tools/perf/tests/bpf.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <errno.h>
   3 #include <stdio.h>
   4 #include <stdlib.h>
   5 #include <sys/epoll.h>
   6 #include <sys/types.h>
   7 #include <sys/stat.h>
   8 #include <fcntl.h>
   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>
  18 #include "tests.h"
  19 #include "llvm.h"
  20 #include "debug.h"
  21 #include "parse-events.h"
  22 #include "util/mmap.h"
  23 #define NR_ITERS       111
  24 #define PERF_TEST_BPF_PATH "/sys/fs/bpf/perf_test"
  25
  26 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
  27 #include <linux/bpf.h>
  28 #include <bpf/bpf.h>
  29
  30 static int epoll_pwait_loop(void)
  31 {
  32         int i;
  33
  34         /* Should fail NR_ITERS times */
  35         for (i = 0; i < NR_ITERS; i++)
  36                 epoll_pwait(-(i + 1), NULL, 0, 0, NULL);
  37         return 0;
  38 }
  39
  40 #ifdef HAVE_BPF_PROLOGUE
  41
  42 static int llseek_loop(void)
  43 {
  44         int fds[2], i;
  45
  46         fds[0] = open("/dev/null", O_RDONLY);
  47         fds[1] = open("/dev/null", O_RDWR);
  48
  49         if (fds[0] < 0 || fds[1] < 0)
  50                 return -1;
  51
  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);
  55         }
  56         close(fds[0]);
  57         close(fds[1]);
  58         return 0;
  59 }
  60
  61 #endif
  62
  63 static struct {
  64         enum test_llvm__testcase prog_id;
  65         const char *name;
  66         const char *msg_compile_fail;
  67         const char *msg_load_fail;
  68         int (*target_func)(void);
  69         int expect_result;
  70         bool    pin;
  71 } bpf_testcase_table[] = {
  72         {
  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,
  79         },
  80         {
  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,
  87                 .pin              = true,
  88         },
  89 #ifdef HAVE_BPF_PROLOGUE
  90         {
  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,
  97         },
  98 #endif
  99 };
 100
 101 static int do_test(struct bpf_object *obj, int (*func)(void),
 102                    int expect)
 103 {
 104         struct record_opts opts = {
 105                 .target = {
 106                         .uid = UINT_MAX,
 107                         .uses_mmap = true,
 108                 },
 109                 .freq         = 0,
 110                 .mmap_pages   = 256,
 111                 .default_interval = 1,
 112         };
 113
 114         char pid[16];
 115         char sbuf[STRERR_BUFSIZE];
 116         struct evlist *evlist;
 117         int i, ret = TEST_FAIL, err = 0, count = 0;
 118
 119         struct parse_events_state parse_state;
 120         struct parse_events_error parse_error;
 121
 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);
 126
 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");
 131                 return TEST_SKIP;
 132         }
 133         if (err || list_empty(&parse_state.list)) {
 134                 pr_debug("Failed to add events selected by BPF\n");
 135                 return TEST_FAIL;
 136         }
 137
 138         snprintf(pid, sizeof(pid), "%d", getpid());
 139         pid[sizeof(pid) - 1] = '\0';
 140         opts.target.tid = opts.target.pid = pid;
 141
 142         /* Instead of evlist__new_default, don't add default events */
 143         evlist = evlist__new();
 144         if (!evlist) {
 145                 pr_debug("Not enough memory to create evlist\n");
 146                 return TEST_FAIL;
 147         }
 148
 149         err = evlist__create_maps(evlist, &opts.target);
 150         if (err < 0) {
 151                 pr_debug("Not enough memory to create thread/cpu maps\n");
 152                 goto out_delete_evlist;
 153         }
 154
 155         evlist__splice_list_tail(evlist, &parse_state.list);
 156
 157         evlist__config(evlist, &opts, NULL);
 158
 159         err = evlist__open(evlist);
 160         if (err < 0) {
 161                 pr_debug("perf_evlist__open: %s\n",
 162                          str_error_r(errno, sbuf, sizeof(sbuf)));
 163                 goto out_delete_evlist;
 164         }
 165
 166         err = evlist__mmap(evlist, opts.mmap_pages);
 167         if (err < 0) {
 168                 pr_debug("evlist__mmap: %s\n",
 169                          str_error_r(errno, sbuf, sizeof(sbuf)));
 170                 goto out_delete_evlist;
 171         }
 172
 173         evlist__enable(evlist);
 174         (*func)();
 175         evlist__disable(evlist);
 176
 177         for (i = 0; i < evlist->core.nr_mmaps; i++) {
 178                 union perf_event *event;
 179                 struct mmap *md;
 180
 181                 md = &evlist->mmap[i];
 182                 if (perf_mmap__read_init(&md->core) < 0)
 183                         continue;
 184
 185                 while ((event = perf_mmap__read_event(&md->core)) != NULL) {
 186                         const u32 type = event->header.type;
 187
 188                         if (type == PERF_RECORD_SAMPLE)
 189                                 count ++;
 190                 }
 191                 perf_mmap__read_done(&md->core);
 192         }
 193
 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;
 197         }
 198
 199         ret = TEST_OK;
 200
 201 out_delete_evlist:
 202         evlist__delete(evlist);
 203         return ret;
 204 }
 205
 206 static struct bpf_object *
 207 prepare_bpf(void *obj_buf, size_t obj_buf_sz, const char *name)
 208 {
 209         struct bpf_object *obj;
 210
 211         obj = bpf__prepare_load_buffer(obj_buf, obj_buf_sz, name);
 212         if (IS_ERR(obj)) {
 213                 pr_debug("Compile BPF program failed.\n");
 214                 return NULL;
 215         }
 216         return obj;
 217 }
 218
 219 static int __test__bpf(int idx)
 220 {
 221         int ret;
 222         void *obj_buf;
 223         size_t obj_buf_sz;
 224         struct bpf_object *obj;
 225
 226         ret = test_llvm__fetch_bpf_obj(&obj_buf, &obj_buf_sz,
 227                                        bpf_testcase_table[idx].prog_id,
 228                                        false, NULL);
 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))
 233                         return TEST_SKIP;
 234                 else
 235                         return TEST_FAIL;
 236         }
 237
 238         obj = prepare_bpf(obj_buf, obj_buf_sz,
 239                           bpf_testcase_table[idx].name);
 240         if ((!!bpf_testcase_table[idx].target_func) != (!!obj)) {
 241                 if (!obj)
 242                         pr_debug("Fail to load BPF object: %s\n",
 243                                  bpf_testcase_table[idx].msg_load_fail);
 244                 else
 245                         pr_debug("Success unexpectedly: %s\n",
 246                                  bpf_testcase_table[idx].msg_load_fail);
 247                 ret = TEST_FAIL;
 248                 goto out;
 249         }
 250
 251         if (obj) {
 252                 ret = do_test(obj,
 253                               bpf_testcase_table[idx].target_func,
 254                               bpf_testcase_table[idx].expect_result);
 255                 if (ret != TEST_OK)
 256                         goto out;
 257                 if (bpf_testcase_table[idx].pin) {
 258                         int err;
 259
 260                         if (!bpf_fs__mount()) {
 261                                 pr_debug("BPF filesystem not mounted\n");
 262                                 ret = TEST_FAIL;
 263                                 goto out;
 264                         }
 265                         err = mkdir(PERF_TEST_BPF_PATH, 0777);
 266                         if (err && errno != EEXIST) {
 267                                 pr_debug("Failed to make perf_test dir: %s\n",
 268                                          strerror(errno));
 269                                 ret = TEST_FAIL;
 270                                 goto out;
 271                         }
 272                         if (bpf_object__pin(obj, PERF_TEST_BPF_PATH))
 273                                 ret = TEST_FAIL;
 274                         if (rm_rf(PERF_TEST_BPF_PATH))
 275                                 ret = TEST_FAIL;
 276                 }
 277         }
 278
 279 out:
 280         free(obj_buf);
 281         bpf__clear();
 282         return ret;
 283 }
 284
 285 static int check_env(void)
 286 {
 287         LIBBPF_OPTS(bpf_prog_load_opts, opts);
 288         int err;
 289         char license[] = "GPL";
 290
 291         struct bpf_insn insns[] = {
 292                 BPF_MOV64_IMM(BPF_REG_0, 1),
 293                 BPF_EXIT_INSN(),
 294         };
 295
 296         err = fetch_kernel_version(&opts.kern_version, NULL, 0);
 297         if (err) {
 298                 pr_debug("Unable to get kernel version\n");
 299                 return err;
 300         }
 301         err = bpf_prog_load(BPF_PROG_TYPE_KPROBE, NULL, license, insns,
 302                             ARRAY_SIZE(insns), &opts);
 303         if (err < 0) {
 304                 pr_err("Missing basic BPF support, skip this test: %s\n",
 305                        strerror(errno));
 306                 return err;
 307         }
 308         close(err);
 309
 310         return 0;
 311 }
 312
 313 static int test__bpf(int i)
 314 {
 315         int err;
 316
 317         if (i < 0 || i >= (int)ARRAY_SIZE(bpf_testcase_table))
 318                 return TEST_FAIL;
 319
 320         if (geteuid() != 0) {
 321                 pr_debug("Only root can run BPF test\n");
 322                 return TEST_SKIP;
 323         }
 324
 325         if (check_env())
 326                 return TEST_SKIP;
 327
 328         err = __test__bpf(i);
 329         return err;
 330 }
 331 #endif
 332
 333 static int test__basic_bpf_test(struct test_suite *test __maybe_unused,
 334                                 int subtest __maybe_unused)
 335 {
 336 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
 337         return test__bpf(0);
 338 #else
 339         pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
 340         return TEST_SKIP;
 341 #endif
 342 }
 343
 344 static int test__bpf_pinning(struct test_suite *test __maybe_unused,
 345                              int subtest __maybe_unused)
 346 {
 347 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_LIBTRACEEVENT)
 348         return test__bpf(1);
 349 #else
 350         pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
 351         return TEST_SKIP;
 352 #endif
 353 }
 354
 355 static int test__bpf_prologue_test(struct test_suite *test __maybe_unused,
 356                                    int subtest __maybe_unused)
 357 {
 358 #if defined(HAVE_LIBBPF_SUPPORT) && defined(HAVE_BPF_PROLOGUE) && defined(HAVE_LIBTRACEEVENT)
 359         return test__bpf(2);
 360 #else
 361         pr_debug("Skip BPF test because BPF or libtraceevent support is not compiled\n");
 362         return TEST_SKIP;
 363 #endif
 364 }
 365
 366
 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"),
 375 #else
 376         TEST_CASE_REASON("BPF prologue generation", bpf_prologue_test, "not compiled in"),
 377 #endif
 378 #else
 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"),
 382 #endif
 383         { .name = NULL, }
 384 };
 385
 386 struct test_suite suite__bpf = {
 387         .desc = "BPF filter",
 388         .test_cases = bpf_tests,
 389 };