Skip to contentSkip to conversation

compiler-clang: add build check for clang 10.0.1

PATCH Superseded Nick Desaulniers 7 participants 12 messages Aug 26, 2020 – Aug 31, 2020

Subsystems (5)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Nick Desaulniers

author reviewer
#0 lore raw

PATCH 1/1 compiler-clang: add build check for clang 10.0.1

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

---
 include/linux/compiler-clang.h | 8 ++++++++
 1 file changed, 8 insertions(+)
include/linux/compiler-clang.h +8 -0
index cee0c728d39a..7338d3ffd240 100644
@@ -3,6 +3,14 @@
 #error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
 #endif
 
+#define CLANG_VERSION (__clang_major__ * 10000	\
+		     + __clang_minor__ * 100	\
+		     + __clang_patchlevel__)
+
+#if CLANG_VERSION < 100001
+# error Sorry, your compiler is too old - please upgrade it.
+#endif
+
 /* Compiler specific definitions for Clang compiler */
 
 /* same as gcc, this was present in clang-2.6 so we can assume it works
Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

---
 include/linux/compiler-clang.h | 8 ++++++++
 1 file changed, 8 insertions(+)
include/linux/compiler-clang.h +0 -0
index cee0c728d39a..7338d3ffd240 100644

include/linux/compiler-clang.h line 11

Quoted 9 lines
include/linux/compiler-clang.h +6 -0
@@ -3,6 +3,14 @@
 #error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
 #endif
 
+#define CLANG_VERSION (__clang_major__ * 10000	\
+		     + __clang_minor__ * 100	\
+		     + __clang_patchlevel__)
+
+#if CLANG_VERSION < 100001
+# error Sorry, your compiler is too old - please upgrade it.

Perhaps a bike-shed suggestion, but I think we should make this message as specific (and helpful) as possible:

# error Sorry, your version of Clang is too old - please use 10.0.1 or newer.

Then anyone seeing this has several pieces of information:

- the kernel build was attempting to use Clang
(maybe they accidentally poked the wrong configs in a CI)
- they need 10.0.1 or better
("upgrade to what version?" doesn't need to be dug out of documentation,
headers, etc)

With that, yes, let's do it. :)

(And likely we should improve the GCC message at the same time...)

Signature · 1 line
Kees Cook
#2 lore raw
Quoted 34 lines · Kees Cook
Quoted 19 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

---
 include/linux/compiler-clang.h | 8 ++++++++
 1 file changed, 8 insertions(+)
include/linux/compiler-clang.h +0 -0
index cee0c728d39a..7338d3ffd240 100644

include/linux/compiler-clang.h line 11

Quoted 9 lines
include/linux/compiler-clang.h +6 -0
@@ -3,6 +3,14 @@
 #error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
 #endif
 
+#define CLANG_VERSION (__clang_major__ * 10000       \
+                  + __clang_minor__ * 100    \
+                  + __clang_patchlevel__)
+
+#if CLANG_VERSION < 100001
+# error Sorry, your compiler is too old - please upgrade it.

Perhaps a bike-shed suggestion, but I think we should make this message as specific (and helpful) as possible:

Quoted 2 lines
# error Sorry, your version of Clang is too old - please use 10.0.1 or newer.

Agreed... Information about the required minimum version is user-friendly.

- Sedat -

Quoted 16 lines

Then anyone seeing this has several pieces of information:

- the kernel build was attempting to use Clang
(maybe they accidentally poked the wrong configs in a CI)
- they need 10.0.1 or better
("upgrade to what version?" doesn't need to be dug out of documentation,
headers, etc)

With that, yes, let's do it. :)

(And likely we should improve the GCC message at the same time...)

--
Kees Cook

Reviewed-by on v1 1/1
#3 lore raw
In reply to Nick Desaulniers
Quoted 3 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Since this effectively enforces a minimum version for Clang, I'd also update Documentation/process/changes.rst and Documentation/admin-guide/README.rst to mention this, and perhaps use that as a commit title ("implement minimum version for Clang") since that is the important change, not the implementation so much!

[Actually, I'd remove the particular GCC version from the admin-guide/README.rst to avoid having the version in 2 places (that doc already links to the other one), but that should be another patch.]

Cheers,
Miguel

#4 lore raw
Quoted 11 lines · Miguel Ojeda
Quoted 3 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Since this effectively enforces a minimum version for Clang, I'd also update Documentation/process/changes.rst and Documentation/admin-guide/README.rst to mention this, and perhaps use that as a commit title ("implement minimum version for Clang") since that is the important change, not the implementation so much!

I was actually going to comment on this separately but you beat me to it :) this patch probably should have been sent as a series with the Documentation update to avoid confusion for the reviewers:

https://lore.kernel.org/lkml/[email protected]/

Cheers,
Nathan

Quoted 9 lines

[Actually, I'd remove the particular GCC version from the admin-guide/README.rst to avoid having the version in 2 places (that doc already links to the other one), but that should be another patch.]

Cheers,
Miguel

#5 lore raw
Quoted 14 lines · Nathan Chancellor
Quoted 11 lines · Miguel Ojeda
Quoted 3 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Since this effectively enforces a minimum version for Clang, I'd also update Documentation/process/changes.rst and Documentation/admin-guide/README.rst to mention this, and perhaps use that as a commit title ("implement minimum version for Clang") since that is the important change, not the implementation so much!

Quoted 4 lines

I was actually going to comment on this separately but you beat me to it :) this patch probably should have been sent as a series with the Documentation update to avoid confusion for the reviewers:

Agreed... This patch should be combined with the other one and sent as a patch-series.

- Sedat -

Quoted 14 lines

https://lore.kernel.org/lkml/[email protected]/

Cheers,
Nathan

Quoted 9 lines

[Actually, I'd remove the particular GCC version from the admin-guide/README.rst to avoid having the version in 2 places (that doc already links to the other one), but that should be another patch.]

Cheers,
Miguel

Acked-by on v1 1/1
#6 lore raw
In reply to Nick Desaulniers
Quoted 5 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

I think this part of the commit message is a little wishy-washy. If we are breaking the build for clang < 10.0.1, we are not saying "may work", we are saying "won't work". Because of this, we should take the opportunity to clean up behind us and revert/remove parts of:

87e0d4f0f37f ("kbuild: disable clang's default use of -fmerge-all-constants") b0fe66cf0950 ("ARM: 8905/1: Emit __gnu_mcount_nc when using Clang 10.0.0 or newer") b9249cba25a5 ("arm64: bti: Require clang >= 10.0.1 for in-kernel BTI support") 3acf4be23528 ("arm64: vdso: Fix compilation with clang older than 8")

This could be a series or a part of this commit, I do not have a strong preference. If we are not going to clean up behind us, this should be a warning and not an error.

Quoted 4 lines

Otherwise, I agree with Kees's comments. With them addressed, feel free to add:

Quoted 26 lines
---
 include/linux/compiler-clang.h | 8 ++++++++
 1 file changed, 8 insertions(+)
include/linux/compiler-clang.h +8 -0
index cee0c728d39a..7338d3ffd240 100644
@@ -3,6 +3,14 @@
 #error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
 #endif
 
+#define CLANG_VERSION (__clang_major__ * 10000	\
+		     + __clang_minor__ * 100	\
+		     + __clang_patchlevel__)
+
+#if CLANG_VERSION < 100001
+# error Sorry, your compiler is too old - please upgrade it.
+#endif
+
 /* Compiler specific definitions for Clang compiler */
 
 /* same as gcc, this was present in clang-2.6 so we can assume it works
Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Acked-by
#7 lore raw
Quoted 12 lines · Nathan Chancellor
Quoted 5 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

I think this part of the commit message is a little wishy-washy. If we are breaking the build for clang < 10.0.1, we are not saying "may work", we are saying "won't work". Because of this, we should take the opportunity to clean up behind us and revert/remove parts of:

Quoted 8 lines

87e0d4f0f37f ("kbuild: disable clang's default use of -fmerge-all-constants") b0fe66cf0950 ("ARM: 8905/1: Emit __gnu_mcount_nc when using Clang 10.0.0 or newer") b9249cba25a5 ("arm64: bti: Require clang >= 10.0.1 for in-kernel BTI support") 3acf4be23528 ("arm64: vdso: Fix compilation with clang older than 8")

This could be a series or a part of this commit, I do not have a strong preference. If we are not going to clean up behind us, this should be a warning and not an error.

There are also some other documentation that would go stale. We probably have to change KASAN docs to look something like the below.

I wish we could also remove the "but detection of out-of-bounds accesses for global variables is only supported since Clang 11", but Clang 10 is a vast improvement so I'm not complaining. :-)

Thanks,
-- Marco

------ >8 ------

From 13d03b55c69dec813d94c1481dcb294971f164ef Mon Sep 17 00:00:00 2001
From: Marco Elver <[email protected]>
Date: Thu, 27 Aug 2020 20:56:34 +0200
Subject: [PATCH] kasan: Remove mentions of unsupported Clang versions

Since the kernel now requires at least Clang 10.0.1, remove any mention of old Clang versions and simplify the documentation.

---
 Documentation/dev-tools/kasan.rst | 4 ++--
 lib/Kconfig.kasan                 | 9 ++++-----
 2 files changed, 6 insertions(+), 7 deletions(-)
Documentation/dev-tools/kasan.rst +2 -2
index 38fd5681fade..4abc84b1798c 100644
@@ -13,10 +13,10 @@ KASAN uses compile-time instrumentation to insert validity checks before every
 memory access, and therefore requires a compiler version that supports that.
 
 Generic KASAN is supported in both GCC and Clang. With GCC it requires version
-8.3.0 or later. With Clang it requires version 7.0.0 or later, but detection of
+8.3.0 or later. Any supported Clang version is compatible, but detection of
 out-of-bounds accesses for global variables is only supported since Clang 11.
 
-Tag-based KASAN is only supported in Clang and requires version 7.0.0 or later.
+Tag-based KASAN is only supported in Clang.
 
 Currently generic KASAN is supported for the x86_64, arm64, xtensa, s390 and
 riscv architectures, and tag-based KASAN is supported only for arm64.
lib/Kconfig.kasan +4 -5
index 047b53dbfd58..033a5bc67ac4 100644
@@ -54,9 +54,9 @@ config KASAN_GENERIC
 	  Enables generic KASAN mode.
 
 	  This mode is supported in both GCC and Clang. With GCC it requires
-	  version 8.3.0 or later. With Clang it requires version 7.0.0 or
-	  later, but detection of out-of-bounds accesses for global variables
-	  is supported only since Clang 11.
+	  version 8.3.0 or later. Any supported Clang version is compatible,
+	  but detection of out-of-bounds accesses for global variables is
+	  supported only since Clang 11.
 
 	  This mode consumes about 1/8th of available memory at kernel start
 	  and introduces an overhead of ~x1.5 for the rest of the allocations.
@@ -78,8 +78,7 @@ config KASAN_SW_TAGS
 	  Enables software tag-based KASAN mode.
 
 	  This mode requires Top Byte Ignore support by the CPU and therefore
-	  is only supported for arm64. This mode requires Clang version 7.0.0
-	  or later.
+	  is only supported for arm64. This mode requires Clang.
 
 	  This mode consumes about 1/16th of available memory at kernel start
 	  and introduces an overhead of ~20% for the rest of the allocations.
Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Reviewed-by
#8 lore raw
Quoted 96 lines · Marco Elver
Quoted 12 lines · Nathan Chancellor
Quoted 5 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

I think this part of the commit message is a little wishy-washy. If we are breaking the build for clang < 10.0.1, we are not saying "may work", we are saying "won't work". Because of this, we should take the opportunity to clean up behind us and revert/remove parts of:

Quoted 8 lines

87e0d4f0f37f ("kbuild: disable clang's default use of -fmerge-all-constants") b0fe66cf0950 ("ARM: 8905/1: Emit __gnu_mcount_nc when using Clang 10.0.0 or newer") b9249cba25a5 ("arm64: bti: Require clang >= 10.0.1 for in-kernel BTI support") 3acf4be23528 ("arm64: vdso: Fix compilation with clang older than 8")

This could be a series or a part of this commit, I do not have a strong preference. If we are not going to clean up behind us, this should be a warning and not an error.

There are also some other documentation that would go stale. We probably have to change KASAN docs to look something like the below.

I wish we could also remove the "but detection of out-of-bounds accesses for global variables is only supported since Clang 11", but Clang 10 is a vast improvement so I'm not complaining. :-)

Thanks,
-- Marco

------ >8 ------

From 13d03b55c69dec813d94c1481dcb294971f164ef Mon Sep 17 00:00:00 2001
From: Marco Elver <[email protected]>
Date: Thu, 27 Aug 2020 20:56:34 +0200
Subject: [PATCH] kasan: Remove mentions of unsupported Clang versions

Since the kernel now requires at least Clang 10.0.1, remove any mention of old Clang versions and simplify the documentation.

---
 Documentation/dev-tools/kasan.rst | 4 ++--
 lib/Kconfig.kasan                 | 9 ++++-----
 2 files changed, 6 insertions(+), 7 deletions(-)
Documentation/dev-tools/kasan.rst +2 -2
index 38fd5681fade..4abc84b1798c 100644
@@ -13,10 +13,10 @@ KASAN uses compile-time instrumentation to insert validity checks before every
 memory access, and therefore requires a compiler version that supports that.
 
 Generic KASAN is supported in both GCC and Clang. With GCC it requires version
-8.3.0 or later. With Clang it requires version 7.0.0 or later, but detection of
+8.3.0 or later. Any supported Clang version is compatible, but detection of
 out-of-bounds accesses for global variables is only supported since Clang 11.
 
-Tag-based KASAN is only supported in Clang and requires version 7.0.0 or later.
+Tag-based KASAN is only supported in Clang.
 
 Currently generic KASAN is supported for the x86_64, arm64, xtensa, s390 and
 riscv architectures, and tag-based KASAN is supported only for arm64.
lib/Kconfig.kasan +4 -6
index 047b53dbfd58..033a5bc67ac4 100644
@@ -54,9 +54,9 @@ config KASAN_GENERIC
          Enables generic KASAN mode.
 
          This mode is supported in both GCC and Clang. With GCC it requires
-         version 8.3.0 or later. With Clang it requires version 7.0.0 or
-         later, but detection of out-of-bounds accesses for global variables
-         is supported only since Clang 11.
+         version 8.3.0 or later. Any supported Clang version is compatible,
+         but detection of out-of-bounds accesses for global variables is
+         supported only since Clang 11.
 
          This mode consumes about 1/8th of available memory at kernel start
          and introduces an overhead of ~x1.5 for the rest of the allocations.
@@ -78,8 +78,7 @@ config KASAN_SW_TAGS
          Enables software tag-based KASAN mode.
 
          This mode requires Top Byte Ignore support by the CPU and therefore
-         is only supported for arm64. This mode requires Clang version 7.0.0
-         or later.
+         is only supported for arm64. This mode requires Clang.
 
          This mode consumes about 1/16th of available memory at kernel start
          and introduces an overhead of ~20% for the rest of the allocations.
--
Quoted 2 lines

2.28.0.297.g1956fa8f8d-goog

Thanks!

author reviewer
#9 lore raw
In reply to Nathan Chancellor
Quoted 9 lines · Nathan Chancellor
Quoted 5 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

I think this part of the commit message is a little wishy-washy. If we

Yep, you're right. I'm still in denial. Let me rip that bandaid off and send a v2, with your and Kees' suggestions.

Sorry, the docs patch already got picked up. Let's follow up with additional patches to docs separately.

Quoted 8 lines

are breaking the build for clang < 10.0.1, we are not saying "may work", we are saying "won't work". Because of this, we should take the opportunity to clean up behind us and revert/remove parts of:

87e0d4f0f37f ("kbuild: disable clang's default use of -fmerge-all-constants") b0fe66cf0950 ("ARM: 8905/1: Emit __gnu_mcount_nc when using Clang 10.0.0 or newer") b9249cba25a5 ("arm64: bti: Require clang >= 10.0.1 for in-kernel BTI support") 3acf4be23528 ("arm64: vdso: Fix compilation with clang older than 8")

I'd prefer to see this land in mainline first; otherwise, I'm worried about this patch "racing" to mainline with those patches if they go via separate trees. Thoughts?

Signature · 2 lines
Thanks,
~Nick Desaulniers
author reviewer
#10 lore raw
Quoted 16 lines · Nick Desaulniers
Quoted 13 lines · Nathan Chancellor
Quoted 5 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

I think this part of the commit message is a little wishy-washy. If we are breaking the build for clang < 10.0.1, we are not saying "may work", we are saying "won't work". Because of this, we should take the opportunity to clean up behind us and revert/remove parts of:

Quoted 8 lines
Quoted 4 lines

87e0d4f0f37f ("kbuild: disable clang's default use of -fmerge-all-constants") b0fe66cf0950 ("ARM: 8905/1: Emit __gnu_mcount_nc when using Clang 10.0.0 or newer") b9249cba25a5 ("arm64: bti: Require clang >= 10.0.1 for in-kernel BTI support") 3acf4be23528 ("arm64: vdso: Fix compilation with clang older than 8")

I'd prefer to see this land in mainline first; otherwise, I'm worried about this patch "racing" to mainline with those patches if they go via separate trees. Thoughts?

Maybe I should send such a series (including Marco's recommendations) to Mr. Morton or Yamada-san?

Signature · 2 lines
Thanks,
~Nick Desaulniers
Acked-by on v1 1/1
#11 lore raw
In reply to Nick Desaulniers
Quoted 11 lines · Nick Desaulniers

During Plumbers 2020, we voted to just support the latest release of Clang for now. Add a compile time check for this.

Older clang's may work, but we will likely drop workarounds for older versions.

Nice to see This Is Happening!

See also my other replies to Kees and Nathan comments.

- Sedat -

Quoted 26 lines
---
 include/linux/compiler-clang.h | 8 ++++++++
 1 file changed, 8 insertions(+)
include/linux/compiler-clang.h +8 -1
index cee0c728d39a..7338d3ffd240 100644
@@ -3,6 +3,14 @@
 #error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
 #endif
 
+#define CLANG_VERSION (__clang_major__ * 10000 \
+                    + __clang_minor__ * 100    \
+                    + __clang_patchlevel__)
+
+#if CLANG_VERSION < 100001
+# error Sorry, your compiler is too old - please upgrade it.
+#endif
+
 /* Compiler specific definitions for Clang compiler */
 
 /* same as gcc, this was present in clang-2.6 so we can assume it works
--

2.28.0.297.g1956fa8f8d-goog