-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.dorsal.polymtl.ca (project: ust)
+ * Git: git://git.dorsal.polymtl.ca/git/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 was tested with liburcu v0.5.4
-- 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.
+
+TRACE VIEWER:
+
+ LTTV is used for viewing UST traces. LTTV may be obtained at
+ http://lttng.org in the Downloads section.
+
+ This release has been tested with LTTV 0.12.32.
+
+
+PACKAGE CONTENTS:
+
+ This package contains the following elements.
+
+ - libust
+ The actual userspace tracing library that must be linked to the
+ instrumented programs.
+
+ - ustctl
+ A program to control the tracing of userspace applications. It can list
+ markers, start the tracing, stop the tracing, enable/disable markers, etc.
+
+ - include
+ The public header files that will be installed on the system.
+
+ - ust-consumerd
+ The daemon that collects trace data and writes it to the disk.
+
+ - doc
+ The documentation.
+
+ - tests
+ Various test programs
+
+ - libustinstr-malloc
+ An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
+ in any program without need to recompile it.
+
+ - libustfork
+ 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.
+
+ - libustctl
+ A library to control tracing in other processes. Used by ustctl.
+
+ - libustcomm
+ A static library shared between libust, ust-consumerd and libustctl, that
+ provides functions that allow these components to communicate together.
+
+ - libustconsumer
+ A library to create ust consumers by registering callbacks, used by
+ ust-consumerd.
+
+ - snprintf
+ An asynchronous signal-safe version of snprintf.
+
+ - java
+ A simple library that uses JNI to allow tracing in java programs.