forked from Minki/linux
c8caa0bb4b
Bring minor improvements to bpftool documentation. Fix or harmonise
formatting, update map types (including in interactive help), improve
description for "map create", fix a build warning due to a missing line
after the double-colon for the "bpftool prog profile" example,
complete/harmonise/sort the list of related bpftool man pages in
footers.
v2:
- Remove (instead of changing) mark-up on "value" in bpftool-map.rst,
when it does not refer to something passed on the command line.
- Fix an additional typo ("hexadeximal") in the same file.
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200511161536.29853-3-quentin@isovalent.com
98 lines
2.7 KiB
ReStructuredText
98 lines
2.7 KiB
ReStructuredText
================
|
|
bpftool-perf
|
|
================
|
|
-------------------------------------------------------------------------------
|
|
tool for inspection of perf related bpf prog attachments
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **perf** *COMMAND*
|
|
|
|
*OPTIONS* := { [{ **-j** | **--json** }] [{ **-p** | **--pretty** }] }
|
|
|
|
*COMMANDS* :=
|
|
{ **show** | **list** | **help** }
|
|
|
|
PERF COMMANDS
|
|
=============
|
|
|
|
| **bpftool** **perf** { **show** | **list** }
|
|
| **bpftool** **perf help**
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool perf { show | list }**
|
|
List all raw_tracepoint, tracepoint, kprobe attachment in the system.
|
|
|
|
Output will start with process id and file descriptor in that process,
|
|
followed by bpf program id, attachment information, and attachment point.
|
|
The attachment point for raw_tracepoint/tracepoint is the trace probe name.
|
|
The attachment point for k[ret]probe is either symbol name and offset,
|
|
or a kernel virtual address.
|
|
The attachment point for u[ret]probe is the file name and the file offset.
|
|
|
|
**bpftool perf help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
-h, --help
|
|
Print short generic help message (similar to **bpftool help**).
|
|
|
|
-V, --version
|
|
Print version number (similar to **bpftool version**).
|
|
|
|
-j, --json
|
|
Generate JSON output. For commands that cannot produce JSON, this
|
|
option has no effect.
|
|
|
|
-p, --pretty
|
|
Generate human-readable JSON output. Implies **-j**.
|
|
|
|
-d, --debug
|
|
Print all logs available from libbpf, including debug-level
|
|
information.
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
| **# bpftool perf**
|
|
|
|
::
|
|
|
|
pid 21711 fd 5: prog_id 5 kprobe func __x64_sys_write offset 0
|
|
pid 21765 fd 5: prog_id 7 kretprobe func __x64_sys_nanosleep offset 0
|
|
pid 21767 fd 5: prog_id 8 tracepoint sys_enter_nanosleep
|
|
pid 21800 fd 5: prog_id 9 uprobe filename /home/yhs/a.out offset 1159
|
|
|
|
|
|
|
| **# bpftool -j perf**
|
|
|
|
::
|
|
|
|
[{"pid":21711,"fd":5,"prog_id":5,"fd_type":"kprobe","func":"__x64_sys_write","offset":0}, \
|
|
{"pid":21765,"fd":5,"prog_id":7,"fd_type":"kretprobe","func":"__x64_sys_nanosleep","offset":0}, \
|
|
{"pid":21767,"fd":5,"prog_id":8,"fd_type":"tracepoint","tracepoint":"sys_enter_nanosleep"}, \
|
|
{"pid":21800,"fd":5,"prog_id":9,"fd_type":"uprobe","filename":"/home/yhs/a.out","offset":1159}]
|
|
|
|
|
|
SEE ALSO
|
|
========
|
|
**bpf**\ (2),
|
|
**bpf-helpers**\ (7),
|
|
**bpftool**\ (8),
|
|
**bpftool-btf**\ (8),
|
|
**bpftool-cgroup**\ (8),
|
|
**bpftool-feature**\ (8),
|
|
**bpftool-gen**\ (8),
|
|
**bpftool-iter**\ (8),
|
|
**bpftool-link**\ (8),
|
|
**bpftool-map**\ (8),
|
|
**bpftool-net**\ (8),
|
|
**bpftool-prog**\ (8),
|
|
**bpftool-struct_ops**\ (8)
|