X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=trunk%2Flttv%2FQUICKSTART;h=b5cde25bc6682566ddba9e71d23261c41bd1724a;hb=2947929c601a093a8d00ead108812f4ba6315cf2;hp=a04c24aaa7b69e194681c3af0f8191f50021b023;hpb=d5662043c1570c860ee97af8d6cdd95af95a8c50;p=lttv.git diff --git a/trunk/lttv/QUICKSTART b/trunk/lttv/QUICKSTART index a04c24aa..b5cde25b 100644 --- a/trunk/lttv/QUICKSTART +++ b/trunk/lttv/QUICKSTART @@ -1,7 +1,7 @@ Linux Trace Toolkit Quickstart ------------------------------ Author : Mathieu Desnoyers, September 2005 -Last update : July 31, 2008 +Last update : January 9th, 2009 This document is made of four parts : the first one explains how to install @@ -14,12 +14,12 @@ applications. What you will typically want is to read sections 2 and 3 : install LTTng from sources and use it. -These operations are made for installing the LTTng 0.12 tracer on a linux 2.6.X -kernel. You will also find instructions for installation of LTTV 0.8.x : the +These operations are made for installing the LTTng 0.74 tracer on a linux 2.6.X +kernel. You will also find instructions for installation of LTTV 0.12.x : the Linux Trace Toolkit Viewer. -To see the list of compatibilities between LTTng, ltt-control, LTTV, genevent -and ltt-usertrace, please refer to : +To see the list of compatibilities between LTTng, ltt-control, LTTV and +markers-userspace, please refer to : http://ltt.polymtl.ca > LTTng+LTTV versions compatibility @@ -53,59 +53,9 @@ PowerPC 32 and 64 bits ** Section 1 * Installation from Debian or RPM packages ** *********************************************************** -** NOTE : RPM and Debian packages are only made once a version has been - thoroughly tested. If they do not exist at the moment, please install from - sources (see section 2 below). To see the list of compatibilities between - LTTng, ltt-control, LTTV, genevent and lttng-modules, please refer to - http://ltt.polymtl.ca > LTTng+LTTV versions compatibility - - -* Install from RPM packages on Fedora Core 4 : - -Get LTTV RPM from : - -http://ltt.polymtl.ca/packages/fedora/RPMS - -LTTV RPM are ready. - -LTTng kernel and lttng-modules RPM are available for some architectures (i586, -i686). Feel free to help fix the spec files to have correct lttng-modules RPM -package. - - -* Install from .deb packages on Debian : - -You can use the ltt.polymtl.ca apt source to get LTTV for Debian : - -Add the following two sources to your /etc/apt/sources.list : - -deb http://ltt.polymtl.ca/packages/debian experimental main -deb-src http://ltt.polymtl.ca/packages/debian experimental main - - -* Install from precompiled binary packages (LTTV compiled only for i386, and - LTTng only for i686 smp), perform the following : - -su - -apt-get update -apt-get install lttv lttv-doc -apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.2 -apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.2 - * note : the packages are signed by myself. I am not considered a trusted - Debian source yet, so warnings are normal. - -Then, follow the section "Editing the system wide configuration" in section 2. - * Create custom LTTV Debian packages -Binary packages are only available for i386. If you want to create your own LTTV -packages for other platforms, do : - -su - -cd /usr/src -apt-get source lttv -cd lttv-0.6.9 -dpkg-buildpackage -rfakeroot +Use : dpkg-buildpackage -rfakeroot You should then have your LTTV .deb files created for your architecture. @@ -113,29 +63,14 @@ You should then have your LTTV .deb files created for your architecture. For building LTTng Debian packages : -su - -apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 -cd /usr/src -bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof - -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 +Get the build tree with patches applies as explained in section 2. + make menuconfig (or xconfig or config) (customize your configuration) make-kpkg kernel_image You will then see your freshly created .deb in /usr/src. Install it with dpkg -i /usr/src/(image-name).deb -You will also need to create a package for the lttng-modules : - -su - -cd /usr/src -apt-get source lttng-modules -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2 -make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image - -You will then see your freshly created .deb in /usr/src. Install it with -dpkg -i /usr/src/lttng-modules-modules-(your version).deb - - Then, follow the section "Editing the system wide configuration" in section 2. @@ -186,6 +121,13 @@ libc6 development librairies (Debian : libc6, libc6-dev) (Fedora : glibc, glibc) +* Reminder + +See the list of compatibilities between LTTng, ltt-control, LTTV and +markers-userspace at : +http://ltt.polymtl.ca > LTTng+LTTV versions compatibility + + * Getting the LTTng packages @@ -223,26 +165,22 @@ make menuconfig (or make xconfig or make config) Items preceded by [ ] means they should be removed. go to the "General setup" section Select the following options : - [*] Activate tracepoints + [*] Prompt for development and/or incomplete code/drivers [*] Activate markers - [*] Activate userspace markers ABI - <*> Compile generic tracing probes - Linux Trace Toolkit ---> - [LTTng fine-grained-timestamping] - [*] Linux Trace Toolkit Instrumentation Support - or <*> Linux Trace Toolkit Relay+DebugFS Support + [*] Activate userspace markers ABI (experimental, optional) + [*] Immediate value optimization (optional) + [*] Linux Trace Toolkit Next Generation (LTTng) ---> + or <*> Compile lttng tracing probes + or <*> Linux Trace Toolkit High-speed Lockless Data Relay + or <*> Linux Trace Toolkit Lock-Protected Data Relay or <*> Linux Trace Toolkit Serializer - or <*> Linux Trace Toolkit Marker Control - or <*> Linux Trace Toolkit Tracer - It makes no difference for the rest of the procedure whether the Tracer - is compiled built-in or as a module. - activate : - [*] Align Linux Trace Toolkit Traces - Linux Trace Toolkit Netlink Controller - Linux Trace Toolkit State Dump - your choice (see < Help >) : - [ ] Write heartbeat event to shrink traces - [ ] Support trace extraction from crash dump + or <*> Linux Trace Toolkit Marker Control + or <*> Linux Trace Toolkit Tracer + [*] Align Linux Trace Toolkit Traces + or <*> Support logging events from userspace + [*] Support trace extraction from crash dump + or <*> Linux Trace Toolkit Trace Controller + or <*> Linux Trace Toolkit State Dump Select Select Select @@ -254,7 +192,7 @@ make modules_install -- on X86, X86_64 make install reboot -Select the Linux 2.6.17-lttng-0.x.xx kernel in your boot loader. +Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader. -- on PowerPC cp vmlinux.strip /boot/vmlinux-2.6.X-lttng-0.x.xx @@ -267,7 +205,7 @@ that comes first is the default kernel) ybin select the right entry at the yaboot prompt (see choices : tab, select : type the kernel name followed by enter) -Select the Linux 2.6.17-lttng-0.x.xx kernel in your boot loader. +Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader. -- @@ -292,7 +230,7 @@ space. This is done by issuing the following commands. Note however these commands load all LTT modules. Depending on what options you chose to compile statically, you may not need to issue all these commands. -modprobe ltt-control +modprobe ltt-trace-control modprobe ltt-marker-control modprobe ltt-tracer modprobe ltt-serialize @@ -302,6 +240,12 @@ modprobe kernel-trace modprobe mm-trace modprobe net-trace modprobe fs-trace +modprobe jbd2-trace +modprobe ext4-trace +modprobe syscall-trace +modprobe trap-trace +#if locking tracing is wanted, uncomment the following +#modprobe lockdep-trace If you want to have complete information about the kernel state (including all the process names), you need to load the ltt-statedump module. This is done by @@ -312,7 +256,7 @@ modprobe ltt-statedump You can automate at boot time loading the ltt-control module by : cp /etc/modules /etc/modules.bkp -echo ltt-control >> /etc/modules +echo ltt-trace-control >> /etc/modules echo ltt-marker-control >> /etc/modules echo ltt-tracer >> /etc/modules echo ltt-serialize >> /etc/modules @@ -322,6 +266,12 @@ echo kernel-trace >> /etc/modules echo mm-trace >> /etc/modules echo net-trace >> /etc/modules echo fs-trace >> /etc/modules +echo jbd2-trace >> /etc/modules +echo ext4-trace >> /etc/modules +echo syscall-trace >> /etc/modules +echo trap-trace >> /etc/modules +#if locking tracing is wanted, uncomment the following +#echo lockdep-trace >> /etc/modules * Getting and installing the ltt-control package (on the traced machine) @@ -330,7 +280,7 @@ same name as the ltt-control kernel module, they are *not* the same thing.) su - cd /usr/src wget http://ltt.polymtl.ca/lttng/ltt-control-0.x-xxxx2006.tar.gz -gzip -cd ltt-control-0.x-xxxx2006.tar.gz | tar xvof - +gzip -cd ltt-control-0.x-xxxx2008.tar.gz | tar xvof - cd ltt-control-0.x-xxxx2006 (refer to README to see the development libraries that must be installed on you system) @@ -338,8 +288,20 @@ system) make make install -* Getting and installing the markers-userspace package for user space tracing -See http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2 or more recent. + +* Userspace tracing + +Make sure you selected the kernel menuconfig option : + or <*> Support logging events from userspace +And that the ltt-userspace-event kernel module is loaded if selected as a +module. + +Simple userspace tracing is available through +echo "some text to record" > /mnt/debugfs/ltt/write_event + +It will appear in the trace under event : +channel : userspace +event name : event * Getting and installing the LTTV package (on the visualisation machine, same or @@ -347,9 +309,9 @@ See http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2 or more recent. su - cd /usr/src -wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz -gzip -cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006.tar.gz | tar xvof - -cd LinuxTraceToolkitViewer-0.x.xx-xxxx2006 +wget http://ltt.polymtl.ca/packages/lttv-0.x.xx-xxxx2008.tar.gz +gzip -cd lttv-0.x.xx-xxxx2008.tar.gz | tar xvof - +cd lttv-0.x.xx-xxxx2008 (refer to README to see the development libraries that must be installed on your system) ./configure @@ -357,13 +319,17 @@ make make install +* Getting and installing the markers-userspace package for user space tracing +(experimental) +See http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2 or more recent. + *********************************************************** ** Section 3 * Using LTTng and LTTV ** *********************************************************** -* Arm Linux Kernel Markers after each boot +* IMPORTANT : Arm Linux Kernel Markers after each boot ltt-armall @@ -385,18 +351,19 @@ root). Start tracing : -lttctl -n trace -d -l /mnt/debugfs/ltt -t /tmp/trace +lttctl -C -w /tmp/trace1 trace1 Stop tracing and destroy trace channels : -lttctl -n trace -R +lttctl -D trace1 see lttctl --help for details. (note : to see if the buffers has been filled, look at the dmesg output after lttctl -R or after stopping tracing from the GUI, it will show an event lost count. If it is the case, try using larger buffers. See lttctl --help to learn -how.) +how. lttv now also shows event lost messages in the console when loading a trace +with missing events or lost subbuffers.) * Use text mode LTTV @@ -429,79 +396,37 @@ flight recorder buffer (now named flight-channelname_X). The following lttctl commands take an hybrid trace : Create trace channel, start lttd on normal channels, start tracing: -lttctl -n tracename -d -l /mnt/relayfs/ltt -t /tmp/trace1 -m hybrid +lttctl -C -w /tmp/trace2 -o channel.kernel.overwrite=1 trace2 Stop tracing, start lttd on flight recorder channels, destroy trace channels : -lttctl -n tracename -f -l /mnt/relayfs/ltt -t /tmp/trace1 -m hybrid +lttctl -D -w /tmp/trace2 trace2 - -We will need to tweak what we consider "important" medium rate events. For -instance, thread branding events are actually considered a "high rate" event -when it should be considered "medium rate". The same should apply for the -state dump process enumeration. +Each "overwrite" channel is flight recorder channel. * Flight recorder mode The flight recorder mode writes data into overwritten buffers for all channels, -including control channels, except for the facilities tracefiles. +including control channels, except for the facilities tracefiles. It consists of +setting all channels to "overwrite". The following lttctl commands take a flight recorder trace : -lttctl -n trace -c -m flight -lttd -n -d -t /tmp/trace -c /sys/kernel/debug/ltt -lttctl -n trace -s -.. do stuff -lttctl -n trace -q -lttd -f -d -t /tmp/trace -c /sys/kernel/debug/ltt -lttctl -m trace -r +lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3 +... +lttctl -D -w /tmp/trace3 trace3 -*********************************************************** -** Section 4 * Adding new instrumentations with genevent ** -*********************************************************** +************************************************************** +** Section 4 * Adding new instrumentations with the markers ** +************************************************************** -* Getting and installing genevent - -su - -cd /usr/src -wget http://ltt.polymtl.ca/packages/genevent-0.xx.tar.gz -gzip -cd genevent-0.xx.tar.gz | tar xvof - -cd genevent-0.xx -make -make install +See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel +tree. +* Add new events to userspace programs with userspace markers +http://ltt.polymtl.ca/packages/ -* Add new events to the kernel with genevent (deprecated in LTTng 0.9.x) +Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It +allows inserting markers in executables and libraries, currently only on x86_32 +and x86_64. -su - -cd /usr/local/share/ltt-control/facilities -cp process.xml yourfacility.xml - * edit yourfacility.xml to fit your needs. -cd /tmp -/usr/local/bin/genevent /usr/local/share/ltt-control/facilities/yourfacility.xml -cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \ - /usr/src/linux-2.6.17-lttng-0.x.xx8/include/ltt -cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \ - /usr/src/linux-2.6.17-lttng-0.x.xx/ltt/facilities - * edit the kernel file you want to instrument to add a marker to it. See - include/linux/marker.h. - * create a dynamically loadable probe. See ltt/probes for examples. The probe - will be connected to your marker and will typically call the logging - functions found in the header file you created with genevent. - -* Add new kernel events - -*Important* note : in its current state, LTTng and LTTV needs the programmer -to keep the marker/probe format string and the XML description of the -event data types in sync by hand. Failure to do so will result in errors in -LTTV. - -See the markers documentation to see how to describe the marker. You will need -to clone probe modules found in ltt/probes to connect them to the markers so -that the information can be recorded in the trace. - -* Add new events to userspace programs with genevent -See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART - -User-space tracing still uses genevent, which is subject to change in a near -future.