[babeltrace.git] / plugins / ctf / common / notif-iter / notif-iter.h

#ifndef CTF_NOTIF_ITER_H
#define CTF_NOTIF_ITER_H

/*
 * Babeltrace - CTF notification iterator
 *                  ¯¯¯¯¯        ¯¯¯¯
 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2015-2016 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 <stdint.h>
#include <stdio.h>
#include <stddef.h>
#include <babeltrace/babeltrace.h>
#include <babeltrace/babeltrace-internal.h>

/**
 * @file ctf-notif-iter.h
 *
 * CTF notification iterator
 *     ¯¯¯¯¯        ¯¯¯¯
 * This is a common internal API used by CTF source plugins. It allows
 * one to get notifications from a user-provided medium.
 */

/**
 * Medium operations status codes.
 */
enum bt_notif_iter_medium_status {
	/**
	 * End of file.
	 *
	 * The medium function called by the notification iterator
	 * function reached the end of the file.
	 */
	BT_NOTIF_ITER_MEDIUM_STATUS_EOF = 1,

	/**
	 * There is no data available right now, try again later.
	 */
	BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN = 11,

	/** Unsupported operation. */
	BT_NOTIF_ITER_MEDIUM_STATUS_UNSUPPORTED = -3,

	/** Invalid argument. */
	BT_NOTIF_ITER_MEDIUM_STATUS_INVAL = -2,

	/** General error. */
	BT_NOTIF_ITER_MEDIUM_STATUS_ERROR = -1,

	/** Everything okay. */
	BT_NOTIF_ITER_MEDIUM_STATUS_OK = 0,
};

/**
 * CTF notification iterator API status code.
 */
enum bt_notif_iter_status {
	/**
	 * End of file.
	 *
	 * The medium function called by the notification iterator
	 * function reached the end of the file.
	 */
	BT_NOTIF_ITER_STATUS_EOF = BT_NOTIF_ITER_MEDIUM_STATUS_EOF,

	/**
	 * There is no data available right now, try again later.
	 *
	 * Some condition resulted in the
	 * bt_notif_iter_medium_ops::request_bytes() user function not
	 * having access to any data now. You should retry calling the
	 * last called notification iterator function once the situation
	 * is resolved.
	 */
	BT_NOTIF_ITER_STATUS_AGAIN = BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN,

	/** Invalid argument. */
	BT_NOTIF_ITER_STATUS_INVAL = BT_NOTIF_ITER_MEDIUM_STATUS_INVAL,

	/** Unsupported operation. */
	BT_NOTIF_ITER_STATUS_UNSUPPORTED = BT_NOTIF_ITER_MEDIUM_STATUS_UNSUPPORTED,

	/** General error. */
	BT_NOTIF_ITER_STATUS_ERROR = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR,

	/** Everything okay. */
	BT_NOTIF_ITER_STATUS_OK =	0,
};

/**
 * CTF notification iterator seek operation directives.
 */
enum bt_notif_iter_seek_whence {
	/**
	 * Set the iterator's position to an absolute offset in the underlying
	 * medium.
	 */
	BT_NOTIF_ITER_SEEK_WHENCE_SET,
};

/**
 * Medium operations.
 *
 * Those user functions are called by the notification iterator
 * functions to request medium actions.
 */
