[lttv.git] / trunk / lttv / QUICKSTART.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>Linux Trace Toolkit Quickstart</title>
</head>
  <body>

<h1>Linux Trace Toolkit Quickstart</h1>

Author : Mathieu Desnoyers, September 2005<br>
Last update : January 21st, 2009<br>

<h2>Table of Contents</h2>
<ul>

<li><a href="#intro" name="TOCintro">Introduction</a></li>
<li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from
sources</a></li>
<li><a href="#section2" name="TOCsection2">Using LTTng and LTTV</a></li>
<li><a href="#section3" name="TOCsection3">Adding kernel and user-space
tracepoints</a></li>
<li><a href="#section4" name="TOCsection4">Creating Debian and RPM packages
from LTTV</a>

</ul>

<hr />

<h2><a href="#TOCintro" name="intro">Introduction</a></h2>
<p>
This document is made of four parts : the first one explains how
to install LTTng and LTTV from sources, the second one describes the steps
to follow to trace a system and view it. The third part explains
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
Linux Trace Toolkit Viewer. 
To see the list of compatibilities between LTTng, ltt-control, LTTV, please
refer to :
<a
href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV versions compatibility</a>
The lttng patch is necessary to have the tracing hooks in the kernel.

<br>
<br>
Supported architectures : 
<br>
LTTng :<br>
<li> x86 32/64 bits
<li> PowerPC 32 and 64 bits
<li> ARM (with limited timestamping precision, e.g. 1HZ. Need
architecture-specific support for better precision)
<li> MIPS
<br>
<br>
LTTV :<br>
<li> Intel 32/64 bits
<li> PowerPC 32 and 64 bits
<li> Possibly others. Takes care of endianness and type size difference between
the LTTng traces and the LTTV analysis tool.

<hr />


<h2><a href="#TOCsection2" name="section2">Installation from sources</a></h2>
<p>

<li>Prerequisites</li>
<ul>
<p>
Tools needed to follow the package download steps :

<li>wget
<li>bzip2
<li>gzip
<li>tar

<p>
You have to install the standard development libraries and programs necessary
to compile a kernel :

<PRE>
(from Documentation/Changes in the Linux kernel tree)
Gnu C                2.95.3                # gcc --version
Gnu make             3.79.1                # make --version
binutils             2.12                  # ld -v
util-linux           2.10o                 # fdformat --version
module-init-tools    0.9.10                # depmod -V
</PRE>

<p>
You might also want to have libncurses5 to have the text mode kernel
configuration menu, but there are alternatives.

<p>
Prerequisites for LTTV 0.x.x installation are :

<PRE>
gcc 3.2 or better
gtk 2.4 or better development libraries
  (Debian : libgtk2.0, libgtk2.0-dev)
  (Fedora : gtk2, gtk2-devel)
  note : For Fedora users : this might require at least core 3 from Fedora,
  or you might have to compile your own GTK2 library.
glib 2.4 or better development libraries
  (Debian : libglib2.0-0, libglib2.0-dev)
  (Fedora : glib2, glib2-devel)
libpopt development libraries
  (Debian : libpopt0, libpopt-dev)
  (Fedora : popt)
libpango development libraries
  (Debian : libpango1.0, libpango1.0-dev)
  (Fedora : pango, pango-devel)
libc6 development librairies 
  (Debian : libc6, libc6-dev)
  (Fedora : glibc, glibc)
</PRE>
</ul>

<li>Reminder</li>

<p>
See the list of compatibilities between LTTng, ltt-control and LTTV at :
<a
href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV
versions compatibility</a>.


<li>Getting the LTTng packages</li>

