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

#ifndef BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
#define BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H

/*
 * BabelTrace - Component Connection 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/connection.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/notification-iterator-internal.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/object-internal.h>
#include <stdbool.h>

struct bt_graph;

struct bt_connection {
	/*
	 * The graph is a connection's parent and the connection is the parent
	 * of all iterators it has created.
	 */
	struct bt_object base;
	/*
	 * Weak references are held to both ports. Their existence is guaranteed
	 * by the existence of the graph and thus, of their respective
	 * components.
	 */
	/* Downstream port. */
	struct bt_port *downstream_port;
	/* Upstream port. */
	struct bt_port *upstream_port;

	/*
	 * Weak references to all the notification iterators that were
	 * created on this connection.
	 */
	GPtrArray *iterators;
};

static inline
struct bt_connection *bt_connection_from_private(
		struct bt_private_connection *private_connection)
{
	return (void *) private_connection;
}

static inline
struct bt_private_connection *bt_private_connection_from_connection(
		struct bt_connection *connection)
{
	return (void *) connection;
}

BT_HIDDEN
struct bt_connection *bt_connection_create(struct bt_graph *graph,
		struct bt_port *upstream_port,
		struct bt_port *downstream_port);

BT_HIDDEN
void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);

BT_HIDDEN
void bt_connection_remove_iterator(struct bt_connection *conn,
		struct bt_notification_iterator_private_connection *iterator);

static inline
struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
{
	assert(conn);
	return (void *) conn->base.parent;
}

static inline
enum bt_connection_status
bt_connection_status_from_notification_iterator_status(
		enum bt_notification_iterator_status iter_status)
{
	switch (iter_status) {
	case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
		return BT_CONNECTION_STATUS_ERROR;
	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
		return BT_CONNECTION_STATUS_ERROR;
	case BT_NOTIFICATION_ITERATOR_STATUS_END:
		return BT_CONNECTION_STATUS_ERROR;
	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
		return BT_CONNECTION_STATUS_OK;
	case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
		return BT_CONNECTION_STATUS_INVALID;
	case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
		return BT_CONNECTION_STATUS_ERROR;
	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
		return BT_CONNECTION_STATUS_NOMEM;
	case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
		return BT_CONNECTION_STATUS_ERROR;
	default:
#ifdef BT_LOGF
		BT_LOGF("Unknown notification iterator status: status=%d",
			iter_status);
#endif
		abort();
	}
}

