[babeltrace.git] / src / lib / graph / component-class.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 */

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H

#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/graph/component.h>
#include "lib/object.h"
#include "common/list.h"
#include <babeltrace2/types.h>
#include <stdbool.h>
#include <glib.h>

struct bt_component_class;
struct bt_plugin_so_shared_lib_handle;

typedef void (*bt_component_class_destroy_listener_func)(
		struct bt_component_class *class, void *data);

struct bt_component_class_destroy_listener {
	bt_component_class_destroy_listener_func func;
	void *data;
};

struct bt_component_class {
	struct bt_object base;
	enum bt_component_class_type type;
	GString *name;
	GString *description;
	GString *help;
	GString *plugin_name;

	/* Array of struct bt_component_class_destroy_listener */
	GArray *destroy_listeners;
	bool frozen;
	struct bt_list_head node;
	struct bt_plugin_so_shared_lib_handle *so_handle;
};

struct bt_component_class_with_iterator_class {
	struct bt_component_class parent;
	bt_message_iterator_class *msg_iter_cls;
};

struct bt_component_class_source {
	struct bt_component_class_with_iterator_class parent;
	struct {
		bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions;
		bt_component_class_source_initialize_method init;
		bt_component_class_source_finalize_method finalize;
		bt_component_class_source_query_method query;
		bt_component_class_source_output_port_connected_method output_port_connected;
	} methods;
};

struct bt_component_class_filter {
	struct bt_component_class_with_iterator_class parent;
	struct {
		bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions;
		bt_component_class_filter_initialize_method init;
		bt_component_class_filter_finalize_method finalize;
		bt_component_class_filter_query_method query;
		bt_component_class_filter_input_port_connected_method input_port_connected;
		bt_component_class_filter_output_port_connected_method output_port_connected;
	} methods;
};

struct bt_component_class_sink {
	struct bt_component_class parent;
	struct {
		bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions;
		bt_component_class_sink_initialize_method init;
		bt_component_class_sink_finalize_method finalize;
		bt_component_class_sink_query_method query;
		bt_component_class_sink_input_port_connected_method input_port_connected;
		bt_component_class_sink_graph_is_configured_method graph_is_configured;
		bt_component_class_sink_consume_method consume;
	} methods;
};

void bt_component_class_add_destroy_listener(struct bt_component_class *class,
		bt_component_class_destroy_listener_func func, void *data);

void _bt_component_class_freeze(
		const struct bt_component_class *component_class);

#ifdef BT_DEV_MODE
# define bt_component_class_freeze	_bt_component_class_freeze
#else
# define bt_component_class_freeze(_cc)
#endif

static inline
bool bt_component_class_has_message_iterator_class(
	struct bt_component_class *component_class)
{
	return component_class->type == BT_COMPONENT_CLASS_TYPE_SOURCE ||
		component_class->type == BT_COMPONENT_CLASS_TYPE_FILTER;
}

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	5	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*/
	7
	8	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
	9	#define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
	10
	11	#include <babeltrace2/graph/component-class.h>
	12	#include <babeltrace2/graph/component.h>
	13	#include "lib/object.h"
	14	#include "common/list.h"
	15	#include <babeltrace2/types.h>
	16	#include <stdbool.h>
	17	#include <glib.h>
	18
	19	struct bt_component_class;
	20	struct bt_plugin_so_shared_lib_handle;
	21
	22	typedef void (*bt_component_class_destroy_listener_func)(
	23	struct bt_component_class class, void data);
	24
	25	struct bt_component_class_destroy_listener {
	26	bt_component_class_destroy_listener_func func;
	27	void *data;
	28	};
	29
	30	struct bt_component_class {
	31	struct bt_object base;
	32	enum bt_component_class_type type;
	33	GString *name;
	34	GString *description;
	35	GString *help;
	36	GString *plugin_name;
	37
	38	/* Array of struct bt_component_class_destroy_listener */
	39	GArray *destroy_listeners;
	40	bool frozen;
	41	struct bt_list_head node;
	42	struct bt_plugin_so_shared_lib_handle *so_handle;
	43	};
	44
	45	struct bt_component_class_with_iterator_class {
	46	struct bt_component_class parent;
	47	bt_message_iterator_class *msg_iter_cls;
	48	};
	49
	50	struct bt_component_class_source {
	51	struct bt_component_class_with_iterator_class parent;
	52	struct {
	53	bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions;
	54	bt_component_class_source_initialize_method init;
	55	bt_component_class_source_finalize_method finalize;
	56	bt_component_class_source_query_method query;
	57	bt_component_class_source_output_port_connected_method output_port_connected;
	58	} methods;
	59	};
	60
	61	struct bt_component_class_filter {
	62	struct bt_component_class_with_iterator_class parent;
	63	struct {
	64	bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions;
	65	bt_component_class_filter_initialize_method init;
	66	bt_component_class_filter_finalize_method finalize;
	67	bt_component_class_filter_query_method query;
	68	bt_component_class_filter_input_port_connected_method input_port_connected;
	69	bt_component_class_filter_output_port_connected_method output_port_connected;
	70	} methods;
	71	};
	72
	73	struct bt_component_class_sink {
	74	struct bt_component_class parent;
	75	struct {
	76	bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions;
	77	bt_component_class_sink_initialize_method init;
	78	bt_component_class_sink_finalize_method finalize;
	79	bt_component_class_sink_query_method query;
	80	bt_component_class_sink_input_port_connected_method input_port_connected;
	81	bt_component_class_sink_graph_is_configured_method graph_is_configured;
	82	bt_component_class_sink_consume_method consume;
	83	} methods;
	84	};
	85
	86	void bt_component_class_add_destroy_listener(struct bt_component_class *class,
	87	bt_component_class_destroy_listener_func func, void *data);
	88
	89	void _bt_component_class_freeze(
	90	const struct bt_component_class *component_class);
	91
	92	#ifdef BT_DEV_MODE
	93	# define bt_component_class_freeze _bt_component_class_freeze
	94	#else
	95	# define bt_component_class_freeze(_cc)
	96	#endif
	97
	98	static inline
	99	bool bt_component_class_has_message_iterator_class(
	100	struct bt_component_class *component_class)
	101	{
	102	return component_class->type == BT_COMPONENT_CLASS_TYPE_SOURCE \|\|
	103	component_class->type == BT_COMPONENT_CLASS_TYPE_FILTER;
	104	}
	105
	106	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */