llvm with tablegen backend for capstone disassembler
Go to file
2022-01-22 23:20:14 +08:00
.github
bolt [BOLT][NFC] Reduce includes with include-what-you-use 2022-01-21 12:05:47 -08:00
clang [time-trace] Add optimizer and codegen regions to NPM 2022-01-21 19:17:57 -08:00
clang-tools-extra [clang-tidy] Avoid binding nullptr to a reference 2022-01-21 15:55:17 +01:00
cmake Revert "[cmake] Duplicate {llvm,compiler_rt}_check_linker_flag for runtime libs and llvm" 2022-01-21 09:53:14 -08:00
compiler-rt [TSan] Omit vfork interceptor iOS simulator runtime 2022-01-21 17:36:12 -08:00
cross-project-tests
flang [flang] Allow INQUIRE() on a child unit in user-defined I/O procedure 2022-01-21 18:23:56 -08:00
libc
libclc
libcxx [libc++] Use addressof in unordered_set. 2022-01-22 11:41:13 +01:00
libcxxabi
libunwind Revert "[cmake] Duplicate {llvm,compiler_rt}_check_linker_flag for runtime libs and llvm" 2022-01-21 09:53:14 -08:00
lld
lldb [lldb] Allow aliases to aliases of raw input commands 2022-01-21 17:57:34 -08:00
llvm [PowerPC] Change CTR clobber estimation for 128-bit floating types 2022-01-22 23:20:14 +08:00
mlir [mlir] Add SingleBlockImplicitTerminator<"tensor::YieldOp"> to PadOp. 2022-01-22 11:46:27 +01:00
openmp
polly Add missing llvm/support/Regex.h include in polly/lib/Analysis/ScopDetection.cpp 2022-01-21 16:04:37 +01:00
pstl
runtimes Revert "[cmake] Duplicate {llvm,compiler_rt}_check_linker_flag for runtime libs and llvm" 2022-01-21 09:53:14 -08:00
third-party
utils [mlir] Move linalg::PadTensorOp to tensor::PadOp. 2022-01-21 20:02:39 +01:00
.arcconfig
.arclint
.clang-format
.clang-tidy
.git-blame-ignore-revs
.gitignore [NFC] Add CMakeUserPresets.json filename to .gitignore 2021-01-22 12:45:29 +01:00
.mailmap
CONTRIBUTING.md
README.md
SECURITY.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.