1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
2 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include <babeltrace/babeltrace-internal.h>
28 #include <babeltrace/object-internal.h>
29 #include <babeltrace/graph/connection-const.h>
30 #include <babeltrace/graph/notification-const.h>
31 #include <babeltrace/graph/notification-iterator.h>
32 #include <babeltrace/types.h>
33 #include <babeltrace/assert-internal.h>
39 enum bt_notification_iterator_type
{
40 BT_NOTIFICATION_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
,
41 BT_NOTIFICATION_ITERATOR_TYPE_PORT_OUTPUT
,
44 enum bt_self_component_port_input_notification_iterator_state
{
45 /* Iterator is not initialized. */
46 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED
,
48 /* Iterator is active, not at the end yet, and not finalized. */
49 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE
,
52 * Iterator is ended, not finalized yet: the "next" method
53 * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
55 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ENDED
,
58 * Iterator is finalized, but not at the end yet. This means
59 * that the "next" method can still return queued notifications
60 * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
63 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED
,
66 * Iterator is finalized and ended: the "next" method always
67 * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
69 BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
,
72 struct bt_notification_iterator
{
73 struct bt_object base
;
74 enum bt_notification_iterator_type type
;
78 struct bt_self_component_port_input_notification_iterator
{
79 struct bt_notification_iterator base
;
80 struct bt_component
*upstream_component
; /* Weak */
81 struct bt_port
*upstream_port
; /* Weak */
82 struct bt_connection
*connection
; /* Weak */
83 struct bt_graph
*graph
; /* Weak */
86 * This hash table keeps the state of a stream as viewed by
87 * this notification iterator. This is used to, in developer
90 * * Automatically enqueue "stream begin", "packet begin",
91 * "packet end", and "stream end" notifications depending
92 * on the stream's state and on the next notification returned
93 * by the upstream component.
95 * * Make sure that, once the notification iterator has seen a
96 * "stream end" notification for a given stream, no other
97 * notifications which refer to this stream can be delivered
100 * The key (struct bt_stream *) is not owned by this. The
101 * value is an allocated state structure.
103 GHashTable
*stream_states
;
105 enum bt_self_component_port_input_notification_iterator_state state
;
109 struct bt_port_output_notification_iterator
{
110 struct bt_notification_iterator base
;
111 struct bt_graph
*graph
; /* Owned by this */
112 struct bt_component_sink
*colander
; /* Owned by this */
115 * Only used temporarily as a bridge between a colander sink and
122 void bt_self_component_port_input_notification_iterator_finalize(
123 struct bt_self_component_port_input_notification_iterator
*iterator
);
126 void bt_self_component_port_input_notification_iterator_set_connection(
127 struct bt_self_component_port_input_notification_iterator
*iterator
,
128 struct bt_connection
*connection
);
131 const char *bt_notification_iterator_status_string(
132 enum bt_notification_iterator_status status
)
135 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
:
136 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
137 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
138 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
139 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
140 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
141 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
142 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
143 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
144 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
145 case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
:
146 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
153 const char *bt_self_component_port_input_notification_iterator_state_string(
154 enum bt_self_component_port_input_notification_iterator_state state
)
157 case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE
:
158 return "BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ACTIVE";
159 case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ENDED
:
160 return "BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_ENDED";
161 case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED
:
162 return "BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED";
163 case BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
:
164 return "BT_SELF_COMPONENT_PORT_INPUT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
170 #endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */