lib/trace-ir/clock-class.c

   1 /*
   2  * clock-class.c
   3  *
   4  * Babeltrace trace IR - Clock class
   5  *
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #define BT_LOG_TAG "CLOCK-CLASS"
  30 #include <babeltrace/lib-logging-internal.h>
  31
  32 #include <babeltrace/assert-pre-internal.h>
  33 #include <babeltrace/compat/uuid-internal.h>
  34 #include <babeltrace/trace-ir/clock-class-internal.h>
  35 #include <babeltrace/trace-ir/clock-value-internal.h>
  36 #include <babeltrace/trace-ir/utils-internal.h>
  37 #include <babeltrace/ref.h>
  38 #include <babeltrace/compiler-internal.h>
  39 #include <babeltrace/types.h>
  40 #include <babeltrace/compat/string-internal.h>
  41 #include <inttypes.h>
  42 #include <babeltrace/object-internal.h>
  43 #include <babeltrace/assert-internal.h>
  44
  45 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
  46         BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
  47
  48 static
  49 void destroy_clock_class(struct bt_object *obj)
  50 {
  51         struct bt_clock_class *clock_class = (void *) obj;
  52
  53         BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
  54
  55         if (clock_class->name.str) {
  56                 g_string_free(clock_class->name.str, TRUE);
  57         }
  58
  59         if (clock_class->description.str) {
  60                 g_string_free(clock_class->description.str, TRUE);
  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_PUT(clock_class);
 154
 155 end:
 156         return clock_class;
 157 }
 158
 159 const char *bt_clock_class_get_name(
 160                 struct bt_clock_class *clock_class)
 161 {
 162         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 163         return clock_class->name.value;
 164 }
 165
 166 int bt_clock_class_set_name(struct bt_clock_class *clock_class,
 167                 const char *name)
 168 {
 169         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 170         BT_ASSERT_PRE_NON_NULL(name, "Name");
 171         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 172         g_string_assign(clock_class->name.str, name);
 173         clock_class->name.value = clock_class->name.str->str;
 174         BT_LIB_LOGV("Set clock class's name: %!+K", clock_class);
 175         return 0;
 176 }
 177
 178 const char *bt_clock_class_get_description(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(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 int 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         return 0;
 218 }
 219
 220 uint64_t bt_clock_class_get_precision(struct bt_clock_class *clock_class)
 221 {
 222         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 223         return clock_class->precision;
 224 }
 225
 226 int bt_clock_class_set_precision(struct bt_clock_class *clock_class,
 227                 uint64_t precision)
 228 {
 229         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 230         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 231         BT_ASSERT_PRE(precision != UINT64_C(-1),
 232                 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
 233                 clock_class, precision);
 234         clock_class->precision = precision;
 235         BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class);
 236         return 0;
 237 }
 238
 239 void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
 240                 int64_t *seconds, uint64_t *cycles)
 241 {
 242         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 243         BT_ASSERT_PRE_NON_NULL(seconds, "Seconds (output)");
 244         BT_ASSERT_PRE_NON_NULL(cycles, "Cycles (output)");
 245         *seconds = clock_class->offset_seconds;
 246         *cycles = clock_class->offset_cycles;
 247 }
 248
 249 int bt_clock_class_set_offset(struct bt_clock_class *clock_class,
 250                 int64_t seconds, uint64_t cycles)
 251 {
 252         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 253         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 254         BT_ASSERT_PRE(cycles < clock_class->frequency,
 255                 "Offset (cycles) is greater than clock class's frequency: "
 256                 "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
 257         clock_class->offset_seconds = seconds;
 258         clock_class->offset_cycles = cycles;
 259         set_base_offset(clock_class);
 260         BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class);
 261         return 0;
 262 }
 263
 264 bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class)
 265 {
 266         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 267         return (bool) clock_class->is_absolute;
 268 }
 269
 270 int bt_clock_class_set_is_absolute(struct bt_clock_class *clock_class,
 271                 bt_bool is_absolute)
 272 {
 273         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 274         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 275         clock_class->is_absolute = (bool) is_absolute;
 276         BT_LIB_LOGV("Set clock class's absolute property: %!+K",
 277                 clock_class);
 278         return 0;
 279 }
 280
 281 bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class)
 282 {
 283         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 284         return clock_class->uuid.value;
 285 }
 286
 287 int bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
 288                 bt_uuid uuid)
 289 {
 290         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 291         BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
 292         BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class);
 293         memcpy(clock_class->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
 294         clock_class->uuid.value = clock_class->uuid.uuid;
 295         BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class);
 296         return 0;
 297 }
 298
 299 BT_HIDDEN
 300 void _bt_clock_class_freeze(struct bt_clock_class *clock_class)
 301 {
 302         BT_ASSERT(clock_class);
 303
 304         if (clock_class->frozen) {
 305                 return;
 306         }
 307
 308         BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
 309         clock_class->frozen = 1;
 310 }
 311
 312 int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class *clock_class,
 313                 uint64_t cycles, int64_t *ns)
 314 {
 315         int ret;
 316
 317         BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
 318         BT_ASSERT_PRE_NON_NULL(ns, "Nanoseconds (output)");
 319         ret = bt_util_ns_from_origin(clock_class, cycles, ns);
 320         if (ret) {
 321                 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
 322                         "from origin for given clock class: "
 323                         "value overflows the signed 64-bit integer range: "
 324                         "%![cc-]+K, cycles=%" PRIu64,
 325                         clock_class, cycles);
 326         }
 327
 328         return ret;
 329 }