2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
9 #define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
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"
22 #include "lib/func-status.h"
24 struct bt_clock_class
{
25 struct bt_object base
;
28 struct bt_value
*user_attributes
;
33 /* NULL or `str->str` above */
40 /* NULL or `str->str` above */
46 int64_t offset_seconds
;
47 uint64_t offset_cycles
;
52 /* NULL or `uuid` above */
56 bool origin_is_unix_epoch
;
59 * This is computed every time you call
60 * bt_clock_class_set_frequency() or
61 * bt_clock_class_set_offset(), as well as initially. It is the
62 * base offset in nanoseconds including both `offset_seconds`
63 * and `offset_cycles` above in the result. It is used to
64 * accelerate future calls to
65 * bt_clock_snapshot_get_ns_from_origin() and
66 * bt_clock_class_cycles_to_ns_from_origin().
68 * `overflows` is true if the base offset cannot be computed
69 * because of an overflow.
76 /* Pool of `struct bt_clock_snapshot *` */
77 struct bt_object_pool cs_pool
;
82 void _bt_clock_class_freeze(const struct bt_clock_class
*clock_class
);
85 # define bt_clock_class_freeze _bt_clock_class_freeze
87 # define bt_clock_class_freeze(_cc)
90 bt_bool
bt_clock_class_is_valid(struct bt_clock_class
*clock_class
);
93 int bt_clock_class_clock_value_from_ns_from_origin(
94 struct bt_clock_class
*cc
, int64_t ns_from_origin
,
98 return bt_common_clock_value_from_ns_from_origin(cc
->offset_seconds
,
99 cc
->offset_cycles
, cc
->frequency
, ns_from_origin
,
100 raw_value
) ? BT_FUNC_STATUS_OVERFLOW_ERROR
: BT_FUNC_STATUS_OK
;
103 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */