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/self-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/connection-internal.h>
36 #include <babeltrace/graph/graph-internal.h>
37 #include <babeltrace/graph/notification-iterator-internal.h>
38 #include <babeltrace/graph/port-internal.h>
39 #include <babeltrace/babeltrace-internal.h>
40 #include <babeltrace/compiler-internal.h>
41 #include <babeltrace/object.h>
42 #include <babeltrace/types.h>
43 #include <babeltrace/values.h>
44 #include <babeltrace/values-internal.h>
45 #include <babeltrace/assert-internal.h>
46 #include <babeltrace/assert-pre-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 finalize_component(struct bt_component
*comp
)
68 typedef void (*method_t
)(void *);
70 method_t method
= NULL
;
74 switch (comp
->class->type
) {
75 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
77 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
79 method
= (method_t
) src_cc
->methods
.finalize
;
82 case BT_COMPONENT_CLASS_TYPE_FILTER
:
84 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
86 method
= (method_t
) flt_cc
->methods
.finalize
;
89 case BT_COMPONENT_CLASS_TYPE_SINK
:
91 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
93 method
= (method_t
) sink_cc
->methods
.finalize
;
101 BT_LIB_LOGD("Calling user's finalization method: "
102 "%![comp-]+c", comp
);
108 void destroy_component(struct bt_object
*obj
)
110 struct bt_component
*component
= NULL
;
118 * The component's reference count is 0 if we're here. Increment
119 * it to avoid a double-destroy (possibly infinitely recursive).
120 * This could happen for example if the component's finalization
121 * function does bt_object_get_ref() (or anything that causes
122 * bt_object_get_ref() to be called) on itself (ref. count goes
123 * from 0 to 1), and then bt_object_put_ref(): the reference
124 * count would go from 1 to 0 again and this function would be
128 component
= container_of(obj
, struct bt_component
, base
);
129 BT_LIB_LOGD("Destroying component: %![comp-]+c, %![graph-]+g",
130 component
, bt_component_borrow_graph(component
));
132 /* Call destroy listeners in reverse registration order */
133 BT_LOGD_STR("Calling destroy listeners.");
135 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
136 struct bt_component_destroy_listener
*listener
=
137 &g_array_index(component
->destroy_listeners
,
138 struct bt_component_destroy_listener
, i
);
140 listener
->func(component
, listener
->data
);
144 * User data is destroyed first, followed by the concrete
145 * component instance. Do not finalize if the component's user
146 * initialization method failed in the first place.
148 if (component
->initialized
) {
149 finalize_component(component
);
152 if (component
->destroy
) {
153 BT_LOGD_STR("Destroying type-specific data.");
154 component
->destroy(component
);
157 if (component
->input_ports
) {
158 BT_LOGD_STR("Destroying input ports.");
159 g_ptr_array_free(component
->input_ports
, TRUE
);
160 component
->input_ports
= NULL
;
163 if (component
->output_ports
) {
164 BT_LOGD_STR("Destroying output ports.");
165 g_ptr_array_free(component
->output_ports
, TRUE
);
166 component
->output_ports
= NULL
;
169 if (component
->destroy_listeners
) {
170 g_array_free(component
->destroy_listeners
, TRUE
);
171 component
->destroy_listeners
= NULL
;
174 if (component
->name
) {
175 g_string_free(component
->name
, TRUE
);
176 component
->name
= NULL
;
179 BT_LOGD_STR("Putting component class.");
180 BT_OBJECT_PUT_REF_AND_RESET(component
->class);
184 enum bt_component_class_type
bt_component_get_class_type(
185 struct bt_component
*component
)
187 BT_ASSERT_PRE_NON_NULL(component
, "Component");
188 return component
->class->type
;
192 struct bt_port
*add_port(
193 struct bt_component
*component
, GPtrArray
*ports
,
194 enum bt_port_type port_type
, const char *name
, void *user_data
)
196 struct bt_port
*new_port
= NULL
;
197 struct bt_graph
*graph
= NULL
;
199 BT_ASSERT_PRE_NON_NULL(component
, "Component");
200 BT_ASSERT_PRE_NON_NULL(name
, "Name");
201 BT_ASSERT_PRE(strlen(name
) > 0, "Name is empty");
202 graph
= bt_component_borrow_graph(component
);
203 BT_ASSERT_PRE(graph
&& !bt_graph_is_canceled(graph
),
204 "Component's graph is canceled: %![comp-]+c, %![graph-]+g",
207 // TODO: Validate that the name is not already used.
209 BT_LIB_LOGD("Adding port to component: %![comp-]+c, "
210 "port-type=%s, port-name=\"%s\"", component
,
211 bt_port_type_string(port_type
), name
);
213 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
215 BT_LOGE_STR("Cannot create port object.");
220 * No name clash, add the port.
221 * The component is now the port's parent; it should _not_
222 * hold a reference to the port since the port's lifetime
223 * is now protected by the component's own lifetime.
225 g_ptr_array_add(ports
, new_port
);
228 * Notify the graph's creator that a new port was added.
230 bt_object_get_ref(bt_component_borrow_graph(component
));
231 graph
= bt_component_borrow_graph(component
);
233 bt_graph_notify_port_added(graph
, new_port
);
234 BT_OBJECT_PUT_REF_AND_RESET(graph
);
237 BT_LIB_LOGD("Created and added port to component: "
238 "%![comp-]+c, %![port-]+p", component
, new_port
);
245 uint64_t bt_component_get_input_port_count(struct bt_component
*comp
)
247 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
248 return (uint64_t) comp
->input_ports
->len
;
252 uint64_t bt_component_get_output_port_count(struct bt_component
*comp
)
254 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
255 return (uint64_t) comp
->output_ports
->len
;
259 int bt_component_create(struct bt_component_class
*component_class
,
260 const char *name
, struct bt_component
**user_component
)
263 struct bt_component
*component
= NULL
;
264 enum bt_component_class_type type
;
266 BT_ASSERT(user_component
);
267 BT_ASSERT(component_class
);
270 type
= bt_component_class_get_type(component_class
);
271 BT_LIB_LOGD("Creating empty component from component class: %![cc-]+C, "
272 "comp-name=\"%s\"", component_class
, name
);
273 component
= component_create_funcs
[type
](component_class
);
275 BT_LOGE_STR("Cannot create specific component object.");
280 bt_object_init_shared_with_parent(&component
->base
,
282 component
->class = component_class
;
283 bt_object_get_no_null_check(component
->class);
284 component
->destroy
= component_destroy_funcs
[type
];
285 component
->name
= g_string_new(name
);
286 if (!component
->name
) {
287 BT_LOGE_STR("Failed to allocate one GString.");
292 component
->input_ports
= g_ptr_array_new_with_free_func(
293 (GDestroyNotify
) bt_object_try_spec_release
);
294 if (!component
->input_ports
) {
295 BT_LOGE_STR("Failed to allocate one GPtrArray.");
300 component
->output_ports
= g_ptr_array_new_with_free_func(
301 (GDestroyNotify
) bt_object_try_spec_release
);
302 if (!component
->output_ports
) {
303 BT_LOGE_STR("Failed to allocate one GPtrArray.");
308 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
309 sizeof(struct bt_component_destroy_listener
));
310 if (!component
->destroy_listeners
) {
311 BT_LOGE_STR("Failed to allocate one GArray.");
316 BT_LIB_LOGD("Created empty component from component class: "
317 "%![cc-]+C, %![comp-]+c", component_class
, component
);
318 BT_OBJECT_MOVE_REF(*user_component
, component
);
321 bt_object_put_ref(component
);
325 const char *bt_component_get_name(struct bt_component
*component
)
327 BT_ASSERT_PRE_NON_NULL(component
, "Component");
328 return component
->name
->str
;
331 struct bt_component_class
*bt_component_borrow_class(
332 struct bt_component
*component
)
334 BT_ASSERT_PRE_NON_NULL(component
, "Component");
335 return component
->class;
338 void *bt_self_component_get_data(struct bt_self_component
*self_comp
)
340 struct bt_component
*component
= (void *) self_comp
;
342 BT_ASSERT_PRE_NON_NULL(component
, "Component");
343 return component
->user_data
;
346 void bt_self_component_set_data(struct bt_self_component
*self_comp
,
349 struct bt_component
*component
= (void *) self_comp
;
351 BT_ASSERT_PRE_NON_NULL(component
, "Component");
352 component
->user_data
= data
;
353 BT_LIB_LOGV("Set component's user data: %!+c", component
);
357 void bt_component_set_graph(struct bt_component
*component
,
358 struct bt_graph
*graph
)
360 bt_object_set_parent(&component
->base
,
361 graph
? &graph
->base
: NULL
);
364 bt_bool
bt_component_graph_is_canceled(struct bt_component
*component
)
366 return bt_graph_is_canceled(
367 (void *) bt_object_borrow_parent(&component
->base
));
371 struct bt_port
*borrow_port_by_name(GPtrArray
*ports
,
375 struct bt_port
*ret_port
= NULL
;
379 for (i
= 0; i
< ports
->len
; i
++) {
380 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
382 if (!strcmp(name
, port
->name
->str
)) {
392 struct bt_port_input
*bt_component_borrow_input_port_by_name(
393 struct bt_component
*comp
, const char *name
)
396 return (void *) borrow_port_by_name(comp
->input_ports
, name
);
400 struct bt_port_output
*bt_component_borrow_output_port_by_name(
401 struct bt_component
*comp
, const char *name
)
403 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
405 borrow_port_by_name(comp
->output_ports
, name
);
409 struct bt_port
*borrow_port_by_index(GPtrArray
*ports
, uint64_t index
)
411 BT_ASSERT(index
< ports
->len
);
412 return g_ptr_array_index(ports
, index
);
416 struct bt_port_input
*bt_component_borrow_input_port_by_index(
417 struct bt_component
*comp
, uint64_t index
)
419 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
420 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->input_ports
->len
);
422 borrow_port_by_index(comp
->input_ports
, index
);
426 struct bt_port_output
*bt_component_borrow_output_port_by_index(
427 struct bt_component
*comp
, uint64_t index
)
429 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
430 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->output_ports
->len
);
432 borrow_port_by_index(comp
->output_ports
, index
);
436 struct bt_port_input
*bt_component_add_input_port(
437 struct bt_component
*component
, const char *name
,
440 /* add_port() logs details */
442 add_port(component
, component
->input_ports
,
443 BT_PORT_TYPE_INPUT
, name
, user_data
);
447 struct bt_port_output
*bt_component_add_output_port(
448 struct bt_component
*component
, const char *name
,
451 /* add_port() logs details */
453 add_port(component
, component
->output_ports
,
454 BT_PORT_TYPE_OUTPUT
, name
, user_data
);
458 void remove_port_by_index(struct bt_component
*component
,
459 GPtrArray
*ports
, uint64_t index
)
461 struct bt_port
*port
;
462 struct bt_graph
*graph
;
465 BT_ASSERT(index
< ports
->len
);
466 port
= g_ptr_array_index(ports
, index
);
467 BT_LIB_LOGD("Removing port from component: %![comp-]+c, %![port-]+p",
470 /* Disconnect both ports of this port's connection, if any */
471 if (port
->connection
) {
472 bt_connection_end(port
->connection
, true);
476 * The port's current reference count can be 0 at this point,
477 * which means its parent (component) keeps it alive. We are
478 * about to remove the port from its parent's container (with
479 * the g_ptr_array_remove_index() call below), which in this
480 * case would destroy it. This is not good because we still
481 * need the port for the bt_graph_notify_port_removed() call
482 * below (in which its component is `NULL` as expected because
483 * of the bt_object_set_parent() call below).
485 * To avoid a destroyed port during the notification callback,
486 * get a reference now, and put it (destroying the port if its
487 * reference count is 0 at this point) after notifying the
488 * private graph's user.
490 bt_object_get_no_null_check(&port
->base
);
493 * Remove from parent's array of ports (weak refs). This never
494 * destroys the port object because its reference count is at
495 * least 1 thanks to the bt_object_get_no_null_check() call
498 g_ptr_array_remove_index(ports
, index
);
500 /* Detach port from its component parent */
501 bt_object_set_parent(&port
->base
, NULL
);
504 * Notify the graph's creator that a port is removed.
506 graph
= bt_component_borrow_graph(component
);
508 bt_graph_notify_port_removed(graph
, component
, port
);
511 BT_LIB_LOGD("Removed port from component: %![comp-]+c, %![port-]+p",
515 * Put the local reference. If this port's reference count was 0
516 * when entering this function, it is 1 now, so it is destroyed
519 bt_object_put_no_null_check(&port
->base
);
523 void bt_component_remove_port(struct bt_component
*component
,
524 struct bt_port
*port
)
527 GPtrArray
*ports
= NULL
;
529 BT_ASSERT(component
);
532 switch (port
->type
) {
533 case BT_PORT_TYPE_INPUT
:
534 ports
= component
->input_ports
;
536 case BT_PORT_TYPE_OUTPUT
:
537 ports
= component
->output_ports
;
545 for (i
= 0; i
< ports
->len
; i
++) {
546 struct bt_port
*cur_port
= g_ptr_array_index(ports
, i
);
548 if (cur_port
== port
) {
549 remove_port_by_index(component
,
555 BT_LIB_LOGW("Port to remove from component was not found: "
556 "%![comp-]+c, %![port-]+p", component
, port
);
563 enum bt_self_component_status
bt_component_accept_port_connection(
564 struct bt_component
*comp
, struct bt_port
*self_port
,
565 struct bt_port
*other_port
)
567 typedef enum bt_self_component_status (*method_t
)(
568 void *, void *, void *);
570 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
571 method_t method
= NULL
;
574 BT_ASSERT(self_port
);
575 BT_ASSERT(other_port
);
577 switch (comp
->class->type
) {
578 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
580 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
582 switch (self_port
->type
) {
583 case BT_PORT_TYPE_OUTPUT
:
584 method
= (method_t
) src_cc
->methods
.accept_output_port_connection
;
592 case BT_COMPONENT_CLASS_TYPE_FILTER
:
594 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
596 switch (self_port
->type
) {
597 case BT_PORT_TYPE_INPUT
:
598 method
= (method_t
) flt_cc
->methods
.accept_input_port_connection
;
600 case BT_PORT_TYPE_OUTPUT
:
601 method
= (method_t
) flt_cc
->methods
.accept_output_port_connection
;
609 case BT_COMPONENT_CLASS_TYPE_SINK
:
611 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
613 switch (self_port
->type
) {
614 case BT_PORT_TYPE_INPUT
:
615 method
= (method_t
) sink_cc
->methods
.accept_input_port_connection
;
628 BT_LIB_LOGD("Calling user's \"accept port connection\" method: "
629 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
630 comp
, self_port
, other_port
);
631 status
= method(comp
, self_port
, other_port
);
632 BT_LOGD("User method returned: status=%s",
633 bt_self_component_status_string(status
));
640 enum bt_self_component_status
bt_component_port_connected(
641 struct bt_component
*comp
, struct bt_port
*self_port
,
642 struct bt_port
*other_port
)
644 typedef enum bt_self_component_status (*method_t
)(
645 void *, void *, void *);
647 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
648 method_t method
= NULL
;
651 BT_ASSERT(self_port
);
652 BT_ASSERT(other_port
);
654 switch (comp
->class->type
) {
655 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
657 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
659 switch (self_port
->type
) {
660 case BT_PORT_TYPE_OUTPUT
:
661 method
= (method_t
) src_cc
->methods
.output_port_connected
;
669 case BT_COMPONENT_CLASS_TYPE_FILTER
:
671 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
673 switch (self_port
->type
) {
674 case BT_PORT_TYPE_INPUT
:
675 method
= (method_t
) flt_cc
->methods
.input_port_connected
;
677 case BT_PORT_TYPE_OUTPUT
:
678 method
= (method_t
) flt_cc
->methods
.output_port_connected
;
686 case BT_COMPONENT_CLASS_TYPE_SINK
:
688 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
690 switch (self_port
->type
) {
691 case BT_PORT_TYPE_INPUT
:
692 method
= (method_t
) sink_cc
->methods
.input_port_connected
;
705 BT_LIB_LOGD("Calling user's \"port connected\" method: "
706 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
707 comp
, self_port
, other_port
);
708 status
= method(comp
, self_port
, other_port
);
709 BT_LOGD("User method returned: status=%s",
710 bt_self_component_status_string(status
));
717 void bt_component_port_disconnected(struct bt_component
*comp
,
718 struct bt_port
*port
)
720 typedef void (*method_t
)(void *, void *);
722 method_t method
= NULL
;
727 switch (comp
->class->type
) {
728 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
730 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
732 switch (port
->type
) {
733 case BT_PORT_TYPE_OUTPUT
:
734 method
= (method_t
) src_cc
->methods
.output_port_disconnected
;
742 case BT_COMPONENT_CLASS_TYPE_FILTER
:
744 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
746 switch (port
->type
) {
747 case BT_PORT_TYPE_INPUT
:
748 method
= (method_t
) flt_cc
->methods
.input_port_disconnected
;
750 case BT_PORT_TYPE_OUTPUT
:
751 method
= (method_t
) flt_cc
->methods
.output_port_disconnected
;
759 case BT_COMPONENT_CLASS_TYPE_SINK
:
761 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
763 switch (port
->type
) {
764 case BT_PORT_TYPE_INPUT
:
765 method
= (method_t
) sink_cc
->methods
.input_port_disconnected
;
778 BT_LIB_LOGD("Calling user's \"port disconnected\" method: "
779 "%![comp-]+c, %![port-]+p", comp
, port
);
785 void bt_component_add_destroy_listener(struct bt_component
*component
,
786 bt_component_destroy_listener_func func
, void *data
)
788 struct bt_component_destroy_listener listener
;
790 BT_ASSERT(component
);
792 listener
.func
= func
;
793 listener
.data
= data
;
794 g_array_append_val(component
->destroy_listeners
, listener
);
795 BT_LIB_LOGV("Added destroy listener: %![comp-]+c, "
796 "func-addr=%p, data-addr=%p",
797 component
, func
, data
);
801 void bt_component_remove_destroy_listener(struct bt_component
*component
,
802 bt_component_destroy_listener_func func
, void *data
)
806 BT_ASSERT(component
);
809 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
810 struct bt_component_destroy_listener
*listener
=
811 &g_array_index(component
->destroy_listeners
,
812 struct bt_component_destroy_listener
, i
);
814 if (listener
->func
== func
&& listener
->data
== data
) {
815 g_array_remove_index(component
->destroy_listeners
, i
);
817 BT_LIB_LOGV("Removed destroy listener: %![comp-]+c, "
818 "func-addr=%p, data-addr=%p",
819 component
, func
, data
);