static inline
const char *bt_connection_status_string(enum bt_connection_status status)
{
	switch (status) {
	case BT_CONNECTION_STATUS_GRAPH_IS_CANCELED:
		return "BT_CONNECTION_STATUS_GRAPH_IS_CANCELED";
	case BT_CONNECTION_STATUS_OK:
		return "BT_CONNECTION_STATUS_OK";
	case BT_CONNECTION_STATUS_INVALID:
		return "BT_CONNECTION_STATUS_INVALID";
	case BT_CONNECTION_STATUS_ERROR:
		return "BT_CONNECTION_STATUS_ERROR";
	case BT_CONNECTION_STATUS_NOMEM:
		return "BT_CONNECTION_STATUS_NOMEM";
	case BT_CONNECTION_STATUS_IS_ENDED:
		return "BT_CONNECTION_STATUS_IS_ENDED";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */
Commit	Line	Data
784cdc68 JG	1	#ifndef BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
	2	#define BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - Component Connection Internal
	6	*
	7	* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	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/connection.h>
73d5c1ad	31	#include <babeltrace/graph/notification-iterator.h>
90157d89	32	#include <babeltrace/graph/notification-iterator-internal.h>
b2e0c907	33	#include <babeltrace/graph/private-connection.h>
784cdc68	34	#include <babeltrace/object-internal.h>
c42ea0af	35	#include <stdbool.h>
784cdc68 JG	36
	37	struct bt_graph;
	38
	39	struct bt_connection {
	40	/*
	41	* The graph is a connection's parent and the connection is the parent
	42	* of all iterators it has created.
	43	*/
	44	struct bt_object base;
	45	/*
	46	* Weak references are held to both ports. Their existence is guaranteed
	47	* by the existence of the graph and thus, of their respective
	48	* components.
	49	*/
	50	/* Downstream port. */
72b913fb	51	struct bt_port *downstream_port;
784cdc68	52	/* Upstream port. */
72b913fb	53	struct bt_port *upstream_port;
bd14d768 PP	54
	55	/*
	56	* Weak references to all the notification iterators that were
	57	* created on this connection.
	58	*/
	59	GPtrArray *iterators;
784cdc68 JG	60	};
784cdc68 JG	61
890882ef PP	62	static inline
	63	struct bt_connection *bt_connection_from_private(
	64	struct bt_private_connection *private_connection)
	65	{
	66	return (void *) private_connection;
	67	}
	68
	69	static inline
	70	struct bt_private_connection *bt_private_connection_from_connection(
	71	struct bt_connection *connection)
	72	{
	73	return (void *) connection;
	74	}
	75
784cdc68 JG	76	BT_HIDDEN
784cdc68 JG	77	struct bt_connection bt_connection_create(struct bt_graph graph,
72b913fb PP	78	struct bt_port *upstream_port,
	79	struct bt_port *downstream_port);
	80
	81	BT_HIDDEN
c42ea0af	82	void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
784cdc68	83
bd14d768 PP	84	BT_HIDDEN
bd14d768 PP	85	void bt_connection_remove_iterator(struct bt_connection *conn,
90157d89	86	struct bt_notification_iterator_private_connection *iterator);
bd14d768	87
c28d097c PP	88	static inline
	89	struct bt_graph bt_connection_borrow_graph(struct bt_connection conn)
	90	{
	91	assert(conn);
	92	return (void *) conn->base.parent;
	93	}
	94
73d5c1ad PP	95	static inline
	96	enum bt_connection_status
	97	bt_connection_status_from_notification_iterator_status(
	98	enum bt_notification_iterator_status iter_status)
	99	{
	100	switch (iter_status) {
	101	case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
	102	return BT_CONNECTION_STATUS_ERROR;
	103	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
	104	return BT_CONNECTION_STATUS_ERROR;
	105	case BT_NOTIFICATION_ITERATOR_STATUS_END:
	106	return BT_CONNECTION_STATUS_ERROR;
	107	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
	108	return BT_CONNECTION_STATUS_OK;
	109	case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
	110	return BT_CONNECTION_STATUS_INVALID;
	111	case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
	112	return BT_CONNECTION_STATUS_ERROR;
	113	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
	114	return BT_CONNECTION_STATUS_NOMEM;
	115	case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
	116	return BT_CONNECTION_STATUS_ERROR;
	117	default:
	118	#ifdef BT_LOGF
	119	BT_LOGF("Unknown notification iterator status: status=%d",
	120	iter_status);
	121	#endif
	122	abort();
	123	}
	124	}
	125
fed72692 PP	126	static inline
	127	const char *bt_connection_status_string(enum bt_connection_status status)
	128	{
	129	switch (status) {
	130	case BT_CONNECTION_STATUS_GRAPH_IS_CANCELED:
	131	return "BT_CONNECTION_STATUS_GRAPH_IS_CANCELED";
	132	case BT_CONNECTION_STATUS_OK:
	133	return "BT_CONNECTION_STATUS_OK";
	134	case BT_CONNECTION_STATUS_INVALID:
	135	return "BT_CONNECTION_STATUS_INVALID";
	136	case BT_CONNECTION_STATUS_ERROR:
	137	return "BT_CONNECTION_STATUS_ERROR";
	138	case BT_CONNECTION_STATUS_NOMEM:
	139	return "BT_CONNECTION_STATUS_NOMEM";
	140	case BT_CONNECTION_STATUS_IS_ENDED:
	141	return "BT_CONNECTION_STATUS_IS_ENDED";
	142	default:
	143	return "(unknown)";
	144	}
	145	}
	146
784cdc68	147	#endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */