Go to file
Fangrui Song dfb7518df1 [MC] Set SHF_INFO_LINK on SHT_REL/SHT_RELA sections
sh_info links to a section, therefore SHF_INFO_LINK should be set as GNU as
does. The issue has been benign because linkers kindly combines relocation
sections w/ and w/o the flag.
2021-09-02 01:00:51 -07:00
.github Removing the main to master sync GitHub workflow. 2021-01-28 12:18:25 -08:00
clang [OpenMP][OpenMPIRBuilder] Implement loop unrolling. 2021-09-02 02:37:25 -05:00
clang-tools-extra [clang-tidy] Fix documentation typos (NFC) 2021-09-01 08:48:31 -07:00
compiler-rt [InstrProfiling] Use llvm.compiler.used if applicable for Mach-O 2021-09-01 14:46:51 -07:00
cross-project-tests [cross-project-tests] Add/update check-* targets for cross-project-tests 2021-06-28 11:31:41 +01:00
flang [flang] Include default component initialization in static initializers 2021-09-01 09:40:37 -07:00
libc [libc] Add a skeleton for C standard condition variable functions. 2021-09-01 19:41:52 +00:00
libclc libclc: Fix rounding during type conversion 2021-08-19 22:24:19 -07:00
libcxx [libc++][nfc] Fixes ppc64le-sanitizer build issue. 2021-09-02 08:13:59 +02:00
libcxxabi [libc++] Remove some workarounds for unsupported GCC and Clang versions 2021-09-01 10:57:14 -04:00
libunwind [libunwind] Don't include cet.h/immintrin.h unconditionally 2021-08-26 11:37:07 +02:00
lld [lld][Hexagon] Add checks for instructions that can have TLS relocations 2021-09-01 13:15:18 -07:00
lldb [lldb] Add minidump save-core functionality to ELF object files 2021-09-01 15:14:29 +02:00
llvm [MC] Set SHF_INFO_LINK on SHT_REL/SHT_RELA sections 2021-09-02 01:00:51 -07:00
mlir [mlir][sparse] sparse runtime support library improvements 2021-09-01 16:51:14 -07:00
openmp [libomptarget] Move HostDataToTargetTy states into StatesTy 2021-09-01 23:36:05 -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] Use subtyped isl::schedule_nodes for ScheduleTreeVisitor. NFC. 2021-08-31 20:54:12 -05:00
pstl [libc++] Remove test-suite annotations for unsupported Clang versions 2021-08-20 15:05:13 -04:00
runtimes [runtimes] Add the libc project to the list of runtimes. 2021-03-23 17:33:03 +00:00
utils [mlir] Add an interface to allow operations to specify how they can be tiled. 2021-08-30 16:31:18 -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 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 Simplify a .mailmap entry 2021-08-18 09:16:16 -04:00
CONTRIBUTING.md
README.md [RFC][debuginfo-test] Rename debug-info lit tests for general purposes 2021-06-28 11:31:40 +01: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 cross-project-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.