1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 /* Copyright (C) 2017-2018 Netronome Systems, Inc. */
8 #include <linux/kernel.h>
15 #include <sys/types.h>
21 #include "json_writer.h"
24 const char * const map_type_name
[] = {
25 [BPF_MAP_TYPE_UNSPEC
] = "unspec",
26 [BPF_MAP_TYPE_HASH
] = "hash",
27 [BPF_MAP_TYPE_ARRAY
] = "array",
28 [BPF_MAP_TYPE_PROG_ARRAY
] = "prog_array",
29 [BPF_MAP_TYPE_PERF_EVENT_ARRAY
] = "perf_event_array",
30 [BPF_MAP_TYPE_PERCPU_HASH
] = "percpu_hash",
31 [BPF_MAP_TYPE_PERCPU_ARRAY
] = "percpu_array",
32 [BPF_MAP_TYPE_STACK_TRACE
] = "stack_trace",
33 [BPF_MAP_TYPE_CGROUP_ARRAY
] = "cgroup_array",
34 [BPF_MAP_TYPE_LRU_HASH
] = "lru_hash",
35 [BPF_MAP_TYPE_LRU_PERCPU_HASH
] = "lru_percpu_hash",
36 [BPF_MAP_TYPE_LPM_TRIE
] = "lpm_trie",
37 [BPF_MAP_TYPE_ARRAY_OF_MAPS
] = "array_of_maps",
38 [BPF_MAP_TYPE_HASH_OF_MAPS
] = "hash_of_maps",
39 [BPF_MAP_TYPE_DEVMAP
] = "devmap",
40 [BPF_MAP_TYPE_DEVMAP_HASH
] = "devmap_hash",
41 [BPF_MAP_TYPE_SOCKMAP
] = "sockmap",
42 [BPF_MAP_TYPE_CPUMAP
] = "cpumap",
43 [BPF_MAP_TYPE_XSKMAP
] = "xskmap",
44 [BPF_MAP_TYPE_SOCKHASH
] = "sockhash",
45 [BPF_MAP_TYPE_CGROUP_STORAGE
] = "cgroup_storage",
46 [BPF_MAP_TYPE_REUSEPORT_SOCKARRAY
] = "reuseport_sockarray",
47 [BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE
] = "percpu_cgroup_storage",
48 [BPF_MAP_TYPE_QUEUE
] = "queue",
49 [BPF_MAP_TYPE_STACK
] = "stack",
50 [BPF_MAP_TYPE_SK_STORAGE
] = "sk_storage",
51 [BPF_MAP_TYPE_STRUCT_OPS
] = "struct_ops",
54 const size_t map_type_name_size
= ARRAY_SIZE(map_type_name
);
56 static bool map_is_per_cpu(__u32 type
)
58 return type
== BPF_MAP_TYPE_PERCPU_HASH
||
59 type
== BPF_MAP_TYPE_PERCPU_ARRAY
||
60 type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
||
61 type
== BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE
;
64 static bool map_is_map_of_maps(__u32 type
)
66 return type
== BPF_MAP_TYPE_ARRAY_OF_MAPS
||
67 type
== BPF_MAP_TYPE_HASH_OF_MAPS
;
70 static bool map_is_map_of_progs(__u32 type
)
72 return type
== BPF_MAP_TYPE_PROG_ARRAY
;
75 static int map_type_from_str(const char *type
)
79 for (i
= 0; i
< ARRAY_SIZE(map_type_name
); i
++)
80 /* Don't allow prefixing in case of possible future shadowing */
81 if (map_type_name
[i
] && !strcmp(map_type_name
[i
], type
))
86 static void *alloc_value(struct bpf_map_info
*info
)
88 if (map_is_per_cpu(info
->type
))
89 return malloc(round_up(info
->value_size
, 8) *
92 return malloc(info
->value_size
);
95 static int map_fd_by_name(char *name
, int **fds
)
103 struct bpf_map_info info
= {};
104 __u32 len
= sizeof(info
);
106 err
= bpf_map_get_next_id(id
, &id
);
108 if (errno
!= ENOENT
) {
109 p_err("%s", strerror(errno
));
115 fd
= bpf_map_get_fd_by_id(id
);
117 p_err("can't get map by id (%u): %s",
118 id
, strerror(errno
));
122 err
= bpf_obj_get_info_by_fd(fd
, &info
, &len
);
124 p_err("can't get map info (%u): %s",
125 id
, strerror(errno
));
129 if (strncmp(name
, info
.name
, BPF_OBJ_NAME_LEN
)) {
135 tmp
= realloc(*fds
, (nb_fds
+ 1) * sizeof(int));
137 p_err("failed to realloc");
142 (*fds
)[nb_fds
++] = fd
;
148 while (--nb_fds
>= 0)
149 close((*fds
)[nb_fds
]);
153 static int map_parse_fds(int *argc
, char ***argv
, int **fds
)
155 if (is_prefix(**argv
, "id")) {
161 id
= strtoul(**argv
, &endptr
, 0);
163 p_err("can't parse %s as ID", **argv
);
168 (*fds
)[0] = bpf_map_get_fd_by_id(id
);
170 p_err("get map by id (%u): %s", id
, strerror(errno
));
174 } else if (is_prefix(**argv
, "name")) {
180 if (strlen(name
) > BPF_OBJ_NAME_LEN
- 1) {
181 p_err("can't parse name");
186 return map_fd_by_name(name
, fds
);
187 } else if (is_prefix(**argv
, "pinned")) {
195 (*fds
)[0] = open_obj_pinned_any(path
, BPF_OBJ_MAP
);
201 p_err("expected 'id', 'name' or 'pinned', got: '%s'?", **argv
);
205 int map_parse_fd(int *argc
, char ***argv
)
210 fds
= malloc(sizeof(int));
212 p_err("mem alloc failed");
215 nb_fds
= map_parse_fds(argc
, argv
, &fds
);
218 p_err("several maps match this handle");
232 int map_parse_fd_and_info(int *argc
, char ***argv
, void *info
, __u32
*info_len
)
237 fd
= map_parse_fd(argc
, argv
);
241 err
= bpf_obj_get_info_by_fd(fd
, info
, info_len
);
243 p_err("can't get map info: %s", strerror(errno
));
251 static int do_dump_btf(const struct btf_dumper
*d
,
252 struct bpf_map_info
*map_info
, void *key
,
258 /* start of key-value pair */
259 jsonw_start_object(d
->jw
);
261 if (map_info
->btf_key_type_id
) {
262 jsonw_name(d
->jw
, "key");
264 ret
= btf_dumper_type(d
, map_info
->btf_key_type_id
, key
);
269 value_id
= map_info
->btf_vmlinux_value_type_id
?
270 : map_info
->btf_value_type_id
;
272 if (!map_is_per_cpu(map_info
->type
)) {
273 jsonw_name(d
->jw
, "value");
274 ret
= btf_dumper_type(d
, value_id
, value
);
276 unsigned int i
, n
, step
;
278 jsonw_name(d
->jw
, "values");
279 jsonw_start_array(d
->jw
);
280 n
= get_possible_cpus();
281 step
= round_up(map_info
->value_size
, 8);
282 for (i
= 0; i
< n
; i
++) {
283 jsonw_start_object(d
->jw
);
284 jsonw_int_field(d
->jw
, "cpu", i
);
285 jsonw_name(d
->jw
, "value");
286 ret
= btf_dumper_type(d
, value_id
, value
+ i
* step
);
287 jsonw_end_object(d
->jw
);
291 jsonw_end_array(d
->jw
);
295 /* end of key-value pair */
296 jsonw_end_object(d
->jw
);
301 static json_writer_t
*get_btf_writer(void)
303 json_writer_t
*jw
= jsonw_new(stdout
);
307 jsonw_pretty(jw
, true);
312 static void print_entry_json(struct bpf_map_info
*info
, unsigned char *key
,
313 unsigned char *value
, struct btf
*btf
)
315 jsonw_start_object(json_wtr
);
317 if (!map_is_per_cpu(info
->type
)) {
318 jsonw_name(json_wtr
, "key");
319 print_hex_data_json(key
, info
->key_size
);
320 jsonw_name(json_wtr
, "value");
321 print_hex_data_json(value
, info
->value_size
);
323 struct btf_dumper d
= {
326 .is_plain_text
= false,
329 jsonw_name(json_wtr
, "formatted");
330 do_dump_btf(&d
, info
, key
, value
);
333 unsigned int i
, n
, step
;
335 n
= get_possible_cpus();
336 step
= round_up(info
->value_size
, 8);
338 jsonw_name(json_wtr
, "key");
339 print_hex_data_json(key
, info
->key_size
);
341 jsonw_name(json_wtr
, "values");
342 jsonw_start_array(json_wtr
);
343 for (i
= 0; i
< n
; i
++) {
344 jsonw_start_object(json_wtr
);
346 jsonw_int_field(json_wtr
, "cpu", i
);
348 jsonw_name(json_wtr
, "value");
349 print_hex_data_json(value
+ i
* step
,
352 jsonw_end_object(json_wtr
);
354 jsonw_end_array(json_wtr
);
356 struct btf_dumper d
= {
359 .is_plain_text
= false,
362 jsonw_name(json_wtr
, "formatted");
363 do_dump_btf(&d
, info
, key
, value
);
367 jsonw_end_object(json_wtr
);
370 static void print_entry_error(struct bpf_map_info
*info
, unsigned char *key
,
371 const char *error_msg
)
373 int msg_size
= strlen(error_msg
);
374 bool single_line
, break_names
;
376 break_names
= info
->key_size
> 16 || msg_size
> 16;
377 single_line
= info
->key_size
+ msg_size
<= 24 && !break_names
;
379 printf("key:%c", break_names
? '\n' : ' ');
380 fprint_hex(stdout
, key
, info
->key_size
, " ");
382 printf(single_line
? " " : "\n");
384 printf("value:%c%s", break_names
? '\n' : ' ', error_msg
);
389 static void print_entry_plain(struct bpf_map_info
*info
, unsigned char *key
,
390 unsigned char *value
)
392 if (!map_is_per_cpu(info
->type
)) {
393 bool single_line
, break_names
;
395 break_names
= info
->key_size
> 16 || info
->value_size
> 16;
396 single_line
= info
->key_size
+ info
->value_size
<= 24 &&
399 if (info
->key_size
) {
400 printf("key:%c", break_names
? '\n' : ' ');
401 fprint_hex(stdout
, key
, info
->key_size
, " ");
403 printf(single_line
? " " : "\n");
406 if (info
->value_size
) {
407 printf("value:%c", break_names
? '\n' : ' ');
408 fprint_hex(stdout
, value
, info
->value_size
, " ");
413 unsigned int i
, n
, step
;
415 n
= get_possible_cpus();
416 step
= round_up(info
->value_size
, 8);
418 if (info
->key_size
) {
420 fprint_hex(stdout
, key
, info
->key_size
, " ");
423 if (info
->value_size
) {
424 for (i
= 0; i
< n
; i
++) {
425 printf("value (CPU %02d):%c",
426 i
, info
->value_size
> 16 ? '\n' : ' ');
427 fprint_hex(stdout
, value
+ i
* step
,
428 info
->value_size
, " ");
435 static char **parse_bytes(char **argv
, const char *name
, unsigned char *val
,
438 unsigned int i
= 0, base
= 0;
441 if (is_prefix(*argv
, "hex")) {
446 while (i
< n
&& argv
[i
]) {
447 val
[i
] = strtoul(argv
[i
], &endptr
, base
);
449 p_err("error parsing byte: %s", argv
[i
]);
456 p_err("%s expected %d bytes got %d", name
, n
, i
);
463 /* on per cpu maps we must copy the provided value on all value instances */
464 static void fill_per_cpu_value(struct bpf_map_info
*info
, void *value
)
466 unsigned int i
, n
, step
;
468 if (!map_is_per_cpu(info
->type
))
471 n
= get_possible_cpus();
472 step
= round_up(info
->value_size
, 8);
473 for (i
= 1; i
< n
; i
++)
474 memcpy(value
+ i
* step
, value
, info
->value_size
);
477 static int parse_elem(char **argv
, struct bpf_map_info
*info
,
478 void *key
, void *value
, __u32 key_size
, __u32 value_size
,
479 __u32
*flags
, __u32
**value_fd
)
484 p_err("did not find %s", key
? "key" : "value");
488 if (is_prefix(*argv
, "key")) {
491 p_err("duplicate key");
493 p_err("unnecessary key");
497 argv
= parse_bytes(argv
+ 1, "key", key
, key_size
);
501 return parse_elem(argv
, info
, NULL
, value
, key_size
, value_size
,
503 } else if (is_prefix(*argv
, "value")) {
508 p_err("duplicate value");
510 p_err("unnecessary value");
516 if (map_is_map_of_maps(info
->type
)) {
519 if (value_size
!= 4) {
520 p_err("value smaller than 4B for map in map?");
523 if (!argv
[0] || !argv
[1]) {
524 p_err("not enough value arguments for map in map");
528 fd
= map_parse_fd(&argc
, &argv
);
534 } else if (map_is_map_of_progs(info
->type
)) {
537 if (value_size
!= 4) {
538 p_err("value smaller than 4B for map of progs?");
541 if (!argv
[0] || !argv
[1]) {
542 p_err("not enough value arguments for map of progs");
545 if (is_prefix(*argv
, "id"))
546 p_info("Warning: updating program array via MAP_ID, make sure this map is kept open\n"
547 " by some process or pinned otherwise update will be lost");
549 fd
= prog_parse_fd(&argc
, &argv
);
556 argv
= parse_bytes(argv
, "value", value
, value_size
);
560 fill_per_cpu_value(info
, value
);
563 return parse_elem(argv
, info
, key
, NULL
, key_size
, value_size
,
565 } else if (is_prefix(*argv
, "any") || is_prefix(*argv
, "noexist") ||
566 is_prefix(*argv
, "exist")) {
568 p_err("flags specified multiple times: %s", *argv
);
572 if (is_prefix(*argv
, "any"))
574 else if (is_prefix(*argv
, "noexist"))
575 *flags
= BPF_NOEXIST
;
576 else if (is_prefix(*argv
, "exist"))
579 return parse_elem(argv
+ 1, info
, key
, value
, key_size
,
580 value_size
, NULL
, value_fd
);
583 p_err("expected key or value, got: %s", *argv
);
587 static void show_map_header_json(struct bpf_map_info
*info
, json_writer_t
*wtr
)
589 jsonw_uint_field(wtr
, "id", info
->id
);
590 if (info
->type
< ARRAY_SIZE(map_type_name
))
591 jsonw_string_field(wtr
, "type", map_type_name
[info
->type
]);
593 jsonw_uint_field(wtr
, "type", info
->type
);
596 jsonw_string_field(wtr
, "name", info
->name
);
598 jsonw_name(wtr
, "flags");
599 jsonw_printf(wtr
, "%d", info
->map_flags
);
602 static int show_map_close_json(int fd
, struct bpf_map_info
*info
)
604 char *memlock
, *frozen_str
;
607 memlock
= get_fdinfo(fd
, "memlock");
608 frozen_str
= get_fdinfo(fd
, "frozen");
610 jsonw_start_object(json_wtr
);
612 show_map_header_json(info
, json_wtr
);
614 print_dev_json(info
->ifindex
, info
->netns_dev
, info
->netns_ino
);
616 jsonw_uint_field(json_wtr
, "bytes_key", info
->key_size
);
617 jsonw_uint_field(json_wtr
, "bytes_value", info
->value_size
);
618 jsonw_uint_field(json_wtr
, "max_entries", info
->max_entries
);
621 jsonw_int_field(json_wtr
, "bytes_memlock", atoi(memlock
));
624 if (info
->type
== BPF_MAP_TYPE_PROG_ARRAY
) {
625 char *owner_prog_type
= get_fdinfo(fd
, "owner_prog_type");
626 char *owner_jited
= get_fdinfo(fd
, "owner_jited");
628 if (owner_prog_type
) {
629 unsigned int prog_type
= atoi(owner_prog_type
);
631 if (prog_type
< ARRAY_SIZE(prog_type_name
))
632 jsonw_string_field(json_wtr
, "owner_prog_type",
633 prog_type_name
[prog_type
]);
635 jsonw_uint_field(json_wtr
, "owner_prog_type",
639 jsonw_bool_field(json_wtr
, "owner_jited",
640 !!atoi(owner_jited
));
642 free(owner_prog_type
);
648 frozen
= atoi(frozen_str
);
651 jsonw_int_field(json_wtr
, "frozen", frozen
);
654 jsonw_int_field(json_wtr
, "btf_id", info
->btf_id
);
656 if (!hash_empty(map_table
.table
)) {
657 struct pinned_obj
*obj
;
659 jsonw_name(json_wtr
, "pinned");
660 jsonw_start_array(json_wtr
);
661 hash_for_each_possible(map_table
.table
, obj
, hash
, info
->id
) {
662 if (obj
->id
== info
->id
)
663 jsonw_string(json_wtr
, obj
->path
);
665 jsonw_end_array(json_wtr
);
668 jsonw_end_object(json_wtr
);
673 static void show_map_header_plain(struct bpf_map_info
*info
)
675 printf("%u: ", info
->id
);
676 if (info
->type
< ARRAY_SIZE(map_type_name
))
677 printf("%s ", map_type_name
[info
->type
]);
679 printf("type %u ", info
->type
);
682 printf("name %s ", info
->name
);
684 printf("flags 0x%x", info
->map_flags
);
685 print_dev_plain(info
->ifindex
, info
->netns_dev
, info
->netns_ino
);
689 static int show_map_close_plain(int fd
, struct bpf_map_info
*info
)
691 char *memlock
, *frozen_str
;
694 memlock
= get_fdinfo(fd
, "memlock");
695 frozen_str
= get_fdinfo(fd
, "frozen");
697 show_map_header_plain(info
);
698 printf("\tkey %uB value %uB max_entries %u",
699 info
->key_size
, info
->value_size
, info
->max_entries
);
702 printf(" memlock %sB", memlock
);
705 if (info
->type
== BPF_MAP_TYPE_PROG_ARRAY
) {
706 char *owner_prog_type
= get_fdinfo(fd
, "owner_prog_type");
707 char *owner_jited
= get_fdinfo(fd
, "owner_jited");
709 if (owner_prog_type
|| owner_jited
)
711 if (owner_prog_type
) {
712 unsigned int prog_type
= atoi(owner_prog_type
);
714 if (prog_type
< ARRAY_SIZE(prog_type_name
))
715 printf("owner_prog_type %s ",
716 prog_type_name
[prog_type
]);
718 printf("owner_prog_type %d ", prog_type
);
721 printf("owner%s jited",
722 atoi(owner_jited
) ? "" : " not");
724 free(owner_prog_type
);
729 if (!hash_empty(map_table
.table
)) {
730 struct pinned_obj
*obj
;
732 hash_for_each_possible(map_table
.table
, obj
, hash
, info
->id
) {
733 if (obj
->id
== info
->id
)
734 printf("\n\tpinned %s", obj
->path
);
740 frozen
= atoi(frozen_str
);
744 if (!info
->btf_id
&& !frozen
)
750 printf("btf_id %d", info
->btf_id
);
753 printf("%sfrozen", info
->btf_id
? " " : "");
759 static int do_show_subset(int argc
, char **argv
)
761 struct bpf_map_info info
= {};
762 __u32 len
= sizeof(info
);
767 fds
= malloc(sizeof(int));
769 p_err("mem alloc failed");
772 nb_fds
= map_parse_fds(&argc
, &argv
, &fds
);
776 if (json_output
&& nb_fds
> 1)
777 jsonw_start_array(json_wtr
); /* root array */
778 for (i
= 0; i
< nb_fds
; i
++) {
779 err
= bpf_obj_get_info_by_fd(fds
[i
], &info
, &len
);
781 p_err("can't get map info: %s",
783 for (; i
< nb_fds
; i
++)
789 show_map_close_json(fds
[i
], &info
);
791 show_map_close_plain(fds
[i
], &info
);
795 if (json_output
&& nb_fds
> 1)
796 jsonw_end_array(json_wtr
); /* root array */
803 static int do_show(int argc
, char **argv
)
805 struct bpf_map_info info
= {};
806 __u32 len
= sizeof(info
);
812 build_pinned_obj_table(&map_table
, BPF_OBJ_MAP
);
815 return do_show_subset(argc
, argv
);
821 jsonw_start_array(json_wtr
);
823 err
= bpf_map_get_next_id(id
, &id
);
827 p_err("can't get next map: %s%s", strerror(errno
),
828 errno
== EINVAL
? " -- kernel too old?" : "");
832 fd
= bpf_map_get_fd_by_id(id
);
836 p_err("can't get map by id (%u): %s",
837 id
, strerror(errno
));
841 err
= bpf_obj_get_info_by_fd(fd
, &info
, &len
);
843 p_err("can't get map info: %s", strerror(errno
));
849 show_map_close_json(fd
, &info
);
851 show_map_close_plain(fd
, &info
);
854 jsonw_end_array(json_wtr
);
856 return errno
== ENOENT
? 0 : -1;
859 static int dump_map_elem(int fd
, void *key
, void *value
,
860 struct bpf_map_info
*map_info
, struct btf
*btf
,
861 json_writer_t
*btf_wtr
)
866 if (!bpf_map_lookup_elem(fd
, key
, value
)) {
868 print_entry_json(map_info
, key
, value
, btf
);
871 struct btf_dumper d
= {
874 .is_plain_text
= true,
877 do_dump_btf(&d
, map_info
, key
, value
);
879 print_entry_plain(map_info
, key
, value
);
886 /* lookup error handling */
887 lookup_errno
= errno
;
889 if (map_is_map_of_maps(map_info
->type
) ||
890 map_is_map_of_progs(map_info
->type
))
894 jsonw_start_object(json_wtr
);
895 jsonw_name(json_wtr
, "key");
896 print_hex_data_json(key
, map_info
->key_size
);
897 jsonw_name(json_wtr
, "value");
898 jsonw_start_object(json_wtr
);
899 jsonw_string_field(json_wtr
, "error", strerror(lookup_errno
));
900 jsonw_end_object(json_wtr
);
901 jsonw_end_object(json_wtr
);
903 const char *msg
= NULL
;
905 if (lookup_errno
== ENOENT
)
907 else if (lookup_errno
== ENOSPC
&&
908 map_info
->type
== BPF_MAP_TYPE_REUSEPORT_SOCKARRAY
)
909 msg
= "<cannot read>";
911 print_entry_error(map_info
, key
,
912 msg
? : strerror(lookup_errno
));
918 static int maps_have_btf(int *fds
, int nb_fds
)
920 struct bpf_map_info info
= {};
921 __u32 len
= sizeof(info
);
924 for (i
= 0; i
< nb_fds
; i
++) {
925 err
= bpf_obj_get_info_by_fd(fds
[i
], &info
, &len
);
927 p_err("can't get map info: %s", strerror(errno
));
938 static struct btf
*btf_vmlinux
;
940 static struct btf
*get_map_kv_btf(const struct bpf_map_info
*info
)
942 struct btf
*btf
= NULL
;
944 if (info
->btf_vmlinux_value_type_id
) {
946 btf_vmlinux
= libbpf_find_kernel_btf();
947 if (IS_ERR(btf_vmlinux
))
948 p_err("failed to get kernel btf");
951 } else if (info
->btf_value_type_id
) {
954 err
= btf__get_from_id(info
->btf_id
, &btf
);
956 p_err("failed to get btf");
957 btf
= err
? ERR_PTR(err
) : ERR_PTR(-ESRCH
);
964 static void free_map_kv_btf(struct btf
*btf
)
966 if (!IS_ERR(btf
) && btf
!= btf_vmlinux
)
970 static void free_btf_vmlinux(void)
972 if (!IS_ERR(btf_vmlinux
))
973 btf__free(btf_vmlinux
);
977 map_dump(int fd
, struct bpf_map_info
*info
, json_writer_t
*wtr
,
980 void *key
, *value
, *prev_key
;
981 unsigned int num_elems
= 0;
982 struct btf
*btf
= NULL
;
985 key
= malloc(info
->key_size
);
986 value
= alloc_value(info
);
987 if (!key
|| !value
) {
988 p_err("mem alloc failed");
996 btf
= get_map_kv_btf(info
);
1003 jsonw_start_object(wtr
); /* map object */
1004 show_map_header_json(info
, wtr
);
1005 jsonw_name(wtr
, "elements");
1007 jsonw_start_array(wtr
); /* elements */
1008 } else if (show_header
) {
1009 show_map_header_plain(info
);
1012 if (info
->type
== BPF_MAP_TYPE_REUSEPORT_SOCKARRAY
&&
1013 info
->value_size
!= 8)
1014 p_info("Warning: cannot read values from %s map with value_size != 8",
1015 map_type_name
[info
->type
]);
1017 err
= bpf_map_get_next_key(fd
, prev_key
, key
);
1019 if (errno
== ENOENT
)
1023 num_elems
+= dump_map_elem(fd
, key
, value
, info
, btf
, wtr
);
1028 jsonw_end_array(wtr
); /* elements */
1030 jsonw_end_object(wtr
); /* map object */
1032 printf("Found %u element%s\n", num_elems
,
1033 num_elems
!= 1 ? "s" : "");
1040 free_map_kv_btf(btf
);
1045 static int do_dump(int argc
, char **argv
)
1047 json_writer_t
*wtr
= NULL
, *btf_wtr
= NULL
;
1048 struct bpf_map_info info
= {};
1050 __u32 len
= sizeof(info
);
1057 fds
= malloc(sizeof(int));
1059 p_err("mem alloc failed");
1062 nb_fds
= map_parse_fds(&argc
, &argv
, &fds
);
1071 do_plain_btf
= maps_have_btf(fds
, nb_fds
);
1072 if (do_plain_btf
< 0)
1076 btf_wtr
= get_btf_writer();
1079 p_info("failed to create json writer for btf. falling back to plain output");
1083 if (wtr
&& nb_fds
> 1)
1084 jsonw_start_array(wtr
); /* root array */
1085 for (i
= 0; i
< nb_fds
; i
++) {
1086 if (bpf_obj_get_info_by_fd(fds
[i
], &info
, &len
)) {
1087 p_err("can't get map info: %s", strerror(errno
));
1090 err
= map_dump(fds
[i
], &info
, wtr
, nb_fds
> 1);
1091 if (!wtr
&& i
!= nb_fds
- 1)
1098 if (wtr
&& nb_fds
> 1)
1099 jsonw_end_array(wtr
); /* root array */
1102 jsonw_destroy(&btf_wtr
);
1104 for (; i
< nb_fds
; i
++)
1112 static int alloc_key_value(struct bpf_map_info
*info
, void **key
, void **value
)
1117 if (info
->key_size
) {
1118 *key
= malloc(info
->key_size
);
1120 p_err("key mem alloc failed");
1125 if (info
->value_size
) {
1126 *value
= alloc_value(info
);
1128 p_err("value mem alloc failed");
1138 static int do_update(int argc
, char **argv
)
1140 struct bpf_map_info info
= {};
1141 __u32 len
= sizeof(info
);
1142 __u32
*value_fd
= NULL
;
1143 __u32 flags
= BPF_ANY
;
1150 fd
= map_parse_fd_and_info(&argc
, &argv
, &info
, &len
);
1154 err
= alloc_key_value(&info
, &key
, &value
);
1158 err
= parse_elem(argv
, &info
, key
, value
, info
.key_size
,
1159 info
.value_size
, &flags
, &value_fd
);
1163 err
= bpf_map_update_elem(fd
, key
, value
, flags
);
1165 p_err("update failed: %s", strerror(errno
));
1176 if (!err
&& json_output
)
1177 jsonw_null(json_wtr
);
1181 static void print_key_value(struct bpf_map_info
*info
, void *key
,
1184 json_writer_t
*btf_wtr
;
1185 struct btf
*btf
= NULL
;
1188 err
= btf__get_from_id(info
->btf_id
, &btf
);
1190 p_err("failed to get btf");
1195 print_entry_json(info
, key
, value
, btf
);
1197 /* if here json_wtr wouldn't have been initialised,
1198 * so let's create separate writer for btf
1200 btf_wtr
= get_btf_writer();
1202 p_info("failed to create json writer for btf. falling back to plain output");
1205 print_entry_plain(info
, key
, value
);
1207 struct btf_dumper d
= {
1210 .is_plain_text
= true,
1213 do_dump_btf(&d
, info
, key
, value
);
1214 jsonw_destroy(&btf_wtr
);
1217 print_entry_plain(info
, key
, value
);
1222 static int do_lookup(int argc
, char **argv
)
1224 struct bpf_map_info info
= {};
1225 __u32 len
= sizeof(info
);
1233 fd
= map_parse_fd_and_info(&argc
, &argv
, &info
, &len
);
1237 err
= alloc_key_value(&info
, &key
, &value
);
1241 err
= parse_elem(argv
, &info
, key
, NULL
, info
.key_size
, 0, NULL
, NULL
);
1245 err
= bpf_map_lookup_elem(fd
, key
, value
);
1247 if (errno
== ENOENT
) {
1249 jsonw_null(json_wtr
);
1252 fprint_hex(stdout
, key
, info
.key_size
, " ");
1253 printf("\n\nNot found\n");
1256 p_err("lookup failed: %s", strerror(errno
));
1262 /* here means bpf_map_lookup_elem() succeeded */
1263 print_key_value(&info
, key
, value
);
1273 static int do_getnext(int argc
, char **argv
)
1275 struct bpf_map_info info
= {};
1276 __u32 len
= sizeof(info
);
1277 void *key
, *nextkey
;
1284 fd
= map_parse_fd_and_info(&argc
, &argv
, &info
, &len
);
1288 key
= malloc(info
.key_size
);
1289 nextkey
= malloc(info
.key_size
);
1290 if (!key
|| !nextkey
) {
1291 p_err("mem alloc failed");
1297 err
= parse_elem(argv
, &info
, key
, NULL
, info
.key_size
, 0,
1306 err
= bpf_map_get_next_key(fd
, key
, nextkey
);
1308 p_err("can't get next key: %s", strerror(errno
));
1313 jsonw_start_object(json_wtr
);
1315 jsonw_name(json_wtr
, "key");
1316 print_hex_data_json(key
, info
.key_size
);
1318 jsonw_null_field(json_wtr
, "key");
1320 jsonw_name(json_wtr
, "next_key");
1321 print_hex_data_json(nextkey
, info
.key_size
);
1322 jsonw_end_object(json_wtr
);
1326 fprint_hex(stdout
, key
, info
.key_size
, " ");
1329 printf("key: None\n");
1331 printf("next key:\n");
1332 fprint_hex(stdout
, nextkey
, info
.key_size
, " ");
1344 static int do_delete(int argc
, char **argv
)
1346 struct bpf_map_info info
= {};
1347 __u32 len
= sizeof(info
);
1355 fd
= map_parse_fd_and_info(&argc
, &argv
, &info
, &len
);
1359 key
= malloc(info
.key_size
);
1361 p_err("mem alloc failed");
1366 err
= parse_elem(argv
, &info
, key
, NULL
, info
.key_size
, 0, NULL
, NULL
);
1370 err
= bpf_map_delete_elem(fd
, key
);
1372 p_err("delete failed: %s", strerror(errno
));
1378 if (!err
&& json_output
)
1379 jsonw_null(json_wtr
);
1383 static int do_pin(int argc
, char **argv
)
1387 err
= do_pin_any(argc
, argv
, map_parse_fd
);
1388 if (!err
&& json_output
)
1389 jsonw_null(json_wtr
);
1393 static int do_create(int argc
, char **argv
)
1395 struct bpf_create_map_attr attr
= { NULL
, };
1396 const char *pinfile
;
1401 pinfile
= GET_ARG();
1407 if (is_prefix(*argv
, "type")) {
1410 if (attr
.map_type
) {
1411 p_err("map type already specified");
1415 attr
.map_type
= map_type_from_str(*argv
);
1416 if ((int)attr
.map_type
< 0) {
1417 p_err("unrecognized map type: %s", *argv
);
1421 } else if (is_prefix(*argv
, "name")) {
1423 attr
.name
= GET_ARG();
1424 } else if (is_prefix(*argv
, "key")) {
1425 if (parse_u32_arg(&argc
, &argv
, &attr
.key_size
,
1428 } else if (is_prefix(*argv
, "value")) {
1429 if (parse_u32_arg(&argc
, &argv
, &attr
.value_size
,
1432 } else if (is_prefix(*argv
, "entries")) {
1433 if (parse_u32_arg(&argc
, &argv
, &attr
.max_entries
,
1436 } else if (is_prefix(*argv
, "flags")) {
1437 if (parse_u32_arg(&argc
, &argv
, &attr
.map_flags
,
1440 } else if (is_prefix(*argv
, "dev")) {
1443 if (attr
.map_ifindex
) {
1444 p_err("offload device already specified");
1448 attr
.map_ifindex
= if_nametoindex(*argv
);
1449 if (!attr
.map_ifindex
) {
1450 p_err("unrecognized netdevice '%s': %s",
1451 *argv
, strerror(errno
));
1456 p_err("unknown arg %s", *argv
);
1462 p_err("map name not specified");
1468 fd
= bpf_create_map_xattr(&attr
);
1470 p_err("map create failed: %s", strerror(errno
));
1474 err
= do_pin_fd(fd
, pinfile
);
1480 jsonw_null(json_wtr
);
1484 static int do_pop_dequeue(int argc
, char **argv
)
1486 struct bpf_map_info info
= {};
1487 __u32 len
= sizeof(info
);
1495 fd
= map_parse_fd_and_info(&argc
, &argv
, &info
, &len
);
1499 err
= alloc_key_value(&info
, &key
, &value
);
1503 err
= bpf_map_lookup_and_delete_elem(fd
, key
, value
);
1505 if (errno
== ENOENT
) {
1507 jsonw_null(json_wtr
);
1509 printf("Error: empty map\n");
1511 p_err("pop failed: %s", strerror(errno
));
1517 print_key_value(&info
, key
, value
);
1527 static int do_freeze(int argc
, char **argv
)
1534 fd
= map_parse_fd(&argc
, &argv
);
1543 err
= bpf_map_freeze(fd
);
1546 p_err("failed to freeze map: %s", strerror(errno
));
1551 jsonw_null(json_wtr
);
1556 static int do_help(int argc
, char **argv
)
1559 jsonw_null(json_wtr
);
1564 "Usage: %s %s { show | list } [MAP]\n"
1565 " %s %s create FILE type TYPE key KEY_SIZE value VALUE_SIZE \\\n"
1566 " entries MAX_ENTRIES name NAME [flags FLAGS] \\\n"
1569 " %s %s update MAP [key DATA] [value VALUE] [UPDATE_FLAGS]\n"
1570 " %s %s lookup MAP [key DATA]\n"
1571 " %s %s getnext MAP [key DATA]\n"
1572 " %s %s delete MAP key DATA\n"
1573 " %s %s pin MAP FILE\n"
1574 " %s %s event_pipe MAP [cpu N index M]\n"
1576 " %s %s push MAP value VALUE\n"
1578 " %s %s enqueue MAP value VALUE\n"
1579 " %s %s dequeue MAP\n"
1580 " %s %s freeze MAP\n"
1583 " " HELP_SPEC_MAP
"\n"
1584 " DATA := { [hex] BYTES }\n"
1585 " " HELP_SPEC_PROGRAM
"\n"
1586 " VALUE := { DATA | MAP | PROG }\n"
1587 " UPDATE_FLAGS := { any | exist | noexist }\n"
1588 " TYPE := { hash | array | prog_array | perf_event_array | percpu_hash |\n"
1589 " percpu_array | stack_trace | cgroup_array | lru_hash |\n"
1590 " lru_percpu_hash | lpm_trie | array_of_maps | hash_of_maps |\n"
1591 " devmap | devmap_hash | sockmap | cpumap | xskmap | sockhash |\n"
1592 " cgroup_storage | reuseport_sockarray | percpu_cgroup_storage }\n"
1593 " " HELP_SPEC_OPTIONS
"\n"
1595 bin_name
, argv
[-2], bin_name
, argv
[-2], bin_name
, argv
[-2],
1596 bin_name
, argv
[-2], bin_name
, argv
[-2], bin_name
, argv
[-2],
1597 bin_name
, argv
[-2], bin_name
, argv
[-2], bin_name
, argv
[-2],
1598 bin_name
, argv
[-2], bin_name
, argv
[-2], bin_name
, argv
[-2],
1599 bin_name
, argv
[-2], bin_name
, argv
[-2], bin_name
, argv
[-2],
1600 bin_name
, argv
[-2]);
1605 static const struct cmd cmds
[] = {
1606 { "show", do_show
},
1607 { "list", do_show
},
1608 { "help", do_help
},
1609 { "dump", do_dump
},
1610 { "update", do_update
},
1611 { "lookup", do_lookup
},
1612 { "getnext", do_getnext
},
1613 { "delete", do_delete
},
1615 { "event_pipe", do_event_pipe
},
1616 { "create", do_create
},
1617 { "peek", do_lookup
},
1618 { "push", do_update
},
1619 { "enqueue", do_update
},
1620 { "pop", do_pop_dequeue
},
1621 { "dequeue", do_pop_dequeue
},
1622 { "freeze", do_freeze
},
1626 int do_map(int argc
, char **argv
)
1628 return cmd_select(cmds
, argc
, argv
, do_help
);