[babeltrace.git] / include / babeltrace / plugin / plugin-internal.h

#ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
#define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H

/*
 * 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/babeltrace-internal.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/plugin/plugin.h>
#include <babeltrace/plugin/plugin-dev.h>
#include <babeltrace/plugin/plugin-so-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/object.h>
#include <babeltrace/types.h>
#include <babeltrace/assert-internal.h>
#include <glib.h>

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_status_string(enum bt_plugin_status status)
{
	switch (status) {
	case BT_PLUGIN_STATUS_OK:
		return "BT_PLUGIN_STATUS_OK";
	case BT_PLUGIN_STATUS_ERROR:
		return "BT_PLUGIN_STATUS_ERROR";
	case BT_PLUGIN_STATUS_NOMEM:
		return "BT_PLUGIN_STATUS_NOMEM";
	default:
		return "(unknown)";
	}
}

static inline
const char *bt_plugin_type_string(enum bt_plugin_type type)
{
	switch (type) {
	case BT_PLUGIN_TYPE_SO:
		return "BT_PLUGIN_TYPE_SO";
	case BT_PLUGIN_TYPE_PYTHON:
		return "BT_PLUGIN_TYPE_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_LOGD("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_LOGE_STR("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_LOGE_STR("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_LOGE_STR("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_LOGE_STR("Failed to allocate a GPtrArray.");
		goto error;
	}

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

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

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

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

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

	plugin->info.version.extra = g_string_new(NULL);
	if (!plugin->info.version.extra) {
		BT_LOGE_STR("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_LOGV("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_LOGV("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_LOGV("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_LOGV("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_LOGV("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_LOGV("Set plugin's version: %![plugin-]+l, "
		"major=%u, minor=%u, patch=%u, extra=\"%s\"",
		plugin, major, minor, patch, extra);
}

static inline
enum bt_plugin_status 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();
	}

	/* Add new component class */
	g_ptr_array_add(comp_classes, bt_object_get_ref(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_PLUGIN_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_LOGE_STR("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
void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set,
		struct bt_plugin *plugin)
{
	BT_ASSERT(plugin_set);
	BT_ASSERT(plugin);
	g_ptr_array_add(plugin_set->plugins, bt_object_get_ref(plugin));
	BT_LIB_LOGV("Added plugin to plugin set: "
		"plugin-set-addr=%p, %![plugin-]+l",
		plugin_set, plugin);
}

#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	/*
fb2dcc52 JG	5	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*
	7	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
	28	#include <babeltrace/babeltrace-internal.h>
d94d92ac	29	#include <babeltrace/graph/component-class-internal.h>
3fe0bf43	30	#include <babeltrace/plugin/plugin.h>
33b34c43	31	#include <babeltrace/plugin/plugin-dev.h>
d94d92ac	32	#include <babeltrace/plugin/plugin-so-internal.h>
b8a06801	33	#include <babeltrace/object-internal.h>
d94d92ac	34	#include <babeltrace/object.h>
c55a9f58	35	#include <babeltrace/types.h>
f6ccaed9	36	#include <babeltrace/assert-internal.h>
55bb57e0	37	#include <glib.h>
fb2dcc52	38
55bb57e0 PP	39	enum bt_plugin_type {
	40	BT_PLUGIN_TYPE_SO = 0,
	41	BT_PLUGIN_TYPE_PYTHON = 1,
fb2dcc52 JG	42	};
fb2dcc52 JG	43
33b34c43 PP	44	struct bt_plugin {
33b34c43 PP	45	struct bt_object base;
55bb57e0	46	enum bt_plugin_type type;
cba174d5	47
d94d92ac PP	48	/* Arrays of `struct bt_component_class ` (owned by this) /
	49	GPtrArray *src_comp_classes;
	50	GPtrArray *flt_comp_classes;
	51	GPtrArray *sink_comp_classes;
6ba0b073	52
55bb57e0 PP	53	/* Info (owned by this) */
	54	struct {
	55	GString *path;
	56	GString *name;
	57	GString *author;
	58	GString *license;
	59	GString *description;
	60	struct {
	61	unsigned int major;
	62	unsigned int minor;
	63	unsigned int patch;
	64	GString *extra;
	65	} version;
d94d92ac PP	66	bool path_set;
	67	bool name_set;
	68	bool author_set;
	69	bool license_set;
	70	bool description_set;
	71	bool version_set;
55bb57e0 PP	72	} info;
	73
	74	/* Value depends on the specific plugin type */
	75	void *spec_data;
6fbd4105	76	void (destroy_spec_data)(struct bt_plugin );
33b34c43	77	};
fb2dcc52	78
a8ff38ef PP	79	struct bt_plugin_set {
	80	struct bt_object base;
	81
	82	/* Array of struct bt_plugin * */
	83	GPtrArray *plugins;
	84	};
	85
3fe0bf43 PP	86	static inline
	87	const char *bt_plugin_status_string(enum bt_plugin_status status)
	88	{
	89	switch (status) {
	90	case BT_PLUGIN_STATUS_OK:
	91	return "BT_PLUGIN_STATUS_OK";
	92	case BT_PLUGIN_STATUS_ERROR:
	93	return "BT_PLUGIN_STATUS_ERROR";
	94	case BT_PLUGIN_STATUS_NOMEM:
	95	return "BT_PLUGIN_STATUS_NOMEM";
	96	default:
	97	return "(unknown)";
	98	}
	99	}
	100
	101	static inline
	102	const char *bt_plugin_type_string(enum bt_plugin_type type)
	103	{
	104	switch (type) {
	105	case BT_PLUGIN_TYPE_SO:
	106	return "BT_PLUGIN_TYPE_SO";
	107	case BT_PLUGIN_TYPE_PYTHON:
	108	return "BT_PLUGIN_TYPE_PYTHON";
	109	default:
	110	return "(unknown)";
	111	}
	112	}
	113
6fbd4105 PP	114	static inline
	115	void bt_plugin_destroy(struct bt_object *obj)
	116	{
	117	struct bt_plugin *plugin;
	118
f6ccaed9	119	BT_ASSERT(obj);
6fbd4105	120	plugin = container_of(obj, struct bt_plugin, base);
d94d92ac	121	BT_LIB_LOGD("Destroying plugin object: %!+l", plugin);
6fbd4105 PP	122
	123	if (plugin->destroy_spec_data) {
	124	plugin->destroy_spec_data(plugin);
	125	}
	126
d94d92ac PP	127	if (plugin->src_comp_classes) {
	128	BT_LOGD_STR("Putting source component classes.");
	129	g_ptr_array_free(plugin->src_comp_classes, TRUE);
db5504f9	130	plugin->src_comp_classes = NULL;
d94d92ac PP	131	}
	132
	133	if (plugin->flt_comp_classes) {
	134	BT_LOGD_STR("Putting filter component classes.");
	135	g_ptr_array_free(plugin->flt_comp_classes, TRUE);
db5504f9	136	plugin->flt_comp_classes = NULL;
d94d92ac PP	137	}
	138
	139	if (plugin->sink_comp_classes) {
	140	BT_LOGD_STR("Putting sink component classes.");
	141	g_ptr_array_free(plugin->sink_comp_classes, TRUE);
db5504f9	142	plugin->sink_comp_classes = NULL;
6fbd4105 PP	143	}
	144
	145	if (plugin->info.name) {
	146	g_string_free(plugin->info.name, TRUE);
db5504f9	147	plugin->info.name = NULL;
6fbd4105 PP	148	}
	149
	150	if (plugin->info.path) {
	151	g_string_free(plugin->info.path, TRUE);
db5504f9	152	plugin->info.path = NULL;
6fbd4105 PP	153	}
	154
	155	if (plugin->info.description) {
	156	g_string_free(plugin->info.description, TRUE);
db5504f9	157	plugin->info.description = NULL;
6fbd4105 PP	158	}
	159
	160	if (plugin->info.author) {
	161	g_string_free(plugin->info.author, TRUE);
db5504f9	162	plugin->info.author = NULL;
6fbd4105 PP	163	}
	164
	165	if (plugin->info.license) {
	166	g_string_free(plugin->info.license, TRUE);
db5504f9	167	plugin->info.license = NULL;
6fbd4105 PP	168	}
	169
	170	if (plugin->info.version.extra) {
	171	g_string_free(plugin->info.version.extra, TRUE);
db5504f9	172	plugin->info.version.extra = NULL;
6fbd4105 PP	173	}
	174
	175	g_free(plugin);
	176	}
	177
	178	static inline
	179	struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type)
	180	{
	181	struct bt_plugin *plugin = NULL;
	182
3fe0bf43 PP	183	BT_LOGD("Creating empty plugin object: type=%s",
	184	bt_plugin_type_string(type));
	185
6fbd4105 PP	186	plugin = g_new0(struct bt_plugin, 1);
6fbd4105 PP	187	if (!plugin) {
3fe0bf43	188	BT_LOGE_STR("Failed to allocate one plugin.");
6fbd4105 PP	189	goto error;
	190	}
	191
3fea54f6	192	bt_object_init_shared(&plugin->base, bt_plugin_destroy);
6fbd4105 PP	193	plugin->type = type;
6fbd4105 PP	194
d94d92ac PP	195	/* Create empty arrays of component classes */
	196	plugin->src_comp_classes =
	197	g_ptr_array_new_with_free_func(
	198	(GDestroyNotify) bt_object_put_ref);
	199	if (!plugin->src_comp_classes) {
	200	BT_LOGE_STR("Failed to allocate a GPtrArray.");
	201	goto error;
	202	}
	203
	204	plugin->flt_comp_classes =
	205	g_ptr_array_new_with_free_func(
	206	(GDestroyNotify) bt_object_put_ref);
	207	if (!plugin->flt_comp_classes) {
	208	BT_LOGE_STR("Failed to allocate a GPtrArray.");
	209	goto error;
	210	}
	211
	212	plugin->sink_comp_classes =
	213	g_ptr_array_new_with_free_func(
	214	(GDestroyNotify) bt_object_put_ref);
	215	if (!plugin->sink_comp_classes) {
3fe0bf43	216	BT_LOGE_STR("Failed to allocate a GPtrArray.");
6fbd4105 PP	217	goto error;
	218	}
	219
	220	/* Create empty info */
	221	plugin->info.name = g_string_new(NULL);
	222	if (!plugin->info.name) {
3fe0bf43	223	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	224	goto error;
	225	}
	226
	227	plugin->info.path = g_string_new(NULL);
	228	if (!plugin->info.path) {
3fe0bf43	229	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	230	goto error;
	231	}
	232
	233	plugin->info.description = g_string_new(NULL);
	234	if (!plugin->info.description) {
3fe0bf43	235	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	236	goto error;
	237	}
	238
	239	plugin->info.author = g_string_new(NULL);
	240	if (!plugin->info.author) {
3fe0bf43	241	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	242	goto error;
	243	}
	244
	245	plugin->info.license = g_string_new(NULL);
	246	if (!plugin->info.license) {
3fe0bf43	247	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	248	goto error;
	249	}
	250
	251	plugin->info.version.extra = g_string_new(NULL);
	252	if (!plugin->info.version.extra) {
3fe0bf43	253	BT_LOGE_STR("Failed to allocate a GString.");
6fbd4105 PP	254	goto error;
	255	}
	256
d94d92ac	257	BT_LIB_LOGD("Created empty plugin object: %!+l", plugin);
6fbd4105 PP	258	goto end;
	259
	260	error:
65300d60	261	BT_OBJECT_PUT_REF_AND_RESET(plugin);
6fbd4105 PP	262
	263	end:
	264	return plugin;
	265	}
55bb57e0 PP	266
	267	static inline
	268	void bt_plugin_set_path(struct bt_plugin plugin, const char path)
	269	{
f6ccaed9 PP	270	BT_ASSERT(plugin);
f6ccaed9 PP	271	BT_ASSERT(path);
55bb57e0	272	g_string_assign(plugin->info.path, path);
c55a9f58	273	plugin->info.path_set = BT_TRUE;
d94d92ac PP	274	BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, path=\"%s\"",
d94d92ac PP	275	plugin, path);
55bb57e0 PP	276	}
	277
	278	static inline
	279	void bt_plugin_set_name(struct bt_plugin plugin, const char name)
	280	{
f6ccaed9 PP	281	BT_ASSERT(plugin);
f6ccaed9 PP	282	BT_ASSERT(name);
55bb57e0	283	g_string_assign(plugin->info.name, name);
c55a9f58	284	plugin->info.name_set = BT_TRUE;
d94d92ac	285	BT_LIB_LOGV("Set plugin's name: %![plugin-]+l, name=\"%s\"",
3fe0bf43	286	plugin, name);
55bb57e0 PP	287	}
	288
	289	static inline
	290	void bt_plugin_set_description(struct bt_plugin *plugin,
	291	const char *description)
	292	{
f6ccaed9 PP	293	BT_ASSERT(plugin);
f6ccaed9 PP	294	BT_ASSERT(description);
55bb57e0	295	g_string_assign(plugin->info.description, description);
c55a9f58	296	plugin->info.description_set = BT_TRUE;
d94d92ac	297	BT_LIB_LOGV("Set plugin's description: %![plugin-]+l", plugin);
55bb57e0 PP	298	}
	299
	300	static inline
	301	void bt_plugin_set_author(struct bt_plugin plugin, const char author)
	302	{
f6ccaed9 PP	303	BT_ASSERT(plugin);
f6ccaed9 PP	304	BT_ASSERT(author);
55bb57e0	305	g_string_assign(plugin->info.author, author);
c55a9f58	306	plugin->info.author_set = BT_TRUE;
d94d92ac PP	307	BT_LIB_LOGV("Set plugin's author: %![plugin-]+l, author=\"%s\"",
d94d92ac PP	308	plugin, author);
55bb57e0 PP	309	}
	310
	311	static inline
	312	void bt_plugin_set_license(struct bt_plugin plugin, const char license)
	313	{
f6ccaed9 PP	314	BT_ASSERT(plugin);
f6ccaed9 PP	315	BT_ASSERT(license);
55bb57e0	316	g_string_assign(plugin->info.license, license);
c55a9f58	317	plugin->info.license_set = BT_TRUE;
d94d92ac PP	318	BT_LIB_LOGV("Set plugin's path: %![plugin-]+l, license=\"%s\"",
d94d92ac PP	319	plugin, license);
55bb57e0 PP	320	}
	321
	322	static inline
	323	void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major,
	324	unsigned int minor, unsigned int patch, const char *extra)
	325	{
f6ccaed9	326	BT_ASSERT(plugin);
55bb57e0 PP	327	plugin->info.version.major = major;
	328	plugin->info.version.minor = minor;
	329	plugin->info.version.patch = patch;
	330
	331	if (extra) {
	332	g_string_assign(plugin->info.version.extra, extra);
	333	}
	334
c55a9f58	335	plugin->info.version_set = BT_TRUE;
d94d92ac	336	BT_LIB_LOGV("Set plugin's version: %![plugin-]+l, "
3fe0bf43	337	"major=%u, minor=%u, patch=%u, extra=\"%s\"",
d94d92ac	338	plugin, major, minor, patch, extra);
55bb57e0 PP	339	}
	340
	341	static inline
