Skip to contentSkip to conversation

infer --target from SRCARCH for CC=clang

PATCH Superseded Nick Desaulniers 3 participants 8 messages Jul 30, 2021 – Aug 2, 2021

Subsystems (3)

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Nick Desaulniers

author reviewer
#0 lore raw

v5 cover infer --target from SRCARCH for CC=clang

We get constant feedback that the command line invocation of make is too long. CROSS_COMPILE is helpful when a toolchain has a prefix of the target triple, or is an absolute path outside of $PATH, but it's mostly redundant for a given ARCH.

Instead, let's infer it from SRCARCH, and move some flag handling into a new file included from the top level Makefile.

Changes v4 -> v5:
* Include previously missing first patch!

Changes v3 -> v4:
* Remove the requirement that LLVM_IAS=1 be set, as per Masahiro.
* Remove the Documentation/ change from patch 2, as per Masahiro and Nathan.
* Add Documentation/ change as patch 3, from Masahiro.
* Reword commit message of patch 2, as per Nathan.
* Change patch 2 oneline to refer to --target and CC=clang (not CROSS_COMPILE).
* Carry Arnd's and Nathan's AB/RB/TB tags, confirmed ok on IRC+discord.

Changes v2 -> v3:
* Remove requirement that LLVM=1 be set. Instead, if building with just CC=clang LLVM_IAS=1 instead of LLVM=1 LLVM_IAS=1, you should use LD=ld.lld explicitly, or LD=aarch64-linux-gnu-ld. (As per Masahiro) Example:

  $ ARCH=arm64 make CC=clang LLVM_IAS=1 LD=ld.lld OBJCOPY=llvm-objcopy \
    STRIP=llvm-strip -j72 defconfig all

(It's still preferable to use LLVM=1 IMO, but this is maximally flexible.)
* Change oneliner from LLVM=1 to CC=clang.
* Update Docs slightly.

Changes v1 -> v2:
* patch 1/2 untouched.
* Fix typos in commit message as per Geert and Masahiro.
* Use SRCARCH instead of ARCH, simplifying x86 handling, as per Masahiro. Add his sugguested by tag.
* change commit oneline from 'drop' to 'infer.'
* Add detail about explicit host --target and relationship of ARCH to SRCARCH, as per Masahiro.

Nick Desaulniers (3):
Makefile: move initial clang flag handling into scripts/Makefile.clang
Makefile: infer --target from ARCH for CC=clang Documentation/llvm: update CROSS_COMPILE inferencing

 Documentation/kbuild/llvm.rst | 17 +++++++++++++++
 MAINTAINERS                   |  1 +
 Makefile                      | 15 +------------
 scripts/Makefile.clang        | 40 +++++++++++++++++++++++++++++++++++
 4 files changed, 59 insertions(+), 14 deletions(-)
 create mode 100644 scripts/Makefile.clang

base-commit: 27932b6a2088eac7a5afa5471963b926cfbb4de7

Signature · 1 line
2.32.0.554.ge1b32706d8-goog
author reviewer
#1 lore raw

PATCH v5 1/3 Makefile: move initial clang flag handling into scripts/Makefile.clang

With some of the changes we'd like to make to CROSS_COMPILE, the initial block of clang flag handling which controls things like the target triple, whether or not to use the integrated assembler and how to find GAS, and erroring on unknown warnings is becoming unwieldy. Move it into its own file under scripts/.

---
 MAINTAINERS            |  1 +
 Makefile               | 15 +--------------
 scripts/Makefile.clang | 14 ++++++++++++++
 3 files changed, 16 insertions(+), 14 deletions(-)
 create mode 100644 scripts/Makefile.clang
MAINTAINERS +1 -0
index 81e1edeceae4..9c1205c258c7 100644
@@ -4433,6 +4433,7 @@ B:	https://github.com/ClangBuiltLinux/linux/issues
 C:	irc://chat.freenode.net/clangbuiltlinux
 F:	Documentation/kbuild/llvm.rst
 F:	include/linux/compiler-clang.h
+F:	scripts/Makefile.clang
 F:	scripts/clang-tools/
 K:	\b(?i:clang|llvm)\b
 
Makefile +1 -14
index cbab0dc53065..010e3a4e770b 100644
@@ -586,20 +586,7 @@ endif
 CC_VERSION_TEXT = $(subst $(pound),,$(shell $(CC) --version 2>/dev/null | head -n 1))
 
 ifneq ($(findstring clang,$(CC_VERSION_TEXT)),)
-ifneq ($(CROSS_COMPILE),)
-CLANG_FLAGS	+= --target=$(notdir $(CROSS_COMPILE:%-=%))
-endif
-ifeq ($(LLVM_IAS),1)
-CLANG_FLAGS	+= -integrated-as
-else
-CLANG_FLAGS	+= -no-integrated-as
-GCC_TOOLCHAIN_DIR := $(dir $(shell which $(CROSS_COMPILE)elfedit))
-CLANG_FLAGS	+= --prefix=$(GCC_TOOLCHAIN_DIR)$(notdir $(CROSS_COMPILE))
-endif
-CLANG_FLAGS	+= -Werror=unknown-warning-option
-KBUILD_CFLAGS	+= $(CLANG_FLAGS)
-KBUILD_AFLAGS	+= $(CLANG_FLAGS)
-export CLANG_FLAGS
+include $(srctree)/scripts/Makefile.clang
 endif
 
 # Include this also for config targets because some architectures need
scripts/Makefile.clang new file +14 -0
new file mode 100644
index 000000000000..297932e973d4
@@ -0,0 +1,14 @@
+ifneq ($(CROSS_COMPILE),)
+CLANG_FLAGS	+= --target=$(notdir $(CROSS_COMPILE:%-=%))
+endif
+ifeq ($(LLVM_IAS),1)
+CLANG_FLAGS	+= -integrated-as
+else
+CLANG_FLAGS	+= -no-integrated-as
+GCC_TOOLCHAIN_DIR := $(dir $(shell which $(CROSS_COMPILE)elfedit))
+CLANG_FLAGS	+= --prefix=$(GCC_TOOLCHAIN_DIR)$(notdir $(CROSS_COMPILE))
+endif
+CLANG_FLAGS	+= -Werror=unknown-warning-option
+KBUILD_CFLAGS	+= $(CLANG_FLAGS)
+KBUILD_AFLAGS	+= $(CLANG_FLAGS)
+export CLANG_FLAGS
Signature · 1 line
2.32.0.554.ge1b32706d8-goog
author reviewer
#2 lore raw

PATCH v5 2/3 Makefile: infer --target from ARCH for CC=clang

In reply to Nick Desaulniers

We get constant feedback that the command line invocation of make is too long when compiling with LLVM. CROSS_COMPILE is helpful when a toolchain has a prefix of the target triple, or is an absolute path outside of $PATH.

Since a Clang binary is generally multi-targeted, we can infer a given target from SRCARCH/ARCH. If CROSS_COMPILE is not set, simply set --target= for CLANG_FLAGS, KBUILD_CFLAGS, and KBUILD_AFLAGS based on $SRCARCH.

Previously, we'd cross compile via:

$ ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make LLVM=1 LLVM_IAS=1
Now:
$ ARCH=arm64 make LLVM=1 LLVM_IAS=1

For native builds (not involving cross compilation) we now explicitly specify a target triple rather than rely on the implicit host triple.

---
Changes v3 -> v4:
* Reword commit message and oneline, as per Nathan.
* Drop documentation change (it's the next patch, could be squashed in, I guess).
* Drop LLVM_IAS=1 requirement, as per Masahiro.
* Carry Arnd's and Nathan's AB/RB/TB tags, confirmed OK on IRC+Discord.

Changes v2 -> v3:
* Drop check/requirement for LLVM=1, as per Masahiro.
* Change oneliner from LLVM=1 LLVM_IAS=1 to CC=clang LLVM_IAS=1.
* Don't carry forward Nathan's RB/TB tags. :( Sorry Nathan, but thank you for testing+reviewing v2.
* Update wording of docs slightly.

Changes v1 -> v2:
* Fix typos in commit message as per Geert and Masahiro.
* Use SRCARCH instead of ARCH, simplifying x86 handling, as per Masahiro. Add his sugguested by tag.
* change commit oneline from 'drop' to 'infer.'
* Add detail about explicit host --target and relationship of ARCH to SRCARCH, as per Masahiro.

Changes RFC -> v1:
* Rebase onto linux-kbuild/for-next
* Keep full target triples since missing the gnueabi suffix messes up 32b ARM. Drop Fangrui's sugguested by tag. Update commit message to drop references to arm64.
* Flush out TODOS.
* Add note about -EL/-EB, -m32/-m64.
* Add note to Documentation/.

 scripts/Makefile.clang | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)
scripts/Makefile.clang +28 -2
index 297932e973d4..f983f65dd9f5 100644
@@ -1,6 +1,32 @@
-ifneq ($(CROSS_COMPILE),)
+# Individual arch/{arch}/Makefiles should use -EL/-EB to set intended
+# endianness and -m32/-m64 to set word size based on Kconfigs instead of
+# relying on the target triple.
+ifeq ($(CROSS_COMPILE),)
+ifeq ($(SRCARCH),arm)
+CLANG_FLAGS	+= --target=arm-linux-gnueabi
+else ifeq ($(SRCARCH),arm64)
+CLANG_FLAGS	+= --target=aarch64-linux-gnu
+else ifeq ($(SRCARCH),hexagon)
+CLANG_FLAGS	+= --target=hexagon-linux-gnu
+else ifeq ($(SRCARCH),m68k)
+CLANG_FLAGS	+= --target=m68k-linux-gnu
+else ifeq ($(SRCARCH),mips)
+CLANG_FLAGS	+= --target=mipsel-linux-gnu
+else ifeq ($(SRCARCH),powerpc)
+CLANG_FLAGS	+= --target=powerpc64le-linux-gnu
+else ifeq ($(SRCARCH),riscv)
+CLANG_FLAGS	+= --target=riscv64-linux-gnu
+else ifeq ($(SRCARCH),s390)
+CLANG_FLAGS	+= --target=s390x-linux-gnu
+else ifeq ($(SRCARCH),x86)
+CLANG_FLAGS	+= --target=x86_64-linux-gnu
+else
+$(error Specify CROSS_COMPILE or add '--target=' option to scripts/Makefile.clang)
+endif # SRCARCH
+else
 CLANG_FLAGS	+= --target=$(notdir $(CROSS_COMPILE:%-=%))
-endif
+endif # CROSS_COMPILE
+
 ifeq ($(LLVM_IAS),1)
 CLANG_FLAGS	+= -integrated-as
 else
Signature · 1 line
2.32.0.554.ge1b32706d8-goog
author reviewer
#3 lore raw

PATCH v5 3/3 Documentation/llvm: update CROSS_COMPILE inferencing

In reply to Nick Desaulniers

As noted by Masahiro, document how we can generally infer CROSS_COMPILE (and the more specific details about --target and --prefix) based on ARCH.

---
 Documentation/kbuild/llvm.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
Documentation/kbuild/llvm.rst +17 -0
index b18401d2ba82..4292f0686316 100644
@@ -63,6 +63,23 @@ They can be enabled individually. The full list of the parameters: ::
 Currently, the integrated assembler is disabled by default. You can pass
 ``LLVM_IAS=1`` to enable it.
 
+Omitting CROSS_COMPILE
+----------------------
+
+As explained above, ``CROSS_COMPILE`` is used to set ``--target=<triple>``.
+
+Unless ``LLVM_IAS=1`` is specified, ``CROSS_COMPILE`` is also used to derive
+``--prefix=<path>`` to search for the GNU assembler.
+
+If ``CROSS_COMPILE`` is not specified, the ``--target=<triple>`` is inferred
+from ``ARCH``.
+
+That means if you use only LLVM tools, ``CROSS_COMPILE`` becomes unnecessary.
+
+For example, to cross-compile the arm64 kernel::
+
+	ARCH=arm64 make LLVM=1 LLVM_IAS=1
+
 Supported Architectures
 -----------------------
 
Signature · 1 line
2.32.0.554.ge1b32706d8-goog
Reviewed-by on v5 3/3
#4 lore raw

Re: [PATCH v5 3/3] Documentation/llvm: update CROSS_COMPILE inferencing

Quoted 18 lines · Nick Desaulniers

As noted by Masahiro, document how we can generally infer CROSS_COMPILE (and the more specific details about --target and --prefix) based on ARCH.

---
Documentation/kbuild/llvm.rst | 17 +++++++++++++++++

1 file changed, 17 insertions(+)
Documentation/kbuild/llvm.rst +0 -0
index b18401d2ba82..4292f0686316 100644
@@ -63,6 +63,23 @@ They can be enabled individually. The full list of the parameters: ::

Currently, the integrated assembler is disabled by default. You can pass ``LLVM_IAS=1`` to enable it.

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 72

Quoted 7 lines
Documentation/kbuild/llvm.rst +7 -0
+Omitting CROSS_COMPILE
+----------------------
+
+As explained above, ``CROSS_COMPILE`` is used to set ``--target=<triple>``.
+
+Unless ``LLVM_IAS=1`` is specified, ``CROSS_COMPILE`` is also used to derive
+``--prefix=<path>`` to search for the GNU assembler.

and the GNU linker.

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 81

Quoted 8 lines
Documentation/kbuild/llvm.rst +8 -0
+If ``CROSS_COMPILE`` is not specified, the ``--target=<triple>`` is inferred
+from ``ARCH``.
+
+That means if you use only LLVM tools, ``CROSS_COMPILE`` becomes unnecessary.
+
+For example, to cross-compile the arm64 kernel::
+
+	ARCH=arm64 make LLVM=1 LLVM_IAS=1

Is ARCH=arm64 make LLVM=1 LLVM_IAS=1

preferred over

make ARCH=arm64 LLVM=1 LLVM_IAS=1

?

Quoted 6 lines

Supported Architectures
-----------------------

Signature · 1 line
2.32.0.554.ge1b32706d8-goog
#5 lore raw

Re: [PATCH v5 3/3] Documentation/llvm: update CROSS_COMPILE inferencing

Quoted 43 lines · Fangrui Song
Quoted 18 lines · Nick Desaulniers

As noted by Masahiro, document how we can generally infer CROSS_COMPILE (and the more specific details about --target and --prefix) based on ARCH.

---
Documentation/kbuild/llvm.rst | 17 +++++++++++++++++

1 file changed, 17 insertions(+)
Documentation/kbuild/llvm.rst +0 -0
index b18401d2ba82..4292f0686316 100644
@@ -63,6 +63,23 @@ They can be enabled individually. The full list of the parameters: ::

Currently, the integrated assembler is disabled by default. You can pass ``LLVM_IAS=1`` to enable it.

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 72

Quoted 7 lines
Documentation/kbuild/llvm.rst +7 -0
+Omitting CROSS_COMPILE
+----------------------
+
+As explained above, ``CROSS_COMPILE`` is used to set ``--target=<triple>``.
+
+Unless ``LLVM_IAS=1`` is specified, ``CROSS_COMPILE`` is also used to derive
+``--prefix=<path>`` to search for the GNU assembler.

and the GNU linker.

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 81

Quoted 8 lines
Documentation/kbuild/llvm.rst +8 -0
+If ``CROSS_COMPILE`` is not specified, the ``--target=<triple>`` is inferred
+from ``ARCH``.
+
+That means if you use only LLVM tools, ``CROSS_COMPILE`` becomes unnecessary.
+
+For example, to cross-compile the arm64 kernel::
+
+      ARCH=arm64 make LLVM=1 LLVM_IAS=1

Is ARCH=arm64 make LLVM=1 LLVM_IAS=1

Quoted 5 lines

preferred over

make ARCH=arm64 LLVM=1 LLVM_IAS=1

?

I do not think so.

For consistency,

make ARCH=arm64 LLVM=1 LLVM_IAS=1

or

ARCH=arm64 LLVM=1 LLVM_IAS=1 make

might be preferred.

But, in the same doc, I see an example, which
mixes up the env variables and a make variable.

ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make CC=clang

Signature · 2 lines
Best Regards
Masahiro Yamada
author reviewer
#6 lore raw

Re: [PATCH v5 3/3] Documentation/llvm: update CROSS_COMPILE inferencing

Quoted 27 lines · Masahiro Yamada
Quoted 8 lines · Fangrui Song

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 81

Quoted 3 lines · Nick Desaulniers
Documentation/kbuild/llvm.rst +3 -0
+For example, to cross-compile the arm64 kernel::
+
+      ARCH=arm64 make LLVM=1 LLVM_IAS=1

Is ARCH=arm64 make LLVM=1 LLVM_IAS=1

Quoted 5 lines

preferred over

make ARCH=arm64 LLVM=1 LLVM_IAS=1

?

I do not think so.

For consistency,

make ARCH=arm64 LLVM=1 LLVM_IAS=1

or

ARCH=arm64 LLVM=1 LLVM_IAS=1 make

Quoted 8 lines

might be preferred.

But, in the same doc, I see an example, which
mixes up the env variables and a make variable.

ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make CC=clang

Perhaps it's just muscle memory from when I started working on Nexus phone kernels ~5 years ago; that's how our build scripts invoked make (with ARCH and CROSS_COMPILE as env vars).

IIRC, GNU make has the notion of origin for variables.
https://www.gnu.org/software/make/manual/html_node/Origin-Function.html
So "before make" would be "environment" and "after make" would be "command line."

I'm rereading the section on assignment to see if one of the assignment operators was affected by origin.
https://www.gnu.org/software/make/manual/html_node/Setting.html
https://www.gnu.org/software/make/manual/html_node/Flavors.html#Flavors

I could have sworn that due to one of the assignment operators (perhaps ?=) that the orderings weren't commutative.

$ make ARCH=arm64 LLVM=1 LLVM_IAS=1 -j72
works
$ ARCH=arm64 LLVM=1 LLVM_IAS=1 make -j72
also works.  Hmm...maybe I misremembered the issue then.

Ok, I will reorder all instances to use the command line rather than env vars in v6.

Signature · 2 lines
Thanks,
~Nick Desaulniers
author reviewer
#7 lore raw

Re: [PATCH v5 3/3] Documentation/llvm: update CROSS_COMPILE inferencing

In reply to Fangrui Song
Quoted 20 lines · Fangrui Song' via Clang Built Linux
Quoted 18 lines · Nick Desaulniers

As noted by Masahiro, document how we can generally infer CROSS_COMPILE (and the more specific details about --target and --prefix) based on ARCH.

---
Documentation/kbuild/llvm.rst | 17 +++++++++++++++++

1 file changed, 17 insertions(+)
Documentation/kbuild/llvm.rst +0 -0
index b18401d2ba82..4292f0686316 100644
@@ -63,6 +63,23 @@ They can be enabled individually. The full list of the parameters: ::

Currently, the integrated assembler is disabled by default. You can pass ``LLVM_IAS=1`` to enable it.

Quoted 9 lines

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 72

Quoted 7 lines
Documentation/kbuild/llvm.rst +7 -0
+Omitting CROSS_COMPILE
+----------------------
+
+As explained above, ``CROSS_COMPILE`` is used to set ``--target=<triple>``.
+
+Unless ``LLVM_IAS=1`` is specified, ``CROSS_COMPILE`` is also used to derive
+``--prefix=<path>`` to search for the GNU assembler.

and the GNU linker.

Sure, I'll add this, but wanted to note that generally the compiler is not used as the driver for kernel builds; the linker is invoked directly. IIRC, there were a few spots where the compiler is used as the driver; I think some of the various VDSO's are still built that way, but it's not common.

Quoted 14 lines

Documentation/kbuild/llvm.rst They can be enabled individually. The full list of the parameters: :: · line 81

Quoted 8 lines
Documentation/kbuild/llvm.rst +8 -0
+If ``CROSS_COMPILE`` is not specified, the ``--target=<triple>`` is inferred
+from ``ARCH``.
+
+That means if you use only LLVM tools, ``CROSS_COMPILE`` becomes unnecessary.
+
+For example, to cross-compile the arm64 kernel::
+
+      ARCH=arm64 make LLVM=1 LLVM_IAS=1

Is ARCH=arm64 make LLVM=1 LLVM_IAS=1

Quoted 5 lines

preferred over

make ARCH=arm64 LLVM=1 LLVM_IAS=1

?

Will respond to this against Masahiro's reply.

Signature · 2 lines
Thanks,
~Nick Desaulniers