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/object-pool-internal.h>
  31 #include <babeltrace/compat/uuid-internal.h>
  32 #include <babeltrace/types.h>
  33 #include <babeltrace/property-internal.h>
  34 #include <stdbool.h>
  35 #include <stdint.h>
  36 #include <glib.h>
  37
  38 struct bt_clock_class {
  39         struct bt_object base;
  40
  41         struct {
  42                 GString *str;
  43
  44                 /* NULL or `str->str` above */
  45                 const char *value;
  46         } name;
  47
  48         struct {
  49                 GString *str;
  50
  51                 /* NULL or `str->str` above */
  52                 const char *value;
  53         } description;
  54
  55         uint64_t frequency;
  56         uint64_t precision;
  57         int64_t offset_seconds;
  58         uint64_t offset_cycles;
  59
  60         struct {
  61                 uint8_t uuid[BABELTRACE_UUID_LEN];
  62
  63                 /* NULL or `uuid` above */
  64                 bt_uuid value;
  65         } uuid;
  66
  67         bool is_absolute;
  68
  69         /*
  70          * This is computed every time you call
  71          * bt_clock_class_set_frequency() or
  72          * bt_clock_class_set_offset(), as well as initially. It is the
  73          * base offset in nanoseconds including both `offset_seconds`
  74          * and `offset_cycles` above in the result. It is used to
  75          * accelerate future calls to
  76          * bt_clock_value_get_ns_from_origin() and
  77          * bt_clock_class_cycles_to_ns_from_origin().
  78          *
  79          * `overflows` is true if the base offset cannot be computed
  80          * because of an overflow.
  81          */
  82         struct {
  83                 int64_t value_ns;
  84                 bool overflows;
  85         } base_offset;
  86
  87         /* Pool of `struct bt_clock_value *` */
  88         struct bt_object_pool cv_pool;
  89
  90         bool frozen;
  91 };
  92
  93 BT_HIDDEN
  94 void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
  95
  96 #ifdef BT_DEV_MODE
  97 # define bt_clock_class_freeze          _bt_clock_class_freeze
  98 #else
  99 # define bt_clock_class_freeze(_cc)
 100 #endif
 101
 102 BT_HIDDEN
 103 bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
 104
 105 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */