Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
f2b0325d | 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 | ||
b03487ab | 24 | #define BT_LOG_TAG "LIB/CLOCK-CLASS" |
1633ef46 | 25 | #include "lib/logging.h" |
0f5e83e5 | 26 | |
57952005 | 27 | #include "lib/assert-pre.h" |
d126826c | 28 | #include "common/uuid.h" |
71c5da58 | 29 | #include <babeltrace2/trace-ir/clock-class.h> |
57952005 MJ |
30 | #include "clock-class.h" |
31 | #include "clock-snapshot.h" | |
32 | #include "utils.h" | |
33 | #include "compat/compiler.h" | |
71c5da58 | 34 | #include <babeltrace2/types.h> |
57952005 | 35 | #include "compat/string.h" |
273b65be | 36 | #include <inttypes.h> |
969c1d8a | 37 | #include <stdbool.h> |
57952005 MJ |
38 | #include "lib/object.h" |
39 | #include "common/assert.h" | |
fb25b9e3 | 40 | #include "lib/func-status.h" |
af90138b | 41 | #include "lib/value.h" |
5134570b | 42 | |
fa6cfec3 PP |
43 | #define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \ |
44 | BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc)) | |
a6918753 PP |
45 | |
46 | static | |
7b33a0e0 | 47 | void destroy_clock_class(struct bt_object *obj) |
c06116f3 | 48 | { |
7b33a0e0 | 49 | struct bt_clock_class *clock_class = (void *) obj; |
c06116f3 | 50 | |
7b33a0e0 | 51 | BT_LIB_LOGD("Destroying clock class: %!+K", clock_class); |
af90138b | 52 | BT_OBJECT_PUT_REF_AND_RESET(clock_class->user_attributes); |
273b65be | 53 | |
7b33a0e0 PP |
54 | if (clock_class->name.str) { |
55 | g_string_free(clock_class->name.str, TRUE); | |
1248f5ea PP |
56 | clock_class->name.str = NULL; |
57 | clock_class->name.value = NULL; | |
5134570b PP |
58 | } |
59 | ||
7b33a0e0 PP |
60 | if (clock_class->description.str) { |
61 | g_string_free(clock_class->description.str, TRUE); | |
1248f5ea PP |
62 | clock_class->description.str = NULL; |
63 | clock_class->description.value = NULL; | |
273b65be JG |
64 | } |
65 | ||
ecbb78c0 | 66 | bt_object_pool_finalize(&clock_class->cs_pool); |
7b33a0e0 | 67 | g_free(clock_class); |
4c426c17 JG |
68 | } |
69 | ||
15260cc8 | 70 | static |
ecbb78c0 | 71 | void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot, |
7b33a0e0 | 72 | struct bt_clock_class *clock_class) |
15260cc8 | 73 | { |
ecbb78c0 | 74 | bt_clock_snapshot_destroy(clock_snapshot); |
15260cc8 PP |
75 | } |
76 | ||
7b33a0e0 PP |
77 | static inline |
78 | void set_base_offset(struct bt_clock_class *clock_class) | |
a6918753 | 79 | { |
35fa110e PP |
80 | clock_class->base_offset.overflows = bt_util_get_base_offset_ns( |
81 | clock_class->offset_seconds, clock_class->offset_cycles, | |
82 | clock_class->frequency, &clock_class->base_offset.value_ns); | |
a6918753 PP |
83 | } |
84 | ||
c0c2ed34 | 85 | struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp) |
4c426c17 JG |
86 | { |
87 | int ret; | |
839d52a5 | 88 | struct bt_clock_class *clock_class = NULL; |
4c426c17 | 89 | |
7c7324d3 | 90 | BT_ASSERT_PRE_NO_ERROR(); |
c0c2ed34 | 91 | BT_ASSERT_PRE_NON_NULL(self_comp, "Self component"); |
7b33a0e0 | 92 | BT_LOGD_STR("Creating default clock class object"); |
15260cc8 | 93 | |
839d52a5 | 94 | clock_class = g_new0(struct bt_clock_class, 1); |
ac0c6bdd | 95 | if (!clock_class) { |
a8f90e5d | 96 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class."); |
4c426c17 JG |
97 | goto error; |
98 | } | |
99 | ||
7b33a0e0 | 100 | bt_object_init_shared(&clock_class->base, destroy_clock_class); |
af90138b 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 | ||
7b33a0e0 PP |
109 | clock_class->name.str = g_string_new(NULL); |
110 | if (!clock_class->name.str) { | |
a8f90e5d | 111 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
7b33a0e0 PP |
112 | goto error; |
113 | } | |
85380e99 | 114 | |
7b33a0e0 PP |
115 | clock_class->description.str = g_string_new(NULL); |
116 | if (!clock_class->description.str) { | |
a8f90e5d | 117 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
7b33a0e0 | 118 | goto error; |
273b65be JG |
119 | } |
120 | ||
7b33a0e0 | 121 | clock_class->frequency = UINT64_C(1000000000); |
d608d675 | 122 | clock_class->origin_is_unix_epoch = BT_TRUE; |
7b33a0e0 | 123 | set_base_offset(clock_class); |
ecbb78c0 PP |
124 | ret = bt_object_pool_initialize(&clock_class->cs_pool, |
125 | (bt_object_pool_new_object_func) bt_clock_snapshot_new, | |
a6918753 | 126 | (bt_object_pool_destroy_object_func) |
ecbb78c0 | 127 | free_clock_snapshot, |
a6918753 PP |
128 | clock_class); |
129 | if (ret) { | |
a8f90e5d PP |
130 | BT_LIB_LOGE_APPEND_CAUSE( |
131 | "Failed to initialize clock snapshot pool: ret=%d", | |
a6918753 PP |
132 | ret); |
133 | goto error; | |
134 | } | |
135 | ||
7b33a0e0 PP |
136 | BT_LIB_LOGD("Created clock class object: %!+K", clock_class); |
137 | goto end; | |
138 | ||
273b65be | 139 | error: |
8138bfe1 | 140 | BT_OBJECT_PUT_REF_AND_RESET(clock_class); |
87d76bb1 JG |
141 | |
142 | end: | |
78cf9df6 | 143 | return clock_class; |
87d76bb1 JG |
144 | } |
145 | ||
78cf9df6 | 146 | const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class) |
87d76bb1 | 147 | { |
fa6cfec3 | 148 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
7b33a0e0 PP |
149 | return clock_class->name.value; |
150 | } | |
87d76bb1 | 151 | |
fb25b9e3 | 152 | enum bt_clock_class_set_name_status bt_clock_class_set_name( |
d10c1e1a | 153 | struct bt_clock_class *clock_class, const char *name) |
7b33a0e0 | 154 | { |
7c7324d3 | 155 | BT_ASSERT_PRE_NO_ERROR(); |
7b33a0e0 PP |
156 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
157 | BT_ASSERT_PRE_NON_NULL(name, "Name"); | |
fa6cfec3 | 158 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
7b33a0e0 PP |
159 | g_string_assign(clock_class->name.str, name); |
160 | clock_class->name.value = clock_class->name.str->str; | |
a684a357 | 161 | BT_LIB_LOGD("Set clock class's name: %!+K", clock_class); |
fb25b9e3 | 162 | return BT_FUNC_STATUS_OK; |
7b33a0e0 | 163 | } |
87d76bb1 | 164 | |
78cf9df6 PP |
165 | const char *bt_clock_class_get_description( |
166 | const struct bt_clock_class *clock_class) | |
7b33a0e0 | 167 | { |
fa6cfec3 | 168 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
7b33a0e0 | 169 | return clock_class->description.value; |
273b65be JG |
170 | } |
171 | ||
fb25b9e3 | 172 | enum bt_clock_class_set_description_status bt_clock_class_set_description( |
d10c1e1a | 173 | struct bt_clock_class *clock_class, const char *descr) |
273b65be | 174 | { |
7c7324d3 | 175 | BT_ASSERT_PRE_NO_ERROR(); |
7b33a0e0 PP |
176 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
177 | BT_ASSERT_PRE_NON_NULL(descr, "Description"); | |
fa6cfec3 | 178 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
7b33a0e0 PP |
179 | g_string_assign(clock_class->description.str, descr); |
180 | clock_class->description.value = clock_class->description.str->str; | |
a684a357 | 181 | BT_LIB_LOGD("Set clock class's description: %!+K", |
7b33a0e0 | 182 | clock_class); |
fb25b9e3 | 183 | return BT_FUNC_STATUS_OK; |
273b65be JG |
184 | } |
185 | ||
78cf9df6 | 186 | uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class) |
87d76bb1 | 187 | { |
fa6cfec3 | 188 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
7b33a0e0 | 189 | return clock_class->frequency; |
87d76bb1 JG |
190 | } |
191 | ||
78cf9df6 | 192 | void bt_clock_class_set_frequency(struct bt_clock_class *clock_class, |
7b33a0e0 | 193 | uint64_t frequency) |
273b65be | 194 | { |
7b33a0e0 | 195 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
fa6cfec3 | 196 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
7b33a0e0 PP |
197 | BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0, |
198 | "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64, | |
199 | clock_class, frequency); | |
200 | BT_ASSERT_PRE(clock_class->offset_cycles < frequency, | |
201 | "Offset (cycles) is greater than clock class's frequency: " | |
202 | "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency); | |
203 | clock_class->frequency = frequency; | |
204 | set_base_offset(clock_class); | |
a684a357 | 205 | BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class); |
273b65be JG |
206 | } |
207 | ||
78cf9df6 | 208 | uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class) |
87d76bb1 | 209 | { |
fa6cfec3 | 210 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
7b33a0e0 | 211 | return clock_class->precision; |
87d76bb1 JG |
212 | } |
213 | ||
78cf9df6 | 214 | void bt_clock_class_set_precision(struct bt_clock_class *clock_class, |
ac0c6bdd | 215 | uint64_t precision) |
273b65be | 216 | { |
7b33a0e0 | 217 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
fa6cfec3 | 218 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
7b33a0e0 PP |
219 | BT_ASSERT_PRE(precision != UINT64_C(-1), |
220 | "Invalid precision: %![cc-]+K, new-precision=%" PRIu64, | |
221 | clock_class, precision); | |
ac0c6bdd | 222 | clock_class->precision = precision; |
a684a357 | 223 | BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class); |
273b65be JG |
224 | } |
225 | ||
78cf9df6 | 226 | void bt_clock_class_get_offset(const struct bt_clock_class *clock_class, |
7b33a0e0 | 227 | int64_t *seconds, uint64_t *cycles) |
87d76bb1 | 228 | { |
fa6cfec3 PP |
229 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
230 | BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)"); | |
231 | BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)"); | |
7b33a0e0 PP |
232 | *seconds = clock_class->offset_seconds; |
233 | *cycles = clock_class->offset_cycles; | |
87d76bb1 JG |
234 | } |
235 | ||
78cf9df6 | 236 | void bt_clock_class_set_offset(struct bt_clock_class *clock_class, |
7b33a0e0 | 237 | int64_t seconds, uint64_t cycles) |
273b65be | 238 | { |
7b33a0e0 | 239 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
fa6cfec3 | 240 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
7b33a0e0 PP |
241 | BT_ASSERT_PRE(cycles < clock_class->frequency, |
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); | |
a684a357 | 247 | BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class); |
273b65be JG |
248 | } |
249 | ||
d608d675 | 250 | bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class) |
87d76bb1 | 251 | { |
fa6cfec3 | 252 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
d608d675 | 253 | return (bool) clock_class->origin_is_unix_epoch; |
87d76bb1 JG |
254 | } |
255 | ||
d608d675 PP |
256 | void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class, |
257 | bt_bool origin_is_unix_epoch) | |
273b65be | 258 | { |
7b33a0e0 | 259 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
fa6cfec3 | 260 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
d608d675 | 261 | clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch; |
a684a357 | 262 | BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K", |
7b33a0e0 | 263 | clock_class); |
273b65be JG |
264 | } |
265 | ||
78cf9df6 | 266 | bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class) |
85b743f4 | 267 | { |
fa6cfec3 | 268 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
7b33a0e0 | 269 | return clock_class->uuid.value; |
85b743f4 JG |
270 | } |
271 | ||
78cf9df6 | 272 | void bt_clock_class_set_uuid(struct bt_clock_class *clock_class, |
7b33a0e0 | 273 | bt_uuid uuid) |
85b743f4 | 274 | { |
7b33a0e0 PP |
275 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
276 | BT_ASSERT_PRE_NON_NULL(uuid, "UUID"); | |
fa6cfec3 | 277 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
d126826c | 278 | bt_uuid_copy(clock_class->uuid.uuid, uuid); |
7b33a0e0 | 279 | clock_class->uuid.value = clock_class->uuid.uuid; |
a684a357 | 280 | BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class); |
a6918753 PP |
281 | } |
282 | ||
283 | BT_HIDDEN | |
78cf9df6 | 284 | void _bt_clock_class_freeze(const struct bt_clock_class *clock_class) |
a6918753 | 285 | { |
a6918753 | 286 | BT_ASSERT(clock_class); |
6f57e458 | 287 | |
7b33a0e0 PP |
288 | if (clock_class->frozen) { |
289 | return; | |
db3347ac PP |
290 | } |
291 | ||
af90138b PP |
292 | BT_LIB_LOGD("Freezing clock class's user attributes: %!+v", |
293 | clock_class->user_attributes); | |
294 | bt_value_freeze(clock_class->user_attributes); | |
7b33a0e0 | 295 | BT_LIB_LOGD("Freezing clock class: %!+K", clock_class); |
78cf9df6 | 296 | ((struct bt_clock_class *) clock_class)->frozen = 1; |
db3347ac | 297 | } |
a6918753 | 298 | |
fb25b9e3 PP |
299 | enum bt_clock_class_cycles_to_ns_from_origin_status |
300 | bt_clock_class_cycles_to_ns_from_origin( | |
78cf9df6 | 301 | const struct bt_clock_class *clock_class, |
a6918753 PP |
302 | uint64_t cycles, int64_t *ns) |
303 | { | |
304 | int ret; | |
a6918753 | 305 | |
7c7324d3 | 306 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
fa6cfec3 PP |
307 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
308 | BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)"); | |
35fa110e | 309 | ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns); |
a6918753 | 310 | if (ret) { |
790240eb | 311 | BT_LIB_LOGE_APPEND_CAUSE("Cannot convert cycles to nanoseconds " |
7b33a0e0 PP |
312 | "from origin for given clock class: " |
313 | "value overflows the signed 64-bit integer range: " | |
314 | "%![cc-]+K, cycles=%" PRIu64, | |
315 | clock_class, cycles); | |
f67e22d1 | 316 | ret = BT_FUNC_STATUS_OVERFLOW_ERROR; |
a6918753 PP |
317 | } |
318 | ||
a6918753 PP |
319 | return ret; |
320 | } | |
8c6884d9 | 321 | |
af90138b PP |
322 | const struct bt_value *bt_clock_class_borrow_user_attributes_const( |
323 | const struct bt_clock_class *clock_class) | |
324 | { | |
325 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); | |
326 | return clock_class->user_attributes; | |
327 | } | |
328 | ||
329 | struct bt_value *bt_clock_class_borrow_user_attributes( | |
330 | struct bt_clock_class *clock_class) | |
331 | { | |
332 | return (void *) bt_clock_class_borrow_user_attributes_const( | |
333 | (void *) clock_class); | |
334 | } | |
335 | ||
336 | void bt_clock_class_set_user_attributes( | |
337 | struct bt_clock_class *clock_class, | |
338 | const struct bt_value *user_attributes) | |
339 | { | |
340 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); | |
341 | BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes"); | |
342 | BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP, | |
343 | "User attributes object is not a map value object."); | |
344 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); | |
864aa43f | 345 | bt_object_put_ref_no_null_check(clock_class->user_attributes); |
af90138b | 346 | clock_class->user_attributes = (void *) user_attributes; |
864aa43f | 347 | bt_object_get_ref_no_null_check(clock_class->user_attributes); |
af90138b PP |
348 | } |
349 | ||
8c6884d9 PP |
350 | void bt_clock_class_get_ref(const struct bt_clock_class *clock_class) |
351 | { | |
352 | bt_object_get_ref(clock_class); | |
353 | } | |
354 | ||
355 | void bt_clock_class_put_ref(const struct bt_clock_class *clock_class) | |
356 | { | |
357 | bt_object_put_ref(clock_class); | |
358 | } |