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

#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H
#define BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2013, 2014 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include <stdint.h>

/* For bt_bool, bt_uuid, bt_clock_class */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum bt_clock_class_status {
	BT_CLOCK_CLASS_STATUS_OK = 0,
	BT_CLOCK_CLASS_STATUS_NOMEM = -12,
	BT_CLOCK_CLASS_STATUS_OVERFLOW = -75,
} bt_clock_class_status;

extern const char *bt_clock_class_get_name(
		const bt_clock_class *clock_class);

extern const char *bt_clock_class_get_description(
		const bt_clock_class *clock_class);

extern uint64_t bt_clock_class_get_frequency(
		const bt_clock_class *clock_class);

extern uint64_t bt_clock_class_get_precision(
		const bt_clock_class *clock_class);

extern void bt_clock_class_get_offset(const bt_clock_class *clock_class,
		int64_t *seconds, uint64_t *cycles);

extern bt_bool bt_clock_class_origin_is_unix_epoch(
		const bt_clock_class *clock_class);

extern bt_uuid bt_clock_class_get_uuid(
		const bt_clock_class *clock_class);

extern bt_clock_class_status bt_clock_class_cycles_to_ns_from_origin(
		const bt_clock_class *clock_class,
		uint64_t cycles, int64_t *ns_from_origin);

extern void bt_clock_class_get_ref(const bt_clock_class *clock_class);

extern void bt_clock_class_put_ref(const bt_clock_class *clock_class);

#define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var)		\
	do {						\
		bt_clock_class_put_ref(_var);		\
		(_var) = NULL;				\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H */
Commit	Line	Data
40f4ba76 PP	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H
40f4ba76 PP	2	#define BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H
c057dea0 PP	3
c057dea0 PP	4	/*
40f4ba76	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
e2f7325d	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c057dea0 PP	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	* The Common Trace Format (CTF) Specification is available at
	27	* http://www.efficios.com/ctf
	28	*/
	29
	30	#include <stdint.h>
c057dea0	31
b19ff26f	32	/* For bt_bool, bt_uuid, bt_clock_class */
40f4ba76 PP	33	#include <babeltrace/types.h>
40f4ba76 PP	34
c057dea0 PP	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
4cdfc5e8	39	typedef enum bt_clock_class_status {
8c41fd73 PP	40	BT_CLOCK_CLASS_STATUS_OK = 0,
	41	BT_CLOCK_CLASS_STATUS_NOMEM = -12,
	42	BT_CLOCK_CLASS_STATUS_OVERFLOW = -75,
4cdfc5e8	43	} bt_clock_class_status;
8c41fd73	44
40f4ba76	45	extern const char *bt_clock_class_get_name(
b19ff26f	46	const bt_clock_class *clock_class);
40f4ba76 PP	47
40f4ba76 PP	48	extern const char *bt_clock_class_get_description(
b19ff26f	49	const bt_clock_class *clock_class);
40f4ba76 PP	50
40f4ba76 PP	51	extern uint64_t bt_clock_class_get_frequency(
b19ff26f	52	const bt_clock_class *clock_class);
40f4ba76 PP	53
40f4ba76 PP	54	extern uint64_t bt_clock_class_get_precision(
b19ff26f	55	const bt_clock_class *clock_class);
40f4ba76	56
b19ff26f	57	extern void bt_clock_class_get_offset(const bt_clock_class *clock_class,
40f4ba76	58	int64_t seconds, uint64_t cycles);
44c440bc	59
5552377a	60	extern bt_bool bt_clock_class_origin_is_unix_epoch(
b19ff26f	61	const bt_clock_class *clock_class);
094ff7c0	62
40f4ba76	63	extern bt_uuid bt_clock_class_get_uuid(
b19ff26f	64	const bt_clock_class *clock_class);
094ff7c0	65
4cdfc5e8	66	extern bt_clock_class_status bt_clock_class_cycles_to_ns_from_origin(
b19ff26f	67	const bt_clock_class *clock_class,
40f4ba76	68	uint64_t cycles, int64_t *ns_from_origin);
c057dea0	69
b19ff26f	70	extern void bt_clock_class_get_ref(const bt_clock_class *clock_class);
c5b9b441	71
b19ff26f	72	extern void bt_clock_class_put_ref(const bt_clock_class *clock_class);
c5b9b441 PP	73
	74	#define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var) \
	75	do { \
	76	bt_clock_class_put_ref(_var); \
	77	(_var) = NULL; \
	78	} while (0)
	79
	80	#define BT_CLOCK_CLASS_MOVE_REF(_var_dst, _var_src) \
	81	do { \
	82	bt_clock_class_put_ref(_var_dst); \
	83	(_var_dst) = (_var_src); \
	84	(_var_src) = NULL; \
	85	} while (0)
	86
c057dea0 PP	87	#ifdef __cplusplus
	88	}
	89	#endif
	90
40f4ba76	91	#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H */