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
);
383 BT_ASSERT(bt_field_class_get_type(
384 bt_field_class_array_borrow_element_field_class_const(
385 build_id_field_class
)) ==
386 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
388 *build_id_len
= bt_field_array_get_length(build_id_field
);
394 int event_get_payload_build_id_value(const bt_event
*event
,
395 const char *field_name
, uint8_t *build_id
)
397 const bt_field
*curr_field
, *build_id_field
;
398 const bt_field_class
*build_id_field_class
;
399 uint64_t i
, build_id_len
;
404 build_id_field
= event_borrow_payload_field(event
, field_name
);
405 build_id_field_class
= bt_field_borrow_class_const(build_id_field
);
407 BT_ASSERT(bt_field_class_get_type(build_id_field_class
) ==
408 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
);
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
);
427 void event_get_payload_unsigned_integer_field_value(const bt_event
*event
,
428 const char *field_name
, uint64_t *value
)
430 *value
= bt_field_integer_unsigned_get_value(
431 event_borrow_payload_field(event
, field_name
));
435 void event_get_payload_string_field_value(const bt_event
*event
,
436 const char *field_name
, const char **value
)
438 *value
= bt_field_string_get_value(
439 event_borrow_payload_field(event
, field_name
));
443 bool event_has_payload_field(const bt_event
*event
,
444 const char *field_name
)
446 return event_borrow_payload_field(event
, field_name
);
450 struct debug_info_source
*proc_debug_info_sources_get_entry(
451 struct debug_info
*debug_info
,
452 struct proc_debug_info_sources
*proc_dbg_info_src
, uint64_t ip
)
454 struct debug_info_source
*debug_info_src
= NULL
;
455 gpointer key
= g_new0(uint64_t, 1);
457 gpointer baddr
, value
;
463 *((uint64_t *) key
) = ip
;
465 /* Look in IP to debug infos hash table first. */
466 debug_info_src
= g_hash_table_lookup(
467 proc_dbg_info_src
->ip_to_debug_info_src
, key
);
468 if (debug_info_src
) {
472 /* Check in all bin_infos. */
473 g_hash_table_iter_init(&iter
, proc_dbg_info_src
->baddr_to_bin_info
);
475 while (g_hash_table_iter_next(&iter
, &baddr
, &value
))
477 struct bin_info
*bin
= value
;
479 if (!bin_info_has_address(value
, ip
)) {
484 * Found; add it to cache.
486 * FIXME: this should be bounded in size (and implement
487 * a caching policy), and entries should be prunned when
488 * libraries are unmapped.
490 debug_info_src
= debug_info_source_create_from_bin(bin
, ip
,
491 debug_info
->self_comp
);
492 if (debug_info_src
) {
494 proc_dbg_info_src
->ip_to_debug_info_src
, key
,
496 /* Ownership passed to ht. */
504 return debug_info_src
;
508 struct debug_info_source
*debug_info_query(struct debug_info
*debug_info
,
509 int64_t vpid
, uint64_t ip
)
511 struct debug_info_source
*dbg_info_src
= NULL
;
512 struct proc_debug_info_sources
*proc_dbg_info_src
;
514 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
515 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
516 if (!proc_dbg_info_src
) {
520 dbg_info_src
= proc_debug_info_sources_get_entry(debug_info
,
521 proc_dbg_info_src
, ip
);
528 struct debug_info
*debug_info_create(struct debug_info_component
*comp
,
529 const bt_trace
*trace
, struct bt_fd_cache
*fdc
)
532 struct debug_info
*debug_info
;
538 debug_info
= g_new0(struct debug_info
, 1);
543 debug_info
->log_level
= comp
->log_level
;
544 debug_info
->self_comp
= comp
->self_comp
;
545 debug_info
->vpid_to_proc_dbg_info_src
= g_hash_table_new_full(
546 g_int64_hash
, g_int64_equal
, (GDestroyNotify
) g_free
,
547 (GDestroyNotify
) proc_debug_info_sources_destroy
);
548 if (!debug_info
->vpid_to_proc_dbg_info_src
) {
552 debug_info
->comp
= comp
;
553 ret
= debug_info_init(debug_info
);
558 debug_info
->input_trace
= trace
;
559 debug_info
->fd_cache
= fdc
;
569 void debug_info_destroy(struct debug_info
*debug_info
)
571 bt_logging_level log_level
;
572 bt_self_component
*self_comp
;
573 bt_trace_remove_listener_status remove_listener_status
;
578 log_level
= debug_info
->log_level
;
579 self_comp
= debug_info
->self_comp
;
581 if (debug_info
->vpid_to_proc_dbg_info_src
) {
582 g_hash_table_destroy(debug_info
->vpid_to_proc_dbg_info_src
);
585 remove_listener_status
= bt_trace_remove_destruction_listener(
586 debug_info
->input_trace
,
587 debug_info
->destruction_listener_id
);
588 if (remove_listener_status
!= BT_TRACE_REMOVE_LISTENER_STATUS_OK
) {
589 BT_COMP_LOGE("Trace destruction listener removal failed.");
590 bt_current_thread_clear_error();
599 void handle_event_statedump_build_id(struct debug_info
*debug_info
,
600 const bt_event
*event
)
602 struct proc_debug_info_sources
*proc_dbg_info_src
;
603 uint64_t build_id_len
, baddr
;
604 uint8_t *build_id
= NULL
;
605 struct bin_info
*bin
;
609 event_get_common_context_signed_integer_field_value(event
,
610 VPID_FIELD_NAME
, &vpid
);
611 event_get_payload_unsigned_integer_field_value(event
,
612 BADDR_FIELD_NAME
, &baddr
);
614 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
615 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
616 if (!proc_dbg_info_src
) {
620 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
624 * The build_id event comes after the bin has been
625 * created. If it isn't found, just ignore this event.
629 ret
= event_get_payload_build_id_length(event
, BUILD_ID_FIELD_NAME
,
632 build_id
= g_new0(uint8_t, build_id_len
);
637 ret
= event_get_payload_build_id_value(event
, BUILD_ID_FIELD_NAME
,
643 ret
= bin_info_set_build_id(bin
, build_id
, build_id_len
);
649 * Reset the is_elf_only flag in case it had been set
650 * previously, because we might find separate debug info using
651 * the new build id information.
653 bin
->is_elf_only
= false;
661 void handle_event_statedump_debug_link(struct debug_info
*debug_info
,
662 const bt_event
*event
)
664 struct proc_debug_info_sources
*proc_dbg_info_src
;
665 struct bin_info
*bin
= NULL
;
668 const char *filename
= NULL
;
670 uint64_t crc_field_value
;
672 event_get_common_context_signed_integer_field_value(event
,
673 VPID_FIELD_NAME
, &vpid
);
675 event_get_payload_unsigned_integer_field_value(event
,
676 BADDR_FIELD_NAME
, &baddr
);
678 event_get_payload_unsigned_integer_field_value(event
,
679 CRC32_FIELD_NAME
, &crc_field_value
);
681 crc32
= (uint32_t) crc_field_value
;
683 event_get_payload_string_field_value(event
,
684 FILENAME_FIELD_NAME
, &filename
);
686 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
687 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
688 if (!proc_dbg_info_src
) {
692 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
,
696 * The debug_link event comes after the bin has been
697 * created. If it isn't found, just ignore this event.
702 bin_info_set_debug_link(bin
, filename
, crc32
);
709 void handle_bin_info_event(struct debug_info
*debug_info
,
710 const bt_event
*event
, bool has_pic_field
)
712 struct proc_debug_info_sources
*proc_dbg_info_src
;
713 struct bin_info
*bin
;
714 uint64_t baddr
, memsz
;
720 event_get_payload_unsigned_integer_field_value(event
,
721 MEMSZ_FIELD_NAME
, &memsz
);
727 event_get_payload_unsigned_integer_field_value(event
,
728 BADDR_FIELD_NAME
, &baddr
);
731 * This field is not produced by the dlopen event emitted before
734 if (!event_has_payload_field(event
, PATH_FIELD_NAME
)) {
737 event_get_payload_string_field_value(event
, PATH_FIELD_NAME
, &path
);
740 uint64_t is_pic_field_value
;
742 event_get_payload_unsigned_integer_field_value(event
,
743 IS_PIC_FIELD_NAME
, &is_pic_field_value
);
744 is_pic
= is_pic_field_value
== 1;
747 * dlopen has no is_pic field, because the shared
748 * object is always PIC.
753 event_get_common_context_signed_integer_field_value(event
,
754 VPID_FIELD_NAME
, &vpid
);
756 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
757 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
758 if (!proc_dbg_info_src
) {
762 key
= g_new0(uint64_t, 1);
767 *((uint64_t *) key
) = baddr
;
769 bin
= g_hash_table_lookup(proc_dbg_info_src
->baddr_to_bin_info
, key
);
774 bin
= bin_info_create(debug_info
->fd_cache
, path
, baddr
, memsz
, is_pic
,
775 debug_info
->comp
->arg_debug_dir
,
776 debug_info
->comp
->arg_target_prefix
,
777 debug_info
->log_level
, debug_info
->self_comp
);
782 g_hash_table_insert(proc_dbg_info_src
->baddr_to_bin_info
, key
, bin
);
783 /* Ownership passed to ht. */
792 void handle_event_statedump_bin_info(struct debug_info
*debug_info
,
793 const bt_event
*event
)
795 handle_bin_info_event(debug_info
, event
, true);
799 void handle_event_lib_load(struct debug_info
*debug_info
,
800 const bt_event
*event
)
802 handle_bin_info_event(debug_info
, event
, false);
806 void handle_event_lib_unload(struct debug_info
*debug_info
,
807 const bt_event
*event
)
810 struct proc_debug_info_sources
*proc_dbg_info_src
;
814 event_get_payload_unsigned_integer_field_value(event
, BADDR_FIELD_NAME
,
817 event_get_common_context_signed_integer_field_value(event
,
818 VPID_FIELD_NAME
, &vpid
);
820 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
821 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
822 if (!proc_dbg_info_src
) {
824 * It's an unload event for a library for which no load event
825 * was previously received.
830 ret
= g_hash_table_remove(proc_dbg_info_src
->baddr_to_bin_info
,
838 void handle_event_statedump_start(struct debug_info
*debug_info
,
839 const bt_event
*event
)
841 struct proc_debug_info_sources
*proc_dbg_info_src
;
844 event_get_common_context_signed_integer_field_value(
845 event
, VPID_FIELD_NAME
, &vpid
);
847 proc_dbg_info_src
= proc_debug_info_sources_ht_get_entry(
848 debug_info
->vpid_to_proc_dbg_info_src
, vpid
);
849 if (!proc_dbg_info_src
) {
853 g_hash_table_remove_all(proc_dbg_info_src
->baddr_to_bin_info
);
854 g_hash_table_remove_all(proc_dbg_info_src
->ip_to_debug_info_src
);
860 void trace_debug_info_remove_func(const bt_trace
*in_trace
, void *data
)
862 struct debug_info_msg_iter
*debug_it
= data
;
863 if (debug_it
->debug_info_map
) {
865 ret
= g_hash_table_remove(debug_it
->debug_info_map
,
866 (gpointer
) in_trace
);
872 void handle_event_statedump(struct debug_info_msg_iter
*debug_it
,
873 const bt_event
*event
)
875 const bt_event_class
*event_class
;
876 const char *event_name
;
878 const bt_trace
*trace
;
879 struct debug_info
*debug_info
;
884 event_class
= bt_event_borrow_class_const(event
);
886 event_name
= bt_event_class_get_name(event_class
);
888 trace
= bt_stream_borrow_trace_const(
889 bt_event_borrow_stream_const(event
));
891 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
, trace
);
893 bt_trace_add_listener_status add_listener_status
;
895 debug_info
= debug_info_create(debug_it
->debug_info_component
,
896 trace
, &debug_it
->fd_cache
);
897 g_hash_table_insert(debug_it
->debug_info_map
, (gpointer
) trace
,
899 add_listener_status
= bt_trace_add_destruction_listener(
900 trace
, trace_debug_info_remove_func
, debug_it
,
901 &debug_info
->destruction_listener_id
);
902 BT_ASSERT(add_listener_status
== BT_TRACE_ADD_LISTENER_STATUS_OK
);
905 q_event_name
= g_quark_try_string(event_name
);
907 if (q_event_name
== debug_info
->q_statedump_bin_info
) {
909 handle_event_statedump_bin_info(debug_info
, event
);
910 } else if (q_event_name
== debug_info
->q_dl_open
||
911 q_event_name
== debug_info
->q_lib_load
) {
913 * dl_open and lib_load events are both checked for since
914 * only dl_open was produced as of lttng-ust 2.8.
916 * lib_load, which is produced from lttng-ust 2.9+, is a lot
917 * more reliable since it will be emitted when other functions
918 * of the dlopen family are called (e.g. dlmopen) and when
919 * library are transitively loaded.
921 handle_event_lib_load(debug_info
, event
);
922 } else if (q_event_name
== debug_info
->q_statedump_start
) {
923 /* Start state dump */
924 handle_event_statedump_start(debug_info
, event
);
925 } else if (q_event_name
== debug_info
->q_statedump_debug_link
) {
926 /* Debug link info */
927 handle_event_statedump_debug_link(debug_info
, event
);
928 } else if (q_event_name
== debug_info
->q_statedump_build_id
) {
930 handle_event_statedump_build_id(debug_info
, event
);
931 } else if (q_event_name
== debug_info
-> q_lib_unload
) {
932 handle_event_lib_unload(debug_info
, event
);
939 void destroy_debug_info_comp(struct debug_info_component
*debug_info
)
945 g_free(debug_info
->arg_debug_dir
);
946 g_free(debug_info
->arg_debug_info_field_name
);
947 g_free(debug_info
->arg_target_prefix
);
952 void fill_debug_info_bin_field(struct debug_info_source
*dbg_info_src
,
953 bool full_path
, bt_field
*curr_field
,
954 bt_logging_level log_level
, bt_self_component
*self_comp
)
956 bt_field_string_set_value_status set_status
;
957 bt_field_string_append_status append_status
;
959 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
960 BT_FIELD_CLASS_TYPE_STRING
);
964 set_status
= bt_field_string_set_value(curr_field
,
965 dbg_info_src
->bin_path
);
967 set_status
= bt_field_string_set_value(curr_field
,
968 dbg_info_src
->short_bin_path
);
970 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
971 BT_COMP_LOGE("Cannot set path component of \"bin\" "
972 "curr_field field's value: str-fc-addr=%p",
974 bt_current_thread_clear_error();
977 append_status
= bt_field_string_append(curr_field
,
978 dbg_info_src
->bin_loc
);
979 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
980 BT_COMP_LOGE("Cannot set bin location component of \"bin\" "
981 "curr_field field's value: str-fc-addr=%p",
983 bt_current_thread_clear_error();
986 set_status
= bt_field_string_set_value(curr_field
, "");
987 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
988 BT_COMP_LOGE("Cannot set \"bin\" curr_field field's value: "
989 "str-fc-addr=%p", curr_field
);
990 bt_current_thread_clear_error();
996 void fill_debug_info_func_field(struct debug_info_source
*dbg_info_src
,
997 bt_field
*curr_field
, bt_logging_level log_level
,
998 bt_self_component
*self_comp
)
1000 bt_field_string_set_value_status status
;
1002 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
1003 BT_FIELD_CLASS_TYPE_STRING
);
1004 if (dbg_info_src
&& dbg_info_src
->func
) {
1005 status
= bt_field_string_set_value(curr_field
,
1006 dbg_info_src
->func
);
1008 status
= bt_field_string_set_value(curr_field
, "");
1010 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1011 BT_COMP_LOGE("Cannot set \"func\" curr_field field's value: "
1012 "str-fc-addr=%p", curr_field
);
1013 bt_current_thread_clear_error();
1018 void fill_debug_info_src_field(struct debug_info_source
*dbg_info_src
,
1019 bool full_path
, bt_field
*curr_field
,
1020 bt_logging_level log_level
,
1021 bt_self_component
*self_comp
)
1023 bt_field_string_set_value_status set_status
;
1024 bt_field_string_append_status append_status
;
1026 BT_ASSERT(bt_field_get_class_type(curr_field
) ==
1027 BT_FIELD_CLASS_TYPE_STRING
);
1029 if (dbg_info_src
&& dbg_info_src
->src_path
) {
1031 set_status
= bt_field_string_set_value(curr_field
,
1032 dbg_info_src
->src_path
);
1034 set_status
= bt_field_string_set_value(curr_field
,
1035 dbg_info_src
->short_src_path
);
1037 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1038 BT_COMP_LOGE("Cannot set path component of \"src\" "
1039 "curr_field field's value: str-fc-addr=%p",
1041 bt_current_thread_clear_error();
1044 append_status
= bt_field_string_append(curr_field
, ":");
1045 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1046 BT_COMP_LOGE("Cannot set colon component of \"src\" "
1047 "curr_field field's value: str-fc-addr=%p",
1049 bt_current_thread_clear_error();
1052 append_status
= bt_field_string_append(curr_field
,
1053 dbg_info_src
->line_no
);
1054 if (append_status
!= BT_FIELD_STRING_APPEND_STATUS_OK
) {
1055 BT_COMP_LOGE("Cannot set line number component of \"src\" "
1056 "curr_field field's value: str-fc-addr=%p",
1058 bt_current_thread_clear_error();
1061 set_status
= bt_field_string_set_value(curr_field
, "");
1062 if (set_status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1063 BT_COMP_LOGE("Cannot set \"src\" curr_field field's value: "
1064 "str-fc-addr=%p", curr_field
);
1065 bt_current_thread_clear_error();
1071 void fill_debug_info_field_empty(bt_field
*debug_info_field
,
1072 bt_logging_level log_level
, bt_self_component
*self_comp
)
1074 bt_field_string_set_value_status status
;
1075 bt_field
*bin_field
, *func_field
, *src_field
;
1077 BT_ASSERT(bt_field_get_class_type(debug_info_field
) ==
1078 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1080 bin_field
= bt_field_structure_borrow_member_field_by_name(
1081 debug_info_field
, "bin");
1082 func_field
= bt_field_structure_borrow_member_field_by_name(
1083 debug_info_field
, "func");
1084 src_field
= bt_field_structure_borrow_member_field_by_name(
1085 debug_info_field
, "src");
1087 BT_ASSERT(bt_field_get_class_type(bin_field
) ==
1088 BT_FIELD_CLASS_TYPE_STRING
);
1089 BT_ASSERT(bt_field_get_class_type(func_field
) ==
1090 BT_FIELD_CLASS_TYPE_STRING
);
1091 BT_ASSERT(bt_field_get_class_type(src_field
) ==
1092 BT_FIELD_CLASS_TYPE_STRING
);
1094 status
= bt_field_string_set_value(bin_field
, "");
1095 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1096 BT_COMP_LOGE("Cannot set \"bin\" bin_field field's value: "
1097 "str-fc-addr=%p", bin_field
);
1098 bt_current_thread_clear_error();
1101 status
= bt_field_string_set_value(func_field
, "");
1102 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1103 BT_COMP_LOGE("Cannot set \"func\" func_field field's value: "
1104 "str-fc-addr=%p", func_field
);
1105 bt_current_thread_clear_error();
1108 status
= bt_field_string_set_value(src_field
, "");
1109 if (status
!= BT_FIELD_STRING_SET_VALUE_STATUS_OK
) {
1110 BT_COMP_LOGE("Cannot set \"src\" src_field field's value: "
1111 "str-fc-addr=%p", src_field
);
1112 bt_current_thread_clear_error();
1116 void fill_debug_info_field(struct debug_info
*debug_info
, int64_t vpid
,
1117 uint64_t ip
, bt_field
*debug_info_field
)
1119 struct debug_info_source
*dbg_info_src
;
1120 const bt_field_class
*debug_info_fc
;
1122 BT_ASSERT(bt_field_get_class_type(debug_info_field
) ==
1123 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1125 debug_info_fc
= bt_field_borrow_class_const(debug_info_field
);
1127 BT_ASSERT(bt_field_class_structure_get_member_count(debug_info_fc
) == 3);
1129 dbg_info_src
= debug_info_query(debug_info
, vpid
, ip
);
1131 fill_debug_info_bin_field(dbg_info_src
,
1132 debug_info
->comp
->arg_full_path
,
1133 bt_field_structure_borrow_member_field_by_name(
1134 debug_info_field
, "bin"),
1135 debug_info
->log_level
, debug_info
->self_comp
);
1136 fill_debug_info_func_field(dbg_info_src
,
1137 bt_field_structure_borrow_member_field_by_name(
1138 debug_info_field
, "func"),
1139 debug_info
->log_level
, debug_info
->self_comp
);
1140 fill_debug_info_src_field(dbg_info_src
,
1141 debug_info
->comp
->arg_full_path
,
1142 bt_field_structure_borrow_member_field_by_name(
1143 debug_info_field
, "src"),
1144 debug_info
->log_level
, debug_info
->self_comp
);
1148 void fill_debug_info_event_if_needed(struct debug_info_msg_iter
*debug_it
,
1149 const bt_event
*in_event
, bt_event
*out_event
)
1151 bt_field
*out_common_ctx_field
, *out_debug_info_field
;
1152 const bt_field
*vpid_field
, *ip_field
, *in_common_ctx_field
;
1153 const bt_field_class
*in_common_ctx_fc
;
1154 struct debug_info
*debug_info
;
1157 gchar
*debug_info_field_name
=
1158 debug_it
->debug_info_component
->arg_debug_info_field_name
;
1159 bt_logging_level log_level
= debug_it
->log_level
;
1160 bt_self_component
*self_comp
= debug_it
->self_comp
;
1162 in_common_ctx_field
= bt_event_borrow_common_context_field_const(
1164 if (!in_common_ctx_field
) {
1166 * There is no event common context so no need to add debug
1172 in_common_ctx_fc
= bt_field_borrow_class_const(in_common_ctx_field
);
1173 if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc
,
1174 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1176 * The input event common context does not have the necessary
1177 * fields to resolve debug information.
1182 /* Borrow the debug-info field. */
1183 out_common_ctx_field
= bt_event_borrow_common_context_field(out_event
);
1184 if (!out_common_ctx_field
) {
1188 out_debug_info_field
= bt_field_structure_borrow_member_field_by_name(
1189 out_common_ctx_field
, debug_info_field_name
);
1191 vpid_field
= bt_field_structure_borrow_member_field_by_name_const(
1192 out_common_ctx_field
, VPID_FIELD_NAME
);
1193 ip_field
= bt_field_structure_borrow_member_field_by_name_const(
1194 out_common_ctx_field
, IP_FIELD_NAME
);
1196 vpid
= bt_field_integer_signed_get_value(vpid_field
);
1197 ip
= bt_field_integer_unsigned_get_value(ip_field
);
1200 * Borrow the debug_info structure needed for the source
1203 debug_info
= g_hash_table_lookup(debug_it
->debug_info_map
,
1204 bt_stream_borrow_trace_const(
1205 bt_event_borrow_stream_const(in_event
)));
1209 * Perform the debug-info resolving and set the event fields
1212 fill_debug_info_field(debug_info
, vpid
, ip
, out_debug_info_field
);
1214 BT_COMP_LOGD("No debug information for this trace. Setting debug "
1215 "info fields to empty strings.");
1216 fill_debug_info_field_empty(out_debug_info_field
,
1217 log_level
, self_comp
);
1224 void update_event_statedump_if_needed(struct debug_info_msg_iter
*debug_it
,
1225 const bt_event
*in_event
)
1227 const bt_field
*event_common_ctx
;
1228 const bt_field_class
*event_common_ctx_fc
;
1229 const bt_event_class
*in_event_class
= bt_event_borrow_class_const(in_event
);
1232 * If the event is an lttng_ust_statedump event AND has the right event
1233 * common context fields update the debug-info view for this process.
1235 event_common_ctx
= bt_event_borrow_common_context_field_const(in_event
);
1236 if (!event_common_ctx
) {
1240 event_common_ctx_fc
= bt_field_borrow_class_const(event_common_ctx
);
1241 if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc
,
1242 debug_it
->ir_maps
->debug_info_field_class_name
)) {
1243 /* Checkout if it might be a one of lttng ust statedump events. */
1244 const char *in_event_name
= bt_event_class_get_name(in_event_class
);
1245 if (strncmp(in_event_name
, LTTNG_UST_STATEDUMP_PREFIX
,
1246 strlen(LTTNG_UST_STATEDUMP_PREFIX
)) == 0) {
1247 /* Handle statedump events. */
1248 handle_event_statedump(debug_it
, in_event
);
1256 bt_message
*handle_event_message(struct debug_info_msg_iter
*debug_it
,
1257 const bt_message
*in_message
)
1259 const bt_clock_snapshot
*cs
;
1260 const bt_clock_class
*default_cc
;
1261 const bt_packet
*in_packet
;
1262 const bt_stream
*in_stream
;
1263 const bt_stream
*out_stream
;
1264 bt_event_class
*out_event_class
;
1265 bt_packet
*out_packet
= NULL
;
1266 bt_event
*out_event
;
1267 bt_logging_level log_level
= debug_it
->log_level
;
1268 bt_self_component
*self_comp
= debug_it
->self_comp
;
1270 bt_message
*out_message
= NULL
;
1272 /* Borrow the input event and its event class. */
1273 const bt_event
*in_event
=
1274 bt_message_event_borrow_event_const(in_message
);
1275 const bt_event_class
*in_event_class
=
1276 bt_event_borrow_class_const(in_event
);
1278 update_event_statedump_if_needed(debug_it
, in_event
);
1280 out_event_class
= trace_ir_mapping_borrow_mapped_event_class(
1281 debug_it
->ir_maps
, in_event_class
);
1282 if (!out_event_class
) {
1283 out_event_class
= trace_ir_mapping_create_new_mapped_event_class(
1284 debug_it
->ir_maps
, in_event_class
);
1286 BT_ASSERT(out_event_class
);
1288 /* Borrow the input stream. */
1289 in_stream
= bt_event_borrow_stream_const(in_event
);
1290 BT_ASSERT(in_stream
);
1291 out_stream
= trace_ir_mapping_borrow_mapped_stream(debug_it
->ir_maps
,
1293 BT_ASSERT(in_stream
);
1295 /* Borrow the input and output packets. */
1296 in_packet
= bt_event_borrow_packet_const(in_event
);
1298 out_packet
= trace_ir_mapping_borrow_mapped_packet(
1299 debug_it
->ir_maps
, in_packet
);
1302 default_cc
= bt_stream_class_borrow_default_clock_class_const(
1303 bt_event_class_borrow_stream_class_const(in_event_class
));
1305 /* Borrow event clock snapshot. */
1306 cs
= bt_message_event_borrow_default_clock_snapshot_const(
1309 /* Create an output event message. */
1312 bt_message_event_create_with_packet_and_default_clock_snapshot(
1313 debug_it
->input_iterator
,
1314 out_event_class
, out_packet
,
1315 bt_clock_snapshot_get_value(cs
));
1318 bt_message_event_create_with_default_clock_snapshot(
1319 debug_it
->input_iterator
,
1320 out_event_class
, out_stream
,
1321 bt_clock_snapshot_get_value(cs
));
1325 out_message
= bt_message_event_create_with_packet(
1326 debug_it
->input_iterator
, out_event_class
,
1329 out_message
= bt_message_event_create(
1330 debug_it
->input_iterator
, out_event_class
,
1336 BT_COMP_LOGE("Error creating output event message.");
1340 out_event
= bt_message_event_borrow_event(out_message
);
1342 /* Copy the original fields to the output event. */
1343 copy_event_content(in_event
, out_event
, log_level
, self_comp
);
1346 * Try to set the debug-info fields based on debug information that is
1349 fill_debug_info_event_if_needed(debug_it
, in_event
, out_event
);
1356 bt_message
*handle_stream_begin_message(struct debug_info_msg_iter
*debug_it
,
1357 const bt_message
*in_message
)
1359 const bt_stream
*in_stream
;
1360 bt_message
*out_message
;
1361 bt_stream
*out_stream
;
1362 bt_logging_level log_level
= debug_it
->log_level
;
1363 bt_self_component
*self_comp
= debug_it
->self_comp
;
1365 in_stream
= bt_message_stream_beginning_borrow_stream_const(in_message
);
1366 BT_ASSERT(in_stream
);
1368 /* Create a duplicated output stream. */
1369 out_stream
= trace_ir_mapping_create_new_mapped_stream(
1370 debug_it
->ir_maps
, in_stream
);
1376 /* Create an output stream beginning message. */
1377 out_message
= bt_message_stream_beginning_create(
1378 debug_it
->input_iterator
, out_stream
);
1380 BT_COMP_LOGE("Error creating output stream beginning message: "
1381 "out-s-addr=%p", out_stream
);
1388 bt_message
*handle_stream_end_message(struct debug_info_msg_iter
*debug_it
,
1389 const bt_message
*in_message
)
1391 const bt_stream
*in_stream
;
1392 bt_message
*out_message
= NULL
;
1393 bt_stream
*out_stream
;
1394 bt_logging_level log_level
= debug_it
->log_level
;
1395 bt_self_component
*self_comp
= debug_it
->self_comp
;
1397 in_stream
= bt_message_stream_end_borrow_stream_const(in_message
);
1398 BT_ASSERT(in_stream
);
1400 out_stream
= trace_ir_mapping_borrow_mapped_stream(
1401 debug_it
->ir_maps
, in_stream
);
1402 BT_ASSERT(out_stream
);
1404 /* Create an output stream end message. */
1405 out_message
= bt_message_stream_end_create(debug_it
->input_iterator
,
1408 BT_COMP_LOGE("Error creating output stream end message: out-s-addr=%p",
1413 /* Remove stream from trace mapping hashtable. */
1414 trace_ir_mapping_remove_mapped_stream(debug_it
->ir_maps
, in_stream
);
1421 bt_message
*handle_packet_begin_message(struct debug_info_msg_iter
*debug_it
,
1422 const bt_message
*in_message
)
1424 bool has_default_clock_snapshot
;
1425 const bt_clock_snapshot
*cs
;
1426 bt_message
*out_message
= NULL
;
1427 bt_packet
*out_packet
;
1428 bt_logging_level log_level
= debug_it
->log_level
;
1429 bt_self_component
*self_comp
= debug_it
->self_comp
;
1431 const bt_packet
*in_packet
=
1432 bt_message_packet_beginning_borrow_packet_const(in_message
);
1433 BT_ASSERT(in_packet
);
1435 /* This packet should not be already mapped. */
1436 BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet(
1437 debug_it
->ir_maps
, in_packet
));
1439 out_packet
= trace_ir_mapping_create_new_mapped_packet(debug_it
->ir_maps
,
1442 BT_ASSERT(out_packet
);
1444 has_default_clock_snapshot
=
1445 bt_stream_class_packets_have_beginning_default_clock_snapshot(
1446 bt_stream_borrow_class_const(
1447 bt_packet_borrow_stream_const(in_packet
)));
1448 if (has_default_clock_snapshot
) {
1449 /* Borrow clock snapshot. */
1450 cs
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
1453 /* Create an output packet beginning message. */
1454 out_message
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1455 debug_it
->input_iterator
, out_packet
,
1456 bt_clock_snapshot_get_value(cs
));
1458 out_message
= bt_message_packet_beginning_create(
1459 debug_it
->input_iterator
, out_packet
);
1462 BT_COMP_LOGE("Error creating output packet beginning message: "
1463 "out-p-addr=%p", out_packet
);
1470 bt_message
*handle_packet_end_message(struct debug_info_msg_iter
*debug_it
,
1471 const bt_message
*in_message
)
1473 bool has_default_clock_snapshot
;
1474 const bt_clock_snapshot
*cs
;
1475 const bt_packet
*in_packet
;
1476 bt_message
*out_message
= NULL
;
1477 bt_packet
*out_packet
;
1478 bt_logging_level log_level
= debug_it
->log_level
;
1479 bt_self_component
*self_comp
= debug_it
->self_comp
;
1481 in_packet
= bt_message_packet_end_borrow_packet_const(in_message
);
1482 BT_ASSERT(in_packet
);
1484 out_packet
= trace_ir_mapping_borrow_mapped_packet(debug_it
->ir_maps
, in_packet
);
1485 BT_ASSERT(out_packet
);
1487 has_default_clock_snapshot
=
1488 bt_stream_class_packets_have_end_default_clock_snapshot(
1489 bt_stream_borrow_class_const(
1490 bt_packet_borrow_stream_const(in_packet
)));
1491 if (has_default_clock_snapshot
) {
1492 /* Borrow clock snapshot. */
1493 cs
= bt_message_packet_end_borrow_default_clock_snapshot_const(
1496 /* Create an outpute packet end message. */
1497 out_message
= bt_message_packet_end_create_with_default_clock_snapshot(
1498 debug_it
->input_iterator
, out_packet
,
1499 bt_clock_snapshot_get_value(cs
));
1501 out_message
= bt_message_packet_end_create(
1502 debug_it
->input_iterator
, out_packet
);
1506 BT_COMP_LOGE("Error creating output packet end message: "
1507 "out-p-addr=%p", out_packet
);
1511 /* Remove packet from data mapping hashtable. */
1512 trace_ir_mapping_remove_mapped_packet(debug_it
->ir_maps
, in_packet
);
1519 bt_message
*handle_msg_iterator_inactivity(struct debug_info_msg_iter
*debug_it
,
1520 const bt_message
*in_message
)
1523 * This message type can be forwarded directly because it does
1524 * not refer to any objects in the trace class.
1526 bt_message_get_ref(in_message
);
1527 return (bt_message
*) in_message
;
1531 bt_message
*handle_discarded_events_message(struct debug_info_msg_iter
*debug_it
,
1532 const bt_message
*in_message
)
1534 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1535 const bt_stream
*in_stream
;
1536 bool has_default_clock_snapshots
;
1537 uint64_t discarded_events
, begin_cs_value
, end_cs_value
;
1538 bt_property_availability prop_avail
;
1539 bt_message
*out_message
= NULL
;
1540 bt_stream
*out_stream
;
1541 bt_logging_level log_level
= debug_it
->log_level
;
1542 bt_self_component
*self_comp
= debug_it
->self_comp
;
1544 in_stream
= bt_message_discarded_events_borrow_stream_const(
1546 BT_ASSERT(in_stream
);
1548 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1550 BT_ASSERT(out_stream
);
1552 has_default_clock_snapshots
=
1553 bt_stream_class_discarded_events_have_default_clock_snapshots(
1554 bt_stream_borrow_class_const(in_stream
));
1555 if (has_default_clock_snapshots
) {
1556 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1558 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1561 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1562 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1564 out_message
= bt_message_discarded_events_create_with_default_clock_snapshots(
1565 debug_it
->input_iterator
, out_stream
,
1566 begin_cs_value
, end_cs_value
);
1568 out_message
= bt_message_discarded_events_create(
1569 debug_it
->input_iterator
, out_stream
);
1572 BT_COMP_LOGE("Error creating output discarded events message: "
1573 "out-s-addr=%p", out_stream
);
1577 prop_avail
= bt_message_discarded_events_get_count(in_message
,
1580 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1581 bt_message_discarded_events_set_count(out_message
,
1590 bt_message
*handle_discarded_packets_message(struct debug_info_msg_iter
*debug_it
,
1591 const bt_message
*in_message
)
1593 const bt_clock_snapshot
*begin_cs
, *end_cs
;
1594 bool has_default_clock_snapshots
;
1595 const bt_stream
*in_stream
;
1596 uint64_t discarded_packets
, begin_cs_value
, end_cs_value
;
1597 bt_property_availability prop_avail
;
1598 bt_message
*out_message
= NULL
;
1599 bt_stream
*out_stream
;
1600 bt_logging_level log_level
= debug_it
->log_level
;
1601 bt_self_component
*self_comp
= debug_it
->self_comp
;
1603 in_stream
= bt_message_discarded_packets_borrow_stream_const(
1605 BT_ASSERT(in_stream
);
1607 out_stream
= trace_ir_mapping_borrow_mapped_stream( debug_it
->ir_maps
,
1609 BT_ASSERT(out_stream
);
1611 has_default_clock_snapshots
=
1612 bt_stream_class_discarded_packets_have_default_clock_snapshots(
1613 bt_stream_borrow_class_const(in_stream
));
1614 if (has_default_clock_snapshots
) {
1615 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1618 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1621 begin_cs_value
= bt_clock_snapshot_get_value(begin_cs
);
1622 end_cs_value
= bt_clock_snapshot_get_value(end_cs
);
1624 out_message
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1625 debug_it
->input_iterator
, out_stream
,
1626 begin_cs_value
, end_cs_value
);
1628 out_message
= bt_message_discarded_packets_create(
1629 debug_it
->input_iterator
, out_stream
);
1632 BT_COMP_LOGE("Error creating output discarded packet message: "
1633 "out-s-addr=%p", out_stream
);
1637 prop_avail
= bt_message_discarded_packets_get_count(in_message
,
1638 &discarded_packets
);
1639 if (prop_avail
== BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
) {
1640 bt_message_discarded_packets_set_count(out_message
,
1649 const bt_message
*handle_message(struct debug_info_msg_iter
*debug_it
,
1650 const bt_message
*in_message
)
1652 bt_message
*out_message
= NULL
;
1654 switch (bt_message_get_type(in_message
)) {
1655 case BT_MESSAGE_TYPE_EVENT
:
1656 out_message
= handle_event_message(debug_it
, in_message
);
1658 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1659 out_message
= handle_packet_begin_message(debug_it
, in_message
);
1661 case BT_MESSAGE_TYPE_PACKET_END
:
1662 out_message
= handle_packet_end_message(debug_it
, in_message
);
1664 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1665 out_message
= handle_stream_begin_message(debug_it
, in_message
);
1667 case BT_MESSAGE_TYPE_STREAM_END
:
1668 out_message
= handle_stream_end_message(debug_it
, in_message
);
1670 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1671 out_message
= handle_msg_iterator_inactivity(debug_it
, in_message
);
1673 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1674 out_message
= handle_discarded_events_message(debug_it
, in_message
);
1676 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1677 out_message
= handle_discarded_packets_message(debug_it
, in_message
);
1687 struct bt_param_validation_map_value_entry_descr debug_info_params
[] = {
1688 { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1689 { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1690 { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
1691 { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
1692 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1696 bt_component_class_initialize_method_status
init_from_params(
1697 struct debug_info_component
*debug_info_component
,
1698 const bt_value
*params
)
1700 const bt_value
*value
;
1701 bt_component_class_initialize_method_status status
;
1702 bt_logging_level log_level
= debug_info_component
->log_level
;
1703 enum bt_param_validation_status validation_status
;
1704 gchar
*validate_error
= NULL
;
1706 validation_status
= bt_param_validation_validate(params
,
1707 debug_info_params
, &validate_error
);
1708 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1709 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1711 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1712 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1713 BT_COMP_LOGE_APPEND_CAUSE(debug_info_component
->self_comp
,
1714 "%s", validate_error
);
1720 value
= bt_value_map_borrow_entry_value_const(params
,
1721 "debug-info-field-name");
1723 debug_info_component
->arg_debug_info_field_name
=
1724 g_strdup(bt_value_string_get(value
));
1726 debug_info_component
->arg_debug_info_field_name
=
1727 g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME
);
1730 value
= bt_value_map_borrow_entry_value_const(params
, "debug-info-dir");
1732 debug_info_component
->arg_debug_dir
=
1733 g_strdup(bt_value_string_get(value
));
1735 debug_info_component
->arg_debug_dir
= NULL
;
1739 value
= bt_value_map_borrow_entry_value_const(params
, "target-prefix");
1741 debug_info_component
->arg_target_prefix
=
1742 g_strdup(bt_value_string_get(value
));
1744 debug_info_component
->arg_target_prefix
= NULL
;
1747 value
= bt_value_map_borrow_entry_value_const(params
, "full-path");
1749 debug_info_component
->arg_full_path
= bt_value_bool_get(value
);
1751 debug_info_component
->arg_full_path
= BT_FALSE
;
1754 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1757 g_free(validate_error
);
1763 bt_component_class_initialize_method_status
debug_info_comp_init(
1764 bt_self_component_filter
*self_comp_flt
,
1765 bt_self_component_filter_configuration
*config
,
1766 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1768 struct debug_info_component
*debug_info_comp
;
1769 bt_component_class_initialize_method_status status
=
1770 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1771 bt_self_component_add_port_status add_port_status
;
1772 bt_self_component
*self_comp
=
1773 bt_self_component_filter_as_self_component(self_comp_flt
);
1774 bt_logging_level log_level
= bt_component_get_logging_level(
1775 bt_self_component_as_component(self_comp
));
1777 BT_COMP_LOGI("Initializing debug_info component: "
1778 "comp-addr=%p, params-addr=%p", self_comp
, params
);
1780 debug_info_comp
= g_new0(struct debug_info_component
, 1);
1781 if (!debug_info_comp
) {
1782 BT_COMP_LOGE_STR("Failed to allocate one debug_info component.");
1786 debug_info_comp
->log_level
= log_level
;
1787 debug_info_comp
->self_comp
= self_comp
;
1788 bt_self_component_set_data(self_comp
, debug_info_comp
);
1790 add_port_status
= bt_self_component_filter_add_input_port(
1791 self_comp_flt
, "in", NULL
, NULL
);
1792 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1793 status
= (int) add_port_status
;
1797 add_port_status
= bt_self_component_filter_add_output_port(
1798 self_comp_flt
, "out", NULL
, NULL
);
1799 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1800 status
= (int) add_port_status
;
1804 status
= init_from_params(debug_info_comp
, params
);
1805 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1806 BT_COMP_LOGE("Cannot configure debug_info component: "
1807 "debug_info-comp-addr=%p, params-addr=%p",
1808 debug_info_comp
, params
);
1815 destroy_debug_info_comp(debug_info_comp
);
1816 bt_self_component_set_data(self_comp
, NULL
);
1818 if (status
== BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1819 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1826 void debug_info_comp_finalize(bt_self_component_filter
*self_comp_flt
)
1828 struct debug_info_component
*debug_info
=
1829 bt_self_component_get_data(
1830 bt_self_component_filter_as_self_component(
1832 bt_logging_level log_level
= debug_info
->log_level
;
1833 bt_self_component
*self_comp
= debug_info
->self_comp
;
1835 BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p",
1838 destroy_debug_info_comp(debug_info
);
1842 bt_component_class_message_iterator_next_method_status
debug_info_msg_iter_next(
1843 bt_self_message_iterator
*self_msg_iter
,
1844 const bt_message_array_const msgs
, uint64_t capacity
,
1847 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1848 bt_message_iterator_next_status upstream_iterator_ret_status
;
1849 struct debug_info_msg_iter
*debug_info_msg_iter
;
1850 struct debug_info_component
*debug_info
= NULL
;
1851 bt_component_class_message_iterator_next_method_status status
;
1852 bt_self_component
*self_comp
= NULL
;
1853 bt_message_array_const input_msgs
;
1854 const bt_message
*out_message
;
1855 uint64_t curr_msg_idx
, i
;
1857 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1859 self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
1860 BT_ASSERT(self_comp
);
1862 debug_info
= bt_self_component_get_data(self_comp
);
1863 BT_ASSERT(debug_info
);
1865 debug_info_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
1866 BT_ASSERT(debug_info_msg_iter
);
1868 upstream_iterator
= debug_info_msg_iter
->msg_iter
;
1869 BT_ASSERT(upstream_iterator
);
1871 upstream_iterator_ret_status
=
1872 bt_self_component_port_input_message_iterator_next(
1873 upstream_iterator
, &input_msgs
, count
);
1874 if (upstream_iterator_ret_status
!=
1875 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
1877 * No messages were returned. Not necessarily an error.
1878 * Convert the upstream message iterator status to a
1881 status
= (int) upstream_iterator_ret_status
;
1886 * There should never be more received messages than the capacity we
1889 BT_ASSERT(*count
<= capacity
);
1891 for (curr_msg_idx
= 0; curr_msg_idx
< *count
; curr_msg_idx
++) {
1892 out_message
= handle_message(debug_info_msg_iter
,
1893 input_msgs
[curr_msg_idx
]);
1895 goto handle_msg_error
;
1898 msgs
[curr_msg_idx
] = out_message
;
1900 * Drop our reference of the input message as we are done with
1901 * it and created a output copy.
1903 bt_message_put_ref(input_msgs
[curr_msg_idx
]);
1910 * Drop references of all the output messages created before the
1913 for (i
= 0; i
< curr_msg_idx
; i
++) {
1914 bt_message_put_ref(msgs
[i
]);
1918 * Drop references of all the input messages not dropped before the
1921 for (i
= curr_msg_idx
; i
< *count
; i
++) {
1922 bt_message_put_ref(input_msgs
[i
]);
1925 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1932 void debug_info_msg_iter_destroy(struct debug_info_msg_iter
*debug_info_msg_iter
)
1934 if (!debug_info_msg_iter
) {
1938 if (debug_info_msg_iter
->msg_iter
) {
1939 bt_self_component_port_input_message_iterator_put_ref(
1940 debug_info_msg_iter
->msg_iter
);
1943 if (debug_info_msg_iter
->ir_maps
) {
1944 trace_ir_maps_destroy(debug_info_msg_iter
->ir_maps
);
1947 if (debug_info_msg_iter
->debug_info_map
) {
1948 g_hash_table_destroy(debug_info_msg_iter
->debug_info_map
);
1951 bt_fd_cache_fini(&debug_info_msg_iter
->fd_cache
);
1952 g_free(debug_info_msg_iter
);
1959 bt_component_class_message_iterator_initialize_method_status
debug_info_msg_iter_init(
1960 bt_self_message_iterator
*self_msg_iter
,
1961 bt_self_message_iterator_configuration
*config
,
1962 bt_self_component_filter
*self_comp_flt
,
1963 bt_self_component_port_output
*self_port
)
1965 bt_component_class_message_iterator_initialize_method_status status
;
1966 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
1968 struct bt_self_component_port_input
*input_port
= NULL
;
1969 bt_self_component_port_input_message_iterator
*upstream_iterator
= NULL
;
1970 struct debug_info_msg_iter
*debug_info_msg_iter
= NULL
;
1971 gchar
*debug_info_field_name
;
1973 bt_self_component
*self_comp
=
1974 bt_self_component_filter_as_self_component(self_comp_flt
);
1975 bt_logging_level log_level
= bt_component_get_logging_level(
1976 bt_self_component_as_component(self_comp
));
1978 /* Borrow the upstream input port. */
1979 input_port
= bt_self_component_filter_borrow_input_port_by_name(
1980 self_comp_flt
, "in");
1982 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1986 debug_info_msg_iter
= g_new0(struct debug_info_msg_iter
, 1);
1987 if (!debug_info_msg_iter
) {
1988 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1992 debug_info_msg_iter
->log_level
= log_level
;
1993 debug_info_msg_iter
->self_comp
= self_comp
;
1995 /* Create an iterator on the upstream component. */
1996 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_message_iterator(
1997 self_msg_iter
, input_port
, &upstream_iterator
);
1998 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
1999 status
= (int) msg_iter_status
;
2003 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(
2004 debug_info_msg_iter
->msg_iter
, upstream_iterator
);
2006 /* Create hashtable that will contain debug info mapping. */
2007 debug_info_msg_iter
->debug_info_map
= g_hash_table_new_full(
2008 g_direct_hash
, g_direct_equal
, (GDestroyNotify
) NULL
,
2009 (GDestroyNotify
) debug_info_destroy
);
2010 if (!debug_info_msg_iter
->debug_info_map
) {
2011 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2015 debug_info_msg_iter
->debug_info_component
=
2016 bt_self_component_get_data(self_comp
);
2018 debug_info_field_name
=
2019 debug_info_msg_iter
->debug_info_component
->arg_debug_info_field_name
;
2021 debug_info_msg_iter
->ir_maps
= trace_ir_maps_create(self_comp
,
2022 debug_info_field_name
, log_level
);
2023 if (!debug_info_msg_iter
->ir_maps
) {
2024 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2028 ret
= bt_fd_cache_init(&debug_info_msg_iter
->fd_cache
, log_level
);
2030 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2034 bt_self_message_iterator_configuration_set_can_seek_forward(config
,
2035 bt_self_component_port_input_message_iterator_can_seek_forward(
2036 debug_info_msg_iter
->msg_iter
));
2038 bt_self_message_iterator_set_data(self_msg_iter
, debug_info_msg_iter
);
2039 debug_info_msg_iter
->input_iterator
= self_msg_iter
;
2041 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
2045 debug_info_msg_iter_destroy(debug_info_msg_iter
);
2052 bt_component_class_message_iterator_can_seek_beginning_method_status
2053 debug_info_msg_iter_can_seek_beginning(bt_self_message_iterator
*self_msg_iter
,
2056 struct debug_info_msg_iter
*debug_info_msg_iter
=
2057 bt_self_message_iterator_get_data(self_msg_iter
);
2058 BT_ASSERT(debug_info_msg_iter
);
2060 return (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
2061 debug_info_msg_iter
->msg_iter
, can_seek
);
2065 bt_component_class_message_iterator_seek_beginning_method_status
2066 debug_info_msg_iter_seek_beginning(bt_self_message_iterator
*self_msg_iter
)
2068 struct debug_info_msg_iter
*debug_info_msg_iter
=
2069 bt_self_message_iterator_get_data(self_msg_iter
);
2070 bt_component_class_message_iterator_seek_beginning_method_status status
=
2071 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
2072 bt_message_iterator_seek_beginning_status seek_beg_status
;
2074 BT_ASSERT(debug_info_msg_iter
);
2076 /* Ask the upstream component to seek to the beginning. */
2077 seek_beg_status
= bt_self_component_port_input_message_iterator_seek_beginning(
2078 debug_info_msg_iter
->msg_iter
);
2079 if (seek_beg_status
!= BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK
) {
2080 status
= (int) seek_beg_status
;
2084 /* Clear this iterator data. */
2085 trace_ir_maps_clear(debug_info_msg_iter
->ir_maps
);
2086 g_hash_table_remove_all(debug_info_msg_iter
->debug_info_map
);
2093 void debug_info_msg_iter_finalize(bt_self_message_iterator
*it
)
2095 struct debug_info_msg_iter
*debug_info_msg_iter
;
2097 debug_info_msg_iter
= bt_self_message_iterator_get_data(it
);
2098 BT_ASSERT(debug_info_msg_iter
);
2100 debug_info_msg_iter_destroy(debug_info_msg_iter
);