projects / lttng-ust.git / blame
| Commit | Line | Data |
|---|---|---|
| 1af1f1db PMF |
1 | LTTNG USERSPACE TRACER (UST) |
| 2 | ---------------------------- | |
| 3 | ||
| cb974fbd | 4 | UST web site and manual: http://lttng.org/ust |
| 2615de09 | 5 | |
| 0207cc51 | 6 | Updated versions of this package may be found at: |
| 0207cc51 | 7 | |
| 8f03ca96 | 8 | * Website: http://lttng.org/ust |
| 2a93485b PMF |
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 | |
| 2615de09 | 12 | |
| 2615de09 | 13 | |
| 2a93485b | 14 | PREREQUISITES: |
| 6514bc5d | 15 | |
| 2a93485b | 16 | - liburcu |
| 2a93485b | 17 | Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney |
| 2615de09 | 18 | |
| ec3e0940 | 19 | -> This release was tested with liburcu v0.4.6 |
| 2615de09 | 20 | |
| 8f03ca96 PMF |
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 | |
| cbccb4a9 | 26 | |
| 2a93485b | 27 | |
| 5de791bd | 28 | INSTALLATION INSTRUCTIONS: |
| 2a93485b | 29 | |
| 7066ec32 | 30 | - Download, compile and install liburcu. |
| 2a93485b PMF |
31 | - In this package's tree, run ./configure. |
| 32 | - Run make. | |
| 33 | - Run make install. | |
| 34 | - Run ldconfig. | |
| 937e29d7 | 35 | - See the manual for usage instructions. |
| 2a93485b | 36 | |
| 1ffa770b PMF |
37 | If compiling from the git repository, run ./bootstrap before running |
| 38 | the configure script, to generate it. | |
| 2a93485b PMF |
39 | |
| 40 | ||
| 5de791bd PMF |
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 | ||
| ec3e0940 | 46 | This release has been tested with LTTV 0.12.32. |
| 5de791bd PMF |
47 | |
| 48 | ||
| 2a93485b PMF |
49 | PACKAGE CONTENTS: |
| 50 | ||
| 5de791bd PMF |
51 | This package contains the following elements. |
| 52 | ||
| 2a93485b PMF |
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 | ||
| 56097329 PMF |
61 | - include |
| 62 | The public header files that will be installed on the system. | |
| 63 | ||
| 2a93485b PMF |
64 | - ustd |
| 65 | The daemon that collects trace data and writes it to the disk. | |
| 66 | ||
| 1af1f1db PMF |
67 | - doc |
| 68 | The documentation. | |
| 2a93485b | 69 | |
| a4c5d022 PMF |
70 | - tests |
| 71 | Various test programs | |
| 2a93485b | 72 | |
| 7066ec32 | 73 | - libustinstr-malloc |
| 2a93485b PMF |
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 | ||
| 7066ec32 | 77 | - libustfork |
| 2a93485b | 78 | A library that is LD_PRELOAD'ed, and that hijacks calls to several system |
| 1ffa770b PMF |
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. | |
| a4c5d022 PMF |
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. |