Line data    Source code

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