Cleanup: add `#include <stdbool.h>` whenever `bool` type is used
[babeltrace.git] / src / lib / trace-ir / clock-class.c
CommitLineData
273b65be 1/*
e2f7325d 2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
de9dd397 3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be
JG
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
350ad6c1 24#define BT_LOG_TAG "LIB/CLOCK-CLASS"
c2d9d9cf 25#include "lib/logging.h"
0f5e83e5 26
578e048b 27#include "lib/assert-pre.h"
6162e6b7 28#include "common/uuid.h"
3fadfbc0
MJ
29#include <babeltrace2/trace-ir/clock-class-const.h>
30#include <babeltrace2/trace-ir/clock-class.h>
578e048b
MJ
31#include "clock-class.h"
32#include "clock-snapshot.h"
33#include "utils.h"
34#include "compat/compiler.h"
3fadfbc0 35#include <babeltrace2/types.h>
578e048b 36#include "compat/string.h"
273b65be 37#include <inttypes.h>
c4f23e30 38#include <stdbool.h>
578e048b
MJ
39#include "lib/object.h"
40#include "common/assert.h"
d24d5663 41#include "lib/func-status.h"
c6962c96 42#include "lib/value.h"
5134570b 43
bdb288b3
PP
44#define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \
45 BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc))
312c056a
PP
46
47static
44c440bc 48void destroy_clock_class(struct bt_object *obj)
c06116f3 49{
44c440bc 50 struct bt_clock_class *clock_class = (void *) obj;
c06116f3 51
44c440bc 52 BT_LIB_LOGD("Destroying clock class: %!+K", clock_class);
c6962c96 53 BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes);
273b65be 54
44c440bc
PP
55 if (clock_class->name.str) {
56 g_string_free(clock_class->name.str, TRUE);
238b7404
PP
57 clock_class->name.str = NULL;
58 clock_class->name.value = NULL;
5134570b
PP
59 }
60
44c440bc
PP
61 if (clock_class->description.str) {
62 g_string_free(clock_class->description.str, TRUE);
238b7404
PP
63 clock_class->description.str = NULL;
64 clock_class->description.value = NULL;
273b65be
JG
65 }
66
605e1019 67 bt_object_pool_finalize(&clock_class->cs_pool);
44c440bc 68 g_free(clock_class);
4c426c17
JG
69}
70
f3534905 71static
605e1019 72void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot,
44c440bc 73 struct bt_clock_class *clock_class)
f3534905 74{
605e1019 75 bt_clock_snapshot_destroy(clock_snapshot);
f3534905
PP
76}
77
44c440bc
PP
78static inline
79void set_base_offset(struct bt_clock_class *clock_class)
312c056a 80{
0f2d58c9
PP
81 clock_class->base_offset.overflows = bt_util_get_base_offset_ns(
82 clock_class->offset_seconds, clock_class->offset_cycles,
83 clock_class->frequency, &clock_class->base_offset.value_ns);
312c056a
PP
84}
85
7fcdb0a9 86struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp)
4c426c17
JG
87{
88 int ret;
50842bdc 89 struct bt_clock_class *clock_class = NULL;
4c426c17 90
7fcdb0a9 91 BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
44c440bc 92 BT_LOGD_STR("Creating default clock class object");
f3534905 93
50842bdc 94 clock_class = g_new0(struct bt_clock_class, 1);
ac0c6bdd 95 if (!clock_class) {
870631a2 96 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class.");
4c426c17
JG
97 goto error;
98 }
99
44c440bc 100 bt_object_init_shared(&clock_class->base, destroy_clock_class);
c6962c96
PP
101
102 clock_class->user_attributes = bt_value_map_create();
103 if (!clock_class->user_attributes) {
104 BT_LIB_LOGE_APPEND_CAUSE(
105 "Failed to create a map value object.");
106 goto error;
107 }
108
44c440bc
PP
109 clock_class->name.str = g_string_new(NULL);
110 if (!clock_class->name.str) {
870631a2 111 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
44c440bc
PP
112 goto error;
113 }
85380e99 114
44c440bc
PP
115 clock_class->description.str = g_string_new(NULL);
116 if (!clock_class->description.str) {
870631a2 117 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
44c440bc 118 goto error;
273b65be
JG
119 }
120
44c440bc 121 clock_class->frequency = UINT64_C(1000000000);
5552377a 122 clock_class->origin_is_unix_epoch = BT_TRUE;
44c440bc 123 set_base_offset(clock_class);
605e1019
PP
124 ret = bt_object_pool_initialize(&clock_class->cs_pool,
125 (bt_object_pool_new_object_func) bt_clock_snapshot_new,
312c056a 126 (bt_object_pool_destroy_object_func)
605e1019 127 free_clock_snapshot,
312c056a
PP
128 clock_class);
129 if (ret) {
870631a2
PP
130 BT_LIB_LOGE_APPEND_CAUSE(
131 "Failed to initialize clock snapshot pool: ret=%d",
312c056a
PP
132 ret);
133 goto error;
134 }
135
44c440bc
PP
136 BT_LIB_LOGD("Created clock class object: %!+K", clock_class);
137 goto end;
138
273b65be 139error:
65300d60 140 BT_OBJECT_PUT_REF_AND_RESET(clock_class);
87d76bb1
JG
141
142end:
40f4ba76 143 return clock_class;
87d76bb1
JG
144}
145
40f4ba76 146const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class)
87d76bb1 147{
bdb288b3 148 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
44c440bc
PP
149 return clock_class->name.value;
150}
87d76bb1 151
d24d5663 152enum bt_clock_class_set_name_status bt_clock_class_set_name(
8c41fd73 153 struct bt_clock_class *clock_class, const char *name)
44c440bc
PP
154{
155 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
156 BT_ASSERT_PRE_NON_NULL(name, "Name");
bdb288b3 157 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
44c440bc
PP
158 g_string_assign(clock_class->name.str, name);
159 clock_class->name.value = clock_class->name.str->str;
3f7d4d90 160 BT_LIB_LOGD("Set clock class's name: %!+K", clock_class);
d24d5663 161 return BT_FUNC_STATUS_OK;
44c440bc 162}
87d76bb1 163
40f4ba76
PP
164const char *bt_clock_class_get_description(
165 const struct bt_clock_class *clock_class)
44c440bc 166{
bdb288b3 167 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
44c440bc 168 return clock_class->description.value;
273b65be
JG
169}
170
d24d5663 171enum bt_clock_class_set_description_status bt_clock_class_set_description(
8c41fd73 172 struct bt_clock_class *clock_class, const char *descr)
273b65be 173{
44c440bc
PP
174 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
175 BT_ASSERT_PRE_NON_NULL(descr, "Description");
bdb288b3 176 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
44c440bc
PP
177 g_string_assign(clock_class->description.str, descr);
178 clock_class->description.value = clock_class->description.str->str;
3f7d4d90 179 BT_LIB_LOGD("Set clock class's description: %!+K",
44c440bc 180 clock_class);
d24d5663 181 return BT_FUNC_STATUS_OK;
273b65be
JG
182}
183
40f4ba76 184uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class)
87d76bb1 185{
bdb288b3 186 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
44c440bc 187 return clock_class->frequency;
87d76bb1
JG
188}
189
40f4ba76 190void bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
44c440bc 191 uint64_t frequency)
273b65be 192{
44c440bc 193 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
bdb288b3 194 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
44c440bc
PP
195 BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0,
196 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64,
197 clock_class, frequency);
198 BT_ASSERT_PRE(clock_class->offset_cycles < frequency,
199 "Offset (cycles) is greater than clock class's frequency: "
200 "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency);
201 clock_class->frequency = frequency;
202 set_base_offset(clock_class);
3f7d4d90 203 BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class);
273b65be
JG
204}
205
40f4ba76 206uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class)
87d76bb1 207{
bdb288b3 208 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
44c440bc 209 return clock_class->precision;
87d76bb1
JG
210}
211
40f4ba76 212void bt_clock_class_set_precision(struct bt_clock_class *clock_class,
ac0c6bdd 213 uint64_t precision)
273b65be 214{
44c440bc 215 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
bdb288b3 216 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
44c440bc
PP
217 BT_ASSERT_PRE(precision != UINT64_C(-1),
218 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64,
219 clock_class, precision);
ac0c6bdd 220 clock_class->precision = precision;
3f7d4d90 221 BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class);
273b65be
JG
222}
223
40f4ba76 224void bt_clock_class_get_offset(const struct bt_clock_class *clock_class,
44c440bc 225 int64_t *seconds, uint64_t *cycles)
87d76bb1 226{
bdb288b3
PP
227 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
228 BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)");
229 BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)");
44c440bc
PP
230 *seconds = clock_class->offset_seconds;
231 *cycles = clock_class->offset_cycles;
87d76bb1
JG
232}
233
40f4ba76 234void bt_clock_class_set_offset(struct bt_clock_class *clock_class,
44c440bc 235 int64_t seconds, uint64_t cycles)
273b65be 236{
44c440bc 237 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
bdb288b3 238 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
44c440bc
PP
239 BT_ASSERT_PRE(cycles < clock_class->frequency,
240 "Offset (cycles) is greater than clock class's frequency: "
241 "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles);
242 clock_class->offset_seconds = seconds;
243 clock_class->offset_cycles = cycles;
244 set_base_offset(clock_class);
3f7d4d90 245 BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class);
273b65be
JG
246}
247
5552377a 248bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class)
87d76bb1 249{
bdb288b3 250 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
5552377a 251 return (bool) clock_class->origin_is_unix_epoch;
87d76bb1
JG
252}
253
5552377a
PP
254void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class,
255 bt_bool origin_is_unix_epoch)
273b65be 256{
44c440bc 257 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
bdb288b3 258 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
5552377a 259 clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch;
3f7d4d90 260 BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
44c440bc 261 clock_class);
273b65be
JG
262}
263
40f4ba76 264bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class)
85b743f4 265{
bdb288b3 266 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
44c440bc 267 return clock_class->uuid.value;
85b743f4
JG
268}
269
40f4ba76 270void bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
44c440bc 271 bt_uuid uuid)
85b743f4 272{
44c440bc
PP
273 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
274 BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
bdb288b3 275 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
6162e6b7 276 bt_uuid_copy(clock_class->uuid.uuid, uuid);
44c440bc 277 clock_class->uuid.value = clock_class->uuid.uuid;
3f7d4d90 278 BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class);
312c056a
PP
279}
280
281BT_HIDDEN
40f4ba76 282void _bt_clock_class_freeze(const struct bt_clock_class *clock_class)
312c056a 283{
312c056a 284 BT_ASSERT(clock_class);
6f57e458 285
44c440bc
PP
286 if (clock_class->frozen) {
287 return;
93dda901
PP
288 }
289
c6962c96
PP
290 BT_LIB_LOGD("Freezing clock class's user attributes: %!+v",
291 clock_class->user_attributes);
292 bt_value_freeze(clock_class->user_attributes);
44c440bc 293 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class);
40f4ba76 294 ((struct bt_clock_class *) clock_class)->frozen = 1;
93dda901 295}
312c056a 296
d24d5663
PP
297enum bt_clock_class_cycles_to_ns_from_origin_status
298bt_clock_class_cycles_to_ns_from_origin(
40f4ba76 299 const struct bt_clock_class *clock_class,
312c056a
PP
300 uint64_t cycles, int64_t *ns)
301{
302 int ret;
312c056a 303
bdb288b3
PP
304 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
305 BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)");
0f2d58c9 306 ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns);
312c056a 307 if (ret) {
bc3d9692 308 BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds "
44c440bc
PP
309 "from origin for given clock class: "
310 "value overflows the signed 64-bit integer range: "
311 "%![cc-]+K, cycles=%" PRIu64,
312 clock_class, cycles);
520cdc82 313 ret = BT_FUNC_STATUS_OVERFLOW_ERROR;
312c056a
PP
314 }
315
312c056a
PP
316 return ret;
317}
c5b9b441 318
c6962c96
PP
319const struct bt_value *bt_clock_class_borrow_user_attributes_const(
320 const struct bt_clock_class *clock_class)
321{
322 BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class");
323 return clock_class->user_attributes;
324}
325
326struct bt_value *bt_clock_class_borrow_user_attributes(
327 struct bt_clock_class *clock_class)
328{
329 return (void *) bt_clock_class_borrow_user_attributes_const(
330 (void *) clock_class);
331}
332
333void bt_clock_class_set_user_attributes(
334 struct bt_clock_class *clock_class,
335 const struct bt_value *user_attributes)
336{
337 BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
338 BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
339 BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
340 "User attributes object is not a map value object.");
341 BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class);
6871026b 342 bt_object_put_ref_no_null_check(clock_class->user_attributes);
c6962c96 343 clock_class->user_attributes = (void *) user_attributes;
6871026b 344 bt_object_get_ref_no_null_check(clock_class->user_attributes);
c6962c96
PP
345}
346
c5b9b441
PP
347void bt_clock_class_get_ref(const struct bt_clock_class *clock_class)
348{
349 bt_object_get_ref(clock_class);
350}
351
352void bt_clock_class_put_ref(const struct bt_clock_class *clock_class)
353{
354 bt_object_put_ref(clock_class);
355}
This page took 0.101218 seconds and 4 git commands to generate.