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