1 # CMake build for CompilerRT.
3 # This build assumes that CompilerRT is checked out into the
4 # 'projects/compiler-rt' inside of an LLVM tree.
5 # Standalone build system for CompilerRT is not yet ready.
7 # An important constraint of the build is that it only produces libraries
8 # based on the ability of the host toolchain to target various platforms.
10 # Check if compiler-rt is built as a standalone project.
11 if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
13 set(COMPILER_RT_STANDALONE_BUILD TRUE)
15 set(COMPILER_RT_STANDALONE_BUILD FALSE)
18 # The CompilerRT build system requires CMake version 2.8.8 or higher in order
19 # to use its support for building convenience "libraries" as a collection of
20 # .o files. This is particularly useful in producing larger, more complex
23 cmake_minimum_required(VERSION 2.8.8)
25 # Version 2.8.12.1 is required to build with Visual Studion 2013.
26 cmake_minimum_required(VERSION 2.8.12.1)
29 # FIXME: It may be removed when we use 2.8.12.
30 if(CMAKE_VERSION VERSION_LESS 2.8.12)
31 # Invalidate a couple of keywords.
32 set(cmake_2_8_12_INTERFACE)
33 set(cmake_2_8_12_PRIVATE)
35 # Use ${cmake_2_8_12_KEYWORD} intead of KEYWORD in target_link_libraries().
36 set(cmake_2_8_12_INTERFACE INTERFACE)
37 set(cmake_2_8_12_PRIVATE PRIVATE)
39 cmake_policy(SET CMP0022 NEW) # automatic when 2.8.12 is required
43 # Top level target used to build all compiler-rt libraries.
44 add_custom_target(compiler-rt ALL)
46 if (NOT COMPILER_RT_STANDALONE_BUILD)
47 # Compute the Clang version from the LLVM version.
48 # FIXME: We should be able to reuse CLANG_VERSION variable calculated
49 # in Clang cmake files, instead of copying the rules here.
50 string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" CLANG_VERSION
52 # Setup the paths where compiler-rt runtimes and headers should be stored.
53 set(COMPILER_RT_OUTPUT_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR}/clang/${CLANG_VERSION})
54 set(COMPILER_RT_EXEC_OUTPUT_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
55 set(COMPILER_RT_INSTALL_PATH lib${LLVM_LIBDIR_SUFFIX}/clang/${CLANG_VERSION})
56 option(COMPILER_RT_INCLUDE_TESTS "Generate and build compiler-rt unit tests."
57 ${LLVM_INCLUDE_TESTS})
58 option(COMPILER_RT_ENABLE_WERROR "Fail and stop if warning is triggered"
59 ${LLVM_ENABLE_WERROR})
60 # Use just-built Clang to compile/link tests on all platforms, except for
61 # Windows where we need to use clang-cl instead.
63 set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang)
65 set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang.exe)
68 # Take output dir and install path from the user.
69 set(COMPILER_RT_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH
70 "Path where built compiler-rt libraries should be stored.")
71 set(COMPILER_RT_EXEC_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/bin CACHE PATH
72 "Path where built compiler-rt executables should be stored.")
73 set(COMPILER_RT_INSTALL_PATH ${CMAKE_INSTALL_PREFIX} CACHE PATH
74 "Path where built compiler-rt libraries should be installed.")
75 option(COMPILER_RT_INCLUDE_TESTS "Generate and build compiler-rt unit tests." OFF)
76 option(COMPILER_RT_ENABLE_WERROR "Fail and stop if warning is triggered" OFF)
77 # Use a host compiler to compile/link tests.
78 set(COMPILER_RT_TEST_COMPILER ${CMAKE_C_COMPILER} CACHE PATH "Compiler to use for testing")
80 if (NOT LLVM_CONFIG_PATH)
81 find_program(LLVM_CONFIG_PATH "llvm-config"
82 DOC "Path to llvm-config binary")
83 if (NOT LLVM_CONFIG_PATH)
84 message(FATAL_ERROR "llvm-config not found: specify LLVM_CONFIG_PATH")
88 COMMAND ${LLVM_CONFIG_PATH} "--obj-root" "--bindir" "--libdir" "--src-root"
89 RESULT_VARIABLE HAD_ERROR
90 OUTPUT_VARIABLE CONFIG_OUTPUT)
92 message(FATAL_ERROR "llvm-config failed with status ${HAD_ERROR}")
94 string(REGEX REPLACE "[ \t]*[\r\n]+[ \t]*" ";" CONFIG_OUTPUT ${CONFIG_OUTPUT})
95 list(GET CONFIG_OUTPUT 0 LLVM_BINARY_DIR)
96 list(GET CONFIG_OUTPUT 1 LLVM_TOOLS_BINARY_DIR)
97 list(GET CONFIG_OUTPUT 2 LLVM_LIBRARY_DIR)
98 list(GET CONFIG_OUTPUT 3 LLVM_MAIN_SRC_DIR)
100 # Make use of LLVM CMake modules.
101 file(TO_CMAKE_PATH ${LLVM_BINARY_DIR} LLVM_BINARY_DIR_CMAKE_STYLE)
102 set(LLVM_CMAKE_PATH "${LLVM_BINARY_DIR_CMAKE_STYLE}/share/llvm/cmake")
103 list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_PATH}")
104 # Get some LLVM variables from LLVMConfig.
105 include("${LLVM_CMAKE_PATH}/LLVMConfig.cmake")
107 set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib)
109 # Find Python interpreter.
110 set(Python_ADDITIONAL_VERSIONS 2.7 2.6 2.5)
111 include(FindPythonInterp)
112 if(NOT PYTHONINTERP_FOUND)
113 message(FATAL_ERROR "
114 Unable to find Python interpreter required testing. Please install Python
115 or specify the PYTHON_EXECUTABLE CMake variable.")
118 # Define default arguments to lit.
119 set(LIT_ARGS_DEFAULT "-sv")
121 set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
123 set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
126 if("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang[+]*$")
127 set(COMPILER_RT_TEST_COMPILER_ID Clang)
128 elseif("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang.*.exe$")
129 set(COMPILER_RT_TEST_COMPILER_ID Clang)
131 set(COMPILER_RT_TEST_COMPILER_ID GNU)
134 # Tests using XFAIL use the first value in COMPILER_RT_TEST_TARGET_TRIPLE
135 set(COMPILER_RT_TEST_TARGET_TRIPLE ${TARGET_TRIPLE} CACHE STRING
136 "Default triple for cross-compiled executables")
137 string(REPLACE "-" ";" TARGET_TRIPLE_LIST ${COMPILER_RT_TEST_TARGET_TRIPLE})
138 list(GET TARGET_TRIPLE_LIST 0 COMPILER_RT_TEST_TARGET_ARCH)
139 list(GET TARGET_TRIPLE_LIST 1 COMPILER_RT_TEST_TARGET_OS)
140 list(GET TARGET_TRIPLE_LIST 2 COMPILER_RT_TEST_TARGET_ABI)
142 if ("${COMPILER_RT_TEST_TARGET_ABI}" STREQUAL "androideabi")
146 string(TOLOWER ${CMAKE_SYSTEM_NAME} COMPILER_RT_OS_DIR)
147 set(COMPILER_RT_LIBRARY_OUTPUT_DIR
148 ${COMPILER_RT_OUTPUT_DIR}/lib/${COMPILER_RT_OS_DIR})
149 set(COMPILER_RT_LIBRARY_INSTALL_DIR
150 ${COMPILER_RT_INSTALL_PATH}/lib/${COMPILER_RT_OS_DIR})
152 # Add path for custom compiler-rt modules.
153 set(CMAKE_MODULE_PATH
154 "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
155 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
158 include(CompilerRTUtils)
160 set(COMPILER_RT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
161 set(COMPILER_RT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
162 # Setup custom SDK sysroots.
163 set(COMPILER_RT_DARWIN_SDK_SYSROOT ${COMPILER_RT_SOURCE_DIR}/SDKs/darwin)
164 set(COMPILER_RT_LINUX_SDK_SYSROOT ${COMPILER_RT_SOURCE_DIR}/SDKs/linux)
166 set(COMPILER_RT_EXTRA_ANDROID_HEADERS ${COMPILER_RT_SOURCE_DIR}/android/include)
168 # Detect whether the current target platform is 32-bit or 64-bit, and setup
169 # the correct commandline flags needed to attempt to target 32-bit and 64-bit.
170 if (NOT CMAKE_SIZEOF_VOID_P EQUAL 4 AND
171 NOT CMAKE_SIZEOF_VOID_P EQUAL 8)
172 message(FATAL_ERROR "Please use architecture with 4 or 8 byte pointers.")
175 set(TARGET_64_BIT_CFLAGS "-m64")
176 set(TARGET_32_BIT_CFLAGS "-m32")
178 set(TARGET_64_BIT_CFLAGS "")
179 set(TARGET_32_BIT_CFLAGS "")
182 # List of architectures we can target.
183 set(COMPILER_RT_SUPPORTED_ARCH)
185 function(get_target_flags_for_arch arch out_var)
186 list(FIND COMPILER_RT_SUPPORTED_ARCH ${arch} ARCH_INDEX)
187 if(ARCH_INDEX EQUAL -1)
188 message(FATAL_ERROR "Unsupported architecture: ${arch}")
190 set(${out_var} ${TARGET_${arch}_CFLAGS} PARENT_SCOPE)
194 # Try to compile a very simple source file to ensure we can target the given
195 # platform. We use the results of these tests to build only the various target
196 # runtime libraries supported by our current compilers cross-compiling
198 set(SIMPLE_SOURCE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/simple.cc)
199 file(WRITE ${SIMPLE_SOURCE} "#include <stdlib.h>\n#include <limits>\nint main() {}\n")
201 # test_target_arch(<arch> <target flags...>)
202 # Sets the target flags for a given architecture and determines if this
203 # architecture is supported by trying to build a simple file.
204 macro(test_target_arch arch)
205 set(TARGET_${arch}_CFLAGS ${ARGN})
206 try_compile(CAN_TARGET_${arch} ${CMAKE_BINARY_DIR} ${SIMPLE_SOURCE}
207 COMPILE_DEFINITIONS "${TARGET_${arch}_CFLAGS}"
208 OUTPUT_VARIABLE TARGET_${arch}_OUTPUT
209 CMAKE_FLAGS "-DCMAKE_EXE_LINKER_FLAGS:STRING=${TARGET_${arch}_CFLAGS}")
210 if(${CAN_TARGET_${arch}})
211 list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
212 elseif("${COMPILER_RT_TEST_TARGET_ARCH}" MATCHES "${arch}" OR
213 "${arch}" STREQUAL "arm_android")
214 # Bail out if we cannot target the architecture we plan to test.
215 message(FATAL_ERROR "Cannot compile for ${arch}:\n${TARGET_${arch}_OUTPUT}")
220 test_target_arch(arm_android "")
222 if("${LLVM_NATIVE_ARCH}" STREQUAL "X86")
224 test_target_arch(x86_64 ${TARGET_64_BIT_CFLAGS})
226 test_target_arch(i386 ${TARGET_32_BIT_CFLAGS})
227 elseif("${LLVM_NATIVE_ARCH}" STREQUAL "PowerPC")
228 test_target_arch(powerpc64 ${TARGET_64_BIT_CFLAGS})
229 elseif("${LLVM_NATIVE_ARCH}" STREQUAL "Mips")
230 test_target_arch(mips "")
233 # Build ARM libraries if we are configured to test on ARM
234 if("${COMPILER_RT_TEST_TARGET_ARCH}" MATCHES "arm|aarch64")
235 test_target_arch(arm "-march=armv7-a")
236 test_target_arch(aarch64 "-march=armv8-a")
240 # We support running instrumented tests when we're not cross compiling
241 # and target a UNIX-like system or Windows.
242 # We can run tests on Android even when we are cross-compiling.
243 if(("${CMAKE_HOST_SYSTEM}" STREQUAL "${CMAKE_SYSTEM}" AND (UNIX OR MSVC)) OR ANDROID
244 OR COMPILER_RT_EMULATOR)
245 option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" ON)
247 option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" OFF)
250 # Check if compiler-rt is built with libc++.
251 find_flag_in_string("${CMAKE_CXX_FLAGS}" "-stdlib=libc++"
252 COMPILER_RT_USES_LIBCXX)
254 function(filter_available_targets out_var)
256 foreach(arch ${ARGN})
257 list(FIND COMPILER_RT_SUPPORTED_ARCH ${arch} ARCH_INDEX)
258 if(NOT (ARCH_INDEX EQUAL -1) AND CAN_TARGET_${arch})
259 list(APPEND archs ${arch})
262 set(${out_var} ${archs} PARENT_SCOPE)
265 option(COMPILER_RT_DEBUG "Build runtimes with full debug info" OFF)
266 # COMPILER_RT_DEBUG_PYBOOL is used by lit.common.configured.in.
267 pythonize_bool(COMPILER_RT_DEBUG)
269 option(COMPILER_RT_BUILD_SHARED_ASAN "Build shared version of AddressSanitizer runtime" OFF)
271 #================================
272 # Setup Compiler Flags
273 #================================
277 append_string_if(COMPILER_RT_HAS_W3_FLAG /W3 CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
279 append_string_if(COMPILER_RT_HAS_WALL_FLAG -Wall CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
281 if(COMPILER_RT_ENABLE_WERROR)
282 append_string_if(COMPILER_RT_HAS_WERROR_FLAG -Werror CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
283 append_string_if(COMPILER_RT_HAS_WX_FLAG /WX CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
286 append_string_if(COMPILER_RT_HAS_STD_CXX11_FLAG -std=c++11 CMAKE_CXX_FLAGS)
288 # Emulate C99 and C++11's __func__ for MSVC prior to 2013 CTP.
289 if(NOT COMPILER_RT_HAS_FUNC_SYMBOL)
290 add_definitions(-D__func__=__FUNCTION__)
293 # Provide some common commmandline flags for Sanitizer runtimes.
294 append_if(COMPILER_RT_HAS_FPIC_FLAG -fPIC SANITIZER_COMMON_CFLAGS)
295 append_if(COMPILER_RT_HAS_FNO_BUILTIN_FLAG -fno-builtin SANITIZER_COMMON_CFLAGS)
296 append_if(COMPILER_RT_HAS_FNO_EXCEPTIONS_FLAG -fno-exceptions SANITIZER_COMMON_CFLAGS)
297 append_if(COMPILER_RT_HAS_FOMIT_FRAME_POINTER_FLAG -fomit-frame-pointer SANITIZER_COMMON_CFLAGS)
298 append_if(COMPILER_RT_HAS_FUNWIND_TABLES_FLAG -funwind-tables SANITIZER_COMMON_CFLAGS)
299 append_if(COMPILER_RT_HAS_FNO_STACK_PROTECTOR_FLAG -fno-stack-protector SANITIZER_COMMON_CFLAGS)
300 append_if(COMPILER_RT_HAS_FVISIBILITY_HIDDEN_FLAG -fvisibility=hidden SANITIZER_COMMON_CFLAGS)
301 append_if(COMPILER_RT_HAS_FNO_FUNCTION_SECTIONS_FLAG -fno-function-sections SANITIZER_COMMON_CFLAGS)
304 # Remove /MD flag so that it doesn't conflict with /MT.
305 if(COMPILER_RT_HAS_MT_FLAG)
306 string(REGEX REPLACE "(^| ) */MDd? *( |$)" "\\1 \\2" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
307 list(APPEND SANITIZER_COMMON_CFLAGS /MT)
309 append_if(COMPILER_RT_HAS_Oy_FLAG /Oy- SANITIZER_COMMON_CFLAGS)
310 append_if(COMPILER_RT_HAS_GS_FLAG /GS- SANITIZER_COMMON_CFLAGS)
313 # Build with optimization, unless we're in debug mode. If we're using MSVC,
314 # always respect the optimization flags set by CMAKE_BUILD_TYPE instead.
315 if(NOT COMPILER_RT_DEBUG AND NOT MSVC)
316 list(APPEND SANITIZER_COMMON_CFLAGS -O3)
319 # Build sanitizer runtimes with debug info.
320 if(COMPILER_RT_HAS_GLINE_TABLES_ONLY_FLAG)
321 list(APPEND SANITIZER_COMMON_CFLAGS -gline-tables-only)
322 elseif(COMPILER_RT_HAS_G_FLAG)
323 list(APPEND SANITIZER_COMMON_CFLAGS -g)
324 elseif(COMPILER_RT_HAS_Zi_FLAG)
325 list(APPEND SANITIZER_COMMON_CFLAGS /Zi)
328 # Turn off several warnings.
329 append_if(COMPILER_RT_HAS_WNO_GNU_FLAG -Wno-gnu SANITIZER_COMMON_CFLAGS)
330 append_if(COMPILER_RT_HAS_WNO_VARIADIC_MACROS_FLAG -Wno-variadic-macros SANITIZER_COMMON_CFLAGS)
331 append_if(COMPILER_RT_HAS_WNO_C99_EXTENSIONS_FLAG -Wno-c99-extensions SANITIZER_COMMON_CFLAGS)
332 append_if(COMPILER_RT_HAS_WNO_NON_VIRTUAL_DTOR_FLAG -Wno-non-virtual-dtor SANITIZER_COMMON_CFLAGS)
333 append_if(COMPILER_RT_HAS_WD4722_FLAG /wd4722 SANITIZER_COMMON_CFLAGS)
336 # Obtain the iOS Simulator SDK path from xcodebuild.
338 COMMAND xcodebuild -version -sdk iphonesimulator Path
339 OUTPUT_VARIABLE IOSSIM_SDK_DIR
340 OUTPUT_STRIP_TRAILING_WHITESPACE
342 string(REGEX MATCH "-mmacosx-version-min="
343 MACOSX_VERSION_MIN_FLAG "${CMAKE_CXX_FLAGS}")
344 set(SANITIZER_COMMON_SUPPORTED_DARWIN_OS osx)
345 if (IOSSIM_SDK_DIR AND NOT MACOSX_VERSION_MIN_FLAG)
346 list(APPEND SANITIZER_COMMON_SUPPORTED_DARWIN_OS iossim)
349 if(COMPILER_RT_USES_LIBCXX)
350 set(SANITIZER_MIN_OSX_VERSION 10.7)
352 set(SANITIZER_MIN_OSX_VERSION 10.6)
354 set(DARWIN_osx_CFLAGS -mmacosx-version-min=${SANITIZER_MIN_OSX_VERSION})
355 set(DARWIN_iossim_CFLAGS
356 -mios-simulator-version-min=7.0 -isysroot ${IOSSIM_SDK_DIR})
357 set(DARWIN_osx_LINKFLAGS)
358 set(DARWIN_iossim_LINKFLAGS
359 -Wl,-ios_simulator_version_min,7.0.0
360 -mios-simulator-version-min=7.0
361 -isysroot ${IOSSIM_SDK_DIR})
364 # Architectures supported by Sanitizer runtimes. Specific sanitizers may
365 # support only subset of these (e.g. TSan works on x86_64 only).
366 filter_available_targets(SANITIZER_COMMON_SUPPORTED_ARCH
367 x86_64 i386 powerpc64 arm aarch64 mips)
368 filter_available_targets(ASAN_SUPPORTED_ARCH x86_64 i386 powerpc64 arm mips)
369 filter_available_targets(DFSAN_SUPPORTED_ARCH x86_64)
370 filter_available_targets(LSAN_SUPPORTED_ARCH x86_64)
371 filter_available_targets(MSAN_SUPPORTED_ARCH x86_64)
372 filter_available_targets(PROFILE_SUPPORTED_ARCH x86_64 i386 arm aarch64)
373 filter_available_targets(TSAN_SUPPORTED_ARCH x86_64)
374 filter_available_targets(UBSAN_SUPPORTED_ARCH x86_64 i386 arm aarch64)
376 add_subdirectory(include)
378 set(COMPILER_RT_LIBCXX_PATH ${LLVM_MAIN_SRC_DIR}/projects/libcxx)
379 if(EXISTS ${COMPILER_RT_LIBCXX_PATH}/)
380 set(COMPILER_RT_HAS_LIBCXX_SOURCES TRUE)
382 set(COMPILER_RT_HAS_LIBCXX_SOURCES FALSE)
385 add_subdirectory(lib)
387 if(COMPILER_RT_INCLUDE_TESTS)
388 add_subdirectory(unittests)
390 add_subdirectory(test)