Go to file
Sebastian Neubauer ca3bae94c4 [AMDGPU] Autogenerate test. NFC 2021-04-12 11:51:28 +02:00
.github Removing the main to master sync GitHub workflow. 2021-01-28 12:18:25 -08:00
clang [OpenCL] Accept .rgba in OpenCL 3.0 2021-04-12 09:30:06 +01:00
clang-tools-extra [libtooling][clang-tidy] Fix compiler warnings in testcase [NFC] 2021-04-12 08:26:46 +02:00
compiler-rt fix typo in a CMake SANITIZER_CAN_USE_CXXABI variable initial definition 2021-04-12 14:05:37 +08:00
debuginfo-tests [dexter] Fix DexLimitSteps when breakpoint can't be set at requested location 2021-03-23 11:33:43 +00:00
flang [flang] Accept & fold IEEE_SELECTED_REAL_KIND 2021-04-10 10:01:14 -07:00
libc libc: Default LIBC_INSTALL_PREFIX to ${CMAKE_INSTALL_PREFIX} 2021-03-30 21:43:25 -07:00
libclc libclc: Add clspv target to libclc 2021-03-04 00:19:10 -05:00
libcxx [libc++] [CI] Validate the output of the generated scripts. 2021-04-11 15:35:23 +02:00
libcxxabi [libc++abi] Adjust XFAIL for misaligned exception header on ARM 2021-04-07 16:14:50 -04:00
libunwind [CMake] Remove {LIBCXX,LIBCXXABI,LIBUNWIND}_INSTALL_PREFIX 2021-04-01 10:13:07 -07:00
lld [lld-macho][nfc] Convert tabs to spaces 2021-04-11 23:25:23 -04:00
lldb [LLDB][NFC] Add clarifying comments for AddCXXSummary and AddCXXSynthetic 2021-04-09 12:07:24 -07:00
llvm [AMDGPU] Autogenerate test. NFC 2021-04-12 11:51:28 +02:00
mlir [mlir] NFC - Add help functions to scf.ForOp 2021-04-09 20:26:34 +00:00
openmp [OpenMP] Define omp_is_initial_device() variants in omp.h 2021-04-06 16:58:01 -05: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] Partially refactoring of IslAstInfo and IslNodeBuilder to use isl++. NFC. 2021-04-10 21:28:02 -05:00
pstl Rename top-level LICENSE.txt files to LICENSE.TXT 2021-03-10 21:26:24 -08:00
runtimes [runtimes] Add the libc project to the list of runtimes. 2021-03-23 17:33:03 +00: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 Add modern arc config for default "onto" branch 2021-02-22 11:58:13 -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] Add CMakeUserPresets.json filename to .gitignore 2021-01-22 12:45:29 +01:00
CONTRIBUTING.md
README.md [doc] Use cmake's -S option to simplify the build instructions 2021-02-16 14:47:06 -06: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

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