update TODO
[ust.git] / README
1 LTTNG USERSPACE TRACER (UST)
2 ----------------------------
3
4 For the UST manual, see: http://lttng.org/files/ust/manual/ust.html
5
6 Updated versions of this package may be found at:
7
8 * Releases: http://lttng.org/files/ust/releases
9 * GitWeb: http://git.dorsal.polymtl.ca (project: ust)
10 * Git: git://git.dorsal.polymtl.ca/git/ust.git
11
12
13
14 PREREQUISITES:
15
16 - liburcu
17
18 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
19 * Releases: http://lttng.org/files/ust/releases
20 * GitWeb: http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
21 * Git: git://lttng.org/userspace-rcu.git
22
23 -> This release was tested with liburcu v0.4.1
24
25
26 - libkcompat
27
28 Linux kernel userspace compatibility library.
29 (Provides userspace ports of some kernel APIs.)
30 * Releases: http://lttng.org/files/ust/releases
31 * GitWeb: http://git.dorsal.polymtl.ca (project: libkcompat)
32 * Git: git://git.dorsal.polymtl.ca/git/libkcompat.git
33
34 -> This release was tested with libkcompat v0.1
35
36
37
38 INSTALLATION INSTRUCTIONS:
39
40 - Download, compile and install liburcu and libkcompat.
41 - In this package's tree, run ./configure.
42 - Run make.
43 - Run make install.
44 - Run ldconfig.
45 - See the manual for usage instructions.
46
47
48
49 TRACE VIEWER:
50
51 LTTV is used for viewing UST traces. LTTV may be obtained at
52 http://lttng.org in the Downloads section.
53
54 This release has been tested with LTTV 0.12.30.
55
56
57 PACKAGE CONTENTS:
58
59 This package contains the following elements.
60
61 - libust
62 The actual userspace tracing library that must be linked to the
63 instrumented programs.
64
65 - ustctl
66 A program to control the tracing of userspace applications. It can list
67 markers, start the tracing, stop the tracing, enable/disable markers, etc.
68
69 - ustd
70 The daemon that collects trace data and writes it to the disk.
71
72 - doc
73 The documentation.
74
75 - hello
76 An example application that uses the userspace tracer.
77
78 - libmallocwrap
79 An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
80 in any program without need to recompile it.
81
82 - libinterfork
83 A library that is LD_PRELOAD'ed, and that hijacks calls to several system
84 calls in order to trace across these calls.
This page took 0.031544 seconds and 4 git commands to generate.