[babeltrace.git] / include / babeltrace / trace-ir / packet-const.h

#ifndef BABELTRACE_TRACE_IR_PACKET_CONST_H
#define BABELTRACE_TRACE_IR_PACKET_CONST_H

/*
 * Copyright 2016-2018 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include <stdint.h>

/* For enum bt_property_availability */
#include <babeltrace/property.h>

/* For enum bt_clock_snapshot_state */
#include <babeltrace/trace-ir/clock-snapshot-const.h>

/*
 * For bt_packet, bt_packet_header_field, bt_packet_context_field,
 * bt_stream, bt_clock_snapshot
 */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

enum bt_packet_status {
	BT_PACKET_STATUS_OK = 0,
	BT_PACKET_STATUS_NOMEM = -12,
};

extern const bt_stream *bt_packet_borrow_stream_const(
		const bt_packet *packet);

extern
const bt_field *bt_packet_borrow_header_field_const(
		const bt_packet *packet);

extern
const bt_field *bt_packet_borrow_context_field_const(
		const bt_packet *packet);

extern
enum bt_clock_snapshot_state
bt_packet_borrow_default_beginning_clock_snapshot_const(
		const bt_packet *packet,
		const bt_clock_snapshot **clock_snapshot);

extern
enum bt_clock_snapshot_state bt_packet_borrow_default_end_clock_snapshot_const(
		const bt_packet *packet,
		const bt_clock_snapshot **clock_snapshot);

extern
enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
		const bt_packet *packet, uint64_t *value);

extern
enum bt_property_availability bt_packet_get_packet_counter_snapshot(
		const bt_packet *packet, uint64_t *value);

extern void bt_packet_get_ref(const bt_packet *packet);

extern void bt_packet_put_ref(const bt_packet *packet);

#define BT_PACKET_PUT_REF_AND_RESET(_var)		\
	do {						\
		bt_packet_put_ref(_var);		\
		(_var) = NULL;				\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_TRACE_IR_PACKET_CONST_H */
Commit	Line	Data
40f4ba76 PP	1	#ifndef BABELTRACE_TRACE_IR_PACKET_CONST_H
	2	#define BABELTRACE_TRACE_IR_PACKET_CONST_H
	3
	4	/*
e2f7325d	5	* Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
40f4ba76 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	* The Common Trace Format (CTF) Specification is available at
	26	* http://www.efficios.com/ctf
	27	*/
	28
	29	#include <stdint.h>
	30
	31	/* For enum bt_property_availability */
	32	#include <babeltrace/property.h>
	33
dc68f16d	34	/* For enum bt_clock_snapshot_state */
605e1019	35	#include <babeltrace/trace-ir/clock-snapshot-const.h>
40f4ba76	36
b19ff26f PP	37	/*
b19ff26f PP	38	* For bt_packet, bt_packet_header_field, bt_packet_context_field,
605e1019	39	* bt_stream, bt_clock_snapshot
b19ff26f PP	40	*/
	41	#include <babeltrace/types.h>
	42
40f4ba76 PP	43	#ifdef __cplusplus
	44	extern "C" {
	45	#endif
	46
b029fcf8 PP	47	enum bt_packet_status {
	48	BT_PACKET_STATUS_OK = 0,
	49	BT_PACKET_STATUS_NOMEM = -12,
	50	};
	51
b19ff26f PP	52	extern const bt_stream *bt_packet_borrow_stream_const(
b19ff26f PP	53	const bt_packet *packet);
40f4ba76 PP	54
40f4ba76 PP	55	extern
b19ff26f PP	56	const bt_field *bt_packet_borrow_header_field_const(
b19ff26f PP	57	const bt_packet *packet);
40f4ba76 PP	58
40f4ba76 PP	59	extern
b19ff26f PP	60	const bt_field *bt_packet_borrow_context_field_const(
b19ff26f PP	61	const bt_packet *packet);
40f4ba76 PP	62
40f4ba76 PP	63	extern
dc68f16d PP	64	enum bt_clock_snapshot_state
dc68f16d PP	65	bt_packet_borrow_default_beginning_clock_snapshot_const(
b19ff26f	66	const bt_packet *packet,
605e1019	67	const bt_clock_snapshot **clock_snapshot);
40f4ba76 PP	68
40f4ba76 PP	69	extern
dc68f16d	70	enum bt_clock_snapshot_state bt_packet_borrow_default_end_clock_snapshot_const(
b19ff26f	71	const bt_packet *packet,
605e1019	72	const bt_clock_snapshot **clock_snapshot);
40f4ba76 PP	73
	74	extern
	75	enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
b19ff26f	76	const bt_packet packet, uint64_t value);
40f4ba76 PP	77
	78	extern
	79	enum bt_property_availability bt_packet_get_packet_counter_snapshot(
b19ff26f	80	const bt_packet packet, uint64_t value);
40f4ba76	81
b19ff26f	82	extern void bt_packet_get_ref(const bt_packet *packet);
c5b9b441	83
b19ff26f	84	extern void bt_packet_put_ref(const bt_packet *packet);
c5b9b441 PP	85
	86	#define BT_PACKET_PUT_REF_AND_RESET(_var) \
	87	do { \
	88	bt_packet_put_ref(_var); \
	89	(_var) = NULL; \
	90	} while (0)
	91
	92	#define BT_PACKET_MOVE_REF(_var_dst, _var_src) \
	93	do { \
	94	bt_packet_put_ref(_var_dst); \
	95	(_var_dst) = (_var_src); \
	96	(_var_src) = NULL; \
	97	} while (0)
	98
40f4ba76 PP	99	#ifdef __cplusplus
	100	}
	101	#endif
	102
	103	#endif /* BABELTRACE_TRACE_IR_PACKET_CONST_H */