From 011987b8162b56b4932bae558364e82b8d76f7a1 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Tue, 11 Nov 2008 17:28:00 -0500 Subject: Add documentation for context.stp and networking.stp. --- .../en-US/Tapset_Reference.xml | 2 + doc/SystemTap_Tapset_Reference/en-US/context.xml | 233 +++++++++++++++++++++ .../en-US/networking.xml | 100 +++++++++ 3 files changed, 335 insertions(+) create mode 100644 doc/SystemTap_Tapset_Reference/en-US/context.xml create mode 100644 doc/SystemTap_Tapset_Reference/en-US/networking.xml (limited to 'doc/SystemTap_Tapset_Reference') diff --git a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml index 4603b238..f10159b8 100644 --- a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml +++ b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml @@ -7,6 +7,8 @@ + + diff --git a/doc/SystemTap_Tapset_Reference/en-US/context.xml b/doc/SystemTap_Tapset_Reference/en-US/context.xml new file mode 100644 index 00000000..df271d0f --- /dev/null +++ b/doc/SystemTap_Tapset_Reference/en-US/context.xml @@ -0,0 +1,233 @@ + + + + + Context Functions + + The context functions provide additional information about the where + the event occurred. + The contact functions can provide information such as a backtrace + where the event occured + and the current register values for the processor. + + + print_regs() + print_regs + + Print a register dump. + + + + print_backtrace() + print_backtrace + + Equivalent to print_stack(backtrace()), + except that deeper stack nesting may be supported. Return nothing. + + + + backtrace:string() + backtrace + + Return a string of hex addresses that are a backtrace of the + stack. It may be truncated due to maximum string length. + + + + execname:string() + execname + + Return the name of the current process. + + + + pid:long () + pid + + Return the id of the current process. + + + + tid:long() + tid + + Return the id of the current thread. + + + + ppid:long() + ppid + + Return the id of the parent process. + + + + pexecname:string() + pexecname + + Return the name of the parent process. + + + + gid:long() + gid + + Return the gid of the current process. + + + + egid:long() + egid + + Return the effective gid of the current process. + + + + uid:long() + uid + + Return the uid of the current process. + + + + euid:long() + euid + + Return the effective uid of the current process. + + + + cpuid:long() + cpuid + + Return the current cpu number. + + + + cpu:long() + cpu + + Return the current cpu number. + + + + print_stack(stk:string) + print_stack + + Perform a symbolic lookup of the addresses in the given string, + which is assumed to be the result of a prior call to + . + Print one line per address, including the address, the + name of the function containing the address, and an estimate of + its position within that function. Return nothing. + + + + pp:string() + pp + + Return the probe point associated with the currently running + probe handler, including alias and wildcard expansion effects. + + + + probefunc:string() + probefunc + + Return the probe point's function name, if known. + + + + probemod:string() + probemod + + Return the probe point's module name, if known. + + + + registers_valid:long() + registers_valid + + Return 1 if register() and u_register() can be used + in the current context, or 0 otherwise. + For example, registers_valid() returns 0 + when called from a begin or end probe. + + + + user_mode:long() + user_mode + + Return 1 if the probe point occurred in user-mode. + + + + is_return:long() + is_return + + Return 1 if the probe point is a return probe. + Deprecated. + + + + target:long() + target + + Return the pid of the target process. + + + + module_name:string() + module_name + + FIXME: need description. + + + + stp_pid:long() + stp_pid + + FIXME: need description. + + + + stack_size:long() + stack_size + + Return the size of the kernel stack. + + + + stack_used:long () + stack_used + + Return how many bytes are currently used in the kernel stack. + + + + stack_unused:long() + stack_unused + + Return how many bytes are currently available in the kernel stack. + + + + caller_addr:long() + caller_addr + + Return the address of the calling function. + Works only for return probes at this time. + + + + + caller:string() + caller + + Return the address and name of the calling function. + Works only for return probes at this time. + + + diff --git a/doc/SystemTap_Tapset_Reference/en-US/networking.xml b/doc/SystemTap_Tapset_Reference/en-US/networking.xml new file mode 100644 index 00000000..ce93739b --- /dev/null +++ b/doc/SystemTap_Tapset_Reference/en-US/networking.xml @@ -0,0 +1,100 @@ + + + + + Networking Tapset + + This family of probe points is used to probe the activities of + network device. + + + netdev.receive + netdev.receive + Fires when data arrives on network device. + + + Arguments: + dev_name + + The name of the device. e.g: eth0, ath1 + + + + length + + The length of the receiving buffer + + + + protocol + The possible values of protocol could be: + Protocol Values + + + + + ValueProtocol + + + 0800IP + 8100802.1Q VLAN + 0001802.3 + 0002AX.25 + 0004802.2 + 8035RARP + 0005SNAP + 0805X.25 + 0806ARP + 8137IPX + 0009Localtalk + 86DDIPv6 + + +
+ + + + truesize + + The size of the received data. + + + + + + + netdev.transmit + netdev.transmit + Fires when the network device wants to transmit a buffer. + + + Arguments: + dev_name + + The name of the device. e.g: eth0, ath1 + + + + length + + The length of the transmit buffer + + + + protocol + + The protocol of this packet. + + + + truesize + + The size of the the data to be transmitted. + + + + + + -- cgit