mirror of
https://github.com/Fishwaldo/Star64_linux.git
synced 2025-06-23 07:01:23 +00:00
f28ef96d7b
Nearly all man pages for bpftool have the same common set of option flags (--help, --version, --json, --pretty, --debug). The description is duplicated across all the pages, which is more difficult to maintain if the description of an option changes. It may also be confusing to sort out what options are not "common" and should not be copied when creating new manual pages. Let's move the description for those common options to a separate file, which is included with a RST directive when generating the man pages. Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Alexei Starovoitov <ast@kernel.org> Acked-by: Andrii Nakryiko <andriin@fb.com> Link: https://lore.kernel.org/bpf/20200909162500.17010-3-quentin@isovalent.com
86 lines
2.3 KiB
ReStructuredText
86 lines
2.3 KiB
ReStructuredText
============
|
|
bpftool-iter
|
|
============
|
|
-------------------------------------------------------------------------------
|
|
tool to create BPF iterators
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **iter** *COMMAND*
|
|
|
|
*COMMANDS* := { **pin** | **help** }
|
|
|
|
ITER COMMANDS
|
|
===================
|
|
|
|
| **bpftool** **iter pin** *OBJ* *PATH* [**map** *MAP*]
|
|
| **bpftool** **iter help**
|
|
|
|
|
| *OBJ* := /a/file/of/bpf_iter_target.o
|
|
| *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool iter pin** *OBJ* *PATH* [**map** *MAP*]
|
|
A bpf iterator combines a kernel iterating of
|
|
particular kernel data (e.g., tasks, bpf_maps, etc.)
|
|
and a bpf program called for each kernel data object
|
|
(e.g., one task, one bpf_map, etc.). User space can
|
|
*read* kernel iterator output through *read()* syscall.
|
|
|
|
The *pin* command creates a bpf iterator from *OBJ*,
|
|
and pin it to *PATH*. The *PATH* should be located
|
|
in *bpffs* mount. It must not contain a dot
|
|
character ('.'), which is reserved for future extensions
|
|
of *bpffs*.
|
|
|
|
Map element bpf iterator requires an additional parameter
|
|
*MAP* so bpf program can iterate over map elements for
|
|
that map. User can have a bpf program in kernel to run
|
|
with each map element, do checking, filtering, aggregation,
|
|
etc. without copying data to user space.
|
|
|
|
User can then *cat PATH* to see the bpf iterator output.
|
|
|
|
**bpftool iter help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
EXAMPLES
|
|
========
|
|
**# bpftool iter pin bpf_iter_netlink.o /sys/fs/bpf/my_netlink**
|
|
|
|
::
|
|
|
|
Create a file-based bpf iterator from bpf_iter_netlink.o and pin it
|
|
to /sys/fs/bpf/my_netlink
|
|
|
|
**# bpftool iter pin bpf_iter_hashmap.o /sys/fs/bpf/my_hashmap map id 20**
|
|
|
|
::
|
|
|
|
Create a file-based bpf iterator from bpf_iter_hashmap.o and map with
|
|
id 20, and pin it to /sys/fs/bpf/my_hashmap
|
|
|
|
SEE ALSO
|
|
========
|
|
**bpf**\ (2),
|
|
**bpf-helpers**\ (7),
|
|
**bpftool**\ (8),
|
|
**bpftool-btf**\ (8),
|
|
**bpftool-cgroup**\ (8),
|
|
**bpftool-feature**\ (8),
|
|
**bpftool-gen**\ (8),
|
|
**bpftool-link**\ (8),
|
|
**bpftool-map**\ (8),
|
|
**bpftool-net**\ (8),
|
|
**bpftool-perf**\ (8),
|
|
**bpftool-prog**\ (8),
|
|
**bpftool-struct_ops**\ (8)
|