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

 
 
 1================
 2BPFTOOL
 3================
 4-------------------------------------------------------------------------------
 5tool for inspection and simple manipulation of eBPF programs and maps
 6-------------------------------------------------------------------------------
 7
 8:Manual section: 8
 9
 
 
10SYNOPSIS
11========
12
13	**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
14
15	**bpftool** **batch file** *FILE*
16
17	**bpftool** **version**
18
19	*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
 
20
21	*OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
22	| { **-j** | **--json** } [{ **-p** | **--pretty** }] }
23
24	*MAP-COMMANDS* :=
25	{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
26	| **delete** | **pin** | **event_pipe** | **help** }
27
28	*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
29	| **load** | **attach** | **detach** | **help** }
30
31	*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
32
33	*PERF-COMMANDS* := { **show** | **list** | **help** }
34
35	*NET-COMMANDS* := { **show** | **list** | **help** }
36
37	*FEATURE-COMMANDS* := { **probe** | **help** }
38
39DESCRIPTION
40===========
41	*bpftool* allows for inspection and simple modification of BPF objects
42	on the system.
43
44	Note that format of the output of all tools is not guaranteed to be
45	stable and should not be depended upon.
46
47OPTIONS
48=======
49	-h, --help
50		  Print short help message (similar to **bpftool help**).
51
52	-V, --version
53		  Print version number (similar to **bpftool version**).
54
55	-j, --json
56		  Generate JSON output. For commands that cannot produce JSON, this
57		  option has no effect.
58
59	-p, --pretty
60		  Generate human-readable JSON output. Implies **-j**.
 
 
61
62	-m, --mapcompat
63		  Allow loading maps with unknown map definitions.
64
65	-n, --nomount
66		  Do not automatically attempt to mount any virtual file system
67		  (such as tracefs or BPF virtual file system) when necessary.
68
69	-d, --debug
70		  Print all logs available, even debug-level information. This
71		  includes logs from libbpf as well as from the verifier, when
72		  attempting to load programs.
73
74SEE ALSO
75========
76	**bpf**\ (2),
77	**bpf-helpers**\ (7),
78	**bpftool-prog**\ (8),
79	**bpftool-map**\ (8),
80	**bpftool-cgroup**\ (8),
81	**bpftool-feature**\ (8),
82	**bpftool-net**\ (8),
83	**bpftool-perf**\ (8),
84	**bpftool-btf**\ (8)