Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-5.4 / b04df400c30235fa347313c9e2a0695549bd2c8e / . / tools / bpf / bpftool / Documentation / bpftool.rst
blob: b6f5d560460d5554d99df1f979faf6d5e49c7200 [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
Yonghong Songb04df402018-05-24 11:21:58 -0700[diff] [blame^]19 *OBJECT* := { **map** | **program** | **cgroup** | **perf** }
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 Kicinski6ebe6db2018-01-02 14:48:36 -0800[diff] [blame]25 { **show** | **list** | **dump** | **update** | **lookup** | **getnext** | **delete**
Jakub Kicinskif412eed2018-05-03 18:37:16 -0700[diff] [blame]26 | **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**
Roman Gushchin49a086c2017-12-13 15:18:53 +0000[diff] [blame]29 | **load** | **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
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]35DESCRIPTION
36===========
37 *bpftool* allows for inspection and simple modification of BPF objects
38 on the system.
39
40 Note that format of the output of all tools is not guaranteed to be
41 stable and should not be depended upon.
42
Quentin Monneta2bc2e52017-10-23 09:24:06 -0700[diff] [blame]43OPTIONS
44=======
45 -h, --help
46 Print short help message (similar to **bpftool help**).
47
48 -v, --version
49 Print version number (similar to **bpftool version**).
50
Quentin Monnet0641c3c2017-10-23 09:24:16 -0700[diff] [blame]51 -j, --json
52 Generate JSON output. For commands that cannot produce JSON, this
53 option has no effect.
54
55 -p, --pretty
56 Generate human-readable JSON output. Implies **-j**.
57
Jakub Kicinskiff69c212017-10-04 20:10:05 -0700[diff] [blame]58SEE ALSO
59========
Roman Gushchin5ccda642017-12-13 15:18:54 +0000[diff] [blame]60 **bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8)
Yonghong Songb04df402018-05-24 11:21:58 -0700[diff] [blame^]61 **bpftool-perf**\ (8)