+ assert(stream);
+ stream_end_notif = bt_notification_stream_end_create(stream);
+ if (!stream_end_notif) {
+ BT_LOGE_STR("Cannot create stream end notification.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, stream_end_notif);
+ BT_LOGV("Added \"push stream end notification\" action: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ stream, bt_ctf_stream_get_name(stream));
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ bt_put(stream_end_notif);
+ return ret;
+}
+
+static
+int add_action_push_notif_packet_begin(
+ struct bt_notification_iterator *iterator,
+ struct bt_ctf_packet *packet)
+{
+ int ret = 0;
+ struct bt_notification *packet_begin_notif = NULL;
+
+ if (!is_subscribed_to_notification_type(iterator,
+ BT_NOTIFICATION_TYPE_PACKET_BEGIN)) {
+ BT_LOGV("Not adding \"push packet beginning notification\" action: "
+ "notification iterator is not subscribed: addr=%p",
+ iterator);
+ goto end;
+ }
+
+ assert(packet);
+ packet_begin_notif = bt_notification_packet_begin_create(packet);
+ if (!packet_begin_notif) {
+ BT_LOGE_STR("Cannot create packet beginning notification.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, packet_begin_notif);
+ BT_LOGV("Added \"push packet beginning notification\" action: "
+ "packet-addr=%p", packet);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ bt_put(packet_begin_notif);
+ return ret;
+}
+
+static
+int add_action_push_notif_packet_end(
+ struct bt_notification_iterator *iterator,
+ struct bt_ctf_packet *packet)
+{
+ int ret = 0;
+ struct bt_notification *packet_end_notif = NULL;
+
+ if (!is_subscribed_to_notification_type(iterator,
+ BT_NOTIFICATION_TYPE_PACKET_END)) {
+ BT_LOGV("Not adding \"push packet end notification\" action: "
+ "notification iterator is not subscribed: addr=%p",
+ iterator);
+ goto end;
+ }
+
+ assert(packet);
+ packet_end_notif = bt_notification_packet_end_create(packet);
+ if (!packet_end_notif) {
+ BT_LOGE_STR("Cannot create packet end notification.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, packet_end_notif);
+ BT_LOGV("Added \"push packet end notification\" action: "
+ "packet-addr=%p", packet);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ bt_put(packet_end_notif);
+ return ret;
+}
+
+static
+void add_action_set_stream_state_is_ended(
+ struct bt_notification_iterator *iterator,
+ struct stream_state *stream_state)
+{
+ struct action action = {
+ .type = ACTION_TYPE_SET_STREAM_STATE_IS_ENDED,
+ .payload.set_stream_state_is_ended = {
+ .stream_state = stream_state,
+ },
+ };
+
+ assert(stream_state);
+ add_action(iterator, &action);
+ BT_LOGV("Added \"set stream state's ended\" action: "
+ "stream-state-addr=%p", stream_state);
+}
+
+static
+void add_action_set_stream_state_cur_packet(
+ struct bt_notification_iterator *iterator,
+ struct stream_state *stream_state,
+ struct bt_ctf_packet *packet)
+{
+ struct action action = {
+ .type = ACTION_TYPE_SET_STREAM_STATE_CUR_PACKET,
+ .payload.set_stream_state_cur_packet = {
+ .stream_state = stream_state,
+ .packet = bt_get(packet),
+ },
+ };
+
+ assert(stream_state);
+ add_action(iterator, &action);
+ BT_LOGV("Added \"set stream state's current packet\" action: "
+ "stream-state-addr=%p, packet-addr=%p",
+ stream_state, packet);
+}
+
+static
+void add_action_update_stream_state_discarded_elements(
+ struct bt_notification_iterator *iterator,
+ enum action_type type,
+ struct stream_state *stream_state,
+ struct bt_ctf_clock_value *cur_begin,
+ uint64_t cur_count)
+{
+ struct action action = {
+ .type = type,
+ .payload.update_stream_state_discarded_elements = {
+ .stream_state = stream_state,
+ .cur_begin = bt_get(cur_begin),
+ .cur_count = cur_count,
+ },
+ };
+
+ assert(stream_state);
+ assert(type == ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS ||
+ type == ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS);
+ add_action(iterator, &action);
+ if (type == ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS) {
+ BT_LOGV("Added \"update stream state's discarded packets\" action: "
+ "stream-state-addr=%p, cur-begin-addr=%p, cur-count=%" PRIu64,
+ stream_state, cur_begin, cur_count);
+ } else if (type == ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS) {
+ BT_LOGV("Added \"update stream state's discarded events\" action: "
+ "stream-state-addr=%p, cur-begin-addr=%p, cur-count=%" PRIu64,
+ stream_state, cur_begin, cur_count);
+ }
+}
+
+static
+int ensure_stream_state_exists(struct bt_notification_iterator *iterator,
+ struct bt_notification *stream_begin_notif,
+ struct bt_ctf_stream *notif_stream,
+ struct stream_state **_stream_state)
+{
+ int ret = 0;
+ struct stream_state *stream_state = NULL;
+
+ if (!notif_stream) {
+ /*
+ * The notification does not reference any stream: no
+ * need to get or create a stream state.
+ */
+ goto end;
+ }
+
+ stream_state = g_hash_table_lookup(iterator->stream_states,
+ notif_stream);
+ if (!stream_state) {
+ /*
+ * This iterator did not bump into this stream yet:
+ * create a stream state and a "stream begin"
+ * notification.
+ */
+ struct action action = {
+ .type = ACTION_TYPE_ADD_STREAM_STATE,
+ .payload.add_stream_state = {
+ .stream = bt_get(notif_stream),
+ .stream_state = NULL,
+ },
+ };
+
+ stream_state = create_stream_state(notif_stream);
+ if (!stream_state) {
+ BT_LOGE_STR("Cannot create stream state.");
+ goto error;
+ }
+
+ action.payload.add_stream_state.stream_state = stream_state;
+ add_action(iterator, &action);
+
+ if (stream_begin_notif) {
+ add_action_push_notif(iterator, stream_begin_notif);
+ } else {
+ ret = add_action_push_notif_stream_begin(iterator,
+ notif_stream);
+ if (ret) {
+ BT_LOGE_STR("Cannot add \"push stream beginning notification\" action.");
+ goto error;
+ }
+ }
+ }
+ goto end;
+
+error:
+ destroy_stream_state(stream_state);
+ stream_state = NULL;
+ ret = -1;
+
+end:
+ *_stream_state = stream_state;
+ return ret;
+}
+
+static
+struct bt_ctf_field *get_struct_field_uint(struct bt_ctf_field *struct_field,
+ const char *field_name)
+{
+ struct bt_ctf_field *field = NULL;
+ struct bt_ctf_field_type *ft = NULL;
+
+ field = bt_ctf_field_structure_get_field_by_name(struct_field,
+ field_name);
+ if (!field) {
+ BT_LOGV_STR("`%s` field does not exist.");
+ goto end;
+ }
+
+ if (!bt_ctf_field_is_integer(field)) {
+ BT_LOGV("Skipping `%s` field because its type is not an integer field type: "
+ "field-addr=%p, ft-addr=%p, ft-id=%s", field_name,
+ field, ft, bt_ctf_field_type_id_string(
+ bt_ctf_field_type_get_type_id(ft)));
+ BT_PUT(field);
+ goto end;
+ }
+
+ ft = bt_ctf_field_get_type(field);
+ assert(ft);
+
+ if (bt_ctf_field_type_integer_is_signed(ft)) {
+ BT_LOGV("Skipping `%s` integer field because its type is signed: "
+ "field-addr=%p, ft-addr=%p", field_name, field, ft);
+ BT_PUT(field);
+ goto end;
+ }
+
+end:
+ bt_put(ft);
+ return field;
+}
+
+static
+uint64_t get_packet_context_events_discarded(struct bt_ctf_packet *packet)
+{
+ struct bt_ctf_field *packet_context = NULL;
+ struct bt_ctf_field *field = NULL;
+ uint64_t retval = -1ULL;
+ int ret;
+
+ packet_context = bt_ctf_packet_get_context(packet);
+ if (!packet_context) {
+ goto end;
+ }
+
+ field = get_struct_field_uint(packet_context, "events_discarded");
+ if (!field) {
+ BT_LOGV("`events_discarded` field does not exist in packet's context field: "
+ "packet-addr=%p, packet-context-field-addr=%p",
+ packet, packet_context);
+ goto end;
+ }
+
+ assert(bt_ctf_field_is_integer(field));
+ ret = bt_ctf_field_unsigned_integer_get_value(field, &retval);
+ if (ret) {
+ BT_LOGV("Cannot get raw value of packet's context field's `events_discarded` integer field: "
+ "packet-addr=%p, field-addr=%p",
+ packet, field);
+ retval = -1ULL;
+ goto end;
+ }
+
+end:
+ bt_put(packet_context);
+ bt_put(field);
+ return retval;
+}
+
+static
+uint64_t get_packet_context_packet_seq_num(struct bt_ctf_packet *packet)
+{
+ struct bt_ctf_field *packet_context = NULL;
+ struct bt_ctf_field *field = NULL;
+ uint64_t retval = -1ULL;
+ int ret;
+
+ packet_context = bt_ctf_packet_get_context(packet);
+ if (!packet_context) {
+ goto end;
+ }
+
+ field = get_struct_field_uint(packet_context, "packet_seq_num");
+ if (!field) {
+ BT_LOGV("`packet_seq_num` field does not exist in packet's context field: "
+ "packet-addr=%p, packet-context-field-addr=%p",
+ packet, packet_context);
+ goto end;
+ }
+
+ assert(bt_ctf_field_is_integer(field));
+ ret = bt_ctf_field_unsigned_integer_get_value(field, &retval);
+ if (ret) {
+ BT_LOGV("Cannot get raw value of packet's context field's `packet_seq_num` integer field: "
+ "packet-addr=%p, field-addr=%p",
+ packet, field);
+ retval = -1ULL;
+ goto end;
+ }
+
+end:
+ bt_put(packet_context);
+ bt_put(field);
+ return retval;
+}
+
+static
+int handle_discarded_packets(struct bt_notification_iterator *iterator,
+ struct bt_ctf_packet *packet,
+ struct bt_ctf_clock_value *ts_begin,
+ struct bt_ctf_clock_value *ts_end,
+ struct stream_state *stream_state)
+{
+ struct bt_notification *notif = NULL;
+ uint64_t diff;
+ uint64_t prev_count, next_count;
+ int ret = 0;
+
+ next_count = get_packet_context_packet_seq_num(packet);
+ if (next_count == -1ULL) {
+ /*
+ * Stream does not have seqnum field, skip discarded
+ * packets feature.
+ */
+ goto end;
+ }
+ prev_count = stream_state->discarded_packets_state.cur_count;
+
+ if (prev_count != -1ULL) {
+ if (next_count < prev_count) {
+ BT_LOGW("Current value of packet's context field's `packet_seq_num` field is lesser than the previous value for the same stream: "
+ "not updating the stream state's current value: "
+ "packet-addr=%p, prev-count=%" PRIu64 ", "
+ "cur-count=%" PRIu64,
+ packet, prev_count, next_count);
+ goto end;
+ }
+ if (next_count == prev_count) {
+ BT_LOGW("Current value of packet's context field's `packet_seq_num` field is equal to the previous value for the same stream: "
+ "not updating the stream state's current value: "
+ "packet-addr=%p, prev-count=%" PRIu64 ", "
+ "cur-count=%" PRIu64,
+ packet, prev_count, next_count);
+ goto end;
+ }
+
+ diff = next_count - prev_count;
+ if (diff > 1) {
+ /*
+ * Add a discarded packets notification. The packets
+ * are considered to be lost between the state's last time
+ * and the current packet's beginning time.
+ * The counter is expected to monotonically increase of
+ * 1 for each packet. Therefore, the number of missing
+ * packets is 'diff - 1'.
+ */
+ notif = bt_notification_discarded_elements_create(
+ BT_NOTIFICATION_TYPE_DISCARDED_PACKETS,
+ stream_state->stream,
+ stream_state->discarded_packets_state.cur_begin,
+ ts_begin, diff - 1);
+ if (!notif) {
+ BT_LOGE_STR("Cannot create discarded packets notification.");
+ ret = -1;
+ goto end;
+ }
+
+ add_action_push_notif(iterator, notif);
+ }
+ }
+
+ add_action_update_stream_state_discarded_elements(iterator,
+ ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS,
+ stream_state, ts_end, next_count);
+
+end:
+ bt_put(notif);
+ return ret;
+}
+
+static
+int handle_discarded_events(struct bt_notification_iterator *iterator,
+ struct bt_ctf_packet *packet,
+ struct bt_ctf_clock_value *ts_begin,
+ struct bt_ctf_clock_value *ts_end,
+ struct stream_state *stream_state)
+{
+ struct bt_notification *notif = NULL;
+ uint64_t diff;
+ uint64_t next_count;
+ int ret = 0;
+
+ next_count = get_packet_context_events_discarded(packet);
+ if (next_count == -1ULL) {
+ next_count = stream_state->discarded_events_state.cur_count;
+ goto update_state;
+ }
+
+ if (next_count < stream_state->discarded_events_state.cur_count) {
+ BT_LOGW("Current value of packet's context field's `events_discarded` field is lesser than the previous value for the same stream: "
+ "not updating the stream state's current value: "
+ "packet-addr=%p, prev-count=%" PRIu64 ", "
+ "cur-count=%" PRIu64,
+ packet, stream_state->discarded_events_state.cur_count,
+ next_count);
+ goto end;
+ }
+
+ diff = next_count - stream_state->discarded_events_state.cur_count;
+ if (diff > 0) {
+ /*
+ * Add a discarded events notification. The events are
+ * considered to be lost betweem the state's last time
+ * and the current packet's end time.
+ */
+ notif = bt_notification_discarded_elements_create(
+ BT_NOTIFICATION_TYPE_DISCARDED_EVENTS,
+ stream_state->stream,
+ stream_state->discarded_events_state.cur_begin,
+ ts_end, diff);
+ if (!notif) {
+ BT_LOGE_STR("Cannot create discarded events notification.");
+ ret = -1;
+ goto end;
+ }
+
+ add_action_push_notif(iterator, notif);
+ }
+
+update_state:
+ add_action_update_stream_state_discarded_elements(iterator,
+ ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS,
+ stream_state, ts_end, next_count);
+
+end:
+ bt_put(notif);
+ return ret;
+}
+
+static
+int get_field_clock_value(struct bt_ctf_field *root_field,
+ const char *field_name,
+ struct bt_ctf_clock_value **user_clock_val)
+{
+ struct bt_ctf_field *field;
+ struct bt_ctf_field_type *ft = NULL;
+ struct bt_ctf_clock_class *clock_class = NULL;
+ struct bt_ctf_clock_value *clock_value = NULL;
+ uint64_t val;
+ int ret = 0;
+
+ field = get_struct_field_uint(root_field, field_name);
+ if (!field) {
+ /* Not an error: skip this */
+ goto end;
+ }
+
+ ft = bt_ctf_field_get_type(field);
+ assert(ft);
+ clock_class = bt_ctf_field_type_integer_get_mapped_clock_class(ft);
+ if (!clock_class) {
+ BT_LOGW("Integer field type has no mapped clock class but it's expected to have one: "
+ "ft-addr=%p", ft);
+ ret = -1;
+ goto end;
+ }
+
+ ret = bt_ctf_field_unsigned_integer_get_value(field, &val);
+ if (ret) {
+ BT_LOGW("Cannot get integer field's raw value: "
+ "field-addr=%p", field);
+ ret = -1;
+ goto end;
+ }
+
+ clock_value = bt_ctf_clock_value_create(clock_class, val);
+ if (!clock_value) {
+ BT_LOGE_STR("Cannot create clock value from clock class.");
+ ret = -1;
+ goto end;
+ }
+
+ /* Move clock value to user */
+ *user_clock_val = clock_value;
+ clock_value = NULL;
+
+end:
+ bt_put(field);
+ bt_put(ft);
+ bt_put(clock_class);
+ bt_put(clock_value);
+ return ret;
+}
+
+static
+int get_ts_begin_ts_end_from_packet(struct bt_ctf_packet *packet,
+ struct bt_ctf_clock_value **user_ts_begin,
+ struct bt_ctf_clock_value **user_ts_end)
+{
+ struct bt_ctf_field *packet_context = NULL;
+ struct bt_ctf_clock_value *ts_begin = NULL;
+ struct bt_ctf_clock_value *ts_end = NULL;
+ int ret = 0;
+
+ packet_context = bt_ctf_packet_get_context(packet);
+ if (!packet_context) {
+ goto end;
+ }
+
+ ret = get_field_clock_value(packet_context, "timestamp_begin",
+ &ts_begin);
+ if (ret) {
+ BT_LOGW("Cannot create clock value for packet context's `timestamp_begin` field: "
+ "packet-addr=%p, packet-context-field-addr=%p",
+ packet, packet_context);
+ goto end;
+ }
+
+ ret = get_field_clock_value(packet_context, "timestamp_end",
+ &ts_end);
+ if (ret) {
+ BT_LOGW("Cannot create clock value for packet context's `timestamp_begin` field: "
+ "packet-addr=%p, packet-context-field-addr=%p",
+ packet, packet_context);
+ goto end;
+ }
+
+ /* Move clock values to user */
+ *user_ts_begin = ts_begin;
+ ts_begin = NULL;
+ *user_ts_end = ts_end;
+ ts_end = NULL;
+
+end:
+ bt_put(packet_context);
+ bt_put(ts_begin);
+ bt_put(ts_end);
+ return ret;
+}
+
+static
+int handle_discarded_elements(struct bt_notification_iterator *iterator,
+ struct bt_ctf_packet *packet, struct stream_state *stream_state)
+{
+ struct bt_ctf_clock_value *ts_begin = NULL;
+ struct bt_ctf_clock_value *ts_end = NULL;
+ int ret;
+
+ ret = get_ts_begin_ts_end_from_packet(packet, &ts_begin, &ts_end);
+ if (ret) {
+ BT_LOGW("Cannot get packet's beginning or end clock values: "
+ "packet-addr=%p, ret=%d", packet, ret);
+ ret = -1;
+ goto end;
+ }
+
+ ret = handle_discarded_packets(iterator, packet, ts_begin, ts_end,
+ stream_state);
+ if (ret) {
+ BT_LOGW("Cannot handle discarded packets for packet: "
+ "packet-addr=%p, ret=%d", packet, ret);
+ ret = -1;
+ goto end;
+ }
+
+ ret = handle_discarded_events(iterator, packet, ts_begin, ts_end,
+ stream_state);
+ if (ret) {
+ BT_LOGW("Cannot handle discarded events for packet: "
+ "packet-addr=%p, ret=%d", packet, ret);
+ ret = -1;
+ goto end;
+ }
+
+end:
+ bt_put(ts_begin);
+ bt_put(ts_end);
+ return ret;
+}
+
+static
+int handle_packet_switch(struct bt_notification_iterator *iterator,
+ struct bt_notification *packet_begin_notif,
+ struct bt_ctf_packet *new_packet,
+ struct stream_state *stream_state)
+{
+ int ret = 0;
+
+ if (stream_state->cur_packet == new_packet) {
+ goto end;
+ }
+
+ BT_LOGV("Handling packet switch: "
+ "cur-packet-addr=%p, new-packet-addr=%p",
+ stream_state->cur_packet, new_packet);
+
+ if (stream_state->cur_packet) {
+ /* End of the current packet */
+ ret = add_action_push_notif_packet_end(iterator,
+ stream_state->cur_packet);
+ if (ret) {
+ BT_LOGE_STR("Cannot add \"push packet end notification\" action.");
+ goto error;
+ }
+ }
+
+ /*
+ * Check the new packet's context fields for discarded packets
+ * and events to emit those automatic notifications.
+ */
+ ret = handle_discarded_elements(iterator, new_packet, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle discarded elements for new packet.");
+ goto error;
+ }
+
+ /* Beginning of the new packet */
+ if (packet_begin_notif) {
+ add_action_push_notif(iterator, packet_begin_notif);
+ } else if (new_packet) {
+ ret = add_action_push_notif_packet_begin(iterator,
+ new_packet);
+ if (ret) {
+ BT_LOGE_STR("Cannot add \"push packet beginning notification\" action.");
+ goto error;
+ }
+ }
+
+ add_action_set_stream_state_cur_packet(iterator, stream_state,
+ new_packet);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_stream_begin(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_STREAM_BEGIN);
+ assert(notif_stream);
+ ret = ensure_stream_state_exists(iterator, notif, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_stream_end(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_STREAM_END);
+ assert(notif_stream);
+ ret = ensure_stream_state_exists(iterator, NULL, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ ret = handle_packet_switch(iterator, NULL, NULL, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle packet switch.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, notif);
+ add_action_set_stream_state_is_ended(iterator, stream_state);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_discarded_elements(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_DISCARDED_EVENTS ||
+ notif->type == BT_NOTIFICATION_TYPE_DISCARDED_PACKETS);
+ assert(notif_stream);
+ ret = ensure_stream_state_exists(iterator, NULL, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, notif);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_packet_begin(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream,
+ struct bt_ctf_packet *notif_packet)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_PACKET_BEGIN);
+ assert(notif_packet);
+ ret = ensure_stream_state_exists(iterator, NULL, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ ret = handle_packet_switch(iterator, notif, notif_packet, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle packet switch.");
+ goto error;
+ }
+
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_packet_end(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream,
+ struct bt_ctf_packet *notif_packet)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_PACKET_END);
+ assert(notif_packet);
+ ret = ensure_stream_state_exists(iterator, NULL, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ ret = handle_packet_switch(iterator, NULL, notif_packet, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle packet switch.");
+ goto error;
+ }
+
+ /* End of the current packet */
+ add_action_push_notif(iterator, notif);
+ add_action_set_stream_state_cur_packet(iterator, stream_state, NULL);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_notif_event(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif,
+ struct bt_ctf_stream *notif_stream,
+ struct bt_ctf_packet *notif_packet)
+{
+ int ret = 0;
+ struct stream_state *stream_state;
+
+ assert(notif->type == BT_NOTIFICATION_TYPE_EVENT);
+ assert(notif_packet);
+ ret = ensure_stream_state_exists(iterator, NULL, notif_stream,
+ &stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
+ goto error;
+ }
+
+ ret = handle_packet_switch(iterator, NULL, notif_packet, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle packet switch.");
+ goto error;
+ }
+
+ add_action_push_notif(iterator, notif);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int enqueue_notification_and_automatic(
+ struct bt_notification_iterator *iterator,
+ struct bt_notification *notif)
+{
+ int ret = 0;
+ struct bt_ctf_event *notif_event = NULL;
+ struct bt_ctf_stream *notif_stream = NULL;
+ struct bt_ctf_packet *notif_packet = NULL;
+
+ assert(notif);
+
+ BT_LOGV("Enqueuing user notification and automatic notifications: "
+ "iter-addr=%p, notif-addr=%p", iterator, notif);
+
+ // TODO: Skip most of this if the iterator is only subscribed
+ // to event/inactivity notifications.
+
+ /* Get the stream and packet referred by the notification */
+ switch (notif->type) {
+ case BT_NOTIFICATION_TYPE_EVENT:
+ notif_event = bt_notification_event_borrow_event(notif);
+ assert(notif_event);
+ notif_packet = bt_ctf_event_borrow_packet(notif_event);
+ assert(notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
+ notif_stream =
+ bt_notification_stream_begin_borrow_stream(notif);
+ assert(notif_stream);
+ break;
+ case BT_NOTIFICATION_TYPE_STREAM_END:
+ notif_stream = bt_notification_stream_end_borrow_stream(notif);
+ assert(notif_stream);
+ break;
+ case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
+ notif_packet =
+ bt_notification_packet_begin_borrow_packet(notif);
+ assert(notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_PACKET_END:
+ notif_packet = bt_notification_packet_end_borrow_packet(notif);
+ assert(notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_INACTIVITY:
+ /* Always valid */
+ goto handle_notif;
+ default:
+ /*
+ * Invalid type of notification. Only the notification
+ * types above are allowed to be returned by a user
+ * component.
+ */
+ BT_LOGF("Unexpected notification type at this point: "
+ "notif-addr=%p, notif-type=%s", notif,
+ bt_notification_type_string(notif->type));
+ abort();
+ }
+
+ if (notif_packet) {
+ notif_stream = bt_ctf_packet_borrow_stream(notif_packet);
+ assert(notif_stream);
+ }
+
+ if (!notif_stream) {
+ /*
+ * The notification has no reference to a stream: it
+ * cannot cause the creation of automatic notifications.
+ */
+ BT_LOGV_STR("Notification has no reference to any stream: skipping automatic notification generation.");
+ goto end;
+ }
+
+ if (!validate_notification(iterator, notif, notif_stream,
+ notif_packet)) {
+ BT_LOGW_STR("Invalid notification.");
+ goto error;
+ }
+
+handle_notif:
+ switch (notif->type) {
+ case BT_NOTIFICATION_TYPE_EVENT:
+ ret = handle_notif_event(iterator, notif, notif_stream,
+ notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
+ ret = handle_notif_stream_begin(iterator, notif, notif_stream);
+ break;
+ case BT_NOTIFICATION_TYPE_STREAM_END:
+ ret = handle_notif_stream_end(iterator, notif, notif_stream);
+ break;
+ case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
+ ret = handle_notif_packet_begin(iterator, notif, notif_stream,
+ notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_PACKET_END:
+ ret = handle_notif_packet_end(iterator, notif, notif_stream,
+ notif_packet);
+ break;
+ case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
+ case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
+ ret = handle_notif_discarded_elements(iterator, notif,
+ notif_stream);
+ break;
+ case BT_NOTIFICATION_TYPE_INACTIVITY:
+ add_action_push_notif(iterator, notif);
+ break;
+ default:
+ break;
+ }
+
+ if (ret) {
+ BT_LOGW_STR("Failed to handle notification for automatic notification generation.");
+ goto error;
+ }
+
+ apply_actions(iterator);
+ BT_LOGV("Enqueued user notification and automatic notifications: "
+ "iter-addr=%p, notif-addr=%p", iterator, notif);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+int handle_end(struct bt_notification_iterator *iterator)
+{
+ GHashTableIter stream_state_iter;
+ gpointer stream_gptr, stream_state_gptr;
+ int ret = 0;
+
+ BT_LOGV("Handling end of iteration: addr=%p", iterator);
+
+ /*
+ * Emit a "stream end" notification for each non-ended stream
+ * known by this iterator and mark them as ended.
+ */
+ g_hash_table_iter_init(&stream_state_iter, iterator->stream_states);
+
+ while (g_hash_table_iter_next(&stream_state_iter, &stream_gptr,
+ &stream_state_gptr)) {
+ struct stream_state *stream_state = stream_state_gptr;
+
+ assert(stream_state_gptr);
+
+ if (stream_state->is_ended) {
+ continue;
+ }
+
+ ret = handle_packet_switch(iterator, NULL, NULL, stream_state);
+ if (ret) {
+ BT_LOGE_STR("Cannot handle packet switch.");
+ goto error;
+ }
+
+ ret = add_action_push_notif_stream_end(iterator, stream_gptr);
+ if (ret) {
+ BT_LOGE_STR("Cannot add \"push stream end notification\" action.");
+ goto error;
+ }
+
+ add_action_set_stream_state_is_ended(iterator, stream_state);
+ }
+
+ apply_actions(iterator);
+ BT_LOGV("Handled end of iteration: addr=%p", iterator);
+ goto end;
+
+error:
+ ret = -1;
+
+end:
+ return ret;
+}
+
+static
+enum bt_notification_iterator_status ensure_queue_has_notifications(
+ struct bt_notification_iterator *iterator)
+{
+ struct bt_private_notification_iterator *priv_iterator =
+ bt_private_notification_iterator_from_notification_iterator(iterator);
+ bt_component_class_notification_iterator_next_method next_method = NULL;
+ struct bt_notification_iterator_next_return next_return = {
+ .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
+ .notification = NULL,
+ };
+ enum bt_notification_iterator_status status =
+ BT_NOTIFICATION_ITERATOR_STATUS_OK;
+ int ret;
+
+ assert(iterator);
+ BT_LOGD("Ensuring that notification iterator's queue has at least one notification: "
+ "iter-addr=%p, queue-size=%u, iter-state=%s",
+ iterator, iterator->queue->length,
+ bt_notification_iterator_state_string(iterator->state));
+
+ if (iterator->queue->length > 0) {
+ /*
+ * We already have enough. Even if this notification
+ * iterator is finalized, its user can still flush its
+ * current queue's content by calling its "next" method
+ * since this content is local and has no impact on what
+ * used to be the iterator's upstream component.
+ */
+ BT_LOGD_STR("Queue already has at least one notification.");
+ goto end;
+ }
+
+ switch (iterator->state) {
+ case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
+ case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED:
+ BT_LOGD_STR("Notification iterator's \"next\" called, but it is finalized.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_CANCELED;
+ goto end;
+ case BT_NOTIFICATION_ITERATOR_STATE_ENDED:
+ BT_LOGD_STR("Notification iterator is ended.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_END;
+ goto end;
+ default:
+ break;
+ }
+
+ assert(iterator->upstream_component);
+ assert(iterator->upstream_component->class);
+
+ /* Pick the appropriate "next" method */
+ switch (iterator->upstream_component->class->type) {
+ case BT_COMPONENT_CLASS_TYPE_SOURCE:
+ {
+ struct bt_component_class_source *source_class =
+ container_of(iterator->upstream_component->class,
+ struct bt_component_class_source, parent);
+
+ assert(source_class->methods.iterator.next);
+ next_method = source_class->methods.iterator.next;
+ break;
+ }
+ case BT_COMPONENT_CLASS_TYPE_FILTER:
+ {
+ struct bt_component_class_filter *filter_class =
+ container_of(iterator->upstream_component->class,
+ struct bt_component_class_filter, parent);
+
+ assert(filter_class->methods.iterator.next);
+ next_method = filter_class->methods.iterator.next;
+ break;
+ }
+ default:
+ abort();
+ }
+
+ /*
+ * Call the user's "next" method to get the next notification
+ * and status.
+ */
+ assert(next_method);
+
+ while (iterator->queue->length == 0) {
+ BT_LOGD_STR("Calling user's \"next\" method.");
+ next_return = next_method(priv_iterator);
+ BT_LOGD("User method returned: status=%s",
+ bt_notification_iterator_status_string(next_return.status));
+ if (next_return.status < 0) {
+ BT_LOGW_STR("User method failed.");
+ status = next_return.status;
+ goto end;
+ }
+
+ if (iterator->state == BT_NOTIFICATION_ITERATOR_STATE_FINALIZED ||
+ iterator->state == BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED) {
+ /*
+ * The user's "next" method, somehow, cancelled
+ * its own notification iterator. This can
+ * happen, for example, when the user's method
+ * removes the port on which there's the
+ * connection from which the iterator was
+ * created. In this case, said connection is
+ * ended, and all its notification iterators are
+ * finalized.
+ *
+ * Only bt_put() the returned notification if
+ * the status is
+ * BT_NOTIFICATION_ITERATOR_STATUS_OK because
+ * otherwise this field could be garbage.
+ */
+ if (next_return.status ==
+ BT_NOTIFICATION_ITERATOR_STATUS_OK) {
+ bt_put(next_return.notification);
+ }
+
+ status = BT_NOTIFICATION_ITERATOR_STATUS_CANCELED;
+ goto end;
+ }
+
+ switch (next_return.status) {
+ case BT_NOTIFICATION_ITERATOR_STATUS_END:
+ ret = handle_end(iterator);
+ if (ret) {
+ BT_LOGW_STR("Cannot handle end of iteration.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
+ goto end;
+ }
+
+ assert(iterator->state ==
+ BT_NOTIFICATION_ITERATOR_STATE_ACTIVE);
+ iterator->state = BT_NOTIFICATION_ITERATOR_STATE_ENDED;
+
+ if (iterator->queue->length == 0) {
+ status = BT_NOTIFICATION_ITERATOR_STATUS_END;
+ }
+
+ BT_LOGD("Set new status: status=%s",
+ bt_notification_iterator_status_string(status));
+ goto end;
+ case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
+ status = BT_NOTIFICATION_ITERATOR_STATUS_AGAIN;
+ goto end;
+ case BT_NOTIFICATION_ITERATOR_STATUS_OK:
+ if (!next_return.notification) {
+ BT_LOGW_STR("User method returned BT_NOTIFICATION_ITERATOR_STATUS_OK, but notification is NULL.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
+ goto end;
+ }
+
+ /*
+ * Ignore some notifications which are always
+ * automatically generated by the notification
+ * iterator to make sure they have valid values.
+ */
+ switch (next_return.notification->type) {
+ case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
+ case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
+ BT_LOGV("Ignoring discarded elements notification returned by notification iterator's \"next\" method: "
+ "notif-type=%s",
+ bt_notification_type_string(next_return.notification->type));
+ BT_PUT(next_return.notification);
+ continue;
+ default:
+ break;
+ }
+
+ /*
+ * We know the notification is valid. Before we
+ * push it to the head of the queue, push the
+ * appropriate automatic notifications if any.
+ */
+ ret = enqueue_notification_and_automatic(iterator,
+ next_return.notification);
+ BT_PUT(next_return.notification);
+ if (ret) {
+ BT_LOGW("Cannot enqueue notification and automatic notifications.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
+ goto end;
+ }
+ break;
+ default:
+ /* Unknown non-error status */
+ abort();
+ }
+ }
+
+end:
+ return status;
+}
+
+enum bt_notification_iterator_status
+bt_notification_iterator_next(struct bt_notification_iterator *iterator)
+{
+ enum bt_notification_iterator_status status;
+
+ if (!iterator) {
+ BT_LOGW_STR("Invalid parameter: notification iterator is NULL.");
+ status = BT_NOTIFICATION_ITERATOR_STATUS_INVALID;
+ goto end;
+ }
+
+ BT_LOGD("Notification iterator's \"next\": iter-addr=%p", iterator);
+
+ /*
+ * Make sure that the iterator's queue contains at least one
+ * notification.
+ */
+ status = ensure_queue_has_notifications(iterator);
+ if (status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
+ /* Not an error */
+ goto end;
+ }
+
+ /*
+ * Move the notification at the tail of the queue to the
+ * iterator's current notification.
+ */
+ assert(iterator->queue->length > 0);
+ bt_put(iterator->current_notification);
+ iterator->current_notification = g_queue_pop_tail(iterator->queue);
+ assert(iterator->current_notification);
+