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

#ifndef BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
#define BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H

/*
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2017 Philippe Proulx <pproulx@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 <glib.h>
#include <gmodule.h>
#include <babeltrace/types.h>

struct bt_plugin;
struct bt_component_class;

struct bt_plugin_so_shared_lib_handle {
	struct bt_object base;
	GString *path;
	GModule *module;

	/* True if initialization function was called */
	bt_bool init_called;
	bt_plugin_exit_func exit;
};

struct bt_plugin_so_spec_data {
	/* Shared lib. handle: owned by this */
	struct bt_plugin_so_shared_lib_handle *shared_lib_handle;

	/* Pointers to plugin's memory: do NOT free */
	const struct __bt_plugin_descriptor *descriptor;
	bt_plugin_init_func init;
	const struct __bt_plugin_descriptor_version *version;
};

BT_HIDDEN
struct bt_plugin_set *bt_plugin_so_create_all_from_file(const char *path);

BT_HIDDEN
struct bt_plugin_set *bt_plugin_so_create_all_from_static(void);

BT_HIDDEN
void bt_plugin_so_on_add_component_class(struct bt_plugin *plugin,
		struct bt_component_class *comp_class);

#endif /* BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H */
Commit	Line	Data
55bb57e0 PP	1	#ifndef BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
	2	#define BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
	3
	4	/*
55bb57e0 PP	5	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	* Copyright 2017 Philippe Proulx <pproulx@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 <glib.h>
	30	#include <gmodule.h>
c55a9f58	31	#include <babeltrace/types.h>
55bb57e0 PP	32
	33	struct bt_plugin;
	34	struct bt_component_class;
	35
	36	struct bt_plugin_so_shared_lib_handle {
	37	struct bt_object base;
	38	GString *path;
	39	GModule *module;
	40
	41	/* True if initialization function was called */
c55a9f58	42	bt_bool init_called;
55bb57e0 PP	43	bt_plugin_exit_func exit;
	44	};
	45
	46	struct bt_plugin_so_spec_data {
	47	/* Shared lib. handle: owned by this */
	48	struct bt_plugin_so_shared_lib_handle *shared_lib_handle;
	49
	50	/* Pointers to plugin's memory: do NOT free */
	51	const struct __bt_plugin_descriptor *descriptor;
	52	bt_plugin_init_func init;
	53	const struct __bt_plugin_descriptor_version *version;
	54	};
	55
	56	BT_HIDDEN
a8ff38ef	57	struct bt_plugin_set bt_plugin_so_create_all_from_file(const char path);
55bb57e0 PP	58
55bb57e0 PP	59	BT_HIDDEN
a8ff38ef	60	struct bt_plugin_set *bt_plugin_so_create_all_from_static(void);
55bb57e0 PP	61
55bb57e0 PP	62	BT_HIDDEN
3230ee6b	63	void bt_plugin_so_on_add_component_class(struct bt_plugin *plugin,
55bb57e0 PP	64	struct bt_component_class *comp_class);
55bb57e0 PP	65
55bb57e0	66	#endif /* BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H */