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