Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H |
2 | #define BABELTRACE_COMPONENT_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> |
fb2dcc52 | 31 | #include <babeltrace/ref-internal.h> |
b2e0c907 PP |
32 | #include <babeltrace/graph/notification.h> |
33 | #include <babeltrace/graph/notification-iterator.h> | |
34 | #include <babeltrace/graph/private-notification-iterator.h> | |
c55a9f58 | 35 | #include <babeltrace/types.h> |
47e5a032 | 36 | |
3230ee6b PP |
37 | struct bt_port; |
38 | ||
fa054faf PP |
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), | |
46 | }; | |
47 | ||
47e5a032 | 48 | struct bt_notification_iterator { |
b8a06801 | 49 | struct bt_object base; |
3230ee6b PP |
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) */ | |
54 | ||
55 | /* | |
56 | * This hash table keeps the state of a stream as viewed by | |
57 | * this notification iterator. This is used to: | |
58 | * | |
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. | |
63 | * | |
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. | |
68 | * | |
69 | * The key (struct bt_ctf_stream *) is not owned by this. The | |
70 | * value is an allocated state structure. | |
71 | */ | |
72 | GHashTable *stream_states; | |
73 | ||
74 | /* | |
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. | |
79 | */ | |
80 | GArray *actions; | |
81 | ||
fa054faf PP |
82 | /* |
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). | |
86 | */ | |
87 | uint32_t subscription_mask; | |
88 | ||
c55a9f58 | 89 | bt_bool is_ended; |
47e5a032 JG |
90 | void *user_data; |
91 | }; | |
92 | ||
890882ef PP |
93 | static inline |
94 | struct bt_notification_iterator *bt_notification_iterator_from_private( | |
95 | struct bt_private_notification_iterator *private_notification_iterator) | |
96 | { | |
97 | return (void *) private_notification_iterator; | |
98 | } | |
99 | ||
100 | static inline | |
101 | struct bt_private_notification_iterator * | |
102 | bt_private_notification_iterator_from_notification_iterator( | |
103 | struct bt_notification_iterator *notification_iterator) | |
104 | { | |
105 | return (void *) notification_iterator; | |
106 | } | |
107 | ||
47e5a032 JG |
108 | /** |
109 | * Allocate a notification iterator. | |
110 | * | |
111 | * @param component Component instance | |
112 | * @returns A notification iterator instance | |
113 | */ | |
114 | BT_HIDDEN | |
115 | struct bt_notification_iterator *bt_notification_iterator_create( | |
3230ee6b | 116 | struct bt_component *upstream_component, |
fa054faf PP |
117 | struct bt_port *upstream_port, |
118 | const enum bt_notification_type *notification_types); | |
47e5a032 JG |
119 | |
120 | /** | |
121 | * Validate a notification iterator. | |
122 | * | |
123 | * @param iterator Notification iterator instance | |
124 | * @returns One of #bt_component_status values | |
125 | */ | |
126 | BT_HIDDEN | |
127 | enum bt_notification_iterator_status bt_notification_iterator_validate( | |
128 | struct bt_notification_iterator *iterator); | |
129 | ||
33b34c43 | 130 | #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */ |