1 #ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
2 #define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include <babeltrace/babeltrace-internal.h>
28 #include <babeltrace/graph/component-class-internal.h>
29 #include <babeltrace/plugin/plugin-const.h>
30 #include <babeltrace/plugin/plugin-dev.h>
31 #include <babeltrace/plugin/plugin-so-internal.h>
32 #include <babeltrace/object-internal.h>
33 #include <babeltrace/types.h>
34 #include <babeltrace/assert-internal.h>
38 BT_PLUGIN_TYPE_SO
= 0,
39 BT_PLUGIN_TYPE_PYTHON
= 1,
42 enum bt_plugin_status
{
43 BT_PLUGIN_STATUS_OK
= 0,
44 BT_PLUGIN_STATUS_ERROR
= -1,
45 BT_PLUGIN_STATUS_NOMEM
= -12,
49 struct bt_object base
;
50 enum bt_plugin_type type
;
52 /* Arrays of `struct bt_component_class *` (owned by this) */
53 GPtrArray
*src_comp_classes
;
54 GPtrArray
*flt_comp_classes
;
55 GPtrArray
*sink_comp_classes
;
57 /* Info (owned by this) */
78 /* Value depends on the specific plugin type */
80 void (*destroy_spec_data
)(struct bt_plugin
*);
83 struct bt_plugin_set
{
84 struct bt_object base
;
86 /* Array of struct bt_plugin * */
91 const char *bt_plugin_status_string(enum bt_plugin_status status
)
94 case BT_PLUGIN_STATUS_OK
:
95 return "BT_PLUGIN_STATUS_OK";
96 case BT_PLUGIN_STATUS_ERROR
:
97 return "BT_PLUGIN_STATUS_ERROR";
98 case BT_PLUGIN_STATUS_NOMEM
:
99 return "BT_PLUGIN_STATUS_NOMEM";
106 const char *bt_plugin_type_string(enum bt_plugin_type type
)
109 case BT_PLUGIN_TYPE_SO
:
110 return "BT_PLUGIN_TYPE_SO";
111 case BT_PLUGIN_TYPE_PYTHON
:
112 return "BT_PLUGIN_TYPE_PYTHON";
119 void bt_plugin_destroy(struct bt_object
*obj
)
121 struct bt_plugin
*plugin
;
124 plugin
= container_of(obj
, struct bt_plugin
, base
);
125 BT_LIB_LOGD("Destroying plugin object: %!+l", plugin
);
127 if (plugin
->destroy_spec_data
) {
128 plugin
->destroy_spec_data(plugin
);
131 if (plugin
->src_comp_classes
) {
132 BT_LOGD_STR("Putting source component classes.");
133 g_ptr_array_free(plugin
->src_comp_classes
, TRUE
);
134 plugin
->src_comp_classes
= NULL
;
137 if (plugin
->flt_comp_classes
) {
138 BT_LOGD_STR("Putting filter component classes.");
139 g_ptr_array_free(plugin
->flt_comp_classes
, TRUE
);
140 plugin
->flt_comp_classes
= NULL
;
143 if (plugin
->sink_comp_classes
) {
144 BT_LOGD_STR("Putting sink component classes.");
145 g_ptr_array_free(plugin
->sink_comp_classes
, TRUE
);
146 plugin
->sink_comp_classes
= NULL
;
149 if (plugin
->info
.name
) {
150 g_string_free(plugin
->info
.name
, TRUE
);
151 plugin
->info
.name
= NULL
;
154 if (plugin
->info
.path
) {
155 g_string_free(plugin
->info
.path
, TRUE
);
156 plugin
->info
.path
= NULL
;
159 if (plugin
->info
.description
) {
160 g_string_free(plugin
->info
.description
, TRUE
);
161 plugin
->info
.description
= NULL
;
164 if (plugin
->info
.author
) {
165 g_string_free(plugin
->info
.author
, TRUE
);
166 plugin
->info
.author
= NULL
;
169 if (plugin
->info
.license
) {
170 g_string_free(plugin
->info
.license
, TRUE
);
171 plugin
->info
.license
= NULL
;
174 if (plugin
->info
.version
.extra
) {
175 g_string_free(plugin
->info
.version
.extra
, TRUE
);
176 plugin
->info
.version
.extra
= NULL
;
183 struct bt_plugin
*bt_plugin_create_empty(enum bt_plugin_type type
)
185 struct bt_plugin
*plugin
= NULL
;
187 BT_LOGD("Creating empty plugin object: type=%s",
188 bt_plugin_type_string(type
));
190 plugin
= g_new0(struct bt_plugin
, 1);
192 BT_LOGE_STR("Failed to allocate one plugin.");
196 bt_object_init_shared(&plugin
->base
, bt_plugin_destroy
);
199 /* Create empty arrays of component classes */
200 plugin
->src_comp_classes
=
201 g_ptr_array_new_with_free_func(
202 (GDestroyNotify
) bt_object_put_ref
);
203 if (!plugin
->src_comp_classes
) {
204 BT_LOGE_STR("Failed to allocate a GPtrArray.");
208 plugin
->flt_comp_classes
=
209 g_ptr_array_new_with_free_func(
210 (GDestroyNotify
) bt_object_put_ref
);
211 if (!plugin
->flt_comp_classes
) {
212 BT_LOGE_STR("Failed to allocate a GPtrArray.");
216 plugin
->sink_comp_classes
=
217 g_ptr_array_new_with_free_func(
218 (GDestroyNotify
) bt_object_put_ref
);
219 if (!plugin
->sink_comp_classes
) {
220 BT_LOGE_STR("Failed to allocate a GPtrArray.");
224 /* Create empty info */
225 plugin
->info
.name
= g_string_new(NULL
);
226 if (!plugin
->info
.name
) {
227 BT_LOGE_STR("Failed to allocate a GString.");
231 plugin
->info
.path
= g_string_new(NULL
);
232 if (!plugin
->info
.path
) {
233 BT_LOGE_STR("Failed to allocate a GString.");
237 plugin
->info
.description
= g_string_new(NULL
);
238 if (!plugin
->info
.description
) {
239 BT_LOGE_STR("Failed to allocate a GString.");
243 plugin
->info
.author
= g_string_new(NULL
);
244 if (!plugin
->info
.author
) {
245 BT_LOGE_STR("Failed to allocate a GString.");
249 plugin
->info
.license
= g_string_new(NULL
);
250 if (!plugin
->info
.license
) {
251 BT_LOGE_STR("Failed to allocate a GString.");
255 plugin
->info
.version
.extra
= g_string_new(NULL
);
256 if (!plugin
->info
.version
.extra
) {
257 BT_LOGE_STR("Failed to allocate a GString.");
261 BT_LIB_LOGD("Created empty plugin object: %!+l", plugin
);
265 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
272 void bt_plugin_set_path(struct bt_plugin
*plugin
, const char *path
)
276 g_string_assign(plugin
->info
.path
, path
);
277 plugin
->info
.path_set
= BT_TRUE
;
278 BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, path=\"%s\"",
283 void bt_plugin_set_name(struct bt_plugin
*plugin
, const char *name
)
287 g_string_assign(plugin
->info
.name
, name
);
288 plugin
->info
.name_set
= BT_TRUE
;
289 BT_LIB_LOGV("Set plugin's name: %![plugin-]+l, name=\"%s\"",
294 void bt_plugin_set_description(struct bt_plugin
*plugin
,
295 const char *description
)
298 BT_ASSERT(description
);
299 g_string_assign(plugin
->info
.description
, description
);
300 plugin
->info
.description_set
= BT_TRUE
;
301 BT_LIB_LOGV("Set plugin's description: %![plugin-]+l", plugin
);
305 void bt_plugin_set_author(struct bt_plugin
*plugin
, const char *author
)
309 g_string_assign(plugin
->info
.author
, author
);
310 plugin
->info
.author_set
= BT_TRUE
;
311 BT_LIB_LOGV("Set plugin's author: %![plugin-]+l, author=\"%s\"",
316 void bt_plugin_set_license(struct bt_plugin
*plugin
, const char *license
)
320 g_string_assign(plugin
->info
.license
, license
);
321 plugin
->info
.license_set
= BT_TRUE
;
322 BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, license=\"%s\"",
327 void bt_plugin_set_version(struct bt_plugin
*plugin
, unsigned int major
,
328 unsigned int minor
, unsigned int patch
, const char *extra
)
331 plugin
->info
.version
.major
= major
;
332 plugin
->info
.version
.minor
= minor
;
333 plugin
->info
.version
.patch
= patch
;
336 g_string_assign(plugin
->info
.version
.extra
, extra
);
339 plugin
->info
.version_set
= BT_TRUE
;
340 BT_LIB_LOGV("Set plugin's version: %![plugin-]+l, "
341 "major=%u, minor=%u, patch=%u, extra=\"%s\"",
342 plugin
, major
, minor
, patch
, extra
);
346 enum bt_plugin_status
bt_plugin_add_component_class(
347 struct bt_plugin
*plugin
, struct bt_component_class
*comp_class
)
349 GPtrArray
*comp_classes
;
352 BT_ASSERT(comp_class
);
354 switch (comp_class
->type
) {
355 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
356 comp_classes
= plugin
->src_comp_classes
;
358 case BT_COMPONENT_CLASS_TYPE_FILTER
:
359 comp_classes
= plugin
->flt_comp_classes
;
361 case BT_COMPONENT_CLASS_TYPE_SINK
:
362 comp_classes
= plugin
->sink_comp_classes
;
368 /* Add new component class */
369 bt_object_get_ref(comp_class
);
370 g_ptr_array_add(comp_classes
, comp_class
);
372 /* Special case for a shared object plugin */
373 if (plugin
->type
== BT_PLUGIN_TYPE_SO
) {
374 bt_plugin_so_on_add_component_class(plugin
, comp_class
);
377 BT_LIB_LOGD("Added component class to plugin: "
378 "%![plugin-]+l, %![cc-]+C", plugin
, comp_class
);
379 return BT_PLUGIN_STATUS_OK
;
383 void bt_plugin_set_destroy(struct bt_object
*obj
)
385 struct bt_plugin_set
*plugin_set
=
386 container_of(obj
, struct bt_plugin_set
, base
);
392 BT_LOGD("Destroying plugin set: addr=%p", plugin_set
);
394 if (plugin_set
->plugins
) {
395 BT_LOGD_STR("Putting plugins.");
396 g_ptr_array_free(plugin_set
->plugins
, TRUE
);
403 struct bt_plugin_set
*bt_plugin_set_create(void)
405 struct bt_plugin_set
*plugin_set
= g_new0(struct bt_plugin_set
, 1);
411 BT_LOGD_STR("Creating empty plugin set.");
412 bt_object_init_shared(&plugin_set
->base
, bt_plugin_set_destroy
);
414 plugin_set
->plugins
= g_ptr_array_new_with_free_func(
415 (GDestroyNotify
) bt_object_put_ref
);
416 if (!plugin_set
->plugins
) {
417 BT_LOGE_STR("Failed to allocate a GPtrArray.");
418 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
422 BT_LOGD("Created empty plugin set: addr=%p", plugin_set
);
429 void bt_plugin_set_add_plugin(struct bt_plugin_set
*plugin_set
,
430 struct bt_plugin
*plugin
)
432 BT_ASSERT(plugin_set
);
434 bt_object_get_ref(plugin
);
435 g_ptr_array_add(plugin_set
->plugins
, plugin
);
436 BT_LIB_LOGV("Added plugin to plugin set: "
437 "plugin-set-addr=%p, %![plugin-]+l",
441 #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */