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