LLVM project master repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Fangrui Song db6a00daa0 [ELF] Remove unneeded binding parameter from addOptionalRegular. NFC 4 hours ago
.github Removing the main to master sync GitHub workflow. 8 months ago
clang [clang-format] Left/Right alignment fixer can cause false positive replacements when they don't actually change anything 10 hours ago
clang-tools-extra Fix wrong FixIt about union in cppcoreguidelines-pro-type-member-init 1 day ago
compiler-rt [ORC-RT] ExecutorAddrDiff ergonomic improvements; contains and overlaps methods 8 hours ago
cross-project-tests Reapply "[Dexter] Improve performance by evaluating expressions only when needed" 2 days ago
flang [fir] Add desc to fir.array_load op and update operand name 15 hours ago
libc [libc] Add an implementation of qsort. 1 day ago
libclc libclc: Fix rounding during type conversion 1 month ago
libcxx [libc++][NFC] Update status of old issue LWG2560 -- we implement it properly 1 day ago
libcxxabi [demangle] Support for ISO/IEC TS 18661 binary floating point type 3 days ago
libunwind [LLVM][CMake][NFC] Resolve FIXME: Rename LLVM_CMAKE_PATH to LLVM_CMAKE_DIR throughout the project 1 week ago
lld [ELF] Remove unneeded binding parameter from addOptionalRegular. NFC 4 hours ago
lldb [lldb] Convert misc. StringConvert uses 14 hours ago
llvm [AA] Move earliest escape tracking from DSE to AA 6 hours ago
mlir [MLIR] Add functionality to remove redundant local variables 16 hours ago
openmp [OpenMP] Fix data-race in new device RTL 2 days ago
parallel-libs Try enabling -Wsuggest-override again, using add_compile_options instead of add_compile_definitions for disabling it in unittests/ directories. 1 year ago
polly [Polly] Fix wrong redirect in test case. 1 day ago
pstl [libc++] Remove test-suite annotations for unsupported Clang versions 1 month ago
runtimes [LLVM][CMake][NFC] Resolve FIXME: Rename LLVM_CMAKE_PATH to LLVM_CMAKE_DIR throughout the project 1 week ago
utils [mlir] Create a generic reduction detection utility 1 day ago
.arcconfig Add modern arc config for default "onto" branch 7 months ago
.arclint PR46997: don't run clang-format on clang's testcases. 1 year ago
.clang-format Add .clang-tidy and .clang-format files to the toplevel of the 3 years ago
.clang-tidy .clang-tidy: Disable misc-no-recursion in general/across the monorepo 4 months ago
.git-blame-ignore-revs [lldb] Add 9494c510af56 to .git-blame-ignore-revs 4 months ago
.gitignore [NFC] Add CMakeUserPresets.json filename to .gitignore 8 months ago
.mailmap [mailmap] Add entry for myself 4 days ago
CONTRIBUTING.md Add contributing info to CONTRIBUTING.md and README.md 2 years ago
README.md [NFC] Update the list of subprojects in docs. 4 days ago
SECURITY.md [docs] Describe reporting security issues on the chromium tracker. 4 months ago


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.


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 convert them 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

    • cmake -S llvm -B build -G <generator> [options]

      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, compiler-rt,cross-project-tests, flang, libc, libclc, libcxx, libcxxabi, libunwind, lld, lldb, mlir, openmp, parallel-libs, polly, or pstl.

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