1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __BPF_MISC_H__ 3 #define __BPF_MISC_H__ 4 5 #define XSTR(s) STR(s) 6 #define STR(s) #s 7 8 /* Expand a macro and then stringize the expansion */ 9 #define QUOTE(str) #str 10 #define EXPAND_QUOTE(str) QUOTE(str) 11 12 /* This set of attributes controls behavior of the 13 * test_loader.c:test_loader__run_subtests(). 14 * 15 * The test_loader sequentially loads each program in a skeleton. 16 * Programs could be loaded in privileged and unprivileged modes. 17 * - __success, __failure, __msg, __regex imply privileged mode; 18 * - __success_unpriv, __failure_unpriv, __msg_unpriv, __regex_unpriv 19 * imply unprivileged mode. 20 * If combination of privileged and unprivileged attributes is present 21 * both modes are used. If none are present privileged mode is implied. 22 * 23 * See test_loader.c:drop_capabilities() for exact set of capabilities 24 * that differ between privileged and unprivileged modes. 25 * 26 * For test filtering purposes the name of the program loaded in 27 * unprivileged mode is derived from the usual program name by adding 28 * `@unpriv' suffix. 29 * 30 * __msg Message expected to be found in the verifier log. 31 * Multiple __msg attributes could be specified. 32 * To match a regular expression use "{{" "}}" brackets, 33 * e.g. "foo{{[0-9]+}}" matches strings like "foo007". 34 * Extended POSIX regular expression syntax is allowed 35 * inside the brackets. 36 * __not_msg Message not expected to be found in verifier log. 37 * If __msg_not is situated between __msg tags 38 * framework matches __msg tags first, and then 39 * checks that __msg_not is not present in a portion of 40 * a log between bracketing __msg tags. 41 * Same regex syntax as for __msg is supported. 42 * __msg_unpriv Same as __msg but for unprivileged mode. 43 * __not_msg_unpriv Same as __not_msg but for unprivileged mode. 44 * 45 * __stderr Message expected to be found in bpf stderr stream. The 46 * same regex rules apply like __msg. 47 * __stderr_unpriv Same as __stderr but for unpriveleged mode. 48 * __stdout Same as __stderr but for stdout stream. 49 * __stdout_unpriv Same as __stdout but for unpriveleged mode. 50 * 51 * __xlated Expect a line in a disassembly log after verifier applies rewrites. 52 * Multiple __xlated attributes could be specified. 53 * Regular expressions could be specified same way as in __msg. 54 * __xlated_unpriv Same as __xlated but for unprivileged mode. 55 * 56 * __jited Match a line in a disassembly of the jited BPF program. 57 * Has to be used after __arch_* macro. 58 * For example: 59 * 60 * __arch_x86_64 61 * __jited(" endbr64") 62 * __jited(" nopl (%rax,%rax)") 63 * __jited(" xorq %rax, %rax") 64 * ... 65 * __naked void some_test(void) 66 * { 67 * asm volatile (... ::: __clobber_all); 68 * } 69 * 70 * Regular expressions could be included in patterns same way 71 * as in __msg. 72 * 73 * By default assume that each pattern has to be matched on the 74 * next consecutive line of disassembly, e.g.: 75 * 76 * __jited(" endbr64") # matched on line N 77 * __jited(" nopl (%rax,%rax)") # matched on line N+1 78 * 79 * If match occurs on a wrong line an error is reported. 80 * To override this behaviour use literal "...", e.g.: 81 * 82 * __jited(" endbr64") # matched on line N 83 * __jited("...") # not matched 84 * __jited(" nopl (%rax,%rax)") # matched on any line >= N 85 * 86 * __jited_unpriv Same as __jited but for unprivileged mode. 87 * 88 * 89 * __success Expect program load success in privileged mode. 90 * __success_unpriv Expect program load success in unprivileged mode. 91 * 92 * __failure Expect program load failure in privileged mode. 93 * __failure_unpriv Expect program load failure in unprivileged mode. 94 * 95 * __retval Execute the program using BPF_PROG_TEST_RUN command, 96 * expect return value to match passed parameter: 97 * - a decimal number 98 * - a hexadecimal number, when starts from 0x 99 * - a macro which expands to one of the above 100 * - literal _INT_MIN (expands to INT_MIN) 101 * In addition, two special macros are defined below: 102 * - POINTER_VALUE 103 * - TEST_DATA_LEN 104 * __retval_unpriv Same, but load program in unprivileged mode. 105 * 106 * __description Text to be used for display and as an additional filter 107 * alias, while the original program name stays matchable. 108 * 109 * __log_level Log level to use for the program, numeric value expected. 110 * 111 * __flag Adds one flag use for the program, the following values are valid: 112 * - BPF_F_STRICT_ALIGNMENT; 113 * - BPF_F_TEST_RND_HI32; 114 * - BPF_F_TEST_STATE_FREQ; 115 * - BPF_F_SLEEPABLE; 116 * - BPF_F_XDP_HAS_FRAGS; 117 * - A numeric value. 118 * Multiple __flag attributes could be specified, the final flags 119 * value is derived by applying binary "or" to all specified values. 120 * 121 * __auxiliary Annotated program is not a separate test, but used as auxiliary 122 * for some other test cases and should always be loaded. 123 * __auxiliary_unpriv Same, but load program in unprivileged mode. 124 * 125 * __arch_* Specify on which architecture the test case should be tested. 126 * Several __arch_* annotations could be specified at once. 127 * When test case is not run on current arch it is marked as skipped. 128 * __caps_unpriv Specify the capabilities that should be set when running the test. 129 * 130 * __linear_size Specify the size of the linear area of non-linear skbs, or 131 * 0 for linear skbs. 132 */ 133 #define __test_tag(tag) __attribute__((btf_decl_tag("comment:" XSTR(__COUNTER__) ":" tag))) 134 135 #define __msg(msg) __test_tag("test_expect_msg=" msg) 136 #define __not_msg(msg) __test_tag("test_expect_not_msg=" msg) 137 #define __xlated(msg) __test_tag("test_expect_xlated=" msg) 138 #define __jited(msg) __test_tag("test_jited=" msg) 139 #define __failure __test_tag("test_expect_failure") 140 #define __success __test_tag("test_expect_success") 141 #define __description(desc) __test_tag("test_description=" desc) 142 #define __msg_unpriv(msg) __test_tag("test_expect_msg_unpriv=" msg) 143 #define __not_msg_unpriv(msg) __test_tag("test_expect_not_msg_unpriv=" msg) 144 #define __xlated_unpriv(msg) __test_tag("test_expect_xlated_unpriv=" msg) 145 #define __jited_unpriv(msg) __test_tag("test_jited_unpriv=" msg) 146 #define __failure_unpriv __test_tag("test_expect_failure_unpriv") 147 #define __success_unpriv __test_tag("test_expect_success_unpriv") 148 #define __log_level(lvl) __test_tag("test_log_level=" #lvl) 149 #define __flag(flag) __test_tag("test_prog_flags=" #flag) 150 #define __retval(val) __test_tag("test_retval=" XSTR(val)) 151 #define __retval_unpriv(val) __test_tag("test_retval_unpriv=" XSTR(val)) 152 #define __auxiliary __test_tag("test_auxiliary") 153 #define __auxiliary_unpriv __test_tag("test_auxiliary_unpriv") 154 #define __btf_path(path) __test_tag("test_btf_path=" path) 155 #define __arch(arch) __test_tag("test_arch=" arch) 156 #define __arch_x86_64 __arch("X86_64") 157 #define __arch_arm64 __arch("ARM64") 158 #define __arch_riscv64 __arch("RISCV64") 159 #define __arch_s390x __arch("s390x") 160 #define __caps_unpriv(caps) __test_tag("test_caps_unpriv=" EXPAND_QUOTE(caps)) 161 #define __load_if_JITed() __test_tag("load_mode=jited") 162 #define __load_if_no_JITed() __test_tag("load_mode=no_jited") 163 #define __stderr(msg) __test_tag("test_expect_stderr=" msg) 164 #define __stderr_unpriv(msg) __test_tag("test_expect_stderr_unpriv=" msg) 165 #define __stdout(msg) __test_tag("test_expect_stdout=" msg) 166 #define __stdout_unpriv(msg) __test_tag("test_expect_stdout_unpriv=" msg) 167 #define __linear_size(sz) __test_tag("test_linear_size=" XSTR(sz)) 168 169 /* Define common capabilities tested using __caps_unpriv */ 170 #define CAP_NET_ADMIN 12 171 #define CAP_SYS_ADMIN 21 172 #define CAP_PERFMON 38 173 #define CAP_BPF 39 174 175 /* Convenience macro for use with 'asm volatile' blocks */ 176 #define __naked __attribute__((naked)) 177 #define __clobber_all "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "memory" 178 #define __clobber_common "r0", "r1", "r2", "r3", "r4", "r5", "memory" 179 #define __imm(name) [name]"i"(name) 180 #define __imm_const(name, expr) [name]"i"(expr) 181 #define __imm_addr(name) [name]"i"(&name) 182 #define __imm_ptr(name) [name]"r"(&name) 183 #define __imm_insn(name, expr) [name]"i"(*(long *)&(expr)) 184 185 #define sizeof_field(TYPE, MEMBER) sizeof((((TYPE *)0)->MEMBER)) 186 #define offsetofend(TYPE, MEMBER) \ 187 (offsetof(TYPE, MEMBER) + sizeof_field(TYPE, MEMBER)) 188 189 /* Magic constants used with __retval() */ 190 #define POINTER_VALUE 0xbadcafe 191 #define TEST_DATA_LEN 64 192 193 #ifndef __aligned 194 #define __aligned(x) __attribute__((aligned(x))) 195 #endif 196 197 #ifndef __used 198 #define __used __attribute__((used)) 199 #endif 200 201 #if defined(__TARGET_ARCH_x86) 202 #define SYSCALL_WRAPPER 1 203 #define SYS_PREFIX "__x64_" 204 #elif defined(__TARGET_ARCH_s390) 205 #define SYSCALL_WRAPPER 1 206 #define SYS_PREFIX "__s390x_" 207 #elif defined(__TARGET_ARCH_arm64) 208 #define SYSCALL_WRAPPER 1 209 #define SYS_PREFIX "__arm64_" 210 #elif defined(__TARGET_ARCH_riscv) 211 #define SYSCALL_WRAPPER 1 212 #define SYS_PREFIX "__riscv_" 213 #elif defined(__TARGET_ARCH_powerpc) 214 #define SYSCALL_WRAPPER 1 215 #define SYS_PREFIX "" 216 #else 217 #define SYSCALL_WRAPPER 0 218 #define SYS_PREFIX "__se_" 219 #endif 220 221 /* How many arguments are passed to function in register */ 222 #if defined(__TARGET_ARCH_x86) || defined(__x86_64__) 223 #define FUNC_REG_ARG_CNT 6 224 #elif defined(__i386__) 225 #define FUNC_REG_ARG_CNT 3 226 #elif defined(__TARGET_ARCH_s390) || defined(__s390x__) 227 #define FUNC_REG_ARG_CNT 5 228 #elif defined(__TARGET_ARCH_arm) || defined(__arm__) 229 #define FUNC_REG_ARG_CNT 4 230 #elif defined(__TARGET_ARCH_arm64) || defined(__aarch64__) 231 #define FUNC_REG_ARG_CNT 8 232 #elif defined(__TARGET_ARCH_mips) || defined(__mips__) 233 #define FUNC_REG_ARG_CNT 8 234 #elif defined(__TARGET_ARCH_powerpc) || defined(__powerpc__) || defined(__powerpc64__) 235 #define FUNC_REG_ARG_CNT 8 236 #elif defined(__TARGET_ARCH_sparc) || defined(__sparc__) 237 #define FUNC_REG_ARG_CNT 6 238 #elif defined(__TARGET_ARCH_riscv) || defined(__riscv__) 239 #define FUNC_REG_ARG_CNT 8 240 #else 241 /* default to 5 for others */ 242 #define FUNC_REG_ARG_CNT 5 243 #endif 244 245 /* make it look to compiler like value is read and written */ 246 #define __sink(expr) asm volatile("" : "+g"(expr)) 247 248 #ifndef ARRAY_SIZE 249 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 250 #endif 251 252 #if (defined(__TARGET_ARCH_arm64) || defined(__TARGET_ARCH_x86) || \ 253 (defined(__TARGET_ARCH_riscv) && __riscv_xlen == 64) || \ 254 defined(__TARGET_ARCH_arm) || defined(__TARGET_ARCH_s390) || \ 255 defined(__TARGET_ARCH_loongarch)) && \ 256 __clang_major__ >= 18 257 #define CAN_USE_GOTOL 258 #endif 259 260 #if __clang_major__ >= 18 261 #define CAN_USE_BPF_ST 262 #endif 263 264 #if __clang_major__ >= 18 && defined(ENABLE_ATOMICS_TESTS) && \ 265 (defined(__TARGET_ARCH_arm64) || defined(__TARGET_ARCH_x86) || \ 266 (defined(__TARGET_ARCH_riscv) && __riscv_xlen == 64)) || \ 267 (defined(__TARGET_ARCH_powerpc)) 268 #define CAN_USE_LOAD_ACQ_STORE_REL 269 #endif 270 271 #if defined(__TARGET_ARCH_arm64) || defined(__TARGET_ARCH_x86) 272 #define SPEC_V1 273 #endif 274 275 #if defined(__TARGET_ARCH_x86) 276 #define SPEC_V4 277 #endif 278 279 #endif 280