[PATCH 0/3] kunit: Expose some built-in features to modules

3 views
Skip to first unread message

Janusz Krzysztofik

unread,
Jul 28, 2023, 11:45:32 AM7/28/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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.

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 | 14 +++++++++++
lib/kunit/executor.c | 51 ++++++++++++++++++++++-----------------
lib/kunit/test.c | 57 +++++++++++++++++++++++++++++++++++++++++++-
3 files changed, 99 insertions(+), 23 deletions(-)

--
2.41.0

Janusz Krzysztofik

unread,
Jul 28, 2023, 11:45:33 AM7/28/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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.

[1] https://docs.kernel.org/dev-tools/ktap.html#

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
lib/kunit/test.c | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 84e4666555c94..a29ca1acc4d81 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -729,6 +729,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{
+ if (mod->num_kunit_suites > 0) {
+ pr_info("KTAP version 1\n");
+ pr_info("1..%d\n", mod->num_kunit_suites);
+ }
+
__kunit_test_suites_init(mod->kunit_suites, mod->num_kunit_suites);
}

--
2.41.0

Janusz Krzysztofik

unread,
Jul 28, 2023, 11:45:36 AM7/28/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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". For ease of use, submit the list in the
format of a standard KTAP report, with SKIP result from each test case,
giving "list mode" as the reason for skipping. For each test suite
provided by a kunit test module, make such list of its test cases also
available via kunit debugfs for the lifetime of the module. For user
convenience, make the kunit.action parameter visible in sysfs.

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 1 +
lib/kunit/executor.c | 19 +++++++++++++------
lib/kunit/test.c | 30 +++++++++++++++++++++++++++++-
3 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 23120d50499ef..6d693f21a4833 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -237,6 +237,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);

diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c
index 74982b83707ca..d1c0616569dfd 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -12,19 +12,26 @@
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");
+
+const char *kunit_action(void)
+{
+ return action_param;
+}
+
#if IS_BUILTIN(CONFIG_KUNIT)

static char *filter_glob_param;
-static char *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");

/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index a29ca1acc4d81..413d9fd364a8d 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -674,6 +674,27 @@ int kunit_run_tests(struct kunit_suite *suite)
}
EXPORT_SYMBOL_GPL(kunit_run_tests);

+static void kunit_list_suite(struct kunit_suite *suite)
+{
+ struct kunit_case *test_case;
+
+ kunit_print_suite_start(suite);
+
+ kunit_suite_for_each_test_case(suite, test_case) {
+ struct kunit test = { .param_value = NULL, .param_index = 0 };
+
+ kunit_init_test(&test, test_case->name, test_case->log);
+
+ kunit_print_ok_not_ok(&test, true, KUNIT_SKIPPED,
+ kunit_test_case_num(suite, test_case),
+ test_case->name, "list mode");
+ }
+
+ kunit_print_ok_not_ok((void *)suite, false, KUNIT_SKIPPED,
+ kunit_suite_counter++,
+ suite->name, "list mode");
+}
+
static void kunit_init_suite(struct kunit_suite *suite)
{
kunit_debugfs_create_suite(suite);
@@ -688,6 +709,7 @@ bool kunit_enabled(void)

int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites)
{
+ const char *action = kunit_action();
unsigned int i;

if (!kunit_enabled() && num_suites > 0) {
@@ -699,7 +721,13 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_

for (i = 0; i < num_suites; i++) {
kunit_init_suite(suites[i]);
- kunit_run_tests(suites[i]);
+
+ if (!action)
+ kunit_run_tests(suites[i]);
+ else if (!strcmp(action, "list"))
+ kunit_list_suite(suites[i]);
+ else
+ pr_err("kunit: unknown action '%s'\n", action);
}

static_branch_dec(&kunit_running);
--
2.41.0

Janusz Krzysztofik

unread,
Jul 28, 2023, 11:45:38 AM7/28/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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_glob parameter
visible in sysfs for user convenience.

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 13 +++++++++++++
lib/kunit/executor.c | 36 ++++++++++++++++++------------------
lib/kunit/test.c | 22 ++++++++++++++++++++++
3 files changed, 53 insertions(+), 18 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 6d693f21a4833..14ff12e72252a 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -190,6 +190,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.
*
@@ -238,6 +244,7 @@ static inline void kunit_set_failure(struct kunit *test)

bool kunit_enabled(void);
const char *kunit_action(void);
+const char *kunit_filter_glob(void);

void kunit_init_test(struct kunit *test, const char *name, char *log);

@@ -248,6 +255,12 @@ 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,
+ 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/executor.c b/lib/kunit/executor.c
index d1c0616569dfd..816e14f4fcb64 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -25,14 +25,17 @@ const char *kunit_action(void)
return action_param;
}

-#if IS_BUILTIN(CONFIG_KUNIT)
-
static char *filter_glob_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");

+const char *kunit_filter_glob(void)
+{
+ return filter_glob_param;
+}
+
/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
char *suite_glob;
@@ -96,16 +99,7 @@ kunit_filter_tests(const struct kunit_suite *const suite, const char *test_glob)
return copy;
}

-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)
+void kunit_free_suite_set(struct kunit_suite_set suite_set)
{
struct kunit_suite * const *suites;

@@ -114,13 +108,14 @@ 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,
- int *err)
+struct kunit_suite_set
+kunit_filter_suites(const struct kunit_suite_set *suite_set,
+ const char *filter_glob,
+ int *err)
{
int i;
struct kunit_suite **copy, *filtered_suite;
- struct suite_set filtered;
+ struct kunit_suite_set filtered;
struct kunit_test_filter filter;

const size_t max = suite_set->end - suite_set->start;
@@ -155,6 +150,11 @@ static struct suite_set kunit_filter_suites(const struct suite_set *suite_set,
return filtered;
}

+#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)
@@ -169,7 +169,7 @@ static void kunit_handle_shutdown(void)

}

