1 #ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
2 #define BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
5 * BabelTrace - Notification Iterator Internal
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/babeltrace-internal.h>
30 #include <babeltrace/object-internal.h>
31 #include <babeltrace/ref-internal.h>
32 #include <babeltrace/graph/connection.h>
33 #include <babeltrace/graph/notification.h>
34 #include <babeltrace/graph/notification-iterator.h>
35 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
36 #include <babeltrace/types.h>
37 #include <babeltrace/assert-internal.h>
43 enum bt_notification_iterator_type
{
44 BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION
,
45 BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT
,
48 enum bt_private_connection_notification_iterator_notif_type
{
49 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT
= (1U << 0),
50 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY
= (1U << 1),
51 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN
= (1U << 2),
52 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END
= (1U << 3),
53 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN
= (1U << 4),
54 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END
= (1U << 5),
55 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS
= (1U << 6),
56 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS
= (1U << 7),
59 enum bt_private_connection_notification_iterator_state
{
60 /* Iterator is not initialized. */
61 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED
,
63 /* Iterator is active, not at the end yet, and not finalized. */
64 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE
,
67 * Iterator is ended, not finalized yet: the "next" method
68 * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
70 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED
,
73 * Iterator is finalized, but not at the end yet. This means
74 * that the "next" method can still return queued notifications
75 * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
78 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED
,
81 * Iterator is finalized and ended: the "next" method always
82 * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
84 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
,
87 struct bt_notification_iterator
{
88 struct bt_object base
;
89 enum bt_notification_iterator_type type
;
90 struct bt_notification
*current_notification
; /* owned by this */
93 struct bt_notification_iterator_private_connection
{
94 struct bt_notification_iterator base
;
95 struct bt_component
*upstream_component
; /* Weak */
96 struct bt_port
*upstream_port
; /* Weak */
97 struct bt_connection
*connection
; /* Weak */
100 * This hash table keeps the state of a stream as viewed by
101 * this notification iterator. This is used to, in developer
104 * * Automatically enqueue "stream begin", "packet begin",
105 * "packet end", and "stream end" notifications depending
106 * on the stream's state and on the next notification returned
107 * by the upstream component.
109 * * Make sure that, once the notification iterator has seen a
110 * "stream end" notification for a given stream, no other
111 * notifications which refer to this stream can be delivered
114 * The key (struct bt_stream *) is not owned by this. The
115 * value is an allocated state structure.
117 GHashTable
*stream_states
;
119 enum bt_private_connection_notification_iterator_state state
;
123 struct bt_notification_iterator_output_port
{
124 struct bt_notification_iterator base
;
125 struct bt_graph
*graph
; /* Owned by this */
126 struct bt_component
*colander
; /* Owned by this */
127 struct bt_port
*output_port
; /* Owned by this */
131 struct bt_notification
*bt_notification_iterator_borrow_current_notification(
132 struct bt_notification_iterator
*iterator
)
135 return iterator
->current_notification
;
139 void bt_notification_iterator_replace_current_notification(
140 struct bt_notification_iterator
*iterator
,
141 struct bt_notification
*notification
)
144 bt_put(iterator
->current_notification
);
145 iterator
->current_notification
= bt_get(notification
);
149 struct bt_notification_iterator_private_connection
*
150 bt_private_connection_notification_iterator_borrow_from_private(
151 struct bt_private_connection_private_notification_iterator
*private_notification_iterator
)
153 return (void *) private_notification_iterator
;
157 struct bt_private_connection_private_notification_iterator
*
158 bt_private_connection_private_notification_iterator_from_notification_iterator(
159 struct bt_notification_iterator_private_connection
*iterator
)
161 return (void *) iterator
;
165 enum bt_connection_status
bt_private_connection_notification_iterator_create(
166 struct bt_component
*upstream_comp
,
167 struct bt_port
*upstream_port
,
168 struct bt_connection
*connection
,
169 struct bt_notification_iterator_private_connection
**iterator
);
172 void bt_private_connection_notification_iterator_finalize(
173 struct bt_notification_iterator_private_connection
*iterator
);
176 void bt_private_connection_notification_iterator_set_connection(
177 struct bt_notification_iterator_private_connection
*iterator
,
178 struct bt_connection
*connection
);
181 const char *bt_notification_iterator_status_string(
182 enum bt_notification_iterator_status status
)
185 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
:
186 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
187 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
188 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
189 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
190 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
191 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
192 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
193 case BT_NOTIFICATION_ITERATOR_STATUS_INVALID
:
194 return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
195 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
196 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
197 case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
:
198 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
199 case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED
:
200 return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
207 const char *bt_private_connection_notification_iterator_state_string(
208 enum bt_private_connection_notification_iterator_state state
)
211 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE
:
212 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
213 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED
:
214 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
215 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED
:
216 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
217 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
:
218 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
224 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */