[ust.git] / README

LTTNG USERSPACE TRACER

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

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

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