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 /* Protection: this file uses BT_LIB_LOG*() macros directly */
28 #ifndef BT_LIB_LOG_SUPPORTED
29 # error Please include "lib/logging.h" before including this file.
32 #include <babeltrace2/graph/graph.h>
33 #include <babeltrace2/graph/message-const.h>
34 #include "common/macros.h"
35 #include "lib/object.h"
36 #include "lib/object-pool.h"
37 #include "common/assert.h"
38 #include "common/common.h"
42 #include "component.h"
43 #include "component-sink.h"
44 #include "connection.h"
45 #include "lib/func-status.h"
47 /* Protection: this file uses BT_LIB_LOG*() macros directly */
48 #ifndef BT_LIB_LOG_SUPPORTED
49 # error Please include "lib/logging.h" before including this file.
52 /* Protection: this file uses BT_ASSERT_PRE*() macros directly */
53 #ifndef BT_ASSERT_PRE_SUPPORTED
54 # error Please include "lib/assert-pre.h" before including this file.
57 /* Protection: this file uses BT_ASSERT_POST*() macros directly */
58 #ifndef BT_ASSERT_POST_SUPPORTED
59 # error Please include "lib/assert-post.h" before including this file.
65 enum bt_graph_configuration_state
{
66 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
67 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
,
68 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
,
69 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
74 * A component graph contains components and point-to-point connection
75 * between these components.
77 * In terms of ownership:
78 * 1) The graph is the components' parent,
79 * 2) The graph is the connnections' parent,
80 * 3) Components share the ownership of their connections,
81 * 4) A connection holds weak references to its two component endpoints.
83 struct bt_object base
;
85 /* Array of pointers to bt_connection. */
86 GPtrArray
*connections
;
87 /* Array of pointers to bt_component. */
88 GPtrArray
*components
;
89 /* Queue of pointers (weak references) to sink bt_components. */
90 GQueue
*sinks_to_consume
;
93 bool in_remove_listener
;
97 * If this is false, then the public API's consuming
98 * functions (bt_graph_consume() and bt_graph_run()) return
99 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
100 * functions always work.
102 * In bt_port_output_message_iterator_create(), on success,
103 * this flag is cleared so that the iterator remains the only
104 * consumer for the graph's lifetime.
108 enum bt_graph_configuration_state config_state
;
111 GArray
*source_output_port_added
;
112 GArray
*filter_output_port_added
;
113 GArray
*filter_input_port_added
;
114 GArray
*sink_input_port_added
;
115 GArray
*source_filter_ports_connected
;
116 GArray
*source_sink_ports_connected
;
117 GArray
*filter_filter_ports_connected
;
118 GArray
*filter_sink_ports_connected
;
121 /* Pool of `struct bt_message_event *` */
122 struct bt_object_pool event_msg_pool
;
124 /* Pool of `struct bt_message_packet_beginning *` */
125 struct bt_object_pool packet_begin_msg_pool
;
127 /* Pool of `struct bt_message_packet_end *` */
128 struct bt_object_pool packet_end_msg_pool
;
131 * Array of `struct bt_message *` (weak).
133 * This is an array of all the messages ever created from
134 * this graph. Some of them can be in one of the pools above,
135 * some of them can be at large. Because each message has a
136 * weak pointer to the graph containing its pool, we need to
137 * notify each message that the graph is gone on graph
140 * TODO: When we support a maximum size for object pools,
141 * add a way for a message to remove itself from this
142 * array (on destruction).
148 void bt_graph_set_can_consume(struct bt_graph
*graph
, bool can_consume
)
151 graph
->can_consume
= can_consume
;
155 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
156 struct bt_component_sink
*sink
);
159 enum bt_graph_listener_func_status
bt_graph_notify_port_added(struct bt_graph
*graph
,
160 struct bt_port
*port
);
163 enum bt_graph_listener_func_status
bt_graph_notify_ports_connected(
164 struct bt_graph
*graph
, struct bt_port
*upstream_port
,
165 struct bt_port
*downstream_port
);
168 void bt_graph_remove_connection(struct bt_graph
*graph
,
169 struct bt_connection
*connection
);
172 * This only works with a component which is not connected at this
175 * Also the reference count of `component` should be 0 when you call
176 * this function, which means only `graph` owns the component, so it
177 * is safe to destroy.
180 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
181 struct bt_component
*component
);
184 void bt_graph_add_message(struct bt_graph
*graph
,
185 struct bt_message
*msg
);
188 const char *bt_graph_configuration_state_string(
189 enum bt_graph_configuration_state state
)
192 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
:
193 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
194 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
:
195 return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
196 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
:
197 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
204 int bt_graph_configure(struct bt_graph
*graph
)
206 int status
= BT_FUNC_STATUS_OK
;
209 BT_ASSERT(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
);
211 if (G_LIKELY(graph
->config_state
==
212 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
)) {
216 BT_ASSERT_PRE(graph
->has_sink
, "Graph has no sink component: %!+g", graph
);
217 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
;
219 for (i
= 0; i
< graph
->components
->len
; i
++) {
220 struct bt_component
*comp
= graph
->components
->pdata
[i
];
221 struct bt_component_sink
*comp_sink
= (void *) comp
;
222 struct bt_component_class_sink
*comp_cls_sink
=
223 (void *) comp
->class;
225 if (comp
->class->type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
229 if (comp_sink
->graph_is_configured_method_called
) {
233 if (comp_cls_sink
->methods
.graph_is_configured
) {
234 enum bt_component_class_sink_graph_is_configured_method_status comp_status
;
236 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
237 "%![graph-]+g, %![comp-]+c",
239 comp_status
= comp_cls_sink
->methods
.graph_is_configured(
241 BT_LIB_LOGD("User method returned: status=%s",
242 bt_common_func_status_string(comp_status
));
243 BT_ASSERT_POST(comp_status
== BT_FUNC_STATUS_OK
||
244 comp_status
== BT_FUNC_STATUS_ERROR
||
245 comp_status
== BT_FUNC_STATUS_MEMORY_ERROR
,
246 "Unexpected returned status: status=%s",
247 bt_common_func_status_string(comp_status
));
248 if (comp_status
!= BT_FUNC_STATUS_OK
) {
249 comp_status
= BT_FUNC_STATUS_ERROR
;
250 if (comp_status
< 0) {
251 BT_LIB_LOGW_APPEND_CAUSE(
252 "Component's \"graph is configured\" method failed: "
253 "%![comp-]+c, status=%s",
255 bt_common_func_status_string(
259 status
= comp_status
;
264 comp_sink
->graph_is_configured_method_called
= true;
267 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
;
274 void bt_graph_make_faulty(struct bt_graph
*graph
)
276 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_FAULTY
;
277 BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph
);
280 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */