1 # See docs/CMake.html for instructions about how to build LLVM with CMake.
3 cmake_minimum_required(VERSION 3.4.3)
6 cmake_policy(SET CMP0022 NEW) # automatic when 2.8.12 is required
10 # CMake 3.1 and higher include generator expressions of the form
11 # $<TARGETLIB:obj> in the SOURCES property. These need to be
12 # stripped everywhere that access the SOURCES property, so we just
13 # defer to the OLD behavior of not including generator expressions
14 # in the output for now.
15 cmake_policy(SET CMP0051 OLD)
19 cmake_policy(SET CMP0057 NEW)
22 if(NOT DEFINED LLVM_VERSION_MAJOR)
23 set(LLVM_VERSION_MAJOR 5)
25 if(NOT DEFINED LLVM_VERSION_MINOR)
26 set(LLVM_VERSION_MINOR 0)
28 if(NOT DEFINED LLVM_VERSION_PATCH)
29 set(LLVM_VERSION_PATCH 0)
31 if(NOT DEFINED LLVM_VERSION_SUFFIX)
32 set(LLVM_VERSION_SUFFIX svn)
36 cmake_policy(SET CMP0048 NEW)
37 set(cmake_3_0_PROJ_VERSION
38 VERSION ${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}.${LLVM_VERSION_PATCH})
39 set(cmake_3_0_LANGUAGES LANGUAGES)
42 if (NOT PACKAGE_VERSION)
44 "${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}.${LLVM_VERSION_PATCH}${LLVM_VERSION_SUFFIX}")
48 ${cmake_3_0_PROJ_VERSION}
49 ${cmake_3_0_LANGUAGES}
52 if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
53 message(STATUS "No build type selected, default to Debug")
54 set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build type (default Debug)" FORCE)
57 # This should only apply if you are both on an Apple host, and targeting Apple.
58 if(CMAKE_HOST_APPLE AND APPLE)
59 # if CMAKE_LIBTOOL is not set, try and find it with xcrun or find_program
62 find_program(CMAKE_XCRUN NAMES xcrun)
65 execute_process(COMMAND ${CMAKE_XCRUN} -find libtool
66 OUTPUT_VARIABLE CMAKE_LIBTOOL
67 OUTPUT_STRIP_TRAILING_WHITESPACE)
70 if(NOT CMAKE_LIBTOOL OR NOT EXISTS CMAKE_LIBTOOL)
71 find_program(CMAKE_LIBTOOL NAMES libtool)
75 get_property(languages GLOBAL PROPERTY ENABLED_LANGUAGES)
77 set(CMAKE_LIBTOOL ${CMAKE_LIBTOOL} CACHE PATH "libtool executable")
78 message(STATUS "Found libtool - ${CMAKE_LIBTOOL}")
80 execute_process(COMMAND ${CMAKE_LIBTOOL} -V
81 OUTPUT_VARIABLE LIBTOOL_V_OUTPUT
82 OUTPUT_STRIP_TRAILING_WHITESPACE)
83 if("${LIBTOOL_V_OUTPUT}" MATCHES ".*cctools-([0-9.]+).*")
84 string(REGEX REPLACE ".*cctools-([0-9.]+).*" "\\1" LIBTOOL_VERSION
86 if(NOT LIBTOOL_VERSION VERSION_LESS "862")
87 set(LIBTOOL_NO_WARNING_FLAG "-no_warning_for_no_symbols")
91 foreach(lang ${languages})
92 set(CMAKE_${lang}_CREATE_STATIC_LIBRARY
93 "${CMAKE_LIBTOOL} -static ${LIBTOOL_NO_WARNING_FLAG} -o <TARGET> \
94 <LINK_FLAGS> <OBJECTS> ")
98 # If DYLD_LIBRARY_PATH is set we need to set it on archiver commands
100 set(dyld_envar "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}")
101 foreach(lang ${languages})
102 foreach(cmd ${CMAKE_${lang}_CREATE_STATIC_LIBRARY})
103 list(APPEND CMAKE_${lang}_CREATE_STATIC_LIBRARY_NEW
104 "${dyld_envar} ${cmd}")
106 set(CMAKE_${lang}_CREATE_STATIC_LIBRARY
107 ${CMAKE_${lang}_CREATE_STATIC_LIBRARY_NEW})
112 # Side-by-side subprojects layout: automatically set the
113 # LLVM_EXTERNAL_${project}_SOURCE_DIR using LLVM_ALL_PROJECTS
114 # This allows an easy way of setting up a build directory for llvm and another
115 # one for llvm+clang+... using the same sources.
116 set(LLVM_ALL_PROJECTS "clang;libcxx;libcxxabi;lldb;compiler-rt;lld;polly")
117 set(LLVM_ENABLE_PROJECTS "" CACHE STRING
118 "Semicolon-separated list of projects to build (${LLVM_ALL_PROJECTS}), or \"all\".")
119 if( LLVM_ENABLE_PROJECTS STREQUAL "all" )
120 set( LLVM_ENABLE_PROJECTS ${LLVM_ALL_PROJECTS})
122 foreach(proj ${LLVM_ENABLE_PROJECTS})
123 set(PROJ_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../${proj}")
124 if(NOT EXISTS "${PROJ_DIR}" OR NOT IS_DIRECTORY "${PROJ_DIR}")
125 message(FATAL_ERROR "LLVM_ENABLE_PROJECTS requests ${proj} but directory not found: ${PROJ_DIR}")
127 string(TOUPPER "${proj}" upper_proj)
128 STRING(REGEX REPLACE "-" "_" upper_proj ${upper_proj})
129 set(LLVM_EXTERNAL_${upper_proj}_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../${proj}")
130 # There is a widely spread opinion that clang-tools-extra should be merged
131 # into clang. The following simulates it by always enabling clang-tools-extra
132 # when enabling clang.
133 if (proj STREQUAL "clang")
134 set(LLVM_EXTERNAL_CLANG_TOOLS_EXTRA_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../clang-tools-extra")
138 # Build llvm with ccache if the package is present
139 set(LLVM_CCACHE_BUILD OFF CACHE BOOL "Set to ON for a ccache enabled build")
140 if(LLVM_CCACHE_BUILD)
141 find_program(CCACHE_PROGRAM ccache)
143 set(LLVM_CCACHE_SIZE "" CACHE STRING "Size of ccache")
144 set(LLVM_CCACHE_DIR "" CACHE STRING "Directory to keep ccached data")
145 set(CCACHE_PROGRAM "CCACHE_CPP2=yes CCACHE_HASHDIR=yes ${CCACHE_PROGRAM}")
146 if (LLVM_CCACHE_SIZE)
147 set(CCACHE_PROGRAM "CCACHE_SIZE=${LLVM_CCACHE_SIZE} ${CCACHE_PROGRAM}")
150 set(CCACHE_PROGRAM "CCACHE_DIR=${LLVM_CCACHE_DIR} ${CCACHE_PROGRAM}")
152 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_PROGRAM})
154 message(FATAL_ERROR "Unable to find the program ccache. Set LLVM_CCACHE_BUILD to OFF")
158 option(LLVM_DEPENDENCY_DEBUGGING "Dependency debugging mode to verify correctly expressed library dependencies (Darwin only)" OFF)
160 # Some features of the LLVM build may be disallowed when dependency debugging is
161 # enabled. In particular you cannot use ccache because we want to force compile
162 # operations to always happen.
163 if(LLVM_DEPENDENCY_DEBUGGING)
164 if(NOT CMAKE_HOST_APPLE)
165 message(FATAL_ERROR "Dependency debugging is only currently supported on Darwin hosts.")
167 if(LLVM_CCACHE_BUILD)
168 message(FATAL_ERROR "Cannot enable dependency debugging while using ccache.")
172 option(LLVM_BUILD_GLOBAL_ISEL "Experimental: Build GlobalISel" ON)
173 if(LLVM_BUILD_GLOBAL_ISEL)
174 add_definitions(-DLLVM_BUILD_GLOBAL_ISEL)
177 option(LLVM_ENABLE_DAGISEL_COV "Debug: Prints tablegen patterns that were used for selecting" OFF)
179 # Add path for custom modules
180 set(CMAKE_MODULE_PATH
182 "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
183 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules"
186 # Generate a CompilationDatabase (compile_commands.json file) for our build,
187 # for use by clang_complete, YouCompleteMe, etc.
188 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
190 option(LLVM_INSTALL_UTILS "Include utility binaries in the 'install' target." OFF)
192 option(LLVM_INSTALL_TOOLCHAIN_ONLY "Only include toolchain files in the 'install' target." OFF)
194 option(LLVM_USE_FOLDERS "Enable solution folders in Visual Studio. Disable for Express versions." ON)
195 if ( LLVM_USE_FOLDERS )
196 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
199 include(VersionFromVCS)
201 option(LLVM_APPEND_VC_REV
202 "Append the version control system revision id to LLVM version" OFF)
204 if( LLVM_APPEND_VC_REV )
205 add_version_info_from_vcs(PACKAGE_VERSION)
208 set(PACKAGE_NAME LLVM)
209 set(PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}")
210 set(PACKAGE_BUGREPORT "http://llvm.org/bugs/")
212 set(BUG_REPORT_URL "${PACKAGE_BUGREPORT}" CACHE STRING
213 "Default URL where bug reports are to be submitted.")
216 set(CPACK_PACKAGE_INSTALL_DIRECTORY "LLVM")
217 set(CPACK_PACKAGE_VENDOR "LLVM")
218 set(CPACK_PACKAGE_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
219 set(CPACK_PACKAGE_VERSION_MINOR ${LLVM_VERSION_MINOR})
220 set(CPACK_PACKAGE_VERSION_PATCH ${LLVM_VERSION_PATCH})
221 set(CPACK_PACKAGE_VERSION ${PACKAGE_VERSION})
222 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.TXT")
223 set(CPACK_NSIS_COMPRESSOR "/SOLID lzma \r\n SetCompressorDictSize 32")
224 if(WIN32 AND NOT UNIX)
225 set(CPACK_PACKAGE_INSTALL_REGISTRY_KEY "LLVM")
226 set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_logo.bmp")
227 set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_icon.ico")
228 set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_icon.ico")
229 set(CPACK_NSIS_MODIFY_PATH "ON")
230 set(CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL "ON")
231 set(CPACK_NSIS_EXTRA_INSTALL_COMMANDS
232 "ExecWait '$INSTDIR/tools/msbuild/install.bat'")
233 set(CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
234 "ExecWait '$INSTDIR/tools/msbuild/uninstall.bat'")
236 set(CPACK_NSIS_INSTALL_ROOT "$PROGRAMFILES64")
241 # Sanity check our source directory to make sure that we are not trying to
242 # generate an in-tree build (unless on MSVC_IDE, where it is ok), and to make
243 # sure that we don't have any stray generated files lying around in the tree
244 # (which would end up getting picked up by header search, instead of the correct
246 if( CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR AND NOT MSVC_IDE )
247 message(FATAL_ERROR "In-source builds are not allowed.
248 CMake would overwrite the makefiles distributed with LLVM.
249 Please create a directory and run cmake from there, passing the path
250 to this source directory as the last argument.
251 This process created the file `CMakeCache.txt' and the directory `CMakeFiles'.
252 Please delete them.")
254 if( NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR )
256 tablegenned_files_on_include_dir
257 "${CMAKE_CURRENT_SOURCE_DIR}/include/llvm/*.gen")
259 tablegenned_files_on_lib_dir
260 "${CMAKE_CURRENT_SOURCE_DIR}/lib/Target/*.inc")
261 if( tablegenned_files_on_include_dir OR tablegenned_files_on_lib_dir)
262 message(FATAL_ERROR "Apparently there is a previous in-source build,
263 probably as the result of running `configure' and `make' on
264 ${CMAKE_CURRENT_SOURCE_DIR}.
265 This may cause problems. The suspicious files are:
266 ${tablegenned_files_on_lib_dir}
267 ${tablegenned_files_on_include_dir}
268 Please clean the source directory.")
272 string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE)
274 if (CMAKE_BUILD_TYPE AND
275 NOT uppercase_CMAKE_BUILD_TYPE MATCHES "^(DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL)$")
276 message(FATAL_ERROR "Invalid value for CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
279 set(LLVM_LIBDIR_SUFFIX "" CACHE STRING "Define suffix of library directory name (32/64)" )
281 set(LLVM_TOOLS_INSTALL_DIR "bin" CACHE STRING "Path for binary subdirectory (defaults to 'bin')")
282 mark_as_advanced(LLVM_TOOLS_INSTALL_DIR)
284 # They are used as destination of target generators.
285 set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin)
286 set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib${LLVM_LIBDIR_SUFFIX})
288 # DLL platform -- put DLLs into bin.
289 set(LLVM_SHLIB_OUTPUT_INTDIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
291 set(LLVM_SHLIB_OUTPUT_INTDIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
294 # Each of them corresponds to llvm-config's.
295 set(LLVM_TOOLS_BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR}) # --bindir
296 set(LLVM_LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR}) # --libdir
297 set(LLVM_MAIN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR} ) # --src-root
298 set(LLVM_MAIN_INCLUDE_DIR ${LLVM_MAIN_SRC_DIR}/include ) # --includedir
299 set(LLVM_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR} ) # --prefix
301 # Note: LLVM_CMAKE_PATH does not include generated files
302 set(LLVM_CMAKE_PATH ${LLVM_MAIN_SRC_DIR}/cmake/modules)
303 set(LLVM_EXAMPLES_BINARY_DIR ${LLVM_BINARY_DIR}/examples)
304 set(LLVM_INCLUDE_DIR ${CMAKE_CURRENT_BINARY_DIR}/include)
324 # List of targets with JIT support:
325 set(LLVM_TARGETS_WITH_JIT X86 PowerPC AArch64 ARM Mips SystemZ)
327 set(LLVM_TARGETS_TO_BUILD "all"
328 CACHE STRING "Semicolon-separated list of targets to build, or \"all\".")
330 set(LLVM_EXPERIMENTAL_TARGETS_TO_BUILD ""
331 CACHE STRING "Semicolon-separated list of experimental targets to build.")
333 option(BUILD_SHARED_LIBS
334 "Build all libraries as shared libraries instead of static" OFF)
336 option(LLVM_ENABLE_BACKTRACES "Enable embedding backtraces on crash." ON)
337 if(LLVM_ENABLE_BACKTRACES)
338 set(ENABLE_BACKTRACES 1)
341 option(LLVM_ENABLE_CRASH_OVERRIDES "Enable crash overrides." ON)
342 if(LLVM_ENABLE_CRASH_OVERRIDES)
343 set(ENABLE_CRASH_OVERRIDES 1)
346 option(LLVM_ENABLE_FFI "Use libffi to call external functions from the interpreter" OFF)
347 set(FFI_LIBRARY_DIR "" CACHE PATH "Additional directory, where CMake should search for libffi.so")
348 set(FFI_INCLUDE_DIR "" CACHE PATH "Additional directory, where CMake should search for ffi.h or ffi/ffi.h")
350 set(LLVM_TARGET_ARCH "host"
351 CACHE STRING "Set target to use for LLVM JIT or use \"host\" for automatic detection.")
353 option(LLVM_ENABLE_TERMINFO "Use terminfo database if available." ON)
355 option(LLVM_ENABLE_LIBEDIT "Use libedit if available." ON)
357 option(LLVM_ENABLE_THREADS "Use threads if available." ON)
359 option(LLVM_ENABLE_ZLIB "Use zlib for compression/decompression if available." ON)
361 if( LLVM_TARGETS_TO_BUILD STREQUAL "all" )
362 set( LLVM_TARGETS_TO_BUILD ${LLVM_ALL_TARGETS} )
365 set(LLVM_TARGETS_TO_BUILD
366 ${LLVM_TARGETS_TO_BUILD}
367 ${LLVM_EXPERIMENTAL_TARGETS_TO_BUILD})
368 list(REMOVE_DUPLICATES LLVM_TARGETS_TO_BUILD)
370 include(AddLLVMDefinitions)
372 option(LLVM_ENABLE_PIC "Build Position-Independent Code" ON)
373 option(LLVM_ENABLE_WARNINGS "Enable compiler warnings." ON)
374 option(LLVM_ENABLE_MODULES "Compile with C++ modules enabled." OFF)
375 if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
376 option(LLVM_ENABLE_MODULE_DEBUGGING "Compile with -gmodules." ON)
377 option(LLVM_ENABLE_LOCAL_SUBMODULE_VISIBILITY "Compile with -fmodules-local-submodule-visibility." OFF)
379 option(LLVM_ENABLE_MODULE_DEBUGGING "Compile with -gmodules." OFF)
380 option(LLVM_ENABLE_LOCAL_SUBMODULE_VISIBILITY "Compile with -fmodules-local-submodule-visibility." ON)
382 option(LLVM_ENABLE_CXX1Y "Compile with C++1y enabled." OFF)
383 option(LLVM_ENABLE_LIBCXX "Use libc++ if available." OFF)
384 option(LLVM_ENABLE_LLD "Use lld as C and C++ linker." OFF)
385 option(LLVM_ENABLE_PEDANTIC "Compile with pedantic enabled." ON)
386 option(LLVM_ENABLE_WERROR "Fail and stop if a warning is triggered." OFF)
388 if( NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" )
389 option(LLVM_ENABLE_ASSERTIONS "Enable assertions" OFF)
391 option(LLVM_ENABLE_ASSERTIONS "Enable assertions" ON)
394 option(LLVM_ENABLE_EXPENSIVE_CHECKS "Enable expensive checks" OFF)
396 set(LLVM_ABI_BREAKING_CHECKS "WITH_ASSERTS" CACHE STRING
397 "Enable abi-breaking checks. Can be WITH_ASSERTS, FORCE_ON or FORCE_OFF.")
399 option(LLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING
400 "Disable abi-breaking checks mismatch detection at link-tim." OFF)
402 option(LLVM_FORCE_USE_OLD_HOST_TOOLCHAIN
403 "Set to ON to force using an old, unsupported host toolchain." OFF)
405 option(LLVM_USE_INTEL_JITEVENTS
406 "Use Intel JIT API to inform Intel(R) VTune(TM) Amplifier XE 2011 about JIT code"
409 if( LLVM_USE_INTEL_JITEVENTS )
410 # Verify we are on a supported platform
411 if( NOT CMAKE_SYSTEM_NAME MATCHES "Windows" AND NOT CMAKE_SYSTEM_NAME MATCHES "Linux" )
413 "Intel JIT API support is available on Linux and Windows only.")
415 endif( LLVM_USE_INTEL_JITEVENTS )
417 option(LLVM_USE_OPROFILE
418 "Use opagent JIT interface to inform OProfile about JIT code" OFF)
420 option(LLVM_EXTERNALIZE_DEBUGINFO
421 "Generate dSYM files and strip executables and libraries (Darwin Only)" OFF)
423 # If enabled, verify we are on a platform that supports oprofile.
424 if( LLVM_USE_OPROFILE )
425 if( NOT CMAKE_SYSTEM_NAME MATCHES "Linux" )
426 message(FATAL_ERROR "OProfile support is available on Linux only.")
427 endif( NOT CMAKE_SYSTEM_NAME MATCHES "Linux" )
428 endif( LLVM_USE_OPROFILE )
430 set(LLVM_USE_SANITIZER "" CACHE STRING
431 "Define the sanitizer used to build binaries and tests.")
433 option(LLVM_USE_SPLIT_DWARF
434 "Use -gsplit-dwarf when compiling llvm." OFF)
436 option(LLVM_POLLY_LINK_INTO_TOOLS "Statically link Polly into tools (if available)" ON)
437 option(LLVM_POLLY_BUILD "Build LLVM with Polly" ON)
439 if (EXISTS ${LLVM_MAIN_SRC_DIR}/tools/polly/CMakeLists.txt)
440 set(POLLY_IN_TREE TRUE)
441 elseif(LLVM_EXTERNAL_POLLY_SOURCE_DIR)
442 set(POLLY_IN_TREE TRUE)
444 set(POLLY_IN_TREE FALSE)
447 if (LLVM_POLLY_BUILD AND POLLY_IN_TREE)
453 if (LLVM_POLLY_LINK_INTO_TOOLS AND WITH_POLLY)
454 set(LINK_POLLY_INTO_TOOLS ON)
456 set(LINK_POLLY_INTO_TOOLS OFF)
459 # Define an option controlling whether we should build for 32-bit on 64-bit
460 # platforms, where supported.
461 if( CMAKE_SIZEOF_VOID_P EQUAL 8 AND NOT WIN32 )
462 # TODO: support other platforms and toolchains.
463 option(LLVM_BUILD_32_BITS "Build 32 bits executables and libraries." OFF)
466 # Define the default arguments to use with 'lit', and an option for the user to
468 set(LIT_ARGS_DEFAULT "-sv")
469 if (MSVC_IDE OR XCODE)
470 set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
472 set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
474 # On Win32 hosts, provide an option to specify the path to the GnuWin32 tools.
475 if( WIN32 AND NOT CYGWIN )
476 set(LLVM_LIT_TOOLS_DIR "" CACHE PATH "Path to GnuWin32 tools")
479 # Define options to control the inclusion and default build behavior for
480 # components which may not strictly be necessary (tools, examples, and tests).
482 # This is primarily to support building smaller or faster project files.
483 option(LLVM_INCLUDE_TOOLS "Generate build targets for the LLVM tools." ON)
484 option(LLVM_BUILD_TOOLS
485 "Build the LLVM tools. If OFF, just generate build targets." ON)
487 option(LLVM_INCLUDE_UTILS "Generate build targets for the LLVM utils." ON)
488 option(LLVM_BUILD_UTILS
489 "Build LLVM utility binaries. If OFF, just generate build targets." ON)
491 option(LLVM_BUILD_RUNTIME
492 "Build the LLVM runtime libraries." ON)
493 option(LLVM_BUILD_EXAMPLES
494 "Build the LLVM example programs. If OFF, just generate build targets." OFF)
495 option(LLVM_INCLUDE_EXAMPLES "Generate build targets for the LLVM examples" ON)
497 option(LLVM_BUILD_TESTS
498 "Build LLVM unit tests. If OFF, just generate build targets." OFF)
499 option(LLVM_INCLUDE_TESTS "Generate build targets for the LLVM unit tests." ON)
500 option(LLVM_INCLUDE_GO_TESTS "Include the Go bindings tests in test build targets." ON)
502 option (LLVM_BUILD_DOCS "Build the llvm documentation." OFF)
503 option (LLVM_INCLUDE_DOCS "Generate build targets for llvm documentation." ON)
504 option (LLVM_ENABLE_DOXYGEN "Use doxygen to generate llvm API documentation." OFF)
505 option (LLVM_ENABLE_SPHINX "Use Sphinx to generate llvm documentation." OFF)
506 option (LLVM_ENABLE_OCAMLDOC "Build OCaml bindings documentation." ON)
508 set(LLVM_INSTALL_DOXYGEN_HTML_DIR "share/doc/llvm/doxygen-html"
509 CACHE STRING "Doxygen-generated HTML documentation install directory")
510 set(LLVM_INSTALL_OCAMLDOC_HTML_DIR "share/doc/llvm/ocaml-html"
511 CACHE STRING "OCamldoc-generated HTML documentation install directory")
513 option (LLVM_BUILD_EXTERNAL_COMPILER_RT
514 "Build compiler-rt as an external project." OFF)
516 # You can configure which libraries from LLVM you want to include in the
517 # shared library by setting LLVM_DYLIB_COMPONENTS to a semi-colon delimited
518 # list of LLVM components. All component names handled by llvm-config are valid.
519 if(NOT DEFINED LLVM_DYLIB_COMPONENTS)
520 set(LLVM_DYLIB_COMPONENTS "all" CACHE STRING
521 "Semicolon-separated list of components to include in libLLVM, or \"all\".")
523 option(LLVM_LINK_LLVM_DYLIB "Link tools against the libllvm dynamic library" OFF)
524 option(LLVM_BUILD_LLVM_C_DYLIB "Build libllvm-c re-export library (Darwin Only)" OFF)
525 set(LLVM_BUILD_LLVM_DYLIB_default OFF)
526 if(LLVM_LINK_LLVM_DYLIB OR LLVM_BUILD_LLVM_C_DYLIB)
527 set(LLVM_BUILD_LLVM_DYLIB_default ON)
529 option(LLVM_BUILD_LLVM_DYLIB "Build libllvm dynamic library" ${LLVM_BUILD_LLVM_DYLIB_default})
531 option(LLVM_OPTIMIZED_TABLEGEN "Force TableGen to be built with optimization" OFF)
532 if(CMAKE_CROSSCOMPILING OR (LLVM_OPTIMIZED_TABLEGEN AND (LLVM_ENABLE_ASSERTIONS OR CMAKE_CONFIGURATION_TYPES)))
533 set(LLVM_USE_HOST_TOOLS ON)
536 if (MSVC_IDE AND NOT (MSVC_VERSION LESS 1900))
537 option(LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION "Configure project to use Visual Studio native visualizers" TRUE)
539 set(LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION FALSE CACHE INTERNAL "For Visual Studio 2013, manually copy natvis files to Documents\\Visual Studio 2013\\Visualizers" FORCE)
542 if (LLVM_BUILD_INSTRUMENTED OR LLVM_BUILD_INSTRUMENTED_COVERAGE)
543 if(NOT LLVM_PROFILE_MERGE_POOL_SIZE)
544 # A pool size of 1-2 is probably sufficient on a SSD. 3-4 should be fine
545 # for spining disks. Anything higher may only help on slower mediums.
546 set(LLVM_PROFILE_MERGE_POOL_SIZE "4")
548 if(NOT LLVM_PROFILE_FILE_PATTERN)
549 if(NOT LLVM_PROFILE_DATA_DIR)
550 file(TO_NATIVE_PATH "${LLVM_BINARY_DIR}/profiles/%${LLVM_PROFILE_MERGE_POOL_SIZE}m.profraw" LLVM_PROFILE_FILE_PATTERN)
552 file(TO_NATIVE_PATH "${LLVM_PROFILE_DATA_DIR}/%${LLVM_PROFILE_MERGE_POOL_SIZE}m.profraw" LLVM_PROFILE_FILE_PATTERN)
557 if (LLVM_BUILD_STATIC)
558 set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
561 # All options referred to from HandleLLVMOptions have to be specified
562 # BEFORE this include, otherwise options will not be correctly set on
566 string(REPLACE "Native" ${LLVM_NATIVE_ARCH}
567 LLVM_TARGETS_TO_BUILD "${LLVM_TARGETS_TO_BUILD}")
568 list(REMOVE_DUPLICATES LLVM_TARGETS_TO_BUILD)
570 # By default, we target the host, but this can be overridden at CMake
572 set(LLVM_DEFAULT_TARGET_TRIPLE "${LLVM_HOST_TRIPLE}" CACHE STRING
573 "Default target for which LLVM will generate code." )
574 set(TARGET_TRIPLE "${LLVM_DEFAULT_TARGET_TRIPLE}")
575 message(STATUS "LLVM host triple: ${LLVM_HOST_TRIPLE}")
576 message(STATUS "LLVM default target triple: ${LLVM_DEFAULT_TARGET_TRIPLE}")
578 include(HandleLLVMOptions)
580 # Verify that we can find a Python 2 interpreter. Python 3 is unsupported.
581 # FIXME: We should support systems with only Python 3, but that requires work
583 set(Python_ADDITIONAL_VERSIONS 2.7)
584 include(FindPythonInterp)
585 if( NOT PYTHONINTERP_FOUND )
587 "Unable to find Python interpreter, required for builds and testing.
589 Please install Python or specify the PYTHON_EXECUTABLE CMake variable.")
592 if( ${PYTHON_VERSION_STRING} VERSION_LESS 2.7 )
593 message(FATAL_ERROR "Python 2.7 or newer is required")
597 # LLVMBuild Integration
599 # We use llvm-build to generate all the data required by the CMake based
600 # build system in one swoop:
602 # - We generate a file (a CMake fragment) in the object root which contains
603 # all the definitions that are required by CMake.
605 # - We generate the library table used by llvm-config.
607 # - We generate the dependencies for the CMake fragment, so that we will
608 # automatically reconfigure outselves.
610 set(LLVMBUILDTOOL "${LLVM_MAIN_SRC_DIR}/utils/llvm-build/llvm-build")
611 set(LLVMCONFIGLIBRARYDEPENDENCIESINC
612 "${LLVM_BINARY_DIR}/tools/llvm-config/LibraryDependencies.inc")
613 set(LLVMBUILDCMAKEFRAG
614 "${LLVM_BINARY_DIR}/LLVMBuild.cmake")
616 # Create the list of optional components that are enabled
617 if (LLVM_USE_INTEL_JITEVENTS)
618 set(LLVMOPTIONALCOMPONENTS IntelJITEvents)
619 endif (LLVM_USE_INTEL_JITEVENTS)
620 if (LLVM_USE_OPROFILE)
621 set(LLVMOPTIONALCOMPONENTS ${LLVMOPTIONALCOMPONENTS} OProfileJIT)
622 endif (LLVM_USE_OPROFILE)
624 message(STATUS "Constructing LLVMBuild project information")
626 COMMAND ${PYTHON_EXECUTABLE} ${LLVMBUILDTOOL}
627 --native-target "${LLVM_NATIVE_ARCH}"
628 --enable-targets "${LLVM_TARGETS_TO_BUILD}"
629 --enable-optional-components "${LLVMOPTIONALCOMPONENTS}"
630 --write-library-table ${LLVMCONFIGLIBRARYDEPENDENCIESINC}
631 --write-cmake-fragment ${LLVMBUILDCMAKEFRAG}
632 OUTPUT_VARIABLE LLVMBUILDOUTPUT
633 ERROR_VARIABLE LLVMBUILDERRORS
634 OUTPUT_STRIP_TRAILING_WHITESPACE
635 ERROR_STRIP_TRAILING_WHITESPACE
636 RESULT_VARIABLE LLVMBUILDRESULT)
638 # On Win32, CMake doesn't properly handle piping the default output/error
639 # streams into the GUI console. So, we explicitly catch and report them.
640 if( NOT "${LLVMBUILDOUTPUT}" STREQUAL "")
641 message(STATUS "llvm-build output: ${LLVMBUILDOUTPUT}")
643 if( NOT "${LLVMBUILDRESULT}" STREQUAL "0" )
645 "Unexpected failure executing llvm-build: ${LLVMBUILDERRORS}")
648 # Include the generated CMake fragment. This will define properties from the
649 # LLVMBuild files in a format which is easy to consume from CMake, and will add
650 # the dependencies so that CMake will reconfigure properly when the LLVMBuild
652 include(${LLVMBUILDCMAKEFRAG})
656 # Configure all of the various header file fragments LLVM uses which depend on
657 # configuration variables.
658 set(LLVM_ENUM_TARGETS "")
659 set(LLVM_ENUM_ASM_PRINTERS "")
660 set(LLVM_ENUM_ASM_PARSERS "")
661 set(LLVM_ENUM_DISASSEMBLERS "")
662 foreach(t ${LLVM_TARGETS_TO_BUILD})
663 set( td ${LLVM_MAIN_SRC_DIR}/lib/Target/${t} )
665 list(FIND LLVM_ALL_TARGETS ${t} idx)
666 list(FIND LLVM_EXPERIMENTAL_TARGETS_TO_BUILD ${t} idy)
667 if( idx LESS 0 AND idy LESS 0 )
668 message(FATAL_ERROR "The target `${t}' does not exist.
669 It should be one of\n${LLVM_ALL_TARGETS}")
671 set(LLVM_ENUM_TARGETS "${LLVM_ENUM_TARGETS}LLVM_TARGET(${t})\n")
674 file(GLOB asmp_file "${td}/*AsmPrinter.cpp")
676 set(LLVM_ENUM_ASM_PRINTERS
677 "${LLVM_ENUM_ASM_PRINTERS}LLVM_ASM_PRINTER(${t})\n")
679 if( EXISTS ${td}/AsmParser/CMakeLists.txt )
680 set(LLVM_ENUM_ASM_PARSERS
681 "${LLVM_ENUM_ASM_PARSERS}LLVM_ASM_PARSER(${t})\n")
683 if( EXISTS ${td}/Disassembler/CMakeLists.txt )
684 set(LLVM_ENUM_DISASSEMBLERS
685 "${LLVM_ENUM_DISASSEMBLERS}LLVM_DISASSEMBLER(${t})\n")
689 # Produce the target definition files, which provide a way for clients to easily
690 # include various classes of targets.
692 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/AsmPrinters.def.in
693 ${LLVM_INCLUDE_DIR}/llvm/Config/AsmPrinters.def
696 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/AsmParsers.def.in
697 ${LLVM_INCLUDE_DIR}/llvm/Config/AsmParsers.def
700 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/Disassemblers.def.in
701 ${LLVM_INCLUDE_DIR}/llvm/Config/Disassemblers.def
704 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/Targets.def.in
705 ${LLVM_INCLUDE_DIR}/llvm/Config/Targets.def
708 # Configure the three LLVM configuration header files.
710 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/config.h.cmake
711 ${LLVM_INCLUDE_DIR}/llvm/Config/config.h)
713 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/llvm-config.h.cmake
714 ${LLVM_INCLUDE_DIR}/llvm/Config/llvm-config.h)
716 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/abi-breaking.h.cmake
717 ${LLVM_INCLUDE_DIR}/llvm/Config/abi-breaking.h)
719 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Support/DataTypes.h.cmake
720 ${LLVM_INCLUDE_DIR}/llvm/Support/DataTypes.h)
722 # They are not referenced. See set_output_directory().
723 set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/bin )
724 set( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX} )
725 set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX} )
727 if(APPLE AND DARWIN_LTO_LIBRARY)
728 set(CMAKE_EXE_LINKER_FLAGS
729 "${CMAKE_EXE_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
730 set(CMAKE_SHARED_LINKER_FLAGS
731 "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
732 set(CMAKE_MODULE_LINKER_FLAGS
733 "${CMAKE_MODULE_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
736 # Work around a broken bfd ld behavior. When linking a binary with a
737 # foo.so library, it will try to find any library that foo.so uses and
738 # check its symbols. This is wasteful (the check was done when foo.so
739 # was created) and can fail since it is not the dynamic linker and
740 # doesn't know how to handle search paths correctly.
741 if (UNIX AND NOT APPLE AND NOT ${CMAKE_SYSTEM_NAME} MATCHES "SunOS|AIX")
742 set(CMAKE_EXE_LINKER_FLAGS
743 "${CMAKE_EXE_LINKER_FLAGS} -Wl,-allow-shlib-undefined")
746 set(CMAKE_INCLUDE_CURRENT_DIR ON)
748 include_directories( ${LLVM_INCLUDE_DIR} ${LLVM_MAIN_INCLUDE_DIR})
750 # when crosscompiling import the executable targets from a file
751 if(LLVM_USE_HOST_TOOLS)
752 include(CrossCompile)
753 endif(LLVM_USE_HOST_TOOLS)
754 if(LLVM_TARGET_IS_CROSSCOMPILE_HOST)
755 # Dummy use to avoid CMake Wraning: Manually-specified variables were not used
756 # (this is a variable that CrossCompile sets on recursive invocations)
759 if(${CMAKE_SYSTEM_NAME} MATCHES "(FreeBSD|DragonFly)")
760 # On FreeBSD, /usr/local/* is not used by default. In order to build LLVM
761 # with libxml2, iconv.h, etc., we must add /usr/local paths.
762 include_directories("/usr/local/include")
763 link_directories("/usr/local/lib")
764 endif(${CMAKE_SYSTEM_NAME} MATCHES "(FreeBSD|DragonFly)")
766 if( ${CMAKE_SYSTEM_NAME} MATCHES SunOS )
767 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -include llvm/Support/Solaris.h")
768 endif( ${CMAKE_SYSTEM_NAME} MATCHES SunOS )
770 # Make sure we don't get -rdynamic in every binary. For those that need it,
771 # use export_executable_symbols(target).
772 set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "")
774 set(LLVM_PROFDATA_FILE "" CACHE FILEPATH
775 "Profiling data file to use when compiling in order to improve runtime performance.")
777 if(LLVM_PROFDATA_FILE AND EXISTS ${LLVM_PROFDATA_FILE})
778 if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" )
779 add_definitions("-fprofile-instr-use=${LLVM_PROFDATA_FILE}")
781 message(FATAL_ERROR "LLVM_PROFDATA_FILE can only be specified when compiling with clang")
789 # People report that -O3 is unreliable on MinGW. The traditional
790 # build also uses -O2 for that reason:
791 llvm_replace_compiler_option(CMAKE_CXX_FLAGS_RELEASE "-O3" "-O2")
794 # Put this before tblgen. Else we have a circular dependence.
795 add_subdirectory(lib/Demangle)
796 add_subdirectory(lib/Support)
797 add_subdirectory(lib/TableGen)
799 add_subdirectory(utils/TableGen)
801 # Force target to be built as soon as possible. Clang modules builds depend
802 # header-wise on it as they ship all headers from the umbrella folders. Building
803 # an entire module might include header, which depends on intrinsics_gen. This
804 # should be right after LLVMSupport and LLVMTableGen otherwise we introduce a
805 # circular dependence.
806 if (LLVM_ENABLE_MODULES)
807 list(APPEND LLVM_COMMON_DEPENDS intrinsics_gen)
808 endif(LLVM_ENABLE_MODULES)
810 add_subdirectory(include/llvm)
812 add_subdirectory(lib)
814 if( LLVM_INCLUDE_UTILS )
815 add_subdirectory(utils/FileCheck)
816 add_subdirectory(utils/PerfectShuffle)
817 add_subdirectory(utils/count)
818 add_subdirectory(utils/not)
819 add_subdirectory(utils/llvm-lit)
820 add_subdirectory(utils/yaml-bench)
821 add_subdirectory(utils/unittest)
823 if ( LLVM_INCLUDE_TESTS )
824 message(FATAL_ERROR "Including tests when not building utils will not work.
825 Either set LLVM_INCLUDE_UTILS to On, or set LLVM_INCLDE_TESTS to Off.")
829 # Use LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION instead of LLVM_INCLUDE_UTILS because it is not really a util
830 if (LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION)
831 add_subdirectory(utils/LLVMVisualizers)
834 foreach( binding ${LLVM_BINDINGS_LIST} )
835 if( EXISTS "${LLVM_MAIN_SRC_DIR}/bindings/${binding}/CMakeLists.txt" )
836 add_subdirectory(bindings/${binding})
840 add_subdirectory(projects)
842 if( LLVM_INCLUDE_TOOLS )
843 add_subdirectory(tools)
846 add_subdirectory(runtimes)
848 if( LLVM_INCLUDE_EXAMPLES )
849 add_subdirectory(examples)
852 if( LLVM_INCLUDE_TESTS )
853 if(EXISTS ${LLVM_MAIN_SRC_DIR}/projects/test-suite AND TARGET clang)
854 include(LLVMExternalProjectUtils)
855 llvm_ExternalProject_Add(test-suite ${LLVM_MAIN_SRC_DIR}/projects/test-suite
861 add_subdirectory(test)
862 add_subdirectory(unittests)
864 # This utility is used to prevent crashing tests from calling Dr. Watson on
866 add_subdirectory(utils/KillTheDoctor)
869 # Add a global check rule now that all subdirectories have been traversed
870 # and we know the total set of lit testsuites.
871 get_property(LLVM_LIT_TESTSUITES GLOBAL PROPERTY LLVM_LIT_TESTSUITES)
872 get_property(LLVM_LIT_PARAMS GLOBAL PROPERTY LLVM_LIT_PARAMS)
873 get_property(LLVM_LIT_DEPENDS GLOBAL PROPERTY LLVM_LIT_DEPENDS)
874 get_property(LLVM_LIT_EXTRA_ARGS GLOBAL PROPERTY LLVM_LIT_EXTRA_ARGS)
875 get_property(LLVM_ADDITIONAL_TEST_TARGETS
876 GLOBAL PROPERTY LLVM_ADDITIONAL_TEST_TARGETS)
877 get_property(LLVM_ADDITIONAL_TEST_DEPENDS
878 GLOBAL PROPERTY LLVM_ADDITIONAL_TEST_DEPENDS)
879 add_lit_target(check-all
880 "Running all regression tests"
881 ${LLVM_LIT_TESTSUITES}
882 PARAMS ${LLVM_LIT_PARAMS}
883 DEPENDS ${LLVM_LIT_DEPENDS} ${LLVM_ADDITIONAL_TEST_TARGETS}
884 ARGS ${LLVM_LIT_EXTRA_ARGS}
886 if(TARGET check-runtimes)
887 add_dependencies(check-all check-runtimes)
889 add_custom_target(test-depends
890 DEPENDS ${LLVM_LIT_DEPENDS} ${LLVM_ADDITIONAL_TEST_DEPENDS})
891 set_target_properties(test-depends PROPERTIES FOLDER "Tests")
894 if (LLVM_INCLUDE_DOCS)
895 add_subdirectory(docs)
898 add_subdirectory(cmake/modules)
900 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
901 install(DIRECTORY include/llvm include/llvm-c
903 COMPONENT llvm-headers
909 PATTERN "LICENSE.TXT"
910 PATTERN ".svn" EXCLUDE
913 install(DIRECTORY ${LLVM_INCLUDE_DIR}/llvm
915 COMPONENT llvm-headers
921 # Exclude include/llvm/CMakeFiles/intrinsics_gen.dir, matched by "*.def"
922 PATTERN "CMakeFiles" EXCLUDE
923 PATTERN "config.h" EXCLUDE
924 PATTERN ".svn" EXCLUDE
927 # Installing the headers needs to depend on generating any public
928 # tablegen'd headers.
929 add_custom_target(llvm-headers DEPENDS intrinsics_gen)
931 if (NOT CMAKE_CONFIGURATION_TYPES)
932 add_custom_target(install-llvm-headers
934 COMMAND "${CMAKE_COMMAND}"
935 -DCMAKE_INSTALL_COMPONENT=llvm-headers
936 -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
940 # This must be at the end of the LLVM root CMakeLists file because it must run
941 # after all targets are created.
942 if(LLVM_DISTRIBUTION_COMPONENTS)
943 if(CMAKE_CONFIGURATION_TYPES)
944 message(FATAL_ERROR "LLVM_DISTRIBUTION_COMPONENTS cannot be specified with multi-configuration generators (i.e. Xcode or Visual Studio)")
947 add_custom_target(distribution)
948 add_custom_target(install-distribution)
949 foreach(target ${LLVM_DISTRIBUTION_COMPONENTS})
951 add_dependencies(distribution ${target})
953 message(FATAL_ERROR "Specified distribution component '${target}' doesn't have a target")
956 if(TARGET install-${target})
957 add_dependencies(install-distribution install-${target})
959 message(FATAL_ERROR "Specified distribution component '${target}' doesn't have an install target")
964 # This allows us to deploy the Universal CRT DLLs by passing -DCMAKE_INSTALL_UCRT_LIBRARIES=ON to CMake
966 include(InstallRequiredSystemLibraries)