Create "untagged" variant structure

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/formats/ctf/metadata/ctf-visitor-generate-io-struct.c b/formats/ctf/metadata/ctf-visitor-generate-io-struct.c
index 499db793ac0b1eade3fa13b1a93e4c03995c7720..1a3fe585c7c1851c2d4b27f8f0e0b63ece073281 100644 (file)
--- a/formats/ctf/metadata/ctf-visitor-generate-io-struct.c
+++ b/formats/ctf/metadata/ctf-visitor-generate-io-struct.c
@@ -824,7 +824,7 @@ int _ctf_visitor(FILE *fd, int depth, struct ctf_node *node, struct ctf_trace *t
                        ret = ctf_typedef_visit(fd, depth + 1,
                                                &iter->u._typedef.declaration_specifier,
                                                &iter->u._typedef.type_declarators,
                        ret = ctf_typedef_visit(fd, depth + 1,
                                                &iter->u._typedef.declaration_specifier,
                                                &iter->u._typedef.type_declarators,

-                                               trace->declaration_scope);
+                                               trace->root_declaration_scope);

                        if (ret)
                                return ret;
                }
                        if (ret)
                                return ret;
                }


@@ -832,7 +832,7 @@ int _ctf_visitor(FILE *fd, int depth, struct ctf_node *node, struct ctf_trace *t
                                        siblings) {
                        ret = ctf_typealias_visit(fd, depth + 1,
                                        &iter->u.typealias.target, &iter->u.typealias.alias
                                        siblings) {
                        ret = ctf_typealias_visit(fd, depth + 1,
                                        &iter->u.typealias.target, &iter->u.typealias.alias

-                                       trace->declaration_scope);
+                                       trace->root_declaration_scope);

                        if (ret)
                                return ret;
                }
                        if (ret)
                                return ret;
                }

diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h
index 6fde4d18605a117529ba96fc5e5a4a4cefdc3988..c8e31337c7bf452baed599e0b3fd3dfd50998a53 100644 (file)
--- a/include/babeltrace/types.h
+++ b/include/babeltrace/types.h
@@ -123,6 +123,7 @@ enum ctf_type_id {
        CTF_TYPE_ENUM,
        CTF_TYPE_STRING,
        CTF_TYPE_STRUCT,
        CTF_TYPE_ENUM,
        CTF_TYPE_STRING,
        CTF_TYPE_STRUCT,

+       CTF_TYPE_UNTAGGED_VARIANT,

        CTF_TYPE_VARIANT,
        CTF_TYPE_ARRAY,
        CTF_TYPE_SEQUENCE,
        CTF_TYPE_VARIANT,
        CTF_TYPE_ARRAY,
        CTF_TYPE_SEQUENCE,


@@ -285,15 +286,20 @@ struct definition_struct {
        GArray *fields;                 /* Array of struct field */
 };
 
        GArray *fields;                 /* Array of struct field */
 };
 

-struct declaration_variant {
+struct declaration_untagged_variant {

        struct declaration p;
        GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
        struct declaration_scope *scope;
        GArray *fields;                 /* Array of declaration_field */
        struct declaration p;
        GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
        struct declaration_scope *scope;
        GArray *fields;                 /* Array of declaration_field */

-       GQuark tag_name;                /* TODO */
-       /* Tag name must be nonzero and must exist when defining the variant */

 };
 
 };
 

+struct declaration_variant {
+       struct declaration p;
+       struct declaration_untagged_variant *untagged_variant;
+       GArray *tag_name;               /* Array of GQuark */
+};
+
+/* A variant needs to be tagged to be defined. */

 struct definition_variant {
        struct definition p;
        struct declaration_variant *declaration;
 struct definition_variant {
        struct definition p;
        struct declaration_variant *declaration;


@@ -468,13 +474,16 @@ struct_get_field_from_index(struct definition_struct *struct_definition,
  * from numeric values to a single tag. Overlapping tag value ranges are
  * therefore forbidden.
  */
  * from numeric values to a single tag. Overlapping tag value ranges are
  * therefore forbidden.
  */

-struct declaration_variant *variant_declaration_new(const char *name,
+struct declaration_untagged_variant *untagged_variant_declaration_new(const char *name,

                struct declaration_scope *parent_scope);
                struct declaration_scope *parent_scope);

-void variant_declaration_add_field(struct declaration_variant *variant_declaration,
-               const char *tag_name,
-               struct declaration *tag_declaration);
+struct declaration_variant *variant_declaration_new(struct declaration_untagged_variant *untagged_variant,
+               const char *tag);
+
+void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+               const char *field_name,
+               struct declaration *field_declaration);

 struct declaration_field *
 struct declaration_field *

-       variant_declaration_get_field_from_tag(struct declaration_variant *variant_declaration,
+       untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration,

                GQuark tag);
 /*
  * Returns 0 on success, -EPERM on error.
                GQuark tag);
 /*
  * Returns 0 on success, -EPERM on error.


@@ -508,4 +517,9 @@ struct declaration_sequence *
                struct declaration *elem_declaration,
                struct declaration_scope *parent_scope);
 
                struct declaration *elem_declaration,
                struct declaration_scope *parent_scope);
 

+/*
+ * in: path (dot separated), out: q (GArray of GQuark)
+ */
+void append_scope_path(const char *path, GArray *q);
+

 #endif /* _BABELTRACE_declarationS_H */
 #endif /* _BABELTRACE_declarationS_H */

diff --git a/types/types.c b/types/types.c
index e57624fb707b73225b2400d4b8f29d192e828132..a8ead299d2cad665135671a6bc9110c262c4a06e 100644 (file)
--- a/types/types.c
+++ b/types/types.c
@@ -447,9 +447,8 @@ struct definition_scope *
 }
 
 /*
 }
 
 /*

- * in: path, out: q (GArray of GQuark)
+ * in: path (dot separated), out: q (GArray of GQuark)

  */
  */

-static

 void append_scope_path(const char *path, GArray *q)
 {
        const char *ptrbegin, *ptrend = path;
 void append_scope_path(const char *path, GArray *q)
 {
        const char *ptrbegin, *ptrend = path;

diff --git a/types/variant.c b/types/variant.c
index 4a8abcb1b406b40962a9a44d9cd3783e3c0b8170..2ab14a21cd4db6e9ecc031289553ff16702ed2d2 100644 (file)
--- a/types/variant.c
+++ b/types/variant.c
@@ -49,42 +49,73 @@ void variant_copy(struct stream_pos *dest, const struct format *fdest,
 }
 
 static
 }
 
 static

-void _variant_declaration_free(struct declaration *declaration)
+void _untagged_variant_declaration_free(struct declaration *declaration)

 {
 {

-       struct declaration_variant *variant_declaration =
-               container_of(declaration, struct declaration_variant, p);
+       struct declaration_untagged_variant *untagged_variant_declaration =
+               container_of(declaration, struct declaration_untagged_variant, p);

        unsigned long i;
 
        unsigned long i;
 

-       free_declaration_scope(variant_declaration->scope);
-       g_hash_table_destroy(variant_declaration->fields_by_tag);
+       free_declaration_scope(untagged_variant_declaration->scope);
+       g_hash_table_destroy(untagged_variant_declaration->fields_by_tag);

 
 

-       for (i = 0; i < variant_declaration->fields->len; i++) {
+       for (i = 0; i < untagged_variant_declaration->fields->len; i++) {

                struct declaration_field *declaration_field =
                struct declaration_field *declaration_field =

-                       &g_array_index(variant_declaration->fields,
+                       &g_array_index(untagged_variant_declaration->fields,

                                       struct declaration_field, i);
                declaration_unref(declaration_field->declaration);
        }
                                       struct declaration_field, i);
                declaration_unref(declaration_field->declaration);
        }

-       g_array_free(variant_declaration->fields, true);
-       g_free(variant_declaration);
+       g_array_free(untagged_variant_declaration->fields, true);
+       g_free(untagged_variant_declaration);

 }
 
 }
 

-struct declaration_variant *variant_declaration_new(const char *name,
+struct declaration_untagged_variant *untagged_variant_declaration_new(const char *name,

                                      struct declaration_scope *parent_scope)
 {
                                      struct declaration_scope *parent_scope)
 {

-       struct declaration_variant *variant_declaration;
+       struct declaration_untagged_variant *untagged_variant_declaration;

        struct declaration *declaration;
 
        struct declaration *declaration;
 

-       variant_declaration = g_new(struct declaration_variant, 1);
-       declaration = &variant_declaration->p;
-       variant_declaration->fields_by_tag = g_hash_table_new(g_direct_hash,
+       untagged_variant_declaration = g_new(struct declaration_untagged_variant, 1);
+       declaration = &untagged_variant_declaration->p;
+       untagged_variant_declaration->fields_by_tag = g_hash_table_new(g_direct_hash,

                                                       g_direct_equal);
                                                       g_direct_equal);

-       variant_declaration->fields = g_array_sized_new(FALSE, TRUE,
+       untagged_variant_declaration->fields = g_array_sized_new(FALSE, TRUE,

                                                 sizeof(struct declaration_field),
                                                 DEFAULT_NR_STRUCT_FIELDS);
                                                 sizeof(struct declaration_field),
                                                 DEFAULT_NR_STRUCT_FIELDS);

-       variant_declaration->scope = new_declaration_scope(parent_scope);
-       declaration->id = CTF_TYPE_VARIANT;
+       untagged_variant_declaration->scope = new_declaration_scope(parent_scope);
+       declaration->id = CTF_TYPE_UNTAGGED_VARIANT;

        declaration->name = g_quark_from_string(name);
        declaration->alignment = 1;
        declaration->name = g_quark_from_string(name);
        declaration->alignment = 1;

+       declaration->copy = NULL;
+       declaration->declaration_free = _untagged_variant_declaration_free;
+       declaration->definition_new = NULL;
+       declaration->definition_free = NULL;
+       declaration->ref = 1;
+       return untagged_variant_declaration;
+}
+
+static
+void _variant_declaration_free(struct declaration *declaration)
+{
+       struct declaration_variant *variant_declaration =
+               container_of(declaration, struct declaration_variant, p);
+
+       _untagged_variant_declaration_free(&variant_declaration->untagged_variant->p);
+       g_array_free(variant_declaration->tag_name, TRUE);
+}
+
+struct declaration_variant *
+       variant_declaration_new(struct declaration_untagged_variant *untagged_variant, const char *tag)
+{
+       struct declaration_variant *variant_declaration;
+       struct declaration *declaration;
+
+       variant_declaration = g_new(struct declaration_variant, 1);
+       declaration = &variant_declaration->p;
+       variant_declaration->untagged_variant = untagged_variant;
+       variant_declaration->tag_name = g_array_new(FALSE, TRUE, sizeof(GQuark));
+       append_scope_path(tag, variant_declaration->tag_name);
+       declaration->id = CTF_TYPE_VARIANT;
+       declaration->alignment = 1;

        declaration->copy = variant_copy;
        declaration->declaration_free = _variant_declaration_free;
        declaration->definition_new = _variant_definition_new;
        declaration->copy = variant_copy;
        declaration->declaration_free = _variant_declaration_free;
        declaration->definition_new = _variant_definition_new;


@@ -93,6 +124,53 @@ struct declaration_variant *variant_declaration_new(const char *name,
        return variant_declaration;
 }
 
        return variant_declaration;
 }
 

+/*
+ * tag_instance is assumed to be an enumeration.
+ * Returns 0 if OK, < 0 if error.
+ */
+static
+int check_enum_tag(struct definition_variant *variant,
+                  struct definition *enum_tag)
+{
+       struct definition_enum *_enum =
+               container_of(enum_tag, struct definition_enum, p);
+       struct declaration_enum *enum_declaration = _enum->declaration;
+       int missing_field = 0;
+       unsigned long i;
+
+       /*
+        * Strictly speaking, each enumerator must map to a field of the
+        * variant. However, we are even stricter here by requiring that each
+        * variant choice map to an enumerator too. We then validate that the
+        * number of enumerators equals the number of variant choices.
+        */
+       if (variant->declaration->untagged_variant->fields->len != enum_get_nr_enumerators(enum_declaration))
+               return -EPERM;
+
+       for (i = 0; i < variant->declaration->untagged_variant->fields->len; i++) {
+               struct declaration_field *field_declaration =
+                       &g_array_index(variant->declaration->untagged_variant->fields,
+                                      struct declaration_field, i);
+               if (!enum_quark_to_range_set(enum_declaration, field_declaration->name)) {
+                       missing_field = 1;
+                       break;
+               }
+       }
+       if (missing_field)
+               return -EPERM;
+
+       /*
+        * Check the enumeration: it must map each value to one and only one
+        * enumerator tag.
+        * TODO: we should also check that each range map to one and only one
+        * tag. For the moment, we will simply check this dynamically in
+        * variant_declaration_get_current_field().
+        */
+       return 0;
+}
+
+
+

 static
 struct definition *
        _variant_definition_new(struct declaration *declaration,
 static
 struct definition *
        _variant_definition_new(struct declaration *declaration,


@@ -111,13 +189,21 @@ struct definition *
        variant->p.ref = 1;
        variant->p.index = index;
        variant->scope = new_definition_scope(parent_scope, field_name);
        variant->p.ref = 1;
        variant->p.index = index;
        variant->scope = new_definition_scope(parent_scope, field_name);

+       variant->enum_tag = lookup_definition(variant->scope->scope_path,
+                                             variant_declaration->tag_name,
+                                             parent_scope);
+                                             
+       if (!variant->enum_tag
+           || check_enum_tag(variant, variant->enum_tag) < 0)
+               goto error;
+       definition_ref(variant->enum_tag);

        variant->fields = g_array_sized_new(FALSE, TRUE,
                                            sizeof(struct field),
        variant->fields = g_array_sized_new(FALSE, TRUE,
                                            sizeof(struct field),

-                                           DEFAULT_NR_STRUCT_FIELDS);
-       g_array_set_size(variant->fields, variant_declaration->fields->len);
-       for (i = 0; i < variant_declaration->fields->len; i++) {
+                                           variant_declaration->untagged_variant->fields->len);
+       g_array_set_size(variant->fields, variant_declaration->untagged_variant->fields->len);
+       for (i = 0; i < variant_declaration->untagged_variant->fields->len; i++) {

                struct declaration_field *declaration_field =
                struct declaration_field *declaration_field =

-                       &g_array_index(variant_declaration->fields,
+                       &g_array_index(variant_declaration->untagged_variant->fields,

                                       struct declaration_field, i);
                struct field *field = &g_array_index(variant->fields,
                                                     struct field, i);
                                       struct declaration_field, i);
                struct field *field = &g_array_index(variant->fields,
                                                     struct field, i);


@@ -134,6 +220,11 @@ struct definition *
        }
        variant->current_field = NULL;
        return &variant->p;
        }
        variant->current_field = NULL;
        return &variant->p;

+error:
+       free_definition_scope(variant->scope);
+       declaration_unref(&variant_declaration->p);
+       g_free(variant);
+       return NULL;

 }
 
 static
 }
 
 static


@@ -143,32 +234,33 @@ void _variant_definition_free(struct definition *definition)
                container_of(definition, struct definition_variant, p);
        unsigned long i;
 
                container_of(definition, struct definition_variant, p);
        unsigned long i;
 

-       assert(variant->fields->len == variant->declaration->fields->len);
+       assert(variant->fields->len == variant->declaration->untagged_variant->fields->len);

        for (i = 0; i < variant->fields->len; i++) {
                struct field *field = &g_array_index(variant->fields,
                                                     struct field, i);
                definition_unref(field->definition);
        }
        for (i = 0; i < variant->fields->len; i++) {
                struct field *field = &g_array_index(variant->fields,
                                                     struct field, i);
                definition_unref(field->definition);
        }

+       definition_unref(variant->enum_tag);

        free_definition_scope(variant->scope);
        declaration_unref(variant->p.declaration);
        g_free(variant);
 }
 
        free_definition_scope(variant->scope);
        declaration_unref(variant->p.declaration);
        g_free(variant);
 }
 

-void variant_declaration_add_field(struct declaration_variant *variant_declaration,
-                           const char *tag_name,
-                           struct declaration *tag_declaration)
+void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+                           const char *field_name,
+                           struct declaration *field_declaration)

 {
        struct declaration_field *field;
        unsigned long index;
 
 {
        struct declaration_field *field;
        unsigned long index;
 

-       g_array_set_size(variant_declaration->fields, variant_declaration->fields->len + 1);
-       index = variant_declaration->fields->len - 1;   /* last field (new) */
-       field = &g_array_index(variant_declaration->fields, struct declaration_field, index);
-       field->name = g_quark_from_string(tag_name);
-       declaration_ref(tag_declaration);
-       field->declaration = tag_declaration;
+       g_array_set_size(untagged_variant_declaration->fields, untagged_variant_declaration->fields->len + 1);
+       index = untagged_variant_declaration->fields->len - 1;  /* last field (new) */
+       field = &g_array_index(untagged_variant_declaration->fields, struct declaration_field, index);
+       field->name = g_quark_from_string(field_name);
+       declaration_ref(field_declaration);
+       field->declaration = field_declaration;

        /* Keep index in hash rather than pointer, because array can relocate */
        /* Keep index in hash rather than pointer, because array can relocate */

-       g_hash_table_insert(variant_declaration->fields_by_tag,
+       g_hash_table_insert(untagged_variant_declaration->fields_by_tag,

                            (gpointer) (unsigned long) field->name,
                            (gpointer) index);
        /*
                            (gpointer) (unsigned long) field->name,
                            (gpointer) index);
        /*


@@ -179,59 +271,13 @@ void variant_declaration_add_field(struct declaration_variant *variant_declarati
 }
 
 struct declaration_field *
 }
 
 struct declaration_field *

-struct_declaration_get_field_from_tag(struct declaration_variant *variant_declaration, GQuark tag)
+untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag)

 {
        unsigned long index;
 
 {
        unsigned long index;
 

-       index = (unsigned long) g_hash_table_lookup(variant_declaration->fields_by_tag,
+       index = (unsigned long) g_hash_table_lookup(untagged_variant_declaration->fields_by_tag,

                                                    (gconstpointer) (unsigned long) tag);
                                                    (gconstpointer) (unsigned long) tag);

-       return &g_array_index(variant_declaration->fields, struct declaration_field, index);
-}
-
-/*
- * tag_instance is assumed to be an enumeration.
- */
-int variant_definition_set_tag(struct definition_variant *variant,
-                              struct definition *enum_tag)
-{
-       struct definition_enum *_enum =
-               container_of(variant->enum_tag, struct definition_enum, p);
-       struct declaration_enum *enum_declaration = _enum->declaration;
-       int missing_field = 0;
-       unsigned long i;
-
-       /*
-        * Strictly speaking, each enumerator must map to a field of the
-        * variant. However, we are even stricter here by requiring that each
-        * variant choice map to an enumerator too. We then validate that the
-        * number of enumerators equals the number of variant choices.
-        */
-       if (variant->declaration->fields->len != enum_get_nr_enumerators(enum_declaration))
-               return -EPERM;
-
-       for (i = 0; i < variant->declaration->fields->len; i++) {
-               struct declaration_field *field_declaration =
-                       &g_array_index(variant->declaration->fields,
-                                      struct declaration_field, i);
-               if (!enum_quark_to_range_set(enum_declaration, field_declaration->name)) {
-                       missing_field = 1;
-                       break;
-               }
-       }
-       if (missing_field)
-               return -EPERM;
-
-       /*
-        * Check the enumeration: it must map each value to one and only one
-        * enumerator tag.
-        * TODO: we should also check that each range map to one and only one
-        * tag. For the moment, we will simply check this dynamically in
-        * variant_declaration_get_current_field().
-        */
-
-       /* Set the enum tag field */
-       variant->enum_tag = enum_tag;
-       return 0;
+       return &g_array_index(untagged_variant_declaration->fields, struct declaration_field, index);

 }
 
 /*
 }
 
 /*


@@ -253,7 +299,7 @@ struct field *variant_get_current_field(struct definition_variant *variant)
         */
        assert(tag_array->len == 1);
        tag = g_array_index(tag_array, GQuark, 0);
         */
        assert(tag_array->len == 1);
        tag = g_array_index(tag_array, GQuark, 0);

-       index = (unsigned long) g_hash_table_lookup(variant_declaration->fields_by_tag,
+       index = (unsigned long) g_hash_table_lookup(variant_declaration->untagged_variant->fields_by_tag,

                                                    (gconstpointer) (unsigned long) tag);
        variant->current_field = &g_array_index(variant->fields, struct field, index);
        return variant->current_field;
                                                    (gconstpointer) (unsigned long) tag);
        variant->current_field = &g_array_index(variant->fields, struct field, index);
        return variant->current_field;