1 /* SPDX-License-Identifier: GPL-2.0 */
3 * kselftest.h: low-level kselftest framework to include from
4 * selftest programs. When possible, please use
5 * kselftest_harness.h instead.
7 * Copyright (c) 2014 Shuah Khan <shuahkh@osg.samsung.com>
8 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
10 * Using this API consists of first counting how many tests your code
11 * has to run, and then starting up the reporting:
13 * ksft_print_header();
14 * ksft_set_plan(total_number_of_tests);
16 * For each test, report any progress, debugging, etc with:
18 * ksft_print_msg(fmt, ...);
20 * and finally report the pass/fail/skip/xfail state of the test with one of:
22 * ksft_test_result(condition, fmt, ...);
23 * ksft_test_result_pass(fmt, ...);
24 * ksft_test_result_fail(fmt, ...);
25 * ksft_test_result_skip(fmt, ...);
26 * ksft_test_result_xfail(fmt, ...);
27 * ksft_test_result_error(fmt, ...);
29 * When all tests are finished, clean up and exit the program with one of:
31 * ksft_exit(condition);
35 * If the program wants to report details on why the entire program has
36 * failed, it can instead exit with a message (this is usually done when
37 * the program is aborting before finishing all tests):
39 * ksft_exit_fail_msg(fmt, ...);
51 /* define kselftest exit codes */
60 unsigned int ksft_pass
;
61 unsigned int ksft_fail
;
62 unsigned int ksft_xfail
;
63 unsigned int ksft_xpass
;
64 unsigned int ksft_xskip
;
65 unsigned int ksft_error
;
68 static struct ksft_count ksft_cnt
;
69 static unsigned int ksft_plan
;
71 static inline unsigned int ksft_test_num(void)
73 return ksft_cnt
.ksft_pass
+ ksft_cnt
.ksft_fail
+
74 ksft_cnt
.ksft_xfail
+ ksft_cnt
.ksft_xpass
+
75 ksft_cnt
.ksft_xskip
+ ksft_cnt
.ksft_error
;
78 static inline void ksft_inc_pass_cnt(void) { ksft_cnt
.ksft_pass
++; }
79 static inline void ksft_inc_fail_cnt(void) { ksft_cnt
.ksft_fail
++; }
80 static inline void ksft_inc_xfail_cnt(void) { ksft_cnt
.ksft_xfail
++; }
81 static inline void ksft_inc_xpass_cnt(void) { ksft_cnt
.ksft_xpass
++; }
82 static inline void ksft_inc_xskip_cnt(void) { ksft_cnt
.ksft_xskip
++; }
83 static inline void ksft_inc_error_cnt(void) { ksft_cnt
.ksft_error
++; }
85 static inline int ksft_get_pass_cnt(void) { return ksft_cnt
.ksft_pass
; }
86 static inline int ksft_get_fail_cnt(void) { return ksft_cnt
.ksft_fail
; }
87 static inline int ksft_get_xfail_cnt(void) { return ksft_cnt
.ksft_xfail
; }
88 static inline int ksft_get_xpass_cnt(void) { return ksft_cnt
.ksft_xpass
; }
89 static inline int ksft_get_xskip_cnt(void) { return ksft_cnt
.ksft_xskip
; }
90 static inline int ksft_get_error_cnt(void) { return ksft_cnt
.ksft_error
; }
92 static inline void ksft_print_header(void)
94 if (!(getenv("KSFT_TAP_LEVEL")))
95 printf("TAP version 13\n");
98 static inline void ksft_set_plan(unsigned int plan
)
101 printf("1..%d\n", ksft_plan
);
104 static inline void ksft_print_cnts(void)
106 if (ksft_plan
!= ksft_test_num())
107 printf("# Planned tests != run tests (%u != %u)\n",
108 ksft_plan
, ksft_test_num());
109 printf("# Totals: pass:%d fail:%d xfail:%d xpass:%d skip:%d error:%d\n",
110 ksft_cnt
.ksft_pass
, ksft_cnt
.ksft_fail
,
111 ksft_cnt
.ksft_xfail
, ksft_cnt
.ksft_xpass
,
112 ksft_cnt
.ksft_xskip
, ksft_cnt
.ksft_error
);
115 static inline void ksft_print_msg(const char *msg
, ...)
117 int saved_errno
= errno
;
127 static inline void ksft_test_result_pass(const char *msg
, ...)
129 int saved_errno
= errno
;
132 ksft_cnt
.ksft_pass
++;
135 printf("ok %d ", ksft_test_num());
141 static inline void ksft_test_result_fail(const char *msg
, ...)
143 int saved_errno
= errno
;
146 ksft_cnt
.ksft_fail
++;
149 printf("not ok %d ", ksft_test_num());
156 * ksft_test_result() - Report test success based on truth of condition
158 * @condition: if true, report test success, otherwise failure.
160 #define ksft_test_result(condition, fmt, ...) do { \
162 ksft_test_result_pass(fmt, ##__VA_ARGS__);\
164 ksft_test_result_fail(fmt, ##__VA_ARGS__);\
167 static inline void ksft_test_result_xfail(const char *msg
, ...)
169 int saved_errno
= errno
;
172 ksft_cnt
.ksft_xfail
++;
175 printf("ok %d # XFAIL ", ksft_test_num());
181 static inline void ksft_test_result_skip(const char *msg
, ...)
183 int saved_errno
= errno
;
186 ksft_cnt
.ksft_xskip
++;
189 printf("ok %d # SKIP ", ksft_test_num());
195 /* TODO: how does "error" differ from "fail" or "skip"? */
196 static inline void ksft_test_result_error(const char *msg
, ...)
198 int saved_errno
= errno
;
201 ksft_cnt
.ksft_error
++;
204 printf("not ok %d # error ", ksft_test_num());
210 static inline int ksft_exit_pass(void)
216 static inline int ksft_exit_fail(void)
223 * ksft_exit() - Exit selftest based on truth of condition
225 * @condition: if true, exit self test with success, otherwise fail.
227 #define ksft_exit(condition) do { \
234 static inline int ksft_exit_fail_msg(const char *msg
, ...)
236 int saved_errno
= errno
;
240 printf("Bail out! ");
249 static inline int ksft_exit_xfail(void)
255 static inline int ksft_exit_xpass(void)
261 static inline int ksft_exit_skip(const char *msg
, ...)
263 int saved_errno
= errno
;
269 * FIXME: several tests misuse ksft_exit_skip so produce
270 * something sensible if some tests have already been run
271 * or a plan has been printed. Those tests should use
272 * ksft_test_result_skip or ksft_exit_fail_msg instead.
274 if (ksft_plan
|| ksft_test_num()) {
275 ksft_cnt
.ksft_xskip
++;
276 printf("ok %d # SKIP ", 1 + ksft_test_num());
278 printf("1..0 # SKIP ");
290 #endif /* __KSELFTEST_H */