-static void kunit_exec_run_tests(struct suite_set *suite_set)
+static void kunit_exec_run_tests(struct kunit_suite_set *suite_set)
{
size_t num_suites = suite_set->end - suite_set->start;

diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 413d9fd364a8d..bfc2f65bd1dae 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -757,6 +757,22 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{
+ struct kunit_suite_set suite_set = {
+ mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites,
+ };
+ int err = 0;
+
+ suite_set = kunit_filter_suites(&suite_set,
+ kunit_filter_glob() ?: "*.*", &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 (mod->num_kunit_suites > 0) {
pr_info("KTAP version 1\n");
pr_info("1..%d\n", mod->num_kunit_suites);
@@ -767,7 +783,13 @@ 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,
+ };
+
__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,
--
2.41.0

kernel test robot

unread,
Jul 28, 2023, 1:25:55 PM7/28/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, ll...@lists.linux.dev, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Hi Janusz,

kernel test robot noticed the following build warnings:

[auto build test WARNING on shuah-kselftest/kunit-fixes]
[also build test WARNING on linus/master v6.5-rc3]
[cannot apply to shuah-kselftest/kunit next-20230728]
[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#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230728-234736
base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git kunit-fixes
patch link: https://lore.kernel.org/r/20230728154419.1810177-8-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH 3/3] kunit: Allow kunit test modules to use test filtering
config: hexagon-randconfig-r045-20230728 (https://download.01.org/0day-ci/archive/20230729/202307290124...@intel.com/config)
compiler: clang version 17.0.0 (https://github.com/llvm/llvm-project.git 4a5ac14ee968ff0ad5d2cc1ffa0299048db4c88a)
reproduce: (https://download.01.org/0day-ci/archive/20230729/202307290124...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307290124...@intel.com/

All warnings (new ones prefixed by >>):

>> lib/kunit/executor.c:182:42: warning: declaration of 'struct suite_set' will not be visible outside of this function [-Wvisibility]
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
lib/kunit/executor.c:190:25: error: incomplete definition of type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ~~~~~~~~~^
lib/kunit/executor.c:182:42: note: forward declaration of 'struct suite_set'
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
lib/kunit/executor.c:190:52: error: incomplete definition of type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ~~~~~~~~~^
lib/kunit/executor.c:182:42: note: forward declaration of 'struct suite_set'
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
lib/kunit/executor.c:198:19: error: variable has incomplete type 'struct suite_set'
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^
lib/kunit/executor.c:198:9: note: forward declaration of 'struct suite_set'
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^
In file included from lib/kunit/executor.c:230:
lib/kunit/executor_test.c:45:19: error: variable has incomplete type 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:45:9: note: forward declaration of 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:46:19: error: variable has incomplete type 'struct suite_set'
46 | struct suite_set got;
| ^
lib/kunit/executor_test.c:45:9: note: forward declaration of 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:19: error: variable has incomplete type 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:9: note: forward declaration of 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:70:19: error: variable has incomplete type 'struct suite_set'
70 | struct suite_set got;
| ^
lib/kunit/executor_test.c:69:9: note: forward declaration of 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:96:19: error: variable has incomplete type 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:96:9: note: forward declaration of 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:97:19: error: variable has incomplete type 'struct suite_set'
97 | struct suite_set got;
| ^
lib/kunit/executor_test.c:96:9: note: forward declaration of 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:138:4: warning: cast from 'void (*)(const void *)' to 'kunit_action_t *' (aka 'void (*)(void *)') converts to incompatible function type [-Wcast-function-type-strict]
138 | (kunit_action_t *)kfree,
| ^~~~~~~~~~~~~~~~~~~~~~~
2 warnings and 9 errors generated.


vim +182 lib/kunit/executor.c

9c6b0e1d8993e4 Daniel Latypov 2021-09-30 181
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 @182 static void kunit_exec_list_tests(struct suite_set *suite_set)
aac35468ca20a3 Alan Maguire 2020-08-04 183 {
e5857d396f35e5 Daniel Latypov 2022-07-09 184 struct kunit_suite * const *suites;
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 185 struct kunit_case *test_case;
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 186
6c738b52316c58 Rae Moar 2022-11-23 187 /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */
6c738b52316c58 Rae Moar 2022-11-23 188 pr_info("KTAP version 1\n");
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 189
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 190 for (suites = suite_set->start; suites < suite_set->end; suites++)
e5857d396f35e5 Daniel Latypov 2022-07-09 191 kunit_suite_for_each_test_case((*suites), test_case) {
e5857d396f35e5 Daniel Latypov 2022-07-09 192 pr_info("%s.%s\n", (*suites)->name, test_case->name);
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 193 }
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 194 }
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 195

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

kernel test robot

unread,
Jul 28, 2023, 1:25:57 PM7/28/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Hi Janusz,

kernel test robot noticed the following build errors:

[auto build test ERROR on shuah-kselftest/kunit-fixes]
[also build test ERROR on linus/master v6.5-rc3]
[cannot apply to shuah-kselftest/kunit next-20230728]
[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#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230728-234736
base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git kunit-fixes
patch link: https://lore.kernel.org/r/20230728154419.1810177-8-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH 3/3] kunit: Allow kunit test modules to use test filtering
config: arc-randconfig-r043-20230728 (https://download.01.org/0day-ci/archive/20230729/202307290108...@intel.com/config)
compiler: arc-elf-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230729/202307290108...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307290108...@intel.com/

All error/warnings (new ones prefixed by >>):

>> lib/kunit/executor.c:182:42: warning: 'struct suite_set' declared inside parameter list will not be visible outside of this definition or declaration
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^~~~~~~~~
lib/kunit/executor.c: In function 'kunit_exec_list_tests':
>> lib/kunit/executor.c:190:32: error: invalid use of undefined type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ^~
lib/kunit/executor.c:190:59: error: invalid use of undefined type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ^~
lib/kunit/executor.c: In function 'kunit_run_all_tests':
>> lib/kunit/executor.c:198:16: error: variable 'suite_set' has initializer but incomplete type
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~
>> lib/kunit/executor.c:198:39: warning: excess elements in struct initializer
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~~~~~~~~~~~~
lib/kunit/executor.c:198:39: note: (near initialization for 'suite_set')
lib/kunit/executor.c:198:61: warning: excess elements in struct initializer
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~~~~~~~~~~
lib/kunit/executor.c:198:61: note: (near initialization for 'suite_set')
>> lib/kunit/executor.c:198:26: error: storage size of 'suite_set' isn't known
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~
lib/kunit/executor.c:198:26: warning: unused variable 'suite_set' [-Wunused-variable]
In file included from lib/kunit/executor.c:230:
lib/kunit/executor_test.c: In function 'filter_suites_test':
>> lib/kunit/executor_test.c:45:16: error: variable 'suite_set' has initializer but incomplete type
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
>> lib/kunit/executor_test.c:45:40: error: 'struct suite_set' has no member named 'start'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
>> lib/kunit/executor_test.c:45:48: warning: excess elements in struct initializer
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:45:48: note: (near initialization for 'suite_set')
>> lib/kunit/executor_test.c:45:59: error: 'struct suite_set' has no member named 'end'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:45:65: warning: excess elements in struct initializer
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:45:65: note: (near initialization for 'suite_set')
>> lib/kunit/executor_test.c:45:26: error: storage size of 'suite_set' isn't known
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
>> lib/kunit/executor_test.c:46:26: error: storage size of 'got' isn't known
46 | struct suite_set got;
| ^~~
In file included from lib/kunit/executor.c:4:
>> include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:54:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
54 | 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:744:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:54:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
54 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:744:64: note: (near initialization for '__assertion.value')
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:54:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
54 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:59:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
59 | 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:744:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:59:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
59 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:744:64: note: (near initialization for '__assertion.value')
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:59:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
59 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:46:26: warning: unused variable 'got' [-Wunused-variable]
46 | struct suite_set got;
| ^~~
lib/kunit/executor_test.c:45:26: warning: unused variable 'suite_set' [-Wunused-variable]
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c: In function 'filter_suites_test_glob_test':
lib/kunit/executor_test.c:69:16: error: variable 'suite_set' has initializer but incomplete type
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:69:40: error: 'struct suite_set' has no member named 'start'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
lib/kunit/executor_test.c:69:48: warning: excess elements in struct initializer
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:69:48: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:69:59: error: 'struct suite_set' has no member named 'end'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:69:65: warning: excess elements in struct initializer
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:65: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:69:26: error: storage size of 'suite_set' isn't known
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:70:26: error: storage size of 'got' isn't known
70 | struct suite_set got;
| ^~~
>> include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:78:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
78 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:744:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:78:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
78 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:744:64: note: (near initialization for '__assertion.value')
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:78:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
78 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:83:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
83 | 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:744:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:83:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
83 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:744:64: note: (near initialization for '__assertion.value')
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:83:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
83 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:88:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
88 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]->test_cases);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:744:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:88:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
88 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]->test_cases);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:744:64: note: (near initialization for '__assertion.value')
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:744:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
744 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:88:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
88 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]->test_cases);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:70:26: warning: unused variable 'got' [-Wunused-variable]
70 | struct suite_set got;
| ^~~
lib/kunit/executor_test.c:69:26: warning: unused variable 'suite_set' [-Wunused-variable]
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c: In function 'filter_suites_to_empty_test':
lib/kunit/executor_test.c:96:16: error: variable 'suite_set' has initializer but incomplete type
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:96:40: error: 'struct suite_set' has no member named 'start'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
lib/kunit/executor_test.c:96:48: warning: excess elements in struct initializer
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:96:48: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:96:59: error: 'struct suite_set' has no member named 'end'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:96:65: warning: excess elements in struct initializer
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:96:65: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:96:26: error: storage size of 'suite_set' isn't known
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:97:26: error: storage size of 'got' isn't known
97 | struct suite_set got;
| ^~~
include/kunit/test.h:628:55: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
628 | .left_value = __left, \
| ^~~~~~
include/kunit/test.h:510:49: note: in definition of macro '_KUNIT_FAILED'
510 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:627:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
627 | KUNIT_INIT_ASSERT(.text = &__text, \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:656:9: note: in expansion of macro 'KUNIT_BASE_BINARY_ASSERTION'
656 | KUNIT_BASE_BINARY_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:825:9: note: in expansion of macro 'KUNIT_BINARY_PTR_ASSERTION'
825 | KUNIT_BINARY_PTR_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:107:9: note: in expansion of macro 'KUNIT_EXPECT_PTR_EQ_MSG'
107 | KUNIT_EXPECT_PTR_EQ_MSG(test, got.start, got.end,
| ^~~~~~~~~~~~~~~~~~~~~~~


vim +190 lib/kunit/executor.c

9c6b0e1d8993e4 Daniel Latypov 2021-09-30 181
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 @182 static void kunit_exec_list_tests(struct suite_set *suite_set)
aac35468ca20a3 Alan Maguire 2020-08-04 183 {
e5857d396f35e5 Daniel Latypov 2022-07-09 184 struct kunit_suite * const *suites;
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 185 struct kunit_case *test_case;
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 186
6c738b52316c58 Rae Moar 2022-11-23 187 /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */
6c738b52316c58 Rae Moar 2022-11-23 188 pr_info("KTAP version 1\n");
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 189
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 @190 for (suites = suite_set->start; suites < suite_set->end; suites++)
e5857d396f35e5 Daniel Latypov 2022-07-09 191 kunit_suite_for_each_test_case((*suites), test_case) {
e5857d396f35e5 Daniel Latypov 2022-07-09 192 pr_info("%s.%s\n", (*suites)->name, test_case->name);
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 193 }
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 194 }
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 195
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 196 int kunit_run_all_tests(void)
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 197 {
e5857d396f35e5 Daniel Latypov 2022-07-09 @198 struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
1b11063d32d7e1 Daniel Latypov 2022-05-13 199 int err = 0;
d20a6ba5e3be5f Joe Fradley 2022-08-23 200 if (!kunit_enabled()) {
d20a6ba5e3be5f Joe Fradley 2022-08-23 201 pr_info("kunit: disabled\n");
d20a6ba5e3be5f Joe Fradley 2022-08-23 202 goto out;
d20a6ba5e3be5f Joe Fradley 2022-08-23 203 }
aac35468ca20a3 Alan Maguire 2020-08-04 204
a02353f491622e Daniel Latypov 2022-05-11 205 if (filter_glob_param) {
a02353f491622e Daniel Latypov 2022-05-11 206 suite_set = kunit_filter_suites(&suite_set, filter_glob_param, &err);
a02353f491622e Daniel Latypov 2022-05-11 207 if (err) {
a02353f491622e Daniel Latypov 2022-05-11 208 pr_err("kunit executor: error filtering suites: %d\n", err);
1b11063d32d7e1 Daniel Latypov 2022-05-13 209 goto out;
a02353f491622e Daniel Latypov 2022-05-11 210 }
a02353f491622e Daniel Latypov 2022-05-11 211 }
45dcbb6f5ef78b Brendan Higgins 2020-08-04 212
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 213 if (!action_param)
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 214 kunit_exec_run_tests(&suite_set);
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 215 else if (strcmp(action_param, "list") == 0)
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 216 kunit_exec_list_tests(&suite_set);
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 217 else
9c6b0e1d8993e4 Daniel Latypov 2021-09-30 218 pr_err("kunit executor: unknown action '%s'\n", action_param);
aac35468ca20a3 Alan Maguire 2020-08-04 219
e5857d396f35e5 Daniel Latypov 2022-07-09 220 if (filter_glob_param) { /* a copy was made of each suite */
a127b154a8f231 Daniel Latypov 2021-09-14 221 kunit_free_suite_set(suite_set);
5d31f71efcb6bc Daniel Latypov 2021-02-05 222 }
5d31f71efcb6bc Daniel Latypov 2021-02-05 223
1b11063d32d7e1 Daniel Latypov 2022-05-13 224 out:
1b11063d32d7e1 Daniel Latypov 2022-05-13 225 kunit_handle_shutdown();
1b11063d32d7e1 Daniel Latypov 2022-05-13 226 return err;
aac35468ca20a3 Alan Maguire 2020-08-04 227 }
aac35468ca20a3 Alan Maguire 2020-08-04 228

kernel test robot

unread,
Jul 28, 2023, 1:47:10 PM7/28/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, ll...@lists.linux.dev, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Hi Janusz,

kernel test robot noticed the following build errors:

[auto build test ERROR on shuah-kselftest/kunit-fixes]
[also build test ERROR on linus/master v6.5-rc3]
[cannot apply to shuah-kselftest/kunit next-20230728]
[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#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230728-234736
base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git kunit-fixes
patch link: https://lore.kernel.org/r/20230728154419.1810177-8-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH 3/3] kunit: Allow kunit test modules to use test filtering
config: mips-randconfig-r002-20230728 (https://download.01.org/0day-ci/archive/20230729/202307290100...@intel.com/config)
compiler: clang version 17.0.0 (https://github.com/llvm/llvm-project.git 4a5ac14ee968ff0ad5d2cc1ffa0299048db4c88a)
reproduce: (https://download.01.org/0day-ci/archive/20230729/202307290100...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307290100...@intel.com/

All error/warnings (new ones prefixed by >>):

>> lib/kunit/executor.c:182:42: warning: declaration of 'struct suite_set' will not be visible outside of this function [-Wvisibility]
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
>> lib/kunit/executor.c:190:25: error: incomplete definition of type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ~~~~~~~~~^
lib/kunit/executor.c:182:42: note: forward declaration of 'struct suite_set'
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
lib/kunit/executor.c:190:52: error: incomplete definition of type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ~~~~~~~~~^
lib/kunit/executor.c:182:42: note: forward declaration of 'struct suite_set'
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^
>> lib/kunit/executor.c:198:19: error: variable has incomplete type 'struct suite_set'
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^
lib/kunit/executor.c:198:9: note: forward declaration of 'struct suite_set'
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^
In file included from lib/kunit/executor.c:230:
>> lib/kunit/executor_test.c:45:19: error: variable has incomplete type 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:45:9: note: forward declaration of 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:46:19: error: variable has incomplete type 'struct suite_set'
46 | struct suite_set got;
| ^
lib/kunit/executor_test.c:45:9: note: forward declaration of 'struct suite_set'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:19: error: variable has incomplete type 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:9: note: forward declaration of 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:70:19: error: variable has incomplete type 'struct suite_set'
70 | struct suite_set got;
| ^
lib/kunit/executor_test.c:69:9: note: forward declaration of 'struct suite_set'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:96:19: error: variable has incomplete type 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:96:9: note: forward declaration of 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:97:19: error: variable has incomplete type 'struct suite_set'
97 | struct suite_set got;
| ^
lib/kunit/executor_test.c:96:9: note: forward declaration of 'struct suite_set'
96 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:138:4: warning: cast from 'void (*)(const void *)' to 'kunit_action_t *' (aka 'void (*)(void *)') converts to incompatible function type [-Wcast-function-type-strict]
138 | (kunit_action_t *)kfree,
| ^~~~~~~~~~~~~~~~~~~~~~~
2 warnings and 9 errors generated.


kernel test robot

unread,
Jul 28, 2023, 2:49:51 PM7/28/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Hi Janusz,

kernel test robot noticed the following build warnings:

[auto build test WARNING on shuah-kselftest/kunit-fixes]
[also build test WARNING on linus/master v6.5-rc3]
[cannot apply to shuah-kselftest/kunit next-20230728]
[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#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230728-234736
base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git kunit-fixes
patch link: https://lore.kernel.org/r/20230728154419.1810177-8-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH 3/3] kunit: Allow kunit test modules to use test filtering
config: i386-allyesconfig (https://download.01.org/0day-ci/archive/20230729/202307290255...@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce: (https://download.01.org/0day-ci/archive/20230729/202307290255...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307290255...@intel.com/

All warnings (new ones prefixed by >>):

lib/kunit/executor.c:182:42: warning: 'struct suite_set' declared inside parameter list will not be visible outside of this definition or declaration
182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
| ^~~~~~~~~
lib/kunit/executor.c: In function 'kunit_exec_list_tests':
lib/kunit/executor.c:190:32: error: invalid use of undefined type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ^~
lib/kunit/executor.c:190:59: error: invalid use of undefined type 'struct suite_set'
190 | for (suites = suite_set->start; suites < suite_set->end; suites++)
| ^~
lib/kunit/executor.c: In function 'kunit_run_all_tests':
lib/kunit/executor.c:198:16: error: variable 'suite_set' has initializer but incomplete type
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~
lib/kunit/executor.c:198:39: warning: excess elements in struct initializer
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~~~~~~~~~~~~
lib/kunit/executor.c:198:39: note: (near initialization for 'suite_set')
lib/kunit/executor.c:198:61: warning: excess elements in struct initializer
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~~~~~~~~~~
lib/kunit/executor.c:198:61: note: (near initialization for 'suite_set')
lib/kunit/executor.c:198:26: error: storage size of 'suite_set' isn't known
198 | struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
| ^~~~~~~~~
>> lib/kunit/executor.c:198:26: warning: unused variable 'suite_set' [-Wunused-variable]
In file included from lib/kunit/executor.c:230:
lib/kunit/executor_test.c: In function 'filter_suites_test':
lib/kunit/executor_test.c:45:16: error: variable 'suite_set' has initializer but incomplete type
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:45:40: error: 'struct suite_set' has no member named 'start'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
lib/kunit/executor_test.c:45:48: warning: excess elements in struct initializer
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:45:48: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:45:59: error: 'struct suite_set' has no member named 'end'
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:45:65: warning: excess elements in struct initializer
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:45:65: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:45:26: error: storage size of 'suite_set' isn't known
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:46:26: error: storage size of 'got' isn't known
46 | struct suite_set got;
| ^~~
In file included from lib/kunit/executor.c:4:
include/kunit/test.h:737:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
737 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1418:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1418 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1415:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1415 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:54:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
54 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
In file included from arch/x86/include/asm/processor.h:36,
from arch/x86/include/asm/cpufeature.h:5,
from arch/x86/include/asm/thread_info.h:53,
from include/linux/thread_info.h:60,
from arch/x86/include/asm/preempt.h:9,
from include/linux/preempt.h:79,
from include/linux/smp.h:110,
from include/linux/lockdep.h:14,
from include/linux/mutex.h:17,
from include/linux/notifier.h:14,
45 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c: In function 'filter_suites_test_glob_test':
lib/kunit/executor_test.c:69:16: error: variable 'suite_set' has initializer but incomplete type
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
lib/kunit/executor_test.c:69:40: error: 'struct suite_set' has no member named 'start'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
lib/kunit/executor_test.c:69:48: warning: excess elements in struct initializer
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:69:48: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:69:59: error: 'struct suite_set' has no member named 'end'
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:69:65: warning: excess elements in struct initializer
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:69:65: note: (near initialization for 'suite_set')
lib/kunit/executor_test.c:69:26: error: storage size of 'suite_set' isn't known
69 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
vim +/suite_set +198 lib/kunit/executor.c

9c6b0e1d8993e47 Daniel Latypov 2021-09-30 195
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 196 int kunit_run_all_tests(void)
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 197 {
e5857d396f35e59 Daniel Latypov 2022-07-09 @198 struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
1b11063d32d7e11 Daniel Latypov 2022-05-13 199 int err = 0;
d20a6ba5e3be5f8 Joe Fradley 2022-08-23 200 if (!kunit_enabled()) {
d20a6ba5e3be5f8 Joe Fradley 2022-08-23 201 pr_info("kunit: disabled\n");
d20a6ba5e3be5f8 Joe Fradley 2022-08-23 202 goto out;
d20a6ba5e3be5f8 Joe Fradley 2022-08-23 203 }
aac35468ca20a3a Alan Maguire 2020-08-04 204
a02353f491622e4 Daniel Latypov 2022-05-11 205 if (filter_glob_param) {
a02353f491622e4 Daniel Latypov 2022-05-11 206 suite_set = kunit_filter_suites(&suite_set, filter_glob_param, &err);
a02353f491622e4 Daniel Latypov 2022-05-11 207 if (err) {
a02353f491622e4 Daniel Latypov 2022-05-11 208 pr_err("kunit executor: error filtering suites: %d\n", err);
1b11063d32d7e11 Daniel Latypov 2022-05-13 209 goto out;
a02353f491622e4 Daniel Latypov 2022-05-11 210 }
a02353f491622e4 Daniel Latypov 2022-05-11 211 }
45dcbb6f5ef78b0 Brendan Higgins 2020-08-04 212
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 213 if (!action_param)
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 214 kunit_exec_run_tests(&suite_set);
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 215 else if (strcmp(action_param, "list") == 0)
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 216 kunit_exec_list_tests(&suite_set);
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 217 else
9c6b0e1d8993e47 Daniel Latypov 2021-09-30 218 pr_err("kunit executor: unknown action '%s'\n", action_param);
aac35468ca20a3a Alan Maguire 2020-08-04 219
e5857d396f35e59 Daniel Latypov 2022-07-09 220 if (filter_glob_param) { /* a copy was made of each suite */
a127b154a8f2317 Daniel Latypov 2021-09-14 221 kunit_free_suite_set(suite_set);
5d31f71efcb6bce Daniel Latypov 2021-02-05 222 }
5d31f71efcb6bce Daniel Latypov 2021-02-05 223
1b11063d32d7e11 Daniel Latypov 2022-05-13 224 out:
1b11063d32d7e11 Daniel Latypov 2022-05-13 225 kunit_handle_shutdown();
1b11063d32d7e11 Daniel Latypov 2022-05-13 226 return err;
aac35468ca20a3a Alan Maguire 2020-08-04 227 }
aac35468ca20a3a Alan Maguire 2020-08-04 228

Janusz Krzysztofik

unread,
Jul 29, 2023, 11:58:09 AM7/29/23
to Brendan Higgins, David Gow, kernel test robot, ll...@lists.linux.dev, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
On Friday, 28 July 2023 19:24:55 CEST kernel test robot wrote:
> >> lib/kunit/executor.c:182:42: warning: declaration of 'struct suite_set'
will not be visible outside of this function [-Wvisibility]
> 182 | static void kunit_exec_list_tests(struct suite_set *suite_set)
> | ^

I've apparently broken this patch while reordering patches in the series.
Sorry for submitting that untested. Please expect v2 soon.

Thanks,
Janusz


Janusz Krzysztofik

unread,
Jul 31, 2023, 2:16:51 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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.

[1] https://docs.kernel.org/dev-tools/ktap.html#

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
lib/kunit/test.c | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 84e4666555c94..a29ca1acc4d81 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -729,6 +729,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{

Janusz Krzysztofik

unread,
Jul 31, 2023, 2:16:52 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 1 +
lib/kunit/executor.c | 19 +++++++++++++------
lib/kunit/test.c | 30 +++++++++++++++++++++++++++++-
3 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 23120d50499ef..6d693f21a4833 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -237,6 +237,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);

diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c
index 74982b83707ca..d1c0616569dfd 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -12,19 +12,26 @@
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");
+
+const char *kunit_action(void)
+{
+ return action_param;
+}
+
#if IS_BUILTIN(CONFIG_KUNIT)

static char *filter_glob_param;
-static char *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");

/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index a29ca1acc4d81..413d9fd364a8d 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites)
{
+ const char *action = kunit_action();
unsigned int i;

if (!kunit_enabled() && num_suites > 0) {
@@ -699,7 +721,13 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_

for (i = 0; i < num_suites; i++) {
kunit_init_suite(suites[i]);
- kunit_run_tests(suites[i]);
+
+ if (!action)
+ kunit_run_tests(suites[i]);
+ else if (!strcmp(action, "list"))
+ kunit_list_suite(suites[i]);
+ else
+ pr_err("kunit: unknown action '%s'\n", action);
}

static_branch_dec(&kunit_running);
--
2.41.0

Janusz Krzysztofik

unread,
Jul 31, 2023, 2:16:52 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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.

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 | 14 +++++++++++
lib/kunit/executor.c | 57 +++++++++++++++++++++++++-------------------
lib/kunit/test.c | 57 +++++++++++++++++++++++++++++++++++++++++++-
3 files changed, 103 insertions(+), 25 deletions(-)

--
2.41.0

Janusz Krzysztofik

unread,
Jul 31, 2023, 2:16:58 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
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_glob parameter
visible in sysfs for user convenience.

v2: Fix new name of a structure moved to kunit namespace not updated
across all uses.

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 13 +++++++++++++
lib/kunit/executor.c | 42 ++++++++++++++++++++++--------------------
lib/kunit/test.c | 22 ++++++++++++++++++++++
3 files changed, 57 insertions(+), 20 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 6d693f21a4833..14ff12e72252a 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -190,6 +190,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.
*
@@ -238,6 +244,7 @@ static inline void kunit_set_failure(struct kunit *test)

bool kunit_enabled(void);
const char *kunit_action(void);
+const char *kunit_filter_glob(void);

void kunit_init_test(struct kunit *test, const char *name, char *log);

@@ -248,6 +255,12 @@ 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,
+ 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/executor.c b/lib/kunit/executor.c
index d1c0616569dfd..49fe40cc8f1af 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -25,14 +25,17 @@ const char *kunit_action(void)
return action_param;
}

-#if IS_BUILTIN(CONFIG_KUNIT)
-
static char *filter_glob_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");

+const char *kunit_filter_glob(void)
+{
+ return filter_glob_param;
+}
+
/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
char *suite_glob;
@@ -96,16 +99,7 @@ kunit_filter_tests(const struct kunit_suite *const suite, const char *test_glob)
return copy;
}

-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)
+void kunit_free_suite_set(struct kunit_suite_set suite_set)
{
struct kunit_suite * const *suites;

@@ -179,7 +179,7 @@ static void kunit_exec_run_tests(struct suite_set *suite_set)
__kunit_test_suites_init(suite_set->start, num_suites);
}

-static void kunit_exec_list_tests(struct suite_set *suite_set)
+static void kunit_exec_list_tests(struct kunit_suite_set *suite_set)
{
struct kunit_suite * const *suites;
struct kunit_case *test_case;
@@ -195,7 +195,9 @@ static void kunit_exec_list_tests(struct suite_set *suite_set)

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");
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 413d9fd364a8d..bfc2f65bd1dae 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -757,6 +757,22 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{
+ struct kunit_suite_set suite_set = {
+ mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites,
+ };
+ int err = 0;
+
+ suite_set = kunit_filter_suites(&suite_set,
+ kunit_filter_glob() ?: "*.*", &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 (mod->num_kunit_suites > 0) {
pr_info("KTAP version 1\n");
pr_info("1..%d\n", mod->num_kunit_suites);

kernel test robot

unread,
Jul 31, 2023, 4:39:19 AM7/31/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, ll...@lists.linux.dev, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Hi Janusz,

kernel test robot noticed the following build errors:

[auto build test ERROR on shuah-kselftest/kunit-fixes]
[also build test ERROR on linus/master v6.5-rc4]
[cannot apply to shuah-kselftest/kunit next-20230731]
[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#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230731-141908
base: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git kunit-fixes
patch link: https://lore.kernel.org/r/20230731054552.2145292-8-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH v2 3/3] kunit: Allow kunit test modules to use test filtering
config: hexagon-randconfig-r041-20230731 (https://download.01.org/0day-ci/archive/20230731/202307311645...@intel.com/config)
compiler: clang version 17.0.0 (https://github.com/llvm/llvm-project.git 4a5ac14ee968ff0ad5d2cc1ffa0299048db4c88a)
reproduce: (https://download.01.org/0day-ci/archive/20230731/202307311645...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307311645...@intel.com/

All errors (new ones prefixed by >>, old ones prefixed by <<):

WARNING: modpost: missing MODULE_DESCRIPTION() in vmlinux.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/locking/locktorture.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/locking/test-ww_mutex.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/rcu/rcutorture.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/rcu/refscale.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/torture.o
WARNING: modpost: missing MODULE_DESCRIPTION() in kernel/scftorture.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp737.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp855.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp857.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp860.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp874.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp932.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_euc-jp.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_cp950.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_iso8859-3.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_iso8859-5.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_iso8859-9.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_koi8-u.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/nls_koi8-ru.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/mac-gaelic.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/mac-romanian.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nls/mac-roman.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/binfmt_script.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/autofs/autofs4.o
WARNING: modpost: missing MODULE_DESCRIPTION() in security/keys/trusted-keys/trusted.o
WARNING: modpost: missing MODULE_DESCRIPTION() in lib/kunit/kunit.o
WARNING: modpost: missing MODULE_DESCRIPTION() in lib/kunit/kunit-example-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in lib/math/prime_numbers.o
WARNING: modpost: missing MODULE_DESCRIPTION() in lib/zlib_deflate/zlib_deflate.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/gpio/gpio-gw-pld.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/gpio/gpio-pcf857x.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/video/backlight/platform_lcd.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/video/backlight/rt4831-backlight.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/video/fbdev/vfb.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/dma/qcom/hdma_mgmt.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/dma/qcom/hdma.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/da9121-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/rt4831-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/tps6286x-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/tty/serial/8250/8250_base.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/tty/serial/serial_mctrl_gpio.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/tty/ttynull.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/tty/goldfish.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/char/ttyprintk.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/char/ppdev.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/gpu/drm/bridge/lontium-lt9611uxc.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/gpu/drm/bridge/sil-sii8620.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/gpu/drm/bridge/sii9234.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/base/regmap/regmap-kunit.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/base/regmap/regmap-ram.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/base/regmap/regmap-raw-ram.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/base/regmap/regmap-slimbus.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mfd/ssbi.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mfd/rt4831.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mfd/qcom-pm8008.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/auxdisplay/line-display.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/hwmon/mr75203.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mmc/core/mmc_core.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mmc/core/pwrseq_emmc.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mmc/core/sdio_uart.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/crypto/atmel-sha204a.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/goldfish/goldfish_pipe.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/devfreq/governor_simpleondemand.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/devfreq/governor_userspace.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/hwtracing/intel_th/intel_th_msu_sink.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/parport/parport.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mtd/chips/cfi_util.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/mtd/maps/map_funcs.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pcmcia/pcmcia_rsrc.o
>> ERROR: modpost: "glob_match" [lib/kunit/kunit.ko] undefined!

Janusz Krzysztofik

unread,
Jul 31, 2023, 8:08:00 AM7/31/23
to Brendan Higgins, David Gow, kernel test robot, ll...@lists.linux.dev, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
On Monday, 31 July 2023 10:39:03 CEST kernel test robot wrote:
> >> ERROR: modpost: "glob_match" [lib/kunit/kunit.ko] undefined!

Caused by CONFIG_GLOB possibly not selected when building kunit as a module
(it was selected via another, unrelated setting in my test .config).

Please expect v3 with that fixed.

Thanks,
Janusz


Janusz Krzysztofik

unread,
Jul 31, 2023, 10:12:44 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
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.

v3: Fix CONFIG_GLOB, required by filtering fuctions, 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 | 14 +++++++++++
lib/kunit/Kconfig | 2 +-
lib/kunit/executor.c | 57 +++++++++++++++++++++++++-------------------
lib/kunit/test.c | 57 +++++++++++++++++++++++++++++++++++++++++++-
4 files changed, 104 insertions(+), 26 deletions(-)

--
2.41.0

Janusz Krzysztofik

unread,
Jul 31, 2023, 10:12:46 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
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.

[1] https://docs.kernel.org/dev-tools/ktap.html#

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
lib/kunit/test.c | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 84e4666555c94..a29ca1acc4d81 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -729,6 +729,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{

Janusz Krzysztofik

unread,
Jul 31, 2023, 10:12:49 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
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". For ease of use, submit the list in the
format of a standard KTAP report, with SKIP result from each test case,
giving "list mode" as the reason for skipping. For each test suite
provided by a kunit test module, make such list of its test cases also
available via kunit debugfs for the lifetime of the module. For user
convenience, make the kunit.action parameter visible in sysfs.

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 1 +
lib/kunit/executor.c | 19 +++++++++++++------
lib/kunit/test.c | 30 +++++++++++++++++++++++++++++-
3 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 23120d50499ef..6d693f21a4833 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -237,6 +237,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);

diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c
index 74982b83707ca..d1c0616569dfd 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -12,19 +12,26 @@
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");
+
+const char *kunit_action(void)
+{
+ return action_param;
+}
+
#if IS_BUILTIN(CONFIG_KUNIT)

static char *filter_glob_param;
-static char *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");

/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index a29ca1acc4d81..413d9fd364a8d 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites)

Janusz Krzysztofik

unread,
Jul 31, 2023, 10:12:52 AM7/31/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
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_glob parameter
visible in sysfs for user convenience.

v3: Fix CONFIG_GLOB, required by filtering fuctions, 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.kr...@linux.intel.com>
---
include/kunit/test.h | 13 +++++++++++++
lib/kunit/Kconfig | 2 +-
lib/kunit/executor.c | 42 ++++++++++++++++++++++--------------------
lib/kunit/test.c | 22 ++++++++++++++++++++++
4 files changed, 58 insertions(+), 21 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 6d693f21a4833..14ff12e72252a 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -190,6 +190,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.
*
@@ -238,6 +244,7 @@ static inline void kunit_set_failure(struct kunit *test)

bool kunit_enabled(void);
const char *kunit_action(void);
+const char *kunit_filter_glob(void);

void kunit_init_test(struct kunit *test, const char *name, char *log);

@@ -248,6 +255,12 @@ 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,
+ 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 d1c0616569dfd..49fe40cc8f1af 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -25,14 +25,17 @@ const char *kunit_action(void)
return action_param;
}

-#if IS_BUILTIN(CONFIG_KUNIT)
-
static char *filter_glob_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");

+const char *kunit_filter_glob(void)
+{
+ return filter_glob_param;
+}
+
/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
struct kunit_test_filter {
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 413d9fd364a8d..bfc2f65bd1dae 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -757,6 +757,22 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{
+ struct kunit_suite_set suite_set = {
+ mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites,
+ };
+ int err = 0;
+
+ suite_set = kunit_filter_suites(&suite_set,
+ kunit_filter_glob() ?: "*.*", &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 (mod->num_kunit_suites > 0) {
pr_info("KTAP version 1\n");
pr_info("1..%d\n", mod->num_kunit_suites);

Mauro Carvalho Chehab

unread,
Aug 1, 2023, 9:17:19 AM8/1/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Em Mon, 31 Jul 2023 16:10:23 +0200
Janusz Krzysztofik <janusz.kr...@linux.intel.com> escreveu:
IMO, the best would be instead to export kunit_exec_run_tests() and
use it here too.

Except for the nit, LGTM.


Thanks,
Mauro

Mauro Carvalho Chehab

unread,
Aug 1, 2023, 9:21:28 AM8/1/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
Em Mon, 31 Jul 2023 16:10:24 +0200
Janusz Krzysztofik <janusz.kr...@linux.intel.com> escreveu:
It sounds interesting to have a modprobe option to just list the
tests without excecuting.
Help message sounded confusing. What about adding a boolean modprobe
parameter, like "list_tests"?
The remaining code LGTM.


Thanks,
Mauro

Janusz Krzysztofik

unread,
Aug 1, 2023, 11:14:02 AM8/1/23
to Mauro Carvalho Chehab, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
Hi Mauro,

Thanks for review.
I was considering a similar approach, i.e., moving those two pr_info() lines
from built-in only kunit_exec_run_tests() to __kunit_test_suites_init() which
is common to both built-in and modular paths, but please note that with kunit
built in, an empty test plan "1..0" is now reported on boot, while we don't
want similar reports to appear on loading modules that don't provide any kunit
tests. Then, inside either your exported kunit_exec_run_tests() or my
__kunit_test_suites_init(), we would have to check somehow if it has been
called from a module notifier initialization callback, and that seemed to me
too much complicated and less clean than what I've proposed: keep using
unmodified kunit_exec_run_tests() in built-in and updated kunit_module_init()
in modular processing path.
Dropping the empty "1..0" test plan from boot messages would mean an ABI
change, I believe, which I'd rather avoid adding to the scope of this patch as
not required.

Thanks,
Janusz

Janusz Krzysztofik

unread,
Aug 1, 2023, 11:18:21 AM8/1/23
to Mauro Carvalho Chehab, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
Hi Mauro,
While the above lines may look like a new code that introduced a new module
parameter at a first glance, please note that's a chunk of the existing code,
only moved out of #if IS_BUILTIN(CONFIG_KUNIT) section below.
Having that clarified, do you mean adding a new module parameter that
effectively replicates the function of the existing built-in only action=list
parameter but is available also for modular kunit? Or do you mean replacing
the existing action=list parameter completely with the new one? If the latter
then that would mean a change to the existing ABI, and I'd rather not add it
to the scope of this change as not required.

Thanks,
Janusz

>

Rae Moar

unread,
Aug 3, 2023, 4:57:56 PM8/3/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
On Mon, Jul 31, 2023 at 10:12 AM Janusz Krzysztofik
<janusz.kr...@linux.intel.com> wrote:
>
> 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.
>
> [1] https://docs.kernel.org/dev-tools/ktap.html#
>
> Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
> ---

Hi!

I think this is a really great idea to improve the KTAP compatibility
for module output. I do agree with Mauro and I wonder if this could be
replaced with using kunit_exec_run_tests. However, if the output of
1..0 for a module with no KUnit tests run is not wanted, I am ok with
this change as is.

LGTM.

Tested-by: Rae Moar <rm...@google.com>

-Rae

> lib/kunit/test.c | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/lib/kunit/test.c b/lib/kunit/test.c
> index 84e4666555c94..a29ca1acc4d81 100644
> --- a/lib/kunit/test.c
> +++ b/lib/kunit/test.c
> @@ -729,6 +729,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
> #ifdef CONFIG_MODULES
> static void kunit_module_init(struct module *mod)
> {
> + if (mod->num_kunit_suites > 0) {
> + pr_info("KTAP version 1\n");
> + pr_info("1..%d\n", mod->num_kunit_suites);
> + }
> +
> __kunit_test_suites_init(mod->kunit_suites, mod->num_kunit_suites);
> }
>
> --
> 2.41.0
>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20230731141021.2854827-6-janusz.krzysztofik%40linux.intel.com.

Rae Moar

unread,
Aug 3, 2023, 5:28:09 PM8/3/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
On Mon, Jul 31, 2023 at 10:12 AM Janusz Krzysztofik
<janusz.kr...@linux.intel.com> wrote:
>
Hello!

Great idea to expose this feature to modules. But just letting you
know this patch didn't apply cleanly for me onto the current
kselftest/kunit branch. So this may need rebasing.
I have some reservations about using a different format to the current
format output when using the action_param=list option. Is it possible
to export and use the kunit_exec_list_tests() method instead? This
would allow for there to be only one method to control the format for
this option.

Also just a note that the new attributes patches introduce the
action_param.list_attr option, which would then need to be accounted
for here and maybe change some of this formatting.

Thanks!
Rae

> static void kunit_init_suite(struct kunit_suite *suite)
> {
> kunit_debugfs_create_suite(suite);
> @@ -688,6 +709,7 @@ bool kunit_enabled(void)
>
> int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites)
> {
> + const char *action = kunit_action();
> unsigned int i;
>
> if (!kunit_enabled() && num_suites > 0) {
> @@ -699,7 +721,13 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_
>
> for (i = 0; i < num_suites; i++) {
> kunit_init_suite(suites[i]);
> - kunit_run_tests(suites[i]);
> +
> + if (!action)
> + kunit_run_tests(suites[i]);
> + else if (!strcmp(action, "list"))
> + kunit_list_suite(suites[i]);
> + else
> + pr_err("kunit: unknown action '%s'\n", action);
> }
>
> static_branch_dec(&kunit_running);
> --
> 2.41.0
>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20230731141021.2854827-7-janusz.krzysztofik%40linux.intel.com.

Janusz Krzysztofik

unread,
Aug 4, 2023, 5:33:34 AM8/4/23
to Rae Moar, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Janusz Krzysztofik
Hi Rae,
I do believe we really don't want that. As soon as kunit framework registers
its notifier callbacks, those callbacks are executed by generic module
handling code on load / unload of every module, not only those providing kunit
tests. If our module initialization callback called unmodified
kunit_exec_run_tests() that deliberately prints these two lines
unconditionally:

KTAP version 1
1..n

then there would be a lot of unnecessary noise.

To avoid that noise, I decided to teach the callback itself to display the
header with the number of test suits provided by the module before processing
them if there is at least one, and be silent otherwise. But since both you
and Mauro think that kunit_exec_run_tests() should be reused, I can do that by
moving that logic to kunit_exec_run_tests() and passing an additional flag
that controls that logic from kunit_module_init() to kunit_exec_run_tests().
Would that approach be more acceptable?

> I am ok with
> this change as is.
>
> LGTM.
>
> Tested-by: Rae Moar <rm...@google.com>

Thank you for testing.

Janusz

Janusz Krzysztofik

unread,
Aug 4, 2023, 6:55:26 PM8/4/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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
--
2.41.0

Janusz Krzysztofik

unread,
Aug 4, 2023, 6:55:27 PM8/4/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.
Cc: Mauro Carvalho Chehab <mch...@kernel.org>
Cc: Rae Moar <rm...@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)
--
2.41.0

Janusz Krzysztofik

unread,
Aug 4, 2023, 6:55:29 PM8/4/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.kr...@linux.intel.com>
Cc: Rae Moar <rm...@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);

Janusz Krzysztofik

unread,
Aug 4, 2023, 6:55:39 PM8/4/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.kr...@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);
}

kernel test robot

unread,
Aug 4, 2023, 9:06:10 PM8/4/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, oe-kbu...@lists.linux.dev, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, linux...@vger.kernel.org, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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-Report-the-count-of-test-suites-in-a-module/20230805-065602
base: 5a175d369c702ce08c9feb630125c9fc7a9e1370
patch link: https://lore.kernel.org/r/20230804225220.8005-6-janusz.krzysztofik%40linux.intel.com
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...@intel.com/config)
compiler: loongarch64-linux-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230805/202308050802...@intel.com/reproduce)

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 <l...@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202308050802...@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

Janusz Krzysztofik

unread,
Aug 7, 2023, 6:28:35 AM8/7/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.

v5: Fix new name of a structure moved to kunit namespace not updated in
executor_test functions (l...@intel.com),
- refresh on tpp of attributes filtering fix.
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 (l...@intel.com).
v2: Fix new name of a structure moved to kunit namespace not updated
across all uses (l...@intel.com).

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/executor_test.c | 36 ++++++++----
lib/kunit/test.c | 37 +++++++++++-
5 files changed, 149 insertions(+), 62 deletions(-)


base-commit: 1c9fd080dffe5e5ad763527fbc2aa3f6f8c653e9
--
2.41.0

Janusz Krzysztofik

unread,
Aug 7, 2023, 6:28:38 AM8/7/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.

v3: Fix new name of a structure moved to kunit namespace not updated in
executor_test functions (l...@intel.com).
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.kr...@linux.intel.com>
Cc: Mauro Carvalho Chehab <mch...@kernel.org>
Cc: Rae Moar <rm...@google.com>
---
include/kunit/test.h | 8 ++++++++
lib/kunit/executor.c | 42 +++++++++++++++++++++------------------
lib/kunit/executor_test.c | 36 ++++++++++++++++++++++-----------
lib/kunit/test.c | 6 +++++-
4 files changed, 60 insertions(+), 32 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 dc295150c4e57..5ef90c334eb0f 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, **copy_start, *filtered_suite, *new_filtered_suite;
- struct suite_set filtered = {NULL, NULL};
+ struct kunit_suite_set filtered = {NULL, NULL};
struct kunit_glob_filter parsed_glob;
struct kunit_attr_filter *parsed_filters = NULL;

@@ -230,17 +225,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;
@@ -265,7 +267,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");
@@ -282,7 +286,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/executor_test.c b/lib/kunit/executor_test.c
index 3e0a1c99cb4e8..4084071d0eb5b 100644
--- a/lib/kunit/executor_test.c
+++ b/lib/kunit/executor_test.c
@@ -43,8 +43,10 @@ static void parse_filter_test(struct kunit *test)
static void filter_suites_test(struct kunit *test)
{
struct kunit_suite *subsuite[3] = {NULL, NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[2],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases);
@@ -67,8 +69,10 @@ static void filter_suites_test(struct kunit *test)
static void filter_suites_test_glob_test(struct kunit *test)
{
struct kunit_suite *subsuite[3] = {NULL, NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[2],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases);
@@ -94,8 +98,10 @@ static void filter_suites_test_glob_test(struct kunit *test)
static void filter_suites_to_empty_test(struct kunit *test)
{
struct kunit_suite *subsuite[3] = {NULL, NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[2],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases);
@@ -144,8 +150,10 @@ static struct kunit_case dummy_attr_test_cases[] = {
static void filter_attr_test(struct kunit *test)
{
struct kunit_suite *subsuite[3] = {NULL, NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[2],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "normal_suite", dummy_attr_test_cases);
@@ -179,8 +187,10 @@ static void filter_attr_test(struct kunit *test)
static void filter_attr_empty_test(struct kunit *test)
{
struct kunit_suite *subsuite[3] = {NULL, NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[2],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "suite1", dummy_attr_test_cases);
@@ -197,8 +207,10 @@ static void filter_attr_empty_test(struct kunit *test)
static void filter_attr_skip_test(struct kunit *test)
{
struct kunit_suite *subsuite[2] = {NULL};
- struct suite_set suite_set = {.start = subsuite, .end = &subsuite[1]};
- struct suite_set got;
+ struct kunit_suite_set suite_set = {
+ .start = subsuite, .end = &subsuite[1],
+ };
+ struct kunit_suite_set got;
int err = 0;

subsuite[0] = alloc_fake_suite(test, "suite", dummy_attr_test_cases);
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)
--
2.41.0

Janusz Krzysztofik

unread,
Aug 7, 2023, 6:28:43 AM8/7/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.kr...@linux.intel.com>
Cc: Rae Moar <rm...@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 5ef90c334eb0f..e877c1f1e75c8 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");
@@ -239,10 +246,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;
@@ -265,6 +269,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);
}

Janusz Krzysztofik

unread,
Aug 7, 2023, 6:28:51 AM8/7/23
to Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar, Janusz Krzysztofik
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.

v5: Refresh on tpp of attributes filtering fix
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 (l...@intel.com).
v2: Fix new name of a structure moved to kunit namespace not updated
across all uses (l...@intel.com).

Signed-off-by: Janusz Krzysztofik <janusz.kr...@linux.intel.com>
---
include/kunit/test.h | 11 ++++++++
lib/kunit/Kconfig | 2 +-
lib/kunit/executor.c | 63 ++++++++++++++++++++++++++------------------
lib/kunit/test.c | 17 ++++++++++++
4 files changed, 66 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 e877c1f1e75c8..5181aa2e760b6 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");
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,
@@ -218,22 +228,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;
@@ -271,6 +265,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..49698a168437a 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -740,6 +740,17 @@ 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);
+
+ 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 +764,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);
}

Rae Moar

unread,
Aug 7, 2023, 7:32:56 PM8/7/23
to Janusz Krzysztofik, Brendan Higgins, David Gow, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org
On Mon, Aug 7, 2023 at 6:28 AM Janusz Krzysztofik
<janusz.kr...@linux.intel.com> wrote:
>
> 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.
>
> v3: Fix new name of a structure moved to kunit namespace not updated in
> executor_test functions (l...@intel.com).
> v2: Use kunit_exec_run_tests() (Mauro, Rae), but prevent it from
> emitting the headers when called on load of non-test modules.
>

Hello!

This patch looks good. This series also applies cleanly for me now.

I have tested this patch and it works well. I realize this is a bigger
change by exposing the executor function but I think it is overall
cleaner. I am interested in what David Gow thinks about the change.

Reviewed-by: Rae Moar <rm...@google.com>

Thanks!
Rae

David Gow

unread,
Aug 8, 2023, 3:47:41 AM8/8/23
to Janusz Krzysztofik, Brendan Higgins, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar
Thanks! This is a long overdue feature, and it seems to work well here.

Reviewed-by: David Gow <davi...@google.com>

Cheers,
-- David

David Gow

unread,
Aug 8, 2023, 3:47:45 AM8/8/23
to Janusz Krzysztofik, Brendan Higgins, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar
On Mon, 7 Aug 2023 at 18:28, Janusz Krzysztofik
<janusz.kr...@linux.intel.com> wrote:
>
Looks good, thanks!

Reviewed-by: David Gow <davi...@google.com>
I'm not _totally_ sold on the name kunit_action() for a function here,
but none of the other options I can think of (kunit_get_action(),
kunit_action_param(), kunit_action_value(), etc) sound better, so
let's go with it.

David Gow

unread,
Aug 8, 2023, 3:47:51 AM8/8/23
to Janusz Krzysztofik, Brendan Higgins, linux-k...@vger.kernel.org, kuni...@googlegroups.com, Mauro Carvalho Chehab, igt...@lists.freedesktop.org, inte...@lists.freedesktop.org, linux-...@vger.kernel.org, Rae Moar
On Mon, 7 Aug 2023 at 18:28, Janusz Krzysztofik
<janusz.kr...@linux.intel.com> wrote:
>
This works a treat here. It's a bit annoying to have to unload /
reload the module to change the filter, which might be something for
us to consider in the future (maybe via a debugfs entry?), but this is
nevertheless an improvement.

Reviewed-by: David Gow <davi...@google.com>

Cheers,
-- David

I've just learnt a new gcc extension! A bit scary, but it works on
clang as well, so I'm fine with it.
Reply all
Reply to author
Forward
0 new messages