projects/linux·blob master · refs

1518 lines · 32.6 KiB

1// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2/* Copyright (C) 2017-2018 Netronome Systems, Inc. */
3
4#include <errno.h>
5#include <fcntl.h>
6#include <linux/err.h>
7#include <linux/kernel.h>
8#include <net/if.h>
9#include <stdbool.h>
10#include <stdio.h>
11#include <stdlib.h>
12#include <string.h>
13#include <unistd.h>
14#include <sys/types.h>
15#include <sys/stat.h>
16
17#include <bpf/bpf.h>
18#include <bpf/btf.h>
19#include <bpf/hashmap.h>
20
21#include "json_writer.h"
22#include "main.h"
23
24static struct hashmap *map_table;
25
26static bool map_is_per_cpu(__u32 type)
27{
28 return type == BPF_MAP_TYPE_PERCPU_HASH ||
29 type == BPF_MAP_TYPE_PERCPU_ARRAY ||
30 type == BPF_MAP_TYPE_LRU_PERCPU_HASH ||
31 type == BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE;
32}
33
34static bool map_is_map_of_maps(__u32 type)
35{
36 return type == BPF_MAP_TYPE_ARRAY_OF_MAPS ||
37 type == BPF_MAP_TYPE_HASH_OF_MAPS;
38}
39
40static bool map_is_map_of_progs(__u32 type)
41{
42 return type == BPF_MAP_TYPE_PROG_ARRAY;
43}
44
45static int map_type_from_str(const char *type)
46{
47 const char *map_type_str;
48 unsigned int i;
49
50 for (i = 0; ; i++) {
51 map_type_str = libbpf_bpf_map_type_str(i);
52 if (!map_type_str)
53 break;
54
55 /* Don't allow prefixing in case of possible future shadowing */
56 if (!strcmp(map_type_str, type))
57 return i;
58 }
59 return -1;
60}
61
62static void *alloc_value(struct bpf_map_info *info)
63{
64 if (map_is_per_cpu(info->type))
65 return malloc(round_up(info->value_size, 8) *
66 get_possible_cpus());
67 else
68 return malloc(info->value_size);
69}
70
71static int do_dump_btf(const struct btf_dumper *d,
72 struct bpf_map_info *map_info, void *key,
73 void *value)
74{
75 __u32 value_id;
76 int ret = 0;
77
78 /* start of key-value pair */
79 jsonw_start_object(d->jw);
80
81 if (map_info->btf_key_type_id) {
82 jsonw_name(d->jw, "key");
83
84 ret = btf_dumper_type(d, map_info->btf_key_type_id, key);
85 if (ret)
86 goto err_end_obj;
87 }
88
89 value_id = map_info->btf_vmlinux_value_type_id ?
90 : map_info->btf_value_type_id;
91
92 if (!map_is_per_cpu(map_info->type)) {
93 jsonw_name(d->jw, "value");
94 ret = btf_dumper_type(d, value_id, value);
95 } else {
96 unsigned int i, n, step;
97
98 jsonw_name(d->jw, "values");
99 jsonw_start_array(d->jw);
100 n = get_possible_cpus();
101 step = round_up(map_info->value_size, 8);
102 for (i = 0; i < n; i++) {
103 jsonw_start_object(d->jw);
104 jsonw_int_field(d->jw, "cpu", i);
105 jsonw_name(d->jw, "value");
106 ret = btf_dumper_type(d, value_id, value + i * step);
107 jsonw_end_object(d->jw);
108 if (ret)
109 break;
110 }
111 jsonw_end_array(d->jw);
112 }
113
114err_end_obj:
115 /* end of key-value pair */
116 jsonw_end_object(d->jw);
117
118 return ret;
119}
120
121static json_writer_t *get_btf_writer(void)
122{
123 json_writer_t *jw = jsonw_new(stdout);
124
125 if (!jw)
126 return NULL;
127 jsonw_pretty(jw, true);
128
129 return jw;
130}
131
132static void print_entry_json(struct bpf_map_info *info, unsigned char *key,
133 unsigned char *value, struct btf *btf)
134{
135 jsonw_start_object(json_wtr);
136
137 if (!map_is_per_cpu(info->type)) {
138 jsonw_name(json_wtr, "key");
139 print_hex_data_json(key, info->key_size);
140 jsonw_name(json_wtr, "value");
141 print_hex_data_json(value, info->value_size);
142 if (map_is_map_of_maps(info->type))
143 jsonw_uint_field(json_wtr, "inner_map_id",
144 *(unsigned int *)value);
145 if (btf) {
146 struct btf_dumper d = {
147 .btf = btf,
148 .jw = json_wtr,
149 .is_plain_text = false,
150 };
151
152 jsonw_name(json_wtr, "formatted");
153 do_dump_btf(&d, info, key, value);
154 }
155 } else {
156 unsigned int i, n, step;
157
158 n = get_possible_cpus();
159 step = round_up(info->value_size, 8);
160
161 jsonw_name(json_wtr, "key");
162 print_hex_data_json(key, info->key_size);
163
164 jsonw_name(json_wtr, "values");
165 jsonw_start_array(json_wtr);
166 for (i = 0; i < n; i++) {
167 jsonw_start_object(json_wtr);
168
169 jsonw_int_field(json_wtr, "cpu", i);
170
171 jsonw_name(json_wtr, "value");
172 print_hex_data_json(value + i * step,
173 info->value_size);
174
175 jsonw_end_object(json_wtr);
176 }
177 jsonw_end_array(json_wtr);
178 if (btf) {
179 struct btf_dumper d = {
180 .btf = btf,
181 .jw = json_wtr,
182 .is_plain_text = false,
183 };
184
185 jsonw_name(json_wtr, "formatted");
186 do_dump_btf(&d, info, key, value);
187 }
188 }
189
190 jsonw_end_object(json_wtr);
191}
192
193static void
194print_entry_error_msg(struct bpf_map_info *info, unsigned char *key,
195 const char *error_msg)
196{
197 int msg_size = strlen(error_msg);
198 bool single_line, break_names;
199
200 break_names = info->key_size > 16 || msg_size > 16;
201 single_line = info->key_size + msg_size <= 24 && !break_names;
202
203 printf("key:%c", break_names ? '\n' : ' ');
204 fprint_hex(stdout, key, info->key_size, " ");
205
206 printf(single_line ? " " : "\n");
207
208 printf("value:%c%s", break_names ? '\n' : ' ', error_msg);
209
210 printf("\n");
211}
212
213static void
214print_entry_error(struct bpf_map_info *map_info, void *key, int lookup_errno)
215{
216 /* For prog_array maps or arrays of maps, failure to lookup the value
217 * means there is no entry for that key. Do not print an error message
218 * in that case.
219 */
220 if ((map_is_map_of_maps(map_info->type) ||
221 map_is_map_of_progs(map_info->type)) && lookup_errno == ENOENT)
222 return;
223
224 if (json_output) {
225 jsonw_start_object(json_wtr); /* entry */
226 jsonw_name(json_wtr, "key");
227 print_hex_data_json(key, map_info->key_size);
228 jsonw_name(json_wtr, "value");
229 jsonw_start_object(json_wtr); /* error */
230 jsonw_string_field(json_wtr, "error", strerror(lookup_errno));
231 jsonw_end_object(json_wtr); /* error */
232 jsonw_end_object(json_wtr); /* entry */
233 } else {
234 const char *msg = NULL;
235
236 if (lookup_errno == ENOENT)
237 msg = "<no entry>";
238 else if (lookup_errno == ENOSPC &&
239 map_info->type == BPF_MAP_TYPE_REUSEPORT_SOCKARRAY)
240 msg = "<cannot read>";
241
242 print_entry_error_msg(map_info, key,
243 msg ? : strerror(lookup_errno));
244 }
245}
246
247static void print_entry_plain(struct bpf_map_info *info, unsigned char *key,
248 unsigned char *value)
249{
250 if (!map_is_per_cpu(info->type)) {
251 bool single_line, break_names;
252
253 break_names = info->key_size > 16 || info->value_size > 16;
254 single_line = info->key_size + info->value_size <= 24 &&
255 !break_names;
256
257 if (info->key_size) {
258 printf("key:%c", break_names ? '\n' : ' ');
259 fprint_hex(stdout, key, info->key_size, " ");
260
261 printf(single_line ? " " : "\n");
262 }
263
264 if (info->value_size) {
265 if (map_is_map_of_maps(info->type)) {
266 printf("inner_map_id:%c", break_names ? '\n' : ' ');
267 printf("%u ", *(unsigned int *)value);
268 } else {
269 printf("value:%c", break_names ? '\n' : ' ');
270 fprint_hex(stdout, value, info->value_size, " ");
271 }
272 }
273
274 printf("\n");
275 } else {
276 unsigned int i, n, step;
277
278 n = get_possible_cpus();
279 step = round_up(info->value_size, 8);
280
281 if (info->key_size) {
282 printf("key:\n");
283 fprint_hex(stdout, key, info->key_size, " ");
284 printf("\n");
285 }
286 if (info->value_size) {
287 for (i = 0; i < n; i++) {
288 printf("value (CPU %02u):%c",
289 i, info->value_size > 16 ? '\n' : ' ');
290 fprint_hex(stdout, value + i * step,
291 info->value_size, " ");
292 printf("\n");
293 }
294 }
295 }
296}
297
298static char **parse_bytes(char **argv, const char *name, unsigned char *val,
299 unsigned int n)
300{
301 unsigned int i = 0, base = 0;
302 char *endptr;
303
304 if (is_prefix(*argv, "hex")) {
305 base = 16;
306 argv++;
307 }
308
309 while (i < n && argv[i]) {
310 val[i] = strtoul(argv[i], &endptr, base);
311 if (*endptr) {
312 p_err("error parsing byte: %s", argv[i]);
313 return NULL;
314 }
315 i++;
316 }
317
318 if (i != n) {
319 p_err("%s expected %u bytes got %u", name, n, i);
320 return NULL;
321 }
322
323 return argv + i;
324}
325
326/* on per cpu maps we must copy the provided value on all value instances */
327static void fill_per_cpu_value(struct bpf_map_info *info, void *value)
328{
329 unsigned int i, n, step;
330
331 if (!map_is_per_cpu(info->type))
332 return;
333
334 n = get_possible_cpus();
335 step = round_up(info->value_size, 8);
336 for (i = 1; i < n; i++)
337 memcpy(value + i * step, value, info->value_size);
338}
339
340static int parse_elem(char **argv, struct bpf_map_info *info, void *key,
341 void *value, __u32 key_size, __u32 value_size,
342 __u32 *flags, __u32 **value_fd, __u32 open_flags)
343{
344 if (!*argv) {
345 if (!key && !value)
346 return 0;
347 p_err("did not find %s", key ? "key" : "value");
348 return -1;
349 }
350
351 if (is_prefix(*argv, "key")) {
352 if (!key) {
353 if (key_size)
354 p_err("duplicate key");
355 else
356 p_err("unnecessary key");
357 return -1;
358 }
359
360 argv = parse_bytes(argv + 1, "key", key, key_size);
361 if (!argv)
362 return -1;
363
364 return parse_elem(argv, info, NULL, value, key_size, value_size,
365 flags, value_fd, open_flags);
366 } else if (is_prefix(*argv, "value")) {
367 int fd;
368
369 if (!value) {
370 if (value_size)
371 p_err("duplicate value");
372 else
373 p_err("unnecessary value");
374 return -1;
375 }
376
377 argv++;
378
379 if (map_is_map_of_maps(info->type)) {
380 int argc = 2;
381
382 if (value_size != 4) {
383 p_err("value smaller than 4B for map in map?");
384 return -1;
385 }
386 if (!argv[0] || !argv[1]) {
387 p_err("not enough value arguments for map in map");
388 return -1;
389 }
390
391 fd = map_parse_fd(&argc, &argv, open_flags);
392 if (fd < 0)
393 return -1;
394
395 *value_fd = value;
396 **value_fd = fd;
397 } else if (map_is_map_of_progs(info->type)) {
398 int argc = 2;
399
400 if (value_size != 4) {
401 p_err("value smaller than 4B for map of progs?");
402 return -1;
403 }
404 if (!argv[0] || !argv[1]) {
405 p_err("not enough value arguments for map of progs");
406 return -1;
407 }
408 if (is_prefix(*argv, "id"))
409 p_info("Warning: updating program array via MAP_ID, make sure this map is kept open\n"
410 " by some process or pinned otherwise update will be lost");
411
412 fd = prog_parse_fd(&argc, &argv);
413 if (fd < 0)
414 return -1;
415
416 *value_fd = value;
417 **value_fd = fd;
418 } else {
419 argv = parse_bytes(argv, "value", value, value_size);
420 if (!argv)
421 return -1;
422
423 fill_per_cpu_value(info, value);
424 }
425
426 return parse_elem(argv, info, key, NULL, key_size, value_size,
427 flags, NULL, open_flags);
428 } else if (is_prefix(*argv, "any") || is_prefix(*argv, "noexist") ||
429 is_prefix(*argv, "exist")) {
430 if (!flags) {
431 p_err("flags specified multiple times: %s", *argv);
432 return -1;
433 }
434
435 if (is_prefix(*argv, "any"))
436 *flags = BPF_ANY;
437 else if (is_prefix(*argv, "noexist"))
438 *flags = BPF_NOEXIST;
439 else if (is_prefix(*argv, "exist"))
440 *flags = BPF_EXIST;
441
442 return parse_elem(argv + 1, info, key, value, key_size,
443 value_size, NULL, value_fd, open_flags);
444 }
445
446 p_err("expected key or value, got: %s", *argv);
447 return -1;
448}
449
450static void show_map_header_json(struct bpf_map_info *info, json_writer_t *wtr)
451{
452 const char *map_type_str;
453
454 jsonw_uint_field(wtr, "id", info->id);
455 map_type_str = libbpf_bpf_map_type_str(info->type);
456 if (map_type_str)
457 jsonw_string_field(wtr, "type", map_type_str);
458 else
459 jsonw_uint_field(wtr, "type", info->type);
460
461 if (*info->name)
462 jsonw_string_field(wtr, "name", info->name);
463
464 jsonw_name(wtr, "flags");
465 jsonw_printf(wtr, "%u", info->map_flags);
466}
467
468static int show_map_close_json(int fd, struct bpf_map_info *info)
469{
470 char *memlock, *frozen_str;
471 int frozen = 0;
472
473 memlock = get_fdinfo(fd, "memlock");
474 frozen_str = get_fdinfo(fd, "frozen");
475
476 jsonw_start_object(json_wtr);
477
478 show_map_header_json(info, json_wtr);
479
480 print_dev_json(info->ifindex, info->netns_dev, info->netns_ino);
481
482 jsonw_uint_field(json_wtr, "bytes_key", info->key_size);
483 jsonw_uint_field(json_wtr, "bytes_value", info->value_size);
484 jsonw_uint_field(json_wtr, "max_entries", info->max_entries);
485
486 if (memlock)
487 jsonw_int_field(json_wtr, "bytes_memlock", atoll(memlock));
488 free(memlock);
489
490 if (info->type == BPF_MAP_TYPE_PROG_ARRAY) {
491 char *owner_prog_type = get_fdinfo(fd, "owner_prog_type");
492 char *owner_jited = get_fdinfo(fd, "owner_jited");
493
494 if (owner_prog_type) {
495 unsigned int prog_type = atoi(owner_prog_type);
496 const char *prog_type_str;
497
498 prog_type_str = libbpf_bpf_prog_type_str(prog_type);
499 if (prog_type_str)
500 jsonw_string_field(json_wtr, "owner_prog_type",
501 prog_type_str);
502 else
503 jsonw_uint_field(json_wtr, "owner_prog_type",
504 prog_type);
505 }
506 if (owner_jited)
507 jsonw_bool_field(json_wtr, "owner_jited",
508 !!atoi(owner_jited));
509
510 free(owner_prog_type);
511 free(owner_jited);
512 }
513 close(fd);
514
515 if (frozen_str) {
516 frozen = atoi(frozen_str);
517 free(frozen_str);
518 }
519 jsonw_int_field(json_wtr, "frozen", frozen);
520
521 if (info->btf_id)
522 jsonw_int_field(json_wtr, "btf_id", info->btf_id);
523
524 if (!hashmap__empty(map_table)) {
525 struct hashmap_entry *entry;
526
527 jsonw_name(json_wtr, "pinned");
528 jsonw_start_array(json_wtr);
529 hashmap__for_each_key_entry(map_table, entry, info->id)
530 jsonw_string(json_wtr, entry->pvalue);
531 jsonw_end_array(json_wtr);
532 }
533
534 emit_obj_refs_json(refs_table, info->id, json_wtr);
535
536 jsonw_end_object(json_wtr);
537
538 return 0;
539}
540
541static void show_map_header_plain(struct bpf_map_info *info)
542{
543 const char *map_type_str;
544
545 printf("%u: ", info->id);
546
547 map_type_str = libbpf_bpf_map_type_str(info->type);
548 if (map_type_str)
549 printf("%s ", map_type_str);
550 else
551 printf("type %u ", info->type);
552
553 if (*info->name)
554 printf("name %s ", info->name);
555
556 printf("flags 0x%x", info->map_flags);
557 print_dev_plain(info->ifindex, info->netns_dev, info->netns_ino);
558 printf("\n");
559}
560
561static int show_map_close_plain(int fd, struct bpf_map_info *info)
562{
563 char *memlock, *frozen_str;
564 int frozen = 0;
565
566 memlock = get_fdinfo(fd, "memlock");
567 frozen_str = get_fdinfo(fd, "frozen");
568
569 show_map_header_plain(info);
570 printf("\tkey %uB value %uB max_entries %u",
571 info->key_size, info->value_size, info->max_entries);
572
573 if (memlock)
574 printf(" memlock %sB", memlock);
575 free(memlock);
576
577 if (info->type == BPF_MAP_TYPE_PROG_ARRAY) {
578 char *owner_prog_type = get_fdinfo(fd, "owner_prog_type");
579 char *owner_jited = get_fdinfo(fd, "owner_jited");
580
581 if (owner_prog_type || owner_jited)
582 printf("\n\t");
583 if (owner_prog_type) {
584 unsigned int prog_type = atoi(owner_prog_type);
585 const char *prog_type_str;
586
587 prog_type_str = libbpf_bpf_prog_type_str(prog_type);
588 if (prog_type_str)
589 printf("owner_prog_type %s ", prog_type_str);
590 else
591 printf("owner_prog_type %u ", prog_type);
592 }
593 if (owner_jited)
594 printf("owner%s jited",
595 atoi(owner_jited) ? "" : " not");
596
597 free(owner_prog_type);
598 free(owner_jited);
599 }
600 close(fd);
601
602 if (!hashmap__empty(map_table)) {
603 struct hashmap_entry *entry;
604
605 hashmap__for_each_key_entry(map_table, entry, info->id)
606 printf("\n\tpinned %s", (char *)entry->pvalue);
607 }
608
609 if (frozen_str) {
610 frozen = atoi(frozen_str);
611 free(frozen_str);
612 }
613
614 if (info->btf_id || frozen)
615 printf("\n\t");
616
617 if (info->btf_id)
618 printf("btf_id %u", info->btf_id);
619
620 if (frozen)
621 printf("%sfrozen", info->btf_id ? " " : "");
622
623 emit_obj_refs_plain(refs_table, info->id, "\n\tpids ");
624
625 printf("\n");
626 return 0;
627}
628
629static int do_show_subset(int argc, char **argv)
630{
631 struct bpf_map_info info = {};
632 __u32 len = sizeof(info);
633 int *fds = NULL;
634 int nb_fds, i;
635 int err = -1;
636
637 fds = malloc(sizeof(int));
638 if (!fds) {
639 p_err("mem alloc failed");
640 return -1;
641 }
642 nb_fds = map_parse_fds(&argc, &argv, &fds, BPF_F_RDONLY);
643 if (nb_fds < 1)
644 goto exit_free;
645
646 if (json_output && nb_fds > 1)
647 jsonw_start_array(json_wtr); /* root array */
648 for (i = 0; i < nb_fds; i++) {
649 err = bpf_map_get_info_by_fd(fds[i], &info, &len);
650 if (err) {
651 p_err("can't get map info: %s",
652 strerror(errno));
653 for (; i < nb_fds; i++)
654 close(fds[i]);
655 break;
656 }
657
658 if (json_output)
659 show_map_close_json(fds[i], &info);
660 else
661 show_map_close_plain(fds[i], &info);
662 }
663 if (json_output && nb_fds > 1)
664 jsonw_end_array(json_wtr); /* root array */
665
666exit_free:
667 free(fds);
668 return err;
669}
670
671static int do_show(int argc, char **argv)
672{
673 LIBBPF_OPTS(bpf_get_fd_by_id_opts, opts);
674 struct bpf_map_info info = {};
675 __u32 len = sizeof(info);
676 __u32 id = 0;
677 int err;
678 int fd;
679
680 opts.open_flags = BPF_F_RDONLY;
681
682 if (show_pinned) {
683 map_table = hashmap__new(hash_fn_for_key_as_id,
684 equal_fn_for_key_as_id, NULL);
685 if (IS_ERR(map_table)) {
686 p_err("failed to create hashmap for pinned paths");
687 return -1;
688 }
689 build_pinned_obj_table(map_table, BPF_OBJ_MAP);
690 }
691 build_obj_refs_table(&refs_table, BPF_OBJ_MAP);
692
693 if (argc == 2)
694 return do_show_subset(argc, argv);
695
696 if (argc)
697 return BAD_ARG();
698
699 if (json_output)
700 jsonw_start_array(json_wtr);
701 while (true) {
702 err = bpf_map_get_next_id(id, &id);
703 if (err) {
704 if (errno == ENOENT)
705 break;
706 p_err("can't get next map: %s%s", strerror(errno),
707 errno == EINVAL ? " -- kernel too old?" : "");
708 break;
709 }
710
711 fd = bpf_map_get_fd_by_id_opts(id, &opts);
712 if (fd < 0) {
713 if (errno == ENOENT)
714 continue;
715 p_err("can't get map by id (%u): %s",
716 id, strerror(errno));
717 break;
718 }
719
720 err = bpf_map_get_info_by_fd(fd, &info, &len);
721 if (err) {
722 p_err("can't get map info: %s", strerror(errno));
723 close(fd);
724 break;
725 }
726
727 if (json_output)
728 show_map_close_json(fd, &info);
729 else
730 show_map_close_plain(fd, &info);
731 }
732 if (json_output)
733 jsonw_end_array(json_wtr);
734
735 delete_obj_refs_table(refs_table);
736
737 if (show_pinned)
738 delete_pinned_obj_table(map_table);
739
740 return errno == ENOENT ? 0 : -1;
741}
742
743static int dump_map_elem(int fd, void *key, void *value,
744 struct bpf_map_info *map_info, struct btf *btf,
745 json_writer_t *btf_wtr)
746{
747 if (bpf_map_lookup_elem(fd, key, value)) {
748 print_entry_error(map_info, key, errno);
749 return -1;
750 }
751
752 if (json_output) {
753 print_entry_json(map_info, key, value, btf);
754 } else if (btf) {
755 struct btf_dumper d = {
756 .btf = btf,
757 .jw = btf_wtr,
758 .is_plain_text = true,
759 };
760
761 do_dump_btf(&d, map_info, key, value);
762 } else {
763 print_entry_plain(map_info, key, value);
764 }
765
766 return 0;
767}
768
769static int maps_have_btf(int *fds, int nb_fds)
770{
771 struct bpf_map_info info = {};
772 __u32 len = sizeof(info);
773 int err, i;
774
775 for (i = 0; i < nb_fds; i++) {
776 err = bpf_map_get_info_by_fd(fds[i], &info, &len);
777 if (err) {
778 p_err("can't get map info: %s", strerror(errno));
779 return -1;
780 }
781
782 if (!info.btf_id)
783 return 0;
784 }
785
786 return 1;
787}
788
789static struct btf *btf_vmlinux;
790
791static void free_btf_vmlinux(void)
792{
793 btf__free(btf_vmlinux);
794 btf_vmlinux = NULL;
795}
796
797static int get_map_kv_btf(const struct bpf_map_info *info, struct btf **btf)
798{
799 int err = 0;
800
801 if (info->btf_vmlinux_value_type_id) {
802 if (!btf_vmlinux) {
803 btf_vmlinux = libbpf_find_kernel_btf();
804 if (!btf_vmlinux) {
805 p_err("failed to get kernel btf");
806 return -errno;
807 }
808 }
809 *btf = btf_vmlinux;
810 } else if (info->btf_value_type_id) {
811 *btf = btf__load_from_kernel_by_id(info->btf_id);
812 if (!*btf) {
813 err = -errno;
814 p_err("failed to get btf");
815 }
816 } else {
817 *btf = NULL;
818 }
819
820 return err;
821}
822
823static void free_map_kv_btf(struct btf *btf)
824{
825 if (btf != btf_vmlinux)
826 btf__free(btf);
827}
828
829static int
830map_dump(int fd, struct bpf_map_info *info, json_writer_t *wtr,
831 bool show_header)
832{
833 void *key, *value, *prev_key;
834 unsigned int num_elems = 0;
835 struct btf *btf = NULL;
836 int err;
837
838 key = malloc(info->key_size);
839 value = alloc_value(info);
840 if (!key || !value) {
841 p_err("mem alloc failed");
842 err = -1;
843 goto exit_free;
844 }
845
846 prev_key = NULL;
847
848 if (wtr) {
849 err = get_map_kv_btf(info, &btf);
850 if (err) {
851 goto exit_free;
852 }
853
854 if (show_header) {
855 jsonw_start_object(wtr); /* map object */
856 show_map_header_json(info, wtr);
857 jsonw_name(wtr, "elements");
858 }
859 jsonw_start_array(wtr); /* elements */
860 } else if (show_header) {
861 show_map_header_plain(info);
862 }
863
864 if (info->type == BPF_MAP_TYPE_REUSEPORT_SOCKARRAY &&
865 info->value_size != 8) {
866 const char *map_type_str;
867
868 map_type_str = libbpf_bpf_map_type_str(info->type);
869 p_info("Warning: cannot read values from %s map with value_size != 8",
870 map_type_str);
871 }
872 while (true) {
873 err = bpf_map_get_next_key(fd, prev_key, key);
874 if (err) {
875 if (errno == ENOENT)
876 err = 0;
877 break;
878 }
879 if (!dump_map_elem(fd, key, value, info, btf, wtr))
880 num_elems++;
881 prev_key = key;
882 }
883
884 if (wtr) {
885 jsonw_end_array(wtr); /* elements */
886 if (show_header)
887 jsonw_end_object(wtr); /* map object */
888 } else {
889 printf("Found %u element%s\n", num_elems,
890 num_elems != 1 ? "s" : "");
891 }
892
893exit_free:
894 free(key);
895 free(value);
896 free_map_kv_btf(btf);
897
898 return err;
899}
900
901static int do_dump(int argc, char **argv)
902{
903 json_writer_t *wtr = NULL, *btf_wtr = NULL;
904 struct bpf_map_info info = {};
905 int nb_fds, i = 0;
906 __u32 len = sizeof(info);
907 int *fds = NULL;
908 int err = -1;
909
910 if (argc != 2)
911 usage();
912
913 fds = malloc(sizeof(int));
914 if (!fds) {
915 p_err("mem alloc failed");
916 return -1;
917 }
918 nb_fds = map_parse_fds(&argc, &argv, &fds, BPF_F_RDONLY);
919 if (nb_fds < 1)
920 goto exit_free;
921
922 if (json_output) {
923 wtr = json_wtr;
924 } else {
925 int do_plain_btf;
926
927 do_plain_btf = maps_have_btf(fds, nb_fds);
928 if (do_plain_btf < 0)
929 goto exit_close;
930
931 if (do_plain_btf) {
932 btf_wtr = get_btf_writer();
933 wtr = btf_wtr;
934 if (!btf_wtr)
935 p_info("failed to create json writer for btf. falling back to plain output");
936 }
937 }
938
939 if (wtr && nb_fds > 1)
940 jsonw_start_array(wtr); /* root array */
941 for (i = 0; i < nb_fds; i++) {
942 if (bpf_map_get_info_by_fd(fds[i], &info, &len)) {
943 p_err("can't get map info: %s", strerror(errno));
944 err = -1;
945 break;
946 }
947 err = map_dump(fds[i], &info, wtr, nb_fds > 1);
948 if (!wtr && i != nb_fds - 1)
949 printf("\n");
950
951 if (err)
952 break;
953 close(fds[i]);
954 }
955 if (wtr && nb_fds > 1)
956 jsonw_end_array(wtr); /* root array */
957
958 if (btf_wtr)
959 jsonw_destroy(&btf_wtr);
960exit_close:
961 for (; i < nb_fds; i++)
962 close(fds[i]);
963exit_free:
964 free(fds);
965 free_btf_vmlinux();
966 return err;
967}
968
969static int alloc_key_value(struct bpf_map_info *info, void **key, void **value)
970{
971 *key = NULL;
972 *value = NULL;
973
974 if (info->key_size) {
975 *key = malloc(info->key_size);
976 if (!*key) {
977 p_err("key mem alloc failed");
978 return -1;
979 }
980 }
981
982 if (info->value_size) {
983 *value = alloc_value(info);
984 if (!*value) {
985 p_err("value mem alloc failed");
986 free(*key);
987 *key = NULL;
988 return -1;
989 }
990 }
991
992 return 0;
993}
994
995static int do_update(int argc, char **argv)
996{
997 struct bpf_map_info info = {};
998 __u32 len = sizeof(info);
999 __u32 *value_fd = NULL;
1000 __u32 flags = BPF_ANY;
1001 void *key, *value;
1002 int fd, err;
1003
1004 if (argc < 2)
1005 usage();
1006
1007 fd = map_parse_fd_and_info(&argc, &argv, &info, &len, 0);
1008 if (fd < 0)
1009 return -1;
1010
1011 err = alloc_key_value(&info, &key, &value);
1012 if (err)
1013 goto exit_free;
1014
1015 err = parse_elem(argv, &info, key, value, info.key_size,
1016 info.value_size, &flags, &value_fd, 0);
1017 if (err)
1018 goto exit_free;
1019
1020 err = bpf_map_update_elem(fd, key, value, flags);
1021 if (err) {
1022 p_err("update failed: %s", strerror(errno));
1023 goto exit_free;
1024 }
1025
1026exit_free:
1027 if (value_fd)
1028 close(*value_fd);
1029 free(key);
1030 free(value);
1031 close(fd);
1032
1033 if (!err && json_output)
1034 jsonw_null(json_wtr);
1035 return err;
1036}
1037
1038static void print_key_value(struct bpf_map_info *info, void *key,
1039 void *value)
1040{
1041 json_writer_t *btf_wtr;
1042 struct btf *btf;
1043
1044 if (get_map_kv_btf(info, &btf))
1045 return;
1046
1047 if (json_output) {
1048 print_entry_json(info, key, value, btf);
1049 } else if (btf) {
1050 /* if here json_wtr wouldn't have been initialised,
1051 * so let's create separate writer for btf
1052 */
1053 btf_wtr = get_btf_writer();
1054 if (!btf_wtr) {
1055 p_info("failed to create json writer for btf. falling back to plain output");
1056 free_map_kv_btf(btf);
1057 btf = NULL;
1058 print_entry_plain(info, key, value);
1059 } else {
1060 struct btf_dumper d = {
1061 .btf = btf,
1062 .jw = btf_wtr,
1063 .is_plain_text = true,
1064 };
1065
1066 do_dump_btf(&d, info, key, value);
1067 jsonw_destroy(&btf_wtr);
1068 }
1069 } else {
1070 print_entry_plain(info, key, value);
1071 }
1072 free_map_kv_btf(btf);
1073}
1074
1075static int do_lookup(int argc, char **argv)
1076{
1077 struct bpf_map_info info = {};
1078 __u32 len = sizeof(info);
1079 void *key, *value;
1080 int err;
1081 int fd;
1082
1083 if (argc < 2)
1084 usage();
1085
1086 fd = map_parse_fd_and_info(&argc, &argv, &info, &len, BPF_F_RDONLY);
1087 if (fd < 0)
1088 return -1;
1089
1090 err = alloc_key_value(&info, &key, &value);
1091 if (err)
1092 goto exit_free;
1093
1094 err = parse_elem(argv, &info, key, NULL, info.key_size, 0, NULL, NULL,
1095 BPF_F_RDONLY);
1096 if (err)
1097 goto exit_free;
1098
1099 err = bpf_map_lookup_elem(fd, key, value);
1100 if (err) {
1101 if (errno == ENOENT) {
1102 if (json_output) {
1103 jsonw_null(json_wtr);
1104 } else {
1105 printf("key:\n");
1106 fprint_hex(stdout, key, info.key_size, " ");
1107 printf("\n\nNot found\n");
1108 }
1109 } else {
1110 p_err("lookup failed: %s", strerror(errno));
1111 }
1112
1113 goto exit_free;
1114 }
1115
1116 /* here means bpf_map_lookup_elem() succeeded */
1117 print_key_value(&info, key, value);
1118
1119exit_free:
1120 free(key);
1121 free(value);
1122 close(fd);
1123
1124 return err;
1125}
1126
1127static int do_getnext(int argc, char **argv)
1128{
1129 struct bpf_map_info info = {};
1130 __u32 len = sizeof(info);
1131 void *key, *nextkey;
1132 int err;
1133 int fd;
1134
1135 if (argc < 2)
1136 usage();
1137
1138 fd = map_parse_fd_and_info(&argc, &argv, &info, &len, BPF_F_RDONLY);
1139 if (fd < 0)
1140 return -1;
1141
1142 key = malloc(info.key_size);
1143 nextkey = malloc(info.key_size);
1144 if (!key || !nextkey) {
1145 p_err("mem alloc failed");
1146 err = -1;
1147 goto exit_free;
1148 }
1149
1150 if (argc) {
1151 err = parse_elem(argv, &info, key, NULL, info.key_size, 0, NULL,
1152 NULL, BPF_F_RDONLY);
1153 if (err)
1154 goto exit_free;
1155 } else {
1156 free(key);
1157 key = NULL;
1158 }
1159
1160 err = bpf_map_get_next_key(fd, key, nextkey);
1161 if (err) {
1162 p_err("can't get next key: %s", strerror(errno));
1163 goto exit_free;
1164 }
1165
1166 if (json_output) {
1167 jsonw_start_object(json_wtr);
1168 if (key) {
1169 jsonw_name(json_wtr, "key");
1170 print_hex_data_json(key, info.key_size);
1171 } else {
1172 jsonw_null_field(json_wtr, "key");
1173 }
1174 jsonw_name(json_wtr, "next_key");
1175 print_hex_data_json(nextkey, info.key_size);
1176 jsonw_end_object(json_wtr);
1177 } else {
1178 if (key) {
1179 printf("key:\n");
1180 fprint_hex(stdout, key, info.key_size, " ");
1181 printf("\n");
1182 } else {
1183 printf("key: None\n");
1184 }
1185 printf("next key:\n");
1186 fprint_hex(stdout, nextkey, info.key_size, " ");
1187 printf("\n");
1188 }
1189
1190exit_free:
1191 free(nextkey);
1192 free(key);
1193 close(fd);
1194
1195 return err;
1196}
1197
1198static int do_delete(int argc, char **argv)
1199{
1200 struct bpf_map_info info = {};
1201 __u32 len = sizeof(info);
1202 void *key;
1203 int err;
1204 int fd;
1205
1206 if (argc < 2)
1207 usage();
1208
1209 fd = map_parse_fd_and_info(&argc, &argv, &info, &len, 0);
1210 if (fd < 0)
1211 return -1;
1212
1213 key = malloc(info.key_size);
1214 if (!key) {
1215 p_err("mem alloc failed");
1216 err = -1;
1217 goto exit_free;
1218 }
1219
1220 err = parse_elem(argv, &info, key, NULL, info.key_size, 0, NULL, NULL,
1221 0);
1222 if (err)
1223 goto exit_free;
1224
1225 err = bpf_map_delete_elem(fd, key);
1226 if (err)
1227 p_err("delete failed: %s", strerror(errno));
1228
1229exit_free:
1230 free(key);
1231 close(fd);
1232
1233 if (!err && json_output)
1234 jsonw_null(json_wtr);
1235 return err;
1236}
1237
1238static int map_parse_read_only_fd(int *argc, char ***argv)
1239{
1240 return map_parse_fd(argc, argv, BPF_F_RDONLY);
1241}
1242
1243static int do_pin(int argc, char **argv)
1244{
1245 int err;
1246
1247 err = do_pin_any(argc, argv, map_parse_read_only_fd);
1248 if (!err && json_output)
1249 jsonw_null(json_wtr);
1250 return err;
1251}
1252
1253static int do_create(int argc, char **argv)
1254{
1255 LIBBPF_OPTS(bpf_map_create_opts, attr);
1256 enum bpf_map_type map_type = BPF_MAP_TYPE_UNSPEC;
1257 __u32 key_size = 0, value_size = 0, max_entries = 0;
1258 const char *map_name = NULL;
1259 const char *pinfile;
1260 int err = -1, fd;
1261
1262 if (!REQ_ARGS(7))
1263 return -1;
1264 pinfile = GET_ARG();
1265
1266 while (argc) {
1267 if (!REQ_ARGS(2))
1268 return -1;
1269
1270 if (is_prefix(*argv, "type")) {
1271 NEXT_ARG();
1272
1273 if (map_type) {
1274 p_err("map type already specified");
1275 goto exit;
1276 }
1277
1278 map_type = map_type_from_str(*argv);
1279 if ((int)map_type < 0) {
1280 p_err("unrecognized map type: %s", *argv);
1281 goto exit;
1282 }
1283 NEXT_ARG();
1284 } else if (is_prefix(*argv, "name")) {
1285 NEXT_ARG();
1286 map_name = GET_ARG();
1287 if (strlen(map_name) > BPF_OBJ_NAME_LEN - 1) {
1288 p_info("Warning: map name is longer than %u characters, it will be truncated.",
1289 BPF_OBJ_NAME_LEN - 1);
1290 }
1291 } else if (is_prefix(*argv, "key")) {
1292 if (parse_u32_arg(&argc, &argv, &key_size,
1293 "key size"))
1294 goto exit;
1295 } else if (is_prefix(*argv, "value")) {
1296 if (parse_u32_arg(&argc, &argv, &value_size,
1297 "value size"))
1298 goto exit;
1299 } else if (is_prefix(*argv, "entries")) {
1300 if (parse_u32_arg(&argc, &argv, &max_entries,
1301 "max entries"))
1302 goto exit;
1303 } else if (is_prefix(*argv, "flags")) {
1304 if (parse_u32_arg(&argc, &argv, &attr.map_flags,
1305 "flags"))
1306 goto exit;
1307 } else if (is_prefix(*argv, "dev")) {
1308 p_info("Warning: 'bpftool map create [...] dev <ifname>' syntax is deprecated.\n"
1309 "Going further, please use 'offload_dev <ifname>' to request hardware offload for the map.");
1310 goto offload_dev;
1311 } else if (is_prefix(*argv, "offload_dev")) {
1312offload_dev:
1313 NEXT_ARG();
1314
1315 if (attr.map_ifindex) {
1316 p_err("offload device already specified");
1317 goto exit;
1318 }
1319
1320 attr.map_ifindex = if_nametoindex(*argv);
1321 if (!attr.map_ifindex) {
1322 p_err("unrecognized netdevice '%s': %s",
1323 *argv, strerror(errno));
1324 goto exit;
1325 }
1326 NEXT_ARG();
1327 } else if (is_prefix(*argv, "inner_map")) {
1328 struct bpf_map_info info = {};
1329 __u32 len = sizeof(info);
1330 int inner_map_fd;
1331
1332 NEXT_ARG();
1333 if (!REQ_ARGS(2))
1334 usage();
1335 inner_map_fd = map_parse_fd_and_info(&argc, &argv,
1336 &info, &len, BPF_F_RDONLY);
1337 if (inner_map_fd < 0)
1338 return -1;
1339 attr.inner_map_fd = inner_map_fd;
1340 } else {
1341 p_err("unknown arg %s", *argv);
1342 goto exit;
1343 }
1344 }
1345
1346 if (!map_name) {
1347 p_err("map name not specified");
1348 goto exit;
1349 }
1350
1351 set_max_rlimit();
1352
1353 fd = bpf_map_create(map_type, map_name, key_size, value_size, max_entries, &attr);
1354 if (fd < 0) {
1355 p_err("map create failed: %s", strerror(errno));
1356 goto exit;
1357 }
1358
1359 err = do_pin_fd(fd, pinfile);
1360 close(fd);
1361 if (err)
1362 goto exit;
1363
1364 if (json_output)
1365 jsonw_null(json_wtr);
1366
1367exit:
1368 if (attr.inner_map_fd > 0)
1369 close(attr.inner_map_fd);
1370
1371 return err;
1372}
1373
1374static int do_pop_dequeue(int argc, char **argv)
1375{
1376 struct bpf_map_info info = {};
1377 __u32 len = sizeof(info);
1378 void *key, *value;
1379 int err;
1380 int fd;
1381
1382 if (argc < 2)
1383 usage();
1384
1385 fd = map_parse_fd_and_info(&argc, &argv, &info, &len, 0);
1386 if (fd < 0)
1387 return -1;
1388
1389 err = alloc_key_value(&info, &key, &value);
1390 if (err)
1391 goto exit_free;
1392
1393 err = bpf_map_lookup_and_delete_elem(fd, key, value);
1394 if (err) {
1395 if (errno == ENOENT) {
1396 if (json_output)
1397 jsonw_null(json_wtr);
1398 else
1399 printf("Error: empty map\n");
1400 } else {
1401 p_err("pop failed: %s", strerror(errno));
1402 }
1403
1404 goto exit_free;
1405 }
1406
1407 print_key_value(&info, key, value);
1408
1409exit_free:
1410 free(key);
1411 free(value);
1412 close(fd);
1413
1414 return err;
1415}
1416
1417static int do_freeze(int argc, char **argv)
1418{
1419 int err, fd;
1420
1421 if (!REQ_ARGS(2))
1422 return -1;
1423
1424 fd = map_parse_fd(&argc, &argv, 0);
1425 if (fd < 0)
1426 return -1;
1427
1428 if (argc) {
1429 close(fd);
1430 return BAD_ARG();
1431 }
1432
1433 err = bpf_map_freeze(fd);
1434 close(fd);
1435 if (err) {
1436 p_err("failed to freeze map: %s", strerror(errno));
1437 return err;
1438 }
1439
1440 if (json_output)
1441 jsonw_null(json_wtr);
1442
1443 return 0;
1444}
1445
1446static int do_help(int argc, char **argv)
1447{
1448 if (json_output) {
1449 jsonw_null(json_wtr);
1450 return 0;
1451 }
1452
1453 fprintf(stderr,
1454 "Usage: %1$s %2$s { show | list } [MAP]\n"
1455 " %1$s %2$s create FILE type TYPE key KEY_SIZE value VALUE_SIZE \\\n"
1456 " entries MAX_ENTRIES name NAME [flags FLAGS] \\\n"
1457 " [inner_map MAP] [offload_dev NAME]\n"
1458 " %1$s %2$s dump MAP\n"
1459 " %1$s %2$s update MAP [key DATA] [value VALUE] [UPDATE_FLAGS]\n"
1460 " %1$s %2$s lookup MAP [key DATA]\n"
1461 " %1$s %2$s getnext MAP [key DATA]\n"
1462 " %1$s %2$s delete MAP key DATA\n"
1463 " %1$s %2$s pin MAP FILE\n"
1464 " %1$s %2$s event_pipe MAP [cpu N index M]\n"
1465 " %1$s %2$s peek MAP\n"
1466 " %1$s %2$s push MAP value VALUE\n"
1467 " %1$s %2$s pop MAP\n"
1468 " %1$s %2$s enqueue MAP value VALUE\n"
1469 " %1$s %2$s dequeue MAP\n"
1470 " %1$s %2$s freeze MAP\n"
1471 " %1$s %2$s help\n"
1472 "\n"
1473 " " HELP_SPEC_MAP "\n"
1474 " DATA := { [hex] BYTES }\n"
1475 " " HELP_SPEC_PROGRAM "\n"
1476 " VALUE := { DATA | MAP | PROG }\n"
1477 " UPDATE_FLAGS := { any | exist | noexist }\n"
1478 " TYPE := { hash | array | prog_array | perf_event_array | percpu_hash |\n"
1479 " percpu_array | stack_trace | cgroup_array | lru_hash |\n"
1480 " lru_percpu_hash | lpm_trie | array_of_maps | hash_of_maps |\n"
1481 " devmap | devmap_hash | sockmap | cpumap | xskmap | sockhash |\n"
1482 " cgroup_storage | reuseport_sockarray | percpu_cgroup_storage |\n"
1483 " queue | stack | sk_storage | struct_ops | ringbuf | inode_storage |\n"
1484 " task_storage | bloom_filter | user_ringbuf | cgrp_storage | arena |\n"
1485 " insn_array | rhash }\n"
1486 " " HELP_SPEC_OPTIONS " |\n"
1487 " {-f|--bpffs} | {-n|--nomount} }\n"
1488 "",
1489 bin_name, argv[-2]);
1490
1491 return 0;
1492}
1493
1494static const struct cmd cmds[] = {
1495 { "show", do_show },
1496 { "list", do_show },
1497 { "help", do_help },
1498 { "dump", do_dump },
1499 { "update", do_update },
1500 { "lookup", do_lookup },
1501 { "getnext", do_getnext },
1502 { "delete", do_delete },
1503 { "pin", do_pin },
1504 { "event_pipe", do_event_pipe },
1505 { "create", do_create },
1506 { "peek", do_lookup },
1507 { "push", do_update },
1508 { "enqueue", do_update },
1509 { "pop", do_pop_dequeue },
1510 { "dequeue", do_pop_dequeue },
1511 { "freeze", do_freeze },
1512 { 0 }
1513};
1514
1515int do_map(int argc, char **argv)
1516{
1517 return cmd_select(cmds, argc, argv, do_help);
1518}