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