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-notification-iterator.h>
36 #include <babeltrace/types.h>
40 enum bt_notification_iterator_notif_type
{
41 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT
= (1U << 0),
42 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY
= (1U << 1),
43 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN
= (1U << 2),
44 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END
= (1U << 3),
45 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN
= (1U << 4),
46 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END
= (1U << 5),
49 enum bt_notification_iterator_state
{
50 /* Iterator is active, not at the end yet, and not finalized. */
51 BT_NOTIFICATION_ITERATOR_STATE_ACTIVE
,
54 * Iterator is ended, not finalized yet: the "next" method
55 * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
57 BT_NOTIFICATION_ITERATOR_STATE_ENDED
,
60 * Iterator is finalized, but not at the end yet. This means
61 * that the "next" method can still return queued notifications
62 * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
65 BT_NOTIFICATION_ITERATOR_STATE_FINALIZED
,
68 * Iterator is finalized and ended: the "next" method always
69 * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
71 BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
,
74 struct bt_notification_iterator
{
75 struct bt_object base
;
76 struct bt_component
*upstream_component
; /* Weak */
77 struct bt_port
*upstream_port
; /* Weak */
78 struct bt_connection
*connection
; /* Weak */
79 struct bt_notification
*current_notification
; /* owned by this */
80 GQueue
*queue
; /* struct bt_notification * (owned by this) */
83 * This hash table keeps the state of a stream as viewed by
84 * this notification iterator. This is used to:
86 * * Automatically enqueue "stream begin", "packet begin",
87 * "packet end", and "stream end" notifications depending
88 * on the stream's state and on the next notification returned
89 * by the upstream component.
91 * * Make sure that, once the notification iterator has seen
92 * a "stream end" notification for a given stream, that no
93 * other notifications which refer to this stream can be
94 * delivered by this iterator.
96 * The key (struct bt_ctf_stream *) is not owned by this. The
97 * value is an allocated state structure.
99 GHashTable
*stream_states
;
102 * This is an array of actions which can be rolled back. It's
103 * similar to the memento pattern, but it's not exactly that. It
104 * is allocated once and reset for each notification to process.
105 * More details near the implementation.
110 * This is a mask of notifications to which the user of this
111 * iterator is subscribed
112 * (see enum bt_notification_iterator_notif_type above).
114 uint32_t subscription_mask
;
116 enum bt_notification_iterator_state state
;
121 struct bt_notification_iterator
*bt_notification_iterator_from_private(
122 struct bt_private_notification_iterator
*private_notification_iterator
)
124 return (void *) private_notification_iterator
;
128 struct bt_private_notification_iterator
*
129 bt_private_notification_iterator_from_notification_iterator(
130 struct bt_notification_iterator
*notification_iterator
)
132 return (void *) notification_iterator
;
136 * Allocate a notification iterator.
138 * @param component Component instance
139 * @returns A notification iterator instance
142 struct bt_notification_iterator
*bt_notification_iterator_create(
143 struct bt_component
*upstream_component
,
144 struct bt_port
*upstream_port
,
145 const enum bt_notification_type
*notification_types
,
146 struct bt_connection
*connection
);
149 void bt_notification_iterator_finalize(
150 struct bt_notification_iterator
*iterator
);
153 void bt_notification_iterator_set_connection(
154 struct bt_notification_iterator
*iterator
,
155 struct bt_connection
*connection
);
158 const char *bt_notification_iterator_status_string(
159 enum bt_notification_iterator_status status
)
162 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
:
163 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
164 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
165 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
166 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
167 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
168 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
169 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
170 case BT_NOTIFICATION_ITERATOR_STATUS_INVALID
:
171 return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
172 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
173 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
174 case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
:
175 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
176 case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED
:
177 return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
184 const char *bt_notification_iterator_state_string(
185 enum bt_notification_iterator_state state
)
188 case BT_NOTIFICATION_ITERATOR_STATE_ACTIVE
:
189 return "BT_NOTIFICATION_ITERATOR_STATE_ACTIVE";
190 case BT_NOTIFICATION_ITERATOR_STATE_ENDED
:
191 return "BT_NOTIFICATION_ITERATOR_STATE_ENDED";
192 case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED
:
193 return "BT_NOTIFICATION_ITERATOR_STATE_FINALIZED";
194 case BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED
:
195 return "BT_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
201 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */