about summary refs log tree commit diff
path: root/include
diff options
context:
space:
mode:
authorWill Newton <will.newton@linaro.org>2014-01-28 14:26:38 +0000
committerWill Newton <will.newton@linaro.org>2014-02-11 10:17:11 +0000
commitb4f12ca39108269a5ca55e0925ae2046965d3083 (patch)
treedf4d8dc7ef5cd00fd569fa4038d703464294fa35 /include
parentc13a72b7c4864f23b9f2e96a3369e5875ed3b51b (diff)
downloadglibc-b4f12ca39108269a5ca55e0925ae2046965d3083.tar.gz
glibc-b4f12ca39108269a5ca55e0925ae2046965d3083.tar.xz
glibc-b4f12ca39108269a5ca55e0925ae2046965d3083.zip
include/stap-probe.h: Add comment about SystemTap argument format
Add a comment pointing to the SystemTap wiki page that documents the
format of the arguments. Also add a pointer to the SystemTap and
gdb sources which seem to be the best place to get the architecture
specific details.

ChangeLog:

2014-02-11  Will Newton  <will.newton@linaro.org>

	* include/stap-probe.h: Add comment about probe argument
	format.
Diffstat (limited to 'include')
-rw-r--r--include/stap-probe.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/include/stap-probe.h b/include/stap-probe.h
index 73b88e67ee..688646c9e9 100644
--- a/include/stap-probe.h
+++ b/include/stap-probe.h
@@ -30,7 +30,15 @@
 
    Systemtap's header defines the macros STAP_PROBE (provider, name) and
    STAP_PROBEn (provider, name, arg1, ..., argn).  For "provider" we paste
-   in the IN_LIB name (libc, libpthread, etc.) automagically.  */
+   in the IN_LIB name (libc, libpthread, etc.) automagically.
+
+   The format of the arg parameters is discussed here:
+
+   https://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation
+
+   The precise details of how register names are specified is
+   architecture specific and can be found in the gdb and SystemTap
+   source code.  */
 
 # ifndef NOT_IN_libc
 #  define IN_LIB	libc