User:Csfore/LLVM/Clang

Important
This is for the C compiler, llvm-core/clang! For general LLVM information (i.e. LLVM profiles, experimental information, etc.) please refer to LLVM.

Home

GitHub

Project

Official documentation

#llvm (on irc://irc.oftc.net)

Package information

Clang is a C/C++/Objective-C/C++, CUDA, and RenderScript language front-end for the LLVM project with a focus on standards, code correctness, and useful diagnostic messages to ease compile time troubleshooting.

Clang can be used as an alternative to GCC. Simple usage is calling Clang instead of GCC, despite the latter providing more than a simple compiler front-end. The GCC toolchain also provides the system's C++ library, unwinder, OpenMP, and runtime libraries and sanitizers. It's possible to use Clang with LLVM's alternatives in place of the GCC provided libraries. These are part of the fundamental building blocks of a Linux system and toolchain.

Furthermore, it's possible to use a fully self contained LLVM toolchain by calling the LLVM alternatives to GNU binutils, thus bypassing nearly all the GNU toolchain with the exception of the C library which is usually provided by GNU glibc.

C, Objective-C, C++, and Objective-C++ compatibility can be found here, as detailed on the Clang compatibility website.

Prerequisites

One of the goals of the Clang project is to be compatible with code written with GCC as the target compiler. Using Clang system wide is experimental and comes with associated risks, such as packages requiring GCC specific functions, failures to build correctly, or successful compilations but having issues when executed. These can be reported in the system wide Clang bugtracker. In these events, it's necessary to use GCC as a fallback.

Important
A compiler toolchain and how it functions compared to another is way beyond the scope of this article, but a understanding a few key differences is important to a Gentoo user wanting to daily drive the Clang and/or LLVM toolchain system wide.

Important differences when compared to GCC

Clang doesn't support some GCC extensions like nested functions. This is the main reason Clang is not able to compile sys-libs/glibc although currently a lot of work is happening to make glibc alternate toolchain friendly.

Second, GCC defaults to -ftrapping-math, Clang defaults to -fno-trapping-math.

GCC doesn't need a separate library installed for PGO and is self sufficient. Clang requires llvm-runtimes/compiler-rt-santizers[profile orc] before enabling the pgo USE flag for packages.

GCC interposes code via -fsemantic-interposition by default. Clang does interprocedural optimizations by default, but -fno-semantic-interposition allows further interprocedural optimizations if the code allows it.^[1]

Minor differences to GCC

GCC defaults to -ffp-contract=fast while Clang defaults to -ffp-contract=on. Unless wanting to match GCC's slightly riskier behavior there should be no issue with Clang's safer default.

Until version 12, GCC didn't run vector optimizations at -O2 or lower. Clang runs vector optimizations at all levels greater than -O1 except level -Oz, which only runs the SLP vectorizer.^[2] Though unlikely to cause issue, it's currently relevant since sys-devel/gcc:11 is still in ::gentoo.

Both compilers LTO phases function drastically different and it's outside the scope of this article to detail it. What works with GCC may or may not work for Clang, and vice versa.

Installation

USE flags

USE flags for llvm-core/clang C language family frontend for LLVM

`+debug`	Enable extra debug codepaths, like asserts and extra output. If you want to get meaningful backtraces see https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces
`+extra`	Build extra tools (clangd, clang-tidy and a few more)
`+pie`	Build programs as Position Independent Executables (a security hardening technique)
`+static-analyzer`	Install the Clang static analyzer
`doc`	Add extra documentation (API, Javadoc, etc). It is recommended to enable per package instead of globally
`ieee-long-double`	Use accelerated 128-bit IEEE long double ABI (ppc64le only)
`test`	Enable dependencies and/or preparations necessary to run tests (usually controlled by FEATURES=test but can be toggled independently)
`verify-sig`	Verify upstream signatures on distfiles
`xml`	Add support for XML files

Data provided by the Gentoo Package Database · Last update: 2025-01-04 15:27 More information about USE flags

LLVM_TARGETS

For information on setting LLVM_TARGETS for clang, refer to LLVM#LLVM_TARGETS.

Emerge

root #emerge --ask llvm-core/clang

Configuration

There are many possible configurations. This section assumes the user wants to choose to use Clang to compile some packages. It is unrelated to packages using LLVM or Clang for their libraries.

