[babeltrace.git] / plugins / plugin.c

/*
 * plugin.c
 *
 * Babeltrace Plugin
 * 
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * 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 <babeltrace/compiler.h>
#include <babeltrace/ref.h>
#include <babeltrace/plugin/plugin-internal.h>
#include <glib.h>

#define PLUGIN_SYMBOL_NAME	"__bt_plugin_name"
#define PLUGIN_SYMBOL_AUTHOR	"__bt_plugin_author"
#define PLUGIN_SYMBOL_LICENSE	"__bt_plugin_license"
#define PLUGIN_SYMBOL_INIT	"__bt_plugin_init"
#define PLUGIN_SYMBOL_EXIT	"__bt_plugin_exit"

static
void bt_plugin_destroy(struct bt_object *obj)
{
	struct bt_plugin *plugin;

	assert(obj);
	plugin = container_of(obj, struct bt_plugin, base);

	if (plugin->module) {
		if (!g_module_close(plugin->module)) {
			printf_error("Module close error: %s",
				g_module_error());

		}
	}
	g_free(plugin);
}

BT_HIDDEN
struct bt_plugin *bt_plugin_create(GModule *module)
{
	struct bt_plugin *plugin = NULL;

	if (!module) {
		goto error;
	}

	plugin = g_new0(struct bt_plugin, 1);
	if (!plugin) {
		goto error;
	}

	bt_object_init(plugin, bt_plugin_destroy);
	if (!g_module_symbol(module, PLUGIN_SYMBOL_NAME,
		(gpointer *) &plugin->name))
	{
		printf_error("Unable to resolve plugin symbol %s from %s",
			PLUGIN_SYMBOL_NAME, g_module_name(module));
		goto error;
	}
	if (!g_module_symbol(module, PLUGIN_SYMBOL_LICENSE,
		(gpointer *) &plugin->license))
	{
		printf_error("Unable to resolve plugin symbol %s from %s",
			PLUGIN_SYMBOL_LICENSE, g_module_name(module));
		goto error;
	}
	if (!g_module_symbol(module, PLUGIN_SYMBOL_INIT,
		(gpointer *) &plugin->init))
	{
		printf_error("Unable to resolve plugin symbol %s from %s",
			PLUGIN_SYMBOL_INIT, g_module_name(module));
		goto error;
	}

	/* Optional symbols */
	g_module_symbol(module, PLUGIN_SYMBOL_EXIT, (gpointer *) &plugin->exit);
	g_module_symbol(module, PLUGIN_SYMBOL_AUTHOR,
		(gpointer *) &plugin->author);

	return plugin;
error:
        BT_PUT(plugin);
	return plugin;
}

BT_HIDDEN
enum bt_component_status bt_plugin_register_component_classes(
		struct bt_plugin *plugin, struct bt_component_factory *factory)
{
	assert(plugin && factory);
	return plugin->init(factory);
}
Commit	Line	Data
fb2dcc52 JG	1	/*
	2	* plugin.c
	3	*
	4	* Babeltrace Plugin
	5	*
	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
	29	#include <babeltrace/compiler.h>
b8a06801	30	#include <babeltrace/ref.h>
fb2dcc52 JG	31	#include <babeltrace/plugin/plugin-internal.h>
	32	#include <glib.h>
	33
50335272 JG	34	#define PLUGIN_SYMBOL_NAME "__bt_plugin_name"
	35	#define PLUGIN_SYMBOL_AUTHOR "__bt_plugin_author"
	36	#define PLUGIN_SYMBOL_LICENSE "__bt_plugin_license"
	37	#define PLUGIN_SYMBOL_INIT "__bt_plugin_init"
	38	#define PLUGIN_SYMBOL_EXIT "__bt_plugin_exit"
	39
fb2dcc52	40	static
b8a06801	41	void bt_plugin_destroy(struct bt_object *obj)
fb2dcc52 JG	42	{
	43	struct bt_plugin *plugin;
	44
b8a06801 JG	45	assert(obj);
	46	plugin = container_of(obj, struct bt_plugin, base);
	47
fb2dcc52 JG	48	if (plugin->module) {
	49	if (!g_module_close(plugin->module)) {
	50	printf_error("Module close error: %s",
	51	g_module_error());
	52
	53	}
	54	}
	55	g_free(plugin);
	56	}
	57
	58	BT_HIDDEN
	59	struct bt_plugin bt_plugin_create(GModule module)
	60	{
50335272 JG	61	struct bt_plugin *plugin = NULL;
	62
	63	if (!module) {
	64	goto error;
	65	}
fb2dcc52 JG	66
	67	plugin = g_new0(struct bt_plugin, 1);
	68	if (!plugin) {
50335272	69	goto error;
fb2dcc52 JG	70	}
fb2dcc52 JG	71
b8a06801	72	bt_object_init(plugin, bt_plugin_destroy);
50335272 JG	73	if (!g_module_symbol(module, PLUGIN_SYMBOL_NAME,
	74	(gpointer *) &plugin->name))
	75	{
	76	printf_error("Unable to resolve plugin symbol %s from %s",
	77	PLUGIN_SYMBOL_NAME, g_module_name(module));
	78	goto error;
	79	}
	80	if (!g_module_symbol(module, PLUGIN_SYMBOL_LICENSE,
	81	(gpointer *) &plugin->license))
	82	{
	83	printf_error("Unable to resolve plugin symbol %s from %s",
	84	PLUGIN_SYMBOL_LICENSE, g_module_name(module));
	85	goto error;
	86	}
	87	if (!g_module_symbol(module, PLUGIN_SYMBOL_INIT,
	88	(gpointer *) &plugin->init))
	89	{
	90	printf_error("Unable to resolve plugin symbol %s from %s",
	91	PLUGIN_SYMBOL_INIT, g_module_name(module));
	92	goto error;
	93	}
	94
	95	/* Optional symbols */
	96	g_module_symbol(module, PLUGIN_SYMBOL_EXIT, (gpointer *) &plugin->exit);
	97	g_module_symbol(module, PLUGIN_SYMBOL_AUTHOR,
	98	(gpointer *) &plugin->author);
	99
fb2dcc52	100	return plugin;
50335272	101	error:
b8a06801 JG	102	BT_PUT(plugin);
b8a06801 JG	103	return plugin;
fb2dcc52 JG	104	}
	105
	106	BT_HIDDEN
	107	enum bt_component_status bt_plugin_register_component_classes(
	108	struct bt_plugin plugin, struct bt_component_factory factory)
	109	{
	110	assert(plugin && factory);
	111	return plugin->init(factory);
	112	}