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 "LIB/COMPONENT"
25 #include "lib/logging.h"
27 #include "common/common.h"
28 #include "common/assert.h"
29 #include "lib/assert-pre.h"
30 #include "lib/assert-post.h"
31 #include <babeltrace2/graph/self-component.h>
32 #include <babeltrace2/graph/component-const.h>
33 #include <babeltrace2/graph/component-source-const.h>
34 #include <babeltrace2/graph/component-filter-const.h>
35 #include <babeltrace2/graph/component-sink-const.h>
36 #include <babeltrace2/graph/graph-const.h>
37 #include "common/macros.h"
38 #include "compat/compiler.h"
39 #include <babeltrace2/types.h>
40 #include <babeltrace2/value.h>
41 #include "lib/value.h"
45 #include "component.h"
46 #include "component-class.h"
47 #include "component-source.h"
48 #include "component-filter.h"
49 #include "component-sink.h"
50 #include "connection.h"
52 #include "message/iterator.h"
54 #include "lib/func-status.h"
57 struct bt_component
* (* const component_create_funcs
[])(
58 const struct bt_component_class
*) = {
59 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
60 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
61 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
65 void (*component_destroy_funcs
[])(struct bt_component
*) = {
66 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
67 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
68 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
72 void finalize_component(struct bt_component
*comp
)
74 typedef void (*method_t
)(void *);
76 method_t method
= NULL
;
80 switch (comp
->class->type
) {
81 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
83 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
85 method
= (method_t
) src_cc
->methods
.finalize
;
88 case BT_COMPONENT_CLASS_TYPE_FILTER
:
90 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
92 method
= (method_t
) flt_cc
->methods
.finalize
;
95 case BT_COMPONENT_CLASS_TYPE_SINK
:
97 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
99 method
= (method_t
) sink_cc
->methods
.finalize
;
107 const struct bt_error
*saved_error
;
109 saved_error
= bt_current_thread_take_error();
111 BT_LIB_LOGI("Calling user's component finalization method: "
112 "%![comp-]+c", comp
);
114 BT_ASSERT_POST_NO_ERROR();
117 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error
);
123 void destroy_component(struct bt_object
*obj
)
125 struct bt_component
*component
= NULL
;
133 * The component's reference count is 0 if we're here. Increment
134 * it to avoid a double-destroy (possibly infinitely recursive).
135 * This could happen for example if the component's finalization
136 * function does bt_object_get_ref() (or anything that causes
137 * bt_object_get_ref() to be called) on itself (ref. count goes
138 * from 0 to 1), and then bt_object_put_ref(): the reference
139 * count would go from 1 to 0 again and this function would be
143 component
= container_of(obj
, struct bt_component
, base
);
144 BT_LIB_LOGI("Destroying component: %![comp-]+c, %![graph-]+g",
145 component
, bt_component_borrow_graph(component
));
147 /* Call destroy listeners in reverse registration order */
148 BT_LOGD_STR("Calling destroy listeners.");
150 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
151 struct bt_component_destroy_listener
*listener
=
152 &g_array_index(component
->destroy_listeners
,
153 struct bt_component_destroy_listener
, i
);
155 listener
->func(component
, listener
->data
);
159 * User data is destroyed first, followed by the concrete
160 * component instance. Do not finalize if the component's user
161 * initialization method failed in the first place.
163 if (component
->initialized
) {
164 finalize_component(component
);
167 if (component
->destroy
) {
168 BT_LOGD_STR("Destroying type-specific data.");
169 component
->destroy(component
);
172 if (component
->input_ports
) {
173 BT_LOGD_STR("Destroying input ports.");
174 g_ptr_array_free(component
->input_ports
, TRUE
);
175 component
->input_ports
= NULL
;
178 if (component
->output_ports
) {
179 BT_LOGD_STR("Destroying output ports.");
180 g_ptr_array_free(component
->output_ports
, TRUE
);
181 component
->output_ports
= NULL
;
184 if (component
->destroy_listeners
) {
185 g_array_free(component
->destroy_listeners
, TRUE
);
186 component
->destroy_listeners
= NULL
;
189 if (component
->name
) {
190 g_string_free(component
->name
, TRUE
);
191 component
->name
= NULL
;
194 BT_LOGD_STR("Putting component class.");
195 BT_OBJECT_PUT_REF_AND_RESET(component
->class);
199 enum bt_component_class_type
bt_component_get_class_type(
200 const struct bt_component
*component
)
202 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
203 return component
->class->type
;
207 enum bt_self_component_add_port_status
add_port(
208 struct bt_component
*component
, GPtrArray
*ports
,
209 enum bt_port_type port_type
, const char *name
, void *user_data
,
210 struct bt_port
**port
)
212 struct bt_port
*new_port
= NULL
;
213 struct bt_graph
*graph
= NULL
;
214 enum bt_self_component_add_port_status status
;
216 BT_ASSERT_PRE_NON_NULL(component
, "Component");
217 BT_ASSERT_PRE_NON_NULL(name
, "Name");
218 BT_ASSERT_PRE(strlen(name
) > 0, "Name is empty");
219 graph
= bt_component_borrow_graph(component
);
221 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
222 "Component's graph is already configured: "
223 "%![comp-]+c, %![graph-]+g", component
, graph
);
225 // TODO: Validate that the name is not already used.
227 BT_LIB_LOGI("Adding port to component: %![comp-]+c, "
228 "port-type=%s, port-name=\"%s\"", component
,
229 bt_port_type_string(port_type
), name
);
231 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
233 BT_LIB_LOGE_APPEND_CAUSE("Cannot create port object.");
234 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
239 * No name clash, add the port.
240 * The component is now the port's parent; it should _not_
241 * hold a reference to the port since the port's lifetime
242 * is now protected by the component's own lifetime.
244 g_ptr_array_add(ports
, new_port
);
247 * Notify the graph's creator that a new port was added.
249 graph
= bt_component_borrow_graph(component
);
251 enum bt_graph_listener_func_status listener_status
;
253 listener_status
= bt_graph_notify_port_added(graph
, new_port
);
254 if (listener_status
!= BT_FUNC_STATUS_OK
) {
255 bt_graph_make_faulty(graph
);
256 status
= (int) listener_status
;
261 BT_LIB_LOGI("Created and added port to component: "
262 "%![comp-]+c, %![port-]+p", component
, new_port
);
265 status
= BT_FUNC_STATUS_OK
;
270 * We need to release the reference that we would otherwise have
271 * returned to the caller.
273 BT_PORT_PUT_REF_AND_RESET(new_port
);
280 uint64_t bt_component_get_input_port_count(const struct bt_component
*comp
)
282 BT_ASSERT_PRE_DEV_NON_NULL(comp
, "Component");
283 return (uint64_t) comp
->input_ports
->len
;
287 uint64_t bt_component_get_output_port_count(const struct bt_component
*comp
)
289 BT_ASSERT_PRE_DEV_NON_NULL(comp
, "Component");
290 return (uint64_t) comp
->output_ports
->len
;
294 int bt_component_create(struct bt_component_class
*component_class
,
295 const char *name
, bt_logging_level log_level
,
296 struct bt_component
**user_component
)
299 struct bt_component
*component
= NULL
;
300 enum bt_component_class_type type
;
302 BT_ASSERT(user_component
);
303 BT_ASSERT(component_class
);
305 type
= bt_component_class_get_type(component_class
);
306 BT_LIB_LOGI("Creating empty component from component class: %![cc-]+C, "
307 "comp-name=\"%s\", log-level=%s", component_class
, name
,
308 bt_common_logging_level_string(log_level
));
309 component
= component_create_funcs
[type
](component_class
);
311 BT_LIB_LOGE_APPEND_CAUSE(
312 "Cannot create specific component object.");
317 bt_object_init_shared_with_parent(&component
->base
, destroy_component
);
318 component
->class = component_class
;
319 bt_object_get_ref_no_null_check(component
->class);
320 component
->destroy
= component_destroy_funcs
[type
];
321 component
->name
= g_string_new(name
);
322 if (!component
->name
) {
323 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
328 component
->log_level
= log_level
;
329 component
->input_ports
= g_ptr_array_new_with_free_func(
330 (GDestroyNotify
) bt_object_try_spec_release
);
331 if (!component
->input_ports
) {
332 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
337 component
->output_ports
= g_ptr_array_new_with_free_func(
338 (GDestroyNotify
) bt_object_try_spec_release
);
339 if (!component
->output_ports
) {
340 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
345 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
346 sizeof(struct bt_component_destroy_listener
));
347 if (!component
->destroy_listeners
) {
348 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
353 BT_LIB_LOGI("Created empty component from component class: "
354 "%![cc-]+C, %![comp-]+c", component_class
, component
);
355 BT_OBJECT_MOVE_REF(*user_component
, component
);
358 bt_object_put_ref(component
);
362 const char *bt_component_get_name(const struct bt_component
*component
)
364 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
365 return component
->name
->str
;
368 const struct bt_component_class
*bt_component_borrow_class_const(
369 const struct bt_component
*component
)
371 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
372 return component
->class;
375 void *bt_self_component_get_data(const struct bt_self_component
*self_comp
)
377 struct bt_component
*component
= (void *) self_comp
;
379 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
380 return component
->user_data
;
383 void bt_self_component_set_data(struct bt_self_component
*self_comp
,
386 struct bt_component
*component
= (void *) self_comp
;
388 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
389 component
->user_data
= data
;
390 BT_LIB_LOGD("Set component's user data: %!+c", component
);
394 void bt_component_set_graph(struct bt_component
*component
,
395 struct bt_graph
*graph
)
397 bt_object_set_parent(&component
->base
,
398 graph
? &graph
->base
: NULL
);
402 struct bt_port
*borrow_port_by_name(GPtrArray
*ports
,
406 struct bt_port
*ret_port
= NULL
;
410 for (i
= 0; i
< ports
->len
; i
++) {
411 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
413 if (strcmp(name
, port
->name
->str
) == 0) {
423 struct bt_port_input
*bt_component_borrow_input_port_by_name(
424 struct bt_component
*comp
, const char *name
)
427 return (void *) borrow_port_by_name(comp
->input_ports
, name
);
431 struct bt_port_output
*bt_component_borrow_output_port_by_name(
432 struct bt_component
*comp
, const char *name
)
434 BT_ASSERT_PRE_DEV_NON_NULL(comp
, "Component");
436 borrow_port_by_name(comp
->output_ports
, name
);
440 struct bt_port
*borrow_port_by_index(GPtrArray
*ports
, uint64_t index
)
442 BT_ASSERT(index
< ports
->len
);
443 return g_ptr_array_index(ports
, index
);
447 struct bt_port_input
*bt_component_borrow_input_port_by_index(
448 struct bt_component
*comp
, uint64_t index
)
450 BT_ASSERT_PRE_DEV_NON_NULL(comp
, "Component");
451 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, comp
->input_ports
->len
);
453 borrow_port_by_index(comp
->input_ports
, index
);
457 struct bt_port_output
*bt_component_borrow_output_port_by_index(
458 struct bt_component
*comp
, uint64_t index
)
460 BT_ASSERT_PRE_DEV_NON_NULL(comp
, "Component");
461 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, comp
->output_ports
->len
);
463 borrow_port_by_index(comp
->output_ports
, index
);
467 enum bt_self_component_add_port_status
bt_component_add_input_port(
468 struct bt_component
*component
, const char *name
,
469 void *user_data
, struct bt_port
**port
)
471 /* add_port() logs details */
472 return add_port(component
, component
->input_ports
,
473 BT_PORT_TYPE_INPUT
, name
, user_data
, port
);
477 enum bt_self_component_add_port_status
bt_component_add_output_port(
478 struct bt_component
*component
, const char *name
,
479 void *user_data
, struct bt_port
**port
)
481 /* add_port() logs details */
482 return add_port(component
, component
->output_ports
,
483 BT_PORT_TYPE_OUTPUT
, name
, user_data
, port
);
487 enum bt_component_class_port_connected_method_status
488 bt_component_port_connected(
489 struct bt_component
*comp
, struct bt_port
*self_port
,
490 struct bt_port
*other_port
)
492 typedef enum bt_component_class_port_connected_method_status (*method_t
)(
493 void *, void *, const void *);
495 enum bt_component_class_port_connected_method_status status
=
497 method_t method
= NULL
;
500 BT_ASSERT(self_port
);
501 BT_ASSERT(other_port
);
503 switch (comp
->class->type
) {
504 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
506 struct bt_component_class_source
*src_cc
= (void *) comp
->class;
508 switch (self_port
->type
) {
509 case BT_PORT_TYPE_OUTPUT
:
510 method
= (method_t
) src_cc
->methods
.output_port_connected
;
518 case BT_COMPONENT_CLASS_TYPE_FILTER
:
520 struct bt_component_class_filter
*flt_cc
= (void *) comp
->class;
522 switch (self_port
->type
) {
523 case BT_PORT_TYPE_INPUT
:
524 method
= (method_t
) flt_cc
->methods
.input_port_connected
;
526 case BT_PORT_TYPE_OUTPUT
:
527 method
= (method_t
) flt_cc
->methods
.output_port_connected
;
535 case BT_COMPONENT_CLASS_TYPE_SINK
:
537 struct bt_component_class_sink
*sink_cc
= (void *) comp
->class;
539 switch (self_port
->type
) {
540 case BT_PORT_TYPE_INPUT
:
541 method
= (method_t
) sink_cc
->methods
.input_port_connected
;
554 BT_LIB_LOGD("Calling user's \"port connected\" method: "
555 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
556 comp
, self_port
, other_port
);
557 status
= (int) method(comp
, self_port
, (void *) other_port
);
558 BT_LOGD("User method returned: status=%s",
559 bt_common_func_status_string(status
));
560 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
561 status
== BT_FUNC_STATUS_ERROR
||
562 status
== BT_FUNC_STATUS_MEMORY_ERROR
,
563 "Unexpected returned component status: status=%s",
564 bt_common_func_status_string(status
));
565 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status
);
572 void bt_component_add_destroy_listener(struct bt_component
*component
,
573 bt_component_destroy_listener_func func
, void *data
)
575 struct bt_component_destroy_listener listener
;
577 BT_ASSERT(component
);
579 listener
.func
= func
;
580 listener
.data
= data
;
581 g_array_append_val(component
->destroy_listeners
, listener
);
582 BT_LIB_LOGD("Added destroy listener: %![comp-]+c, "
583 "func-addr=%p, data-addr=%p",
584 component
, func
, data
);
588 void bt_component_remove_destroy_listener(struct bt_component
*component
,
589 bt_component_destroy_listener_func func
, void *data
)
593 BT_ASSERT(component
);
596 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
597 struct bt_component_destroy_listener
*listener
=
598 &g_array_index(component
->destroy_listeners
,
599 struct bt_component_destroy_listener
, i
);
601 if (listener
->func
== func
&& listener
->data
== data
) {
602 g_array_remove_index(component
->destroy_listeners
, i
);
604 BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, "
605 "func-addr=%p, data-addr=%p",
606 component
, func
, data
);
611 bt_logging_level
bt_component_get_logging_level(
612 const struct bt_component
*component
)
614 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
615 return component
->log_level
;
618 uint64_t bt_self_component_get_graph_mip_version(
619 bt_self_component
*self_component
)
621 struct bt_component
*comp
= (void *) self_component
;
623 BT_ASSERT_PRE_NON_NULL(self_component
, "Component");
624 return bt_component_borrow_graph(comp
)->mip_version
;
627 void bt_component_get_ref(const struct bt_component
*component
)
629 bt_object_get_ref(component
);
632 void bt_component_put_ref(const struct bt_component
*component
)
634 bt_object_put_ref(component
);