1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2010-2014 Intel Corporation 3 */ 4 5 #ifndef _TEST_H_ 6 #define _TEST_H_ 7 8 #include <stddef.h> 9 #include <sys/queue.h> 10 11 #include <rte_hexdump.h> 12 #include <rte_common.h> 13 14 #define TEST_SUCCESS EXIT_SUCCESS 15 #define TEST_FAILED -1 16 #define TEST_SKIPPED 77 17 18 /* Before including test.h file you can define 19 * TEST_TRACE_FAILURE(_file, _line, _func) macro to better trace/debug test 20 * failures. Mostly useful in test development phase. */ 21 #ifndef TEST_TRACE_FAILURE 22 # define TEST_TRACE_FAILURE(_file, _line, _func) 23 #endif 24 25 #define RTE_TEST_TRACE_FAILURE TEST_TRACE_FAILURE 26 27 #include <rte_test.h> 28 29 #define TEST_ASSERT RTE_TEST_ASSERT 30 31 #define TEST_ASSERT_EQUAL RTE_TEST_ASSERT_EQUAL 32 33 /* Compare two buffers (length in bytes) */ 34 #define TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, len, msg, ...) do { \ 35 if (memcmp(a, b, len)) { \ 36 printf("TestCase %s() line %d failed: " \ 37 msg "\n", __func__, __LINE__, ##__VA_ARGS__); \ 38 TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__); \ 39 return TEST_FAILED; \ 40 } \ 41 } while (0) 42 43 /* Compare two buffers with offset (length and offset in bytes) */ 44 #define TEST_ASSERT_BUFFERS_ARE_EQUAL_OFFSET(a, b, len, off, msg, ...) do { \ 45 const uint8_t *_a_with_off = (const uint8_t *)a + off; \ 46 const uint8_t *_b_with_off = (const uint8_t *)b + off; \ 47 TEST_ASSERT_BUFFERS_ARE_EQUAL(_a_with_off, _b_with_off, len, msg); \ 48 } while (0) 49 50 /* Compare two buffers (length in bits) */ 51 #define TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT(a, b, len, msg, ...) do { \ 52 uint8_t _last_byte_a, _last_byte_b; \ 53 uint8_t _last_byte_mask, _last_byte_bits; \ 54 TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, (len >> 3), msg); \ 55 if (len % 8) { \ 56 _last_byte_bits = len % 8; \ 57 _last_byte_mask = ~((1 << (8 - _last_byte_bits)) - 1); \ 58 _last_byte_a = ((const uint8_t *)a)[len >> 3]; \ 59 _last_byte_b = ((const uint8_t *)b)[len >> 3]; \ 60 _last_byte_a &= _last_byte_mask; \ 61 _last_byte_b &= _last_byte_mask; \ 62 if (_last_byte_a != _last_byte_b) { \ 63 printf("TestCase %s() line %d failed: " \ 64 msg "\n", __func__, __LINE__, ##__VA_ARGS__);\ 65 TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__); \ 66 return TEST_FAILED; \ 67 } \ 68 } \ 69 } while (0) 70 71 /* Compare two buffers with offset (length and offset in bits) */ 72 #define TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT_OFFSET(a, b, len, off, msg, ...) do { \ 73 uint8_t _first_byte_a, _first_byte_b; \ 74 uint8_t _first_byte_mask, _first_byte_bits; \ 75 uint32_t _len_without_first_byte = (off % 8) ? \ 76 len - (8 - (off % 8)) : \ 77 len; \ 78 uint32_t _off_in_bytes = (off % 8) ? (off >> 3) + 1 : (off >> 3); \ 79 const uint8_t *_a_with_off = (const uint8_t *)a + _off_in_bytes; \ 80 const uint8_t *_b_with_off = (const uint8_t *)b + _off_in_bytes; \ 81 TEST_ASSERT_BUFFERS_ARE_EQUAL_BIT(_a_with_off, _b_with_off, \ 82 _len_without_first_byte, msg); \ 83 if (off % 8) { \ 84 _first_byte_bits = 8 - (off % 8); \ 85 _first_byte_mask = (1 << _first_byte_bits) - 1; \ 86 _first_byte_a = *(_a_with_off - 1); \ 87 _first_byte_b = *(_b_with_off - 1); \ 88 _first_byte_a &= _first_byte_mask; \ 89 _first_byte_b &= _first_byte_mask; \ 90 if (_first_byte_a != _first_byte_b) { \ 91 printf("TestCase %s() line %d failed: " \ 92 msg "\n", __func__, __LINE__, ##__VA_ARGS__); \ 93 TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__); \ 94 return TEST_FAILED; \ 95 } \ 96 } \ 97 } while (0) 98 99 #define TEST_ASSERT_NOT_EQUAL RTE_TEST_ASSERT_NOT_EQUAL 100 101 #define TEST_ASSERT_SUCCESS RTE_TEST_ASSERT_SUCCESS 102 103 #define TEST_ASSERT_FAIL RTE_TEST_ASSERT_FAIL 104 105 #define TEST_ASSERT_NULL RTE_TEST_ASSERT_NULL 106 107 #define TEST_ASSERT_NOT_NULL RTE_TEST_ASSERT_NOT_NULL 108 109 struct unit_test_case { 110 int (*setup)(void); 111 void (*teardown)(void); 112 int (*testcase)(void); 113 const char *name; 114 unsigned enabled; 115 }; 116 117 #define TEST_CASE(fn) { NULL, NULL, fn, #fn, 1 } 118 119 #define TEST_CASE_NAMED(name, fn) { NULL, NULL, fn, name, 1 } 120 121 #define TEST_CASE_ST(setup, teardown, testcase) \ 122 { setup, teardown, testcase, #testcase, 1 } 123 124 125 #define TEST_CASE_DISABLED(fn) { NULL, NULL, fn, #fn, 0 } 126 127 #define TEST_CASE_ST_DISABLED(setup, teardown, testcase) \ 128 { setup, teardown, testcase, #testcase, 0 } 129 130 #define TEST_CASES_END() { NULL, NULL, NULL, NULL, 0 } 131 132 static inline void 133 debug_hexdump(FILE *file, const char *title, const void *buf, size_t len) 134 { 135 if (rte_log_get_global_level() == RTE_LOG_DEBUG) 136 rte_hexdump(file, title, buf, len); 137 } 138 139 struct unit_test_suite { 140 const char *suite_name; 141 int (*setup)(void); 142 void (*teardown)(void); 143 struct unit_test_case unit_test_cases[]; 144 }; 145 146 int unit_test_suite_runner(struct unit_test_suite *suite); 147 extern int last_test_result; 148 149 #define RECURSIVE_ENV_VAR "RTE_TEST_RECURSIVE" 150 151 #include <cmdline_parse.h> 152 #include <cmdline_parse_string.h> 153 154 extern const char *prgname; 155 156 int commands_init(void); 157 158 int test_mp_secondary(void); 159 160 int test_set_rxtx_conf(cmdline_fixed_string_t mode); 161 int test_set_rxtx_anchor(cmdline_fixed_string_t type); 162 int test_set_rxtx_sc(cmdline_fixed_string_t type); 163 164 typedef int (test_callback)(void); 165 TAILQ_HEAD(test_commands_list, test_command); 166 struct test_command { 167 TAILQ_ENTRY(test_command) next; 168 const char *command; 169 test_callback *callback; 170 }; 171 172 void add_test_command(struct test_command *t); 173 174 /* Register a test function with its command string */ 175 #define REGISTER_TEST_COMMAND(cmd, func) \ 176 static struct test_command test_struct_##cmd = { \ 177 .command = RTE_STR(cmd), \ 178 .callback = func, \ 179 }; \ 180 RTE_INIT(test_register_##cmd) \ 181 { \ 182 add_test_command(&test_struct_##cmd); \ 183 } 184 185 #endif 186