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