Bitops instrumentation for KASAN
Subsystems (5)
v4 cover Bitops instrumentation for KASAN
Previous version:
http://lkml.kernel.org/r/[email protected]
* This version only changes lib/test_kasan.c.
* Remaining files are identical to v3.
Marco Elver (3):
lib/test_kasan: Add bitops tests
x86: Use static_cpu_has in uaccess region to avoid instrumentation asm-generic, x86: Add bitops instrumentation for KASAN
Documentation/core-api/kernel-api.rst | 2 +- arch/x86/ia32/ia32_signal.c | 2 +- arch/x86/include/asm/bitops.h | 189 ++++------------ arch/x86/kernel/signal.c | 2 +- include/asm-generic/bitops-instrumented.h | 263 ++++++++++++++++++++++ lib/test_kasan.c | 82 ++++++- 6 files changed, 383 insertions(+), 157 deletions(-) create mode 100644 include/asm-generic/bitops-instrumented.h
Signature · 1 line
2.22.0.rc2.383.gf4fbbf30c2-goog
PATCH v4 1/3 lib/test_kasan: Add bitops tests
This adds bitops tests to the test_kasan module. In a follow-up patch, support for bitops instrumentation will be added.
---
Changes in v4:
* Remove "within-bounds" tests.
* Allocate sizeof(*bite) + 1, to not actually corrupt other memory in case instrumentation isn't working.
* Clarify that accesses operate on whole longs, which causes OOB regardless of the bit accessed beyond the first long in the test.
Changes in v3:
* Use kzalloc instead of kmalloc.
* Use sizeof(*bits).
Changes in v2:
* Use BITS_PER_LONG.
* Use heap allocated memory for test, as newer compilers (correctly) warn on OOB stack access.
--- lib/test_kasan.c | 82 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 79 insertions(+), 3 deletions(-)
lib/test_kasan.c +79 -3
@@ -11,16 +11,17 @@#define pr_fmt (fmt) "kasan test: %s " fmt, __func__ +#include <linux/bitops.h> #include <linux/delay.h> +#include <linux/kasan.h> #include <linux/kernel.h> -#include <linux/mman.h> #include <linux/mm.h> +#include <linux/mman.h> +#include <linux/module.h> #include <linux/printk.h> #include <linux/slab.h> #include <linux/string.h> #include <linux/uaccess.h> -#include <linux/module.h> -#include <linux/kasan.h> /* * Note: test functions are marked noinline so that their names appear in
@@ -623,6 +624,80 @@ static noinline void __init kasan_strings(void)strnlen (ptr,1 ); } +static noinline void __init kasan_bitops(void) +{ +/* +* Allocate 1 more byte, which causes kzalloc to round up to 16-bytes; +* this way we do not actually corrupt other memory, in case +* instrumentation is not working as intended. +*/ +long *bits =kzalloc (sizeof (*bits) +1 ,GFP_KERNEL ); +if (!bits) +return ; + +/* +* Below calls try to access bit within allocated memory; however, the +* below accesses are still out-of-bounds, since bitops are defined to +* operate on the whole long the bit is in. +*/ +pr_info ("out-of-bounds in set_bit\n" ); +set_bit (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in __set_bit\n" ); +__set_bit (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in clear_bit\n" ); +clear_bit (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in __clear_bit\n" ); +__clear_bit (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in clear_bit_unlock\n" ); +clear_bit_unlock (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in __clear_bit_unlock\n" ); +__clear_bit_unlock (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in change_bit\n" ); +change_bit (BITS_PER_LONG , bits); + +pr_info ("out-of-bounds in __change_bit\n" ); +__change_bit (BITS_PER_LONG , bits); + +/* +* Below calls try to access bit beyond allocated memory. +*/ +pr_info ("out-of-bounds in test_and_set_bit\n" ); +test_and_set_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in __test_and_set_bit\n" ); +__test_and_set_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in test_and_set_bit_lock\n" ); +test_and_set_bit_lock (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in test_and_clear_bit\n" ); +test_and_clear_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in __test_and_clear_bit\n" ); +__test_and_clear_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in test_and_change_bit\n" ); +test_and_change_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in __test_and_change_bit\n" ); +__test_and_change_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +pr_info ("out-of-bounds in test_bit\n" ); + (void )test_bit (BITS_PER_LONG +BITS_PER_BYTE , bits); + +#if defined(clear_bit_unlock_is_negative_byte) +pr_info ("out-of-bounds in clear_bit_unlock_is_negative_byte\n" ); +clear_bit_unlock_is_negative_byte (BITS_PER_LONG +BITS_PER_BYTE , bits); +#endif +kfree (bits); +} +static int __init kmalloc_tests_init (void ) {/*
@@ -664,6 +739,7 @@ static int __init kmalloc_tests_init(void)kasan_memchr ();kasan_memcmp ();kasan_strings (); +kasan_bitops ();kasan_restore_multi_shot (multishot);
Signature · 1 line
2.22.0.rc2.383.gf4fbbf30c2-goog
Re: [PATCH v4 1/3] lib/test_kasan: Add bitops tests
Quoted 6 lines · Marco Elver
This adds bitops tests to the
test_kasanmodule. In a follow-up patch, support for bitops instrumentation will be added.Signed-off-by Marco Elver <[email protected]>Acked-by Mark Rutland <[email protected]>---
lib/test_kasan.c static noinline void __init kasan_strings(void) · line 632
Quoted 6 lines
lib/test_kasan.c +6
-0+static noinline void __init kasan_bitops(void) +{ +/* +* Allocate 1 more byte, which causes kzalloc to round up to 16-bytes; +* this way we do not actually corrupt other memory, in case +* instrumentation is not working as intended.
This sound like working instrumentation somehow save us from corrupting memory. In fact it doesn't, it only reports corruption.
Quoted 5 lines
lib/test_kasan.c +5
-0+*/ +long *bits =kzalloc (sizeof (*bits) +1 ,GFP_KERNEL ); +if (!bits) +return ; +
Re: [PATCH v4 1/3] lib/test_kasan: Add bitops tests
Quoted 16 lines · Andrey Ryabinin
Quoted 6 lines · Marco Elver
This adds bitops tests to the
test_kasanmodule. In a follow-up patch, support for bitops instrumentation will be added.Signed-off-by Marco Elver <[email protected]>Acked-by Mark Rutland <[email protected]>---
Reviewed-by Andrey Ryabinin <[email protected]>
Quoted 9 lines
lib/test_kasan.c static noinline void __init kasan_strings(void) · line 632
Quoted 6 lines
lib/test_kasan.c +6
-0+static noinline void __init kasan_bitops(void) +{ +/* +* Allocate 1 more byte, which causes kzalloc to round up to 16-bytes; +* this way we do not actually corrupt other memory, in case +* instrumentation is not working as intended. This sound like working instrumentation somehow save us from corrupting memory. In fact it doesn't, it only reports corruption.
Thanks, I removed the confusing wording. Sent v5.
Quoted 12 lines
lib/test_kasan.c static noinline void __init kasan_strings(void) · line 637
Quoted 5 lines
lib/test_kasan.c +5
-0+*/ +long *bits =kzalloc (sizeof (*bits) +1 ,GFP_KERNEL ); +if (!bits) +return ; +--
You received this message because you are subscribed to the Google Groups "kasan-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/6cc5e12d-1492-d9b7-3ea7-6381407439d7%40virtuozzo.com.
For more options, visit https://groups.google.com/d/optout.
PATCH v4 2/3 x86: Use static_cpu_has in uaccess region to avoid instrumentation
In reply to Marco ElverThis patch is a pre-requisite for enabling KASAN bitops instrumentation; using static_cpu_has instead of boot_cpu_has avoids instrumentation of test_bit inside the uaccess region. With instrumentation, the KASAN check would otherwise be flagged by objtool.
For consistency, kernel/signal.c was changed to mirror this change, however, is never instrumented with KASAN (currently unsupported under x86 32bit).
---
Changes in v3:
* Use static_cpu_has instead of moving boot_cpu_has outside uaccess region.
Changes in v2:
* Replaces patch: 'tools/objtool: add kasan_check_* to uaccess whitelist'
--- arch/x86/ia32/ia32_signal.c | 2 +- arch/x86/kernel/signal.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
arch/x86/ia32/ia32_signal.c +1 -1
@@ -358,7 +358,7 @@ int ia32_setup_rt_frame(int sig, struct ksignal *ksig,put_user_ex (ptr_to_compat (&frame->uc), &frame->puc);/* Create the ucontext. */ -if (boot_cpu_has (X86_FEATURE_XSAVE )) +if (static_cpu_has (X86_FEATURE_XSAVE ))put_user_ex (UC_FP_XSTATE , &frame->uc.uc_flags);else put_user_ex (0 , &frame->uc.uc_flags);
arch/x86/kernel/signal.c +1 -1
@@ -391,7 +391,7 @@ static int __setup_rt_frame(int sig, struct ksignal *ksig,put_user_ex (&frame->uc, &frame->puc);/* Create the ucontext. */ -if (boot_cpu_has (X86_FEATURE_XSAVE )) +if (static_cpu_has (X86_FEATURE_XSAVE ))put_user_ex (UC_FP_XSTATE , &frame->uc.uc_flags);else put_user_ex (0 , &frame->uc.uc_flags);
Signature · 1 line
2.22.0.rc2.383.gf4fbbf30c2-goog
PATCH v4 3/3 asm-generic, x86: Add bitops instrumentation for KASAN
In reply to Marco ElverThis adds a new header to asm-generic to allow optionally instrumenting architecture-specific asm implementations of bitops.
This change includes the required change for x86 as reference and changes the kernel API doc to point to bitops-instrumented.h instead.
Rationale: the functions in x86's bitops.h are no longer the kernel API functions, but instead the arch_ prefixed functions, which are then instrumented via bitops-instrumented.h.
Other architectures can similarly add support for asm implementations of bitops.
The documentation text was derived from x86 and existing bitops asm-generic versions: 1) references to x86 have been removed; 2) as a result, some of the text had to be reworded for clarity and consistency.
Tested: using lib/test_kasan with bitops tests (pre-requisite patch).
Bugzilla: https://bugzilla.kernel.org/show_bug.cgi?id=198439
---
Changes in v3:
* Remove references to 'x86' in API documentation; as a result, had to reword doc text for clarify and consistency.
* Remove #ifdef, since it is assumed that if asm-generic bitops implementations are used, bitops-instrumented.h is not needed.
Changes in v2:
* Instrument word-sized accesses, as specified by the interface.
--- Documentation/core-api/kernel-api.rst | 2 +- arch/x86/include/asm/bitops.h | 189 ++++------------ include/asm-generic/bitops-instrumented.h | 263 ++++++++++++++++++++++ 3 files changed, 302 insertions(+), 152 deletions(-) create mode 100644 include/asm-generic/bitops-instrumented.h
Documentation/core-api/kernel-api.rst +1 -1
@@ -51,7 +51,7 @@ The Linux kernel provides more basic utility functions. Bit Operations -------------- -.. kernel-doc:: arch/x86/include/asm/bitops.h +.. kernel-doc:: include/asm-generic/bitops-instrumented.h :internal: Bitmap Operations
arch/x86/include/asm/bitops.h +38 -151
289 lines not on this page · raw message
include/asm-generic/bitops-instrumented.h new file +263 -0
263 lines not on this page · raw message
Signature · 1 line
2.22.0.rc2.383.gf4fbbf30c2-goog