xref: /linux/lib/kunit/executor.c (revision 03c305861c70d6db898dd2379b882e7772a5c5d0)
1 // SPDX-License-Identifier: GPL-2.0
2 
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>
8 
9 /*
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.
12  */
13 extern struct kunit_suite * const __kunit_suites_start[];
14 extern struct kunit_suite * const __kunit_suites_end[];
15 
16 static char *action_param;
17 
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");
24 
25 const char *kunit_action(void)
26 {
27 	return action_param;
28 }
29 
30 static char *filter_glob_param;
31 static char *filter_param;
32 static char *filter_action_param;
33 
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");
45 
46 const char *kunit_filter_glob(void)
47 {
48 	return filter_glob_param;
49 }
50 
51 char *kunit_filter(void)
52 {
53 	return filter_param;
54 }
55 
56 char *kunit_filter_action(void)
57 {
58 	return filter_action_param;
59 }
60 
61 /* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */
62 struct kunit_glob_filter {
63 	char *suite_glob;
64 	char *test_glob;
65 };
66 
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)
70 {
71 	const int len = strlen(filter_glob);
72 	const char *period = strchr(filter_glob, '.');
73 
74 	if (!period) {
75 		parsed->suite_glob = kzalloc(len + 1, GFP_KERNEL);
76 		if (!parsed->suite_glob)
77 			return -ENOMEM;
78 
79 		parsed->test_glob = NULL;
80 		strcpy(parsed->suite_glob, filter_glob);
81 		return 0;
82 	}
83 
84 	parsed->suite_glob = kzalloc(period - filter_glob + 1, GFP_KERNEL);
85 	if (!parsed->suite_glob)
86 		return -ENOMEM;
87 
88 	parsed->test_glob = kzalloc(len - (period - filter_glob) + 1, GFP_KERNEL);
89 	if (!parsed->test_glob) {
90 		kfree(parsed->suite_glob);
91 		return -ENOMEM;
92 	}
93 
94 	strncpy(parsed->suite_glob, filter_glob, period - filter_glob);
95 	strncpy(parsed->test_glob, period + 1, len - (period - filter_glob));
96 
97 	return 0;
98 }
99 
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)
103 {
104 	int n = 0;
105 	struct kunit_case *filtered, *test_case;
106 	struct kunit_suite *copy;
107 
108 	kunit_suite_for_each_test_case(suite, test_case) {
109 		if (!test_glob || glob_match(test_glob, test_case->name))
110 			++n;
111 	}
112 
113 	if (n == 0)
114 		return NULL;
115 
116 	copy = kmemdup(suite, sizeof(*copy), GFP_KERNEL);
117 	if (!copy)
118 		return ERR_PTR(-ENOMEM);
119 
120 	filtered = kcalloc(n + 1, sizeof(*filtered), GFP_KERNEL);
121 	if (!filtered) {
122 		kfree(copy);
123 		return ERR_PTR(-ENOMEM);
124 	}
125 
126 	n = 0;
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;
130 	}
131 
132 	copy->test_cases = filtered;
133 	return copy;
134 }
135 
136 void kunit_free_suite_set(struct kunit_suite_set suite_set)
137 {
138 	struct kunit_suite * const *suites;
139 
140 	for (suites = suite_set.start; suites < suite_set.end; suites++) {
141 		kfree((*suites)->test_cases);
142 		kfree(*suites);
143 	}
144 	kfree(suite_set.start);
145 }
146 
147 struct kunit_suite_set
148 kunit_filter_suites(const struct kunit_suite_set *suite_set,
149 		    const char *filter_glob,
150 		    char *filters,
151 		    char *filter_action,
152 		    int *err)
153 {
154 	int i, j, k;
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;
161 
162 	const size_t max = suite_set->end - suite_set->start;
163 
164 	copy = kcalloc(max, sizeof(*filtered.start), GFP_KERNEL);
165 	if (!copy) { /* won't be able to run anything, return an empty set */
166 		return filtered;
167 	}
168 	copy_start = copy;
169 
170 	if (filter_glob) {
171 		*err = kunit_parse_glob_filter(&parsed_glob, filter_glob);
172 		if (*err)
173 			goto free_copy;
174 	}
175 
176 	/* Parse attribute filters */
177 	if (filters) {
178 		filter_count = kunit_get_filter_count(filters);
179 		parsed_filters = kcalloc(filter_count, sizeof(*parsed_filters), GFP_KERNEL);
180 		if (!parsed_filters) {
181 			*err = -ENOMEM;
182 			goto free_parsed_glob;
183 		}
184 		for (j = 0; j < filter_count; j++)
185 			parsed_filters[j] = kunit_next_attr_filter(&filters, err);
186 		if (*err)
187 			goto free_parsed_filters;
188 	}
189 
190 	for (i = 0; &suite_set->start[i] != suite_set->end; i++) {
191 		filtered_suite = suite_set->start[i];
192 		if (filter_glob) {
193 			if (!glob_match(parsed_glob.suite_glob, filtered_suite->name))
194 				continue;
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;
200 			}
201 		}
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);
206 
207 				/* Free previous copy of suite */
208 				if (k > 0 || filter_glob) {
209 					kfree(filtered_suite->test_cases);
210 					kfree(filtered_suite);
211 				}
212 
213 				filtered_suite = new_filtered_suite;
214 
215 				if (*err)
216 					goto free_filtered_suite;
217 
218 				if (IS_ERR(filtered_suite)) {
219 					*err = PTR_ERR(filtered_suite);
220 					goto free_filtered_suite;
221 				}
222 				if (!filtered_suite)
223 					break;
224 			}
225 		}
226 
227 		if (!filtered_suite)
228 			continue;
229 
230 		*copy++ = filtered_suite;
231 	}
232 	filtered.start = copy_start;
233 	filtered.end = copy;
234 
235 free_filtered_suite:
236 	if (*err) {
237 		for (suites = copy_start; suites < copy; suites++) {
238 			kfree((*suites)->test_cases);
239 			kfree(*suites);
240 		}
241 	}
242 
243 free_parsed_filters:
244 	if (filter_count)
245 		kfree(parsed_filters);
246 
247 free_parsed_glob:
248 	if (filter_glob) {
249 		kfree(parsed_glob.suite_glob);
250 		kfree(parsed_glob.test_glob);
251 	}
252 
253 free_copy:
254 	if (*err)
255 		kfree(copy_start);
256 
257 	return filtered;
258 }
259 
260 void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin)
261 {
262 	size_t num_suites = suite_set->end - suite_set->start;
263 
264 	if (builtin || num_suites) {
265 		pr_info("KTAP version 1\n");
266 		pr_info("1..%zu\n", num_suites);
267 	}
268 
269 	__kunit_test_suites_init(suite_set->start, num_suites);
270 }
271 
272 void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr)
273 {
274 	struct kunit_suite * const *suites;
275 	struct kunit_case *test_case;
276 
277 	/* Hack: print a ktap header so kunit.py can find the start of KUnit output. */
278 	pr_info("KTAP version 1\n");
279 
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);
283 		if (include_attr)
284 			kunit_print_attr((void *)(*suites), false, 0);
285 
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);
289 			if (include_attr)
290 				kunit_print_attr((void *)test_case, true, 0);
291 		}
292 	}
293 }
294 
295 #if IS_BUILTIN(CONFIG_KUNIT)
296 
297 static char *kunit_shutdown;
298 core_param(kunit_shutdown, kunit_shutdown, charp, 0644);
299 
300 static void kunit_handle_shutdown(void)
301 {
302 	if (!kunit_shutdown)
303 		return;
304 
305 	if (!strcmp(kunit_shutdown, "poweroff"))
306 		kernel_power_off();
307 	else if (!strcmp(kunit_shutdown, "halt"))
308 		kernel_halt();
309 	else if (!strcmp(kunit_shutdown, "reboot"))
310 		kernel_restart(NULL);
311 
312 }
313 
314 int kunit_run_all_tests(void)
315 {
316 	struct kunit_suite_set suite_set = {
317 		__kunit_suites_start, __kunit_suites_end,
318 	};
319 	int err = 0;
320 	if (!kunit_enabled()) {
321 		pr_info("kunit: disabled\n");
322 		goto out;
323 	}
324 
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);
328 		if (err) {
329 			pr_err("kunit executor: error filtering suites: %d\n", err);
330 			goto out;
331 		}
332 	}
333 
334 	if (!action_param)
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);
340 	else
341 		pr_err("kunit executor: unknown action '%s'\n", action_param);
342 
343 	if (filter_glob_param || filter_param) { /* a copy was made of each suite */
344 		kunit_free_suite_set(suite_set);
345 	}
346 
347 out:
348 	kunit_handle_shutdown();
349 	return err;
350 }
351 
352 #if IS_BUILTIN(CONFIG_KUNIT_TEST)
353 #include "executor_test.c"
354 #endif
355 
356 #endif /* IS_BUILTIN(CONFIG_KUNIT) */
357