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