d9cd3a2e |
1 | |
2 | QUICKSTART |
3 | |
4 | How to use LTTng and LTTV in a few lines : |
5 | |
6c913994 |
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 | |
238a687b |
16 | These operations are made for installing LTTng 0.3 on a linux 2.6.12-rc2-mm2 |
d9cd3a2e |
17 | kernel. Change the versions to fit your needs. |
18 | |
af88bd8a |
19 | Author : Mathieu Desnoyers, September 2005 |
20 | |
d9cd3a2e |
21 | |
6c913994 |
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 | |
d9cd3a2e |
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 |
4408c54c |
43 | wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2 |
d9cd3a2e |
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 |
4408c54c |
56 | bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2 | patch -p1 |
d9cd3a2e |
57 | cd .. |
4408c54c |
58 | mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.3 |
d9cd3a2e |
59 | |
60 | |
61 | * Installing a LTTng kernel |
62 | |
63 | su - |
4408c54c |
64 | cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 |
d9cd3a2e |
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 |
7bfce92a |
72 | IMPORTANT : This is enabled by default : you must disable it! |
02bc6879 |
73 | make |
d9cd3a2e |
74 | make install |
26d45a39 |
75 | make modules_install |
916ec268 |
76 | |
e8e288b8 |
77 | The first time you use relayfs, you have to specify a mount point in you system: |
78 | mkdir /mnt/relayfs |
79 | echo "relayfs /mnt/relayfs relayfs rw 0 0" \ |
80 | >> /etc/fstab |
81 | |
916ec268 |
82 | Depending on your boot loader, you may want to execute : |
83 | update-grub or lilo |
84 | |
d9cd3a2e |
85 | reboot |
86 | |
87 | |
88 | * Install the ltt-modules |
89 | |
90 | su - |
91 | cd /usr/src/lttng/lttng-modules-0.2 |
4408c54c |
92 | KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make |
93 | KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make modules_install |
d9cd3a2e |
94 | |
95 | note : at this stage, you might want to execute |
96 | modprobe ltt-control |
97 | |
98 | and you might also want to do this : |
99 | echo ltt-control >> /etc/modules |
100 | |
101 | |
102 | * Getting and installing the LTTV package |
103 | |
104 | su - |
105 | cd /usr/src |
1c12a30f |
106 | wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.2-20092005.tar.gz |
107 | gzip -cd LinuxTraceToolkitViewer-0.6.2-20092005.tar.gz | tar xvof - |
108 | cd LinuxTraceToolkitViewer-0.6.2-20092005 |
36fcd0b7 |
109 | (refer to README to see the development libraries that must be installed on you |
110 | system) |
d9cd3a2e |
111 | ./configure |
112 | make |
113 | make install |
114 | |
6c913994 |
115 | |
116 | |
117 | |
118 | *********************************************************** |
d1f19ac5 |
119 | ** Section 3 * Using LTTng and LTTV ** |
6c913994 |
120 | *********************************************************** |
121 | |
d1f19ac5 |
122 | * Use graphical LTTV to control tracing and analyse traces |
d9cd3a2e |
123 | |
124 | lttv-gui (or /usr/local/bin/lttv-gui) |
e44b6048 |
125 | - Spot the "Tracing Control" icon : click on it |
126 | (it's a traffic light icon) |
d9cd3a2e |
127 | - enter the root password |
128 | - click "start" |
129 | - click "stop" |
130 | - Yes |
131 | * You should now see a trace |
132 | |
d1f19ac5 |
133 | * Use text mode LTTng to control tracing |
134 | |
135 | The tracing can be controlled from a terminal by using the lttctl command. |
136 | |
137 | Start tracing : |
138 | |
139 | lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace1 |
140 | |
141 | Stop tracing and destroy trace channels : |
142 | |
143 | lttctl -n trace -R |
144 | |
145 | see lttctl --help for details. |
146 | |
147 | |
6c913994 |
148 | * Use text mode LTTV |
149 | |
150 | Fell free to look in /usr/local/lib/lttv/plugins to see all the text and |
151 | graphical plugins available. |
152 | |
153 | For example, a simple trace dump in text format is available with : |
154 | |
155 | lttv -m textDump -t /tmp/trace |
156 | |
157 | see lttv -m textDump --help for detailed command line options of textDump. |
158 | |
159 | |
160 | |
161 | |
162 | *********************************************************** |
163 | ** Section 4 * Adding new instrumentations with genevent ** |
164 | *********************************************************** |
d9cd3a2e |
165 | |
166 | * Getting and installing genevent |
167 | |
cb598ad7 |
168 | su - |
d9cd3a2e |
169 | cd /usr/src |
170 | wget http://ltt.polymtl.ca/packages/genevent-0.1.tar.gz |
171 | gzip -cd genevent-0.1.tar.gz | tar xvof - |
172 | cd genevent-0.1 |
173 | make |
174 | make install |
175 | |
176 | |
177 | * Add new events to the kernel with genevent |
178 | |
179 | su - |
180 | cd /usr/local/share/LinuxTraceToolkitViewer/facilities |
181 | cp process.xml yourfacility.xml |
182 | * edit yourfacility.xml to fit your needs. |
183 | cd /tmp |
184 | /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml |
185 | cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \ |
4408c54c |
186 | /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt |
d9cd3a2e |
187 | cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \ |
4408c54c |
188 | /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/ltt |
d9cd3a2e |
189 | * edit the kernel file you want to instrument |
190 | - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning |
191 | of the file. |
192 | - Add a call to the tracing functions. See their names and parameters in |
4408c54c |
193 | /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt/ltt-facility-yourfacility.h |
d9cd3a2e |
194 | |
195 | |
196 | |