Go to file
Michael Kruse 5577fb229d [tests][OpenMPIRBuilder] Use EXPECT_EQ instead ASSERT_EQ.
Test execution can continue even if previous cases failed.
2020-12-11 11:49:50 -06:00
.github/workflows [PATCH] github actions: Pepare main branch for being read/write 2020-12-06 22:16:36 -08:00
clang [KernelAddressSanitizer] Fix globals exclusion for indirect aliases 2020-12-11 12:20:40 +01:00
clang-tools-extra Revert [clangd] Extract per-dir CDB cache to its own threadsafe class. NFC 2020-12-11 17:35:50 +01:00
compiler-rt [DFSan] Add custom wrapper for recvmmsg. 2020-12-11 06:24:56 -08:00
debuginfo-tests Include BuiltinAttributes.h in llvm-prettyprinters/gdb/mlir-support.cpp 2020-12-04 15:57:05 -06:00
flang [flang]Add Parser Support for Allocate Directive 2020-12-10 16:21:19 +00:00
libc [libc] Add [l|ll]abs implementation. 2020-12-11 09:25:20 +08:00
libclc libclc: Use find_package to find Python 3 and require it 2020-10-01 22:31:33 +02:00
libcxx [libc++] Use TARGET_FILE instead of TARGET_SONAME_FILE when generating ABI lists 2020-12-11 12:12:40 -05:00
libcxxabi [libc++abi] Don't try calling __libcpp_aligned_free when aligned allocation is disabled 2020-12-01 17:45:14 -05:00
libunwind [libunwind] Multiple preprocessor fixes on PowerPC* 2020-11-23 19:07:21 -08:00
lld [lld-macho] Disable some tests that are failing on Windows 2020-12-10 17:54:23 -08:00
lldb [lldb] Remove single-case switch statement (NFC) 2020-12-10 10:58:30 -08:00
llvm [tests][OpenMPIRBuilder] Use EXPECT_EQ instead ASSERT_EQ. 2020-12-11 11:49:50 -06:00
mlir [mlir] Support inlining into affine operations 2020-12-11 16:24:27 +01:00
openmp [libomptarget][nfc] Remove data_sharing type aliasing 2020-12-11 02:13:34 +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] Consider InvalidContext to determine partial READ. 2020-12-10 22:25:19 -06:00
pstl [pstl] Replace direct use of assert() with _PSTL_ASSERT 2020-11-02 18:35:54 -05:00
utils/arcanist Fix arc lint's clang-format rule: only format the file we were asked to format. 2020-10-11 14:24:23 -07:00
.arcconfig Set the target branch for `arc land` to main 2020-12-07 21:57:32 +00:00
.arclint PR46997: don't run clang-format on clang's testcases. 2020-08-04 17:53:25 -07:00
.clang-format
.clang-tidy - Update .clang-tidy to ignore parameters of main like functions for naming violations in clang and llvm directory 2020-01-31 16:49:45 +00:00
.git-blame-ignore-revs NFC: Add whitespace-changing revisions to .git-blame-ignore-revs 2020-09-21 20:17:24 -04:00
.gitignore [NFC] Adding pythonenv* to .gitignore 2020-09-03 22:42:27 -04:00
CONTRIBUTING.md
README.md Revert "This is a test commit" 2020-10-21 09:34:15 +08: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 converts it 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

    • mkdir build

    • cd build

    • cmake -G <generator> [options] ../llvm

      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 . [-- [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.