[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/babeltrace-internal.h>
#include <babeltrace/object-internal.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;

	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_ALREADY_IN_A_GRAPH:
		return "BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH";
	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";
	default:
		return "(unknown)";
	}
}

#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>
c0418dd9 JG	31	#include <babeltrace/babeltrace-internal.h>
	32	#include <babeltrace/object-internal.h>
	33	#include <glib.h>
	34
1bf957a0 PP	35	struct bt_component;
	36	struct bt_port;
	37
f60c8b34 JG	38	struct bt_graph {
	39	/**
	40	* A component graph contains components and point-to-point connection
	41	* between these components.
c0418dd9	42	*
f60c8b34 JG	43	* In terms of ownership:
	44	* 1) The graph is the components' parent,
	45	* 2) The graph is the connnections' parent,
	46	* 3) Components share the ownership of their connections,
	47	* 4) A connection holds weak references to its two component endpoints.
c0418dd9	48	*/
f60c8b34 JG	49	struct bt_object base;
	50
	51	/* Array of pointers to bt_connection. */
	52	GPtrArray *connections;
	53	/* Array of pointers to bt_component. */
	54	GPtrArray *components;
	55	/* Queue of pointers (weak references) to sink bt_components. */
	56	GQueue *sinks_to_consume;
1bf957a0	57
202a3a13 PP	58	bt_bool canceled;
202a3a13 PP	59
1bf957a0 PP	60	struct {
	61	GArray *port_added;
	62	GArray *port_removed;
f345f8bb PP	63	GArray *ports_connected;
f345f8bb PP	64	GArray *ports_disconnected;
1bf957a0	65	} listeners;
c0418dd9 JG	66	};
c0418dd9 JG	67
1bf957a0 PP	68	BT_HIDDEN
	69	void bt_graph_notify_port_added(struct bt_graph graph, struct bt_port port);
	70
	71	BT_HIDDEN
	72	void bt_graph_notify_port_removed(struct bt_graph *graph,
	73	struct bt_component comp, struct bt_port port);
	74
	75	BT_HIDDEN
f345f8bb PP	76	void bt_graph_notify_ports_connected(struct bt_graph *graph,
f345f8bb PP	77	struct bt_port upstream_port, struct bt_port downstream_port);
1bf957a0 PP	78
1bf957a0 PP	79	BT_HIDDEN
f345f8bb PP	80	void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
	81	struct bt_component *upstream_comp,
	82	struct bt_component *downstream_comp,
	83	struct bt_port *upstream_port,
	84	struct bt_port *downstream_port);
1bf957a0	85
f167d3c0 PP	86	BT_HIDDEN
	87	void bt_graph_remove_connection(struct bt_graph *graph,
	88	struct bt_connection *connection);
	89
262e5473 PP	90	static inline
	91	const char *bt_graph_status_string(enum bt_graph_status status)
	92	{
	93	switch (status) {
	94	case BT_GRAPH_STATUS_CANCELED:
	95	return "BT_GRAPH_STATUS_CANCELED";
	96	case BT_GRAPH_STATUS_AGAIN:
	97	return "BT_GRAPH_STATUS_AGAIN";
	98	case BT_GRAPH_STATUS_END:
	99	return "BT_GRAPH_STATUS_END";
	100	case BT_GRAPH_STATUS_OK:
	101	return "BT_GRAPH_STATUS_OK";
	102	case BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH:
	103	return "BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH";
	104	case BT_GRAPH_STATUS_INVALID:
	105	return "BT_GRAPH_STATUS_INVALID";
	106	case BT_GRAPH_STATUS_NO_SINK:
	107	return "BT_GRAPH_STATUS_NO_SINK";
	108	case BT_GRAPH_STATUS_ERROR:
	109	return "BT_GRAPH_STATUS_ERROR";
	110	default:
	111	return "(unknown)";
	112	}
	113	}
	114
33b34c43	115	#endif /* BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H */