Allow NULL (unset) packet, stream and event headers, contexts
[babeltrace.git] / formats / ctf / ir / stream.c
index 97f179463b174a0c4b56be513868172394718d90..d4dbc447ca6a6b1fe16d6004c90e408c97f1ee61 100644 (file)
@@ -35,6 +35,8 @@
 #include <babeltrace/ctf-ir/stream.h>
 #include <babeltrace/ctf-ir/stream-internal.h>
 #include <babeltrace/ctf-ir/stream-class-internal.h>
+#include <babeltrace/ctf-ir/trace-internal.h>
+#include <babeltrace/ctf-writer/writer-internal.h>
 #include <babeltrace/ref.h>
 #include <babeltrace/ctf-writer/functor-internal.h>
 #include <babeltrace/compiler.h>
@@ -59,7 +61,7 @@ int set_packet_header_magic(struct bt_ctf_stream *stream)
                goto end;
        }
 
-       if (!bt_ctf_field_validate(magic_field)) {
+       if (bt_ctf_field_is_set(magic_field)) {
                /* Value already set. Not an error, skip. */
                goto end;
        }
@@ -111,7 +113,7 @@ int set_packet_header_uuid(struct bt_ctf_stream *stream)
                goto end;
        }
 
-       if (!bt_ctf_field_validate(uuid_field)) {
+       if (bt_ctf_field_is_set(uuid_field)) {
                /* Value already set. Not an error, skip. */
                goto end;
        }
@@ -184,7 +186,7 @@ int set_packet_header_stream_id(struct bt_ctf_stream *stream)
                goto end;
        }
 
-       if (!bt_ctf_field_validate(stream_id_field)) {
+       if (bt_ctf_field_is_set(stream_id_field)) {
                /* Value already set. Not an error, skip. */
                goto end;
        }
@@ -252,21 +254,71 @@ void release_event(struct bt_ctf_event *event)
        }
 }
 
