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

#ifndef BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
#define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef enum bt_message_iterator_next_status {
	BT_MESSAGE_ITERATOR_NEXT_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_NEXT_STATUS_END		= __BT_FUNC_STATUS_END,
	BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_next_status;

typedef enum bt_message_iterator_seek_beginning_status {
	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_seek_beginning_status;

typedef enum bt_message_iterator_seek_ns_from_origin_status {
	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_seek_ns_from_origin_status;

typedef enum bt_message_iterator_can_seek_beginning_status {
	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_AGAIN		= __BT_FUNC_STATUS_AGAIN,
	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_can_seek_beginning_status;

typedef enum bt_message_iterator_can_seek_ns_from_origin_status {
	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN	= __BT_FUNC_STATUS_AGAIN,
	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_ERROR	= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_can_seek_ns_from_origin_status;

typedef enum bt_message_iterator_create_from_message_iterator_status {
	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_create_from_message_iterator_status;

typedef enum bt_message_iterator_create_from_sink_component_status {
	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR		= __BT_FUNC_STATUS_ERROR,
	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_message_iterator_create_from_sink_component_status;

static inline
bt_message_iterator *
bt_message_iterator_as_message_iterator(
		bt_message_iterator *iterator)
{
	return __BT_UPCAST(bt_message_iterator, iterator);
}

extern bt_message_iterator_create_from_message_iterator_status
bt_message_iterator_create_from_message_iterator(
		bt_self_message_iterator *self_msg_iter,
		bt_self_component_port_input *input_port,
		bt_message_iterator **message_iterator);

extern bt_message_iterator_create_from_sink_component_status
bt_message_iterator_create_from_sink_component(
		bt_self_component_sink *self_comp,
		bt_self_component_port_input *input_port,
		bt_message_iterator **message_iterator);

extern bt_component *
bt_message_iterator_borrow_component(
		bt_message_iterator *iterator);

extern bt_message_iterator_next_status
bt_message_iterator_next(
		bt_message_iterator *iterator,
		bt_message_array_const *msgs, uint64_t *count);

extern bt_message_iterator_can_seek_ns_from_origin_status
bt_message_iterator_can_seek_ns_from_origin(
		bt_message_iterator *iterator,
		int64_t ns_from_origin, bt_bool *can_seek);

extern bt_message_iterator_can_seek_beginning_status
bt_message_iterator_can_seek_beginning(
		bt_message_iterator *iterator,
		bt_bool *can_seek);

extern bt_message_iterator_seek_ns_from_origin_status
bt_message_iterator_seek_ns_from_origin(
		bt_message_iterator *iterator,
		int64_t ns_from_origin);

extern bt_message_iterator_seek_beginning_status
bt_message_iterator_seek_beginning(
		bt_message_iterator *iterator);

extern bt_bool
bt_message_iterator_can_seek_forward(
		bt_message_iterator *iterator);

extern void bt_message_iterator_get_ref(
		const bt_message_iterator *message_iterator);

extern void bt_message_iterator_put_ref(
		const bt_message_iterator *message_iterator);

#define BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
	do {								\
		bt_message_iterator_put_ref(_var); \
		(_var) = NULL;						\
	} while (0)

#define BT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
	do {								\
		bt_message_iterator_put_ref(_var_dst); \
		(_var_dst) = (_var_src);				\
		(_var_src) = NULL;					\
	} while (0)

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H */
Commit	Line	Data
924dc299 PP	1	#ifndef BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
924dc299 PP	2	#define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
d24d5663 PP	3
d24d5663 PP	4	/*
bbb7b5f0	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
d24d5663 PP	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
4fa90f32 PP	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
d24d5663 PP	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
	34	typedef enum bt_message_iterator_next_status {
	35	BT_MESSAGE_ITERATOR_NEXT_STATUS_OK = __BT_FUNC_STATUS_OK,
	36	BT_MESSAGE_ITERATOR_NEXT_STATUS_END = __BT_FUNC_STATUS_END,
	37	BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	38	BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	39	BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	40	} bt_message_iterator_next_status;
	41
	42	typedef enum bt_message_iterator_seek_beginning_status {
	43	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK = __BT_FUNC_STATUS_OK,
d24d5663 PP	44	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	45	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	46	BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	47	} bt_message_iterator_seek_beginning_status;
	48
	49	typedef enum bt_message_iterator_seek_ns_from_origin_status {
	50	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_OK = __BT_FUNC_STATUS_OK,
d24d5663 PP	51	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	52	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	53	BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	54	} bt_message_iterator_seek_ns_from_origin_status;
	55
f2fb1b32 SM	56	typedef enum bt_message_iterator_can_seek_beginning_status {
	57	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_OK = __BT_FUNC_STATUS_OK,
	58	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	59	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	60	BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	61	} bt_message_iterator_can_seek_beginning_status;
	62
	63	typedef enum bt_message_iterator_can_seek_ns_from_origin_status {
	64	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_OK = __BT_FUNC_STATUS_OK,
	65	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
	66	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	67	BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	68	} bt_message_iterator_can_seek_ns_from_origin_status;
	69
9a2c8b8e PP	70	typedef enum bt_message_iterator_create_from_message_iterator_status {
	71	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK = __BT_FUNC_STATUS_OK,
	72	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	73	BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	74	} bt_message_iterator_create_from_message_iterator_status;
	75
	76	typedef enum bt_message_iterator_create_from_sink_component_status {
	77	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK = __BT_FUNC_STATUS_OK,
	78	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
	79	BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	80	} bt_message_iterator_create_from_sink_component_status;
	81
	82	static inline
	83	bt_message_iterator *
	84	bt_message_iterator_as_message_iterator(
	85	bt_message_iterator *iterator)
	86	{
	87	return __BT_UPCAST(bt_message_iterator, iterator);
	88	}
	89
	90	extern bt_message_iterator_create_from_message_iterator_status
	91	bt_message_iterator_create_from_message_iterator(
	92	bt_self_message_iterator *self_msg_iter,
	93	bt_self_component_port_input *input_port,
	94	bt_message_iterator **message_iterator);
	95
	96	extern bt_message_iterator_create_from_sink_component_status
	97	bt_message_iterator_create_from_sink_component(
	98	bt_self_component_sink *self_comp,
	99	bt_self_component_port_input *input_port,
	100	bt_message_iterator **message_iterator);
	101
	102	extern bt_component *
	103	bt_message_iterator_borrow_component(
	104	bt_message_iterator *iterator);
	105
	106	extern bt_message_iterator_next_status
	107	bt_message_iterator_next(
	108	bt_message_iterator *iterator,
	109	bt_message_array_const msgs, uint64_t count);
	110
	111	extern bt_message_iterator_can_seek_ns_from_origin_status
	112	bt_message_iterator_can_seek_ns_from_origin(
	113	bt_message_iterator *iterator,
	114	int64_t ns_from_origin, bt_bool *can_seek);
	115
	116	extern bt_message_iterator_can_seek_beginning_status
	117	bt_message_iterator_can_seek_beginning(
	118	bt_message_iterator *iterator,
	119	bt_bool *can_seek);
	120
	121	extern bt_message_iterator_seek_ns_from_origin_status
	122	bt_message_iterator_seek_ns_from_origin(
	123	bt_message_iterator *iterator,
	124	int64_t ns_from_origin);
	125
	126	extern bt_message_iterator_seek_beginning_status
	127	bt_message_iterator_seek_beginning(
	128	bt_message_iterator *iterator);
	129
	130	extern bt_bool
	131	bt_message_iterator_can_seek_forward(
	132	bt_message_iterator *iterator);
	133
134	extern void bt_message_iterator_get_ref(
135	const bt_message_iterator *message_iterator);
136
137	extern void bt_message_iterator_put_ref(
138	const bt_message_iterator *message_iterator);
139
140	#define BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
141	do { \
142	bt_message_iterator_put_ref(_var); \
143	(_var) = NULL; \
144	} while (0)
145
146	#define BT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
147	do { \
148	bt_message_iterator_put_ref(_var_dst); \
149	(_var_dst) = (_var_src); \
150	(_var_src) = NULL; \
151	} while (0)
152
d24d5663 PP	153	#ifdef __cplusplus
	154	}
	155	#endif
	156
924dc299	157	#endif /* BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H */