Unify reference counting using a common bt_object base
[babeltrace.git] / formats / ctf / ir / stream.c
index ce909bf4535696df0af262272d16159048519c9e..6a6a3a77f57580bc2069a3b96f7d57fdba18520d 100644 (file)
 #include <babeltrace/ctf-ir/stream.h>
 #include <babeltrace/ctf-ir/stream-internal.h>
 #include <babeltrace/ctf-ir/stream-class-internal.h>
+#include <babeltrace/ref.h>
 #include <babeltrace/ctf-writer/functor-internal.h>
 #include <babeltrace/compiler.h>
 #include <babeltrace/align.h>
+#include <babeltrace/ctf/ctf-index.h>
 
 static
-void bt_ctf_stream_destroy(struct bt_ctf_ref *ref);
+void bt_ctf_stream_destroy(struct bt_object *obj);
 static
 int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
 
+static
+int set_packet_header_magic(struct bt_ctf_stream *stream)
+{
+       int ret = 0;
+       struct bt_ctf_field_type *magic_field_type = NULL;
+       struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field(
+               stream->packet_header, "magic");
+
+       if (!magic_field) {
+               /* No magic field found. Not an error, skip. */
+               goto end;
+       }
+
+       if (!bt_ctf_field_validate(magic_field)) {
+               /* Value already set. Not an error, skip. */
+               goto end;
+       }
+
+       magic_field_type = bt_ctf_field_get_type(magic_field);
+       assert(magic_field_type);
+
+       if (bt_ctf_field_type_get_type_id(magic_field_type) !=
+               CTF_TYPE_INTEGER) {
+               /* Magic field is not an integer. Not an error, skip. */
+               goto end;
+       }
+
+       if (bt_ctf_field_type_integer_get_size(magic_field_type) != 32) {
+               /*
+                * Magic field is not of the expected size.
+                * Not an error, skip.
+                */
+               goto end;
+       }
+
+       ret = bt_ctf_field_type_integer_get_signed(magic_field_type);
+       assert(ret >= 0);
+       if (ret) {
+               ret = bt_ctf_field_signed_integer_set_value(magic_field,
+                       (int64_t) 0xC1FC1FC1);
+       } else {
+               ret = bt_ctf_field_unsigned_integer_set_value(magic_field,
+                       (uint64_t) 0xC1FC1FC1);
+       }
+end:
+       bt_put(magic_field);
+       bt_put(magic_field_type);
+       return ret;
+}
+
+static
+int set_packet_header_uuid(struct bt_ctf_stream *stream)
+{
+       int i, ret = 0;
+       struct bt_ctf_field_type *uuid_field_type = NULL;
+       struct bt_ctf_field_type *element_field_type = NULL;
+       struct bt_ctf_field *uuid_field = bt_ctf_field_structure_get_field(
+               stream->packet_header, "uuid");
+
+       if (!uuid_field) {
+               /* No uuid field found. Not an error, skip. */
+               goto end;
+       }
+
+       if (!bt_ctf_field_validate(uuid_field)) {
+               /* Value already set. Not an error, skip. */
+               goto end;
+       }
+
+       uuid_field_type = bt_ctf_field_get_type(uuid_field);
+       assert(uuid_field_type);
+       if (bt_ctf_field_type_get_type_id(uuid_field_type) !=
+               CTF_TYPE_ARRAY) {
+               /* UUID field is not an array. Not an error, skip. */
+               goto end;
+       }
+
+       if (bt_ctf_field_type_array_get_length(uuid_field_type) != 16) {
+               /*
+                * UUID field is not of the expected size.
+                * Not an error, skip.
+                */
+               goto end;
+       }
+
+       element_field_type = bt_ctf_field_type_array_get_element_type(
+               uuid_field_type);
+       assert(element_field_type);
+       if (bt_ctf_field_type_get_type_id(element_field_type) !=
+               CTF_TYPE_INTEGER) {
+               /* UUID array elements are not integers. Not an error, skip */
+               goto end;
+       }
+
+       for (i = 0; i < 16; i++) {
+               struct bt_ctf_field *uuid_element =
+                       bt_ctf_field_array_get_field(uuid_field, i);
+
+               ret = bt_ctf_field_type_integer_get_signed(element_field_type);
+               assert(ret >= 0);
+
+               if (ret) {
+                       ret = bt_ctf_field_signed_integer_set_value(
+                               uuid_element, (int64_t) stream->trace->uuid[i]);
+               } else {
+                       ret = bt_ctf_field_unsigned_integer_set_value(
+                               uuid_element,
+                               (uint64_t) stream->trace->uuid[i]);
+               }
+               bt_put(uuid_element);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+end:
+       bt_put(uuid_field);
+       bt_put(uuid_field_type);
+       bt_put(element_field_type);
+       return ret;
+}
+static
+int set_packet_header_stream_id(struct bt_ctf_stream *stream)
+{
+       int ret = 0;
+       uint32_t stream_id;
+       struct bt_ctf_field_type *stream_id_field_type = NULL;
+       struct bt_ctf_field *stream_id_field = bt_ctf_field_structure_get_field(
+               stream->packet_header, "stream_id");
+
+       if (!stream_id_field) {
+               /* No stream_id field found. Not an error, skip. */
+               goto end;
+       }
+
+       if (!bt_ctf_field_validate(stream_id_field)) {
+               /* Value already set. Not an error, skip. */
+               goto end;
+       }
+
+       stream_id_field_type = bt_ctf_field_get_type(stream_id_field);
+       assert(stream_id_field_type);
+       if (bt_ctf_field_type_get_type_id(stream_id_field_type) !=
+               CTF_TYPE_INTEGER) {
+               /* stream_id field is not an integer. Not an error, skip. */
+               goto end;
+       }
+
+       stream_id = stream->stream_class->id;
+       ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type);
+       assert(ret >= 0);
+       if (ret) {
+               ret = bt_ctf_field_signed_integer_set_value(stream_id_field,
+                       (int64_t) stream_id);
+       } else {
+               ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field,
+                       (uint64_t) stream_id);
+       }
+end:
+       bt_put(stream_id_field);
+       bt_put(stream_id_field_type);
+       return ret;
+}
+
+static
+int set_packet_header(struct bt_ctf_stream *stream)
+{
+       int ret;
+
+       ret = set_packet_header_magic(stream);
+       if (ret) {
+               goto end;
+       }
+
+       ret = set_packet_header_uuid(stream);
+       if (ret) {
+               goto end;
+       }
+
+       ret = set_packet_header_stream_id(stream);
+       if (ret) {
+               goto end;
+       }
+end:
+       return ret;
+}
+
+static
+void put_event(struct bt_ctf_event *event)
+{
+       bt_ctf_event_set_stream(event, NULL);
+       bt_put(event);
+}
+
 BT_HIDDEN
 struct bt_ctf_stream *bt_ctf_stream_create(
-               struct bt_ctf_stream_class *stream_class)
+       struct bt_ctf_stream_class *stream_class,
+       struct bt_ctf_trace *trace)
 {
        int ret;
        struct bt_ctf_stream *stream = NULL;
 
-       if (!stream_class) {
+       if (!stream_class || !trace) {
                goto end;
        }
 
@@ -60,11 +257,13 @@ struct bt_ctf_stream *bt_ctf_stream_create(
                goto end;
        }
 
-       bt_ctf_ref_init(&stream->ref_count);
+       /* A stream has no ownership of its trace (weak ptr) */
+       stream->trace = trace;
+       bt_object_init(stream, bt_ctf_stream_destroy);
        stream->packet_context = bt_ctf_field_create(
                stream_class->packet_context_type);
        if (!stream->packet_context) {
-               goto error_destroy;
+               goto error;
        }
 
        /*
@@ -77,7 +276,7 @@ struct bt_ctf_stream *bt_ctf_stream_create(
                stream->event_context = bt_ctf_field_create(
                        stream_class->event_context_type);
                if (!stream->packet_context) {
-                       goto error_destroy;
+                       goto error;
                }
        }
 
@@ -85,63 +284,80 @@ struct bt_ctf_stream *bt_ctf_stream_create(
        ret = set_structure_field_integer(stream->packet_context,
                "events_discarded", 0);
        if (ret) {
-               goto error_destroy;
+               goto error;
        }
 
        stream->pos.fd = -1;
        stream->id = stream_class->next_stream_id++;
        stream->stream_class = stream_class;
-       bt_ctf_stream_class_get(stream_class);
-       bt_ctf_stream_class_freeze(stream_class);
+       bt_get(stream_class);
        stream->events = g_ptr_array_new_with_free_func(
-               (GDestroyNotify) bt_ctf_event_put);
+               (GDestroyNotify) put_event);
        if (!stream->events) {
-               goto error_destroy;
+               goto error;
        }
        if (stream_class->event_context_type) {
                stream->event_contexts = g_ptr_array_new_with_free_func(
                        (GDestroyNotify) bt_ctf_field_put);
                if (!stream->event_contexts) {
-                       goto error_destroy;
+                       goto error;
                }
        }
+
+       /* A trace is not allowed to have a NULL packet header */
+       assert(trace->packet_header_type);
+       stream->packet_header = bt_ctf_field_create(trace->packet_header_type);
+       if (!stream->packet_header) {
+               goto error;
+       }
+       /*
+        * Attempt to populate the default trace packet header fields
+        * (magic, uuid and stream_id). This will _not_ fail shall the
+        * fields not be found or be of an incompatible type; they will
+        * simply not be populated automatically. The user will have to
+        * make sure to set the trace packet header fields himself before
+        * flushing.
+        */
+       ret = set_packet_header(stream);
+       if (ret) {
+               goto error;
+       }
 end:
        return stream;
-error_destroy:
-       bt_ctf_stream_destroy(&stream->ref_count);
-       return NULL;
+error:
+       BT_PUT(stream);
+       return stream;
 }
 
 BT_HIDDEN
-int bt_ctf_stream_set_flush_callback(struct bt_ctf_stream *stream,
-       flush_func callback, void *data)
+int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd)
 {
-       int ret = stream ? 0 : -1;
+       int ret = 0;
 
-       if (!stream) {
+       if (stream->pos.fd != -1) {
+               ret = -1;
                goto end;
        }
 
-       stream->flush.func = callback;
-       stream->flush.data = data;
+       ctf_init_pos(&stream->pos, NULL, fd, O_RDWR);
+       stream->pos.fd = fd;
 end:
        return ret;
 }
 
-BT_HIDDEN
-int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd)
+struct bt_ctf_stream_class *bt_ctf_stream_get_class(
+               struct bt_ctf_stream *stream)
 {
-       int ret = 0;
+       struct bt_ctf_stream_class *stream_class = NULL;
 
-       if (stream->pos.fd != -1) {
-               ret = -1;
+       if (!stream) {
                goto end;
        }
 
-       ctf_init_pos(&stream->pos, NULL, fd, O_RDWR);
-       stream->pos.fd = fd;
+       stream_class = stream->stream_class;
+       bt_get(stream_class);
 end:
-       return ret;
+       return stream_class;
 }
 
 int bt_ctf_stream_get_discarded_events_count(
@@ -200,12 +416,8 @@ int bt_ctf_stream_get_discarded_events_count(
                }
        }
 end:
-       if (events_discarded_field) {
-               bt_ctf_field_put(events_discarded_field);
-       }
-       if (events_discarded_field_type) {
-               bt_ctf_field_type_put(events_discarded_field_type);
-       }
+       bt_put(events_discarded_field);
+       bt_put(events_discarded_field_type);
        return ret;
 }
 
