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 static int libbpf_perf_print(enum libbpf_print_level level __attribute__((unused)),
33 const char *fmt, va_list args)
35 return veprintf(1, verbose, pr_fmt(fmt), args);
38 struct bpf_prog_priv {
42 struct perf_probe_event pev;
44 struct bpf_insn *insns_buf;
49 static bool libbpf_initialized;
52 bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz, const char *name)
54 struct bpf_object *obj;
56 if (!libbpf_initialized) {
57 libbpf_set_print(libbpf_perf_print);
58 libbpf_initialized = true;
61 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, name);
62 if (IS_ERR_OR_NULL(obj)) {
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_perf_print);
76 libbpf_initialized = true;
85 err = perf_clang__compile_bpf(filename, &obj_buf, &obj_buf_sz);
86 perf_clang__cleanup();
88 pr_debug("bpf: builtin compilation failed: %d, try external compiler\n", err);
89 err = llvm__compile_bpf(filename, &obj_buf, &obj_buf_sz);
91 return ERR_PTR(-BPF_LOADER_ERRNO__COMPILE);
93 pr_debug("bpf: successful builtin compilation\n");
94 obj = bpf_object__open_buffer(obj_buf, obj_buf_sz, filename);
96 if (!IS_ERR_OR_NULL(obj) && llvm_param.dump_obj)
97 llvm__dump_obj(filename, obj_buf, obj_buf_sz);
101 obj = bpf_object__open(filename);
103 if (IS_ERR_OR_NULL(obj)) {
104 pr_debug("bpf: failed to load %s\n", filename);
111 void bpf__clear(void)
113 struct bpf_object *obj, *tmp;
115 bpf_object__for_each_safe(obj, tmp) {
117 bpf_object__close(obj);
122 clear_prog_priv(struct bpf_program *prog __maybe_unused,
125 struct bpf_prog_priv *priv = _priv;
127 cleanup_perf_probe_events(&priv->pev, 1);
128 zfree(&priv->insns_buf);
129 zfree(&priv->type_mapping);
130 zfree(&priv->sys_name);
131 zfree(&priv->evt_name);
136 prog_config__exec(const char *value, struct perf_probe_event *pev)
139 pev->target = strdup(value);
146 prog_config__module(const char *value, struct perf_probe_event *pev)
148 pev->uprobes = false;
149 pev->target = strdup(value);
156 prog_config__bool(const char *value, bool *pbool, bool invert)
164 err = strtobool(value, &bool_value);
168 *pbool = invert ? !bool_value : bool_value;
173 prog_config__inlines(const char *value,
174 struct perf_probe_event *pev __maybe_unused)
176 return prog_config__bool(value, &probe_conf.no_inlines, true);
180 prog_config__force(const char *value,
181 struct perf_probe_event *pev __maybe_unused)
183 return prog_config__bool(value, &probe_conf.force_add, false);
190 int (*func)(const char *, struct perf_probe_event *);
191 } bpf_prog_config_terms[] = {
194 .usage = "exec=<full path of file>",
195 .desc = "Set uprobe target",
196 .func = prog_config__exec,
200 .usage = "module=<module name> ",
201 .desc = "Set kprobe module",
202 .func = prog_config__module,
206 .usage = "inlines=[yes|no] ",
207 .desc = "Probe at inline symbol",
208 .func = prog_config__inlines,
212 .usage = "force=[yes|no] ",
213 .desc = "Forcibly add events with existing name",
214 .func = prog_config__force,
219 do_prog_config(const char *key, const char *value,
220 struct perf_probe_event *pev)
224 pr_debug("config bpf program: %s=%s\n", key, value);
225 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
226 if (strcmp(key, bpf_prog_config_terms[i].key) == 0)
227 return bpf_prog_config_terms[i].func(value, pev);
229 pr_debug("BPF: ERROR: invalid program config option: %s=%s\n",
232 pr_debug("\nHint: Valid options are:\n");
233 for (i = 0; i < ARRAY_SIZE(bpf_prog_config_terms); i++)
234 pr_debug("\t%s:\t%s\n", bpf_prog_config_terms[i].usage,
235 bpf_prog_config_terms[i].desc);
238 return -BPF_LOADER_ERRNO__PROGCONF_TERM;
242 parse_prog_config_kvpair(const char *config_str, struct perf_probe_event *pev)
244 char *text = strdup(config_str);
246 const char *main_str = NULL;
250 pr_debug("Not enough memory: dup config_str failed\n");
251 return ERR_PTR(-ENOMEM);
255 while ((sep = strchr(line, ';'))) {
259 equ = strchr(line, '=');
261 pr_warning("WARNING: invalid config in BPF object: %s\n",
263 pr_warning("\tShould be 'key=value'.\n");
268 err = do_prog_config(line, equ + 1, pev);
276 main_str = config_str + (line - text);
279 return err ? ERR_PTR(err) : main_str;
283 parse_prog_config(const char *config_str, const char **p_main_str,
284 bool *is_tp, struct perf_probe_event *pev)
287 const char *main_str = parse_prog_config_kvpair(config_str, pev);
289 if (IS_ERR(main_str))
290 return PTR_ERR(main_str);
292 *p_main_str = main_str;
293 if (!strchr(main_str, '=')) {
294 /* Is a tracepoint event? */
295 const char *s = strchr(main_str, ':');
298 pr_debug("bpf: '%s' is not a valid tracepoint\n",
300 return -BPF_LOADER_ERRNO__CONFIG;
308 err = parse_perf_probe_command(main_str, pev);
310 pr_debug("bpf: '%s' is not a valid config string\n",
312 /* parse failed, don't need clear pev. */
313 return -BPF_LOADER_ERRNO__CONFIG;
319 config_bpf_program(struct bpf_program *prog)
321 struct perf_probe_event *pev = NULL;
322 struct bpf_prog_priv *priv = NULL;
323 const char *config_str, *main_str;
327 /* Initialize per-program probing setting */
328 probe_conf.no_inlines = false;
329 probe_conf.force_add = false;
331 priv = calloc(sizeof(*priv), 1);
333 pr_debug("bpf: failed to alloc priv\n");
338 config_str = bpf_program__section_name(prog);
339 pr_debug("bpf: config program '%s'\n", config_str);
340 err = parse_prog_config(config_str, &main_str, &is_tp, pev);
345 char *s = strchr(main_str, ':');
348 priv->sys_name = strndup(main_str, s - main_str);
349 priv->evt_name = strdup(s + 1);
353 if (pev->group && strcmp(pev->group, PERF_BPF_PROBE_GROUP)) {
354 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
355 config_str, PERF_BPF_PROBE_GROUP);
356 err = -BPF_LOADER_ERRNO__GROUP;
358 } else if (!pev->group)
359 pev->group = strdup(PERF_BPF_PROBE_GROUP);
362 pr_debug("bpf: strdup failed\n");
368 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
370 err = -BPF_LOADER_ERRNO__EVENTNAME;
373 pr_debug("bpf: config '%s' is ok\n", config_str);
376 err = bpf_program__set_priv(prog, priv, clear_prog_priv);
378 pr_debug("Failed to set priv for program '%s'\n", config_str);
386 clear_perf_probe_event(pev);
391 static int bpf__prepare_probe(void)
394 static bool initialized = false;
397 * Make err static, so if init failed the first, bpf__prepare_probe()
398 * fails each time without calling init_probe_symbol_maps multiple
405 err = init_probe_symbol_maps(false);
407 pr_debug("Failed to init_probe_symbol_maps\n");
408 probe_conf.max_probes = MAX_PROBES;
413 preproc_gen_prologue(struct bpf_program *prog, int n,
414 struct bpf_insn *orig_insns, int orig_insns_cnt,
415 struct bpf_prog_prep_result *res)
417 struct bpf_prog_priv *priv = bpf_program__priv(prog);
418 struct probe_trace_event *tev;
419 struct perf_probe_event *pev;
420 struct bpf_insn *buf;
421 size_t prologue_cnt = 0;
424 if (IS_ERR(priv) || !priv || priv->is_tp)
429 if (n < 0 || n >= priv->nr_types)
432 /* Find a tev belongs to that type */
433 for (i = 0; i < pev->ntevs; i++) {
434 if (priv->type_mapping[i] == n)
438 if (i >= pev->ntevs) {
439 pr_debug("Internal error: prologue type %d not found\n", n);
440 return -BPF_LOADER_ERRNO__PROLOGUE;
445 buf = priv->insns_buf;
446 err = bpf__gen_prologue(tev->args, tev->nargs,
448 BPF_MAXINSNS - orig_insns_cnt);
452 title = bpf_program__section_name(prog);
453 pr_debug("Failed to generate prologue for program %s\n",
458 memcpy(&buf[prologue_cnt], orig_insns,
459 sizeof(struct bpf_insn) * orig_insns_cnt);
461 res->new_insn_ptr = buf;
462 res->new_insn_cnt = prologue_cnt + orig_insns_cnt;
467 pr_debug("Internal error in preproc_gen_prologue\n");
468 return -BPF_LOADER_ERRNO__PROLOGUE;
472 * compare_tev_args is reflexive, transitive and antisymmetric.
473 * I can proof it but this margin is too narrow to contain.
475 static int compare_tev_args(const void *ptev1, const void *ptev2)
478 const struct probe_trace_event *tev1 =
479 *(const struct probe_trace_event **)ptev1;
480 const struct probe_trace_event *tev2 =
481 *(const struct probe_trace_event **)ptev2;
483 ret = tev2->nargs - tev1->nargs;
487 for (i = 0; i < tev1->nargs; i++) {
488 struct probe_trace_arg *arg1, *arg2;
489 struct probe_trace_arg_ref *ref1, *ref2;
491 arg1 = &tev1->args[i];
492 arg2 = &tev2->args[i];
494 ret = strcmp(arg1->value, arg2->value);
501 while (ref1 && ref2) {
502 ret = ref2->offset - ref1->offset;
511 return ref2 ? 1 : -1;
518 * Assign a type number to each tevs in a pev.
519 * mapping is an array with same slots as tevs in that pev.
520 * nr_types will be set to number of types.
522 static int map_prologue(struct perf_probe_event *pev, int *mapping,
526 struct probe_trace_event **ptevs;
528 size_t array_sz = sizeof(*ptevs) * pev->ntevs;
530 ptevs = malloc(array_sz);
532 pr_debug("Not enough memory: alloc ptevs failed\n");
536 pr_debug("In map_prologue, ntevs=%d\n", pev->ntevs);
537 for (i = 0; i < pev->ntevs; i++)
538 ptevs[i] = &pev->tevs[i];
540 qsort(ptevs, pev->ntevs, sizeof(*ptevs),
543 for (i = 0; i < pev->ntevs; i++) {
546 n = ptevs[i] - pev->tevs;
549 pr_debug("mapping[%d]=%d\n", n, type);
553 if (compare_tev_args(ptevs + i, ptevs + i - 1) == 0)
558 pr_debug("mapping[%d]=%d\n", n, mapping[n]);
561 *nr_types = type + 1;
566 static int hook_load_preprocessor(struct bpf_program *prog)
568 struct bpf_prog_priv *priv = bpf_program__priv(prog);
569 struct perf_probe_event *pev;
570 bool need_prologue = false;
573 if (IS_ERR(priv) || !priv) {
574 pr_debug("Internal error when hook preprocessor\n");
575 return -BPF_LOADER_ERRNO__INTERNAL;
579 priv->need_prologue = false;
584 for (i = 0; i < pev->ntevs; i++) {
585 struct probe_trace_event *tev = &pev->tevs[i];
587 if (tev->nargs > 0) {
588 need_prologue = true;
594 * Since all tevs don't have argument, we don't need generate
597 if (!need_prologue) {
598 priv->need_prologue = false;
602 priv->need_prologue = true;
603 priv->insns_buf = malloc(sizeof(struct bpf_insn) * BPF_MAXINSNS);
604 if (!priv->insns_buf) {
605 pr_debug("Not enough memory: alloc insns_buf failed\n");
609 priv->type_mapping = malloc(sizeof(int) * pev->ntevs);
610 if (!priv->type_mapping) {
611 pr_debug("Not enough memory: alloc type_mapping failed\n");
614 memset(priv->type_mapping, -1,
615 sizeof(int) * pev->ntevs);
617 err = map_prologue(pev, priv->type_mapping, &priv->nr_types);
621 err = bpf_program__set_prep(prog, priv->nr_types,
622 preproc_gen_prologue);
626 int bpf__probe(struct bpf_object *obj)
629 struct bpf_program *prog;
630 struct bpf_prog_priv *priv;
631 struct perf_probe_event *pev;
633 err = bpf__prepare_probe();
635 pr_debug("bpf__prepare_probe failed\n");
639 bpf_object__for_each_program(prog, obj) {
640 err = config_bpf_program(prog);
644 priv = bpf_program__priv(prog);
645 if (IS_ERR(priv) || !priv) {
651 bpf_program__set_tracepoint(prog);
655 bpf_program__set_kprobe(prog);
658 err = convert_perf_probe_events(pev, 1);
660 pr_debug("bpf_probe: failed to convert perf probe events\n");
664 err = apply_perf_probe_events(pev, 1);
666 pr_debug("bpf_probe: failed to apply perf probe events\n");
671 * After probing, let's consider prologue, which
672 * adds program fetcher to BPF programs.
674 * hook_load_preprocessorr() hooks pre-processor
675 * to bpf_program, let it generate prologue
676 * dynamically during loading.
678 err = hook_load_preprocessor(prog);
683 return err < 0 ? err : 0;
686 #define EVENTS_WRITE_BUFSIZE 4096
687 int bpf__unprobe(struct bpf_object *obj)
690 struct bpf_program *prog;
692 bpf_object__for_each_program(prog, obj) {
693 struct bpf_prog_priv *priv = bpf_program__priv(prog);
696 if (IS_ERR(priv) || !priv || priv->is_tp)
699 for (i = 0; i < priv->pev.ntevs; i++) {
700 struct probe_trace_event *tev = &priv->pev.tevs[i];
701 char name_buf[EVENTS_WRITE_BUFSIZE];
702 struct strfilter *delfilter;
704 snprintf(name_buf, EVENTS_WRITE_BUFSIZE,
705 "%s:%s", tev->group, tev->event);
706 name_buf[EVENTS_WRITE_BUFSIZE - 1] = '\0';
708 delfilter = strfilter__new(name_buf, NULL);
710 pr_debug("Failed to create filter for unprobing\n");
715 err = del_perf_probe_events(delfilter);
716 strfilter__delete(delfilter);
718 pr_debug("Failed to delete %s\n", name_buf);
727 int bpf__load(struct bpf_object *obj)
731 err = bpf_object__load(obj);
734 libbpf_strerror(err, bf, sizeof(bf));
735 pr_debug("bpf: load objects failed: err=%d: (%s)\n", err, bf);
741 int bpf__foreach_event(struct bpf_object *obj,
742 bpf_prog_iter_callback_t func,
745 struct bpf_program *prog;
748 bpf_object__for_each_program(prog, obj) {
749 struct bpf_prog_priv *priv = bpf_program__priv(prog);
750 struct probe_trace_event *tev;
751 struct perf_probe_event *pev;
754 if (IS_ERR(priv) || !priv) {
755 pr_debug("bpf: failed to get private field\n");
756 return -BPF_LOADER_ERRNO__INTERNAL;
760 fd = bpf_program__fd(prog);
761 err = (*func)(priv->sys_name, priv->evt_name, fd, obj, arg);
763 pr_debug("bpf: tracepoint call back failed, stop iterate\n");
770 for (i = 0; i < pev->ntevs; i++) {
773 if (priv->need_prologue) {
774 int type = priv->type_mapping[i];
776 fd = bpf_program__nth_fd(prog, type);
778 fd = bpf_program__fd(prog);
782 pr_debug("bpf: failed to get file descriptor\n");
786 err = (*func)(tev->group, tev->event, fd, obj, arg);
788 pr_debug("bpf: call back failed, stop iterate\n");
796 enum bpf_map_op_type {
797 BPF_MAP_OP_SET_VALUE,
798 BPF_MAP_OP_SET_EVSEL,
801 enum bpf_map_key_type {
807 struct list_head list;
808 enum bpf_map_op_type op_type;
809 enum bpf_map_key_type key_type;
811 struct parse_events_array array;
819 struct bpf_map_priv {
820 struct list_head ops_list;
824 bpf_map_op__delete(struct bpf_map_op *op)
826 if (!list_empty(&op->list))
827 list_del_init(&op->list);
828 if (op->key_type == BPF_MAP_KEY_RANGES)
829 parse_events__clear_array(&op->k.array);
834 bpf_map_priv__purge(struct bpf_map_priv *priv)
836 struct bpf_map_op *pos, *n;
838 list_for_each_entry_safe(pos, n, &priv->ops_list, list) {
839 list_del_init(&pos->list);
840 bpf_map_op__delete(pos);
845 bpf_map_priv__clear(struct bpf_map *map __maybe_unused,
848 struct bpf_map_priv *priv = _priv;
850 bpf_map_priv__purge(priv);
855 bpf_map_op_setkey(struct bpf_map_op *op, struct parse_events_term *term)
857 op->key_type = BPF_MAP_KEY_ALL;
861 if (term->array.nr_ranges) {
862 size_t memsz = term->array.nr_ranges *
863 sizeof(op->k.array.ranges[0]);
865 op->k.array.ranges = memdup(term->array.ranges, memsz);
866 if (!op->k.array.ranges) {
867 pr_debug("Not enough memory to alloc indices for map\n");
870 op->key_type = BPF_MAP_KEY_RANGES;
871 op->k.array.nr_ranges = term->array.nr_ranges;
876 static struct bpf_map_op *
877 bpf_map_op__new(struct parse_events_term *term)
879 struct bpf_map_op *op;
882 op = zalloc(sizeof(*op));
884 pr_debug("Failed to alloc bpf_map_op\n");
885 return ERR_PTR(-ENOMEM);
887 INIT_LIST_HEAD(&op->list);
889 err = bpf_map_op_setkey(op, term);
897 static struct bpf_map_op *
898 bpf_map_op__clone(struct bpf_map_op *op)
900 struct bpf_map_op *newop;
902 newop = memdup(op, sizeof(*op));
904 pr_debug("Failed to alloc bpf_map_op\n");
908 INIT_LIST_HEAD(&newop->list);
909 if (op->key_type == BPF_MAP_KEY_RANGES) {
910 size_t memsz = op->k.array.nr_ranges *
911 sizeof(op->k.array.ranges[0]);
913 newop->k.array.ranges = memdup(op->k.array.ranges, memsz);
914 if (!newop->k.array.ranges) {
915 pr_debug("Failed to alloc indices for map\n");
924 static struct bpf_map_priv *
925 bpf_map_priv__clone(struct bpf_map_priv *priv)
927 struct bpf_map_priv *newpriv;
928 struct bpf_map_op *pos, *newop;
930 newpriv = zalloc(sizeof(*newpriv));
932 pr_debug("Not enough memory to alloc map private\n");
935 INIT_LIST_HEAD(&newpriv->ops_list);
937 list_for_each_entry(pos, &priv->ops_list, list) {
938 newop = bpf_map_op__clone(pos);
940 bpf_map_priv__purge(newpriv);
943 list_add_tail(&newop->list, &newpriv->ops_list);
950 bpf_map__add_op(struct bpf_map *map, struct bpf_map_op *op)
952 const char *map_name = bpf_map__name(map);
953 struct bpf_map_priv *priv = bpf_map__priv(map);
956 pr_debug("Failed to get private from map %s\n", map_name);
957 return PTR_ERR(priv);
961 priv = zalloc(sizeof(*priv));
963 pr_debug("Not enough memory to alloc map private\n");
966 INIT_LIST_HEAD(&priv->ops_list);
968 if (bpf_map__set_priv(map, priv, bpf_map_priv__clear)) {
970 return -BPF_LOADER_ERRNO__INTERNAL;
974 list_add_tail(&op->list, &priv->ops_list);
978 static struct bpf_map_op *
979 bpf_map__add_newop(struct bpf_map *map, struct parse_events_term *term)
981 struct bpf_map_op *op;
984 op = bpf_map_op__new(term);
988 err = bpf_map__add_op(map, op);
990 bpf_map_op__delete(op);
997 __bpf_map__config_value(struct bpf_map *map,
998 struct parse_events_term *term)
1000 struct bpf_map_op *op;
1001 const char *map_name = bpf_map__name(map);
1002 const struct bpf_map_def *def = bpf_map__def(map);
1005 pr_debug("Unable to get map definition from '%s'\n",
1007 return -BPF_LOADER_ERRNO__INTERNAL;
1010 if (def->type != BPF_MAP_TYPE_ARRAY) {
1011 pr_debug("Map %s type is not BPF_MAP_TYPE_ARRAY\n",
1013 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1015 if (def->key_size < sizeof(unsigned int)) {
1016 pr_debug("Map %s has incorrect key size\n", map_name);
1017 return -BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE;
1019 switch (def->value_size) {
1026 pr_debug("Map %s has incorrect value size\n", map_name);
1027 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1030 op = bpf_map__add_newop(map, term);
1033 op->op_type = BPF_MAP_OP_SET_VALUE;
1034 op->v.value = term->val.num;
1039 bpf_map__config_value(struct bpf_map *map,
1040 struct parse_events_term *term,
1041 struct evlist *evlist __maybe_unused)
1043 if (!term->err_val) {
1044 pr_debug("Config value not set\n");
1045 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1048 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM) {
1049 pr_debug("ERROR: wrong value type for 'value'\n");
1050 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1053 return __bpf_map__config_value(map, term);
1057 __bpf_map__config_event(struct bpf_map *map,
1058 struct parse_events_term *term,
1059 struct evlist *evlist)
1061 struct evsel *evsel;
1062 const struct bpf_map_def *def;
1063 struct bpf_map_op *op;
1064 const char *map_name = bpf_map__name(map);
1066 evsel = perf_evlist__find_evsel_by_str(evlist, term->val.str);
1068 pr_debug("Event (for '%s') '%s' doesn't exist\n",
1069 map_name, term->val.str);
1070 return -BPF_LOADER_ERRNO__OBJCONF_MAP_NOEVT;
1073 def = bpf_map__def(map);
1075 pr_debug("Unable to get map definition from '%s'\n",
1077 return PTR_ERR(def);
1081 * No need to check key_size and value_size:
1082 * kernel has already checked them.
1084 if (def->type != BPF_MAP_TYPE_PERF_EVENT_ARRAY) {
1085 pr_debug("Map %s type is not BPF_MAP_TYPE_PERF_EVENT_ARRAY\n",
1087 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1090 op = bpf_map__add_newop(map, term);
1093 op->op_type = BPF_MAP_OP_SET_EVSEL;
1094 op->v.evsel = evsel;
1099 bpf_map__config_event(struct bpf_map *map,
1100 struct parse_events_term *term,
1101 struct evlist *evlist)
1103 if (!term->err_val) {
1104 pr_debug("Config value not set\n");
1105 return -BPF_LOADER_ERRNO__OBJCONF_CONF;
1108 if (term->type_val != PARSE_EVENTS__TERM_TYPE_STR) {
1109 pr_debug("ERROR: wrong value type for 'event'\n");
1110 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE;
1113 return __bpf_map__config_event(map, term, evlist);
1116 struct bpf_obj_config__map_func {
1117 const char *config_opt;
1118 int (*config_func)(struct bpf_map *, struct parse_events_term *,
1122 struct bpf_obj_config__map_func bpf_obj_config__map_funcs[] = {
1123 {"value", bpf_map__config_value},
1124 {"event", bpf_map__config_event},
1128 config_map_indices_range_check(struct parse_events_term *term,
1129 struct bpf_map *map,
1130 const char *map_name)
1132 struct parse_events_array *array = &term->array;
1133 const struct bpf_map_def *def;
1136 if (!array->nr_ranges)
1138 if (!array->ranges) {
1139 pr_debug("ERROR: map %s: array->nr_ranges is %d but range array is NULL\n",
1140 map_name, (int)array->nr_ranges);
1141 return -BPF_LOADER_ERRNO__INTERNAL;
1144 def = bpf_map__def(map);
1146 pr_debug("ERROR: Unable to get map definition from '%s'\n",
1148 return -BPF_LOADER_ERRNO__INTERNAL;
1151 for (i = 0; i < array->nr_ranges; i++) {
1152 unsigned int start = array->ranges[i].start;
1153 size_t length = array->ranges[i].length;
1154 unsigned int idx = start + length - 1;
1156 if (idx >= def->max_entries) {
1157 pr_debug("ERROR: index %d too large\n", idx);
1158 return -BPF_LOADER_ERRNO__OBJCONF_MAP_IDX2BIG;
1165 bpf__obj_config_map(struct bpf_object *obj,
1166 struct parse_events_term *term,
1167 struct evlist *evlist,
1170 /* key is "map:<mapname>.<config opt>" */
1171 char *map_name = strdup(term->config + sizeof("map:") - 1);
1172 struct bpf_map *map;
1173 int err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1180 map_opt = strchr(map_name, '.');
1182 pr_debug("ERROR: Invalid map config: %s\n", map_name);
1187 if (*map_opt == '\0') {
1188 pr_debug("ERROR: Invalid map option: %s\n", term->config);
1192 map = bpf_object__find_map_by_name(obj, map_name);
1194 pr_debug("ERROR: Map %s doesn't exist\n", map_name);
1195 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST;
1199 *key_scan_pos += strlen(map_opt);
1200 err = config_map_indices_range_check(term, map, map_name);
1203 *key_scan_pos -= strlen(map_opt);
1205 for (i = 0; i < ARRAY_SIZE(bpf_obj_config__map_funcs); i++) {
1206 struct bpf_obj_config__map_func *func =
1207 &bpf_obj_config__map_funcs[i];
1209 if (strcmp(map_opt, func->config_opt) == 0) {
1210 err = func->config_func(map, term, evlist);
1215 pr_debug("ERROR: Invalid map config option '%s'\n", map_opt);
1216 err = -BPF_LOADER_ERRNO__OBJCONF_MAP_OPT;
1219 *key_scan_pos += strlen(map_opt);
1225 int bpf__config_obj(struct bpf_object *obj,
1226 struct parse_events_term *term,
1227 struct evlist *evlist,
1230 int key_scan_pos = 0;
1233 if (!obj || !term || !term->config)
1236 if (strstarts(term->config, "map:")) {
1237 key_scan_pos = sizeof("map:") - 1;
1238 err = bpf__obj_config_map(obj, term, evlist, &key_scan_pos);
1241 err = -BPF_LOADER_ERRNO__OBJCONF_OPT;
1244 *error_pos = key_scan_pos;
1249 typedef int (*map_config_func_t)(const char *name, int map_fd,
1250 const struct bpf_map_def *pdef,
1251 struct bpf_map_op *op,
1252 void *pkey, void *arg);
1255 foreach_key_array_all(map_config_func_t func,
1256 void *arg, const char *name,
1257 int map_fd, const struct bpf_map_def *pdef,
1258 struct bpf_map_op *op)
1263 for (i = 0; i < pdef->max_entries; i++) {
1264 err = func(name, map_fd, pdef, op, &i, arg);
1266 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1275 foreach_key_array_ranges(map_config_func_t func, void *arg,
1276 const char *name, int map_fd,
1277 const struct bpf_map_def *pdef,
1278 struct bpf_map_op *op)
1283 for (i = 0; i < op->k.array.nr_ranges; i++) {
1284 unsigned int start = op->k.array.ranges[i].start;
1285 size_t length = op->k.array.ranges[i].length;
1287 for (j = 0; j < length; j++) {
1288 unsigned int idx = start + j;
1290 err = func(name, map_fd, pdef, op, &idx, arg);
1292 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1302 bpf_map_config_foreach_key(struct bpf_map *map,
1303 map_config_func_t func,
1307 struct bpf_map_op *op;
1308 const struct bpf_map_def *def;
1309 const char *name = bpf_map__name(map);
1310 struct bpf_map_priv *priv = bpf_map__priv(map);
1313 pr_debug("ERROR: failed to get private from map %s\n", name);
1314 return -BPF_LOADER_ERRNO__INTERNAL;
1316 if (!priv || list_empty(&priv->ops_list)) {
1317 pr_debug("INFO: nothing to config for map %s\n", name);
1321 def = bpf_map__def(map);
1323 pr_debug("ERROR: failed to get definition from map %s\n", name);
1324 return -BPF_LOADER_ERRNO__INTERNAL;
1326 map_fd = bpf_map__fd(map);
1328 pr_debug("ERROR: failed to get fd from map %s\n", name);
1332 list_for_each_entry(op, &priv->ops_list, list) {
1333 switch (def->type) {
1334 case BPF_MAP_TYPE_ARRAY:
1335 case BPF_MAP_TYPE_PERF_EVENT_ARRAY:
1336 switch (op->key_type) {
1337 case BPF_MAP_KEY_ALL:
1338 err = foreach_key_array_all(func, arg, name,
1341 case BPF_MAP_KEY_RANGES:
1342 err = foreach_key_array_ranges(func, arg, name,
1347 pr_debug("ERROR: keytype for map '%s' invalid\n",
1349 return -BPF_LOADER_ERRNO__INTERNAL;
1355 pr_debug("ERROR: type of '%s' incorrect\n", name);
1356 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE;
1364 apply_config_value_for_key(int map_fd, void *pkey,
1365 size_t val_size, u64 val)
1371 u8 _val = (u8)(val);
1372 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1376 u16 _val = (u16)(val);
1377 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1381 u32 _val = (u32)(val);
1382 err = bpf_map_update_elem(map_fd, pkey, &_val, BPF_ANY);
1386 err = bpf_map_update_elem(map_fd, pkey, &val, BPF_ANY);
1390 pr_debug("ERROR: invalid value size\n");
1391 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE;
1399 apply_config_evsel_for_key(const char *name, int map_fd, void *pkey,
1400 struct evsel *evsel)
1402 struct xyarray *xy = evsel->core.fd;
1403 struct perf_event_attr *attr;
1404 unsigned int key, events;
1405 bool check_pass = false;
1410 pr_debug("ERROR: evsel not ready for map %s\n", name);
1411 return -BPF_LOADER_ERRNO__INTERNAL;
1414 if (xy->row_size / xy->entry_size != 1) {
1415 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1417 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM;
1420 attr = &evsel->core.attr;
1421 if (attr->inherit) {
1422 pr_debug("ERROR: Can't put inherit event into map %s\n", name);
1423 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH;
1426 if (evsel__is_bpf_output(evsel))
1428 if (attr->type == PERF_TYPE_RAW)
1430 if (attr->type == PERF_TYPE_HARDWARE)
1433 pr_debug("ERROR: Event type is wrong for map %s\n", name);
1434 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE;
1437 events = xy->entries / (xy->row_size / xy->entry_size);
1438 key = *((unsigned int *)pkey);
1439 if (key >= events) {
1440 pr_debug("ERROR: there is no event %d for map %s\n",
1442 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE;
1444 evt_fd = xyarray__entry(xy, key, 0);
1445 err = bpf_map_update_elem(map_fd, pkey, evt_fd, BPF_ANY);
1452 apply_obj_config_map_for_key(const char *name, int map_fd,
1453 const struct bpf_map_def *pdef,
1454 struct bpf_map_op *op,
1455 void *pkey, void *arg __maybe_unused)
1459 switch (op->op_type) {
1460 case BPF_MAP_OP_SET_VALUE:
1461 err = apply_config_value_for_key(map_fd, pkey,
1465 case BPF_MAP_OP_SET_EVSEL:
1466 err = apply_config_evsel_for_key(name, map_fd, pkey,
1470 pr_debug("ERROR: unknown value type for '%s'\n", name);
1471 err = -BPF_LOADER_ERRNO__INTERNAL;
1477 apply_obj_config_map(struct bpf_map *map)
1479 return bpf_map_config_foreach_key(map,
1480 apply_obj_config_map_for_key,
1485 apply_obj_config_object(struct bpf_object *obj)
1487 struct bpf_map *map;
1490 bpf_object__for_each_map(map, obj) {
1491 err = apply_obj_config_map(map);
1498 int bpf__apply_obj_config(void)
1500 struct bpf_object *obj, *tmp;
1503 bpf_object__for_each_safe(obj, tmp) {
1504 err = apply_obj_config_object(obj);
1512 #define bpf__for_each_map(pos, obj, objtmp) \
1513 bpf_object__for_each_safe(obj, objtmp) \
1514 bpf_object__for_each_map(pos, obj)
1516 #define bpf__for_each_map_named(pos, obj, objtmp, name) \
1517 bpf__for_each_map(pos, obj, objtmp) \
1518 if (bpf_map__name(pos) && \
1520 bpf_map__name(pos)) == 0))
1522 struct evsel *bpf__setup_output_event(struct evlist *evlist, const char *name)
1524 struct bpf_map_priv *tmpl_priv = NULL;
1525 struct bpf_object *obj, *tmp;
1526 struct evsel *evsel = NULL;
1527 struct bpf_map *map;
1529 bool need_init = false;
1531 bpf__for_each_map_named(map, obj, tmp, name) {
1532 struct bpf_map_priv *priv = bpf_map__priv(map);
1535 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL);
1538 * No need to check map type: type should have been
1539 * verified by kernel.
1541 if (!need_init && !priv)
1543 if (!tmpl_priv && priv)
1551 char *event_definition = NULL;
1553 if (asprintf(&event_definition, "bpf-output/no-inherit=1,name=%s/", name) < 0)
1554 return ERR_PTR(-ENOMEM);
1556 err = parse_events(evlist, event_definition, NULL);
1557 free(event_definition);
1560 pr_debug("ERROR: failed to create the \"%s\" bpf-output event\n", name);
1561 return ERR_PTR(-err);
1564 evsel = evlist__last(evlist);
1567 bpf__for_each_map_named(map, obj, tmp, name) {
1568 struct bpf_map_priv *priv = bpf_map__priv(map);
1571 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL);
1576 priv = bpf_map_priv__clone(tmpl_priv);
1578 return ERR_PTR(-ENOMEM);
1580 err = bpf_map__set_priv(map, priv, bpf_map_priv__clear);
1582 bpf_map_priv__clear(map, priv);
1583 return ERR_PTR(err);
1586 struct bpf_map_op *op;
1588 op = bpf_map__add_newop(map, NULL);
1590 return ERR_CAST(op);
1591 op->op_type = BPF_MAP_OP_SET_EVSEL;
1592 op->v.evsel = evsel;
1599 int bpf__setup_stdout(struct evlist *evlist)
1601 struct evsel *evsel = bpf__setup_output_event(evlist, "__bpf_stdout__");
1602 return PTR_ERR_OR_ZERO(evsel);
1605 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1606 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1607 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1609 static const char *bpf_loader_strerror_table[NR_ERRNO] = {
1610 [ERRCODE_OFFSET(CONFIG)] = "Invalid config string",
1611 [ERRCODE_OFFSET(GROUP)] = "Invalid group name",
1612 [ERRCODE_OFFSET(EVENTNAME)] = "No event name found in config string",
1613 [ERRCODE_OFFSET(INTERNAL)] = "BPF loader internal error",
1614 [ERRCODE_OFFSET(COMPILE)] = "Error when compiling BPF scriptlet",
1615 [ERRCODE_OFFSET(PROGCONF_TERM)] = "Invalid program config term in config string",
1616 [ERRCODE_OFFSET(PROLOGUE)] = "Failed to generate prologue",
1617 [ERRCODE_OFFSET(PROLOGUE2BIG)] = "Prologue too big for program",
1618 [ERRCODE_OFFSET(PROLOGUEOOB)] = "Offset out of bound for prologue",
1619 [ERRCODE_OFFSET(OBJCONF_OPT)] = "Invalid object config option",
1620 [ERRCODE_OFFSET(OBJCONF_CONF)] = "Config value not set (missing '=')",
1621 [ERRCODE_OFFSET(OBJCONF_MAP_OPT)] = "Invalid object map config option",
1622 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST)] = "Target map doesn't exist",
1623 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE)] = "Incorrect value type for map",
1624 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE)] = "Incorrect map type",
1625 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE)] = "Incorrect map key size",
1626 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE)] = "Incorrect map value size",
1627 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT)] = "Event not found for map setting",
1628 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE)] = "Invalid map size for event setting",
1629 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM)] = "Event dimension too large",
1630 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH)] = "Doesn't support inherit event",
1631 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE)] = "Wrong event type for map",
1632 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG)] = "Index too large",
1636 bpf_loader_strerror(int err, char *buf, size_t size)
1638 char sbuf[STRERR_BUFSIZE];
1644 err = err > 0 ? err : -err;
1646 if (err >= __LIBBPF_ERRNO__START)
1647 return libbpf_strerror(err, buf, size);
1649 if (err >= __BPF_LOADER_ERRNO__START && err < __BPF_LOADER_ERRNO__END) {
1650 msg = bpf_loader_strerror_table[ERRNO_OFFSET(err)];
1651 snprintf(buf, size, "%s", msg);
1652 buf[size - 1] = '\0';
1656 if (err >= __BPF_LOADER_ERRNO__END)
1657 snprintf(buf, size, "Unknown bpf loader error %d", err);
1659 snprintf(buf, size, "%s",
1660 str_error_r(err, sbuf, sizeof(sbuf)));
1662 buf[size - 1] = '\0';
1666 #define bpf__strerror_head(err, buf, size) \
1667 char sbuf[STRERR_BUFSIZE], *emsg;\
1672 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1676 scnprintf(buf, size, "%s", emsg);\
1679 #define bpf__strerror_entry(val, fmt...)\
1681 scnprintf(buf, size, fmt);\
1685 #define bpf__strerror_end(buf, size)\
1687 buf[size - 1] = '\0';
1689 int bpf__strerror_prepare_load(const char *filename, bool source,
1690 int err, char *buf, size_t size)
1695 n = snprintf(buf, size, "Failed to load %s%s: ",
1696 filename, source ? " from source" : "");
1698 buf[size - 1] = '\0';
1704 ret = bpf_loader_strerror(err, buf, size);
1705 buf[size - 1] = '\0';
1709 int bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
1710 int err, char *buf, size_t size)
1712 bpf__strerror_head(err, buf, size);
1713 case BPF_LOADER_ERRNO__PROGCONF_TERM: {
1714 scnprintf(buf, size, "%s (add -v to see detail)", emsg);
1717 bpf__strerror_entry(EEXIST, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1718 bpf__strerror_entry(EACCES, "You need to be root");
1719 bpf__strerror_entry(EPERM, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1720 bpf__strerror_entry(ENOENT, "You need to check probing points in BPF file");
1721 bpf__strerror_end(buf, size);
1725 int bpf__strerror_load(struct bpf_object *obj,
1726 int err, char *buf, size_t size)
1728 bpf__strerror_head(err, buf, size);
1729 case LIBBPF_ERRNO__KVER: {
1730 unsigned int obj_kver = bpf_object__kversion(obj);
1731 unsigned int real_kver;
1733 if (fetch_kernel_version(&real_kver, NULL, 0)) {
1734 scnprintf(buf, size, "Unable to fetch kernel version");
1738 if (obj_kver != real_kver) {
1739 scnprintf(buf, size,
1740 "'version' ("KVER_FMT") doesn't match running kernel ("KVER_FMT")",
1741 KVER_PARAM(obj_kver),
1742 KVER_PARAM(real_kver));
1746 scnprintf(buf, size, "Failed to load program for unknown reason");
1749 bpf__strerror_end(buf, size);
1753 int bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
1754 struct parse_events_term *term __maybe_unused,
1755 struct evlist *evlist __maybe_unused,
1756 int *error_pos __maybe_unused, int err,
1757 char *buf, size_t size)
1759 bpf__strerror_head(err, buf, size);
1760 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,
1761 "Can't use this config term with this map type");
1762 bpf__strerror_end(buf, size);
1766 int bpf__strerror_apply_obj_config(int err, char *buf, size_t size)
1768 bpf__strerror_head(err, buf, size);
1769 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM,
1770 "Cannot set event to BPF map in multi-thread tracing");
1771 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH,
1772 "%s (Hint: use -i to turn off inherit)", emsg);
1773 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE,
1774 "Can only put raw, hardware and BPF output event into a BPF map");
1775 bpf__strerror_end(buf, size);
1779 int bpf__strerror_setup_output_event(struct evlist *evlist __maybe_unused,
1780 int err, char *buf, size_t size)
1782 bpf__strerror_head(err, buf, size);
1783 bpf__strerror_end(buf, size);