A script to create a standalone installation of clang/LLVM/libc++
Shell Makefile C++
Switch branches/tags
Nothing to show
Latest commit 6e7ab9e Nov 5, 2015 @Bialogs Bialogs Fixed typo

README.md

install-clang

This script installs self-contained standalone versions of clang, LLVM, libc++, and compiler-rt on Darwin, FreeBSD, and Linux, including linking clang and LLVM themselves against libc++ as well. The script keeps all of the installation within a given target prefix (e.g., /opt/llvm), and hence separate from any already installed compilers, libraries, and include files. In particular, you can later deinstall everything easily by just deleting, e.g., /opt/llvm. Furthermore, as long as the prefix path is writable, the installation doesn't need root privileges.

If you have used older version of the script before, see News below for changes.

Usage

To see the available options, use -h:

> ./install-clang -h
Usage: install-clang [<options>] <install-prefix>

Available options:
    -A         enables assertions in LLVM libraries
    -b         build type (Release, Debug, RelWithDebInfo) [default: RelWithDebInfo]
    -c         skip cloning repositories, assume they are in place
    -h|-?      display this help
    -j <n>     build with <n> threads in parallel [default: 1]
    -m         use git/master instead of preconfigured versions
    -s <stage> begin build from <stage> [0, 1, 2]
    -u         update an existing build in <prefix> instead of installing new

Environment variables:
    CC         path to the C compiler for bootstrapping
    CXX        path to the C++ compiler for bootstrapping

For example, to build Clang on a machine with multiple cores and install it in /opt/llvm, you can use:

> ./install-clang -j 16 /opt/llvm

Once finished, just prefix your PATH with <prefix>/bin and you're ready to use the new binaries:

> clang++ --std=c++11 --stdlib=libc++ test.cc -o a.out && ./a.out
Hello, Clang!

By default, install-clang currently installs the 3.5 release branches of the relevant llvm.org projects. Adding -m on the command line instructs the script to use the current git master versions instead. The script downloads all the sources from the corresponding git repositories and compiles the pieces as needed. Other OSs than Darwin, FreeBSD, and Linux are not currently supported.

The script also has an update option -u that allows for catching up with upstream repository changes without doing the complete compile/install-from-scratch cycle again. Note, however, that unless coupled with -m, this flag has no immediate effect since the git versions to use are hardcoded to the LLVM/clang release versions.

Doing a self-contained clang/LLVM installation is a bit more messy than one would hope because the projects make assumptions about specific system-wide installation paths to use. The install-clang script captures some trial-and-error I (and others) went through to get an independent setup working. It compiles clang/LLVM up to three times, bootstrapping things with the system compiler as it goes. It also patches some of the LLVM projects to incorporate the installation prefix into configuration and search paths, and also fixes/tweaks a few other things as well.

Docker

install-clang comes with a Dockerfile to build a Docker image, based on Ubuntu, with clang/LLVM then in /opt/llvm:

# make docker-build && make docker-run
[... get a beer ...]
root@f39b941f177c:/# clang --version
clang version 3.5.0
Target: x86_64-unknown-linux-gnu
Thread model: posix
root@f39b941f177c:/# which clang
/opt/llvm/bin/clang

A prebuilt image is available at https://registry.hub.docker.com/u/rsmmr/clang.

News

The install-clang script for LLVM 3.5 comes with a few changes compared to earlier version:

  • The script now supports FreeBSD as well. (Contributed by Matthias Vallentin).

  • The script now generally shared libraries for LLVM and clang, rather than static ones.

  • As libc++abi now works well on Linux as well, we use it generally and no longer support libcxxrt.

  • There are now command line options to select build mode and assertions explicitly.

  • There's no 3rd phase anymore building assertion-enabled LLVM libraries, as changing compilation options isn't useful with shared libraries.

  • In return, there's a phase 0 now if the system compiler isn't a clang; libc++abi needs clang that for its initial compilation already.

  • There's now a Dockerfile to build an image with clang/LLVM in /opt/llvm.