Commit | Line | Data |
---|---|---|
b09a5592 PP |
1 | #ifndef BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H |
2 | #define BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H | |
3 | ||
4 | /* | |
5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> | |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
85e7137b | 27 | #include "common/macros.h" |
57952005 | 28 | #include "lib/object.h" |
71c5da58 MJ |
29 | #include <babeltrace2/graph/connection-const.h> |
30 | #include <babeltrace2/graph/message-const.h> | |
71c5da58 | 31 | #include <babeltrace2/types.h> |
57952005 | 32 | #include "common/assert.h" |
b09a5592 | 33 | #include <stdbool.h> |
d126826c | 34 | #include "common/uuid.h" |
b09a5592 PP |
35 | |
36 | struct bt_port; | |
37 | struct bt_graph; | |
38 | ||
fbd8a4e0 | 39 | enum bt_message_iterator_state { |
15a52f66 | 40 | /* Iterator is not initialized */ |
fbd8a4e0 | 41 | BT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED, |
b09a5592 | 42 | |
15a52f66 | 43 | /* Iterator is active, not at the end yet, and not finalized */ |
fbd8a4e0 | 44 | BT_MESSAGE_ITERATOR_STATE_ACTIVE, |
b09a5592 PP |
45 | |
46 | /* | |
47 | * Iterator is ended, not finalized yet: the "next" method | |
48 | * returns BT_MESSAGE_ITERATOR_STATUS_END. | |
49 | */ | |
fbd8a4e0 | 50 | BT_MESSAGE_ITERATOR_STATE_ENDED, |
b09a5592 | 51 | |
15a52f66 | 52 | /* Iterator is currently being finalized */ |
fbd8a4e0 | 53 | BT_MESSAGE_ITERATOR_STATE_FINALIZING, |
b09a5592 | 54 | |
15a52f66 | 55 | /* Iterator is finalized */ |
fbd8a4e0 | 56 | BT_MESSAGE_ITERATOR_STATE_FINALIZED, |
15a52f66 PP |
57 | |
58 | /* Iterator is seeking */ | |
fbd8a4e0 | 59 | BT_MESSAGE_ITERATOR_STATE_SEEKING, |
15a52f66 PP |
60 | |
61 | /* Iterator did seek, but returned `BT_MESSAGE_ITERATOR_STATUS_AGAIN` */ | |
fbd8a4e0 | 62 | BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN, |
15a52f66 PP |
63 | |
64 | /* Iterator did seek, but returned error status */ | |
fbd8a4e0 | 65 | BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, |
b09a5592 PP |
66 | }; |
67 | ||
68e2deed | 68 | typedef enum bt_message_iterator_class_next_method_status |
fbd8a4e0 | 69 | (*bt_message_iterator_next_method)( |
15a52f66 PP |
70 | void *, bt_message_array_const, uint64_t, uint64_t *); |
71 | ||
68e2deed | 72 | typedef enum bt_message_iterator_class_seek_ns_from_origin_method_status |
fbd8a4e0 | 73 | (*bt_message_iterator_seek_ns_from_origin_method)( |
15a52f66 PP |
74 | void *, int64_t); |
75 | ||
68e2deed | 76 | typedef enum bt_message_iterator_class_seek_beginning_method_status |
fbd8a4e0 | 77 | (*bt_message_iterator_seek_beginning_method)( |
15a52f66 PP |
78 | void *); |
79 | ||
68e2deed | 80 | typedef enum bt_message_iterator_class_can_seek_ns_from_origin_method_status |
fbd8a4e0 | 81 | (*bt_message_iterator_can_seek_ns_from_origin_method)( |
9e8e8b43 | 82 | void *, int64_t, bt_bool *); |
15a52f66 | 83 | |
68e2deed | 84 | typedef enum bt_message_iterator_class_can_seek_beginning_method_status |
fbd8a4e0 | 85 | (*bt_message_iterator_can_seek_beginning_method)( |
9e8e8b43 | 86 | void *, bt_bool *); |
15a52f66 | 87 | |
9415de1c SM |
88 | struct bt_self_message_iterator_configuration { |
89 | bool frozen; | |
90 | bool can_seek_forward; | |
91 | }; | |
92 | ||
fbd8a4e0 | 93 | struct bt_message_iterator { |
fac7b25a PP |
94 | struct bt_object base; |
95 | GPtrArray *msgs; | |
b09a5592 PP |
96 | struct bt_component *upstream_component; /* Weak */ |
97 | struct bt_port *upstream_port; /* Weak */ | |
98 | struct bt_connection *connection; /* Weak */ | |
99 | struct bt_graph *graph; /* Weak */ | |
9415de1c | 100 | struct bt_self_message_iterator_configuration config; |
b09a5592 | 101 | |
692f1a01 PP |
102 | /* |
103 | * Array of | |
fbd8a4e0 | 104 | * `struct bt_message_iterator *` |
692f1a01 PP |
105 | * (weak). |
106 | * | |
107 | * This is an array of upstream message iterators on which this | |
108 | * iterator depends. The references are weak: an upstream | |
109 | * message iterator is responsible for removing its entry within | |
110 | * this array on finalization/destruction. | |
111 | */ | |
112 | GPtrArray *upstream_msg_iters; | |
113 | ||
114 | /* | |
115 | * Downstream message iterator which depends on this message | |
116 | * iterator (weak). | |
117 | * | |
118 | * This can be `NULL` if this message iterator's owner is a sink | |
119 | * component. | |
120 | */ | |
fbd8a4e0 | 121 | struct bt_message_iterator *downstream_msg_iter; |
692f1a01 | 122 | |
15a52f66 | 123 | struct { |
fbd8a4e0 | 124 | bt_message_iterator_next_method next; |
7f8e969d SM |
125 | |
126 | /* These two are always both set or both unset. */ | |
fbd8a4e0 PP |
127 | bt_message_iterator_seek_ns_from_origin_method seek_ns_from_origin; |
128 | bt_message_iterator_can_seek_ns_from_origin_method can_seek_ns_from_origin; | |
7f8e969d SM |
129 | |
130 | /* These two are always both set or both unset. */ | |
fbd8a4e0 PP |
131 | bt_message_iterator_seek_beginning_method seek_beginning; |
132 | bt_message_iterator_can_seek_beginning_method can_seek_beginning; | |
15a52f66 | 133 | } methods; |
b09a5592 | 134 | |
fbd8a4e0 | 135 | enum bt_message_iterator_state state; |
1b3630b6 | 136 | |
e253ad8d SM |
137 | /* |
138 | * Timestamp of the last received message (or INT64_MIN in the | |
139 | * beginning, or after a seek to beginning). | |
140 | */ | |
141 | int64_t last_ns_from_origin; | |
142 | ||
143 | struct { | |
144 | enum { | |
145 | /* We haven't recorded clock properties yet. */ | |
146 | CLOCK_EXPECTATION_UNSET, | |
147 | ||
148 | /* Expect to have no clock. */ | |
149 | CLOCK_EXPECTATION_NONE, | |
150 | ||
151 | /* Clock with origin_is_unix_epoch true.*/ | |
152 | CLOCK_EXPECTATION_ORIGIN_UNIX, | |
153 | ||
154 | /* Clock with origin_is_unix_epoch false, with a UUID.*/ | |
155 | CLOCK_EXPECTATION_ORIGIN_OTHER_UUID, | |
156 | ||
157 | /* Clock with origin_is_unix_epoch false, without a UUID.*/ | |
158 | CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID, | |
159 | } type; | |
160 | ||
161 | /* | |
162 | * Expected UUID of the clock, if `type`is CLOCK_EXPECTATION_ORIGIN_OTHER_UUID. | |
163 | * | |
164 | * If the clock's origin is the unix epoch, the UUID is | |
165 | * irrelevant (as the clock will be correlatable with other | |
166 | * clocks having the same origin). | |
167 | */ | |
d126826c | 168 | bt_uuid_t uuid; |
e253ad8d SM |
169 | } clock_expectation; |
170 | ||
1b3630b6 SM |
171 | /* |
172 | * Data necessary for auto seek (the seek-to-beginning then fast-forward | |
173 | * seek strategy). | |
174 | */ | |
175 | struct { | |
176 | /* | |
177 | * Queue of `const bt_message *` (owned by this queue). | |
178 | * | |
179 | * When fast-forwarding, we get the messages from upstream in | |
180 | * batches. Once we have found the first message with timestamp | |
181 | * greater or equal to the seek time, we put it and all of the | |
182 | * following message of the batch in this queue. They will be | |
183 | * sent on the next "next" call on this iterator. | |
184 | * | |
185 | * The messages are in chronological order (i.e. the first to | |
186 | * send is the first of the queue). | |
187 | */ | |
188 | GQueue *msgs; | |
1d801aab SM |
189 | |
190 | /* | |
191 | * After auto-seeking, we replace the iterator's `next` callback | |
192 | * with our own, which returns the contents of the `msgs` queue. | |
193 | * This field is where we save the original callback, so we can | |
194 | * restore it. | |
195 | */ | |
196 | void *original_next_callback; | |
1b3630b6 SM |
197 | } auto_seek; |
198 | ||
b09a5592 PP |
199 | void *user_data; |
200 | }; | |
201 | ||
b09a5592 | 202 | BT_HIDDEN |
fbd8a4e0 PP |
203 | void bt_message_iterator_try_finalize( |
204 | struct bt_message_iterator *iterator); | |
b09a5592 PP |
205 | |
206 | BT_HIDDEN | |
fbd8a4e0 PP |
207 | void bt_message_iterator_set_connection( |
208 | struct bt_message_iterator *iterator, | |
b09a5592 PP |
209 | struct bt_connection *connection); |
210 | ||
b09a5592 | 211 | static inline |
fbd8a4e0 PP |
212 | const char *bt_message_iterator_state_string( |
213 | enum bt_message_iterator_state state) | |
b09a5592 PP |
214 | { |
215 | switch (state) { | |
fbd8a4e0 | 216 | case BT_MESSAGE_ITERATOR_STATE_ACTIVE: |
e05f8464 | 217 | return "ACTIVE"; |
fbd8a4e0 | 218 | case BT_MESSAGE_ITERATOR_STATE_ENDED: |
e05f8464 | 219 | return "ENDED"; |
fbd8a4e0 | 220 | case BT_MESSAGE_ITERATOR_STATE_FINALIZING: |
e05f8464 | 221 | return "FINALIZING"; |
fbd8a4e0 | 222 | case BT_MESSAGE_ITERATOR_STATE_FINALIZED: |
e05f8464 | 223 | return "FINALIZED"; |
fbd8a4e0 | 224 | case BT_MESSAGE_ITERATOR_STATE_SEEKING: |
e05f8464 | 225 | return "SEEKING"; |
fbd8a4e0 | 226 | case BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN: |
e05f8464 | 227 | return "LAST_SEEKING_RETURNED_AGAIN"; |
fbd8a4e0 | 228 | case BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR: |
e05f8464 | 229 | return "LAST_SEEKING_RETURNED_ERROR"; |
b09a5592 PP |
230 | default: |
231 | return "(unknown)"; | |
232 | } | |
233 | }; | |
234 | ||
235 | #endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */ |