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 19469b9b88SMasami Hiramatsu'perf probe' [options] --line='FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]' 20cf6eb489SMasami Hiramatsuor 21469b9b88SMasami Hiramatsu'perf probe' [options] --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 36469b9b88SMasami Hiramatsu-m:: 37469b9b88SMasami Hiramatsu--module=MODNAME:: 38469b9b88SMasami Hiramatsu Specify module name in which perf-probe searches probe points 39469b9b88SMasami Hiramatsu or lines. 40469b9b88SMasami Hiramatsu 419ed7e1b8SChase Douglas-s:: 429ed7e1b8SChase Douglas--source=PATH:: 439ed7e1b8SChase Douglas Specify path to kernel source. 449ed7e1b8SChase Douglas 45595c3649SMasami Hiramatsu-v:: 46595c3649SMasami Hiramatsu--verbose:: 47595c3649SMasami Hiramatsu Be more verbose (show parsed arguments, etc). 48595c3649SMasami Hiramatsu 49c43f9d1eSMasami Hiramatsu-a:: 50c937fe20SMasami Hiramatsu--add=:: 51c937fe20SMasami Hiramatsu Define a probe event (see PROBE SYNTAX for detail). 52c937fe20SMasami Hiramatsu 53c937fe20SMasami Hiramatsu-d:: 54c937fe20SMasami Hiramatsu--del=:: 55ee391de8SMasami Hiramatsu Delete probe events. This accepts glob wildcards('*', '?') and character 56ee391de8SMasami Hiramatsu classes(e.g. [a-z], [!A-Z]). 57c937fe20SMasami Hiramatsu 58c937fe20SMasami Hiramatsu-l:: 59c937fe20SMasami Hiramatsu--list:: 60c937fe20SMasami Hiramatsu List up current probe events. 61595c3649SMasami Hiramatsu 62631c9defSMasami Hiramatsu-L:: 63631c9defSMasami Hiramatsu--line=:: 64631c9defSMasami Hiramatsu Show source code lines which can be probed. This needs an argument 65ee391de8SMasami Hiramatsu which specifies a range of the source code. (see LINE SYNTAX for detail) 66ee391de8SMasami Hiramatsu 67cf6eb489SMasami Hiramatsu-V:: 68cf6eb489SMasami Hiramatsu--vars=:: 69cf6eb489SMasami Hiramatsu Show available local variables at given probe point. The argument 70cf6eb489SMasami Hiramatsu syntax is same as PROBE SYNTAX, but NO ARGs. 71cf6eb489SMasami Hiramatsu 72fb8c5a56SMasami Hiramatsu--externs:: 73fb8c5a56SMasami Hiramatsu (Only for --vars) Show external defined variables in addition to local 74fb8c5a56SMasami Hiramatsu variables. 75fb8c5a56SMasami Hiramatsu 76ee391de8SMasami Hiramatsu-f:: 77ee391de8SMasami Hiramatsu--force:: 78ee391de8SMasami Hiramatsu Forcibly add events with existing name. 79631c9defSMasami Hiramatsu 80f4d7da49SMasami Hiramatsu-n:: 81f4d7da49SMasami Hiramatsu--dry-run:: 82f4d7da49SMasami Hiramatsu Dry run. With this option, --add and --del doesn't execute actual 83f4d7da49SMasami Hiramatsu adding and removal operations. 84f4d7da49SMasami Hiramatsu 85ef4a3565SMasami Hiramatsu--max-probes:: 86ef4a3565SMasami Hiramatsu Set the maximum number of probe points for an event. Default is 128. 87ef4a3565SMasami Hiramatsu 88595c3649SMasami HiramatsuPROBE SYNTAX 89595c3649SMasami Hiramatsu------------ 90595c3649SMasami HiramatsuProbe points are defined by following syntax. 91595c3649SMasami Hiramatsu 922a9c8c36SMasami Hiramatsu 1) Define event based on function name 932a9c8c36SMasami Hiramatsu [EVENT=]FUNC[@SRC][:RLN|+OFFS|%return|;PTN] [ARG ...] 942a9c8c36SMasami Hiramatsu 952a9c8c36SMasami Hiramatsu 2) Define event based on source file with line number 962a9c8c36SMasami Hiramatsu [EVENT=]SRC:ALN [ARG ...] 972a9c8c36SMasami Hiramatsu 982a9c8c36SMasami Hiramatsu 3) Define event based on source file with lazy pattern 992a9c8c36SMasami Hiramatsu [EVENT=]SRC;PTN [ARG ...] 1002a9c8c36SMasami Hiramatsu 101595c3649SMasami Hiramatsu 102af663d75SMasami 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'. 1032a9c8c36SMasami 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. 1042a9c8c36SMasami 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. 10548481938SMasami Hiramatsu'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). 10648481938SMasami Hiramatsu 10748481938SMasami HiramatsuPROBE ARGUMENT 10848481938SMasami Hiramatsu-------------- 10948481938SMasami HiramatsuEach probe argument follows below syntax. 11048481938SMasami Hiramatsu 11111a1ca35SMasami Hiramatsu [NAME=]LOCALVAR|$retval|%REG|@SYMBOL[:TYPE] 11248481938SMasami Hiramatsu 113b2a3c12bSMasami 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'.) 11473317b95SMasami 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. 115595c3649SMasami Hiramatsu 116631c9defSMasami HiramatsuLINE SYNTAX 117631c9defSMasami Hiramatsu----------- 118*9d5b7f5bSShawn BohrerLine range is described by following syntax. 119631c9defSMasami Hiramatsu 120085ea739SMasami Hiramatsu "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]" 121631c9defSMasami Hiramatsu 122631c9defSMasami HiramatsuFUNC specifies the function name of showing lines. 'RLN' is the start line 123631c9defSMasami Hiramatsunumber from function entry line, and 'RLN2' is the end line number. As same as 124631c9defSMasami Hiramatsuprobe syntax, 'SRC' means the source file path, 'ALN' is start line number, 125631c9defSMasami Hiramatsuand 'ALN2' is end line number in the file. It is also possible to specify how 126631c9defSMasami Hiramatsumany lines to show by using 'NUM'. 127631c9defSMasami 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. 128631c9defSMasami Hiramatsu 1292a9c8c36SMasami HiramatsuLAZY MATCHING 1302a9c8c36SMasami Hiramatsu------------- 1312a9c8c36SMasami 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]). 1322a9c8c36SMasami Hiramatsu 1332a9c8c36SMasami Hiramatsue.g. 1342a9c8c36SMasami Hiramatsu 'a=*' can matches 'a=b', 'a = b', 'a == b' and so on. 1352a9c8c36SMasami Hiramatsu 1362a9c8c36SMasami 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.) 1372a9c8c36SMasami Hiramatsu 1382a9c8c36SMasami Hiramatsu 139ee391de8SMasami HiramatsuEXAMPLES 140ee391de8SMasami Hiramatsu-------- 141ee391de8SMasami HiramatsuDisplay which lines in schedule() can be probed: 142ee391de8SMasami Hiramatsu 143ee391de8SMasami Hiramatsu ./perf probe --line schedule 144ee391de8SMasami Hiramatsu 145ee391de8SMasami HiramatsuAdd a probe on schedule() function 12th line with recording cpu local variable: 146ee391de8SMasami Hiramatsu 147ee391de8SMasami Hiramatsu ./perf probe schedule:12 cpu 148ee391de8SMasami Hiramatsu or 149ee391de8SMasami Hiramatsu ./perf probe --add='schedule:12 cpu' 150ee391de8SMasami Hiramatsu 151ee391de8SMasami Hiramatsu this will add one or more probes which has the name start with "schedule". 152ee391de8SMasami Hiramatsu 1532a9c8c36SMasami Hiramatsu Add probes on lines in schedule() function which calls update_rq_clock(). 1542a9c8c36SMasami Hiramatsu 1552a9c8c36SMasami Hiramatsu ./perf probe 'schedule;update_rq_clock*' 1562a9c8c36SMasami Hiramatsu or 1572a9c8c36SMasami Hiramatsu ./perf probe --add='schedule;update_rq_clock*' 1582a9c8c36SMasami Hiramatsu 159ee391de8SMasami HiramatsuDelete all probes on schedule(). 160ee391de8SMasami Hiramatsu 161ee391de8SMasami Hiramatsu ./perf probe --del='schedule*' 162ee391de8SMasami Hiramatsu 163ee391de8SMasami Hiramatsu 164595c3649SMasami HiramatsuSEE ALSO 165595c3649SMasami Hiramatsu-------- 166595c3649SMasami Hiramatsulinkperf:perf-trace[1], linkperf:perf-record[1] 167