From 0cce60ac57b25f73f74b2e42b226b2c05162feea Mon Sep 17 00:00:00 2001 From: William Cohen Date: Tue, 25 Nov 2008 11:02:08 -0500 Subject: Add kernel-doc based version of SystemTap_Tapset_Reference. --- doc/SystemTap_Tapset_Reference/tapsets.tmpl | 115 ++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 doc/SystemTap_Tapset_Reference/tapsets.tmpl (limited to 'doc/SystemTap_Tapset_Reference/tapsets.tmpl') diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl new file mode 100644 index 00000000..8ae22edf --- /dev/null +++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl @@ -0,0 +1,115 @@ + + + + + + SystemTap Tapset Reference Manual + + + + Willliam + Cohen + +
+ wcohen@redhat.com +
+ + + + + + 2008 + Red Hat, Inc. + + + + + This documentation is free software; you can redistribute + it and/or modify it under the terms of the GNU General Public + License version 2 as published by the Free Software Foundation. + + + + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU General Public License for more details. + + + + You should have received a copy of the GNU General Public + License along with this program; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, + MA 02111-1307 USA + + + + For more details see the file COPYING in the source + distribution of Linux. + + + + + + + + Introduction + + SystemTap provides free software (GPL) infrastructure to simplify the + gathering of information about the running Linux system. This assists + diagnosis of a performance or functional problem. SystemTap eliminates the + need for the developer to go through the tedious and disruptive instrument, + recompile, install, and reboot sequence that may be otherwise required to + collect data. + + + + SystemTap provides a simple command line interface and scripting language + for writing instrumentation for a live running kernel. The instrumentation + makes extensive use of the probe points and functions provided in the + tapset library. This document describes the various + probe points and functions. + + +
+ Tapset Name Format + + In this guide, tapset definitions appear in the following format: + + + name:return (parameters) + definition + + + + The return field specifies what data type the + tapset extracts and returns from the kernel during a probe (and thus, + returns). Tapsets use 2 data types for + return: long (tapset + extracts and returns an integer) and string (tapset + extracts and returns a string). + + + + In some cases, tapsets do not have a return v +alue. This + simply means that the tapset does not extract anything from the kernel. +This is common among + asynchronous events such as timers, exit functions, and print functions. + + + + +
+ + + + -- cgit