xref: /linux/tools/bpf/bpftool/Documentation/bpftool-perf.rst (revision 2697b79a469b68e3ad3640f55284359c1396278d) 
1.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
3================
4bpftool-perf
5================
6-------------------------------------------------------------------------------
7tool for inspection of perf related bpf prog attachments
8-------------------------------------------------------------------------------
9
10:Manual section: 8
11
12.. include:: substitutions.rst
13
14SYNOPSIS
15========
16
17**bpftool** [*OPTIONS*] **perf** *COMMAND*
18
19*OPTIONS* := { |COMMON_OPTIONS| }
20
21*COMMANDS* :=
22{ **show** | **list** | **help** }
23
24PERF COMMANDS
25=============
26
27| **bpftool** **perf** { **show** | **list** }
28| **bpftool** **perf help**
29
30DESCRIPTION
31===========
32bpftool perf { show | list }
33    List all raw_tracepoint, tracepoint, kprobe attachment in the system.
34
35    Output will start with process id and file descriptor in that process,
36    followed by bpf program id, attachment information, and attachment point.
37    The attachment point for raw_tracepoint/tracepoint is the trace probe name.
38    The attachment point for k[ret]probe is either symbol name and offset, or a
39    kernel virtual address. The attachment point for u[ret]probe is the file
40    name and the file offset.
41
42bpftool perf help
43    Print short help message.
44
45OPTIONS
46=======
47.. include:: common_options.rst
48
49EXAMPLES
50========
51
52| **# bpftool perf**
53
54::
55
56      pid 21711  fd 5: prog_id 5  kprobe  func __x64_sys_write  offset 0
57      pid 21765  fd 5: prog_id 7  kretprobe  func __x64_sys_nanosleep  offset 0
58      pid 21767  fd 5: prog_id 8  tracepoint  sys_enter_nanosleep
59      pid 21800  fd 5: prog_id 9  uprobe  filename /home/yhs/a.out  offset 1159
60
61|
62| **# bpftool -j perf**
63
64::
65
66    [{"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":"kretprobe","func":"__x64_sys_nanosleep","offset":0}, \
68     {"pid":21767,"fd":5,"prog_id":8,"fd_type":"tracepoint","tracepoint":"sys_enter_nanosleep"}, \
69     {"pid":21800,"fd":5,"prog_id":9,"fd_type":"uprobe","filename":"/home/yhs/a.out","offset":1159}]
70