1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/reboot.h>
4 #include <kunit/test.h>
5 #include <kunit/attributes.h>
6 #include <linux/glob.h>
7 #include <linux/moduleparam.h>
10 * These symbols point to the .kunit_test_suites section and are defined in
11 * include/asm-generic/vmlinux.lds.h, and consequently must be extern.
13 extern struct kunit_suite * const __kunit_suites_start[];
14 extern struct kunit_suite * const __kunit_suites_end[];
16 static char *action_param;
18 module_param_named(action, action_param, charp, 0400);
19 MODULE_PARM_DESC(action,
20 "Changes KUnit executor behavior, valid values are:\n"
21 "<none>: run the tests like normal\n"
22 "'list' to list test names instead of running them.\n"
23 "'list_attr' to list test names and attributes instead of running them.\n");
25 const char *kunit_action(void)
30 static char *filter_glob_param;
31 static char *filter_param;
32 static char *filter_action_param;
34 module_param_named(filter_glob, filter_glob_param, charp, 0400);
35 MODULE_PARM_DESC(filter_glob,
36 "Filter which KUnit test suites/tests run at boot-time, e.g. list* or list*.*del_test");
37 module_param_named(filter, filter_param, charp, 0400);
38 MODULE_PARM_DESC(filter,
39 "Filter which KUnit test suites/tests run at boot-time using attributes, e.g. speed>slow");
40 module_param_named(filter_action, filter_action_param, charp, 0400);
41 MODULE_PARM_DESC(filter_action,
42 "Changes behavior of filtered tests using attributes, valid values are:\n"
43 "<none>: do not run filtered tests as normal\n"
44 "'skip': skip all filtered tests instead so tests will appear in output\n");
46 const char *kunit_filter_glob(void)
48 return filter_glob_param;
51 char *kunit_filter(void)
56 char *kunit_filter_action(void)
58 return filter_action_param;
61 /* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
62 struct kunit_glob_filter {
67 /* Split "suite_glob.test_glob" into two. Assumes filter_glob is not empty. */
68 static int kunit_parse_glob_filter(struct kunit_glob_filter *parsed,
69 const char *filter_glob)
71 const int len = strlen(filter_glob);
72 const char *period = strchr(filter_glob, '.');
75 parsed->suite_glob = kzalloc(len + 1, GFP_KERNEL);
76 if (!parsed->suite_glob)
79 parsed->test_glob = NULL;
80 strcpy(parsed->suite_glob, filter_glob);
84 parsed->suite_glob = kzalloc(period - filter_glob + 1, GFP_KERNEL);
85 if (!parsed->suite_glob)
88 parsed->test_glob = kzalloc(len - (period - filter_glob) + 1, GFP_KERNEL);
89 if (!parsed->test_glob) {
90 kfree(parsed->suite_glob);
94 strncpy(parsed->suite_glob, filter_glob, period - filter_glob);
95 strncpy(parsed->test_glob, period + 1, len - (period - filter_glob));
100 /* Create a copy of suite with only tests that match test_glob. */
101 static struct kunit_suite *
102 kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_glob)
105 struct kunit_case *filtered, *test_case;
106 struct kunit_suite *copy;
108 kunit_suite_for_each_test_case(suite, test_case) {
109 if (!test_glob || glob_match(test_glob, test_case->name))
116 copy = kmemdup(suite, sizeof(*copy), GFP_KERNEL);
118 return ERR_PTR(-ENOMEM);
120 filtered = kcalloc(n + 1, sizeof(*filtered), GFP_KERNEL);
123 return ERR_PTR(-ENOMEM);
127 kunit_suite_for_each_test_case(suite, test_case) {
128 if (!test_glob || glob_match(test_glob, test_case->name))
129 filtered[n++] = *test_case;
132 copy->test_cases = filtered;
136 void kunit_free_suite_set(struct kunit_suite_set suite_set)
138 struct kunit_suite * const *suites;
140 for (suites = suite_set.start; suites < suite_set.end; suites++) {
141 kfree((*suites)->test_cases);
144 kfree(suite_set.start);
147 struct kunit_suite_set
148 kunit_filter_suites(const struct kunit_suite_set *suite_set,
149 const char *filter_glob,
155 int filter_count = 0;
156 struct kunit_suite **copy, **copy_start, *filtered_suite, *new_filtered_suite;
157 struct kunit_suite_set filtered = {NULL, NULL};
158 struct kunit_glob_filter parsed_glob;
159 struct kunit_attr_filter *parsed_filters = NULL;
160 struct kunit_suite * const *suites;
162 const size_t max = suite_set->end - suite_set->start;
164 copy = kcalloc(max, sizeof(*filtered.start), GFP_KERNEL);
165 if (!copy) { /* won't be able to run anything, return an empty set */
171 *err = kunit_parse_glob_filter(&parsed_glob, filter_glob);
176 /* Parse attribute filters */
178 filter_count = kunit_get_filter_count(filters);
179 parsed_filters = kcalloc(filter_count, sizeof(*parsed_filters), GFP_KERNEL);
180 if (!parsed_filters) {
182 goto free_parsed_glob;
184 for (j = 0; j < filter_count; j++)
185 parsed_filters[j] = kunit_next_attr_filter(&filters, err);
187 goto free_parsed_filters;
190 for (i = 0; &suite_set->start[i] != suite_set->end; i++) {
191 filtered_suite = suite_set->start[i];
193 if (!glob_match(parsed_glob.suite_glob, filtered_suite->name))
195 filtered_suite = kunit_filter_glob_tests(filtered_suite,
196 parsed_glob.test_glob);
197 if (IS_ERR(filtered_suite)) {
198 *err = PTR_ERR(filtered_suite);
199 goto free_filtered_suite;
202 if (filter_count > 0 && parsed_filters != NULL) {
203 for (k = 0; k < filter_count; k++) {
204 new_filtered_suite = kunit_filter_attr_tests(filtered_suite,
205 parsed_filters[k], filter_action, err);
207 /* Free previous copy of suite */
208 if (k > 0 || filter_glob) {
209 kfree(filtered_suite->test_cases);
210 kfree(filtered_suite);
213 filtered_suite = new_filtered_suite;
216 goto free_filtered_suite;
218 if (IS_ERR(filtered_suite)) {
219 *err = PTR_ERR(filtered_suite);
220 goto free_filtered_suite;
230 *copy++ = filtered_suite;
232 filtered.start = copy_start;
237 for (suites = copy_start; suites < copy; suites++) {
238 kfree((*suites)->test_cases);
245 kfree(parsed_filters);
249 kfree(parsed_glob.suite_glob);
250 kfree(parsed_glob.test_glob);
260 void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin)
262 size_t num_suites = suite_set->end - suite_set->start;
264 if (builtin || num_suites) {
265 pr_info("KTAP version 1\n");
266 pr_info("1..%zu\n", num_suites);
269 __kunit_test_suites_init(suite_set->start, num_suites);
272 void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr)
274 struct kunit_suite * const *suites;
275 struct kunit_case *test_case;
277 /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */
278 pr_info("KTAP version 1\n");
280 for (suites = suite_set->start; suites < suite_set->end; suites++) {
281 /* Print suite name and suite attributes */
282 pr_info("%s\n", (*suites)->name);
284 kunit_print_attr((void *)(*suites), false, 0);
286 /* Print test case name and attributes in suite */
287 kunit_suite_for_each_test_case((*suites), test_case) {
288 pr_info("%s.%s\n", (*suites)->name, test_case->name);
290 kunit_print_attr((void *)test_case, true, 0);
295 #if IS_BUILTIN(CONFIG_KUNIT)
297 static char *kunit_shutdown;
298 core_param(kunit_shutdown, kunit_shutdown, charp, 0644);
300 static void kunit_handle_shutdown(void)
305 if (!strcmp(kunit_shutdown, "poweroff"))
307 else if (!strcmp(kunit_shutdown, "halt"))
309 else if (!strcmp(kunit_shutdown, "reboot"))
310 kernel_restart(NULL);
314 int kunit_run_all_tests(void)
316 struct kunit_suite_set suite_set = {
317 __kunit_suites_start, __kunit_suites_end,
320 if (!kunit_enabled()) {
321 pr_info("kunit: disabled\n");
325 if (filter_glob_param || filter_param) {
326 suite_set = kunit_filter_suites(&suite_set, filter_glob_param,
327 filter_param, filter_action_param, &err);
329 pr_err("kunit executor: error filtering suites: %d\n", err);
335 kunit_exec_run_tests(&suite_set, true);
336 else if (strcmp(action_param, "list") == 0)
337 kunit_exec_list_tests(&suite_set, false);
338 else if (strcmp(action_param, "list_attr") == 0)
339 kunit_exec_list_tests(&suite_set, true);
341 pr_err("kunit executor: unknown action '%s'\n", action_param);
343 if (filter_glob_param || filter_param) { /* a copy was made of each suite */
344 kunit_free_suite_set(suite_set);
348 kunit_handle_shutdown();
352 #if IS_BUILTIN(CONFIG_KUNIT_TEST)
353 #include "executor_test.c"
356 #endif /* IS_BUILTIN(CONFIG_KUNIT) */