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

#ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
#define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H

/*
 * BabelTrace - Notification Iterator Internal
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2017 Philippe Proulx <pproulx@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/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/ref-internal.h>
#include <babeltrace/graph/connection.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/private-connection-private-notification-iterator.h>
#include <babeltrace/types.h>
#include <babeltrace/assert-internal.h>
#include <stdbool.h>

struct bt_port;
struct bt_graph;

enum bt_notification_iterator_type {
	BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION,
	BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT,
};

enum bt_private_connection_notification_iterator_notif_type {
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT =			(1U << 0),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY =		(1U << 1),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN =		(1U << 2),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END =		(1U << 3),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN =		(1U << 4),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END =		(1U << 5),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS =	(1U << 6),
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS =	(1U << 7),
};

enum bt_private_connection_notification_iterator_state {
	/* Iterator is not initialized. */
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED,

	/* Iterator is active, not at the end yet, and not finalized. */
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE,

	/*
	 * Iterator is ended, not finalized yet: the "next" method
	 * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
	 */
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED,

	/*
	 * Iterator is finalized, but not at the end yet. This means
	 * that the "next" method can still return queued notifications
	 * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
	 * status.
	 */
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED,

	/*
	 * Iterator is finalized and ended: the "next" method always
	 * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
	 */
	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED,
};

struct bt_notification_iterator {
	struct bt_object base;
	enum bt_notification_iterator_type type;
	struct bt_notification *current_notification; /* owned by this */
};

struct bt_notification_iterator_private_connection {
	struct bt_notification_iterator base;
	struct bt_component *upstream_component; /* Weak */
	struct bt_port *upstream_port; /* Weak */
	struct bt_connection *connection; /* Weak */
	struct bt_graph *graph; /* Weak */

	/*
	 * This hash table keeps the state of a stream as viewed by
	 * this notification iterator. This is used to, in developer
	 * mode:
	 *
	 * * Automatically enqueue "stream begin", "packet begin",
	 *   "packet end", and "stream end" notifications depending
	 *   on the stream's state and on the next notification returned
	 *   by the upstream component.
	 *
	 * * Make sure that, once the notification iterator has seen a
	 *   "stream end" notification for a given stream, no other
	 *   notifications which refer to this stream can be delivered
	 *   by this iterator.
	 *
	 * The key (struct bt_stream *) is not owned by this. The
	 * value is an allocated state structure.
	 */
	GHashTable *stream_states;

	enum bt_private_connection_notification_iterator_state state;
	void *user_data;
};

struct bt_notification_iterator_output_port {
	struct bt_notification_iterator base;
	struct bt_graph *graph; /* Owned by this */
	struct bt_component *colander; /* Owned by this */
	struct bt_port *output_port; /* Owned by this */
};

static inline
struct bt_notification *bt_notification_iterator_borrow_current_notification(
		struct bt_notification_iterator *iterator)
{
	BT_ASSERT(iterator);
	return iterator->current_notification;
}

static inline
void bt_notification_iterator_replace_current_notification(
		struct bt_notification_iterator *iterator,
		struct bt_notification *notification)
{
	BT_ASSERT(iterator);
	bt_put(iterator->current_notification);
	iterator->current_notification = bt_get(notification);
}

static inline
struct bt_private_connection_private_notification_iterator *
bt_private_connection_private_notification_iterator_from_notification_iterator(
		struct bt_notification_iterator_private_connection *iterator)
{
	return (void *) iterator;
}

BT_HIDDEN
enum bt_connection_status bt_private_connection_notification_iterator_create(
		struct bt_component *upstream_comp,
		struct bt_port *upstream_port,
		struct bt_connection *connection,
		struct bt_notification_iterator_private_connection **iterator);

BT_HIDDEN
void bt_private_connection_notification_iterator_finalize(
		struct bt_notification_iterator_private_connection *iterator);

BT_HIDDEN
void bt_private_connection_notification_iterator_set_connection(
		struct bt_notification_iterator_private_connection *iterator,
		struct bt_connection *connection);

