Support the addition of integer trace environment fields

[babeltrace.git] / formats / ctf / ir / trace.c

diff --git a/formats/ctf/ir/trace.c b/formats/ctf/ir/trace.c
index 68bfd67afdab8e71ad38189ac104c397a2a5c98e..8d5f72705c5078b59cf848bfa60a897c293c0212 100644 (file)
--- a/formats/ctf/ir/trace.c
+++ b/formats/ctf/ir/trace.c
@@ -143,13 +143,6 @@ struct bt_ctf_stream *bt_ctf_trace_create_stream(struct bt_ctf_trace *trace,
                goto error;
        }
 
-       ret = bt_ctf_stream_class_set_byte_order(stream_class,
-               trace->byte_order == LITTLE_ENDIAN ?
-               BT_CTF_BYTE_ORDER_LITTLE_ENDIAN : BT_CTF_BYTE_ORDER_BIG_ENDIAN);
-       if (ret) {
-               goto error;
-       }
-
        stream = bt_ctf_stream_create(stream_class, trace);
        if (!stream) {
                goto error;
@@ -185,9 +178,25 @@ struct bt_ctf_stream *bt_ctf_trace_create_stream(struct bt_ctf_trace *trace,
 
        bt_ctf_stream_get(stream);
        g_ptr_array_add(trace->streams, stream);
+
+       /*
+        * Freeze the trace and its packet header.
+        *
+        * All field type byte orders set as "native" byte ordering can now be
+        * safely set to trace's own endianness, including the stream class'.
+        */
+       bt_ctf_field_type_set_native_byte_order(trace->packet_header_type,
+               trace->byte_order);
+       ret = bt_ctf_stream_class_set_byte_order(stream_class,
+               trace->byte_order == LITTLE_ENDIAN ?
+               BT_CTF_BYTE_ORDER_LITTLE_ENDIAN : BT_CTF_BYTE_ORDER_BIG_ENDIAN);
+       if (ret) {
+               goto error;
+       }
+
+       bt_ctf_stream_class_freeze(stream_class);
        trace->frozen = 1;
        return stream;
-
 error:
        bt_ctf_stream_put(stream);
        return NULL;
@@ -217,6 +226,7 @@ int bt_ctf_trace_add_environment_field(struct bt_ctf_trace *trace,
                goto error;
        }
 
+       var->type = BT_ENVIRONMENT_FIELD_TYPE_STRING;
        escaped_value = g_strescape(value, NULL);
        if (!escaped_value) {
                ret = -1;
@@ -224,9 +234,9 @@ int bt_ctf_trace_add_environment_field(struct bt_ctf_trace *trace,
        }
 
        var->name = g_string_new(name);
-       var->value = g_string_new(escaped_value);
+       var->value.string = g_string_new(escaped_value);
        g_free(escaped_value);
-       if (!var->name || !var->value) {
+       if (!var->name || !var->value.string) {
                ret = -1;
                goto error;
        }
@@ -239,8 +249,46 @@ error:
                g_string_free(var->name, TRUE);
        }
 
-       if (var && var->value) {
-               g_string_free(var->value, TRUE);
+       if (var && var->value.string) {
+               g_string_free(var->value.string, TRUE);
+       }
+
+       g_free(var);
+       return ret;
+}
+
+int bt_ctf_trace_add_environment_field_integer(struct bt_ctf_trace *trace,
+               const char *name,
+               int64_t value)
+{
+       struct environment_variable *var = NULL;
+       int ret = 0;
+
+       if (!trace || !name) {
+               ret = -1;
+               goto error;
+       }
+
+       var = g_new0(struct environment_variable, 1);
+       if (!var) {
+               ret = -1;
+               goto error;
+       }
+
+       var->type = BT_ENVIRONMENT_FIELD_TYPE_INTEGER;
+       var->name = g_string_new(name);
+       var->value.integer = value;
+       if (!var->name) {
+               ret = -1;
+               goto error;
+       }
+
+       g_ptr_array_add(trace->environment, var);
+       return ret;
+
+error:
+       if (var && var->name) {
+               g_string_free(var->name, TRUE);
        }
 
        g_free(var);
@@ -359,8 +407,18 @@ static
 void append_env_field_metadata(struct environment_variable *var,
                struct metadata_context *context)
 {
-       g_string_append_printf(context->string, "\t%s = \"%s\";\n",
-               var->name->str, var->value->str);
+       switch (var->type) {
+       case BT_ENVIRONMENT_FIELD_TYPE_STRING:
+               g_string_append_printf(context->string, "\t%s = \"%s\";\n",
+                       var->name->str, var->value.string->str);
+               break;
+       case BT_ENVIRONMENT_FIELD_TYPE_INTEGER:
+               g_string_append_printf(context->string, "\t%s = %" PRId64 ";\n",
+                       var->name->str, var->value.integer);
+               break;
+       default:
+               assert(0);
+       }
 }
 
 static
@@ -433,7 +491,16 @@ int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace,
 
        switch (byte_order) {
        case BT_CTF_BYTE_ORDER_NATIVE:
-               internal_byte_order =  (G_BYTE_ORDER == G_LITTLE_ENDIAN) ?
+               /*
+                * This doesn't make sense since the CTF specification defines
+                * the "native" byte order as "the byte order described in the
+                * trace description". However, this behavior had been
+                * implemented as part of v1.2 and is kept to maintain
+                * compatibility.
+                *
+                * This may be changed on a major version bump only.
+                */
+               internal_byte_order = (G_BYTE_ORDER == G_LITTLE_ENDIAN) ?
                        LITTLE_ENDIAN : BIG_ENDIAN;
                break;
        case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
@@ -449,9 +516,6 @@ int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace,
        }
 
        trace->byte_order = internal_byte_order;
-       if (trace->packet_header_type) {
-               init_trace_packet_header(trace);
-       }
 end:
        return ret;
 }
@@ -549,14 +613,6 @@ int init_trace_packet_header(struct bt_ctf_trace *trace)
                goto end;
        }
 
-       ret = bt_ctf_field_type_set_byte_order(_uint32_t,
-               (trace->byte_order == LITTLE_ENDIAN ?
-               BT_CTF_BYTE_ORDER_LITTLE_ENDIAN :
-               BT_CTF_BYTE_ORDER_BIG_ENDIAN));
-       if (ret) {
-               goto end;
-       }
-
        ret = bt_ctf_field_type_structure_add_field(trace_packet_header_type,
                _uint32_t, "magic");
        if (ret) {
@@ -575,17 +631,18 @@ int init_trace_packet_header(struct bt_ctf_trace *trace)
                goto end;
        }
 
-       bt_ctf_field_type_put(trace->packet_header_type);
-       trace->packet_header_type = trace_packet_header_type;
+       ret = bt_ctf_trace_set_packet_header_type(trace,
+               trace_packet_header_type);
+       if (ret) {
+               goto end;
+       }
 end:
        bt_ctf_field_type_put(uuid_array_type);
        bt_ctf_field_type_put(_uint32_t);
        bt_ctf_field_type_put(_uint8_t);
        bt_ctf_field_put(magic);
        bt_ctf_field_put(uuid_array);
-       if (ret) {
-               bt_ctf_field_type_put(trace_packet_header_type);
-       }
+       bt_ctf_field_type_put(trace_packet_header_type);
 
        return ret;
 }
@@ -594,6 +651,8 @@ static
 void environment_variable_destroy(struct environment_variable *var)
 {
        g_string_free(var->name, TRUE);
-       g_string_free(var->value, TRUE);
+       if (var->type == BT_ENVIRONMENT_FIELD_TYPE_STRING) {
+               g_string_free(var->value.string, TRUE);
+       }
        g_free(var);
 }