ctf.fs: bt_ctf_notif_iter_create(): assert() that all medops exist
[babeltrace.git] / formats / ctf / ir / stream.c
index 74c6f52b5828bcf8b278486b25666cfde0e27628..b4d234703e1bb27d7725bb7ab9530232e2847dc4 100644 (file)
@@ -47,6 +47,8 @@
 static
 void bt_ctf_stream_destroy(struct bt_object *obj);
 static
+int try_set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
+static
 int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
 
 static
@@ -384,17 +386,20 @@ struct bt_ctf_stream *bt_ctf_stream_create(
                        bt_object_get_parent(trace);
 
                assert(writer);
-               stream->packet_context = bt_ctf_field_create(
-                       stream_class->packet_context_type);
-               if (!stream->packet_context) {
-                       goto error;
-               }
+               if (stream_class->packet_context_type) {
+                       stream->packet_context = bt_ctf_field_create(
+                               stream_class->packet_context_type);
+                       if (!stream->packet_context) {
+                               goto error;
+                       }
 
-               /* Initialize events_discarded */
-               ret = set_structure_field_integer(stream->packet_context,
-                       "events_discarded", 0);
-               if (ret) {
-                       goto error;
+                       /* Initialize events_discarded */
+                       ret = try_set_structure_field_integer(
+                               stream->packet_context,
+                               "events_discarded", 0);
+                       if (ret != 1) {
+                               goto error;
+                       }
                }
 
                stream->events = g_ptr_array_new_with_free_func(
@@ -863,13 +868,32 @@ end:
        return ret;
 }
 
+static
+void reset_structure_field(struct bt_ctf_field *structure, const char *name)
+{
+       struct bt_ctf_field *member;
+
+       member = bt_ctf_field_structure_get_field(structure, name);
+       assert(member);
+       (void) bt_ctf_field_reset(member);
+       bt_put(member);
+}
+
 int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
 {
        int ret = 0;
        size_t i;
-       uint64_t timestamp_begin, timestamp_end, events_discarded;
+       uint64_t timestamp_begin, timestamp_end;
        struct bt_ctf_field *integer = NULL;
        struct ctf_stream_pos packet_context_pos;
+       bool empty_packet;
+       uint64_t packet_size_bits;
+       struct {
+               bool timestamp_begin;
+               bool timestamp_end;
+               bool content_size;
+               bool packet_size;
+       } auto_set_fields = { 0 };
 
        if (!stream || stream->pos.fd < 0) {
                /*
@@ -880,94 +904,80 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
                goto end;
        }
 
-       if (!stream->events->len) {
+       if (!stream->packet_context && stream->flushed_packet_count > 0) {
+               /*
+                * A stream without a packet context, and thus without
+                * content and packet size members, can't have more than
+                * one packet.
+                */
+               ret = -1;
                goto end;
        }
 
-       ret = bt_ctf_field_validate(stream->packet_header);
-       if (ret) {
-               goto end;
-       }
+       empty_packet = (stream->events->len == 0);
 
        /* mmap the next packet */
        ctf_packet_seek(&stream->pos.parent, 0, SEEK_CUR);
-
        ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos);
        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 (stream->packet_context) {
+               /* Set the default context attributes if present and unset. */
+               if (!empty_packet && !get_event_header_timestamp(
+                       ((struct bt_ctf_event *) g_ptr_array_index(
+                               stream->events, 0))->event_header, &timestamp_begin)) {
+                       ret = try_set_structure_field_integer(
+                               stream->packet_context,
+                               "timestamp_begin", timestamp_begin);
+                       if (ret < 0) {
+                               goto end;
+                       }
+                       auto_set_fields.timestamp_begin = ret == 1;
                }
-       }
 
-       if (!get_event_header_timestamp(
-               ((struct bt_ctf_event *) g_ptr_array_index(
-               stream->events, stream->events->len - 1))->event_header,
-               &timestamp_end)) {
+               if (!empty_packet && !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) {
+                       ret = try_set_structure_field_integer(
+                               stream->packet_context,
+                               "timestamp_end", timestamp_end);
+                       if (ret < 0) {
+                               goto end;
+                       }
+                       auto_set_fields.timestamp_end = ret == 1;
+               }
+               ret = try_set_structure_field_integer(stream->packet_context,
+                       "content_size", UINT64_MAX);
+               if (ret < 0) {
                        goto end;
                }
-       }
-       ret = set_structure_field_integer(stream->packet_context,
-               "content_size", UINT64_MAX);
-       if (ret) {
-               goto end;
-       }
-
-       ret = set_structure_field_integer(stream->packet_context,
-               "packet_size", UINT64_MAX);
-       if (ret) {
-               goto end;
-       }
-
-       /* Write packet context */
-       memcpy(&packet_context_pos, &stream->pos,
-              sizeof(struct ctf_stream_pos));
-       ret = bt_ctf_field_serialize(stream->packet_context,
-               &stream->pos);
-       if (ret) {
-               goto end;
-       }
-
-       ret = bt_ctf_stream_get_discarded_events_count(stream,
-               &events_discarded);
-       if (ret) {
-               goto end;
-       }
+               auto_set_fields.content_size = ret == 1;
 
-       /* Unset the packet context's fields. */
-       ret = bt_ctf_field_reset(stream->packet_context);
-       if (ret) {
-               goto end;
-       }
+               ret = try_set_structure_field_integer(stream->packet_context,
+                       "packet_size", UINT64_MAX);
+               if (ret < 0) {
+                       goto end;
+               }
+               auto_set_fields.packet_size = ret == 1;
 
-       /* Set the previous number of discarded events. */
-       ret = set_structure_field_integer(stream->packet_context,
-               "events_discarded", events_discarded);
-       if (ret) {
-               goto end;
+               /* Write packet context */
+               memcpy(&packet_context_pos, &stream->pos,
+                       sizeof(struct ctf_stream_pos));
+               ret = bt_ctf_field_serialize(stream->packet_context,
+                       &stream->pos);
+               if (ret) {
+                       goto end;
+               }
        }
 
        for (i = 0; i < stream->events->len; i++) {
                struct bt_ctf_event *event = g_ptr_array_index(
                        stream->events, i);
 
-               ret = bt_ctf_field_reset(event->event_header);
-               if (ret) {
-                       goto end;
-               }
-
                /* Write event header */
                ret = bt_ctf_field_serialize(event->event_header,
                        &stream->pos);
@@ -991,35 +1001,75 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
                }
        }
 
-       /*
-        * Update the packet total size and content size and overwrite the
-        * packet context.
-        * Copy base_mma as the packet may have been remapped (e.g. when a
-        * packet is resized).
-        */
-       packet_context_pos.base_mma = stream->pos.base_mma;
-       ret = set_structure_field_integer(stream->packet_context,
-               "content_size", stream->pos.offset);
-       if (ret) {
-               goto end;
-       }
+       /* Rounded-up in case content_size is not byte-aligned. */
+       packet_size_bits = (stream->pos.offset + (CHAR_BIT - 1)) &
+               ~(CHAR_BIT - 1);
+       stream->pos.packet_size = packet_size_bits;
 
-       ret = set_structure_field_integer(stream->packet_context,
-               "packet_size", stream->pos.packet_size);
-       if (ret) {
-               goto end;
-       }
+       if (stream->packet_context) {
+               /*
+                * Update the packet total size and content size and overwrite
+                * the packet context.
+                * Copy base_mma as the packet may have been remapped (e.g. when
+                * a packet is resized).
+                */
+               packet_context_pos.base_mma = stream->pos.base_mma;
+               if (auto_set_fields.content_size) {
+                       ret = set_structure_field_integer(
+                                       stream->packet_context,
+                                       "content_size", stream->pos.offset);
+                       if (ret < 0) {
+                               goto end;
+                       }
+               }
 
-       ret = bt_ctf_field_serialize(stream->packet_context,
-               &packet_context_pos);
-       if (ret) {
-               goto end;
+               if (auto_set_fields.packet_size) {
+                       ret = set_structure_field_integer(stream->packet_context,
+                                       "packet_size", packet_size_bits);
+                       if (ret < 0) {
+                               goto end;
+                       }
+               }
+
+               ret = bt_ctf_field_serialize(stream->packet_context,
+                       &packet_context_pos);
+               if (ret) {
+                       goto end;
+               }
        }
 
        g_ptr_array_set_size(stream->events, 0);
        stream->flushed_packet_count++;
+       stream->size += packet_size_bits / CHAR_BIT;
 end:
+       /* Reset automatically-set fields. */
+       if (auto_set_fields.timestamp_begin) {
+               reset_structure_field(stream->packet_context,
+                               "timestamp_begin");
+       }
+       if (auto_set_fields.timestamp_end) {
+               reset_structure_field(stream->packet_context,
+                               "timestamp_end");
+       }
+       if (auto_set_fields.packet_size) {
+               reset_structure_field(stream->packet_context,
+                               "packet_size");
+       }
+       if (auto_set_fields.content_size) {
+               reset_structure_field(stream->packet_context,
+                               "content_size");
+       }
        bt_put(integer);
+
+       if (ret < 0) {
+               /*
+                * We failed to write the packet. Its size is therefore set to 0
+                * to ensure the next mapping is done in the same place rather
+                * than advancing by "stream->pos.packet_size", which would
+                * leave a corrupted packet in the trace.
+                */
+               stream->pos.packet_size = 0;
+       }
        return ret;
 }
 
@@ -1040,8 +1090,24 @@ void bt_ctf_stream_destroy(struct bt_object *obj)
 
        stream = container_of(obj, struct bt_ctf_stream, base);
        ctf_fini_pos(&stream->pos);
-       if (stream->pos.fd >= 0 && close(stream->pos.fd)) {
-               perror("close");
+       if (stream->pos.fd >= 0) {
+               int ret;
+
+               /*
+                * Truncate the file's size to the minimum required to fit the
+                * last packet as we might have grown it too much on the last
+                * mmap.
+                */
+               do {
+                       ret = ftruncate(stream->pos.fd, stream->size);
+               } while (ret == -1 && errno == EINTR);
+               if (ret) {
+                       perror("ftruncate");
+               }
+
+               if (close(stream->pos.fd)) {
+                       perror("close");
+               }
        }
 
        if (stream->events) {
@@ -1058,8 +1124,8 @@ void bt_ctf_stream_destroy(struct bt_object *obj)
 }
 
 static
-int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
-               uint64_t value)
+int _set_structure_field_integer(struct bt_ctf_field *structure, char *name,
+               uint64_t value, bool force)
 {
        int ret = 0;
        struct bt_ctf_field_type *field_type = NULL;
@@ -1077,13 +1143,12 @@ 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_is_set(integer)) {
+       if (!force && bt_ctf_field_is_set(integer)) {
                /* Payload already set, not an error */
                goto end;
        }
 
        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) != BT_CTF_TYPE_ID_INTEGER) {
                /*
@@ -1101,12 +1166,33 @@ int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
        } else {
                ret = bt_ctf_field_unsigned_integer_set_value(integer, value);
        }
+       ret = !ret ? 1 : ret;
 end:
        bt_put(integer);
        bt_put(field_type);
        return ret;
 }
 
+static
+int set_structure_field_integer(struct bt_ctf_field *structure, char *name,
+               uint64_t value)
+{
+       return _set_structure_field_integer(structure, name, value, true);
+}
+
+/*
+ * Returns the following codes:
+ * 1 if the field was found and set,
+ * 0 if nothing was done (field not found, or was already set),
+ * <0 if an error was encoutered
+ */
+static
+int try_set_structure_field_integer(struct bt_ctf_field *structure, char *name,
+               uint64_t value)
+{
+       return _set_structure_field_integer(structure, name, value, false);
+}
+
 const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream)
 {
        const char *name = NULL;
This page took 0.029611 seconds and 4 git commands to generate.