2 * Babeltrace - Trace IR metadata object copy
4 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #define BT_COMP_LOG_SELF_COMP self_comp
28 #define BT_LOG_OUTPUT_LEVEL log_level
29 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO/TRACE-IR-META-COPY"
30 #include "plugins/comp-logging.h"
35 #include "common/assert.h"
37 #include "trace-ir-metadata-copy.h"
38 #include "trace-ir-metadata-field-class-copy.h"
42 int copy_trace_class_content(const bt_trace_class
*in_trace_class
,
43 bt_trace_class
*out_trace_class
, bt_logging_level log_level
,
44 bt_self_component
*self_comp
)
47 uint64_t i
, env_field_count
;
48 const char *in_trace_class_name
;
50 BT_COMP_LOGD("Copying content of trace class: in-tc-addr=%p, out-tc-addr=%p",
51 in_trace_class
, out_trace_class
);
53 /* Use the same stream class ids as in the origin trace class. */
54 bt_trace_class_set_assigns_automatic_stream_class_id(out_trace_class
,
57 in_trace_class_name
= bt_trace_class_get_name(in_trace_class
);
58 if (in_trace_class_name
) {
59 bt_trace_class_set_name_status status
;
61 status
= bt_trace_class_set_name(out_trace_class
,
63 if (status
!= BT_TRACE_CLASS_SET_NAME_STATUS_OK
) {
64 bt_current_thread_clear_error();
69 * Do not copy the trace class UUID as it may be modified and should no
70 * longer have the same UUID.
74 * Go over all the entries in the environment section of the trace class
75 * and copy the content to the new trace class.
77 env_field_count
= bt_trace_class_get_environment_entry_count(in_trace_class
);
78 for (i
= 0; i
< env_field_count
; i
++) {
79 const char *value_name
;
80 const bt_value
*value
= NULL
;
81 bt_trace_class_set_environment_entry_status set_env_status
;
83 bt_trace_class_borrow_environment_entry_by_index_const(
84 in_trace_class
, i
, &value_name
, &value
);
86 BT_COMP_LOGD("Copying trace class environnement entry: "
87 "index=%" PRId64
", value-addr=%p, value-name=%s",
88 i
, value
, value_name
);
90 BT_ASSERT(value_name
);
93 if (bt_value_is_signed_integer(value
)) {
95 bt_trace_class_set_environment_entry_integer(
96 out_trace_class
, value_name
,
97 bt_value_signed_integer_get(
99 } else if (bt_value_is_string(value
)) {
101 bt_trace_class_set_environment_entry_string(
102 out_trace_class
, value_name
,
103 bt_value_string_get(value
));
108 if (set_env_status
!=
109 BT_TRACE_CLASS_SET_ENVIRONMENT_ENTRY_STATUS_OK
) {
115 BT_COMP_LOGD("Copied content of trace class: in-tc-addr=%p, out-tc-addr=%p",
116 in_trace_class
, out_trace_class
);
122 int copy_clock_class_content(const bt_clock_class
*in_clock_class
,
123 bt_clock_class
*out_clock_class
, bt_logging_level log_level
,
124 bt_self_component
*self_comp
)
126 const char *clock_class_name
, *clock_class_description
;
132 BT_COMP_LOGD("Copying content of clock class: in-cc-addr=%p, out-cc-addr=%p",
133 in_clock_class
, out_clock_class
);
135 clock_class_name
= bt_clock_class_get_name(in_clock_class
);
137 if (clock_class_name
) {
138 if (bt_clock_class_set_name(out_clock_class
, clock_class_name
)
139 != BT_CLOCK_CLASS_SET_NAME_STATUS_OK
) {
140 BT_COMP_LOGE("Error setting clock class' name cc-addr=%p, name=%p",
141 out_clock_class
, clock_class_name
);
142 out_clock_class
= NULL
;
148 clock_class_description
= bt_clock_class_get_description(in_clock_class
);
150 if (clock_class_description
) {
151 if (bt_clock_class_set_description(out_clock_class
,
152 clock_class_description
) !=
153 BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK
) {
154 BT_COMP_LOGE("Error setting clock class' description cc-addr=%p, "
155 "name=%p", out_clock_class
, clock_class_description
);
156 out_clock_class
= NULL
;
162 in_uuid
= bt_clock_class_get_uuid(in_clock_class
);
164 bt_clock_class_set_uuid(out_clock_class
, in_uuid
);
167 bt_clock_class_set_frequency(out_clock_class
,
168 bt_clock_class_get_frequency(in_clock_class
));
169 bt_clock_class_set_precision(out_clock_class
,
170 bt_clock_class_get_precision(in_clock_class
));
171 bt_clock_class_get_offset(in_clock_class
, &seconds
, &cycles
);
172 bt_clock_class_set_offset(out_clock_class
, seconds
, cycles
);
173 bt_clock_class_set_origin_is_unix_epoch(out_clock_class
,
174 bt_clock_class_origin_is_unix_epoch(in_clock_class
));
176 BT_COMP_LOGD("Copied content of clock class: in-cc-addr=%p, out-cc-addr=%p",
177 in_clock_class
, out_clock_class
);
184 bt_clock_class
*borrow_mapped_clock_class(
185 struct trace_ir_metadata_maps
*md_maps
,
186 const bt_clock_class
*in_clock_class
)
189 BT_ASSERT(in_clock_class
);
191 return g_hash_table_lookup(md_maps
->clock_class_map
,
192 (gpointer
) in_clock_class
);
196 bt_clock_class
*create_new_mapped_clock_class(
197 bt_self_component
*self_comp
,
198 struct trace_ir_metadata_maps
*md_maps
,
199 const bt_clock_class
*in_clock_class
)
201 bt_clock_class
*out_clock_class
;
203 bt_logging_level log_level
= md_maps
->log_level
;
205 BT_COMP_LOGD("Creating new mapped clock class: in-cc-addr=%p",
209 BT_ASSERT(in_clock_class
);
211 BT_ASSERT(!borrow_mapped_clock_class(md_maps
, in_clock_class
));
213 out_clock_class
= bt_clock_class_create(self_comp
);
214 if (!out_clock_class
) {
215 BT_COMP_LOGE_STR("Cannot create clock class");
218 /* If not, create a new one and add it to the mapping. */
219 ret
= copy_clock_class_content(in_clock_class
, out_clock_class
,
220 log_level
, self_comp
);
222 BT_COMP_LOGE_STR("Cannot copy clock class");
226 g_hash_table_insert(md_maps
->clock_class_map
,
227 (gpointer
) in_clock_class
, out_clock_class
);
229 BT_COMP_LOGD("Created new mapped clock class: in-cc-addr=%p, out-cc-addr=%p",
230 in_clock_class
, out_clock_class
);
232 return out_clock_class
;
236 int copy_stream_class_content(struct trace_ir_maps
*ir_maps
,
237 const bt_stream_class
*in_stream_class
,
238 bt_stream_class
*out_stream_class
)
240 struct trace_ir_metadata_maps
*md_maps
;
241 const bt_clock_class
*in_clock_class
;
242 bt_clock_class
*out_clock_class
;
243 const bt_field_class
*in_packet_context_fc
, *in_common_context_fc
;
244 bt_field_class
*out_packet_context_fc
, *out_common_context_fc
;
247 bt_logging_level log_level
= ir_maps
->log_level
;
248 bt_self_component
*self_comp
= ir_maps
->self_comp
;
250 BT_COMP_LOGD("Copying content of stream class: in-sc-addr=%p, out-sc-addr=%p",
251 in_stream_class
, out_stream_class
);
253 md_maps
= borrow_metadata_maps_from_input_stream_class(ir_maps
, in_stream_class
);
254 in_clock_class
= bt_stream_class_borrow_default_clock_class_const(
257 if (in_clock_class
) {
258 /* Copy the clock class. */
260 borrow_mapped_clock_class(md_maps
, in_clock_class
);
261 if (!out_clock_class
) {
262 out_clock_class
= create_new_mapped_clock_class(
263 ir_maps
->self_comp
, md_maps
,
266 bt_stream_class_set_default_clock_class(out_stream_class
,
271 bt_stream_class_set_packets_have_beginning_default_clock_snapshot(
273 bt_stream_class_packets_have_beginning_default_clock_snapshot(
275 bt_stream_class_set_packets_have_end_default_clock_snapshot(
277 bt_stream_class_packets_have_end_default_clock_snapshot(
279 bt_stream_class_set_supports_discarded_events(
281 bt_stream_class_supports_discarded_events(in_stream_class
),
282 bt_stream_class_discarded_events_have_default_clock_snapshots(
284 bt_stream_class_set_supports_discarded_packets(
286 bt_stream_class_supports_discarded_packets(in_stream_class
),
287 bt_stream_class_discarded_packets_have_default_clock_snapshots(
290 in_name
= bt_stream_class_get_name(in_stream_class
);
292 if (bt_stream_class_set_name(out_stream_class
, in_name
) !=
293 BT_STREAM_CLASS_SET_NAME_STATUS_OK
) {
294 BT_COMP_LOGE("Error set stream class name: out-sc-addr=%p, "
295 "name=%s", out_stream_class
, in_name
);
301 bt_stream_class_set_assigns_automatic_stream_id(out_stream_class
,
303 bt_stream_class_set_assigns_automatic_event_class_id(out_stream_class
,
307 * Add the input packet context field class to the context to
308 * resolution in the further steps.
310 in_packet_context_fc
=
311 bt_stream_class_borrow_packet_context_field_class_const(
313 md_maps
->fc_resolving_ctx
->packet_context
=
314 in_packet_context_fc
;
316 if (in_packet_context_fc
) {
317 /* Copy packet context. */
318 out_packet_context_fc
= create_field_class_copy(
319 md_maps
, in_packet_context_fc
);
321 ret
= copy_field_class_content(md_maps
,
322 in_packet_context_fc
, out_packet_context_fc
);
328 if (bt_stream_class_set_packet_context_field_class(
329 out_stream_class
, out_packet_context_fc
) !=
330 BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
331 BT_COMP_LOGE("Error setting stream class' packet context "
332 "field class: sc-addr=%p, packet-fc-addr=%p",
333 out_stream_class
, out_packet_context_fc
);
340 * Add the input common context field class to the context to
341 * resolution in the further steps.
343 in_common_context_fc
=
344 bt_stream_class_borrow_event_common_context_field_class_const(
346 md_maps
->fc_resolving_ctx
->event_common_context
=
347 in_common_context_fc
;
349 if (in_common_context_fc
) {
350 /* Copy common context. */
351 /* TODO: I find it a bit awkward to have this special function
352 * here to add the debug-info field class. I would like to
354 out_common_context_fc
= create_field_class_copy(
355 md_maps
, in_common_context_fc
);
357 ret
= copy_event_common_context_field_class_content(
358 md_maps
, ir_maps
->debug_info_field_class_name
,
359 in_common_context_fc
, out_common_context_fc
);
364 if (bt_stream_class_set_event_common_context_field_class(
365 out_stream_class
, out_common_context_fc
) !=
366 BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
367 BT_COMP_LOGE("Error setting stream class' packet context "
368 "field class: sc-addr=%p, packet-fc-addr=%p",
369 out_stream_class
, out_common_context_fc
);
375 /* Set packet snapshot boolean fields. */
376 BT_COMP_LOGD("Copied content of stream class: in-sc-addr=%p, out-sc-addr=%p",
377 in_stream_class
, out_stream_class
);
383 int copy_event_class_content(struct trace_ir_maps
*ir_maps
,
384 const bt_event_class
*in_event_class
,
385 bt_event_class
*out_event_class
)
387 struct trace_ir_metadata_maps
*md_maps
;
388 const char *in_event_class_name
, *in_emf_uri
;
389 bt_property_availability prop_avail
;
390 bt_event_class_log_level ec_log_level
;
391 bt_field_class
*out_specific_context_fc
, *out_payload_fc
;
392 const bt_field_class
*in_event_specific_context
, *in_event_payload
;
394 bt_logging_level log_level
= ir_maps
->log_level
;
395 bt_self_component
*self_comp
= ir_maps
->self_comp
;
397 BT_COMP_LOGD("Copying content of event class: in-ec-addr=%p, out-ec-addr=%p",
398 in_event_class
, out_event_class
);
400 /* Copy event class name. */
401 in_event_class_name
= bt_event_class_get_name(in_event_class
);
402 if (in_event_class_name
) {
403 if (bt_event_class_set_name(out_event_class
,
404 in_event_class_name
) !=
405 BT_EVENT_CLASS_SET_NAME_STATUS_OK
) {
406 BT_COMP_LOGE("Error setting event class' name: ec-addr=%p, "
407 "name=%s", out_event_class
, in_event_class_name
);
413 /* Copy event class loglevel. */
414 prop_avail
= bt_event_class_get_log_level(in_event_class
,
416 if (prop_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
417 bt_event_class_set_log_level(out_event_class
,
421 /* Copy event class emf uri. */
422 in_emf_uri
= bt_event_class_get_emf_uri(in_event_class
);
424 if (bt_event_class_set_emf_uri(out_event_class
, in_emf_uri
) !=
425 BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK
) {
426 BT_COMP_LOGE("Error setting event class' emf uri: ec-addr=%p, "
427 "emf uri=%s", out_event_class
, in_emf_uri
);
433 md_maps
= borrow_metadata_maps_from_input_event_class(ir_maps
, in_event_class
);
435 * Add the input event class' specific ctx to te
438 in_event_specific_context
=
439 bt_event_class_borrow_specific_context_field_class_const(
442 md_maps
->fc_resolving_ctx
->event_specific_context
=
443 in_event_specific_context
;
445 if (in_event_specific_context
) {
446 /* Copy the specific context of this event class. */
447 out_specific_context_fc
= create_field_class_copy(md_maps
,
448 in_event_specific_context
);
450 ret
= copy_field_class_content(md_maps
,
451 in_event_specific_context
, out_specific_context_fc
);
456 * Add the output specific context to the output event
459 if (bt_event_class_set_specific_context_field_class(
460 out_event_class
, out_specific_context_fc
) !=
461 BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
462 BT_COMP_LOGE("Error setting event class' specific context "
463 "field class: ec-addr=%p, ctx-fc-addr=%p",
464 out_event_class
, out_specific_context_fc
);
471 * Add the input event class' payload field class to
474 in_event_payload
= bt_event_class_borrow_payload_field_class_const(
477 md_maps
->fc_resolving_ctx
->event_payload
= in_event_payload
;
479 if (in_event_payload
) {
480 /* Copy the payload of this event class. */
481 out_payload_fc
= create_field_class_copy(md_maps
,
483 ret
= copy_field_class_content(md_maps
,
484 in_event_payload
, out_payload_fc
);
489 /* Add the output payload to the output event class. */
490 if (bt_event_class_set_payload_field_class(
491 out_event_class
, out_payload_fc
) !=
492 BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
493 BT_COMP_LOGE("Error setting event class' payload "
494 "field class: ec-addr=%p, payload-fc-addr=%p",
495 out_event_class
, out_payload_fc
);
501 BT_COMP_LOGD("Copied content of event class: in-ec-addr=%p, out-ec-addr=%p",
502 in_event_class
, out_event_class
);
508 int copy_event_common_context_field_class_content(
509 struct trace_ir_metadata_maps
*md_maps
,
510 const char *debug_info_fc_name
,
511 const bt_field_class
*in_field_class
,
512 bt_field_class
*out_field_class
)
514 bt_field_class
*debug_field_class
= NULL
, *bin_field_class
= NULL
,
515 *func_field_class
= NULL
, *src_field_class
= NULL
;
517 bt_logging_level log_level
= md_maps
->log_level
;
518 bt_self_component
*self_comp
= md_maps
->self_comp
;
520 BT_COMP_LOGD("Copying content of event common context field class: "
521 "in-fc-addr=%p, out-fc-addr=%p", in_field_class
, out_field_class
);
523 /* Copy the content of the input common context. */
524 ret
= copy_field_class_content(md_maps
, in_field_class
, out_field_class
);
530 * If this event common context has the necessary fields to compute the
531 * debug information append the debug-info field class to the event
534 if (is_event_common_ctx_dbg_info_compatible(in_field_class
, debug_info_fc_name
)) {
536 * The struct field and 3 sub-fields are not stored in the
537 * field class map because they don't have input equivalent.
538 * We need to put our reference each of these field classes
539 * once they are added to their respective containing field
542 debug_field_class
= bt_field_class_structure_create(
543 md_maps
->output_trace_class
);
544 if (!debug_field_class
) {
545 BT_COMP_LOGE_STR("Failed to create debug_info structure.");
550 bin_field_class
= bt_field_class_string_create(
551 md_maps
->output_trace_class
);
552 if (!bin_field_class
) {
553 BT_COMP_LOGE_STR("Failed to create string for field=bin.");
558 func_field_class
= bt_field_class_string_create(
559 md_maps
->output_trace_class
);
560 if (!func_field_class
) {
561 BT_COMP_LOGE_STR("Failed to create string for field=func.");
566 src_field_class
= bt_field_class_string_create(
567 md_maps
->output_trace_class
);
568 if (!src_field_class
) {
569 BT_COMP_LOGE_STR("Failed to create string for field=src.");
574 if (bt_field_class_structure_append_member(
575 debug_field_class
, "bin", bin_field_class
) !=
576 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
577 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
578 "struct: field=bin.");
582 BT_FIELD_CLASS_PUT_REF_AND_RESET(bin_field_class
);
584 if (bt_field_class_structure_append_member(
585 debug_field_class
, "func", func_field_class
) !=
586 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
587 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
588 "struct: field=func.");
592 BT_FIELD_CLASS_PUT_REF_AND_RESET(func_field_class
);
594 if (bt_field_class_structure_append_member(
595 debug_field_class
, "src", src_field_class
) !=
596 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
597 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
598 "struct: field=src.");
602 BT_FIELD_CLASS_PUT_REF_AND_RESET(src_field_class
);
604 /*Add the filled debug-info field class to the common context. */
605 if (bt_field_class_structure_append_member(out_field_class
,
606 debug_info_fc_name
, debug_field_class
) !=
607 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
608 BT_COMP_LOGE_STR("Failed to add debug_info field to "
609 "event common context.");
613 BT_FIELD_CLASS_PUT_REF_AND_RESET(debug_field_class
);
615 BT_COMP_LOGD("Copied content of event common context field class: "
616 "in-fc-addr=%p, out-fc-addr=%p", in_field_class
, out_field_class
);
620 if (debug_field_class
) {
621 bt_field_class_put_ref(debug_field_class
);
623 if (bin_field_class
) {
624 bt_field_class_put_ref(bin_field_class
);
626 if (func_field_class
) {
627 bt_field_class_put_ref(func_field_class
);
629 if (src_field_class
) {
630 bt_field_class_put_ref(src_field_class
);
637 bt_field_class
*create_field_class_copy(struct trace_ir_metadata_maps
*md_maps
,
638 const bt_field_class
*in_field_class
)
640 return create_field_class_copy_internal(md_maps
, in_field_class
);
644 int copy_field_class_content(struct trace_ir_metadata_maps
*md_maps
,
645 const bt_field_class
*in_field_class
,
646 bt_field_class
*out_field_class
)
648 return copy_field_class_content_internal(md_maps
, in_field_class
,