[babeltrace.git] / lib / trace-ir / clock-class.c

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

#define BT_LOG_TAG "CLOCK-CLASS"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/compat/uuid-internal.h>
#include <babeltrace/trace-ir/clock-class-internal.h>
#include <babeltrace/trace-ir/clock-value-internal.h>
#include <babeltrace/trace-ir/utils-internal.h>
#include <babeltrace/object.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/compat/string-internal.h>
#include <inttypes.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/assert-internal.h>

#define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
	BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))

static
void destroy_clock_class(struct bt_object *obj)
{
	struct bt_clock_class *clock_class = (void *) obj;

	BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);

	if (clock_class->name.str) {
		g_string_free(clock_class->name.str, TRUE);
	}

	if (clock_class->description.str) {
		g_string_free(clock_class->description.str, TRUE);
	}

	bt_object_pool_finalize(&clock_class->cv_pool);
	g_free(clock_class);
}

static
void free_clock_value(struct bt_clock_value *clock_value,
		struct bt_clock_class *clock_class)
{
	bt_clock_value_destroy(clock_value);
}

static inline
void set_base_offset(struct bt_clock_class *clock_class)
{
	uint64_t offset_cycles_ns;

	/* Initialize nanosecond timestamp to clock's offset in seconds */
	if (clock_class->offset_seconds <= (INT64_MIN / INT64_C(1000000000) - 1) ||
			clock_class->offset_seconds >= (INT64_MAX / INT64_C(1000000000)) - 1) {
		/*
		 * Overflow: offset in seconds converted to nanoseconds
		 * is outside the int64_t range. We also subtract 1 here
		 * to leave "space" for the offset in cycles converted
		 * to nanoseconds (which is always less than 1 second by
		 * contract).
		 */
		clock_class->base_offset.overflows = true;
		goto end;
	}

	/* Offset (seconds) to nanoseconds */
	clock_class->base_offset.value_ns = clock_class->offset_seconds *
		INT64_C(1000000000);

	/* Add offset in cycles */
	BT_ASSERT(clock_class->offset_cycles < clock_class->frequency);
	offset_cycles_ns = bt_util_ns_from_value(clock_class->frequency,
		clock_class->offset_cycles);
	BT_ASSERT(offset_cycles_ns < 1000000000);
	clock_class->base_offset.value_ns += (int64_t) offset_cycles_ns;
	clock_class->base_offset.overflows = false;

end:
	return;
}

struct bt_private_clock_class *bt_private_clock_class_create(void)
{
	int ret;
	struct bt_clock_class *clock_class = NULL;

	BT_LOGD_STR("Creating default clock class object");

	clock_class = g_new0(struct bt_clock_class, 1);
	if (!clock_class) {
		BT_LOGE_STR("Failed to allocate one clock class.");
		goto error;
	}

	bt_object_init_shared(&clock_class->base, destroy_clock_class);
	clock_class->name.str = g_string_new(NULL);
	if (!clock_class->name.str) {
		BT_LOGE_STR("Failed to allocate a GString.");
		goto error;
	}

	clock_class->description.str = g_string_new(NULL);
	if (!clock_class->description.str) {
		BT_LOGE_STR("Failed to allocate a GString.");
		goto error;
	}

	clock_class->frequency = UINT64_C(1000000000);
	clock_class->is_absolute = BT_TRUE;
	set_base_offset(clock_class);
	ret = bt_object_pool_initialize(&clock_class->cv_pool,
		(bt_object_pool_new_object_func) bt_clock_value_new,
		(bt_object_pool_destroy_object_func)
			free_clock_value,
		clock_class);
	if (ret) {
		BT_LOGE("Failed to initialize clock value pool: ret=%d",
			ret);
		goto error;
	}

	BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(clock_class);

end:
	return (void *) clock_class;
}

const char *bt_clock_class_get_name(
		struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return clock_class->name.value;
}

int bt_private_clock_class_set_name(
		struct bt_private_clock_class *priv_clock_class,
		const char *name)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	g_string_assign(clock_class->name.str, name);
	clock_class->name.value = clock_class->name.str->str;
	BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
	return 0;
}

