X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fgraph%2Fnotification-iterator-internal.h;h=dd80a5192b595f1199415df706ce6c057f87bde2;hb=3fea54f69edd1780566230255da196cb6e82df62;hp=dc4e430928609b37df95d1a8d750a59bb9110db1;hpb=3230ee6b4f3a704958b761daecae835c56938bc9;p=babeltrace.git diff --git a/include/babeltrace/graph/notification-iterator-internal.h b/include/babeltrace/graph/notification-iterator-internal.h index dc4e4309..dd80a519 100644 --- a/include/babeltrace/graph/notification-iterator-internal.h +++ b/include/babeltrace/graph/notification-iterator-internal.h @@ -1,5 +1,5 @@ -#ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H -#define BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H +#ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H +#define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H /* * BabelTrace - Notification Iterator Internal @@ -28,85 +28,172 @@ #include #include -#include +#include #include #include -#include +#include +#include +#include +#include struct bt_port; +struct bt_graph; + +enum bt_notification_iterator_type { + BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION, + BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT, +}; + +enum bt_private_connection_notification_iterator_notif_type { + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT = (1U << 0), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY = (1U << 1), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN = (1U << 2), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END = (1U << 3), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN = (1U << 4), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END = (1U << 5), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS = (1U << 6), + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS = (1U << 7), +}; + +enum bt_private_connection_notification_iterator_state { + /* Iterator is not initialized. */ + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED, + + /* Iterator is active, not at the end yet, and not finalized. */ + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE, + + /* + * Iterator is ended, not finalized yet: the "next" method + * returns BT_NOTIFICATION_ITERATOR_STATUS_END. + */ + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED, + + /* + * Iterator is finalized, but not at the end yet. This means + * that the "next" method can still return queued notifications + * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED + * status. + */ + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED, + + /* + * Iterator is finalized and ended: the "next" method always + * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED. + */ + BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED, +}; struct bt_notification_iterator { struct bt_object base; - struct bt_component *upstream_component; /* owned by this */ - struct bt_port *upstream_port; /* owned by this */ - struct bt_notification *current_notification; /* owned by this */ - GQueue *queue; /* struct bt_notification * (owned by this) */ + enum bt_notification_iterator_type type; +}; + +struct bt_notification_iterator_private_connection { + struct bt_notification_iterator base; + struct bt_component *upstream_component; /* Weak */ + struct bt_port *upstream_port; /* Weak */ + struct bt_connection *connection; /* Weak */ + struct bt_graph *graph; /* Weak */ /* * This hash table keeps the state of a stream as viewed by - * this notification iterator. This is used to: + * this notification iterator. This is used to, in developer + * mode: * * * Automatically enqueue "stream begin", "packet begin", * "packet end", and "stream end" notifications depending * on the stream's state and on the next notification returned * by the upstream component. * - * * Make sure that, once the notification iterator has seen - * a "stream end" notification for a given stream, that no - * other notifications which refer to this stream can be - * delivered by this iterator. + * * Make sure that, once the notification iterator has seen a + * "stream end" notification for a given stream, no other + * notifications which refer to this stream can be delivered + * by this iterator. * - * The key (struct bt_ctf_stream *) is not owned by this. The + * The key (struct bt_stream *) is not owned by this. The * value is an allocated state structure. */ GHashTable *stream_states; - /* - * This is an array of actions which can be rolled back. It's - * similar to the memento pattern, but it's not exactly that. It - * is allocated once and reset for each notification to process. - * More details near the implementation. - */ - GArray *actions; - - bool is_ended; + enum bt_private_connection_notification_iterator_state state; void *user_data; }; -static inline -struct bt_notification_iterator *bt_notification_iterator_from_private( - struct bt_private_notification_iterator *private_notification_iterator) -{ - return (void *) private_notification_iterator; -} +struct bt_notification_iterator_output_port { + struct bt_notification_iterator base; + struct bt_graph *graph; /* Owned by this */ + struct bt_component *colander; /* Owned by this */ + + /* Only used temporarily: should always be NULL */ + struct bt_notification *notif; +}; static inline -struct bt_private_notification_iterator * -bt_private_notification_iterator_from_notification_iterator( - struct bt_notification_iterator *notification_iterator) +struct bt_private_connection_private_notification_iterator * +bt_private_connection_private_notification_iterator_from_notification_iterator( + struct bt_notification_iterator_private_connection *iterator) { - return (void *) notification_iterator; + return (void *) iterator; } -/** - * Allocate a notification iterator. - * - * @param component Component instance - * @returns A notification iterator instance - */ BT_HIDDEN -struct bt_notification_iterator *bt_notification_iterator_create( - struct bt_component *upstream_component, - struct bt_port *upstream_port); +enum bt_connection_status bt_private_connection_notification_iterator_create( + struct bt_component *upstream_comp, + struct bt_port *upstream_port, + struct bt_connection *connection, + struct bt_notification_iterator_private_connection **iterator); -/** - * Validate a notification iterator. - * - * @param iterator Notification iterator instance - * @returns One of #bt_component_status values - */ BT_HIDDEN -enum bt_notification_iterator_status bt_notification_iterator_validate( - struct bt_notification_iterator *iterator); +void bt_private_connection_notification_iterator_finalize( + struct bt_notification_iterator_private_connection *iterator); + +BT_HIDDEN +void bt_private_connection_notification_iterator_set_connection( + struct bt_notification_iterator_private_connection *iterator, + struct bt_connection *connection); + +static inline +const char *bt_notification_iterator_status_string( + enum bt_notification_iterator_status status) +{ + switch (status) { + case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED: + return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED"; + case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN: + return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN"; + case BT_NOTIFICATION_ITERATOR_STATUS_END: + return "BT_NOTIFICATION_ITERATOR_STATUS_END"; + case BT_NOTIFICATION_ITERATOR_STATUS_OK: + return "BT_NOTIFICATION_ITERATOR_STATUS_OK"; + case BT_NOTIFICATION_ITERATOR_STATUS_INVALID: + return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID"; + case BT_NOTIFICATION_ITERATOR_STATUS_ERROR: + return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR"; + case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM: + return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM"; + case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED: + return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED"; + default: + return "(unknown)"; + } +}; + +static inline +const char *bt_private_connection_notification_iterator_state_string( + enum bt_private_connection_notification_iterator_state state) +{ + switch (state) { + case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE: + return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE"; + case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED: + return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED"; + case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED: + return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED"; + case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED: + return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED"; + default: + return "(unknown)"; + } +}; -#endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */ +#endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */