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 "CLOCK-CLASS"
  25 #include <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/assert-pre-internal.h>
  28 #include <babeltrace/compat/uuid-internal.h>
  29 #include <babeltrace/trace-ir/clock-class-internal.h>
  30 #include <babeltrace/trace-ir/clock-value-internal.h>
  31 #include <babeltrace/trace-ir/utils-internal.h>
  32 #include <babeltrace/compiler-internal.h>
  33 #include <babeltrace/types.h>
  34 #include <babeltrace/compat/string-internal.h>
  35 #include <inttypes.h>
  36 #include <babeltrace/object-internal.h>
  37 #include <babeltrace/assert-internal.h>
  38
  39 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
  40         BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
  41
  42 static
  43 void destroy_clock_class(struct bt_object *obj)
  44 {
  45         struct bt_clock_class *clock_class = (void *) obj;
  46
  47         BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
  48
  49         if (clock_class->name.str) {
  50                 g_string_free(clock_class->name.str, TRUE);
  51                 clock_class->name.str = NULL;
  52                 clock_class->name.value = NULL;
  53         }
  54
  55         if (clock_class->description.str) {
  56                 g_string_free(clock_class->description.str, TRUE);
  57                 clock_class->description.str = NULL;
  58                 clock_class->description.value = NULL;
  59         }
  60
  61         bt_object_pool_finalize(&clock_class->cv_pool);
  62         g_free(clock_class);
  63 }
  64
  65 static
  66 void free_clock_value(struct bt_clock_value *clock_value,
  67                 struct bt_clock_class *clock_class)
  68 {
  69         bt_clock_value_destroy(clock_value);
  70 }
  71
  72 static inline
  73 void set_base_offset(struct bt_clock_class *clock_class)
  74 {
  75         uint64_t offset_cycles_ns;
  76
  77         /* Initialize nanosecond timestamp to clock's offset in seconds */
  78         if (clock_class->offset_seconds <= (INT64_MIN / INT64_C(1000000000) - 1) ||
  79                         clock_class->offset_seconds >= (INT64_MAX / INT64_C(1000000000)) - 1) {
  80                 /*
  81                  * Overflow: offset in seconds converted to nanoseconds
  82                  * is outside the int64_t range. We also subtract 1 here
  83                  * to leave "space" for the offset in cycles converted
  84                  * to nanoseconds (which is always less than 1 second by
  85                  * contract).
  86                  */
  87                 clock_class->base_offset.overflows = true;
  88                 goto end;
  89         }
  90
  91         /* Offset (seconds) to nanoseconds */
  92         clock_class->base_offset.value_ns = clock_class->offset_seconds *
  93                 INT64_C(1000000000);
  94
  95         /* Add offset in cycles */
  96         BT_ASSERT(clock_class->offset_cycles < clock_class->frequency);
  97         offset_cycles_ns = bt_util_ns_from_value(clock_class->frequency,
  98                 clock_class->offset_cycles);
  99         BT_ASSERT(offset_cycles_ns < 1000000000);
 100         clock_class->base_offset.value_ns += (int64_t) offset_cycles_ns;
 101         clock_class->base_offset.overflows = false;
 102
 103 end:
 104         return;
 105 }
 106
 107 struct bt_clock_class *bt_clock_class_create(void)
 108 {
 109         int ret;
 110         struct bt_clock_class *clock_class = NULL;
 111
 112         BT_LOGD_STR("Creating default clock class object");
 113
 114         clock_class = g_new0(struct bt_clock_class, 1);
 115         if (!clock_class) {
 116                 BT_LOGE_STR("Failed to allocate one clock class.");
 117                 goto error;
 118         }
 119
 120         bt_object_init_shared(&clock_class->base, destroy_clock_class);
 121         clock_class->name.str = g_string_new(NULL);
 122         if (!clock_class->name.str) {
 123                 BT_LOGE_STR("Failed to allocate a GString.");
 124                 goto error;
 125         }
 126
 127         clock_class->description.str = g_string_new(NULL);
 128         if (!clock_class->description.str) {
 129                 BT_LOGE_STR("Failed to allocate a GString.");
 130                 goto error;
 131         }
 132
 133         clock_class->frequency = UINT64_C(1000000000);
 134         clock_class->is_absolute = BT_TRUE;
 135         set_base_offset(clock_class);
 136         ret = bt_object_pool_initialize(&clock_class->cv_pool,
 137                 (bt_object_pool_new_object_func) bt_clock_value_new,
 138                 (bt_object_pool_destroy_object_func)
 139                         free_clock_value,
 140                 clock_class);
 141         if (ret) {
 142                 BT_LOGE("Failed to initialize clock value pool: ret=%d",
 143                         ret);
 144                 goto error;
 145         }
 146
 147         BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
 148         goto end;
 149
 150 error:
 151         BT_OBJECT_PUT_REF_AND_RESET(clock_class);
 152
 153 end:
 154         return clock_class;
 155 }
 156
 157 const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 158 {
 159         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 160         return clock_class->name.value;
 161 }
 162
 163 int bt_clock_class_set_name(struct bt_clock_class *clock_class,
 164                 const char *name)
 165 {
 166         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 167         BT_ASSERT_PRE_NON_NULL(name, "Name");
 168         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 169         g_string_assign(clock_class->name.str, name);
 170         clock_class->name.value = clock_class->name.str->str;
 171         BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
 172         return 0;
 173 }
 174
 175 const char *bt_clock_class_get_description(
 176                 const struct bt_clock_class *clock_class)
 177 {
 178         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 179         return clock_class->description.value;
 180 }
 181
 182 int bt_clock_class_set_description(struct bt_clock_class *clock_class,
 183                 const char *descr)
 184 {
 185         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 186         BT_ASSERT_PRE_NON_NULL(descr, "Description");
 187         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 188         g_string_assign(clock_class->description.str, descr);
 189         clock_class->description.value = clock_class->description.str->str;
 190         BT_LIB_LOGV("Set clock class's description: %!+K",
 191                 clock_class);
 192         return 0;
 193 }
 194
 195 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
 196 {
 197         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 198         return clock_class->frequency;
 199 }
 200
 201 void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
 202                 uint64_t frequency)
 203 {
 204         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 205         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 206         BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
 207                 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
 208                 clock_class, frequency);
 209         BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
 210                 "Offset (cycles) is greater than clock class's frequency: "
 211                 "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
 212         clock_class->frequency = frequency;
 213         set_base_offset(clock_class);
 214         BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class);
 215 }
 216
 217 uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
 218 {
 219         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 220         return clock_class->precision;
 221 }
 222
 223 void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
 224                 uint64_t precision)
 225 {
 226         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 227         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 228         BT_ASSERT_PRE(precision != UINT64_C(-1),
 229                 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
 230                 clock_class, precision);
 231         clock_class->precision = precision;
 232         BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
 233 }
 234
 235 void bt_clock_class_get_offset(const struct bt_clock_class *clock_class,
 236                 int64_t *seconds, uint64_t *cycles)
 237 {
 238         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 239         BT_ASSERT_PRE_NON_NULL(seconds, "Seconds (output)");
 240         BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
 241         *seconds = clock_class->offset_seconds;
 242         *cycles = clock_class->offset_cycles;
 243 }
 244
 245 void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
 246                 int64_t seconds, uint64_t cycles)
 247 {
 248         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 249         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 250         BT_ASSERT_PRE(cycles < clock_class->frequency,
 251                 "Offset (cycles) is greater than clock class's frequency: "
 252                 "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
 253         clock_class->offset_seconds = seconds;
 254         clock_class->offset_cycles = cycles;
 255         set_base_offset(clock_class);
 256         BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
 257 }
 258
 259 bt_bool bt_clock_class_is_absolute(const struct bt_clock_class *clock_class)
 260 {
 261         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 262         return (bool) clock_class->is_absolute;
 263 }
 264
 265 void bt_clock_class_set_is_absolute(struct bt_clock_class *clock_class,
 266                 bt_bool is_absolute)
 267 {
 268         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 269         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 270         clock_class->is_absolute = (bool) is_absolute;
 271         BT_LIB_LOGV("Set clock class's absolute property: %!+K",
 272                 clock_class);
 273 }
 274
 275 bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
 276 {
 277         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 278         return clock_class->uuid.value;
 279 }
 280
 281 void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
 282                 bt_uuid uuid)
 283 {
 284         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 285         BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
 286         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 287         memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
 288         clock_class->uuid.value = clock_class->uuid.uuid;
 289         BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class);
 290 }
 291
 292 BT_HIDDEN
 293 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
 294 {
 295         BT_ASSERT(clock_class);
 296
 297         if (clock_class->frozen) {
 298                 return;
 299         }
 300
 301         BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
 302         ((struct bt_clock_class *) clock_class)->frozen = 1;
 303 }
 304
 305 int bt_clock_class_cycles_to_ns_from_origin(
 306                 const struct bt_clock_class *clock_class,
 307                 uint64_t cycles, int64_t *ns)
 308 {
 309         int ret;
 310
 311         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 312         BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
 313         ret = bt_util_ns_from_origin(clock_class, cycles, ns);
 314         if (ret) {
 315                 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
 316                         "from origin for given clock class: "
 317                         "value overflows the signed 64-bit integer range: "
 318                         "%![cc-]+K, cycles=%" PRIu64,
 319                         clock_class, cycles);
 320         }
 321
 322         return ret;
 323 }
 324
 325 void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
 326 {
 327         bt_object_get_ref(clock_class);
 328 }
 329
 330 void bt_clock_class_put_ref(const struct bt_clock_class *clock_class)
 331 {
 332         bt_object_put_ref(clock_class);
 333 }