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/notification.h>
33 #include <babeltrace/graph/notification-iterator.h>
34 #include <babeltrace/graph/private-notification-iterator.h>
35 #include <babeltrace/types.h>
39 enum bt_notification_iterator_notif_type
{
40 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT
= (1U << 0),
41 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY
= (1U << 1),
42 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN
= (1U << 2),
43 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END
= (1U << 3),
44 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN
= (1U << 4),
45 BT_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END
= (1U << 5),
48 struct bt_notification_iterator
{
49 struct bt_object base
;
50 struct bt_component
*upstream_component
; /* owned by this */
51 struct bt_port
*upstream_port
; /* owned by this */
52 struct bt_notification
*current_notification
; /* owned by this */
53 GQueue
*queue
; /* struct bt_notification * (owned by this) */
56 * This hash table keeps the state of a stream as viewed by
57 * this notification iterator. This is used to:
59 * * Automatically enqueue "stream begin", "packet begin",
60 * "packet end", and "stream end" notifications depending
61 * on the stream's state and on the next notification returned
62 * by the upstream component.
64 * * Make sure that, once the notification iterator has seen
65 * a "stream end" notification for a given stream, that no
66 * other notifications which refer to this stream can be
67 * delivered by this iterator.
69 * The key (struct bt_ctf_stream *) is not owned by this. The
70 * value is an allocated state structure.
72 GHashTable
*stream_states
;
75 * This is an array of actions which can be rolled back. It's
76 * similar to the memento pattern, but it's not exactly that. It
77 * is allocated once and reset for each notification to process.
78 * More details near the implementation.
83 * This is a mask of notifications to which the user of this
84 * iterator is subscribed
85 * (see enum bt_notification_iterator_notif_type above).
87 uint32_t subscription_mask
;
94 struct bt_notification_iterator
*bt_notification_iterator_from_private(
95 struct bt_private_notification_iterator
*private_notification_iterator
)
97 return (void *) private_notification_iterator
;
101 struct bt_private_notification_iterator
*
102 bt_private_notification_iterator_from_notification_iterator(
103 struct bt_notification_iterator
*notification_iterator
)
105 return (void *) notification_iterator
;
109 * Allocate a notification iterator.
111 * @param component Component instance
112 * @returns A notification iterator instance
115 struct bt_notification_iterator
*bt_notification_iterator_create(
116 struct bt_component
*upstream_component
,
117 struct bt_port
*upstream_port
,
118 const enum bt_notification_type
*notification_types
);
121 * Validate a notification iterator.
123 * @param iterator Notification iterator instance
124 * @returns One of #bt_component_status values
127 enum bt_notification_iterator_status
bt_notification_iterator_validate(
128 struct bt_notification_iterator
*iterator
);
130 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */