X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fctf-ir%2Fstream.c;h=5741a7a520f6fbc4126f50ec031b5be12f269174;hb=7d7fae6d7f0be96112fe30e47715b83f169bff52;hp=a06cbbbf64a7844e0878ff533137290ea409c040;hpb=1487a16a42ca7be6b85ef210644d9ac398d7c0dd;p=babeltrace.git diff --git a/lib/ctf-ir/stream.c b/lib/ctf-ir/stream.c index a06cbbbf..5741a7a5 100644 --- a/lib/ctf-ir/stream.c +++ b/lib/ctf-ir/stream.c @@ -26,6 +26,9 @@ * SOFTWARE. */ +#define BT_LOG_TAG "STREAM" +#include + #include #include #include @@ -36,20 +39,21 @@ #include #include #include +#include #include #include +#include #include #include -#include -#include +#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) @@ -58,6 +62,7 @@ int set_integer_field_value(struct bt_ctf_field* field, uint64_t value) struct bt_ctf_field_type *field_type = NULL; if (!field) { + BT_LOGW_STR("Invalid parameter: field is NULL."); ret = -1; goto end; } @@ -68,6 +73,10 @@ int set_integer_field_value(struct bt_ctf_field* field, uint64_t value) if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_FIELD_TYPE_ID_INTEGER) { /* Not an integer and the value is unset, error. */ + BT_LOGW("Invalid parameter: field's type is not an integer field type: " + "field-addr=%p, ft-addr=%p, ft-id=%s", + field, field_type, + bt_ctf_field_type_id_string(field_type->id)); ret = -1; goto end; } @@ -76,12 +85,18 @@ int set_integer_field_value(struct bt_ctf_field* field, uint64_t value) ret = bt_ctf_field_signed_integer_set_value(field, (int64_t) value); if (ret) { /* Value is out of range, error. */ + BT_LOGW("Cannot set signed integer field's value: " + "addr=%p, value=%" PRId64, + field, (int64_t) value); goto end; } } else { ret = bt_ctf_field_unsigned_integer_set_value(field, value); if (ret) { /* Value is out of range, error. */ + BT_LOGW("Cannot set unsigned integer field's value: " + "addr=%p, value=%" PRIu64, + field, value); goto end; } } @@ -94,188 +109,539 @@ 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; + + assert(stream); if (!magic_field) { /* No magic field found. Not an error, skip. */ + BT_LOGV("No field named `magic` in packet header: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); goto end; } - if (bt_ctf_field_is_set(magic_field)) { - /* Value already set. Not an error, skip. */ - goto end; + ret = bt_ctf_field_unsigned_integer_set_value(magic_field, + (uint64_t) magic_value); + + if (ret) { + 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=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), + magic_field, (uint64_t) magic_value); } +end: + bt_put(magic_field); + return ret; +} - magic_field_type = bt_ctf_field_get_type(magic_field); - assert(magic_field_type); +static +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 *uuid_field = bt_ctf_field_structure_get_field( + stream->packet_header, "uuid"); + + assert(stream); - 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. */ + if (!uuid_field) { + /* No uuid field found. Not an error, skip. */ + BT_LOGV("No field named `uuid` in packet header: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); 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. - */ + 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_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=%" PRIu64 ", index=%" PRId64, + stream, bt_ctf_stream_get_name(stream), + uuid_element, (uint64_t) trace->uuid[i], i); + goto end; + } + } + + BT_LOGV("Set packet header field's `uuid` field's value: " + "stream-addr=%p, stream-name=\"%s\", field-addr=%p", + stream, bt_ctf_stream_get_name(stream), uuid_field); + +end: + bt_put(uuid_field); + BT_PUT(trace); + return ret; +} +static +int set_packet_header_stream_id(struct bt_ctf_stream *stream) +{ + int ret = 0; + uint32_t stream_id; + struct bt_ctf_field *stream_id_field = bt_ctf_field_structure_get_field( + stream->packet_header, "stream_id"); + + if (!stream_id_field) { + /* No stream_id field found. Not an error, skip. */ + BT_LOGV("No field named `stream_id` in packet header: skipping: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); goto end; } - ret = bt_ctf_field_type_integer_get_signed(magic_field_type); - assert(ret >= 0); + stream_id = stream->stream_class->id; + ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, + (uint64_t) stream_id); if (ret) { - ret = bt_ctf_field_signed_integer_set_value(magic_field, - (int64_t) 0xC1FC1FC1); + 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 { - ret = bt_ctf_field_unsigned_integer_set_value(magic_field, - (uint64_t) 0xC1FC1FC1); + 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(magic_field); - bt_put(magic_field_type); + bt_put(stream_id_field); return ret; } static -int set_packet_header_uuid(struct bt_ctf_stream *stream) +int auto_populate_packet_header(struct bt_ctf_stream *stream) { - int i, ret = 0; - 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"); + int ret = 0; - if (!uuid_field) { - /* No uuid field found. Not an error, skip. */ + if (!stream->packet_header) { goto end; } - if (bt_ctf_field_is_set(uuid_field)) { - /* Value already set. Not an error, skip. */ + 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; } - 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. */ + 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; } - if (bt_ctf_field_type_array_get_length(uuid_field_type) != 16) { - /* - * UUID field is not of the expected size. - * Not an error, skip. - */ + 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; } - 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("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; } - 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_unsigned_integer_set_value(field, + stream->pos.packet_size); + if (ret) { + 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 { + 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); + } - ret = bt_ctf_field_type_integer_get_signed(element_field_type); - assert(ret >= 0); +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 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), + field, stream->pos.offset); + } else { + 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), + field, stream->pos.offset); + } + +end: + bt_put(field); + return ret; +} + +static +int set_packet_context_events_discarded(struct bt_ctf_stream *stream) +{ + int ret = 0; + struct bt_ctf_field *field = bt_ctf_field_structure_get_field( + stream->packet_context, "events_discarded"); + + 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) { - 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]); + 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; } - bt_put(uuid_element); - if (ret) { + + 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(uuid_field); - bt_put(uuid_field_type); - bt_put(element_field_type); - BT_PUT(trace); + bt_put(field); return ret; } + static -int set_packet_header_stream_id(struct bt_ctf_stream *stream) +int get_event_header_timestamp(struct bt_ctf_stream *stream, + struct bt_ctf_field *event_header, uint64_t *timestamp) { 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"); + struct bt_ctf_field *timestamp_field = NULL; + struct bt_ctf_clock_class *ts_field_mapped_clock_class = NULL; - if (!stream_id_field) { - /* No stream_id field found. Not an error, skip. */ + *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_is_set(stream_id_field)) { - /* Value already set. Not an error, skip. */ + 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; } - 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. */ + 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; } - stream_id = stream->stream_class->id; - ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type); - assert(ret >= 0); + 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 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; + } + + 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) { - ret = bt_ctf_field_signed_integer_set_value(stream_id_field, - (int64_t) stream_id); + 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 { - ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, - (uint64_t) stream_id); + 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(stream_id_field); - bt_put(stream_id_field_type); + bt_put(field); + bt_put(field_mapped_clock_class); return ret; } static -int set_packet_header(struct bt_ctf_stream *stream) +int set_packet_context_timestamp_begin(struct bt_ctf_stream *stream) { - int ret; + int ret = 0; - ret = set_packet_header_magic(stream); + 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_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 context's packet size field: " + "stream-addr=%p, stream-name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); goto end; } - ret = set_packet_header_uuid(stream); + 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_header_stream_id(stream); + 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; + } + + 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)); + end: return ret; } @@ -301,48 +667,107 @@ 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; - if (stream->stream_class->name->len == 0) { - int64_t ret; + 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); - ret = bt_ctf_stream_class_get_id(stream->stream_class); - if (ret < 0) { - fd = -1; - goto error; + 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); -error: + g_free(file_path); + if (fd < 0) { + 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\", " + "filename=\"%s\", fd=%d", stream, bt_ctf_stream_get_name(stream), + filename->str, fd); + +end: g_string_free(filename, TRUE); return fd; } static -int set_stream_fd(struct bt_ctf_stream *stream, int fd) +void set_stream_fd(struct bt_ctf_stream *stream, int fd) { - int ret = 0; - - if (stream->pos.fd != -1) { - ret = -1; - goto end; - } - (void) bt_ctf_stream_pos_init(&stream->pos, fd, O_RDWR); stream->pos.fd = fd; -end: - return ret; } -struct bt_ctf_stream *bt_ctf_stream_create( +static +void component_destroy_listener(struct bt_component *component, void *data) +{ + struct bt_ctf_stream *stream = data; + + BT_LOGD("Component is being destroyed, stream is notified: " + "comp-addr=%p, stream-addr=%p", component, stream); + g_hash_table_remove(stream->comp_cur_port, component); +} + +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; @@ -350,16 +775,65 @@ struct bt_ctf_stream *bt_ctf_stream_create( struct bt_ctf_writer *writer = NULL; if (!stream_class) { + BT_LOGW_STR("Invalid parameter: stream class is NULL."); goto error; } - trace = bt_ctf_stream_class_get_trace(stream_class); + BT_LOGD("Creating stream object: 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); + 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_class, bt_ctf_stream_class_get_name(stream_class), + name); + goto error; + } + + if (bt_ctf_trace_is_static(trace)) { + /* + * A static trace has the property that all its stream + * classes, clock classes, and streams are definitive: + * 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-addr=%p, stream-class-name=\"%s\", " + "stream-name=\"%s\", trace-addr=%p", + stream_class, bt_ctf_stream_class_get_name(stream_class), + 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."); goto error; } @@ -369,35 +843,53 @@ 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)); + if (!stream->destroy_listeners) { + BT_LOGE_STR("Failed to allocate a GArray."); + goto error; + } if (name) { stream->name = g_string_new(name); if (!stream->name) { + BT_LOGE_STR("Failed to allocate a GString."); goto error; } } + BT_LOGD("Set stream's trace parent: trace-addr=%p", trace); + 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); stream->packet_context = bt_ctf_field_create( stream_class->packet_context_type); if (!stream->packet_context) { + BT_LOGW_STR("Cannot create stream's packet context field."); goto error; } /* Initialize events_discarded */ ret = try_set_structure_field_integer( - stream->packet_context, - "events_discarded", 0); - if (ret != 1) { + stream->packet_context, "events_discarded", 0); + if (ret < 0) { + BT_LOGW("Cannot set `events_discarded` field in packet context: " + "ret=%d, packet-context-field-addr=%p", + ret, stream->packet_context); goto error; } } @@ -405,15 +897,19 @@ struct bt_ctf_stream *bt_ctf_stream_create( stream->events = g_ptr_array_new_with_free_func( (GDestroyNotify) release_event); if (!stream->events) { + BT_LOGE_STR("Failed to allocate a GPtrArray."); 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; + 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; + } } /* @@ -424,51 +920,109 @@ 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 automatically populate the stream's packet header."); goto error; } /* Create file associated with this stream */ fd = create_stream_file(writer, stream); if (fd < 0) { + BT_LOGW_STR("Cannot create stream file."); goto error; } - ret = set_stream_fd(stream, fd); - if (ret) { - goto error; - } + set_stream_fd(stream, fd); /* Freeze the writer */ + BT_LOGD_STR("Freezing stream's CTF writer."); bt_ctf_writer_freeze(writer); } else { /* Non-writer stream indicated by a negative FD */ - ret = set_stream_fd(stream, -1); - if (ret) { + set_stream_fd(stream, -1); + stream->comp_cur_port = g_hash_table_new(g_direct_hash, + g_direct_equal); + if (!stream->comp_cur_port) { + BT_LOGE_STR("Failed to allocate a GHashTable."); goto error; } } /* 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; - BT_PUT(trace); - BT_PUT(writer); - return stream; error: BT_PUT(stream); - BT_PUT(trace); - BT_PUT(writer); + +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; + } + + 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) { struct bt_ctf_stream_class *stream_class = NULL; if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); goto end; } @@ -481,62 +1035,62 @@ end: int bt_ctf_stream_get_discarded_events_count( struct bt_ctf_stream *stream, uint64_t *count) { - int64_t ret = 0; - int field_signed; + int ret = 0; + + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + ret = -1; + goto end; + } + + if (!count) { + BT_LOGW_STR("Invalid parameter: count is NULL."); + 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; + goto end; + } + + *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; - struct bt_ctf_field_type *events_discarded_field_type = NULL; - if (!stream || !count || !stream->packet_context || - stream->pos.fd < 0) { - ret = -1; + if (!stream->packet_context) { goto end; } events_discarded_field = bt_ctf_field_structure_get_field( stream->packet_context, "events_discarded"); if (!events_discarded_field) { - ret = -1; - goto end; - } - - events_discarded_field_type = bt_ctf_field_get_type( - events_discarded_field); - if (!events_discarded_field_type) { - ret = -1; goto end; } - field_signed = bt_ctf_field_type_integer_get_signed( - events_discarded_field_type); - if (field_signed < 0) { - ret = field_signed; + 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); goto end; } - if (field_signed) { - int64_t signed_count; - - ret = bt_ctf_field_signed_integer_get_value( - events_discarded_field, &signed_count); - if (ret) { - goto end; - } - if (signed_count < 0) { - /* Invalid value */ - ret = -1; - goto end; - } - *count = (uint64_t) signed_count; - } else { - ret = bt_ctf_field_unsigned_integer_get_value( - events_discarded_field, count); - if (ret) { - goto end; - } - } end: bt_put(events_discarded_field); - bt_put(events_discarded_field_type); return ret; } @@ -544,58 +1098,56 @@ 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 || !stream->packet_context || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); goto end; } - ret = bt_ctf_stream_get_discarded_events_count(stream, - &previous_count); - if (ret) { + BT_LOGV("Appending discarded events to stream: " + "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, + stream, bt_ctf_stream_get_name(stream), event_count); + + if (!stream->packet_context) { + BT_LOGW_STR("Invalid parameter: stream has no packet context field."); + goto end; + } + + if (stream->pos.fd < 0) { + BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); 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 stream's packet context."); goto end; } - events_discarded_field_type = bt_ctf_field_get_type( - events_discarded_field); - if (!events_discarded_field_type) { + 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; } - field_signed = bt_ctf_field_type_integer_get_signed( - events_discarded_field_type); - if (field_signed < 0) { + ret = set_packet_context_events_discarded_field(stream, new_count); + if (ret) { + /* set_packet_context_events_discarded_field() logs errors */ goto end; } - new_count = previous_count + event_count; - if (field_signed) { - ret = bt_ctf_field_signed_integer_set_value( - events_discarded_field, (int64_t) new_count); - if (ret) { - goto end; - } - } else { - ret = bt_ctf_field_unsigned_integer_set_value( - events_discarded_field, new_count); - if (ret) { - 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, @@ -604,25 +1156,37 @@ 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; + int64_t event_class_id; + + assert(event); + + if (!event->event_header) { + goto end; + } - if (!event || event->frozen) { + if (event->frozen) { + BT_LOGW_STR("Cannot populate event header field: event is 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. - */ + 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); + 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)); + 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: " + "addr=%p, value=%" PRIu64, id_field, + event_class_id); goto end; } } @@ -637,40 +1201,39 @@ 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; ret = bt_ctf_clock_get_value( stream->stream_class->clock, ×tamp); - if (ret) { - goto end; - } - + assert(ret == 0); ret = set_integer_field_value(timestamp_field, timestamp); if (ret) { + BT_LOGW("Cannot set event header's `timestamp` field's value: " + "addr=%p, value=%" PRIu64, + timestamp_field, timestamp); goto end; } } } + 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); + end: bt_put(id_field); bt_put(timestamp_field); @@ -683,11 +1246,31 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, { int ret = 0; - if (!stream || !event || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + ret = -1; + goto end; + } + + if (!event) { + BT_LOGW_STR("Invalid parameter: event is NULL."); + ret = -1; + goto end; + } + + if (stream->pos.fd < 0) { + BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); ret = -1; goto end; } + BT_LOGV("Appending event to stream: " + "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " + "event-class-name=\"%s\", event-class-id=%" PRId64, + stream, bt_ctf_stream_get_name(stream), event, + bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event)), + bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event))); + /* * The event is not supposed to have a parent stream at this * point. The only other way an event can have a parent stream @@ -702,18 +1285,22 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, } bt_object_set_parent(event, stream); + BT_LOGV_STR("Automatically populating the header of the event to append."); ret = auto_populate_event_header(stream, event); if (ret) { + /* auto_populate_event_header() reports errors */ goto error; } /* Make sure the various scopes of the event are set */ + BT_LOGV_STR("Validating event to append."); ret = bt_ctf_event_validate(event); if (ret) { goto error; } /* Save the new event and freeze it */ + BT_LOGV_STR("Freezing the event to append."); bt_ctf_event_freeze(event); g_ptr_array_add(stream->events, event); @@ -723,7 +1310,14 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, * class share the same lifetime guarantees and the reference is no * longer needed. */ + BT_LOGV_STR("Putting the event's class."); bt_put(event->event_class); + BT_LOGV("Appended event to stream: " + "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " + "event-class-name=\"%s\", event-class-id=%" PRId64, + stream, bt_ctf_stream_get_name(stream), event, + bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event)), + bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event))); end: return ret; @@ -743,7 +1337,15 @@ struct bt_ctf_field *bt_ctf_stream_get_packet_context( { struct bt_ctf_field *packet_context = NULL; - if (!stream || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + 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)); goto end; } @@ -761,7 +1363,14 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, int ret = 0; struct bt_ctf_field_type *field_type; - if (!stream || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + ret = -1; + goto end; + } + + if (stream->pos.fd < 0) { + BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); ret = -1; goto end; } @@ -769,6 +1378,12 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, field_type = bt_ctf_field_get_type(field); if (bt_ctf_field_type_compare(field_type, stream->stream_class->packet_context_type)) { + BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: " + "stream-addr=%p, stream-name=\"%s\", " + "packet-context-field-addr=%p, " + "packet-context-ft-addr=%p", + stream, bt_ctf_stream_get_name(stream), + field, field_type); ret = -1; goto end; } @@ -776,6 +1391,10 @@ int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, bt_put(field_type); bt_put(stream->packet_context); stream->packet_context = bt_get(field); + BT_LOGV("Set stream's packet context field: " + "stream-addr=%p, stream-name=\"%s\", " + "packet-context-field-addr=%p", + stream, bt_ctf_stream_get_name(stream), field); end: return ret; } @@ -785,7 +1404,15 @@ struct bt_ctf_field *bt_ctf_stream_get_packet_header( { struct bt_ctf_field *packet_header = NULL; - if (!stream || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); + 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)); goto end; } @@ -804,67 +1431,59 @@ 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 || stream->pos.fd < 0) { + if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); ret = -1; goto end; } - trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); - field_type = bt_ctf_field_get_type(field); - if (bt_ctf_field_type_compare(field_type, trace->packet_header_type)) { + if (stream->pos.fd < 0) { + BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); ret = -1; goto end; } - bt_put(stream->packet_header); - stream->packet_header = bt_get(field); -end: - BT_PUT(trace); - bt_put(field_type); - return ret; -} + trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); -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; + 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; + } - timestamp_field = bt_ctf_field_structure_get_field(event_header, - "timestamp"); - if (!timestamp_field) { - ret = -1; - goto end; + goto skip_validation; } - 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) { + 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\", " + "packet-header-field-addr=%p, " + "packet-header-ft-addr=%p", + stream, bt_ctf_stream_get_name(stream), + field, field_type); ret = -1; goto end; } - if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) { - int64_t val; - - ret = bt_ctf_field_signed_integer_get_value(timestamp_field, - &val); - if (ret) { - goto end; - } - *timestamp = (uint64_t) val; - } else { - ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field, - timestamp); - if (ret) { - goto end; - } - } +skip_validation: + bt_put(stream->packet_header); + stream->packet_header = bt_get(field); + BT_LOGV("Set stream's packet header field: " + "stream-addr=%p, stream-name=\"%s\", " + "packet-header-field-addr=%p", + stream, bt_ctf_stream_get_name(stream), field); end: - bt_put(timestamp_field); - bt_put(timestamp_field_type); + BT_PUT(trace); + bt_put(field_type); return ret; } @@ -874,129 +1493,144 @@ 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; - 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) { - /* - * Stream does not have an associated fd. It is, - * therefore, not a stream being used to write events. - */ + 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->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. - */ + if (stream->pos.fd < 0) { + BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); 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, " + "stream-name=\"%s\", packet-index=%u", stream, + bt_ctf_stream_get_name(stream), stream->flushed_packet_count); trace = bt_ctf_stream_class_borrow_trace(stream->stream_class); assert(trace); - native_byte_order = bt_ctf_trace_get_byte_order(trace); - empty_packet = (stream->events->len == 0); + native_byte_order = bt_ctf_trace_get_native_byte_order(trace); - /* mmap the next packet */ - bt_ctf_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR); - ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos, - native_byte_order); + ret = auto_populate_packet_header(stream); if (ret) { + 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) { - goto end; - } - auto_set_fields.timestamp_begin = ret == 1; - } - - 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 = auto_populate_packet_context(stream); + if (ret) { + BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); + ret = -1; + goto end; + } - 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; - } - auto_set_fields.content_size = ret == 1; + /* 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, - "packet_size", UINT64_MAX); - if (ret < 0) { + 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)); + BT_LOGV_STR("Serializing packet context field."); ret = bt_ctf_field_serialize(stream->packet_context, &stream->pos, native_byte_order); if (ret) { + BT_LOGW("Cannot serialize stream's packet context field: " + "field-addr=%p", stream->packet_context); goto end; } } + BT_LOGV("Serializing events: count=%u", stream->events->len); + for (i = 0; i < stream->events->len; i++) { struct bt_ctf_event *event = g_ptr_array_index( stream->events, i); + struct bt_ctf_event_class *event_class = + bt_ctf_event_borrow_event_class(event); + + 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), + bt_ctf_event_class_get_id(event_class), + stream->pos.offset, stream->pos.packet_size); /* Write event header */ - ret = bt_ctf_field_serialize(event->event_header, - &stream->pos, native_byte_order); - if (ret) { - 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 */ if (event->stream_event_context) { + BT_LOGV_STR("Serializing event's stream event context field."); ret = bt_ctf_field_serialize( event->stream_event_context, &stream->pos, native_byte_order); if (ret) { + BT_LOGW("Cannot serialize event's stream event context field: " + "field-addr=%p", event->stream_event_context); goto end; } } @@ -1005,69 +1639,91 @@ int bt_ctf_stream_flush(struct bt_ctf_stream *stream) ret = bt_ctf_event_serialize(event, &stream->pos, native_byte_order); if (ret) { + /* bt_ctf_event_serialize() logs errors */ 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; + 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) { + 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) { - 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_LOGW("Cannot serialize stream's packet context field: " + "field-addr=%p", stream->packet_context); goto end; } } 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) { /* @@ -1077,15 +1733,23 @@ end: * leave a corrupted packet in the trace. */ stream->pos.packet_size = 0; + } else { + 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; } +/* Pre-2.0 CTF writer backward compatibility */ void bt_ctf_stream_get(struct bt_ctf_stream *stream) { bt_get(stream); } +/* Pre-2.0 CTF writer backward compatibility */ void bt_ctf_stream_put(struct bt_ctf_stream *stream) { bt_put(stream); @@ -1095,8 +1759,23 @@ static void bt_ctf_stream_destroy(struct bt_object *obj) { struct bt_ctf_stream *stream; + int i; stream = container_of(obj, struct bt_ctf_stream, base); + BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"", + stream, bt_ctf_stream_get_name(stream)); + + /* Call destroy listeners in reverse registration order */ + for (i = stream->destroy_listeners->len - 1; i >= 0; i--) { + struct bt_ctf_stream_destroy_listener *listener = + &g_array_index(stream->destroy_listeners, + struct bt_ctf_stream_destroy_listener, i); + + BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d", + listener->func, listener->data, i); + listener->func(stream, listener->data); + } + (void) bt_ctf_stream_pos_fini(&stream->pos); if (stream->pos.fd >= 0) { int ret; @@ -1110,15 +1789,19 @@ void bt_ctf_stream_destroy(struct bt_object *obj) ret = ftruncate(stream->pos.fd, stream->size); } while (ret == -1 && errno == EINTR); if (ret) { - perror("ftruncate"); + BT_LOGE_ERRNO("Failed to truncate stream file", + ": ret=%d, size=%" PRIu64, + ret, (uint64_t) stream->size); } if (close(stream->pos.fd)) { - perror("close"); + BT_LOGE_ERRNO("Failed to close stream file", + ": ret=%d", ret); } } if (stream->events) { + BT_LOGD_STR("Putting events."); g_ptr_array_free(stream->events, TRUE); } @@ -1126,33 +1809,63 @@ void bt_ctf_stream_destroy(struct bt_object *obj) g_string_free(stream->name, TRUE); } + if (stream->comp_cur_port) { + GHashTableIter ht_iter; + gpointer comp_gptr, port_gptr; + + /* + * Since we're destroying the stream, remove the destroy + * listeners that it registered for each component in + * its component-port mapping hash table. Otherwise they + * would be called and the stream would be accessed once + * it's freed or another stream would be accessed. + */ + g_hash_table_iter_init(&ht_iter, stream->comp_cur_port); + + while (g_hash_table_iter_next(&ht_iter, &comp_gptr, &port_gptr)) { + assert(comp_gptr); + bt_component_remove_destroy_listener((void *) comp_gptr, + component_destroy_listener, stream); + } + + g_hash_table_destroy(stream->comp_cur_port); + } + + if (stream->destroy_listeners) { + g_array_free(stream->destroy_listeners, TRUE); + } + + BT_LOGD_STR("Putting packet header field."); bt_put(stream->packet_header); + BT_LOGD_STR("Putting packet context field."); bt_put(stream->packet_context); g_free(stream); } static int _set_structure_field_integer(struct bt_ctf_field *structure, char *name, - uint64_t value, bool force) + uint64_t value, bt_bool force) { int ret = 0; struct bt_ctf_field_type *field_type = NULL; - struct bt_ctf_field *integer = - bt_ctf_field_structure_get_field(structure, name); + struct bt_ctf_field *integer; - if (!structure || !name) { - ret = -1; - goto end; - } + assert(structure); + assert(name); + integer = bt_ctf_field_structure_get_field(structure, name); if (!integer) { /* Field not found, not an error. */ + BT_LOGV("Field not found: struct-field-addr=%p, " + "name=\"%s\", force=%d", structure, name, force); goto end; } /* 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); goto end; } @@ -1164,6 +1877,10 @@ int _set_structure_field_integer(struct bt_ctf_field *structure, char *name, * automatically. However, we can only do this if the field * is an integer. Return an error. */ + BT_LOGW("Invalid parameter: field's type is not an integer field type: " + "field-addr=%p, ft-addr=%p, ft-id=%s", + integer, field_type, + bt_ctf_field_type_id_string(field_type->id)); ret = -1; goto end; } @@ -1181,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, true); -} - /* * Returns the following codes: * 1 if the field was found and set, @@ -1198,7 +1908,7 @@ 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); + return _set_structure_field_integer(structure, name, value, BT_FALSE); } const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream) @@ -1206,6 +1916,7 @@ const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream) const char *name = NULL; if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); goto end; } @@ -1220,6 +1931,7 @@ int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream) int ret = -1; if (!stream) { + BT_LOGW_STR("Invalid parameter: stream is NULL."); goto end; } @@ -1228,3 +1940,103 @@ int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream) end: return ret; } + +BT_HIDDEN +void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream *stream, + struct bt_component *comp, + struct bt_port *port) +{ + assert(stream); + assert(comp); + assert(port); + assert(stream->comp_cur_port); + + /* + * Do not take a reference to the component here because we + * don't want the component to exist as long as this stream + * exists. Instead, keep a weak reference, but add a destroy + * listener so that we remove this hash table entry when we know + * the component is destroyed. + */ + 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 +struct bt_port *bt_ctf_stream_port_for_component(struct bt_ctf_stream *stream, + struct bt_component *comp) +{ + assert(stream); + assert(comp); + assert(stream->comp_cur_port); + return g_hash_table_lookup(stream->comp_cur_port, comp); +} + +BT_HIDDEN +void bt_ctf_stream_add_destroy_listener(struct bt_ctf_stream *stream, + bt_ctf_stream_destroy_listener_func func, void *data) +{ + struct bt_ctf_stream_destroy_listener listener; + + assert(stream); + assert(func); + listener.func = func; + listener.data = data; + g_array_append_val(stream->destroy_listeners, listener); + BT_LOGV("Added stream destroy listener: stream-addr=%p, " + "stream-name=\"%s\", func=%p, data=%p", + stream, bt_ctf_stream_get_name(stream), func, data); +} + +BT_HIDDEN +void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream *stream, + bt_ctf_stream_destroy_listener_func func, void *data) +{ + size_t i; + + assert(stream); + assert(func); + + for (i = 0; i < stream->destroy_listeners->len; i++) { + struct bt_ctf_stream_destroy_listener *listener = + &g_array_index(stream->destroy_listeners, + struct bt_ctf_stream_destroy_listener, i); + + if (listener->func == func && listener->data == data) { + g_array_remove_index(stream->destroy_listeners, i); + i--; + BT_LOGV("Removed stream destroy listener: stream-addr=%p, " + "stream-name=\"%s\", func=%p, data=%p", + stream, bt_ctf_stream_get_name(stream), + func, data); + } + } +} + +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; +}