1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 cmake_minimum_required(VERSION 3.13)
16 if(DEFINED VPP_PLATFORM AND VPP_PLATFORM STREQUAL "default")
18 unset(VPP_PLATFORM CACHE)
19 set(VPP_PLATFORM_NAME "default")
20 elseif(DEFINED VPP_PLATFORM)
21 set(platform_file ${CMAKE_SOURCE_DIR}/cmake/platform/${VPP_PLATFORM}.cmake)
22 if(NOT EXISTS ${platform_file})
23 message(FATAL_ERROR "unknown platform ${VPP_PLATFORM}")
25 include(${platform_file})
26 set(VPP_PLATFORM_NAME ${VPP_PLATFORM})
28 set(VPP_PLATFORM_NAME "default")
31 if (DEFINED VPP_PLATFORM_C_COMPILER_NAMES)
32 set(CMAKE_C_COMPILER_NAMES ${VPP_PLATFORM_C_COMPILER_NAME})
34 set(CMAKE_C_COMPILER_NAMES clang gcc cc)
39 if(NOT DEFINED CMAKE_INSTALL_LIBDIR AND EXISTS "/etc/debian_version")
40 set(CMAKE_INSTALL_LIBDIR "lib/${CMAKE_LIBRARY_ARCHITECTURE}")
43 include(CheckCCompilerFlag)
44 include(CheckIPOSupported)
45 include(GNUInstallDirs)
46 include(cmake/misc.cmake)
47 include(cmake/cpu.cmake)
48 include(cmake/ccache.cmake)
50 ##############################################################################
52 ##############################################################################
54 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
55 COMMAND scripts/version
56 OUTPUT_VARIABLE VPP_VERSION
57 OUTPUT_STRIP_TRAILING_WHITESPACE
61 set(VPP_VERSION ${VPP_VERSION}-${VPP_PLATFORM_NAME})
64 string(REPLACE "-" ";" VPP_LIB_VERSION ${VPP_VERSION})
65 list(GET VPP_LIB_VERSION 0 VPP_LIB_VERSION)
67 ##############################################################################
69 ##############################################################################
71 set(MIN_SUPPORTED_CLANG_C_COMPILER_VERSION 9.0.0)
72 set(MIN_SUPPORTED_GNU_C_COMPILER_VERSION 9.0.0)
74 if(CMAKE_C_COMPILER_ID STREQUAL "Clang")
75 if (CMAKE_C_COMPILER_VERSION VERSION_LESS MIN_SUPPORTED_CLANG_C_COMPILER_VERSION)
76 set(COMPILER_TOO_OLD TRUE)
78 elseif(CMAKE_C_COMPILER_ID STREQUAL "GNU")
79 if (CMAKE_C_COMPILER_VERSION VERSION_LESS MIN_SUPPORTED_GNU_C_COMPILER_VERSION)
80 set(COMPILER_TOO_OLD TRUE)
82 set(GCC_STRING_OVERFLOW_WARNING_DISABLE_VERSION 10.0.0)
83 if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL GCC_STRING_OVERFLOW_WARNING_DISABLE_VERSION)
84 add_compile_options(-Wno-stringop-overflow)
86 set(GCC_STRING_OVERREAD_WARNING_DISABLE_VERSION 12.0.0)
87 if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL GCC_STRING_OVERREAD_WARNING_DISABLE_VERSION)
88 add_compile_options(-Wno-stringop-overread)
90 set(GCC_ARRAY_BOUNDS_WARNING_DISABLE_VERSION 12.0.0)
91 if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL GCC_ARRAY_BOUNDS_WARNING_DISABLE_VERSION)
92 add_compile_options(-Wno-array-bounds)
95 message(WARNING "WARNING: Unsupported C compiler `${CMAKE_C_COMPILER_ID}` is used")
96 set (PRINT_MIN_C_COMPILER_VER TRUE)
99 message(WARNING "WARNING: C compiler version is too old and it's usage may result")
100 message(WARNING " in sub-optimal binaries or lack of support for specific CPU types.")
101 set (PRINT_MIN_C_COMPILER_VER TRUE)
104 if (PRINT_MIN_C_COMPILER_VER)
105 string (APPEND _t "Supported C compilers are ")
106 string (APPEND _t "Clang ${MIN_SUPPORTED_CLANG_C_COMPILER_VERSION} or higher ")
107 string (APPEND _t "and GNU ${MIN_SUPPORTED_GNU_C_COMPILER_VERSION} or higher.")
108 message(WARNING " ${_t}")
112 ##############################################################################
114 ##############################################################################
115 if(CMAKE_CROSSCOMPILING)
116 set(CMAKE_IGNORE_PATH
117 /usr/lib/${CMAKE_HOST_SYSTEM_PROCESSOR}-linux-gnu/
118 /usr/lib/${CMAKE_HOST_SYSTEM_PROCESSOR}-linux-gnu/lib/
121 set(CMAKE_C_COMPILER_TARGET ${CMAKE_SYSTEM_PROCESSOR}-linux-gnu)
123 ##############################################################################
125 ##############################################################################
126 check_c_compiler_flag("-Wno-address-of-packed-member"
127 compiler_flag_no_address_of_packed_member)
128 set(VPP_RUNTIME_DIR ${CMAKE_INSTALL_BINDIR} CACHE STRING "Relative runtime directory path")
129 set(VPP_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR} CACHE STRING "Relative library directory path")
131 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${VPP_RUNTIME_DIR})
132 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${VPP_LIBRARY_DIR})
133 set(VPP_BINARY_DIR ${CMAKE_BINARY_DIR}/CMakeFiles)
134 set(PYENV PYTHONPYCACHEPREFIX=${CMAKE_BINARY_DIR}/CMakeFiles/__pycache__)
136 if (CMAKE_BUILD_TYPE)
137 add_compile_options(-g -Werror -Wall)
140 if (compiler_flag_no_address_of_packed_member)
141 add_compile_options(-Wno-address-of-packed-member)
144 string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LC)
145 string(TOUPPER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_UC)
147 set(CMAKE_C_FLAGS_RELEASE "")
148 set(CMAKE_C_FLAGS_DEBUG "")
150 if (${CMAKE_BUILD_TYPE_LC} MATCHES "release")
151 add_compile_options(-O3 -fstack-protector -fno-common)
152 add_compile_definitions(_FORTIFY_SOURCE=2)
153 elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "debug")
154 add_compile_options(-O0 -fstack-protector -fno-common)
155 add_compile_definitions(CLIB_DEBUG)
156 elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "coverity")
157 add_compile_options(-O0)
158 add_compile_definitions(__COVERITY__)
159 elseif (${CMAKE_BUILD_TYPE_LC} MATCHES "gcov")
160 add_compile_options(-O0 -fprofile-arcs -ftest-coverage)
161 add_compile_definitions(CLIB_DEBUG CLIB_GCOV)
165 set(BUILD_TYPES release debug coverity gcov)
166 string(REPLACE ";" " " BUILD_TYPES_STR "${BUILD_TYPES}")
167 set_property(CACHE CMAKE_BUILD_TYPE PROPERTY
168 HELPSTRING "Build type - valid options are: ${BUILD_TYPES_STR}")
170 ##############################################################################
171 # link time optimizations
172 ##############################################################################
173 if (CMAKE_BUILD_TYPE_UC STREQUAL "RELEASE")
174 check_ipo_supported(RESULT _result)
176 option(VPP_USE_LTO "Link time optimization of release binaries" ON)
181 check_c_compiler_flag("-Wno-stringop-overflow"
182 compiler_flag_no_stringop_overflow)
184 ##############################################################################
186 ##############################################################################
188 option(VPP_ENABLE_SANITIZE_ADDR "Enable Address Sanitizer" OFF)
189 set(VPP_SANITIZE_ADDR_OPTIONS
190 "unmap_shadow_on_exit=1:disable_coredump=0:abort_on_error=1:detect_leaks=0"
192 STRING "Address sanitizer arguments"
195 if (VPP_ENABLE_SANITIZE_ADDR)
196 add_compile_options(-fsanitize=address)
197 add_link_options(-fsanitize=address)
198 endif (VPP_ENABLE_SANITIZE_ADDR)
200 ##############################################################################
202 ##############################################################################
204 option(VPP_ENABLE_TRAJECTORY_TRACE "Build vpp with trajectory tracing enabled" OFF)
205 if(VPP_ENABLE_TRAJECTORY_TRACE)
206 add_compile_definitions(VLIB_BUFFER_TRACE_TRAJECTORY=1)
209 ##############################################################################
210 # unittest with clang code coverage
211 ##############################################################################
213 if("${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.13" AND "${CMAKE_C_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
214 option(VPP_BUILD_TESTS_WITH_COVERAGE "Build unit tests with code coverage" OFF)
217 ##############################################################################
219 ##############################################################################
220 option(VPP_SET_RPATH "Set rpath for resulting binaries and libraries." ON)
222 set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${VPP_LIBRARY_DIR}")
224 set(CMAKE_INSTALL_MESSAGE NEVER)
226 include_directories (
230 set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME "vpp")
232 set(THREADS_PREFER_PTHREAD_FLAG ON)
233 find_package(Threads REQUIRED)
235 include(cmake/syscall.cmake)
236 include(cmake/api.cmake)
237 include(cmake/library.cmake)
238 include(cmake/exec.cmake)
239 include(cmake/plugin.cmake)
241 ##############################################################################
242 # subdirs - order matters
243 ##############################################################################
244 option(VPP_HOST_TOOLS_ONLY "Build only host tools" OFF)
245 if(VPP_HOST_TOOLS_ONLY)
246 set(SUBDIRS tools/vppapigen cmake)
249 vpp-api/vapi/vapi_c_gen.py
250 vpp-api/vapi/vapi_cpp_gen.py
251 vpp-api/vapi/vapi_json_parser.py
252 DESTINATION ${VPP_RUNTIME_DIR}
255 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
256 find_package(OpenSSL)
258 vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vat2 vcl vpp-api
259 plugins tools/vppapigen tools/g2 tools/perftool cmake pkg
262 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
263 set(SUBDIRS vppinfra)
265 message(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}")
268 foreach(DIR ${SUBDIRS})
269 add_subdirectory(${DIR} ${VPP_BINARY_DIR}/${DIR})
272 ##############################################################################
273 # detect if we are inside git repo and add configure dependency
274 ##############################################################################
276 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
277 COMMAND git rev-parse --show-toplevel
278 OUTPUT_VARIABLE VPP_GIT_TOPLEVEL_DIR
279 OUTPUT_STRIP_TRAILING_WHITESPACE
283 if (VPP_GIT_TOPLEVEL_DIR)
285 DIRECTORY APPEND PROPERTY
286 CMAKE_CONFIGURE_DEPENDS ${VPP_GIT_TOPLEVEL_DIR}/.git/index
290 ##############################################################################
292 ##############################################################################
294 add_custom_target(run
295 COMMAND ./${VPP_RUNTIME_DIR}/vpp -c startup.conf
296 COMMENT "Starting VPP..."
300 add_custom_target(debug
301 COMMAND gdb --args ./${VPP_RUNTIME_DIR}/vpp -c startup.conf
302 COMMENT "Starting VPP in the debugger..."
306 add_custom_target(config
307 COMMAND ccmake ${CMAKE_BINARY_DIR}
308 COMMENT "Starting Configuration TUI..."
312 foreach(bt ${BUILD_TYPES})
313 add_custom_target(set-build-type-${bt}
314 COMMAND cmake -DCMAKE_BUILD_TYPE:STRING=${bt} .
315 COMMENT "Changing build type to ${bt}"
320 mark_as_advanced(CLEAR
323 CMAKE_EXPORT_COMPILE_COMMANDS
326 CMAKE_SHARED_LINKER_FLAGS
327 CMAKE_VERBOSE_MAKEFILE
330 ##############################################################################
331 # print configuration
332 ##############################################################################
333 message(STATUS "Configuration:")
334 pr("VPP platform" ${VPP_PLATFORM_NAME})
335 pr("VPP version" ${VPP_VERSION})
336 pr("VPP library version" ${VPP_LIB_VERSION})
337 pr("GIT toplevel dir" ${VPP_GIT_TOPLEVEL_DIR})
338 pr("Build type" ${CMAKE_BUILD_TYPE})
339 pr("C compiler" "${CMAKE_C_COMPILER} (${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION})")
340 pr("C flags" ${CMAKE_C_FLAGS}${CMAKE_C_FLAGS_${CMAKE_BUILD_TYPE_UC}})
341 pr("Linker flags (apps)" ${CMAKE_EXE_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}})
342 pr("Linker flags (libs)" ${CMAKE_SHARED_LINKER_FLAGS} ${CMAKE_SHARED_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UC}})
343 pr("Host processor" ${CMAKE_HOST_SYSTEM_PROCESSOR})
344 pr("Target processor" ${CMAKE_SYSTEM_PROCESSOR})
345 pr("Prefix path" ${CMAKE_PREFIX_PATH})
346 pr("Install prefix" ${CMAKE_INSTALL_PREFIX})
347 pr("Library dir" ${VPP_LIBRARY_DIR})
348 pr("Multiarch variants" ${MARCH_VARIANTS_NAMES})