[ust.git] / README

LTTNG USERSPACE TRACER

Updated versions of this package may be found at:
	git://git.dorsal.polymtl.ca/git/ust.git

Dependencies:

- 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
   * git://lttng.org/userspace-rcu.git

- libkcompat
  Linux kernel userspace compatibility library.
   * http://git.dorsal.polymtl.ca
   * git://git.dorsal.polymtl.ca/git/libkcompat.git

Installation instruction:

- 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.

Package contents:

- 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.

- 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.
Commit	Line	Data
	1	LTTNG USERSPACE TRACER
	2
	3	Updated versions of this package may be found at:
	4	git://git.dorsal.polymtl.ca/git/ust.git
	5
	6	Dependencies:
	7
	8	- liburcu
	9	Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
	10	* http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
	11	* git://lttng.org/userspace-rcu.git
	12
	13	- libkcompat
	14	Linux kernel userspace compatibility library.
	15	* http://git.dorsal.polymtl.ca
	16	* git://git.dorsal.polymtl.ca/git/libkcompat.git
	17
	18	Installation instruction:
	19
	20	- Download, compile and install liburcu and libkcompat.
	21	- In this package's tree, run ./configure.
	22	- Run make.
	23	- Run make install.
	24	- Run ldconfig.
	25	- See the manual in the doc/ directory for usage instructions.
	26
	27	Package contents:
	28
	29	- libust
	30	The actual userspace tracing library that must be linked to the
	31	instrumented programs.
	32
	33	- ustctl
	34	A program to control the tracing of userspace applications. It can list
	35	markers, start the tracing, stop the tracing, enable/disable markers, etc.
	36
	37	- ustd
	38	The daemon that collects trace data and writes it to the disk.
	39
	40	- Documentation
	41
	42	- hello
	43	An example application that uses the userspace tracer.
	44
	45	- libmallocwrap
	46	An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
	47	in any program without need to recompile it.
	48
	49	- libinterfork
	50	A library that is LD_PRELOAD'ed, and that hijacks calls to several system
	51	calls in order to trace across these calls.