Go to file
Sebastian Neubauer bbd7424402 [AMDGPU] Fix linking with shared libraries
AMDGPULDSUtils depends on llvm::CallGraph.
2021-06-21 11:11:13 +02:00
.github Removing the main to master sync GitHub workflow. 2021-01-28 12:18:25 -08:00
clang [clang] NFC: adjust indentation of statements with more than one lines 2021-06-21 10:17:10 +08:00
clang-tools-extra [clangd] Type hints for C++14 return type deduction 2021-06-21 01:13:00 -04:00
compiler-rt [profile] Fix variable name 2021-06-19 14:55:32 -07:00
debuginfo-tests [Dexter] Remove erroneously added diff file 2021-05-25 13:36:11 +01:00
flang [flang] Implement constant folding for the NOT intrinsic 2021-06-20 07:25:05 -07:00
libc [libc][Obvious] Add the new header file PlatformDefs.h to the fputil target. 2021-06-18 07:37:06 +00:00
libclc Support: Stop using F_{None,Text,Append} compatibility synonyms, NFC 2021-04-30 11:00:03 -07:00
libcxx [libcxx] Implement P0883R2 ("Fixing Atomic Initialization") 2021-06-20 17:37:42 +03:00
libcxxabi [libc++] Promote GCC 11 to mandatory CI 2021-06-15 20:54:58 -04:00
libunwind [libcxx] Fix exception raised during downstream bare-metal libunwind tests 2021-06-16 13:35:36 +01:00
lld [lld/mac] Make a variable more local; no behavior change 2021-06-20 21:59:15 -04:00
lldb Try to unbreak the windows CI 2021-06-20 13:13:46 -07:00
llvm [AMDGPU] Fix linking with shared libraries 2021-06-21 11:11:13 +02:00
mlir [mlir][NFC] Remove Standard dialect dependency on MemRef dialect 2021-06-21 17:55:23 +09:00
openmp [AMDGPU][Libomptarget] Remove redundant functions 2021-06-21 06:13:24 +00: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][Isl] Refactoring IslAstInfo::getBuild() and IslAstInfo::IslAstUserPayload::Build to use isl++. NFC 2021-06-18 09:53:51 +02:00
pstl [pstl] Workaround more errors in the test suite 2021-05-26 15:45:01 -04:00
runtimes [runtimes] Add the libc project to the list of runtimes. 2021-03-23 17:33:03 +00:00
utils/arcanist [utils] Don't print username in arcanist clang format message 2021-05-14 14:33:00 +00: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 Update my mailmap 2021-06-10 14:14:57 +08:00
CONTRIBUTING.md
README.md Fix grammar in README.md 2021-05-12 08:48:59 -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, 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.