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 18*631c9defSMasami Hiramatsuor 19*631c9defSMasami Hiramatsu'perf probe' --line='FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]' 20595c3649SMasami Hiramatsu 21595c3649SMasami HiramatsuDESCRIPTION 22595c3649SMasami Hiramatsu----------- 23595c3649SMasami HiramatsuThis command defines dynamic tracepoint events, by symbol and registers 24595c3649SMasami Hiramatsuwithout debuginfo, or by C expressions (C line numbers, C function names, 25595c3649SMasami Hiramatsuand C local variables) with debuginfo. 26595c3649SMasami Hiramatsu 27595c3649SMasami Hiramatsu 28595c3649SMasami HiramatsuOPTIONS 29595c3649SMasami Hiramatsu------- 30595c3649SMasami Hiramatsu-k:: 31c43f9d1eSMasami Hiramatsu--vmlinux=PATH:: 32595c3649SMasami Hiramatsu Specify vmlinux path which has debuginfo (Dwarf binary). 33595c3649SMasami Hiramatsu 34595c3649SMasami Hiramatsu-v:: 35595c3649SMasami Hiramatsu--verbose:: 36595c3649SMasami Hiramatsu Be more verbose (show parsed arguments, etc). 37595c3649SMasami Hiramatsu 38c43f9d1eSMasami Hiramatsu-a:: 39c937fe20SMasami Hiramatsu--add=:: 40c937fe20SMasami Hiramatsu Define a probe event (see PROBE SYNTAX for detail). 41c937fe20SMasami Hiramatsu 42c937fe20SMasami Hiramatsu-d:: 43c937fe20SMasami Hiramatsu--del=:: 44c937fe20SMasami Hiramatsu Delete a probe event. 45c937fe20SMasami Hiramatsu 46c937fe20SMasami Hiramatsu-l:: 47c937fe20SMasami Hiramatsu--list:: 48c937fe20SMasami Hiramatsu List up current probe events. 49595c3649SMasami Hiramatsu 50*631c9defSMasami Hiramatsu-L:: 51*631c9defSMasami Hiramatsu--line=:: 52*631c9defSMasami Hiramatsu Show source code lines which can be probed. This needs an argument 53*631c9defSMasami Hiramatsu which specifies a range of the source code. 54*631c9defSMasami Hiramatsu 55595c3649SMasami HiramatsuPROBE SYNTAX 56595c3649SMasami Hiramatsu------------ 57595c3649SMasami HiramatsuProbe points are defined by following syntax. 58595c3649SMasami Hiramatsu 59af663d75SMasami Hiramatsu "[EVENT=]FUNC[+OFFS|:RLN|%return][@SRC]|SRC:ALN [ARG ...]" 60595c3649SMasami Hiramatsu 61af663d75SMasami 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'. 62c43f9d1eSMasami 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. In addition, 'SRC' specifies a source file which has that function. 63c43f9d1eSMasami HiramatsuIt 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. 64595c3649SMasami Hiramatsu'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). 65595c3649SMasami Hiramatsu 66*631c9defSMasami HiramatsuLINE SYNTAX 67*631c9defSMasami Hiramatsu----------- 68*631c9defSMasami HiramatsuLine range is descripted by following syntax. 69*631c9defSMasami Hiramatsu 70*631c9defSMasami Hiramatsu "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]" 71*631c9defSMasami Hiramatsu 72*631c9defSMasami HiramatsuFUNC specifies the function name of showing lines. 'RLN' is the start line 73*631c9defSMasami Hiramatsunumber from function entry line, and 'RLN2' is the end line number. As same as 74*631c9defSMasami Hiramatsuprobe syntax, 'SRC' means the source file path, 'ALN' is start line number, 75*631c9defSMasami Hiramatsuand 'ALN2' is end line number in the file. It is also possible to specify how 76*631c9defSMasami Hiramatsumany lines to show by using 'NUM'. 77*631c9defSMasami 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. 78*631c9defSMasami Hiramatsu 79595c3649SMasami HiramatsuSEE ALSO 80595c3649SMasami Hiramatsu-------- 81595c3649SMasami Hiramatsulinkperf:perf-trace[1], linkperf:perf-record[1] 82