@@ -263,19 +475,14 @@ void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
        }
 
 end:
-       if (events_discarded_field) {
-               bt_ctf_field_put(events_discarded_field);
-       }
-       if (events_discarded_field_type) {
-               bt_ctf_field_type_put(events_discarded_field_type);
-       }
+       bt_put(events_discarded_field);
+       bt_put(events_discarded_field_type);
 }
 
 int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                struct bt_ctf_event *event)
 {
        int ret = 0;
-       uint64_t timestamp;
        struct bt_ctf_field *event_context_copy = NULL;
 
        if (!stream || !event) {
@@ -283,6 +490,19 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                goto end;
        }
 
+       ret = bt_ctf_event_set_stream(event, stream);
+       if (ret) {
+               /* Event was already associated to a stream */
+               ret = -1;
+               goto end;
+       }
+
+       ret = bt_ctf_event_populate_event_header(event);
+       if (ret) {
+               goto end;
+       }
+
+       /* Make sure the event's payload is set */
        ret = bt_ctf_event_validate(event);
        if (ret) {
                goto end;
@@ -303,19 +523,16 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                }
        }
 
-       timestamp = bt_ctf_clock_get_time(stream->stream_class->clock);
-       ret = bt_ctf_event_set_timestamp(event, timestamp);
-       if (ret) {
-               goto end;
-       }
-
-       bt_ctf_event_get(event);
+       bt_get(event);
        /* Save the new event along with its associated stream event context */
        g_ptr_array_add(stream->events, event);
        if (event_context_copy) {
                g_ptr_array_add(stream->event_contexts, event_context_copy);
        }
 end:
