From: Alessandro Carminati <[email protected]> Some unit tests intentionally trigger warning backtraces by passing bad parameters to kernel API functions. Such unit tests typically check the return value from such calls, not the existence of the warning backtrace.
Such intentionally generated warning backtraces are neither desirable nor useful for a number of reasons: - They can result in overlooked real problems. - A warning that suddenly starts to show up in unit tests needs to be investigated and has to be marked to be ignored, for example by adjusting filter scripts. Such filters are ad hoc because there is no real standard format for warnings. On top of that, such filter scripts would require constant maintenance. Solve the problem by providing a means to identify and suppress specific warning backtraces while executing test code. Support suppressing multiple backtraces while at the same time limiting changes to generic code to the absolute minimum. Implementation details: Check suppression directly in the `WARN()` Macros. This avoids the need for function symbol resolution or ELF section modification. Use unlikely() with KUNIT_IS_SUPPRESSED_WARNING() in the Macros so the common case (no suppression) stays on the hot path, improving performance and keeping the critical path smaller. A helper function, `__kunit_is_suppressed_warning()`, is used to determine whether suppression applies. It is marked as `noinstr`, since some `WARN*()` sites reside in non-instrumentable sections. As it uses `strcmp`, which is not `noinstr`-safe, its use is wrapped within `__kunit_check_suppress()` and surounded by instrumentation_begin()/end() calls. The list of supressed warnings includes RCU protection. The implementation is deliberately simple and avoids architecture-specific optimizations to preserve portability. Signed-off-by: Guenter Roeck <[email protected]> Signed-off-by: Alessandro Carminati <[email protected]> Reviewed-by: Kees Cook <[email protected]> Signed-off-by: Albert Esteve <[email protected]> --- include/asm-generic/bug.h | 44 ++++++++++++++++++++++------------ include/kunit/bug.h | 61 +++++++++++++++++++++++++++++++++++++++++++++++ include/kunit/test.h | 1 + lib/kunit/Kconfig | 9 +++++++ lib/kunit/Makefile | 6 +++-- lib/kunit/bug.c | 59 +++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 163 insertions(+), 17 deletions(-) diff --git a/include/asm-generic/bug.h b/include/asm-generic/bug.h index 09e8eccee8ed9..7c766fde49a90 100644 --- a/include/asm-generic/bug.h +++ b/include/asm-generic/bug.h @@ -27,6 +27,7 @@ #endif /* WARN_CONDITION_STR */ #ifndef __ASSEMBLY__ +#include <kunit/bug.h> #include <linux/panic.h> #include <linux/printk.h> @@ -71,9 +72,13 @@ struct bug_entry { */ #ifndef HAVE_ARCH_BUG #define BUG() do { \ - printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ - barrier_before_unreachable(); \ - panic("BUG!"); \ + if (!unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) { \ + printk("BUG: failure at %s:%d/%s()!\n", __FILE__, \ + __LINE__, __func__); \ + barrier_before_unreachable(); \ + panic("BUG!"); \ + } \ + __builtin_unreachable(); \ } while (0) #endif @@ -129,18 +134,23 @@ extern __printf(1, 2) void __warn_printk(const char *fmt, ...); #if defined(__WARN_FLAGS) && !defined(__WARN_printf) #define __WARN_printf(taint, arg...) do { \ - instrumentation_begin(); \ - __warn_printk(arg); \ - __WARN_FLAGS("", BUGFLAG_NO_CUT_HERE | BUGFLAG_TAINT(taint));\ - instrumentation_end(); \ + if (!unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) { \ + instrumentation_begin(); \ + __warn_printk(arg); \ + __WARN_FLAGS("", BUGFLAG_NO_CUT_HERE | \ + BUGFLAG_TAINT(taint)); \ + instrumentation_end(); \ + } \ } while (0) #endif #ifndef __WARN_printf -#define __WARN_printf(taint, arg...) do { \ - instrumentation_begin(); \ - warn_slowpath_fmt(__FILE__, __LINE__, taint, arg); \ - instrumentation_end(); \ +#define __WARN_printf(taint, arg...) do { \ + if (!unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) { \ + instrumentation_begin(); \ + warn_slowpath_fmt(__FILE__, __LINE__, taint, arg); \ + instrumentation_end(); \ + } \ } while (0) #endif @@ -153,7 +163,8 @@ extern __printf(1, 2) void __warn_printk(const char *fmt, ...); #ifndef WARN_ON #define WARN_ON(condition) ({ \ int __ret_warn_on = !!(condition); \ - if (unlikely(__ret_warn_on)) \ + if (unlikely(__ret_warn_on) && \ + !unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) \ __WARN(); \ unlikely(__ret_warn_on); \ }) @@ -170,7 +181,8 @@ extern __printf(1, 2) void __warn_printk(const char *fmt, ...); #define WARN_TAINT(condition, taint, format...) ({ \ int __ret_warn_on = !!(condition); \ - if (unlikely(__ret_warn_on)) \ + if (unlikely(__ret_warn_on) && \ + !unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) \ __WARN_printf(taint, format); \ unlikely(__ret_warn_on); \ }) @@ -191,8 +203,10 @@ extern __printf(1, 2) void __warn_printk(const char *fmt, ...); #else /* !CONFIG_BUG */ #ifndef HAVE_ARCH_BUG #define BUG() do { \ - do {} while (1); \ - unreachable(); \ + if (!unlikely(KUNIT_IS_SUPPRESSED_WARNING(__func__))) { \ + do {} while (1); \ + } \ + unreachable(); \ } while (0) #endif diff --git a/include/kunit/bug.h b/include/kunit/bug.h new file mode 100644 index 0000000000000..9a5cd226c2139 --- /dev/null +++ b/include/kunit/bug.h @@ -0,0 +1,61 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * KUnit helpers for backtrace suppression + * + * Copyright (C) 2025 Alessandro Carminati <[email protected]> + * Copyright (C) 2024 Guenter Roeck <[email protected]> + */ + +#ifndef _KUNIT_BUG_H +#define _KUNIT_BUG_H + +#ifndef __ASSEMBLY__ + +#include <linux/kconfig.h> + +#ifdef CONFIG_KUNIT_SUPPRESS_BACKTRACE + +#include <linux/stringify.h> +#include <linux/types.h> + +struct __suppressed_warning { + struct list_head node; + const char *function; + int counter; +}; + +void __kunit_start_suppress_warning(struct __suppressed_warning *warning); +void __kunit_end_suppress_warning(struct __suppressed_warning *warning); +bool __kunit_is_suppressed_warning(const char *function); + +#define KUNIT_DEFINE_SUPPRESSED_WARNING(func) \ + struct __suppressed_warning __kunit_suppress_##func = \ + { .function = __stringify(func), .counter = 0 } + +#define KUNIT_START_SUPPRESSED_WARNING(func) \ + __kunit_start_suppress_warning(&__kunit_suppress_##func) + +#define KUNIT_END_SUPPRESSED_WARNING(func) \ + __kunit_end_suppress_warning(&__kunit_suppress_##func) + +#define KUNIT_IS_SUPPRESSED_WARNING(func) \ + __kunit_is_suppressed_warning(func) + +#define KUNIT_SUPPRESSED_WARNING_COUNT(func) \ + (__kunit_suppress_##func.counter) + +#define KUNIT_SUPPRESSED_WARNING_COUNT_RESET(func) \ + __kunit_suppress_##func.counter = 0 + +#else /* CONFIG_KUNIT_SUPPRESS_BACKTRACE */ + +#define KUNIT_DEFINE_SUPPRESSED_WARNING(func) +#define KUNIT_START_SUPPRESSED_WARNING(func) +#define KUNIT_END_SUPPRESSED_WARNING(func) +#define KUNIT_IS_SUPPRESSED_WARNING(func) ((void)(func), false) +#define KUNIT_SUPPRESSED_WARNING_COUNT(func) ((void)(func), 0) +#define KUNIT_SUPPRESSED_WARNING_COUNT_RESET(func) + +#endif /* CONFIG_KUNIT_SUPPRESS_BACKTRACE */ +#endif /* __ASSEMBLY__ */ +#endif /* _KUNIT_BUG_H */ diff --git a/include/kunit/test.h b/include/kunit/test.h index 9cd1594ab697d..4ec07b3fa0204 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -10,6 +10,7 @@ #define _KUNIT_TEST_H #include <kunit/assert.h> +#include <kunit/bug.h> #include <kunit/try-catch.h> #include <linux/args.h> diff --git a/lib/kunit/Kconfig b/lib/kunit/Kconfig index 498cc51e493dc..57527418fcf09 100644 --- a/lib/kunit/Kconfig +++ b/lib/kunit/Kconfig @@ -15,6 +15,15 @@ menuconfig KUNIT if KUNIT +config KUNIT_SUPPRESS_BACKTRACE + bool "KUnit - Enable backtrace suppression" + default y + help + Enable backtrace suppression for KUnit. If enabled, backtraces + generated intentionally by KUnit tests are suppressed. Disable + to reduce kernel image size if image size is more important than + suppression of backtraces generated by KUnit tests. + config KUNIT_DEBUGFS bool "KUnit - Enable /sys/kernel/debug/kunit debugfs representation" if !KUNIT_ALL_TESTS default KUNIT_ALL_TESTS diff --git a/lib/kunit/Makefile b/lib/kunit/Makefile index 656f1fa35abcc..fe177ff3ebdef 100644 --- a/lib/kunit/Makefile +++ b/lib/kunit/Makefile @@ -16,8 +16,10 @@ ifeq ($(CONFIG_KUNIT_DEBUGFS),y) kunit-objs += debugfs.o endif -# KUnit 'hooks' are built-in even when KUnit is built as a module. -obj-$(if $(CONFIG_KUNIT),y) += hooks.o +# KUnit 'hooks' and bug handling are built-in even when KUnit is built +# as a module. +obj-$(if $(CONFIG_KUNIT),y) += hooks.o \ + bug.o obj-$(CONFIG_KUNIT_TEST) += kunit-test.o obj-$(CONFIG_KUNIT_TEST) += platform-test.o diff --git a/lib/kunit/bug.c b/lib/kunit/bug.c new file mode 100644 index 0000000000000..53c98e225a895 --- /dev/null +++ b/lib/kunit/bug.c @@ -0,0 +1,59 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * KUnit helpers for backtrace suppression + * + * Copyright (C) 2025 Alessandro Carminati <[email protected]> + * Copyright (C) 2024 Guenter Roeck <[email protected]> + */ + +#include <kunit/bug.h> +#include <linux/export.h> +#include <linux/instrumentation.h> +#include <linux/rculist.h> +#include <linux/string.h> + +#ifdef CONFIG_KUNIT_SUPPRESS_BACKTRACE + +static LIST_HEAD(suppressed_warnings); + +void __kunit_start_suppress_warning(struct __suppressed_warning *warning) +{ + list_add_rcu(&warning->node, &suppressed_warnings); +} +EXPORT_SYMBOL_GPL(__kunit_start_suppress_warning); + +void __kunit_end_suppress_warning(struct __suppressed_warning *warning) +{ + list_del_rcu(&warning->node); + synchronize_rcu(); /* Wait for readers to finish */ +} +EXPORT_SYMBOL_GPL(__kunit_end_suppress_warning); + +static bool __kunit_check_suppress(const char *function) +{ + struct __suppressed_warning *warning; + + if (!function) + return false; + + list_for_each_entry(warning, &suppressed_warnings, node) { + if (!strcmp(function, warning->function)) { + warning->counter++; + return true; + } + } + return false; +} + +noinstr bool __kunit_is_suppressed_warning(const char *function) +{ + bool ret; + + instrumentation_begin(); + ret = __kunit_check_suppress(function); + instrumentation_end(); + return ret; +} +EXPORT_SYMBOL_GPL(__kunit_is_suppressed_warning); + +#endif /* CONFIG_KUNIT_SUPPRESS_BACKTRACE */ -- 2.52.0
