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 |
208a5623 |
10 | briefly how to add a new trace point to the kernel and to user space |
11 | applications. |
6c913994 |
12 | |
208a5623 |
13 | What you will typically want is to read sections 2 and 3 : install LTTng from |
14 | sources and use it. |
6c913994 |
15 | |
3c3abcf1 |
16 | These operations are made for installing the LTTng 0.5.X tracer on a |
17 | linux 2.6.X kernel. You will also find instructions for installation of |
18 | LTTV 0.8.x : the Linux Trace Toolkit Viewer. |
19 | |
20 | To see the list of compatibilities between LTTng, ltt-control, LTTV, genevent |
208a5623 |
21 | and ltt-usertrace, please refer to : |
3c3abcf1 |
22 | http://ltt.polymtl.ca > LTTng+LTTV versions compatibility |
23 | |
24 | |
38e8e662 |
25 | |
26 | The following lttng patch is necessary to have the tracing hooks in the kernel. |
27 | The following ltt-control module controls the tracing. |
28 | |
29 | Required programs and librairies are assumed to be automatically installed in an |
30 | installation with Debian or RPM packages. In the case of an installation from |
31 | sources, the dependencies are listed. |
32 | |
d9cd3a2e |
33 | |
c96be0d0 |
34 | ** Current development status ** |
35 | |
36 | LTTng : |
37 | supported architectures : |
38 | Intel Pentium (UP/SMP) with TSC |
e3b182e5 |
39 | PowerPC 32 and 64 bits |
2a4c796f |
40 | ARM |
2b75fbd7 |
41 | x86_64 |
285468d4 |
42 | C2 Microsystems (variant of MIPS) |
c96be0d0 |
43 | |
44 | LTTV : |
45 | supported architectures : |
46 | Intel i386 and better |
d21695ed |
47 | Intel 64 bits |
e3b182e5 |
48 | PowerPC 32 and 64 bits |
c96be0d0 |
49 | |
50 | |
51 | |
af88bd8a |
52 | Author : Mathieu Desnoyers, September 2005 |
208a5623 |
53 | Last update : May 30, 2006 |
d9cd3a2e |
54 | |
6c913994 |
55 | |
56 | *********************************************************** |
57 | ** Section 1 * Installation from Debian or RPM packages ** |
58 | *********************************************************** |
59 | |
d21695ed |
60 | ** NOTE : RPM and debian packages are only made once a version has been |
61 | thoroughly tested. If they do not exist at the moment, please install from |
208a5623 |
62 | sources (see section 2 below). To see the list of compatibilities between |
63 | LTTng, ltt-control, LTTV, genevent and lttng-modules, please refer to |
64 | http://ltt.polymtl.ca > LTTng+LTTV versions compatibility |
d21695ed |
65 | |
66 | |
c1298250 |
67 | * Install from RPM packages on Fedora Core 4 : |
68 | |
69 | Get LTTV RPM from : |
70 | |
71 | http://ltt.polymtl.ca/packages/fedora/RPMS |
72 | |
8c7a7394 |
73 | LTTV RPM are ready. |
74 | |
75 | LTTng kernel and lttng-modules RPM are available for some architectures (i586, |
76 | i686). Feel free to help fix the spec files to have correct lttng-modules RPM |
77 | package. |
c1298250 |
78 | |
79 | |
80 | * Install from Deb packages on Debian : |
6a2c1aed |
81 | |
82 | You can use the ltt.polymtl.ca apt source to get LTTV for Debian : |
83 | |
84 | Add the following two sources to your /etc/apt/sources.list : |
85 | |
86 | deb http://ltt.polymtl.ca/packages/debian experimental main |
87 | deb-src http://ltt.polymtl.ca/packages/debian experimental main |
88 | |
5694ce4d |
89 | |
90 | * Install from precompiled binary packages (LTTV compiled only for i386, and |
91 | LTTng only for i686 smp), perform the following : |
6a2c1aed |
92 | |
93 | su - |
94 | apt-get update |
95 | apt-get install lttv lttv-doc |
8c7a7394 |
96 | apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.2 |
97 | apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.2 |
6a2c1aed |
98 | * note : the packages are signed by myself. I am not considered a trusted |
99 | Debian source yet, so warnings are normal. |
100 | |
5694ce4d |
101 | Then, follow the section "Editing the system wide configuration" in section 2. |
102 | |
103 | * Create custom LTTV Debian packages |
104 | |
105 | Binary packages are only available for i386. If you want to create your own LTTV |
106 | packages for other platforms, do : |
6a2c1aed |
107 | |
5694ce4d |
108 | su - |
109 | cd /usr/src |
78d521e3 |
110 | apt-get source lttv |
8c7a7394 |
111 | cd lttv-0.6.9 |
78d521e3 |
112 | dpkg-buildpackage -rfakeroot |
113 | |
5694ce4d |
114 | You should then have your LTTV .deb files created for your architecture. |
115 | |
116 | * Create custom LTTng packages |
117 | |
118 | For building LTTng Debian packages : |
119 | |
120 | su - |
8c7a7394 |
121 | apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
122 | cd /usr/src |
8c7a7394 |
123 | bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof - |
124 | cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
125 | make menuconfig (or xconfig or config) (customize your configuration) |
126 | make-kpkg kernel_image |
127 | |
128 | You will then see your freshly created .deb in /usr/src. Install it with |
129 | dpkg -i /usr/src/(image-name).deb |
130 | |
131 | You will also need to create a package for the lttng-modules : |
132 | |
133 | su - |
134 | cd /usr/src |
135 | apt-get source lttng-modules |
8c7a7394 |
136 | cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
137 | make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image |
138 | |
139 | You will then see your freshly created .deb in /usr/src. Install it with |
140 | dpkg -i /usr/src/lttng-modules-modules-(your version).deb |
141 | |
6c913994 |
142 | |
5694ce4d |
143 | Then, follow the section "Editing the system wide configuration" in section 2. |
6c913994 |
144 | |
145 | |
146 | *********************************************************** |
147 | ** Section 2 * Installation from sources ** |
148 | *********************************************************** |
149 | |
38e8e662 |
150 | * Prerequisites |
151 | |
152 | Tools needed to follow the package download steps : |
153 | |
154 | o wget |
155 | o bzip2 |
156 | o gzip |
157 | o tar |
158 | |
159 | You have to install the standard development librairies and programs necessary |
160 | to compile a kernel : |
161 | |
162 | (from Documentation/Changes in the Linux kernel tree) |
163 | o Gnu C 2.95.3 # gcc --version |
164 | o Gnu make 3.79.1 # make --version |
165 | o binutils 2.12 # ld -v |
166 | o util-linux 2.10o # fdformat --version |
167 | o module-init-tools 0.9.10 # depmod -V |
168 | |
169 | You might also want to have libncurses5 to have the text mode kernel |
170 | configuration menu, but there are alternatives. |
171 | |
3c3abcf1 |
172 | Prerequisites for LTTV 0.x.x installation are : |
38e8e662 |
173 | |
860c0a03 |
174 | gcc 3.2 or better |
175 | gtk 2.4 or better development libraries |
176 | (Debian : libgtk2.0, libgtk2.0-dev) |
177 | (Fedora : gtk2, gtk2-devel) |
178 | note : For Fedora users : this might require at least core 3 from Fedora, |
179 | or you might have to compile your own GTK2 library. |
180 | glib 2.4 or better development libraries |
181 | (Debian : libglib2.0-0, libglib2.0-dev) |
182 | (Fedora : glib2, glib2-devel) |
183 | libpopt development libraries |
184 | (Debian : libpopt0, libpopt-dev) |
185 | (Fedora : popt) |
186 | libpango development libraries |
187 | (Debian : libpango1.0, libpango1.0-dev) |
188 | (Fedora : pango, pango-devel) |
189 | libc6 development librairies |
190 | (Debian : libc6, libc6-dev) |
191 | (Fedora : glibc, glibc) |
38e8e662 |
192 | |
193 | |
d9cd3a2e |
194 | * Getting the LTTng packages |
195 | |
196 | su - |
197 | mkdir /usr/src/lttng |
198 | cd /usr/src/lttng |
199 | (see http://ltt.polymtl.ca/lttng for package listing) |
208a5623 |
200 | wget http://ltt.polymtl.ca/lttng/patch-2.6.X-lttng-0.x.xx.tar.bz2 |
201 | bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 | tar xvof - |
d9cd3a2e |
202 | |
203 | |
204 | * Getting LTTng kernel sources |
205 | |
206 | su - |
207 | cd /usr/src |
52a20c2e |
208 | wget http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.X.tar.bz2 |
208a5623 |
209 | bzip2 -cd linux-2.6.X.tar.bz2 | tar xvof - |
210 | cd linux-2.6.X |
211 | cat /usr/src/lttng/patch-2.6.X-lttng-0.x.xx* | patch -p1 |
d9cd3a2e |
212 | cd .. |
208a5623 |
213 | mv linux-2.6.X linux-2.6.X-lttng-0.x.xx |
d9cd3a2e |
214 | |
215 | |
216 | * Installing a LTTng kernel |
217 | |
218 | su - |
208a5623 |
219 | cd /usr/src/linux-2.6.X-lttng-0.x.xx |
38e8e662 |
220 | make menuconfig (or make xconfig or make config) |
221 | Select the < Help > button if you are not familiar with kernel |
222 | configuration. |
223 | Items preceded by [*] means they has to be built into the kernel. |
224 | Items preceded by [M] means they has to be built as modules. |
225 | Items preceded by [ ] means they should be removed. |
d21695ed |
226 | go to the "Instrumentation Support" section |
38e8e662 |
227 | Select the following options : |
228 | [*] Linux Trace Toolkit Instrumentation Support |
d21695ed |
229 | <M> or <*> Linux Trace Toolkit Tracer |
8ede3ed9 |
230 | It makes no difference for the rest of the procedure whether the Tracer |
231 | is compiled built-in or as a module. |
d21695ed |
232 | activate : |
233 | [*] Align Linux Trace Toolkit Traces |
3c3abcf1 |
234 | [*] Allow tracing from userspace |
235 | your choice (see < Help >) : |
38e8e662 |
236 | [ ] Activate Linux Trace Toolkit Heartbeat Timer |
208a5623 |
237 | You may or may not activate instrumentation per facility. They are all |
238 | selected for logging by default. It can be used as a compile time filter to |
239 | enable/disable logging of events. It is useful to discard events with a |
240 | minimal impact on the system and especially useful for now, as the dynamic |
241 | filter has not been implemented yet. |
38e8e662 |
242 | Select <Exit> |
243 | Select <Exit> |
244 | Select <Yes> |
02bc6879 |
245 | make |
26d45a39 |
246 | make modules_install |
916ec268 |
247 | |
208a5623 |
248 | -- on X86, X86_64 |
249 | make install |
d9cd3a2e |
250 | reboot |
620920a8 |
251 | Select the Linux 2.6.17-lttng-0.x.xx kernel in your boot loader. |
208a5623 |
252 | |
253 | -- on PowerPC |
3c8a1f17 |
254 | cp vmlinux.strip /boot/vmlinux-2.6.X-lttng-0.x.xx |
208a5623 |
255 | cp System.map /boot/System.map-2.6.X-lttng-0.x.xx |
256 | cp .config /boot/config-2.6.X-lttng-0.x.xx |
257 | depmod -ae -F /boot/System.map-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx |
258 | mkinitrd /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx |
259 | (edit /etc/yaboot.conf to add a new entry pointing to your kernel : the entry |
260 | that comes first is the default kernel) |
261 | ybin |
262 | select the right entry at the yaboot prompt (see choices : tab, select : type |
263 | the kernel name followed by enter) |
620920a8 |
264 | Select the Linux 2.6.17-lttng-0.x.xx kernel in your boot loader. |
208a5623 |
265 | -- |
d9cd3a2e |
266 | |
d9cd3a2e |
267 | |
5694ce4d |
268 | |
269 | * Editing the system wide configuration |
270 | |
271 | You must activate relayfs and specify a mount point. This is typically done in |
272 | fstab such that it happens at boot time. |
273 | |
274 | If you have never used RelayFS before, these operation would do this for you : |
275 | |
276 | mkdir /mnt/relayfs |
277 | cp /etc/fstab /etc/fstab.lttng.bkp |
278 | echo "relayfs /mnt/relayfs relayfs rw 0 0" >> /etc/fstab |
279 | |
280 | then, rebooting or issuing the following command will activate relayfs : |
281 | |
282 | mount /mnt/relayfs |
283 | |
38e8e662 |
284 | You need to load the ltt-control module to be able to control tracing from user |
285 | space. This is done by issuing the command : |
8ede3ed9 |
286 | |
d9cd3a2e |
287 | modprobe ltt-control |
288 | |
9c78dc8f |
289 | If you want to have complete information about the kernel state (including all |
290 | the process names), you need to load the ltt-statedump module. This is done by |
291 | issuing the command : |
292 | |
293 | modprobe ltt-statedump |
294 | |
38e8e662 |
295 | You can automate at boot time loading the ltt-control module by : |
8ede3ed9 |
296 | |
d9cd3a2e |
297 | echo ltt-control >> /etc/modules |
9c78dc8f |
298 | echo ltt-statedump >> /etc/modules |
d9cd3a2e |
299 | |
300 | |
daa38dd5 |
301 | * Getting and installing the ltt-control package (on the traced machine) |
3bef9a5f |
302 | (note : the ltt-control package contains lttd and lttctl. Although it has the |
303 | same name as the ltt-control kernel module, they are *not* the same thing.) |
d9cd3a2e |
304 | su - |
305 | cd /usr/src |
3c3abcf1 |
306 | wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz |
307 | gzip -cd ltt-control-0.x-xxxx2006.tar.gz | tar xvof - |
308 | cd ltt-control-0.x-xxxx2006 |
daa38dd5 |
309 | (refer to README to see the development libraries that must be installed on you |
310 | system) |
311 | ./configure |
312 | make |
313 | make install |
314 | |
208a5623 |
315 | * Getting and installing the ltt-usertrace package for user space tracing |
316 | See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART |
317 | |
daa38dd5 |
318 | |
319 | * Getting and installing the LTTV package (on the visualisation machine, same or |
320 | different from the visualisation machine) |
321 | |
322 | su - |
323 | cd /usr/src |
3c3abcf1 |
324 | wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz |
325 | gzip -cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz | tar xvof - |
326 | cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006 |
36fcd0b7 |
327 | (refer to README to see the development libraries that must be installed on you |
328 | system) |
d9cd3a2e |
329 | ./configure |
330 | make |
331 | make install |
332 | |
6c913994 |
333 | |
334 | |
335 | |
336 | *********************************************************** |
d1f19ac5 |
337 | ** Section 3 * Using LTTng and LTTV ** |
6c913994 |
338 | *********************************************************** |
339 | |
d1f19ac5 |
340 | * Use graphical LTTV to control tracing and analyse traces |
d9cd3a2e |
341 | |
342 | lttv-gui (or /usr/local/bin/lttv-gui) |
e44b6048 |
343 | - Spot the "Tracing Control" icon : click on it |
344 | (it's a traffic light icon) |
d9cd3a2e |
345 | - enter the root password |
346 | - click "start" |
347 | - click "stop" |
348 | - Yes |
349 | * You should now see a trace |
350 | |
d1f19ac5 |
351 | * Use text mode LTTng to control tracing |
352 | |
5e5b1de1 |
353 | The tracing can be controlled from a terminal by using the lttctl command (as |
354 | root). |
d1f19ac5 |
355 | |
356 | Start tracing : |
357 | |
29f07f68 |
358 | lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace |
d1f19ac5 |
359 | |
360 | Stop tracing and destroy trace channels : |
361 | |
362 | lttctl -n trace -R |
363 | |
364 | see lttctl --help for details. |
365 | |
366 | |
6c913994 |
367 | * Use text mode LTTV |
368 | |
369 | Fell free to look in /usr/local/lib/lttv/plugins to see all the text and |
370 | graphical plugins available. |
371 | |
372 | For example, a simple trace dump in text format is available with : |
373 | |
374 | lttv -m textDump -t /tmp/trace |
375 | |
376 | see lttv -m textDump --help for detailed command line options of textDump. |
377 | |
378 | |
379 | |
380 | |
381 | *********************************************************** |
382 | ** Section 4 * Adding new instrumentations with genevent ** |
383 | *********************************************************** |
d9cd3a2e |
384 | |
385 | * Getting and installing genevent |
386 | |
cb598ad7 |
387 | su - |
d9cd3a2e |
388 | cd /usr/src |
3c3abcf1 |
389 | wget http://ltt.polymtl.ca/packages/genevent-0.xx.tar.gz |
390 | gzip -cd genevent-0.xx.tar.gz | tar xvof - |
391 | cd genevent-0.xx |
d9cd3a2e |
392 | make |
393 | make install |
394 | |
395 | |
396 | * Add new events to the kernel with genevent |
397 | |
398 | su - |
399 | cd /usr/local/share/LinuxTraceToolkitViewer/facilities |
400 | cp process.xml yourfacility.xml |
401 | * edit yourfacility.xml to fit your needs. |
402 | cd /tmp |
81685107 |
403 | /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/facilities/yourfacility.xml |
d9cd3a2e |
404 | cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \ |
620920a8 |
405 | /usr/src/linux-2.6.17-lttng-0.x.xx8/include/linux/ltt |
d9cd3a2e |
406 | cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \ |
620920a8 |
407 | /usr/src/linux-2.6.17-lttng-0.x.xx/ltt |
d9cd3a2e |
408 | * edit the kernel file you want to instrument |
409 | - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning |
410 | of the file. |
411 | - Add a call to the tracing functions. See their names and parameters in |
620920a8 |
412 | /usr/src/linux-2.6.17-lttng-0.x.xx/include/linux/ltt/ltt-facility-yourfacility.h |
d9cd3a2e |
413 | |
208a5623 |
414 | * Add new events to userspace programs with genevent |
415 | See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART |
416 | |
417 | |
d9cd3a2e |
418 | |
419 | |