[babeltrace.git] / include / babeltrace / graph / graph-internal.h

#ifndef BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H
#define BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H

/*
 * BabelTrace - Component Graph Internal
 *
 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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 <babeltrace/graph/graph.h>
#include <babeltrace/graph/component-status.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <stdlib.h>
#include <glib.h>

struct bt_component;
struct bt_port;

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;

	bt_bool canceled;
	bt_bool in_remove_listener;
	bt_bool has_sink;
	bt_bool can_consume;

	struct {
		GArray *port_added;
		GArray *port_removed;
		GArray *ports_connected;
		GArray *ports_disconnected;
	} listeners;
};

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

BT_HIDDEN
void bt_graph_notify_port_removed(struct bt_graph *graph,
		struct bt_component *comp, struct bt_port *port);

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

BT_HIDDEN
void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
		struct bt_component *upstream_comp,
		struct bt_component *downstream_comp,
		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);

static inline
const char *bt_graph_status_string(enum bt_graph_status status)
{
	switch (status) {
	case BT_GRAPH_STATUS_CANCELED:
		return "BT_GRAPH_STATUS_CANCELED";
	case BT_GRAPH_STATUS_AGAIN:
		return "BT_GRAPH_STATUS_AGAIN";
	case BT_GRAPH_STATUS_END:
		return "BT_GRAPH_STATUS_END";
	case BT_GRAPH_STATUS_OK:
		return "BT_GRAPH_STATUS_OK";
	case BT_GRAPH_STATUS_INVALID:
		return "BT_GRAPH_STATUS_INVALID";
	case BT_GRAPH_STATUS_NO_SINK:
		return "BT_GRAPH_STATUS_NO_SINK";
	case BT_GRAPH_STATUS_ERROR:
		return "BT_GRAPH_STATUS_ERROR";
	case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
		return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
	case BT_GRAPH_STATUS_NOMEM:
		return "BT_GRAPH_STATUS_NOMEM";
	case BT_GRAPH_STATUS_CANNOT_CONSUME:
		return "BT_GRAPH_STATUS_CANNOT_CONSUME";
	default:
		return "(unknown)";
	}
}

static inline
enum bt_graph_status bt_graph_status_from_component_status(
		enum bt_component_status comp_status)
{
	switch (comp_status) {
	case BT_COMPONENT_STATUS_OK:
		return BT_GRAPH_STATUS_OK;
	case BT_COMPONENT_STATUS_END:
		return BT_GRAPH_STATUS_END;
	case BT_COMPONENT_STATUS_AGAIN:
		return BT_GRAPH_STATUS_AGAIN;
	case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
		return BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION;
	case BT_COMPONENT_STATUS_ERROR:
		return BT_GRAPH_STATUS_ERROR;
	case BT_COMPONENT_STATUS_UNSUPPORTED:
		return BT_GRAPH_STATUS_ERROR;
	case BT_COMPONENT_STATUS_INVALID:
		return BT_GRAPH_STATUS_INVALID;
	case BT_COMPONENT_STATUS_NOMEM:
		return BT_GRAPH_STATUS_NOMEM;
	case BT_COMPONENT_STATUS_NOT_FOUND:
		return BT_GRAPH_STATUS_ERROR;
	default:
#ifdef BT_LOGF
		BT_LOGF("Unknown component status: status=%d", comp_status);
#endif
		abort();
	}
}

#endif /* BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H
c0418dd9 JG	3
	4	/*
	5	* BabelTrace - Component Graph Internal
	6	*
f60c8b34	7	* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c0418dd9 JG	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
b2e0c907	30	#include <babeltrace/graph/graph.h>
a256a42d	31	#include <babeltrace/graph/component-status.h>
c0418dd9 JG	32	#include <babeltrace/babeltrace-internal.h>
c0418dd9 JG	33	#include <babeltrace/object-internal.h>
a256a42d	34	#include <stdlib.h>
c0418dd9 JG	35	#include <glib.h>
c0418dd9 JG	36
1bf957a0 PP	37	struct bt_component;
	38	struct bt_port;
	39
f60c8b34 JG	40	struct bt_graph {
	41	/**
	42	* A component graph contains components and point-to-point connection
	43	* between these components.
c0418dd9	44	*
f60c8b34 JG	45	* In terms of ownership:
	46	* 1) The graph is the components' parent,
	47	* 2) The graph is the connnections' parent,
	48	* 3) Components share the ownership of their connections,
	49	* 4) A connection holds weak references to its two component endpoints.
c0418dd9	50	*/
f60c8b34 JG	51	struct bt_object base;
	52
	53	/* Array of pointers to bt_connection. */
	54	GPtrArray *connections;
	55	/* Array of pointers to bt_component. */
	56	GPtrArray *components;
	57	/* Queue of pointers (weak references) to sink bt_components. */
	58	GQueue *sinks_to_consume;
