Submit the top-level headers also from the kunit test module notifier initialization callback, so external tools that are parsing dmesg for kunit test output are able to tell how many test suites should be expected and whether to continue parsing after complete output from the first test suite is collected.
Extend kunit module notifier initialization callback with a processing path for only listing the tests provided by a module if the kunit action parameter is set to "list", so external tools can obtain a list of test cases to be executed in advance and can make a better job on assigning kernel messages interleaved with kunit output to specific tests.
Use test filtering functions in kunit module notifier callback functions, so external tools are able to execute individual test cases from kunit test modules in order to still better isolate their potential impact on kernel messages that appear interleaved with output from other tests.
v4: Use kunit_exec_run_tests() (Mauro, Rae), but prevent it from emitting the headers when called on load of non-test modules, - don't use a different list format, use kunit_exec_list_tests() (Rae), - refresh on top of newly introduced attributes patches, handle newly introduced kunit.action=list_attr case (Rae). v3: Fix CONFIG_GLOB, required by filtering functions, not selected when building as a module. v2: Fix new name of a structure moved to kunit namespace not updated across all uses.
Janusz Krzysztofik (3): kunit: Report the count of test suites in a module kunit: Make 'list' action available to kunit test modules kunit: Allow kunit test modules to use test filtering
include/kunit/test.h | 21 ++++++++ lib/kunit/Kconfig | 2 +- lib/kunit/executor.c | 115 +++++++++++++++++++++++++------------------ lib/kunit/test.c | 40 ++++++++++++++- 4 files changed, 128 insertions(+), 50 deletions(-)
base-commit: 5a175d369c702ce08c9feb630125c9fc7a9e1370
According to KTAP specification[1], results should always start from a header that provides a TAP protocol version, followed by a test plan with a count of items to be executed. That pattern should be followed at each nesting level. In the current implementation of the top-most, i.e., test suite level, those rules apply only for test suites built into the kernel, executed and reported on boot. Results submitted to dmesg from kunit test modules loaded later are missing those top-level headers.
As a consequence, if a kunit test module provides more than one test suite then, without the top level test plan, external tools that are parsing dmesg for kunit test output are not able to tell how many test suites should be expected and whether to continue parsing after complete output from the first test suite is collected.
Submit the top-level headers also from the kunit test module notifier initialization callback.
v2: Use kunit_exec_run_tests() (Mauro, Rae), but prevent it from emitting the headers when called on load of non-test modules.
[1] https://docs.kernel.org/dev-tools/ktap.html#
Signed-off-by: Janusz Krzysztofik janusz.krzysztofik@linux.intel.com Cc: Mauro Carvalho Chehab mchehab@kernel.org Cc: Rae Moar rmoar@google.com --- include/kunit/test.h | 8 ++++++++ lib/kunit/executor.c | 42 +++++++++++++++++++++++------------------- lib/kunit/test.c | 6 +++++- 3 files changed, 36 insertions(+), 20 deletions(-)
diff --git a/include/kunit/test.h b/include/kunit/test.h index 011e0d6bb506c..3d002e6b252f2 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -256,6 +256,12 @@ struct kunit_suite { int suite_init_err; };
+/* Stores an array of suites, end points one past the end */ +struct kunit_suite_set { + struct kunit_suite * const *start; + struct kunit_suite * const *end; +}; + /** * struct kunit - represents a running instance of a test. * @@ -317,6 +323,8 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_
void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites);
+void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin); + #if IS_BUILTIN(CONFIG_KUNIT) int kunit_run_all_tests(void); #else diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index 5b5bed1efb931..bd6f3b5dc47f7 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -104,13 +104,7 @@ kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_ static char *kunit_shutdown; core_param(kunit_shutdown, kunit_shutdown, charp, 0644);
-/* Stores an array of suites, end points one past the end */ -struct suite_set { - struct kunit_suite * const *start; - struct kunit_suite * const *end; -}; - -static void kunit_free_suite_set(struct suite_set suite_set) +static void kunit_free_suite_set(struct kunit_suite_set suite_set) { struct kunit_suite * const *suites;
@@ -119,16 +113,17 @@ static void kunit_free_suite_set(struct suite_set suite_set) kfree(suite_set.start); }
-static struct suite_set kunit_filter_suites(const struct suite_set *suite_set, - const char *filter_glob, - char *filters, - char *filter_action, - int *err) +static struct kunit_suite_set +kunit_filter_suites(const struct kunit_suite_set *suite_set, + const char *filter_glob, + char *filters, + char *filter_action, + int *err) { int i, j, k; int filter_count = 0; struct kunit_suite **copy, *filtered_suite, *new_filtered_suite; - struct suite_set filtered; + struct kunit_suite_set filtered; struct kunit_glob_filter parsed_glob; struct kunit_attr_filter *parsed_filters;
@@ -219,17 +214,24 @@ static void kunit_handle_shutdown(void)
}
-static void kunit_exec_run_tests(struct suite_set *suite_set) +#endif + +void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin) { size_t num_suites = suite_set->end - suite_set->start;
- pr_info("KTAP version 1\n"); - pr_info("1..%zu\n", num_suites); + if (builtin || num_suites) { + pr_info("KTAP version 1\n"); + pr_info("1..%zu\n", num_suites); + }
__kunit_test_suites_init(suite_set->start, num_suites); }
-static void kunit_exec_list_tests(struct suite_set *suite_set, bool include_attr) +#if IS_BUILTIN(CONFIG_KUNIT) + +static void kunit_exec_list_tests(struct kunit_suite_set *suite_set, + bool include_attr) { struct kunit_suite * const *suites; struct kunit_case *test_case; @@ -254,7 +256,9 @@ static void kunit_exec_list_tests(struct suite_set *suite_set, bool include_attr
int kunit_run_all_tests(void) { - struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end}; + struct kunit_suite_set suite_set = { + __kunit_suites_start, __kunit_suites_end, + }; int err = 0; if (!kunit_enabled()) { pr_info("kunit: disabled\n"); @@ -271,7 +275,7 @@ int kunit_run_all_tests(void) }
if (!action_param) - kunit_exec_run_tests(&suite_set); + kunit_exec_run_tests(&suite_set, true); else if (strcmp(action_param, "list") == 0) kunit_exec_list_tests(&suite_set, false); else if (strcmp(action_param, "list_attr") == 0) diff --git a/lib/kunit/test.c b/lib/kunit/test.c index cb9797fa6303f..8b2808068497f 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -736,7 +736,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit); #ifdef CONFIG_MODULES static void kunit_module_init(struct module *mod) { - __kunit_test_suites_init(mod->kunit_suites, mod->num_kunit_suites); + struct kunit_suite_set suite_set = { + mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites, + }; + + kunit_exec_run_tests(&suite_set, false); }
static void kunit_module_exit(struct module *mod)
Hi Janusz,
kernel test robot noticed the following build errors:
[auto build test ERROR on 5a175d369c702ce08c9feb630125c9fc7a9e1370]
url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Repo... base: 5a175d369c702ce08c9feb630125c9fc7a9e1370 patch link: https://lore.kernel.org/r/20230804225220.8005-6-janusz.krzysztofik%40linux.i... patch subject: [PATCH v4 1/3] kunit: Report the count of test suites in a module config: loongarch-allyesconfig (https://download.01.org/0day-ci/archive/20230805/202308050802.0wKtrhu1-lkp@i...) compiler: loongarch64-linux-gcc (GCC) 12.3.0 reproduce: (https://download.01.org/0day-ci/archive/20230805/202308050802.0wKtrhu1-lkp@i...)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags | Reported-by: kernel test robot lkp@intel.com | Closes: https://lore.kernel.org/oe-kbuild-all/202308050802.0wKtrhu1-lkp@intel.com/
All errors (new ones prefixed by >>):
In file included from lib/kunit/executor.c:296: lib/kunit/executor_test.c: In function 'filter_suites_test':
lib/kunit/executor_test.c:46:16: error: variable 'suite_set' has initializer but incomplete type
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^~~~~~~~~
lib/kunit/executor_test.c:46:40: error: 'struct suite_set' has no member named 'start'
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^~~~~ lib/kunit/executor_test.c:46:48: warning: excess elements in struct initializer 46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^~~~~~~~ lib/kunit/executor_test.c:46:48: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:46:59: error: 'struct suite_set' has no member named 'end'
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^~~ lib/kunit/executor_test.c:46:65: warning: excess elements in struct initializer 46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^ lib/kunit/executor_test.c:46:65: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:46:26: error: storage size of 'suite_set' isn't known
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; | ^~~~~~~~~
lib/kunit/executor_test.c:47:26: error: storage size of 'got' isn't known
47 | struct suite_set got; | ^~~ In file included from lib/kunit/executor.c:4: include/kunit/test.h:797:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion] 797 | if (!IS_ERR_OR_NULL(__ptr)) \ | ^~~~~ | | | int include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION' 1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG' 1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL' 55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ In file included from include/linux/rwsem.h:17, from include/linux/notifier.h:15, from include/linux/reboot.h:6, from lib/kunit/executor.c:3: include/linux/err.h:70:68: note: expected 'const void *' but argument is of type 'int' 70 | static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr) | ~~~~~~~~~~~~^~~ include/kunit/test.h:804:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion] 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~ include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED' 570 | const struct assert_class __assertion = INITIALIZER; \ | ^~~~~~~~~~~ include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT' 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~~~~~~~~~~~~~ include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION' 1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG' 1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL' 55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:804:64: note: (near initialization for '__assertion.value') 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~ include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED' 570 | const struct assert_class __assertion = INITIALIZER; \ | ^~~~~~~~~~~ include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT' 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~~~~~~~~~~~~~ include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION' 1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG' 1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL' 55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:797:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion] 797 | if (!IS_ERR_OR_NULL(__ptr)) \ | ^~~~~ | | | int include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION' 1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG' 1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ lib/kunit/executor_test.c:60:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL' 60 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/linux/err.h:70:68: note: expected 'const void *' but argument is of type 'int' 70 | static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr) | ~~~~~~~~~~~~^~~ include/kunit/test.h:804:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion] 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~ include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED' 570 | const struct assert_class __assertion = INITIALIZER; \ | ^~~~~~~~~~~ include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT' 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~~~~~~~~~~~~~ include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION' 1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG' 1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ lib/kunit/executor_test.c:60:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL' 60 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:804:64: note: (near initialization for '__assertion.value') 804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \ | ^~~~~ include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED' 570 | const struct assert_class __assertion = INITIALIZER; \
vim +/suite_set +46 lib/kunit/executor_test.c
1d71307a6f94df Daniel Latypov 2021-04-20 42 e5857d396f35e5 Daniel Latypov 2022-07-09 43 static void filter_suites_test(struct kunit *test) 1d71307a6f94df Daniel Latypov 2021-04-20 44 { e5857d396f35e5 Daniel Latypov 2022-07-09 45 struct kunit_suite *subsuite[3] = {NULL, NULL}; e5857d396f35e5 Daniel Latypov 2022-07-09 @46 struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]}; e5857d396f35e5 Daniel Latypov 2022-07-09 @47 struct suite_set got; e5857d396f35e5 Daniel Latypov 2022-07-09 48 int err = 0; 1d71307a6f94df Daniel Latypov 2021-04-20 49 a127b154a8f231 Daniel Latypov 2021-09-14 50 subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases); a127b154a8f231 Daniel Latypov 2021-09-14 51 subsuite[1] = alloc_fake_suite(test, "suite2", dummy_test_cases); 1d71307a6f94df Daniel Latypov 2021-04-20 52 1d71307a6f94df Daniel Latypov 2021-04-20 53 /* Want: suite1, suite2, NULL -> suite2, NULL */ 529534e8cba3e6 Rae Moar 2023-07-25 54 got = kunit_filter_suites(&suite_set, "suite2", NULL, NULL, &err); e5857d396f35e5 Daniel Latypov 2022-07-09 55 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start); e5857d396f35e5 Daniel Latypov 2022-07-09 56 KUNIT_ASSERT_EQ(test, err, 0); e5857d396f35e5 Daniel Latypov 2022-07-09 57 kfree_at_end(test, got.start); 1d71307a6f94df Daniel Latypov 2021-04-20 58 a127b154a8f231 Daniel Latypov 2021-09-14 59 /* Validate we just have suite2 */ e5857d396f35e5 Daniel Latypov 2022-07-09 60 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]); e5857d396f35e5 Daniel Latypov 2022-07-09 61 KUNIT_EXPECT_STREQ(test, (const char *)got.start[0]->name, "suite2"); e5857d396f35e5 Daniel Latypov 2022-07-09 62 e5857d396f35e5 Daniel Latypov 2022-07-09 63 /* Contains one element (end is 1 past end) */ e5857d396f35e5 Daniel Latypov 2022-07-09 64 KUNIT_ASSERT_EQ(test, got.end - got.start, 1); a127b154a8f231 Daniel Latypov 2021-09-14 65 } a127b154a8f231 Daniel Latypov 2021-09-14 66
Results from kunit tests reported via dmesg may be interleaved with other kernel messages. When parsing dmesg for modular kunit results in real time, external tools, e.g., Intel GPU tools (IGT), may want to insert their own test name markers into dmesg at the start of each test, before any kernel message related to that test appears there, so existing upper level test result parsers have no doubt which test to blame for a specific kernel message. Unfortunately, kunit reports names of tests only at their completion (with the exeption of a not standarized "# Subtest: <name>" header above a test plan of each test suite or parametrized test).
External tools could be able to insert their own "start of the test" markers with test names included if they new those names in advance. Test names could be learned from a list if provided by a kunit test module.
There exists a feature of listing kunit tests without actually executing them, but it is now limited to configurations with the kunit module built in and covers only built-in tests, already available at boot time. Moreover, switching from list to normal mode requires reboot. If that feature was also available when kunit is built as a module, userspace could load the module with action=list parameter, load some kunit test modules they are interested in and learn about the list of tests provided by those modules, then unload them, reload the kunit module in normal mode and execute the tests with their lists already known.
Extend kunit module notifier initialization callback with a processing path for only listing the tests provided by a module if the kunit action parameter is set to "list" or "list_attr". For user convenience, make the kunit.action parameter visible in sysfs.
v2: Don't use a different format, use kunit_exec_list_tests() (Rae), - refresh on top of new attributes patches, handle newly introduced kunit.action=list_attr case (Rae).
Signed-off-by: Janusz Krzysztofik janusz.krzysztofik@linux.intel.com Cc: Rae Moar rmoar@google.com --- include/kunit/test.h | 2 ++ lib/kunit/executor.c | 28 +++++++++++++++++----------- lib/kunit/test.c | 18 +++++++++++++++--- 3 files changed, 34 insertions(+), 14 deletions(-)
diff --git a/include/kunit/test.h b/include/kunit/test.h index 3d002e6b252f2..6a338a3267ed5 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -309,6 +309,7 @@ static inline void kunit_set_failure(struct kunit *test) }
bool kunit_enabled(void); +const char *kunit_action(void);
void kunit_init_test(struct kunit *test, const char *name, char *log);
@@ -324,6 +325,7 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_ void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites);
void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin); +void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr);
#if IS_BUILTIN(CONFIG_KUNIT) int kunit_run_all_tests(void); diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index bd6f3b5dc47f7..b3878a34c35a5 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -13,22 +13,29 @@ extern struct kunit_suite * const __kunit_suites_start[]; extern struct kunit_suite * const __kunit_suites_end[];
+static char *action_param; + +module_param_named(action, action_param, charp, 0400); +MODULE_PARM_DESC(action, + "Changes KUnit executor behavior, valid values are:\n" + "<none>: run the tests like normal\n" + "'list' to list test names instead of running them.\n" + "'list_attr' to list test names and attributes instead of running them.\n"); + +const char *kunit_action(void) +{ + return action_param; +} + #if IS_BUILTIN(CONFIG_KUNIT)
static char *filter_glob_param; -static char *action_param; static char *filter_param; static char *filter_action_param;
module_param_named(filter_glob, filter_glob_param, charp, 0); MODULE_PARM_DESC(filter_glob, "Filter which KUnit test suites/tests run at boot-time, e.g. list* or list*.*del_test"); -module_param_named(action, action_param, charp, 0); -MODULE_PARM_DESC(action, - "Changes KUnit executor behavior, valid values are:\n" - "<none>: run the tests like normal\n" - "'list' to list test names instead of running them.\n" - "'list_attr' to list test names and attributes instead of running them.\n"); module_param_named(filter, filter_param, charp, 0); MODULE_PARM_DESC(filter, "Filter which KUnit test suites/tests run at boot-time using attributes, e.g. speed>slow"); @@ -228,10 +235,7 @@ void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin) __kunit_test_suites_init(suite_set->start, num_suites); }
-#if IS_BUILTIN(CONFIG_KUNIT) - -static void kunit_exec_list_tests(struct kunit_suite_set *suite_set, - bool include_attr) +void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr) { struct kunit_suite * const *suites; struct kunit_case *test_case; @@ -254,6 +258,8 @@ static void kunit_exec_list_tests(struct kunit_suite_set *suite_set, } }
+#if IS_BUILTIN(CONFIG_KUNIT) + int kunit_run_all_tests(void) { struct kunit_suite_set suite_set = { diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 8b2808068497f..5232a43737826 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -739,13 +739,25 @@ static void kunit_module_init(struct module *mod) struct kunit_suite_set suite_set = { mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites, }; - - kunit_exec_run_tests(&suite_set, false); + const char *action = kunit_action(); + + if (!action) + kunit_exec_run_tests(&suite_set, false); + else if (!strcmp(action, "list")) + kunit_exec_list_tests(&suite_set, false); + else if (!strcmp(action, "list_attr")) + kunit_exec_list_tests(&suite_set, true); + else + pr_err("kunit: unknown action '%s'\n", action); }
static void kunit_module_exit(struct module *mod) { - __kunit_test_suites_exit(mod->kunit_suites, mod->num_kunit_suites); + const char *action = kunit_action(); + + if (!action) + __kunit_test_suites_exit(mod->kunit_suites, + mod->num_kunit_suites); }
static int kunit_module_notify(struct notifier_block *nb, unsigned long val,
External tools, e.g., Intel GPU tools (IGT), support execution of individual selftests provided by kernel modules. That could be also applicable to kunit test modules if they provided test filtering. But test filtering is now possible only when kunit code is built into the kernel. Moreover, a filter can be specified only at boot time, then reboot is required each time a different filter is needed.
Build the test filtering code also when kunit is configured as a module, expose test filtering functions to other kunit source files, and use them in kunit module notifier callback functions. Userspace can then reload the kunit module with a value of the filter_glob parameter tuned to a specific kunit test module every time it wants to limit the scope of tests executed on that module load. Make the kunit.filter* parameters visible in sysfs for user convenience.
v4: Refresh on top of newly applied attributes patches and changes introdced by new versions of other patches submitted in series with this one. v3: Fix CONFIG_GLOB, required by filtering functions, not selected when building as a module. v2: Fix new name of a structure moved to kunit namespace not updated across all uses.
Signed-off-by: Janusz Krzysztofik janusz.krzysztofik@linux.intel.com --- include/kunit/test.h | 11 ++++++++ lib/kunit/Kconfig | 2 +- lib/kunit/executor.c | 63 ++++++++++++++++++++++++++------------------ lib/kunit/test.c | 20 ++++++++++++++ 4 files changed, 69 insertions(+), 27 deletions(-)
diff --git a/include/kunit/test.h b/include/kunit/test.h index 6a338a3267ed5..d33114097d0d0 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -310,6 +310,9 @@ static inline void kunit_set_failure(struct kunit *test)
bool kunit_enabled(void); const char *kunit_action(void); +const char *kunit_filter_glob(void); +char *kunit_filter(void); +char *kunit_filter_action(void);
void kunit_init_test(struct kunit *test, const char *name, char *log);
@@ -320,6 +323,14 @@ size_t kunit_suite_num_test_cases(struct kunit_suite *suite); unsigned int kunit_test_case_num(struct kunit_suite *suite, struct kunit_case *test_case);
+struct kunit_suite_set +kunit_filter_suites(const struct kunit_suite_set *suite_set, + const char *filter_glob, + char *filters, + char *filter_action, + int *err); +void kunit_free_suite_set(struct kunit_suite_set suite_set); + int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites);
void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites); diff --git a/lib/kunit/Kconfig b/lib/kunit/Kconfig index 626719b95badd..68a6daec0aef1 100644 --- a/lib/kunit/Kconfig +++ b/lib/kunit/Kconfig @@ -4,7 +4,7 @@
menuconfig KUNIT tristate "KUnit - Enable support for unit tests" - select GLOB if KUNIT=y + select GLOB help Enables support for kernel unit tests (KUnit), a lightweight unit testing and mocking framework for the Linux kernel. These tests are diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index b3878a34c35a5..a3e49c9deb6f0 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -27,24 +27,37 @@ const char *kunit_action(void) return action_param; }
-#if IS_BUILTIN(CONFIG_KUNIT) - static char *filter_glob_param; static char *filter_param; static char *filter_action_param;
-module_param_named(filter_glob, filter_glob_param, charp, 0); +module_param_named(filter_glob, filter_glob_param, charp, 0400); MODULE_PARM_DESC(filter_glob, "Filter which KUnit test suites/tests run at boot-time, e.g. list* or list*.*del_test"); -module_param_named(filter, filter_param, charp, 0); +module_param_named(filter, filter_param, charp, 0400); MODULE_PARM_DESC(filter, "Filter which KUnit test suites/tests run at boot-time using attributes, e.g. speed>slow"); -module_param_named(filter_action, filter_action_param, charp, 0); +module_param_named(filter_action, filter_action_param, charp, 0400); MODULE_PARM_DESC(filter_action, "Changes behavior of filtered tests using attributes, valid values are:\n" "<none>: do not run filtered tests as normal\n" "'skip': skip all filtered tests instead so tests will appear in output\n");
+const char *kunit_filter_glob(void) +{ + return filter_glob_param; +} + +char *kunit_filter(void) +{ + return filter_param; +} + +char *kunit_filter_action(void) +{ + return filter_action_param; +} + /* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */ struct kunit_glob_filter { char *suite_glob; @@ -108,10 +121,7 @@ kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_ return copy; }
-static char *kunit_shutdown; -core_param(kunit_shutdown, kunit_shutdown, charp, 0644); - -static void kunit_free_suite_set(struct kunit_suite_set suite_set) +void kunit_free_suite_set(struct kunit_suite_set suite_set) { struct kunit_suite * const *suites;
@@ -120,7 +130,7 @@ static void kunit_free_suite_set(struct kunit_suite_set suite_set) kfree(suite_set.start); }
-static struct kunit_suite_set +struct kunit_suite_set kunit_filter_suites(const struct kunit_suite_set *suite_set, const char *filter_glob, char *filters, @@ -207,22 +217,6 @@ kunit_filter_suites(const struct kunit_suite_set *suite_set, return filtered; }
-static void kunit_handle_shutdown(void) -{ - if (!kunit_shutdown) - return; - - if (!strcmp(kunit_shutdown, "poweroff")) - kernel_power_off(); - else if (!strcmp(kunit_shutdown, "halt")) - kernel_halt(); - else if (!strcmp(kunit_shutdown, "reboot")) - kernel_restart(NULL); - -} - -#endif - void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin) { size_t num_suites = suite_set->end - suite_set->start; @@ -260,6 +254,23 @@ void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr)
#if IS_BUILTIN(CONFIG_KUNIT)
+static char *kunit_shutdown; +core_param(kunit_shutdown, kunit_shutdown, charp, 0644); + +static void kunit_handle_shutdown(void) +{ + if (!kunit_shutdown) + return; + + if (!strcmp(kunit_shutdown, "poweroff")) + kernel_power_off(); + else if (!strcmp(kunit_shutdown, "halt")) + kernel_halt(); + else if (!strcmp(kunit_shutdown, "reboot")) + kernel_restart(NULL); + +} + int kunit_run_all_tests(void) { struct kunit_suite_set suite_set = { diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 5232a43737826..8162f2ea73b59 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -740,6 +740,20 @@ static void kunit_module_init(struct module *mod) mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites, }; const char *action = kunit_action(); + int err = 0; + + suite_set = kunit_filter_suites(&suite_set, + kunit_filter_glob() ?: "*.*", + kunit_filter(), kunit_filter_action(), + &err); + if (err) { + pr_err("kunit module: error filtering suites: %d\n", + err); + kfree(suite_set.start); + suite_set.start = NULL; + } + mod->kunit_suites = (struct kunit_suite **)suite_set.start; + mod->num_kunit_suites = suite_set.end - suite_set.start;
if (!action) kunit_exec_run_tests(&suite_set, false); @@ -753,11 +767,17 @@ static void kunit_module_init(struct module *mod)
static void kunit_module_exit(struct module *mod) { + struct kunit_suite_set suite_set = { + mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites, + }; const char *action = kunit_action();
if (!action) __kunit_test_suites_exit(mod->kunit_suites, mod->num_kunit_suites); + + if (suite_set.start) + kunit_free_suite_set(suite_set); }
static int kunit_module_notify(struct notifier_block *nb, unsigned long val,
linux-kselftest-mirror@lists.linaro.org
-
Janusz Krzysztofik -
kernel test robot