[babeltrace.git] / src / lib / graph / graph.h

#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
#define BABELTRACE_GRAPH_GRAPH_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2017 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.
 */

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BT_LIB_LOG_SUPPORTED
# error Please include "lib/logging.h" before including this file.
#endif

#include <babeltrace2/graph/graph.h>
#include <babeltrace2/graph/message-const.h>
#include "common/macros.h"
#include "lib/object.h"
#include "lib/object-pool.h"
#include "common/assert.h"
#include "common/common.h"
#include <stdlib.h>
#include <glib.h>

#include "component.h"
#include "component-sink.h"
#include "connection.h"
#include "lib/func-status.h"

/* Protection: this file uses BT_LIB_LOG*() macros directly */
#ifndef BT_LIB_LOG_SUPPORTED
# error Please include "lib/logging.h" before including this file.
#endif

/* Protection: this file uses BT_ASSERT_PRE*() macros directly */
#ifndef BT_ASSERT_PRE_SUPPORTED
# error Please include "lib/assert-pre.h" before including this file.
#endif

/* Protection: this file uses BT_ASSERT_POST*() macros directly */
#ifndef BT_ASSERT_POST_SUPPORTED
# error Please include "lib/assert-post.h" before including this file.
#endif

struct bt_component;
struct bt_port;

enum bt_graph_configuration_state {
	BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
	BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
	BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
	BT_GRAPH_CONFIGURATION_STATE_FAULTY,
};

struct bt_graph {
	/**
	 * A component graph contains components and point-to-point connection
	 * between these components.
	 *
	 * In terms of ownership:
	 * 1) The graph is the components' parent,
	 * 2) The graph is the connnections' parent,
	 * 3) Components share the ownership of their connections,
	 * 4) A connection holds weak references to its two component endpoints.
	 */
	struct bt_object base;

	/* Array of pointers to bt_connection. */
	GPtrArray *connections;
	/* Array of pointers to bt_component. */
	GPtrArray *components;
	/* Queue of pointers (weak references) to sink bt_components. */
	GQueue *sinks_to_consume;

	bool canceled;
	bool in_remove_listener;
	bool has_sink;

	/*
	 * If this is false, then the public API's consuming
	 * functions (bt_graph_consume() and bt_graph_run()) return
	 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
	 * functions always work.
	 *
	 * In bt_port_output_message_iterator_create(), on success,
	 * this flag is cleared so that the iterator remains the only
	 * consumer for the graph's lifetime.
	 */
	bool can_consume;

	enum bt_graph_configuration_state config_state;

	struct {
		GArray *source_output_port_added;
		GArray *filter_output_port_added;
		GArray *filter_input_port_added;
		GArray *sink_input_port_added;
		GArray *source_filter_ports_connected;
		GArray *source_sink_ports_connected;
		GArray *filter_filter_ports_connected;
		GArray *filter_sink_ports_connected;
	} listeners;

	/* Pool of `struct bt_message_event *` */
	struct bt_object_pool event_msg_pool;

	/* Pool of `struct bt_message_packet_beginning *` */
	struct bt_object_pool packet_begin_msg_pool;

	/* Pool of `struct bt_message_packet_end *` */
	struct bt_object_pool packet_end_msg_pool;

	/*
	 * Array of `struct bt_message *` (weak).
	 *
	 * This is an array of all the messages ever created from
	 * this graph. Some of them can be in one of the pools above,
	 * some of them can be at large. Because each message has a
	 * weak pointer to the graph containing its pool, we need to
	 * notify each message that the graph is gone on graph
	 * destruction.
	 *
	 * TODO: When we support a maximum size for object pools,
	 * add a way for a message to remove itself from this
	 * array (on destruction).
	 */
	GPtrArray *messages;
};

static inline
void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
{
	BT_ASSERT(graph);
	graph->can_consume = can_consume;
}

#ifdef BT_DEV_MODE
# define bt_graph_set_can_consume	_bt_graph_set_can_consume
#else
# define bt_graph_set_can_consume(_graph, _can_consume)
#endif

BT_HIDDEN
int bt_graph_consume_sink_no_check(struct bt_graph *graph,
		struct bt_component_sink *sink);

BT_HIDDEN
enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
		struct bt_port *port);

BT_HIDDEN
enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
		struct bt_graph *graph, struct bt_port *upstream_port,
		struct bt_port *downstream_port);

BT_HIDDEN
void bt_graph_remove_connection(struct bt_graph *graph,
		struct bt_connection *connection);

/*
 * This only works with a component which is not connected at this
 * point.
 *
 * Also the reference count of `component` should be 0 when you call
 * this function, which means only `graph` owns the component, so it
 * is safe to destroy.
 */
BT_HIDDEN
int bt_graph_remove_unconnected_component(struct bt_graph *graph,
		struct bt_component *component);

BT_HIDDEN
void bt_graph_add_message(struct bt_graph *graph,
		struct bt_message *msg);

static inline
const char *bt_graph_configuration_state_string(
		enum bt_graph_configuration_state state)
{
	switch (state) {
	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
		return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
	case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
		return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
		return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
	default:
		return "(unknown)";
	}
}

static inline
int bt_graph_configure(struct bt_graph *graph)
{
	int status = BT_FUNC_STATUS_OK;
	uint64_t i;

	BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);

	if (G_LIKELY(graph->config_state ==
			BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
		goto end;
	}

	BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;

	for (i = 0; i < graph->components->len; i++) {
		struct bt_component *comp = graph->components->pdata[i];
		struct bt_component_sink *comp_sink = (void *) comp;
		struct bt_component_class_sink *comp_cls_sink =
			(void *) comp->class;

		if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
			continue;
		}

		if (comp_sink->graph_is_configured_method_called) {
			continue;
		}

		if (comp_cls_sink->methods.graph_is_configured) {
			enum bt_component_class_sink_graph_is_configured_method_status comp_status;

			BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
				"%![graph-]+g, %![comp-]+c",
				graph, comp);
			comp_status = comp_cls_sink->methods.graph_is_configured(
				(void *) comp_sink);
			BT_LIB_LOGD("User method returned: status=%s",
				bt_common_func_status_string(comp_status));
			BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
				comp_status == BT_FUNC_STATUS_ERROR ||
				comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
				"Unexpected returned status: status=%s",
				bt_common_func_status_string(comp_status));
			if (comp_status != BT_FUNC_STATUS_OK) {
				comp_status = BT_FUNC_STATUS_ERROR;
				if (comp_status < 0) {
					BT_LIB_LOGW_APPEND_CAUSE(
						"Component's \"graph is configured\" method failed: "
						"%![comp-]+c, status=%s",
						comp,
						bt_common_func_status_string(
							comp_status));
				}

				status = comp_status;
				goto end;
			}
		}

		comp_sink->graph_is_configured_method_called = true;
	}

	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;

end:
	return status;
}

static inline
void bt_graph_make_faulty(struct bt_graph *graph)
{
	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
	BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
}

#endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
	2	#define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	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	/* Protection: this file uses BT_LIB_LOG() macros directly /
	28	#ifndef BT_LIB_LOG_SUPPORTED
	29	# error Please include "lib/logging.h" before including this file.
	30	#endif
	31
	32	#include <babeltrace2/graph/graph.h>
	33	#include <babeltrace2/graph/message-const.h>
	34	#include "common/macros.h"
	35	#include "lib/object.h"
	36	#include "lib/object-pool.h"
	37	#include "common/assert.h"
	38	#include "common/common.h"
	39	#include <stdlib.h>
	40	#include <glib.h>
	41
	42	#include "component.h"
	43	#include "component-sink.h"
	44	#include "connection.h"
	45	#include "lib/func-status.h"
	46
	47	/* Protection: this file uses BT_LIB_LOG() macros directly /
	48	#ifndef BT_LIB_LOG_SUPPORTED
	49	# error Please include "lib/logging.h" before including this file.
	50	#endif
	51
	52	/* Protection: this file uses BT_ASSERT_PRE() macros directly /
	53	#ifndef BT_ASSERT_PRE_SUPPORTED
	54	# error Please include "lib/assert-pre.h" before including this file.
	55	#endif
	56
	57	/* Protection: this file uses BT_ASSERT_POST() macros directly /
	58	#ifndef BT_ASSERT_POST_SUPPORTED
	59	# error Please include "lib/assert-post.h" before including this file.
	60	#endif
	61
	62	struct bt_component;
	63	struct bt_port;
	64
	65	enum bt_graph_configuration_state {
	66	BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
	67	BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
	68	BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
	69	BT_GRAPH_CONFIGURATION_STATE_FAULTY,
	70	};
	71
	72	struct bt_graph {
	73	/**
	74	* A component graph contains components and point-to-point connection
	75	* between these components.
	76	*
	77	* In terms of ownership:
	78	* 1) The graph is the components' parent,
	79	* 2) The graph is the connnections' parent,
	80	* 3) Components share the ownership of their connections,
	81	* 4) A connection holds weak references to its two component endpoints.
	82	*/
	83	struct bt_object base;
	84
	85	/* Array of pointers to bt_connection. */
	86	GPtrArray *connections;
	87	/* Array of pointers to bt_component. */
	88	GPtrArray *components;
	89	/* Queue of pointers (weak references) to sink bt_components. */
	90	GQueue *sinks_to_consume;
	91
	92	bool canceled;
	93	bool in_remove_listener;
	94	bool has_sink;
	95
	96	/*
	97	* If this is false, then the public API's consuming
	98	* functions (bt_graph_consume() and bt_graph_run()) return
	99	* BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
	100	* functions always work.
	101	*
	102	* In bt_port_output_message_iterator_create(), on success,
	103	* this flag is cleared so that the iterator remains the only
	104	* consumer for the graph's lifetime.
	105	*/
	106	bool can_consume;
	107
	108	enum bt_graph_configuration_state config_state;
	109
	110	struct {
	111	GArray *source_output_port_added;
	112	GArray *filter_output_port_added;
	113	GArray *filter_input_port_added;
	114	GArray *sink_input_port_added;
	115	GArray *source_filter_ports_connected;
	116	GArray *source_sink_ports_connected;
	117	GArray *filter_filter_ports_connected;
	118	GArray *filter_sink_ports_connected;
	119	} listeners;
	120
	121	/* Pool of `struct bt_message_event ` /
	122	struct bt_object_pool event_msg_pool;
	123
	124	/* Pool of `struct bt_message_packet_beginning ` /
	125	struct bt_object_pool packet_begin_msg_pool;
	126
	127	/* Pool of `struct bt_message_packet_end ` /
	128	struct bt_object_pool packet_end_msg_pool;
	129
	130	/*
	131	* Array of `struct bt_message *` (weak).
	132	*
	133	* This is an array of all the messages ever created from
	134	* this graph. Some of them can be in one of the pools above,
	135	* some of them can be at large. Because each message has a
	136	* weak pointer to the graph containing its pool, we need to
	137	* notify each message that the graph is gone on graph
	138	* destruction.
	139	*
	140	* TODO: When we support a maximum size for object pools,
	141	* add a way for a message to remove itself from this
	142	* array (on destruction).
	143	*/
	144	GPtrArray *messages;
	145	};
	146
	147	static inline
	148	void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
	149	{
	150	BT_ASSERT(graph);
	151	graph->can_consume = can_consume;
	152	}
	153
	154	#ifdef BT_DEV_MODE
	155	# define bt_graph_set_can_consume _bt_graph_set_can_consume
	156	#else
	157	# define bt_graph_set_can_consume(_graph, _can_consume)
	158	#endif
	159
	160	BT_HIDDEN
	161	int bt_graph_consume_sink_no_check(struct bt_graph *graph,
	162	struct bt_component_sink *sink);
	163
	164	BT_HIDDEN
	165	enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
	166	struct bt_port *port);
	167
	168	BT_HIDDEN
	169	enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
	170	struct bt_graph graph, struct bt_port upstream_port,
	171	struct bt_port *downstream_port);
	172
	173	BT_HIDDEN
	174	void bt_graph_remove_connection(struct bt_graph *graph,
	175	struct bt_connection *connection);
	176
	177	/*
	178	* This only works with a component which is not connected at this
	179	* point.
	180	*
	181	* Also the reference count of `component` should be 0 when you call
	182	* this function, which means only `graph` owns the component, so it
	183	* is safe to destroy.
	184	*/
	185	BT_HIDDEN
	186	int bt_graph_remove_unconnected_component(struct bt_graph *graph,
	187	struct bt_component *component);
	188
	189	BT_HIDDEN
	190	void bt_graph_add_message(struct bt_graph *graph,
	191	struct bt_message *msg);
	192
	193	static inline
	194	const char *bt_graph_configuration_state_string(
	195	enum bt_graph_configuration_state state)
	196	{
	197	switch (state) {
	198	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
	199	return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
	200	case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
	201	return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
	202	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
	203	return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
	204	default:
	205	return "(unknown)";
	206	}
	207	}
	208
	209	static inline
	210	int bt_graph_configure(struct bt_graph *graph)
	211	{
	212	int status = BT_FUNC_STATUS_OK;
	213	uint64_t i;
	214
	215	BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
	216
	217	if (G_LIKELY(graph->config_state ==
	218	BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
	219	goto end;
	220	}
	221
	222	BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
	223	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
	224
	225	for (i = 0; i < graph->components->len; i++) {
	226	struct bt_component *comp = graph->components->pdata[i];
	227	struct bt_component_sink comp_sink = (void ) comp;
	228	struct bt_component_class_sink *comp_cls_sink =
	229	(void *) comp->class;
	230
	231	if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
	232	continue;
	233	}
	234
	235	if (comp_sink->graph_is_configured_method_called) {
	236	continue;
	237	}
	238
	239	if (comp_cls_sink->methods.graph_is_configured) {
	240	enum bt_component_class_sink_graph_is_configured_method_status comp_status;
	241
	242	BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
	243	"%![graph-]+g, %![comp-]+c",
	244	graph, comp);
	245	comp_status = comp_cls_sink->methods.graph_is_configured(
	246	(void *) comp_sink);
	247	BT_LIB_LOGD("User method returned: status=%s",
	248	bt_common_func_status_string(comp_status));
	249	BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK \|\|
	250	comp_status == BT_FUNC_STATUS_ERROR \|\|
	251	comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
	252	"Unexpected returned status: status=%s",
	253	bt_common_func_status_string(comp_status));
	254	if (comp_status != BT_FUNC_STATUS_OK) {
	255	comp_status = BT_FUNC_STATUS_ERROR;
	256	if (comp_status < 0) {
	257	BT_LIB_LOGW_APPEND_CAUSE(
	258	"Component's \"graph is configured\" method failed: "
	259	"%![comp-]+c, status=%s",
	260	comp,
	261	bt_common_func_status_string(
	262	comp_status));
	263	}
	264
	265	status = comp_status;
	266	goto end;
	267	}
	268	}
	269
	270	comp_sink->graph_is_configured_method_called = true;
	271	}
	272
	273	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
	274
	275	end:
	276	return status;
	277	}
	278
	279	static inline
	280	void bt_graph_make_faulty(struct bt_graph *graph)
	281	{
	282	graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
	283	BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
	284	}
	285
	286	#endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */