* SOFTWARE.
*/
+#define BT_LOG_TAG "NOTIF-ITER"
+#include <babeltrace/lib-logging-internal.h>
+
#include <babeltrace/compiler-internal.h>
#include <babeltrace/ref.h>
+#include <babeltrace/ctf-ir/fields.h>
+#include <babeltrace/ctf-ir/field-types.h>
+#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/ctf-ir/event-internal.h>
#include <babeltrace/ctf-ir/packet-internal.h>
#include <babeltrace/ctf-ir/stream-internal.h>
+#include <babeltrace/graph/connection.h>
+#include <babeltrace/graph/connection-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/component-source-internal.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/graph/notification-packet-internal.h>
#include <babeltrace/graph/notification-stream.h>
#include <babeltrace/graph/notification-stream-internal.h>
+#include <babeltrace/graph/notification-discarded-elements-internal.h>
#include <babeltrace/graph/port.h>
#include <babeltrace/types.h>
#include <stdint.h>
+#include <inttypes.h>
+#include <stdlib.h>
+
+struct discarded_elements_state {
+ struct bt_ctf_clock_value *cur_begin;
+ uint64_t cur_count;
+};
struct stream_state {
struct bt_ctf_stream *stream; /* owned by this */
struct bt_ctf_packet *cur_packet; /* owned by this */
+ struct discarded_elements_state discarded_packets_state;
+ struct discarded_elements_state discarded_events_state;
bt_bool is_ended;
};
ACTION_TYPE_ADD_STREAM_STATE,
ACTION_TYPE_SET_STREAM_STATE_IS_ENDED,
ACTION_TYPE_SET_STREAM_STATE_CUR_PACKET,
+ ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS,
+ ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS,
};
struct action {
struct stream_state *stream_state; /* weak */
struct bt_ctf_packet *packet; /* owned by this */
} set_stream_state_cur_packet;
+
+ /* ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS */
+ /* ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS */
+ struct {
+ struct stream_state *stream_state; /* weak */
+ struct bt_ctf_clock_value *cur_begin; /* owned by this */
+ uint64_t cur_count;
+ } update_stream_state_discarded_elements;
} payload;
};
return;
}
+ BT_LOGV("Destroying stream state: stream-state-addr=%p", stream_state);
+ BT_LOGV_STR("Putting stream state's current packet.");
bt_put(stream_state->cur_packet);
+ BT_LOGV_STR("Putting stream state's stream.");
bt_put(stream_state->stream);
+ bt_put(stream_state->discarded_packets_state.cur_begin);
+ bt_put(stream_state->discarded_events_state.cur_begin);
g_free(stream_state);
}
break;
case ACTION_TYPE_SET_STREAM_STATE_IS_ENDED:
break;
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS:
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS:
+ BT_PUT(action->payload.update_stream_state_discarded_elements.cur_begin);
+ break;
default:
- assert(BT_FALSE);
+ BT_LOGF("Unexpected action's type: type=%d", action->type);
+ abort();
}
}
g_array_set_size(iterator->actions, 0);
}
+static inline
+const char *action_type_string(enum action_type type)
+{
+ switch (type) {
+ case ACTION_TYPE_PUSH_NOTIF:
+ return "ACTION_TYPE_PUSH_NOTIF";
+ case ACTION_TYPE_MAP_PORT_TO_COMP_IN_STREAM:
+ return "ACTION_TYPE_MAP_PORT_TO_COMP_IN_STREAM";
+ case ACTION_TYPE_ADD_STREAM_STATE:
+ return "ACTION_TYPE_ADD_STREAM_STATE";
+ case ACTION_TYPE_SET_STREAM_STATE_IS_ENDED:
+ return "ACTION_TYPE_SET_STREAM_STATE_IS_ENDED";
+ case ACTION_TYPE_SET_STREAM_STATE_CUR_PACKET:
+ return "ACTION_TYPE_SET_STREAM_STATE_CUR_PACKET";
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS:
+ return "ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS";
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS:
+ return "ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS";
+ default:
+ return "(unknown)";
+ }
+}
+
static
void apply_actions(struct bt_notification_iterator *iterator)
{
size_t i;
+ BT_LOGV("Applying notification's iterator current actions: "
+ "count=%u", iterator->actions->len);
+
for (i = 0; i < iterator->actions->len; i++) {
struct action *action = &g_array_index(iterator->actions,
struct action, i);
+ BT_LOGV("Applying action: index=%zu, type=%s",
+ i, action_type_string(action->type));
+
switch (action->type) {
case ACTION_TYPE_PUSH_NOTIF:
/* Move notification to queue */
BT_MOVE(action->payload.set_stream_state_cur_packet.stream_state->cur_packet,
action->payload.set_stream_state_cur_packet.packet);
break;
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS:
+ case ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_EVENTS:
+ {
+ struct discarded_elements_state *state;
+
+ if (action->type == ACTION_TYPE_UPDATE_STREAM_STATE_DISCARDED_PACKETS) {
+ state = &action->payload.update_stream_state_discarded_elements.stream_state->discarded_packets_state;
+ } else {
+ state = &action->payload.update_stream_state_discarded_elements.stream_state->discarded_events_state;
+ }
+
+ BT_MOVE(state->cur_begin,
+ action->payload.update_stream_state_discarded_elements.cur_begin);
+ state->cur_count = action->payload.update_stream_state_discarded_elements.cur_count;
+ break;
+ }
default:
- assert(BT_FALSE);
+ BT_LOGF("Unexpected action's type: type=%d",
+ action->type);
+ abort();
}
}
struct stream_state *stream_state = g_new0(struct stream_state, 1);
if (!stream_state) {
+ BT_LOGE_STR("Failed to allocate one stream state.");
goto end;
}
+ /*
+ * The packet index is a monotonic counter which may not start
+ * at 0 at the beginning of the stream. We therefore need to
+ * have an internal object initial state of -1ULL to distinguish
+ * between initial state and having seen a packet with
+ * seqnum = 0.
+ */
+ stream_state->discarded_packets_state.cur_count = -1ULL;
+
/*
* We keep a reference to the stream until we know it's ended
* because we need to be able to create an automatic "stream
* We put this reference when the stream is marked as ended.
*/
stream_state->stream = bt_get(stream);
+ BT_LOGV("Created stream state: stream-addr=%p, stream-name=\"%s\", "
+ "stream-state-addr=%p",
+ stream, bt_ctf_stream_get_name(stream), stream_state);
end:
return stream_state;
void bt_notification_iterator_destroy(struct bt_object *obj)
{
struct bt_notification_iterator *iterator;
- struct bt_component_class *comp_class;
assert(obj);
- iterator = container_of(obj, struct bt_notification_iterator,
- base);
- assert(iterator->upstream_component);
- comp_class = iterator->upstream_component->class;
-
- /* Call user-defined destroy method */
- switch (comp_class->type) {
- case BT_COMPONENT_CLASS_TYPE_SOURCE:
- {
- struct bt_component_class_source *source_class;
-
- source_class = container_of(comp_class, struct bt_component_class_source, parent);
- if (source_class->methods.iterator.finalize) {
- source_class->methods.iterator.finalize(
- bt_private_notification_iterator_from_notification_iterator(iterator));
- }
- break;
- }
- case BT_COMPONENT_CLASS_TYPE_FILTER:
- {
- struct bt_component_class_filter *filter_class;
-
- filter_class = container_of(comp_class, struct bt_component_class_filter, parent);
-
- if (filter_class->methods.iterator.finalize) {
- filter_class->methods.iterator.finalize(
- bt_private_notification_iterator_from_notification_iterator(iterator));
- }
- break;
- }
- default:
- /* Unreachable */
- assert(0);
- }
+ /*
+ * The notification iterator's reference count is 0 if we're
+ * here. Increment it to avoid a double-destroy (possibly
+ * infinitely recursive). This could happen for example if the
+ * notification iterator's finalization function does bt_get()
+ * (or anything that causes bt_get() to be called) on itself
+ * (ref. count goes from 0 to 1), and then bt_put(): the
+ * reference count would go from 1 to 0 again and this function
+ * would be called again.
+ */
+ obj->ref_count.count++;
+ iterator = container_of(obj, struct bt_notification_iterator, base);
+ BT_LOGD("Destroying notification iterator object: addr=%p",
+ iterator);
+ bt_notification_iterator_finalize(iterator);
if (iterator->queue) {
struct bt_notification *notif;
+ BT_LOGD("Putting notifications in queue.");
+
while ((notif = g_queue_pop_tail(iterator->queue))) {
bt_put(notif);
}
while (g_hash_table_iter_next(&ht_iter, &stream_gptr, &stream_state_gptr)) {
assert(stream_gptr);
+
+ BT_LOGD_STR("Removing stream's destroy listener for notification iterator.");
bt_ctf_stream_remove_destroy_listener(
(void *) stream_gptr, stream_destroy_listener,
iterator);
g_array_free(iterator->actions, TRUE);
}
+ if (iterator->connection) {
+ /*
+ * Remove ourself from the originating connection so
+ * that it does not try to finalize a dangling pointer
+ * later.
+ */
+ bt_connection_remove_iterator(iterator->connection, iterator);
+ }
+
+ BT_LOGD_STR("Putting current notification.");
bt_put(iterator->current_notification);
- bt_put(iterator->upstream_component);
- bt_put(iterator->upstream_port);
g_free(iterator);
}
+BT_HIDDEN
+void bt_notification_iterator_finalize(
+ struct bt_notification_iterator *iterator)
+{
+ struct bt_component_class *comp_class = NULL;
+ bt_component_class_notification_iterator_finalize_method
+ finalize_method = NULL;
+
+ assert(iterator);
+
+ switch (iterator->state) {
+ case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED:
+ case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
+ /* Already finalized */
+ BT_LOGD("Not finalizing notification iterator: already finalized: "
+ "addr=%p", iterator);
+ return;
+ default:
+ break;
+ }
+
+ BT_LOGD("Finalizing notification iterator: addr=%p", iterator);
+
+ if (iterator->state == BT_NOTIFICATION_ITERATOR_STATE_ENDED) {
+ BT_LOGD("Updating notification iterator's state: "
+ "new-state=BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED");
+ iterator->state = BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED;
+ } else {
+ BT_LOGD("Updating notification iterator's state: "
+ "new-state=BT_NOTIFICATION_ITERATOR_STATE_FINALIZED");
+ iterator->state = BT_NOTIFICATION_ITERATOR_STATE_FINALIZED;
+ }
+
+ assert(iterator->upstream_component);
+ comp_class = iterator->upstream_component->class;
+
+ /* Call user-defined destroy method */
+ switch (comp_class->type) {
+ case BT_COMPONENT_CLASS_TYPE_SOURCE:
+ {
+ struct bt_component_class_source *source_class;
+
+ source_class = container_of(comp_class, struct bt_component_class_source, parent);
+ finalize_method = source_class->methods.iterator.finalize;
+ break;
+ }
+ case BT_COMPONENT_CLASS_TYPE_FILTER:
+ {
+ struct bt_component_class_filter *filter_class;
+
+ filter_class = container_of(comp_class, struct bt_component_class_filter, parent);
+ finalize_method = filter_class->methods.iterator.finalize;
+ break;
+ }
+ default:
+ /* Unreachable */
+ abort();
+ }
+
+ if (finalize_method) {
+ BT_LOGD("Calling user's finalization method: addr=%p",
+ iterator);
+ finalize_method(
+ bt_private_notification_iterator_from_notification_iterator(iterator));
+ }
+
+ iterator->upstream_component = NULL;
+ iterator->upstream_port = NULL;
+ BT_LOGD("Finalized notification iterator: addr=%p", iterator);
+}
+
+BT_HIDDEN
+void bt_notification_iterator_set_connection(
+ struct bt_notification_iterator *iterator,
+ struct bt_connection *connection)
+{
+ assert(iterator);
+ iterator->connection = connection;
+ BT_LOGV("Set notification iterator's connection: "
+ "iter-addr=%p, conn-addr=%p", iterator, connection);
+}
+
static
int create_subscription_mask_from_notification_types(
struct bt_notification_iterator *iterator,
BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN |
BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END |
BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN |
- BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END;
+ BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END |
+ BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS |
+ BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS;
break;
case BT_NOTIFICATION_TYPE_EVENT:
iterator->subscription_mask |= BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT;
case BT_NOTIFICATION_TYPE_PACKET_END:
iterator->subscription_mask |= BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END;
break;
+ case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
+ iterator->subscription_mask |= BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS;
+ break;
+ case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
+ iterator->subscription_mask |= BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS;
+ break;
default:
ret = -1;
goto end;
}
+
+ BT_LOGV("Added notification type to subscription mask: "
+ "type=%s, mask=%x",
+ bt_notification_type_string(*notif_type),
+ iterator->subscription_mask);
}
end:
}
BT_HIDDEN
-struct bt_notification_iterator *bt_notification_iterator_create(
+enum bt_connection_status bt_notification_iterator_create(
struct bt_component *upstream_comp,
struct bt_port *upstream_port,
- const enum bt_notification_type *notification_types)
+ const enum bt_notification_type *notification_types,
+ struct bt_connection *connection,
+ struct bt_notification_iterator **user_iterator)
{
+ enum bt_connection_status status = BT_CONNECTION_STATUS_OK;
enum bt_component_class_type type;
struct bt_notification_iterator *iterator = NULL;
assert(upstream_port);
assert(notification_types);
assert(bt_port_is_connected(upstream_port));
-
+ assert(user_iterator);
+ BT_LOGD("Creating notification iterator: "
+ "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
+ "upstream-port-addr=%p, upstream-port-name=\"%s\", "
+ "conn-addr=%p",
+ upstream_comp, bt_component_get_name(upstream_comp),
+ upstream_port, bt_port_get_name(upstream_port),
+ connection);
type = bt_component_get_class_type(upstream_comp);
- switch (type) {
- case BT_COMPONENT_CLASS_TYPE_SOURCE:
- case BT_COMPONENT_CLASS_TYPE_FILTER:
- break;
- default:
- goto error;
- }
-
+ assert(type == BT_COMPONENT_CLASS_TYPE_SOURCE ||
+ type == BT_COMPONENT_CLASS_TYPE_FILTER);
iterator = g_new0(struct bt_notification_iterator, 1);
if (!iterator) {
- goto error;
+ BT_LOGE_STR("Failed to allocate one notification iterator.");
+ status = BT_CONNECTION_STATUS_NOMEM;
+ goto end;
}
bt_object_init(iterator, bt_notification_iterator_destroy);
if (create_subscription_mask_from_notification_types(iterator,
notification_types)) {
- goto error;
+ BT_LOGW_STR("Cannot create subscription mask from notification types.");
+ status = BT_CONNECTION_STATUS_INVALID;
+ goto end;
}
iterator->stream_states = g_hash_table_new_full(g_direct_hash,
g_direct_equal, NULL, (GDestroyNotify) destroy_stream_state);
if (!iterator->stream_states) {
- goto error;
+ BT_LOGE_STR("Failed to allocate a GHashTable.");
+ status = BT_CONNECTION_STATUS_NOMEM;
+ goto end;
}
iterator->queue = g_queue_new();
if (!iterator->queue) {
- goto error;
+ BT_LOGE_STR("Failed to allocate a GQueue.");
+ status = BT_CONNECTION_STATUS_NOMEM;
+ goto end;
}
iterator->actions = g_array_new(FALSE, FALSE, sizeof(struct action));
if (!iterator->actions) {
- goto error;
+ BT_LOGE_STR("Failed to allocate a GArray.");
+ status = BT_CONNECTION_STATUS_NOMEM;
+ goto end;
}
- iterator->upstream_component = bt_get(upstream_comp);
- iterator->upstream_port = bt_get(upstream_port);
- goto end;
-
-error:
- BT_PUT(iterator);
-
-end:
- return iterator;
-}
-
-BT_HIDDEN
-enum bt_notification_iterator_status bt_notification_iterator_validate(
- struct bt_notification_iterator *iterator)
-{
- enum bt_notification_iterator_status ret =
- BT_NOTIFICATION_ITERATOR_STATUS_OK;
+ iterator->upstream_component = upstream_comp;
+ iterator->upstream_port = upstream_port;
+ iterator->connection = connection;
+ iterator->state = BT_NOTIFICATION_ITERATOR_STATE_ACTIVE;
+ BT_LOGD("Created notification iterator: "
+ "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
+ "upstream-port-addr=%p, upstream-port-name=\"%s\", "
+ "conn-addr=%p, iter-addr=%p",
+ upstream_comp, bt_component_get_name(upstream_comp),
+ upstream_port, bt_port_get_name(upstream_port),
+ connection, iterator);
+
+ /* Move reference to user */
+ *user_iterator = iterator;
+ iterator = NULL;
- if (!iterator) {
- ret = BT_NOTIFICATION_ITERATOR_STATUS_INVALID;
- goto end;
- }
end:
- return ret;
+ bt_put(iterator);
+ return status;
}
void *bt_private_notification_iterator_get_user_data(
bt_notification_iterator_from_private(private_iterator);
if (!iterator) {
+ BT_LOGW_STR("Invalid parameter: notification iterator is NULL.");
ret = BT_NOTIFICATION_ITERATOR_STATUS_INVALID;
goto end;
}
iterator->user_data = data;
+ BT_LOGV("Set notification iterator's user data: "
+ "iter-addr=%p, user-data-addr=%p", iterator, data);
+
end:
return ret;
}
struct bt_notification *notification = NULL;
if (!iterator) {
+ BT_LOGW_STR("Invalid parameter: notification iterator is NULL.");
goto end;
}
case BT_NOTIFICATION_TYPE_PACKET_END:
iter_notif_type = BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END;
break;
+ case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
+ iter_notif_type = BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS;
+ break;
+ case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
+ iter_notif_type = BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS;
+ break;
default:
- assert(BT_FALSE);
+ abort();
}
return iter_notif_type;
* bad: the API guarantees that it can never
* happen.
*/
+ BT_LOGW("Two different ports of the same component are emitting notifications which refer to the same stream: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "stream-comp-cur-port-addr=%p, "
+ "stream-comp-cur-port-name=%p, "
+ "iter-upstream-port-addr=%p, "
+ "iter-upstream-port-name=%s",
+ notif_stream,
+ bt_ctf_stream_get_name(notif_stream),
+ stream_comp_cur_port,
+ bt_port_get_name(stream_comp_cur_port),
+ iterator->upstream_port,
+ bt_port_get_name(iterator->upstream_port));
is_valid = BT_FALSE;
goto end;
}
stream_state = g_hash_table_lookup(iterator->stream_states,
notif_stream);
if (stream_state) {
+ BT_LOGV("Stream state already exists: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "stream-state-addr=%p",
+ notif_stream,
+ bt_ctf_stream_get_name(notif_stream), stream_state);
+
if (stream_state->is_ended) {
/*
* There's a new notification which has a
* bad: the API guarantees that it can never
* happen.
*/
+ BT_LOGW("Stream is already ended: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ notif_stream,
+ bt_ctf_stream_get_name(notif_stream));
is_valid = BT_FALSE;
goto end;
}
* we already returned a "stream begin"
* notification: this is an invalid duplicate.
*/
+ BT_LOGW("Duplicate stream beginning notification: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ notif_stream,
+ bt_ctf_stream_get_name(notif_stream));
is_valid = BT_FALSE;
goto end;
case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
if (notif_packet == stream_state->cur_packet) {
/* Duplicate "packet begin" notification */
+ BT_LOGW("Duplicate stream beginning notification: "
+ "stream-addr=%p, stream-name=\"%s\", "
+ "packet-addr=%p",
+ notif_stream,
+ bt_ctf_stream_get_name(notif_stream),
+ notif_packet);
is_valid = BT_FALSE;
goto end;
}
action.payload.push_notif.notif = bt_get(notif);
add_action(iterator, &action);
+ BT_LOGV("Added \"push notification\" action: notif-addr=%p", notif);
}
static
if (!is_subscribed_to_notification_type(iterator,
BT_NOTIFICATION_TYPE_STREAM_BEGIN)) {
+ BT_LOGV("Not adding \"push stream beginning notification\" action: "
+ "notification iterator is not subscribed: addr=%p",
+ iterator);
goto end;
}
assert(stream);
stream_begin_notif = bt_notification_stream_begin_create(stream);
if (!stream_begin_notif) {
+ BT_LOGE_STR("Cannot create stream beginning notification.");
goto error;
}
add_action_push_notif(iterator, stream_begin_notif);
+ BT_LOGV("Added \"push stream beginning notification\" action: "
+ "stream-addr=%p, stream-name=\"%s\"",
+ stream, bt_ctf_stream_get_name(stream));
goto end;
error:
if (!is_subscribed_to_notification_type(iterator,
BT_NOTIFICATION_TYPE_STREAM_END)) {
+ BT_LOGV("Not adding \"push stream end notification\" action: "
+ "notification iterator is not subscribed: addr=%p",
+ iterator);
goto end;
}
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:
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:
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:
assert(stream_state);
add_action(iterator, &action);
+ BT_LOGV("Added \"set stream state's ended\" action: "
+ "stream-state-addr=%p", stream_state);
}
static
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
*stream_state = create_stream_state(notif_stream);
if (!stream_state) {
+ BT_LOGE_STR("Cannot create stream state.");
goto error;
}
ret = add_action_push_notif_stream_begin(iterator,
notif_stream);
if (ret) {
+ BT_LOGE_STR("Cannot add \"push stream beginning notification\" action.");
goto error;
}
}
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,
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);
ret = add_action_push_notif_packet_begin(iterator,
new_packet);
if (ret) {
+ BT_LOGE_STR("Cannot add \"push packet beginning notification\" action.");
goto error;
}
}
ret = ensure_stream_state_exists(iterator, notif, notif_stream,
&stream_state);
if (ret) {
+ BT_LOGE_STR("Cannot ensure that stream state exists.");
goto error;
}
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;
}
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,
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;
}
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;
}
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;
}
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.
break;
case BT_NOTIFICATION_TYPE_INACTIVITY:
/* Always valid */
- break;
+ goto handle_notif;
default:
/*
* Invalid type of notification. Only the notification
* types above are allowed to be returned by a user
* component.
*/
- goto error;
+ 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) {
* 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,
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:
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.
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;
}
}
apply_actions(iterator);
+ BT_LOGV("Handled end of iteration: addr=%p", iterator);
goto end;
error:
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 */
+ /*
+ * 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;
}
- if (iterator->is_ended) {
+ 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);
break;
}
default:
- assert(BT_FALSE);
- break;
+ abort();
}
/*
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;
}
- iterator->is_ended = BT_TRUE;
+ 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
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 */
- assert(BT_FALSE);
+ abort();
}
}
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;
}
projects / babeltrace.git / blobdiff