2 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "COMP"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/graph/private-component.h>
29 #include <babeltrace/graph/component.h>
30 #include <babeltrace/graph/component-internal.h>
31 #include <babeltrace/graph/component-class-internal.h>
32 #include <babeltrace/graph/component-source-internal.h>
33 #include <babeltrace/graph/component-filter-internal.h>
34 #include <babeltrace/graph/component-sink-internal.h>
35 #include <babeltrace/graph/private-connection.h>
36 #include <babeltrace/graph/connection-internal.h>
37 #include <babeltrace/graph/graph-internal.h>
38 #include <babeltrace/graph/notification-iterator-internal.h>
39 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
40 #include <babeltrace/babeltrace-internal.h>
41 #include <babeltrace/compiler-internal.h>
42 #include <babeltrace/object.h>
43 #include <babeltrace/types.h>
44 #include <babeltrace/values.h>
45 #include <babeltrace/values-internal.h>
46 #include <babeltrace/assert-internal.h>
51 struct bt_component
* (* const component_create_funcs
[])(
52 struct bt_component_class
*) = {
53 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
54 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
55 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
59 void (*component_destroy_funcs
[])(struct bt_component
*) = {
60 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
61 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
62 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
66 void bt_component_destroy(struct bt_object
*obj
)
68 struct bt_component
*component
= NULL
;
69 struct bt_component_class
*component_class
= NULL
;
77 * The component's reference count is 0 if we're here. Increment
78 * it to avoid a double-destroy (possibly infinitely recursive).
79 * This could happen for example if the component's finalization
80 * function does bt_object_get_ref() (or anything that causes bt_object_get_ref() to
81 * be called) on itself (ref. count goes from 0 to 1), and then
82 * bt_object_put_ref(): the reference count would go from 1 to 0 again and
83 * this function would be called again.
86 component
= container_of(obj
, struct bt_component
, base
);
87 BT_LOGD("Destroying component: addr=%p, name=\"%s\", graph-addr=%p",
88 component
, bt_component_get_name(component
),
91 /* Call destroy listeners in reverse registration order */
92 BT_LOGD_STR("Calling destroy listeners.");
94 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
95 struct bt_component_destroy_listener
*listener
=
96 &g_array_index(component
->destroy_listeners
,
97 struct bt_component_destroy_listener
, i
);
99 listener
->func(component
, listener
->data
);
102 component_class
= component
->class;
105 * User data is destroyed first, followed by the concrete
106 * component instance. Do not finalize if the component's user
107 * initialization method failed in the first place.
109 if (component
->initialized
&& component
->class->methods
.finalize
) {
110 BT_LOGD_STR("Calling user's finalization method.");
111 component
->class->methods
.finalize(
112 bt_private_component_from_component(component
));
115 if (component
->destroy
) {
116 BT_LOGD_STR("Destroying type-specific data.");
117 component
->destroy(component
);
120 if (component
->input_ports
) {
121 BT_LOGD_STR("Destroying input ports.");
122 g_ptr_array_free(component
->input_ports
, TRUE
);
125 if (component
->output_ports
) {
126 BT_LOGD_STR("Destroying output ports.");
127 g_ptr_array_free(component
->output_ports
, TRUE
);
130 if (component
->destroy_listeners
) {
131 g_array_free(component
->destroy_listeners
, TRUE
);
134 if (component
->name
) {
135 g_string_free(component
->name
, TRUE
);
138 BT_LOGD("Putting component class.");
139 bt_object_put_ref(component_class
);
143 struct bt_component
*bt_component_borrow_from_private(
144 struct bt_private_component
*private_component
)
146 return (void *) private_component
;
149 enum bt_component_class_type
bt_component_get_class_type(
150 struct bt_component
*component
)
152 return component
? component
->class->type
: BT_COMPONENT_CLASS_TYPE_UNKNOWN
;
156 struct bt_port
*bt_component_add_port(
157 struct bt_component
*component
, GPtrArray
*ports
,
158 enum bt_port_type port_type
, const char *name
, void *user_data
)
161 struct bt_port
*new_port
= NULL
;
162 struct bt_graph
*graph
= NULL
;
165 BT_LOGW_STR("Invalid parameter: name is NULL.");
169 if (strlen(name
) == 0) {
170 BT_LOGW_STR("Invalid parameter: name is an empty string.");
174 BT_LOGD("Adding port to component: comp-addr=%p, comp-name=\"%s\", "
175 "port-type=%s, port-name=\"%s\"", component
,
176 bt_component_get_name(component
),
177 bt_port_type_string(port_type
), name
);
179 /* Look for a port having the same name. */
180 for (i
= 0; i
< ports
->len
; i
++) {
181 const char *port_name
;
182 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
184 port_name
= bt_port_get_name(port
);
185 BT_ASSERT(port_name
);
187 if (!strcmp(name
, port_name
)) {
188 /* Port name clash, abort. */
189 BT_LOGW("Invalid parameter: another port with the same name already exists in the component: "
190 "other-port-addr=%p", port
);
195 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
197 BT_LOGE("Cannot create port object.");
202 * No name clash, add the port.
203 * The component is now the port's parent; it should _not_
204 * hold a reference to the port since the port's lifetime
205 * is now protected by the component's own lifetime.
207 g_ptr_array_add(ports
, new_port
);
210 * Notify the graph's creator that a new port was added.
212 graph
= bt_object_get_ref(bt_component_borrow_graph(component
));
214 bt_graph_notify_port_added(graph
, new_port
);
215 BT_OBJECT_PUT_REF_AND_RESET(graph
);
218 BT_LOGD("Created and added port to component: comp-addr=%p, comp-name=\"%s\", "
219 "port-type=%s, port-name=\"%s\", port-addr=%p", component
,
220 bt_component_get_name(component
),
221 bt_port_type_string(port_type
), name
, new_port
);
228 int64_t bt_component_get_input_port_count(struct bt_component
*comp
)
231 return (int64_t) comp
->input_ports
->len
;
235 int64_t bt_component_get_output_port_count(struct bt_component
*comp
)
238 return (int64_t) comp
->output_ports
->len
;
242 enum bt_component_status
bt_component_create(
243 struct bt_component_class
*component_class
,
244 const char *name
, struct bt_component
**user_component
)
246 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
247 struct bt_component
*component
= NULL
;
248 enum bt_component_class_type type
;
250 BT_ASSERT(user_component
);
251 BT_ASSERT(component_class
);
254 type
= bt_component_class_get_type(component_class
);
255 BT_LOGD("Creating empty component from component class: "
256 "comp-cls-addr=%p, comp-cls-type=%s, name=\"%s\"",
257 component_class
, bt_component_class_type_string(type
), name
);
258 component
= component_create_funcs
[type
](component_class
);
260 BT_LOGE_STR("Cannot create specific component object.");
261 status
= BT_COMPONENT_STATUS_NOMEM
;
265 bt_object_init_shared_with_parent(&component
->base
,
266 bt_component_destroy
);
267 component
->class = bt_object_get_ref(component_class
);
268 component
->destroy
= component_destroy_funcs
[type
];
269 component
->name
= g_string_new(name
);
270 if (!component
->name
) {
271 BT_LOGE_STR("Failed to allocate one GString.");
272 status
= BT_COMPONENT_STATUS_NOMEM
;
276 component
->input_ports
= g_ptr_array_new_with_free_func(
277 (GDestroyNotify
) bt_object_try_spec_release
);
278 if (!component
->input_ports
) {
279 BT_LOGE_STR("Failed to allocate one GPtrArray.");
280 status
= BT_COMPONENT_STATUS_NOMEM
;
284 component
->output_ports
= g_ptr_array_new_with_free_func(
285 (GDestroyNotify
) bt_object_try_spec_release
);
286 if (!component
->output_ports
) {
287 BT_LOGE_STR("Failed to allocate one GPtrArray.");
288 status
= BT_COMPONENT_STATUS_NOMEM
;
292 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
293 sizeof(struct bt_component_destroy_listener
));
294 if (!component
->destroy_listeners
) {
295 BT_LOGE_STR("Failed to allocate one GArray.");
296 status
= BT_COMPONENT_STATUS_NOMEM
;
300 BT_LOGD("Created empty component from component class: "
301 "comp-cls-addr=%p, comp-cls-type=%s, name=\"%s\", comp-addr=%p",
302 component_class
, bt_component_class_type_string(type
), name
,
304 BT_OBJECT_MOVE_REF(*user_component
, component
);
307 bt_object_put_ref(component
);
311 const char *bt_component_get_name(struct bt_component
*component
)
313 const char *ret
= NULL
;
316 BT_LOGW_STR("Invalid parameter: component is NULL.");
320 ret
= component
->name
->len
== 0 ? NULL
: component
->name
->str
;
326 struct bt_component_class
*bt_component_get_class(
327 struct bt_component
*component
)
329 return component
? bt_object_get_ref(component
->class) : NULL
;
332 void *bt_private_component_get_user_data(
333 struct bt_private_component
*private_component
)
335 struct bt_component
*component
=
336 bt_component_borrow_from_private(private_component
);
338 return component
? component
->user_data
: NULL
;
341 enum bt_component_status
bt_private_component_set_user_data(
342 struct bt_private_component
*private_component
,
345 struct bt_component
*component
=
346 bt_component_borrow_from_private(private_component
);
347 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
350 BT_LOGW_STR("Invalid parameter: component is NULL.");
351 ret
= BT_COMPONENT_STATUS_INVALID
;
355 component
->user_data
= data
;
356 BT_LOGV("Set component's user data: "
357 "comp-addr=%p, comp-name=\"%s\", user-data-addr=%p",
358 component
, bt_component_get_name(component
), data
);
365 void bt_component_set_graph(struct bt_component
*component
,
366 struct bt_graph
*graph
)
368 bt_object_set_parent(&component
->base
,
369 graph
? &graph
->base
: NULL
);
372 bt_bool
bt_component_graph_is_canceled(struct bt_component
*component
)
374 return bt_graph_is_canceled(
375 (void *) bt_object_borrow_parent(&component
->base
));
379 struct bt_port
*bt_component_get_port_by_name(GPtrArray
*ports
,
383 struct bt_port
*ret_port
= NULL
;
387 for (i
= 0; i
< ports
->len
; i
++) {
388 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
389 const char *port_name
= bt_port_get_name(port
);
395 if (!strcmp(name
, port_name
)) {
396 ret_port
= bt_object_get_ref(port
);
405 struct bt_port
*bt_component_get_input_port_by_name(struct bt_component
*comp
,
410 return bt_component_get_port_by_name(comp
->input_ports
, name
);
414 struct bt_port
*bt_component_get_output_port_by_name(struct bt_component
*comp
,
419 return bt_component_get_port_by_name(comp
->output_ports
, name
);
423 struct bt_port
*bt_component_get_port_by_index(GPtrArray
*ports
, uint64_t index
)
425 struct bt_port
*port
= NULL
;
427 if (index
>= ports
->len
) {
428 BT_LOGW("Invalid parameter: index is out of bounds: "
429 "index=%" PRIu64
", count=%u",
434 port
= bt_object_get_ref(g_ptr_array_index(ports
, index
));
440 struct bt_port
*bt_component_get_input_port_by_index(struct bt_component
*comp
,
445 return bt_component_get_port_by_index(comp
->input_ports
, index
);
449 struct bt_port
*bt_component_get_output_port_by_index(struct bt_component
*comp
,
454 return bt_component_get_port_by_index(comp
->output_ports
, index
);
458 struct bt_port
*bt_component_add_input_port(
459 struct bt_component
*component
, const char *name
,
462 /* bt_component_add_port() logs details */
463 return bt_component_add_port(component
, component
->input_ports
,
464 BT_PORT_TYPE_INPUT
, name
, user_data
);
468 struct bt_port
*bt_component_add_output_port(
469 struct bt_component
*component
, const char *name
,
472 /* bt_component_add_port() logs details */
473 return bt_component_add_port(component
, component
->output_ports
,
474 BT_PORT_TYPE_OUTPUT
, name
, user_data
);
478 void bt_component_remove_port_by_index(struct bt_component
*component
,
479 GPtrArray
*ports
, size_t index
)
481 struct bt_port
*port
;
482 struct bt_graph
*graph
;
485 BT_ASSERT(index
< ports
->len
);
486 port
= g_ptr_array_index(ports
, index
);
488 BT_LOGD("Removing port from component: "
489 "comp-addr=%p, comp-name=\"%s\", "
490 "port-addr=%p, port-name=\"%s\"",
491 component
, bt_component_get_name(component
),
492 port
, bt_port_get_name(port
));
494 /* Disconnect both ports of this port's connection, if any */
495 if (port
->connection
) {
496 bt_connection_end(port
->connection
, true);
499 /* Remove from parent's array of ports (weak refs) */
500 g_ptr_array_remove_index(ports
, index
);
502 /* Detach port from its component parent */
503 BT_OBJECT_PUT_REF_AND_RESET(port
->base
.parent
);
506 * Notify the graph's creator that a port is removed.
508 graph
= bt_object_get_ref(bt_component_borrow_graph(component
));
510 bt_graph_notify_port_removed(graph
, component
, port
);
511 BT_OBJECT_PUT_REF_AND_RESET(graph
);
514 BT_LOGD("Removed port from component: "
515 "comp-addr=%p, comp-name=\"%s\", "
516 "port-addr=%p, port-name=\"%s\"",
517 component
, bt_component_get_name(component
),
518 port
, bt_port_get_name(port
));
522 enum bt_component_status
bt_component_remove_port(
523 struct bt_component
*component
, struct bt_port
*port
)
526 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
527 GPtrArray
*ports
= NULL
;
530 BT_LOGW_STR("Invalid parameter: component is NULL.");
531 status
= BT_COMPONENT_STATUS_INVALID
;
536 BT_LOGW_STR("Invalid parameter: port is NULL.");
537 status
= BT_COMPONENT_STATUS_INVALID
;
541 if (bt_port_get_type(port
) == BT_PORT_TYPE_INPUT
) {
542 ports
= component
->input_ports
;
543 } else if (bt_port_get_type(port
) == BT_PORT_TYPE_OUTPUT
) {
544 ports
= component
->output_ports
;
549 for (i
= 0; i
< ports
->len
; i
++) {
550 struct bt_port
*cur_port
= g_ptr_array_index(ports
, i
);
552 if (cur_port
== port
) {
553 bt_component_remove_port_by_index(component
,
559 status
= BT_COMPONENT_STATUS_NOT_FOUND
;
560 BT_LOGW("Port to remove from component was not found: "
561 "comp-addr=%p, comp-name=\"%s\", "
562 "port-addr=%p, port-name=\"%s\"",
563 component
, bt_component_get_name(component
),
564 port
, bt_port_get_name(port
));
571 enum bt_component_status
bt_component_accept_port_connection(
572 struct bt_component
*comp
, struct bt_port
*self_port
,
573 struct bt_port
*other_port
)
575 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
578 BT_ASSERT(self_port
);
579 BT_ASSERT(other_port
);
581 if (comp
->class->methods
.accept_port_connection
) {
582 BT_LOGD("Calling user's \"accept port connection\" method: "
583 "comp-addr=%p, comp-name=\"%s\", "
584 "self-port-addr=%p, self-port-name=\"%s\", "
585 "other-port-addr=%p, other-port-name=\"%s\"",
586 comp
, bt_component_get_name(comp
),
587 self_port
, bt_port_get_name(self_port
),
588 other_port
, bt_port_get_name(other_port
));
589 status
= comp
->class->methods
.accept_port_connection(
590 bt_private_component_from_component(comp
),
591 bt_private_port_from_port(self_port
),
593 BT_LOGD("User method returned: status=%s",
594 bt_component_status_string(status
));
601 enum bt_component_status
bt_component_port_connected(struct bt_component
*comp
,
602 struct bt_port
*self_port
, struct bt_port
*other_port
)
604 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
607 BT_ASSERT(self_port
);
608 BT_ASSERT(other_port
);
610 if (comp
->class->methods
.port_connected
) {
611 BT_LOGD("Calling user's \"port connected\" method: "
612 "comp-addr=%p, comp-name=\"%s\", "
613 "self-port-addr=%p, self-port-name=\"%s\", "
614 "other-port-addr=%p, other-port-name=\"%s\"",
615 comp
, bt_component_get_name(comp
),
616 self_port
, bt_port_get_name(self_port
),
617 other_port
, bt_port_get_name(other_port
));
618 status
= comp
->class->methods
.port_connected(
619 bt_private_component_from_component(comp
),
620 bt_private_port_from_port(self_port
), other_port
);
627 void bt_component_port_disconnected(struct bt_component
*comp
,
628 struct bt_port
*port
)
633 if (comp
->class->methods
.port_disconnected
) {
634 BT_LOGD("Calling user's \"port disconnected\" method: "
635 "comp-addr=%p, comp-name=\"%s\", "
636 "port-addr=%p, port-name=\"%s\"",
637 comp
, bt_component_get_name(comp
),
638 port
, bt_port_get_name(port
));
639 comp
->class->methods
.port_disconnected(
640 bt_private_component_from_component(comp
),
641 bt_private_port_from_port(port
));
646 void bt_component_add_destroy_listener(struct bt_component
*component
,
647 bt_component_destroy_listener_func func
, void *data
)
649 struct bt_component_destroy_listener listener
;
651 BT_ASSERT(component
);
653 listener
.func
= func
;
654 listener
.data
= data
;
655 g_array_append_val(component
->destroy_listeners
, listener
);
656 BT_LOGV("Added destroy listener: "
657 "comp-addr=%p, comp-name=\"%s\", "
658 "func-addr=%p, data-addr=%p",
659 component
, bt_component_get_name(component
),
664 void bt_component_remove_destroy_listener(struct bt_component
*component
,
665 bt_component_destroy_listener_func func
, void *data
)
669 BT_ASSERT(component
);
672 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
673 struct bt_component_destroy_listener
*listener
=
674 &g_array_index(component
->destroy_listeners
,
675 struct bt_component_destroy_listener
, i
);
677 if (listener
->func
== func
&& listener
->data
== data
) {
678 g_array_remove_index(component
->destroy_listeners
, i
);
680 BT_LOGV("Removed destroy listener: "
681 "comp-addr=%p, comp-name=\"%s\", "
682 "func-addr=%p, data-addr=%p",
683 component
, bt_component_get_name(component
),