1bf957a0	59
202a3a13	60	bt_bool canceled;
8cc092c9	61	bt_bool in_remove_listener;
2de524b3	62	bt_bool has_sink;
1d915789	63	bt_bool can_consume;
202a3a13	64
1bf957a0 PP	65	struct {
	66	GArray *port_added;
	67	GArray *port_removed;
f345f8bb PP	68	GArray *ports_connected;
f345f8bb PP	69	GArray *ports_disconnected;
1bf957a0	70	} listeners;
c0418dd9 JG	71	};
c0418dd9 JG	72
1bf957a0 PP	73	BT_HIDDEN
	74	void bt_graph_notify_port_added(struct bt_graph graph, struct bt_port port);
	75
	76	BT_HIDDEN
	77	void bt_graph_notify_port_removed(struct bt_graph *graph,
	78	struct bt_component comp, struct bt_port port);
	79
	80	BT_HIDDEN
f345f8bb PP	81	void bt_graph_notify_ports_connected(struct bt_graph *graph,
f345f8bb PP	82	struct bt_port upstream_port, struct bt_port downstream_port);
1bf957a0 PP	83
1bf957a0 PP	84	BT_HIDDEN
f345f8bb PP	85	void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
	86	struct bt_component *upstream_comp,
	87	struct bt_component *downstream_comp,
	88	struct bt_port *upstream_port,
	89	struct bt_port *downstream_port);
1bf957a0	90
f167d3c0 PP	91	BT_HIDDEN
	92	void bt_graph_remove_connection(struct bt_graph *graph,
	93	struct bt_connection *connection);
	94
262e5473 PP	95	static inline
	96	const char *bt_graph_status_string(enum bt_graph_status status)
	97	{
	98	switch (status) {
	99	case BT_GRAPH_STATUS_CANCELED:
	100	return "BT_GRAPH_STATUS_CANCELED";
	101	case BT_GRAPH_STATUS_AGAIN:
	102	return "BT_GRAPH_STATUS_AGAIN";
	103	case BT_GRAPH_STATUS_END:
	104	return "BT_GRAPH_STATUS_END";
	105	case BT_GRAPH_STATUS_OK:
	106	return "BT_GRAPH_STATUS_OK";
262e5473 PP	107	case BT_GRAPH_STATUS_INVALID:
	108	return "BT_GRAPH_STATUS_INVALID";
	109	case BT_GRAPH_STATUS_NO_SINK:
	110	return "BT_GRAPH_STATUS_NO_SINK";
	111	case BT_GRAPH_STATUS_ERROR:
	112	return "BT_GRAPH_STATUS_ERROR";
a256a42d PP	113	case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
	114	return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
	115	case BT_GRAPH_STATUS_NOMEM:
	116	return "BT_GRAPH_STATUS_NOMEM";
1d915789 PP	117	case BT_GRAPH_STATUS_CANNOT_CONSUME:
1d915789 PP	118	return "BT_GRAPH_STATUS_CANNOT_CONSUME";
262e5473 PP	119	default:
	120	return "(unknown)";
	121	}
	122	}
	123
a256a42d PP	124	static inline
	125	enum bt_graph_status bt_graph_status_from_component_status(
	126	enum bt_component_status comp_status)
	127	{
	128	switch (comp_status) {
	129	case BT_COMPONENT_STATUS_OK:
	130	return BT_GRAPH_STATUS_OK;
	131	case BT_COMPONENT_STATUS_END:
	132	return BT_GRAPH_STATUS_END;
	133	case BT_COMPONENT_STATUS_AGAIN:
	134	return BT_GRAPH_STATUS_AGAIN;
	135	case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
	136	return BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION;
	137	case BT_COMPONENT_STATUS_ERROR:
	138	return BT_GRAPH_STATUS_ERROR;
	139	case BT_COMPONENT_STATUS_UNSUPPORTED:
	140	return BT_GRAPH_STATUS_ERROR;
	141	case BT_COMPONENT_STATUS_INVALID:
	142	return BT_GRAPH_STATUS_INVALID;
	143	case BT_COMPONENT_STATUS_NOMEM:
	144	return BT_GRAPH_STATUS_NOMEM;
	145	case BT_COMPONENT_STATUS_NOT_FOUND:
	146	return BT_GRAPH_STATUS_ERROR;
	147	default:
	148	#ifdef BT_LOGF
	149	BT_LOGF("Unknown component status: status=%d", comp_status);
	150	#endif
	151	abort();
	152	}
	153	}
	154
33b34c43	155	#endif /* BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H */