X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fplugins%2Fctf%2Ffs-sink%2Ftranslate-trace-ir-to-ctf-ir.c;h=19ca9dcdbbee3d7194ce2095195ea6bf513ea4b4;hp=be00d041f4b067419dd37ee2f2ea14c9e3449023;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=a29ba23b453b2e2e62b40f77d49ee45db444ccfc diff --git a/src/plugins/ctf/fs-sink/translate-trace-ir-to-ctf-ir.c b/src/plugins/ctf/fs-sink/translate-trace-ir-to-ctf-ir.c index be00d041..19ca9dcd 100644 --- a/src/plugins/ctf/fs-sink/translate-trace-ir-to-ctf-ir.c +++ b/src/plugins/ctf/fs-sink/translate-trace-ir-to-ctf-ir.c @@ -1,23 +1,7 @@ /* - * Copyright 2019 Philippe Proulx - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * SPDX-License-Identifier: MIT * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Copyright 2019 Philippe Proulx */ #define BT_COMP_LOG_SELF_COMP (ctx->self_comp) @@ -25,6 +9,8 @@ #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/TRANSLATE-TRACE-IR-TO-CTF-IR" #include "logging/comp-logging.h" +#include "translate-trace-ir-to-ctf-ir.h" + #include #include "common/macros.h" #include "common/common.h" @@ -152,14 +138,14 @@ bool ist_valid_identifier(const char *name) } /* Make sure the name starts with a letter or `_` */ - if (!isalpha(name[0]) && name[0] != '_') { + if (!isalpha((unsigned char) name[0]) && name[0] != '_') { ist_valid = false; goto end; } /* Make sure the name only contains letters, digits, and `_` */ for (at = name; *at != '\0'; at++) { - if (!isalnum(*at) && *at != '_') { + if (!isalnum((unsigned char) *at) && *at != '_') { ist_valid = false; goto end; } @@ -305,7 +291,7 @@ int create_relative_field_ref(struct ctx *ctx, tgt_fc = ctx->cur_ec->payload_fc; break; default: - abort(); + bt_common_abort(); } i = 0; @@ -319,6 +305,13 @@ int create_relative_field_ref(struct ctx *ctx, BT_ASSERT(tgt_fc); BT_ASSERT(fp_item); + if (bt_field_path_item_get_type(fp_item) == + BT_FIELD_PATH_ITEM_TYPE_CURRENT_OPTION_CONTENT) { + /* Not supported by CTF 1.8 */ + ret = -1; + goto end; + } + switch (tgt_fc->type) { case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT: BT_ASSERT(bt_field_path_item_get_type(fp_item) == @@ -346,7 +339,7 @@ int create_relative_field_ref(struct ctx *ctx, break; } default: - abort(); + bt_common_abort(); } if (named_fc) { @@ -363,8 +356,8 @@ int create_relative_field_ref(struct ctx *ctx, /* Find target field class having this name in current context */ for (si = ctx->cur_path->len - 1; si >= 0; si--) { struct fs_sink_ctf_field_class *fc; - struct fs_sink_ctf_field_class_struct *struct_fc; - struct fs_sink_ctf_field_class_variant *var_fc; + struct fs_sink_ctf_field_class_struct *struct_fc = NULL; + struct fs_sink_ctf_field_class_variant *var_fc = NULL; struct fs_sink_ctf_named_field_class *named_fc; uint64_t len; @@ -470,7 +463,7 @@ int create_absolute_field_ref(struct ctx *ctx, g_string_assign(tgt_field_ref, "event.fields"); break; default: - abort(); + bt_common_abort(); } BT_ASSERT(fc); @@ -504,7 +497,7 @@ int create_absolute_field_ref(struct ctx *ctx, bt_field_path_item_index_get_index(fp_item)); break; default: - abort(); + bt_common_abort(); } BT_ASSERT(named_fc); @@ -568,7 +561,6 @@ void resolve_field_class(struct ctx *ctx, tgt_field_ref, user_tgt_fc); if (ret) { *create_before = true; - ret = 0; goto end; } } @@ -599,6 +591,16 @@ void append_to_parent_field_class(struct ctx *ctx, fs_sink_ctf_field_class_struct_append_member((void *) parent_fc, cur_path_stack_top(ctx)->name->str, fc); break; + case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION: + { + struct fs_sink_ctf_field_class_option *opt_fc = + (void *) parent_fc; + + BT_ASSERT(!opt_fc->content_fc); + opt_fc->content_fc = fc; + opt_fc->base.alignment = fc->alignment; + break; + } case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT: fs_sink_ctf_field_class_variant_append_option((void *) parent_fc, cur_path_stack_top(ctx)->name->str, fc); @@ -615,7 +617,7 @@ void append_to_parent_field_class(struct ctx *ctx, break; } default: - abort(); + bt_common_abort(); } } @@ -709,8 +711,10 @@ end: } /* - * This function indicates whether or not a given variant FC option name - * must be protected (with the `_` prefix). + * This function protects a given variant FC option name (with the `_` + * prefix) if required. On success, `name_buf->str` contains the variant + * FC option name to use (original option name or protected if + * required). * * One of the goals of `sink.ctf.fs` is to write a CTF trace which is as * close as possible to an original CTF trace as decoded by @@ -776,9 +780,9 @@ end: * FC options and enumeration FC mappings by range set. */ static -int must_protect_variant_option_name(const bt_field_class *ir_var_fc, +int maybe_protect_variant_option_name(const bt_field_class *ir_var_fc, const bt_field_class *ir_tag_fc, uint64_t opt_i, - GString *name_buf, bool *must_protect) + GString *name_buf) { int ret = 0; uint64_t i; @@ -789,7 +793,6 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, const bt_field_class_variant_option *base_var_opt; bool force_protect = false; - *must_protect = false; ir_var_fc_type = bt_field_class_get_type(ir_var_fc); base_var_opt = bt_field_class_variant_borrow_option_by_index_const( ir_var_fc, opt_i); @@ -805,7 +808,6 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, */ force_protect = must_protect_identifier(ir_opt_name); if (force_protect) { - *must_protect = true; g_string_assign(name_buf, "_"); g_string_append(name_buf, ir_opt_name); } else { @@ -813,29 +815,29 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, } /* Borrow option's ranges */ - if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR) { + if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD) { /* No ranges: we're done */ goto end; - } if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR) { - const bt_field_class_variant_with_selector_unsigned_option *var_opt = - bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const( + } if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD) { + const bt_field_class_variant_with_selector_field_integer_unsigned_option *var_opt = + bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const( ir_var_fc, opt_i); opt_ranges = - bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const( + bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const( var_opt); } else { - const bt_field_class_variant_with_selector_signed_option *var_opt = - bt_field_class_variant_with_selector_signed_borrow_option_by_index_const( + const bt_field_class_variant_with_selector_field_integer_signed_option *var_opt = + bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const( ir_var_fc, opt_i); opt_ranges = - bt_field_class_variant_with_selector_signed_option_borrow_ranges_const( + bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const( var_opt); } /* Find corresponding mapping by range set in selector FC */ for (i = 0; i < bt_field_class_enumeration_get_mapping_count(ir_tag_fc); i++) { - if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR) { + if (ir_var_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD) { const bt_field_class_enumeration_mapping *mapping_base; const bt_field_class_enumeration_unsigned_mapping *mapping; const bt_integer_range_set_unsigned *mapping_ranges; @@ -845,7 +847,7 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, mapping_ranges = bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const( mapping); - if (bt_integer_range_set_unsigned_compare(opt_ranges, + if (bt_integer_range_set_unsigned_is_equal(opt_ranges, mapping_ranges)) { /* We have a winner */ mapping_base = @@ -866,7 +868,7 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, mapping_ranges = bt_field_class_enumeration_signed_mapping_borrow_ranges_const( mapping); - if (bt_integer_range_set_signed_compare(opt_ranges, + if (bt_integer_range_set_signed_is_equal(opt_ranges, mapping_ranges)) { /* We have a winner */ mapping_base = @@ -909,15 +911,53 @@ int must_protect_variant_option_name(const bt_field_class *ir_var_fc, ret = -1; goto end; } + } - /* - * If this comes from a `src.ctf.fs` source, it looks - * like the variant FC option name was initially - * protected: protect it again when going back to TSDL. - */ - *must_protect = true; +end: + return ret; +} + +static inline +int translate_option_field_class(struct ctx *ctx) +{ + struct fs_sink_ctf_field_class_option *fc = + fs_sink_ctf_field_class_option_create_empty( + cur_path_stack_top(ctx)->ir_fc, + cur_path_stack_top(ctx)->index_in_parent); + const bt_field_class *content_ir_fc = + bt_field_class_option_borrow_field_class_const(fc->base.ir_fc); + int ret; + + BT_ASSERT(fc); + + /* + * CTF 1.8 does not support the option field class type. To + * write something anyway, this component translates this type + * to a variant field class where the options are: + * + * * An empty structure field class. + * * The optional field class itself. + * + * The "tag" is always generated/before in that case (an 8-bit + * unsigned enumeration field class). + */ + append_to_parent_field_class(ctx, (void *) fc); + ret = cur_path_stack_push(ctx, UINT64_C(-1), NULL, false, content_ir_fc, + (void *) fc); + if (ret) { + BT_COMP_LOGE_STR("Cannot translate option field class content."); + goto end; + } + + ret = translate_field_class(ctx); + if (ret) { + BT_COMP_LOGE_STR("Cannot translate option field class content."); + goto end; } + cur_path_stack_pop(ctx); + update_parent_field_class_alignment(ctx, fc->base.alignment); + end: return ret; } @@ -944,9 +984,9 @@ int translate_variant_field_class(struct ctx *ctx) ir_fc_type = bt_field_class_get_type(fc->base.ir_fc); opt_count = bt_field_class_variant_get_option_count(fc->base.ir_fc); - if (ir_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || - ir_fc_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR) { - ir_selector_field_path = bt_field_class_variant_with_selector_borrow_selector_field_path_const( + if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD)) { + ir_selector_field_path = bt_field_class_variant_with_selector_field_borrow_selector_field_path_const( fc->base.ir_fc); BT_ASSERT(ir_selector_field_path); } @@ -963,14 +1003,14 @@ int translate_variant_field_class(struct ctx *ctx) bt_field_class_type type = bt_field_class_get_type( tgt_fc->ir_fc); - if (type != BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION && - type != BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION) { + if (!bt_field_class_type_is(type, + BT_FIELD_CLASS_TYPE_ENUMERATION)) { fc->tag_is_before = true; goto validate_opts; } /* - * Call must_protect_variant_option_name() for each + * Call maybe_protect_variant_option_name() for each * option below. In that case we also want selector FC * to contain as many mappings as the variant FC has * options. @@ -990,6 +1030,7 @@ int translate_variant_field_class(struct ctx *ctx) * create the appropriate selector field class. */ fc->tag_is_before = true; + goto validate_opts; } validate_opts: @@ -1004,12 +1045,13 @@ validate_opts: * cur_path_stack_push(). */ for (i = 0; i < opt_count; i++) { - bool must_protect = false; - - ret = must_protect_variant_option_name(fc->base.ir_fc, - tgt_fc->ir_fc, i, name_buf, &must_protect); - if (ret) { - fc->tag_is_before = true; + if (!fc->tag_is_before) { + BT_ASSERT(tgt_fc->ir_fc); + ret = maybe_protect_variant_option_name(fc->base.ir_fc, + tgt_fc->ir_fc, i, name_buf); + if (ret) { + fc->tag_is_before = true; + } } ret = bt_value_array_append_string_element(prot_opt_names, @@ -1035,7 +1077,7 @@ validate_opts: opt_name_b = bt_value_array_borrow_element_by_index_const( prot_opt_names, j); - if (bt_value_compare(opt_name_a, opt_name_b)) { + if (bt_value_is_equal(opt_name_a, opt_name_b)) { /* * Variant FC option names are not * unique when protected. @@ -1145,10 +1187,13 @@ int translate_dynamic_array_field_class(struct ctx *ctx) BT_ASSERT(fc); /* Resolve length field class before appending to parent */ - resolve_field_class(ctx, - bt_field_class_array_dynamic_borrow_length_field_path_const( - fc->base.base.ir_fc), - fc->length_ref, &fc->length_is_before, NULL); + if (bt_field_class_get_type(cur_path_stack_top(ctx)->ir_fc) == + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD) { + resolve_field_class(ctx, + bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const( + fc->base.base.ir_fc), + fc->length_ref, &fc->length_is_before, NULL); + } append_to_parent_field_class(ctx, (void *) fc); ret = cur_path_stack_push(ctx, UINT64_C(-1), NULL, false, elem_ir_fc, @@ -1171,6 +1216,32 @@ end: return ret; } +static inline +int translate_bool_field_class(struct ctx *ctx) +{ + struct fs_sink_ctf_field_class_bool *fc = + fs_sink_ctf_field_class_bool_create( + cur_path_stack_top(ctx)->ir_fc, + cur_path_stack_top(ctx)->index_in_parent); + + BT_ASSERT(fc); + append_to_parent_field_class(ctx, (void *) fc); + return 0; +} + +static inline +int translate_bit_array_field_class(struct ctx *ctx) +{ + struct fs_sink_ctf_field_class_bit_array *fc = + fs_sink_ctf_field_class_bit_array_create( + cur_path_stack_top(ctx)->ir_fc, + cur_path_stack_top(ctx)->index_in_parent); + + BT_ASSERT(fc); + append_to_parent_field_class(ctx, (void *) fc); + return 0; +} + static inline int translate_integer_field_class(struct ctx *ctx) { @@ -1221,36 +1292,36 @@ static int translate_field_class(struct ctx *ctx) { int ret; - - switch (bt_field_class_get_type(cur_path_stack_top(ctx)->ir_fc)) { - case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER: - case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER: - case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: - case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION: + bt_field_class_type ir_fc_type = + bt_field_class_get_type(cur_path_stack_top(ctx)->ir_fc); + + if (ir_fc_type == BT_FIELD_CLASS_TYPE_BOOL) { + ret = translate_bool_field_class(ctx); + } else if (ir_fc_type == BT_FIELD_CLASS_TYPE_BIT_ARRAY) { + ret = translate_bit_array_field_class(ctx); + } else if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_INTEGER)) { ret = translate_integer_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_REAL: + } else if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_REAL)) { ret = translate_real_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_STRING: + } else if (ir_fc_type == BT_FIELD_CLASS_TYPE_STRING) { ret = translate_string_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_STRUCTURE: + } else if (ir_fc_type == BT_FIELD_CLASS_TYPE_STRUCTURE) { ret = translate_structure_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_STATIC_ARRAY: + } else if (ir_fc_type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY) { ret = translate_static_array_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY: + } else if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)) { ret = translate_dynamic_array_field_class(ctx); - break; - case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: - case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: - case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: + } else if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_OPTION)) { + ret = translate_option_field_class(ctx); + } else if (bt_field_class_type_is(ir_fc_type, + BT_FIELD_CLASS_TYPE_VARIANT)) { ret = translate_variant_field_class(ctx); - break; - default: - abort(); + } else { + bt_common_abort(); } return ret; @@ -1277,6 +1348,30 @@ int set_field_ref(struct fs_sink_ctf_field_class *fc, const char *fc_name, } switch (fc->type) { + case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION: + { + /* + * CTF 1.8 does not support the option field class type. + * To write something anyway, this component translates + * this type to a variant field class where the options + * are: + * + * * An empty structure field class. + * * The optional field class itself. + * + * Because the option field class becomes a CTF variant + * field class, we use the term "tag" too here. + * + * The "tag" is always generated/before in that case (an + * 8-bit unsigned enumeration field class). + */ + struct fs_sink_ctf_field_class_option *opt_fc = (void *) fc; + + field_ref = opt_fc->tag_ref; + is_before = true; + tgt_type = "tag"; + break; + } case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE: { struct fs_sink_ctf_field_class_sequence *seq_fc = (void *) fc; @@ -1296,7 +1391,7 @@ int set_field_ref(struct fs_sink_ctf_field_class *fc, const char *fc_name, break; } default: - abort(); + bt_common_abort(); } BT_ASSERT(field_ref); @@ -1364,12 +1459,28 @@ int set_field_refs(struct fs_sink_ctf_field_class * const fc, fc_type = fc->type; switch (fc_type) { + case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION: + { + struct fs_sink_ctf_field_class_option *opt_fc = (void *) fc; + + ret = set_field_ref(fc, fc_name, parent_fc); + if (ret) { + goto end; + } + + ret = set_field_refs(opt_fc->content_fc, NULL, fc); + if (ret) { + goto end; + } + + break; + } case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT: case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT: { uint64_t i; uint64_t len; - struct fs_sink_ctf_field_class_struct *struct_fc; + struct fs_sink_ctf_field_class_struct *struct_fc = NULL; struct fs_sink_ctf_field_class_variant *var_fc = NULL; struct fs_sink_ctf_named_field_class *named_fc; @@ -1567,6 +1678,7 @@ end: return ret; } +static bool default_clock_class_name_exists(struct fs_sink_ctf_trace *trace, const char *name) { @@ -1646,7 +1758,6 @@ int translate_stream_class(struct fs_sink_comp *fs_sink, (*out_sc)->default_clock_class_name->str)) { /* Invalid: create a new name */ make_unique_default_clock_class_name(*out_sc); - ret = 0; } } else { /* No name: create a name */