[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 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.
 */

#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 <babeltrace/assert-internal.h>
#include <stdbool.h>
#include <stdint.h>
#include <glib.h>

#define NS_PER_S_I	INT64_C(1000000000)
#define NS_PER_S_U	UINT64_C(1000000000)

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 origin_is_unix_epoch;

	/*
	 * 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_snapshot_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_snapshot *` */
	struct bt_object_pool cs_pool;

	bool frozen;
};

BT_HIDDEN
void _bt_clock_class_freeze(const 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);

static inline
int bt_clock_class_clock_value_from_ns_from_origin(
		struct bt_clock_class *cc, int64_t ns_from_origin,
		uint64_t *raw_value)
{
	int ret = 0;
	int64_t offset_in_ns;
	uint64_t value_in_ns;
	uint64_t rem_value_in_ns;
	uint64_t value_periods;
	uint64_t value_period_cycles;
	int64_t ns_to_add;

	BT_ASSERT(cc);
	BT_ASSERT(raw_value);

	/* Compute offset part of requested value, in nanoseconds */
	if (!bt_safe_to_mul_int64(cc->offset_seconds, NS_PER_S_I)) {
		ret = -1;
		goto end;
	}

	offset_in_ns = cc->offset_seconds * NS_PER_S_I;

	if (cc->frequency == NS_PER_S_U) {
		ns_to_add = (int64_t) cc->offset_cycles;
	} else {
		if (!bt_safe_to_mul_int64((int64_t) cc->offset_cycles,
				NS_PER_S_I)) {
			ret = -1;
			goto end;
		}

		ns_to_add = ((int64_t) cc->offset_cycles * NS_PER_S_I) /
			(int64_t) cc->frequency;
	}

	if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) {
		ret = -1;
		goto end;
	}

	offset_in_ns += ns_to_add;

	/* Value part in nanoseconds */
	if (ns_from_origin < offset_in_ns) {
		ret = -1;
		goto end;
	}

	value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns);

	/* Number of whole clock periods in `value_in_ns` */
	value_periods = value_in_ns / NS_PER_S_U;

	/* Remaining nanoseconds in cycles + whole clock periods in cycles */
	rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U;

	if (value_periods > UINT64_MAX / cc->frequency) {
		ret = -1;
		goto end;
	}

	if (!bt_safe_to_mul_uint64(value_periods, cc->frequency)) {
		ret = -1;
		goto end;
	}

	value_period_cycles = value_periods * cc->frequency;

	if (!bt_safe_to_mul_uint64(cc->frequency, rem_value_in_ns)) {
		ret = -1;
		goto end;
	}

	if (!bt_safe_to_add_uint64(cc->frequency * rem_value_in_ns / NS_PER_S_U,
			value_period_cycles)) {
		ret = -1;
		goto end;
	}

	*raw_value = cc->frequency * rem_value_in_ns / NS_PER_S_U +
		value_period_cycles;

end:
	return ret;
}

