/*
+ * SPDX-License-Identifier: MIT
+ *
* 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.
*/
#define BT_LOG_TAG "LIB/CLOCK-CLASS"
#include "lib/logging.h"
-#include "lib/assert-pre.h"
+#include "lib/assert-cond.h"
#include "common/uuid.h"
#include <babeltrace2/trace-ir/clock-class.h>
#include "clock-class.h"
#include "utils.h"
#include "compat/compiler.h"
#include <babeltrace2/types.h>
-#include "compat/string.h"
#include <inttypes.h>
#include <stdbool.h>
#include "lib/object.h"
#include "lib/func-status.h"
#include "lib/value.h"
-#define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \
- BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc))
+#define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \
+ BT_ASSERT_PRE_DEV_HOT("clock-class", (_cc), "Clock class", \
+ ": %!+K", (_cc))
static
void destroy_clock_class(struct bt_object *obj)
BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes);
- if (clock_class->name.str) {
- g_string_free(clock_class->name.str, TRUE);
- clock_class->name.str = NULL;
- clock_class->name.value = NULL;
- }
-
- if (clock_class->description.str) {
- g_string_free(clock_class->description.str, TRUE);
- clock_class->description.str = NULL;
- clock_class->description.value = NULL;
- }
-
+ g_free(clock_class->name);
+ g_free(clock_class->description);
bt_object_pool_finalize(&clock_class->cs_pool);
g_free(clock_class);
}
static
void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot,
- struct bt_clock_class *clock_class)
+ struct bt_clock_class *clock_class __attribute__((unused)))
{
bt_clock_snapshot_destroy(clock_snapshot);
}
clock_class->frequency, &clock_class->base_offset.value_ns);
}
+BT_EXPORT
struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
{
int ret;
struct bt_clock_class *clock_class = NULL;
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
+ BT_ASSERT_PRE_COMP_NON_NULL(self_comp);
BT_LOGD_STR("Creating default clock class object");
clock_class = g_new0(struct bt_clock_class, 1);
goto error;
}
- clock_class->name.str = g_string_new(NULL);
- if (!clock_class->name.str) {
- BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
- goto error;
- }
-
- clock_class->description.str = g_string_new(NULL);
- if (!clock_class->description.str) {
- BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
- goto error;
- }
-
clock_class->frequency = UINT64_C(1000000000);
clock_class->origin_is_unix_epoch = BT_TRUE;
set_base_offset(clock_class);
return clock_class;
}
+BT_EXPORT
const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
- return clock_class->name.value;
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
+ return clock_class->name;
}
+BT_EXPORT
enum bt_clock_class_set_name_status bt_clock_class_set_name(
struct bt_clock_class *clock_class, const char *name)
{
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_NON_NULL(name, "Name");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_NAME_NON_NULL(name);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
- g_string_assign(clock_class->name.str, name);
- clock_class->name.value = clock_class->name.str->str;
+ g_free(clock_class->name);
+ clock_class->name = g_strdup(name);
BT_LIB_LOGD("Set clock class's name: %!+K", clock_class);
return BT_FUNC_STATUS_OK;
}
+BT_EXPORT
const char *bt_clock_class_get_description(
const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
- return clock_class->description.value;
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
+ return clock_class->description;
}
+BT_EXPORT
enum bt_clock_class_set_description_status bt_clock_class_set_description(
struct bt_clock_class *clock_class, const char *descr)
{
BT_ASSERT_PRE_NO_ERROR();
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_NON_NULL(descr, "Description");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_DESCR_NON_NULL(descr);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
- g_string_assign(clock_class->description.str, descr);
- clock_class->description.value = clock_class->description.str->str;
+ g_free(clock_class->description);
+ clock_class->description = g_strdup(descr);
BT_LIB_LOGD("Set clock class's description: %!+K",
clock_class);
return BT_FUNC_STATUS_OK;
}
+BT_EXPORT
uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
return clock_class->frequency;
}
+BT_EXPORT
void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
uint64_t frequency)
{
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
- BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
+ BT_ASSERT_PRE("valid-frequency",
+ frequency != UINT64_C(-1) && frequency != 0,
"Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
clock_class, frequency);
- BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
+ BT_ASSERT_PRE("offset-cycles-lt-frequency",
+ 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;
BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class);
}
+BT_EXPORT
uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
return clock_class->precision;
}
+BT_EXPORT
void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
uint64_t precision)
{
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
- BT_ASSERT_PRE(precision != UINT64_C(-1),
+ BT_ASSERT_PRE("valid-precision", precision != UINT64_C(-1),
"Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
clock_class, precision);
clock_class->precision = precision;
BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class);
}
+BT_EXPORT
void bt_clock_class_get_offset(const struct bt_clock_class *clock_class,
int64_t *seconds, uint64_t *cycles)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)");
- BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_DEV_NON_NULL("seconds-output", seconds,
+ "Seconds (output)");
+ BT_ASSERT_PRE_DEV_NON_NULL("cycles-output", cycles, "Cycles (output)");
*seconds = clock_class->offset_seconds;
*cycles = clock_class->offset_cycles;
}
+BT_EXPORT
void bt_clock_class_set_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_CLK_CLS_NON_NULL(clock_class);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
- BT_ASSERT_PRE(cycles < clock_class->frequency,
+ BT_ASSERT_PRE("offset-cycles-lt-frequency",
+ 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;
BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class);
}
+BT_EXPORT
bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
return (bool) clock_class->origin_is_unix_epoch;
}
+BT_EXPORT
void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class,
bt_bool origin_is_unix_epoch)
{
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch;
BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
clock_class);
}
+BT_EXPORT
bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
return clock_class->uuid.value;
}
+BT_EXPORT
void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
bt_uuid uuid)
{
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_UUID_NON_NULL(uuid);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
bt_uuid_copy(clock_class->uuid.uuid, uuid);
clock_class->uuid.value = clock_class->uuid.uuid;
BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class);
}
-BT_HIDDEN
void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
{
BT_ASSERT(clock_class);
((struct bt_clock_class *) clock_class)->frozen = 1;
}
+BT_EXPORT
enum bt_clock_class_cycles_to_ns_from_origin_status
bt_clock_class_cycles_to_ns_from_origin(
const struct bt_clock_class *clock_class,
int ret;
BT_ASSERT_PRE_DEV_NO_ERROR();
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_DEV_NON_NULL("nanoseconds-output", ns,
+ "Nanoseconds (output)");
ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns);
if (ret) {
BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds "
return ret;
}
+BT_EXPORT
const struct bt_value *bt_clock_class_borrow_user_attributes_const(
const struct bt_clock_class *clock_class)
{
- BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
+ BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class);
return clock_class->user_attributes;
}
+BT_EXPORT
struct bt_value *bt_clock_class_borrow_user_attributes(
struct bt_clock_class *clock_class)
{
(void *) clock_class);
}
+BT_EXPORT
void bt_clock_class_set_user_attributes(
struct bt_clock_class *clock_class,
const struct bt_value *user_attributes)
{
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
- BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
- "User attributes object is not a map value object.");
+ BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class);
+ BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes);
+ BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes);
BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
bt_object_put_ref_no_null_check(clock_class->user_attributes);
clock_class->user_attributes = (void *) user_attributes;
bt_object_get_ref_no_null_check(clock_class->user_attributes);
}
+BT_EXPORT
void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
{
bt_object_get_ref(clock_class);
}
+BT_EXPORT
void bt_clock_class_put_ref(const struct bt_clock_class *clock_class)
{
bt_object_put_ref(clock_class);
projects / babeltrace.git / blobdiff