summaryrefslogtreecommitdiffstats
path: root/SystemTap_Beginners_Guide/using-systemtap.html
diff options
authorserhei <serhei>2022-11-16 15:22:14 +0000
committerserhei <serhei>2022-11-16 15:22:14 +0000
commitf7f6f68dda3ed01e7b7dd7e95dca2e84326fab2b (patch)
treedef321b7b9ba6994d8f5615bf5ecbabc47e07c38 /SystemTap_Beginners_Guide/using-systemtap.html
parentadd new tutorial/* (diff)
removed man pages
Diffstat (limited to 'SystemTap_Beginners_Guide/using-systemtap.html')
-rw-r--r--SystemTap_Beginners_Guide/using-systemtap.html12
1 files changed, 6 insertions, 6 deletions
diff --git a/SystemTap_Beginners_Guide/using-systemtap.html b/SystemTap_Beginners_Guide/using-systemtap.html
index e501b313..3bfdde75 100644
--- a/SystemTap_Beginners_Guide/using-systemtap.html
+++ b/SystemTap_Beginners_Guide/using-systemtap.html
@@ -1,9 +1,9 @@
1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">Chapter 2. Using SystemTap</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="not publican" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="" /><link rel="home" href="index.html" title="SystemTap Beginners Guide" /><link rel="up" href="index.html" title="SystemTap Beginners Guide" /><link rel="prev" href="intro-systemtap-limitations.html" title="1.3. Limitations of SystemTap" /><link rel="next" href="cross-compiling.html" title="2.2. Generating Instrumentation for Other Computers" /></head><body><p id="title"></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="intro-systemtap-limitations.html"><strong>Prev</strong></a></li><li class="home">SystemTap Beginners Guide</li><li class="next"><a accesskey="n" href="cross-compiling.html"><strong>Next</strong></a></li></ul><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="using-systemtap"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">Chapter 2. Using SystemTap</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="not publican" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="" /><link rel="home" href="index.html" title="SystemTap Beginners Guide" /><link rel="up" href="index.html" title="SystemTap Beginners Guide" /><link rel="prev" href="intro-systemtap-limitations.html" title="1.3. Limitations of SystemTap" /><link rel="next" href="cross-compiling.html" title="2.2. Generating Instrumentation for Other Computers" /></head><body><p id="title"></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="intro-systemtap-limitations.html"><strong>Prev</strong></a></li><li class="home">SystemTap Beginners Guide</li><li class="next"><a accesskey="n" href="cross-compiling.html"><strong>Next</strong></a></li></ul><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="using-systemtap">
3 ⁠</a>Chapter 2. Using SystemTap</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="using-systemtap.html#using-setup">2.1. Installation and Setup</a></span></dt><dd><dl><dt><span class="section"><a href="using-systemtap.html#installproper">2.1.1. Installing SystemTap</a></span></dt><dt><span class="section"><a href="using-systemtap.html#install-kinfo">2.1.2. Installing Required Kernel Information Packages Manually</a></span></dt><dt><span class="section"><a href="using-systemtap.html#testing">2.1.3. Initial Testing</a></span></dt></dl></dd><dt><span class="section"><a href="cross-compiling.html">2.2. Generating Instrumentation for Other Computers</a></span></dt><dt><span class="section"><a href="using-usage.html">2.3. Running SystemTap Scripts</a></span></dt><dd><dl><dt><span class="section"><a href="using-usage.html#flight-recorder">2.3.1. SystemTap Flight Recorder Mode</a></span></dt></dl></dd></dl></div><a id="idm46604934250656" class="indexterm"></a><div class="para"> 3 ⁠</a>Chapter 2. Using SystemTap</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="using-systemtap.html#using-setup">2.1. Installation and Setup</a></span></dt><dd><dl><dt><span class="section"><a href="using-systemtap.html#installproper">2.1.1. Installing SystemTap</a></span></dt><dt><span class="section"><a href="using-systemtap.html#install-kinfo">2.1.2. Installing Required Kernel Information Packages Manually</a></span></dt><dt><span class="section"><a href="using-systemtap.html#testing">2.1.3. Initial Testing</a></span></dt></dl></dd><dt><span class="section"><a href="cross-compiling.html">2.2. Generating Instrumentation for Other Computers</a></span></dt><dt><span class="section"><a href="using-usage.html">2.3. Running SystemTap Scripts</a></span></dt><dd><dl><dt><span class="section"><a href="using-usage.html#flight-recorder">2.3.1. SystemTap Flight Recorder Mode</a></span></dt></dl></dd></dl></div><a id="idm46413318351392" class="indexterm"></a><div class="para">
4 This chapter documents how to install SystemTap in the system and explains how to use the <code class="command">stap</code> utility to run SystemTap scripts. 4 This chapter documents how to install SystemTap in the system and explains how to use the <code class="command">stap</code> utility to run SystemTap scripts.
5 </div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="using-setup"> 5 </div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="using-setup">
6 ⁠</a>2.1. Installation and Setup</h2></div></div></div><a id="idm46604934252832" class="indexterm"></a><a id="idm46604934256432" class="indexterm"></a><div class="para">To deploy SystemTap, install the SystemTap packages along 6 ⁠</a>2.1. Installation and Setup</h2></div></div></div><a id="idm46413318353568" class="indexterm"></a><a id="idm46413318357088" class="indexterm"></a><div class="para">To deploy SystemTap, install the SystemTap packages along
7 with the corresponding set of <span class="package">-devel</span>, 7 with the corresponding set of <span class="package">-devel</span>,
8 <span class="package">-debuginfo</span>, and <span class="package">-debuginfo-common</span> 8 <span class="package">-debuginfo</span>, and <span class="package">-debuginfo-common</span>
9 packages for your kernel. If your system has multiple kernels installed and 9 packages for your kernel. If your system has multiple kernels installed and
@@ -17,7 +17,7 @@
17 <span class="package">-debuginfo</span> package of the kernel, not the 17 <span class="package">-debuginfo</span> package of the kernel, not the
18 <span class="package">-debug</span> version of the kernel.</div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="installproper"> 18 <span class="package">-debug</span> version of the kernel.</div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="installproper">
19 ⁠</a>2.1.1. Installing SystemTap</h3></div></div></div><div class="para">To deploy SystemTap, install the following RPM packages: 19 ⁠</a>2.1.1. Installing SystemTap</h3></div></div></div><div class="para">To deploy SystemTap, install the following RPM packages:
20 </div><a id="idm46604934265264" class="indexterm"></a><a id="idm46604934267424" class="indexterm"></a><a id="idm46604934268848" class="indexterm"></a><a id="idm46604941377680" class="indexterm"></a><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para"><span class="package">systemtap</span></div></li><li class="listitem"><div class="para"><span class="package">systemtap-runtime</span></div></li></ul></div><div class="para"> 20 </div><a id="idm46413318365920" class="indexterm"></a><a id="idm46413318368080" class="indexterm"></a><a id="idm46413318369504" class="indexterm"></a><a id="idm46413318370368" class="indexterm"></a><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para"><span class="package">systemtap</span></div></li><li class="listitem"><div class="para"><span class="package">systemtap-runtime</span></div></li></ul></div><div class="para">
21 To do so, run the following command as root: 21 To do so, run the following command as root:
22 </div><pre class="screen"><code class="command">yum install systemtap systemtap-runtime</code></pre><div class="para"> 22 </div><pre class="screen"><code class="command">yum install systemtap systemtap-runtime</code></pre><div class="para">
23 Note that before using SystemTap, you still need to install the required 23 Note that before using SystemTap, you still need to install the required
@@ -26,7 +26,7 @@
26 </div><pre class="screen"><code class="command">stap-prep</code></pre><div class="para"> 26 </div><pre class="screen"><code class="command">stap-prep</code></pre><div class="para">
27 If this command does not work, try manual installation as described below. 27 If this command does not work, try manual installation as described below.
28 </div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="install-kinfo"> 28 </div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="install-kinfo">
29 ⁠</a>2.1.2. Installing Required Kernel Information Packages Manually</h3></div></div></div><a id="idm46604941385136" class="indexterm"></a><a id="idm46604941389600" class="indexterm"></a><a id="idm46604941386672" class="indexterm"></a><a id="idm46604941388320" class="indexterm"></a><a id="idm46604934724736" class="indexterm"></a><a id="idm46604941390592" class="indexterm"></a><div class="para"> 29 ⁠</a>2.1.2. Installing Required Kernel Information Packages Manually</h3></div></div></div><a id="idm46413318377744" class="indexterm"></a><a id="idm46413318382208" class="indexterm"></a><a id="idm46413318379280" class="indexterm"></a><a id="idm46413318380928" class="indexterm"></a><a id="idm46413318386048" class="indexterm"></a><a id="idm46413318383200" class="indexterm"></a><div class="para">
30 SystemTap needs information about the kernel in order to place instrumentation in it (in other words, probe it). This 30 SystemTap needs information about the kernel in order to place instrumentation in it (in other words, probe it). This
31 information also allows SystemTap to generate the code for the instrumentation. 31 information also allows SystemTap to generate the code for the instrumentation.
32 </div><div class="para"> 32 </div><div class="para">
@@ -38,7 +38,7 @@
38 Likewise, the necessary packages for the PAE kernel are 38 Likewise, the necessary packages for the PAE kernel are
39 <span class="package">kernel-PAE-debuginfo</span>, <span class="package">kernel-PAE-debuginfo-common</span>, 39 <span class="package">kernel-PAE-debuginfo</span>, <span class="package">kernel-PAE-debuginfo-common</span>,
40 and <span class="package">kernel-PAE-devel</span>. 40 and <span class="package">kernel-PAE-devel</span>.
41 </div><a id="idm46604934732112" class="indexterm"></a><a id="idm46604934732608" class="indexterm"></a><a id="idm46604938148288" class="indexterm"></a><a id="idm46604938149744" class="indexterm"></a><div class="para"> To determine what kernel your system is currently using, use:</div><pre class="screen">uname -r</pre><div class="para"> 41 </div><a id="idm46413327000144" class="indexterm"></a><a id="idm46413327000640" class="indexterm"></a><a id="idm46413327000944" class="indexterm"></a><a id="idm46413327002400" class="indexterm"></a><div class="para"> To determine what kernel your system is currently using, use:</div><pre class="screen">uname -r</pre><div class="para">
42 For example, if you intend to use SystemTap on kernel version <span class="emphasis"><em>2.6.18-53.el5</em></span> on an <span class="emphasis"><em>i686</em></span> machine, 42 For example, if you intend to use SystemTap on kernel version <span class="emphasis"><em>2.6.18-53.el5</em></span> on an <span class="emphasis"><em>i686</em></span> machine,
43 download and install the following RPM packages: 43 download and install the following RPM packages:
44 </div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para"><span class="package">kernel-debuginfo-2.6.18-53.1.13.el5.i686.rpm</span></div></li><li class="listitem"><div class="para"><span class="package">kernel-debuginfo-common-2.6.18-53.1.13.el5.i686.rpm</span></div></li><li class="listitem"><div class="para"><span class="package">kernel-devel-2.6.18-53.1.13.el5.i686.rpm</span></div></li></ul></div><div xmlns:d="http://docbook.org/ns/docbook" class="important"><div class="admonition_header"><p><strong>Important</strong></p></div><div class="admonition"><div class="para"> 44 </div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para"><span class="package">kernel-debuginfo-2.6.18-53.1.13.el5.i686.rpm</span></div></li><li class="listitem"><div class="para"><span class="package">kernel-debuginfo-common-2.6.18-53.1.13.el5.i686.rpm</span></div></li><li class="listitem"><div class="para"><span class="package">kernel-devel-2.6.18-53.1.13.el5.i686.rpm</span></div></li></ul></div><div xmlns:d="http://docbook.org/ns/docbook" class="important"><div class="admonition_header"><p><strong>Important</strong></p></div><div class="admonition"><div class="para">
@@ -73,7 +73,7 @@
73<code class="command">debuginfo-install kernel-PAE-2.6.18-53.1.13.el5</code></pre><div class="para"> 73<code class="command">debuginfo-install kernel-PAE-2.6.18-53.1.13.el5</code></pre><div class="para">
74Once you have manually downloaded the required packages to the machine, run the following command as root to install them: 74Once you have manually downloaded the required packages to the machine, run the following command as root to install them:
75 </div><pre class="screen"><code class="command">rpm --force -ivh <em class="replaceable">package_names</em></code></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="testing"> 75 </div><pre class="screen"><code class="command">rpm --force -ivh <em class="replaceable">package_names</em></code></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="testing">
76 ⁠</a>2.1.3. Initial Testing</h3></div></div></div><a id="idm46604933086832" class="indexterm"></a><a id="idm46604937584528" class="indexterm"></a><a id="idm46604942112288" class="indexterm"></a><div class="para">If you are currently using the kernel you intend to probe with 76 ⁠</a>2.1.3. Initial Testing</h3></div></div></div><a id="idm46413324703104" class="indexterm"></a><a id="idm46413323362496" class="indexterm"></a><a id="idm46413323363024" class="indexterm"></a><div class="para">If you are currently using the kernel you intend to probe with
77 SystemTap, you can immediately test whether the deployment was 77 SystemTap, you can immediately test whether the deployment was
78 successful. If not, you restart the system and load the appropriate 78 successful. If not, you restart the system and load the appropriate
79 kernel. 79 kernel.