* [RFC PATCH] Add syscall probe information to Language Reference
@ 2009-09-16 21:16 Robb Romans
2009-09-16 22:58 ` Josh Stone
0 siblings, 1 reply; 3+ messages in thread
From: Robb Romans @ 2009-09-16 21:16 UTC (permalink / raw)
To: systemtap
Signed-off-by: Robb Romans <robb@linux.vnet.ibm.com>
---
doc/langref.tex | 36 ++++++++++++++++++++++++++++++++++++
1 files changed, 36 insertions(+), 0 deletions(-)
diff --git a/doc/langref.tex b/doc/langref.tex
index 6003890..29de453 100644
--- a/doc/langref.tex
+++ b/doc/langref.tex
@@ -992,6 +992,42 @@ For more information about marker probes, see
\url{http://sourceware.org/systemtap/wiki/UsingMarkers}.
+\subsection{Syscall probes}
+\label{sec:syscall}
+\index{syscall probes}
+The \texttt{syscall.*} aliases define several hundred probes. They
+use the following syntax:
+\begin{vindent}
+\begin{verbatim}
+syscall.NAME
+syscall.NAME.return
+\end{verbatim}
+\end{vindent}
+
+Generally, two probes are defined for each normal system call as
+listed in the syscalls(2) manual page: one for entry and one for
+return. System calls that never return do not have a
+corresponding \texttt{.return} probe.
+
+Each probe alias defines a variety of variables. Look at the tapset
+source code to find the most reliable source of variable definitions.
+Generally, each variable listed in the standard manual page is
+available as a script-level variable. For example,
+\texttt{syscall.open} exposes file name, flags, and mode. In addition,
+a standard suite of variables is available at most aliases, as follows:
+
+\begin{itemize}
+\item \texttt{argstr}: A pretty-printed form of the entire argument
+ list, without parentheses.
+\item \texttt{name}: The name of the system call.
+\item \texttt{retstr}: For return probes, a pretty-printed form of the
+ system call result.
+\end{itemize}
+
+Not all probe aliases obey all of these general guidelines. Please
+report exceptions that you encounter as a bug.
+
+
\subsection{Tracepoints}
\label{sec:tracepoints}
\index{tracepoints}
--
1.6.0.4
--
Robb Romans
IBM LTC Information Development
robb@linux.vnet.ibm.com
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [RFC PATCH] Add syscall probe information to Language Reference
2009-09-16 21:16 [RFC PATCH] Add syscall probe information to Language Reference Robb Romans
@ 2009-09-16 22:58 ` Josh Stone
2009-09-16 23:27 ` Robb Romans
0 siblings, 1 reply; 3+ messages in thread
From: Josh Stone @ 2009-09-16 22:58 UTC (permalink / raw)
To: Robb Romans; +Cc: systemtap
This and the procfs and tracepoint patches are all committed now, thanks!
Josh
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [RFC PATCH] Add syscall probe information to Language Reference
2009-09-16 22:58 ` Josh Stone
@ 2009-09-16 23:27 ` Robb Romans
0 siblings, 0 replies; 3+ messages in thread
From: Robb Romans @ 2009-09-16 23:27 UTC (permalink / raw)
To: Josh Stone; +Cc: systemtap
Josh Stone <jistone@redhat.com> writes:
> This and the procfs and tracepoint patches are all committed now, thanks!
> Josh
Thank you.
Robb
--
Robb Romans
IBM LTC Information Development
robb@linux.vnet.ibm.com
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2009-09-16 23:27 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-09-16 21:16 [RFC PATCH] Add syscall probe information to Language Reference Robb Romans
2009-09-16 22:58 ` Josh Stone
2009-09-16 23:27 ` Robb Romans
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).