[babeltrace.git] / src / ctf-writer / clock.c

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
 *
 * Babeltrace CTF writer - Clock
 */

#define BT_LOG_TAG "CTF-WRITER/CLOCK"
#include "logging.h"

#include "common/assert.h"
#include "common/uuid.h"
#include "compat/compiler.h"
#include <babeltrace2-ctf-writer/utils.h>
#include <babeltrace2-ctf-writer/object.h>
#include <inttypes.h>

#include "clock-class.h"
#include "clock.h"
#include "object.h"
#include "writer.h"

static
void bt_ctf_clock_destroy(struct bt_ctf_object *obj);

BT_EXPORT
struct bt_ctf_clock *bt_ctf_clock_create(const char *name)
{
	int ret;
	struct bt_ctf_clock *clock = NULL;
	bt_uuid_t cc_uuid;

	BT_CTF_ASSERT_PRE_NON_NULL(name, "Name");
	clock = g_new0(struct bt_ctf_clock, 1);
	if (!clock) {
		goto error;
	}

	bt_ctf_object_init_shared(&clock->base, bt_ctf_clock_destroy);
	clock->value = 0;

	/* Pre-2.0.0 backward compatibility: default frequency is 1 GHz */
	clock->clock_class = (void *) bt_ctf_clock_class_create(name, 1000000000);
	if (!clock->clock_class) {
		goto error;
	}

	/* Automatically set clock class's UUID. */
	bt_uuid_generate(cc_uuid);

	ret = bt_ctf_clock_class_set_uuid(clock->clock_class, cc_uuid);
	BT_ASSERT_DBG(ret == 0);
	return clock;

error:
	BT_CTF_OBJECT_PUT_REF_AND_RESET(clock);
	return clock;
}

BT_EXPORT
const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_name(clock->clock_class);
}

BT_EXPORT
const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_description(clock->clock_class);
}

BT_EXPORT
int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_description(clock->clock_class,
		desc);
}

BT_EXPORT
uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_frequency(clock->clock_class);
}

BT_EXPORT
int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_frequency(clock->clock_class,
		freq);
}

BT_EXPORT
uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_precision(clock->clock_class);
}

BT_EXPORT
int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_precision(clock->clock_class,
		precision);
}

BT_EXPORT
int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, int64_t *offset_s)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_offset_s(clock->clock_class,
		offset_s);
}

BT_EXPORT
int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_offset_s(clock->clock_class,
		offset_s);
}

BT_EXPORT
int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, int64_t *offset)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_offset_cycles(clock->clock_class,
		offset);
}

BT_EXPORT
int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_offset_cycles(clock->clock_class,
		offset);
}

BT_EXPORT
int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_is_absolute(clock->clock_class);
}

BT_EXPORT
int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_is_absolute(clock->clock_class,
		is_absolute);
}

BT_EXPORT
const uint8_t *bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_get_uuid(clock->clock_class);
}

BT_EXPORT
int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock, const uint8_t *uuid)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	return bt_ctf_clock_class_set_uuid(clock->clock_class, uuid);
}

BT_EXPORT
int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time)
{
	int64_t value;
	struct bt_ctf_clock_class *cc;

	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	cc = clock->clock_class;

	/* Common case where cycles are actually nanoseconds */
	if (cc->frequency == 1000000000) {
		value = time;
	} else {
		value = (uint64_t) (((double) time *
		        (double) cc->frequency) / 1e9);
	}

	BT_CTF_ASSERT_PRE(clock->value <= value,
		"CTF writer clock value must be updated monotonically: "
		"prev-value=%" PRId64 ", new-value=%" PRId64,
		clock->value, value);
	clock->value = value;
	return 0;
}

int bt_ctf_clock_get_value(struct bt_ctf_clock *clock, uint64_t *value)
{
	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	BT_CTF_ASSERT_PRE_NON_NULL(value, "Value");
	*value = clock->value;
	return 0;
}

static
void bt_ctf_clock_destroy(struct bt_ctf_object *obj)
{
	struct bt_ctf_clock *clock;

	clock = container_of(obj, struct bt_ctf_clock, base);
	bt_ctf_object_put_ref(clock->clock_class);
	g_free(clock);
}

void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class,
		struct metadata_context *context)
{
	uint8_t *uuid;

	BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
		"name=\"%s\", metadata-context-addr=%p", clock_class,
		bt_ctf_clock_class_get_name(clock_class),
		context);

	if (!clock_class || !context) {
		BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
			"clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
			clock_class,
			bt_ctf_clock_class_get_name(clock_class),
			context);
		return;
	}

	uuid = clock_class->uuid;
	g_string_append(context->string, "clock {\n");
	g_string_append_printf(context->string, "\tname = %s;\n",
		clock_class->name->str);

	if (clock_class->uuid_set) {
		g_string_append_printf(context->string,
			"\tuuid = \"" BT_UUID_FMT "\";\n",
			BT_UUID_FMT_VALUES(uuid));
	}

	if (clock_class->description) {
		g_string_append_printf(context->string, "\tdescription = \"%s\";\n",
			clock_class->description->str);
	}

	g_string_append_printf(context->string, "\tfreq = %" PRIu64 ";\n",
		clock_class->frequency);
	g_string_append_printf(context->string, "\tprecision = %" PRIu64 ";\n",
		clock_class->precision);
	g_string_append_printf(context->string, "\toffset_s = %" PRIu64 ";\n",
		clock_class->offset_s);
	g_string_append_printf(context->string, "\toffset = %" PRIu64 ";\n",
		clock_class->offset);
	g_string_append_printf(context->string, "\tabsolute = %s;\n",
		clock_class->absolute ? "true" : "false");
	g_string_append(context->string, "};\n\n");
}
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
	6	*
	7	* Babeltrace CTF writer - Clock
	8	*/
	9
	10	#define BT_LOG_TAG "CTF-WRITER/CLOCK"
	11	#include "logging.h"
	12
	13	#include "common/assert.h"
	14	#include "common/uuid.h"
	15	#include "compat/compiler.h"
	16	#include <babeltrace2-ctf-writer/utils.h>
	17	#include <babeltrace2-ctf-writer/object.h>
	18	#include <inttypes.h>
	19
	20	#include "clock-class.h"
	21	#include "clock.h"
	22	#include "object.h"
	23	#include "writer.h"
	24
	25	static
	26	void bt_ctf_clock_destroy(struct bt_ctf_object *obj);
	27
	28	BT_EXPORT
	29	struct bt_ctf_clock bt_ctf_clock_create(const char name)
	30	{
	31	int ret;
	32	struct bt_ctf_clock *clock = NULL;
	33	bt_uuid_t cc_uuid;
	34
	35	BT_CTF_ASSERT_PRE_NON_NULL(name, "Name");
	36	clock = g_new0(struct bt_ctf_clock, 1);
	37	if (!clock) {
	38	goto error;
	39	}
	40
	41	bt_ctf_object_init_shared(&clock->base, bt_ctf_clock_destroy);
	42	clock->value = 0;
	43
	44	/* Pre-2.0.0 backward compatibility: default frequency is 1 GHz */
	45	clock->clock_class = (void *) bt_ctf_clock_class_create(name, 1000000000);
	46	if (!clock->clock_class) {
	47	goto error;
	48	}
	49
	50	/* Automatically set clock class's UUID. */
	51	bt_uuid_generate(cc_uuid);
	52
	53	ret = bt_ctf_clock_class_set_uuid(clock->clock_class, cc_uuid);
	54	BT_ASSERT_DBG(ret == 0);
	55	return clock;
	56
	57	error:
	58	BT_CTF_OBJECT_PUT_REF_AND_RESET(clock);
	59	return clock;
	60	}
	61
	62	BT_EXPORT
	63	const char bt_ctf_clock_get_name(struct bt_ctf_clock clock)
	64	{
	65	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	66	return bt_ctf_clock_class_get_name(clock->clock_class);
	67	}
	68
	69	BT_EXPORT
	70	const char bt_ctf_clock_get_description(struct bt_ctf_clock clock)
	71	{
	72	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	73	return bt_ctf_clock_class_get_description(clock->clock_class);
	74	}
	75
	76	BT_EXPORT
	77	int bt_ctf_clock_set_description(struct bt_ctf_clock clock, const char desc)
	78	{
	79	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	80	return bt_ctf_clock_class_set_description(clock->clock_class,
	81	desc);
	82	}
	83
	84	BT_EXPORT
	85	uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock)
	86	{
	87	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	88	return bt_ctf_clock_class_get_frequency(clock->clock_class);
	89	}
	90
	91	BT_EXPORT
	92	int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq)
	93	{
	94	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	95	return bt_ctf_clock_class_set_frequency(clock->clock_class,
	96	freq);
	97	}
	98
	99	BT_EXPORT
	100	uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock)
	101	{
	102	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	103	return bt_ctf_clock_class_get_precision(clock->clock_class);
	104	}
	105
	106	BT_EXPORT
	107	int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision)
	108	{
	109	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	110	return bt_ctf_clock_class_set_precision(clock->clock_class,
	111	precision);
	112	}
	113
	114	BT_EXPORT
	115	int bt_ctf_clock_get_offset_s(struct bt_ctf_clock clock, int64_t offset_s)
	116	{
	117	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	118	return bt_ctf_clock_class_get_offset_s(clock->clock_class,
	119	offset_s);
	120	}
	121
	122	BT_EXPORT
	123	int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s)
	124	{
	125	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	126	return bt_ctf_clock_class_set_offset_s(clock->clock_class,
	127	offset_s);
	128	}
	129
	130	BT_EXPORT
	131	int bt_ctf_clock_get_offset(struct bt_ctf_clock clock, int64_t offset)
	132	{
	133	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	134	return bt_ctf_clock_class_get_offset_cycles(clock->clock_class,
	135	offset);
	136	}
	137
	138	BT_EXPORT
	139	int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset)
	140	{
	141	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	142	return bt_ctf_clock_class_set_offset_cycles(clock->clock_class,
	143	offset);
	144	}
	145
	146	BT_EXPORT
	147	int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock)
	148	{
	149	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	150	return bt_ctf_clock_class_is_absolute(clock->clock_class);
	151	}
	152
	153	BT_EXPORT
	154	int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute)
	155	{
	156	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	157	return bt_ctf_clock_class_set_is_absolute(clock->clock_class,
	158	is_absolute);
	159	}
	160
	161	BT_EXPORT
	162	const uint8_t bt_ctf_clock_get_uuid(struct bt_ctf_clock clock)
	163	{
	164	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	165	return bt_ctf_clock_class_get_uuid(clock->clock_class);
	166	}
	167
	168	BT_EXPORT
	169	int bt_ctf_clock_set_uuid(struct bt_ctf_clock clock, const uint8_t uuid)
	170	{
	171	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	172	return bt_ctf_clock_class_set_uuid(clock->clock_class, uuid);
	173	}
	174
	175	BT_EXPORT
	176	int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time)
	177	{
	178	int64_t value;
	179	struct bt_ctf_clock_class *cc;
	180
	181	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	182	cc = clock->clock_class;
	183
	184	/* Common case where cycles are actually nanoseconds */
	185	if (cc->frequency == 1000000000) {
	186	value = time;
	187	} else {
	188	value = (uint64_t) (((double) time *
	189	(double) cc->frequency) / 1e9);
	190	}
	191
	192	BT_CTF_ASSERT_PRE(clock->value <= value,
	193	"CTF writer clock value must be updated monotonically: "
	194	"prev-value=%" PRId64 ", new-value=%" PRId64,
	195	clock->value, value);
	196	clock->value = value;
	197	return 0;
	198	}
	199
	200	int bt_ctf_clock_get_value(struct bt_ctf_clock clock, uint64_t value)
	201	{
	202	BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock");
	203	BT_CTF_ASSERT_PRE_NON_NULL(value, "Value");
	204	*value = clock->value;
	205	return 0;
	206	}
	207
	208	static
	209	void bt_ctf_clock_destroy(struct bt_ctf_object *obj)
	210	{
	211	struct bt_ctf_clock *clock;
	212
	213	clock = container_of(obj, struct bt_ctf_clock, base);
	214	bt_ctf_object_put_ref(clock->clock_class);
	215	g_free(clock);
	216	}
	217
	218	void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class,
	219	struct metadata_context *context)
	220	{
	221	uint8_t *uuid;
	222
	223	BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
	224	"name=\"%s\", metadata-context-addr=%p", clock_class,
	225	bt_ctf_clock_class_get_name(clock_class),
	226	context);
	227
	228	if (!clock_class \|\| !context) {
	229	BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
	230	"clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
	231	clock_class,
	232	bt_ctf_clock_class_get_name(clock_class),
	233	context);
	234	return;
	235	}
	236
	237	uuid = clock_class->uuid;
	238	g_string_append(context->string, "clock {\n");
	239	g_string_append_printf(context->string, "\tname = %s;\n",
	240	clock_class->name->str);
	241
	242	if (clock_class->uuid_set) {
	243	g_string_append_printf(context->string,
	244	"\tuuid = \"" BT_UUID_FMT "\";\n",
	245	BT_UUID_FMT_VALUES(uuid));
	246	}
	247
	248	if (clock_class->description) {
	249	g_string_append_printf(context->string, "\tdescription = \"%s\";\n",
	250	clock_class->description->str);
	251	}
	252
	253	g_string_append_printf(context->string, "\tfreq = %" PRIu64 ";\n",
	254	clock_class->frequency);
	255	g_string_append_printf(context->string, "\tprecision = %" PRIu64 ";\n",
	256	clock_class->precision);
	257	g_string_append_printf(context->string, "\toffset_s = %" PRIu64 ";\n",
	258	clock_class->offset_s);
	259	g_string_append_printf(context->string, "\toffset = %" PRIu64 ";\n",
	260	clock_class->offset);
	261	g_string_append_printf(context->string, "\tabsolute = %s;\n",
	262	clock_class->absolute ? "true" : "false");
	263	g_string_append(context->string, "};\n\n");
	264	}