• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..--

.github/workflows/23-Nov-2023-2619

clang/23-Nov-2023-3,328,4522,093,634

clang-tools-extra/23-Nov-2023-299,021206,226

compiler-rt/23-Nov-2023-477,467375,152

debuginfo-tests/23-Nov-2023-12,7998,515

flang/23-Nov-2023-174,826130,046

libc/23-Nov-2023-109,81192,533

libclc/23-Nov-2023-26,13820,547

libcxx/23-Nov-2023-806,392613,329

libcxxabi/23-Nov-2023-29,66822,190

libunwind/23-Nov-2023-19,34815,634

lld/23-Nov-2023-260,286191,373

lldb/23-Nov-2023-950,026699,588

llvm/23-Nov-2023-10,241,8248,282,406

mlir/23-Nov-2023-430,294310,702

openmp/23-Nov-2023-159,989112,882

parallel-libs/23-Nov-2023-7,0035,193

polly/23-Nov-2023-606,727465,655

pstl/23-Nov-2023-21,13416,240

utils/arcanist/23-Nov-2023-6941

.arcconfigD23-Nov-2023190 87

.arclintD23-Nov-2023437 1615

.clang-formatD23-Nov-202319 21

.clang-tidyD23-Nov-2023913 2018

.git-blame-ignore-revsD23-Nov-20231.5 KiB4331

.gitignoreD23-Nov-20232 KiB6661

CONTRIBUTING.mdD23-Nov-2023455 118

README.mdD23-Nov-20234.4 KiB11175

README.md

1# The LLVM Compiler Infrastructure
2
3This directory and its sub-directories contain source code for LLVM,
4a toolkit for the construction of highly optimized compilers,
5optimizers, and run-time environments.
6
7The README briefly describes how to get started with building LLVM.
8For more information on how to contribute to the LLVM project, please
9take a look at the
10[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
11
12## Getting Started with the LLVM System
13
14Taken from https://llvm.org/docs/GettingStarted.html.
15
16### Overview
17
18Welcome to the LLVM project!
19
20The LLVM project has multiple components. The core of the project is
21itself called "LLVM". This contains all of the tools, libraries, and header
22files needed to process intermediate representations and converts it into
23object files.  Tools include an assembler, disassembler, bitcode analyzer, and
24bitcode optimizer.  It also contains basic regression tests.
25
26C-like languages use the [Clang](http://clang.llvm.org/) front end.  This
27component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
28-- and from there into object files, using LLVM.
29
30Other components include:
31the [libc++ C++ standard library](https://libcxx.llvm.org),
32the [LLD linker](https://lld.llvm.org), and more.
33
34### Getting the Source Code and Building LLVM
35
36The LLVM Getting Started documentation may be out of date.  The [Clang
37Getting Started](http://clang.llvm.org/get_started.html) page might have more
38accurate information.
39
40This is an example work-flow and configuration to get and build the LLVM source:
41
421. 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
492. 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
106Consult the
107[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm)
108page for detailed information on configuring and compiling LLVM. You can visit
109[Directory Layout](https://llvm.org/docs/GettingStarted.html#directory-layout)
110to learn about the layout of the source code tree.
111