Loading...
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 * __msg_unpriv Same as __msg but for unprivileged mode.
37 *
38 * __xlated Expect a line in a disassembly log after verifier applies rewrites.
39 * Multiple __xlated attributes could be specified.
40 * Regular expressions could be specified same way as in __msg.
41 * __xlated_unpriv Same as __xlated but for unprivileged mode.
42 *
43 * __jited Match a line in a disassembly of the jited BPF program.
44 * Has to be used after __arch_* macro.
45 * For example:
46 *
47 * __arch_x86_64
48 * __jited(" endbr64")
49 * __jited(" nopl (%rax,%rax)")
50 * __jited(" xorq %rax, %rax")
51 * ...
52 * __naked void some_test(void)
53 * {
54 * asm volatile (... ::: __clobber_all);
55 * }
56 *
57 * Regular expressions could be included in patterns same way
58 * as in __msg.
59 *
60 * By default assume that each pattern has to be matched on the
61 * next consecutive line of disassembly, e.g.:
62 *
63 * __jited(" endbr64") # matched on line N
64 * __jited(" nopl (%rax,%rax)") # matched on line N+1
65 *
66 * If match occurs on a wrong line an error is reported.
67 * To override this behaviour use literal "...", e.g.:
68 *
69 * __jited(" endbr64") # matched on line N
70 * __jited("...") # not matched
71 * __jited(" nopl (%rax,%rax)") # matched on any line >= N
72 *
73 * __jited_unpriv Same as __jited but for unprivileged mode.
74 *
75 *
76 * __success Expect program load success in privileged mode.
77 * __success_unpriv Expect program load success in unprivileged mode.
78 *
79 * __failure Expect program load failure in privileged mode.
80 * __failure_unpriv Expect program load failure in unprivileged mode.
81 *
82 * __retval Execute the program using BPF_PROG_TEST_RUN command,
83 * expect return value to match passed parameter:
84 * - a decimal number
85 * - a hexadecimal number, when starts from 0x
86 * - literal INT_MIN
87 * - literal POINTER_VALUE (see definition below)
88 * - literal TEST_DATA_LEN (see definition below)
89 * __retval_unpriv Same, but load program in unprivileged mode.
90 *
91 * __description Text to be used instead of a program name for display
92 * and filtering purposes.
93 *
94 * __log_level Log level to use for the program, numeric value expected.
95 *
96 * __flag Adds one flag use for the program, the following values are valid:
97 * - BPF_F_STRICT_ALIGNMENT;
98 * - BPF_F_TEST_RND_HI32;
99 * - BPF_F_TEST_STATE_FREQ;
100 * - BPF_F_SLEEPABLE;
101 * - BPF_F_XDP_HAS_FRAGS;
102 * - A numeric value.
103 * Multiple __flag attributes could be specified, the final flags
104 * value is derived by applying binary "or" to all specified values.
105 *
106 * __auxiliary Annotated program is not a separate test, but used as auxiliary
107 * for some other test cases and should always be loaded.
108 * __auxiliary_unpriv Same, but load program in unprivileged mode.
109 *
110 * __arch_* Specify on which architecture the test case should be tested.
111 * Several __arch_* annotations could be specified at once.
112 * When test case is not run on current arch it is marked as skipped.
113 * __caps_unpriv Specify the capabilities that should be set when running the test.
114 */
115#define __msg(msg) __attribute__((btf_decl_tag("comment:test_expect_msg=" XSTR(__COUNTER__) "=" msg)))
116#define __xlated(msg) __attribute__((btf_decl_tag("comment:test_expect_xlated=" XSTR(__COUNTER__) "=" msg)))
117#define __jited(msg) __attribute__((btf_decl_tag("comment:test_jited=" XSTR(__COUNTER__) "=" msg)))
118#define __failure __attribute__((btf_decl_tag("comment:test_expect_failure")))
119#define __success __attribute__((btf_decl_tag("comment:test_expect_success")))
120#define __description(desc) __attribute__((btf_decl_tag("comment:test_description=" desc)))
121#define __msg_unpriv(msg) __attribute__((btf_decl_tag("comment:test_expect_msg_unpriv=" XSTR(__COUNTER__) "=" msg)))
122#define __xlated_unpriv(msg) __attribute__((btf_decl_tag("comment:test_expect_xlated_unpriv=" XSTR(__COUNTER__) "=" msg)))
123#define __jited_unpriv(msg) __attribute__((btf_decl_tag("comment:test_jited=" XSTR(__COUNTER__) "=" msg)))
124#define __failure_unpriv __attribute__((btf_decl_tag("comment:test_expect_failure_unpriv")))
125#define __success_unpriv __attribute__((btf_decl_tag("comment:test_expect_success_unpriv")))
126#define __log_level(lvl) __attribute__((btf_decl_tag("comment:test_log_level="#lvl)))
127#define __flag(flag) __attribute__((btf_decl_tag("comment:test_prog_flags="#flag)))
128#define __retval(val) __attribute__((btf_decl_tag("comment:test_retval="#val)))
129#define __retval_unpriv(val) __attribute__((btf_decl_tag("comment:test_retval_unpriv="#val)))
130#define __auxiliary __attribute__((btf_decl_tag("comment:test_auxiliary")))
131#define __auxiliary_unpriv __attribute__((btf_decl_tag("comment:test_auxiliary_unpriv")))
132#define __btf_path(path) __attribute__((btf_decl_tag("comment:test_btf_path=" path)))
133#define __arch(arch) __attribute__((btf_decl_tag("comment:test_arch=" arch)))
134#define __arch_x86_64 __arch("X86_64")
135#define __arch_arm64 __arch("ARM64")
136#define __arch_riscv64 __arch("RISCV64")
137#define __caps_unpriv(caps) __attribute__((btf_decl_tag("comment:test_caps_unpriv=" EXPAND_QUOTE(caps))))
138
139/* Define common capabilities tested using __caps_unpriv */
140#define CAP_NET_ADMIN 12
141#define CAP_SYS_ADMIN 21
142#define CAP_PERFMON 38
143#define CAP_BPF 39
144
145/* Convenience macro for use with 'asm volatile' blocks */
146#define __naked __attribute__((naked))
147#define __clobber_all "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "memory"
148#define __clobber_common "r0", "r1", "r2", "r3", "r4", "r5", "memory"
149#define __imm(name) [name]"i"(name)
150#define __imm_const(name, expr) [name]"i"(expr)
151#define __imm_addr(name) [name]"i"(&name)
152#define __imm_ptr(name) [name]"r"(&name)
153#define __imm_insn(name, expr) [name]"i"(*(long *)&(expr))
154
155/* Magic constants used with __retval() */
156#define POINTER_VALUE 0xcafe4all
157#define TEST_DATA_LEN 64
158
159#ifndef __used
160#define __used __attribute__((used))
161#endif
162
163#if defined(__TARGET_ARCH_x86)
164#define SYSCALL_WRAPPER 1
165#define SYS_PREFIX "__x64_"
166#elif defined(__TARGET_ARCH_s390)
167#define SYSCALL_WRAPPER 1
168#define SYS_PREFIX "__s390x_"
169#elif defined(__TARGET_ARCH_arm64)
170#define SYSCALL_WRAPPER 1
171#define SYS_PREFIX "__arm64_"
172#elif defined(__TARGET_ARCH_riscv)
173#define SYSCALL_WRAPPER 1
174#define SYS_PREFIX "__riscv_"
175#else
176#define SYSCALL_WRAPPER 0
177#define SYS_PREFIX "__se_"
178#endif
179
180/* How many arguments are passed to function in register */
181#if defined(__TARGET_ARCH_x86) || defined(__x86_64__)
182#define FUNC_REG_ARG_CNT 6
183#elif defined(__i386__)
184#define FUNC_REG_ARG_CNT 3
185#elif defined(__TARGET_ARCH_s390) || defined(__s390x__)
186#define FUNC_REG_ARG_CNT 5
187#elif defined(__TARGET_ARCH_arm) || defined(__arm__)
188#define FUNC_REG_ARG_CNT 4
189#elif defined(__TARGET_ARCH_arm64) || defined(__aarch64__)
190#define FUNC_REG_ARG_CNT 8
191#elif defined(__TARGET_ARCH_mips) || defined(__mips__)
192#define FUNC_REG_ARG_CNT 8
193#elif defined(__TARGET_ARCH_powerpc) || defined(__powerpc__) || defined(__powerpc64__)
194#define FUNC_REG_ARG_CNT 8
195#elif defined(__TARGET_ARCH_sparc) || defined(__sparc__)
196#define FUNC_REG_ARG_CNT 6
197#elif defined(__TARGET_ARCH_riscv) || defined(__riscv__)
198#define FUNC_REG_ARG_CNT 8
199#else
200/* default to 5 for others */
201#define FUNC_REG_ARG_CNT 5
202#endif
203
204/* make it look to compiler like value is read and written */
205#define __sink(expr) asm volatile("" : "+g"(expr))
206
207#ifndef ARRAY_SIZE
208#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
209#endif
210
211#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __BPF_MISC_H__
3#define __BPF_MISC_H__
4
5/* This set of attributes controls behavior of the
6 * test_loader.c:test_loader__run_subtests().
7 *
8 * The test_loader sequentially loads each program in a skeleton.
9 * Programs could be loaded in privileged and unprivileged modes.
10 * - __success, __failure, __msg imply privileged mode;
11 * - __success_unpriv, __failure_unpriv, __msg_unpriv imply
12 * unprivileged mode.
13 * If combination of privileged and unprivileged attributes is present
14 * both modes are used. If none are present privileged mode is implied.
15 *
16 * See test_loader.c:drop_capabilities() for exact set of capabilities
17 * that differ between privileged and unprivileged modes.
18 *
19 * For test filtering purposes the name of the program loaded in
20 * unprivileged mode is derived from the usual program name by adding
21 * `@unpriv' suffix.
22 *
23 * __msg Message expected to be found in the verifier log.
24 * Multiple __msg attributes could be specified.
25 * __msg_unpriv Same as __msg but for unprivileged mode.
26 *
27 * __success Expect program load success in privileged mode.
28 * __success_unpriv Expect program load success in unprivileged mode.
29 *
30 * __failure Expect program load failure in privileged mode.
31 * __failure_unpriv Expect program load failure in unprivileged mode.
32 *
33 * __retval Execute the program using BPF_PROG_TEST_RUN command,
34 * expect return value to match passed parameter:
35 * - a decimal number
36 * - a hexadecimal number, when starts from 0x
37 * - literal INT_MIN
38 * - literal POINTER_VALUE (see definition below)
39 * - literal TEST_DATA_LEN (see definition below)
40 * __retval_unpriv Same, but load program in unprivileged mode.
41 *
42 * __description Text to be used instead of a program name for display
43 * and filtering purposes.
44 *
45 * __log_level Log level to use for the program, numeric value expected.
46 *
47 * __flag Adds one flag use for the program, the following values are valid:
48 * - BPF_F_STRICT_ALIGNMENT;
49 * - BPF_F_TEST_RND_HI32;
50 * - BPF_F_TEST_STATE_FREQ;
51 * - BPF_F_SLEEPABLE;
52 * - BPF_F_XDP_HAS_FRAGS;
53 * - A numeric value.
54 * Multiple __flag attributes could be specified, the final flags
55 * value is derived by applying binary "or" to all specified values.
56 *
57 * __auxiliary Annotated program is not a separate test, but used as auxiliary
58 * for some other test cases and should always be loaded.
59 * __auxiliary_unpriv Same, but load program in unprivileged mode.
60 */
61#define __msg(msg) __attribute__((btf_decl_tag("comment:test_expect_msg=" msg)))
62#define __failure __attribute__((btf_decl_tag("comment:test_expect_failure")))
63#define __success __attribute__((btf_decl_tag("comment:test_expect_success")))
64#define __description(desc) __attribute__((btf_decl_tag("comment:test_description=" desc)))
65#define __msg_unpriv(msg) __attribute__((btf_decl_tag("comment:test_expect_msg_unpriv=" msg)))
66#define __failure_unpriv __attribute__((btf_decl_tag("comment:test_expect_failure_unpriv")))
67#define __success_unpriv __attribute__((btf_decl_tag("comment:test_expect_success_unpriv")))
68#define __log_level(lvl) __attribute__((btf_decl_tag("comment:test_log_level="#lvl)))
69#define __flag(flag) __attribute__((btf_decl_tag("comment:test_prog_flags="#flag)))
70#define __retval(val) __attribute__((btf_decl_tag("comment:test_retval="#val)))
71#define __retval_unpriv(val) __attribute__((btf_decl_tag("comment:test_retval_unpriv="#val)))
72#define __auxiliary __attribute__((btf_decl_tag("comment:test_auxiliary")))
73#define __auxiliary_unpriv __attribute__((btf_decl_tag("comment:test_auxiliary_unpriv")))
74#define __btf_path(path) __attribute__((btf_decl_tag("comment:test_btf_path=" path)))
75
76/* Convenience macro for use with 'asm volatile' blocks */
77#define __naked __attribute__((naked))
78#define __clobber_all "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "memory"
79#define __clobber_common "r0", "r1", "r2", "r3", "r4", "r5", "memory"
80#define __imm(name) [name]"i"(name)
81#define __imm_const(name, expr) [name]"i"(expr)
82#define __imm_addr(name) [name]"i"(&name)
83#define __imm_ptr(name) [name]"p"(&name)
84#define __imm_insn(name, expr) [name]"i"(*(long *)&(expr))
85
86/* Magic constants used with __retval() */
87#define POINTER_VALUE 0xcafe4all
88#define TEST_DATA_LEN 64
89
90#ifndef __used
91#define __used __attribute__((used))
92#endif
93
94#if defined(__TARGET_ARCH_x86)
95#define SYSCALL_WRAPPER 1
96#define SYS_PREFIX "__x64_"
97#elif defined(__TARGET_ARCH_s390)
98#define SYSCALL_WRAPPER 1
99#define SYS_PREFIX "__s390x_"
100#elif defined(__TARGET_ARCH_arm64)
101#define SYSCALL_WRAPPER 1
102#define SYS_PREFIX "__arm64_"
103#elif defined(__TARGET_ARCH_riscv)
104#define SYSCALL_WRAPPER 1
105#define SYS_PREFIX "__riscv_"
106#else
107#define SYSCALL_WRAPPER 0
108#define SYS_PREFIX "__se_"
109#endif
110
111/* How many arguments are passed to function in register */
112#if defined(__TARGET_ARCH_x86) || defined(__x86_64__)
113#define FUNC_REG_ARG_CNT 6
114#elif defined(__i386__)
115#define FUNC_REG_ARG_CNT 3
116#elif defined(__TARGET_ARCH_s390) || defined(__s390x__)
117#define FUNC_REG_ARG_CNT 5
118#elif defined(__TARGET_ARCH_arm) || defined(__arm__)
119#define FUNC_REG_ARG_CNT 4
120#elif defined(__TARGET_ARCH_arm64) || defined(__aarch64__)
121#define FUNC_REG_ARG_CNT 8
122#elif defined(__TARGET_ARCH_mips) || defined(__mips__)
123#define FUNC_REG_ARG_CNT 8
124#elif defined(__TARGET_ARCH_powerpc) || defined(__powerpc__) || defined(__powerpc64__)
125#define FUNC_REG_ARG_CNT 8
126#elif defined(__TARGET_ARCH_sparc) || defined(__sparc__)
127#define FUNC_REG_ARG_CNT 6
128#elif defined(__TARGET_ARCH_riscv) || defined(__riscv__)
129#define FUNC_REG_ARG_CNT 8
130#else
131/* default to 5 for others */
132#define FUNC_REG_ARG_CNT 5
133#endif
134
135/* make it look to compiler like value is read and written */
136#define __sink(expr) asm volatile("" : "+g"(expr))
137
138#endif