README: add section on libinterfork
[ust.git] / README
1 LTTNG USERSPACE TRACER
2
3 NOTE: This library has not been released yet because altough it is licenced as
4 LGPL, it can only be used as gpl because it depends on GPL files. It will be
5 released as soon as these issues are resolved.
6
7 Dependencies:
8
9 - liburcu
10 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
11 http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
12
13 - libkcompat
14 Linux kernel userspace compatibility library.
15 http://git.dorsal.polymtl.ca
16
17 Installation instruction:
18
19 - Download, compile and install liburcu and libkcompat.
20 - In this package's tree, run ./configure, specifying the location of
21 liburcu and libkcompat with the --with-urcu and --with-kcompat options.
22 - Run make.
23 - See the manual in the doc/ directory for usage instructions.
24
25 Package contents:
26
27 - libust
28 The actual userspace tracing library that must be linked to the
29 instrumented programs.
30
31 - ustctl
32 A program to control the tracing of userspace applications. It can list
33 markers, start the tracing, stop the tracing, enable/disable markers, etc.
34
35 - ustd
36 The daemon that collects trace data and writes it to the disk.
37
38 - Documentation
39
40 - hello
41 An example application that uses the userspace tracer.
42
43 - libmallocwrap
44 An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
45 in any program without need to recompile it.
46
47 - libinterfork
48 A library that is LD_PRELOAD'ed, and that hijacks calls to several system
49 calls in order to trace across these calls.
This page took 0.031519 seconds and 5 git commands to generate.