1595c3649SMasami Hiramatsuperf-probe(1) 2595c3649SMasami Hiramatsu============= 3595c3649SMasami Hiramatsu 4595c3649SMasami HiramatsuNAME 5595c3649SMasami Hiramatsu---- 6595c3649SMasami Hiramatsuperf-probe - Define new dynamic tracepoints 7595c3649SMasami Hiramatsu 8595c3649SMasami HiramatsuSYNOPSIS 9595c3649SMasami Hiramatsu-------- 10595c3649SMasami Hiramatsu[verse] 11c937fe20SMasami Hiramatsu'perf probe' [options] --add='PROBE' [...] 12c43f9d1eSMasami Hiramatsuor 13c937fe20SMasami Hiramatsu'perf probe' [options] PROBE 14c937fe20SMasami Hiramatsuor 15c937fe20SMasami Hiramatsu'perf probe' [options] --del='[GROUP:]EVENT' [...] 16c937fe20SMasami Hiramatsuor 17c937fe20SMasami Hiramatsu'perf probe' --list 18631c9defSMasami Hiramatsuor 19631c9defSMasami Hiramatsu'perf probe' --line='FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]' 20*cf6eb489SMasami Hiramatsuor 21*cf6eb489SMasami Hiramatsu'perf probe' --vars='PROBEPOINT' 22595c3649SMasami Hiramatsu 23595c3649SMasami HiramatsuDESCRIPTION 24595c3649SMasami Hiramatsu----------- 25595c3649SMasami HiramatsuThis command defines dynamic tracepoint events, by symbol and registers 26595c3649SMasami Hiramatsuwithout debuginfo, or by C expressions (C line numbers, C function names, 27595c3649SMasami Hiramatsuand C local variables) with debuginfo. 28595c3649SMasami Hiramatsu 29595c3649SMasami Hiramatsu 30595c3649SMasami HiramatsuOPTIONS 31595c3649SMasami Hiramatsu------- 32595c3649SMasami Hiramatsu-k:: 33c43f9d1eSMasami Hiramatsu--vmlinux=PATH:: 34595c3649SMasami Hiramatsu Specify vmlinux path which has debuginfo (Dwarf binary). 35595c3649SMasami Hiramatsu 369ed7e1b8SChase Douglas-s:: 379ed7e1b8SChase Douglas--source=PATH:: 389ed7e1b8SChase Douglas Specify path to kernel source. 399ed7e1b8SChase Douglas 40595c3649SMasami Hiramatsu-v:: 41595c3649SMasami Hiramatsu--verbose:: 42595c3649SMasami Hiramatsu Be more verbose (show parsed arguments, etc). 43595c3649SMasami Hiramatsu 44c43f9d1eSMasami Hiramatsu-a:: 45c937fe20SMasami Hiramatsu--add=:: 46c937fe20SMasami Hiramatsu Define a probe event (see PROBE SYNTAX for detail). 47c937fe20SMasami Hiramatsu 48c937fe20SMasami Hiramatsu-d:: 49c937fe20SMasami Hiramatsu--del=:: 50ee391de8SMasami Hiramatsu Delete probe events. This accepts glob wildcards('*', '?') and character 51ee391de8SMasami Hiramatsu classes(e.g. [a-z], [!A-Z]). 52c937fe20SMasami Hiramatsu 53c937fe20SMasami Hiramatsu-l:: 54c937fe20SMasami Hiramatsu--list:: 55c937fe20SMasami Hiramatsu List up current probe events. 56595c3649SMasami Hiramatsu 57631c9defSMasami Hiramatsu-L:: 58631c9defSMasami Hiramatsu--line=:: 59631c9defSMasami Hiramatsu Show source code lines which can be probed. This needs an argument 60ee391de8SMasami Hiramatsu which specifies a range of the source code. (see LINE SYNTAX for detail) 61ee391de8SMasami Hiramatsu 62*cf6eb489SMasami Hiramatsu-V:: 63*cf6eb489SMasami Hiramatsu--vars=:: 64*cf6eb489SMasami Hiramatsu Show available local variables at given probe point. The argument 65*cf6eb489SMasami Hiramatsu syntax is same as PROBE SYNTAX, but NO ARGs. 66*cf6eb489SMasami Hiramatsu 67ee391de8SMasami Hiramatsu-f:: 68ee391de8SMasami Hiramatsu--force:: 69ee391de8SMasami Hiramatsu Forcibly add events with existing name. 70631c9defSMasami Hiramatsu 71f4d7da49SMasami Hiramatsu-n:: 72f4d7da49SMasami Hiramatsu--dry-run:: 73f4d7da49SMasami Hiramatsu Dry run. With this option, --add and --del doesn't execute actual 74f4d7da49SMasami Hiramatsu adding and removal operations. 75f4d7da49SMasami Hiramatsu 76ef4a3565SMasami Hiramatsu--max-probes:: 77ef4a3565SMasami Hiramatsu Set the maximum number of probe points for an event. Default is 128. 78ef4a3565SMasami Hiramatsu 79595c3649SMasami HiramatsuPROBE SYNTAX 80595c3649SMasami Hiramatsu------------ 81595c3649SMasami HiramatsuProbe points are defined by following syntax. 82595c3649SMasami Hiramatsu 832a9c8c36SMasami Hiramatsu 1) Define event based on function name 842a9c8c36SMasami Hiramatsu [EVENT=]FUNC[@SRC][:RLN|+OFFS|%return|;PTN] [ARG ...] 852a9c8c36SMasami Hiramatsu 862a9c8c36SMasami Hiramatsu 2) Define event based on source file with line number 872a9c8c36SMasami Hiramatsu [EVENT=]SRC:ALN [ARG ...] 882a9c8c36SMasami Hiramatsu 892a9c8c36SMasami Hiramatsu 3) Define event based on source file with lazy pattern 902a9c8c36SMasami Hiramatsu [EVENT=]SRC;PTN [ARG ...] 912a9c8c36SMasami Hiramatsu 92595c3649SMasami Hiramatsu 93af663d75SMasami Hiramatsu'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'. 942a9c8c36SMasami Hiramatsu'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. 952a9c8c36SMasami HiramatsuIt 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. 9648481938SMasami Hiramatsu'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). 9748481938SMasami Hiramatsu 9848481938SMasami HiramatsuPROBE ARGUMENT 9948481938SMasami Hiramatsu-------------- 10048481938SMasami HiramatsuEach probe argument follows below syntax. 10148481938SMasami Hiramatsu 10211a1ca35SMasami Hiramatsu [NAME=]LOCALVAR|$retval|%REG|@SYMBOL[:TYPE] 10348481938SMasami Hiramatsu 104b2a3c12bSMasami Hiramatsu'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), local array with fixed index (e.g. array[1], var->array[0], var->pointer[2]), 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'.) 10573317b95SMasami Hiramatsu'TYPE' casts the type of this argument (optional). If omitted, perf probe automatically set the type based on debuginfo. You can specify 'string' type only for the local variable or structure member which is an array of or a pointer to 'char' or 'unsigned char' type. 106595c3649SMasami Hiramatsu 107631c9defSMasami HiramatsuLINE SYNTAX 108631c9defSMasami Hiramatsu----------- 109631c9defSMasami HiramatsuLine range is descripted by following syntax. 110631c9defSMasami Hiramatsu 111085ea739SMasami Hiramatsu "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]" 112631c9defSMasami Hiramatsu 113631c9defSMasami HiramatsuFUNC specifies the function name of showing lines. 'RLN' is the start line 114631c9defSMasami Hiramatsunumber from function entry line, and 'RLN2' is the end line number. As same as 115631c9defSMasami Hiramatsuprobe syntax, 'SRC' means the source file path, 'ALN' is start line number, 116631c9defSMasami Hiramatsuand 'ALN2' is end line number in the file. It is also possible to specify how 117631c9defSMasami Hiramatsumany lines to show by using 'NUM'. 118631c9defSMasami HiramatsuSo, "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. 119631c9defSMasami Hiramatsu 1202a9c8c36SMasami HiramatsuLAZY MATCHING 1212a9c8c36SMasami Hiramatsu------------- 1222a9c8c36SMasami Hiramatsu 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]). 1232a9c8c36SMasami Hiramatsu 1242a9c8c36SMasami Hiramatsue.g. 1252a9c8c36SMasami Hiramatsu 'a=*' can matches 'a=b', 'a = b', 'a == b' and so on. 1262a9c8c36SMasami Hiramatsu 1272a9c8c36SMasami HiramatsuThis 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.) 1282a9c8c36SMasami Hiramatsu 1292a9c8c36SMasami Hiramatsu 130ee391de8SMasami HiramatsuEXAMPLES 131ee391de8SMasami Hiramatsu-------- 132ee391de8SMasami HiramatsuDisplay which lines in schedule() can be probed: 133ee391de8SMasami Hiramatsu 134ee391de8SMasami Hiramatsu ./perf probe --line schedule 135ee391de8SMasami Hiramatsu 136ee391de8SMasami HiramatsuAdd a probe on schedule() function 12th line with recording cpu local variable: 137ee391de8SMasami Hiramatsu 138ee391de8SMasami Hiramatsu ./perf probe schedule:12 cpu 139ee391de8SMasami Hiramatsu or 140ee391de8SMasami Hiramatsu ./perf probe --add='schedule:12 cpu' 141ee391de8SMasami Hiramatsu 142ee391de8SMasami Hiramatsu this will add one or more probes which has the name start with "schedule". 143ee391de8SMasami Hiramatsu 1442a9c8c36SMasami Hiramatsu Add probes on lines in schedule() function which calls update_rq_clock(). 1452a9c8c36SMasami Hiramatsu 1462a9c8c36SMasami Hiramatsu ./perf probe 'schedule;update_rq_clock*' 1472a9c8c36SMasami Hiramatsu or 1482a9c8c36SMasami Hiramatsu ./perf probe --add='schedule;update_rq_clock*' 1492a9c8c36SMasami Hiramatsu 150ee391de8SMasami HiramatsuDelete all probes on schedule(). 151ee391de8SMasami Hiramatsu 152ee391de8SMasami Hiramatsu ./perf probe --del='schedule*' 153ee391de8SMasami Hiramatsu 154ee391de8SMasami Hiramatsu 155595c3649SMasami HiramatsuSEE ALSO 156595c3649SMasami Hiramatsu-------- 157595c3649SMasami Hiramatsulinkperf:perf-trace[1], linkperf:perf-record[1] 158