include/kunit/test-bug.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * KUnit API allowing dynamic analysis tools to interact with KUnit 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 #if IS_BUILTIN(CONFIG_KUNIT)
  13
  14 #include <linux/jump_label.h> /* For static branch */
  15 #include <linux/sched.h>
  16
  17 /* Static key if KUnit is running any tests. */
  18 DECLARE_STATIC_KEY_FALSE(kunit_running);
  19
  20 /**
  21  * kunit_get_current_test() - Return a pointer to the currently running
  22  *                            KUnit test.
  23  *
  24  * If a KUnit test is running in the current task, returns a pointer to its
  25  * associated struct kunit. This pointer can then be passed to any KUnit
  26  * function or assertion. If no test is running (or a test is running in a
  27  * different task), returns NULL.
  28  *
  29  * This function is safe to call even when KUnit is disabled. If CONFIG_KUNIT
  30  * is not enabled, it will compile down to nothing and will return quickly no
  31  * test is running.
  32  */
  33 static inline struct kunit *kunit_get_current_test(void)
  34 {
  35         if (!static_branch_unlikely(&kunit_running))
  36                 return NULL;
  37
  38         return current->kunit_test;
  39 }
  40
  41
  42 /**
  43  * kunit_fail_current_test() - If a KUnit test is running, fail it.
  44  *
  45  * If a KUnit test is running in the current task, mark that test as failed.
  46  *
  47  * This macro will only work if KUnit is built-in (though the tests
  48  * themselves can be modules). Otherwise, it compiles down to nothing.
  49  */
  50 #define kunit_fail_current_test(fmt, ...) do {                                  \
  51                 if (static_branch_unlikely(&kunit_running)) {                   \
  52                         __kunit_fail_current_test(__FILE__, __LINE__,           \
  53                                                   fmt, ##__VA_ARGS__);          \
  54                 }                                                               \
  55         } while (0)
  56
  57
  58 extern __printf(3, 4) void __kunit_fail_current_test(const char *file, int line,
  59                                                     const char *fmt, ...);
  60
  61 #else
  62
  63 static inline struct kunit *kunit_get_current_test(void) { return NULL; }
  64
  65 /* We define this with an empty helper function so format string warnings work */
  66 #define kunit_fail_current_test(fmt, ...) \
  67                 __kunit_fail_current_test(__FILE__, __LINE__, fmt, ##__VA_ARGS__)
  68
  69 static inline __printf(3, 4) void __kunit_fail_current_test(const char *file, int line,
  70                                                             const char *fmt, ...)
  71 {
  72 }
  73
  74 #endif
  75
  76 #endif /* _KUNIT_TEST_BUG_H */