xref: /OK3568_Linux_fs/kernel/tools/bpf/bpftool/Documentation/bpftool.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun================
2*4882a593SmuzhiyunBPFTOOL
3*4882a593Smuzhiyun================
4*4882a593Smuzhiyun-------------------------------------------------------------------------------
5*4882a593Smuzhiyuntool for inspection and simple manipulation of eBPF programs and maps
6*4882a593Smuzhiyun-------------------------------------------------------------------------------
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun:Manual section: 8
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunSYNOPSIS
11*4882a593Smuzhiyun========
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun	**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun	**bpftool** **batch file** *FILE*
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun	**bpftool** **version**
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun	*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun	*OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
22*4882a593Smuzhiyun	| { **-j** | **--json** } [{ **-p** | **--pretty** }] }
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun	*MAP-COMMANDS* :=
25*4882a593Smuzhiyun	{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
26*4882a593Smuzhiyun	| **delete** | **pin** | **event_pipe** | **help** }
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun	*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
29*4882a593Smuzhiyun	| **load** | **attach** | **detach** | **help** }
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun	*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun	*PERF-COMMANDS* := { **show** | **list** | **help** }
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun	*NET-COMMANDS* := { **show** | **list** | **help** }
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun	*FEATURE-COMMANDS* := { **probe** | **help** }
38*4882a593Smuzhiyun
39*4882a593SmuzhiyunDESCRIPTION
40*4882a593Smuzhiyun===========
41*4882a593Smuzhiyun	*bpftool* allows for inspection and simple modification of BPF objects
42*4882a593Smuzhiyun	on the system.
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun	Note that format of the output of all tools is not guaranteed to be
45*4882a593Smuzhiyun	stable and should not be depended upon.
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunOPTIONS
48*4882a593Smuzhiyun=======
49*4882a593Smuzhiyun	.. include:: common_options.rst
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun	-m, --mapcompat
52*4882a593Smuzhiyun		  Allow loading maps with unknown map definitions.
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun	-n, --nomount
55*4882a593Smuzhiyun		  Do not automatically attempt to mount any virtual file system
56*4882a593Smuzhiyun		  (such as tracefs or BPF virtual file system) when necessary.
57