diff options
Diffstat (limited to 'cmake')
50 files changed, 1835 insertions, 8 deletions
diff --git a/cmake/compiler.cmake b/cmake/compiler.cmake new file mode 100644 index 00000000..6258cca0 --- /dev/null +++ b/cmake/compiler.cmake @@ -0,0 +1,72 @@ +include(utils/CompilerUtils) + +test_and_set_c_compiler_flag_global(-std=c89) +test_and_set_c_compiler_flag_global(-Wall) +# -Wextra may fail on clobbered warning due to pthread_cleanup +test_and_set_c_compiler_flag_global(-Wno-clobbered) +test_and_set_c_compiler_flag_global(-Wextra) +# explicitly add other flags in -Wextra +test_and_set_c_compiler_flag_global(-Wempty-body) +test_and_set_c_compiler_flag_global(-Wignored-qualifiers) +test_and_set_c_compiler_flag_global(-Wimplicit-fallthrough=4) +test_and_set_c_compiler_flag_global(-Wmissing-field-initializers) +test_and_set_c_compiler_flag_global(-Wmissing-parameter-type) +test_and_set_c_compiler_flag_global(-Wold-style-declaration) +test_and_set_c_compiler_flag_global(-Woverride-init) +test_and_set_c_compiler_flag_global(-Wsign-compare) +test_and_set_c_compiler_flag_global(-Wtype-limits) +test_and_set_c_compiler_flag_global(-Wuninitialized) +test_and_set_c_compiler_flag_global(-Wshift-negative-value) +test_and_set_c_compiler_flag_global(-Wunused-parameter) +test_and_set_c_compiler_flag_global(-Wunused-but-set-parameter) +test_and_set_c_compiler_flag_global(-Werror) +test_and_set_c_compiler_flag_global(-Wundef) +test_and_set_c_compiler_flag_global(-Wpointer-arith) +test_and_set_c_compiler_flag_global(-Wstrict-prototypes) +test_and_set_c_compiler_flag_global(-Wvla) +test_and_set_c_compiler_flag_global(-Wswitch-default) +test_and_set_c_compiler_flag_global(-Wreturn-type) +test_and_set_c_compiler_flag_global(-Wunreachable-code) +test_and_set_c_compiler_flag_global(-Wdeclaration-after-statement) +test_and_set_c_compiler_flag_global(-Winfinite-recursion) +test_and_set_c_compiler_flag_global(-fmax-errors=5) + +set(DISABLE_COVERAGE ON CACHE BOOL "Disable code coverage analysis") + +if (NOT DISABLE_COVERAGE) + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(--coverage) + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage") + set(ENABLE_COVERAGE ON) +else() + set(ENABLE_COVERAGE OFF) +endif() + +if (NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE "Release" CACHE STRING + "Build type (Release, Debug, DebugASan, DebugTSan, DebugLSan, DebugUSan, DebugAnalyzer)" FORCE) +endif() + +if (CMAKE_BUILD_TYPE STREQUAL "Release") + test_and_set_c_compiler_flag_global(-O3) +elseif (CMAKE_BUILD_TYPE STREQUAL "Debug") + test_and_set_c_compiler_flag_global(-g) +elseif (CMAKE_BUILD_TYPE STREQUAL "DebugASan") + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(-fsanitize=address) +elseif (CMAKE_BUILD_TYPE STREQUAL "DebugTSan") + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(-fsanitize=thread) +elseif (CMAKE_BUILD_TYPE STREQUAL "DebugLSan") + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(-fsanitize=leak) +elseif (CMAKE_BUILD_TYPE STREQUAL "DebugUSan") + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(-fsanitize=undefined) +elseif (CMAKE_BUILD_TYPE STREQUAL "DebugAnalyzer") + test_and_set_c_compiler_flag_global(-g) + test_and_set_c_compiler_flag_global(-fanalyzer) +else () + message(FATAL_ERROR "Unkown build type ${CMAKE_BUILD_TYPE}") +endif () diff --git a/cmake/dependencies.cmake b/cmake/dependencies.cmake new file mode 100644 index 00000000..e9dc17a1 --- /dev/null +++ b/cmake/dependencies.cmake @@ -0,0 +1,18 @@ +include(FindPkgConfig) +include(CheckSymbolExists) + +include(dependencies/protobufc) +include(dependencies/systemlibraries) +include(dependencies/robustmutex) +include(dependencies/fuse) +include(dependencies/libgcrypt) +include(dependencies/openssl) +include(dependencies/sysrandom) +include(dependencies/libtoml) +include(dependencies/rawsockets) +include(dependencies/bpf) +include(dependencies/netmap) +include(dependencies/gcov) +include(dependencies/lcov) + + diff --git a/cmake/dependencies/bpf.cmake b/cmake/dependencies/bpf.cmake new file mode 100644 index 00000000..8c04937f --- /dev/null +++ b/cmake/dependencies/bpf.cmake @@ -0,0 +1,20 @@ +# Berkeley Packet Filter support (BSD/macOS only) +if (NOT CMAKE_SYSTEM_NAME STREQUAL "Linux") + find_path(BPF_C_INCLUDE_DIR + net/bpf.h + HINTS /usr/include /usr/local/include) + + mark_as_advanced(BPF_C_INCLUDE_DIR) + + if (BPF_C_INCLUDE_DIR) + set(DISABLE_BPF FALSE CACHE BOOL + "Disable Berkeley Packet Filter support for Ethernet IPCPs") + if (NOT DISABLE_BPF) + message(STATUS "Berkeley Packet Filter support for Ethernet IPCPs enabled") + set(HAVE_BPF TRUE) + else () + message(STATUS "Berkeley Packet Filter support for Ethernet IPCPs disabled by user") + unset(HAVE_BPF) + endif () + endif () +endif () diff --git a/cmake/dependencies/fuse.cmake b/cmake/dependencies/fuse.cmake new file mode 100644 index 00000000..8ef60292 --- /dev/null +++ b/cmake/dependencies/fuse.cmake @@ -0,0 +1,23 @@ +find_library(FUSE_LIBRARIES fuse QUIET) +if (FUSE_LIBRARIES) + #FIXME: Check for version >= 2.6 + set(DISABLE_FUSE FALSE CACHE BOOL "Disable FUSE support") + if (NOT DISABLE_FUSE) + message(STATUS "FUSE support enabled") + set(FUSE_PREFIX "/tmp/ouroboros" CACHE STRING + "Mountpoint for RIB filesystem") + set(HAVE_FUSE TRUE CACHE INTERNAL "") + else () + message(STATUS "FUSE support disabled by user") + unset(HAVE_FUSE CACHE) + endif () +else () + message(STATUS "Install FUSE version > 2.6 to enable RIB access") +endif () + +if (NOT HAVE_FUSE) + set(FUSE_LIBRARIES "") + set(FUSE_INCLUDE_DIR "") +endif () + +mark_as_advanced(FUSE_LIBRARIES) diff --git a/cmake/dependencies/gcov.cmake b/cmake/dependencies/gcov.cmake new file mode 100644 index 00000000..c4d1caf0 --- /dev/null +++ b/cmake/dependencies/gcov.cmake @@ -0,0 +1,11 @@ +find_program(GCOV_PATH gcov) + +if (GCOV_PATH) + set(HAVE_GCOV TRUE CACHE INTERNAL "") + message(STATUS "gcov found - coverage analysis available") +else () + set(HAVE_GCOV FALSE CACHE INTERNAL "") + message(STATUS "gcov not found - coverage analysis not available") +endif () + +mark_as_advanced(GCOV_PATH) diff --git a/cmake/dependencies/lcov.cmake b/cmake/dependencies/lcov.cmake new file mode 100644 index 00000000..db559332 --- /dev/null +++ b/cmake/dependencies/lcov.cmake @@ -0,0 +1,17 @@ +find_program(LCOV_PATH lcov) +find_program(GENHTML_PATH genhtml) + +if (LCOV_PATH AND GENHTML_PATH) + set(HAVE_LCOV TRUE CACHE INTERNAL "") + message(STATUS "lcov and genhtml found - HTML coverage reports available") +else () + set(HAVE_LCOV FALSE CACHE INTERNAL "") + if (NOT LCOV_PATH) + message(STATUS "lcov not found - HTML coverage reports not available") + endif () + if (NOT GENHTML_PATH) + message(STATUS "genhtml not found - HTML coverage reports not available") + endif () +endif () + +mark_as_advanced(LCOV_PATH GENHTML_PATH) diff --git a/cmake/dependencies/libgcrypt.cmake b/cmake/dependencies/libgcrypt.cmake new file mode 100644 index 00000000..90a25f36 --- /dev/null +++ b/cmake/dependencies/libgcrypt.cmake @@ -0,0 +1,31 @@ +find_library(LIBGCRYPT_LIBRARIES gcrypt QUIET) +if (LIBGCRYPT_LIBRARIES) + find_path(LIBGCRYPT_INCLUDE_DIR gcrypt.h + HINTS /usr/include /usr/local/include) + if (LIBGCRYPT_INCLUDE_DIR) + file(STRINGS ${LIBGCRYPT_INCLUDE_DIR}/gcrypt.h GCSTR + REGEX "^#define GCRYPT_VERSION ") + string(REGEX REPLACE "^#define GCRYPT_VERSION \"(.*)\".*$" "\\1" + GCVER "${GCSTR}") + if (NOT GCVER VERSION_LESS "1.7.0") + set(DISABLE_LIBGCRYPT FALSE CACHE BOOL "Disable libgcrypt support") + if (NOT DISABLE_LIBGCRYPT) + message(STATUS "libgcrypt support enabled") + set(HAVE_LIBGCRYPT TRUE CACHE INTERNAL "") + else () + message(STATUS "libgcrypt support disabled by user") + unset(HAVE_LIBGCRYPT CACHE) + endif() + else () + message(STATUS "Install version >= \"1.7.0\" to enable libgcrypt support " + "(found version \"${GCVER}\")") + endif() + endif () +endif () + +if (NOT HAVE_LIBGCRYPT) + set(LIBGCRYPT_LIBRARIES "") + set(LIBGCRYPT_INCLUDE_DIR "") +endif () + +mark_as_advanced(LIBGCRYPT_LIBRARIES LIBGCRYPT_INCLUDE_DIR) diff --git a/cmake/dependencies/libtoml.cmake b/cmake/dependencies/libtoml.cmake new file mode 100644 index 00000000..3974a1dd --- /dev/null +++ b/cmake/dependencies/libtoml.cmake @@ -0,0 +1,5 @@ +find_library(LIBTOML_LIBRARIES toml QUIET) +if (LIBTOML_LIBRARIES) + find_path(LIBTOML_INCLUDE toml.h) + mark_as_advanced(LIBTOML_LIBRARIES LIBTOML_INCLUDE) +endif () diff --git a/cmake/dependencies/netmap.cmake b/cmake/dependencies/netmap.cmake new file mode 100644 index 00000000..d8d3781b --- /dev/null +++ b/cmake/dependencies/netmap.cmake @@ -0,0 +1,18 @@ +# netmap support (optional acceleration) +find_path(NETMAP_C_INCLUDE_DIR + net/netmap_user.h + HINTS /usr/include /usr/local/include) + +mark_as_advanced(NETMAP_C_INCLUDE_DIR) + +if (NOT HAVE_RAW_SOCKETS AND NOT HAVE_BPF AND NETMAP_C_INCLUDE_DIR) + set(DISABLE_NETMAP FALSE CACHE BOOL + "Disable netmap support for ETH IPCPs") + if (NOT DISABLE_NETMAP) + message(STATUS "Netmap support for Ethernet IPCPs enabled") + set(HAVE_NETMAP TRUE) + else () + message(STATUS "Netmap support for Ethernet IPCPs disabled by user") + unset(HAVE_NETMAP) + endif () +endif () diff --git a/cmake/dependencies/openssl.cmake b/cmake/dependencies/openssl.cmake new file mode 100644 index 00000000..604d5d99 --- /dev/null +++ b/cmake/dependencies/openssl.cmake @@ -0,0 +1,26 @@ +find_package(OpenSSL QUIET) +if (OPENSSL_FOUND) + set(HAVE_OPENSSL_RNG TRUE) + if (OPENSSL_VERSION VERSION_LESS "1.1.0") + message(STATUS "Install version >= \"1.1.0\" to enable OpenSSL support " + "(found version \"${OPENSSL_VERSION}\")") + else () + set(DISABLE_OPENSSL FALSE CACHE BOOL "Disable OpenSSL support") + if (NOT DISABLE_OPENSSL) + message(STATUS "OpenSSL support enabled") + set(HAVE_OPENSSL TRUE CACHE INTERNAL "") + else() + message(STATUS "OpenSSL support disabled") + unset(HAVE_OPENSSL CACHE) + endif() + endif () +else() + message(STATUS "Install openSSL version >= \"1.1.0\" to enable OpenSSL support") + unset(HAVE_OPENSSL_RNG) + unset(HAVE_OPENSSL CACHE) + set(OPENSSL_INCLUDE_DIR "") + set(OPENSSL_LIBRARIES "") + set(OPENSSL_CRYPTO_LIBRARY "") +endif () + +mark_as_advanced(OPENSSL_LIBRARIES OPENSSL_CRYPTO_LIBRARY) diff --git a/cmake/dependencies/protobufc.cmake b/cmake/dependencies/protobufc.cmake new file mode 100644 index 00000000..f1fab59d --- /dev/null +++ b/cmake/dependencies/protobufc.cmake @@ -0,0 +1,11 @@ +list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/utils") + +find_package(ProtobufC QUIET) +if (NOT (PROTOBUF_C_INCLUDE_DIRS AND PROTOBUF_C_LIBRARY + AND PROTOBUF_PROTOC_C_EXECUTABLE)) + message(FATAL_ERROR "Protobuf C compiler required but not found. " + "Please install Google Protocol Buffers.") +else () + message(STATUS "Found protobuf C compiler in ${PROTOBUF_PROTOC_C_EXECUTABLE}") +endif () +include_directories(${PROTOBUF_C_INCLUDE_DIRS}) diff --git a/cmake/dependencies/rawsockets.cmake b/cmake/dependencies/rawsockets.cmake new file mode 100644 index 00000000..92f7b8b7 --- /dev/null +++ b/cmake/dependencies/rawsockets.cmake @@ -0,0 +1,12 @@ +# Raw sockets support (Linux only) +if (CMAKE_SYSTEM_NAME STREQUAL "Linux") + set(DISABLE_RAW_SOCKETS FALSE CACHE BOOL + "Disable raw socket support for Ethernet IPCPs") + if (NOT DISABLE_RAW_SOCKETS) + message(STATUS "Raw socket support for Ethernet IPCPs enabled") + set(HAVE_RAW_SOCKETS TRUE) + else () + message(STATUS "Raw socket support for Ethernet IPCPs disabled by user") + unset(HAVE_RAW_SOCKETS) + endif () +endif () diff --git a/cmake/dependencies/robustmutex.cmake b/cmake/dependencies/robustmutex.cmake new file mode 100644 index 00000000..94aec8f0 --- /dev/null +++ b/cmake/dependencies/robustmutex.cmake @@ -0,0 +1,18 @@ +list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_POSIX_C_SOURCE=200809L) +list(APPEND CMAKE_REQUIRED_DEFINITIONS -D__XSI_VISIBLE=500) +list(APPEND CMAKE_REQUIRED_LIBRARIES pthread) +check_symbol_exists(pthread_mutexattr_setrobust pthread.h HAVE_ROBUST_MUTEX) + +if (HAVE_ROBUST_MUTEX) + set(DISABLE_ROBUST_MUTEXES FALSE CACHE BOOL "Disable robust mutex support") + if (NOT DISABLE_ROBUST_MUTEXES) + message(STATUS "Robust mutex support enabled") + set(HAVE_ROBUST_MUTEX TRUE) + else () + message(STATUS "Robust mutex support disabled by user") + unset(HAVE_ROBUST_MUTEX) + endif () +else() + message(STATUS "Robust mutex support not available") + unset(HAVE_ROBUST_MUTEX) +endif () diff --git a/cmake/dependencies/sysrandom.cmake b/cmake/dependencies/sysrandom.cmake new file mode 100644 index 00000000..972db801 --- /dev/null +++ b/cmake/dependencies/sysrandom.cmake @@ -0,0 +1,21 @@ +if (APPLE OR CMAKE_SYSTEM_NAME STREQUAL "FreeBSD") + set(SYS_RND_HDR "") +else () + find_path(SYS_RND_HDR sys/random.h PATH /usr/include/ /usr/local/include/) + if (SYS_RND_HDR) + message(STATUS "Found sys/random.h in ${SYS_RND_HDR}") + set(HAVE_SYS_RANDOM TRUE) + else () + set(SYS_RND_HDR "") + unset(HAVE_SYS_RANDOM) + endif () +endif() + +# Validate that at least one secure random generator is available +if (NOT ((CMAKE_SYSTEM_NAME STREQUAL "FreeBSD") OR APPLE OR + HAVE_SYS_RANDOM OR HAVE_OPENSSL_RNG OR HAVE_LIBGCRYPT)) + message(FATAL_ERROR "No secure random generator found, " + "please install libgcrypt (> 1.7.0) or OpenSSL") +endif () + +mark_as_advanced(SYS_RND_HDR) diff --git a/cmake/dependencies/systemlibraries.cmake b/cmake/dependencies/systemlibraries.cmake new file mode 100644 index 00000000..e00266d6 --- /dev/null +++ b/cmake/dependencies/systemlibraries.cmake @@ -0,0 +1,20 @@ +if (NOT APPLE) + find_library(LIBRT_LIBRARIES rt) + if (NOT LIBRT_LIBRARIES) + message(FATAL_ERROR "Could not find librt") + endif () +else () + set(LIBRT_LIBRARIES "") +endif () + +find_library(LIBPTHREAD_LIBRARIES pthread) +if (NOT LIBPTHREAD_LIBRARIES) + message(FATAL_ERROR "Could not find libpthread") +endif () + +find_library(LIBM_LIBRARIES m) +if (NOT LIBM_LIBRARIES) + message(FATAL_ERROR "Could not find libm") +endif () + +mark_as_advanced(LIBRT_LIBRARIES LIBPTHREAD_LIBRARIES LIBM_LIBRARIES) diff --git a/cmake/doc.cmake b/cmake/doc.cmake new file mode 100644 index 00000000..16991f82 --- /dev/null +++ b/cmake/doc.cmake @@ -0,0 +1,64 @@ +set(DOC_SOURCE_DIR "${CMAKE_SOURCE_DIR}/doc") +set(DOC_BINARY_DIR "${CMAKE_BINARY_DIR}/doc") + +set(MAN_NAMES + # Add man page sources here + flow_accept.3 + flow_alloc.3 + flow_dealloc.3 + flow_read.3 + flow_write.3 + fccntl.3 + fqueue.3 + fqueue_create.3 + fqueue_destroy.3 + fqueue_next.3 + fevent.3 + fset.3 + fset_create.3 + fset_destroy.3 + fset_zero.3 + fset_add.3 + fset_del.3 + fset_has.3 + ouroboros-glossary.7 + ouroboros-tutorial.7 + ouroboros.8 + irmd.8 + irm.8 + ) + +macro(INSTALL_MAN __mans) + foreach (_man ${ARGV}) + string(REGEX REPLACE "^.+[.]([1-9]).gz" "\\1" _mansect ${_man}) + install(FILES ${_man} DESTINATION "${CMAKE_INSTALL_MANDIR}/man${_mansect}") + endforeach (_man) +endmacro(INSTALL_MAN __mans) + +find_program(GZIP_EXECUTABLE + NAMES gzip + DOC "Will gzip the man pages") + +mark_as_advanced(GZIP_EXECUTABLE) + +if (GZIP_EXECUTABLE) + # Create the doc output directory + file(MAKE_DIRECTORY ${DOC_BINARY_DIR}) + + foreach (m ${MAN_NAMES}) + set(md ${DOC_BINARY_DIR}/${m}.gz) + + add_custom_command( + OUTPUT ${md} + COMMAND ${GZIP_EXECUTABLE} + ARGS -c ${DOC_SOURCE_DIR}/man/${m} > ${md} + COMMENT "Compressing manpage ${m}" + VERBATIM) + + set(MAN_FILES ${MAN_FILES} ${md}) + endforeach () + + add_custom_target(man ALL DEPENDS ${MAN_FILES}) + + INSTALL_MAN(${MAN_FILES}) +endif () diff --git a/cmake/include.cmake b/cmake/include.cmake new file mode 100644 index 00000000..c14d205d --- /dev/null +++ b/cmake/include.cmake @@ -0,0 +1,28 @@ +set(HEADERS_SOURCE_DIR "${CMAKE_SOURCE_DIR}/include/ouroboros") + +set(SOCK_BUF_SIZE 10240 CACHE STRING + "Size of the buffer used by the UNIX sockets for local IPC") + +configure_file("${CMAKE_SOURCE_DIR}/include/ouroboros/version.h.in" + "${CMAKE_BINARY_DIR}/include/ouroboros/version.h" @ONLY) + +configure_file("${CMAKE_SOURCE_DIR}/include/ouroboros/sockets.h.in" + "${CMAKE_BINARY_DIR}/include/ouroboros/sockets.h" @ONLY) + +set(PUBLIC_HEADER_FILES + ${HEADERS_SOURCE_DIR}/cep.h + ${HEADERS_SOURCE_DIR}/cdefs.h + ${HEADERS_SOURCE_DIR}/dev.h + ${HEADERS_SOURCE_DIR}/errno.h + ${HEADERS_SOURCE_DIR}/fccntl.h + ${HEADERS_SOURCE_DIR}/fqueue.h + ${HEADERS_SOURCE_DIR}/ipcp.h + ${HEADERS_SOURCE_DIR}/irm.h + ${HEADERS_SOURCE_DIR}/name.h + ${HEADERS_SOURCE_DIR}/proto.h + ${HEADERS_SOURCE_DIR}/qos.h + ${CMAKE_BINARY_DIR}/include/ouroboros/version.h + ) + +install(FILES ${PUBLIC_HEADER_FILES} + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/ouroboros) diff --git a/cmake/install.cmake b/cmake/install.cmake new file mode 100644 index 00000000..21a8cd52 --- /dev/null +++ b/cmake/install.cmake @@ -0,0 +1,64 @@ +# Installation configuration + +# Install pkg-config files +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ouroboros-dev.pc" + DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") + +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ouroboros-irm.pc" + DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") + +# Systemd service file installation +set(SYSTEMD_INSTALL_FILES "DETECT" CACHE STRING + "Install systemd .service files (NO (never), DETECT (use pkg-config - default),\ + FORCE (always - see SYSTEMD_UNITDIR_OVERRIDE))") +set(SYSTEMD_UNITDIR_OVERRIDE "" CACHE PATH + "Path to install systemd files. When SYSTEMD_INSTALL_FILES == DETECT, this\ + can be empty to automatically determine the path. Cannot be empty when FORCE.") + +if (SYSTEMD_INSTALL_FILES STREQUAL "DETECT" OR SYSTEMD_INSTALL_FILES STREQUAL "FORCE") + if (SYSTEMD_INSTALL_FILES STREQUAL "DETECT") + pkg_check_modules(SYSTEMD "systemd") + if (SYSTEMD_FOUND) + if ("${SYSTEMD_UNITDIR_OVERRIDE}" STREQUAL "") + execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} + --variable=systemdsystemunitdir systemd + OUTPUT_VARIABLE SYSTEMD_UNITDIR_INTERNAL) + string(REGEX REPLACE "[ \t\n]+" "" SYSTEMD_UNITDIR_INTERNAL + "${SYSTEMD_UNITDIR_INTERNAL}" + ) + else () + set(SYSTEMD_UNITDIR_INTERNAL "${SYSTEMD_UNITDIR_OVERRIDE}") + endif () + else () + set(SYSTEMD_UNITDIR_INTERNAL "") + endif () + elseif (SYSTEMD_INSTALL_FILES STREQUAL "FORCE") + if ("${SYSTEMD_UNITDIR_OVERRIDE}" STREQUAL "") + message(FATAL_ERROR "Systemd installation required by user, but no path\ + provided with SYSTEMD_UNITDIR_OVERRIDE.") + else () + set(SYSTEMD_UNITDIR_INTERNAL "${SYSTEMD_UNITDIR_OVERRIDE}") + endif () + endif() + if (NOT ${SYSTEMD_UNITDIR_INTERNAL} STREQUAL "") + message(STATUS "Systemd service installation enabled to: ${SYSTEMD_UNITDIR_INTERNAL}") + if (LIBTOML_LIBRARIES AND NOT DISABLE_CONFIGFILE) + set (CONFIGURE_STRING "--config ${OUROBOROS_CONFIG_DIR}/${OUROBOROS_CONFIG_FILE}") + else () + set (CONFIGURE_STRING "") + endif () + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/ouroboros.service.in" + "${CMAKE_CURRENT_BINARY_DIR}/ouroboros.service" @ONLY) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ouroboros.service" + DESTINATION "${SYSTEMD_UNITDIR_INTERNAL}") + endif () +else () + message(STATUS "Systemd service installation disabled by user") +endif() + +# Uninstall target +configure_file("${CMAKE_SOURCE_DIR}/cmake/utils/CMakeUninstall.cmake.in" + "${CMAKE_BINARY_DIR}/cmake/cmakeuninstall.cmake" IMMEDIATE @ONLY) + +add_custom_target(uninstall + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_BINARY_DIR}/cmake/cmakeuninstall.cmake) diff --git a/cmake/ipcp.cmake b/cmake/ipcp.cmake new file mode 100644 index 00000000..6839fcc2 --- /dev/null +++ b/cmake/ipcp.cmake @@ -0,0 +1,10 @@ +include(ipcp/ipcp) +include(ipcp/eth) +include(ipcp/udp) +include(ipcp/local) +include(ipcp/broadcast) +include(ipcp/unicast) + +configure_file("${IPCP_SOURCE_DIR}/config.h.in" + "${IPCP_BINARY_DIR}/config.h" @ONLY) + diff --git a/cmake/ipcp/broadcast.cmake b/cmake/ipcp/broadcast.cmake new file mode 100644 index 00000000..20610a25 --- /dev/null +++ b/cmake/ipcp/broadcast.cmake @@ -0,0 +1,22 @@ +set(BROADCAST_SOURCE_DIR "${IPCP_SOURCE_DIR}/broadcast") + +set(IPCP_BROADCAST_TARGET ipcpd-broadcast CACHE INTERNAL "") + +set(IPCP_BROADCAST_MPL 100 CACHE STRING + "Default maximum packet lifetime for the Broadcast IPCP, in ms") + +set(BROADCAST_SOURCES + "${BROADCAST_SOURCE_DIR}/connmgr.c" + "${BROADCAST_SOURCE_DIR}/dt.c" + "${BROADCAST_SOURCE_DIR}/main.c" +) + +add_executable(${IPCP_BROADCAST_TARGET} + ${BROADCAST_SOURCES} + ${IPCP_SOURCES} + ${COMMON_SOURCES} +) + +target_include_directories(${IPCP_BROADCAST_TARGET} PRIVATE ${IPCP_INCLUDE_DIRS}) +target_link_libraries(${IPCP_BROADCAST_TARGET} PUBLIC ouroboros-dev) +install(TARGETS ${IPCP_BROADCAST_TARGET} RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/ipcp/eth.cmake b/cmake/ipcp/eth.cmake new file mode 100644 index 00000000..0d37bf9b --- /dev/null +++ b/cmake/ipcp/eth.cmake @@ -0,0 +1,40 @@ +set(ETH_SOURCE_DIR "${IPCP_SOURCE_DIR}/eth") + +set(IPCP_ETH_LLC_TARGET ipcpd-eth-llc CACHE INTERNAL "") +set(IPCP_ETH_DIX_TARGET ipcpd-eth-dix CACHE INTERNAL "") + +set(IPCP_ETH_RD_THR 1 CACHE STRING + "Number of reader threads in Ethernet IPCP") +set(IPCP_ETH_WR_THR 1 CACHE STRING + "Number of writer threads in Ethernet IPCP") +set(IPCP_ETH_QDISC_BYPASS false CACHE BOOL + "Bypass the Qdisc in the kernel when using raw sockets") +set(IPCP_ETH_LO_MTU 1500 CACHE STRING + "Restrict Ethernet MTU over loopback interfaces") +set(IPCP_ETH_MPL 100 CACHE STRING + "Default maximum packet lifetime for the Ethernet IPCPs, in ms") + +if (HAVE_RAW_SOCKETS OR HAVE_BPF OR HAVE_NETMAP) + set(HAVE_ETH TRUE) +else () + unset(HAVE_ETH) +endif () + +if (HAVE_ETH) + add_executable(${IPCP_ETH_LLC_TARGET} "${ETH_SOURCE_DIR}/llc.c" ${IPCP_SOURCES}) + add_executable(${IPCP_ETH_DIX_TARGET} "${ETH_SOURCE_DIR}/dix.c" ${IPCP_SOURCES}) + + foreach(target ${IPCP_ETH_LLC_TARGET} ${IPCP_ETH_DIX_TARGET}) + target_include_directories(${target} PRIVATE ${IPCP_INCLUDE_DIRS}) + if (HAVE_BPF AND NOT APPLE) + target_include_directories(${target} PRIVATE ${BPF_C_INCLUDE_DIR}) + endif () + if (HAVE_NETMAP AND NOT APPLE) + set_target_properties(${target} PROPERTIES COMPILE_FLAGS "${CMAKE_C_FLAGS} -std=c99") + target_include_directories(${target} PRIVATE ${NETMAP_C_INCLUDE_DIR}) + endif () + target_link_libraries(${target} PUBLIC ouroboros-dev) + endforeach() + + install(TARGETS ${IPCP_ETH_LLC_TARGET} ${IPCP_ETH_DIX_TARGET} RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) +endif () diff --git a/cmake/ipcp/ipcp.cmake b/cmake/ipcp/ipcp.cmake new file mode 100644 index 00000000..5b1eef09 --- /dev/null +++ b/cmake/ipcp/ipcp.cmake @@ -0,0 +1,58 @@ +set(IPCP_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/ipcpd") +set(IPCP_BINARY_DIR "${CMAKE_BINARY_DIR}/src/ipcpd") + +set(CONNMGR_RCV_TIMEOUT 1000 CACHE STRING + "Timeout for the connection manager to wait for OCEP info (ms).") +set(IPCP_DEBUG_LOCAL FALSE CACHE BOOL + "Use PID as address for local debugging") +set(IPCP_QOS_CUBE_BE_PRIO 50 CACHE STRING + "Priority for best effort QoS cube (0-99)") +set(IPCP_QOS_CUBE_VIDEO_PRIO 90 CACHE STRING + "Priority for video QoS cube (0-99)") +set(IPCP_QOS_CUBE_VOICE_PRIO 99 CACHE STRING + "Priority for voice QoS cube (0-99)") +set(IPCP_MIN_THREADS 4 CACHE STRING + "Minimum number of worker threads in the IPCP") +set(IPCP_ADD_THREADS 4 CACHE STRING + "Number of extra threads to start when an IPCP faces thread starvation") +set(IPCP_SCHED_THR_MUL 2 CACHE STRING + "Number of scheduler threads per QoS cube") +set(DISABLE_CORE_LOCK TRUE CACHE BOOL + "Disable locking performance threads to a core") + +if (CMAKE_SYSTEM_NAME STREQUAL "Linux") + set(IPCP_LINUX_TIMERSLACK_NS 1000 CACHE STRING + "Slack value for high resolution timers on Linux systems.") +endif () + +if ((IPCP_QOS_CUBE_BE_PRIO LESS 0) OR (IPCP_QOS_CUBE_BE_PRIO GREATER 99)) + message(FATAL_ERROR "Invalid priority for best effort QoS cube") +endif () + +if ((IPCP_QOS_CUBE_VIDEO_PRIO LESS 0) OR (IPCP_QOS_CUBE_VIDEO_PRIO GREATER 99)) + message(FATAL_ERROR "Invalid priority for video QoS cube") +endif () + +if ((IPCP_QOS_CUBE_VOICE_PRIO LESS 0) OR (IPCP_QOS_CUBE_VOICE_PRIO GREATER 99)) + message(FATAL_ERROR "Invalid priority for voice QoS cube") +endif () + +if ((DHT_ENROLL_SLACK LESS 0) OR (DHT_ENROLL_SLACK GREATER 999)) + message(FATAL_ERROR "Invalid DHT slack value") +endif () + +set(IPCP_SOURCES + "${IPCP_SOURCE_DIR}/ipcp.c" + "${IPCP_SOURCE_DIR}/shim-data.c" +) + +set(COMMON_SOURCES + "${IPCP_SOURCE_DIR}/common/enroll.c" +) + +set(IPCP_INCLUDE_DIRS + ${IPCP_SOURCE_DIR} + ${IPCP_BINARY_DIR} + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_BINARY_DIR}/include +) diff --git a/cmake/ipcp/local.cmake b/cmake/ipcp/local.cmake new file mode 100644 index 00000000..9e320aad --- /dev/null +++ b/cmake/ipcp/local.cmake @@ -0,0 +1,11 @@ +set(LOCAL_SOURCE_DIR "${IPCP_SOURCE_DIR}/local") + +set(IPCP_LOCAL_TARGET ipcpd-local CACHE INTERNAL "") + +set(IPCP_LOCAL_MPL 100 CACHE STRING + "Default maximum packet lifetime for the Local IPCP, in ms") + +add_executable(${IPCP_LOCAL_TARGET} "${LOCAL_SOURCE_DIR}/main.c" ${IPCP_SOURCES}) +target_include_directories(${IPCP_LOCAL_TARGET} PRIVATE ${IPCP_INCLUDE_DIRS}) +target_link_libraries(${IPCP_LOCAL_TARGET} PUBLIC ouroboros-dev) +install(TARGETS ${IPCP_LOCAL_TARGET} RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/ipcp/udp.cmake b/cmake/ipcp/udp.cmake new file mode 100644 index 00000000..7195dfa1 --- /dev/null +++ b/cmake/ipcp/udp.cmake @@ -0,0 +1,51 @@ +set(UDP_SOURCE_DIR "${IPCP_SOURCE_DIR}/udp") + +set(IPCP_UDP4_TARGET ipcpd-udp4 CACHE INTERNAL "") +set(IPCP_UDP6_TARGET ipcpd-udp6 CACHE INTERNAL "") + +set(IPCP_UDP_RD_THR 3 CACHE STRING + "Number of reader threads in UDP IPCPs") +set(IPCP_UDP_WR_THR 3 CACHE STRING + "Number of writer threads in UDP IPCPs") +set(IPCP_UDP_MPL 5000 CACHE STRING + "Default maximum packet lifetime for the UDP IPCPs, in ms") + +# Find nsupdate and nslookup for DDNS support +find_program(NSUPDATE_EXECUTABLE + NAMES nsupdate + DOC "The nsupdate tool that enables DDNS") + +find_program(NSLOOKUP_EXECUTABLE + NAMES nslookup + DOC "The nslookup tool that resolves DNS names") + +mark_as_advanced(NSLOOKUP_EXECUTABLE NSUPDATE_EXECUTABLE) + +if (NSLOOKUP_EXECUTABLE AND NSUPDATE_EXECUTABLE) + set(DISABLE_DDNS FALSE CACHE BOOL "Disable DDNS support") + if (NOT DISABLE_DDNS) + message(STATUS "DDNS support enabled") + set(HAVE_DDNS TRUE CACHE INTERNAL "") + else () + message(STATUS "DDNS support disabled by user") + unset(HAVE_DDNS CACHE) + endif () +else () + if (NSLOOKUP_EXECUTABLE) + message(STATUS "Install nsupdate to enable DDNS support") + elseif (NSUPDATE_EXECUTABLE) + message(STATUS "Install nslookup to enable DDNS support") + else () + message(STATUS "Install nslookup and nsupdate to enable DDNS support") + endif () +endif () + +add_executable(${IPCP_UDP4_TARGET} "${UDP_SOURCE_DIR}/udp4.c" ${IPCP_SOURCES}) +add_executable(${IPCP_UDP6_TARGET} "${UDP_SOURCE_DIR}/udp6.c" ${IPCP_SOURCES}) + +foreach(target ${IPCP_UDP4_TARGET} ${IPCP_UDP6_TARGET}) + target_include_directories(${target} PRIVATE ${IPCP_INCLUDE_DIRS}) + target_link_libraries(${target} PUBLIC ouroboros-dev) +endforeach() + +install(TARGETS ${IPCP_UDP4_TARGET} ${IPCP_UDP6_TARGET} RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/ipcp/unicast.cmake b/cmake/ipcp/unicast.cmake new file mode 100644 index 00000000..2a2f7a3f --- /dev/null +++ b/cmake/ipcp/unicast.cmake @@ -0,0 +1,50 @@ +set(UNICAST_SOURCE_DIR "${IPCP_SOURCE_DIR}/unicast") +set(UNICAST_BINARY_DIR "${IPCP_BINARY_DIR}/unicast") + +set(IPCP_UNICAST_TARGET ipcpd-unicast CACHE INTERNAL "") + +set(IPCP_UNICAST_MPL 100 CACHE STRING + "Default maximum packet lifetime for the Unicast IPCP, in ms") +set(PFT_SIZE 256 CACHE STRING + "Prefix forwarding table size for the Unicast IPCP") +set(DEBUG_PROTO_DHT FALSE CACHE BOOL + "Add DHT protocol debug logging") +set(DEBUG_PROTO_LS FALSE CACHE BOOL + "Add link state protocol debug logging") + +# Generate DHT protobuf files +protobuf_generate_c(DHT_PROTO_SRCS DHT_PROTO_HDRS "${UNICAST_SOURCE_DIR}/dir/dht.proto") + +set (UNICAST_SOURCES + "${UNICAST_SOURCE_DIR}/addr-auth.c" + "${UNICAST_SOURCE_DIR}/ca.c" + "${UNICAST_SOURCE_DIR}/connmgr.c" + "${UNICAST_SOURCE_DIR}/dir.c" + "${UNICAST_SOURCE_DIR}/dt.c" + "${UNICAST_SOURCE_DIR}/fa.c" + "${UNICAST_SOURCE_DIR}/main.c" + "${UNICAST_SOURCE_DIR}/pff.c" + "${UNICAST_SOURCE_DIR}/routing.c" + "${UNICAST_SOURCE_DIR}/psched.c" + "${UNICAST_SOURCE_DIR}/addr-auth/flat.c" + "${UNICAST_SOURCE_DIR}/ca/mb-ecn.c" + "${UNICAST_SOURCE_DIR}/ca/nop.c" + "${UNICAST_SOURCE_DIR}/dir/dht.c" + "${UNICAST_SOURCE_DIR}/pff/simple.c" + "${UNICAST_SOURCE_DIR}/pff/alternate.c" + "${UNICAST_SOURCE_DIR}/pff/multipath.c" + "${UNICAST_SOURCE_DIR}/pff/pft.c" + "${UNICAST_SOURCE_DIR}/routing/link-state.c" + "${UNICAST_SOURCE_DIR}/routing/graph.c" +) + +add_executable(${IPCP_UNICAST_TARGET} + ${UNICAST_SOURCES} + ${IPCP_SOURCES} + ${COMMON_SOURCES} + ${DHT_PROTO_SRCS} +) +target_include_directories(${IPCP_UNICAST_TARGET} PRIVATE ${IPCP_INCLUDE_DIRS}) +target_include_directories(${IPCP_UNICAST_TARGET} PRIVATE "${UNICAST_SOURCE_DIR}") +target_link_libraries(${IPCP_UNICAST_TARGET} PUBLIC ouroboros-dev) +install(TARGETS ${IPCP_UNICAST_TARGET} RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/irmd.cmake b/cmake/irmd.cmake new file mode 100644 index 00000000..d4b4808c --- /dev/null +++ b/cmake/irmd.cmake @@ -0,0 +1,115 @@ +set(IRMD_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/irmd") +set(IRMD_BINARY_DIR "${CMAKE_BINARY_DIR}/src/irmd") + +set(OUROBOROS_CONFIG_DIR /etc/ouroboros CACHE STRING + "Configuration directory (should be absolute)") + +# Configuration file support +set(OUROBOROS_SECURITY_DIR "${OUROBOROS_CONFIG_DIR}/security" CACHE STRING + "Security directory holding authentication information") +set(OUROBOROS_CA_CRT_DIR "${OUROBOROS_SECURITY_DIR}/cacert" CACHE STRING + "Directory holding trusted CA certificates") +set(OUROBOROS_SRV_CRT_DIR "${OUROBOROS_SECURITY_DIR}/server" CACHE STRING + "Directory holding server certificates") +set(OUROBOROS_CLI_CRT_DIR "${OUROBOROS_SECURITY_DIR}/client" CACHE STRING + "Directory holding client certificates") +set(OUROBOROS_UNTRUSTED_DIR "${OUROBOROS_SECURITY_DIR}/untrusted" CACHE STRING + "Directory holding untrusted intermediate certificates") + +# IRMd timeouts and parameters +set(IRMD_REQ_ARR_TIMEOUT 1000 CACHE STRING + "Timeout for an application to respond to a new flow (ms)") +set(BOOTSTRAP_TIMEOUT 5000 CACHE STRING + "Timeout for an IPCP to bootstrap (ms)") +set(ENROLL_TIMEOUT 20000 CACHE STRING + "Timeout for an IPCP to enroll (ms)") +set(REG_TIMEOUT 20000 CACHE STRING + "Timeout for registering a name (ms)") +set(QUERY_TIMEOUT 200 CACHE STRING + "Timeout to query a name with an IPCP (ms)") +set(CONNECT_TIMEOUT 20000 CACHE STRING + "Timeout to connect an IPCP to another IPCP (ms)") +set(FLOW_ALLOC_TIMEOUT 20000 CACHE STRING + "Timeout for a flow allocation response (ms)") +set(IRMD_MIN_THREADS 8 CACHE STRING + "Minimum number of worker threads in the IRMd") +set(IRMD_ADD_THREADS 8 CACHE STRING + "Number of extra threads to start when the IRMD faces thread starvation") +set(IRMD_PKILL_TIMEOUT 30 CACHE STRING + "Number of seconds to wait before sending SIGKILL to subprocesses on exit") +set(IRMD_KILL_ALL_PROCESSES TRUE CACHE BOOL + "Kill all processes on exit") +set(DEBUG_PROTO_OAP FALSE CACHE BOOL + "Add Flow allocation protocol message output to IRMd debug logging") + +# Configuration file support (libtoml) +if (LIBTOML_LIBRARIES) + set(DISABLE_CONFIGFILE FALSE CACHE BOOL + "Disable configuration file support") + if (NOT DISABLE_CONFIGFILE) + set(OUROBOROS_CONFIG_FILE irmd.conf CACHE STRING + "Name of the IRMd configuration file") + set(HAVE_TOML TRUE) + message(STATUS "Configuration file support enabled") + message(STATUS "Configuration directory: ${OUROBOROS_CONFIG_DIR}") + set(INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}") + configure_file("${CMAKE_SOURCE_DIR}/irmd.conf.in" + "${CMAKE_BINARY_DIR}/${OUROBOROS_CONFIG_FILE}.example" @ONLY) + install(FILES "${CMAKE_BINARY_DIR}/${OUROBOROS_CONFIG_FILE}.example" + DESTINATION "${OUROBOROS_CONFIG_DIR}") + install(CODE " + if (NOT EXISTS \"${OUROBOROS_CONFIG_DIR}/${OUROBOROS_CONFIG_FILE}\") + file(WRITE \"${OUROBOROS_CONFIG_DIR}/${OUROBOROS_CONFIG_FILE}\" \"\") + endif() + ") + unset(INSTALL_DIR) + else () + message(STATUS "Configuration file support disabled by user") + unset(OUROBOROS_CONFIG_FILE CACHE) + set(HAVE_TOML FALSE) + endif () +else () + message(STATUS "Install tomlc99 for config file support") + message(STATUS " https://github.com/cktan/tomlc99") + unset(HAVE_TOML) +endif () + +configure_file("${IRMD_SOURCE_DIR}/config.h.in" + "${IRMD_BINARY_DIR}/config.h" @ONLY) + +set(IRMD_SOURCES + "${IRMD_SOURCE_DIR}/ipcp.c" + "${IRMD_SOURCE_DIR}/configfile.c" + "${IRMD_SOURCE_DIR}/main.c" + "${IRMD_SOURCE_DIR}/oap.c" + "${IRMD_SOURCE_DIR}/reg/flow.c" + "${IRMD_SOURCE_DIR}/reg/ipcp.c" + "${IRMD_SOURCE_DIR}/reg/proc.c" + "${IRMD_SOURCE_DIR}/reg/prog.c" + "${IRMD_SOURCE_DIR}/reg/name.c" + "${IRMD_SOURCE_DIR}/reg/reg.c" +) + +add_executable(irmd ${IRMD_SOURCES}) + +target_include_directories(irmd PRIVATE + "${IRMD_SOURCE_DIR}" + "${IRMD_BINARY_DIR}" + "${CMAKE_SOURCE_DIR}/include" + "${CMAKE_BINARY_DIR}/include") + +target_link_libraries(irmd PUBLIC ouroboros-common) +if (LIBTOML_LIBRARIES) + target_link_libraries(irmd PUBLIC ${LIBTOML_LIBRARIES}) +endif () + +if (HAVE_TOML) + target_include_directories(irmd PRIVATE ${LIBTOML_INCLUDE}) +endif () + +include(utils/AddCompileFlags) +if (CMAKE_BUILD_TYPE MATCHES "Debug*") + add_compile_flags(irmd -DCONFIG_OUROBOROS_DEBUG) +endif () + +install(TARGETS irmd RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/lib.cmake b/cmake/lib.cmake new file mode 100644 index 00000000..6d9333a3 --- /dev/null +++ b/cmake/lib.cmake @@ -0,0 +1,7 @@ +include(lib/lib) +include(lib/common) +include(lib/dev) +include(lib/irm) + +configure_file("${LIB_SOURCE_DIR}/config.h.in" + "${LIB_BINARY_DIR}/config.h" @ONLY) diff --git a/cmake/lib/common.cmake b/cmake/lib/common.cmake new file mode 100644 index 00000000..1e834f10 --- /dev/null +++ b/cmake/lib/common.cmake @@ -0,0 +1,124 @@ +# Common library configuration + +set(LIB_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/lib") +set(LIB_BINARY_DIR "${CMAKE_BINARY_DIR}/src/lib") + +# Protobuf files +set_source_files_properties( + "${LIB_SOURCE_DIR}/pb/model.proto" + "${LIB_SOURCE_DIR}/pb/ipcp_config.proto" + "${LIB_SOURCE_DIR}/pb/enroll.proto" + "${LIB_SOURCE_DIR}/pb/cep.proto" + "${LIB_SOURCE_DIR}/pb/irm.proto" + "${LIB_SOURCE_DIR}/pb/ipcp.proto" + PROPERTIES + COMPILE_FLAGS "-I${LIB_SOURCE_DIR}/pb" +) + +protobuf_generate_c(MODEL_PROTO_SRCS MODEL_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/model.proto") +protobuf_generate_c(IPCP_CONFIG_PROTO_SRCS IPCP_CONFIG_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/ipcp_config.proto") +protobuf_generate_c(ENROLL_PROTO_SRCS ENROLL_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/enroll.proto") +protobuf_generate_c(CEP_PROTO_SRCS CEP_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/cep.proto") +protobuf_generate_c(IRM_PROTO_SRCS IRM_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/irm.proto") +protobuf_generate_c(IPCP_PROTO_SRCS IPCP_PROTO_HDRS + "${LIB_SOURCE_DIR}/pb/ipcp.proto") + +# Common library source files +set(SOURCE_FILES_COMMON + bitmap.c + btree.c + crc32.c + crypt.c + hash.c + list.c + lockfile.c + logs.c + md5.c + notifier.c + protobuf.c + qoscube.c + random.c + rib.c + serdes-irm.c + serdes-oep.c + sha3.c + shm_flow_set.c + shm_rbuff.c + shm_rdrbuff.c + sockets.c + tpm.c + utils.c +) + +# Convert relative paths to absolute +set(SOURCE_FILES_COMMON_ABS) +foreach(src ${SOURCE_FILES_COMMON}) + list(APPEND SOURCE_FILES_COMMON_ABS "${LIB_SOURCE_DIR}/${src}") +endforeach() + +if (HAVE_OPENSSL) + set(OPENSSL_SOURCES "${LIB_SOURCE_DIR}/crypt/openssl.c") +else() + set(OPENSSL_SOURCES "") +endif() + +add_library(ouroboros-common SHARED + ${SOURCE_FILES_COMMON_ABS} + ${IRM_PROTO_SRCS} + ${IPCP_PROTO_SRCS} + ${IPCP_CONFIG_PROTO_SRCS} + ${MODEL_PROTO_SRCS} + ${ENROLL_PROTO_SRCS} + ${OPENSSL_SOURCES}) + +set_target_properties(ouroboros-common PROPERTIES + VERSION ${PACKAGE_VERSION} + SOVERSION ${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}) + +include(utils/AddCompileFlags) +if (CMAKE_BUILD_TYPE MATCHES "Debug*") + add_compile_flags(ouroboros-common -DCONFIG_OUROBOROS_DEBUG) +endif () + +target_include_directories(ouroboros-common PUBLIC + ${LIB_SOURCE_DIR} + ${LIB_BINARY_DIR} + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_BINARY_DIR}/include + ${CMAKE_BINARY_DIR} + ${PROTOBUF_C_INCLUDE_DIRS} + ${SYS_RND_HDR}) + +if (LIBGCRYPT_INCLUDE_DIR) + target_include_directories(ouroboros-common PUBLIC ${LIBGCRYPT_INCLUDE_DIR}) +endif () + +if (OPENSSL_INCLUDE_DIR) + target_include_directories(ouroboros-common PUBLIC ${OPENSSL_INCLUDE_DIR}) +endif () + + +target_link_libraries(ouroboros-common + ${LIBRT_LIBRARIES} + ${LIBPTHREAD_LIBRARIES} + ${PROTOBUF_C_LIBRARY}) + +if (OPENSSL_CRYPTO_LIBRARY) + target_link_libraries(ouroboros-common ${OPENSSL_CRYPTO_LIBRARY}) +endif () + +if (LIBGCRYPT_LIBRARIES) + target_link_libraries(ouroboros-common ${LIBGCRYPT_LIBRARIES}) +endif () + +if (FUSE_LIBRARIES) + target_link_libraries(ouroboros-common ${FUSE_LIBRARIES}) +endif () + +install(TARGETS ouroboros-common LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) + diff --git a/cmake/lib/dev.cmake b/cmake/lib/dev.cmake new file mode 100644 index 00000000..21fe140d --- /dev/null +++ b/cmake/lib/dev.cmake @@ -0,0 +1,37 @@ +set(SOURCE_FILES_DEV + cep.c + dev.c +) + +# Convert relative paths to absolute +set(SOURCE_FILES_DEV_ABS) +foreach(src ${SOURCE_FILES_DEV}) + list(APPEND SOURCE_FILES_DEV_ABS "${LIB_SOURCE_DIR}/${src}") +endforeach() + +add_library(ouroboros-dev SHARED + ${SOURCE_FILES_DEV_ABS} + ${CEP_PROTO_SRCS}) + +set_target_properties(ouroboros-dev PROPERTIES + VERSION ${PACKAGE_VERSION} + SOVERSION ${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}) + +if (CMAKE_BUILD_TYPE MATCHES "Debug*") + add_compile_flags(ouroboros-dev -DCONFIG_OUROBOROS_DEBUG) +endif () + +target_include_directories(ouroboros-dev PUBLIC + ${LIB_SOURCE_DIR} + ${LIB_BINARY_DIR} + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_BINARY_DIR}/include + ${CMAKE_BINARY_DIR} + ${PROTOBUF_C_INCLUDE_DIRS} + ${SYS_RND_HDR} + ${LIBGCRYPT_INCLUDE_DIR} + ${OPENSSL_INCLUDE_DIR}) + +target_link_libraries(ouroboros-dev ouroboros-common) + +install(TARGETS ouroboros-dev LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) diff --git a/cmake/lib/irm.cmake b/cmake/lib/irm.cmake new file mode 100644 index 00000000..5e336b31 --- /dev/null +++ b/cmake/lib/irm.cmake @@ -0,0 +1,34 @@ +set(SOURCE_FILES_IRM + irm.c +) + +# Convert relative paths to absolute +set(SOURCE_FILES_IRM_ABS) +foreach(src ${SOURCE_FILES_IRM}) + list(APPEND SOURCE_FILES_IRM_ABS "${LIB_SOURCE_DIR}/${src}") +endforeach() + +add_library(ouroboros-irm SHARED ${SOURCE_FILES_IRM_ABS}) + +set_target_properties(ouroboros-irm PROPERTIES + VERSION ${PACKAGE_VERSION} + SOVERSION ${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}) + +if (CMAKE_BUILD_TYPE MATCHES "Debug*") + add_compile_flags(ouroboros-irm -DCONFIG_OUROBOROS_DEBUG) +endif () + +target_include_directories(ouroboros-irm PUBLIC + ${LIB_SOURCE_DIR} + ${LIB_BINARY_DIR} + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_BINARY_DIR}/include + ${CMAKE_BINARY_DIR} + ${PROTOBUF_C_INCLUDE_DIRS} + ${SYS_RND_HDR} + ${LIBGCRYPT_INCLUDE_DIR} + ${OPENSSL_INCLUDE_DIR}) + +target_link_libraries(ouroboros-irm ouroboros-common) + +install(TARGETS ouroboros-irm LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) diff --git a/cmake/lib/lib.cmake b/cmake/lib/lib.cmake new file mode 100644 index 00000000..674d8503 --- /dev/null +++ b/cmake/lib/lib.cmake @@ -0,0 +1,97 @@ +set(LIB_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/lib") +set(LIB_BINARY_DIR "${CMAKE_BINARY_DIR}/src/lib") + +# Library configuration variables +set(SHM_BUFFER_SIZE 16384 CACHE STRING + "Number of blocks in packet buffer, must be a power of 2") +set(SHM_RBUFF_SIZE 1024 CACHE STRING + "Number of blocks in rbuff buffer, must be a power of 2") +set(SYS_MAX_FLOWS 10240 CACHE STRING + "Maximum number of total flows for this system") +set(PROG_MAX_FLOWS 4096 CACHE STRING + "Maximum number of flows in an application") +set(PROG_RES_FDS 64 CACHE STRING + "Number of reserved flow descriptors per application") +set(PROG_MAX_FQUEUES 32 CACHE STRING + "Maximum number of flow sets per application") +set(DU_BUFF_HEADSPACE 256 CACHE STRING + "Bytes of headspace to reserve for future headers") +set(DU_BUFF_TAILSPACE 32 CACHE STRING + "Bytes of tailspace to reserve for future tails") + +if (NOT APPLE) + set(PTHREAD_COND_CLOCK "CLOCK_MONOTONIC" CACHE STRING + "Clock to use for condition variable timing") +else () + set(PTHREAD_COND_CLOCK "CLOCK_REALTIME" CACHE INTERNAL + "Clock to use for condition variable timing") +endif () + +set(SOCKET_TIMEOUT 500 CACHE STRING + "Default timeout for responses from IPCPs (ms)") +set(SHM_PREFIX "ouroboros" CACHE STRING + "String to prepend to POSIX shared memory filenames") +set(SHM_RBUFF_PREFIX "/${SHM_PREFIX}.rbuff." CACHE INTERNAL + "Prefix for rbuff POSIX shared memory filenames") +set(SHM_LOCKFILE_NAME "/${SHM_PREFIX}.lockfile" CACHE INTERNAL + "Filename for the POSIX shared memory lockfile") +set(SHM_FLOW_SET_PREFIX "/${SHM_PREFIX}.set." CACHE INTERNAL + "Prefix for the POSIX shared memory flow set") +set(SHM_RDRB_NAME "/${SHM_PREFIX}.rdrb" CACHE INTERNAL + "Name for the main POSIX shared memory buffer") +set(SHM_RDRB_BLOCK_SIZE "sysconf(_SC_PAGESIZE)" CACHE STRING + "Packet buffer block size, multiple of pagesize for performance") +set(SHM_RDRB_MULTI_BLOCK TRUE CACHE BOOL + "Packet buffer multiblock packet support") +set(QOS_DISABLE_CRC TRUE CACHE BOOL + "Ignores ber setting on all QoS cubes") +set(DELTA_T_MPL 60 CACHE STRING + "Maximum packet lifetime (s)") +set(DELTA_T_ACK 10 CACHE STRING + "Maximum time to acknowledge a packet (s)") +set(DELTA_T_RTX 120 CACHE STRING + "Maximum time to retransmit a packet (s)") +set(FRCT_REORDER_QUEUE_SIZE 256 CACHE STRING + "Size of the reordering queue, must be a power of 2") +set(FRCT_START_WINDOW 64 CACHE STRING + "Start window, must be a power of 2") +set(FRCT_LINUX_RTT_ESTIMATOR TRUE CACHE BOOL + "Use Linux RTT estimator formula instead of the TCP RFC formula") +set(FRCT_RTO_MDEV_MULTIPLIER 2 CACHE STRING + "Multiplier for deviation term in the RTO: RTO = sRTT + (mdev << X)") +set(FRCT_RTO_INC_FACTOR 0 CACHE STRING + "Divisor for RTO increase after timeout: RTO += RTX >> X, 0: Karn/Partridge") +set(FRCT_RTO_MIN 250 CACHE STRING + "Minimum Retransmission Timeout (RTO) for FRCT (us)") +set(FRCT_TICK_TIME 5000 CACHE STRING + "Tick time for FRCT activity (retransmission, acknowledgments) (us)") +set(RXM_BUFFER_ON_HEAP FALSE CACHE BOOL + "Store packets for retransmission on the heap instead of in packet buffer") +set(RXM_BLOCKING TRUE CACHE BOOL + "Use blocking writes for retransmission") +set(RXM_MIN_RESOLUTION 20 CACHE STRING + "Minimum retransmission delay (ns), as a power to 2") +set(RXM_WHEEL_MULTIPLIER 4 CACHE STRING + "Factor for retransmission wheel levels as a power to 2") +set(RXM_WHEEL_LEVELS 3 CACHE STRING + "Number of levels in the retransmission wheel") +set(RXM_WHEEL_SLOTS_PER_LEVEL 256 CACHE STRING + "Number of slots per level in the retransmission wheel, must be a power of 2") +set(ACK_WHEEL_SLOTS 256 CACHE STRING + "Number of slots in the acknowledgment wheel, must be a power of 2") +set(ACK_WHEEL_RESOLUTION 18 CACHE STRING + "Minimum acknowledgment delay (ns), as a power to 2") +set(TPM_DEBUG_REPORT_INTERVAL 0 CACHE STRING + "Interval at wich the TPM will report long running threads (s), 0 disables") +set(TPM_DEBUG_ABORT_TIMEOUT 0 CACHE STRING + "TPM abort process after a thread reaches this timeout (s), 0 disables") + +if (HAVE_FUSE) + set(PROC_FLOW_STATS TRUE CACHE BOOL + "Enable flow statistics tracking for application flows") + if (PROC_FLOW_STATS) + message(STATUS "Application flow statistics enabled") + else () + message(STATUS "Application flow statistics disabled") + endif () +endif () diff --git a/cmake/package.cmake b/cmake/package.cmake new file mode 100644 index 00000000..d45222dc --- /dev/null +++ b/cmake/package.cmake @@ -0,0 +1,31 @@ +set(PACKAGE_NAME "${CMAKE_PROJECT_NAME}") +set(PACKAGE_DESCRIPTION "The Ouroboros prototype") +set(PACKAGE_URL "http://ouroboros.rocks") +set(PACKAGE_BUGREPORT "http://ouroboros.rocks/bugzilla/") + +message(STATUS "Package name is: ${PACKAGE_NAME}") +message(STATUS "Package description is: ${PACKAGE_DESCRIPTION}") +message(STATUS "Package version is: ${PACKAGE_VERSION}") +message(STATUS "Package URL is: ${PACKAGE_URL}") +message(STATUS "Package bug-report address: ${PACKAGE_BUGREPORT}") +message(STATUS "Package install prefix: ${CMAKE_INSTALL_PREFIX}") + +# Pkg-config files configuration +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/ouroboros-dev.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/ouroboros-dev.pc" @ONLY) + +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/ouroboros-irm.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/ouroboros-irm.pc" @ONLY) + +# CPack packaging configuration +set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PACKAGE_DESCRIPTION}") +set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README") +set(CPACK_PACKAGE_VERSION_MAJOR "${PACKAGE_VERSION_MAJOR}") +set(CPACK_PACKAGE_VERSION_MINOR "${PACKAGE_VERSION_MINOR}") +set(CPACK_PACKAGE_VERSION_PATCH "${PACKAGE_VERSION_PATCH}") +set(CPACK_PACKAGE_INSTALL_DIRECTORY + "CMake ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}") +set(CPACK_GENERATOR "TGZ") +set(CPACK_SOURCE_GENERATOR "TGZ") + +include(CPack) diff --git a/cmake/tests.cmake b/cmake/tests.cmake new file mode 100644 index 00000000..01dd2ecd --- /dev/null +++ b/cmake/tests.cmake @@ -0,0 +1,26 @@ +include(CTest) # Sets BUILD_TESTING by default to on. + +if (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND BUILD_TESTING) + set(BUILD_TESTS ON) +else () + set(BUILD_TESTS OFF) +endif() + +add_custom_target(build_tests) + +if (BUILD_TESTS) + add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND}) + add_dependencies(check build_tests) + + # Add test subdirectories + add_subdirectory(src/lib/tests) + add_subdirectory(src/irmd/tests) + add_subdirectory(src/ipcpd/unicast/pff/tests) + add_subdirectory(src/ipcpd/unicast/routing/tests) + add_subdirectory(src/ipcpd/unicast/dir/tests) + add_subdirectory(src/irmd/reg/tests) + + # Create coverage target if gcov is available + include(utils/GenCoverage) + create_coverage_target() +endif () diff --git a/cmake/tools.cmake b/cmake/tools.cmake new file mode 100644 index 00000000..de1d374c --- /dev/null +++ b/cmake/tools.cmake @@ -0,0 +1,8 @@ +include(tools/tools) +include(tools/irm) +include(tools/ocbr) +include(tools/oecho) +include(tools/obc) +include(tools/oping) +include(tools/operf) +include(tools/ovpn) diff --git a/cmake/tools/irm.cmake b/cmake/tools/irm.cmake new file mode 100644 index 00000000..c9090a2c --- /dev/null +++ b/cmake/tools/irm.cmake @@ -0,0 +1,33 @@ +set(IRM_SOURCE_DIR "${TOOLS_SOURCE_DIR}/irm") + +set(IRM_SOURCES + "${IRM_SOURCE_DIR}/irm.c" + "${IRM_SOURCE_DIR}/irm_bind_program.c" + "${IRM_SOURCE_DIR}/irm_bind_process.c" + "${IRM_SOURCE_DIR}/irm_bind_ipcp.c" + "${IRM_SOURCE_DIR}/irm_ipcp_create.c" + "${IRM_SOURCE_DIR}/irm_ipcp_destroy.c" + "${IRM_SOURCE_DIR}/irm_ipcp_bootstrap.c" + "${IRM_SOURCE_DIR}/irm_ipcp_enroll.c" + "${IRM_SOURCE_DIR}/irm_ipcp_list.c" + "${IRM_SOURCE_DIR}/irm_ipcp_connect.c" + "${IRM_SOURCE_DIR}/irm_ipcp_disconnect.c" + "${IRM_SOURCE_DIR}/irm_unbind_program.c" + "${IRM_SOURCE_DIR}/irm_unbind_process.c" + "${IRM_SOURCE_DIR}/irm_unbind_ipcp.c" + "${IRM_SOURCE_DIR}/irm_unbind.c" + "${IRM_SOURCE_DIR}/irm_bind.c" + "${IRM_SOURCE_DIR}/irm_ipcp.c" + "${IRM_SOURCE_DIR}/irm_name.c" + "${IRM_SOURCE_DIR}/irm_name_create.c" + "${IRM_SOURCE_DIR}/irm_name_destroy.c" + "${IRM_SOURCE_DIR}/irm_name_reg.c" + "${IRM_SOURCE_DIR}/irm_name_unreg.c" + "${IRM_SOURCE_DIR}/irm_name_list.c" + "${IRM_SOURCE_DIR}/irm_utils.c" +) + +add_executable(irm ${IRM_SOURCES}) +target_include_directories(irm PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(irm PUBLIC ouroboros-irm) +install(TARGETS irm RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR}) diff --git a/cmake/tools/obc.cmake b/cmake/tools/obc.cmake new file mode 100644 index 00000000..99e001b6 --- /dev/null +++ b/cmake/tools/obc.cmake @@ -0,0 +1,4 @@ +add_executable(obc "${TOOLS_SOURCE_DIR}/obc/obc.c") +target_include_directories(obc PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(obc PUBLIC ouroboros-dev) +install(TARGETS obc RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/cmake/tools/ocbr.cmake b/cmake/tools/ocbr.cmake new file mode 100644 index 00000000..bab80da8 --- /dev/null +++ b/cmake/tools/ocbr.cmake @@ -0,0 +1,4 @@ +add_executable(ocbr "${TOOLS_SOURCE_DIR}/ocbr/ocbr.c") +target_include_directories(ocbr PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(ocbr PUBLIC ouroboros-dev) +install(TARGETS ocbr RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/cmake/tools/oecho.cmake b/cmake/tools/oecho.cmake new file mode 100644 index 00000000..73522731 --- /dev/null +++ b/cmake/tools/oecho.cmake @@ -0,0 +1,4 @@ +add_executable(oecho "${TOOLS_SOURCE_DIR}/oecho/oecho.c") +target_include_directories(oecho PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(oecho PUBLIC ouroboros-dev) +install(TARGETS oecho RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/cmake/tools/operf.cmake b/cmake/tools/operf.cmake new file mode 100644 index 00000000..f6b2b465 --- /dev/null +++ b/cmake/tools/operf.cmake @@ -0,0 +1,4 @@ +add_executable(operf "${TOOLS_SOURCE_DIR}/operf/operf.c") +target_include_directories(operf PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(operf PUBLIC ouroboros-dev) +install(TARGETS operf RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/cmake/tools/oping.cmake b/cmake/tools/oping.cmake new file mode 100644 index 00000000..6bb18132 --- /dev/null +++ b/cmake/tools/oping.cmake @@ -0,0 +1,4 @@ +add_executable(oping "${TOOLS_SOURCE_DIR}/oping/oping.c") +target_include_directories(oping PRIVATE ${TOOLS_INCLUDE_DIRS}) +target_link_libraries(oping PUBLIC ${LIBM_LIBRARIES} ouroboros-dev) +install(TARGETS oping RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/cmake/tools/ovpn.cmake b/cmake/tools/ovpn.cmake new file mode 100644 index 00000000..331daff9 --- /dev/null +++ b/cmake/tools/ovpn.cmake @@ -0,0 +1,6 @@ +if (CMAKE_SYSTEM_NAME STREQUAL "Linux") + add_executable(ovpn "${TOOLS_SOURCE_DIR}/ovpn/ovpn.c") + target_include_directories(ovpn PRIVATE ${TOOLS_INCLUDE_DIRS}) + target_link_libraries(ovpn PUBLIC ouroboros-dev) + install(TARGETS ovpn RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) +endif () diff --git a/cmake/tools/tools.cmake b/cmake/tools/tools.cmake new file mode 100644 index 00000000..26abdc63 --- /dev/null +++ b/cmake/tools/tools.cmake @@ -0,0 +1,8 @@ +set(TOOLS_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/tools") +set(TOOLS_BINARY_DIR "${CMAKE_BINARY_DIR}/src/tools") + +set(TOOLS_INCLUDE_DIRS + ${TOOLS_SOURCE_DIR} + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_BINARY_DIR}/include +) diff --git a/cmake/AddCompileFlags.cmake b/cmake/utils/AddCompileFlags.cmake index 8f3877d9..8f3877d9 100644 --- a/cmake/AddCompileFlags.cmake +++ b/cmake/utils/AddCompileFlags.cmake diff --git a/cmake/CmakeUninstall.cmake.in b/cmake/utils/CMakeUninstall.cmake.in index 4c07dc7b..985b31b2 100644 --- a/cmake/CmakeUninstall.cmake.in +++ b/cmake/utils/CMakeUninstall.cmake.in @@ -7,14 +7,22 @@ string(REGEX REPLACE "\n" ";" files "${files}") foreach(file ${files}) message(STATUS "Uninstalling $ENV{DESTDIR}${file}") if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") - exec_program( - "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" - OUTPUT_VARIABLE rm_out - RETURN_VALUE rm_retval - ) - if(NOT "${rm_retval}" STREQUAL 0) + if(CMAKE_VERSION VERSION_LESS "3.28.0") + exec_program( + "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + else() + execute_process( + COMMAND @CMAKE_COMMAND@ -E remove "$ENV{DESTDIR}${file}" + RESULT_VARIABLE rm_out + ERROR_VARIABLE rm_retval + ) + endif () + if(NOT "${rm_retval}" STREQUAL "" AND NOT "${rm_retval}" STREQUAL 0) message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}") - endif(NOT "${rm_retval}" STREQUAL 0) + endif(NOT "${rm_retval}" STREQUAL "" AND NOT "${rm_retval}" STREQUAL 0) else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") message(STATUS "File $ENV{DESTDIR}${file} does not exist.") endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") diff --git a/cmake/CompilerUtils.cmake b/cmake/utils/CompilerUtils.cmake index 7c8b022f..7c8b022f 100644 --- a/cmake/CompilerUtils.cmake +++ b/cmake/utils/CompilerUtils.cmake diff --git a/cmake/FindProtobufC.cmake b/cmake/utils/FindProtobufC.cmake index ff532a46..ff892b5b 100644 --- a/cmake/FindProtobufC.cmake +++ b/cmake/utils/FindProtobufC.cmake @@ -62,7 +62,7 @@ mark_as_advanced(PROTOBUF_C_INCLUDE_DIR) # Find the protoc-c Executable find_program(PROTOBUF_PROTOC_C_EXECUTABLE - NAMES protoc-c + NAMES protoc protoc-c DOC "The Google Protocol Buffers C Compiler" ) mark_as_advanced(PROTOBUF_PROTOC_C_EXECUTABLE) diff --git a/cmake/utils/GenCoverage.cmake b/cmake/utils/GenCoverage.cmake new file mode 100644 index 00000000..65f5d8ba --- /dev/null +++ b/cmake/utils/GenCoverage.cmake @@ -0,0 +1,94 @@ +# Creates the coverage target for test coverage analysis +# Requires HAVE_GCOV to be set (from dependencies/gcov.cmake) +# Uses HAVE_LCOV for optional HTML generation (from dependencies/lcov.cmake) + +# Filter patterns for lcov --remove +set(LCOV_FILTERS '*_test.c' '*.h') + +# Ignore inconsistent coverage: legitimate gaps in error paths and +# edge cases that are difficult to exercise in unit tests. +function(get_html_coverage_commands OUTPUT_VAR) + if(HAVE_LCOV) + set(COMMANDS + COMMAND ${LCOV_PATH} + --capture --directory . + --output-file coverage.info + > /dev/null 2>&1 + COMMAND ${LCOV_PATH} + --remove coverage.info ${LCOV_FILTERS} + --output-file coverage_filtered.info + --ignore-errors inconsistent + > /dev/null 2>&1 + COMMAND ${GENHTML_PATH} + coverage_filtered.info + --output-directory coverage_html + > /dev/null 2>&1 + COMMAND ${CMAKE_COMMAND} -E echo "" + COMMAND ${CMAKE_COMMAND} -E echo "HTML report: ${CMAKE_BINARY_DIR}/coverage_html/index.html" + COMMAND ${CMAKE_COMMAND} -E echo "" + ) + set(${OUTPUT_VAR} "${COMMANDS}" PARENT_SCOPE) + else() + set(${OUTPUT_VAR} "" PARENT_SCOPE) + endif() +endfunction() + +function(create_informational_target) + # MESSAGE lines are passed as ARGV, last arg is COMMENT + list(LENGTH ARGV NUM_ARGS) + math(EXPR COMMENT_IDX "${NUM_ARGS} - 1") + list(GET ARGV ${COMMENT_IDX} COMMENT_TEXT) + + # Build command list + set(COMMANDS + COMMAND ${CMAKE_COMMAND} -E echo "" + ) + foreach(i RANGE 0 ${COMMENT_IDX}) + if(NOT i EQUAL ${COMMENT_IDX}) + list(GET ARGV ${i} LINE) + list(APPEND COMMANDS COMMAND ${CMAKE_COMMAND} -E echo "${LINE}") + endif() + endforeach() + list(APPEND COMMANDS COMMAND ${CMAKE_COMMAND} -E echo "") + + add_custom_target(coverage + ${COMMANDS} + COMMENT "${COMMENT_TEXT}" + ) +endfunction() + +macro(create_coverage_target) + if(HAVE_GCOV AND ENABLE_COVERAGE) + get_html_coverage_commands(HTML_COVERAGE_COMMANDS) + + add_custom_target(coverage + COMMAND ${CMAKE_CTEST_COMMAND} -D ExperimentalStart > /dev/null 2>&1 + COMMAND ${CMAKE_CTEST_COMMAND} -D ExperimentalConfigure > /dev/null 2>&1 + COMMAND ${CMAKE_CTEST_COMMAND} -D ExperimentalBuild > /dev/null 2>&1 + COMMAND ${CMAKE_CTEST_COMMAND} -D ExperimentalTest > /dev/null 2>&1 + COMMAND ${CMAKE_CTEST_COMMAND} -D ExperimentalCoverage > /dev/null 2>&1 + COMMAND ${CMAKE_COMMAND} + -DPROJECT_SOURCE_DIR=${CMAKE_SOURCE_DIR} + -DPROJECT_BINARY_DIR=${CMAKE_BINARY_DIR} + -P ${CMAKE_SOURCE_DIR}/cmake/utils/PrintCoverage.cmake + ${HTML_COVERAGE_COMMANDS} + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + DEPENDS build_tests + COMMENT "Running tests with coverage analysis using CTest" + ) + elseif(HAVE_GCOV) + create_informational_target( + "Coverage is currently disabled" + "To enable coverage analysis, reconfigure with" + " cmake -DDISABLE_COVERAGE=OFF .." + "Coverage disabled" + ) + message(STATUS "Coverage disabled. Use 'make coverage' for instructions to enable.") + else() + create_informational_target( + "Coverage analysis is not available" + "Install gcov to enable coverage support" + "Coverage not available" + ) + endif() +endmacro() diff --git a/cmake/utils/ParseCoverage.cmake b/cmake/utils/ParseCoverage.cmake new file mode 100644 index 00000000..0bbed0de --- /dev/null +++ b/cmake/utils/ParseCoverage.cmake @@ -0,0 +1,120 @@ +# Parse CTest Coverage.xml file and extract structured coverage data. +# +# Sets in PARENT_SCOPE: +# LOC_TESTED, LOC_UNTESTED - Overall metrics +# FILE_COVERAGE_LIST - "path|name|tested|untested|total|percent" entries +# COVERED_FILES - Absolute paths of covered files + +# Regex building blocks +set(R_NUMBER "[0-9]+") +set(R_NON_TAG "[^<]*") +set(R_NON_BRACKET "[^>]*") +set(R_NON_QUOTE "[^\"]+") + +# XML element patterns +set(R_LOC_TESTED_ELEM "<LOCTested>(${R_NUMBER})</LOCTested>") +set(R_LOC_TESTED_SKIP "<LOCTested>${R_NUMBER}</LOCTested>") +set(R_LOC_UNTESTED_ELEM "<LOCUntested>(${R_NUMBER})</LOCUntested>") +set(R_LOC_UNTESTED_CAP "<LOCUnTested>(${R_NUMBER})</LOCUnTested>") + +# Regex patterns for XML parsing +set(REGEX_LOC_TESTED "</File>${R_NON_TAG}${R_LOC_TESTED_ELEM}") +set(REGEX_LOC_UNTESTED "</File>${R_NON_TAG}${R_LOC_TESTED_SKIP}${R_NON_TAG}${R_LOC_UNTESTED_ELEM}") +set(REGEX_FILE_ENTRY "<File${R_NON_BRACKET}Name=\"(${R_NON_QUOTE})\"${R_NON_BRACKET}>${R_NON_TAG}${R_LOC_TESTED_ELEM}${R_NON_TAG}${R_LOC_UNTESTED_CAP}") + +# Regex patterns for filtering +set(REGEX_TEST_FILE "test") +set(REGEX_TEST_DIR "/tests/") +set(REGEX_PROTOBUF_C "\\.pb-c\\.c$") +set(REGEX_PROTOBUF_ALT "\\.pb\\.c$") +set(REGEX_DOTSLASH_SRC "^\\.\\/src\\/") + +function(should_skip_file FILE_PATH OUTPUT_VAR) + if(FILE_PATH MATCHES "${REGEX_TEST_FILE}" OR FILE_PATH MATCHES "${REGEX_TEST_DIR}" OR + FILE_PATH MATCHES "${REGEX_PROTOBUF_C}" OR FILE_PATH MATCHES "${REGEX_PROTOBUF_ALT}") + set(${OUTPUT_VAR} TRUE PARENT_SCOPE) + else() + set(${OUTPUT_VAR} FALSE PARENT_SCOPE) + endif() +endfunction() + +function(normalize_coverage_path FILE_PATH PROJECT_SOURCE_DIR OUTPUT_VAR) + if(NOT IS_ABSOLUTE "${FILE_PATH}") + string(REGEX REPLACE "${REGEX_DOTSLASH_SRC}" "src/" FILE_PATH "${FILE_PATH}") + get_filename_component(FILE_PATH "${PROJECT_SOURCE_DIR}/${FILE_PATH}" ABSOLUTE) + endif() + set(${OUTPUT_VAR} "${FILE_PATH}" PARENT_SCOPE) +endfunction() + +function(extract_xml_attribute XML_STRING ATTRIBUTE OUTPUT_VAR) + string(REGEX MATCH "${ATTRIBUTE}=\"([^\"]+)\"" _ "${XML_STRING}") + set(${OUTPUT_VAR} "${CMAKE_MATCH_1}" PARENT_SCOPE) +endfunction() + +function(extract_xml_element XML_STRING ELEMENT OUTPUT_VAR) + string(REGEX MATCH "<${ELEMENT}>([^<]+)</${ELEMENT}>" _ "${XML_STRING}") + set(${OUTPUT_VAR} "${CMAKE_MATCH_1}" PARENT_SCOPE) +endfunction() + +function(build_coverage_entry PATH NAME TESTED UNTESTED OUTPUT_VAR) + math(EXPR TOTAL "${TESTED} + ${UNTESTED}") + if(NOT TOTAL GREATER 0) + set(${OUTPUT_VAR} "" PARENT_SCOPE) + return() + endif() + math(EXPR PERCENT "(${TESTED} * 100) / ${TOTAL}") + set(${OUTPUT_VAR} "${PATH}|${NAME}|${TESTED}|${UNTESTED}|${TOTAL}|${PERCENT}" PARENT_SCOPE) +endfunction() + +function(parse_coverage_xml COVERAGE_FILE PROJECT_SOURCE_DIR) + if(NOT EXISTS "${COVERAGE_FILE}") + return() + endif() + + file(READ "${COVERAGE_FILE}" COVERAGE_XML) + + string(REGEX MATCH "${REGEX_LOC_TESTED}" _ "${COVERAGE_XML}") + set(TESTED "${CMAKE_MATCH_1}") + + string(REGEX MATCH "${REGEX_LOC_UNTESTED}" _ "${COVERAGE_XML}") + set(UNTESTED "${CMAKE_MATCH_1}") + + if(NOT TESTED OR NOT UNTESTED) + return() + endif() + + string(REGEX MATCHALL "${REGEX_FILE_ENTRY}" FILE_MATCHES "${COVERAGE_XML}") + + set(COVERED_LIST "") + set(COVERAGE_DATA "") + + foreach(MATCH ${FILE_MATCHES}) + extract_xml_attribute("${MATCH}" "FullPath" PATH) + extract_xml_attribute("${MATCH}" "Name" NAME) + + should_skip_file("${PATH}" SKIP) + if(SKIP) + continue() + endif() + + normalize_coverage_path("${PATH}" "${PROJECT_SOURCE_DIR}" ABS_PATH) + list(APPEND COVERED_LIST "${ABS_PATH}") + + extract_xml_element("${MATCH}" "LOCTested" TESTED_LINES) + extract_xml_element("${MATCH}" "LOCUnTested" UNTESTED_LINES) + + if(NOT TESTED_LINES OR NOT UNTESTED_LINES) + continue() + endif() + + build_coverage_entry("${PATH}" "${NAME}" "${TESTED_LINES}" "${UNTESTED_LINES}" ENTRY) + if(ENTRY) + list(APPEND COVERAGE_DATA "${ENTRY}") + endif() + endforeach() + + set(LOC_TESTED "${TESTED}" PARENT_SCOPE) + set(LOC_UNTESTED "${UNTESTED}" PARENT_SCOPE) + set(FILE_COVERAGE_LIST "${COVERAGE_DATA}" PARENT_SCOPE) + set(COVERED_FILES "${COVERED_LIST}" PARENT_SCOPE) +endfunction() diff --git a/cmake/utils/PrintCoverage.cmake b/cmake/utils/PrintCoverage.cmake new file mode 100644 index 00000000..4b75fa09 --- /dev/null +++ b/cmake/utils/PrintCoverage.cmake @@ -0,0 +1,333 @@ +# Script to parse and display coverage results from CTest +# +# This script is invoked by the 'make coverage' target and parses the CTest +# Coverage.xml file to generate a formatted coverage report grouped by component. +# +# This script is run with cmake -P, so CMAKE_SOURCE_DIR won't be set correctly. +# Use PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR passed as -D arguments. + +if(NOT DEFINED PROJECT_SOURCE_DIR) + message(FATAL_ERROR "PROJECT_SOURCE_DIR must be defined") +endif() +if(NOT DEFINED PROJECT_BINARY_DIR) + message(FATAL_ERROR "PROJECT_BINARY_DIR must be defined") +endif() + +# Include coverage parsing functions +include(${CMAKE_CURRENT_LIST_DIR}/ParseCoverage.cmake) + +# Create padding strings (CMake 2.8 compatible) +function(make_padding LENGTH OUTPUT_VAR) + set(RESULT "") + if(LENGTH GREATER 0) + foreach(i RANGE 1 ${LENGTH}) + set(RESULT "${RESULT} ") + endforeach() + endif() + set(${OUTPUT_VAR} "${RESULT}" PARENT_SCOPE) +endfunction() + +# Format a number with padding for right alignment +function(format_number VALUE WIDTH OUTPUT_VAR) + string(LENGTH "${VALUE}" VALUE_LEN) + math(EXPR PAD_LEN "${WIDTH} - ${VALUE_LEN}") + make_padding(${PAD_LEN} PADDING) + set(${OUTPUT_VAR} "${PADDING}${VALUE}" PARENT_SCOPE) +endfunction() + +# Format a complete coverage row with consistent alignment +function(format_coverage_row LABEL TESTED TESTED_FC UNTESTED UNTESTED_FC TOTAL PERCENT OUTPUT_VAR) + string(LENGTH "${LABEL}" LABEL_LEN) + math(EXPR LABEL_PAD "28 - ${LABEL_LEN}") + make_padding(${LABEL_PAD} LP) + + format_number(${TESTED} 6 TS) + format_number(${TESTED_FC} 3 TFC) + format_number(${UNTESTED} 8 US) + format_number(${UNTESTED_FC} 3 UFC) + format_number(${TOTAL} 5 TT) + format_number(${PERCENT} 3 PC) + set(${OUTPUT_VAR} " ${LABEL}${LP}${TS}[${TFC}] ${US}[${UFC}] ${TT} ${PC}%" PARENT_SCOPE) +endfunction() + +# Format the header row to align with data columns +function(format_coverage_header OUTPUT_VAR) + set(HEADER " Component Tested Untested Total %") + set(${OUTPUT_VAR} "${HEADER}" PARENT_SCOPE) +endfunction() + +# Calculate metrics from entry list (pipe-delimited: path|name|tested|untested|total|percent) +function(calculate_metrics ENTRIES OUT_TESTED OUT_UNTESTED OUT_TESTED_FC OUT_UNTESTED_FC) + set(TESTED 0) + set(UNTESTED 0) + set(TESTED_FC 0) + set(UNTESTED_FC 0) + + foreach(ENTRY ${ENTRIES}) + string(REPLACE "|" ";" PARTS "${ENTRY}") + list(GET PARTS 2 ENTRY_TESTED) + list(GET PARTS 3 ENTRY_UNTESTED) + + math(EXPR TESTED "${TESTED} + ${ENTRY_TESTED}") + math(EXPR UNTESTED "${UNTESTED} + ${ENTRY_UNTESTED}") + + if(ENTRY_TESTED EQUAL 0) + math(EXPR UNTESTED_FC "${UNTESTED_FC} + 1") + else() + math(EXPR TESTED_FC "${TESTED_FC} + 1") + endif() + endforeach() + + set(${OUT_TESTED} "${TESTED}" PARENT_SCOPE) + set(${OUT_UNTESTED} "${UNTESTED}" PARENT_SCOPE) + set(${OUT_TESTED_FC} "${TESTED_FC}" PARENT_SCOPE) + set(${OUT_UNTESTED_FC} "${UNTESTED_FC}" PARENT_SCOPE) +endfunction() + +# Discover components and sub-components from source tree +function(discover_components PROJECT_SOURCE_DIR OUT_COMPONENTS OUT_COMP_SUBCOMPS) + file(GLOB COMPONENT_DIRS "${PROJECT_SOURCE_DIR}/src/*") + set(COMPONENTS "") + set(SKIP_DIRS "include;doc;tests") + + foreach(DIR ${COMPONENT_DIRS}) + if(IS_DIRECTORY ${DIR}) + get_filename_component(COMP_NAME ${DIR} NAME) + list(FIND SKIP_DIRS ${COMP_NAME} SKIP_IDX) + if(SKIP_IDX EQUAL -1) + list(APPEND COMPONENTS ${COMP_NAME}) + + file(GLOB SUBCOMP_DIRS "${DIR}/*") + set(COMP_${COMP_NAME}_SUBCOMPS "") + foreach(SUBDIR ${SUBCOMP_DIRS}) + if(IS_DIRECTORY ${SUBDIR}) + get_filename_component(SUBCOMP_NAME ${SUBDIR} NAME) + list(FIND SKIP_DIRS ${SUBCOMP_NAME} SKIP_IDX2) + if(SKIP_IDX2 EQUAL -1) + list(APPEND COMP_${COMP_NAME}_SUBCOMPS ${SUBCOMP_NAME}) + set(COMP_${COMP_NAME}_${SUBCOMP_NAME} "") + endif() + endif() + endforeach() + endif() + endif() + endforeach() + + set(${OUT_COMPONENTS} "${COMPONENTS}" PARENT_SCOPE) + foreach(COMP ${COMPONENTS}) + set(COMP_${COMP}_SUBCOMPS "${COMP_${COMP}_SUBCOMPS}" PARENT_SCOPE) + endforeach() +endfunction() + +# Print a coverage line +function(print_coverage_line LABEL TESTED TESTED_FC UNTESTED UNTESTED_FC TOTAL PERCENT) + format_coverage_row("${LABEL}" ${TESTED} ${TESTED_FC} ${UNTESTED} ${UNTESTED_FC} ${TOTAL} ${PERCENT} ROW) + execute_process(COMMAND ${CMAKE_COMMAND} -E echo "${ROW}") +endfunction() + +# Locate the coverage file +if(NOT EXISTS "${CMAKE_BINARY_DIR}/Testing/TAG") + message(WARNING "Testing/TAG file not found. Coverage may not have run successfully.") + return() +endif() + +file(STRINGS "${CMAKE_BINARY_DIR}/Testing/TAG" TAG_CONTENTS LIMIT_COUNT 1) +string(STRIP "${TAG_CONTENTS}" TEST_DIR) +set(COVERAGE_FILE "${CMAKE_BINARY_DIR}/Testing/${TEST_DIR}/Coverage.xml") + +if(NOT EXISTS "${COVERAGE_FILE}") + message(WARNING "Coverage file not found: ${COVERAGE_FILE}") + execute_process(COMMAND ${CMAKE_COMMAND} -E echo "Note: Coverage results should be in Testing/${TEST_DIR}/") + return() +endif() + +# Parse the coverage XML file +parse_coverage_xml("${COVERAGE_FILE}" "${PROJECT_SOURCE_DIR}") + +if(NOT LOC_TESTED OR NOT LOC_UNTESTED) + message(WARNING "Could not parse coverage metrics") + return() +endif() + +math(EXPR TOTAL_LOC "${LOC_TESTED} + ${LOC_UNTESTED}") +if(NOT TOTAL_LOC GREATER 0) + message(WARNING "No coverage data found") + return() +endif() + +math(EXPR COVERAGE_PERCENT "(${LOC_TESTED} * 100) / ${TOTAL_LOC}") + +# Discover and group files by component +if(NOT FILE_COVERAGE_LIST) + execute_process(COMMAND ${CMAKE_COMMAND} -E echo "No coverage data for source files (excluding tests)") + return() +endif() + +# Discover components from source tree (only src/ directory) +discover_components("${PROJECT_SOURCE_DIR}" COMPONENTS COMP_SUBCOMPS) + +# Find all source files and identify completely untested ones +file(GLOB_RECURSE ALL_SOURCE_FILES "${PROJECT_SOURCE_DIR}/src/*.c") +set(UNCOVERED_FILES "") +foreach(SRC_FILE ${ALL_SOURCE_FILES}) + if(SRC_FILE MATCHES "test" OR SRC_FILE MATCHES "/tests/") + continue() + endif() + + list(FIND COVERED_FILES "${SRC_FILE}" FILE_IDX) + if(FILE_IDX EQUAL -1) + file(STRINGS "${SRC_FILE}" FILE_LINES) + list(LENGTH FILE_LINES LINE_COUNT) + if(LINE_COUNT GREATER 0) + get_filename_component(FILE_NAME "${SRC_FILE}" NAME) + list(APPEND UNCOVERED_FILES "${SRC_FILE}|${FILE_NAME}|0|${LINE_COUNT}|${LINE_COUNT}|0") + endif() + endif() +endforeach() + +# Combine covered and uncovered files +set(ALL_FILES ${FILE_COVERAGE_LIST}) +if(UNCOVERED_FILES) + list(APPEND ALL_FILES ${UNCOVERED_FILES}) +endif() + +# Group files into components and sub-components +foreach(ENTRY ${ALL_FILES}) + string(REPLACE "|" ";" ENTRY_PARTS "${ENTRY}") + list(GET ENTRY_PARTS 0 F_PATH) + + # Normalize path and extract relative path from src/ + # Remove leading ./ if present, then ensure path starts with src/ + string(REGEX REPLACE "^\\./" "" REL_PATH "${F_PATH}") + string(REGEX REPLACE "^.*/src/" "src/" REL_PATH "${REL_PATH}") + + # Tokenize on /: ["src", "component", "subcomponent", "file.c"] + string(REPLACE "/" ";" PATH_TOKENS "${REL_PATH}") + list(LENGTH PATH_TOKENS TOKEN_COUNT) + + if(TOKEN_COUNT EQUAL 3) + # src/component/file.c - add to component main + list(GET PATH_TOKENS 1 FILE_COMP) + list(FIND COMPONENTS ${FILE_COMP} COMP_IDX) + if(COMP_IDX GREATER -1) + list(APPEND COMP_${FILE_COMP} "${ENTRY}") + list(APPEND COMP_${FILE_COMP}_main "${ENTRY}") + endif() + elseif(TOKEN_COUNT GREATER 3) + # src/component/subdir/.../file.c - check if subdir is a known subcomponent + list(GET PATH_TOKENS 1 FILE_COMP) + list(GET PATH_TOKENS 2 FILE_SUBCOMP) + + list(FIND COMPONENTS ${FILE_COMP} COMP_IDX) + if(COMP_IDX GREATER -1) + list(APPEND COMP_${FILE_COMP} "${ENTRY}") + + # Check if subdir is a recognized subcomponent + list(FIND COMP_${FILE_COMP}_SUBCOMPS ${FILE_SUBCOMP} SUBCOMP_IDX) + if(SUBCOMP_IDX GREATER -1) + list(APPEND COMP_${FILE_COMP}_${FILE_SUBCOMP} "${ENTRY}") + else() + # Subdir not recognized, treat as main + list(APPEND COMP_${FILE_COMP}_main "${ENTRY}") + endif() + endif() + endif() +endforeach() + +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "") +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "=============================================================================") +format_coverage_header(HEADER) +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "${HEADER}") +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "=============================================================================") + +# Process and display each component +foreach(COMP_NAME ${COMPONENTS}) + set(COMP_LIST ${COMP_${COMP_NAME}}) + + if(NOT COMP_LIST) + continue() + endif() + + calculate_metrics("${COMP_LIST}" COMP_TESTED COMP_UNTESTED COMP_TESTED_FILE_COUNT COMP_UNTESTED_FILE_COUNT) + math(EXPR COMP_TOTAL "${COMP_TESTED} + ${COMP_UNTESTED}") + if(COMP_TOTAL GREATER 0) + math(EXPR COMP_PERCENT "(${COMP_TESTED} * 100) / ${COMP_TOTAL}") + else() + set(COMP_PERCENT 0) + endif() + + print_coverage_line("${COMP_NAME}" ${COMP_TESTED} ${COMP_TESTED_FILE_COUNT} ${COMP_UNTESTED} ${COMP_UNTESTED_FILE_COUNT} ${COMP_TOTAL} ${COMP_PERCENT}) + + # Display "main" sub-component first if it has files + set(MAIN_LIST ${COMP_${COMP_NAME}_main}) + if(MAIN_LIST) + calculate_metrics("${MAIN_LIST}" MAIN_TESTED MAIN_UNTESTED MAIN_TESTED_FILE_COUNT MAIN_UNTESTED_FILE_COUNT) + math(EXPR MAIN_TOTAL "${MAIN_TESTED} + ${MAIN_UNTESTED}") + if(MAIN_TOTAL GREATER 0) + math(EXPR MAIN_PERCENT "(${MAIN_TESTED} * 100) / ${MAIN_TOTAL}") + else() + set(MAIN_PERCENT 0) + endif() + + print_coverage_line(" ." ${MAIN_TESTED} ${MAIN_TESTED_FILE_COUNT} ${MAIN_UNTESTED} ${MAIN_UNTESTED_FILE_COUNT} ${MAIN_TOTAL} ${MAIN_PERCENT}) + endif() + + # Display sub-components + foreach(SUBCOMP ${COMP_${COMP_NAME}_SUBCOMPS}) + set(SUBCOMP_LIST ${COMP_${COMP_NAME}_${SUBCOMP}}) + if(NOT SUBCOMP_LIST) + continue() + endif() + + calculate_metrics("${SUBCOMP_LIST}" SUBCOMP_TESTED SUBCOMP_UNTESTED SUBCOMP_TESTED_FILE_COUNT SUBCOMP_UNTESTED_FILE_COUNT) + math(EXPR SUBCOMP_TOTAL "${SUBCOMP_TESTED} + ${SUBCOMP_UNTESTED}") + if(SUBCOMP_TOTAL GREATER 0) + math(EXPR SUBCOMP_PERCENT "(${SUBCOMP_TESTED} * 100) / ${SUBCOMP_TOTAL}") + else() + set(SUBCOMP_PERCENT 0) + endif() + + print_coverage_line(" ${SUBCOMP}" ${SUBCOMP_TESTED} ${SUBCOMP_TESTED_FILE_COUNT} ${SUBCOMP_UNTESTED} ${SUBCOMP_UNTESTED_FILE_COUNT} ${SUBCOMP_TOTAL} ${SUBCOMP_PERCENT}) + endforeach() + + execute_process(COMMAND ${CMAKE_COMMAND} -E echo "") +endforeach() + +# Calculate overall coverage +set(TOTAL_TESTED ${LOC_TESTED}) +set(TOTAL_UNTESTED ${LOC_UNTESTED}) + +# Count file coverage for totals +set(TOTAL_TESTED_FILE_COUNT 0) +set(TOTAL_UNTESTED_FILE_COUNT 0) + +foreach(ENTRY ${FILE_COVERAGE_LIST}) + string(REPLACE "|" ";" PARTS "${ENTRY}") + list(GET PARTS 2 ENTRY_TESTED) + if(ENTRY_TESTED EQUAL 0) + math(EXPR TOTAL_UNTESTED_FILE_COUNT "${TOTAL_UNTESTED_FILE_COUNT} + 1") + else() + math(EXPR TOTAL_TESTED_FILE_COUNT "${TOTAL_TESTED_FILE_COUNT} + 1") + endif() +endforeach() + +# Add untested file counts +foreach(ENTRY ${UNCOVERED_FILES}) + string(REPLACE "|" ";" PARTS "${ENTRY}") + list(GET PARTS 3 ENTRY_UNTESTED) + math(EXPR TOTAL_UNTESTED "${TOTAL_UNTESTED} + ${ENTRY_UNTESTED}") + math(EXPR TOTAL_UNTESTED_FILE_COUNT "${TOTAL_UNTESTED_FILE_COUNT} + 1") +endforeach() + +math(EXPR TOTAL_ALL_LOC "${TOTAL_TESTED} + ${TOTAL_UNTESTED}") +if(TOTAL_ALL_LOC GREATER 0) + math(EXPR OVERALL_COVERAGE_PERCENT "(${TOTAL_TESTED} * 100) / ${TOTAL_ALL_LOC}") +else() + set(OVERALL_COVERAGE_PERCENT 0) +endif() + +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "=============================================================================") +print_coverage_line("Total" ${TOTAL_TESTED} ${TOTAL_TESTED_FILE_COUNT} ${TOTAL_UNTESTED} ${TOTAL_UNTESTED_FILE_COUNT} ${TOTAL_ALL_LOC} ${OVERALL_COVERAGE_PERCENT}) +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "=============================================================================") +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "") +execute_process(COMMAND ${CMAKE_COMMAND} -E echo "Detailed XML report: ${COVERAGE_FILE}") diff --git a/cmake/version.cmake b/cmake/version.cmake new file mode 100644 index 00000000..00183d34 --- /dev/null +++ b/cmake/version.cmake @@ -0,0 +1,5 @@ +set(PACKAGE_VERSION_MAJOR 0) +set(PACKAGE_VERSION_MINOR 22) +set(PACKAGE_VERSION_PATCH 0) +set(PACKAGE_VERSION + "${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}.${PACKAGE_VERSION_PATCH}") |