Fix: epoll attributes used outside of compat layer
[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
d086eb77 20 -> Tested with liburcu >= v0.7.2
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
7c0cb22c
CB
31 - Perl (optional)
32 Needed for make check and tests.
33
9ea3b588
JG
34 - Python >= 3.0 (optional)
35 Needed for make check and tests.
36
37 * Debian/Ubuntu package: python3
38
36907cb5 39 - SWIG >= 2.0 (optional)
d086eb77 40 Needed for Python bindings (--enable-python-bindings).
36907cb5
DS
41
42 * Debian/Ubuntu package: swig2.0
43
44 - python-dev (optional)
45 Python headers
46
47 * Debian/Ubuntu package: python-dev
48
71a76062
MD
49 - For kernel tracing: modprobe
50
1167f2bc
DG
51 - bash
52 Needed for running "make check".
53
8ad9aaaf
MD
54For developers using the git tree:
55
56This source tree is based on the autotools suite from GNU to simplify
57portability. Here are some things you should have on your system in order to
58compile 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/)
5a82525d
DG
64- flex >= 2.5.35
65- bison >= 2.4
8ad9aaaf 66
ee10cdeb
DG
67If 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)
71Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
72LDFLAGS.
73
8ad9aaaf 74If you get the tree from the repository, you will need to use the "bootstrap"
ee10cdeb
DG
75script in the root of the tree. It calls all the GNU tools needed to prepare
76the tree configuration.
8ad9aaaf 77
fac6795d
DG
78INSTALLATION INSTRUCTIONS:
79
ebb6ebd5
DG
80 - Download, compile and install the prerequisites.
81 Then:
ee10cdeb 82 $ ./boostrap
ebb6ebd5
DG
83 $ ./configure
84 $ make
85 $ sudo make install
86 $ sudo ldconfig
fac6795d
DG
87
88 If compiling from the git repository, run ./bootstrap before running
89 the configure script, to generate it.
90
36907cb5
DS
91 If you want Python bindings, run ./configure --enable-python-bindings.
92
aeff77c8
DG
93USAGE:
94
95Please 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:
97lttng enable-event -h).
98
c0e668d0
DG
99A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
100helps you understand how to stream a LTTng 2.0 trace.
101
36907cb5
DS
102A Python HOWTO can be found in doc/python-howto.txt which quickly
103helps you understand how to use the Python module to control the LTTng API.
104
fac6795d
DG
105PACKAGE CONTENTS:
106
ebb6ebd5
DG
107 This package contains the following elements:
108
ffb25bd5 109 - liblttng-ctl
ebb6ebd5
DG
110 The LTTng tracing control library.
111
fe54b749
DG
112 - libsessiond-comm (internal)
113 The lttng-sessiond communication library. In order to talk with
114 lttng-sessiond, this library must be used.
ebb6ebd5 115
fe54b749 116 - libkernel-ctl (internal)
ebb6ebd5 117 Kernel tracer control and ioctl definitions.
fac6795d 118
fe54b749 119 - libconsumer (internal)
3bd1e081 120 Library for Kernel and (optionally) UST trace consumer.
fac6795d 121
fe54b749
DG
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
ffb25bd5
DG
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
b8aa1682
JD
140 - lttng-relayd
141 The relay daemon used for network streaming
142
3bd1e081 143 - lttng-consumerd
fe54b749 144 The consumer daemon which uses libconsumer.
fac6795d 145
32258573 146 - lttng-sessiond
ebb6ebd5 147 The LTTng session daemon binary.
fac6795d 148
ebb6ebd5
DG
149 - lttng
150 The LTTng tracer command line control tool.
fac6795d 151
ebb6ebd5
DG
152 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
153 The liblttngctl API header file.
fac6795d 154
ebb6ebd5
DG
155 - tests
156 Various test programs.
fe54b749
DG
157
158 - doc
159 Various documentations and quickstart guide.
ffb25bd5
DG
160
161 - extras
162 Contains extra data such as bash completion file.
This page took 0.041998 seconds and 5 git commands to generate.