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
= bin
->log_level
;
183 debug_info_src
= g_new0(struct debug_info_source
, 1);
185 if (!debug_info_src
) {
189 /* Lookup function name */
190 ret
= bin_info_lookup_function_name(bin
, ip
, &debug_info_src
->func
);
195 /* Can't retrieve src_loc from ELF, or could not find binary, skip. */
196 if (!bin
->is_elf_only
|| !debug_info_src
->func
) {
197 /* Lookup source location */
198 ret
= bin_info_lookup_source_location(bin
, ip
, &src_loc
);
200 BT_COMP_LOGI("Failed to lookup source location: ret=%d", ret
);
205 debug_info_src
->line_no
=
206 g_strdup_printf("%"PRId64
, src_loc
->line_no
);
207 if (!debug_info_src
->line_no
) {
208 BT_COMP_LOGE("Error occured when setting line_no field.");
212 if (src_loc
->filename
) {
213 debug_info_src
->src_path
= g_strdup(src_loc
->filename
);
214 if (!debug_info_src
->src_path
) {
218 debug_info_src
->short_src_path
= get_filename_from_path(
219 debug_info_src
->src_path
);
221 source_location_destroy(src_loc
);
225 debug_info_src
->bin_path
= g_strdup(bin
->elf_path
);
226 if (!debug_info_src
->bin_path
) {
230 debug_info_src
->short_bin_path
= get_filename_from_path(
231 debug_info_src
->bin_path
);
233 ret
= bin_info_get_bin_loc(bin
, ip
, &(debug_info_src
->bin_loc
));
240 return debug_info_src
;
243 debug_info_source_destroy(debug_info_src
);
248 void proc_debug_info_sources_destroy(
249 struct proc_debug_info_sources
*proc_dbg_info_src
)
251 if (!proc_dbg_info_src
) {
255 if (proc_dbg_info_src
->baddr_to_bin_info
) {
256 g_hash_table_destroy(proc_dbg_info_src
->baddr_to_bin_info
);
259 if (proc_dbg_info_src
->ip_to_debug_info_src
) {
260 g_hash_table_destroy(proc_dbg_info_src
->ip_to_debug_info_src
);
263 g_free(proc_dbg_info_src
);
267 struct proc_debug_info_sources
*proc_debug_info_sources_create(void)
269 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
271 proc_dbg_info_src
= g_new0(struct proc_debug_info_sources
, 1);
272 if (!proc_dbg_info_src
) {
276 proc_dbg_info_src
->baddr_to_bin_info
= g_hash_table_new_full(
277 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
278 (GDestroyNotify
) bin_info_destroy
);
279 if (!proc_dbg_info_src
->baddr_to_bin_info
) {
283 proc_dbg_info_src
->ip_to_debug_info_src
= g_hash_table_new_full(
284 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
285 (GDestroyNotify
) debug_info_source_destroy
);
286 if (!proc_dbg_info_src
->ip_to_debug_info_src
) {
291 return proc_dbg_info_src
;
294 proc_debug_info_sources_destroy(proc_dbg_info_src
);
299 struct proc_debug_info_sources
*proc_debug_info_sources_ht_get_entry(
300 GHashTable
*ht
, int64_t vpid
)
302 gpointer key
= g_new0(int64_t, 1);
303 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
309 *((int64_t *) key
) = vpid
;
311 /* Exists? Return it */
312 proc_dbg_info_src
= g_hash_table_lookup(ht
, key
);
313 if (proc_dbg_info_src
) {
317 /* Otherwise, create and return it */
318 proc_dbg_info_src
= proc_debug_info_sources_create();
319 if (!proc_dbg_info_src
) {
323 g_hash_table_insert(ht
, key
, proc_dbg_info_src
);
324 /* Ownership passed to ht */
328 return proc_dbg_info_src
;
332 const bt_field
*event_borrow_payload_field(const bt_event
*event
,
333 const char *field_name
)
335 const bt_field
*event_payload
, *field
;
337 event_payload
= bt_event_borrow_payload_field_const(event
);
338 BT_ASSERT(event_payload
);
340 field
= bt_field_structure_borrow_member_field_by_name_const(
341 event_payload
, field_name
);
346 const bt_field
*event_borrow_common_context_field(const bt_event
*event
,
347 const char *field_name
)
349 const bt_field
*event_common_ctx
, *field
= NULL
;
351 event_common_ctx
= bt_event_borrow_common_context_field_const(event
);
352 if (!event_common_ctx
) {
356 field
= bt_field_structure_borrow_member_field_by_name_const(
357 event_common_ctx
, field_name
);
364 void event_get_common_context_signed_integer_field_value(
365 const bt_event
*event
, const char *field_name
, int64_t *value
)
367 *value
= bt_field_integer_signed_get_value(
368 event_borrow_common_context_field(event
, field_name
));
372 int event_get_payload_build_id_length(const bt_event
*event
,
373 const char *field_name
, uint64_t *build_id_len
)
375 const bt_field
*build_id_field
;
376 const bt_field_class
*build_id_field_class
;
378 build_id_field
= event_borrow_payload_field(event
, field_name
);
379 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
381 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
382 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
||
383 bt_field_class_get_type(build_id_field_class
) ==
384 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
);
385 BT_ASSERT(bt_field_class_get_type(
386 bt_field_class_array_borrow_element_field_class_const(
387 build_id_field_class
)) ==
388 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
390 *build_id_len
= bt_field_array_get_length(build_id_field
);
396 int event_get_payload_build_id_value(const bt_event
*event
,
397 const char *field_name
, uint8_t *build_id
)
399 const bt_field
*curr_field
, *build_id_field
;
400 const bt_field_class
*build_id_field_class
;
401 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
);
431 void event_get_payload_unsigned_integer_field_value(const bt_event
*event
,
432 const char *field_name
, uint64_t *value
)
434 *value
= bt_field_integer_unsigned_get_value(
435 event_borrow_payload_field(event
, field_name
));
439 void event_get_payload_string_field_value(const bt_event
*event
,
440 const char *field_name
, const char **value
)
442 *value
= bt_field_string_get_value(
443 event_borrow_payload_field(event
, field_name
));
447 bool event_has_payload_field(const bt_event
*event
,
448 const char *field_name
)
450 return event_borrow_payload_field(event
, field_name
);
454 struct debug_info_source
*proc_debug_info_sources_get_entry(
455 struct debug_info
*debug_info
,
456 struct proc_debug_info_sources
*proc_dbg_info_src
, uint64_t ip
)
458 struct debug_info_source
*debug_info_src
= NULL
;
459 gpointer key
= g_new0(uint64_t, 1);
461 gpointer baddr
, value
;
467 *((uint64_t *) key
) = ip
;
469 /* Look in IP to debug infos hash table first. */
470 debug_info_src
= g_hash_table_lookup(
471 proc_dbg_info_src
->ip_to_debug_info_src
, key
);
472 if (debug_info_src
) {
476 /* Check in all bin_infos. */
477 g_hash_table_iter_init(&iter
, proc_dbg_info_src
->baddr_to_bin_info
);
479 while (g_hash_table_iter_next(&iter
, &baddr
, &value
))
481 struct bin_info
*bin
= value
;
483 if (!bin_info_has_address(value
, ip
)) {
488 * Found; add it to cache.
490 * FIXME: this should be bounded in size (and implement
491 * a caching policy), and entries should be prunned when
492 * libraries are unmapped.
494 debug_info_src
= debug_info_source_create_from_bin(bin
, ip
,
495 debug_info
->self_comp
);
496 if (debug_info_src
) {
498 proc_dbg_info_src
->ip_to_debug_info_src
, key
,
500 /* Ownership passed to ht. */
508 return debug_info_src
;
512 struct debug_info_source
*debug_info_query(struct debug_info
*debug_info
,
513 int64_t vpid
, uint64_t ip
)
515 struct debug_info_source
*dbg_info_src
= NULL
;
516 struct proc_debug_info_sources
*proc_dbg_info_src
;
518 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
519 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
520 if (!proc_dbg_info_src
) {
524 dbg_info_src
= proc_debug_info_sources_get_entry(debug_info
,
525 proc_dbg_info_src
, ip
);
532 struct debug_info
*debug_info_create(struct debug_info_component
*comp
,
533 const bt_trace
*trace
, struct bt_fd_cache
*fdc
)
536 struct debug_info
*debug_info
;
542 debug_info
= g_new0(struct debug_info
, 1);
547 debug_info
->log_level
= comp
->log_level
;
548 debug_info
->self_comp
= comp
->self_comp
;
549 debug_info
->vpid_to_proc_dbg_info_src
= g_hash_table_new_full(
550 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
551 (GDestroyNotify
) proc_debug_info_sources_destroy
);
552 if (!debug_info
->vpid_to_proc_dbg_info_src
) {
556 debug_info
->comp
= comp
;
557 ret
= debug_info_init(debug_info
);
562 debug_info
->input_trace
= trace
;
563 debug_info
->fd_cache
= fdc
;
573 void debug_info_destroy(struct debug_info
*debug_info
)
575 bt_logging_level log_level
;
576 bt_self_component
*self_comp
;
577 bt_trace_remove_listener_status remove_listener_status
;
582 log_level
= debug_info
->log_level
;
583 self_comp
= debug_info
->self_comp
;
585 if (debug_info
->vpid_to_proc_dbg_info_src
) {
586 g_hash_table_destroy(debug_info
->vpid_to_proc_dbg_info_src
);
589 remove_listener_status
= bt_trace_remove_destruction_listener(
590 debug_info
->input_trace
,
591 debug_info
->destruction_listener_id
);
592 if (remove_listener_status
!= BT_TRACE_REMOVE_LISTENER_STATUS_OK
) {
593 BT_COMP_LOGE("Trace destruction listener removal failed.");
594 bt_current_thread_clear_error();
603 void handle_event_statedump_build_id(struct debug_info
*debug_info
,
604 const bt_event
*event
)
606 struct proc_debug_info_sources
*proc_dbg_info_src
;
607 uint64_t build_id_len
, baddr
;
608 uint8_t *build_id
= NULL
;
609 struct bin_info
*bin
;
613 event_get_common_context_signed_integer_field_value(event
,
614 VPID_FIELD_NAME
, &vpid
);
615 event_get_payload_unsigned_integer_field_value(event
,
616 BADDR_FIELD_NAME
, &baddr
);
618 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
619 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
620 if (!proc_dbg_info_src
) {
624 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
628 * The build_id event comes after the bin has been
629 * created. If it isn't found, just ignore this event.
633 ret
= event_get_payload_build_id_length(event
, BUILD_ID_FIELD_NAME
,
636 build_id
= g_new0(uint8_t, build_id_len
);
641 ret
= event_get_payload_build_id_value(event
, BUILD_ID_FIELD_NAME
,
647 ret
= bin_info_set_build_id(bin
, build_id
, build_id_len
);
653 * Reset the is_elf_only flag in case it had been set
654 * previously, because we might find separate debug info using
655 * the new build id information.
657 bin
->is_elf_only
= false;
665 void handle_event_statedump_debug_link(struct debug_info
*debug_info
,
666 const bt_event
*event
)
668 struct proc_debug_info_sources
*proc_dbg_info_src
;
669 struct bin_info
*bin
= NULL
;
672 const char *filename
= NULL
;
674 uint64_t crc_field_value
;
676 event_get_common_context_signed_integer_field_value(event
,
677 VPID_FIELD_NAME
, &vpid
);
679 event_get_payload_unsigned_integer_field_value(event
,
680 BADDR_FIELD_NAME
, &baddr
);
682 event_get_payload_unsigned_integer_field_value(event
,
683 CRC32_FIELD_NAME
, &crc_field_value
);
685 crc32
= (uint32_t) crc_field_value
;
687 event_get_payload_string_field_value(event
,
688 FILENAME_FIELD_NAME
, &filename
);
690 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
691 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
692 if (!proc_dbg_info_src
) {
696 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
700 * The debug_link event comes after the bin has been
701 * created. If it isn't found, just ignore this event.
706 bin_info_set_debug_link(bin
, filename
, crc32
);
713 void handle_bin_info_event(struct debug_info
*debug_info
,
714 const bt_event
*event
, bool has_pic_field
)
716 struct proc_debug_info_sources
*proc_dbg_info_src
;
717 struct bin_info
*bin
;
718 uint64_t baddr
, memsz
;
724 event_get_payload_unsigned_integer_field_value(event
,
725 MEMSZ_FIELD_NAME
, &memsz
);
731 event_get_payload_unsigned_integer_field_value(event
,
732 BADDR_FIELD_NAME
, &baddr
);
735 * This field is not produced by the dlopen event emitted before
738 if (!event_has_payload_field(event
, PATH_FIELD_NAME
)) {
741 event_get_payload_string_field_value(event
, PATH_FIELD_NAME
, &path
);
744 uint64_t is_pic_field_value
;
746 event_get_payload_unsigned_integer_field_value(event
,
747 IS_PIC_FIELD_NAME
, &is_pic_field_value
);
748 is_pic
= is_pic_field_value
== 1;
751 * dlopen has no is_pic field, because the shared
752 * object is always PIC.
757 event_get_common_context_signed_integer_field_value(event
,
758 VPID_FIELD_NAME
, &vpid
);
760 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
761 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
762 if (!proc_dbg_info_src
) {
766 key
= g_new0(uint64_t, 1);
771 *((uint64_t *) key
) = baddr
;
773 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
, key
);
778 bin
= bin_info_create(debug_info
->fd_cache
, path
, baddr
, memsz
, is_pic
,
779 debug_info
->comp
->arg_debug_dir
,
780 debug_info
->comp
->arg_target_prefix
,
781 debug_info
->log_level
, debug_info
->self_comp
);
786 g_hash_table_insert(proc_dbg_info_src
->baddr_to_bin_info
, key
, bin
);
787 /* Ownership passed to ht. */
796 void handle_event_statedump_bin_info(struct debug_info
*debug_info
,
797 const bt_event
*event
)
799 handle_bin_info_event(debug_info
, event
, true);
803 void handle_event_lib_load(struct debug_info
*debug_info
,
804 const bt_event
*event
)
806 handle_bin_info_event(debug_info
, event
, false);
810 void handle_event_lib_unload(struct debug_info
*debug_info
,
811 const bt_event
*event
)
814 struct proc_debug_info_sources
*proc_dbg_info_src
;
818 event_get_payload_unsigned_integer_field_value(event
, BADDR_FIELD_NAME
,
821 event_get_common_context_signed_integer_field_value(event
,
822 VPID_FIELD_NAME
, &vpid
);
824 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
825 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
826 if (!proc_dbg_info_src
) {
828 * It's an unload event for a library for which no load event
829 * was previously received.
834 ret
= g_hash_table_remove(proc_dbg_info_src
->baddr_to_bin_info
,
842 void handle_event_statedump_start(struct debug_info
*debug_info
,
843 const bt_event
*event
)
845 struct proc_debug_info_sources
*proc_dbg_info_src
;
848 event_get_common_context_signed_integer_field_value(
849 event
, VPID_FIELD_NAME
, &vpid
);
851 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
852 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
853 if (!proc_dbg_info_src
) {
857 g_hash_table_remove_all(proc_dbg_info_src
->baddr_to_bin_info
);
858 g_hash_table_remove_all(proc_dbg_info_src
->ip_to_debug_info_src
);
864 void trace_debug_info_remove_func(const bt_trace
*in_trace
, void *data
)
866 struct debug_info_msg_iter
*debug_it
= data
;
867 if (debug_it
->debug_info_map
) {
869 ret
= g_hash_table_remove(debug_it
->debug_info_map
,
870 (gpointer
) in_trace
);
876 void handle_event_statedump(struct debug_info_msg_iter
*debug_it
,
877 const bt_event
*event
)
879 const bt_event_class
*event_class
;
880 const char *event_name
;
882 const bt_trace
*trace
;
883 struct debug_info
*debug_info
;
888 event_class
= bt_event_borrow_class_const(event
);
890 event_name
= bt_event_class_get_name(event_class
);
892 trace
= bt_stream_borrow_trace_const(
893 bt_event_borrow_stream_const(event
));
895 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
, trace
);
897 bt_trace_add_listener_status add_listener_status
;
899 debug_info
= debug_info_create(debug_it
->debug_info_component
,
900 trace
, &debug_it
->fd_cache
);
901 g_hash_table_insert(debug_it
->debug_info_map
, (gpointer
) trace
,
903 add_listener_status
= bt_trace_add_destruction_listener(
904 trace
, trace_debug_info_remove_func
, debug_it
,
905 &debug_info
->destruction_listener_id
);
906 BT_ASSERT(add_listener_status
== BT_TRACE_ADD_LISTENER_STATUS_OK
);
909 q_event_name
= g_quark_try_string(event_name
);
911 if (q_event_name
== debug_info
->q_statedump_bin_info
) {
913 handle_event_statedump_bin_info(debug_info
, event
);
914 } else if (q_event_name
== debug_info
->q_dl_open
||
915 q_event_name
== debug_info
->q_lib_load
) {
917 * dl_open and lib_load events are both checked for since
918 * only dl_open was produced as of lttng-ust 2.8.
920 * lib_load, which is produced from lttng-ust 2.9+, is a lot
921 * more reliable since it will be emitted when other functions
922 * of the dlopen family are called (e.g. dlmopen) and when
923 * library are transitively loaded.
925 handle_event_lib_load(debug_info
, event
);
926 } else if (q_event_name
== debug_info
->q_statedump_start
) {
927 /* Start state dump */
928 handle_event_statedump_start(debug_info
, event
);
929 } else if (q_event_name
== debug_info
->q_statedump_debug_link
) {
930 /* Debug link info */
931 handle_event_statedump_debug_link(debug_info
, event
);
932 } else if (q_event_name
== debug_info
->q_statedump_build_id
) {
934 handle_event_statedump_build_id(debug_info
, event
);
935 } else if (q_event_name
== debug_info
-> q_lib_unload
) {
936 handle_event_lib_unload(debug_info
, event
);
943 void destroy_debug_info_comp(struct debug_info_component
*debug_info
)
949 g_free(debug_info
->arg_debug_dir
);
950 g_free(debug_info
->arg_debug_info_field_name
);
951 g_free(debug_info
->arg_target_prefix
);
956 void fill_debug_info_bin_field(struct debug_info_source
*dbg_info_src
,
957 bool full_path
, bt_field
*curr_field
,
958 bt_logging_level log_level
, bt_self_component
*self_comp
)
960 bt_field_string_set_value_status set_status
;
961 bt_field_string_append_status append_status
;
963 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
964 BT_FIELD_CLASS_TYPE_STRING
);
968 set_status
= bt_field_string_set_value(curr_field
,
969 dbg_info_src
->bin_path
);
971 set_status
= bt_field_string_set_value(curr_field
,
972 dbg_info_src
->short_bin_path
);
974 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
975 BT_COMP_LOGE("Cannot set path component of \"bin\" "
976 "curr_field field's value: str-fc-addr=%p",
978 bt_current_thread_clear_error();
981 append_status
= bt_field_string_append(curr_field
,
982 dbg_info_src
->bin_loc
);
983 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
984 BT_COMP_LOGE("Cannot set bin location component of \"bin\" "
985 "curr_field field's value: str-fc-addr=%p",
987 bt_current_thread_clear_error();
990 set_status
= bt_field_string_set_value(curr_field
, "");
991 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
992 BT_COMP_LOGE("Cannot set \"bin\" curr_field field's value: "
993 "str-fc-addr=%p", curr_field
);
994 bt_current_thread_clear_error();
1000 void fill_debug_info_func_field(struct debug_info_source
*dbg_info_src
,
1001 bt_field
*curr_field
, bt_logging_level log_level
,
1002 bt_self_component
*self_comp
)
1004 bt_field_string_set_value_status status
;
1006 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
1007 BT_FIELD_CLASS_TYPE_STRING
);
1008 if (dbg_info_src
&& dbg_info_src
->func
) {
1009 status
= bt_field_string_set_value(curr_field
,
1010 dbg_info_src
->func
);
1012 status
= bt_field_string_set_value(curr_field
, "");
1014 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1015 BT_COMP_LOGE("Cannot set \"func\" curr_field field's value: "
1016 "str-fc-addr=%p", curr_field
);
1017 bt_current_thread_clear_error();
1022 void fill_debug_info_src_field(struct debug_info_source
*dbg_info_src
,
1023 bool full_path
, bt_field
*curr_field
,
1024 bt_logging_level log_level
,
1025 bt_self_component
*self_comp
)
1027 bt_field_string_set_value_status set_status
;
1028 bt_field_string_append_status append_status
;
1030 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
1031 BT_FIELD_CLASS_TYPE_STRING
);
1033 if (dbg_info_src
&& dbg_info_src
->src_path
) {
1035 set_status
= bt_field_string_set_value(curr_field
,
1036 dbg_info_src
->src_path
);
1038 set_status
= bt_field_string_set_value(curr_field
,
1039 dbg_info_src
->short_src_path
);
1041 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1042 BT_COMP_LOGE("Cannot set path component of \"src\" "
1043 "curr_field field's value: str-fc-addr=%p",
1045 bt_current_thread_clear_error();
1048 append_status
= bt_field_string_append(curr_field
, ":");
1049 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1050 BT_COMP_LOGE("Cannot set colon component of \"src\" "
1051 "curr_field field's value: str-fc-addr=%p",
1053 bt_current_thread_clear_error();
1056 append_status
= bt_field_string_append(curr_field
,
1057 dbg_info_src
->line_no
);
1058 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1059 BT_COMP_LOGE("Cannot set line number component of \"src\" "
1060 "curr_field field's value: str-fc-addr=%p",
1062 bt_current_thread_clear_error();
1065 set_status
= bt_field_string_set_value(curr_field
, "");
1066 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1067 BT_COMP_LOGE("Cannot set \"src\" curr_field field's value: "
1068 "str-fc-addr=%p", curr_field
);
1069 bt_current_thread_clear_error();
1075 void fill_debug_info_field_empty(bt_field
*debug_info_field
,
1076 bt_logging_level log_level
, bt_self_component
*self_comp
)
1078 bt_field_string_set_value_status status
;
1079 bt_field
*bin_field
, *func_field
, *src_field
;
1081 BT_ASSERT(bt_field_get_class_type(debug_info_field
) ==
1082 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1084 bin_field
= bt_field_structure_borrow_member_field_by_name(
1085 debug_info_field
, "bin");
1086 func_field
= bt_field_structure_borrow_member_field_by_name(
1087 debug_info_field
, "func");
1088 src_field
= bt_field_structure_borrow_member_field_by_name(
1089 debug_info_field
, "src");
1091 BT_ASSERT(bt_field_get_class_type(bin_field
) ==
1092 BT_FIELD_CLASS_TYPE_STRING
);
1093 BT_ASSERT(bt_field_get_class_type(func_field
) ==
1094 BT_FIELD_CLASS_TYPE_STRING
);
1095 BT_ASSERT(bt_field_get_class_type(src_field
) ==
1096 BT_FIELD_CLASS_TYPE_STRING
);
1098 status
= bt_field_string_set_value(bin_field
, "");
1099 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1100 BT_COMP_LOGE("Cannot set \"bin\" bin_field field's value: "
1101 "str-fc-addr=%p", bin_field
);
1102 bt_current_thread_clear_error();
1105 status
= bt_field_string_set_value(func_field
, "");
1106 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1107 BT_COMP_LOGE("Cannot set \"func\" func_field field's value: "
1108 "str-fc-addr=%p", func_field
);
1109 bt_current_thread_clear_error();
1112 status
= bt_field_string_set_value(src_field
, "");
1113 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1114 BT_COMP_LOGE("Cannot set \"src\" src_field field's value: "
1115 "str-fc-addr=%p", src_field
);
1116 bt_current_thread_clear_error();
1120 void fill_debug_info_field(struct debug_info
*debug_info
, int64_t vpid
,
1121 uint64_t ip
, bt_field
*debug_info_field
)
1123 struct debug_info_source
*dbg_info_src
;
1124 const bt_field_class
*debug_info_fc
;
1126 BT_ASSERT(bt_field_get_class_type(debug_info_field
) ==
1127 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1129 debug_info_fc
= bt_field_borrow_class_const(debug_info_field
);
1131 BT_ASSERT(bt_field_class_structure_get_member_count(debug_info_fc
) == 3);
1133 dbg_info_src
= debug_info_query(debug_info
, vpid
, ip
);
1135 fill_debug_info_bin_field(dbg_info_src
,
1136 debug_info
->comp
->arg_full_path
,
1137 bt_field_structure_borrow_member_field_by_name(
1138 debug_info_field
, "bin"),
1139 debug_info
->log_level
, debug_info
->self_comp
);
1140 fill_debug_info_func_field(dbg_info_src
,
1141 bt_field_structure_borrow_member_field_by_name(
1142 debug_info_field
, "func"),
1143 debug_info
->log_level
, debug_info
->self_comp
);
1144 fill_debug_info_src_field(dbg_info_src
,
1145 debug_info
->comp
->arg_full_path
,
1146 bt_field_structure_borrow_member_field_by_name(
1147 debug_info_field
, "src"),
1148 debug_info
->log_level
, debug_info
->self_comp
);
1152 void fill_debug_info_event_if_needed(struct debug_info_msg_iter
*debug_it
,
1153 const bt_event
*in_event
, bt_event
*out_event
)
1155 bt_field
*out_common_ctx_field
, *out_debug_info_field
;
1156 const bt_field
*vpid_field
, *ip_field
, *in_common_ctx_field
;
1157 const bt_field_class
*in_common_ctx_fc
;
1158 struct debug_info
*debug_info
;
1161 gchar
*debug_info_field_name
=
1162 debug_it
->debug_info_component
->arg_debug_info_field_name
;
1163 bt_logging_level log_level
= debug_it
->log_level
;
1164 bt_self_component
*self_comp
= debug_it
->self_comp
;
1166 in_common_ctx_field
= bt_event_borrow_common_context_field_const(
1168 if (!in_common_ctx_field
) {
1170 * There is no event common context so no need to add debug
1176 in_common_ctx_fc
= bt_field_borrow_class_const(in_common_ctx_field
);
1177 if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc
,
1178 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1180 * The input event common context does not have the necessary
1181 * fields to resolve debug information.
1186 /* Borrow the debug-info field. */
1187 out_common_ctx_field
= bt_event_borrow_common_context_field(out_event
);
1188 if (!out_common_ctx_field
) {
1192 out_debug_info_field
= bt_field_structure_borrow_member_field_by_name(
1193 out_common_ctx_field
, debug_info_field_name
);
1195 vpid_field
= bt_field_structure_borrow_member_field_by_name_const(
1196 out_common_ctx_field
, VPID_FIELD_NAME
);
1197 ip_field
= bt_field_structure_borrow_member_field_by_name_const(
1198 out_common_ctx_field
, IP_FIELD_NAME
);
1200 vpid
= bt_field_integer_signed_get_value(vpid_field
);
1201 ip
= bt_field_integer_unsigned_get_value(ip_field
);
1204 * Borrow the debug_info structure needed for the source
1207 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
,
1208 bt_stream_borrow_trace_const(
1209 bt_event_borrow_stream_const(in_event
)));
1213 * Perform the debug-info resolving and set the event fields
1216 fill_debug_info_field(debug_info
, vpid
, ip
, out_debug_info_field
);
1218 BT_COMP_LOGD("No debug information for this trace. Setting debug "
1219 "info fields to empty strings.");
1220 fill_debug_info_field_empty(out_debug_info_field
,
1221 log_level
, self_comp
);
1228 void update_event_statedump_if_needed(struct debug_info_msg_iter
*debug_it
,
1229 const bt_event
*in_event
)
1231 const bt_field
*event_common_ctx
;
1232 const bt_field_class
*event_common_ctx_fc
;
1233 const bt_event_class
*in_event_class
= bt_event_borrow_class_const(in_event
);
1236 * If the event is an lttng_ust_statedump event AND has the right event
1237 * common context fields update the debug-info view for this process.
1239 event_common_ctx
= bt_event_borrow_common_context_field_const(in_event
);
1240 if (!event_common_ctx
) {
1244 event_common_ctx_fc
= bt_field_borrow_class_const(event_common_ctx
);
1245 if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc
,
1246 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1247 /* Checkout if it might be a one of lttng ust statedump events. */
1248 const char *in_event_name
= bt_event_class_get_name(in_event_class
);
1249 if (strncmp(in_event_name
, LTTNG_UST_STATEDUMP_PREFIX
,
1250 strlen(LTTNG_UST_STATEDUMP_PREFIX
)) == 0) {
1251 /* Handle statedump events. */
1252 handle_event_statedump(debug_it
, in_event
);
1260 bt_message
*handle_event_message(struct debug_info_msg_iter
*debug_it
,
1261 const bt_message
*in_message
)
1263 const bt_clock_snapshot
*cs
;
1264 const bt_clock_class
*default_cc
;
1265 const bt_packet
*in_packet
;
1266 const bt_stream
*in_stream
;
1267 const bt_stream
*out_stream
;
1268 bt_event_class
*out_event_class
;
1269 bt_packet
*out_packet
= NULL
;
1270 bt_event
*out_event
;
1271 bt_logging_level log_level
= debug_it
->log_level
;
1272 bt_self_component
*self_comp
= debug_it
->self_comp
;
1274 bt_message
*out_message
= NULL
;
1276 /* Borrow the input event and its event class. */
1277 const bt_event
*in_event
=
1278 bt_message_event_borrow_event_const(in_message
);
1279 const bt_event_class
*in_event_class
=
1280 bt_event_borrow_class_const(in_event
);
1282 update_event_statedump_if_needed(debug_it
, in_event
);
1284 out_event_class
= trace_ir_mapping_borrow_mapped_event_class(
1285 debug_it
->ir_maps
, in_event_class
);
1286 if (!out_event_class
) {
1287 out_event_class
= trace_ir_mapping_create_new_mapped_event_class(
1288 debug_it
->ir_maps
, in_event_class
);
1290 BT_ASSERT(out_event_class
);
1292 /* Borrow the input stream. */
1293 in_stream
= bt_event_borrow_stream_const(in_event
);
1294 BT_ASSERT(in_stream
);
1295 out_stream
= trace_ir_mapping_borrow_mapped_stream(debug_it
->ir_maps
,
1297 BT_ASSERT(in_stream
);
1299 /* Borrow the input and output packets. */
1300 in_packet
= bt_event_borrow_packet_const(in_event
);
1302 out_packet
= trace_ir_mapping_borrow_mapped_packet(
1303 debug_it
->ir_maps
, in_packet
);
1306 default_cc
= bt_stream_class_borrow_default_clock_class_const(
1307 bt_event_class_borrow_stream_class_const(in_event_class
));
1309 /* Borrow event clock snapshot. */
1310 cs
= bt_message_event_borrow_default_clock_snapshot_const(
1313 /* Create an output event message. */
1316 bt_message_event_create_with_packet_and_default_clock_snapshot(
1317 debug_it
->input_iterator
,
1318 out_event_class
, out_packet
,
1319 bt_clock_snapshot_get_value(cs
));
1322 bt_message_event_create_with_default_clock_snapshot(
1323 debug_it
->input_iterator
,
1324 out_event_class
, out_stream
,
1325 bt_clock_snapshot_get_value(cs
));
1329 out_message
= bt_message_event_create_with_packet(
1330 debug_it
->input_iterator
, out_event_class
,
1333 out_message
= bt_message_event_create(
1334 debug_it
->input_iterator
, out_event_class
,
1340 BT_COMP_LOGE("Error creating output event message.");
1344 out_event
= bt_message_event_borrow_event(out_message
);
1346 /* Copy the original fields to the output event. */
1347 copy_event_content(in_event
, out_event
, log_level
, self_comp
);
1350 * Try to set the debug-info fields based on debug information that is
1353 fill_debug_info_event_if_needed(debug_it
, in_event
, out_event
);
1360 bt_message
*handle_stream_begin_message(struct debug_info_msg_iter
*debug_it
,
1361 const bt_message
*in_message
)
1363 const bt_stream
*in_stream
;
1364 bt_message
*out_message
;
1365 bt_stream
*out_stream
;
1366 bt_logging_level log_level
= debug_it
->log_level
;
1367 bt_self_component
*self_comp
= debug_it
->self_comp
;
1369 in_stream
= bt_message_stream_beginning_borrow_stream_const(in_message
);
1370 BT_ASSERT(in_stream
);
1372 /* Create a duplicated output stream. */
1373 out_stream
= trace_ir_mapping_create_new_mapped_stream(
1374 debug_it
->ir_maps
, in_stream
);
1380 /* Create an output stream beginning message. */
1381 out_message
= bt_message_stream_beginning_create(
1382 debug_it
->input_iterator
, out_stream
);
1384 BT_COMP_LOGE("Error creating output stream beginning message: "
1385 "out-s-addr=%p", out_stream
);
1392 bt_message
*handle_stream_end_message(struct debug_info_msg_iter
*debug_it
,
1393 const bt_message
*in_message
)
1395 const bt_stream
*in_stream
;
1396 bt_message
*out_message
= NULL
;
1397 bt_stream
*out_stream
;
1398 bt_logging_level log_level
= debug_it
->log_level
;
1399 bt_self_component
*self_comp
= debug_it
->self_comp
;
1401 in_stream
= bt_message_stream_end_borrow_stream_const(in_message
);
1402 BT_ASSERT(in_stream
);
1404 out_stream
= trace_ir_mapping_borrow_mapped_stream(
1405 debug_it
->ir_maps
, in_stream
);
1406 BT_ASSERT(out_stream
);
1408 /* Create an output stream end message. */
1409 out_message
= bt_message_stream_end_create(debug_it
->input_iterator
,
1412 BT_COMP_LOGE("Error creating output stream end message: out-s-addr=%p",
1417 /* Remove stream from trace mapping hashtable. */
1418 trace_ir_mapping_remove_mapped_stream(debug_it
->ir_maps
, in_stream
);
1425 bt_message
*handle_packet_begin_message(struct debug_info_msg_iter
*debug_it
,
1426 const bt_message
*in_message
)
1428 bool has_default_clock_snapshot
;
1429 const bt_clock_snapshot
*cs
;
1430 bt_message
*out_message
= NULL
;
1431 bt_packet
*out_packet
;
1432 bt_logging_level log_level
= debug_it
->log_level
;
1433 bt_self_component
*self_comp
= debug_it
->self_comp
;
1435 const bt_packet
*in_packet
=
1436 bt_message_packet_beginning_borrow_packet_const(in_message
);
1437 BT_ASSERT(in_packet
);
1439 /* This packet should not be already mapped. */
1440 BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet(
1441 debug_it
->ir_maps
, in_packet
));
1443 out_packet
= trace_ir_mapping_create_new_mapped_packet(debug_it
->ir_maps
,
1446 BT_ASSERT(out_packet
);
1448 has_default_clock_snapshot
=
1449 bt_stream_class_packets_have_beginning_default_clock_snapshot(
1450 bt_stream_borrow_class_const(
1451 bt_packet_borrow_stream_const(in_packet
)));
1452 if (has_default_clock_snapshot
) {
1453 /* Borrow clock snapshot. */
1454 cs
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
1457 /* Create an output packet beginning message. */
1458 out_message
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1459 debug_it
->input_iterator
, out_packet
,
1460 bt_clock_snapshot_get_value(cs
));
1462 out_message
= bt_message_packet_beginning_create(
1463 debug_it
->input_iterator
, out_packet
);
1466 BT_COMP_LOGE("Error creating output packet beginning message: "
1467 "out-p-addr=%p", out_packet
);
1474 bt_message
*handle_packet_end_message(struct debug_info_msg_iter
*debug_it
,
1475 const bt_message
*in_message
)
1477 bool has_default_clock_snapshot
;
1478 const bt_clock_snapshot
*cs
;
1479 const bt_packet
*in_packet
;
1480 bt_message
*out_message
= NULL
;
1481 bt_packet
*out_packet
;
1482 bt_logging_level log_level
= debug_it
->log_level
;
1483 bt_self_component
*self_comp
= debug_it
->self_comp
;
1485 in_packet
= bt_message_packet_end_borrow_packet_const(in_message
);
1486 BT_ASSERT(in_packet
);
1488 out_packet
= trace_ir_mapping_borrow_mapped_packet(debug_it
->ir_maps
, in_packet
);
1489 BT_ASSERT(out_packet
);
1491 has_default_clock_snapshot
=
1492 bt_stream_class_packets_have_end_default_clock_snapshot(
1493 bt_stream_borrow_class_const(
1494 bt_packet_borrow_stream_const(in_packet
)));
1495 if (has_default_clock_snapshot
) {
1496 /* Borrow clock snapshot. */
1497 cs
= bt_message_packet_end_borrow_default_clock_snapshot_const(
1500 /* Create an outpute packet end message. */
1501 out_message
= bt_message_packet_end_create_with_default_clock_snapshot(
1502 debug_it
->input_iterator
, out_packet
,
1503 bt_clock_snapshot_get_value(cs
));
1505 out_message
= bt_message_packet_end_create(
1506 debug_it
->input_iterator
, out_packet
);
1510 BT_COMP_LOGE("Error creating output packet end message: "
1511 "out-p-addr=%p", out_packet
);
1515 /* Remove packet from data mapping hashtable. */
1516 trace_ir_mapping_remove_mapped_packet(debug_it
->ir_maps
, in_packet
);
1523 bt_message
*handle_msg_iterator_inactivity(struct debug_info_msg_iter
*debug_it
,
1524 const bt_message
*in_message
)
1527 * This message type can be forwarded directly because it does
1528 * not refer to any objects in the trace class.
1530 bt_message_get_ref(in_message
);
1531 return (bt_message
*) in_message
;
1535 bt_message
*handle_discarded_events_message(struct debug_info_msg_iter
*debug_it
,
1536 const bt_message
*in_message
)
1538 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1539 const bt_stream
*in_stream
;
1540 bool has_default_clock_snapshots
;
1541 uint64_t discarded_events
, begin_cs_value
, end_cs_value
;
1542 bt_property_availability prop_avail
;
1543 bt_message
*out_message
= NULL
;
1544 bt_stream
*out_stream
;
1545 bt_logging_level log_level
= debug_it
->log_level
;
1546 bt_self_component
*self_comp
= debug_it
->self_comp
;
1548 in_stream
= bt_message_discarded_events_borrow_stream_const(
1550 BT_ASSERT(in_stream
);
1552 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1554 BT_ASSERT(out_stream
);
1556 has_default_clock_snapshots
=
1557 bt_stream_class_discarded_events_have_default_clock_snapshots(
1558 bt_stream_borrow_class_const(in_stream
));
1559 if (has_default_clock_snapshots
) {
1560 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1562 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1565 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1566 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1568 out_message
= bt_message_discarded_events_create_with_default_clock_snapshots(
1569 debug_it
->input_iterator
, out_stream
,
1570 begin_cs_value
, end_cs_value
);
1572 out_message
= bt_message_discarded_events_create(
1573 debug_it
->input_iterator
, out_stream
);
1576 BT_COMP_LOGE("Error creating output discarded events message: "
1577 "out-s-addr=%p", out_stream
);
1581 prop_avail
= bt_message_discarded_events_get_count(in_message
,
1584 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1585 bt_message_discarded_events_set_count(out_message
,
1594 bt_message
*handle_discarded_packets_message(struct debug_info_msg_iter
*debug_it
,
1595 const bt_message
*in_message
)
1597 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1598 bool has_default_clock_snapshots
;
1599 const bt_stream
*in_stream
;
1600 uint64_t discarded_packets
, begin_cs_value
, end_cs_value
;
1601 bt_property_availability prop_avail
;
1602 bt_message
*out_message
= NULL
;
1603 bt_stream
*out_stream
;
1604 bt_logging_level log_level
= debug_it
->log_level
;
1605 bt_self_component
*self_comp
= debug_it
->self_comp
;
1607 in_stream
= bt_message_discarded_packets_borrow_stream_const(
1609 BT_ASSERT(in_stream
);
1611 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1613 BT_ASSERT(out_stream
);
1615 has_default_clock_snapshots
=
1616 bt_stream_class_discarded_packets_have_default_clock_snapshots(
1617 bt_stream_borrow_class_const(in_stream
));
1618 if (has_default_clock_snapshots
) {
1619 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1622 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1625 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1626 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1628 out_message
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1629 debug_it
->input_iterator
, out_stream
,
1630 begin_cs_value
, end_cs_value
);
1632 out_message
= bt_message_discarded_packets_create(
1633 debug_it
->input_iterator
, out_stream
);
1636 BT_COMP_LOGE("Error creating output discarded packet message: "
1637 "out-s-addr=%p", out_stream
);
1641 prop_avail
= bt_message_discarded_packets_get_count(in_message
,
1642 &discarded_packets
);
1643 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1644 bt_message_discarded_packets_set_count(out_message
,
1653 const bt_message
*handle_message(struct debug_info_msg_iter
*debug_it
,
1654 const bt_message
*in_message
)
1656 bt_message
*out_message
= NULL
;
1658 switch (bt_message_get_type(in_message
)) {
1659 case BT_MESSAGE_TYPE_EVENT
:
1660 out_message
= handle_event_message(debug_it
, in_message
);
1662 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1663 out_message
= handle_packet_begin_message(debug_it
, in_message
);
1665 case BT_MESSAGE_TYPE_PACKET_END
:
1666 out_message
= handle_packet_end_message(debug_it
, in_message
);
1668 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1669 out_message
= handle_stream_begin_message(debug_it
, in_message
);
1671 case BT_MESSAGE_TYPE_STREAM_END
:
1672 out_message
= handle_stream_end_message(debug_it
, in_message
);
1674 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1675 out_message
= handle_msg_iterator_inactivity(debug_it
, in_message
);
1677 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1678 out_message
= handle_discarded_events_message(debug_it
, in_message
);
1680 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1681 out_message
= handle_discarded_packets_message(debug_it
, in_message
);
1691 struct bt_param_validation_map_value_entry_descr debug_info_params
[] = {
1692 { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1693 { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1694 { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1695 { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
1696 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1700 bt_component_class_initialize_method_status
init_from_params(
1701 struct debug_info_component
*debug_info_component
,
1702 const bt_value
*params
)
1704 const bt_value
*value
;
1705 bt_component_class_initialize_method_status status
;
1706 bt_logging_level log_level
= debug_info_component
->log_level
;
1707 enum bt_param_validation_status validation_status
;
1708 gchar
*validate_error
= NULL
;
1710 validation_status
= bt_param_validation_validate(params
,
1711 debug_info_params
, &validate_error
);
1712 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1713 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1715 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1716 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1717 BT_COMP_LOGE_APPEND_CAUSE(debug_info_component
->self_comp
,
1718 "%s", validate_error
);
1724 value
= bt_value_map_borrow_entry_value_const(params
,
1725 "debug-info-field-name");
1727 debug_info_component
->arg_debug_info_field_name
=
1728 g_strdup(bt_value_string_get(value
));
1730 debug_info_component
->arg_debug_info_field_name
=
1731 g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME
);
1734 value
= bt_value_map_borrow_entry_value_const(params
, "debug-info-dir");
1736 debug_info_component
->arg_debug_dir
=
1737 g_strdup(bt_value_string_get(value
));
1739 debug_info_component
->arg_debug_dir
= NULL
;
1743 value
= bt_value_map_borrow_entry_value_const(params
, "target-prefix");
1745 debug_info_component
->arg_target_prefix
=
1746 g_strdup(bt_value_string_get(value
));
1748 debug_info_component
->arg_target_prefix
= NULL
;
1751 value
= bt_value_map_borrow_entry_value_const(params
, "full-path");
1753 debug_info_component
->arg_full_path
= bt_value_bool_get(value
);
1755 debug_info_component
->arg_full_path
= BT_FALSE
;
1758 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1761 g_free(validate_error
);
1767 bt_component_class_initialize_method_status
debug_info_comp_init(
1768 bt_self_component_filter
*self_comp_flt
,
1769 bt_self_component_filter_configuration
*config
,
1770 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1772 struct debug_info_component
*debug_info_comp
;
1773 bt_component_class_initialize_method_status status
=
1774 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1775 bt_self_component_add_port_status add_port_status
;
1776 bt_self_component
*self_comp
=
1777 bt_self_component_filter_as_self_component(self_comp_flt
);
1778 bt_logging_level log_level
= bt_component_get_logging_level(
1779 bt_self_component_as_component(self_comp
));
1781 BT_COMP_LOGI("Initializing debug_info component: "
1782 "comp-addr=%p, params-addr=%p", self_comp
, params
);
1784 debug_info_comp
= g_new0(struct debug_info_component
, 1);
1785 if (!debug_info_comp
) {
1786 BT_COMP_LOGE_STR("Failed to allocate one debug_info component.");
1790 debug_info_comp
->log_level
= log_level
;
1791 debug_info_comp
->self_comp
= self_comp
;
1792 bt_self_component_set_data(self_comp
, debug_info_comp
);
1794 add_port_status
= bt_self_component_filter_add_input_port(
1795 self_comp_flt
, "in", NULL
, NULL
);
1796 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1797 status
= (int) add_port_status
;
1801 add_port_status
= bt_self_component_filter_add_output_port(
1802 self_comp_flt
, "out", NULL
, NULL
);
1803 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1804 status
= (int) add_port_status
;
1808 status
= init_from_params(debug_info_comp
, params
);
1809 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1810 BT_COMP_LOGE("Cannot configure debug_info component: "
1811 "debug_info-comp-addr=%p, params-addr=%p",
1812 debug_info_comp
, params
);
1819 destroy_debug_info_comp(debug_info_comp
);
1820 bt_self_component_set_data(self_comp
, NULL
);
1822 if (status
== BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1823 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1830 void debug_info_comp_finalize(bt_self_component_filter
*self_comp_flt
)
1832 struct debug_info_component
*debug_info
=
1833 bt_self_component_get_data(
1834 bt_self_component_filter_as_self_component(
1836 bt_logging_level log_level
= debug_info
->log_level
;
1837 bt_self_component
*self_comp
= debug_info
->self_comp
;
1839 BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p",
1842 destroy_debug_info_comp(debug_info
);
1846 bt_component_class_message_iterator_next_method_status
debug_info_msg_iter_next(
1847 bt_self_message_iterator
*self_msg_iter
,
1848 const bt_message_array_const msgs
, uint64_t capacity
,
1851 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1852 bt_message_iterator_next_status upstream_iterator_ret_status
;
1853 struct debug_info_msg_iter
*debug_info_msg_iter
;
1854 struct debug_info_component
*debug_info
= NULL
;
1855 bt_component_class_message_iterator_next_method_status status
;
1856 bt_self_component
*self_comp
= NULL
;
1857 bt_message_array_const input_msgs
;
1858 const bt_message
*out_message
;
1859 uint64_t curr_msg_idx
, i
;
1861 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1863 self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
1864 BT_ASSERT(self_comp
);
1866 debug_info
= bt_self_component_get_data(self_comp
);
1867 BT_ASSERT(debug_info
);
1869 debug_info_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
1870 BT_ASSERT(debug_info_msg_iter
);
1872 upstream_iterator
= debug_info_msg_iter
->msg_iter
;
1873 BT_ASSERT(upstream_iterator
);
1875 upstream_iterator_ret_status
=
1876 bt_self_component_port_input_message_iterator_next(
1877 upstream_iterator
, &input_msgs
, count
);
1878 if (upstream_iterator_ret_status
!=
1879 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
1881 * No messages were returned. Not necessarily an error.
1882 * Convert the upstream message iterator status to a
1885 status
= (int) upstream_iterator_ret_status
;
1890 * There should never be more received messages than the capacity we
1893 BT_ASSERT(*count
<= capacity
);
1895 for (curr_msg_idx
= 0; curr_msg_idx
< *count
; curr_msg_idx
++) {
1896 out_message
= handle_message(debug_info_msg_iter
,
1897 input_msgs
[curr_msg_idx
]);
1899 goto handle_msg_error
;
1902 msgs
[curr_msg_idx
] = out_message
;
1904 * Drop our reference of the input message as we are done with
1905 * it and created a output copy.
1907 bt_message_put_ref(input_msgs
[curr_msg_idx
]);
1914 * Drop references of all the output messages created before the
1917 for (i
= 0; i
< curr_msg_idx
; i
++) {
1918 bt_message_put_ref(msgs
[i
]);
1922 * Drop references of all the input messages not dropped before the
1925 for (i
= curr_msg_idx
; i
< *count
; i
++) {
1926 bt_message_put_ref(input_msgs
[i
]);
1929 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1936 void debug_info_msg_iter_destroy(struct debug_info_msg_iter
*debug_info_msg_iter
)
1938 if (!debug_info_msg_iter
) {
1942 if (debug_info_msg_iter
->msg_iter
) {
1943 bt_self_component_port_input_message_iterator_put_ref(
1944 debug_info_msg_iter
->msg_iter
);
1947 if (debug_info_msg_iter
->ir_maps
) {
1948 trace_ir_maps_destroy(debug_info_msg_iter
->ir_maps
);
1951 if (debug_info_msg_iter
->debug_info_map
) {
1952 g_hash_table_destroy(debug_info_msg_iter
->debug_info_map
);
1955 bt_fd_cache_fini(&debug_info_msg_iter
->fd_cache
);
1956 g_free(debug_info_msg_iter
);
1963 bt_component_class_message_iterator_initialize_method_status
debug_info_msg_iter_init(
1964 bt_self_message_iterator
*self_msg_iter
,
1965 bt_self_message_iterator_configuration
*config
,
1966 bt_self_component_filter
*self_comp_flt
,
1967 bt_self_component_port_output
*self_port
)
1969 bt_component_class_message_iterator_initialize_method_status status
;
1970 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
1972 struct bt_self_component_port_input
*input_port
= NULL
;
1973 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1974 struct debug_info_msg_iter
*debug_info_msg_iter
= NULL
;
1975 gchar
*debug_info_field_name
;
1977 bt_self_component
*self_comp
=
1978 bt_self_component_filter_as_self_component(self_comp_flt
);
1979 bt_logging_level log_level
= bt_component_get_logging_level(
1980 bt_self_component_as_component(self_comp
));
1982 /* Borrow the upstream input port. */
1983 input_port
= bt_self_component_filter_borrow_input_port_by_name(
1984 self_comp_flt
, "in");
1986 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1990 debug_info_msg_iter
= g_new0(struct debug_info_msg_iter
, 1);
1991 if (!debug_info_msg_iter
) {
1992 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1996 debug_info_msg_iter
->log_level
= log_level
;
1997 debug_info_msg_iter
->self_comp
= self_comp
;
1999 /* Create an iterator on the upstream component. */
2000 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_message_iterator(
2001 self_msg_iter
, input_port
, &upstream_iterator
);
2002 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
2003 status
= (int) msg_iter_status
;
2007 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
2008 debug_info_msg_iter
->msg_iter
, upstream_iterator
);
2010 /* Create hashtable that will contain debug info mapping. */
2011 debug_info_msg_iter
->debug_info_map
= g_hash_table_new_full(
2012 g_direct_hash
, g_direct_equal
, (GDestroyNotify
) NULL
,
2013 (GDestroyNotify
) debug_info_destroy
);
2014 if (!debug_info_msg_iter
->debug_info_map
) {
2015 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2019 debug_info_msg_iter
->debug_info_component
=
2020 bt_self_component_get_data(self_comp
);
2022 debug_info_field_name
=
2023 debug_info_msg_iter
->debug_info_component
->arg_debug_info_field_name
;
2025 debug_info_msg_iter
->ir_maps
= trace_ir_maps_create(self_comp
,
2026 debug_info_field_name
, log_level
);
2027 if (!debug_info_msg_iter
->ir_maps
) {
2028 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2032 ret
= bt_fd_cache_init(&debug_info_msg_iter
->fd_cache
, log_level
);
2034 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2038 bt_self_message_iterator_configuration_set_can_seek_forward(config
,
2039 bt_self_component_port_input_message_iterator_can_seek_forward(
2040 debug_info_msg_iter
->msg_iter
));
2042 bt_self_message_iterator_set_data(self_msg_iter
, debug_info_msg_iter
);
2043 debug_info_msg_iter
->input_iterator
= self_msg_iter
;
2045 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
2049 debug_info_msg_iter_destroy(debug_info_msg_iter
);
2056 bt_component_class_message_iterator_can_seek_beginning_method_status
2057 debug_info_msg_iter_can_seek_beginning(bt_self_message_iterator
*self_msg_iter
,
2060 struct debug_info_msg_iter
*debug_info_msg_iter
=
2061 bt_self_message_iterator_get_data(self_msg_iter
);
2062 BT_ASSERT(debug_info_msg_iter
);
2064 return (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
2065 debug_info_msg_iter
->msg_iter
, can_seek
);
2069 bt_component_class_message_iterator_seek_beginning_method_status
2070 debug_info_msg_iter_seek_beginning(bt_self_message_iterator
*self_msg_iter
)
2072 struct debug_info_msg_iter
*debug_info_msg_iter
=
2073 bt_self_message_iterator_get_data(self_msg_iter
);
2074 bt_component_class_message_iterator_seek_beginning_method_status status
=
2075 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
2076 bt_message_iterator_seek_beginning_status seek_beg_status
;
2078 BT_ASSERT(debug_info_msg_iter
);
2080 /* Ask the upstream component to seek to the beginning. */
2081 seek_beg_status
= bt_self_component_port_input_message_iterator_seek_beginning(
2082 debug_info_msg_iter
->msg_iter
);
2083 if (seek_beg_status
!= BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK
) {
2084 status
= (int) seek_beg_status
;
2088 /* Clear this iterator data. */
2089 trace_ir_maps_clear(debug_info_msg_iter
->ir_maps
);
2090 g_hash_table_remove_all(debug_info_msg_iter
->debug_info_map
);
2097 void debug_info_msg_iter_finalize(bt_self_message_iterator
*it
)
2099 struct debug_info_msg_iter
*debug_info_msg_iter
;
2101 debug_info_msg_iter
= bt_self_message_iterator_get_data(it
);
2102 BT_ASSERT(debug_info_msg_iter
);
2104 debug_info_msg_iter_destroy(debug_info_msg_iter
);