1 // SPDX-License-Identifier: GPL-2.0
3 * Base unit test (KUnit) API.
5 * Copyright (C) 2019, Google LLC.
6 * Author: Brendan Higgins <brendanhiggins@google.com>
9 #include <kunit/resource.h>
10 #include <kunit/test.h>
11 #include <kunit/test-bug.h>
12 #include <linux/kernel.h>
13 #include <linux/moduleparam.h>
14 #include <linux/sched/debug.h>
15 #include <linux/sched.h>
18 #include "string-stream.h"
19 #include "try-catch-impl.h"
21 #if IS_BUILTIN(CONFIG_KUNIT)
23 * Fail the current test and print an error message to the log.
25 void __kunit_fail_current_test(const char *file, int line, const char *fmt, ...)
31 if (!current->kunit_test)
34 kunit_set_failure(current->kunit_test);
36 /* kunit_err() only accepts literals, so evaluate the args first. */
38 len = vsnprintf(NULL, 0, fmt, args) + 1;
41 buffer = kunit_kmalloc(current->kunit_test, len, GFP_KERNEL);
46 vsnprintf(buffer, len, fmt, args);
49 kunit_err(current->kunit_test, "%s:%d: %s", file, line, buffer);
50 kunit_kfree(current->kunit_test, buffer);
52 EXPORT_SYMBOL_GPL(__kunit_fail_current_test);
56 * KUnit statistic mode:
58 * 1 - only when there is more than one subtest
61 static int kunit_stats_enabled = 1;
62 module_param_named(stats_enabled, kunit_stats_enabled, int, 0644);
63 MODULE_PARM_DESC(stats_enabled,
64 "Print test stats: never (0), only for multiple subtests (1), or always (2)");
66 struct kunit_result_stats {
68 unsigned long skipped;
73 static bool kunit_should_print_stats(struct kunit_result_stats stats)
75 if (kunit_stats_enabled == 0)
78 if (kunit_stats_enabled == 2)
81 return (stats.total > 1);
84 static void kunit_print_test_stats(struct kunit *test,
85 struct kunit_result_stats stats)
87 if (!kunit_should_print_stats(stats))
90 kunit_log(KERN_INFO, test,
92 "# %s: pass:%lu fail:%lu skip:%lu total:%lu",
101 * Append formatted message to log, size of which is limited to
102 * KUNIT_LOG_SIZE bytes (including null terminating byte).
104 void kunit_log_append(char *log, const char *fmt, ...)
106 char line[KUNIT_LOG_SIZE];
113 len_left = KUNIT_LOG_SIZE - strlen(log) - 1;
118 vsnprintf(line, sizeof(line), fmt, args);
121 strncat(log, line, len_left);
123 EXPORT_SYMBOL_GPL(kunit_log_append);
125 size_t kunit_suite_num_test_cases(struct kunit_suite *suite)
127 struct kunit_case *test_case;
130 kunit_suite_for_each_test_case(suite, test_case)
135 EXPORT_SYMBOL_GPL(kunit_suite_num_test_cases);
137 static void kunit_print_suite_start(struct kunit_suite *suite)
139 kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "# Subtest: %s",
141 kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "1..%zd",
142 kunit_suite_num_test_cases(suite));
145 static void kunit_print_ok_not_ok(void *test_or_suite,
147 enum kunit_status status,
149 const char *description,
150 const char *directive)
152 struct kunit_suite *suite = is_test ? NULL : test_or_suite;
153 struct kunit *test = is_test ? test_or_suite : NULL;
154 const char *directive_header = (status == KUNIT_SKIPPED) ? " # SKIP " : "";
157 * We do not log the test suite results as doing so would
158 * mean debugfs display would consist of the test suite
159 * description and status prior to individual test results.
160 * Hence directly printk the suite status, and we will
161 * separately seq_printf() the suite status for the debugfs
165 pr_info("%s %zd - %s%s%s\n",
166 kunit_status_to_ok_not_ok(status),
167 test_number, description, directive_header,
168 (status == KUNIT_SKIPPED) ? directive : "");
170 kunit_log(KERN_INFO, test,
171 KUNIT_SUBTEST_INDENT "%s %zd - %s%s%s",
172 kunit_status_to_ok_not_ok(status),
173 test_number, description, directive_header,
174 (status == KUNIT_SKIPPED) ? directive : "");
177 enum kunit_status kunit_suite_has_succeeded(struct kunit_suite *suite)
179 const struct kunit_case *test_case;
180 enum kunit_status status = KUNIT_SKIPPED;
182 if (suite->suite_init_err)
183 return KUNIT_FAILURE;
185 kunit_suite_for_each_test_case(suite, test_case) {
186 if (test_case->status == KUNIT_FAILURE)
187 return KUNIT_FAILURE;
188 else if (test_case->status == KUNIT_SUCCESS)
189 status = KUNIT_SUCCESS;
194 EXPORT_SYMBOL_GPL(kunit_suite_has_succeeded);
196 static size_t kunit_suite_counter = 1;
198 static void kunit_print_suite_end(struct kunit_suite *suite)
200 kunit_print_ok_not_ok((void *)suite, false,
201 kunit_suite_has_succeeded(suite),
202 kunit_suite_counter++,
204 suite->status_comment);
207 unsigned int kunit_test_case_num(struct kunit_suite *suite,
208 struct kunit_case *test_case)
210 struct kunit_case *tc;
213 kunit_suite_for_each_test_case(suite, tc) {
221 EXPORT_SYMBOL_GPL(kunit_test_case_num);
223 static void kunit_print_string_stream(struct kunit *test,
224 struct string_stream *stream)
226 struct string_stream_fragment *fragment;
229 if (string_stream_is_empty(stream))
232 buf = string_stream_get_string(stream);
235 "Could not allocate buffer, dumping stream:\n");
236 list_for_each_entry(fragment, &stream->fragments, node) {
237 kunit_err(test, "%s", fragment->fragment);
239 kunit_err(test, "\n");
241 kunit_err(test, "%s", buf);
242 kunit_kfree(test, buf);
246 static void kunit_fail(struct kunit *test, const struct kunit_loc *loc,
247 enum kunit_assert_type type, const struct kunit_assert *assert,
248 const struct va_format *message)
250 struct string_stream *stream;
252 kunit_set_failure(test);
254 stream = alloc_string_stream(test, GFP_KERNEL);
257 "Could not allocate stream to print failed assertion in %s:%d\n",
263 kunit_assert_prologue(loc, type, stream);
264 assert->format(assert, message, stream);
266 kunit_print_string_stream(test, stream);
268 WARN_ON(string_stream_destroy(stream));
271 static void __noreturn kunit_abort(struct kunit *test)
273 kunit_try_catch_throw(&test->try_catch); /* Does not return. */
276 * Throw could not abort from test.
278 * XXX: we should never reach this line! As kunit_try_catch_throw is
281 WARN_ONCE(true, "Throw could not abort from test!\n");
284 void kunit_do_failed_assertion(struct kunit *test,
285 const struct kunit_loc *loc,
286 enum kunit_assert_type type,
287 const struct kunit_assert *assert,
288 const char *fmt, ...)
291 struct va_format message;
297 kunit_fail(test, loc, type, assert, &message);
301 if (type == KUNIT_ASSERTION)
304 EXPORT_SYMBOL_GPL(kunit_do_failed_assertion);
306 void kunit_init_test(struct kunit *test, const char *name, char *log)
308 spin_lock_init(&test->lock);
309 INIT_LIST_HEAD(&test->resources);
314 test->status = KUNIT_SUCCESS;
315 test->status_comment[0] = '\0';
317 EXPORT_SYMBOL_GPL(kunit_init_test);
320 * Initializes and runs test case. Does not clean up or do post validations.
322 static void kunit_run_case_internal(struct kunit *test,
323 struct kunit_suite *suite,
324 struct kunit_case *test_case)
329 ret = suite->init(test);
331 kunit_err(test, "failed to initialize: %d\n", ret);
332 kunit_set_failure(test);
337 test_case->run_case(test);
340 static void kunit_case_internal_cleanup(struct kunit *test)
346 * Performs post validations and cleanup after a test case was run.
347 * XXX: Should ONLY BE CALLED AFTER kunit_run_case_internal!
349 static void kunit_run_case_cleanup(struct kunit *test,
350 struct kunit_suite *suite)
355 kunit_case_internal_cleanup(test);
358 struct kunit_try_catch_context {
360 struct kunit_suite *suite;
361 struct kunit_case *test_case;
364 static void kunit_try_run_case(void *data)
366 struct kunit_try_catch_context *ctx = data;
367 struct kunit *test = ctx->test;
368 struct kunit_suite *suite = ctx->suite;
369 struct kunit_case *test_case = ctx->test_case;
371 current->kunit_test = test;
374 * kunit_run_case_internal may encounter a fatal error; if it does,
375 * abort will be called, this thread will exit, and finally the parent
376 * thread will resume control and handle any necessary clean up.
378 kunit_run_case_internal(test, suite, test_case);
379 /* This line may never be reached. */
380 kunit_run_case_cleanup(test, suite);
383 static void kunit_catch_run_case(void *data)
385 struct kunit_try_catch_context *ctx = data;
386 struct kunit *test = ctx->test;
387 struct kunit_suite *suite = ctx->suite;
388 int try_exit_code = kunit_try_catch_get_result(&test->try_catch);
391 kunit_set_failure(test);
393 * Test case could not finish, we have no idea what state it is
394 * in, so don't do clean up.
396 if (try_exit_code == -ETIMEDOUT) {
397 kunit_err(test, "test case timed out\n");
399 * Unknown internal error occurred preventing test case from
400 * running, so there is nothing to clean up.
403 kunit_err(test, "internal error occurred preventing test case from running: %d\n",
410 * Test case was run, but aborted. It is the test case's business as to
411 * whether it failed or not, we just need to clean up.
413 kunit_run_case_cleanup(test, suite);
417 * Performs all logic to run a test case. It also catches most errors that
418 * occur in a test case and reports them as failures.
420 static void kunit_run_case_catch_errors(struct kunit_suite *suite,
421 struct kunit_case *test_case,
424 struct kunit_try_catch_context context;
425 struct kunit_try_catch *try_catch;
427 kunit_init_test(test, test_case->name, test_case->log);
428 try_catch = &test->try_catch;
430 kunit_try_catch_init(try_catch,
433 kunit_catch_run_case);
435 context.suite = suite;
436 context.test_case = test_case;
437 kunit_try_catch_run(try_catch, &context);
439 /* Propagate the parameter result to the test case. */
440 if (test->status == KUNIT_FAILURE)
441 test_case->status = KUNIT_FAILURE;
442 else if (test_case->status != KUNIT_FAILURE && test->status == KUNIT_SUCCESS)
443 test_case->status = KUNIT_SUCCESS;
446 static void kunit_print_suite_stats(struct kunit_suite *suite,
447 struct kunit_result_stats suite_stats,
448 struct kunit_result_stats param_stats)
450 if (kunit_should_print_stats(suite_stats)) {
451 kunit_log(KERN_INFO, suite,
452 "# %s: pass:%lu fail:%lu skip:%lu total:%lu",
460 if (kunit_should_print_stats(param_stats)) {
461 kunit_log(KERN_INFO, suite,
462 "# Totals: pass:%lu fail:%lu skip:%lu total:%lu",
470 static void kunit_update_stats(struct kunit_result_stats *stats,
471 enum kunit_status status)
488 static void kunit_accumulate_stats(struct kunit_result_stats *total,
489 struct kunit_result_stats add)
491 total->passed += add.passed;
492 total->skipped += add.skipped;
493 total->failed += add.failed;
494 total->total += add.total;
497 int kunit_run_tests(struct kunit_suite *suite)
499 char param_desc[KUNIT_PARAM_DESC_SIZE];
500 struct kunit_case *test_case;
501 struct kunit_result_stats suite_stats = { 0 };
502 struct kunit_result_stats total_stats = { 0 };
504 if (suite->suite_init) {
505 suite->suite_init_err = suite->suite_init(suite);
506 if (suite->suite_init_err) {
507 kunit_err(suite, KUNIT_SUBTEST_INDENT
508 "# failed to initialize (%d)", suite->suite_init_err);
513 kunit_print_suite_start(suite);
515 kunit_suite_for_each_test_case(suite, test_case) {
516 struct kunit test = { .param_value = NULL, .param_index = 0 };
517 struct kunit_result_stats param_stats = { 0 };
518 test_case->status = KUNIT_SKIPPED;
520 if (!test_case->generate_params) {
521 /* Non-parameterised test. */
522 kunit_run_case_catch_errors(suite, test_case, &test);
523 kunit_update_stats(¶m_stats, test.status);
525 /* Get initial param. */
526 param_desc[0] = '\0';
527 test.param_value = test_case->generate_params(NULL, param_desc);
528 kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT
529 "# Subtest: %s", test_case->name);
531 while (test.param_value) {
532 kunit_run_case_catch_errors(suite, test_case, &test);
534 if (param_desc[0] == '\0') {
535 snprintf(param_desc, sizeof(param_desc),
536 "param-%d", test.param_index);
539 kunit_log(KERN_INFO, &test,
540 KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT
542 kunit_status_to_ok_not_ok(test.status),
543 test.param_index + 1, param_desc);
545 /* Get next param. */
546 param_desc[0] = '\0';
547 test.param_value = test_case->generate_params(test.param_value, param_desc);
550 kunit_update_stats(¶m_stats, test.status);
555 kunit_print_test_stats(&test, param_stats);
557 kunit_print_ok_not_ok(&test, true, test_case->status,
558 kunit_test_case_num(suite, test_case),
560 test.status_comment);
562 kunit_update_stats(&suite_stats, test_case->status);
563 kunit_accumulate_stats(&total_stats, param_stats);
566 if (suite->suite_exit)
567 suite->suite_exit(suite);
569 kunit_print_suite_stats(suite, suite_stats, total_stats);
571 kunit_print_suite_end(suite);
575 EXPORT_SYMBOL_GPL(kunit_run_tests);
577 static void kunit_init_suite(struct kunit_suite *suite)
579 kunit_debugfs_create_suite(suite);
580 suite->status_comment[0] = '\0';
581 suite->suite_init_err = 0;
584 int __kunit_test_suites_init(struct kunit_suite * const * const suites)
588 for (i = 0; suites[i] != NULL; i++) {
589 kunit_init_suite(suites[i]);
590 kunit_run_tests(suites[i]);
594 EXPORT_SYMBOL_GPL(__kunit_test_suites_init);
596 static void kunit_exit_suite(struct kunit_suite *suite)
598 kunit_debugfs_destroy_suite(suite);
601 void __kunit_test_suites_exit(struct kunit_suite **suites)
605 for (i = 0; suites[i] != NULL; i++)
606 kunit_exit_suite(suites[i]);
608 kunit_suite_counter = 1;
610 EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
612 struct kunit_kmalloc_array_params {
618 static int kunit_kmalloc_array_init(struct kunit_resource *res, void *context)
620 struct kunit_kmalloc_array_params *params = context;
622 res->data = kmalloc_array(params->n, params->size, params->gfp);
629 static void kunit_kmalloc_array_free(struct kunit_resource *res)
634 void *kunit_kmalloc_array(struct kunit *test, size_t n, size_t size, gfp_t gfp)
636 struct kunit_kmalloc_array_params params = {
642 return kunit_alloc_resource(test,
643 kunit_kmalloc_array_init,
644 kunit_kmalloc_array_free,
648 EXPORT_SYMBOL_GPL(kunit_kmalloc_array);
650 void kunit_kfree(struct kunit *test, const void *ptr)
652 struct kunit_resource *res;
654 res = kunit_find_resource(test, kunit_resource_instance_match,
658 * Removing the resource from the list of resources drops the
659 * reference count to 1; the final put will trigger the free.
661 kunit_remove_resource(test, res);
663 kunit_put_resource(res);
666 EXPORT_SYMBOL_GPL(kunit_kfree);
668 void kunit_cleanup(struct kunit *test)
670 struct kunit_resource *res;
674 * test->resources is a stack - each allocation must be freed in the
675 * reverse order from which it was added since one resource may depend
676 * on another for its entire lifetime.
677 * Also, we cannot use the normal list_for_each constructs, even the
678 * safe ones because *arbitrary* nodes may be deleted when
679 * kunit_resource_free is called; the list_for_each_safe variants only
680 * protect against the current node being deleted, not the next.
683 spin_lock_irqsave(&test->lock, flags);
684 if (list_empty(&test->resources)) {
685 spin_unlock_irqrestore(&test->lock, flags);
688 res = list_last_entry(&test->resources,
689 struct kunit_resource,
692 * Need to unlock here as a resource may remove another
693 * resource, and this can't happen if the test->lock
696 spin_unlock_irqrestore(&test->lock, flags);
697 kunit_remove_resource(test, res);
699 current->kunit_test = NULL;
701 EXPORT_SYMBOL_GPL(kunit_cleanup);
703 static int __init kunit_init(void)
705 kunit_debugfs_init();
709 late_initcall(kunit_init);
711 static void __exit kunit_exit(void)
713 kunit_debugfs_cleanup();
715 module_exit(kunit_exit);
717 MODULE_LICENSE("GPL v2");