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)
64 set(COMPILER_RT_TEST_COMPILER_EXE "-o")
65 set(COMPILER_RT_TEST_COMPILER_OBJ "-o")
67 set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl.exe)
68 set(COMPILER_RT_TEST_COMPILER_EXE "-Fe")
69 set(COMPILER_RT_TEST_COMPILER_OBJ "-Fo")
72 # Take output dir and install path from the user.
73 set(COMPILER_RT_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH
74 "Path where built compiler-rt libraries should be stored.")
75 set(COMPILER_RT_EXEC_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/bin CACHE PATH
76 "Path where built compiler-rt executables should be stored.")
77 set(COMPILER_RT_INSTALL_PATH ${CMAKE_INSTALL_PREFIX} CACHE PATH
78 "Path where built compiler-rt libraries should be installed.")
79 option(COMPILER_RT_INCLUDE_TESTS "Generate and build compiler-rt unit tests." OFF)
80 option(COMPILER_RT_ENABLE_WERROR "Fail and stop if warning is triggered" OFF)
81 # Use a host compiler to compile/link tests.
82 set(COMPILER_RT_TEST_COMPILER ${CMAKE_C_COMPILER} CACHE PATH "Compiler to use for testing")
83 set(COMPILER_RT_TEST_COMPILER_EXE "-o")
84 set(COMPILER_RT_TEST_COMPILER_OBJ "-o")
86 if (NOT LLVM_CONFIG_PATH)
87 find_program(LLVM_CONFIG_PATH "llvm-config"
88 DOC "Path to llvm-config binary")
89 if (NOT LLVM_CONFIG_PATH)
90 message(FATAL_ERROR "llvm-config not found: specify LLVM_CONFIG_PATH")
94 COMMAND ${LLVM_CONFIG_PATH} "--obj-root" "--bindir" "--libdir" "--src-root"
95 RESULT_VARIABLE HAD_ERROR
96 OUTPUT_VARIABLE CONFIG_OUTPUT)
98 message(FATAL_ERROR "llvm-config failed with status ${HAD_ERROR}")
100 string(REGEX REPLACE "[ \t]*[\r\n]+[ \t]*" ";" CONFIG_OUTPUT ${CONFIG_OUTPUT})
101 list(GET CONFIG_OUTPUT 0 LLVM_BINARY_DIR)
102 list(GET CONFIG_OUTPUT 1 LLVM_TOOLS_BINARY_DIR)
103 list(GET CONFIG_OUTPUT 2 LLVM_LIBRARY_DIR)
104 list(GET CONFIG_OUTPUT 3 LLVM_MAIN_SRC_DIR)
106 # Make use of LLVM CMake modules.
107 file(TO_CMAKE_PATH ${LLVM_BINARY_DIR} LLVM_BINARY_DIR_CMAKE_STYLE)
108 set(LLVM_CMAKE_PATH "${LLVM_BINARY_DIR_CMAKE_STYLE}/share/llvm/cmake")
109 list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_PATH}")
110 # Get some LLVM variables from LLVMConfig.
111 include("${LLVM_CMAKE_PATH}/LLVMConfig.cmake")
113 set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib)
115 # Find Python interpreter.
116 set(Python_ADDITIONAL_VERSIONS 2.7 2.6 2.5)
117 include(FindPythonInterp)
118 if(NOT PYTHONINTERP_FOUND)
119 message(FATAL_ERROR "
120 Unable to find Python interpreter required testing. Please install Python
121 or specify the PYTHON_EXECUTABLE CMake variable.")
124 # Define default arguments to lit.
125 set(LIT_ARGS_DEFAULT "-sv")
127 set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
129 set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
132 if("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang[+]*$")
133 set(COMPILER_RT_TEST_COMPILER_ID Clang)
134 elseif("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang-cl.exe$")
135 set(COMPILER_RT_TEST_COMPILER_ID Clang)
137 set(COMPILER_RT_TEST_COMPILER_ID GNU)
140 string(TOLOWER ${CMAKE_SYSTEM_NAME} COMPILER_RT_OS_DIR)
141 set(COMPILER_RT_LIBRARY_OUTPUT_DIR
142 ${COMPILER_RT_OUTPUT_DIR}/lib/${COMPILER_RT_OS_DIR})
143 set(COMPILER_RT_LIBRARY_INSTALL_DIR
144 ${COMPILER_RT_INSTALL_PATH}/lib/${COMPILER_RT_OS_DIR})
146 # Add path for custom compiler-rt modules.
147 set(CMAKE_MODULE_PATH
148 "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
149 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
152 include(CompilerRTUtils)
154 set(COMPILER_RT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
155 set(COMPILER_RT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
156 # Setup custom SDK sysroots.
157 set(COMPILER_RT_DARWIN_SDK_SYSROOT ${COMPILER_RT_SOURCE_DIR}/SDKs/darwin)
158 set(COMPILER_RT_LINUX_SDK_SYSROOT ${COMPILER_RT_SOURCE_DIR}/SDKs/linux)
160 set(COMPILER_RT_EXTRA_ANDROID_HEADERS ${COMPILER_RT_SOURCE_DIR}/android/include)
162 # Detect whether the current target platform is 32-bit or 64-bit, and setup
163 # the correct commandline flags needed to attempt to target 32-bit and 64-bit.
164 if (NOT CMAKE_SIZEOF_VOID_P EQUAL 4 AND
165 NOT CMAKE_SIZEOF_VOID_P EQUAL 8)
166 message(FATAL_ERROR "Please use architecture with 4 or 8 byte pointers.")
169 set(TARGET_64_BIT_CFLAGS "-m64")
170 set(TARGET_32_BIT_CFLAGS "-m32")
172 set(TARGET_64_BIT_CFLAGS "")
173 set(TARGET_32_BIT_CFLAGS "")
176 # List of architectures we can target.
177 set(COMPILER_RT_SUPPORTED_ARCH)
179 function(get_target_flags_for_arch arch out_var)
180 list(FIND COMPILER_RT_SUPPORTED_ARCH ${arch} ARCH_INDEX)
181 if(ARCH_INDEX EQUAL -1)
182 message(FATAL_ERROR "Unsupported architecture: ${arch}")
184 set(${out_var} ${TARGET_${arch}_CFLAGS} PARENT_SCOPE)
188 # Try to compile a very simple source file to ensure we can target the given
189 # platform. We use the results of these tests to build only the various target
190 # runtime libraries supported by our current compilers cross-compiling
192 set(SIMPLE_SOURCE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/simple.cc)
193 file(WRITE ${SIMPLE_SOURCE} "#include <stdlib.h>\n#include <limits>\nint main() {}\n")
195 # test_target_arch(<arch> <target flags...>)
196 # Sets the target flags for a given architecture and determines if this
197 # architecture is supported by trying to build a simple file.
198 macro(test_target_arch arch)
199 set(TARGET_${arch}_CFLAGS ${ARGN})
200 try_compile(CAN_TARGET_${arch} ${CMAKE_BINARY_DIR} ${SIMPLE_SOURCE}
201 COMPILE_DEFINITIONS "${TARGET_${arch}_CFLAGS}"
202 CMAKE_FLAGS "-DCMAKE_EXE_LINKER_FLAGS:STRING=${TARGET_${arch}_CFLAGS}")
203 if(${CAN_TARGET_${arch}})
204 list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
208 if(ANDROID_COMMON_FLAGS)
209 test_target_arch(arm_android "${ANDROID_COMMON_FLAGS}")
211 if("${LLVM_NATIVE_ARCH}" STREQUAL "X86")
213 test_target_arch(x86_64 ${TARGET_64_BIT_CFLAGS})
215 test_target_arch(i386 ${TARGET_32_BIT_CFLAGS})
216 elseif("${LLVM_NATIVE_ARCH}" STREQUAL "PowerPC")
217 test_target_arch(powerpc64 ${TARGET_64_BIT_CFLAGS})
218 elseif("${LLVM_NATIVE_ARCH}" STREQUAL "ARM")
219 test_target_arch(arm "")
223 # We support running instrumented tests when we're not cross compiling
224 # and target a UNIX-like system or Windows.
225 # We can run tests on Android even when we are cross-compiling.
226 if(("${CMAKE_HOST_SYSTEM}" STREQUAL "${CMAKE_SYSTEM}" AND (UNIX OR MSVC)) OR ANDROID
227 OR COMPILER_RT_EMULATOR)
228 option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" ON)
230 option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" OFF)
233 # Check if compiler-rt is built with libc++.
234 find_flag_in_string("${CMAKE_CXX_FLAGS}" "-stdlib=libc++"
235 COMPILER_RT_USES_LIBCXX)
237 function(filter_available_targets out_var)
239 foreach(arch ${ARGN})
240 list(FIND COMPILER_RT_SUPPORTED_ARCH ${arch} ARCH_INDEX)
241 if(NOT (ARCH_INDEX EQUAL -1) AND CAN_TARGET_${arch})
242 list(APPEND archs ${arch})
245 set(${out_var} ${archs} PARENT_SCOPE)
248 option(COMPILER_RT_DEBUG "Build runtimes with full debug info" OFF)
249 # COMPILER_RT_DEBUG_PYBOOL is used by lit.common.configured.in.
250 pythonize_bool(COMPILER_RT_DEBUG)
252 option(COMPILER_RT_BUILD_SHARED_ASAN "Build shared version of AddressSanitizer runtime" OFF)
254 #================================
255 # Setup Compiler Flags
256 #================================
260 append_string_if(COMPILER_RT_HAS_W3_FLAG /W3 CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
262 append_string_if(COMPILER_RT_HAS_WALL_FLAG -Wall CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
264 if(COMPILER_RT_ENABLE_WERROR)
265 append_string_if(COMPILER_RT_HAS_WERROR_FLAG -Werror CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
266 append_string_if(COMPILER_RT_HAS_WX_FLAG /WX CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
269 append_string_if(COMPILER_RT_HAS_STD_CXX11_FLAG -std=c++11 CMAKE_CXX_FLAGS)
271 # Emulate C99 and C++11's __func__ for MSVC prior to 2013 CTP.
272 if(NOT COMPILER_RT_HAS_FUNC_SYMBOL)
273 add_definitions(-D__func__=__FUNCTION__)
276 # Provide some common commmandline flags for Sanitizer runtimes.
277 append_if(COMPILER_RT_HAS_FPIC_FLAG -fPIC SANITIZER_COMMON_CFLAGS)
278 append_if(COMPILER_RT_HAS_FNO_BUILTIN_FLAG -fno-builtin SANITIZER_COMMON_CFLAGS)
279 append_if(COMPILER_RT_HAS_FNO_EXCEPTIONS_FLAG -fno-exceptions SANITIZER_COMMON_CFLAGS)
280 append_if(COMPILER_RT_HAS_FOMIT_FRAME_POINTER_FLAG -fomit-frame-pointer SANITIZER_COMMON_CFLAGS)
281 append_if(COMPILER_RT_HAS_FUNWIND_TABLES_FLAG -funwind-tables SANITIZER_COMMON_CFLAGS)
282 append_if(COMPILER_RT_HAS_FNO_STACK_PROTECTOR_FLAG -fno-stack-protector SANITIZER_COMMON_CFLAGS)
283 append_if(COMPILER_RT_HAS_FVISIBILITY_HIDDEN_FLAG -fvisibility=hidden SANITIZER_COMMON_CFLAGS)
284 append_if(COMPILER_RT_HAS_FNO_FUNCTION_SECTIONS_FLAG -fno-function-sections SANITIZER_COMMON_CFLAGS)
287 # Remove /MD flag so that it doesn't conflict with /MT.
288 if(COMPILER_RT_HAS_MT_FLAG)
289 string(REGEX REPLACE "(^| ) */MDd? *( |$)" "\\1 \\2" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
290 list(APPEND SANITIZER_COMMON_CFLAGS /MT)
292 append_if(COMPILER_RT_HAS_Oy_FLAG /Oy- SANITIZER_COMMON_CFLAGS)
293 append_if(COMPILER_RT_HAS_GS_FLAG /GS- SANITIZER_COMMON_CFLAGS)
296 # Build with optimization, unless we're in debug mode. If we're using MSVC,
297 # always respect the optimization flags set by CMAKE_BUILD_TYPE instead.
298 if(NOT COMPILER_RT_DEBUG AND NOT MSVC)
299 list(APPEND SANITIZER_COMMON_CFLAGS -O3)
302 # Build sanitizer runtimes with debug info.
303 if(COMPILER_RT_HAS_GLINE_TABLES_ONLY_FLAG)
304 list(APPEND SANITIZER_COMMON_CFLAGS -gline-tables-only)
305 elseif(COMPILER_RT_HAS_G_FLAG)
306 list(APPEND SANITIZER_COMMON_CFLAGS -g)
307 elseif(COMPILER_RT_HAS_Zi_FLAG)
308 list(APPEND SANITIZER_COMMON_CFLAGS /Zi)
311 # Turn off several warnings.
312 append_if(COMPILER_RT_HAS_WNO_GNU_FLAG -Wno-gnu SANITIZER_COMMON_CFLAGS)
313 append_if(COMPILER_RT_HAS_WNO_VARIADIC_MACROS_FLAG -Wno-variadic-macros SANITIZER_COMMON_CFLAGS)
314 append_if(COMPILER_RT_HAS_WNO_C99_EXTENSIONS_FLAG -Wno-c99-extensions SANITIZER_COMMON_CFLAGS)
315 append_if(COMPILER_RT_HAS_WNO_NON_VIRTUAL_DTOR_FLAG -Wno-non-virtual-dtor SANITIZER_COMMON_CFLAGS)
316 append_if(COMPILER_RT_HAS_WD4722_FLAG /wd4722 SANITIZER_COMMON_CFLAGS)
319 # Obtain the iOS Simulator SDK path from xcodebuild.
321 COMMAND xcodebuild -version -sdk iphonesimulator Path
322 OUTPUT_VARIABLE IOSSIM_SDK_DIR
323 OUTPUT_STRIP_TRAILING_WHITESPACE
325 string(REGEX MATCH "-mmacosx-version-min="
326 MACOSX_VERSION_MIN_FLAG "${CMAKE_CXX_FLAGS}")
327 set(SANITIZER_COMMON_SUPPORTED_DARWIN_OS osx)
328 if (IOSSIM_SDK_DIR AND NOT MACOSX_VERSION_MIN_FLAG)
329 list(APPEND SANITIZER_COMMON_SUPPORTED_DARWIN_OS iossim)
332 if(COMPILER_RT_USES_LIBCXX)
333 set(SANITIZER_MIN_OSX_VERSION 10.7)
335 set(SANITIZER_MIN_OSX_VERSION 10.6)
337 set(DARWIN_osx_CFLAGS -mmacosx-version-min=${SANITIZER_MIN_OSX_VERSION})
338 set(DARWIN_iossim_CFLAGS
339 -mios-simulator-version-min=7.0 -isysroot ${IOSSIM_SDK_DIR})
340 set(DARWIN_osx_LINKFLAGS)
341 set(DARWIN_iossim_LINKFLAGS
342 -Wl,-ios_simulator_version_min,7.0.0
343 -mios-simulator-version-min=7.0
344 -isysroot ${IOSSIM_SDK_DIR})
347 # Architectures supported by Sanitizer runtimes. Specific sanitizers may
348 # support only subset of these (e.g. TSan works on x86_64 only).
349 filter_available_targets(SANITIZER_COMMON_SUPPORTED_ARCH
350 x86_64 i386 powerpc64 arm)
351 filter_available_targets(ASAN_SUPPORTED_ARCH x86_64 i386 powerpc64)
352 filter_available_targets(DFSAN_SUPPORTED_ARCH x86_64)
353 filter_available_targets(LSAN_SUPPORTED_ARCH x86_64)
354 filter_available_targets(MSAN_SUPPORTED_ARCH x86_64)
355 filter_available_targets(PROFILE_SUPPORTED_ARCH x86_64 i386 arm)
356 filter_available_targets(TSAN_SUPPORTED_ARCH x86_64)
357 filter_available_targets(UBSAN_SUPPORTED_ARCH x86_64 i386)
359 add_subdirectory(include)
361 set(COMPILER_RT_LIBCXX_PATH ${LLVM_MAIN_SRC_DIR}/projects/libcxx)
362 if(EXISTS ${COMPILER_RT_LIBCXX_PATH}/)
363 set(COMPILER_RT_HAS_LIBCXX_SOURCES TRUE)
365 set(COMPILER_RT_HAS_LIBCXX_SOURCES FALSE)
368 add_subdirectory(lib)
370 if(COMPILER_RT_INCLUDE_TESTS)
371 add_subdirectory(unittests)
373 add_subdirectory(test)