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"
36 #include "plugin-so.h"
38 /* Protection: this file uses BT_LIB_LOG*() macros directly */
39 #ifndef BT_LIB_LOG_SUPPORTED
40 # error Please include "lib/logging.h" before including this file.
44 BT_PLUGIN_TYPE_SO
= 0,
45 BT_PLUGIN_TYPE_PYTHON
= 1,
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_NOT_FOUND
:
97 return "BT_PLUGIN_STATUS_NOT_FOUND";
98 case BT_PLUGIN_STATUS_ERROR
:
99 return "BT_PLUGIN_STATUS_ERROR";
100 case BT_PLUGIN_STATUS_LOADING_ERROR
:
101 return "BT_PLUGIN_STATUS_LOADING_ERROR";
102 case BT_PLUGIN_STATUS_NOMEM
:
103 return "BT_PLUGIN_STATUS_NOMEM";
110 const char *bt_plugin_type_string(enum bt_plugin_type type
)
113 case BT_PLUGIN_TYPE_SO
:
114 return "BT_PLUGIN_TYPE_SO";
115 case BT_PLUGIN_TYPE_PYTHON
:
116 return "BT_PLUGIN_TYPE_PYTHON";
123 void bt_plugin_destroy(struct bt_object
*obj
)
125 struct bt_plugin
*plugin
;
128 plugin
= container_of(obj
, struct bt_plugin
, base
);
129 BT_LIB_LOGI("Destroying plugin object: %!+l", plugin
);
131 if (plugin
->destroy_spec_data
) {
132 plugin
->destroy_spec_data(plugin
);
135 if (plugin
->src_comp_classes
) {
136 BT_LOGD_STR("Putting source component classes.");
137 g_ptr_array_free(plugin
->src_comp_classes
, TRUE
);
138 plugin
->src_comp_classes
= NULL
;
141 if (plugin
->flt_comp_classes
) {
142 BT_LOGD_STR("Putting filter component classes.");
143 g_ptr_array_free(plugin
->flt_comp_classes
, TRUE
);
144 plugin
->flt_comp_classes
= NULL
;
147 if (plugin
->sink_comp_classes
) {
148 BT_LOGD_STR("Putting sink component classes.");
149 g_ptr_array_free(plugin
->sink_comp_classes
, TRUE
);
150 plugin
->sink_comp_classes
= NULL
;
153 if (plugin
->info
.name
) {
154 g_string_free(plugin
->info
.name
, TRUE
);
155 plugin
->info
.name
= NULL
;
158 if (plugin
->info
.path
) {
159 g_string_free(plugin
->info
.path
, TRUE
);
160 plugin
->info
.path
= NULL
;
163 if (plugin
->info
.description
) {
164 g_string_free(plugin
->info
.description
, TRUE
);
165 plugin
->info
.description
= NULL
;
168 if (plugin
->info
.author
) {
169 g_string_free(plugin
->info
.author
, TRUE
);
170 plugin
->info
.author
= NULL
;
173 if (plugin
->info
.license
) {
174 g_string_free(plugin
->info
.license
, TRUE
);
175 plugin
->info
.license
= NULL
;
178 if (plugin
->info
.version
.extra
) {
179 g_string_free(plugin
->info
.version
.extra
, TRUE
);
180 plugin
->info
.version
.extra
= NULL
;
187 struct bt_plugin
*bt_plugin_create_empty(enum bt_plugin_type type
)
189 struct bt_plugin
*plugin
= NULL
;
191 BT_LOGD("Creating empty plugin object: type=%s",
192 bt_plugin_type_string(type
));
194 plugin
= g_new0(struct bt_plugin
, 1);
196 BT_LOGE_STR("Failed to allocate one plugin.");
200 bt_object_init_shared(&plugin
->base
, bt_plugin_destroy
);
203 /* Create empty arrays of component classes */
204 plugin
->src_comp_classes
=
205 g_ptr_array_new_with_free_func(
206 (GDestroyNotify
) bt_object_put_ref
);
207 if (!plugin
->src_comp_classes
) {
208 BT_LOGE_STR("Failed to allocate a GPtrArray.");
212 plugin
->flt_comp_classes
=
213 g_ptr_array_new_with_free_func(
214 (GDestroyNotify
) bt_object_put_ref
);
215 if (!plugin
->flt_comp_classes
) {
216 BT_LOGE_STR("Failed to allocate a GPtrArray.");
220 plugin
->sink_comp_classes
=
221 g_ptr_array_new_with_free_func(
222 (GDestroyNotify
) bt_object_put_ref
);
223 if (!plugin
->sink_comp_classes
) {
224 BT_LOGE_STR("Failed to allocate a GPtrArray.");
228 /* Create empty info */
229 plugin
->info
.name
= g_string_new(NULL
);
230 if (!plugin
->info
.name
) {
231 BT_LOGE_STR("Failed to allocate a GString.");
235 plugin
->info
.path
= g_string_new(NULL
);
236 if (!plugin
->info
.path
) {
237 BT_LOGE_STR("Failed to allocate a GString.");
241 plugin
->info
.description
= g_string_new(NULL
);
242 if (!plugin
->info
.description
) {
243 BT_LOGE_STR("Failed to allocate a GString.");
247 plugin
->info
.author
= g_string_new(NULL
);
248 if (!plugin
->info
.author
) {
249 BT_LOGE_STR("Failed to allocate a GString.");
253 plugin
->info
.license
= g_string_new(NULL
);
254 if (!plugin
->info
.license
) {
255 BT_LOGE_STR("Failed to allocate a GString.");
259 plugin
->info
.version
.extra
= g_string_new(NULL
);
260 if (!plugin
->info
.version
.extra
) {
261 BT_LOGE_STR("Failed to allocate a GString.");
265 BT_LIB_LOGD("Created empty plugin object: %!+l", plugin
);
269 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
276 void bt_plugin_set_path(struct bt_plugin
*plugin
, const char *path
)
280 g_string_assign(plugin
->info
.path
, path
);
281 plugin
->info
.path_set
= BT_TRUE
;
282 BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, path=\"%s\"",
287 void bt_plugin_set_name(struct bt_plugin
*plugin
, const char *name
)
291 g_string_assign(plugin
->info
.name
, name
);
292 plugin
->info
.name_set
= BT_TRUE
;
293 BT_LIB_LOGD("Set plugin's name: %![plugin-]+l, name=\"%s\"",
298 void bt_plugin_set_description(struct bt_plugin
*plugin
,
299 const char *description
)
302 BT_ASSERT(description
);
303 g_string_assign(plugin
->info
.description
, description
);
304 plugin
->info
.description_set
= BT_TRUE
;
305 BT_LIB_LOGD("Set plugin's description: %![plugin-]+l", plugin
);
309 void bt_plugin_set_author(struct bt_plugin
*plugin
, const char *author
)
313 g_string_assign(plugin
->info
.author
, author
);
314 plugin
->info
.author_set
= BT_TRUE
;
315 BT_LIB_LOGD("Set plugin's author: %![plugin-]+l, author=\"%s\"",
320 void bt_plugin_set_license(struct bt_plugin
*plugin
, const char *license
)
324 g_string_assign(plugin
->info
.license
, license
);
325 plugin
->info
.license_set
= BT_TRUE
;
326 BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, license=\"%s\"",
331 void bt_plugin_set_version(struct bt_plugin
*plugin
, unsigned int major
,
332 unsigned int minor
, unsigned int patch
, const char *extra
)
335 plugin
->info
.version
.major
= major
;
336 plugin
->info
.version
.minor
= minor
;
337 plugin
->info
.version
.patch
= patch
;
340 g_string_assign(plugin
->info
.version
.extra
, extra
);
343 plugin
->info
.version_set
= BT_TRUE
;
344 BT_LIB_LOGD("Set plugin's version: %![plugin-]+l, "
345 "major=%u, minor=%u, patch=%u, extra=\"%s\"",
346 plugin
, major
, minor
, patch
, extra
);
350 enum bt_plugin_status
bt_plugin_add_component_class(
351 struct bt_plugin
*plugin
, struct bt_component_class
*comp_class
)
353 GPtrArray
*comp_classes
;
356 BT_ASSERT(comp_class
);
358 switch (comp_class
->type
) {
359 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
360 comp_classes
= plugin
->src_comp_classes
;
362 case BT_COMPONENT_CLASS_TYPE_FILTER
:
363 comp_classes
= plugin
->flt_comp_classes
;
365 case BT_COMPONENT_CLASS_TYPE_SINK
:
366 comp_classes
= plugin
->sink_comp_classes
;
372 /* Add new component class */
373 bt_object_get_ref(comp_class
);
374 g_ptr_array_add(comp_classes
, comp_class
);
376 /* Special case for a shared object plugin */
377 if (plugin
->type
== BT_PLUGIN_TYPE_SO
) {
378 bt_plugin_so_on_add_component_class(plugin
, comp_class
);
381 BT_LIB_LOGD("Added component class to plugin: "
382 "%![plugin-]+l, %![cc-]+C", plugin
, comp_class
);
383 return BT_PLUGIN_STATUS_OK
;
387 void bt_plugin_set_destroy(struct bt_object
*obj
)
389 struct bt_plugin_set
*plugin_set
=
390 container_of(obj
, struct bt_plugin_set
, base
);
396 BT_LOGD("Destroying plugin set: addr=%p", plugin_set
);
398 if (plugin_set
->plugins
) {
399 BT_LOGD_STR("Putting plugins.");
400 g_ptr_array_free(plugin_set
->plugins
, TRUE
);
407 struct bt_plugin_set
*bt_plugin_set_create(void)
409 struct bt_plugin_set
*plugin_set
= g_new0(struct bt_plugin_set
, 1);
415 BT_LOGD_STR("Creating empty plugin set.");
416 bt_object_init_shared(&plugin_set
->base
, bt_plugin_set_destroy
);
418 plugin_set
->plugins
= g_ptr_array_new_with_free_func(
419 (GDestroyNotify
) bt_object_put_ref
);
420 if (!plugin_set
->plugins
) {
421 BT_LOGE_STR("Failed to allocate a GPtrArray.");
422 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
426 BT_LOGD("Created empty plugin set: addr=%p", plugin_set
);
433 void bt_plugin_set_add_plugin(struct bt_plugin_set
*plugin_set
,
434 struct bt_plugin
*plugin
)
436 BT_ASSERT(plugin_set
);
438 bt_object_get_ref(plugin
);
439 g_ptr_array_add(plugin_set
->plugins
, plugin
);
440 BT_LIB_LOGD("Added plugin to plugin set: "
441 "plugin-set-addr=%p, %![plugin-]+l",
445 #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */