4 * Babeltrace Plugin Component
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/graph/private-component.h>
30 #include <babeltrace/graph/component.h>
31 #include <babeltrace/graph/component-internal.h>
32 #include <babeltrace/graph/component-class-internal.h>
33 #include <babeltrace/graph/component-source-internal.h>
34 #include <babeltrace/graph/component-filter-internal.h>
35 #include <babeltrace/graph/component-sink-internal.h>
36 #include <babeltrace/graph/private-connection.h>
37 #include <babeltrace/graph/connection-internal.h>
38 #include <babeltrace/graph/graph-internal.h>
39 #include <babeltrace/graph/notification-iterator-internal.h>
40 #include <babeltrace/graph/private-notification-iterator.h>
41 #include <babeltrace/babeltrace-internal.h>
42 #include <babeltrace/compiler-internal.h>
43 #include <babeltrace/ref.h>
47 struct bt_component
* (* const component_create_funcs
[])(
48 struct bt_component_class
*, struct bt_value
*) = {
49 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
50 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
51 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
55 void (*component_destroy_funcs
[])(struct bt_component
*) = {
56 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
57 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
58 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
62 enum bt_component_status (* const component_validation_funcs
[])(
63 struct bt_component
*) = {
64 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_validate
,
65 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_validate
,
66 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_validate
,
70 void bt_component_destroy(struct bt_object
*obj
)
72 struct bt_component
*component
= NULL
;
73 struct bt_component_class
*component_class
= NULL
;
80 component
= container_of(obj
, struct bt_component
, base
);
82 /* Call destroy listeners in reverse registration order */
83 for (i
= component
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
84 struct bt_component_destroy_listener
*listener
=
85 &g_array_index(component
->destroy_listeners
,
86 struct bt_component_destroy_listener
, i
);
88 listener
->func(component
, listener
->data
);
91 component_class
= component
->class;
94 * User data is destroyed first, followed by the concrete component
97 if (component
->class->methods
.finalize
) {
98 component
->class->methods
.finalize(
99 bt_private_component_from_component(component
));
102 if (component
->destroy
) {
103 component
->destroy(component
);
106 if (component
->input_ports
) {
107 g_ptr_array_free(component
->input_ports
, TRUE
);
110 if (component
->output_ports
) {
111 g_ptr_array_free(component
->output_ports
, TRUE
);
114 if (component
->destroy_listeners
) {
115 g_array_free(component
->destroy_listeners
, TRUE
);
118 g_string_free(component
->name
, TRUE
);
119 bt_put(component_class
);
123 struct bt_component
*bt_component_from_private_component(
124 struct bt_private_component
*private_component
)
126 return bt_get(bt_component_from_private(private_component
));
129 enum bt_component_class_type
bt_component_get_class_type(
130 struct bt_component
*component
)
132 return component
? component
->class->type
: BT_COMPONENT_CLASS_TYPE_UNKNOWN
;
136 struct bt_port
*bt_component_add_port(
137 struct bt_component
*component
, GPtrArray
*ports
,
138 enum bt_port_type port_type
, const char *name
, void *user_data
)
141 struct bt_port
*new_port
= NULL
;
142 struct bt_graph
*graph
= NULL
;
144 if (!name
|| strlen(name
) == 0) {
148 /* Look for a port having the same name. */
149 for (i
= 0; i
< ports
->len
; i
++) {
150 const char *port_name
;
151 struct bt_port
*port
= g_ptr_array_index(
154 port_name
= bt_port_get_name(port
);
159 if (!strcmp(name
, port_name
)) {
160 /* Port name clash, abort. */
165 new_port
= bt_port_create(component
, port_type
, name
, user_data
);
171 * No name clash, add the port.
172 * The component is now the port's parent; it should _not_
173 * hold a reference to the port since the port's lifetime
174 * is now protected by the component's own lifetime.
176 g_ptr_array_add(ports
, new_port
);
179 * Notify the graph's creator that a new port was added.
181 graph
= bt_component_get_graph(component
);
183 bt_graph_notify_port_added(graph
, new_port
);
192 int64_t bt_component_get_input_port_count(struct bt_component
*comp
)
195 return (int64_t) comp
->input_ports
->len
;
199 int64_t bt_component_get_output_port_count(struct bt_component
*comp
)
202 return (int64_t) comp
->output_ports
->len
;
205 struct bt_component
*bt_component_create_with_init_method_data(
206 struct bt_component_class
*component_class
, const char *name
,
207 struct bt_value
*params
, void *init_method_data
)
210 struct bt_component
*component
= NULL
;
211 enum bt_component_class_type type
;
212 struct bt_port
*default_port
= NULL
;
216 if (!component_class
) {
220 type
= bt_component_class_get_type(component_class
);
221 if (type
<= BT_COMPONENT_CLASS_TYPE_UNKNOWN
||
222 type
> BT_COMPONENT_CLASS_TYPE_FILTER
) {
227 * Parameters must be a map value, but we create a convenient
228 * empty one if it's NULL.
231 if (!bt_value_is_map(params
)) {
235 params
= bt_value_map_create();
241 component
= component_create_funcs
[type
](component_class
, params
);
246 bt_object_init(component
, bt_component_destroy
);
247 component
->class = bt_get(component_class
);
248 component
->destroy
= component_destroy_funcs
[type
];
249 component
->name
= g_string_new(name
);
250 if (!component
->name
) {
255 component
->input_ports
= g_ptr_array_new_with_free_func(
257 if (!component
->input_ports
) {
262 component
->output_ports
= g_ptr_array_new_with_free_func(
264 if (!component
->output_ports
) {
269 component
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
270 sizeof(struct bt_component_destroy_listener
));
271 if (!component
->destroy_listeners
) {
276 if (type
== BT_COMPONENT_CLASS_TYPE_SOURCE
||
277 type
== BT_COMPONENT_CLASS_TYPE_FILTER
) {
278 default_port
= bt_component_add_port(component
,
279 component
->output_ports
, BT_PORT_TYPE_OUTPUT
,
280 DEFAULT_OUTPUT_PORT_NAME
, NULL
);
286 BT_PUT(default_port
);
289 if (type
== BT_COMPONENT_CLASS_TYPE_FILTER
||
290 type
== BT_COMPONENT_CLASS_TYPE_SINK
) {
291 default_port
= bt_component_add_port(component
,
292 component
->input_ports
, BT_PORT_TYPE_INPUT
,
293 DEFAULT_INPUT_PORT_NAME
, NULL
);
299 BT_PUT(default_port
);
302 component
->initializing
= true;
304 if (component_class
->methods
.init
) {
305 ret
= component_class
->methods
.init(
306 bt_private_component_from_component(component
), params
,
308 component
->initializing
= false;
309 if (ret
!= BT_COMPONENT_STATUS_OK
) {
315 component
->initializing
= false;
316 ret
= component_validation_funcs
[type
](component
);
317 if (ret
!= BT_COMPONENT_STATUS_OK
) {
322 bt_component_class_freeze(component
->class);
325 bt_put(default_port
);
329 struct bt_component
*bt_component_create(
330 struct bt_component_class
*component_class
, const char *name
,
331 struct bt_value
*params
)
333 return bt_component_create_with_init_method_data(component_class
, name
,
337 const char *bt_component_get_name(struct bt_component
*component
)
339 const char *ret
= NULL
;
345 ret
= component
->name
->len
== 0 ? NULL
: component
->name
->str
;
350 enum bt_component_status
bt_component_set_name(struct bt_component
*component
,
353 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
355 if (!component
|| !name
|| name
[0] == '\0') {
356 ret
= BT_COMPONENT_STATUS_INVALID
;
360 g_string_assign(component
->name
, name
);
365 struct bt_component_class
*bt_component_get_class(
366 struct bt_component
*component
)
368 return component
? bt_get(component
->class) : NULL
;
371 void *bt_private_component_get_user_data(
372 struct bt_private_component
*private_component
)
374 struct bt_component
*component
=
375 bt_component_from_private(private_component
);
377 return component
? component
->user_data
: NULL
;
380 enum bt_component_status
bt_private_component_set_user_data(
381 struct bt_private_component
*private_component
,
384 struct bt_component
*component
=
385 bt_component_from_private(private_component
);
386 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
388 if (!component
|| !component
->initializing
) {
389 ret
= BT_COMPONENT_STATUS_INVALID
;
393 component
->user_data
= data
;
399 void bt_component_set_graph(struct bt_component
*component
,
400 struct bt_graph
*graph
)
402 struct bt_object
*parent
= bt_object_get_parent(&component
->base
);
404 assert(!parent
|| parent
== &graph
->base
);
406 bt_object_set_parent(component
, &graph
->base
);
411 struct bt_graph
*bt_component_get_graph(
412 struct bt_component
*component
)
414 return (struct bt_graph
*) bt_object_get_parent(&component
->base
);
418 struct bt_port
*bt_component_get_port_by_name(GPtrArray
*ports
,
422 struct bt_port
*ret_port
= NULL
;
426 for (i
= 0; i
< ports
->len
; i
++) {
427 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
428 const char *port_name
= bt_port_get_name(port
);
434 if (!strcmp(name
, port_name
)) {
435 ret_port
= bt_get(port
);
444 struct bt_port
*bt_component_get_input_port_by_name(struct bt_component
*comp
,
449 return bt_component_get_port_by_name(comp
->input_ports
, name
);
453 struct bt_port
*bt_component_get_output_port_by_name(struct bt_component
*comp
,
458 return bt_component_get_port_by_name(comp
->output_ports
, name
);
462 struct bt_port
*bt_component_get_port_by_index(GPtrArray
*ports
, uint64_t index
)
464 struct bt_port
*port
= NULL
;
466 if (index
>= ports
->len
) {
470 port
= bt_get(g_ptr_array_index(ports
, index
));
476 struct bt_port
*bt_component_get_input_port_by_index(struct bt_component
*comp
,
481 return bt_component_get_port_by_index(comp
->input_ports
, index
);
485 struct bt_port
*bt_component_get_output_port_by_index(struct bt_component
*comp
,
490 return bt_component_get_port_by_index(comp
->output_ports
, index
);
494 struct bt_port
*bt_component_add_input_port(
495 struct bt_component
*component
, const char *name
,
498 return bt_component_add_port(component
, component
->input_ports
,
499 BT_PORT_TYPE_INPUT
, name
, user_data
);
503 struct bt_port
*bt_component_add_output_port(
504 struct bt_component
*component
, const char *name
,
507 return bt_component_add_port(component
, component
->output_ports
,
508 BT_PORT_TYPE_OUTPUT
, name
, user_data
);
512 void bt_component_remove_port_by_index(struct bt_component
*component
,
513 GPtrArray
*ports
, size_t index
)
515 struct bt_port
*port
;
516 struct bt_graph
*graph
;
519 assert(index
< ports
->len
);
520 port
= g_ptr_array_index(ports
, index
);
522 /* Disconnect both ports of this port's connection, if any */
523 if (port
->connection
) {
524 bt_connection_disconnect_ports(port
->connection
);
527 /* Remove from parent's array of ports (weak refs) */
528 g_ptr_array_remove_index(ports
, index
);
530 /* Detach port from its component parent */
531 BT_PUT(port
->base
.parent
);
534 * Notify the graph's creator that a port is removed.
536 graph
= bt_component_get_graph(component
);
538 bt_graph_notify_port_removed(graph
, component
, port
);
544 enum bt_component_status
bt_component_remove_port(
545 struct bt_component
*component
, struct bt_port
*port
)
548 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
549 GPtrArray
*ports
= NULL
;
551 if (!component
|| !port
) {
552 status
= BT_COMPONENT_STATUS_INVALID
;
556 if (bt_port_get_type(port
) == BT_PORT_TYPE_INPUT
) {
557 ports
= component
->input_ports
;
558 } else if (bt_port_get_type(port
) == BT_PORT_TYPE_OUTPUT
) {
559 ports
= component
->output_ports
;
564 for (i
= 0; i
< ports
->len
; i
++) {
565 struct bt_port
*cur_port
= g_ptr_array_index(ports
, i
);
567 if (cur_port
== port
) {
568 bt_component_remove_port_by_index(component
,
574 status
= BT_COMPONENT_STATUS_NOT_FOUND
;
580 enum bt_component_status
bt_component_accept_port_connection(
581 struct bt_component
*comp
, struct bt_port
*self_port
,
582 struct bt_port
*other_port
)
584 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
590 if (comp
->class->methods
.accept_port_connection
) {
591 status
= comp
->class->methods
.accept_port_connection(
592 bt_private_component_from_component(comp
),
593 bt_private_port_from_port(self_port
),
601 void bt_component_port_connected(struct bt_component
*comp
,
602 struct bt_port
*self_port
, struct bt_port
*other_port
)
608 if (comp
->class->methods
.port_connected
) {
609 comp
->class->methods
.port_connected(
610 bt_private_component_from_component(comp
),
611 bt_private_port_from_port(self_port
), other_port
);
616 void bt_component_port_disconnected(struct bt_component
*comp
,
617 struct bt_port
*port
)
622 if (comp
->class->methods
.port_disconnected
) {
623 comp
->class->methods
.port_disconnected(
624 bt_private_component_from_component(comp
),
625 bt_private_port_from_port(port
));
630 void bt_component_add_destroy_listener(struct bt_component
*component
,
631 bt_component_destroy_listener_func func
, void *data
)
633 struct bt_component_destroy_listener listener
;
637 listener
.func
= func
;
638 listener
.data
= data
;
639 g_array_append_val(component
->destroy_listeners
, listener
);
643 void bt_component_remove_destroy_listener(struct bt_component
*component
,
644 bt_component_destroy_listener_func func
, void *data
)
651 for (i
= 0; i
< component
->destroy_listeners
->len
; i
++) {
652 struct bt_component_destroy_listener
*listener
=
653 &g_array_index(component
->destroy_listeners
,
654 struct bt_component_destroy_listener
, i
);
656 if (listener
->func
== func
&& listener
->data
== data
) {
657 g_array_remove_index(component
->destroy_listeners
, i
);