archive mirror
 help / color / mirror / Atom feed
From: David Gow <>
To: Brendan Higgins <>,
	Daniel Latypov <>,
	Shuah Khan <>
Cc: David Gow <>,,,, Kees Cook <>,,
Subject: [PATCH v3 1/3] kunit: Provide a static key to check if KUnit is actively running tests
Date: Sat, 19 Nov 2022 16:12:50 +0800	[thread overview]
Message-ID: <> (raw)

KUnit does a few expensive things when enabled. This hasn't been a
problem because KUnit was only enabled on test kernels, but with a few
people enabling (but not _using_) KUnit on production systems, we need a
runtime way of handling this.

Provide a 'kunit_running' static key (defaulting to false), which allows
us to hide any KUnit code behind a static branch. This should reduce the
performance impact (on other code) of having KUnit enabled to a single
NOP when no tests are running.

Note that, while it looks unintuitive, tests always run entirely within
__kunit_test_suites_init(), so it's safe to decrement the static key at
the end of this function, rather than in __kunit_test_suites_exit(),
which is only there to clean up results in debugfs.

Signed-off-by: David Gow <>

This should be a no-op (other than a possible performance improvement)
functionality-wise, and lays the groundwork for a more optimised static
stub implementation.

The remaining patches in the series add a kunit_get_current_test()
function which is a more friendly and performant wrapper around
current->kunit_test, and use this in the slub test. They also improve
the documentation a bit.

If there are no objections, we'll take the whole series via the KUnit

No changes since v2:

Changes since v1:
- No changes in this patch.
- Patch 2/3 is reworked, patch 3/3 is new.

 include/kunit/test.h | 4 ++++
 lib/kunit/test.c     | 6 ++++++
 2 files changed, 10 insertions(+)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index d7f60e8aab30..b948c32a7b6b 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -16,6 +16,7 @@
 #include <linux/container_of.h>
 #include <linux/err.h>
 #include <linux/init.h>
+#include <linux/jump_label.h>
 #include <linux/kconfig.h>
 #include <linux/kref.h>
 #include <linux/list.h>
@@ -27,6 +28,9 @@
 #include <asm/rwonce.h>
+/* Static key: true if any KUnit tests are currently running */
+extern struct static_key_false kunit_running;
 struct kunit;
 /* Size of log associated with test. */
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 90640a43cf62..314717b63080 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -20,6 +20,8 @@
 #include "string-stream.h"
 #include "try-catch-impl.h"
  * Fail the current test and print an error message to the log.
@@ -612,10 +614,14 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_
 		return 0;
+	static_branch_inc(&kunit_running);
 	for (i = 0; i < num_suites; i++) {
+	static_branch_dec(&kunit_running);
 	return 0;

             reply	other threads:[~2022-11-19  8:13 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-19  8:12 David Gow [this message]
2022-11-19  8:12 ` [PATCH v3 2/3] kunit: Use the static key when retrieving the current test David Gow
2022-11-22  2:21   ` Daniel Latypov
2022-11-22  3:16     ` David Gow
2022-11-23 16:59       ` Daniel Latypov
2022-11-23 15:48   ` Sadiya Kazi
2022-11-19  8:12 ` [PATCH v3 3/3] mm: slub: test: Use the kunit_get_current_test() function David Gow
2022-11-24 10:43   ` Hyeonggon Yoo
2022-11-25  8:33     ` David Gow
2022-11-22  1:31 ` [PATCH v3 1/3] kunit: Provide a static key to check if KUnit is actively running tests Daniel Latypov
2022-11-22  2:33   ` David Gow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).