- /*
- * Orphan the event; we were not successful in associating it to
- * a stream.
- */
- bt_object_set_parent(event, NULL);
-
- return ret;
-}
-
-struct bt_ctf_field *bt_ctf_stream_get_packet_context(
- struct bt_ctf_stream *stream)
-{
- struct bt_ctf_field *packet_context = NULL;
-
- 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;
- }
-
- packet_context = stream->packet_context;
- if (packet_context) {
- bt_get(packet_context);
- }
-end:
- return packet_context;
-}
-
-int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
- struct bt_ctf_field *field)
-{
- int ret = 0;
- struct bt_ctf_field_type *field_type;
-
- 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;
- }
-
- 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;
- }
-
- 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;
-}
-
-struct bt_ctf_field *bt_ctf_stream_get_packet_header(
- struct bt_ctf_stream *stream)
-{
- struct bt_ctf_field *packet_header = NULL;
-
- 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;
- }
-
- packet_header = stream->packet_header;
- if (packet_header) {
- bt_get(packet_header);
- }
-end:
- return packet_header;
-}
-
-int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
- struct bt_ctf_field *field)
-{
- int ret = 0;
- struct bt_ctf_trace *trace = NULL;
- struct bt_ctf_field_type *field_type = NULL;
-
- 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)) {
- 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;
- }
-
- 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(trace);
- bt_put(field_type);
- return ret;
-}
-
-static
-int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp)
-{
- int ret = 0;
- struct bt_ctf_field *timestamp_field = NULL;
- struct bt_ctf_field_type *timestamp_field_type = NULL;
-
- timestamp_field = bt_ctf_field_structure_get_field(event_header,
- "timestamp");
- if (!timestamp_field) {
- BT_LOGV("Cannot get event header's `timestamp` field: "
- "field-addr=%p", timestamp_field);
- ret = -1;
- goto end;
- }
-
- timestamp_field_type = bt_ctf_field_get_type(timestamp_field);
- assert(timestamp_field_type);
- if (bt_ctf_field_type_get_type_id(timestamp_field_type) !=
- BT_CTF_FIELD_TYPE_ID_INTEGER) {
- BT_LOGW("Invalid event header: `timestamp` field's type is not an integer field type: "
- "event-header-field-addr=%p, "
- "timestamp-field-addr=%p, timestamp-ft-addr=%p, "
- "timestamp-ft-id=%s",
- event_header, timestamp_field, timestamp_field_type,
- bt_ctf_field_type_id_string(timestamp_field_type->id));
- ret = -1;
- goto end;
- }
-
- if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) {
- int64_t val;
-
- ret = bt_ctf_field_signed_integer_get_value(timestamp_field,
- &val);
- if (ret) {
- BT_LOGW("Cannot get signed integer field's value: "
- "event-header-field-addr=%p, "
- "timestamp-field-addr=%p",
- event_header, timestamp_field);
- goto end;
- }
- *timestamp = (uint64_t) val;
- } else {
- ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field,
- timestamp);
- if (ret) {
- BT_LOGW("Cannot get unsigned integer field's value: "
- "event-header-field-addr=%p, "
- "timestamp-field-addr=%p",
- event_header, timestamp_field);
- goto end;
- }
- }
-end:
- bt_put(timestamp_field);
- bt_put(timestamp_field_type);
- return ret;
-}
-
-static
-void reset_structure_field(struct bt_ctf_field *structure, const char *name)
-{
- struct bt_ctf_field *member;
-
- member = bt_ctf_field_structure_get_field(structure, name);
- assert(member);
- (void) bt_ctf_field_reset(member);
- bt_put(member);
-}
-
-int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
-{
- int ret = 0;
- size_t i;
- uint64_t timestamp_begin, timestamp_end;
- struct bt_ctf_field *integer = NULL;
- struct bt_ctf_stream_pos packet_context_pos;
- struct bt_ctf_trace *trace;
- enum bt_ctf_byte_order native_byte_order;
- bt_bool empty_packet;
- uint64_t packet_size_bits;
- struct {
- bt_bool timestamp_begin;
- bt_bool timestamp_end;
- bt_bool content_size;
- bt_bool packet_size;
- } auto_set_fields = { 0 };
-
- 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;
- }
-
- if (!stream->packet_context && stream->flushed_packet_count > 0) {
- /*
- * A stream without a packet context, and thus without
- * content and packet size members, can't have more than
- * one packet.
- */
- BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
- ret = -1;
- goto end;
- }
-
- 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_native_byte_order(trace);
- empty_packet = (stream->events->len == 0);
-
- /* mmap the next packet */
- BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64,
- stream->pos.offset);
- bt_ctf_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR);
- BT_LOGV_STR("Serializing packet header field.");
- ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos,
- native_byte_order);
- if (ret) {
- BT_LOGE("Cannot serialize stream's packet header field: "
- "field-addr=%p", stream->packet_header);
- goto end;
- }
-
- if (stream->packet_context) {
- /* Set the default context attributes if present and unset. */
- if (!empty_packet && !get_event_header_timestamp(
- ((struct bt_ctf_event *) g_ptr_array_index(
- stream->events, 0))->event_header, ×tamp_begin)) {
- ret = try_set_structure_field_integer(
- stream->packet_context,
- "timestamp_begin", timestamp_begin);
- if (ret < 0) {
- BT_LOGW("Cannot set `timestamp_begin` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- auto_set_fields.timestamp_begin = ret == 1;
- }
-
- 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) {
- BT_LOGW("Cannot set `timestamp_end` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- auto_set_fields.timestamp_end = ret == 1;
- }
- ret = try_set_structure_field_integer(stream->packet_context,
- "content_size", UINT64_MAX);
- if (ret < 0) {
- BT_LOGW("Cannot set `content_size` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- auto_set_fields.content_size = ret == 1;
-
- ret = try_set_structure_field_integer(stream->packet_context,
- "packet_size", UINT64_MAX);
- if (ret < 0) {
- BT_LOGW("Cannot set `packet_size` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- auto_set_fields.packet_size = ret == 1;
-
- /* 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_LOGE("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=%u, 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 */
- BT_LOGV_STR("Serializing event's header field.");
- ret = bt_ctf_field_serialize(event->event_header,
- &stream->pos, native_byte_order);
- if (ret) {
- BT_LOGE("Cannot serialize event's header field: "
- "field-addr=%p", event->event_header);
- goto end;
- }
-
- /* 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_LOGE("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,
- 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 (stream->packet_context) {
- /*
- * Update the packet total size and content size and overwrite
- * the packet context.
- * Copy base_mma as the packet may have been remapped (e.g. when
- * a packet is resized).
- */
- packet_context_pos.base_mma = stream->pos.base_mma;
- if (auto_set_fields.content_size) {
- ret = set_structure_field_integer(
- stream->packet_context,
- "content_size", stream->pos.offset);
- if (ret < 0) {
- BT_LOGW("Cannot set `content_size` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- }
-
- if (auto_set_fields.packet_size) {
- ret = set_structure_field_integer(stream->packet_context,
- "packet_size", packet_size_bits);
- if (ret < 0) {
- BT_LOGW("Cannot set `packet_size` field in packet context: "
- "ret=%d, packet-context-field-addr=%p",
- ret, stream->packet_context);
- goto end;
- }
- }
-
- BT_LOGV("Rewriting (serializing) packet context field.");
- ret = bt_ctf_field_serialize(stream->packet_context,
- &packet_context_pos, native_byte_order);
- if (ret) {
- BT_LOGE("Cannot serialize stream's packet context field: "
- "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;
-end:
- /* Reset automatically-set fields. */
- if (auto_set_fields.timestamp_begin) {
- reset_structure_field(stream->packet_context,
- "timestamp_begin");
- }
- if (auto_set_fields.timestamp_end) {
- reset_structure_field(stream->packet_context,
- "timestamp_end");
- }
- if (auto_set_fields.packet_size) {
- reset_structure_field(stream->packet_context,
- "packet_size");
- }
- if (auto_set_fields.content_size) {
- reset_structure_field(stream->packet_context,
- "content_size");
- }
- bt_put(integer);
-
- if (ret < 0) {
- /*
- * We failed to write the packet. Its size is therefore set to 0
- * to ensure the next mapping is done in the same place rather
- * than advancing by "stream->pos.packet_size", which would
- * leave a corrupted packet in the trace.
- */
- stream->pos.packet_size = 0;
- } else {
- BT_LOGV("Flushed stream's current packet: packet-size=%" PRIu64,
- packet_size_bits);
- }
- 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);
-}
-
-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;
-
- /*
- * Truncate the file's size to the minimum required to fit the
- * last packet as we might have grown it too much on the last
- * mmap.
- */
- do {
- ret = ftruncate(stream->pos.fd, stream->size);
- } while (ret == -1 && errno == EINTR);
- if (ret) {
- BT_LOGE("Failed to truncate stream file: %s: "
- "ret=%d, errno=%d, size=%" PRIu64,
- strerror(errno), ret, errno,
- (uint64_t) stream->size);
- }
-
- if (close(stream->pos.fd)) {
- BT_LOGE("Failed to close stream file: %s: "
- "ret=%d, errno=%d", strerror(errno),
- ret, errno);
- }
- }
-
- if (stream->events) {
- BT_LOGD_STR("Putting events.");
- g_ptr_array_free(stream->events, TRUE);
- }
-
- if (stream->name) {
- 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, bt_bool force)
-{
- int ret = 0;
- struct bt_ctf_field_type *field_type = NULL;
- struct bt_ctf_field *integer;
-
- 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)) {
- /* 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) {
- /*
- * 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_ctf_field_type_id_string(field_type->id));
- ret = -1;
- goto end;
- }