static inline
const char *bt_notification_iterator_status_string(
		enum bt_notification_iterator_status status)
{
	switch (status) {
	case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
		return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
		return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
	case BT_NOTIFICATION_ITERATOR_STATUS_END:
		return "BT_NOTIFICATION_ITERATOR_STATUS_END";
	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
		return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
	case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
		return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
	case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
		return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
		return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
	case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
		return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
	default:
		return "(unknown)";
	}
};

static inline
const char *bt_private_connection_notification_iterator_state_string(
		enum bt_private_connection_notification_iterator_state state)
{
	switch (state) {
	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE:
		return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED:
		return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED:
		return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
		return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
	default:
		return "(unknown)";
	}
};

#endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */
Commit	Line	Data
6ac74c0c PP	1	#ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
6ac74c0c PP	2	#define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
47e5a032 JG	3
	4	/*
	5	* BabelTrace - Notification Iterator Internal
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3230ee6b	8	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
47e5a032 JG	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
	29	#include <babeltrace/babeltrace-internal.h>
890882ef	30	#include <babeltrace/object-internal.h>
fb2dcc52	31	#include <babeltrace/ref-internal.h>
bd14d768	32	#include <babeltrace/graph/connection.h>
b2e0c907 PP	33	#include <babeltrace/graph/notification.h>
b2e0c907 PP	34	#include <babeltrace/graph/notification-iterator.h>
90157d89	35	#include <babeltrace/graph/private-connection-private-notification-iterator.h>
c55a9f58	36	#include <babeltrace/types.h>
f6ccaed9	37	#include <babeltrace/assert-internal.h>
088d4023	38	#include <stdbool.h>
47e5a032	39
3230ee6b	40	struct bt_port;
8ed535b5	41	struct bt_graph;
3230ee6b	42
90157d89 PP	43	enum bt_notification_iterator_type {
90157d89 PP	44	BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION,
8ed535b5	45	BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT,
fa054faf PP	46	};
fa054faf PP	47
90157d89 PP	48	enum bt_private_connection_notification_iterator_notif_type {
	49	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT = (1U << 0),
	50	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY = (1U << 1),
	51	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN = (1U << 2),
	52	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END = (1U << 3),
	53	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN = (1U << 4),
	54	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END = (1U << 5),
	55	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS = (1U << 6),
	56	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS = (1U << 7),
	57	};
	58
	59	enum bt_private_connection_notification_iterator_state {
088d4023	60	/* Iterator is not initialized. */
90157d89	61	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED,
088d4023	62
bd14d768	63	/* Iterator is active, not at the end yet, and not finalized. */
90157d89	64	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE,
bd14d768 PP	65
	66	/*
	67	* Iterator is ended, not finalized yet: the "next" method
	68	* returns BT_NOTIFICATION_ITERATOR_STATUS_END.
	69	*/
90157d89	70	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED,
bd14d768 PP	71
	72	/*
	73	* Iterator is finalized, but not at the end yet. This means
	74	* that the "next" method can still return queued notifications
	75	* before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
	76	* status.
	77	*/
90157d89	78	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED,
bd14d768 PP	79
	80	/*
	81	* Iterator is finalized and ended: the "next" method always
	82	* returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
	83	*/
90157d89	84	BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED,
bd14d768 PP	85	};
bd14d768 PP	86
47e5a032	87	struct bt_notification_iterator {
b8a06801	88	struct bt_object base;
90157d89	89	enum bt_notification_iterator_type type;
8ed535b5	90	struct bt_notification current_notification; / owned by this */
90157d89 PP	91	};
	92
	93	struct bt_notification_iterator_private_connection {
	94	struct bt_notification_iterator base;
bd14d768 PP	95	struct bt_component upstream_component; / Weak */
	96	struct bt_port upstream_port; / Weak */
	97	struct bt_connection connection; / Weak */
5c563278	98	struct bt_graph graph; / Weak */
3230ee6b PP	99
	100	/*
	101	* This hash table keeps the state of a stream as viewed by
f42867e2 PP	102	* this notification iterator. This is used to, in developer
f42867e2 PP	103	* mode:
3230ee6b PP	104	*
	105	* * Automatically enqueue "stream begin", "packet begin",
	106	* "packet end", and "stream end" notifications depending
	107	* on the stream's state and on the next notification returned
	108	* by the upstream component.
	109	*
f42867e2 PP	110	* * Make sure that, once the notification iterator has seen a
	111	* "stream end" notification for a given stream, no other
	112	* notifications which refer to this stream can be delivered
	113	* by this iterator.
3230ee6b	114	*
50842bdc	115	* The key (struct bt_stream *) is not owned by this. The
3230ee6b PP	116	* value is an allocated state structure.
	117	*/
	118	GHashTable *stream_states;
	119
90157d89	120	enum bt_private_connection_notification_iterator_state state;
47e5a032 JG	121	void *user_data;
	122	};
	123