struct bt_notif_iter_medium_ops {
	/**
	 * Returns the next byte buffer to be used by the binary file
	 * reader to deserialize binary data.
	 *
	 * This function \em must be defined.
	 *
	 * The purpose of this function is to return a buffer of bytes
	 * to the notification iterator, of a maximum of \p request_sz
	 * bytes. If this function cannot return a buffer of at least
	 * \p request_sz bytes, it may return a smaller buffer. In
	 * either cases, \p buffer_sz must be set to the returned buffer
	 * size (in bytes).
	 *
	 * The returned buffer's ownership remains the medium, in that
	 * it won't be freed by the notification iterator functions. The
	 * returned buffer won't be modified by the notification
	 * iterator functions either.
	 *
	 * When this function is called for the first time for a given
	 * file, the offset within the file is considered to be 0. The
	 * next times this function is called, the returned buffer's
	 * byte offset within the complete file must be the previous
	 * offset plus the last returned value of \p buffer_sz by this
	 * medium.
	 *
	 * This function must return one of the following statuses:
	 *
	 *   - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_OK</b>: Everything
	 *     is okay, i.e. \p buffer_sz is set to a positive value
	 *     reflecting the number of available bytes in the buffer
	 *     starting at the address written in \p buffer_addr.
	 *   - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN</b>: No data is
	 *     available right now. In this case, the notification
	 *     iterator function called by the user returns
	 *     #BT_NOTIF_ITER_STATUS_AGAIN, and it is the user's
	 *     responsibility to make sure enough data becomes available
	 *     before calling the \em same notification iterator
	 *     function again to continue the decoding process.
	 *   - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_EOF</b>: The end of
	 *     the file was reached, and no more data will ever be
	 *     available for this file. In this case, the notification
	 *     iterator function called by the user returns
	 *     #BT_NOTIF_ITER_STATUS_EOF. This must \em not be
	 *     returned when returning at least one byte of data to the
	 *     caller, i.e. this must be returned when there's
	 *     absolutely nothing left; should the request size be
	 *     larger than what's left in the file, this function must
	 *     return what's left, setting \p buffer_sz to the number of
	 *     remaining bytes, and return
	 *     #BT_NOTIF_ITER_MEDIUM_STATUS_EOF on the \em following
	 *     call.
	 *   - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_ERROR</b>: A fatal
	 *     error occured during this operation. In this case, the
	 *     notification iterator function called by the user returns
	 *     #BT_NOTIF_ITER_STATUS_ERROR.
	 *
	 * If #BT_NOTIF_ITER_MEDIUM_STATUS_OK is not returned, the
	 * values of \p buffer_sz and \p buffer_addr are \em ignored by
	 * the caller.
	 *
	 * @param request_sz	Requested buffer size (bytes)
	 * @param buffer_addr	Returned buffer address
	 * @param buffer_sz	Returned buffer's size (bytes)
	 * @param data		User data
	 * @returns		Status code (see description above)
	 */
	enum bt_notif_iter_medium_status (* request_bytes)(
			size_t request_sz, uint8_t **buffer_addr,
			size_t *buffer_sz, void *data);

	/**
	 * Repositions the underlying stream's position.
	 *
	 * This *optional* method repositions the underlying stream
	 * to a given absolute or relative position, as indicated by
	 * the whence directive.
	 *
	 * @param whence	One of #bt_notif_iter_seek_whence values
	 * @param offset	Offset to use for the given directive
	 * @param data		User data
	 * @returns		One of #bt_notif_iter_medium_status values
	 */
	enum bt_notif_iter_medium_status (* seek)(
			enum bt_notif_iter_seek_whence whence,
			off_t offset, void *data);

	/**
	 * Returns a stream instance (weak reference) for the given
	 * stream class.
	 *
	 * This is called after a packet header is read, and the
	 * corresponding stream class is found by the notification
	 * iterator.
	 *
	 * @param stream_class	Stream class of the stream to get
	 * @param stream_id	Stream (instance) ID of the stream
	 *			to get (-1ULL if not available)
	 * @param data		User data
	 * @returns		Stream instance (weak reference) or
	 *			\c NULL on error
	 */
	struct bt_stream * (* borrow_stream)(
			struct bt_stream_class *stream_class,
			uint64_t stream_id, void *data);
};

/** CTF notification iterator. */
struct bt_notif_iter;

// TODO: Replace by the real thing
enum bt_notif_iter_notif_type {
	BT_NOTIF_ITER_NOTIF_NEW_PACKET,
	BT_NOTIF_ITER_NOTIF_END_OF_PACKET,
	BT_NOTIF_ITER_NOTIF_EVENT,
};

struct bt_notif_iter_notif {
	enum bt_notif_iter_notif_type type;
};

struct bt_notif_iter_notif_new_packet {
	struct bt_notif_iter_notif base;
	struct bt_packet *packet;
};

struct bt_notif_iter_notif_end_of_packet {
	struct bt_notif_iter_notif base;
	struct bt_packet *packet;
};

struct bt_notif_iter_notif_event {
	struct bt_notif_iter_notif base;
	struct bt_event *event;
};

/**
 * Creates a CTF notification iterator.
 *
 * Upon successful completion, the reference count of \p trace is
 * incremented.
 *
 * @param trace			Trace to read
 * @param max_request_sz	Maximum buffer size, in bytes, to
 *				request to
 *				bt_notif_iter_medium_ops::request_bytes()
 * 				at a time
 * @param medops		Medium operations
 * @param medops_data		User data (passed to medium operations)
 * @returns			New CTF notification iterator on
 *				success, or \c NULL on error
 */
BT_HIDDEN
struct bt_notif_iter *bt_notif_iter_create(struct bt_trace *trace,
	size_t max_request_sz, struct bt_notif_iter_medium_ops medops,
	void *medops_data);

/**
 * Destroys a CTF notification iterator, freeing all internal resources.
 *
 * The registered trace's reference count is decremented.
 *
 * @param notif_iter		CTF notification iterator
 */
BT_HIDDEN
void bt_notif_iter_destroy(struct bt_notif_iter *notif_iter);

/**
 * Returns the next notification from a CTF notification iterator.
 *
 * Upon successful completion, #BT_NOTIF_ITER_STATUS_OK is
 * returned, and the next notification is written to \p notif.
 * In this case, the caller is responsible for calling
 * bt_notification_put() on the returned notification.
 *
 * If this function returns #BT_NOTIF_ITER_STATUS_AGAIN, the caller
 * should make sure that data becomes available to its medium, and
 * call this function again, until another status is returned.
 *
 * @param notif_iter		CTF notification iterator
 * @param notification		Returned notification if the function's
 *				return value is #BT_NOTIF_ITER_STATUS_OK
 * @returns			One of #bt_notif_iter_status values
 */
BT_HIDDEN
enum bt_notif_iter_status bt_notif_iter_get_next_notification(
		struct bt_notif_iter *notit,
		struct bt_private_connection_private_notification_iterator *notif_iter,
		struct bt_notification **notification);

/**
 * Returns the first packet header and context fields. This function
 * never needs to call the `borrow_stream()` medium operation because
 * it does not create packet or event objects.
 *
 * @param notif_iter		CTF notification iterator
 * @param packet_header_field	Packet header field (\c NULL if there's
 *				no packet header field)
 * @param packet_context_field	Packet context field (\c NULL if there's
 *				no packet context field)
 * @returns			One of #bt_notif_iter_status values
 */
BT_HIDDEN
enum bt_notif_iter_status bt_notif_iter_borrow_packet_header_context_fields(
		struct bt_notif_iter *notit,
		struct bt_field **packet_header_field,
		struct bt_field **packet_context_field);

BT_HIDDEN
void bt_notif_iter_set_medops_data(struct bt_notif_iter *notit,
		void *medops_data);

BT_HIDDEN
enum bt_notif_iter_status bt_notif_iter_seek(
		struct bt_notif_iter *notit, off_t offset);

/*
 * Get the current packet's offset in bytes relative to the media's initial
 * position.
 */
BT_HIDDEN
off_t bt_notif_iter_get_current_packet_offset(
		struct bt_notif_iter *notit);

/* Get the current packet's size (in bits). */
BT_HIDDEN
off_t bt_notif_iter_get_current_packet_size(
		struct bt_notif_iter *notit);

/*
 * Resets the iterator so that the next requested medium bytes are
 * assumed to be the first bytes of a new stream. The first notification
 * which this iterator emits after calling bt_notif_iter_reset() is a
 * BT_NOTIFICATION_TYPE_STREAM_BEGIN one.
 */
BT_HIDDEN
void bt_notif_iter_reset(struct bt_notif_iter *notit);

static inline
const char *bt_notif_iter_medium_status_string(
		enum bt_notif_iter_medium_status status)
{
	switch (status) {
	case BT_NOTIF_ITER_MEDIUM_STATUS_EOF:
		return "BT_NOTIF_ITER_MEDIUM_STATUS_EOF";
	case BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN:
		return "BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN";
	case BT_NOTIF_ITER_MEDIUM_STATUS_INVAL:
		return "BT_NOTIF_ITER_MEDIUM_STATUS_INVAL";
	case BT_NOTIF_ITER_MEDIUM_STATUS_ERROR:
		return "BT_NOTIF_ITER_MEDIUM_STATUS_ERROR";
	case BT_NOTIF_ITER_MEDIUM_STATUS_OK:
		return "BT_NOTIF_ITER_MEDIUM_STATUS_OK";
	default:
		return "(unknown)";
	}
}

static inline
const char *bt_notif_iter_status_string(
		enum bt_notif_iter_status status)
{
	switch (status) {
	case BT_NOTIF_ITER_STATUS_EOF:
		return "BT_NOTIF_ITER_STATUS_EOF";
	case BT_NOTIF_ITER_STATUS_AGAIN:
		return "BT_NOTIF_ITER_STATUS_AGAIN";
	case BT_NOTIF_ITER_STATUS_INVAL:
		return "BT_NOTIF_ITER_STATUS_INVAL";
	case BT_NOTIF_ITER_STATUS_ERROR:
		return "BT_NOTIF_ITER_STATUS_ERROR";
	case BT_NOTIF_ITER_STATUS_OK:
		return "BT_NOTIF_ITER_STATUS_OK";
	default:
		return "(unknown)";
	}
}

#endif /* CTF_NOTIF_ITER_H */
Commit	Line	Data
e98a2d6e PP	1	#ifndef CTF_NOTIF_ITER_H
	2	#define CTF_NOTIF_ITER_H
	3
	4	/*
	5	* Babeltrace - CTF notification iterator
	6	* ¯¯¯¯¯ ¯¯¯¯
	7	* Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
	8	* Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
	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 <stdint.h>
	30	#include <stdio.h>
	31	#include <stddef.h>
e0831b38	32	#include <babeltrace/babeltrace.h>
e98a2d6e PP	33	#include <babeltrace/babeltrace-internal.h>
	34
	35	/**
	36	* @file ctf-notif-iter.h
	37	*
	38	* CTF notification iterator
	39	* ¯¯¯¯¯ ¯¯¯¯
	40	* This is a common internal API used by CTF source plugins. It allows
	41	* one to get notifications from a user-provided medium.
	42	*/
	43
	44	/**
	45	* Medium operations status codes.
	46	*/
839d52a5	47	enum bt_notif_iter_medium_status {
e98a2d6e PP	48	/**
	49	* End of file.
	50	*
	51	* The medium function called by the notification iterator
	52	* function reached the end of the file.
	53	*/
839d52a5	54	BT_NOTIF_ITER_MEDIUM_STATUS_EOF = 1,
e98a2d6e PP	55
	56	/**
	57	* There is no data available right now, try again later.
	58	*/
839d52a5	59	BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN = 11,
bb230c9b JG	60
bb230c9b JG	61	/** Unsupported operation. */
839d52a5	62	BT_NOTIF_ITER_MEDIUM_STATUS_UNSUPPORTED = -3,
e98a2d6e PP	63
e98a2d6e PP	64	/** Invalid argument. */
839d52a5	65	BT_NOTIF_ITER_MEDIUM_STATUS_INVAL = -2,
e98a2d6e PP	66
e98a2d6e PP	67	/** General error. */
839d52a5	68	BT_NOTIF_ITER_MEDIUM_STATUS_ERROR = -1,
e98a2d6e PP	69
e98a2d6e PP	70	/** Everything okay. */
839d52a5	71	BT_NOTIF_ITER_MEDIUM_STATUS_OK = 0,
e98a2d6e PP	72	};
	73
	74	/**
	75	* CTF notification iterator API status code.
	76	*/
