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/plugin/component.h>
30 #include <babeltrace/plugin/component-internal.h>
31 #include <babeltrace/plugin/source-internal.h>
32 #include <babeltrace/plugin/sink-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/compiler.h>
35 #include <babeltrace/ref.h>
38 struct bt_component
* (* const component_create_funcs
[])(
39 struct bt_component_class
*, struct bt_value
*) = {
40 [BT_COMPONENT_TYPE_SOURCE
] = bt_component_source_create
,
41 [BT_COMPONENT_TYPE_SINK
] = bt_component_sink_create
,
45 enum bt_component_status (* const component_validation_funcs
[])(
46 struct bt_component
*) = {
47 [BT_COMPONENT_TYPE_SOURCE
] = bt_component_source_validate
,
48 [BT_COMPONENT_TYPE_SINK
] = bt_component_sink_validate
,
52 void bt_component_destroy(struct bt_object
*obj
)
54 struct bt_component
*component
= NULL
;
55 struct bt_component_class
*component_class
= NULL
;
61 component
= container_of(obj
, struct bt_component
, base
);
62 component_class
= component
->class;
65 * User data is destroyed first, followed by the concrete component
68 if (component
->user_destroy
) {
69 component
->user_destroy(component
);
72 if (component
->destroy
) {
73 component
->destroy(component
);
76 g_string_free(component
->name
, TRUE
);
77 bt_put(component_class
);
82 enum bt_component_status
bt_component_init(struct bt_component
*component
,
83 bt_component_destroy_cb destroy
)
85 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
88 ret
= BT_COMPONENT_STATUS_INVALID
;
92 component
->destroy
= destroy
;
98 enum bt_component_type
bt_component_get_type(struct bt_component
*component
)
100 return component
? component
->class->type
: BT_COMPONENT_TYPE_UNKNOWN
;
103 struct bt_component
*bt_component_create(
104 struct bt_component_class
*component_class
, const char *name
,
105 struct bt_value
*params
)
108 struct bt_component
*component
= NULL
;
109 enum bt_component_type type
;
111 if (!component_class
) {
115 type
= bt_component_class_get_type(component_class
);
116 if (type
<= BT_COMPONENT_TYPE_UNKNOWN
||
117 type
>= BT_COMPONENT_TYPE_FILTER
) {
118 /* Filter components are not supported yet. */
122 component
= component_create_funcs
[type
](component_class
, params
);
127 bt_object_init(component
, bt_component_destroy
);
128 component
->name
= g_string_new(name
);
129 if (!component
->name
) {
134 component_class
->init(component
, params
);
135 ret
= component_validation_funcs
[type
](component
);
136 if (ret
!= BT_COMPONENT_STATUS_OK
) {
144 const char *bt_component_get_name(struct bt_component
*component
)
146 const char *ret
= NULL
;
152 ret
= component
->name
->str
;
157 enum bt_component_status
bt_component_set_name(struct bt_component
*component
,
160 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
162 if (!component
|| !name
|| name
[0] == '\0') {
163 ret
= BT_COMPONENT_STATUS_INVALID
;
167 g_string_assign(component
->name
, name
);
172 struct bt_component_class
*bt_component_get_class(
173 struct bt_component
*component
)
175 return component
? bt_get(component
->class) : NULL
;
178 void *bt_component_get_private_data(struct bt_component
*component
)
180 return component
? component
->user_data
: NULL
;
183 enum bt_component_status
184 bt_component_set_private_data(struct bt_component
*component
,
187 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
190 ret
= BT_COMPONENT_STATUS_INVALID
;
194 component
->user_data
= data
;
199 enum bt_component_status
bt_component_set_destroy_cb(
200 struct bt_component
*component
, bt_component_destroy_cb destroy
)
202 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
205 ret
= BT_COMPONENT_STATUS_INVALID
;
209 component
->user_destroy
= destroy
;