include/babeltrace/trace-ir/clock-class-internal.h

   1 #ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <babeltrace/trace-ir/clock-class.h>
  28 #include <babeltrace/object-internal.h>
  29 #include <babeltrace/babeltrace-internal.h>
  30 #include <babeltrace/common-internal.h>
  31 #include <babeltrace/object-pool-internal.h>
  32 #include <babeltrace/compat/uuid-internal.h>
  33 #include <babeltrace/types.h>
  34 #include <babeltrace/property-internal.h>
  35 #include <babeltrace/assert-internal.h>
  36 #include <stdbool.h>
  37 #include <stdint.h>
  38 #include <glib.h>
  39
  40 struct bt_clock_class {
  41         struct bt_object base;
  42
  43         struct {
  44                 GString *str;
  45
  46                 /* NULL or `str->str` above */
  47                 const char *value;
  48         } name;
  49
  50         struct {
  51                 GString *str;
  52
  53                 /* NULL or `str->str` above */
  54                 const char *value;
  55         } description;
  56
  57         uint64_t frequency;
  58         uint64_t precision;
  59         int64_t offset_seconds;
  60         uint64_t offset_cycles;
  61
  62         struct {
  63                 uint8_t uuid[BABELTRACE_UUID_LEN];
  64
  65                 /* NULL or `uuid` above */
  66                 bt_uuid value;
  67         } uuid;
  68
  69         bool origin_is_unix_epoch;
  70
  71         /*
  72          * This is computed every time you call
  73          * bt_clock_class_set_frequency() or
  74          * bt_clock_class_set_offset(), as well as initially. It is the
  75          * base offset in nanoseconds including both `offset_seconds`
  76          * and `offset_cycles` above in the result. It is used to
  77          * accelerate future calls to
  78          * bt_clock_snapshot_get_ns_from_origin() and
  79          * bt_clock_class_cycles_to_ns_from_origin().
  80          *
  81          * `overflows` is true if the base offset cannot be computed
  82          * because of an overflow.
  83          */
  84         struct {
  85                 int64_t value_ns;
  86                 bool overflows;
  87         } base_offset;
  88
  89         /* Pool of `struct bt_clock_snapshot *` */
  90         struct bt_object_pool cs_pool;
  91
  92         bool frozen;
  93 };
  94
  95 BT_HIDDEN
  96 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
  97
  98 #ifdef BT_DEV_MODE
  99 # define bt_clock_class_freeze          _bt_clock_class_freeze
 100 #else
 101 # define bt_clock_class_freeze(_cc)
 102 #endif
 103
 104 BT_HIDDEN
 105 bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
 106
 107 static inline
 108 int bt_clock_class_clock_value_from_ns_from_origin(
 109                 struct bt_clock_class *cc, int64_t ns_from_origin,
 110                 uint64_t *raw_value)
 111 {
 112         BT_ASSERT(cc);
 113
 114         return bt_common_clock_value_from_ns_from_origin(cc->offset_seconds,
 115                 cc->offset_cycles, cc->frequency, ns_from_origin,
 116                 raw_value);
 117 }
 118
 119 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */