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

#ifndef BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H
#define BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/graph/connection-const.h>
#include <babeltrace/graph/message-const.h>
#include <babeltrace/graph/message-iterator.h>
#include <babeltrace/types.h>
#include <babeltrace/assert-internal.h>
#include <stdbool.h>

struct bt_port;
struct bt_graph;

enum bt_message_iterator_type {
	BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT,
	BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT,
};

enum bt_self_component_port_input_message_iterator_state {
	/* Iterator is not initialized. */
	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED,

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

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

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

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

struct bt_message_iterator {
	struct bt_object base;
	enum bt_message_iterator_type type;
	GPtrArray *msgs;
};

struct bt_self_component_port_input_message_iterator {
	struct bt_message_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 message iterator. This is used to, in developer
	 * mode:
	 *
	 * * Automatically enqueue "stream begin", "packet begin",
	 *   "packet end", and "stream end" messages depending
	 *   on the stream's state and on the next message returned
	 *   by the upstream component.
	 *
	 * * Make sure that, once the message iterator has seen a
	 *   "stream end" message for a given stream, no other
	 *   messages 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_self_component_port_input_message_iterator_state state;
	void *user_data;
};

struct bt_port_output_message_iterator {
	struct bt_message_iterator base;
	struct bt_graph *graph; /* Owned by this */
	struct bt_component_sink *colander; /* Owned by this */

