From 6d26218596597e1c4529b151464fd0ef8d0313cb Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Wed, 8 Jan 2014 10:13:11 -0500 Subject: [PATCH] cleanup ust_baddr and ust_baddr_statedump doc Signed-off-by: Mathieu Desnoyers --- doc/man/lttng-ust-dl.3 | 21 +++++++++++++-------- doc/man/lttng-ust.3 | 21 +++++++++++---------- 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/doc/man/lttng-ust-dl.3 b/doc/man/lttng-ust-dl.3 index ff46f6be..cfd961eb 100644 --- a/doc/man/lttng-ust-dl.3 +++ b/doc/man/lttng-ust-dl.3 @@ -9,29 +9,33 @@ Launch your application with: \fBLD_PRELOAD=liblttng-ust-dl.so\fP appname .PP This LD_PRELOAD library causes all calls to dlopen and dlclose in the -application to be traced with LTTng. The following two events need to be -enabled: ust_baddr:push and ust_baddr:pop. +application to be traced with LTTng. In addition to loading this +library, enabling this tracing requires the following two events to be +enabled: "ust_baddr:push" and "ust_baddr:pop". .SH "DESCRIPTION" The events have the following detailed definitions: .PP .IP "ust_baddr:push" -This event is used to trace dlopen calls. The base address (where the dynamic -linker has placed the shared object) is recorded in the baddr-field. The path -to the shared object gets recorded in the sopath-field (as string). The file -size of the loaded object (in bytes) is recorded to the size-field and its time -of last modification (in seconds since Epoch) is recorded in the mtime-field. +This event is used to trace dlopen calls. The base address (where the +dynamic linker has placed the shared object) is recorded in the "baddr" +field. The path to the shared object gets recorded in the "sopath" field +(as string). The file size of the loaded object (in bytes) is recorded +to the "size" field and its time of last modification (in seconds since +Epoch) is recorded in the "mtime" field. .IP "ust_baddr:pop" This event is used to trace dlclose calls. The base address of the shared -object that got closed is recorded in the baddr-field. +object that got closed is recorded in the "baddr" field. .PP .SH "SEE ALSO" lttng-ust(3), dlopen(3), lttng(1) + .SH "BUGS" If you encounter any issues or usability problem, please report it on our mailing list to help improve this project. + .SH "CREDITS" liblttng-ust is distributed under the GNU Lesser General Public License version 2.1. The headers are distributed under the MIT license. @@ -41,6 +45,7 @@ See http://lttng.org for more information on the LTTng project. Mailing list for support and development: . You can find us on IRC server irc.oftc.net (OFTC) in #lttng. + .SH "AUTHORS" liblttng-ust was originally written by Mathieu Desnoyers, with additional contributions from various other people. It is currently maintained by diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3 index 55de9fd2..2fb287ac 100644 --- a/doc/man/lttng-ust.3 +++ b/doc/man/lttng-ust.3 @@ -377,16 +377,17 @@ needs to be enabled: .IP "ust_baddr_statedump:soinfo" This event is used to trace a currently loaded shared object. The base address (where the dynamic linker has placed the shared object) is recorded in the -baddr-field. The path to the shared object gets recorded in the sopath-field -(as string). The file size of the loaded object (in bytes) is recorded to the -size-field and its time of last modification (in seconds since Epoch) is -recorded in the mtime-field. -.PP -If the event above is enabled, a series of ust_baddr_statedump:soinfo events is -recorded at session-enable time, that represents the state of currently loaded -shared objects (of the traced application). If this information gets combined -with the lttng-ust-dl(3) instrumentation, all aspects of dynamic loading that -are relevant for symbol and linenumber-lookup are traced by LTTng. +"baddr" field. The path to the shared object gets recorded in the +"sopath" field (as string). The file size of the loaded object (in +bytes) is recorded to the "size" field and its time of last modification +(in seconds since Epoch) is recorded in the "mtime" field. +.PP +If the event above is enabled, a series of "ust_baddr_statedump:soinfo" +events is recorded at session-enable time. It represents the state of +currently loaded shared objects for the traced process. If this +information gets combined with the lttng-ust-dl(3) instrumentation, all +aspects of dynamic loading that are relevant for symbol and +line number lookup are traced by LTTng. .PP .SH "ENVIRONMENT VARIABLES" -- 2.34.1