[babeltrace.git] / src / lib / plugin / plugin.h

#ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
#define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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 "common/macros.h"
#include "lib/graph/component-class.h"
#include <babeltrace2/plugin/plugin-const.h>
#include <babeltrace2/plugin/plugin-dev.h>
#include "lib/object.h"
#include <babeltrace2/types.h>
#include "common/assert.h"
#include <glib.h>
#include <stdbool.h>

#include "plugin-so.h"
#include "lib/func-status.h"

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BT_LIB_LOG_SUPPORTED
# error Please include "lib/logging.h" before including this file.
#endif

enum bt_plugin_type {
	BT_PLUGIN_TYPE_SO = 0,
	BT_PLUGIN_TYPE_PYTHON = 1,
};

struct bt_plugin {
	struct bt_object base;
	enum bt_plugin_type type;

	/* Arrays of `struct bt_component_class *` (owned by this) */
	GPtrArray *src_comp_classes;
	GPtrArray *flt_comp_classes;
	GPtrArray *sink_comp_classes;

	/* Info (owned by this) */
	struct {
		GString *path;
		GString *name;
		GString *author;
		GString *license;
		GString *description;
		struct {
			unsigned int major;
			unsigned int minor;
			unsigned int patch;
			GString *extra;
		} version;
		bool path_set;
		bool name_set;
		bool author_set;
		bool license_set;
		bool description_set;
		bool version_set;
	} info;

	/* Value depends on the specific plugin type */
	void *spec_data;
	void (*destroy_spec_data)(struct bt_plugin *);
};

struct bt_plugin_set {
	struct bt_object base;

	/* Array of struct bt_plugin * */
	GPtrArray *plugins;
};

static inline
const char *bt_plugin_type_string(enum bt_plugin_type type)
{
	switch (type) {
	case BT_PLUGIN_TYPE_SO:
		return "SO";
	case BT_PLUGIN_TYPE_PYTHON:
		return "PYTHON";
	default:
		return "(unknown)";
	}
}

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

	BT_ASSERT(obj);
	plugin = container_of(obj, struct bt_plugin, base);
	BT_LIB_LOGI("Destroying plugin object: %!+l", plugin);

	if (plugin->destroy_spec_data) {
		plugin->destroy_spec_data(plugin);
	}

	if (plugin->src_comp_classes) {
		BT_LOGD_STR("Putting source component classes.");
		g_ptr_array_free(plugin->src_comp_classes, TRUE);
		plugin->src_comp_classes = NULL;
	}

	if (plugin->flt_comp_classes) {
		BT_LOGD_STR("Putting filter component classes.");
		g_ptr_array_free(plugin->flt_comp_classes, TRUE);
		plugin->flt_comp_classes = NULL;
	}

	if (plugin->sink_comp_classes) {
		BT_LOGD_STR("Putting sink component classes.");
		g_ptr_array_free(plugin->sink_comp_classes, TRUE);
		plugin->sink_comp_classes = NULL;
	}

	if (plugin->info.name) {
		g_string_free(plugin->info.name, TRUE);
		plugin->info.name = NULL;
	}

	if (plugin->info.path) {
		g_string_free(plugin->info.path, TRUE);
		plugin->info.path = NULL;
	}

	if (plugin->info.description) {
		g_string_free(plugin->info.description, TRUE);
		plugin->info.description = NULL;
	}

	if (plugin->info.author) {
		g_string_free(plugin->info.author, TRUE);
		plugin->info.author = NULL;
	}

	if (plugin->info.license) {
		g_string_free(plugin->info.license, TRUE);
		plugin->info.license = NULL;
	}

	if (plugin->info.version.extra) {
		g_string_free(plugin->info.version.extra, TRUE);
		plugin->info.version.extra = NULL;
	}

	g_free(plugin);
}

static inline
struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type)
{
	struct bt_plugin *plugin = NULL;

	BT_LOGD("Creating empty plugin object: type=%s",
		bt_plugin_type_string(type));

	plugin = g_new0(struct bt_plugin, 1);
	if (!plugin) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one plugin.");
		goto error;
	}

	bt_object_init_shared(&plugin->base, bt_plugin_destroy);
	plugin->type = type;

	/* Create empty arrays of component classes */
	plugin->src_comp_classes =
		g_ptr_array_new_with_free_func(
			(GDestroyNotify) bt_object_put_ref);
	if (!plugin->src_comp_classes) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
		goto error;
	}

	plugin->flt_comp_classes =
		g_ptr_array_new_with_free_func(
			(GDestroyNotify) bt_object_put_ref);
	if (!plugin->flt_comp_classes) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
		goto error;
	}

	plugin->sink_comp_classes =
		g_ptr_array_new_with_free_func(
			(GDestroyNotify) bt_object_put_ref);
	if (!plugin->sink_comp_classes) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
		goto error;
	}

	/* Create empty info */
	plugin->info.name = g_string_new(NULL);
	if (!plugin->info.name) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	plugin->info.path = g_string_new(NULL);
	if (!plugin->info.path) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	plugin->info.description = g_string_new(NULL);
	if (!plugin->info.description) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	plugin->info.author = g_string_new(NULL);
	if (!plugin->info.author) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	plugin->info.license = g_string_new(NULL);
	if (!plugin->info.license) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	plugin->info.version.extra = g_string_new(NULL);
	if (!plugin->info.version.extra) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
		goto error;
	}

	BT_LIB_LOGD("Created empty plugin object: %!+l", plugin);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(plugin);

end:
	return plugin;
}

static inline
void bt_plugin_set_path(struct bt_plugin *plugin, const char *path)
{
	BT_ASSERT(plugin);
	BT_ASSERT(path);
	g_string_assign(plugin->info.path, path);
	plugin->info.path_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, path=\"%s\"",
		plugin, path);
}

static inline
void bt_plugin_set_name(struct bt_plugin *plugin, const char *name)
{
	BT_ASSERT(plugin);
	BT_ASSERT(name);
	g_string_assign(plugin->info.name, name);
	plugin->info.name_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's name: %![plugin-]+l, name=\"%s\"",
		plugin, name);
}

static inline
void bt_plugin_set_description(struct bt_plugin *plugin,
		const char *description)
{
	BT_ASSERT(plugin);
	BT_ASSERT(description);
	g_string_assign(plugin->info.description, description);
	plugin->info.description_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's description: %![plugin-]+l", plugin);
}

static inline
void bt_plugin_set_author(struct bt_plugin *plugin, const char *author)
{
	BT_ASSERT(plugin);
	BT_ASSERT(author);
	g_string_assign(plugin->info.author, author);
	plugin->info.author_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's author: %![plugin-]+l, author=\"%s\"",
		plugin, author);
}

static inline
void bt_plugin_set_license(struct bt_plugin *plugin, const char *license)
{
	BT_ASSERT(plugin);
	BT_ASSERT(license);
	g_string_assign(plugin->info.license, license);
	plugin->info.license_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, license=\"%s\"",
		plugin, license);
}

static inline
void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major,
		unsigned int minor, unsigned int patch, const char *extra)
{
	BT_ASSERT(plugin);
	plugin->info.version.major = major;
	plugin->info.version.minor = minor;
	plugin->info.version.patch = patch;

	if (extra) {
		g_string_assign(plugin->info.version.extra, extra);
	}

	plugin->info.version_set = BT_TRUE;
	BT_LIB_LOGD("Set plugin's version: %![plugin-]+l, "
		"major=%u, minor=%u, patch=%u, extra=\"%s\"",
		plugin, major, minor, patch, extra);
}

static inline
int bt_plugin_add_component_class(
	struct bt_plugin *plugin, struct bt_component_class *comp_class)
{
	GPtrArray *comp_classes;

	BT_ASSERT(plugin);
	BT_ASSERT(comp_class);

