Skip to contentSkip to conversation

x86/csum: Add KASAN/KCSAN instrumentation

PATCH Superseded Jann Horn 3 participants 5 messages Jan 26, 2022 – Jan 27, 2022 x86

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Jann Horn

author
#0 lore raw

PATCH 1/1 x86/csum: Add KASAN/KCSAN instrumentation

In the optimized X86 version of the copy-with-checksum helpers, use instrument_*() before accessing buffers from assembly code so that KASAN and KCSAN don't have blind spots there.

---
 arch/x86/lib/csum-partial_64.c  | 3 +++
 arch/x86/lib/csum-wrappers_64.c | 9 +++++++++
 2 files changed, 12 insertions(+)
arch/x86/lib/csum-partial_64.c +3 -0
index 1f8a8f895173..8b0c353cd212 100644
@@ -8,6 +8,7 @@
  
 #include <linux/compiler.h>
 #include <linux/export.h>
+#include <linux/instrumented.h>
 #include <asm/checksum.h>
 #include <asm/word-at-a-time.h>
 
@@ -37,6 +38,8 @@ __wsum csum_partial(const void *buff, int len, __wsum sum)
 	u64 temp64 = (__force u64)sum;
 	unsigned odd, result;
 
+	instrument_read(buff, len);
+
 	odd = 1 & (unsigned long) buff;
 	if (unlikely(odd)) {
 		if (unlikely(len == 0))
arch/x86/lib/csum-wrappers_64.c +9 -0
index 189344924a2b..087f3c4cb89f 100644
@@ -6,6 +6,8 @@
  */
 #include <asm/checksum.h>
 #include <linux/export.h>
+#include <linux/in6.h>
+#include <linux/instrumented.h>
 #include <linux/uaccess.h>
 #include <asm/smap.h>
 
@@ -26,6 +28,7 @@ csum_and_copy_from_user(const void __user *src, void *dst, int len)
 	__wsum sum;
 
 	might_sleep();
+	instrument_write(dst, len);
 	if (!user_access_begin(src, len))
 		return 0;
 	sum = csum_partial_copy_generic((__force const void *)src, dst, len);
@@ -51,6 +54,7 @@ csum_and_copy_to_user(const void *src, void __user *dst, int len)
 	__wsum sum;
 
 	might_sleep();
+	instrument_read(src, len);
 	if (!user_access_begin(dst, len))
 		return 0;
 	sum = csum_partial_copy_generic(src, (void __force *)dst, len);
@@ -71,6 +75,8 @@ EXPORT_SYMBOL(csum_and_copy_to_user);
 __wsum
 csum_partial_copy_nocheck(const void *src, void *dst, int len)
 {
+	instrument_write(dst, len);
+	instrument_read(src, len);
 	return csum_partial_copy_generic(src, dst, len);
 }
 EXPORT_SYMBOL(csum_partial_copy_nocheck);
@@ -81,6 +87,9 @@ __sum16 csum_ipv6_magic(const struct in6_addr *saddr,
 {
 	__u64 rest, sum64;
 
+	instrument_read(saddr, sizeof(*saddr));
+	instrument_read(daddr, sizeof(*daddr));
+
 	rest = (__force __u64)htonl(len) + (__force __u64)htons(proto) +
 		(__force __u64)sum;
 

base-commit: 0280e3c58f92b2fe0e8fbbdf8d386449168de4a8

Signature · 1 line
2.35.0.rc0.227.g00780c9af4-goog
#1 lore raw
Quoted 54 lines · Jann Horn

In the optimized X86 version of the copy-with-checksum helpers, use instrument_*() before accessing buffers from assembly code so that KASAN and KCSAN don't have blind spots there.

---
 arch/x86/lib/csum-partial_64.c  | 3 +++
 arch/x86/lib/csum-wrappers_64.c | 9 +++++++++
 2 files changed, 12 insertions(+)
arch/x86/lib/csum-partial_64.c +3 -0
index 1f8a8f895173..8b0c353cd212 100644
@@ -8,6 +8,7 @@
 
 #include <linux/compiler.h>
 #include <linux/export.h>
+#include <linux/instrumented.h>
 #include <asm/checksum.h>
 #include <asm/word-at-a-time.h>
 
@@ -37,6 +38,8 @@ __wsum csum_partial(const void *buff, int len, __wsum sum)
        u64 temp64 = (__force u64)sum;
        unsigned odd, result;
 
+       instrument_read(buff, len);
+
        odd = 1 & (unsigned long) buff;
        if (unlikely(odd)) {
                if (unlikely(len == 0))
arch/x86/lib/csum-wrappers_64.c +3 -0
index 189344924a2b..087f3c4cb89f 100644
@@ -6,6 +6,8 @@
  */
 #include <asm/checksum.h>
 #include <linux/export.h>
+#include <linux/in6.h>
+#include <linux/instrumented.h>
 #include <linux/uaccess.h>
 #include <asm/smap.h>
 
@@ -26,6 +28,7 @@ csum_and_copy_from_user(const void __user *src, void *dst, int len)
        __wsum sum;
 
        might_sleep();
+       instrument_write(dst, len);
        if (!user_access_begin(src, len))
                return 0;
        sum = csum_partial_copy_generic((__force const void *)src, dst, len);

arch/x86/lib/csum-wrappers_64.c csum_and_copy_to_user(const void *src, void __user *dst, int len) · line 57

Quoted 4 lines
arch/x86/lib/csum-wrappers_64.c +1 -0
@@ -51,6 +54,7 @@ csum_and_copy_to_user(const void *src, void __user *dst, int len)
        __wsum sum;
 
        might_sleep();
+       instrument_read(src, len);

Nice!

Can these potentially be called with KERNEL_DS as in some compat syscalls? If so it's better to use instrument_copy_to/from_user. Or probably it's better to use them anyway b/c we also want to know about user accesses for uaccess logging and maybe other things.

Quoted 27 lines
arch/x86/lib/csum-wrappers_64.c +5 -0
        if (!user_access_begin(dst, len))
                return 0;
        sum = csum_partial_copy_generic(src, (void __force *)dst, len);
@@ -71,6 +75,8 @@ EXPORT_SYMBOL(csum_and_copy_to_user);
 __wsum
 csum_partial_copy_nocheck(const void *src, void *dst, int len)
 {
+       instrument_write(dst, len);
+       instrument_read(src, len);
        return csum_partial_copy_generic(src, dst, len);
 }
 EXPORT_SYMBOL(csum_partial_copy_nocheck);
@@ -81,6 +87,9 @@ __sum16 csum_ipv6_magic(const struct in6_addr *saddr,
 {
        __u64 rest, sum64;
 
+       instrument_read(saddr, sizeof(*saddr));
+       instrument_read(daddr, sizeof(*daddr));
+
        rest = (__force __u64)htonl(len) + (__force __u64)htons(proto) +
                (__force __u64)sum;
 

base-commit: 0280e3c58f92b2fe0e8fbbdf8d386449168de4a8 --
2.35.0.rc0.227.g00780c9af4-goog

author
#2 lore raw
Quoted 5 lines · Dmitry Vyukov
Quoted 4 lines · Jann Horn

In the optimized X86 version of the copy-with-checksum helpers, use instrument_*() before accessing buffers from assembly code so that KASAN and KCSAN don't have blind spots there.

[...]

Quoted 4 lines

Can these potentially be called with KERNEL_DS as in some compat syscalls? If so it's better to use instrument_copy_to/from_user. Or probably it's better to use them anyway b/c we also want to know about user accesses for uaccess logging and maybe other things.

Christoph Hellwig has basically eradicated KERNEL_DS. :)

In particular, on X86, set_fs(KERNEL_DS) doesn't really do anything anymore since commit 47058bb54b579 ("x86: remove address space overrides using set_fs()").

#3 lore raw
Quoted 9 lines · Jann Horn
Quoted 3 lines
Quoted 3 lines

In the optimized X86 version of the copy-with-checksum helpers, use instrument_*() before accessing buffers from assembly code so that KASAN and KCSAN don't have blind spots there.

[...]

Quoted 4 lines

Can these potentially be called with KERNEL_DS as in some compat syscalls? If so it's better to use instrument_copy_to/from_user. Or probably it's better to use them anyway b/c we also want to know about user accesses for uaccess logging and maybe other things.

Quoted 5 lines

Christoph Hellwig has basically eradicated KERNEL_DS. :)

In particular, on X86, set_fs(KERNEL_DS) doesn't really do anything anymore since commit 47058bb54b579 ("x86: remove address space overrides using set_fs()").

That's good!

But still need this for uaccess logging.

Acked-by on v1 1/1
#4 lore raw
In reply to Jann Horn
Quoted 81 lines · Jann Horn

In the optimized X86 version of the copy-with-checksum helpers, use instrument_*() before accessing buffers from assembly code so that KASAN and KCSAN don't have blind spots there.

---
 arch/x86/lib/csum-partial_64.c  | 3 +++
 arch/x86/lib/csum-wrappers_64.c | 9 +++++++++
 2 files changed, 12 insertions(+)
arch/x86/lib/csum-partial_64.c +3 -0
index 1f8a8f895173..8b0c353cd212 100644
@@ -8,6 +8,7 @@
 
 #include <linux/compiler.h>
 #include <linux/export.h>
+#include <linux/instrumented.h>
 #include <asm/checksum.h>
 #include <asm/word-at-a-time.h>
 
@@ -37,6 +38,8 @@ __wsum csum_partial(const void *buff, int len, __wsum sum)
        u64 temp64 = (__force u64)sum;
        unsigned odd, result;
 
+       instrument_read(buff, len);
+
        odd = 1 & (unsigned long) buff;
        if (unlikely(odd)) {
                if (unlikely(len == 0))
arch/x86/lib/csum-wrappers_64.c +9 -0
index 189344924a2b..087f3c4cb89f 100644
@@ -6,6 +6,8 @@
  */
 #include <asm/checksum.h>
 #include <linux/export.h>
+#include <linux/in6.h>
+#include <linux/instrumented.h>
 #include <linux/uaccess.h>
 #include <asm/smap.h>
 
@@ -26,6 +28,7 @@ csum_and_copy_from_user(const void __user *src, void *dst, int len)
        __wsum sum;
 
        might_sleep();
+       instrument_write(dst, len);
        if (!user_access_begin(src, len))
                return 0;
        sum = csum_partial_copy_generic((__force const void *)src, dst, len);
@@ -51,6 +54,7 @@ csum_and_copy_to_user(const void *src, void __user *dst, int len)
        __wsum sum;
 
        might_sleep();
+       instrument_read(src, len);
        if (!user_access_begin(dst, len))
                return 0;
        sum = csum_partial_copy_generic(src, (void __force *)dst, len);
@@ -71,6 +75,8 @@ EXPORT_SYMBOL(csum_and_copy_to_user);
 __wsum
 csum_partial_copy_nocheck(const void *src, void *dst, int len)
 {
+       instrument_write(dst, len);
+       instrument_read(src, len);
        return csum_partial_copy_generic(src, dst, len);
 }
 EXPORT_SYMBOL(csum_partial_copy_nocheck);
@@ -81,6 +87,9 @@ __sum16 csum_ipv6_magic(const struct in6_addr *saddr,
 {
        __u64 rest, sum64;
 
+       instrument_read(saddr, sizeof(*saddr));
+       instrument_read(daddr, sizeof(*daddr));
+
        rest = (__force __u64)htonl(len) + (__force __u64)htons(proto) +
                (__force __u64)sum;
 
Quoted 4 lines

base-commit: 0280e3c58f92b2fe0e8fbbdf8d386449168de4a8 --
2.35.0.rc0.227.g00780c9af4-goog

It would also be nice to add tests to check these, but since we still don't have tests that check atomics [1], csum tests can be added together with them once someone gets to doing that.

Thanks!

[1] https://bugzilla.kernel.org/show_bug.cgi?id=214055