mirror of
https://github.com/AuxXxilium/linux_dsm_epyc7002.git
synced 2024-12-28 05:45:09 +07:00
a0d1c951ef
As Documentation/kbuild/llvm.rst implies, building the kernel with a full set of LLVM tools gets very verbose and unwieldy. Provide a single switch LLVM=1 to use Clang and LLVM tools instead of GCC and Binutils. You can pass it from the command line or as an environment variable. Please note LLVM=1 does not turn on the integrated assembler. You need to pass LLVM_IAS=1 to use it. When the upstream kernel is ready for the integrated assembler, I think we can make it default. We discussed what we need, and we agreed to go with a simple boolean flag that switches both target and host tools: https://lkml.org/lkml/2020/3/28/494 https://lkml.org/lkml/2020/4/3/43 Some items discussed, but not adopted: - LLVM_DIR When multiple versions of LLVM are installed, I just thought supporting LLVM_DIR=/path/to/my/llvm/bin/ might be useful. CC = $(LLVM_DIR)clang LD = $(LLVM_DIR)ld.lld ... However, we can handle this by modifying PATH. So, we decided to not do this. - LLVM_SUFFIX Some distributions (e.g. Debian) package specific versions of LLVM with naming conventions that use the version as a suffix. CC = clang$(LLVM_SUFFIX) LD = ld.lld(LLVM_SUFFIX) ... will allow a user to pass LLVM_SUFFIX=-11 to use clang-11 etc., but the suffixed versions in /usr/bin/ are symlinks to binaries in /usr/lib/llvm-#/bin/, so this can also be handled by PATH. Signed-off-by: Masahiro Yamada <masahiroy@kernel.org> Reviewed-by: Nathan Chancellor <natechancellor@gmail.com> Tested-by: Nathan Chancellor <natechancellor@gmail.com> # build Tested-by: Nick Desaulniers <ndesaulniers@google.com> Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>
88 lines
3.0 KiB
ReStructuredText
88 lines
3.0 KiB
ReStructuredText
==============================
|
|
Building Linux with Clang/LLVM
|
|
==============================
|
|
|
|
This document covers how to build the Linux kernel with Clang and LLVM
|
|
utilities.
|
|
|
|
About
|
|
-----
|
|
|
|
The Linux kernel has always traditionally been compiled with GNU toolchains
|
|
such as GCC and binutils. Ongoing work has allowed for `Clang
|
|
<https://clang.llvm.org/>`_ and `LLVM <https://llvm.org/>`_ utilities to be
|
|
used as viable substitutes. Distributions such as `Android
|
|
<https://www.android.com/>`_, `ChromeOS
|
|
<https://www.chromium.org/chromium-os>`_, and `OpenMandriva
|
|
<https://www.openmandriva.org/>`_ use Clang built kernels. `LLVM is a
|
|
collection of toolchain components implemented in terms of C++ objects
|
|
<https://www.aosabook.org/en/llvm.html>`_. Clang is a front-end to LLVM that
|
|
supports C and the GNU C extensions required by the kernel, and is pronounced
|
|
"klang," not "see-lang."
|
|
|
|
Clang
|
|
-----
|
|
|
|
The compiler used can be swapped out via `CC=` command line argument to `make`.
|
|
`CC=` should be set when selecting a config and during a build.
|
|
|
|
make CC=clang defconfig
|
|
|
|
make CC=clang
|
|
|
|
Cross Compiling
|
|
---------------
|
|
|
|
A single Clang compiler binary will typically contain all supported backends,
|
|
which can help simplify cross compiling.
|
|
|
|
ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make CC=clang
|
|
|
|
`CROSS_COMPILE` is not used to prefix the Clang compiler binary, instead
|
|
`CROSS_COMPILE` is used to set a command line flag: `--target <triple>`. For
|
|
example:
|
|
|
|
clang --target aarch64-linux-gnu foo.c
|
|
|
|
LLVM Utilities
|
|
--------------
|
|
|
|
LLVM has substitutes for GNU binutils utilities. Kbuild supports `LLVM=1`
|
|
to enable them.
|
|
|
|
make LLVM=1
|
|
|
|
They can be enabled individually. The full list of the parameters:
|
|
|
|
make CC=clang LD=ld.lld AR=llvm-ar NM=llvm-nm STRIP=llvm-strip \\
|
|
OBJCOPY=llvm-objcopy OBJDUMP=llvm-objdump OBJSIZE=llvm-size \\
|
|
READELF=llvm-readelf HOSTCC=clang HOSTCXX=clang++ HOSTAR=llvm-ar \\
|
|
HOSTLD=ld.lld
|
|
|
|
Currently, the integrated assembler is disabled by default. You can pass
|
|
`LLVM_IAS=1` to enable it.
|
|
|
|
Getting Help
|
|
------------
|
|
|
|
- `Website <https://clangbuiltlinux.github.io/>`_
|
|
- `Mailing List <https://groups.google.com/forum/#!forum/clang-built-linux>`_: <clang-built-linux@googlegroups.com>
|
|
- `Issue Tracker <https://github.com/ClangBuiltLinux/linux/issues>`_
|
|
- IRC: #clangbuiltlinux on chat.freenode.net
|
|
- `Telegram <https://t.me/ClangBuiltLinux>`_: @ClangBuiltLinux
|
|
- `Wiki <https://github.com/ClangBuiltLinux/linux/wiki>`_
|
|
- `Beginner Bugs <https://github.com/ClangBuiltLinux/linux/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_
|
|
|
|
Getting LLVM
|
|
-------------
|
|
|
|
- http://releases.llvm.org/download.html
|
|
- https://github.com/llvm/llvm-project
|
|
- https://llvm.org/docs/GettingStarted.html
|
|
- https://llvm.org/docs/CMake.html
|
|
- https://apt.llvm.org/
|
|
- https://www.archlinux.org/packages/extra/x86_64/llvm/
|
|
- https://github.com/ClangBuiltLinux/tc-build
|
|
- https://github.com/ClangBuiltLinux/linux/wiki/Building-Clang-from-source
|
|
- https://android.googlesource.com/platform/prebuilts/clang/host/linux-x86/
|