+       if (ret) {
+               (void) bt_ctf_event_set_stream(event, NULL);
+       }
        return ret;
 }
 
@@ -329,10 +546,10 @@ struct bt_ctf_field *bt_ctf_stream_get_packet_context(
        }
 
        packet_context = stream->packet_context;
-end:
        if (packet_context) {
-               bt_ctf_field_get(packet_context);
+               bt_get(packet_context);
        }
+end:
        return packet_context;
 }
 
@@ -353,9 +570,9 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
                goto end;
        }
 
-       bt_ctf_field_type_put(field_type);
-       bt_ctf_field_get(field);
-       bt_ctf_field_put(stream->packet_context);
+       bt_put(field_type);
+       bt_get(field);
+       bt_put(stream->packet_context);
        stream->packet_context = field;
 end:
        return ret;
@@ -372,7 +589,7 @@ struct bt_ctf_field *bt_ctf_stream_get_event_context(
 
        event_context = stream->event_context;
        if (event_context) {
-               bt_ctf_field_get(event_context);
+               bt_get(event_context);
        }
 end:
        return event_context;
@@ -395,13 +612,97 @@ int bt_ctf_stream_set_event_context(struct bt_ctf_stream *stream,
                goto end;
        }
 
-       bt_ctf_field_get(field);
-       bt_ctf_field_put(stream->event_context);
+       bt_get(field);
+       bt_put(stream->event_context);
        stream->event_context = field;
 end:
-       if (field_type) {
-               bt_ctf_field_type_put(field_type);
+       bt_put(field_type);
+       return ret;
+}
+
+struct bt_ctf_field *bt_ctf_stream_get_packet_header(
+               struct bt_ctf_stream *stream)
+{
+       struct bt_ctf_field *packet_header = NULL;
+
+       if (!stream) {
+               goto end;
+       }
+
+       packet_header = stream->packet_header;
+       if (packet_header) {
+               bt_get(packet_header);
+       }
+end:
+       return packet_header;
+}
+
+int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
+               struct bt_ctf_field *field)
+{
+       int ret = 0;
+       struct bt_ctf_field_type *field_type = NULL;
+
+       if (!stream || !field) {
+               ret = -1;
+               goto end;
        }
+
+       field_type = bt_ctf_field_get_type(field);
+       if (field_type != stream->trace->packet_header_type) {
+               ret = -1;
+               goto end;
+       }
+
+       bt_get(field);
+       bt_put(stream->packet_header);
+       stream->packet_header = field;
+end:
+       bt_put(field_type);
+       return ret;
+}
+
+static
+int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp)
+{
+       int ret = 0;
+       struct bt_ctf_field *timestamp_field = NULL;
+       struct bt_ctf_field_type *timestamp_field_type = NULL;
+
+       timestamp_field = bt_ctf_field_structure_get_field(event_header,
+               "timestamp");
+       if (!timestamp_field) {
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_field_type = bt_ctf_field_get_type(timestamp_field);
+       assert(timestamp_field_type);
+       if (bt_ctf_field_type_get_type_id(timestamp_field_type) !=
+               CTF_TYPE_INTEGER) {
+               ret = -1;
+               goto end;
+       }
+
+       if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) {
+               int64_t val;
+
+               ret = bt_ctf_field_signed_integer_get_value(timestamp_field,
+                       &val);
+               if (ret) {
+                       goto end;
+               }
+               *timestamp = (uint64_t) val;
+       } else {
+               ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field,
+                       timestamp);
+               if (ret) {
+                       goto end;
+               }
+       }
+end:
+       bt_put(timestamp_field);
+       bt_put(timestamp_field_type);
        return ret;
 }
 
