From b4f12ca39108269a5ca55e0925ae2046965d3083 Mon Sep 17 00:00:00 2001 From: Will Newton Date: Tue, 28 Jan 2014 14:26:38 +0000 Subject: 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 * include/stap-probe.h: Add comment about probe argument format. --- include/stap-probe.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'include/stap-probe.h') 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 -- cgit v1.2.3