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
{
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;
89 err
= llvm__compile_bpf(filename
, &obj_buf
, &obj_buf_sz
);
91 return ERR_PTR(-BPF_LOADER_ERRNO__COMPILE
);
92 obj
= bpf_object__open_buffer(obj_buf
, obj_buf_sz
, filename
);
95 obj
= bpf_object__open(filename
);
98 pr_debug("bpf: failed to load %s\n", filename
);
105 void bpf__clear(void)
107 struct bpf_object
*obj
, *tmp
;
109 bpf_object__for_each_safe(obj
, tmp
) {
111 bpf_object__close(obj
);
116 clear_prog_priv(struct bpf_program
*prog __maybe_unused
,
119 struct bpf_prog_priv
*priv
= _priv
;
121 cleanup_perf_probe_events(&priv
->pev
, 1);
122 zfree(&priv
->insns_buf
);
123 zfree(&priv
->type_mapping
);
124 zfree(&priv
->sys_name
);
125 zfree(&priv
->evt_name
);
130 prog_config__exec(const char *value
, struct perf_probe_event
*pev
)
133 pev
->target
= strdup(value
);
140 prog_config__module(const char *value
, struct perf_probe_event
*pev
)
142 pev
->uprobes
= false;
143 pev
->target
= strdup(value
);
150 prog_config__bool(const char *value
, bool *pbool
, bool invert
)
158 err
= strtobool(value
, &bool_value
);
162 *pbool
= invert
? !bool_value
: bool_value
;
167 prog_config__inlines(const char *value
,
168 struct perf_probe_event
*pev __maybe_unused
)
170 return prog_config__bool(value
, &probe_conf
.no_inlines
, true);
174 prog_config__force(const char *value
,
175 struct perf_probe_event
*pev __maybe_unused
)
177 return prog_config__bool(value
, &probe_conf
.force_add
, false);
184 int (*func
)(const char *, struct perf_probe_event
*);
185 } bpf_prog_config_terms
[] = {
188 .usage
= "exec=<full path of file>",
189 .desc
= "Set uprobe target",
190 .func
= prog_config__exec
,
194 .usage
= "module=<module name> ",
195 .desc
= "Set kprobe module",
196 .func
= prog_config__module
,
200 .usage
= "inlines=[yes|no] ",
201 .desc
= "Probe at inline symbol",
202 .func
= prog_config__inlines
,
206 .usage
= "force=[yes|no] ",
207 .desc
= "Forcibly add events with existing name",
208 .func
= prog_config__force
,
213 do_prog_config(const char *key
, const char *value
,
214 struct perf_probe_event
*pev
)
218 pr_debug("config bpf program: %s=%s\n", key
, value
);
219 for (i
= 0; i
< ARRAY_SIZE(bpf_prog_config_terms
); i
++)
220 if (strcmp(key
, bpf_prog_config_terms
[i
].key
) == 0)
221 return bpf_prog_config_terms
[i
].func(value
, pev
);
223 pr_debug("BPF: ERROR: invalid program config option: %s=%s\n",
226 pr_debug("\nHint: Valid options are:\n");
227 for (i
= 0; i
< ARRAY_SIZE(bpf_prog_config_terms
); i
++)
228 pr_debug("\t%s:\t%s\n", bpf_prog_config_terms
[i
].usage
,
229 bpf_prog_config_terms
[i
].desc
);
232 return -BPF_LOADER_ERRNO__PROGCONF_TERM
;
236 parse_prog_config_kvpair(const char *config_str
, struct perf_probe_event
*pev
)
238 char *text
= strdup(config_str
);
240 const char *main_str
= NULL
;
244 pr_debug("No enough memory: dup config_str failed\n");
245 return ERR_PTR(-ENOMEM
);
249 while ((sep
= strchr(line
, ';'))) {
253 equ
= strchr(line
, '=');
255 pr_warning("WARNING: invalid config in BPF object: %s\n",
257 pr_warning("\tShould be 'key=value'.\n");
262 err
= do_prog_config(line
, equ
+ 1, pev
);
270 main_str
= config_str
+ (line
- text
);
273 return err
? ERR_PTR(err
) : main_str
;
277 parse_prog_config(const char *config_str
, const char **p_main_str
,
278 bool *is_tp
, struct perf_probe_event
*pev
)
281 const char *main_str
= parse_prog_config_kvpair(config_str
, pev
);
283 if (IS_ERR(main_str
))
284 return PTR_ERR(main_str
);
286 *p_main_str
= main_str
;
287 if (!strchr(main_str
, '=')) {
288 /* Is a tracepoint event? */
289 const char *s
= strchr(main_str
, ':');
292 pr_debug("bpf: '%s' is not a valid tracepoint\n",
294 return -BPF_LOADER_ERRNO__CONFIG
;
302 err
= parse_perf_probe_command(main_str
, pev
);
304 pr_debug("bpf: '%s' is not a valid config string\n",
306 /* parse failed, don't need clear pev. */
307 return -BPF_LOADER_ERRNO__CONFIG
;
313 config_bpf_program(struct bpf_program
*prog
)
315 struct perf_probe_event
*pev
= NULL
;
316 struct bpf_prog_priv
*priv
= NULL
;
317 const char *config_str
, *main_str
;
321 /* Initialize per-program probing setting */
322 probe_conf
.no_inlines
= false;
323 probe_conf
.force_add
= false;
325 config_str
= bpf_program__title(prog
, false);
326 if (IS_ERR(config_str
)) {
327 pr_debug("bpf: unable to get title for program\n");
328 return PTR_ERR(config_str
);
331 priv
= calloc(sizeof(*priv
), 1);
333 pr_debug("bpf: failed to alloc priv\n");
338 pr_debug("bpf: config program '%s'\n", config_str
);
339 err
= parse_prog_config(config_str
, &main_str
, &is_tp
, pev
);
344 char *s
= strchr(main_str
, ':');
347 priv
->sys_name
= strndup(main_str
, s
- main_str
);
348 priv
->evt_name
= strdup(s
+ 1);
352 if (pev
->group
&& strcmp(pev
->group
, PERF_BPF_PROBE_GROUP
)) {
353 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
354 config_str
, PERF_BPF_PROBE_GROUP
);
355 err
= -BPF_LOADER_ERRNO__GROUP
;
357 } else if (!pev
->group
)
358 pev
->group
= strdup(PERF_BPF_PROBE_GROUP
);
361 pr_debug("bpf: strdup failed\n");
367 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
369 err
= -BPF_LOADER_ERRNO__EVENTNAME
;
372 pr_debug("bpf: config '%s' is ok\n", config_str
);
375 err
= bpf_program__set_priv(prog
, priv
, clear_prog_priv
);
377 pr_debug("Failed to set priv for program '%s'\n", config_str
);
385 clear_perf_probe_event(pev
);
390 static int bpf__prepare_probe(void)
393 static bool initialized
= false;
396 * Make err static, so if init failed the first, bpf__prepare_probe()
397 * fails each time without calling init_probe_symbol_maps multiple
404 err
= init_probe_symbol_maps(false);
406 pr_debug("Failed to init_probe_symbol_maps\n");
407 probe_conf
.max_probes
= MAX_PROBES
;
412 preproc_gen_prologue(struct bpf_program
*prog
, int n
,
413 struct bpf_insn
*orig_insns
, int orig_insns_cnt
,
414 struct bpf_prog_prep_result
*res
)
416 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
417 struct probe_trace_event
*tev
;
418 struct perf_probe_event
*pev
;
419 struct bpf_insn
*buf
;
420 size_t prologue_cnt
= 0;
423 if (IS_ERR(priv
) || !priv
|| priv
->is_tp
)
428 if (n
< 0 || n
>= priv
->nr_types
)
431 /* Find a tev belongs to that type */
432 for (i
= 0; i
< pev
->ntevs
; i
++) {
433 if (priv
->type_mapping
[i
] == n
)
437 if (i
>= pev
->ntevs
) {
438 pr_debug("Internal error: prologue type %d not found\n", n
);
439 return -BPF_LOADER_ERRNO__PROLOGUE
;
444 buf
= priv
->insns_buf
;
445 err
= bpf__gen_prologue(tev
->args
, tev
->nargs
,
447 BPF_MAXINSNS
- orig_insns_cnt
);
451 title
= bpf_program__title(prog
, false);
455 pr_debug("Failed to generate prologue for program %s\n",
460 memcpy(&buf
[prologue_cnt
], orig_insns
,
461 sizeof(struct bpf_insn
) * orig_insns_cnt
);
463 res
->new_insn_ptr
= buf
;
464 res
->new_insn_cnt
= prologue_cnt
+ orig_insns_cnt
;
469 pr_debug("Internal error in preproc_gen_prologue\n");
470 return -BPF_LOADER_ERRNO__PROLOGUE
;
474 * compare_tev_args is reflexive, transitive and antisymmetric.
475 * I can proof it but this margin is too narrow to contain.
477 static int compare_tev_args(const void *ptev1
, const void *ptev2
)
480 const struct probe_trace_event
*tev1
=
481 *(const struct probe_trace_event
**)ptev1
;
482 const struct probe_trace_event
*tev2
=
483 *(const struct probe_trace_event
**)ptev2
;
485 ret
= tev2
->nargs
- tev1
->nargs
;
489 for (i
= 0; i
< tev1
->nargs
; i
++) {
490 struct probe_trace_arg
*arg1
, *arg2
;
491 struct probe_trace_arg_ref
*ref1
, *ref2
;
493 arg1
= &tev1
->args
[i
];
494 arg2
= &tev2
->args
[i
];
496 ret
= strcmp(arg1
->value
, arg2
->value
);
503 while (ref1
&& ref2
) {
504 ret
= ref2
->offset
- ref1
->offset
;
513 return ref2
? 1 : -1;
520 * Assign a type number to each tevs in a pev.
521 * mapping is an array with same slots as tevs in that pev.
522 * nr_types will be set to number of types.
524 static int map_prologue(struct perf_probe_event
*pev
, int *mapping
,
528 struct probe_trace_event
**ptevs
;
530 size_t array_sz
= sizeof(*ptevs
) * pev
->ntevs
;
532 ptevs
= malloc(array_sz
);
534 pr_debug("No ehough memory: alloc ptevs failed\n");
538 pr_debug("In map_prologue, ntevs=%d\n", pev
->ntevs
);
539 for (i
= 0; i
< pev
->ntevs
; i
++)
540 ptevs
[i
] = &pev
->tevs
[i
];
542 qsort(ptevs
, pev
->ntevs
, sizeof(*ptevs
),
545 for (i
= 0; i
< pev
->ntevs
; i
++) {
548 n
= ptevs
[i
] - pev
->tevs
;
551 pr_debug("mapping[%d]=%d\n", n
, type
);
555 if (compare_tev_args(ptevs
+ i
, ptevs
+ i
- 1) == 0)
560 pr_debug("mapping[%d]=%d\n", n
, mapping
[n
]);
563 *nr_types
= type
+ 1;
568 static int hook_load_preprocessor(struct bpf_program
*prog
)
570 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
571 struct perf_probe_event
*pev
;
572 bool need_prologue
= false;
575 if (IS_ERR(priv
) || !priv
) {
576 pr_debug("Internal error when hook preprocessor\n");
577 return -BPF_LOADER_ERRNO__INTERNAL
;
581 priv
->need_prologue
= false;
586 for (i
= 0; i
< pev
->ntevs
; i
++) {
587 struct probe_trace_event
*tev
= &pev
->tevs
[i
];
589 if (tev
->nargs
> 0) {
590 need_prologue
= true;
596 * Since all tevs don't have argument, we don't need generate
599 if (!need_prologue
) {
600 priv
->need_prologue
= false;
604 priv
->need_prologue
= true;
605 priv
->insns_buf
= malloc(sizeof(struct bpf_insn
) * BPF_MAXINSNS
);
606 if (!priv
->insns_buf
) {
607 pr_debug("No enough memory: alloc insns_buf failed\n");
611 priv
->type_mapping
= malloc(sizeof(int) * pev
->ntevs
);
612 if (!priv
->type_mapping
) {
613 pr_debug("No enough memory: alloc type_mapping failed\n");
616 memset(priv
->type_mapping
, -1,
617 sizeof(int) * pev
->ntevs
);
619 err
= map_prologue(pev
, priv
->type_mapping
, &priv
->nr_types
);
623 err
= bpf_program__set_prep(prog
, priv
->nr_types
,
624 preproc_gen_prologue
);
628 int bpf__probe(struct bpf_object
*obj
)
631 struct bpf_program
*prog
;
632 struct bpf_prog_priv
*priv
;
633 struct perf_probe_event
*pev
;
635 err
= bpf__prepare_probe();
637 pr_debug("bpf__prepare_probe failed\n");
641 bpf_object__for_each_program(prog
, obj
) {
642 err
= config_bpf_program(prog
);
646 priv
= bpf_program__priv(prog
);
647 if (IS_ERR(priv
) || !priv
) {
653 bpf_program__set_tracepoint(prog
);
657 bpf_program__set_kprobe(prog
);
660 err
= convert_perf_probe_events(pev
, 1);
662 pr_debug("bpf_probe: failed to convert perf probe events");
666 err
= apply_perf_probe_events(pev
, 1);
668 pr_debug("bpf_probe: failed to apply perf probe events");
673 * After probing, let's consider prologue, which
674 * adds program fetcher to BPF programs.
676 * hook_load_preprocessorr() hooks pre-processor
677 * to bpf_program, let it generate prologue
678 * dynamically during loading.
680 err
= hook_load_preprocessor(prog
);
685 return err
< 0 ? err
: 0;
688 #define EVENTS_WRITE_BUFSIZE 4096
689 int bpf__unprobe(struct bpf_object
*obj
)
692 struct bpf_program
*prog
;
694 bpf_object__for_each_program(prog
, obj
) {
695 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
698 if (IS_ERR(priv
) || !priv
|| priv
->is_tp
)
701 for (i
= 0; i
< priv
->pev
.ntevs
; i
++) {
702 struct probe_trace_event
*tev
= &priv
->pev
.tevs
[i
];
703 char name_buf
[EVENTS_WRITE_BUFSIZE
];
704 struct strfilter
*delfilter
;
706 snprintf(name_buf
, EVENTS_WRITE_BUFSIZE
,
707 "%s:%s", tev
->group
, tev
->event
);
708 name_buf
[EVENTS_WRITE_BUFSIZE
- 1] = '\0';
710 delfilter
= strfilter__new(name_buf
, NULL
);
712 pr_debug("Failed to create filter for unprobing\n");
717 err
= del_perf_probe_events(delfilter
);
718 strfilter__delete(delfilter
);
720 pr_debug("Failed to delete %s\n", name_buf
);
729 int bpf__load(struct bpf_object
*obj
)
733 err
= bpf_object__load(obj
);
735 pr_debug("bpf: load objects failed\n");
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
, 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
, 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
;
815 struct perf_evsel
*evsel
;
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
))
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("No 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("No 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("No 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 perf_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 perf_evlist
*evlist
)
1061 struct perf_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 perf_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
*,
1119 struct perf_evlist
*);
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 perf_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
;
1220 key_scan_pos
+= strlen(map_opt
);
1224 int bpf__config_obj(struct bpf_object
*obj
,
1225 struct parse_events_term
*term
,
1226 struct perf_evlist
*evlist
,
1229 int key_scan_pos
= 0;
1232 if (!obj
|| !term
|| !term
->config
)
1235 if (!prefixcmp(term
->config
, "map:")) {
1236 key_scan_pos
= sizeof("map:") - 1;
1237 err
= bpf__obj_config_map(obj
, term
, evlist
, &key_scan_pos
);
1240 err
= -BPF_LOADER_ERRNO__OBJCONF_OPT
;
1243 *error_pos
= key_scan_pos
;
1248 typedef int (*map_config_func_t
)(const char *name
, int map_fd
,
1249 const struct bpf_map_def
*pdef
,
1250 struct bpf_map_op
*op
,
1251 void *pkey
, void *arg
);
1254 foreach_key_array_all(map_config_func_t func
,
1255 void *arg
, const char *name
,
1256 int map_fd
, const struct bpf_map_def
*pdef
,
1257 struct bpf_map_op
*op
)
1262 for (i
= 0; i
< pdef
->max_entries
; i
++) {
1263 err
= func(name
, map_fd
, pdef
, op
, &i
, arg
);
1265 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1274 foreach_key_array_ranges(map_config_func_t func
, void *arg
,
1275 const char *name
, int map_fd
,
1276 const struct bpf_map_def
*pdef
,
1277 struct bpf_map_op
*op
)
1282 for (i
= 0; i
< op
->k
.array
.nr_ranges
; i
++) {
1283 unsigned int start
= op
->k
.array
.ranges
[i
].start
;
1284 size_t length
= op
->k
.array
.ranges
[i
].length
;
1286 for (j
= 0; j
< length
; j
++) {
1287 unsigned int idx
= start
+ j
;
1289 err
= func(name
, map_fd
, pdef
, op
, &idx
, arg
);
1291 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1301 bpf_map_config_foreach_key(struct bpf_map
*map
,
1302 map_config_func_t func
,
1306 struct bpf_map_op
*op
;
1307 const struct bpf_map_def
*def
;
1308 const char *name
= bpf_map__name(map
);
1309 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1312 pr_debug("ERROR: failed to get private from map %s\n", name
);
1313 return -BPF_LOADER_ERRNO__INTERNAL
;
1315 if (!priv
|| list_empty(&priv
->ops_list
)) {
1316 pr_debug("INFO: nothing to config for map %s\n", name
);
1320 def
= bpf_map__def(map
);
1322 pr_debug("ERROR: failed to get definition from map %s\n", name
);
1323 return -BPF_LOADER_ERRNO__INTERNAL
;
1325 map_fd
= bpf_map__fd(map
);
1327 pr_debug("ERROR: failed to get fd from map %s\n", name
);
1331 list_for_each_entry(op
, &priv
->ops_list
, list
) {
1332 switch (def
->type
) {
1333 case BPF_MAP_TYPE_ARRAY
:
1334 case BPF_MAP_TYPE_PERF_EVENT_ARRAY
:
1335 switch (op
->key_type
) {
1336 case BPF_MAP_KEY_ALL
:
1337 err
= foreach_key_array_all(func
, arg
, name
,
1340 case BPF_MAP_KEY_RANGES
:
1341 err
= foreach_key_array_ranges(func
, arg
, name
,
1346 pr_debug("ERROR: keytype for map '%s' invalid\n",
1348 return -BPF_LOADER_ERRNO__INTERNAL
;
1354 pr_debug("ERROR: type of '%s' incorrect\n", name
);
1355 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
;
1363 apply_config_value_for_key(int map_fd
, void *pkey
,
1364 size_t val_size
, u64 val
)
1370 u8 _val
= (u8
)(val
);
1371 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1375 u16 _val
= (u16
)(val
);
1376 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1380 u32 _val
= (u32
)(val
);
1381 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1385 err
= bpf_map_update_elem(map_fd
, pkey
, &val
, BPF_ANY
);
1389 pr_debug("ERROR: invalid value size\n");
1390 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE
;
1398 apply_config_evsel_for_key(const char *name
, int map_fd
, void *pkey
,
1399 struct perf_evsel
*evsel
)
1401 struct xyarray
*xy
= evsel
->fd
;
1402 struct perf_event_attr
*attr
;
1403 unsigned int key
, events
;
1404 bool check_pass
= false;
1409 pr_debug("ERROR: evsel not ready for map %s\n", name
);
1410 return -BPF_LOADER_ERRNO__INTERNAL
;
1413 if (xy
->row_size
/ xy
->entry_size
!= 1) {
1414 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1416 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM
;
1419 attr
= &evsel
->attr
;
1420 if (attr
->inherit
) {
1421 pr_debug("ERROR: Can't put inherit event into map %s\n", name
);
1422 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH
;
1425 if (perf_evsel__is_bpf_output(evsel
))
1427 if (attr
->type
== PERF_TYPE_RAW
)
1429 if (attr
->type
== PERF_TYPE_HARDWARE
)
1432 pr_debug("ERROR: Event type is wrong for map %s\n", name
);
1433 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE
;
1436 events
= xy
->entries
/ (xy
->row_size
/ xy
->entry_size
);
1437 key
= *((unsigned int *)pkey
);
1438 if (key
>= events
) {
1439 pr_debug("ERROR: there is no event %d for map %s\n",
1441 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE
;
1443 evt_fd
= xyarray__entry(xy
, key
, 0);
1444 err
= bpf_map_update_elem(map_fd
, pkey
, evt_fd
, BPF_ANY
);
1451 apply_obj_config_map_for_key(const char *name
, int map_fd
,
1452 const struct bpf_map_def
*pdef
,
1453 struct bpf_map_op
*op
,
1454 void *pkey
, void *arg __maybe_unused
)
1458 switch (op
->op_type
) {
1459 case BPF_MAP_OP_SET_VALUE
:
1460 err
= apply_config_value_for_key(map_fd
, pkey
,
1464 case BPF_MAP_OP_SET_EVSEL
:
1465 err
= apply_config_evsel_for_key(name
, map_fd
, pkey
,
1469 pr_debug("ERROR: unknown value type for '%s'\n", name
);
1470 err
= -BPF_LOADER_ERRNO__INTERNAL
;
1476 apply_obj_config_map(struct bpf_map
*map
)
1478 return bpf_map_config_foreach_key(map
,
1479 apply_obj_config_map_for_key
,
1484 apply_obj_config_object(struct bpf_object
*obj
)
1486 struct bpf_map
*map
;
1489 bpf_map__for_each(map
, obj
) {
1490 err
= apply_obj_config_map(map
);
1497 int bpf__apply_obj_config(void)
1499 struct bpf_object
*obj
, *tmp
;
1502 bpf_object__for_each_safe(obj
, tmp
) {
1503 err
= apply_obj_config_object(obj
);
1511 #define bpf__for_each_map(pos, obj, objtmp) \
1512 bpf_object__for_each_safe(obj, objtmp) \
1513 bpf_map__for_each(pos, obj)
1515 #define bpf__for_each_stdout_map(pos, obj, objtmp) \
1516 bpf__for_each_map(pos, obj, objtmp) \
1517 if (bpf_map__name(pos) && \
1518 (strcmp("__bpf_stdout__", \
1519 bpf_map__name(pos)) == 0))
1521 int bpf__setup_stdout(struct perf_evlist
*evlist __maybe_unused
)
1523 struct bpf_map_priv
*tmpl_priv
= NULL
;
1524 struct bpf_object
*obj
, *tmp
;
1525 struct perf_evsel
*evsel
= NULL
;
1526 struct bpf_map
*map
;
1528 bool need_init
= false;
1530 bpf__for_each_stdout_map(map
, obj
, tmp
) {
1531 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1534 return -BPF_LOADER_ERRNO__INTERNAL
;
1537 * No need to check map type: type should have been
1538 * verified by kernel.
1540 if (!need_init
&& !priv
)
1542 if (!tmpl_priv
&& priv
)
1550 err
= parse_events(evlist
, "bpf-output/no-inherit=1,name=__bpf_stdout__/",
1553 pr_debug("ERROR: failed to create bpf-output event\n");
1557 evsel
= perf_evlist__last(evlist
);
1560 bpf__for_each_stdout_map(map
, obj
, tmp
) {
1561 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1564 return -BPF_LOADER_ERRNO__INTERNAL
;
1569 priv
= bpf_map_priv__clone(tmpl_priv
);
1573 err
= bpf_map__set_priv(map
, priv
, bpf_map_priv__clear
);
1575 bpf_map_priv__clear(map
, priv
);
1579 struct bpf_map_op
*op
;
1581 op
= bpf_map__add_newop(map
, NULL
);
1584 op
->op_type
= BPF_MAP_OP_SET_EVSEL
;
1585 op
->v
.evsel
= evsel
;
1592 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1593 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1594 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1596 static const char *bpf_loader_strerror_table
[NR_ERRNO
] = {
1597 [ERRCODE_OFFSET(CONFIG
)] = "Invalid config string",
1598 [ERRCODE_OFFSET(GROUP
)] = "Invalid group name",
1599 [ERRCODE_OFFSET(EVENTNAME
)] = "No event name found in config string",
1600 [ERRCODE_OFFSET(INTERNAL
)] = "BPF loader internal error",
1601 [ERRCODE_OFFSET(COMPILE
)] = "Error when compiling BPF scriptlet",
1602 [ERRCODE_OFFSET(PROGCONF_TERM
)] = "Invalid program config term in config string",
1603 [ERRCODE_OFFSET(PROLOGUE
)] = "Failed to generate prologue",
1604 [ERRCODE_OFFSET(PROLOGUE2BIG
)] = "Prologue too big for program",
1605 [ERRCODE_OFFSET(PROLOGUEOOB
)] = "Offset out of bound for prologue",
1606 [ERRCODE_OFFSET(OBJCONF_OPT
)] = "Invalid object config option",
1607 [ERRCODE_OFFSET(OBJCONF_CONF
)] = "Config value not set (missing '=')",
1608 [ERRCODE_OFFSET(OBJCONF_MAP_OPT
)] = "Invalid object map config option",
1609 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST
)] = "Target map doesn't exist",
1610 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE
)] = "Incorrect value type for map",
1611 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE
)] = "Incorrect map type",
1612 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE
)] = "Incorrect map key size",
1613 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE
)] = "Incorrect map value size",
1614 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT
)] = "Event not found for map setting",
1615 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE
)] = "Invalid map size for event setting",
1616 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM
)] = "Event dimension too large",
1617 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH
)] = "Doesn't support inherit event",
1618 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE
)] = "Wrong event type for map",
1619 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG
)] = "Index too large",
1623 bpf_loader_strerror(int err
, char *buf
, size_t size
)
1625 char sbuf
[STRERR_BUFSIZE
];
1631 err
= err
> 0 ? err
: -err
;
1633 if (err
>= __LIBBPF_ERRNO__START
)
1634 return libbpf_strerror(err
, buf
, size
);
1636 if (err
>= __BPF_LOADER_ERRNO__START
&& err
< __BPF_LOADER_ERRNO__END
) {
1637 msg
= bpf_loader_strerror_table
[ERRNO_OFFSET(err
)];
1638 snprintf(buf
, size
, "%s", msg
);
1639 buf
[size
- 1] = '\0';
1643 if (err
>= __BPF_LOADER_ERRNO__END
)
1644 snprintf(buf
, size
, "Unknown bpf loader error %d", err
);
1646 snprintf(buf
, size
, "%s",
1647 str_error_r(err
, sbuf
, sizeof(sbuf
)));
1649 buf
[size
- 1] = '\0';
1653 #define bpf__strerror_head(err, buf, size) \
1654 char sbuf[STRERR_BUFSIZE], *emsg;\
1659 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1663 scnprintf(buf, size, "%s", emsg);\
1666 #define bpf__strerror_entry(val, fmt...)\
1668 scnprintf(buf, size, fmt);\
1672 #define bpf__strerror_end(buf, size)\
1674 buf[size - 1] = '\0';
1676 int bpf__strerror_prepare_load(const char *filename
, bool source
,
1677 int err
, char *buf
, size_t size
)
1682 n
= snprintf(buf
, size
, "Failed to load %s%s: ",
1683 filename
, source
? " from source" : "");
1685 buf
[size
- 1] = '\0';
1691 ret
= bpf_loader_strerror(err
, buf
, size
);
1692 buf
[size
- 1] = '\0';
1696 int bpf__strerror_probe(struct bpf_object
*obj __maybe_unused
,
1697 int err
, char *buf
, size_t size
)
1699 bpf__strerror_head(err
, buf
, size
);
1700 case BPF_LOADER_ERRNO__PROGCONF_TERM
: {
1701 scnprintf(buf
, size
, "%s (add -v to see detail)", emsg
);
1704 bpf__strerror_entry(EEXIST
, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1705 bpf__strerror_entry(EACCES
, "You need to be root");
1706 bpf__strerror_entry(EPERM
, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1707 bpf__strerror_entry(ENOENT
, "You need to check probing points in BPF file");
1708 bpf__strerror_end(buf
, size
);
1712 int bpf__strerror_load(struct bpf_object
*obj
,
1713 int err
, char *buf
, size_t size
)
1715 bpf__strerror_head(err
, buf
, size
);
1716 case LIBBPF_ERRNO__KVER
: {
1717 unsigned int obj_kver
= bpf_object__kversion(obj
);
1718 unsigned int real_kver
;
1720 if (fetch_kernel_version(&real_kver
, NULL
, 0)) {
1721 scnprintf(buf
, size
, "Unable to fetch kernel version");
1725 if (obj_kver
!= real_kver
) {
1726 scnprintf(buf
, size
,
1727 "'version' ("KVER_FMT
") doesn't match running kernel ("KVER_FMT
")",
1728 KVER_PARAM(obj_kver
),
1729 KVER_PARAM(real_kver
));
1733 scnprintf(buf
, size
, "Failed to load program for unknown reason");
1736 bpf__strerror_end(buf
, size
);
1740 int bpf__strerror_config_obj(struct bpf_object
*obj __maybe_unused
,
1741 struct parse_events_term
*term __maybe_unused
,
1742 struct perf_evlist
*evlist __maybe_unused
,
1743 int *error_pos __maybe_unused
, int err
,
1744 char *buf
, size_t size
)
1746 bpf__strerror_head(err
, buf
, size
);
1747 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
,
1748 "Can't use this config term with this map type");
1749 bpf__strerror_end(buf
, size
);
1753 int bpf__strerror_apply_obj_config(int err
, char *buf
, size_t size
)
1755 bpf__strerror_head(err
, buf
, size
);
1756 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM
,
1757 "Cannot set event to BPF map in multi-thread tracing");
1758 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH
,
1759 "%s (Hint: use -i to turn off inherit)", emsg
);
1760 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE
,
1761 "Can only put raw, hardware and BPF output event into a BPF map");
1762 bpf__strerror_end(buf
, size
);
1766 int bpf__strerror_setup_stdout(struct perf_evlist
*evlist __maybe_unused
,
1767 int err
, char *buf
, size_t size
)
1769 bpf__strerror_head(err
, buf
, size
);
1770 bpf__strerror_end(buf
, size
);