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/test.h>
10 #include <linux/kernel.h>
11 #include <linux/kref.h>
12 #include <linux/sched/debug.h>
15 #include "string-stream.h"
16 #include "try-catch-impl.h"
18 static void kunit_set_failure(struct kunit *test)
20 WRITE_ONCE(test->success, false);
23 static void kunit_print_tap_version(void)
25 static bool kunit_has_printed_tap_version;
27 if (!kunit_has_printed_tap_version) {
28 pr_info("TAP version 14\n");
29 kunit_has_printed_tap_version = true;
34 * Append formatted message to log, size of which is limited to
35 * KUNIT_LOG_SIZE bytes (including null terminating byte).
37 void kunit_log_append(char *log, const char *fmt, ...)
39 char line[KUNIT_LOG_SIZE];
46 len_left = KUNIT_LOG_SIZE - strlen(log) - 1;
51 vsnprintf(line, sizeof(line), fmt, args);
54 strncat(log, line, len_left);
56 EXPORT_SYMBOL_GPL(kunit_log_append);
58 size_t kunit_suite_num_test_cases(struct kunit_suite *suite)
60 struct kunit_case *test_case;
63 kunit_suite_for_each_test_case(suite, test_case)
68 EXPORT_SYMBOL_GPL(kunit_suite_num_test_cases);
70 static void kunit_print_subtest_start(struct kunit_suite *suite)
72 kunit_print_tap_version();
73 kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "# Subtest: %s",
75 kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "1..%zd",
76 kunit_suite_num_test_cases(suite));
79 static void kunit_print_ok_not_ok(void *test_or_suite,
83 const char *description)
85 struct kunit_suite *suite = is_test ? NULL : test_or_suite;
86 struct kunit *test = is_test ? test_or_suite : NULL;
89 * We do not log the test suite results as doing so would
90 * mean debugfs display would consist of the test suite
91 * description and status prior to individual test results.
92 * Hence directly printk the suite status, and we will
93 * separately seq_printf() the suite status for the debugfs
97 pr_info("%s %zd - %s\n",
98 kunit_status_to_string(is_ok),
99 test_number, description);
101 kunit_log(KERN_INFO, test, KUNIT_SUBTEST_INDENT "%s %zd - %s",
102 kunit_status_to_string(is_ok),
103 test_number, description);
106 bool kunit_suite_has_succeeded(struct kunit_suite *suite)
108 const struct kunit_case *test_case;
110 kunit_suite_for_each_test_case(suite, test_case) {
111 if (!test_case->success)
117 EXPORT_SYMBOL_GPL(kunit_suite_has_succeeded);
119 static void kunit_print_subtest_end(struct kunit_suite *suite)
121 static size_t kunit_suite_counter = 1;
123 kunit_print_ok_not_ok((void *)suite, false,
124 kunit_suite_has_succeeded(suite),
125 kunit_suite_counter++,
129 unsigned int kunit_test_case_num(struct kunit_suite *suite,
130 struct kunit_case *test_case)
132 struct kunit_case *tc;
135 kunit_suite_for_each_test_case(suite, tc) {
143 EXPORT_SYMBOL_GPL(kunit_test_case_num);
145 static void kunit_print_string_stream(struct kunit *test,
146 struct string_stream *stream)
148 struct string_stream_fragment *fragment;
151 if (string_stream_is_empty(stream))
154 buf = string_stream_get_string(stream);
157 "Could not allocate buffer, dumping stream:\n");
158 list_for_each_entry(fragment, &stream->fragments, node) {
159 kunit_err(test, "%s", fragment->fragment);
161 kunit_err(test, "\n");
163 kunit_err(test, "%s", buf);
164 kunit_kfree(test, buf);
168 static void kunit_fail(struct kunit *test, struct kunit_assert *assert)
170 struct string_stream *stream;
172 kunit_set_failure(test);
174 stream = alloc_string_stream(test, GFP_KERNEL);
177 "Could not allocate stream to print failed assertion in %s:%d\n",
183 assert->format(assert, stream);
185 kunit_print_string_stream(test, stream);
187 WARN_ON(string_stream_destroy(stream));
190 static void __noreturn kunit_abort(struct kunit *test)
192 kunit_try_catch_throw(&test->try_catch); /* Does not return. */
195 * Throw could not abort from test.
197 * XXX: we should never reach this line! As kunit_try_catch_throw is
200 WARN_ONCE(true, "Throw could not abort from test!\n");
203 void kunit_do_assertion(struct kunit *test,
204 struct kunit_assert *assert,
206 const char *fmt, ...)
215 assert->message.fmt = fmt;
216 assert->message.va = &args;
218 kunit_fail(test, assert);
222 if (assert->type == KUNIT_ASSERTION)
225 EXPORT_SYMBOL_GPL(kunit_do_assertion);
227 void kunit_init_test(struct kunit *test, const char *name, char *log)
229 spin_lock_init(&test->lock);
230 INIT_LIST_HEAD(&test->resources);
235 test->success = true;
237 EXPORT_SYMBOL_GPL(kunit_init_test);
240 * Initializes and runs test case. Does not clean up or do post validations.
242 static void kunit_run_case_internal(struct kunit *test,
243 struct kunit_suite *suite,
244 struct kunit_case *test_case)
249 ret = suite->init(test);
251 kunit_err(test, "failed to initialize: %d\n", ret);
252 kunit_set_failure(test);
257 test_case->run_case(test);
260 static void kunit_case_internal_cleanup(struct kunit *test)
266 * Performs post validations and cleanup after a test case was run.
267 * XXX: Should ONLY BE CALLED AFTER kunit_run_case_internal!
269 static void kunit_run_case_cleanup(struct kunit *test,
270 struct kunit_suite *suite)
275 kunit_case_internal_cleanup(test);
278 struct kunit_try_catch_context {
280 struct kunit_suite *suite;
281 struct kunit_case *test_case;
284 static void kunit_try_run_case(void *data)
286 struct kunit_try_catch_context *ctx = data;
287 struct kunit *test = ctx->test;
288 struct kunit_suite *suite = ctx->suite;
289 struct kunit_case *test_case = ctx->test_case;
292 * kunit_run_case_internal may encounter a fatal error; if it does,
293 * abort will be called, this thread will exit, and finally the parent
294 * thread will resume control and handle any necessary clean up.
296 kunit_run_case_internal(test, suite, test_case);
297 /* This line may never be reached. */
298 kunit_run_case_cleanup(test, suite);
301 static void kunit_catch_run_case(void *data)
303 struct kunit_try_catch_context *ctx = data;
304 struct kunit *test = ctx->test;
305 struct kunit_suite *suite = ctx->suite;
306 int try_exit_code = kunit_try_catch_get_result(&test->try_catch);
309 kunit_set_failure(test);
311 * Test case could not finish, we have no idea what state it is
312 * in, so don't do clean up.
314 if (try_exit_code == -ETIMEDOUT) {
315 kunit_err(test, "test case timed out\n");
317 * Unknown internal error occurred preventing test case from
318 * running, so there is nothing to clean up.
321 kunit_err(test, "internal error occurred preventing test case from running: %d\n",
328 * Test case was run, but aborted. It is the test case's business as to
329 * whether it failed or not, we just need to clean up.
331 kunit_run_case_cleanup(test, suite);
335 * Performs all logic to run a test case. It also catches most errors that
336 * occur in a test case and reports them as failures.
338 static void kunit_run_case_catch_errors(struct kunit_suite *suite,
339 struct kunit_case *test_case)
341 struct kunit_try_catch_context context;
342 struct kunit_try_catch *try_catch;
345 kunit_init_test(&test, test_case->name, test_case->log);
346 try_catch = &test.try_catch;
348 kunit_try_catch_init(try_catch,
351 kunit_catch_run_case);
352 context.test = &test;
353 context.suite = suite;
354 context.test_case = test_case;
355 kunit_try_catch_run(try_catch, &context);
357 test_case->success = test.success;
359 kunit_print_ok_not_ok(&test, true, test_case->success,
360 kunit_test_case_num(suite, test_case),
364 int kunit_run_tests(struct kunit_suite *suite)
366 struct kunit_case *test_case;
368 kunit_print_subtest_start(suite);
370 kunit_suite_for_each_test_case(suite, test_case)
371 kunit_run_case_catch_errors(suite, test_case);
373 kunit_print_subtest_end(suite);
377 EXPORT_SYMBOL_GPL(kunit_run_tests);
379 static void kunit_init_suite(struct kunit_suite *suite)
381 kunit_debugfs_create_suite(suite);
384 int __kunit_test_suites_init(struct kunit_suite **suites)
388 for (i = 0; suites[i] != NULL; i++) {
389 kunit_init_suite(suites[i]);
390 kunit_run_tests(suites[i]);
394 EXPORT_SYMBOL_GPL(__kunit_test_suites_init);
396 static void kunit_exit_suite(struct kunit_suite *suite)
398 kunit_debugfs_destroy_suite(suite);
401 void __kunit_test_suites_exit(struct kunit_suite **suites)
405 for (i = 0; suites[i] != NULL; i++)
406 kunit_exit_suite(suites[i]);
408 EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
411 * Used for static resources and when a kunit_resource * has been created by
412 * kunit_alloc_resource(). When an init function is supplied, @data is passed
413 * into the init function; otherwise, we simply set the resource data field to
414 * the data value passed in.
416 int kunit_add_resource(struct kunit *test,
417 kunit_resource_init_t init,
418 kunit_resource_free_t free,
419 struct kunit_resource *res,
425 kref_init(&res->refcount);
428 ret = init(res, data);
435 spin_lock(&test->lock);
436 list_add_tail(&res->node, &test->resources);
437 /* refcount for list is established by kref_init() */
438 spin_unlock(&test->lock);
442 EXPORT_SYMBOL_GPL(kunit_add_resource);
444 int kunit_add_named_resource(struct kunit *test,
445 kunit_resource_init_t init,
446 kunit_resource_free_t free,
447 struct kunit_resource *res,
451 struct kunit_resource *existing;
456 existing = kunit_find_named_resource(test, name);
458 kunit_put_resource(existing);
464 return kunit_add_resource(test, init, free, res, data);
466 EXPORT_SYMBOL_GPL(kunit_add_named_resource);
468 struct kunit_resource *kunit_alloc_and_get_resource(struct kunit *test,
469 kunit_resource_init_t init,
470 kunit_resource_free_t free,
474 struct kunit_resource *res;
477 res = kzalloc(sizeof(*res), internal_gfp);
481 ret = kunit_add_resource(test, init, free, res, data);
484 * bump refcount for get; kunit_resource_put() should be called
487 kunit_get_resource(res);
492 EXPORT_SYMBOL_GPL(kunit_alloc_and_get_resource);
494 void kunit_remove_resource(struct kunit *test, struct kunit_resource *res)
496 spin_lock(&test->lock);
497 list_del(&res->node);
498 spin_unlock(&test->lock);
499 kunit_put_resource(res);
501 EXPORT_SYMBOL_GPL(kunit_remove_resource);
503 int kunit_destroy_resource(struct kunit *test, kunit_resource_match_t match,
506 struct kunit_resource *res = kunit_find_resource(test, match,
512 kunit_remove_resource(test, res);
514 /* We have a reference also via _find(); drop it. */
515 kunit_put_resource(res);
519 EXPORT_SYMBOL_GPL(kunit_destroy_resource);
521 struct kunit_kmalloc_params {
526 static int kunit_kmalloc_init(struct kunit_resource *res, void *context)
528 struct kunit_kmalloc_params *params = context;
530 res->data = kmalloc(params->size, params->gfp);
537 static void kunit_kmalloc_free(struct kunit_resource *res)
542 void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp)
544 struct kunit_kmalloc_params params = {
549 return kunit_alloc_resource(test,
555 EXPORT_SYMBOL_GPL(kunit_kmalloc);
557 void kunit_kfree(struct kunit *test, const void *ptr)
559 struct kunit_resource *res;
561 res = kunit_find_resource(test, kunit_resource_instance_match,
565 * Removing the resource from the list of resources drops the
566 * reference count to 1; the final put will trigger the free.
568 kunit_remove_resource(test, res);
570 kunit_put_resource(res);
573 EXPORT_SYMBOL_GPL(kunit_kfree);
575 void kunit_cleanup(struct kunit *test)
577 struct kunit_resource *res;
580 * test->resources is a stack - each allocation must be freed in the
581 * reverse order from which it was added since one resource may depend
582 * on another for its entire lifetime.
583 * Also, we cannot use the normal list_for_each constructs, even the
584 * safe ones because *arbitrary* nodes may be deleted when
585 * kunit_resource_free is called; the list_for_each_safe variants only
586 * protect against the current node being deleted, not the next.
589 spin_lock(&test->lock);
590 if (list_empty(&test->resources)) {
591 spin_unlock(&test->lock);
594 res = list_last_entry(&test->resources,
595 struct kunit_resource,
598 * Need to unlock here as a resource may remove another
599 * resource, and this can't happen if the test->lock
602 spin_unlock(&test->lock);
603 kunit_remove_resource(test, res);
606 EXPORT_SYMBOL_GPL(kunit_cleanup);
608 static int __init kunit_init(void)
610 kunit_debugfs_init();
614 late_initcall(kunit_init);
616 static void __exit kunit_exit(void)
618 kunit_debugfs_cleanup();
620 module_exit(kunit_exit);
622 MODULE_LICENSE("GPL v2");