2 * Copyright (C) 2013 Paul Woegerer <paul_woegerer@mentor.com>
3 * Copyright (C) 2015 Antoine Busque <abusque@efficios.com>
4 * Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29 #include <sys/types.h>
32 #include <lttng/ust-elf.h>
34 #include "lttng-tracer-core.h"
35 #include "lttng-ust-statedump.h"
39 #define TRACEPOINT_DEFINE
40 #include "ust_lib.h" /* Only define. */
42 #define TRACEPOINT_CREATE_PROBES
43 #define TP_SESSION_CHECK
44 #include "lttng-ust-statedump-provider.h" /* Define and create probes. */
46 struct dl_iterate_data
{
52 struct bin_info_data
{
54 char resolved_path
[PATH_MAX
];
63 uint8_t has_debug_link
;
66 struct lttng_ust_dl_node
{
67 struct bin_info_data bin_data
;
68 struct cds_hlist_node node
;
73 #define UST_DL_STATE_HASH_BITS 8
74 #define UST_DL_STATE_TABLE_SIZE (1 << UST_DL_STATE_HASH_BITS)
75 struct cds_hlist_head dl_state_table
[UST_DL_STATE_TABLE_SIZE
];
77 typedef void (*tracepoint_cb
)(struct lttng_session
*session
, void *priv
);
80 struct lttng_ust_dl_node
*alloc_dl_node(const struct bin_info_data
*bin_data
)
82 struct lttng_ust_dl_node
*e
;
84 e
= zmalloc(sizeof(struct lttng_ust_dl_node
));
87 if (bin_data
->dbg_file
) {
88 e
->bin_data
.dbg_file
= strdup(bin_data
->dbg_file
);
89 if (!e
->bin_data
.dbg_file
)
92 if (bin_data
->build_id
) {
93 e
->bin_data
.build_id
= zmalloc(bin_data
->build_id_len
);
94 if (!e
->bin_data
.build_id
)
96 memcpy(e
->bin_data
.build_id
, bin_data
->build_id
,
97 bin_data
->build_id_len
);
99 e
->bin_data
.base_addr_ptr
= bin_data
->base_addr_ptr
;
100 memcpy(e
->bin_data
.resolved_path
, bin_data
->resolved_path
, PATH_MAX
);
101 e
->bin_data
.memsz
= bin_data
->memsz
;
102 e
->bin_data
.build_id_len
= bin_data
->build_id_len
;
103 e
->bin_data
.vdso
= bin_data
->vdso
;
104 e
->bin_data
.crc
= bin_data
->crc
;
105 e
->bin_data
.is_pic
= bin_data
->is_pic
;
106 e
->bin_data
.has_build_id
= bin_data
->has_build_id
;
107 e
->bin_data
.has_debug_link
= bin_data
->has_debug_link
;
111 free(e
->bin_data
.build_id
);
112 free(e
->bin_data
.dbg_file
);
118 void free_dl_node(struct lttng_ust_dl_node
*e
)
120 free(e
->bin_data
.build_id
);
121 free(e
->bin_data
.dbg_file
);
125 /* Return 0 if same, nonzero if not. */
127 int compare_bin_data(const struct bin_info_data
*a
,
128 const struct bin_info_data
*b
)
130 if (a
->base_addr_ptr
!= b
->base_addr_ptr
)
132 if (strcmp(a
->resolved_path
, b
->resolved_path
) != 0)
134 if (a
->dbg_file
&& !b
->dbg_file
)
136 if (!a
->dbg_file
&& b
->dbg_file
)
138 if (a
->dbg_file
&& strcmp(a
->dbg_file
, b
->dbg_file
) != 0)
140 if (a
->build_id
&& !b
->build_id
)
142 if (!a
->build_id
&& b
->build_id
)
144 if (a
->build_id_len
!= b
->build_id_len
)
147 memcmp(a
->build_id
, b
->build_id
, a
->build_id_len
) != 0)
149 if (a
->memsz
!= b
->memsz
)
151 if (a
->vdso
!= b
->vdso
)
153 if (a
->crc
!= b
->crc
)
155 if (a
->is_pic
!= b
->is_pic
)
157 if (a
->has_build_id
!= b
->has_build_id
)
159 if (a
->has_debug_link
!= b
->has_debug_link
)
165 struct lttng_ust_dl_node
*find_or_create_dl_node(struct bin_info_data
*bin_data
)
167 struct cds_hlist_head
*head
;
168 struct lttng_ust_dl_node
*e
;
172 hash
= jhash(&bin_data
->base_addr_ptr
,
173 sizeof(bin_data
->base_addr_ptr
), 0);
174 head
= &dl_state_table
[hash
& (UST_DL_STATE_TABLE_SIZE
- 1)];
175 cds_hlist_for_each_entry_2(e
, head
, node
) {
176 if (compare_bin_data(&e
->bin_data
, bin_data
) != 0)
183 e
= alloc_dl_node(bin_data
);
186 cds_hlist_add_head(&e
->node
, head
);
192 void remove_dl_node(struct lttng_ust_dl_node
*e
)
194 cds_hlist_del(&e
->node
);
198 * Trace statedump event into all sessions owned by the caller thread
199 * for which statedump is pending.
202 void trace_statedump_event(tracepoint_cb tp_cb
, void *owner
, void *priv
)
204 struct cds_list_head
*sessionsp
;
205 struct lttng_session
*session
;
207 sessionsp
= _lttng_get_sessions();
208 cds_list_for_each_entry(session
, sessionsp
, node
) {
209 if (session
->owner
!= owner
)
211 if (!session
->statedump_pending
)
213 tp_cb(session
, priv
);
218 void trace_bin_info_cb(struct lttng_session
*session
, void *priv
)
220 struct bin_info_data
*bin_data
= (struct bin_info_data
*) priv
;
222 tracepoint(lttng_ust_statedump
, bin_info
,
223 session
, bin_data
->base_addr_ptr
,
224 bin_data
->resolved_path
, bin_data
->memsz
,
225 bin_data
->is_pic
, bin_data
->has_build_id
,
226 bin_data
->has_debug_link
);
230 void trace_build_id_cb(struct lttng_session
*session
, void *priv
)
232 struct bin_info_data
*bin_data
= (struct bin_info_data
*) priv
;
234 tracepoint(lttng_ust_statedump
, build_id
,
235 session
, bin_data
->base_addr_ptr
,
236 bin_data
->build_id
, bin_data
->build_id_len
);
240 void trace_debug_link_cb(struct lttng_session
*session
, void *priv
)
242 struct bin_info_data
*bin_data
= (struct bin_info_data
*) priv
;
244 tracepoint(lttng_ust_statedump
, debug_link
,
245 session
, bin_data
->base_addr_ptr
,
246 bin_data
->dbg_file
, bin_data
->crc
);
250 void trace_start_cb(struct lttng_session
*session
, void *priv
)
252 tracepoint(lttng_ust_statedump
, start
, session
);
256 void trace_end_cb(struct lttng_session
*session
, void *priv
)
258 tracepoint(lttng_ust_statedump
, end
, session
);
262 int get_elf_info(struct bin_info_data
*bin_data
)
264 struct lttng_ust_elf
*elf
;
267 elf
= lttng_ust_elf_create(bin_data
->resolved_path
);
273 ret
= lttng_ust_elf_get_memsz(elf
, &bin_data
->memsz
);
279 ret
= lttng_ust_elf_get_build_id(elf
, &bin_data
->build_id
,
280 &bin_data
->build_id_len
,
285 bin_data
->has_build_id
= !!found
;
287 ret
= lttng_ust_elf_get_debug_link(elf
, &bin_data
->dbg_file
,
293 bin_data
->has_debug_link
= !!found
;
295 bin_data
->is_pic
= lttng_ust_elf_is_pic(elf
);
298 lttng_ust_elf_destroy(elf
);
303 void trace_baddr(struct bin_info_data
*bin_data
, void *owner
)
305 trace_statedump_event(trace_bin_info_cb
, owner
, bin_data
);
307 if (bin_data
->has_build_id
)
308 trace_statedump_event(trace_build_id_cb
, owner
, bin_data
);
310 if (bin_data
->has_debug_link
)
311 trace_statedump_event(trace_debug_link_cb
, owner
, bin_data
);
315 int extract_baddr(struct bin_info_data
*bin_data
)
318 struct lttng_ust_dl_node
*e
;
320 if (!bin_data
->vdso
) {
321 ret
= get_elf_info(bin_data
);
327 bin_data
->has_build_id
= 0;
328 bin_data
->has_debug_link
= 0;
331 e
= find_or_create_dl_node(bin_data
);
338 free(bin_data
->build_id
);
339 bin_data
->build_id
= NULL
;
340 free(bin_data
->dbg_file
);
341 bin_data
->dbg_file
= NULL
;
346 void trace_statedump_start(void *owner
)
348 trace_statedump_event(trace_start_cb
, owner
, NULL
);
352 void trace_statedump_end(void *owner
)
354 trace_statedump_event(trace_end_cb
, owner
, NULL
);
358 void iter_begin(struct dl_iterate_data
*data
)
363 * UST lock nests within dynamic loader lock.
365 * Hold this lock across handling of the module listing to
366 * protect memory allocation at early process start, due to
367 * interactions with libc-wrapper lttng malloc instrumentation.
374 /* Ensure all entries are unmarked. */
375 for (i
= 0; i
< UST_DL_STATE_TABLE_SIZE
; i
++) {
376 struct cds_hlist_head
*head
;
377 struct lttng_ust_dl_node
*e
;
379 head
= &dl_state_table
[i
];
380 cds_hlist_for_each_entry_2(e
, head
, node
)
386 void trace_lib_load(const struct bin_info_data
*bin_data
, void *ip
)
388 tracepoint(lttng_ust_lib
, load
,
389 ip
, bin_data
->base_addr_ptr
, bin_data
->resolved_path
,
390 bin_data
->memsz
, bin_data
->has_build_id
,
391 bin_data
->has_debug_link
);
393 if (bin_data
->has_build_id
) {
394 tracepoint(lttng_ust_lib
, build_id
,
395 ip
, bin_data
->base_addr_ptr
, bin_data
->build_id
,
396 bin_data
->build_id_len
);
399 if (bin_data
->has_debug_link
) {
400 tracepoint(lttng_ust_lib
, debug_link
,
401 ip
, bin_data
->base_addr_ptr
, bin_data
->dbg_file
,
407 void trace_lib_unload(const struct bin_info_data
*bin_data
, void *ip
)
409 tracepoint(lttng_ust_lib
, unload
, ip
, bin_data
->base_addr_ptr
);
413 void iter_end(struct dl_iterate_data
*data
, void *ip
)
420 * Iterate on hash table.
421 * For each marked, traced, do nothing.
422 * For each marked, not traced, trace lib open event. traced = true.
423 * For each unmarked, traced, trace lib close event. remove node.
424 * For each unmarked, not traced, remove node.
426 for (i
= 0; i
< UST_DL_STATE_TABLE_SIZE
; i
++) {
427 struct cds_hlist_head
*head
;
428 struct lttng_ust_dl_node
*e
;
430 head
= &dl_state_table
[i
];
431 cds_hlist_for_each_entry_2(e
, head
, node
) {
434 trace_lib_load(&e
->bin_data
, ip
);
440 trace_lib_unload(&e
->bin_data
, ip
);
451 int extract_bin_info_events(struct dl_phdr_info
*info
, size_t size
, void *_data
)
454 struct dl_iterate_data
*data
= _data
;
464 for (j
= 0; j
< info
->dlpi_phnum
; j
++) {
465 struct bin_info_data bin_data
;
467 if (info
->dlpi_phdr
[j
].p_type
!= PT_LOAD
)
470 memset(&bin_data
, 0, sizeof(bin_data
));
472 /* Calculate virtual memory address of the loadable segment */
473 bin_data
.base_addr_ptr
= (void *) info
->dlpi_addr
+
474 info
->dlpi_phdr
[j
].p_vaddr
;
476 if ((info
->dlpi_name
== NULL
|| info
->dlpi_name
[0] == 0)) {
478 * Only the first phdr without a dlpi_name
479 * encountered is considered as the program
480 * executable. The rest are vdsos.
482 if (!data
->exec_found
) {
484 data
->exec_found
= 1;
487 * Use /proc/self/exe to resolve the
488 * executable's full path.
490 path_len
= readlink("/proc/self/exe",
491 bin_data
.resolved_path
,
496 bin_data
.resolved_path
[path_len
] = '\0';
499 snprintf(bin_data
.resolved_path
,
500 PATH_MAX
- 1, "[vdso]");
505 * For regular dl_phdr_info entries check if
506 * the path to the binary really exists. If not,
507 * treat as vdso and use dlpi_name as 'path'.
509 if (!realpath(info
->dlpi_name
,
510 bin_data
.resolved_path
)) {
511 snprintf(bin_data
.resolved_path
,
512 PATH_MAX
- 1, "[%s]",
520 ret
= extract_baddr(&bin_data
);
528 void ust_dl_table_statedump(void *owner
)
535 /* Statedump each traced table entry into session for owner. */
536 for (i
= 0; i
< UST_DL_STATE_TABLE_SIZE
; i
++) {
537 struct cds_hlist_head
*head
;
538 struct lttng_ust_dl_node
*e
;
540 head
= &dl_state_table
[i
];
541 cds_hlist_for_each_entry_2(e
, head
, node
) {
543 trace_baddr(&e
->bin_data
, owner
);
551 void lttng_ust_dl_update(void *ip
)
553 struct dl_iterate_data data
;
555 if (lttng_getenv("LTTNG_UST_WITHOUT_BADDR_STATEDUMP"))
559 * Fixup lttng-ust TLS when called from dlopen/dlclose
562 lttng_ust_fixup_tls();
568 * Iterate through the list of currently loaded shared objects and
569 * generate tables entries for loadable segments using
570 * extract_bin_info_events.
571 * Removed libraries are detected by mark-and-sweep: marking is
572 * done in the iteration over libraries, and sweeping is
573 * performed by iter_end().
575 dl_iterate_phdr(extract_bin_info_events
, &data
);
582 * Generate a statedump of base addresses of all shared objects loaded
583 * by the traced application, as well as for the application's
587 int do_baddr_statedump(void *owner
)
589 if (lttng_getenv("LTTNG_UST_WITHOUT_BADDR_STATEDUMP"))
591 lttng_ust_dl_update(LTTNG_UST_CALLER_IP());
592 ust_dl_table_statedump(owner
);
597 * Generate a statedump of a given traced application. A statedump is
598 * delimited by start and end events. For a given (process, session)
599 * pair, begin/end events are serialized and will match. However, in a
600 * session, statedumps from different processes may be
601 * interleaved. The vpid context should be used to identify which
602 * events belong to which process.
604 * Grab the ust_lock outside of the RCU read-side lock because we
605 * perform synchronize_rcu with the ust_lock held, which can trigger
606 * deadlocks otherwise.
608 int do_lttng_ust_statedump(void *owner
)
611 trace_statedump_start(owner
);
614 do_baddr_statedump(owner
);
617 trace_statedump_end(owner
);
623 void lttng_ust_statedump_init(void)
625 __tracepoints__init();
626 __tracepoints__ptrs_init();
627 __lttng_events_init__lttng_ust_statedump();
628 lttng_ust_dl_update(LTTNG_UST_CALLER_IP());
632 void ust_dl_state_destroy(void)
636 for (i
= 0; i
< UST_DL_STATE_TABLE_SIZE
; i
++) {
637 struct cds_hlist_head
*head
;
638 struct lttng_ust_dl_node
*e
, *tmp
;
640 head
= &dl_state_table
[i
];
641 cds_hlist_for_each_entry_safe_2(e
, tmp
, head
, node
)
643 CDS_INIT_HLIST_HEAD(head
);
647 void lttng_ust_statedump_destroy(void)
649 __lttng_events_exit__lttng_ust_statedump();
650 __tracepoints__ptrs_destroy();
651 __tracepoints__destroy();
652 ust_dl_state_destroy();