Fix: bt2: fix reference counting of messages returned by Python components
[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>
31#include <babeltrace2/graph/message-iterator-const.h>
32#include <babeltrace2/types.h>
578e048b 33#include "common/assert.h"
d6e69534
PP
34#include <stdbool.h>
35
36struct bt_port;
37struct bt_graph;
38
39enum bt_message_iterator_type {
40 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT,
41 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT,
42};
43
44enum bt_self_component_port_input_message_iterator_state {
7474e7d3 45 /* Iterator is not initialized */
d6e69534
PP
46 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED,
47
7474e7d3 48 /* Iterator is active, not at the end yet, and not finalized */
d6e69534
PP
49 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE,
50
51 /*
52 * Iterator is ended, not finalized yet: the "next" method
53 * returns BT_MESSAGE_ITERATOR_STATUS_END.
54 */
55 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED,
56
7474e7d3 57 /* Iterator is currently being finalized */
d0fea130 58 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING,
d6e69534 59
7474e7d3 60 /* Iterator is finalized */
d0fea130 61 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED,
7474e7d3
PP
62
63 /* Iterator is seeking */
64 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING,
65
66 /* Iterator did seek, but returned `BT_MESSAGE_ITERATOR_STATUS_AGAIN` */
67 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN,
68
69 /* Iterator did seek, but returned error status */
70 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR,
d6e69534
PP
71};
72
73struct bt_message_iterator {
74 struct bt_object base;
75 enum bt_message_iterator_type type;
76 GPtrArray *msgs;
77};
78
7474e7d3
PP
79typedef enum bt_self_message_iterator_status
80(*bt_self_component_port_input_message_iterator_next_method)(
81 void *, bt_message_array_const, uint64_t, uint64_t *);
82
83typedef enum bt_self_message_iterator_status
84(*bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)(
85 void *, int64_t);
86
87typedef enum bt_self_message_iterator_status
88(*bt_self_component_port_input_message_iterator_seek_beginning_method)(
89 void *);
90
91typedef bt_bool
92(*bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)(
93 void *, int64_t);
94
95typedef bt_bool
96(*bt_self_component_port_input_message_iterator_can_seek_beginning_method)(
97 void *);
98
d6e69534
PP
99struct bt_self_component_port_input_message_iterator {
100 struct bt_message_iterator base;
101 struct bt_component *upstream_component; /* Weak */
102 struct bt_port *upstream_port; /* Weak */
103 struct bt_connection *connection; /* Weak */
104 struct bt_graph *graph; /* Weak */
105
7474e7d3
PP
106 struct {
107 bt_self_component_port_input_message_iterator_next_method next;
108 bt_self_component_port_input_message_iterator_seek_ns_from_origin_method seek_ns_from_origin;
109 bt_self_component_port_input_message_iterator_seek_beginning_method seek_beginning;
110 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method can_seek_ns_from_origin;
111 bt_self_component_port_input_message_iterator_can_seek_beginning_method can_seek_beginning;
112 } methods;
d6e69534
PP
113
114 enum bt_self_component_port_input_message_iterator_state state;
da9c4c52
SM
115
116 /*
117 * Data necessary for auto seek (the seek-to-beginning then fast-forward
118 * seek strategy).
119 */
120 struct {
121 /*
122 * Queue of `const bt_message *` (owned by this queue).
123 *
124 * When fast-forwarding, we get the messages from upstream in
125 * batches. Once we have found the first message with timestamp
126 * greater or equal to the seek time, we put it and all of the
127 * following message of the batch in this queue. They will be
128 * sent on the next "next" call on this iterator.
129 *
130 * The messages are in chronological order (i.e. the first to
131 * send is the first of the queue).
132 */
133 GQueue *msgs;
572075a8
SM
134
135 /*
136 * After auto-seeking, we replace the iterator's `next` callback
137 * with our own, which returns the contents of the `msgs` queue.
138 * This field is where we save the original callback, so we can
139 * restore it.
140 */
141 void *original_next_callback;
da9c4c52
SM
142 } auto_seek;
143
d6e69534
PP
144 void *user_data;
145};
146
147struct bt_port_output_message_iterator {
148 struct bt_message_iterator base;
149 struct bt_graph *graph; /* Owned by this */
150 struct bt_component_sink *colander; /* Owned by this */
151
152 /*
153 * Only used temporarily as a bridge between a colander sink and
154 * the user.
155 */
156 uint64_t count;
157};
158
159BT_HIDDEN
d0fea130 160void bt_self_component_port_input_message_iterator_try_finalize(
d6e69534
PP
161 struct bt_self_component_port_input_message_iterator *iterator);
162
163BT_HIDDEN
164void bt_self_component_port_input_message_iterator_set_connection(
165 struct bt_self_component_port_input_message_iterator *iterator,
166 struct bt_connection *connection);
167
d6e69534
PP
168static inline
169const char *bt_self_component_port_input_message_iterator_state_string(
170 enum bt_self_component_port_input_message_iterator_state state)
171{
172 switch (state) {
173 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE:
174 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE";
175 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED:
176 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED";
d0fea130
PP
177 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING:
178 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING";
d6e69534
PP
179 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
180 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED";
7474e7d3
PP
181 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING:
182 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING";
183 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN:
184 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN";
185 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR:
186 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR";
d6e69534
PP
187 default:
188 return "(unknown)";
189 }
190};
191
192#endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */
This page took 0.047237 seconds and 4 git commands to generate.