|
150
|
1 # The LLVM Compiler Infrastructure
|
|
|
2
|
|
|
3 This directory and its sub-directories contain source code for LLVM,
|
|
|
4 a toolkit for the construction of highly optimized compilers,
|
|
|
5 optimizers, and run-time environments.
|
|
|
6
|
|
|
7 The README briefly describes how to get started with building LLVM.
|
|
|
8 For more information on how to contribute to the LLVM project, please
|
|
|
9 take a look at the
|
|
|
10 [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
|
|
|
11
|
|
|
12 ## Getting Started with the LLVM System
|
|
|
13
|
|
|
14 Taken from https://llvm.org/docs/GettingStarted.html.
|
|
|
15
|
|
|
16 ### Overview
|
|
|
17
|
|
|
18 Welcome to the LLVM project!
|
|
|
19
|
|
|
20 The LLVM project has multiple components. The core of the project is
|
|
|
21 itself called "LLVM". This contains all of the tools, libraries, and header
|
|
|
22 files needed to process intermediate representations and converts it into
|
|
|
23 object files. Tools include an assembler, disassembler, bitcode analyzer, and
|
|
|
24 bitcode optimizer. It also contains basic regression tests.
|
|
|
25
|
|
|
26 C-like languages use the [Clang](http://clang.llvm.org/) front end. This
|
|
|
27 component compiles C, C++, Objective C, and Objective C++ code into LLVM bitcode
|
|
|
28 -- and from there into object files, using LLVM.
|
|
|
29
|
|
|
30 Other components include:
|
|
|
31 the [libc++ C++ standard library](https://libcxx.llvm.org),
|
|
|
32 the [LLD linker](https://lld.llvm.org), and more.
|
|
|
33
|
|
|
34 ### Getting the Source Code and Building LLVM
|
|
|
35
|
|
|
36 The LLVM Getting Started documentation may be out of date. The [Clang
|
|
|
37 Getting Started](http://clang.llvm.org/get_started.html) page might have more
|
|
|
38 accurate information.
|
|
|
39
|
|
|
40 This is an example work-flow and configuration to get and build the LLVM source:
|
|
|
41
|
|
|
42 1. Checkout LLVM (including related sub-projects like Clang):
|
|
|
43
|
|
|
44 * ``git clone https://github.com/llvm/llvm-project.git``
|
|
|
45
|
|
|
46 * Or, on windows, ``git clone --config core.autocrlf=false
|
|
|
47 https://github.com/llvm/llvm-project.git``
|
|
|
48
|
|
|
49 2. Configure and build LLVM and Clang:
|
|
|
50
|
|
|
51 * ``cd llvm-project``
|
|
|
52
|
|
|
53 * ``mkdir build``
|
|
|
54
|
|
|
55 * ``cd build``
|
|
|
56
|
|
|
57 * ``cmake -G <generator> [options] ../llvm``
|
|
|
58
|
|
|
59 Some common build system generators are:
|
|
|
60
|
|
|
61 * ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
|
|
|
62 build files. Most llvm developers use Ninja.
|
|
|
63 * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
|
|
|
64 * ``Visual Studio`` --- for generating Visual Studio projects and
|
|
|
65 solutions.
|
|
|
66 * ``Xcode`` --- for generating Xcode projects.
|
|
|
67
|
|
|
68 Some Common options:
|
|
|
69
|
|
|
70 * ``-DLLVM_ENABLE_PROJECTS='...'`` --- semicolon-separated list of the LLVM
|
|
|
71 sub-projects you'd like to additionally build. Can include any of: clang,
|
|
|
72 clang-tools-extra, libcxx, libcxxabi, libunwind, lldb, compiler-rt, lld,
|
|
|
73 polly, or debuginfo-tests.
|
|
|
74
|
|
|
75 For example, to build LLVM, Clang, libcxx, and libcxxabi, use
|
|
|
76 ``-DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi"``.
|
|
|
77
|
|
|
78 * ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full
|
|
|
79 path name of where you want the LLVM tools and libraries to be installed
|
|
|
80 (default ``/usr/local``).
|
|
|
81
|
|
|
82 * ``-DCMAKE_BUILD_TYPE=type`` --- Valid options for *type* are Debug,
|
|
|
83 Release, RelWithDebInfo, and MinSizeRel. Default is Debug.
|
|
|
84
|
|
|
85 * ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled
|
|
|
86 (default is Yes for Debug builds, No for all other build types).
|
|
|
87
|
|
|
88 * ``cmake --build . [-- [options] <target>]`` or your build system specified above
|
|
|
89 directly.
|
|
|
90
|
|
|
91 * The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
|
|
|
92
|
|
|
93 * The ``check-all`` target (i.e. ``ninja check-all``) will run the
|
|
|
94 regression tests to ensure everything is in working order.
|
|
|
95
|
|
|
96 * CMake will generate targets for each tool and library, and most
|
|
|
97 LLVM sub-projects generate their own ``check-<project>`` target.
|
|
|
98
|
|
|
99 * Running a serial build will be **slow**. To improve speed, try running a
|
|
|
100 parallel build. That's done by default in Ninja; for ``make``, use the option
|
|
|
101 ``-j NNN``, where ``NNN`` is the number of parallel jobs, e.g. the number of
|
|
|
102 CPUs you have.
|
|
|
103
|
|
|
104 * For more information see [CMake](https://llvm.org/docs/CMake.html)
|
|
|
105
|
|
|
106 Consult the
|
|
|
107 [Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm)
|
|
|
108 page for detailed information on configuring and compiling LLVM. You can visit
|
|
|
109 [Directory Layout](https://llvm.org/docs/GettingStarted.html#directory-layout)
|
|
|
110 to learn about the layout of the source code tree.
|
