lib: notification iterator: transfer a batch of notifications
[babeltrace.git] / include / babeltrace / graph / notification-iterator-internal.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
2#define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
47e5a032
JG
3
4/*
5 * BabelTrace - Notification Iterator Internal
6 *
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3230ee6b 8 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
47e5a032
JG
9 *
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:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
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
26 * SOFTWARE.
27 */
28
29#include <babeltrace/babeltrace-internal.h>
890882ef 30#include <babeltrace/object-internal.h>
bd14d768 31#include <babeltrace/graph/connection.h>
b2e0c907
PP
32#include <babeltrace/graph/notification.h>
33#include <babeltrace/graph/notification-iterator.h>
90157d89 34#include <babeltrace/graph/private-connection-private-notification-iterator.h>
c55a9f58 35#include <babeltrace/types.h>
f6ccaed9 36#include <babeltrace/assert-internal.h>
088d4023 37#include <stdbool.h>
47e5a032 38
3230ee6b 39struct bt_port;
8ed535b5 40struct bt_graph;
3230ee6b 41
90157d89
PP
42enum bt_notification_iterator_type {
43 BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION,
8ed535b5 44 BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT,
fa054faf
PP
45};
46
90157d89
PP
47enum bt_private_connection_notification_iterator_notif_type {
48 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT = (1U << 0),
49 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY = (1U << 1),
50 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN = (1U << 2),
51 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END = (1U << 3),
52 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN = (1U << 4),
53 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END = (1U << 5),
54 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS = (1U << 6),
55 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS = (1U << 7),
56};
57
58enum bt_private_connection_notification_iterator_state {
088d4023 59 /* Iterator is not initialized. */
90157d89 60 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED,
088d4023 61
bd14d768 62 /* Iterator is active, not at the end yet, and not finalized. */
90157d89 63 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE,
bd14d768
PP
64
65 /*
66 * Iterator is ended, not finalized yet: the "next" method
67 * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
68 */
90157d89 69 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED,
bd14d768
PP
70
71 /*
72 * Iterator is finalized, but not at the end yet. This means
73 * that the "next" method can still return queued notifications
74 * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
75 * status.
76 */
90157d89 77 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED,
bd14d768
PP
78
79 /*
80 * Iterator is finalized and ended: the "next" method always
81 * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
82 */
90157d89 83 BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED,
bd14d768
PP
84};
85
47e5a032 86struct bt_notification_iterator {
b8a06801 87 struct bt_object base;
90157d89 88 enum bt_notification_iterator_type type;
d4393e08 89 GPtrArray *notifs;
90157d89
PP
90};
91
92struct bt_notification_iterator_private_connection {
93 struct bt_notification_iterator base;
bd14d768
PP
94 struct bt_component *upstream_component; /* Weak */
95 struct bt_port *upstream_port; /* Weak */
96 struct bt_connection *connection; /* Weak */
5c563278 97 struct bt_graph *graph; /* Weak */
3230ee6b
PP
98
99 /*
100 * This hash table keeps the state of a stream as viewed by
f42867e2
PP
101 * this notification iterator. This is used to, in developer
102 * mode:
3230ee6b
PP
103 *
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.
108 *
f42867e2
PP
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
112 * by this iterator.
3230ee6b 113 *
50842bdc 114 * The key (struct bt_stream *) is not owned by this. The
3230ee6b
PP
115 * value is an allocated state structure.
116 */
117 GHashTable *stream_states;
118
90157d89 119 enum bt_private_connection_notification_iterator_state state;
47e5a032
JG
120 void *user_data;
121};
122
8ed535b5
PP
123struct 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 */
8ed535b5 127
d4393e08
PP
128 /*
129 * Only used temporarily as a bridge between a colander sink and
130 * the user.
131 */
132 uint64_t count;
07245ac2 133};
8ed535b5 134
890882ef 135static inline
90157d89
PP
136struct bt_private_connection_private_notification_iterator *
137bt_private_connection_private_notification_iterator_from_notification_iterator(
138 struct bt_notification_iterator_private_connection *iterator)
890882ef 139{
90157d89 140 return (void *) iterator;
890882ef
PP
141}
142
47e5a032 143BT_HIDDEN
90157d89 144enum bt_connection_status bt_private_connection_notification_iterator_create(
73d5c1ad 145 struct bt_component *upstream_comp,
fa054faf 146 struct bt_port *upstream_port,
73d5c1ad 147 struct bt_connection *connection,
90157d89 148 struct bt_notification_iterator_private_connection **iterator);
47e5a032 149
bd14d768 150BT_HIDDEN
90157d89
PP
151void bt_private_connection_notification_iterator_finalize(
152 struct bt_notification_iterator_private_connection *iterator);
bd14d768
PP
153
154BT_HIDDEN
90157d89
PP
155void bt_private_connection_notification_iterator_set_connection(
156 struct bt_notification_iterator_private_connection *iterator,
bd14d768
PP
157 struct bt_connection *connection);
158
a36bfb16
PP
159static inline
160const char *bt_notification_iterator_status_string(
161 enum bt_notification_iterator_status status)
162{
163 switch (status) {
164 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
165 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
166 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
167 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
168 case BT_NOTIFICATION_ITERATOR_STATUS_END:
169 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
170 case BT_NOTIFICATION_ITERATOR_STATUS_OK:
171 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
172 case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
173 return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
174 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
175 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
176 case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
177 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
178 case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
179 return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
180 default:
181 return "(unknown)";
182 }
183};
184
8f9d7550 185static inline
90157d89
PP
186const char *bt_private_connection_notification_iterator_state_string(
187 enum bt_private_connection_notification_iterator_state state)
8f9d7550
PP
188{
189 switch (state) {
90157d89
PP
190 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE:
191 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
192 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED:
193 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
194 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED:
195 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
196 case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
197 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
8f9d7550
PP
198 default:
199 return "(unknown)";
200 }
201};
202
6ac74c0c 203#endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */
This page took 0.048659 seconds and 4 git commands to generate.