2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #define BT_LOG_TAG "LIB/COMPONENT"
9 #include "lib/logging.h"
11 #include "common/common.h"
12 #include "common/assert.h"
13 #include "lib/assert-cond.h"
14 #include <babeltrace2/graph/self-component.h>
15 #include <babeltrace2/graph/component.h>
16 #include <babeltrace2/graph/graph.h>
17 #include "common/macros.h"
18 #include "compat/compiler.h"
19 #include <babeltrace2/types.h>
20 #include <babeltrace2/value.h>
21 #include "lib/value.h"
25 #include "component.h"
26 #include "component-class.h"
27 #include "component-source.h"
28 #include "component-filter.h"
29 #include "component-sink.h"
30 #include "connection.h"
32 #include "message/iterator.h"
34 #include "lib/func-status.h"
37 struct bt_component
* (* const component_create_funcs
[])(
38 const struct bt_component_class
*) = {
39 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
40 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
41 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
45 void (*component_destroy_funcs
[])(struct bt_component
*) = {
46 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
47 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
48 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
52 void finalize_component(struct bt_component
*comp
)
54 typedef void (*method_t
)(void *);
55 const char *method_name
;
57 method_t method
= NULL
;
61 switch (comp
->class->type
) {
62 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
64 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
66 method
= (method_t
) src_cc
->methods
.finalize
;
67 method_name
= "bt_component_class_source_finalize_method";
70 case BT_COMPONENT_CLASS_TYPE_FILTER
:
72 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
74 method
= (method_t
) flt_cc
->methods
.finalize
;
75 method_name
= "bt_component_class_filter_finalize_method";
78 case BT_COMPONENT_CLASS_TYPE_SINK
:
80 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
82 method
= (method_t
) sink_cc
->methods
.finalize
;
83 method_name
= "bt_component_class_sink_finalize_method";
91 const struct bt_error
*saved_error
;
93 saved_error
= bt_current_thread_take_error();
95 BT_LIB_LOGI("Calling user's component finalization method: "
98 BT_ASSERT_POST_NO_ERROR(method_name
);
101 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error
);
107 void destroy_component(struct bt_object
*obj
)
109 struct bt_component
*component
= NULL
;
117 * The component's reference count is 0 if we're here. Increment
118 * it to avoid a double-destroy (possibly infinitely recursive).
119 * This could happen for example if the component's finalization
120 * function does bt_object_get_ref() (or anything that causes
121 * bt_object_get_ref() to be called) on itself (ref. count goes
122 * from 0 to 1), and then bt_object_put_ref(): the reference
123 * count would go from 1 to 0 again and this function would be
127 component
= container_of(obj
, struct bt_component
, base
);
128 BT_LIB_LOGI("Destroying component: %![comp-]+c, %![graph-]+g",
129 component
, bt_component_borrow_graph(component
));
131 /* Call destroy listeners in reverse registration order */
132 BT_LOGD_STR("Calling destroy listeners.");
134 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
135 struct bt_component_destroy_listener
*listener
=
136 &g_array_index(component
->destroy_listeners
,
137 struct bt_component_destroy_listener
, i
);
139 listener
->func(component
, listener
->data
);
143 * User data is destroyed first, followed by the concrete
144 * component instance. Do not finalize if the component's user
145 * initialization method failed in the first place.
147 if (component
->initialized
) {
148 finalize_component(component
);
151 if (component
->destroy
) {
152 BT_LOGD_STR("Destroying type-specific data.");
153 component
->destroy(component
);
156 if (component
->input_ports
) {
157 BT_LOGD_STR("Destroying input ports.");
158 g_ptr_array_free(component
->input_ports
, TRUE
);
159 component
->input_ports
= NULL
;
162 if (component
->output_ports
) {
163 BT_LOGD_STR("Destroying output ports.");
164 g_ptr_array_free(component
->output_ports
, TRUE
);
165 component
->output_ports
= NULL
;
168 if (component
->destroy_listeners
) {
169 g_array_free(component
->destroy_listeners
, TRUE
);
170 component
->destroy_listeners
= NULL
;
173 if (component
->name
) {
174 g_string_free(component
->name
, TRUE
);
175 component
->name
= NULL
;
178 BT_LOGD_STR("Putting component class.");
179 BT_OBJECT_PUT_REF_AND_RESET(component
->class);
183 enum bt_component_class_type
bt_component_get_class_type(
184 const struct bt_component
*component
)
186 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
187 return component
->class->type
;
191 enum bt_self_component_add_port_status
add_port(
192 struct bt_component
*component
, GPtrArray
*ports
,
193 enum bt_port_type port_type
, const char *name
, void *user_data
,
194 struct bt_port
**port
, const char *api_func
)
196 struct bt_port
*new_port
= NULL
;
197 struct bt_graph
*graph
= NULL
;
198 enum bt_self_component_add_port_status status
;
200 BT_ASSERT(component
);
202 BT_ASSERT_PRE_FROM_FUNC(api_func
, "name-is-not-empty",
203 strlen(name
) > 0, "Name is empty");
204 graph
= bt_component_borrow_graph(component
);
205 BT_ASSERT_PRE_FROM_FUNC(api_func
, "graph-is-not-configured",
206 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
207 "Component's graph is already configured: "
208 "%![comp-]+c, %![graph-]+g", component
, graph
);
210 // TODO: Validate that the name is not already used.
212 BT_LIB_LOGI("Adding port to component: %![comp-]+c, "
213 "port-type=%s, port-name=\"%s\"", component
,
214 bt_port_type_string(port_type
), name
);
216 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
218 BT_LIB_LOGE_APPEND_CAUSE("Cannot create port object.");
219 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
224 * No name clash, add the port.
225 * The component is now the port's parent; it should _not_
226 * hold a reference to the port since the port's lifetime
227 * is now protected by the component's own lifetime.
229 g_ptr_array_add(ports
, new_port
);
232 * Notify the graph's creator that a new port was added.
234 graph
= bt_component_borrow_graph(component
);
236 enum bt_graph_listener_func_status listener_status
;
238 listener_status
= bt_graph_notify_port_added(graph
, new_port
);
239 if (listener_status
!= BT_FUNC_STATUS_OK
) {
240 bt_graph_make_faulty(graph
);
241 status
= (int) listener_status
;
246 BT_LIB_LOGI("Created and added port to component: "
247 "%![comp-]+c, %![port-]+p", component
, new_port
);
250 status
= BT_FUNC_STATUS_OK
;
255 * We need to release the reference that we would otherwise have
256 * returned to the caller.
258 BT_PORT_PUT_REF_AND_RESET(new_port
);
265 uint64_t bt_component_get_input_port_count(const struct bt_component
*comp
,
266 const char *api_func
)
268 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
269 return (uint64_t) comp
->input_ports
->len
;
273 uint64_t bt_component_get_output_port_count(const struct bt_component
*comp
,
274 const char *api_func
)
276 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
277 return (uint64_t) comp
->output_ports
->len
;
281 int bt_component_create(struct bt_component_class
*component_class
,
282 const char *name
, bt_logging_level log_level
,
283 struct bt_component
**user_component
)
286 struct bt_component
*component
= NULL
;
287 enum bt_component_class_type type
;
289 BT_ASSERT(user_component
);
290 BT_ASSERT(component_class
);
292 type
= bt_component_class_get_type(component_class
);
293 BT_LIB_LOGI("Creating empty component from component class: %![cc-]+C, "
294 "comp-name=\"%s\", log-level=%s", component_class
, name
,
295 bt_common_logging_level_string(log_level
));
296 component
= component_create_funcs
[type
](component_class
);
298 BT_LIB_LOGE_APPEND_CAUSE(
299 "Cannot create specific component object.");
304 bt_object_init_shared_with_parent(&component
->base
, destroy_component
);
305 component
->class = component_class
;
306 bt_object_get_ref_no_null_check(component
->class);
307 component
->destroy
= component_destroy_funcs
[type
];
308 component
->name
= g_string_new(name
);
309 if (!component
->name
) {
310 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
315 component
->log_level
= log_level
;
316 component
->input_ports
= g_ptr_array_new_with_free_func(
317 (GDestroyNotify
) bt_object_try_spec_release
);
318 if (!component
->input_ports
) {
319 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
324 component
->output_ports
= g_ptr_array_new_with_free_func(
325 (GDestroyNotify
) bt_object_try_spec_release
);
326 if (!component
->output_ports
) {
327 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
332 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
333 sizeof(struct bt_component_destroy_listener
));
334 if (!component
->destroy_listeners
) {
335 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
340 BT_LIB_LOGI("Created empty component from component class: "
341 "%![cc-]+C, %![comp-]+c", component_class
, component
);
342 BT_OBJECT_MOVE_REF(*user_component
, component
);
345 bt_object_put_ref(component
);
349 const char *bt_component_get_name(const struct bt_component
*component
)
351 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
352 return component
->name
->str
;
355 const struct bt_component_class
*bt_component_borrow_class_const(
356 const struct bt_component
*component
)
358 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
359 return component
->class;
362 void *bt_self_component_get_data(const struct bt_self_component
*self_comp
)
364 struct bt_component
*component
= (void *) self_comp
;
366 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
367 return component
->user_data
;
370 void bt_self_component_set_data(struct bt_self_component
*self_comp
,
373 struct bt_component
*component
= (void *) self_comp
;
375 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
376 component
->user_data
= data
;
377 BT_LIB_LOGD("Set component's user data: %!+c", component
);
381 void bt_component_set_graph(struct bt_component
*component
,
382 struct bt_graph
*graph
)
384 bt_object_set_parent(&component
->base
,
385 graph
? &graph
->base
: NULL
);
389 struct bt_port
*borrow_port_by_name(GPtrArray
*ports
,
390 const char *name
, const char *api_func
)
393 struct bt_port
*ret_port
= NULL
;
395 BT_ASSERT_PRE_DEV_NAME_NON_NULL_FROM_FUNC(api_func
, name
);
397 for (i
= 0; i
< ports
->len
; i
++) {
398 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
400 if (strcmp(name
, port
->name
->str
) == 0) {
410 struct bt_port_input
*bt_component_borrow_input_port_by_name(
411 struct bt_component
*comp
, const char *name
,
412 const char *api_func
)
414 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
415 return (void *) borrow_port_by_name(comp
->input_ports
, name
, api_func
);
419 struct bt_port_output
*bt_component_borrow_output_port_by_name(
420 struct bt_component
*comp
, const char *name
,
421 const char *api_func
)
423 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
425 borrow_port_by_name(comp
->output_ports
, name
, api_func
);
429 struct bt_port
*borrow_port_by_index(GPtrArray
*ports
, uint64_t index
,
430 const char *api_func
)
432 BT_ASSERT_PRE_DEV_VALID_INDEX_FROM_FUNC(api_func
, index
, ports
->len
);
433 return g_ptr_array_index(ports
, index
);
437 struct bt_port_input
*bt_component_borrow_input_port_by_index(
438 struct bt_component
*comp
, uint64_t index
,
439 const char *api_func
)
441 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
443 borrow_port_by_index(comp
->input_ports
, index
, api_func
);
447 struct bt_port_output
*bt_component_borrow_output_port_by_index(
448 struct bt_component
*comp
, uint64_t index
,
449 const char *api_func
)
451 BT_ASSERT_PRE_DEV_COMP_NON_NULL_FROM_FUNC(api_func
, comp
);
453 borrow_port_by_index(comp
->output_ports
, index
, api_func
);
457 enum bt_self_component_add_port_status
bt_component_add_input_port(
458 struct bt_component
*component
, const char *name
,
459 void *user_data
, struct bt_port
**port
, const char *api_func
)
461 BT_ASSERT_PRE_COMP_NON_NULL_FROM_FUNC(api_func
, component
);
462 BT_ASSERT_PRE_NAME_NON_NULL_FROM_FUNC(api_func
, name
);
463 BT_ASSERT_PRE_FROM_FUNC(api_func
, "input-port-name-is-unique",
464 bt_component_port_name_is_unique(component
->input_ports
, name
),
465 "Input port name is not unique: name=\"%s\", %![comp-]c",
468 /* add_port() logs details and checks preconditions */
469 return add_port(component
, component
->input_ports
,
470 BT_PORT_TYPE_INPUT
, name
, user_data
, port
, api_func
);
474 enum bt_self_component_add_port_status
bt_component_add_output_port(
475 struct bt_component
*component
, const char *name
,
476 void *user_data
, struct bt_port
**port
,
477 const char *api_func
)
479 BT_ASSERT_PRE_COMP_NON_NULL_FROM_FUNC(api_func
, component
);
480 BT_ASSERT_PRE_NAME_NON_NULL_FROM_FUNC(api_func
, name
);
481 BT_ASSERT_PRE_FROM_FUNC(api_func
, "output-port-name-is-unique",
482 bt_component_port_name_is_unique(component
->output_ports
, name
),
483 "Output port name is not unique: name=\"%s\", %![comp-]c",
486 /* add_port() logs details and checks preconditions */
487 return add_port(component
, component
->output_ports
,
488 BT_PORT_TYPE_OUTPUT
, name
, user_data
, port
, api_func
);
492 bool bt_component_port_name_is_unique(GPtrArray
*ports
, const char *name
)
497 for (i
= 0; i
< ports
->len
; i
++) {
498 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
500 if (strcmp(port
->name
->str
, name
) == 0) {
513 enum bt_component_class_port_connected_method_status
514 bt_component_port_connected(
515 struct bt_component
*comp
, struct bt_port
*self_port
,
516 struct bt_port
*other_port
)
518 typedef enum bt_component_class_port_connected_method_status (*method_t
)(
519 void *, void *, const void *);
521 enum bt_component_class_port_connected_method_status status
=
523 method_t method
= NULL
;
524 const char *method_name
= NULL
;
527 BT_ASSERT(self_port
);
528 BT_ASSERT(other_port
);
530 switch (comp
->class->type
) {
531 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
533 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
535 switch (self_port
->type
) {
536 case BT_PORT_TYPE_OUTPUT
:
537 method
= (method_t
) src_cc
->methods
.output_port_connected
;
538 method_name
= "bt_component_class_source_output_port_connected_method";
546 case BT_COMPONENT_CLASS_TYPE_FILTER
:
548 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
550 switch (self_port
->type
) {
551 case BT_PORT_TYPE_INPUT
:
552 method
= (method_t
) flt_cc
->methods
.input_port_connected
;
553 method_name
= "bt_component_class_filter_input_port_connected_method";
555 case BT_PORT_TYPE_OUTPUT
:
556 method
= (method_t
) flt_cc
->methods
.output_port_connected
;
557 method_name
= "bt_component_class_filter_output_port_connected_method";
565 case BT_COMPONENT_CLASS_TYPE_SINK
:
567 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
569 switch (self_port
->type
) {
570 case BT_PORT_TYPE_INPUT
:
571 method
= (method_t
) sink_cc
->methods
.input_port_connected
;
572 method_name
= "bt_component_class_sink_input_port_connected_method";
585 BT_LIB_LOGD("Calling user's \"port connected\" method: "
586 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
587 comp
, self_port
, other_port
);
588 status
= (int) method(comp
, self_port
, (void *) other_port
);
589 BT_LOGD("User method returned: status=%s",
590 bt_common_func_status_string(status
));
591 BT_ASSERT_POST(method_name
, "valid-status",
592 status
== BT_FUNC_STATUS_OK
||
593 status
== BT_FUNC_STATUS_ERROR
||
594 status
== BT_FUNC_STATUS_MEMORY_ERROR
,
595 "Unexpected returned component status: status=%s",
596 bt_common_func_status_string(status
));
597 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(method_name
, status
);
604 void bt_component_add_destroy_listener(struct bt_component
*component
,
605 bt_component_destroy_listener_func func
, void *data
)
607 struct bt_component_destroy_listener listener
;
609 BT_ASSERT(component
);
611 listener
.func
= func
;
612 listener
.data
= data
;
613 g_array_append_val(component
->destroy_listeners
, listener
);
614 BT_LIB_LOGD("Added destroy listener: %![comp-]+c, "
615 "func-addr=%p, data-addr=%p",
616 component
, func
, data
);
620 void bt_component_remove_destroy_listener(struct bt_component
*component
,
621 bt_component_destroy_listener_func func
, void *data
)
625 BT_ASSERT(component
);
628 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
629 struct bt_component_destroy_listener
*listener
=
630 &g_array_index(component
->destroy_listeners
,
631 struct bt_component_destroy_listener
, i
);
633 if (listener
->func
== func
&& listener
->data
== data
) {
634 g_array_remove_index(component
->destroy_listeners
, i
);
636 BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, "
637 "func-addr=%p, data-addr=%p",
638 component
, func
, data
);
643 bt_logging_level
bt_component_get_logging_level(
644 const struct bt_component
*component
)
646 BT_ASSERT_PRE_DEV_COMP_NON_NULL(component
);
647 return component
->log_level
;
650 uint64_t bt_self_component_get_graph_mip_version(
651 bt_self_component
*self_component
)
653 struct bt_component
*comp
= (void *) self_component
;
655 BT_ASSERT_PRE_COMP_NON_NULL(self_component
);
656 return bt_component_borrow_graph(comp
)->mip_version
;
659 void bt_component_get_ref(const struct bt_component
*component
)
661 bt_object_get_ref(component
);
664 void bt_component_put_ref(const struct bt_component
*component
)
666 bt_object_put_ref(component
);