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