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_APPEND_CAUSE(self_comp
,
209 "Error occured when setting `line_no` field.");
213 if (src_loc
->filename
) {
214 debug_info_src
->src_path
= g_strdup(src_loc
->filename
);
215 if (!debug_info_src
->src_path
) {
219 debug_info_src
->short_src_path
= get_filename_from_path(
220 debug_info_src
->src_path
);
222 source_location_destroy(src_loc
);
226 debug_info_src
->bin_path
= g_strdup(bin
->elf_path
);
227 if (!debug_info_src
->bin_path
) {
231 debug_info_src
->short_bin_path
= get_filename_from_path(
232 debug_info_src
->bin_path
);
234 ret
= bin_info_get_bin_loc(bin
, ip
, &(debug_info_src
->bin_loc
));
241 return debug_info_src
;
244 debug_info_source_destroy(debug_info_src
);
249 void proc_debug_info_sources_destroy(
250 struct proc_debug_info_sources
*proc_dbg_info_src
)
252 if (!proc_dbg_info_src
) {
256 if (proc_dbg_info_src
->baddr_to_bin_info
) {
257 g_hash_table_destroy(proc_dbg_info_src
->baddr_to_bin_info
);
260 if (proc_dbg_info_src
->ip_to_debug_info_src
) {
261 g_hash_table_destroy(proc_dbg_info_src
->ip_to_debug_info_src
);
264 g_free(proc_dbg_info_src
);
268 struct proc_debug_info_sources
*proc_debug_info_sources_create(void)
270 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
272 proc_dbg_info_src
= g_new0(struct proc_debug_info_sources
, 1);
273 if (!proc_dbg_info_src
) {
277 proc_dbg_info_src
->baddr_to_bin_info
= g_hash_table_new_full(
278 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
279 (GDestroyNotify
) bin_info_destroy
);
280 if (!proc_dbg_info_src
->baddr_to_bin_info
) {
284 proc_dbg_info_src
->ip_to_debug_info_src
= g_hash_table_new_full(
285 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
286 (GDestroyNotify
) debug_info_source_destroy
);
287 if (!proc_dbg_info_src
->ip_to_debug_info_src
) {
292 return proc_dbg_info_src
;
295 proc_debug_info_sources_destroy(proc_dbg_info_src
);
300 struct proc_debug_info_sources
*proc_debug_info_sources_ht_get_entry(
301 GHashTable
*ht
, int64_t vpid
)
303 gpointer key
= g_new0(int64_t, 1);
304 struct proc_debug_info_sources
*proc_dbg_info_src
= NULL
;
310 *((int64_t *) key
) = vpid
;
312 /* Exists? Return it */
313 proc_dbg_info_src
= g_hash_table_lookup(ht
, key
);
314 if (proc_dbg_info_src
) {
318 /* Otherwise, create and return it */
319 proc_dbg_info_src
= proc_debug_info_sources_create();
320 if (!proc_dbg_info_src
) {
324 g_hash_table_insert(ht
, key
, proc_dbg_info_src
);
325 /* Ownership passed to ht */
329 return proc_dbg_info_src
;
333 const bt_field
*event_borrow_payload_field(const bt_event
*event
,
334 const char *field_name
)
336 const bt_field
*event_payload
, *field
;
338 event_payload
= bt_event_borrow_payload_field_const(event
);
339 BT_ASSERT_DBG(event_payload
);
341 field
= bt_field_structure_borrow_member_field_by_name_const(
342 event_payload
, field_name
);
347 const bt_field
*event_borrow_common_context_field(const bt_event
*event
,
348 const char *field_name
)
350 const bt_field
*event_common_ctx
, *field
= NULL
;
352 event_common_ctx
= bt_event_borrow_common_context_field_const(event
);
353 if (!event_common_ctx
) {
357 field
= bt_field_structure_borrow_member_field_by_name_const(
358 event_common_ctx
, field_name
);
365 void event_get_common_context_signed_integer_field_value(
366 const bt_event
*event
, const char *field_name
, int64_t *value
)
368 *value
= bt_field_integer_signed_get_value(
369 event_borrow_common_context_field(event
, field_name
));
373 void event_get_payload_build_id_length(const bt_event
*event
,
374 const char *field_name
, uint64_t *build_id_len
)
376 const bt_field
*build_id_field
;
377 const bt_field_class
*build_id_field_class
;
379 build_id_field
= event_borrow_payload_field(event
, field_name
);
380 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
382 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
383 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
||
384 bt_field_class_get_type(build_id_field_class
) ==
385 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
);
386 BT_ASSERT(bt_field_class_get_type(
387 bt_field_class_array_borrow_element_field_class_const(
388 build_id_field_class
)) ==
389 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
391 *build_id_len
= bt_field_array_get_length(build_id_field
);
395 void event_get_payload_build_id_value(const bt_event
*event
,
396 const char *field_name
, uint8_t *build_id
)
398 const bt_field
*curr_field
, *build_id_field
;
399 const bt_field_class
*build_id_field_class
;
400 uint64_t i
, build_id_len
;
402 build_id_field
= event_borrow_payload_field(event
, field_name
);
403 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
405 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
406 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
||
407 bt_field_class_get_type(build_id_field_class
) ==
408 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
);
409 BT_ASSERT(bt_field_class_get_type(
410 bt_field_class_array_borrow_element_field_class_const(
411 build_id_field_class
)) ==
412 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
414 build_id_len
= bt_field_array_get_length(build_id_field
);
416 for (i
= 0; i
< build_id_len
; i
++) {
417 curr_field
= bt_field_array_borrow_element_field_by_index_const(
420 build_id
[i
] = bt_field_integer_unsigned_get_value(curr_field
);
425 void event_get_payload_unsigned_integer_field_value(const bt_event
*event
,
426 const char *field_name
, uint64_t *value
)
428 *value
= bt_field_integer_unsigned_get_value(
429 event_borrow_payload_field(event
, field_name
));
433 void event_get_payload_string_field_value(const bt_event
*event
,
434 const char *field_name
, const char **value
)
436 *value
= bt_field_string_get_value(
437 event_borrow_payload_field(event
, field_name
));
441 bool event_has_payload_field(const bt_event
*event
,
442 const char *field_name
)
444 return event_borrow_payload_field(event
, field_name
);
448 struct debug_info_source
*proc_debug_info_sources_get_entry(
449 struct debug_info
*debug_info
,
450 struct proc_debug_info_sources
*proc_dbg_info_src
, uint64_t ip
)
452 struct debug_info_source
*debug_info_src
= NULL
;
453 gpointer key
= g_new0(uint64_t, 1);
455 gpointer baddr
, value
;
461 *((uint64_t *) key
) = ip
;
463 /* Look in IP to debug infos hash table first. */
464 debug_info_src
= g_hash_table_lookup(
465 proc_dbg_info_src
->ip_to_debug_info_src
, key
);
466 if (debug_info_src
) {
470 /* Check in all bin_infos. */
471 g_hash_table_iter_init(&iter
, proc_dbg_info_src
->baddr_to_bin_info
);
473 while (g_hash_table_iter_next(&iter
, &baddr
, &value
))
475 struct bin_info
*bin
= value
;
477 if (!bin_info_has_address(value
, ip
)) {
482 * Found; add it to cache.
484 * FIXME: this should be bounded in size (and implement
485 * a caching policy), and entries should be prunned when
486 * libraries are unmapped.
488 debug_info_src
= debug_info_source_create_from_bin(bin
, ip
,
489 debug_info
->self_comp
);
490 if (debug_info_src
) {
492 proc_dbg_info_src
->ip_to_debug_info_src
, key
,
494 /* Ownership passed to ht. */
502 return debug_info_src
;
506 struct debug_info_source
*debug_info_query(struct debug_info
*debug_info
,
507 int64_t vpid
, uint64_t ip
)
509 struct debug_info_source
*dbg_info_src
= NULL
;
510 struct proc_debug_info_sources
*proc_dbg_info_src
;
512 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
513 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
514 if (!proc_dbg_info_src
) {
518 dbg_info_src
= proc_debug_info_sources_get_entry(debug_info
,
519 proc_dbg_info_src
, ip
);
526 struct debug_info
*debug_info_create(struct debug_info_component
*comp
,
527 const bt_trace
*trace
, struct bt_fd_cache
*fdc
)
530 struct debug_info
*debug_info
;
536 debug_info
= g_new0(struct debug_info
, 1);
541 debug_info
->log_level
= comp
->log_level
;
542 debug_info
->self_comp
= comp
->self_comp
;
543 debug_info
->vpid_to_proc_dbg_info_src
= g_hash_table_new_full(
544 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
545 (GDestroyNotify
) proc_debug_info_sources_destroy
);
546 if (!debug_info
->vpid_to_proc_dbg_info_src
) {
550 debug_info
->comp
= comp
;
551 ret
= debug_info_init(debug_info
);
556 debug_info
->input_trace
= trace
;
557 debug_info
->fd_cache
= fdc
;
567 void debug_info_destroy(struct debug_info
*debug_info
)
569 bt_logging_level log_level
;
570 bt_self_component
*self_comp
;
571 bt_trace_remove_listener_status remove_listener_status
;
576 log_level
= debug_info
->log_level
;
577 self_comp
= debug_info
->self_comp
;
579 if (debug_info
->vpid_to_proc_dbg_info_src
) {
580 g_hash_table_destroy(debug_info
->vpid_to_proc_dbg_info_src
);
583 remove_listener_status
= bt_trace_remove_destruction_listener(
584 debug_info
->input_trace
,
585 debug_info
->destruction_listener_id
);
586 if (remove_listener_status
!= BT_TRACE_REMOVE_LISTENER_STATUS_OK
) {
587 BT_COMP_LOGE("Trace destruction listener removal failed.");
588 bt_current_thread_clear_error();
597 void handle_event_statedump_build_id(struct debug_info
*debug_info
,
598 const bt_event
*event
)
600 struct proc_debug_info_sources
*proc_dbg_info_src
;
601 uint64_t build_id_len
, baddr
;
602 uint8_t *build_id
= NULL
;
603 struct bin_info
*bin
;
607 event_get_common_context_signed_integer_field_value(event
,
608 VPID_FIELD_NAME
, &vpid
);
609 event_get_payload_unsigned_integer_field_value(event
,
610 BADDR_FIELD_NAME
, &baddr
);
612 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
613 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
614 if (!proc_dbg_info_src
) {
618 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
622 * The build_id event comes after the bin has been
623 * created. If it isn't found, just ignore this event.
628 event_get_payload_build_id_length(event
, BUILD_ID_FIELD_NAME
,
631 build_id
= g_new0(uint8_t, build_id_len
);
636 event_get_payload_build_id_value(event
, BUILD_ID_FIELD_NAME
, build_id
);
638 ret
= bin_info_set_build_id(bin
, build_id
, build_id_len
);
644 * Reset the is_elf_only flag in case it had been set
645 * previously, because we might find separate debug info using
646 * the new build id information.
648 bin
->is_elf_only
= false;
656 void handle_event_statedump_debug_link(struct debug_info
*debug_info
,
657 const bt_event
*event
)
659 struct proc_debug_info_sources
*proc_dbg_info_src
;
660 struct bin_info
*bin
= NULL
;
663 const char *filename
= NULL
;
665 uint64_t crc_field_value
;
667 event_get_common_context_signed_integer_field_value(event
,
668 VPID_FIELD_NAME
, &vpid
);
670 event_get_payload_unsigned_integer_field_value(event
,
671 BADDR_FIELD_NAME
, &baddr
);
673 event_get_payload_unsigned_integer_field_value(event
,
674 CRC32_FIELD_NAME
, &crc_field_value
);
676 crc32
= (uint32_t) crc_field_value
;
678 event_get_payload_string_field_value(event
,
679 FILENAME_FIELD_NAME
, &filename
);
681 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
682 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
683 if (!proc_dbg_info_src
) {
687 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
691 * The debug_link event comes after the bin has been
692 * created. If it isn't found, just ignore this event.
697 bin_info_set_debug_link(bin
, filename
, crc32
);
704 void handle_bin_info_event(struct debug_info
*debug_info
,
705 const bt_event
*event
, bool has_pic_field
)
707 struct proc_debug_info_sources
*proc_dbg_info_src
;
708 struct bin_info
*bin
;
709 uint64_t baddr
, memsz
;
715 event_get_payload_unsigned_integer_field_value(event
,
716 MEMSZ_FIELD_NAME
, &memsz
);
722 event_get_payload_unsigned_integer_field_value(event
,
723 BADDR_FIELD_NAME
, &baddr
);
726 * This field is not produced by the dlopen event emitted before
729 if (!event_has_payload_field(event
, PATH_FIELD_NAME
)) {
732 event_get_payload_string_field_value(event
, PATH_FIELD_NAME
, &path
);
735 uint64_t is_pic_field_value
;
737 event_get_payload_unsigned_integer_field_value(event
,
738 IS_PIC_FIELD_NAME
, &is_pic_field_value
);
739 is_pic
= is_pic_field_value
== 1;
742 * dlopen has no is_pic field, because the shared
743 * object is always PIC.
748 event_get_common_context_signed_integer_field_value(event
,
749 VPID_FIELD_NAME
, &vpid
);
751 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
752 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
753 if (!proc_dbg_info_src
) {
757 key
= g_new0(uint64_t, 1);
762 *((uint64_t *) key
) = baddr
;
764 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
, key
);
769 bin
= bin_info_create(debug_info
->fd_cache
, path
, baddr
, memsz
, is_pic
,
770 debug_info
->comp
->arg_debug_dir
,
771 debug_info
->comp
->arg_target_prefix
,
772 debug_info
->log_level
, debug_info
->self_comp
);
777 g_hash_table_insert(proc_dbg_info_src
->baddr_to_bin_info
, key
, bin
);
778 /* Ownership passed to ht. */
787 void handle_event_statedump_bin_info(struct debug_info
*debug_info
,
788 const bt_event
*event
)
790 handle_bin_info_event(debug_info
, event
, true);
794 void handle_event_lib_load(struct debug_info
*debug_info
,
795 const bt_event
*event
)
797 handle_bin_info_event(debug_info
, event
, false);
801 void handle_event_lib_unload(struct debug_info
*debug_info
,
802 const bt_event
*event
)
805 struct proc_debug_info_sources
*proc_dbg_info_src
;
809 event_get_payload_unsigned_integer_field_value(event
, BADDR_FIELD_NAME
,
812 event_get_common_context_signed_integer_field_value(event
,
813 VPID_FIELD_NAME
, &vpid
);
815 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
816 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
817 if (!proc_dbg_info_src
) {
819 * It's an unload event for a library for which no load event
820 * was previously received.
825 ret
= g_hash_table_remove(proc_dbg_info_src
->baddr_to_bin_info
,
833 void handle_event_statedump_start(struct debug_info
*debug_info
,
834 const bt_event
*event
)
836 struct proc_debug_info_sources
*proc_dbg_info_src
;
839 event_get_common_context_signed_integer_field_value(
840 event
, VPID_FIELD_NAME
, &vpid
);
842 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
843 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
844 if (!proc_dbg_info_src
) {
848 g_hash_table_remove_all(proc_dbg_info_src
->baddr_to_bin_info
);
849 g_hash_table_remove_all(proc_dbg_info_src
->ip_to_debug_info_src
);
855 void trace_debug_info_remove_func(const bt_trace
*in_trace
, void *data
)
857 struct debug_info_msg_iter
*debug_it
= data
;
858 if (debug_it
->debug_info_map
) {
860 ret
= g_hash_table_remove(debug_it
->debug_info_map
,
861 (gpointer
) in_trace
);
867 void handle_event_statedump(struct debug_info_msg_iter
*debug_it
,
868 const bt_event
*event
)
870 const bt_event_class
*event_class
;
871 const char *event_name
;
873 const bt_trace
*trace
;
874 struct debug_info
*debug_info
;
879 event_class
= bt_event_borrow_class_const(event
);
881 event_name
= bt_event_class_get_name(event_class
);
883 trace
= bt_stream_borrow_trace_const(
884 bt_event_borrow_stream_const(event
));
886 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
, trace
);
888 bt_trace_add_listener_status add_listener_status
;
890 debug_info
= debug_info_create(debug_it
->debug_info_component
,
891 trace
, &debug_it
->fd_cache
);
892 g_hash_table_insert(debug_it
->debug_info_map
, (gpointer
) trace
,
894 add_listener_status
= bt_trace_add_destruction_listener(
895 trace
, trace_debug_info_remove_func
, debug_it
,
896 &debug_info
->destruction_listener_id
);
897 BT_ASSERT(add_listener_status
== BT_TRACE_ADD_LISTENER_STATUS_OK
);
900 q_event_name
= g_quark_try_string(event_name
);
902 if (q_event_name
== debug_info
->q_statedump_bin_info
) {
904 handle_event_statedump_bin_info(debug_info
, event
);
905 } else if (q_event_name
== debug_info
->q_dl_open
||
906 q_event_name
== debug_info
->q_lib_load
) {
908 * dl_open and lib_load events are both checked for since
909 * only dl_open was produced as of lttng-ust 2.8.
911 * lib_load, which is produced from lttng-ust 2.9+, is a lot
912 * more reliable since it will be emitted when other functions
913 * of the dlopen family are called (e.g. dlmopen) and when
914 * library are transitively loaded.
916 handle_event_lib_load(debug_info
, event
);
917 } else if (q_event_name
== debug_info
->q_statedump_start
) {
918 /* Start state dump */
919 handle_event_statedump_start(debug_info
, event
);
920 } else if (q_event_name
== debug_info
->q_statedump_debug_link
) {
921 /* Debug link info */
922 handle_event_statedump_debug_link(debug_info
, event
);
923 } else if (q_event_name
== debug_info
->q_statedump_build_id
) {
925 handle_event_statedump_build_id(debug_info
, event
);
926 } else if (q_event_name
== debug_info
-> q_lib_unload
) {
927 handle_event_lib_unload(debug_info
, event
);
934 void destroy_debug_info_comp(struct debug_info_component
*debug_info
)
940 g_free(debug_info
->arg_debug_dir
);
941 g_free(debug_info
->arg_debug_info_field_name
);
942 g_free(debug_info
->arg_target_prefix
);
947 void fill_debug_info_bin_field(struct debug_info_source
*dbg_info_src
,
948 bool full_path
, bt_field
*curr_field
,
949 bt_logging_level log_level
, bt_self_component
*self_comp
)
951 bt_field_string_set_value_status set_status
;
952 bt_field_string_append_status append_status
;
954 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
955 BT_FIELD_CLASS_TYPE_STRING
);
959 set_status
= bt_field_string_set_value(curr_field
,
960 dbg_info_src
->bin_path
);
962 set_status
= bt_field_string_set_value(curr_field
,
963 dbg_info_src
->short_bin_path
);
965 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
966 BT_COMP_LOGE("Cannot set path component of `bin` "
967 "curr_field field's value: str-fc-addr=%p",
969 bt_current_thread_clear_error();
972 append_status
= bt_field_string_append(curr_field
,
973 dbg_info_src
->bin_loc
);
974 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
975 BT_COMP_LOGE("Cannot set bin location component of `bin` "
976 "curr_field field's value: str-fc-addr=%p",
978 bt_current_thread_clear_error();
981 set_status
= bt_field_string_set_value(curr_field
, "");
982 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
983 BT_COMP_LOGE("Cannot set `bin` curr_field field's value: "
984 "str-fc-addr=%p", curr_field
);
985 bt_current_thread_clear_error();
991 void fill_debug_info_func_field(struct debug_info_source
*dbg_info_src
,
992 bt_field
*curr_field
, bt_logging_level log_level
,
993 bt_self_component
*self_comp
)
995 bt_field_string_set_value_status status
;
997 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
998 BT_FIELD_CLASS_TYPE_STRING
);
999 if (dbg_info_src
&& dbg_info_src
->func
) {
1000 status
= bt_field_string_set_value(curr_field
,
1001 dbg_info_src
->func
);
1003 status
= bt_field_string_set_value(curr_field
, "");
1005 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1006 BT_COMP_LOGE("Cannot set `func` curr_field field's value: "
1007 "str-fc-addr=%p", curr_field
);
1008 bt_current_thread_clear_error();
1013 void fill_debug_info_src_field(struct debug_info_source
*dbg_info_src
,
1014 bool full_path
, bt_field
*curr_field
,
1015 bt_logging_level log_level
,
1016 bt_self_component
*self_comp
)
1018 bt_field_string_set_value_status set_status
;
1019 bt_field_string_append_status append_status
;
1021 BT_ASSERT_DBG(bt_field_get_class_type(curr_field
) ==
1022 BT_FIELD_CLASS_TYPE_STRING
);
1024 if (dbg_info_src
&& dbg_info_src
->src_path
) {
1026 set_status
= bt_field_string_set_value(curr_field
,
1027 dbg_info_src
->src_path
);
1029 set_status
= bt_field_string_set_value(curr_field
,
1030 dbg_info_src
->short_src_path
);
1032 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1033 BT_COMP_LOGE("Cannot set path component of `src` "
1034 "curr_field field's value: str-fc-addr=%p",
1036 bt_current_thread_clear_error();
1039 append_status
= bt_field_string_append(curr_field
, ":");
1040 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1041 BT_COMP_LOGE("Cannot set colon component of `src` "
1042 "curr_field field's value: str-fc-addr=%p",
1044 bt_current_thread_clear_error();
1047 append_status
= bt_field_string_append(curr_field
,
1048 dbg_info_src
->line_no
);
1049 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1050 BT_COMP_LOGE("Cannot set line number component of `src` "
1051 "curr_field field's value: str-fc-addr=%p",
1053 bt_current_thread_clear_error();
1056 set_status
= bt_field_string_set_value(curr_field
, "");
1057 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1058 BT_COMP_LOGE("Cannot set `src` curr_field field's value: "
1059 "str-fc-addr=%p", curr_field
);
1060 bt_current_thread_clear_error();
1066 void fill_debug_info_field_empty(bt_field
*debug_info_field
,
1067 bt_logging_level log_level
, bt_self_component
*self_comp
)
1069 bt_field_string_set_value_status status
;
1070 bt_field
*bin_field
, *func_field
, *src_field
;
1072 BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field
) ==
1073 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1075 bin_field
= bt_field_structure_borrow_member_field_by_name(
1076 debug_info_field
, "bin");
1077 func_field
= bt_field_structure_borrow_member_field_by_name(
1078 debug_info_field
, "func");
1079 src_field
= bt_field_structure_borrow_member_field_by_name(
1080 debug_info_field
, "src");
1082 BT_ASSERT_DBG(bt_field_get_class_type(bin_field
) ==
1083 BT_FIELD_CLASS_TYPE_STRING
);
1084 BT_ASSERT_DBG(bt_field_get_class_type(func_field
) ==
1085 BT_FIELD_CLASS_TYPE_STRING
);
1086 BT_ASSERT_DBG(bt_field_get_class_type(src_field
) ==
1087 BT_FIELD_CLASS_TYPE_STRING
);
1089 status
= bt_field_string_set_value(bin_field
, "");
1090 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1091 BT_COMP_LOGE("Cannot set `bin` field's value: "
1092 "str-fc-addr=%p", bin_field
);
1093 bt_current_thread_clear_error();
1096 status
= bt_field_string_set_value(func_field
, "");
1097 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1098 BT_COMP_LOGE("Cannot set `func` field's value: "
1099 "str-fc-addr=%p", func_field
);
1100 bt_current_thread_clear_error();
1103 status
= bt_field_string_set_value(src_field
, "");
1104 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1105 BT_COMP_LOGE("Cannot set `src` field's value: "
1106 "str-fc-addr=%p", src_field
);
1107 bt_current_thread_clear_error();
1111 void fill_debug_info_field(struct debug_info
*debug_info
, int64_t vpid
,
1112 uint64_t ip
, bt_field
*debug_info_field
)
1114 struct debug_info_source
*dbg_info_src
;
1115 const bt_field_class
*debug_info_fc
;
1117 BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field
) ==
1118 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1120 debug_info_fc
= bt_field_borrow_class_const(debug_info_field
);
1122 BT_ASSERT_DBG(bt_field_class_structure_get_member_count(
1123 debug_info_fc
) == 3);
1125 dbg_info_src
= debug_info_query(debug_info
, vpid
, ip
);
1127 fill_debug_info_bin_field(dbg_info_src
,
1128 debug_info
->comp
->arg_full_path
,
1129 bt_field_structure_borrow_member_field_by_name(
1130 debug_info_field
, "bin"),
1131 debug_info
->log_level
, debug_info
->self_comp
);
1132 fill_debug_info_func_field(dbg_info_src
,
1133 bt_field_structure_borrow_member_field_by_name(
1134 debug_info_field
, "func"),
1135 debug_info
->log_level
, debug_info
->self_comp
);
1136 fill_debug_info_src_field(dbg_info_src
,
1137 debug_info
->comp
->arg_full_path
,
1138 bt_field_structure_borrow_member_field_by_name(
1139 debug_info_field
, "src"),
1140 debug_info
->log_level
, debug_info
->self_comp
);
1144 void fill_debug_info_event_if_needed(struct debug_info_msg_iter
*debug_it
,
1145 const bt_event
*in_event
, bt_event
*out_event
)
1147 bt_field
*out_common_ctx_field
, *out_debug_info_field
;
1148 const bt_field
*vpid_field
, *ip_field
, *in_common_ctx_field
;
1149 const bt_field_class
*in_common_ctx_fc
;
1150 struct debug_info
*debug_info
;
1153 gchar
*debug_info_field_name
=
1154 debug_it
->debug_info_component
->arg_debug_info_field_name
;
1155 bt_logging_level log_level
= debug_it
->log_level
;
1156 bt_self_component
*self_comp
= debug_it
->self_comp
;
1158 in_common_ctx_field
= bt_event_borrow_common_context_field_const(
1160 if (!in_common_ctx_field
) {
1162 * There is no event common context so no need to add debug
1168 in_common_ctx_fc
= bt_field_borrow_class_const(in_common_ctx_field
);
1169 if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc
,
1170 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1172 * The input event common context does not have the necessary
1173 * fields to resolve debug information.
1178 /* Borrow the debug-info field. */
1179 out_common_ctx_field
= bt_event_borrow_common_context_field(out_event
);
1180 if (!out_common_ctx_field
) {
1184 out_debug_info_field
= bt_field_structure_borrow_member_field_by_name(
1185 out_common_ctx_field
, debug_info_field_name
);
1187 vpid_field
= bt_field_structure_borrow_member_field_by_name_const(
1188 out_common_ctx_field
, VPID_FIELD_NAME
);
1189 ip_field
= bt_field_structure_borrow_member_field_by_name_const(
1190 out_common_ctx_field
, IP_FIELD_NAME
);
1192 vpid
= bt_field_integer_signed_get_value(vpid_field
);
1193 ip
= bt_field_integer_unsigned_get_value(ip_field
);
1196 * Borrow the debug_info structure needed for the source
1199 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
,
1200 bt_stream_borrow_trace_const(
1201 bt_event_borrow_stream_const(in_event
)));
1205 * Perform the debug-info resolving and set the event fields
1208 fill_debug_info_field(debug_info
, vpid
, ip
, out_debug_info_field
);
1210 BT_COMP_LOGD("No debug information for this trace. Setting debug "
1211 "info fields to empty strings.");
1212 fill_debug_info_field_empty(out_debug_info_field
,
1213 log_level
, self_comp
);
1220 void update_event_statedump_if_needed(struct debug_info_msg_iter
*debug_it
,
1221 const bt_event
*in_event
)
1223 const bt_field
*event_common_ctx
;
1224 const bt_field_class
*event_common_ctx_fc
;
1225 const bt_event_class
*in_event_class
= bt_event_borrow_class_const(in_event
);
1228 * If the event is an lttng_ust_statedump event AND has the right event
1229 * common context fields update the debug-info view for this process.
1231 event_common_ctx
= bt_event_borrow_common_context_field_const(in_event
);
1232 if (!event_common_ctx
) {
1236 event_common_ctx_fc
= bt_field_borrow_class_const(event_common_ctx
);
1237 if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc
,
1238 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1239 /* Checkout if it might be a one of lttng ust statedump events. */
1240 const char *in_event_name
= bt_event_class_get_name(in_event_class
);
1241 if (strncmp(in_event_name
, LTTNG_UST_STATEDUMP_PREFIX
,
1242 strlen(LTTNG_UST_STATEDUMP_PREFIX
)) == 0) {
1243 /* Handle statedump events. */
1244 handle_event_statedump(debug_it
, in_event
);
1252 bt_message
*handle_event_message(struct debug_info_msg_iter
*debug_it
,
1253 const bt_message
*in_message
)
1255 const bt_clock_snapshot
*cs
;
1256 const bt_clock_class
*default_cc
;
1257 const bt_packet
*in_packet
;
1258 const bt_stream
*in_stream
;
1259 const bt_stream
*out_stream
;
1260 bt_event_class
*out_event_class
;
1261 bt_packet
*out_packet
= NULL
;
1262 bt_event
*out_event
;
1263 bt_logging_level log_level
= debug_it
->log_level
;
1264 bt_self_component
*self_comp
= debug_it
->self_comp
;
1266 bt_message
*out_message
= NULL
;
1268 /* Borrow the input event and its event class. */
1269 const bt_event
*in_event
=
1270 bt_message_event_borrow_event_const(in_message
);
1271 const bt_event_class
*in_event_class
=
1272 bt_event_borrow_class_const(in_event
);
1274 update_event_statedump_if_needed(debug_it
, in_event
);
1276 out_event_class
= trace_ir_mapping_borrow_mapped_event_class(
1277 debug_it
->ir_maps
, in_event_class
);
1278 if (!out_event_class
) {
1279 out_event_class
= trace_ir_mapping_create_new_mapped_event_class(
1280 debug_it
->ir_maps
, in_event_class
);
1282 BT_ASSERT_DBG(out_event_class
);
1284 /* Borrow the input stream. */
1285 in_stream
= bt_event_borrow_stream_const(in_event
);
1286 BT_ASSERT_DBG(in_stream
);
1287 out_stream
= trace_ir_mapping_borrow_mapped_stream(debug_it
->ir_maps
,
1289 BT_ASSERT_DBG(in_stream
);
1291 /* Borrow the input and output packets. */
1292 in_packet
= bt_event_borrow_packet_const(in_event
);
1294 out_packet
= trace_ir_mapping_borrow_mapped_packet(
1295 debug_it
->ir_maps
, in_packet
);
1298 default_cc
= bt_stream_class_borrow_default_clock_class_const(
1299 bt_event_class_borrow_stream_class_const(in_event_class
));
1301 /* Borrow event clock snapshot. */
1302 cs
= bt_message_event_borrow_default_clock_snapshot_const(
1305 /* Create an output event message. */
1308 bt_message_event_create_with_packet_and_default_clock_snapshot(
1309 debug_it
->input_iterator
,
1310 out_event_class
, out_packet
,
1311 bt_clock_snapshot_get_value(cs
));
1314 bt_message_event_create_with_default_clock_snapshot(
1315 debug_it
->input_iterator
,
1316 out_event_class
, out_stream
,
1317 bt_clock_snapshot_get_value(cs
));
1321 out_message
= bt_message_event_create_with_packet(
1322 debug_it
->input_iterator
, out_event_class
,
1325 out_message
= bt_message_event_create(
1326 debug_it
->input_iterator
, out_event_class
,
1332 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1333 "Error creating output event message.");
1337 out_event
= bt_message_event_borrow_event(out_message
);
1339 /* Copy the original fields to the output event. */
1340 if (copy_event_content(in_event
, out_event
, log_level
, self_comp
) !=
1341 DEBUG_INFO_TRACE_IR_MAPPING_STATUS_OK
) {
1342 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1343 "Error copying event message content output event message: "
1344 "in-ev-addr=%p, out-ev-addr=%p", in_event
, out_event
);
1349 * Try to set the debug-info fields based on debug information that is
1352 fill_debug_info_event_if_needed(debug_it
, in_event
, out_event
);
1357 BT_MESSAGE_PUT_REF_AND_RESET(out_message
);
1363 bt_message
*handle_stream_begin_message(struct debug_info_msg_iter
*debug_it
,
1364 const bt_message
*in_message
)
1366 const bt_stream
*in_stream
;
1367 bt_message
*out_message
;
1368 bt_stream
*out_stream
;
1369 bt_logging_level log_level
= debug_it
->log_level
;
1370 bt_self_component
*self_comp
= debug_it
->self_comp
;
1372 in_stream
= bt_message_stream_beginning_borrow_stream_const(in_message
);
1373 BT_ASSERT(in_stream
);
1375 /* Create a duplicated output stream. */
1376 out_stream
= trace_ir_mapping_create_new_mapped_stream(
1377 debug_it
->ir_maps
, in_stream
);
1383 /* Create an output stream beginning message. */
1384 out_message
= bt_message_stream_beginning_create(
1385 debug_it
->input_iterator
, out_stream
);
1387 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1388 "Error creating output stream beginning message: "
1389 "out-s-addr=%p", out_stream
);
1396 bt_message
*handle_stream_end_message(struct debug_info_msg_iter
*debug_it
,
1397 const bt_message
*in_message
)
1399 const bt_stream
*in_stream
;
1400 bt_message
*out_message
= NULL
;
1401 bt_stream
*out_stream
;
1402 bt_logging_level log_level
= debug_it
->log_level
;
1403 bt_self_component
*self_comp
= debug_it
->self_comp
;
1405 in_stream
= bt_message_stream_end_borrow_stream_const(in_message
);
1406 BT_ASSERT(in_stream
);
1408 out_stream
= trace_ir_mapping_borrow_mapped_stream(
1409 debug_it
->ir_maps
, in_stream
);
1410 BT_ASSERT(out_stream
);
1412 /* Create an output stream end message. */
1413 out_message
= bt_message_stream_end_create(debug_it
->input_iterator
,
1416 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1417 "Error creating output stream end message: "
1418 "out-s-addr=%p", out_stream
);
1422 /* Remove stream from trace mapping hashtable. */
1423 trace_ir_mapping_remove_mapped_stream(debug_it
->ir_maps
, in_stream
);
1430 bt_message
*handle_packet_begin_message(struct debug_info_msg_iter
*debug_it
,
1431 const bt_message
*in_message
)
1433 bool has_default_clock_snapshot
;
1434 const bt_clock_snapshot
*cs
;
1435 bt_message
*out_message
= NULL
;
1436 bt_packet
*out_packet
;
1437 bt_logging_level log_level
= debug_it
->log_level
;
1438 bt_self_component
*self_comp
= debug_it
->self_comp
;
1440 const bt_packet
*in_packet
=
1441 bt_message_packet_beginning_borrow_packet_const(in_message
);
1442 BT_ASSERT(in_packet
);
1444 /* This packet should not be already mapped. */
1445 BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet(
1446 debug_it
->ir_maps
, in_packet
));
1448 out_packet
= trace_ir_mapping_create_new_mapped_packet(debug_it
->ir_maps
,
1451 BT_ASSERT(out_packet
);
1453 has_default_clock_snapshot
=
1454 bt_stream_class_packets_have_beginning_default_clock_snapshot(
1455 bt_stream_borrow_class_const(
1456 bt_packet_borrow_stream_const(in_packet
)));
1457 if (has_default_clock_snapshot
) {
1458 /* Borrow clock snapshot. */
1459 cs
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
1462 /* Create an output packet beginning message. */
1463 out_message
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1464 debug_it
->input_iterator
, out_packet
,
1465 bt_clock_snapshot_get_value(cs
));
1467 out_message
= bt_message_packet_beginning_create(
1468 debug_it
->input_iterator
, out_packet
);
1471 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1472 "Error creating output packet beginning message: "
1473 "out-p-addr=%p", out_packet
);
1480 bt_message
*handle_packet_end_message(struct debug_info_msg_iter
*debug_it
,
1481 const bt_message
*in_message
)
1483 bool has_default_clock_snapshot
;
1484 const bt_clock_snapshot
*cs
;
1485 const bt_packet
*in_packet
;
1486 bt_message
*out_message
= NULL
;
1487 bt_packet
*out_packet
;
1488 bt_logging_level log_level
= debug_it
->log_level
;
1489 bt_self_component
*self_comp
= debug_it
->self_comp
;
1491 in_packet
= bt_message_packet_end_borrow_packet_const(in_message
);
1492 BT_ASSERT(in_packet
);
1494 out_packet
= trace_ir_mapping_borrow_mapped_packet(debug_it
->ir_maps
, in_packet
);
1495 BT_ASSERT(out_packet
);
1497 has_default_clock_snapshot
=
1498 bt_stream_class_packets_have_end_default_clock_snapshot(
1499 bt_stream_borrow_class_const(
1500 bt_packet_borrow_stream_const(in_packet
)));
1501 if (has_default_clock_snapshot
) {
1502 /* Borrow clock snapshot. */
1503 cs
= bt_message_packet_end_borrow_default_clock_snapshot_const(
1506 /* Create an outpute packet end message. */
1507 out_message
= bt_message_packet_end_create_with_default_clock_snapshot(
1508 debug_it
->input_iterator
, out_packet
,
1509 bt_clock_snapshot_get_value(cs
));
1511 out_message
= bt_message_packet_end_create(
1512 debug_it
->input_iterator
, out_packet
);
1516 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1517 "Error creating output packet end message: "
1518 "out-p-addr=%p", out_packet
);
1522 /* Remove packet from data mapping hashtable. */
1523 trace_ir_mapping_remove_mapped_packet(debug_it
->ir_maps
, in_packet
);
1530 bt_message
*handle_msg_iterator_inactivity(struct debug_info_msg_iter
*debug_it
,
1531 const bt_message
*in_message
)
1534 * This message type can be forwarded directly because it does
1535 * not refer to any objects in the trace class.
1537 bt_message_get_ref(in_message
);
1538 return (bt_message
*) in_message
;
1542 bt_message
*handle_discarded_events_message(struct debug_info_msg_iter
*debug_it
,
1543 const bt_message
*in_message
)
1545 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1546 const bt_stream
*in_stream
;
1547 bool has_default_clock_snapshots
;
1548 uint64_t discarded_events
, begin_cs_value
, end_cs_value
;
1549 bt_property_availability prop_avail
;
1550 bt_message
*out_message
= NULL
;
1551 bt_stream
*out_stream
;
1552 bt_logging_level log_level
= debug_it
->log_level
;
1553 bt_self_component
*self_comp
= debug_it
->self_comp
;
1555 in_stream
= bt_message_discarded_events_borrow_stream_const(
1557 BT_ASSERT(in_stream
);
1559 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1561 BT_ASSERT(out_stream
);
1563 has_default_clock_snapshots
=
1564 bt_stream_class_discarded_events_have_default_clock_snapshots(
1565 bt_stream_borrow_class_const(in_stream
));
1566 if (has_default_clock_snapshots
) {
1567 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1569 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1572 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1573 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1575 out_message
= bt_message_discarded_events_create_with_default_clock_snapshots(
1576 debug_it
->input_iterator
, out_stream
,
1577 begin_cs_value
, end_cs_value
);
1579 out_message
= bt_message_discarded_events_create(
1580 debug_it
->input_iterator
, out_stream
);
1583 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1584 "Error creating output discarded events message: "
1585 "out-s-addr=%p", out_stream
);
1589 prop_avail
= bt_message_discarded_events_get_count(in_message
,
1592 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1593 bt_message_discarded_events_set_count(out_message
,
1602 bt_message
*handle_discarded_packets_message(struct debug_info_msg_iter
*debug_it
,
1603 const bt_message
*in_message
)
1605 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1606 bool has_default_clock_snapshots
;
1607 const bt_stream
*in_stream
;
1608 uint64_t discarded_packets
, begin_cs_value
, end_cs_value
;
1609 bt_property_availability prop_avail
;
1610 bt_message
*out_message
= NULL
;
1611 bt_stream
*out_stream
;
1612 bt_logging_level log_level
= debug_it
->log_level
;
1613 bt_self_component
*self_comp
= debug_it
->self_comp
;
1615 in_stream
= bt_message_discarded_packets_borrow_stream_const(
1617 BT_ASSERT(in_stream
);
1619 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1621 BT_ASSERT(out_stream
);
1623 has_default_clock_snapshots
=
1624 bt_stream_class_discarded_packets_have_default_clock_snapshots(
1625 bt_stream_borrow_class_const(in_stream
));
1626 if (has_default_clock_snapshots
) {
1627 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1630 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1633 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1634 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1636 out_message
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1637 debug_it
->input_iterator
, out_stream
,
1638 begin_cs_value
, end_cs_value
);
1640 out_message
= bt_message_discarded_packets_create(
1641 debug_it
->input_iterator
, out_stream
);
1644 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1645 "Error creating output discarded packet message: "
1646 "out-s-addr=%p", out_stream
);
1650 prop_avail
= bt_message_discarded_packets_get_count(in_message
,
1651 &discarded_packets
);
1652 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1653 bt_message_discarded_packets_set_count(out_message
,
1662 const bt_message
*handle_message(struct debug_info_msg_iter
*debug_it
,
1663 const bt_message
*in_message
)
1665 bt_message
*out_message
= NULL
;
1667 switch (bt_message_get_type(in_message
)) {
1668 case BT_MESSAGE_TYPE_EVENT
:
1669 out_message
= handle_event_message(debug_it
, in_message
);
1671 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1672 out_message
= handle_packet_begin_message(debug_it
, in_message
);
1674 case BT_MESSAGE_TYPE_PACKET_END
:
1675 out_message
= handle_packet_end_message(debug_it
, in_message
);
1677 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1678 out_message
= handle_stream_begin_message(debug_it
, in_message
);
1680 case BT_MESSAGE_TYPE_STREAM_END
:
1681 out_message
= handle_stream_end_message(debug_it
, in_message
);
1683 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1684 out_message
= handle_msg_iterator_inactivity(debug_it
, in_message
);
1686 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1687 out_message
= handle_discarded_events_message(debug_it
, in_message
);
1689 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1690 out_message
= handle_discarded_packets_message(debug_it
, in_message
);
1700 struct bt_param_validation_map_value_entry_descr debug_info_params
[] = {
1701 { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1702 { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1703 { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1704 { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
1705 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1709 bt_component_class_initialize_method_status
init_from_params(
1710 struct debug_info_component
*debug_info_component
,
1711 const bt_value
*params
)
1713 const bt_value
*value
;
1714 bt_component_class_initialize_method_status status
;
1715 bt_logging_level log_level
= debug_info_component
->log_level
;
1716 enum bt_param_validation_status validation_status
;
1717 gchar
*validate_error
= NULL
;
1719 validation_status
= bt_param_validation_validate(params
,
1720 debug_info_params
, &validate_error
);
1721 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1722 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1724 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1725 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1726 BT_COMP_LOGE_APPEND_CAUSE(debug_info_component
->self_comp
,
1727 "%s", validate_error
);
1733 value
= bt_value_map_borrow_entry_value_const(params
,
1734 "debug-info-field-name");
1736 debug_info_component
->arg_debug_info_field_name
=
1737 g_strdup(bt_value_string_get(value
));
1739 debug_info_component
->arg_debug_info_field_name
=
1740 g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME
);
1743 value
= bt_value_map_borrow_entry_value_const(params
, "debug-info-dir");
1745 debug_info_component
->arg_debug_dir
=
1746 g_strdup(bt_value_string_get(value
));
1748 debug_info_component
->arg_debug_dir
= NULL
;
1752 value
= bt_value_map_borrow_entry_value_const(params
, "target-prefix");
1754 debug_info_component
->arg_target_prefix
=
1755 g_strdup(bt_value_string_get(value
));
1757 debug_info_component
->arg_target_prefix
= NULL
;
1760 value
= bt_value_map_borrow_entry_value_const(params
, "full-path");
1762 debug_info_component
->arg_full_path
= bt_value_bool_get(value
);
1764 debug_info_component
->arg_full_path
= BT_FALSE
;
1767 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1770 g_free(validate_error
);
1776 bt_component_class_initialize_method_status
debug_info_comp_init(
1777 bt_self_component_filter
*self_comp_flt
,
1778 bt_self_component_filter_configuration
*config
,
1779 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1781 struct debug_info_component
*debug_info_comp
;
1782 bt_component_class_initialize_method_status status
=
1783 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1784 bt_self_component_add_port_status add_port_status
;
1785 bt_self_component
*self_comp
=
1786 bt_self_component_filter_as_self_component(self_comp_flt
);
1787 bt_logging_level log_level
= bt_component_get_logging_level(
1788 bt_self_component_as_component(self_comp
));
1790 BT_COMP_LOGI("Initializing debug_info component: "
1791 "comp-addr=%p, params-addr=%p", self_comp
, params
);
1793 debug_info_comp
= g_new0(struct debug_info_component
, 1);
1794 if (!debug_info_comp
) {
1795 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1796 "Failed to allocate one debug_info component.");
1800 debug_info_comp
->log_level
= log_level
;
1801 debug_info_comp
->self_comp
= self_comp
;
1802 bt_self_component_set_data(self_comp
, debug_info_comp
);
1804 add_port_status
= bt_self_component_filter_add_input_port(
1805 self_comp_flt
, "in", NULL
, NULL
);
1806 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1807 status
= (int) add_port_status
;
1811 add_port_status
= bt_self_component_filter_add_output_port(
1812 self_comp_flt
, "out", NULL
, NULL
);
1813 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1814 status
= (int) add_port_status
;
1818 status
= init_from_params(debug_info_comp
, params
);
1819 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1820 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1821 "Cannot configure debug_info component: "
1822 "debug_info-comp-addr=%p, params-addr=%p",
1823 debug_info_comp
, params
);
1830 destroy_debug_info_comp(debug_info_comp
);
1831 bt_self_component_set_data(self_comp
, NULL
);
1833 if (status
== BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1834 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1841 void debug_info_comp_finalize(bt_self_component_filter
*self_comp_flt
)
1843 struct debug_info_component
*debug_info
=
1844 bt_self_component_get_data(
1845 bt_self_component_filter_as_self_component(
1847 bt_logging_level log_level
= debug_info
->log_level
;
1848 bt_self_component
*self_comp
= debug_info
->self_comp
;
1850 BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p",
1853 destroy_debug_info_comp(debug_info
);
1857 bt_component_class_message_iterator_next_method_status
debug_info_msg_iter_next(
1858 bt_self_message_iterator
*self_msg_iter
,
1859 const bt_message_array_const msgs
, uint64_t capacity
,
1862 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1863 bt_message_iterator_next_status upstream_iterator_ret_status
;
1864 struct debug_info_msg_iter
*debug_info_msg_iter
;
1865 struct debug_info_component
*debug_info
= NULL
;
1866 bt_component_class_message_iterator_next_method_status status
;
1867 bt_self_component
*self_comp
= NULL
;
1868 bt_message_array_const input_msgs
;
1869 const bt_message
*out_message
;
1870 uint64_t curr_msg_idx
, i
;
1872 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1874 self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
1875 BT_ASSERT_DBG(self_comp
);
1877 debug_info
= bt_self_component_get_data(self_comp
);
1878 BT_ASSERT_DBG(debug_info
);
1880 debug_info_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
1881 BT_ASSERT_DBG(debug_info_msg_iter
);
1883 upstream_iterator
= debug_info_msg_iter
->msg_iter
;
1884 BT_ASSERT_DBG(upstream_iterator
);
1886 upstream_iterator_ret_status
=
1887 bt_self_component_port_input_message_iterator_next(
1888 upstream_iterator
, &input_msgs
, count
);
1889 if (upstream_iterator_ret_status
!=
1890 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
1892 * No messages were returned. Not necessarily an error.
1893 * Convert the upstream message iterator status to a
1896 status
= (int) upstream_iterator_ret_status
;
1901 * There should never be more received messages than the capacity we
1904 BT_ASSERT_DBG(*count
<= capacity
);
1906 for (curr_msg_idx
= 0; curr_msg_idx
< *count
; curr_msg_idx
++) {
1907 out_message
= handle_message(debug_info_msg_iter
,
1908 input_msgs
[curr_msg_idx
]);
1910 goto handle_msg_error
;
1913 msgs
[curr_msg_idx
] = out_message
;
1915 * Drop our reference of the input message as we are done with
1916 * it and created a output copy.
1918 bt_message_put_ref(input_msgs
[curr_msg_idx
]);
1925 * Drop references of all the output messages created before the
1928 for (i
= 0; i
< curr_msg_idx
; i
++) {
1929 bt_message_put_ref(msgs
[i
]);
1933 * Drop references of all the input messages not dropped before the
1936 for (i
= curr_msg_idx
; i
< *count
; i
++) {
1937 bt_message_put_ref(input_msgs
[i
]);
1940 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1947 void debug_info_msg_iter_destroy(struct debug_info_msg_iter
*debug_info_msg_iter
)
1949 if (!debug_info_msg_iter
) {
1953 if (debug_info_msg_iter
->msg_iter
) {
1954 bt_self_component_port_input_message_iterator_put_ref(
1955 debug_info_msg_iter
->msg_iter
);
1958 if (debug_info_msg_iter
->ir_maps
) {
1959 trace_ir_maps_destroy(debug_info_msg_iter
->ir_maps
);
1962 if (debug_info_msg_iter
->debug_info_map
) {
1963 g_hash_table_destroy(debug_info_msg_iter
->debug_info_map
);
1966 bt_fd_cache_fini(&debug_info_msg_iter
->fd_cache
);
1967 g_free(debug_info_msg_iter
);
1974 bt_component_class_message_iterator_initialize_method_status
debug_info_msg_iter_init(
1975 bt_self_message_iterator
*self_msg_iter
,
1976 bt_self_message_iterator_configuration
*config
,
1977 bt_self_component_filter
*self_comp_flt
,
1978 bt_self_component_port_output
*self_port
)
1980 bt_component_class_message_iterator_initialize_method_status status
;
1981 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
1983 struct bt_self_component_port_input
*input_port
= NULL
;
1984 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1985 struct debug_info_msg_iter
*debug_info_msg_iter
= NULL
;
1986 gchar
*debug_info_field_name
;
1988 bt_self_component
*self_comp
=
1989 bt_self_component_filter_as_self_component(self_comp_flt
);
1990 bt_logging_level log_level
= bt_component_get_logging_level(
1991 bt_self_component_as_component(self_comp
));
1993 /* Borrow the upstream input port. */
1994 input_port
= bt_self_component_filter_borrow_input_port_by_name(
1995 self_comp_flt
, "in");
1997 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
2001 debug_info_msg_iter
= g_new0(struct debug_info_msg_iter
, 1);
2002 if (!debug_info_msg_iter
) {
2003 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2007 debug_info_msg_iter
->log_level
= log_level
;
2008 debug_info_msg_iter
->self_comp
= self_comp
;
2010 /* Create an iterator on the upstream component. */
2011 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_message_iterator(
2012 self_msg_iter
, input_port
, &upstream_iterator
);
2013 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
2014 status
= (int) msg_iter_status
;
2018 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
2019 debug_info_msg_iter
->msg_iter
, upstream_iterator
);
2021 /* Create hashtable that will contain debug info mapping. */
2022 debug_info_msg_iter
->debug_info_map
= g_hash_table_new_full(
2023 g_direct_hash
, g_direct_equal
, (GDestroyNotify
) NULL
,
2024 (GDestroyNotify
) debug_info_destroy
);
2025 if (!debug_info_msg_iter
->debug_info_map
) {
2026 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2030 debug_info_msg_iter
->debug_info_component
=
2031 bt_self_component_get_data(self_comp
);
2033 debug_info_field_name
=
2034 debug_info_msg_iter
->debug_info_component
->arg_debug_info_field_name
;
2036 debug_info_msg_iter
->ir_maps
= trace_ir_maps_create(self_comp
,
2037 debug_info_field_name
, log_level
);
2038 if (!debug_info_msg_iter
->ir_maps
) {
2039 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2043 ret
= bt_fd_cache_init(&debug_info_msg_iter
->fd_cache
, log_level
);
2045 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2049 bt_self_message_iterator_configuration_set_can_seek_forward(config
,
2050 bt_self_component_port_input_message_iterator_can_seek_forward(
2051 debug_info_msg_iter
->msg_iter
));
2053 bt_self_message_iterator_set_data(self_msg_iter
, debug_info_msg_iter
);
2054 debug_info_msg_iter
->input_iterator
= self_msg_iter
;
2056 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
2060 debug_info_msg_iter_destroy(debug_info_msg_iter
);
2067 bt_component_class_message_iterator_can_seek_beginning_method_status
2068 debug_info_msg_iter_can_seek_beginning(bt_self_message_iterator
*self_msg_iter
,
2071 struct debug_info_msg_iter
*debug_info_msg_iter
=
2072 bt_self_message_iterator_get_data(self_msg_iter
);
2073 BT_ASSERT(debug_info_msg_iter
);
2075 return (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
2076 debug_info_msg_iter
->msg_iter
, can_seek
);
2080 bt_component_class_message_iterator_seek_beginning_method_status
2081 debug_info_msg_iter_seek_beginning(bt_self_message_iterator
*self_msg_iter
)
2083 struct debug_info_msg_iter
*debug_info_msg_iter
=
2084 bt_self_message_iterator_get_data(self_msg_iter
);
2085 bt_component_class_message_iterator_seek_beginning_method_status status
=
2086 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
2087 bt_message_iterator_seek_beginning_status seek_beg_status
;
2089 BT_ASSERT(debug_info_msg_iter
);
2091 /* Ask the upstream component to seek to the beginning. */
2092 seek_beg_status
= bt_self_component_port_input_message_iterator_seek_beginning(
2093 debug_info_msg_iter
->msg_iter
);
2094 if (seek_beg_status
!= BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK
) {
2095 status
= (int) seek_beg_status
;
2099 /* Clear this iterator data. */
2100 trace_ir_maps_clear(debug_info_msg_iter
->ir_maps
);
2101 g_hash_table_remove_all(debug_info_msg_iter
->debug_info_map
);
2108 void debug_info_msg_iter_finalize(bt_self_message_iterator
*it
)
2110 struct debug_info_msg_iter
*debug_info_msg_iter
;
2112 debug_info_msg_iter
= bt_self_message_iterator_get_data(it
);
2113 BT_ASSERT(debug_info_msg_iter
);
2115 debug_info_msg_iter_destroy(debug_info_msg_iter
);