1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
4 *
5 * kselftest_harness.h: simple C unit test helper.
6 *
7 * See documentation in Documentation/dev-tools/kselftest.rst
8 *
9 * API inspired by code.google.com/p/googletest
10 */
11
12 /**
13 * DOC: example
14 *
15 * .. code-block:: c
16 *
17 * #include "../kselftest_harness.h"
18 *
19 * TEST(standalone_test) {
20 * do_some_stuff;
21 * EXPECT_GT(10, stuff) {
22 * stuff_state_t state;
23 * enumerate_stuff_state(&state);
24 * TH_LOG("expectation failed with state: %s", state.msg);
25 * }
26 * more_stuff;
27 * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
28 * last_stuff;
29 * EXPECT_EQ(0, last_stuff);
30 * }
31 *
32 * FIXTURE(my_fixture) {
33 * mytype_t *data;
34 * int awesomeness_level;
35 * };
36 * FIXTURE_SETUP(my_fixture) {
37 * self->data = mytype_new();
38 * ASSERT_NE(NULL, self->data);
39 * }
40 * FIXTURE_TEARDOWN(my_fixture) {
41 * mytype_free(self->data);
42 * }
43 * TEST_F(my_fixture, data_is_good) {
44 * EXPECT_EQ(1, is_my_data_good(self->data));
45 * }
46 *
47 * TEST_HARNESS_MAIN
48 */
49
50 #ifndef __KSELFTEST_HARNESS_H
51 #define __KSELFTEST_HARNESS_H
52
53 #ifndef _GNU_SOURCE
54 #define _GNU_SOURCE
55 #endif
56 #include <asm/types.h>
57 #include <errno.h>
58 #include <stdbool.h>
59 #include <stdint.h>
60 #include <stdio.h>
61 #include <stdlib.h>
62 #include <string.h>
63 #include <sys/mman.h>
64 #include <sys/types.h>
65 #include <sys/wait.h>
66 #include <unistd.h>
67
68 #include "kselftest.h"
69
70 #define TEST_TIMEOUT_DEFAULT 30
71
72 /* Utilities exposed to the test definitions */
73 #ifndef TH_LOG_STREAM
74 # define TH_LOG_STREAM stderr
75 #endif
76
77 #ifndef TH_LOG_ENABLED
78 # define TH_LOG_ENABLED 1
79 #endif
80
81 /**
82 * TH_LOG()
83 *
84 * @fmt: format string
85 * @...: optional arguments
86 *
87 * .. code-block:: c
88 *
89 * TH_LOG(format, ...)
90 *
91 * Optional debug logging function available for use in tests.
92 * Logging may be enabled or disabled by defining TH_LOG_ENABLED.
93 * E.g., #define TH_LOG_ENABLED 1
94 *
95 * If no definition is provided, logging is enabled by default.
96 *
97 * If there is no way to print an error message for the process running the
98 * test (e.g. not allowed to write to stderr), it is still possible to get the
99 * ASSERT_* number for which the test failed. This behavior can be enabled by
100 * writing `_metadata->no_print = true;` before the check sequence that is
101 * unable to print. When an error occur, instead of printing an error message
102 * and calling `abort(3)`, the test process call `_exit(2)` with the assert
103 * number as argument, which is then printed by the parent process.
104 */
105 #define TH_LOG(fmt, ...) do { \
106 if (TH_LOG_ENABLED) \
107 __TH_LOG(fmt, ##__VA_ARGS__); \
108 } while (0)
109
110 /* Unconditional logger for internal use. */
111 #define __TH_LOG(fmt, ...) \
112 fprintf(TH_LOG_STREAM, "# %s:%d:%s:" fmt "\n", \
113 __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
114
115 /**
116 * SKIP()
117 *
118 * @statement: statement to run after reporting SKIP
119 * @fmt: format string
120 * @...: optional arguments
121 *
122 * .. code-block:: c
123 *
124 * SKIP(statement, fmt, ...);
125 *
126 * This forces a "pass" after reporting why something is being skipped
127 * and runs "statement", which is usually "return" or "goto skip".
128 */
129 #define SKIP(statement, fmt, ...) do { \
130 snprintf(_metadata->results->reason, \
131 sizeof(_metadata->results->reason), fmt, ##__VA_ARGS__); \
132 if (TH_LOG_ENABLED) { \
133 fprintf(TH_LOG_STREAM, "# SKIP %s\n", \
134 _metadata->results->reason); \
135 } \
136 _metadata->passed = 1; \
137 _metadata->skip = 1; \
138 _metadata->trigger = 0; \
139 statement; \
140 } while (0)
141
142 /**
143 * TEST() - Defines the test function and creates the registration
144 * stub
145 *
146 * @test_name: test name
147 *
148 * .. code-block:: c
149 *
150 * TEST(name) { implementation }
151 *
152 * Defines a test by name.
153 * Names must be unique and tests must not be run in parallel. The
154 * implementation containing block is a function and scoping should be treated
155 * as such. Returning early may be performed with a bare "return;" statement.
156 *
157 * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
158 */
159 #define TEST(test_name) __TEST_IMPL(test_name, -1)
160
161 /**
162 * TEST_SIGNAL()
163 *
164 * @test_name: test name
165 * @signal: signal number
166 *
167 * .. code-block:: c
168 *
169 * TEST_SIGNAL(name, signal) { implementation }
170 *
171 * Defines a test by name and the expected term signal.
172 * Names must be unique and tests must not be run in parallel. The
173 * implementation containing block is a function and scoping should be treated
174 * as such. Returning early may be performed with a bare "return;" statement.
175 *
176 * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
177 */
178 #define TEST_SIGNAL(test_name, signal) __TEST_IMPL(test_name, signal)
179
180 #define __TEST_IMPL(test_name, _signal) \
181 static void test_name(struct __test_metadata *_metadata); \
182 static inline void wrapper_##test_name( \
183 struct __test_metadata *_metadata, \
184 struct __fixture_variant_metadata *variant) \
185 { \
186 test_name(_metadata); \
187 } \
188 static struct __test_metadata _##test_name##_object = \
189 { .name = #test_name, \
190 .fn = &wrapper_##test_name, \
191 .fixture = &_fixture_global, \
192 .termsig = _signal, \
193 .timeout = TEST_TIMEOUT_DEFAULT, }; \
194 static void __attribute__((constructor)) _register_##test_name(void) \
195 { \
196 __register_test(&_##test_name##_object); \
197 } \
198 static void test_name( \
199 struct __test_metadata __attribute__((unused)) *_metadata)
200
201 /**
202 * FIXTURE_DATA() - Wraps the struct name so we have one less
203 * argument to pass around
204 *
205 * @datatype_name: datatype name
206 *
207 * .. code-block:: c
208 *
209 * FIXTURE_DATA(datatype_name)
210 *
211 * Almost always, you want just FIXTURE() instead (see below).
212 * This call may be used when the type of the fixture data
213 * is needed. In general, this should not be needed unless
214 * the *self* is being passed to a helper directly.
215 */
216 #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
217
218 /**
219 * FIXTURE() - Called once per fixture to setup the data and
220 * register
221 *
222 * @fixture_name: fixture name
223 *
224 * .. code-block:: c
225 *
226 * FIXTURE(fixture_name) {
227 * type property1;
228 * ...
229 * };
230 *
231 * Defines the data provided to TEST_F()-defined tests as *self*. It should be
232 * populated and cleaned up using FIXTURE_SETUP() and FIXTURE_TEARDOWN().
233 */
234 #define FIXTURE(fixture_name) \
235 FIXTURE_VARIANT(fixture_name); \
236 static struct __fixture_metadata _##fixture_name##_fixture_object = \
237 { .name = #fixture_name, }; \
238 static void __attribute__((constructor)) \
239 _register_##fixture_name##_data(void) \
240 { \
241 __register_fixture(&_##fixture_name##_fixture_object); \
242 } \
243 FIXTURE_DATA(fixture_name)
244
245 /**
246 * FIXTURE_SETUP() - Prepares the setup function for the fixture.
247 * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
248 *
249 * @fixture_name: fixture name
250 *
251 * .. code-block:: c
252 *
253 * FIXTURE_SETUP(fixture_name) { implementation }
254 *
255 * Populates the required "setup" function for a fixture. An instance of the
256 * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
257 * implementation.
258 *
259 * ASSERT_* are valid for use in this context and will prempt the execution
260 * of any dependent fixture tests.
261 *
262 * A bare "return;" statement may be used to return early.
263 */
264 #define FIXTURE_SETUP(fixture_name) \
265 void fixture_name##_setup( \
266 struct __test_metadata __attribute__((unused)) *_metadata, \
267 FIXTURE_DATA(fixture_name) __attribute__((unused)) *self, \
268 const FIXTURE_VARIANT(fixture_name) \
269 __attribute__((unused)) *variant)
270
271 /**
272 * FIXTURE_TEARDOWN()
273 * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
274 *
275 * @fixture_name: fixture name
276 *
277 * .. code-block:: c
278 *
279 * FIXTURE_TEARDOWN(fixture_name) { implementation }
280 *
281 * Populates the required "teardown" function for a fixture. An instance of the
282 * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
283 * implementation to clean up.
284 *
285 * A bare "return;" statement may be used to return early.
286 */
287 #define FIXTURE_TEARDOWN(fixture_name) \
288 void fixture_name##_teardown( \
289 struct __test_metadata __attribute__((unused)) *_metadata, \
290 FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
291
292 /**
293 * FIXTURE_VARIANT() - Optionally called once per fixture
294 * to declare fixture variant
295 *
296 * @fixture_name: fixture name
297 *
298 * .. code-block:: c
299 *
300 * FIXTURE_VARIANT(fixture_name) {
301 * type property1;
302 * ...
303 * };
304 *
305 * Defines type of constant parameters provided to FIXTURE_SETUP() and TEST_F()
306 * as *variant*. Variants allow the same tests to be run with different
307 * arguments.
308 */
309 #define FIXTURE_VARIANT(fixture_name) struct _fixture_variant_##fixture_name
310
311 /**
312 * FIXTURE_VARIANT_ADD() - Called once per fixture
313 * variant to setup and register the data
314 *
315 * @fixture_name: fixture name
316 * @variant_name: name of the parameter set
317 *
318 * .. code-block:: c
319 *
320 * FIXTURE_VARIANT_ADD(fixture_name, variant_name) {
321 * .property1 = val1,
322 * ...
323 * };
324 *
325 * Defines a variant of the test fixture, provided to FIXTURE_SETUP() and
326 * TEST_F() as *variant*. Tests of each fixture will be run once for each
327 * variant.
328 */
329 #define FIXTURE_VARIANT_ADD(fixture_name, variant_name) \
330 extern FIXTURE_VARIANT(fixture_name) \
331 _##fixture_name##_##variant_name##_variant; \
332 static struct __fixture_variant_metadata \
333 _##fixture_name##_##variant_name##_object = \
334 { .name = #variant_name, \
335 .data = &_##fixture_name##_##variant_name##_variant}; \
336 static void __attribute__((constructor)) \
337 _register_##fixture_name##_##variant_name(void) \
338 { \
339 __register_fixture_variant(&_##fixture_name##_fixture_object, \
340 &_##fixture_name##_##variant_name##_object); \
341 } \
342 FIXTURE_VARIANT(fixture_name) \
343 _##fixture_name##_##variant_name##_variant =
344
345 /**
346 * TEST_F() - Emits test registration and helpers for
347 * fixture-based test cases
348 *
349 * @fixture_name: fixture name
350 * @test_name: test name
351 *
352 * .. code-block:: c
353 *
354 * TEST_F(fixture, name) { implementation }
355 *
356 * Defines a test that depends on a fixture (e.g., is part of a test case).
357 * Very similar to TEST() except that *self* is the setup instance of fixture's
358 * datatype exposed for use by the implementation.
359 *
360 * Warning: use of ASSERT_* here will skip TEARDOWN.
361 */
362 /* TODO(wad) register fixtures on dedicated test lists. */
363 #define TEST_F(fixture_name, test_name) \
364 __TEST_F_IMPL(fixture_name, test_name, -1, TEST_TIMEOUT_DEFAULT)
365
366 #define TEST_F_SIGNAL(fixture_name, test_name, signal) \
367 __TEST_F_IMPL(fixture_name, test_name, signal, TEST_TIMEOUT_DEFAULT)
368
369 #define TEST_F_TIMEOUT(fixture_name, test_name, timeout) \
370 __TEST_F_IMPL(fixture_name, test_name, -1, timeout)
371
372 #define __TEST_F_IMPL(fixture_name, test_name, signal, tmout) \
373 static void fixture_name##_##test_name( \
374 struct __test_metadata *_metadata, \
375 FIXTURE_DATA(fixture_name) *self, \
376 const FIXTURE_VARIANT(fixture_name) *variant); \
377 static inline void wrapper_##fixture_name##_##test_name( \
378 struct __test_metadata *_metadata, \
379 struct __fixture_variant_metadata *variant) \
380 { \
381 /* fixture data is alloced, setup, and torn down per call. */ \
382 FIXTURE_DATA(fixture_name) self; \
383 memset(&self, 0, sizeof(FIXTURE_DATA(fixture_name))); \
384 fixture_name##_setup(_metadata, &self, variant->data); \
385 /* Let setup failure terminate early. */ \
386 if (!_metadata->passed) \
387 return; \
388 fixture_name##_##test_name(_metadata, &self, variant->data); \
389 fixture_name##_teardown(_metadata, &self); \
390 } \
391 static struct __test_metadata \
392 _##fixture_name##_##test_name##_object = { \
393 .name = #test_name, \
394 .fn = &wrapper_##fixture_name##_##test_name, \
395 .fixture = &_##fixture_name##_fixture_object, \
396 .termsig = signal, \
397 .timeout = tmout, \
398 }; \
399 static void __attribute__((constructor)) \
400 _register_##fixture_name##_##test_name(void) \
401 { \
402 __register_test(&_##fixture_name##_##test_name##_object); \
403 } \
404 static void fixture_name##_##test_name( \
405 struct __test_metadata __attribute__((unused)) *_metadata, \
406 FIXTURE_DATA(fixture_name) __attribute__((unused)) *self, \
407 const FIXTURE_VARIANT(fixture_name) \
408 __attribute__((unused)) *variant)
409
410 /**
411 * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
412 *
413 * .. code-block:: c
414 *
415 * TEST_HARNESS_MAIN
416 *
417 * Use once to append a main() to the test file.
418 */
419 #define TEST_HARNESS_MAIN \
420 static void __attribute__((constructor)) \
421 __constructor_order_last(void) \
422 { \
423 if (!__constructor_order) \
424 __constructor_order = _CONSTRUCTOR_ORDER_BACKWARD; \
425 } \
426 int main(int argc, char **argv) { \
427 return test_harness_run(argc, argv); \
428 }
429
430 /**
431 * DOC: operators
432 *
433 * Operators for use in TEST() and TEST_F().
434 * ASSERT_* calls will stop test execution immediately.
435 * EXPECT_* calls will emit a failure warning, note it, and continue.
436 */
437
438 /**
439 * ASSERT_EQ()
440 *
441 * @expected: expected value
442 * @seen: measured value
443 *
444 * ASSERT_EQ(expected, measured): expected == measured
445 */
446 #define ASSERT_EQ(expected, seen) \
447 __EXPECT(expected, #expected, seen, #seen, ==, 1)
448
449 /**
450 * ASSERT_NE()
451 *
452 * @expected: expected value
453 * @seen: measured value
454 *
455 * ASSERT_NE(expected, measured): expected != measured
456 */
457 #define ASSERT_NE(expected, seen) \
458 __EXPECT(expected, #expected, seen, #seen, !=, 1)
459
460 /**
461 * ASSERT_LT()
462 *
463 * @expected: expected value
464 * @seen: measured value
465 *
466 * ASSERT_LT(expected, measured): expected < measured
467 */
468 #define ASSERT_LT(expected, seen) \
469 __EXPECT(expected, #expected, seen, #seen, <, 1)
470
471 /**
472 * ASSERT_LE()
473 *
474 * @expected: expected value
475 * @seen: measured value
476 *
477 * ASSERT_LE(expected, measured): expected <= measured
478 */
479 #define ASSERT_LE(expected, seen) \
480 __EXPECT(expected, #expected, seen, #seen, <=, 1)
481
482 /**
483 * ASSERT_GT()
484 *
485 * @expected: expected value
486 * @seen: measured value
487 *
488 * ASSERT_GT(expected, measured): expected > measured
489 */
490 #define ASSERT_GT(expected, seen) \
491 __EXPECT(expected, #expected, seen, #seen, >, 1)
492
493 /**
494 * ASSERT_GE()
495 *
496 * @expected: expected value
497 * @seen: measured value
498 *
499 * ASSERT_GE(expected, measured): expected >= measured
500 */
501 #define ASSERT_GE(expected, seen) \
502 __EXPECT(expected, #expected, seen, #seen, >=, 1)
503
504 /**
505 * ASSERT_NULL()
506 *
507 * @seen: measured value
508 *
509 * ASSERT_NULL(measured): NULL == measured
510 */
511 #define ASSERT_NULL(seen) \
512 __EXPECT(NULL, "NULL", seen, #seen, ==, 1)
513
514 /**
515 * ASSERT_TRUE()
516 *
517 * @seen: measured value
518 *
519 * ASSERT_TRUE(measured): measured != 0
520 */
521 #define ASSERT_TRUE(seen) \
522 __EXPECT(0, "0", seen, #seen, !=, 1)
523
524 /**
525 * ASSERT_FALSE()
526 *
527 * @seen: measured value
528 *
529 * ASSERT_FALSE(measured): measured == 0
530 */
531 #define ASSERT_FALSE(seen) \
532 __EXPECT(0, "0", seen, #seen, ==, 1)
533
534 /**
535 * ASSERT_STREQ()
536 *
537 * @expected: expected value
538 * @seen: measured value
539 *
540 * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
541 */
542 #define ASSERT_STREQ(expected, seen) \
543 __EXPECT_STR(expected, seen, ==, 1)
544
545 /**
546 * ASSERT_STRNE()
547 *
548 * @expected: expected value
549 * @seen: measured value
550 *
551 * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
552 */
553 #define ASSERT_STRNE(expected, seen) \
554 __EXPECT_STR(expected, seen, !=, 1)
555
556 /**
557 * EXPECT_EQ()
558 *
559 * @expected: expected value
560 * @seen: measured value
561 *
562 * EXPECT_EQ(expected, measured): expected == measured
563 */
564 #define EXPECT_EQ(expected, seen) \
565 __EXPECT(expected, #expected, seen, #seen, ==, 0)
566
567 /**
568 * EXPECT_NE()
569 *
570 * @expected: expected value
571 * @seen: measured value
572 *
573 * EXPECT_NE(expected, measured): expected != measured
574 */
575 #define EXPECT_NE(expected, seen) \
576 __EXPECT(expected, #expected, seen, #seen, !=, 0)
577
578 /**
579 * EXPECT_LT()
580 *
581 * @expected: expected value
582 * @seen: measured value
583 *
584 * EXPECT_LT(expected, measured): expected < measured
585 */
586 #define EXPECT_LT(expected, seen) \
587 __EXPECT(expected, #expected, seen, #seen, <, 0)
588
589 /**
590 * EXPECT_LE()
591 *
592 * @expected: expected value
593 * @seen: measured value
594 *
595 * EXPECT_LE(expected, measured): expected <= measured
596 */
597 #define EXPECT_LE(expected, seen) \
598 __EXPECT(expected, #expected, seen, #seen, <=, 0)
599
600 /**
601 * EXPECT_GT()
602 *
603 * @expected: expected value
604 * @seen: measured value
605 *
606 * EXPECT_GT(expected, measured): expected > measured
607 */
608 #define EXPECT_GT(expected, seen) \
609 __EXPECT(expected, #expected, seen, #seen, >, 0)
610
611 /**
612 * EXPECT_GE()
613 *
614 * @expected: expected value
615 * @seen: measured value
616 *
617 * EXPECT_GE(expected, measured): expected >= measured
618 */
619 #define EXPECT_GE(expected, seen) \
620 __EXPECT(expected, #expected, seen, #seen, >=, 0)
621
622 /**
623 * EXPECT_NULL()
624 *
625 * @seen: measured value
626 *
627 * EXPECT_NULL(measured): NULL == measured
628 */
629 #define EXPECT_NULL(seen) \
630 __EXPECT(NULL, "NULL", seen, #seen, ==, 0)
631
632 /**
633 * EXPECT_TRUE()
634 *
635 * @seen: measured value
636 *
637 * EXPECT_TRUE(measured): 0 != measured
638 */
639 #define EXPECT_TRUE(seen) \
640 __EXPECT(0, "0", seen, #seen, !=, 0)
641
642 /**
643 * EXPECT_FALSE()
644 *
645 * @seen: measured value
646 *
647 * EXPECT_FALSE(measured): 0 == measured
648 */
649 #define EXPECT_FALSE(seen) \
650 __EXPECT(0, "0", seen, #seen, ==, 0)
651
652 /**
653 * EXPECT_STREQ()
654 *
655 * @expected: expected value
656 * @seen: measured value
657 *
658 * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
659 */
660 #define EXPECT_STREQ(expected, seen) \
661 __EXPECT_STR(expected, seen, ==, 0)
662
663 /**
664 * EXPECT_STRNE()
665 *
666 * @expected: expected value
667 * @seen: measured value
668 *
669 * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
670 */
671 #define EXPECT_STRNE(expected, seen) \
672 __EXPECT_STR(expected, seen, !=, 0)
673
674 #ifndef ARRAY_SIZE
675 #define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
676 #endif
677
678 /* Support an optional handler after and ASSERT_* or EXPECT_*. The approach is
679 * not thread-safe, but it should be fine in most sane test scenarios.
680 *
681 * Using __bail(), which optionally abort()s, is the easiest way to early
682 * return while still providing an optional block to the API consumer.
683 */
684 #define OPTIONAL_HANDLER(_assert) \
685 for (; _metadata->trigger; _metadata->trigger = \
686 __bail(_assert, _metadata->no_print, _metadata->step))
687
688 #define __INC_STEP(_metadata) \
689 /* Keep "step" below 255 (which is used for "SKIP" reporting). */ \
690 if (_metadata->passed && _metadata->step < 253) \
691 _metadata->step++;
692
693 #define is_signed_type(var) (!!(((__typeof__(var))(-1)) < (__typeof__(var))1))
694
695 #define __EXPECT(_expected, _expected_str, _seen, _seen_str, _t, _assert) do { \
696 /* Avoid multiple evaluation of the cases */ \
697 __typeof__(_expected) __exp = (_expected); \
698 __typeof__(_seen) __seen = (_seen); \
699 if (_assert) __INC_STEP(_metadata); \
700 if (!(__exp _t __seen)) { \
701 /* Report with actual signedness to avoid weird output. */ \
702 switch (is_signed_type(__exp) * 2 + is_signed_type(__seen)) { \
703 case 0: { \
704 unsigned long long __exp_print = (uintptr_t)__exp; \
705 unsigned long long __seen_print = (uintptr_t)__seen; \
706 __TH_LOG("Expected %s (%llu) %s %s (%llu)", \
707 _expected_str, __exp_print, #_t, \
708 _seen_str, __seen_print); \
709 break; \
710 } \
711 case 1: { \
712 unsigned long long __exp_print = (uintptr_t)__exp; \
713 long long __seen_print = (intptr_t)__seen; \
714 __TH_LOG("Expected %s (%llu) %s %s (%lld)", \
715 _expected_str, __exp_print, #_t, \
716 _seen_str, __seen_print); \
717 break; \
718 } \
719 case 2: { \
720 long long __exp_print = (intptr_t)__exp; \
721 unsigned long long __seen_print = (uintptr_t)__seen; \
722 __TH_LOG("Expected %s (%lld) %s %s (%llu)", \
723 _expected_str, __exp_print, #_t, \
724 _seen_str, __seen_print); \
725 break; \
726 } \
727 case 3: { \
728 long long __exp_print = (intptr_t)__exp; \
729 long long __seen_print = (intptr_t)__seen; \
730 __TH_LOG("Expected %s (%lld) %s %s (%lld)", \
731 _expected_str, __exp_print, #_t, \
732 _seen_str, __seen_print); \
733 break; \
734 } \
735 } \
736 _metadata->passed = 0; \
737 /* Ensure the optional handler is triggered */ \
738 _metadata->trigger = 1; \
739 } \
740 } while (0); OPTIONAL_HANDLER(_assert)
741
742 #define __EXPECT_STR(_expected, _seen, _t, _assert) do { \
743 const char *__exp = (_expected); \
744 const char *__seen = (_seen); \
745 if (_assert) __INC_STEP(_metadata); \
746 if (!(strcmp(__exp, __seen) _t 0)) { \
747 __TH_LOG("Expected '%s' %s '%s'.", __exp, #_t, __seen); \
748 _metadata->passed = 0; \
749 _metadata->trigger = 1; \
750 } \
751 } while (0); OPTIONAL_HANDLER(_assert)
752
753 /* List helpers */
754 #define __LIST_APPEND(head, item) \
755 { \
756 /* Circular linked list where only prev is circular. */ \
757 if (head == NULL) { \
758 head = item; \
759 item->next = NULL; \
760 item->prev = item; \
761 return; \
762 } \
763 if (__constructor_order == _CONSTRUCTOR_ORDER_FORWARD) { \
764 item->next = NULL; \
765 item->prev = head->prev; \
766 item->prev->next = item; \
767 head->prev = item; \
768 } else { \
769 item->next = head; \
770 item->next->prev = item; \
771 item->prev = item; \
772 head = item; \
773 } \
774 }
775
776 struct __test_results {
777 char reason[1024]; /* Reason for test result */
778 };
779
780 struct __test_metadata;
781 struct __fixture_variant_metadata;
782
783 /* Contains all the information about a fixture. */
784 struct __fixture_metadata {
785 const char *name;
786 struct __test_metadata *tests;
787 struct __fixture_variant_metadata *variant;
788 struct __fixture_metadata *prev, *next;
789 } _fixture_global __attribute__((unused)) = {
790 .name = "global",
791 .prev = &_fixture_global,
792 };
793
794 static struct __fixture_metadata *__fixture_list = &_fixture_global;
795 static int __constructor_order;
796
797 #define _CONSTRUCTOR_ORDER_FORWARD 1
798 #define _CONSTRUCTOR_ORDER_BACKWARD -1
799
__register_fixture(struct __fixture_metadata * f)800 static inline void __register_fixture(struct __fixture_metadata *f)
801 {
802 __LIST_APPEND(__fixture_list, f);
803 }
804
805 struct __fixture_variant_metadata {
806 const char *name;
807 const void *data;
808 struct __fixture_variant_metadata *prev, *next;
809 };
810
811 static inline void
__register_fixture_variant(struct __fixture_metadata * f,struct __fixture_variant_metadata * variant)812 __register_fixture_variant(struct __fixture_metadata *f,
813 struct __fixture_variant_metadata *variant)
814 {
815 __LIST_APPEND(f->variant, variant);
816 }
817
818 /* Contains all the information for test execution and status checking. */
819 struct __test_metadata {
820 const char *name;
821 void (*fn)(struct __test_metadata *,
822 struct __fixture_variant_metadata *);
823 pid_t pid; /* pid of test when being run */
824 struct __fixture_metadata *fixture;
825 int termsig;
826 int passed;
827 int skip; /* did SKIP get used? */
828 int trigger; /* extra handler after the evaluation */
829 int timeout; /* seconds to wait for test timeout */
830 bool timed_out; /* did this test timeout instead of exiting? */
831 __u8 step;
832 bool no_print; /* manual trigger when TH_LOG_STREAM is not available */
833 struct __test_results *results;
834 struct __test_metadata *prev, *next;
835 };
836
837 /*
838 * Since constructors are called in reverse order, reverse the test
839 * list so tests are run in source declaration order.
840 * https://gcc.gnu.org/onlinedocs/gccint/Initialization.html
841 * However, it seems not all toolchains do this correctly, so use
842 * __constructor_order to detect which direction is called first
843 * and adjust list building logic to get things running in the right
844 * direction.
845 */
__register_test(struct __test_metadata * t)846 static inline void __register_test(struct __test_metadata *t)
847 {
848 __LIST_APPEND(t->fixture->tests, t);
849 }
850
__bail(int for_realz,bool no_print,__u8 step)851 static inline int __bail(int for_realz, bool no_print, __u8 step)
852 {
853 if (for_realz) {
854 if (no_print)
855 _exit(step);
856 abort();
857 }
858 return 0;
859 }
860
861 struct __test_metadata *__active_test;
__timeout_handler(int sig,siginfo_t * info,void * ucontext)862 static void __timeout_handler(int sig, siginfo_t *info, void *ucontext)
863 {
864 struct __test_metadata *t = __active_test;
865
866 /* Sanity check handler execution environment. */
867 if (!t) {
868 fprintf(TH_LOG_STREAM,
869 "# no active test in SIGALRM handler!?\n");
870 abort();
871 }
872 if (sig != SIGALRM || sig != info->si_signo) {
873 fprintf(TH_LOG_STREAM,
874 "# %s: SIGALRM handler caught signal %d!?\n",
875 t->name, sig != SIGALRM ? sig : info->si_signo);
876 abort();
877 }
878
879 t->timed_out = true;
880 // signal process group
881 kill(-(t->pid), SIGKILL);
882 }
883
__wait_for_test(struct __test_metadata * t)884 void __wait_for_test(struct __test_metadata *t)
885 {
886 struct sigaction action = {
887 .sa_sigaction = __timeout_handler,
888 .sa_flags = SA_SIGINFO,
889 };
890 struct sigaction saved_action;
891 int status;
892
893 if (sigaction(SIGALRM, &action, &saved_action)) {
894 t->passed = 0;
895 fprintf(TH_LOG_STREAM,
896 "# %s: unable to install SIGALRM handler\n",
897 t->name);
898 return;
899 }
900 __active_test = t;
901 t->timed_out = false;
902 alarm(t->timeout);
903 waitpid(t->pid, &status, 0);
904 alarm(0);
905 if (sigaction(SIGALRM, &saved_action, NULL)) {
906 t->passed = 0;
907 fprintf(TH_LOG_STREAM,
908 "# %s: unable to uninstall SIGALRM handler\n",
909 t->name);
910 return;
911 }
912 __active_test = NULL;
913
914 if (t->timed_out) {
915 t->passed = 0;
916 fprintf(TH_LOG_STREAM,
917 "# %s: Test terminated by timeout\n", t->name);
918 } else if (WIFEXITED(status)) {
919 if (WEXITSTATUS(status) == 255) {
920 /* SKIP */
921 t->passed = 1;
922 t->skip = 1;
923 } else if (t->termsig != -1) {
924 t->passed = 0;
925 fprintf(TH_LOG_STREAM,
926 "# %s: Test exited normally instead of by signal (code: %d)\n",
927 t->name,
928 WEXITSTATUS(status));
929 } else {
930 switch (WEXITSTATUS(status)) {
931 /* Success */
932 case 0:
933 t->passed = 1;
934 break;
935 /* Other failure, assume step report. */
936 default:
937 t->passed = 0;
938 fprintf(TH_LOG_STREAM,
939 "# %s: Test failed at step #%d\n",
940 t->name,
941 WEXITSTATUS(status));
942 }
943 }
944 } else if (WIFSIGNALED(status)) {
945 t->passed = 0;
946 if (WTERMSIG(status) == SIGABRT) {
947 fprintf(TH_LOG_STREAM,
948 "# %s: Test terminated by assertion\n",
949 t->name);
950 } else if (WTERMSIG(status) == t->termsig) {
951 t->passed = 1;
952 } else {
953 fprintf(TH_LOG_STREAM,
954 "# %s: Test terminated unexpectedly by signal %d\n",
955 t->name,
956 WTERMSIG(status));
957 }
958 } else {
959 fprintf(TH_LOG_STREAM,
960 "# %s: Test ended in some other way [%u]\n",
961 t->name,
962 status);
963 }
964 }
965
__run_test(struct __fixture_metadata * f,struct __fixture_variant_metadata * variant,struct __test_metadata * t)966 void __run_test(struct __fixture_metadata *f,
967 struct __fixture_variant_metadata *variant,
968 struct __test_metadata *t)
969 {
970 /* reset test struct */
971 t->passed = 1;
972 t->skip = 0;
973 t->trigger = 0;
974 t->step = 1;
975 t->no_print = 0;
976 memset(t->results->reason, 0, sizeof(t->results->reason));
977
978 ksft_print_msg(" RUN %s%s%s.%s ...\n",
979 f->name, variant->name[0] ? "." : "", variant->name, t->name);
980
981 /* Make sure output buffers are flushed before fork */
982 fflush(stdout);
983 fflush(stderr);
984
985 t->pid = fork();
986 if (t->pid < 0) {
987 ksft_print_msg("ERROR SPAWNING TEST CHILD\n");
988 t->passed = 0;
989 } else if (t->pid == 0) {
990 setpgrp();
991 t->fn(t, variant);
992 if (t->skip)
993 _exit(255);
994 /* Pass is exit 0 */
995 if (t->passed)
996 _exit(0);
997 /* Something else happened, report the step. */
998 _exit(t->step);
999 } else {
1000 __wait_for_test(t);
1001 }
1002 ksft_print_msg(" %4s %s%s%s.%s\n", t->passed ? "OK" : "FAIL",
1003 f->name, variant->name[0] ? "." : "", variant->name, t->name);
1004
1005 if (t->skip)
1006 ksft_test_result_skip("%s\n", t->results->reason[0] ?
1007 t->results->reason : "unknown");
1008 else
1009 ksft_test_result(t->passed, "%s%s%s.%s\n",
1010 f->name, variant->name[0] ? "." : "", variant->name, t->name);
1011 }
1012
test_harness_run(int argc,char ** argv)1013 static int test_harness_run(int __attribute__((unused)) argc,
1014 char __attribute__((unused)) **argv)
1015 {
1016 struct __fixture_variant_metadata no_variant = { .name = "", };
1017 struct __fixture_variant_metadata *v;
1018 struct __fixture_metadata *f;
1019 struct __test_results *results;
1020 struct __test_metadata *t;
1021 int ret = 0;
1022 unsigned int case_count = 0, test_count = 0;
1023 unsigned int count = 0;
1024 unsigned int pass_count = 0;
1025
1026 for (f = __fixture_list; f; f = f->next) {
1027 for (v = f->variant ?: &no_variant; v; v = v->next) {
1028 case_count++;
1029 for (t = f->tests; t; t = t->next)
1030 test_count++;
1031 }
1032 }
1033
1034 results = mmap(NULL, sizeof(*results), PROT_READ | PROT_WRITE,
1035 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
1036
1037 ksft_print_header();
1038 ksft_set_plan(test_count);
1039 ksft_print_msg("Starting %u tests from %u test cases.\n",
1040 test_count, case_count);
1041 for (f = __fixture_list; f; f = f->next) {
1042 for (v = f->variant ?: &no_variant; v; v = v->next) {
1043 for (t = f->tests; t; t = t->next) {
1044 count++;
1045 t->results = results;
1046 __run_test(f, v, t);
1047 t->results = NULL;
1048 if (t->passed)
1049 pass_count++;
1050 else
1051 ret = 1;
1052 }
1053 }
1054 }
1055 munmap(results, sizeof(*results));
1056
1057 ksft_print_msg("%s: %u / %u tests passed.\n", ret ? "FAILED" : "PASSED",
1058 pass_count, count);
1059 ksft_exit(ret == 0);
1060
1061 /* unreachable */
1062 return KSFT_FAIL;
1063 }
1064
__constructor_order_first(void)1065 static void __attribute__((constructor)) __constructor_order_first(void)
1066 {
1067 if (!__constructor_order)
1068 __constructor_order = _CONSTRUCTOR_ORDER_FORWARD;
1069 }
1070
1071 #endif /* __KSELFTEST_HARNESS_H */
1072