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/component/component.h>
30 #include <babeltrace/component/component-internal.h>
31 #include <babeltrace/component/component-class-internal.h>
32 #include <babeltrace/component/component-source-internal.h>
33 #include <babeltrace/component/component-filter-internal.h>
34 #include <babeltrace/component/component-sink-internal.h>
35 #include <babeltrace/component/connection-internal.h>
36 #include <babeltrace/component/graph-internal.h>
37 #include <babeltrace/component/notification/iterator-internal.h>
38 #include <babeltrace/babeltrace-internal.h>
39 #include <babeltrace/compiler.h>
40 #include <babeltrace/ref.h>
43 struct bt_component
* (* const component_create_funcs
[])(
44 struct bt_component_class
*, struct bt_value
*) = {
45 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_create
,
46 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_create
,
47 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_create
,
51 void (*component_destroy_funcs
[])(struct bt_component
*) = {
52 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_destroy
,
53 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_destroy
,
54 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_destroy
,
58 enum bt_component_status (* const component_validation_funcs
[])(
59 struct bt_component
*) = {
60 [BT_COMPONENT_CLASS_TYPE_SOURCE
] = bt_component_source_validate
,
61 [BT_COMPONENT_CLASS_TYPE_SINK
] = bt_component_sink_validate
,
62 [BT_COMPONENT_CLASS_TYPE_FILTER
] = bt_component_filter_validate
,
66 void bt_component_destroy(struct bt_object
*obj
)
68 struct bt_component
*component
= NULL
;
69 struct bt_component_class
*component_class
= NULL
;
75 component
= container_of(obj
, struct bt_component
, base
);
76 component_class
= component
->class;
79 * User data is destroyed first, followed by the concrete component
82 if (component
->class->methods
.destroy
) {
83 component
->class->methods
.destroy(component
);
86 if (component
->destroy
) {
87 component
->destroy(component
);
90 if (component
->input_ports
) {
91 g_ptr_array_free(component
->input_ports
, TRUE
);
94 if (component
->output_ports
) {
95 g_ptr_array_free(component
->output_ports
, TRUE
);
98 g_string_free(component
->name
, TRUE
);
99 bt_put(component_class
);
103 enum bt_component_class_type
bt_component_get_class_type(
104 struct bt_component
*component
)
106 return component
? component
->class->type
: BT_COMPONENT_CLASS_TYPE_UNKNOWN
;
110 struct bt_notification_iterator
*bt_component_create_iterator(
111 struct bt_component
*component
, void *init_method_data
)
113 enum bt_notification_iterator_status ret_iterator
;
114 enum bt_component_class_type type
;
115 struct bt_notification_iterator
*iterator
= NULL
;
116 struct bt_component_class
*class = component
->class;
122 type
= bt_component_get_class_type(component
);
123 if (type
!= BT_COMPONENT_CLASS_TYPE_SOURCE
&&
124 type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
125 /* Unsupported operation. */
129 iterator
= bt_notification_iterator_create(component
);
135 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
137 struct bt_component_class_source
*source_class
;
138 enum bt_notification_iterator_status status
;
140 source_class
= container_of(class, struct bt_component_class_source
, parent
);
142 if (source_class
->methods
.iterator
.init
) {
143 status
= source_class
->methods
.iterator
.init(component
,
144 iterator
, init_method_data
);
151 case BT_COMPONENT_CLASS_TYPE_FILTER
:
153 struct bt_component_class_filter
*filter_class
;
154 enum bt_notification_iterator_status status
;
156 filter_class
= container_of(class, struct bt_component_class_filter
, parent
);
158 if (filter_class
->methods
.iterator
.init
) {
159 status
= filter_class
->methods
.iterator
.init(component
,
160 iterator
, init_method_data
);
172 ret_iterator
= bt_notification_iterator_validate(iterator
);
173 if (ret_iterator
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
184 struct bt_port
*bt_component_add_port(
185 struct bt_component
*component
, GPtrArray
*ports
,
186 enum bt_port_type port_type
, const char *name
)
189 struct bt_port
*new_port
= NULL
;
191 if (!name
|| strlen(name
) == 0) {
195 /* Look for a port having the same name. */
196 for (i
= 0; i
< ports
->len
; i
++) {
197 const char *port_name
;
198 struct bt_port
*port
= g_ptr_array_index(
201 port_name
= bt_port_get_name(port
);
206 if (!strcmp(name
, port_name
)) {
207 /* Port name clash, abort. */
212 new_port
= bt_port_create(component
, port_type
, name
);
218 * No name clash, add the port.
219 * The component is now the port's parent; it should _not_
220 * hold a reference to the port since the port's lifetime
221 * is now protected by the component's own lifetime.
223 g_ptr_array_add(ports
, new_port
);
229 uint64_t bt_component_get_input_port_count(struct bt_component
*comp
)
232 return comp
->input_ports
->len
;
236 uint64_t bt_component_get_output_port_count(struct bt_component
*comp
)
239 return comp
->output_ports
->len
;
242 struct bt_component
*bt_component_create_with_init_method_data(
243 struct bt_component_class
*component_class
, const char *name
,
244 struct bt_value
*params
, void *init_method_data
)
247 struct bt_component
*component
= NULL
;
248 enum bt_component_class_type type
;
249 struct bt_port
*default_port
= NULL
;
251 if (!component_class
) {
255 type
= bt_component_class_get_type(component_class
);
256 if (type
<= BT_COMPONENT_CLASS_TYPE_UNKNOWN
||
257 type
> BT_COMPONENT_CLASS_TYPE_FILTER
) {
261 component
= component_create_funcs
[type
](component_class
, params
);
266 bt_object_init(component
, bt_component_destroy
);
267 component
->class = bt_get(component_class
);
268 component
->destroy
= component_destroy_funcs
[type
];
269 component
->name
= g_string_new(name
);
270 if (!component
->name
) {
275 component
->input_ports
= g_ptr_array_new_with_free_func(
277 if (!component
->input_ports
) {
282 component
->output_ports
= g_ptr_array_new_with_free_func(
284 if (!component
->output_ports
) {
289 if (type
== BT_COMPONENT_CLASS_TYPE_SOURCE
||
290 type
== BT_COMPONENT_CLASS_TYPE_FILTER
) {
291 default_port
= bt_component_add_port(component
,
292 component
->output_ports
, BT_PORT_TYPE_OUTPUT
,
293 DEFAULT_OUTPUT_PORT_NAME
);
299 BT_PUT(default_port
);
302 if (type
== BT_COMPONENT_CLASS_TYPE_FILTER
||
303 type
== BT_COMPONENT_CLASS_TYPE_SINK
) {
304 default_port
= bt_component_add_port(component
,
305 component
->input_ports
, BT_PORT_TYPE_INPUT
,
306 DEFAULT_INPUT_PORT_NAME
);
312 BT_PUT(default_port
);
315 component
->initializing
= true;
317 if (component_class
->methods
.init
) {
318 ret
= component_class
->methods
.init(component
, params
,
320 component
->initializing
= false;
321 if (ret
!= BT_COMPONENT_STATUS_OK
) {
327 component
->initializing
= false;
328 ret
= component_validation_funcs
[type
](component
);
329 if (ret
!= BT_COMPONENT_STATUS_OK
) {
334 bt_component_class_freeze(component
->class);
336 bt_put(default_port
);
340 struct bt_component
*bt_component_create(
341 struct bt_component_class
*component_class
, const char *name
,
342 struct bt_value
*params
)
344 return bt_component_create_with_init_method_data(component_class
, name
,
348 const char *bt_component_get_name(struct bt_component
*component
)
350 const char *ret
= NULL
;
356 ret
= component
->name
->len
== 0 ? NULL
: component
->name
->str
;
361 enum bt_component_status
bt_component_set_name(struct bt_component
*component
,
364 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
366 if (!component
|| !name
|| name
[0] == '\0') {
367 ret
= BT_COMPONENT_STATUS_INVALID
;
371 g_string_assign(component
->name
, name
);
376 struct bt_component_class
*bt_component_get_class(
377 struct bt_component
*component
)
379 return component
? bt_get(component
->class) : NULL
;
382 void *bt_component_get_private_data(struct bt_component
*component
)
384 return component
? component
->user_data
: NULL
;
387 enum bt_component_status
388 bt_component_set_private_data(struct bt_component
*component
,
391 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
393 if (!component
|| !component
->initializing
) {
394 ret
= BT_COMPONENT_STATUS_INVALID
;
398 component
->user_data
= data
;
404 void bt_component_set_graph(struct bt_component
*component
,
405 struct bt_graph
*graph
)
407 struct bt_object
*parent
= bt_object_get_parent(&component
->base
);
409 assert(!parent
|| parent
== &graph
->base
);
411 bt_object_set_parent(component
, &graph
->base
);
416 struct bt_graph
*bt_component_get_graph(
417 struct bt_component
*component
)
419 return (struct bt_graph
*) bt_object_get_parent(&component
->base
);
423 struct bt_port
*bt_component_get_port(GPtrArray
*ports
, const char *name
)
426 struct bt_port
*ret_port
= NULL
;
430 for (i
= 0; i
< ports
->len
; i
++) {
431 struct bt_port
*port
= g_ptr_array_index(ports
, i
);
432 const char *port_name
= bt_port_get_name(port
);
438 if (!strcmp(name
, port_name
)) {
439 ret_port
= bt_get(port
);
448 struct bt_port
*bt_component_get_input_port(struct bt_component
*comp
,
453 return bt_component_get_port(comp
->input_ports
, name
);
457 struct bt_port
*bt_component_get_output_port(struct bt_component
*comp
,
462 return bt_component_get_port(comp
->output_ports
, name
);
466 struct bt_port
*bt_component_get_port_at_index(GPtrArray
*ports
, int index
)
468 struct bt_port
*port
= NULL
;
470 if (index
< 0 || index
>= ports
->len
) {
474 port
= bt_get(g_ptr_array_index(ports
, index
));
480 struct bt_port
*bt_component_get_input_port_at_index(struct bt_component
*comp
,
485 return bt_component_get_port_at_index(comp
->input_ports
, index
);
489 struct bt_port
*bt_component_get_output_port_at_index(struct bt_component
*comp
,
494 return bt_component_get_port_at_index(comp
->output_ports
, index
);
498 struct bt_port
*bt_component_add_input_port(
499 struct bt_component
*component
, const char *name
)
501 return bt_component_add_port(component
, component
->input_ports
,
502 BT_PORT_TYPE_INPUT
, name
);
506 struct bt_port
*bt_component_add_output_port(
507 struct bt_component
*component
, const char *name
)
509 return bt_component_add_port(component
, component
->output_ports
,
510 BT_PORT_TYPE_OUTPUT
, name
);
514 void bt_component_remove_port_at_index(struct bt_component
*component
,
515 GPtrArray
*ports
, size_t index
)
517 struct bt_port
*port
;
520 assert(index
< ports
->len
);
521 port
= g_ptr_array_index(ports
, index
);
523 /* Disconnect both ports of this port's connection, if any */
524 if (port
->connection
) {
525 bt_connection_disconnect_ports(port
->connection
, component
);
528 /* Remove from parent's array of ports (weak refs) */
529 g_ptr_array_remove_index(ports
, index
);
531 /* Detach port from its component parent */
532 BT_PUT(port
->base
.parent
);
534 // TODO: notify graph user: component's port removed
538 enum bt_component_status
bt_component_remove_port(
539 struct bt_component
*component
, struct bt_port
*port
)
542 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
543 GPtrArray
*ports
= NULL
;
545 if (!component
|| !port
) {
546 status
= BT_COMPONENT_STATUS_INVALID
;
550 if (bt_port_get_type(port
) == BT_PORT_TYPE_INPUT
) {
551 ports
= component
->input_ports
;
552 } else if (bt_port_get_type(port
) == BT_PORT_TYPE_OUTPUT
) {
553 ports
= component
->output_ports
;
558 for (i
= 0; i
< ports
->len
; i
++) {
559 struct bt_port
*cur_port
= g_ptr_array_index(ports
, i
);
561 if (cur_port
== port
) {
562 bt_component_remove_port_at_index(component
,
568 status
= BT_COMPONENT_STATUS_NOT_FOUND
;
574 enum bt_component_status
bt_component_accept_port_connection(
575 struct bt_component
*comp
, struct bt_port
*port
)
577 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
582 if (comp
->class->methods
.accept_port_connection
) {
583 status
= comp
->class->methods
.accept_port_connection(
591 void bt_component_port_disconnected(struct bt_component
*comp
,
592 struct bt_port
*port
)
597 if (comp
->class->methods
.port_disconnected
) {
598 comp
->class->methods
.port_disconnected(comp
, port
);