summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Book_Info.xml2
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Installation.xml2
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Revision_History.xml32
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-dropwatch.xml28
-rw-r--r--doc/SystemTap_Tapset_Reference/tapsets.tmpl9
5 files changed, 60 insertions, 13 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Book_Info.xml b/doc/SystemTap_Beginners_Guide/en-US/Book_Info.xml
index 5dfeeee2..acca17ae 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Book_Info.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Book_Info.xml
@@ -5,7 +5,7 @@
<bookinfo id="SystemTap_Beginners_Guide">
<title>SystemTap Beginners Guide</title>
<subtitle condition="RedHat">Introduction to SystemTap (for Red Hat Enterprise Linux 5.4)</subtitle>
- <subtitle condition="fedora">Introduction to SystemTap (for Fedora 10)</subtitle>
+<!-- <subtitle condition="fedora">Introduction to SystemTap (for Fedora 10)</subtitle> -->
<edition>2.0</edition>
<productname>Red Hat Enterprise Linux</productname>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
index d0ce1f26..ab984b14 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
@@ -213,7 +213,7 @@ enabled=1
Replace <command><replaceable>kernelname</replaceable></command> with the appropriate kernel variant name
(for example, <filename>kernel-PAE</filename>), and <command><replaceable>version</replaceable></command>
with the target kernel's version. For example, to install the required kernel information packages for
- the <command>kernel-PAE--2.6.18-53.1.13.el5</command> kernel, run:
+ the <command>kernel-PAE-2.6.18-53.1.13.el5</command> kernel, run:
</para>
<itemizedlist>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Revision_History.xml b/doc/SystemTap_Beginners_Guide/en-US/Revision_History.xml
index d5ce8446..96201d56 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Revision_History.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Revision_History.xml
@@ -6,7 +6,36 @@
<title>Revision History</title>
<simpara>
<revhistory>
- <revision>
+<revision>
+ <revnumber>2.0</revnumber>
+ <date>Mon Jul 20 2009</date>
+ <author>
+ <firstname>Don</firstname>
+ <surname>Domingo</surname>
+ <email>ddomingo@redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>includes 5.4 minor updates and additional script "dropwatch.stp"</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+
+<revision>
+ <revnumber>1.0</revnumber>
+ <date>Wed Jun 17 2009</date>
+ <author>
+ <firstname>Don</firstname>
+ <surname>Domingo</surname>
+ <email>ddomingo@redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Building+pushing to RHEL</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+<!-- <revision>
<revnumber>1.0</revnumber>
<date>September 2, 2008</date>
<author>
@@ -50,6 +79,7 @@
</simplelist>
</revdescription>
</revision>
+-->
</revhistory>
</simpara>
</appendix>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-dropwatch.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-dropwatch.xml
index c7bee988..3bc69899 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-dropwatch.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-dropwatch.xml
@@ -39,11 +39,10 @@
<indexterm><primary>tracepoint</primary></indexterm>
The network stack in Linux
can discard packets for various reasons. Some Linux kernels include a
-tracepoint, <command>kernel.trace("kfree_skb")</command>, to allow easy probing
-to determine where the packets are discarded. The <xref linkend="dropwatch"/>
-script uses that tracepoint trace packet discards. The script summarizes the
-locations discarding packets every five seconds as totals number of packets
-discarded for each location.
+tracepoint, <command>kernel.trace("kfree_skb")</command>, which easily tracks where packets
+are discarded. <xref linkend="dropwatch"/> uses <command>kernel.trace("kfree_skb")</command> to trace
+packet discards; the script summarizes which locations
+discard packets every five-second interval.
</para>
<formalpara id="dropwatch">
@@ -56,9 +55,8 @@ discarded for each location.
</formalpara>
<para>
-The <command>kernel.trace("kfree_skb")</command> instruments each of the places
-in the kernel that drops network packets. Like probes for functions the
-tracepoint probes also have arguments. The
+The <command>kernel.trace("kfree_skb")</command> traces which places
+in the kernel drop network packets. The
<command>kernel.trace("kfree_skb")</command> has two arguments: a pointer to the
buffer being freed (<command>$skb</command>) and the location in kernel code the
buffer is being freed (<command>$location</command>).
@@ -88,6 +86,18 @@ Stopping dropped packet monitor
</example>
<para>
+To make the location of packet drops more meaningful, refer to the
+<filename>/boot/System.map-`uname -r`</filename> file. This file lists the
+starting addresses for each function, allowing you to map the
+addresses in the output of <xref linkend="dropwatchoutput"/> to a specific
+function name. Given the following snippet of the <filename>/boot/System.map-`uname -r`</filename> file,
+the
+address 0xffffffff8024cd0f maps to the function
+<command>unix_stream_recvmsg</command> and the address 0xffffffff8044b472 maps
+to the function <command>arp_rcv</command>:
+</para>
+<!--
+<para>
The functions containing the location of the packet drops is determined using
<command>/boot/System.map-`uname -r`</command> file. The System.map file lists
the starting addesses for each function. Below are the sections of the
@@ -96,7 +106,7 @@ address 0xffffffff8024cd0f maps to the function
<command>unix_stream_recvmsg</command> and the address 0xffffffff8044b472 maps
to the function <command>arp_rcv</command>.
</para>
-
+-->
<screen>
[...]
ffffffff8024c5cd T unlock_new_inode
diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
index 835d0309..7e9d4784 100644
--- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl
+++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
@@ -198,5 +198,12 @@
</para>
!Itapset/signal.stp
</chapter>
-
+ <chapter id="dentry.stp">
+ <title>Directory-entry (dentry) Tapset</title>
+ <para>
+ This family of functions is used to map kernel VFS
+ directory entriy pointers to file or full path names.
+ </para>
+!Itapset/dentry.stp
+ </chapter>
</book>