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 "common/macros.h"
28 #include "lib/graph/component-class.h"
29 #include <babeltrace2/plugin/plugin-const.h>
30 #include <babeltrace2/plugin/plugin-dev.h>
31 #include "lib/object.h"
32 #include <babeltrace2/types.h>
33 #include "common/assert.h"
37 #include "plugin-so.h"
38 #include "lib/func-status.h"
40 /* Protection: this file uses BT_LIB_LOG*() macros directly */
41 #ifndef BT_LIB_LOG_SUPPORTED
42 # error Please include "lib/logging.h" before including this file.
46 BT_PLUGIN_TYPE_SO
= 0,
47 BT_PLUGIN_TYPE_PYTHON
= 1,
51 struct bt_object base
;
52 enum bt_plugin_type type
;
54 /* Arrays of `struct bt_component_class *` (owned by this) */
55 GPtrArray
*src_comp_classes
;
56 GPtrArray
*flt_comp_classes
;
57 GPtrArray
*sink_comp_classes
;
59 /* Info (owned by this) */
80 /* Value depends on the specific plugin type */
82 void (*destroy_spec_data
)(struct bt_plugin
*);
85 struct bt_plugin_set
{
86 struct bt_object base
;
88 /* Array of struct bt_plugin * */
93 const char *bt_plugin_type_string(enum bt_plugin_type type
)
96 case BT_PLUGIN_TYPE_SO
:
98 case BT_PLUGIN_TYPE_PYTHON
:
106 void bt_plugin_destroy(struct bt_object
*obj
)
108 struct bt_plugin
*plugin
;
111 plugin
= container_of(obj
, struct bt_plugin
, base
);
112 BT_LIB_LOGI("Destroying plugin object: %!+l", plugin
);
114 if (plugin
->destroy_spec_data
) {
115 plugin
->destroy_spec_data(plugin
);
118 if (plugin
->src_comp_classes
) {
119 BT_LOGD_STR("Putting source component classes.");
120 g_ptr_array_free(plugin
->src_comp_classes
, TRUE
);
121 plugin
->src_comp_classes
= NULL
;
124 if (plugin
->flt_comp_classes
) {
125 BT_LOGD_STR("Putting filter component classes.");
126 g_ptr_array_free(plugin
->flt_comp_classes
, TRUE
);
127 plugin
->flt_comp_classes
= NULL
;
130 if (plugin
->sink_comp_classes
) {
131 BT_LOGD_STR("Putting sink component classes.");
132 g_ptr_array_free(plugin
->sink_comp_classes
, TRUE
);
133 plugin
->sink_comp_classes
= NULL
;
136 if (plugin
->info
.name
) {
137 g_string_free(plugin
->info
.name
, TRUE
);
138 plugin
->info
.name
= NULL
;
141 if (plugin
->info
.path
) {
142 g_string_free(plugin
->info
.path
, TRUE
);
143 plugin
->info
.path
= NULL
;
146 if (plugin
->info
.description
) {
147 g_string_free(plugin
->info
.description
, TRUE
);
148 plugin
->info
.description
= NULL
;
151 if (plugin
->info
.author
) {
152 g_string_free(plugin
->info
.author
, TRUE
);
153 plugin
->info
.author
= NULL
;
156 if (plugin
->info
.license
) {
157 g_string_free(plugin
->info
.license
, TRUE
);
158 plugin
->info
.license
= NULL
;
161 if (plugin
->info
.version
.extra
) {
162 g_string_free(plugin
->info
.version
.extra
, TRUE
);
163 plugin
->info
.version
.extra
= NULL
;
170 struct bt_plugin
*bt_plugin_create_empty(enum bt_plugin_type type
)
172 struct bt_plugin
*plugin
= NULL
;
174 BT_LOGD("Creating empty plugin object: type=%s",
175 bt_plugin_type_string(type
));
177 plugin
= g_new0(struct bt_plugin
, 1);
179 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one plugin.");
183 bt_object_init_shared(&plugin
->base
, bt_plugin_destroy
);
186 /* Create empty arrays of component classes */
187 plugin
->src_comp_classes
=
188 g_ptr_array_new_with_free_func(
189 (GDestroyNotify
) bt_object_put_ref
);
190 if (!plugin
->src_comp_classes
) {
191 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
195 plugin
->flt_comp_classes
=
196 g_ptr_array_new_with_free_func(
197 (GDestroyNotify
) bt_object_put_ref
);
198 if (!plugin
->flt_comp_classes
) {
199 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
203 plugin
->sink_comp_classes
=
204 g_ptr_array_new_with_free_func(
205 (GDestroyNotify
) bt_object_put_ref
);
206 if (!plugin
->sink_comp_classes
) {
207 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
211 /* Create empty info */
212 plugin
->info
.name
= g_string_new(NULL
);
213 if (!plugin
->info
.name
) {
214 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
218 plugin
->info
.path
= g_string_new(NULL
);
219 if (!plugin
->info
.path
) {
220 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
224 plugin
->info
.description
= g_string_new(NULL
);
225 if (!plugin
->info
.description
) {
226 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
230 plugin
->info
.author
= g_string_new(NULL
);
231 if (!plugin
->info
.author
) {
232 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
236 plugin
->info
.license
= g_string_new(NULL
);
237 if (!plugin
->info
.license
) {
238 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
242 plugin
->info
.version
.extra
= g_string_new(NULL
);
243 if (!plugin
->info
.version
.extra
) {
244 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
248 BT_LIB_LOGD("Created empty plugin object: %!+l", plugin
);
252 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
259 void bt_plugin_set_path(struct bt_plugin
*plugin
, const char *path
)
263 g_string_assign(plugin
->info
.path
, path
);
264 plugin
->info
.path_set
= BT_TRUE
;
265 BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, path=\"%s\"",
270 void bt_plugin_set_name(struct bt_plugin
*plugin
, const char *name
)
274 g_string_assign(plugin
->info
.name
, name
);
275 plugin
->info
.name_set
= BT_TRUE
;
276 BT_LIB_LOGD("Set plugin's name: %![plugin-]+l, name=\"%s\"",
281 void bt_plugin_set_description(struct bt_plugin
*plugin
,
282 const char *description
)
285 BT_ASSERT(description
);
286 g_string_assign(plugin
->info
.description
, description
);
287 plugin
->info
.description_set
= BT_TRUE
;
288 BT_LIB_LOGD("Set plugin's description: %![plugin-]+l", plugin
);
292 void bt_plugin_set_author(struct bt_plugin
*plugin
, const char *author
)
296 g_string_assign(plugin
->info
.author
, author
);
297 plugin
->info
.author_set
= BT_TRUE
;
298 BT_LIB_LOGD("Set plugin's author: %![plugin-]+l, author=\"%s\"",
303 void bt_plugin_set_license(struct bt_plugin
*plugin
, const char *license
)
307 g_string_assign(plugin
->info
.license
, license
);
308 plugin
->info
.license_set
= BT_TRUE
;
309 BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, license=\"%s\"",
314 void bt_plugin_set_version(struct bt_plugin
*plugin
, unsigned int major
,
315 unsigned int minor
, unsigned int patch
, const char *extra
)
318 plugin
->info
.version
.major
= major
;
319 plugin
->info
.version
.minor
= minor
;
320 plugin
->info
.version
.patch
= patch
;
323 g_string_assign(plugin
->info
.version
.extra
, extra
);
326 plugin
->info
.version_set
= BT_TRUE
;
327 BT_LIB_LOGD("Set plugin's version: %![plugin-]+l, "
328 "major=%u, minor=%u, patch=%u, extra=\"%s\"",
329 plugin
, major
, minor
, patch
, extra
);
333 int bt_plugin_add_component_class(
334 struct bt_plugin
*plugin
, struct bt_component_class
*comp_class
)
336 GPtrArray
*comp_classes
;
339 BT_ASSERT(comp_class
);
341 switch (comp_class
->type
) {
342 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
343 comp_classes
= plugin
->src_comp_classes
;
345 case BT_COMPONENT_CLASS_TYPE_FILTER
:
346 comp_classes
= plugin
->flt_comp_classes
;
348 case BT_COMPONENT_CLASS_TYPE_SINK
:
349 comp_classes
= plugin
->sink_comp_classes
;
355 /* Set component class's original plugin name */
356 BT_ASSERT(comp_class
->plugin_name
);
357 BT_ASSERT(plugin
->info
.name
);
358 g_string_assign(comp_class
->plugin_name
, plugin
->info
.name
->str
);
360 /* Add new component class */
361 bt_object_get_ref(comp_class
);
362 g_ptr_array_add(comp_classes
, comp_class
);
364 /* Special case for a shared object plugin */
365 if (plugin
->type
== BT_PLUGIN_TYPE_SO
) {
366 bt_plugin_so_on_add_component_class(plugin
, comp_class
);
369 BT_LIB_LOGD("Added component class to plugin: "
370 "%![plugin-]+l, %![cc-]+C", plugin
, comp_class
);
371 return BT_FUNC_STATUS_OK
;
375 void bt_plugin_set_destroy(struct bt_object
*obj
)
377 struct bt_plugin_set
*plugin_set
=
378 container_of(obj
, struct bt_plugin_set
, base
);
384 BT_LOGD("Destroying plugin set: addr=%p", plugin_set
);
386 if (plugin_set
->plugins
) {
387 BT_LOGD_STR("Putting plugins.");
388 g_ptr_array_free(plugin_set
->plugins
, TRUE
);
395 struct bt_plugin_set
*bt_plugin_set_create(void)
397 struct bt_plugin_set
*plugin_set
= g_new0(struct bt_plugin_set
, 1);
403 BT_LOGD_STR("Creating empty plugin set.");
404 bt_object_init_shared(&plugin_set
->base
, bt_plugin_set_destroy
);
406 plugin_set
->plugins
= g_ptr_array_new_with_free_func(
407 (GDestroyNotify
) bt_object_put_ref
);
408 if (!plugin_set
->plugins
) {
409 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
410 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
414 BT_LOGD("Created empty plugin set: addr=%p", plugin_set
);
421 bool bt_plugin_set_contains_plugin(struct bt_plugin_set
*plugin_set
,
425 bool contains
= false;
427 BT_ASSERT(plugin_set
);
430 for (i
= 0; i
< plugin_set
->plugins
->len
; i
++) {
431 const struct bt_plugin
*plugin
= plugin_set
->plugins
->pdata
[i
];
433 if (strcmp(plugin
->info
.name
->str
, name
) == 0) {
444 void bt_plugin_set_add_plugin(struct bt_plugin_set
*plugin_set
,
445 struct bt_plugin
*plugin
)
447 BT_ASSERT(plugin_set
);
450 if (bt_plugin_set_contains_plugin(plugin_set
,
451 plugin
->info
.name
->str
)) {
455 bt_object_get_ref(plugin
);
456 g_ptr_array_add(plugin_set
->plugins
, plugin
);
457 BT_LIB_LOGD("Added plugin to plugin set: "
458 "plugin-set-addr=%p, %![plugin-]+l",
465 #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */