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