Users may wish to default to Clang and selectively use GCC or vice-versa.

There are two ways to do this:

System wide using /etc/portage/make.conf or,
via environment variables like the one(s) created for the GCC fallback.

make.conf

Note
Clang versions prior to 14.0.0 did not have a default-pie option similar to gcc. Prior versions would need -fPIC in CFLAGS and -pie in LDFLAGS. Users should clean up any stale references in *FLAGS.

Users will still need GCC to build some packages like glibc or wine. Gentoo maintains a tracker bug (bug #408963) for packages that fail to build with Clang.

Configuring Gentoo to use Clang system wide is simple. Change the CC and CXX variables in /etc/portage/make.conf to reference the Clang equivalents. No further configuration is necessary.

FILE /etc/portage/make.conf

# Normal settings here
COMMON_FLAGS="-O2 -march=native"
CFLAGS="${COMMON_FLAGS}"
CXXFLAGS="${COMMON_FLAGS}"

CC="clang"
CPP="clang-cpp" # necessary for xorg-server and possibly other packages
CXX="clang++"
AR="llvm-ar"
NM="llvm-nm"
RANLIB="llvm-ranlib"

Alternatively, the same contents could be put in e.g. /etc/portage/env/compiler-clang. This would allow using Clang on a per package basis by invoking the compiler-clang environment file if desired:

FILE /etc/portage/package.envUsing the Clang compiler for app-foo/bar and app-bar/baz

app-foo/bar compiler-clang
app-bar/baz compiler-clang

GCC fallback environment

Create a configuration file with a set of environment variables using Portage's built in /etc/portage/env directory. This will override any defaults for any packages that fail to compile with clang.

The name used below is just an example, so feel free to choose whatever name is desired for the fallback environment. Be sure to substitute the chosen name with the examples used in this article.

The most basic example is:

FILE /etc/portage/env/compiler-gccEnvironment named compiler-gcc

COMMON_FLAGS="-O2 -march=native"
CFLAGS="${COMMON_FLAGS}"
CXXFLAGS="${COMMON_FLAGS}"
LDFLAGS="-Wl,--as-needed"

CC="gcc"
CXX="g++"
CPP="gcc -E"
AR="ar"
NM="nm"
RANLIB="ranlib"

In the event GCC should be used as the fallback environment, set the appropriate flags in the /etc/portage/package.env file:

FILE /etc/portage/package.envFalling back to GCC for app-foo/bar and app-bar/baz

# Compiled using GCC with no link-time optimization since package baz fails using lto
app-bar/baz compiler-gcc
# Compiled using GCC with link-time optimization since package bar compiles using lto
app-foo/bar compiler-gcc-lto

Advanced usage

LTO

Warning
Static libraries built with clang LTO or LTO-thin are not understandable by GCC and vice versa: static libraries built by GCC with LTO are not understandable by clang . Solutions can be:

Disable USE flag static-libs
Turn off LTO for packages with the static-libs
With all packages that use static libraries use only one compiler.

The link-time optimization feature defers optimizing the resulting executables to linking phase. This can result in better optimization of packages but isn't standard behavior in Gentoo yet. Clang uses the linker, llvm-core/lld, for LTO.

Environment

Clang supports two types of link time optimization:

Full LTO, which is the traditional approach also used by GCC where the whole link unit is analyzed at once. Using it is no longer recommended.
ThinLTO, where the link unit is scanned and split up into multiple parts.^[3] With ThinLTO, the final compilation units only contain the code that are relevant to the current scope, thus speeding up compilation, lowering footprint and allowing for more parallelism at (mostly) no cost. ThinLTO is the recommended LTO mode when using Clang.

For full LTO, replace -flto=thin with -flto in the following examples. There should be no compatibility differences between full LTO and thin LTO. Additionally, if Clang was not built with the default-lld USE flag, add the -fuse-ld=lld value to the following LDFLAGS.

FILE /etc/portage/env/compiler-clang-ltoEnvironment named compiler-clang-lto

CFLAGS="${CFLAGS} -flto=thin"
CXXFLAGS="${CXXFLAGS} -flto=thin"
# -O2 in LDFLAGS refers to binary size optimization during linking, it is NOT related to the -O levels of the compiler          
LDFLAGS="${LDFLAGS} -Wl,-O2 -Wl,--as-needed"

CC="clang"                         
CXX="clang++"
CPP="clang-cpp" # necessary for xorg-server and possibly other packages

As an alternative, LLVM provides its own ar, nm, and ranlib values. Feel free to use them though mileage may vary over using the standard ar, nm, and ranlib, since they're intended to handle LLVM bitcode which Clang produces when using the -flto flag.

FILE /etc/portage/env/compiler-clang-ltoEnvironment named compiler-clang-lto

CFLAGS="${CFLAGS} -flto=thin"
CXXFLAGS="${CXXFLAGS} -flto=thin"
# -O2 in LDFLAGS refers to binary size optimization during linking, it is NOT related to the -O levels of the compiler              
LDFLAGS="${LDFLAGS} -Wl,-O2 -Wl,--as-needed"

CC="clang"
CXX="clang++"
CPP="clang-cpp" # necessary for xorg-server and possibly other packages
AR="llvm-ar"
NM="llvm-nm"
RANLIB="llvm-ranlib"

Now set /etc/portage/package.env overrides using Clang with LTO enabled:

FILE /etc/portage/package.envEnabling LTO for app-foo/bar and app-bar/baz

app-foo/bar compiler-clang-lto
app-bar/baz compiler-clang-lto

Global configuration

Similar to what was covered earlier in the article, a system wide Clang with LTO enabled can be done by changing the /etc/portage/make.conf file:

FILE /etc/portage/make.confSetting the system compiler to Clang

CFLAGS="${CFLAGS} -flto=thin"
CXXFLAGS="${CXXFLAGS} -flto=thin"
# -O2 in LDFLAGS refers to binary size optimization during linking, it is NOT related to the -O levels of the compiler          
LDFLAGS="${LDFLAGS} -Wl,-O2 -Wl,--as-needed"

CC="clang"
CXX="clang++"
CPP="clang-cpp" # necessary for xorg-server and possibly other packages
AR="llvm-ar"
NM="llvm-nm"
RANLIB="llvm-ranlib"

Again, it is possible to set the AR, NM, and RANLIB to the LLVM implementations. Since earlier in the article compiler environments were set up using Clang without LTO, GCC without LTO, and GCC with LTO, it is now possible to pick and choose which is best on a per package basis. Since the goal is to compile packages system wide with Clang using LTO and not every package will successfully compile using it, fall back to Clang with LTO disabled or GCC. The /etc/portage/package.env may look like the following:

FILE /etc/portage/package.envExample package.env setup

# Compiled using Clang with no link-time optimization since package bar fails using flto
app-foo/bar compiler-clang
# Compiled using GCC with no link-time optimization since package baz fails using flto
app-bar/baz compiler-gcc
# Compiled using GCC with link-time optimization since package foo compiles using flto
app-baz/foo compiler-gcc-lto

PGO

Emerge llvm-core/clang-runtime[sanitize] and llvm-runtimes/compiler-rt-sanitizers[profile orc]

root #emerge --ask llvm-core/clang-runtime

root #emerge --ask llvm-runtimes/compiler-rt-sanitizers

And finally, add USE="pgo" globally or locally, using package.use and update:

root #emerge --ask --verbose --update --deep --changed-use @world

Warning
Not having the USE flags profile and orc enabled will cause packages such as dev-lang/python[pgo] to fail the compile phase.

Note
build.log will report following errors if you do not have compiler-rt-sanitizers installed.

ld.lld: error: cannot open /usr/lib/llvm/18/bin/../../../../lib/clang/18/lib/linux/libclang_rt.profile-x86_64.a: No such file or directory
clang: error: linker command failed with exit code 1 (use -v to see invocation)

Example bug #917263

ccache

ccache support is automatic once Clang is emerged.

Troubleshooting

The main place for looking up known failures with Clang is the tracker bug #408963. If hitting an issue not reported on Gentoo's Bugzilla already, please open a new bug report and make it block the linked tracker.

Compile errors when using Clang with -flto

If the packages being installed are failing, check the logs. Often, packages with errors like the following will need to disable LTO by invoking the compiler-clang environment.

FILE /var/log/portage/sys-apps:less-483-r1:20160712-034715.log

/usr/bin/x86_64-pc-linux-gnu-ld: error: version.o:1:3: invalid character
/usr/bin/x86_64-pc-linux-gnu-ld: error: version.o:1:3: syntax error, unexpected $end
/usr/bin/x86_64-pc-linux-gnu-ld: error: version.o: not an object or archive

The following error may be seen in every LTO failure case:

FILE /var/log/portage/sys-apps:less-483-r1:20160712-034715.log

x86_64-pc-linux-gnu-clang-3.8: error: linker command failed with exit code 1 (use -v to see invocation)

Simply add the failing package to /etc/portage/package.env. In this case, it's the sys-apps/less package, so to apply the proper override.

FILE /etc/portage/package.envExample package.env setup

# Compiled using Clang with no link-time optimization since the package 'less' fails using lto
sys-apps/less compiler-clang

Sometimes a package will fail to compile even when disabling LTO because it requires another package which was compiled using -flto and works incorrectly. Something like the following error may be seen:

FILE /var/log/portage/dev-libs:boehm-gc-7.4.2:20160713-085706.log

/usr/lib64/libatomic_ops.a: error adding symbols: Archive has no index; run ranlib to add one

In this case libatomic_ops is causing boehm-gc to fail compiling. Recompile the program causing the failure using the non-LTO environment and then recompile the new program. In this case, boehm-gc fails when using LTO, so add both of them to the /etc/portage/package.env file to build them without LTO:

FILE /etc/portage/package.envExample package.env setup

dev-libs/boehm-gc compiler-clang
dev-libs/libatomic_ops compiler-clang

Use of GNU extensions without proper -std =

Some packages tend to use GNU extensions in their code without specifying -std= appropriately. GCC allows that usage, yet Clang disables some of more specific GNU extensions by default.

If a particular package relies on such extensions being available, then append the correct -std= flag to it:

-std=gnu89 for C89/C90 with GNU extensions,
-std=gnu99 for C99 with GNU extensions,
-std=gnu++98 for C++:1998 with GNU extensions.

A common symptom of this problem are multiple definitions of inline functions like this:

FILE /var/log/portage/example.logExample package error in example log

/usr/bin/x86_64-pc-linux-gnu-ld: error: ../mpi/.libs/libmpi.a(mpi-bit.o): multiple definition of '_gcry_mpih_add'
/usr/bin/x86_64-pc-linux-gnu-ld: ../mpi/.libs/libmpi.a(mpi-add.o): previous definition here
/usr/bin/x86_64-pc-linux-gnu-ld: error: ../mpi/.libs/libmpi.a(mpi-bit.o): multiple definition of '_gcry_mpih_add_1'
/usr/bin/x86_64-pc-linux-gnu-ld: ../mpi/.libs/libmpi.a(mpi-add.o): previous definition here

This is because Clang uses C99 inline rules by default which do not work with gnu89 code. To work around it, it is likely necessary to pass -std=gnu89 or set one of the environmental overrides to use GCC to compile the failing package if passing the right -std= flag doesn't work.

Since both current (2020) GCC and Clang default to -std=gnu17 with C99 inline rules, chances are the problems have already been spotted by a GCC user.

sudo: clang: command not found

Clang is not added to /usr/bin and instead lives in a separate path that is added to the PATH variable. Sudo has a whitelisted PATH variable that is baked in at compile time. So when a new version of clang is installed, it will not be added to sudo's PATH until sudo is re-emerged.

References

External resources

[1] ttps://github.com/llvm/llvm-project/blob/f24c443e8241df7df1d5152c45636c76b682a043/clang/lib/Driver/ToolChains/Clang.cpp#L5349

[2] ttps://github.com/llvm/llvm-project/blob/f24c443e8241df7df1d5152c45636c76b682a043/clang/lib/Driver/ToolChains/Clang.cpp#L645

[3] ttps://blog.llvm.org/2016/06/thinlto-scalable-and-incremental-lto.html

[1]

[2]

[3]

User:Csfore/LLVM/Clang

Contents

Prerequisites

Important differences when compared to GCC

Minor differences to GCC

Installation

USE flags

USE flags for llvm-core/clang C language family frontend for LLVM

LLVM_TARGETS

Emerge

Configuration

make.conf

GCC fallback environment

Advanced usage

LTO

Environment

Global configuration

PGO

ccache

Troubleshooting

Compile errors when using Clang with -flto

Use of GNU extensions without proper -std =

sudo: clang: command not found

See also

References

External resources