Commit | Line | Data |
---|---|---|
1bb74e94 | 1 | LTTNG USERSPACE TRACER (LTTng-UST) |
1af1f1db PMF |
2 | ---------------------------- |
3 | ||
1bb74e94 | 4 | UST web site: http://lttng.org/lttng2.0 |
2615de09 | 5 | |
0207cc51 | 6 | Updated versions of this package may be found at: |
0207cc51 | 7 | |
1bb74e94 MD |
8 | * Website: http://lttng.org/lttng2.0 |
9 | * Releases: http://lttng.org/files/lttng-ust | |
10 | * GitWeb: http://git.lttng.org (project: lttng-ust) | |
11 | * Git: git://git.lttng.org/lttng-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 | |
bf956ec0 | 19 | -> This release depends on liburcu v0.7.2 |
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 | |
f8f5a378 | 27 | - libuuid (for Linux) |
c68670d0 | 28 | * Debian/Ubuntu package: libuuid1, uuid-dev |
05dc3c14 | 29 | * Fedora package: libuuid-devel |
f8f5a378 | 30 | |
efac0f0f MD |
31 | For developers using the git tree: |
32 | ||
33 | This source tree is based on the autotools suite from GNU to simplify | |
34 | portability. Here are some things you should have on your system in order to | |
35 | compile the git repository tree : | |
36 | ||
37 | - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50) | |
38 | (make sure your system wide "automake" points to a recent version!) | |
39 | - GNU Libtool >=2.2 | |
40 | (for more information, go to http://www.gnu.org/software/autoconf/) | |
41 | ||
42 | If you get the tree from the repository, you will need to use the "bootstrap" | |
43 | script in the root of the tree. It calls all the GNU tools needed to prepare the | |
44 | tree configuration. | |
45 | ||
2a93485b | 46 | |
5de791bd | 47 | INSTALLATION INSTRUCTIONS: |
2a93485b | 48 | |
7066ec32 | 49 | - Download, compile and install liburcu. |
2a93485b PMF |
50 | - In this package's tree, run ./configure. |
51 | - Run make. | |
52 | - Run make install. | |
53 | - Run ldconfig. | |
2a93485b | 54 | |
1ffa770b PMF |
55 | If compiling from the git repository, run ./bootstrap before running |
56 | the configure script, to generate it. | |
2a93485b PMF |
57 | |
58 | ||
5e96a467 MD |
59 | USAGE: |
60 | ||
61 | - Create an instrumentation header following the tracepoint examples. | |
8844360e | 62 | See lttng/tracepoint.h, and examples. |
628e1d81 MD |
63 | |
64 | There are 2 ways to compile the Tracepoint Provider with the | |
65 | application: either statically or dynamically. Please follow | |
66 | carefully: | |
67 | ||
68 | 1.1) Compile the Tracepoint provider with the application, either | |
69 | directly or through a static library (.a): | |
70 | - Into exactly one object of your application: define | |
71 | "TRACEPOINT_DEFINE" and include the tracepoint provider. | |
8844360e MD |
72 | - Use "-I." for the compilation unit containing the tracepoint |
73 | provider include (e.g. tp.c). | |
c6c454ab | 74 | - Link application with "-ldl" on Linux, with "-lc" on BSD. |
0ba9b647 MD |
75 | - If building the provider directly into the application, |
76 | link the application with "-llttng-ust". | |
77 | - If building a static library for the provider, link the static | |
78 | library with "-lllttng-ust". | |
628e1d81 MD |
79 | - Include the tracepoint provider header into all C files using |
80 | the provider. | |
8844360e | 81 | - Example: |
c6c454ab | 82 | tests/hello/ hello.c tp.c ust_tests_hello.h Makefile.example.* |
628e1d81 MD |
83 | |
84 | 2) Compile the Tracepoint Provider separately from the application, | |
85 | using dynamic linking: | |
86 | - Into exactly one object of your application: define | |
87 | "TRACEPOINT_DEFINE" _and_ also define | |
88 | "TRACEPOINT_PROBE_DYNAMIC_LINKAGE", then include the tracepoint | |
89 | provider header. | |
90 | - Include the tracepoint provider header into all instrumented C | |
91 | files that use the provider. | |
8844360e MD |
92 | - Compile the tracepoint provider with "-I.". |
93 | - Link the tracepoint provider with "-llttng-ust". | |
c6c454ab | 94 | - Link application with "-ldl" on Linux, "-lc" on BSD. |
8844360e MD |
95 | - Set a LD_PRELOAD environment to preload the tracepoint provider |
96 | shared object before starting the application when tracing is | |
b834dead MD |
97 | needed. Another way is to dlopen the tracepoint probe when needed |
98 | by the application. | |
8844360e MD |
99 | - Example: |
100 | - tests/demo/ demo.c tp*.c ust_tests_demo*.h demo-trace | |
628e1d81 | 101 | |
8844360e MD |
102 | - Enable instrumentation and control tracing with the "lttng" command |
103 | from lttng-tools. See lttng-tools doc/quickstart.txt. | |
5e96a467 | 104 | |
cf12a773 MD |
105 | ENVIRONMENT VARIABLES: |
106 | ||
f3049ad9 MD |
107 | - liblttng-ust debug can be activated by setting the environment variable |
108 | "LTTNG_UST_DEBUG" when launching the application. It can also be enabled | |
109 | at compile-time by compiling libust with -DLTTNG_UST_DEBUG. | |
cf12a773 | 110 | |
f3049ad9 | 111 | - The environment variable "LTTNG_UST_REGISTER_TIMEOUT" can be used to |
cf12a773 MD |
112 | specify how long the applications should wait for sessiond |
113 | "registration done" command before proceeding to execute the main | |
114 | program. The default is 3000ms (3 seconds). The timeout value is | |
7b766b16 | 115 | specified in milliseconds. The value 0 means "don't wait". The value |
8844360e MD |
116 | -1 means "wait forever". Setting this environment variable to 0 is |
117 | recommended for applications with time constraints on the process | |
118 | startup time. | |
5e96a467 | 119 | |
fdb4af10 MD |
120 | - The compilation flag "-DLTTNG_UST_DEBUG_VALGRIND" should be enabled |
121 | at build time to allow liblttng-ust to be used with valgrind | |
122 | (side-effect: disables per-cpu buffering). | |
123 | ||
5e96a467 | 124 | |
5de791bd PMF |
125 | TRACE VIEWER: |
126 | ||
f3049ad9 MD |
127 | Use babeltrace for viewing traces generated by LTTng UST 2.0. |
128 | See http://lttng.org for download. | |
5de791bd PMF |
129 | |
130 | ||
13ef5c0e MD |
131 | CONTACT: |
132 | ||
133 | Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
1bb74e94 | 134 | Mailing list: lttng-dev@lists.lttng.org |
13ef5c0e MD |
135 | |
136 | ||
2a93485b PMF |
137 | PACKAGE CONTENTS: |
138 | ||
5de791bd PMF |
139 | This package contains the following elements. |
140 | ||
f3049ad9 | 141 | - liblttng-ust |
2a93485b PMF |
142 | The actual userspace tracing library that must be linked to the |
143 | instrumented programs. | |
144 | ||
56097329 PMF |
145 | - include |
146 | The public header files that will be installed on the system. | |
147 | ||
a4c5d022 PMF |
148 | - tests |
149 | Various test programs | |
2a93485b | 150 | |
476037d9 | 151 | - liblttng-ust-libc-wrapper |
1622ba22 MD |
152 | An example library that can be LD_PRELOAD'ed to instrument some |
153 | calls to libc (currently malloc() and free()) in any program without | |
154 | need to recompile it. | |
2a93485b | 155 | |
f3049ad9 | 156 | - liblttng-ust-fork |
2a93485b | 157 | A library that is LD_PRELOAD'ed, and that hijacks calls to several system |
1ffa770b PMF |
158 | calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed |
159 | in order to hijack calls. In contrast, libust may be linked at build time. | |
a4c5d022 | 160 | |
f3049ad9 MD |
161 | - liblttng-ust-ctl |
162 | A library to control tracing in other processes. Used by lttng-tools. | |
a4c5d022 | 163 | |
f3049ad9 MD |
164 | - liblttng-ust-comm |
165 | A static library shared between libust and lttng-tools, that | |
9dc7b7ff NC |
166 | provides functions that allow these components to communicate together. |
167 | ||
8844360e MD |
168 | - libringbuffer |
169 | The ring buffer implementation used within LTTng-UST. | |
170 | ||
a4c5d022 PMF |
171 | - snprintf |
172 | An asynchronous signal-safe version of snprintf. | |
173 | ||
8844360e | 174 | - liblttng-ust-java |
a4c5d022 | 175 | A simple library that uses JNI to allow tracing in java programs. |
8844360e | 176 | See liblttng-ust-java/README for build instructions. |