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