LTTng and LTTV from Debian and RPM binary packages, the second one explains how
to install LTTng and LTTV from sources and the third one describes the steps
to follow to trace a system and view it. The fourth and last part explains
-briefly how to add a new trace point to the kernel.
+briefly how to add a new trace point to the kernel and to user space
+applications.
-What you will typically want is to read sections 1 and 3 : install LTTng from
-binary packages and use it. If there are no packages ready for your system, you
-will have to install from sources (section 2) instead.
+What you will typically want is to read sections 2 and 3 : install LTTng from
+sources and use it.
+
+These operations are made for installing the LTTng 0.5.X tracer on a
+linux 2.6.X kernel. You will also find instructions for installation of
+LTTV 0.8.x : the Linux Trace Toolkit Viewer.
+
+To see the list of compatibilities between LTTng, ltt-control, LTTV, genevent
+and ltt-usertrace, please refer to :
+http://ltt.polymtl.ca > LTTng+LTTV versions compatibility
-These operations are made for installing the LTTng 0.4 tracer on a
-linux 2.6.12-rc4-mm2 kernel. You will also find instructions for installtion of
-LTTV 0.6.x : the Linux Trace Toolkit Viewer.
-At this point, the -mm tree of the kernel is used because it has RelayFS support
-in it. In a nearby future, a vanilla kernel 2.6.14 will be used, as RelayFS has
-been integrated in the linux 2.6.14-rc series.
The following lttng patch is necessary to have the tracing hooks in the kernel.
The following ltt-control module controls the tracing.
sources, the dependencies are listed.
-Author : Mathieu Desnoyers, September 2005
+** Current development status **
+
+LTTng :
+supported architectures :
+Intel Pentium (UP/SMP) with TSC
+PowerPC 32 and 64 bits
+ARM
+C2 Microsystems (variant of MIPS)
+LTTV :
+supported architectures :
+Intel i386 and better
+Intel 64 bits
+PowerPC 32 and 64 bits
+
+
+
+Author : Mathieu Desnoyers, September 2005
+Last update : May 30, 2006
***********************************************************
** Section 1 * Installation from Debian or RPM packages **
***********************************************************
-No RPM packages are ready yet.
-No Debian kernel LTTng patch is ready yet.
+** NOTE : RPM and debian packages are only made once a version has been
+ thoroughly tested. If they do not exist at the moment, please install from
+ sources (see section 2 below). To see the list of compatibilities between
+ LTTng, ltt-control, LTTV, genevent and lttng-modules, please refer to
+ http://ltt.polymtl.ca > LTTng+LTTV versions compatibility
+
+
+* Install from RPM packages on Fedora Core 4 :
+
+Get LTTV RPM from :
+
+http://ltt.polymtl.ca/packages/fedora/RPMS
+
+LTTV RPM are ready.
+
+LTTng kernel and lttng-modules RPM are available for some architectures (i586,
+i686). Feel free to help fix the spec files to have correct lttng-modules RPM
+package.
+
+
+* Install from Deb packages on Debian :
You can use the ltt.polymtl.ca apt source to get LTTV for Debian :
deb http://ltt.polymtl.ca/packages/debian experimental main
deb-src http://ltt.polymtl.ca/packages/debian experimental main
-Then, perform the following :
+
+* Install from precompiled binary packages (LTTV compiled only for i386, and
+ LTTng only for i686 smp), perform the following :
su -
apt-get update
apt-get install lttv lttv-doc
+apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.2
+apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.2
* note : the packages are signed by myself. I am not considered a trusted
Debian source yet, so warnings are normal.
+Then, follow the section "Editing the system wide configuration" in section 2.
+
+* Create custom LTTV Debian packages
+
+Binary packages are only available for i386. If you want to create your own LTTV
+packages for other platforms, do :
+
+su -
+cd /usr/src
+apt-get source lttv
+cd lttv-0.6.9
+dpkg-buildpackage -rfakeroot
+
+You should then have your LTTV .deb files created for your architecture.
+
+* Create custom LTTng packages
+
+For building LTTng Debian packages :
+
+su -
+apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.2
+cd /usr/src
+bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof -
+cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.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
+
+You will also need to create a package for the lttng-modules :
+
+su -
+cd /usr/src
+apt-get source lttng-modules
+cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2
+make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image
+
+You will then see your freshly created .deb in /usr/src. Install it with
+dpkg -i /usr/src/lttng-modules-modules-(your version).deb
+Then, follow the section "Editing the system wide configuration" in section 2.
***********************************************************
You might also want to have libncurses5 to have the text mode kernel
configuration menu, but there are alternatives.
-Prerequisites for LTTV 0.6.x installation are :
-
-gtk 2.4 or better development libraries (libgtk2.0, libgtk2.0-dev)
-glib 2.4 or better development libraries (libglib2.0-0, libglib2.0-dev)
-libpopt development libraries (libpopt0, libpopt-dev)
-libpango development libraries (libpango1.0, libpango1.0-dev)
-libc6 development librairies (libc6, libc6-dev)
+Prerequisites for LTTV 0.x.x installation are :
+
+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)
* Getting the LTTng packages
mkdir /usr/src/lttng
cd /usr/src/lttng
(see http://ltt.polymtl.ca/lttng for package listing)
-wget http://ltt.polymtl.ca/lttng/lttng-modules-0.3.tar.bz2
-wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.bz2
-bzip2 -cd lttng-modules-0.3.tar.bz2 | tar xvof -
+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 -
* Getting LTTng kernel sources
su -
cd /usr/src
-wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.12-rc4.tar.bz2
-wget http://kernel.org/pub/linux/kernel/people/akpm/patches/2.6/2.6.12-rc4/2.6.12-rc4-mm2/2.6.12-rc4-mm2.bz2
-bzip2 -cd linux-2.6.12-rc4.tar.bz2 | tar xvof -
-cd linux-2.6.12-rc4
-bzip2 -cd ../2.6.12-rc4-mm2.bz2 | patch -p1
-bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.bz2 | patch -p1
+wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.X.tar.bz2
+bzip2 -cd linux-2.6.X.tar.bz2 | tar xvof -
+cd linux-2.6.X
+cat /usr/src/lttng/patch-2.6.X-lttng-0.x.xx* | patch -p1
cd ..
-mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4
+mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
* Installing a LTTng kernel
su -
-cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4
+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
+ go to the "Instrumentation Support" section
Select the following options :
[*] Linux Trace Toolkit Instrumentation Support
- [M] or [*] Linux Trace Toolkit Tracer
+ <M> or <*> Linux Trace Toolkit Tracer
It makes no difference for the rest of the procedure whether the Tracer
is compiled built-in or as a module.
- do NOT activate (not ready yet) :
- [ ] Align Linux Trace Toolkit Traces
+ activate :
+ [*] Align Linux Trace Toolkit Traces
+ [*] Allow tracing from userspace
+ your choice (see < Help >) :
[ ] Activate Linux Trace Toolkit Heartbeat Timer
- IMPORTANT : This is enabled by default : you must disable it!
+ You may or may not activate instrumentation per facility. They are all
+ selected for logging by default. It can be used as a compile time filter to
+ enable/disable logging of events. It is useful to discard events with a
+ minimal impact on the system and especially useful for now, as the dynamic
+ filter has not been implemented yet.
Select <Exit>
Select <Exit>
Select <Yes>
make
make modules_install
+
+-- on X86, X86_64
make install
+reboot
+Select the Linux 2.6.16-lttng-0.x.xx kernel in your boot loader.
+
+-- on PowerPC
+cp vmlinux /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.16-lttng-0.x.xx kernel in your boot loader.
+--
+
+
+
+* Editing the system wide configuration
You must activate relayfs and specify a mount point. This is typically done in
fstab such that it happens at boot time.
cp /etc/fstab /etc/fstab.lttng.bkp
echo "relayfs /mnt/relayfs relayfs rw 0 0" >> /etc/fstab
-reboot
-
- Select the Linux 2.6.12-rc4-mm2-lttng-0.4 kernel in your boot loader.
-
-
-* Install the ltt-modules
+then, rebooting or issuing the following command will activate relayfs :
-su -
-cd /usr/src/lttng/lttng-modules-0.3
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4 make
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4 make modules_install
+mount /mnt/relayfs
You need to load the ltt-control module to be able to control tracing from user
space. This is done by issuing the command :
modprobe ltt-control
+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 :
+
+modprobe ltt-statedump
+
You can automate at boot time loading the ltt-control module by :
echo ltt-control >> /etc/modules
+echo ltt-statedump >> /etc/modules
-* Getting and installing the LTTV package
+* Getting and installing the ltt-control package (on the traced machine)
+(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.)
+su -
+cd /usr/src
+wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz
+gzip -cd ltt-control-0.x-xxxx2006.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
+
+* Getting and installing the ltt-usertrace package for user space tracing
+See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART
+
+
+* Getting and installing the LTTV package (on the visualisation machine, same or
+ different from the visualisation machine)
su -
cd /usr/src
-wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.5-21092005.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.6.5-21092005.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.6.5-21092005
+wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz
+gzip -cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz | tar xvof -
+cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006
(refer to README to see the development libraries that must be installed on you
system)
./configure
su -
cd /usr/src
-wget http://ltt.polymtl.ca/packages/genevent-0.2.tar.gz
-gzip -cd genevent-0.2.tar.gz | tar xvof -
-cd genevent-0.2
+wget http://ltt.polymtl.ca/packages/genevent-0.xx.tar.gz
+gzip -cd genevent-0.xx.tar.gz | tar xvof -
+cd genevent-0.xx
make
make install
cp process.xml yourfacility.xml
* edit yourfacility.xml to fit your needs.
cd /tmp
-/usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
+/usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/facilities/yourfacility.xml
cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
- /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/include/linux/ltt
+ /usr/src/linux-2.6.16-lttng-0.x.xx8/include/linux/ltt
cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
- /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/ltt
+ /usr/src/linux-2.6.16-lttng-0.x.xx/ltt
* edit the kernel file you want to instrument
- Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
of the file.
- Add a call to the tracing functions. See their names and parameters in
- /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/include/linux/ltt/ltt-facility-yourfacility.h
+ /usr/src/linux-2.6.16-lttng-0.x.xx/include/linux/ltt/ltt-facility-yourfacility.h
+* Add new events to userspace programs with genevent
+See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART
+
+
projects / lttv.git / blobdiff