	/*
	 * Only used temporarily as a bridge between a colander sink and
	 * the user.
	 */
	uint64_t count;
};

BT_HIDDEN
void bt_self_component_port_input_message_iterator_finalize(
		struct bt_self_component_port_input_message_iterator *iterator);

BT_HIDDEN
void bt_self_component_port_input_message_iterator_set_connection(
		struct bt_self_component_port_input_message_iterator *iterator,
		struct bt_connection *connection);

static inline
const char *bt_message_iterator_status_string(
		enum bt_message_iterator_status status)
{
	switch (status) {
	case BT_MESSAGE_ITERATOR_STATUS_CANCELED:
		return "BT_MESSAGE_ITERATOR_STATUS_CANCELED";
	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
		return "BT_MESSAGE_ITERATOR_STATUS_AGAIN";
	case BT_MESSAGE_ITERATOR_STATUS_END:
		return "BT_MESSAGE_ITERATOR_STATUS_END";
	case BT_MESSAGE_ITERATOR_STATUS_OK:
		return "BT_MESSAGE_ITERATOR_STATUS_OK";
	case BT_MESSAGE_ITERATOR_STATUS_ERROR:
		return "BT_MESSAGE_ITERATOR_STATUS_ERROR";
	case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
		return "BT_MESSAGE_ITERATOR_STATUS_NOMEM";
	default:
		return "(unknown)";
	}
};

static inline
const char *bt_self_component_port_input_message_iterator_state_string(
		enum bt_self_component_port_input_message_iterator_state state)
{
	switch (state) {
	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE:
		return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE";
	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED:
		return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED";
	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
		return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED";
	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED:
		return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED";
	default:
		return "(unknown)";
	}
};

#endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */
Commit	Line	Data
d6e69534 PP	1	#ifndef BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H
	2	#define BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
	27	#include <babeltrace/babeltrace-internal.h>
	28	#include <babeltrace/object-internal.h>
	29	#include <babeltrace/graph/connection-const.h>
	30	#include <babeltrace/graph/message-const.h>
	31	#include <babeltrace/graph/message-iterator.h>
	32	#include <babeltrace/types.h>
	33	#include <babeltrace/assert-internal.h>
	34	#include <stdbool.h>
	35
	36	struct bt_port;
	37	struct bt_graph;
	38
	39	enum bt_message_iterator_type {
	40	BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT,
	41	BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT,
	42	};
	43
	44	enum bt_self_component_port_input_message_iterator_state {
	45	/* Iterator is not initialized. */
	46	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED,
	47
	48	/* Iterator is active, not at the end yet, and not finalized. */
	49	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE,
	50
	51	/*
	52	* Iterator is ended, not finalized yet: the "next" method
	53	* returns BT_MESSAGE_ITERATOR_STATUS_END.
	54	*/
	55	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED,
	56
	57	/*
	58	* Iterator is finalized, but not at the end yet. This means
	59	* that the "next" method can still return queued messages
	60	* before returning the BT_MESSAGE_ITERATOR_STATUS_CANCELED
	61	* status.
	62	*/
	63	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED,
	64
65	/*
66	* Iterator is finalized and ended: the "next" method always
67	* returns BT_MESSAGE_ITERATOR_STATUS_CANCELED.
68	*/
69	BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED,
70	};
71
72	struct bt_message_iterator {
73	struct bt_object base;
74	enum bt_message_iterator_type type;
75	GPtrArray *msgs;
76	};
77
78	struct bt_self_component_port_input_message_iterator {
79	struct bt_message_iterator base;
80	struct bt_component upstream_component; / Weak */
81	struct bt_port upstream_port; / Weak */
82	struct bt_connection connection; / Weak */
83	struct bt_graph graph; / Weak */
84
85	/*
86	* This hash table keeps the state of a stream as viewed by
87	* this message iterator. This is used to, in developer
88	* mode:
89	*
90	* * Automatically enqueue "stream begin", "packet begin",
91	* "packet end", and "stream end" messages depending
92	* on the stream's state and on the next message returned
93	* by the upstream component.
94	*
95	* * Make sure that, once the message iterator has seen a
96	* "stream end" message for a given stream, no other
97	* messages which refer to this stream can be delivered
98	* by this iterator.
99	*
100	* The key (struct bt_stream *) is not owned by this. The
101	* value is an allocated state structure.
102	*/
103	GHashTable *stream_states;
104
105	enum bt_self_component_port_input_message_iterator_state state;
106	void *user_data;
107	};
108
109	struct bt_port_output_message_iterator {
110	struct bt_message_iterator base;
111	struct bt_graph graph; / Owned by this */
112	struct bt_component_sink colander; / Owned by this */
113
114	/*
115	* Only used temporarily as a bridge between a colander sink and
116	* the user.
117	*/
118	uint64_t count;
119	};
120
121	BT_HIDDEN
122	void bt_self_component_port_input_message_iterator_finalize(
123	struct bt_self_component_port_input_message_iterator *iterator);
124
125	BT_HIDDEN
126	void bt_self_component_port_input_message_iterator_set_connection(
127	struct bt_self_component_port_input_message_iterator *iterator,
128	struct bt_connection *connection);
129
130	static inline
131	const char *bt_message_iterator_status_string(
132	enum bt_message_iterator_status status)
133	{
134	switch (status) {
135	case BT_MESSAGE_ITERATOR_STATUS_CANCELED:
136	return "BT_MESSAGE_ITERATOR_STATUS_CANCELED";
137	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
138	return "BT_MESSAGE_ITERATOR_STATUS_AGAIN";
139	case BT_MESSAGE_ITERATOR_STATUS_END:
140	return "BT_MESSAGE_ITERATOR_STATUS_END";
141	case BT_MESSAGE_ITERATOR_STATUS_OK:
142	return "BT_MESSAGE_ITERATOR_STATUS_OK";
143	case BT_MESSAGE_ITERATOR_STATUS_ERROR:
144	return "BT_MESSAGE_ITERATOR_STATUS_ERROR";
145	case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
146	return "BT_MESSAGE_ITERATOR_STATUS_NOMEM";
147	default:
148	return "(unknown)";
149	}
150	};
151
152	static inline
153	const char *bt_self_component_port_input_message_iterator_state_string(
154	enum bt_self_component_port_input_message_iterator_state state)
155	{
156	switch (state) {
157	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE:
158	return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE";
159	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED:
160	return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED";
161	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
162	return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED";
163	case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED:
164	return "BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED";
165	default:
166	return "(unknown)";
167	}
168	};
169
170	#endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_INTERNAL_H */