<PRE>
su -
mkdir /usr/src/lttng
cd /usr/src/lttng
(see http://ltt.polymtl.ca/lttng for package listing)
wget http://ltt.polymtl.ca/lttng/patch-2.6.X-lttng-0.x.xx.tar.bz2
bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 | tar xvof -
</PRE>


<li>Getting LTTng kernel sources</li>

<PRE>
su -
cd /usr/src
wget http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.X.tar.bz2
bzip2 -cd linux-2.6.X.tar.bz2 | tar xvof -
cd linux-2.6.X
- For LTTng 0.9.4- cat /usr/src/lttng/patch*-2.6.X-lttng-0.x.xx* | patch -p1
- For LTTng 0.9.5+ apply the patches in the order specified in the series file,
  or use quilt
cd ..
mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
</PRE>


<li>Installing a LTTng kernel</li>

<PRE>
su -
cd /usr/src/linux-2.6.X-lttng-0.x.xx
make menuconfig (or make xconfig or make config)
    Select the < Help > button if you are not familiar with kernel
    configuration.
    Items preceded by [*] means they has to be built into the kernel.
    Items preceded by [M] means they has to be built as modules.
    Items preceded by [ ] means they should be removed.
  go to the "General setup" section
    Select the following options :
    [*] Prompt for development and/or incomplete code/drivers
    [*] Activate markers
    [*] Activate userspace markers ABI (experimental, optional)
    [*] Immediate value optimization (optional)
    [*] Linux Trace Toolkit Next Generation (LTTng) --->
    <M> or <*> Compile lttng tracing probes
    <M> or <*> Linux Trace Toolkit High-speed Lockless Data Relay
    <M> or <*> Linux Trace Toolkit Lock-Protected Data Relay
    <M> or <*> Linux Trace Toolkit Serializer
    <M> or <*>   Linux Trace Toolkit Marker Control
    <M> or <*>     Linux Trace Toolkit Tracer
    [*] Align Linux Trace Toolkit Traces
    <M> or <*> Support logging events from userspace
    [*] Support trace extraction from crash dump
    <M> or <*> Linux Trace Toolkit Trace Controller
    <M> or <*> Linux Trace Toolkit State Dump
  Select <Exit>
  Select <Exit>
  Select <Yes>
make
make modules_install
(if necessary, create a initrd with mkinitrd or your preferate alternative)
(mkinitrd -o /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx)

-- on X86, X86_64
make install
reboot
Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.

-- on PowerPC
cp vmlinux.strip /boot/vmlinux-2.6.X-lttng-0.x.xx
cp System.map /boot/System.map-2.6.X-lttng-0.x.xx
cp .config /boot/config-2.6.X-lttng-0.x.xx
depmod -ae -F /boot/System.map-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx
mkinitrd /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx
(edit /etc/yaboot.conf to add a new entry pointing to your kernel : the entry
that comes first is the default kernel)
ybin
select the right entry at the yaboot prompt (see choices : tab, select : type
the kernel name followed by enter)
Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.
--
</PRE>

<li>Editing the system wide configuration</li>

<p>
You must activate debugfs and specify a mount point. This is typically done in
fstab such that it happens at boot time.  If you have never used DebugFS before,
these operation would do this for you :

<PRE>
mkdir /mnt/debugfs
cp /etc/fstab /etc/fstab.lttng.bkp
echo "debugfs         /mnt/debugfs    debugfs rw              0       0"  >> /etc/fstab
</PRE>

<p>
then, rebooting or issuing the following command will activate debugfs :
<PRE>
mount /mnt/debugfs
</PRE>

<p>
You need to load the LTT modules to be able to control tracing from user
space. This is done by issuing the following commands. Note however
these commands load all LTT modules. Depending on what options you chose to
compile statically, you may not need to issue all these commands. 

<PRE>
modprobe ltt-trace-control
modprobe ltt-marker-control
modprobe ltt-tracer
modprobe ltt-serialize
modprobe ltt-relay
modprobe ipc-trace
modprobe kernel-trace
modprobe mm-trace
modprobe net-trace
modprobe fs-trace
modprobe jbd2-trace
modprobe ext4-trace
modprobe syscall-trace
modprobe trap-trace
#if locking tracing is wanted, uncomment the following
#modprobe lockdep-trace
</PRE>

<p>
If you want to have complete information about the kernel state (including all
the process names), you need to load the ltt-statedump module. This is done by
issuing the command :

<PRE>
modprobe ltt-statedump
</PRE>
<p>
You can automate at boot time loading the ltt-control module by :

<PRE>
cp /etc/modules /etc/modules.bkp
echo ltt-trace-control >> /etc/modules
echo ltt-marker-control >> /etc/modules
echo ltt-tracer >> /etc/modules
echo ltt-serialize >> /etc/modules
echo ltt-relay >> /etc/modules
echo ipc-trace >> /etc/modules
echo kernel-trace >> /etc/modules
echo mm-trace >> /etc/modules
echo net-trace >> /etc/modules
echo fs-trace >> /etc/modules
echo jbd2-trace >> /etc/modules
echo ext4-trace >> /etc/modules
echo syscall-trace >> /etc/modules
echo trap-trace >> /etc/modules
#if locking tracing is wanted, uncomment the following
#echo lockdep-trace >> /etc/modules
</PRE>

<li>Getting and installing the ltt-control package (on the traced machine)</li>
<p>
(note : the ltt-control package contains lttd and lttctl. Although it has the
same name as the ltt-control kernel module, they are *not* the same thing.)

<PRE>
su -
cd /usr/src
wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz
gzip -cd ltt-control-0.x-xxxx2008.tar.gz | tar xvof -
cd ltt-control-0.x-xxxx2006
(refer to README to see the development libraries that must be installed on you
system)
./configure
make
make install
</PRE>

<li>Userspace tracing</li>

<PRE>
Make sure you selected the kernel menuconfig option :
    <M> or <*> Support logging events from userspace
And that the ltt-userspace-event kernel module is loaded if selected as a
module.

Simple userspace tracing is available through
echo "some text to record" > /mnt/debugfs/ltt/write_event

It will appear in the trace under event :
channel : userspace
event name : event
</PRE>

<li>Getting and installing the LTTV package (on the visualisation machine, same
or different from the visualisation machine)</li>

<PRE>
su -
cd /usr/src
wget http://ltt.polymtl.ca/packages/lttv-0.x.xx-xxxx2008.tar.gz
gzip -cd lttv-0.x.xx-xxxx2008.tar.gz | tar xvof -
cd lttv-0.x.xx-xxxx2008
(refer to README to see the development libraries that must be installed on your
system)
./configure
make
make install


<li>Getting and installing the markers-userspace package for user space
tracing (experimental)</li>
<p>
See <a
href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.

<hr />


<h2><a href="#TOCsection3" name="section3">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
      (it's a traffic light icon)
    - enter the root password
    - click "start"
    - click "stop"
    - Yes
      * You should now see a trace
</PRE>

<li>Use text mode LTTng to control tracing</li>
<PRE>
The tracing can be controlled from a terminal by using the lttctl command (as
root).

Start tracing :

lttctl -C -w /tmp/trace1 trace1

Stop tracing and destroy trace channels :

lttctl -D trace1

see lttctl --help for details.
<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
count. If it is the case, try using larger buffers. See lttctl --help to learn 
how. lttv now also shows event lost messages in the console when loading a trace
with missing events or lost subbuffers.)

<li>Use text mode LTTV</li>
<p>
Feel free to look in /usr/local/lib/lttv/plugins to see all the text and
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
of the events to the clipboard and paste them in the GUI by clicking on the
bottom right label "Current time". Support for this type of filtering should
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>
Create trace channel, start lttd on normal channels, start tracing:
<PRE>
lttctl -C -w /tmp/trace2 -o channel.kernel.overwrite=1 trace2
</PRE>
<p>
Stop tracing, start lttd on flight recorder channels, destroy trace channels :
<PRE>
lttctl -D -w /tmp/trace2 trace2
</PRE>
<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 **
**************************************************************

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/

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           **
***********************************************************

* Create custom LTTV Debian packages

Use : dpkg-buildpackage -rfakeroot

You should then have your LTTV .deb files created for your architecture.

* Create custom LTTng packages

For building LTTng Debian packages :

Get the build tree with patches applies as explained in section 2.

make menuconfig (or xconfig or config) (customize your configuration)
make-kpkg kernel_image

You will then see your freshly created .deb in /usr/src. Install it with
dpkg -i /usr/src/(image-name).deb

Then, follow the section "Editing the system wide configuration" in section 2.


  </body>
</html>
Commit	Line	Data
c924c2c6	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
	2	<html>
	3	<head>
	4	<title>Linux Trace Toolkit Quickstart</title>
	5	</head>
	6	<body>
	7
	8	<h1>Linux Trace Toolkit Quickstart</h1>
	9
c924c2c6	10	Author : Mathieu Desnoyers, September 2005<br>
24070967	11	Last update : January 21st, 2009<br>
	12
	13	<h2>Table of Contents</h2>
	14	<ul>
	15
f9ff56f3	16	<li><a href="#intro" name="TOCintro">Introduction</a></li>
24070967	17	<li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from
	18	sources</a></li>
	19	<li><a href="#section2" name="TOCsection2">Using LTTng and LTTV</a></li>
	20	<li><a href="#section3" name="TOCsection3">Adding kernel and user-space
	21	tracepoints</a></li>
633bc4a3	22	<li><a href="#section4" name="TOCsection4">Creating Debian and RPM packages
633bc4a3	23	from LTTV</a>
c924c2c6	24
f9ff56f3	25	</ul>
	26
	27	<hr />
	28
b9e1fab1	29	<h2><a href="#TOCintro" name="intro">Introduction</a></h2>
c924c2c6	30	<p>
633bc4a3	31	This document is made of four parts : the first one explains how
24070967	32	to install LTTng and LTTV from sources, the second one describes the steps
633bc4a3	33	to follow to trace a system and view it. The third part explains
c924c2c6	34	briefly how to add a new trace point to the kernel and to user space
633bc4a3	35	applications. The fourth and last part explains how to create Debian or RPM
633bc4a3	36	packages from the LTTng and LTTV sources.
c924c2c6	37	<p>
24070967	38	These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X
c924c2c6	39	kernel. You will also find instructions for installation of LTTV 0.12.x : the
c924c2c6	40	Linux Trace Toolkit Viewer.
24070967	41	To see the list of compatibilities between LTTng, ltt-control, LTTV, please
24070967	42	refer to :
c924c2c6	43	<a
c924c2c6	44	href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV versions compatibility</a>
24070967	45	The lttng patch is necessary to have the tracing hooks in the kernel.
c924c2c6	46
24070967	47	<br>
24070967	48	<br>
633bc4a3	49	Supported architectures :
24070967	50	<br>
c924c2c6	51	LTTng :<br>
c924c2c6	52	<li> x86 32/64 bits
	53	<li> PowerPC 32 and 64 bits
	54	<li> ARM (with limited timestamping precision, e.g. 1HZ. Need
	55	architecture-specific support for better precision)
	56	<li> MIPS
	57	<br>
24070967	58	<br>
c924c2c6	59	LTTV :<br>
c924c2c6	60	<li> Intel 32/64 bits
	61	<li> PowerPC 32 and 64 bits
	62	<li> Possibly others. Takes care of endianness and type size difference between
	63	the LTTng traces and the LTTV analysis tool.
	64
f9ff56f3	65	<hr />
f9ff56f3	66
c924c2c6	67
633bc4a3	68	<h2><a href="#TOCsection2" name="section2">Installation from sources</a></h2>
633bc4a3	69	<p>
c924c2c6	70
633bc4a3	71	<li>Prerequisites</li>
	72	<ul>
	73	<p>
c924c2c6	74	Tools needed to follow the package download steps :
c924c2c6	75
633bc4a3	76	<li>wget
	77	<li>bzip2
	78	<li>gzip
	79	<li>tar
c924c2c6	80
633bc4a3	81	<p>
c924c2c6	82	You have to install the standard development libraries and programs necessary
	83	to compile a kernel :
	84
84cf5903	85	<PRE>
c924c2c6	86	(from Documentation/Changes in the Linux kernel tree)
84cf5903	87	Gnu C 2.95.3 # gcc --version
	88	Gnu make 3.79.1 # make --version
	89	binutils 2.12 # ld -v
	90	util-linux 2.10o # fdformat --version
	91	module-init-tools 0.9.10 # depmod -V
	92	</PRE>
c924c2c6	93
633bc4a3	94	<p>
c924c2c6	95	You might also want to have libncurses5 to have the text mode kernel
	96	configuration menu, but there are alternatives.
	97
633bc4a3	98	<p>
c924c2c6	99	Prerequisites for LTTV 0.x.x installation are :
c924c2c6	100
84cf5903	101	<PRE>
	102	gcc 3.2 or better
	103	gtk 2.4 or better development libraries
c924c2c6	104	(Debian : libgtk2.0, libgtk2.0-dev)
	105	(Fedora : gtk2, gtk2-devel)
	106	note : For Fedora users : this might require at least core 3 from Fedora,
	107	or you might have to compile your own GTK2 library.
84cf5903	108	glib 2.4 or better development libraries
c924c2c6	109	(Debian : libglib2.0-0, libglib2.0-dev)
c924c2c6	110	(Fedora : glib2, glib2-devel)
84cf5903	111	libpopt development libraries
c924c2c6	112	(Debian : libpopt0, libpopt-dev)
c924c2c6	113	(Fedora : popt)
84cf5903	114	libpango development libraries
c924c2c6	115	(Debian : libpango1.0, libpango1.0-dev)
c924c2c6	116	(Fedora : pango, pango-devel)
84cf5903	117	libc6 development librairies
c924c2c6	118	(Debian : libc6, libc6-dev)
c924c2c6	119	(Fedora : glibc, glibc)
84cf5903	120	</PRE>
633bc4a3	121	</ul>
c924c2c6	122
c8997124	123	<li>Reminder</li>
c924c2c6	124
c8997124	125	<p>
633bc4a3	126	See the list of compatibilities between LTTng, ltt-control and LTTV at :
	127	<a
	128	href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV
	129	versions compatibility</a>.
c924c2c6	130
c924c2c6	131
c8997124	132	<li>Getting the LTTng packages</li>
c924c2c6	133
c8997124	134	<PRE>
c924c2c6	135	su -
	136	mkdir /usr/src/lttng
	137	cd /usr/src/lttng
	138	(see http://ltt.polymtl.ca/lttng for package listing)
	139	wget http://ltt.polymtl.ca/lttng/patch-2.6.X-lttng-0.x.xx.tar.bz2
	140	bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 \| tar xvof -
c8997124	141	</PRE>
c924c2c6	142
c924c2c6	143
c8997124	144	<li>Getting LTTng kernel sources</li>
c924c2c6	145
c8997124	146	<PRE>
c924c2c6	147	su -
	148	cd /usr/src
	149	wget http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.X.tar.bz2
	150	bzip2 -cd linux-2.6.X.tar.bz2 \| tar xvof -
	151	cd linux-2.6.X
	152	- For LTTng 0.9.4- cat /usr/src/lttng/patch-2.6.X-lttng-0.x.xx \| patch -p1
	153	- For LTTng 0.9.5+ apply the patches in the order specified in the series file,
	154	or use quilt
	155	cd ..
	156	mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
c8997124	157	</PRE>
c924c2c6	158
c924c2c6	159
c8997124	160	<li>Installing a LTTng kernel</li>
c924c2c6	161
c8997124	162	<PRE>
c924c2c6	163	su -
	164	cd /usr/src/linux-2.6.X-lttng-0.x.xx
	165	make menuconfig (or make xconfig or make config)
	166	Select the < Help > button if you are not familiar with kernel
	167	configuration.
	168	Items preceded by [*] means they has to be built into the kernel.
	169	Items preceded by [M] means they has to be built as modules.
	170	Items preceded by [ ] means they should be removed.
	171	go to the "General setup" section
	172	Select the following options :
	173	[*] Prompt for development and/or incomplete code/drivers
	174	[*] Activate markers
	175	[*] Activate userspace markers ABI (experimental, optional)
	176	[*] Immediate value optimization (optional)
	177	[*] Linux Trace Toolkit Next Generation (LTTng) --->
	178	<M> or <*> Compile lttng tracing probes
	179	<M> or <*> Linux Trace Toolkit High-speed Lockless Data Relay
	180	<M> or <*> Linux Trace Toolkit Lock-Protected Data Relay
	181	<M> or <*> Linux Trace Toolkit Serializer
	182	<M> or <*> Linux Trace Toolkit Marker Control
	183	<M> or <*> Linux Trace Toolkit Tracer
	184	[*] Align Linux Trace Toolkit Traces
	185	<M> or <*> Support logging events from userspace
	186	[*] Support trace extraction from crash dump
	187	<M> or <*> Linux Trace Toolkit Trace Controller
	188	<M> or <*> Linux Trace Toolkit State Dump
	189	Select <Exit>
	190	Select <Exit>
	191	Select <Yes>
	192	make
	193	make modules_install
	194	(if necessary, create a initrd with mkinitrd or your preferate alternative)
	195	(mkinitrd -o /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx)
	196
	197	-- on X86, X86_64
	198	make install
	199	reboot
	200	Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.
	201
	202	-- on PowerPC
	203	cp vmlinux.strip /boot/vmlinux-2.6.X-lttng-0.x.xx
	204	cp System.map /boot/System.map-2.6.X-lttng-0.x.xx
	205	cp .config /boot/config-2.6.X-lttng-0.x.xx
	206	depmod -ae -F /boot/System.map-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx
	207	mkinitrd /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx
	208	(edit /etc/yaboot.conf to add a new entry pointing to your kernel : the entry
	209	that comes first is the default kernel)
	210	ybin
	211	select the right entry at the yaboot prompt (see choices : tab, select : type
	212	the kernel name followed by enter)
	213	Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.
	214	--
c8997124	215	</PRE>
c924c2c6	216
c8997124	217	<li>Editing the system wide configuration</li>
c924c2c6	218
c8997124	219	<p>
c924c2c6	220	You must activate debugfs and specify a mount point. This is typically done in
c8997124	221	fstab such that it happens at boot time. If you have never used DebugFS before,
c8997124	222	these operation would do this for you :
c924c2c6	223
c8997124	224	<PRE>
c924c2c6	225	mkdir /mnt/debugfs
	226	cp /etc/fstab /etc/fstab.lttng.bkp
	227	echo "debugfs /mnt/debugfs debugfs rw 0 0" >> /etc/fstab
c8997124	228	</PRE>
c924c2c6	229
c8997124	230	<p>
c924c2c6	231	then, rebooting or issuing the following command will activate debugfs :
c8997124	232	<PRE>
c924c2c6	233	mount /mnt/debugfs
c8997124	234	</PRE>
c924c2c6	235
c8997124	236	<p>
c924c2c6	237	You need to load the LTT modules to be able to control tracing from user
	238	space. This is done by issuing the following commands. Note however
	239	these commands load all LTT modules. Depending on what options you chose to
	240	compile statically, you may not need to issue all these commands.
	241
c8997124	242	<PRE>
c924c2c6	243	modprobe ltt-trace-control
	244	modprobe ltt-marker-control
	245	modprobe ltt-tracer
	246	modprobe ltt-serialize
	247	modprobe ltt-relay
	248	modprobe ipc-trace
	249	modprobe kernel-trace
	250	modprobe mm-trace
	251	modprobe net-trace
	252	modprobe fs-trace
	253	modprobe jbd2-trace
	254	modprobe ext4-trace
	255	modprobe syscall-trace
	256	modprobe trap-trace
	257	#if locking tracing is wanted, uncomment the following
	258	#modprobe lockdep-trace
c8997124	259	</PRE>
c924c2c6	260
c8997124	261	<p>
c924c2c6	262	If you want to have complete information about the kernel state (including all
	263	the process names), you need to load the ltt-statedump module. This is done by
	264	issuing the command :
	265
c8997124	266	<PRE>
c924c2c6	267	modprobe ltt-statedump
c8997124	268	</PRE>
c8997124	269	<p>
c924c2c6	270	You can automate at boot time loading the ltt-control module by :
c924c2c6	271
c8997124	272	<PRE>
c924c2c6	273	cp /etc/modules /etc/modules.bkp
	274	echo ltt-trace-control >> /etc/modules
	275	echo ltt-marker-control >> /etc/modules
	276	echo ltt-tracer >> /etc/modules
	277	echo ltt-serialize >> /etc/modules
	278	echo ltt-relay >> /etc/modules
	279	echo ipc-trace >> /etc/modules
	280	echo kernel-trace >> /etc/modules
	281	echo mm-trace >> /etc/modules
	282	echo net-trace >> /etc/modules
	283	echo fs-trace >> /etc/modules
	284	echo jbd2-trace >> /etc/modules
	285	echo ext4-trace >> /etc/modules
	286	echo syscall-trace >> /etc/modules
	287	echo trap-trace >> /etc/modules
	288	#if locking tracing is wanted, uncomment the following
	289	#echo lockdep-trace >> /etc/modules
c8997124	290	</PRE>
c924c2c6	291
c8997124	292	<li>Getting and installing the ltt-control package (on the traced machine)</li>
c8997124	293	<p>
c924c2c6	294	(note : the ltt-control package contains lttd and lttctl. Although it has the
c924c2c6	295	same name as the ltt-control kernel module, they are not the same thing.)
c8997124	296
c8997124	297	<PRE>
c924c2c6	298	su -
	299	cd /usr/src
	300	wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz
	301	gzip -cd ltt-control-0.x-xxxx2008.tar.gz \| tar xvof -
	302	cd ltt-control-0.x-xxxx2006
	303	(refer to README to see the development libraries that must be installed on you
	304	system)
	305	./configure
	306	make
	307	make install
c8997124	308	</PRE>
c924c2c6	309
c8997124	310	<li>Userspace tracing</li>
c924c2c6	311
c8997124	312	<PRE>
c924c2c6	313	Make sure you selected the kernel menuconfig option :
	314	<M> or <*> Support logging events from userspace
	315	And that the ltt-userspace-event kernel module is loaded if selected as a
	316	module.
	317
	318	Simple userspace tracing is available through
	319	echo "some text to record" > /mnt/debugfs/ltt/write_event
	320
	321	It will appear in the trace under event :
	322	channel : userspace
	323	event name : event
c8997124	324	</PRE>
c924c2c6	325
c8997124	326	<li>Getting and installing the LTTV package (on the visualisation machine, same
c8997124	327	or different from the visualisation machine)</li>
c924c2c6	328
c8997124	329	<PRE>
c924c2c6	330	su -
	331	cd /usr/src
	332	wget http://ltt.polymtl.ca/packages/lttv-0.x.xx-xxxx2008.tar.gz
	333	gzip -cd lttv-0.x.xx-xxxx2008.tar.gz \| tar xvof -
	334	cd lttv-0.x.xx-xxxx2008
	335	(refer to README to see the development libraries that must be installed on your
	336	system)
	337	./configure
	338	make
	339	make install
	340
	341
c8997124	342	<li>Getting and installing the markers-userspace package for user space
c8997124	343	tracing (experimental)</li>
3fafc0cd	344	<p>
c8997124	345	See <a
c8997124	346	href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
c924c2c6	347
c8997124	348	<hr />
c924c2c6	349
c924c2c6	350
c8997124	351	<h2><a href="#TOCsection3" name="section3">Using LTTng and LTTV</a></h2>
c924c2c6	352
c8997124	353	<li>IMPORTANT : Arm Linux Kernel Markers after each boot</li>
c8997124	354	<PRE>
c924c2c6	355	ltt-armall
c8997124	356	</PRE>
c924c2c6	357
c8997124	358	<li>Use graphical LTTV to control tracing and analyse traces</li>
c8997124	359	<PRE>
c924c2c6	360	lttv-gui (or /usr/local/bin/lttv-gui)
	361	- Spot the "Tracing Control" icon : click on it
	362	(it's a traffic light icon)
	363	- enter the root password
	364	- click "start"
	365	- click "stop"
	366	- Yes
	367	* You should now see a trace
c8997124	368	</PRE>
c924c2c6	369
c8997124	370	<li>Use text mode LTTng to control tracing</li>
c8997124	371	<PRE>
c924c2c6	372	The tracing can be controlled from a terminal by using the lttctl command (as
	373	root).
	374
	375	Start tracing :
	376
	377	lttctl -C -w /tmp/trace1 trace1
	378
	379	Stop tracing and destroy trace channels :
	380
	381	lttctl -D trace1
	382
	383	see lttctl --help for details.
c8997124	384	<PRE>
c8997124	385	<p>
c924c2c6	386	(note : to see if the buffers has been filled, look at the dmesg output after
	387	lttctl -R or after stopping tracing from the GUI, it will show an event lost
	388	count. If it is the case, try using larger buffers. See lttctl --help to learn
	389	how. lttv now also shows event lost messages in the console when loading a trace
	390	with missing events or lost subbuffers.)
	391
c8997124	392	<li>Use text mode LTTV</li>
c8997124	393	<p>
c924c2c6	394	Feel free to look in /usr/local/lib/lttv/plugins to see all the text and
c924c2c6	395	graphical plugins available.
c8997124	396	<p>
c924c2c6	397	For example, a simple trace dump in text format is available with :
c8997124	398	<PRE>
c924c2c6	399	lttv -m textDump -t /tmp/trace
c8997124	400	</PRE>
c8997124	401	<p>
c8997124	402	See lttv -m textDump --help for detailed command line options of textDump.
c8997124	403	<p>
c924c2c6	404	It is, in the current state of the project, very useful to use "grep" on the
	405	text output to filter by specific event fields. You can later copy the timestamp
	406	of the events to the clipboard and paste them in the GUI by clicking on the
	407	bottom right label "Current time". Support for this type of filtering should
	408	be added to the filter module soon.
	409
c8997124	410	<li>Hybrid mode</li>
c8997124	411	<p>
c924c2c6	412	Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used :
	413	hybrid. It can be especially useful when studying big workloads on a long period
	414	of time.
c8997124	415	<p>
c924c2c6	416	When using this mode, the most important, low rate control information will be
	417	recorded during all the trace by lttd (i.e. process creation/exit). The high
	418	rate information (i.e. interrupt/traps/syscall entry/exit) will be kept in a
	419	flight recorder buffer (now named flight-channelname_X).
c8997124	420	<p>
c924c2c6	421	The following lttctl commands take an hybrid trace :
c8997124	422	<p>
c924c2c6	423	Create trace channel, start lttd on normal channels, start tracing:
c8997124	424	<PRE>
c924c2c6	425	lttctl -C -w /tmp/trace2 -o channel.kernel.overwrite=1 trace2
c8997124	426	</PRE>
c8997124	427	<p>
c924c2c6	428	Stop tracing, start lttd on flight recorder channels, destroy trace channels :
c8997124	429	<PRE>
c924c2c6	430	lttctl -D -w /tmp/trace2 trace2
c8997124	431	</PRE>
c8997124	432	<p>
c924c2c6	433	Each "overwrite" channel is flight recorder channel.
c924c2c6	434
c8997124	435	<li>Flight recorder mode</li>
c8997124	436	<p>
c924c2c6	437	The flight recorder mode writes data into overwritten buffers for all channels,
	438	including control channels, except for the facilities tracefiles. It consists of
	439	setting all channels to "overwrite".
c8997124	440	<p>
c924c2c6	441	The following lttctl commands take a flight recorder trace :
c8997124	442	<PRE>
c924c2c6	443	lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3
	444	...
	445	lttctl -D -w /tmp/trace3 trace3
c8997124	446	</PRE>
c924c2c6	447
	448	**************************************************************
	449	** Section 4 * Adding new instrumentations with the markers **
	450	**************************************************************
	451
	452	See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel
	453	tree.
	454
	455	* Add new events to userspace programs with userspace markers
	456	http://ltt.polymtl.ca/packages/
	457
	458	Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It
	459	allows inserting markers in executables and libraries, currently only on x86_32
	460	and x86_64.
	461
633bc4a3	462	***********************************************************
	463	** Section 5 * Creating Debian or RPM packages **
	464	***********************************************************
	465
	466	* Create custom LTTV Debian packages
	467
	468	Use : dpkg-buildpackage -rfakeroot
	469
	470	You should then have your LTTV .deb files created for your architecture.
	471
	472	* Create custom LTTng packages
	473
	474	For building LTTng Debian packages :
	475
	476	Get the build tree with patches applies as explained in section 2.
	477
	478	make menuconfig (or xconfig or config) (customize your configuration)
	479	make-kpkg kernel_image
	480
	481	You will then see your freshly created .deb in /usr/src. Install it with
	482	dpkg -i /usr/src/(image-name).deb
	483
	484	Then, follow the section "Editing the system wide configuration" in section 2.
	485
	486
	487
c924c2c6	488	</body>
c924c2c6	489	</html>