include/babeltrace2/trace-ir/clock-snapshot-internal.h

   1 #ifndef BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <babeltrace2/babeltrace-internal.h>
  27 #include <babeltrace2/object-internal.h>
  28 #include <babeltrace2/trace-ir/clock-class-internal.h>
  29 #include <babeltrace2/trace-ir/utils-internal.h>
  30 #include <stdbool.h>
  31 #include <stdint.h>
  32
  33 struct bt_clock_class;
  34
  35 struct bt_clock_snapshot {
  36         struct bt_object base;
  37         struct bt_clock_class *clock_class;
  38         uint64_t value_cycles;
  39         bool ns_from_origin_overflows;
  40         int64_t ns_from_origin;
  41         bool is_set;
  42 };
  43
  44 static inline
  45 void bt_clock_snapshot_set(struct bt_clock_snapshot *clock_snapshot)
  46 {
  47         BT_ASSERT(clock_snapshot);
  48         clock_snapshot->is_set = true;
  49 }
  50
  51 static inline
  52 void bt_clock_snapshot_reset(struct bt_clock_snapshot *clock_snapshot)
  53 {
  54         BT_ASSERT(clock_snapshot);
  55         clock_snapshot->is_set = false;
  56 }
  57
  58 static inline
  59 void set_ns_from_origin(struct bt_clock_snapshot *clock_snapshot)
  60 {
  61         if (bt_util_ns_from_origin_clock_class(clock_snapshot->clock_class,
  62                         clock_snapshot->value_cycles,
  63                         &clock_snapshot->ns_from_origin)) {
  64                 clock_snapshot->ns_from_origin_overflows = true;
  65         }
  66 }
  67
  68 static inline
  69 void bt_clock_snapshot_set_raw_value(struct bt_clock_snapshot *clock_snapshot,
  70                 uint64_t cycles)
  71 {
  72         BT_ASSERT(clock_snapshot);
  73         clock_snapshot->value_cycles = cycles;
  74         set_ns_from_origin(clock_snapshot);
  75         bt_clock_snapshot_set(clock_snapshot);
  76 }
  77
  78 BT_HIDDEN
  79 void bt_clock_snapshot_destroy(struct bt_clock_snapshot *clock_snapshot);
  80
  81 BT_HIDDEN
  82 struct bt_clock_snapshot *bt_clock_snapshot_new(struct bt_clock_class *clock_class);
  83
  84 BT_HIDDEN
  85 struct bt_clock_snapshot *bt_clock_snapshot_create(
  86                 struct bt_clock_class *clock_class);
  87
  88 BT_HIDDEN
  89 void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot);
  90
  91 #endif /* BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H */