X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=trunk%2Flttv%2FQUICKSTART.html;h=6c6abb54506256b189d37384693955085d4c79f7;hb=47e2b1954d6c6af938e4b8285db2953002049e48;hp=98079c7accc37a1a67e39b68a7d161def55ecb8a;hpb=df7f63ab9e7699a88909ba141753bdaf90b95df6;p=lttv.git diff --git a/trunk/lttv/QUICKSTART.html b/trunk/lttv/QUICKSTART.html index 98079c7a..6c6abb54 100644 --- a/trunk/lttv/QUICKSTART.html +++ b/trunk/lttv/QUICKSTART.html @@ -1,14 +1,15 @@ - Linux Trace Toolkit Quickstart + Linux Trace Toolkit Next Generation User Documentation -

Linux Trace Toolkit Quickstart

Linux Trace Toolkit Next Generation User Documentation

Author : Mathieu Desnoyers, September 2005
Last update : January 21st, 2009
+(originally known as the LTTng QUICKSTART guide)

Introduction
Installing LTTng and LTTV from sources

Prerequisistes

Getting the LTTng packages

Getting the LTTng kernel sources

Installing a LTTng kernel

Editing the system wide +configuration +
Getting and installing the +ltt-control package

Userspace Tracing

Getting and installing the LTTV package

Using LTTng and LTTV
Adding kernel and user-space -tracepoints

Adding kernel instrumentation
Adding userspace instrumentation

Creating Debian and RPM packages from LTTV @@ -47,7 +64,7 @@ The lttng patch is necessary to have the tracing hooks in the kernel.

Supported architectures : -
+br> LTTng :
x86 32/64 bits
PowerPC 32 and 64 bits @@ -65,10 +82,10 @@ the LTTng traces and the LTTV analysis tool.
-
Installation from sources
+
Installation from sources

-
Prerequisites

Prerequisites

Tools needed to follow the package download steps : @@ -129,7 +146,7 @@ href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibilit versions compatibility. -

Getting the LTTng packages

Getting the LTTng packages

 su -
@@ -141,7 +158,7 @@ bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 | tar xvof -

Getting LTTng kernel sources

Getting LTTng kernel sources

 su -
@@ -157,7 +174,7 @@ mv linux-2.6.X linux-2.6.X-lttng-0.x.xx

Installing a LTTng kernel

Installing a LTTng kernel

 su -
@@ -214,7 +231,8 @@ Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.
 --

Editing the system wide configuration

Editing the system wide +configuration

You must activate debugfs and specify a mount point. This is typically done in @@ -289,7 +307,9 @@ echo trap-trace >> /etc/modules #echo lockdep-trace >> /etc/modules -

Getting and installing the ltt-control package (on the traced machine)

Getting and installing the +ltt-control package (on the traced machine)

(note : the ltt-control package contains lttd and lttctl. Although it has the same name as the ltt-control kernel module, they are *not* the same thing.) @@ -307,7 +327,7 @@ make make install -

Userspace tracing

Userspace tracing

 Make sure you selected the kernel menuconfig option :
@@ -323,8 +343,9 @@ channel : userspace
 event name : event

Getting and installing the LTTV package (on the visualisation machine, same -or different from the visualisation machine)

Getting and installing the LTTV package +(on the visualisation machine, same +or different from the visualisation machine)

 su -
@@ -339,16 +360,10 @@ make
 make install

Getting and installing the markers-userspace package for user space -tracing (experimental)

-See markers-userspace-0.5.tar.bz2 or more recent. -

Using LTTng and LTTV

IMPORTANT : Arm Linux Kernel Markers after each boot

@@ -445,42 +460,79 @@ lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3
 lttctl -D -w /tmp/trace3 trace3

Adding new instrumentations with the +markers

+ +

Adding kernel +instrumentation

+See Documentation/markers.txt +and Documentation/tracepoints.txt in your kernel tree. +

+Also see ltt/probes/ +for LTTng probe examples. + +

Adding userspace instrumentation

Add new events to userspace programs with +userspace markers packages

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. +See markers-userspace-0.5.tar.bz2 or more recent. -*********************************************************** -** Section 5 * Creating Debian or RPM packages ** -*********************************************************** +

+Note that a new design document for a 3rd generation of tracepoint/marker-based +userspace tracing is available at LTTng User-space Tracing +Design". This new infrastructure is not yet implemented. -* Create custom LTTV Debian packages +

+The easy quick-and-dirty way to perform userspace tracing is currently to write +an string to /mnt/debugfs/ltt/write_event. See Userspace tracing in the +installation for sources section of this document. -Use : dpkg-buildpackage -rfakeroot +

Creating Debian or RPM packages

-* Create custom LTTng packages +

Create custom LTTV Debian packages

+Use : dpkg-buildpackage -rfakeroot
+

+You should then have your LTTV .deb files created for your architecture. -Get the build tree with patches applies as explained in section 2. +

Create custom LTTng packages

+For building LTTng Debian packages : +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
-
+

Then, follow the section "Editing the system wide configuration" in section 2.

Linux Trace Toolkit Quickstart

Linux Trace Toolkit Next Generation User Documentation

Table of Contents