X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=README;h=ad9acd77b5664753b5947d5fe9c4c2a3ffa1f73c;hb=67e5f39161d80ea3d972a37ecf76f45a260c480d;hp=23b831978a748d7acc1cd63e16c11ad7c9082714;hpb=628e1d81fe575cfd281d8e0758b672b23d890c09;p=lttng-ust.git diff --git a/README b/README index 23b83197..ad9acd77 100644 --- a/README +++ b/README @@ -67,7 +67,11 @@ USAGE: "TRACEPOINT_DEFINE" and include the tracepoint provider. - Use "-I." for the compilation unit containing the tracepoint provider include (e.g. tp.c). - - Link application with "-ldl -llttng-ust". + - Link application with "-ldl". + - If building the provider directly into the application, + link the application with "-llttng-ust". + - If building a static library for the provider, link the static + library with "-lllttng-ust". - Include the tracepoint provider header into all C files using the provider. - Example: @@ -86,15 +90,11 @@ USAGE: - Link application with "-ldl". - Set a LD_PRELOAD environment to preload the tracepoint provider shared object before starting the application when tracing is - needed. + needed. Another way is to dlopen the tracepoint probe when needed + by the application. - Example: - tests/demo/ demo.c tp*.c ust_tests_demo*.h demo-trace - - Note about dlopen() usage: due to locking side-effects due to the - way libc lazily resolves Thread-Local Storage (TLS) symbols when a - library is dlopen'd, linking the tracepoint probe or liblttng-ust - with dlopen() is discouraged. They should be linked with the - application using "-llibname" or loaded with LD_PRELOAD. - Enable instrumentation and control tracing with the "lttng" command from lttng-tools. See lttng-tools doc/quickstart.txt. @@ -140,7 +140,7 @@ PACKAGE CONTENTS: - tests Various test programs - - liblttng-ust-libc + - liblttng-ust-libc-wrapper An example library that can be LD_PRELOAD'ed to instrument some calls to libc (currently malloc() and free()) in any program without need to recompile it.