gpio: rcar: Fix runtime PM imbalance on error
[linux/fpc-iii.git] / tools / bpf / bpftool / prog.c
blobf6a5974a7b0aec20ae366ecb38132c5181e8ffdf
1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 /* Copyright (C) 2017-2018 Netronome Systems, Inc. */
4 #define _GNU_SOURCE
5 #include <errno.h>
6 #include <fcntl.h>
7 #include <signal.h>
8 #include <stdarg.h>
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <string.h>
12 #include <time.h>
13 #include <unistd.h>
14 #include <net/if.h>
15 #include <sys/ioctl.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18 #include <sys/syscall.h>
20 #include <linux/err.h>
21 #include <linux/perf_event.h>
22 #include <linux/sizes.h>
24 #include <bpf/bpf.h>
25 #include <bpf/btf.h>
26 #include <bpf/libbpf.h>
28 #include "cfg.h"
29 #include "main.h"
30 #include "xlated_dumper.h"
32 enum dump_mode {
33 DUMP_JITED,
34 DUMP_XLATED,
37 static const char * const attach_type_strings[] = {
38 [BPF_SK_SKB_STREAM_PARSER] = "stream_parser",
39 [BPF_SK_SKB_STREAM_VERDICT] = "stream_verdict",
40 [BPF_SK_MSG_VERDICT] = "msg_verdict",
41 [BPF_FLOW_DISSECTOR] = "flow_dissector",
42 [__MAX_BPF_ATTACH_TYPE] = NULL,
45 static enum bpf_attach_type parse_attach_type(const char *str)
47 enum bpf_attach_type type;
49 for (type = 0; type < __MAX_BPF_ATTACH_TYPE; type++) {
50 if (attach_type_strings[type] &&
51 is_prefix(str, attach_type_strings[type]))
52 return type;
55 return __MAX_BPF_ATTACH_TYPE;
58 static void print_boot_time(__u64 nsecs, char *buf, unsigned int size)
60 struct timespec real_time_ts, boot_time_ts;
61 time_t wallclock_secs;
62 struct tm load_tm;
64 buf[--size] = '\0';
66 if (clock_gettime(CLOCK_REALTIME, &real_time_ts) ||
67 clock_gettime(CLOCK_BOOTTIME, &boot_time_ts)) {
68 perror("Can't read clocks");
69 snprintf(buf, size, "%llu", nsecs / 1000000000);
70 return;
73 wallclock_secs = (real_time_ts.tv_sec - boot_time_ts.tv_sec) +
74 (real_time_ts.tv_nsec - boot_time_ts.tv_nsec + nsecs) /
75 1000000000;
78 if (!localtime_r(&wallclock_secs, &load_tm)) {
79 snprintf(buf, size, "%llu", nsecs / 1000000000);
80 return;
83 if (json_output)
84 strftime(buf, size, "%s", &load_tm);
85 else
86 strftime(buf, size, "%FT%T%z", &load_tm);
89 static int prog_fd_by_nametag(void *nametag, int **fds, bool tag)
91 unsigned int id = 0;
92 int fd, nb_fds = 0;
93 void *tmp;
94 int err;
96 while (true) {
97 struct bpf_prog_info info = {};
98 __u32 len = sizeof(info);
100 err = bpf_prog_get_next_id(id, &id);
101 if (err) {
102 if (errno != ENOENT) {
103 p_err("%s", strerror(errno));
104 goto err_close_fds;
106 return nb_fds;
109 fd = bpf_prog_get_fd_by_id(id);
110 if (fd < 0) {
111 p_err("can't get prog by id (%u): %s",
112 id, strerror(errno));
113 goto err_close_fds;
116 err = bpf_obj_get_info_by_fd(fd, &info, &len);
117 if (err) {
118 p_err("can't get prog info (%u): %s",
119 id, strerror(errno));
120 goto err_close_fd;
123 if ((tag && memcmp(nametag, info.tag, BPF_TAG_SIZE)) ||
124 (!tag && strncmp(nametag, info.name, BPF_OBJ_NAME_LEN))) {
125 close(fd);
126 continue;
129 if (nb_fds > 0) {
130 tmp = realloc(*fds, (nb_fds + 1) * sizeof(int));
131 if (!tmp) {
132 p_err("failed to realloc");
133 goto err_close_fd;
135 *fds = tmp;
137 (*fds)[nb_fds++] = fd;
140 err_close_fd:
141 close(fd);
142 err_close_fds:
143 while (--nb_fds >= 0)
144 close((*fds)[nb_fds]);
145 return -1;
148 static int prog_parse_fds(int *argc, char ***argv, int **fds)
150 if (is_prefix(**argv, "id")) {
151 unsigned int id;
152 char *endptr;
154 NEXT_ARGP();
156 id = strtoul(**argv, &endptr, 0);
157 if (*endptr) {
158 p_err("can't parse %s as ID", **argv);
159 return -1;
161 NEXT_ARGP();
163 (*fds)[0] = bpf_prog_get_fd_by_id(id);
164 if ((*fds)[0] < 0) {
165 p_err("get by id (%u): %s", id, strerror(errno));
166 return -1;
168 return 1;
169 } else if (is_prefix(**argv, "tag")) {
170 unsigned char tag[BPF_TAG_SIZE];
172 NEXT_ARGP();
174 if (sscanf(**argv, BPF_TAG_FMT, tag, tag + 1, tag + 2,
175 tag + 3, tag + 4, tag + 5, tag + 6, tag + 7)
176 != BPF_TAG_SIZE) {
177 p_err("can't parse tag");
178 return -1;
180 NEXT_ARGP();
182 return prog_fd_by_nametag(tag, fds, true);
183 } else if (is_prefix(**argv, "name")) {
184 char *name;
186 NEXT_ARGP();
188 name = **argv;
189 if (strlen(name) > BPF_OBJ_NAME_LEN - 1) {
190 p_err("can't parse name");
191 return -1;
193 NEXT_ARGP();
195 return prog_fd_by_nametag(name, fds, false);
196 } else if (is_prefix(**argv, "pinned")) {
197 char *path;
199 NEXT_ARGP();
201 path = **argv;
202 NEXT_ARGP();
204 (*fds)[0] = open_obj_pinned_any(path, BPF_OBJ_PROG);
205 if ((*fds)[0] < 0)
206 return -1;
207 return 1;
210 p_err("expected 'id', 'tag', 'name' or 'pinned', got: '%s'?", **argv);
211 return -1;
214 int prog_parse_fd(int *argc, char ***argv)
216 int *fds = NULL;
217 int nb_fds, fd;
219 fds = malloc(sizeof(int));
220 if (!fds) {
221 p_err("mem alloc failed");
222 return -1;
224 nb_fds = prog_parse_fds(argc, argv, &fds);
225 if (nb_fds != 1) {
226 if (nb_fds > 1) {
227 p_err("several programs match this handle");
228 while (nb_fds--)
229 close(fds[nb_fds]);
231 fd = -1;
232 goto exit_free;
235 fd = fds[0];
236 exit_free:
237 free(fds);
238 return fd;
241 static void show_prog_maps(int fd, u32 num_maps)
243 struct bpf_prog_info info = {};
244 __u32 len = sizeof(info);
245 __u32 map_ids[num_maps];
246 unsigned int i;
247 int err;
249 info.nr_map_ids = num_maps;
250 info.map_ids = ptr_to_u64(map_ids);
252 err = bpf_obj_get_info_by_fd(fd, &info, &len);
253 if (err || !info.nr_map_ids)
254 return;
256 if (json_output) {
257 jsonw_name(json_wtr, "map_ids");
258 jsonw_start_array(json_wtr);
259 for (i = 0; i < info.nr_map_ids; i++)
260 jsonw_uint(json_wtr, map_ids[i]);
261 jsonw_end_array(json_wtr);
262 } else {
263 printf(" map_ids ");
264 for (i = 0; i < info.nr_map_ids; i++)
265 printf("%u%s", map_ids[i],
266 i == info.nr_map_ids - 1 ? "" : ",");
270 static void print_prog_header_json(struct bpf_prog_info *info)
272 jsonw_uint_field(json_wtr, "id", info->id);
273 if (info->type < ARRAY_SIZE(prog_type_name))
274 jsonw_string_field(json_wtr, "type",
275 prog_type_name[info->type]);
276 else
277 jsonw_uint_field(json_wtr, "type", info->type);
279 if (*info->name)
280 jsonw_string_field(json_wtr, "name", info->name);
282 jsonw_name(json_wtr, "tag");
283 jsonw_printf(json_wtr, "\"" BPF_TAG_FMT "\"",
284 info->tag[0], info->tag[1], info->tag[2], info->tag[3],
285 info->tag[4], info->tag[5], info->tag[6], info->tag[7]);
287 jsonw_bool_field(json_wtr, "gpl_compatible", info->gpl_compatible);
288 if (info->run_time_ns) {
289 jsonw_uint_field(json_wtr, "run_time_ns", info->run_time_ns);
290 jsonw_uint_field(json_wtr, "run_cnt", info->run_cnt);
294 static void print_prog_json(struct bpf_prog_info *info, int fd)
296 char *memlock;
298 jsonw_start_object(json_wtr);
299 print_prog_header_json(info);
300 print_dev_json(info->ifindex, info->netns_dev, info->netns_ino);
302 if (info->load_time) {
303 char buf[32];
305 print_boot_time(info->load_time, buf, sizeof(buf));
307 /* Piggy back on load_time, since 0 uid is a valid one */
308 jsonw_name(json_wtr, "loaded_at");
309 jsonw_printf(json_wtr, "%s", buf);
310 jsonw_uint_field(json_wtr, "uid", info->created_by_uid);
313 jsonw_uint_field(json_wtr, "bytes_xlated", info->xlated_prog_len);
315 if (info->jited_prog_len) {
316 jsonw_bool_field(json_wtr, "jited", true);
317 jsonw_uint_field(json_wtr, "bytes_jited", info->jited_prog_len);
318 } else {
319 jsonw_bool_field(json_wtr, "jited", false);
322 memlock = get_fdinfo(fd, "memlock");
323 if (memlock)
324 jsonw_int_field(json_wtr, "bytes_memlock", atoi(memlock));
325 free(memlock);
327 if (info->nr_map_ids)
328 show_prog_maps(fd, info->nr_map_ids);
330 if (info->btf_id)
331 jsonw_int_field(json_wtr, "btf_id", info->btf_id);
333 if (!hash_empty(prog_table.table)) {
334 struct pinned_obj *obj;
336 jsonw_name(json_wtr, "pinned");
337 jsonw_start_array(json_wtr);
338 hash_for_each_possible(prog_table.table, obj, hash, info->id) {
339 if (obj->id == info->id)
340 jsonw_string(json_wtr, obj->path);
342 jsonw_end_array(json_wtr);
345 jsonw_end_object(json_wtr);
348 static void print_prog_header_plain(struct bpf_prog_info *info)
350 printf("%u: ", info->id);
351 if (info->type < ARRAY_SIZE(prog_type_name))
352 printf("%s ", prog_type_name[info->type]);
353 else
354 printf("type %u ", info->type);
356 if (*info->name)
357 printf("name %s ", info->name);
359 printf("tag ");
360 fprint_hex(stdout, info->tag, BPF_TAG_SIZE, "");
361 print_dev_plain(info->ifindex, info->netns_dev, info->netns_ino);
362 printf("%s", info->gpl_compatible ? " gpl" : "");
363 if (info->run_time_ns)
364 printf(" run_time_ns %lld run_cnt %lld",
365 info->run_time_ns, info->run_cnt);
366 printf("\n");
369 static void print_prog_plain(struct bpf_prog_info *info, int fd)
371 char *memlock;
373 print_prog_header_plain(info);
375 if (info->load_time) {
376 char buf[32];
378 print_boot_time(info->load_time, buf, sizeof(buf));
380 /* Piggy back on load_time, since 0 uid is a valid one */
381 printf("\tloaded_at %s uid %u\n", buf, info->created_by_uid);
384 printf("\txlated %uB", info->xlated_prog_len);
386 if (info->jited_prog_len)
387 printf(" jited %uB", info->jited_prog_len);
388 else
389 printf(" not jited");
391 memlock = get_fdinfo(fd, "memlock");
392 if (memlock)
393 printf(" memlock %sB", memlock);
394 free(memlock);
396 if (info->nr_map_ids)
397 show_prog_maps(fd, info->nr_map_ids);
399 if (!hash_empty(prog_table.table)) {
400 struct pinned_obj *obj;
402 hash_for_each_possible(prog_table.table, obj, hash, info->id) {
403 if (obj->id == info->id)
404 printf("\n\tpinned %s", obj->path);
408 if (info->btf_id)
409 printf("\n\tbtf_id %d", info->btf_id);
411 printf("\n");
414 static int show_prog(int fd)
416 struct bpf_prog_info info = {};
417 __u32 len = sizeof(info);
418 int err;
420 err = bpf_obj_get_info_by_fd(fd, &info, &len);
421 if (err) {
422 p_err("can't get prog info: %s", strerror(errno));
423 return -1;
426 if (json_output)
427 print_prog_json(&info, fd);
428 else
429 print_prog_plain(&info, fd);
431 return 0;
434 static int do_show_subset(int argc, char **argv)
436 int *fds = NULL;
437 int nb_fds, i;
438 int err = -1;
440 fds = malloc(sizeof(int));
441 if (!fds) {
442 p_err("mem alloc failed");
443 return -1;
445 nb_fds = prog_parse_fds(&argc, &argv, &fds);
446 if (nb_fds < 1)
447 goto exit_free;
449 if (json_output && nb_fds > 1)
450 jsonw_start_array(json_wtr); /* root array */
451 for (i = 0; i < nb_fds; i++) {
452 err = show_prog(fds[i]);
453 if (err) {
454 for (; i < nb_fds; i++)
455 close(fds[i]);
456 break;
458 close(fds[i]);
460 if (json_output && nb_fds > 1)
461 jsonw_end_array(json_wtr); /* root array */
463 exit_free:
464 free(fds);
465 return err;
468 static int do_show(int argc, char **argv)
470 __u32 id = 0;
471 int err;
472 int fd;
474 if (show_pinned)
475 build_pinned_obj_table(&prog_table, BPF_OBJ_PROG);
477 if (argc == 2)
478 return do_show_subset(argc, argv);
480 if (argc)
481 return BAD_ARG();
483 if (json_output)
484 jsonw_start_array(json_wtr);
485 while (true) {
486 err = bpf_prog_get_next_id(id, &id);
487 if (err) {
488 if (errno == ENOENT) {
489 err = 0;
490 break;
492 p_err("can't get next program: %s%s", strerror(errno),
493 errno == EINVAL ? " -- kernel too old?" : "");
494 err = -1;
495 break;
498 fd = bpf_prog_get_fd_by_id(id);
499 if (fd < 0) {
500 if (errno == ENOENT)
501 continue;
502 p_err("can't get prog by id (%u): %s",
503 id, strerror(errno));
504 err = -1;
505 break;
508 err = show_prog(fd);
509 close(fd);
510 if (err)
511 break;
514 if (json_output)
515 jsonw_end_array(json_wtr);
517 return err;
520 static int
521 prog_dump(struct bpf_prog_info *info, enum dump_mode mode,
522 char *filepath, bool opcodes, bool visual, bool linum)
524 struct bpf_prog_linfo *prog_linfo = NULL;
525 const char *disasm_opt = NULL;
526 struct dump_data dd = {};
527 void *func_info = NULL;
528 struct btf *btf = NULL;
529 char func_sig[1024];
530 unsigned char *buf;
531 __u32 member_len;
532 ssize_t n;
533 int fd;
535 if (mode == DUMP_JITED) {
536 if (info->jited_prog_len == 0 || !info->jited_prog_insns) {
537 p_info("no instructions returned");
538 return -1;
540 buf = (unsigned char *)(info->jited_prog_insns);
541 member_len = info->jited_prog_len;
542 } else { /* DUMP_XLATED */
543 if (info->xlated_prog_len == 0 || !info->xlated_prog_insns) {
544 p_err("error retrieving insn dump: kernel.kptr_restrict set?");
545 return -1;
547 buf = (unsigned char *)info->xlated_prog_insns;
548 member_len = info->xlated_prog_len;
551 if (info->btf_id && btf__get_from_id(info->btf_id, &btf)) {
552 p_err("failed to get btf");
553 return -1;
556 func_info = (void *)info->func_info;
558 if (info->nr_line_info) {
559 prog_linfo = bpf_prog_linfo__new(info);
560 if (!prog_linfo)
561 p_info("error in processing bpf_line_info. continue without it.");
564 if (filepath) {
565 fd = open(filepath, O_WRONLY | O_CREAT | O_TRUNC, 0600);
566 if (fd < 0) {
567 p_err("can't open file %s: %s", filepath,
568 strerror(errno));
569 return -1;
572 n = write(fd, buf, member_len);
573 close(fd);
574 if (n != member_len) {
575 p_err("error writing output file: %s",
576 n < 0 ? strerror(errno) : "short write");
577 return -1;
580 if (json_output)
581 jsonw_null(json_wtr);
582 } else if (mode == DUMP_JITED) {
583 const char *name = NULL;
585 if (info->ifindex) {
586 name = ifindex_to_bfd_params(info->ifindex,
587 info->netns_dev,
588 info->netns_ino,
589 &disasm_opt);
590 if (!name)
591 return -1;
594 if (info->nr_jited_func_lens && info->jited_func_lens) {
595 struct kernel_sym *sym = NULL;
596 struct bpf_func_info *record;
597 char sym_name[SYM_MAX_NAME];
598 unsigned char *img = buf;
599 __u64 *ksyms = NULL;
600 __u32 *lens;
601 __u32 i;
602 if (info->nr_jited_ksyms) {
603 kernel_syms_load(&dd);
604 ksyms = (__u64 *) info->jited_ksyms;
607 if (json_output)
608 jsonw_start_array(json_wtr);
610 lens = (__u32 *) info->jited_func_lens;
611 for (i = 0; i < info->nr_jited_func_lens; i++) {
612 if (ksyms) {
613 sym = kernel_syms_search(&dd, ksyms[i]);
614 if (sym)
615 sprintf(sym_name, "%s", sym->name);
616 else
617 sprintf(sym_name, "0x%016llx", ksyms[i]);
618 } else {
619 strcpy(sym_name, "unknown");
622 if (func_info) {
623 record = func_info + i * info->func_info_rec_size;
624 btf_dumper_type_only(btf, record->type_id,
625 func_sig,
626 sizeof(func_sig));
629 if (json_output) {
630 jsonw_start_object(json_wtr);
631 if (func_info && func_sig[0] != '\0') {
632 jsonw_name(json_wtr, "proto");
633 jsonw_string(json_wtr, func_sig);
635 jsonw_name(json_wtr, "name");
636 jsonw_string(json_wtr, sym_name);
637 jsonw_name(json_wtr, "insns");
638 } else {
639 if (func_info && func_sig[0] != '\0')
640 printf("%s:\n", func_sig);
641 printf("%s:\n", sym_name);
644 disasm_print_insn(img, lens[i], opcodes,
645 name, disasm_opt, btf,
646 prog_linfo, ksyms[i], i,
647 linum);
649 img += lens[i];
651 if (json_output)
652 jsonw_end_object(json_wtr);
653 else
654 printf("\n");
657 if (json_output)
658 jsonw_end_array(json_wtr);
659 } else {
660 disasm_print_insn(buf, member_len, opcodes, name,
661 disasm_opt, btf, NULL, 0, 0, false);
663 } else if (visual) {
664 if (json_output)
665 jsonw_null(json_wtr);
666 else
667 dump_xlated_cfg(buf, member_len);
668 } else {
669 kernel_syms_load(&dd);
670 dd.nr_jited_ksyms = info->nr_jited_ksyms;
671 dd.jited_ksyms = (__u64 *) info->jited_ksyms;
672 dd.btf = btf;
673 dd.func_info = func_info;
674 dd.finfo_rec_size = info->func_info_rec_size;
675 dd.prog_linfo = prog_linfo;
677 if (json_output)
678 dump_xlated_json(&dd, buf, member_len, opcodes,
679 linum);
680 else
681 dump_xlated_plain(&dd, buf, member_len, opcodes,
682 linum);
683 kernel_syms_destroy(&dd);
686 return 0;
689 static int do_dump(int argc, char **argv)
691 struct bpf_prog_info_linear *info_linear;
692 char *filepath = NULL;
693 bool opcodes = false;
694 bool visual = false;
695 enum dump_mode mode;
696 bool linum = false;
697 int *fds = NULL;
698 int nb_fds, i = 0;
699 int err = -1;
700 __u64 arrays;
702 if (is_prefix(*argv, "jited")) {
703 if (disasm_init())
704 return -1;
705 mode = DUMP_JITED;
706 } else if (is_prefix(*argv, "xlated")) {
707 mode = DUMP_XLATED;
708 } else {
709 p_err("expected 'xlated' or 'jited', got: %s", *argv);
710 return -1;
712 NEXT_ARG();
714 if (argc < 2)
715 usage();
717 fds = malloc(sizeof(int));
718 if (!fds) {
719 p_err("mem alloc failed");
720 return -1;
722 nb_fds = prog_parse_fds(&argc, &argv, &fds);
723 if (nb_fds < 1)
724 goto exit_free;
726 if (is_prefix(*argv, "file")) {
727 NEXT_ARG();
728 if (!argc) {
729 p_err("expected file path");
730 goto exit_close;
732 if (nb_fds > 1) {
733 p_err("several programs matched");
734 goto exit_close;
737 filepath = *argv;
738 NEXT_ARG();
739 } else if (is_prefix(*argv, "opcodes")) {
740 opcodes = true;
741 NEXT_ARG();
742 } else if (is_prefix(*argv, "visual")) {
743 if (nb_fds > 1) {
744 p_err("several programs matched");
745 goto exit_close;
748 visual = true;
749 NEXT_ARG();
750 } else if (is_prefix(*argv, "linum")) {
751 linum = true;
752 NEXT_ARG();
755 if (argc) {
756 usage();
757 goto exit_close;
760 if (mode == DUMP_JITED)
761 arrays = 1UL << BPF_PROG_INFO_JITED_INSNS;
762 else
763 arrays = 1UL << BPF_PROG_INFO_XLATED_INSNS;
765 arrays |= 1UL << BPF_PROG_INFO_JITED_KSYMS;
766 arrays |= 1UL << BPF_PROG_INFO_JITED_FUNC_LENS;
767 arrays |= 1UL << BPF_PROG_INFO_FUNC_INFO;
768 arrays |= 1UL << BPF_PROG_INFO_LINE_INFO;
769 arrays |= 1UL << BPF_PROG_INFO_JITED_LINE_INFO;
771 if (json_output && nb_fds > 1)
772 jsonw_start_array(json_wtr); /* root array */
773 for (i = 0; i < nb_fds; i++) {
774 info_linear = bpf_program__get_prog_info_linear(fds[i], arrays);
775 if (IS_ERR_OR_NULL(info_linear)) {
776 p_err("can't get prog info: %s", strerror(errno));
777 break;
780 if (json_output && nb_fds > 1) {
781 jsonw_start_object(json_wtr); /* prog object */
782 print_prog_header_json(&info_linear->info);
783 jsonw_name(json_wtr, "insns");
784 } else if (nb_fds > 1) {
785 print_prog_header_plain(&info_linear->info);
788 err = prog_dump(&info_linear->info, mode, filepath, opcodes,
789 visual, linum);
791 if (json_output && nb_fds > 1)
792 jsonw_end_object(json_wtr); /* prog object */
793 else if (i != nb_fds - 1 && nb_fds > 1)
794 printf("\n");
796 free(info_linear);
797 if (err)
798 break;
799 close(fds[i]);
801 if (json_output && nb_fds > 1)
802 jsonw_end_array(json_wtr); /* root array */
804 exit_close:
805 for (; i < nb_fds; i++)
806 close(fds[i]);
807 exit_free:
808 free(fds);
809 return err;
812 static int do_pin(int argc, char **argv)
814 int err;
816 err = do_pin_any(argc, argv, prog_parse_fd);
817 if (!err && json_output)
818 jsonw_null(json_wtr);
819 return err;
822 struct map_replace {
823 int idx;
824 int fd;
825 char *name;
828 static int map_replace_compar(const void *p1, const void *p2)
830 const struct map_replace *a = p1, *b = p2;
832 return a->idx - b->idx;
835 static int parse_attach_detach_args(int argc, char **argv, int *progfd,
836 enum bpf_attach_type *attach_type,
837 int *mapfd)
839 if (!REQ_ARGS(3))
840 return -EINVAL;
842 *progfd = prog_parse_fd(&argc, &argv);
843 if (*progfd < 0)
844 return *progfd;
846 *attach_type = parse_attach_type(*argv);
847 if (*attach_type == __MAX_BPF_ATTACH_TYPE) {
848 p_err("invalid attach/detach type");
849 return -EINVAL;
852 if (*attach_type == BPF_FLOW_DISSECTOR) {
853 *mapfd = -1;
854 return 0;
857 NEXT_ARG();
858 if (!REQ_ARGS(2))
859 return -EINVAL;
861 *mapfd = map_parse_fd(&argc, &argv);
862 if (*mapfd < 0)
863 return *mapfd;
865 return 0;
868 static int do_attach(int argc, char **argv)
870 enum bpf_attach_type attach_type;
871 int err, progfd;
872 int mapfd;
874 err = parse_attach_detach_args(argc, argv,
875 &progfd, &attach_type, &mapfd);
876 if (err)
877 return err;
879 err = bpf_prog_attach(progfd, mapfd, attach_type, 0);
880 if (err) {
881 p_err("failed prog attach to map");
882 return -EINVAL;
885 if (json_output)
886 jsonw_null(json_wtr);
887 return 0;
890 static int do_detach(int argc, char **argv)
892 enum bpf_attach_type attach_type;
893 int err, progfd;
894 int mapfd;
896 err = parse_attach_detach_args(argc, argv,
897 &progfd, &attach_type, &mapfd);
898 if (err)
899 return err;
901 err = bpf_prog_detach2(progfd, mapfd, attach_type);
902 if (err) {
903 p_err("failed prog detach from map");
904 return -EINVAL;
907 if (json_output)
908 jsonw_null(json_wtr);
909 return 0;
912 static int check_single_stdin(char *file_data_in, char *file_ctx_in)
914 if (file_data_in && file_ctx_in &&
915 !strcmp(file_data_in, "-") && !strcmp(file_ctx_in, "-")) {
916 p_err("cannot use standard input for both data_in and ctx_in");
917 return -1;
920 return 0;
923 static int get_run_data(const char *fname, void **data_ptr, unsigned int *size)
925 size_t block_size = 256;
926 size_t buf_size = block_size;
927 size_t nb_read = 0;
928 void *tmp;
929 FILE *f;
931 if (!fname) {
932 *data_ptr = NULL;
933 *size = 0;
934 return 0;
937 if (!strcmp(fname, "-"))
938 f = stdin;
939 else
940 f = fopen(fname, "r");
941 if (!f) {
942 p_err("failed to open %s: %s", fname, strerror(errno));
943 return -1;
946 *data_ptr = malloc(block_size);
947 if (!*data_ptr) {
948 p_err("failed to allocate memory for data_in/ctx_in: %s",
949 strerror(errno));
950 goto err_fclose;
953 while ((nb_read += fread(*data_ptr + nb_read, 1, block_size, f))) {
954 if (feof(f))
955 break;
956 if (ferror(f)) {
957 p_err("failed to read data_in/ctx_in from %s: %s",
958 fname, strerror(errno));
959 goto err_free;
961 if (nb_read > buf_size - block_size) {
962 if (buf_size == UINT32_MAX) {
963 p_err("data_in/ctx_in is too long (max: %d)",
964 UINT32_MAX);
965 goto err_free;
967 /* No space for fread()-ing next chunk; realloc() */
968 buf_size *= 2;
969 tmp = realloc(*data_ptr, buf_size);
970 if (!tmp) {
971 p_err("failed to reallocate data_in/ctx_in: %s",
972 strerror(errno));
973 goto err_free;
975 *data_ptr = tmp;
978 if (f != stdin)
979 fclose(f);
981 *size = nb_read;
982 return 0;
984 err_free:
985 free(*data_ptr);
986 *data_ptr = NULL;
987 err_fclose:
988 if (f != stdin)
989 fclose(f);
990 return -1;
993 static void hex_print(void *data, unsigned int size, FILE *f)
995 size_t i, j;
996 char c;
998 for (i = 0; i < size; i += 16) {
999 /* Row offset */
1000 fprintf(f, "%07zx\t", i);
1002 /* Hexadecimal values */
1003 for (j = i; j < i + 16 && j < size; j++)
1004 fprintf(f, "%02x%s", *(uint8_t *)(data + j),
1005 j % 2 ? " " : "");
1006 for (; j < i + 16; j++)
1007 fprintf(f, " %s", j % 2 ? " " : "");
1009 /* ASCII values (if relevant), '.' otherwise */
1010 fprintf(f, "| ");
1011 for (j = i; j < i + 16 && j < size; j++) {
1012 c = *(char *)(data + j);
1013 if (c < ' ' || c > '~')
1014 c = '.';
1015 fprintf(f, "%c%s", c, j == i + 7 ? " " : "");
1018 fprintf(f, "\n");
1022 static int
1023 print_run_output(void *data, unsigned int size, const char *fname,
1024 const char *json_key)
1026 size_t nb_written;
1027 FILE *f;
1029 if (!fname)
1030 return 0;
1032 if (!strcmp(fname, "-")) {
1033 f = stdout;
1034 if (json_output) {
1035 jsonw_name(json_wtr, json_key);
1036 print_data_json(data, size);
1037 } else {
1038 hex_print(data, size, f);
1040 return 0;
1043 f = fopen(fname, "w");
1044 if (!f) {
1045 p_err("failed to open %s: %s", fname, strerror(errno));
1046 return -1;
1049 nb_written = fwrite(data, 1, size, f);
1050 fclose(f);
1051 if (nb_written != size) {
1052 p_err("failed to write output data/ctx: %s", strerror(errno));
1053 return -1;
1056 return 0;
1059 static int alloc_run_data(void **data_ptr, unsigned int size_out)
1061 *data_ptr = calloc(size_out, 1);
1062 if (!*data_ptr) {
1063 p_err("failed to allocate memory for output data/ctx: %s",
1064 strerror(errno));
1065 return -1;
1068 return 0;
1071 static int do_run(int argc, char **argv)
1073 char *data_fname_in = NULL, *data_fname_out = NULL;
1074 char *ctx_fname_in = NULL, *ctx_fname_out = NULL;
1075 struct bpf_prog_test_run_attr test_attr = {0};
1076 const unsigned int default_size = SZ_32K;
1077 void *data_in = NULL, *data_out = NULL;
1078 void *ctx_in = NULL, *ctx_out = NULL;
1079 unsigned int repeat = 1;
1080 int fd, err;
1082 if (!REQ_ARGS(4))
1083 return -1;
1085 fd = prog_parse_fd(&argc, &argv);
1086 if (fd < 0)
1087 return -1;
1089 while (argc) {
1090 if (detect_common_prefix(*argv, "data_in", "data_out",
1091 "data_size_out", NULL))
1092 return -1;
1093 if (detect_common_prefix(*argv, "ctx_in", "ctx_out",
1094 "ctx_size_out", NULL))
1095 return -1;
1097 if (is_prefix(*argv, "data_in")) {
1098 NEXT_ARG();
1099 if (!REQ_ARGS(1))
1100 return -1;
1102 data_fname_in = GET_ARG();
1103 if (check_single_stdin(data_fname_in, ctx_fname_in))
1104 return -1;
1105 } else if (is_prefix(*argv, "data_out")) {
1106 NEXT_ARG();
1107 if (!REQ_ARGS(1))
1108 return -1;
1110 data_fname_out = GET_ARG();
1111 } else if (is_prefix(*argv, "data_size_out")) {
1112 char *endptr;
1114 NEXT_ARG();
1115 if (!REQ_ARGS(1))
1116 return -1;
1118 test_attr.data_size_out = strtoul(*argv, &endptr, 0);
1119 if (*endptr) {
1120 p_err("can't parse %s as output data size",
1121 *argv);
1122 return -1;
1124 NEXT_ARG();
1125 } else if (is_prefix(*argv, "ctx_in")) {
1126 NEXT_ARG();
1127 if (!REQ_ARGS(1))
1128 return -1;
1130 ctx_fname_in = GET_ARG();
1131 if (check_single_stdin(data_fname_in, ctx_fname_in))
1132 return -1;
1133 } else if (is_prefix(*argv, "ctx_out")) {
1134 NEXT_ARG();
1135 if (!REQ_ARGS(1))
1136 return -1;
1138 ctx_fname_out = GET_ARG();
1139 } else if (is_prefix(*argv, "ctx_size_out")) {
1140 char *endptr;
1142 NEXT_ARG();
1143 if (!REQ_ARGS(1))
1144 return -1;
1146 test_attr.ctx_size_out = strtoul(*argv, &endptr, 0);
1147 if (*endptr) {
1148 p_err("can't parse %s as output context size",
1149 *argv);
1150 return -1;
1152 NEXT_ARG();
1153 } else if (is_prefix(*argv, "repeat")) {
1154 char *endptr;
1156 NEXT_ARG();
1157 if (!REQ_ARGS(1))
1158 return -1;
1160 repeat = strtoul(*argv, &endptr, 0);
1161 if (*endptr) {
1162 p_err("can't parse %s as repeat number",
1163 *argv);
1164 return -1;
1166 NEXT_ARG();
1167 } else {
1168 p_err("expected no more arguments, 'data_in', 'data_out', 'data_size_out', 'ctx_in', 'ctx_out', 'ctx_size_out' or 'repeat', got: '%s'?",
1169 *argv);
1170 return -1;
1174 err = get_run_data(data_fname_in, &data_in, &test_attr.data_size_in);
1175 if (err)
1176 return -1;
1178 if (data_in) {
1179 if (!test_attr.data_size_out)
1180 test_attr.data_size_out = default_size;
1181 err = alloc_run_data(&data_out, test_attr.data_size_out);
1182 if (err)
1183 goto free_data_in;
1186 err = get_run_data(ctx_fname_in, &ctx_in, &test_attr.ctx_size_in);
1187 if (err)
1188 goto free_data_out;
1190 if (ctx_in) {
1191 if (!test_attr.ctx_size_out)
1192 test_attr.ctx_size_out = default_size;
1193 err = alloc_run_data(&ctx_out, test_attr.ctx_size_out);
1194 if (err)
1195 goto free_ctx_in;
1198 test_attr.prog_fd = fd;
1199 test_attr.repeat = repeat;
1200 test_attr.data_in = data_in;
1201 test_attr.data_out = data_out;
1202 test_attr.ctx_in = ctx_in;
1203 test_attr.ctx_out = ctx_out;
1205 err = bpf_prog_test_run_xattr(&test_attr);
1206 if (err) {
1207 p_err("failed to run program: %s", strerror(errno));
1208 goto free_ctx_out;
1211 err = 0;
1213 if (json_output)
1214 jsonw_start_object(json_wtr); /* root */
1216 /* Do not exit on errors occurring when printing output data/context,
1217 * we still want to print return value and duration for program run.
1219 if (test_attr.data_size_out)
1220 err += print_run_output(test_attr.data_out,
1221 test_attr.data_size_out,
1222 data_fname_out, "data_out");
1223 if (test_attr.ctx_size_out)
1224 err += print_run_output(test_attr.ctx_out,
1225 test_attr.ctx_size_out,
1226 ctx_fname_out, "ctx_out");
1228 if (json_output) {
1229 jsonw_uint_field(json_wtr, "retval", test_attr.retval);
1230 jsonw_uint_field(json_wtr, "duration", test_attr.duration);
1231 jsonw_end_object(json_wtr); /* root */
1232 } else {
1233 fprintf(stdout, "Return value: %u, duration%s: %uns\n",
1234 test_attr.retval,
1235 repeat > 1 ? " (average)" : "", test_attr.duration);
1238 free_ctx_out:
1239 free(ctx_out);
1240 free_ctx_in:
1241 free(ctx_in);
1242 free_data_out:
1243 free(data_out);
1244 free_data_in:
1245 free(data_in);
1247 return err;
1250 static int
1251 get_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
1252 enum bpf_attach_type *expected_attach_type)
1254 libbpf_print_fn_t print_backup;
1255 int ret;
1257 ret = libbpf_prog_type_by_name(name, prog_type, expected_attach_type);
1258 if (!ret)
1259 return ret;
1261 /* libbpf_prog_type_by_name() failed, let's re-run with debug level */
1262 print_backup = libbpf_set_print(print_all_levels);
1263 ret = libbpf_prog_type_by_name(name, prog_type, expected_attach_type);
1264 libbpf_set_print(print_backup);
1266 return ret;
1269 static int load_with_options(int argc, char **argv, bool first_prog_only)
1271 enum bpf_prog_type common_prog_type = BPF_PROG_TYPE_UNSPEC;
1272 DECLARE_LIBBPF_OPTS(bpf_object_open_opts, open_opts,
1273 .relaxed_maps = relaxed_maps,
1275 struct bpf_object_load_attr load_attr = { 0 };
1276 enum bpf_attach_type expected_attach_type;
1277 struct map_replace *map_replace = NULL;
1278 struct bpf_program *prog = NULL, *pos;
1279 unsigned int old_map_fds = 0;
1280 const char *pinmaps = NULL;
1281 struct bpf_object *obj;
1282 struct bpf_map *map;
1283 const char *pinfile;
1284 unsigned int i, j;
1285 __u32 ifindex = 0;
1286 const char *file;
1287 int idx, err;
1290 if (!REQ_ARGS(2))
1291 return -1;
1292 file = GET_ARG();
1293 pinfile = GET_ARG();
1295 while (argc) {
1296 if (is_prefix(*argv, "type")) {
1297 char *type;
1299 NEXT_ARG();
1301 if (common_prog_type != BPF_PROG_TYPE_UNSPEC) {
1302 p_err("program type already specified");
1303 goto err_free_reuse_maps;
1305 if (!REQ_ARGS(1))
1306 goto err_free_reuse_maps;
1308 /* Put a '/' at the end of type to appease libbpf */
1309 type = malloc(strlen(*argv) + 2);
1310 if (!type) {
1311 p_err("mem alloc failed");
1312 goto err_free_reuse_maps;
1314 *type = 0;
1315 strcat(type, *argv);
1316 strcat(type, "/");
1318 err = get_prog_type_by_name(type, &common_prog_type,
1319 &expected_attach_type);
1320 free(type);
1321 if (err < 0)
1322 goto err_free_reuse_maps;
1324 NEXT_ARG();
1325 } else if (is_prefix(*argv, "map")) {
1326 void *new_map_replace;
1327 char *endptr, *name;
1328 int fd;
1330 NEXT_ARG();
1332 if (!REQ_ARGS(4))
1333 goto err_free_reuse_maps;
1335 if (is_prefix(*argv, "idx")) {
1336 NEXT_ARG();
1338 idx = strtoul(*argv, &endptr, 0);
1339 if (*endptr) {
1340 p_err("can't parse %s as IDX", *argv);
1341 goto err_free_reuse_maps;
1343 name = NULL;
1344 } else if (is_prefix(*argv, "name")) {
1345 NEXT_ARG();
1347 name = *argv;
1348 idx = -1;
1349 } else {
1350 p_err("expected 'idx' or 'name', got: '%s'?",
1351 *argv);
1352 goto err_free_reuse_maps;
1354 NEXT_ARG();
1356 fd = map_parse_fd(&argc, &argv);
1357 if (fd < 0)
1358 goto err_free_reuse_maps;
1360 new_map_replace = reallocarray(map_replace,
1361 old_map_fds + 1,
1362 sizeof(*map_replace));
1363 if (!new_map_replace) {
1364 p_err("mem alloc failed");
1365 goto err_free_reuse_maps;
1367 map_replace = new_map_replace;
1369 map_replace[old_map_fds].idx = idx;
1370 map_replace[old_map_fds].name = name;
1371 map_replace[old_map_fds].fd = fd;
1372 old_map_fds++;
1373 } else if (is_prefix(*argv, "dev")) {
1374 NEXT_ARG();
1376 if (ifindex) {
1377 p_err("offload device already specified");
1378 goto err_free_reuse_maps;
1380 if (!REQ_ARGS(1))
1381 goto err_free_reuse_maps;
1383 ifindex = if_nametoindex(*argv);
1384 if (!ifindex) {
1385 p_err("unrecognized netdevice '%s': %s",
1386 *argv, strerror(errno));
1387 goto err_free_reuse_maps;
1389 NEXT_ARG();
1390 } else if (is_prefix(*argv, "pinmaps")) {
1391 NEXT_ARG();
1393 if (!REQ_ARGS(1))
1394 goto err_free_reuse_maps;
1396 pinmaps = GET_ARG();
1397 } else {
1398 p_err("expected no more arguments, 'type', 'map' or 'dev', got: '%s'?",
1399 *argv);
1400 goto err_free_reuse_maps;
1404 set_max_rlimit();
1406 obj = bpf_object__open_file(file, &open_opts);
1407 if (IS_ERR_OR_NULL(obj)) {
1408 p_err("failed to open object file");
1409 goto err_free_reuse_maps;
1412 bpf_object__for_each_program(pos, obj) {
1413 enum bpf_prog_type prog_type = common_prog_type;
1415 if (prog_type == BPF_PROG_TYPE_UNSPEC) {
1416 const char *sec_name = bpf_program__title(pos, false);
1418 err = get_prog_type_by_name(sec_name, &prog_type,
1419 &expected_attach_type);
1420 if (err < 0)
1421 goto err_close_obj;
1424 bpf_program__set_ifindex(pos, ifindex);
1425 bpf_program__set_type(pos, prog_type);
1426 bpf_program__set_expected_attach_type(pos, expected_attach_type);
1429 qsort(map_replace, old_map_fds, sizeof(*map_replace),
1430 map_replace_compar);
1432 /* After the sort maps by name will be first on the list, because they
1433 * have idx == -1. Resolve them.
1435 j = 0;
1436 while (j < old_map_fds && map_replace[j].name) {
1437 i = 0;
1438 bpf_object__for_each_map(map, obj) {
1439 if (!strcmp(bpf_map__name(map), map_replace[j].name)) {
1440 map_replace[j].idx = i;
1441 break;
1443 i++;
1445 if (map_replace[j].idx == -1) {
1446 p_err("unable to find map '%s'", map_replace[j].name);
1447 goto err_close_obj;
1449 j++;
1451 /* Resort if any names were resolved */
1452 if (j)
1453 qsort(map_replace, old_map_fds, sizeof(*map_replace),
1454 map_replace_compar);
1456 /* Set ifindex and name reuse */
1457 j = 0;
1458 idx = 0;
1459 bpf_object__for_each_map(map, obj) {
1460 if (!bpf_map__is_offload_neutral(map))
1461 bpf_map__set_ifindex(map, ifindex);
1463 if (j < old_map_fds && idx == map_replace[j].idx) {
1464 err = bpf_map__reuse_fd(map, map_replace[j++].fd);
1465 if (err) {
1466 p_err("unable to set up map reuse: %d", err);
1467 goto err_close_obj;
1470 /* Next reuse wants to apply to the same map */
1471 if (j < old_map_fds && map_replace[j].idx == idx) {
1472 p_err("replacement for map idx %d specified more than once",
1473 idx);
1474 goto err_close_obj;
1478 idx++;
1480 if (j < old_map_fds) {
1481 p_err("map idx '%d' not used", map_replace[j].idx);
1482 goto err_close_obj;
1485 load_attr.obj = obj;
1486 if (verifier_logs)
1487 /* log_level1 + log_level2 + stats, but not stable UAPI */
1488 load_attr.log_level = 1 + 2 + 4;
1490 err = bpf_object__load_xattr(&load_attr);
1491 if (err) {
1492 p_err("failed to load object file");
1493 goto err_close_obj;
1496 err = mount_bpffs_for_pin(pinfile);
1497 if (err)
1498 goto err_close_obj;
1500 if (first_prog_only) {
1501 prog = bpf_program__next(NULL, obj);
1502 if (!prog) {
1503 p_err("object file doesn't contain any bpf program");
1504 goto err_close_obj;
1507 err = bpf_obj_pin(bpf_program__fd(prog), pinfile);
1508 if (err) {
1509 p_err("failed to pin program %s",
1510 bpf_program__title(prog, false));
1511 goto err_close_obj;
1513 } else {
1514 err = bpf_object__pin_programs(obj, pinfile);
1515 if (err) {
1516 p_err("failed to pin all programs");
1517 goto err_close_obj;
1521 if (pinmaps) {
1522 err = bpf_object__pin_maps(obj, pinmaps);
1523 if (err) {
1524 p_err("failed to pin all maps");
1525 goto err_unpin;
1529 if (json_output)
1530 jsonw_null(json_wtr);
1532 bpf_object__close(obj);
1533 for (i = 0; i < old_map_fds; i++)
1534 close(map_replace[i].fd);
1535 free(map_replace);
1537 return 0;
1539 err_unpin:
1540 if (first_prog_only)
1541 unlink(pinfile);
1542 else
1543 bpf_object__unpin_programs(obj, pinfile);
1544 err_close_obj:
1545 bpf_object__close(obj);
1546 err_free_reuse_maps:
1547 for (i = 0; i < old_map_fds; i++)
1548 close(map_replace[i].fd);
1549 free(map_replace);
1550 return -1;
1553 static int do_load(int argc, char **argv)
1555 return load_with_options(argc, argv, true);
1558 static int do_loadall(int argc, char **argv)
1560 return load_with_options(argc, argv, false);
1563 #ifdef BPFTOOL_WITHOUT_SKELETONS
1565 static int do_profile(int argc, char **argv)
1567 p_err("bpftool prog profile command is not supported. Please build bpftool with clang >= 10.0.0");
1568 return 0;
1571 #else /* BPFTOOL_WITHOUT_SKELETONS */
1573 #include "profiler.skel.h"
1575 struct profile_metric {
1576 const char *name;
1577 struct bpf_perf_event_value val;
1578 struct perf_event_attr attr;
1579 bool selected;
1581 /* calculate ratios like instructions per cycle */
1582 const int ratio_metric; /* 0 for N/A, 1 for index 0 (cycles) */
1583 const char *ratio_desc;
1584 const float ratio_mul;
1585 } metrics[] = {
1587 .name = "cycles",
1588 .attr = {
1589 .type = PERF_TYPE_HARDWARE,
1590 .config = PERF_COUNT_HW_CPU_CYCLES,
1591 .exclude_user = 1,
1595 .name = "instructions",
1596 .attr = {
1597 .type = PERF_TYPE_HARDWARE,
1598 .config = PERF_COUNT_HW_INSTRUCTIONS,
1599 .exclude_user = 1,
1601 .ratio_metric = 1,
1602 .ratio_desc = "insns per cycle",
1603 .ratio_mul = 1.0,
1606 .name = "l1d_loads",
1607 .attr = {
1608 .type = PERF_TYPE_HW_CACHE,
1609 .config =
1610 PERF_COUNT_HW_CACHE_L1D |
1611 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1612 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16),
1613 .exclude_user = 1,
1617 .name = "llc_misses",
1618 .attr = {
1619 .type = PERF_TYPE_HW_CACHE,
1620 .config =
1621 PERF_COUNT_HW_CACHE_LL |
1622 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1623 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16),
1624 .exclude_user = 1
1626 .ratio_metric = 2,
1627 .ratio_desc = "LLC misses per million insns",
1628 .ratio_mul = 1e6,
1632 static __u64 profile_total_count;
1634 #define MAX_NUM_PROFILE_METRICS 4
1636 static int profile_parse_metrics(int argc, char **argv)
1638 unsigned int metric_cnt;
1639 int selected_cnt = 0;
1640 unsigned int i;
1642 metric_cnt = sizeof(metrics) / sizeof(struct profile_metric);
1644 while (argc > 0) {
1645 for (i = 0; i < metric_cnt; i++) {
1646 if (is_prefix(argv[0], metrics[i].name)) {
1647 if (!metrics[i].selected)
1648 selected_cnt++;
1649 metrics[i].selected = true;
1650 break;
1653 if (i == metric_cnt) {
1654 p_err("unknown metric %s", argv[0]);
1655 return -1;
1657 NEXT_ARG();
1659 if (selected_cnt > MAX_NUM_PROFILE_METRICS) {
1660 p_err("too many (%d) metrics, please specify no more than %d metrics at at time",
1661 selected_cnt, MAX_NUM_PROFILE_METRICS);
1662 return -1;
1664 return selected_cnt;
1667 static void profile_read_values(struct profiler_bpf *obj)
1669 __u32 m, cpu, num_cpu = obj->rodata->num_cpu;
1670 int reading_map_fd, count_map_fd;
1671 __u64 counts[num_cpu];
1672 __u32 key = 0;
1673 int err;
1675 reading_map_fd = bpf_map__fd(obj->maps.accum_readings);
1676 count_map_fd = bpf_map__fd(obj->maps.counts);
1677 if (reading_map_fd < 0 || count_map_fd < 0) {
1678 p_err("failed to get fd for map");
1679 return;
1682 err = bpf_map_lookup_elem(count_map_fd, &key, counts);
1683 if (err) {
1684 p_err("failed to read count_map: %s", strerror(errno));
1685 return;
1688 profile_total_count = 0;
1689 for (cpu = 0; cpu < num_cpu; cpu++)
1690 profile_total_count += counts[cpu];
1692 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
1693 struct bpf_perf_event_value values[num_cpu];
1695 if (!metrics[m].selected)
1696 continue;
1698 err = bpf_map_lookup_elem(reading_map_fd, &key, values);
1699 if (err) {
1700 p_err("failed to read reading_map: %s",
1701 strerror(errno));
1702 return;
1704 for (cpu = 0; cpu < num_cpu; cpu++) {
1705 metrics[m].val.counter += values[cpu].counter;
1706 metrics[m].val.enabled += values[cpu].enabled;
1707 metrics[m].val.running += values[cpu].running;
1709 key++;
1713 static void profile_print_readings_json(void)
1715 __u32 m;
1717 jsonw_start_array(json_wtr);
1718 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
1719 if (!metrics[m].selected)
1720 continue;
1721 jsonw_start_object(json_wtr);
1722 jsonw_string_field(json_wtr, "metric", metrics[m].name);
1723 jsonw_lluint_field(json_wtr, "run_cnt", profile_total_count);
1724 jsonw_lluint_field(json_wtr, "value", metrics[m].val.counter);
1725 jsonw_lluint_field(json_wtr, "enabled", metrics[m].val.enabled);
1726 jsonw_lluint_field(json_wtr, "running", metrics[m].val.running);
1728 jsonw_end_object(json_wtr);
1730 jsonw_end_array(json_wtr);
1733 static void profile_print_readings_plain(void)
1735 __u32 m;
1737 printf("\n%18llu %-20s\n", profile_total_count, "run_cnt");
1738 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
1739 struct bpf_perf_event_value *val = &metrics[m].val;
1740 int r;
1742 if (!metrics[m].selected)
1743 continue;
1744 printf("%18llu %-20s", val->counter, metrics[m].name);
1746 r = metrics[m].ratio_metric - 1;
1747 if (r >= 0 && metrics[r].selected &&
1748 metrics[r].val.counter > 0) {
1749 printf("# %8.2f %-30s",
1750 val->counter * metrics[m].ratio_mul /
1751 metrics[r].val.counter,
1752 metrics[m].ratio_desc);
1753 } else {
1754 printf("%-41s", "");
1757 if (val->enabled > val->running)
1758 printf("(%4.2f%%)",
1759 val->running * 100.0 / val->enabled);
1760 printf("\n");
1764 static void profile_print_readings(void)
1766 if (json_output)
1767 profile_print_readings_json();
1768 else
1769 profile_print_readings_plain();
1772 static char *profile_target_name(int tgt_fd)
1774 struct bpf_prog_info_linear *info_linear;
1775 struct bpf_func_info *func_info;
1776 const struct btf_type *t;
1777 char *name = NULL;
1778 struct btf *btf;
1780 info_linear = bpf_program__get_prog_info_linear(
1781 tgt_fd, 1UL << BPF_PROG_INFO_FUNC_INFO);
1782 if (IS_ERR_OR_NULL(info_linear)) {
1783 p_err("failed to get info_linear for prog FD %d", tgt_fd);
1784 return NULL;
1787 if (info_linear->info.btf_id == 0 ||
1788 btf__get_from_id(info_linear->info.btf_id, &btf)) {
1789 p_err("prog FD %d doesn't have valid btf", tgt_fd);
1790 goto out;
1793 func_info = (struct bpf_func_info *)(info_linear->info.func_info);
1794 t = btf__type_by_id(btf, func_info[0].type_id);
1795 if (!t) {
1796 p_err("btf %d doesn't have type %d",
1797 info_linear->info.btf_id, func_info[0].type_id);
1798 goto out;
1800 name = strdup(btf__name_by_offset(btf, t->name_off));
1801 out:
1802 free(info_linear);
1803 return name;
1806 static struct profiler_bpf *profile_obj;
1807 static int profile_tgt_fd = -1;
1808 static char *profile_tgt_name;
1809 static int *profile_perf_events;
1810 static int profile_perf_event_cnt;
1812 static void profile_close_perf_events(struct profiler_bpf *obj)
1814 int i;
1816 for (i = profile_perf_event_cnt - 1; i >= 0; i--)
1817 close(profile_perf_events[i]);
1819 free(profile_perf_events);
1820 profile_perf_event_cnt = 0;
1823 static int profile_open_perf_events(struct profiler_bpf *obj)
1825 unsigned int cpu, m;
1826 int map_fd, pmu_fd;
1828 profile_perf_events = calloc(
1829 sizeof(int), obj->rodata->num_cpu * obj->rodata->num_metric);
1830 if (!profile_perf_events) {
1831 p_err("failed to allocate memory for perf_event array: %s",
1832 strerror(errno));
1833 return -1;
1835 map_fd = bpf_map__fd(obj->maps.events);
1836 if (map_fd < 0) {
1837 p_err("failed to get fd for events map");
1838 return -1;
1841 for (m = 0; m < ARRAY_SIZE(metrics); m++) {
1842 if (!metrics[m].selected)
1843 continue;
1844 for (cpu = 0; cpu < obj->rodata->num_cpu; cpu++) {
1845 pmu_fd = syscall(__NR_perf_event_open, &metrics[m].attr,
1846 -1/*pid*/, cpu, -1/*group_fd*/, 0);
1847 if (pmu_fd < 0 ||
1848 bpf_map_update_elem(map_fd, &profile_perf_event_cnt,
1849 &pmu_fd, BPF_ANY) ||
1850 ioctl(pmu_fd, PERF_EVENT_IOC_ENABLE, 0)) {
1851 p_err("failed to create event %s on cpu %d",
1852 metrics[m].name, cpu);
1853 return -1;
1855 profile_perf_events[profile_perf_event_cnt++] = pmu_fd;
1858 return 0;
1861 static void profile_print_and_cleanup(void)
1863 profile_close_perf_events(profile_obj);
1864 profile_read_values(profile_obj);
1865 profile_print_readings();
1866 profiler_bpf__destroy(profile_obj);
1868 close(profile_tgt_fd);
1869 free(profile_tgt_name);
1872 static void int_exit(int signo)
1874 profile_print_and_cleanup();
1875 exit(0);
1878 static int do_profile(int argc, char **argv)
1880 int num_metric, num_cpu, err = -1;
1881 struct bpf_program *prog;
1882 unsigned long duration;
1883 char *endptr;
1885 /* we at least need two args for the prog and one metric */
1886 if (!REQ_ARGS(3))
1887 return -EINVAL;
1889 /* parse target fd */
1890 profile_tgt_fd = prog_parse_fd(&argc, &argv);
1891 if (profile_tgt_fd < 0) {
1892 p_err("failed to parse fd");
1893 return -1;
1896 /* parse profiling optional duration */
1897 if (argc > 2 && is_prefix(argv[0], "duration")) {
1898 NEXT_ARG();
1899 duration = strtoul(*argv, &endptr, 0);
1900 if (*endptr)
1901 usage();
1902 NEXT_ARG();
1903 } else {
1904 duration = UINT_MAX;
1907 num_metric = profile_parse_metrics(argc, argv);
1908 if (num_metric <= 0)
1909 goto out;
1911 num_cpu = libbpf_num_possible_cpus();
1912 if (num_cpu <= 0) {
1913 p_err("failed to identify number of CPUs");
1914 goto out;
1917 profile_obj = profiler_bpf__open();
1918 if (!profile_obj) {
1919 p_err("failed to open and/or load BPF object");
1920 goto out;
1923 profile_obj->rodata->num_cpu = num_cpu;
1924 profile_obj->rodata->num_metric = num_metric;
1926 /* adjust map sizes */
1927 bpf_map__resize(profile_obj->maps.events, num_metric * num_cpu);
1928 bpf_map__resize(profile_obj->maps.fentry_readings, num_metric);
1929 bpf_map__resize(profile_obj->maps.accum_readings, num_metric);
1930 bpf_map__resize(profile_obj->maps.counts, 1);
1932 /* change target name */
1933 profile_tgt_name = profile_target_name(profile_tgt_fd);
1934 if (!profile_tgt_name)
1935 goto out;
1937 bpf_object__for_each_program(prog, profile_obj->obj) {
1938 err = bpf_program__set_attach_target(prog, profile_tgt_fd,
1939 profile_tgt_name);
1940 if (err) {
1941 p_err("failed to set attach target\n");
1942 goto out;
1946 set_max_rlimit();
1947 err = profiler_bpf__load(profile_obj);
1948 if (err) {
1949 p_err("failed to load profile_obj");
1950 goto out;
1953 err = profile_open_perf_events(profile_obj);
1954 if (err)
1955 goto out;
1957 err = profiler_bpf__attach(profile_obj);
1958 if (err) {
1959 p_err("failed to attach profile_obj");
1960 goto out;
1962 signal(SIGINT, int_exit);
1964 sleep(duration);
1965 profile_print_and_cleanup();
1966 return 0;
1968 out:
1969 profile_close_perf_events(profile_obj);
1970 if (profile_obj)
1971 profiler_bpf__destroy(profile_obj);
1972 close(profile_tgt_fd);
1973 free(profile_tgt_name);
1974 return err;
1977 #endif /* BPFTOOL_WITHOUT_SKELETONS */
1979 static int do_help(int argc, char **argv)
1981 if (json_output) {
1982 jsonw_null(json_wtr);
1983 return 0;
1986 fprintf(stderr,
1987 "Usage: %s %s { show | list } [PROG]\n"
1988 " %s %s dump xlated PROG [{ file FILE | opcodes | visual | linum }]\n"
1989 " %s %s dump jited PROG [{ file FILE | opcodes | linum }]\n"
1990 " %s %s pin PROG FILE\n"
1991 " %s %s { load | loadall } OBJ PATH \\\n"
1992 " [type TYPE] [dev NAME] \\\n"
1993 " [map { idx IDX | name NAME } MAP]\\\n"
1994 " [pinmaps MAP_DIR]\n"
1995 " %s %s attach PROG ATTACH_TYPE [MAP]\n"
1996 " %s %s detach PROG ATTACH_TYPE [MAP]\n"
1997 " %s %s run PROG \\\n"
1998 " data_in FILE \\\n"
1999 " [data_out FILE [data_size_out L]] \\\n"
2000 " [ctx_in FILE [ctx_out FILE [ctx_size_out M]]] \\\n"
2001 " [repeat N]\n"
2002 " %s %s profile PROG [duration DURATION] METRICs\n"
2003 " %s %s tracelog\n"
2004 " %s %s help\n"
2005 "\n"
2006 " " HELP_SPEC_MAP "\n"
2007 " " HELP_SPEC_PROGRAM "\n"
2008 " TYPE := { socket | kprobe | kretprobe | classifier | action |\n"
2009 " tracepoint | raw_tracepoint | xdp | perf_event | cgroup/skb |\n"
2010 " cgroup/sock | cgroup/dev | lwt_in | lwt_out | lwt_xmit |\n"
2011 " lwt_seg6local | sockops | sk_skb | sk_msg | lirc_mode2 |\n"
2012 " sk_reuseport | flow_dissector | cgroup/sysctl |\n"
2013 " cgroup/bind4 | cgroup/bind6 | cgroup/post_bind4 |\n"
2014 " cgroup/post_bind6 | cgroup/connect4 | cgroup/connect6 |\n"
2015 " cgroup/sendmsg4 | cgroup/sendmsg6 | cgroup/recvmsg4 |\n"
2016 " cgroup/recvmsg6 | cgroup/getsockopt | cgroup/setsockopt |\n"
2017 " struct_ops | fentry | fexit | freplace }\n"
2018 " ATTACH_TYPE := { msg_verdict | stream_verdict | stream_parser |\n"
2019 " flow_dissector }\n"
2020 " METRIC := { cycles | instructions | l1d_loads | llc_misses }\n"
2021 " " HELP_SPEC_OPTIONS "\n"
2023 bin_name, argv[-2], bin_name, argv[-2], bin_name, argv[-2],
2024 bin_name, argv[-2], bin_name, argv[-2], bin_name, argv[-2],
2025 bin_name, argv[-2], bin_name, argv[-2], bin_name, argv[-2],
2026 bin_name, argv[-2], bin_name, argv[-2]);
2028 return 0;
2031 static const struct cmd cmds[] = {
2032 { "show", do_show },
2033 { "list", do_show },
2034 { "help", do_help },
2035 { "dump", do_dump },
2036 { "pin", do_pin },
2037 { "load", do_load },
2038 { "loadall", do_loadall },
2039 { "attach", do_attach },
2040 { "detach", do_detach },
2041 { "tracelog", do_tracelog },
2042 { "run", do_run },
2043 { "profile", do_profile },
2044 { 0 }
2047 int do_prog(int argc, char **argv)
2049 return cmd_select(cmds, argc, argv, do_help);