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

#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H

/*
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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/trace-ir/clock-class.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-pool-internal.h>
#include <babeltrace/compat/uuid-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/property-internal.h>
#include <stdbool.h>
#include <stdint.h>
#include <glib.h>

struct bt_clock_class {
	struct bt_object base;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} name;

	struct {
		GString *str;

		/* NULL or `str->str` above */
		const char *value;
	} description;

	uint64_t frequency;
	uint64_t precision;
	int64_t offset_seconds;
	uint64_t offset_cycles;

	struct {
		uint8_t uuid[BABELTRACE_UUID_LEN];

		/* NULL or `uuid` above */
		bt_uuid value;
	} uuid;

	bool is_absolute;

	/*
	 * This is computed every time you call
	 * bt_clock_class_set_frequency() or
	 * bt_clock_class_set_offset(), as well as initially. It is the
	 * base offset in nanoseconds including both `offset_seconds`
	 * and `offset_cycles` above in the result. It is used to
	 * accelerate future calls to
	 * bt_clock_value_get_ns_from_origin() and
	 * bt_clock_class_cycles_to_ns_from_origin().
	 *
	 * `overflows` is true if the base offset cannot be computed
	 * because of an overflow.
	 */
	struct {
		int64_t value_ns;
		bool overflows;
	} base_offset;

	/* Pool of `struct bt_clock_value *` */
	struct bt_object_pool cv_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_clock_class_freeze(struct bt_clock_class *clock_class);

#ifdef BT_DEV_MODE
# define bt_clock_class_freeze		_bt_clock_class_freeze
#else
# define bt_clock_class_freeze(_cc)
#endif

BT_HIDDEN
bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);

#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
Commit	Line	Data
56e18c4c PP	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
56e18c4c PP	2	#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
de9dd397	5	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	6	*
	7	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
56e18c4c	28	#include <babeltrace/trace-ir/clock-class.h>
83509119	29	#include <babeltrace/object-internal.h>
273b65be	30	#include <babeltrace/babeltrace-internal.h>
312c056a	31	#include <babeltrace/object-pool-internal.h>
3d9990ac	32	#include <babeltrace/compat/uuid-internal.h>
c55a9f58	33	#include <babeltrace/types.h>
44c440bc	34	#include <babeltrace/property-internal.h>
036a7cac PP	35	#include <stdbool.h>
036a7cac PP	36	#include <stdint.h>
c55a9f58	37	#include <glib.h>
273b65be	38
50842bdc	39	struct bt_clock_class {
83509119	40	struct bt_object base;
44c440bc PP	41
	42	struct {
	43	GString *str;
	44
	45	/* NULL or `str->str` above */
	46	const char *value;
	47	} name;
	48
	49	struct {
	50	GString *str;
	51
	52	/* NULL or `str->str` above */
	53	const char *value;
	54	} description;
	55
273b65be JG	56	uint64_t frequency;
273b65be JG	57	uint64_t precision;
44c440bc PP	58	int64_t offset_seconds;
	59	uint64_t offset_cycles;
	60
	61	struct {
	62	uint8_t uuid[BABELTRACE_UUID_LEN];
	63
	64	/* NULL or `uuid` above */
	65	bt_uuid value;
	66	} uuid;
	67
	68	bool is_absolute;
cfeb617e	69
273b65be	70	/*
44c440bc PP	71	* This is computed every time you call
	72	* bt_clock_class_set_frequency() or
	73	* bt_clock_class_set_offset(), as well as initially. It is the
	74	* base offset in nanoseconds including both `offset_seconds`
	75	* and `offset_cycles` above in the result. It is used to
	76	* accelerate future calls to
	77	* bt_clock_value_get_ns_from_origin() and
	78	* bt_clock_class_cycles_to_ns_from_origin().
	79	*
	80	* `overflows` is true if the base offset cannot be computed
	81	* because of an overflow.
273b65be	82	*/
44c440bc PP	83	struct {
	84	int64_t value_ns;
	85	bool overflows;
	86	} base_offset;
312c056a PP	87
	88	/* Pool of `struct bt_clock_value ` /
	89	struct bt_object_pool cv_pool;
44c440bc PP	90
44c440bc PP	91	bool frozen;
273b65be JG	92	};
	93
	94	BT_HIDDEN
44c440bc	95	void _bt_clock_class_freeze(struct bt_clock_class *clock_class);
273b65be	96
44c440bc PP	97	#ifdef BT_DEV_MODE
	98	# define bt_clock_class_freeze _bt_clock_class_freeze
	99	#else
	100	# define bt_clock_class_freeze(_cc)
	101	#endif
24626e8b	102
93dda901	103	BT_HIDDEN
44c440bc	104	bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
93dda901	105
56e18c4c	106	#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */