4 * Babeltrace Connection
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #define BT_LOG_TAG "CONNECTION"
30 #include <babeltrace/lib-logging-internal.h>
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>
40 #include <babeltrace/object-internal.h>
41 #include <babeltrace/compiler-internal.h>
42 #include <babeltrace/assert-internal.h>
47 void bt_connection_destroy(struct bt_object
*obj
)
49 struct bt_connection
*connection
= container_of(obj
,
50 struct bt_connection
, base
);
52 BT_LOGD("Destroying connection: addr=%p", connection
);
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.
60 * Because connections are destroyed before components within a
61 * graph, this ensures that notification iterators are always
62 * finalized before their upstream component.
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
69 bt_connection_end(connection
, false);
70 g_ptr_array_free(connection
->iterators
, TRUE
);
73 * No bt_put on ports as a connection only holds _weak_
80 void bt_connection_try_remove_from_graph(struct bt_connection
*connection
)
82 void *graph
= (void *) bt_object_borrow_parent(&connection
->base
);
84 if (connection
->base
.ref_count
> 0 ||
85 connection
->downstream_port
||
86 connection
->upstream_port
||
87 connection
->iterators
->len
> 0) {
92 * At this point we know that:
94 * 1. The connection is ended (ports were disconnected).
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.
100 * In other words, no other object than the graph knows this
103 * It is safe to remove the connection from the graph, therefore
106 BT_LOGD("Removing self from graph's connections: "
107 "graph-addr=%p, conn-addr=%p", graph
, connection
);
108 bt_graph_remove_connection(graph
, connection
);
112 void bt_connection_parent_is_owner(struct bt_object
*obj
)
114 struct bt_connection
*connection
= container_of(obj
,
115 struct bt_connection
, base
);
117 bt_connection_try_remove_from_graph(connection
);
120 struct bt_connection
*bt_connection_borrow_from_private(
121 struct bt_private_connection
*private_connection
)
123 return (void *) private_connection
;
127 struct bt_connection
*bt_connection_create(
128 struct bt_graph
*graph
,
129 struct bt_port
*upstream_port
,
130 struct bt_port
*downstream_port
)
132 struct bt_connection
*connection
= NULL
;
134 if (bt_port_get_type(upstream_port
) != BT_PORT_TYPE_OUTPUT
) {
135 BT_LOGW_STR("Invalid parameter: upstream port is not an output port.");
138 if (bt_port_get_type(downstream_port
) != BT_PORT_TYPE_INPUT
) {
139 BT_LOGW_STR("Invalid parameter: downstream port is not an input port.");
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
));
148 connection
= g_new0(struct bt_connection
, 1);
150 BT_LOGE_STR("Failed to allocate one connection.");
154 bt_object_init_shared_with_parent(&connection
->base
,
155 bt_connection_destroy
);
156 bt_object_set_parent_is_owner_listener_func(&connection
->base
,
157 bt_connection_parent_is_owner
);
158 connection
->iterators
= g_ptr_array_new();
159 if (!connection
->iterators
) {
160 BT_LOGE_STR("Failed to allocate a GPtrArray.");
165 /* Weak references are taken, see comment in header. */
166 connection
->upstream_port
= upstream_port
;
167 connection
->downstream_port
= downstream_port
;
168 BT_LOGD_STR("Setting upstream port's connection.");
169 bt_port_set_connection(upstream_port
, connection
);
170 BT_LOGD_STR("Setting downstream port's connection.");
171 bt_port_set_connection(downstream_port
, connection
);
172 bt_object_set_parent(&connection
->base
, &graph
->base
);
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\", "
177 graph
, upstream_port
, bt_port_get_name(upstream_port
),
178 downstream_port
, bt_port_get_name(downstream_port
),
186 void bt_connection_end(struct bt_connection
*conn
,
187 bool try_remove_from_graph
)
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
;
193 struct bt_graph
*graph
= bt_connection_borrow_graph(conn
);
196 BT_LOGD("Ending connection: conn-addr=%p, try-remove-from-graph=%d",
197 conn
, try_remove_from_graph
);
199 if (downstream_port
) {
200 BT_LOGD("Disconnecting connection's downstream port: "
201 "port-addr=%p, port-name=\"%s\"",
202 downstream_port
, bt_port_get_name(downstream_port
));
203 downstream_comp
= bt_port_get_component(downstream_port
);
204 bt_port_set_connection(downstream_port
, NULL
);
205 conn
->downstream_port
= NULL
;
209 BT_LOGD("Disconnecting connection's upstream port: "
210 "port-addr=%p, port-name=\"%s\"",
211 upstream_port
, bt_port_get_name(upstream_port
));
212 upstream_comp
= bt_port_get_component(upstream_port
);
213 bt_port_set_connection(upstream_port
, NULL
);
214 conn
->upstream_port
= NULL
;
217 if (downstream_comp
) {
218 /* bt_component_port_disconnected() logs details */
219 bt_component_port_disconnected(downstream_comp
,
224 /* bt_component_port_disconnected() logs details */
225 bt_component_port_disconnected(upstream_comp
, upstream_port
);
229 /* bt_graph_notify_ports_disconnected() logs details */
230 bt_graph_notify_ports_disconnected(graph
, upstream_comp
,
231 downstream_comp
, upstream_port
, downstream_port
);
232 bt_put(downstream_comp
);
233 bt_put(upstream_comp
);
236 * Because this connection is ended, finalize (cancel) each
237 * notification iterator created from it.
239 for (i
= 0; i
< conn
->iterators
->len
; i
++) {
240 struct bt_notification_iterator_private_connection
*iterator
=
241 g_ptr_array_index(conn
->iterators
, i
);
243 BT_LOGD("Finalizing notification iterator created by this ended connection: "
244 "conn-addr=%p, iter-addr=%p", conn
, iterator
);
245 bt_private_connection_notification_iterator_finalize(iterator
);
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.
252 bt_private_connection_notification_iterator_set_connection(
256 g_ptr_array_set_size(conn
->iterators
, 0);
258 if (try_remove_from_graph
) {
259 bt_connection_try_remove_from_graph(conn
);
263 struct bt_port
*bt_connection_get_upstream_port(
264 struct bt_connection
*connection
)
266 return connection
? bt_get(connection
->upstream_port
) : NULL
;
269 struct bt_port
*bt_connection_get_downstream_port(
270 struct bt_connection
*connection
)
272 return connection
? bt_get(connection
->downstream_port
) : NULL
;
275 enum bt_connection_status
276 bt_private_connection_create_notification_iterator(
277 struct bt_private_connection
*private_connection
,
278 struct bt_notification_iterator
**user_iterator
)
280 enum bt_component_class_type upstream_comp_class_type
;
281 struct bt_notification_iterator_private_connection
*iterator
= NULL
;
282 struct bt_port
*upstream_port
= NULL
;
283 struct bt_component
*upstream_component
= NULL
;
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
;
287 enum bt_connection_status status
;
289 if (!private_connection
) {
290 BT_LOGW_STR("Invalid parameter: private connection is NULL.");
291 status
= BT_CONNECTION_STATUS_INVALID
;
295 if (!user_iterator
) {
296 BT_LOGW_STR("Invalid parameter: notification iterator pointer is NULL.");
297 status
= BT_CONNECTION_STATUS_INVALID
;
301 connection
= bt_connection_borrow_from_private(private_connection
);
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
),
312 bt_component_get_name(upstream_component
),
313 bt_connection_borrow_graph(connection
));
314 status
= BT_CONNECTION_STATUS_GRAPH_IS_CANCELED
;
318 if (bt_connection_is_ended(connection
)) {
319 BT_LOGW("Invalid parameter: connection is ended: "
320 "conn-addr=%p", connection
);
321 status
= BT_CONNECTION_STATUS_IS_ENDED
;
325 upstream_port
= connection
->upstream_port
;
326 BT_ASSERT(upstream_port
);
327 upstream_component
= bt_port_get_component(upstream_port
);
328 BT_ASSERT(upstream_component
);
329 upstream_comp_class
= upstream_component
->class;
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
));
337 upstream_comp_class_type
=
338 bt_component_get_class_type(upstream_component
);
339 BT_ASSERT(upstream_comp_class_type
== BT_COMPONENT_CLASS_TYPE_SOURCE
||
340 upstream_comp_class_type
== BT_COMPONENT_CLASS_TYPE_FILTER
);
341 status
= bt_private_connection_notification_iterator_create(upstream_component
,
342 upstream_port
, connection
, &iterator
);
343 if (status
!= BT_CONNECTION_STATUS_OK
) {
344 BT_LOGW("Cannot create notification iterator from connection.");
348 switch (upstream_comp_class_type
) {
349 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
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
;
357 case BT_COMPONENT_CLASS_TYPE_FILTER
:
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
;
367 BT_LOGF("Unknown component class type: type=%d",
368 upstream_comp_class_type
);
373 enum bt_notification_iterator_status iter_status
;
375 BT_LOGD("Calling user's initialization method: iter-addr=%p",
377 iter_status
= init_method(
378 bt_private_connection_private_notification_iterator_from_notification_iterator((void *) iterator
),
379 bt_private_port_from_port(upstream_port
));
380 BT_LOGD("User method returned: status=%s",
381 bt_notification_iterator_status_string(iter_status
));
382 if (iter_status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
383 BT_LOGW_STR("Initialization method failed.");
384 status
= bt_connection_status_from_notification_iterator_status(
390 iterator
->state
= BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE
;
391 g_ptr_array_add(connection
->iterators
, iterator
);
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
),
401 /* Move reference to user */
402 *user_iterator
= (void *) iterator
;
406 bt_put(upstream_component
);
412 void bt_connection_remove_iterator(struct bt_connection
*conn
,
413 struct bt_notification_iterator_private_connection
*iterator
)
415 g_ptr_array_remove(conn
->iterators
, iterator
);
416 BT_LOGV("Removed notification iterator from connection: "
417 "conn-addr=%p, iter-addr=%p", conn
, iterator
);
418 bt_connection_try_remove_from_graph(conn
);
421 bt_bool
bt_connection_is_ended(struct bt_connection
*connection
)
423 return !connection
->downstream_port
&& !connection
->upstream_port
;