ltt/branches/poly/QUICKSTART

   1
   2 QUICKSTART
   3
   4 How to use LTTng and LTTV in a few lines :
   5
   6 These operations are made for installing LTTng 0.2 on a linux 2.6.12-rc2-mm2
   7 kernel. Change the versions to fit your needs.
   8
   9 Author : Mathieu Desnoyers, September 2005
  10
  11
  12 * Getting the LTTng packages
  13
  14 su -
  15 mkdir /usr/src/lttng
  16 cd /usr/src/lttng
  17 (see http://ltt.polymtl.ca/lttng for package listing)
  18 wget http://ltt.polymtl.ca/lttng/lttng-modules-0.2.tar.bz2
  19 wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.2.bz2
  20 bzip2 -cd lttng-modules-0.2.tar.bz2 | tar xvof -
  21
  22
  23 * Getting LTTng kernel sources
  24
  25 su -
  26 cd /usr/src
  27 wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.12-rc4.tar.bz2
  28 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
  29 bzip2 -cd linux-2.6.12-rc4.tar.bz2 | tar xvof -
  30 cd linux-2.6.12-rc4
  31 bzip2 -cd ../2.6.12-rc4-mm2.bz2 | patch -p1
  32 bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.2.bz2 | patch -p1
  33 cd ..
  34 mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.2
  35
  36
  37 * Installing a LTTng kernel
  38
  39 su -
  40 cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2
  41 make menuconfig
  42   General setup
  43     * Linux Trace Toolkit Instrumentation Support
  44     M or * Linux Trace Toolkit Tracer
  45     do NOT activate (not ready yet) :
  46         Align Linux Trace Toolkit Traces
  47         Activate Linux Trace Toolkit Heartbeat Timer
  48               IMPORTANT : This is enabled by default : you must disable it!
  49 make install
  50 make modules_install
  51 reboot
  52
  53
  54 * Install the ltt-modules
  55
  56 su -
  57 cd /usr/src/lttng/lttng-modules-0.2
  58 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.2 make
  59 KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.2 make modules_install
  60
  61 note : at this stage, you might want to execute
  62 modprobe ltt-control
  63
  64 and you might also want to do this :
  65 echo ltt-control >> /etc/modules
  66
  67
  68 * Getting and installing the LTTV package
  69
  70 su -
  71 cd /usr/src
  72 wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.5-16092005.tar.gz
  73 gzip -cd LinuxTraceToolkitViewer-0.5-16092005.tar.gz | tar xvof -
  74 cd LinuxTraceToolkitViewer-0.5-16092005
  75 ./configure
  76 make
  77 make install
  78
  79 * Use LTTV
  80
  81 lttv-gui (or /usr/local/bin/lttv-gui)
  82   - Spot the "Trace Control" icon : click on it
  83     - enter the root password
  84     - click "start"
  85     - click "stop"
  86     - Yes
  87       * You should now see a trace
  88
  89
  90 * Getting and installing genevent
  91
  92 su -
  93 cd /usr/src
  94 wget http://ltt.polymtl.ca/packages/genevent-0.1.tar.gz
  95 gzip -cd genevent-0.1.tar.gz | tar xvof -
  96 cd genevent-0.1
  97 make
  98 make install
  99
 100
 101 * Add new events to the kernel with genevent
 102
 103 su -
 104 cd /usr/local/share/LinuxTraceToolkitViewer/facilities
 105 cp process.xml yourfacility.xml
 106   * edit yourfacility.xml to fit your needs.
 107 cd /tmp
 108 /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
 109 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
 110          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/include/linux/ltt
 111 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
 112          /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/ltt
 113   * edit the kernel file you want to instrument
 114     - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
 115       of the file.
 116     - Add a call to the tracing functions. See their names and parameters in
 117       /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/include/linux/ltt/ltt-facility-yourfacility.h
 118
 119
 120