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 <babeltrace/babeltrace-internal.h>
28 #include <babeltrace/object-internal.h>
29 #include <babeltrace/graph/connection-const.h>
30 #include <babeltrace/graph/message-const.h>
31 #include <babeltrace/graph/message-iterator.h>
32 #include <babeltrace/types.h>
33 #include <babeltrace/assert-internal.h>
39 enum bt_message_iterator_type
{
40 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
,
41 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
,
44 enum bt_self_component_port_input_message_iterator_state
{
45 /* Iterator is not initialized. */
46 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
,
48 /* Iterator is active, not at the end yet, and not finalized. */
49 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
52 * Iterator is ended, not finalized yet: the "next" method
53 * returns BT_MESSAGE_ITERATOR_STATUS_END.
55 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
,
58 * Iterator is currently being finalized.
60 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
,
63 * Iterator is finalized.
65 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
,
68 struct bt_message_iterator
{
69 struct bt_object base
;
70 enum bt_message_iterator_type type
;
74 struct bt_self_component_port_input_message_iterator
{
75 struct bt_message_iterator base
;
76 struct bt_component
*upstream_component
; /* Weak */
77 struct bt_port
*upstream_port
; /* Weak */
78 struct bt_connection
*connection
; /* Weak */
79 struct bt_graph
*graph
; /* Weak */
82 * This hash table keeps the state of a stream as viewed by this
83 * message iterator. This is used, in developer mode, to make
84 * sure that, once the message iterator has seen a "stream end"
85 * message for a given stream, no other messages which refer to
86 * this stream can be delivered by this iterator. It is also
87 * used to check for a valid sequence of messages.
89 * The key (struct bt_stream *) is not owned by this. The value
90 * is an allocated state structure.
92 GHashTable
*stream_states
;
94 enum bt_self_component_port_input_message_iterator_state state
;
98 struct bt_port_output_message_iterator
{
99 struct bt_message_iterator base
;
100 struct bt_graph
*graph
; /* Owned by this */
101 struct bt_component_sink
*colander
; /* Owned by this */
104 * Only used temporarily as a bridge between a colander sink and
111 void bt_self_component_port_input_message_iterator_try_finalize(
112 struct bt_self_component_port_input_message_iterator
*iterator
);
115 void bt_self_component_port_input_message_iterator_set_connection(
116 struct bt_self_component_port_input_message_iterator
*iterator
,
117 struct bt_connection
*connection
);
120 const char *bt_message_iterator_status_string(
121 enum bt_message_iterator_status status
)
124 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
125 return "BT_MESSAGE_ITERATOR_STATUS_AGAIN";
126 case BT_MESSAGE_ITERATOR_STATUS_END
:
127 return "BT_MESSAGE_ITERATOR_STATUS_END";
128 case BT_MESSAGE_ITERATOR_STATUS_OK
:
129 return "BT_MESSAGE_ITERATOR_STATUS_OK";
130 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
131 return "BT_MESSAGE_ITERATOR_STATUS_ERROR";
132 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
133 return "BT_MESSAGE_ITERATOR_STATUS_NOMEM";
140 const char *bt_self_component_port_input_message_iterator_state_string(
141 enum bt_self_component_port_input_message_iterator_state state
)
144 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
:
145 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE";
146 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
:
147 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED";
148 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
:
149 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING";
150 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
:
151 return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED";
157 #endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */