Commit | Line | Data |
---|---|---|
595c3649 MH |
1 | perf-probe(1) |
2 | ============= | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | perf-probe - Define new dynamic tracepoints | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
c937fe20 | 11 | 'perf probe' [options] --add='PROBE' [...] |
c43f9d1e | 12 | or |
c937fe20 MH |
13 | 'perf probe' [options] PROBE |
14 | or | |
15 | 'perf probe' [options] --del='[GROUP:]EVENT' [...] | |
16 | or | |
17 | 'perf probe' --list | |
631c9def MH |
18 | or |
19 | 'perf probe' --line='FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]' | |
595c3649 MH |
20 | |
21 | DESCRIPTION | |
22 | ----------- | |
23 | This command defines dynamic tracepoint events, by symbol and registers | |
24 | without debuginfo, or by C expressions (C line numbers, C function names, | |
25 | and C local variables) with debuginfo. | |
26 | ||
27 | ||
28 | OPTIONS | |
29 | ------- | |
30 | -k:: | |
c43f9d1e | 31 | --vmlinux=PATH:: |
595c3649 MH |
32 | Specify vmlinux path which has debuginfo (Dwarf binary). |
33 | ||
34 | -v:: | |
35 | --verbose:: | |
36 | Be more verbose (show parsed arguments, etc). | |
37 | ||
c43f9d1e | 38 | -a:: |
c937fe20 MH |
39 | --add=:: |
40 | Define a probe event (see PROBE SYNTAX for detail). | |
41 | ||
42 | -d:: | |
43 | --del=:: | |
ee391de8 MH |
44 | Delete probe events. This accepts glob wildcards('*', '?') and character |
45 | classes(e.g. [a-z], [!A-Z]). | |
c937fe20 MH |
46 | |
47 | -l:: | |
48 | --list:: | |
49 | List up current probe events. | |
595c3649 | 50 | |
631c9def MH |
51 | -L:: |
52 | --line=:: | |
53 | Show source code lines which can be probed. This needs an argument | |
ee391de8 MH |
54 | which specifies a range of the source code. (see LINE SYNTAX for detail) |
55 | ||
56 | -f:: | |
57 | --force:: | |
58 | Forcibly add events with existing name. | |
631c9def | 59 | |
f4d7da49 MH |
60 | -n:: |
61 | --dry-run:: | |
62 | Dry run. With this option, --add and --del doesn't execute actual | |
63 | adding and removal operations. | |
64 | ||
595c3649 MH |
65 | PROBE SYNTAX |
66 | ------------ | |
67 | Probe points are defined by following syntax. | |
68 | ||
2a9c8c36 MH |
69 | 1) Define event based on function name |
70 | [EVENT=]FUNC[@SRC][:RLN|+OFFS|%return|;PTN] [ARG ...] | |
71 | ||
72 | 2) Define event based on source file with line number | |
73 | [EVENT=]SRC:ALN [ARG ...] | |
74 | ||
75 | 3) Define event based on source file with lazy pattern | |
76 | [EVENT=]SRC;PTN [ARG ...] | |
77 | ||
595c3649 | 78 | |
af663d75 | 79 | 'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function. Currently, event group name is set as 'probe'. |
2a9c8c36 MH |
80 | 'FUNC' specifies a probed function name, and it may have one of the following options; '+OFFS' is the offset from function entry address in bytes, ':RLN' is the relative-line number from function entry line, and '%return' means that it probes function return. And ';PTN' means lazy matching pattern (see LAZY MATCHING). Note that ';PTN' must be the end of the probe point definition. In addition, '@SRC' specifies a source file which has that function. |
81 | It is also possible to specify a probe point by the source line number or lazy matching by using 'SRC:ALN' or 'SRC;PTN' syntax, where 'SRC' is the source file path, ':ALN' is the line number and ';PTN' is the lazy matching pattern. | |
48481938 MH |
82 | 'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). |
83 | ||
84 | PROBE ARGUMENT | |
85 | -------------- | |
86 | Each probe argument follows below syntax. | |
87 | ||
88 | [NAME=]LOCALVAR|$retval|%REG|@SYMBOL | |
89 | ||
df0faf4b | 90 | 'NAME' specifies the name of this argument (optional). You can use the name of local variable, local data structure member (e.g. var->field, var.field2), or kprobe-tracer argument format (e.g. $retval, %ax, etc). Note that the name of this argument will be set as the last member name if you specify a local data structure member (e.g. field2 for 'var->field1.field2'.) |
595c3649 | 91 | |
631c9def MH |
92 | LINE SYNTAX |
93 | ----------- | |
94 | Line range is descripted by following syntax. | |
95 | ||
085ea739 | 96 | "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]" |
631c9def MH |
97 | |
98 | FUNC specifies the function name of showing lines. 'RLN' is the start line | |
99 | number from function entry line, and 'RLN2' is the end line number. As same as | |
100 | probe syntax, 'SRC' means the source file path, 'ALN' is start line number, | |
101 | and 'ALN2' is end line number in the file. It is also possible to specify how | |
102 | many lines to show by using 'NUM'. | |
103 | So, "source.c:100-120" shows lines between 100th to l20th in source.c file. And "func:10+20" shows 20 lines from 10th line of func function. | |
104 | ||
2a9c8c36 MH |
105 | LAZY MATCHING |
106 | ------------- | |
107 | The lazy line matching is similar to glob matching but ignoring spaces in both of pattern and target. So this accepts wildcards('*', '?') and character classes(e.g. [a-z], [!A-Z]). | |
108 | ||
109 | e.g. | |
110 | 'a=*' can matches 'a=b', 'a = b', 'a == b' and so on. | |
111 | ||
112 | This provides some sort of flexibility and robustness to probe point definitions against minor code changes. For example, actual 10th line of schedule() can be moved easily by modifying schedule(), but the same line matching 'rq=cpu_rq*' may still exist in the function.) | |
113 | ||
114 | ||
ee391de8 MH |
115 | EXAMPLES |
116 | -------- | |
117 | Display which lines in schedule() can be probed: | |
118 | ||
119 | ./perf probe --line schedule | |
120 | ||
121 | Add a probe on schedule() function 12th line with recording cpu local variable: | |
122 | ||
123 | ./perf probe schedule:12 cpu | |
124 | or | |
125 | ./perf probe --add='schedule:12 cpu' | |
126 | ||
127 | this will add one or more probes which has the name start with "schedule". | |
128 | ||
2a9c8c36 MH |
129 | Add probes on lines in schedule() function which calls update_rq_clock(). |
130 | ||
131 | ./perf probe 'schedule;update_rq_clock*' | |
132 | or | |
133 | ./perf probe --add='schedule;update_rq_clock*' | |
134 | ||
ee391de8 MH |
135 | Delete all probes on schedule(). |
136 | ||
137 | ./perf probe --del='schedule*' | |
138 | ||
139 | ||
595c3649 MH |
140 | SEE ALSO |
141 | -------- | |
142 | linkperf:perf-trace[1], linkperf:perf-record[1] |