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)
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 Studion 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
46if (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
51         ${PACKAGE_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.
62  if(NOT MSVC)
63    set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang)
64  else()
65    set(COMPILER_RT_TEST_COMPILER ${LLVM_RUNTIME_OUTPUT_INTDIR}/clang.exe)
66  endif()
67else()
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")
79
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")
85    endif()
86  endif()
87  execute_process(
88    COMMAND ${LLVM_CONFIG_PATH} "--obj-root" "--bindir" "--libdir" "--src-root"
89    RESULT_VARIABLE HAD_ERROR
90    OUTPUT_VARIABLE CONFIG_OUTPUT)
91  if (HAD_ERROR)
92    message(FATAL_ERROR "llvm-config failed with status ${HAD_ERROR}")
93  endif()
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)
99
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")
106
107  set(LLVM_LIBRARY_OUTPUT_INTDIR
108    ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib${LLVM_LIBDIR_SUFFIX})
109
110  # Find Python interpreter.
111  set(Python_ADDITIONAL_VERSIONS 2.7 2.6 2.5)
112  include(FindPythonInterp)
113  if(NOT PYTHONINTERP_FOUND)
114    message(FATAL_ERROR "
115      Unable to find Python interpreter required testing. Please install Python
116      or specify the PYTHON_EXECUTABLE CMake variable.")
117  endif()
118
119  # Define default arguments to lit.
120  set(LIT_ARGS_DEFAULT "-sv")
121  if (MSVC OR XCODE)
122    set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
123  endif()
124  set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
125endif()
126
127if("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang[+]*$")
128  set(COMPILER_RT_TEST_COMPILER_ID Clang)
129elseif("${COMPILER_RT_TEST_COMPILER}" MATCHES "clang.*.exe$")
130  set(COMPILER_RT_TEST_COMPILER_ID Clang)
131else()
132  set(COMPILER_RT_TEST_COMPILER_ID GNU)
133endif()
134
135# Tests using XFAIL use the first value in COMPILER_RT_TEST_TARGET_TRIPLE
136set(COMPILER_RT_TEST_TARGET_TRIPLE ${TARGET_TRIPLE} CACHE STRING
137    "Default triple for cross-compiled executables")
138string(REPLACE "-" ";" TARGET_TRIPLE_LIST ${COMPILER_RT_TEST_TARGET_TRIPLE})
139list(GET TARGET_TRIPLE_LIST 0 COMPILER_RT_TEST_TARGET_ARCH)
140list(GET TARGET_TRIPLE_LIST 1 COMPILER_RT_TEST_TARGET_OS)
141list(GET TARGET_TRIPLE_LIST 2 COMPILER_RT_TEST_TARGET_ABI)
142
143if ("${COMPILER_RT_TEST_TARGET_ABI}" STREQUAL "androideabi")
144  set(ANDROID 1)
145endif()
146
147string(TOLOWER ${CMAKE_SYSTEM_NAME} COMPILER_RT_OS_DIR)
148set(COMPILER_RT_LIBRARY_OUTPUT_DIR
149  ${COMPILER_RT_OUTPUT_DIR}/lib/${COMPILER_RT_OS_DIR})
150set(COMPILER_RT_LIBRARY_INSTALL_DIR
151  ${COMPILER_RT_INSTALL_PATH}/lib/${COMPILER_RT_OS_DIR})
152
153# Add path for custom compiler-rt modules.
154set(CMAKE_MODULE_PATH
155  "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
156  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
157  ${CMAKE_MODULE_PATH}
158  )
159include(CompilerRTUtils)
160
161set(COMPILER_RT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
162set(COMPILER_RT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
163
164# We support running instrumented tests when we're not cross compiling
165# and target a UNIX-like system or Windows.
166# We can run tests on Android even when we are cross-compiling.
167if(("${CMAKE_HOST_SYSTEM}" STREQUAL "${CMAKE_SYSTEM}" AND (UNIX OR MSVC)) OR ANDROID
168   OR COMPILER_RT_EMULATOR)
169  option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" ON)
170else()
171  option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" OFF)
172endif()
173
174option(COMPILER_RT_DEBUG "Build runtimes with full debug info" OFF)
175# COMPILER_RT_DEBUG_PYBOOL is used by lit.common.configured.in.
176pythonize_bool(COMPILER_RT_DEBUG)
177
178#================================
179# Setup Compiler Flags
180#================================
181include(CheckIncludeFile)
182check_include_file(unwind.h HAVE_UNWIND_H)
183
184include(config-ix)
185
186if(MSVC)
187  append_string_if(COMPILER_RT_HAS_W3_FLAG /W3 CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
188else()
189  append_string_if(COMPILER_RT_HAS_WALL_FLAG -Wall CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
190endif()
191if(COMPILER_RT_ENABLE_WERROR)
192  append_string_if(COMPILER_RT_HAS_WERROR_FLAG -Werror CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
193  append_string_if(COMPILER_RT_HAS_WX_FLAG /WX CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
194endif()
195
196append_string_if(COMPILER_RT_HAS_STD_CXX11_FLAG -std=c++11 CMAKE_CXX_FLAGS)
197
198# Emulate C99 and C++11's __func__ for MSVC prior to 2013 CTP.
199if(NOT COMPILER_RT_HAS_FUNC_SYMBOL)
200  add_definitions(-D__func__=__FUNCTION__)
201endif()
202
203# Provide some common commmandline flags for Sanitizer runtimes.
204append_list_if(COMPILER_RT_HAS_FPIC_FLAG -fPIC SANITIZER_COMMON_CFLAGS)
205append_list_if(COMPILER_RT_HAS_FNO_BUILTIN_FLAG -fno-builtin SANITIZER_COMMON_CFLAGS)
206append_list_if(COMPILER_RT_HAS_FNO_EXCEPTIONS_FLAG -fno-exceptions SANITIZER_COMMON_CFLAGS)
207append_list_if(COMPILER_RT_HAS_FOMIT_FRAME_POINTER_FLAG -fomit-frame-pointer SANITIZER_COMMON_CFLAGS)
208append_list_if(COMPILER_RT_HAS_FUNWIND_TABLES_FLAG -funwind-tables SANITIZER_COMMON_CFLAGS)
209append_list_if(COMPILER_RT_HAS_FNO_STACK_PROTECTOR_FLAG -fno-stack-protector SANITIZER_COMMON_CFLAGS)
210append_list_if(COMPILER_RT_HAS_FVISIBILITY_HIDDEN_FLAG -fvisibility=hidden SANITIZER_COMMON_CFLAGS)
211append_list_if(COMPILER_RT_HAS_FNO_FUNCTION_SECTIONS_FLAG -fno-function-sections SANITIZER_COMMON_CFLAGS)
212append_list_if(COMPILER_RT_HAS_FNO_LTO_FLAG -fno-lto SANITIZER_COMMON_CFLAGS)
213
214if(MSVC)
215  # Replace the /MD[d] flags with /MT.
216  # FIXME: In fact, sanitizers should support both /MT and /MD, see PR20214.
217  if(COMPILER_RT_HAS_MT_FLAG)
218    foreach(flag_var
219      CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE
220      CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_RELWITHDEBINFO)
221      if(${flag_var} MATCHES "/MD")
222        string(REGEX REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
223      elseif(${flag_var} MATCHES "/MDd")
224        string(REGEX REPLACE "/MDd" "/MT" ${flag_var} "${${flag_var}}")
225      endif()
226    endforeach()
227  endif()
228  append_list_if(COMPILER_RT_HAS_Oy_FLAG /Oy- SANITIZER_COMMON_CFLAGS)
229  append_list_if(COMPILER_RT_HAS_GS_FLAG /GS- SANITIZER_COMMON_CFLAGS)
230endif()
231
232append_list_if(COMPILER_RT_DEBUG -DSANITIZER_DEBUG=1 SANITIZER_COMMON_CFLAGS)
233
234# Build with optimization, unless we're in debug mode. If we're using MSVC,
235# always respect the optimization flags set by CMAKE_BUILD_TYPE instead.
236if(NOT COMPILER_RT_DEBUG AND NOT MSVC)
237  list(APPEND SANITIZER_COMMON_CFLAGS -O3)
238endif()
239
240# Determine if we should restrict stack frame sizes.
241# Stack frames on PowerPC and Mips and in debug biuld can be much larger than
242# anticipated.
243# FIXME: Fix all sanitizers and add -Wframe-larger-than to
244# SANITIZER_COMMON_FLAGS
245if(COMPILER_RT_HAS_WFRAME_LARGER_THAN_FLAG AND NOT COMPILER_RT_DEBUG
246   AND NOT ${LLVM_NATIVE_ARCH} STREQUAL "PowerPC"
247   AND NOT ${LLVM_NATIVE_ARCH} STREQUAL "Mips")
248  set(SANITIZER_LIMIT_FRAME_SIZE TRUE)
249else()
250  set(SANITIZER_LIMIT_FRAME_SIZE FALSE)
251endif()
252
253# Build sanitizer runtimes with debug info.
254if(COMPILER_RT_HAS_GLINE_TABLES_ONLY_FLAG AND NOT COMPILER_RT_DEBUG)
255  list(APPEND SANITIZER_COMMON_CFLAGS -gline-tables-only)
256elseif(COMPILER_RT_HAS_G_FLAG)
257  list(APPEND SANITIZER_COMMON_CFLAGS -g)
258elseif(COMPILER_RT_HAS_Zi_FLAG)
259  list(APPEND SANITIZER_COMMON_CFLAGS /Zi)
260endif()
261
262# Turn off several warnings.
263append_list_if(COMPILER_RT_HAS_WGNU_FLAG -Wno-gnu SANITIZER_COMMON_CFLAGS)
264append_list_if(COMPILER_RT_HAS_WVARIADIC_MACROS_FLAG -Wno-variadic-macros SANITIZER_COMMON_CFLAGS)
265append_list_if(COMPILER_RT_HAS_WC99_EXTENSIONS_FLAG -Wno-c99-extensions SANITIZER_COMMON_CFLAGS)
266append_list_if(COMPILER_RT_HAS_WNON_VIRTUAL_DTOR_FLAG -Wno-non-virtual-dtor SANITIZER_COMMON_CFLAGS)
267append_list_if(COMPILER_RT_HAS_WD4146_FLAG /wd4146 SANITIZER_COMMON_CFLAGS)
268append_list_if(COMPILER_RT_HAS_WD4291_FLAG /wd4291 SANITIZER_COMMON_CFLAGS)
269append_list_if(COMPILER_RT_HAS_WD4391_FLAG /wd4391 SANITIZER_COMMON_CFLAGS)
270append_list_if(COMPILER_RT_HAS_WD4722_FLAG /wd4722 SANITIZER_COMMON_CFLAGS)
271append_list_if(COMPILER_RT_HAS_WD4800_FLAG /wd4800 SANITIZER_COMMON_CFLAGS)
272if(APPLE)
273  macro(find_darwin_sdk_dir var sdk_name)
274    # Let's first try the internal SDK, otherwise use the public SDK.
275    execute_process(
276      COMMAND xcodebuild -version -sdk ${sdk_name}.internal Path
277      OUTPUT_VARIABLE ${var}
278      OUTPUT_STRIP_TRAILING_WHITESPACE
279      ERROR_FILE /dev/null
280    )
281    if(${var} STREQUAL "")
282      execute_process(
283        COMMAND xcodebuild -version -sdk ${sdk_name} Path
284        OUTPUT_VARIABLE ${var}
285        OUTPUT_STRIP_TRAILING_WHITESPACE
286        ERROR_FILE /dev/null
287      )
288    endif()
289  endmacro()
290
291  find_darwin_sdk_dir(OSX_SDK_DIR macosx)
292  find_darwin_sdk_dir(IOSSIM_SDK_DIR iphonesimulator)
293
294  string(REGEX MATCH "-mmacosx-version-min="
295         MACOSX_VERSION_MIN_FLAG "${CMAKE_CXX_FLAGS}")
296  set(SANITIZER_COMMON_SUPPORTED_DARWIN_OS osx)
297  if (IOSSIM_SDK_DIR AND NOT MACOSX_VERSION_MIN_FLAG)
298    list(APPEND SANITIZER_COMMON_SUPPORTED_DARWIN_OS iossim)
299  endif()
300
301  set(SANITIZER_MIN_OSX_VERSION 10.7)
302  set(CMAKE_OSX_DEPLOYMENT_TARGET "") # We're setting the flag manually below.
303  set(DARWIN_osx_CFLAGS -mmacosx-version-min=${SANITIZER_MIN_OSX_VERSION}
304    -stdlib=libc++)
305  set(DARWIN_iossim_CFLAGS
306    -stdlib=libc++
307    -mios-simulator-version-min=7.0 -isysroot ${IOSSIM_SDK_DIR})
308  set(DARWIN_osx_LINKFLAGS -mmacosx-version-min=${SANITIZER_MIN_OSX_VERSION}
309    -stdlib=libc++ -lc++ -lc++abi)
310  set(DARWIN_iossim_LINKFLAGS
311    -stdlib=libc++ -lc++ -lc++abi
312    -Wl,-ios_simulator_version_min,7.0.0
313    -mios-simulator-version-min=7.0
314    -isysroot ${IOSSIM_SDK_DIR})
315
316  if(OSX_SDK_DIR)
317    list(APPEND DARWIN_osx_CFLAGS -isysroot ${OSX_SDK_DIR})
318    list(APPEND DARWIN_osx_LINKFLAGS -isysroot ${OSX_SDK_DIR})
319  endif()
320endif()
321
322add_subdirectory(include)
323
324set(COMPILER_RT_LIBCXX_PATH ${LLVM_MAIN_SRC_DIR}/projects/libcxx)
325if(EXISTS ${COMPILER_RT_LIBCXX_PATH}/)
326  set(COMPILER_RT_HAS_LIBCXX_SOURCES TRUE)
327else()
328  set(COMPILER_RT_HAS_LIBCXX_SOURCES FALSE)
329endif()
330
331add_subdirectory(lib)
332
333if(COMPILER_RT_INCLUDE_TESTS)
334  add_subdirectory(unittests)
335endif()
336add_subdirectory(test)
337