summaryrefslogtreecommitdiffstats
path: root/stapfuncs.5.in
diff options
context:
space:
mode:
authorfche <fche>2005-09-05 22:00:43 +0000
committerfche <fche>2005-09-05 22:00:43 +0000
commitcc9ee6059e4d3fb51c0695a8a57f75eb988a1786 (patch)
tree7ab8cf3bede7e9200c3290a9def709f9ae16b4bd /stapfuncs.5.in
parentf86db5a776ed429e0df0e3d871c5692f86b0f4be (diff)
downloadsystemtap-steved-cc9ee6059e4d3fb51c0695a8a57f75eb988a1786.tar.gz
systemtap-steved-cc9ee6059e4d3fb51c0695a8a57f75eb988a1786.tar.xz
systemtap-steved-cc9ee6059e4d3fb51c0695a8a57f75eb988a1786.zip
2005-09-05 Frank Ch. Eigler <fche@elastic.org>
PR 1172. * staptree.h, staptree.cxx: Make all ::print*(), operator<< functions take const staptree objects. (literal_string::print): \-prefix double-quotes. * translate.cxx (emit_common_header): Add context probe_point field. Switch to atomic_t busy flags. (emit_module_exit): Use atomic operations for busy flag. (visit_*): Use lex_cast_qstring for last_stmt strings. * tapsets.cxx (lex_cast_quoted): \-prefix double-quotes too. (*::emit_probe_entries): Populate probe_point. Use atomic operations for busy flag. * tapset/context.stp (pp): New function. * stapfuncs.5.in: Document it. * testsuite/buildok/context_test.stp: Test it.
Diffstat (limited to 'stapfuncs.5.in')
-rw-r--r--stapfuncs.5.in39
1 files changed, 22 insertions, 17 deletions
diff --git a/stapfuncs.5.in b/stapfuncs.5.in
index 212e5193..dbecf0d3 100644
--- a/stapfuncs.5.in
+++ b/stapfuncs.5.in
@@ -15,13 +15,13 @@ Examples:
.TP
example1:long (v:string, k:long)
-Function "example1" does something with the given string and integer.
-It returns some integer.
+In function "example1", do something with the given string and integer.
+Return some integer.
.TP
example2:unknown ()
-Function "example2" does something. There is no explicit return value
-and it takes no parameters.
+In function "example2", do something. There is no explicit return value
+and take no parameters.
.SS LOGGING
@@ -98,52 +98,57 @@ Return the number of seconds since the UNIX epoch.
.TP
execname:string ()
-Returns the name of the current process.
+Return the name of the current process.
.TP
pexecname:string()
-Returns the name of the parent process.
+Return the name of the parent process.
.TP
pid:long ()
-Returns the current pid.
+Return the current pid.
.TP
ppid:long ()
-Returns the current pid.
+Return the current pid.
.TP
uid:long ()
-Returns the uid of the current process.
+Return the uid of the current process.
.TP
euid:long ()
-Returns the effective uid of the current process.
+Return the effective uid of the current process.
.TP
gid:long ()
-Returns the gid of the current process.
+Return the gid of the current process.
.TP
egid:long ()
-Returns the effective gid of the current process.
+Return the effective gid of the current process.
.TP
print_regs:unknown ()
-Prints a register dump.
+Print a register dump.
.TP
print_backtrace:unknown ()
-Prints a symbolic backtrace. Use with care. May be timeconsuming.
+Print a symbolic backtrace. Use with care. May be timeconsuming.
.TP
backtrace:string ()
-Returns a string of hex addresses that are a backtrace of the stack.
+Return a string of hex addresses that are a backtrace of the stack.
May be truncated due to maximum string length.
.TP
-print_stack(bt:string)
-Does a symbolic lookup of the addresses in bt and prints one per line.
+print_stack (bt:string)
+Perform a symbolic lookup of the addresses in bt and prints one per line.
+
+.TP
+pp:string ()
+Return the probe point associated with the currently running probe handler,
+including alias and wildcard expansion effects.
.SH FILES
.nh