From 0777b693891d963ed90dbd5ef45e30cc259d84f9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Wed, 20 May 2015 17:22:17 -0400 Subject: [PATCH] Implement source plugin base MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/babeltrace/plugin/plugin-internal.h | 9 ++- include/babeltrace/plugin/plugin-system.h | 4 +- include/babeltrace/plugin/source-internal.h | 48 ++++++++++++++ plugins/plugin.c | 55 +++++++++++++++- plugins/source.c | 72 +++++++++++++++++++++ 5 files changed, 184 insertions(+), 4 deletions(-) diff --git a/include/babeltrace/plugin/plugin-internal.h b/include/babeltrace/plugin/plugin-internal.h index 91f36219..2214dc96 100644 --- a/include/babeltrace/plugin/plugin-internal.h +++ b/include/babeltrace/plugin/plugin-internal.h @@ -44,10 +44,17 @@ struct bt_plugin { /** No ownership taken */ FILE *error_stream; - /* Plug-in implementation callbacks */ + void *user_data; + bt_plugin_destroy_cb user_data_destroy; bt_plugin_destroy_cb destroy; }; +BT_HIDDEN +enum bt_plugin_status bt_plugin_init(struct bt_plugin *plugin, const char *name, + void *user_data,bt_plugin_destroy_func destroy_func, + enum bt_plugin_type plugin_type, + bt_plugin_destroy_func plugin_destroy); + #ifdef __cplusplus } #endif diff --git a/include/babeltrace/plugin/plugin-system.h b/include/babeltrace/plugin/plugin-system.h index 7b955f4d..b8aa4a3b 100644 --- a/include/babeltrace/plugin/plugin-system.h +++ b/include/babeltrace/plugin/plugin-system.h @@ -52,7 +52,7 @@ typedef void (*bt_plugin_destroy_cb)(struct bt_plugin *plugin); extern void *bt_plugin_get_private_data(struct bt_plugin *plugin); -/* Plug-in initialization functions */ +/** Plug-in initialization functions */ /** * Allocate a source plug-in. * @@ -80,7 +80,7 @@ extern struct bt_plugin *bt_plugin_sink_create(const char *name, bt_plugin_sink_handle_notification_cb notification_cb); -/* Notification iterator functions */ +/** Notification iterator functions */ /** * Allocate a notification iterator. * diff --git a/include/babeltrace/plugin/source-internal.h b/include/babeltrace/plugin/source-internal.h index e69de29b..1b45d92e 100644 --- a/include/babeltrace/plugin/source-internal.h +++ b/include/babeltrace/plugin/source-internal.h @@ -0,0 +1,48 @@ +#ifndef BABELTRACE_PLUGIN_SOURCE_INTERNAL_H +#define BABELTRACE_PLUGIN_SOURCE_INTERNAL_H + +/* + * BabelTrace - Source Plug-in internal + * + * Copyright 2015 Jérémie Galarneau + * + * Author: Jérémie Galarneau + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +struct bt_plugin_source { + struct bt_plugin parent; + + /* Plug-in implementation callbacks */ + bt_plugin_source_iterator_create_func create_iterator; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* BABELTRACE_PLUGIN_SOURCE_INTERNAL_H */ diff --git a/plugins/plugin.c b/plugins/plugin.c index e857381d..8714d689 100644 --- a/plugins/plugin.c +++ b/plugins/plugin.c @@ -97,5 +97,58 @@ void bt_plugin_put(struct bt_plugin *plugin) return; } - bt_ctf_ref_put(&plugin->ref_count); + bt_ctf_ref_put(&plugin->ref_count, bt_plugin_destroy); +} + +BT_HIDDEN +enum bt_plugin_status bt_plugin_init(struct bt_plugin *plugin, const char *name, + void *user_data, bt_plugin_destroy_func user_destroy_func, + enum bt_plugin_type plugin_type, + bt_plugin_destroy_func plugin_destroy) +{ + enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; + + if (!plugin || !name || name[0] == '\0' || + !destroy_func || !private_data) { + ret = BT_PLUGIN_STATUS_INVAL; + goto end; + } + + bt_ctf_ref_init(&plugin->ref_count); + plugin->type = plugin_type; + plugin->user_data = user_data; + plugin->user_data_destroy = user_destroy_func; + plugin->destroy = plugin_destroy; + + plugin->name = g_string_new(name); + if (!plugin->name) { + ret = BT_PLUGIN_STATUS_NOMEM; + goto end; + } +end: + return ret; +} + +static +void bt_plugin_destroy(struct bt_ctf_ref *ref) +{ + struct bt_ctf_plugin *plugin = NULL; + + if (!ref) { + return; + } + + plugin = container_of(ref, struct bt_plugin, parent); + + /** + * Destroy user data, base and source/filter/sink last since + * it will deallocate the plugin. + */ + assert(plugin->user_destroy_func); + plugin->user_destroy_func(plugin->user_data); + + g_string_free(plugin->name, TRUE); + + assert(plugin->destroy); + plugin->destroy(plugin); } diff --git a/plugins/source.c b/plugins/source.c index e69de29b..5aa8fc54 100644 --- a/plugins/source.c +++ b/plugins/source.c @@ -0,0 +1,72 @@ +/* + * source.c + * + * Babeltrace Source Plugin + * + * Copyright 2015 Jérémie Galarneau + * + * Author: Jérémie Galarneau + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +#include +#include + +static +void bt_plugin_source_destroy(struct bt_plugin *plugin) +{ + struct bt_plugin_source *source; + + if (!plugin) { + return; + } + + source = container_of(plugin, struct bt_plugin_source, parent); + g_free(source); +} + +struct bt_plugin *bt_plugin_source_create(const char *name, + void *private_data, bt_plugin_destroy_func destroy_func, + bt_plugin_source_iterator_create_cb iterator_create_cb) +{ + struct bt_plugin_source *source = NULL; + enum bt_plugin_status ret; + + if (!iterator_create_cb) { + goto end; + } + + source = g_new0(struct bt_plugin_source, 1); + if (!source) { + goto end; + } + + ret = bt_plugin_init(&source->parent, name, private_data, + destroy_func, BT_PLUGIN_TYPE_SOURCE, bt_plugin_source_destroy); + if (ret != BT_PLUGIN_STATUS_OK) { + g_free(source); + source = NULL; + goto end; + } + + source->create_iterator = iterator_create_cb; +end: + return source ? &source->parent : NULL; +} -- 2.34.1