X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fctf-ir%2Fstream.c;h=5741a7a520f6fbc4126f50ec031b5be12f269174;hb=7d7fae6d7f0be96112fe30e47715b83f169bff52;hp=a24e16ae343d04c0533330c50b4774b0f01ac629;hpb=19abc2c651500e2dcabdd0ab5251d418ce312385;p=babeltrace.git diff --git a/lib/ctf-ir/stream.c b/lib/ctf-ir/stream.c index a24e16ae..5741a7a5 100644 --- a/lib/ctf-ir/stream.c +++ b/lib/ctf-ir/stream.c @@ -48,13 +48,12 @@ #include #include #include +#include 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) @@ -110,7 +109,6 @@ 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"); const uint32_t magic_value = 0xc1fc1fc1; @@ -125,64 +123,22 @@ int set_packet_header_magic(struct bt_ctf_stream *stream) goto end; } - if (bt_ctf_field_is_set(magic_field)) { - /* Value already set. Not an error, skip. */ - BT_LOGV("Packet header's `magic` field is already set: skipping: " - "stream-addr=%p, stream-name=\"%s\"", stream, - bt_ctf_stream_get_name(stream)); - 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) != - BT_CTF_FIELD_TYPE_ID_INTEGER) { - /* Magic field is not an integer. Not an error, skip. */ - BT_LOGV("Packet header's `magic` field's type is not an integer field type: skipping: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, ft-addr=%p, ft-id=%s", - stream, bt_ctf_stream_get_name(stream), magic_field, - magic_field_type, - bt_ctf_field_type_id_string(magic_field_type->id)); - 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. - */ - BT_LOGV("Packet header's `magic` field's type is not 32-bit: skipping: " - "stream-addr=%p, stream-name=\"%s\", ft-addr=%p, size=%d", - stream, bt_ctf_stream_get_name(stream), magic_field_type, - bt_ctf_field_type_integer_get_size(magic_field_type)); - goto end; - } + ret = bt_ctf_field_unsigned_integer_set_value(magic_field, + (uint64_t) magic_value); - 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) magic_value); - } else { - ret = bt_ctf_field_unsigned_integer_set_value(magic_field, - (uint64_t) magic_value); - } - - if (ret) { - BT_LOGW("Cannot set `magic` integer field's value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value-unsigned=%" PRIu64, + BT_LOGW("Cannot set packet header field's `magic` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, stream, bt_ctf_stream_get_name(stream), magic_field, (uint64_t) magic_value); } else { BT_LOGV("Set packet header field's `magic` field's value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value-unsigned=%" PRIu64, + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, stream, bt_ctf_stream_get_name(stream), magic_field, (uint64_t) magic_value); } end: bt_put(magic_field); - bt_put(magic_field_type); return ret; } @@ -192,8 +148,6 @@ int set_packet_header_uuid(struct bt_ctf_stream *stream) int ret = 0; int64_t i; struct bt_ctf_trace *trace = NULL; - 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"); @@ -207,75 +161,18 @@ int set_packet_header_uuid(struct bt_ctf_stream *stream) goto end; } - if (bt_ctf_field_is_set(uuid_field)) { - /* Value already set. Not an error, skip. */ - BT_LOGV("Packet header's `uuid` field is already set: skipping: " - "stream-addr=%p, stream-name=\"%s\"", - stream, bt_ctf_stream_get_name(stream)); - 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) != - BT_CTF_FIELD_TYPE_ID_ARRAY) { - /* UUID field is not an array. Not an error, skip. */ - BT_LOGV("Packet header's `uuid` field's type is not an array field type: skipping: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, ft-addr=%p, ft-id=%s", - stream, bt_ctf_stream_get_name(stream), uuid_field, - uuid_field_type, - bt_ctf_field_type_id_string(uuid_field_type->id)); - 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. - */ - BT_LOGV("Packet header's `uuid` array field's type's length is not 16: skipping: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, ft-addr=%p, ft-length=%u", - stream, bt_ctf_stream_get_name(stream), uuid_field, - uuid_field_type, - (unsigned int) bt_ctf_field_type_array_get_length(uuid_field_type)); - 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) != - BT_CTF_FIELD_TYPE_ID_INTEGER) { - /* UUID array elements are not integers. Not an error, skip */ - BT_LOGV("Packet header's `uuid` array field's type's element field type is not an integer field type: skipping: " - "stream-addr=%p, stream-name=\"%s\", uuid-field-addr=%p, " - "element-ft-addr=%p, element-ft-id=%s", - stream, bt_ctf_stream_get_name(stream), uuid_field, - element_field_type, - bt_ctf_field_type_id_string(element_field_type->id)); - goto end; - } - trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); 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) trace->uuid[i]); - } else { - ret = bt_ctf_field_unsigned_integer_set_value( - uuid_element, (uint64_t) trace->uuid[i]); - } + ret = bt_ctf_field_unsigned_integer_set_value( + uuid_element, (uint64_t) trace->uuid[i]); bt_put(uuid_element); if (ret) { BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): " "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " - "value-unsigned=%" PRIu64 ", index=%" PRId64, + "value=%" PRIu64 ", index=%" PRId64, stream, bt_ctf_stream_get_name(stream), uuid_element, (uint64_t) trace->uuid[i], i); goto end; @@ -288,8 +185,6 @@ int set_packet_header_uuid(struct bt_ctf_stream *stream) end: bt_put(uuid_field); - bt_put(uuid_field_type); - bt_put(element_field_type); BT_PUT(trace); return ret; } @@ -298,7 +193,6 @@ 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"); @@ -310,86 +204,441 @@ int set_packet_header_stream_id(struct bt_ctf_stream *stream) goto end; } - if (bt_ctf_field_is_set(stream_id_field)) { - /* Value already set. Not an error, skip. */ - BT_LOGV("Packet header's `stream_id` field is already set: skipping: " + stream_id = stream->stream_class->id; + ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, + (uint64_t) stream_id); + if (ret) { + BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + stream_id_field, (uint64_t) stream_id); + } else { + BT_LOGV("Set packet header field's `stream_id` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + stream_id_field, (uint64_t) stream_id); + } + +end: + bt_put(stream_id_field); + return ret; +} + +static +int auto_populate_packet_header(struct bt_ctf_stream *stream) +{ + int ret = 0; + + if (!stream->packet_header) { + goto end; + } + + ret = set_packet_header_magic(stream); + if (ret) { + BT_LOGW("Cannot set packet header's magic number field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = set_packet_header_uuid(stream); + if (ret) { + BT_LOGW("Cannot set packet header's UUID field: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); 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) != - BT_CTF_FIELD_TYPE_ID_INTEGER) { - /* stream_id field is not an integer. Not an error, skip. */ - BT_LOGV("Packet header's `stream_id` field's type is not an integer field type: skipping: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, ft-addr=%p, ft-id=%s", - stream, bt_ctf_stream_get_name(stream), stream_id_field, - stream_id_field_type, - bt_ctf_field_type_id_string(stream_id_field_type->id)); + ret = set_packet_header_stream_id(stream); + if (ret) { + BT_LOGW("Cannot set packet header's stream class ID field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); goto end; } - stream_id = stream->stream_class->id; - ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type); - assert(ret >= 0); + BT_LOGV("Automatically populated stream's packet header's known fields: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + +end: + return ret; +} + +static +int set_packet_context_packet_size(struct bt_ctf_stream *stream) +{ + int ret = 0; + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, "packet_size"); + + assert(stream); + + if (!field) { + /* No packet size field found. Not an error, skip. */ + BT_LOGV("No field named `packet_size` in packet context: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = bt_ctf_field_unsigned_integer_set_value(field, + stream->pos.packet_size); if (ret) { - ret = bt_ctf_field_signed_integer_set_value(stream_id_field, - (int64_t) stream_id); + BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + field, stream->pos.packet_size); } else { - ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, - (uint64_t) stream_id); + BT_LOGV("Set packet context field's `packet_size` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + field, stream->pos.packet_size); } +end: + bt_put(field); + return ret; +} + +static +int set_packet_context_content_size(struct bt_ctf_stream *stream) +{ + int ret = 0; + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, "content_size"); + + assert(stream); + + if (!field) { + /* No content size field found. Not an error, skip. */ + BT_LOGV("No field named `content_size` in packet context: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = bt_ctf_field_unsigned_integer_set_value(field, + stream->pos.offset); if (ret) { - BT_LOGW("Cannot set `stream_id` integer field's value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value-unsigned=%" PRIu64, + BT_LOGW("Cannot set packet context field's `content_size` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64, stream, bt_ctf_stream_get_name(stream), - stream_id_field, (uint64_t) stream_id); + field, stream->pos.offset); } else { - BT_LOGV("Set packet header field's `stream_id` field's value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value-unsigned=%" PRIu64, + BT_LOGV("Set packet context field's `content_size` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64, stream, bt_ctf_stream_get_name(stream), - stream_id_field, (uint64_t) stream_id); + field, stream->pos.offset); } end: - bt_put(stream_id_field); - bt_put(stream_id_field_type); + bt_put(field); return ret; } static -int set_packet_header(struct bt_ctf_stream *stream) +int set_packet_context_events_discarded(struct bt_ctf_stream *stream) { - int ret; + int ret = 0; + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, "events_discarded"); - ret = set_packet_header_magic(stream); + assert(stream); + + if (!field) { + /* No discarded events count field found. Not an error, skip. */ + BT_LOGV("No field named `events_discarded` in packet context: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + /* + * If the field is set by the user, make sure that the value is + * greater than or equal to the stream's current count of + * discarded events. We do not allow wrapping here. If it's + * valid, update the stream's current count. + */ + if (bt_ctf_field_value_is_set(field)) { + uint64_t user_val; + + ret = bt_ctf_field_unsigned_integer_get_value(field, + &user_val); + if (ret) { + BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p", + stream, bt_ctf_stream_get_name(stream), field); + goto end; + } + + if (user_val < stream->discarded_events) { + BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: " + "value is lesser than the stream's current discarded events count: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " + "value=%" PRIu64 ", " + "stream-discarded-events-count=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), field, + user_val, stream->discarded_events); + goto end; + } + + stream->discarded_events = user_val; + } else { + ret = bt_ctf_field_unsigned_integer_set_value(field, + stream->discarded_events); + if (ret) { + BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + field, stream->discarded_events); + } else { + BT_LOGV("Set packet context field's `events_discarded` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + field, stream->discarded_events); + } + } + +end: + bt_put(field); + return ret; +} + +static +int get_event_header_timestamp(struct bt_ctf_stream *stream, + struct bt_ctf_field *event_header, uint64_t *timestamp) +{ + int ret = 0; + struct bt_ctf_field *timestamp_field = NULL; + struct bt_ctf_clock_class *ts_field_mapped_clock_class = NULL; + + *timestamp = 0; + + if (!event_header) { + BT_LOGV_STR("Event header does not exist."); + goto end; + } + + timestamp_field = bt_ctf_field_structure_get_field(event_header, + "timestamp"); + if (!timestamp_field) { + BT_LOGV("Cannot get event header's `timestamp` field: " + "event-header-field-addr=%p", event_header); + goto end; + } + + if (!bt_ctf_field_type_is_integer(timestamp_field->type)) { + BT_LOGV("Event header's `timestamp` field's type is not an integer field type: " + "event-header-field-addr=%p", event_header); + goto end; + } + + ts_field_mapped_clock_class = + bt_ctf_field_type_integer_get_mapped_clock_class( + timestamp_field->type); + if (!ts_field_mapped_clock_class) { + BT_LOGV("Event header's `timestamp` field's type is not mapped to a clock class: " + "event-header-field-addr=%p", event_header); + goto end; + } + + if (ts_field_mapped_clock_class != + stream->stream_class->clock->clock_class) { + BT_LOGV("Event header's `timestamp` field's type is not mapped to the stream's clock's class: " + "event-header-field-addr=%p", event_header); + goto end; + } + + ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field, + timestamp); if (ret) { - BT_LOGW("Cannot set packet header's magic number field: " + BT_LOGW("Cannot get unsigned integer field's value: " + "event-header-field-addr=%p, " + "timestamp-field-addr=%p", + event_header, timestamp_field); + goto end; + } + +end: + bt_put(timestamp_field); + bt_put(ts_field_mapped_clock_class); + return ret; +} + +static +int set_packet_context_timestamp_field(struct bt_ctf_stream *stream, + const char *field_name, struct bt_ctf_event *event) +{ + int ret = 0; + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, field_name); + struct bt_ctf_clock_class *field_mapped_clock_class = NULL; + uint64_t ts; + + assert(stream); + + if (!field) { + /* No beginning timestamp field found. Not an error, skip. */ + BT_LOGV("No field named `%s` in packet context: skipping: " + "stream-addr=%p, stream-name=\"%s\"", field_name, + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + if (!stream->stream_class->clock) { + BT_LOGV("Stream has no clock: skipping: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); goto end; } - ret = set_packet_header_uuid(stream); + field_mapped_clock_class = + bt_ctf_field_type_integer_get_mapped_clock_class(field->type); + if (!field_mapped_clock_class) { + BT_LOGV("Packet context's `%s` field's type is not mapped to a clock class: skipping: " + "stream-addr=%p, stream-name=\"%s\", " + "field-addr=%p, ft-addr=%p", field_name, + stream, bt_ctf_stream_get_name(stream), + field, field->type); + goto end; + } + + if (field_mapped_clock_class != + stream->stream_class->clock->clock_class) { + BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: " + "stream-addr=%p, stream-name=\"%s\", " + "field-addr=%p, ft-addr=%p, " + "ft-mapped-clock-class-addr=%p, " + "ft-mapped-clock-class-name=\"%s\", " + "stream-clock-class-addr=%p, " + "stream-clock-class-name=\"%s\"", + field_name, + stream, bt_ctf_stream_get_name(stream), + field, field->type, + field_mapped_clock_class, + bt_ctf_clock_class_get_name(field_mapped_clock_class), + stream->stream_class->clock->clock_class, + bt_ctf_clock_class_get_name( + stream->stream_class->clock->clock_class)); + goto end; + } + + if (get_event_header_timestamp(stream, event->event_header, &ts)) { + BT_LOGW("Cannot get event's timestamp: " + "event-header-field-addr=%p", + event->event_header); + ret = -1; + goto end; + } + + ret = bt_ctf_field_unsigned_integer_set_value(field, ts); if (ret) { - BT_LOGW("Cannot set packet header's UUID field: " + BT_LOGW("Cannot set packet context field's `%s` integer field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + field_name, stream, bt_ctf_stream_get_name(stream), + field, stream->discarded_events); + } else { + BT_LOGV("Set packet context field's `%s` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, + field_name, stream, bt_ctf_stream_get_name(stream), + field, stream->discarded_events); + } + +end: + bt_put(field); + bt_put(field_mapped_clock_class); + return ret; +} + +static +int set_packet_context_timestamp_begin(struct bt_ctf_stream *stream) +{ + int ret = 0; + + if (stream->events->len == 0) { + BT_LOGV("Current packet contains no events: skipping: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); goto end; } - ret = set_packet_header_stream_id(stream); + ret = set_packet_context_timestamp_field(stream, "timestamp_begin", + g_ptr_array_index(stream->events, 0)); + +end: + return ret; +} + +static +int set_packet_context_timestamp_end(struct bt_ctf_stream *stream) +{ + int ret = 0; + + if (stream->events->len == 0) { + BT_LOGV("Current packet contains no events: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = set_packet_context_timestamp_field(stream, "timestamp_end", + g_ptr_array_index(stream->events, stream->events->len - 1)); + +end: + return ret; +} + +static +int auto_populate_packet_context(struct bt_ctf_stream *stream) +{ + int ret = 0; + + if (!stream->packet_context) { + goto end; + } + + ret = set_packet_context_packet_size(stream); if (ret) { - BT_LOGW("Cannot set packet header's stream class ID field: " + BT_LOGW("Cannot set packet context's packet size field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = set_packet_context_content_size(stream); + if (ret) { + BT_LOGW("Cannot set packet context's content size field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = set_packet_context_timestamp_begin(stream); + if (ret) { + BT_LOGW("Cannot set packet context's beginning timestamp field: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); goto end; } - BT_LOGV("Set packet header's known fields's values: " + ret = set_packet_context_timestamp_end(stream); + if (ret) { + BT_LOGW("Cannot set packet context's end timestamp field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + ret = set_packet_context_events_discarded(stream); + if (ret) { + BT_LOGW("Cannot set packet context's discarded events count field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + goto end; + } + + BT_LOGV("Automatically populated stream's packet context's known fields: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); @@ -418,45 +667,80 @@ 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); + GString *filename = g_string_new(NULL); + int64_t stream_class_id; + char *file_path = NULL; BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, " "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"", writer, stream, bt_ctf_stream_get_name(stream), stream->stream_class, 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) { - BT_LOGW("Cannot get stream class's ID: " - "stream-class-addr=%p, " - "stream-class-name=\"%s\"", - stream->stream_class, - stream->stream_class->name->str); - fd = -1; - goto end; + if (stream->name && stream->name->len > 0) { + /* Use stream name's base name as prefix */ + gchar *basename = g_path_get_basename(stream->name->str); + + assert(basename); + + if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { + g_string_assign(filename, "stream"); + } else { + g_string_assign(filename, basename); } - g_string_printf(filename, "stream_%" PRId64, ret); + g_free(basename); + goto append_ids; + } + + if (stream->stream_class->name && + stream->stream_class->name->len > 0) { + /* Use stream class name's base name as prefix */ + gchar *basename = + g_path_get_basename(stream->stream_class->name->str); + + assert(basename); + + if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { + g_string_assign(filename, "stream"); + } else { + g_string_assign(filename, basename); + } + + g_free(basename); + goto append_ids; + } + + /* Default to using `stream-` as prefix */ + g_string_assign(filename, "stream"); + +append_ids: + stream_class_id = bt_ctf_stream_class_get_id(stream->stream_class); + assert(stream_class_id >= 0); + assert(stream->id >= 0); + g_string_append_printf(filename, "-%" PRId64 "-%" PRId64, + stream_class_id, stream->id); + + file_path = g_build_filename(writer->path->str, filename->str, NULL); + if (file_path == NULL) { + fd = -1; + goto end; } - g_string_append_printf(filename, "_%" PRIu32, stream->id); - fd = openat(writer->trace_dir_fd, filename->str, + fd = open(file_path, O_RDWR | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP); + g_free(file_path); if (fd < 0) { - BT_LOGW("Failed to open stream file for writing: " - "writer-trace-dir-fd=%d, filename=\"%s\"", - writer->trace_dir_fd, filename->str); + BT_LOGW_ERRNO("Failed to open stream file for writing", + ": file_path=\"%s\", filename=\"%s\", ret=%d", + file_path, filename->str, fd); goto end; } BT_LOGD("Created stream file for writing: " - "stream-addr=%p, stream-name=\"%s\", writer-trace-dir-fd=%d, " + "stream-addr=%p, stream-name=\"%s\", " "filename=\"%s\", fd=%d", stream, bt_ctf_stream_get_name(stream), - writer->trace_dir_fd, filename->str, fd); + filename->str, fd); end: g_string_free(filename, TRUE); @@ -480,9 +764,10 @@ void component_destroy_listener(struct bt_component *component, void *data) g_hash_table_remove(stream->comp_cur_port, component); } -struct bt_ctf_stream *bt_ctf_stream_create( +static +struct bt_ctf_stream *bt_ctf_stream_create_with_id_no_check( struct bt_ctf_stream_class *stream_class, - const char *name) + const char *name, uint64_t id) { int ret; struct bt_ctf_stream *stream = NULL; @@ -495,13 +780,15 @@ struct bt_ctf_stream *bt_ctf_stream_create( } BT_LOGD("Creating stream object: stream-class-addr=%p, " - "stream-class-name=\"%s\", stream-name=\"%s\"", + "stream-class-name=\"%s\", stream-name=\"%s\", " + "stream-id=%" PRIu64, stream_class, bt_ctf_stream_class_get_name(stream_class), - name); - trace = bt_ctf_stream_class_get_trace(stream_class); + name, id); + trace = bt_ctf_stream_class_borrow_trace(stream_class); if (!trace) { BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " - "stream-class-name=\"%s\", stream-class-name=\"%s\"", + "stream-class-addr=%p, stream-class-name=\"%s\", " + "stream-name=\"%s\"", stream_class, bt_ctf_stream_class_get_name(stream_class), name); goto error; @@ -514,13 +801,36 @@ struct bt_ctf_stream *bt_ctf_stream_create( * no more can be added, and each object is also frozen. */ BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: " - "stream-class-name=\"%s\", stream-class-name=\"%s\", " - "trace-addr=%p", + "stream-class-addr=%p, stream-class-name=\"%s\", " + "stream-name=\"%s\", trace-addr=%p", stream_class, bt_ctf_stream_class_get_name(stream_class), - name, trace);; + name, trace); goto error; } + if (id != -1ULL) { + /* + * Validate that the given ID is unique amongst all the + * existing trace's streams created from the same stream + * class. + */ + size_t i; + + for (i = 0; i < trace->streams->len; i++) { + struct bt_ctf_stream *trace_stream = + g_ptr_array_index(trace->streams, i); + + if (trace_stream->stream_class != stream_class) { + continue; + } + + if (trace_stream->id == id) { + BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID."); + goto error; + } + } + } + stream = g_new0(struct bt_ctf_stream, 1); if (!stream) { BT_LOGE_STR("Failed to allocate one stream."); @@ -533,9 +843,9 @@ struct bt_ctf_stream *bt_ctf_stream_create( * reachable; it needs its parent to remain valid. */ bt_object_set_parent(stream, trace); - stream->id = stream_class->next_stream_id++; stream->stream_class = stream_class; stream->pos.fd = -1; + stream->id = (int64_t) id; stream->destroy_listeners = g_array_new(FALSE, TRUE, sizeof(struct bt_ctf_stream_destroy_listener)); @@ -556,13 +866,13 @@ struct bt_ctf_stream *bt_ctf_stream_create( if (trace->is_created_by_writer) { int fd; - writer = (struct bt_ctf_writer *) - bt_object_get_parent(trace); + writer = (struct bt_ctf_writer *) bt_object_get_parent(trace); + stream->id = (int64_t) stream_class->next_stream_id++; BT_LOGD("Stream object belongs to a writer's trace: " "writer-addr=%p", writer); - assert(writer); + if (stream_class->packet_context_type) { BT_LOGD("Creating stream's packet context field: " "ft-addr=%p", stream_class->packet_context_type); @@ -576,7 +886,7 @@ struct bt_ctf_stream *bt_ctf_stream_create( /* Initialize events_discarded */ ret = try_set_structure_field_integer( stream->packet_context, "events_discarded", 0); - if (ret != 1) { + if (ret < 0) { BT_LOGW("Cannot set `events_discarded` field in packet context: " "ret=%d, packet-context-field-addr=%p", ret, stream->packet_context); @@ -591,15 +901,15 @@ struct bt_ctf_stream *bt_ctf_stream_create( goto error; } - /* A trace is not allowed to have a NULL packet header */ - assert(trace->packet_header_type); - BT_LOGD("Creating stream's packet header field: " - "ft-addr=%p", trace->packet_header_type); - stream->packet_header = - bt_ctf_field_create(trace->packet_header_type); - if (!stream->packet_header) { - BT_LOGW_STR("Cannot create stream's packet header field."); - goto error; + if (trace->packet_header_type) { + BT_LOGD("Creating stream's packet header field: " + "ft-addr=%p", trace->packet_header_type); + stream->packet_header = + bt_ctf_field_create(trace->packet_header_type); + if (!stream->packet_header) { + BT_LOGW_STR("Cannot create stream's packet header field."); + goto error; + } } /* @@ -610,9 +920,9 @@ struct bt_ctf_stream *bt_ctf_stream_create( * make sure to set the trace packet header fields himself * before flushing. */ - ret = set_packet_header(stream); + ret = auto_populate_packet_header(stream); if (ret) { - BT_LOGW_STR("Cannot populate the stream's packet header."); + BT_LOGW_STR("Cannot automatically populate the stream's packet header."); goto error; } @@ -639,20 +949,73 @@ struct bt_ctf_stream *bt_ctf_stream_create( } } - /* Add this stream to the trace's streams */ - g_ptr_array_add(trace->streams, stream); + /* Add this stream to the trace's streams */ + g_ptr_array_add(trace->streams, stream); + BT_LOGD("Created stream object: addr=%p", stream); + goto end; + +error: + BT_PUT(stream); + +end: + bt_put(writer); + return stream; +} + +struct bt_ctf_stream *bt_ctf_stream_create_with_id( + struct bt_ctf_stream_class *stream_class, + const char *name, uint64_t id_param) +{ + struct bt_ctf_trace *trace; + struct bt_ctf_stream *stream = NULL; + int64_t id = (int64_t) id_param; + + if (!stream_class) { + BT_LOGW_STR("Invalid parameter: stream class is NULL."); + goto end; + } + + if (id < 0) { + BT_LOGW("Invalid parameter: invalid stream's ID: " + "name=\"%s\", id=%" PRIu64, + name, id_param); + goto end; + } + + trace = bt_ctf_stream_class_borrow_trace(stream_class); + if (!trace) { + BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " + "stream-class-addr=%p, stream-class-name=\"%s\", " + "stream-name=\"%s\", stream-id=%" PRIu64, + stream_class, bt_ctf_stream_class_get_name(stream_class), + name, id_param); + goto end; + } - BT_PUT(trace); - BT_PUT(writer); - BT_LOGD("Created stream object: addr=%p", stream); - return stream; -error: - BT_PUT(stream); - BT_PUT(trace); - BT_PUT(writer); + if (trace->is_created_by_writer) { + BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_ctf_stream_create(): " + "stream-class-addr=%p, stream-class-name=\"%s\", " + "stream-name=\"%s\", stream-id=%" PRIu64, + stream_class, bt_ctf_stream_class_get_name(stream_class), + name, id_param); + goto end; + } + + stream = bt_ctf_stream_create_with_id_no_check(stream_class, + name, id_param); + +end: return stream; } +struct bt_ctf_stream *bt_ctf_stream_create( + struct bt_ctf_stream_class *stream_class, + const char *name) +{ + return bt_ctf_stream_create_with_id_no_check(stream_class, + name, -1ULL); +} + struct bt_ctf_stream_class *bt_ctf_stream_get_class( struct bt_ctf_stream *stream) { @@ -672,10 +1035,7 @@ end: int bt_ctf_stream_get_discarded_events_count( struct bt_ctf_stream *stream, uint64_t *count) { - int64_t ret = 0; - int field_signed; - struct bt_ctf_field *events_discarded_field = NULL; - struct bt_ctf_field_type *events_discarded_field_type = NULL; + int ret = 0; if (!stream) { BT_LOGW_STR("Invalid parameter: stream is NULL."); @@ -689,79 +1049,48 @@ int bt_ctf_stream_get_discarded_events_count( goto end; } - if (!stream->packet_context) { - /* Not an error */ - BT_LOGV("Stream has no packet context field: " + if (stream->pos.fd < 0) { + BT_LOGW("Invalid parameter: stream is not a CTF writer stream: " "stream-addr=%p, stream-name=\"%s\"", stream, bt_ctf_stream_get_name(stream)); ret = -1; goto end; } - if (stream->pos.fd < 0) { - BT_LOGW("Invalid parameter: stream is not a CTF writer stream: " - "stream-addr=%p, stream-name=\"%s\"", - stream, bt_ctf_stream_get_name(stream)); - ret = -1; + *count = (uint64_t) stream->discarded_events; + +end: + return ret; +} + +static +int set_packet_context_events_discarded_field(struct bt_ctf_stream *stream, + uint64_t count) +{ + int ret = 0; + struct bt_ctf_field *events_discarded_field = NULL; + + if (!stream->packet_context) { goto end; } events_discarded_field = bt_ctf_field_structure_get_field( stream->packet_context, "events_discarded"); if (!events_discarded_field) { - BT_LOGW("Cannot get packet context's `events_discarded` field: " - "stream-addr=%p, stream-name=\"%s\", " - "packet-context-field-addr=%p", - stream, bt_ctf_stream_get_name(stream), - stream->packet_context); - ret = -1; goto end; } - events_discarded_field_type = bt_ctf_field_get_type( - events_discarded_field); - assert(events_discarded_field_type); - field_signed = bt_ctf_field_type_integer_get_signed( - events_discarded_field_type); - assert(field_signed >= 0); - - if (field_signed) { - int64_t signed_count; - - ret = bt_ctf_field_signed_integer_get_value( - events_discarded_field, &signed_count); - if (ret) { - BT_LOGW("Cannot get packet context's `events_discarded` field value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p", - stream, bt_ctf_stream_get_name(stream), - events_discarded_field); - goto end; - } - if (signed_count < 0) { - /* Invalid value */ - BT_LOGW("Invalid value for packet context's `events_discarded` field: must be zero or positive: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " - "value=%" PRId64, stream, - bt_ctf_stream_get_name(stream), - events_discarded_field, signed_count); - ret = -1; - goto end; - } - *count = (uint64_t) signed_count; - } else { - ret = bt_ctf_field_unsigned_integer_get_value( + ret = bt_ctf_field_unsigned_integer_set_value( + events_discarded_field, count); + if (ret) { + BT_LOGW("Cannot set packet context's `events_discarded` field: " + "field-addr=%p, value=%" PRIu64, events_discarded_field, count); - if (ret) { - BT_LOGW("Cannot get packet context's `events_discarded` field value: " - "stream-addr=%p, stream-name=\"%s\", field-addr=%p", - stream, bt_ctf_stream_get_name(stream), - events_discarded_field); - goto end; - } + goto end; } + end: bt_put(events_discarded_field); - bt_put(events_discarded_field_type); return ret; } @@ -769,11 +1098,8 @@ void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count) { int ret; - int field_signed; - uint64_t previous_count; uint64_t new_count; struct bt_ctf_field *events_discarded_field = NULL; - struct bt_ctf_field_type *events_discarded_field_type = NULL; if (!stream) { BT_LOGW_STR("Invalid parameter: stream is NULL."); @@ -794,56 +1120,34 @@ void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, goto end; } - ret = bt_ctf_stream_get_discarded_events_count(stream, - &previous_count); - if (ret) { - BT_LOGW_STR("Cannot get stream's number of discarded events."); - goto end; - } - events_discarded_field = bt_ctf_field_structure_get_field( stream->packet_context, "events_discarded"); if (!events_discarded_field) { - BT_LOGW_STR("No field named `events_discarded` in packet context."); + BT_LOGW_STR("No field named `events_discarded` in stream's packet context."); goto end; } - events_discarded_field_type = bt_ctf_field_get_type( - events_discarded_field); - assert(events_discarded_field_type); - field_signed = bt_ctf_field_type_integer_get_signed( - events_discarded_field_type); - assert(field_signed >= 0); - new_count = previous_count + event_count; - assert(new_count >= previous_count); - if (field_signed) { - ret = bt_ctf_field_signed_integer_set_value( - events_discarded_field, (int64_t) new_count); - if (ret) { - BT_LOGW("Cannot set packet context's `events_discarded` field: " - "field-addr=%p, value=%" PRId64, - events_discarded_field, (int64_t) new_count); - goto end; - } - } else { - ret = bt_ctf_field_unsigned_integer_set_value( - events_discarded_field, new_count); - if (ret) { - BT_LOGW("Cannot set packet context's `events_discarded` field: " - "field-addr=%p, value=%" PRIu64, - events_discarded_field, new_count); - goto end; - } + new_count = stream->discarded_events + event_count; + if (new_count < stream->discarded_events) { + BT_LOGW("New discarded events count is less than the stream's current discarded events count: " + "cur-count=%" PRIu64 ", new-count=%" PRIu64, + stream->discarded_events, new_count); + goto end; + } + + ret = set_packet_context_events_discarded_field(stream, new_count); + if (ret) { + /* set_packet_context_events_discarded_field() logs errors */ + goto end; } + stream->discarded_events = new_count; BT_LOGV("Appended discarded events to stream: " "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, stream, bt_ctf_stream_get_name(stream), event_count); - end: bt_put(events_discarded_field); - bt_put(events_discarded_field_type); } static int auto_populate_event_header(struct bt_ctf_stream *stream, @@ -852,31 +1156,32 @@ static int auto_populate_event_header(struct bt_ctf_stream *stream, int ret = 0; struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL; struct bt_ctf_clock_class *mapped_clock_class = NULL; - uint64_t event_class_id; + int64_t event_class_id; assert(event); + if (!event->event_header) { + goto end; + } + if (event->frozen) { BT_LOGW_STR("Cannot populate event header field: event is frozen."); ret = -1; goto end; } - BT_LOGV("Automatically populating event header field: " + BT_LOGV("Automatically populating event's header field: " "stream-addr=%p, stream-name=\"%s\", event-addr=%p", stream, bt_ctf_stream_get_name(stream), event); - /* - * 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"); - event_class_id = (uint64_t) bt_ctf_event_class_get_id(event->event_class); - assert(event_class_id >= 0); - if (id_field && !bt_ctf_field_is_set(id_field)) { + event_class_id = bt_ctf_event_class_get_id(event->event_class); + if (event_class_id < 0) { + BT_LOGE("Event class ID cannot be found"); + ret = -1; + goto end; + } + if (id_field && bt_ctf_field_type_is_integer(id_field->type)) { ret = set_integer_field_value(id_field, event_class_id); if (ret) { BT_LOGW("Cannot set event header's `id` field's value: " @@ -896,22 +1201,17 @@ static int auto_populate_event_header(struct bt_ctf_stream *stream, * 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) { + if (timestamp_field && stream->stream_class->clock && + bt_ctf_field_type_is_integer(timestamp_field->type)) { 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); + timestamp_field->type); if (mapped_clock_class == stream_class_clock_class) { uint64_t timestamp; @@ -930,7 +1230,7 @@ static int auto_populate_event_header(struct bt_ctf_stream *stream, } } - BT_LOGV("Automatically populated event header field: " + BT_LOGV("Automatically populated event's header field: " "stream-addr=%p, stream-name=\"%s\", event-addr=%p", stream, bt_ctf_stream_get_name(stream), event); @@ -1144,7 +1444,25 @@ int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, } trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); + + if (!field) { + if (trace->packet_header_type) { + BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: " + "stream-addr=%p, stream-name=\"%s\", " + "packet-header-field-addr=%p, " + "expected-ft-addr=%p", + stream, bt_ctf_stream_get_name(stream), + field, trace->packet_header_type); + ret = -1; + goto end; + } + + goto skip_validation; + } + field_type = bt_ctf_field_get_type(field); + assert(field_type); + if (bt_ctf_field_type_compare(field_type, trace->packet_header_type)) { BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: " "stream-addr=%p, stream-name=\"%s\", " @@ -1156,6 +1474,7 @@ int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, goto end; } +skip_validation: bt_put(stream->packet_header); stream->packet_header = bt_get(field); BT_LOGV("Set stream's packet header field: " @@ -1168,99 +1487,31 @@ end: 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) { - BT_LOGV("Cannot get event header's `timestamp` field: " - "field-addr=%p", 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) != - BT_CTF_FIELD_TYPE_ID_INTEGER) { - BT_LOGW("Invalid event header: `timestamp` field's type is not an integer field type: " - "event-header-field-addr=%p, " - "timestamp-field-addr=%p, timestamp-ft-addr=%p, " - "timestamp-ft-id=%s", - event_header, timestamp_field, timestamp_field_type, - bt_ctf_field_type_id_string(timestamp_field_type->id)); - 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) { - BT_LOGW("Cannot get signed integer field's value: " - "event-header-field-addr=%p, " - "timestamp-field-addr=%p", - event_header, timestamp_field); - goto end; - } - *timestamp = (uint64_t) val; - } else { - ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field, - timestamp); - if (ret) { - BT_LOGW("Cannot get unsigned integer field's value: " - "event-header-field-addr=%p, " - "timestamp-field-addr=%p", - event_header, timestamp_field); - goto end; - } - } -end: - bt_put(timestamp_field); - bt_put(timestamp_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); + if (member) { + (void) bt_ctf_field_reset_value(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; - struct bt_ctf_field *integer = NULL; struct bt_ctf_stream_pos packet_context_pos; struct bt_ctf_trace *trace; enum bt_ctf_byte_order native_byte_order; - bt_bool empty_packet; - uint64_t packet_size_bits; - struct { - bt_bool timestamp_begin; - bt_bool timestamp_end; - bt_bool content_size; - bt_bool packet_size; - } auto_set_fields = { 0 }; + bool has_packet_size = false; if (!stream) { BT_LOGW_STR("Invalid parameter: stream is NULL."); ret = -1; - goto end; + goto end_no_stream; } if (stream->pos.fd < 0) { @@ -1269,15 +1520,27 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) goto end; } - 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. - */ - BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once."); - ret = -1; - goto end; + if (stream->packet_context) { + struct bt_ctf_field *packet_size_field; + + packet_size_field = bt_ctf_field_structure_get_field( + stream->packet_context, "packet_size"); + has_packet_size = (packet_size_field != NULL); + bt_put(packet_size_field); + } + + if (stream->flushed_packet_count == 1) { + if (!stream->packet_context) { + BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once."); + ret = -1; + goto end; + } + + if (!has_packet_size) { + BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once."); + ret = -1; + goto end; + } } BT_LOGV("Flushing stream's current packet: stream-addr=%p, " @@ -1286,74 +1549,39 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) trace = bt_ctf_stream_class_borrow_trace(stream->stream_class); assert(trace); native_byte_order = bt_ctf_trace_get_native_byte_order(trace); - empty_packet = (stream->events->len == 0); - /* mmap the next packet */ - BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64, - stream->pos.offset); - bt_ctf_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR); - BT_LOGV_STR("Serializing packet header field."); - ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos, - native_byte_order); + ret = auto_populate_packet_header(stream); if (ret) { - BT_LOGE("Cannot serialize stream's packet header field: " - "field-addr=%p", stream->packet_header); + BT_LOGW_STR("Cannot automatically populate the stream's packet header field."); + ret = -1; 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) { - BT_LOGW("Cannot set `timestamp_begin` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); - goto end; - } - auto_set_fields.timestamp_begin = ret == 1; - } + ret = auto_populate_packet_context(stream); + if (ret) { + BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); + ret = -1; + goto 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)) { + /* mmap the next packet */ + BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64, + stream->pos.offset); + bt_ctf_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR); + assert(stream->pos.packet_size % 8 == 0); - ret = try_set_structure_field_integer( - stream->packet_context, - "timestamp_end", timestamp_end); - if (ret < 0) { - BT_LOGW("Cannot set `timestamp_end` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); - 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) { - BT_LOGW("Cannot set `content_size` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); - goto end; - } - auto_set_fields.content_size = ret == 1; - - ret = try_set_structure_field_integer(stream->packet_context, - "packet_size", UINT64_MAX); - if (ret < 0) { - BT_LOGW("Cannot set `packet_size` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); + if (stream->packet_header) { + BT_LOGV_STR("Serializing packet header field."); + ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos, + native_byte_order); + if (ret) { + BT_LOGW("Cannot serialize stream's packet header field: " + "field-addr=%p", stream->packet_header); goto end; } - auto_set_fields.packet_size = ret == 1; + } + if (stream->packet_context) { /* Write packet context */ memcpy(&packet_context_pos, &stream->pos, sizeof(packet_context_pos)); @@ -1361,7 +1589,7 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) ret = bt_ctf_field_serialize(stream->packet_context, &stream->pos, native_byte_order); if (ret) { - BT_LOGE("Cannot serialize stream's packet context field: " + BT_LOGW("Cannot serialize stream's packet context field: " "field-addr=%p", stream->packet_context); goto end; } @@ -1375,7 +1603,7 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) struct bt_ctf_event_class *event_class = bt_ctf_event_borrow_event_class(event); - BT_LOGV("Serializing event: index=%u, event-addr=%p, " + BT_LOGV("Serializing event: index=%zu, event-addr=%p, " "event-class-name=\"%s\", event-class-id=%" PRId64 ", " "pos-offset=%" PRId64 ", packet-size=%" PRIu64, i, event, bt_ctf_event_class_get_name(event_class), @@ -1383,13 +1611,15 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) stream->pos.offset, stream->pos.packet_size); /* Write event header */ - BT_LOGV_STR("Serializing event's header field."); - ret = bt_ctf_field_serialize(event->event_header, - &stream->pos, native_byte_order); - if (ret) { - BT_LOGE("Cannot serialize event's header field: " - "field-addr=%p", event->event_header); - goto end; + if (event->event_header) { + BT_LOGV_STR("Serializing event's header field."); + ret = bt_ctf_field_serialize(event->event_header, + &stream->pos, native_byte_order); + if (ret) { + BT_LOGW("Cannot serialize event's header field: " + "field-addr=%p", event->event_header); + goto end; + } } /* Write stream event context */ @@ -1399,7 +1629,7 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) event->stream_event_context, &stream->pos, native_byte_order); if (ret) { - BT_LOGE("Cannot serialize event's stream event context field: " + BT_LOGW("Cannot serialize event's stream event context field: " "field-addr=%p", event->stream_event_context); goto end; } @@ -1414,47 +1644,68 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) } } - /* 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; + if (!has_packet_size && stream->pos.offset % 8 != 0) { + BT_LOGW("Stream's packet context field type has no `packet_size` field, " + "but current content size is not a multiple of 8 bits: " + "content-size=%" PRId64 ", " + "packet-size=%" PRIu64, + stream->pos.offset, + stream->pos.packet_size); + ret = -1; + goto end; + } + + assert(stream->pos.packet_size % 8 == 0); + + /* + * Remove extra padding bytes. + */ + stream->pos.packet_size = (stream->pos.offset + 7) & ~7; 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). + * The whole packet is serialized at this point. Make sure that, + * if `packet_size` is missing, the current content size is + * equal to the current packet size. */ - 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) { - BT_LOGW("Cannot set `content_size` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, "content_size"); + + bt_put(field); + if (!field) { + if (stream->pos.offset != stream->pos.packet_size) { + BT_LOGW("Stream's packet context's `content_size` field is missing, " + "but current packet's content size is not equal to its packet size: " + "content-size=%" PRId64 ", " + "packet-size=%" PRIu64, + stream->pos.offset, + stream->pos.packet_size); + ret = -1; goto end; } } - if (auto_set_fields.packet_size) { - ret = set_structure_field_integer(stream->packet_context, - "packet_size", packet_size_bits); - if (ret < 0) { - BT_LOGW("Cannot set `packet_size` field in packet context: " - "ret=%d, packet-context-field-addr=%p", - ret, stream->packet_context); - goto end; - } + /* + * Overwrite the packet context now that the stream + * position's packet and content sizes have the correct + * values. + * + * 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 = auto_populate_packet_context(stream); + if (ret) { + BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); + ret = -1; + goto end; } BT_LOGV("Rewriting (serializing) packet context field."); ret = bt_ctf_field_serialize(stream->packet_context, &packet_context_pos, native_byte_order); if (ret) { - BT_LOGE("Cannot serialize stream's packet context field: " + BT_LOGW("Cannot serialize stream's packet context field: " "field-addr=%p", stream->packet_context); goto end; } @@ -1462,26 +1713,17 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) g_ptr_array_set_size(stream->events, 0); stream->flushed_packet_count++; - stream->size += packet_size_bits / CHAR_BIT; + stream->size += stream->pos.packet_size / 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"); + if (stream->packet_context) { + reset_structure_field(stream->packet_context, "timestamp_begin"); + reset_structure_field(stream->packet_context, "timestamp_end"); + reset_structure_field(stream->packet_context, "packet_size"); + reset_structure_field(stream->packet_context, "content_size"); + reset_structure_field(stream->packet_context, "events_discarded"); } - bt_put(integer); if (ret < 0) { /* @@ -1492,9 +1734,12 @@ end: */ stream->pos.packet_size = 0; } else { - BT_LOGV("Flushed stream's current packet: packet-size=%" PRIu64, - packet_size_bits); + BT_LOGV("Flushed stream's current packet: content-size=%" PRId64 ", " + "packet-size=%" PRIu64, + stream->pos.offset, stream->pos.packet_size); } + +end_no_stream: return ret; } @@ -1544,16 +1789,14 @@ void bt_ctf_stream_destroy(struct bt_object *obj) ret = ftruncate(stream->pos.fd, stream->size); } while (ret == -1 && errno == EINTR); if (ret) { - BT_LOGE("Failed to truncate stream file: %s: " - "ret=%d, errno=%d, size=%" PRIu64, - strerror(errno), ret, errno, - (uint64_t) stream->size); + BT_LOGE_ERRNO("Failed to truncate stream file", + ": ret=%d, size=%" PRIu64, + ret, (uint64_t) stream->size); } if (close(stream->pos.fd)) { - BT_LOGE("Failed to close stream file: %s: " - "ret=%d, errno=%d", strerror(errno), - ret, errno); + BT_LOGE_ERRNO("Failed to close stream file", + ": ret=%d", ret); } } @@ -1619,7 +1862,7 @@ int _set_structure_field_integer(struct bt_ctf_field *structure, char *name, } /* Make sure the payload has not already been set. */ - if (!force && bt_ctf_field_is_set(integer)) { + if (!force && bt_ctf_field_value_is_set(integer)) { /* Payload already set, not an error */ BT_LOGV("Field's payload is already set: struct-field-addr=%p, " "name=\"%s\", force=%d", structure, name, force); @@ -1655,13 +1898,6 @@ end: 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, BT_TRUE); -} - /* * Returns the following codes: * 1 if the field was found and set, @@ -1722,15 +1958,16 @@ void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream *stream, * listener so that we remove this hash table entry when we know * the component is destroyed. */ - bt_component_add_destroy_listener(comp, component_destroy_listener, - stream); - g_hash_table_insert(stream->comp_cur_port, comp, port); - BT_LOGV("Mapped component to port for stream: stream-addr=%p, " - "stream-name=\"%s\", comp-addr=%p, comp-name=\"%s\", " - "port-addr=%p, port-name=\"%s\"", + BT_LOGV("Adding component's destroy listener for stream: " + "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, " + "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"", stream, bt_ctf_stream_get_name(stream), comp, bt_component_get_name(comp), port, bt_port_get_name(port)); + bt_component_add_destroy_listener(comp, component_destroy_listener, + stream); + g_hash_table_insert(stream->comp_cur_port, comp, port); + BT_LOGV_STR("Mapped component to port for stream."); } BT_HIDDEN @@ -1783,3 +2020,23 @@ void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream *stream, } } } + +int64_t bt_ctf_stream_get_id(struct bt_ctf_stream *stream) +{ + int64_t ret; + + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + ret = (int64_t) -1; + goto end; + } + + ret = stream->id; + if (ret < 0) { + BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + } + +end: + return ret; +}