Beyond Linux® From Scratch - Version 8.1

Chapter 13. Programming

LLVM-4.0.1

Introduction to LLVM

The LLVM package contains a collection of modular and reusable compiler and toolchain technologies. The Low Level Virtual Machine (LLVM) Core libraries provide a modern source and target-independent optimizer, along with code generation support for many popular CPUs (as well as some less common ones!). These libraries are built around a well specified code representation known as the LLVM intermediate representation ("LLVM IR").

The optional Clang and Compiler RT packages provide new C, C++, Objective C and Objective C++ front-ends and runtime libraries for the LLVM.

This package is known to build and work properly using an LFS-8.1 platform.

Package Information

  • Download (HTTP): http://llvm.org/releases/4.0.1/llvm-4.0.1.src.tar.xz

  • Download MD5 sum: a818e70321b91e2bb2d47e60edd5408f

  • Download size: 20 MB

  • Estimated disk space required: 1.8 GB (with Clang, add 8.2 GB for tests)

  • Estimated build time: 19 SBU (with Clang and parallelism=4, add 14 SBU for tests using 12 cores)

Optional Downloads

Clang

Compiler RT

LLVM Dependencies

Required

CMake-3.9.1

Recommended

libffi-3.2.1 and Python-2.7.13

Optional

Doxygen-1.8.13, Graphviz-2.40.1, libxml2-2.9.4, texlive-20170524 (or install-tl-unx), Valgrind-3.13.0, Zip-3.0, OCaml, and Sphinx

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/llvm

Installation of LLVM

If you have downloaded the optional packages, install them into the source tree by running the following commands: 

tar -xf ../cfe-4.0.1.src.tar.xz -C tools &&
tar -xf ../compiler-rt-4.0.1.src.tar.xz -C projects &&

mv tools/cfe-4.0.1.src tools/clang &&
mv projects/compiler-rt-4.0.1.src projects/compiler-rt

patch -Np1 -d projects/compiler-rt < ../compiler-rt-4.0.1-glibc-2.26-1.patch

Install LLVM by running the following commands: 

mkdir -v build &&
cd       build &&

CC=gcc CXX=g++                              \
cmake -DCMAKE_INSTALL_PREFIX=/usr           \
      -DLLVM_ENABLE_FFI=ON                  \
      -DCMAKE_BUILD_TYPE=Release            \
      -DLLVM_BUILD_LLVM_DYLIB=ON            \
      -DLLVM_TARGETS_TO_BUILD="host;AMDGPU" \
      -Wno-dev ..                           &&
make

If you have installed Sphinx and wish to generate the html documentation and manual pages, issue the following commands: 

cmake -DLLVM_ENABLE_SPHINX=ON         \
      -DSPHINX_WARNINGS_AS_ERRORS=OFF \
      -Wno-dev ..                     &&
make docs-llvm-html  docs-llvm-man

If you have downloaded the optional packages, the clang documentation can be built too: 

make docs-clang-html docs-clang-man

To test the results, issue: make check-all. Tests are run using the maximum number of processors/threads available. Note that the Address Sanitizer tests are known to fail, and that 19 tests fail because of the removal of an obsolete header.

Now, as the root user: 

make install

If you have built the documentation, install it by running the following command as the root user: 

install -v -m644 docs/man/* /usr/share/man/man1             &&
install -v -d -m755 /usr/share/doc/llvm-4.0.1/llvm-html     &&
cp -Rv docs/html/* /usr/share/doc/llvm-4.0.1/llvm-html

The clang documentation can be installed in the same way (again as the root user): 

install -v -m644 tools/clang/docs/man/* /usr/share/man/man1 &&
install -v -d -m755 /usr/share/doc/llvm-4.0.1/clang-html    &&
cp -Rv tools/clang/docs/html/* /usr/share/doc/llvm-4.0.1/clang-html

Command Explanations

-DLLVM_ENABLE_FFI=ON: This switch enables LLVM to use libffi. Remove if you did not install libffi.

-DLLVM_BUILD_LLVM_DYLIB=ON: builds libraries as static and links all of them into an unique shared one. This is the recommended way of building a shared library.

-DCMAKE_BUILD_TYPE=Release: This switch enables compiler optimizations in order to speed up the code and reduce its size. It also disables some compile checks, not necessary on a production system.

-DLLVM_TARGETS_TO_BUILD="host;AMDGPU": This switch enables building for the same target as the host, and also for the r600 AMD GPU used by the Mesa r600 and radeonsi drivers. Default is all. You can use a semicolon separated list. Valid targets are: host, X86, Sparc, PowerPC, ARM, AArch64, Mips, Hexagon, Xcore, MSP430, NVPTX, SystemZ, AMDGPU, BPF, CppBackend, or all.

-DLLVM_LINK_LLVM_DYLIB=ON: Used in conjunction with -DLLVM_BUILD_LLVM_DYLIB=ON, this switch enables linking the tools against the shared library instead of the static ones.

-DBUILD_SHARED_LIBS=ON: if used instead of -DLLVM_BUILD_LLVM_DYLIB=ON, builds all the LLVM libraries (about 60) as shared libraries instead of static.

-DLLVM_ENABLE_DOXYGEN: Enables the generation of browsable HTML documentation if you have installed Doxygen-1.8.13. You should run make doxygen-html afterwards, and install the generated documentation manually.

Contents

Installed Programs: bugpoint, c-index-test, clang, clang++ (symlinks to clang-<version>), clang-<version>, clang-check, clang-cl, clang-format, git-clang-format, llc, lli, llvm-ar, llvm-as, llvm-bcanalyzer, llvm-config, llvm-cov, llvm-c-test, llvm-cxxdump, llvm-diff, llvm-dis, llvm-dsymutil, llvm-dwarfdump, llvm-dwp, llvm-extract, llvm-lib (symlink to llvm-ar), llvm-link, llvm-lto, llvm-mc, llvm-mcmarkup, llvm-nm, llvm-objdump, llvm-pdbdump, llvm-profdata, llvm-ranlib (symlink to llvm-ar), llvm-readobj, llvm-rtdyld, llvm-size, llvm-split, llvm-stress, llvm-symbolizer, llvm-tblgen, obj2yaml, opt, sancov, sanstats, scan-build, scan-view, verify-uselistorder, and yaml2obj
Installed Libraries: BugpointPasses.so, LLVMHello.so, libLLVM.so, libLLVM*.a (57 libraries), libLTO.so, libclang.so and libclang*.a (24 libraries)
Installed Directories: /usr/include/{clang,clang-c,llvm,llvm-c}, /usr/lib/{clang,cmake/{clang,llvm}} and /usr/share/{clang,scan-build,scan-view,doc/llvm-4.0.1}

Short Descriptions

bugpoint

is the automatic test case reduction tool.

clang

is the Clang C, C++, and Objective-C compiler.

clang-format

is a tool to format C/C++/Java/JavaScript/Objective-C/Protobuf code.

llc

is the LLVM static compiler.

lli

is used to directly execute programs from LLVM bitcode.

llvm-ar

is the LLVM archiver.

llvm-as

is the LLVM assembler.

llvm-bcanalyzer

is the LLVM bitcode analyzer.

llvm-config

Prints LLVM compilation options.

llvm-cov

is used to emit coverage information.

llvm-c-test

is a bytecode disassembler.

llvm-cxxdump

is used as a C++ ABI Data Dumper.

llvm-diff

is the LLVM structural 'diff'.

llvm-dis

is the LLVM disassembler.

llvm-dsymutil

is a tool used to manipulate archived DWARF debug symbol files, compatible with the Darwin command dsymutil.

llvm-dwarfdump

prints the content of DWARF sections in object files.

llvm-dwp

merges split DWARF files.

llvm-extract

is used to extract a function from an LLVM module.

llvm-link

is the LLVM linker.

llvm-lto

is the LLVM LTO (link time optimization) linker.

llvm-mc

is a standalone machine code assembler/disassembler.

llvm-nm

is used to list LLVM bitcode and object file's symbol table.

llvm-objdump

is an LLVM object file dumper.

llvm-pdbdump

is used as PDB Dumper.

llvm-profdata

is a small tool to manipulate and print profile data files.

llvm-ranlib

is used to generate an index for a LLVM archive.

llvm-readobj

displays low-level format-specific information about object files.

llvm-rtdyld

is the LLVM MC-JIT tool.

llvm-size

is the LLVM object size dumper.

llvm-split

is the LLVM module splitter.

llvm-stress

is used to generate random .ll files.

llvm-symbolizer

converts adresses into source code locations.

llvm-tblgen

is the LLVM Target Description To C++ Code Generator.

obj2yaml

takes an object file,and produces a YAML representation of the file.

opt

is the LLVM optimizer.

sancov

is the sanitizer coverage processing tool.

sanstats

is the sanitizer statistics processing tool.

scan-build

is a Perl script that invokes the Clang static analyzer.

scan-view

is a viewer for Clang static analyzer results.

verify-uselistorder

is the LLVM tool to verify use-list order.

yaml2obj

takes a YAML representation of an object file and converts it to a binary file.

Last updated on 2017-08-23 21:43:54 -0700