lib: rename clock class's absolute property to "origin is Unix epoch"
[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>
312c056a 30#include <babeltrace/object-pool-internal.h>
3d9990ac 31#include <babeltrace/compat/uuid-internal.h>
c55a9f58 32#include <babeltrace/types.h>
44c440bc 33#include <babeltrace/property-internal.h>
036a7cac
PP
34#include <stdbool.h>
35#include <stdint.h>
c55a9f58 36#include <glib.h>
273b65be 37
50842bdc 38struct bt_clock_class {
83509119 39 struct bt_object base;
44c440bc
PP
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
273b65be
JG
55 uint64_t frequency;
56 uint64_t precision;
44c440bc
PP
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
5552377a 67 bool origin_is_unix_epoch;
cfeb617e 68
273b65be 69 /*
44c440bc
PP
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
605e1019 76 * bt_clock_snapshot_get_ns_from_origin() and
44c440bc
PP
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.
273b65be 81 */
44c440bc
PP
82 struct {
83 int64_t value_ns;
84 bool overflows;
85 } base_offset;
312c056a 86
605e1019
PP
87 /* Pool of `struct bt_clock_snapshot *` */
88 struct bt_object_pool cs_pool;
44c440bc
PP
89
90 bool frozen;
273b65be
JG
91};
92
93BT_HIDDEN
40f4ba76 94void _bt_clock_class_freeze(const struct bt_clock_class *clock_class);
273b65be 95
44c440bc
PP
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
24626e8b 101
93dda901 102BT_HIDDEN
44c440bc 103bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
93dda901 104
56e18c4c 105#endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_INTERNAL_H */
This page took 0.052234 seconds and 4 git commands to generate.