Commit | Line | Data |
---|---|---|
784cdc68 | 1 | /* |
7d55361f | 2 | * connection.c |
784cdc68 JG |
3 | * |
4 | * Babeltrace Connection | |
5 | * | |
6 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
a36bfb16 PP |
29 | #define BT_LOG_TAG "CONNECTION" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
b2e0c907 PP |
32 | #include <babeltrace/graph/notification-iterator-internal.h> |
33 | #include <babeltrace/graph/component-internal.h> | |
34 | #include <babeltrace/graph/component-source-internal.h> | |
35 | #include <babeltrace/graph/component-filter-internal.h> | |
36 | #include <babeltrace/graph/connection-internal.h> | |
37 | #include <babeltrace/graph/private-connection.h> | |
38 | #include <babeltrace/graph/graph-internal.h> | |
39 | #include <babeltrace/graph/port-internal.h> | |
784cdc68 | 40 | #include <babeltrace/object-internal.h> |
3d9990ac | 41 | #include <babeltrace/compiler-internal.h> |
f6ccaed9 | 42 | #include <babeltrace/assert-internal.h> |
0fbb9a9f | 43 | #include <stdlib.h> |
784cdc68 JG |
44 | #include <glib.h> |
45 | ||
46 | static | |
47 | void bt_connection_destroy(struct bt_object *obj) | |
48 | { | |
49 | struct bt_connection *connection = container_of(obj, | |
50 | struct bt_connection, base); | |
bd14d768 | 51 | |
a36bfb16 PP |
52 | BT_LOGD("Destroying connection: addr=%p", connection); |
53 | ||
bd14d768 PP |
54 | /* |
55 | * Make sure that each notification iterator which was created | |
56 | * for this connection is finalized before we destroy it. Once a | |
57 | * notification iterator is finalized, all its method return | |
58 | * NULL or the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED status. | |
59 | * | |
60 | * Because connections are destroyed before components within a | |
61 | * graph, this ensures that notification iterators are always | |
62 | * finalized before their upstream component. | |
c42ea0af PP |
63 | * |
64 | * Ending the connection does exactly this. We pass `false` to | |
65 | * bt_connection_end() here to avoid removing this connection | |
66 | * from the graph: if we're here, we're already in the graph's | |
67 | * destructor. | |
bd14d768 | 68 | */ |
c42ea0af PP |
69 | bt_connection_end(connection, false); |
70 | g_ptr_array_free(connection->iterators, TRUE); | |
784cdc68 JG |
71 | |
72 | /* | |
c42ea0af PP |
73 | * No bt_put on ports as a connection only holds _weak_ |
74 | * references to them. | |
784cdc68 JG |
75 | */ |
76 | g_free(connection); | |
77 | } | |
78 | ||
f167d3c0 PP |
79 | static |
80 | void bt_connection_try_remove_from_graph(struct bt_connection *connection) | |
81 | { | |
3fea54f6 | 82 | void *graph = (void *) bt_object_borrow_parent(&connection->base); |
f167d3c0 | 83 | |
3fea54f6 | 84 | if (connection->base.ref_count > 0 || |
f167d3c0 PP |
85 | connection->downstream_port || |
86 | connection->upstream_port || | |
87 | connection->iterators->len > 0) { | |
88 | return; | |
89 | } | |
90 | ||
91 | /* | |
92 | * At this point we know that: | |
93 | * | |
a36bfb16 | 94 | * 1. The connection is ended (ports were disconnected). |
f167d3c0 PP |
95 | * 2. All the notification iterators that this connection |
96 | * created, if any, are finalized. | |
97 | * 3. The connection's reference count is 0, so only the | |
98 | * parent (graph) owns this connection after this call. | |
99 | * | |
100 | * In other words, no other object than the graph knows this | |
101 | * connection. | |
102 | * | |
103 | * It is safe to remove the connection from the graph, therefore | |
104 | * destroying it. | |
105 | */ | |
a36bfb16 PP |
106 | BT_LOGD("Removing self from graph's connections: " |
107 | "graph-addr=%p, conn-addr=%p", graph, connection); | |
f167d3c0 PP |
108 | bt_graph_remove_connection(graph, connection); |
109 | } | |
110 | ||
111 | static | |
112 | void bt_connection_parent_is_owner(struct bt_object *obj) | |
113 | { | |
114 | struct bt_connection *connection = container_of(obj, | |
115 | struct bt_connection, base); | |
116 | ||
117 | bt_connection_try_remove_from_graph(connection); | |
118 | } | |
119 | ||
5c563278 | 120 | struct bt_connection *bt_connection_borrow_from_private( |
890882ef PP |
121 | struct bt_private_connection *private_connection) |
122 | { | |
5c563278 | 123 | return (void *) private_connection; |
890882ef PP |
124 | } |
125 | ||
784cdc68 JG |
126 | BT_HIDDEN |
127 | struct bt_connection *bt_connection_create( | |
128 | struct bt_graph *graph, | |
72b913fb PP |
129 | struct bt_port *upstream_port, |
130 | struct bt_port *downstream_port) | |
784cdc68 JG |
131 | { |
132 | struct bt_connection *connection = NULL; | |
133 | ||
72b913fb | 134 | if (bt_port_get_type(upstream_port) != BT_PORT_TYPE_OUTPUT) { |
a36bfb16 | 135 | BT_LOGW_STR("Invalid parameter: upstream port is not an output port."); |
784cdc68 JG |
136 | goto end; |
137 | } | |
72b913fb | 138 | if (bt_port_get_type(downstream_port) != BT_PORT_TYPE_INPUT) { |
a36bfb16 | 139 | BT_LOGW_STR("Invalid parameter: downstream port is not an input port."); |
784cdc68 JG |
140 | goto end; |
141 | } | |
142 | ||
a36bfb16 PP |
143 | BT_LOGD("Creating connection: " |
144 | "graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", " | |
145 | "downstream-port-addr=%p, downstream-port-name=\"%s\"", | |
146 | graph, upstream_port, bt_port_get_name(upstream_port), | |
147 | downstream_port, bt_port_get_name(downstream_port)); | |
784cdc68 JG |
148 | connection = g_new0(struct bt_connection, 1); |
149 | if (!connection) { | |
a36bfb16 | 150 | BT_LOGE_STR("Failed to allocate one connection."); |
784cdc68 JG |
151 | goto end; |
152 | } | |
153 | ||
3fea54f6 PP |
154 | bt_object_init_shared_with_parent(&connection->base, |
155 | bt_connection_destroy); | |
156 | bt_object_set_parent_is_owner_listener_func(&connection->base, | |
f167d3c0 | 157 | bt_connection_parent_is_owner); |
bd14d768 PP |
158 | connection->iterators = g_ptr_array_new(); |
159 | if (!connection->iterators) { | |
a36bfb16 | 160 | BT_LOGE_STR("Failed to allocate a GPtrArray."); |
bd14d768 PP |
161 | BT_PUT(connection); |
162 | goto end; | |
163 | } | |
164 | ||
784cdc68 | 165 | /* Weak references are taken, see comment in header. */ |
72b913fb PP |
166 | connection->upstream_port = upstream_port; |
167 | connection->downstream_port = downstream_port; | |
a36bfb16 | 168 | BT_LOGD_STR("Setting upstream port's connection."); |
72b913fb | 169 | bt_port_set_connection(upstream_port, connection); |
a36bfb16 | 170 | BT_LOGD_STR("Setting downstream port's connection."); |
72b913fb | 171 | bt_port_set_connection(downstream_port, connection); |
3fea54f6 | 172 | bt_object_set_parent(&connection->base, &graph->base); |
a36bfb16 PP |
173 | BT_LOGD("Created connection: " |
174 | "graph-addr=%p, upstream-port-addr=%p, uptream-port-name=\"%s\", " | |
175 | "downstream-port-addr=%p, downstream-port-name=\"%s\", " | |
176 | "conn-addr=%p", | |
177 | graph, upstream_port, bt_port_get_name(upstream_port), | |
178 | downstream_port, bt_port_get_name(downstream_port), | |
179 | connection); | |
180 | ||
784cdc68 JG |
181 | end: |
182 | return connection; | |
183 | } | |
184 | ||
72b913fb | 185 | BT_HIDDEN |
c42ea0af PP |
186 | void bt_connection_end(struct bt_connection *conn, |
187 | bool try_remove_from_graph) | |
72b913fb PP |
188 | { |
189 | struct bt_component *downstream_comp = NULL; | |
190 | struct bt_component *upstream_comp = NULL; | |
191 | struct bt_port *downstream_port = conn->downstream_port; | |
192 | struct bt_port *upstream_port = conn->upstream_port; | |
c42ea0af | 193 | struct bt_graph *graph = bt_connection_borrow_graph(conn); |
f167d3c0 | 194 | size_t i; |
72b913fb | 195 | |
c42ea0af PP |
196 | BT_LOGD("Ending connection: conn-addr=%p, try-remove-from-graph=%d", |
197 | conn, try_remove_from_graph); | |
198 | ||
72b913fb | 199 | if (downstream_port) { |
c42ea0af PP |
200 | BT_LOGD("Disconnecting connection's downstream port: " |
201 | "port-addr=%p, port-name=\"%s\"", | |
202 | downstream_port, bt_port_get_name(downstream_port)); | |
72b913fb PP |
203 | downstream_comp = bt_port_get_component(downstream_port); |
204 | bt_port_set_connection(downstream_port, NULL); | |
205 | conn->downstream_port = NULL; | |
206 | } | |
207 | ||
208 | if (upstream_port) { | |
c42ea0af PP |
209 | BT_LOGD("Disconnecting connection's upstream port: " |
210 | "port-addr=%p, port-name=\"%s\"", | |
211 | upstream_port, bt_port_get_name(upstream_port)); | |
72b913fb PP |
212 | upstream_comp = bt_port_get_component(upstream_port); |
213 | bt_port_set_connection(upstream_port, NULL); | |
214 | conn->upstream_port = NULL; | |
215 | } | |
216 | ||
2038affb | 217 | if (downstream_comp) { |
a36bfb16 | 218 | /* bt_component_port_disconnected() logs details */ |
72b913fb PP |
219 | bt_component_port_disconnected(downstream_comp, |
220 | downstream_port); | |
221 | } | |
222 | ||
2038affb | 223 | if (upstream_comp) { |
a36bfb16 | 224 | /* bt_component_port_disconnected() logs details */ |
72b913fb PP |
225 | bt_component_port_disconnected(upstream_comp, upstream_port); |
226 | } | |
227 | ||
f6ccaed9 | 228 | BT_ASSERT(graph); |
a36bfb16 | 229 | /* bt_graph_notify_ports_disconnected() logs details */ |
f345f8bb PP |
230 | bt_graph_notify_ports_disconnected(graph, upstream_comp, |
231 | downstream_comp, upstream_port, downstream_port); | |
72b913fb PP |
232 | bt_put(downstream_comp); |
233 | bt_put(upstream_comp); | |
f167d3c0 PP |
234 | |
235 | /* | |
a36bfb16 | 236 | * Because this connection is ended, finalize (cancel) each |
f167d3c0 PP |
237 | * notification iterator created from it. |
238 | */ | |
239 | for (i = 0; i < conn->iterators->len; i++) { | |
90157d89 | 240 | struct bt_notification_iterator_private_connection *iterator = |
f167d3c0 PP |
241 | g_ptr_array_index(conn->iterators, i); |
242 | ||
a36bfb16 PP |
243 | BT_LOGD("Finalizing notification iterator created by this ended connection: " |
244 | "conn-addr=%p, iter-addr=%p", conn, iterator); | |
90157d89 | 245 | bt_private_connection_notification_iterator_finalize(iterator); |
f167d3c0 PP |
246 | |
247 | /* | |
248 | * Make sure this iterator does not try to remove itself | |
249 | * from this connection's iterators on destruction | |
250 | * because this connection won't exist anymore. | |
251 | */ | |
90157d89 PP |
252 | bt_private_connection_notification_iterator_set_connection( |
253 | iterator, NULL); | |
f167d3c0 PP |
254 | } |
255 | ||
256 | g_ptr_array_set_size(conn->iterators, 0); | |
c42ea0af PP |
257 | |
258 | if (try_remove_from_graph) { | |
259 | bt_connection_try_remove_from_graph(conn); | |
260 | } | |
72b913fb PP |
261 | } |
262 | ||
263 | struct bt_port *bt_connection_get_upstream_port( | |
784cdc68 JG |
264 | struct bt_connection *connection) |
265 | { | |
72b913fb | 266 | return connection ? bt_get(connection->upstream_port) : NULL; |
784cdc68 JG |
267 | } |
268 | ||
72b913fb | 269 | struct bt_port *bt_connection_get_downstream_port( |
784cdc68 JG |
270 | struct bt_connection *connection) |
271 | { | |
72b913fb | 272 | return connection ? bt_get(connection->downstream_port) : NULL; |
784cdc68 JG |
273 | } |
274 | ||
73d5c1ad | 275 | enum bt_connection_status |
890882ef | 276 | bt_private_connection_create_notification_iterator( |
fa054faf | 277 | struct bt_private_connection *private_connection, |
73d5c1ad | 278 | struct bt_notification_iterator **user_iterator) |
784cdc68 | 279 | { |
890882ef | 280 | enum bt_component_class_type upstream_comp_class_type; |
90157d89 | 281 | struct bt_notification_iterator_private_connection *iterator = NULL; |
890882ef | 282 | struct bt_port *upstream_port = NULL; |
784cdc68 | 283 | struct bt_component *upstream_component = NULL; |
890882ef PP |
284 | struct bt_component_class *upstream_comp_class = NULL; |
285 | struct bt_connection *connection = NULL; | |
286 | bt_component_class_notification_iterator_init_method init_method = NULL; | |
73d5c1ad | 287 | enum bt_connection_status status; |
784cdc68 | 288 | |
890882ef | 289 | if (!private_connection) { |
a36bfb16 | 290 | BT_LOGW_STR("Invalid parameter: private connection is NULL."); |
73d5c1ad PP |
291 | status = BT_CONNECTION_STATUS_INVALID; |
292 | goto end; | |
293 | } | |
294 | ||
295 | if (!user_iterator) { | |
296 | BT_LOGW_STR("Invalid parameter: notification iterator pointer is NULL."); | |
297 | status = BT_CONNECTION_STATUS_INVALID; | |
298 | goto end; | |
784cdc68 JG |
299 | } |
300 | ||
6d137876 | 301 | connection = bt_connection_borrow_from_private(private_connection); |
c28d097c PP |
302 | |
303 | if (bt_graph_is_canceled(bt_connection_borrow_graph(connection))) { | |
304 | BT_LOGW("Cannot create notification iterator from connection: " | |
305 | "connection's graph is canceled: " | |
306 | "conn-addr=%p, upstream-port-addr=%p, " | |
307 | "upstream-port-name=\"%s\", upstream-comp-addr=%p, " | |
308 | "upstream-comp-name=\"%s\", graph-addr=%p", | |
309 | connection, connection->upstream_port, | |
310 | bt_port_get_name(connection->upstream_port), | |
311 | upstream_component, | |
312 | bt_component_get_name(upstream_component), | |
313 | bt_connection_borrow_graph(connection)); | |
314 | status = BT_CONNECTION_STATUS_GRAPH_IS_CANCELED; | |
315 | goto end; | |
fa054faf PP |
316 | } |
317 | ||
73d5c1ad | 318 | if (bt_connection_is_ended(connection)) { |
a36bfb16 PP |
319 | BT_LOGW("Invalid parameter: connection is ended: " |
320 | "conn-addr=%p", connection); | |
73d5c1ad PP |
321 | status = BT_CONNECTION_STATUS_IS_ENDED; |
322 | goto end; | |
72b913fb PP |
323 | } |
324 | ||
890882ef | 325 | upstream_port = connection->upstream_port; |
f6ccaed9 | 326 | BT_ASSERT(upstream_port); |
890882ef | 327 | upstream_component = bt_port_get_component(upstream_port); |
f6ccaed9 | 328 | BT_ASSERT(upstream_component); |
890882ef | 329 | upstream_comp_class = upstream_component->class; |
a36bfb16 PP |
330 | BT_LOGD("Creating notification iterator from connection: " |
331 | "conn-addr=%p, upstream-port-addr=%p, " | |
332 | "upstream-port-name=\"%s\", upstream-comp-addr=%p, " | |
333 | "upstream-comp-name=\"%s\"", | |
334 | connection, connection->upstream_port, | |
335 | bt_port_get_name(connection->upstream_port), | |
336 | upstream_component, bt_component_get_name(upstream_component)); | |
890882ef PP |
337 | upstream_comp_class_type = |
338 | bt_component_get_class_type(upstream_component); | |
f6ccaed9 | 339 | BT_ASSERT(upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_SOURCE || |
73d5c1ad | 340 | upstream_comp_class_type == BT_COMPONENT_CLASS_TYPE_FILTER); |
90157d89 | 341 | status = bt_private_connection_notification_iterator_create(upstream_component, |
f42867e2 | 342 | upstream_port, connection, &iterator); |
73d5c1ad | 343 | if (status != BT_CONNECTION_STATUS_OK) { |
a36bfb16 | 344 | BT_LOGW("Cannot create notification iterator from connection."); |
73d5c1ad | 345 | goto end; |
890882ef PP |
346 | } |
347 | ||
348 | switch (upstream_comp_class_type) { | |
784cdc68 | 349 | case BT_COMPONENT_CLASS_TYPE_SOURCE: |
890882ef PP |
350 | { |
351 | struct bt_component_class_source *source_class = | |
352 | container_of(upstream_comp_class, | |
353 | struct bt_component_class_source, parent); | |
354 | init_method = source_class->methods.iterator.init; | |
784cdc68 | 355 | break; |
890882ef | 356 | } |
784cdc68 | 357 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
890882ef PP |
358 | { |
359 | struct bt_component_class_filter *filter_class = | |
360 | container_of(upstream_comp_class, | |
361 | struct bt_component_class_filter, parent); | |
362 | init_method = filter_class->methods.iterator.init; | |
784cdc68 | 363 | break; |
890882ef | 364 | } |
784cdc68 | 365 | default: |
890882ef | 366 | /* Unreachable. */ |
73d5c1ad PP |
367 | BT_LOGF("Unknown component class type: type=%d", |
368 | upstream_comp_class_type); | |
0fbb9a9f | 369 | abort(); |
890882ef PP |
370 | } |
371 | ||
372 | if (init_method) { | |
73d5c1ad | 373 | enum bt_notification_iterator_status iter_status; |
a36bfb16 PP |
374 | |
375 | BT_LOGD("Calling user's initialization method: iter-addr=%p", | |
376 | iterator); | |
73d5c1ad | 377 | iter_status = init_method( |
90157d89 | 378 | bt_private_connection_private_notification_iterator_from_notification_iterator((void *) iterator), |
91457551 | 379 | bt_private_port_from_port(upstream_port)); |
a36bfb16 | 380 | BT_LOGD("User method returned: status=%s", |
73d5c1ad PP |
381 | bt_notification_iterator_status_string(iter_status)); |
382 | if (iter_status != BT_NOTIFICATION_ITERATOR_STATUS_OK) { | |
a36bfb16 | 383 | BT_LOGW_STR("Initialization method failed."); |
73d5c1ad PP |
384 | status = bt_connection_status_from_notification_iterator_status( |
385 | iter_status); | |
386 | goto end; | |
890882ef PP |
387 | } |
388 | } | |
389 | ||
90157d89 | 390 | iterator->state = BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE; |
bd14d768 | 391 | g_ptr_array_add(connection->iterators, iterator); |
a36bfb16 PP |
392 | BT_LOGD("Created notification iterator from connection: " |
393 | "conn-addr=%p, upstream-port-addr=%p, " | |
394 | "upstream-port-name=\"%s\", upstream-comp-addr=%p, " | |
395 | "upstream-comp-name=\"%s\", iter-addr=%p", | |
396 | connection, connection->upstream_port, | |
397 | bt_port_get_name(connection->upstream_port), | |
398 | upstream_component, bt_component_get_name(upstream_component), | |
399 | iterator); | |
1a6a376a PP |
400 | |
401 | /* Move reference to user */ | |
90157d89 | 402 | *user_iterator = (void *) iterator; |
1a6a376a | 403 | iterator = NULL; |
890882ef | 404 | |
784cdc68 JG |
405 | end: |
406 | bt_put(upstream_component); | |
73d5c1ad PP |
407 | bt_put(iterator); |
408 | return status; | |
784cdc68 | 409 | } |
bd14d768 PP |
410 | |
411 | BT_HIDDEN | |
412 | void bt_connection_remove_iterator(struct bt_connection *conn, | |
90157d89 | 413 | struct bt_notification_iterator_private_connection *iterator) |
bd14d768 PP |
414 | { |
415 | g_ptr_array_remove(conn->iterators, iterator); | |
a36bfb16 PP |
416 | BT_LOGV("Removed notification iterator from connection: " |
417 | "conn-addr=%p, iter-addr=%p", conn, iterator); | |
f167d3c0 | 418 | bt_connection_try_remove_from_graph(conn); |
bd14d768 | 419 | } |
090a4c0a PP |
420 | |
421 | bt_bool bt_connection_is_ended(struct bt_connection *connection) | |
422 | { | |
423 | return !connection->downstream_port && !connection->upstream_port; | |
424 | } |