@@ -410,7 +711,6 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
        int ret = 0;
        size_t i;
        uint64_t timestamp_begin, timestamp_end, events_discarded;
-       struct bt_ctf_stream_class *stream_class;
        struct bt_ctf_field *integer = NULL;
        struct ctf_stream_pos packet_context_pos;
 
@@ -427,29 +727,41 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
                goto end;
        }
 
-       if (stream->flush.func) {
-               stream->flush.func(stream, stream->flush.data);
+       ret = bt_ctf_field_validate(stream->packet_header);
+       if (ret) {
+               goto end;
        }
 
-       stream_class = stream->stream_class;
-       timestamp_begin = ((struct bt_ctf_event *) g_ptr_array_index(
-               stream->events, 0))->timestamp;
-       timestamp_end = ((struct bt_ctf_event *) g_ptr_array_index(
-               stream->events, stream->events->len - 1))->timestamp;
+       /* mmap the next packet */
+       ctf_packet_seek(&stream->pos.parent, 0, SEEK_CUR);
 
-       /* Set the default context attributes if present and unset. */
-       ret = set_structure_field_integer(stream->packet_context,
-               "timestamp_begin", timestamp_begin);
+       ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos);
        if (ret) {
                goto end;
        }
 
-       ret = set_structure_field_integer(stream->packet_context,
-               "timestamp_end", timestamp_end);
-       if (ret) {
-               goto end;
+       /* Set the default context attributes if present and unset. */
+       if (!get_event_header_timestamp(
+               ((struct bt_ctf_event *) g_ptr_array_index(
+               stream->events, 0))->event_header, &timestamp_begin)) {
+               ret = set_structure_field_integer(stream->packet_context,
+                       "timestamp_begin", timestamp_begin);
+               if (ret) {
+                       goto end;
+               }
        }
 
+       if (!get_event_header_timestamp(
+               ((struct bt_ctf_event *) g_ptr_array_index(
+               stream->events, stream->events->len - 1))->event_header,
+               &timestamp_end)) {
+
+               ret = set_structure_field_integer(stream->packet_context,
+                       "timestamp_end", timestamp_end);
+               if (ret) {
+                       goto end;
+               }
+       }
        ret = set_structure_field_integer(stream->packet_context,
                "content_size", UINT64_MAX);
        if (ret) {
@@ -493,28 +805,14 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
        for (i = 0; i < stream->events->len; i++) {
                struct bt_ctf_event *event = g_ptr_array_index(
                        stream->events, i);
-               uint32_t event_id = bt_ctf_event_class_get_id(
-                       event->event_class);
-               uint64_t timestamp = bt_ctf_event_get_timestamp(event);
 
-               ret = bt_ctf_field_reset(stream_class->event_header);
-               if (ret) {
-                       goto end;
-               }
-
-               ret = set_structure_field_integer(stream_class->event_header,
-                       "id", event_id);
-               if (ret) {
-                       goto end;
-               }
-               ret = set_structure_field_integer(stream_class->event_header,
-                       "timestamp", timestamp);
+               ret = bt_ctf_field_reset(event->event_header);
                if (ret) {
                        goto end;
                }
 
                /* Write event header */
-               ret = bt_ctf_field_serialize(stream_class->event_header,
+               ret = bt_ctf_field_serialize(event->event_header,
                        &stream->pos);
                if (ret) {
                        goto end;
@@ -568,58 +866,41 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
        }
        stream->flushed_packet_count++;
 end:
-       bt_ctf_field_put(integer);
+       bt_put(integer);
        return ret;
 }
 
 void bt_ctf_stream_get(struct bt_ctf_stream *stream)
 {
-       if (!stream) {
-               return;
-       }
-
-       bt_ctf_ref_get(&stream->ref_count);
+       bt_get(stream);
 }
 
 void bt_ctf_stream_put(struct bt_ctf_stream *stream)
 {
-       if (!stream) {
-               return;
-       }
-
-       bt_ctf_ref_put(&stream->ref_count, bt_ctf_stream_destroy);
+       bt_put(stream);
 }
 
 static
-void bt_ctf_stream_destroy(struct bt_ctf_ref *ref)
+void bt_ctf_stream_destroy(struct bt_object *obj)
 {
        struct bt_ctf_stream *stream;
 
-       if (!ref) {
-               return;
-       }
-
-       stream = container_of(ref, struct bt_ctf_stream, ref_count);
+       stream = container_of(obj, struct bt_ctf_stream, base);
        ctf_fini_pos(&stream->pos);
-       if (close(stream->pos.fd)) {
+       if (stream->pos.fd >= 0 && close(stream->pos.fd)) {
                perror("close");
        }
 
-       if (stream->stream_class) {
-               bt_ctf_stream_class_put(stream->stream_class);
-       }
+       bt_put(stream->stream_class);
        if (stream->events) {
                g_ptr_array_free(stream->events, TRUE);
        }
        if (stream->event_contexts) {
                g_ptr_array_free(stream->event_contexts, TRUE);
        }
-       if (stream->packet_context) {
-               bt_ctf_field_put(stream->packet_context);
-       }
-       if (stream->event_context) {
-               bt_ctf_field_put(stream->event_context);
-       }
+       bt_put(stream->packet_header);
+       bt_put(stream->packet_context);
+       bt_put(stream->event_context);
        g_free(stream);
 }
 
@@ -628,6 +909,7 @@ int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
                uint64_t value)
 {
        int ret = 0;
+       struct bt_ctf_field_type *field_type = NULL;
        struct bt_ctf_field *integer =
                bt_ctf_field_structure_get_field(structure, name);
 
@@ -647,8 +929,27 @@ int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
                goto end;
        }
 
-       ret = bt_ctf_field_unsigned_integer_set_value(integer, value);
+       field_type = bt_ctf_field_get_type(integer);
+       /* Something is serioulsly wrong */
+       assert(field_type);
+       if (bt_ctf_field_type_get_type_id(field_type) != CTF_TYPE_INTEGER) {
+               /*
+                * The user most likely meant for us to populate this field
+                * automatically. However, we can only do this if the field
+                * is an integer. Return an error.
+                */
+               ret = -1;
+               goto end;
+       }
+
+       if (bt_ctf_field_type_integer_get_signed(field_type)) {
+               ret = bt_ctf_field_signed_integer_set_value(integer,
+                       (int64_t) value);
+       } else {
+               ret = bt_ctf_field_unsigned_integer_set_value(integer, value);
+       }
 end:
-       bt_ctf_field_put(integer);
+       bt_put(integer);
+       bt_put(field_type);
        return ret;
 }
This page took 0.031898 seconds and 4 git commands to generate.