2 * Copyright 2019 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.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #define BT_COMP_LOG_SELF_COMP (ctx->self_comp)
24 #define BT_LOG_OUTPUT_LEVEL (ctx->log_level)
25 #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/TRANSLATE-TRACE-IR-TO-CTF-IR"
26 #include "logging/comp-logging.h"
28 #include <babeltrace2/babeltrace.h>
29 #include "common/macros.h"
30 #include "common/common.h"
31 #include "common/assert.h"
38 #include "fs-sink-ctf-meta.h"
40 struct field_path_elem
{
41 uint64_t index_in_parent
;
45 const bt_field_class
*ir_fc
;
48 struct fs_sink_ctf_field_class
*parent_fc
;
52 bt_logging_level log_level
;
53 bt_self_component
*self_comp
;
56 struct fs_sink_ctf_stream_class
*cur_sc
;
59 struct fs_sink_ctf_event_class
*cur_ec
;
61 bt_field_path_scope cur_scope
;
64 * Array of `struct field_path_elem` */
69 struct field_path_elem
*cur_path_stack_at(struct ctx
*ctx
, uint64_t i
)
71 BT_ASSERT(i
< ctx
->cur_path
->len
);
72 return &g_array_index(ctx
->cur_path
, struct field_path_elem
, i
);
76 struct field_path_elem
*cur_path_stack_top(struct ctx
*ctx
)
78 BT_ASSERT(ctx
->cur_path
->len
> 0);
79 return cur_path_stack_at(ctx
, ctx
->cur_path
->len
- 1);
83 bool is_reserved_member_name(const char *name
, const char *reserved_name
)
85 bool is_reserved
= false;
87 if (strcmp(name
, reserved_name
) == 0) {
92 if (name
[0] == '_' && strcmp(&name
[1], reserved_name
) == 0) {
101 static const char *reserved_tsdl_keywords
[] = {
133 bool ist_valid_identifier(const char *name
)
137 bool ist_valid
= true;
139 /* Make sure the name is not a reserved keyword */
140 for (i
= 0; i
< sizeof(reserved_tsdl_keywords
) / sizeof(*reserved_tsdl_keywords
);
142 if (strcmp(name
, reserved_tsdl_keywords
[i
]) == 0) {
148 /* Make sure the name is not an empty string */
149 if (strlen(name
) == 0) {
154 /* Make sure the name starts with a letter or `_` */
155 if (!isalpha(name
[0]) && name
[0] != '_') {
160 /* Make sure the name only contains letters, digits, and `_` */
161 for (at
= name
; *at
!= '\0'; at
++) {
162 if (!isalnum(*at
) && *at
!= '_') {
173 bool must_protect_identifier(const char *name
)
176 bool must_protect
= false;
178 /* Protect a reserved keyword */
179 for (i
= 0; i
< sizeof(reserved_tsdl_keywords
) / sizeof(*reserved_tsdl_keywords
);
181 if (strcmp(name
, reserved_tsdl_keywords
[i
]) == 0) {
187 /* Protect an identifier which already starts with `_` */
188 if (name
[0] == '_') {
198 int cur_path_stack_push(struct ctx
*ctx
,
199 uint64_t index_in_parent
, const char *name
,
200 bool force_protect_name
, const bt_field_class
*ir_fc
,
201 struct fs_sink_ctf_field_class
*parent_fc
)
204 struct field_path_elem
*field_path_elem
;
206 g_array_set_size(ctx
->cur_path
, ctx
->cur_path
->len
+ 1);
207 field_path_elem
= cur_path_stack_top(ctx
);
208 field_path_elem
->index_in_parent
= index_in_parent
;
209 field_path_elem
->name
= g_string_new(NULL
);
212 if (force_protect_name
) {
213 g_string_assign(field_path_elem
->name
, "_");
216 g_string_append(field_path_elem
->name
, name
);
218 if (ctx
->cur_scope
== BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
) {
219 if (is_reserved_member_name(name
, "packet_size") ||
220 is_reserved_member_name(name
, "content_size") ||
221 is_reserved_member_name(name
, "timestamp_begin") ||
222 is_reserved_member_name(name
, "timestamp_end") ||
223 is_reserved_member_name(name
, "events_discarded") ||
224 is_reserved_member_name(name
, "packet_seq_num")) {
225 BT_COMP_LOGE("Unsupported reserved TSDL structure field class member "
226 "or variant field class option name: name=\"%s\"",
233 if (!ist_valid_identifier(field_path_elem
->name
->str
)) {
235 BT_COMP_LOGE("Unsupported non-TSDL structure field class member "
236 "or variant field class option name: name=\"%s\"",
237 field_path_elem
->name
->str
);
242 field_path_elem
->ir_fc
= ir_fc
;
243 field_path_elem
->parent_fc
= parent_fc
;
250 void cur_path_stack_pop(struct ctx
*ctx
)
252 struct field_path_elem
*field_path_elem
;
254 BT_ASSERT(ctx
->cur_path
->len
> 0);
255 field_path_elem
= cur_path_stack_top(ctx
);
257 if (field_path_elem
->name
) {
258 g_string_free(field_path_elem
->name
, TRUE
);
259 field_path_elem
->name
= NULL
;
262 g_array_set_size(ctx
->cur_path
, ctx
->cur_path
->len
- 1);
266 * Creates a relative field ref (a single name) from IR field path
267 * `tgt_ir_field_path`.
269 * This function tries to locate the target field class recursively from
270 * the top to the bottom of the context's current path using only the
271 * target field class's own name. This is because many CTF reading tools
272 * do not support a relative field ref with more than one element, for
273 * example `prev_struct.len`.
275 * Returns a negative value if this resolving operation failed.
278 int create_relative_field_ref(struct ctx
*ctx
,
279 const bt_field_path
*tgt_ir_field_path
, GString
*tgt_field_ref
,
280 struct fs_sink_ctf_field_class
**user_tgt_fc
)
283 struct fs_sink_ctf_field_class
*tgt_fc
= NULL
;
286 const char *tgt_fc_name
= NULL
;
287 struct field_path_elem
*field_path_elem
;
289 /* Get target field class's name */
290 switch (bt_field_path_get_root_scope(tgt_ir_field_path
)) {
291 case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
:
292 BT_ASSERT(ctx
->cur_sc
);
293 tgt_fc
= ctx
->cur_sc
->packet_context_fc
;
295 case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT
:
296 BT_ASSERT(ctx
->cur_sc
);
297 tgt_fc
= ctx
->cur_sc
->event_common_context_fc
;
299 case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT
:
300 BT_ASSERT(ctx
->cur_ec
);
301 tgt_fc
= ctx
->cur_ec
->spec_context_fc
;
303 case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD
:
304 BT_ASSERT(ctx
->cur_ec
);
305 tgt_fc
= ctx
->cur_ec
->payload_fc
;
313 while (i
< bt_field_path_get_item_count(tgt_ir_field_path
)) {
314 const bt_field_path_item
*fp_item
=
315 bt_field_path_borrow_item_by_index_const(
316 tgt_ir_field_path
, i
);
317 struct fs_sink_ctf_named_field_class
*named_fc
= NULL
;
322 if (bt_field_path_item_get_type(fp_item
) ==
323 BT_FIELD_PATH_ITEM_TYPE_CURRENT_OPTION_CONTENT
) {
324 /* Not supported by CTF 1.8 */
329 switch (tgt_fc
->type
) {
330 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
331 BT_ASSERT(bt_field_path_item_get_type(fp_item
) ==
332 BT_FIELD_PATH_ITEM_TYPE_INDEX
);
333 named_fc
= fs_sink_ctf_field_class_struct_borrow_member_by_index(
335 bt_field_path_item_index_get_index(fp_item
));
337 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
338 BT_ASSERT(bt_field_path_item_get_type(fp_item
) ==
339 BT_FIELD_PATH_ITEM_TYPE_INDEX
);
340 named_fc
= fs_sink_ctf_field_class_variant_borrow_option_by_index(
342 bt_field_path_item_index_get_index(fp_item
));
344 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
345 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
347 struct fs_sink_ctf_field_class_array_base
*array_base_fc
=
350 BT_ASSERT(bt_field_path_item_get_type(fp_item
) ==
351 BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT
);
352 tgt_fc
= array_base_fc
->elem_fc
;
360 tgt_fc
= named_fc
->fc
;
361 tgt_fc_name
= named_fc
->name
->str
;
367 BT_ASSERT(tgt_fc
->type
== FS_SINK_CTF_FIELD_CLASS_TYPE_INT
);
368 BT_ASSERT(tgt_fc_name
);
370 /* Find target field class having this name in current context */
371 for (si
= ctx
->cur_path
->len
- 1; si
>= 0; si
--) {
372 struct fs_sink_ctf_field_class
*fc
;
373 struct fs_sink_ctf_field_class_struct
*struct_fc
= NULL
;
374 struct fs_sink_ctf_field_class_variant
*var_fc
= NULL
;
375 struct fs_sink_ctf_named_field_class
*named_fc
;
378 field_path_elem
= cur_path_stack_at(ctx
, (uint64_t) si
);
379 fc
= field_path_elem
->parent_fc
;
381 /* Reached stack's bottom */
387 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
388 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
390 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
391 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
394 /* Not supported by TSDL 1.8 */
399 if (fc
->type
== FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
) {
400 struct_fc
= (void *) fc
;
401 len
= struct_fc
->members
->len
;
403 var_fc
= (void *) fc
;
404 len
= var_fc
->options
->len
;
407 for (i
= 0; i
< len
; i
++) {
408 if (fc
->type
== FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
) {
409 named_fc
= fs_sink_ctf_field_class_struct_borrow_member_by_index(
412 named_fc
= fs_sink_ctf_field_class_variant_borrow_option_by_index(
416 if (strcmp(named_fc
->name
->str
, tgt_fc_name
) == 0) {
417 if (named_fc
->fc
== tgt_fc
) {
418 g_string_assign(tgt_field_ref
,
422 *user_tgt_fc
= tgt_fc
;
426 * Using only the target field
427 * class's name, we're not
428 * reaching the target field
429 * class. This is not supported
445 * Creates an absolute field ref from IR field path `tgt_ir_field_path`.
447 * Returns a negative value if this resolving operation failed.
450 int create_absolute_field_ref(struct ctx
*ctx
,
451 const bt_field_path
*tgt_ir_field_path
, GString
*tgt_field_ref
,
452 struct fs_sink_ctf_field_class
**user_tgt_fc
)
455 struct fs_sink_ctf_field_class
*fc
= NULL
;
458 switch (bt_field_path_get_root_scope(tgt_ir_field_path
)) {
459 case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
:
460 BT_ASSERT(ctx
->cur_sc
);
461 fc
= ctx
->cur_sc
->packet_context_fc
;
462 g_string_assign(tgt_field_ref
, "stream.packet.context");
464 case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT
:
465 BT_ASSERT(ctx
->cur_sc
);
466 fc
= ctx
->cur_sc
->event_common_context_fc
;
467 g_string_assign(tgt_field_ref
, "stream.event.context");
469 case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT
:
470 BT_ASSERT(ctx
->cur_ec
);
471 fc
= ctx
->cur_ec
->spec_context_fc
;
472 g_string_assign(tgt_field_ref
, "event.context");
474 case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD
:
475 BT_ASSERT(ctx
->cur_ec
);
476 fc
= ctx
->cur_ec
->payload_fc
;
477 g_string_assign(tgt_field_ref
, "event.fields");
485 for (i
= 0; i
< bt_field_path_get_item_count(tgt_ir_field_path
); i
++) {
486 const bt_field_path_item
*fp_item
=
487 bt_field_path_borrow_item_by_index_const(
488 tgt_ir_field_path
, i
);
489 struct fs_sink_ctf_named_field_class
*named_fc
= NULL
;
491 if (bt_field_path_item_get_type(fp_item
) !=
492 BT_FIELD_PATH_ITEM_TYPE_INDEX
) {
493 /* Not supported by TSDL 1.8 */
499 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
500 BT_ASSERT(bt_field_path_item_get_type(fp_item
) ==
501 BT_FIELD_PATH_ITEM_TYPE_INDEX
);
502 named_fc
= fs_sink_ctf_field_class_struct_borrow_member_by_index(
504 bt_field_path_item_index_get_index(fp_item
));
506 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
507 BT_ASSERT(bt_field_path_item_get_type(fp_item
) ==
508 BT_FIELD_PATH_ITEM_TYPE_INDEX
);
509 named_fc
= fs_sink_ctf_field_class_variant_borrow_option_by_index(
511 bt_field_path_item_index_get_index(fp_item
));
518 g_string_append_c(tgt_field_ref
, '.');
519 g_string_append(tgt_field_ref
, named_fc
->name
->str
);
532 * Resolves a target field class located at `tgt_ir_field_path`, writing
533 * the resolved field ref to `tgt_field_ref` and setting
534 * `*create_before` according to whether or not the target field must be
535 * created immediately before (in which case `tgt_field_ref` is
539 void resolve_field_class(struct ctx
*ctx
,
540 const bt_field_path
*tgt_ir_field_path
,
541 GString
*tgt_field_ref
, bool *create_before
,
542 struct fs_sink_ctf_field_class
**user_tgt_fc
)
545 bt_field_path_scope tgt_scope
;
547 *create_before
= false;
549 if (!tgt_ir_field_path
) {
550 *create_before
= true;
554 tgt_scope
= bt_field_path_get_root_scope(tgt_ir_field_path
);
556 if (tgt_scope
== ctx
->cur_scope
) {
558 * Try, in this order:
560 * 1. Use a relative path, using only the target field
561 * class's name. This is what is the most commonly
562 * supported by popular CTF reading tools.
564 * 2. Use an absolute path. This could fail if there's
565 * an array field class from the current root's field
566 * class to the target field class.
568 * 3. Create the target field class before the
569 * requesting field class (fallback).
571 ret
= create_relative_field_ref(ctx
, tgt_ir_field_path
,
572 tgt_field_ref
, user_tgt_fc
);
574 ret
= create_absolute_field_ref(ctx
, tgt_ir_field_path
,
575 tgt_field_ref
, user_tgt_fc
);
577 *create_before
= true;
583 ret
= create_absolute_field_ref(ctx
, tgt_ir_field_path
,
584 tgt_field_ref
, user_tgt_fc
);
586 /* It must always work in previous scopes */
595 int translate_field_class(struct ctx
*ctx
);
598 void append_to_parent_field_class(struct ctx
*ctx
,
599 struct fs_sink_ctf_field_class
*fc
)
601 struct fs_sink_ctf_field_class
*parent_fc
=
602 cur_path_stack_top(ctx
)->parent_fc
;
604 switch (parent_fc
->type
) {
605 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
606 fs_sink_ctf_field_class_struct_append_member((void *) parent_fc
,
607 cur_path_stack_top(ctx
)->name
->str
, fc
);
609 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
611 struct fs_sink_ctf_field_class_option
*opt_fc
=
614 BT_ASSERT(!opt_fc
->content_fc
);
615 opt_fc
->content_fc
= fc
;
616 opt_fc
->base
.alignment
= fc
->alignment
;
619 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
620 fs_sink_ctf_field_class_variant_append_option((void *) parent_fc
,
621 cur_path_stack_top(ctx
)->name
->str
, fc
);
623 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
624 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
626 struct fs_sink_ctf_field_class_array_base
*array_base_fc
=
629 BT_ASSERT(!array_base_fc
->elem_fc
);
630 array_base_fc
->elem_fc
= fc
;
631 array_base_fc
->base
.alignment
= fc
->alignment
;
640 void update_parent_field_class_alignment(struct ctx
*ctx
,
641 unsigned int alignment
)
643 struct fs_sink_ctf_field_class
*parent_fc
=
644 cur_path_stack_top(ctx
)->parent_fc
;
646 switch (parent_fc
->type
) {
647 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
648 fs_sink_ctf_field_class_struct_align_at_least(
649 (void *) parent_fc
, alignment
);
651 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
652 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
654 struct fs_sink_ctf_field_class_array_base
*array_base_fc
=
657 array_base_fc
->base
.alignment
= alignment
;
666 int translate_structure_field_class_members(struct ctx
*ctx
,
667 struct fs_sink_ctf_field_class_struct
*struct_fc
,
668 const bt_field_class
*ir_fc
)
673 for (i
= 0; i
< bt_field_class_structure_get_member_count(ir_fc
); i
++) {
674 const bt_field_class_structure_member
*member
;
676 const bt_field_class
*memb_ir_fc
;
679 bt_field_class_structure_borrow_member_by_index_const(
681 name
= bt_field_class_structure_member_get_name(member
);
682 memb_ir_fc
= bt_field_class_structure_member_borrow_field_class_const(
684 ret
= cur_path_stack_push(ctx
, i
, name
, true, memb_ir_fc
,
687 BT_COMP_LOGE("Cannot translate structure field class member: "
688 "name=\"%s\"", name
);
692 ret
= translate_field_class(ctx
);
694 BT_COMP_LOGE("Cannot translate structure field class member: "
695 "name=\"%s\"", name
);
699 cur_path_stack_pop(ctx
);
707 int translate_structure_field_class(struct ctx
*ctx
)
710 struct fs_sink_ctf_field_class_struct
*fc
=
711 fs_sink_ctf_field_class_struct_create_empty(
712 cur_path_stack_top(ctx
)->ir_fc
,
713 cur_path_stack_top(ctx
)->index_in_parent
);
716 append_to_parent_field_class(ctx
, (void *) fc
);
717 ret
= translate_structure_field_class_members(ctx
, fc
, fc
->base
.ir_fc
);
722 update_parent_field_class_alignment(ctx
, fc
->base
.alignment
);
729 * This function protects a given variant FC option name (with the `_`
730 * prefix) if required. On success, `name_buf->str` contains the variant
731 * FC option name to use (original option name or protected if
734 * One of the goals of `sink.ctf.fs` is to write a CTF trace which is as
735 * close as possible to an original CTF trace as decoded by
738 * This scenario is valid in CTF 1.8:
750 * Once in trace IR, the enumeration FC mapping names and variant FC
751 * option names are kept as is. For this reason, we don't want to
752 * protect the variant FC option names here (by prepending `_`): this
753 * would make the variant FC option name and the enumeration FC mapping
756 * This scenario is also valid in CTF 1.8:
768 * Once in trace IR, the enumeration FC mapping names are kept as is,
769 * but the `_HELLO` variant FC option name becomes `HELLO` (unprotected
770 * for presentation, as recommended by CTF 1.8). When going back to
771 * TSDL, we need to protect `HELLO` so that it becomes `_HELLO` to match
772 * the corresponding enumeration FC mapping name.
774 * This scenario is also valid in CTF 1.8:
786 * Once in trace IR, the enumeration FC mapping names are kept as is,
787 * but the `__HELLO` variant FC option name becomes `_HELLO`
788 * (unprotected). When going back to TSDL, we need to protect `_HELLO`
789 * so that it becomes `__HELLO` to match the corresponding enumeration
792 * `src.ctf.fs` always uses the _same_ integer range sets for a selector
793 * FC mapping and a corresponding variant FC option. We can use that
794 * fact to find the original variant FC option names by matching variant
795 * FC options and enumeration FC mappings by range set.
798 int maybe_protect_variant_option_name(const bt_field_class
*ir_var_fc
,
799 const bt_field_class
*ir_tag_fc
, uint64_t opt_i
,
804 bt_field_class_type ir_var_fc_type
;
805 const void *opt_ranges
= NULL
;
806 const char *mapping_label
= NULL
;
807 const char *ir_opt_name
;
808 const bt_field_class_variant_option
*base_var_opt
;
809 bool force_protect
= false;
811 ir_var_fc_type
= bt_field_class_get_type(ir_var_fc
);
812 base_var_opt
= bt_field_class_variant_borrow_option_by_index_const(
814 BT_ASSERT(base_var_opt
);
815 ir_opt_name
= bt_field_class_variant_option_get_name(base_var_opt
);
816 BT_ASSERT(ir_opt_name
);
819 * Check if the variant FC option name is required to be
820 * protected (reserved TSDL keyword or starts with `_`). In that
821 * case, the name of the selector FC mapping we find must match
822 * exactly the protected name.
824 force_protect
= must_protect_identifier(ir_opt_name
);
826 g_string_assign(name_buf
, "_");
827 g_string_append(name_buf
, ir_opt_name
);
829 g_string_assign(name_buf
, ir_opt_name
);
832 /* Borrow option's ranges */
833 if (ir_var_fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
) {
834 /* No ranges: we're done */
836 } if (ir_var_fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR
) {
837 const bt_field_class_variant_with_selector_integer_unsigned_option
*var_opt
=
838 bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_index_const(
841 bt_field_class_variant_with_selector_integer_unsigned_option_borrow_ranges_const(
844 const bt_field_class_variant_with_selector_integer_signed_option
*var_opt
=
845 bt_field_class_variant_with_selector_integer_signed_borrow_option_by_index_const(
848 bt_field_class_variant_with_selector_integer_signed_option_borrow_ranges_const(
852 /* Find corresponding mapping by range set in selector FC */
853 for (i
= 0; i
< bt_field_class_enumeration_get_mapping_count(ir_tag_fc
);
855 if (ir_var_fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR
) {
856 const bt_field_class_enumeration_mapping
*mapping_base
;
857 const bt_field_class_enumeration_unsigned_mapping
*mapping
;
858 const bt_integer_range_set_unsigned
*mapping_ranges
;
860 mapping
= bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
862 mapping_ranges
= bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
865 if (bt_integer_range_set_unsigned_is_equal(opt_ranges
,
867 /* We have a winner */
869 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
872 bt_field_class_enumeration_mapping_get_label(
877 const bt_field_class_enumeration_mapping
*mapping_base
;
878 const bt_field_class_enumeration_signed_mapping
*mapping
;
879 const bt_integer_range_set_signed
*mapping_ranges
;
881 mapping
= bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
883 mapping_ranges
= bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
886 if (bt_integer_range_set_signed_is_equal(opt_ranges
,
888 /* We have a winner */
890 bt_field_class_enumeration_signed_mapping_as_mapping_const(
893 bt_field_class_enumeration_mapping_get_label(
900 if (!mapping_label
) {
901 /* Range set not found: invalid selector for CTF 1.8 */
907 * If the enumeration FC mapping name is not the same as the
908 * variant FC option name and we didn't protect already, try
909 * protecting the option name and check again.
911 if (strcmp(mapping_label
, name_buf
->str
) != 0) {
917 if (mapping_label
[0] == '\0') {
922 g_string_assign(name_buf
, "_");
923 g_string_append(name_buf
, ir_opt_name
);
925 if (strcmp(mapping_label
, name_buf
->str
) != 0) {
936 int translate_option_field_class(struct ctx
*ctx
)
938 struct fs_sink_ctf_field_class_option
*fc
=
939 fs_sink_ctf_field_class_option_create_empty(
940 cur_path_stack_top(ctx
)->ir_fc
,
941 cur_path_stack_top(ctx
)->index_in_parent
);
942 const bt_field_class
*content_ir_fc
=
943 bt_field_class_option_borrow_field_class_const(fc
->base
.ir_fc
);
949 * CTF 1.8 does not support the option field class type. To
950 * write something anyway, this component translates this type
951 * to a variant field class where the options are:
953 * * An empty structure field class.
954 * * The optional field class itself.
956 * The "tag" is always generated/before in that case (an 8-bit
957 * unsigned enumeration field class).
959 append_to_parent_field_class(ctx
, (void *) fc
);
960 ret
= cur_path_stack_push(ctx
, UINT64_C(-1), NULL
, false, content_ir_fc
,
963 BT_COMP_LOGE_STR("Cannot translate option field class content.");
967 ret
= translate_field_class(ctx
);
969 BT_COMP_LOGE_STR("Cannot translate option field class content.");
973 cur_path_stack_pop(ctx
);
974 update_parent_field_class_alignment(ctx
, fc
->base
.alignment
);
981 int translate_variant_field_class(struct ctx
*ctx
)
985 struct fs_sink_ctf_field_class_variant
*fc
=
986 fs_sink_ctf_field_class_variant_create_empty(
987 cur_path_stack_top(ctx
)->ir_fc
,
988 cur_path_stack_top(ctx
)->index_in_parent
);
989 bt_field_class_type ir_fc_type
;
990 const bt_field_path
*ir_selector_field_path
= NULL
;
991 struct fs_sink_ctf_field_class
*tgt_fc
= NULL
;
992 GString
*name_buf
= g_string_new(NULL
);
993 bt_value
*prot_opt_names
= bt_value_array_create();
998 BT_ASSERT(prot_opt_names
);
999 ir_fc_type
= bt_field_class_get_type(fc
->base
.ir_fc
);
1000 opt_count
= bt_field_class_variant_get_option_count(fc
->base
.ir_fc
);
1002 if (ir_fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR
||
1003 ir_fc_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR
) {
1004 ir_selector_field_path
= bt_field_class_variant_with_selector_borrow_selector_field_path_const(
1006 BT_ASSERT(ir_selector_field_path
);
1009 /* Resolve tag field class before appending to parent */
1010 resolve_field_class(ctx
, ir_selector_field_path
, fc
->tag_ref
,
1011 &fc
->tag_is_before
, &tgt_fc
);
1013 if (ir_selector_field_path
&& tgt_fc
) {
1014 uint64_t mapping_count
;
1015 uint64_t option_count
;
1017 /* CTF 1.8: selector FC must be an enumeration FC */
1018 bt_field_class_type type
= bt_field_class_get_type(
1021 if (type
!= BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
&&
1022 type
!= BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
) {
1023 fc
->tag_is_before
= true;
1028 * Call maybe_protect_variant_option_name() for each
1029 * option below. In that case we also want selector FC
1030 * to contain as many mappings as the variant FC has
1033 mapping_count
= bt_field_class_enumeration_get_mapping_count(
1035 option_count
= bt_field_class_variant_get_option_count(
1038 if (mapping_count
!= option_count
) {
1039 fc
->tag_is_before
= true;
1044 * No compatible selector field class for CTF 1.8:
1045 * create the appropriate selector field class.
1047 fc
->tag_is_before
= true;
1053 * First pass: detect any option name clash with option name
1054 * protection. In that case, we don't fail: just create the
1055 * selector field class before the variant field class.
1057 * After this, `prot_opt_names` contains the final option names,
1058 * potentially protected if needed. They can still be invalid
1059 * TSDL identifiers however; this will be checked by
1060 * cur_path_stack_push().
1062 for (i
= 0; i
< opt_count
; i
++) {
1063 if (!fc
->tag_is_before
) {
1064 BT_ASSERT(tgt_fc
->ir_fc
);
1065 ret
= maybe_protect_variant_option_name(fc
->base
.ir_fc
,
1066 tgt_fc
->ir_fc
, i
, name_buf
);
1068 fc
->tag_is_before
= true;
1072 ret
= bt_value_array_append_string_element(prot_opt_names
,
1079 for (i
= 0; i
< opt_count
; i
++) {
1081 const bt_value
*opt_name_a
=
1082 bt_value_array_borrow_element_by_index_const(
1085 for (j
= 0; j
< opt_count
; j
++) {
1086 const bt_value
*opt_name_b
;
1093 bt_value_array_borrow_element_by_index_const(
1095 if (bt_value_is_equal(opt_name_a
, opt_name_b
)) {
1097 * Variant FC option names are not
1098 * unique when protected.
1100 fc
->tag_is_before
= true;
1101 goto append_to_parent
;
1107 append_to_parent_field_class(ctx
, (void *) fc
);
1109 for (i
= 0; i
< opt_count
; i
++) {
1110 const bt_field_class_variant_option
*opt
;
1111 const bt_field_class
*opt_ir_fc
;
1112 const bt_value
*prot_opt_name_val
=
1113 bt_value_array_borrow_element_by_index_const(
1115 const char *prot_opt_name
= bt_value_string_get(
1118 BT_ASSERT(prot_opt_name
);
1119 opt
= bt_field_class_variant_borrow_option_by_index_const(
1121 opt_ir_fc
= bt_field_class_variant_option_borrow_field_class_const(
1125 * We don't ask cur_path_stack_push() to protect the
1126 * option name because it's already protected at this
1129 ret
= cur_path_stack_push(ctx
, i
, prot_opt_name
, false,
1130 opt_ir_fc
, (void *) fc
);
1132 BT_COMP_LOGE("Cannot translate variant field class option: "
1133 "name=\"%s\"", prot_opt_name
);
1137 ret
= translate_field_class(ctx
);
1139 BT_COMP_LOGE("Cannot translate variant field class option: "
1140 "name=\"%s\"", prot_opt_name
);
1144 cur_path_stack_pop(ctx
);
1149 g_string_free(name_buf
, TRUE
);
1152 bt_value_put_ref(prot_opt_names
);
1157 int translate_static_array_field_class(struct ctx
*ctx
)
1159 struct fs_sink_ctf_field_class_array
*fc
=
1160 fs_sink_ctf_field_class_array_create_empty(
1161 cur_path_stack_top(ctx
)->ir_fc
,
1162 cur_path_stack_top(ctx
)->index_in_parent
);
1163 const bt_field_class
*elem_ir_fc
=
1164 bt_field_class_array_borrow_element_field_class_const(
1165 fc
->base
.base
.ir_fc
);
1169 append_to_parent_field_class(ctx
, (void *) fc
);
1170 ret
= cur_path_stack_push(ctx
, UINT64_C(-1), NULL
, false, elem_ir_fc
,
1173 BT_COMP_LOGE_STR("Cannot translate static array field class element.");
1177 ret
= translate_field_class(ctx
);
1179 BT_COMP_LOGE_STR("Cannot translate static array field class element.");
1183 cur_path_stack_pop(ctx
);
1184 update_parent_field_class_alignment(ctx
, fc
->base
.base
.alignment
);
1191 int translate_dynamic_array_field_class(struct ctx
*ctx
)
1193 struct fs_sink_ctf_field_class_sequence
*fc
=
1194 fs_sink_ctf_field_class_sequence_create_empty(
1195 cur_path_stack_top(ctx
)->ir_fc
,
1196 cur_path_stack_top(ctx
)->index_in_parent
);
1197 const bt_field_class
*elem_ir_fc
=
1198 bt_field_class_array_borrow_element_field_class_const(
1199 fc
->base
.base
.ir_fc
);
1204 /* Resolve length field class before appending to parent */
1205 resolve_field_class(ctx
,
1206 bt_field_class_array_dynamic_borrow_length_field_path_const(
1207 fc
->base
.base
.ir_fc
),
1208 fc
->length_ref
, &fc
->length_is_before
, NULL
);
1210 append_to_parent_field_class(ctx
, (void *) fc
);
1211 ret
= cur_path_stack_push(ctx
, UINT64_C(-1), NULL
, false, elem_ir_fc
,
1214 BT_COMP_LOGE_STR("Cannot translate dynamic array field class element.");
1218 ret
= translate_field_class(ctx
);
1220 BT_COMP_LOGE_STR("Cannot translate dynamic array field class element.");
1224 cur_path_stack_pop(ctx
);
1225 update_parent_field_class_alignment(ctx
, fc
->base
.base
.alignment
);
1232 int translate_bool_field_class(struct ctx
*ctx
)
1234 struct fs_sink_ctf_field_class_bool
*fc
=
1235 fs_sink_ctf_field_class_bool_create(
1236 cur_path_stack_top(ctx
)->ir_fc
,
1237 cur_path_stack_top(ctx
)->index_in_parent
);
1240 append_to_parent_field_class(ctx
, (void *) fc
);
1245 int translate_bit_array_field_class(struct ctx
*ctx
)
1247 struct fs_sink_ctf_field_class_bit_array
*fc
=
1248 fs_sink_ctf_field_class_bit_array_create(
1249 cur_path_stack_top(ctx
)->ir_fc
,
1250 cur_path_stack_top(ctx
)->index_in_parent
);
1253 append_to_parent_field_class(ctx
, (void *) fc
);
1258 int translate_integer_field_class(struct ctx
*ctx
)
1260 struct fs_sink_ctf_field_class_int
*fc
=
1261 fs_sink_ctf_field_class_int_create(
1262 cur_path_stack_top(ctx
)->ir_fc
,
1263 cur_path_stack_top(ctx
)->index_in_parent
);
1266 append_to_parent_field_class(ctx
, (void *) fc
);
1271 int translate_real_field_class(struct ctx
*ctx
)
1273 struct fs_sink_ctf_field_class_float
*fc
=
1274 fs_sink_ctf_field_class_float_create(
1275 cur_path_stack_top(ctx
)->ir_fc
,
1276 cur_path_stack_top(ctx
)->index_in_parent
);
1279 append_to_parent_field_class(ctx
, (void *) fc
);
1284 int translate_string_field_class(struct ctx
*ctx
)
1286 struct fs_sink_ctf_field_class_string
*fc
=
1287 fs_sink_ctf_field_class_string_create(
1288 cur_path_stack_top(ctx
)->ir_fc
,
1289 cur_path_stack_top(ctx
)->index_in_parent
);
1292 append_to_parent_field_class(ctx
, (void *) fc
);
1297 * Translates a field class, recursively.
1299 * The field class's IR field class, parent field class, and index
1300 * within its parent are in the context's current path's top element
1301 * (cur_path_stack_top()).
1304 int translate_field_class(struct ctx
*ctx
)
1308 switch (bt_field_class_get_type(cur_path_stack_top(ctx
)->ir_fc
)) {
1309 case BT_FIELD_CLASS_TYPE_BOOL
:
1310 ret
= translate_bool_field_class(ctx
);
1312 case BT_FIELD_CLASS_TYPE_BIT_ARRAY
:
1313 ret
= translate_bit_array_field_class(ctx
);
1315 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
1316 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
1317 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
1318 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
1319 ret
= translate_integer_field_class(ctx
);
1321 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
:
1322 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL
:
1323 ret
= translate_real_field_class(ctx
);
1325 case BT_FIELD_CLASS_TYPE_STRING
:
1326 ret
= translate_string_field_class(ctx
);
1328 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1329 ret
= translate_structure_field_class(ctx
);
1331 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1332 ret
= translate_static_array_field_class(ctx
);
1334 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1335 ret
= translate_dynamic_array_field_class(ctx
);
1337 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR
:
1338 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR
:
1339 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR
:
1340 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR
:
1341 ret
= translate_option_field_class(ctx
);
1343 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
:
1344 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR
:
1345 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR
:
1346 ret
= translate_variant_field_class(ctx
);
1356 int set_field_ref(struct fs_sink_ctf_field_class
*fc
, const char *fc_name
,
1357 struct fs_sink_ctf_field_class
*parent_fc
)
1360 GString
*field_ref
= NULL
;
1362 const char *tgt_type
;
1363 struct fs_sink_ctf_field_class_struct
*parent_struct_fc
=
1366 unsigned int suffix
= 0;
1368 if (!fc_name
|| !parent_fc
||
1369 parent_fc
->type
!= FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
) {
1376 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
1379 * CTF 1.8 does not support the option field class type.
1380 * To write something anyway, this component translates
1381 * this type to a variant field class where the options
1384 * * An empty structure field class.
1385 * * The optional field class itself.
1387 * Because the option field class becomes a CTF variant
1388 * field class, we use the term "tag" too here.
1390 * The "tag" is always generated/before in that case (an
1391 * 8-bit unsigned enumeration field class).
1393 struct fs_sink_ctf_field_class_option
*opt_fc
= (void *) fc
;
1395 field_ref
= opt_fc
->tag_ref
;
1400 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
1402 struct fs_sink_ctf_field_class_sequence
*seq_fc
= (void *) fc
;
1404 field_ref
= seq_fc
->length_ref
;
1405 is_before
= seq_fc
->length_is_before
;
1409 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
1411 struct fs_sink_ctf_field_class_variant
*var_fc
= (void *) fc
;
1413 field_ref
= var_fc
->tag_ref
;
1414 is_before
= var_fc
->tag_is_before
;
1422 BT_ASSERT(field_ref
);
1428 /* Initial field ref */
1429 g_string_printf(field_ref
, "__%s_%s", fc_name
, tgt_type
);
1432 * Make sure field ref does not clash with an existing field
1433 * class name within the same parent structure field class.
1436 bool name_ok
= true;
1438 for (i
= 0; i
< parent_struct_fc
->members
->len
; i
++) {
1439 struct fs_sink_ctf_named_field_class
*named_fc
=
1440 fs_sink_ctf_field_class_struct_borrow_member_by_index(
1441 parent_struct_fc
, i
);
1443 if (strcmp(field_ref
->str
, named_fc
->name
->str
) == 0) {
1451 /* No clash: we're done */
1455 /* Append suffix and try again */
1456 g_string_printf(field_ref
, "__%s_%s_%u", fc_name
, tgt_type
,
1466 * This function recursively sets field refs of sequence and variant
1467 * field classes when they are immediately before, avoiding name clashes
1468 * with existing field class names.
1470 * It can fail at this point if, for example, a sequence field class of
1471 * which to set the length's field ref has something else than a
1472 * structure field class as its parent: in this case, there's no
1473 * location to place the length field class immediately before the
1474 * sequence field class.
1477 int set_field_refs(struct fs_sink_ctf_field_class
* const fc
,
1478 const char *fc_name
, struct fs_sink_ctf_field_class
*parent_fc
)
1481 enum fs_sink_ctf_field_class_type fc_type
;
1487 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
1489 struct fs_sink_ctf_field_class_option
*opt_fc
= (void *) fc
;
1491 ret
= set_field_ref(fc
, fc_name
, parent_fc
);
1496 ret
= set_field_refs(opt_fc
->content_fc
, NULL
, fc
);
1503 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
1504 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
1508 struct fs_sink_ctf_field_class_struct
*struct_fc
= NULL
;
1509 struct fs_sink_ctf_field_class_variant
*var_fc
= NULL
;
1510 struct fs_sink_ctf_named_field_class
*named_fc
;
1512 if (fc_type
== FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
) {
1513 struct_fc
= (void *) fc
;
1514 len
= struct_fc
->members
->len
;
1516 var_fc
= (void *) fc
;
1517 len
= var_fc
->options
->len
;
1518 ret
= set_field_ref(fc
, fc_name
, parent_fc
);
1524 for (i
= 0; i
< len
; i
++) {
1525 if (fc_type
== FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
) {
1526 named_fc
= fs_sink_ctf_field_class_struct_borrow_member_by_index(
1529 named_fc
= fs_sink_ctf_field_class_variant_borrow_option_by_index(
1533 ret
= set_field_refs(named_fc
->fc
, named_fc
->name
->str
,
1542 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
1543 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
1545 struct fs_sink_ctf_field_class_array_base
*array_base_fc
=
1548 if (fc_type
== FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
1549 ret
= set_field_ref(fc
, fc_name
, parent_fc
);
1555 ret
= set_field_refs(array_base_fc
->elem_fc
, NULL
, fc
);
1571 * This function translates a root scope trace IR field class to
1572 * a CTF IR field class.
1574 * The resulting CTF IR field class is written to `*fc` so that it
1575 * exists as the parent object's (stream class or event class) true root
1576 * field class during the recursive translation for resolving purposes.
1577 * This is also why this function creates the empty structure field
1578 * class and then calls translate_structure_field_class_members() to
1582 int translate_scope_field_class(struct ctx
*ctx
, bt_field_path_scope scope
,
1583 struct fs_sink_ctf_field_class
**fc
,
1584 const bt_field_class
*ir_fc
)
1592 BT_ASSERT(bt_field_class_get_type(ir_fc
) ==
1593 BT_FIELD_CLASS_TYPE_STRUCTURE
);
1595 *fc
= (void *) fs_sink_ctf_field_class_struct_create_empty(
1596 ir_fc
, UINT64_C(-1));
1598 ctx
->cur_scope
= scope
;
1599 BT_ASSERT(ctx
->cur_path
->len
== 0);
1600 ret
= cur_path_stack_push(ctx
, UINT64_C(-1), NULL
, false, ir_fc
, NULL
);
1602 BT_COMP_LOGE("Cannot translate scope structure field class: "
1607 ret
= translate_structure_field_class_members(ctx
, (void *) *fc
, ir_fc
);
1609 BT_COMP_LOGE("Cannot translate scope structure field class: "
1614 cur_path_stack_pop(ctx
);
1616 /* Set field refs for preceding targets */
1617 ret
= set_field_refs(*fc
, NULL
, NULL
);
1624 void ctx_init(struct ctx
*ctx
, struct fs_sink_comp
*fs_sink
)
1626 memset(ctx
, 0, sizeof(struct ctx
));
1627 ctx
->cur_path
= g_array_new(FALSE
, TRUE
,
1628 sizeof(struct field_path_elem
));
1629 BT_ASSERT(ctx
->cur_path
);
1630 ctx
->log_level
= fs_sink
->log_level
;
1631 ctx
->self_comp
= fs_sink
->self_comp
;
1635 void ctx_fini(struct ctx
*ctx
)
1637 if (ctx
->cur_path
) {
1638 g_array_free(ctx
->cur_path
, TRUE
);
1639 ctx
->cur_path
= NULL
;
1644 int translate_event_class(struct fs_sink_comp
*fs_sink
,
1645 struct fs_sink_ctf_stream_class
*sc
,
1646 const bt_event_class
*ir_ec
,
1647 struct fs_sink_ctf_event_class
**out_ec
)
1651 struct fs_sink_ctf_event_class
*ec
;
1656 ctx_init(&ctx
, fs_sink
);
1657 ec
= fs_sink_ctf_event_class_create(sc
, ir_ec
);
1661 ret
= translate_scope_field_class(&ctx
, BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT
,
1662 &ec
->spec_context_fc
,
1663 bt_event_class_borrow_specific_context_field_class_const(
1669 ret
= translate_scope_field_class(&ctx
, BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD
,
1671 bt_event_class_borrow_payload_field_class_const(ir_ec
));
1683 int try_translate_event_class_trace_ir_to_ctf_ir(
1684 struct fs_sink_comp
*fs_sink
,
1685 struct fs_sink_ctf_stream_class
*sc
,
1686 const bt_event_class
*ir_ec
,
1687 struct fs_sink_ctf_event_class
**out_ec
)
1694 /* Check in hash table first */
1695 *out_ec
= g_hash_table_lookup(sc
->event_classes_from_ir
, ir_ec
);
1696 if (G_LIKELY(*out_ec
)) {
1700 ret
= translate_event_class(fs_sink
, sc
, ir_ec
, out_ec
);
1706 bool default_clock_class_name_exists(struct fs_sink_ctf_trace
*trace
,
1709 bool exists
= false;
1712 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1713 struct fs_sink_ctf_stream_class
*sc
=
1714 trace
->stream_classes
->pdata
[i
];
1716 if (sc
->default_clock_class_name
->len
== 0) {
1717 /* No default clock class */
1721 if (strcmp(sc
->default_clock_class_name
->str
, name
) == 0) {
1732 void make_unique_default_clock_class_name(struct fs_sink_ctf_stream_class
*sc
)
1734 unsigned int suffix
= 0;
1737 g_string_assign(sc
->default_clock_class_name
, "");
1738 sprintf(buf
, "default");
1740 while (default_clock_class_name_exists(sc
->trace
, buf
)) {
1741 sprintf(buf
, "default%u", suffix
);
1745 g_string_assign(sc
->default_clock_class_name
, buf
);
1749 int translate_stream_class(struct fs_sink_comp
*fs_sink
,
1750 struct fs_sink_ctf_trace
*trace
,
1751 const bt_stream_class
*ir_sc
,
1752 struct fs_sink_ctf_stream_class
**out_sc
)
1759 ctx_init(&ctx
, fs_sink
);
1760 *out_sc
= fs_sink_ctf_stream_class_create(trace
, ir_sc
);
1763 /* Set default clock class's protected name, if any */
1764 if ((*out_sc
)->default_clock_class
) {
1765 const char *name
= bt_clock_class_get_name(
1766 (*out_sc
)->default_clock_class
);
1769 /* Try original name, protected */
1770 g_string_assign((*out_sc
)->default_clock_class_name
,
1773 if (must_protect_identifier(name
)) {
1775 (*out_sc
)->default_clock_class_name
,
1779 g_string_assign((*out_sc
)->default_clock_class_name
,
1781 if (!ist_valid_identifier(
1782 (*out_sc
)->default_clock_class_name
->str
)) {
1783 /* Invalid: create a new name */
1784 make_unique_default_clock_class_name(*out_sc
);
1788 /* No name: create a name */
1789 make_unique_default_clock_class_name(*out_sc
);
1793 ctx
.cur_sc
= *out_sc
;
1794 ret
= translate_scope_field_class(&ctx
, BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
,
1795 &(*out_sc
)->packet_context_fc
,
1796 bt_stream_class_borrow_packet_context_field_class_const(ir_sc
));
1801 if ((*out_sc
)->packet_context_fc
) {
1803 * Make sure the structure field class's alignment is
1804 * enough: 8 is what we use for our own special members
1805 * in the packet context.
1807 fs_sink_ctf_field_class_struct_align_at_least(
1808 (void *) (*out_sc
)->packet_context_fc
, 8);
1811 ret
= translate_scope_field_class(&ctx
, BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT
,
1812 &(*out_sc
)->event_common_context_fc
,
1813 bt_stream_class_borrow_event_common_context_field_class_const(
1822 fs_sink_ctf_stream_class_destroy(*out_sc
);
1831 int try_translate_stream_class_trace_ir_to_ctf_ir(
1832 struct fs_sink_comp
*fs_sink
,
1833 struct fs_sink_ctf_trace
*trace
,
1834 const bt_stream_class
*ir_sc
,
1835 struct fs_sink_ctf_stream_class
**out_sc
)
1843 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1844 *out_sc
= trace
->stream_classes
->pdata
[i
];
1846 if ((*out_sc
)->ir_sc
== ir_sc
) {
1851 ret
= translate_stream_class(fs_sink
, trace
, ir_sc
, out_sc
);
1858 struct fs_sink_ctf_trace
*translate_trace_trace_ir_to_ctf_ir(
1859 struct fs_sink_comp
*fs_sink
, const bt_trace
*ir_trace
)
1863 struct fs_sink_ctf_trace
*trace
= NULL
;
1865 /* Check that trace's environment is TSDL-compatible */
1866 count
= bt_trace_get_environment_entry_count(ir_trace
);
1867 for (i
= 0; i
< count
; i
++) {
1869 const bt_value
*val
;
1871 bt_trace_borrow_environment_entry_by_index_const(
1872 ir_trace
, i
, &name
, &val
);
1874 if (!ist_valid_identifier(name
)) {
1875 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, fs_sink
->log_level
,
1877 "Unsupported trace class's environment entry name: "
1878 "name=\"%s\"", name
);
1882 switch (bt_value_get_type(val
)) {
1883 case BT_VALUE_TYPE_SIGNED_INTEGER
:
1884 case BT_VALUE_TYPE_STRING
:
1887 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, fs_sink
->log_level
,
1889 "Unsupported trace class's environment entry value type: "
1891 bt_common_value_type_string(
1892 bt_value_get_type(val
)));
1897 trace
= fs_sink_ctf_trace_create(ir_trace
);