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 | |
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 |
21 | and lttng-modules, please refer to : |
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 |
2a4c796f |
39 | ARM |
285468d4 |
40 | C2 Microsystems (variant of MIPS) |
c96be0d0 |
41 | |
42 | LTTV : |
43 | supported architectures : |
44 | Intel i386 and better |
d21695ed |
45 | Intel 64 bits |
c96be0d0 |
46 | PowerPC |
47 | |
48 | |
49 | |
af88bd8a |
50 | Author : Mathieu Desnoyers, September 2005 |
285468d4 |
51 | Last update : April 29, 2006 |
d9cd3a2e |
52 | |
6c913994 |
53 | |
54 | *********************************************************** |
55 | ** Section 1 * Installation from Debian or RPM packages ** |
56 | *********************************************************** |
57 | |
d21695ed |
58 | ** NOTE : RPM and debian packages are only made once a version has been |
59 | thoroughly tested. If they do not exist at the moment, please install from |
d5118964 |
60 | sources (see section 2 below). To see the list of compatibilities between |
3c3abcf1 |
61 | LTTng, ltt-control, LTTV, genevent and lttng-modules, please refer to |
d5118964 |
62 | http://ltt.polymtl.ca > LTTng+LTTV versions compatibility |
d21695ed |
63 | |
64 | |
c1298250 |
65 | * Install from RPM packages on Fedora Core 4 : |
66 | |
67 | Get LTTV RPM from : |
68 | |
69 | http://ltt.polymtl.ca/packages/fedora/RPMS |
70 | |
8c7a7394 |
71 | LTTV RPM are ready. |
72 | |
73 | LTTng kernel and lttng-modules RPM are available for some architectures (i586, |
74 | i686). Feel free to help fix the spec files to have correct lttng-modules RPM |
75 | package. |
c1298250 |
76 | |
77 | |
78 | * Install from Deb packages on Debian : |
6a2c1aed |
79 | |
80 | You can use the ltt.polymtl.ca apt source to get LTTV for Debian : |
81 | |
82 | Add the following two sources to your /etc/apt/sources.list : |
83 | |
84 | deb http://ltt.polymtl.ca/packages/debian experimental main |
85 | deb-src http://ltt.polymtl.ca/packages/debian experimental main |
86 | |
5694ce4d |
87 | |
88 | * Install from precompiled binary packages (LTTV compiled only for i386, and |
89 | LTTng only for i686 smp), perform the following : |
6a2c1aed |
90 | |
91 | su - |
92 | apt-get update |
93 | apt-get install lttv lttv-doc |
8c7a7394 |
94 | apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.2 |
95 | apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.2 |
6a2c1aed |
96 | * note : the packages are signed by myself. I am not considered a trusted |
97 | Debian source yet, so warnings are normal. |
98 | |
5694ce4d |
99 | Then, follow the section "Editing the system wide configuration" in section 2. |
100 | |
101 | * Create custom LTTV Debian packages |
102 | |
103 | Binary packages are only available for i386. If you want to create your own LTTV |
104 | packages for other platforms, do : |
6a2c1aed |
105 | |
5694ce4d |
106 | su - |
107 | cd /usr/src |
78d521e3 |
108 | apt-get source lttv |
8c7a7394 |
109 | cd lttv-0.6.9 |
78d521e3 |
110 | dpkg-buildpackage -rfakeroot |
111 | |
5694ce4d |
112 | You should then have your LTTV .deb files created for your architecture. |
113 | |
114 | * Create custom LTTng packages |
115 | |
116 | For building LTTng Debian packages : |
117 | |
118 | su - |
8c7a7394 |
119 | apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
120 | cd /usr/src |
8c7a7394 |
121 | bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof - |
122 | cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
123 | make menuconfig (or xconfig or config) (customize your configuration) |
124 | make-kpkg kernel_image |
125 | |
126 | You will then see your freshly created .deb in /usr/src. Install it with |
127 | dpkg -i /usr/src/(image-name).deb |
128 | |
129 | You will also need to create a package for the lttng-modules : |
130 | |
131 | su - |
132 | cd /usr/src |
133 | apt-get source lttng-modules |
8c7a7394 |
134 | cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 |
5694ce4d |
135 | make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image |
136 | |
137 | You will then see your freshly created .deb in /usr/src. Install it with |
138 | dpkg -i /usr/src/lttng-modules-modules-(your version).deb |
139 | |
6c913994 |
140 | |
5694ce4d |
141 | Then, follow the section "Editing the system wide configuration" in section 2. |
6c913994 |
142 | |
143 | |
144 | *********************************************************** |
145 | ** Section 2 * Installation from sources ** |
146 | *********************************************************** |
147 | |
38e8e662 |
148 | * Prerequisites |
149 | |
150 | Tools needed to follow the package download steps : |
151 | |
152 | o wget |
153 | o bzip2 |
154 | o gzip |
155 | o tar |
156 | |
157 | You have to install the standard development librairies and programs necessary |
158 | to compile a kernel : |
159 | |
160 | (from Documentation/Changes in the Linux kernel tree) |
161 | o Gnu C 2.95.3 # gcc --version |
162 | o Gnu make 3.79.1 # make --version |
163 | o binutils 2.12 # ld -v |
164 | o util-linux 2.10o # fdformat --version |
165 | o module-init-tools 0.9.10 # depmod -V |
166 | |
167 | You might also want to have libncurses5 to have the text mode kernel |
168 | configuration menu, but there are alternatives. |
169 | |
3c3abcf1 |
170 | Prerequisites for LTTV 0.x.x installation are : |
38e8e662 |
171 | |
860c0a03 |
172 | gcc 3.2 or better |
173 | gtk 2.4 or better development libraries |
174 | (Debian : libgtk2.0, libgtk2.0-dev) |
175 | (Fedora : gtk2, gtk2-devel) |
176 | note : For Fedora users : this might require at least core 3 from Fedora, |
177 | or you might have to compile your own GTK2 library. |
178 | glib 2.4 or better development libraries |
179 | (Debian : libglib2.0-0, libglib2.0-dev) |
180 | (Fedora : glib2, glib2-devel) |
181 | libpopt development libraries |
182 | (Debian : libpopt0, libpopt-dev) |
183 | (Fedora : popt) |
184 | libpango development libraries |
185 | (Debian : libpango1.0, libpango1.0-dev) |
186 | (Fedora : pango, pango-devel) |
187 | libc6 development librairies |
188 | (Debian : libc6, libc6-dev) |
189 | (Fedora : glibc, glibc) |
38e8e662 |
190 | |
191 | |
d9cd3a2e |
192 | * Getting the LTTng packages |
193 | |
194 | su - |
195 | mkdir /usr/src/lttng |
196 | cd /usr/src/lttng |
197 | (see http://ltt.polymtl.ca/lttng for package listing) |
9c78dc8f |
198 | wget http://ltt.polymtl.ca/lttng/lttng-modules-0.5.tar.bz2 |
3c3abcf1 |
199 | wget http://ltt.polymtl.ca/lttng/patch-2.6.15-lttng-0.x.xx.tar.bz2 |
200 | bzip2 -cd lttng-modules-0.x.tar.bz2 | tar xvof - |
201 | bzip2 -cd patch-2.6.15-lttng-0.x.xx.tar.bz2 | tar xvof - |
d9cd3a2e |
202 | |
203 | |
204 | * Getting LTTng kernel sources |
205 | |
206 | su - |
207 | cd /usr/src |
80f4d0e1 |
208 | wget http://kernel.org/pub/linux/kernel/v2.6/testing/linux-2.6.15.tar.bz2 |
209 | bzip2 -cd linux-2.6.15.tar.bz2 | tar xvof - |
210 | cd linux-2.6.15 |
3c3abcf1 |
211 | cat /usr/src/lttng/patch-2.6.15-lttng-0.x.xx* | patch -p1 |
d9cd3a2e |
212 | cd .. |
3c3abcf1 |
213 | mv linux-2.6.15 linux-2.6.15-lttng-0.x.xx |
d9cd3a2e |
214 | |
215 | |
216 | * Installing a LTTng kernel |
217 | |
218 | su - |
3c3abcf1 |
219 | cd /usr/src/linux-2.6.15-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 |
d21695ed |
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 |
8ede3ed9 |
247 | make install |
916ec268 |
248 | |
d9cd3a2e |
249 | reboot |
250 | |
3c3abcf1 |
251 | Select the Linux 2.6.15-lttng-0.x.xx kernel in your boot loader. |
38e8e662 |
252 | |
d9cd3a2e |
253 | |
254 | * Install the ltt-modules |
255 | |
256 | su - |
3c3abcf1 |
257 | cd /usr/src/lttng/lttng-modules-0.xx |
258 | KERNELDIR=/usr/src/linux-2.6.15-lttng-0.x.xx make |
259 | KERNELDIR=/usr/src/linux-2.6.15-lttng-0.x.xx make modules_install |
d9cd3a2e |
260 | |
5694ce4d |
261 | |
262 | * Editing the system wide configuration |
263 | |
264 | You must activate relayfs and specify a mount point. This is typically done in |
265 | fstab such that it happens at boot time. |
266 | |
267 | If you have never used RelayFS before, these operation would do this for you : |
268 | |
269 | mkdir /mnt/relayfs |
270 | cp /etc/fstab /etc/fstab.lttng.bkp |
271 | echo "relayfs /mnt/relayfs relayfs rw 0 0" >> /etc/fstab |
272 | |
273 | then, rebooting or issuing the following command will activate relayfs : |
274 | |
275 | mount /mnt/relayfs |
276 | |
38e8e662 |
277 | You need to load the ltt-control module to be able to control tracing from user |
278 | space. This is done by issuing the command : |
8ede3ed9 |
279 | |
d9cd3a2e |
280 | modprobe ltt-control |
281 | |
9c78dc8f |
282 | If you want to have complete information about the kernel state (including all |
283 | the process names), you need to load the ltt-statedump module. This is done by |
284 | issuing the command : |
285 | |
286 | modprobe ltt-statedump |
287 | |
38e8e662 |
288 | You can automate at boot time loading the ltt-control module by : |
8ede3ed9 |
289 | |
d9cd3a2e |
290 | echo ltt-control >> /etc/modules |
9c78dc8f |
291 | echo ltt-statedump >> /etc/modules |
d9cd3a2e |
292 | |
293 | |
daa38dd5 |
294 | * Getting and installing the ltt-control package (on the traced machine) |
d9cd3a2e |
295 | |
296 | su - |
297 | cd /usr/src |
3c3abcf1 |
298 | wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz |
299 | gzip -cd ltt-control-0.x-xxxx2006.tar.gz | tar xvof - |
300 | cd ltt-control-0.x-xxxx2006 |
daa38dd5 |
301 | (refer to README to see the development libraries that must be installed on you |
302 | system) |
303 | ./configure |
304 | make |
305 | make install |
306 | |
307 | |
308 | * Getting and installing the LTTV package (on the visualisation machine, same or |
309 | different from the visualisation machine) |
310 | |
311 | su - |
312 | cd /usr/src |
3c3abcf1 |
313 | wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz |
314 | gzip -cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz | tar xvof - |
315 | cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006 |
36fcd0b7 |
316 | (refer to README to see the development libraries that must be installed on you |
317 | system) |
d9cd3a2e |
318 | ./configure |
319 | make |
320 | make install |
321 | |
6c913994 |
322 | |
323 | |
324 | |
325 | *********************************************************** |
d1f19ac5 |
326 | ** Section 3 * Using LTTng and LTTV ** |
6c913994 |
327 | *********************************************************** |
328 | |
d1f19ac5 |
329 | * Use graphical LTTV to control tracing and analyse traces |
d9cd3a2e |
330 | |
331 | lttv-gui (or /usr/local/bin/lttv-gui) |
e44b6048 |
332 | - Spot the "Tracing Control" icon : click on it |
333 | (it's a traffic light icon) |
d9cd3a2e |
334 | - enter the root password |
335 | - click "start" |
336 | - click "stop" |
337 | - Yes |
338 | * You should now see a trace |
339 | |
d1f19ac5 |
340 | * Use text mode LTTng to control tracing |
341 | |
5e5b1de1 |
342 | The tracing can be controlled from a terminal by using the lttctl command (as |
343 | root). |
d1f19ac5 |
344 | |
345 | Start tracing : |
346 | |
29f07f68 |
347 | lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace |
d1f19ac5 |
348 | |
349 | Stop tracing and destroy trace channels : |
350 | |
351 | lttctl -n trace -R |
352 | |
353 | see lttctl --help for details. |
354 | |
355 | |
6c913994 |
356 | * Use text mode LTTV |
357 | |
358 | Fell free to look in /usr/local/lib/lttv/plugins to see all the text and |
359 | graphical plugins available. |
360 | |
361 | For example, a simple trace dump in text format is available with : |
362 | |
363 | lttv -m textDump -t /tmp/trace |
364 | |
365 | see lttv -m textDump --help for detailed command line options of textDump. |
366 | |
367 | |
368 | |
369 | |
370 | *********************************************************** |
371 | ** Section 4 * Adding new instrumentations with genevent ** |
372 | *********************************************************** |
d9cd3a2e |
373 | |
374 | * Getting and installing genevent |
375 | |
cb598ad7 |
376 | su - |
d9cd3a2e |
377 | cd /usr/src |
3c3abcf1 |
378 | wget http://ltt.polymtl.ca/packages/genevent-0.xx.tar.gz |
379 | gzip -cd genevent-0.xx.tar.gz | tar xvof - |
380 | cd genevent-0.xx |
d9cd3a2e |
381 | make |
382 | make install |
383 | |
384 | |
385 | * Add new events to the kernel with genevent |
386 | |
387 | su - |
388 | cd /usr/local/share/LinuxTraceToolkitViewer/facilities |
389 | cp process.xml yourfacility.xml |
390 | * edit yourfacility.xml to fit your needs. |
391 | cd /tmp |
81685107 |
392 | /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/facilities/yourfacility.xml |
d9cd3a2e |
393 | cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \ |
3c3abcf1 |
394 | /usr/src/linux-2.6.15-lttng-0.x.xx8/include/linux/ltt |
d9cd3a2e |
395 | cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \ |
3c3abcf1 |
396 | /usr/src/linux-2.6.15-lttng-0.x.xx/ltt |
d9cd3a2e |
397 | * edit the kernel file you want to instrument |
398 | - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning |
399 | of the file. |
400 | - Add a call to the tracing functions. See their names and parameters in |
3c3abcf1 |
401 | /usr/src/linux-2.6.15-lttng-0.x.xx/include/linux/ltt/ltt-facility-yourfacility.h |
d9cd3a2e |
402 | |
403 | |
404 | |