d94d92ac PP	342	enum bt_plugin_status bt_plugin_add_component_class(
d94d92ac PP	343	struct bt_plugin plugin, struct bt_component_class comp_class)
55bb57e0	344	{
d94d92ac PP	345	GPtrArray *comp_classes;
d94d92ac PP	346
f6ccaed9	347	BT_ASSERT(plugin);
d94d92ac PP	348	BT_ASSERT(comp_class);
	349
	350	switch (comp_class->type) {
	351	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	352	comp_classes = plugin->src_comp_classes;
	353	break;
	354	case BT_COMPONENT_CLASS_TYPE_FILTER:
	355	comp_classes = plugin->flt_comp_classes;
	356	break;
	357	case BT_COMPONENT_CLASS_TYPE_SINK:
	358	comp_classes = plugin->sink_comp_classes;
	359	break;
	360	default:
	361	abort();
	362	}
3fe0bf43	363
d94d92ac PP	364	/* Add new component class */
	365	g_ptr_array_add(comp_classes, bt_object_get_ref(comp_class));
	366
	367	/* Special case for a shared object plugin */
	368	if (plugin->type == BT_PLUGIN_TYPE_SO) {
	369	bt_plugin_so_on_add_component_class(plugin, comp_class);
3fe0bf43 PP	370	}
3fe0bf43 PP	371
d94d92ac PP	372	BT_LIB_LOGD("Added component class to plugin: "
	373	"%![plugin-]+l, %![cc-]+C", plugin, comp_class);
	374	return BT_PLUGIN_STATUS_OK;
55bb57e0 PP	375	}
55bb57e0 PP	376
a8ff38ef PP	377	static
	378	void bt_plugin_set_destroy(struct bt_object *obj)
	379	{
	380	struct bt_plugin_set *plugin_set =
	381	container_of(obj, struct bt_plugin_set, base);
	382
	383	if (!plugin_set) {
	384	return;
	385	}
	386
3fe0bf43 PP	387	BT_LOGD("Destroying plugin set: addr=%p", plugin_set);
3fe0bf43 PP	388
a8ff38ef	389	if (plugin_set->plugins) {
3fe0bf43	390	BT_LOGD_STR("Putting plugins.");
a8ff38ef PP	391	g_ptr_array_free(plugin_set->plugins, TRUE);
	392	}
	393
	394	g_free(plugin_set);
	395	}
	396
	397	static inline
	398	struct bt_plugin_set *bt_plugin_set_create(void)
	399	{
	400	struct bt_plugin_set *plugin_set = g_new0(struct bt_plugin_set, 1);
	401
	402	if (!plugin_set) {
	403	goto end;
	404	}
	405
3fe0bf43	406	BT_LOGD_STR("Creating empty plugin set.");
3fea54f6	407	bt_object_init_shared(&plugin_set->base, bt_plugin_set_destroy);
a8ff38ef PP	408
a8ff38ef PP	409	plugin_set->plugins = g_ptr_array_new_with_free_func(
65300d60	410	(GDestroyNotify) bt_object_put_ref);
a8ff38ef	411	if (!plugin_set->plugins) {
3fe0bf43	412	BT_LOGE_STR("Failed to allocate a GPtrArray.");
65300d60	413	BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
a8ff38ef PP	414	goto end;
	415	}
	416
3fe0bf43 PP	417	BT_LOGD("Created empty plugin set: addr=%p", plugin_set);
3fe0bf43 PP	418
a8ff38ef PP	419	end:
	420	return plugin_set;
	421	}
	422
	423	static inline
	424	void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set,
	425	struct bt_plugin *plugin)
	426	{
f6ccaed9 PP	427	BT_ASSERT(plugin_set);
f6ccaed9 PP	428	BT_ASSERT(plugin);
65300d60	429	g_ptr_array_add(plugin_set->plugins, bt_object_get_ref(plugin));
d94d92ac PP	430	BT_LIB_LOGV("Added plugin to plugin set: "
	431	"plugin-set-addr=%p, %![plugin-]+l",
	432	plugin_set, plugin);
8c1a3187 PP	433	}
8c1a3187 PP	434
33b34c43	435	#endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */