Move liblttng-ust-libc-wrapper to 'src/lib/'

[lttng-ust.git] / src / lib / lttng-ust-libc-wrapper / README

diff --git a/src/lib/lttng-ust-libc-wrapper/README b/src/lib/lttng-ust-libc-wrapper/README
new file mode 100644 (file)
index 0000000..09e17cb
--- /dev/null
+++ b/src/lib/lttng-ust-libc-wrapper/README
@@ -0,0 +1,9 @@
+liblttng-ust-libc is used for instrumenting some calls to libc in a
+program, without need for recompiling it.
+
+This library defines a malloc() function that is instrumented with a
+tracepoint. It also calls the libc malloc afterwards. When loaded with
+LD_PRELOAD, it replaces the libc malloc() function, in effect
+instrumenting all calls to malloc(). The same is performed for free().
+
+See the "run" script for a usage example.