839d52a5	77	enum bt_notif_iter_status {
e98a2d6e PP	78	/**
	79	* End of file.
	80	*
	81	* The medium function called by the notification iterator
	82	* function reached the end of the file.
	83	*/
839d52a5	84	BT_NOTIF_ITER_STATUS_EOF = BT_NOTIF_ITER_MEDIUM_STATUS_EOF,
e98a2d6e PP	85
	86	/**
	87	* There is no data available right now, try again later.
	88	*
	89	* Some condition resulted in the
839d52a5	90	* bt_notif_iter_medium_ops::request_bytes() user function not
e98a2d6e PP	91	* having access to any data now. You should retry calling the
	92	* last called notification iterator function once the situation
	93	* is resolved.
	94	*/
839d52a5	95	BT_NOTIF_ITER_STATUS_AGAIN = BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN,
e98a2d6e PP	96
e98a2d6e PP	97	/** Invalid argument. */
839d52a5	98	BT_NOTIF_ITER_STATUS_INVAL = BT_NOTIF_ITER_MEDIUM_STATUS_INVAL,
e98a2d6e	99
bb230c9b	100	/** Unsupported operation. */
839d52a5	101	BT_NOTIF_ITER_STATUS_UNSUPPORTED = BT_NOTIF_ITER_MEDIUM_STATUS_UNSUPPORTED,
bb230c9b	102
e98a2d6e	103	/** General error. */
839d52a5	104	BT_NOTIF_ITER_STATUS_ERROR = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR,
e98a2d6e PP	105
e98a2d6e PP	106	/** Everything okay. */
839d52a5	107	BT_NOTIF_ITER_STATUS_OK = 0,
e98a2d6e PP	108	};
e98a2d6e PP	109
bb230c9b JG	110	/**
	111	* CTF notification iterator seek operation directives.
	112	*/
839d52a5	113	enum bt_notif_iter_seek_whence {
bb230c9b JG	114	/**
	115	* Set the iterator's position to an absolute offset in the underlying
	116	* medium.
	117	*/
839d52a5	118	BT_NOTIF_ITER_SEEK_WHENCE_SET,
bb230c9b JG	119	};
bb230c9b JG	120
e98a2d6e PP	121	/**
	122	* Medium operations.
	123	*
	124	* Those user functions are called by the notification iterator
	125	* functions to request medium actions.
	126	*/
