Go to file
Phoebe Wang 313c93a344 Add myself to CREDITS.TXT + CODE_OWNERS.TXT
See https://discourse.llvm.org/t/proposed-change-to-x86-code-ownership/65620
2022-10-09 09:02:20 +08:00
.github [NFC] Fix exception in version-check.py script 2022-09-15 13:34:29 +02:00
bolt [BOLT][TEST] Fix section order test 2022-10-07 14:38:49 -07:00
clang [PGO] Consider parent context when weighing branches with likelyhood. 2022-10-08 23:49:27 +02:00
clang-tools-extra [clangd] FindTarget: UsingEnumDecl is not an alias 2022-10-08 19:29:35 +02:00
cmake Revert "[cmake] Use `CMAKE_INSTALL_LIBDIR` too" 2022-08-18 22:46:32 -04:00
compiler-rt [memprof] dump memprof profile when receive deadly signals 2022-10-08 10:08:23 +08:00
cross-project-tests [Pipelines] Introduce DAE after ArgumentPromotion 2022-09-22 15:33:46 -07:00
flang [flang][nfc] Relocate a few driver tests 2022-10-07 17:04:06 +00:00
libc [libc] Document which date funcs are needed/done 2022-10-08 00:06:22 +00:00
libclc [libclc] Quote addition of CLC/LLAsm flags 2022-08-31 11:10:24 +02:00
libcxx [libc++] Make charconv require C++17 or later. 2022-10-08 13:50:30 +02:00
libcxxabi [SystemZ][z/OS] Add ASCII and 32-bit variants for libc++. 2022-10-03 17:24:02 -05:00
libunwind [libunwind] Fix compile error with CROSS_UNWINDING 2022-09-30 12:04:19 -07:00
lld Revert "[lld/mac] Port typo correction for undefined symbols from ELF port" 2022-10-07 13:37:48 +02:00
lldb [LLDB] Add "frame select" as equivalent of GDB's "frame" command 2022-10-07 09:30:05 +00:00
llvm Add myself to CREDITS.TXT + CODE_OWNERS.TXT 2022-10-09 09:02:20 +08:00
llvm-libgcc [cmake] Slight fix ups to make robust to the full range of GNUInstallDirs 2022-07-26 14:48:49 +00:00
mlir Apply clang-tidy fixes for llvm-else-after-return in TosaToLinalg.cpp (NFC) 2022-10-08 18:18:13 +00:00
openmp [NFC] Remove trailing white space in openmp/libomptarget/src/CMakeLists.txt 2022-10-07 13:42:31 -04:00
polly [CMake] Avoid `LLVM_BINARY_DIR` when other more specific variable are better-suited, part 2 2022-09-14 15:48:58 -04:00
pstl Revert "[cmake] Use `CMAKE_INSTALL_LIBDIR` too" 2022-08-18 22:46:32 -04:00
runtimes Revert "[runtimes] Use a response file for runtimes test suites" 2022-08-29 11:25:29 -07:00
third-party Revert "[cmake] Use `CMAKE_INSTALL_LIBDIR` too" 2022-08-18 22:46:32 -04:00
utils [mlir][Bazel] Port d85f6e5d57 2022-10-07 13:49:28 +02:00
.arcconfig
.arclint
.clang-format
.clang-tidy Add -misc-const-correctness to .clang-tidy 2022-08-08 13:00:52 -07:00
.git-blame-ignore-revs Add __config formatting to .git-blame-ignore-revs 2022-06-14 09:52:49 -04:00
.gitignore [llvm] Ignore .rej files in .gitignore 2022-04-28 08:44:51 -07:00
.mailmap [mailmap] Add entry for myself 2022-08-08 16:29:06 +08:00
CONTRIBUTING.md docs: update some bug tracker references (NFC) 2022-01-10 15:59:08 -08:00
LICENSE.TXT [docs] Add LICENSE.txt to the root of the mono-repo 2022-08-24 09:35:00 +02:00
README.md Fix grammar and punctuation across several docs; NFC 2022-04-07 07:11:11 -04: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 the 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 here.

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 frontend. 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='...' and -DLLVM_ENABLE_RUNTIMES='...' --- semicolon-separated list of the LLVM sub-projects and runtimes you'd like to additionally build. LLVM_ENABLE_PROJECTS can include any of: clang, clang-tools-extra, cross-project-tests, flang, libc, libclc, lld, lldb, mlir, openmp, polly, or pstl. LLVM_ENABLE_RUNTIMES can include any of libcxx, libcxxabi, libunwind, compiler-rt, libc or openmp. Some runtime projects can be specified either in LLVM_ENABLE_PROJECTS or in LLVM_ENABLE_RUNTIMES.

        For example, to build LLVM, Clang, libcxx, and libcxxabi, use -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_RUNTIMES="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). Be careful if you install runtime libraries: if your system uses those provided by LLVM (like libc++ or libc++abi), you must not overwrite your system's copy of those libraries, since that could render your system unusable. In general, using something like /usr is not advised, but /usr/local is fine.

      • -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 to run. In most cases, you get the best performance if you specify the number of CPU threads you have. On some Unix systems, you can specify this with -j$(nproc).

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

Getting in touch

Join LLVM Discourse forums, discord chat or #llvm IRC channel on OFTC.

The LLVM project has adopted a code of conduct for participants to all modes of communication within the project.