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