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

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   5  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  */
   7
   8 #ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
   9 #define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
  10
  11 #include <babeltrace2/trace-ir/clock-class.h>
  12 #include "lib/object.h"
  13 #include "common/common.h"
  14 #include "lib/object-pool.h"
  15 #include "common/uuid.h"
  16 #include <babeltrace2/types.h>
  17 #include "common/assert.h"
  18 #include <stdbool.h>
  19 #include <stdint.h>
  20 #include <glib.h>
  21
  22 #include "lib/func-status.h"
  23
  24 struct bt_clock_class {
  25         struct bt_object base;
  26
  27         /* Owned by this */
  28         struct bt_value *user_attributes;
  29
  30         struct {
  31                 GString *str;
  32
  33                 /* NULL or `str->str` above */
  34                 const char *value;
  35         } name;
  36
  37         struct {
  38                 GString *str;
  39
  40                 /* NULL or `str->str` above */
  41                 const char *value;
  42         } description;
  43
  44         uint64_t frequency;
  45         uint64_t precision;
  46         int64_t offset_seconds;
  47         uint64_t offset_cycles;
  48
  49         struct {
  50                 bt_uuid_t uuid;
  51
  52                 /* NULL or `uuid` above */
  53                 bt_uuid value;
  54         } uuid;
  55
  56         bool origin_is_unix_epoch;
  57
  58         /*
  59          * This is computed every time you call
  60          * bt_clock_class_set_frequency() or
  61          * bt_clock_class_set_offset(), as well as initially. It is the
  62          * base offset in nanoseconds including both `offset_seconds`
  63          * and `offset_cycles` above in the result. It is used to
  64          * accelerate future calls to
  65          * bt_clock_snapshot_get_ns_from_origin() and
  66          * bt_clock_class_cycles_to_ns_from_origin().
  67          *
  68          * `overflows` is true if the base offset cannot be computed
  69          * because of an overflow.
  70          */
  71         struct {
  72                 int64_t value_ns;
  73                 bool overflows;
  74         } base_offset;
  75
  76         /* Pool of `struct bt_clock_snapshot *` */
  77         struct bt_object_pool cs_pool;
  78
  79         bool frozen;
  80 };
  81
  82 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
  83
  84 #ifdef BT_DEV_MODE
  85 # define bt_clock_class_freeze          _bt_clock_class_freeze
  86 #else
  87 # define bt_clock_class_freeze(_cc)
  88 #endif
  89
  90 bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
  91
  92 static inline
  93 int bt_clock_class_clock_value_from_ns_from_origin(
  94                 struct bt_clock_class *cc, int64_t ns_from_origin,
  95                 uint64_t *raw_value)
  96 {
  97         BT_ASSERT_DBG(cc);
  98         return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
  99                 cc->offset_cycles, cc->frequency, ns_from_origin,
 100                 raw_value) ? BT_FUNC_STATUS_OVERFLOW_ERROR : BT_FUNC_STATUS_OK;
 101 }
 102
 103 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */