X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=032fd946d7db213fb6af5da03eddead85476eec2;hb=a4c5d022e0ffb2a26be6ac925bedfd9e903ea8f3;hp=a68e8707183a3e8a0456c0ac7499d262b84137e8;hpb=cb974fbd91bf27bfda124e8c30227e548a802585;p=ust.git diff --git a/README b/README index a68e870..032fd94 100644 --- a/README +++ b/README @@ -5,6 +5,7 @@ UST web site and manual: http://lttng.org/ust Updated versions of this package may be found at: + * 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 @@ -14,30 +15,20 @@ Updated versions of this package may be found at: PREREQUISITES: - liburcu - 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 - - -> This release was tested with liburcu v0.4.1 - - - - libkcompat - - 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 - -> This release was tested with libkcompat v0.1 + -> This release was tested with liburcu v0.4.3 + * 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 INSTALLATION INSTRUCTIONS: - - Download, compile and install liburcu and libkcompat. + - Download, compile and install liburcu. - In this package's tree, run ./configure. - Run make. - Run make install. @@ -66,19 +57,35 @@ PACKAGE CONTENTS: 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. + - 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. + - tests + Various test programs - - libmallocwrap + - libustinstr-malloc An example library that can be LD_PRELOAD'ed to instrument calls to malloc() in any program without need to recompile it. - - libinterfork + - libustfork A library that is LD_PRELOAD'ed, and that hijacks calls to several system calls in order to trace across these calls. + + - libustcmd + A library to control tracing in other processes. Used by ustctl. + + - libustcomm + A static library shared between libust, ustd and libustcmd, 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.