1 #ifndef BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H
2 #define BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 #include "common/macros.h"
28 #include "lib/object.h"
29 #include <babeltrace2/graph/connection-const.h>
30 #include <babeltrace2/graph/message-const.h>
31 #include <babeltrace2/types.h>
32 #include "common/assert.h"
34 #include "common/uuid.h"
39 enum bt_self_component_port_input_message_iterator_state
{
40 /* Iterator is not initialized */
41 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
,
43 /* Iterator is active, not at the end yet, and not finalized */
44 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
47 * Iterator is ended, not finalized yet: the "next" method
48 * returns BT_MESSAGE_ITERATOR_STATUS_END.
50 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
,
52 /* Iterator is currently being finalized */
53 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
,
55 /* Iterator is finalized */
56 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
,
58 /* Iterator is seeking */
59 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
,
61 /* Iterator did seek, but returned `BT_MESSAGE_ITERATOR_STATUS_AGAIN` */
62 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
,
64 /* Iterator did seek, but returned error status */
65 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
,
68 typedef enum bt_message_iterator_class_next_method_status
69 (*bt_self_component_port_input_message_iterator_next_method
)(
70 void *, bt_message_array_const
, uint64_t, uint64_t *);
72 typedef enum bt_message_iterator_class_seek_ns_from_origin_method_status
73 (*bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)(
76 typedef enum bt_message_iterator_class_seek_beginning_method_status
77 (*bt_self_component_port_input_message_iterator_seek_beginning_method
)(
80 typedef enum bt_message_iterator_class_can_seek_ns_from_origin_method_status
81 (*bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)(
82 void *, int64_t, bt_bool
*);
84 typedef enum bt_message_iterator_class_can_seek_beginning_method_status
85 (*bt_self_component_port_input_message_iterator_can_seek_beginning_method
)(
88 struct bt_self_message_iterator_configuration
{
90 bool can_seek_forward
;
93 struct bt_self_component_port_input_message_iterator
{
94 struct bt_object base
;
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 */
100 struct bt_self_message_iterator_configuration config
;
104 * `struct bt_self_component_port_input_message_iterator *`
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.
112 GPtrArray
*upstream_msg_iters
;
115 * Downstream message iterator which depends on this message
118 * This can be `NULL` if this message iterator's owner is a sink
121 struct bt_self_component_port_input_message_iterator
*downstream_msg_iter
;
124 bt_self_component_port_input_message_iterator_next_method next
;
126 /* These two are always both set or both unset. */
127 bt_self_component_port_input_message_iterator_seek_ns_from_origin_method seek_ns_from_origin
;
128 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method can_seek_ns_from_origin
;
130 /* These two are always both set or both unset. */
131 bt_self_component_port_input_message_iterator_seek_beginning_method seek_beginning
;
132 bt_self_component_port_input_message_iterator_can_seek_beginning_method can_seek_beginning
;
135 enum bt_self_component_port_input_message_iterator_state state
;
138 * Timestamp of the last received message (or INT64_MIN in the
139 * beginning, or after a seek to beginning).
141 int64_t last_ns_from_origin
;
145 /* We haven't recorded clock properties yet. */
146 CLOCK_EXPECTATION_UNSET
,
148 /* Expect to have no clock. */
149 CLOCK_EXPECTATION_NONE
,
151 /* Clock with origin_is_unix_epoch true.*/
152 CLOCK_EXPECTATION_ORIGIN_UNIX
,
154 /* Clock with origin_is_unix_epoch false, with a UUID.*/
155 CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
,
157 /* Clock with origin_is_unix_epoch false, without a UUID.*/
158 CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
,
162 * Expected UUID of the clock, if `type`is CLOCK_EXPECTATION_ORIGIN_OTHER_UUID.
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).
172 * Data necessary for auto seek (the seek-to-beginning then fast-forward
177 * Queue of `const bt_message *` (owned by this queue).
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.
185 * The messages are in chronological order (i.e. the first to
186 * send is the first of the queue).
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
196 void *original_next_callback
;
203 void bt_self_component_port_input_message_iterator_try_finalize(
204 struct bt_self_component_port_input_message_iterator
*iterator
);
207 void bt_self_component_port_input_message_iterator_set_connection(
208 struct bt_self_component_port_input_message_iterator
*iterator
,
209 struct bt_connection
*connection
);
212 const char *bt_self_component_port_input_message_iterator_state_string(
213 enum bt_self_component_port_input_message_iterator_state state
)
216 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
:
218 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
:
220 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
:
222 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
:
224 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
:
226 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
:
227 return "LAST_SEEKING_RETURNED_AGAIN";
228 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
:
229 return "LAST_SEEKING_RETURNED_ERROR";
235 #endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */