2 * Babeltrace - Mapping of IR metadata and data object between input and output
5 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
7 * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define BT_COMP_LOG_SELF_COMP (ir_maps->self_comp)
29 #define BT_LOG_OUTPUT_LEVEL (ir_maps->log_level)
30 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO/TRACE-IR-MAPPING"
31 #include "logging/comp-logging.h"
35 #include "common/assert.h"
36 #include <babeltrace2/babeltrace.h>
37 /* For bt_property_availability */
38 #include <babeltrace2/property.h>
40 #include "debug-info.h"
41 #include "trace-ir-data-copy.h"
42 #include "trace-ir-mapping.h"
43 #include "trace-ir-metadata-copy.h"
46 bt_trace_class
*create_new_mapped_trace_class(struct trace_ir_maps
*ir_maps
,
47 const bt_trace_class
*in_trace_class
)
50 bt_trace_class
*out_trace_class
;
52 BT_COMP_LOGD("Creating new mapped trace class: in-tc-addr=%p", in_trace_class
);
55 BT_ASSERT(in_trace_class
);
57 /* Create the ouput trace class. */
58 out_trace_class
= bt_trace_class_create(ir_maps
->self_comp
);
59 if (!out_trace_class
) {
60 BT_COMP_LOGE_STR("Error create output trace class");
64 /* If not, create a new one and add it to the mapping. */
65 ret
= copy_trace_class_content(in_trace_class
, out_trace_class
,
66 ir_maps
->log_level
, ir_maps
->self_comp
);
68 BT_COMP_LOGE_STR("Error copy content to output trace class");
69 out_trace_class
= NULL
;
73 BT_COMP_LOGD("Created new mapped trace class: in-tc-addr=%p, out-tc-addr=%p",
74 in_trace_class
, out_trace_class
);
77 return out_trace_class
;
81 bt_trace
*create_new_mapped_trace(struct trace_ir_maps
*ir_maps
,
82 const bt_trace
*in_trace
)
85 const bt_trace_class
*in_trace_class
;
86 struct trace_ir_metadata_maps
*metadata_maps
;
88 BT_COMP_LOGD("Creating new mapped trace: in-t-addr=%p", in_trace
);
92 in_trace_class
= bt_trace_borrow_class_const(in_trace
);
93 metadata_maps
= borrow_metadata_maps_from_input_trace_class(ir_maps
,
96 if (!metadata_maps
->output_trace_class
) {
97 metadata_maps
->output_trace_class
=
98 create_new_mapped_trace_class(ir_maps
, in_trace_class
);
99 if (!metadata_maps
->output_trace_class
) {
105 out_trace
= bt_trace_create(metadata_maps
->output_trace_class
);
107 BT_COMP_LOGE_STR("Error create output trace");
111 /* If not, create a new one and add it to the mapping. */
112 copy_trace_content(in_trace
, out_trace
, ir_maps
->log_level
,
115 BT_COMP_LOGD("Created new mapped trace: in-t-addr=%p, out-t-addr=%p",
116 in_trace
, out_trace
);
122 bt_stream_class
*borrow_mapped_stream_class(struct trace_ir_metadata_maps
*md_maps
,
123 const bt_stream_class
*in_stream_class
)
126 BT_ASSERT(in_stream_class
);
128 return g_hash_table_lookup(md_maps
->stream_class_map
,
129 (gpointer
) in_stream_class
);
133 bt_stream_class
*create_new_mapped_stream_class(struct trace_ir_maps
*ir_maps
,
134 const bt_stream_class
*in_stream_class
)
137 bt_stream_class
*out_stream_class
;
138 struct trace_ir_metadata_maps
*md_maps
;
140 BT_COMP_LOGD("Creating new mapped stream class: in-sc-addr=%p",
143 md_maps
= borrow_metadata_maps_from_input_stream_class(ir_maps
,
147 BT_ASSERT(in_stream_class
);
148 BT_ASSERT(!borrow_mapped_stream_class(md_maps
, in_stream_class
));
150 /* Create an out_stream_class. */
151 out_stream_class
= bt_stream_class_create_with_id(
152 md_maps
->output_trace_class
,
153 bt_stream_class_get_id(in_stream_class
));
154 if (!out_stream_class
) {
155 BT_COMP_LOGE_STR("Error create output stream class");
159 /* If not, create a new one and add it to the mapping. */
160 ret
= copy_stream_class_content(ir_maps
, in_stream_class
,
163 BT_COMP_LOGE_STR("Error copy content to output stream class");
164 out_stream_class
= NULL
;
168 g_hash_table_insert(md_maps
->stream_class_map
,
169 (gpointer
) in_stream_class
, out_stream_class
);
171 BT_COMP_LOGD("Created new mapped stream class: in-sc-addr=%p, out-sc-addr=%p",
172 in_stream_class
, out_stream_class
);
175 return out_stream_class
;
179 bt_stream
*borrow_mapped_stream(struct trace_ir_data_maps
*d_maps
,
180 const bt_stream
*in_stream
)
183 BT_ASSERT(in_stream
);
185 return g_hash_table_lookup(d_maps
->stream_map
, (gpointer
) in_stream
);
189 bt_stream
*trace_ir_mapping_create_new_mapped_stream(
190 struct trace_ir_maps
*ir_maps
,
191 const bt_stream
*in_stream
)
193 struct trace_ir_data_maps
*d_maps
;
194 struct trace_ir_metadata_maps
*md_maps
;
195 const bt_stream_class
*in_stream_class
;
196 const bt_trace
*in_trace
;
197 bt_stream_class
*out_stream_class
;
198 bt_stream
*out_stream
= NULL
;
201 BT_ASSERT(in_stream
);
202 BT_COMP_LOGD("Creating new mapped stream: in-s-addr=%p", in_stream
);
204 in_trace
= bt_stream_borrow_trace_const(in_stream
);
206 d_maps
= borrow_data_maps_from_input_trace(ir_maps
, in_trace
);
207 if (!d_maps
->output_trace
) {
208 d_maps
->output_trace
= create_new_mapped_trace(ir_maps
, in_trace
);
209 if (!d_maps
->output_trace
) {
214 BT_ASSERT(d_maps
->output_trace
);
215 BT_ASSERT(!borrow_mapped_stream(d_maps
, in_stream
));
217 in_stream_class
= bt_stream_borrow_class_const(in_stream
);
218 md_maps
= borrow_metadata_maps_from_input_stream_class(ir_maps
, in_stream_class
);
219 out_stream_class
= borrow_mapped_stream_class(md_maps
, in_stream_class
);
220 if (!out_stream_class
) {
221 out_stream_class
= create_new_mapped_stream_class(ir_maps
,
223 if (!out_stream_class
) {
227 BT_ASSERT(out_stream_class
);
229 out_stream
= bt_stream_create_with_id(out_stream_class
,
230 d_maps
->output_trace
, bt_stream_get_id(in_stream
));
232 BT_COMP_LOGE_STR("Error creating output stream");
236 copy_stream_content(in_stream
, out_stream
, ir_maps
->log_level
,
239 g_hash_table_insert(d_maps
->stream_map
, (gpointer
) in_stream
,
242 BT_COMP_LOGD("Created new mapped stream: in-s-addr=%p, out-s-addr=%p",
243 in_stream
, out_stream
);
250 bt_stream
*trace_ir_mapping_borrow_mapped_stream(struct trace_ir_maps
*ir_maps
,
251 const bt_stream
*in_stream
)
254 BT_ASSERT(in_stream
);
255 struct trace_ir_data_maps
*d_maps
;
257 d_maps
= borrow_data_maps_from_input_stream(ir_maps
, in_stream
);
258 /* Return the mapped stream. */
259 return borrow_mapped_stream(d_maps
, in_stream
);
263 bt_event_class
*borrow_mapped_event_class(struct trace_ir_metadata_maps
*md_maps
,
264 const bt_event_class
*in_event_class
)
266 return g_hash_table_lookup(md_maps
->event_class_map
,
267 (gpointer
) in_event_class
);
271 bt_event_class
*trace_ir_mapping_create_new_mapped_event_class(
272 struct trace_ir_maps
*ir_maps
,
273 const bt_event_class
*in_event_class
)
275 bt_event_class
*out_event_class
;
276 const bt_trace_class
*in_trace_class
;
277 const bt_stream_class
*in_stream_class
;
278 bt_stream_class
*out_stream_class
;
279 struct trace_ir_metadata_maps
*md_maps
;
283 BT_ASSERT(in_event_class
);
284 BT_COMP_LOGD("Creating new mapped event class: in-ec-addr=%p",
287 in_trace_class
= bt_stream_class_borrow_trace_class_const(
288 bt_event_class_borrow_stream_class_const(in_event_class
));
290 md_maps
= borrow_metadata_maps_from_input_trace_class(ir_maps
,
293 BT_ASSERT(!borrow_mapped_event_class(md_maps
, in_event_class
));
296 bt_event_class_borrow_stream_class_const(in_event_class
);
297 BT_ASSERT(in_stream_class
);
299 /* Get the right output stream class to add the new event class to. */
300 out_stream_class
= borrow_mapped_stream_class(md_maps
, in_stream_class
);
301 BT_ASSERT(out_stream_class
);
303 /* Create an output event class. */
304 out_event_class
= bt_event_class_create_with_id(out_stream_class
,
305 bt_event_class_get_id(in_event_class
));
306 if (!out_event_class
) {
307 BT_COMP_LOGE_STR("Error creating output event class");
311 /* If not, create a new one and add it to the mapping. */
312 ret
= copy_event_class_content(ir_maps
, in_event_class
,
315 BT_COMP_LOGE_STR("Error copy content to output event class");
316 out_event_class
= NULL
;
320 g_hash_table_insert(md_maps
->event_class_map
,
321 (gpointer
) in_event_class
, out_event_class
);
323 BT_COMP_LOGD("Created new mapped event class: in-ec-addr=%p, out-ec-addr=%p",
324 in_event_class
, out_event_class
);
327 return out_event_class
;
331 bt_event_class
*trace_ir_mapping_borrow_mapped_event_class(
332 struct trace_ir_maps
*ir_maps
,
333 const bt_event_class
*in_event_class
)
335 struct trace_ir_metadata_maps
*md_maps
;
338 BT_ASSERT(in_event_class
);
340 md_maps
= borrow_metadata_maps_from_input_event_class(ir_maps
,
343 /* Return the mapped event_class. */
344 return borrow_mapped_event_class(md_maps
, in_event_class
);
348 bt_packet
*borrow_mapped_packet(struct trace_ir_data_maps
*d_maps
,
349 const bt_packet
*in_packet
)
352 BT_ASSERT(in_packet
);
354 return g_hash_table_lookup(d_maps
->packet_map
, (gpointer
) in_packet
);
358 bt_packet
*trace_ir_mapping_create_new_mapped_packet(
359 struct trace_ir_maps
*ir_maps
,
360 const bt_packet
*in_packet
)
362 struct trace_ir_data_maps
*d_maps
;
363 const bt_trace
*in_trace
;
364 const bt_stream
*in_stream
;
365 bt_packet
*out_packet
;
366 bt_stream
*out_stream
;
368 BT_COMP_LOGD("Creating new mapped packet: in-p-addr=%p", in_packet
);
370 in_stream
= bt_packet_borrow_stream_const(in_packet
);
371 in_trace
= bt_stream_borrow_trace_const(in_stream
);
372 d_maps
= borrow_data_maps_from_input_trace(ir_maps
, in_trace
);
374 /* There should never be a mapped packet. */
375 BT_ASSERT(!borrow_mapped_packet(d_maps
, in_packet
));
377 BT_ASSERT(in_stream
);
379 /* Get output stream corresponding to this input stream. */
380 out_stream
= borrow_mapped_stream(d_maps
, in_stream
);
381 BT_ASSERT(out_stream
);
383 /* Create the output packet. */
384 out_packet
= bt_packet_create(out_stream
);
386 BT_COMP_LOGE_STR("Error create output packet");
390 copy_packet_content(in_packet
, out_packet
, ir_maps
->log_level
,
393 g_hash_table_insert(d_maps
->packet_map
,
394 (gpointer
) in_packet
, out_packet
);
396 BT_COMP_LOGD("Created new mapped packet: in-p-addr=%p, out-p-addr=%p",
397 in_packet
, out_packet
);
404 bt_packet
*trace_ir_mapping_borrow_mapped_packet(struct trace_ir_maps
*ir_maps
,
405 const bt_packet
*in_packet
)
407 struct trace_ir_data_maps
*d_maps
;
409 BT_ASSERT(in_packet
);
411 d_maps
= borrow_data_maps_from_input_packet(ir_maps
, in_packet
);
413 return borrow_mapped_packet(d_maps
, in_packet
);
417 void trace_ir_mapping_remove_mapped_packet(struct trace_ir_maps
*ir_maps
,
418 const bt_packet
*in_packet
)
422 struct trace_ir_data_maps
*d_maps
;
424 BT_ASSERT(in_packet
);
426 d_maps
= borrow_data_maps_from_input_packet(ir_maps
, in_packet
);
428 ret
= g_hash_table_remove(d_maps
->packet_map
, in_packet
);
434 void trace_ir_mapping_remove_mapped_stream(struct trace_ir_maps
*ir_maps
,
435 const bt_stream
*in_stream
)
438 struct trace_ir_data_maps
*d_maps
;
441 BT_ASSERT(in_stream
);
443 d_maps
= borrow_data_maps_from_input_stream(ir_maps
, in_stream
);
445 ret
= g_hash_table_remove(d_maps
->stream_map
, in_stream
);
451 void trace_ir_metadata_maps_remove_func(const bt_trace_class
*in_trace_class
,
454 struct trace_ir_maps
*maps
= (struct trace_ir_maps
*) data
;
455 if (maps
->metadata_maps
) {
457 ret
= g_hash_table_remove(maps
->metadata_maps
,
458 (gpointer
) in_trace_class
);
464 void trace_ir_data_maps_remove_func(const bt_trace
*in_trace
, void *data
)
466 struct trace_ir_maps
*maps
= (struct trace_ir_maps
*) data
;
467 if (maps
->data_maps
) {
469 ret
= g_hash_table_remove(maps
->data_maps
, (gpointer
) in_trace
);
474 struct trace_ir_data_maps
*trace_ir_data_maps_create(struct trace_ir_maps
*ir_maps
,
475 const bt_trace
*in_trace
)
477 struct trace_ir_data_maps
*d_maps
= g_new0(struct trace_ir_data_maps
, 1);
478 bt_trace_add_listener_status add_listener_status
;
481 BT_COMP_LOGE_STR("Error allocating trace_ir_maps");
485 d_maps
->log_level
= ir_maps
->log_level
;
486 d_maps
->self_comp
= ir_maps
->self_comp
;
487 d_maps
->input_trace
= in_trace
;
489 /* Create the hashtables used to map data objects. */
490 d_maps
->stream_map
= g_hash_table_new_full(g_direct_hash
,
491 g_direct_equal
, NULL
,(GDestroyNotify
) bt_stream_put_ref
);
492 d_maps
->packet_map
= g_hash_table_new_full(g_direct_hash
,
493 g_direct_equal
, NULL
,(GDestroyNotify
) bt_packet_put_ref
);
495 add_listener_status
= bt_trace_add_destruction_listener(
496 in_trace
, trace_ir_data_maps_remove_func
,
497 ir_maps
, &d_maps
->destruction_listener_id
);
498 BT_ASSERT(add_listener_status
== BT_TRACE_ADD_LISTENER_STATUS_OK
);
504 struct trace_ir_metadata_maps
*trace_ir_metadata_maps_create(
505 struct trace_ir_maps
*ir_maps
,
506 const bt_trace_class
*in_trace_class
)
508 struct trace_ir_metadata_maps
*md_maps
=
509 g_new0(struct trace_ir_metadata_maps
, 1);
510 bt_trace_class_add_listener_status add_listener_status
;
513 BT_COMP_LOGE_STR("Error allocating trace_ir_maps");
517 md_maps
->log_level
= ir_maps
->log_level
;
518 md_maps
->self_comp
= ir_maps
->self_comp
;
519 md_maps
->input_trace_class
= in_trace_class
;
521 * Create the field class resolving context. This is needed to keep
522 * track of the field class already copied in order to do the field
523 * path resolution correctly.
525 md_maps
->fc_resolving_ctx
=
526 g_new0(struct field_class_resolving_context
, 1);
527 if (!md_maps
->fc_resolving_ctx
) {
528 BT_COMP_LOGE_STR("Error allocating field_class_resolving_context");
532 /* Create the hashtables used to map metadata objects. */
533 md_maps
->stream_class_map
= g_hash_table_new_full(g_direct_hash
,
534 g_direct_equal
, NULL
, (GDestroyNotify
) bt_stream_class_put_ref
);
535 md_maps
->event_class_map
= g_hash_table_new_full(g_direct_hash
,
536 g_direct_equal
, NULL
, (GDestroyNotify
) bt_event_class_put_ref
);
537 md_maps
->field_class_map
= g_hash_table_new_full(g_direct_hash
,
538 g_direct_equal
, NULL
, (GDestroyNotify
) bt_field_class_put_ref
);
539 md_maps
->clock_class_map
= g_hash_table_new_full(g_direct_hash
,
540 g_direct_equal
, NULL
, (GDestroyNotify
) bt_clock_class_put_ref
);
542 add_listener_status
= bt_trace_class_add_destruction_listener(
543 in_trace_class
, trace_ir_metadata_maps_remove_func
,
544 ir_maps
, &md_maps
->destruction_listener_id
);
545 BT_ASSERT(add_listener_status
== BT_TRACE_CLASS_ADD_LISTENER_STATUS_OK
);
552 void trace_ir_data_maps_destroy(struct trace_ir_data_maps
*maps
)
554 bt_trace_remove_listener_status status
;
560 if (maps
->packet_map
) {
561 g_hash_table_destroy(maps
->packet_map
);
564 if (maps
->stream_map
) {
565 g_hash_table_destroy(maps
->stream_map
);
568 if (maps
->output_trace
) {
569 bt_trace_put_ref(maps
->output_trace
);
572 status
= bt_trace_remove_destruction_listener(maps
->input_trace
,
573 maps
->destruction_listener_id
);
574 if (status
!= BT_TRACE_REMOVE_LISTENER_STATUS_OK
) {
575 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, maps
->log_level
,
577 "Trace destruction listener removal failed.");
578 bt_current_thread_clear_error();
585 void trace_ir_metadata_maps_destroy(struct trace_ir_metadata_maps
*maps
)
587 bt_trace_class_remove_listener_status status
;
593 if (maps
->stream_class_map
) {
594 g_hash_table_destroy(maps
->stream_class_map
);
597 if (maps
->event_class_map
) {
598 g_hash_table_destroy(maps
->event_class_map
);
601 if (maps
->field_class_map
) {
602 g_hash_table_destroy(maps
->field_class_map
);
605 if (maps
->clock_class_map
) {
606 g_hash_table_destroy(maps
->clock_class_map
);
609 g_free(maps
->fc_resolving_ctx
);
611 if (maps
->output_trace_class
) {
612 bt_trace_class_put_ref(maps
->output_trace_class
);
615 status
= bt_trace_class_remove_destruction_listener(
616 maps
->input_trace_class
, maps
->destruction_listener_id
);
617 if (status
!= BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_OK
) {
618 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, maps
->log_level
,
620 "Trace destruction listener removal failed.");
621 bt_current_thread_clear_error();
627 void trace_ir_maps_clear(struct trace_ir_maps
*maps
)
629 if (maps
->data_maps
) {
630 g_hash_table_remove_all(maps
->data_maps
);
633 if (maps
->metadata_maps
) {
634 g_hash_table_remove_all(maps
->metadata_maps
);
639 void trace_ir_maps_destroy(struct trace_ir_maps
*maps
)
645 g_free(maps
->debug_info_field_class_name
);
647 if (maps
->data_maps
) {
648 g_hash_table_destroy(maps
->data_maps
);
649 maps
->data_maps
= NULL
;
652 if (maps
->metadata_maps
) {
653 g_hash_table_destroy(maps
->metadata_maps
);
654 maps
->metadata_maps
= NULL
;
661 struct trace_ir_maps
*trace_ir_maps_create(bt_self_component
*self_comp
,
662 const char *debug_info_field_name
, bt_logging_level log_level
)
664 struct trace_ir_maps
*ir_maps
=
665 g_new0(struct trace_ir_maps
, 1);
667 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
668 "Error allocating trace_ir_maps");
672 ir_maps
->log_level
= log_level
;
673 ir_maps
->self_comp
= self_comp
;
675 /* Copy debug info field name received from the user. */
676 ir_maps
->debug_info_field_class_name
=
677 g_strdup(debug_info_field_name
);
678 if (!ir_maps
->debug_info_field_class_name
) {
679 BT_COMP_LOGE_STR("Cannot copy debug info field name");
683 ir_maps
->self_comp
= self_comp
;
685 ir_maps
->data_maps
= g_hash_table_new_full(g_direct_hash
,
686 g_direct_equal
, (GDestroyNotify
) NULL
,
687 (GDestroyNotify
) trace_ir_data_maps_destroy
);
689 ir_maps
->metadata_maps
= g_hash_table_new_full(g_direct_hash
,
690 g_direct_equal
, (GDestroyNotify
) NULL
,
691 (GDestroyNotify
) trace_ir_metadata_maps_destroy
);
695 trace_ir_maps_destroy(ir_maps
);