4 * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
5 * Copyright (C) 2015 Huawei Inc.
9 #include <bpf/libbpf.h>
11 #include <linux/err.h>
12 #include <linux/string.h>
15 #include "bpf-loader.h"
16 #include "bpf-prologue.h"
17 #include "probe-event.h"
18 #include "probe-finder.h" // for MAX_PROBES
19 #include "parse-events.h"
20 #include "llvm-utils.h"
21 #include "c++/clang-c.h"
23 #define DEFINE_PRINT_FN(name, level) \
24 static int libbpf_##name(const char *fmt, ...) \
29 va_start(args, fmt); \
30 ret = veprintf(level, verbose, pr_fmt(fmt), args);\
35 DEFINE_PRINT_FN(warning, 1)
36 DEFINE_PRINT_FN(info, 1)
37 DEFINE_PRINT_FN(debug, 1)
39 struct bpf_prog_priv {
43 struct perf_probe_event pev;
45 struct bpf_insn *insns_buf;
50 static bool libbpf_initialized;
53 bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz, const char *name)
55 struct bpf_object *obj;
57 if (!libbpf_initialized) {
58 libbpf_set_print(libbpf_warning,
61 libbpf_initialized = true;
64 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, name);
66 pr_debug("bpf: failed to load buffer\n");
67 return ERR_PTR(-EINVAL);
73 struct bpf_object *bpf__prepare_load(const char *filename, bool source)
75 struct bpf_object *obj;
77 if (!libbpf_initialized) {
78 libbpf_set_print(libbpf_warning,
81 libbpf_initialized = true;
90 err = perf_clang__compile_bpf(filename, &obj_buf, &obj_buf_sz);
91 perf_clang__cleanup();
93 pr_warning("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: successfull builtin compilation\n");
99 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, filename);
101 if (!IS_ERR(obj) && llvm_param.dump_obj)
102 llvm__dump_obj(filename, obj_buf, obj_buf_sz);
106 obj = bpf_object__open(filename);
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 config_str = bpf_program__title(prog, false);
337 if (IS_ERR(config_str)) {
338 pr_debug("bpf: unable to get title for program\n");
339 return PTR_ERR(config_str);
342 priv = calloc(sizeof(*priv), 1);
344 pr_debug("bpf: failed to alloc priv\n");
349 pr_debug("bpf: config program '%s'\n", config_str);
350 err = parse_prog_config(config_str, &main_str, &is_tp, pev);
355 char *s = strchr(main_str, ':');
358 priv->sys_name = strndup(main_str, s - main_str);
359 priv->evt_name = strdup(s + 1);
363 if (pev->group && strcmp(pev->group, PERF_BPF_PROBE_GROUP)) {
364 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
365 config_str, PERF_BPF_PROBE_GROUP);
366 err = -BPF_LOADER_ERRNO__GROUP;
368 } else if (!pev->group)
369 pev->group = strdup(PERF_BPF_PROBE_GROUP);
372 pr_debug("bpf: strdup failed\n");
378 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
380 err = -BPF_LOADER_ERRNO__EVENTNAME;
383 pr_debug("bpf: config '%s' is ok\n", config_str);
386 err = bpf_program__set_priv(prog, priv, clear_prog_priv);
388 pr_debug("Failed to set priv for program '%s'\n", config_str);
396 clear_perf_probe_event(pev);
401 static int bpf__prepare_probe(void)
404 static bool initialized = false;
407 * Make err static, so if init failed the first, bpf__prepare_probe()
408 * fails each time without calling init_probe_symbol_maps multiple
415 err = init_probe_symbol_maps(false);
417 pr_debug("Failed to init_probe_symbol_maps\n");
418 probe_conf.max_probes = MAX_PROBES;
423 preproc_gen_prologue(struct bpf_program *prog, int n,
424 struct bpf_insn *orig_insns, int orig_insns_cnt,
425 struct bpf_prog_prep_result *res)
427 struct bpf_prog_priv *priv = bpf_program__priv(prog);
428 struct probe_trace_event *tev;
429 struct perf_probe_event *pev;
430 struct bpf_insn *buf;
431 size_t prologue_cnt = 0;
434 if (IS_ERR(priv) || !priv || priv->is_tp)
439 if (n < 0 || n >= priv->nr_types)
442 /* Find a tev belongs to that type */
443 for (i = 0; i < pev->ntevs; i++) {
444 if (priv->type_mapping[i] == n)
448 if (i >= pev->ntevs) {
449 pr_debug("Internal error: prologue type %d not found\n", n);
450 return -BPF_LOADER_ERRNO__PROLOGUE;
455 buf = priv->insns_buf;
456 err = bpf__gen_prologue(tev->args, tev->nargs,
458 BPF_MAXINSNS - orig_insns_cnt);
462 title = bpf_program__title(prog, false);
466 pr_debug("Failed to generate prologue for program %s\n",
471 memcpy(&buf[prologue_cnt], orig_insns,
472 sizeof(struct bpf_insn) * orig_insns_cnt);
474 res->new_insn_ptr = buf;
475 res->new_insn_cnt = prologue_cnt + orig_insns_cnt;
480 pr_debug("Internal error in preproc_gen_prologue\n");
481 return -BPF_LOADER_ERRNO__PROLOGUE;
485 * compare_tev_args is reflexive, transitive and antisymmetric.
486 * I can proof it but this margin is too narrow to contain.
488 static int compare_tev_args(const void *ptev1, const void *ptev2)
491 const struct probe_trace_event *tev1 =
492 *(const struct probe_trace_event **)ptev1;
493 const struct probe_trace_event *tev2 =
494 *(const struct probe_trace_event **)ptev2;
496 ret = tev2->nargs - tev1->nargs;
500 for (i = 0; i < tev1->nargs; i++) {
501 struct probe_trace_arg *arg1, *arg2;
502 struct probe_trace_arg_ref *ref1, *ref2;
504 arg1 = &tev1->args[i];
505 arg2 = &tev2->args[i];
507 ret = strcmp(arg1->value, arg2->value);
514 while (ref1 && ref2) {
515 ret = ref2->offset - ref1->offset;
524 return ref2 ? 1 : -1;
531 * Assign a type number to each tevs in a pev.
532 * mapping is an array with same slots as tevs in that pev.
533 * nr_types will be set to number of types.
535 static int map_prologue(struct perf_probe_event *pev, int *mapping,
539 struct probe_trace_event **ptevs;
541 size_t array_sz = sizeof(*ptevs) * pev->ntevs;
543 ptevs = malloc(array_sz);
545 pr_debug("Not enough memory: alloc ptevs failed\n");
549 pr_debug("In map_prologue, ntevs=%d\n", pev->ntevs);
550 for (i = 0; i < pev->ntevs; i++)
551 ptevs[i] = &pev->tevs[i];
553 qsort(ptevs, pev->ntevs, sizeof(*ptevs),
556 for (i = 0; i < pev->ntevs; i++) {
559 n = ptevs[i] - pev->tevs;
562 pr_debug("mapping[%d]=%d\n", n, type);
566 if (compare_tev_args(ptevs + i, ptevs + i - 1) == 0)
571 pr_debug("mapping[%d]=%d\n", n, mapping[n]);
574 *nr_types = type + 1;
579 static int hook_load_preprocessor(struct bpf_program *prog)
581 struct bpf_prog_priv *priv = bpf_program__priv(prog);
582 struct perf_probe_event *pev;
583 bool need_prologue = false;
586 if (IS_ERR(priv) || !priv) {
587 pr_debug("Internal error when hook preprocessor\n");
588 return -BPF_LOADER_ERRNO__INTERNAL;
592 priv->need_prologue = false;
597 for (i = 0; i < pev->ntevs; i++) {
598 struct probe_trace_event *tev = &pev->tevs[i];
600 if (tev->nargs > 0) {
601 need_prologue = true;
607 * Since all tevs don't have argument, we don't need generate
610 if (!need_prologue) {
611 priv->need_prologue = false;
615 priv->need_prologue = true;
616 priv->insns_buf = malloc(sizeof(struct bpf_insn) * BPF_MAXINSNS);
617 if (!priv->insns_buf) {
618 pr_debug("Not enough memory: alloc insns_buf failed\n");
622 priv->type_mapping = malloc(sizeof(int) * pev->ntevs);
623 if (!priv->type_mapping) {
624 pr_debug("Not enough memory: alloc type_mapping failed\n");
627 memset(priv->type_mapping, -1,
628 sizeof(int) * pev->ntevs);
630 err = map_prologue(pev, priv->type_mapping, &priv->nr_types);
634 err = bpf_program__set_prep(prog, priv->nr_types,
635 preproc_gen_prologue);
639 int bpf__probe(struct bpf_object *obj)
642 struct bpf_program *prog;
643 struct bpf_prog_priv *priv;
644 struct perf_probe_event *pev;
646 err = bpf__prepare_probe();
648 pr_debug("bpf__prepare_probe failed\n");
652 bpf_object__for_each_program(prog, obj) {
653 err = config_bpf_program(prog);
657 priv = bpf_program__priv(prog);
658 if (IS_ERR(priv) || !priv) {
664 bpf_program__set_tracepoint(prog);
668 bpf_program__set_kprobe(prog);
671 err = convert_perf_probe_events(pev, 1);
673 pr_debug("bpf_probe: failed to convert perf probe events\n");
677 err = apply_perf_probe_events(pev, 1);
679 pr_debug("bpf_probe: failed to apply perf probe events\n");
684 * After probing, let's consider prologue, which
685 * adds program fetcher to BPF programs.
687 * hook_load_preprocessorr() hooks pre-processor
688 * to bpf_program, let it generate prologue
689 * dynamically during loading.
691 err = hook_load_preprocessor(prog);
696 return err < 0 ? err : 0;
699 #define EVENTS_WRITE_BUFSIZE 4096
700 int bpf__unprobe(struct bpf_object *obj)
703 struct bpf_program *prog;
705 bpf_object__for_each_program(prog, obj) {
706 struct bpf_prog_priv *priv = bpf_program__priv(prog);
709 if (IS_ERR(priv) || !priv || priv->is_tp)
712 for (i = 0; i < priv->pev.ntevs; i++) {
713 struct probe_trace_event *tev = &priv->pev.tevs[i];
714 char name_buf[EVENTS_WRITE_BUFSIZE];
715 struct strfilter *delfilter;
717 snprintf(name_buf, EVENTS_WRITE_BUFSIZE,
718 "%s:%s", tev->group, tev->event);
719 name_buf[EVENTS_WRITE_BUFSIZE - 1] = '\0';
721 delfilter = strfilter__new(name_buf, NULL);
723 pr_debug("Failed to create filter for unprobing\n");
728 err = del_perf_probe_events(delfilter);
729 strfilter__delete(delfilter);
731 pr_debug("Failed to delete %s\n", name_buf);
740 int bpf__load(struct bpf_object *obj)
744 err = bpf_object__load(obj);
746 pr_debug("bpf: load objects failed\n");
752 int bpf__foreach_event(struct bpf_object *obj,
753 bpf_prog_iter_callback_t func,
756 struct bpf_program *prog;
759 bpf_object__for_each_program(prog, obj) {
760 struct bpf_prog_priv *priv = bpf_program__priv(prog);
761 struct probe_trace_event *tev;
762 struct perf_probe_event *pev;
765 if (IS_ERR(priv) || !priv) {
766 pr_debug("bpf: failed to get private field\n");
767 return -BPF_LOADER_ERRNO__INTERNAL;
771 fd = bpf_program__fd(prog);
772 err = (*func)(priv->sys_name, priv->evt_name, fd, arg);
774 pr_debug("bpf: tracepoint call back failed, stop iterate\n");
781 for (i = 0; i < pev->ntevs; i++) {
784 if (priv->need_prologue) {
785 int type = priv->type_mapping[i];
787 fd = bpf_program__nth_fd(prog, type);
789 fd = bpf_program__fd(prog);
793 pr_debug("bpf: failed to get file descriptor\n");
797 err = (*func)(tev->group, tev->event, fd, arg);
799 pr_debug("bpf: call back failed, stop iterate\n");
807 enum bpf_map_op_type {
808 BPF_MAP_OP_SET_VALUE,
809 BPF_MAP_OP_SET_EVSEL,
812 enum bpf_map_key_type {
818 struct list_head list;
819 enum bpf_map_op_type op_type;
820 enum bpf_map_key_type key_type;
822 struct parse_events_array array;
826 struct perf_evsel *evsel;
830 struct bpf_map_priv {
831 struct list_head ops_list;
835 bpf_map_op__delete(struct bpf_map_op *op)
837 if (!list_empty(&op->list))
839 if (op->key_type == BPF_MAP_KEY_RANGES)
840 parse_events__clear_array(&op->k.array);
845 bpf_map_priv__purge(struct bpf_map_priv *priv)
847 struct bpf_map_op *pos, *n;
849 list_for_each_entry_safe(pos, n, &priv->ops_list, list) {
850 list_del_init(&pos->list);
851 bpf_map_op__delete(pos);
856 bpf_map_priv__clear(struct bpf_map *map __maybe_unused,
859 struct bpf_map_priv *priv = _priv;
861 bpf_map_priv__purge(priv);
866 bpf_map_op_setkey(struct bpf_map_op *op, struct parse_events_term *term)
868 op->key_type = BPF_MAP_KEY_ALL;
872 if (term->array.nr_ranges) {
873 size_t memsz = term->array.nr_ranges *
874 sizeof(op->k.array.ranges[0]);
876 op->k.array.ranges = memdup(term->array.ranges, memsz);
877 if (!op->k.array.ranges) {
878 pr_debug("Not enough memory to alloc indices for map\n");
881 op->key_type = BPF_MAP_KEY_RANGES;
882 op->k.array.nr_ranges = term->array.nr_ranges;
887 static struct bpf_map_op *
888 bpf_map_op__new(struct parse_events_term *term)
890 struct bpf_map_op *op;
893 op = zalloc(sizeof(*op));
895 pr_debug("Failed to alloc bpf_map_op\n");
896 return ERR_PTR(-ENOMEM);
898 INIT_LIST_HEAD(&op->list);
900 err = bpf_map_op_setkey(op, term);
908 static struct bpf_map_op *
909 bpf_map_op__clone(struct bpf_map_op *op)
911 struct bpf_map_op *newop;
913 newop = memdup(op, sizeof(*op));
915 pr_debug("Failed to alloc bpf_map_op\n");
919 INIT_LIST_HEAD(&newop->list);
920 if (op->key_type == BPF_MAP_KEY_RANGES) {
921 size_t memsz = op->k.array.nr_ranges *
922 sizeof(op->k.array.ranges[0]);
924 newop->k.array.ranges = memdup(op->k.array.ranges, memsz);
925 if (!newop->k.array.ranges) {
926 pr_debug("Failed to alloc indices for map\n");
935 static struct bpf_map_priv *
936 bpf_map_priv__clone(struct bpf_map_priv *priv)
938 struct bpf_map_priv *newpriv;
939 struct bpf_map_op *pos, *newop;
941 newpriv = zalloc(sizeof(*newpriv));
943 pr_debug("Not enough memory to alloc map private\n");
946 INIT_LIST_HEAD(&newpriv->ops_list);
948 list_for_each_entry(pos, &priv->ops_list, list) {
949 newop = bpf_map_op__clone(pos);
951 bpf_map_priv__purge(newpriv);
954 list_add_tail(&newop->list, &newpriv->ops_list);
961 bpf_map__add_op(struct bpf_map *map, struct bpf_map_op *op)
963 const char *map_name = bpf_map__name(map);
964 struct bpf_map_priv *priv = bpf_map__priv(map);
967 pr_debug("Failed to get private from map %s\n", map_name);
968 return PTR_ERR(priv);
972 priv = zalloc(sizeof(*priv));
974 pr_debug("Not enough memory to alloc map private\n");
977 INIT_LIST_HEAD(&priv->ops_list);
979 if (bpf_map__set_priv(map, priv, bpf_map_priv__clear)) {
981 return -BPF_LOADER_ERRNO__INTERNAL;
985 list_add_tail(&op->list, &priv->ops_list);
989 static struct bpf_map_op *
990 bpf_map__add_newop(struct bpf_map *map, struct parse_events_term *term)
992 struct bpf_map_op *op;
995 op = bpf_map_op__new(term);
999 err = bpf_map__add_op(map, op);
1001 bpf_map_op__delete(op);
1002 return ERR_PTR(err);
1008 __bpf_map__config_value(struct bpf_map *map,
1009 struct parse_events_term *term)
1011 struct bpf_map_op *op;
1012 const char *map_name = bpf_map__name(map);
1013 const struct bpf_map_def *def = bpf_map__def(map);
1016 pr_debug("Unable to get map definition from '%s'\n",
1018 return -BPF_LOADER_ERRNO__INTERNAL;
1021 if (def->type != BPF_MAP_TYPE_ARRAY) {
1022 pr_debug("Map %s type is not BPF_MAP_TYPE_ARRAY\n",
1024 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1026 if (def->key_size < sizeof(unsigned int)) {
1027 pr_debug("Map %s has incorrect key size\n", map_name);
1028 return -BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE;
1030 switch (def->value_size) {
1037 pr_debug("Map %s has incorrect value size\n", map_name);
1038 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1041 op = bpf_map__add_newop(map, term);
1044 op->op_type = BPF_MAP_OP_SET_VALUE;
1045 op->v.value = term->val.num;
1050 bpf_map__config_value(struct bpf_map *map,
1051 struct parse_events_term *term,
1052 struct perf_evlist *evlist __maybe_unused)
1054 if (!term->err_val) {
1055 pr_debug("Config value not set\n");
1056 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1059 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM) {
1060 pr_debug("ERROR: wrong value type for 'value'\n");
1061 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1064 return __bpf_map__config_value(map, term);
1068 __bpf_map__config_event(struct bpf_map *map,
1069 struct parse_events_term *term,
1070 struct perf_evlist *evlist)
1072 struct perf_evsel *evsel;
1073 const struct bpf_map_def *def;
1074 struct bpf_map_op *op;
1075 const char *map_name = bpf_map__name(map);
1077 evsel = perf_evlist__find_evsel_by_str(evlist, term->val.str);
1079 pr_debug("Event (for '%s') '%s' doesn't exist\n",
1080 map_name, term->val.str);
1081 return -BPF_LOADER_ERRNO__OBJCONF_MAP_NOEVT;
1084 def = bpf_map__def(map);
1086 pr_debug("Unable to get map definition from '%s'\n",
1088 return PTR_ERR(def);
1092 * No need to check key_size and value_size:
1093 * kernel has already checked them.
1095 if (def->type != BPF_MAP_TYPE_PERF_EVENT_ARRAY) {
1096 pr_debug("Map %s type is not BPF_MAP_TYPE_PERF_EVENT_ARRAY\n",
1098 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1101 op = bpf_map__add_newop(map, term);
1104 op->op_type = BPF_MAP_OP_SET_EVSEL;
1105 op->v.evsel = evsel;
1110 bpf_map__config_event(struct bpf_map *map,
1111 struct parse_events_term *term,
1112 struct perf_evlist *evlist)
1114 if (!term->err_val) {
1115 pr_debug("Config value not set\n");
1116 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1119 if (term->type_val != PARSE_EVENTS__TERM_TYPE_STR) {
1120 pr_debug("ERROR: wrong value type for 'event'\n");
1121 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1124 return __bpf_map__config_event(map, term, evlist);
1127 struct bpf_obj_config__map_func {
1128 const char *config_opt;
1129 int (*config_func)(struct bpf_map *, struct parse_events_term *,
1130 struct perf_evlist *);
1133 struct bpf_obj_config__map_func bpf_obj_config__map_funcs[] = {
1134 {"value", bpf_map__config_value},
1135 {"event", bpf_map__config_event},
1139 config_map_indices_range_check(struct parse_events_term *term,
1140 struct bpf_map *map,
1141 const char *map_name)
1143 struct parse_events_array *array = &term->array;
1144 const struct bpf_map_def *def;
1147 if (!array->nr_ranges)
1149 if (!array->ranges) {
1150 pr_debug("ERROR: map %s: array->nr_ranges is %d but range array is NULL\n",
1151 map_name, (int)array->nr_ranges);
1152 return -BPF_LOADER_ERRNO__INTERNAL;
1155 def = bpf_map__def(map);
1157 pr_debug("ERROR: Unable to get map definition from '%s'\n",
1159 return -BPF_LOADER_ERRNO__INTERNAL;
1162 for (i = 0; i < array->nr_ranges; i++) {
1163 unsigned int start = array->ranges[i].start;
1164 size_t length = array->ranges[i].length;
1165 unsigned int idx = start + length - 1;
1167 if (idx >= def->max_entries) {
1168 pr_debug("ERROR: index %d too large\n", idx);
1169 return -BPF_LOADER_ERRNO__OBJCONF_MAP_IDX2BIG;
1176 bpf__obj_config_map(struct bpf_object *obj,
1177 struct parse_events_term *term,
1178 struct perf_evlist *evlist,
1181 /* key is "map:<mapname>.<config opt>" */
1182 char *map_name = strdup(term->config + sizeof("map:") - 1);
1183 struct bpf_map *map;
1184 int err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1191 map_opt = strchr(map_name, '.');
1193 pr_debug("ERROR: Invalid map config: %s\n", map_name);
1198 if (*map_opt == '\0') {
1199 pr_debug("ERROR: Invalid map option: %s\n", term->config);
1203 map = bpf_object__find_map_by_name(obj, map_name);
1205 pr_debug("ERROR: Map %s doesn't exist\n", map_name);
1206 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST;
1210 *key_scan_pos += strlen(map_opt);
1211 err = config_map_indices_range_check(term, map, map_name);
1214 *key_scan_pos -= strlen(map_opt);
1216 for (i = 0; i < ARRAY_SIZE(bpf_obj_config__map_funcs); i++) {
1217 struct bpf_obj_config__map_func *func =
1218 &bpf_obj_config__map_funcs[i];
1220 if (strcmp(map_opt, func->config_opt) == 0) {
1221 err = func->config_func(map, term, evlist);
1226 pr_debug("ERROR: Invalid map config option '%s'\n", map_opt);
1227 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_OPT;
1231 key_scan_pos += strlen(map_opt);
1235 int bpf__config_obj(struct bpf_object *obj,
1236 struct parse_events_term *term,
1237 struct perf_evlist *evlist,
1240 int key_scan_pos = 0;
1243 if (!obj || !term || !term->config)
1246 if (!prefixcmp(term->config, "map:")) {
1247 key_scan_pos = sizeof("map:") - 1;
1248 err = bpf__obj_config_map(obj, term, evlist, &key_scan_pos);
1251 err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1254 *error_pos = key_scan_pos;
1259 typedef int (*map_config_func_t)(const char *name, int map_fd,
1260 const struct bpf_map_def *pdef,
1261 struct bpf_map_op *op,
1262 void *pkey, void *arg);
1265 foreach_key_array_all(map_config_func_t func,
1266 void *arg, const char *name,
1267 int map_fd, const struct bpf_map_def *pdef,
1268 struct bpf_map_op *op)
1273 for (i = 0; i < pdef->max_entries; i++) {
1274 err = func(name, map_fd, pdef, op, &i, arg);
1276 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1285 foreach_key_array_ranges(map_config_func_t func, void *arg,
1286 const char *name, int map_fd,
1287 const struct bpf_map_def *pdef,
1288 struct bpf_map_op *op)
1293 for (i = 0; i < op->k.array.nr_ranges; i++) {
1294 unsigned int start = op->k.array.ranges[i].start;
1295 size_t length = op->k.array.ranges[i].length;
1297 for (j = 0; j < length; j++) {
1298 unsigned int idx = start + j;
1300 err = func(name, map_fd, pdef, op, &idx, arg);
1302 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1312 bpf_map_config_foreach_key(struct bpf_map *map,
1313 map_config_func_t func,
1317 struct bpf_map_op *op;
1318 const struct bpf_map_def *def;
1319 const char *name = bpf_map__name(map);
1320 struct bpf_map_priv *priv = bpf_map__priv(map);
1323 pr_debug("ERROR: failed to get private from map %s\n", name);
1324 return -BPF_LOADER_ERRNO__INTERNAL;
1326 if (!priv || list_empty(&priv->ops_list)) {
1327 pr_debug("INFO: nothing to config for map %s\n", name);
1331 def = bpf_map__def(map);
1333 pr_debug("ERROR: failed to get definition from map %s\n", name);
1334 return -BPF_LOADER_ERRNO__INTERNAL;
1336 map_fd = bpf_map__fd(map);
1338 pr_debug("ERROR: failed to get fd from map %s\n", name);
1342 list_for_each_entry(op, &priv->ops_list, list) {
1343 switch (def->type) {
1344 case BPF_MAP_TYPE_ARRAY:
1345 case BPF_MAP_TYPE_PERF_EVENT_ARRAY:
1346 switch (op->key_type) {
1347 case BPF_MAP_KEY_ALL:
1348 err = foreach_key_array_all(func, arg, name,
1351 case BPF_MAP_KEY_RANGES:
1352 err = foreach_key_array_ranges(func, arg, name,
1357 pr_debug("ERROR: keytype for map '%s' invalid\n",
1359 return -BPF_LOADER_ERRNO__INTERNAL;
1365 pr_debug("ERROR: type of '%s' incorrect\n", name);
1366 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1374 apply_config_value_for_key(int map_fd, void *pkey,
1375 size_t val_size, u64 val)
1381 u8 _val = (u8)(val);
1382 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1386 u16 _val = (u16)(val);
1387 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1391 u32 _val = (u32)(val);
1392 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1396 err = bpf_map_update_elem(map_fd, pkey, &val, BPF_ANY);
1400 pr_debug("ERROR: invalid value size\n");
1401 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1409 apply_config_evsel_for_key(const char *name, int map_fd, void *pkey,
1410 struct perf_evsel *evsel)
1412 struct xyarray *xy = evsel->fd;
1413 struct perf_event_attr *attr;
1414 unsigned int key, events;
1415 bool check_pass = false;
1420 pr_debug("ERROR: evsel not ready for map %s\n", name);
1421 return -BPF_LOADER_ERRNO__INTERNAL;
1424 if (xy->row_size / xy->entry_size != 1) {
1425 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1427 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM;
1430 attr = &evsel->attr;
1431 if (attr->inherit) {
1432 pr_debug("ERROR: Can't put inherit event into map %s\n", name);
1433 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH;
1436 if (perf_evsel__is_bpf_output(evsel))
1438 if (attr->type == PERF_TYPE_RAW)
1440 if (attr->type == PERF_TYPE_HARDWARE)
1443 pr_debug("ERROR: Event type is wrong for map %s\n", name);
1444 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE;
1447 events = xy->entries / (xy->row_size / xy->entry_size);
1448 key = *((unsigned int *)pkey);
1449 if (key >= events) {
1450 pr_debug("ERROR: there is no event %d for map %s\n",
1452 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE;
1454 evt_fd = xyarray__entry(xy, key, 0);
1455 err = bpf_map_update_elem(map_fd, pkey, evt_fd, BPF_ANY);
1462 apply_obj_config_map_for_key(const char *name, int map_fd,
1463 const struct bpf_map_def *pdef,
1464 struct bpf_map_op *op,
1465 void *pkey, void *arg __maybe_unused)
1469 switch (op->op_type) {
1470 case BPF_MAP_OP_SET_VALUE:
1471 err = apply_config_value_for_key(map_fd, pkey,
1475 case BPF_MAP_OP_SET_EVSEL:
1476 err = apply_config_evsel_for_key(name, map_fd, pkey,
1480 pr_debug("ERROR: unknown value type for '%s'\n", name);
1481 err = -BPF_LOADER_ERRNO__INTERNAL;
1487 apply_obj_config_map(struct bpf_map *map)
1489 return bpf_map_config_foreach_key(map,
1490 apply_obj_config_map_for_key,
1495 apply_obj_config_object(struct bpf_object *obj)
1497 struct bpf_map *map;
1500 bpf_map__for_each(map, obj) {
1501 err = apply_obj_config_map(map);
1508 int bpf__apply_obj_config(void)
1510 struct bpf_object *obj, *tmp;
1513 bpf_object__for_each_safe(obj, tmp) {
1514 err = apply_obj_config_object(obj);
1522 #define bpf__for_each_map(pos, obj, objtmp) \
1523 bpf_object__for_each_safe(obj, objtmp) \
1524 bpf_map__for_each(pos, obj)
1526 #define bpf__for_each_stdout_map(pos, obj, objtmp) \
1527 bpf__for_each_map(pos, obj, objtmp) \
1528 if (bpf_map__name(pos) && \
1529 (strcmp("__bpf_stdout__", \
1530 bpf_map__name(pos)) == 0))
1532 int bpf__setup_stdout(struct perf_evlist *evlist __maybe_unused)
1534 struct bpf_map_priv *tmpl_priv = NULL;
1535 struct bpf_object *obj, *tmp;
1536 struct perf_evsel *evsel = NULL;
1537 struct bpf_map *map;
1539 bool need_init = false;
1541 bpf__for_each_stdout_map(map, obj, tmp) {
1542 struct bpf_map_priv *priv = bpf_map__priv(map);
1545 return -BPF_LOADER_ERRNO__INTERNAL;
1548 * No need to check map type: type should have been
1549 * verified by kernel.
1551 if (!need_init && !priv)
1553 if (!tmpl_priv && priv)
1561 err = parse_events(evlist, "bpf-output/no-inherit=1,name=__bpf_stdout__/",
1564 pr_debug("ERROR: failed to create bpf-output event\n");
1568 evsel = perf_evlist__last(evlist);
1571 bpf__for_each_stdout_map(map, obj, tmp) {
1572 struct bpf_map_priv *priv = bpf_map__priv(map);
1575 return -BPF_LOADER_ERRNO__INTERNAL;
1580 priv = bpf_map_priv__clone(tmpl_priv);
1584 err = bpf_map__set_priv(map, priv, bpf_map_priv__clear);
1586 bpf_map_priv__clear(map, priv);
1590 struct bpf_map_op *op;
1592 op = bpf_map__add_newop(map, NULL);
1595 op->op_type = BPF_MAP_OP_SET_EVSEL;
1596 op->v.evsel = evsel;
1603 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1604 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1605 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1607 static const char *bpf_loader_strerror_table[NR_ERRNO] = {
1608 [ERRCODE_OFFSET(CONFIG)] = "Invalid config string",
1609 [ERRCODE_OFFSET(GROUP)] = "Invalid group name",
1610 [ERRCODE_OFFSET(EVENTNAME)] = "No event name found in config string",
1611 [ERRCODE_OFFSET(INTERNAL)] = "BPF loader internal error",
1612 [ERRCODE_OFFSET(COMPILE)] = "Error when compiling BPF scriptlet",
1613 [ERRCODE_OFFSET(PROGCONF_TERM)] = "Invalid program config term in config string",
1614 [ERRCODE_OFFSET(PROLOGUE)] = "Failed to generate prologue",
1615 [ERRCODE_OFFSET(PROLOGUE2BIG)] = "Prologue too big for program",
1616 [ERRCODE_OFFSET(PROLOGUEOOB)] = "Offset out of bound for prologue",
1617 [ERRCODE_OFFSET(OBJCONF_OPT)] = "Invalid object config option",
1618 [ERRCODE_OFFSET(OBJCONF_CONF)] = "Config value not set (missing '=')",
1619 [ERRCODE_OFFSET(OBJCONF_MAP_OPT)] = "Invalid object map config option",
1620 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST)] = "Target map doesn't exist",
1621 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE)] = "Incorrect value type for map",
1622 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE)] = "Incorrect map type",
1623 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE)] = "Incorrect map key size",
1624 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE)] = "Incorrect map value size",
1625 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT)] = "Event not found for map setting",
1626 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE)] = "Invalid map size for event setting",
1627 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM)] = "Event dimension too large",
1628 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH)] = "Doesn't support inherit event",
1629 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE)] = "Wrong event type for map",
1630 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG)] = "Index too large",
1634 bpf_loader_strerror(int err, char *buf, size_t size)
1636 char sbuf[STRERR_BUFSIZE];
1642 err = err > 0 ? err : -err;
1644 if (err >= __LIBBPF_ERRNO__START)
1645 return libbpf_strerror(err, buf, size);
1647 if (err >= __BPF_LOADER_ERRNO__START && err < __BPF_LOADER_ERRNO__END) {
1648 msg = bpf_loader_strerror_table[ERRNO_OFFSET(err)];
1649 snprintf(buf, size, "%s", msg);
1650 buf[size - 1] = '\0';
1654 if (err >= __BPF_LOADER_ERRNO__END)
1655 snprintf(buf, size, "Unknown bpf loader error %d", err);
1657 snprintf(buf, size, "%s",
1658 str_error_r(err, sbuf, sizeof(sbuf)));
1660 buf[size - 1] = '\0';
1664 #define bpf__strerror_head(err, buf, size) \
1665 char sbuf[STRERR_BUFSIZE], *emsg;\
1670 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1674 scnprintf(buf, size, "%s", emsg);\
1677 #define bpf__strerror_entry(val, fmt...)\
1679 scnprintf(buf, size, fmt);\
1683 #define bpf__strerror_end(buf, size)\
1685 buf[size - 1] = '\0';
1687 int bpf__strerror_prepare_load(const char *filename, bool source,
1688 int err, char *buf, size_t size)
1693 n = snprintf(buf, size, "Failed to load %s%s: ",
1694 filename, source ? " from source" : "");
1696 buf[size - 1] = '\0';
1702 ret = bpf_loader_strerror(err, buf, size);
1703 buf[size - 1] = '\0';
1707 int bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
1708 int err, char *buf, size_t size)
1710 bpf__strerror_head(err, buf, size);
1711 case BPF_LOADER_ERRNO__PROGCONF_TERM: {
1712 scnprintf(buf, size, "%s (add -v to see detail)", emsg);
1715 bpf__strerror_entry(EEXIST, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1716 bpf__strerror_entry(EACCES, "You need to be root");
1717 bpf__strerror_entry(EPERM, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1718 bpf__strerror_entry(ENOENT, "You need to check probing points in BPF file");
1719 bpf__strerror_end(buf, size);
1723 int bpf__strerror_load(struct bpf_object *obj,
1724 int err, char *buf, size_t size)
1726 bpf__strerror_head(err, buf, size);
1727 case LIBBPF_ERRNO__KVER: {
1728 unsigned int obj_kver = bpf_object__kversion(obj);
1729 unsigned int real_kver;
1731 if (fetch_kernel_version(&real_kver, NULL, 0)) {
1732 scnprintf(buf, size, "Unable to fetch kernel version");
1736 if (obj_kver != real_kver) {
1737 scnprintf(buf, size,
1738 "'version' ("KVER_FMT") doesn't match running kernel ("KVER_FMT")",
1739 KVER_PARAM(obj_kver),
1740 KVER_PARAM(real_kver));
1744 scnprintf(buf, size, "Failed to load program for unknown reason");
1747 bpf__strerror_end(buf, size);
1751 int bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
1752 struct parse_events_term *term __maybe_unused,
1753 struct perf_evlist *evlist __maybe_unused,
1754 int *error_pos __maybe_unused, int err,
1755 char *buf, size_t size)
1757 bpf__strerror_head(err, buf, size);
1758 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,
1759 "Can't use this config term with this map type");
1760 bpf__strerror_end(buf, size);
1764 int bpf__strerror_apply_obj_config(int err, char *buf, size_t size)
1766 bpf__strerror_head(err, buf, size);
1767 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM,
1768 "Cannot set event to BPF map in multi-thread tracing");
1769 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH,
1770 "%s (Hint: use -i to turn off inherit)", emsg);
1771 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE,
1772 "Can only put raw, hardware and BPF output event into a BPF map");
1773 bpf__strerror_end(buf, size);
1777 int bpf__strerror_setup_stdout(struct perf_evlist *evlist __maybe_unused,
1778 int err, char *buf, size_t size)
1780 bpf__strerror_head(err, buf, size);
1781 bpf__strerror_end(buf, size);