2 * Babeltrace - Debug Information State Tracker
4 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
6 * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
7 * Copyright (c) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_COMP_LOG_SELF_COMP self_comp
30 #define BT_LOG_OUTPUT_LEVEL log_level
31 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO"
32 #include "logging/comp-logging.h"
36 #include "common/assert.h"
37 #include "common/common.h"
38 #include "fd-cache/fd-cache.h"
41 #include "debug-info.h"
42 #include "trace-ir-data-copy.h"
43 #include "trace-ir-mapping.h"
44 #include "trace-ir-metadata-copy.h"
46 #include "plugins/common/param-validation/param-validation.h"
48 #define DEFAULT_DEBUG_INFO_FIELD_NAME "debug_info"
49 #define LTTNG_UST_STATEDUMP_PREFIX "lttng_ust"
50 #define VPID_FIELD_NAME "vpid"
51 #define IP_FIELD_NAME "ip"
52 #define BADDR_FIELD_NAME "baddr"
53 #define CRC32_FIELD_NAME "crc"
54 #define BUILD_ID_FIELD_NAME "build_id"
55 #define FILENAME_FIELD_NAME "filename"
56 #define IS_PIC_FIELD_NAME "is_pic"
57 #define MEMSZ_FIELD_NAME "memsz"
58 #define PATH_FIELD_NAME "path"
60 struct debug_info_component
{
61 bt_logging_level log_level
;
62 bt_self_component
*self_comp
;
64 gchar
*arg_debug_info_field_name
;
65 gchar
*arg_target_prefix
;
66 bt_bool arg_full_path
;
69 struct debug_info_msg_iter
{
70 bt_logging_level log_level
;
71 struct debug_info_component
*debug_info_component
;
72 bt_self_message_iterator
*input_iterator
;
73 bt_self_component
*self_comp
;
74 bt_self_component_port_input_message_iterator
*msg_iter
;
76 struct trace_ir_maps
*ir_maps
;
77 /* in_trace -> debug_info_mapping. */
78 GHashTable
*debug_info_map
;
80 struct bt_fd_cache fd_cache
;
83 struct debug_info_source
{
84 /* Strings are owned by debug_info_source. */
87 * Store the line number as a string so that the allocation and
88 * conversion to string is only done once.
92 /* short_src_path points inside src_path, no need to free. */
93 const gchar
*short_src_path
;
95 /* short_bin_path points inside bin_path, no need to free. */
96 const gchar
*short_bin_path
;
98 * Location within the binary. Either absolute (@0x1234) or
104 struct proc_debug_info_sources
{
106 * Hash table: base address (pointer to uint64_t) to bin info; owned by
107 * proc_debug_info_sources.
109 GHashTable
*baddr_to_bin_info
;
112 * Hash table: IP (pointer to uint64_t) to (struct debug_info_source *);
113 * owned by proc_debug_info_sources.
115 GHashTable
*ip_to_debug_info_src
;
119 bt_logging_level log_level
;
120 bt_self_component
*self_comp
;
121 struct debug_info_component
*comp
;
122 const bt_trace
*input_trace
;
123 bt_listener_id destruction_listener_id
;
126 * Hash table of VPIDs (pointer to int64_t) to
127 * (struct proc_debug_info_sources*); owned by debug_info.
129 GHashTable
*vpid_to_proc_dbg_info_src
;
130 GQuark q_statedump_bin_info
;
131 GQuark q_statedump_debug_link
;
132 GQuark q_statedump_build_id
;
133 GQuark q_statedump_start
;
137 struct bt_fd_cache
*fd_cache
; /* Weak ref. Owned by the iterator. */
141 int debug_info_init(struct debug_info
*info
)
143 info
->q_statedump_bin_info
= g_quark_from_string(
144 "lttng_ust_statedump:bin_info");
145 info
->q_statedump_debug_link
= g_quark_from_string(
146 "lttng_ust_statedump:debug_link");
147 info
->q_statedump_build_id
= g_quark_from_string(
148 "lttng_ust_statedump:build_id");
149 info
->q_statedump_start
= g_quark_from_string(
150 "lttng_ust_statedump:start");
151 info
->q_dl_open
= g_quark_from_string("lttng_ust_dl:dlopen");
152 info
->q_lib_load
= g_quark_from_string("lttng_ust_lib:load");
153 info
->q_lib_unload
= g_quark_from_string("lttng_ust_lib:unload");
155 return bin_info_init(info
->log_level
, info
->self_comp
);
159 void debug_info_source_destroy(struct debug_info_source
*debug_info_src
)
161 if (!debug_info_src
) {
165 g_free(debug_info_src
->func
);
166 g_free(debug_info_src
->line_no
);
167 g_free(debug_info_src
->src_path
);
168 g_free(debug_info_src
->bin_path
);
169 g_free(debug_info_src
->bin_loc
);
170 g_free(debug_info_src
);
174 struct debug_info_source
*debug_info_source_create_from_bin(
175 struct bin_info
*bin
, uint64_t ip
,
176 bt_self_component
*self_comp
)
179 struct debug_info_source
*debug_info_src
= NULL
;
180 struct source_location
*src_loc
= NULL
;
181 bt_logging_level log_level
;
185 log_level
= bin
->log_level
;
187 debug_info_src
= g_new0(struct debug_info_source
, 1);
189 if (!debug_info_src
) {
193 /* Lookup function name */
194 ret
= bin_info_lookup_function_name(bin
, ip
, &debug_info_src
->func
);
199 /* Can't retrieve src_loc from ELF, or could not find binary, skip. */
200 if (!bin
->is_elf_only
|| !debug_info_src
->func
) {
201 /* Lookup source location */
202 ret
= bin_info_lookup_source_location(bin
, ip
, &src_loc
);
204 BT_COMP_LOGI("Failed to lookup source location: ret=%d", ret
);
209 debug_info_src
->line_no
=
210 g_strdup_printf("%"PRId64
, src_loc
->line_no
);
211 if (!debug_info_src
->line_no
) {
212 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
213 "Error occured when setting `line_no` field.");
217 if (src_loc
->filename
) {
218 debug_info_src
->src_path
= g_strdup(src_loc
->filename
);
219 if (!debug_info_src
->src_path
) {
223 debug_info_src
->short_src_path
= get_filename_from_path(
224 debug_info_src
->src_path
);
226 source_location_destroy(src_loc
);
230 debug_info_src
->bin_path
= g_strdup(bin
->elf_path
);
231 if (!debug_info_src
->bin_path
) {
235 debug_info_src
->short_bin_path
= get_filename_from_path(
236 debug_info_src
->bin_path
);
238 ret
= bin_info_get_bin_loc(bin
, ip
, &(debug_info_src
->bin_loc
));
245 return debug_info_src
;
248 debug_info_source_destroy(debug_info_src
);
253 void proc_debug_info_sources_destroy(
254 struct proc_debug_info_sources
*proc_dbg_info_src
)
256 if (!proc_dbg_info_src
) {
260 if (proc_dbg_info_src
->baddr_to_bin_info
) {
261 g_hash_table_destroy(proc_dbg_info_src
->baddr_to_bin_info
);
264 if (proc_dbg_info_src
->ip_to_debug_info_src
) {
265 g_hash_table_destroy(proc_dbg_info_src
->ip_to_debug_info_src
);
268 g_free(proc_dbg_info_src
);
272 struct proc_debug_info_sources
*proc_debug_info_sources_create(void)
274 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
276 proc_dbg_info_src
= g_new0(struct proc_debug_info_sources
, 1);
277 if (!proc_dbg_info_src
) {
281 proc_dbg_info_src
->baddr_to_bin_info
= g_hash_table_new_full(
282 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
283 (GDestroyNotify
) bin_info_destroy
);
284 if (!proc_dbg_info_src
->baddr_to_bin_info
) {
288 proc_dbg_info_src
->ip_to_debug_info_src
= g_hash_table_new_full(
289 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
290 (GDestroyNotify
) debug_info_source_destroy
);
291 if (!proc_dbg_info_src
->ip_to_debug_info_src
) {
296 return proc_dbg_info_src
;
299 proc_debug_info_sources_destroy(proc_dbg_info_src
);
304 struct proc_debug_info_sources
*proc_debug_info_sources_ht_get_entry(
305 GHashTable
*ht
, int64_t vpid
)
307 gpointer key
= g_new0(int64_t, 1);
308 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
314 *((int64_t *) key
) = vpid
;
316 /* Exists? Return it */
317 proc_dbg_info_src
= g_hash_table_lookup(ht
, key
);
318 if (proc_dbg_info_src
) {
322 /* Otherwise, create and return it */
323 proc_dbg_info_src
= proc_debug_info_sources_create();
324 if (!proc_dbg_info_src
) {
328 g_hash_table_insert(ht
, key
, proc_dbg_info_src
);
329 /* Ownership passed to ht */
333 return proc_dbg_info_src
;
337 const bt_field
*event_borrow_payload_field(const bt_event
*event
,
338 const char *field_name
)
340 const bt_field
*event_payload
, *field
;
342 event_payload
= bt_event_borrow_payload_field_const(event
);
343 BT_ASSERT_DBG(event_payload
);
345 field
= bt_field_structure_borrow_member_field_by_name_const(
346 event_payload
, field_name
);
351 const bt_field
*event_borrow_common_context_field(const bt_event
*event
,
352 const char *field_name
)
354 const bt_field
*event_common_ctx
, *field
= NULL
;
356 event_common_ctx
= bt_event_borrow_common_context_field_const(event
);
357 if (!event_common_ctx
) {
361 field
= bt_field_structure_borrow_member_field_by_name_const(
362 event_common_ctx
, field_name
);
369 void event_get_common_context_signed_integer_field_value(
370 const bt_event
*event
, const char *field_name
, int64_t *value
)
372 *value
= bt_field_integer_signed_get_value(
373 event_borrow_common_context_field(event
, field_name
));
377 void event_get_payload_build_id_length(const bt_event
*event
,
378 const char *field_name
, uint64_t *build_id_len
)
380 const bt_field
*build_id_field
;
381 const bt_field_class
*build_id_field_class
;
383 build_id_field
= event_borrow_payload_field(event
, field_name
);
384 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
386 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
387 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
||
388 bt_field_class_get_type(build_id_field_class
) ==
389 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
);
390 BT_ASSERT(bt_field_class_get_type(
391 bt_field_class_array_borrow_element_field_class_const(
392 build_id_field_class
)) ==
393 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
395 *build_id_len
= bt_field_array_get_length(build_id_field
);
399 void event_get_payload_build_id_value(const bt_event
*event
,
400 const char *field_name
, uint8_t *build_id
)
402 const bt_field
*curr_field
, *build_id_field
;
403 const bt_field_class
*build_id_field_class
;
404 uint64_t i
, build_id_len
;
406 build_id_field
= event_borrow_payload_field(event
, field_name
);
407 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
409 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
410 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
||
411 bt_field_class_get_type(build_id_field_class
) ==
412 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
);
413 BT_ASSERT(bt_field_class_get_type(
414 bt_field_class_array_borrow_element_field_class_const(
415 build_id_field_class
)) ==
416 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
418 build_id_len
= bt_field_array_get_length(build_id_field
);
420 for (i
= 0; i
< build_id_len
; i
++) {
421 curr_field
= bt_field_array_borrow_element_field_by_index_const(
424 build_id
[i
] = bt_field_integer_unsigned_get_value(curr_field
);
429 void event_get_payload_unsigned_integer_field_value(const bt_event
*event
,
430 const char *field_name
, uint64_t *value
)
432 *value
= bt_field_integer_unsigned_get_value(
433 event_borrow_payload_field(event
, field_name
));
437 void event_get_payload_string_field_value(const bt_event
*event
,
438 const char *field_name
, const char **value
)
440 *value
= bt_field_string_get_value(
441 event_borrow_payload_field(event
, field_name
));
445 bool event_has_payload_field(const bt_event
*event
,
446 const char *field_name
)
448 return event_borrow_payload_field(event
, field_name
);
452 struct debug_info_source
*proc_debug_info_sources_get_entry(
453 struct debug_info
*debug_info
,
454 struct proc_debug_info_sources
*proc_dbg_info_src
, uint64_t ip
)
456 struct debug_info_source
*debug_info_src
= NULL
;
457 gpointer key
= g_new0(uint64_t, 1);
459 gpointer baddr
, value
;
465 *((uint64_t *) key
) = ip
;
467 /* Look in IP to debug infos hash table first. */
468 debug_info_src
= g_hash_table_lookup(
469 proc_dbg_info_src
->ip_to_debug_info_src
, key
);
470 if (debug_info_src
) {
474 /* Check in all bin_infos. */
475 g_hash_table_iter_init(&iter
, proc_dbg_info_src
->baddr_to_bin_info
);
477 while (g_hash_table_iter_next(&iter
, &baddr
, &value
))
479 struct bin_info
*bin
= value
;
481 if (!bin_info_has_address(value
, ip
)) {
486 * Found; add it to cache.
488 * FIXME: this should be bounded in size (and implement
489 * a caching policy), and entries should be prunned when
490 * libraries are unmapped.
492 debug_info_src
= debug_info_source_create_from_bin(bin
, ip
,
493 debug_info
->self_comp
);
494 if (debug_info_src
) {
496 proc_dbg_info_src
->ip_to_debug_info_src
, key
,
498 /* Ownership passed to ht. */
506 return debug_info_src
;
510 struct debug_info_source
*debug_info_query(struct debug_info
*debug_info
,
511 int64_t vpid
, uint64_t ip
)
513 struct debug_info_source
*dbg_info_src
= NULL
;
514 struct proc_debug_info_sources
*proc_dbg_info_src
;
516 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
517 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
518 if (!proc_dbg_info_src
) {
522 dbg_info_src
= proc_debug_info_sources_get_entry(debug_info
,
523 proc_dbg_info_src
, ip
);
530 struct debug_info
*debug_info_create(struct debug_info_component
*comp
,
531 const bt_trace
*trace
, struct bt_fd_cache
*fdc
)
534 struct debug_info
*debug_info
;
540 debug_info
= g_new0(struct debug_info
, 1);
545 debug_info
->log_level
= comp
->log_level
;
546 debug_info
->self_comp
= comp
->self_comp
;
547 debug_info
->vpid_to_proc_dbg_info_src
= g_hash_table_new_full(
548 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
549 (GDestroyNotify
) proc_debug_info_sources_destroy
);
550 if (!debug_info
->vpid_to_proc_dbg_info_src
) {
554 debug_info
->comp
= comp
;
555 ret
= debug_info_init(debug_info
);
560 debug_info
->input_trace
= trace
;
561 debug_info
->fd_cache
= fdc
;
571 void debug_info_destroy(struct debug_info
*debug_info
)
573 bt_logging_level log_level
;
574 bt_self_component
*self_comp
;
575 bt_trace_remove_listener_status remove_listener_status
;
580 log_level
= debug_info
->log_level
;
581 self_comp
= debug_info
->self_comp
;
583 if (debug_info
->vpid_to_proc_dbg_info_src
) {
584 g_hash_table_destroy(debug_info
->vpid_to_proc_dbg_info_src
);
587 remove_listener_status
= bt_trace_remove_destruction_listener(
588 debug_info
->input_trace
,
589 debug_info
->destruction_listener_id
);
590 if (remove_listener_status
!= BT_TRACE_REMOVE_LISTENER_STATUS_OK
) {
591 BT_COMP_LOGE("Trace destruction listener removal failed.");
592 bt_current_thread_clear_error();
601 void handle_event_statedump_build_id(struct debug_info
*debug_info
,
602 const bt_event
*event
)
604 struct proc_debug_info_sources
*proc_dbg_info_src
;
605 uint64_t build_id_len
, baddr
;
606 uint8_t *build_id
= NULL
;
607 struct bin_info
*bin
;
611 event_get_common_context_signed_integer_field_value(event
,
612 VPID_FIELD_NAME
, &vpid
);
613 event_get_payload_unsigned_integer_field_value(event
,
614 BADDR_FIELD_NAME
, &baddr
);
616 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
617 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
618 if (!proc_dbg_info_src
) {
622 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
626 * The build_id event comes after the bin has been
627 * created. If it isn't found, just ignore this event.
632 event_get_payload_build_id_length(event
, BUILD_ID_FIELD_NAME
,
635 build_id
= g_new0(uint8_t, build_id_len
);
640 event_get_payload_build_id_value(event
, BUILD_ID_FIELD_NAME
, build_id
);
642 ret
= bin_info_set_build_id(bin
, build_id
, build_id_len
);
648 * Reset the is_elf_only flag in case it had been set
649 * previously, because we might find separate debug info using
650 * the new build id information.
652 bin
->is_elf_only
= false;
660 void handle_event_statedump_debug_link(struct debug_info
*debug_info
,
661 const bt_event
*event
)
663 struct proc_debug_info_sources
*proc_dbg_info_src
;
664 struct bin_info
*bin
= NULL
;
667 const char *filename
= NULL
;
669 uint64_t crc_field_value
;
671 event_get_common_context_signed_integer_field_value(event
,
672 VPID_FIELD_NAME
, &vpid
);
674 event_get_payload_unsigned_integer_field_value(event
,
675 BADDR_FIELD_NAME
, &baddr
);
677 event_get_payload_unsigned_integer_field_value(event
,
678 CRC32_FIELD_NAME
, &crc_field_value
);
680 crc32
= (uint32_t) crc_field_value
;
682 event_get_payload_string_field_value(event
,
683 FILENAME_FIELD_NAME
, &filename
);
685 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
686 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
687 if (!proc_dbg_info_src
) {
691 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
695 * The debug_link event comes after the bin has been
696 * created. If it isn't found, just ignore this event.
701 bin_info_set_debug_link(bin
, filename
, crc32
);
708 void handle_bin_info_event(struct debug_info
*debug_info
,
709 const bt_event
*event
, bool has_pic_field
)
711 struct proc_debug_info_sources
*proc_dbg_info_src
;
712 struct bin_info
*bin
;
713 uint64_t baddr
, memsz
;
719 event_get_payload_unsigned_integer_field_value(event
,
720 MEMSZ_FIELD_NAME
, &memsz
);
726 event_get_payload_unsigned_integer_field_value(event
,
727 BADDR_FIELD_NAME
, &baddr
);
730 * This field is not produced by the dlopen event emitted before
733 if (!event_has_payload_field(event
, PATH_FIELD_NAME
)) {
736 event_get_payload_string_field_value(event
, PATH_FIELD_NAME
, &path
);
739 uint64_t is_pic_field_value
;
741 event_get_payload_unsigned_integer_field_value(event
,
742 IS_PIC_FIELD_NAME
, &is_pic_field_value
);
743 is_pic
= is_pic_field_value
== 1;
746 * dlopen has no is_pic field, because the shared
747 * object is always PIC.
752 event_get_common_context_signed_integer_field_value(event
,
753 VPID_FIELD_NAME
, &vpid
);
755 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
756 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
757 if (!proc_dbg_info_src
) {
761 key
= g_new0(uint64_t, 1);
766 *((uint64_t *) key
) = baddr
;
768 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
, key
);
773 bin
= bin_info_create(debug_info
->fd_cache
, path
, baddr
, memsz
, is_pic
,
774 debug_info
->comp
->arg_debug_dir
,
775 debug_info
->comp
->arg_target_prefix
,
776 debug_info
->log_level
, debug_info
->self_comp
);
781 g_hash_table_insert(proc_dbg_info_src
->baddr_to_bin_info
, key
, bin
);
782 /* Ownership passed to ht. */
791 void handle_event_statedump_bin_info(struct debug_info
*debug_info
,
792 const bt_event
*event
)
794 handle_bin_info_event(debug_info
, event
, true);
798 void handle_event_lib_load(struct debug_info
*debug_info
,
799 const bt_event
*event
)
801 handle_bin_info_event(debug_info
, event
, false);
805 void handle_event_lib_unload(struct debug_info
*debug_info
,
806 const bt_event
*event
)
809 struct proc_debug_info_sources
*proc_dbg_info_src
;
813 event_get_payload_unsigned_integer_field_value(event
, BADDR_FIELD_NAME
,
816 event_get_common_context_signed_integer_field_value(event
,
817 VPID_FIELD_NAME
, &vpid
);
819 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
820 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
821 if (!proc_dbg_info_src
) {
823 * It's an unload event for a library for which no load event
824 * was previously received.
829 ret
= g_hash_table_remove(proc_dbg_info_src
->baddr_to_bin_info
,
837 void handle_event_statedump_start(struct debug_info
*debug_info
,
838 const bt_event
*event
)
840 struct proc_debug_info_sources
*proc_dbg_info_src
;
843 event_get_common_context_signed_integer_field_value(
844 event
, VPID_FIELD_NAME
, &vpid
);
846 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
847 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
848 if (!proc_dbg_info_src
) {
852 g_hash_table_remove_all(proc_dbg_info_src
->baddr_to_bin_info
);
853 g_hash_table_remove_all(proc_dbg_info_src
->ip_to_debug_info_src
);
860 void trace_debug_info_remove_func(const bt_trace
*in_trace
, void *data
)
862 struct debug_info_msg_iter
*debug_it
= data
;
863 if (debug_it
->debug_info_map
) {
865 ret
= g_hash_table_remove(debug_it
->debug_info_map
,
866 (gpointer
) in_trace
);
872 void handle_event_statedump(struct debug_info_msg_iter
*debug_it
,
873 const bt_event
*event
)
875 const bt_event_class
*event_class
;
876 const char *event_name
;
878 const bt_trace
*trace
;
879 struct debug_info
*debug_info
;
884 event_class
= bt_event_borrow_class_const(event
);
886 event_name
= bt_event_class_get_name(event_class
);
888 trace
= bt_stream_borrow_trace_const(
889 bt_event_borrow_stream_const(event
));
891 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
, trace
);
893 bt_trace_add_listener_status add_listener_status
;
895 debug_info
= debug_info_create(debug_it
->debug_info_component
,
896 trace
, &debug_it
->fd_cache
);
897 g_hash_table_insert(debug_it
->debug_info_map
, (gpointer
) trace
,
899 add_listener_status
= bt_trace_add_destruction_listener(
900 trace
, trace_debug_info_remove_func
, debug_it
,
901 &debug_info
->destruction_listener_id
);
902 BT_ASSERT(add_listener_status
== BT_TRACE_ADD_LISTENER_STATUS_OK
);
905 q_event_name
= g_quark_try_string(event_name
);
907 if (q_event_name
== debug_info
->q_statedump_bin_info
) {
909 handle_event_statedump_bin_info(debug_info
, event
);
910 } else if (q_event_name
== debug_info
->q_dl_open
||
911 q_event_name
== debug_info
->q_lib_load
) {
913 * dl_open and lib_load events are both checked for since
914 * only dl_open was produced as of lttng-ust 2.8.
916 * lib_load, which is produced from lttng-ust 2.9+, is a lot
917 * more reliable since it will be emitted when other functions
918 * of the dlopen family are called (e.g. dlmopen) and when
919 * library are transitively loaded.
921 handle_event_lib_load(debug_info
, event
);
922 } else if (q_event_name
== debug_info
->q_statedump_start
) {
923 /* Start state dump */
924 handle_event_statedump_start(debug_info
, event
);
925 } else if (q_event_name
== debug_info
->q_statedump_debug_link
) {
926 /* Debug link info */
927 handle_event_statedump_debug_link(debug_info
, event
);
928 } else if (q_event_name
== debug_info
->q_statedump_build_id
) {
930 handle_event_statedump_build_id(debug_info
, event
);
931 } else if (q_event_name
== debug_info
-> q_lib_unload
) {
932 handle_event_lib_unload(debug_info
, event
);
939 void destroy_debug_info_comp(struct debug_info_component
*debug_info
)
945 g_free(debug_info
->arg_debug_dir
);
946 g_free(debug_info
->arg_debug_info_field_name
);
947 g_free(debug_info
->arg_target_prefix
);
952 void fill_debug_info_bin_field(struct debug_info_source
*dbg_info_src
,
953 bool full_path
, bt_field
*curr_field
,
954 bt_logging_level log_level
, bt_self_component
*self_comp
)
956 bt_field_string_set_value_status set_status
;
957 bt_field_string_append_status append_status
;
959 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
960 BT_FIELD_CLASS_TYPE_STRING
);
964 set_status
= bt_field_string_set_value(curr_field
,
965 dbg_info_src
->bin_path
);
967 set_status
= bt_field_string_set_value(curr_field
,
968 dbg_info_src
->short_bin_path
);
970 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
971 BT_COMP_LOGE("Cannot set path component of `bin` "
972 "curr_field field's value: str-fc-addr=%p",
974 bt_current_thread_clear_error();
977 append_status
= bt_field_string_append(curr_field
,
978 dbg_info_src
->bin_loc
);
979 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
980 BT_COMP_LOGE("Cannot set bin location component of `bin` "
981 "curr_field field's value: str-fc-addr=%p",
983 bt_current_thread_clear_error();
986 set_status
= bt_field_string_set_value(curr_field
, "");
987 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
988 BT_COMP_LOGE("Cannot set `bin` curr_field field's value: "
989 "str-fc-addr=%p", curr_field
);
990 bt_current_thread_clear_error();
996 void fill_debug_info_func_field(struct debug_info_source
*dbg_info_src
,
997 bt_field
*curr_field
, bt_logging_level log_level
,
998 bt_self_component
*self_comp
)
1000 bt_field_string_set_value_status status
;
1002 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
1003 BT_FIELD_CLASS_TYPE_STRING
);
1004 if (dbg_info_src
&& dbg_info_src
->func
) {
1005 status
= bt_field_string_set_value(curr_field
,
1006 dbg_info_src
->func
);
1008 status
= bt_field_string_set_value(curr_field
, "");
1010 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1011 BT_COMP_LOGE("Cannot set `func` curr_field field's value: "
1012 "str-fc-addr=%p", curr_field
);
1013 bt_current_thread_clear_error();
1018 void fill_debug_info_src_field(struct debug_info_source
*dbg_info_src
,
1019 bool full_path
, bt_field
*curr_field
,
1020 bt_logging_level log_level
,
1021 bt_self_component
*self_comp
)
1023 bt_field_string_set_value_status set_status
;
1024 bt_field_string_append_status append_status
;
1026 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
1027 BT_FIELD_CLASS_TYPE_STRING
);
1029 if (dbg_info_src
&& dbg_info_src
->src_path
) {
1031 set_status
= bt_field_string_set_value(curr_field
,
1032 dbg_info_src
->src_path
);
1034 set_status
= bt_field_string_set_value(curr_field
,
1035 dbg_info_src
->short_src_path
);
1037 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1038 BT_COMP_LOGE("Cannot set path component of `src` "
1039 "curr_field field's value: str-fc-addr=%p",
1041 bt_current_thread_clear_error();
1044 append_status
= bt_field_string_append(curr_field
, ":");
1045 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1046 BT_COMP_LOGE("Cannot set colon component of `src` "
1047 "curr_field field's value: str-fc-addr=%p",
1049 bt_current_thread_clear_error();
1052 append_status
= bt_field_string_append(curr_field
,
1053 dbg_info_src
->line_no
);
1054 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1055 BT_COMP_LOGE("Cannot set line number component of `src` "
1056 "curr_field field's value: str-fc-addr=%p",
1058 bt_current_thread_clear_error();
1061 set_status
= bt_field_string_set_value(curr_field
, "");
1062 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1063 BT_COMP_LOGE("Cannot set `src` curr_field field's value: "
1064 "str-fc-addr=%p", curr_field
);
1065 bt_current_thread_clear_error();
1071 void fill_debug_info_field_empty(bt_field
*debug_info_field
,
1072 bt_logging_level log_level
, bt_self_component
*self_comp
)
1074 bt_field_string_set_value_status status
;
1075 bt_field
*bin_field
, *func_field
, *src_field
;
1077 BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field
) ==
1078 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1080 bin_field
= bt_field_structure_borrow_member_field_by_name(
1081 debug_info_field
, "bin");
1082 func_field
= bt_field_structure_borrow_member_field_by_name(
1083 debug_info_field
, "func");
1084 src_field
= bt_field_structure_borrow_member_field_by_name(
1085 debug_info_field
, "src");
1087 BT_ASSERT_DBG(bt_field_get_class_type(bin_field
) ==
1088 BT_FIELD_CLASS_TYPE_STRING
);
1089 BT_ASSERT_DBG(bt_field_get_class_type(func_field
) ==
1090 BT_FIELD_CLASS_TYPE_STRING
);
1091 BT_ASSERT_DBG(bt_field_get_class_type(src_field
) ==
1092 BT_FIELD_CLASS_TYPE_STRING
);
1094 status
= bt_field_string_set_value(bin_field
, "");
1095 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1096 BT_COMP_LOGE("Cannot set `bin` field's value: "
1097 "str-fc-addr=%p", bin_field
);
1098 bt_current_thread_clear_error();
1101 status
= bt_field_string_set_value(func_field
, "");
1102 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1103 BT_COMP_LOGE("Cannot set `func` field's value: "
1104 "str-fc-addr=%p", func_field
);
1105 bt_current_thread_clear_error();
1108 status
= bt_field_string_set_value(src_field
, "");
1109 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1110 BT_COMP_LOGE("Cannot set `src` field's value: "
1111 "str-fc-addr=%p", src_field
);
1112 bt_current_thread_clear_error();
1116 void fill_debug_info_field(struct debug_info
*debug_info
, int64_t vpid
,
1117 uint64_t ip
, bt_field
*debug_info_field
)
1119 struct debug_info_source
*dbg_info_src
;
1120 const bt_field_class
*debug_info_fc
;
1122 BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field
) ==
1123 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1125 debug_info_fc
= bt_field_borrow_class_const(debug_info_field
);
1127 BT_ASSERT_DBG(bt_field_class_structure_get_member_count(
1128 debug_info_fc
) == 3);
1130 dbg_info_src
= debug_info_query(debug_info
, vpid
, ip
);
1132 fill_debug_info_bin_field(dbg_info_src
,
1133 debug_info
->comp
->arg_full_path
,
1134 bt_field_structure_borrow_member_field_by_name(
1135 debug_info_field
, "bin"),
1136 debug_info
->log_level
, debug_info
->self_comp
);
1137 fill_debug_info_func_field(dbg_info_src
,
1138 bt_field_structure_borrow_member_field_by_name(
1139 debug_info_field
, "func"),
1140 debug_info
->log_level
, debug_info
->self_comp
);
1141 fill_debug_info_src_field(dbg_info_src
,
1142 debug_info
->comp
->arg_full_path
,
1143 bt_field_structure_borrow_member_field_by_name(
1144 debug_info_field
, "src"),
1145 debug_info
->log_level
, debug_info
->self_comp
);
1149 void fill_debug_info_event_if_needed(struct debug_info_msg_iter
*debug_it
,
1150 const bt_event
*in_event
, bt_event
*out_event
)
1152 bt_field
*out_common_ctx_field
, *out_debug_info_field
;
1153 const bt_field
*vpid_field
, *ip_field
, *in_common_ctx_field
;
1154 const bt_field_class
*in_common_ctx_fc
;
1155 struct debug_info
*debug_info
;
1158 gchar
*debug_info_field_name
=
1159 debug_it
->debug_info_component
->arg_debug_info_field_name
;
1160 bt_logging_level log_level
= debug_it
->log_level
;
1161 bt_self_component
*self_comp
= debug_it
->self_comp
;
1163 in_common_ctx_field
= bt_event_borrow_common_context_field_const(
1165 if (!in_common_ctx_field
) {
1167 * There is no event common context so no need to add debug
1173 in_common_ctx_fc
= bt_field_borrow_class_const(in_common_ctx_field
);
1174 if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc
,
1175 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1177 * The input event common context does not have the necessary
1178 * fields to resolve debug information.
1183 /* Borrow the debug-info field. */
1184 out_common_ctx_field
= bt_event_borrow_common_context_field(out_event
);
1185 if (!out_common_ctx_field
) {
1189 out_debug_info_field
= bt_field_structure_borrow_member_field_by_name(
1190 out_common_ctx_field
, debug_info_field_name
);
1192 vpid_field
= bt_field_structure_borrow_member_field_by_name_const(
1193 out_common_ctx_field
, VPID_FIELD_NAME
);
1194 ip_field
= bt_field_structure_borrow_member_field_by_name_const(
1195 out_common_ctx_field
, IP_FIELD_NAME
);
1197 vpid
= bt_field_integer_signed_get_value(vpid_field
);
1198 ip
= bt_field_integer_unsigned_get_value(ip_field
);
1201 * Borrow the debug_info structure needed for the source
1204 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
,
1205 bt_stream_borrow_trace_const(
1206 bt_event_borrow_stream_const(in_event
)));
1210 * Perform the debug-info resolving and set the event fields
1213 fill_debug_info_field(debug_info
, vpid
, ip
, out_debug_info_field
);
1215 BT_COMP_LOGD("No debug information for this trace. Setting debug "
1216 "info fields to empty strings.");
1217 fill_debug_info_field_empty(out_debug_info_field
,
1218 log_level
, self_comp
);
1225 void update_event_statedump_if_needed(struct debug_info_msg_iter
*debug_it
,
1226 const bt_event
*in_event
)
1228 const bt_field
*event_common_ctx
;
1229 const bt_field_class
*event_common_ctx_fc
;
1230 const bt_event_class
*in_event_class
= bt_event_borrow_class_const(in_event
);
1233 * If the event is an lttng_ust_statedump event AND has the right event
1234 * common context fields update the debug-info view for this process.
1236 event_common_ctx
= bt_event_borrow_common_context_field_const(in_event
);
1237 if (!event_common_ctx
) {
1241 event_common_ctx_fc
= bt_field_borrow_class_const(event_common_ctx
);
1242 if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc
,
1243 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1244 /* Checkout if it might be a one of lttng ust statedump events. */
1245 const char *in_event_name
= bt_event_class_get_name(in_event_class
);
1246 if (strncmp(in_event_name
, LTTNG_UST_STATEDUMP_PREFIX
,
1247 strlen(LTTNG_UST_STATEDUMP_PREFIX
)) == 0) {
1248 /* Handle statedump events. */
1249 handle_event_statedump(debug_it
, in_event
);
1257 bt_message
*handle_event_message(struct debug_info_msg_iter
*debug_it
,
1258 const bt_message
*in_message
)
1260 const bt_clock_snapshot
*cs
;
1261 const bt_clock_class
*default_cc
;
1262 const bt_packet
*in_packet
;
1263 const bt_stream
*in_stream
;
1264 const bt_stream
*out_stream
;
1265 bt_event_class
*out_event_class
;
1266 bt_packet
*out_packet
= NULL
;
1267 bt_event
*out_event
;
1268 bt_logging_level log_level
= debug_it
->log_level
;
1269 bt_self_component
*self_comp
= debug_it
->self_comp
;
1271 bt_message
*out_message
= NULL
;
1273 /* Borrow the input event and its event class. */
1274 const bt_event
*in_event
=
1275 bt_message_event_borrow_event_const(in_message
);
1276 const bt_event_class
*in_event_class
=
1277 bt_event_borrow_class_const(in_event
);
1279 update_event_statedump_if_needed(debug_it
, in_event
);
1281 out_event_class
= trace_ir_mapping_borrow_mapped_event_class(
1282 debug_it
->ir_maps
, in_event_class
);
1283 if (!out_event_class
) {
1284 out_event_class
= trace_ir_mapping_create_new_mapped_event_class(
1285 debug_it
->ir_maps
, in_event_class
);
1287 BT_ASSERT_DBG(out_event_class
);
1289 /* Borrow the input stream. */
1290 in_stream
= bt_event_borrow_stream_const(in_event
);
1291 BT_ASSERT_DBG(in_stream
);
1292 out_stream
= trace_ir_mapping_borrow_mapped_stream(debug_it
->ir_maps
,
1294 BT_ASSERT_DBG(in_stream
);
1296 /* Borrow the input and output packets. */
1297 in_packet
= bt_event_borrow_packet_const(in_event
);
1299 out_packet
= trace_ir_mapping_borrow_mapped_packet(
1300 debug_it
->ir_maps
, in_packet
);
1303 default_cc
= bt_stream_class_borrow_default_clock_class_const(
1304 bt_event_class_borrow_stream_class_const(in_event_class
));
1306 /* Borrow event clock snapshot. */
1307 cs
= bt_message_event_borrow_default_clock_snapshot_const(
1310 /* Create an output event message. */
1313 bt_message_event_create_with_packet_and_default_clock_snapshot(
1314 debug_it
->input_iterator
,
1315 out_event_class
, out_packet
,
1316 bt_clock_snapshot_get_value(cs
));
1319 bt_message_event_create_with_default_clock_snapshot(
1320 debug_it
->input_iterator
,
1321 out_event_class
, out_stream
,
1322 bt_clock_snapshot_get_value(cs
));
1326 out_message
= bt_message_event_create_with_packet(
1327 debug_it
->input_iterator
, out_event_class
,
1330 out_message
= bt_message_event_create(
1331 debug_it
->input_iterator
, out_event_class
,
1337 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1338 "Error creating output event message.");
1342 out_event
= bt_message_event_borrow_event(out_message
);
1344 /* Copy the original fields to the output event. */
1345 if (copy_event_content(in_event
, out_event
, log_level
, self_comp
) !=
1346 DEBUG_INFO_TRACE_IR_MAPPING_STATUS_OK
) {
1347 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1348 "Error copying event message content output event message: "
1349 "in-ev-addr=%p, out-ev-addr=%p", in_event
, out_event
);
1354 * Try to set the debug-info fields based on debug information that is
1357 fill_debug_info_event_if_needed(debug_it
, in_event
, out_event
);
1362 BT_MESSAGE_PUT_REF_AND_RESET(out_message
);
1368 bt_message
*handle_stream_begin_message(struct debug_info_msg_iter
*debug_it
,
1369 const bt_message
*in_message
)
1371 const bt_stream
*in_stream
;
1372 bt_message
*out_message
;
1373 bt_stream
*out_stream
;
1374 bt_logging_level log_level
= debug_it
->log_level
;
1375 bt_self_component
*self_comp
= debug_it
->self_comp
;
1377 in_stream
= bt_message_stream_beginning_borrow_stream_const(in_message
);
1378 BT_ASSERT(in_stream
);
1380 /* Create a duplicated output stream. */
1381 out_stream
= trace_ir_mapping_create_new_mapped_stream(
1382 debug_it
->ir_maps
, in_stream
);
1388 /* Create an output stream beginning message. */
1389 out_message
= bt_message_stream_beginning_create(
1390 debug_it
->input_iterator
, out_stream
);
1392 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1393 "Error creating output stream beginning message: "
1394 "out-s-addr=%p", out_stream
);
1401 bt_message
*handle_stream_end_message(struct debug_info_msg_iter
*debug_it
,
1402 const bt_message
*in_message
)
1404 const bt_stream
*in_stream
;
1405 bt_message
*out_message
= NULL
;
1406 bt_stream
*out_stream
;
1407 bt_logging_level log_level
= debug_it
->log_level
;
1408 bt_self_component
*self_comp
= debug_it
->self_comp
;
1410 in_stream
= bt_message_stream_end_borrow_stream_const(in_message
);
1411 BT_ASSERT(in_stream
);
1413 out_stream
= trace_ir_mapping_borrow_mapped_stream(
1414 debug_it
->ir_maps
, in_stream
);
1415 BT_ASSERT(out_stream
);
1417 /* Create an output stream end message. */
1418 out_message
= bt_message_stream_end_create(debug_it
->input_iterator
,
1421 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1422 "Error creating output stream end message: "
1423 "out-s-addr=%p", out_stream
);
1427 /* Remove stream from trace mapping hashtable. */
1428 trace_ir_mapping_remove_mapped_stream(debug_it
->ir_maps
, in_stream
);
1435 bt_message
*handle_packet_begin_message(struct debug_info_msg_iter
*debug_it
,
1436 const bt_message
*in_message
)
1438 bool has_default_clock_snapshot
;
1439 const bt_clock_snapshot
*cs
;
1440 bt_message
*out_message
= NULL
;
1441 bt_packet
*out_packet
;
1442 bt_logging_level log_level
= debug_it
->log_level
;
1443 bt_self_component
*self_comp
= debug_it
->self_comp
;
1445 const bt_packet
*in_packet
=
1446 bt_message_packet_beginning_borrow_packet_const(in_message
);
1447 BT_ASSERT(in_packet
);
1449 /* This packet should not be already mapped. */
1450 BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet(
1451 debug_it
->ir_maps
, in_packet
));
1453 out_packet
= trace_ir_mapping_create_new_mapped_packet(debug_it
->ir_maps
,
1456 BT_ASSERT(out_packet
);
1458 has_default_clock_snapshot
=
1459 bt_stream_class_packets_have_beginning_default_clock_snapshot(
1460 bt_stream_borrow_class_const(
1461 bt_packet_borrow_stream_const(in_packet
)));
1462 if (has_default_clock_snapshot
) {
1463 /* Borrow clock snapshot. */
1464 cs
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
1467 /* Create an output packet beginning message. */
1468 out_message
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1469 debug_it
->input_iterator
, out_packet
,
1470 bt_clock_snapshot_get_value(cs
));
1472 out_message
= bt_message_packet_beginning_create(
1473 debug_it
->input_iterator
, out_packet
);
1476 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1477 "Error creating output packet beginning message: "
1478 "out-p-addr=%p", out_packet
);
1485 bt_message
*handle_packet_end_message(struct debug_info_msg_iter
*debug_it
,
1486 const bt_message
*in_message
)
1488 bool has_default_clock_snapshot
;
1489 const bt_clock_snapshot
*cs
;
1490 const bt_packet
*in_packet
;
1491 bt_message
*out_message
= NULL
;
1492 bt_packet
*out_packet
;
1493 bt_logging_level log_level
= debug_it
->log_level
;
1494 bt_self_component
*self_comp
= debug_it
->self_comp
;
1496 in_packet
= bt_message_packet_end_borrow_packet_const(in_message
);
1497 BT_ASSERT(in_packet
);
1499 out_packet
= trace_ir_mapping_borrow_mapped_packet(debug_it
->ir_maps
, in_packet
);
1500 BT_ASSERT(out_packet
);
1502 has_default_clock_snapshot
=
1503 bt_stream_class_packets_have_end_default_clock_snapshot(
1504 bt_stream_borrow_class_const(
1505 bt_packet_borrow_stream_const(in_packet
)));
1506 if (has_default_clock_snapshot
) {
1507 /* Borrow clock snapshot. */
1508 cs
= bt_message_packet_end_borrow_default_clock_snapshot_const(
1511 /* Create an outpute packet end message. */
1512 out_message
= bt_message_packet_end_create_with_default_clock_snapshot(
1513 debug_it
->input_iterator
, out_packet
,
1514 bt_clock_snapshot_get_value(cs
));
1516 out_message
= bt_message_packet_end_create(
1517 debug_it
->input_iterator
, out_packet
);
1521 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1522 "Error creating output packet end message: "
1523 "out-p-addr=%p", out_packet
);
1527 /* Remove packet from data mapping hashtable. */
1528 trace_ir_mapping_remove_mapped_packet(debug_it
->ir_maps
, in_packet
);
1535 bt_message
*handle_msg_iterator_inactivity(struct debug_info_msg_iter
*debug_it
,
1536 const bt_message
*in_message
)
1539 * This message type can be forwarded directly because it does
1540 * not refer to any objects in the trace class.
1542 bt_message_get_ref(in_message
);
1543 return (bt_message
*) in_message
;
1547 bt_message
*handle_discarded_events_message(struct debug_info_msg_iter
*debug_it
,
1548 const bt_message
*in_message
)
1550 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1551 const bt_stream
*in_stream
;
1552 bool has_default_clock_snapshots
;
1553 uint64_t discarded_events
, begin_cs_value
, end_cs_value
;
1554 bt_property_availability prop_avail
;
1555 bt_message
*out_message
= NULL
;
1556 bt_stream
*out_stream
;
1557 bt_logging_level log_level
= debug_it
->log_level
;
1558 bt_self_component
*self_comp
= debug_it
->self_comp
;
1560 in_stream
= bt_message_discarded_events_borrow_stream_const(
1562 BT_ASSERT(in_stream
);
1564 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1566 BT_ASSERT(out_stream
);
1568 has_default_clock_snapshots
=
1569 bt_stream_class_discarded_events_have_default_clock_snapshots(
1570 bt_stream_borrow_class_const(in_stream
));
1571 if (has_default_clock_snapshots
) {
1572 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1574 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1577 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1578 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1580 out_message
= bt_message_discarded_events_create_with_default_clock_snapshots(
1581 debug_it
->input_iterator
, out_stream
,
1582 begin_cs_value
, end_cs_value
);
1584 out_message
= bt_message_discarded_events_create(
1585 debug_it
->input_iterator
, out_stream
);
1588 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1589 "Error creating output discarded events message: "
1590 "out-s-addr=%p", out_stream
);
1594 prop_avail
= bt_message_discarded_events_get_count(in_message
,
1597 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1598 bt_message_discarded_events_set_count(out_message
,
1607 bt_message
*handle_discarded_packets_message(struct debug_info_msg_iter
*debug_it
,
1608 const bt_message
*in_message
)
1610 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1611 bool has_default_clock_snapshots
;
1612 const bt_stream
*in_stream
;
1613 uint64_t discarded_packets
, begin_cs_value
, end_cs_value
;
1614 bt_property_availability prop_avail
;
1615 bt_message
*out_message
= NULL
;
1616 bt_stream
*out_stream
;
1617 bt_logging_level log_level
= debug_it
->log_level
;
1618 bt_self_component
*self_comp
= debug_it
->self_comp
;
1620 in_stream
= bt_message_discarded_packets_borrow_stream_const(
1622 BT_ASSERT(in_stream
);
1624 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1626 BT_ASSERT(out_stream
);
1628 has_default_clock_snapshots
=
1629 bt_stream_class_discarded_packets_have_default_clock_snapshots(
1630 bt_stream_borrow_class_const(in_stream
));
1631 if (has_default_clock_snapshots
) {
1632 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1635 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1638 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1639 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1641 out_message
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1642 debug_it
->input_iterator
, out_stream
,
1643 begin_cs_value
, end_cs_value
);
1645 out_message
= bt_message_discarded_packets_create(
1646 debug_it
->input_iterator
, out_stream
);
1649 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1650 "Error creating output discarded packet message: "
1651 "out-s-addr=%p", out_stream
);
1655 prop_avail
= bt_message_discarded_packets_get_count(in_message
,
1656 &discarded_packets
);
1657 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1658 bt_message_discarded_packets_set_count(out_message
,
1667 const bt_message
*handle_message(struct debug_info_msg_iter
*debug_it
,
1668 const bt_message
*in_message
)
1670 bt_message
*out_message
= NULL
;
1672 switch (bt_message_get_type(in_message
)) {
1673 case BT_MESSAGE_TYPE_EVENT
:
1674 out_message
= handle_event_message(debug_it
, in_message
);
1676 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1677 out_message
= handle_packet_begin_message(debug_it
, in_message
);
1679 case BT_MESSAGE_TYPE_PACKET_END
:
1680 out_message
= handle_packet_end_message(debug_it
, in_message
);
1682 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1683 out_message
= handle_stream_begin_message(debug_it
, in_message
);
1685 case BT_MESSAGE_TYPE_STREAM_END
:
1686 out_message
= handle_stream_end_message(debug_it
, in_message
);
1688 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1689 out_message
= handle_msg_iterator_inactivity(debug_it
, in_message
);
1691 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1692 out_message
= handle_discarded_events_message(debug_it
, in_message
);
1694 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1695 out_message
= handle_discarded_packets_message(debug_it
, in_message
);
1705 struct bt_param_validation_map_value_entry_descr debug_info_params
[] = {
1706 { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1707 { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1708 { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1709 { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
1710 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1714 bt_component_class_initialize_method_status
init_from_params(
1715 struct debug_info_component
*debug_info_component
,
1716 const bt_value
*params
)
1718 const bt_value
*value
;
1719 bt_component_class_initialize_method_status status
;
1720 bt_logging_level log_level
= debug_info_component
->log_level
;
1721 enum bt_param_validation_status validation_status
;
1722 gchar
*validate_error
= NULL
;
1724 validation_status
= bt_param_validation_validate(params
,
1725 debug_info_params
, &validate_error
);
1726 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1727 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1729 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1730 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1731 BT_COMP_LOGE_APPEND_CAUSE(debug_info_component
->self_comp
,
1732 "%s", validate_error
);
1738 value
= bt_value_map_borrow_entry_value_const(params
,
1739 "debug-info-field-name");
1741 debug_info_component
->arg_debug_info_field_name
=
1742 g_strdup(bt_value_string_get(value
));
1744 debug_info_component
->arg_debug_info_field_name
=
1745 g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME
);
1748 value
= bt_value_map_borrow_entry_value_const(params
, "debug-info-dir");
1750 debug_info_component
->arg_debug_dir
=
1751 g_strdup(bt_value_string_get(value
));
1753 debug_info_component
->arg_debug_dir
= NULL
;
1757 value
= bt_value_map_borrow_entry_value_const(params
, "target-prefix");
1759 debug_info_component
->arg_target_prefix
=
1760 g_strdup(bt_value_string_get(value
));
1762 debug_info_component
->arg_target_prefix
= NULL
;
1765 value
= bt_value_map_borrow_entry_value_const(params
, "full-path");
1767 debug_info_component
->arg_full_path
= bt_value_bool_get(value
);
1769 debug_info_component
->arg_full_path
= BT_FALSE
;
1772 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1775 g_free(validate_error
);
1781 bt_component_class_initialize_method_status
debug_info_comp_init(
1782 bt_self_component_filter
*self_comp_flt
,
1783 bt_self_component_filter_configuration
*config
,
1784 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1786 struct debug_info_component
*debug_info_comp
;
1787 bt_component_class_initialize_method_status status
=
1788 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1789 bt_self_component_add_port_status add_port_status
;
1790 bt_self_component
*self_comp
=
1791 bt_self_component_filter_as_self_component(self_comp_flt
);
1792 bt_logging_level log_level
= bt_component_get_logging_level(
1793 bt_self_component_as_component(self_comp
));
1795 BT_COMP_LOGI("Initializing debug_info component: "
1796 "comp-addr=%p, params-addr=%p", self_comp
, params
);
1798 debug_info_comp
= g_new0(struct debug_info_component
, 1);
1799 if (!debug_info_comp
) {
1800 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1801 "Failed to allocate one debug_info component.");
1805 debug_info_comp
->log_level
= log_level
;
1806 debug_info_comp
->self_comp
= self_comp
;
1807 bt_self_component_set_data(self_comp
, debug_info_comp
);
1809 add_port_status
= bt_self_component_filter_add_input_port(
1810 self_comp_flt
, "in", NULL
, NULL
);
1811 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1812 status
= (int) add_port_status
;
1816 add_port_status
= bt_self_component_filter_add_output_port(
1817 self_comp_flt
, "out", NULL
, NULL
);
1818 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1819 status
= (int) add_port_status
;
1823 status
= init_from_params(debug_info_comp
, params
);
1824 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1825 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1826 "Cannot configure debug_info component: "
1827 "debug_info-comp-addr=%p, params-addr=%p",
1828 debug_info_comp
, params
);
1835 destroy_debug_info_comp(debug_info_comp
);
1836 bt_self_component_set_data(self_comp
, NULL
);
1838 if (status
== BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1839 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1846 void debug_info_comp_finalize(bt_self_component_filter
*self_comp_flt
)
1848 struct debug_info_component
*debug_info
=
1849 bt_self_component_get_data(
1850 bt_self_component_filter_as_self_component(
1852 bt_logging_level log_level
= debug_info
->log_level
;
1853 bt_self_component
*self_comp
= debug_info
->self_comp
;
1855 BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p",
1858 destroy_debug_info_comp(debug_info
);
1862 bt_component_class_message_iterator_next_method_status
debug_info_msg_iter_next(
1863 bt_self_message_iterator
*self_msg_iter
,
1864 const bt_message_array_const msgs
, uint64_t capacity
,
1867 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1868 bt_message_iterator_next_status upstream_iterator_ret_status
;
1869 struct debug_info_msg_iter
*debug_info_msg_iter
;
1870 struct debug_info_component
*debug_info
= NULL
;
1871 bt_component_class_message_iterator_next_method_status status
;
1872 bt_self_component
*self_comp
= NULL
;
1873 bt_message_array_const input_msgs
;
1874 const bt_message
*out_message
;
1875 uint64_t curr_msg_idx
, i
;
1877 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1879 self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
1880 BT_ASSERT_DBG(self_comp
);
1882 debug_info
= bt_self_component_get_data(self_comp
);
1883 BT_ASSERT_DBG(debug_info
);
1885 debug_info_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
1886 BT_ASSERT_DBG(debug_info_msg_iter
);
1888 upstream_iterator
= debug_info_msg_iter
->msg_iter
;
1889 BT_ASSERT_DBG(upstream_iterator
);
1891 upstream_iterator_ret_status
=
1892 bt_self_component_port_input_message_iterator_next(
1893 upstream_iterator
, &input_msgs
, count
);
1894 if (upstream_iterator_ret_status
!=
1895 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
1897 * No messages were returned. Not necessarily an error.
1898 * Convert the upstream message iterator status to a
1901 status
= (int) upstream_iterator_ret_status
;
1906 * There should never be more received messages than the capacity we
1909 BT_ASSERT_DBG(*count
<= capacity
);
1911 for (curr_msg_idx
= 0; curr_msg_idx
< *count
; curr_msg_idx
++) {
1912 out_message
= handle_message(debug_info_msg_iter
,
1913 input_msgs
[curr_msg_idx
]);
1915 goto handle_msg_error
;
1918 msgs
[curr_msg_idx
] = out_message
;
1920 * Drop our reference of the input message as we are done with
1921 * it and created a output copy.
1923 bt_message_put_ref(input_msgs
[curr_msg_idx
]);
1930 * Drop references of all the output messages created before the
1933 for (i
= 0; i
< curr_msg_idx
; i
++) {
1934 bt_message_put_ref(msgs
[i
]);
1938 * Drop references of all the input messages not dropped before the
1941 for (i
= curr_msg_idx
; i
< *count
; i
++) {
1942 bt_message_put_ref(input_msgs
[i
]);
1945 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1952 void debug_info_msg_iter_destroy(struct debug_info_msg_iter
*debug_info_msg_iter
)
1954 if (!debug_info_msg_iter
) {
1958 if (debug_info_msg_iter
->msg_iter
) {
1959 bt_self_component_port_input_message_iterator_put_ref(
1960 debug_info_msg_iter
->msg_iter
);
1963 if (debug_info_msg_iter
->ir_maps
) {
1964 trace_ir_maps_destroy(debug_info_msg_iter
->ir_maps
);
1967 if (debug_info_msg_iter
->debug_info_map
) {
1968 g_hash_table_destroy(debug_info_msg_iter
->debug_info_map
);
1971 bt_fd_cache_fini(&debug_info_msg_iter
->fd_cache
);
1972 g_free(debug_info_msg_iter
);
1979 bt_component_class_message_iterator_initialize_method_status
debug_info_msg_iter_init(
1980 bt_self_message_iterator
*self_msg_iter
,
1981 bt_self_message_iterator_configuration
*config
,
1982 bt_self_component_filter
*self_comp_flt
,
1983 bt_self_component_port_output
*self_port
)
1985 bt_component_class_message_iterator_initialize_method_status status
;
1986 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
1988 struct bt_self_component_port_input
*input_port
= NULL
;
1989 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1990 struct debug_info_msg_iter
*debug_info_msg_iter
= NULL
;
1991 gchar
*debug_info_field_name
;
1993 bt_self_component
*self_comp
=
1994 bt_self_component_filter_as_self_component(self_comp_flt
);
1995 bt_logging_level log_level
= bt_component_get_logging_level(
1996 bt_self_component_as_component(self_comp
));
1998 /* Borrow the upstream input port. */
1999 input_port
= bt_self_component_filter_borrow_input_port_by_name(
2000 self_comp_flt
, "in");
2002 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
2006 debug_info_msg_iter
= g_new0(struct debug_info_msg_iter
, 1);
2007 if (!debug_info_msg_iter
) {
2008 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2012 debug_info_msg_iter
->log_level
= log_level
;
2013 debug_info_msg_iter
->self_comp
= self_comp
;
2015 /* Create an iterator on the upstream component. */
2016 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_message_iterator(
2017 self_msg_iter
, input_port
, &upstream_iterator
);
2018 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
2019 status
= (int) msg_iter_status
;
2023 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
2024 debug_info_msg_iter
->msg_iter
, upstream_iterator
);
2026 /* Create hashtable that will contain debug info mapping. */
2027 debug_info_msg_iter
->debug_info_map
= g_hash_table_new_full(
2028 g_direct_hash
, g_direct_equal
, (GDestroyNotify
) NULL
,
2029 (GDestroyNotify
) debug_info_destroy
);
2030 if (!debug_info_msg_iter
->debug_info_map
) {
2031 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2035 debug_info_msg_iter
->debug_info_component
=
2036 bt_self_component_get_data(self_comp
);
2038 debug_info_field_name
=
2039 debug_info_msg_iter
->debug_info_component
->arg_debug_info_field_name
;
2041 debug_info_msg_iter
->ir_maps
= trace_ir_maps_create(self_comp
,
2042 debug_info_field_name
, log_level
);
2043 if (!debug_info_msg_iter
->ir_maps
) {
2044 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2048 ret
= bt_fd_cache_init(&debug_info_msg_iter
->fd_cache
, log_level
);
2050 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2054 bt_self_message_iterator_configuration_set_can_seek_forward(config
,
2055 bt_self_component_port_input_message_iterator_can_seek_forward(
2056 debug_info_msg_iter
->msg_iter
));
2058 bt_self_message_iterator_set_data(self_msg_iter
, debug_info_msg_iter
);
2059 debug_info_msg_iter
->input_iterator
= self_msg_iter
;
2061 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
2065 debug_info_msg_iter_destroy(debug_info_msg_iter
);
2072 bt_component_class_message_iterator_can_seek_beginning_method_status
2073 debug_info_msg_iter_can_seek_beginning(bt_self_message_iterator
*self_msg_iter
,
2076 struct debug_info_msg_iter
*debug_info_msg_iter
=
2077 bt_self_message_iterator_get_data(self_msg_iter
);
2078 BT_ASSERT(debug_info_msg_iter
);
2080 return (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
2081 debug_info_msg_iter
->msg_iter
, can_seek
);
2085 bt_component_class_message_iterator_seek_beginning_method_status
2086 debug_info_msg_iter_seek_beginning(bt_self_message_iterator
*self_msg_iter
)
2088 struct debug_info_msg_iter
*debug_info_msg_iter
=
2089 bt_self_message_iterator_get_data(self_msg_iter
);
2090 bt_component_class_message_iterator_seek_beginning_method_status status
=
2091 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
2092 bt_message_iterator_seek_beginning_status seek_beg_status
;
2094 BT_ASSERT(debug_info_msg_iter
);
2096 /* Ask the upstream component to seek to the beginning. */
2097 seek_beg_status
= bt_self_component_port_input_message_iterator_seek_beginning(
2098 debug_info_msg_iter
->msg_iter
);
2099 if (seek_beg_status
!= BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK
) {
2100 status
= (int) seek_beg_status
;
2104 /* Clear this iterator data. */
2105 trace_ir_maps_clear(debug_info_msg_iter
->ir_maps
);
2106 g_hash_table_remove_all(debug_info_msg_iter
->debug_info_map
);
2113 void debug_info_msg_iter_finalize(bt_self_message_iterator
*it
)
2115 struct debug_info_msg_iter
*debug_info_msg_iter
;
2117 debug_info_msg_iter
= bt_self_message_iterator_get_data(it
);
2118 BT_ASSERT(debug_info_msg_iter
);
2120 debug_info_msg_iter_destroy(debug_info_msg_iter
);