839d52a5	127	struct bt_notif_iter_medium_ops {
e98a2d6e PP	128	/**
	129	* Returns the next byte buffer to be used by the binary file
	130	* reader to deserialize binary data.
	131	*
	132	* This function \em must be defined.
	133	*
	134	* The purpose of this function is to return a buffer of bytes
	135	* to the notification iterator, of a maximum of \p request_sz
	136	* bytes. If this function cannot return a buffer of at least
	137	* \p request_sz bytes, it may return a smaller buffer. In
	138	* either cases, \p buffer_sz must be set to the returned buffer
	139	* size (in bytes).
	140	*
	141	* The returned buffer's ownership remains the medium, in that
	142	* it won't be freed by the notification iterator functions. The
	143	* returned buffer won't be modified by the notification
	144	* iterator functions either.
	145	*
	146	* When this function is called for the first time for a given
	147	* file, the offset within the file is considered to be 0. The
	148	* next times this function is called, the returned buffer's
	149	* byte offset within the complete file must be the previous
	150	* offset plus the last returned value of \p buffer_sz by this
	151	* medium.
	152	*
	153	* This function must return one of the following statuses:
	154	*
839d52a5	155	* - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_OK</b>: Everything
e98a2d6e PP	156	* is okay, i.e. \p buffer_sz is set to a positive value
	157	* reflecting the number of available bytes in the buffer
	158	* starting at the address written in \p buffer_addr.
839d52a5	159	* - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN</b>: No data is
e98a2d6e PP	160	* available right now. In this case, the notification
e98a2d6e PP	161	* iterator function called by the user returns
839d52a5	162	* #BT_NOTIF_ITER_STATUS_AGAIN, and it is the user's
e98a2d6e PP	163	* responsibility to make sure enough data becomes available
	164	* before calling the \em same notification iterator
	165	* function again to continue the decoding process.
839d52a5	166	* - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_EOF</b>: The end of
e98a2d6e PP	167	* the file was reached, and no more data will ever be
	168	* available for this file. In this case, the notification
	169	* iterator function called by the user returns
839d52a5	170	* #BT_NOTIF_ITER_STATUS_EOF. This must \em not be
e98a2d6e PP	171	* returned when returning at least one byte of data to the
	172	* caller, i.e. this must be returned when there's
	173	* absolutely nothing left; should the request size be
	174	* larger than what's left in the file, this function must
	175	* return what's left, setting \p buffer_sz to the number of
	176	* remaining bytes, and return
839d52a5	177	* #BT_NOTIF_ITER_MEDIUM_STATUS_EOF on the \em following
e98a2d6e	178	* call.
839d52a5	179	* - <b>#BT_NOTIF_ITER_MEDIUM_STATUS_ERROR</b>: A fatal
e98a2d6e PP	180	* error occured during this operation. In this case, the
e98a2d6e PP	181	* notification iterator function called by the user returns
839d52a5	182	* #BT_NOTIF_ITER_STATUS_ERROR.
e98a2d6e	183	*
839d52a5	184	* If #BT_NOTIF_ITER_MEDIUM_STATUS_OK is not returned, the
e98a2d6e PP	185	* values of \p buffer_sz and \p buffer_addr are \em ignored by
	186	* the caller.
	187	*
	188	* @param request_sz Requested buffer size (bytes)
	189	* @param buffer_addr Returned buffer address
	190	* @param buffer_sz Returned buffer's size (bytes)
	191	* @param data User data
	192	* @returns Status code (see description above)
	193	*/
839d52a5	194	enum bt_notif_iter_medium_status (* request_bytes)(
e98a2d6e PP	195	size_t request_sz, uint8_t **buffer_addr,
	196	size_t buffer_sz, void data);
	197
bb230c9b JG	198	/**
	199	* Repositions the underlying stream's position.
	200	*
	201	* This optional method repositions the underlying stream
	202	* to a given absolute or relative position, as indicated by
	203	* the whence directive.
	204	*
839d52a5	205	* @param whence One of #bt_notif_iter_seek_whence values
bb230c9b JG	206	* @param offset Offset to use for the given directive
bb230c9b JG	207	* @param data User data
839d52a5	208	* @returns One of #bt_notif_iter_medium_status values
bb230c9b	209	*/
839d52a5 PP	210	enum bt_notif_iter_medium_status (* seek)(
839d52a5 PP	211	enum bt_notif_iter_seek_whence whence,
bb230c9b JG	212	off_t offset, void *data);
bb230c9b JG	213
e98a2d6e PP	214	/**
	215	* Returns a stream instance (weak reference) for the given
	216	* stream class.
	217	*
	218	* This is called after a packet header is read, and the
	219	* corresponding stream class is found by the notification
	220	* iterator.
	221	*
0659c536 PP	222	* @param stream_class Stream class of the stream to get
	223	* @param stream_id Stream (instance) ID of the stream
	224	* to get (-1ULL if not available)
e98a2d6e PP	225	* @param data User data
	226	* @returns Stream instance (weak reference) or
	227	* \c NULL on error
	228	*/
a6918753	229	struct bt_stream * (* borrow_stream)(
839d52a5	230	struct bt_stream_class *stream_class,
0659c536	231	uint64_t stream_id, void *data);
e98a2d6e PP	232	};
	233
	234	/** CTF notification iterator. */
