1 .. SPDX-License-Identifier: (GPL-2.0-only OR B <<
2 <<
3 ================ 1 ================
4 bpftool-perf 2 bpftool-perf
5 ================ 3 ================
6 ---------------------------------------------- 4 -------------------------------------------------------------------------------
7 tool for inspection of perf related bpf prog a 5 tool for inspection of perf related bpf prog attachments
8 ---------------------------------------------- 6 -------------------------------------------------------------------------------
9 7
10 :Manual section: 8 8 :Manual section: 8
11 9
12 .. include:: substitutions.rst <<
13 <<
14 SYNOPSIS 10 SYNOPSIS
15 ======== 11 ========
16 12
17 **bpftool** [*OPTIONS*] **perf** *COMMAND* !! 13 **bpftool** [*OPTIONS*] **perf** *COMMAND*
18 14
19 *OPTIONS* := { |COMMON_OPTIONS| } !! 15 *OPTIONS* := { [{ **-j** | **--json** }] [{ **-p** | **--pretty** }] }
20 16
21 *COMMANDS* := !! 17 *COMMANDS* :=
22 { **show** | **list** | **help** } !! 18 { **show** | **list** | **help** }
23 19
24 PERF COMMANDS 20 PERF COMMANDS
25 ============= 21 =============
26 22
27 | **bpftool** **perf** { **show** | **list** } !! 23 | **bpftool** **perf { show | list }**
28 | **bpftool** **perf help** !! 24 | **bpftool** **perf help**
29 25
30 DESCRIPTION 26 DESCRIPTION
31 =========== 27 ===========
32 bpftool perf { show | list } !! 28 **bpftool perf { show | list }**
33 List all raw_tracepoint, tracepoint, kprob !! 29 List all raw_tracepoint, tracepoint, kprobe attachment in the system.
34 30
35 Output will start with process id and file !! 31 Output will start with process id and file descriptor in that process,
36 followed by bpf program id, attachment inf !! 32 followed by bpf program id, attachment information, and attachment point.
37 The attachment point for raw_tracepoint/tr !! 33 The attachment point for raw_tracepoint/tracepoint is the trace probe name.
38 The attachment point for k[ret]probe is ei !! 34 The attachment point for k[ret]probe is either symbol name and offset,
39 kernel virtual address. The attachment poi !! 35 or a kernel virtual address.
40 name and the file offset. !! 36 The attachment point for u[ret]probe is the file name and the file offset.
41 37
42 bpftool perf help !! 38 **bpftool perf help**
43 Print short help message. !! 39 Print short help message.
44 40
45 OPTIONS 41 OPTIONS
46 ======= 42 =======
47 .. include:: common_options.rst !! 43 -h, --help
>> 44 Print short generic help message (similar to **bpftool help**).
>> 45
>> 46 -V, --version
>> 47 Print version number (similar to **bpftool version**).
>> 48
>> 49 -j, --json
>> 50 Generate JSON output. For commands that cannot produce JSON, this
>> 51 option has no effect.
>> 52
>> 53 -p, --pretty
>> 54 Generate human-readable JSON output. Implies **-j**.
>> 55
>> 56 -d, --debug
>> 57 Print all logs available from libbpf, including debug-level
>> 58 information.
48 59
49 EXAMPLES 60 EXAMPLES
50 ======== 61 ========
51 62
52 | **# bpftool perf** 63 | **# bpftool perf**
53 64
54 :: 65 ::
55 66
56 pid 21711 fd 5: prog_id 5 kprobe func 67 pid 21711 fd 5: prog_id 5 kprobe func __x64_sys_write offset 0
57 pid 21765 fd 5: prog_id 7 kretprobe f 68 pid 21765 fd 5: prog_id 7 kretprobe func __x64_sys_nanosleep offset 0
58 pid 21767 fd 5: prog_id 8 tracepoint 69 pid 21767 fd 5: prog_id 8 tracepoint sys_enter_nanosleep
59 pid 21800 fd 5: prog_id 9 uprobe file 70 pid 21800 fd 5: prog_id 9 uprobe filename /home/yhs/a.out offset 1159
60 71
61 | 72 |
62 | **# bpftool -j perf** 73 | **# bpftool -j perf**
63 74
64 :: 75 ::
65 76
66 [{"pid":21711,"fd":5,"prog_id":5,"fd_type" 77 [{"pid":21711,"fd":5,"prog_id":5,"fd_type":"kprobe","func":"__x64_sys_write","offset":0}, \
67 {"pid":21765,"fd":5,"prog_id":7,"fd_type" 78 {"pid":21765,"fd":5,"prog_id":7,"fd_type":"kretprobe","func":"__x64_sys_nanosleep","offset":0}, \
68 {"pid":21767,"fd":5,"prog_id":8,"fd_type" 79 {"pid":21767,"fd":5,"prog_id":8,"fd_type":"tracepoint","tracepoint":"sys_enter_nanosleep"}, \
69 {"pid":21800,"fd":5,"prog_id":9,"fd_type" 80 {"pid":21800,"fd":5,"prog_id":9,"fd_type":"uprobe","filename":"/home/yhs/a.out","offset":1159}]
>> 81
>> 82
>> 83 SEE ALSO
>> 84 ========
>> 85 **bpf**\ (2),
>> 86 **bpf-helpers**\ (7),
>> 87 **bpftool**\ (8),
>> 88 **bpftool-prog**\ (8),
>> 89 **bpftool-map**\ (8),
>> 90 **bpftool-cgroup**\ (8),
>> 91 **bpftool-feature**\ (8),
>> 92 **bpftool-net**\ (8),
>> 93 **bpftool-btf**\ (8)
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.