-BT_HIDDEN
+static
+int create_stream_file(struct bt_ctf_writer *writer,
+               struct bt_ctf_stream *stream)
+{
+       int fd;
+       GString *filename = g_string_new(stream->stream_class->name->str);
+
+       if (stream->stream_class->name->len == 0) {
+               int64_t ret;
+
+               ret = bt_ctf_stream_class_get_id(stream->stream_class);
+               if (ret < 0) {
+                       fd = -1;
+                       goto error;
+               }
+
+               g_string_printf(filename, "stream_%" PRId64, ret);
+       }
+
+       g_string_append_printf(filename, "_%" PRIu32, stream->id);
+       fd = openat(writer->trace_dir_fd, filename->str,
+               O_RDWR | O_CREAT | O_TRUNC,
+               S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
+error:
+       g_string_free(filename, TRUE);
+       return fd;
+}
+
+static
+int set_stream_fd(struct bt_ctf_stream *stream, int fd)
+{
+       int ret = 0;
+
+       if (stream->pos.fd != -1) {
+               ret = -1;
+               goto end;
+       }
+
+       ctf_init_pos(&stream->pos, NULL, fd, O_RDWR);
+       stream->pos.fd = fd;
+end:
+       return ret;
+}
+
 struct bt_ctf_stream *bt_ctf_stream_create(
-       struct bt_ctf_stream_class *stream_class,
-       struct bt_ctf_trace *trace)
+               struct bt_ctf_stream_class *stream_class,
+               const char *name)
 {
        int ret;
        struct bt_ctf_stream *stream = NULL;
+       struct bt_ctf_trace *trace = NULL;
+       struct bt_ctf_writer *writer = NULL;
 
-       if (!stream_class || !trace) {
-               goto end;
+       if (!stream_class) {
+               goto error;
+       }
+
+       trace = bt_ctf_stream_class_get_trace(stream_class);
+       if (!trace) {
+               goto error;
        }
 
        stream = g_new0(struct bt_ctf_stream, 1);
        if (!stream) {
-               goto end;
+               goto error;
        }
 
        bt_object_init(stream, bt_ctf_stream_destroy);
@@ -275,91 +327,97 @@ struct bt_ctf_stream *bt_ctf_stream_create(
         * reachable; it needs its parent to remain valid.
         */
        bt_object_set_parent(stream, trace);
-       stream->packet_context = bt_ctf_field_create(
-               stream_class->packet_context_type);
-       if (!stream->packet_context) {
-               goto error;
-       }
+       stream->id = stream_class->next_stream_id++;
+       stream->stream_class = stream_class;
+       stream->pos.fd = -1;
 
-       /*
-        * A stream class may not have a stream event context defined
-        * in which case this stream will never have a stream_event_context
-        * member since, after a stream's creation, the parent stream class
-        * is "frozen" (immutable).
-        */
-       if (stream_class->event_context_type) {
-               stream->event_context = bt_ctf_field_create(
-                       stream_class->event_context_type);
-               if (!stream->event_context) {
+       if (name) {
+               stream->name = g_string_new(name);
+               if (!stream->name) {
                        goto error;
                }
        }
 
-       /* Initialize events_discarded */
-       ret = set_structure_field_integer(stream->packet_context,
-               "events_discarded", 0);
-       if (ret) {
-               goto error;
-       }
+       if (trace->is_created_by_writer) {
+               int fd;
+               writer = (struct bt_ctf_writer *)
+                       bt_object_get_parent(trace);
 
-       stream->pos.fd = -1;
-       stream->id = stream_class->next_stream_id++;
-       stream->stream_class = stream_class;
-       stream->events = g_ptr_array_new_with_free_func(
-               (GDestroyNotify) release_event);
-       if (!stream->events) {
-               goto error;
-       }
-       if (stream_class->event_context_type) {
-               stream->event_contexts = g_ptr_array_new_with_free_func(
-                       (GDestroyNotify) bt_put);
-               if (!stream->event_contexts) {
+               assert(writer);
+               stream->packet_context = bt_ctf_field_create(
+                       stream_class->packet_context_type);
+               if (!stream->packet_context) {
                        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;
+               /* Initialize events_discarded */
+               ret = set_structure_field_integer(stream->packet_context,
+                       "events_discarded", 0);
+               if (ret) {
+                       goto error;
+               }
+
+               stream->events = g_ptr_array_new_with_free_func(
+                       (GDestroyNotify) release_event);
+               if (!stream->events) {
+                       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;
+               }
+
+               /* Create file associated with this stream */
+               fd = create_stream_file(writer, stream);
+               if (fd < 0) {
+                       goto error;
+               }
+
+               ret = set_stream_fd(stream, fd);
+               if (ret) {
+                       goto error;
+               }
+
+               /* Freeze the writer */
+               bt_ctf_writer_freeze(writer);
+       } else {
+               /* Non-writer stream indicated by a negative FD */
+               ret = set_stream_fd(stream, -1);
+               if (ret) {
+                       goto error;
+               }
        }
-end:
+
+       /* Add this stream to the trace's streams */
+       g_ptr_array_add(trace->streams, stream);
+
+       BT_PUT(trace);
+       BT_PUT(writer);
        return stream;
 error:
        BT_PUT(stream);
-       bt_put(trace);
+       BT_PUT(trace);
+       BT_PUT(writer);
        return stream;
 }
 
-BT_HIDDEN
-int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd)
-{
-       int ret = 0;
-
-       if (stream->pos.fd != -1) {
-               ret = -1;
-               goto end;
-       }
-
-       ctf_init_pos(&stream->pos, NULL, fd, O_RDWR);
-       stream->pos.fd = fd;
-end:
-       return ret;
-}
-
 struct bt_ctf_stream_class *bt_ctf_stream_get_class(
                struct bt_ctf_stream *stream)
 {
@@ -383,7 +441,8 @@ int bt_ctf_stream_get_discarded_events_count(
        struct bt_ctf_field *events_discarded_field = NULL;
        struct bt_ctf_field_type *events_discarded_field_type = NULL;
 
-       if (!stream || !count || !stream->packet_context) {
+       if (!stream || !count || !stream->packet_context ||
+                       stream->pos.fd < 0) {
                ret = -1;
                goto end;
        }
@@ -446,7 +505,7 @@ void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
        struct bt_ctf_field *events_discarded_field = NULL;
        struct bt_ctf_field_type *events_discarded_field_type = NULL;
 
-       if (!stream || !stream->packet_context) {
+       if (!stream || !stream->packet_context || stream->pos.fd < 0) {
                goto end;
        }
 
@@ -498,9 +557,21 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                struct bt_ctf_event *event)
 {
        int ret = 0;
-       struct bt_ctf_field *event_context_copy = NULL;
 
-       if (!stream || !event) {
+       if (!stream || !event || stream->pos.fd < 0) {
+               ret = -1;
+               goto end;
+       }
+
+       /*
+        * The event is not supposed to have a parent stream at this
+        * point. The only other way an event can have a parent stream
+        * is if it was assigned when setting a packet to the event,
+        * in which case the packet's stream is not a writer stream,
+        * and thus the user is trying to append an event which belongs
+        * to another stream.
+        */
+       if (event->base.parent) {
                ret = -1;
                goto end;
        }
@@ -508,35 +579,19 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
        bt_object_set_parent(event, stream);
        ret = bt_ctf_event_populate_event_header(event);
        if (ret) {
-               goto end;
+               goto error;
        }
 
-       /* Make sure the event's payload is set */
+       /* Make sure the various scopes of the event are set */
        ret = bt_ctf_event_validate(event);
        if (ret) {
-               goto end;
-       }
-
-       /* Sample the current stream event context by copying it */
-       if (stream->event_context) {
-               /* Make sure the event context's payload is set */
-               ret = bt_ctf_field_validate(stream->event_context);
-               if (ret) {
-                       goto end;
-               }
-
-               event_context_copy = bt_ctf_field_copy(stream->event_context);
-               if (!event_context_copy) {
-                       ret = -1;
-                       goto end;
-               }
+               goto error;
        }
 
-       /* Save the new event along with its associated stream event context */
+       /* Save the new event and freeze it */
+       bt_ctf_event_freeze(event);
        g_ptr_array_add(stream->events, event);
-       if (event_context_copy) {
-               g_ptr_array_add(stream->event_contexts, event_context_copy);
-       }
+
        /*
         * Event had to hold a reference to its event class as long as it wasn't
         * part of the same trace hierarchy. From now on, the event and its
@@ -544,14 +599,17 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
         * longer needed.
         */
        bt_put(event->event_class);
+
 end:
-       if (ret) {
-               /*
-                * Orphan the event; we were not succesful in associating it to
-                * a stream.
-                */
-               bt_object_set_parent(event, NULL);
-       }
+       return ret;
+
+error:
+       /*
+        * Orphan the event; we were not successful in associating it to
+        * a stream.
+        */
+       bt_object_set_parent(event, NULL);
+
        return ret;
 }
 
@@ -560,7 +618,7 @@ struct bt_ctf_field *bt_ctf_stream_get_packet_context(
 {
        struct bt_ctf_field *packet_context = NULL;
 
-       if (!stream) {
+       if (!stream || stream->pos.fd < 0) {
                goto end;
        }
 
@@ -578,7 +636,7 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
        int ret = 0;
        struct bt_ctf_field_type *field_type;
 
-       if (!stream || !field) {
+       if (!stream || stream->pos.fd < 0) {
                ret = -1;
                goto end;
        }
@@ -591,62 +649,18 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
        }
 
        bt_put(field_type);
-       bt_get(field);
        bt_put(stream->packet_context);
-       stream->packet_context = field;
+       stream->packet_context = bt_get(field);
 end:
        return ret;
 }
 
-struct bt_ctf_field *bt_ctf_stream_get_event_context(
-               struct bt_ctf_stream *stream)
-{
-       struct bt_ctf_field *event_context = NULL;
-
-       if (!stream) {
-               goto end;
-       }
-
-       event_context = stream->event_context;
-       if (event_context) {
-               bt_get(event_context);
-       }
-end:
-       return event_context;
-}
-
-int bt_ctf_stream_set_event_context(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 (bt_ctf_field_type_compare(field_type,
-                       stream->stream_class->event_context_type)) {
-               ret = -1;
-               goto end;
-       }
-
-       bt_get(field);
-       bt_put(stream->event_context);
-       stream->event_context = field;
-end:
-       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) {
+       if (!stream || stream->pos.fd < 0) {
                goto end;
        }
 
@@ -665,7 +679,7 @@ int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
        struct bt_ctf_trace *trace = NULL;
        struct bt_ctf_field_type *field_type = NULL;
 
-       if (!stream || !field) {
+       if (!stream || stream->pos.fd < 0) {
                ret = -1;
                goto end;
        }
@@ -677,9 +691,8 @@ int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
                goto end;
        }
 
-       bt_get(field);
        bt_put(stream->packet_header);
-       stream->packet_header = field;
+       stream->packet_header = bt_get(field);
 end:
        BT_PUT(trace);
        bt_put(field_type);
@@ -843,10 +856,9 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
                }
 
                /* Write stream event context */
-               if (stream->event_contexts) {
+               if (event->stream_event_context) {
                        ret = bt_ctf_field_serialize(
-                               g_ptr_array_index(stream->event_contexts, i),
-                               &stream->pos);
+                               event->stream_event_context, &stream->pos);
                        if (ret) {
                                goto end;
                        }
@@ -885,9 +897,6 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
        }
 
        g_ptr_array_set_size(stream->events, 0);
-       if (stream->event_contexts) {
-               g_ptr_array_set_size(stream->event_contexts, 0);
-       }
        stream->flushed_packet_count++;
 end:
        bt_put(integer);
@@ -918,12 +927,13 @@ void bt_ctf_stream_destroy(struct bt_object *obj)
        if (stream->events) {
                g_ptr_array_free(stream->events, TRUE);
        }
-       if (stream->event_contexts) {
-               g_ptr_array_free(stream->event_contexts, TRUE);
+
+       if (stream->name) {
+               g_string_free(stream->name, TRUE);
        }
+
        bt_put(stream->packet_header);
        bt_put(stream->packet_context);
-       bt_put(stream->event_context);
        g_free(stream);
 }
 
@@ -947,7 +957,7 @@ int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
        }
 
        /* Make sure the payload has not already been set. */
-       if (!bt_ctf_field_validate(integer)) {
+       if (bt_ctf_field_is_set(integer)) {
                /* Payload already set, not an error */
                goto end;
        }
@@ -976,3 +986,17 @@ end:
        bt_put(field_type);
        return ret;
 }
+
+const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream)
+{
+       const char *name = NULL;
+
+       if (!stream) {
+               goto end;
+       }
+
+       name = stream->name ? stream->name->str : NULL;
+
+end:
+       return name;
+}
This page took 0.038831 seconds and 4 git commands to generate.