<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
- <title>Linux Trace Toolkit Quickstart</title>
+ <title>Linux Trace Toolkit Next Generation User Documentation</title>
</head>
<body>
-<h1>Linux Trace Toolkit Quickstart</h1>
+<h1>Linux Trace Toolkit Next Generation User Documentation</h1>
Author : Mathieu Desnoyers, September 2005<br>
Last update : January 21st, 2009<br>
+(originally known as the LTTng QUICKSTART guide)
<h2>Table of Contents</h2>
<ul>
briefly how to add a new trace point to the kernel and to user space
applications. The fourth and last part explains how to create Debian or RPM
packages from the LTTng and LTTV sources.
-
<p>
These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X
kernel. You will also find instructions for installation of LTTV 0.12.x : the
<hr />
-<h2><a href="#TOCsection2" name="section2">Installation from sources</a></h2>
+<h2><a href="#TOCsection1" name="section1">Installation from sources</a></h2>
<p>
<li>Prerequisites</li>
./configure
make
make install
-
-
-<li>Getting and installing the markers-userspace package for user space
-tracing (experimental)</li>
-
-See <a
-href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
+</PRE>
<hr />
-<h2><a href="#TOCsection3" name="section3">Using LTTng and LTTV</a></h2>
+<h2><a href="#TOCsection2" name="section2">Using LTTng and LTTV</a></h2>
<li>IMPORTANT : Arm Linux Kernel Markers after each boot</li>
-
<PRE>
ltt-armall
</PRE>
<li>Use graphical LTTV to control tracing and analyse traces</li>
-
<PRE>
lttv-gui (or /usr/local/bin/lttv-gui)
- Spot the "Tracing Control" icon : click on it
lttctl -D trace1
see lttctl --help for details.
-<PRE>
+</PRE>
<p>
(note : to see if the buffers has been filled, look at the dmesg output after
lttctl -R or after stopping tracing from the GUI, it will show an event lost
graphical plugins available.
<p>
For example, a simple trace dump in text format is available with :
-
<PRE>
lttv -m textDump -t /tmp/trace
</PRE>
-
<p>
See lttv -m textDump --help for detailed command line options of textDump.
-
<p>
It is, in the current state of the project, very useful to use "grep" on the
text output to filter by specific event fields. You can later copy the timestamp
be added to the filter module soon.
<li>Hybrid mode</li>
-
<p>
Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used :
hybrid. It can be especially useful when studying big workloads on a long period
of time.
-
<p>
When using this mode, the most important, low rate control information will be
recorded during all the trace by lttd (i.e. process creation/exit). The high
rate information (i.e. interrupt/traps/syscall entry/exit) will be kept in a
flight recorder buffer (now named flight-channelname_X).
-
<p>
The following lttctl commands take an hybrid trace :
<p>
Each "overwrite" channel is flight recorder channel.
<li>Flight recorder mode</li>
-
<p>
The flight recorder mode writes data into overwritten buffers for all channels,
including control channels, except for the facilities tracefiles. It consists of
setting all channels to "overwrite".
-
<p>
The following lttctl commands take a flight recorder trace :
-
<PRE>
lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3
...
lttctl -D -w /tmp/trace3 trace3
</PRE>
-**************************************************************
-** Section 4 * Adding new instrumentations with the markers **
-**************************************************************
+<hr />
+
+
+<h2><a href="#TOCsection3" name="section3">Adding new instrumentations with the
+markers</a></h2>
+<p>
+<p>
See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel
tree.
-* Add new events to userspace programs with userspace markers
-http://ltt.polymtl.ca/packages/
+<li>Add new events to userspace programs with
+<a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a></li>
+<p>
Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It
allows inserting markers in executables and libraries, currently only on x86_32
and x86_64.
-***********************************************************
-** Section 5 * Creating Debian or RPM packages **
-***********************************************************
+See <a
+href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
-* Create custom LTTV Debian packages
+Note that a new design document for a 3rd generation of tracepoint/marker-based
+userspace tracing is available at <a
+href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/ust.html">LTTng User-space Tracing
+Design"</a>.
-Use : dpkg-buildpackage -rfakeroot
+<hr />
-You should then have your LTTV .deb files created for your architecture.
+<h2><a href="#TOCsection4" name="section4">Creating Debian or RPM packages</a></h2>
+<p>
-* Create custom LTTng packages
+<li>Create custom LTTV Debian packages</li>
-For building LTTng Debian packages :
+<PRE>
+Use : dpkg-buildpackage -rfakeroot
+</PRE>
+<p>
+You should then have your LTTV .deb files created for your architecture.
-Get the build tree with patches applies as explained in section 2.
+<li>Create custom LTTng packages</li>
+<p>
+For building LTTng Debian packages :
+get the build tree with patches applies as explained in section 2.
+<PRE>
make menuconfig (or xconfig or config) (customize your configuration)
make-kpkg kernel_image
-
+</PRE>
+<p>
You will then see your freshly created .deb in /usr/src. Install it with
+<PRE>
dpkg -i /usr/src/(image-name).deb
-
+</PRE>
+<p>
Then, follow the section "Editing the system wide configuration" in section 2.
projects / lttv.git / blobdiff