Go to file
Fangrui Song 8c5825befb [llvm-readobj][test] Fix ELF/verneed-flags.yaml
*.yaml tests don't currently run, so we failed to update it.
2020-07-07 15:01:02 -07:00
clang [x86][seses] Add clang flag; Use lvi-cfi with seses 2020-07-07 13:20:13 -07:00
clang-tools-extra Speculatively fix the sphinx build. 2020-07-07 13:54:28 -04:00
compiler-rt Revert "Temporarily disable the following failing tests on Darwin:" 2020-07-07 10:15:46 -07:00
debuginfo-tests [CMake] Add check-debuginfo-* targets 2020-06-26 11:18:18 -07:00
flang [flang] Added missing runtime I/O definitions 2020-07-07 12:33:51 -07:00
libc [libc] Add memchr implementation. 2020-07-07 17:08:50 -04:00
libclc libclc: update website url 2020-05-29 09:18:37 +02:00
libcxx Modifications to the algorithm sort benchmark 2020-07-06 18:30:02 -04:00
libcxxabi [libc++/libc++abi] Automatically detect whether exceptions are enabled 2020-07-03 14:58:09 -04:00
libunwind [runtimes] Rename newformat to just format, now that the old format has been removed 2020-06-30 10:10:30 -04:00
lld [ELF] Ignore --no-relax for RISC-V 2020-07-07 09:48:13 -07:00
lldb [lldb/api] Add checks for StackFrame::GetRegisterContext calls (NFC) 2020-07-07 23:30:24 +02:00
llvm [llvm-readobj][test] Fix ELF/verneed-flags.yaml 2020-07-07 15:01:02 -07:00
mlir [mlir][Vector] Add ExtractOp folding 2020-07-07 16:48:49 -04:00
openmp [OpenMP] Use primary context in CUDA plugin 2020-07-07 10:14:51 -04:00
parallel-libs [arcconfig] Delete subproject arcconfigs 2020-02-24 16:20:36 -08:00
polly Reland "[ScalarEvolution] createSCEV(): recognize `udiv`/`urem` disguised as an `sdiv`/`srem`" 2020-07-06 18:00:22 +03:00
pstl [pstl] A fix for move placement-new (and destroy) allocated objects from raw memory. 2020-05-18 17:00:13 +03:00
utils/arcanist Use in-tree clang-format-diff.py as Arcanist linter 2020-04-06 12:02:20 -04:00
.arcconfig [arcconfig] Default base to previous revision 2020-02-24 16:20:25 -08:00
.arclint Fix .arclint on Windows 2020-04-28 09:55:48 -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 Add some libc++ revisions to .git-blame-ignore-revs 2020-03-17 17:30:20 -04:00
.gitignore [clangd] Store index in '.cache/clangd/index' instead of '.clangd/index' 2020-07-07 14:53:45 +02:00
CONTRIBUTING.md
README.md Revert 'This is a test commit - ded57e1a06 2020-06-18 01:03:42 +05:30

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.