-/*
- * clock.c
- *
- * Babeltrace CTF IR - Clock
- *
- * 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/ctf-ir/clock-internal.h>
-#include <babeltrace/ctf-ir/utils.h>
-#include <babeltrace/ref.h>
-#include <babeltrace/ctf-writer/writer-internal.h>
-#include <babeltrace/object-internal.h>
-#include <babeltrace/compiler.h>
-#include <inttypes.h>
-
-static
-void bt_ctf_clock_destroy(struct bt_object *obj);
-
-BT_HIDDEN
-bool bt_ctf_clock_is_valid(struct bt_ctf_clock *clock)
-{
- return clock && clock->name;
-}
-
-int bt_ctf_clock_set_name(struct bt_ctf_clock *clock,
- const char *name)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- if (bt_ctf_validate_identifier(name)) {
- ret = -1;
- goto end;
- }
-
- if (clock->name) {
- g_string_assign(clock->name, name);
- } else {
- clock->name = g_string_new(name);
- if (!clock->name) {
- ret = -1;
- goto end;
- }
- }
-
-end:
- return ret;
-}
-
-struct bt_ctf_clock *bt_ctf_clock_create(const char *name)
-{
- int ret;
- struct bt_ctf_clock *clock = g_new0(struct bt_ctf_clock, 1);
-
- if (!clock) {
- goto error;
- }
-
- clock->precision = 1;
- clock->frequency = 1000000000;
- bt_object_init(clock, bt_ctf_clock_destroy);
-
- if (name) {
- ret = bt_ctf_clock_set_name(clock, name);
- if (ret) {
- goto error;
- }
- }
-
- ret = bt_uuid_generate(clock->uuid);
- if (ret) {
- goto error;
- }
-
- /*
- * For backward compatibility reasons, a fresh clock can have
- * a value because it could be added to a trace created by a
- * CTF writer. As soon as this clock is added to a non-writer
- * trace, then its value/time functions will be disabled.
- */
- clock->has_value = 1;
- clock->uuid_set = 1;
- return clock;
-error:
- BT_PUT(clock);
- return clock;
-}
-
-const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock)
-{
- const char *ret = NULL;
-
- if (!clock) {
- goto end;
- }
-
- if (clock->name) {
- ret = clock->name->str;
- }
-
-end:
- return ret;
-}
-
-const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock)
-{
- const char *ret = NULL;
-
- if (!clock) {
- goto end;
- }
-
- if (clock->description) {
- ret = clock->description->str;
- }
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc)
-{
- int ret = 0;
-
- if (!clock || !desc || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->description = g_string_new(desc);
- ret = clock->description ? 0 : -1;
-end:
- return ret;
-}
-
-uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock)
-{
- uint64_t ret = -1ULL;
-
- if (!clock) {
- goto end;
- }
-
- ret = clock->frequency;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->frequency = freq;
-end:
- return ret;
-}
-
-uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock)
-{
- uint64_t ret = -1ULL;
-
- if (!clock) {
- goto end;
- }
-
- ret = clock->precision;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->precision = precision;
-end:
- return ret;
-}
-
-int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, int64_t *offset_s)
-{
- int ret = 0;
-
- if (!clock || !offset_s) {
- ret = -1;
- goto end;
- }
-
- *offset_s = clock->offset_s;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->offset_s = offset_s;
-end:
- return ret;
-}
-
-int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, int64_t *offset)
-{
- int ret = 0;
-
- if (!clock || !offset) {
- ret = -1;
- goto end;
- }
-
- *offset = clock->offset;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->offset = offset;
-end:
- return ret;
-}
-
-int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock)
-{
- int ret = -1;
-
- if (!clock) {
- goto end;
- }
-
- ret = clock->absolute;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute)
-{
- int ret = 0;
-
- if (!clock || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- clock->absolute = !!is_absolute;
-end:
- return ret;
-}
-
-const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock)
-{
- const unsigned char *ret;
-
- if (!clock || !clock->uuid_set) {
- ret = NULL;
- goto end;
- }
-
- ret = clock->uuid;
-end:
- return ret;
-}
-
-int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock, const unsigned char *uuid)
-{
- int ret = 0;
-
- if (!clock || !uuid || clock->frozen) {
- ret = -1;
- goto end;
- }
-
- memcpy(clock->uuid, uuid, sizeof(uuid_t));
- clock->uuid_set = 1;
-end:
- return ret;
-}
-
-uint64_t ns_from_value(uint64_t frequency, uint64_t value)
-{
- uint64_t ns;
-
- if (frequency == 1000000000) {
- ns = value;
- } else {
- ns = (uint64_t) ((1e9 * (double) value) / (double) frequency);
- }
-
- return ns;
-}
-
-int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time)
-{
- int ret = 0;
- int64_t value;
-
- /* Timestamps are strictly monotonic */
- if (!clock) {
- ret = -1;
- goto end;
- }
-
-
- if (!clock->has_value) {
- /*
- * Clock belongs to a non-writer mode trace and thus
- * this function is disabled.
- */
- ret = -1;
- goto end;
- }
-
- /* Common case where cycles are actually nanoseconds */
- if (clock->frequency == 1000000000) {
- value = time;
- } else {
- value = (uint64_t) (((double) time *
- (double) clock->frequency) / 1e9);
- }
-
- if (clock->value > value) {
- /* Timestamps must be strictly monotonic. */
- ret = -1;
- goto end;
- }
-
- clock->value = value;
-end:
- return ret;
-}
-
-void bt_ctf_clock_get(struct bt_ctf_clock *clock)
-{
- bt_get(clock);
-}
-
-void bt_ctf_clock_put(struct bt_ctf_clock *clock)
-{
- bt_put(clock);
-}
-
-BT_HIDDEN
-void bt_ctf_clock_freeze(struct bt_ctf_clock *clock)
-{
- if (!clock) {
- return;
- }
-
- clock->frozen = 1;
-}
-
-BT_HIDDEN
-void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
- struct metadata_context *context)
-{
- unsigned char *uuid;
-
- if (!clock || !context) {
- return;
- }
-
- uuid = clock->uuid;
- g_string_append(context->string, "clock {\n");
- g_string_append_printf(context->string, "\tname = %s;\n",
- clock->name->str);
- g_string_append_printf(context->string,
- "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
- uuid[0], uuid[1], uuid[2], uuid[3],
- uuid[4], uuid[5], uuid[6], uuid[7],
- uuid[8], uuid[9], uuid[10], uuid[11],
- uuid[12], uuid[13], uuid[14], uuid[15]);
- if (clock->description) {
- g_string_append_printf(context->string, "\tdescription = \"%s\";\n",
- clock->description->str);
- }
-
- g_string_append_printf(context->string, "\tfreq = %" PRIu64 ";\n",
- clock->frequency);
- g_string_append_printf(context->string, "\tprecision = %" PRIu64 ";\n",
- clock->precision);
- g_string_append_printf(context->string, "\toffset_s = %" PRIu64 ";\n",
- clock->offset_s);
- g_string_append_printf(context->string, "\toffset = %" PRIu64 ";\n",
- clock->offset);
- g_string_append_printf(context->string, "\tabsolute = %s;\n",
- clock->absolute ? "TRUE" : "FALSE");
- g_string_append(context->string, "};\n\n");
-}
-
-BT_HIDDEN
-int bt_ctf_clock_get_value(struct bt_ctf_clock *clock, uint64_t *value)
-{
- int ret = 0;
-
- if (!clock || !value) {
- ret = -1;
- goto end;
- }
-
- *value = clock->value;
-end:
- return ret;
-}
-
-static
-void bt_ctf_clock_destroy(struct bt_object *obj)
-{
- struct bt_ctf_clock *clock;
-
- clock = container_of(obj, struct bt_ctf_clock, base);
- if (clock->name) {
- g_string_free(clock->name, TRUE);
- }
-
- if (clock->description) {
- g_string_free(clock->description, TRUE);
- }
-
- g_free(clock);
-}
-
-static
-void bt_ctf_clock_value_destroy(struct bt_object *obj)
-{
- struct bt_ctf_clock_value *value;
-
- if (!obj) {
- return;
- }
-
- value = container_of(obj, struct bt_ctf_clock_value, base);
- bt_put(value->clock_class);
- g_free(value);
-}
-
-struct bt_ctf_clock_value *bt_ctf_clock_value_create(
- struct bt_ctf_clock *clock, uint64_t value)
-{
- struct bt_ctf_clock_value *ret = NULL;
-
- if (!clock) {
- goto end;
- }
-
- ret = g_new0(struct bt_ctf_clock_value, 1);
- if (!ret) {
- goto end;
- }
-
- bt_object_init(ret, bt_ctf_clock_value_destroy);
- ret->clock_class = bt_get(clock);
- ret->value = value;
-end:
- return ret;
-}
-
-int bt_ctf_clock_value_get_value(
- struct bt_ctf_clock_value *clock_value, uint64_t *raw_value)
-{
- int ret = 0;
-
- if (!clock_value || !raw_value) {
- ret = -1;
- goto end;
- }
-
- *raw_value = clock_value->value;
-end:
- return ret;
-}
-
-int bt_ctf_clock_value_get_value_ns_from_epoch(struct bt_ctf_clock_value *value,
- int64_t *ret_value_ns)
-{
- int ret = 0;
- int64_t ns;
-
- if (!value || !ret_value_ns) {
- ret = -1;
- goto end;
- }
-
- /* Initialize nanosecond timestamp to clock's offset in seconds. */
- ns = value->clock_class->offset_s * 1000000000;
-
- /* Add offset in cycles, converted to nanoseconds. */
- ns += ns_from_value(value->clock_class->frequency,
- value->clock_class->offset);
-
- /* Add given value, converter to nanoseconds. */
- ns += ns_from_value(value->clock_class->frequency, value->value);
-
- *ret_value_ns = ns;
-end:
- return ret;
-}