diff options
author | fche <fche> | 2005-08-30 01:54:44 +0000 |
---|---|---|
committer | fche <fche> | 2005-08-30 01:54:44 +0000 |
commit | ba4a90fd18a9c94624a38d660c6e7ca6230c271f (patch) | |
tree | 82a060bc5f9db3001c0e09db8372caf8bfdfc2dc /stapfuncs.5.in | |
parent | 55a030a179fdfd1e887d95d5c0050004bee27fcf (diff) | |
download | systemtap-steved-ba4a90fd18a9c94624a38d660c6e7ca6230c271f.tar.gz systemtap-steved-ba4a90fd18a9c94624a38d660c6e7ca6230c271f.tar.xz systemtap-steved-ba4a90fd18a9c94624a38d660c6e7ca6230c271f.zip |
2005-08-29 Frank Ch. Eigler <fche@redhat.com>
* stapprobes.5.in, stapfuncs.5.in, stapex.5.in: New man pages.
* stap.1.in: Moved some content out.
* Makefile.am (man_MANS): Add new man pages.
* configure.ac (AC_CONFIG_FILES): Add them.
* systemtap.spec.in: Package them.
* Makefile.in, configure: Regenerated.
* buildrun.cxx (run_pass): Pass "-r" to stpd.
* translate.cxx (emit_common_header): Wrap try/catch around
variable decls, to improve exception particularity.
(visit_literal_number): Emit as unsigned literal, which is
actually a subtle correctness issue.
Diffstat (limited to 'stapfuncs.5.in')
-rw-r--r-- | stapfuncs.5.in | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/stapfuncs.5.in b/stapfuncs.5.in new file mode 100644 index 00000000..597dc674 --- /dev/null +++ b/stapfuncs.5.in @@ -0,0 +1,92 @@ +.\" -*- nroff -*- +.TH STAPFUNCS 5 @DATE@ "Red Hat" +.SH NAME +stapfuncs \- systemtap functions + +.SH DESCRIPTION +The following sections enumerate the public functions provided by +standard tapsets installed under /usr/share/systemtap/tapset. Each +function is described with a signature, and its behavior/restrictions. +The signature line includes the name of the function, the type of +its return value (if any), and the names and types of all parameters. +The syntax is the same as printed with the +.IR stap " option " -p2 . +Examples: + +.TP +example1:long (v:string, k:long) +Function "example1" does something with the given string and integer. +It returns some integer. + +.TP +example2:unknown () +Function "example2" does something. There is no explicit return value +and it takes no parameters. + +.SS LOGGING + +.TP +printk:unknown (msg:string) +Log the given string to the kernel's printk buffer, at KERN_INFO severity. +Append an implicit end-of-line. + +.TP +log:unknown (msg:string) +Log the given string to the common trace buffer. Append an implicit +end-of-line. + +.TP +warn:unknown (msg:string) +Log the given string to the warning stream. Append an implicit end-of-line. +.I stpd +prepends the string "WARNING:". + +.TP +error:unknown (msg:string) +A fatal error has occurred. Log the given string to the error stream. +Append an implicit end-of-line. +.I stpd +prepends the string "ERROR:". +Block any further execution of statements in this probe, block +any new probe handlers, and end the systemtap session as soon +as possible. + +.TP +exit:unknown () +Enqueue a request to shut down the systemtap session. This does +.B not +unwind the current probe handler, nor block new probe handlers. +.I stpd +will shortly respond to the request and initiate an orderly shutdown. + +.SS CONVERSIONS + +.TP +hexstring:string (num:long) +Return a hexadecimal string representation of the given integer, including +the leading "0x". + +.TP +string:string (num:long) +Return a decimal string representation of the given integer. + +.SS TIMESTAMP + +.TP +gettimeofday_ms:long () +Return the number of milliseconds since the UNIX epoch. + +.TP +gettimeofday_s:long () +Return the number of seconds since the UNIX epoch. + +.\" .SS CONTEXTINFO + + +.SH FILES +.nh +.IR /usr/share/systemtap/tapset +.hy + +.SH SEE ALSO +.IR stap (1) |