kunit: add a KUnit test for SLUB debugging functionality
Subsystems (3)
PATCH v2 1/2 kunit: add a KUnit test for SLUB debugging functionality
From: Oliver Glitta <[email protected]>
SLUB has resiliency_test() function which is hidden behind #ifdef SLUB_RESILIENCY_TEST that is not part of Kconfig, so nobody runs it. KUnit should be a proper replacement for it.
Try changing byte in redzone after allocation and changing pointer to next free node, first byte, 50th byte and redzone byte. Check if validation finds errors.
There are several differences from the original resiliency test:
Tests create own caches with known state instead of corrupting shared kmalloc caches.
The corruption of freepointer uses correct offset, the original resiliency test got broken with freepointer changes.
Scratch changing random byte test, because it does not have meaning in this form where we need deterministic results.
Add new option CONFIG_SLUB_KUNIT_TEST in Kconfig.
Add a counter field "errors" to struct kmem_cache to count number of errors detected in cache.
Silence bug report in SLUB test. Add SLAB_SILENT_ERRORS debug flag. Add SLAB_SILENT_ERRORS flag to SLAB_NEVER_MERGE, SLAB_DEBUG_FLAGS, SLAB_FLAGS_PERMITTED macros.
---
Changes since v1
Conversion from kselftest to KUnit test suggested by Marco Elver. Error silencing.
Error counting improvements.
include/linux/slab.h | 2 + include/linux/slub_def.h | 2 + lib/Kconfig.debug | 5 ++ lib/Makefile | 1 + lib/test_slub.c | 124 +++++++++++++++++++++++++++++++++++++++ mm/slab.h | 7 ++- mm/slab_common.c | 2 +- mm/slub.c | 64 +++++++++++++------- 8 files changed, 184 insertions(+), 23 deletions(-) create mode 100644 lib/test_slub.c
include/linux/slab.h +2 -0
@@ -25,6 +25,8 @@*/ /* DEBUG: Perform (expensive) checks on alloc/free */ #define SLAB_CONSISTENCY_CHECKS ((slab_flags_t __force)0x00000100U) +/* DEBUG: Silent bug reports */ +#define SLAB_SILENT_ERRORS ((slab_flags_t __force)0x00000200U)/* DEBUG: Red zone objs in a cache */ #define SLAB_RED_ZONE ((slab_flags_t __force)0x00000400U)/* DEBUG: Poison objects */
include/linux/slub_def.h +2 -0
@@ -133,6 +133,8 @@ struct kmem_cache {unsigned int usersize;/* Usercopy region size */ struct kmem_cache_node *node[MAX_NUMNODES ]; + +int errors;/* Number of errors in cache */ };#ifdef CONFIG_SLUB_CPU_PARTIAL
lib/Kconfig.debug +5 -0
@@ -2371,6 +2371,11 @@ config BITS_TEST If unsure, say N. +config SLUB_KUNIT_TEST + tristate "KUnit Test for SLUB cache error detection" if !KUNIT_ALL_TESTS + depends on SLUB_DEBUG && KUNIT + default KUNIT_ALL_TESTS + config TEST_UDELAY tristate "udelay test driver" help
lib/Makefile +1 -0
@@ -352,5 +352,6 @@ obj-$(CONFIG_LIST_KUNIT_TEST) += list-test.o obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o obj-$(CONFIG_BITS_TEST) += test_bits.o obj-$(CONFIG_CMDLINE_KUNIT_TEST) += cmdline_kunit.o +obj-$(CONFIG_SLUB_KUNIT_TEST) += test_slub.o obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o
lib/test_slub.c new file +124 -0
124 lines not on this page · raw message
mm/slab.h +5 -2
@@ -134,7 +134,8 @@ static inline slab_flags_t kmem_cache_flags(unsigned int object_size,#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)#elif defined(CONFIG_SLUB_DEBUG )#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \ - SLAB_TRACE | SLAB_CONSISTENCY_CHECKS) + SLAB_TRACE | SLAB_CONSISTENCY_CHECKS | \ + SLAB_SILENT_ERRORS)#else #define SLAB_DEBUG_FLAGS (0)#endif
@@ -164,7 +165,8 @@ static inline slab_flags_t kmem_cache_flags(unsigned int object_size, SLAB_NOLEAKTRACE | \ SLAB_RECLAIM_ACCOUNT | \ SLAB_TEMPORARY | \ - SLAB_ACCOUNT) + SLAB_ACCOUNT | \ + SLAB_SILENT_ERRORS)bool __kmem_cache_empty (struct kmem_cache *);int __kmem_cache_shutdown (struct kmem_cache *);
@@ -215,6 +217,7 @@ DECLARE_STATIC_KEY_TRUE(slub_debug_enabled);DECLARE_STATIC_KEY_FALSE (slub_debug_enabled);#endif extern void print_tracking (struct kmem_cache *s,void *object); +long validate_slab_cache (struct kmem_cache *s);#else static inline void print_tracking (struct kmem_cache *s,void *object) {
mm/slab_common.c +1 -1
@@ -55,7 +55,7 @@ static DECLARE_WORK(slab_caches_to_rcu_destroy_work,*/ #define SLAB_NEVER_MERGE (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \ SLAB_TRACE | SLAB_TYPESAFE_BY_RCU | SLAB_NOLEAKTRACE | \ - SLAB_FAILSLAB | kasan_never_merge()) + SLAB_FAILSLAB | SLAB_SILENT_ERRORS | kasan_never_merge())#define SLAB_MERGE_SAME (SLAB_RECLAIM_ACCOUNT | SLAB_CACHE_DMA | \ SLAB_CACHE_DMA32 | SLAB_ACCOUNT)
mm/slub.c +44 -20
166 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v2 2/2 slub: remove resiliency_test() function
From: Oliver Glitta <[email protected]>
Function resiliency_test() is hidden behind #ifdef SLUB_RESILIENCY_TEST that is not part of Kconfig, so nobody runs it.
This function is replaced with KUnit test for SLUB added by the previous patch "selftests: add a KUnit test for SLUB debugging functionality".
--- mm/slub.c | 64 ------------------------------------------------------- 1 file changed, 64 deletions(-)
mm/slub.c +0 -64
@@ -153,9 +153,6 @@ static inline bool kmem_cache_has_cpu_partial(struct kmem_cache *s)* - Variable sizing of the per node arrays */ -/* Enable to test recovery from slab corruption on boot */ -#undef SLUB_RESILIENCY_TEST -/* Enable to log cmpxchg failures */ #undef SLUB_DEBUG_CMPXCHG
@@ -4923,66 +4920,6 @@ static int list_locations(struct kmem_cache *s, char *buf, }#endif /* CONFIG_SLUB_DEBUG */ -#ifdef SLUB_RESILIENCY_TEST -static void __init resiliency_test (void ) -{ -u8 *p; -int type =KMALLOC_NORMAL ; - -BUILD_BUG_ON (KMALLOC_MIN_SIZE >16 ||KMALLOC_SHIFT_HIGH <10 ); - -pr_err ("SLUB resiliency testing\n" ); -pr_err ("-----------------------\n" ); -pr_err ("A. Corruption after allocation\n" ); - - p =kzalloc (16 ,GFP_KERNEL ); - p[16 ] =0x12 ; -pr_err ("\n1. kmalloc-16: Clobber Redzone/next pointer 0x12->0x%p\n\n" , - p +16 ); - -validate_slab_cache (kmalloc_caches[type][4 ]); - -/* Hmmm... The next two are dangerous */ - p =kzalloc (32 ,GFP_KERNEL ); - p[32 +sizeof (void *)] =0x34 ; -pr_err ("\n2. kmalloc-32: Clobber next pointer/next slab 0x34 -> -0x%p\n" , - p); -pr_err ("If allocated object is overwritten then not detectable\n\n" ); - -validate_slab_cache (kmalloc_caches[type][5 ]); - p =kzalloc (64 ,GFP_KERNEL ); - p +=64 + (get_cycles () &0xff ) *sizeof (void *); - *p =0x56 ; -pr_err ("\n3. kmalloc-64: corrupting random byte 0x56->0x%p\n" , - p); -pr_err ("If allocated object is overwritten then not detectable\n\n" ); -validate_slab_cache (kmalloc_caches[type][6 ]); - -pr_err ("\nB. Corruption after free\n" ); - p =kzalloc (128 ,GFP_KERNEL ); -kfree (p); - *p =0x78 ; -pr_err ("1. kmalloc-128: Clobber first word 0x78->0x%p\n\n" , p); -validate_slab_cache (kmalloc_caches[type][7 ]); - - p =kzalloc (256 ,GFP_KERNEL ); -kfree (p); - p[50 ] =0x9a ; -pr_err ("\n2. kmalloc-256: Clobber 50th byte 0x9a->0x%p\n\n" , p); -validate_slab_cache (kmalloc_caches[type][8 ]); - - p =kzalloc (512 ,GFP_KERNEL ); -kfree (p); - p[512 ] =0xab ; -pr_err ("\n3. kmalloc-512: Clobber redzone 0xab->0x%p\n\n" , p); -validate_slab_cache (kmalloc_caches[type][9 ]); -} -#else -#ifdef CONFIG_SYSFS -static void resiliency_test (void ) {}; -#endif -#endif /* SLUB_RESILIENCY_TEST */ -#ifdef CONFIG_SYSFS enum slab_stat_type { SL_ALL, /* All slabs */
@@ -5831,7 +5768,6 @@ static int __init slab_sysfs_init(void) }mutex_unlock (&slab_mutex); -resiliency_test ();return 0 ; }
Signature · 1 line
2.17.1
kernel test robot
build botThank you for the patch! Perhaps something to improve:
Hi,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on linus/master]
[also build test WARNING on v5.12-rc5]
[cannot apply to hnaz-linux-mm/master next-20210330]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/glittao-gmail-com/kunit-add-a-KUnit-test-for-SLUB-debugging-functionality/20210330-200635 base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 1e43c377a79f9189fea8f2711b399d4e8b4e609b config: x86_64-randconfig-r022-20210330 (attached as .config) compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 482283042f795ecc27838a3b2f76b5494991401c)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# install x86_64 cross compiling tool for clang build
# apt-get install binutils-x86-64-linux-gnu
# https://github.com/0day-ci/linux/commit/98f544695d3d3b4676d7ff7bd7c964c9d39172d2
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review glittao-gmail-com/kunit-add-a-KUnit-test-for-SLUB-debugging-functionality/20210330-200635 git checkout 98f544695d3d3b4676d7ff7bd7c964c9d39172d2
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64
If you fix the issue, kindly add following tag as appropriate
All warnings (new ones prefixed by >>):
>> mm/slub.c:744:17: warning: use of logical '&&' with constant operand [-Wconstant-logical-operand]
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^ ~~~~~~~~~~~~~~~~~~
mm/slub.c:744:17: note: use '&' for a bitwise operation
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^~
&
mm/slub.c:744:17: note: remove constant to silence this warning
if (!(s->flags && SLAB_SILENT_ERRORS)) {
~^~~~~~~~~~~~~~~~~~~~~
mm/slub.c:759:17: warning: use of logical '&&' with constant operand [-Wconstant-logical-operand]
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^ ~~~~~~~~~~~~~~~~~~
mm/slub.c:759:17: note: use '&' for a bitwise operation
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^~
&
mm/slub.c:759:17: note: remove constant to silence this warning
if (!(s->flags && SLAB_SILENT_ERRORS)) {
~^~~~~~~~~~~~~~~~~~~~~
mm/slub.c:807:17: warning: use of logical '&&' with constant operand [-Wconstant-logical-operand]
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^ ~~~~~~~~~~~~~~~~~~
mm/slub.c:807:17: note: use '&' for a bitwise operation
if (!(s->flags && SLAB_SILENT_ERRORS)) {
^~
&
mm/slub.c:807:17: note: remove constant to silence this warning
if (!(s->flags && SLAB_SILENT_ERRORS)) {
~^~~~~~~~~~~~~~~~~~~~~
mm/slub.c:1536:21: warning: unused function 'kmalloc_large_node_hook' [-Wunused-function]
static inline void *kmalloc_large_node_hook(void *ptr, size_t size, gfp_t flags)
^4 warnings generated.
vim +744 mm/slub.c
740
741 void object_err(struct kmem_cache *s, struct page *page,
742 u8 *object, char *reason)
743 {
> 744 if (!(s->flags && SLAB_SILENT_ERRORS)) { 745 slab_bug(s, "%s", reason);
746 print_trailer(s, page, object);
747 }
748 }
749
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
Hi,
url: https://github.com/0day-ci/linux/commits/glittao-gmail-com/kunit-add-a-KUnit-test-for-SLUB-debugging-functionality/20210330-200635 base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 1e43c377a79f9189fea8f2711b399d4e8b4e609b config: i386-randconfig-m021-20210330 (attached as .config) compiler: gcc-9 (Debian 9.3.0-22) 9.3.0
If you fix the issue, kindly add following tag as appropriate
smatch warnings:mm/slub.c:744 object_err() warn: should this be a bitwise op? mm/slub.c:759 slab_err() warn: should this be a bitwise op? mm/slub.c:807 check_bytes_and_report() warn: should this be a bitwise op?
vim +744 mm/slub.c
75c66def8d8152 Andrey Ryabinin 2015-02-13 741 void object_err(struct kmem_cache *s, struct page *page,
81819f0fc8285a Christoph Lameter 2007-05-06 742 u8 *object, char *reason)
81819f0fc8285a Christoph Lameter 2007-05-06 743 {
98f544695d3d3b Oliver Glitta 2021-03-30 @744 if (!(s->flags && SLAB_SILENT_ERRORS)) {
^^& was intended instead of &&
3dc5063786b273 Christoph Lameter 2008-04-23 745 slab_bug(s, "%s", reason);
2492268472e7d3 Christoph Lameter 2007-07-17 746 print_trailer(s, page, object);
81819f0fc8285a Christoph Lameter 2007-05-06 747 }
98f544695d3d3b Oliver Glitta 2021-03-30 748 }
81819f0fc8285a Christoph Lameter 2007-05-06 749
a38965bf941b7c Mathieu Malaterre 2018-06-07 750 static __printf(3, 4) void slab_err(struct kmem_cache *s, struct page *page,
d0e0ac9772f8ec Chen Gang 2013-07-15 751 const char *fmt, ...)
81819f0fc8285a Christoph Lameter 2007-05-06 752 {
81819f0fc8285a Christoph Lameter 2007-05-06 753 va_list args;
81819f0fc8285a Christoph Lameter 2007-05-06 754 char buf[100];
81819f0fc8285a Christoph Lameter 2007-05-06 755
2492268472e7d3 Christoph Lameter 2007-07-17 756 va_start(args, fmt);
2492268472e7d3 Christoph Lameter 2007-07-17 757 vsnprintf(buf, sizeof(buf), fmt, args);
81819f0fc8285a Christoph Lameter 2007-05-06 758 va_end(args);
98f544695d3d3b Oliver Glitta 2021-03-30 @759 if (!(s->flags && SLAB_SILENT_ERRORS)) {
^^^^^^^^^^^^^^^^^^^^^3dc5063786b273 Christoph Lameter 2008-04-23 760 slab_bug(s, "%s", buf);
2492268472e7d3 Christoph Lameter 2007-07-17 761 print_page_info(page);
81819f0fc8285a Christoph Lameter 2007-05-06 762 dump_stack();
81819f0fc8285a Christoph Lameter 2007-05-06 763 }
98f544695d3d3b Oliver Glitta 2021-03-30 764 }
81819f0fc8285a Christoph Lameter 2007-05-06 765
f7cb1933621bce Christoph Lameter 2010-09-29 766 static void init_object(struct kmem_cache *s, void *object, u8 val)
81819f0fc8285a Christoph Lameter 2007-05-06 767 {
aa1ef4d7b3f67f Andrey Konovalov 2020-12-22 768 u8 *p = kasan_reset_tag(object);
81819f0fc8285a Christoph Lameter 2007-05-06 769
d86bd1bece6fc4 Joonsoo Kim 2016-03-15 770 if (s->flags & SLAB_RED_ZONE)
d86bd1bece6fc4 Joonsoo Kim 2016-03-15 771 memset(p - s->red_left_pad, val, s->red_left_pad);
d86bd1bece6fc4 Joonsoo Kim 2016-03-15 772
81819f0fc8285a Christoph Lameter 2007-05-06 773 if (s->flags & __OBJECT_POISON) {
3b0efdfa1e7193 Christoph Lameter 2012-06-13 774 memset(p, POISON_FREE, s->object_size - 1);
3b0efdfa1e7193 Christoph Lameter 2012-06-13 775 p[s->object_size - 1] = POISON_END;
81819f0fc8285a Christoph Lameter 2007-05-06 776 }
81819f0fc8285a Christoph Lameter 2007-05-06 777
81819f0fc8285a Christoph Lameter 2007-05-06 778 if (s->flags & SLAB_RED_ZONE)
3b0efdfa1e7193 Christoph Lameter 2012-06-13 779 memset(p + s->object_size, val, s->inuse - s->object_size);
81819f0fc8285a Christoph Lameter 2007-05-06 780 }
81819f0fc8285a Christoph Lameter 2007-05-06 781
2492268472e7d3 Christoph Lameter 2007-07-17 782 static void restore_bytes(struct kmem_cache *s, char *message, u8 data,
2492268472e7d3 Christoph Lameter 2007-07-17 783 void *from, void *to)
2492268472e7d3 Christoph Lameter 2007-07-17 784 {
2492268472e7d3 Christoph Lameter 2007-07-17 785 slab_fix(s, "Restoring 0x%p-0x%p=0x%x\n", from, to - 1, data);
2492268472e7d3 Christoph Lameter 2007-07-17 786 memset(from, data, to - from);
2492268472e7d3 Christoph Lameter 2007-07-17 787 }
2492268472e7d3 Christoph Lameter 2007-07-17 788
2492268472e7d3 Christoph Lameter 2007-07-17 789 static int check_bytes_and_report(struct kmem_cache *s, struct page *page,
2492268472e7d3 Christoph Lameter 2007-07-17 790 u8 *object, char *what,
2492268472e7d3 Christoph Lameter 2007-07-17 791 u8 *start, unsigned int value, unsigned int bytes)
2492268472e7d3 Christoph Lameter 2007-07-17 792 {
2492268472e7d3 Christoph Lameter 2007-07-17 793 u8 *fault;
2492268472e7d3 Christoph Lameter 2007-07-17 794 u8 *end;
e1b70dd1e6429f Miles Chen 2019-11-30 795 u8 *addr = page_address(page);
2492268472e7d3 Christoph Lameter 2007-07-17 796
a79316c6178ca4 Andrey Ryabinin 2015-02-13 797 metadata_access_enable();
aa1ef4d7b3f67f Andrey Konovalov 2020-12-22 798 fault = memchr_inv(kasan_reset_tag(start), value, bytes);
a79316c6178ca4 Andrey Ryabinin 2015-02-13 799 metadata_access_disable();
2492268472e7d3 Christoph Lameter 2007-07-17 800 if (!fault)
81819f0fc8285a Christoph Lameter 2007-05-06 801 return 1;
2492268472e7d3 Christoph Lameter 2007-07-17 802
2492268472e7d3 Christoph Lameter 2007-07-17 803 end = start + bytes;
2492268472e7d3 Christoph Lameter 2007-07-17 804 while (end > fault && end[-1] == value)
2492268472e7d3 Christoph Lameter 2007-07-17 805 end--;
2492268472e7d3 Christoph Lameter 2007-07-17 806
98f544695d3d3b Oliver Glitta 2021-03-30 @807 if (!(s->flags && SLAB_SILENT_ERRORS)) {
^^^^^^^^^^^^^^^^^^^^^2492268472e7d3 Christoph Lameter 2007-07-17 808 slab_bug(s, "%s overwritten", what);
e1b70dd1e6429f Miles Chen 2019-11-30 809 pr_err("INFO: 0x%p-0x%p @offset=%tu. First byte 0x%x instead of 0x%x\n",
e1b70dd1e6429f Miles Chen 2019-11-30 810 fault, end - 1, fault - addr,
e1b70dd1e6429f Miles Chen 2019-11-30 811 fault[0], value);
2492268472e7d3 Christoph Lameter 2007-07-17 812 print_trailer(s, page, object);
98f544695d3d3b Oliver Glitta 2021-03-30 813 }
2492268472e7d3 Christoph Lameter 2007-07-17 814
2492268472e7d3 Christoph Lameter 2007-07-17 815 restore_bytes(s, what, value, fault, end);
2492268472e7d3 Christoph Lameter 2007-07-17 816 return 0;
81819f0fc8285a Christoph Lameter 2007-05-06 817 }---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org