Go to file
Nikita Popov 3c6fe0fc77 [BasicAA] Fix stale comment (NFC)
DataLayout is always around...
2020-10-17 23:58:58 +02:00
clang Revert "[clang-format] Fix AlignConsecutive on PP blocks" 2020-10-17 19:52:51 +02:00
clang-tools-extra [clang-tidy] modernize-loop-convert reverse iteration support 2020-10-16 14:16:30 +01:00
compiler-rt [RISCV][ASAN] Fix passing XFAIL tests 2020-10-17 16:55:11 +01:00
debuginfo-tests Add GDB prettyprinters for a few more MLIR types. 2020-09-30 21:22:47 +02:00
flang [flang] Disallow pointer constants 2020-10-16 12:31:42 -07:00
libc [libc] Use entrypoints.txt as the single source of list of functions for a platform. 2020-10-15 20:46:13 +00:00
libclc libclc: Use find_package to find Python 3 and require it 2020-10-01 22:31:33 +02:00
libcxx [libcxx] [test] Fix string type handling in a few fairly trivial class.path tests 2020-10-16 21:04:23 +03:00
libcxxabi [libcxxabi] Fix printf formats in a test. 2020-10-16 13:59:11 +01:00
libunwind [libcxxabi,libunwind] support running tests in standalone mode 2020-10-14 09:10:20 +02:00
lld Reapply [LLD] [COFF] Implement a GNU/ELF like -wrap option 2020-10-15 22:14:02 +03:00
lldb [lldb] Enable cmake policy CMP0077 for option() 2020-10-17 00:16:24 -07:00
llvm [BasicAA] Fix stale comment (NFC) 2020-10-17 23:58:58 +02:00
mlir Fixed a failure when const matcher fails, added a test to catch 2020-10-16 15:02:24 -07:00
openmp [libomptarget] Fix copy-to motion for PTR_AND_OBJ entries where PTR is a struct member. 2020-10-16 16:14:01 -07:00
parallel-libs Reapply "Try enabling -Wsuggest-override again, using add_compile_options instead of add_compile_definitions for disabling it in unittests/ directories." 2020-07-22 17:50:19 -07:00
polly Polly - specify address space when creating a pointer to a vector type 2020-10-14 11:17:15 -05:00
pstl [pstl] Support Threading Building Blocks 2020 (oneTBB) for "tbb" parallel backend. 2020-09-14 14:21:54 +03:00
utils/arcanist Fix arc lint's clang-format rule: only format the file we were asked to format. 2020-10-11 14:24:23 -07:00
.arcconfig [arcconfig] Default base to previous revision 2020-02-24 16:20:25 -08:00
.arclint PR46997: don't run clang-format on clang's testcases. 2020-08-04 17:53:25 -07:00
.clang-format
.clang-tidy - Update .clang-tidy to ignore parameters of main like functions for naming violations in clang and llvm directory 2020-01-31 16:49:45 +00:00
.git-blame-ignore-revs NFC: Add whitespace-changing revisions to .git-blame-ignore-revs 2020-09-21 20:17:24 -04:00
.gitignore [NFC] Adding pythonenv* to .gitignore 2020-09-03 22:42:27 -04:00
CONTRIBUTING.md
README.md Revert "This is a test commit" 2020-09-18 08:43:53 +02:00

README.md

The LLVM Compiler Infrastructure

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

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 guide.

Getting Started with the LLVM System

Taken from https://llvm.org/docs/GettingStarted.html.

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 files needed to process intermediate representations and converts it into object files. Tools include an assembler, disassembler, bitcode analyzer, and bitcode optimizer. It also contains basic regression tests.

C-like languages use the Clang front end. This component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode -- and from there into object files, using LLVM.

Other components include: the libc++ C++ standard library, the LLD linker, and more.

Getting the Source Code and Building LLVM

The LLVM Getting Started documentation may be out of date. The Clang Getting Started page might have more accurate information.

This is an example work-flow and configuration to get and build the LLVM source:

  1. Checkout LLVM (including related sub-projects like Clang):

    • 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

    • mkdir build

    • cd build

    • cmake -G <generator> [options] ../llvm

      Some common build system generators are:

      • Ninja --- for generating Ninja 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.

      Some Common options:

      • -DLLVM_ENABLE_PROJECTS='...' --- semicolon-separated list of the LLVM sub-projects you'd like to additionally build. Can include any of: clang, clang-tools-extra, libcxx, libcxxabi, libunwind, lldb, compiler-rt, lld, polly, or debuginfo-tests.

        For example, to build LLVM, Clang, libcxx, and libcxxabi, use -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi".

      • -DCMAKE_INSTALL_PREFIX=directory --- Specify for directory the full path name of where you want the LLVM tools and libraries to be installed (default /usr/local).

      • -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).

    • cmake --build . [-- [options] <target>] or your build system specified above directly.

      • 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.

      • CMake will generate targets for each tool and library, and most LLVM sub-projects generate their own check-<project> target.

      • Running a serial build will be slow. To improve speed, try running a parallel build. That's done by default in Ninja; for make, use the option -j NNN, where NNN is the number of parallel jobs, e.g. the number of CPUs you have.

    • For more information see CMake

Consult the Getting Started with LLVM page for detailed information on configuring and compiling LLVM. You can visit Directory Layout to learn about the layout of the source code tree.