	switch (comp_class->type) {
	case BT_COMPONENT_CLASS_TYPE_SOURCE:
		comp_classes = plugin->src_comp_classes;
		break;
	case BT_COMPONENT_CLASS_TYPE_FILTER:
		comp_classes = plugin->flt_comp_classes;
		break;
	case BT_COMPONENT_CLASS_TYPE_SINK:
		comp_classes = plugin->sink_comp_classes;
		break;
	default:
		abort();
	}

	/* Set component class's original plugin name */
	BT_ASSERT(comp_class->plugin_name);
	BT_ASSERT(plugin->info.name);
	g_string_assign(comp_class->plugin_name, plugin->info.name->str);

	/* Add new component class */
	bt_object_get_ref(comp_class);
	g_ptr_array_add(comp_classes, comp_class);

	/* Special case for a shared object plugin */
	if (plugin->type == BT_PLUGIN_TYPE_SO) {
		bt_plugin_so_on_add_component_class(plugin, comp_class);
	}

	BT_LIB_LOGD("Added component class to plugin: "
		"%![plugin-]+l, %![cc-]+C", plugin, comp_class);
	return BT_FUNC_STATUS_OK;
}

static
void bt_plugin_set_destroy(struct bt_object *obj)
{
	struct bt_plugin_set *plugin_set =
		container_of(obj, struct bt_plugin_set, base);

	if (!plugin_set) {
		return;
	}

	BT_LOGD("Destroying plugin set: addr=%p", plugin_set);

	if (plugin_set->plugins) {
		BT_LOGD_STR("Putting plugins.");
		g_ptr_array_free(plugin_set->plugins, TRUE);
	}

	g_free(plugin_set);
}

static inline
struct bt_plugin_set *bt_plugin_set_create(void)
{
	struct bt_plugin_set *plugin_set = g_new0(struct bt_plugin_set, 1);

	if (!plugin_set) {
		goto end;
	}

	BT_LOGD_STR("Creating empty plugin set.");
	bt_object_init_shared(&plugin_set->base, bt_plugin_set_destroy);

	plugin_set->plugins = g_ptr_array_new_with_free_func(
		(GDestroyNotify) bt_object_put_ref);
	if (!plugin_set->plugins) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
		BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
		goto end;
	}

	BT_LOGD("Created empty plugin set: addr=%p", plugin_set);

end:
	return plugin_set;
}

static inline
bool bt_plugin_set_contains_plugin(struct bt_plugin_set *plugin_set,
		const char *name)
{
	uint64_t i;
	bool contains = false;

	BT_ASSERT(plugin_set);
	BT_ASSERT(name);

	for (i = 0; i < plugin_set->plugins->len; i++) {
		const struct bt_plugin *plugin = plugin_set->plugins->pdata[i];

		if (strcmp(plugin->info.name->str, name) == 0) {
			contains = true;
			goto end;
		}
	}

end:
	return contains;
}

static inline
void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set,
		struct bt_plugin *plugin)
{
	BT_ASSERT(plugin_set);
	BT_ASSERT(plugin);

	if (bt_plugin_set_contains_plugin(plugin_set,
			plugin->info.name->str)) {
		goto end;
	}

	bt_object_get_ref(plugin);
	g_ptr_array_add(plugin_set->plugins, plugin);
	BT_LIB_LOGD("Added plugin to plugin set: "
		"plugin-set-addr=%p, %![plugin-]+l",
		plugin_set, plugin);

end:
	return;
}

#endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
33b34c43 PP	2	#define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
fb2dcc52 JG	3
fb2dcc52 JG	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
fb2dcc52 JG	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
fb2dcc52 JG	7	*
fb2dcc52 JG	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:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	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
	24	* SOFTWARE.
	25	*/
	26
