tests: make code coverage for unit tests optional
[vpp.git] / src / CMakeLists.txt
index 59c7512..a1764f7 100644 (file)
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.10)
 
-set(CMAKE_C_COMPILER_NAMES clang-10 clang-9 gcc-9 cc)
+set(CMAKE_C_COMPILER_NAMES
+  clang-13
+  clang-12
+  clang-11
+  clang-10
+  clang-9
+  gcc-10
+  gcc-9
+  cc
+)
 
 project(vpp C)
 
+if(CMAKE_VERSION VERSION_LESS 3.12)
+  macro(add_compile_definitions defs)
+    foreach(d ${defs})
+      add_compile_options(-D${d})
+    endforeach()
+  endmacro()
+endif()
+
+if(NOT DEFINED CMAKE_INSTALL_LIBDIR AND EXISTS "/etc/debian_version")
+  set(CMAKE_INSTALL_LIBDIR "lib/${CMAKE_LIBRARY_ARCHITECTURE}")
+endif()
+
 include(CheckCCompilerFlag)
+include(CheckIPOSupported)
+include(GNUInstallDirs)
 include(cmake/misc.cmake)
 include(cmake/cpu.cmake)
 include(cmake/ccache.cmake)
@@ -50,82 +73,109 @@ set(CMAKE_C_COMPILER_TARGET ${CMAKE_SYSTEM_PROCESSOR}-linux-gnu)
 ##############################################################################
 check_c_compiler_flag("-Wno-address-of-packed-member"
                      compiler_flag_no_address_of_packed_member)
-set(VPP_RUNTIME_DIR "bin" CACHE STRING "Relative runtime directory path")
-set(VPP_LIBRARY_DIR "lib" CACHE STRING "Relative library directory path")
+set(VPP_RUNTIME_DIR ${CMAKE_INSTALL_BINDIR} CACHE STRING "Relative runtime directory path")
+set(VPP_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR} CACHE STRING "Relative library directory path")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${VPP_RUNTIME_DIR})
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${VPP_LIBRARY_DIR})
+set(VPP_BINARY_DIR ${CMAKE_BINARY_DIR}/CMakeFiles)
+set(PYENV PYTHONPYCACHEPREFIX=${CMAKE_BINARY_DIR}/CMakeFile/__pycache__)
 
 if (CMAKE_BUILD_TYPE)
-  set(CMAKE_C_FLAGS "-g -fPIC -Werror -Wall ${CMAKE_C_FLAGS}")
+  add_compile_options(-g -fPIC -Werror -Wall)
 endif()
 
 if (compiler_flag_no_address_of_packed_member)
-  set(CMAKE_C_FLAGS "-Wno-address-of-packed-member ${CMAKE_C_FLAGS}")
+  add_compile_options(-Wno-address-of-packed-member)
 endif()
 
-# release
-list(APPEND BUILD_TYPES "release")
-string(CONCAT CMAKE_C_FLAGS_RELEASE
-  "-O2 "
-  "-fstack-protector "
-  "-DFORTIFY_SOURCE=2 "
-  "-fno-common "
-)
-
-string(CONCAT CMAKE_EXE_LINKER_FLAGS_RELEASE "-pie")
-
-# debug
-list(APPEND BUILD_TYPES "debug")
-string(CONCAT CMAKE_C_FLAGS_DEBUG
-  "-O0 "
-  "-DCLIB_DEBUG "
-  "-fstack-protector "
-  "-DFORTIFY_SOURCE=2 "
-  "-fno-common "
-)
-
-# coverity
-list(APPEND BUILD_TYPES "coverity")
-string(CONCAT CMAKE_C_FLAGS_COVERITY "-O2 -D__COVERITY__")
-
-# gcov
-list(APPEND BUILD_TYPES "gcov")
-string(CONCAT CMAKE_C_FLAGS_GCOV
-  "-O0 "
-  "-DCLIB_DEBUG "
-  "-DCLIB_GCOV "
-  "-fprofile-arcs "
-  "-ftest-coverage ")
-
+string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LC)
 string(TOUPPER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_UC)
 
+set(CMAKE_C_FLAGS_RELEASE "")
+set(CMAKE_C_FLAGS_DEBUG "")
 
-string(REPLACE ";" " " BUILD_TYPES "${BUILD_TYPES}")
+if (${CMAKE_BUILD_TYPE_LC} MATCHES "release")
+  add_compile_options(-O3 -fstack-protector -fno-common)
+  add_compile_definitions(_FORTIFY_SOURCE=2)
+  set(CMAKE_EXE_LINKER_FLAGS_RELEASE "-pie")
+elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "debug")
+  add_compile_options(-O0 -fstack-protector -fno-common)
+  add_compile_definitions(CLIB_DEBUG)
+elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "coverity")
+  add_compile_options(-O0)
+  add_compile_definitions(__COVERITY__)
+elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "gcov")
+  add_compile_options(-O0 -fprofile-arcs -ftest-coverage)
+  add_compile_definitions(CLIB_DEBUG CLIB_GCOV)
+endif()
+
+set(BUILD_TYPES release debug coverity gcov)
+string(REPLACE ";" " " BUILD_TYPES_STR "${BUILD_TYPES}")
 set_property(CACHE CMAKE_BUILD_TYPE PROPERTY
-            HELPSTRING "Build type - valid options are: ${BUILD_TYPES}")
+            HELPSTRING "Build type - valid options are: ${BUILD_TYPES_STR}")
 
+##############################################################################
+# link time optimizations
+##############################################################################
+if (CMAKE_BUILD_TYPE_UC STREQUAL "RELEASE")
+  check_ipo_supported(RESULT _result)
+  if (_result)
+    option(VPP_USE_LTO "Link time optimization of release binaries" ON)
+  endif()
+endif()
+
+if(VPP_USE_LTO)
+  check_c_compiler_flag("-Wno-stringop-overflow"
+                       compiler_flag_no_stringop_overflow)
+endif()
 ##############################################################################
 # sanitizers
 ##############################################################################
 
 option(VPP_ENABLE_SANITIZE_ADDR "Enable Address Sanitizer" OFF)
+set(VPP_SANITIZE_ADDR_OPTIONS
+  "unmap_shadow_on_exit=1:disable_coredump=0:abort_on_error=1:detect_leaks=0"
+  CACHE
+  STRING "Address sanitizer arguments"
+)
+
 if (VPP_ENABLE_SANITIZE_ADDR)
-  set(CMAKE_C_FLAGS "-fsanitize=address --param asan-stack=0 -DCLIB_SANITIZE_ADDR ${CMAKE_C_FLAGS}")
+  add_compile_options(-fsanitize=address)
+  add_compile_definitions(CLIB_SANITIZE_ADDR)
   set(CMAKE_EXE_LINKER_FLAGS "-fsanitize=address ${CMAKE_EXE_LINKER_FLAGS}")
   set(CMAKE_SHARED_LINKER_FLAGS "-fsanitize=address ${CMAKE_SHARED_LINKER_FLAGS}")
 endif (VPP_ENABLE_SANITIZE_ADDR)
 
+##############################################################################
+# trajectory trace
+##############################################################################
+
+option(VPP_ENABLE_TRAJECTORY_TRACE "Build vpp with trajectory tracing enabled" OFF)
+if(VPP_ENABLE_TRAJECTORY_TRACE)
+  add_compile_definitions(VLIB_BUFFER_TRACE_TRAJECTORY=1)
+endif()
+
+##############################################################################
+# unittest with clang ode coverage
+##############################################################################
+
+if("${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.13" AND "${CMAKE_C_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
+  option(VPP_BUILD_TESTS_WITH_COVERAGE "Build unit tests with code coverage" OFF)
+endif()
+
 ##############################################################################
 # install config
 ##############################################################################
-set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
+option(VPP_SET_RPATH "Set rpath for resulting binaries and libraries." ON)
+if(VPP_SET_RPATH)
+  set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${VPP_LIBRARY_DIR}")
+endif()
 set(CMAKE_INSTALL_MESSAGE NEVER)
 
 include_directories (
        ${CMAKE_SOURCE_DIR}
-       ${CMAKE_BINARY_DIR}
-       ${CMAKE_BINARY_DIR}/include
+       ${VPP_BINARY_DIR}
 )
 set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME "vpp")
 
@@ -145,10 +195,10 @@ option(VPP_HOST_TOOLS_ONLY "Build only host tools" OFF)
 if(VPP_HOST_TOOLS_ONLY)
   set(SUBDIRS tools/vppapigen cmake)
 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
-  find_package(OpenSSL REQUIRED)
+  find_package(OpenSSL)
   set(SUBDIRS
-    vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vcl plugins
-    vpp-api tools/vppapigen tools/g2 tools/perftool cmake pkg
+    vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vat2 vcl vpp-api
+    plugins tools/vppapigen tools/g2 tools/perftool cmake pkg
     tools/appimage
   )
 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
@@ -158,7 +208,7 @@ else()
 endif()
 
 foreach(DIR ${SUBDIRS})
-  add_subdirectory(${DIR})
+  add_subdirectory(${DIR} ${VPP_BINARY_DIR}/${DIR})
 endforeach()
 
 ##############################################################################
@@ -179,18 +229,60 @@ if (VPP_GIT_TOPLEVEL_DIR)
   )
 endif()
 
+##############################################################################
+# custom targets
+##############################################################################
+
+add_custom_target(run
+  COMMAND ./${VPP_RUNTIME_DIR}/vpp -c startup.conf
+  COMMENT "Starting VPP..."
+  USES_TERMINAL
+)
+
+add_custom_target(debug
+  COMMAND gdb --args ./${VPP_RUNTIME_DIR}/vpp -c startup.conf
+  COMMENT "Starting VPP in the debugger..."
+  USES_TERMINAL
+)
+
+add_custom_target(config
+  COMMAND ccmake ${CMAKE_BINARY_DIR}
+  COMMENT "Starting Configuration TUI..."
+  USES_TERMINAL
+)
+
+foreach(bt ${BUILD_TYPES})
+  add_custom_target(set-build-type-${bt}
+    COMMAND cmake -DCMAKE_BUILD_TYPE:STRING=${bt} .
+    COMMENT "Changing build type to ${bt}"
+    USES_TERMINAL
+  )
+endforeach()
+
+mark_as_advanced(CLEAR
+  CMAKE_C_FLAGS
+  CMAKE_C_COMPILER
+  CMAKE_EXPORT_COMPILE_COMMANDS
+  CMAKE_INSTALL_PREFIX
+  CMAKE_LINKER
+  CMAKE_SHARED_LINKER_FLAGS
+  CMAKE_VERBOSE_MAKEFILE
+)
+
 ##############################################################################
 # print configuration
 ##############################################################################
 message(STATUS "Configuration:")
-pr("VPP version" "${VPP_VERSION}")
-pr("VPP library version" "${VPP_LIB_VERSION}")
-pr("GIT toplevel dir" "${VPP_GIT_TOPLEVEL_DIR}")
-pr("Build type" "${CMAKE_BUILD_TYPE}")
-pr("C flags" "${CMAKE_C_FLAGS}${CMAKE_C_FLAGS_${CMAKE_BUILD_TYPE_UC}}")
-pr("Linker flags (apps)" "${CMAKE_EXE_LINKER_FLAGS}${CMAKE_EXE_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}}")
-pr("Linker flags (libs)" "${CMAKE_SHARED_LINKER_FLAGS}${CMAKE_SHARED_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}}")
-pr("Host processor" "${CMAKE_HOST_SYSTEM_PROCESSOR}")
-pr("Target processor" "${CMAKE_SYSTEM_PROCESSOR}")
-pr("Prefix path" "${CMAKE_PREFIX_PATH}")
-pr("Install prefix" "${CMAKE_INSTALL_PREFIX}")
+pr("VPP version" ${VPP_VERSION})
+pr("VPP library version" ${VPP_LIB_VERSION})
+pr("GIT toplevel dir" ${VPP_GIT_TOPLEVEL_DIR})
+pr("Build type" ${CMAKE_BUILD_TYPE})
+pr("C compiler" ${CMAKE_C_COMPILER})
+pr("C flags" ${CMAKE_C_FLAGS}${CMAKE_C_FLAGS_${CMAKE_BUILD_TYPE_UC}})
+pr("Linker flags (apps)" ${CMAKE_EXE_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}})
+pr("Linker flags (libs)" ${CMAKE_SHARED_LINKER_FLAGS} ${CMAKE_SHARED_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}})
+pr("Host processor" ${CMAKE_HOST_SYSTEM_PROCESSOR})
+pr("Target processor" ${CMAKE_SYSTEM_PROCESSOR})
+pr("Prefix path" ${CMAKE_PREFIX_PATH})
+pr("Install prefix" ${CMAKE_INSTALL_PREFIX})
+pr("Library dir" ${VPP_LIBRARY_DIR})