1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * KUnit API providing hooks for non-test code to interact with tests.
4 *
5 * Copyright (C) 2020, Google LLC.
6 * Author: Uriel Guajardo <urielguajardo@google.com>
7 */
8
9 #ifndef _KUNIT_TEST_BUG_H
10 #define _KUNIT_TEST_BUG_H
11
12 #include <linux/stddef.h> /* for NULL */
13
14 #if IS_ENABLED(CONFIG_KUNIT)
15
16 #include <linux/jump_label.h> /* For static branch */
17 #include <linux/sched.h>
18 #include <linux/android_kabi.h>
19
20 /* Static key if KUnit is running any tests. */
21 DECLARE_STATIC_KEY_FALSE(kunit_running);
22
23 /* Hooks table: a table of function pointers filled in when kunit loads */
24 extern struct kunit_hooks_table {
25 __printf(3, 4) void (*fail_current_test)(const char*, int, const char*, ...);
26 void *(*get_static_stub_address)(struct kunit *test, void *real_fn_addr);
27
28 ANDROID_KABI_RESERVE(1);
29 } kunit_hooks;
30
31 /**
32 * kunit_get_current_test() - Return a pointer to the currently running
33 * KUnit test.
34 *
35 * If a KUnit test is running in the current task, returns a pointer to its
36 * associated struct kunit. This pointer can then be passed to any KUnit
37 * function or assertion. If no test is running (or a test is running in a
38 * different task), returns NULL.
39 *
40 * This function is safe to call even when KUnit is disabled. If CONFIG_KUNIT
41 * is not enabled, it will compile down to nothing and will return quickly no
42 * test is running.
43 */
kunit_get_current_test(void)44 static inline struct kunit *kunit_get_current_test(void)
45 {
46 if (!static_branch_unlikely(&kunit_running))
47 return NULL;
48
49 return current->kunit_test;
50 }
51
52
53 /**
54 * kunit_fail_current_test() - If a KUnit test is running, fail it.
55 *
56 * If a KUnit test is running in the current task, mark that test as failed.
57 */
58 #define kunit_fail_current_test(fmt, ...) do { \
59 if (static_branch_unlikely(&kunit_running)) { \
60 /* Guaranteed to be non-NULL when kunit_running true*/ \
61 kunit_hooks.fail_current_test(__FILE__, __LINE__, \
62 fmt, ##__VA_ARGS__); \
63 } \
64 } while (0)
65
66 #else
67
kunit_get_current_test(void)68 static inline struct kunit *kunit_get_current_test(void) { return NULL; }
69
70 #define kunit_fail_current_test(fmt, ...) do {} while (0)
71
72 #endif
73
74 #endif /* _KUNIT_TEST_BUG_H */
75