1============ 2bpftool-iter 3============ 4------------------------------------------------------------------------------- 5tool to create BPF iterators 6------------------------------------------------------------------------------- 7 8:Manual section: 8 9 10SYNOPSIS 11======== 12 13 **bpftool** [*OPTIONS*] **iter** *COMMAND* 14 15 *COMMANDS* := { **pin** | **help** } 16 17ITER COMMANDS 18=================== 19 20| **bpftool** **iter pin** *OBJ* *PATH* 21| **bpftool** **iter help** 22| 23| *OBJ* := /a/file/of/bpf_iter_target.o 24 25 26DESCRIPTION 27=========== 28 **bpftool iter pin** *OBJ* *PATH* 29 A bpf iterator combines a kernel iterating of 30 particular kernel data (e.g., tasks, bpf_maps, etc.) 31 and a bpf program called for each kernel data object 32 (e.g., one task, one bpf_map, etc.). User space can 33 *read* kernel iterator output through *read()* syscall. 34 35 The *pin* command creates a bpf iterator from *OBJ*, 36 and pin it to *PATH*. The *PATH* should be located 37 in *bpffs* mount. It must not contain a dot 38 character ('.'), which is reserved for future extensions 39 of *bpffs*. 40 41 User can then *cat PATH* to see the bpf iterator output. 42 43 **bpftool iter help** 44 Print short help message. 45 46OPTIONS 47======= 48 -h, --help 49 Print short generic help message (similar to **bpftool help**). 50 51 -V, --version 52 Print version number (similar to **bpftool version**). 53 54 -d, --debug 55 Print all logs available, even debug-level information. This 56 includes logs from libbpf as well as from the verifier, when 57 attempting to load programs. 58 59EXAMPLES 60======== 61**# bpftool iter pin bpf_iter_netlink.o /sys/fs/bpf/my_netlink** 62 63:: 64 65 Create a file-based bpf iterator from bpf_iter_netlink.o and pin it 66 to /sys/fs/bpf/my_netlink 67 68 69SEE ALSO 70======== 71 **bpf**\ (2), 72 **bpf-helpers**\ (7), 73 **bpftool**\ (8), 74 **bpftool-prog**\ (8), 75 **bpftool-map**\ (8), 76 **bpftool-link**\ (8), 77 **bpftool-cgroup**\ (8), 78 **bpftool-feature**\ (8), 79 **bpftool-net**\ (8), 80 **bpftool-perf**\ (8), 81 **bpftool-btf**\ (8) 82 **bpftool-gen**\ (8) 83 **bpftool-struct_ops**\ (8) 84