fsfw/CMakeLists.txt

433 lines
14 KiB
CMake
Raw Normal View History

2020-12-07 01:40:10 +01:00
cmake_minimum_required(VERSION 3.13)
2022-04-26 20:06:26 +02:00
project(${LIB_FSFW_NAME})
2020-12-07 01:40:10 +01:00
2022-04-22 14:47:28 +02:00
set(FSFW_VERSION_IF_GIT_FAILS 4)
set(FSFW_SUBVERSION_IF_GIT_FAILS 0)
set(FSFW_REVISION_IF_GIT_FAILS 0)
# Add the cmake folder so the FindSphinx module is found
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" )
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake-modules")
2022-04-22 14:08:26 +02:00
set(MSG_PREFIX "fsfw |")
2022-03-28 20:57:13 +02:00
set(FSFW_ETL_LIB_MAJOR_VERSION 20 CACHE STRING
2022-03-28 20:55:34 +02:00
"ETL library major version requirement"
)
2022-04-26 11:15:24 +02:00
set(FSFW_ETL_LIB_VERSION ${FSFW_ETL_LIB_MAJOR_VERSION}.27.3 CACHE STRING
2022-03-28 20:55:34 +02:00
"ETL library exact version requirement"
)
2022-03-28 20:53:39 +02:00
2022-03-28 20:57:13 +02:00
set(FSFW_CATCH2_LIB_MAJOR_VERSION 3 CACHE STRING
2022-03-28 20:55:34 +02:00
"Catch2 library major version requirement"
)
2022-03-28 20:57:13 +02:00
set(FSFW_CATCH2_LIB_VERSION v${FSFW_CATCH2_LIB_MAJOR_VERSION}.0.0-preview4 CACHE STRING
2022-03-28 20:55:34 +02:00
"Catch2 library exact version requirement"
)
2022-03-28 20:53:39 +02:00
2022-03-28 20:18:49 +02:00
set(FSFW_ETL_LIB_NAME etl)
2021-03-25 18:48:00 +01:00
option(FSFW_GENERATE_SECTIONS
"Generate function and data sections. Required to remove unused code" ON
)
if(FSFW_GENERATE_SECTIONS)
option(FSFW_REMOVE_UNUSED_CODE "Remove unused code" ON)
endif()
option(FSFW_BUILD_UNITTESTS "Build unittest binary in addition to static library" OFF)
option(FSFW_BUILD_DOCS "Build documentation with Sphinx and Doxygen" OFF)
if(FSFW_BUILD_UNITTESTS)
option(FSFW_TESTS_GEN_COV "Generate coverage data for unittests" ON)
endif()
2021-01-19 16:30:17 +01:00
option(FSFW_WARNING_SHADOW_LOCAL_GCC "Enable -Wshadow=local warning in GCC" ON)
# Options to exclude parts of the FSFW from compilation.
2021-07-14 10:22:58 +02:00
option(FSFW_ADD_INTERNAL_TESTS "Add internal unit tests" ON)
option(FSFW_ADD_UNITTESTS "Add regular unittests. Requires Catch2" OFF)
2021-07-30 13:47:29 +02:00
option(FSFW_ADD_HAL "Add Hardware Abstraction Layer" ON)
2021-07-19 18:26:54 +02:00
# Optional sources
option(FSFW_ADD_PUS "Compile with PUS sources" ON)
option(FSFW_ADD_MONITORING "Compile with monitoring components" ON)
option(FSFW_ADD_RMAP "Compile with RMAP" OFF)
option(FSFW_ADD_DATALINKLAYER "Compile with Data Link Layer" OFF)
option(FSFW_ADD_COORDINATES "Compile with coordinate components" OFF)
option(FSFW_ADD_TMSTORAGE "Compile with tm storage components" OFF)
# Contrib sources
2021-08-02 15:47:12 +02:00
option(FSFW_ADD_SGP4_PROPAGATOR "Add SGP4 propagator code" OFF)
2021-01-19 16:30:17 +01:00
2020-12-07 01:40:10 +01:00
set(LIB_FSFW_NAME fsfw)
set(FSFW_TEST_TGT fsfw-tests)
set(FSFW_DUMMY_TGT fsfw-dummy)
2020-12-07 01:40:10 +01:00
add_library(${LIB_FSFW_NAME})
2022-04-22 15:08:16 +02:00
set(FSFW_GIT_VER_HANDLING_OK FALSE)
# Version handling
2022-04-22 14:55:17 +02:00
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)
message(STATUS "${MSG_PREFIX} Determining version information with git")
2022-04-22 15:00:04 +02:00
include(FsfwHelpers)
2022-04-22 14:47:28 +02:00
determine_version_with_git("--exclude" "docker_*")
2022-04-22 15:08:16 +02:00
if(GIT_INFO)
set(FSFW_GIT_INFO ${GIT_INFO} CACHE STRING "Version information retrieved with git describe")
list(GET FSFW_GIT_INFO 1 FSFW_VERSION)
list(GET FSFW_GIT_INFO 2 FSFW_SUBVERSION)
list(GET FSFW_GIT_INFO 3 FSFW_REVISION)
list(GET FSFW_GIT_INFO 4 FSFW_VERSION_CST_GIT_SHA1)
if(NOT FSFW_VERSION)
set(FSFW_VERSION ${FSFW_VERSION_IF_GIT_FAILS})
endif()
if(NOT FSFW_SUBVERSION)
set(FSFW_SUBVERSION ${FSFW_SUBVERSION_IF_GIT_FAILS})
endif()
if(NOT FSFW_REVISION)
set(FSFW_REVISION ${FSFW_REVISION_IF_GIT_FAILS})
endif()
set(FSFW_GIT_VER_HANDLING_OK TRUE)
else()
set(FSFW_GIT_VER_HANDLING_OK FALSE)
endif()
endif()
if(NOT FSFW_GIT_VER_HANDLING_OK)
2022-04-22 14:47:28 +02:00
set(FSFW_VERSION ${FSFW_VERSION_IF_GIT_FAILS})
set(FSFW_SUBVERSION ${FSFW_SUBVERSION_IF_GIT_FAILS})
set(FSFW_REVISION ${FSFW_REVISION_IF_GIT_FAILS})
endif()
if(FSFW_BUILD_UNITTESTS)
2022-04-22 14:08:26 +02:00
message(STATUS "${MSG_PREFIX} Building the FSFW unittests in addition to the static library")
# Check whether the user has already installed Catch2 first
2022-04-26 20:06:26 +02:00
find_package(Catch2 ${FSFW_CATCH2_LIB_MAJOR_VERSION} CONFIG QUIET)
# Not installed, so use FetchContent to download and provide Catch2
if(NOT Catch2_FOUND)
2022-04-22 14:08:26 +02:00
message(STATUS "${MSG_PREFIX} Catch2 installation not found. Downloading Catch2 library with FetchContent")
include(FetchContent)
FetchContent_Declare(
Catch2
GIT_REPOSITORY https://github.com/catchorg/Catch2.git
2022-03-28 20:53:39 +02:00
GIT_TAG ${FSFW_CATCH2_LIB_VERSION}
)
FetchContent_MakeAvailable(Catch2)
#fixes regression -preview4, to be confirmed in later releases
set_target_properties(Catch2 PROPERTIES DEBUG_POSTFIX "")
endif()
2021-10-11 14:56:42 +02:00
set(FSFW_CONFIG_PATH tests/src/fsfw_tests/unit/testcfg)
2021-10-11 15:07:52 +02:00
configure_file(tests/src/fsfw_tests/unit/testcfg/FSFWConfig.h.in FSFWConfig.h)
configure_file(tests/src/fsfw_tests/unit/testcfg/TestsConfig.h.in tests/TestsConfig.h)
2021-10-11 16:16:49 +02:00
2021-10-11 15:09:19 +02:00
project(${FSFW_TEST_TGT} CXX C)
add_executable(${FSFW_TEST_TGT})
if(FSFW_TESTS_GEN_COV)
2022-04-22 14:08:26 +02:00
message(STATUS "${MSG_PREFIX} Generating coverage data for the library")
message(STATUS "${MSG_PREFIX} Targets linking against ${LIB_FSFW_NAME} "
"will be compiled with coverage data as well"
)
set(CMAKE_BUILD_TYPE "Debug")
include(CodeCoverage)
endif()
endif()
2022-04-26 16:24:14 +02:00
message(STATUS "Finding and/or providing etl library with version ${FSFW_ETL_LIB_MAJOR_VERSION}")
2022-04-11 16:44:20 +02:00
2022-03-28 21:10:51 +02:00
# Check whether the user has already installed ETL first
2022-04-26 20:06:26 +02:00
# find_package(${FSFW_ETL_LIB_NAME} ${FSFW_ETL_LIB_MAJOR_VERSION} CONFIG QUIET)
2022-03-28 20:16:11 +02:00
# Not installed, so use FetchContent to download and provide etl
2022-04-26 20:06:26 +02:00
# if(NOT ${FSFW_ETL_LIB_NAME}_FOUND)
message(STATUS
"No etl installation was found with find_package. Installing and providing "
"etl with FetchContent"
)
include(FetchContent)
2022-03-28 20:16:11 +02:00
2022-04-26 20:06:26 +02:00
FetchContent_Declare(
${FSFW_ETL_LIB_NAME}
GIT_REPOSITORY https://github.com/ETLCPP/etl
GIT_TAG ${FSFW_ETL_LIB_VERSION}
)
2022-03-28 20:16:11 +02:00
2022-04-26 20:06:26 +02:00
FetchContent_MakeAvailable(${FSFW_ETL_LIB_NAME})
# endif()
2022-03-28 20:16:11 +02:00
2021-07-13 20:22:54 +02:00
set(FSFW_CORE_INC_PATH "inc")
2020-12-07 01:40:10 +01:00
2021-07-13 18:53:07 +02:00
set_property(CACHE FSFW_OSAL PROPERTY STRINGS host linux rtems freertos)
2020-12-07 12:59:09 +01:00
2022-01-18 18:47:29 +01:00
# For configure files
target_include_directories(${LIB_FSFW_NAME} PRIVATE
${CMAKE_CURRENT_BINARY_DIR}
)
target_include_directories(${LIB_FSFW_NAME} INTERFACE
${CMAKE_CURRENT_BINARY_DIR}
)
2021-10-11 16:32:19 +02:00
2021-05-27 11:56:52 +02:00
if(NOT CMAKE_CXX_STANDARD)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)
elseif(${CMAKE_CXX_STANDARD} LESS 11)
2022-04-22 14:08:26 +02:00
message(FATAL_ERROR "${MSG_PREFIX} Compiling the FSFW requires a minimum of C++11 support")
2021-05-27 11:56:52 +02:00
endif()
2021-07-13 18:58:31 +02:00
# Backwards comptability
2021-08-16 15:19:03 +02:00
if(OS_FSFW AND NOT FSFW_OSAL)
2022-04-22 14:08:26 +02:00
message(WARNING "${MSG_PREFIX} Please pass the FSFW OSAL as FSFW_OSAL instead of OS_FSFW")
2021-07-13 18:58:31 +02:00
set(FSFW_OSAL OS_FSFW)
endif()
2021-07-13 18:53:07 +02:00
if(NOT FSFW_OSAL)
2022-04-22 14:08:26 +02:00
message(STATUS "${MSG_PREFIX} No OS for FSFW via FSFW_OSAL set. Assuming host OS")
2020-12-17 11:46:50 +01:00
# Assume host OS and autodetermine from OS_FSFW
if(UNIX)
2021-07-13 18:53:07 +02:00
set(FSFW_OSAL "linux"
2020-12-17 11:46:50 +01:00
CACHE STRING
"OS abstraction layer used in the FSFW"
)
elseif(WIN32)
2021-07-13 18:53:07 +02:00
set(FSFW_OSAL "host"
2020-12-17 11:46:50 +01:00
CACHE STRING "OS abstraction layer used in the FSFW"
)
endif()
2020-12-17 20:18:16 +01:00
endif()
2020-12-17 11:46:50 +01:00
2021-07-14 10:22:58 +02:00
set(FSFW_OSAL_DEFINITION FSFW_OSAL_HOST)
2021-03-27 21:27:46 +01:00
2021-07-13 18:52:19 +02:00
if(FSFW_OSAL MATCHES host)
set(FSFW_OS_NAME "Host")
2021-08-16 11:23:44 +02:00
set(FSFW_OSAL_HOST ON)
2021-07-13 18:52:19 +02:00
elseif(FSFW_OSAL MATCHES linux)
set(FSFW_OS_NAME "Linux")
2021-08-16 11:23:44 +02:00
set(FSFW_OSAL_LINUX ON)
2021-07-13 18:52:19 +02:00
elseif(FSFW_OSAL MATCHES freertos)
set(FSFW_OS_NAME "FreeRTOS")
2021-08-16 11:23:44 +02:00
set(FSFW_OSAL_FREERTOS ON)
target_link_libraries(${LIB_FSFW_NAME} PRIVATE
${LIB_OS_NAME}
2021-08-16 11:23:44 +02:00
)
2021-07-13 18:52:19 +02:00
elseif(FSFW_OSAL STREQUAL rtems)
set(FSFW_OS_NAME "RTEMS")
2021-08-16 11:23:44 +02:00
set(FSFW_OSAL_RTEMS ON)
2020-12-07 12:59:09 +01:00
else()
2021-08-16 11:23:44 +02:00
message(WARNING
2022-04-22 14:08:26 +02:00
"${MSG_PREFIX} Invalid operating system for FSFW specified! Setting to host.."
2021-08-16 11:23:44 +02:00
)
set(FSFW_OS_NAME "Host")
2021-08-16 11:23:44 +02:00
set(OS_FSFW "host")
2020-12-07 12:59:09 +01:00
endif()
2022-01-18 18:29:54 +01:00
configure_file(src/fsfw/FSFW.h.in fsfw/FSFW.h)
configure_file(src/fsfw/FSFWVersion.h.in fsfw/FSFWVersion.h)
2021-10-27 17:10:37 +02:00
2022-04-22 14:08:26 +02:00
message(STATUS "${MSG_PREFIX} Compiling FSFW for the ${FSFW_OS_NAME} operating system")
2020-12-07 12:59:09 +01:00
2021-07-13 18:52:19 +02:00
add_subdirectory(src)
2021-07-14 10:22:58 +02:00
add_subdirectory(tests)
2021-07-30 13:47:29 +02:00
if(FSFW_ADD_HAL)
add_subdirectory(hal)
endif()
2021-07-14 11:03:42 +02:00
add_subdirectory(contrib)
if(FSFW_BUILD_DOCS)
add_subdirectory(docs)
endif()
2020-12-07 01:40:10 +01:00
if(FSFW_BUILD_UNITTESTS)
if(FSFW_TESTS_GEN_COV)
if(CMAKE_COMPILER_IS_GNUCXX)
include(CodeCoverage)
# Remove quotes.
separate_arguments(COVERAGE_COMPILER_FLAGS
NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}"
)
# Add compile options manually, we don't want coverage for Catch2
target_compile_options(${FSFW_TEST_TGT} PRIVATE
"${COVERAGE_COMPILER_FLAGS}"
)
target_compile_options(${LIB_FSFW_NAME} PRIVATE
"${COVERAGE_COMPILER_FLAGS}"
)
# Exclude directories here
if(WIN32)
set(GCOVR_ADDITIONAL_ARGS
"--exclude-throw-branches"
"--exclude-unreachable-branches"
)
set(COVERAGE_EXCLUDES
"/c/msys64/mingw64/*" "*/fsfw_hal/*"
)
elseif(UNIX)
set(COVERAGE_EXCLUDES
"/usr/include/*" "/usr/bin/*" "Catch2/*"
2021-10-11 17:28:07 +02:00
"/usr/local/include/*" "*/fsfw_tests/*"
"*/catch2-src/*" "*/fsfw_hal/*"
)
endif()
target_link_options(${FSFW_TEST_TGT} PRIVATE
-fprofile-arcs
-ftest-coverage
)
target_link_options(${LIB_FSFW_NAME} PRIVATE
-fprofile-arcs
-ftest-coverage
)
# Need to specify this as an interface, otherwise there will the compile issues
target_link_options(${LIB_FSFW_NAME} INTERFACE
-fprofile-arcs
-ftest-coverage
)
if(WIN32)
setup_target_for_coverage_gcovr_html(
NAME ${FSFW_TEST_TGT}_coverage
EXECUTABLE ${FSFW_TEST_TGT}
DEPENDENCIES ${FSFW_TEST_TGT}
)
else()
setup_target_for_coverage_lcov(
NAME ${FSFW_TEST_TGT}_coverage
EXECUTABLE ${FSFW_TEST_TGT}
DEPENDENCIES ${FSFW_TEST_TGT}
)
endif()
endif()
endif()
target_link_libraries(${FSFW_TEST_TGT} PRIVATE Catch2::Catch2 ${LIB_FSFW_NAME})
endif()
2020-12-07 01:40:10 +01:00
# The project CMakeLists file has to set the FSFW_CONFIG_PATH and add it.
# If this is not given, we include the default configuration and emit a warning.
if(NOT FSFW_CONFIG_PATH)
2021-10-11 13:57:00 +02:00
set(DEF_CONF_PATH misc/defaultcfg/fsfwconfig)
if(NOT FSFW_BUILD_DOCS)
2022-04-22 14:08:26 +02:00
message(WARNING "${MSG_PREFIX} Flight Software Framework configuration path not set")
message(WARNING "${MSG_PREFIX} Setting default configuration from ${DEF_CONF_PATH} ..")
endif()
2021-10-11 13:57:00 +02:00
add_subdirectory(${DEF_CONF_PATH})
2021-10-11 15:03:03 +02:00
set(FSFW_CONFIG_PATH ${DEF_CONF_PATH})
2020-12-07 01:40:10 +01:00
endif()
2020-12-19 02:29:22 +01:00
# FSFW might be part of a possibly complicated folder structure, so we
# extract the absolute path of the fsfwconfig folder.
if(IS_ABSOLUTE ${FSFW_CONFIG_PATH})
2020-12-19 12:10:29 +01:00
set(FSFW_CONFIG_PATH_ABSOLUTE ${FSFW_CONFIG_PATH})
2020-12-19 02:29:22 +01:00
else()
2020-12-19 12:10:29 +01:00
get_filename_component(FSFW_CONFIG_PATH_ABSOLUTE
${FSFW_CONFIG_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR}
2020-12-19 02:29:22 +01:00
)
endif()
2021-05-31 16:46:32 +02:00
foreach(INCLUDE_PATH ${FSFW_ADDITIONAL_INC_PATHS})
if(IS_ABSOLUTE ${INCLUDE_PATH})
2021-05-31 17:00:51 +02:00
set(CURR_ABS_INC_PATH "${INCLUDE_PATH}")
else()
get_filename_component(CURR_ABS_INC_PATH
${INCLUDE_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR})
endif()
if(CMAKE_VERBOSE)
message(STATUS "FSFW include path: ${CURR_ABS_INC_PATH}")
endif()
list(APPEND FSFW_ADD_INC_PATHS_ABS ${CURR_ABS_INC_PATH})
endforeach()
2021-01-13 11:47:04 +01:00
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
2021-01-13 21:35:17 +01:00
if(NOT DEFINED FSFW_WARNING_FLAGS)
set(FSFW_WARNING_FLAGS
-Wall
-Wextra
-Wimplicit-fallthrough=1
-Wno-unused-parameter
-Wno-psabi
-Wduplicated-cond # check for duplicate conditions
-Wduplicated-branches # check for duplicate branches
-Wlogical-op # Search for bitwise operations instead of logical
-Wnull-dereference # Search for NULL dereference
-Wundef # Warn if undefind marcos are used
-Wformat=2 # Format string problem detection
-Wformat-overflow=2 # Formatting issues in printf
-Wformat-truncation=2 # Formatting issues in printf
-Wformat-security # Search for dangerous printf operations
-Wstrict-overflow=3 # Warn if integer overflows might happen
-Warray-bounds=2 # Some array bounds violations will be found
-Wshift-overflow=2 # Search for bit left shift overflows (<c++14)
-Wcast-qual # Warn if the constness is cast away
-Wstringop-overflow=4
# -Wstack-protector # Emits a few false positives for low level access
# -Wconversion # Creates many false positives
# -Warith-conversion # Use with Wconversion to find more implicit conversions
# -fanalyzer # Should be used to look through problems
2021-01-13 21:35:17 +01:00
)
2021-01-19 16:39:12 +01:00
endif()
2021-03-25 18:48:00 +01:00
if(FSFW_GENERATE_SECTIONS)
target_compile_options(${LIB_FSFW_NAME} PRIVATE
"-ffunction-sections"
"-fdata-sections"
)
endif()
if(FSFW_REMOVE_UNUSED_CODE)
target_link_options(${LIB_FSFW_NAME} PRIVATE
"Wl,--gc-sections"
)
endif()
2021-01-19 16:39:12 +01:00
if(FSFW_WARNING_SHADOW_LOCAL_GCC)
list(APPEND WARNING_FLAGS "-Wshadow=local")
endif()
2021-01-19 16:13:10 +01:00
2020-12-20 15:32:03 +01:00
endif()
if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
set(COMPILER_FLAGS "/permissive-")
endif()
2020-12-20 13:21:12 +01:00
2020-12-07 01:40:10 +01:00
# Required include paths to compile the FSFW
2020-12-19 02:29:22 +01:00
target_include_directories(${LIB_FSFW_NAME} INTERFACE
${CMAKE_SOURCE_DIR}
${FSFW_CONFIG_PATH_ABSOLUTE}
2021-07-13 20:22:54 +02:00
${FSFW_CORE_INC_PATH}
${FSFW_ADD_INC_PATHS_ABS}
2020-12-19 02:29:22 +01:00
)
# Includes path required to compile FSFW itself as well
# We assume that the fsfwconfig folder uses include relative to the project
# root here!
target_include_directories(${LIB_FSFW_NAME} PRIVATE
${CMAKE_SOURCE_DIR}
${FSFW_CONFIG_PATH_ABSOLUTE}
2021-07-13 20:22:54 +02:00
${FSFW_CORE_INC_PATH}
${FSFW_ADD_INC_PATHS_ABS}
2020-12-07 01:40:10 +01:00
)
2020-12-19 18:38:02 +01:00
target_compile_options(${LIB_FSFW_NAME} PRIVATE
2021-01-13 21:35:17 +01:00
${FSFW_WARNING_FLAGS}
2020-12-20 15:32:03 +01:00
${COMPILER_FLAGS}
2020-12-19 18:38:02 +01:00
)
target_link_libraries(${LIB_FSFW_NAME} PRIVATE
2022-04-26 20:06:26 +02:00
etl
${FSFW_ADDITIONAL_LINK_LIBS}
)
string(CONCAT POST_BUILD_COMMENT
"######################################################################\n"
2021-10-11 16:06:12 +02:00
"Built FSFW v${FSFW_VERSION}.${FSFW_SUBVERSION}.${FSFW_REVISION}, "
"Target OSAL: ${FSFW_OS_NAME}\n"
"######################################################################\n"
)
add_custom_command(
TARGET ${LIB_FSFW_NAME}
POST_BUILD
COMMENT ${POST_BUILD_COMMENT}
)