Commit | Line | Data |
---|---|---|
c0418dd9 | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
f60c8b34 | 5 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
c0418dd9 JG |
6 | */ |
7 | ||
0235b0db MJ |
8 | #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H |
9 | #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H | |
10 | ||
870631a2 PP |
11 | /* Protection: this file uses BT_LIB_LOG*() macros directly */ |
12 | #ifndef BT_LIB_LOG_SUPPORTED | |
13 | # error Please include "lib/logging.h" before including this file. | |
14 | #endif | |
15 | ||
3fadfbc0 | 16 | #include <babeltrace2/graph/graph.h> |
43c59509 | 17 | #include <babeltrace2/graph/message.h> |
91d81473 | 18 | #include "common/macros.h" |
578e048b MJ |
19 | #include "lib/object.h" |
20 | #include "lib/object-pool.h" | |
21 | #include "common/assert.h" | |
de625d1c | 22 | #include "common/common.h" |
c4f23e30 | 23 | #include <stdbool.h> |
a256a42d | 24 | #include <stdlib.h> |
c0418dd9 JG |
25 | #include <glib.h> |
26 | ||
578e048b MJ |
27 | #include "component.h" |
28 | #include "component-sink.h" | |
29 | #include "connection.h" | |
d24d5663 | 30 | #include "lib/func-status.h" |
578e048b | 31 | |
51375aa9 PP |
32 | /* Protection: this file uses BT_LIB_LOG*() macros directly */ |
33 | #ifndef BT_LIB_LOG_SUPPORTED | |
34 | # error Please include "lib/logging.h" before including this file. | |
35 | #endif | |
36 | ||
d98421f2 PP |
37 | /* |
38 | * Protection: this file uses precondition and postcondition assertion | |
39 | * macros directly. | |
40 | */ | |
41 | #ifndef BT_ASSERT_COND_SUPPORTED | |
42 | # error Please include "lib/assert-cond.h" before including this file. | |
51375aa9 PP |
43 | #endif |
44 | ||
1bf957a0 PP |
45 | struct bt_component; |
46 | struct bt_port; | |
47 | ||
5badd463 PP |
48 | enum bt_graph_configuration_state { |
49 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, | |
50 | BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED, | |
51 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURED, | |
38cda5da | 52 | BT_GRAPH_CONFIGURATION_STATE_FAULTY, |
9b4f9b42 | 53 | BT_GRAPH_CONFIGURATION_STATE_DESTROYING, |
5badd463 PP |
54 | }; |
55 | ||
f60c8b34 JG |
56 | struct bt_graph { |
57 | /** | |
58 | * A component graph contains components and point-to-point connection | |
59 | * between these components. | |
c0418dd9 | 60 | * |
f60c8b34 JG |
61 | * In terms of ownership: |
62 | * 1) The graph is the components' parent, | |
63 | * 2) The graph is the connnections' parent, | |
64 | * 3) Components share the ownership of their connections, | |
65 | * 4) A connection holds weak references to its two component endpoints. | |
c0418dd9 | 66 | */ |
f60c8b34 JG |
67 | struct bt_object base; |
68 | ||
69 | /* Array of pointers to bt_connection. */ | |
70 | GPtrArray *connections; | |
71 | /* Array of pointers to bt_component. */ | |
72 | GPtrArray *components; | |
73 | /* Queue of pointers (weak references) to sink bt_components. */ | |
74 | GQueue *sinks_to_consume; | |
1bf957a0 | 75 | |
056deb59 PP |
76 | uint64_t mip_version; |
77 | ||
9b4f9b42 PP |
78 | /* |
79 | * Array of `struct bt_interrupter *`, each one owned by this. | |
80 | * If any interrupter is set, then this graph is deemed | |
81 | * interrupted. | |
82 | */ | |
83 | GPtrArray *interrupters; | |
84 | ||
85 | /* | |
c513d240 | 86 | * Default interrupter, owned by this. |
9b4f9b42 PP |
87 | */ |
88 | struct bt_interrupter *default_interrupter; | |
89 | ||
d94d92ac | 90 | bool has_sink; |
8ed535b5 PP |
91 | |
92 | /* | |
d94d92ac | 93 | * If this is false, then the public API's consuming |
8ed535b5 | 94 | * functions (bt_graph_consume() and bt_graph_run()) return |
d24d5663 | 95 | * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check" |
8ed535b5 PP |
96 | * functions always work. |
97 | * | |
d6e69534 | 98 | * In bt_port_output_message_iterator_create(), on success, |
8ed535b5 PP |
99 | * this flag is cleared so that the iterator remains the only |
100 | * consumer for the graph's lifetime. | |
101 | */ | |
d94d92ac | 102 | bool can_consume; |
202a3a13 | 103 | |
5badd463 | 104 | enum bt_graph_configuration_state config_state; |
4725a201 | 105 | |
1bf957a0 | 106 | struct { |
d94d92ac PP |
107 | GArray *source_output_port_added; |
108 | GArray *filter_output_port_added; | |
109 | GArray *filter_input_port_added; | |
110 | GArray *sink_input_port_added; | |
1bf957a0 | 111 | } listeners; |
5c563278 | 112 | |
d6e69534 PP |
113 | /* Pool of `struct bt_message_event *` */ |
114 | struct bt_object_pool event_msg_pool; | |
5c563278 | 115 | |
d6e69534 PP |
116 | /* Pool of `struct bt_message_packet_beginning *` */ |
117 | struct bt_object_pool packet_begin_msg_pool; | |
5c563278 | 118 | |
d6e69534 PP |
119 | /* Pool of `struct bt_message_packet_end *` */ |
120 | struct bt_object_pool packet_end_msg_pool; | |
5c563278 PP |
121 | |
122 | /* | |
d6e69534 | 123 | * Array of `struct bt_message *` (weak). |
5c563278 | 124 | * |
d6e69534 | 125 | * This is an array of all the messages ever created from |
5c563278 | 126 | * this graph. Some of them can be in one of the pools above, |
d6e69534 | 127 | * some of them can be at large. Because each message has a |
5c563278 | 128 | * weak pointer to the graph containing its pool, we need to |
d6e69534 | 129 | * notify each message that the graph is gone on graph |
5c563278 PP |
130 | * destruction. |
131 | * | |
132 | * TODO: When we support a maximum size for object pools, | |
d6e69534 | 133 | * add a way for a message to remove itself from this |
5c563278 PP |
134 | * array (on destruction). |
135 | */ | |
d6e69534 | 136 | GPtrArray *messages; |
c0418dd9 JG |
137 | }; |
138 | ||
8ed535b5 | 139 | static inline |
bdb288b3 | 140 | void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume) |
8ed535b5 | 141 | { |
98b15851 | 142 | BT_ASSERT_DBG(graph); |
8ed535b5 PP |
143 | graph->can_consume = can_consume; |
144 | } | |
145 | ||
8ed535b5 | 146 | BT_HIDDEN |
d24d5663 | 147 | int bt_graph_consume_sink_no_check(struct bt_graph *graph, |
d94d92ac | 148 | struct bt_component_sink *sink); |
8ed535b5 | 149 | |
1bf957a0 | 150 | BT_HIDDEN |
d24d5663 | 151 | enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph, |
8cc56726 | 152 | struct bt_port *port); |
1bf957a0 | 153 | |
f167d3c0 PP |
154 | BT_HIDDEN |
155 | void bt_graph_remove_connection(struct bt_graph *graph, | |
156 | struct bt_connection *connection); | |
157 | ||
5c563278 | 158 | BT_HIDDEN |
d6e69534 PP |
159 | void bt_graph_add_message(struct bt_graph *graph, |
160 | struct bt_message *msg); | |
5c563278 | 161 | |
9b4f9b42 PP |
162 | BT_HIDDEN |
163 | bool bt_graph_is_interrupted(const struct bt_graph *graph); | |
164 | ||
5badd463 PP |
165 | static inline |
166 | const char *bt_graph_configuration_state_string( | |
167 | enum bt_graph_configuration_state state) | |
168 | { | |
169 | switch (state) { | |
170 | case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING: | |
8a432889 | 171 | return "CONFIGURING"; |
5badd463 | 172 | case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED: |
8a432889 | 173 | return "PARTIALLY_CONFIGURED"; |
5badd463 | 174 | case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED: |
8a432889 PP |
175 | return "CONFIGURED"; |
176 | case BT_GRAPH_CONFIGURATION_STATE_FAULTY: | |
177 | return "FAULTY"; | |
178 | case BT_GRAPH_CONFIGURATION_STATE_DESTROYING: | |
179 | return "DESTROYING"; | |
5badd463 PP |
180 | default: |
181 | return "(unknown)"; | |
182 | } | |
183 | } | |
184 | ||
185 | static inline | |
d24d5663 | 186 | int bt_graph_configure(struct bt_graph *graph) |
5badd463 | 187 | { |
d24d5663 | 188 | int status = BT_FUNC_STATUS_OK; |
5badd463 PP |
189 | uint64_t i; |
190 | ||
98b15851 PP |
191 | BT_ASSERT_DBG(graph->config_state != |
192 | BT_GRAPH_CONFIGURATION_STATE_FAULTY); | |
38cda5da | 193 | |
91d81473 | 194 | if (G_LIKELY(graph->config_state == |
5badd463 PP |
195 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) { |
196 | goto end; | |
197 | } | |
198 | ||
cd6128ca | 199 | BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph); |
5badd463 PP |
200 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED; |
201 | ||
202 | for (i = 0; i < graph->components->len; i++) { | |
203 | struct bt_component *comp = graph->components->pdata[i]; | |
204 | struct bt_component_sink *comp_sink = (void *) comp; | |
205 | struct bt_component_class_sink *comp_cls_sink = | |
206 | (void *) comp->class; | |
207 | ||
208 | if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) { | |
209 | continue; | |
210 | } | |
211 | ||
212 | if (comp_sink->graph_is_configured_method_called) { | |
213 | continue; | |
214 | } | |
215 | ||
216 | if (comp_cls_sink->methods.graph_is_configured) { | |
d24d5663 | 217 | enum bt_component_class_sink_graph_is_configured_method_status comp_status; |
5badd463 | 218 | |
5badd463 PP |
219 | BT_LIB_LOGD("Calling user's \"graph is configured\" method: " |
220 | "%![graph-]+g, %![comp-]+c", | |
221 | graph, comp); | |
5badd463 PP |
222 | comp_status = comp_cls_sink->methods.graph_is_configured( |
223 | (void *) comp_sink); | |
5badd463 | 224 | BT_LIB_LOGD("User method returned: status=%s", |
d24d5663 PP |
225 | bt_common_func_status_string(comp_status)); |
226 | BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK || | |
227 | comp_status == BT_FUNC_STATUS_ERROR || | |
228 | comp_status == BT_FUNC_STATUS_MEMORY_ERROR, | |
5badd463 | 229 | "Unexpected returned status: status=%s", |
d24d5663 | 230 | bt_common_func_status_string(comp_status)); |
6ecdcca3 | 231 | BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(comp_status); |
d24d5663 | 232 | if (comp_status != BT_FUNC_STATUS_OK) { |
870631a2 PP |
233 | if (comp_status < 0) { |
234 | BT_LIB_LOGW_APPEND_CAUSE( | |
235 | "Component's \"graph is configured\" method failed: " | |
236 | "%![comp-]+c, status=%s", | |
237 | comp, | |
238 | bt_common_func_status_string( | |
239 | comp_status)); | |
240 | } | |
241 | ||
242 | status = comp_status; | |
5badd463 PP |
243 | goto end; |
244 | } | |
245 | } | |
246 | ||
247 | comp_sink->graph_is_configured_method_called = true; | |
248 | } | |
249 | ||
250 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED; | |
251 | ||
252 | end: | |
253 | return status; | |
254 | } | |
255 | ||
8cc56726 SM |
256 | static inline |
257 | void bt_graph_make_faulty(struct bt_graph *graph) | |
258 | { | |
259 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY; | |
3f7d4d90 | 260 | BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph); |
8cc56726 SM |
261 | } |
262 | ||
6ac74c0c | 263 | #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */ |