1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 /* Copyright (C) 2017-2018 Netronome Systems, Inc. */
17 #include <sys/ioctl.h>
18 #include <sys/types.h>
20 #include <sys/syscall.h>
23 #include <linux/err.h>
24 #include <linux/perf_event.h>
25 #include <linux/sizes.h>
29 #include <bpf/hashmap.h>
30 #include <bpf/libbpf.h>
31 #include <bpf/libbpf_internal.h>
32 #include <bpf/skel_internal.h>
36 #include "xlated_dumper.h"
38 #define BPF_METADATA_PREFIX "bpf_metadata_"
39 #define BPF_METADATA_PREFIX_LEN (sizeof(BPF_METADATA_PREFIX) - 1)
46 static const bool attach_types[] = {
47 [BPF_SK_SKB_STREAM_PARSER] = true,
48 [BPF_SK_SKB_STREAM_VERDICT] = true,
49 [BPF_SK_SKB_VERDICT] = true,
50 [BPF_SK_MSG_VERDICT] = true,
51 [BPF_FLOW_DISSECTOR] = true,
52 [__MAX_BPF_ATTACH_TYPE] = false,
55 /* Textual representations traditionally used by the program and kept around
56 * for the sake of backwards compatibility.
58 static const char * const attach_type_strings[] = {
59 [BPF_SK_SKB_STREAM_PARSER] = "stream_parser",
60 [BPF_SK_SKB_STREAM_VERDICT] = "stream_verdict",
61 [BPF_SK_SKB_VERDICT] = "skb_verdict",
62 [BPF_SK_MSG_VERDICT] = "msg_verdict",
63 [__MAX_BPF_ATTACH_TYPE] = NULL,
66 static struct hashmap *prog_table;
68 static enum bpf_attach_type parse_attach_type(const char *str)
70 enum bpf_attach_type type;
72 for (type = 0; type < __MAX_BPF_ATTACH_TYPE; type++) {
73 if (attach_types[type]) {
74 const char *attach_type_str;
76 attach_type_str = libbpf_bpf_attach_type_str(type);
77 if (!strcmp(str, attach_type_str))
81 if (attach_type_strings[type] &&
82 is_prefix(str, attach_type_strings[type]))
86 return __MAX_BPF_ATTACH_TYPE;
89 static int prep_prog_info(struct bpf_prog_info *const info, enum dump_mode mode,
90 void **info_data, size_t *const info_data_sz)
92 struct bpf_prog_info holder = {};
96 if (mode == DUMP_JITED) {
97 holder.jited_prog_len = info->jited_prog_len;
98 needed += info->jited_prog_len;
100 holder.xlated_prog_len = info->xlated_prog_len;
101 needed += info->xlated_prog_len;
104 holder.nr_jited_ksyms = info->nr_jited_ksyms;
105 needed += info->nr_jited_ksyms * sizeof(__u64);
107 holder.nr_jited_func_lens = info->nr_jited_func_lens;
108 needed += info->nr_jited_func_lens * sizeof(__u32);
110 holder.nr_func_info = info->nr_func_info;
111 holder.func_info_rec_size = info->func_info_rec_size;
112 needed += info->nr_func_info * info->func_info_rec_size;
114 holder.nr_line_info = info->nr_line_info;
115 holder.line_info_rec_size = info->line_info_rec_size;
116 needed += info->nr_line_info * info->line_info_rec_size;
118 holder.nr_jited_line_info = info->nr_jited_line_info;
119 holder.jited_line_info_rec_size = info->jited_line_info_rec_size;
120 needed += info->nr_jited_line_info * info->jited_line_info_rec_size;
122 if (needed > *info_data_sz) {
123 ptr = realloc(*info_data, needed);
128 *info_data_sz = needed;
132 if (mode == DUMP_JITED) {
133 holder.jited_prog_insns = ptr_to_u64(ptr);
134 ptr += holder.jited_prog_len;
136 holder.xlated_prog_insns = ptr_to_u64(ptr);
137 ptr += holder.xlated_prog_len;
140 holder.jited_ksyms = ptr_to_u64(ptr);
141 ptr += holder.nr_jited_ksyms * sizeof(__u64);
143 holder.jited_func_lens = ptr_to_u64(ptr);
144 ptr += holder.nr_jited_func_lens * sizeof(__u32);
146 holder.func_info = ptr_to_u64(ptr);
147 ptr += holder.nr_func_info * holder.func_info_rec_size;
149 holder.line_info = ptr_to_u64(ptr);
150 ptr += holder.nr_line_info * holder.line_info_rec_size;
152 holder.jited_line_info = ptr_to_u64(ptr);
153 ptr += holder.nr_jited_line_info * holder.jited_line_info_rec_size;
159 static void print_boot_time(__u64 nsecs, char *buf, unsigned int size)
161 struct timespec real_time_ts, boot_time_ts;
162 time_t wallclock_secs;
167 if (clock_gettime(CLOCK_REALTIME, &real_time_ts) ||
168 clock_gettime(CLOCK_BOOTTIME, &boot_time_ts)) {
169 perror("Can't read clocks");
170 snprintf(buf, size, "%llu", nsecs / 1000000000);
174 wallclock_secs = (real_time_ts.tv_sec - boot_time_ts.tv_sec) +
175 (real_time_ts.tv_nsec - boot_time_ts.tv_nsec + nsecs) /
179 if (!localtime_r(&wallclock_secs, &load_tm)) {
180 snprintf(buf, size, "%llu", nsecs / 1000000000);
185 strftime(buf, size, "%s", &load_tm);
187 strftime(buf, size, "%FT%T%z", &load_tm);
190 static void show_prog_maps(int fd, __u32 num_maps)
192 struct bpf_prog_info info = {};
193 __u32 len = sizeof(info);
194 __u32 map_ids[num_maps];
198 info.nr_map_ids = num_maps;
199 info.map_ids = ptr_to_u64(map_ids);
201 err = bpf_prog_get_info_by_fd(fd, &info, &len);
202 if (err || !info.nr_map_ids)
206 jsonw_name(json_wtr, "map_ids");
207 jsonw_start_array(json_wtr);
208 for (i = 0; i < info.nr_map_ids; i++)
209 jsonw_uint(json_wtr, map_ids[i]);
210 jsonw_end_array(json_wtr);
213 for (i = 0; i < info.nr_map_ids; i++)
214 printf("%u%s", map_ids[i],
215 i == info.nr_map_ids - 1 ? "" : ",");
219 static void *find_metadata(int prog_fd, struct bpf_map_info *map_info)
221 struct bpf_prog_info prog_info;
232 memset(&prog_info, 0, sizeof(prog_info));
233 prog_info_len = sizeof(prog_info);
234 ret = bpf_prog_get_info_by_fd(prog_fd, &prog_info, &prog_info_len);
238 if (!prog_info.nr_map_ids)
241 map_ids = calloc(prog_info.nr_map_ids, sizeof(__u32));
245 nr_maps = prog_info.nr_map_ids;
246 memset(&prog_info, 0, sizeof(prog_info));
247 prog_info.nr_map_ids = nr_maps;
248 prog_info.map_ids = ptr_to_u64(map_ids);
249 prog_info_len = sizeof(prog_info);
251 ret = bpf_prog_get_info_by_fd(prog_fd, &prog_info, &prog_info_len);
255 for (i = 0; i < prog_info.nr_map_ids; i++) {
256 map_fd = bpf_map_get_fd_by_id(map_ids[i]);
260 memset(map_info, 0, sizeof(*map_info));
261 map_info_len = sizeof(*map_info);
262 ret = bpf_map_get_info_by_fd(map_fd, map_info, &map_info_len);
268 if (map_info->type != BPF_MAP_TYPE_ARRAY ||
269 map_info->key_size != sizeof(int) ||
270 map_info->max_entries != 1 ||
271 !map_info->btf_value_type_id ||
272 !strstr(map_info->name, ".rodata")) {
277 value = malloc(map_info->value_size);
283 if (bpf_map_lookup_elem(map_fd, &key, value)) {
299 static bool has_metadata_prefix(const char *s)
301 return strncmp(s, BPF_METADATA_PREFIX, BPF_METADATA_PREFIX_LEN) == 0;
304 static void show_prog_metadata(int fd, __u32 num_maps)
306 const struct btf_type *t_datasec, *t_var;
307 struct bpf_map_info map_info;
308 struct btf_var_secinfo *vsi;
309 bool printed_header = false;
310 unsigned int i, vlen;
319 memset(&map_info, 0, sizeof(map_info));
320 value = find_metadata(fd, &map_info);
324 btf = btf__load_from_kernel_by_id(map_info.btf_id);
328 t_datasec = btf__type_by_id(btf, map_info.btf_value_type_id);
329 if (!btf_is_datasec(t_datasec))
332 vlen = btf_vlen(t_datasec);
333 vsi = btf_var_secinfos(t_datasec);
335 /* We don't proceed to check the kinds of the elements of the DATASEC.
336 * The verifier enforces them to be BTF_KIND_VAR.
340 struct btf_dumper d = {
343 .is_plain_text = false,
346 for (i = 0; i < vlen; i++, vsi++) {
347 t_var = btf__type_by_id(btf, vsi->type);
348 name = btf__name_by_offset(btf, t_var->name_off);
350 if (!has_metadata_prefix(name))
353 if (!printed_header) {
354 jsonw_name(json_wtr, "metadata");
355 jsonw_start_object(json_wtr);
356 printed_header = true;
359 jsonw_name(json_wtr, name + BPF_METADATA_PREFIX_LEN);
360 err = btf_dumper_type(&d, t_var->type, value + vsi->offset);
362 p_err("btf dump failed: %d", err);
367 jsonw_end_object(json_wtr);
369 json_writer_t *btf_wtr;
370 struct btf_dumper d = {
372 .is_plain_text = true,
375 for (i = 0; i < vlen; i++, vsi++) {
376 t_var = btf__type_by_id(btf, vsi->type);
377 name = btf__name_by_offset(btf, t_var->name_off);
379 if (!has_metadata_prefix(name))
382 if (!printed_header) {
383 printf("\tmetadata:");
385 btf_wtr = jsonw_new(stdout);
387 p_err("jsonw alloc failed");
392 printed_header = true;
395 printf("\n\t\t%s = ", name + BPF_METADATA_PREFIX_LEN);
397 jsonw_reset(btf_wtr);
398 err = btf_dumper_type(&d, t_var->type, value + vsi->offset);
400 p_err("btf dump failed: %d", err);
405 jsonw_destroy(&btf_wtr);
413 static void print_prog_header_json(struct bpf_prog_info *info, int fd)
415 const char *prog_type_str;
416 char prog_name[MAX_PROG_FULL_NAME];
418 jsonw_uint_field(json_wtr, "id", info->id);
419 prog_type_str = libbpf_bpf_prog_type_str(info->type);
422 jsonw_string_field(json_wtr, "type", prog_type_str);
424 jsonw_uint_field(json_wtr, "type", info->type);
427 get_prog_full_name(info, fd, prog_name, sizeof(prog_name));
428 jsonw_string_field(json_wtr, "name", prog_name);
431 jsonw_name(json_wtr, "tag");
432 jsonw_printf(json_wtr, "\"" BPF_TAG_FMT "\"",
433 info->tag[0], info->tag[1], info->tag[2], info->tag[3],
434 info->tag[4], info->tag[5], info->tag[6], info->tag[7]);
436 jsonw_bool_field(json_wtr, "gpl_compatible", info->gpl_compatible);
437 if (info->run_time_ns) {
438 jsonw_uint_field(json_wtr, "run_time_ns", info->run_time_ns);
439 jsonw_uint_field(json_wtr, "run_cnt", info->run_cnt);
441 if (info->recursion_misses)
442 jsonw_uint_field(json_wtr, "recursion_misses", info->recursion_misses);
445 static void print_prog_json(struct bpf_prog_info *info, int fd)
449 jsonw_start_object(json_wtr);
450 print_prog_header_json(info, fd);
451 print_dev_json(info->ifindex, info->netns_dev, info->netns_ino);
453 if (info->load_time) {
456 print_boot_time(info->load_time, buf, sizeof(buf));
458 /* Piggy back on load_time, since 0 uid is a valid one */
459 jsonw_name(json_wtr, "loaded_at");
460 jsonw_printf(json_wtr, "%s", buf);
461 jsonw_uint_field(json_wtr, "uid", info->created_by_uid);
464 jsonw_uint_field(json_wtr, "bytes_xlated", info->xlated_prog_len);
466 if (info->jited_prog_len) {
467 jsonw_bool_field(json_wtr, "jited", true);
468 jsonw_uint_field(json_wtr, "bytes_jited", info->jited_prog_len);
470 jsonw_bool_field(json_wtr, "jited", false);
473 memlock = get_fdinfo(fd, "memlock");
475 jsonw_int_field(json_wtr, "bytes_memlock", atoll(memlock));
478 if (info->nr_map_ids)
479 show_prog_maps(fd, info->nr_map_ids);
482 jsonw_int_field(json_wtr, "btf_id", info->btf_id);
484 if (!hashmap__empty(prog_table)) {
485 struct hashmap_entry *entry;
487 jsonw_name(json_wtr, "pinned");
488 jsonw_start_array(json_wtr);
489 hashmap__for_each_key_entry(prog_table, entry, info->id)
490 jsonw_string(json_wtr, entry->pvalue);
491 jsonw_end_array(json_wtr);
494 emit_obj_refs_json(refs_table, info->id, json_wtr);
496 show_prog_metadata(fd, info->nr_map_ids);
498 jsonw_end_object(json_wtr);
501 static void print_prog_header_plain(struct bpf_prog_info *info, int fd)
503 const char *prog_type_str;
504 char prog_name[MAX_PROG_FULL_NAME];
506 printf("%u: ", info->id);
507 prog_type_str = libbpf_bpf_prog_type_str(info->type);
509 printf("%s ", prog_type_str);
511 printf("type %u ", info->type);
514 get_prog_full_name(info, fd, prog_name, sizeof(prog_name));
515 printf("name %s ", prog_name);
519 fprint_hex(stdout, info->tag, BPF_TAG_SIZE, "");
520 print_dev_plain(info->ifindex, info->netns_dev, info->netns_ino);
521 printf("%s", info->gpl_compatible ? " gpl" : "");
522 if (info->run_time_ns)
523 printf(" run_time_ns %lld run_cnt %lld",
524 info->run_time_ns, info->run_cnt);
525 if (info->recursion_misses)
526 printf(" recursion_misses %lld", info->recursion_misses);
530 static void print_prog_plain(struct bpf_prog_info *info, int fd)
534 print_prog_header_plain(info, fd);
536 if (info->load_time) {
539 print_boot_time(info->load_time, buf, sizeof(buf));
541 /* Piggy back on load_time, since 0 uid is a valid one */
542 printf("\tloaded_at %s uid %u\n", buf, info->created_by_uid);
545 printf("\txlated %uB", info->xlated_prog_len);
547 if (info->jited_prog_len)
548 printf(" jited %uB", info->jited_prog_len);
550 printf(" not jited");
552 memlock = get_fdinfo(fd, "memlock");
554 printf(" memlock %sB", memlock);
557 if (info->nr_map_ids)
558 show_prog_maps(fd, info->nr_map_ids);
560 if (!hashmap__empty(prog_table)) {
561 struct hashmap_entry *entry;
563 hashmap__for_each_key_entry(prog_table, entry, info->id)
564 printf("\n\tpinned %s", (char *)entry->pvalue);
568 printf("\n\tbtf_id %d", info->btf_id);
570 emit_obj_refs_plain(refs_table, info->id, "\n\tpids ");
574 show_prog_metadata(fd, info->nr_map_ids);
577 static int show_prog(int fd)
579 struct bpf_prog_info info = {};
580 __u32 len = sizeof(info);
583 err = bpf_prog_get_info_by_fd(fd, &info, &len);
585 p_err("can't get prog info: %s", strerror(errno));
590 print_prog_json(&info, fd);
592 print_prog_plain(&info, fd);
597 static int do_show_subset(int argc, char **argv)
603 fds = malloc(sizeof(int));
605 p_err("mem alloc failed");
608 nb_fds = prog_parse_fds(&argc, &argv, &fds);
612 if (json_output && nb_fds > 1)
613 jsonw_start_array(json_wtr); /* root array */
614 for (i = 0; i < nb_fds; i++) {
615 err = show_prog(fds[i]);
617 for (; i < nb_fds; i++)
623 if (json_output && nb_fds > 1)
624 jsonw_end_array(json_wtr); /* root array */
631 static int do_show(int argc, char **argv)
638 prog_table = hashmap__new(hash_fn_for_key_as_id,
639 equal_fn_for_key_as_id, NULL);
640 if (IS_ERR(prog_table)) {
641 p_err("failed to create hashmap for pinned paths");
644 build_pinned_obj_table(prog_table, BPF_OBJ_PROG);
646 build_obj_refs_table(&refs_table, BPF_OBJ_PROG);
649 return do_show_subset(argc, argv);
655 jsonw_start_array(json_wtr);
657 err = bpf_prog_get_next_id(id, &id);
659 if (errno == ENOENT) {
663 p_err("can't get next program: %s%s", strerror(errno),
664 errno == EINVAL ? " -- kernel too old?" : "");
669 fd = bpf_prog_get_fd_by_id(id);
673 p_err("can't get prog by id (%u): %s",
674 id, strerror(errno));
686 jsonw_end_array(json_wtr);
688 delete_obj_refs_table(refs_table);
691 delete_pinned_obj_table(prog_table);
697 prog_dump(struct bpf_prog_info *info, enum dump_mode mode,
698 char *filepath, bool opcodes, bool visual, bool linum)
700 struct bpf_prog_linfo *prog_linfo = NULL;
701 const char *disasm_opt = NULL;
702 struct dump_data dd = {};
703 void *func_info = NULL;
704 struct btf *btf = NULL;
711 if (mode == DUMP_JITED) {
712 if (info->jited_prog_len == 0 || !info->jited_prog_insns) {
713 p_info("no instructions returned");
716 buf = u64_to_ptr(info->jited_prog_insns);
717 member_len = info->jited_prog_len;
718 } else { /* DUMP_XLATED */
719 if (info->xlated_prog_len == 0 || !info->xlated_prog_insns) {
720 p_err("error retrieving insn dump: kernel.kptr_restrict set?");
723 buf = u64_to_ptr(info->xlated_prog_insns);
724 member_len = info->xlated_prog_len;
728 btf = btf__load_from_kernel_by_id(info->btf_id);
730 p_err("failed to get btf");
735 func_info = u64_to_ptr(info->func_info);
737 if (info->nr_line_info) {
738 prog_linfo = bpf_prog_linfo__new(info);
740 p_info("error in processing bpf_line_info. continue without it.");
744 fd = open(filepath, O_WRONLY | O_CREAT | O_TRUNC, 0600);
746 p_err("can't open file %s: %s", filepath,
751 n = write(fd, buf, member_len);
753 if (n != (ssize_t)member_len) {
754 p_err("error writing output file: %s",
755 n < 0 ? strerror(errno) : "short write");
760 jsonw_null(json_wtr);
761 } else if (mode == DUMP_JITED) {
762 const char *name = NULL;
765 name = ifindex_to_arch(info->ifindex, info->netns_dev,
766 info->netns_ino, &disasm_opt);
771 if (info->nr_jited_func_lens && info->jited_func_lens) {
772 struct kernel_sym *sym = NULL;
773 struct bpf_func_info *record;
774 char sym_name[SYM_MAX_NAME];
775 unsigned char *img = buf;
779 if (info->nr_jited_ksyms) {
780 kernel_syms_load(&dd);
781 ksyms = u64_to_ptr(info->jited_ksyms);
785 jsonw_start_array(json_wtr);
787 lens = u64_to_ptr(info->jited_func_lens);
788 for (i = 0; i < info->nr_jited_func_lens; i++) {
790 sym = kernel_syms_search(&dd, ksyms[i]);
792 sprintf(sym_name, "%s", sym->name);
794 sprintf(sym_name, "0x%016llx", ksyms[i]);
796 strcpy(sym_name, "unknown");
800 record = func_info + i * info->func_info_rec_size;
801 btf_dumper_type_only(btf, record->type_id,
807 jsonw_start_object(json_wtr);
808 if (func_info && func_sig[0] != '\0') {
809 jsonw_name(json_wtr, "proto");
810 jsonw_string(json_wtr, func_sig);
812 jsonw_name(json_wtr, "name");
813 jsonw_string(json_wtr, sym_name);
814 jsonw_name(json_wtr, "insns");
816 if (func_info && func_sig[0] != '\0')
817 printf("%s:\n", func_sig);
818 printf("%s:\n", sym_name);
821 if (disasm_print_insn(img, lens[i], opcodes,
822 name, disasm_opt, btf,
823 prog_linfo, ksyms[i], i,
830 jsonw_end_object(json_wtr);
836 jsonw_end_array(json_wtr);
838 if (disasm_print_insn(buf, member_len, opcodes, name,
839 disasm_opt, btf, NULL, 0, 0,
844 kernel_syms_load(&dd);
845 dd.nr_jited_ksyms = info->nr_jited_ksyms;
846 dd.jited_ksyms = u64_to_ptr(info->jited_ksyms);
848 dd.func_info = func_info;
849 dd.finfo_rec_size = info->func_info_rec_size;
850 dd.prog_linfo = prog_linfo;
853 dump_xlated_json(&dd, buf, member_len, opcodes, linum);
855 dump_xlated_cfg(&dd, buf, member_len, opcodes, linum);
857 dump_xlated_plain(&dd, buf, member_len, opcodes, linum);
858 kernel_syms_destroy(&dd);
865 bpf_prog_linfo__free(prog_linfo);
869 static int do_dump(int argc, char **argv)
871 struct bpf_prog_info info;
872 __u32 info_len = sizeof(info);
873 size_t info_data_sz = 0;
874 void *info_data = NULL;
875 char *filepath = NULL;
876 bool opcodes = false;
884 if (is_prefix(*argv, "jited")) {
888 } else if (is_prefix(*argv, "xlated")) {
891 p_err("expected 'xlated' or 'jited', got: %s", *argv);
899 fds = malloc(sizeof(int));
901 p_err("mem alloc failed");
904 nb_fds = prog_parse_fds(&argc, &argv, &fds);
909 if (is_prefix(*argv, "file")) {
912 p_err("expected file path");
916 p_err("several programs matched");
922 } else if (is_prefix(*argv, "opcodes")) {
925 } else if (is_prefix(*argv, "visual")) {
927 p_err("several programs matched");
933 } else if (is_prefix(*argv, "linum")) {
942 if (filepath && (opcodes || visual || linum)) {
943 p_err("'file' is not compatible with 'opcodes', 'visual', or 'linum'");
946 if (json_output && visual) {
947 p_err("'visual' is not compatible with JSON output");
951 if (json_output && nb_fds > 1)
952 jsonw_start_array(json_wtr); /* root array */
953 for (i = 0; i < nb_fds; i++) {
954 memset(&info, 0, sizeof(info));
956 err = bpf_prog_get_info_by_fd(fds[i], &info, &info_len);
958 p_err("can't get prog info: %s", strerror(errno));
962 err = prep_prog_info(&info, mode, &info_data, &info_data_sz);
964 p_err("can't grow prog info_data");
968 err = bpf_prog_get_info_by_fd(fds[i], &info, &info_len);
970 p_err("can't get prog info: %s", strerror(errno));
974 if (json_output && nb_fds > 1) {
975 jsonw_start_object(json_wtr); /* prog object */
976 print_prog_header_json(&info, fds[i]);
977 jsonw_name(json_wtr, "insns");
978 } else if (nb_fds > 1) {
979 print_prog_header_plain(&info, fds[i]);
982 err = prog_dump(&info, mode, filepath, opcodes, visual, linum);
984 if (json_output && nb_fds > 1)
985 jsonw_end_object(json_wtr); /* prog object */
986 else if (i != nb_fds - 1 && nb_fds > 1)
993 if (json_output && nb_fds > 1)
994 jsonw_end_array(json_wtr); /* root array */
997 for (; i < nb_fds; i++)
1005 static int do_pin(int argc, char **argv)
1009 err = do_pin_any(argc, argv, prog_parse_fd);
1010 if (!err && json_output)
1011 jsonw_null(json_wtr);
1015 struct map_replace {
1021 static int map_replace_compar(const void *p1, const void *p2)
1023 const struct map_replace *a = p1, *b = p2;
1025 return a->idx - b->idx;
1028 static int parse_attach_detach_args(int argc, char **argv, int *progfd,
1029 enum bpf_attach_type *attach_type,
1035 *progfd = prog_parse_fd(&argc, &argv);
1039 *attach_type = parse_attach_type(*argv);
1040 if (*attach_type == __MAX_BPF_ATTACH_TYPE) {
1041 p_err("invalid attach/detach type");
1045 if (*attach_type == BPF_FLOW_DISSECTOR) {
1054 *mapfd = map_parse_fd(&argc, &argv);
1061 static int do_attach(int argc, char **argv)
1063 enum bpf_attach_type attach_type;
1067 err = parse_attach_detach_args(argc, argv,
1068 &progfd, &attach_type, &mapfd);
1072 err = bpf_prog_attach(progfd, mapfd, attach_type, 0);
1074 p_err("failed prog attach to map");
1079 jsonw_null(json_wtr);
1083 static int do_detach(int argc, char **argv)
1085 enum bpf_attach_type attach_type;
1089 err = parse_attach_detach_args(argc, argv,
1090 &progfd, &attach_type, &mapfd);
1094 err = bpf_prog_detach2(progfd, mapfd, attach_type);
1096 p_err("failed prog detach from map");
1101 jsonw_null(json_wtr);
1105 static int check_single_stdin(char *file_data_in, char *file_ctx_in)
1107 if (file_data_in && file_ctx_in &&
1108 !strcmp(file_data_in, "-") && !strcmp(file_ctx_in, "-")) {
1109 p_err("cannot use standard input for both data_in and ctx_in");
1116 static int get_run_data(const char *fname, void **data_ptr, unsigned int *size)
1118 size_t block_size = 256;
1119 size_t buf_size = block_size;
1130 if (!strcmp(fname, "-"))
1133 f = fopen(fname, "r");
1135 p_err("failed to open %s: %s", fname, strerror(errno));
1139 *data_ptr = malloc(block_size);
1141 p_err("failed to allocate memory for data_in/ctx_in: %s",
1146 while ((nb_read += fread(*data_ptr + nb_read, 1, block_size, f))) {
1150 p_err("failed to read data_in/ctx_in from %s: %s",
1151 fname, strerror(errno));
1154 if (nb_read > buf_size - block_size) {
1155 if (buf_size == UINT32_MAX) {
1156 p_err("data_in/ctx_in is too long (max: %d)",
1160 /* No space for fread()-ing next chunk; realloc() */
1162 tmp = realloc(*data_ptr, buf_size);
1164 p_err("failed to reallocate data_in/ctx_in: %s",
1186 static void hex_print(void *data, unsigned int size, FILE *f)
1191 for (i = 0; i < size; i += 16) {
1193 fprintf(f, "%07zx\t", i);
1195 /* Hexadecimal values */
1196 for (j = i; j < i + 16 && j < size; j++)
1197 fprintf(f, "%02x%s", *(uint8_t *)(data + j),
1199 for (; j < i + 16; j++)
1200 fprintf(f, " %s", j % 2 ? " " : "");
1202 /* ASCII values (if relevant), '.' otherwise */
1204 for (j = i; j < i + 16 && j < size; j++) {
1205 c = *(char *)(data + j);
1206 if (c < ' ' || c > '~')
1208 fprintf(f, "%c%s", c, j == i + 7 ? " " : "");
1216 print_run_output(void *data, unsigned int size, const char *fname,
1217 const char *json_key)
1225 if (!strcmp(fname, "-")) {
1228 jsonw_name(json_wtr, json_key);
1229 print_data_json(data, size);
1231 hex_print(data, size, f);
1236 f = fopen(fname, "w");
1238 p_err("failed to open %s: %s", fname, strerror(errno));
1242 nb_written = fwrite(data, 1, size, f);
1244 if (nb_written != size) {
1245 p_err("failed to write output data/ctx: %s", strerror(errno));
1252 static int alloc_run_data(void **data_ptr, unsigned int size_out)
1254 *data_ptr = calloc(size_out, 1);
1256 p_err("failed to allocate memory for output data/ctx: %s",
1264 static int do_run(int argc, char **argv)
1266 char *data_fname_in = NULL, *data_fname_out = NULL;
1267 char *ctx_fname_in = NULL, *ctx_fname_out = NULL;
1268 const unsigned int default_size = SZ_32K;
1269 void *data_in = NULL, *data_out = NULL;
1270 void *ctx_in = NULL, *ctx_out = NULL;
1271 unsigned int repeat = 1;
1273 LIBBPF_OPTS(bpf_test_run_opts, test_attr);
1278 fd = prog_parse_fd(&argc, &argv);
1283 if (detect_common_prefix(*argv, "data_in", "data_out",
1284 "data_size_out", NULL))
1286 if (detect_common_prefix(*argv, "ctx_in", "ctx_out",
1287 "ctx_size_out", NULL))
1290 if (is_prefix(*argv, "data_in")) {
1295 data_fname_in = GET_ARG();
1296 if (check_single_stdin(data_fname_in, ctx_fname_in))
1298 } else if (is_prefix(*argv, "data_out")) {
1303 data_fname_out = GET_ARG();
1304 } else if (is_prefix(*argv, "data_size_out")) {
1311 test_attr.data_size_out = strtoul(*argv, &endptr, 0);
1313 p_err("can't parse %s as output data size",
1318 } else if (is_prefix(*argv, "ctx_in")) {
1323 ctx_fname_in = GET_ARG();
1324 if (check_single_stdin(data_fname_in, ctx_fname_in))
1326 } else if (is_prefix(*argv, "ctx_out")) {
1331 ctx_fname_out = GET_ARG();
1332 } else if (is_prefix(*argv, "ctx_size_out")) {
1339 test_attr.ctx_size_out = strtoul(*argv, &endptr, 0);
1341 p_err("can't parse %s as output context size",
1346 } else if (is_prefix(*argv, "repeat")) {
1353 repeat = strtoul(*argv, &endptr, 0);
1355 p_err("can't parse %s as repeat number",
1361 p_err("expected no more arguments, 'data_in', 'data_out', 'data_size_out', 'ctx_in', 'ctx_out', 'ctx_size_out' or 'repeat', got: '%s'?",
1367 err = get_run_data(data_fname_in, &data_in, &test_attr.data_size_in);
1372 if (!test_attr.data_size_out)
1373 test_attr.data_size_out = default_size;
1374 err = alloc_run_data(&data_out, test_attr.data_size_out);
1379 err = get_run_data(ctx_fname_in, &ctx_in, &test_attr.ctx_size_in);
1384 if (!test_attr.ctx_size_out)
1385 test_attr.ctx_size_out = default_size;
1386 err = alloc_run_data(&ctx_out, test_attr.ctx_size_out);
1391 test_attr.repeat = repeat;
1392 test_attr.data_in = data_in;
1393 test_attr.data_out = data_out;
1394 test_attr.ctx_in = ctx_in;
1395 test_attr.ctx_out = ctx_out;
1397 err = bpf_prog_test_run_opts(fd, &test_attr);
1399 p_err("failed to run program: %s", strerror(errno));
1406 jsonw_start_object(json_wtr); /* root */
1408 /* Do not exit on errors occurring when printing output data/context,
1409 * we still want to print return value and duration for program run.
1411 if (test_attr.data_size_out)
1412 err += print_run_output(test_attr.data_out,
1413 test_attr.data_size_out,
1414 data_fname_out, "data_out");
1415 if (test_attr.ctx_size_out)
1416 err += print_run_output(test_attr.ctx_out,
1417 test_attr.ctx_size_out,
1418 ctx_fname_out, "ctx_out");
1421 jsonw_uint_field(json_wtr, "retval", test_attr.retval);
1422 jsonw_uint_field(json_wtr, "duration", test_attr.duration);
1423 jsonw_end_object(json_wtr); /* root */
1425 fprintf(stdout, "Return value: %u, duration%s: %uns\n",
1427 repeat > 1 ? " (average)" : "", test_attr.duration);
1443 get_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
1444 enum bpf_attach_type *expected_attach_type)
1446 libbpf_print_fn_t print_backup;
1449 ret = libbpf_prog_type_by_name(name, prog_type, expected_attach_type);
1453 /* libbpf_prog_type_by_name() failed, let's re-run with debug level */
1454 print_backup = libbpf_set_print(print_all_levels);
1455 ret = libbpf_prog_type_by_name(name, prog_type, expected_attach_type);
1456 libbpf_set_print(print_backup);
1462 auto_attach_program(struct bpf_program *prog, const char *path)
1464 struct bpf_link *link;
1467 link = bpf_program__attach(prog);
1469 p_info("Program %s does not support autoattach, falling back to pinning",
1470 bpf_program__name(prog));
1471 return bpf_obj_pin(bpf_program__fd(prog), path);
1474 err = bpf_link__pin(link, path);
1475 bpf_link__destroy(link);
1480 auto_attach_programs(struct bpf_object *obj, const char *path)
1482 struct bpf_program *prog;
1486 bpf_object__for_each_program(prog, obj) {
1487 err = pathname_concat(buf, sizeof(buf), path, bpf_program__name(prog));
1489 goto err_unpin_programs;
1491 err = auto_attach_program(prog, buf);
1493 goto err_unpin_programs;
1499 while ((prog = bpf_object__prev_program(obj, prog))) {
1500 if (pathname_concat(buf, sizeof(buf), path, bpf_program__name(prog)))
1503 bpf_program__unpin(prog, buf);
1509 static int load_with_options(int argc, char **argv, bool first_prog_only)
1511 enum bpf_prog_type common_prog_type = BPF_PROG_TYPE_UNSPEC;
1512 DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts,
1513 .relaxed_maps = relaxed_maps,
1515 enum bpf_attach_type expected_attach_type;
1516 struct map_replace *map_replace = NULL;
1517 struct bpf_program *prog = NULL, *pos;
1518 unsigned int old_map_fds = 0;
1519 const char *pinmaps = NULL;
1520 __u32 xdpmeta_ifindex = 0;
1521 __u32 offload_ifindex = 0;
1522 bool auto_attach = false;
1523 struct bpf_object *obj;
1524 struct bpf_map *map;
1525 const char *pinfile;
1534 pinfile = GET_ARG();
1537 if (is_prefix(*argv, "type")) {
1540 if (common_prog_type != BPF_PROG_TYPE_UNSPEC) {
1541 p_err("program type already specified");
1542 goto err_free_reuse_maps;
1545 goto err_free_reuse_maps;
1547 err = libbpf_prog_type_by_name(*argv, &common_prog_type,
1548 &expected_attach_type);
1550 /* Put a '/' at the end of type to appease libbpf */
1551 char *type = malloc(strlen(*argv) + 2);
1554 p_err("mem alloc failed");
1555 goto err_free_reuse_maps;
1558 strcat(type, *argv);
1561 err = get_prog_type_by_name(type, &common_prog_type,
1562 &expected_attach_type);
1565 goto err_free_reuse_maps;
1569 } else if (is_prefix(*argv, "map")) {
1570 void *new_map_replace;
1571 char *endptr, *name;
1577 goto err_free_reuse_maps;
1579 if (is_prefix(*argv, "idx")) {
1582 idx = strtoul(*argv, &endptr, 0);
1584 p_err("can't parse %s as IDX", *argv);
1585 goto err_free_reuse_maps;
1588 } else if (is_prefix(*argv, "name")) {
1594 p_err("expected 'idx' or 'name', got: '%s'?",
1596 goto err_free_reuse_maps;
1600 fd = map_parse_fd(&argc, &argv);
1602 goto err_free_reuse_maps;
1604 new_map_replace = libbpf_reallocarray(map_replace,
1606 sizeof(*map_replace));
1607 if (!new_map_replace) {
1608 p_err("mem alloc failed");
1609 goto err_free_reuse_maps;
1611 map_replace = new_map_replace;
1613 map_replace[old_map_fds].idx = idx;
1614 map_replace[old_map_fds].name = name;
1615 map_replace[old_map_fds].fd = fd;
1617 } else if (is_prefix(*argv, "dev")) {
1618 p_info("Warning: 'bpftool prog load [...] dev <ifname>' syntax is deprecated.\n"
1619 "Going further, please use 'offload_dev <ifname>' to offload program to device.\n"
1620 "For applications using XDP hints only, use 'xdpmeta_dev <ifname>'.");
1622 } else if (is_prefix(*argv, "offload_dev")) {
1626 if (offload_ifindex) {
1627 p_err("offload_dev already specified");
1628 goto err_free_reuse_maps;
1629 } else if (xdpmeta_ifindex) {
1630 p_err("xdpmeta_dev and offload_dev are mutually exclusive");
1631 goto err_free_reuse_maps;
1634 goto err_free_reuse_maps;
1636 offload_ifindex = if_nametoindex(*argv);
1637 if (!offload_ifindex) {
1638 p_err("unrecognized netdevice '%s': %s",
1639 *argv, strerror(errno));
1640 goto err_free_reuse_maps;
1643 } else if (is_prefix(*argv, "xdpmeta_dev")) {
1646 if (xdpmeta_ifindex) {
1647 p_err("xdpmeta_dev already specified");
1648 goto err_free_reuse_maps;
1649 } else if (offload_ifindex) {
1650 p_err("xdpmeta_dev and offload_dev are mutually exclusive");
1651 goto err_free_reuse_maps;
1654 goto err_free_reuse_maps;
1656 xdpmeta_ifindex = if_nametoindex(*argv);
1657 if (!xdpmeta_ifindex) {
1658 p_err("unrecognized netdevice '%s': %s",
1659 *argv, strerror(errno));
1660 goto err_free_reuse_maps;
1663 } else if (is_prefix(*argv, "pinmaps")) {
1667 goto err_free_reuse_maps;
1669 pinmaps = GET_ARG();
1670 } else if (is_prefix(*argv, "autoattach")) {
1674 p_err("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?",
1676 goto err_free_reuse_maps;
1683 /* log_level1 + log_level2 + stats, but not stable UAPI */
1684 open_opts.kernel_log_level = 1 + 2 + 4;
1686 obj = bpf_object__open_file(file, &open_opts);
1688 p_err("failed to open object file");
1689 goto err_free_reuse_maps;
1692 bpf_object__for_each_program(pos, obj) {
1693 enum bpf_prog_type prog_type = common_prog_type;
1695 if (prog_type == BPF_PROG_TYPE_UNSPEC) {
1696 const char *sec_name = bpf_program__section_name(pos);
1698 err = get_prog_type_by_name(sec_name, &prog_type,
1699 &expected_attach_type);
1704 if (prog_type == BPF_PROG_TYPE_XDP && xdpmeta_ifindex) {
1705 bpf_program__set_flags(pos, BPF_F_XDP_DEV_BOUND_ONLY);
1706 bpf_program__set_ifindex(pos, xdpmeta_ifindex);
1708 bpf_program__set_ifindex(pos, offload_ifindex);
1710 if (bpf_program__type(pos) != prog_type)
1711 bpf_program__set_type(pos, prog_type);
1712 bpf_program__set_expected_attach_type(pos, expected_attach_type);
1715 qsort(map_replace, old_map_fds, sizeof(*map_replace),
1716 map_replace_compar);
1718 /* After the sort maps by name will be first on the list, because they
1719 * have idx == -1. Resolve them.
1722 while (j < old_map_fds && map_replace[j].name) {
1724 bpf_object__for_each_map(map, obj) {
1725 if (!strcmp(bpf_map__name(map), map_replace[j].name)) {
1726 map_replace[j].idx = i;
1731 if (map_replace[j].idx == -1) {
1732 p_err("unable to find map '%s'", map_replace[j].name);
1737 /* Resort if any names were resolved */
1739 qsort(map_replace, old_map_fds, sizeof(*map_replace),
1740 map_replace_compar);
1742 /* Set ifindex and name reuse */
1745 bpf_object__for_each_map(map, obj) {
1746 if (bpf_map__type(map) != BPF_MAP_TYPE_PERF_EVENT_ARRAY)
1747 bpf_map__set_ifindex(map, offload_ifindex);
1749 if (j < old_map_fds && idx == map_replace[j].idx) {
1750 err = bpf_map__reuse_fd(map, map_replace[j++].fd);
1752 p_err("unable to set up map reuse: %d", err);
1756 /* Next reuse wants to apply to the same map */
1757 if (j < old_map_fds && map_replace[j].idx == idx) {
1758 p_err("replacement for map idx %d specified more than once",
1766 if (j < old_map_fds) {
1767 p_err("map idx '%d' not used", map_replace[j].idx);
1771 err = bpf_object__load(obj);
1773 p_err("failed to load object file");
1777 err = mount_bpffs_for_pin(pinfile, !first_prog_only);
1781 if (first_prog_only) {
1782 prog = bpf_object__next_program(obj, NULL);
1784 p_err("object file doesn't contain any bpf program");
1789 err = auto_attach_program(prog, pinfile);
1791 err = bpf_obj_pin(bpf_program__fd(prog), pinfile);
1793 p_err("failed to pin program %s",
1794 bpf_program__section_name(prog));
1799 err = auto_attach_programs(obj, pinfile);
1801 err = bpf_object__pin_programs(obj, pinfile);
1803 p_err("failed to pin all programs");
1809 err = bpf_object__pin_maps(obj, pinmaps);
1811 p_err("failed to pin all maps");
1817 jsonw_null(json_wtr);
1819 bpf_object__close(obj);
1820 for (i = 0; i < old_map_fds; i++)
1821 close(map_replace[i].fd);
1827 if (first_prog_only)
1830 bpf_object__unpin_programs(obj, pinfile);
1832 bpf_object__close(obj);
1833 err_free_reuse_maps:
1834 for (i = 0; i < old_map_fds; i++)
1835 close(map_replace[i].fd);
1840 static int count_open_fds(void)
1842 DIR *dp = opendir("/proc/self/fd");
1849 while ((de = readdir(dp)))
1856 static int try_loader(struct gen_loader_opts *gen)
1858 struct bpf_load_and_run_opts opts = {};
1859 struct bpf_loader_ctx *ctx;
1860 int ctx_sz = sizeof(*ctx) + 64 * max(sizeof(struct bpf_map_desc),
1861 sizeof(struct bpf_prog_desc));
1862 int log_buf_sz = (1u << 24) - 1;
1863 int err, fds_before, fd_delta;
1864 char *log_buf = NULL;
1866 ctx = alloca(ctx_sz);
1867 memset(ctx, 0, ctx_sz);
1869 if (verifier_logs) {
1870 ctx->log_level = 1 + 2 + 4;
1871 ctx->log_size = log_buf_sz;
1872 log_buf = malloc(log_buf_sz);
1875 ctx->log_buf = (long) log_buf;
1878 opts.data = gen->data;
1879 opts.data_sz = gen->data_sz;
1880 opts.insns = gen->insns;
1881 opts.insns_sz = gen->insns_sz;
1882 fds_before = count_open_fds();
1883 err = bpf_load_and_run(&opts);
1884 fd_delta = count_open_fds() - fds_before;
1885 if (err < 0 || verifier_logs) {
1886 fprintf(stderr, "err %d\n%s\n%s", err, opts.errstr, log_buf);
1887 if (fd_delta && err < 0)
1888 fprintf(stderr, "loader prog leaked %d FDs\n",
1895 static int do_loader(int argc, char **argv)
1897 DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts);
1898 DECLARE_LIBBPF_OPTS(gen_loader_opts, gen);
1899 struct bpf_object *obj;
1908 /* log_level1 + log_level2 + stats, but not stable UAPI */
1909 open_opts.kernel_log_level = 1 + 2 + 4;
1911 obj = bpf_object__open_file(file, &open_opts);
1913 p_err("failed to open object file");
1917 err = bpf_object__gen_loader(obj, &gen);
1921 err = bpf_object__load(obj);
1923 p_err("failed to load object file");
1927 if (verifier_logs) {
1928 struct dump_data dd = {};
1930 kernel_syms_load(&dd);
1931 dump_xlated_plain(&dd, (void *)gen.insns, gen.insns_sz, false, false);
1932 kernel_syms_destroy(&dd);
1934 err = try_loader(&gen);
1936 bpf_object__close(obj);
1940 static int do_load(int argc, char **argv)
1943 return do_loader(argc, argv);
1944 return load_with_options(argc, argv, true);
1947 static int do_loadall(int argc, char **argv)
1949 return load_with_options(argc, argv, false);
1952 #ifdef BPFTOOL_WITHOUT_SKELETONS
1954 static int do_profile(int argc, char **argv)
1956 p_err("bpftool prog profile command is not supported. Please build bpftool with clang >= 10.0.0");
1960 #else /* BPFTOOL_WITHOUT_SKELETONS */
1962 #include "profiler.skel.h"
1964 struct profile_metric {
1966 struct bpf_perf_event_value val;
1967 struct perf_event_attr attr;
1970 /* calculate ratios like instructions per cycle */
1971 const int ratio_metric; /* 0 for N/A, 1 for index 0 (cycles) */
1972 const char *ratio_desc;
1973 const float ratio_mul;
1978 .type = PERF_TYPE_HARDWARE,
1979 .config = PERF_COUNT_HW_CPU_CYCLES,
1984 .name = "instructions",
1986 .type = PERF_TYPE_HARDWARE,
1987 .config = PERF_COUNT_HW_INSTRUCTIONS,
1991 .ratio_desc = "insns per cycle",
1995 .name = "l1d_loads",
1997 .type = PERF_TYPE_HW_CACHE,
1999 PERF_COUNT_HW_CACHE_L1D |
2000 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2001 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16),
2006 .name = "llc_misses",
2008 .type = PERF_TYPE_HW_CACHE,
2010 PERF_COUNT_HW_CACHE_LL |
2011 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2012 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16),
2016 .ratio_desc = "LLC misses per million insns",
2020 .name = "itlb_misses",
2022 .type = PERF_TYPE_HW_CACHE,
2024 PERF_COUNT_HW_CACHE_ITLB |
2025 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2026 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16),
2030 .ratio_desc = "itlb misses per million insns",
2034 .name = "dtlb_misses",
2036 .type = PERF_TYPE_HW_CACHE,
2038 PERF_COUNT_HW_CACHE_DTLB |
2039 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2040 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16),
2044 .ratio_desc = "dtlb misses per million insns",
2049 static __u64 profile_total_count;
2051 #define MAX_NUM_PROFILE_METRICS 4
2053 static int profile_parse_metrics(int argc, char **argv)
2055 unsigned int metric_cnt;
2056 int selected_cnt = 0;
2059 metric_cnt = ARRAY_SIZE(metrics);
2062 for (i = 0; i < metric_cnt; i++) {
2063 if (is_prefix(argv[0], metrics[i].name)) {
2064 if (!metrics[i].selected)
2066 metrics[i].selected = true;
2070 if (i == metric_cnt) {
2071 p_err("unknown metric %s", argv[0]);
2076 if (selected_cnt > MAX_NUM_PROFILE_METRICS) {
2077 p_err("too many (%d) metrics, please specify no more than %d metrics at at time",
2078 selected_cnt, MAX_NUM_PROFILE_METRICS);
2081 return selected_cnt;
2084 static void profile_read_values(struct profiler_bpf *obj)
2086 __u32 m, cpu, num_cpu = obj->rodata->num_cpu;
2087 int reading_map_fd, count_map_fd;
2088 __u64 counts[num_cpu];
2092 reading_map_fd = bpf_map__fd(obj->maps.accum_readings);
2093 count_map_fd = bpf_map__fd(obj->maps.counts);
2094 if (reading_map_fd < 0 || count_map_fd < 0) {
2095 p_err("failed to get fd for map");
2099 err = bpf_map_lookup_elem(count_map_fd, &key, counts);
2101 p_err("failed to read count_map: %s", strerror(errno));
2105 profile_total_count = 0;
2106 for (cpu = 0; cpu < num_cpu; cpu++)
2107 profile_total_count += counts[cpu];
2109 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
2110 struct bpf_perf_event_value values[num_cpu];
2112 if (!metrics[m].selected)
2115 err = bpf_map_lookup_elem(reading_map_fd, &key, values);
2117 p_err("failed to read reading_map: %s",
2121 for (cpu = 0; cpu < num_cpu; cpu++) {
2122 metrics[m].val.counter += values[cpu].counter;
2123 metrics[m].val.enabled += values[cpu].enabled;
2124 metrics[m].val.running += values[cpu].running;
2130 static void profile_print_readings_json(void)
2134 jsonw_start_array(json_wtr);
2135 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
2136 if (!metrics[m].selected)
2138 jsonw_start_object(json_wtr);
2139 jsonw_string_field(json_wtr, "metric", metrics[m].name);
2140 jsonw_lluint_field(json_wtr, "run_cnt", profile_total_count);
2141 jsonw_lluint_field(json_wtr, "value", metrics[m].val.counter);
2142 jsonw_lluint_field(json_wtr, "enabled", metrics[m].val.enabled);
2143 jsonw_lluint_field(json_wtr, "running", metrics[m].val.running);
2145 jsonw_end_object(json_wtr);
2147 jsonw_end_array(json_wtr);
2150 static void profile_print_readings_plain(void)
2154 printf("\n%18llu %-20s\n", profile_total_count, "run_cnt");
2155 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
2156 struct bpf_perf_event_value *val = &metrics[m].val;
2159 if (!metrics[m].selected)
2161 printf("%18llu %-20s", val->counter, metrics[m].name);
2163 r = metrics[m].ratio_metric - 1;
2164 if (r >= 0 && metrics[r].selected &&
2165 metrics[r].val.counter > 0) {
2166 printf("# %8.2f %-30s",
2167 val->counter * metrics[m].ratio_mul /
2168 metrics[r].val.counter,
2169 metrics[m].ratio_desc);
2171 printf("%-41s", "");
2174 if (val->enabled > val->running)
2176 val->running * 100.0 / val->enabled);
2181 static void profile_print_readings(void)
2184 profile_print_readings_json();
2186 profile_print_readings_plain();
2189 static char *profile_target_name(int tgt_fd)
2191 struct bpf_func_info func_info;
2192 struct bpf_prog_info info = {};
2193 __u32 info_len = sizeof(info);
2194 const struct btf_type *t;
2195 __u32 func_info_rec_size;
2196 struct btf *btf = NULL;
2200 err = bpf_prog_get_info_by_fd(tgt_fd, &info, &info_len);
2202 p_err("failed to get info for prog FD %d", tgt_fd);
2206 if (info.btf_id == 0) {
2207 p_err("prog FD %d doesn't have valid btf", tgt_fd);
2211 func_info_rec_size = info.func_info_rec_size;
2212 if (info.nr_func_info == 0) {
2213 p_err("found 0 func_info for prog FD %d", tgt_fd);
2217 memset(&info, 0, sizeof(info));
2218 info.nr_func_info = 1;
2219 info.func_info_rec_size = func_info_rec_size;
2220 info.func_info = ptr_to_u64(&func_info);
2222 err = bpf_prog_get_info_by_fd(tgt_fd, &info, &info_len);
2224 p_err("failed to get func_info for prog FD %d", tgt_fd);
2228 btf = btf__load_from_kernel_by_id(info.btf_id);
2230 p_err("failed to load btf for prog FD %d", tgt_fd);
2234 t = btf__type_by_id(btf, func_info.type_id);
2236 p_err("btf %d doesn't have type %d",
2237 info.btf_id, func_info.type_id);
2240 name = strdup(btf__name_by_offset(btf, t->name_off));
2246 static struct profiler_bpf *profile_obj;
2247 static int profile_tgt_fd = -1;
2248 static char *profile_tgt_name;
2249 static int *profile_perf_events;
2250 static int profile_perf_event_cnt;
2252 static void profile_close_perf_events(struct profiler_bpf *obj)
2256 for (i = profile_perf_event_cnt - 1; i >= 0; i--)
2257 close(profile_perf_events[i]);
2259 free(profile_perf_events);
2260 profile_perf_event_cnt = 0;
2263 static int profile_open_perf_event(int mid, int cpu, int map_fd)
2267 pmu_fd = syscall(__NR_perf_event_open, &metrics[mid].attr,
2268 -1 /*pid*/, cpu, -1 /*group_fd*/, 0);
2270 if (errno == ENODEV) {
2271 p_info("cpu %d may be offline, skip %s profiling.",
2272 cpu, metrics[mid].name);
2273 profile_perf_event_cnt++;
2279 if (bpf_map_update_elem(map_fd,
2280 &profile_perf_event_cnt,
2281 &pmu_fd, BPF_ANY) ||
2282 ioctl(pmu_fd, PERF_EVENT_IOC_ENABLE, 0)) {
2287 profile_perf_events[profile_perf_event_cnt++] = pmu_fd;
2291 static int profile_open_perf_events(struct profiler_bpf *obj)
2293 unsigned int cpu, m;
2296 profile_perf_events = calloc(
2297 sizeof(int), obj->rodata->num_cpu * obj->rodata->num_metric);
2298 if (!profile_perf_events) {
2299 p_err("failed to allocate memory for perf_event array: %s",
2303 map_fd = bpf_map__fd(obj->maps.events);
2305 p_err("failed to get fd for events map");
2309 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
2310 if (!metrics[m].selected)
2312 for (cpu = 0; cpu < obj->rodata->num_cpu; cpu++) {
2313 if (profile_open_perf_event(m, cpu, map_fd)) {
2314 p_err("failed to create event %s on cpu %d",
2315 metrics[m].name, cpu);
2323 static void profile_print_and_cleanup(void)
2325 profile_close_perf_events(profile_obj);
2326 profile_read_values(profile_obj);
2327 profile_print_readings();
2328 profiler_bpf__destroy(profile_obj);
2330 close(profile_tgt_fd);
2331 free(profile_tgt_name);
2334 static void int_exit(int signo)
2336 profile_print_and_cleanup();
2340 static int do_profile(int argc, char **argv)
2342 int num_metric, num_cpu, err = -1;
2343 struct bpf_program *prog;
2344 unsigned long duration;
2347 /* we at least need two args for the prog and one metric */
2351 /* parse target fd */
2352 profile_tgt_fd = prog_parse_fd(&argc, &argv);
2353 if (profile_tgt_fd < 0) {
2354 p_err("failed to parse fd");
2358 /* parse profiling optional duration */
2359 if (argc > 2 && is_prefix(argv[0], "duration")) {
2361 duration = strtoul(*argv, &endptr, 0);
2366 duration = UINT_MAX;
2369 num_metric = profile_parse_metrics(argc, argv);
2370 if (num_metric <= 0)
2373 num_cpu = libbpf_num_possible_cpus();
2375 p_err("failed to identify number of CPUs");
2379 profile_obj = profiler_bpf__open();
2381 p_err("failed to open and/or load BPF object");
2385 profile_obj->rodata->num_cpu = num_cpu;
2386 profile_obj->rodata->num_metric = num_metric;
2388 /* adjust map sizes */
2389 bpf_map__set_max_entries(profile_obj->maps.events, num_metric * num_cpu);
2390 bpf_map__set_max_entries(profile_obj->maps.fentry_readings, num_metric);
2391 bpf_map__set_max_entries(profile_obj->maps.accum_readings, num_metric);
2392 bpf_map__set_max_entries(profile_obj->maps.counts, 1);
2394 /* change target name */
2395 profile_tgt_name = profile_target_name(profile_tgt_fd);
2396 if (!profile_tgt_name)
2399 bpf_object__for_each_program(prog, profile_obj->obj) {
2400 err = bpf_program__set_attach_target(prog, profile_tgt_fd,
2403 p_err("failed to set attach target\n");
2409 err = profiler_bpf__load(profile_obj);
2411 p_err("failed to load profile_obj");
2415 err = profile_open_perf_events(profile_obj);
2419 err = profiler_bpf__attach(profile_obj);
2421 p_err("failed to attach profile_obj");
2424 signal(SIGINT, int_exit);
2427 profile_print_and_cleanup();
2431 profile_close_perf_events(profile_obj);
2433 profiler_bpf__destroy(profile_obj);
2434 close(profile_tgt_fd);
2435 free(profile_tgt_name);
2439 #endif /* BPFTOOL_WITHOUT_SKELETONS */
2441 static int do_help(int argc, char **argv)
2444 jsonw_null(json_wtr);
2449 "Usage: %1$s %2$s { show | list } [PROG]\n"
2450 " %1$s %2$s dump xlated PROG [{ file FILE | [opcodes] [linum] [visual] }]\n"
2451 " %1$s %2$s dump jited PROG [{ file FILE | [opcodes] [linum] }]\n"
2452 " %1$s %2$s pin PROG FILE\n"
2453 " %1$s %2$s { load | loadall } OBJ PATH \\\n"
2454 " [type TYPE] [{ offload_dev | xdpmeta_dev } NAME] \\\n"
2455 " [map { idx IDX | name NAME } MAP]\\\n"
2456 " [pinmaps MAP_DIR]\n"
2458 " %1$s %2$s attach PROG ATTACH_TYPE [MAP]\n"
2459 " %1$s %2$s detach PROG ATTACH_TYPE [MAP]\n"
2460 " %1$s %2$s run PROG \\\n"
2461 " data_in FILE \\\n"
2462 " [data_out FILE [data_size_out L]] \\\n"
2463 " [ctx_in FILE [ctx_out FILE [ctx_size_out M]]] \\\n"
2465 " %1$s %2$s profile PROG [duration DURATION] METRICs\n"
2466 " %1$s %2$s tracelog\n"
2469 " " HELP_SPEC_MAP "\n"
2470 " " HELP_SPEC_PROGRAM "\n"
2471 " TYPE := { socket | kprobe | kretprobe | classifier | action |\n"
2472 " tracepoint | raw_tracepoint | xdp | perf_event | cgroup/skb |\n"
2473 " cgroup/sock | cgroup/dev | lwt_in | lwt_out | lwt_xmit |\n"
2474 " lwt_seg6local | sockops | sk_skb | sk_msg | lirc_mode2 |\n"
2475 " sk_reuseport | flow_dissector | cgroup/sysctl |\n"
2476 " cgroup/bind4 | cgroup/bind6 | cgroup/post_bind4 |\n"
2477 " cgroup/post_bind6 | cgroup/connect4 | cgroup/connect6 |\n"
2478 " cgroup/getpeername4 | cgroup/getpeername6 |\n"
2479 " cgroup/getsockname4 | cgroup/getsockname6 | cgroup/sendmsg4 |\n"
2480 " cgroup/sendmsg6 | cgroup/recvmsg4 | cgroup/recvmsg6 |\n"
2481 " cgroup/getsockopt | cgroup/setsockopt | cgroup/sock_release |\n"
2482 " struct_ops | fentry | fexit | freplace | sk_lookup }\n"
2483 " ATTACH_TYPE := { sk_msg_verdict | sk_skb_verdict | sk_skb_stream_verdict |\n"
2484 " sk_skb_stream_parser | flow_dissector }\n"
2485 " METRIC := { cycles | instructions | l1d_loads | llc_misses | itlb_misses | dtlb_misses }\n"
2486 " " HELP_SPEC_OPTIONS " |\n"
2487 " {-f|--bpffs} | {-m|--mapcompat} | {-n|--nomount} |\n"
2488 " {-L|--use-loader} }\n"
2490 bin_name, argv[-2]);
2495 static const struct cmd cmds[] = {
2496 { "show", do_show },
2497 { "list", do_show },
2498 { "help", do_help },
2499 { "dump", do_dump },
2501 { "load", do_load },
2502 { "loadall", do_loadall },
2503 { "attach", do_attach },
2504 { "detach", do_detach },
2505 { "tracelog", do_tracelog },
2507 { "profile", do_profile },
2511 int do_prog(int argc, char **argv)
2513 return cmd_select(cmds, argc, argv, do_help);