lib: Reset libbabeltrace2 to SONANE 0
[babeltrace.git] / include / babeltrace / trace-ir / clock-class-internal.h
CommitLineData
56e18c4c
PP
1#ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
2#define BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H
273b65be
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
de9dd397 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be 7 *
273b65be
JG
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
56e18c4c 27#include <babeltrace/trace-ir/clock-class.h>
83509119 28#include <babeltrace/object-internal.h>
273b65be 29#include <babeltrace/babeltrace-internal.h>
7de0e49a 30#include <babeltrace/common-internal.h>
312c056a 31#include <babeltrace/object-pool-internal.h>
3d9990ac 32#include <babeltrace/compat/uuid-internal.h>
c55a9f58 33#include <babeltrace/types.h>
44c440bc 34#include <babeltrace/property-internal.h>
5b9e151d 35#include <babeltrace/assert-internal.h>
036a7cac
PP
36#include <stdbool.h>
37#include <stdint.h>
c55a9f58 38#include <glib.h>
273b65be 39
50842bdc 40struct bt_clock_class {
83509119 41 struct bt_object base;
44c440bc
PP
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
273b65be
JG
57 uint64_t frequency;
58 uint64_t precision;
44c440bc
PP
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
5552377a 69 bool origin_is_unix_epoch;
cfeb617e 70
273b65be 71 /*
44c440bc
PP
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
605e1019 78 * bt_clock_snapshot_get_ns_from_origin() and
44c440bc
PP
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.
273b65be 83 */
44c440bc
PP
84 struct {
85 int64_t value_ns;
86 bool overflows;
87 } base_offset;
312c056a 88
605e1019
PP
89 /* Pool of `struct bt_clock_snapshot *` */
90 struct bt_object_pool cs_pool;
44c440bc
PP
91
92 bool frozen;
273b65be
JG
93};
94
95BT_HIDDEN
40f4ba76 96void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
273b65be 97
44c440bc
PP
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
24626e8b 103
93dda901 104BT_HIDDEN
44c440bc 105bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
93dda901 106
5b9e151d
PP
107static inline
108int 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{
5b9e151d 112 BT_ASSERT(cc);
7de0e49a
PP
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);
5b9e151d
PP
117}
118
56e18c4c 119#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
This page took 0.057774 seconds and 4 git commands to generate.