update QUICKSTART
[lttv.git] / ltt / branches / poly / QUICKSTART
index d35ca427668de8331082e35d87afd8b3478264f8..b5d31f7e30e64d105f1d20150a76c675f3babe52 100644 (file)
@@ -7,15 +7,21 @@ This document is made of four parts : The first one explains how to install
 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 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
 
-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.
 
-These operations are made for installing the LTTng 0.5.5 tracer on a
-linux 2.6.15 kernel. You will also find instructions for installation of
-LTTV 0.8.x : the Linux Trace Toolkit Viewer.
 
 The following lttng patch is necessary to have the tracing hooks in the kernel.
 The following ltt-control module controls the tracing.
@@ -30,17 +36,20 @@ sources, the dependencies are listed.
 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
+PowerPC 32 and 64 bits
 
 
 
 Author : Mathieu Desnoyers, September 2005
-Last update : January 10, 2006
+Last update : May 30, 2006
 
 
 ***********************************************************
@@ -49,7 +58,9 @@ Last update : January 10, 2006
 
 ** 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).
+   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 :
@@ -157,7 +168,7 @@ o  module-init-tools      0.9.10                  # depmod -V
 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 :
+Prerequisites for LTTV 0.x.x installation are :
 
 gcc 3.2 or better
 gtk 2.4 or better development libraries
@@ -185,28 +196,26 @@ su -
 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.4.tar.bz2
-wget http://ltt.polymtl.ca/lttng/patch-2.6.15-lttng-0.5.5.tar.bz2
-bzip2 -cd lttng-modules-0.4.tar.bz2 | tar xvof -
-bzip2 -cd patch-2.6.15-lttng-0.5.5.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.15.tar.bz2
-bzip2 -cd linux-2.6.15.tar.bz2 | tar xvof -
-cd linux-2.6.15
-cat /usr/src/lttng/patch-2.6.15-lttng-0.5.5* | 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.15 linux-2.6.15-lttng-0.5.5
+mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
 
 
 * Installing a LTTng kernel
 
 su -
-cd /usr/src/linux-2.6.15-lttng-0.5.5
+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.
@@ -221,32 +230,40 @@ make menuconfig (or make xconfig or make config)
         is compiled built-in or as a module.
     activate :
        [*] Align Linux Trace Toolkit Traces
-    do NOT activate (not ready yet) :
+       [*] Allow tracing from userspace
+    your choice (see < Help >) :
        [ ] Activate Linux Trace Toolkit Heartbeat Timer
-               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.
+    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
-make install
 
+-- on X86, X86_64
+make install
 reboot
+Select the Linux 2.6.16-lttng-0.x.xx kernel in your boot loader.
 
-  Select the Linux 2.6.15-lttng-0.5.5 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.
+--
 
 
-* Install the ltt-modules
-
-su -
-cd /usr/src/lttng/lttng-modules-0.4
-KERNELDIR=/usr/src/linux-2.6.15-lttng-0.5.5 make
-KERNELDIR=/usr/src/linux-2.6.15-lttng-0.5.5 make modules_install
-
 
 * Editing the system wide configuration
 
@@ -268,18 +285,44 @@ 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 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
+* 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.8.4-10012006.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.8.4-10012006.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.8.4-10012006
+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
@@ -342,9 +385,9 @@ see lttv -m textDump --help for detailed command line options of textDump.
 
 su -
 cd /usr/src
-wget http://ltt.polymtl.ca/packages/genevent-0.4.tar.gz
-gzip -cd genevent-0.4.tar.gz | tar xvof -
-cd genevent-0.4
+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
 
@@ -358,14 +401,18 @@ cp process.xml yourfacility.xml
 cd /tmp
 /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.15-lttng-0.5.5/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.15-lttng-0.5.5/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.15-lttng-0.5.5/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
+
+
 
 
This page took 0.026539 seconds and 4 git commands to generate.