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 the LTTng 0.4.2 tracer on a
  17 linux 2.6.12-rc4-mm2 kernel. You will also find instructions for installtion of
  18 LTTV 0.6.x : the Linux Trace Toolkit Viewer.
  19
  20 At this point, the -mm tree of the kernel is used because it has RelayFS support
  21 in it. In a nearby future, a vanilla kernel 2.6.14 will be used, as RelayFS has
  22 been integrated in the linux 2.6.14-rc series.
  23
  24 The following lttng patch is necessary to have the tracing hooks in the kernel.
  25 The following ltt-control module controls the tracing.
  26
  27 Required programs and librairies are assumed to be automatically installed in an
  28 installation with Debian or RPM packages. In the case of an installation from
  29 sources, the dependencies are listed.
  30
  31
  32 ** Current development status **
  33
  34 LTTng :
  35 supported architectures :
  36 Intel Pentium (UP/SMP) with TSC
  37
  38 LTTV :
  39 supported architectures :
  40 Intel i386 and better
  41 PowerPC
  42
  43
  44
  45 Author : Mathieu Desnoyers, September 2005
  46
  47
  48
  49 ***********************************************************
  50 ** Section 1 * Installation from Debian or RPM packages  **
  51 ***********************************************************
  52
  53 * Install from RPM packages on Fedora Core 4 :
  54
  55 Get LTTV RPM from :
  56
  57 http://ltt.polymtl.ca/packages/fedora/RPMS
  58
  59 No RPM packages for LTTng are ready yet.
  60
  61
  62 * Install from Deb packages on Debian :
  63
  64 You can use the ltt.polymtl.ca apt source to get LTTV for Debian :
  65
  66 Add the following two sources to your /etc/apt/sources.list :
  67
  68 deb http://ltt.polymtl.ca/packages/debian experimental main
  69 deb-src http://ltt.polymtl.ca/packages/debian experimental main
  70
  71
  72 * Install from precompiled binary packages (LTTV compiled only for i386, and
  73   LTTng only for i686 smp), perform the following :
  74
  75 su -
  76 apt-get update
  77 apt-get install lttv lttv-doc
  78 apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.1
  79 apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.1
  80   * note : the packages are signed by myself. I am not considered a trusted
  81     Debian source yet, so warnings are normal.
  82
  83 Then, follow the section "Editing the system wide configuration" in section 2.
  84
  85 * Create custom LTTV Debian packages
  86
  87 Binary packages are only available for i386. If you want to create your own LTTV
  88 packages for other platforms, do :
  89
  90 su -
  91 cd /usr/src
  92 apt-get source lttv
  93 cd lttv-0.6.8
  94 dpkg-buildpackage -rfakeroot
  95
  96 You should then have your LTTV .deb files created for your architecture.
  97
  98 * Create custom LTTng packages
  99
 100 For building LTTng Debian packages :
 101
 102 su -
 103 apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
 104 cd /usr/src
 105 bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1.tar.bz2 | tar xvof -
 106 cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
 107 make menuconfig (or xconfig or config) (customize your configuration)
 108 make-kpkg kernel_image
 109
 110 You will then see your freshly created .deb in /usr/src. Install it with
 111 dpkg -i /usr/src/(image-name).deb
 112
 113 You will also need to create a package for the lttng-modules :
 114
 115 su -
 116 cd /usr/src
 117 apt-get source lttng-modules
 118 cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
 119 make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image
 120
 121 You will then see your freshly created .deb in /usr/src. Install it with
 122 dpkg -i /usr/src/lttng-modules-modules-(your version).deb
 123
 124
 125 Then, follow the section "Editing the system wide configuration" in section 2.
 126
 127
 128 ***********************************************************
 129 ** Section 2 * Installation from sources                 **
 130 ***********************************************************
 131
 132 * Prerequisites
 133
 134 Tools needed to follow the package download steps :
 135
 136 o wget
 137 o bzip2
 138 o gzip
 139 o tar
 140
 141 You have to install the standard development librairies and programs necessary
 142 to compile a kernel :
 143
 144 (from Documentation/Changes in the Linux kernel tree)
 145 o  Gnu C                  2.95.3                  # gcc --version
 146 o  Gnu make               3.79.1                  # make --version
 147 o  binutils               2.12                    # ld -v
 148 o  util-linux             2.10o                   # fdformat --version
 149 o  module-init-tools      0.9.10                  # depmod -V
 150
 151 You might also want to have libncurses5 to have the text mode kernel
 152 configuration menu, but there are alternatives.
 153
 154 Prerequisites for LTTV 0.6.x installation are :
 155
 156 gcc 3.2 or better
 157 gtk 2.4 or better development libraries
 158   (Debian : libgtk2.0, libgtk2.0-dev)
 159   (Fedora : gtk2, gtk2-devel)
 160   note : For Fedora users : this might require at least core 3 from Fedora,
 161   or you might have to compile your own GTK2 library.
 162 glib 2.4 or better development libraries
 163   (Debian : libglib2.0-0, libglib2.0-dev)
 164   (Fedora : glib2, glib2-devel)
 165 libpopt development libraries
 166   (Debian : libpopt0, libpopt-dev)
 167   (Fedora : popt)
 168 libpango development libraries
 169   (Debian : libpango1.0, libpango1.0-dev)
 170   (Fedora : pango, pango-devel)
 171 libc6 development librairies
 172   (Debian : libc6, libc6-dev)
 173   (Fedora : glibc, glibc)
 174
 175
 176 * Getting the LTTng packages
 177
 178 su -
 179 mkdir /usr/src/lttng
 180 cd /usr/src/lttng
 181 (see http://ltt.polymtl.ca/lttng for package listing)
 182 wget http://ltt.polymtl.ca/lttng/lttng-modules-0.3.tar.bz2
 183 wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2
 184 bzip2 -cd lttng-modules-0.3.tar.bz2 | tar xvof -
 185 bzip2 -cd patch-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof -
 186
 187
 188 * Getting LTTng kernel sources
 189
 190 su -
 191 cd /usr/src
 192 wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.12-rc4.tar.bz2
 193 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
 194 bzip2 -cd linux-2.6.12-rc4.tar.bz2 | tar xvof -
 195 cd linux-2.6.12-rc4
 196 bzip2 -cd ../2.6.12-rc4-mm2.bz2 | patch -p1
 197 cat /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.2-* | patch -p1
 198 cd ..
 199 mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4.2
 200
 201
 202 * Installing a LTTng kernel
 203
 204 su -
 205 cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2
 206 make menuconfig (or make xconfig or make config)
 207     Select the < Help > button if you are not familiar with kernel
 208     configuration.
 209     Items preceded by [*] means they has to be built into the kernel.
 210     Items preceded by [M] means they has to be built as modules.
 211     Items preceded by [ ] means they should be removed.
 212   go to the "General setup" section
 213     Select the following options :
 214     [*] Linux Trace Toolkit Instrumentation Support
 215     [M] or [*] Linux Trace Toolkit Tracer
 216         It makes no difference for the rest of the procedure whether the Tracer
 217         is compiled built-in or as a module.
 218     do NOT activate (not ready yet) :
 219        [ ] Align Linux Trace Toolkit Traces
 220        [ ] Activate Linux Trace Toolkit Heartbeat Timer
 221               IMPORTANT : This is enabled by default : you must disable it!
 222     Select <Exit>
 223   Select <Exit>
 224   Select <Yes>
 225 make
 226 make modules_install
 227 make install
 228
 229 reboot
 230
 231   Select the Linux 2.6.12-rc4-mm2-lttng-0.4.2 kernel in your boot loader.
 232
 233
 234 * Install the ltt-modules
 235
 236 su -
 237 cd /usr/src/lttng/lttng-modules-0.3
 238 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2 make
 239 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2 make modules_install
 240
 241
 242 * Editing the system wide configuration
 243
 244 You must activate relayfs and specify a mount point. This is typically done in
 245 fstab such that it happens at boot time.
 246
 247 If you have never used RelayFS before, these operation would do this for you :
 248
 249 mkdir /mnt/relayfs
 250 cp /etc/fstab /etc/fstab.lttng.bkp
 251 echo "relayfs         /mnt/relayfs    relayfs rw              0       0"  >> /etc/fstab
 252
 253 then, rebooting or issuing the following command will activate relayfs :
 254
 255 mount /mnt/relayfs
 256
 257 You need to load the ltt-control module to be able to control tracing from user
 258 space. This is done by issuing the command :
 259
 260 modprobe ltt-control
 261
 262 You can automate at boot time loading the ltt-control module by :
 263
 264 echo ltt-control >> /etc/modules
 265
 266
 267 * Getting and installing the LTTV package
 268
 269 su -
 270 cd /usr/src
 271 wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.8-26092005.tar.gz
 272 gzip -cd LinuxTraceToolkitViewer-0.6.8-26092005.tar.gz | tar xvof -
 273 cd LinuxTraceToolkitViewer-0.6.8-26092005
 274 (refer to README to see the development libraries that must be installed on you
 275 system)
 276 ./configure
 277 make
 278 make install
 279
 280
 281
 282
 283 ***********************************************************
 284 ** Section 3 * Using LTTng and LTTV                      **
 285 ***********************************************************
 286
 287 * Use graphical LTTV to control tracing and analyse traces
 288
 289 lttv-gui (or /usr/local/bin/lttv-gui)
 290   - Spot the "Tracing Control" icon : click on it
 291       (it's a traffic light icon)
 292     - enter the root password
 293     - click "start"
 294     - click "stop"
 295     - Yes
 296       * You should now see a trace
 297
 298 * Use text mode LTTng to control tracing
 299
 300 The tracing can be controlled from a terminal by using the lttctl command (as
 301 root).
 302
 303 Start tracing :
 304
 305 lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace
 306
 307 Stop tracing and destroy trace channels :
 308
 309 lttctl -n trace -R
 310
 311 see lttctl --help for details.
 312
 313
 314 * Use text mode LTTV
 315
 316 Fell free to look in /usr/local/lib/lttv/plugins to see all the text and
 317 graphical plugins available.
 318
 319 For example, a simple trace dump in text format is available with :
 320
 321 lttv -m textDump -t /tmp/trace
 322
 323 see lttv -m textDump --help for detailed command line options of textDump.
 324
 325
 326
 327
 328 ***********************************************************
 329 ** Section 4 * Adding new instrumentations with genevent **
 330 ***********************************************************
 331
 332 * Getting and installing genevent
 333
 334 su -
 335 cd /usr/src
 336 wget http://ltt.polymtl.ca/packages/genevent-0.2.tar.gz
 337 gzip -cd genevent-0.2.tar.gz | tar xvof -
 338 cd genevent-0.2
 339 make
 340 make install
 341
 342
 343 * Add new events to the kernel with genevent
 344
 345 su -
 346 cd /usr/local/share/LinuxTraceToolkitViewer/facilities
 347 cp process.xml yourfacility.xml
 348   * edit yourfacility.xml to fit your needs.
 349 cd /tmp
 350 /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
 351 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
 352          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2/include/linux/ltt
 353 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
 354          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2/ltt
 355   * edit the kernel file you want to instrument
 356     - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
 357       of the file.
 358     - Add a call to the tracing functions. See their names and parameters in
 359       /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.2/include/linux/ltt/ltt-facility-yourfacility.h
 360
 361
 362