From patchwork Wed Feb 26 23:23:36 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nick Desaulniers X-Patchwork-Id: 11407479 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 9D87792A for ; Wed, 26 Feb 2020 23:23:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 67D0F20658 for ; Wed, 26 Feb 2020 23:23:51 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="GSalGtQy" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727920AbgBZXXu (ORCPT ); Wed, 26 Feb 2020 18:23:50 -0500 Received: from mail-pj1-f74.google.com ([209.85.216.74]:44922 "EHLO mail-pj1-f74.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727749AbgBZXXu (ORCPT ); Wed, 26 Feb 2020 18:23:50 -0500 Received: by mail-pj1-f74.google.com with SMTP id c31so433074pje.9 for ; Wed, 26 Feb 2020 15:23:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=zMAfUHJJiNLY4kAwxfSfFqfgoKQ5jUFofqSLJDdWxPU=; b=GSalGtQymTDs5BKgjs6cq8yGfJg/2aIJUeFnCf+jy83fYF69PucinQ8eanbN3ge7KQ Utnklx6MpNNRLQ4eb9nPa8j5WU0IAfMJnBj888Kbfx+uGPaZYp5Qp2SPUu0QM73jxAEQ SjGzgZJ9RJqIo/ovlChaiv4ThwgBNNgc9T0ZzW3k1TmvIMB6rh6VbEwaQsu+Z6fa8nJI 2q6bNfzpUAYKWsQtydKpeovaDWYLGgKAXSACl5BDqkBBl/NQlhq9/ZMNX2f/WDK4z6bu ayPfEAeVxmSAXpzgvIAZblosUPpFK+wAvSWo4IfTglQLAZY1JsDXnUKKDZT1zpNBWhp0 XaHw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=zMAfUHJJiNLY4kAwxfSfFqfgoKQ5jUFofqSLJDdWxPU=; b=nO+JWYYtGq9hurHdtQpsHh5lCYWN6SZmhPCK0iRKgbVWRMYUxJvMoZ/qBTTei+jm7a WsFnuKv4k4ilILZq/11MDqmtu1UnHiy+pIX5Gp/B+MIDoVvB9JGE6tYHhHXEMhZWH6wh 40vyRYiqRUgF/jzy4aONJpV7pNSPDkFDd4pnwxWzCiYe0StfXB1X/jBE1l/zZ3lA2aht b1Mwxm0qMICMlm5enfDaHXC7fGAYo3g08PZ/zi0FbJsvgDUF7c/pvc1yXbsJ36Ku/7P4 uanV18hlULUM4xunbwR8RtFk7I7eDg98gcq3YgOc9nOBP3qA7+pHaZ7fAuh/IYyuvz1g M7SA== X-Gm-Message-State: APjAAAXBvJJz9u9bljPyyoMbfppCaV09iug0dMSPnn/NSABEvS1QiwxY FEgooxZ1SQKnVIJTXuj1jUiisRnOcDc9t/LuKDM= X-Google-Smtp-Source: APXvYqx7LBf15YkCrDwdvWPHxR1x7Hdivto6HOgT22kd7Osik9IknfZY8HczyWn3EEZxCJqEhdN1W3gFaII1S72k8mk= X-Received: by 2002:a63:d845:: with SMTP id k5mr1115560pgj.183.1582759429173; Wed, 26 Feb 2020 15:23:49 -0800 (PST) Date: Wed, 26 Feb 2020 15:23:36 -0800 In-Reply-To: <20200225210250.64366-1-ndesaulniers@google.com> Message-Id: <20200226232336.252872-1-ndesaulniers@google.com> Mime-Version: 1.0 References: <20200225210250.64366-1-ndesaulniers@google.com> X-Mailer: git-send-email 2.25.0.265.gbab2e86ba0-goog Subject: [PATCH v3] Documentation/llvm: add documentation on building w/ Clang/LLVM From: Nick Desaulniers To: corbet@lwn.net, masahiroy@kernel.org Cc: rdunlap@infradead.org, michal.lkml@markovi.net, linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, clang-built-linux@googlegroups.com, Nick Desaulniers , Kees Cook , Nathan Chancellor , Sedat Dilek Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org Added to kbuild documentation. Provides more official info on building kernels with Clang and LLVM than our wiki. Suggested-by: Kees Cook Reviewed-by: Kees Cook Reviewed-by: Nathan Chancellor Reviewed-by: Sedat Dilek Signed-off-by: Nick Desaulniers --- Changes V2 -> V3: * Drop Randy's Suggested-by tag. Sorry Randy, I do appreciate the review though. * Add F: line to MAINTAINERS. Changes V1 -> V2: * s/On going/ongoing/ * add Randy's Suggested-by * add Nathan and Sedat's Reviewed-by * Upgrade Kees' Sugguested-by to Reviewed-by * s/suffix/prefix/ Documentation/kbuild/index.rst | 1 + Documentation/kbuild/llvm.rst | 80 ++++++++++++++++++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 82 insertions(+) create mode 100644 Documentation/kbuild/llvm.rst diff --git a/Documentation/kbuild/index.rst b/Documentation/kbuild/index.rst index 0f144fad99a6..3882bd5f7728 100644 --- a/Documentation/kbuild/index.rst +++ b/Documentation/kbuild/index.rst @@ -19,6 +19,7 @@ Kernel Build System issues reproducible-builds + llvm .. only:: subproject and html diff --git a/Documentation/kbuild/llvm.rst b/Documentation/kbuild/llvm.rst new file mode 100644 index 000000000000..d6c79eb4e23e --- /dev/null +++ b/Documentation/kbuild/llvm.rst @@ -0,0 +1,80 @@ +============================== +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 +`_ and `LLVM `_ utilities to be +used as viable substitutes. Distributions such as `Android +`_, `ChromeOS +`_, and `OpenMandriva +`_ use Clang built kernels. `LLVM is a +collection of toolchain components implemented in terms of C++ objects +`_. 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 `. For +example: + + clang --target aarch64-linux-gnu foo.c + +LLVM Utilities +-------------- + +LLVM has substitutes for GNU binutils utilities. These can be invoked as +additional parameters to `make`. + + make CC=clang AS=clang LD=ld.lld AR=llvm-ar NM=llvm-nm STRIP=llvm-strip \\ + OBJCOPY=llvm-objcopy OBJDUMP=llvm-objdump OBJSIZE=llvm-objsize \\ + READELF=llvm-readelf HOSTCC=clang HOSTCXX=clang++ HOSTAR=llvm-ar \\ + HOSTLD=ld.lld + +Getting Help +------------ + +- `Website `_ +- `Mailing List `_: +- `Issue Tracker `_ +- IRC: #clangbuiltlinux on chat.freenode.net +- `Telegram `_: @ClangBuiltLinux +- `Wiki `_ +- `Beginner Bugs `_ + +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/ diff --git a/MAINTAINERS b/MAINTAINERS index 8b85f22b9b69..79e1f9bfb2b6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4124,6 +4124,7 @@ B: https://github.com/ClangBuiltLinux/linux/issues C: irc://chat.freenode.net/clangbuiltlinux S: Supported K: \b(?i:clang|llvm)\b +F: Documentation/kbuild/llvm.rst CLEANCACHE API M: Konrad Rzeszutek Wilk