bt2: refactor test_message_iterator
[babeltrace.git] / src / lib / graph / message / iterator.h
CommitLineData
d6e69534
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
91d81473 27#include "common/macros.h"
578e048b 28#include "lib/object.h"
3fadfbc0
MJ
29#include <babeltrace2/graph/connection-const.h>
30#include <babeltrace2/graph/message-const.h>
3fadfbc0 31#include <babeltrace2/types.h>
578e048b 32#include "common/assert.h"
d6e69534 33#include <stdbool.h>
6162e6b7 34#include "common/uuid.h"
d6e69534
PP
35
36struct bt_port;
37struct bt_graph;
38
d6e69534 39enum bt_self_component_port_input_message_iterator_state {
7474e7d3 40 /* Iterator is not initialized */
d6e69534
PP
41 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED,
42
7474e7d3 43 /* Iterator is active, not at the end yet, and not finalized */
d6e69534
PP
44 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE,
45
46 /*
47 * Iterator is ended, not finalized yet: the "next" method
48 * returns BT_MESSAGE_ITERATOR_STATUS_END.
49 */
50 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED,
51
7474e7d3 52 /* Iterator is currently being finalized */
d0fea130 53 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING,
d6e69534 54
7474e7d3 55 /* Iterator is finalized */
d0fea130 56 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED,
7474e7d3
PP
57
58 /* Iterator is seeking */
59 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING,
60
61 /* Iterator did seek, but returned `BT_MESSAGE_ITERATOR_STATUS_AGAIN` */
62 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN,
63
64 /* Iterator did seek, but returned error status */
65 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR,
d6e69534
PP
66};
67
d24d5663 68typedef enum bt_component_class_message_iterator_next_method_status
7474e7d3
PP
69(*bt_self_component_port_input_message_iterator_next_method)(
70 void *, bt_message_array_const, uint64_t, uint64_t *);
71
d24d5663 72typedef enum bt_component_class_message_iterator_seek_ns_from_origin_method_status
7474e7d3
PP
73(*bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)(
74 void *, int64_t);
75
d24d5663 76typedef enum bt_component_class_message_iterator_seek_beginning_method_status
7474e7d3
PP
77(*bt_self_component_port_input_message_iterator_seek_beginning_method)(
78 void *);
79
80typedef bt_bool
81(*bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)(
82 void *, int64_t);
83
84typedef bt_bool
85(*bt_self_component_port_input_message_iterator_can_seek_beginning_method)(
86 void *);
87
d6e69534 88struct bt_self_component_port_input_message_iterator {
6c373cc9
PP
89 struct bt_object base;
90 GPtrArray *msgs;
d6e69534
PP
91 struct bt_component *upstream_component; /* Weak */
92 struct bt_port *upstream_port; /* Weak */
93 struct bt_connection *connection; /* Weak */
94 struct bt_graph *graph; /* Weak */
95
ca02df0a
PP
96 /*
97 * Array of
98 * `struct bt_self_component_port_input_message_iterator *`
99 * (weak).
100 *
101 * This is an array of upstream message iterators on which this
102 * iterator depends. The references are weak: an upstream
103 * message iterator is responsible for removing its entry within
104 * this array on finalization/destruction.
105 */
106 GPtrArray *upstream_msg_iters;
107
108 /*
109 * Downstream message iterator which depends on this message
110 * iterator (weak).
111 *
112 * This can be `NULL` if this message iterator's owner is a sink
113 * component.
114 */
115 struct bt_self_component_port_input_message_iterator *downstream_msg_iter;
116
7474e7d3
PP
117 struct {
118 bt_self_component_port_input_message_iterator_next_method next;
119 bt_self_component_port_input_message_iterator_seek_ns_from_origin_method seek_ns_from_origin;
120 bt_self_component_port_input_message_iterator_seek_beginning_method seek_beginning;
121 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method can_seek_ns_from_origin;
122 bt_self_component_port_input_message_iterator_can_seek_beginning_method can_seek_beginning;
123 } methods;
d6e69534
PP
124
125 enum bt_self_component_port_input_message_iterator_state state;
da9c4c52 126
54b135a0
SM
127 /*
128 * Timestamp of the last received message (or INT64_MIN in the
129 * beginning, or after a seek to beginning).
130 */
131 int64_t last_ns_from_origin;
132
133 struct {
134 enum {
135 /* We haven't recorded clock properties yet. */
136 CLOCK_EXPECTATION_UNSET,
137
138 /* Expect to have no clock. */
139 CLOCK_EXPECTATION_NONE,
140
141 /* Clock with origin_is_unix_epoch true.*/
142 CLOCK_EXPECTATION_ORIGIN_UNIX,
143
144 /* Clock with origin_is_unix_epoch false, with a UUID.*/
145 CLOCK_EXPECTATION_ORIGIN_OTHER_UUID,
146
147 /* Clock with origin_is_unix_epoch false, without a UUID.*/
148 CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID,
149 } type;
150
151 /*
152 * Expected UUID of the clock, if `type`is CLOCK_EXPECTATION_ORIGIN_OTHER_UUID.
153 *
154 * If the clock's origin is the unix epoch, the UUID is
155 * irrelevant (as the clock will be correlatable with other
156 * clocks having the same origin).
157 */
6162e6b7 158 bt_uuid_t uuid;
54b135a0
SM
159 } clock_expectation;
160
da9c4c52
SM
161 /*
162 * Data necessary for auto seek (the seek-to-beginning then fast-forward
163 * seek strategy).
164 */
165 struct {
166 /*
167 * Queue of `const bt_message *` (owned by this queue).
168 *
169 * When fast-forwarding, we get the messages from upstream in
170 * batches. Once we have found the first message with timestamp
171 * greater or equal to the seek time, we put it and all of the
172 * following message of the batch in this queue. They will be
173 * sent on the next "next" call on this iterator.
174 *
175 * The messages are in chronological order (i.e. the first to
176 * send is the first of the queue).
177 */
178 GQueue *msgs;
572075a8
SM
179
180 /*
181 * After auto-seeking, we replace the iterator's `next` callback
182 * with our own, which returns the contents of the `msgs` queue.
183 * This field is where we save the original callback, so we can
184 * restore it.
185 */
186 void *original_next_callback;
da9c4c52
SM
187 } auto_seek;
188
d6e69534
PP
189 void *user_data;
190};
191
d6e69534 192BT_HIDDEN
d0fea130 193void bt_self_component_port_input_message_iterator_try_finalize(
d6e69534
PP
194 struct bt_self_component_port_input_message_iterator *iterator);
195
196BT_HIDDEN
197void bt_self_component_port_input_message_iterator_set_connection(
198 struct bt_self_component_port_input_message_iterator *iterator,
199 struct bt_connection *connection);
200
d6e69534
PP
201static inline
202const char *bt_self_component_port_input_message_iterator_state_string(
203 enum bt_self_component_port_input_message_iterator_state state)
204{
205 switch (state) {
206 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE:
8a432889 207 return "ACTIVE";
d6e69534 208 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED:
8a432889 209 return "ENDED";
d0fea130 210 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING:
8a432889 211 return "FINALIZING";
d6e69534 212 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
8a432889 213 return "FINALIZED";
7474e7d3 214 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING:
8a432889 215 return "SEEKING";
7474e7d3 216 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN:
8a432889 217 return "LAST_SEEKING_RETURNED_AGAIN";
7474e7d3 218 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR:
8a432889 219 return "LAST_SEEKING_RETURNED_ERROR";
d6e69534
PP
220 default:
221 return "(unknown)";
222 }
223};
224
225#endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */
This page took 0.05657 seconds and 4 git commands to generate.