ltt/branches/poly/QUICKSTART

   1
   2 QUICKSTART
   3
   4 How to use LTTng and LTTV in a few lines :
   5
   6 This document is made of four parts : The first one explains how to install
   7 LTTng and LTTV from Debian and RPM binary packages, the second one explains how
   8 to install LTTng and LTTV from sources and the third one describes the steps
   9 to follow to trace a system and view it. The fourth and last part explains
  10 briefly how to add a new trace point to the kernel.
  11
  12 What you will typically want is to read sections 1 and 3 : install LTTng from
  13 binary packages and use it. If there are no packages ready for your system, you
  14 will have to install from sources (section 2) instead.
  15
  16 These operations are made for installing LTTng 0.2 on a linux 2.6.12-rc2-mm2
  17 kernel. Change the versions to fit your needs.
  18
  19 Author : Mathieu Desnoyers, September 2005
  20
  21
  22
  23 ***********************************************************
  24 ** Section 1 * Installation from Debian or RPM packages  **
  25 ***********************************************************
  26
  27 No Debian or RPM packages are ready yet.
  28
  29 TODO
  30
  31
  32 ***********************************************************
  33 ** Section 2 * Installation from sources                 **
  34 ***********************************************************
  35
  36 * Getting the LTTng packages
  37
  38 su -
  39 mkdir /usr/src/lttng
  40 cd /usr/src/lttng
  41 (see http://ltt.polymtl.ca/lttng for package listing)
  42 wget http://ltt.polymtl.ca/lttng/lttng-modules-0.2.tar.bz2
  43 wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2
  44 bzip2 -cd lttng-modules-0.2.tar.bz2 | tar xvof -
  45
  46
  47 * Getting LTTng kernel sources
  48
  49 su -
  50 cd /usr/src
  51 wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.12-rc4.tar.bz2
  52 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
  53 bzip2 -cd linux-2.6.12-rc4.tar.bz2 | tar xvof -
  54 cd linux-2.6.12-rc4
  55 bzip2 -cd ../2.6.12-rc4-mm2.bz2 | patch -p1
  56 bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2 | patch -p1
  57 cd ..
  58 mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.3
  59
  60
  61 * Installing a LTTng kernel
  62
  63 su -
  64 cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3
  65 make menuconfig
  66   General setup
  67     * Linux Trace Toolkit Instrumentation Support
  68     M or * Linux Trace Toolkit Tracer
  69     do NOT activate (not ready yet) :
  70         Align Linux Trace Toolkit Traces
  71         Activate Linux Trace Toolkit Heartbeat Timer
  72               IMPORTANT : This is enabled by default : you must disable it!
  73 make
  74 make install
  75 make modules_install
  76
  77 Depending on your boot loader, you may want to execute :
  78 update-grub or lilo
  79
  80 reboot
  81
  82
  83 * Install the ltt-modules
  84
  85 su -
  86 cd /usr/src/lttng/lttng-modules-0.2
  87 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make
  88 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make modules_install
  89
  90 note : at this stage, you might want to execute
  91 modprobe ltt-control
  92
  93 and you might also want to do this :
  94 echo ltt-control >> /etc/modules
  95
  96
  97 * Getting and installing the LTTV package
  98
  99 su -
 100 cd /usr/src
 101 wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.5-16092005.tar.gz
 102 gzip -cd LinuxTraceToolkitViewer-0.5-16092005.tar.gz | tar xvof -
 103 cd LinuxTraceToolkitViewer-0.5-16092005
 104 ./configure
 105 make
 106 make install
 107
 108
 109
 110
 111 ***********************************************************
 112 ** Section 3 * Using LTTV                                **
 113 ***********************************************************
 114
 115 * Use graphical LTTV
 116
 117 lttv-gui (or /usr/local/bin/lttv-gui)
 118   - Spot the "Trace Control" icon : click on it
 119     - enter the root password
 120     - click "start"
 121     - click "stop"
 122     - Yes
 123       * You should now see a trace
 124
 125 * Use text mode LTTV
 126
 127 Fell free to look in /usr/local/lib/lttv/plugins to see all the text and
 128 graphical plugins available.
 129
 130 For example, a simple trace dump in text format is available with :
 131
 132 lttv -m textDump -t /tmp/trace
 133
 134 see lttv -m textDump --help for detailed command line options of textDump.
 135
 136
 137
 138
 139 ***********************************************************
 140 ** Section 4 * Adding new instrumentations with genevent **
 141 ***********************************************************
 142
 143 * Getting and installing genevent
 144
 145 su -
 146 cd /usr/src
 147 wget http://ltt.polymtl.ca/packages/genevent-0.1.tar.gz
 148 gzip -cd genevent-0.1.tar.gz | tar xvof -
 149 cd genevent-0.1
 150 make
 151 make install
 152
 153
 154 * Add new events to the kernel with genevent
 155
 156 su -
 157 cd /usr/local/share/LinuxTraceToolkitViewer/facilities
 158 cp process.xml yourfacility.xml
 159   * edit yourfacility.xml to fit your needs.
 160 cd /tmp
 161 /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
 162 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
 163          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt
 164 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
 165          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/ltt
 166   * edit the kernel file you want to instrument
 167     - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
 168       of the file.
 169     - Add a call to the tracing functions. See their names and parameters in
 170       /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt/ltt-facility-yourfacility.h
 171
 172
 173