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 4)
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)
60 find_program(CMAKE_XCRUN NAMES xcrun)
63 execute_process(COMMAND ${CMAKE_XCRUN} -find libtool
64 OUTPUT_VARIABLE CMAKE_LIBTOOL
65 OUTPUT_STRIP_TRAILING_WHITESPACE)
68 if(NOT CMAKE_LIBTOOL OR NOT EXISTS CMAKE_LIBTOOL)
69 find_program(CMAKE_LIBTOOL NAMES libtool)
72 get_property(languages GLOBAL PROPERTY ENABLED_LANGUAGES)
74 set(CMAKE_LIBTOOL ${CMAKE_LIBTOOL} CACHE PATH "libtool executable")
75 message(STATUS "Found libtool - ${CMAKE_LIBTOOL}")
76 foreach(lang ${languages})
77 set(CMAKE_${lang}_CREATE_STATIC_LIBRARY
78 "${CMAKE_LIBTOOL} -static -o <TARGET> <LINK_FLAGS> <OBJECTS> ")
82 # If DYLD_LIBRARY_PATH is set we need to set it on archiver commands
84 set(dyld_envar "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}")
85 foreach(lang ${languages})
86 foreach(cmd ${CMAKE_${lang}_CREATE_STATIC_LIBRARY})
87 list(APPEND CMAKE_${lang}_CREATE_STATIC_LIBRARY_NEW
88 "${dyld_envar} ${cmd}")
90 set(CMAKE_${lang}_CREATE_STATIC_LIBRARY
91 ${CMAKE_${lang}_CREATE_STATIC_LIBRARY_NEW})
96 # Side-by-side subprojects layout: automatically set the
97 # LLVM_EXTERNAL_${project}_SOURCE_DIR using LLVM_ALL_PROJECTS
98 # This allows an easy way of setting up a build directory for llvm and another
99 # one for llvm+clang+... using the same sources.
100 set(LLVM_ALL_PROJECTS "clang;libcxx;libcxxabi;lldb;compiler-rt;lld;polly")
101 set(LLVM_ENABLE_PROJECTS "" CACHE STRING
102 "Semicolon-separated list of projects to build (${LLVM_ALL_PROJECTS}), or \"all\".")
103 if( LLVM_ENABLE_PROJECTS STREQUAL "all" )
104 set( LLVM_ENABLE_PROJECTS ${LLVM_ALL_PROJECTS})
106 foreach(proj ${LLVM_ENABLE_PROJECTS})
107 set(PROJ_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../${proj}")
108 if(NOT EXISTS "${PROJ_DIR}" OR NOT IS_DIRECTORY "${PROJ_DIR}")
109 message(FATAL_ERROR "LLVM_ENABLE_PROJECTS requests ${proj} but directory not found: ${PROJ_DIR}")
111 string(TOUPPER "${proj}" upper_proj)
112 STRING(REGEX REPLACE "-" "_" upper_proj ${upper_proj})
113 set(LLVM_EXTERNAL_${upper_proj}_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../${proj}")
114 # There is a widely spread opinion that clang-tools-extra should be merged
115 # into clang. The following simulates it by always enabling clang-tools-extra
116 # when enabling clang.
117 if (proj STREQUAL "clang")
118 set(LLVM_EXTERNAL_CLANG_TOOLS_EXTRA_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../clang-tools-extra")
122 # The following only works with the Ninja generator in CMake >= 3.0.
123 set(LLVM_PARALLEL_COMPILE_JOBS "" CACHE STRING
124 "Define the maximum number of concurrent compilation jobs.")
125 if(LLVM_PARALLEL_COMPILE_JOBS)
126 if(NOT CMAKE_MAKE_PROGRAM MATCHES "ninja")
127 message(WARNING "Job pooling is only available with Ninja generators.")
129 set_property(GLOBAL APPEND PROPERTY JOB_POOLS compile_job_pool=${LLVM_PARALLEL_COMPILE_JOBS})
130 set(CMAKE_JOB_POOL_COMPILE compile_job_pool)
134 # Build llvm with ccache if the package is present
135 set(LLVM_CCACHE_BUILD OFF CACHE BOOL "Set to ON for a ccache enabled build")
136 if(LLVM_CCACHE_BUILD)
137 find_program(CCACHE_PROGRAM ccache)
139 set(LLVM_CCACHE_SIZE "" CACHE STRING "Size of ccache")
140 set(LLVM_CCACHE_DIR "" CACHE STRING "Directory to keep ccached data")
141 set(CCACHE_PROGRAM "CCACHE_CPP2=yes CCACHE_HASHDIR=yes ${CCACHE_PROGRAM}")
142 if (LLVM_CCACHE_SIZE)
143 set(CCACHE_PROGRAM "CCACHE_SIZE=${LLVM_CCACHE_SIZE} ${CCACHE_PROGRAM}")
146 set(CCACHE_PROGRAM "CCACHE_DIR=${LLVM_CCACHE_DIR} ${CCACHE_PROGRAM}")
148 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_PROGRAM})
150 message(FATAL_ERROR "Unable to find the program ccache. Set LLVM_CCACHE_BUILD to OFF")
154 option(LLVM_DEPENDENCY_DEBUGGING "Dependency debugging mode to verify correctly expressed library dependencies (Darwin only)" OFF)
156 # Some features of the LLVM build may be disallowed when dependency debugging is
157 # enabled. In particular you cannot use ccache because we want to force compile
158 # operations to always happen.
159 if(LLVM_DEPENDENCY_DEBUGGING)
160 if(NOT CMAKE_HOST_APPLE)
161 message(FATAL_ERROR "Dependency debugging is only currently supported on Darwin hosts.")
163 if(LLVM_CCACHE_BUILD)
164 message(FATAL_ERROR "Cannot enable dependency debugging while using ccache.")
168 option(LLVM_BUILD_GLOBAL_ISEL "Experimental: Build GlobalISel" OFF)
169 if(LLVM_BUILD_GLOBAL_ISEL)
170 add_definitions(-DLLVM_BUILD_GLOBAL_ISEL)
173 set(LLVM_PARALLEL_LINK_JOBS "" CACHE STRING
174 "Define the maximum number of concurrent link jobs.")
175 if(LLVM_PARALLEL_LINK_JOBS)
176 if(NOT CMAKE_MAKE_PROGRAM MATCHES "ninja")
177 message(WARNING "Job pooling is only available with Ninja generators.")
179 set_property(GLOBAL APPEND PROPERTY JOB_POOLS link_job_pool=${LLVM_PARALLEL_LINK_JOBS})
180 set(CMAKE_JOB_POOL_LINK link_job_pool)
184 # Add path for custom modules
185 set(CMAKE_MODULE_PATH
187 "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
188 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules"
191 # Generate a CompilationDatabase (compile_commands.json file) for our build,
192 # for use by clang_complete, YouCompleteMe, etc.
193 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
195 option(LLVM_INSTALL_UTILS "Include utility binaries in the 'install' target." OFF)
197 option(LLVM_INSTALL_TOOLCHAIN_ONLY "Only include toolchain files in the 'install' target." OFF)
199 option(LLVM_USE_FOLDERS "Enable solution folders in Visual Studio. Disable for Express versions." ON)
200 if ( LLVM_USE_FOLDERS )
201 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
204 include(VersionFromVCS)
206 option(LLVM_APPEND_VC_REV
207 "Append the version control system revision id to LLVM version" OFF)
209 if( LLVM_APPEND_VC_REV )
210 add_version_info_from_vcs(PACKAGE_VERSION)
213 set(PACKAGE_NAME LLVM)
214 set(PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}")
215 set(PACKAGE_BUGREPORT "http://llvm.org/bugs/")
217 set(BUG_REPORT_URL "${PACKAGE_BUGREPORT}" CACHE STRING
218 "Default URL where bug reports are to be submitted.")
221 set(CPACK_PACKAGE_INSTALL_DIRECTORY "LLVM")
222 set(CPACK_PACKAGE_VENDOR "LLVM")
223 set(CPACK_PACKAGE_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
224 set(CPACK_PACKAGE_VERSION_MINOR ${LLVM_VERSION_MINOR})
225 set(CPACK_PACKAGE_VERSION_PATCH ${LLVM_VERSION_PATCH})
226 set(CPACK_PACKAGE_VERSION ${PACKAGE_VERSION})
227 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.TXT")
228 set(CPACK_NSIS_COMPRESSOR "/SOLID lzma \r\n SetCompressorDictSize 32")
229 if(WIN32 AND NOT UNIX)
230 set(CPACK_PACKAGE_INSTALL_REGISTRY_KEY "LLVM")
231 set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_logo.bmp")
232 set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_icon.ico")
233 set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\cmake\\\\nsis_icon.ico")
234 set(CPACK_NSIS_MODIFY_PATH "ON")
235 set(CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL "ON")
236 set(CPACK_NSIS_EXTRA_INSTALL_COMMANDS
237 "ExecWait '$INSTDIR/tools/msbuild/install.bat'")
238 set(CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
239 "ExecWait '$INSTDIR/tools/msbuild/uninstall.bat'")
241 set(CPACK_NSIS_INSTALL_ROOT "$PROGRAMFILES64")
246 # Sanity check our source directory to make sure that we are not trying to
247 # generate an in-tree build (unless on MSVC_IDE, where it is ok), and to make
248 # sure that we don't have any stray generated files lying around in the tree
249 # (which would end up getting picked up by header search, instead of the correct
251 if( CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR AND NOT MSVC_IDE )
252 message(FATAL_ERROR "In-source builds are not allowed.
253 CMake would overwrite the makefiles distributed with LLVM.
254 Please create a directory and run cmake from there, passing the path
255 to this source directory as the last argument.
256 This process created the file `CMakeCache.txt' and the directory `CMakeFiles'.
257 Please delete them.")
259 if( NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR )
261 tablegenned_files_on_include_dir
262 "${CMAKE_CURRENT_SOURCE_DIR}/include/llvm/*.gen")
264 tablegenned_files_on_lib_dir
265 "${CMAKE_CURRENT_SOURCE_DIR}/lib/Target/*.inc")
266 if( tablegenned_files_on_include_dir OR tablegenned_files_on_lib_dir)
267 message(FATAL_ERROR "Apparently there is a previous in-source build,
268 probably as the result of running `configure' and `make' on
269 ${CMAKE_CURRENT_SOURCE_DIR}.
270 This may cause problems. The suspicious files are:
271 ${tablegenned_files_on_lib_dir}
272 ${tablegenned_files_on_include_dir}
273 Please clean the source directory.")
277 string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE)
279 if (CMAKE_BUILD_TYPE AND
280 NOT uppercase_CMAKE_BUILD_TYPE MATCHES "^(DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL)$")
281 message(FATAL_ERROR "Invalid value for CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
284 set(LLVM_LIBDIR_SUFFIX "" CACHE STRING "Define suffix of library directory name (32/64)" )
286 set(LLVM_TOOLS_INSTALL_DIR "bin" CACHE STRING "Path for binary subdirectory (defaults to 'bin')")
287 mark_as_advanced(LLVM_TOOLS_INSTALL_DIR)
289 # They are used as destination of target generators.
290 set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin)
291 set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib${LLVM_LIBDIR_SUFFIX})
293 # DLL platform -- put DLLs into bin.
294 set(LLVM_SHLIB_OUTPUT_INTDIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
296 set(LLVM_SHLIB_OUTPUT_INTDIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
299 # Each of them corresponds to llvm-config's.
300 set(LLVM_TOOLS_BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR}) # --bindir
301 set(LLVM_LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR}) # --libdir
302 set(LLVM_MAIN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR} ) # --src-root
303 set(LLVM_MAIN_INCLUDE_DIR ${LLVM_MAIN_SRC_DIR}/include ) # --includedir
304 set(LLVM_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR} ) # --prefix
306 # Note: LLVM_CMAKE_PATH does not include generated files
307 set(LLVM_CMAKE_PATH ${LLVM_MAIN_SRC_DIR}/cmake/modules)
308 set(LLVM_EXAMPLES_BINARY_DIR ${LLVM_BINARY_DIR}/examples)
309 set(LLVM_INCLUDE_DIR ${CMAKE_CURRENT_BINARY_DIR}/include)
329 # List of targets with JIT support:
330 set(LLVM_TARGETS_WITH_JIT X86 PowerPC AArch64 ARM Mips SystemZ)
332 set(LLVM_TARGETS_TO_BUILD "all"
333 CACHE STRING "Semicolon-separated list of targets to build, or \"all\".")
335 set(LLVM_EXPERIMENTAL_TARGETS_TO_BUILD ""
336 CACHE STRING "Semicolon-separated list of experimental targets to build.")
338 option(BUILD_SHARED_LIBS
339 "Build all libraries as shared libraries instead of static" OFF)
341 option(LLVM_ENABLE_BACKTRACES "Enable embedding backtraces on crash." ON)
342 if(LLVM_ENABLE_BACKTRACES)
343 set(ENABLE_BACKTRACES 1)
346 option(LLVM_ENABLE_CRASH_OVERRIDES "Enable crash overrides." ON)
347 if(LLVM_ENABLE_CRASH_OVERRIDES)
348 set(ENABLE_CRASH_OVERRIDES 1)
351 option(LLVM_ENABLE_FFI "Use libffi to call external functions from the interpreter" OFF)
352 set(FFI_LIBRARY_DIR "" CACHE PATH "Additional directory, where CMake should search for libffi.so")
353 set(FFI_INCLUDE_DIR "" CACHE PATH "Additional directory, where CMake should search for ffi.h or ffi/ffi.h")
355 set(LLVM_TARGET_ARCH "host"
356 CACHE STRING "Set target to use for LLVM JIT or use \"host\" for automatic detection.")
358 option(LLVM_ENABLE_TERMINFO "Use terminfo database if available." ON)
360 option(LLVM_ENABLE_THREADS "Use threads if available." ON)
362 option(LLVM_ENABLE_ZLIB "Use zlib for compression/decompression if available." ON)
364 if( LLVM_TARGETS_TO_BUILD STREQUAL "all" )
365 set( LLVM_TARGETS_TO_BUILD ${LLVM_ALL_TARGETS} )
368 set(LLVM_TARGETS_TO_BUILD
369 ${LLVM_TARGETS_TO_BUILD}
370 ${LLVM_EXPERIMENTAL_TARGETS_TO_BUILD})
371 list(REMOVE_DUPLICATES LLVM_TARGETS_TO_BUILD)
373 include(AddLLVMDefinitions)
375 option(LLVM_ENABLE_PIC "Build Position-Independent Code" ON)
376 option(LLVM_ENABLE_WARNINGS "Enable compiler warnings." ON)
377 option(LLVM_ENABLE_MODULES "Compile with C++ modules enabled." OFF)
378 if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
379 option(LLVM_ENABLE_MODULE_DEBUGGING "Compile with -gmodules." ON)
380 option(LLVM_ENABLE_LOCAL_SUBMODULE_VISIBILITY "Compile with -fmodules-local-submodule-visibility." OFF)
382 option(LLVM_ENABLE_MODULE_DEBUGGING "Compile with -gmodules." OFF)
383 option(LLVM_ENABLE_LOCAL_SUBMODULE_VISIBILITY "Compile with -fmodules-local-submodule-visibility." ON)
385 option(LLVM_ENABLE_CXX1Y "Compile with C++1y enabled." OFF)
386 option(LLVM_ENABLE_LIBCXX "Use libc++ if available." OFF)
387 option(LLVM_ENABLE_LLD "Use lld as C and C++ linker." OFF)
388 option(LLVM_ENABLE_PEDANTIC "Compile with pedantic enabled." ON)
389 option(LLVM_ENABLE_WERROR "Fail and stop if a warning is triggered." OFF)
391 if( NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" )
392 option(LLVM_ENABLE_ASSERTIONS "Enable assertions" OFF)
394 option(LLVM_ENABLE_ASSERTIONS "Enable assertions" ON)
397 option(LLVM_ENABLE_EXPENSIVE_CHECKS "Enable expensive checks" OFF)
399 set(LLVM_ABI_BREAKING_CHECKS "WITH_ASSERTS" CACHE STRING
400 "Enable abi-breaking checks. Can be WITH_ASSERTS, FORCE_ON or FORCE_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))
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 # All options referred to from HandleLLVMOptions have to be specified
558 # BEFORE this include, otherwise options will not be correctly set on
562 string(REPLACE "Native" ${LLVM_NATIVE_ARCH}
563 LLVM_TARGETS_TO_BUILD "${LLVM_TARGETS_TO_BUILD}")
564 list(REMOVE_DUPLICATES LLVM_TARGETS_TO_BUILD)
566 # By default, we target the host, but this can be overridden at CMake
568 set(LLVM_DEFAULT_TARGET_TRIPLE "${LLVM_HOST_TRIPLE}" CACHE STRING
569 "Default target for which LLVM will generate code." )
570 set(TARGET_TRIPLE "${LLVM_DEFAULT_TARGET_TRIPLE}")
571 message(STATUS "LLVM host triple: ${LLVM_HOST_TRIPLE}")
572 message(STATUS "LLVM default target triple: ${LLVM_DEFAULT_TARGET_TRIPLE}")
574 include(HandleLLVMOptions)
576 # Verify that we can find a Python 2 interpreter. Python 3 is unsupported.
577 # FIXME: We should support systems with only Python 3, but that requires work
579 set(Python_ADDITIONAL_VERSIONS 2.7)
580 include(FindPythonInterp)
581 if( NOT PYTHONINTERP_FOUND )
583 "Unable to find Python interpreter, required for builds and testing.
585 Please install Python or specify the PYTHON_EXECUTABLE CMake variable.")
588 if( ${PYTHON_VERSION_STRING} VERSION_LESS 2.7 )
589 message(FATAL_ERROR "Python 2.7 or newer is required")
593 # LLVMBuild Integration
595 # We use llvm-build to generate all the data required by the CMake based
596 # build system in one swoop:
598 # - We generate a file (a CMake fragment) in the object root which contains
599 # all the definitions that are required by CMake.
601 # - We generate the library table used by llvm-config.
603 # - We generate the dependencies for the CMake fragment, so that we will
604 # automatically reconfigure outselves.
606 set(LLVMBUILDTOOL "${LLVM_MAIN_SRC_DIR}/utils/llvm-build/llvm-build")
607 set(LLVMCONFIGLIBRARYDEPENDENCIESINC
608 "${LLVM_BINARY_DIR}/tools/llvm-config/LibraryDependencies.inc")
609 set(LLVMBUILDCMAKEFRAG
610 "${LLVM_BINARY_DIR}/LLVMBuild.cmake")
612 # Create the list of optional components that are enabled
613 if (LLVM_USE_INTEL_JITEVENTS)
614 set(LLVMOPTIONALCOMPONENTS IntelJITEvents)
615 endif (LLVM_USE_INTEL_JITEVENTS)
616 if (LLVM_USE_OPROFILE)
617 set(LLVMOPTIONALCOMPONENTS ${LLVMOPTIONALCOMPONENTS} OProfileJIT)
618 endif (LLVM_USE_OPROFILE)
620 message(STATUS "Constructing LLVMBuild project information")
622 COMMAND ${PYTHON_EXECUTABLE} ${LLVMBUILDTOOL}
623 --native-target "${LLVM_NATIVE_ARCH}"
624 --enable-targets "${LLVM_TARGETS_TO_BUILD}"
625 --enable-optional-components "${LLVMOPTIONALCOMPONENTS}"
626 --write-library-table ${LLVMCONFIGLIBRARYDEPENDENCIESINC}
627 --write-cmake-fragment ${LLVMBUILDCMAKEFRAG}
628 OUTPUT_VARIABLE LLVMBUILDOUTPUT
629 ERROR_VARIABLE LLVMBUILDERRORS
630 OUTPUT_STRIP_TRAILING_WHITESPACE
631 ERROR_STRIP_TRAILING_WHITESPACE
632 RESULT_VARIABLE LLVMBUILDRESULT)
634 # On Win32, CMake doesn't properly handle piping the default output/error
635 # streams into the GUI console. So, we explicitly catch and report them.
636 if( NOT "${LLVMBUILDOUTPUT}" STREQUAL "")
637 message(STATUS "llvm-build output: ${LLVMBUILDOUTPUT}")
639 if( NOT "${LLVMBUILDRESULT}" STREQUAL "0" )
641 "Unexpected failure executing llvm-build: ${LLVMBUILDERRORS}")
644 # Include the generated CMake fragment. This will define properties from the
645 # LLVMBuild files in a format which is easy to consume from CMake, and will add
646 # the dependencies so that CMake will reconfigure properly when the LLVMBuild
648 include(${LLVMBUILDCMAKEFRAG})
652 # Configure all of the various header file fragments LLVM uses which depend on
653 # configuration variables.
654 set(LLVM_ENUM_TARGETS "")
655 set(LLVM_ENUM_ASM_PRINTERS "")
656 set(LLVM_ENUM_ASM_PARSERS "")
657 set(LLVM_ENUM_DISASSEMBLERS "")
658 foreach(t ${LLVM_TARGETS_TO_BUILD})
659 set( td ${LLVM_MAIN_SRC_DIR}/lib/Target/${t} )
661 list(FIND LLVM_ALL_TARGETS ${t} idx)
662 list(FIND LLVM_EXPERIMENTAL_TARGETS_TO_BUILD ${t} idy)
663 if( idx LESS 0 AND idy LESS 0 )
664 message(FATAL_ERROR "The target `${t}' does not exist.
665 It should be one of\n${LLVM_ALL_TARGETS}")
667 set(LLVM_ENUM_TARGETS "${LLVM_ENUM_TARGETS}LLVM_TARGET(${t})\n")
670 file(GLOB asmp_file "${td}/*AsmPrinter.cpp")
672 set(LLVM_ENUM_ASM_PRINTERS
673 "${LLVM_ENUM_ASM_PRINTERS}LLVM_ASM_PRINTER(${t})\n")
675 if( EXISTS ${td}/AsmParser/CMakeLists.txt )
676 set(LLVM_ENUM_ASM_PARSERS
677 "${LLVM_ENUM_ASM_PARSERS}LLVM_ASM_PARSER(${t})\n")
679 if( EXISTS ${td}/Disassembler/CMakeLists.txt )
680 set(LLVM_ENUM_DISASSEMBLERS
681 "${LLVM_ENUM_DISASSEMBLERS}LLVM_DISASSEMBLER(${t})\n")
685 # Produce the target definition files, which provide a way for clients to easily
686 # include various classes of targets.
688 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/AsmPrinters.def.in
689 ${LLVM_INCLUDE_DIR}/llvm/Config/AsmPrinters.def
692 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/AsmParsers.def.in
693 ${LLVM_INCLUDE_DIR}/llvm/Config/AsmParsers.def
696 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/Disassemblers.def.in
697 ${LLVM_INCLUDE_DIR}/llvm/Config/Disassemblers.def
700 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/Targets.def.in
701 ${LLVM_INCLUDE_DIR}/llvm/Config/Targets.def
704 # Configure the three LLVM configuration header files.
706 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/config.h.cmake
707 ${LLVM_INCLUDE_DIR}/llvm/Config/config.h)
709 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Config/llvm-config.h.cmake
710 ${LLVM_INCLUDE_DIR}/llvm/Config/llvm-config.h)
712 ${LLVM_MAIN_INCLUDE_DIR}/llvm/Support/DataTypes.h.cmake
713 ${LLVM_INCLUDE_DIR}/llvm/Support/DataTypes.h)
715 # They are not referenced. See set_output_directory().
716 set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/bin )
717 set( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX} )
718 set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${LLVM_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX} )
720 if(APPLE AND DARWIN_LTO_LIBRARY)
721 set(CMAKE_EXE_LINKER_FLAGS
722 "${CMAKE_EXE_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
723 set(CMAKE_SHARED_LINKER_FLAGS
724 "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
725 set(CMAKE_MODULE_LINKER_FLAGS
726 "${CMAKE_MODULE_LINKER_FLAGS} -Wl,-lto_library -Wl,${DARWIN_LTO_LIBRARY}")
729 # Work around a broken bfd ld behavior. When linking a binary with a
730 # foo.so library, it will try to find any library that foo.so uses and
731 # check its symbols. This is wasteful (the check was done when foo.so
732 # was created) and can fail since it is not the dynamic linker and
733 # doesn't know how to handle search paths correctly.
734 if (UNIX AND NOT APPLE AND NOT ${CMAKE_SYSTEM_NAME} MATCHES "SunOS|AIX")
735 set(CMAKE_EXE_LINKER_FLAGS
736 "${CMAKE_EXE_LINKER_FLAGS} -Wl,-allow-shlib-undefined")
739 set(CMAKE_INCLUDE_CURRENT_DIR ON)
741 include_directories( ${LLVM_INCLUDE_DIR} ${LLVM_MAIN_INCLUDE_DIR})
743 # when crosscompiling import the executable targets from a file
744 if(LLVM_USE_HOST_TOOLS)
745 include(CrossCompile)
746 endif(LLVM_USE_HOST_TOOLS)
747 if(LLVM_TARGET_IS_CROSSCOMPILE_HOST)
748 # Dummy use to avoid CMake Wraning: Manually-specified variables were not used
749 # (this is a variable that CrossCompile sets on recursive invocations)
752 if(${CMAKE_SYSTEM_NAME} MATCHES "(FreeBSD|DragonFly)")
753 # On FreeBSD, /usr/local/* is not used by default. In order to build LLVM
754 # with libxml2, iconv.h, etc., we must add /usr/local paths.
755 include_directories("/usr/local/include")
756 link_directories("/usr/local/lib")
757 endif(${CMAKE_SYSTEM_NAME} MATCHES "(FreeBSD|DragonFly)")
759 if( ${CMAKE_SYSTEM_NAME} MATCHES SunOS )
760 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -include llvm/Support/Solaris.h")
761 endif( ${CMAKE_SYSTEM_NAME} MATCHES SunOS )
763 # Make sure we don't get -rdynamic in every binary. For those that need it,
764 # use export_executable_symbols(target).
765 set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "")
767 set(LLVM_PROFDATA_FILE "" CACHE FILEPATH
768 "Profiling data file to use when compiling in order to improve runtime performance.")
770 if(LLVM_PROFDATA_FILE AND EXISTS ${LLVM_PROFDATA_FILE})
771 if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" )
772 add_definitions("-fprofile-instr-use=${LLVM_PROFDATA_FILE}")
774 message(FATAL_ERROR "LLVM_PROFDATA_FILE can only be specified when compiling with clang")
782 # People report that -O3 is unreliable on MinGW. The traditional
783 # build also uses -O2 for that reason:
784 llvm_replace_compiler_option(CMAKE_CXX_FLAGS_RELEASE "-O3" "-O2")
787 # Put this before tblgen. Else we have a circular dependence.
788 add_subdirectory(lib/Demangle)
789 add_subdirectory(lib/Support)
790 add_subdirectory(lib/TableGen)
792 add_subdirectory(utils/TableGen)
794 # Force target to be built as soon as possible. Clang modules builds depend
795 # header-wise on it as they ship all headers from the umbrella folders. Building
796 # an entire module might include header, which depends on intrinsics_gen. This
797 # should be right after LLVMSupport and LLVMTableGen otherwise we introduce a
798 # circular dependence.
799 if (LLVM_ENABLE_MODULES)
800 list(APPEND LLVM_COMMON_DEPENDS intrinsics_gen)
801 endif(LLVM_ENABLE_MODULES)
803 add_subdirectory(include/llvm)
805 add_subdirectory(lib)
807 if( LLVM_INCLUDE_UTILS )
808 add_subdirectory(utils/FileCheck)
809 add_subdirectory(utils/PerfectShuffle)
810 add_subdirectory(utils/count)
811 add_subdirectory(utils/not)
812 add_subdirectory(utils/llvm-lit)
813 add_subdirectory(utils/yaml-bench)
814 add_subdirectory(utils/unittest)
816 if ( LLVM_INCLUDE_TESTS )
817 message(FATAL_ERROR "Including tests when not building utils will not work.
818 Either set LLVM_INCLUDE_UTILS to On, or set LLVM_INCLDE_TESTS to Off.")
822 # Use LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION instead of LLVM_INCLUDE_UTILS because it is not really a util
823 if (LLVM_ADD_NATIVE_VISUALIZERS_TO_SOLUTION)
824 add_subdirectory(utils/LLVMVisualizers)
827 foreach( binding ${LLVM_BINDINGS_LIST} )
828 if( EXISTS "${LLVM_MAIN_SRC_DIR}/bindings/${binding}/CMakeLists.txt" )
829 add_subdirectory(bindings/${binding})
833 add_subdirectory(projects)
835 if( LLVM_INCLUDE_TOOLS )
836 add_subdirectory(tools)
839 add_subdirectory(runtimes)
841 if( LLVM_INCLUDE_EXAMPLES )
842 add_subdirectory(examples)
845 if( LLVM_INCLUDE_TESTS )
846 if(EXISTS ${LLVM_MAIN_SRC_DIR}/projects/test-suite AND TARGET clang)
847 include(LLVMExternalProjectUtils)
848 llvm_ExternalProject_Add(test-suite ${LLVM_MAIN_SRC_DIR}/projects/test-suite
854 add_subdirectory(test)
855 add_subdirectory(unittests)
857 # This utility is used to prevent crashing tests from calling Dr. Watson on
859 add_subdirectory(utils/KillTheDoctor)
862 # Add a global check rule now that all subdirectories have been traversed
863 # and we know the total set of lit testsuites.
864 get_property(LLVM_LIT_TESTSUITES GLOBAL PROPERTY LLVM_LIT_TESTSUITES)
865 get_property(LLVM_LIT_PARAMS GLOBAL PROPERTY LLVM_LIT_PARAMS)
866 get_property(LLVM_LIT_DEPENDS GLOBAL PROPERTY LLVM_LIT_DEPENDS)
867 get_property(LLVM_LIT_EXTRA_ARGS GLOBAL PROPERTY LLVM_LIT_EXTRA_ARGS)
868 get_property(LLVM_ADDITIONAL_TEST_TARGETS
869 GLOBAL PROPERTY LLVM_ADDITIONAL_TEST_TARGETS)
870 get_property(LLVM_ADDITIONAL_TEST_DEPENDS
871 GLOBAL PROPERTY LLVM_ADDITIONAL_TEST_DEPENDS)
872 add_lit_target(check-all
873 "Running all regression tests"
874 ${LLVM_LIT_TESTSUITES}
875 PARAMS ${LLVM_LIT_PARAMS}
876 DEPENDS ${LLVM_LIT_DEPENDS} ${LLVM_ADDITIONAL_TEST_TARGETS}
877 ARGS ${LLVM_LIT_EXTRA_ARGS}
879 if(TARGET check-runtimes)
880 add_dependencies(check-all check-runtimes)
882 add_custom_target(test-depends
883 DEPENDS ${LLVM_LIT_DEPENDS} ${LLVM_ADDITIONAL_TEST_DEPENDS})
884 set_target_properties(test-depends PROPERTIES FOLDER "Tests")
887 if (LLVM_INCLUDE_DOCS)
888 add_subdirectory(docs)
891 add_subdirectory(cmake/modules)
893 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
894 install(DIRECTORY include/llvm include/llvm-c
896 COMPONENT llvm-headers
902 PATTERN "LICENSE.TXT"
903 PATTERN ".svn" EXCLUDE
906 install(DIRECTORY ${LLVM_INCLUDE_DIR}/llvm
908 COMPONENT llvm-headers
914 # Exclude include/llvm/CMakeFiles/intrinsics_gen.dir, matched by "*.def"
915 PATTERN "CMakeFiles" EXCLUDE
916 PATTERN "config.h" EXCLUDE
917 PATTERN ".svn" EXCLUDE
920 # Installing the headers needs to depend on generating any public
921 # tablegen'd headers.
922 add_custom_target(llvm-headers DEPENDS intrinsics_gen)
924 if (NOT CMAKE_CONFIGURATION_TYPES)
925 add_custom_target(install-llvm-headers
927 COMMAND "${CMAKE_COMMAND}"
928 -DCMAKE_INSTALL_COMPONENT=llvm-headers
929 -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
933 # This must be at the end of the LLVM root CMakeLists file because it must run
934 # after all targets are created.
935 if(LLVM_DISTRIBUTION_COMPONENTS)
936 if(CMAKE_CONFIGURATION_TYPES)
937 message(FATAL_ERROR "LLVM_DISTRIBUTION_COMPONENTS cannot be specified with multi-configuration generators (i.e. Xcode or Visual Studio)")
940 add_custom_target(distribution)
941 add_custom_target(install-distribution)
942 foreach(target ${LLVM_DISTRIBUTION_COMPONENTS})
944 add_dependencies(distribution ${target})
946 message(FATAL_ERROR "Specified distribution component '${target}' doesn't have a target")
949 if(TARGET install-${target})
950 add_dependencies(install-distribution install-${target})
952 message(FATAL_ERROR "Specified distribution component '${target}' doesn't have an install target")