const char *bt_clock_class_get_description(struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return clock_class->description.value;
}

int bt_private_clock_class_set_description(
		struct bt_private_clock_class *priv_clock_class,
		const char *descr)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_NON_NULL(descr, "Description");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	g_string_assign(clock_class->description.str, descr);
	clock_class->description.value = clock_class->description.str->str;
	BT_LIB_LOGV("Set clock class's description: %!+K",
		clock_class);
	return 0;
}

uint64_t bt_clock_class_get_frequency(struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return clock_class->frequency;
}

void bt_private_clock_class_set_frequency(
		struct bt_private_clock_class *priv_clock_class,
		uint64_t frequency)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
		"Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
		clock_class, frequency);
	BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
		"Offset (cycles) is greater than clock class's frequency: "
		"%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
	clock_class->frequency = frequency;
	set_base_offset(clock_class);
	BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class);
}

uint64_t bt_clock_class_get_precision(struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return clock_class->precision;
}

void bt_private_clock_class_set_precision(
		struct bt_private_clock_class *priv_clock_class,
		uint64_t precision)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	BT_ASSERT_PRE(precision != UINT64_C(-1),
		"Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
		clock_class, precision);
	clock_class->precision = precision;
	BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
}

void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
		int64_t *seconds, uint64_t *cycles)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_NON_NULL(seconds, "Seconds (output)");
	BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
	*seconds = clock_class->offset_seconds;
	*cycles = clock_class->offset_cycles;
}

void bt_private_clock_class_set_offset(
		struct bt_private_clock_class *priv_clock_class,
		int64_t seconds, uint64_t cycles)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	BT_ASSERT_PRE(cycles < clock_class->frequency,
		"Offset (cycles) is greater than clock class's frequency: "
		"%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
	clock_class->offset_seconds = seconds;
	clock_class->offset_cycles = cycles;
	set_base_offset(clock_class);
	BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
}

bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return (bool) clock_class->is_absolute;
}

void bt_private_clock_class_set_is_absolute(
		struct bt_private_clock_class *priv_clock_class,
		bt_bool is_absolute)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	clock_class->is_absolute = (bool) is_absolute;
	BT_LIB_LOGV("Set clock class's absolute property: %!+K",
		clock_class);
}

bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class)
{
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	return clock_class->uuid.value;
}

void bt_private_clock_class_set_uuid(
		struct bt_private_clock_class *priv_clock_class,
		bt_uuid uuid)
{
	struct bt_clock_class *clock_class = (void *) priv_clock_class;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
	clock_class->uuid.value = clock_class->uuid.uuid;
	BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class);
}

BT_HIDDEN
void _bt_clock_class_freeze(struct bt_clock_class *clock_class)
{
	BT_ASSERT(clock_class);

	if (clock_class->frozen) {
		return;
	}

	BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
	clock_class->frozen = 1;
}

int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
		uint64_t cycles, int64_t *ns)
{
	int ret;

	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
	ret = bt_util_ns_from_origin(clock_class, cycles, ns);
	if (ret) {
		BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
			"from origin for given clock class: "
			"value overflows the signed 64-bit integer range: "
			"%![cc-]+K, cycles=%" PRIu64,
			clock_class, cycles);
	}

	return ret;
}
Commit	Line	Data
273b65be	1	/*
de9dd397	2	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	3	*
	4	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	19	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	22	* SOFTWARE.
	23	*/
	24
0f5e83e5	25	#define BT_LOG_TAG "CLOCK-CLASS"
40547d22	26	#include <babeltrace/lib-logging-internal.h>
0f5e83e5	27
312c056a	28	#include <babeltrace/assert-pre-internal.h>
75c3fca1	29	#include <babeltrace/compat/uuid-internal.h>
56e18c4c PP	30	#include <babeltrace/trace-ir/clock-class-internal.h>
	31	#include <babeltrace/trace-ir/clock-value-internal.h>
	32	#include <babeltrace/trace-ir/utils-internal.h>
