1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
6 * Copyright (C) 2015 Huawei Inc.
10 #include <bpf/libbpf.h>
12 #include <linux/err.h>
13 #include <linux/kernel.h>
14 #include <linux/string.h>
15 #include <linux/zalloc.h>
20 #include "bpf-loader.h"
21 #include "bpf-prologue.h"
22 #include "probe-event.h"
23 #include "probe-finder.h" // for MAX_PROBES
24 #include "parse-events.h"
25 #include "strfilter.h"
27 #include "llvm-utils.h"
28 #include "c++/clang-c.h"
30 #include <internal/xyarray.h>
32 /* temporarily disable libbpf deprecation warnings */
33 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
35 static int libbpf_perf_print(enum libbpf_print_level level __attribute__((unused)),
36 const char *fmt, va_list args)
38 return veprintf(1, verbose, pr_fmt(fmt), args);
41 struct bpf_prog_priv {
45 struct perf_probe_event pev;
47 struct bpf_insn *insns_buf;
52 static bool libbpf_initialized;
55 bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz, const char *name)
57 LIBBPF_OPTS(bpf_object_open_opts, opts, .object_name = name);
58 struct bpf_object *obj;
60 if (!libbpf_initialized) {
61 libbpf_set_print(libbpf_perf_print);
62 libbpf_initialized = true;
65 obj = bpf_object__open_mem(obj_buf, obj_buf_sz, &opts);
66 if (IS_ERR_OR_NULL(obj)) {
67 pr_debug("bpf: failed to load buffer\n");
68 return ERR_PTR(-EINVAL);
74 struct bpf_object *bpf__prepare_load(const char *filename, bool source)
76 LIBBPF_OPTS(bpf_object_open_opts, opts, .object_name = filename);
77 struct bpf_object *obj;
79 if (!libbpf_initialized) {
80 libbpf_set_print(libbpf_perf_print);
81 libbpf_initialized = true;
90 err = perf_clang__compile_bpf(filename, &obj_buf, &obj_buf_sz);
91 perf_clang__cleanup();
93 pr_debug("bpf: builtin compilation failed: %d, try external compiler\n", err);
94 err = llvm__compile_bpf(filename, &obj_buf, &obj_buf_sz);
96 return ERR_PTR(-BPF_LOADER_ERRNO__COMPILE);
98 pr_debug("bpf: successful builtin compilation\n");
99 obj = bpf_object__open_mem(obj_buf, obj_buf_sz, &opts);
101 if (!IS_ERR_OR_NULL(obj) && llvm_param.dump_obj)
102 llvm__dump_obj(filename, obj_buf, obj_buf_sz);
106 obj = bpf_object__open(filename);
108 if (IS_ERR_OR_NULL(obj)) {
109 pr_debug("bpf: failed to load %s\n", filename);
116 void bpf__clear(void)
118 struct bpf_object *obj, *tmp;
120 bpf_object__for_each_safe(obj, tmp) {
122 bpf_object__close(obj);
127 clear_prog_priv(struct bpf_program *prog __maybe_unused,
130 struct bpf_prog_priv *priv = _priv;
132 cleanup_perf_probe_events(&priv->pev, 1);
133 zfree(&priv->insns_buf);
134 zfree(&priv->type_mapping);
135 zfree(&priv->sys_name);
136 zfree(&priv->evt_name);
141 prog_config__exec(const char *value, struct perf_probe_event *pev)
144 pev->target = strdup(value);
151 prog_config__module(const char *value, struct perf_probe_event *pev)
153 pev->uprobes = false;
154 pev->target = strdup(value);
161 prog_config__bool(const char *value, bool *pbool, bool invert)
169 err = strtobool(value, &bool_value);
173 *pbool = invert ? !bool_value : bool_value;
178 prog_config__inlines(const char *value,
179 struct perf_probe_event *pev __maybe_unused)
181 return prog_config__bool(value, &probe_conf.no_inlines, true);
185 prog_config__force(const char *value,
186 struct perf_probe_event *pev __maybe_unused)
188 return prog_config__bool(value, &probe_conf.force_add, false);
195 int (*func)(const char *, struct perf_probe_event *);
196 } bpf_prog_config_terms[] = {
199 .usage = "exec=<full path of file>",
200 .desc = "Set uprobe target",
201 .func = prog_config__exec,
205 .usage = "module=<module name> ",
206 .desc = "Set kprobe module",
207 .func = prog_config__module,
211 .usage = "inlines=[yes|no] ",
212 .desc = "Probe at inline symbol",
213 .func = prog_config__inlines,
217 .usage = "force=[yes|no] ",
218 .desc = "Forcibly add events with existing name",
219 .func = prog_config__force,
224 do_prog_config(const char *key, const char *value,
225 struct perf_probe_event *pev)
229 pr_debug("config bpf program: %s=%s\n", key, value);
230 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
231 if (strcmp(key, bpf_prog_config_terms[i].key) == 0)
232 return bpf_prog_config_terms[i].func(value, pev);
234 pr_debug("BPF: ERROR: invalid program config option: %s=%s\n",
237 pr_debug("\nHint: Valid options are:\n");
238 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
239 pr_debug("\t%s:\t%s\n", bpf_prog_config_terms[i].usage,
240 bpf_prog_config_terms[i].desc);
243 return -BPF_LOADER_ERRNO__PROGCONF_TERM;
247 parse_prog_config_kvpair(const char *config_str, struct perf_probe_event *pev)
249 char *text = strdup(config_str);
251 const char *main_str = NULL;
255 pr_debug("Not enough memory: dup config_str failed\n");
256 return ERR_PTR(-ENOMEM);
260 while ((sep = strchr(line, ';'))) {
264 equ = strchr(line, '=');
266 pr_warning("WARNING: invalid config in BPF object: %s\n",
268 pr_warning("\tShould be 'key=value'.\n");
273 err = do_prog_config(line, equ + 1, pev);
281 main_str = config_str + (line - text);
284 return err ? ERR_PTR(err) : main_str;
288 parse_prog_config(const char *config_str, const char **p_main_str,
289 bool *is_tp, struct perf_probe_event *pev)
292 const char *main_str = parse_prog_config_kvpair(config_str, pev);
294 if (IS_ERR(main_str))
295 return PTR_ERR(main_str);
297 *p_main_str = main_str;
298 if (!strchr(main_str, '=')) {
299 /* Is a tracepoint event? */
300 const char *s = strchr(main_str, ':');
303 pr_debug("bpf: '%s' is not a valid tracepoint\n",
305 return -BPF_LOADER_ERRNO__CONFIG;
313 err = parse_perf_probe_command(main_str, pev);
315 pr_debug("bpf: '%s' is not a valid config string\n",
317 /* parse failed, don't need clear pev. */
318 return -BPF_LOADER_ERRNO__CONFIG;
324 config_bpf_program(struct bpf_program *prog)
326 struct perf_probe_event *pev = NULL;
327 struct bpf_prog_priv *priv = NULL;
328 const char *config_str, *main_str;
332 /* Initialize per-program probing setting */
333 probe_conf.no_inlines = false;
334 probe_conf.force_add = false;
336 priv = calloc(sizeof(*priv), 1);
338 pr_debug("bpf: failed to alloc priv\n");
343 config_str = bpf_program__section_name(prog);
344 pr_debug("bpf: config program '%s'\n", config_str);
345 err = parse_prog_config(config_str, &main_str, &is_tp, pev);
350 char *s = strchr(main_str, ':');
353 priv->sys_name = strndup(main_str, s - main_str);
354 priv->evt_name = strdup(s + 1);
358 if (pev->group && strcmp(pev->group, PERF_BPF_PROBE_GROUP)) {
359 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
360 config_str, PERF_BPF_PROBE_GROUP);
361 err = -BPF_LOADER_ERRNO__GROUP;
363 } else if (!pev->group)
364 pev->group = strdup(PERF_BPF_PROBE_GROUP);
367 pr_debug("bpf: strdup failed\n");
373 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
375 err = -BPF_LOADER_ERRNO__EVENTNAME;
378 pr_debug("bpf: config '%s' is ok\n", config_str);
381 err = bpf_program__set_priv(prog, priv, clear_prog_priv);
383 pr_debug("Failed to set priv for program '%s'\n", config_str);
391 clear_perf_probe_event(pev);
396 static int bpf__prepare_probe(void)
399 static bool initialized = false;
402 * Make err static, so if init failed the first, bpf__prepare_probe()
403 * fails each time without calling init_probe_symbol_maps multiple
410 err = init_probe_symbol_maps(false);
412 pr_debug("Failed to init_probe_symbol_maps\n");
413 probe_conf.max_probes = MAX_PROBES;
418 preproc_gen_prologue(struct bpf_program *prog, int n,
419 struct bpf_insn *orig_insns, int orig_insns_cnt,
420 struct bpf_prog_prep_result *res)
422 struct bpf_prog_priv *priv = bpf_program__priv(prog);
423 struct probe_trace_event *tev;
424 struct perf_probe_event *pev;
425 struct bpf_insn *buf;
426 size_t prologue_cnt = 0;
429 if (IS_ERR_OR_NULL(priv) || priv->is_tp)
434 if (n < 0 || n >= priv->nr_types)
437 /* Find a tev belongs to that type */
438 for (i = 0; i < pev->ntevs; i++) {
439 if (priv->type_mapping[i] == n)
443 if (i >= pev->ntevs) {
444 pr_debug("Internal error: prologue type %d not found\n", n);
445 return -BPF_LOADER_ERRNO__PROLOGUE;
450 buf = priv->insns_buf;
451 err = bpf__gen_prologue(tev->args, tev->nargs,
453 BPF_MAXINSNS - orig_insns_cnt);
457 title = bpf_program__section_name(prog);
458 pr_debug("Failed to generate prologue for program %s\n",
463 memcpy(&buf[prologue_cnt], orig_insns,
464 sizeof(struct bpf_insn) * orig_insns_cnt);
466 res->new_insn_ptr = buf;
467 res->new_insn_cnt = prologue_cnt + orig_insns_cnt;
472 pr_debug("Internal error in preproc_gen_prologue\n");
473 return -BPF_LOADER_ERRNO__PROLOGUE;
477 * compare_tev_args is reflexive, transitive and antisymmetric.
478 * I can proof it but this margin is too narrow to contain.
480 static int compare_tev_args(const void *ptev1, const void *ptev2)
483 const struct probe_trace_event *tev1 =
484 *(const struct probe_trace_event **)ptev1;
485 const struct probe_trace_event *tev2 =
486 *(const struct probe_trace_event **)ptev2;
488 ret = tev2->nargs - tev1->nargs;
492 for (i = 0; i < tev1->nargs; i++) {
493 struct probe_trace_arg *arg1, *arg2;
494 struct probe_trace_arg_ref *ref1, *ref2;
496 arg1 = &tev1->args[i];
497 arg2 = &tev2->args[i];
499 ret = strcmp(arg1->value, arg2->value);
506 while (ref1 && ref2) {
507 ret = ref2->offset - ref1->offset;
516 return ref2 ? 1 : -1;
523 * Assign a type number to each tevs in a pev.
524 * mapping is an array with same slots as tevs in that pev.
525 * nr_types will be set to number of types.
527 static int map_prologue(struct perf_probe_event *pev, int *mapping,
531 struct probe_trace_event **ptevs;
533 size_t array_sz = sizeof(*ptevs) * pev->ntevs;
535 ptevs = malloc(array_sz);
537 pr_debug("Not enough memory: alloc ptevs failed\n");
541 pr_debug("In map_prologue, ntevs=%d\n", pev->ntevs);
542 for (i = 0; i < pev->ntevs; i++)
543 ptevs[i] = &pev->tevs[i];
545 qsort(ptevs, pev->ntevs, sizeof(*ptevs),
548 for (i = 0; i < pev->ntevs; i++) {
551 n = ptevs[i] - pev->tevs;
554 pr_debug("mapping[%d]=%d\n", n, type);
558 if (compare_tev_args(ptevs + i, ptevs + i - 1) == 0)
563 pr_debug("mapping[%d]=%d\n", n, mapping[n]);
566 *nr_types = type + 1;
571 static int hook_load_preprocessor(struct bpf_program *prog)
573 struct bpf_prog_priv *priv = bpf_program__priv(prog);
574 struct perf_probe_event *pev;
575 bool need_prologue = false;
578 if (IS_ERR_OR_NULL(priv)) {
579 pr_debug("Internal error when hook preprocessor\n");
580 return -BPF_LOADER_ERRNO__INTERNAL;
584 priv->need_prologue = false;
589 for (i = 0; i < pev->ntevs; i++) {
590 struct probe_trace_event *tev = &pev->tevs[i];
592 if (tev->nargs > 0) {
593 need_prologue = true;
599 * Since all tevs don't have argument, we don't need generate
602 if (!need_prologue) {
603 priv->need_prologue = false;
607 priv->need_prologue = true;
608 priv->insns_buf = malloc(sizeof(struct bpf_insn) * BPF_MAXINSNS);
609 if (!priv->insns_buf) {
610 pr_debug("Not enough memory: alloc insns_buf failed\n");
614 priv->type_mapping = malloc(sizeof(int) * pev->ntevs);
615 if (!priv->type_mapping) {
616 pr_debug("Not enough memory: alloc type_mapping failed\n");
619 memset(priv->type_mapping, -1,
620 sizeof(int) * pev->ntevs);
622 err = map_prologue(pev, priv->type_mapping, &priv->nr_types);
626 err = bpf_program__set_prep(prog, priv->nr_types,
627 preproc_gen_prologue);
631 int bpf__probe(struct bpf_object *obj)
634 struct bpf_program *prog;
635 struct bpf_prog_priv *priv;
636 struct perf_probe_event *pev;
638 err = bpf__prepare_probe();
640 pr_debug("bpf__prepare_probe failed\n");
644 bpf_object__for_each_program(prog, obj) {
645 err = config_bpf_program(prog);
649 priv = bpf_program__priv(prog);
650 if (IS_ERR_OR_NULL(priv)) {
652 err = -BPF_LOADER_ERRNO__INTERNAL;
659 bpf_program__set_type(prog, BPF_PROG_TYPE_TRACEPOINT);
663 bpf_program__set_type(prog, BPF_PROG_TYPE_KPROBE);
666 err = convert_perf_probe_events(pev, 1);
668 pr_debug("bpf_probe: failed to convert perf probe events\n");
672 err = apply_perf_probe_events(pev, 1);
674 pr_debug("bpf_probe: failed to apply perf probe events\n");
679 * After probing, let's consider prologue, which
680 * adds program fetcher to BPF programs.
682 * hook_load_preprocessor() hooks pre-processor
683 * to bpf_program, let it generate prologue
684 * dynamically during loading.
686 err = hook_load_preprocessor(prog);
691 return err < 0 ? err : 0;
694 #define EVENTS_WRITE_BUFSIZE 4096
695 int bpf__unprobe(struct bpf_object *obj)
698 struct bpf_program *prog;
700 bpf_object__for_each_program(prog, obj) {
701 struct bpf_prog_priv *priv = bpf_program__priv(prog);
704 if (IS_ERR_OR_NULL(priv) || priv->is_tp)
707 for (i = 0; i < priv->pev.ntevs; i++) {
708 struct probe_trace_event *tev = &priv->pev.tevs[i];
709 char name_buf[EVENTS_WRITE_BUFSIZE];
710 struct strfilter *delfilter;
712 snprintf(name_buf, EVENTS_WRITE_BUFSIZE,
713 "%s:%s", tev->group, tev->event);
714 name_buf[EVENTS_WRITE_BUFSIZE - 1] = '\0';
716 delfilter = strfilter__new(name_buf, NULL);
718 pr_debug("Failed to create filter for unprobing\n");
723 err = del_perf_probe_events(delfilter);
724 strfilter__delete(delfilter);
726 pr_debug("Failed to delete %s\n", name_buf);
735 int bpf__load(struct bpf_object *obj)
739 err = bpf_object__load(obj);
742 libbpf_strerror(err, bf, sizeof(bf));
743 pr_debug("bpf: load objects failed: err=%d: (%s)\n", err, bf);
749 int bpf__foreach_event(struct bpf_object *obj,
750 bpf_prog_iter_callback_t func,
753 struct bpf_program *prog;
756 bpf_object__for_each_program(prog, obj) {
757 struct bpf_prog_priv *priv = bpf_program__priv(prog);
758 struct probe_trace_event *tev;
759 struct perf_probe_event *pev;
762 if (IS_ERR_OR_NULL(priv)) {
763 pr_debug("bpf: failed to get private field\n");
764 return -BPF_LOADER_ERRNO__INTERNAL;
768 fd = bpf_program__fd(prog);
769 err = (*func)(priv->sys_name, priv->evt_name, fd, obj, arg);
771 pr_debug("bpf: tracepoint call back failed, stop iterate\n");
778 for (i = 0; i < pev->ntevs; i++) {
781 if (priv->need_prologue) {
782 int type = priv->type_mapping[i];
784 fd = bpf_program__nth_fd(prog, type);
786 fd = bpf_program__fd(prog);
790 pr_debug("bpf: failed to get file descriptor\n");
794 err = (*func)(tev->group, tev->event, fd, obj, arg);
796 pr_debug("bpf: call back failed, stop iterate\n");
804 enum bpf_map_op_type {
805 BPF_MAP_OP_SET_VALUE,
806 BPF_MAP_OP_SET_EVSEL,
809 enum bpf_map_key_type {
815 struct list_head list;
816 enum bpf_map_op_type op_type;
817 enum bpf_map_key_type key_type;
819 struct parse_events_array array;
827 struct bpf_map_priv {
828 struct list_head ops_list;
832 bpf_map_op__delete(struct bpf_map_op *op)
834 if (!list_empty(&op->list))
835 list_del_init(&op->list);
836 if (op->key_type == BPF_MAP_KEY_RANGES)
837 parse_events__clear_array(&op->k.array);
842 bpf_map_priv__purge(struct bpf_map_priv *priv)
844 struct bpf_map_op *pos, *n;
846 list_for_each_entry_safe(pos, n, &priv->ops_list, list) {
847 list_del_init(&pos->list);
848 bpf_map_op__delete(pos);
853 bpf_map_priv__clear(struct bpf_map *map __maybe_unused,
856 struct bpf_map_priv *priv = _priv;
858 bpf_map_priv__purge(priv);
863 bpf_map_op_setkey(struct bpf_map_op *op, struct parse_events_term *term)
865 op->key_type = BPF_MAP_KEY_ALL;
869 if (term->array.nr_ranges) {
870 size_t memsz = term->array.nr_ranges *
871 sizeof(op->k.array.ranges[0]);
873 op->k.array.ranges = memdup(term->array.ranges, memsz);
874 if (!op->k.array.ranges) {
875 pr_debug("Not enough memory to alloc indices for map\n");
878 op->key_type = BPF_MAP_KEY_RANGES;
879 op->k.array.nr_ranges = term->array.nr_ranges;
884 static struct bpf_map_op *
885 bpf_map_op__new(struct parse_events_term *term)
887 struct bpf_map_op *op;
890 op = zalloc(sizeof(*op));
892 pr_debug("Failed to alloc bpf_map_op\n");
893 return ERR_PTR(-ENOMEM);
895 INIT_LIST_HEAD(&op->list);
897 err = bpf_map_op_setkey(op, term);
905 static struct bpf_map_op *
906 bpf_map_op__clone(struct bpf_map_op *op)
908 struct bpf_map_op *newop;
910 newop = memdup(op, sizeof(*op));
912 pr_debug("Failed to alloc bpf_map_op\n");
916 INIT_LIST_HEAD(&newop->list);
917 if (op->key_type == BPF_MAP_KEY_RANGES) {
918 size_t memsz = op->k.array.nr_ranges *
919 sizeof(op->k.array.ranges[0]);
921 newop->k.array.ranges = memdup(op->k.array.ranges, memsz);
922 if (!newop->k.array.ranges) {
923 pr_debug("Failed to alloc indices for map\n");
932 static struct bpf_map_priv *
933 bpf_map_priv__clone(struct bpf_map_priv *priv)
935 struct bpf_map_priv *newpriv;
936 struct bpf_map_op *pos, *newop;
938 newpriv = zalloc(sizeof(*newpriv));
940 pr_debug("Not enough memory to alloc map private\n");
943 INIT_LIST_HEAD(&newpriv->ops_list);
945 list_for_each_entry(pos, &priv->ops_list, list) {
946 newop = bpf_map_op__clone(pos);
948 bpf_map_priv__purge(newpriv);
951 list_add_tail(&newop->list, &newpriv->ops_list);
958 bpf_map__add_op(struct bpf_map *map, struct bpf_map_op *op)
960 const char *map_name = bpf_map__name(map);
961 struct bpf_map_priv *priv = bpf_map__priv(map);
964 pr_debug("Failed to get private from map %s\n", map_name);
965 return PTR_ERR(priv);
969 priv = zalloc(sizeof(*priv));
971 pr_debug("Not enough memory to alloc map private\n");
974 INIT_LIST_HEAD(&priv->ops_list);
976 if (bpf_map__set_priv(map, priv, bpf_map_priv__clear)) {
978 return -BPF_LOADER_ERRNO__INTERNAL;
982 list_add_tail(&op->list, &priv->ops_list);
986 static struct bpf_map_op *
987 bpf_map__add_newop(struct bpf_map *map, struct parse_events_term *term)
989 struct bpf_map_op *op;
992 op = bpf_map_op__new(term);
996 err = bpf_map__add_op(map, op);
998 bpf_map_op__delete(op);
1005 __bpf_map__config_value(struct bpf_map *map,
1006 struct parse_events_term *term)
1008 struct bpf_map_op *op;
1009 const char *map_name = bpf_map__name(map);
1012 pr_debug("Map '%s' is invalid\n", map_name);
1013 return -BPF_LOADER_ERRNO__INTERNAL;
1016 if (bpf_map__type(map) != BPF_MAP_TYPE_ARRAY) {
1017 pr_debug("Map %s type is not BPF_MAP_TYPE_ARRAY\n",
1019 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1021 if (bpf_map__key_size(map) < sizeof(unsigned int)) {
1022 pr_debug("Map %s has incorrect key size\n", map_name);
1023 return -BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE;
1025 switch (bpf_map__value_size(map)) {
1032 pr_debug("Map %s has incorrect value size\n", map_name);
1033 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1036 op = bpf_map__add_newop(map, term);
1039 op->op_type = BPF_MAP_OP_SET_VALUE;
1040 op->v.value = term->val.num;
1045 bpf_map__config_value(struct bpf_map *map,
1046 struct parse_events_term *term,
1047 struct evlist *evlist __maybe_unused)
1049 if (!term->err_val) {
1050 pr_debug("Config value not set\n");
1051 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1054 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM) {
1055 pr_debug("ERROR: wrong value type for 'value'\n");
1056 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1059 return __bpf_map__config_value(map, term);
1063 __bpf_map__config_event(struct bpf_map *map,
1064 struct parse_events_term *term,
1065 struct evlist *evlist)
1067 struct bpf_map_op *op;
1068 const char *map_name = bpf_map__name(map);
1069 struct evsel *evsel = evlist__find_evsel_by_str(evlist, term->val.str);
1072 pr_debug("Event (for '%s') '%s' doesn't exist\n",
1073 map_name, term->val.str);
1074 return -BPF_LOADER_ERRNO__OBJCONF_MAP_NOEVT;
1078 pr_debug("Map '%s' is invalid\n", map_name);
1079 return PTR_ERR(map);
1083 * No need to check key_size and value_size:
1084 * kernel has already checked them.
1086 if (bpf_map__type(map) != BPF_MAP_TYPE_PERF_EVENT_ARRAY) {
1087 pr_debug("Map %s type is not BPF_MAP_TYPE_PERF_EVENT_ARRAY\n",
1089 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1092 op = bpf_map__add_newop(map, term);
1095 op->op_type = BPF_MAP_OP_SET_EVSEL;
1096 op->v.evsel = evsel;
1101 bpf_map__config_event(struct bpf_map *map,
1102 struct parse_events_term *term,
1103 struct evlist *evlist)
1105 if (!term->err_val) {
1106 pr_debug("Config value not set\n");
1107 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1110 if (term->type_val != PARSE_EVENTS__TERM_TYPE_STR) {
1111 pr_debug("ERROR: wrong value type for 'event'\n");
1112 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1115 return __bpf_map__config_event(map, term, evlist);
1118 struct bpf_obj_config__map_func {
1119 const char *config_opt;
1120 int (*config_func)(struct bpf_map *, struct parse_events_term *,
1124 struct bpf_obj_config__map_func bpf_obj_config__map_funcs[] = {
1125 {"value", bpf_map__config_value},
1126 {"event", bpf_map__config_event},
1130 config_map_indices_range_check(struct parse_events_term *term,
1131 struct bpf_map *map,
1132 const char *map_name)
1134 struct parse_events_array *array = &term->array;
1137 if (!array->nr_ranges)
1139 if (!array->ranges) {
1140 pr_debug("ERROR: map %s: array->nr_ranges is %d but range array is NULL\n",
1141 map_name, (int)array->nr_ranges);
1142 return -BPF_LOADER_ERRNO__INTERNAL;
1146 pr_debug("Map '%s' is invalid\n", map_name);
1147 return -BPF_LOADER_ERRNO__INTERNAL;
1150 for (i = 0; i < array->nr_ranges; i++) {
1151 unsigned int start = array->ranges[i].start;
1152 size_t length = array->ranges[i].length;
1153 unsigned int idx = start + length - 1;
1155 if (idx >= bpf_map__max_entries(map)) {
1156 pr_debug("ERROR: index %d too large\n", idx);
1157 return -BPF_LOADER_ERRNO__OBJCONF_MAP_IDX2BIG;
1164 bpf__obj_config_map(struct bpf_object *obj,
1165 struct parse_events_term *term,
1166 struct evlist *evlist,
1169 /* key is "map:<mapname>.<config opt>" */
1170 char *map_name = strdup(term->config + sizeof("map:") - 1);
1171 struct bpf_map *map;
1172 int err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1179 map_opt = strchr(map_name, '.');
1181 pr_debug("ERROR: Invalid map config: %s\n", map_name);
1186 if (*map_opt == '\0') {
1187 pr_debug("ERROR: Invalid map option: %s\n", term->config);
1191 map = bpf_object__find_map_by_name(obj, map_name);
1193 pr_debug("ERROR: Map %s doesn't exist\n", map_name);
1194 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST;
1198 *key_scan_pos += strlen(map_opt);
1199 err = config_map_indices_range_check(term, map, map_name);
1202 *key_scan_pos -= strlen(map_opt);
1204 for (i = 0; i < ARRAY_SIZE(bpf_obj_config__map_funcs); i++) {
1205 struct bpf_obj_config__map_func *func =
1206 &bpf_obj_config__map_funcs[i];
1208 if (strcmp(map_opt, func->config_opt) == 0) {
1209 err = func->config_func(map, term, evlist);
1214 pr_debug("ERROR: Invalid map config option '%s'\n", map_opt);
1215 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_OPT;
1218 *key_scan_pos += strlen(map_opt);
1224 int bpf__config_obj(struct bpf_object *obj,
1225 struct parse_events_term *term,
1226 struct evlist *evlist,
1229 int key_scan_pos = 0;
1232 if (!obj || !term || !term->config)
1235 if (strstarts(term->config, "map:")) {
1236 key_scan_pos = sizeof("map:") - 1;
1237 err = bpf__obj_config_map(obj, term, evlist, &key_scan_pos);
1240 err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1243 *error_pos = key_scan_pos;
1248 typedef int (*map_config_func_t)(const char *name, int map_fd,
1249 const struct bpf_map *map,
1250 struct bpf_map_op *op,
1251 void *pkey, void *arg);
1254 foreach_key_array_all(map_config_func_t func,
1255 void *arg, const char *name,
1256 int map_fd, const struct bpf_map *map,
1257 struct bpf_map_op *op)
1262 for (i = 0; i < bpf_map__max_entries(map); i++) {
1263 err = func(name, map_fd, map, op, &i, arg);
1265 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1274 foreach_key_array_ranges(map_config_func_t func, void *arg,
1275 const char *name, int map_fd,
1276 const struct bpf_map *map,
1277 struct bpf_map_op *op)
1282 for (i = 0; i < op->k.array.nr_ranges; i++) {
1283 unsigned int start = op->k.array.ranges[i].start;
1284 size_t length = op->k.array.ranges[i].length;
1286 for (j = 0; j < length; j++) {
1287 unsigned int idx = start + j;
1289 err = func(name, map_fd, map, op, &idx, arg);
1291 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1301 bpf_map_config_foreach_key(struct bpf_map *map,
1302 map_config_func_t func,
1305 int err, map_fd, type;
1306 struct bpf_map_op *op;
1307 const char *name = bpf_map__name(map);
1308 struct bpf_map_priv *priv = bpf_map__priv(map);
1311 pr_debug("ERROR: failed to get private from map %s\n", name);
1312 return -BPF_LOADER_ERRNO__INTERNAL;
1314 if (!priv || list_empty(&priv->ops_list)) {
1315 pr_debug("INFO: nothing to config for map %s\n", name);
1320 pr_debug("Map '%s' is invalid\n", name);
1321 return -BPF_LOADER_ERRNO__INTERNAL;
1323 map_fd = bpf_map__fd(map);
1325 pr_debug("ERROR: failed to get fd from map %s\n", name);
1329 type = bpf_map__type(map);
1330 list_for_each_entry(op, &priv->ops_list, list) {
1332 case BPF_MAP_TYPE_ARRAY:
1333 case BPF_MAP_TYPE_PERF_EVENT_ARRAY:
1334 switch (op->key_type) {
1335 case BPF_MAP_KEY_ALL:
1336 err = foreach_key_array_all(func, arg, name,
1339 case BPF_MAP_KEY_RANGES:
1340 err = foreach_key_array_ranges(func, arg, name,
1344 pr_debug("ERROR: keytype for map '%s' invalid\n",
1346 return -BPF_LOADER_ERRNO__INTERNAL;
1352 pr_debug("ERROR: type of '%s' incorrect\n", name);
1353 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1361 apply_config_value_for_key(int map_fd, void *pkey,
1362 size_t val_size, u64 val)
1368 u8 _val = (u8)(val);
1369 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1373 u16 _val = (u16)(val);
1374 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1378 u32 _val = (u32)(val);
1379 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1383 err = bpf_map_update_elem(map_fd, pkey, &val, BPF_ANY);
1387 pr_debug("ERROR: invalid value size\n");
1388 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1396 apply_config_evsel_for_key(const char *name, int map_fd, void *pkey,
1397 struct evsel *evsel)
1399 struct xyarray *xy = evsel->core.fd;
1400 struct perf_event_attr *attr;
1401 unsigned int key, events;
1402 bool check_pass = false;
1407 pr_debug("ERROR: evsel not ready for map %s\n", name);
1408 return -BPF_LOADER_ERRNO__INTERNAL;
1411 if (xy->row_size / xy->entry_size != 1) {
1412 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1414 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM;
1417 attr = &evsel->core.attr;
1418 if (attr->inherit) {
1419 pr_debug("ERROR: Can't put inherit event into map %s\n", name);
1420 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH;
1423 if (evsel__is_bpf_output(evsel))
1425 if (attr->type == PERF_TYPE_RAW)
1427 if (attr->type == PERF_TYPE_HARDWARE)
1430 pr_debug("ERROR: Event type is wrong for map %s\n", name);
1431 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE;
1434 events = xy->entries / (xy->row_size / xy->entry_size);
1435 key = *((unsigned int *)pkey);
1436 if (key >= events) {
1437 pr_debug("ERROR: there is no event %d for map %s\n",
1439 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE;
1441 evt_fd = xyarray__entry(xy, key, 0);
1442 err = bpf_map_update_elem(map_fd, pkey, evt_fd, BPF_ANY);
1449 apply_obj_config_map_for_key(const char *name, int map_fd,
1450 const struct bpf_map *map,
1451 struct bpf_map_op *op,
1452 void *pkey, void *arg __maybe_unused)
1456 switch (op->op_type) {
1457 case BPF_MAP_OP_SET_VALUE:
1458 err = apply_config_value_for_key(map_fd, pkey,
1459 bpf_map__value_size(map),
1462 case BPF_MAP_OP_SET_EVSEL:
1463 err = apply_config_evsel_for_key(name, map_fd, pkey,
1467 pr_debug("ERROR: unknown value type for '%s'\n", name);
1468 err = -BPF_LOADER_ERRNO__INTERNAL;
1474 apply_obj_config_map(struct bpf_map *map)
1476 return bpf_map_config_foreach_key(map,
1477 apply_obj_config_map_for_key,
1482 apply_obj_config_object(struct bpf_object *obj)
1484 struct bpf_map *map;
1487 bpf_object__for_each_map(map, obj) {
1488 err = apply_obj_config_map(map);
1495 int bpf__apply_obj_config(void)
1497 struct bpf_object *obj, *tmp;
1500 bpf_object__for_each_safe(obj, tmp) {
1501 err = apply_obj_config_object(obj);
1509 #define bpf__for_each_map(pos, obj, objtmp) \
1510 bpf_object__for_each_safe(obj, objtmp) \
1511 bpf_object__for_each_map(pos, obj)
1513 #define bpf__for_each_map_named(pos, obj, objtmp, name) \
1514 bpf__for_each_map(pos, obj, objtmp) \
1515 if (bpf_map__name(pos) && \
1517 bpf_map__name(pos)) == 0))
1519 struct evsel *bpf__setup_output_event(struct evlist *evlist, const char *name)
1521 struct bpf_map_priv *tmpl_priv = NULL;
1522 struct bpf_object *obj, *tmp;
1523 struct evsel *evsel = NULL;
1524 struct bpf_map *map;
1526 bool need_init = false;
1528 bpf__for_each_map_named(map, obj, tmp, name) {
1529 struct bpf_map_priv *priv = bpf_map__priv(map);
1532 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL);
1535 * No need to check map type: type should have been
1536 * verified by kernel.
1538 if (!need_init && !priv)
1540 if (!tmpl_priv && priv)
1548 char *event_definition = NULL;
1550 if (asprintf(&event_definition, "bpf-output/no-inherit=1,name=%s/", name) < 0)
1551 return ERR_PTR(-ENOMEM);
1553 err = parse_events(evlist, event_definition, NULL);
1554 free(event_definition);
1557 pr_debug("ERROR: failed to create the \"%s\" bpf-output event\n", name);
1558 return ERR_PTR(-err);
1561 evsel = evlist__last(evlist);
1564 bpf__for_each_map_named(map, obj, tmp, name) {
1565 struct bpf_map_priv *priv = bpf_map__priv(map);
1568 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL);
1573 priv = bpf_map_priv__clone(tmpl_priv);
1575 return ERR_PTR(-ENOMEM);
1577 err = bpf_map__set_priv(map, priv, bpf_map_priv__clear);
1579 bpf_map_priv__clear(map, priv);
1580 return ERR_PTR(err);
1583 struct bpf_map_op *op;
1585 op = bpf_map__add_newop(map, NULL);
1587 return ERR_CAST(op);
1588 op->op_type = BPF_MAP_OP_SET_EVSEL;
1589 op->v.evsel = evsel;
1596 int bpf__setup_stdout(struct evlist *evlist)
1598 struct evsel *evsel = bpf__setup_output_event(evlist, "__bpf_stdout__");
1599 return PTR_ERR_OR_ZERO(evsel);
1602 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1603 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1604 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1606 static const char *bpf_loader_strerror_table[NR_ERRNO] = {
1607 [ERRCODE_OFFSET(CONFIG)] = "Invalid config string",
1608 [ERRCODE_OFFSET(GROUP)] = "Invalid group name",
1609 [ERRCODE_OFFSET(EVENTNAME)] = "No event name found in config string",
1610 [ERRCODE_OFFSET(INTERNAL)] = "BPF loader internal error",
1611 [ERRCODE_OFFSET(COMPILE)] = "Error when compiling BPF scriptlet",
1612 [ERRCODE_OFFSET(PROGCONF_TERM)] = "Invalid program config term in config string",
1613 [ERRCODE_OFFSET(PROLOGUE)] = "Failed to generate prologue",
1614 [ERRCODE_OFFSET(PROLOGUE2BIG)] = "Prologue too big for program",
1615 [ERRCODE_OFFSET(PROLOGUEOOB)] = "Offset out of bound for prologue",
1616 [ERRCODE_OFFSET(OBJCONF_OPT)] = "Invalid object config option",
1617 [ERRCODE_OFFSET(OBJCONF_CONF)] = "Config value not set (missing '=')",
1618 [ERRCODE_OFFSET(OBJCONF_MAP_OPT)] = "Invalid object map config option",
1619 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST)] = "Target map doesn't exist",
1620 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE)] = "Incorrect value type for map",
1621 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE)] = "Incorrect map type",
1622 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE)] = "Incorrect map key size",
1623 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE)] = "Incorrect map value size",
1624 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT)] = "Event not found for map setting",
1625 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE)] = "Invalid map size for event setting",
1626 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM)] = "Event dimension too large",
1627 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH)] = "Doesn't support inherit event",
1628 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE)] = "Wrong event type for map",
1629 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG)] = "Index too large",
1633 bpf_loader_strerror(int err, char *buf, size_t size)
1635 char sbuf[STRERR_BUFSIZE];
1641 err = err > 0 ? err : -err;
1643 if (err >= __LIBBPF_ERRNO__START)
1644 return libbpf_strerror(err, buf, size);
1646 if (err >= __BPF_LOADER_ERRNO__START && err < __BPF_LOADER_ERRNO__END) {
1647 msg = bpf_loader_strerror_table[ERRNO_OFFSET(err)];
1648 snprintf(buf, size, "%s", msg);
1649 buf[size - 1] = '\0';
1653 if (err >= __BPF_LOADER_ERRNO__END)
1654 snprintf(buf, size, "Unknown bpf loader error %d", err);
1656 snprintf(buf, size, "%s",
1657 str_error_r(err, sbuf, sizeof(sbuf)));
1659 buf[size - 1] = '\0';
1663 #define bpf__strerror_head(err, buf, size) \
1664 char sbuf[STRERR_BUFSIZE], *emsg;\
1669 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1673 scnprintf(buf, size, "%s", emsg);\
1676 #define bpf__strerror_entry(val, fmt...)\
1678 scnprintf(buf, size, fmt);\
1682 #define bpf__strerror_end(buf, size)\
1684 buf[size - 1] = '\0';
1686 int bpf__strerror_prepare_load(const char *filename, bool source,
1687 int err, char *buf, size_t size)
1692 n = snprintf(buf, size, "Failed to load %s%s: ",
1693 filename, source ? " from source" : "");
1695 buf[size - 1] = '\0';
1701 ret = bpf_loader_strerror(err, buf, size);
1702 buf[size - 1] = '\0';
1706 int bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
1707 int err, char *buf, size_t size)
1709 bpf__strerror_head(err, buf, size);
1710 case BPF_LOADER_ERRNO__PROGCONF_TERM: {
1711 scnprintf(buf, size, "%s (add -v to see detail)", emsg);
1714 bpf__strerror_entry(EEXIST, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1715 bpf__strerror_entry(EACCES, "You need to be root");
1716 bpf__strerror_entry(EPERM, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1717 bpf__strerror_entry(ENOENT, "You need to check probing points in BPF file");
1718 bpf__strerror_end(buf, size);
1722 int bpf__strerror_load(struct bpf_object *obj,
1723 int err, char *buf, size_t size)
1725 bpf__strerror_head(err, buf, size);
1726 case LIBBPF_ERRNO__KVER: {
1727 unsigned int obj_kver = bpf_object__kversion(obj);
1728 unsigned int real_kver;
1730 if (fetch_kernel_version(&real_kver, NULL, 0)) {
1731 scnprintf(buf, size, "Unable to fetch kernel version");
1735 if (obj_kver != real_kver) {
1736 scnprintf(buf, size,
1737 "'version' ("KVER_FMT") doesn't match running kernel ("KVER_FMT")",
1738 KVER_PARAM(obj_kver),
1739 KVER_PARAM(real_kver));
1743 scnprintf(buf, size, "Failed to load program for unknown reason");
1746 bpf__strerror_end(buf, size);
1750 int bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
1751 struct parse_events_term *term __maybe_unused,
1752 struct evlist *evlist __maybe_unused,
1753 int *error_pos __maybe_unused, int err,
1754 char *buf, size_t size)
1756 bpf__strerror_head(err, buf, size);
1757 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,
1758 "Can't use this config term with this map type");
1759 bpf__strerror_end(buf, size);
1763 int bpf__strerror_apply_obj_config(int err, char *buf, size_t size)
1765 bpf__strerror_head(err, buf, size);
1766 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM,
1767 "Cannot set event to BPF map in multi-thread tracing");
1768 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH,
1769 "%s (Hint: use -i to turn off inherit)", emsg);
1770 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE,
1771 "Can only put raw, hardware and BPF output event into a BPF map");
1772 bpf__strerror_end(buf, size);
1776 int bpf__strerror_setup_output_event(struct evlist *evlist __maybe_unused,
1777 int err, char *buf, size_t size)
1779 bpf__strerror_head(err, buf, size);
1780 bpf__strerror_end(buf, size);