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>
38 struct bt_notification_iterator
{
39 struct bt_object base
;
40 struct bt_component
*upstream_component
; /* owned by this */
41 struct bt_port
*upstream_port
; /* owned by this */
42 struct bt_notification
*current_notification
; /* owned by this */
43 GQueue
*queue
; /* struct bt_notification * (owned by this) */
46 * This hash table keeps the state of a stream as viewed by
47 * this notification iterator. This is used to:
49 * * Automatically enqueue "stream begin", "packet begin",
50 * "packet end", and "stream end" notifications depending
51 * on the stream's state and on the next notification returned
52 * by the upstream component.
54 * * Make sure that, once the notification iterator has seen
55 * a "stream end" notification for a given stream, that no
56 * other notifications which refer to this stream can be
57 * delivered by this iterator.
59 * The key (struct bt_ctf_stream *) is not owned by this. The
60 * value is an allocated state structure.
62 GHashTable
*stream_states
;
65 * This is an array of actions which can be rolled back. It's
66 * similar to the memento pattern, but it's not exactly that. It
67 * is allocated once and reset for each notification to process.
68 * More details near the implementation.
77 struct bt_notification_iterator
*bt_notification_iterator_from_private(
78 struct bt_private_notification_iterator
*private_notification_iterator
)
80 return (void *) private_notification_iterator
;
84 struct bt_private_notification_iterator
*
85 bt_private_notification_iterator_from_notification_iterator(
86 struct bt_notification_iterator
*notification_iterator
)
88 return (void *) notification_iterator
;
92 * Allocate a notification iterator.
94 * @param component Component instance
95 * @returns A notification iterator instance
98 struct bt_notification_iterator
*bt_notification_iterator_create(
99 struct bt_component
*upstream_component
,
100 struct bt_port
*upstream_port
);
103 * Validate a notification iterator.
105 * @param iterator Notification iterator instance
106 * @returns One of #bt_component_status values
109 enum bt_notification_iterator_status
bt_notification_iterator_validate(
110 struct bt_notification_iterator
*iterator
);
112 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */