README

   1 LTTng Trace Control
   2 ----------------
   3
   4 Please visit http://lttng.org for more information.
   5
   6 Latest development can be found at:
   7
   8     * Gitweb :  http://git.lttng.org/lttng-tools.git/
   9     * Git :     git://git.lttng.org/lttng-tools.git
  10
  11 REQUIREMENTS:
  12
  13         - Linux kernel >= 2.6.27
  14           pipe2(), epoll_create1() and SOCK_CLOEXEC are needed to run the session
  15           daemon. There were introduce in the Linux 2.6.27
  16
  17     - liburcu
  18       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
  19
  20       -> Tested with liburcu >= v0.7.2
  21
  22       * Debian/Ubuntu package: liburcu-dev
  23       * Git : git://git.lttng.org/userspace-rcu.git
  24       * Website:  http://lttng.org/urcu
  25
  26     - libpopt >= 1.13
  27       Library for parsing command line parameters
  28
  29       * Debian/Ubuntu package: libpopt-dev
  30
  31     - SWIG >= 2.0 (optional)
  32       Needed for Python bindings (--enable-python-bindings).
  33
  34       * Debian/Ubuntu package: swig2.0
  35
  36     - python-dev (optional)
  37       Python headers
  38
  39       * Debian/Ubuntu package: python-dev
  40
  41     - For kernel tracing: modprobe
  42
  43         - bash
  44           Needed for running "make check".
  45
  46 For developers using the git tree:
  47
  48 This source tree is based on the autotools suite from GNU to simplify
  49 portability. Here are some things you should have on your system in order to
  50 compile the git repository tree :
  51
  52 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
  53   (make sure your system wide "automake" points to a recent version!)
  54 - GNU Libtool >=2.2
  55   (for more information, go to http://www.gnu.org/software/autoconf/)
  56 - flex >= 2.5.35
  57 - bison >= 2.4
  58
  59 If you use GNU gold, which is NOT mandatory, make sure you have this version:
  60 - GNU gold >= 2.22
  61 (Before this version we hit a known bug documented at:
  62  http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
  63 Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
  64 LDFLAGS.
  65
  66 If you get the tree from the repository, you will need to use the "bootstrap"
  67 script in the root of the tree. It calls all the GNU tools needed to prepare
  68 the tree configuration.
  69
  70 INSTALLATION INSTRUCTIONS:
  71
  72   - Download, compile and install the prerequisites.
  73   Then:
  74   $ ./boostrap
  75   $ ./configure
  76   $ make
  77   $ sudo make install
  78   $ sudo ldconfig
  79
  80   If compiling from the git repository, run ./bootstrap before running
  81   the configure script, to generate it.
  82
  83   If you want Python bindings, run ./configure --enable-python-bindings.
  84
  85 USAGE:
  86
  87 Please see doc/quickstart.txt to help you start tracing. You can also use the
  88 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
  89 lttng enable-event -h).
  90
  91 A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
  92 helps you understand how to stream a LTTng 2.0 trace.
  93
  94 A Python HOWTO can be found in doc/python-howto.txt which quickly
  95 helps you understand how to use the Python module to control the LTTng API.
  96
  97 PACKAGE CONTENTS:
  98
  99     This package contains the following elements:
 100
 101     - liblttng-ctl
 102       The LTTng tracing control library.
 103
 104     - libsessiond-comm (internal)
 105           The lttng-sessiond communication library. In order to talk with
 106           lttng-sessiond, this library must be used.
 107
 108     - libkernel-ctl (internal)
 109       Kernel tracer control and ioctl definitions.
 110
 111     - libconsumer (internal)
 112       Library for Kernel and (optionally) UST trace consumer.
 113
 114         - libkernel-consumer (internal)
 115           Library for Kernel consumer control
 116
 117         - libust-consumer (internal)
 118           Library for UST consumer control
 119
 120         - libhashtable (internal)
 121           Library wrapper over URCU hashtables.
 122
 123         - libcommon (internal)
 124           Contains multiple useful function call used by the whole tree.
 125
 126         - libcompat (internal)
 127           Compatibility library mostly for FreeBSD and Linux.
 128
 129         - librelayd (internal)
 130           Library for all relayd interactions over the network.
 131
 132         - lttng-relayd
 133           The relay daemon used for network streaming
 134
 135     - lttng-consumerd
 136       The consumer daemon which uses libconsumer.
 137
 138     - lttng-sessiond
 139       The LTTng session daemon binary.
 140
 141     - lttng
 142       The LTTng tracer command line control tool.
 143
 144     - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
 145       The liblttngctl API header file.
 146
 147     - tests
 148       Various test programs.
 149
 150         - doc
 151           Various documentations and quickstart guide.
 152
 153         - extras
 154           Contains extra data such as bash completion file.