1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * kselftest.h:	low-level kselftest framework to include from
  4 *		selftest programs. When possible, please use
  5 *		kselftest_harness.h instead.
  6 *
  7 * Copyright (c) 2014 Shuah Khan <shuahkh@osg.samsung.com>
  8 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
  9 *
 10 * Using this API consists of first counting how many tests your code
 11 * has to run, and then starting up the reporting:
 12 *
 13 *     ksft_print_header();
 14 *     ksft_set_plan(total_number_of_tests);
 15 *
 16 * For each test, report any progress, debugging, etc with:
 17 *
 18 *     ksft_print_msg(fmt, ...);
 19 *
 20 * and finally report the pass/fail/skip/xfail state of the test with one of:
 21 *
 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, ...);
 28 *
 29 * When all tests are finished, clean up and exit the program with one of:
 30 *
 31 *    ksft_exit(condition);
 32 *    ksft_exit_pass();
 33 *    ksft_exit_fail();
 34 *
 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):
 38 *
 39 *    ksft_exit_fail_msg(fmt, ...);
 40 *
 41 */
 42#ifndef __KSELFTEST_H
 43#define __KSELFTEST_H
 44
 45#include <errno.h>
 46#include <stdlib.h>
 47#include <unistd.h>
 48#include <stdarg.h>
 49#include <stdio.h>
 50
 51/* define kselftest exit codes */
 52#define KSFT_PASS  0
 53#define KSFT_FAIL  1
 54#define KSFT_XFAIL 2
 55#define KSFT_XPASS 3
 56#define KSFT_SKIP  4
 57
 58/* counters */
 59struct ksft_count {
 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;
 66};
 67
 68static struct ksft_count ksft_cnt;
 69static unsigned int ksft_plan;
 70
 71static inline unsigned int ksft_test_num(void)
 72{
 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;
 76}
 77
 78static inline void ksft_inc_pass_cnt(void) { ksft_cnt.ksft_pass++; }
 79static inline void ksft_inc_fail_cnt(void) { ksft_cnt.ksft_fail++; }
 80static inline void ksft_inc_xfail_cnt(void) { ksft_cnt.ksft_xfail++; }
 81static inline void ksft_inc_xpass_cnt(void) { ksft_cnt.ksft_xpass++; }
 82static inline void ksft_inc_xskip_cnt(void) { ksft_cnt.ksft_xskip++; }
 83static inline void ksft_inc_error_cnt(void) { ksft_cnt.ksft_error++; }
 84
 85static inline int ksft_get_pass_cnt(void) { return ksft_cnt.ksft_pass; }
 86static inline int ksft_get_fail_cnt(void) { return ksft_cnt.ksft_fail; }
 87static inline int ksft_get_xfail_cnt(void) { return ksft_cnt.ksft_xfail; }
 88static inline int ksft_get_xpass_cnt(void) { return ksft_cnt.ksft_xpass; }
 89static inline int ksft_get_xskip_cnt(void) { return ksft_cnt.ksft_xskip; }
 90static inline int ksft_get_error_cnt(void) { return ksft_cnt.ksft_error; }
 91
 92static inline void ksft_print_header(void)
 93{
 94	if (!(getenv("KSFT_TAP_LEVEL")))
 95		printf("TAP version 13\n");
 96}
 97
 98static inline void ksft_set_plan(unsigned int plan)
 99{
100	ksft_plan = plan;
101	printf("1..%d\n", ksft_plan);
102}
103
104static inline void ksft_print_cnts(void)
105{
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);
113}
114
115static inline void ksft_print_msg(const char *msg, ...)
116{
117	int saved_errno = errno;
118	va_list args;
119
120	va_start(args, msg);
121	printf("# ");
122	errno = saved_errno;
123	vprintf(msg, args);
124	va_end(args);
125}
126
127static inline void ksft_test_result_pass(const char *msg, ...)
128{
129	int saved_errno = errno;
130	va_list args;
131
132	ksft_cnt.ksft_pass++;
133
134	va_start(args, msg);
135	printf("ok %d ", ksft_test_num());
136	errno = saved_errno;
137	vprintf(msg, args);
138	va_end(args);
139}
140
141static inline void ksft_test_result_fail(const char *msg, ...)
142{
143	int saved_errno = errno;
144	va_list args;
145
146	ksft_cnt.ksft_fail++;
147
148	va_start(args, msg);
149	printf("not ok %d ", ksft_test_num());
150	errno = saved_errno;
151	vprintf(msg, args);
152	va_end(args);
153}
154
155/**
156 * ksft_test_result() - Report test success based on truth of condition
157 *
158 * @condition: if true, report test success, otherwise failure.
159 */
160#define ksft_test_result(condition, fmt, ...) do {	\
161	if (!!(condition))				\
162		ksft_test_result_pass(fmt, ##__VA_ARGS__);\
163	else						\
164		ksft_test_result_fail(fmt, ##__VA_ARGS__);\
165	} while (0)
166
167static inline void ksft_test_result_xfail(const char *msg, ...)
168{
169	int saved_errno = errno;
170	va_list args;
171
172	ksft_cnt.ksft_xfail++;
173
174	va_start(args, msg);
175	printf("ok %d # XFAIL ", ksft_test_num());
176	errno = saved_errno;
177	vprintf(msg, args);
178	va_end(args);
179}
180
181static inline void ksft_test_result_skip(const char *msg, ...)
182{
183	int saved_errno = errno;
184	va_list args;
185
186	ksft_cnt.ksft_xskip++;
187
188	va_start(args, msg);
189	printf("ok %d # SKIP ", ksft_test_num());
190	errno = saved_errno;
191	vprintf(msg, args);
192	va_end(args);
193}
194
195/* TODO: how does "error" differ from "fail" or "skip"? */
196static inline void ksft_test_result_error(const char *msg, ...)
197{
198	int saved_errno = errno;
199	va_list args;
200
201	ksft_cnt.ksft_error++;
202
203	va_start(args, msg);
204	printf("not ok %d # error ", ksft_test_num());
205	errno = saved_errno;
206	vprintf(msg, args);
207	va_end(args);
208}
209
210static inline int ksft_exit_pass(void)
211{
212	ksft_print_cnts();
213	exit(KSFT_PASS);
214}
215
216static inline int ksft_exit_fail(void)
217{
218	ksft_print_cnts();
219	exit(KSFT_FAIL);
220}
221
222/**
223 * ksft_exit() - Exit selftest based on truth of condition
224 *
225 * @condition: if true, exit self test with success, otherwise fail.
226 */
227#define ksft_exit(condition) do {	\
228	if (!!(condition))		\
229		ksft_exit_pass();	\
230	else				\
231		ksft_exit_fail();	\
232	} while (0)
233
234static inline int ksft_exit_fail_msg(const char *msg, ...)
235{
236	int saved_errno = errno;
237	va_list args;
238
239	va_start(args, msg);
240	printf("Bail out! ");
241	errno = saved_errno;
242	vprintf(msg, args);
243	va_end(args);
244
245	ksft_print_cnts();
246	exit(KSFT_FAIL);
247}
248
249static inline int ksft_exit_xfail(void)
250{
251	ksft_print_cnts();
252	exit(KSFT_XFAIL);
253}
254
255static inline int ksft_exit_xpass(void)
256{
257	ksft_print_cnts();
258	exit(KSFT_XPASS);
259}
260
261static inline int ksft_exit_skip(const char *msg, ...)
262{
263	int saved_errno = errno;
264	va_list args;
265
266	va_start(args, msg);
267
268	/*
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.
273	 */
274	if (ksft_plan || ksft_test_num()) {
275		ksft_cnt.ksft_xskip++;
276		printf("ok %d # SKIP ", 1 + ksft_test_num());
277	} else {
278		printf("1..0 # SKIP ");
279	}
280	if (msg) {
281		errno = saved_errno;
282		vprintf(msg, args);
283		va_end(args);
284	}
285	if (ksft_test_num())
286		ksft_print_cnts();
287	exit(KSFT_SKIP);
288}
289
290#endif /* __KSELFTEST_H */