This is the mail archive of the systemtap@sourceware.org mailing list for the systemtap project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[PATCH 5/6] New Infiniband (OFED) tapset - man page


This patch add a manual page for the ofed set of tapsets and updates
the stapprobes manual page.

Signed-off-by: David Wilder <dwilder@us.ibm.com>

------------------------------------------------------
 configure.ac             |    2 +-
 man/stapprobes.ofed.5.in |   99 ++++++++++++++++++++++++++++++++++++++++++++++
 stapprobes.5.in          |    1 +
 3 files changed, 101 insertions(+), 1 deletions(-)

diff --git a/configure.ac b/configure.ac
index 542b3b4..3a900b5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -335,7 +335,7 @@ dnl Don't use this directly (when not given it is set to NONE).
 AC_DEFINE_UNQUOTED(STAP_PREFIX, "$prefix", [configure prefix location])
 
 AC_CONFIG_HEADERS([config.h:config.in])
-AC_CONFIG_FILES(Makefile doc/Makefile doc/SystemTap_Tapset_Reference/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 initscript/systemtap)
+AC_CONFIG_FILES(Makefile doc/Makefile doc/SystemTap_Tapset_Reference/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 man/stapprobes.5.in initscript/systemtap)
 AC_CONFIG_SUBDIRS(testsuite)
 AC_CONFIG_FILES([run-stap], [chmod +x run-stap])
 AC_OUTPUT
diff --git a/man/stapprobes.ofed.5.in b/man/stapprobes.ofed.5.in
new file mode 100644
index 0000000..add1477
--- /dev/null
+++ b/man/stapprobes.ofed.5.in
@@ -0,0 +1,99 @@
+.\" -*- nroff -*-
+.TH STAPPROBES.OFED 5 @DATE@ "IBM"
+.SH NAME
+stapprobes.ofed \- systemtap infiniband probe points
+
+.\" macros
+.de SAMPLE
+.br
+.RS
+.nf
+.nh
+..
+.de ESAMPLE
+.hy
+.fi
+.RE
+..
+
+.SH DESCRIPTION
+
+This family of probe points is used to probe the ofed infiniband stack.
+A "probe data output service" (dprint) has been included in the tapset.
+When enabled the dprint service displays a function trace of several key
+components of the ofed stack.
+
+.P
+.TP 
+.B Probe points:
+Probe points aliases are assigned using the following format:
+
+<module name>.[UD|CM].[function name]
+
+.I module name
+The name of the kernel module containing the probe. Supported modules are ib_ipoib, ib_cm.
+
+.I UD, CM
+Used only with the ib_ipoib module. Effectively splits the probe points of
+the ib_ipoib module into two groups. Use UD to specify probes related to
+datagram mode or CM to specify connection mode probes.
+
+.I function
+Name of the function containing the probe point.  Most probes are placed at
+the function entry.
+
+.SH HELPER FUNCTIONS:
+These helper functions are available for use by tap scripts.
+
+.B ib_dprint_on()
+Turn on the data print feature.
+
+.B ib_dprint_off()
+Turn off the function tracing print feature.
+
+.B hexdump (buff:long, len:long)
+Prints "len" bytes in hex that are pointed to by "buff".
+
+.B _hexdump:string (buff:long, _len:long)
+Returns a string of "_len" bytes in hex that are pointed to by "buff".
+The maximum number of bytes processed is about MAXSTRING/3.
+
+.B skbdump(skb:long)
+Prints in hex the buffer of a struct sk_buff. Input variable skb is a pointer
+to an sk_buff. The maximum number of bytes processed is about MAXSTRING/3.
+
+.B _skbdump:string(skb:long)
+Returns a string of hex bytes found in the buffer of a struct sk_buff.
+The maximum number of bytes processed is about MAXSTRING/3.
+
+.B Conversion functions
+Converts event and state values to strings or integers.
+
+.B ib_event_num2str:string (event:long)
+.B ib_event_str2num:long (event:string)
+.B ib_wc_status_num2str:string (status:long)
+.B ib_wc_status_str2num:long (statis:string)
+.B ib_wr_opcode_num2str:string (opcode:long)
+.B ib_wr_opcode_str2num:long  (opcode:string)
+.B ipoib_cm_state_num2str:string (state:long)
+.B ipoib_cm_state_str2num:long (state:string)
+.B ib_wr_flags2str:string (flags:long)
+.B ib_cm_event_type_num2str:string (event:long)
+.B ib_cm_event_type_str2num:long (event:string)
+.B ib_cm_state_num2str:string (state:long)
+.B ib_cm_state_str2num:long (state:string)
+.B ib_cm_lap_state_num2str:string (state:long)
+.B ib_cm_lap_state_str2num:long (state:string
+
+
+.SH USING THE dprint FEATURE:
+When switched on the dprint feature prints a set of default data
+for each enabled probe point. To enable dprint, call
+ib_dprint_on() in your begin probe. You must set a probe
+on the points that you wish to generate dprint data. It is
+not necessary to provide a probe handler for these probe points.
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (5),
+
diff --git a/stapprobes.5.in b/stapprobes.5.in
index 0854be5..3b3312d 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -632,4 +632,5 @@ refers to the group of probe aliases with any name in the third position
 .IR stapprobes.socket (5),
 .IR stapprobes.tcp (5),
 .IR stapprobes.udp (5),
+.IR stapprobes.ofed (5),
 .IR proc (5)



Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]