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 config_str
= bpf_program__title(prog
, false);
332 if (IS_ERR(config_str
)) {
333 pr_debug("bpf: unable to get title for program\n");
334 return PTR_ERR(config_str
);
337 priv
= calloc(sizeof(*priv
), 1);
339 pr_debug("bpf: failed to alloc priv\n");
344 pr_debug("bpf: config program '%s'\n", config_str
);
345 err
= parse_prog_config(config_str
, &main_str
, &is_tp
, pev
);
350 char *s
= strchr(main_str
, ':');
353 priv
->sys_name
= strndup(main_str
, s
- main_str
);
354 priv
->evt_name
= strdup(s
+ 1);
358 if (pev
->group
&& strcmp(pev
->group
, PERF_BPF_PROBE_GROUP
)) {
359 pr_debug("bpf: '%s': group for event is set and not '%s'.\n",
360 config_str
, PERF_BPF_PROBE_GROUP
);
361 err
= -BPF_LOADER_ERRNO__GROUP
;
363 } else if (!pev
->group
)
364 pev
->group
= strdup(PERF_BPF_PROBE_GROUP
);
367 pr_debug("bpf: strdup failed\n");
373 pr_debug("bpf: '%s': event name is missing. Section name should be 'key=value'\n",
375 err
= -BPF_LOADER_ERRNO__EVENTNAME
;
378 pr_debug("bpf: config '%s' is ok\n", config_str
);
381 err
= bpf_program__set_priv(prog
, priv
, clear_prog_priv
);
383 pr_debug("Failed to set priv for program '%s'\n", config_str
);
391 clear_perf_probe_event(pev
);
396 static int bpf__prepare_probe(void)
399 static bool initialized
= false;
402 * Make err static, so if init failed the first, bpf__prepare_probe()
403 * fails each time without calling init_probe_symbol_maps multiple
410 err
= init_probe_symbol_maps(false);
412 pr_debug("Failed to init_probe_symbol_maps\n");
413 probe_conf
.max_probes
= MAX_PROBES
;
418 preproc_gen_prologue(struct bpf_program
*prog
, int n
,
419 struct bpf_insn
*orig_insns
, int orig_insns_cnt
,
420 struct bpf_prog_prep_result
*res
)
422 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
423 struct probe_trace_event
*tev
;
424 struct perf_probe_event
*pev
;
425 struct bpf_insn
*buf
;
426 size_t prologue_cnt
= 0;
429 if (IS_ERR(priv
) || !priv
|| priv
->is_tp
)
434 if (n
< 0 || n
>= priv
->nr_types
)
437 /* Find a tev belongs to that type */
438 for (i
= 0; i
< pev
->ntevs
; i
++) {
439 if (priv
->type_mapping
[i
] == n
)
443 if (i
>= pev
->ntevs
) {
444 pr_debug("Internal error: prologue type %d not found\n", n
);
445 return -BPF_LOADER_ERRNO__PROLOGUE
;
450 buf
= priv
->insns_buf
;
451 err
= bpf__gen_prologue(tev
->args
, tev
->nargs
,
453 BPF_MAXINSNS
- orig_insns_cnt
);
457 title
= bpf_program__title(prog
, false);
461 pr_debug("Failed to generate prologue for program %s\n",
466 memcpy(&buf
[prologue_cnt
], orig_insns
,
467 sizeof(struct bpf_insn
) * orig_insns_cnt
);
469 res
->new_insn_ptr
= buf
;
470 res
->new_insn_cnt
= prologue_cnt
+ orig_insns_cnt
;
475 pr_debug("Internal error in preproc_gen_prologue\n");
476 return -BPF_LOADER_ERRNO__PROLOGUE
;
480 * compare_tev_args is reflexive, transitive and antisymmetric.
481 * I can proof it but this margin is too narrow to contain.
483 static int compare_tev_args(const void *ptev1
, const void *ptev2
)
486 const struct probe_trace_event
*tev1
=
487 *(const struct probe_trace_event
**)ptev1
;
488 const struct probe_trace_event
*tev2
=
489 *(const struct probe_trace_event
**)ptev2
;
491 ret
= tev2
->nargs
- tev1
->nargs
;
495 for (i
= 0; i
< tev1
->nargs
; i
++) {
496 struct probe_trace_arg
*arg1
, *arg2
;
497 struct probe_trace_arg_ref
*ref1
, *ref2
;
499 arg1
= &tev1
->args
[i
];
500 arg2
= &tev2
->args
[i
];
502 ret
= strcmp(arg1
->value
, arg2
->value
);
509 while (ref1
&& ref2
) {
510 ret
= ref2
->offset
- ref1
->offset
;
519 return ref2
? 1 : -1;
526 * Assign a type number to each tevs in a pev.
527 * mapping is an array with same slots as tevs in that pev.
528 * nr_types will be set to number of types.
530 static int map_prologue(struct perf_probe_event
*pev
, int *mapping
,
534 struct probe_trace_event
**ptevs
;
536 size_t array_sz
= sizeof(*ptevs
) * pev
->ntevs
;
538 ptevs
= malloc(array_sz
);
540 pr_debug("Not enough memory: alloc ptevs failed\n");
544 pr_debug("In map_prologue, ntevs=%d\n", pev
->ntevs
);
545 for (i
= 0; i
< pev
->ntevs
; i
++)
546 ptevs
[i
] = &pev
->tevs
[i
];
548 qsort(ptevs
, pev
->ntevs
, sizeof(*ptevs
),
551 for (i
= 0; i
< pev
->ntevs
; i
++) {
554 n
= ptevs
[i
] - pev
->tevs
;
557 pr_debug("mapping[%d]=%d\n", n
, type
);
561 if (compare_tev_args(ptevs
+ i
, ptevs
+ i
- 1) == 0)
566 pr_debug("mapping[%d]=%d\n", n
, mapping
[n
]);
569 *nr_types
= type
+ 1;
574 static int hook_load_preprocessor(struct bpf_program
*prog
)
576 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
577 struct perf_probe_event
*pev
;
578 bool need_prologue
= false;
581 if (IS_ERR(priv
) || !priv
) {
582 pr_debug("Internal error when hook preprocessor\n");
583 return -BPF_LOADER_ERRNO__INTERNAL
;
587 priv
->need_prologue
= false;
592 for (i
= 0; i
< pev
->ntevs
; i
++) {
593 struct probe_trace_event
*tev
= &pev
->tevs
[i
];
595 if (tev
->nargs
> 0) {
596 need_prologue
= true;
602 * Since all tevs don't have argument, we don't need generate
605 if (!need_prologue
) {
606 priv
->need_prologue
= false;
610 priv
->need_prologue
= true;
611 priv
->insns_buf
= malloc(sizeof(struct bpf_insn
) * BPF_MAXINSNS
);
612 if (!priv
->insns_buf
) {
613 pr_debug("Not enough memory: alloc insns_buf failed\n");
617 priv
->type_mapping
= malloc(sizeof(int) * pev
->ntevs
);
618 if (!priv
->type_mapping
) {
619 pr_debug("Not enough memory: alloc type_mapping failed\n");
622 memset(priv
->type_mapping
, -1,
623 sizeof(int) * pev
->ntevs
);
625 err
= map_prologue(pev
, priv
->type_mapping
, &priv
->nr_types
);
629 err
= bpf_program__set_prep(prog
, priv
->nr_types
,
630 preproc_gen_prologue
);
634 int bpf__probe(struct bpf_object
*obj
)
637 struct bpf_program
*prog
;
638 struct bpf_prog_priv
*priv
;
639 struct perf_probe_event
*pev
;
641 err
= bpf__prepare_probe();
643 pr_debug("bpf__prepare_probe failed\n");
647 bpf_object__for_each_program(prog
, obj
) {
648 err
= config_bpf_program(prog
);
652 priv
= bpf_program__priv(prog
);
653 if (IS_ERR(priv
) || !priv
) {
659 bpf_program__set_tracepoint(prog
);
663 bpf_program__set_kprobe(prog
);
666 err
= convert_perf_probe_events(pev
, 1);
668 pr_debug("bpf_probe: failed to convert perf probe events\n");
672 err
= apply_perf_probe_events(pev
, 1);
674 pr_debug("bpf_probe: failed to apply perf probe events\n");
679 * After probing, let's consider prologue, which
680 * adds program fetcher to BPF programs.
682 * hook_load_preprocessorr() hooks pre-processor
683 * to bpf_program, let it generate prologue
684 * dynamically during loading.
686 err
= hook_load_preprocessor(prog
);
691 return err
< 0 ? err
: 0;
694 #define EVENTS_WRITE_BUFSIZE 4096
695 int bpf__unprobe(struct bpf_object
*obj
)
698 struct bpf_program
*prog
;
700 bpf_object__for_each_program(prog
, obj
) {
701 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
704 if (IS_ERR(priv
) || !priv
|| priv
->is_tp
)
707 for (i
= 0; i
< priv
->pev
.ntevs
; i
++) {
708 struct probe_trace_event
*tev
= &priv
->pev
.tevs
[i
];
709 char name_buf
[EVENTS_WRITE_BUFSIZE
];
710 struct strfilter
*delfilter
;
712 snprintf(name_buf
, EVENTS_WRITE_BUFSIZE
,
713 "%s:%s", tev
->group
, tev
->event
);
714 name_buf
[EVENTS_WRITE_BUFSIZE
- 1] = '\0';
716 delfilter
= strfilter__new(name_buf
, NULL
);
718 pr_debug("Failed to create filter for unprobing\n");
723 err
= del_perf_probe_events(delfilter
);
724 strfilter__delete(delfilter
);
726 pr_debug("Failed to delete %s\n", name_buf
);
735 int bpf__load(struct bpf_object
*obj
)
739 err
= bpf_object__load(obj
);
742 libbpf_strerror(err
, bf
, sizeof(bf
));
743 pr_debug("bpf: load objects failed: err=%d: (%s)\n", err
, bf
);
749 int bpf__foreach_event(struct bpf_object
*obj
,
750 bpf_prog_iter_callback_t func
,
753 struct bpf_program
*prog
;
756 bpf_object__for_each_program(prog
, obj
) {
757 struct bpf_prog_priv
*priv
= bpf_program__priv(prog
);
758 struct probe_trace_event
*tev
;
759 struct perf_probe_event
*pev
;
762 if (IS_ERR(priv
) || !priv
) {
763 pr_debug("bpf: failed to get private field\n");
764 return -BPF_LOADER_ERRNO__INTERNAL
;
768 fd
= bpf_program__fd(prog
);
769 err
= (*func
)(priv
->sys_name
, priv
->evt_name
, fd
, obj
, arg
);
771 pr_debug("bpf: tracepoint call back failed, stop iterate\n");
778 for (i
= 0; i
< pev
->ntevs
; i
++) {
781 if (priv
->need_prologue
) {
782 int type
= priv
->type_mapping
[i
];
784 fd
= bpf_program__nth_fd(prog
, type
);
786 fd
= bpf_program__fd(prog
);
790 pr_debug("bpf: failed to get file descriptor\n");
794 err
= (*func
)(tev
->group
, tev
->event
, fd
, obj
, arg
);
796 pr_debug("bpf: call back failed, stop iterate\n");
804 enum bpf_map_op_type
{
805 BPF_MAP_OP_SET_VALUE
,
806 BPF_MAP_OP_SET_EVSEL
,
809 enum bpf_map_key_type
{
815 struct list_head list
;
816 enum bpf_map_op_type op_type
;
817 enum bpf_map_key_type key_type
;
819 struct parse_events_array array
;
827 struct bpf_map_priv
{
828 struct list_head ops_list
;
832 bpf_map_op__delete(struct bpf_map_op
*op
)
834 if (!list_empty(&op
->list
))
835 list_del_init(&op
->list
);
836 if (op
->key_type
== BPF_MAP_KEY_RANGES
)
837 parse_events__clear_array(&op
->k
.array
);
842 bpf_map_priv__purge(struct bpf_map_priv
*priv
)
844 struct bpf_map_op
*pos
, *n
;
846 list_for_each_entry_safe(pos
, n
, &priv
->ops_list
, list
) {
847 list_del_init(&pos
->list
);
848 bpf_map_op__delete(pos
);
853 bpf_map_priv__clear(struct bpf_map
*map __maybe_unused
,
856 struct bpf_map_priv
*priv
= _priv
;
858 bpf_map_priv__purge(priv
);
863 bpf_map_op_setkey(struct bpf_map_op
*op
, struct parse_events_term
*term
)
865 op
->key_type
= BPF_MAP_KEY_ALL
;
869 if (term
->array
.nr_ranges
) {
870 size_t memsz
= term
->array
.nr_ranges
*
871 sizeof(op
->k
.array
.ranges
[0]);
873 op
->k
.array
.ranges
= memdup(term
->array
.ranges
, memsz
);
874 if (!op
->k
.array
.ranges
) {
875 pr_debug("Not enough memory to alloc indices for map\n");
878 op
->key_type
= BPF_MAP_KEY_RANGES
;
879 op
->k
.array
.nr_ranges
= term
->array
.nr_ranges
;
884 static struct bpf_map_op
*
885 bpf_map_op__new(struct parse_events_term
*term
)
887 struct bpf_map_op
*op
;
890 op
= zalloc(sizeof(*op
));
892 pr_debug("Failed to alloc bpf_map_op\n");
893 return ERR_PTR(-ENOMEM
);
895 INIT_LIST_HEAD(&op
->list
);
897 err
= bpf_map_op_setkey(op
, term
);
905 static struct bpf_map_op
*
906 bpf_map_op__clone(struct bpf_map_op
*op
)
908 struct bpf_map_op
*newop
;
910 newop
= memdup(op
, sizeof(*op
));
912 pr_debug("Failed to alloc bpf_map_op\n");
916 INIT_LIST_HEAD(&newop
->list
);
917 if (op
->key_type
== BPF_MAP_KEY_RANGES
) {
918 size_t memsz
= op
->k
.array
.nr_ranges
*
919 sizeof(op
->k
.array
.ranges
[0]);
921 newop
->k
.array
.ranges
= memdup(op
->k
.array
.ranges
, memsz
);
922 if (!newop
->k
.array
.ranges
) {
923 pr_debug("Failed to alloc indices for map\n");
932 static struct bpf_map_priv
*
933 bpf_map_priv__clone(struct bpf_map_priv
*priv
)
935 struct bpf_map_priv
*newpriv
;
936 struct bpf_map_op
*pos
, *newop
;
938 newpriv
= zalloc(sizeof(*newpriv
));
940 pr_debug("Not enough memory to alloc map private\n");
943 INIT_LIST_HEAD(&newpriv
->ops_list
);
945 list_for_each_entry(pos
, &priv
->ops_list
, list
) {
946 newop
= bpf_map_op__clone(pos
);
948 bpf_map_priv__purge(newpriv
);
951 list_add_tail(&newop
->list
, &newpriv
->ops_list
);
958 bpf_map__add_op(struct bpf_map
*map
, struct bpf_map_op
*op
)
960 const char *map_name
= bpf_map__name(map
);
961 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
964 pr_debug("Failed to get private from map %s\n", map_name
);
965 return PTR_ERR(priv
);
969 priv
= zalloc(sizeof(*priv
));
971 pr_debug("Not enough memory to alloc map private\n");
974 INIT_LIST_HEAD(&priv
->ops_list
);
976 if (bpf_map__set_priv(map
, priv
, bpf_map_priv__clear
)) {
978 return -BPF_LOADER_ERRNO__INTERNAL
;
982 list_add_tail(&op
->list
, &priv
->ops_list
);
986 static struct bpf_map_op
*
987 bpf_map__add_newop(struct bpf_map
*map
, struct parse_events_term
*term
)
989 struct bpf_map_op
*op
;
992 op
= bpf_map_op__new(term
);
996 err
= bpf_map__add_op(map
, op
);
998 bpf_map_op__delete(op
);
1005 __bpf_map__config_value(struct bpf_map
*map
,
1006 struct parse_events_term
*term
)
1008 struct bpf_map_op
*op
;
1009 const char *map_name
= bpf_map__name(map
);
1010 const struct bpf_map_def
*def
= bpf_map__def(map
);
1013 pr_debug("Unable to get map definition from '%s'\n",
1015 return -BPF_LOADER_ERRNO__INTERNAL
;
1018 if (def
->type
!= BPF_MAP_TYPE_ARRAY
) {
1019 pr_debug("Map %s type is not BPF_MAP_TYPE_ARRAY\n",
1021 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
;
1023 if (def
->key_size
< sizeof(unsigned int)) {
1024 pr_debug("Map %s has incorrect key size\n", map_name
);
1025 return -BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE
;
1027 switch (def
->value_size
) {
1034 pr_debug("Map %s has incorrect value size\n", map_name
);
1035 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE
;
1038 op
= bpf_map__add_newop(map
, term
);
1041 op
->op_type
= BPF_MAP_OP_SET_VALUE
;
1042 op
->v
.value
= term
->val
.num
;
1047 bpf_map__config_value(struct bpf_map
*map
,
1048 struct parse_events_term
*term
,
1049 struct evlist
*evlist __maybe_unused
)
1051 if (!term
->err_val
) {
1052 pr_debug("Config value not set\n");
1053 return -BPF_LOADER_ERRNO__OBJCONF_CONF
;
1056 if (term
->type_val
!= PARSE_EVENTS__TERM_TYPE_NUM
) {
1057 pr_debug("ERROR: wrong value type for 'value'\n");
1058 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE
;
1061 return __bpf_map__config_value(map
, term
);
1065 __bpf_map__config_event(struct bpf_map
*map
,
1066 struct parse_events_term
*term
,
1067 struct evlist
*evlist
)
1069 struct evsel
*evsel
;
1070 const struct bpf_map_def
*def
;
1071 struct bpf_map_op
*op
;
1072 const char *map_name
= bpf_map__name(map
);
1074 evsel
= perf_evlist__find_evsel_by_str(evlist
, term
->val
.str
);
1076 pr_debug("Event (for '%s') '%s' doesn't exist\n",
1077 map_name
, term
->val
.str
);
1078 return -BPF_LOADER_ERRNO__OBJCONF_MAP_NOEVT
;
1081 def
= bpf_map__def(map
);
1083 pr_debug("Unable to get map definition from '%s'\n",
1085 return PTR_ERR(def
);
1089 * No need to check key_size and value_size:
1090 * kernel has already checked them.
1092 if (def
->type
!= BPF_MAP_TYPE_PERF_EVENT_ARRAY
) {
1093 pr_debug("Map %s type is not BPF_MAP_TYPE_PERF_EVENT_ARRAY\n",
1095 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
;
1098 op
= bpf_map__add_newop(map
, term
);
1101 op
->op_type
= BPF_MAP_OP_SET_EVSEL
;
1102 op
->v
.evsel
= evsel
;
1107 bpf_map__config_event(struct bpf_map
*map
,
1108 struct parse_events_term
*term
,
1109 struct evlist
*evlist
)
1111 if (!term
->err_val
) {
1112 pr_debug("Config value not set\n");
1113 return -BPF_LOADER_ERRNO__OBJCONF_CONF
;
1116 if (term
->type_val
!= PARSE_EVENTS__TERM_TYPE_STR
) {
1117 pr_debug("ERROR: wrong value type for 'event'\n");
1118 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE
;
1121 return __bpf_map__config_event(map
, term
, evlist
);
1124 struct bpf_obj_config__map_func
{
1125 const char *config_opt
;
1126 int (*config_func
)(struct bpf_map
*, struct parse_events_term
*,
1130 struct bpf_obj_config__map_func bpf_obj_config__map_funcs
[] = {
1131 {"value", bpf_map__config_value
},
1132 {"event", bpf_map__config_event
},
1136 config_map_indices_range_check(struct parse_events_term
*term
,
1137 struct bpf_map
*map
,
1138 const char *map_name
)
1140 struct parse_events_array
*array
= &term
->array
;
1141 const struct bpf_map_def
*def
;
1144 if (!array
->nr_ranges
)
1146 if (!array
->ranges
) {
1147 pr_debug("ERROR: map %s: array->nr_ranges is %d but range array is NULL\n",
1148 map_name
, (int)array
->nr_ranges
);
1149 return -BPF_LOADER_ERRNO__INTERNAL
;
1152 def
= bpf_map__def(map
);
1154 pr_debug("ERROR: Unable to get map definition from '%s'\n",
1156 return -BPF_LOADER_ERRNO__INTERNAL
;
1159 for (i
= 0; i
< array
->nr_ranges
; i
++) {
1160 unsigned int start
= array
->ranges
[i
].start
;
1161 size_t length
= array
->ranges
[i
].length
;
1162 unsigned int idx
= start
+ length
- 1;
1164 if (idx
>= def
->max_entries
) {
1165 pr_debug("ERROR: index %d too large\n", idx
);
1166 return -BPF_LOADER_ERRNO__OBJCONF_MAP_IDX2BIG
;
1173 bpf__obj_config_map(struct bpf_object
*obj
,
1174 struct parse_events_term
*term
,
1175 struct evlist
*evlist
,
1178 /* key is "map:<mapname>.<config opt>" */
1179 char *map_name
= strdup(term
->config
+ sizeof("map:") - 1);
1180 struct bpf_map
*map
;
1181 int err
= -BPF_LOADER_ERRNO__OBJCONF_OPT
;
1188 map_opt
= strchr(map_name
, '.');
1190 pr_debug("ERROR: Invalid map config: %s\n", map_name
);
1195 if (*map_opt
== '\0') {
1196 pr_debug("ERROR: Invalid map option: %s\n", term
->config
);
1200 map
= bpf_object__find_map_by_name(obj
, map_name
);
1202 pr_debug("ERROR: Map %s doesn't exist\n", map_name
);
1203 err
= -BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST
;
1207 *key_scan_pos
+= strlen(map_opt
);
1208 err
= config_map_indices_range_check(term
, map
, map_name
);
1211 *key_scan_pos
-= strlen(map_opt
);
1213 for (i
= 0; i
< ARRAY_SIZE(bpf_obj_config__map_funcs
); i
++) {
1214 struct bpf_obj_config__map_func
*func
=
1215 &bpf_obj_config__map_funcs
[i
];
1217 if (strcmp(map_opt
, func
->config_opt
) == 0) {
1218 err
= func
->config_func(map
, term
, evlist
);
1223 pr_debug("ERROR: Invalid map config option '%s'\n", map_opt
);
1224 err
= -BPF_LOADER_ERRNO__OBJCONF_MAP_OPT
;
1228 *key_scan_pos
+= strlen(map_opt
);
1232 int bpf__config_obj(struct bpf_object
*obj
,
1233 struct parse_events_term
*term
,
1234 struct evlist
*evlist
,
1237 int key_scan_pos
= 0;
1240 if (!obj
|| !term
|| !term
->config
)
1243 if (strstarts(term
->config
, "map:")) {
1244 key_scan_pos
= sizeof("map:") - 1;
1245 err
= bpf__obj_config_map(obj
, term
, evlist
, &key_scan_pos
);
1248 err
= -BPF_LOADER_ERRNO__OBJCONF_OPT
;
1251 *error_pos
= key_scan_pos
;
1256 typedef int (*map_config_func_t
)(const char *name
, int map_fd
,
1257 const struct bpf_map_def
*pdef
,
1258 struct bpf_map_op
*op
,
1259 void *pkey
, void *arg
);
1262 foreach_key_array_all(map_config_func_t func
,
1263 void *arg
, const char *name
,
1264 int map_fd
, const struct bpf_map_def
*pdef
,
1265 struct bpf_map_op
*op
)
1270 for (i
= 0; i
< pdef
->max_entries
; i
++) {
1271 err
= func(name
, map_fd
, pdef
, op
, &i
, arg
);
1273 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1282 foreach_key_array_ranges(map_config_func_t func
, void *arg
,
1283 const char *name
, int map_fd
,
1284 const struct bpf_map_def
*pdef
,
1285 struct bpf_map_op
*op
)
1290 for (i
= 0; i
< op
->k
.array
.nr_ranges
; i
++) {
1291 unsigned int start
= op
->k
.array
.ranges
[i
].start
;
1292 size_t length
= op
->k
.array
.ranges
[i
].length
;
1294 for (j
= 0; j
< length
; j
++) {
1295 unsigned int idx
= start
+ j
;
1297 err
= func(name
, map_fd
, pdef
, op
, &idx
, arg
);
1299 pr_debug("ERROR: failed to insert value to %s[%u]\n",
1309 bpf_map_config_foreach_key(struct bpf_map
*map
,
1310 map_config_func_t func
,
1314 struct bpf_map_op
*op
;
1315 const struct bpf_map_def
*def
;
1316 const char *name
= bpf_map__name(map
);
1317 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1320 pr_debug("ERROR: failed to get private from map %s\n", name
);
1321 return -BPF_LOADER_ERRNO__INTERNAL
;
1323 if (!priv
|| list_empty(&priv
->ops_list
)) {
1324 pr_debug("INFO: nothing to config for map %s\n", name
);
1328 def
= bpf_map__def(map
);
1330 pr_debug("ERROR: failed to get definition from map %s\n", name
);
1331 return -BPF_LOADER_ERRNO__INTERNAL
;
1333 map_fd
= bpf_map__fd(map
);
1335 pr_debug("ERROR: failed to get fd from map %s\n", name
);
1339 list_for_each_entry(op
, &priv
->ops_list
, list
) {
1340 switch (def
->type
) {
1341 case BPF_MAP_TYPE_ARRAY
:
1342 case BPF_MAP_TYPE_PERF_EVENT_ARRAY
:
1343 switch (op
->key_type
) {
1344 case BPF_MAP_KEY_ALL
:
1345 err
= foreach_key_array_all(func
, arg
, name
,
1348 case BPF_MAP_KEY_RANGES
:
1349 err
= foreach_key_array_ranges(func
, arg
, name
,
1354 pr_debug("ERROR: keytype for map '%s' invalid\n",
1356 return -BPF_LOADER_ERRNO__INTERNAL
;
1362 pr_debug("ERROR: type of '%s' incorrect\n", name
);
1363 return -BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
;
1371 apply_config_value_for_key(int map_fd
, void *pkey
,
1372 size_t val_size
, u64 val
)
1378 u8 _val
= (u8
)(val
);
1379 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1383 u16 _val
= (u16
)(val
);
1384 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1388 u32 _val
= (u32
)(val
);
1389 err
= bpf_map_update_elem(map_fd
, pkey
, &_val
, BPF_ANY
);
1393 err
= bpf_map_update_elem(map_fd
, pkey
, &val
, BPF_ANY
);
1397 pr_debug("ERROR: invalid value size\n");
1398 return -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE
;
1406 apply_config_evsel_for_key(const char *name
, int map_fd
, void *pkey
,
1407 struct evsel
*evsel
)
1409 struct xyarray
*xy
= evsel
->core
.fd
;
1410 struct perf_event_attr
*attr
;
1411 unsigned int key
, events
;
1412 bool check_pass
= false;
1417 pr_debug("ERROR: evsel not ready for map %s\n", name
);
1418 return -BPF_LOADER_ERRNO__INTERNAL
;
1421 if (xy
->row_size
/ xy
->entry_size
!= 1) {
1422 pr_debug("ERROR: Dimension of target event is incorrect for map %s\n",
1424 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM
;
1427 attr
= &evsel
->core
.attr
;
1428 if (attr
->inherit
) {
1429 pr_debug("ERROR: Can't put inherit event into map %s\n", name
);
1430 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH
;
1433 if (evsel__is_bpf_output(evsel
))
1435 if (attr
->type
== PERF_TYPE_RAW
)
1437 if (attr
->type
== PERF_TYPE_HARDWARE
)
1440 pr_debug("ERROR: Event type is wrong for map %s\n", name
);
1441 return -BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE
;
1444 events
= xy
->entries
/ (xy
->row_size
/ xy
->entry_size
);
1445 key
= *((unsigned int *)pkey
);
1446 if (key
>= events
) {
1447 pr_debug("ERROR: there is no event %d for map %s\n",
1449 return -BPF_LOADER_ERRNO__OBJCONF_MAP_MAPSIZE
;
1451 evt_fd
= xyarray__entry(xy
, key
, 0);
1452 err
= bpf_map_update_elem(map_fd
, pkey
, evt_fd
, BPF_ANY
);
1459 apply_obj_config_map_for_key(const char *name
, int map_fd
,
1460 const struct bpf_map_def
*pdef
,
1461 struct bpf_map_op
*op
,
1462 void *pkey
, void *arg __maybe_unused
)
1466 switch (op
->op_type
) {
1467 case BPF_MAP_OP_SET_VALUE
:
1468 err
= apply_config_value_for_key(map_fd
, pkey
,
1472 case BPF_MAP_OP_SET_EVSEL
:
1473 err
= apply_config_evsel_for_key(name
, map_fd
, pkey
,
1477 pr_debug("ERROR: unknown value type for '%s'\n", name
);
1478 err
= -BPF_LOADER_ERRNO__INTERNAL
;
1484 apply_obj_config_map(struct bpf_map
*map
)
1486 return bpf_map_config_foreach_key(map
,
1487 apply_obj_config_map_for_key
,
1492 apply_obj_config_object(struct bpf_object
*obj
)
1494 struct bpf_map
*map
;
1497 bpf_object__for_each_map(map
, obj
) {
1498 err
= apply_obj_config_map(map
);
1505 int bpf__apply_obj_config(void)
1507 struct bpf_object
*obj
, *tmp
;
1510 bpf_object__for_each_safe(obj
, tmp
) {
1511 err
= apply_obj_config_object(obj
);
1519 #define bpf__for_each_map(pos, obj, objtmp) \
1520 bpf_object__for_each_safe(obj, objtmp) \
1521 bpf_object__for_each_map(pos, obj)
1523 #define bpf__for_each_map_named(pos, obj, objtmp, name) \
1524 bpf__for_each_map(pos, obj, objtmp) \
1525 if (bpf_map__name(pos) && \
1527 bpf_map__name(pos)) == 0))
1529 struct evsel
*bpf__setup_output_event(struct evlist
*evlist
, const char *name
)
1531 struct bpf_map_priv
*tmpl_priv
= NULL
;
1532 struct bpf_object
*obj
, *tmp
;
1533 struct evsel
*evsel
= NULL
;
1534 struct bpf_map
*map
;
1536 bool need_init
= false;
1538 bpf__for_each_map_named(map
, obj
, tmp
, name
) {
1539 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1542 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL
);
1545 * No need to check map type: type should have been
1546 * verified by kernel.
1548 if (!need_init
&& !priv
)
1550 if (!tmpl_priv
&& priv
)
1558 char *event_definition
= NULL
;
1560 if (asprintf(&event_definition
, "bpf-output/no-inherit=1,name=%s/", name
) < 0)
1561 return ERR_PTR(-ENOMEM
);
1563 err
= parse_events(evlist
, event_definition
, NULL
);
1564 free(event_definition
);
1567 pr_debug("ERROR: failed to create the \"%s\" bpf-output event\n", name
);
1568 return ERR_PTR(-err
);
1571 evsel
= evlist__last(evlist
);
1574 bpf__for_each_map_named(map
, obj
, tmp
, name
) {
1575 struct bpf_map_priv
*priv
= bpf_map__priv(map
);
1578 return ERR_PTR(-BPF_LOADER_ERRNO__INTERNAL
);
1583 priv
= bpf_map_priv__clone(tmpl_priv
);
1585 return ERR_PTR(-ENOMEM
);
1587 err
= bpf_map__set_priv(map
, priv
, bpf_map_priv__clear
);
1589 bpf_map_priv__clear(map
, priv
);
1590 return ERR_PTR(err
);
1593 struct bpf_map_op
*op
;
1595 op
= bpf_map__add_newop(map
, NULL
);
1597 return ERR_CAST(op
);
1598 op
->op_type
= BPF_MAP_OP_SET_EVSEL
;
1599 op
->v
.evsel
= evsel
;
1606 int bpf__setup_stdout(struct evlist
*evlist
)
1608 struct evsel
*evsel
= bpf__setup_output_event(evlist
, "__bpf_stdout__");
1609 return PTR_ERR_OR_ZERO(evsel
);
1612 #define ERRNO_OFFSET(e) ((e) - __BPF_LOADER_ERRNO__START)
1613 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(BPF_LOADER_ERRNO__##c)
1614 #define NR_ERRNO (__BPF_LOADER_ERRNO__END - __BPF_LOADER_ERRNO__START)
1616 static const char *bpf_loader_strerror_table
[NR_ERRNO
] = {
1617 [ERRCODE_OFFSET(CONFIG
)] = "Invalid config string",
1618 [ERRCODE_OFFSET(GROUP
)] = "Invalid group name",
1619 [ERRCODE_OFFSET(EVENTNAME
)] = "No event name found in config string",
1620 [ERRCODE_OFFSET(INTERNAL
)] = "BPF loader internal error",
1621 [ERRCODE_OFFSET(COMPILE
)] = "Error when compiling BPF scriptlet",
1622 [ERRCODE_OFFSET(PROGCONF_TERM
)] = "Invalid program config term in config string",
1623 [ERRCODE_OFFSET(PROLOGUE
)] = "Failed to generate prologue",
1624 [ERRCODE_OFFSET(PROLOGUE2BIG
)] = "Prologue too big for program",
1625 [ERRCODE_OFFSET(PROLOGUEOOB
)] = "Offset out of bound for prologue",
1626 [ERRCODE_OFFSET(OBJCONF_OPT
)] = "Invalid object config option",
1627 [ERRCODE_OFFSET(OBJCONF_CONF
)] = "Config value not set (missing '=')",
1628 [ERRCODE_OFFSET(OBJCONF_MAP_OPT
)] = "Invalid object map config option",
1629 [ERRCODE_OFFSET(OBJCONF_MAP_NOTEXIST
)] = "Target map doesn't exist",
1630 [ERRCODE_OFFSET(OBJCONF_MAP_VALUE
)] = "Incorrect value type for map",
1631 [ERRCODE_OFFSET(OBJCONF_MAP_TYPE
)] = "Incorrect map type",
1632 [ERRCODE_OFFSET(OBJCONF_MAP_KEYSIZE
)] = "Incorrect map key size",
1633 [ERRCODE_OFFSET(OBJCONF_MAP_VALUESIZE
)] = "Incorrect map value size",
1634 [ERRCODE_OFFSET(OBJCONF_MAP_NOEVT
)] = "Event not found for map setting",
1635 [ERRCODE_OFFSET(OBJCONF_MAP_MAPSIZE
)] = "Invalid map size for event setting",
1636 [ERRCODE_OFFSET(OBJCONF_MAP_EVTDIM
)] = "Event dimension too large",
1637 [ERRCODE_OFFSET(OBJCONF_MAP_EVTINH
)] = "Doesn't support inherit event",
1638 [ERRCODE_OFFSET(OBJCONF_MAP_EVTTYPE
)] = "Wrong event type for map",
1639 [ERRCODE_OFFSET(OBJCONF_MAP_IDX2BIG
)] = "Index too large",
1643 bpf_loader_strerror(int err
, char *buf
, size_t size
)
1645 char sbuf
[STRERR_BUFSIZE
];
1651 err
= err
> 0 ? err
: -err
;
1653 if (err
>= __LIBBPF_ERRNO__START
)
1654 return libbpf_strerror(err
, buf
, size
);
1656 if (err
>= __BPF_LOADER_ERRNO__START
&& err
< __BPF_LOADER_ERRNO__END
) {
1657 msg
= bpf_loader_strerror_table
[ERRNO_OFFSET(err
)];
1658 snprintf(buf
, size
, "%s", msg
);
1659 buf
[size
- 1] = '\0';
1663 if (err
>= __BPF_LOADER_ERRNO__END
)
1664 snprintf(buf
, size
, "Unknown bpf loader error %d", err
);
1666 snprintf(buf
, size
, "%s",
1667 str_error_r(err
, sbuf
, sizeof(sbuf
)));
1669 buf
[size
- 1] = '\0';
1673 #define bpf__strerror_head(err, buf, size) \
1674 char sbuf[STRERR_BUFSIZE], *emsg;\
1679 bpf_loader_strerror(err, sbuf, sizeof(sbuf));\
1683 scnprintf(buf, size, "%s", emsg);\
1686 #define bpf__strerror_entry(val, fmt...)\
1688 scnprintf(buf, size, fmt);\
1692 #define bpf__strerror_end(buf, size)\
1694 buf[size - 1] = '\0';
1696 int bpf__strerror_prepare_load(const char *filename
, bool source
,
1697 int err
, char *buf
, size_t size
)
1702 n
= snprintf(buf
, size
, "Failed to load %s%s: ",
1703 filename
, source
? " from source" : "");
1705 buf
[size
- 1] = '\0';
1711 ret
= bpf_loader_strerror(err
, buf
, size
);
1712 buf
[size
- 1] = '\0';
1716 int bpf__strerror_probe(struct bpf_object
*obj __maybe_unused
,
1717 int err
, char *buf
, size_t size
)
1719 bpf__strerror_head(err
, buf
, size
);
1720 case BPF_LOADER_ERRNO__PROGCONF_TERM
: {
1721 scnprintf(buf
, size
, "%s (add -v to see detail)", emsg
);
1724 bpf__strerror_entry(EEXIST
, "Probe point exist. Try 'perf probe -d \"*\"' and set 'force=yes'");
1725 bpf__strerror_entry(EACCES
, "You need to be root");
1726 bpf__strerror_entry(EPERM
, "You need to be root, and /proc/sys/kernel/kptr_restrict should be 0");
1727 bpf__strerror_entry(ENOENT
, "You need to check probing points in BPF file");
1728 bpf__strerror_end(buf
, size
);
1732 int bpf__strerror_load(struct bpf_object
*obj
,
1733 int err
, char *buf
, size_t size
)
1735 bpf__strerror_head(err
, buf
, size
);
1736 case LIBBPF_ERRNO__KVER
: {
1737 unsigned int obj_kver
= bpf_object__kversion(obj
);
1738 unsigned int real_kver
;
1740 if (fetch_kernel_version(&real_kver
, NULL
, 0)) {
1741 scnprintf(buf
, size
, "Unable to fetch kernel version");
1745 if (obj_kver
!= real_kver
) {
1746 scnprintf(buf
, size
,
1747 "'version' ("KVER_FMT
") doesn't match running kernel ("KVER_FMT
")",
1748 KVER_PARAM(obj_kver
),
1749 KVER_PARAM(real_kver
));
1753 scnprintf(buf
, size
, "Failed to load program for unknown reason");
1756 bpf__strerror_end(buf
, size
);
1760 int bpf__strerror_config_obj(struct bpf_object
*obj __maybe_unused
,
1761 struct parse_events_term
*term __maybe_unused
,
1762 struct evlist
*evlist __maybe_unused
,
1763 int *error_pos __maybe_unused
, int err
,
1764 char *buf
, size_t size
)
1766 bpf__strerror_head(err
, buf
, size
);
1767 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE
,
1768 "Can't use this config term with this map type");
1769 bpf__strerror_end(buf
, size
);
1773 int bpf__strerror_apply_obj_config(int err
, char *buf
, size_t size
)
1775 bpf__strerror_head(err
, buf
, size
);
1776 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTDIM
,
1777 "Cannot set event to BPF map in multi-thread tracing");
1778 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTINH
,
1779 "%s (Hint: use -i to turn off inherit)", emsg
);
1780 bpf__strerror_entry(BPF_LOADER_ERRNO__OBJCONF_MAP_EVTTYPE
,
1781 "Can only put raw, hardware and BPF output event into a BPF map");
1782 bpf__strerror_end(buf
, size
);
1786 int bpf__strerror_setup_output_event(struct evlist
*evlist __maybe_unused
,
1787 int err
, char *buf
, size_t size
)
1789 bpf__strerror_head(err
, buf
, size
);
1790 bpf__strerror_end(buf
, size
);