update READMEs
[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.dorsal.polymtl.ca (project: ust)
11 * Git: git://git.dorsal.polymtl.ca/git/ust.git
12
13
14 PREREQUISITES:
15
16 - liburcu
17 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
18
19 -> This release was tested with liburcu v0.4.3
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.30.
47
48
49 PACKAGE CONTENTS:
50
51 This package contains the following elements.
52
53 - libust
54 The actual userspace tracing library that must be linked to the
55 instrumented programs.
56
57 - ustctl
58 A program to control the tracing of userspace applications. It can list
59 markers, start the tracing, stop the tracing, enable/disable markers, etc.
60
61 - include
62 The public header files that will be installed on the system.
63
64 - ustd
65 The daemon that collects trace data and writes it to the disk.
66
67 - doc
68 The documentation.
69
70 - tests
71 Various test programs
72
73 - libustinstr-malloc
74 An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
75 in any program without need to recompile it.
76
77 - libustfork
78 A library that is LD_PRELOAD'ed, and that hijacks calls to several system
79 calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
80 in order to hijack calls. In contrast, libust may be linked at build time.
81
82 - libustcmd
83 A library to control tracing in other processes. Used by ustctl.
84
85 - libustcomm
86 A static library shared between libust, ustd and libustcmd, that provides
87 functions that allow these components to communicate together.
88
89 - snprintf
90 An asynchronous signal-safe version of snprintf.
91
92 - java
93 A simple library that uses JNI to allow tracing in java programs.
This page took 0.032892 seconds and 4 git commands to generate.