| 1 | LTTNG USERSPACE TRACER |
| 2 | ---------------------- |
| 3 | |
| 4 | Updated versions of this package may be found at: |
| 5 | |
| 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 |
| 9 | |
| 10 | |
| 11 | |
| 12 | PREREQUISITES: |
| 13 | |
| 14 | - liburcu |
| 15 | |
| 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 |
| 20 | |
| 21 | -> This release was tested with liburcu v0.0 |
| 22 | |
| 23 | |
| 24 | - libkcompat |
| 25 | |
| 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 |
| 31 | |
| 32 | -> This release was tested with libkcompat v0.0 |
| 33 | |
| 34 | |
| 35 | |
| 36 | INSTALLATION INSTRUCTIONS: |
| 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 | |
| 47 | TRACE 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 | |
| 54 | PACKAGE CONTENTS: |
| 55 | |
| 56 | This package contains the following elements. |
| 57 | |
| 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. |