Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 5 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
6 | */ |
7 | ||
350ad6c1 | 8 | #define BT_LOG_TAG "LIB/CLOCK-CLASS" |
c2d9d9cf | 9 | #include "lib/logging.h" |
0f5e83e5 | 10 | |
d98421f2 | 11 | #include "lib/assert-cond.h" |
6162e6b7 | 12 | #include "common/uuid.h" |
3fadfbc0 | 13 | #include <babeltrace2/trace-ir/clock-class.h> |
578e048b MJ |
14 | #include "clock-class.h" |
15 | #include "clock-snapshot.h" | |
16 | #include "utils.h" | |
17 | #include "compat/compiler.h" | |
3fadfbc0 | 18 | #include <babeltrace2/types.h> |
273b65be | 19 | #include <inttypes.h> |
c4f23e30 | 20 | #include <stdbool.h> |
578e048b MJ |
21 | #include "lib/object.h" |
22 | #include "common/assert.h" | |
d24d5663 | 23 | #include "lib/func-status.h" |
c6962c96 | 24 | #include "lib/value.h" |
5134570b | 25 | |
d5b13b9b | 26 | #define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \ |
1778c2a4 PP |
27 | BT_ASSERT_PRE_DEV_HOT("clock-class", (_cc), "Clock class", \ |
28 | ": %!+K", (_cc)) | |
312c056a PP |
29 | |
30 | static | |
44c440bc | 31 | void destroy_clock_class(struct bt_object *obj) |
c06116f3 | 32 | { |
44c440bc | 33 | struct bt_clock_class *clock_class = (void *) obj; |
c06116f3 | 34 | |
44c440bc | 35 | BT_LIB_LOGD("Destroying clock class: %!+K", clock_class); |
c6962c96 | 36 | BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes); |
273b65be | 37 | |
b91e0631 SM |
38 | g_free(clock_class->name); |
39 | g_free(clock_class->description); | |
605e1019 | 40 | bt_object_pool_finalize(&clock_class->cs_pool); |
44c440bc | 41 | g_free(clock_class); |
4c426c17 JG |
42 | } |
43 | ||
f3534905 | 44 | static |
605e1019 | 45 | void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot, |
ecd7492f | 46 | struct bt_clock_class *clock_class __attribute__((unused))) |
f3534905 | 47 | { |
605e1019 | 48 | bt_clock_snapshot_destroy(clock_snapshot); |
f3534905 PP |
49 | } |
50 | ||
44c440bc PP |
51 | static inline |
52 | void set_base_offset(struct bt_clock_class *clock_class) | |
312c056a | 53 | { |
0f2d58c9 PP |
54 | clock_class->base_offset.overflows = bt_util_get_base_offset_ns( |
55 | clock_class->offset_seconds, clock_class->offset_cycles, | |
56 | clock_class->frequency, &clock_class->base_offset.value_ns); | |
312c056a PP |
57 | } |
58 | ||
1353b066 | 59 | BT_EXPORT |
7fcdb0a9 | 60 | struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp) |
4c426c17 JG |
61 | { |
62 | int ret; | |
50842bdc | 63 | struct bt_clock_class *clock_class = NULL; |
4c426c17 | 64 | |
17f3083a | 65 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 66 | BT_ASSERT_PRE_COMP_NON_NULL(self_comp); |
44c440bc | 67 | BT_LOGD_STR("Creating default clock class object"); |
f3534905 | 68 | |
50842bdc | 69 | clock_class = g_new0(struct bt_clock_class, 1); |
ac0c6bdd | 70 | if (!clock_class) { |
870631a2 | 71 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class."); |
4c426c17 JG |
72 | goto error; |
73 | } | |
74 | ||
44c440bc | 75 | bt_object_init_shared(&clock_class->base, destroy_clock_class); |
c6962c96 PP |
76 | |
77 | clock_class->user_attributes = bt_value_map_create(); | |
78 | if (!clock_class->user_attributes) { | |
79 | BT_LIB_LOGE_APPEND_CAUSE( | |
80 | "Failed to create a map value object."); | |
81 | goto error; | |
82 | } | |
83 | ||
44c440bc | 84 | clock_class->frequency = UINT64_C(1000000000); |
5552377a | 85 | clock_class->origin_is_unix_epoch = BT_TRUE; |
44c440bc | 86 | set_base_offset(clock_class); |
605e1019 PP |
87 | ret = bt_object_pool_initialize(&clock_class->cs_pool, |
88 | (bt_object_pool_new_object_func) bt_clock_snapshot_new, | |
312c056a | 89 | (bt_object_pool_destroy_object_func) |
605e1019 | 90 | free_clock_snapshot, |
312c056a PP |
91 | clock_class); |
92 | if (ret) { | |
870631a2 PP |
93 | BT_LIB_LOGE_APPEND_CAUSE( |
94 | "Failed to initialize clock snapshot pool: ret=%d", | |
312c056a PP |
95 | ret); |
96 | goto error; | |
97 | } | |
98 | ||
44c440bc PP |
99 | BT_LIB_LOGD("Created clock class object: %!+K", clock_class); |
100 | goto end; | |
101 | ||
273b65be | 102 | error: |
65300d60 | 103 | BT_OBJECT_PUT_REF_AND_RESET(clock_class); |
87d76bb1 JG |
104 | |
105 | end: | |
40f4ba76 | 106 | return clock_class; |
87d76bb1 JG |
107 | } |
108 | ||
1353b066 | 109 | BT_EXPORT |
40f4ba76 | 110 | const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class) |
87d76bb1 | 111 | { |
d5b13b9b | 112 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
b91e0631 | 113 | return clock_class->name; |
44c440bc | 114 | } |
87d76bb1 | 115 | |
1353b066 | 116 | BT_EXPORT |
d24d5663 | 117 | enum bt_clock_class_set_name_status bt_clock_class_set_name( |
8c41fd73 | 118 | struct bt_clock_class *clock_class, const char *name) |
44c440bc | 119 | { |
17f3083a | 120 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
121 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
122 | BT_ASSERT_PRE_NAME_NON_NULL(name); | |
bdb288b3 | 123 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
b91e0631 SM |
124 | g_free(clock_class->name); |
125 | clock_class->name = g_strdup(name); | |
3f7d4d90 | 126 | BT_LIB_LOGD("Set clock class's name: %!+K", clock_class); |
d24d5663 | 127 | return BT_FUNC_STATUS_OK; |
44c440bc | 128 | } |
87d76bb1 | 129 | |
1353b066 | 130 | BT_EXPORT |
40f4ba76 PP |
131 | const char *bt_clock_class_get_description( |
132 | const struct bt_clock_class *clock_class) | |
44c440bc | 133 | { |
d5b13b9b | 134 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
b91e0631 | 135 | return clock_class->description; |
273b65be JG |
136 | } |
137 | ||
1353b066 | 138 | BT_EXPORT |
d24d5663 | 139 | enum bt_clock_class_set_description_status bt_clock_class_set_description( |
8c41fd73 | 140 | struct bt_clock_class *clock_class, const char *descr) |
273b65be | 141 | { |
17f3083a | 142 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b PP |
143 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
144 | BT_ASSERT_PRE_DESCR_NON_NULL(descr); | |
bdb288b3 | 145 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
b91e0631 SM |
146 | g_free(clock_class->description); |
147 | clock_class->description = g_strdup(descr); | |
3f7d4d90 | 148 | BT_LIB_LOGD("Set clock class's description: %!+K", |
44c440bc | 149 | clock_class); |
d24d5663 | 150 | return BT_FUNC_STATUS_OK; |
273b65be JG |
151 | } |
152 | ||
1353b066 | 153 | BT_EXPORT |
40f4ba76 | 154 | uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class) |
87d76bb1 | 155 | { |
d5b13b9b | 156 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
44c440bc | 157 | return clock_class->frequency; |
87d76bb1 JG |
158 | } |
159 | ||
1353b066 | 160 | BT_EXPORT |
40f4ba76 | 161 | void bt_clock_class_set_frequency(struct bt_clock_class *clock_class, |
44c440bc | 162 | uint64_t frequency) |
273b65be | 163 | { |
d5b13b9b | 164 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
bdb288b3 | 165 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
1778c2a4 PP |
166 | BT_ASSERT_PRE("valid-frequency", |
167 | frequency != UINT64_C(-1) && frequency != 0, | |
44c440bc PP |
168 | "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64, |
169 | clock_class, frequency); | |
1778c2a4 PP |
170 | BT_ASSERT_PRE("offset-cycles-lt-frequency", |
171 | clock_class->offset_cycles < frequency, | |
44c440bc PP |
172 | "Offset (cycles) is greater than clock class's frequency: " |
173 | "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency); | |
174 | clock_class->frequency = frequency; | |
175 | set_base_offset(clock_class); | |
3f7d4d90 | 176 | BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class); |
273b65be JG |
177 | } |
178 | ||
1353b066 | 179 | BT_EXPORT |
40f4ba76 | 180 | uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class) |
87d76bb1 | 181 | { |
d5b13b9b | 182 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
44c440bc | 183 | return clock_class->precision; |
87d76bb1 JG |
184 | } |
185 | ||
1353b066 | 186 | BT_EXPORT |
40f4ba76 | 187 | void bt_clock_class_set_precision(struct bt_clock_class *clock_class, |
ac0c6bdd | 188 | uint64_t precision) |
273b65be | 189 | { |
d5b13b9b | 190 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
bdb288b3 | 191 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
1778c2a4 | 192 | BT_ASSERT_PRE("valid-precision", precision != UINT64_C(-1), |
44c440bc PP |
193 | "Invalid precision: %![cc-]+K, new-precision=%" PRIu64, |
194 | clock_class, precision); | |
ac0c6bdd | 195 | clock_class->precision = precision; |
3f7d4d90 | 196 | BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class); |
273b65be JG |
197 | } |
198 | ||
1353b066 | 199 | BT_EXPORT |
40f4ba76 | 200 | void bt_clock_class_get_offset(const struct bt_clock_class *clock_class, |
44c440bc | 201 | int64_t *seconds, uint64_t *cycles) |
87d76bb1 | 202 | { |
d5b13b9b | 203 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
1778c2a4 PP |
204 | BT_ASSERT_PRE_DEV_NON_NULL("seconds-output", seconds, |
205 | "Seconds (output)"); | |
206 | BT_ASSERT_PRE_DEV_NON_NULL("cycles-output", cycles, "Cycles (output)"); | |
44c440bc PP |
207 | *seconds = clock_class->offset_seconds; |
208 | *cycles = clock_class->offset_cycles; | |
87d76bb1 JG |
209 | } |
210 | ||
1353b066 | 211 | BT_EXPORT |
40f4ba76 | 212 | void bt_clock_class_set_offset(struct bt_clock_class *clock_class, |
44c440bc | 213 | int64_t seconds, uint64_t cycles) |
273b65be | 214 | { |
d5b13b9b | 215 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
bdb288b3 | 216 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
1778c2a4 PP |
217 | BT_ASSERT_PRE("offset-cycles-lt-frequency", |
218 | cycles < clock_class->frequency, | |
44c440bc PP |
219 | "Offset (cycles) is greater than clock class's frequency: " |
220 | "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles); | |
221 | clock_class->offset_seconds = seconds; | |
222 | clock_class->offset_cycles = cycles; | |
223 | set_base_offset(clock_class); | |
3f7d4d90 | 224 | BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class); |
273b65be JG |
225 | } |
226 | ||
1353b066 | 227 | BT_EXPORT |
5552377a | 228 | bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class) |
87d76bb1 | 229 | { |
d5b13b9b | 230 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
5552377a | 231 | return (bool) clock_class->origin_is_unix_epoch; |
87d76bb1 JG |
232 | } |
233 | ||
1353b066 | 234 | BT_EXPORT |
5552377a PP |
235 | void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class, |
236 | bt_bool origin_is_unix_epoch) | |
273b65be | 237 | { |
d5b13b9b | 238 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
bdb288b3 | 239 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
5552377a | 240 | clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch; |
3f7d4d90 | 241 | BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K", |
44c440bc | 242 | clock_class); |
273b65be JG |
243 | } |
244 | ||
1353b066 | 245 | BT_EXPORT |
40f4ba76 | 246 | bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class) |
85b743f4 | 247 | { |
d5b13b9b | 248 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
44c440bc | 249 | return clock_class->uuid.value; |
85b743f4 JG |
250 | } |
251 | ||
1353b066 | 252 | BT_EXPORT |
40f4ba76 | 253 | void bt_clock_class_set_uuid(struct bt_clock_class *clock_class, |
44c440bc | 254 | bt_uuid uuid) |
85b743f4 | 255 | { |
d5b13b9b PP |
256 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
257 | BT_ASSERT_PRE_UUID_NON_NULL(uuid); | |
bdb288b3 | 258 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
6162e6b7 | 259 | bt_uuid_copy(clock_class->uuid.uuid, uuid); |
44c440bc | 260 | clock_class->uuid.value = clock_class->uuid.uuid; |
3f7d4d90 | 261 | BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class); |
312c056a PP |
262 | } |
263 | ||
40f4ba76 | 264 | void _bt_clock_class_freeze(const struct bt_clock_class *clock_class) |
312c056a | 265 | { |
312c056a | 266 | BT_ASSERT(clock_class); |
6f57e458 | 267 | |
44c440bc PP |
268 | if (clock_class->frozen) { |
269 | return; | |
93dda901 PP |
270 | } |
271 | ||
c6962c96 PP |
272 | BT_LIB_LOGD("Freezing clock class's user attributes: %!+v", |
273 | clock_class->user_attributes); | |
274 | bt_value_freeze(clock_class->user_attributes); | |
44c440bc | 275 | BT_LIB_LOGD("Freezing clock class: %!+K", clock_class); |
40f4ba76 | 276 | ((struct bt_clock_class *) clock_class)->frozen = 1; |
93dda901 | 277 | } |
312c056a | 278 | |
1353b066 | 279 | BT_EXPORT |
d24d5663 PP |
280 | enum bt_clock_class_cycles_to_ns_from_origin_status |
281 | bt_clock_class_cycles_to_ns_from_origin( | |
40f4ba76 | 282 | const struct bt_clock_class *clock_class, |
312c056a PP |
283 | uint64_t cycles, int64_t *ns) |
284 | { | |
285 | int ret; | |
312c056a | 286 | |
17f3083a | 287 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
d5b13b9b | 288 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
1778c2a4 PP |
289 | BT_ASSERT_PRE_DEV_NON_NULL("nanoseconds-output", ns, |
290 | "Nanoseconds (output)"); | |
0f2d58c9 | 291 | ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns); |
312c056a | 292 | if (ret) { |
bc3d9692 | 293 | BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds " |
44c440bc PP |
294 | "from origin for given clock class: " |
295 | "value overflows the signed 64-bit integer range: " | |
296 | "%![cc-]+K, cycles=%" PRIu64, | |
297 | clock_class, cycles); | |
520cdc82 | 298 | ret = BT_FUNC_STATUS_OVERFLOW_ERROR; |
312c056a PP |
299 | } |
300 | ||
312c056a PP |
301 | return ret; |
302 | } | |
c5b9b441 | 303 | |
1353b066 | 304 | BT_EXPORT |
c6962c96 PP |
305 | const struct bt_value *bt_clock_class_borrow_user_attributes_const( |
306 | const struct bt_clock_class *clock_class) | |
307 | { | |
d5b13b9b | 308 | BT_ASSERT_PRE_DEV_CLK_CLS_NON_NULL(clock_class); |
c6962c96 PP |
309 | return clock_class->user_attributes; |
310 | } | |
311 | ||
1353b066 | 312 | BT_EXPORT |
c6962c96 PP |
313 | struct bt_value *bt_clock_class_borrow_user_attributes( |
314 | struct bt_clock_class *clock_class) | |
315 | { | |
316 | return (void *) bt_clock_class_borrow_user_attributes_const( | |
317 | (void *) clock_class); | |
318 | } | |
319 | ||
1353b066 | 320 | BT_EXPORT |
c6962c96 PP |
321 | void bt_clock_class_set_user_attributes( |
322 | struct bt_clock_class *clock_class, | |
323 | const struct bt_value *user_attributes) | |
324 | { | |
d5b13b9b PP |
325 | BT_ASSERT_PRE_CLK_CLS_NON_NULL(clock_class); |
326 | BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); | |
327 | BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); | |
c6962c96 | 328 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
6871026b | 329 | bt_object_put_ref_no_null_check(clock_class->user_attributes); |
c6962c96 | 330 | clock_class->user_attributes = (void *) user_attributes; |
6871026b | 331 | bt_object_get_ref_no_null_check(clock_class->user_attributes); |
c6962c96 PP |
332 | } |
333 | ||
1353b066 | 334 | BT_EXPORT |
c5b9b441 PP |
335 | void bt_clock_class_get_ref(const struct bt_clock_class *clock_class) |
336 | { | |
337 | bt_object_get_ref(clock_class); | |
338 | } | |
339 | ||
1353b066 | 340 | BT_EXPORT |
c5b9b441 PP |
341 | void bt_clock_class_put_ref(const struct bt_clock_class *clock_class) |
342 | { | |
343 | bt_object_put_ref(clock_class); | |
344 | } |