[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 "common/macros.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;
};

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

BT_HIDDEN
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
const char *bt_component_class_type_string(enum bt_component_class_type type)
{
	switch (type) {
	case BT_COMPONENT_CLASS_TYPE_SOURCE:
		return "SOURCE";
	case BT_COMPONENT_CLASS_TYPE_SINK:
		return "SINK";
	case BT_COMPONENT_CLASS_TYPE_FILTER:
		return "FILTER";
	default:
		return "(unknown)";
	}
}

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 "common/macros.h"
	14	#include "lib/object.h"
	15	#include "common/list.h"
	16	#include <babeltrace2/types.h>
	17	#include <stdbool.h>
	18	#include <glib.h>
	19
	20	struct bt_component_class;
	21	struct bt_plugin_so_shared_lib_handle;
	22
	23	typedef void (*bt_component_class_destroy_listener_func)(
	24	struct bt_component_class class, void data);
	25
	26	struct bt_component_class_destroy_listener {
	27	bt_component_class_destroy_listener_func func;
	28	void *data;
	29	};
	30
	31	struct bt_component_class {
	32	struct bt_object base;
	33	enum bt_component_class_type type;
	34	GString *name;
	35	GString *description;
	36	GString *help;
	37	GString *plugin_name;
	38
	39	/* Array of struct bt_component_class_destroy_listener */
	40	GArray *destroy_listeners;
	41	bool frozen;
	42	struct bt_list_head node;
	43	struct bt_plugin_so_shared_lib_handle *so_handle;
	44	};
	45
	46	struct bt_component_class_with_iterator_class {
	47	struct bt_component_class parent;
	48	bt_message_iterator_class *msg_iter_cls;
	49	};
	50
	51	struct bt_component_class_source {
	52	struct bt_component_class_with_iterator_class parent;
	53	struct {
	54	bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions;
	55	bt_component_class_source_initialize_method init;
	56	bt_component_class_source_finalize_method finalize;
	57	bt_component_class_source_query_method query;
	58	bt_component_class_source_output_port_connected_method output_port_connected;
	59	} methods;
	60	};
	61
	62	struct bt_component_class_filter {
	63	struct bt_component_class_with_iterator_class parent;
	64	struct {
	65	bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions;
	66	bt_component_class_filter_initialize_method init;
	67	bt_component_class_filter_finalize_method finalize;
	68	bt_component_class_filter_query_method query;
	69	bt_component_class_filter_input_port_connected_method input_port_connected;
	70	bt_component_class_filter_output_port_connected_method output_port_connected;
	71	} methods;
	72	};
	73
	74	struct bt_component_class_sink {
	75	struct bt_component_class parent;
	76	struct {
	77	bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions;
	78	bt_component_class_sink_initialize_method init;
	79	bt_component_class_sink_finalize_method finalize;
	80	bt_component_class_sink_query_method query;
	81	bt_component_class_sink_input_port_connected_method input_port_connected;
	82	bt_component_class_sink_graph_is_configured_method graph_is_configured;
	83	bt_component_class_sink_consume_method consume;
	84	} methods;
	85	};
	86
	87	BT_HIDDEN
	88	void bt_component_class_add_destroy_listener(struct bt_component_class *class,
	89	bt_component_class_destroy_listener_func func, void *data);
	90
	91	BT_HIDDEN
	92	void _bt_component_class_freeze(
	93	const struct bt_component_class *component_class);
	94
	95	#ifdef BT_DEV_MODE
	96	# define bt_component_class_freeze _bt_component_class_freeze
	97	#else
	98	# define bt_component_class_freeze(_cc)
	99	#endif
	100
	101	static inline
	102	const char *bt_component_class_type_string(enum bt_component_class_type type)
	103	{
	104	switch (type) {
	105	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	106	return "SOURCE";
	107	case BT_COMPONENT_CLASS_TYPE_SINK:
	108	return "SINK";
	109	case BT_COMPONENT_CLASS_TYPE_FILTER:
	110	return "FILTER";
	111	default:
	112	return "(unknown)";
	113	}
	114	}
	115
	116	static inline
	117	bool bt_component_class_has_message_iterator_class(
	118	struct bt_component_class *component_class)
	119	{
	120	return component_class->type == BT_COMPONENT_CLASS_TYPE_SOURCE \|\|
	121	component_class->type == BT_COMPONENT_CLASS_TYPE_FILTER;
	122	}
	123
	124	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */