src/lib/trace-ir/clock-snapshot.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 "common/macros.h"
  27 #include "lib/object.h"
  28 #include <stdbool.h>
  29 #include <stdint.h>
  30
  31 #include "clock-class.h"
  32 #include "utils.h"
  33
  34 struct bt_clock_class;
  35
  36 struct bt_clock_snapshot {
  37         struct bt_object base;
  38         struct bt_clock_class *clock_class;
  39         uint64_t value_cycles;
  40         bool ns_from_origin_overflows;
  41         int64_t ns_from_origin;
  42         bool is_set;
  43 };
  44
  45 static inline
  46 void bt_clock_snapshot_set(struct bt_clock_snapshot *clock_snapshot)
  47 {
  48         BT_ASSERT(clock_snapshot);
  49         clock_snapshot->is_set = true;
  50 }
  51
  52 static inline
  53 void bt_clock_snapshot_reset(struct bt_clock_snapshot *clock_snapshot)
  54 {
  55         BT_ASSERT(clock_snapshot);
  56         clock_snapshot->is_set = false;
  57 }
  58
  59 static inline
  60 void set_ns_from_origin(struct bt_clock_snapshot *clock_snapshot)
  61 {
  62         if (bt_util_ns_from_origin_clock_class(clock_snapshot->clock_class,
  63                         clock_snapshot->value_cycles,
  64                         &clock_snapshot->ns_from_origin)) {
  65                 clock_snapshot->ns_from_origin_overflows = true;
  66         }
  67 }
  68
  69 static inline
  70 void bt_clock_snapshot_set_raw_value(struct bt_clock_snapshot *clock_snapshot,
  71                 uint64_t cycles)
  72 {
  73         BT_ASSERT(clock_snapshot);
  74         clock_snapshot->value_cycles = cycles;
  75         set_ns_from_origin(clock_snapshot);
  76         bt_clock_snapshot_set(clock_snapshot);
  77 }
  78
  79 BT_HIDDEN
  80 void bt_clock_snapshot_destroy(struct bt_clock_snapshot *clock_snapshot);
  81
  82 BT_HIDDEN
  83 struct bt_clock_snapshot *bt_clock_snapshot_new(struct bt_clock_class *clock_class);
  84
  85 BT_HIDDEN
  86 struct bt_clock_snapshot *bt_clock_snapshot_create(
  87                 struct bt_clock_class *clock_class);
  88
  89 BT_HIDDEN
  90 void bt_clock_snapshot_recycle(struct bt_clock_snapshot *clock_snapshot);
  91
  92 #endif /* BABELTRACE_TRACE_IR_CLOCK_SNAPSHOT_INTERNAL_H */