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         gchar *name;
  31         gchar *description;
  32
  33         uint64_t frequency;
  34         uint64_t precision;
  35         int64_t offset_seconds;
  36         uint64_t offset_cycles;
  37
  38         struct {
  39                 bt_uuid_t uuid;
  40
  41                 /* NULL or `uuid` above */
  42                 bt_uuid value;
  43         } uuid;
  44
  45         bool origin_is_unix_epoch;
  46
  47         /*
  48          * This is computed every time you call
  49          * bt_clock_class_set_frequency() or
  50          * bt_clock_class_set_offset(), as well as initially. It is the
  51          * base offset in nanoseconds including both `offset_seconds`
  52          * and `offset_cycles` above in the result. It is used to
  53          * accelerate future calls to
  54          * bt_clock_snapshot_get_ns_from_origin() and
  55          * bt_clock_class_cycles_to_ns_from_origin().
  56          *
  57          * `overflows` is true if the base offset cannot be computed
  58          * because of an overflow.
  59          */
  60         struct {
  61                 int64_t value_ns;
  62                 bool overflows;
  63         } base_offset;
  64
  65         /* Pool of `struct bt_clock_snapshot *` */
  66         struct bt_object_pool cs_pool;
  67
  68         bool frozen;
  69 };
  70
  71 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
  72
  73 #ifdef BT_DEV_MODE
  74 # define bt_clock_class_freeze          _bt_clock_class_freeze
  75 #else
  76 # define bt_clock_class_freeze(_cc)
  77 #endif
  78
  79 bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
  80
  81 static inline
  82 int bt_clock_class_clock_value_from_ns_from_origin(
  83                 struct bt_clock_class *cc, int64_t ns_from_origin,
  84                 uint64_t *raw_value)
  85 {
  86         BT_ASSERT_DBG(cc);
  87         return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
  88                 cc->offset_cycles, cc->frequency, ns_from_origin,
  89                 raw_value) ? BT_FUNC_STATUS_OVERFLOW_ERROR : BT_FUNC_STATUS_OK;
  90 }
  91
  92 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */