Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / ebbed0f46ed9d3ae23291d67cd52d18abb8501bc / . / tools / bpf / bpftool / Documentation / bpftool.rst
blob: 4f2188845dd8338f435db3c7ac07e742e9b3ecbd [file] [log] [blame]
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]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
Quentin Monnet0641c3c2017-10-23 09:24:16 -0700[diff] [blame]13 **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]14
Quentin Monnet47ff7ac2017-10-23 09:24:15 -0700[diff] [blame]15 **bpftool** **batch file** *FILE*
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]16
Quentin Monnet47ff7ac2017-10-23 09:24:15 -0700[diff] [blame]17 **bpftool** **version**
Quentin Monnet821cfbb2017-10-19 15:46:26 -0700[diff] [blame]18
Prashant Bholeebbed0f2019-02-12 10:25:12 +0900[diff] [blame^]19 *OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]20
Quentin Monnet0641c3c2017-10-23 09:24:16 -0700[diff] [blame]21 *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
22 | { **-j** | **--json** } [{ **-p** | **--pretty** }] }
23
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]24 *MAP-COMMANDS* :=
Jakub Kicinski0b592b5a2018-10-15 16:30:36 -0700[diff] [blame]25 { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
26 | **delete** | **pin** | **event_pipe** | **help** }
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]27
Jakub Kicinski6ebe6db2018-01-02 14:48:36 -0800[diff] [blame]28 *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
John Fastabendb7d38262018-10-15 11:19:50 -0700[diff] [blame]29 | **load** | **attach** | **detach** | **help** }
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]30
Jakub Kicinski6ebe6db2018-01-02 14:48:36 -0800[diff] [blame]31 *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
Roman Gushchin5ccda642017-12-13 15:18:54 +0000[diff] [blame]32
Yonghong Songb04df402018-05-24 11:21:58 -0700[diff] [blame]33 *PERF-COMMANDS* := { **show** | **list** | **help** }
34
Yonghong Songf6f3bac2018-09-05 16:58:06 -0700[diff] [blame]35 *NET-COMMANDS* := { **show** | **list** | **help** }
36
Prashant Bholeebbed0f2019-02-12 10:25:12 +0900[diff] [blame^]37 *FEATURE-COMMANDS* := { **probe** | **help** }
38
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]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
Quentin Monneta2bc2e52017-10-23 09:24:06 -0700[diff] [blame]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
Quentin Monnet0641c3c2017-10-23 09:24:16 -0700[diff] [blame]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
John Fastabendc034a172018-10-15 11:19:55 -0700[diff] [blame]62 -m, --mapcompat
63 Allow loading maps with unknown map definitions.
64
Quentin Monnet33221302018-12-18 10:13:19 +0000[diff] [blame]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
John Fastabendc034a172018-10-15 11:19:55 -0700[diff] [blame]69
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]70SEE ALSO
71========
Quentin Monnetf98e46a2018-11-08 11:52:28 +0000[diff] [blame]72 **bpf**\ (2),
73 **bpf-helpers**\ (7),
74 **bpftool-prog**\ (8),
75 **bpftool-map**\ (8),
76 **bpftool-cgroup**\ (8),
Quentin Monnet49eb7ab2019-01-17 15:27:50 +0000[diff] [blame]77 **bpftool-feature**\ (8),
Quentin Monnetf98e46a2018-11-08 11:52:28 +0000[diff] [blame]78 **bpftool-net**\ (8),
79 **bpftool-perf**\ (8)