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 "logging/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
)
46 BT_COMP_LOGD("Copying content of trace class: in-tc-addr=%p, out-tc-addr=%p",
47 in_trace_class
, out_trace_class
);
50 * Safe to use the same value object because it's frozen at this
53 bt_trace_class_set_user_attributes(out_trace_class
,
54 bt_trace_class_borrow_user_attributes_const(in_trace_class
));
56 /* Use the same stream class ids as in the origin trace class. */
57 bt_trace_class_set_assigns_automatic_stream_class_id(out_trace_class
,
59 BT_COMP_LOGD("Copied content of trace class: in-tc-addr=%p, out-tc-addr=%p",
60 in_trace_class
, out_trace_class
);
65 int copy_clock_class_content(const bt_clock_class
*in_clock_class
,
66 bt_clock_class
*out_clock_class
, bt_logging_level log_level
,
67 bt_self_component
*self_comp
)
69 const char *clock_class_name
, *clock_class_description
;
75 BT_COMP_LOGD("Copying content of clock class: in-cc-addr=%p, out-cc-addr=%p",
76 in_clock_class
, out_clock_class
);
78 clock_class_name
= bt_clock_class_get_name(in_clock_class
);
80 if (clock_class_name
) {
81 if (bt_clock_class_set_name(out_clock_class
, clock_class_name
)
82 != BT_CLOCK_CLASS_SET_NAME_STATUS_OK
) {
83 BT_COMP_LOGE("Error setting clock class' name cc-addr=%p, name=%p",
84 out_clock_class
, clock_class_name
);
85 out_clock_class
= NULL
;
92 * Safe to use the same value object because it's frozen at this
95 bt_clock_class_set_user_attributes(out_clock_class
,
96 bt_clock_class_borrow_user_attributes_const(in_clock_class
));
98 clock_class_description
= bt_clock_class_get_description(in_clock_class
);
100 if (clock_class_description
) {
101 if (bt_clock_class_set_description(out_clock_class
,
102 clock_class_description
) !=
103 BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK
) {
104 BT_COMP_LOGE("Error setting clock class' description cc-addr=%p, "
105 "name=%p", out_clock_class
, clock_class_description
);
106 out_clock_class
= NULL
;
112 in_uuid
= bt_clock_class_get_uuid(in_clock_class
);
114 bt_clock_class_set_uuid(out_clock_class
, in_uuid
);
117 bt_clock_class_set_frequency(out_clock_class
,
118 bt_clock_class_get_frequency(in_clock_class
));
119 bt_clock_class_set_precision(out_clock_class
,
120 bt_clock_class_get_precision(in_clock_class
));
121 bt_clock_class_get_offset(in_clock_class
, &seconds
, &cycles
);
122 bt_clock_class_set_offset(out_clock_class
, seconds
, cycles
);
123 bt_clock_class_set_origin_is_unix_epoch(out_clock_class
,
124 bt_clock_class_origin_is_unix_epoch(in_clock_class
));
126 BT_COMP_LOGD("Copied content of clock class: in-cc-addr=%p, out-cc-addr=%p",
127 in_clock_class
, out_clock_class
);
134 bt_clock_class
*borrow_mapped_clock_class(
135 struct trace_ir_metadata_maps
*md_maps
,
136 const bt_clock_class
*in_clock_class
)
139 BT_ASSERT(in_clock_class
);
141 return g_hash_table_lookup(md_maps
->clock_class_map
,
142 (gpointer
) in_clock_class
);
146 bt_clock_class
*create_new_mapped_clock_class(bt_self_component
*self_comp
,
147 struct trace_ir_metadata_maps
*md_maps
,
148 const bt_clock_class
*in_clock_class
)
150 bt_clock_class
*out_clock_class
;
151 bt_logging_level log_level
= md_maps
->log_level
;
154 BT_COMP_LOGD("Creating new mapped clock class: in-cc-addr=%p",
158 BT_ASSERT(in_clock_class
);
160 BT_ASSERT(!borrow_mapped_clock_class(md_maps
, in_clock_class
));
162 out_clock_class
= bt_clock_class_create(self_comp
);
163 if (!out_clock_class
) {
164 BT_COMP_LOGE_STR("Cannot create clock class");
167 /* If not, create a new one and add it to the mapping. */
168 ret
= copy_clock_class_content(in_clock_class
, out_clock_class
,
169 log_level
, self_comp
);
171 BT_COMP_LOGE_STR("Cannot copy clock class");
175 g_hash_table_insert(md_maps
->clock_class_map
,
176 (gpointer
) in_clock_class
, out_clock_class
);
178 BT_COMP_LOGD("Created new mapped clock class: in-cc-addr=%p, out-cc-addr=%p",
179 in_clock_class
, out_clock_class
);
181 return out_clock_class
;
185 int copy_stream_class_content(struct trace_ir_maps
*ir_maps
,
186 const bt_stream_class
*in_stream_class
,
187 bt_stream_class
*out_stream_class
)
189 struct trace_ir_metadata_maps
*md_maps
;
190 const bt_clock_class
*in_clock_class
;
191 bt_clock_class
*out_clock_class
;
192 const bt_field_class
*in_packet_context_fc
, *in_common_context_fc
;
193 bt_field_class
*out_packet_context_fc
, *out_common_context_fc
;
195 bt_logging_level log_level
= ir_maps
->log_level
;
196 bt_self_component
*self_comp
= ir_maps
->self_comp
;
199 BT_COMP_LOGD("Copying content of stream class: in-sc-addr=%p, out-sc-addr=%p",
200 in_stream_class
, out_stream_class
);
202 md_maps
= borrow_metadata_maps_from_input_stream_class(ir_maps
, in_stream_class
);
203 in_clock_class
= bt_stream_class_borrow_default_clock_class_const(
206 if (in_clock_class
) {
207 /* Copy the clock class. */
208 out_clock_class
= borrow_mapped_clock_class(md_maps
,
210 if (!out_clock_class
) {
211 out_clock_class
= create_new_mapped_clock_class(
212 ir_maps
->self_comp
, md_maps
, in_clock_class
);
214 bt_stream_class_set_default_clock_class(out_stream_class
,
219 * Safe to use the same value object because it's frozen at this
222 bt_stream_class_set_user_attributes(out_stream_class
,
223 bt_stream_class_borrow_user_attributes_const(in_stream_class
));
225 bt_stream_class_set_supports_packets(
227 bt_stream_class_supports_packets(in_stream_class
),
228 bt_stream_class_packets_have_beginning_default_clock_snapshot(
230 bt_stream_class_packets_have_end_default_clock_snapshot(
232 bt_stream_class_set_supports_discarded_events(
234 bt_stream_class_supports_discarded_events(in_stream_class
),
235 bt_stream_class_discarded_events_have_default_clock_snapshots(
237 bt_stream_class_set_supports_discarded_packets(
239 bt_stream_class_supports_discarded_packets(in_stream_class
),
240 bt_stream_class_discarded_packets_have_default_clock_snapshots(
243 in_name
= bt_stream_class_get_name(in_stream_class
);
245 if (bt_stream_class_set_name(out_stream_class
, in_name
) !=
246 BT_STREAM_CLASS_SET_NAME_STATUS_OK
) {
247 BT_COMP_LOGE("Error set stream class name: out-sc-addr=%p, "
248 "name=%s", out_stream_class
, in_name
);
254 bt_stream_class_set_assigns_automatic_stream_id(out_stream_class
,
256 bt_stream_class_set_assigns_automatic_event_class_id(out_stream_class
,
260 * Add the input packet context field class to the context to
261 * resolution in the further steps.
263 in_packet_context_fc
=
264 bt_stream_class_borrow_packet_context_field_class_const(
266 md_maps
->fc_resolving_ctx
->packet_context
=
267 in_packet_context_fc
;
269 if (in_packet_context_fc
) {
270 /* Copy packet context. */
271 out_packet_context_fc
= create_field_class_copy(md_maps
,
272 in_packet_context_fc
);
274 ret
= copy_field_class_content(md_maps
, in_packet_context_fc
,
275 out_packet_context_fc
);
281 if (bt_stream_class_set_packet_context_field_class(
282 out_stream_class
, out_packet_context_fc
) !=
283 BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
284 BT_COMP_LOGE("Error setting stream class' packet context "
285 "field class: sc-addr=%p, packet-fc-addr=%p",
286 out_stream_class
, out_packet_context_fc
);
293 * Add the input common context field class to the context to
294 * resolution in the further steps.
296 in_common_context_fc
=
297 bt_stream_class_borrow_event_common_context_field_class_const(
299 md_maps
->fc_resolving_ctx
->event_common_context
= in_common_context_fc
;
301 if (in_common_context_fc
) {
302 /* Copy common context. */
303 /* TODO: I find it a bit awkward to have this special function
304 * here to add the debug-info field class. I would like to
306 out_common_context_fc
= create_field_class_copy(md_maps
,
307 in_common_context_fc
);
309 ret
= copy_event_common_context_field_class_content(md_maps
,
310 ir_maps
->debug_info_field_class_name
,
311 in_common_context_fc
, out_common_context_fc
);
316 if (bt_stream_class_set_event_common_context_field_class(
317 out_stream_class
, out_common_context_fc
) !=
318 BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
319 BT_COMP_LOGE("Error setting stream class' packet context "
320 "field class: sc-addr=%p, packet-fc-addr=%p",
321 out_stream_class
, out_common_context_fc
);
327 BT_COMP_LOGD("Copied content of stream class: in-sc-addr=%p, out-sc-addr=%p",
328 in_stream_class
, out_stream_class
);
334 int copy_event_class_content(struct trace_ir_maps
*ir_maps
,
335 const bt_event_class
*in_event_class
,
336 bt_event_class
*out_event_class
)
338 struct trace_ir_metadata_maps
*md_maps
;
339 const char *in_event_class_name
, *in_emf_uri
;
340 bt_property_availability prop_avail
;
341 bt_event_class_log_level ec_log_level
;
342 bt_field_class
*out_specific_context_fc
, *out_payload_fc
;
343 const bt_field_class
*in_event_specific_context
, *in_event_payload
;
345 bt_logging_level log_level
= ir_maps
->log_level
;
346 bt_self_component
*self_comp
= ir_maps
->self_comp
;
348 BT_COMP_LOGD("Copying content of event class: in-ec-addr=%p, out-ec-addr=%p",
349 in_event_class
, out_event_class
);
351 /* Copy event class name. */
352 in_event_class_name
= bt_event_class_get_name(in_event_class
);
353 if (in_event_class_name
) {
354 if (bt_event_class_set_name(out_event_class
,
355 in_event_class_name
) !=
356 BT_EVENT_CLASS_SET_NAME_STATUS_OK
) {
357 BT_COMP_LOGE("Error setting event class' name: ec-addr=%p, "
358 "name=%s", out_event_class
, in_event_class_name
);
365 * Safe to use the same value object because it's frozen at this
368 bt_event_class_set_user_attributes(out_event_class
,
369 bt_event_class_borrow_user_attributes_const(in_event_class
));
371 /* Copy event class loglevel. */
372 prop_avail
= bt_event_class_get_log_level(in_event_class
,
374 if (prop_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
375 bt_event_class_set_log_level(out_event_class
, ec_log_level
);
378 /* Copy event class emf uri. */
379 in_emf_uri
= bt_event_class_get_emf_uri(in_event_class
);
381 if (bt_event_class_set_emf_uri(out_event_class
, in_emf_uri
) !=
382 BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK
) {
383 BT_COMP_LOGE("Error setting event class' emf uri: ec-addr=%p, "
384 "emf uri=%s", out_event_class
, in_emf_uri
);
390 md_maps
= borrow_metadata_maps_from_input_event_class(ir_maps
,
393 * Add the input event class' specific ctx to te
396 in_event_specific_context
=
397 bt_event_class_borrow_specific_context_field_class_const(
400 md_maps
->fc_resolving_ctx
->event_specific_context
=
401 in_event_specific_context
;
403 if (in_event_specific_context
) {
404 /* Copy the specific context of this event class. */
405 out_specific_context_fc
= create_field_class_copy(md_maps
,
406 in_event_specific_context
);
408 ret
= copy_field_class_content(md_maps
,
409 in_event_specific_context
, out_specific_context_fc
);
414 * Add the output specific context to the output event
417 if (bt_event_class_set_specific_context_field_class(
418 out_event_class
, out_specific_context_fc
) !=
419 BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
420 BT_COMP_LOGE("Error setting event class' specific context "
421 "field class: ec-addr=%p, ctx-fc-addr=%p",
422 out_event_class
, out_specific_context_fc
);
429 * Add the input event class' payload field class to
432 in_event_payload
= bt_event_class_borrow_payload_field_class_const(
435 md_maps
->fc_resolving_ctx
->event_payload
= in_event_payload
;
437 if (in_event_payload
) {
438 /* Copy the payload of this event class. */
439 out_payload_fc
= create_field_class_copy(md_maps
,
441 ret
= copy_field_class_content(md_maps
, in_event_payload
,
447 /* Add the output payload to the output event class. */
448 if (bt_event_class_set_payload_field_class(out_event_class
,
449 out_payload_fc
) != BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK
) {
450 BT_COMP_LOGE("Error setting event class' payload "
451 "field class: ec-addr=%p, payload-fc-addr=%p",
452 out_event_class
, out_payload_fc
);
458 BT_COMP_LOGD("Copied content of event class: in-ec-addr=%p, out-ec-addr=%p",
459 in_event_class
, out_event_class
);
465 int copy_event_common_context_field_class_content(
466 struct trace_ir_metadata_maps
*md_maps
,
467 const char *debug_info_fc_name
,
468 const bt_field_class
*in_field_class
,
469 bt_field_class
*out_field_class
)
471 bt_field_class
*debug_field_class
= NULL
, *bin_field_class
= NULL
,
472 *func_field_class
= NULL
, *src_field_class
= NULL
;
473 bt_logging_level log_level
= md_maps
->log_level
;
474 bt_self_component
*self_comp
= md_maps
->self_comp
;
477 BT_COMP_LOGD("Copying content of event common context field class: "
478 "in-fc-addr=%p, out-fc-addr=%p", in_field_class
, out_field_class
);
480 /* Copy the content of the input common context. */
481 ret
= copy_field_class_content(md_maps
, in_field_class
, out_field_class
);
487 * If this event common context has the necessary fields to compute the
488 * debug information append the debug-info field class to the event
491 if (is_event_common_ctx_dbg_info_compatible(in_field_class
, debug_info_fc_name
)) {
493 * The struct field and 3 sub-fields are not stored in the
494 * field class map because they don't have input equivalent.
495 * We need to put our reference each of these field classes
496 * once they are added to their respective containing field
499 debug_field_class
= bt_field_class_structure_create(
500 md_maps
->output_trace_class
);
501 if (!debug_field_class
) {
502 BT_COMP_LOGE_STR("Failed to create debug_info structure.");
507 bin_field_class
= bt_field_class_string_create(
508 md_maps
->output_trace_class
);
509 if (!bin_field_class
) {
510 BT_COMP_LOGE_STR("Failed to create string for field=bin.");
515 func_field_class
= bt_field_class_string_create(
516 md_maps
->output_trace_class
);
517 if (!func_field_class
) {
518 BT_COMP_LOGE_STR("Failed to create string for field=func.");
523 src_field_class
= bt_field_class_string_create(
524 md_maps
->output_trace_class
);
525 if (!src_field_class
) {
526 BT_COMP_LOGE_STR("Failed to create string for field=src.");
531 if (bt_field_class_structure_append_member(debug_field_class
,
532 "bin", bin_field_class
) !=
533 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
534 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
535 "struct: field=bin.");
539 BT_FIELD_CLASS_PUT_REF_AND_RESET(bin_field_class
);
541 if (bt_field_class_structure_append_member(debug_field_class
,
542 "func", func_field_class
) !=
543 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
544 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
545 "struct: field=func.");
549 BT_FIELD_CLASS_PUT_REF_AND_RESET(func_field_class
);
551 if (bt_field_class_structure_append_member(debug_field_class
,
552 "src", src_field_class
) !=
553 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
554 BT_COMP_LOGE_STR("Failed to add a field to debug_info "
555 "struct: field=src.");
559 BT_FIELD_CLASS_PUT_REF_AND_RESET(src_field_class
);
561 /*Add the filled debug-info field class to the common context. */
562 if (bt_field_class_structure_append_member(out_field_class
,
563 debug_info_fc_name
, debug_field_class
) !=
564 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
) {
565 BT_COMP_LOGE_STR("Failed to add debug_info field to "
566 "event common context.");
570 BT_FIELD_CLASS_PUT_REF_AND_RESET(debug_field_class
);
572 BT_COMP_LOGD("Copied content of event common context field class: "
573 "in-fc-addr=%p, out-fc-addr=%p", in_field_class
, out_field_class
);
577 if (debug_field_class
) {
578 bt_field_class_put_ref(debug_field_class
);
580 if (bin_field_class
) {
581 bt_field_class_put_ref(bin_field_class
);
583 if (func_field_class
) {
584 bt_field_class_put_ref(func_field_class
);
586 if (src_field_class
) {
587 bt_field_class_put_ref(src_field_class
);
594 bt_field_class
*create_field_class_copy(struct trace_ir_metadata_maps
*md_maps
,
595 const bt_field_class
*in_field_class
)
597 return create_field_class_copy_internal(md_maps
, in_field_class
);
601 int copy_field_class_content(struct trace_ir_metadata_maps
*md_maps
,
602 const bt_field_class
*in_field_class
,
603 bt_field_class
*out_field_class
)
605 return copy_field_class_content_internal(md_maps
, in_field_class
,