2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "COMP"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/graph/self-component.h>
30 #include <babeltrace/graph/component-const.h>
31 #include <babeltrace/graph/component-source-const.h>
32 #include <babeltrace/graph/component-filter-const.h>
33 #include <babeltrace/graph/component-sink-const.h>
34 #include <babeltrace/graph/component-internal.h>
35 #include <babeltrace/graph/component-class-internal.h>
36 #include <babeltrace/graph/component-source-internal.h>
37 #include <babeltrace/graph/component-filter-internal.h>
38 #include <babeltrace/graph/component-sink-internal.h>
39 #include <babeltrace/graph/connection-internal.h>
40 #include <babeltrace/graph/graph-internal.h>
41 #include <babeltrace/graph/message-iterator-internal.h>
42 #include <babeltrace/graph/port-internal.h>
43 #include <babeltrace/babeltrace-internal.h>
44 #include <babeltrace/compiler-internal.h>
45 #include <babeltrace/types.h>
46 #include <babeltrace/value.h>
47 #include <babeltrace/value-internal.h>
52 struct bt_component
* (* const component_create_funcs
[])(
53 const struct bt_component_class
*) = {
54 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
55 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
56 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
60 void (*component_destroy_funcs
[])(struct bt_component
*) = {
61 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
62 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
63 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
67 void finalize_component(struct bt_component
*comp
)
69 typedef void (*method_t
)(void *);
71 method_t method
= NULL
;
75 switch (comp
->class->type
) {
76 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
78 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
80 method
= (method_t
) src_cc
->methods
.finalize
;
83 case BT_COMPONENT_CLASS_TYPE_FILTER
:
85 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
87 method
= (method_t
) flt_cc
->methods
.finalize
;
90 case BT_COMPONENT_CLASS_TYPE_SINK
:
92 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
94 method
= (method_t
) sink_cc
->methods
.finalize
;
102 BT_LIB_LOGD("Calling user's finalization method: "
103 "%![comp-]+c", comp
);
109 void destroy_component(struct bt_object
*obj
)
111 struct bt_component
*component
= NULL
;
119 * The component's reference count is 0 if we're here. Increment
120 * it to avoid a double-destroy (possibly infinitely recursive).
121 * This could happen for example if the component's finalization
122 * function does bt_object_get_ref() (or anything that causes
123 * bt_object_get_ref() to be called) on itself (ref. count goes
124 * from 0 to 1), and then bt_object_put_ref(): the reference
125 * count would go from 1 to 0 again and this function would be
129 component
= container_of(obj
, struct bt_component
, base
);
130 BT_LIB_LOGD("Destroying component: %![comp-]+c, %![graph-]+g",
131 component
, bt_component_borrow_graph(component
));
133 /* Call destroy listeners in reverse registration order */
134 BT_LOGD_STR("Calling destroy listeners.");
136 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
137 struct bt_component_destroy_listener
*listener
=
138 &g_array_index(component
->destroy_listeners
,
139 struct bt_component_destroy_listener
, i
);
141 listener
->func(component
, listener
->data
);
145 * User data is destroyed first, followed by the concrete
146 * component instance. Do not finalize if the component's user
147 * initialization method failed in the first place.
149 if (component
->initialized
) {
150 finalize_component(component
);
153 if (component
->destroy
) {
154 BT_LOGD_STR("Destroying type-specific data.");
155 component
->destroy(component
);
158 if (component
->input_ports
) {
159 BT_LOGD_STR("Destroying input ports.");
160 g_ptr_array_free(component
->input_ports
, TRUE
);
161 component
->input_ports
= NULL
;
164 if (component
->output_ports
) {
165 BT_LOGD_STR("Destroying output ports.");
166 g_ptr_array_free(component
->output_ports
, TRUE
);
167 component
->output_ports
= NULL
;
170 if (component
->destroy_listeners
) {
171 g_array_free(component
->destroy_listeners
, TRUE
);
172 component
->destroy_listeners
= NULL
;
175 if (component
->name
) {
176 g_string_free(component
->name
, TRUE
);
177 component
->name
= NULL
;
180 BT_LOGD_STR("Putting component class.");
181 BT_OBJECT_PUT_REF_AND_RESET(component
->class);
185 enum bt_component_class_type
bt_component_get_class_type(
186 const struct bt_component
*component
)
188 BT_ASSERT_PRE_NON_NULL(component
, "Component");
189 return component
->class->type
;
193 struct bt_port
*add_port(
194 struct bt_component
*component
, GPtrArray
*ports
,
195 enum bt_port_type port_type
, const char *name
, void *user_data
)
197 struct bt_port
*new_port
= NULL
;
198 struct bt_graph
*graph
= NULL
;
200 BT_ASSERT_PRE_NON_NULL(component
, "Component");
201 BT_ASSERT_PRE_NON_NULL(name
, "Name");
202 BT_ASSERT_PRE(strlen(name
) > 0, "Name is empty");
203 graph
= bt_component_borrow_graph(component
);
204 BT_ASSERT_PRE(graph
&& !bt_graph_is_canceled(graph
),
205 "Component's graph is canceled: %![comp-]+c, %![graph-]+g",
207 BT_ASSERT_PRE(!graph
->is_configured
,
208 "Component's graph is already configured: "
209 "%![comp-]+c, %![graph-]+g", component
, graph
);
211 // TODO: Validate that the name is not already used.
213 BT_LIB_LOGD("Adding port to component: %![comp-]+c, "
214 "port-type=%s, port-name=\"%s\"", component
,
215 bt_port_type_string(port_type
), name
);
217 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
219 BT_LOGE_STR("Cannot create port object.");
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 bt_object_get_ref(bt_component_borrow_graph(component
));
235 graph
= bt_component_borrow_graph(component
);
237 bt_graph_notify_port_added(graph
, new_port
);
238 BT_OBJECT_PUT_REF_AND_RESET(graph
);
241 BT_LIB_LOGD("Created and added port to component: "
242 "%![comp-]+c, %![port-]+p", component
, new_port
);
249 uint64_t bt_component_get_input_port_count(const struct bt_component
*comp
)
251 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
252 return (uint64_t) comp
->input_ports
->len
;
256 uint64_t bt_component_get_output_port_count(const struct bt_component
*comp
)
258 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
259 return (uint64_t) comp
->output_ports
->len
;
263 int bt_component_create(struct bt_component_class
*component_class
,
264 const char *name
, struct bt_component
**user_component
)
267 struct bt_component
*component
= NULL
;
268 enum bt_component_class_type type
;
270 BT_ASSERT(user_component
);
271 BT_ASSERT(component_class
);
273 type
= bt_component_class_get_type(component_class
);
274 BT_LIB_LOGD("Creating empty component from component class: %![cc-]+C, "
275 "comp-name=\"%s\"", component_class
, name
);
276 component
= component_create_funcs
[type
](component_class
);
278 BT_LOGE_STR("Cannot create specific component object.");
283 bt_object_init_shared_with_parent(&component
->base
, destroy_component
);
284 component
->class = component_class
;
285 bt_object_get_no_null_check(component
->class);
286 component
->destroy
= component_destroy_funcs
[type
];
287 component
->name
= g_string_new(name
);
288 if (!component
->name
) {
289 BT_LOGE_STR("Failed to allocate one GString.");
294 component
->input_ports
= g_ptr_array_new_with_free_func(
295 (GDestroyNotify
) bt_object_try_spec_release
);
296 if (!component
->input_ports
) {
297 BT_LOGE_STR("Failed to allocate one GPtrArray.");
302 component
->output_ports
= g_ptr_array_new_with_free_func(
303 (GDestroyNotify
) bt_object_try_spec_release
);
304 if (!component
->output_ports
) {
305 BT_LOGE_STR("Failed to allocate one GPtrArray.");
310 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
311 sizeof(struct bt_component_destroy_listener
));
312 if (!component
->destroy_listeners
) {
313 BT_LOGE_STR("Failed to allocate one GArray.");
318 BT_LIB_LOGD("Created empty component from component class: "
319 "%![cc-]+C, %![comp-]+c", component_class
, component
);
320 BT_OBJECT_MOVE_REF(*user_component
, component
);
323 bt_object_put_ref(component
);
327 const char *bt_component_get_name(const struct bt_component
*component
)
329 BT_ASSERT_PRE_NON_NULL(component
, "Component");
330 return component
->name
->str
;
333 struct bt_component_class
*bt_component_borrow_class(
334 const struct bt_component
*component
)
336 BT_ASSERT_PRE_NON_NULL(component
, "Component");
337 return component
->class;
340 void *bt_self_component_get_data(const struct bt_self_component
*self_comp
)
342 struct bt_component
*component
= (void *) self_comp
;
344 BT_ASSERT_PRE_NON_NULL(component
, "Component");
345 return component
->user_data
;
348 void bt_self_component_set_data(struct bt_self_component
*self_comp
,
351 struct bt_component
*component
= (void *) self_comp
;
353 BT_ASSERT_PRE_NON_NULL(component
, "Component");
354 component
->user_data
= data
;
355 BT_LIB_LOGV("Set component's user data: %!+c", component
);
359 void bt_component_set_graph(struct bt_component
*component
,
360 struct bt_graph
*graph
)
362 bt_object_set_parent(&component
->base
,
363 graph
? &graph
->base
: NULL
);
366 bt_bool
bt_component_graph_is_canceled(const struct bt_component
*component
)
368 return bt_graph_is_canceled(
369 (void *) bt_object_borrow_parent(&component
->base
));
373 struct bt_port
*borrow_port_by_name(GPtrArray
*ports
,
377 struct bt_port
*ret_port
= NULL
;
381 for (i
= 0; i
< ports
->len
; i
++) {
382 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
384 if (!strcmp(name
, port
->name
->str
)) {
394 struct bt_port_input
*bt_component_borrow_input_port_by_name(
395 struct bt_component
*comp
, const char *name
)
398 return (void *) borrow_port_by_name(comp
->input_ports
, name
);
402 struct bt_port_output
*bt_component_borrow_output_port_by_name(
403 struct bt_component
*comp
, const char *name
)
405 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
407 borrow_port_by_name(comp
->output_ports
, name
);
411 struct bt_port
*borrow_port_by_index(GPtrArray
*ports
, uint64_t index
)
413 BT_ASSERT(index
< ports
->len
);
414 return g_ptr_array_index(ports
, index
);
418 struct bt_port_input
*bt_component_borrow_input_port_by_index(
419 struct bt_component
*comp
, uint64_t index
)
421 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
422 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->input_ports
->len
);
424 borrow_port_by_index(comp
->input_ports
, index
);
428 struct bt_port_output
*bt_component_borrow_output_port_by_index(
429 struct bt_component
*comp
, uint64_t index
)
431 BT_ASSERT_PRE_NON_NULL(comp
, "Component");
432 BT_ASSERT_PRE_VALID_INDEX(index
, comp
->output_ports
->len
);
434 borrow_port_by_index(comp
->output_ports
, index
);
438 struct bt_port_input
*bt_component_add_input_port(
439 struct bt_component
*component
, const char *name
,
442 /* add_port() logs details */
444 add_port(component
, component
->input_ports
,
445 BT_PORT_TYPE_INPUT
, name
, user_data
);
449 struct bt_port_output
*bt_component_add_output_port(
450 struct bt_component
*component
, const char *name
,
453 /* add_port() logs details */
455 add_port(component
, component
->output_ports
,
456 BT_PORT_TYPE_OUTPUT
, name
, user_data
);
460 enum bt_self_component_status
bt_component_accept_port_connection(
461 struct bt_component
*comp
, struct bt_port
*self_port
,
462 struct bt_port
*other_port
)
464 typedef enum bt_self_component_status (*method_t
)(
465 void *, void *, const void *);
467 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
468 method_t method
= NULL
;
471 BT_ASSERT(self_port
);
472 BT_ASSERT(other_port
);
474 switch (comp
->class->type
) {
475 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
477 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
479 switch (self_port
->type
) {
480 case BT_PORT_TYPE_OUTPUT
:
481 method
= (method_t
) src_cc
->methods
.accept_output_port_connection
;
489 case BT_COMPONENT_CLASS_TYPE_FILTER
:
491 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
493 switch (self_port
->type
) {
494 case BT_PORT_TYPE_INPUT
:
495 method
= (method_t
) flt_cc
->methods
.accept_input_port_connection
;
497 case BT_PORT_TYPE_OUTPUT
:
498 method
= (method_t
) flt_cc
->methods
.accept_output_port_connection
;
506 case BT_COMPONENT_CLASS_TYPE_SINK
:
508 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
510 switch (self_port
->type
) {
511 case BT_PORT_TYPE_INPUT
:
512 method
= (method_t
) sink_cc
->methods
.accept_input_port_connection
;
525 BT_LIB_LOGD("Calling user's \"accept port connection\" method: "
526 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
527 comp
, self_port
, other_port
);
528 status
= method(comp
, self_port
, (void *) other_port
);
529 BT_LOGD("User method returned: status=%s",
530 bt_self_component_status_string(status
));
537 enum bt_self_component_status
bt_component_port_connected(
538 struct bt_component
*comp
, struct bt_port
*self_port
,
539 struct bt_port
*other_port
)
541 typedef enum bt_self_component_status (*method_t
)(
542 void *, void *, const void *);
544 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
545 method_t method
= NULL
;
548 BT_ASSERT(self_port
);
549 BT_ASSERT(other_port
);
551 switch (comp
->class->type
) {
552 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
554 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
556 switch (self_port
->type
) {
557 case BT_PORT_TYPE_OUTPUT
:
558 method
= (method_t
) src_cc
->methods
.output_port_connected
;
566 case BT_COMPONENT_CLASS_TYPE_FILTER
:
568 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
570 switch (self_port
->type
) {
571 case BT_PORT_TYPE_INPUT
:
572 method
= (method_t
) flt_cc
->methods
.input_port_connected
;
574 case BT_PORT_TYPE_OUTPUT
:
575 method
= (method_t
) flt_cc
->methods
.output_port_connected
;
583 case BT_COMPONENT_CLASS_TYPE_SINK
:
585 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
587 switch (self_port
->type
) {
588 case BT_PORT_TYPE_INPUT
:
589 method
= (method_t
) sink_cc
->methods
.input_port_connected
;
602 BT_LIB_LOGD("Calling user's \"port connected\" method: "
603 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
604 comp
, self_port
, other_port
);
605 status
= method(comp
, self_port
, (void *) other_port
);
606 BT_LOGD("User method returned: status=%s",
607 bt_self_component_status_string(status
));
608 BT_ASSERT_PRE(status
== BT_SELF_COMPONENT_STATUS_OK
||
609 status
== BT_SELF_COMPONENT_STATUS_ERROR
||
610 status
== BT_SELF_COMPONENT_STATUS_NOMEM
,
611 "Unexpected returned component status: status=%s",
612 bt_self_component_status_string(status
));
619 void bt_component_add_destroy_listener(struct bt_component
*component
,
620 bt_component_destroy_listener_func func
, void *data
)
622 struct bt_component_destroy_listener listener
;
624 BT_ASSERT(component
);
626 listener
.func
= func
;
627 listener
.data
= data
;
628 g_array_append_val(component
->destroy_listeners
, listener
);
629 BT_LIB_LOGV("Added destroy listener: %![comp-]+c, "
630 "func-addr=%p, data-addr=%p",
631 component
, func
, data
);
635 void bt_component_remove_destroy_listener(struct bt_component
*component
,
636 bt_component_destroy_listener_func func
, void *data
)
640 BT_ASSERT(component
);
643 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
644 struct bt_component_destroy_listener
*listener
=
645 &g_array_index(component
->destroy_listeners
,
646 struct bt_component_destroy_listener
, i
);
648 if (listener
->func
== func
&& listener
->data
== data
) {
649 g_array_remove_index(component
->destroy_listeners
, i
);
651 BT_LIB_LOGV("Removed destroy listener: %![comp-]+c, "
652 "func-addr=%p, data-addr=%p",
653 component
, func
, data
);
658 void bt_component_get_ref(const struct bt_component
*component
)
660 bt_object_get_ref(component
);
663 void bt_component_put_ref(const struct bt_component
*component
)
665 bt_object_put_ref(component
);