65300d60	33	#include <babeltrace/object.h>
3d9990ac	34	#include <babeltrace/compiler-internal.h>
c55a9f58	35	#include <babeltrace/types.h>
ee389f01	36	#include <babeltrace/compat/string-internal.h>
273b65be	37	#include <inttypes.h>
0f5e83e5	38	#include <babeltrace/object-internal.h>
f6ccaed9	39	#include <babeltrace/assert-internal.h>
5134570b	40
44c440bc PP	41	#define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
44c440bc PP	42	BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
312c056a PP	43
312c056a PP	44	static
44c440bc	45	void destroy_clock_class(struct bt_object *obj)
c06116f3	46	{
44c440bc	47	struct bt_clock_class clock_class = (void ) obj;
c06116f3	48
44c440bc	49	BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
273b65be	50
44c440bc PP	51	if (clock_class->name.str) {
44c440bc PP	52	g_string_free(clock_class->name.str, TRUE);
5134570b PP	53	}
5134570b PP	54
44c440bc PP	55	if (clock_class->description.str) {
44c440bc PP	56	g_string_free(clock_class->description.str, TRUE);
273b65be JG	57	}
273b65be JG	58
44c440bc PP	59	bt_object_pool_finalize(&clock_class->cv_pool);
44c440bc PP	60	g_free(clock_class);
4c426c17 JG	61	}
4c426c17 JG	62
f3534905	63	static
44c440bc PP	64	void free_clock_value(struct bt_clock_value *clock_value,
44c440bc PP	65	struct bt_clock_class *clock_class)
f3534905	66	{
44c440bc	67	bt_clock_value_destroy(clock_value);
f3534905 PP	68	}
f3534905 PP	69
44c440bc PP	70	static inline
44c440bc PP	71	void set_base_offset(struct bt_clock_class *clock_class)
312c056a	72	{
44c440bc PP	73	uint64_t offset_cycles_ns;
	74
	75	/* Initialize nanosecond timestamp to clock's offset in seconds */
	76	if (clock_class->offset_seconds <= (INT64_MIN / INT64_C(1000000000) - 1) \|\|
	77	clock_class->offset_seconds >= (INT64_MAX / INT64_C(1000000000)) - 1) {
	78	/*
	79	* Overflow: offset in seconds converted to nanoseconds
	80	* is outside the int64_t range. We also subtract 1 here
	81	* to leave "space" for the offset in cycles converted
	82	* to nanoseconds (which is always less than 1 second by
	83	* contract).
	84	*/
	85	clock_class->base_offset.overflows = true;
	86	goto end;
	87	}
	88
	89	/* Offset (seconds) to nanoseconds */
	90	clock_class->base_offset.value_ns = clock_class->offset_seconds *
	91	INT64_C(1000000000);
	92
	93	/* Add offset in cycles */
	94	BT_ASSERT(clock_class->offset_cycles < clock_class->frequency);
	95	offset_cycles_ns = bt_util_ns_from_value(clock_class->frequency,
	96	clock_class->offset_cycles);
	97	BT_ASSERT(offset_cycles_ns < 1000000000);
	98	clock_class->base_offset.value_ns += (int64_t) offset_cycles_ns;
	99	clock_class->base_offset.overflows = false;
	100
	101	end:
	102	return;
312c056a PP	103	}
312c056a PP	104
e5be10ef	105	struct bt_private_clock_class *bt_private_clock_class_create(void)
4c426c17 JG	106	{
4c426c17 JG	107	int ret;
50842bdc	108	struct bt_clock_class *clock_class = NULL;
4c426c17	109
44c440bc	110	BT_LOGD_STR("Creating default clock class object");
f3534905	111
50842bdc	112	clock_class = g_new0(struct bt_clock_class, 1);
ac0c6bdd	113	if (!clock_class) {
5134570b	114	BT_LOGE_STR("Failed to allocate one clock class.");
4c426c17 JG	115	goto error;
	116	}
	117
44c440bc PP	118	bt_object_init_shared(&clock_class->base, destroy_clock_class);
	119	clock_class->name.str = g_string_new(NULL);
	120	if (!clock_class->name.str) {
	121	BT_LOGE_STR("Failed to allocate a GString.");
	122	goto error;
	123	}
85380e99	124
44c440bc PP	125	clock_class->description.str = g_string_new(NULL);
	126	if (!clock_class->description.str) {
	127	BT_LOGE_STR("Failed to allocate a GString.");
	128	goto error;
273b65be JG	129	}
273b65be JG	130
44c440bc PP	131	clock_class->frequency = UINT64_C(1000000000);
	132	clock_class->is_absolute = BT_TRUE;
	133	set_base_offset(clock_class);
312c056a PP	134	ret = bt_object_pool_initialize(&clock_class->cv_pool,
	135	(bt_object_pool_new_object_func) bt_clock_value_new,
	136	(bt_object_pool_destroy_object_func)
44c440bc	137	free_clock_value,
312c056a PP	138	clock_class);
	139	if (ret) {
	140	BT_LOGE("Failed to initialize clock value pool: ret=%d",
	141	ret);
	142	goto error;
	143	}
	144
44c440bc PP	145	BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
	146	goto end;
	147
273b65be	148	error:
65300d60	149	BT_OBJECT_PUT_REF_AND_RESET(clock_class);
87d76bb1 JG	150
87d76bb1 JG	151	end:
e5be10ef	152	return (void *) clock_class;
87d76bb1 JG	153	}
87d76bb1 JG	154
44c440bc	155	const char *bt_clock_class_get_name(
50842bdc	156	struct bt_clock_class *clock_class)
87d76bb1	157	{
44c440bc PP	158	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	159	return clock_class->name.value;
	160	}
87d76bb1	161
e5be10ef PP	162	int bt_private_clock_class_set_name(
e5be10ef PP	163	struct bt_private_clock_class *priv_clock_class,
44c440bc PP	164	const char *name)
44c440bc PP	165	{
e5be10ef PP	166	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	167
44c440bc PP	168	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	169	BT_ASSERT_PRE_NON_NULL(name, "Name");
	170	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	171	g_string_assign(clock_class->name.str, name);
	172	clock_class->name.value = clock_class->name.str->str;
	173	BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
	174	return 0;
	175	}
87d76bb1	176
44c440bc PP	177	const char bt_clock_class_get_description(struct bt_clock_class clock_class)
	178	{
	179	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	180	return clock_class->description.value;
273b65be JG	181	}
273b65be JG	182
e5be10ef PP	183	int bt_private_clock_class_set_description(
e5be10ef PP	184	struct bt_private_clock_class *priv_clock_class,
44c440bc	185	const char *descr)
273b65be	186	{
e5be10ef PP	187	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	188
44c440bc PP	189	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	190	BT_ASSERT_PRE_NON_NULL(descr, "Description");
	191	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	192	g_string_assign(clock_class->description.str, descr);
	193	clock_class->description.value = clock_class->description.str->str;
	194	BT_LIB_LOGV("Set clock class's description: %!+K",
	195	clock_class);
	196	return 0;
273b65be JG	197	}
273b65be JG	198
44c440bc	199	uint64_t bt_clock_class_get_frequency(struct bt_clock_class *clock_class)
87d76bb1	200	{
44c440bc PP	201	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
44c440bc PP	202	return clock_class->frequency;
87d76bb1 JG	203	}
87d76bb1 JG	204
140e6d94	205	void bt_private_clock_class_set_frequency(
e5be10ef	206	struct bt_private_clock_class *priv_clock_class,
44c440bc	207	uint64_t frequency)
273b65be	208	{
e5be10ef PP	209	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	210
44c440bc PP	211	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	212	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	213	BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
	214	"Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
	215	clock_class, frequency);
	216	BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
	217	"Offset (cycles) is greater than clock class's frequency: "
	218	"%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
	219	clock_class->frequency = frequency;
	220	set_base_offset(clock_class);
	221	BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class);
273b65be JG	222	}
273b65be JG	223
50842bdc	224	uint64_t bt_clock_class_get_precision(struct bt_clock_class *clock_class)
87d76bb1	225	{
44c440bc PP	226	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
44c440bc PP	227	return clock_class->precision;
87d76bb1 JG	228	}
87d76bb1 JG	229
140e6d94	230	void bt_private_clock_class_set_precision(
e5be10ef	231	struct bt_private_clock_class *priv_clock_class,
ac0c6bdd	232	uint64_t precision)
273b65be	233	{
e5be10ef PP	234	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	235
44c440bc PP	236	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	237	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	238	BT_ASSERT_PRE(precision != UINT64_C(-1),
	239	"Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
	240	clock_class, precision);
ac0c6bdd	241	clock_class->precision = precision;
44c440bc	242	BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
273b65be JG	243	}
273b65be JG	244
44c440bc PP	245	void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
44c440bc PP	246	int64_t seconds, uint64_t cycles)
87d76bb1	247	{
44c440bc PP	248	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	249	BT_ASSERT_PRE_NON_NULL(seconds, "Seconds (output)");
	250	BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
	251	*seconds = clock_class->offset_seconds;
	252	*cycles = clock_class->offset_cycles;
87d76bb1 JG	253	}
87d76bb1 JG	254
140e6d94	255	void bt_private_clock_class_set_offset(
e5be10ef	256	struct bt_private_clock_class *priv_clock_class,
44c440bc	257	int64_t seconds, uint64_t cycles)
273b65be	258	{
e5be10ef PP	259	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	260
44c440bc PP	261	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	262	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	263	BT_ASSERT_PRE(cycles < clock_class->frequency,
	264	"Offset (cycles) is greater than clock class's frequency: "
	265	"%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
	266	clock_class->offset_seconds = seconds;
	267	clock_class->offset_cycles = cycles;
	268	set_base_offset(clock_class);
	269	BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
273b65be JG	270	}
273b65be JG	271
50842bdc	272	bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class)
87d76bb1	273	{
44c440bc PP	274	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
44c440bc PP	275	return (bool) clock_class->is_absolute;
87d76bb1 JG	276	}
87d76bb1 JG	277
140e6d94	278	void bt_private_clock_class_set_is_absolute(
e5be10ef	279	struct bt_private_clock_class *priv_clock_class,
a2b94977	280	bt_bool is_absolute)
273b65be	281	{
e5be10ef PP	282	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	283
44c440bc PP	284	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	285	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	286	clock_class->is_absolute = (bool) is_absolute;
	287	BT_LIB_LOGV("Set clock class's absolute property: %!+K",
	288	clock_class);
273b65be JG	289	}
273b65be JG	290
44c440bc	291	bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class)
85b743f4	292	{
44c440bc PP	293	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
44c440bc PP	294	return clock_class->uuid.value;
85b743f4 JG	295	}
85b743f4 JG	296
140e6d94	297	void bt_private_clock_class_set_uuid(
e5be10ef	298	struct bt_private_clock_class *priv_clock_class,
44c440bc	299	bt_uuid uuid)
85b743f4	300	{
e5be10ef PP	301	struct bt_clock_class clock_class = (void ) priv_clock_class;
e5be10ef PP	302
44c440bc PP	303	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	304	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	305	BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
	306	memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
	307	clock_class->uuid.value = clock_class->uuid.uuid;
	308	BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class);
312c056a PP	309	}
	310
	311	BT_HIDDEN
44c440bc	312	void _bt_clock_class_freeze(struct bt_clock_class *clock_class)
312c056a	313	{
312c056a	314	BT_ASSERT(clock_class);
6f57e458	315
44c440bc PP	316	if (clock_class->frozen) {
44c440bc PP	317	return;
93dda901 PP	318	}
93dda901 PP	319
44c440bc PP	320	BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
44c440bc PP	321	clock_class->frozen = 1;
93dda901	322	}
312c056a	323
44c440bc	324	int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
312c056a PP	325	uint64_t cycles, int64_t *ns)
	326	{
	327	int ret;
312c056a PP	328
312c056a PP	329	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
44c440bc PP	330	BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
44c440bc PP	331	ret = bt_util_ns_from_origin(clock_class, cycles, ns);
312c056a	332	if (ret) {
44c440bc PP	333	BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
	334	"from origin for given clock class: "
	335	"value overflows the signed 64-bit integer range: "
	336	"%![cc-]+K, cycles=%" PRIu64,
	337	clock_class, cycles);
312c056a PP	338	}
312c056a PP	339
312c056a PP	340	return ret;
312c056a PP	341	}