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_BUILD_BENCHMARKS**:BOOL
 254   Adds benchmarks to the list of default targets. Defaults to OFF.
 255
 256 **LLVM_INCLUDE_BENCHMARKS**:BOOL
 257   Generate build targets for the LLVM benchmarks. Defaults to ON.
 258
 259 **LLVM_APPEND_VC_REV**:BOOL
 260   Embed version control revision info (svn revision number or Git revision id).
 261   The version info is provided by the ``LLVM_REVISION`` macro in
 262   ``llvm/include/llvm/Support/VCSRevision.h``. Developers using git who don't
 263   need revision info can disable this option to avoid re-linking most binaries
 264   after a branch switch. Defaults to ON.
 265
 266 **LLVM_ENABLE_THREADS**:BOOL
 267   Build with threads support, if available. Defaults to ON.
 268
 269 **LLVM_ENABLE_UNWIND_TABLES**:BOOL
 270   Enable unwind tables in the binary.  Disabling unwind tables can reduce the
 271   size of the libraries.  Defaults to ON.
 272
 273 **LLVM_CXX_STD**:STRING
 274   Build with the specified C++ standard. Defaults to "c++11".
 275
 276 **LLVM_ENABLE_ASSERTIONS**:BOOL
 277   Enables code assertions. Defaults to ON if and only if ``CMAKE_BUILD_TYPE``
 278   is *Debug*.
 279
 280 **LLVM_ENABLE_EH**:BOOL
 281   Build LLVM with exception-handling support. This is necessary if you wish to
 282   link against LLVM libraries and make use of C++ exceptions in your own code
 283   that need to propagate through LLVM code. Defaults to OFF.
 284
 285 **LLVM_ENABLE_EXPENSIVE_CHECKS**:BOOL
 286   Enable additional time/memory expensive checking. Defaults to OFF.
 287
 288 **LLVM_ENABLE_IDE**:BOOL
 289   Tell the build system that an IDE is being used. This in turn disables the
 290   creation of certain convenience build system targets, such as the various
 291   ``install-*`` and ``check-*`` targets, since IDEs don't always deal well with
 292   a large number of targets. This is usually autodetected, but it can be
 293   configured manually to explicitly control the generation of those targets. One
 294   scenario where a manual override may be desirable is when using Visual Studio
 295   2017's CMake integration, which would not be detected as an IDE otherwise.
 296
 297 **LLVM_ENABLE_PIC**:BOOL
 298   Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports
 299   this flag. Some systems, like Windows, do not need this flag. Defaults to ON.
 300
 301 **LLVM_ENABLE_RTTI**:BOOL
 302   Build LLVM with run-time type information. Defaults to OFF.
 303
 304 **LLVM_ENABLE_WARNINGS**:BOOL
 305   Enable all compiler warnings. Defaults to ON.
 306
 307 **LLVM_ENABLE_PEDANTIC**:BOOL
 308   Enable pedantic mode. This disables compiler-specific extensions, if
 309   possible. Defaults to ON.
 310
 311 **LLVM_ENABLE_WERROR**:BOOL
 312   Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.
 313
 314 **LLVM_ABI_BREAKING_CHECKS**:STRING
 315   Used to decide if LLVM should be built with ABI breaking checks or
 316   not.  Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and
 317   `FORCE_OFF`.  `WITH_ASSERTS` turns on ABI breaking checks in an
 318   assertion enabled build.  `FORCE_ON` (`FORCE_OFF`) turns them on
 319   (off) irrespective of whether normal (`NDEBUG`-based) assertions are
 320   enabled or not.  A version of LLVM built with ABI breaking checks
 321   is not ABI compatible with a version built without it.
 322
 323 **LLVM_BUILD_32_BITS**:BOOL
 324   Build 32-bit executables and libraries on 64-bit systems. This option is
 325   available only on some 64-bit Unix systems. Defaults to OFF.
 326
 327 **LLVM_TARGET_ARCH**:STRING
 328   LLVM target to use for native code generation. This is required for JIT
 329   generation. It defaults to "host", meaning that it shall pick the architecture
 330   of the machine where LLVM is being built. If you are cross-compiling, set it
 331   to the target architecture name.
 332
 333 **LLVM_TABLEGEN**:STRING
 334   Full path to a native TableGen executable (usually named ``llvm-tblgen``). This is
 335   intended for cross-compiling: if the user sets this variable, no native
 336   TableGen will be created.
 337
 338 **LLVM_LIT_ARGS**:STRING
 339   Arguments given to lit.  ``make check`` and ``make clang-test`` are affected.
 340   By default, ``'-sv --no-progress-bar'`` on Visual C++ and Xcode, ``'-sv'`` on
 341   others.
 342
 343 **LLVM_LIT_TOOLS_DIR**:PATH
 344   The path to GnuWin32 tools for tests. Valid on Windows host.  Defaults to
 345   the empty string, in which case lit will look for tools needed for tests
 346   (e.g. ``grep``, ``sort``, etc.) in your %PATH%. If GnuWin32 is not in your
 347   %PATH%, then you can set this variable to the GnuWin32 directory so that
 348   lit can find tools needed for tests in that directory.
 349
 350 **LLVM_ENABLE_FFI**:BOOL
 351   Indicates whether the LLVM Interpreter will be linked with the Foreign Function
 352   Interface library (libffi) in order to enable calling external functions.
 353   If the library or its headers are installed in a custom
 354   location, you can also set the variables FFI_INCLUDE_DIR and
 355   FFI_LIBRARY_DIR to the directories where ffi.h and libffi.so can be found,
 356   respectively. Defaults to OFF.
 357
 358 **LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR**:PATH
 359   These variables specify the path to the source directory for the external
 360   LLVM projects Clang, lld, and Polly, respectively, relative to the top-level
 361   source directory.  If the in-tree subdirectory for an external project
 362   exists (e.g., llvm/tools/clang for Clang), then the corresponding variable
 363   will not be used.  If the variable for an external project does not point
 364   to a valid path, then that project will not be built.
 365
 366 **LLVM_ENABLE_PROJECTS**:STRING
 367   Semicolon-separated list of projects to build, or *all* for building all
 368   (clang, libcxx, libcxxabi, lldb, compiler-rt, lld, polly) projects.
 369   This flag assumes that projects are checked out side-by-side and not nested,
 370   i.e. clang needs to be in parallel of llvm instead of nested in `llvm/tools`.
 371   This feature allows to have one build for only LLVM and another for clang+llvm
 372   using the same source checkout.
 373
 374 **LLVM_EXTERNAL_PROJECTS**:STRING
 375   Semicolon-separated list of additional external projects to build as part of
 376   llvm. For each project LLVM_EXTERNAL_<NAME>_SOURCE_DIR have to be specified
 377   with the path for the source code of the project. Example:
 378   ``-DLLVM_EXTERNAL_PROJECTS="Foo;Bar"
 379   -DLLVM_EXTERNAL_FOO_SOURCE_DIR=/src/foo
 380   -DLLVM_EXTERNAL_BAR_SOURCE_DIR=/src/bar``.
 381
 382 **LLVM_USE_OPROFILE**:BOOL
 383   Enable building OProfile JIT support. Defaults to OFF.
 384
 385 **LLVM_PROFDATA_FILE**:PATH
 386   Path to a profdata file to pass into clang's -fprofile-instr-use flag. This
 387   can only be specified if you're building with clang.
 388
 389 **LLVM_USE_INTEL_JITEVENTS**:BOOL
 390   Enable building support for Intel JIT Events API. Defaults to OFF.
 391
 392 **LLVM_ENABLE_LIBPFM**:BOOL
 393   Enable building with libpfm to support hardware counter measurements in LLVM
 394   tools.
 395   Defaults to ON.
 396
 397   **LLVM_USE_PERF**:BOOL
 398   Enable building support for Perf (linux profiling tool) JIT support. Defaults to OFF.
 399
 400 **LLVM_ENABLE_ZLIB**:BOOL
 401   Enable building with zlib to support compression/uncompression in LLVM tools.
 402   Defaults to ON.
 403
 404 **LLVM_ENABLE_DIA_SDK**:BOOL
 405   Enable building with MSVC DIA SDK for PDB debugging support. Available
 406   only with MSVC. Defaults to ON.
 407
 408 **LLVM_USE_SANITIZER**:STRING
 409   Define the sanitizer used to build LLVM binaries and tests. Possible values
 410   are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,
 411   and ``Address;Undefined``. Defaults to empty string.
 412
 413 **LLVM_ENABLE_LTO**:STRING
 414   Add ``-flto`` or ``-flto=`` flags to the compile and link command
 415   lines, enabling link-time optimization. Possible values are ``Off``,
 416   ``On``, ``Thin`` and ``Full``. Defaults to OFF.
 417
 418 **LLVM_USE_LINKER**:STRING
 419   Add ``-fuse-ld={name}`` to the link invocation. The possible value depend on
 420   your compiler, for clang the value can be an absolute path to your custom
 421   linker, otherwise clang will prefix the name with ``ld.`` and apply its usual
 422   search. For example to link LLVM with the Gold linker, cmake can be invoked
 423   with ``-DLLVM_USE_LINKER=gold``.
 424
 425 **LLVM_ENABLE_LLD**:BOOL
 426   This option is equivalent to `-DLLVM_USE_LINKER=lld`, except during a 2-stage
 427   build where a dependency is added from the first stage to the second ensuring
 428   that lld is built before stage2 begins.
 429
 430 **LLVM_PARALLEL_COMPILE_JOBS**:STRING
 431   Define the maximum number of concurrent compilation jobs.
 432
 433 **LLVM_PARALLEL_LINK_JOBS**:STRING
 434   Define the maximum number of concurrent link jobs.
 435
 436 **LLVM_BUILD_DOCS**:BOOL
 437   Adds all *enabled* documentation targets (i.e. Doxgyen and Sphinx targets) as
 438   dependencies of the default build targets.  This results in all of the (enabled)
 439   documentation targets being as part of a normal build.  If the ``install``
 440   target is run then this also enables all built documentation targets to be
 441   installed. Defaults to OFF.  To enable a particular documentation target, see
 442   see LLVM_ENABLE_SPHINX and LLVM_ENABLE_DOXYGEN.
 443
 444 **LLVM_ENABLE_DOXYGEN**:BOOL
 445   Enables the generation of browsable HTML documentation using doxygen.
 446   Defaults to OFF.
 447
 448 **LLVM_ENABLE_DOXYGEN_QT_HELP**:BOOL
 449   Enables the generation of a Qt Compressed Help file. Defaults to OFF.
 450   This affects the make target ``doxygen-llvm``. When enabled, apart from
 451   the normal HTML output generated by doxygen, this will produce a QCH file
 452   named ``org.llvm.qch``. You can then load this file into Qt Creator.
 453   This option is only useful in combination with ``-DLLVM_ENABLE_DOXYGEN=ON``;
 454   otherwise this has no effect.
 455
 456 **LLVM_DOXYGEN_QCH_FILENAME**:STRING
 457   The filename of the Qt Compressed Help file that will be generated when
 458   ``-DLLVM_ENABLE_DOXYGEN=ON`` and
 459   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to
 460   ``org.llvm.qch``.
 461   This option is only useful in combination with
 462   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
 463   otherwise it has no effect.
 464
 465 **LLVM_DOXYGEN_QHP_NAMESPACE**:STRING
 466   Namespace under which the intermediate Qt Help Project file lives. See `Qt
 467   Help Project`_
 468   for more information. Defaults to "org.llvm". This option is only useful in
 469   combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise
 470   it has no effect.
 471
 472 **LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING
 473   See `Qt Help Project`_ for
 474   more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which
 475   is a combination of the package name and version string. This filter can then
 476   be used in Qt Creator to select only documentation from LLVM when browsing
 477   through all the help files that you might have loaded. This option is only
 478   useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
 479   otherwise it has no effect.
 480
 481 .. _Qt Help Project: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters
 482
 483 **LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING
 484   The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's
 485   ``find_program()`` can find. This option is only useful in combination with
 486   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise it has no
 487   effect.
 488
 489 **LLVM_DOXYGEN_SVG**:BOOL
 490   Uses .svg files instead of .png files for graphs in the Doxygen output.
 491   Defaults to OFF.
 492
 493 **LLVM_INSTALL_DOXYGEN_HTML_DIR**:STRING
 494   The path to install Doxygen-generated HTML documentation to. This path can
 495   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 496   `share/doc/llvm/doxygen-html`.
 497
 498 **LLVM_ENABLE_SPHINX**:BOOL
 499   If specified, CMake will search for the ``sphinx-build`` executable and will make
 500   the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.
 501   Defaults to OFF.
 502
 503 **SPHINX_EXECUTABLE**:STRING
 504   The path to the ``sphinx-build`` executable detected by CMake.
 505   For installation instructions, see
 506   http://www.sphinx-doc.org/en/latest/install.html
 507
 508 **SPHINX_OUTPUT_HTML**:BOOL
 509   If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) then the targets for
 510   building the documentation as html are added (but not built by default unless
 511   ``LLVM_BUILD_DOCS`` is enabled). There is a target for each project in the
 512   source tree that uses sphinx (e.g.  ``docs-llvm-html``, ``docs-clang-html``
 513   and ``docs-lld-html``). Defaults to ON.
 514
 515 **SPHINX_OUTPUT_MAN**:BOOL
 516   If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) the targets for building
 517   the man pages are added (but not built by default unless ``LLVM_BUILD_DOCS``
 518   is enabled). Currently the only target added is ``docs-llvm-man``. Defaults
 519   to ON.
 520
 521 **SPHINX_WARNINGS_AS_ERRORS**:BOOL
 522   If enabled then sphinx documentation warnings will be treated as
 523   errors. Defaults to ON.
 524
 525 **LLVM_INSTALL_SPHINX_HTML_DIR**:STRING
 526   The path to install Sphinx-generated HTML documentation to. This path can
 527   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 528   `share/doc/llvm/html`.
 529
 530 **LLVM_INSTALL_OCAMLDOC_HTML_DIR**:STRING
 531   The path to install OCamldoc-generated HTML documentation to. This path can
 532   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
 533   `share/doc/llvm/ocaml-html`.
 534
 535 **LLVM_CREATE_XCODE_TOOLCHAIN**:BOOL
 536   OS X Only: If enabled CMake will generate a target named
 537   'install-xcode-toolchain'. This target will create a directory at
 538   $CMAKE_INSTALL_PREFIX/Toolchains containing an xctoolchain directory which can
 539   be used to override the default system tools.
 540
 541 **LLVM_BUILD_LLVM_DYLIB**:BOOL
 542   If enabled, the target for building the libLLVM shared library is added.
 543   This library contains all of LLVM's components in a single shared library.
 544   Defaults to OFF. This cannot be used in conjunction with BUILD_SHARED_LIBS.
 545   Tools will only be linked to the libLLVM shared library if LLVM_LINK_LLVM_DYLIB
 546   is also ON.
 547   The components in the library can be customised by setting LLVM_DYLIB_COMPONENTS
 548   to a list of the desired components.
 549
 550 **LLVM_LINK_LLVM_DYLIB**:BOOL
 551   If enabled, tools will be linked with the libLLVM shared library. Defaults
 552   to OFF. Setting LLVM_LINK_LLVM_DYLIB to ON also sets LLVM_BUILD_LLVM_DYLIB
 553   to ON.
 554
 555 **BUILD_SHARED_LIBS**:BOOL
 556   Flag indicating if each LLVM component (e.g. Support) is built as a shared
 557   library (ON) or as a static library (OFF). Its default value is OFF. On
 558   Windows, shared libraries may be used when building with MinGW, including
 559   mingw-w64, but not when building with the Microsoft toolchain.
 560
 561   .. note:: BUILD_SHARED_LIBS is only recommended for use by LLVM developers.
 562             If you want to build LLVM as a shared library, you should use the
 563             ``LLVM_BUILD_LLVM_DYLIB`` option.
 564
 565 **LLVM_OPTIMIZED_TABLEGEN**:BOOL
 566   If enabled and building a debug or asserts build the CMake build system will
 567   generate a Release build tree to build a fully optimized tablegen for use
 568   during the build. Enabling this option can significantly speed up build times
 569   especially when building LLVM in Debug configurations.
 570
 571 **LLVM_REVERSE_ITERATION**:BOOL
 572   If enabled, all supported unordered llvm containers would be iterated in
 573   reverse order. This is useful for uncovering non-determinism caused by
 574   iteration of unordered containers.
 575
 576 **LLVM_BUILD_INSTRUMENTED_COVERAGE**:BOOL
 577   If enabled, `source-based code coverage
 578   <http://clang.llvm.org/docs/SourceBasedCodeCoverage.html>`_ instrumentation
 579   is enabled while building llvm.
 580
 581 **LLVM_CCACHE_BUILD**:BOOL
 582   If enabled and the ``ccache`` program is available, then LLVM will be
 583   built using ``ccache`` to speed up rebuilds of LLVM and its components.
 584   Defaults to OFF.  The size and location of the cache maintained
 585   by ``ccache`` can be adjusted via the LLVM_CCACHE_MAXSIZE and LLVM_CCACHE_DIR
 586   options, which are passed to the CCACHE_MAXSIZE and CCACHE_DIR environment
 587   variables, respectively.
 588
 589 **LLVM_FORCE_USE_OLD_TOOLCHAIN**:BOOL
 590   If enabled, the compiler and standard library versions won't be checked. LLVM
 591   may not compile at all, or might fail at runtime due to known bugs in these
 592   toolchains.
 593
 594 **LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN**:BOOL
 595   If enabled, the compiler version check will only warn when using a toolchain
 596   which is about to be deprecated, instead of emitting an error.
 597
 598 **LLVM_USE_NEWPM**:BOOL
 599   If enabled, use the experimental new pass manager.
 600
 601 CMake Caches
 602 ============
 603
 604 Recently LLVM and Clang have been adding some more complicated build system
 605 features. Utilizing these new features often involves a complicated chain of
 606 CMake variables passed on the command line. Clang provides a collection of CMake
 607 cache scripts to make these features more approachable.
 608
 609 CMake cache files are utilized using CMake's -C flag:
 610
 611 .. code-block:: console
 612
 613   $ cmake -C <path to cache file> <path to sources>
 614
 615 CMake cache scripts are processed in an isolated scope, only cached variables
 616 remain set when the main configuration runs. CMake cached variables do not reset
 617 variables that are already set unless the FORCE option is specified.
 618
 619 A few notes about CMake Caches:
 620
 621 - Order of command line arguments is important
 622
 623   - -D arguments specified before -C are set before the cache is processed and
 624     can be read inside the cache file
 625   - -D arguments specified after -C are set after the cache is processed and
 626     are unset inside the cache file
 627
 628 - All -D arguments will override cache file settings
 629 - CMAKE_TOOLCHAIN_FILE is evaluated after both the cache file and the command
 630   line arguments
 631 - It is recommended that all -D options should be specified *before* -C
 632
 633 For more information about some of the advanced build configurations supported
 634 via Cache files see :doc:`AdvancedBuilds`.
 635
 636 Executing the Tests
 637 ===================
 638
 639 Testing is performed when the *check-all* target is built. For instance, if you are
 640 using Makefiles, execute this command in the root of your build directory:
 641
 642 .. code-block:: console
 643
 644   $ make check-all
 645
 646 On Visual Studio, you may run tests by building the project "check-all".
 647 For more information about testing, see the :doc:`TestingGuide`.
 648
 649 Cross compiling
 650 ===============
 651
 652 See `this wiki page <http://www.vtk.org/Wiki/CMake_Cross_Compiling>`_ for
 653 generic instructions on how to cross-compile with CMake. It goes into detailed
 654 explanations and may seem daunting, but it is not. On the wiki page there are
 655 several examples including toolchain files. Go directly to `this section
 656 <http://www.vtk.org/Wiki/CMake_Cross_Compiling#Information_how_to_set_up_various_cross_compiling_toolchains>`_
 657 for a quick solution.
 658
 659 Also see the `LLVM-specific variables`_ section for variables used when
 660 cross-compiling.
 661
 662 Embedding LLVM in your project
 663 ==============================
 664
 665 From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export
 666 LLVM libraries as importable CMake targets. This means that clients of LLVM can
 667 now reliably use CMake to develop their own LLVM-based projects against an
 668 installed version of LLVM regardless of how it was built.
 669
 670 Here is a simple example of a CMakeLists.txt file that imports the LLVM libraries
 671 and uses them to build a simple application ``simple-tool``.
 672
 673 .. code-block:: cmake
 674
 675   cmake_minimum_required(VERSION 3.4.3)
 676   project(SimpleProject)
 677
 678   find_package(LLVM REQUIRED CONFIG)
 679
 680   message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
 681   message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
 682
 683   # Set your project compile flags.
 684   # E.g. if using the C++ header files
 685   # you will need to enable C++11 support
 686   # for your compiler.
 687
 688   include_directories(${LLVM_INCLUDE_DIRS})
 689   add_definitions(${LLVM_DEFINITIONS})
 690
 691   # Now build our tools
 692   add_executable(simple-tool tool.cpp)
 693
 694   # Find the libraries that correspond to the LLVM components
 695   # that we wish to use
 696   llvm_map_components_to_libnames(llvm_libs support core irreader)
 697
 698   # Link against LLVM libraries
 699   target_link_libraries(simple-tool ${llvm_libs})
 700
 701 The ``find_package(...)`` directive when used in CONFIG mode (as in the above
 702 example) will look for the ``LLVMConfig.cmake`` file in various locations (see
 703 cmake manual for details).  It creates a ``LLVM_DIR`` cache entry to save the
 704 directory where ``LLVMConfig.cmake`` is found or allows the user to specify the
 705 directory (e.g. by passing ``-DLLVM_DIR=/usr/lib/cmake/llvm`` to
 706 the ``cmake`` command or by setting it directly in ``ccmake`` or ``cmake-gui``).
 707
 708 This file is available in two different locations.
 709
 710 * ``<INSTALL_PREFIX>/lib/cmake/llvm/LLVMConfig.cmake`` where
 711   ``<INSTALL_PREFIX>`` is the install prefix of an installed version of LLVM.
 712   On Linux typically this is ``/usr/lib/cmake/llvm/LLVMConfig.cmake``.
 713
 714 * ``<LLVM_BUILD_ROOT>/lib/cmake/llvm/LLVMConfig.cmake`` where
 715   ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note: this is only
 716   available when building LLVM with CMake.**
 717
 718 If LLVM is installed in your operating system's normal installation prefix (e.g.
 719 on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will
 720 automatically find LLVM if it is installed correctly. If LLVM is not installed
 721 or you wish to build directly against the LLVM build tree you can use
 722 ``LLVM_DIR`` as previously mentioned.
 723
 724 The ``LLVMConfig.cmake`` file sets various useful variables. Notable variables
 725 include
 726
 727 ``LLVM_CMAKE_DIR``
 728   The path to the LLVM CMake directory (i.e. the directory containing
 729   LLVMConfig.cmake).
 730
 731 ``LLVM_DEFINITIONS``
 732   A list of preprocessor defines that should be used when building against LLVM.
 733
 734 ``LLVM_ENABLE_ASSERTIONS``
 735   This is set to ON if LLVM was built with assertions, otherwise OFF.
 736
 737 ``LLVM_ENABLE_EH``
 738   This is set to ON if LLVM was built with exception handling (EH) enabled,
 739   otherwise OFF.
 740
 741 ``LLVM_ENABLE_RTTI``
 742   This is set to ON if LLVM was built with run time type information (RTTI),
 743   otherwise OFF.
 744
 745 ``LLVM_INCLUDE_DIRS``
 746   A list of include paths to directories containing LLVM header files.
 747
 748 ``LLVM_PACKAGE_VERSION``
 749   The LLVM version. This string can be used with CMake conditionals, e.g., ``if
 750   (${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.
 751
 752 ``LLVM_TOOLS_BINARY_DIR``
 753   The path to the directory containing the LLVM tools (e.g. ``llvm-as``).
 754
 755 Notice that in the above example we link ``simple-tool`` against several LLVM
 756 libraries. The list of libraries is determined by using the
 757 ``llvm_map_components_to_libnames()`` CMake function. For a list of available
 758 components look at the output of running ``llvm-config --components``.
 759
 760 Note that for LLVM < 3.5 ``llvm_map_components_to_libraries()`` was
 761 used instead of ``llvm_map_components_to_libnames()``. This is now deprecated
 762 and will be removed in a future version of LLVM.
 763
 764 .. _cmake-out-of-source-pass:
 765
 766 Developing LLVM passes out of source
 767 ------------------------------------
 768
 769 It is possible to develop LLVM passes out of LLVM's source tree (i.e. against an
 770 installed or built LLVM). An example of a project layout is provided below.
 771
 772 .. code-block:: none
 773
 774   <project dir>/
 775       |
 776       CMakeLists.txt
 777       <pass name>/
 778           |
 779           CMakeLists.txt
 780           Pass.cpp
 781           ...
 782
 783 Contents of ``<project dir>/CMakeLists.txt``:
 784
 785 .. code-block:: cmake
 786
 787   find_package(LLVM REQUIRED CONFIG)
 788
 789   add_definitions(${LLVM_DEFINITIONS})
 790   include_directories(${LLVM_INCLUDE_DIRS})
 791
 792   add_subdirectory(<pass name>)
 793
 794 Contents of ``<project dir>/<pass name>/CMakeLists.txt``:
 795
 796 .. code-block:: cmake
 797
 798   add_library(LLVMPassname MODULE Pass.cpp)
 799
 800 Note if you intend for this pass to be merged into the LLVM source tree at some
 801 point in the future it might make more sense to use LLVM's internal
 802 ``add_llvm_library`` function with the MODULE argument instead by...
 803
 804
 805 Adding the following to ``<project dir>/CMakeLists.txt`` (after
 806 ``find_package(LLVM ...)``)
 807
 808 .. code-block:: cmake
 809
 810   list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
 811   include(AddLLVM)
 812
 813 And then changing ``<project dir>/<pass name>/CMakeLists.txt`` to
 814
 815 .. code-block:: cmake
 816
 817   add_llvm_library(LLVMPassname MODULE
 818     Pass.cpp
 819     )
 820
 821 When you are done developing your pass, you may wish to integrate it
 822 into the LLVM source tree. You can achieve it in two easy steps:
 823
 824 #. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.
 825
 826 #. Adding ``add_subdirectory(<pass name>)`` line into
 827    ``<LLVM root>/lib/Transform/CMakeLists.txt``.
 828
 829 Compiler/Platform-specific topics
 830 =================================
 831
 832 Notes for specific compilers and/or platforms.
 833
 834 Microsoft Visual C++
 835 --------------------
 836
 837 **LLVM_COMPILER_JOBS**:STRING
 838   Specifies the maximum number of parallel compiler jobs to use per project
 839   when building with msbuild or Visual Studio. Only supported for the Visual
 840   Studio 2010 CMake generator. 0 means use all processors. Default is 0.