Go to file
Valentin Clement 676d091c63
Revert "[fir] Add Character helper"
This reverts commit 02d7089c23.
2021-10-20 22:43:13 +02:00
.github/workflows repo-lockdown: Add pr comment and fix typo 2021-10-18 14:31:44 -07:00
clang Remove include of 'type_info' from ext-int test. 2021-10-20 12:53:51 -07:00
clang-tools-extra [clangd] Fix use-after-free in HeaderIncluderCache 2021-10-20 16:36:07 +02:00
cmake/Modules [CMake] Cache the compiler-rt library search results 2021-10-18 14:44:07 -07:00
compiler-rt [ORC-RT] Configure the ORC runtime for more architectures and platforms 2021-10-20 11:21:18 -07:00
cross-project-tests [Dexter] Add option to pass a Visual Studio solution instead of a binary 2021-10-08 17:39:51 +01:00
flang Revert "[fir] Add Character helper" 2021-10-20 22:43:13 +02:00
libc [libc] add atof, strtof and strtod 2021-10-18 16:10:03 -07:00
libclc libclc: Fix rounding during type conversion 2021-08-19 22:24:19 -07:00
libcxx [libc++] Fix incorrect main() signatures in the tests 2021-10-20 16:26:34 -04:00
libcxxabi [CMake] Cache the compiler-rt library search results 2021-10-18 14:44:07 -07:00
libunwind [libunwind] Use the from-scratch testing configuration by default 2021-10-20 08:45:58 -04:00
lld [lld/mac] Remove else-after-return in ICF code 2021-10-20 14:24:13 -04:00
lldb [lldb] Remove variable "any" which is set but not used 2021-10-20 12:08:35 -07:00
llvm [x86] add special-case lowering for usubsat for AVX512 2021-10-20 16:41:13 -04:00
mlir [mlir][sparse] make index type explicit in public API of support library 2021-10-20 12:46:31 -07:00
openmp [OpenMP] Add GOMP allocator functions 2021-10-20 11:37:29 -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 Use llvm::erase_if (NFC) 2021-10-18 09:33:42 -07:00
pstl [pstl] Initial implementation of OpenMP backend, on behalf of Christopher Nelson nadiasvertex@gmail.com 2021-10-15 15:36:07 +03:00
runtimes [runtimes] Make sure LLVM_LIT_ARGS is set before including individual runtimes 2021-10-19 08:21:29 -04:00
utils Fix bazel build. 2021-10-18 10:22:41 +02: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 (test commit) Fix capitalization in README.md 2021-10-06 05:34:31 +02: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, parallel-libs, 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.