1# CMake build for CompilerRT.
2#
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.
6#
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.
9
10# Check if compiler-rt is built as a standalone project.
11if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
12  project(CompilerRT C CXX ASM)
13  set(COMPILER_RT_STANDALONE_BUILD TRUE)
14else()
15  set(COMPILER_RT_STANDALONE_BUILD FALSE)
16endif()
17
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
21# runtime libraries.
22if (NOT MSVC)
23  cmake_minimum_required(VERSION 2.8.8)
24else()
25  # Version 2.8.12.1 is required to build with Visual Studio 2013.
26  cmake_minimum_required(VERSION 2.8.12.1)
27endif()
28
29# FIXME: It may be removed when we use 2.8.12.
30if(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)
34else()
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)
38  if(POLICY CMP0022)
39    cmake_policy(SET CMP0022 NEW) # automatic when 2.8.12 is required
40  endif()
41endif()
42
43# Top level target used to build all compiler-rt libraries.
44add_custom_target(compiler-rt ALL)
45
46option(COMPILER_RT_BUILD_BUILTINS "Build builtins" ON)
47mark_as_advanced(COMPILER_RT_BUILD_BUILTINS)
48option(COMPILER_RT_BUILD_SANITIZERS "Build sanitizers" ON)
49mark_as_advanced(COMPILER_RT_BUILD_SANITIZERS)
50
51if (NOT COMPILER_RT_STANDALONE_BUILD)
52  # Compute the Clang version from the LLVM version.
53  # FIXME: We should be able to reuse CLANG_VERSION variable calculated
54  #        in Clang cmake files, instead of copying the rules here.
55  string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" CLANG_VERSION
56         ${PACKAGE_VERSION})
57  # Setup the paths where compiler-rt runtimes and headers should be stored.
58  set(COMPILER_RT_OUTPUT_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR}/clang/${CLANG_VERSION})
59  set(COMPILER_RT_EXEC_OUTPUT_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
60  set(COMPILER_RT_INSTALL_PATH lib${LLVM_LIBDIR_SUFFIX}/clang/${CLANG_VERSION})
61  option(COMPILER_RT_INCLUDE_TESTS "Generate and build compiler-rt unit tests."
62         ${LLVM_INCLUDE_TESTS})
63 option(COMPILER_RT_ENABLE_WERROR "Fail and stop if warning is triggered"
64        ${LLVM_ENABLE_WERROR})
65  # Use just-built Clang to compile/link tests on all platforms, except for
66  # Windows where we need to use clang-cl instead.
67  if(NOT MSVC)
68    set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang)
69  else()
70    set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang.exe)
71  endif()
72else()
73  # Take output dir and install path from the user.
74  set(COMPILER_RT_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH
75    "Path where built compiler-rt libraries should be stored.")
76  set(COMPILER_RT_EXEC_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/bin CACHE PATH
77    "Path where built compiler-rt executables should be stored.")
78  set(COMPILER_RT_INSTALL_PATH ${CMAKE_INSTALL_PREFIX} CACHE PATH
79    "Path where built compiler-rt libraries should be installed.")
80  option(COMPILER_RT_INCLUDE_TESTS "Generate and build compiler-rt unit tests." OFF)
81  option(COMPILER_RT_ENABLE_WERROR "Fail and stop if warning is triggered" OFF)
82  # Use a host compiler to compile/link tests.
83  set(COMPILER_RT_TEST_COMPILER ${CMAKE_C_COMPILER} CACHE PATH "Compiler to use for testing")
84
85  if (NOT LLVM_CONFIG_PATH)
86    find_program(LLVM_CONFIG_PATH "llvm-config"
87                 DOC "Path to llvm-config binary")
88    if (NOT LLVM_CONFIG_PATH)
89      message(FATAL_ERROR "llvm-config not found: specify LLVM_CONFIG_PATH")
90    endif()
91  endif()
92  execute_process(
93    COMMAND ${LLVM_CONFIG_PATH} "--obj-root" "--bindir" "--libdir" "--src-root"
94    RESULT_VARIABLE HAD_ERROR
95    OUTPUT_VARIABLE CONFIG_OUTPUT)
96  if (HAD_ERROR)
97    message(FATAL_ERROR "llvm-config failed with status ${HAD_ERROR}")
98  endif()
99  string(REGEX REPLACE "[ \t]*[\r\n]+[ \t]*" ";" CONFIG_OUTPUT ${CONFIG_OUTPUT})
100  list(GET CONFIG_OUTPUT 0 LLVM_BINARY_DIR)
101  list(GET CONFIG_OUTPUT 1 LLVM_TOOLS_BINARY_DIR)
102  list(GET CONFIG_OUTPUT 2 LLVM_LIBRARY_DIR)
103  list(GET CONFIG_OUTPUT 3 LLVM_MAIN_SRC_DIR)
104
105  # Make use of LLVM CMake modules.
106  file(TO_CMAKE_PATH ${LLVM_BINARY_DIR} LLVM_BINARY_DIR_CMAKE_STYLE)
107  set(LLVM_CMAKE_PATH "${LLVM_BINARY_DIR_CMAKE_STYLE}/share/llvm/cmake")
108  list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_PATH}")
109  # Get some LLVM variables from LLVMConfig.
110  include("${LLVM_CMAKE_PATH}/LLVMConfig.cmake")
111
112  set(LLVM_LIBRARY_OUTPUT_INTDIR
113    ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib${LLVM_LIBDIR_SUFFIX})
114
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.")
122  endif()
123
124  # Define default arguments to lit.
125  set(LIT_ARGS_DEFAULT "-sv")
126  if (MSVC OR XCODE)
127    set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
128  endif()
129  set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
130endif()
131
132if("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang[+]*$")
133  set(COMPILER_RT_TEST_COMPILER_ID Clang)
134elseif("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang.*.exe$")
135  set(COMPILER_RT_TEST_COMPILER_ID Clang)
136else()
137  set(COMPILER_RT_TEST_COMPILER_ID GNU)
138endif()
139
140set(COMPILER_RT_DEFAULT_TARGET_TRIPLE ${TARGET_TRIPLE} CACHE STRING
141    "Default triple for which compiler-rt runtimes will be built.")
142if(DEFINED COMPILER_RT_TEST_TARGET_TRIPLE)
143  # Backwards compatibility: this variable used to be called
144  # COMPILER_RT_TEST_TARGET_TRIPLE.
145  set(COMPILER_RT_DEFAULT_TARGET_TRIPLE ${COMPILER_RT_TEST_TARGET_TRIPLE})
146endif()
147
148string(REPLACE "-" ";" TARGET_TRIPLE_LIST ${COMPILER_RT_DEFAULT_TARGET_TRIPLE})
149list(GET TARGET_TRIPLE_LIST 0 COMPILER_RT_DEFAULT_TARGET_ARCH)
150list(GET TARGET_TRIPLE_LIST 1 COMPILER_RT_DEFAULT_TARGET_OS)
151list(GET TARGET_TRIPLE_LIST 2 COMPILER_RT_DEFAULT_TARGET_ABI)
152# Determine if test target triple is specified explicitly, and doesn't match the
153# default.
154if(NOT COMPILER_RT_DEFAULT_TARGET_TRIPLE STREQUAL TARGET_TRIPLE)
155  set(COMPILER_RT_HAS_EXPLICIT_DEFAULT_TARGET_TRIPLE TRUE)
156else()
157  set(COMPILER_RT_HAS_EXPLICIT_DEFAULT_TARGET_TRIPLE FALSE)
158endif()
159
160if ("${COMPILER_RT_DEFAULT_TARGET_ABI}" STREQUAL "androideabi")
161  set(ANDROID 1)
162endif()
163
164string(TOLOWER ${CMAKE_SYSTEM_NAME} COMPILER_RT_OS_DIR)
165set(COMPILER_RT_LIBRARY_OUTPUT_DIR
166  ${COMPILER_RT_OUTPUT_DIR}/lib/${COMPILER_RT_OS_DIR})
167set(COMPILER_RT_LIBRARY_INSTALL_DIR
168  ${COMPILER_RT_INSTALL_PATH}/lib/${COMPILER_RT_OS_DIR})
169
170# Add path for custom compiler-rt modules.
171set(CMAKE_MODULE_PATH
172  "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
173  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
174  ${CMAKE_MODULE_PATH}
175  )
176include(CompilerRTUtils)
177
178set(COMPILER_RT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
179set(COMPILER_RT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
180
181# We support running instrumented tests when we're not cross compiling
182# and target a UNIX-like system or Windows.
183# We can run tests on Android even when we are cross-compiling.
184if(("${CMAKE_HOST_SYSTEM}" STREQUAL "${CMAKE_SYSTEM}" AND (UNIX OR WIN32)) OR ANDROID
185   OR COMPILER_RT_EMULATOR)
186  option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" ON)
187else()
188  option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" OFF)
189endif()
190
191option(COMPILER_RT_DEBUG "Build runtimes with full debug info" OFF)
192option(COMPILER_RT_EXTERNALIZE_DEBUGINFO
193  "Generate dSYM files and strip executables and libraries (Darwin Only)" OFF)
194# COMPILER_RT_DEBUG_PYBOOL is used by lit.common.configured.in.
195pythonize_bool(COMPILER_RT_DEBUG)
196
197#================================
198# Setup Compiler Flags
199#================================
200include(CheckIncludeFile)
201check_include_file(unwind.h HAVE_UNWIND_H)
202
203include(config-ix)
204
205if(MSVC)
206  append_string_if(COMPILER_RT_HAS_W3_FLAG /W3 CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
207else()
208  append_string_if(COMPILER_RT_HAS_WALL_FLAG -Wall CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
209endif()
210if(COMPILER_RT_ENABLE_WERROR)
211  append_string_if(COMPILER_RT_HAS_WERROR_FLAG -Werror CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
212  append_string_if(COMPILER_RT_HAS_WX_FLAG /WX CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
213endif()
214
215append_string_if(COMPILER_RT_HAS_STD_CXX11_FLAG -std=c++11 CMAKE_CXX_FLAGS)
216
217# Emulate C99 and C++11's __func__ for MSVC prior to 2013 CTP.
218if(NOT COMPILER_RT_HAS_FUNC_SYMBOL)
219  add_definitions(-D__func__=__FUNCTION__)
220endif()
221
222# Provide some common commmandline flags for Sanitizer runtimes.
223append_list_if(COMPILER_RT_HAS_FPIC_FLAG -fPIC SANITIZER_COMMON_CFLAGS)
224append_list_if(COMPILER_RT_HAS_FNO_BUILTIN_FLAG -fno-builtin SANITIZER_COMMON_CFLAGS)
225append_list_if(COMPILER_RT_HAS_FNO_EXCEPTIONS_FLAG -fno-exceptions SANITIZER_COMMON_CFLAGS)
226append_list_if(COMPILER_RT_HAS_FOMIT_FRAME_POINTER_FLAG -fomit-frame-pointer SANITIZER_COMMON_CFLAGS)
227append_list_if(COMPILER_RT_HAS_FUNWIND_TABLES_FLAG -funwind-tables SANITIZER_COMMON_CFLAGS)
228append_list_if(COMPILER_RT_HAS_FNO_STACK_PROTECTOR_FLAG -fno-stack-protector SANITIZER_COMMON_CFLAGS)
229append_list_if(COMPILER_RT_HAS_FNO_SANITIZE_SAFE_STACK_FLAG -fno-sanitize=safe-stack SANITIZER_COMMON_CFLAGS)
230append_list_if(COMPILER_RT_HAS_FVISIBILITY_HIDDEN_FLAG -fvisibility=hidden SANITIZER_COMMON_CFLAGS)
231append_list_if(COMPILER_RT_HAS_FVISIBILITY_INLINES_HIDDEN_FLAG -fvisibility-inlines-hidden SANITIZER_COMMON_CFLAGS)
232append_list_if(COMPILER_RT_HAS_FNO_FUNCTION_SECTIONS_FLAG -fno-function-sections SANITIZER_COMMON_CFLAGS)
233append_list_if(COMPILER_RT_HAS_FNO_LTO_FLAG -fno-lto SANITIZER_COMMON_CFLAGS)
234
235if(MSVC)
236  # Replace the /M[DT][d] flags with /MT, and strip any definitions of _DEBUG,
237  # which cause definition mismatches at link time.
238  # FIXME: In fact, sanitizers should support both /MT and /MD, see PR20214.
239  if(COMPILER_RT_HAS_MT_FLAG)
240    foreach(flag_var
241      CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE
242      CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_RELWITHDEBINFO)
243      string(REGEX REPLACE "/M[DT]d" "/MT" ${flag_var} "${${flag_var}}")
244      string(REGEX REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
245      string(REGEX REPLACE "/D_DEBUG" "" ${flag_var} "${${flag_var}}")
246    endforeach()
247  endif()
248  append_list_if(COMPILER_RT_HAS_Oy_FLAG /Oy- SANITIZER_COMMON_CFLAGS)
249  append_list_if(COMPILER_RT_HAS_GS_FLAG /GS- SANITIZER_COMMON_CFLAGS)
250endif()
251
252append_list_if(COMPILER_RT_DEBUG -DSANITIZER_DEBUG=1 SANITIZER_COMMON_CFLAGS)
253
254# Build with optimization, unless we're in debug mode. If we're using MSVC,
255# always respect the optimization flags set by CMAKE_BUILD_TYPE instead.
256if(NOT COMPILER_RT_DEBUG AND NOT MSVC)
257  list(APPEND SANITIZER_COMMON_CFLAGS -O3)
258endif()
259
260# Determine if we should restrict stack frame sizes.
261# Stack frames on PowerPC and Mips and in debug biuld can be much larger than
262# anticipated.
263# FIXME: Fix all sanitizers and add -Wframe-larger-than to
264# SANITIZER_COMMON_FLAGS
265if(COMPILER_RT_HAS_WFRAME_LARGER_THAN_FLAG AND NOT COMPILER_RT_DEBUG
266   AND NOT ${COMPILER_RT_DEFAULT_TARGET_ARCH} MATCHES "powerpc|mips")
267  set(SANITIZER_LIMIT_FRAME_SIZE TRUE)
268else()
269  set(SANITIZER_LIMIT_FRAME_SIZE FALSE)
270endif()
271
272# Build sanitizer runtimes with debug info.
273if(COMPILER_RT_HAS_GLINE_TABLES_ONLY_FLAG AND NOT COMPILER_RT_DEBUG)
274  list(APPEND SANITIZER_COMMON_CFLAGS -gline-tables-only)
275elseif(COMPILER_RT_HAS_G_FLAG)
276  list(APPEND SANITIZER_COMMON_CFLAGS -g)
277elseif(COMPILER_RT_HAS_Zi_FLAG)
278  list(APPEND SANITIZER_COMMON_CFLAGS /Zi)
279endif()
280
281# Turn off several warnings.
282append_list_if(COMPILER_RT_HAS_WGNU_FLAG -Wno-gnu SANITIZER_COMMON_CFLAGS)
283append_list_if(COMPILER_RT_HAS_WVARIADIC_MACROS_FLAG -Wno-variadic-macros SANITIZER_COMMON_CFLAGS)
284append_list_if(COMPILER_RT_HAS_WC99_EXTENSIONS_FLAG -Wno-c99-extensions SANITIZER_COMMON_CFLAGS)
285append_list_if(COMPILER_RT_HAS_WNON_VIRTUAL_DTOR_FLAG -Wno-non-virtual-dtor SANITIZER_COMMON_CFLAGS)
286append_list_if(COMPILER_RT_HAS_WD4146_FLAG /wd4146 SANITIZER_COMMON_CFLAGS)
287append_list_if(COMPILER_RT_HAS_WD4291_FLAG /wd4291 SANITIZER_COMMON_CFLAGS)
288append_list_if(COMPILER_RT_HAS_WD4391_FLAG /wd4391 SANITIZER_COMMON_CFLAGS)
289append_list_if(COMPILER_RT_HAS_WD4722_FLAG /wd4722 SANITIZER_COMMON_CFLAGS)
290append_list_if(COMPILER_RT_HAS_WD4800_FLAG /wd4800 SANITIZER_COMMON_CFLAGS)
291
292if(APPLE AND SANITIZER_MIN_OSX_VERSION VERSION_LESS "10.9")
293  # Mac OS X prior to 10.9 had problems with exporting symbols from
294  # libc++/libc++abi.
295  set(SANITIZER_CAN_USE_CXXABI FALSE)
296else()
297  set(SANITIZER_CAN_USE_CXXABI TRUE)
298endif()
299pythonize_bool(SANITIZER_CAN_USE_CXXABI)
300
301add_subdirectory(include)
302
303set(COMPILER_RT_LIBCXX_PATH ${LLVM_MAIN_SRC_DIR}/projects/libcxx)
304if(EXISTS ${COMPILER_RT_LIBCXX_PATH}/)
305  set(COMPILER_RT_HAS_LIBCXX_SOURCES TRUE)
306else()
307  set(COMPILER_RT_HAS_LIBCXX_SOURCES FALSE)
308endif()
309
310set(COMPILER_RT_LLD_PATH ${LLVM_MAIN_SRC_DIR}/tools/lld)
311if(EXISTS ${COMPILER_RT_LLD_PATH}/)
312  set(COMPILER_RT_HAS_LLD_SOURCES TRUE)
313else()
314  set(COMPILER_RT_HAS_LLD_SOURCES FALSE)
315endif()
316pythonize_bool(COMPILER_RT_HAS_LLD_SOURCES)
317
318add_subdirectory(lib)
319
320if(COMPILER_RT_INCLUDE_TESTS)
321  add_subdirectory(unittests)
322  add_subdirectory(test)
323endif()
324