Go to file
Martin Storsjö df0ba47c36 [Support] Allow configuring the preferred type of slashes on Windows
Default to preferring forward slashes when built for MinGW, as
many usecases, when e.g. Clang is used as a drop-in replacement
for GCC, requires the compiler to output paths with forward slashes.

Not all tests pass yet, if configuring to prefer forward slashes though.

Differential Revision: https://reviews.llvm.org/D112787
2021-11-05 10:42:02 +02:00
.github/workflows Disable lockdown for external forks by default 2021-10-29 14:54:20 -07:00
clang Revert "[Attr] support btf_type_tag attribute" 2021-11-05 10:36:40 +02:00
clang-tools-extra [NFC] Don't set rlimit in test with MSAN 2021-11-04 18:18:03 -07:00
cmake/Modules [libunwind] Try to add --unwindlib=none while configuring and building libunwind 2021-11-05 10:10:19 +02:00
compiler-rt [asan] compiler-rt version of D113143 2021-11-04 23:51:16 -07:00
cross-project-tests Fix some issues with the gdb pretty printers for llvm::Twine 2021-11-04 22:50:50 -07:00
flang [OpenMP] Add parsing/sema/serialization for 'bind' clause. 2021-11-04 14:40:30 -07:00
libc [libc] add stpcpy and stpncpy 2021-11-04 11:39:26 -07:00
libclc Revert "Use `GNUInstallDirs` to support custom installation dirs. -- LLVM" 2021-11-02 19:11:44 +01:00
libcxx [libcxx][NFC] tidy up money_get::__do_get's sign parsing 2021-11-04 17:55:28 -04:00
libcxxabi [libcxxabi] Fix NO_THREADS version of test_exception_storage.pass.cpp 2021-11-04 19:30:21 -04:00
libunwind [libunwind] Try to add --unwindlib=none while configuring and building libunwind 2021-11-05 10:10:19 +02:00
lld [lld-macho] Replace LC_LINKER_OPTION parsing 2021-11-04 22:03:40 -07:00
lldb [debugserver] Fix typo in DNBArchImplARM64 2021-11-04 09:43:50 -07:00
llvm [Support] Allow configuring the preferred type of slashes on Windows 2021-11-05 10:42:02 +02:00
mlir [mlir][linalg][bufferize] Separate pass from ComprehensiveBufferize 2021-11-05 13:56:39 +09:00
openmp [OpenMP] Build device runtimes for sm_86 2021-11-04 17:54:59 -05:00
polly Use llvm::erase_if (NFC) 2021-10-18 09:33:42 -07:00
pstl [pstl] A hot fix for a reduction parallel pattern of OpenMP backend 2021-10-27 18:52:41 +03:00
runtimes [runtimes] Make sure LLVM_LIT_ARGS is set before including individual runtimes 2021-10-19 08:21:29 -04:00
utils [mlir][linalg][bufferize] Separate pass from ComprehensiveBufferize 2021-11-05 13:56:39 +09: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 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 .clang-tidy: Disable misc-no-recursion in general/across the monorepo 2021-06-08 08:31:33 -07:00
.git-blame-ignore-revs [lldb] Add 9494c510af to .git-blame-ignore-revs 2021-06-10 09:29:59 -07:00
.gitignore [NFC] Add CMakeUserPresets.json filename to .gitignore 2021-01-22 12:45:29 +01:00
.mailmap Add self to .mailmap 2021-10-12 15:51:01 +02:00
CONTRIBUTING.md
README.md Remove unused parallel-libs project 2021-10-21 14:34:39 -07: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 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 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, 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.