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