camkes_vm_helpers.cmake

#
# Copyright 2018, Data61, CSIRO (ABN 41 687 119 230)
#
# SPDX-License-Identifier: BSD-2-Clause
#

cmake_minimum_required(VERSION 3.8.2)

set(VM_PROJECT_DIR "${CMAKE_CURRENT_LIST_DIR}" CACHE INTERNAL "")

# Function for declaring a CAmkESVM. This is called for each Init component in the applications
# camkes config.
# init_component: is the name of CamkESVM Init component described in the .camkes config
# In addition the user can pass in extra compilation sources, includes, libs and flags through
# the SOURCES, INCLUDES, LIBS, LD_FLAGS and C_FLAGS arguments.
function(DeclareCAmkESVM init_component)
    cmake_parse_arguments(
        PARSE_ARGV
        1
        VM_COMP
        ""
        ""
        "EXTRA_SOURCES;EXTRA_INCLUDES;EXTRA_LIBS;EXTRA_C_FLAGS;EXTRA_LD_FLAGS"
    )
    # Retrieve sources for Init component
    file(GLOB base_sources ${VM_PROJECT_DIR}/components/Init/src/*.c)
    # Declare an Init component for CAmkESVM
    DeclareCAmkESComponent(
        ${init_component}
        SOURCES
        ${base_sources}
        ${VM_COMP_EXTRA_SOURCES}
        INCLUDES
        ${VM_PROJECT_DIR}/components/Init/src
        ${VM_PROJECT_DIR}/components/Init/include
        ${VM_PROJECT_DIR}/components/VM/configurations
        ${VM_COMP_EXTRA_INCLUDES}
        LIBS
        sel4allocman
        sel4vm
        sel4vmmplatsupport
        sel4vmmplatsupport_Config
        sel4_autoconf
        camkes_vmm_Config
        virtqueue
        vswitch
        FileServer-client
        ${VM_COMP_EXTRA_LIBS}
        LD_FLAGS
        ${VM_COMP_EXTRA_LD_FLAGS}
        C_FLAGS
        ${VM_COMP_EXTRA_C_FLAGS}
        TEMPLATE_SOURCES
        seL4ExtraRAM.template.c
        seL4ExcludeGuestPAddr.template.c
        seL4InitConnection.template.c
        seL4VMIOPorts.template.c
        seL4GuestMaps.template.c
        seL4VMIRQs.template.c
        seL4VMPCIDevices.template.c
    )
endfunction(DeclareCAmkESVM)

#
# Function defines a CAmkESVMFileServer using the declared fileserver images
# and fileserver dependencies. These images are placed into a CPIO archive.
#
# Parameters:
#
# TYPE <type>
#   Type of the file server CAmkES component.
#   Optional, defaults to "FileServer"
#
# INSTANCE <name>
#   Instance name of the file server CAmkES component.
#   Optional, defaults to "fserv"
#
# FILES <item>[ <item>[...]]
#   The files to be added. Each item has the form [<NAME>:]<FILE_NAME>, where
#   the optional <NAME> allows using a different name for the file in the
#   file server than it had on the disk. The build will abort if <FILE_NAME> is
#   not found. Each item can either be a single file item or a CMake list of
#   items (where a CMake list is just a string with elements separated by ';').
#   This allows building lists of files in advance, which may contain different
#   files for different configurations. An empty string as item is also allowed
#   explicitly for convenience reasons. This supports cases where an item does
#   not exist in every configuration and the respective CMake variable used for
#   the item is just left empty.
#
# DEPENDS <dep>[ <dep>[...]]
#   Additional dependencies of the file server instance. This is an optional
#   parameter for non-trivial dependencies. Each file server instance depends on
#   all input files anyway, thus a re-build happens automatically on any
#   changes. If an input file is created dynamically by another regular CMake
#   target, any dependencies should have been specified there already, so there
#   is no need to repeat them here.
#
#
function(DefineCAmkESVMFileServer)

    cmake_parse_arguments(
        PARSE_ARGV
        0
        PARAM # variable prefix
        "" # option arguments
        "TYPE;INSTANCE" # optional single value arguments
        "FILES;DEPENDS" # optional multi value arguments
    )

    if(PARAM_UNPARSED_ARGUMENTS)
        message(FATAL_ERROR "Unknown arguments: ${PARAM_UNPARSED_ARGUMENTS}")
    endif()

    if(NOT PARAM_TYPE)
        set(PARAM_TYPE "FileServer")
    endif()

    if(NOT PARAM_INSTANCE)
        set(PARAM_INSTANCE "fserv")
    endif()

    # The target might exist already when AddToFileServer() was called.
    set(FSRV_TARGET "vm_fileserver_config_${PARAM_INSTANCE}")
    if(NOT TARGET ${FSRV_TARGET})
        add_custom_target(${FSRV_TARGET})
    endif()

    # For dependencies and files, both lists and lists of list are supported for
    # convenience reasons. Furthermore, empty entries are also allowed. This
    # can happen when the caller uses variables for the lists, when in some
    # configurations the lists remain empty.

    foreach(element IN LISTS PARAM_DEPENDS)
        foreach(item IN LISTS element)
            if(item)
                set_property(TARGET ${FSRV_TARGET} APPEND PROPERTY DEPS ${item})
            endif()
        endforeach()
    endforeach()

    foreach(element IN LISTS PARAM_FILES)
        foreach(item IN LISTS element) # [<CPIO_NAME>:]<FILENAME>
            if(item)
                string(
                    REGEX
                        MATCH
                        "^([^:]+)(:([^:]+))?$"
                        cpio_item
                        "${item}"
                )
                if(NOT cpio_item)
                    message(FATAL_ERROR "invalid parameter format: '${item}'")
                endif()
                if(CMAKE_MATCH_3)
                    set(CPIO_NAME "${CMAKE_MATCH_1}")
                    set(FILE_NAME "${CMAKE_MATCH_3}")
                else()
                    set(FILE_NAME "${CMAKE_MATCH_1}")
                    get_filename_component(CPIO_NAME "${FILE_NAME}" NAME)
                endif()
                set_property(
                    TARGET ${FSRV_TARGET}
                    APPEND
                    PROPERTY FILES "${CPIO_NAME}:${FILE_NAME}"
                )
            endif()
        endforeach()
    endforeach()

    # now process the file/deps list
    get_target_property(files ${FSRV_TARGET} FILES)
    if(NOT files) # this also catches "files-NOTFOUND" if property is not set
        set(files "")
    endif()
    get_target_property(deps ${FSRV_TARGET} DEPS)
    if(NOT deps) # this also catches "deps-NOTFOUND" if property is not set
        set(deps "")
    endif()

    set(CPIO_FILES "")
    foreach(item IN LISTS files) # <CPIO_NAME>:<FILENAME>
        string(
            REGEX
                MATCH
                "^([^:]+):([^:]+)$"
                cpio_item
                "${item}"
        )
        if(NOT cpio_item)
            message(FATAL_ERROR "invalid CPIO file format: '${item}'")
        endif()
        set(CPIO_NAME "${CMAKE_MATCH_1}")
        set(FILE_NAME "${CMAKE_MATCH_2}")
        set(CPIO_FILE "${PARAM_INSTANCE}/files/${CPIO_NAME}")
        add_custom_command(
            OUTPUT "${CPIO_FILE}"
            COMMENT "copy: ${FILE_NAME} -> ${CPIO_FILE}"
            COMMAND
                ${CMAKE_COMMAND} -E copy "${FILE_NAME}" "${CPIO_FILE}"
            VERBATIM
            DEPENDS ${FILE_NAME} ${deps}
        )
        # There is no need to create an explicit target for the command above,
        # the archive creation depends on all files in CPIO_FILES, where the
        # command above is the creation rule for each one.
        list(APPEND CPIO_FILES "${CPIO_FILE}")
    endforeach()

    # Build CPIO archive. It implicitly depends on all files in CPIO_FILES,
    # which have their own dependencies each from above. So we don't have any
    # additional explicit dependencies here.
    # Unfortunately MakeCPIO() currently allows passing plain file names only,
    # it does not support paths. Thus, the archive will be created in the built
    # output root folder, having it the instance specific subfolder would be a
    # bit cleaner actually.
    set(CPIO_ARCHIVE "${PARAM_INSTANCE}_cpio_archive.o")
    include(cpio)
    # Due to the way MakeCPIO() is implemented, the file list must have absolute
    # paths. Since we don't require CMake 3.12+ yet, we can't use the list
    # transformation functions, but have to prepend each element manually.
    set(CPIO_FILES_FQN "")
    foreach(f IN LISTS CPIO_FILES)
        list(APPEND CPIO_FILES_FQN "${CMAKE_CURRENT_BINARY_DIR}/${f}")
    endforeach()
    MakeCPIO("${CPIO_ARCHIVE}" "${CPIO_FILES_FQN}")

    # Build a library from the CPIO archive. Ensure the lib has a unique name
    # within the project, as there could be more than one file server.
    set(FILESERVER_LIB "${PARAM_INSTANCE}_file_archive_cpio")
    add_library("${FILESERVER_LIB}" STATIC EXCLUDE_FROM_ALL "${CPIO_ARCHIVE}")
    set_property(TARGET "${FILESERVER_LIB}" PROPERTY LINKER_LANGUAGE C)
    # Add the CPIO-library to the FileServer component
    ExtendCAmkESComponentInstance("${PARAM_TYPE}" "${PARAM_INSTANCE}" LIBS "${FILESERVER_LIB}")

endfunction(DefineCAmkESVMFileServer)

# Function for declaring the CAmkESVM root server. Taking the camkes application
# config file we declare a CAmkES Root server and the VM File Server. It is
# expected the caller has declared the file server images before using this
# function.
# camkes_config: The applications .camkes file
# In addition the user can pass in extra CPP compilation includes and flags through
# the CPP_INCLUDES and CPP_FLAGS arguments.
function(DeclareCAmkESVMRootServer camkes_config)
    cmake_parse_arguments(PARSE_ARGV 1 CAMKES_ROOT_VM "" "" "CPP_INCLUDES;CPP_FLAGS")
    # Initialise the CAmKES VM fileserver
    DefineCAmkESVMFileServer()
    get_absolute_source_or_binary(config_file "${camkes_config}")
    # Declare CAmkES root server
    DeclareCAmkESRootserver(
        ${config_file}
        CPP_FLAGS
        ${CAMKES_ROOT_VM_CPP_FLAGS}
        CPP_INCLUDES
        "${VM_PROJECT_DIR}/components/VM"
        ${CAMKES_ROOT_VM_CPP_INCLUDES}
    )
endfunction(DeclareCAmkESVMRootServer)

# Function for adding a file/image to the vm file server.
#
# Parameters:
#
# <filename_pref>
#   The name to use for the file in the file server. Components using a file
#   server could expect certain files to have a specific name, which could
#   differer from the file name on the disk, so this provides a convenient way
#   to handle the renaming.
#
# <file_dest>
#   The location of the file on the disk.
#
# INSTANCE <name>
#   The File server instance to add the file to.
#   Optional, defaults to "fserv".
#
# DEPENDS <dep>[ <dep>[...]]
#   Additional dependencies of the file added to the file server. This is an
#   optional parameter for non-trivial dependencies of the input file. Each file
#   server instance depends on all input files anyway, thus a re-build happens
#   automatically on any changes. If an input file is created dynamically by
#   another regular CMake target, any dependencies should have been specified
#   there already, so there is no need to repeat them here.
#
function(AddToFileServer filename_pref file_dest)

    cmake_parse_arguments(
        PARSE_ARGV
        2
        PARAM # variable prefix
        "" # option arguments
        "INSTANCE" # optional single value arguments
        "DEPENDS" # optional multi value arguments
    )

    if(PARAM_UNPARSED_ARGUMENTS)
        message(FATAL_ERROR "Unknown arguments: ${PARAM_UNPARSED_ARGUMENTS}")
    endif()

    if(NOT PARAM_INSTANCE)
        set(PARAM_INSTANCE "fserv")
    endif()

    set(FSRV_TARGET "vm_fileserver_config_${PARAM_INSTANCE}")
    if(NOT TARGET ${FSRV_TARGET})
        add_custom_target(${FSRV_TARGET})
    endif()

    set_property(TARGET ${FSRV_TARGET} APPEND PROPERTY FILES "${filename_pref}:${file_dest}")

    if(PARAM_DEPENDS)
        set_property(TARGET ${FSRV_TARGET} APPEND PROPERTY DEPS ${PARAM_DEPENDS})
    endif()

endfunction(AddToFileServer)

# Function for decompressing/extracting a vmlinux file from a given kernel image
# decompress_target: The target name the caller wishes to use to generate the decompressed kernel
# image
# decompressed_kernel_image: caller variable which is set with the decompressed kernel image location
# compressed_kernel_image: The location of the compressed kernel image
# DEPENDS: Any additional dependencies for the compressed kernel image
function(DecompressLinuxKernel decompress_target decompressed_kernel_image compressed_kernel_image)
    # Get any existing dependencies for decompressing linux kernel
    cmake_parse_arguments(PARSE_ARGV 3 DECOMPRESS_KERNEL "" "" "DEPENDS")
    if(NOT "${DECOMPRESS_KERNEL_UNPARSED_ARGUMENTS}" STREQUAL "")
        message(FATAL_ERROR "Unknown arguments to DecompressLinuxKernel")
    endif()
    # Retrieve filename from kernel path
    get_filename_component(kernel_basename ${compressed_kernel_image} NAME)
    # Extract vmlinux from bzimage
    add_custom_command(
        OUTPUT decomp/${kernel_basename}
        COMMAND
            bash -c
            "${VM_PROJECT_DIR}/tools/elf/extract-vmlinux ${compressed_kernel_image} > decomp/${kernel_basename}"
        VERBATIM
        DEPENDS ${compressed_kernel_image} ${DECOMPRESS_KERNEL_DEPENDS}
    )
    # Create custom target for extraction
    add_custom_target(
        ${decompress_target}
        DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/decomp/${kernel_basename}"
    )
    # Set parameter to tell the caller location of decompressed kernel image
    set(
        ${decompressed_kernel_image} ${CMAKE_CURRENT_BINARY_DIR}/decomp/${kernel_basename}
        PARENT_SCOPE
    )
endfunction(DecompressLinuxKernel)