Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0
0002 #include <test_progs.h>
0003 #include "kprobe_multi.skel.h"
0004 #include "trace_helpers.h"
0005 #include "kprobe_multi_empty.skel.h"
0006 #include "bpf/libbpf_internal.h"
0007 #include "bpf/hashmap.h"
0008 
0009 static void kprobe_multi_test_run(struct kprobe_multi *skel, bool test_return)
0010 {
0011     LIBBPF_OPTS(bpf_test_run_opts, topts);
0012     int err, prog_fd;
0013 
0014     prog_fd = bpf_program__fd(skel->progs.trigger);
0015     err = bpf_prog_test_run_opts(prog_fd, &topts);
0016     ASSERT_OK(err, "test_run");
0017     ASSERT_EQ(topts.retval, 0, "test_run");
0018 
0019     ASSERT_EQ(skel->bss->kprobe_test1_result, 1, "kprobe_test1_result");
0020     ASSERT_EQ(skel->bss->kprobe_test2_result, 1, "kprobe_test2_result");
0021     ASSERT_EQ(skel->bss->kprobe_test3_result, 1, "kprobe_test3_result");
0022     ASSERT_EQ(skel->bss->kprobe_test4_result, 1, "kprobe_test4_result");
0023     ASSERT_EQ(skel->bss->kprobe_test5_result, 1, "kprobe_test5_result");
0024     ASSERT_EQ(skel->bss->kprobe_test6_result, 1, "kprobe_test6_result");
0025     ASSERT_EQ(skel->bss->kprobe_test7_result, 1, "kprobe_test7_result");
0026     ASSERT_EQ(skel->bss->kprobe_test8_result, 1, "kprobe_test8_result");
0027 
0028     if (test_return) {
0029         ASSERT_EQ(skel->bss->kretprobe_test1_result, 1, "kretprobe_test1_result");
0030         ASSERT_EQ(skel->bss->kretprobe_test2_result, 1, "kretprobe_test2_result");
0031         ASSERT_EQ(skel->bss->kretprobe_test3_result, 1, "kretprobe_test3_result");
0032         ASSERT_EQ(skel->bss->kretprobe_test4_result, 1, "kretprobe_test4_result");
0033         ASSERT_EQ(skel->bss->kretprobe_test5_result, 1, "kretprobe_test5_result");
0034         ASSERT_EQ(skel->bss->kretprobe_test6_result, 1, "kretprobe_test6_result");
0035         ASSERT_EQ(skel->bss->kretprobe_test7_result, 1, "kretprobe_test7_result");
0036         ASSERT_EQ(skel->bss->kretprobe_test8_result, 1, "kretprobe_test8_result");
0037     }
0038 }
0039 
0040 static void test_skel_api(void)
0041 {
0042     struct kprobe_multi *skel = NULL;
0043     int err;
0044 
0045     skel = kprobe_multi__open_and_load();
0046     if (!ASSERT_OK_PTR(skel, "kprobe_multi__open_and_load"))
0047         goto cleanup;
0048 
0049     skel->bss->pid = getpid();
0050     err = kprobe_multi__attach(skel);
0051     if (!ASSERT_OK(err, "kprobe_multi__attach"))
0052         goto cleanup;
0053 
0054     kprobe_multi_test_run(skel, true);
0055 
0056 cleanup:
0057     kprobe_multi__destroy(skel);
0058 }
0059 
0060 static void test_link_api(struct bpf_link_create_opts *opts)
0061 {
0062     int prog_fd, link1_fd = -1, link2_fd = -1;
0063     struct kprobe_multi *skel = NULL;
0064 
0065     skel = kprobe_multi__open_and_load();
0066     if (!ASSERT_OK_PTR(skel, "fentry_raw_skel_load"))
0067         goto cleanup;
0068 
0069     skel->bss->pid = getpid();
0070     prog_fd = bpf_program__fd(skel->progs.test_kprobe);
0071     link1_fd = bpf_link_create(prog_fd, 0, BPF_TRACE_KPROBE_MULTI, opts);
0072     if (!ASSERT_GE(link1_fd, 0, "link_fd"))
0073         goto cleanup;
0074 
0075     opts->kprobe_multi.flags = BPF_F_KPROBE_MULTI_RETURN;
0076     prog_fd = bpf_program__fd(skel->progs.test_kretprobe);
0077     link2_fd = bpf_link_create(prog_fd, 0, BPF_TRACE_KPROBE_MULTI, opts);
0078     if (!ASSERT_GE(link2_fd, 0, "link_fd"))
0079         goto cleanup;
0080 
0081     kprobe_multi_test_run(skel, true);
0082 
0083 cleanup:
0084     if (link1_fd != -1)
0085         close(link1_fd);
0086     if (link2_fd != -1)
0087         close(link2_fd);
0088     kprobe_multi__destroy(skel);
0089 }
0090 
0091 #define GET_ADDR(__sym, __addr) ({                  \
0092     __addr = ksym_get_addr(__sym);                  \
0093     if (!ASSERT_NEQ(__addr, 0, "kallsyms load failed for " #__sym)) \
0094         return;                         \
0095 })
0096 
0097 static void test_link_api_addrs(void)
0098 {
0099     LIBBPF_OPTS(bpf_link_create_opts, opts);
0100     unsigned long long addrs[8];
0101 
0102     GET_ADDR("bpf_fentry_test1", addrs[0]);
0103     GET_ADDR("bpf_fentry_test2", addrs[1]);
0104     GET_ADDR("bpf_fentry_test3", addrs[2]);
0105     GET_ADDR("bpf_fentry_test4", addrs[3]);
0106     GET_ADDR("bpf_fentry_test5", addrs[4]);
0107     GET_ADDR("bpf_fentry_test6", addrs[5]);
0108     GET_ADDR("bpf_fentry_test7", addrs[6]);
0109     GET_ADDR("bpf_fentry_test8", addrs[7]);
0110 
0111     opts.kprobe_multi.addrs = (const unsigned long*) addrs;
0112     opts.kprobe_multi.cnt = ARRAY_SIZE(addrs);
0113     test_link_api(&opts);
0114 }
0115 
0116 static void test_link_api_syms(void)
0117 {
0118     LIBBPF_OPTS(bpf_link_create_opts, opts);
0119     const char *syms[8] = {
0120         "bpf_fentry_test1",
0121         "bpf_fentry_test2",
0122         "bpf_fentry_test3",
0123         "bpf_fentry_test4",
0124         "bpf_fentry_test5",
0125         "bpf_fentry_test6",
0126         "bpf_fentry_test7",
0127         "bpf_fentry_test8",
0128     };
0129 
0130     opts.kprobe_multi.syms = syms;
0131     opts.kprobe_multi.cnt = ARRAY_SIZE(syms);
0132     test_link_api(&opts);
0133 }
0134 
0135 static void
0136 test_attach_api(const char *pattern, struct bpf_kprobe_multi_opts *opts)
0137 {
0138     struct bpf_link *link1 = NULL, *link2 = NULL;
0139     struct kprobe_multi *skel = NULL;
0140 
0141     skel = kprobe_multi__open_and_load();
0142     if (!ASSERT_OK_PTR(skel, "fentry_raw_skel_load"))
0143         goto cleanup;
0144 
0145     skel->bss->pid = getpid();
0146     link1 = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0147                               pattern, opts);
0148     if (!ASSERT_OK_PTR(link1, "bpf_program__attach_kprobe_multi_opts"))
0149         goto cleanup;
0150 
0151     if (opts) {
0152         opts->retprobe = true;
0153         link2 = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kretprobe_manual,
0154                                   pattern, opts);
0155         if (!ASSERT_OK_PTR(link2, "bpf_program__attach_kprobe_multi_opts"))
0156             goto cleanup;
0157     }
0158 
0159     kprobe_multi_test_run(skel, !!opts);
0160 
0161 cleanup:
0162     bpf_link__destroy(link2);
0163     bpf_link__destroy(link1);
0164     kprobe_multi__destroy(skel);
0165 }
0166 
0167 static void test_attach_api_pattern(void)
0168 {
0169     LIBBPF_OPTS(bpf_kprobe_multi_opts, opts);
0170 
0171     test_attach_api("bpf_fentry_test*", &opts);
0172     test_attach_api("bpf_fentry_test?", NULL);
0173 }
0174 
0175 static void test_attach_api_addrs(void)
0176 {
0177     LIBBPF_OPTS(bpf_kprobe_multi_opts, opts);
0178     unsigned long long addrs[8];
0179 
0180     GET_ADDR("bpf_fentry_test1", addrs[0]);
0181     GET_ADDR("bpf_fentry_test2", addrs[1]);
0182     GET_ADDR("bpf_fentry_test3", addrs[2]);
0183     GET_ADDR("bpf_fentry_test4", addrs[3]);
0184     GET_ADDR("bpf_fentry_test5", addrs[4]);
0185     GET_ADDR("bpf_fentry_test6", addrs[5]);
0186     GET_ADDR("bpf_fentry_test7", addrs[6]);
0187     GET_ADDR("bpf_fentry_test8", addrs[7]);
0188 
0189     opts.addrs = (const unsigned long *) addrs;
0190     opts.cnt = ARRAY_SIZE(addrs);
0191     test_attach_api(NULL, &opts);
0192 }
0193 
0194 static void test_attach_api_syms(void)
0195 {
0196     LIBBPF_OPTS(bpf_kprobe_multi_opts, opts);
0197     const char *syms[8] = {
0198         "bpf_fentry_test1",
0199         "bpf_fentry_test2",
0200         "bpf_fentry_test3",
0201         "bpf_fentry_test4",
0202         "bpf_fentry_test5",
0203         "bpf_fentry_test6",
0204         "bpf_fentry_test7",
0205         "bpf_fentry_test8",
0206     };
0207 
0208     opts.syms = syms;
0209     opts.cnt = ARRAY_SIZE(syms);
0210     test_attach_api(NULL, &opts);
0211 }
0212 
0213 static void test_attach_api_fails(void)
0214 {
0215     LIBBPF_OPTS(bpf_kprobe_multi_opts, opts);
0216     struct kprobe_multi *skel = NULL;
0217     struct bpf_link *link = NULL;
0218     unsigned long long addrs[2];
0219     const char *syms[2] = {
0220         "bpf_fentry_test1",
0221         "bpf_fentry_test2",
0222     };
0223     __u64 cookies[2];
0224 
0225     addrs[0] = ksym_get_addr("bpf_fentry_test1");
0226     addrs[1] = ksym_get_addr("bpf_fentry_test2");
0227 
0228     if (!ASSERT_FALSE(!addrs[0] || !addrs[1], "ksym_get_addr"))
0229         goto cleanup;
0230 
0231     skel = kprobe_multi__open_and_load();
0232     if (!ASSERT_OK_PTR(skel, "fentry_raw_skel_load"))
0233         goto cleanup;
0234 
0235     skel->bss->pid = getpid();
0236 
0237     /* fail_1 - pattern and opts NULL */
0238     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0239                              NULL, NULL);
0240     if (!ASSERT_ERR_PTR(link, "fail_1"))
0241         goto cleanup;
0242 
0243     if (!ASSERT_EQ(libbpf_get_error(link), -EINVAL, "fail_1_error"))
0244         goto cleanup;
0245 
0246     /* fail_2 - both addrs and syms set */
0247     opts.addrs = (const unsigned long *) addrs;
0248     opts.syms = syms;
0249     opts.cnt = ARRAY_SIZE(syms);
0250     opts.cookies = NULL;
0251 
0252     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0253                              NULL, &opts);
0254     if (!ASSERT_ERR_PTR(link, "fail_2"))
0255         goto cleanup;
0256 
0257     if (!ASSERT_EQ(libbpf_get_error(link), -EINVAL, "fail_2_error"))
0258         goto cleanup;
0259 
0260     /* fail_3 - pattern and addrs set */
0261     opts.addrs = (const unsigned long *) addrs;
0262     opts.syms = NULL;
0263     opts.cnt = ARRAY_SIZE(syms);
0264     opts.cookies = NULL;
0265 
0266     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0267                              "ksys_*", &opts);
0268     if (!ASSERT_ERR_PTR(link, "fail_3"))
0269         goto cleanup;
0270 
0271     if (!ASSERT_EQ(libbpf_get_error(link), -EINVAL, "fail_3_error"))
0272         goto cleanup;
0273 
0274     /* fail_4 - pattern and cnt set */
0275     opts.addrs = NULL;
0276     opts.syms = NULL;
0277     opts.cnt = ARRAY_SIZE(syms);
0278     opts.cookies = NULL;
0279 
0280     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0281                              "ksys_*", &opts);
0282     if (!ASSERT_ERR_PTR(link, "fail_4"))
0283         goto cleanup;
0284 
0285     if (!ASSERT_EQ(libbpf_get_error(link), -EINVAL, "fail_4_error"))
0286         goto cleanup;
0287 
0288     /* fail_5 - pattern and cookies */
0289     opts.addrs = NULL;
0290     opts.syms = NULL;
0291     opts.cnt = 0;
0292     opts.cookies = cookies;
0293 
0294     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_manual,
0295                              "ksys_*", &opts);
0296     if (!ASSERT_ERR_PTR(link, "fail_5"))
0297         goto cleanup;
0298 
0299     if (!ASSERT_EQ(libbpf_get_error(link), -EINVAL, "fail_5_error"))
0300         goto cleanup;
0301 
0302 cleanup:
0303     bpf_link__destroy(link);
0304     kprobe_multi__destroy(skel);
0305 }
0306 
0307 static inline __u64 get_time_ns(void)
0308 {
0309     struct timespec t;
0310 
0311     clock_gettime(CLOCK_MONOTONIC, &t);
0312     return (__u64) t.tv_sec * 1000000000 + t.tv_nsec;
0313 }
0314 
0315 static size_t symbol_hash(const void *key, void *ctx __maybe_unused)
0316 {
0317     return str_hash((const char *) key);
0318 }
0319 
0320 static bool symbol_equal(const void *key1, const void *key2, void *ctx __maybe_unused)
0321 {
0322     return strcmp((const char *) key1, (const char *) key2) == 0;
0323 }
0324 
0325 static int get_syms(char ***symsp, size_t *cntp)
0326 {
0327     size_t cap = 0, cnt = 0, i;
0328     char *name, **syms = NULL;
0329     struct hashmap *map;
0330     char buf[256];
0331     FILE *f;
0332     int err = 0;
0333 
0334     /*
0335      * The available_filter_functions contains many duplicates,
0336      * but other than that all symbols are usable in kprobe multi
0337      * interface.
0338      * Filtering out duplicates by using hashmap__add, which won't
0339      * add existing entry.
0340      */
0341     f = fopen("/sys/kernel/debug/tracing/available_filter_functions", "r");
0342     if (!f)
0343         return -EINVAL;
0344 
0345     map = hashmap__new(symbol_hash, symbol_equal, NULL);
0346     if (IS_ERR(map)) {
0347         err = libbpf_get_error(map);
0348         goto error;
0349     }
0350 
0351     while (fgets(buf, sizeof(buf), f)) {
0352         /* skip modules */
0353         if (strchr(buf, '['))
0354             continue;
0355         if (sscanf(buf, "%ms$*[^\n]\n", &name) != 1)
0356             continue;
0357         /*
0358          * We attach to almost all kernel functions and some of them
0359          * will cause 'suspicious RCU usage' when fprobe is attached
0360          * to them. Filter out the current culprits - arch_cpu_idle
0361          * and rcu_* functions.
0362          */
0363         if (!strcmp(name, "arch_cpu_idle"))
0364             continue;
0365         if (!strncmp(name, "rcu_", 4))
0366             continue;
0367         if (!strcmp(name, "bpf_dispatcher_xdp_func"))
0368             continue;
0369         if (!strncmp(name, "__ftrace_invalid_address__",
0370                  sizeof("__ftrace_invalid_address__") - 1))
0371             continue;
0372         err = hashmap__add(map, name, NULL);
0373         if (err) {
0374             free(name);
0375             if (err == -EEXIST)
0376                 continue;
0377             goto error;
0378         }
0379         err = libbpf_ensure_mem((void **) &syms, &cap,
0380                     sizeof(*syms), cnt + 1);
0381         if (err) {
0382             free(name);
0383             goto error;
0384         }
0385         syms[cnt] = name;
0386         cnt++;
0387     }
0388 
0389     *symsp = syms;
0390     *cntp = cnt;
0391 
0392 error:
0393     fclose(f);
0394     hashmap__free(map);
0395     if (err) {
0396         for (i = 0; i < cnt; i++)
0397             free(syms[cnt]);
0398         free(syms);
0399     }
0400     return err;
0401 }
0402 
0403 static void test_bench_attach(void)
0404 {
0405     LIBBPF_OPTS(bpf_kprobe_multi_opts, opts);
0406     struct kprobe_multi_empty *skel = NULL;
0407     long attach_start_ns, attach_end_ns;
0408     long detach_start_ns, detach_end_ns;
0409     double attach_delta, detach_delta;
0410     struct bpf_link *link = NULL;
0411     char **syms = NULL;
0412     size_t cnt = 0, i;
0413 
0414     if (!ASSERT_OK(get_syms(&syms, &cnt), "get_syms"))
0415         return;
0416 
0417     skel = kprobe_multi_empty__open_and_load();
0418     if (!ASSERT_OK_PTR(skel, "kprobe_multi_empty__open_and_load"))
0419         goto cleanup;
0420 
0421     opts.syms = (const char **) syms;
0422     opts.cnt = cnt;
0423 
0424     attach_start_ns = get_time_ns();
0425     link = bpf_program__attach_kprobe_multi_opts(skel->progs.test_kprobe_empty,
0426                              NULL, &opts);
0427     attach_end_ns = get_time_ns();
0428 
0429     if (!ASSERT_OK_PTR(link, "bpf_program__attach_kprobe_multi_opts"))
0430         goto cleanup;
0431 
0432     detach_start_ns = get_time_ns();
0433     bpf_link__destroy(link);
0434     detach_end_ns = get_time_ns();
0435 
0436     attach_delta = (attach_end_ns - attach_start_ns) / 1000000000.0;
0437     detach_delta = (detach_end_ns - detach_start_ns) / 1000000000.0;
0438 
0439     printf("%s: found %lu functions\n", __func__, cnt);
0440     printf("%s: attached in %7.3lfs\n", __func__, attach_delta);
0441     printf("%s: detached in %7.3lfs\n", __func__, detach_delta);
0442 
0443 cleanup:
0444     kprobe_multi_empty__destroy(skel);
0445     if (syms) {
0446         for (i = 0; i < cnt; i++)
0447             free(syms[i]);
0448         free(syms);
0449     }
0450 }
0451 
0452 void test_kprobe_multi_test(void)
0453 {
0454     if (!ASSERT_OK(load_kallsyms(), "load_kallsyms"))
0455         return;
0456 
0457     if (test__start_subtest("skel_api"))
0458         test_skel_api();
0459     if (test__start_subtest("link_api_addrs"))
0460         test_link_api_syms();
0461     if (test__start_subtest("link_api_syms"))
0462         test_link_api_addrs();
0463     if (test__start_subtest("attach_api_pattern"))
0464         test_attach_api_pattern();
0465     if (test__start_subtest("attach_api_addrs"))
0466         test_attach_api_addrs();
0467     if (test__start_subtest("attach_api_syms"))
0468         test_attach_api_syms();
0469     if (test__start_subtest("attach_api_fails"))
0470         test_attach_api_fails();
0471     if (test__start_subtest("bench_attach"))
0472         test_bench_attach();
0473 }