* SOFTWARE.
*/
-#include <babeltrace/ctf-ir/clock.h>
-#include <babeltrace/ctf-ir/clock-internal.h>
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/ctf-writer/clock.h>
+#include <babeltrace/ctf-writer/clock-internal.h>
#include <babeltrace/ctf-writer/event.h>
#include <babeltrace/ctf-ir/event-internal.h>
#include <babeltrace/ctf-ir/field-types-internal.h>
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
+int set_integer_field_value(struct bt_ctf_field* field, uint64_t value)
+{
+ int ret = 0;
+ struct bt_ctf_field_type *field_type = NULL;
+
+ if (!field) {
+ ret = -1;
+ goto end;
+ }
+
+ field_type = bt_ctf_field_get_type(field);
+ assert(field_type);
+
+ if (bt_ctf_field_type_get_type_id(field_type) !=
+ BT_CTF_TYPE_ID_INTEGER) {
+ /* Not an integer and the value is unset, error. */
+ ret = -1;
+ goto end;
+ }
+
+ if (bt_ctf_field_type_integer_get_signed(field_type)) {
+ ret = bt_ctf_field_signed_integer_set_value(field, (int64_t) value);
+ if (ret) {
+ /* Value is out of range, error. */
+ goto end;
+ }
+ } else {
+ ret = bt_ctf_field_unsigned_integer_set_value(field, value);
+ if (ret) {
+ /* Value is out of range, error. */
+ goto end;
+ }
+ }
+end:
+ bt_put(field_type);
+ return ret;
+}
+
static
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;
}
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;
}
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;
}
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(
if (ret) {
goto error;
}
-
- stream->clock_values = g_hash_table_new_full(g_direct_hash,
- g_direct_equal, NULL, g_free);
}
/* Add this stream to the trace's streams */
bt_put(events_discarded_field_type);
}
+static int auto_populate_event_header(struct bt_ctf_stream *stream,
+ struct bt_ctf_event *event)
+{
+ int ret = 0;
+ struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL;
+ struct bt_ctf_clock_class *mapped_clock_class = NULL;
+
+ if (!event || event->frozen) {
+ ret = -1;
+ goto end;
+ }
+
+ /*
+ * The condition to automatically set the ID are:
+ *
+ * 1. The event header field "id" exists and is an integer
+ * field.
+ * 2. The event header field "id" is NOT set.
+ */
+ id_field = bt_ctf_field_structure_get_field(event->event_header, "id");
+ if (id_field && !bt_ctf_field_is_set(id_field)) {
+ ret = set_integer_field_value(id_field,
+ (uint64_t) bt_ctf_event_class_get_id(
+ event->event_class));
+ if (ret) {
+ goto end;
+ }
+ }
+
+ /*
+ * The conditions to automatically set the timestamp are:
+ *
+ * 1. The event header field "timestamp" exists and is an
+ * integer field.
+ * 2. This stream's class has a registered clock (set with
+ * bt_ctf_stream_class_set_clock()).
+ * 3. The event header field "timestamp" has its type mapped to
+ * a clock class which is also the clock class of this
+ * stream's class's registered clock.
+ * 4. The event header field "timestamp" is NOT set.
+ */
+ timestamp_field = bt_ctf_field_structure_get_field(event->event_header,
+ "timestamp");
+ if (timestamp_field && !bt_ctf_field_is_set(timestamp_field) &&
+ stream->stream_class->clock) {
+ struct bt_ctf_clock_class *stream_class_clock_class =
+ stream->stream_class->clock->clock_class;
+ struct bt_ctf_field_type *timestamp_field_type =
+ bt_ctf_field_get_type(timestamp_field);
+
+ assert(timestamp_field_type);
+ mapped_clock_class =
+ bt_ctf_field_type_integer_get_mapped_clock_class(
+ timestamp_field_type);
+ BT_PUT(timestamp_field_type);
+ if (mapped_clock_class == stream_class_clock_class) {
+ uint64_t timestamp;
+
+ ret = bt_ctf_clock_get_value(
+ stream->stream_class->clock,
+ ×tamp);
+ if (ret) {
+ goto end;
+ }
+
+ ret = set_integer_field_value(timestamp_field,
+ timestamp);
+ if (ret) {
+ goto end;
+ }
+ }
+ }
+
+end:
+ bt_put(id_field);
+ bt_put(timestamp_field);
+ bt_put(mapped_clock_class);
+ return ret;
+}
+
int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
struct bt_ctf_event *event)
{
}
bt_object_set_parent(event, stream);
- ret = bt_ctf_event_populate_event_header(event);
+ ret = auto_populate_event_header(stream, event);
if (ret) {
- goto end;
+ goto error;
}
/* Make sure the various scopes of the event are set */
ret = bt_ctf_event_validate(event);
if (ret) {
- goto end;
+ goto error;
}
/* Save the new event and freeze it */
* 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;
}
int ret = 0;
struct bt_ctf_field_type *field_type;
- if (!stream || !field || stream->pos.fd < 0) {
+ if (!stream || stream->pos.fd < 0) {
ret = -1;
goto end;
}
}
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_trace *trace = NULL;
struct bt_ctf_field_type *field_type = NULL;
- if (!stream || !field || stream->pos.fd < 0) {
+ if (!stream || stream->pos.fd < 0) {
ret = -1;
goto end;
}
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);
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) {
/*
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, ×tamp_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, ×tamp_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,
- ×tamp_end)) {
+ if (!empty_packet && !get_event_header_timestamp(
+ ((struct bt_ctf_event *) g_ptr_array_index(
+ stream->events, stream->events->len - 1))->event_header,
+ ×tamp_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;
- }
+ auto_set_fields.content_size = ret == 1;
- ret = bt_ctf_stream_get_discarded_events_count(stream,
- &events_discarded);
- if (ret) {
- goto end;
- }
-
- /* 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);
}
}
- /*
- * 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;
}
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) {
g_string_free(stream->name, TRUE);
}
- if (stream->clock_values) {
- g_hash_table_destroy(stream->clock_values);
- }
-
bt_put(stream->packet_header);
bt_put(stream->packet_context);
g_free(stream);
}
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;
}
/* Make sure the payload has not already been set. */
- if (!bt_ctf_field_validate(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) {
/*
} 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;
return name;
}
-BT_HIDDEN
-void bt_ctf_stream_update_clock_value(struct bt_ctf_stream *stream,
- struct bt_ctf_field *value_field)
+int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream)
{
- struct bt_ctf_field_type *value_type = NULL;
- struct bt_ctf_clock *clock = NULL;
- uint64_t requested_new_value;
- uint64_t requested_new_value_mask;
- uint64_t *cur_value;
- uint64_t cur_value_masked;
- int requested_new_value_size;
- int ret;
-
- assert(stream);
- assert(clock);
- assert(value_field);
- value_type = bt_ctf_field_get_type(value_field);
- assert(value_type);
- clock = bt_ctf_field_type_integer_get_mapped_clock(value_type);
- assert(clock);
- requested_new_value_size =
- bt_ctf_field_type_integer_get_size(value_type);
- assert(requested_new_value_size > 0);
- ret = bt_ctf_field_unsigned_integer_get_value(value_field,
- &requested_new_value);
- assert(!ret);
- cur_value = g_hash_table_lookup(stream->clock_values, clock);
-
- if (!cur_value) {
- /*
- * Updating the value of a clock which is not registered
- * yet, so register it with the new value as its initial
- * value.
- */
- uint64_t *requested_new_value_ptr = g_new0(uint64_t, 1);
+ int ret = -1;
- *requested_new_value_ptr = requested_new_value;
- g_hash_table_insert(stream->clock_values, clock,
- requested_new_value_ptr);
- goto end;
- }
-
- /*
- * Special case for a 64-bit new value, which is the limit
- * of a clock value as of this version: overwrite the
- * current value directly.
- */
- if (requested_new_value_size == 64) {
- *cur_value = requested_new_value;
+ if (!stream) {
goto end;
}
- requested_new_value_mask = (1ULL << requested_new_value_size) - 1;
- cur_value_masked = *cur_value & requested_new_value_mask;
-
- if (requested_new_value < cur_value_masked) {
- /*
- * It looks like a wrap happened on the number of bits
- * of the requested new value. Assume that the clock
- * value wrapped only one time.
- */
- *cur_value += requested_new_value_mask + 1;
- }
-
- /* Clear the low bits of the current clock value */
- *cur_value &= ~requested_new_value_mask;
-
- /* Set the low bits of the current clock value */
- *cur_value |= requested_new_value;
+ ret = (stream->pos.fd >= 0);
end:
- bt_put(clock);
- bt_put(value_type);
+ return ret;
}
projects / babeltrace.git / blobdiff