| perf-probe.txt (cf40a76e7d5874bb25f4404eecc58a2e033af885) | perf-probe.txt (e63c625a1e417edbe513b75b347a7238e9e7fea0) |
|---|---|
| 1perf-probe(1) 2============= 3 4NAME 5---- 6perf-probe - Define new dynamic tracepoints 7 8SYNOPSIS --- 156 unchanged lines hidden (view full) --- 165 3) Define event based on source file with lazy pattern 166 [[GROUP:]EVENT=]SRC;PTN [ARG ...] 167 168 4) Pre-defined SDT events or cached event with name 169 %[sdt_PROVIDER:]SDTEVENT 170 or, 171 sdt_PROVIDER:SDTEVENT 172 | 1perf-probe(1) 2============= 3 4NAME 5---- 6perf-probe - Define new dynamic tracepoints 7 8SYNOPSIS --- 156 unchanged lines hidden (view full) --- 165 3) Define event based on source file with lazy pattern 166 [[GROUP:]EVENT=]SRC;PTN [ARG ...] 167 168 4) Pre-defined SDT events or cached event with name 169 %[sdt_PROVIDER:]SDTEVENT 170 or, 171 sdt_PROVIDER:SDTEVENT 172 |
| 173'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function. You can also specify a group name by 'GROUP', if omitted, set 'probe' is used for kprobe and 'probe_<bin>' is used for uprobe. | 173'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function, and for return probes, a "\_\_return" suffix is automatically added to the function name. You can also specify a group name by 'GROUP', if omitted, set 'probe' is used for kprobe and 'probe_<bin>' is used for uprobe. |
| 174Note that using existing group name can conflict with other events. Especially, using the group name reserved for kernel modules can hide embedded events in the 175modules. 176'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. 177It 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. 178'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). 179'SDTEVENT' and 'PROVIDER' is the pre-defined event name which is defined by user SDT (Statically Defined Tracing) or the pre-cached probes with event name. 180Note that before using the SDT event, the target binary (on which SDT events are defined) must be scanned by linkperf:perf-buildid-cache[1] to make SDT events as cached events. 181 --- 102 unchanged lines hidden --- | 174Note that using existing group name can conflict with other events. Especially, using the group name reserved for kernel modules can hide embedded events in the 175modules. 176'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. 177It 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. 178'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). 179'SDTEVENT' and 'PROVIDER' is the pre-defined event name which is defined by user SDT (Statically Defined Tracing) or the pre-cached probes with event name. 180Note that before using the SDT event, the target binary (on which SDT events are defined) must be scanned by linkperf:perf-buildid-cache[1] to make SDT events as cached events. 181 --- 102 unchanged lines hidden --- |