summaryrefslogtreecommitdiffstats
path: root/stapprobes.5.in
diff options
context:
space:
mode:
Diffstat (limited to 'stapprobes.5.in')
-rw-r--r--stapprobes.5.in27
1 files changed, 20 insertions, 7 deletions
diff --git a/stapprobes.5.in b/stapprobes.5.in
index c71f79d3..5281c40e 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -334,6 +334,11 @@ $var\->field
traversal to a structure's field. The indirection operator
may be repeated to follow more levels of pointers.
.TP
+$return
+is available in return probes only for functions that are declared
+with a return value.
+.TP
+.TP
$var[N]
indexes into an array. The index is given with a
literal number.
@@ -344,12 +349,15 @@ sprintf("parm1=%x ... parmN=%x var1=%x ... varN=%x", parm1, ..., parmN,
var1, ..., varN)
.TP
$$locals
-expands to a character string that is equivalent to
-sprintf("var1=%x ... varN=%x", var1, ..., varN)
+expands to a subset of $$vars for only local variables.
.TP
$$parms
-expands to a character string that is equivalent to
-sprintf("parm1=%x ... parmN=%x", parm1, ..., parmN)
+expands to a subset of $$vars for only function parameters.
+.TP
+$$return
+is available in return probes only. It expands to a string that
+is equivalent to sprintf("return=%x", $return)
+if the probed function has a return value, or else an empty string.
.PP
For ".return" probes, context variables other than the "$return"
value itself are only available for the function call parameters.
@@ -378,16 +386,22 @@ Additional user-space probing is available in the following forms:
.SAMPLE
process(PID).begin
process("PATH").begin
+process.begin
process(PID).thread.begin
process("PATH").thread.begin
+process.thread.begin
process(PID).end
process("PATH").end
+process.end
process(PID).thread.end
process("PATH").thread.end
+process.thread.end
process(PID).syscall
process("PATH").syscall
+process.syscall
process(PID).syscall.return
process("PATH").syscall.return
+process.syscall.return
process(PID).itrace
process("PATH").itrace
.ESAMPLE
@@ -423,9 +437,8 @@ Note that
names refer to executables that are searched the same way shells do: relative
to the working directory if they contain a "/" character, otherwise in
.BR $PATH .
-A
-.I PATH
-of "*" means to probe all threads.
+If a process probe is specified without a PID or PATH, all user
+threads are probed.
.SS PROCFS