-LTTNG USERSPACE TRACER
+LTTNG USERSPACE TRACER (UST)
+----------------------------
-Dependencies:
+UST web site and manual: http://lttng.org/ust
-- liburcu
- Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
- http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+Updated versions of this package may be found at:
-- libkcompat
- Linux kernel userspace compatibility library.
- http://git.dorsal.polymtl.ca
+ * Website: http://lttng.org/ust
+ * Releases: http://lttng.org/files/ust/releases
+ * GitWeb: http://git.lttng.org (project: ust)
+ * Git: git://git.lttng.org/ust.git
-Installation instruction:
-- Download, compile and install liburcu and libkcompat.
-- In this package's tree, run ./configure, specifying the location of
- liburcu and libkcompat with the --with-urcu and --with-kcompat options.
-- Run make.
-- See the manual in the doc/ directory for usage instructions.
+PREREQUISITES:
-Package contents:
+ - liburcu
+ Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-- libust
- The actual userspace tracing library that must be linked to the
- instrumented programs.
+ -> This release depends on liburcu v0.6.6
-- ustctl
- A program to control the tracing of userspace applications. It can list
- markers, start the tracing, stop the tracing, enable/disable markers, etc.
+ * Debian/Ubuntu package: liburcu-dev
+ * Website: http://lttng.org/urcu
+ * Releases: http://lttng.org/files/urcu
+ * GitWeb: http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+ * Git: git://lttng.org/userspace-rcu.git
-- ustd
- The daemon that collects trace data and writes it to the disk.
-- Documentation
+INSTALLATION INSTRUCTIONS:
-- hello
- An example application that uses the userspace tracer.
+ - Download, compile and install liburcu.
+ - In this package's tree, run ./configure.
+ - Run make.
+ - Run make install.
+ - Run ldconfig.
+ - See the manual for usage instructions.
-- libmallocwrap
- An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
- in any program without need to recompile it.
+ If compiling from the git repository, run ./bootstrap before running
+ the configure script, to generate it.
-- libinterfork
- A library that is LD_PRELOAD'ed, and that hijacks calls to several system
- calls in order to trace across these calls.
+
+USAGE:
+
+ - Create an instrumentation header following the tracepoint examples.
+ (see tracepoint.h and tests/hello/tp.h).
+ - Link application with -lust.
+ - (TODO: start tracing with the "lttng" command from lttng-tools)
+
+ENVIRONMENT VARIABLES:
+
+ - liblttng-ust debug can be activated by setting the environment variable
+ "LTTNG_UST_DEBUG" when launching the application. It can also be enabled
+ at compile-time by compiling libust with -DLTTNG_UST_DEBUG.
+
+ - The environment variable "LTTNG_UST_REGISTER_TIMEOUT" can be used to
+ specify how long the applications should wait for sessiond
+ "registration done" command before proceeding to execute the main
+ program. The default is 3000ms (3 seconds). The timeout value is
+ specified in milliseconds. The value 0 means "don't wait". The value
+ -1 means "wait forever".
+
+
+TRACE VIEWER:
+
+ Use babeltrace for viewing traces generated by LTTng UST 2.0.
+ See http://lttng.org for download.
+
+
+CONTACT:
+
+ Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ Mailing list: ltt-dev@lists.casi.polymtl.ca
+
+
+PACKAGE CONTENTS:
+
+ This package contains the following elements.
+
+ - liblttng-ust
+ The actual userspace tracing library that must be linked to the
+ instrumented programs.
+
+ - include
+ The public header files that will be installed on the system.
+
+ - doc
+ The documentation.
+
+ - tests
+ Various test programs
+
+ - liblttng-ust-malloc
+ An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
+ in any program without need to recompile it.
+
+ - liblttng-ust-fork
+ A library that is LD_PRELOAD'ed, and that hijacks calls to several system
+ calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
+ in order to hijack calls. In contrast, libust may be linked at build time.
+
+ - liblttng-ust-ctl
+ A library to control tracing in other processes. Used by lttng-tools.
+
+ - liblttng-ust-comm
+ A static library shared between libust and lttng-tools, that
+ provides functions that allow these components to communicate together.
+
+ - snprintf
+ An asynchronous signal-safe version of snprintf.
+
+ - java
+ A simple library that uses JNI to allow tracing in java programs.
+ See java/README for build instructions.
projects / ust.git / blobdiff