#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
	2	#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	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
	27	#include <babeltrace/trace-ir/clock-class.h>
	28	#include <babeltrace/object-internal.h>
	29	#include <babeltrace/babeltrace-internal.h>
	30	#include <babeltrace/object-pool-internal.h>
	31	#include <babeltrace/compat/uuid-internal.h>
	32	#include <babeltrace/types.h>
	33	#include <babeltrace/property-internal.h>
	34	#include <babeltrace/assert-internal.h>
	35	#include <stdbool.h>
	36	#include <stdint.h>
	37	#include <glib.h>
	38
	39	#define NS_PER_S_I INT64_C(1000000000)
	40	#define NS_PER_S_U UINT64_C(1000000000)
	41
	42	struct bt_clock_class {
	43	struct bt_object base;
	44
	45	struct {
	46	GString *str;
	47
	48	/* NULL or `str->str` above */
	49	const char *value;
	50	} name;
	51
	52	struct {
	53	GString *str;
	54
	55	/* NULL or `str->str` above */
	56	const char *value;
	57	} description;
	58
	59	uint64_t frequency;
	60	uint64_t precision;
	61	int64_t offset_seconds;
	62	uint64_t offset_cycles;
	63
	64	struct {
	65	uint8_t uuid[BABELTRACE_UUID_LEN];
	66
	67	/* NULL or `uuid` above */
	68	bt_uuid value;
	69	} uuid;
	70
	71	bool origin_is_unix_epoch;
	72
	73	/*
	74	* This is computed every time you call
	75	* bt_clock_class_set_frequency() or
	76	* bt_clock_class_set_offset(), as well as initially. It is the
	77	* base offset in nanoseconds including both `offset_seconds`
	78	* and `offset_cycles` above in the result. It is used to
	79	* accelerate future calls to
	80	* bt_clock_snapshot_get_ns_from_origin() and
	81	* bt_clock_class_cycles_to_ns_from_origin().
	82	*
	83	* `overflows` is true if the base offset cannot be computed
	84	* because of an overflow.
	85	*/
	86	struct {
	87	int64_t value_ns;
	88	bool overflows;
	89	} base_offset;
	90
	91	/* Pool of `struct bt_clock_snapshot ` /
	92	struct bt_object_pool cs_pool;
	93
	94	bool frozen;
	95	};
	96
	97	BT_HIDDEN
	98	void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
	99
	100	#ifdef BT_DEV_MODE
	101	# define bt_clock_class_freeze _bt_clock_class_freeze
	102	#else
	103	# define bt_clock_class_freeze(_cc)
	104	#endif
	105
	106	BT_HIDDEN
	107	bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
	108
	109	static inline
	110	int bt_clock_class_clock_value_from_ns_from_origin(
	111	struct bt_clock_class *cc, int64_t ns_from_origin,
	112	uint64_t *raw_value)
	113	{
	114	int ret = 0;
	115	int64_t offset_in_ns;
	116	uint64_t value_in_ns;
	117	uint64_t rem_value_in_ns;
	118	uint64_t value_periods;
	119	uint64_t value_period_cycles;
	120	int64_t ns_to_add;
	121
	122	BT_ASSERT(cc);
	123	BT_ASSERT(raw_value);
	124
	125	/* Compute offset part of requested value, in nanoseconds */
	126	if (!bt_safe_to_mul_int64(cc->offset_seconds, NS_PER_S_I)) {
	127	ret = -1;
	128	goto end;
	129	}
	130
	131	offset_in_ns = cc->offset_seconds * NS_PER_S_I;
	132
	133	if (cc->frequency == NS_PER_S_U) {
	134	ns_to_add = (int64_t) cc->offset_cycles;
	135	} else {
	136	if (!bt_safe_to_mul_int64((int64_t) cc->offset_cycles,
	137	NS_PER_S_I)) {
	138	ret = -1;
	139	goto end;
	140	}
	141
	142	ns_to_add = ((int64_t) cc->offset_cycles * NS_PER_S_I) /
	143	(int64_t) cc->frequency;
	144	}
	145
	146	if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) {
	147	ret = -1;
	148	goto end;
	149	}
	150
	151	offset_in_ns += ns_to_add;
	152
	153	/* Value part in nanoseconds */
	154	if (ns_from_origin < offset_in_ns) {
	155	ret = -1;
	156	goto end;
	157	}
	158
	159	value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns);
	160
	161	/* Number of whole clock periods in `value_in_ns` */
	162	value_periods = value_in_ns / NS_PER_S_U;
	163
	164	/* Remaining nanoseconds in cycles + whole clock periods in cycles */
	165	rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U;
	166
	167	if (value_periods > UINT64_MAX / cc->frequency) {
	168	ret = -1;
	169	goto end;
	170	}
	171
	172	if (!bt_safe_to_mul_uint64(value_periods, cc->frequency)) {
	173	ret = -1;
	174	goto end;
	175	}
	176
	177	value_period_cycles = value_periods * cc->frequency;
	178
	179	if (!bt_safe_to_mul_uint64(cc->frequency, rem_value_in_ns)) {
	180	ret = -1;
	181	goto end;
	182	}
	183
	184	if (!bt_safe_to_add_uint64(cc->frequency * rem_value_in_ns / NS_PER_S_U,
	185	value_period_cycles)) {
	186	ret = -1;
	187	goto end;
	188	}
	189
	190	raw_value = cc->frequency rem_value_in_ns / NS_PER_S_U +
	191	value_period_cycles;
	192
	193	end:
	194	return ret;
	195	}
	196
	197	#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */