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