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

#ifndef BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
#define BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2016 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 <stdbool.h>
#include <babeltrace2/types.h>
#include "common/macros.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_finalize_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_initialize_func init;
	const struct __bt_plugin_descriptor_version *version;
};

BT_HIDDEN
int bt_plugin_so_create_all_from_file(const char *path,
		bool fail_on_load_error, struct bt_plugin_set **plugin_set_out);

BT_HIDDEN
int bt_plugin_so_create_all_from_static(bool fail_on_load_error,
		struct bt_plugin_set **plugin_set_out);

/*
 * This function would normally be BT_HIDDEN, but it is used by the Python
 * plugin provider, which is conceptually part of libbabeltrace2, but
 * implemented as a separate shared object, for modularity.  It is therefore
 * exposed, but not part of the public ABI.
 */
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	/*
f2b0325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
55bb57e0	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
55bb57e0 PP	7	*
	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
	27	#include <glib.h>
	28	#include <gmodule.h>
969c1d8a	29	#include <stdbool.h>
71c5da58	30	#include <babeltrace2/types.h>
85e7137b	31	#include "common/macros.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;
ddc4d7d7	43	bt_plugin_finalize_func exit;
55bb57e0 PP	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;
4175c1d5	52	bt_plugin_initialize_func init;
55bb57e0 PP	53	const struct __bt_plugin_descriptor_version *version;
	54	};
	55
	56	BT_HIDDEN
fb25b9e3	57	int bt_plugin_so_create_all_from_file(const char *path,
01f50d54	58	bool fail_on_load_error, struct bt_plugin_set **plugin_set_out);
55bb57e0 PP	59
55bb57e0 PP	60	BT_HIDDEN
fb25b9e3	61	int bt_plugin_so_create_all_from_static(bool fail_on_load_error,
01f50d54	62	struct bt_plugin_set **plugin_set_out);
55bb57e0	63
d9cf7100 SM	64	/*
	65	* This function would normally be BT_HIDDEN, but it is used by the Python
	66	* plugin provider, which is conceptually part of libbabeltrace2, but
	67	* implemented as a separate shared object, for modularity. It is therefore
	68	* exposed, but not part of the public ABI.
	69	*/
3230ee6b	70	void bt_plugin_so_on_add_component_class(struct bt_plugin *plugin,
55bb57e0 PP	71	struct bt_component_class *comp_class);
55bb57e0 PP	72
55bb57e0	73	#endif /* BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H */