1/* SPDX-License-Identifier: GPL-2.0+ */
2#ifndef __KSELFTEST_MODULE_H
3#define __KSELFTEST_MODULE_H
4
5#include <linux/module.h>
6#include <linux/panic.h>
7
8/*
9 * Test framework for writing test modules to be loaded by kselftest.
10 * See Documentation/dev-tools/kselftest.rst for an example test module.
11 */
12
13#define KSTM_MODULE_GLOBALS() \
14static unsigned int total_tests __initdata; \
15static unsigned int failed_tests __initdata; \
16static unsigned int skipped_tests __initdata
17
18#define KSTM_CHECK_ZERO(x) do { \
19 total_tests++; \
20 if (x) { \
21 pr_warn("TC failed at %s:%d\n", __func__, __LINE__); \
22 failed_tests++; \
23 } \
24} while (0)
25
26static inline int kstm_report(unsigned int total_tests, unsigned int failed_tests,
27 unsigned int skipped_tests)
28{
29 if (failed_tests == 0) {
30 if (skipped_tests) {
31 pr_info("skipped %u tests\n", skipped_tests);
32 pr_info("remaining %u tests passed\n", total_tests);
33 } else
34 pr_info("all %u tests passed\n", total_tests);
35 } else
36 pr_warn("failed %u out of %u tests\n", failed_tests, total_tests);
37
38 return failed_tests ? -EINVAL : 0;
39}
40
41#define KSTM_MODULE_LOADERS(__module) \
42static int __init __module##_init(void) \
43{ \
44 pr_info("loaded.\n"); \
45 add_taint(TAINT_TEST, LOCKDEP_STILL_OK); \
46 selftest(); \
47 return kstm_report(total_tests, failed_tests, skipped_tests); \
48} \
49static void __exit __module##_exit(void) \
50{ \
51 pr_info("unloaded.\n"); \
52} \
53module_init(__module##_init); \
54module_exit(__module##_exit)
55
56MODULE_INFO(test, "Y");
57
58#endif /* __KSELFTEST_MODULE_H */
59

source code of linux/tools/testing/selftests/kselftest_module.h