8ed535b5 PP	124	struct bt_notification_iterator_output_port {
	125	struct bt_notification_iterator base;
	126	struct bt_graph graph; / Owned by this */
	127	struct bt_component colander; / Owned by this */
	128	struct bt_port output_port; / Owned by this */
	129	};
	130
	131	static inline
	132	struct bt_notification *bt_notification_iterator_borrow_current_notification(
	133	struct bt_notification_iterator *iterator)
	134	{
f6ccaed9	135	BT_ASSERT(iterator);
8ed535b5 PP	136	return iterator->current_notification;
	137	}
	138
	139	static inline
	140	void bt_notification_iterator_replace_current_notification(
	141	struct bt_notification_iterator *iterator,
	142	struct bt_notification *notification)
	143	{
f6ccaed9	144	BT_ASSERT(iterator);
8ed535b5 PP	145	bt_put(iterator->current_notification);
	146	iterator->current_notification = bt_get(notification);
	147	}
	148
890882ef	149	static inline
90157d89 PP	150	struct bt_private_connection_private_notification_iterator *
	151	bt_private_connection_private_notification_iterator_from_notification_iterator(
	152	struct bt_notification_iterator_private_connection *iterator)
890882ef	153	{
90157d89	154	return (void *) iterator;
890882ef PP	155	}
890882ef PP	156
47e5a032	157	BT_HIDDEN
90157d89	158	enum bt_connection_status bt_private_connection_notification_iterator_create(
73d5c1ad	159	struct bt_component *upstream_comp,
fa054faf	160	struct bt_port *upstream_port,
73d5c1ad	161	struct bt_connection *connection,
90157d89	162	struct bt_notification_iterator_private_connection **iterator);
47e5a032	163
bd14d768	164	BT_HIDDEN
90157d89 PP	165	void bt_private_connection_notification_iterator_finalize(
90157d89 PP	166	struct bt_notification_iterator_private_connection *iterator);
bd14d768 PP	167
bd14d768 PP	168	BT_HIDDEN
90157d89 PP	169	void bt_private_connection_notification_iterator_set_connection(
90157d89 PP	170	struct bt_notification_iterator_private_connection *iterator,
bd14d768 PP	171	struct bt_connection *connection);
bd14d768 PP	172
a36bfb16 PP	173	static inline
	174	const char *bt_notification_iterator_status_string(
	175	enum bt_notification_iterator_status status)
	176	{
	177	switch (status) {
	178	case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
	179	return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
	180	case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
	181	return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
	182	case BT_NOTIFICATION_ITERATOR_STATUS_END:
	183	return "BT_NOTIFICATION_ITERATOR_STATUS_END";
	184	case BT_NOTIFICATION_ITERATOR_STATUS_OK:
	185	return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
	186	case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
	187	return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
	188	case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
	189	return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
	190	case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
	191	return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
	192	case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
	193	return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
	194	default:
	195	return "(unknown)";
	196	}
	197	};
	198
8f9d7550	199	static inline
90157d89 PP	200	const char *bt_private_connection_notification_iterator_state_string(
90157d89 PP	201	enum bt_private_connection_notification_iterator_state state)
8f9d7550 PP	202	{
8f9d7550 PP	203	switch (state) {
90157d89 PP	204	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE:
	205	return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
	206	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED:
	207	return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
	208	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED:
	209	return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
	210	case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
	211	return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
8f9d7550 PP	212	default:
	213	return "(unknown)";
	214	}
	215	};
	216
6ac74c0c	217	#endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */