projects / linux-block.git / blame
| Commit | Line | Data |
|---|---|---|
| ff69c21a JK |
1 | ================ |
| 2 | BPFTOOL | |
| 3 | ================ | |
| 4 | ------------------------------------------------------------------------------- | |
| 5 | tool for inspection and simple manipulation of eBPF programs and maps | |
| 6 | ------------------------------------------------------------------------------- | |
| 7 | ||
| 8 | :Manual section: 8 | |
| 9 | ||
| 10 | SYNOPSIS | |
| 11 | ======== | |
| 12 | ||
| 0641c3c8 | 13 | **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** } |
| ff69c21a | 14 | |
| 47ff7ac6 | 15 | **bpftool** **batch file** *FILE* |
| ff69c21a | 16 | |
| 47ff7ac6 | 17 | **bpftool** **version** |
| 821cfbb0 | 18 | |
| b04df400 | 19 | *OBJECT* := { **map** | **program** | **cgroup** | **perf** } |
| ff69c21a | 20 | |
| 0641c3c8 QM |
21 | *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** } |
| 22 | | { **-j** | **--json** } [{ **-p** | **--pretty** }] } | |
| 23 | ||
| ff69c21a | 24 | *MAP-COMMANDS* := |
| 6ebe6dbd | 25 | { **show** | **list** | **dump** | **update** | **lookup** | **getnext** | **delete** |
| f412eed9 | 26 | | **pin** | **event_pipe** | **help** } |
| ff69c21a | 27 | |
| 6ebe6dbd | 28 | *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
| 49a086c2 | 29 | | **load** | **help** } |
| ff69c21a | 30 | |
| 6ebe6dbd | 31 | *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** } |
| 5ccda64d | 32 | |
| b04df400 YS |
33 | *PERF-COMMANDS* := { **show** | **list** | **help** } |
| 34 | ||
| ff69c21a JK |
35 | DESCRIPTION |
| 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 | ||
| a2bc2e5c QM |
43 | OPTIONS |
| 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 | ||
| 0641c3c8 QM |
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 | ||
| ff69c21a JK |
58 | SEE ALSO |
| 59 | ======== | |
| 5ccda64d | 60 | **bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8) |
| b04df400 | 61 | **bpftool-perf**\ (8) |