Skip to contentSkip to conversation

kmsan: compiler_types: declare __no_sanitize_or_inline

PATCH Superseded Alexander Potapenko 3 participants 4 messages Apr 25, 2024 – Apr 26, 2024

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kmsan: compiler_types: declare __no_sanitize_or_inline

It turned out that KMSAN instruments READ_ONCE_NOCHECK(), resulting in false positive reports, because __no_sanitize_or_inline enforced inlining.

Properly declare __no_sanitize_or_inline under __SANITIZE_MEMORY__, so that it does not inline the annotated function.

---
 include/linux/compiler_types.h | 11 +++++++++++
 1 file changed, 11 insertions(+)
include/linux/compiler_types.h +11 -0
index 0caf354cb94b5..a6a28952836cb 100644
@@ -278,6 +278,17 @@ struct ftrace_likely_data {
 # define __no_kcsan
 #endif
 
+#ifdef __SANITIZE_MEMORY__
+/*
+ * Similarly to KASAN and KCSAN, KMSAN loses function attributes of inlined
+ * functions, therefore disabling KMSAN checks also requires disabling inlining.
+ *
+ * __no_sanitize_or_inline effectively prevents KMSAN from reporting errors
+ * within the function and marks all its outputs as initialized.
+ */
+# define __no_sanitize_or_inline __no_kmsan_checks notrace __maybe_unused
+#endif
+
 #ifndef __no_sanitize_or_inline
 #define __no_sanitize_or_inline __always_inline
 #endif
Signature · 1 line
2.44.0.769.g3c40516874-goog
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Alexander Potapenko

It turned out that KMSAN instruments READ_ONCE_NOCHECK(), resulting in false positive reports, because __no_sanitize_or_inline enforced inlining.

Properly declare __no_sanitize_or_inline under __SANITIZE_MEMORY__, so that it does not inline the annotated function.

Maybe worth noting that this is only a problem for __always_inline, since that is inlining-by-force, and from the compiler's point of view WAI.

Quoted 2 lines
Quoted 29 lines
---
 include/linux/compiler_types.h | 11 +++++++++++
 1 file changed, 11 insertions(+)
include/linux/compiler_types.h +11 -1
index 0caf354cb94b5..a6a28952836cb 100644
@@ -278,6 +278,17 @@ struct ftrace_likely_data {
 # define __no_kcsan
 #endif
 
+#ifdef __SANITIZE_MEMORY__
+/*
+ * Similarly to KASAN and KCSAN, KMSAN loses function attributes of inlined
+ * functions, therefore disabling KMSAN checks also requires disabling inlining.
+ *
+ * __no_sanitize_or_inline effectively prevents KMSAN from reporting errors
+ * within the function and marks all its outputs as initialized.
+ */
+# define __no_sanitize_or_inline __no_kmsan_checks notrace __maybe_unused
+#endif
+
 #ifndef __no_sanitize_or_inline
 #define __no_sanitize_or_inline __always_inline
 #endif
--

2.44.0.769.g3c40516874-goog

#2 lore raw
In reply to Alexander Potapenko
Quoted 7 lines · On Thu, 25 Apr 2024 11:28:59 +0200 Alexander Potapenko <[email protected]>…

It turned out that KMSAN instruments READ_ONCE_NOCHECK(), resulting in false positive reports, because __no_sanitize_or_inline enforced inlining.

Properly declare __no_sanitize_or_inline under __SANITIZE_MEMORY__, so that it does not inline the annotated function.

Reported-by [email protected]

I'll add

And I think a cc:stable is justifiable. A Fixes: target would be nice?

#3 lore raw
Quoted 8 lines · Andrew Morton
Quoted 5 lines · On Thu, 25 Apr 2024 11:28:59 +0200 Alexander Potapenko <[email protected]>…

It turned out that KMSAN instruments READ_ONCE_NOCHECK(), resulting in false positive reports, because __no_sanitize_or_inline enforced inlining.

Properly declare __no_sanitize_or_inline under __SANITIZE_MEMORY__, so that it does not inline the annotated function.

As Marco noted above, we may want to rephrase it as:

Properly declare __no_sanitize_or_inline under __SANITIZE_MEMORY__, so that it does not __always_inline the annotated function.

Let me know if I need to send a v2.

Quoted 7 lines
Quoted 1 line
Reported-by [email protected]

I'll add

And I think a cc:stable is justifiable.

Agreed.

Quoted 1 line

A Fixes: target would be nice?

Hmm, the introduction of READ_ONCE_NOCHECK predates KMSAN. We could do:

Fixes 5de0ce85f5a4d ("kmsan: mark noinstr as __no_sanitize_memory")

, because that commit should have introduced __no_sanitize_or_inline for KMSAN.