1 #ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
2 #define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
5 * BabelTrace - Plug-in Internal
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/babeltrace-internal.h>
31 #include <babeltrace/plugin/plugin.h>
32 #include <babeltrace/plugin/plugin-dev.h>
33 #include <babeltrace/object-internal.h>
34 #include <babeltrace/types.h>
35 #include <babeltrace/assert-internal.h>
39 BT_PLUGIN_TYPE_SO
= 0,
40 BT_PLUGIN_TYPE_PYTHON
= 1,
44 struct bt_object base
;
45 enum bt_plugin_type type
;
48 /* Array of pointers to bt_component_class (owned by this) */
49 GPtrArray
*comp_classes
;
51 /* Info (owned by this) */
68 bt_bool description_set
;
72 /* Value depends on the specific plugin type */
74 void (*destroy_spec_data
)(struct bt_plugin
*);
77 struct bt_plugin_set
{
78 struct bt_object base
;
80 /* Array of struct bt_plugin * */
85 const char *bt_plugin_status_string(enum bt_plugin_status status
)
88 case BT_PLUGIN_STATUS_OK
:
89 return "BT_PLUGIN_STATUS_OK";
90 case BT_PLUGIN_STATUS_ERROR
:
91 return "BT_PLUGIN_STATUS_ERROR";
92 case BT_PLUGIN_STATUS_NOMEM
:
93 return "BT_PLUGIN_STATUS_NOMEM";
100 const char *bt_plugin_type_string(enum bt_plugin_type type
)
103 case BT_PLUGIN_TYPE_SO
:
104 return "BT_PLUGIN_TYPE_SO";
105 case BT_PLUGIN_TYPE_PYTHON
:
106 return "BT_PLUGIN_TYPE_PYTHON";
113 void bt_plugin_destroy(struct bt_object
*obj
)
115 struct bt_plugin
*plugin
;
118 plugin
= container_of(obj
, struct bt_plugin
, base
);
119 BT_LOGD("Destroying plugin object: addr=%p, name=\"%s\"",
120 plugin
, plugin
->info
.name
? plugin
->info
.name
->str
: NULL
);
122 if (plugin
->destroy_spec_data
) {
123 plugin
->destroy_spec_data(plugin
);
126 if (plugin
->comp_classes
) {
127 BT_LOGD_STR("Putting component classes.");
128 g_ptr_array_free(plugin
->comp_classes
, TRUE
);
131 if (plugin
->info
.name
) {
132 g_string_free(plugin
->info
.name
, TRUE
);
135 if (plugin
->info
.path
) {
136 g_string_free(plugin
->info
.path
, TRUE
);
139 if (plugin
->info
.description
) {
140 g_string_free(plugin
->info
.description
, TRUE
);
143 if (plugin
->info
.author
) {
144 g_string_free(plugin
->info
.author
, TRUE
);
147 if (plugin
->info
.license
) {
148 g_string_free(plugin
->info
.license
, TRUE
);
151 if (plugin
->info
.version
.extra
) {
152 g_string_free(plugin
->info
.version
.extra
, TRUE
);
159 struct bt_plugin
*bt_plugin_create_empty(enum bt_plugin_type type
)
161 struct bt_plugin
*plugin
= NULL
;
163 BT_LOGD("Creating empty plugin object: type=%s",
164 bt_plugin_type_string(type
));
166 plugin
= g_new0(struct bt_plugin
, 1);
168 BT_LOGE_STR("Failed to allocate one plugin.");
172 bt_object_init_shared(&plugin
->base
, bt_plugin_destroy
);
175 /* Create empty array of component classes */
176 plugin
->comp_classes
=
177 g_ptr_array_new_with_free_func((GDestroyNotify
) bt_object_put_ref
);
178 if (!plugin
->comp_classes
) {
179 BT_LOGE_STR("Failed to allocate a GPtrArray.");
183 /* Create empty info */
184 plugin
->info
.name
= g_string_new(NULL
);
185 if (!plugin
->info
.name
) {
186 BT_LOGE_STR("Failed to allocate a GString.");
190 plugin
->info
.path
= g_string_new(NULL
);
191 if (!plugin
->info
.path
) {
192 BT_LOGE_STR("Failed to allocate a GString.");
196 plugin
->info
.description
= g_string_new(NULL
);
197 if (!plugin
->info
.description
) {
198 BT_LOGE_STR("Failed to allocate a GString.");
202 plugin
->info
.author
= g_string_new(NULL
);
203 if (!plugin
->info
.author
) {
204 BT_LOGE_STR("Failed to allocate a GString.");
208 plugin
->info
.license
= g_string_new(NULL
);
209 if (!plugin
->info
.license
) {
210 BT_LOGE_STR("Failed to allocate a GString.");
214 plugin
->info
.version
.extra
= g_string_new(NULL
);
215 if (!plugin
->info
.version
.extra
) {
216 BT_LOGE_STR("Failed to allocate a GString.");
220 BT_LOGD("Created empty plugin object: type=%s, addr=%p",
221 bt_plugin_type_string(type
), plugin
);
225 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
232 void bt_plugin_set_path(struct bt_plugin
*plugin
, const char *path
)
236 g_string_assign(plugin
->info
.path
, path
);
237 plugin
->info
.path_set
= BT_TRUE
;
238 BT_LOGV("Set plugin's path: addr=%p, name=\"%s\", path=\"%s\"",
239 plugin
, bt_plugin_get_name(plugin
), path
);
243 void bt_plugin_set_name(struct bt_plugin
*plugin
, const char *name
)
247 g_string_assign(plugin
->info
.name
, name
);
248 plugin
->info
.name_set
= BT_TRUE
;
249 BT_LOGV("Set plugin's name: addr=%p, name=\"%s\"",
254 void bt_plugin_set_description(struct bt_plugin
*plugin
,
255 const char *description
)
258 BT_ASSERT(description
);
259 g_string_assign(plugin
->info
.description
, description
);
260 plugin
->info
.description_set
= BT_TRUE
;
261 BT_LOGV("Set plugin's description: addr=%p, name=\"%s\"",
262 plugin
, bt_plugin_get_name(plugin
));
266 void bt_plugin_set_author(struct bt_plugin
*plugin
, const char *author
)
270 g_string_assign(plugin
->info
.author
, author
);
271 plugin
->info
.author_set
= BT_TRUE
;
272 BT_LOGV("Set plugin's author: addr=%p, name=\"%s\", author=\"%s\"",
273 plugin
, bt_plugin_get_name(plugin
), author
);
277 void bt_plugin_set_license(struct bt_plugin
*plugin
, const char *license
)
281 g_string_assign(plugin
->info
.license
, license
);
282 plugin
->info
.license_set
= BT_TRUE
;
283 BT_LOGV("Set plugin's path: addr=%p, name=\"%s\", license=\"%s\"",
284 plugin
, bt_plugin_get_name(plugin
), license
);
288 void bt_plugin_set_version(struct bt_plugin
*plugin
, unsigned int major
,
289 unsigned int minor
, unsigned int patch
, const char *extra
)
292 plugin
->info
.version
.major
= major
;
293 plugin
->info
.version
.minor
= minor
;
294 plugin
->info
.version
.patch
= patch
;
297 g_string_assign(plugin
->info
.version
.extra
, extra
);
300 plugin
->info
.version_set
= BT_TRUE
;
301 BT_LOGV("Set plugin's version: addr=%p, name=\"%s\", "
302 "major=%u, minor=%u, patch=%u, extra=\"%s\"",
303 plugin
, bt_plugin_get_name(plugin
),
304 major
, minor
, patch
, extra
);
308 void bt_plugin_freeze(struct bt_plugin
*plugin
)
312 if (plugin
->frozen
) {
316 BT_LOGD("Freezing plugin: addr=%p, name=\"%s\", path=\"%s\"",
317 plugin
, bt_plugin_get_name(plugin
),
318 bt_plugin_get_path(plugin
));
319 plugin
->frozen
= BT_TRUE
;
323 void bt_plugin_set_destroy(struct bt_object
*obj
)
325 struct bt_plugin_set
*plugin_set
=
326 container_of(obj
, struct bt_plugin_set
, base
);
332 BT_LOGD("Destroying plugin set: addr=%p", plugin_set
);
334 if (plugin_set
->plugins
) {
335 BT_LOGD_STR("Putting plugins.");
336 g_ptr_array_free(plugin_set
->plugins
, TRUE
);
343 struct bt_plugin_set
*bt_plugin_set_create(void)
345 struct bt_plugin_set
*plugin_set
= g_new0(struct bt_plugin_set
, 1);
351 BT_LOGD_STR("Creating empty plugin set.");
352 bt_object_init_shared(&plugin_set
->base
, bt_plugin_set_destroy
);
354 plugin_set
->plugins
= g_ptr_array_new_with_free_func(
355 (GDestroyNotify
) bt_object_put_ref
);
356 if (!plugin_set
->plugins
) {
357 BT_LOGE_STR("Failed to allocate a GPtrArray.");
358 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
362 BT_LOGD("Created empty plugin set: addr=%p", plugin_set
);
369 void bt_plugin_set_add_plugin(struct bt_plugin_set
*plugin_set
,
370 struct bt_plugin
*plugin
)
372 BT_ASSERT(plugin_set
);
374 g_ptr_array_add(plugin_set
->plugins
, bt_object_get_ref(plugin
));
375 BT_LOGV("Added plugin to plugin set: "
376 "plugin-set-addr=%p, plugin-addr=%p, plugin-name=\"%s\", "
377 "plugin-path=\"%s\"",
378 plugin_set
, plugin
, bt_plugin_get_name(plugin
),
379 bt_plugin_get_path(plugin
));
382 #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */
This page took 0.037795 seconds and 5 git commands to generate.