91d81473	27	#include "common/macros.h"
578e048b	28	#include "lib/graph/component-class.h"
3fadfbc0 MJ	29	#include <babeltrace2/plugin/plugin-const.h>
3fadfbc0 MJ	30	#include <babeltrace2/plugin/plugin-dev.h>
578e048b	31	#include "lib/object.h"
3fadfbc0	32	#include <babeltrace2/types.h>
578e048b	33	#include "common/assert.h"
55bb57e0	34	#include <glib.h>
c4f23e30	35	#include <stdbool.h>
fb2dcc52	36
578e048b	37	#include "plugin-so.h"
d24d5663	38	#include "lib/func-status.h"
578e048b	39
d3207ebf	40	/* Protection: this file uses BT_LIB_LOG() macros directly /
7151fb67	41	#ifndef BT_LIB_LOG_SUPPORTED
c2d9d9cf	42	# error Please include "lib/logging.h" before including this file.
d3207ebf PP	43	#endif
d3207ebf PP	44
55bb57e0 PP	45	enum bt_plugin_type {
	46	BT_PLUGIN_TYPE_SO = 0,
	47	BT_PLUGIN_TYPE_PYTHON = 1,
fb2dcc52 JG	48	};
fb2dcc52 JG	49
33b34c43 PP	50	struct bt_plugin {
33b34c43 PP	51	struct bt_object base;
55bb57e0	52	enum bt_plugin_type type;
cba174d5	53
d94d92ac PP	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;
6ba0b073	58
55bb57e0 PP	59	/* Info (owned by this) */
	60	struct {
	61	GString *path;
	62	GString *name;
	63	GString *author;
	64	GString *license;
	65	GString *description;
	66	struct {
	67	unsigned int major;
	68	unsigned int minor;
	69	unsigned int patch;
	70	GString *extra;
	71	} version;
d94d92ac PP	72	bool path_set;
	73	bool name_set;
	74	bool author_set;
	75	bool license_set;
	76	bool description_set;
	77	bool version_set;
55bb57e0 PP	78	} info;
	79
	80	/* Value depends on the specific plugin type */
	81	void *spec_data;
6fbd4105	82	void (destroy_spec_data)(struct bt_plugin );
33b34c43	83	};
fb2dcc52	84
a8ff38ef PP	85	struct bt_plugin_set {
	86	struct bt_object base;
	87
	88	/* Array of struct bt_plugin * */
	89	GPtrArray *plugins;
	90	};
	91
3fe0bf43 PP	92	static inline
	93	const char *bt_plugin_type_string(enum bt_plugin_type type)
	94	{
	95	switch (type) {
	96	case BT_PLUGIN_TYPE_SO:
8a432889	97	return "SO";
3fe0bf43	98	case BT_PLUGIN_TYPE_PYTHON:
8a432889	99	return "PYTHON";
3fe0bf43 PP	100	default:
	101	return "(unknown)";
	102	}
	103	}
	104
6fbd4105 PP	105	static inline
	106	void bt_plugin_destroy(struct bt_object *obj)
	107	{
	108	struct bt_plugin *plugin;
	109
f6ccaed9	110	BT_ASSERT(obj);
6fbd4105	111	plugin = container_of(obj, struct bt_plugin, base);
3f7d4d90	112	BT_LIB_LOGI("Destroying plugin object: %!+l", plugin);
6fbd4105 PP	113
	114	if (plugin->destroy_spec_data) {
	115	plugin->destroy_spec_data(plugin);
	116	}
	117
d94d92ac PP	118	if (plugin->src_comp_classes) {
	119	BT_LOGD_STR("Putting source component classes.");
	120	g_ptr_array_free(plugin->src_comp_classes, TRUE);
db5504f9	121	plugin->src_comp_classes = NULL;
d94d92ac PP	122	}
	123
	124	if (plugin->flt_comp_classes) {
	125	BT_LOGD_STR("Putting filter component classes.");
	126	g_ptr_array_free(plugin->flt_comp_classes, TRUE);
db5504f9	127	plugin->flt_comp_classes = NULL;
d94d92ac PP	128	}
	129
	130	if (plugin->sink_comp_classes) {
	131	BT_LOGD_STR("Putting sink component classes.");
	132	g_ptr_array_free(plugin->sink_comp_classes, TRUE);
db5504f9	133	plugin->sink_comp_classes = NULL;
6fbd4105 PP	134	}
	135
	136	if (plugin->info.name) {
	137	g_string_free(plugin->info.name, TRUE);
db5504f9	138	plugin->info.name = NULL;
6fbd4105 PP	139	}
	140
	141	if (plugin->info.path) {
	142	g_string_free(plugin->info.path, TRUE);
db5504f9	143	plugin->info.path = NULL;
6fbd4105 PP	144	}
	145
	146	if (plugin->info.description) {
	147	g_string_free(plugin->info.description, TRUE);
db5504f9	148	plugin->info.description = NULL;
6fbd4105 PP	149	}
	150
	151	if (plugin->info.author) {
	152	g_string_free(plugin->info.author, TRUE);
db5504f9	153	plugin->info.author = NULL;
6fbd4105 PP	154	}
	155
	156	if (plugin->info.license) {
	157	g_string_free(plugin->info.license, TRUE);
db5504f9	158	plugin->info.license = NULL;
6fbd4105 PP	159	}
	160
	161	if (plugin->info.version.extra) {
	162	g_string_free(plugin->info.version.extra, TRUE);
db5504f9	163	plugin->info.version.extra = NULL;
6fbd4105 PP	164	}
	165
	166	g_free(plugin);
	167	}
	168
	169	static inline
	170	struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type)
	171	{
	172	struct bt_plugin *plugin = NULL;
	173
3fe0bf43 PP	174	BT_LOGD("Creating empty plugin object: type=%s",
	175	bt_plugin_type_string(type));
	176
6fbd4105 PP	177	plugin = g_new0(struct bt_plugin, 1);
6fbd4105 PP	178	if (!plugin) {
870631a2	179	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one plugin.");
6fbd4105 PP	180	goto error;
	181	}
	182
3fea54f6	183	bt_object_init_shared(&plugin->base, bt_plugin_destroy);
6fbd4105 PP	184	plugin->type = type;
6fbd4105 PP	185
d94d92ac PP	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) {
870631a2	191	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
d94d92ac PP	192	goto error;
	193	}
	194
	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) {
870631a2	199	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
d94d92ac PP	200	goto error;
	201	}
	202
	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) {
870631a2	207	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
6fbd4105 PP	208	goto error;
	209	}
	210
	211	/* Create empty info */
	212	plugin->info.name = g_string_new(NULL);
	213	if (!plugin->info.name) {
870631a2	214	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	215	goto error;
	216	}
	217
	218	plugin->info.path = g_string_new(NULL);
	219	if (!plugin->info.path) {
870631a2	220	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	221	goto error;
	222	}
	223
	224	plugin->info.description = g_string_new(NULL);
	225	if (!plugin->info.description) {
870631a2	226	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	227	goto error;
	228	}
	229
	230	plugin->info.author = g_string_new(NULL);
	231	if (!plugin->info.author) {
870631a2	232	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	233	goto error;
	234	}
	235
	236	plugin->info.license = g_string_new(NULL);
	237	if (!plugin->info.license) {
870631a2	238	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	239	goto error;
	240	}
	241
	242	plugin->info.version.extra = g_string_new(NULL);
	243	if (!plugin->info.version.extra) {
870631a2	244	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
6fbd4105 PP	245	goto error;
	246	}
	247
d94d92ac	248	BT_LIB_LOGD("Created empty plugin object: %!+l", plugin);
6fbd4105 PP	249	goto end;
	250
	251	error:
65300d60	252	BT_OBJECT_PUT_REF_AND_RESET(plugin);
6fbd4105 PP	253
	254	end:
	255	return plugin;
	256	}
