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.dorsal.polymtl.ca (project: ust)
  11   * Git:      git://git.dorsal.polymtl.ca/git/ust.git
  12
  13
  14
  15 PREREQUISITES:
  16
  17   - liburcu
  18     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
  19
  20     -> This release was tested with liburcu v0.4.3
  21
  22       * Debian/Ubuntu package: liburcu-dev
  23       * Website:  http://lttng.org/urcu
  24       * Releases: http://lttng.org/files/urcu
  25       * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
  26       * Git:      git://lttng.org/userspace-rcu.git
  27
  28
  29 INSTALLATION INSTRUCTIONS:
  30
  31   - Download, compile and install liburcu.
  32   - In this package's tree, run ./configure.
  33   - Run make.
  34   - Run make install.
  35   - Run ldconfig.
  36   - See the manual for usage instructions.
  37
  38
  39
  40 TRACE VIEWER:
  41
  42   LTTV is used for viewing UST traces. LTTV may be obtained at
  43   http://lttng.org in the Downloads section.
  44
  45   This release has been tested with LTTV 0.12.30.
  46
  47
  48 PACKAGE CONTENTS:
  49
  50   This package contains the following elements.
  51
  52   - libust
  53     The actual userspace tracing library that must be linked to the
  54     instrumented programs.
  55
  56   - ustctl
  57     A program to control the tracing of userspace applications. It can list
  58     markers, start the tracing, stop the tracing, enable/disable markers, etc.
  59
  60   - include
  61     The public header files that will be installed on the system.
  62
  63   - ustd
  64     The daemon that collects trace data and writes it to the disk.
  65
  66   - doc
  67     The documentation.
  68
  69   - tests
  70     Various test programs
  71
  72   - libustinstr-malloc
  73     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
  74     in any program without need to recompile it.
  75
  76   - libustfork
  77     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
  78     calls in order to trace across these calls.
  79
  80   - libustcmd
  81     A library to control tracing in other processes. Used by ustctl.
  82
  83   - libustcomm
  84     A static library shared between libust, ustd and libustcmd, that provides
  85     functions that allow these components to communicate together.
  86
  87   - snprintf
  88     An asynchronous signal-safe version of snprintf.
  89
  90   - java
  91     A simple library that uses JNI to allow tracing in java programs.