Update version to 0.16
[ust.git] / README
1 LTTNG USERSPACE TRACER (UST)
2 ----------------------------
3
4 UST web site and manual: http://lttng.org/ust
5
6 Updated versions of this package may be found at:
7
8 * Website: http://lttng.org/ust
9 * Releases: http://lttng.org/files/ust/releases
10 * GitWeb: http://git.lttng.org (project: ust)
11 * Git: git://git.lttng.org/ust.git
12
13
14 PREREQUISITES:
15
16 - liburcu
17 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
18
19 -> This release depends on liburcu v0.6.6
20
21 * Debian/Ubuntu package: liburcu-dev
22 * Website: http://lttng.org/urcu
23 * Releases: http://lttng.org/files/urcu
24 * GitWeb: http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
25 * Git: git://lttng.org/userspace-rcu.git
26
27
28 INSTALLATION INSTRUCTIONS:
29
30 - Download, compile and install liburcu.
31 - In this package's tree, run ./configure.
32 - Run make.
33 - Run make install.
34 - Run ldconfig.
35 - See the manual for usage instructions.
36
37 If compiling from the git repository, run ./bootstrap before running
38 the configure script, to generate it.
39
40
41 TRACE VIEWER:
42
43 LTTV is used for viewing UST traces. LTTV may be obtained at
44 http://lttng.org in the Downloads section.
45
46 This release has been tested with LTTV 0.12.32.
47
48
49 CONTACT:
50
51 Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
52 Mailing list: ltt-dev@lists.casi.polymtl.ca
53
54
55 PACKAGE CONTENTS:
56
57 This package contains the following elements.
58
59 - libust
60 The actual userspace tracing library that must be linked to the
61 instrumented programs.
62
63 - ustctl
64 A program to control the tracing of userspace applications. It can list
65 markers, start the tracing, stop the tracing, enable/disable markers, etc.
66
67 - include
68 The public header files that will be installed on the system.
69
70 - ust-consumerd
71 The daemon that collects trace data and writes it to the disk.
72
73 - doc
74 The documentation.
75
76 - tests
77 Various test programs
78
79 - libustinstr-malloc
80 An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
81 in any program without need to recompile it.
82
83 - libustfork
84 A library that is LD_PRELOAD'ed, and that hijacks calls to several system
85 calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
86 in order to hijack calls. In contrast, libust may be linked at build time.
87
88 - libustctl
89 A library to control tracing in other processes. Used by ustctl.
90
91 - libustcomm
92 A static library shared between libust, ust-consumerd and libustctl, that
93 provides functions that allow these components to communicate together.
94
95 - libustconsumer
96 A library to create ust consumers by registering callbacks, used by
97 ust-consumerd.
98
99 - snprintf
100 An asynchronous signal-safe version of snprintf.
101
102 - java
103 A simple library that uses JNI to allow tracing in java programs.
This page took 0.042417 seconds and 4 git commands to generate.