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 | |
19 | /* Static key if KUnit is running any tests. */ |
20 | DECLARE_STATIC_KEY_FALSE(kunit_running); |
21 | |
22 | /* Hooks table: a table of function pointers filled in when kunit loads */ |
23 | extern struct kunit_hooks_table { |
24 | __printf(3, 4) void (*fail_current_test)(const char*, int, const char*, ...); |
25 | void *(*get_static_stub_address)(struct kunit *test, void *real_fn_addr); |
26 | } kunit_hooks; |
27 | |
28 | /** |
29 | * kunit_get_current_test() - Return a pointer to the currently running |
30 | * KUnit test. |
31 | * |
32 | * If a KUnit test is running in the current task, returns a pointer to its |
33 | * associated struct kunit. This pointer can then be passed to any KUnit |
34 | * function or assertion. If no test is running (or a test is running in a |
35 | * different task), returns NULL. |
36 | * |
37 | * This function is safe to call even when KUnit is disabled. If CONFIG_KUNIT |
38 | * is not enabled, it will compile down to nothing and will return quickly no |
39 | * test is running. |
40 | */ |
41 | static inline struct kunit *kunit_get_current_test(void) |
42 | { |
43 | if (!static_branch_unlikely(&kunit_running)) |
44 | return NULL; |
45 | |
46 | return current->kunit_test; |
47 | } |
48 | |
49 | |
50 | /** |
51 | * kunit_fail_current_test() - If a KUnit test is running, fail it. |
52 | * |
53 | * If a KUnit test is running in the current task, mark that test as failed. |
54 | */ |
55 | #define kunit_fail_current_test(fmt, ...) do { \ |
56 | if (static_branch_unlikely(&kunit_running)) { \ |
57 | /* Guaranteed to be non-NULL when kunit_running true*/ \ |
58 | kunit_hooks.fail_current_test(__FILE__, __LINE__, \ |
59 | fmt, ##__VA_ARGS__); \ |
60 | } \ |
61 | } while (0) |
62 | |
63 | #else |
64 | |
65 | static inline struct kunit *kunit_get_current_test(void) { return NULL; } |
66 | |
67 | #define kunit_fail_current_test(fmt, ...) do {} while (0) |
68 | |
69 | #endif |
70 | |
71 | #endif /* _KUNIT_TEST_BUG_H */ |
72 | |