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