839d52a5	235	struct bt_notif_iter;
e98a2d6e PP	236
e98a2d6e PP	237	// TODO: Replace by the real thing
839d52a5 PP	238	enum bt_notif_iter_notif_type {
	239	BT_NOTIF_ITER_NOTIF_NEW_PACKET,
	240	BT_NOTIF_ITER_NOTIF_END_OF_PACKET,
	241	BT_NOTIF_ITER_NOTIF_EVENT,
e98a2d6e PP	242	};
e98a2d6e PP	243
839d52a5 PP	244	struct bt_notif_iter_notif {
839d52a5 PP	245	enum bt_notif_iter_notif_type type;
e98a2d6e PP	246	};
e98a2d6e PP	247
839d52a5 PP	248	struct bt_notif_iter_notif_new_packet {
	249	struct bt_notif_iter_notif base;
	250	struct bt_packet *packet;
e98a2d6e PP	251	};
e98a2d6e PP	252
839d52a5 PP	253	struct bt_notif_iter_notif_end_of_packet {
	254	struct bt_notif_iter_notif base;
	255	struct bt_packet *packet;
e98a2d6e PP	256	};
e98a2d6e PP	257
839d52a5 PP	258	struct bt_notif_iter_notif_event {
	259	struct bt_notif_iter_notif base;
	260	struct bt_event *event;
e98a2d6e PP	261	};
e98a2d6e PP	262
e98a2d6e PP	263	/**
	264	* Creates a CTF notification iterator.
	265	*
	266	* Upon successful completion, the reference count of \p trace is
	267	* incremented.
	268	*
	269	* @param trace Trace to read
	270	* @param max_request_sz Maximum buffer size, in bytes, to
	271	* request to
839d52a5	272	* bt_notif_iter_medium_ops::request_bytes()
e98a2d6e PP	273	* at a time
	274	* @param medops Medium operations
	275	* @param medops_data User data (passed to medium operations)
e98a2d6e PP	276	* @returns New CTF notification iterator on
	277	* success, or \c NULL on error
	278	*/
2cf1d51e	279	BT_HIDDEN
839d52a5 PP	280	struct bt_notif_iter bt_notif_iter_create(struct bt_trace trace,
839d52a5 PP	281	size_t max_request_sz, struct bt_notif_iter_medium_ops medops,
55314f2a	282	void *medops_data);
e98a2d6e PP	283
	284	/**
	285	* Destroys a CTF notification iterator, freeing all internal resources.
	286	*
	287	* The registered trace's reference count is decremented.
	288	*
	289	* @param notif_iter CTF notification iterator
	290	*/
2cf1d51e	291	BT_HIDDEN
839d52a5	292	void bt_notif_iter_destroy(struct bt_notif_iter *notif_iter);
e98a2d6e	293
e98a2d6e PP	294	/**
	295	* Returns the next notification from a CTF notification iterator.
	296	*
839d52a5	297	* Upon successful completion, #BT_NOTIF_ITER_STATUS_OK is
e98a2d6e PP	298	* returned, and the next notification is written to \p notif.
	299	* In this case, the caller is responsible for calling
	300	* bt_notification_put() on the returned notification.
	301	*
839d52a5	302	* If this function returns #BT_NOTIF_ITER_STATUS_AGAIN, the caller
e98a2d6e PP	303	* should make sure that data becomes available to its medium, and
	304	* call this function again, until another status is returned.
	305	*
	306	* @param notif_iter CTF notification iterator
	307	* @param notification Returned notification if the function's
839d52a5 PP	308	* return value is #BT_NOTIF_ITER_STATUS_OK
839d52a5 PP	309	* @returns One of #bt_notif_iter_status values
e98a2d6e	310	*/
2cf1d51e	311	BT_HIDDEN
839d52a5 PP	312	enum bt_notif_iter_status bt_notif_iter_get_next_notification(
839d52a5 PP	313	struct bt_notif_iter *notit,
03e18d5d	314	struct bt_private_connection_private_notification_iterator *notif_iter,
78586d8a	315	struct bt_notification **notification);
e98a2d6e	316
87187cbf PP	317	/**
87187cbf PP	318	* Returns the first packet header and context fields. This function
a6918753	319	* never needs to call the `borrow_stream()` medium operation because
87187cbf PP	320	* it does not create packet or event objects.
	321	*
	322	* @param notif_iter CTF notification iterator
	323	* @param packet_header_field Packet header field (\c NULL if there's
	324	* no packet header field)
	325	* @param packet_context_field Packet context field (\c NULL if there's
	326	* no packet context field)
839d52a5	327	* @returns One of #bt_notif_iter_status values
87187cbf PP	328	*/
87187cbf PP	329	BT_HIDDEN
a6918753	330	enum bt_notif_iter_status bt_notif_iter_borrow_packet_header_context_fields(
839d52a5 PP	331	struct bt_notif_iter *notit,
	332	struct bt_field **packet_header_field,
	333	struct bt_field **packet_context_field);
