README.md 5.54 KB
Newer Older
1
# The LLVM Compiler Infrastructure
2

3
This directory and its sub-directories contain the source code for LLVM,
4
a toolkit for the construction of highly optimized compilers,
5
optimizers, and run-time environments.
6

7
8
9
10
11
The README briefly describes how to get started with building LLVM.
For more information on how to contribute to the LLVM project, please
take a look at the
[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.

12
13
## Getting Started with the LLVM System

14
Taken from [here](https://llvm.org/docs/GettingStarted.html).
15
16
17
18
19
20
21

### Overview

Welcome to the LLVM project!

The LLVM project has multiple components. The core of the project is
itself called "LLVM". This contains all of the tools, libraries, and header
Paul Robinson's avatar
Paul Robinson committed
22
files needed to process intermediate representations and convert them into
23
24
object files. Tools include an assembler, disassembler, bitcode analyzer, and
bitcode optimizer. It also contains basic regression tests.
25

26
C-like languages use the [Clang](http://clang.llvm.org/) frontend. This
Austin Conlon's avatar
Austin Conlon committed
27
component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
28
29
30
31
32
33
34
35
-- and from there into object files, using LLVM.

Other components include:
the [libc++ C++ standard library](https://libcxx.llvm.org),
the [LLD linker](https://lld.llvm.org), and more.

### Getting the Source Code and Building LLVM

36
The LLVM Getting Started documentation may be out of date. The [Clang
37
38
39
Getting Started](http://clang.llvm.org/get_started.html) page might have more
accurate information.

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
45
46
47
48
49
50
51
52

     * ``git clone https://github.com/llvm/llvm-project.git``

     * Or, on windows, ``git clone --config core.autocrlf=false
    https://github.com/llvm/llvm-project.git``

2. Configure and build LLVM and Clang:

     * ``cd llvm-project``

53
     * ``cmake -S llvm -B build -G <generator> [options]``
54

55
        Some common build system generators are:
56
57
58
59
60
61
62
63

        * ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
          build files. Most llvm developers use Ninja.
        * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
        * ``Visual Studio`` --- for generating Visual Studio projects and
          solutions.
        * ``Xcode`` --- for generating Xcode projects.

64
        Some common options:
65

66
67
68
69
70
71
72
73
        * ``-DLLVM_ENABLE_PROJECTS='...'`` and ``-DLLVM_ENABLE_RUNTIMES='...'`` ---
          semicolon-separated list of the LLVM sub-projects and runtimes you'd like to
          additionally build. ``LLVM_ENABLE_PROJECTS`` can include any of: clang,
          clang-tools-extra, cross-project-tests, flang, libc, libclc, lld, lldb,
          mlir, openmp, polly, or pstl. ``LLVM_ENABLE_RUNTIMES`` can include any of
          libcxx, libcxxabi, libunwind, compiler-rt, libc or openmp. Some runtime
          projects can be specified either in ``LLVM_ENABLE_PROJECTS`` or in
          ``LLVM_ENABLE_RUNTIMES``.
74
75

          For example, to build LLVM, Clang, libcxx, and libcxxabi, use
76
          ``-DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_RUNTIMES="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
81
82
83
84
          (default ``/usr/local``). Be careful if you install runtime libraries: if
          your system uses those provided by LLVM (like libc++ or libc++abi), you
          must not overwrite your system's copy of those libraries, since that
          could render your system unusable. In general, using something like
          ``/usr`` is not advised, but ``/usr/local`` is fine.
85
86
87
88
89
90
91

        * ``-DCMAKE_BUILD_TYPE=type`` --- Valid options for *type* are Debug,
          Release, RelWithDebInfo, and MinSizeRel. Default is Debug.

        * ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled
          (default is Yes for Debug builds, No for all other build types).

92
      * ``cmake --build build [-- [options] <target>]`` or your build system specified above
93
        directly.
94
95
96
97
98
99

        * The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.

        * The ``check-all`` target (i.e. ``ninja check-all``) will run the
          regression tests to ensure everything is in working order.

100
        * CMake will generate targets for each tool and library, and most
101
102
          LLVM sub-projects generate their own ``check-<project>`` target.

103
        * Running a serial build will be **slow**. To improve speed, try running a
104
          parallel build. That's done by default in Ninja; for ``make``, use the option
105
106
107
          ``-j NNN``, where ``NNN`` is the number of parallel jobs to run.
          In most cases, you get the best performance if you specify the number of CPU threads you have.
          On some Unix systems, you can specify this with ``-j$(nproc)``.
108

109
      * For more information see [CMake](https://llvm.org/docs/CMake.html).
110
111
112
113
114
115

Consult the
[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm)
page for detailed information on configuring and compiling LLVM. You can visit
[Directory Layout](https://llvm.org/docs/GettingStarted.html#directory-layout)
to learn about the layout of the source code tree.
116
117
118
119
120
121
122

## Getting in touch

Join [LLVM Discourse forums](https://discourse.llvm.org/), [discord chat](https://discord.gg/xS7Z362) or #llvm IRC channel on [OFTC](https://oftc.net/).

The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
participants to all modes of communication within the project.