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