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