xref: /aosp_15_r20/external/bpftool/docs/bpftool.rst (revision 858ea5e570667251cdc31d3fe7b846b591105938)
1*858ea5e5SAndroid Build Coastguard Worker.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*858ea5e5SAndroid Build Coastguard Worker
3*858ea5e5SAndroid Build Coastguard Worker================
4*858ea5e5SAndroid Build Coastguard WorkerBPFTOOL
5*858ea5e5SAndroid Build Coastguard Worker================
6*858ea5e5SAndroid Build Coastguard Worker-------------------------------------------------------------------------------
7*858ea5e5SAndroid Build Coastguard Workertool for inspection and simple manipulation of eBPF programs and maps
8*858ea5e5SAndroid Build Coastguard Worker-------------------------------------------------------------------------------
9*858ea5e5SAndroid Build Coastguard Worker
10*858ea5e5SAndroid Build Coastguard Worker:Manual section: 8
11*858ea5e5SAndroid Build Coastguard Worker
12*858ea5e5SAndroid Build Coastguard Worker.. include:: substitutions.rst
13*858ea5e5SAndroid Build Coastguard Worker
14*858ea5e5SAndroid Build Coastguard WorkerSYNOPSIS
15*858ea5e5SAndroid Build Coastguard Worker========
16*858ea5e5SAndroid Build Coastguard Worker
17*858ea5e5SAndroid Build Coastguard Worker	**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
18*858ea5e5SAndroid Build Coastguard Worker
19*858ea5e5SAndroid Build Coastguard Worker	**bpftool** **batch file** *FILE*
20*858ea5e5SAndroid Build Coastguard Worker
21*858ea5e5SAndroid Build Coastguard Worker	**bpftool** **version**
22*858ea5e5SAndroid Build Coastguard Worker
23*858ea5e5SAndroid Build Coastguard Worker	*OBJECT* := { **map** | **prog** | **link** | **cgroup** | **perf** | **net** | **feature** |
24*858ea5e5SAndroid Build Coastguard Worker	**btf** | **gen** | **struct_ops** | **iter** }
25*858ea5e5SAndroid Build Coastguard Worker
26*858ea5e5SAndroid Build Coastguard Worker	*OPTIONS* := { { **-V** | **--version** } | |COMMON_OPTIONS| }
27*858ea5e5SAndroid Build Coastguard Worker
28*858ea5e5SAndroid Build Coastguard Worker	*MAP-COMMANDS* :=
29*858ea5e5SAndroid Build Coastguard Worker	{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
30*858ea5e5SAndroid Build Coastguard Worker	**delete** | **pin** | **event_pipe** | **help** }
31*858ea5e5SAndroid Build Coastguard Worker
32*858ea5e5SAndroid Build Coastguard Worker	*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
33*858ea5e5SAndroid Build Coastguard Worker	**load** | **attach** | **detach** | **help** }
34*858ea5e5SAndroid Build Coastguard Worker
35*858ea5e5SAndroid Build Coastguard Worker	*LINK-COMMANDS* := { **show** | **list** | **pin** | **detach** | **help** }
36*858ea5e5SAndroid Build Coastguard Worker
37*858ea5e5SAndroid Build Coastguard Worker	*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
38*858ea5e5SAndroid Build Coastguard Worker
39*858ea5e5SAndroid Build Coastguard Worker	*PERF-COMMANDS* := { **show** | **list** | **help** }
40*858ea5e5SAndroid Build Coastguard Worker
41*858ea5e5SAndroid Build Coastguard Worker	*NET-COMMANDS* := { **show** | **list** | **help** }
42*858ea5e5SAndroid Build Coastguard Worker
43*858ea5e5SAndroid Build Coastguard Worker	*FEATURE-COMMANDS* := { **probe** | **help** }
44*858ea5e5SAndroid Build Coastguard Worker
45*858ea5e5SAndroid Build Coastguard Worker	*BTF-COMMANDS* := { **show** | **list** | **dump** | **help** }
46*858ea5e5SAndroid Build Coastguard Worker
47*858ea5e5SAndroid Build Coastguard Worker	*GEN-COMMANDS* := { **object** | **skeleton** | **min_core_btf** | **help** }
48*858ea5e5SAndroid Build Coastguard Worker
49*858ea5e5SAndroid Build Coastguard Worker	*STRUCT-OPS-COMMANDS* := { **show** | **list** | **dump** | **register** | **unregister** | **help** }
50*858ea5e5SAndroid Build Coastguard Worker
51*858ea5e5SAndroid Build Coastguard Worker	*ITER-COMMANDS* := { **pin** | **help** }
52*858ea5e5SAndroid Build Coastguard Worker
53*858ea5e5SAndroid Build Coastguard WorkerDESCRIPTION
54*858ea5e5SAndroid Build Coastguard Worker===========
55*858ea5e5SAndroid Build Coastguard Worker	*bpftool* allows for inspection and simple modification of BPF objects
56*858ea5e5SAndroid Build Coastguard Worker	on the system.
57*858ea5e5SAndroid Build Coastguard Worker
58*858ea5e5SAndroid Build Coastguard Worker	Note that format of the output of all tools is not guaranteed to be
59*858ea5e5SAndroid Build Coastguard Worker	stable and should not be depended upon.
60*858ea5e5SAndroid Build Coastguard Worker
61*858ea5e5SAndroid Build Coastguard WorkerOPTIONS
62*858ea5e5SAndroid Build Coastguard Worker=======
63*858ea5e5SAndroid Build Coastguard Worker	.. include:: common_options.rst
64*858ea5e5SAndroid Build Coastguard Worker
65*858ea5e5SAndroid Build Coastguard Worker	-m, --mapcompat
66*858ea5e5SAndroid Build Coastguard Worker		  Allow loading maps with unknown map definitions.
67*858ea5e5SAndroid Build Coastguard Worker
68*858ea5e5SAndroid Build Coastguard Worker	-n, --nomount
69*858ea5e5SAndroid Build Coastguard Worker		  Do not automatically attempt to mount any virtual file system
70*858ea5e5SAndroid Build Coastguard Worker		  (such as tracefs or BPF virtual file system) when necessary.
71