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