src/lib/trace-ir/clock-class.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "LIB/CLOCK-CLASS"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include "common/uuid.h"
  29 #include <babeltrace2/trace-ir/clock-class-const.h>
  30 #include <babeltrace2/trace-ir/clock-class.h>
  31 #include "clock-class.h"
  32 #include "clock-snapshot.h"
  33 #include "utils.h"
  34 #include "compat/compiler.h"
  35 #include <babeltrace2/types.h>
  36 #include "compat/string.h"
  37 #include <inttypes.h>
  38 #include <stdbool.h>
  39 #include "lib/object.h"
  40 #include "common/assert.h"
  41 #include "lib/func-status.h"
  42 #include "lib/value.h"
  43
  44 #define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \
  45         BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc))
  46
  47 static
  48 void destroy_clock_class(struct bt_object *obj)
  49 {
  50         struct bt_clock_class *clock_class = (void *) obj;
  51
  52         BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
  53         BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes);
  54
  55         if (clock_class->name.str) {
  56                 g_string_free(clock_class->name.str, TRUE);
  57                 clock_class->name.str = NULL;
  58                 clock_class->name.value = NULL;
  59         }
  60
  61         if (clock_class->description.str) {
  62                 g_string_free(clock_class->description.str, TRUE);
  63                 clock_class->description.str = NULL;
  64                 clock_class->description.value = NULL;
  65         }
  66
  67         bt_object_pool_finalize(&clock_class->cs_pool);
  68         g_free(clock_class);
  69 }
  70
  71 static
  72 void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot,
  73                 struct bt_clock_class *clock_class)
  74 {
  75         bt_clock_snapshot_destroy(clock_snapshot);
  76 }
  77
  78 static inline
  79 void set_base_offset(struct bt_clock_class *clock_class)
  80 {
  81         clock_class->base_offset.overflows = bt_util_get_base_offset_ns(
  82                 clock_class->offset_seconds, clock_class->offset_cycles,
  83                 clock_class->frequency, &clock_class->base_offset.value_ns);
  84 }
  85
  86 struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
  87 {
  88         int ret;
  89         struct bt_clock_class *clock_class = NULL;
  90
  91         BT_ASSERT_PRE_NO_ERROR();
  92         BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
  93         BT_LOGD_STR("Creating default clock class object");
  94
  95         clock_class = g_new0(struct bt_clock_class, 1);
  96         if (!clock_class) {
  97                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class.");
  98                 goto error;
  99         }
 100
 101         bt_object_init_shared(&clock_class->base, destroy_clock_class);
 102
 103         clock_class->user_attributes = bt_value_map_create();
 104         if (!clock_class->user_attributes) {
 105                 BT_LIB_LOGE_APPEND_CAUSE(
 106                         "Failed to create a map value object.");
 107                 goto error;
 108         }
 109
 110         clock_class->name.str = g_string_new(NULL);
 111         if (!clock_class->name.str) {
 112                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 113                 goto error;
 114         }
 115
 116         clock_class->description.str = g_string_new(NULL);
 117         if (!clock_class->description.str) {
 118                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 119                 goto error;
 120         }
 121
 122         clock_class->frequency = UINT64_C(1000000000);
 123         clock_class->origin_is_unix_epoch = BT_TRUE;
 124         set_base_offset(clock_class);
 125         ret = bt_object_pool_initialize(&clock_class->cs_pool,
 126                 (bt_object_pool_new_object_func) bt_clock_snapshot_new,
 127                 (bt_object_pool_destroy_object_func)
 128                         free_clock_snapshot,
 129                 clock_class);
 130         if (ret) {
 131                 BT_LIB_LOGE_APPEND_CAUSE(
 132                         "Failed to initialize clock snapshot pool: ret=%d",
 133                         ret);
 134                 goto error;
 135         }
 136
 137         BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
 138         goto end;
 139
 140 error:
 141         BT_OBJECT_PUT_REF_AND_RESET(clock_class);
 142
 143 end:
 144         return clock_class;
 145 }
 146
 147 const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 148 {
 149         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 150         return clock_class->name.value;
 151 }
 152
 153 enum bt_clock_class_set_name_status bt_clock_class_set_name(
 154                 struct bt_clock_class *clock_class, const char *name)
 155 {
 156         BT_ASSERT_PRE_NO_ERROR();
 157         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 158         BT_ASSERT_PRE_NON_NULL(name, "Name");
 159         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 160         g_string_assign(clock_class->name.str, name);
 161         clock_class->name.value = clock_class->name.str->str;
 162         BT_LIB_LOGD("Set clock class's name: %!+K", clock_class);
 163         return BT_FUNC_STATUS_OK;
 164 }
 165
 166 const char *bt_clock_class_get_description(
 167                 const struct bt_clock_class *clock_class)
 168 {
 169         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 170         return clock_class->description.value;
 171 }
 172
 173 enum bt_clock_class_set_description_status bt_clock_class_set_description(
 174                 struct bt_clock_class *clock_class, const char *descr)
 175 {
 176         BT_ASSERT_PRE_NO_ERROR();
 177         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 178         BT_ASSERT_PRE_NON_NULL(descr, "Description");
 179         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 180         g_string_assign(clock_class->description.str, descr);
 181         clock_class->description.value = clock_class->description.str->str;
 182         BT_LIB_LOGD("Set clock class's description: %!+K",
 183                 clock_class);
 184         return BT_FUNC_STATUS_OK;
 185 }
 186
 187 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
 188 {
 189         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 190         return clock_class->frequency;
 191 }
 192
 193 void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
 194                 uint64_t frequency)
 195 {
 196         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 197         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 198         BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
 199                 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
 200                 clock_class, frequency);
 201         BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
 202                 "Offset (cycles) is greater than clock class's frequency: "
 203                 "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
 204         clock_class->frequency = frequency;
 205         set_base_offset(clock_class);
 206         BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class);
 207 }
 208
 209 uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
 210 {
 211         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 212         return clock_class->precision;
 213 }
 214
 215 void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
 216                 uint64_t precision)
 217 {
 218         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 219         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 220         BT_ASSERT_PRE(precision != UINT64_C(-1),
 221                 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
 222                 clock_class, precision);
 223         clock_class->precision = precision;
 224         BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class);
 225 }
 226
 227 void bt_clock_class_get_offset(const struct bt_clock_class *clock_class,
 228                 int64_t *seconds, uint64_t *cycles)
 229 {
 230         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 231         BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)");
 232         BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)");
 233         *seconds = clock_class->offset_seconds;
 234         *cycles = clock_class->offset_cycles;
 235 }
 236
 237 void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
 238                 int64_t seconds, uint64_t cycles)
 239 {
 240         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 241         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 242         BT_ASSERT_PRE(cycles < clock_class->frequency,
 243                 "Offset (cycles) is greater than clock class's frequency: "
 244                 "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
 245         clock_class->offset_seconds = seconds;
 246         clock_class->offset_cycles = cycles;
 247         set_base_offset(clock_class);
 248         BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class);
 249 }
 250
 251 bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class)
 252 {
 253         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 254         return (bool) clock_class->origin_is_unix_epoch;
 255 }
 256
 257 void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class,
 258                 bt_bool origin_is_unix_epoch)
 259 {
 260         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 261         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 262         clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch;
 263         BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
 264                 clock_class);
 265 }
 266
 267 bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
 268 {
 269         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 270         return clock_class->uuid.value;
 271 }
 272
 273 void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
 274                 bt_uuid uuid)
 275 {
 276         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 277         BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
 278         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 279         bt_uuid_copy(clock_class->uuid.uuid, uuid);
 280         clock_class->uuid.value = clock_class->uuid.uuid;
 281         BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class);
 282 }
 283
 284 BT_HIDDEN
 285 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
 286 {
 287         BT_ASSERT(clock_class);
 288
 289         if (clock_class->frozen) {
 290                 return;
 291         }
 292
 293         BT_LIB_LOGD("Freezing clock class's user attributes: %!+v",
 294                 clock_class->user_attributes);
 295         bt_value_freeze(clock_class->user_attributes);
 296         BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
 297         ((struct bt_clock_class *) clock_class)->frozen = 1;
 298 }
 299
 300 enum bt_clock_class_cycles_to_ns_from_origin_status
 301 bt_clock_class_cycles_to_ns_from_origin(
 302                 const struct bt_clock_class *clock_class,
 303                 uint64_t cycles, int64_t *ns)
 304 {
 305         int ret;
 306
 307         BT_ASSERT_PRE_DEV_NO_ERROR();
 308         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 309         BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)");
 310         ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns);
 311         if (ret) {
 312                 BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds "
 313                         "from origin for given clock class: "
 314                         "value overflows the signed 64-bit integer range: "
 315                         "%![cc-]+K, cycles=%" PRIu64,
 316                         clock_class, cycles);
 317                 ret = BT_FUNC_STATUS_OVERFLOW_ERROR;
 318         }
 319
 320         return ret;
 321 }
 322
 323 const struct bt_value *bt_clock_class_borrow_user_attributes_const(
 324                 const struct bt_clock_class *clock_class)
 325 {
 326         BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
 327         return clock_class->user_attributes;
 328 }
 329
 330 struct bt_value *bt_clock_class_borrow_user_attributes(
 331                 struct bt_clock_class *clock_class)
 332 {
 333         return (void *) bt_clock_class_borrow_user_attributes_const(
 334                 (void *) clock_class);
 335 }
 336
 337 void bt_clock_class_set_user_attributes(
 338                 struct bt_clock_class *clock_class,
 339                 const struct bt_value *user_attributes)
 340 {
 341         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 342         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
 343         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
 344                 "User attributes object is not a map value object.");
 345         BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
 346         bt_object_put_ref_no_null_check(clock_class->user_attributes);
 347         clock_class->user_attributes = (void *) user_attributes;
 348         bt_object_get_ref_no_null_check(clock_class->user_attributes);
 349 }
 350
 351 void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
 352 {
 353         bt_object_get_ref(clock_class);
 354 }
 355
 356 void bt_clock_class_put_ref(const struct bt_clock_class *clock_class)
 357 {
 358         bt_object_put_ref(clock_class);
 359 }