87187cbf	334
55fa6491	335	BT_HIDDEN
839d52a5	336	void bt_notif_iter_set_medops_data(struct bt_notif_iter *notit,
55fa6491 PP	337	void *medops_data);
55fa6491 PP	338
bb230c9b	339	BT_HIDDEN
839d52a5 PP	340	enum bt_notif_iter_status bt_notif_iter_seek(
839d52a5 PP	341	struct bt_notif_iter *notit, off_t offset);
bb230c9b JG	342
	343	/*
	344	* Get the current packet's offset in bytes relative to the media's initial
	345	* position.
	346	*/
	347	BT_HIDDEN
839d52a5 PP	348	off_t bt_notif_iter_get_current_packet_offset(
839d52a5 PP	349	struct bt_notif_iter *notit);
bb230c9b JG	350
	351	/* Get the current packet's size (in bits). */
	352	BT_HIDDEN
839d52a5 PP	353	off_t bt_notif_iter_get_current_packet_size(
839d52a5 PP	354	struct bt_notif_iter *notit);
bb230c9b	355
6ff151ad PP	356	/*
	357	* Resets the iterator so that the next requested medium bytes are
	358	* assumed to be the first bytes of a new stream. The first notification
	359	* which this iterator emits after calling bt_notif_iter_reset() is a
	360	* BT_NOTIFICATION_TYPE_STREAM_BEGIN one.
	361	*/
	362	BT_HIDDEN
	363	void bt_notif_iter_reset(struct bt_notif_iter *notit);
	364
fdf0e7a0	365	static inline
839d52a5 PP	366	const char *bt_notif_iter_medium_status_string(
839d52a5 PP	367	enum bt_notif_iter_medium_status status)
fdf0e7a0 PP	368	{
fdf0e7a0 PP	369	switch (status) {
839d52a5 PP	370	case BT_NOTIF_ITER_MEDIUM_STATUS_EOF:
	371	return "BT_NOTIF_ITER_MEDIUM_STATUS_EOF";
	372	case BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN:
	373	return "BT_NOTIF_ITER_MEDIUM_STATUS_AGAIN";
	374	case BT_NOTIF_ITER_MEDIUM_STATUS_INVAL:
	375	return "BT_NOTIF_ITER_MEDIUM_STATUS_INVAL";
	376	case BT_NOTIF_ITER_MEDIUM_STATUS_ERROR:
	377	return "BT_NOTIF_ITER_MEDIUM_STATUS_ERROR";
	378	case BT_NOTIF_ITER_MEDIUM_STATUS_OK:
	379	return "BT_NOTIF_ITER_MEDIUM_STATUS_OK";
fdf0e7a0 PP	380	default:
	381	return "(unknown)";
	382	}
	383	}
	384
	385	static inline
839d52a5 PP	386	const char *bt_notif_iter_status_string(
839d52a5 PP	387	enum bt_notif_iter_status status)
fdf0e7a0 PP	388	{
fdf0e7a0 PP	389	switch (status) {
839d52a5 PP	390	case BT_NOTIF_ITER_STATUS_EOF:
	391	return "BT_NOTIF_ITER_STATUS_EOF";
	392	case BT_NOTIF_ITER_STATUS_AGAIN:
	393	return "BT_NOTIF_ITER_STATUS_AGAIN";
	394	case BT_NOTIF_ITER_STATUS_INVAL:
	395	return "BT_NOTIF_ITER_STATUS_INVAL";
	396	case BT_NOTIF_ITER_STATUS_ERROR:
	397	return "BT_NOTIF_ITER_STATUS_ERROR";
	398	case BT_NOTIF_ITER_STATUS_OK:
	399	return "BT_NOTIF_ITER_STATUS_OK";
fdf0e7a0 PP	400	default:
	401	return "(unknown)";
	402	}
	403	}
	404
e98a2d6e	405	#endif /* CTF_NOTIF_ITER_H */