| perf-probe.txt (ee391de876ae4272926b8632be04ed4a460321e3) | perf-probe.txt (2a9c8c36092de41c13fdd81fe59556915b080c3e) |
|---|---|
| 1perf-probe(1) 2============= 3 4NAME 5---- 6perf-probe - Define new dynamic tracepoints 7 8SYNOPSIS --- 47 unchanged lines hidden (view full) --- 56-f:: 57--force:: 58 Forcibly add events with existing name. 59 60PROBE SYNTAX 61------------ 62Probe points are defined by following syntax. 63 | 1perf-probe(1) 2============= 3 4NAME 5---- 6perf-probe - Define new dynamic tracepoints 7 8SYNOPSIS --- 47 unchanged lines hidden (view full) --- 56-f:: 57--force:: 58 Forcibly add events with existing name. 59 60PROBE SYNTAX 61------------ 62Probe points are defined by following syntax. 63 |
| 64 "[EVENT=]FUNC[+OFFS|:RLN|%return][@SRC]|SRC:ALN [ARG ...]" | 64 1) Define event based on function name 65 [EVENT=]FUNC[@SRC][:RLN|+OFFS|%return|;PTN] [ARG ...] |
| 65 | 66 |
| 67 2) Define event based on source file with line number 68 [EVENT=]SRC:ALN [ARG ...] 69 70 3) Define event based on source file with lazy pattern 71 [EVENT=]SRC;PTN [ARG ...] 72 73 |
|
| 66'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'. | 74'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'. |
| 67'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. In addition, 'SRC' specifies a source file which has that function. 68It is also possible to specify a probe point by the source line number by using 'SRC:ALN' syntax, where 'SRC' is the source file path and 'ALN' is the line number. | 75'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. 76It 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. |
| 69'ARG' specifies the arguments of this probe point. You can use the name of local variable, or kprobe-tracer argument format (e.g. $retval, %ax, etc). 70 71LINE SYNTAX 72----------- 73Line range is descripted by following syntax. 74 75 "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]" 76 77FUNC specifies the function name of showing lines. 'RLN' is the start line 78number from function entry line, and 'RLN2' is the end line number. As same as 79probe syntax, 'SRC' means the source file path, 'ALN' is start line number, 80and 'ALN2' is end line number in the file. It is also possible to specify how 81many lines to show by using 'NUM'. 82So, "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. 83 | 77'ARG' specifies the arguments of this probe point. You can use the name of local variable, or kprobe-tracer argument format (e.g. $retval, %ax, etc). 78 79LINE SYNTAX 80----------- 81Line range is descripted by following syntax. 82 83 "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]" 84 85FUNC specifies the function name of showing lines. 'RLN' is the start line 86number from function entry line, and 'RLN2' is the end line number. As same as 87probe syntax, 'SRC' means the source file path, 'ALN' is start line number, 88and 'ALN2' is end line number in the file. It is also possible to specify how 89many lines to show by using 'NUM'. 90So, "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. 91 |
| 92LAZY MATCHING 93------------- 94 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]). 95 96e.g. 97 'a=*' can matches 'a=b', 'a = b', 'a == b' and so on. 98 99This 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.) 100 101 |
|
| 84EXAMPLES 85-------- 86Display which lines in schedule() can be probed: 87 88 ./perf probe --line schedule 89 90Add a probe on schedule() function 12th line with recording cpu local variable: 91 92 ./perf probe schedule:12 cpu 93 or 94 ./perf probe --add='schedule:12 cpu' 95 96 this will add one or more probes which has the name start with "schedule". 97 | 102EXAMPLES 103-------- 104Display which lines in schedule() can be probed: 105 106 ./perf probe --line schedule 107 108Add a probe on schedule() function 12th line with recording cpu local variable: 109 110 ./perf probe schedule:12 cpu 111 or 112 ./perf probe --add='schedule:12 cpu' 113 114 this will add one or more probes which has the name start with "schedule". 115 |
| 116 Add probes on lines in schedule() function which calls update_rq_clock(). 117 118 ./perf probe 'schedule;update_rq_clock*' 119 or 120 ./perf probe --add='schedule;update_rq_clock*' 121 |
|
| 98Delete all probes on schedule(). 99 100 ./perf probe --del='schedule*' 101 102 103SEE ALSO 104-------- 105linkperf:perf-trace[1], linkperf:perf-record[1] | 122Delete all probes on schedule(). 123 124 ./perf probe --del='schedule*' 125 126 127SEE ALSO 128-------- 129linkperf:perf-trace[1], linkperf:perf-record[1] |