0.6.8
[lttv.git] / ltt / branches / poly / QUICKSTART
index fc9f3a085ccaaa999cf7b7061c2326e455833f85..7a37dcbbab4b93fd8c80f196686c12396ca40424 100644 (file)
@@ -13,7 +13,7 @@ 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.4 tracer on a
+These operations are made for installing the LTTng 0.4.1 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.
 
@@ -29,6 +29,19 @@ installation with Debian or RPM packages. In the case of an installation from
 sources, the dependencies are listed.
 
 
+** Current development status **
+
+LTTng : 
+supported architectures : 
+Intel Pentium (UP/SMP) with TSC
+
+LTTV :
+supported architectures :
+Intel i386 and better
+PowerPC
+
+
+
 Author : Mathieu Desnoyers, September 2005
 
 
@@ -37,9 +50,70 @@ Author : Mathieu Desnoyers, September 2005
 ** Section 1 * Installation from Debian or RPM packages  **
 ***********************************************************
 
-No Debian or RPM packages are ready yet.
+No RPM packages are ready yet.
+
+You can use the ltt.polymtl.ca apt source to get LTTV for Debian :
+
+Add the following two sources to your /etc/apt/sources.list :
+
+deb http://ltt.polymtl.ca/packages/debian experimental main
+deb-src http://ltt.polymtl.ca/packages/debian experimental main
+
+
+* 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.1
+apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.1
+  * 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.8
+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.1
+cd /usr/src
+bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1.tar.bz2 | tar xvof -
+cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
+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.1
+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
 
-TODO
+
+Then, follow the section "Editing the system wide configuration" in section 2.
 
 
 ***********************************************************
@@ -83,9 +157,9 @@ 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.2.tar.bz2
-wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.bz2
-bzip2 -cd lttng-modules-0.2.tar.bz2 | tar xvof -
+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.1.bz2
+bzip2 -cd lttng-modules-0.3.tar.bz2 | tar xvof -
 
 
 * Getting LTTng kernel sources
@@ -97,15 +171,15 @@ wget http://kernel.org/pub/linux/kernel/people/akpm/patches/2.6/2.6.12-rc4/2.6.1
 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
+bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.1.bz2 | patch -p1
 cd ..
-mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4
+mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4.1
 
 
 * Installing a LTTng kernel
 
 su -
-cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4
+cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1
 make menuconfig (or make xconfig or make config)
     Select the < Help > button if you are not familiar with kernel
     configuration.
@@ -116,6 +190,8 @@ make menuconfig (or make xconfig or make config)
     Select the following options :
     [*] Linux Trace Toolkit Instrumentation Support
     [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 Linux Trace Toolkit Heartbeat Timer
@@ -124,34 +200,44 @@ make menuconfig (or make xconfig or make config)
   Select <Exit>
   Select <Yes>
 make
-make install
 make modules_install
-
-You must activate relayfs and specify a mount point. This is typically done in
-fstab such that it happens at boot time.
-
-If you have never used RelayFS before, these operation would do this for you :
-mkdir /mnt/relayfs
-echo "relayfs         /mnt/relayfs    relayfs rw              0       0" \
-   >> /etc/fstab
+make install
 
 reboot
 
-  Select the Linux 2.6.12-rc4-mm2-lttng-0.4 kernel in your boot loader.
+  Select the Linux 2.6.12-rc4-mm2-lttng-0.4.1 kernel in your boot loader.
 
 
 * Install the ltt-modules
 
 su -
-cd /usr/src/lttng/lttng-modules-0.2
-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
+cd /usr/src/lttng/lttng-modules-0.3
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1 make
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1 make modules_install
+
+
+* 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.
+
+If you have never used RelayFS before, these operation would do this for you :
+
+mkdir /mnt/relayfs
+cp /etc/fstab /etc/fstab.lttng.bkp
+echo "relayfs         /mnt/relayfs    relayfs rw              0       0"  >> /etc/fstab
+
+then, rebooting or issuing the following command will activate relayfs :
+
+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
 
 You can automate at boot time loading the ltt-control module by :
+
 echo ltt-control >> /etc/modules
 
 
@@ -159,9 +245,9 @@ echo ltt-control >> /etc/modules
 
 su -
 cd /usr/src
-wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.4-21092005.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.6.4-21092005.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.6.4-21092005
+wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.8-26092005.tar.gz
+gzip -cd LinuxTraceToolkitViewer-0.6.8-26092005.tar.gz | tar xvof -
+cd LinuxTraceToolkitViewer-0.6.8-26092005
 (refer to README to see the development libraries that must be installed on you
 system)
 ./configure
@@ -224,9 +310,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.1.tar.gz
-gzip -cd genevent-0.1.tar.gz | tar xvof -
-cd genevent-0.1
+wget http://ltt.polymtl.ca/packages/genevent-0.2.tar.gz
+gzip -cd genevent-0.2.tar.gz | tar xvof -
+cd genevent-0.2
 make
 make install
 
@@ -240,14 +326,14 @@ cp process.xml yourfacility.xml
 cd /tmp
 /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/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.12-rc4-mm2-lttng-0.4.1/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.12-rc4-mm2-lttng-0.4.1/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.12-rc4-mm2-lttng-0.4.1/include/linux/ltt/ltt-facility-yourfacility.h
     
 
 
This page took 0.025764 seconds and 4 git commands to generate.