Commit | Line | Data |
---|---|---|
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> |
578e048b MJ |
38 | #include "lib/object.h" |
39 | #include "common/assert.h" | |
d24d5663 | 40 | #include "lib/func-status.h" |
5134570b | 41 | |
bdb288b3 PP |
42 | #define BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(_cc) \ |
43 | BT_ASSERT_PRE_DEV_HOT((_cc), "Clock class", ": %!+K", (_cc)) | |
312c056a PP |
44 | |
45 | static | |
44c440bc | 46 | void destroy_clock_class(struct bt_object *obj) |
c06116f3 | 47 | { |
44c440bc | 48 | struct bt_clock_class *clock_class = (void *) obj; |
c06116f3 | 49 | |
44c440bc | 50 | BT_LIB_LOGD("Destroying clock class: %!+K", clock_class); |
273b65be | 51 | |
44c440bc PP |
52 | if (clock_class->name.str) { |
53 | g_string_free(clock_class->name.str, TRUE); | |
238b7404 PP |
54 | clock_class->name.str = NULL; |
55 | clock_class->name.value = NULL; | |
5134570b PP |
56 | } |
57 | ||
44c440bc PP |
58 | if (clock_class->description.str) { |
59 | g_string_free(clock_class->description.str, TRUE); | |
238b7404 PP |
60 | clock_class->description.str = NULL; |
61 | clock_class->description.value = NULL; | |
273b65be JG |
62 | } |
63 | ||
605e1019 | 64 | bt_object_pool_finalize(&clock_class->cs_pool); |
44c440bc | 65 | g_free(clock_class); |
4c426c17 JG |
66 | } |
67 | ||
f3534905 | 68 | static |
605e1019 | 69 | void free_clock_snapshot(struct bt_clock_snapshot *clock_snapshot, |
44c440bc | 70 | struct bt_clock_class *clock_class) |
f3534905 | 71 | { |
605e1019 | 72 | bt_clock_snapshot_destroy(clock_snapshot); |
f3534905 PP |
73 | } |
74 | ||
44c440bc PP |
75 | static inline |
76 | void set_base_offset(struct bt_clock_class *clock_class) | |
312c056a | 77 | { |
0f2d58c9 PP |
78 | clock_class->base_offset.overflows = bt_util_get_base_offset_ns( |
79 | clock_class->offset_seconds, clock_class->offset_cycles, | |
80 | clock_class->frequency, &clock_class->base_offset.value_ns); | |
312c056a PP |
81 | } |
82 | ||
7fcdb0a9 | 83 | struct bt_clock_class *bt_clock_class_create(bt_self_component *self_comp) |
4c426c17 JG |
84 | { |
85 | int ret; | |
50842bdc | 86 | struct bt_clock_class *clock_class = NULL; |
4c426c17 | 87 | |
7fcdb0a9 | 88 | BT_ASSERT_PRE_NON_NULL(self_comp, "Self component"); |
44c440bc | 89 | BT_LOGD_STR("Creating default clock class object"); |
f3534905 | 90 | |
50842bdc | 91 | clock_class = g_new0(struct bt_clock_class, 1); |
ac0c6bdd | 92 | if (!clock_class) { |
870631a2 | 93 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class."); |
4c426c17 JG |
94 | goto error; |
95 | } | |
96 | ||
44c440bc PP |
97 | bt_object_init_shared(&clock_class->base, destroy_clock_class); |
98 | clock_class->name.str = g_string_new(NULL); | |
99 | if (!clock_class->name.str) { | |
870631a2 | 100 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
44c440bc PP |
101 | goto error; |
102 | } | |
85380e99 | 103 | |
44c440bc PP |
104 | clock_class->description.str = g_string_new(NULL); |
105 | if (!clock_class->description.str) { | |
870631a2 | 106 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
44c440bc | 107 | goto error; |
273b65be JG |
108 | } |
109 | ||
44c440bc | 110 | clock_class->frequency = UINT64_C(1000000000); |
5552377a | 111 | clock_class->origin_is_unix_epoch = BT_TRUE; |
44c440bc | 112 | set_base_offset(clock_class); |
605e1019 PP |
113 | ret = bt_object_pool_initialize(&clock_class->cs_pool, |
114 | (bt_object_pool_new_object_func) bt_clock_snapshot_new, | |
312c056a | 115 | (bt_object_pool_destroy_object_func) |
605e1019 | 116 | free_clock_snapshot, |
312c056a PP |
117 | clock_class); |
118 | if (ret) { | |
870631a2 PP |
119 | BT_LIB_LOGE_APPEND_CAUSE( |
120 | "Failed to initialize clock snapshot pool: ret=%d", | |
312c056a PP |
121 | ret); |
122 | goto error; | |
123 | } | |
124 | ||
44c440bc PP |
125 | BT_LIB_LOGD("Created clock class object: %!+K", clock_class); |
126 | goto end; | |
127 | ||
273b65be | 128 | error: |
65300d60 | 129 | BT_OBJECT_PUT_REF_AND_RESET(clock_class); |
87d76bb1 JG |
130 | |
131 | end: | |
40f4ba76 | 132 | return clock_class; |
87d76bb1 JG |
133 | } |
134 | ||
40f4ba76 | 135 | const char *bt_clock_class_get_name(const struct bt_clock_class *clock_class) |
87d76bb1 | 136 | { |
bdb288b3 | 137 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
44c440bc PP |
138 | return clock_class->name.value; |
139 | } | |
87d76bb1 | 140 | |
d24d5663 | 141 | enum bt_clock_class_set_name_status bt_clock_class_set_name( |
8c41fd73 | 142 | struct bt_clock_class *clock_class, const char *name) |
44c440bc PP |
143 | { |
144 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); | |
145 | BT_ASSERT_PRE_NON_NULL(name, "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 | |
40f4ba76 PP |
153 | const char *bt_clock_class_get_description( |
154 | const struct bt_clock_class *clock_class) | |
44c440bc | 155 | { |
bdb288b3 | 156 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
44c440bc | 157 | return clock_class->description.value; |
273b65be JG |
158 | } |
159 | ||
d24d5663 | 160 | enum bt_clock_class_set_description_status bt_clock_class_set_description( |
8c41fd73 | 161 | struct bt_clock_class *clock_class, const char *descr) |
273b65be | 162 | { |
44c440bc PP |
163 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
164 | BT_ASSERT_PRE_NON_NULL(descr, "Description"); | |
bdb288b3 | 165 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
44c440bc PP |
166 | g_string_assign(clock_class->description.str, descr); |
167 | clock_class->description.value = clock_class->description.str->str; | |
3f7d4d90 | 168 | BT_LIB_LOGD("Set clock class's description: %!+K", |
44c440bc | 169 | clock_class); |
d24d5663 | 170 | return BT_FUNC_STATUS_OK; |
273b65be JG |
171 | } |
172 | ||
40f4ba76 | 173 | uint64_t bt_clock_class_get_frequency(const struct bt_clock_class *clock_class) |
87d76bb1 | 174 | { |
bdb288b3 | 175 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
44c440bc | 176 | return clock_class->frequency; |
87d76bb1 JG |
177 | } |
178 | ||
40f4ba76 | 179 | void bt_clock_class_set_frequency(struct bt_clock_class *clock_class, |
44c440bc | 180 | uint64_t frequency) |
273b65be | 181 | { |
44c440bc | 182 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
bdb288b3 | 183 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
44c440bc PP |
184 | BT_ASSERT_PRE(frequency != UINT64_C(-1) && frequency != 0, |
185 | "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64, | |
186 | clock_class, frequency); | |
187 | BT_ASSERT_PRE(clock_class->offset_cycles < frequency, | |
188 | "Offset (cycles) is greater than clock class's frequency: " | |
189 | "%![cc-]+K, new-freq=%" PRIu64, clock_class, frequency); | |
190 | clock_class->frequency = frequency; | |
191 | set_base_offset(clock_class); | |
3f7d4d90 | 192 | BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class); |
273b65be JG |
193 | } |
194 | ||
40f4ba76 | 195 | uint64_t bt_clock_class_get_precision(const struct bt_clock_class *clock_class) |
87d76bb1 | 196 | { |
bdb288b3 | 197 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
44c440bc | 198 | return clock_class->precision; |
87d76bb1 JG |
199 | } |
200 | ||
40f4ba76 | 201 | void bt_clock_class_set_precision(struct bt_clock_class *clock_class, |
ac0c6bdd | 202 | uint64_t precision) |
273b65be | 203 | { |
44c440bc | 204 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
bdb288b3 | 205 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
44c440bc PP |
206 | BT_ASSERT_PRE(precision != UINT64_C(-1), |
207 | "Invalid precision: %![cc-]+K, new-precision=%" PRIu64, | |
208 | clock_class, precision); | |
ac0c6bdd | 209 | clock_class->precision = precision; |
3f7d4d90 | 210 | BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class); |
273b65be JG |
211 | } |
212 | ||
40f4ba76 | 213 | void bt_clock_class_get_offset(const struct bt_clock_class *clock_class, |
44c440bc | 214 | int64_t *seconds, uint64_t *cycles) |
87d76bb1 | 215 | { |
bdb288b3 PP |
216 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
217 | BT_ASSERT_PRE_DEV_NON_NULL(seconds, "Seconds (output)"); | |
218 | BT_ASSERT_PRE_DEV_NON_NULL(cycles, "Cycles (output)"); | |
44c440bc PP |
219 | *seconds = clock_class->offset_seconds; |
220 | *cycles = clock_class->offset_cycles; | |
87d76bb1 JG |
221 | } |
222 | ||
40f4ba76 | 223 | void bt_clock_class_set_offset(struct bt_clock_class *clock_class, |
44c440bc | 224 | int64_t seconds, uint64_t cycles) |
273b65be | 225 | { |
44c440bc | 226 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
bdb288b3 | 227 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
44c440bc PP |
228 | BT_ASSERT_PRE(cycles < clock_class->frequency, |
229 | "Offset (cycles) is greater than clock class's frequency: " | |
230 | "%![cc-]+K, new-offset-cycles=%" PRIu64, clock_class, cycles); | |
231 | clock_class->offset_seconds = seconds; | |
232 | clock_class->offset_cycles = cycles; | |
233 | set_base_offset(clock_class); | |
3f7d4d90 | 234 | BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class); |
273b65be JG |
235 | } |
236 | ||
5552377a | 237 | bt_bool bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class *clock_class) |
87d76bb1 | 238 | { |
bdb288b3 | 239 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
5552377a | 240 | return (bool) clock_class->origin_is_unix_epoch; |
87d76bb1 JG |
241 | } |
242 | ||
5552377a PP |
243 | void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class *clock_class, |
244 | bt_bool origin_is_unix_epoch) | |
273b65be | 245 | { |
44c440bc | 246 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
bdb288b3 | 247 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
5552377a | 248 | clock_class->origin_is_unix_epoch = (bool) origin_is_unix_epoch; |
3f7d4d90 | 249 | BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K", |
44c440bc | 250 | clock_class); |
273b65be JG |
251 | } |
252 | ||
40f4ba76 | 253 | bt_uuid bt_clock_class_get_uuid(const struct bt_clock_class *clock_class) |
85b743f4 | 254 | { |
bdb288b3 | 255 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
44c440bc | 256 | return clock_class->uuid.value; |
85b743f4 JG |
257 | } |
258 | ||
40f4ba76 | 259 | void bt_clock_class_set_uuid(struct bt_clock_class *clock_class, |
44c440bc | 260 | bt_uuid uuid) |
85b743f4 | 261 | { |
44c440bc PP |
262 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); |
263 | BT_ASSERT_PRE_NON_NULL(uuid, "UUID"); | |
bdb288b3 | 264 | BT_ASSERT_PRE_DEV_CLOCK_CLASS_HOT(clock_class); |
6162e6b7 | 265 | bt_uuid_copy(clock_class->uuid.uuid, uuid); |
44c440bc | 266 | clock_class->uuid.value = clock_class->uuid.uuid; |
3f7d4d90 | 267 | BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class); |
312c056a PP |
268 | } |
269 | ||
270 | BT_HIDDEN | |
40f4ba76 | 271 | void _bt_clock_class_freeze(const struct bt_clock_class *clock_class) |
312c056a | 272 | { |
312c056a | 273 | BT_ASSERT(clock_class); |
6f57e458 | 274 | |
44c440bc PP |
275 | if (clock_class->frozen) { |
276 | return; | |
93dda901 PP |
277 | } |
278 | ||
44c440bc | 279 | BT_LIB_LOGD("Freezing clock class: %!+K", clock_class); |
40f4ba76 | 280 | ((struct bt_clock_class *) clock_class)->frozen = 1; |
93dda901 | 281 | } |
312c056a | 282 | |
d24d5663 PP |
283 | enum bt_clock_class_cycles_to_ns_from_origin_status |
284 | bt_clock_class_cycles_to_ns_from_origin( | |
40f4ba76 | 285 | const struct bt_clock_class *clock_class, |
312c056a PP |
286 | uint64_t cycles, int64_t *ns) |
287 | { | |
288 | int ret; | |
312c056a | 289 | |
bdb288b3 PP |
290 | BT_ASSERT_PRE_DEV_NON_NULL(clock_class, "Clock class"); |
291 | BT_ASSERT_PRE_DEV_NON_NULL(ns, "Nanoseconds (output)"); | |
0f2d58c9 | 292 | ret = bt_util_ns_from_origin_clock_class(clock_class, cycles, ns); |
312c056a | 293 | if (ret) { |
d24d5663 | 294 | ret = BT_FUNC_STATUS_OVERFLOW; |
3f7d4d90 | 295 | BT_LIB_LOGD("Cannot convert cycles to nanoseconds " |
44c440bc PP |
296 | "from origin for given clock class: " |
297 | "value overflows the signed 64-bit integer range: " | |
298 | "%![cc-]+K, cycles=%" PRIu64, | |
299 | clock_class, cycles); | |
312c056a PP |
300 | } |
301 | ||
312c056a PP |
302 | return ret; |
303 | } | |
c5b9b441 PP |
304 | |
305 | void bt_clock_class_get_ref(const struct bt_clock_class *clock_class) | |
306 | { | |
307 | bt_object_get_ref(clock_class); | |
308 | } | |
309 | ||
310 | void bt_clock_class_put_ref(const struct bt_clock_class *clock_class) | |
311 | { | |
312 | bt_object_put_ref(clock_class); | |
313 | } |