Allow unset tags on variant field types
[babeltrace.git] / formats / ctf / ir / event-types.c
index a57aaf5a5c5556c5be12204afc9b2c9e705b8ff4..e7263d5cc55d802c2ae90eac8041a9f2c4849d84 100644 (file)
@@ -29,6 +29,7 @@
 #include <babeltrace/ctf-writer/event-types.h>
 #include <babeltrace/ctf-ir/event-types-internal.h>
 #include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ctf-ir/clock.h>
 #include <babeltrace/ctf-writer/writer-internal.h>
 #include <babeltrace/compiler.h>
 #include <babeltrace/endian.h>
@@ -150,19 +151,41 @@ type_serialize_func const type_serialize_funcs[] = {
 
 static
 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type *,
-               int byte_order);
+               int byte_order, int set_native);
+static
+void bt_ctf_field_type_enumeration_set_byte_order(struct bt_ctf_field_type *,
+               int byte_order, int set_native);
 static
 void bt_ctf_field_type_floating_point_set_byte_order(
-               struct bt_ctf_field_type *, int byte_order);
+               struct bt_ctf_field_type *, int byte_order, int set_native);
+static
+void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type *,
+               int byte_order, int set_native);
+static
+void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type *,
+               int byte_order, int set_native);
+static
+void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type *,
+               int byte_order, int set_native);
+static
+void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type *,
+               int byte_order, int set_native);
 
+/* The set_native flag only set the byte order if it is set to native */
 static
 void (* const set_byte_order_funcs[])(struct bt_ctf_field_type *,
-       int) = {
-       [CTF_TYPE_INTEGER] =
-               bt_ctf_field_type_integer_set_byte_order,
+               int byte_order, int set_native) = {
+       [CTF_TYPE_INTEGER] = bt_ctf_field_type_integer_set_byte_order,
+       [CTF_TYPE_ENUM] =
+               bt_ctf_field_type_enumeration_set_byte_order,
        [CTF_TYPE_FLOAT] =
                bt_ctf_field_type_floating_point_set_byte_order,
-       [CTF_TYPE_ENUM ... CTF_TYPE_SEQUENCE] = NULL,
+       [CTF_TYPE_STRUCT] =
+               bt_ctf_field_type_structure_set_byte_order,
+       [CTF_TYPE_VARIANT] = bt_ctf_field_type_variant_set_byte_order,
+       [CTF_TYPE_ARRAY] = bt_ctf_field_type_array_set_byte_order,
+       [CTF_TYPE_SEQUENCE] = bt_ctf_field_type_sequence_set_byte_order,
+       [CTF_TYPE_STRING] = NULL,
 };
 
 static
@@ -276,7 +299,6 @@ int add_structure_field(GPtrArray *fields,
                (gpointer) (unsigned long) name_quark,
                (gpointer) (unsigned long) fields->len);
        g_ptr_array_add(fields, field);
-       bt_ctf_field_type_freeze(field_type);
 end:
        return ret;
 }
@@ -314,12 +336,19 @@ int bt_ctf_field_type_validate(struct bt_ctf_field_type *type)
                goto end;
        }
 
-       if (type->declaration->id == CTF_TYPE_ENUM) {
+       switch (type->declaration->id) {
+       case CTF_TYPE_ENUM:
+       {
                struct bt_ctf_field_type_enumeration *enumeration =
                        container_of(type, struct bt_ctf_field_type_enumeration,
                        parent);
 
+               /* Ensure enum has entries */
                ret = enumeration->entries->len ? 0 : -1;
+               break;
+       }
+       default:
+               break;
        }
 end:
        return ret;
@@ -330,7 +359,7 @@ struct bt_ctf_field_type *bt_ctf_field_type_integer_create(unsigned int size)
        struct bt_ctf_field_type_integer *integer =
                g_new0(struct bt_ctf_field_type_integer, 1);
 
-       if (!integer || size > 64) {
+       if (!integer || size == 0 || size > 64) {
                return NULL;
        }
 
@@ -388,11 +417,6 @@ int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *type,
        }
 
        integer = container_of(type, struct bt_ctf_field_type_integer, parent);
-       if (is_signed && integer->declaration.len <= 1) {
-               ret = -1;
-               goto end;
-       }
-
        integer->declaration.signedness = !!is_signed;
 end:
        return ret;
@@ -479,6 +503,51 @@ end:
        return ret;
 }
 
+struct bt_ctf_clock *bt_ctf_field_type_integer_get_mapped_clock(
+               struct bt_ctf_field_type *type)
+{
+       struct bt_ctf_field_type_integer *integer;
+       struct bt_ctf_clock *clock = NULL;
+
+       if (!type) {
+               goto end;
+       }
+
+       integer = container_of(type, struct bt_ctf_field_type_integer, parent);
+       clock = integer->mapped_clock;
+       if (clock) {
+               bt_ctf_clock_get(clock);
+       }
+end:
+       return clock;
+}
+
+int bt_ctf_field_type_integer_set_mapped_clock(
+               struct bt_ctf_field_type *type,
+               struct bt_ctf_clock *clock)
+{
+       struct bt_ctf_field_type_integer *integer;
+       int ret = 0;
+
+       if (!type || type->frozen) {
+               ret = -1;
+               goto end;
+       }
+
+       integer = container_of(type, struct bt_ctf_field_type_integer, parent);
+       if (integer->mapped_clock) {
+               bt_ctf_clock_put(integer->mapped_clock);
+       }
+
+       if (clock) {
+               bt_ctf_clock_get(clock);
+       }
+
+       integer->mapped_clock = clock;
+end:
+       return ret;
+}
+
 struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create(
                struct bt_ctf_field_type *integer_container_type)
 {
@@ -1016,10 +1085,10 @@ struct bt_ctf_field_type *bt_ctf_field_type_structure_create(void)
 
        structure->parent.declaration = &structure->declaration.p;
        structure->parent.declaration->id = CTF_TYPE_STRUCT;
-       bt_ctf_field_type_init(&structure->parent);
        structure->fields = g_ptr_array_new_with_free_func(
                (GDestroyNotify)destroy_structure_field);
        structure->field_name_to_index = g_hash_table_new(NULL, NULL);
+       bt_ctf_field_type_init(&structure->parent);
        return &structure->parent;
 error:
        return NULL;
@@ -1141,8 +1210,7 @@ struct bt_ctf_field_type *bt_ctf_field_type_variant_create(
 {
        struct bt_ctf_field_type_variant *variant = NULL;
 
-       if (!enum_tag || bt_ctf_validate_identifier(tag_name) ||
-               (enum_tag->declaration->id != CTF_TYPE_ENUM)) {
+       if (tag_name && bt_ctf_validate_identifier(tag_name)) {
                goto error;
        }
 
@@ -1154,13 +1222,16 @@ struct bt_ctf_field_type *bt_ctf_field_type_variant_create(
        variant->parent.declaration = &variant->declaration.p;
        variant->parent.declaration->id = CTF_TYPE_VARIANT;
        variant->tag_name = g_string_new(tag_name);
-       bt_ctf_field_type_init(&variant->parent);
        variant->field_name_to_index = g_hash_table_new(NULL, NULL);
        variant->fields = g_ptr_array_new_with_free_func(
                (GDestroyNotify)destroy_structure_field);
-       bt_ctf_field_type_get(enum_tag);
-       variant->tag = container_of(enum_tag,
-               struct bt_ctf_field_type_enumeration, parent);
+       if (enum_tag) {
+               bt_ctf_field_type_get(enum_tag);
+               variant->tag = container_of(enum_tag,
+                       struct bt_ctf_field_type_enumeration, parent);
+       }
+
+       bt_ctf_field_type_init(&variant->parent);
        return &variant->parent;
 error:
        return NULL;
@@ -1177,6 +1248,10 @@ struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(
        }
 
        variant = container_of(type, struct bt_ctf_field_type_variant, parent);
+       if (!variant->tag) {
+               goto end;
+       }
+
        tag_type = &variant->tag->parent;
        bt_ctf_field_type_get(tag_type);
 end:
@@ -1194,6 +1269,10 @@ const char *bt_ctf_field_type_variant_get_tag_name(
        }
 
        variant = container_of(type, struct bt_ctf_field_type_variant, parent);
+       if (variant->tag_name->len == 0) {
+               goto end;
+       }
+
        tag_name = variant->tag_name->str;
 end:
        return tag_name;
@@ -1205,7 +1284,6 @@ int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *type,
 {
        size_t i;
        int ret = 0;
-       int name_found = 0;
        struct bt_ctf_field_type_variant *variant;
        GQuark field_name_quark = g_quark_from_string(field_name);
 
@@ -1218,19 +1296,31 @@ int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *type,
        }
 
        variant = container_of(type, struct bt_ctf_field_type_variant, parent);
-       /* Make sure this name is present in the enum tag */
-       for (i = 0; i < variant->tag->entries->len; i++) {
-               struct enumeration_mapping *mapping =
-                       g_ptr_array_index(variant->tag->entries, i);
 
-               if (mapping->string == field_name_quark) {
-                       name_found = 1;
-                       break;
+       /* The user has explicitly provided a tag; validate against it. */
+       if (variant->tag) {
+               int name_found = 0;
+
+               /* Make sure this name is present in the enum tag */
+               for (i = 0; i < variant->tag->entries->len; i++) {
+                       struct enumeration_mapping *mapping =
+                               g_ptr_array_index(variant->tag->entries, i);
+
+                       if (mapping->string == field_name_quark) {
+                               name_found = 1;
+                               break;
+                       }
+               }
+
+               if (!name_found) {
+                       /* Validation failed */
+                       ret = -1;
+                       goto end;
                }
        }
 
-       if (!name_found || add_structure_field(variant->fields,
-               variant->field_name_to_index, field_type, field_name)) {
+       if (add_structure_field(variant->fields, variant->field_name_to_index,
+               field_type, field_name)) {
                ret = -1;
                goto end;
        }
@@ -1358,10 +1448,11 @@ struct bt_ctf_field_type *bt_ctf_field_type_array_create(
 
        array->parent.declaration = &array->declaration.p;
        array->parent.declaration->id = CTF_TYPE_ARRAY;
-       bt_ctf_field_type_init(&array->parent);
+
        bt_ctf_field_type_get(element_type);
        array->element_type = element_type;
        array->length = length;
+       bt_ctf_field_type_init(&array->parent);
        array->parent.declaration->alignment =
                element_type->declaration->alignment;
        return &array->parent;
@@ -1420,10 +1511,10 @@ struct bt_ctf_field_type *bt_ctf_field_type_sequence_create(
 
        sequence->parent.declaration = &sequence->declaration.p;
        sequence->parent.declaration->id = CTF_TYPE_SEQUENCE;
-       bt_ctf_field_type_init(&sequence->parent);
        bt_ctf_field_type_get(element_type);
        sequence->element_type = element_type;
        sequence->length_field_name = g_string_new(length_field_name);
+       bt_ctf_field_type_init(&sequence->parent);
        sequence->parent.declaration->alignment =
                element_type->declaration->alignment;
        return &sequence->parent;
@@ -1560,6 +1651,7 @@ enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
                struct bt_ctf_field_type *type)
 {
        enum bt_ctf_byte_order ret = BT_CTF_BYTE_ORDER_UNKNOWN;
+       int internal_byte_order = -1;
 
        if (!type) {
                goto end;
@@ -1570,9 +1662,7 @@ enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
        {
                struct bt_ctf_field_type_integer *integer = container_of(
                        type, struct bt_ctf_field_type_integer, parent);
-               ret = integer->declaration.byte_order == LITTLE_ENDIAN ?
-                       BT_CTF_BYTE_ORDER_LITTLE_ENDIAN :
-                       BT_CTF_BYTE_ORDER_BIG_ENDIAN;
+               internal_byte_order = integer->declaration.byte_order;
                break;
        }
        case CTF_TYPE_FLOAT:
@@ -1581,13 +1671,25 @@ enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
                        container_of(type,
                                struct bt_ctf_field_type_floating_point,
                                parent);
-               ret = floating_point->declaration.byte_order == LITTLE_ENDIAN ?
-                       BT_CTF_BYTE_ORDER_LITTLE_ENDIAN :
-                       BT_CTF_BYTE_ORDER_BIG_ENDIAN;
+               internal_byte_order = floating_point->declaration.byte_order;
                break;
        }
        default:
+               goto end;
+       }
+
+       switch (internal_byte_order) {
+       case LITTLE_ENDIAN:
+               ret = BT_CTF_BYTE_ORDER_LITTLE_ENDIAN;
+               break;
+       case BIG_ENDIAN:
+               ret = BT_CTF_BYTE_ORDER_BIG_ENDIAN;
+               break;
+       case 0:
+               ret = BT_CTF_BYTE_ORDER_NATIVE;
                break;
+       default:
+               ret = BT_CTF_BYTE_ORDER_UNKNOWN;
        }
 end:
        return ret;
@@ -1608,8 +1710,8 @@ int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type,
        type_id = type->declaration->id;
        switch (byte_order) {
        case BT_CTF_BYTE_ORDER_NATIVE:
-               internal_byte_order = (G_BYTE_ORDER == G_LITTLE_ENDIAN ?
-                       LITTLE_ENDIAN : BIG_ENDIAN);
+               /* Leave unset. Will be initialized by parent. */
+               internal_byte_order = 0;
                break;
        case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
                internal_byte_order = LITTLE_ENDIAN;
@@ -1624,7 +1726,7 @@ int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type,
        }
 
        if (set_byte_order_funcs[type_id]) {
-               set_byte_order_funcs[type_id](type, internal_byte_order);
+               set_byte_order_funcs[type_id](type, internal_byte_order, 0);
        }
 end:
        return ret;
@@ -1763,6 +1865,21 @@ end:
        return ret;
 }
 
+BT_HIDDEN
+void bt_ctf_field_type_set_native_byte_order(struct bt_ctf_field_type *type,
+               int byte_order)
+{
+       if (!type) {
+               return;
+       }
+
+       assert(byte_order == LITTLE_ENDIAN || byte_order == BIG_ENDIAN);
+       if (set_byte_order_funcs[type->declaration->id]) {
+               set_byte_order_funcs[type->declaration->id](type,
+                       byte_order, 1);
+       }
+}
+
 static
 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref *ref)
 {
@@ -1775,6 +1892,9 @@ void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref *ref)
        integer = container_of(
                container_of(ref, struct bt_ctf_field_type, ref_count),
                struct bt_ctf_field_type_integer, parent);
+       if (integer->mapped_clock) {
+               bt_ctf_clock_put(integer->mapped_clock);
+       }
        g_free(integer);
 }
 
@@ -2013,15 +2133,31 @@ int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type *type,
 {
        struct bt_ctf_field_type_integer *integer = container_of(type,
                struct bt_ctf_field_type_integer, parent);
+       int ret = 0;
 
        g_string_append_printf(context->string,
-               "integer { size = %zu; align = %zu; signed = %s; encoding = %s; base = %s; byte_order = %s; }",
+               "integer { size = %zu; align = %zu; signed = %s; encoding = %s; base = %s; byte_order = %s",
                integer->declaration.len, type->declaration->alignment,
                (integer->declaration.signedness ? "true" : "false"),
                get_encoding_string(integer->declaration.encoding),
                get_integer_base_string(integer->declaration.base),
                get_byte_order_string(integer->declaration.byte_order));
-       return 0;
+       if (integer->mapped_clock) {
+               const char *clock_name = bt_ctf_clock_get_name(
+                       integer->mapped_clock);
+
+               if (!clock_name) {
+                       ret = -1;
+                       goto end;
+               }
+
+               g_string_append_printf(context->string,
+                       "; map = clock.%s.value", clock_name);
+       }
+
+       g_string_append(context->string, "; }");
+end:
+       return ret;
 }
 
 static
@@ -2190,8 +2326,13 @@ int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type *type,
        GString *variant_field_name = context->field_name;
 
        context->field_name = g_string_new("");
-       g_string_append_printf(context->string,
-               "variant <%s> {\n", variant->tag_name->str);
+       if (variant->tag_name->len > 0) {
+               g_string_append_printf(context->string,
+                       "variant <%s> {\n", variant->tag_name->str);
+       } else {
+               g_string_append(context->string, "variant {\n");
+       }
+
        context->current_indentation_level++;
        for (i = 0; i < variant->fields->len; i++) {
                struct structure_field *field = variant->fields->pdata[i];
@@ -2296,24 +2437,130 @@ int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type *type,
 
 static
 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type *type,
-               int byte_order)
+               int byte_order, int set_native)
 {
        struct bt_ctf_field_type_integer *integer_type = container_of(type,
                struct bt_ctf_field_type_integer, parent);
 
-       integer_type->declaration.byte_order = byte_order;
+       if (set_native) {
+               integer_type->declaration.byte_order =
+                       integer_type->declaration.byte_order == 0 ?
+                       byte_order : integer_type->declaration.byte_order;
+       } else {
+               integer_type->declaration.byte_order = byte_order;
+       }
+}
+
+static
+void bt_ctf_field_type_enumeration_set_byte_order(
+               struct bt_ctf_field_type *type, int byte_order, int set_native)
+{
+       struct bt_ctf_field_type_enumeration *enum_type = container_of(type,
+               struct bt_ctf_field_type_enumeration, parent);
+
+       /* Safe to assume that container is an integer */
+       bt_ctf_field_type_integer_set_byte_order(enum_type->container,
+               byte_order, set_native);
 }
 
 static
 void bt_ctf_field_type_floating_point_set_byte_order(
-               struct bt_ctf_field_type *type, int byte_order)
+               struct bt_ctf_field_type *type, int byte_order, int set_native)
 {
        struct bt_ctf_field_type_floating_point *floating_point_type =
                container_of(type, struct bt_ctf_field_type_floating_point,
                parent);
 
-       floating_point_type->declaration.byte_order = byte_order;
-       floating_point_type->sign.byte_order = byte_order;
-       floating_point_type->mantissa.byte_order = byte_order;
-       floating_point_type->exp.byte_order = byte_order;
+       if (set_native) {
+               floating_point_type->declaration.byte_order =
+                       floating_point_type->declaration.byte_order == 0 ?
+                       byte_order :
+                       floating_point_type->declaration.byte_order;
+               floating_point_type->sign.byte_order =
+                       floating_point_type->sign.byte_order == 0 ?
+                       byte_order : floating_point_type->sign.byte_order;
+               floating_point_type->mantissa.byte_order =
+                       floating_point_type->mantissa.byte_order == 0 ?
+                       byte_order : floating_point_type->mantissa.byte_order;
+               floating_point_type->exp.byte_order =
+                       floating_point_type->exp.byte_order == 0 ?
+                       byte_order : floating_point_type->exp.byte_order;
+       } else {
+               floating_point_type->declaration.byte_order = byte_order;
+               floating_point_type->sign.byte_order = byte_order;
+               floating_point_type->mantissa.byte_order = byte_order;
+               floating_point_type->exp.byte_order = byte_order;
+       }
+}
+
+static
+void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type *type,
+               int byte_order, int set_native)
+{
+       int i;
+       struct bt_ctf_field_type_structure *structure_type =
+               container_of(type, struct bt_ctf_field_type_structure,
+               parent);
+
+       for (i = 0; i < structure_type->fields->len; i++) {
+               struct structure_field *field = g_ptr_array_index(
+                       structure_type->fields, i);
+               struct bt_ctf_field_type *field_type = field->type;
+
+               if (set_byte_order_funcs[field_type->declaration->id]) {
+                       set_byte_order_funcs[field_type->declaration->id](
+                               field_type, byte_order, set_native);
+               }
+       }
+}
+
+static
+void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type *type,
+               int byte_order, int set_native)
+{
+       int i;
+       struct bt_ctf_field_type_variant *variant_type =
+               container_of(type, struct bt_ctf_field_type_variant,
+               parent);
+
+       for (i = 0; i < variant_type->fields->len; i++) {
+               struct structure_field *field = g_ptr_array_index(
+                       variant_type->fields, i);
+               struct bt_ctf_field_type *field_type = field->type;
+
+               if (set_byte_order_funcs[field_type->declaration->id]) {
+                       set_byte_order_funcs[field_type->declaration->id](
+                               field_type, byte_order, set_native);
+               }
+       }
+}
+
+static
+void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type *type,
+               int byte_order, int set_native)
+{
+       struct bt_ctf_field_type_array *array_type =
+               container_of(type, struct bt_ctf_field_type_array,
+               parent);
+
+       if (set_byte_order_funcs[array_type->element_type->declaration->id]) {
+               set_byte_order_funcs[array_type->element_type->declaration->id](
+                       array_type->element_type, byte_order, set_native);
+       }
+}
+
+static
+void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type *type,
+               int byte_order, int set_native)
+{
+       struct bt_ctf_field_type_sequence *sequence_type =
+               container_of(type, struct bt_ctf_field_type_sequence,
+               parent);
+
+       if (set_byte_order_funcs[
+               sequence_type->element_type->declaration->id]) {
+               set_byte_order_funcs[
+                       sequence_type->element_type->declaration->id](
+                       sequence_type->element_type, byte_order, set_native);
+       }
 }
This page took 0.030399 seconds and 4 git commands to generate.