- 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);
-
-end:
- return status;
-}
-
-struct bt_component *bt_notification_iterator_get_component(
- struct bt_notification_iterator *iterator)
-{
- return bt_get(iterator->upstream_component);
-}
-
-struct bt_private_component *
-bt_private_notification_iterator_get_private_component(
- struct bt_private_notification_iterator *private_iterator)
-{
- return bt_private_component_from_component(
- bt_notification_iterator_get_component(
- bt_notification_iterator_from_private(private_iterator)));
-}
-
-enum bt_notification_iterator_status bt_notification_iterator_seek_time(
- struct bt_notification_iterator *iterator,
- enum bt_notification_iterator_seek_origin seek_origin,
- int64_t time)
-{
- enum bt_notification_iterator_status ret =
- BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
- return ret;