-LTTNG USERSPACE TRACER
+LTTNG USERSPACE TRACER (UST)
+----------------------------
-NOTE: This library has not been released yet because altough it is licenced as
-LGPL, it can only be used as gpl because it depends on GPL files. It will be
-released as soon as these issues are resolved.
+For the UST manual, see: http://lttng.org/files/ust/manual/ust.html
-Dependencies:
+Updated versions of this package may be found at:
-- 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
+ * Releases: http://lttng.org/files/ust/releases
+ * GitWeb: http://git.dorsal.polymtl.ca (project: ust)
+ * Git: git://git.dorsal.polymtl.ca/git/ust.git
-- libkcompat
- Linux kernel userspace compatibility library.
- http://git.dorsal.polymtl.ca
-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
-- libust
- The actual userspace tracing library that must be linked to the
- instrumented programs.
+ Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
+ * Releases: http://lttng.org/files/ust/releases
+ * GitWeb: http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+ * Git: git://lttng.org/userspace-rcu.git
-- ustctl
- A program to control the tracing of userspace applications. It can list
- markers, start the tracing, stop the tracing, enable/disable markers, etc.
+ -> This release was tested with liburcu v0.3.4
-- ustd
- The daemon that collects trace data and writes it to the disk.
-- Documentation
+ - libkcompat
-- hello
- An example application that uses the userspace tracer.
+ Linux kernel userspace compatibility library.
+ (Provides userspace ports of some kernel APIs.)
+ * Releases: http://lttng.org/files/ust/releases
+ * GitWeb: http://git.dorsal.polymtl.ca (project: libkcompat)
+ * Git: git://git.dorsal.polymtl.ca/git/libkcompat.git
-- libmallocwrap
- An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
- in any program without need to recompile it.
+ -> This release was tested with libkcompat v0.1
+
+
+
+INSTALLATION INSTRUCTIONS:
+
+ - Download, compile and install liburcu and libkcompat.
+ - In this package's tree, run ./configure.
+ - Run make.
+ - Run make install.
+ - Run ldconfig.
+ - See the manual in the doc/ directory for usage instructions.
+
+
+
+TRACE VIEWER:
+
+ LTTV is used for viewing UST traces. LTTV may be obtained at
+ http://lttng.org in the Downloads section.
+
+
+
+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.
+
+ - ustd
+ The daemon that collects trace data and writes it to the disk.
+
+ - doc
+ The documentation.
+
+ - hello
+ An example application that uses the userspace tracer.
+
+ - libmallocwrap
+ An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
+ in any program without need to recompile it.
+
+ - libinterfork
+ A library that is LD_PRELOAD'ed, and that hijacks calls to several system
+ calls in order to trace across these calls.
projects / ust.git / blobdiff