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"
43 #include "component.h"
44 #include "component-sink.h"
45 #include "connection.h"
46 #include "lib/func-status.h"
48 /* Protection: this file uses BT_LIB_LOG*() macros directly */
49 #ifndef BT_LIB_LOG_SUPPORTED
50 # error Please include "lib/logging.h" before including this file.
53 /* Protection: this file uses BT_ASSERT_PRE*() macros directly */
54 #ifndef BT_ASSERT_PRE_SUPPORTED
55 # error Please include "lib/assert-pre.h" before including this file.
58 /* Protection: this file uses BT_ASSERT_POST*() macros directly */
59 #ifndef BT_ASSERT_POST_SUPPORTED
60 # error Please include "lib/assert-post.h" before including this file.
66 enum bt_graph_configuration_state
{
67 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
68 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
,
69 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
,
70 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
71 BT_GRAPH_CONFIGURATION_STATE_DESTROYING
,
76 * A component graph contains components and point-to-point connection
77 * between these components.
79 * In terms of ownership:
80 * 1) The graph is the components' parent,
81 * 2) The graph is the connnections' parent,
82 * 3) Components share the ownership of their connections,
83 * 4) A connection holds weak references to its two component endpoints.
85 struct bt_object base
;
87 /* Array of pointers to bt_connection. */
88 GPtrArray
*connections
;
89 /* Array of pointers to bt_component. */
90 GPtrArray
*components
;
91 /* Queue of pointers (weak references) to sink bt_components. */
92 GQueue
*sinks_to_consume
;
97 * Array of `struct bt_interrupter *`, each one owned by this.
98 * If any interrupter is set, then this graph is deemed
101 GPtrArray
*interrupters
;
104 * Default interrupter to support bt_graph_interrupt(); owned
107 struct bt_interrupter
*default_interrupter
;
112 * If this is false, then the public API's consuming
113 * functions (bt_graph_consume() and bt_graph_run()) return
114 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
115 * functions always work.
117 * In bt_port_output_message_iterator_create(), on success,
118 * this flag is cleared so that the iterator remains the only
119 * consumer for the graph's lifetime.
123 enum bt_graph_configuration_state config_state
;
126 GArray
*source_output_port_added
;
127 GArray
*filter_output_port_added
;
128 GArray
*filter_input_port_added
;
129 GArray
*sink_input_port_added
;
132 /* Pool of `struct bt_message_event *` */
133 struct bt_object_pool event_msg_pool
;
135 /* Pool of `struct bt_message_packet_beginning *` */
136 struct bt_object_pool packet_begin_msg_pool
;
138 /* Pool of `struct bt_message_packet_end *` */
139 struct bt_object_pool packet_end_msg_pool
;
142 * Array of `struct bt_message *` (weak).
144 * This is an array of all the messages ever created from
145 * this graph. Some of them can be in one of the pools above,
146 * some of them can be at large. Because each message has a
147 * weak pointer to the graph containing its pool, we need to
148 * notify each message that the graph is gone on graph
151 * TODO: When we support a maximum size for object pools,
152 * add a way for a message to remove itself from this
153 * array (on destruction).
159 void bt_graph_set_can_consume(struct bt_graph
*graph
, bool can_consume
)
161 BT_ASSERT_DBG(graph
);
162 graph
->can_consume
= can_consume
;
166 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
167 struct bt_component_sink
*sink
);
170 enum bt_graph_listener_func_status
bt_graph_notify_port_added(struct bt_graph
*graph
,
171 struct bt_port
*port
);
174 void bt_graph_remove_connection(struct bt_graph
*graph
,
175 struct bt_connection
*connection
);
178 void bt_graph_add_message(struct bt_graph
*graph
,
179 struct bt_message
*msg
);
182 bool bt_graph_is_interrupted(const struct bt_graph
*graph
);
185 const char *bt_graph_configuration_state_string(
186 enum bt_graph_configuration_state state
)
189 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
:
190 return "CONFIGURING";
191 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
:
192 return "PARTIALLY_CONFIGURED";
193 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
:
195 case BT_GRAPH_CONFIGURATION_STATE_FAULTY
:
197 case BT_GRAPH_CONFIGURATION_STATE_DESTROYING
:
205 int bt_graph_configure(struct bt_graph
*graph
)
207 int status
= BT_FUNC_STATUS_OK
;
210 BT_ASSERT_DBG(graph
->config_state
!=
211 BT_GRAPH_CONFIGURATION_STATE_FAULTY
);
213 if (G_LIKELY(graph
->config_state
==
214 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
)) {
218 BT_ASSERT_PRE(graph
->has_sink
, "Graph has no sink component: %!+g", graph
);
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_component_class_sink_graph_is_configured_method_status comp_status
;
238 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
239 "%![graph-]+g, %![comp-]+c",
241 comp_status
= comp_cls_sink
->methods
.graph_is_configured(
243 BT_LIB_LOGD("User method returned: status=%s",
244 bt_common_func_status_string(comp_status
));
245 BT_ASSERT_POST(comp_status
== BT_FUNC_STATUS_OK
||
246 comp_status
== BT_FUNC_STATUS_ERROR
||
247 comp_status
== BT_FUNC_STATUS_MEMORY_ERROR
,
248 "Unexpected returned status: status=%s",
249 bt_common_func_status_string(comp_status
));
250 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(comp_status
);
251 if (comp_status
!= BT_FUNC_STATUS_OK
) {
252 if (comp_status
< 0) {
253 BT_LIB_LOGW_APPEND_CAUSE(
254 "Component's \"graph is configured\" method failed: "
255 "%![comp-]+c, status=%s",
257 bt_common_func_status_string(
261 status
= comp_status
;
266 comp_sink
->graph_is_configured_method_called
= true;
269 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
;
276 void bt_graph_make_faulty(struct bt_graph
*graph
)
278 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_FAULTY
;
279 BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph
);
282 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */