[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.h>
#include "common/macros.h"
#include "lib/object.h"
#include "lib/object-pool.h"
#include "common/assert.h"
#include "common/common.h"
#include <stdbool.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,
	BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
};

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;

	uint64_t mip_version;

	/*
	 * Array of `struct bt_interrupter *`, each one owned by this.
	 * If any interrupter is set, then this graph is deemed
	 * interrupted.
	 */
	GPtrArray *interrupters;

	/*
	 * Default interrupter, owned by this.
	 */
	struct bt_interrupter *default_interrupter;

	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;
	} 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_DBG(graph);
	graph->can_consume = can_consume;
}

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
void bt_graph_remove_connection(struct bt_graph *graph,
		struct bt_connection *connection);

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

BT_HIDDEN
bool bt_graph_is_interrupted(const struct bt_graph *graph);

static inline
const char *bt_graph_configuration_state_string(
		enum bt_graph_configuration_state state)
{
	switch (state) {
	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
		return "CONFIGURING";
	case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
		return "PARTIALLY_CONFIGURED";
	case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
		return "CONFIGURED";
	case BT_GRAPH_CONFIGURATION_STATE_FAULTY:
		return "FAULTY";
	case BT_GRAPH_CONFIGURATION_STATE_DESTROYING:
		return "DESTROYING";
	default:
		return "(unknown)";
	}
}

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

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