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 graph
= bt_object_get_ref(bt_component_borrow_graph(component
));
232 bt_graph_notify_port_added(graph
, new_port
);
233 BT_OBJECT_PUT_REF_AND_RESET(graph
);
236 BT_LIB_LOGD("Created and added port to component: "
237 "%![comp-]+c, %![port-]+p", component
, new_port
);
244 uint64_t bt_component_get_input_port_count(struct bt_component
*comp
)
246 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
247 return (uint64_t) comp
->input_ports
->len
;
251 uint64_t bt_component_get_output_port_count(struct bt_component
*comp
)
253 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
254 return (uint64_t) comp
->output_ports
->len
;
258 int bt_component_create(struct bt_component_class
*component_class
,
259 const char *name
, struct bt_component
**user_component
)
262 struct bt_component
*component
= NULL
;
263 enum bt_component_class_type type
;
265 BT_ASSERT(user_component
);
266 BT_ASSERT(component_class
);
269 type
= bt_component_class_get_type(component_class
);
270 BT_LIB_LOGD("Creating empty component from component class: %![cc-]+C, "
271 "comp-name=\"%s\"", component_class
, name
);
272 component
= component_create_funcs
[type
](component_class
);
274 BT_LOGE_STR("Cannot create specific component object.");
279 bt_object_init_shared_with_parent(&component
->base
,
281 component
->class = bt_object_get_ref(component_class
);
282 component
->destroy
= component_destroy_funcs
[type
];
283 component
->name
= g_string_new(name
);
284 if (!component
->name
) {
285 BT_LOGE_STR("Failed to allocate one GString.");
290 component
->input_ports
= g_ptr_array_new_with_free_func(
291 (GDestroyNotify
) bt_object_try_spec_release
);
292 if (!component
->input_ports
) {
293 BT_LOGE_STR("Failed to allocate one GPtrArray.");
298 component
->output_ports
= g_ptr_array_new_with_free_func(
299 (GDestroyNotify
) bt_object_try_spec_release
);
300 if (!component
->output_ports
) {
301 BT_LOGE_STR("Failed to allocate one GPtrArray.");
306 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
307 sizeof(struct bt_component_destroy_listener
));
308 if (!component
->destroy_listeners
) {
309 BT_LOGE_STR("Failed to allocate one GArray.");
314 BT_LIB_LOGD("Created empty component from component class: "
315 "%![cc-]+C, %![comp-]+c", component_class
, component
);
316 BT_OBJECT_MOVE_REF(*user_component
, component
);
319 bt_object_put_ref(component
);
323 const char *bt_component_get_name(struct bt_component
*component
)
325 BT_ASSERT_PRE_NON_NULL(component
, "Component");
326 return component
->name
->str
;
329 struct bt_component_class
*bt_component_borrow_class(
330 struct bt_component
*component
)
332 BT_ASSERT_PRE_NON_NULL(component
, "Component");
333 return component
->class;
336 void *bt_self_component_get_data(struct bt_self_component
*self_comp
)
338 struct bt_component
*component
= (void *) self_comp
;
340 BT_ASSERT_PRE_NON_NULL(component
, "Component");
341 return component
->user_data
;
344 void bt_self_component_set_data(struct bt_self_component
*self_comp
,
347 struct bt_component
*component
= (void *) self_comp
;
349 BT_ASSERT_PRE_NON_NULL(component
, "Component");
350 component
->user_data
= data
;
351 BT_LIB_LOGV("Set component's user data: %!+c", component
);
355 void bt_component_set_graph(struct bt_component
*component
,
356 struct bt_graph
*graph
)
358 bt_object_set_parent(&component
->base
,
359 graph
? &graph
->base
: NULL
);
362 bt_bool
bt_component_graph_is_canceled(struct bt_component
*component
)
364 return bt_graph_is_canceled(
365 (void *) bt_object_borrow_parent(&component
->base
));
369 struct bt_port
*borrow_port_by_name(GPtrArray
*ports
,
373 struct bt_port
*ret_port
= NULL
;
377 for (i
= 0; i
< ports
->len
; i
++) {
378 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
380 if (!strcmp(name
, port
->name
->str
)) {
390 struct bt_port_input
*bt_component_borrow_input_port_by_name(
391 struct bt_component
*comp
, const char *name
)
394 return (void *) borrow_port_by_name(comp
->input_ports
, name
);
398 struct bt_port_output
*bt_component_borrow_output_port_by_name(
399 struct bt_component
*comp
, const char *name
)
401 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
403 borrow_port_by_name(comp
->output_ports
, name
);
407 struct bt_port
*borrow_port_by_index(GPtrArray
*ports
, uint64_t index
)
409 BT_ASSERT(index
< ports
->len
);
410 return g_ptr_array_index(ports
, index
);
414 struct bt_port_input
*bt_component_borrow_input_port_by_index(
415 struct bt_component
*comp
, uint64_t index
)
417 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
418 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->input_ports
->len
);
420 borrow_port_by_index(comp
->input_ports
, index
);
424 struct bt_port_output
*bt_component_borrow_output_port_by_index(
425 struct bt_component
*comp
, uint64_t index
)
427 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
428 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->output_ports
->len
);
430 borrow_port_by_index(comp
->output_ports
, index
);
434 struct bt_port_input
*bt_component_add_input_port(
435 struct bt_component
*component
, const char *name
,
438 /* add_port() logs details */
440 add_port(component
, component
->input_ports
,
441 BT_PORT_TYPE_INPUT
, name
, user_data
);
445 struct bt_port_output
*bt_component_add_output_port(
446 struct bt_component
*component
, const char *name
,
449 /* add_port() logs details */
451 add_port(component
, component
->output_ports
,
452 BT_PORT_TYPE_OUTPUT
, name
, user_data
);
456 void remove_port_by_index(struct bt_component
*component
,
457 GPtrArray
*ports
, uint64_t index
)
459 struct bt_port
*port
;
460 struct bt_graph
*graph
;
463 BT_ASSERT(index
< ports
->len
);
464 port
= g_ptr_array_index(ports
, index
);
465 BT_LIB_LOGD("Removing port from component: %![comp-]+c, %![port-]+p",
468 /* Disconnect both ports of this port's connection, if any */
469 if (port
->connection
) {
470 bt_connection_end(port
->connection
, true);
474 * The port's current reference count can be 0 at this point,
475 * which means its parent (component) keeps it alive. We are
476 * about to remove the port from its parent's container (with
477 * the g_ptr_array_remove_index() call below), which in this
478 * case would destroy it. This is not good because we still
479 * need the port for the bt_graph_notify_port_removed() call
480 * below (in which its component is `NULL` as expected because
481 * of the bt_object_set_parent() call below).
483 * To avoid a destroyed port during the notification callback,
484 * get a reference now, and put it (destroying the port if its
485 * reference count is 0 at this point) after notifying the
486 * private graph's user.
488 bt_object_get_no_null_check(&port
->base
);
491 * Remove from parent's array of ports (weak refs). This never
492 * destroys the port object because its reference count is at
493 * least 1 thanks to the bt_object_get_no_null_check() call
496 g_ptr_array_remove_index(ports
, index
);
498 /* Detach port from its component parent */
499 bt_object_set_parent(&port
->base
, NULL
);
502 * Notify the graph's creator that a port is removed.
504 graph
= bt_component_borrow_graph(component
);
506 bt_graph_notify_port_removed(graph
, component
, port
);
509 BT_LIB_LOGD("Removed port from component: %![comp-]+c, %![port-]+p",
513 * Put the local reference. If this port's reference count was 0
514 * when entering this function, it is 1 now, so it is destroyed
517 bt_object_put_no_null_check(&port
->base
);
521 void bt_component_remove_port(struct bt_component
*component
,
522 struct bt_port
*port
)
525 GPtrArray
*ports
= NULL
;
527 BT_ASSERT(component
);
530 switch (port
->type
) {
531 case BT_PORT_TYPE_INPUT
:
532 ports
= component
->input_ports
;
534 case BT_PORT_TYPE_OUTPUT
:
535 ports
= component
->output_ports
;
543 for (i
= 0; i
< ports
->len
; i
++) {
544 struct bt_port
*cur_port
= g_ptr_array_index(ports
, i
);
546 if (cur_port
== port
) {
547 remove_port_by_index(component
,
553 BT_LIB_LOGW("Port to remove from component was not found: "
554 "%![comp-]+c, %![port-]+p", component
, port
);
561 enum bt_self_component_status
bt_component_accept_port_connection(
562 struct bt_component
*comp
, struct bt_port
*self_port
,
563 struct bt_port
*other_port
)
565 typedef enum bt_self_component_status (*method_t
)(
566 void *, void *, void *);
568 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
569 method_t method
= NULL
;
572 BT_ASSERT(self_port
);
573 BT_ASSERT(other_port
);
575 switch (comp
->class->type
) {
576 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
578 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
580 switch (self_port
->type
) {
581 case BT_PORT_TYPE_OUTPUT
:
582 method
= (method_t
) src_cc
->methods
.accept_output_port_connection
;
590 case BT_COMPONENT_CLASS_TYPE_FILTER
:
592 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
594 switch (self_port
->type
) {
595 case BT_PORT_TYPE_INPUT
:
596 method
= (method_t
) flt_cc
->methods
.accept_input_port_connection
;
598 case BT_PORT_TYPE_OUTPUT
:
599 method
= (method_t
) flt_cc
->methods
.accept_output_port_connection
;
607 case BT_COMPONENT_CLASS_TYPE_SINK
:
609 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
611 switch (self_port
->type
) {
612 case BT_PORT_TYPE_INPUT
:
613 method
= (method_t
) sink_cc
->methods
.accept_input_port_connection
;
626 BT_LIB_LOGD("Calling user's \"accept port connection\" method: "
627 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
628 comp
, self_port
, other_port
);
629 status
= method(comp
, self_port
, other_port
);
630 BT_LOGD("User method returned: status=%s",
631 bt_self_component_status_string(status
));
638 enum bt_self_component_status
bt_component_port_connected(
639 struct bt_component
*comp
, struct bt_port
*self_port
,
640 struct bt_port
*other_port
)
642 typedef enum bt_self_component_status (*method_t
)(
643 void *, void *, void *);
645 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
646 method_t method
= NULL
;
649 BT_ASSERT(self_port
);
650 BT_ASSERT(other_port
);
652 switch (comp
->class->type
) {
653 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
655 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
657 switch (self_port
->type
) {
658 case BT_PORT_TYPE_OUTPUT
:
659 method
= (method_t
) src_cc
->methods
.output_port_connected
;
667 case BT_COMPONENT_CLASS_TYPE_FILTER
:
669 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
671 switch (self_port
->type
) {
672 case BT_PORT_TYPE_INPUT
:
673 method
= (method_t
) flt_cc
->methods
.input_port_connected
;
675 case BT_PORT_TYPE_OUTPUT
:
676 method
= (method_t
) flt_cc
->methods
.output_port_connected
;
684 case BT_COMPONENT_CLASS_TYPE_SINK
:
686 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
688 switch (self_port
->type
) {
689 case BT_PORT_TYPE_INPUT
:
690 method
= (method_t
) sink_cc
->methods
.input_port_connected
;
703 BT_LIB_LOGD("Calling user's \"port connected\" method: "
704 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
705 comp
, self_port
, other_port
);
706 status
= method(comp
, self_port
, other_port
);
707 BT_LOGD("User method returned: status=%s",
708 bt_self_component_status_string(status
));
715 void bt_component_port_disconnected(struct bt_component
*comp
,
716 struct bt_port
*port
)
718 typedef void (*method_t
)(void *, void *);
720 method_t method
= NULL
;
725 switch (comp
->class->type
) {
726 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
728 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
730 switch (port
->type
) {
731 case BT_PORT_TYPE_OUTPUT
:
732 method
= (method_t
) src_cc
->methods
.output_port_disconnected
;
740 case BT_COMPONENT_CLASS_TYPE_FILTER
:
742 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
744 switch (port
->type
) {
745 case BT_PORT_TYPE_INPUT
:
746 method
= (method_t
) flt_cc
->methods
.input_port_disconnected
;
748 case BT_PORT_TYPE_OUTPUT
:
749 method
= (method_t
) flt_cc
->methods
.output_port_disconnected
;
757 case BT_COMPONENT_CLASS_TYPE_SINK
:
759 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
761 switch (port
->type
) {
762 case BT_PORT_TYPE_INPUT
:
763 method
= (method_t
) sink_cc
->methods
.input_port_disconnected
;
776 BT_LIB_LOGD("Calling user's \"port disconnected\" method: "
777 "%![comp-]+c, %![port-]+p", comp
, port
);
783 void bt_component_add_destroy_listener(struct bt_component
*component
,
784 bt_component_destroy_listener_func func
, void *data
)
786 struct bt_component_destroy_listener listener
;
788 BT_ASSERT(component
);
790 listener
.func
= func
;
791 listener
.data
= data
;
792 g_array_append_val(component
->destroy_listeners
, listener
);
793 BT_LIB_LOGV("Added destroy listener: %![comp-]+c, "
794 "func-addr=%p, data-addr=%p",
795 component
, func
, data
);
799 void bt_component_remove_destroy_listener(struct bt_component
*component
,
800 bt_component_destroy_listener_func func
, void *data
)
804 BT_ASSERT(component
);
807 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
808 struct bt_component_destroy_listener
*listener
=
809 &g_array_index(component
->destroy_listeners
,
810 struct bt_component_destroy_listener
, i
);
812 if (listener
->func
== func
&& listener
->data
== data
) {
813 g_array_remove_index(component
->destroy_listeners
, i
);
815 BT_LIB_LOGV("Removed destroy listener: %![comp-]+c, "
816 "func-addr=%p, data-addr=%p",
817 component
, func
, data
);