README

   1 LTTNG USERSPACE TRACER (UST)
   2 ----------------------------
   3
   4 UST web site and manual: http://lttng.org/ust
   5
   6 Updated versions of this package may be found at:
   7
   8   * Website:  http://lttng.org/ust
   9   * Releases: http://lttng.org/files/ust/releases
  10   * GitWeb:   http://git.lttng.org (project: ust)
  11   * Git:      git://git.lttng.org/ust.git
  12
  13
  14 PREREQUISITES:
  15
  16   - liburcu
  17     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
  18
  19     -> This release depends on liburcu v0.6.6
  20
  21       * Debian/Ubuntu package: liburcu-dev
  22       * Website:  http://lttng.org/urcu
  23       * Releases: http://lttng.org/files/urcu
  24       * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
  25       * Git:      git://lttng.org/userspace-rcu.git
  26
  27
  28 INSTALLATION INSTRUCTIONS:
  29
  30   - Download, compile and install liburcu.
  31   - In this package's tree, run ./configure.
  32   - Run make.
  33   - Run make install.
  34   - Run ldconfig.
  35   - See the manual for usage instructions.
  36
  37   If compiling from the git repository, run ./bootstrap before running
  38   the configure script, to generate it.
  39
  40
  41 USAGE:
  42
  43   - Create an instrumentation header following the tracepoint examples.
  44     (see tracepoint.h and tests/hello/tp.h).
  45   - Link application with -lust.
  46   - (TODO: start tracing with the "lttng" command from lttng-tools)
  47
  48 ENVIRONMENT VARIABLES:
  49
  50   - liblttng-ust debug can be activated by setting the environment variable
  51     "LTTNG_UST_DEBUG" when launching the application. It can also be enabled
  52     at compile-time by compiling libust with -DLTTNG_UST_DEBUG.
  53
  54   - The environment variable "LTTNG_UST_REGISTER_TIMEOUT" can be used to
  55     specify how long the applications should wait for sessiond
  56     "registration done" command before proceeding to execute the main
  57     program. The default is 3000ms (3 seconds). The timeout value is
  58     specified in milliseconds. The value 0 means "don't wait". The value
  59     -1 means "wait forever".
  60
  61
  62 TRACE VIEWER:
  63
  64   Use babeltrace for viewing traces generated by LTTng UST 2.0.
  65   See http://lttng.org for download.
  66
  67
  68 CONTACT:
  69
  70   Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  71   Mailing list: ltt-dev@lists.casi.polymtl.ca
  72
  73
  74 PACKAGE CONTENTS:
  75
  76   This package contains the following elements.
  77
  78   - liblttng-ust
  79     The actual userspace tracing library that must be linked to the
  80     instrumented programs.
  81
  82   - include
  83     The public header files that will be installed on the system.
  84
  85   - doc
  86     The documentation.
  87
  88   - tests
  89     Various test programs
  90
  91   - liblttng-ust-malloc
  92     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
  93     in any program without need to recompile it.
  94
  95   - liblttng-ust-fork
  96     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
  97     calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
  98     in order to hijack calls. In contrast, libust may be linked at build time.
  99
 100   - liblttng-ust-ctl
 101     A library to control tracing in other processes. Used by lttng-tools.
 102
 103   - liblttng-ust-comm
 104     A static library shared between libust and lttng-tools, that
 105     provides functions that allow these components to communicate together.
 106
 107   - snprintf
 108     An asynchronous signal-safe version of snprintf.
 109
 110   - java
 111     A simple library that uses JNI to allow tracing in java programs.
 112     See java/README for build instructions.