55bb57e0 PP	257
	258	static inline
	259	void bt_plugin_set_path(struct bt_plugin plugin, const char path)
	260	{
f6ccaed9 PP	261	BT_ASSERT(plugin);
f6ccaed9 PP	262	BT_ASSERT(path);
55bb57e0	263	g_string_assign(plugin->info.path, path);
c55a9f58	264	plugin->info.path_set = BT_TRUE;
3f7d4d90	265	BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, path=\"%s\"",
d94d92ac	266	plugin, path);
55bb57e0 PP	267	}
	268
	269	static inline
	270	void bt_plugin_set_name(struct bt_plugin plugin, const char name)
	271	{
f6ccaed9 PP	272	BT_ASSERT(plugin);
f6ccaed9 PP	273	BT_ASSERT(name);
55bb57e0	274	g_string_assign(plugin->info.name, name);
c55a9f58	275	plugin->info.name_set = BT_TRUE;
3f7d4d90	276	BT_LIB_LOGD("Set plugin's name: %![plugin-]+l, name=\"%s\"",
3fe0bf43	277	plugin, name);
55bb57e0 PP	278	}
	279
	280	static inline
	281	void bt_plugin_set_description(struct bt_plugin *plugin,
	282	const char *description)
	283	{
f6ccaed9 PP	284	BT_ASSERT(plugin);
f6ccaed9 PP	285	BT_ASSERT(description);
55bb57e0	286	g_string_assign(plugin->info.description, description);
c55a9f58	287	plugin->info.description_set = BT_TRUE;
3f7d4d90	288	BT_LIB_LOGD("Set plugin's description: %![plugin-]+l", plugin);
55bb57e0 PP	289	}
	290
	291	static inline
	292	void bt_plugin_set_author(struct bt_plugin plugin, const char author)
	293	{
f6ccaed9 PP	294	BT_ASSERT(plugin);
f6ccaed9 PP	295	BT_ASSERT(author);
55bb57e0	296	g_string_assign(plugin->info.author, author);
c55a9f58	297	plugin->info.author_set = BT_TRUE;
3f7d4d90	298	BT_LIB_LOGD("Set plugin's author: %![plugin-]+l, author=\"%s\"",
d94d92ac	299	plugin, author);
55bb57e0 PP	300	}
	301
	302	static inline
	303	void bt_plugin_set_license(struct bt_plugin plugin, const char license)
	304	{
f6ccaed9 PP	305	BT_ASSERT(plugin);
f6ccaed9 PP	306	BT_ASSERT(license);
55bb57e0	307	g_string_assign(plugin->info.license, license);
c55a9f58	308	plugin->info.license_set = BT_TRUE;
3f7d4d90	309	BT_LIB_LOGD("Set plugin's path: %![plugin-]+l, license=\"%s\"",
d94d92ac	310	plugin, license);
55bb57e0 PP	311	}
	312
	313	static inline
	314	void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major,
	315	unsigned int minor, unsigned int patch, const char *extra)
	316	{
f6ccaed9	317	BT_ASSERT(plugin);
55bb57e0 PP	318	plugin->info.version.major = major;
	319	plugin->info.version.minor = minor;
	320	plugin->info.version.patch = patch;
	321
	322	if (extra) {
	323	g_string_assign(plugin->info.version.extra, extra);
	324	}
	325
c55a9f58	326	plugin->info.version_set = BT_TRUE;
3f7d4d90	327	BT_LIB_LOGD("Set plugin's version: %![plugin-]+l, "
3fe0bf43	328	"major=%u, minor=%u, patch=%u, extra=\"%s\"",
d94d92ac	329	plugin, major, minor, patch, extra);
55bb57e0 PP	330	}
	331
	332	static inline
d24d5663	333	int bt_plugin_add_component_class(
d94d92ac	334	struct bt_plugin plugin, struct bt_component_class comp_class)
55bb57e0	335	{
d94d92ac PP	336	GPtrArray *comp_classes;
d94d92ac PP	337
f6ccaed9	338	BT_ASSERT(plugin);
d94d92ac PP	339	BT_ASSERT(comp_class);
	340
	341	switch (comp_class->type) {
	342	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	343	comp_classes = plugin->src_comp_classes;
	344	break;
	345	case BT_COMPONENT_CLASS_TYPE_FILTER:
	346	comp_classes = plugin->flt_comp_classes;
	347	break;
	348	case BT_COMPONENT_CLASS_TYPE_SINK:
	349	comp_classes = plugin->sink_comp_classes;
	350	break;
	351	default:
	352	abort();
	353	}
3fe0bf43	354
2ce06c9e PP	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);
	359
d94d92ac	360	/* Add new component class */
398454ed PP	361	bt_object_get_ref(comp_class);
398454ed PP	362	g_ptr_array_add(comp_classes, comp_class);
d94d92ac PP	363
	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);
3fe0bf43 PP	367	}
3fe0bf43 PP	368
d94d92ac PP	369	BT_LIB_LOGD("Added component class to plugin: "
d94d92ac PP	370	"%![plugin-]+l, %![cc-]+C", plugin, comp_class);
d24d5663	371	return BT_FUNC_STATUS_OK;
55bb57e0 PP	372	}
55bb57e0 PP	373
a8ff38ef PP	374	static
	375	void bt_plugin_set_destroy(struct bt_object *obj)
	376	{
	377	struct bt_plugin_set *plugin_set =
	378	container_of(obj, struct bt_plugin_set, base);
	379
	380	if (!plugin_set) {
	381	return;
	382	}
	383
3fe0bf43 PP	384	BT_LOGD("Destroying plugin set: addr=%p", plugin_set);
3fe0bf43 PP	385
a8ff38ef	386	if (plugin_set->plugins) {
3fe0bf43	387	BT_LOGD_STR("Putting plugins.");
a8ff38ef PP	388	g_ptr_array_free(plugin_set->plugins, TRUE);
	389	}
	390
	391	g_free(plugin_set);
	392	}
	393
	394	static inline
	395	struct bt_plugin_set *bt_plugin_set_create(void)
	396	{
	397	struct bt_plugin_set *plugin_set = g_new0(struct bt_plugin_set, 1);
	398
	399	if (!plugin_set) {
	400	goto end;
	401	}
	402
3fe0bf43	403	BT_LOGD_STR("Creating empty plugin set.");
3fea54f6	404	bt_object_init_shared(&plugin_set->base, bt_plugin_set_destroy);
a8ff38ef PP	405
a8ff38ef PP	406	plugin_set->plugins = g_ptr_array_new_with_free_func(
65300d60	407	(GDestroyNotify) bt_object_put_ref);
a8ff38ef	408	if (!plugin_set->plugins) {
870631a2	409	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
65300d60	410	BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
a8ff38ef PP	411	goto end;
	412	}
	413
3fe0bf43 PP	414	BT_LOGD("Created empty plugin set: addr=%p", plugin_set);
3fe0bf43 PP	415
a8ff38ef PP	416	end:
	417	return plugin_set;
	418	}
	419
577fa92f PP	420	static inline
	421	bool bt_plugin_set_contains_plugin(struct bt_plugin_set *plugin_set,
	422	const char *name)
	423	{
	424	uint64_t i;
	425	bool contains = false;
	426
	427	BT_ASSERT(plugin_set);
	428	BT_ASSERT(name);
	429
	430	for (i = 0; i < plugin_set->plugins->len; i++) {
	431	const struct bt_plugin *plugin = plugin_set->plugins->pdata[i];
	432
	433	if (strcmp(plugin->info.name->str, name) == 0) {
	434	contains = true;
	435	goto end;
	436	}
	437	}
	438
	439	end:
	440	return contains;
	441	}
	442
a8ff38ef PP	443	static inline
	444	void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set,
	445	struct bt_plugin *plugin)
	446	{
f6ccaed9 PP	447	BT_ASSERT(plugin_set);
f6ccaed9 PP	448	BT_ASSERT(plugin);
577fa92f PP	449
	450	if (bt_plugin_set_contains_plugin(plugin_set,
	451	plugin->info.name->str)) {
	452	goto end;
	453	}
	454
398454ed PP	455	bt_object_get_ref(plugin);
398454ed PP	456	g_ptr_array_add(plugin_set->plugins, plugin);
3f7d4d90	457	BT_LIB_LOGD("Added plugin to plugin set: "
d94d92ac PP	458	"plugin-set-addr=%p, %![plugin-]+l",
d94d92ac PP	459	plugin_set, plugin);
577fa92f PP	460
	461	end:
	462	return;
8c1a3187 PP	463	}
8c1a3187 PP	464
33b34c43	465	#endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */