Go to file
LLVM GN Syncbot 31049b3d2b [gn build] Port 1dad6247d2 2022-07-21 20:54:39 +00:00
.github [github] format and refactor GitHub workflows 2022-06-11 11:31:21 +04:30
bolt [cmake] Don't export `LLVM_TOOLS_INSTALL_DIR` anymore 2022-07-21 19:04:00 +00:00
clang [OpenMP][NFC] Claim iterators in 'map' clause and motion clauses 2022-07-21 15:50:22 -05:00
clang-tools-extra [pseudo] Key guards by RuleID, add guards to literals (and 0). 2022-07-21 22:42:31 +02:00
cmake [CMake] Make FindLibEdit.cmake more robust 2022-05-27 13:06:45 -07:00
compiler-rt tsan: remove unnecessary brackets 2022-07-21 12:11:44 +02:00
cross-project-tests Pretty printer test fixes 2022-07-12 19:29:38 +00:00
flang [cmake] Don't export `LLVM_TOOLS_INSTALL_DIR` anymore 2022-07-21 19:04:00 +00:00
libc [libc] Add a convenience class and function for integer to string conversion. 2022-07-21 20:18:59 +00:00
libclc libclc: Add clspv64 target 2022-01-13 09:28:19 +00:00
libcxx [libc++] Reorganize release notes 2022-07-21 12:57:27 -04:00
libcxxabi [libcxxabi][CMake] Set --unwindlib=none when using LLVM libunwind 2022-07-14 18:59:40 +00:00
libunwind [libunwind][SystemZ] Use process_vm_readv to avoid potential segfaults 2022-07-18 16:54:48 +02:00
lld [cmake] Don't export `LLVM_TOOLS_INSTALL_DIR` anymore 2022-07-21 19:04:00 +00:00
lldb [lldb][NFCI] Refactor regex filtering logic in CommandObjectTypeFormatterList 2022-07-21 09:22:40 -07:00
llvm [gn build] Port 1dad6247d2 2022-07-21 20:54:39 +00:00
llvm-libgcc [llvm-libgcc] initial commit 2022-02-16 17:06:45 +00:00
mlir [mlir] Explicitly mark dialect prefixing 2022-07-21 12:58:19 -07:00
openmp [Libomptarget] Stop testing CPU offloading with LTO 2022-07-21 16:47:41 -04:00
polly Use llvm::is_contained (NFC) 2022-07-20 09:09:19 -07:00
pstl [libc++] Use _LIBCPP_ASSERT by default for _PSTL_ASSERTions 2022-05-20 16:58:21 +02:00
runtimes [runtimes] adds llvm-libgcc to the list of runtimes to be sorted 2022-06-30 23:50:24 +00:00
third-party Ensure newlines at the end of files (NFC) 2021-12-26 08:51:06 -08:00
utils [bazel] add headers now required after 17e4c217b6 2022-07-21 15:39:29 -04:00
.arcconfig Add modern arc config for default "onto" branch 2021-02-22 11:58:13 -08:00
.arclint
.clang-format Revert "Title: [RISCV] Add missing part of instruction vmsge {u}. VX Review By: craig.topper Differential Revision : https://reviews.llvm.org/D100115" 2021-04-14 08:04:37 +01:00
.clang-tidy [clangd] Cleanup of readability-identifier-naming 2022-02-01 13:31:52 +00:00
.git-blame-ignore-revs Add __config formatting to .git-blame-ignore-revs 2022-06-14 09:52:49 -04:00
.gitignore [llvm] Ignore .rej files in .gitignore 2022-04-28 08:44:51 -07:00
.mailmap .mailmap: remove stray space in comment 2022-02-24 18:50:08 -05:00
CONTRIBUTING.md docs: update some bug tracker references (NFC) 2022-01-10 15:59:08 -08:00
README.md Fix grammar and punctuation across several docs; NFC 2022-04-07 07:11:11 -04:00
SECURITY.md [docs] Describe reporting security issues on the chromium tracker. 2021-05-19 15:21:50 -07:00

README.md

The LLVM Compiler Infrastructure

This directory and its sub-directories contain the 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 here.

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 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 frontend. 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='...' and -DLLVM_ENABLE_RUNTIMES='...' --- semicolon-separated list of the LLVM sub-projects and runtimes you'd like to additionally build. LLVM_ENABLE_PROJECTS can include any of: clang, clang-tools-extra, cross-project-tests, flang, libc, libclc, lld, lldb, mlir, openmp, polly, or pstl. LLVM_ENABLE_RUNTIMES can include any of libcxx, libcxxabi, libunwind, compiler-rt, libc or openmp. Some runtime projects can be specified either in LLVM_ENABLE_PROJECTS or in LLVM_ENABLE_RUNTIMES.

        For example, to build LLVM, Clang, libcxx, and libcxxabi, use -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_RUNTIMES="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). Be careful if you install runtime libraries: if your system uses those provided by LLVM (like libc++ or libc++abi), you must not overwrite your system's copy of those libraries, since that could render your system unusable. In general, using something like /usr is not advised, but /usr/local is fine.

      • -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 to run. In most cases, you get the best performance if you specify the number of CPU threads you have. On some Unix systems, you can specify this with -j$(nproc).

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

Getting in touch

Join LLVM Discourse forums, discord chat or #llvm IRC channel on OFTC.

The LLVM project has adopted a code of conduct for participants to all modes of communication within the project.