docs/CMake.rst

   1 ========================
   2 Building LLVM with CMake
   3 ========================
   4
   5 .. contents::
   6    :local:
   7
   8 Introduction
   9 ============
  10
  11 `CMake <http://www.cmake.org/>`_ is a cross-platform build-generator tool. CMake
  12 does not build the project, it generates the files needed by your build tool
  13 (GNU make, Visual Studio, etc.) for building LLVM.
  14
  15 If **you are a new contributor**, please start with the :doc:`GettingStarted`
  16 page.  This page is geared for existing contributors moving from the
  17 legacy configure/make system.
  18
  19 If you are really anxious about getting a functional LLVM build, go to the
  20 `Quick start`_ section. If you are a CMake novice, start with `Basic CMake usage`_
  21 and then go back to the `Quick start`_ section once you know what you are doing. The
  22 `Options and variables`_ section is a reference for customizing your build. If
  23 you already have experience with CMake, this is the recommended starting point.
  24
  25 This page is geared towards users of the LLVM CMake build. If you're looking for
  26 information about modifying the LLVM CMake build system you may want to see the
  27 :doc:`CMakePrimer` page. It has a basic overview of the CMake language.
  28
  29 .. _Quick start:
  30
  31 Quick start
  32 ===========
  33
  34 We use here the command-line, non-interactive CMake interface.
  35
  36 #. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
  37    CMake. Version 3.4.3 is the minimum required.
  38
  39 #. Open a shell. Your development tools must be reachable from this shell
  40    through the PATH environment variable.
  41
  42 #. Create a build directory. Building LLVM in the source
  43    directory is not supported. cd to this directory:
  44
  45    .. code-block:: console
  46
  47      $ mkdir mybuilddir
  48      $ cd mybuilddir
  49
  50 #. Execute this command in the shell replacing `path/to/llvm/source/root` with
  51    the path to the root of your LLVM source tree:
  52
  53    .. code-block:: console
  54
  55      $ cmake path/to/llvm/source/root
  56
  57    CMake will detect your development environment, perform a series of tests, and
  58    generate the files required for building LLVM. CMake will use default values
  59    for all build parameters. See the `Options and variables`_ section for
  60    a list of build parameters that you can modify.
  61
  62    This can fail if CMake can't detect your toolset, or if it thinks that the
  63    environment is not sane enough. In this case, make sure that the toolset that
  64    you intend to use is the only one reachable from the shell, and that the shell
  65    itself is the correct one for your development environment. CMake will refuse
  66    to build MinGW makefiles if you have a POSIX shell reachable through the PATH
  67    environment variable, for instance. You can force CMake to use a given build
  68    tool; for instructions, see the `Usage`_ section, below.
  69
  70 #. After CMake has finished running, proceed to use IDE project files, or start
  71    the build from the build directory:
  72
  73    .. code-block:: console
  74
  75      $ cmake --build .
  76
  77    The ``--build`` option tells ``cmake`` to invoke the underlying build
  78    tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc.)
  79
  80    The underlying build tool can be invoked directly, of course, but
  81    the ``--build`` option is portable.
  82
  83 #. After LLVM has finished building, install it from the build directory:
  84
  85    .. code-block:: console
  86
  87      $ cmake --build . --target install
  88
  89    The ``--target`` option with ``install`` parameter in addition to
  90    the ``--build`` option tells ``cmake`` to build the ``install`` target.
  91
  92    It is possible to set a different install prefix at installation time
  93    by invoking the ``cmake_install.cmake`` script generated in the
  94    build directory:
  95
  96    .. code-block:: console
  97
  98      $ cmake -DCMAKE_INSTALL_PREFIX=/tmp/llvm -P cmake_install.cmake
  99
 100 .. _Basic CMake usage:
 101 .. _Usage:
 102
 103 Basic CMake usage
 104 =================
 105
 106 This section explains basic aspects of CMake
 107 which you may need in your day-to-day usage.
 108
 109 CMake comes with extensive documentation, in the form of html files, and as
 110 online help accessible via the ``cmake`` executable itself. Execute ``cmake
 111 --help`` for further help options.
 112
 113 CMake allows you to specify a build tool (e.g., GNU make, Visual Studio,
 114 or Xcode). If not specified on the command line, CMake tries to guess which
 115 build tool to use, based on your environment. Once it has identified your
 116 build tool, CMake uses the corresponding *Generator* to create files for your
 117 build tool (e.g., Makefiles or Visual Studio or Xcode project files). You can
 118 explicitly specify the generator with the command line option ``-G "Name of the
 119 generator"``. To see a list of the available generators on your system, execute
 120
 121 .. code-block:: console
 122
 123   $ cmake --help
 124
 125 This will list the generator names at the end of the help text.
 126
 127 Generators' names are case-sensitive, and may contain spaces. For this reason,
 128 you should enter them exactly as they are listed in the ``cmake --help``
 129 output, in quotes. For example, to generate project files specifically for
 130 Visual Studio 12, you can execute:
 131
 132 .. code-block:: console
 133
 134   $ cmake -G "Visual Studio 12" path/to/llvm/source/root
 135
 136 For a given development platform there can be more than one adequate
 137 generator. If you use Visual Studio, "NMake Makefiles" is a generator you can use
 138 for building with NMake. By default, CMake chooses the most specific generator
 139 supported by your development environment. If you want an alternative generator,
 140 you must tell this to CMake with the ``-G`` option.
 141
 142 .. todo::
 143
 144   Explain variables and cache. Move explanation here from #options section.
 145
 146 .. _Options and variables:
 147
 148 Options and variables
 149 =====================
 150
 151 Variables customize how the build will be generated. Options are boolean
 152 variables, with possible values ON/OFF. Options and variables are defined on the
 153 CMake command line like this:
 154
 155 .. code-block:: console
 156
 157   $ cmake -DVARIABLE=value path/to/llvm/source
 158
 159 You can set a variable after the initial CMake invocation to change its
 160 value. You can also undefine a variable:
 161
 162 .. code-block:: console
 163
 164   $ cmake -UVARIABLE path/to/llvm/source
 165
 166 Variables are stored in the CMake cache. This is a file named ``CMakeCache.txt``
 167 stored at the root of your build directory that is generated by ``cmake``.
 168 Editing it yourself is not recommended.
 169
 170 Variables are listed in the CMake cache and later in this document with
 171 the variable name and type separated by a colon. You can also specify the
 172 variable and type on the CMake command line:
 173
 174 .. code-block:: console
 175
 176   $ cmake -DVARIABLE:TYPE=value path/to/llvm/source
 177
 178 Frequently-used CMake variables
 179 -------------------------------
 180
 181 Here are some of the CMake variables that are used often, along with a
 182 brief explanation and LLVM-specific notes. For full documentation, consult the
 183 CMake manual, or execute ``cmake --help-variable VARIABLE_NAME``.
 184
 185 **CMAKE_BUILD_TYPE**:STRING
 186   Sets the build type for ``make``-based generators. Possible values are
 187   Release, Debug, RelWithDebInfo and MinSizeRel. If you are using an IDE such as
 188   Visual Studio, you should use the IDE settings to set the build type.
 189   Be aware that Release and RelWithDebInfo use different optimization levels on
 190   most platforms.
 191
 192 **CMAKE_INSTALL_PREFIX**:PATH
 193   Path where LLVM will be installed if "make install" is invoked or the
 194   "install" target is built.
 195
 196 **LLVM_LIBDIR_SUFFIX**:STRING
 197   Extra suffix to append to the directory where libraries are to be
 198   installed. On a 64-bit architecture, one could use ``-DLLVM_LIBDIR_SUFFIX=64``
 199   to install libraries to ``/usr/lib64``.
 200
 201 **CMAKE_C_FLAGS**:STRING
 202   Extra flags to use when compiling C source files.
 203
 204 **CMAKE_CXX_FLAGS**:STRING
 205   Extra flags to use when compiling C++ source files.
 206
 207 .. _LLVM-specific variables:
 208
 209 LLVM-specific variables
 210 -----------------------
 211
 212 **LLVM_TARGETS_TO_BUILD**:STRING
 213   Semicolon-separated list of targets to build, or *all* for building all
 214   targets. Case-sensitive. Defaults to *all*. Example:
 215   ``-DLLVM_TARGETS_TO_BUILD="X86;PowerPC"``.
 216
 217 **LLVM_BUILD_TOOLS**:BOOL
 218   Build LLVM tools. Defaults to ON. Targets for building each tool are generated
 219   in any case. You can build a tool separately by invoking its target. For
 220   example, you can build *llvm-as* with a Makefile-based system by executing *make
 221   llvm-as* at the root of your build directory.
 222
 223 **LLVM_INCLUDE_TOOLS**:BOOL
 224   Generate build targets for the LLVM tools. Defaults to ON. You can use this
 225   option to disable the generation of build targets for the LLVM tools.
 226
 227 **LLVM_INSTALL_BINUTILS_SYMLINKS**:BOOL
 228   Install symlinks from the binutils tool names to the corresponding LLVM tools.
 229   For example, ar will be symlinked to llvm-ar.
 230
 231 **LLVM_BUILD_EXAMPLES**:BOOL
 232   Build LLVM examples. Defaults to OFF. Targets for building each example are
 233   generated in any case. See documentation for *LLVM_BUILD_TOOLS* above for more
 234   details.
 235
 236 **LLVM_INCLUDE_EXAMPLES**:BOOL
 237   Generate build targets for the LLVM examples. Defaults to ON. You can use this
 238   option to disable the generation of build targets for the LLVM examples.
 239
 240 **LLVM_BUILD_TESTS**:BOOL
 241   Build LLVM unit tests. Defaults to OFF. Targets for building each unit test
 242   are generated in any case. You can build a specific unit test using the
 243   targets defined under *unittests*, such as ADTTests, IRTests, SupportTests,
 244   etc. (Search for ``add_llvm_unittest`` in the subdirectories of *unittests*
 245   for a complete list of unit tests.) It is possible to build all unit tests
 246   with the target *UnitTests*.
 247
 248 **LLVM_INCLUDE_TESTS**:BOOL
 249   Generate build targets for the LLVM unit tests. Defaults to ON. You can use
 250   this option to disable the generation of build targets for the LLVM unit
 251   tests.
 252
 253 **LLVM_APPEND_VC_REV**:BOOL
 254   Embed version control revision info (svn revision number or Git revision id).
 255   The version info is provided by the ``LLVM_REVISION`` macro in
 256   ``llvm/include/llvm/Support/VCSRevision.h``. Developers using git who don't
 257   need revision info can disable this option to avoid re-linking most binaries
 258   after a branch switch. Defaults to ON.
 259
 260 **LLVM_ENABLE_THREADS**:BOOL
 261   Build with threads support, if available. Defaults to ON.
 262
 263 **LLVM_ENABLE_CXX1Y**:BOOL
 264   Build in C++1y mode, if available. Defaults to OFF.
 265
 266 **LLVM_ENABLE_ASSERTIONS**:BOOL
 267   Enables code assertions. Defaults to ON if and only if ``CMAKE_BUILD_TYPE``
 268   is *Debug*.
 269
 270 **LLVM_ENABLE_EH**:BOOL
 271   Build LLVM with exception-handling support. This is necessary if you wish to
 272   link against LLVM libraries and make use of C++ exceptions in your own code
 273   that need to propagate through LLVM code. Defaults to OFF.
 274
 275 **LLVM_ENABLE_EXPENSIVE_CHECKS**:BOOL
 276   Enable additional time/memory expensive checking. Defaults to OFF.
 277
 278 **LLVM_ENABLE_PIC**:BOOL
 279   Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports
 280   this flag. Some systems, like Windows, do not need this flag. Defaults to ON.
 281
 282 **LLVM_ENABLE_RTTI**:BOOL
 283   Build LLVM with run-time type information. Defaults to OFF.
 284
 285 **LLVM_ENABLE_WARNINGS**:BOOL
 286   Enable all compiler warnings. Defaults to ON.
 287
 288 **LLVM_ENABLE_PEDANTIC**:BOOL
 289   Enable pedantic mode. This disables compiler-specific extensions, if
 290   possible. Defaults to ON.
 291
 292 **LLVM_ENABLE_WERROR**:BOOL
 293   Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.
 294
 295 **LLVM_ABI_BREAKING_CHECKS**:STRING
 296   Used to decide if LLVM should be built with ABI breaking checks or
 297   not.  Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and
 298   `FORCE_OFF`.  `WITH_ASSERTS` turns on ABI breaking checks in an
 299   assertion enabled build.  `FORCE_ON` (`FORCE_OFF`) turns them on
 300   (off) irrespective of whether normal (`NDEBUG`-based) assertions are
 301   enabled or not.  A version of LLVM built with ABI breaking checks
 302   is not ABI compatible with a version built without it.
 303
 304 **LLVM_BUILD_32_BITS**:BOOL
 305   Build 32-bit executables and libraries on 64-bit systems. This option is
 306   available only on some 64-bit Unix systems. Defaults to OFF.
 307
 308 **LLVM_TARGET_ARCH**:STRING
 309   LLVM target to use for native code generation. This is required for JIT
 310   generation. It defaults to "host", meaning that it shall pick the architecture
 311   of the machine where LLVM is being built. If you are cross-compiling, set it
 312   to the target architecture name.
 313
 314 **LLVM_TABLEGEN**:STRING
 315   Full path to a native TableGen executable (usually named ``llvm-tblgen``). This is
 316   intended for cross-compiling: if the user sets this variable, no native
 317   TableGen will be created.
 318
 319 **LLVM_LIT_ARGS**:STRING
 320   Arguments given to lit.  ``make check`` and ``make clang-test`` are affected.
 321   By default, ``'-sv --no-progress-bar'`` on Visual C++ and Xcode, ``'-sv'`` on
 322   others.
 323
 324 **LLVM_LIT_TOOLS_DIR**:PATH
 325   The path to GnuWin32 tools for tests. Valid on Windows host.  Defaults to
 326   the empty string, in which case lit will look for tools needed for tests
 327   (e.g. ``grep``, ``sort``, etc.) in your %PATH%. If GnuWin32 is not in your
 328   %PATH%, then you can set this variable to the GnuWin32 directory so that
 329   lit can find tools needed for tests in that directory.
 330
 331 **LLVM_ENABLE_FFI**:BOOL
 332   Indicates whether the LLVM Interpreter will be linked with the Foreign Function
 333   Interface library (libffi) in order to enable calling external functions.
 334   If the library or its headers are installed in a custom
 335   location, you can also set the variables FFI_INCLUDE_DIR and
 336   FFI_LIBRARY_DIR to the directories where ffi.h and libffi.so can be found,
 337   respectively. Defaults to OFF.
 338
 339 **LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR**:PATH
 340   These variables specify the path to the source directory for the external
 341   LLVM projects Clang, lld, and Polly, respectively, relative to the top-level
 342   source directory.  If the in-tree subdirectory for an external project
 343   exists (e.g., llvm/tools/clang for Clang), then the corresponding variable
 344   will not be used.  If the variable for an external project does not point
 345   to a valid path, then that project will not be built.
 346
 347 **LLVM_ENABLE_PROJECTS**:STRING
 348   Semicolon-separated list of projects to build, or *all* for building all
 349   (clang, libcxx, libcxxabi, lldb, compiler-rt, lld, polly) projects.
 350   This flag assumes that projects are checked out side-by-side and not nested,
 351   i.e. clang needs to be in parallel of llvm instead of nested in `llvm/tools`.
 352   This feature allows to have one build for only LLVM and another for clang+llvm
 353   using the same source checkout.
 354
 355 **LLVM_EXTERNAL_PROJECTS**:STRING
 356   Semicolon-separated list of additional external projects to build as part of
 357   llvm. For each project LLVM_EXTERNAL_<NAME>_SOURCE_DIR have to be specified
 358   with the path for the source code of the project. Example:
 359   ``-DLLVM_EXTERNAL_PROJECTS="Foo;Bar"
 360   -DLLVM_EXTERNAL_FOO_SOURCE_DIR=/src/foo
 361   -DLLVM_EXTERNAL_BAR_SOURCE_DIR=/src/bar``.
 362
 363 **LLVM_USE_OPROFILE**:BOOL
 364   Enable building OProfile JIT support. Defaults to OFF.
 365
 366 **LLVM_PROFDATA_FILE**:PATH
 367   Path to a profdata file to pass into clang's -fprofile-instr-use flag. This
 368   can only be specified if you're building with clang.
 369
 370 **LLVM_USE_INTEL_JITEVENTS**:BOOL
 371   Enable building support for Intel JIT Events API. Defaults to OFF.
 372
 373 **LLVM_ENABLE_ZLIB**:BOOL
 374   Enable building with zlib to support compression/uncompression in LLVM tools.
 375   Defaults to ON.
 376
 377 **LLVM_ENABLE_DIA_SDK**:BOOL
 378   Enable building with MSVC DIA SDK for PDB debugging support. Available
 379   only with MSVC. Defaults to ON.
 380
 381 **LLVM_USE_SANITIZER**:STRING
 382   Define the sanitizer used to build LLVM binaries and tests. Possible values
 383   are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,
 384   and ``Address;Undefined``. Defaults to empty string.
 385
 386 **LLVM_ENABLE_LTO**:STRING
 387   Add ``-flto`` or ``-flto=`` flags to the compile and link command
 388   lines, enabling link-time optimization. Possible values are ``Off``,
 389   ``On``, ``Thin`` and ``Full``. Defaults to OFF.
 390
 391 **LLVM_USE_LINKER**:STRING
 392   Add ``-fuse-ld={name}`` to the link invocation. The possible value depend on
 393   your compiler, for clang the value can be an absolute path to your custom
 394   linker, otherwise clang will prefix the name with ``ld.`` and apply its usual
 395   search. For example to link LLVM with the Gold linker, cmake can be invoked
 396   with ``-DLLVM_USE_LINKER=gold``.
 397
 398 **LLVM_ENABLE_LLD**:BOOL
 399   This option is equivalent to `-DLLVM_USE_LINKER=lld`, except during a 2-stage
 400   build where a dependency is added from the first stage to the second ensuring
 401   that lld is built before stage2 begins.
 402
 403 **LLVM_PARALLEL_COMPILE_JOBS**:STRING
 404   Define the maximum number of concurrent compilation jobs.
 405
 406 **LLVM_PARALLEL_LINK_JOBS**:STRING
 407   Define the maximum number of concurrent link jobs.
 408
 409 **LLVM_BUILD_DOCS**:BOOL
 410   Adds all *enabled* documentation targets (i.e. Doxgyen and Sphinx targets) as
 411   dependencies of the default build targets.  This results in all of the (enabled)
 412   documentation targets being as part of a normal build.  If the ``install``
 413   target is run then this also enables all built documentation targets to be
 414   installed. Defaults to OFF.  To enable a particular documentation target, see
 415   see LLVM_ENABLE_SPHINX and LLVM_ENABLE_DOXYGEN.
 416
 417 **LLVM_ENABLE_DOXYGEN**:BOOL
 418   Enables the generation of browsable HTML documentation using doxygen.
 419   Defaults to OFF.
 420
 421 **LLVM_ENABLE_DOXYGEN_QT_HELP**:BOOL
 422   Enables the generation of a Qt Compressed Help file. Defaults to OFF.
 423   This affects the make target ``doxygen-llvm``. When enabled, apart from
 424   the normal HTML output generated by doxygen, this will produce a QCH file
 425   named ``org.llvm.qch``. You can then load this file into Qt Creator.
 426   This option is only useful in combination with ``-DLLVM_ENABLE_DOXYGEN=ON``;
 427   otherwise this has no effect.
 428
 429 **LLVM_DOXYGEN_QCH_FILENAME**:STRING
 430   The filename of the Qt Compressed Help file that will be generated when
 431   ``-DLLVM_ENABLE_DOXYGEN=ON`` and
 432   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to
 433   ``org.llvm.qch``.
 434   This option is only useful in combination with
 435   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
 436   otherwise it has no effect.
 437
 438 **LLVM_DOXYGEN_QHP_NAMESPACE**:STRING
 439   Namespace under which the intermediate Qt Help Project file lives. See `Qt
 440   Help Project`_
 441   for more information. Defaults to "org.llvm". This option is only useful in
 442   combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise
 443   it has no effect.
 444
 445 **LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING
 446   See `Qt Help Project`_ for
 447   more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which
 448   is a combination of the package name and version string. This filter can then
 449   be used in Qt Creator to select only documentation from LLVM when browsing
 450   through all the help files that you might have loaded. This option is only
 451   useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
 452   otherwise it has no effect.
 453
 454 .. _Qt Help Project: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters
 455
 456 **LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING
 457   The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's
 458   ``find_program()`` can find. This option is only useful in combination with
 459   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise it has no
 460   effect.
 461
 462 **LLVM_DOXYGEN_SVG**:BOOL
 463   Uses .svg files instead of .png files for graphs in the Doxygen output.
 464   Defaults to OFF.
 465
 466 **LLVM_INSTALL_DOXYGEN_HTML_DIR**:STRING
 467   The path to install Doxygen-generated HTML documentation to. This path can
 468   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 469   `share/doc/llvm/doxygen-html`.
 470
 471 **LLVM_ENABLE_SPHINX**:BOOL
 472   If specified, CMake will search for the ``sphinx-build`` executable and will make
 473   the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.
 474   Defaults to OFF.
 475
 476 **SPHINX_EXECUTABLE**:STRING
 477   The path to the ``sphinx-build`` executable detected by CMake.
 478   For installation instructions, see
 479   http://www.sphinx-doc.org/en/latest/install.html
 480
 481 **SPHINX_OUTPUT_HTML**:BOOL
 482   If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) then the targets for
 483   building the documentation as html are added (but not built by default unless
 484   ``LLVM_BUILD_DOCS`` is enabled). There is a target for each project in the
 485   source tree that uses sphinx (e.g.  ``docs-llvm-html``, ``docs-clang-html``
 486   and ``docs-lld-html``). Defaults to ON.
 487
 488 **SPHINX_OUTPUT_MAN**:BOOL
 489   If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) the targets for building
 490   the man pages are added (but not built by default unless ``LLVM_BUILD_DOCS``
 491   is enabled). Currently the only target added is ``docs-llvm-man``. Defaults
 492   to ON.
 493
 494 **SPHINX_WARNINGS_AS_ERRORS**:BOOL
 495   If enabled then sphinx documentation warnings will be treated as
 496   errors. Defaults to ON.
 497
 498 **LLVM_INSTALL_SPHINX_HTML_DIR**:STRING
 499   The path to install Sphinx-generated HTML documentation to. This path can
 500   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 501   `share/doc/llvm/html`.
 502
 503 **LLVM_INSTALL_OCAMLDOC_HTML_DIR**:STRING
 504   The path to install OCamldoc-generated HTML documentation to. This path can
 505   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 506   `share/doc/llvm/ocaml-html`.
 507
 508 **LLVM_CREATE_XCODE_TOOLCHAIN**:BOOL
 509   OS X Only: If enabled CMake will generate a target named
 510   'install-xcode-toolchain'. This target will create a directory at
 511   $CMAKE_INSTALL_PREFIX/Toolchains containing an xctoolchain directory which can
 512   be used to override the default system tools.
 513
 514 **LLVM_BUILD_LLVM_DYLIB**:BOOL
 515   If enabled, the target for building the libLLVM shared library is added.
 516   This library contains all of LLVM's components in a single shared library.
 517   Defaults to OFF. This cannot be used in conjunction with BUILD_SHARED_LIBS.
 518   Tools will only be linked to the libLLVM shared library if LLVM_LINK_LLVM_DYLIB
 519   is also ON.
 520   The components in the library can be customised by setting LLVM_DYLIB_COMPONENTS
 521   to a list of the desired components.
 522
 523 **LLVM_LINK_LLVM_DYLIB**:BOOL
 524   If enabled, tools will be linked with the libLLVM shared library. Defaults
 525   to OFF. Setting LLVM_LINK_LLVM_DYLIB to ON also sets LLVM_BUILD_LLVM_DYLIB
 526   to ON.
 527
 528 **BUILD_SHARED_LIBS**:BOOL
 529   Flag indicating if each LLVM component (e.g. Support) is built as a shared
 530   library (ON) or as a static library (OFF). Its default value is OFF. On
 531   Windows, shared libraries may be used when building with MinGW, including
 532   mingw-w64, but not when building with the Microsoft toolchain.
 533
 534   .. note:: BUILD_SHARED_LIBS is only recommended for use by LLVM developers.
 535             If you want to build LLVM as a shared library, you should use the
 536             ``LLVM_BUILD_LLVM_DYLIB`` option.
 537
 538 **LLVM_OPTIMIZED_TABLEGEN**:BOOL
 539   If enabled and building a debug or asserts build the CMake build system will
 540   generate a Release build tree to build a fully optimized tablegen for use
 541   during the build. Enabling this option can significantly speed up build times
 542   especially when building LLVM in Debug configurations.
 543
 544 **LLVM_REVERSE_ITERATION**:BOOL
 545   If enabled, all supported unordered llvm containers would be iterated in
 546   reverse order. This is useful for uncovering non-determinism caused by
 547   iteration of unordered containers.
 548
 549 **LLVM_BUILD_INSTRUMENTED_COVERAGE**:BOOL
 550   If enabled, `source-based code coverage
 551   <http://clang.llvm.org/docs/SourceBasedCodeCoverage.html>`_ instrumentation
 552   is enabled while building llvm.
 553
 554 CMake Caches
 555 ============
 556
 557 Recently LLVM and Clang have been adding some more complicated build system
 558 features. Utilizing these new features often involves a complicated chain of
 559 CMake variables passed on the command line. Clang provides a collection of CMake
 560 cache scripts to make these features more approachable.
 561
 562 CMake cache files are utilized using CMake's -C flag:
 563
 564 .. code-block:: console
 565
 566   $ cmake -C <path to cache file> <path to sources>
 567
 568 CMake cache scripts are processed in an isolated scope, only cached variables
 569 remain set when the main configuration runs. CMake cached variables do not reset
 570 variables that are already set unless the FORCE option is specified.
 571
 572 A few notes about CMake Caches:
 573
 574 - Order of command line arguments is important
 575
 576   - -D arguments specified before -C are set before the cache is processed and
 577     can be read inside the cache file
 578   - -D arguments specified after -C are set after the cache is processed and
 579     are unset inside the cache file
 580
 581 - All -D arguments will override cache file settings
 582 - CMAKE_TOOLCHAIN_FILE is evaluated after both the cache file and the command
 583   line arguments
 584 - It is recommended that all -D options should be specified *before* -C
 585
 586 For more information about some of the advanced build configurations supported
 587 via Cache files see :doc:`AdvancedBuilds`.
 588
 589 Executing the test suite
 590 ========================
 591
 592 Testing is performed when the *check-all* target is built. For instance, if you are
 593 using Makefiles, execute this command in the root of your build directory:
 594
 595 .. code-block:: console
 596
 597   $ make check-all
 598
 599 On Visual Studio, you may run tests by building the project "check-all".
 600 For more information about testing, see the :doc:`TestingGuide`.
 601
 602 Cross compiling
 603 ===============
 604
 605 See `this wiki page <http://www.vtk.org/Wiki/CMake_Cross_Compiling>`_ for
 606 generic instructions on how to cross-compile with CMake. It goes into detailed
 607 explanations and may seem daunting, but it is not. On the wiki page there are
 608 several examples including toolchain files. Go directly to `this section
 609 <http://www.vtk.org/Wiki/CMake_Cross_Compiling#Information_how_to_set_up_various_cross_compiling_toolchains>`_
 610 for a quick solution.
 611
 612 Also see the `LLVM-specific variables`_ section for variables used when
 613 cross-compiling.
 614
 615 Embedding LLVM in your project
 616 ==============================
 617
 618 From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export
 619 LLVM libraries as importable CMake targets. This means that clients of LLVM can
 620 now reliably use CMake to develop their own LLVM-based projects against an
 621 installed version of LLVM regardless of how it was built.
 622
 623 Here is a simple example of a CMakeLists.txt file that imports the LLVM libraries
 624 and uses them to build a simple application ``simple-tool``.
 625
 626 .. code-block:: cmake
 627
 628   cmake_minimum_required(VERSION 3.4.3)
 629   project(SimpleProject)
 630
 631   find_package(LLVM REQUIRED CONFIG)
 632
 633   message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
 634   message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
 635
 636   # Set your project compile flags.
 637   # E.g. if using the C++ header files
 638   # you will need to enable C++11 support
 639   # for your compiler.
 640
 641   include_directories(${LLVM_INCLUDE_DIRS})
 642   add_definitions(${LLVM_DEFINITIONS})
 643
 644   # Now build our tools
 645   add_executable(simple-tool tool.cpp)
 646
 647   # Find the libraries that correspond to the LLVM components
 648   # that we wish to use
 649   llvm_map_components_to_libnames(llvm_libs support core irreader)
 650
 651   # Link against LLVM libraries
 652   target_link_libraries(simple-tool ${llvm_libs})
 653
 654 The ``find_package(...)`` directive when used in CONFIG mode (as in the above
 655 example) will look for the ``LLVMConfig.cmake`` file in various locations (see
 656 cmake manual for details).  It creates a ``LLVM_DIR`` cache entry to save the
 657 directory where ``LLVMConfig.cmake`` is found or allows the user to specify the
 658 directory (e.g. by passing ``-DLLVM_DIR=/usr/lib/cmake/llvm`` to
 659 the ``cmake`` command or by setting it directly in ``ccmake`` or ``cmake-gui``).
 660
 661 This file is available in two different locations.
 662
 663 * ``<INSTALL_PREFIX>/lib/cmake/llvm/LLVMConfig.cmake`` where
 664   ``<INSTALL_PREFIX>`` is the install prefix of an installed version of LLVM.
 665   On Linux typically this is ``/usr/lib/cmake/llvm/LLVMConfig.cmake``.
 666
 667 * ``<LLVM_BUILD_ROOT>/lib/cmake/llvm/LLVMConfig.cmake`` where
 668   ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note: this is only
 669   available when building LLVM with CMake.**
 670
 671 If LLVM is installed in your operating system's normal installation prefix (e.g.
 672 on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will
 673 automatically find LLVM if it is installed correctly. If LLVM is not installed
 674 or you wish to build directly against the LLVM build tree you can use
 675 ``LLVM_DIR`` as previously mentioned.
 676
 677 The ``LLVMConfig.cmake`` file sets various useful variables. Notable variables
 678 include
 679
 680 ``LLVM_CMAKE_DIR``
 681   The path to the LLVM CMake directory (i.e. the directory containing
 682   LLVMConfig.cmake).
 683
 684 ``LLVM_DEFINITIONS``
 685   A list of preprocessor defines that should be used when building against LLVM.
 686
 687 ``LLVM_ENABLE_ASSERTIONS``
 688   This is set to ON if LLVM was built with assertions, otherwise OFF.
 689
 690 ``LLVM_ENABLE_EH``
 691   This is set to ON if LLVM was built with exception handling (EH) enabled,
 692   otherwise OFF.
 693
 694 ``LLVM_ENABLE_RTTI``
 695   This is set to ON if LLVM was built with run time type information (RTTI),
 696   otherwise OFF.
 697
 698 ``LLVM_INCLUDE_DIRS``
 699   A list of include paths to directories containing LLVM header files.
 700
 701 ``LLVM_PACKAGE_VERSION``
 702   The LLVM version. This string can be used with CMake conditionals, e.g., ``if
 703   (${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.
 704
 705 ``LLVM_TOOLS_BINARY_DIR``
 706   The path to the directory containing the LLVM tools (e.g. ``llvm-as``).
 707
 708 Notice that in the above example we link ``simple-tool`` against several LLVM
 709 libraries. The list of libraries is determined by using the
 710 ``llvm_map_components_to_libnames()`` CMake function. For a list of available
 711 components look at the output of running ``llvm-config --components``.
 712
 713 Note that for LLVM < 3.5 ``llvm_map_components_to_libraries()`` was
 714 used instead of ``llvm_map_components_to_libnames()``. This is now deprecated
 715 and will be removed in a future version of LLVM.
 716
 717 .. _cmake-out-of-source-pass:
 718
 719 Developing LLVM passes out of source
 720 ------------------------------------
 721
 722 It is possible to develop LLVM passes out of LLVM's source tree (i.e. against an
 723 installed or built LLVM). An example of a project layout is provided below.
 724
 725 .. code-block:: none
 726
 727   <project dir>/
 728       |
 729       CMakeLists.txt
 730       <pass name>/
 731           |
 732           CMakeLists.txt
 733           Pass.cpp
 734           ...
 735
 736 Contents of ``<project dir>/CMakeLists.txt``:
 737
 738 .. code-block:: cmake
 739
 740   find_package(LLVM REQUIRED CONFIG)
 741
 742   add_definitions(${LLVM_DEFINITIONS})
 743   include_directories(${LLVM_INCLUDE_DIRS})
 744
 745   add_subdirectory(<pass name>)
 746
 747 Contents of ``<project dir>/<pass name>/CMakeLists.txt``:
 748
 749 .. code-block:: cmake
 750
 751   add_library(LLVMPassname MODULE Pass.cpp)
 752
 753 Note if you intend for this pass to be merged into the LLVM source tree at some
 754 point in the future it might make more sense to use LLVM's internal
 755 ``add_llvm_loadable_module`` function instead by...
 756
 757
 758 Adding the following to ``<project dir>/CMakeLists.txt`` (after
 759 ``find_package(LLVM ...)``)
 760
 761 .. code-block:: cmake
 762
 763   list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
 764   include(AddLLVM)
 765
 766 And then changing ``<project dir>/<pass name>/CMakeLists.txt`` to
 767
 768 .. code-block:: cmake
 769
 770   add_llvm_loadable_module(LLVMPassname
 771     Pass.cpp
 772     )
 773
 774 When you are done developing your pass, you may wish to integrate it
 775 into the LLVM source tree. You can achieve it in two easy steps:
 776
 777 #. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.
 778
 779 #. Adding ``add_subdirectory(<pass name>)`` line into
 780    ``<LLVM root>/lib/Transform/CMakeLists.txt``.
 781
 782 Compiler/Platform-specific topics
 783 =================================
 784
 785 Notes for specific compilers and/or platforms.
 786
 787 Microsoft Visual C++
 788 --------------------
 789
 790 **LLVM_COMPILER_JOBS**:STRING
 791   Specifies the maximum number of parallel compiler jobs to use per project
 792   when building with msbuild or Visual Studio. Only supported for the Visual
 793   Studio 2010 CMake generator. 0 means use all processors. Default is 0.