1 // SPDX-License-Identifier: GPL-2.0
9 #include <util/record.h>
10 #include <util/util.h>
11 #include <util/bpf-loader.h>
12 #include <util/evlist.h>
13 #include <linux/filter.h>
14 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <api/fs/fs.h>
17 #include <perf/mmap.h>
21 #include "parse-events.h"
22 #include "util/mmap.h"
24 #define PERF_TEST_BPF_PATH "/sys/fs/bpf/perf_test"
26 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
27 #include <linux/bpf.h>
30 static int epoll_pwait_loop(void)
34 /* Should fail NR_ITERS times */
35 for (i = 0; i < NR_ITERS; i++)
36 epoll_pwait(-(i + 1), NULL, 0, 0, NULL);
40 #ifdef HAVE_BPF_PROLOGUE
42 static int llseek_loop(void)
46 fds[0] = open("/dev/null", O_RDONLY);
47 fds[1] = open("/dev/null", O_RDWR);
49 if (fds[0] < 0 || fds[1] < 0)
52 for (i = 0; i < NR_ITERS; i++) {
53 lseek(fds[i % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
54 lseek(fds[(i + 1) % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
64 enum test_llvm__testcase prog_id;
66 const char *msg_compile_fail;
67 const char *msg_load_fail;
68 int (*target_func)(void);
71 } bpf_testcase_table[] = {
73 .prog_id = LLVM_TESTCASE_BASE,
74 .name = "[basic_bpf_test]",
75 .msg_compile_fail = "fix 'perf test LLVM' first",
76 .msg_load_fail = "load bpf object failed",
77 .target_func = &epoll_pwait_loop,
78 .expect_result = (NR_ITERS + 1) / 2,
81 .prog_id = LLVM_TESTCASE_BASE,
82 .name = "[bpf_pinning]",
83 .msg_compile_fail = "fix kbuild first",
84 .msg_load_fail = "check your vmlinux setting?",
85 .target_func = &epoll_pwait_loop,
86 .expect_result = (NR_ITERS + 1) / 2,
89 #ifdef HAVE_BPF_PROLOGUE
91 .prog_id = LLVM_TESTCASE_BPF_PROLOGUE,
92 .name = "[bpf_prologue_test]",
93 .msg_compile_fail = "fix kbuild first",
94 .msg_load_fail = "check your vmlinux setting?",
95 .target_func = &llseek_loop,
96 .expect_result = (NR_ITERS + 1) / 4,
101 static int do_test(struct bpf_object *obj, int (*func)(void),
104 struct record_opts opts = {
111 .default_interval = 1,
115 char sbuf[STRERR_BUFSIZE];
116 struct evlist *evlist;
117 int i, ret = TEST_FAIL, err = 0, count = 0;
119 struct parse_events_state parse_state;
120 struct parse_events_error parse_error;
122 parse_events_error__init(&parse_error);
123 bzero(&parse_state, sizeof(parse_state));
124 parse_state.error = &parse_error;
125 INIT_LIST_HEAD(&parse_state.list);
127 err = parse_events_load_bpf_obj(&parse_state, &parse_state.list, obj, NULL);
128 parse_events_error__exit(&parse_error);
129 if (err == -ENODATA) {
130 pr_debug("Failed to add events selected by BPF, debuginfo package not installed\n");
133 if (err || list_empty(&parse_state.list)) {
134 pr_debug("Failed to add events selected by BPF\n");
138 snprintf(pid, sizeof(pid), "%d", getpid());
139 pid[sizeof(pid) - 1] = '\0';
140 opts.target.tid = opts.target.pid = pid;
142 /* Instead of evlist__new_default, don't add default events */
143 evlist = evlist__new();
145 pr_debug("Not enough memory to create evlist\n");
149 err = evlist__create_maps(evlist, &opts.target);
151 pr_debug("Not enough memory to create thread/cpu maps\n");
152 goto out_delete_evlist;
155 evlist__splice_list_tail(evlist, &parse_state.list);
157 evlist__config(evlist, &opts, NULL);
159 err = evlist__open(evlist);
161 pr_debug("perf_evlist__open: %s\n",
162 str_error_r(errno, sbuf, sizeof(sbuf)));
163 goto out_delete_evlist;
166 err = evlist__mmap(evlist, opts.mmap_pages);
168 pr_debug("evlist__mmap: %s\n",
169 str_error_r(errno, sbuf, sizeof(sbuf)));
170 goto out_delete_evlist;
173 evlist__enable(evlist);
175 evlist__disable(evlist);
177 for (i = 0; i < evlist->core.nr_mmaps; i++) {
178 union perf_event *event;
181 md = &evlist->mmap[i];
182 if (perf_mmap__read_init(&md->core) < 0)
185 while ((event = perf_mmap__read_event(&md->core)) != NULL) {
186 const u32 type = event->header.type;
188 if (type == PERF_RECORD_SAMPLE)
191 perf_mmap__read_done(&md->core);
194 if (count != expect * evlist->core.nr_entries) {
195 pr_debug("BPF filter result incorrect, expected %d, got %d samples\n", expect * evlist->core.nr_entries, count);
196 goto out_delete_evlist;
202 evlist__delete(evlist);
206 static struct bpf_object *
207 prepare_bpf(void *obj_buf, size_t obj_buf_sz, const char *name)
209 struct bpf_object *obj;
211 obj = bpf__prepare_load_buffer(obj_buf, obj_buf_sz, name);
213 pr_debug("Compile BPF program failed.\n");
219 static int __test__bpf(int idx)
224 struct bpf_object *obj;
226 ret = test_llvm__fetch_bpf_obj(&obj_buf, &obj_buf_sz,
227 bpf_testcase_table[idx].prog_id,
229 if (ret != TEST_OK || !obj_buf || !obj_buf_sz) {
230 pr_debug("Unable to get BPF object, %s\n",
231 bpf_testcase_table[idx].msg_compile_fail);
232 if ((idx == 0) || (ret == TEST_SKIP))
238 obj = prepare_bpf(obj_buf, obj_buf_sz,
239 bpf_testcase_table[idx].name);
240 if ((!!bpf_testcase_table[idx].target_func) != (!!obj)) {
242 pr_debug("Fail to load BPF object: %s\n",
243 bpf_testcase_table[idx].msg_load_fail);
245 pr_debug("Success unexpectedly: %s\n",
246 bpf_testcase_table[idx].msg_load_fail);
253 bpf_testcase_table[idx].target_func,
254 bpf_testcase_table[idx].expect_result);
257 if (bpf_testcase_table[idx].pin) {
260 if (!bpf_fs__mount()) {
261 pr_debug("BPF filesystem not mounted\n");
265 err = mkdir(PERF_TEST_BPF_PATH, 0777);
266 if (err && errno != EEXIST) {
267 pr_debug("Failed to make perf_test dir: %s\n",
272 if (bpf_object__pin(obj, PERF_TEST_BPF_PATH))
274 if (rm_rf(PERF_TEST_BPF_PATH))
285 static int check_env(void)
287 LIBBPF_OPTS(bpf_prog_load_opts, opts);
289 char license[] = "GPL";
291 struct bpf_insn insns[] = {
292 BPF_MOV64_IMM(BPF_REG_0, 1),
296 err = fetch_kernel_version(&opts.kern_version, NULL, 0);
298 pr_debug("Unable to get kernel version\n");
301 err = bpf_prog_load(BPF_PROG_TYPE_KPROBE, NULL, license, insns,
302 ARRAY_SIZE(insns), &opts);
304 pr_err("Missing basic BPF support, skip this test: %s\n",
313 static int test__bpf(int i)
317 if (i < 0 || i >= (int)ARRAY_SIZE(bpf_testcase_table))
320 if (geteuid() != 0) {
321 pr_debug("Only root can run BPF test\n");
328 err = __test__bpf(i);
333 static int test__basic_bpf_test(struct test_suite *test __maybe_unused,
334 int subtest __maybe_unused)
336 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
339 pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
344 static int test__bpf_pinning(struct test_suite *test __maybe_unused,
345 int subtest __maybe_unused)
347 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
350 pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
355 static int test__bpf_prologue_test(struct test_suite *test __maybe_unused,
356 int subtest __maybe_unused)
358 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_BPF_PROLOGUE) && defined(HAVE_LIBTRACEEVENT)
361 pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
367 static struct test_case bpf_tests[] = {
368 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
369 TEST_CASE("Basic BPF filtering", basic_bpf_test),
370 TEST_CASE_REASON("BPF pinning", bpf_pinning,
371 "clang isn't installed or environment missing BPF support"),
372 #ifdef HAVE_BPF_PROLOGUE
373 TEST_CASE_REASON("BPF prologue generation", bpf_prologue_test,
374 "clang/debuginfo isn't installed or environment missing BPF support"),
376 TEST_CASE_REASON("BPF prologue generation", bpf_prologue_test, "not compiled in"),
379 TEST_CASE_REASON("Basic BPF filtering", basic_bpf_test, "not compiled in or missing libtraceevent support"),
380 TEST_CASE_REASON("BPF pinning", bpf_pinning, "not compiled in or missing libtraceevent support"),
381 TEST_CASE_REASON("BPF prologue generation", bpf_prologue_test, "not compiled in or missing libtraceevent support"),
386 struct test_suite suite__bpf = {
387 .desc = "BPF filter",
388 .test_cases = bpf_tests,