lib/trace-ir/clock-class.c

   1 /*
   2  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define BT_LOG_TAG "CLOCK-CLASS"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/compat/uuid-internal.h>
  30 #include <babeltrace/trace-ir/clock-class-internal.h>
  31 #include <babeltrace/trace-ir/clock-value-internal.h>
  32 #include <babeltrace/trace-ir/utils-internal.h>
  33 #include <babeltrace/object.h>
  34 #include <babeltrace/compiler-internal.h>
  35 #include <babeltrace/types.h>
  36 #include <babeltrace/compat/string-internal.h>
  37 #include <inttypes.h>
  38 #include <babeltrace/object-internal.h>
  39 #include <babeltrace/assert-internal.h>
  40
  41 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
  42         BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
  43
  44 static
  45 void destroy_clock_class(struct bt_object *obj)
  46 {
  47         struct bt_clock_class *clock_class = (void *) obj;
  48
  49         BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
  50
  51         if (clock_class->name.str) {
  52                 g_string_free(clock_class->name.str, TRUE);
  53                 clock_class->name.str = NULL;
  54                 clock_class->name.value = NULL;
  55         }
  56
  57         if (clock_class->description.str) {
  58                 g_string_free(clock_class->description.str, TRUE);
  59                 clock_class->description.str = NULL;
  60                 clock_class->description.value = NULL;
  61         }
  62
  63         bt_object_pool_finalize(&clock_class->cv_pool);
  64         g_free(clock_class);
  65 }
  66
  67 static
  68 void free_clock_value(struct bt_clock_value *clock_value,
  69                 struct bt_clock_class *clock_class)
  70 {
  71         bt_clock_value_destroy(clock_value);
  72 }
  73
  74 static inline
  75 void set_base_offset(struct bt_clock_class *clock_class)
  76 {
  77         uint64_t offset_cycles_ns;
  78
  79         /* Initialize nanosecond timestamp to clock's offset in seconds */
  80         if (clock_class->offset_seconds <= (INT64_MIN / INT64_C(1000000000) - 1) ||
  81                         clock_class->offset_seconds >= (INT64_MAX / INT64_C(1000000000)) - 1) {
  82                 /*
  83                  * Overflow: offset in seconds converted to nanoseconds
  84                  * is outside the int64_t range. We also subtract 1 here
  85                  * to leave "space" for the offset in cycles converted
  86                  * to nanoseconds (which is always less than 1 second by
  87                  * contract).
  88                  */
  89                 clock_class->base_offset.overflows = true;
  90                 goto end;
  91         }
  92
  93         /* Offset (seconds) to nanoseconds */
  94         clock_class->base_offset.value_ns = clock_class->offset_seconds *
  95                 INT64_C(1000000000);
  96
  97         /* Add offset in cycles */
  98         BT_ASSERT(clock_class->offset_cycles < clock_class->frequency);
  99         offset_cycles_ns = bt_util_ns_from_value(clock_class->frequency,
 100                 clock_class->offset_cycles);
 101         BT_ASSERT(offset_cycles_ns < 1000000000);
 102         clock_class->base_offset.value_ns += (int64_t) offset_cycles_ns;
 103         clock_class->base_offset.overflows = false;
 104
 105 end:
 106         return;
 107 }
 108
 109 struct bt_clock_class *bt_clock_class_create(void)
 110 {
 111         int ret;
 112         struct bt_clock_class *clock_class = NULL;
 113
 114         BT_LOGD_STR("Creating default clock class object");
 115
 116         clock_class = g_new0(struct bt_clock_class, 1);
 117         if (!clock_class) {
 118                 BT_LOGE_STR("Failed to allocate one clock class.");
 119                 goto error;
 120         }
 121
 122         bt_object_init_shared(&clock_class->base, destroy_clock_class);
 123         clock_class->name.str = g_string_new(NULL);
 124         if (!clock_class->name.str) {
 125                 BT_LOGE_STR("Failed to allocate a GString.");
 126                 goto error;
 127         }
 128
 129         clock_class->description.str = g_string_new(NULL);
 130         if (!clock_class->description.str) {
 131                 BT_LOGE_STR("Failed to allocate a GString.");
 132                 goto error;
 133         }
 134
 135         clock_class->frequency = UINT64_C(1000000000);
 136         clock_class->is_absolute = BT_TRUE;
 137         set_base_offset(clock_class);
 138         ret = bt_object_pool_initialize(&clock_class->cv_pool,
 139                 (bt_object_pool_new_object_func) bt_clock_value_new,
 140                 (bt_object_pool_destroy_object_func)
 141                         free_clock_value,
 142                 clock_class);
 143         if (ret) {
 144                 BT_LOGE("Failed to initialize clock value pool: ret=%d",
 145                         ret);
 146                 goto error;
 147         }
 148
 149         BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
 150         goto end;
 151
 152 error:
 153         BT_OBJECT_PUT_REF_AND_RESET(clock_class);
 154
 155 end:
 156         return clock_class;
 157 }
 158
 159 const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
 160 {
 161         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 162         return clock_class->name.value;
 163 }
 164
 165 int bt_clock_class_set_name(struct bt_clock_class *clock_class,
 166                 const char *name)
 167 {
 168         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 169         BT_ASSERT_PRE_NON_NULL(name, "Name");
 170         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 171         g_string_assign(clock_class->name.str, name);
 172         clock_class->name.value = clock_class->name.str->str;
 173         BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
 174         return 0;
 175 }
 176
 177 const char *bt_clock_class_get_description(
 178                 const struct bt_clock_class *clock_class)
 179 {
 180         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 181         return clock_class->description.value;
 182 }
 183
 184 int bt_clock_class_set_description(struct bt_clock_class *clock_class,
 185                 const char *descr)
 186 {
 187         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 188         BT_ASSERT_PRE_NON_NULL(descr, "Description");
 189         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 190         g_string_assign(clock_class->description.str, descr);
 191         clock_class->description.value = clock_class->description.str->str;
 192         BT_LIB_LOGV("Set clock class's description: %!+K",
 193                 clock_class);
 194         return 0;
 195 }
 196
 197 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
 198 {
 199         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 200         return clock_class->frequency;
 201 }
 202
 203 void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
 204                 uint64_t frequency)
 205 {
 206         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 207         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 208         BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
 209                 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
 210                 clock_class, frequency);
 211         BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
 212                 "Offset (cycles) is greater than clock class's frequency: "
 213                 "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
 214         clock_class->frequency = frequency;
 215         set_base_offset(clock_class);
 216         BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class);
 217 }
 218
 219 uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
 220 {
 221         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 222         return clock_class->precision;
 223 }
 224
 225 void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
 226                 uint64_t precision)
 227 {
 228         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 229         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 230         BT_ASSERT_PRE(precision != UINT64_C(-1),
 231                 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
 232                 clock_class, precision);
 233         clock_class->precision = precision;
 234         BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
 235 }
 236
 237 void bt_clock_class_get_offset(const 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_NON_NULL(seconds, "Seconds (output)");
 242         BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
 243         *seconds = clock_class->offset_seconds;
 244         *cycles = clock_class->offset_cycles;
 245 }
 246
 247 void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
 248                 int64_t seconds, uint64_t cycles)
 249 {
 250         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 251         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 252         BT_ASSERT_PRE(cycles < clock_class->frequency,
 253                 "Offset (cycles) is greater than clock class's frequency: "
 254                 "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
 255         clock_class->offset_seconds = seconds;
 256         clock_class->offset_cycles = cycles;
 257         set_base_offset(clock_class);
 258         BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
 259 }
 260
 261 bt_bool bt_clock_class_is_absolute(const struct bt_clock_class *clock_class)
 262 {
 263         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 264         return (bool) clock_class->is_absolute;
 265 }
 266
 267 void bt_clock_class_set_is_absolute(struct bt_clock_class *clock_class,
 268                 bt_bool is_absolute)
 269 {
 270         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 271         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 272         clock_class->is_absolute = (bool) is_absolute;
 273         BT_LIB_LOGV("Set clock class's absolute property: %!+K",
 274                 clock_class);
 275 }
 276
 277 bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
 278 {
 279         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 280         return clock_class->uuid.value;
 281 }
 282
 283 void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
 284                 bt_uuid uuid)
 285 {
 286         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 287         BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
 288         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 289         memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
 290         clock_class->uuid.value = clock_class->uuid.uuid;
 291         BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class);
 292 }
 293
 294 BT_HIDDEN
 295 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
 296 {
 297         BT_ASSERT(clock_class);
 298
 299         if (clock_class->frozen) {
 300                 return;
 301         }
 302
 303         BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
 304         ((struct bt_clock_class *) clock_class)->frozen = 1;
 305 }
 306
 307 int bt_clock_class_cycles_to_ns_from_origin(
 308                 const struct bt_clock_class *clock_class,
 309                 uint64_t cycles, int64_t *ns)
 310 {
 311         int ret;
 312
 313         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 314         BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
 315         ret = bt_util_ns_from_origin(clock_class, cycles, ns);
 316         if (ret) {
 317                 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
 318                         "from origin for given clock class: "
 319                         "value overflows the signed 64-bit integer range: "
 320                         "%![cc-]+K, cycles=%" PRIu64,
 321                         clock_class, cycles);
 322         }
 323
 324         return ret;
 325 }