# 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.13)
+
+set(CMAKE_C_COMPILER_NAMES clang gcc cc)
project(vpp C)
+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)
##############################################################################
-# Highlight WARNING and ERROR messages
-##############################################################################
-function(message)
- list(GET ARGV 0 type)
- string(ASCII 27 esc)
- set(red "${esc}[1;31m")
- set(yellow "${esc}[1;33m")
- set(reset "${esc}[m")
- if(type STREQUAL FATAL_ERROR OR type STREQUAL SEND_ERROR)
- list(REMOVE_AT ARGV 0)
- _message(${type} "${red}${ARGV}${reset}")
- elseif(type STREQUAL WARNING)
- list(REMOVE_AT ARGV 0)
- _message(STATUS "${yellow}${ARGV}${reset}")
- elseif(type STREQUAL STATUS)
- list(REMOVE_AT ARGV 0)
- _message(STATUS "${ARGV}")
- else()
- _message(${ARGV})
- endif()
-endfunction()
+# VPP Version
+##############################################################################
+execute_process(
+ WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+ COMMAND scripts/version
+ OUTPUT_VARIABLE VPP_VERSION
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+string(REPLACE "-" ";" VPP_LIB_VERSION ${VPP_VERSION})
+list(GET VPP_LIB_VERSION 0 VPP_LIB_VERSION)
##############################################################################
-# CPU optimizations and multiarch support
+# compiler specifics
##############################################################################
-if(CMAKE_SYSTEM_PROCESSOR MATCHES "amd64.*|x86_64.*|AMD64.*")
- set(CMAKE_C_FLAGS "-march=corei7 -mtune=corei7-avx ${CMAKE_C_FLAGS}")
- check_c_compiler_flag("-march=core-avx2" AVX2)
- if(AVX2)
- list(APPEND MARCH_VARIANTS "avx2\;-march=core-avx2 -mtune=core-avx2")
+
+set(MIN_SUPPORTED_CLANG_C_COMPILER_VERSION 9.0.0)
+set(MIN_SUPPORTED_GNU_C_COMPILER_VERSION 9.0.0)
+
+if(CMAKE_C_COMPILER_ID STREQUAL "Clang")
+ if (CMAKE_C_COMPILER_VERSION VERSION_LESS MIN_SUPPORTED_CLANG_C_COMPILER_VERSION)
+ set(COMPILER_TOO_OLD TRUE)
endif()
- check_c_compiler_flag("-march=skylake-avx512" AVX512)
- if(AVX512)
- list(APPEND MARCH_VARIANTS "avx512\;-march=skylake-avx512 -mtune=skylake-avx512")
+elseif(CMAKE_C_COMPILER_ID STREQUAL "GNU")
+ if (CMAKE_C_COMPILER_VERSION VERSION_LESS MIN_SUPPORTED_GNU_C_COMPILER_VERSION)
+ set(COMPILER_TOO_OLD TRUE)
endif()
-elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64.*|AARCH64.*)")
- set(CMAKE_C_FLAGS "-march=armv8-a+crc ${CMAKE_C_FLAGS}")
+ set(GCC_STRING_OVERFLOW_WARNING_DISABLE_VERSION 10.0.0)
+ if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL GCC_STRING_OVERFLOW_WARNING_DISABLE_VERSION)
+ add_compile_options(-Wno-stringop-overflow)
+ endif()
+else()
+ message(WARNING "WARNING: Unsupported C compiler `${CMAKE_C_COMPILER_ID}` is used")
+ set (PRINT_MIN_C_COMPILER_VER TRUE)
+endif()
+if (COMPILER_TOO_OLD)
+ message(WARNING "WARNING: C compiler version is too old and it's usage may result")
+ message(WARNING " in sub-optimal binaries or lack of support for specific CPU types.")
+ set (PRINT_MIN_C_COMPILER_VER TRUE)
+endif()
+
+if (PRINT_MIN_C_COMPILER_VER)
+ string (APPEND _t "Supported C compilers are ")
+ string (APPEND _t "Clang ${MIN_SUPPORTED_CLANG_C_COMPILER_VERSION} or higher ")
+ string (APPEND _t "and GNU ${MIN_SUPPORTED_GNU_C_COMPILER_VERSION} or higher.")
+ message(WARNING " ${_t}")
+ unset (_t)
endif()
-macro(vpp_library_set_multiarch_sources lib)
- foreach(V ${MARCH_VARIANTS})
- list(GET V 0 VARIANT)
- list(GET V 1 VARIANT_FLAGS)
- set(l ${lib}_${VARIANT})
- add_library(${l} OBJECT ${ARGN})
- set_target_properties(${l} PROPERTIES POSITION_INDEPENDENT_CODE ON)
- target_compile_options(${l} PUBLIC "-DCLIB_MARCH_VARIANT=${VARIANT}")
- separate_arguments(VARIANT_FLAGS)
- target_compile_options(${l} PUBLIC ${VARIANT_FLAGS})
- target_sources(${lib} PRIVATE $<TARGET_OBJECTS:${l}>)
- endforeach()
-endmacro()
+##############################################################################
+# cross compiling
+##############################################################################
+if(CMAKE_CROSSCOMPILING)
+ set(CMAKE_IGNORE_PATH
+ /usr/lib/${CMAKE_HOST_SYSTEM_PROCESSOR}-linux-gnu/
+ /usr/lib/${CMAKE_HOST_SYSTEM_PROCESSOR}-linux-gnu/lib/
+ )
+endif()
+set(CMAKE_C_COMPILER_TARGET ${CMAKE_SYSTEM_PROCESSOR}-linux-gnu)
##############################################################################
# build config
##############################################################################
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
-set(CMAKE_C_FLAGS_COMMON "-DFORTIFY_SOURCE=2 -fstack-protector-all -Werror")
-set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} ${CMAKE_C_FLAGS_COMMON} -DCLIB_DEBUG")
-set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} ${CMAKE_C_FLAGS_COMMON}")
+check_c_compiler_flag("-Wno-address-of-packed-member"
+ compiler_flag_no_address_of_packed_member)
+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}/CMakeFiles/__pycache__)
+
+if (CMAKE_BUILD_TYPE)
+ add_compile_options(-g -Werror -Wall)
+endif()
+
+if (compiler_flag_no_address_of_packed_member)
+ add_compile_options(-Wno-address-of-packed-member)
+endif()
+
+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 "")
+
+if (${CMAKE_BUILD_TYPE_LC} MATCHES "release")
+ add_compile_options(-O3 -fstack-protector -fno-common)
+ add_compile_definitions(_FORTIFY_SOURCE=2)
+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_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)
+ add_compile_options(-fsanitize=address)
+ add_link_options(-fsanitize=address)
+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()
##############################################################################
-# ccache
+# unittest with clang ode coverage
##############################################################################
-option(VPP_USE_CCACHE "Use ccache compiler cache." ON)
-if(VPP_USE_CCACHE)
- find_program(CCACHE_FOUND ccache)
- message(STATUS "Looking for ccache")
- if(CCACHE_FOUND)
- message(STATUS "Looking for ccache - found")
- set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
- set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)
- else(CCACHE_FOUND)
- message(STATUS "Looking for ccache - not found")
- endif(CCACHE_FOUND)
-endif(VPP_USE_CCACHE)
+
+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)
-message(STATUS "CMAKE_C_FLAGS: ${CMAKE_C_FLAGS}")
-message(STATUS "We are on a ${CMAKE_SYSTEM_NAME} system")
-message(STATUS "The host processor is ${CMAKE_HOST_SYSTEM_PROCESSOR}")
-
include_directories (
${CMAKE_SOURCE_DIR}
- ${CMAKE_BINARY_DIR}
- ${CMAKE_BINARY_DIR}/include
+ ${VPP_BINARY_DIR}
)
set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME "vpp")
set(THREADS_PREFER_PTHREAD_FLAG ON)
find_package(Threads REQUIRED)
-find_package(OpenSSL REQUIRED)
-include_directories(${OPENSSL_INCLUDE_DIR})
-add_definitions(-DHAVE_MEMFD_CREATE -DVPP_API_TEST_BUILTIN=1)
+include(cmake/syscall.cmake)
+include(cmake/api.cmake)
+include(cmake/library.cmake)
+include(cmake/exec.cmake)
+include(cmake/plugin.cmake)
##############################################################################
-# API
+# subdirs - order matters
##############################################################################
-function(vpp_generate_api_header file)
- set (output_name ${CMAKE_CURRENT_BINARY_DIR}/${file}.h)
- get_filename_component(output_dir ${output_name} DIRECTORY)
- add_custom_command (OUTPUT ${output_name}
- COMMAND mkdir -p ${output_dir}
- COMMAND ${CMAKE_SOURCE_DIR}/tools/vppapigen/vppapigen
- ARGS --includedir ${CMAKE_SOURCE_DIR} --input ${CMAKE_CURRENT_SOURCE_DIR}/${file} --output ${output_name}
- DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${file}
- COMMENT "Generating API header ${file}.h"
+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)
+ set(SUBDIRS
+ vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vat2 vcl vpp-api
+ plugins tools/vppapigen tools/g2 tools/perftool cmake pkg
+ tools/appimage
)
-endfunction()
-
-function(vpp_add_api_files target)
- unset(header_files)
- foreach(file ${ARGN})
- vpp_generate_api_header (${file})
- list (APPEND header_files ${file}.h)
- endforeach()
- add_custom_target(${target} DEPENDS ${header_files})
-endfunction()
-
-add_custom_target(api_headers
- DEPENDS vlibmemory_api_headers vnet_api_headers vpp_api_headers
-)
+elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
+ set(SUBDIRS vppinfra)
+else()
+ message(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}")
+endif()
+
+foreach(DIR ${SUBDIRS})
+ add_subdirectory(${DIR} ${VPP_BINARY_DIR}/${DIR})
+endforeach()
##############################################################################
-# header files
+# detect if we are inside git repo and add configure dependency
##############################################################################
-function (vpp_add_header_files path)
- foreach(file ${ARGN})
- get_filename_component(dir ${file} DIRECTORY)
- install(FILES ${file} DESTINATION include/${path}/${dir})
- endforeach()
-endfunction()
+execute_process(
+ WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+ COMMAND git rev-parse --show-toplevel
+ OUTPUT_VARIABLE VPP_GIT_TOPLEVEL_DIR
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+ ERROR_QUIET
+)
+
+if (VPP_GIT_TOPLEVEL_DIR)
+ set_property(
+ DIRECTORY APPEND PROPERTY
+ CMAKE_CONFIGURE_DEPENDS ${VPP_GIT_TOPLEVEL_DIR}/.git/index
+ )
+endif()
##############################################################################
-# subdirs
+# custom targets
##############################################################################
-foreach (DIR vppinfra svm vlib vlibmemory vnet vpp vpp-api vcl plugins)
- add_subdirectory(${DIR})
-endforeach ()
+
+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
+)
##############################################################################
-# DEB Packaging
+# print configuration
##############################################################################
-set(CPACK_GENERATOR "DEB")
-set(CPACK_DEBIAN_PACKAGE_MAINTAINER "VPP Team")
-set(CPACK_PACKAGE_NAME "vpp")
-set(CPACK_PACKAGE_VENDOR "fd.io")
-set(CPACK_PACKAGE_VERSION "18.08")
-set(CPACK_DEB_COMPONENT_INSTALL ON)
-set(CPACK_COMPONENTS_IGNORE_GROUPS 1)
-set(CPACK_DEBIAN_VPP_PACKAGE_NAME "vpp")
-set(CPACK_DEBIAN_VPP_FILE_NAME "vpp.deb")
-set(CPACK_DEBIAN_DEV_PACKAGE_NAME "vpp-dev")
-set(CPACK_DEBIAN_DEV_FILE_NAME "vpp-dev.deb")
-set(CPACK_DEBIAN_PLUGINS_PACKAGE_NAME "vpp-plugins")
-set(CPACK_DEBIAN_PLUGINS_FILE_NAME "vpp-plugins.deb")
-include(CPack)
+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 compiler" "${CMAKE_C_COMPILER} (${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION})")
+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})
+pr("Multiarch variants" ${MARCH_VARIANTS_NAMES})