Commit | Line | Data |
---|---|---|
c924c2c6 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
f6e6ee82 | 4 | <title>Linux Trace Toolkit Next Generation Manual</title> |
c924c2c6 | 5 | </head> |
6 | <body> | |
7 | ||
f6e6ee82 | 8 | <h1>Linux Trace Toolkit Next Generation Manual</h1> |
c924c2c6 | 9 | |
c924c2c6 | 10 | Author : Mathieu Desnoyers, September 2005<br> |
24070967 | 11 | Last update : January 21st, 2009<br> |
bc58079d | 12 | (originally known as the LTTng QUICKSTART guide) |
24070967 | 13 | |
14 | <h2>Table of Contents</h2> | |
24070967 | 15 | |
d58b406f | 16 | <ul> |
f9ff56f3 | 17 | <li><a href="#intro" name="TOCintro">Introduction</a></li> |
7e77d1a9 | 18 | <ul> |
19 | <li><a href="#arch" name="TOCarch">Supported architectures</a></li> | |
20 | </ul> | |
d58b406f | 21 | |
24070967 | 22 | <li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from |
6f88b01d | 23 | sources</a></li> |
38b04cd7 | 24 | <ul> |
2d540155 | 25 | <li><a href="#prerequisites" name="TOCprerequisites">Prerequisistes</li> |
26 | <li><a href="#getlttng" name="TOCgetlttng">Getting the LTTng packages</li> | |
27 | <li><a href="#getlttngsrc" name="TOCgetlttngsrc">Getting the LTTng kernel sources</li> | |
28 | <li><a href="#installlttng" name="TOCinstalllttng">Installing a LTTng kernel</li> | |
6f88b01d | 29 | <li><a href="#editconfig" name="TOCeditconfig">Editing the system wide |
30 | configuration</a> | |
31 | <li><a href="#getlttctl" name="TOCgetlttctl">Getting and installing the | |
2d540155 | 32 | ltt-control package</li> |
33 | <li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</li> | |
6f88b01d | 34 | <li><a href="#getlttv" name="TOCgetlttv">Getting and installing the LTTV package</ul> |
d58b406f | 35 | |
24070967 | 36 | <li><a href="#section2" name="TOCsection2">Using LTTng and LTTV</a></li> |
d58b406f | 37 | <ul> |
38 | <li><a href="#uselttvgui" name="TOCuselttvgui">Use graphical LTTV to control | |
39 | tracing and analyse traces</a></li> | |
40 | <li><a href="#uselttngtext" name="TOCuselttngtext">Use text mode LTTng to | |
f7828b7c | 41 | control tracing</a></li> |
d58b406f | 42 | <li><a href="#uselttvtext" name="TOCuselttvtext">Use text mode LTTV</a></li> |
43 | <li><a href="#hybrid" name="TOChybrid">Tracing in "Hybrid" mode</a></li> | |
44 | <li><a href="#flight" name="TOCflight">Tracing in flight recorder mode</a></li> | |
d58b406f | 45 | </ul> |
46 | ||
24070967 | 47 | <li><a href="#section3" name="TOCsection3">Adding kernel and user-space |
47e2b195 | 48 | instrumentation</a> |
49 | <ul> | |
50 | <li><a href="#kerneltp" name="TOCkerneltp">Adding kernel instrumentation</a></li> | |
51 | <li><a href="#usertp" name="TOCusertp">Adding userspace instrumentation</a></li> | |
52 | </ul> | |
d58b406f | 53 | |
633bc4a3 | 54 | <li><a href="#section4" name="TOCsection4">Creating Debian and RPM packages |
98dde887 | 55 | from LTTV</a></li> |
56 | <ul> | |
57 | <li><a href="#pkgdebian" name="TOCpkgdebian">Create custom LTTV Debian | |
58 | <li><a href="#pkglttng" name="TOCpkglttng">Create custom LTTng packages</a></li> | |
98dde887 | 59 | </ul> |
c924c2c6 | 60 | |
f9ff56f3 | 61 | </ul> |
62 | ||
63 | <hr /> | |
64 | ||
b9e1fab1 | 65 | <h2><a href="#TOCintro" name="intro">Introduction</a></h2> |
c924c2c6 | 66 | <p> |
70a3fc43 | 67 | This document is made of five parts : the first one explains how |
24070967 | 68 | to install LTTng and LTTV from sources, the second one describes the steps |
633bc4a3 | 69 | to follow to trace a system and view it. The third part explains |
c924c2c6 | 70 | briefly how to add a new trace point to the kernel and to user space |
42cf459d | 71 | applications. The fourth and last part explains how to create Debian or RPM |
72 | packages from the LTTng and LTTV sources. | |
c924c2c6 | 73 | <p> |
24070967 | 74 | These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X |
c924c2c6 | 75 | kernel. You will also find instructions for installation of LTTV 0.12.x : the |
76 | Linux Trace Toolkit Viewer. | |
24070967 | 77 | To see the list of compatibilities between LTTng, ltt-control, LTTV, please |
78 | refer to : | |
c924c2c6 | 79 | <a |
80 | href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV versions compatibility</a> | |
534f65eb | 81 | |
82 | The ongoing work had the Linux Kernel Markers integrated in the mainline Linux | |
83 | kernel since Linux 2.6.24 and the Tracepoints since 2.6.28. In its current | |
84 | state, the lttng patchset is necessary to have the trace clocksource, the | |
85 | instrumentation and the LTTng high-speed data extraction mechanism added to the | |
86 | kernel. | |
c924c2c6 | 87 | |
aad04917 MD |
88 | <br> |
89 | <br> | |
90 | <h3><a href="#TOClicense" name="license">Licenses</a></h3> | |
91 | <br> | |
92 | <p> | |
93 | LTTng, UST and LTTV are developed by an open community. LTTng is released under | |
94 | a dual Gnu LGPLv2.1/GPLv2 license, except for very few kernel-specific files | |
95 | which are derived work from the Linux kernel. | |
96 | <p> | |
97 | LTTV is available under the Gnu GPLv2. The low-level LTTV trace reading library | |
98 | is released under Gnu LGPLv2.1. | |
99 | <p> | |
89b751c3 MD |
100 | The UST (Userspace Tracing) and the Userspace RCU libraries are released under |
101 | the LGPLv2.1 license, which allows linking with non-GPL (BSD, proprietary...) | |
102 | applications. The associated headers are released under MIT-style/BSD-style | |
103 | licenses. | |
aad04917 MD |
104 | <p> |
105 | Please refer to each particular file licensing for details. | |
106 | ||
24070967 | 107 | <br> |
108 | <br> | |
7e77d1a9 | 109 | <h3><a href="#TOCarch" name="arch">Supported architectures</a></h3> |
70a3fc43 | 110 | <br> |
c924c2c6 | 111 | LTTng :<br> |
70a3fc43 | 112 | <br> |
c924c2c6 | 113 | <li> x86 32/64 bits |
114 | <li> PowerPC 32 and 64 bits | |
f0fcce6d | 115 | <li> ARMv7 OMAP3 |
116 | <li> Other ARM (with limited timestamping precision, e.g. 1HZ. Need | |
c924c2c6 | 117 | architecture-specific support for better precision) |
118 | <li> MIPS | |
1aeeacdb | 119 | <li> sh (partial architecture-specific instrumentation) |
120 | <li> sparc64 (partial architecture-specific instrumentation) | |
121 | <li> s390 (partial architecture-specific instrumentation) | |
122 | <li> Other architectures supported without architecture-specific instrumentation | |
123 | and with low-resolution timestamps.<br> | |
c924c2c6 | 124 | <br> |
24070967 | 125 | <br> |
c924c2c6 | 126 | LTTV :<br> |
70a3fc43 | 127 | <br> |
c924c2c6 | 128 | <li> Intel 32/64 bits |
129 | <li> PowerPC 32 and 64 bits | |
130 | <li> Possibly others. Takes care of endianness and type size difference between | |
131 | the LTTng traces and the LTTV analysis tool. | |
132 | ||
f9ff56f3 | 133 | <hr /> |
134 | ||
c924c2c6 | 135 | |
89aa576c | 136 | <h2><a href="#TOCsection1" name="section1">Installation from sources</a></h2> |
633bc4a3 | 137 | <p> |
c924c2c6 | 138 | |
6f88b01d | 139 | <h3><a href="#TOCprerequisites" name="prerequisites">Prerequisites</a></h3> |
633bc4a3 | 140 | <ul> |
141 | <p> | |
c924c2c6 | 142 | Tools needed to follow the package download steps : |
143 | ||
633bc4a3 | 144 | <li>wget |
145 | <li>bzip2 | |
146 | <li>gzip | |
147 | <li>tar | |
c924c2c6 | 148 | |
633bc4a3 | 149 | <p> |
c924c2c6 | 150 | You have to install the standard development libraries and programs necessary |
151 | to compile a kernel : | |
152 | ||
84cf5903 | 153 | <PRE> |
c924c2c6 | 154 | (from Documentation/Changes in the Linux kernel tree) |
84cf5903 | 155 | Gnu C 2.95.3 # gcc --version |
156 | Gnu make 3.79.1 # make --version | |
157 | binutils 2.12 # ld -v | |
158 | util-linux 2.10o # fdformat --version | |
159 | module-init-tools 0.9.10 # depmod -V | |
160 | </PRE> | |
c924c2c6 | 161 | |
633bc4a3 | 162 | <p> |
c924c2c6 | 163 | You might also want to have libncurses5 to have the text mode kernel |
164 | configuration menu, but there are alternatives. | |
165 | ||
633bc4a3 | 166 | <p> |
c924c2c6 | 167 | Prerequisites for LTTV 0.x.x installation are : |
168 | ||
84cf5903 | 169 | <PRE> |
170 | gcc 3.2 or better | |
171 | gtk 2.4 or better development libraries | |
c924c2c6 | 172 | (Debian : libgtk2.0, libgtk2.0-dev) |
173 | (Fedora : gtk2, gtk2-devel) | |
174 | note : For Fedora users : this might require at least core 3 from Fedora, | |
175 | or you might have to compile your own GTK2 library. | |
84cf5903 | 176 | glib 2.4 or better development libraries |
c924c2c6 | 177 | (Debian : libglib2.0-0, libglib2.0-dev) |
178 | (Fedora : glib2, glib2-devel) | |
84cf5903 | 179 | libpopt development libraries |
c924c2c6 | 180 | (Debian : libpopt0, libpopt-dev) |
181 | (Fedora : popt) | |
84cf5903 | 182 | libpango development libraries |
c924c2c6 | 183 | (Debian : libpango1.0, libpango1.0-dev) |
184 | (Fedora : pango, pango-devel) | |
84cf5903 | 185 | libc6 development librairies |
c924c2c6 | 186 | (Debian : libc6, libc6-dev) |
187 | (Fedora : glibc, glibc) | |
84cf5903 | 188 | </PRE> |
633bc4a3 | 189 | </ul> |
c924c2c6 | 190 | |
c8997124 | 191 | <li>Reminder</li> |
c924c2c6 | 192 | |
c8997124 | 193 | <p> |
633bc4a3 | 194 | See the list of compatibilities between LTTng, ltt-control and LTTV at : |
195 | <a | |
196 | href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV | |
197 | versions compatibility</a>. | |
c924c2c6 | 198 | |
199 | ||
6f88b01d | 200 | <h3><a href="#TOCgetlttng" name="getlttng">Getting the LTTng packages</a></h3> |
c924c2c6 | 201 | |
c8997124 | 202 | <PRE> |
c924c2c6 | 203 | su - |
204 | mkdir /usr/src/lttng | |
205 | cd /usr/src/lttng | |
206 | (see http://ltt.polymtl.ca/lttng for package listing) | |
207 | wget http://ltt.polymtl.ca/lttng/patch-2.6.X-lttng-0.x.xx.tar.bz2 | |
208 | bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 | tar xvof - | |
c8997124 | 209 | </PRE> |
c924c2c6 | 210 | |
211 | ||
6f88b01d | 212 | <h3><a href="#TOCgetlttngsrc" name="getlttngsrc">Getting LTTng kernel sources</a></h3> |
c924c2c6 | 213 | |
c8997124 | 214 | <PRE> |
c924c2c6 | 215 | su - |
216 | cd /usr/src | |
217 | wget http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.X.tar.bz2 | |
218 | bzip2 -cd linux-2.6.X.tar.bz2 | tar xvof - | |
219 | cd linux-2.6.X | |
220 | - For LTTng 0.9.4- cat /usr/src/lttng/patch*-2.6.X-lttng-0.x.xx* | patch -p1 | |
221 | - For LTTng 0.9.5+ apply the patches in the order specified in the series file, | |
222 | or use quilt | |
223 | cd .. | |
224 | mv linux-2.6.X linux-2.6.X-lttng-0.x.xx | |
c8997124 | 225 | </PRE> |
c924c2c6 | 226 | |
227 | ||
6f88b01d | 228 | <h3><a href="#TOCinstalllttng" name="installlttng">Installing a LTTng kernel</a></h3> |
c924c2c6 | 229 | |
c8997124 | 230 | <PRE> |
c924c2c6 | 231 | su - |
232 | cd /usr/src/linux-2.6.X-lttng-0.x.xx | |
233 | make menuconfig (or make xconfig or make config) | |
234 | Select the < Help > button if you are not familiar with kernel | |
235 | configuration. | |
236 | Items preceded by [*] means they has to be built into the kernel. | |
237 | Items preceded by [M] means they has to be built as modules. | |
238 | Items preceded by [ ] means they should be removed. | |
239 | go to the "General setup" section | |
240 | Select the following options : | |
241 | [*] Prompt for development and/or incomplete code/drivers | |
242 | [*] Activate markers | |
243 | [*] Activate userspace markers ABI (experimental, optional) | |
244 | [*] Immediate value optimization (optional) | |
245 | [*] Linux Trace Toolkit Next Generation (LTTng) ---> | |
246 | <M> or <*> Compile lttng tracing probes | |
247 | <M> or <*> Linux Trace Toolkit High-speed Lockless Data Relay | |
248 | <M> or <*> Linux Trace Toolkit Lock-Protected Data Relay | |
249 | <M> or <*> Linux Trace Toolkit Serializer | |
250 | <M> or <*> Linux Trace Toolkit Marker Control | |
251 | <M> or <*> Linux Trace Toolkit Tracer | |
252 | [*] Align Linux Trace Toolkit Traces | |
253 | <M> or <*> Support logging events from userspace | |
254 | [*] Support trace extraction from crash dump | |
255 | <M> or <*> Linux Trace Toolkit Trace Controller | |
256 | <M> or <*> Linux Trace Toolkit State Dump | |
257 | Select <Exit> | |
258 | Select <Exit> | |
259 | Select <Yes> | |
260 | make | |
261 | make modules_install | |
262 | (if necessary, create a initrd with mkinitrd or your preferate alternative) | |
263 | (mkinitrd -o /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx) | |
264 | ||
265 | -- on X86, X86_64 | |
266 | make install | |
267 | reboot | |
268 | Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader. | |
269 | ||
270 | -- on PowerPC | |
271 | cp vmlinux.strip /boot/vmlinux-2.6.X-lttng-0.x.xx | |
272 | cp System.map /boot/System.map-2.6.X-lttng-0.x.xx | |
273 | cp .config /boot/config-2.6.X-lttng-0.x.xx | |
274 | depmod -ae -F /boot/System.map-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx | |
275 | mkinitrd /boot/initrd.img-2.6.X-lttng-0.x.xx 2.6.X-lttng-0.x.xx | |
276 | (edit /etc/yaboot.conf to add a new entry pointing to your kernel : the entry | |
277 | that comes first is the default kernel) | |
278 | ybin | |
279 | select the right entry at the yaboot prompt (see choices : tab, select : type | |
280 | the kernel name followed by enter) | |
281 | Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader. | |
282 | -- | |
c8997124 | 283 | </PRE> |
c924c2c6 | 284 | |
6f88b01d | 285 | <h3><a href="#TOCeditconfig" name="editconfig">Editing the system wide |
286 | configuration</a></h3> | |
c924c2c6 | 287 | |
c8997124 | 288 | <p> |
c924c2c6 | 289 | You must activate debugfs and specify a mount point. This is typically done in |
c8997124 | 290 | fstab such that it happens at boot time. If you have never used DebugFS before, |
291 | these operation would do this for you : | |
c924c2c6 | 292 | |
c8997124 | 293 | <PRE> |
c924c2c6 | 294 | mkdir /mnt/debugfs |
295 | cp /etc/fstab /etc/fstab.lttng.bkp | |
296 | echo "debugfs /mnt/debugfs debugfs rw 0 0" >> /etc/fstab | |
c8997124 | 297 | </PRE> |
c924c2c6 | 298 | |
c8997124 | 299 | <p> |
c924c2c6 | 300 | then, rebooting or issuing the following command will activate debugfs : |
c8997124 | 301 | <PRE> |
c924c2c6 | 302 | mount /mnt/debugfs |
c8997124 | 303 | </PRE> |
c924c2c6 | 304 | |
c8997124 | 305 | <p> |
c924c2c6 | 306 | You need to load the LTT modules to be able to control tracing from user |
307 | space. This is done by issuing the following commands. Note however | |
308 | these commands load all LTT modules. Depending on what options you chose to | |
309 | compile statically, you may not need to issue all these commands. | |
310 | ||
c8997124 | 311 | <PRE> |
c924c2c6 | 312 | modprobe ltt-trace-control |
313 | modprobe ltt-marker-control | |
314 | modprobe ltt-tracer | |
315 | modprobe ltt-serialize | |
316 | modprobe ltt-relay | |
317 | modprobe ipc-trace | |
318 | modprobe kernel-trace | |
319 | modprobe mm-trace | |
320 | modprobe net-trace | |
321 | modprobe fs-trace | |
322 | modprobe jbd2-trace | |
323 | modprobe ext4-trace | |
324 | modprobe syscall-trace | |
325 | modprobe trap-trace | |
326 | #if locking tracing is wanted, uncomment the following | |
327 | #modprobe lockdep-trace | |
c8997124 | 328 | </PRE> |
c924c2c6 | 329 | |
c8997124 | 330 | <p> |
c924c2c6 | 331 | If you want to have complete information about the kernel state (including all |
332 | the process names), you need to load the ltt-statedump module. This is done by | |
333 | issuing the command : | |
334 | ||
c8997124 | 335 | <PRE> |
c924c2c6 | 336 | modprobe ltt-statedump |
c8997124 | 337 | </PRE> |
338 | <p> | |
c924c2c6 | 339 | You can automate at boot time loading the ltt-control module by : |
340 | ||
c8997124 | 341 | <PRE> |
c924c2c6 | 342 | cp /etc/modules /etc/modules.bkp |
343 | echo ltt-trace-control >> /etc/modules | |
344 | echo ltt-marker-control >> /etc/modules | |
345 | echo ltt-tracer >> /etc/modules | |
346 | echo ltt-serialize >> /etc/modules | |
347 | echo ltt-relay >> /etc/modules | |
348 | echo ipc-trace >> /etc/modules | |
349 | echo kernel-trace >> /etc/modules | |
350 | echo mm-trace >> /etc/modules | |
351 | echo net-trace >> /etc/modules | |
352 | echo fs-trace >> /etc/modules | |
353 | echo jbd2-trace >> /etc/modules | |
354 | echo ext4-trace >> /etc/modules | |
355 | echo syscall-trace >> /etc/modules | |
356 | echo trap-trace >> /etc/modules | |
357 | #if locking tracing is wanted, uncomment the following | |
358 | #echo lockdep-trace >> /etc/modules | |
c8997124 | 359 | </PRE> |
c924c2c6 | 360 | |
6f88b01d | 361 | |
362 | <h3><a href="#TOCgetlttctl" name="getlttctl">Getting and installing the | |
363 | ltt-control package (on the traced machine)</a></h3> | |
c8997124 | 364 | <p> |
c924c2c6 | 365 | (note : the ltt-control package contains lttd and lttctl. Although it has the |
366 | same name as the ltt-control kernel module, they are *not* the same thing.) | |
c8997124 | 367 | |
368 | <PRE> | |
c924c2c6 | 369 | su - |
370 | cd /usr/src | |
371 | wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz | |
372 | gzip -cd ltt-control-0.x-xxxx2008.tar.gz | tar xvof - | |
373 | cd ltt-control-0.x-xxxx2006 | |
374 | (refer to README to see the development libraries that must be installed on you | |
375 | system) | |
376 | ./configure | |
377 | make | |
378 | make install | |
4411682a MD |
379 | # (run ldconfig to ensure new shared objects are taken into account) |
380 | ldconfig | |
c8997124 | 381 | </PRE> |
c924c2c6 | 382 | |
38b04cd7 | 383 | <h3><a href="#TOCuserspacetracing" name="userspacetracing">Userspace tracing</a></h3> |
c924c2c6 | 384 | |
c8997124 | 385 | <PRE> |
c924c2c6 | 386 | Make sure you selected the kernel menuconfig option : |
387 | <M> or <*> Support logging events from userspace | |
388 | And that the ltt-userspace-event kernel module is loaded if selected as a | |
389 | module. | |
390 | ||
391 | Simple userspace tracing is available through | |
392 | echo "some text to record" > /mnt/debugfs/ltt/write_event | |
393 | ||
394 | It will appear in the trace under event : | |
395 | channel : userspace | |
396 | event name : event | |
c8997124 | 397 | </PRE> |
c924c2c6 | 398 | |
6f88b01d | 399 | <h3><a href="#TOCgetlttv" name="getlttv">Getting and installing the LTTV package |
400 | (on the visualisation machine, same | |
401 | or different from the visualisation machine)</a></h3> | |
c924c2c6 | 402 | |
c8997124 | 403 | <PRE> |
c924c2c6 | 404 | su - |
405 | cd /usr/src | |
406 | wget http://ltt.polymtl.ca/packages/lttv-0.x.xx-xxxx2008.tar.gz | |
407 | gzip -cd lttv-0.x.xx-xxxx2008.tar.gz | tar xvof - | |
408 | cd lttv-0.x.xx-xxxx2008 | |
409 | (refer to README to see the development libraries that must be installed on your | |
410 | system) | |
411 | ./configure | |
412 | make | |
413 | make install | |
4411682a MD |
414 | # (run ldconfig to ensure new shared objects are taken into account) |
415 | ldconfig | |
13d7a628 | 416 | </PRE> |
c924c2c6 | 417 | |
c8997124 | 418 | <hr /> |
c924c2c6 | 419 | |
c924c2c6 | 420 | |
89aa576c | 421 | <h2><a href="#TOCsection2" name="section2">Using LTTng and LTTV</a></h2> |
c924c2c6 | 422 | |
d58b406f | 423 | <li><b>IMPORTANT : Arm Linux Kernel Markers after each boot before tracing</b></li> |
c8997124 | 424 | <PRE> |
c924c2c6 | 425 | ltt-armall |
c8997124 | 426 | </PRE> |
c924c2c6 | 427 | |
d58b406f | 428 | <h3><a href="#TOCuselttvgui" name="uselttvgui">Use graphical LTTV to control |
429 | tracing and analyse traces</a></h3> | |
c8997124 | 430 | <PRE> |
c924c2c6 | 431 | lttv-gui (or /usr/local/bin/lttv-gui) |
432 | - Spot the "Tracing Control" icon : click on it | |
433 | (it's a traffic light icon) | |
434 | - enter the root password | |
435 | - click "start" | |
436 | - click "stop" | |
437 | - Yes | |
438 | * You should now see a trace | |
c8997124 | 439 | </PRE> |
c924c2c6 | 440 | |
d58b406f | 441 | <h3><a href="#TOCuselttngtext" name="uselttngtext">Use text mode LTTng to control tracing</a></h3> |
c8997124 | 442 | <PRE> |
c924c2c6 | 443 | The tracing can be controlled from a terminal by using the lttctl command (as |
444 | root). | |
445 | ||
446 | Start tracing : | |
447 | ||
448 | lttctl -C -w /tmp/trace1 trace1 | |
449 | ||
450 | Stop tracing and destroy trace channels : | |
451 | ||
452 | lttctl -D trace1 | |
453 | ||
454 | see lttctl --help for details. | |
df7f63ab | 455 | </PRE> |
c8997124 | 456 | <p> |
c924c2c6 | 457 | (note : to see if the buffers has been filled, look at the dmesg output after |
196f71c4 | 458 | lttctl -D or after stopping tracing from the GUI, it will show an event lost |
c924c2c6 | 459 | count. If it is the case, try using larger buffers. See lttctl --help to learn |
460 | how. lttv now also shows event lost messages in the console when loading a trace | |
461 | with missing events or lost subbuffers.) | |
462 | ||
d58b406f | 463 | <h3><a href="#TOCuselttvtext" name="uselttvtext">Use text mode LTTV</a></h3> |
c8997124 | 464 | <p> |
c924c2c6 | 465 | Feel free to look in /usr/local/lib/lttv/plugins to see all the text and |
466 | graphical plugins available. | |
c8997124 | 467 | <p> |
c924c2c6 | 468 | For example, a simple trace dump in text format is available with : |
c8997124 | 469 | <PRE> |
c924c2c6 | 470 | lttv -m textDump -t /tmp/trace |
c8997124 | 471 | </PRE> |
c8997124 | 472 | <p> |
473 | See lttv -m textDump --help for detailed command line options of textDump. | |
c8997124 | 474 | <p> |
c924c2c6 | 475 | It is, in the current state of the project, very useful to use "grep" on the |
476 | text output to filter by specific event fields. You can later copy the timestamp | |
477 | of the events to the clipboard and paste them in the GUI by clicking on the | |
478 | bottom right label "Current time". Support for this type of filtering should | |
479 | be added to the filter module soon. | |
480 | ||
d58b406f | 481 | <h3><a href="#TOChybrid" name="hybrid">Tracing in "Hybrid" mode</a></h3> |
c8997124 | 482 | <p> |
c924c2c6 | 483 | Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used : |
484 | hybrid. It can be especially useful when studying big workloads on a long period | |
485 | of time. | |
c8997124 | 486 | <p> |
c924c2c6 | 487 | When using this mode, the most important, low rate control information will be |
488 | recorded during all the trace by lttd (i.e. process creation/exit). The high | |
489 | rate information (i.e. interrupt/traps/syscall entry/exit) will be kept in a | |
490 | flight recorder buffer (now named flight-channelname_X). | |
c8997124 | 491 | <p> |
c924c2c6 | 492 | The following lttctl commands take an hybrid trace : |
c8997124 | 493 | <p> |
c924c2c6 | 494 | Create trace channel, start lttd on normal channels, start tracing: |
c8997124 | 495 | <PRE> |
c924c2c6 | 496 | lttctl -C -w /tmp/trace2 -o channel.kernel.overwrite=1 trace2 |
c8997124 | 497 | </PRE> |
498 | <p> | |
c924c2c6 | 499 | Stop tracing, start lttd on flight recorder channels, destroy trace channels : |
c8997124 | 500 | <PRE> |
c924c2c6 | 501 | lttctl -D -w /tmp/trace2 trace2 |
c8997124 | 502 | </PRE> |
503 | <p> | |
c924c2c6 | 504 | Each "overwrite" channel is flight recorder channel. |
505 | ||
d58b406f | 506 | |
507 | <h3><a href="#TOCflight" name="flight">Tracing in flight recorder mode</a></h3> | |
c8997124 | 508 | <li>Flight recorder mode</li> |
c8997124 | 509 | <p> |
c924c2c6 | 510 | The flight recorder mode writes data into overwritten buffers for all channels, |
511 | including control channels, except for the facilities tracefiles. It consists of | |
512 | setting all channels to "overwrite". | |
c8997124 | 513 | <p> |
c924c2c6 | 514 | The following lttctl commands take a flight recorder trace : |
c8997124 | 515 | <PRE> |
c924c2c6 | 516 | lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3 |
517 | ... | |
518 | lttctl -D -w /tmp/trace3 trace3 | |
c8997124 | 519 | </PRE> |
c924c2c6 | 520 | |
89aa576c | 521 | <hr /> |
522 | ||
523 | ||
524 | <h2><a href="#TOCsection3" name="section3">Adding new instrumentations with the | |
525 | markers</a></h2> | |
526 | <p> | |
c924c2c6 | 527 | |
47e2b195 | 528 | <h3><a href="#TOCkerneltp" name="kerneltp">Adding kernel |
529 | instrumentation</a></h3> | |
530 | ||
89aa576c | 531 | <p> |
47e2b195 | 532 | See <a |
533 | href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/markers.txt">Documentation/markers.txt</a> | |
534 | and <a | |
81654ff7 | 535 | href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/trace/tracepoints.txt">Documentation/trace/tracepoints.txt</a> in your kernel |
c924c2c6 | 536 | tree. |
47e2b195 | 537 | <p> |
538 | Also see <a | |
539 | href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=tree;f=ltt/probes">ltt/probes/</a> | |
540 | for LTTng probe examples. | |
541 | ||
542 | <h3><a href="#TOCusertp" name="usertp">Adding userspace instrumentation</a></h3> | |
c924c2c6 | 543 | |
305fd815 | 544 | Add new events to userspace programs with |
545 | <a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a>. | |
c924c2c6 | 546 | Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It |
547 | allows inserting markers in executables and libraries, currently only on x86_32 | |
548 | and x86_64. | |
e01a1ce1 | 549 | See <a |
550 | href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent. | |
551 | ||
38b04cd7 | 552 | <p> |
e01a1ce1 | 553 | Note that a new design document for a 3rd generation of tracepoint/marker-based |
554 | userspace tracing is available at <a | |
555 | href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/ust.html">LTTng User-space Tracing | |
98dde887 | 556 | Design</a>. This new infrastructure is not yet implemented. |
38b04cd7 | 557 | |
558 | <p> | |
559 | The easy quick-and-dirty way to perform userspace tracing is currently to write | |
560 | an string to /mnt/debugfs/ltt/write_event. See <a | |
561 | href="#userspacetracing">Userspace tracing</a> in the | |
562 | installation for sources section of this document. | |
e01a1ce1 | 563 | |
89aa576c | 564 | <hr /> |
633bc4a3 | 565 | |
89aa576c | 566 | <h2><a href="#TOCsection4" name="section4">Creating Debian or RPM packages</a></h2> |
567 | <p> | |
633bc4a3 | 568 | |
98dde887 | 569 | <h3><a href="#TOCpkgdebian" name="pkgdebian">Create custom LTTV Debian packages</a></h3> |
633bc4a3 | 570 | |
89aa576c | 571 | <PRE> |
572 | Use : dpkg-buildpackage -rfakeroot | |
573 | </PRE> | |
574 | <p> | |
633bc4a3 | 575 | You should then have your LTTV .deb files created for your architecture. |
576 | ||
98dde887 | 577 | <h3><a href="#TOCpkglttng" name="pkglttng">Create custom LTTng packages</a></h3> |
89aa576c | 578 | <p> |
633bc4a3 | 579 | For building LTTng Debian packages : |
89aa576c | 580 | get the build tree with patches applies as explained in section 2. |
633bc4a3 | 581 | |
89aa576c | 582 | <PRE> |
633bc4a3 | 583 | make menuconfig (or xconfig or config) (customize your configuration) |
584 | make-kpkg kernel_image | |
89aa576c | 585 | </PRE> |
586 | <p> | |
633bc4a3 | 587 | You will then see your freshly created .deb in /usr/src. Install it with |
89aa576c | 588 | <PRE> |
633bc4a3 | 589 | dpkg -i /usr/src/(image-name).deb |
89aa576c | 590 | </PRE> |
591 | <p> | |
633bc4a3 | 592 | Then, follow the section "Editing the system wide configuration" in section 2. |
593 | ||
70a3fc43 | 594 | <hr /> |
633bc4a3 | 595 | |
c924c2c6 | 596 | </body> |
597 | </html> |