* SOFTWARE.
*/
+#define BT_LOG_TAG "STREAM"
+#include <babeltrace/lib-logging-internal.h>
+
#include <babeltrace/ctf-ir/clock-class.h>
#include <babeltrace/ctf-writer/clock.h>
#include <babeltrace/ctf-writer/clock-internal.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-internal.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
+#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/ctf-writer/writer-internal.h>
+#include <babeltrace/graph/component-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/ctf-writer/functor-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/align-internal.h>
+#include <babeltrace/assert-internal.h>
#include <inttypes.h>
+#include <unistd.h>
static
-void bt_ctf_stream_destroy(struct bt_object *obj);
-static
-int try_set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
+void bt_stream_destroy(struct bt_object *obj);
static
-int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);
+int try_set_structure_field_integer(struct bt_field *, char *, uint64_t);
static
-int set_integer_field_value(struct bt_ctf_field* field, uint64_t value)
+int set_integer_field_value(struct bt_field* field, uint64_t value)
{
int ret = 0;
- struct bt_ctf_field_type *field_type = NULL;
+ struct bt_field_type *field_type = NULL;
if (!field) {
+ BT_LOGW_STR("Invalid parameter: field is NULL.");
ret = -1;
goto end;
}
- field_type = bt_ctf_field_get_type(field);
- assert(field_type);
+ field_type = bt_field_get_type(field);
+ BT_ASSERT(field_type);
- if (bt_ctf_field_type_get_type_id(field_type) !=
- BT_CTF_FIELD_TYPE_ID_INTEGER) {
+ if (bt_field_type_get_type_id(field_type) !=
+ BT_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_field_type_id_string(field_type->id));
ret = -1;
goto end;
}
- if (bt_ctf_field_type_integer_get_signed(field_type)) {
- ret = bt_ctf_field_signed_integer_set_value(field, (int64_t) value);
+ if (bt_field_type_integer_is_signed(field_type)) {
+ ret = bt_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);
+ ret = bt_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;
}
}
}
static
-int set_packet_header_magic(struct bt_ctf_stream *stream)
+int set_packet_header_magic(struct bt_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(
+ struct bt_field *magic_field = bt_field_structure_get_field_by_name(
stream->packet_header, "magic");
+ const uint32_t magic_value = 0xc1fc1fc1;
+
+ BT_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_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_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_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_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_stream *stream)
+{
+ int ret = 0;
+ int64_t i;
+ struct bt_trace *trace = NULL;
+ struct bt_field *uuid_field = bt_field_structure_get_field_by_name(
+ stream->packet_header, "uuid");
- 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_ASSERT(stream);
+
+ 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_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_trace *) bt_object_get_parent(stream);
+ for (i = 0; i < 16; i++) {
+ struct bt_field *uuid_element =
+ bt_field_array_get_field(uuid_field, i);
+
+ ret = bt_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_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_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_stream *stream)
+{
+ int ret = 0;
+ uint32_t stream_id;
+ struct bt_field *stream_id_field = bt_field_structure_get_field_by_name(
+ 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_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_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_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_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_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_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_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_stream_get_name(stream));
+ goto end;
+ }
+
+ BT_LOGV("Automatically populated stream's packet header's known fields: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ stream, bt_stream_get_name(stream));
+
+end:
+ return ret;
+}
+
+static
+int set_packet_context_packet_size(struct bt_stream *stream)
+{
+ int ret = 0;
+ struct bt_field *field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "packet_size");
+
+ BT_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_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 */
+ ret = bt_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_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_stream_get_name(stream),
+ field, stream->pos.packet_size);
+ }
+
+end:
+ bt_put(field);
+ return ret;
+}
+
+static
+int set_packet_context_content_size(struct bt_stream *stream)
+{
+ int ret = 0;
+ struct bt_field *field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "content_size");
+
+ BT_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_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_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_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_stream_get_name(stream),
+ field, stream->pos.offset);
+ }
+
+end:
+ bt_put(field);
+ return ret;
+}
+
+static
+int set_packet_context_events_discarded(struct bt_stream *stream)
+{
+ int ret = 0;
+ struct bt_field *field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "events_discarded");
- ret = bt_ctf_field_type_integer_get_signed(element_field_type);
- assert(ret >= 0);
+ BT_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_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_field_is_set_recursive(field)) {
+ uint64_t user_val;
+
+ ret = bt_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]);
+ BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: "
+ "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
+ stream, bt_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_stream_get_name(stream), field,
+ user_val, stream->discarded_events);
+ goto end;
+ }
+
+ stream->discarded_events = user_val;
+ } else {
+ ret = bt_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_stream_get_name(stream),
+ field, stream->discarded_events);
} else {
- ret = bt_ctf_field_unsigned_integer_set_value(
- uuid_element,
- (uint64_t) trace->uuid[i]);
+ 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_stream_get_name(stream),
+ field, stream->discarded_events);
}
- bt_put(uuid_element);
+ }
+
+end:
+ bt_put(field);
+ return ret;
+}
+
+static
+void update_clock_value(uint64_t *val, uint64_t new_val,
+ unsigned int new_val_size)
+{
+ const uint64_t pow2 = 1ULL << new_val_size;
+ const uint64_t mask = pow2 - 1;
+ uint64_t val_masked;
+
+#ifdef BT_LOG_ENABLED_VERBOSE
+ uint64_t old_val = *val;
+#endif
+
+ if (new_val_size == 64) {
+ *val = new_val;
+ goto end;
+ }
+
+ val_masked = *val & mask;
+
+ if (new_val < val_masked) {
+ /* Wrapped once */
+ new_val |= pow2;
+ }
+
+ *val &= ~mask;
+ *val |= new_val;
+
+end:
+ BT_LOGV("Updated clock value: old-val=%" PRIu64 ", new-val=%" PRIu64,
+ old_val, *val);
+ return;
+}
+
+static
+int visit_field_update_clock_value(struct bt_field *field, uint64_t *val)
+{
+ int ret = 0;
+
+ if (!field) {
+ goto end;
+ }
+
+ switch (bt_field_get_type_id(field)) {
+ case BT_FIELD_TYPE_ID_INTEGER:
+ {
+ struct bt_clock_class *cc =
+ bt_field_type_integer_get_mapped_clock_class(
+ field->type);
+ int val_size;
+ uint64_t uval;
+
+ if (!cc) {
+ goto end;
+ }
+
+ bt_put(cc);
+ val_size = bt_field_type_integer_get_size(field->type);
+ BT_ASSERT(val_size >= 1);
+
+ if (bt_field_type_integer_is_signed(field->type)) {
+ int64_t ival;
+
+ ret = bt_field_signed_integer_get_value(field, &ival);
+ uval = (uint64_t) ival;
+ } else {
+ ret = bt_field_unsigned_integer_get_value(field, &uval);
+ }
+
if (ret) {
+ /* Not set */
+ goto end;
+ }
+
+ update_clock_value(val, uval, val_size);
+ break;
+ }
+ case BT_FIELD_TYPE_ID_ENUM:
+ {
+ struct bt_field *int_field =
+ bt_field_enumeration_get_container(field);
+
+ BT_ASSERT(int_field);
+ ret = visit_field_update_clock_value(int_field, val);
+ bt_put(int_field);
+ break;
+ }
+ case BT_FIELD_TYPE_ID_ARRAY:
+ {
+ uint64_t i;
+ int64_t len = bt_field_type_array_get_length(field->type);
+
+ BT_ASSERT(len >= 0);
+
+ for (i = 0; i < len; i++) {
+ struct bt_field *elem_field =
+ bt_field_array_get_field(field, i);
+
+ BT_ASSERT(elem_field);
+ ret = visit_field_update_clock_value(elem_field, val);
+ bt_put(elem_field);
+ if (ret) {
+ goto end;
+ }
+ }
+ break;
+ }
+ case BT_FIELD_TYPE_ID_SEQUENCE:
+ {
+ uint64_t i;
+ int64_t len = bt_field_sequence_get_int_length(field);
+
+ if (len < 0) {
+ ret = -1;
goto end;
}
+
+ for (i = 0; i < len; i++) {
+ struct bt_field *elem_field =
+ bt_field_sequence_get_field(field, i);
+
+ BT_ASSERT(elem_field);
+ ret = visit_field_update_clock_value(elem_field, val);
+ bt_put(elem_field);
+ if (ret) {
+ goto end;
+ }
+ }
+ break;
+ }
+ case BT_FIELD_TYPE_ID_STRUCT:
+ {
+ uint64_t i;
+ int64_t len = bt_field_type_structure_get_field_count(
+ field->type);
+
+ BT_ASSERT(len >= 0);
+
+ for (i = 0; i < len; i++) {
+ struct bt_field *member_field =
+ bt_field_structure_get_field_by_index(field, i);
+
+ BT_ASSERT(member_field);
+ ret = visit_field_update_clock_value(member_field, val);
+ bt_put(member_field);
+ if (ret) {
+ goto end;
+ }
+ }
+ break;
+ }
+ case BT_FIELD_TYPE_ID_VARIANT:
+ {
+ struct bt_field *cur_field =
+ bt_field_variant_get_current_field(field);
+
+ if (!cur_field) {
+ ret = -1;
+ goto end;
+ }
+
+ ret = visit_field_update_clock_value(cur_field, val);
+ bt_put(cur_field);
+ break;
+ }
+ default:
+ break;
}
end:
- bt_put(uuid_field);
- bt_put(uuid_field_type);
- bt_put(element_field_type);
- BT_PUT(trace);
return ret;
}
-static
-int set_packet_header_stream_id(struct bt_ctf_stream *stream)
+
+int visit_event_update_clock_value(struct bt_event *event, uint64_t *val)
{
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_field *field;
- if (!stream_id_field) {
- /* No stream_id field found. Not an error, skip. */
+ field = bt_event_get_header(event);
+ ret = visit_field_update_clock_value(field, val);
+ bt_put(field);
+ if (ret) {
+ BT_LOGW_STR("Cannot automatically update clock value in "
+ "event's header.");
goto end;
}
- if (bt_ctf_field_is_set(stream_id_field)) {
- /* Value already set. Not an error, skip. */
+ field = bt_event_get_stream_event_context(event);
+ ret = visit_field_update_clock_value(field, val);
+ bt_put(field);
+ if (ret) {
+ BT_LOGW_STR("Cannot automatically update clock value in "
+ "event's stream event context.");
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. */
+ field = bt_event_get_event_context(event);
+ ret = visit_field_update_clock_value(field, val);
+ bt_put(field);
+ if (ret) {
+ BT_LOGW_STR("Cannot automatically update clock value in "
+ "event's context.");
goto end;
}
- stream_id = stream->stream_class->id;
- ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type);
- assert(ret >= 0);
+ field = bt_event_get_event_payload(event);
+ ret = visit_field_update_clock_value(field, val);
+ bt_put(field);
if (ret) {
- ret = bt_ctf_field_signed_integer_set_value(stream_id_field,
- (int64_t) stream_id);
- } else {
- ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field,
- (uint64_t) stream_id);
+ BT_LOGW_STR("Cannot automatically update clock value in "
+ "event's payload.");
+ goto end;
}
+
end:
- bt_put(stream_id_field);
- bt_put(stream_id_field_type);
return ret;
}
static
-int set_packet_header(struct bt_ctf_stream *stream)
+int set_packet_context_timestamps(struct bt_stream *stream)
{
- int ret;
+ int ret = 0;
+ uint64_t val;
+ uint64_t cur_clock_value;
+ uint64_t init_clock_value = 0;
+ struct bt_field *ts_begin_field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "timestamp_begin");
+ struct bt_field *ts_end_field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "timestamp_end");
+ uint64_t i;
+ int64_t len;
+
+ if (ts_begin_field && bt_field_is_set_recursive(ts_begin_field)) {
+ /* Use provided `timestamp_begin` value as starting value */
+ ret = bt_field_unsigned_integer_get_value(ts_begin_field, &val);
+ BT_ASSERT(ret == 0);
+ init_clock_value = val;
+ } else if (stream->last_ts_end != -1ULL) {
+ /* Use last packet's ending timestamp as starting value */
+ init_clock_value = stream->last_ts_end;
+ }
+
+ cur_clock_value = init_clock_value;
+
+ if (stream->last_ts_end != -1ULL &&
+ cur_clock_value < stream->last_ts_end) {
+ BT_LOGW("Packet's initial timestamp is less than previous "
+ "packet's final timestamp: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "cur-packet-ts-begin=%" PRIu64 ", "
+ "prev-packet-ts-end=%" PRIu64,
+ stream, bt_stream_get_name(stream),
+ cur_clock_value, stream->last_ts_end);
+ ret = -1;
+ goto end;
+ }
- ret = set_packet_header_magic(stream);
+ /*
+ * Visit all the packet context fields, followed by all the
+ * fields of all the events, in order, updating our current
+ * clock value as we visit.
+ *
+ * While visiting the packet context fields, do not consider
+ * `timestamp_begin` and `timestamp_end` because this function's
+ * purpose is to set them anyway. Also do not consider
+ * `packet_size`, `content_size`, `events_discarded`, and
+ * `packet_seq_num` if they are not set because those are
+ * autopopulating fields.
+ */
+ len = bt_field_type_structure_get_field_count(
+ stream->packet_context->type);
+ BT_ASSERT(len >= 0);
+
+ for (i = 0; i < len; i++) {
+ const char *member_name;
+ struct bt_field *member_field;
+
+ ret = bt_field_type_structure_get_field_by_index(
+ stream->packet_context->type, &member_name, NULL, i);
+ BT_ASSERT(ret == 0);
+
+ if (strcmp(member_name, "timestamp_begin") == 0 ||
+ strcmp(member_name, "timestamp_end") == 0) {
+ continue;
+ }
+
+ member_field = bt_field_structure_get_field_by_index(
+ stream->packet_context, i);
+ BT_ASSERT(member_field);
+
+ if (strcmp(member_name, "packet_size") == 0 &&
+ !bt_field_is_set_recursive(member_field)) {
+ bt_put(member_field);
+ continue;
+ }
+
+ if (strcmp(member_name, "content_size") == 0 &&
+ !bt_field_is_set_recursive(member_field)) {
+ bt_put(member_field);
+ continue;
+ }
+
+ if (strcmp(member_name, "events_discarded") == 0 &&
+ !bt_field_is_set_recursive(member_field)) {
+ bt_put(member_field);
+ continue;
+ }
+
+ if (strcmp(member_name, "packet_seq_num") == 0 &&
+ !bt_field_is_set_recursive(member_field)) {
+ bt_put(member_field);
+ continue;
+ }
+
+ ret = visit_field_update_clock_value(member_field,
+ &cur_clock_value);
+ bt_put(member_field);
+ if (ret) {
+ BT_LOGW("Cannot automatically update clock value "
+ "in stream's packet context: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "field-name=\"%s\"",
+ stream, bt_stream_get_name(stream),
+ member_name);
+ goto end;
+ }
+ }
+
+ for (i = 0; i < stream->events->len; i++) {
+ struct bt_event *event = g_ptr_array_index(stream->events, i);
+
+ BT_ASSERT(event);
+ ret = visit_event_update_clock_value(event, &cur_clock_value);
+ if (ret) {
+ BT_LOGW("Cannot automatically update clock value "
+ "in stream's packet context: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "index=%" PRIu64 ", event-addr=%p, "
+ "event-class-id=%" PRId64 ", "
+ "event-class-name=\"%s\"",
+ stream, bt_stream_get_name(stream),
+ i, event,
+ bt_event_class_get_id(event->event_class),
+ bt_event_class_get_name(event->event_class));
+ goto end;
+ }
+ }
+
+ /*
+ * Everything is visited, thus the current clock value
+ * corresponds to the ending timestamp. Validate this value
+ * against the provided value of `timestamp_end`, if any,
+ * otherwise set it.
+ */
+ if (ts_end_field && bt_field_is_set_recursive(ts_end_field)) {
+ ret = bt_field_unsigned_integer_get_value(ts_end_field, &val);
+ BT_ASSERT(ret == 0);
+
+ if (val < cur_clock_value) {
+ BT_LOGW("Packet's final timestamp is less than "
+ "computed packet's final timestamp: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "cur-packet-ts-end=%" PRIu64 ", "
+ "computed-packet-ts-end=%" PRIu64,
+ stream, bt_stream_get_name(stream),
+ val, cur_clock_value);
+ ret = -1;
+ goto end;
+ }
+
+ stream->last_ts_end = val;
+ }
+
+ if (ts_end_field && !bt_field_is_set_recursive(ts_end_field)) {
+ ret = set_integer_field_value(ts_end_field, cur_clock_value);
+ BT_ASSERT(ret == 0);
+ stream->last_ts_end = cur_clock_value;
+ }
+
+ if (!ts_end_field) {
+ stream->last_ts_end = cur_clock_value;
+ }
+
+ /* Set `timestamp_begin` field to initial clock value */
+ if (ts_begin_field && !bt_field_is_set_recursive(ts_begin_field)) {
+ ret = set_integer_field_value(ts_begin_field, init_clock_value);
+ BT_ASSERT(ret == 0);
+ }
+
+end:
+ bt_put(ts_begin_field);
+ bt_put(ts_end_field);
+ return ret;
+}
+
+static
+int auto_populate_packet_context(struct bt_stream *stream, bool set_ts)
+{
+ 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_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_stream_get_name(stream));
goto end;
}
- ret = set_packet_header_stream_id(stream);
+ if (set_ts) {
+ ret = set_packet_context_timestamps(stream);
+ if (ret) {
+ BT_LOGW("Cannot set packet context's timestamp fields: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ stream, bt_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_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_stream_get_name(stream));
+
end:
return ret;
}
static
-void release_event(struct bt_ctf_event *event)
+void release_event(struct bt_event *event)
{
if (bt_object_get_ref_count(event)) {
/*
static
int create_stream_file(struct bt_ctf_writer *writer,
- struct bt_ctf_stream *stream)
+ struct bt_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_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);
+
+ BT_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);
+
+ BT_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_stream_class_get_id(stream->stream_class);
+ BT_ASSERT(stream_class_id >= 0);
+ BT_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_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_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);
+ (void) bt_stream_pos_init(&stream->pos, fd, O_RDWR);
stream->pos.fd = fd;
-end:
- return ret;
}
-struct bt_ctf_stream *bt_ctf_stream_create(
- struct bt_ctf_stream_class *stream_class,
- const char *name)
+static
+struct bt_stream *bt_stream_create_with_id_no_check(
+ struct bt_stream_class *stream_class,
+ const char *name, uint64_t id)
{
int ret;
- struct bt_ctf_stream *stream = NULL;
- struct bt_ctf_trace *trace = NULL;
+ struct bt_stream *stream = NULL;
+ struct bt_trace *trace = NULL;
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_stream_class_get_name(stream_class),
+ name, id);
+ trace = bt_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_stream_class_get_name(stream_class),
+ name);
+ goto error;
+ }
+
+ if (bt_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_stream_class_get_name(stream_class),
+ name, trace);
goto error;
}
- stream = g_new0(struct bt_ctf_stream, 1);
+ 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_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_stream, 1);
if (!stream) {
+ BT_LOGE_STR("Failed to allocate one stream.");
goto error;
}
- bt_object_init(stream, bt_ctf_stream_destroy);
+ bt_object_init(stream, bt_stream_destroy);
/*
* Acquire reference to parent since stream will become publicly
* 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_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);
- assert(writer);
+ writer = (struct bt_ctf_writer *) bt_object_get_parent(trace);
+ stream->id = (int64_t) stream_class->next_stream_id++;
+ stream->last_ts_end = -1ULL;
+
+ BT_LOGD("Stream object belongs to a writer's trace: "
+ "writer-addr=%p", writer);
+ BT_ASSERT(writer);
+
if (stream_class->packet_context_type) {
- stream->packet_context = bt_ctf_field_create(
+ BT_LOGD("Creating stream's packet context field: "
+ "ft-addr=%p", stream_class->packet_context_type);
+ stream->packet_context = bt_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;
}
}
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_field_create(trace->packet_header_type);
+ if (!stream->packet_header) {
+ BT_LOGW_STR("Cannot create stream's packet header field.");
+ goto error;
+ }
}
/*
* 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 */
+ set_stream_fd(stream, -1);
+ }
+
+ /* 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_stream *bt_stream_create_with_id(
+ struct bt_stream_class *stream_class,
+ const char *name, uint64_t id_param)
+{
+ struct bt_trace *trace;
+ struct bt_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;
+ }
- /* Freeze the writer */
- bt_ctf_writer_freeze(writer);
- } else {
- /* Non-writer stream indicated by a negative FD */
- ret = set_stream_fd(stream, -1);
- if (ret) {
- goto error;
- }
+ trace = bt_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_stream_class_get_name(stream_class),
+ name, id_param);
+ goto end;
}
- /* Add this stream to the trace's streams */
- g_ptr_array_add(trace->streams, stream);
+ if (trace->is_created_by_writer) {
+ BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_stream_create(): "
+ "stream-class-addr=%p, stream-class-name=\"%s\", "
+ "stream-name=\"%s\", stream-id=%" PRIu64,
+ stream_class, bt_stream_class_get_name(stream_class),
+ name, id_param);
+ goto end;
+ }
- BT_PUT(trace);
- BT_PUT(writer);
- return stream;
-error:
- BT_PUT(stream);
- BT_PUT(trace);
- BT_PUT(writer);
+ stream = bt_stream_create_with_id_no_check(stream_class,
+ name, id_param);
+
+end:
return stream;
}
-struct bt_ctf_stream_class *bt_ctf_stream_get_class(
- struct bt_ctf_stream *stream)
+struct bt_stream *bt_stream_create(
+ struct bt_stream_class *stream_class,
+ const char *name)
+{
+ return bt_stream_create_with_id_no_check(stream_class,
+ name, -1ULL);
+}
+
+struct bt_stream_class *bt_stream_get_class(
+ struct bt_stream *stream)
{
- struct bt_ctf_stream_class *stream_class = NULL;
+ struct bt_stream_class *stream_class = NULL;
if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
goto end;
}
return stream_class;
}
-int bt_ctf_stream_get_discarded_events_count(
- struct bt_ctf_stream *stream, uint64_t *count)
+int bt_stream_get_discarded_events_count(
+ struct bt_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 || !count || !stream->packet_context ||
- stream->pos.fd < 0) {
+ if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
ret = -1;
goto end;
}
- events_discarded_field = bt_ctf_field_structure_get_field(
- stream->packet_context, "events_discarded");
- if (!events_discarded_field) {
+ if (!count) {
+ BT_LOGW_STR("Invalid parameter: count is NULL.");
ret = -1;
goto end;
}
- events_discarded_field_type = bt_ctf_field_get_type(
- events_discarded_field);
- if (!events_discarded_field_type) {
+ if (stream->pos.fd < 0) {
+ BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ stream, bt_stream_get_name(stream));
ret = -1;
goto end;
}
- field_signed = bt_ctf_field_type_integer_get_signed(
- events_discarded_field_type);
- if (field_signed < 0) {
- ret = field_signed;
+ *count = (uint64_t) stream->discarded_events;
+
+end:
+ return ret;
+}
+
+static
+int set_packet_context_events_discarded_field(struct bt_stream *stream,
+ uint64_t count)
+{
+ int ret = 0;
+ struct bt_field *events_discarded_field = NULL;
+
+ if (!stream->packet_context) {
goto end;
}
- if (field_signed) {
- int64_t signed_count;
+ events_discarded_field = bt_field_structure_get_field_by_name(
+ stream->packet_context, "events_discarded");
+ if (!events_discarded_field) {
+ goto end;
+ }
- 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(
+ ret = bt_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) {
- goto end;
- }
+ goto end;
}
+
end:
bt_put(events_discarded_field);
- bt_put(events_discarded_field_type);
return ret;
}
-void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
+void bt_stream_append_discarded_events(struct bt_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;
+ struct bt_field *events_discarded_field = 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_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(
+ events_discarded_field = bt_field_structure_get_field_by_name(
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_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,
- struct bt_ctf_event *event)
+static int auto_populate_event_header(struct bt_stream *stream,
+ struct bt_event *event)
{
int ret = 0;
- struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL;
- struct bt_ctf_clock_class *mapped_clock_class = NULL;
+ struct bt_field *id_field = NULL, *timestamp_field = NULL;
+ struct bt_clock_class *mapped_clock_class = NULL;
+ int64_t event_class_id;
+
+ BT_ASSERT(event);
- if (!event || event->frozen) {
+ if (!event->event_header) {
+ goto end;
+ }
+
+ 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.
- */
- 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));
+ BT_LOGV("Automatically populating event's header field: "
+ "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
+ stream, bt_stream_get_name(stream), event);
+
+ id_field = bt_field_structure_get_field_by_name(event->event_header, "id");
+ event_class_id = bt_event_class_get_id(event->event_class);
+ BT_ASSERT(event_class_id >= 0);
+
+ if (id_field && bt_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;
}
}
* 1. The event header field "timestamp" exists and is an
* integer field.
* 2. This stream's class has a registered clock (set with
- * bt_ctf_stream_class_set_clock()).
- * 3. The event header field "timestamp" has its type mapped to
- * a clock class which is also the clock class of this
- * stream's class's registered clock.
- * 4. The event header field "timestamp" is NOT set.
+ * bt_stream_class_set_clock()).
+ * 3. The "timestamp" field is not set.
*/
- timestamp_field = bt_ctf_field_structure_get_field(event->event_header,
- "timestamp");
- if (timestamp_field && !bt_ctf_field_is_set(timestamp_field) &&
- stream->stream_class->clock) {
- struct bt_ctf_clock_class *stream_class_clock_class =
- stream->stream_class->clock->clock_class;
- struct bt_ctf_field_type *timestamp_field_type =
- bt_ctf_field_get_type(timestamp_field);
-
- assert(timestamp_field_type);
+ timestamp_field = bt_field_structure_get_field_by_name(
+ event->event_header, "timestamp");
+ if (timestamp_field && stream->stream_class->clock &&
+ bt_field_type_is_integer(timestamp_field->type) &&
+ !bt_field_is_set_recursive(timestamp_field)) {
mapped_clock_class =
- bt_ctf_field_type_integer_get_mapped_clock_class(
- timestamp_field_type);
- BT_PUT(timestamp_field_type);
- if (mapped_clock_class == stream_class_clock_class) {
+ bt_field_type_integer_get_mapped_clock_class(
+ timestamp_field->type);
+ if (mapped_clock_class) {
uint64_t timestamp;
+ BT_ASSERT(mapped_clock_class ==
+ stream->stream_class->clock->clock_class);
ret = bt_ctf_clock_get_value(
stream->stream_class->clock,
×tamp);
- if (ret) {
- goto end;
- }
-
+ BT_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_stream_get_name(stream), event);
+
end:
bt_put(id_field);
bt_put(timestamp_field);
return ret;
}
-int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
- struct bt_ctf_event *event)
+int bt_stream_append_event(struct bt_stream *stream,
+ struct bt_event *event)
{
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_stream_get_name(stream), event,
+ bt_event_class_get_name(bt_event_borrow_event_class(event)),
+ bt_event_class_get_id(bt_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
}
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 */
- ret = bt_ctf_event_validate(event);
+ BT_LOGV_STR("Validating event to append.");
+ ret = bt_event_validate(event);
if (ret) {
goto error;
}
/* Save the new event and freeze it */
- bt_ctf_event_freeze(event);
+ BT_LOGV_STR("Freezing the event to append.");
+ bt_event_freeze(event);
g_ptr_array_add(stream->events, event);
/*
* 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_stream_get_name(stream), event,
+ bt_event_class_get_name(bt_event_borrow_event_class(event)),
+ bt_event_class_get_id(bt_event_borrow_event_class(event)));
end:
return ret;
return ret;
}
-struct bt_ctf_field *bt_ctf_stream_get_packet_context(
- struct bt_ctf_stream *stream)
+struct bt_field *bt_stream_get_packet_context(struct bt_stream *stream)
{
- struct bt_ctf_field *packet_context = NULL;
+ struct bt_field *packet_context = NULL;
+
+ if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
+ goto end;
+ }
- if (!stream || stream->pos.fd < 0) {
+ if (stream->pos.fd < 0) {
+ BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
+ "stream-addr=%p, stream-name=\"%s\"", stream,
+ bt_stream_get_name(stream));
goto end;
}
return packet_context;
}
-int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
- struct bt_ctf_field *field)
+int bt_stream_set_packet_context(struct bt_stream *stream,
+ struct bt_field *field)
{
int ret = 0;
- struct bt_ctf_field_type *field_type;
+ struct bt_field_type *field_type;
+
+ if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
+ ret = -1;
+ goto end;
+ }
- if (!stream || stream->pos.fd < 0) {
+ if (stream->pos.fd < 0) {
+ BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
ret = -1;
goto end;
}
- field_type = bt_ctf_field_get_type(field);
- if (bt_ctf_field_type_compare(field_type,
+ field_type = bt_field_get_type(field);
+ if (bt_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_stream_get_name(stream),
+ field, field_type);
ret = -1;
goto end;
}
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_stream_get_name(stream), field);
end:
return ret;
}
-struct bt_ctf_field *bt_ctf_stream_get_packet_header(
- struct bt_ctf_stream *stream)
+struct bt_field *bt_stream_get_packet_header(struct bt_stream *stream)
{
- struct bt_ctf_field *packet_header = NULL;
+ struct bt_field *packet_header = NULL;
+
+ if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
+ goto end;
+ }
- if (!stream || stream->pos.fd < 0) {
+ if (stream->pos.fd < 0) {
+ BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
+ "stream-addr=%p, stream-name=\"%s\"", stream,
+ bt_stream_get_name(stream));
goto end;
}
return packet_header;
}
-int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
- struct bt_ctf_field *field)
+int bt_stream_set_packet_header(struct bt_stream *stream,
+ struct bt_field *field)
{
int ret = 0;
- struct bt_ctf_trace *trace = NULL;
- struct bt_ctf_field_type *field_type = NULL;
+ struct bt_trace *trace = NULL;
+ struct bt_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;
+ }
+
+ if (stream->pos.fd < 0) {
+ BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
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)) {
+ trace = (struct bt_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_stream_get_name(stream),
+ field, trace->packet_header_type);
+ ret = -1;
+ goto end;
+ }
+
+ goto skip_validation;
+ }
+
+ field_type = bt_field_get_type(field);
+ BT_ASSERT(field_type);
+
+ if (bt_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_stream_get_name(stream),
+ field, field_type);
ret = -1;
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_stream_get_name(stream), field);
end:
BT_PUT(trace);
bt_put(field_type);
}
static
-int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp)
+void reset_structure_field(struct bt_field *structure, const char *name)
+{
+ struct bt_field *member;
+
+ member = bt_field_structure_get_field_by_name(structure, name);
+ if (member) {
+ (void) bt_field_reset_recursive(member);
+ bt_put(member);
+ }
+}
+
+int bt_stream_flush(struct bt_stream *stream)
{
int ret = 0;
- struct bt_ctf_field *timestamp_field = NULL;
- struct bt_ctf_field_type *timestamp_field_type = NULL;
+ size_t i;
+ struct bt_stream_pos packet_context_pos;
+ struct bt_trace *trace;
+ enum bt_byte_order native_byte_order;
+ bool has_packet_size = false;
- timestamp_field = bt_ctf_field_structure_get_field(event_header,
- "timestamp");
- if (!timestamp_field) {
+ if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
ret = -1;
- goto end;
+ goto end_no_stream;
}
- 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) {
+ if (stream->pos.fd < 0) {
+ BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
ret = -1;
goto end;
}
- if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) {
- int64_t val;
+ if (stream->packet_context) {
+ struct bt_field *packet_size_field;
- ret = bt_ctf_field_signed_integer_get_value(timestamp_field,
- &val);
- if (ret) {
+ packet_size_field = bt_field_structure_get_field_by_name(
+ 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;
}
- *timestamp = (uint64_t) val;
- } else {
- ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field,
- timestamp);
- if (ret) {
+
+ 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;
}
}
-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);
-}
+ BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
+ "stream-name=\"%s\", packet-index=%u", stream,
+ bt_stream_get_name(stream), stream->flushed_packet_count);
+ trace = bt_stream_class_borrow_trace(stream->stream_class);
+ BT_ASSERT(trace);
+ native_byte_order = bt_trace_get_native_byte_order(trace);
-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.
- */
+ 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 && stream->flushed_packet_count > 0) {
- /*
- * A stream without a packet context, and thus without
- * content and packet size members, can't have more than
- * one packet.
- */
+ ret = auto_populate_packet_context(stream, true);
+ if (ret) {
+ BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
ret = -1;
goto end;
}
- 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);
-
/* 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);
- if (ret) {
- goto end;
- }
-
- if (stream->packet_context) {
- /* Set the default context attributes if present and unset. */
- if (!empty_packet && !get_event_header_timestamp(
- ((struct bt_ctf_event *) g_ptr_array_index(
- stream->events, 0))->event_header, ×tamp_begin)) {
- ret = try_set_structure_field_integer(
- stream->packet_context,
- "timestamp_begin", timestamp_begin);
- if (ret < 0) {
- goto end;
- }
- auto_set_fields.timestamp_begin = ret == 1;
- }
-
- if (!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 = 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;
-
- ret = try_set_structure_field_integer(stream->packet_context,
- "packet_size", UINT64_MAX);
- if (ret < 0) {
+ BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64,
+ stream->pos.offset);
+ bt_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR);
+ BT_ASSERT(stream->pos.packet_size % 8 == 0);
+
+ if (stream->packet_header) {
+ BT_LOGV_STR("Serializing packet header field.");
+ ret = bt_field_serialize_recursive(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));
- ret = bt_ctf_field_serialize(stream->packet_context,
+ BT_LOGV_STR("Serializing packet context field.");
+ ret = bt_field_serialize_recursive(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(
+ struct bt_event *event = g_ptr_array_index(
stream->events, i);
+ struct bt_event_class *event_class =
+ bt_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_event_class_get_name(event_class),
+ bt_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_field_serialize_recursive(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) {
- ret = bt_ctf_field_serialize(
+ BT_LOGV_STR("Serializing event's stream event context field.");
+ ret = bt_field_serialize_recursive(
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;
}
}
/* Write event content */
- ret = bt_ctf_event_serialize(event, &stream->pos,
+ ret = bt_event_serialize(event, &stream->pos,
native_byte_order);
if (ret) {
+ /* bt_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;
+ }
+
+ BT_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_field *field = bt_field_structure_get_field_by_name(
+ 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, false);
+ if (ret) {
+ BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
+ ret = -1;
+ goto end;
}
- ret = bt_ctf_field_serialize(stream->packet_context,
+ BT_LOGV("Rewriting (serializing) packet context field.");
+ ret = bt_field_serialize_recursive(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) {
/*
* 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;
}
-void bt_ctf_stream_get(struct bt_ctf_stream *stream)
+/* Pre-2.0 CTF writer backward compatibility */
+void bt_ctf_stream_get(struct bt_stream *stream)
{
bt_get(stream);
}
-void bt_ctf_stream_put(struct bt_ctf_stream *stream)
+/* Pre-2.0 CTF writer backward compatibility */
+void bt_ctf_stream_put(struct bt_stream *stream)
{
bt_put(stream);
}
static
-void bt_ctf_stream_destroy(struct bt_object *obj)
+void bt_stream_destroy(struct bt_object *obj)
{
- struct bt_ctf_stream *stream;
+ struct bt_stream *stream;
+ int i;
+
+ stream = container_of(obj, struct bt_stream, base);
+ BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
+ stream, bt_stream_get_name(stream));
- stream = container_of(obj, struct bt_ctf_stream, base);
- (void) bt_ctf_stream_pos_fini(&stream->pos);
+ /* Call destroy listeners in reverse registration order */
+ for (i = stream->destroy_listeners->len - 1; i >= 0; i--) {
+ struct bt_stream_destroy_listener *listener =
+ &g_array_index(stream->destroy_listeners,
+ struct bt_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_stream_pos_fini(&stream->pos);
if (stream->pos.fd >= 0) {
int ret;
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);
}
g_string_free(stream->name, TRUE);
}
+ 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)
+int _set_structure_field_integer(struct bt_field *structure, char *name,
+ 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_field_type *field_type = NULL;
+ struct bt_field *integer;
- if (!structure || !name) {
- ret = -1;
- goto end;
- }
+ BT_ASSERT(structure);
+ BT_ASSERT(name);
+ integer = bt_field_structure_get_field_by_name(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_field_is_set_recursive(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;
}
- field_type = bt_ctf_field_get_type(integer);
- assert(field_type);
- if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_FIELD_TYPE_ID_INTEGER) {
+ field_type = bt_field_get_type(integer);
+ BT_ASSERT(field_type);
+ if (bt_field_type_get_type_id(field_type) != BT_FIELD_TYPE_ID_INTEGER) {
/*
* The user most likely meant for us to populate this field
* 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_field_type_id_string(field_type->id));
ret = -1;
goto end;
}
- if (bt_ctf_field_type_integer_get_signed(field_type)) {
- ret = bt_ctf_field_signed_integer_set_value(integer,
+ if (bt_field_type_integer_is_signed(field_type)) {
+ ret = bt_field_signed_integer_set_value(integer,
(int64_t) value);
} else {
- ret = bt_ctf_field_unsigned_integer_set_value(integer, value);
+ ret = bt_field_unsigned_integer_set_value(integer, value);
}
ret = !ret ? 1 : ret;
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,
* <0 if an error was encoutered
*/
static
-int try_set_structure_field_integer(struct bt_ctf_field *structure, char *name,
+int try_set_structure_field_integer(struct bt_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)
+const char *bt_stream_get_name(struct bt_stream *stream)
{
const char *name = NULL;
if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
goto end;
}
return name;
}
-int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream)
+int bt_stream_is_writer(struct bt_stream *stream)
{
int ret = -1;
if (!stream) {
+ BT_LOGW_STR("Invalid parameter: stream is NULL.");
goto end;
}
end:
return ret;
}
+
+BT_HIDDEN
+void bt_stream_add_destroy_listener(struct bt_stream *stream,
+ bt_stream_destroy_listener_func func, void *data)
+{
+ struct bt_stream_destroy_listener listener;
+
+ BT_ASSERT(stream);
+ BT_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_stream_get_name(stream), func, data);
+}
+
+BT_HIDDEN
+void bt_stream_remove_destroy_listener(struct bt_stream *stream,
+ bt_stream_destroy_listener_func func, void *data)
+{
+ size_t i;
+
+ BT_ASSERT(stream);
+ BT_ASSERT(func);
+
+ for (i = 0; i < stream->destroy_listeners->len; i++) {
+ struct bt_stream_destroy_listener *listener =
+ &g_array_index(stream->destroy_listeners,
+ struct bt_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_stream_get_name(stream),
+ func, data);
+ }
+ }
+}
+
+int64_t bt_stream_get_id(struct bt_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_stream_get_name(stream));
+ }
+
+end:
+ return ret;
+}
projects / babeltrace.git / blobdiff