1 #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
2 #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 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/graph/graph.h>
28 #include <babeltrace/graph/connection-internal.h>
29 #include <babeltrace/graph/message-const.h>
30 #include <babeltrace/graph/component-internal.h>
31 #include <babeltrace/graph/component-sink-internal.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/object-internal.h>
34 #include <babeltrace/object-pool-internal.h>
35 #include <babeltrace/assert-internal.h>
42 enum bt_graph_configuration_state
{
43 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
44 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
,
45 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
,
50 * A component graph contains components and point-to-point connection
51 * between these components.
53 * In terms of ownership:
54 * 1) The graph is the components' parent,
55 * 2) The graph is the connnections' parent,
56 * 3) Components share the ownership of their connections,
57 * 4) A connection holds weak references to its two component endpoints.
59 struct bt_object base
;
61 /* Array of pointers to bt_connection. */
62 GPtrArray
*connections
;
63 /* Array of pointers to bt_component. */
64 GPtrArray
*components
;
65 /* Queue of pointers (weak references) to sink bt_components. */
66 GQueue
*sinks_to_consume
;
69 bool in_remove_listener
;
73 * If this is false, then the public API's consuming
74 * functions (bt_graph_consume() and bt_graph_run()) return
75 * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
76 * functions always work.
78 * In bt_port_output_message_iterator_create(), on success,
79 * this flag is cleared so that the iterator remains the only
80 * consumer for the graph's lifetime.
84 enum bt_graph_configuration_state config_state
;
87 GArray
*source_output_port_added
;
88 GArray
*filter_output_port_added
;
89 GArray
*filter_input_port_added
;
90 GArray
*sink_input_port_added
;
91 GArray
*source_filter_ports_connected
;
92 GArray
*source_sink_ports_connected
;
93 GArray
*filter_filter_ports_connected
;
94 GArray
*filter_sink_ports_connected
;
97 /* Pool of `struct bt_message_event *` */
98 struct bt_object_pool event_msg_pool
;
100 /* Pool of `struct bt_message_packet_beginning *` */
101 struct bt_object_pool packet_begin_msg_pool
;
103 /* Pool of `struct bt_message_packet_end *` */
104 struct bt_object_pool packet_end_msg_pool
;
107 * Array of `struct bt_message *` (weak).
109 * This is an array of all the messages ever created from
110 * this graph. Some of them can be in one of the pools above,
111 * some of them can be at large. Because each message has a
112 * weak pointer to the graph containing its pool, we need to
113 * notify each message that the graph is gone on graph
116 * TODO: When we support a maximum size for object pools,
117 * add a way for a message to remove itself from this
118 * array (on destruction).
124 void _bt_graph_set_can_consume(struct bt_graph
*graph
, bool can_consume
)
127 graph
->can_consume
= can_consume
;
131 # define bt_graph_set_can_consume _bt_graph_set_can_consume
133 # define bt_graph_set_can_consume(_graph, _can_consume)
137 enum bt_graph_status
bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
138 struct bt_component_sink
*sink
);
141 void bt_graph_notify_port_added(struct bt_graph
*graph
, struct bt_port
*port
);
144 void bt_graph_notify_ports_connected(struct bt_graph
*graph
,
145 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
);
148 void bt_graph_remove_connection(struct bt_graph
*graph
,
149 struct bt_connection
*connection
);
152 * This only works with a component which is not connected at this
155 * Also the reference count of `component` should be 0 when you call
156 * this function, which means only `graph` owns the component, so it
157 * is safe to destroy.
160 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
161 struct bt_component
*component
);
164 void bt_graph_add_message(struct bt_graph
*graph
,
165 struct bt_message
*msg
);
168 const char *bt_graph_status_string(enum bt_graph_status status
)
171 case BT_GRAPH_STATUS_CANCELED
:
172 return "BT_GRAPH_STATUS_CANCELED";
173 case BT_GRAPH_STATUS_AGAIN
:
174 return "BT_GRAPH_STATUS_AGAIN";
175 case BT_GRAPH_STATUS_END
:
176 return "BT_GRAPH_STATUS_END";
177 case BT_GRAPH_STATUS_OK
:
178 return "BT_GRAPH_STATUS_OK";
179 case BT_GRAPH_STATUS_NO_SINK
:
180 return "BT_GRAPH_STATUS_NO_SINK";
181 case BT_GRAPH_STATUS_ERROR
:
182 return "BT_GRAPH_STATUS_ERROR";
183 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
184 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
185 case BT_GRAPH_STATUS_NOMEM
:
186 return "BT_GRAPH_STATUS_NOMEM";
193 const char *bt_graph_configuration_state_string(
194 enum bt_graph_configuration_state state
)
197 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
:
198 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
199 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
:
200 return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
201 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
:
202 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
209 enum bt_graph_status
bt_graph_configure(struct bt_graph
*graph
)
211 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
214 if (likely(graph
->config_state
==
215 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
)) {
219 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
;
221 for (i
= 0; i
< graph
->components
->len
; i
++) {
222 struct bt_component
*comp
= graph
->components
->pdata
[i
];
223 struct bt_component_sink
*comp_sink
= (void *) comp
;
224 struct bt_component_class_sink
*comp_cls_sink
=
225 (void *) comp
->class;
227 if (comp
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
231 if (comp_sink
->graph_is_configured_method_called
) {
235 if (comp_cls_sink
->methods
.graph_is_configured
) {
236 enum bt_self_component_status comp_status
;
239 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
240 "%![graph-]+g, %![comp-]+c",
244 comp_status
= comp_cls_sink
->methods
.graph_is_configured(
248 BT_LIB_LOGD("User method returned: status=%s",
249 bt_self_component_status_string(comp_status
));
253 BT_ASSERT_PRE(comp_status
== BT_SELF_COMPONENT_STATUS_OK
||
254 comp_status
== BT_SELF_COMPONENT_STATUS_ERROR
||
255 comp_status
== BT_SELF_COMPONENT_STATUS_NOMEM
,
256 "Unexpected returned status: status=%s",
257 bt_self_component_status_string(comp_status
));
260 if (comp_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
262 BT_LIB_LOGW("User's \"graph is configured\" method failed: "
263 "%![comp-]+c, status=%s",
265 bt_self_component_status_string(
273 comp_sink
->graph_is_configured_method_called
= true;
276 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
;
282 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */