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 "llvm-utils.h"
18 #include "probe-event.h"
19 #include "probe-finder.h" // for MAX_PROBES
20 #include "parse-events.h"
21 #include "llvm-utils.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 {
40 struct perf_probe_event pev;
42 struct bpf_insn *insns_buf;
47 static bool libbpf_initialized;
50 bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz, const char *name)
52 struct bpf_object *obj;
54 if (!libbpf_initialized) {
55 libbpf_set_print(libbpf_warning,
58 libbpf_initialized = true;
61 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, name);
63 pr_debug("bpf: failed to load buffer\n");
64 return ERR_PTR(-EINVAL);
70 struct bpf_object *bpf__prepare_load(const char *filename, bool source)
72 struct bpf_object *obj;
74 if (!libbpf_initialized) {
75 libbpf_set_print(libbpf_warning,
78 libbpf_initialized = true;
86 err = llvm__compile_bpf(filename, &obj_buf, &obj_buf_sz);
88 return ERR_PTR(-BPF_LOADER_ERRNO__COMPILE);
89 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, filename);
92 obj = bpf_object__open(filename);
95 pr_debug("bpf: failed to load %s\n", filename);
102 void bpf__clear(void)
104 struct bpf_object *obj, *tmp;
106 bpf_object__for_each_safe(obj, tmp) {
108 bpf_object__close(obj);
113 clear_prog_priv(struct bpf_program *prog __maybe_unused,
116 struct bpf_prog_priv *priv = _priv;
118 cleanup_perf_probe_events(&priv->pev, 1);
119 zfree(&priv->insns_buf);
120 zfree(&priv->type_mapping);
125 prog_config__exec(const char *value, struct perf_probe_event *pev)
128 pev->target = strdup(value);
135 prog_config__module(const char *value, struct perf_probe_event *pev)
137 pev->uprobes = false;
138 pev->target = strdup(value);
145 prog_config__bool(const char *value, bool *pbool, bool invert)
153 err = strtobool(value, &bool_value);
157 *pbool = invert ? !bool_value : bool_value;
162 prog_config__inlines(const char *value,
163 struct perf_probe_event *pev __maybe_unused)
165 return prog_config__bool(value, &probe_conf.no_inlines, true);
169 prog_config__force(const char *value,
170 struct perf_probe_event *pev __maybe_unused)
172 return prog_config__bool(value, &probe_conf.force_add, false);
179 int (*func)(const char *, struct perf_probe_event *);
180 } bpf_prog_config_terms[] = {
183 .usage = "exec=<full path of file>",
184 .desc = "Set uprobe target",
185 .func = prog_config__exec,
189 .usage = "module=<module name> ",
190 .desc = "Set kprobe module",
191 .func = prog_config__module,
195 .usage = "inlines=[yes|no] ",
196 .desc = "Probe at inline symbol",
197 .func = prog_config__inlines,
201 .usage = "force=[yes|no] ",
202 .desc = "Forcibly add events with existing name",
203 .func = prog_config__force,
208 do_prog_config(const char *key, const char *value,
209 struct perf_probe_event *pev)
213 pr_debug("config bpf program: %s=%s\n", key, value);
214 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
215 if (strcmp(key, bpf_prog_config_terms[i].key) == 0)
216 return bpf_prog_config_terms[i].func(value, pev);
218 pr_debug("BPF: ERROR: invalid program config option: %s=%s\n",
221 pr_debug("\nHint: Valid options are:\n");
222 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
223 pr_debug("\t%s:\t%s\n", bpf_prog_config_terms[i].usage,
224 bpf_prog_config_terms[i].desc);
227 return -BPF_LOADER_ERRNO__PROGCONF_TERM;
231 parse_prog_config_kvpair(const char *config_str, struct perf_probe_event *pev)
233 char *text = strdup(config_str);
235 const char *main_str = NULL;
239 pr_debug("No enough memory: dup config_str failed\n");
240 return ERR_PTR(-ENOMEM);
244 while ((sep = strchr(line, ';'))) {
248 equ = strchr(line, '=');
250 pr_warning("WARNING: invalid config in BPF object: %s\n",
252 pr_warning("\tShould be 'key=value'.\n");
257 err = do_prog_config(line, equ + 1, pev);
265 main_str = config_str + (line - text);
268 return err ? ERR_PTR(err) : main_str;
272 parse_prog_config(const char *config_str, struct perf_probe_event *pev)
275 const char *main_str = parse_prog_config_kvpair(config_str, pev);
277 if (IS_ERR(main_str))
278 return PTR_ERR(main_str);
280 err = parse_perf_probe_command(main_str, pev);
282 pr_debug("bpf: '%s' is not a valid config string\n",
284 /* parse failed, don't need clear pev. */
285 return -BPF_LOADER_ERRNO__CONFIG;
291 config_bpf_program(struct bpf_program *prog)
293 struct perf_probe_event *pev = NULL;
294 struct bpf_prog_priv *priv = NULL;
295 const char *config_str;
298 /* Initialize per-program probing setting */
299 probe_conf.no_inlines = false;
300 probe_conf.force_add = false;
302 config_str = bpf_program__title(prog, false);
303 if (IS_ERR(config_str)) {
304 pr_debug("bpf: unable to get title for program\n");
305 return PTR_ERR(config_str);
308 priv = calloc(sizeof(*priv), 1);
310 pr_debug("bpf: failed to alloc priv\n");
315 pr_debug("bpf: config program '%s'\n", config_str);
316 err = parse_prog_config(config_str, pev);
320 if (pev->group && strcmp(pev->group, PERF_BPF_PROBE_GROUP)) {
321 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
322 config_str, PERF_BPF_PROBE_GROUP);
323 err = -BPF_LOADER_ERRNO__GROUP;
325 } else if (!pev->group)
326 pev->group = strdup(PERF_BPF_PROBE_GROUP);
329 pr_debug("bpf: strdup failed\n");
335 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
337 err = -BPF_LOADER_ERRNO__EVENTNAME;
340 pr_debug("bpf: config '%s' is ok\n", config_str);
342 err = bpf_program__set_private(prog, priv, clear_prog_priv);
344 pr_debug("Failed to set priv for program '%s'\n", config_str);
352 clear_perf_probe_event(pev);
357 static int bpf__prepare_probe(void)
360 static bool initialized = false;
363 * Make err static, so if init failed the first, bpf__prepare_probe()
364 * fails each time without calling init_probe_symbol_maps multiple
371 err = init_probe_symbol_maps(false);
373 pr_debug("Failed to init_probe_symbol_maps\n");
374 probe_conf.max_probes = MAX_PROBES;
379 preproc_gen_prologue(struct bpf_program *prog, int n,
380 struct bpf_insn *orig_insns, int orig_insns_cnt,
381 struct bpf_prog_prep_result *res)
383 struct probe_trace_event *tev;
384 struct perf_probe_event *pev;
385 struct bpf_prog_priv *priv;
386 struct bpf_insn *buf;
387 size_t prologue_cnt = 0;
390 err = bpf_program__get_private(prog, (void **)&priv);
396 if (n < 0 || n >= priv->nr_types)
399 /* Find a tev belongs to that type */
400 for (i = 0; i < pev->ntevs; i++) {
401 if (priv->type_mapping[i] == n)
405 if (i >= pev->ntevs) {
406 pr_debug("Internal error: prologue type %d not found\n", n);
407 return -BPF_LOADER_ERRNO__PROLOGUE;
412 buf = priv->insns_buf;
413 err = bpf__gen_prologue(tev->args, tev->nargs,
415 BPF_MAXINSNS - orig_insns_cnt);
419 title = bpf_program__title(prog, false);
423 pr_debug("Failed to generate prologue for program %s\n",
428 memcpy(&buf[prologue_cnt], orig_insns,
429 sizeof(struct bpf_insn) * orig_insns_cnt);
431 res->new_insn_ptr = buf;
432 res->new_insn_cnt = prologue_cnt + orig_insns_cnt;
437 pr_debug("Internal error in preproc_gen_prologue\n");
438 return -BPF_LOADER_ERRNO__PROLOGUE;
442 * compare_tev_args is reflexive, transitive and antisymmetric.
443 * I can proof it but this margin is too narrow to contain.
445 static int compare_tev_args(const void *ptev1, const void *ptev2)
448 const struct probe_trace_event *tev1 =
449 *(const struct probe_trace_event **)ptev1;
450 const struct probe_trace_event *tev2 =
451 *(const struct probe_trace_event **)ptev2;
453 ret = tev2->nargs - tev1->nargs;
457 for (i = 0; i < tev1->nargs; i++) {
458 struct probe_trace_arg *arg1, *arg2;
459 struct probe_trace_arg_ref *ref1, *ref2;
461 arg1 = &tev1->args[i];
462 arg2 = &tev2->args[i];
464 ret = strcmp(arg1->value, arg2->value);
471 while (ref1 && ref2) {
472 ret = ref2->offset - ref1->offset;
481 return ref2 ? 1 : -1;
488 * Assign a type number to each tevs in a pev.
489 * mapping is an array with same slots as tevs in that pev.
490 * nr_types will be set to number of types.
492 static int map_prologue(struct perf_probe_event *pev, int *mapping,
496 struct probe_trace_event **ptevs;
498 size_t array_sz = sizeof(*ptevs) * pev->ntevs;
500 ptevs = malloc(array_sz);
502 pr_debug("No ehough memory: alloc ptevs failed\n");
506 pr_debug("In map_prologue, ntevs=%d\n", pev->ntevs);
507 for (i = 0; i < pev->ntevs; i++)
508 ptevs[i] = &pev->tevs[i];
510 qsort(ptevs, pev->ntevs, sizeof(*ptevs),
513 for (i = 0; i < pev->ntevs; i++) {
516 n = ptevs[i] - pev->tevs;
519 pr_debug("mapping[%d]=%d\n", n, type);
523 if (compare_tev_args(ptevs + i, ptevs + i - 1) == 0)
528 pr_debug("mapping[%d]=%d\n", n, mapping[n]);
531 *nr_types = type + 1;
536 static int hook_load_preprocessor(struct bpf_program *prog)
538 struct perf_probe_event *pev;
539 struct bpf_prog_priv *priv;
540 bool need_prologue = false;
543 err = bpf_program__get_private(prog, (void **)&priv);
545 pr_debug("Internal error when hook preprocessor\n");
546 return -BPF_LOADER_ERRNO__INTERNAL;
550 for (i = 0; i < pev->ntevs; i++) {
551 struct probe_trace_event *tev = &pev->tevs[i];
553 if (tev->nargs > 0) {
554 need_prologue = true;
560 * Since all tevs don't have argument, we don't need generate
563 if (!need_prologue) {
564 priv->need_prologue = false;
568 priv->need_prologue = true;
569 priv->insns_buf = malloc(sizeof(struct bpf_insn) * BPF_MAXINSNS);
570 if (!priv->insns_buf) {
571 pr_debug("No enough memory: alloc insns_buf failed\n");
575 priv->type_mapping = malloc(sizeof(int) * pev->ntevs);
576 if (!priv->type_mapping) {
577 pr_debug("No enough memory: alloc type_mapping failed\n");
580 memset(priv->type_mapping, -1,
581 sizeof(int) * pev->ntevs);
583 err = map_prologue(pev, priv->type_mapping, &priv->nr_types);
587 err = bpf_program__set_prep(prog, priv->nr_types,
588 preproc_gen_prologue);
592 int bpf__probe(struct bpf_object *obj)
595 struct bpf_program *prog;
596 struct bpf_prog_priv *priv;
597 struct perf_probe_event *pev;
599 err = bpf__prepare_probe();
601 pr_debug("bpf__prepare_probe failed\n");
605 bpf_object__for_each_program(prog, obj) {
606 err = config_bpf_program(prog);
610 err = bpf_program__get_private(prog, (void **)&priv);
615 err = convert_perf_probe_events(pev, 1);
617 pr_debug("bpf_probe: failed to convert perf probe events");
621 err = apply_perf_probe_events(pev, 1);
623 pr_debug("bpf_probe: failed to apply perf probe events");
628 * After probing, let's consider prologue, which
629 * adds program fetcher to BPF programs.
631 * hook_load_preprocessorr() hooks pre-processor
632 * to bpf_program, let it generate prologue
633 * dynamically during loading.
635 err = hook_load_preprocessor(prog);
640 return err < 0 ? err : 0;
643 #define EVENTS_WRITE_BUFSIZE 4096
644 int bpf__unprobe(struct bpf_object *obj)
647 struct bpf_program *prog;
648 struct bpf_prog_priv *priv;
650 bpf_object__for_each_program(prog, obj) {
653 err = bpf_program__get_private(prog, (void **)&priv);
657 for (i = 0; i < priv->pev.ntevs; i++) {
658 struct probe_trace_event *tev = &priv->pev.tevs[i];
659 char name_buf[EVENTS_WRITE_BUFSIZE];
660 struct strfilter *delfilter;
662 snprintf(name_buf, EVENTS_WRITE_BUFSIZE,
663 "%s:%s", tev->group, tev->event);
664 name_buf[EVENTS_WRITE_BUFSIZE - 1] = '\0';
666 delfilter = strfilter__new(name_buf, NULL);
668 pr_debug("Failed to create filter for unprobing\n");
673 err = del_perf_probe_events(delfilter);
674 strfilter__delete(delfilter);
676 pr_debug("Failed to delete %s\n", name_buf);
685 int bpf__load(struct bpf_object *obj)
689 err = bpf_object__load(obj);
691 pr_debug("bpf: load objects failed\n");
697 int bpf__foreach_tev(struct bpf_object *obj,
698 bpf_prog_iter_callback_t func,
701 struct bpf_program *prog;
704 bpf_object__for_each_program(prog, obj) {
705 struct probe_trace_event *tev;
706 struct perf_probe_event *pev;
707 struct bpf_prog_priv *priv;
710 err = bpf_program__get_private(prog,
713 pr_debug("bpf: failed to get private field\n");
714 return -BPF_LOADER_ERRNO__INTERNAL;
718 for (i = 0; i < pev->ntevs; i++) {
721 if (priv->need_prologue) {
722 int type = priv->type_mapping[i];
724 fd = bpf_program__nth_fd(prog, type);
726 fd = bpf_program__fd(prog);
730 pr_debug("bpf: failed to get file descriptor\n");
734 err = (*func)(tev, fd, arg);
736 pr_debug("bpf: call back failed, stop iterate\n");
744 enum bpf_map_op_type {
745 BPF_MAP_OP_SET_VALUE,
746 BPF_MAP_OP_SET_EVSEL,
749 enum bpf_map_key_type {
755 struct list_head list;
756 enum bpf_map_op_type op_type;
757 enum bpf_map_key_type key_type;
759 struct parse_events_array array;
763 struct perf_evsel *evsel;
767 struct bpf_map_priv {
768 struct list_head ops_list;
772 bpf_map_op__delete(struct bpf_map_op *op)
774 if (!list_empty(&op->list))
776 if (op->key_type == BPF_MAP_KEY_RANGES)
777 parse_events__clear_array(&op->k.array);
782 bpf_map_priv__purge(struct bpf_map_priv *priv)
784 struct bpf_map_op *pos, *n;
786 list_for_each_entry_safe(pos, n, &priv->ops_list, list) {
787 list_del_init(&pos->list);
788 bpf_map_op__delete(pos);
793 bpf_map_priv__clear(struct bpf_map *map __maybe_unused,
796 struct bpf_map_priv *priv = _priv;
798 bpf_map_priv__purge(priv);
803 bpf_map_op_setkey(struct bpf_map_op *op, struct parse_events_term *term)
805 op->key_type = BPF_MAP_KEY_ALL;
809 if (term->array.nr_ranges) {
810 size_t memsz = term->array.nr_ranges *
811 sizeof(op->k.array.ranges[0]);
813 op->k.array.ranges = memdup(term->array.ranges, memsz);
814 if (!op->k.array.ranges) {
815 pr_debug("No enough memory to alloc indices for map\n");
818 op->key_type = BPF_MAP_KEY_RANGES;
819 op->k.array.nr_ranges = term->array.nr_ranges;
824 static struct bpf_map_op *
825 bpf_map_op__new(struct parse_events_term *term)
827 struct bpf_map_op *op;
830 op = zalloc(sizeof(*op));
832 pr_debug("Failed to alloc bpf_map_op\n");
833 return ERR_PTR(-ENOMEM);
835 INIT_LIST_HEAD(&op->list);
837 err = bpf_map_op_setkey(op, term);
845 static struct bpf_map_op *
846 bpf_map_op__clone(struct bpf_map_op *op)
848 struct bpf_map_op *newop;
850 newop = memdup(op, sizeof(*op));
852 pr_debug("Failed to alloc bpf_map_op\n");
856 INIT_LIST_HEAD(&newop->list);
857 if (op->key_type == BPF_MAP_KEY_RANGES) {
858 size_t memsz = op->k.array.nr_ranges *
859 sizeof(op->k.array.ranges[0]);
861 newop->k.array.ranges = memdup(op->k.array.ranges, memsz);
862 if (!newop->k.array.ranges) {
863 pr_debug("Failed to alloc indices for map\n");
872 static struct bpf_map_priv *
873 bpf_map_priv__clone(struct bpf_map_priv *priv)
875 struct bpf_map_priv *newpriv;
876 struct bpf_map_op *pos, *newop;
878 newpriv = zalloc(sizeof(*newpriv));
880 pr_debug("No enough memory to alloc map private\n");
883 INIT_LIST_HEAD(&newpriv->ops_list);
885 list_for_each_entry(pos, &priv->ops_list, list) {
886 newop = bpf_map_op__clone(pos);
888 bpf_map_priv__purge(newpriv);
891 list_add_tail(&newop->list, &newpriv->ops_list);
898 bpf_map__add_op(struct bpf_map *map, struct bpf_map_op *op)
900 struct bpf_map_priv *priv;
901 const char *map_name;
904 map_name = bpf_map__get_name(map);
905 err = bpf_map__get_private(map, (void **)&priv);
907 pr_debug("Failed to get private from map %s\n", map_name);
912 priv = zalloc(sizeof(*priv));
914 pr_debug("No enough memory to alloc map private\n");
917 INIT_LIST_HEAD(&priv->ops_list);
919 if (bpf_map__set_private(map, priv, bpf_map_priv__clear)) {
921 return -BPF_LOADER_ERRNO__INTERNAL;
925 list_add_tail(&op->list, &priv->ops_list);
929 static struct bpf_map_op *
930 bpf_map__add_newop(struct bpf_map *map, struct parse_events_term *term)
932 struct bpf_map_op *op;
935 op = bpf_map_op__new(term);
939 err = bpf_map__add_op(map, op);
941 bpf_map_op__delete(op);
948 __bpf_map__config_value(struct bpf_map *map,
949 struct parse_events_term *term)
951 struct bpf_map_def def;
952 struct bpf_map_op *op;
953 const char *map_name;
956 map_name = bpf_map__get_name(map);
958 err = bpf_map__get_def(map, &def);
960 pr_debug("Unable to get map definition from '%s'\n",
962 return -BPF_LOADER_ERRNO__INTERNAL;
965 if (def.type != BPF_MAP_TYPE_ARRAY) {
966 pr_debug("Map %s type is not BPF_MAP_TYPE_ARRAY\n",
968 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
970 if (def.key_size < sizeof(unsigned int)) {
971 pr_debug("Map %s has incorrect key size\n", map_name);
972 return -BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE;
974 switch (def.value_size) {
981 pr_debug("Map %s has incorrect value size\n", map_name);
982 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
985 op = bpf_map__add_newop(map, term);
988 op->op_type = BPF_MAP_OP_SET_VALUE;
989 op->v.value = term->val.num;
994 bpf_map__config_value(struct bpf_map *map,
995 struct parse_events_term *term,
996 struct perf_evlist *evlist __maybe_unused)
998 if (!term->err_val) {
999 pr_debug("Config value not set\n");
1000 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1003 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM) {
1004 pr_debug("ERROR: wrong value type for 'value'\n");
1005 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1008 return __bpf_map__config_value(map, term);
1012 __bpf_map__config_event(struct bpf_map *map,
1013 struct parse_events_term *term,
1014 struct perf_evlist *evlist)
1016 struct perf_evsel *evsel;
1017 struct bpf_map_def def;
1018 struct bpf_map_op *op;
1019 const char *map_name;
1022 map_name = bpf_map__get_name(map);
1023 evsel = perf_evlist__find_evsel_by_str(evlist, term->val.str);
1025 pr_debug("Event (for '%s') '%s' doesn't exist\n",
1026 map_name, term->val.str);
1027 return -BPF_LOADER_ERRNO__OBJCONF_MAP_NOEVT;
1030 err = bpf_map__get_def(map, &def);
1032 pr_debug("Unable to get map definition from '%s'\n",
1038 * No need to check key_size and value_size:
1039 * kernel has already checked them.
1041 if (def.type != BPF_MAP_TYPE_PERF_EVENT_ARRAY) {
1042 pr_debug("Map %s type is not BPF_MAP_TYPE_PERF_EVENT_ARRAY\n",
1044 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1047 op = bpf_map__add_newop(map, term);
1050 op->op_type = BPF_MAP_OP_SET_EVSEL;
1051 op->v.evsel = evsel;
1056 bpf_map__config_event(struct bpf_map *map,
1057 struct parse_events_term *term,
1058 struct perf_evlist *evlist)
1060 if (!term->err_val) {
1061 pr_debug("Config value not set\n");
1062 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1065 if (term->type_val != PARSE_EVENTS__TERM_TYPE_STR) {
1066 pr_debug("ERROR: wrong value type for 'event'\n");
1067 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1070 return __bpf_map__config_event(map, term, evlist);
1073 struct bpf_obj_config__map_func {
1074 const char *config_opt;
1075 int (*config_func)(struct bpf_map *, struct parse_events_term *,
1076 struct perf_evlist *);
1079 struct bpf_obj_config__map_func bpf_obj_config__map_funcs[] = {
1080 {"value", bpf_map__config_value},
1081 {"event", bpf_map__config_event},
1085 config_map_indices_range_check(struct parse_events_term *term,
1086 struct bpf_map *map,
1087 const char *map_name)
1089 struct parse_events_array *array = &term->array;
1090 struct bpf_map_def def;
1094 if (!array->nr_ranges)
1096 if (!array->ranges) {
1097 pr_debug("ERROR: map %s: array->nr_ranges is %d but range array is NULL\n",
1098 map_name, (int)array->nr_ranges);
1099 return -BPF_LOADER_ERRNO__INTERNAL;
1102 err = bpf_map__get_def(map, &def);
1104 pr_debug("ERROR: Unable to get map definition from '%s'\n",
1106 return -BPF_LOADER_ERRNO__INTERNAL;
1109 for (i = 0; i < array->nr_ranges; i++) {
1110 unsigned int start = array->ranges[i].start;
1111 size_t length = array->ranges[i].length;
1112 unsigned int idx = start + length - 1;
1114 if (idx >= def.max_entries) {
1115 pr_debug("ERROR: index %d too large\n", idx);
1116 return -BPF_LOADER_ERRNO__OBJCONF_MAP_IDX2BIG;
1123 bpf__obj_config_map(struct bpf_object *obj,
1124 struct parse_events_term *term,
1125 struct perf_evlist *evlist,
1128 /* key is "map:<mapname>.<config opt>" */
1129 char *map_name = strdup(term->config + sizeof("map:") - 1);
1130 struct bpf_map *map;
1131 int err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1138 map_opt = strchr(map_name, '.');
1140 pr_debug("ERROR: Invalid map config: %s\n", map_name);
1145 if (*map_opt == '\0') {
1146 pr_debug("ERROR: Invalid map option: %s\n", term->config);
1150 map = bpf_object__get_map_by_name(obj, map_name);
1152 pr_debug("ERROR: Map %s doesn't exist\n", map_name);
1153 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST;
1157 *key_scan_pos += strlen(map_opt);
1158 err = config_map_indices_range_check(term, map, map_name);
1161 *key_scan_pos -= strlen(map_opt);
1163 for (i = 0; i < ARRAY_SIZE(bpf_obj_config__map_funcs); i++) {
1164 struct bpf_obj_config__map_func *func =
1165 &bpf_obj_config__map_funcs[i];
1167 if (strcmp(map_opt, func->config_opt) == 0) {
1168 err = func->config_func(map, term, evlist);
1173 pr_debug("ERROR: Invalid map config option '%s'\n", map_opt);
1174 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_OPT;
1178 key_scan_pos += strlen(map_opt);
1182 int bpf__config_obj(struct bpf_object *obj,
1183 struct parse_events_term *term,
1184 struct perf_evlist *evlist,
1187 int key_scan_pos = 0;
1190 if (!obj || !term || !term->config)
1193 if (!prefixcmp(term->config, "map:")) {
1194 key_scan_pos = sizeof("map:") - 1;
1195 err = bpf__obj_config_map(obj, term, evlist, &key_scan_pos);
1198 err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1201 *error_pos = key_scan_pos;
1206 typedef int (*map_config_func_t)(const char *name, int map_fd,
1207 struct bpf_map_def *pdef,
1208 struct bpf_map_op *op,
1209 void *pkey, void *arg);
1212 foreach_key_array_all(map_config_func_t func,
1213 void *arg, const char *name,
1214 int map_fd, struct bpf_map_def *pdef,
1215 struct bpf_map_op *op)
1220 for (i = 0; i < pdef->max_entries; i++) {
1221 err = func(name, map_fd, pdef, op, &i, arg);
1223 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1232 foreach_key_array_ranges(map_config_func_t func, void *arg,
1233 const char *name, int map_fd,
1234 struct bpf_map_def *pdef,
1235 struct bpf_map_op *op)
1240 for (i = 0; i < op->k.array.nr_ranges; i++) {
1241 unsigned int start = op->k.array.ranges[i].start;
1242 size_t length = op->k.array.ranges[i].length;
1244 for (j = 0; j < length; j++) {
1245 unsigned int idx = start + j;
1247 err = func(name, map_fd, pdef, op, &idx, arg);
1249 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1259 bpf_map_config_foreach_key(struct bpf_map *map,
1260 map_config_func_t func,
1265 struct bpf_map_op *op;
1266 struct bpf_map_def def;
1267 struct bpf_map_priv *priv;
1269 name = bpf_map__get_name(map);
1271 err = bpf_map__get_private(map, (void **)&priv);
1273 pr_debug("ERROR: failed to get private from map %s\n", name);
1274 return -BPF_LOADER_ERRNO__INTERNAL;
1276 if (!priv || list_empty(&priv->ops_list)) {
1277 pr_debug("INFO: nothing to config for map %s\n", name);
1281 err = bpf_map__get_def(map, &def);
1283 pr_debug("ERROR: failed to get definition from map %s\n", name);
1284 return -BPF_LOADER_ERRNO__INTERNAL;
1286 map_fd = bpf_map__get_fd(map);
1288 pr_debug("ERROR: failed to get fd from map %s\n", name);
1292 list_for_each_entry(op, &priv->ops_list, list) {
1294 case BPF_MAP_TYPE_ARRAY:
1295 case BPF_MAP_TYPE_PERF_EVENT_ARRAY:
1296 switch (op->key_type) {
1297 case BPF_MAP_KEY_ALL:
1298 err = foreach_key_array_all(func, arg, name,
1301 case BPF_MAP_KEY_RANGES:
1302 err = foreach_key_array_ranges(func, arg, name,
1307 pr_debug("ERROR: keytype for map '%s' invalid\n",
1309 return -BPF_LOADER_ERRNO__INTERNAL;
1315 pr_debug("ERROR: type of '%s' incorrect\n", name);
1316 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1324 apply_config_value_for_key(int map_fd, void *pkey,
1325 size_t val_size, u64 val)
1331 u8 _val = (u8)(val);
1332 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1336 u16 _val = (u16)(val);
1337 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1341 u32 _val = (u32)(val);
1342 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1346 err = bpf_map_update_elem(map_fd, pkey, &val, BPF_ANY);
1350 pr_debug("ERROR: invalid value size\n");
1351 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1359 apply_config_evsel_for_key(const char *name, int map_fd, void *pkey,
1360 struct perf_evsel *evsel)
1362 struct xyarray *xy = evsel->fd;
1363 struct perf_event_attr *attr;
1364 unsigned int key, events;
1365 bool check_pass = false;
1370 pr_debug("ERROR: evsel not ready for map %s\n", name);
1371 return -BPF_LOADER_ERRNO__INTERNAL;
1374 if (xy->row_size / xy->entry_size != 1) {
1375 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1377 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM;
1380 attr = &evsel->attr;
1381 if (attr->inherit) {
1382 pr_debug("ERROR: Can't put inherit event into map %s\n", name);
1383 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH;
1386 if (perf_evsel__is_bpf_output(evsel))
1388 if (attr->type == PERF_TYPE_RAW)
1390 if (attr->type == PERF_TYPE_HARDWARE)
1393 pr_debug("ERROR: Event type is wrong for map %s\n", name);
1394 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE;
1397 events = xy->entries / (xy->row_size / xy->entry_size);
1398 key = *((unsigned int *)pkey);
1399 if (key >= events) {
1400 pr_debug("ERROR: there is no event %d for map %s\n",
1402 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE;
1404 evt_fd = xyarray__entry(xy, key, 0);
1405 err = bpf_map_update_elem(map_fd, pkey, evt_fd, BPF_ANY);
1412 apply_obj_config_map_for_key(const char *name, int map_fd,
1413 struct bpf_map_def *pdef __maybe_unused,
1414 struct bpf_map_op *op,
1415 void *pkey, void *arg __maybe_unused)
1419 switch (op->op_type) {
1420 case BPF_MAP_OP_SET_VALUE:
1421 err = apply_config_value_for_key(map_fd, pkey,
1425 case BPF_MAP_OP_SET_EVSEL:
1426 err = apply_config_evsel_for_key(name, map_fd, pkey,
1430 pr_debug("ERROR: unknown value type for '%s'\n", name);
1431 err = -BPF_LOADER_ERRNO__INTERNAL;
1437 apply_obj_config_map(struct bpf_map *map)
1439 return bpf_map_config_foreach_key(map,
1440 apply_obj_config_map_for_key,
1445 apply_obj_config_object(struct bpf_object *obj)
1447 struct bpf_map *map;
1450 bpf_map__for_each(map, obj) {
1451 err = apply_obj_config_map(map);
1458 int bpf__apply_obj_config(void)
1460 struct bpf_object *obj, *tmp;
1463 bpf_object__for_each_safe(obj, tmp) {
1464 err = apply_obj_config_object(obj);
1472 #define bpf__for_each_map(pos, obj, objtmp) \
1473 bpf_object__for_each_safe(obj, objtmp) \
1474 bpf_map__for_each(pos, obj)
1476 #define bpf__for_each_stdout_map(pos, obj, objtmp) \
1477 bpf__for_each_map(pos, obj, objtmp) \
1478 if (bpf_map__get_name(pos) && \
1479 (strcmp("__bpf_stdout__", \
1480 bpf_map__get_name(pos)) == 0))
1482 int bpf__setup_stdout(struct perf_evlist *evlist __maybe_unused)
1484 struct bpf_map_priv *tmpl_priv = NULL;
1485 struct bpf_object *obj, *tmp;
1486 struct perf_evsel *evsel = NULL;
1487 struct bpf_map *map;
1489 bool need_init = false;
1491 bpf__for_each_stdout_map(map, obj, tmp) {
1492 struct bpf_map_priv *priv;
1494 err = bpf_map__get_private(map, (void **)&priv);
1496 return -BPF_LOADER_ERRNO__INTERNAL;
1499 * No need to check map type: type should have been
1500 * verified by kernel.
1502 if (!need_init && !priv)
1504 if (!tmpl_priv && priv)
1512 err = parse_events(evlist, "bpf-output/no-inherit=1,name=__bpf_stdout__/",
1515 pr_debug("ERROR: failed to create bpf-output event\n");
1519 evsel = perf_evlist__last(evlist);
1522 bpf__for_each_stdout_map(map, obj, tmp) {
1523 struct bpf_map_priv *priv;
1525 err = bpf_map__get_private(map, (void **)&priv);
1527 return -BPF_LOADER_ERRNO__INTERNAL;
1532 priv = bpf_map_priv__clone(tmpl_priv);
1536 err = bpf_map__set_private(map, priv, bpf_map_priv__clear);
1538 bpf_map_priv__clear(map, priv);
1542 struct bpf_map_op *op;
1544 op = bpf_map__add_newop(map, NULL);
1547 op->op_type = BPF_MAP_OP_SET_EVSEL;
1548 op->v.evsel = evsel;
1555 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1556 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1557 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1559 static const char *bpf_loader_strerror_table[NR_ERRNO] = {
1560 [ERRCODE_OFFSET(CONFIG)] = "Invalid config string",
1561 [ERRCODE_OFFSET(GROUP)] = "Invalid group name",
1562 [ERRCODE_OFFSET(EVENTNAME)] = "No event name found in config string",
1563 [ERRCODE_OFFSET(INTERNAL)] = "BPF loader internal error",
1564 [ERRCODE_OFFSET(COMPILE)] = "Error when compiling BPF scriptlet",
1565 [ERRCODE_OFFSET(PROGCONF_TERM)] = "Invalid program config term in config string",
1566 [ERRCODE_OFFSET(PROLOGUE)] = "Failed to generate prologue",
1567 [ERRCODE_OFFSET(PROLOGUE2BIG)] = "Prologue too big for program",
1568 [ERRCODE_OFFSET(PROLOGUEOOB)] = "Offset out of bound for prologue",
1569 [ERRCODE_OFFSET(OBJCONF_OPT)] = "Invalid object config option",
1570 [ERRCODE_OFFSET(OBJCONF_CONF)] = "Config value not set (missing '=')",
1571 [ERRCODE_OFFSET(OBJCONF_MAP_OPT)] = "Invalid object map config option",
1572 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST)] = "Target map doesn't exist",
1573 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE)] = "Incorrect value type for map",
1574 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE)] = "Incorrect map type",
1575 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE)] = "Incorrect map key size",
1576 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE)] = "Incorrect map value size",
1577 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT)] = "Event not found for map setting",
1578 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE)] = "Invalid map size for event setting",
1579 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM)] = "Event dimension too large",
1580 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH)] = "Doesn't support inherit event",
1581 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE)] = "Wrong event type for map",
1582 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG)] = "Index too large",
1586 bpf_loader_strerror(int err, char *buf, size_t size)
1588 char sbuf[STRERR_BUFSIZE];
1594 err = err > 0 ? err : -err;
1596 if (err >= __LIBBPF_ERRNO__START)
1597 return libbpf_strerror(err, buf, size);
1599 if (err >= __BPF_LOADER_ERRNO__START && err < __BPF_LOADER_ERRNO__END) {
1600 msg = bpf_loader_strerror_table[ERRNO_OFFSET(err)];
1601 snprintf(buf, size, "%s", msg);
1602 buf[size - 1] = '\0';
1606 if (err >= __BPF_LOADER_ERRNO__END)
1607 snprintf(buf, size, "Unknown bpf loader error %d", err);
1609 snprintf(buf, size, "%s",
1610 strerror_r(err, sbuf, sizeof(sbuf)));
1612 buf[size - 1] = '\0';
1616 #define bpf__strerror_head(err, buf, size) \
1617 char sbuf[STRERR_BUFSIZE], *emsg;\
1622 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1626 scnprintf(buf, size, "%s", emsg);\
1629 #define bpf__strerror_entry(val, fmt...)\
1631 scnprintf(buf, size, fmt);\
1635 #define bpf__strerror_end(buf, size)\
1637 buf[size - 1] = '\0';
1639 int bpf__strerror_prepare_load(const char *filename, bool source,
1640 int err, char *buf, size_t size)
1645 n = snprintf(buf, size, "Failed to load %s%s: ",
1646 filename, source ? " from source" : "");
1648 buf[size - 1] = '\0';
1654 ret = bpf_loader_strerror(err, buf, size);
1655 buf[size - 1] = '\0';
1659 int bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
1660 int err, char *buf, size_t size)
1662 bpf__strerror_head(err, buf, size);
1663 case BPF_LOADER_ERRNO__PROGCONF_TERM: {
1664 scnprintf(buf, size, "%s (add -v to see detail)", emsg);
1667 bpf__strerror_entry(EEXIST, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1668 bpf__strerror_entry(EACCES, "You need to be root");
1669 bpf__strerror_entry(EPERM, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1670 bpf__strerror_entry(ENOENT, "You need to check probing points in BPF file");
1671 bpf__strerror_end(buf, size);
1675 int bpf__strerror_load(struct bpf_object *obj,
1676 int err, char *buf, size_t size)
1678 bpf__strerror_head(err, buf, size);
1679 case LIBBPF_ERRNO__KVER: {
1680 unsigned int obj_kver = bpf_object__get_kversion(obj);
1681 unsigned int real_kver;
1683 if (fetch_kernel_version(&real_kver, NULL, 0)) {
1684 scnprintf(buf, size, "Unable to fetch kernel version");
1688 if (obj_kver != real_kver) {
1689 scnprintf(buf, size,
1690 "'version' ("KVER_FMT") doesn't match running kernel ("KVER_FMT")",
1691 KVER_PARAM(obj_kver),
1692 KVER_PARAM(real_kver));
1696 scnprintf(buf, size, "Failed to load program for unknown reason");
1699 bpf__strerror_end(buf, size);
1703 int bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
1704 struct parse_events_term *term __maybe_unused,
1705 struct perf_evlist *evlist __maybe_unused,
1706 int *error_pos __maybe_unused, int err,
1707 char *buf, size_t size)
1709 bpf__strerror_head(err, buf, size);
1710 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,
1711 "Can't use this config term with this map type");
1712 bpf__strerror_end(buf, size);
1716 int bpf__strerror_apply_obj_config(int err, char *buf, size_t size)
1718 bpf__strerror_head(err, buf, size);
1719 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM,
1720 "Cannot set event to BPF map in multi-thread tracing");
1721 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH,
1722 "%s (Hint: use -i to turn off inherit)", emsg);
1723 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE,
1724 "Can only put raw, hardware and BPF output event into a BPF map");
1725 bpf__strerror_end(buf, size);
1729 int bpf__strerror_setup_stdout(struct perf_evlist *evlist __maybe_unused,
1730 int err, char *buf, size_t size)
1732 bpf__strerror_head(err, buf, size);
1733 bpf__strerror_end(buf, size);