2 * Copyright 2018 - Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
15 #define BT_LOG_TAG "PLUGIN-CTF-METADATA-META-TRANSLATE"
18 #include <babeltrace/babeltrace.h>
19 #include <babeltrace/babeltrace-internal.h>
20 #include <babeltrace/assert-internal.h>
26 #include "ctf-meta-visitors.h"
29 struct bt_private_field_class
*ctf_field_class_to_ir(struct ctf_field_class
*fc
,
30 struct ctf_trace_class
*tc
,
31 struct ctf_stream_class
*sc
,
32 struct ctf_event_class
*ec
);
35 void ctf_field_class_int_set_props(struct ctf_field_class_int
*fc
,
36 struct bt_private_field_class
*ir_fc
)
38 bt_private_field_class_integer_set_field_value_range(ir_fc
,
40 bt_private_field_class_integer_set_preferred_display_base(ir_fc
,
45 struct bt_private_field_class
*ctf_field_class_int_to_ir(
46 struct ctf_field_class_int
*fc
)
48 struct bt_private_field_class
*ir_fc
;
51 ir_fc
= bt_private_field_class_signed_integer_create();
53 ir_fc
= bt_private_field_class_unsigned_integer_create();
57 ctf_field_class_int_set_props(fc
, ir_fc
);
62 struct bt_private_field_class
*ctf_field_class_enum_to_ir(
63 struct ctf_field_class_enum
*fc
)
66 struct bt_private_field_class
*ir_fc
;
69 if (fc
->base
.is_signed
) {
70 ir_fc
= bt_private_field_class_signed_enumeration_create();
72 ir_fc
= bt_private_field_class_unsigned_enumeration_create();
76 ctf_field_class_int_set_props((void *) fc
, ir_fc
);
78 for (i
= 0; i
< fc
->mappings
->len
; i
++) {
79 struct ctf_field_class_enum_mapping
*mapping
=
80 ctf_field_class_enum_borrow_mapping_by_index(fc
, i
);
82 if (fc
->base
.is_signed
) {
83 ret
= bt_private_field_class_signed_enumeration_map_range(
84 ir_fc
, mapping
->label
->str
,
85 mapping
->range
.lower
.i
, mapping
->range
.upper
.i
);
87 ret
= bt_private_field_class_unsigned_enumeration_map_range(
88 ir_fc
, mapping
->label
->str
,
89 mapping
->range
.lower
.u
, mapping
->range
.upper
.u
);
99 struct bt_private_field_class
*ctf_field_class_float_to_ir(
100 struct ctf_field_class_float
*fc
)
102 struct bt_private_field_class
*ir_fc
;
104 ir_fc
= bt_private_field_class_real_create();
107 if (fc
->base
.size
== 32) {
108 bt_private_field_class_real_set_is_single_precision(ir_fc
,
116 struct bt_private_field_class
*ctf_field_class_string_to_ir(
117 struct ctf_field_class_string
*fc
)
119 struct bt_private_field_class
*ir_fc
=
120 bt_private_field_class_string_create();
127 struct bt_private_field_class
*ctf_field_class_struct_to_ir(
128 struct ctf_field_class_struct
*fc
,
129 struct ctf_trace_class
*tc
,
130 struct ctf_stream_class
*sc
,
131 struct ctf_event_class
*ec
)
134 struct bt_private_field_class
*ir_fc
=
135 bt_private_field_class_structure_create();
140 for (i
= 0; i
< fc
->members
->len
; i
++) {
141 struct ctf_named_field_class
*named_fc
=
142 ctf_field_class_struct_borrow_member_by_index(fc
, i
);
143 struct bt_private_field_class
*member_ir_fc
;
145 if (!named_fc
->fc
->in_ir
) {
149 member_ir_fc
= ctf_field_class_to_ir(named_fc
->fc
, tc
, sc
, ec
);
150 BT_ASSERT(member_ir_fc
);
151 ret
= bt_private_field_class_structure_append_member(
152 ir_fc
, named_fc
->name
->str
, member_ir_fc
);
154 bt_object_put_ref(member_ir_fc
);
161 struct bt_private_field_class
*borrow_ir_ft_from_field_path(
162 struct ctf_field_path
*field_path
,
163 struct ctf_trace_class
*tc
,
164 struct ctf_stream_class
*sc
,
165 struct ctf_event_class
*ec
)
167 struct bt_private_field_class
*ir_fc
= NULL
;
168 struct ctf_field_class
*fc
= ctf_field_path_borrow_field_class(
169 field_path
, tc
, sc
, ec
);
181 struct bt_private_field_class
*ctf_field_class_variant_to_ir(
182 struct ctf_field_class_variant
*fc
,
183 struct ctf_trace_class
*tc
,
184 struct ctf_stream_class
*sc
,
185 struct ctf_event_class
*ec
)
188 struct bt_private_field_class
*ir_fc
=
189 bt_private_field_class_variant_create();
193 ret
= bt_private_field_class_variant_set_selector_field_class(
194 ir_fc
, borrow_ir_ft_from_field_path(&fc
->tag_path
, tc
, sc
, ec
));
197 for (i
= 0; i
< fc
->options
->len
; i
++) {
198 struct ctf_named_field_class
*named_fc
=
199 ctf_field_class_variant_borrow_option_by_index(fc
, i
);
200 struct bt_private_field_class
*option_ir_fc
;
202 BT_ASSERT(named_fc
->fc
->in_ir
);
203 option_ir_fc
= ctf_field_class_to_ir(named_fc
->fc
, tc
, sc
, ec
);
204 BT_ASSERT(option_ir_fc
);
205 ret
= bt_private_field_class_variant_append_private_option(
206 ir_fc
, named_fc
->name
->str
, option_ir_fc
);
208 bt_object_put_ref(option_ir_fc
);
215 struct bt_private_field_class
*ctf_field_class_array_to_ir(
216 struct ctf_field_class_array
*fc
,
217 struct ctf_trace_class
*tc
,
218 struct ctf_stream_class
*sc
,
219 struct ctf_event_class
*ec
)
221 struct bt_private_field_class
*ir_fc
;
222 struct bt_private_field_class
*elem_ir_fc
;
224 if (fc
->base
.is_text
) {
225 ir_fc
= bt_private_field_class_string_create();
230 elem_ir_fc
= ctf_field_class_to_ir(fc
->base
.elem_fc
, tc
, sc
, ec
);
231 BT_ASSERT(elem_ir_fc
);
232 ir_fc
= bt_private_field_class_static_array_create(elem_ir_fc
,
235 bt_object_put_ref(elem_ir_fc
);
242 struct bt_private_field_class
*ctf_field_class_sequence_to_ir(
243 struct ctf_field_class_sequence
*fc
,
244 struct ctf_trace_class
*tc
,
245 struct ctf_stream_class
*sc
,
246 struct ctf_event_class
*ec
)
249 struct bt_private_field_class
*ir_fc
;
250 struct bt_private_field_class
*elem_ir_fc
;
252 if (fc
->base
.is_text
) {
253 ir_fc
= bt_private_field_class_string_create();
258 elem_ir_fc
= ctf_field_class_to_ir(fc
->base
.elem_fc
, tc
, sc
, ec
);
259 BT_ASSERT(elem_ir_fc
);
260 ir_fc
= bt_private_field_class_dynamic_array_create(elem_ir_fc
);
262 bt_object_put_ref(elem_ir_fc
);
264 ret
= bt_private_field_class_dynamic_array_set_length_field_class(
266 borrow_ir_ft_from_field_path(&fc
->length_path
, tc
, sc
, ec
));
274 struct bt_private_field_class
*ctf_field_class_to_ir(struct ctf_field_class
*fc
,
275 struct ctf_trace_class
*tc
,
276 struct ctf_stream_class
*sc
,
277 struct ctf_event_class
*ec
)
279 struct bt_private_field_class
*ir_fc
= NULL
;
282 BT_ASSERT(fc
->in_ir
);
285 case CTF_FIELD_CLASS_TYPE_INT
:
286 ir_fc
= ctf_field_class_int_to_ir((void *) fc
);
288 case CTF_FIELD_CLASS_TYPE_ENUM
:
289 ir_fc
= ctf_field_class_enum_to_ir((void *) fc
);
291 case CTF_FIELD_CLASS_TYPE_FLOAT
:
292 ir_fc
= ctf_field_class_float_to_ir((void *) fc
);
294 case CTF_FIELD_CLASS_TYPE_STRING
:
295 ir_fc
= ctf_field_class_string_to_ir((void *) fc
);
297 case CTF_FIELD_CLASS_TYPE_STRUCT
:
298 ir_fc
= ctf_field_class_struct_to_ir((void *) fc
, tc
, sc
, ec
);
300 case CTF_FIELD_CLASS_TYPE_ARRAY
:
301 ir_fc
= ctf_field_class_array_to_ir((void *) fc
, tc
, sc
, ec
);
303 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
304 ir_fc
= ctf_field_class_sequence_to_ir((void *) fc
, tc
, sc
, ec
);
306 case CTF_FIELD_CLASS_TYPE_VARIANT
:
307 ir_fc
= ctf_field_class_variant_to_ir((void *) fc
, tc
, sc
, ec
);
318 bool ctf_field_class_struct_has_immediate_member_in_ir(
319 struct ctf_field_class_struct
*fc
)
322 bool has_immediate_member_in_ir
= false;
324 for (i
= 0; i
< fc
->members
->len
; i
++) {
325 struct ctf_named_field_class
*named_fc
=
326 ctf_field_class_struct_borrow_member_by_index(fc
, i
);
328 if (named_fc
->fc
->in_ir
) {
329 has_immediate_member_in_ir
= true;
335 return has_immediate_member_in_ir
;
339 struct bt_private_field_class
*scope_ctf_field_class_to_ir(struct ctf_field_class
*fc
,
340 struct ctf_trace_class
*tc
,
341 struct ctf_stream_class
*sc
,
342 struct ctf_event_class
*ec
)
344 struct bt_private_field_class
*ir_fc
= NULL
;
350 BT_ASSERT(fc
->type
== CTF_FIELD_CLASS_TYPE_STRUCT
);
352 if (!ctf_field_class_struct_has_immediate_member_in_ir((void *) fc
)) {
354 * Nothing for IR in this scope: typical for packet
355 * header, packet context, and event header.
360 ir_fc
= ctf_field_class_to_ir(fc
, tc
, sc
, ec
);
367 struct ctf_field_class_int
*borrow_named_int_field_class(
368 struct ctf_field_class_struct
*struct_fc
, const char *name
)
370 struct ctf_named_field_class
*named_fc
= NULL
;
371 struct ctf_field_class_int
*int_fc
= NULL
;
377 named_fc
= ctf_field_class_struct_borrow_member_by_name(struct_fc
, name
);
382 if (named_fc
->fc
->type
!= CTF_FIELD_CLASS_TYPE_INT
&&
383 named_fc
->fc
->type
!= CTF_FIELD_CLASS_TYPE_ENUM
) {
387 int_fc
= (void *) named_fc
->fc
;
394 struct bt_private_event_class
*ctf_event_class_to_ir(struct ctf_event_class
*ec
,
395 struct bt_private_stream_class
*ir_sc
, struct ctf_trace_class
*tc
,
396 struct ctf_stream_class
*sc
)
399 struct bt_private_event_class
*ir_ec
= NULL
;
401 if (ec
->is_translated
) {
402 ir_ec
= bt_private_stream_class_borrow_event_class_by_id(
408 ir_ec
= bt_private_event_class_create_with_id(ir_sc
, ec
->id
);
410 bt_object_put_ref(ir_ec
);
412 if (ec
->spec_context_fc
) {
413 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
414 ec
->spec_context_fc
, tc
, sc
, ec
);
417 ret
= bt_private_event_class_set_specific_context_field_class(
420 bt_object_put_ref(ir_fc
);
424 if (ec
->payload_fc
) {
425 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
426 ec
->payload_fc
, tc
, sc
, ec
);
429 ret
= bt_private_event_class_set_payload_field_class(ir_ec
,
432 bt_object_put_ref(ir_fc
);
436 if (ec
->name
->len
> 0) {
437 ret
= bt_private_event_class_set_name(ir_ec
, ec
->name
->str
);
441 if (ec
->emf_uri
->len
> 0) {
442 ret
= bt_private_event_class_set_emf_uri(ir_ec
, ec
->emf_uri
->str
);
446 if (ec
->log_level
!= -1) {
447 bt_private_event_class_set_log_level(ir_ec
, ec
->log_level
);
450 ec
->is_translated
= true;
459 struct bt_private_stream_class
*ctf_stream_class_to_ir(struct ctf_stream_class
*sc
,
460 struct bt_private_trace
*ir_trace
, struct ctf_trace_class
*tc
)
463 struct bt_private_stream_class
*ir_sc
= NULL
;
464 struct ctf_field_class_int
*int_fc
;
466 if (sc
->is_translated
) {
467 ir_sc
= bt_private_trace_borrow_stream_class_by_id(
473 ir_sc
= bt_private_stream_class_create_with_id(ir_trace
, sc
->id
);
475 bt_object_put_ref(ir_sc
);
477 if (sc
->packet_context_fc
) {
478 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
479 sc
->packet_context_fc
, tc
, sc
, NULL
);
482 ret
= bt_private_stream_class_set_packet_context_field_class(
485 bt_object_put_ref(ir_fc
);
489 if (sc
->event_header_fc
) {
490 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
491 sc
->event_header_fc
, tc
, sc
, NULL
);
494 ret
= bt_private_stream_class_set_event_header_field_class(
497 bt_object_put_ref(ir_fc
);
501 if (sc
->event_common_context_fc
) {
502 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
503 sc
->event_common_context_fc
, tc
, sc
, NULL
);
506 ret
= bt_private_stream_class_set_event_common_context_field_class(
509 bt_object_put_ref(ir_fc
);
513 bt_private_stream_class_set_assigns_automatic_event_class_id(ir_sc
,
515 bt_private_stream_class_set_assigns_automatic_stream_id(ir_sc
, BT_FALSE
);
517 if (sc
->default_clock_class
) {
518 ret
= bt_private_stream_class_set_default_clock_class(ir_sc
,
519 bt_private_clock_class_as_clock_class(sc
->default_clock_class
));
523 int_fc
= borrow_named_int_field_class((void *) sc
->packet_context_fc
,
526 if (int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
) {
527 bt_private_stream_class_set_packets_have_discarded_event_counter_snapshot(
532 int_fc
= borrow_named_int_field_class((void *) sc
->packet_context_fc
,
535 if (int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
) {
536 bt_private_stream_class_set_packets_have_packet_counter_snapshot(
541 int_fc
= borrow_named_int_field_class((void *) sc
->packet_context_fc
,
544 if (int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
) {
545 bt_private_stream_class_set_packets_have_default_beginning_clock_value(
550 int_fc
= borrow_named_int_field_class((void *) sc
->packet_context_fc
,
553 if (int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
) {
554 bt_private_stream_class_set_packets_have_default_end_clock_value(
559 sc
->is_translated
= true;
567 int ctf_trace_class_to_ir(struct bt_private_trace
*ir_trace
,
568 struct ctf_trace_class
*tc
)
573 if (tc
->is_translated
) {
577 if (tc
->packet_header_fc
) {
578 struct bt_private_field_class
*ir_fc
= scope_ctf_field_class_to_ir(
579 tc
->packet_header_fc
, tc
, NULL
, NULL
);
582 ret
= bt_private_trace_set_packet_header_field_class(
585 bt_object_put_ref(ir_fc
);
589 if (tc
->name
->len
> 0) {
590 ret
= bt_private_trace_set_name(ir_trace
, tc
->name
->str
);
596 if (tc
->is_uuid_set
) {
597 bt_private_trace_set_uuid(ir_trace
, tc
->uuid
);
600 for (i
= 0; i
< tc
->env_entries
->len
; i
++) {
601 struct ctf_trace_class_env_entry
*env_entry
=
602 ctf_trace_class_borrow_env_entry_by_index(tc
, i
);
604 switch (env_entry
->type
) {
605 case CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
:
606 ret
= bt_private_trace_set_environment_entry_integer(
607 ir_trace
, env_entry
->name
->str
,
610 case CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
:
611 ret
= bt_private_trace_set_environment_entry_string(
612 ir_trace
, env_entry
->name
->str
,
613 env_entry
->value
.str
->str
);
624 bt_private_trace_set_assigns_automatic_stream_class_id(ir_trace
,
626 tc
->is_translated
= true;
627 tc
->ir_tc
= ir_trace
;
634 int ctf_trace_class_translate(struct bt_private_trace
*ir_trace
,
635 struct ctf_trace_class
*tc
)
640 ret
= ctf_trace_class_to_ir(ir_trace
, tc
);
645 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
647 struct ctf_stream_class
*sc
= tc
->stream_classes
->pdata
[i
];
648 struct bt_private_stream_class
*ir_sc
;
650 ir_sc
= ctf_stream_class_to_ir(sc
, ir_trace
, tc
);
656 for (j
= 0; j
< sc
->event_classes
->len
; j
++) {
657 struct ctf_event_class
*ec
= sc
->event_classes
->pdata
[j
];
658 struct bt_private_event_class
*ir_ec
;
660 ir_ec
= ctf_event_class_to_ir(ec
, ir_sc
, tc
, sc
);