2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "CLOCK-CLASS"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/compat/uuid-internal.h>
29 #include <babeltrace/trace-ir/clock-class-internal.h>
30 #include <babeltrace/trace-ir/clock-value-internal.h>
31 #include <babeltrace/trace-ir/utils-internal.h>
32 #include <babeltrace/object.h>
33 #include <babeltrace/compiler-internal.h>
34 #include <babeltrace/types.h>
35 #include <babeltrace/compat/string-internal.h>
37 #include <babeltrace/object-internal.h>
38 #include <babeltrace/assert-internal.h>
40 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
41 BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
44 void destroy_clock_class(struct bt_object
*obj
)
46 struct bt_clock_class
*clock_class
= (void *) obj
;
48 BT_LIB_LOGD("Destroying clock class: %!+K", clock_class
);
50 if (clock_class
->name
.str
) {
51 g_string_free(clock_class
->name
.str
, TRUE
);
52 clock_class
->name
.str
= NULL
;
53 clock_class
->name
.value
= NULL
;
56 if (clock_class
->description
.str
) {
57 g_string_free(clock_class
->description
.str
, TRUE
);
58 clock_class
->description
.str
= NULL
;
59 clock_class
->description
.value
= NULL
;
62 bt_object_pool_finalize(&clock_class
->cv_pool
);
67 void free_clock_value(struct bt_clock_value
*clock_value
,
68 struct bt_clock_class
*clock_class
)
70 bt_clock_value_destroy(clock_value
);
74 void set_base_offset(struct bt_clock_class
*clock_class
)
76 uint64_t offset_cycles_ns
;
78 /* Initialize nanosecond timestamp to clock's offset in seconds */
79 if (clock_class
->offset_seconds
<= (INT64_MIN
/ INT64_C(1000000000) - 1) ||
80 clock_class
->offset_seconds
>= (INT64_MAX
/ INT64_C(1000000000)) - 1) {
82 * Overflow: offset in seconds converted to nanoseconds
83 * is outside the int64_t range. We also subtract 1 here
84 * to leave "space" for the offset in cycles converted
85 * to nanoseconds (which is always less than 1 second by
88 clock_class
->base_offset
.overflows
= true;
92 /* Offset (seconds) to nanoseconds */
93 clock_class
->base_offset
.value_ns
= clock_class
->offset_seconds
*
96 /* Add offset in cycles */
97 BT_ASSERT(clock_class
->offset_cycles
< clock_class
->frequency
);
98 offset_cycles_ns
= bt_util_ns_from_value(clock_class
->frequency
,
99 clock_class
->offset_cycles
);
100 BT_ASSERT(offset_cycles_ns
< 1000000000);
101 clock_class
->base_offset
.value_ns
+= (int64_t) offset_cycles_ns
;
102 clock_class
->base_offset
.overflows
= false;
108 struct bt_clock_class
*bt_clock_class_create(void)
111 struct bt_clock_class
*clock_class
= NULL
;
113 BT_LOGD_STR("Creating default clock class object");
115 clock_class
= g_new0(struct bt_clock_class
, 1);
117 BT_LOGE_STR("Failed to allocate one clock class.");
121 bt_object_init_shared(&clock_class
->base
, destroy_clock_class
);
122 clock_class
->name
.str
= g_string_new(NULL
);
123 if (!clock_class
->name
.str
) {
124 BT_LOGE_STR("Failed to allocate a GString.");
128 clock_class
->description
.str
= g_string_new(NULL
);
129 if (!clock_class
->description
.str
) {
130 BT_LOGE_STR("Failed to allocate a GString.");
134 clock_class
->frequency
= UINT64_C(1000000000);
135 clock_class
->is_absolute
= BT_TRUE
;
136 set_base_offset(clock_class
);
137 ret
= bt_object_pool_initialize(&clock_class
->cv_pool
,
138 (bt_object_pool_new_object_func
) bt_clock_value_new
,
139 (bt_object_pool_destroy_object_func
)
143 BT_LOGE("Failed to initialize clock value pool: ret=%d",
148 BT_LIB_LOGD("Created clock class object: %!+K", clock_class
);
152 BT_OBJECT_PUT_REF_AND_RESET(clock_class
);
158 const char *bt_clock_class_get_name(const struct bt_clock_class
*clock_class
)
160 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
161 return clock_class
->name
.value
;
164 int bt_clock_class_set_name(struct bt_clock_class
*clock_class
,
167 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
168 BT_ASSERT_PRE_NON_NULL(name
, "Name");
169 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
170 g_string_assign(clock_class
->name
.str
, name
);
171 clock_class
->name
.value
= clock_class
->name
.str
->str
;
172 BT_LIB_LOGV("Set clock class's name: %!+K", clock_class
);
176 const char *bt_clock_class_get_description(
177 const struct bt_clock_class
*clock_class
)
179 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
180 return clock_class
->description
.value
;
183 int bt_clock_class_set_description(struct bt_clock_class
*clock_class
,
186 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
187 BT_ASSERT_PRE_NON_NULL(descr
, "Description");
188 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
189 g_string_assign(clock_class
->description
.str
, descr
);
190 clock_class
->description
.value
= clock_class
->description
.str
->str
;
191 BT_LIB_LOGV("Set clock class's description: %!+K",
196 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class
*clock_class
)
198 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
199 return clock_class
->frequency
;
202 void bt_clock_class_set_frequency(struct bt_clock_class
*clock_class
,
205 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
206 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
207 BT_ASSERT_PRE(frequency
!= UINT64_C(-1) && frequency
!= 0,
208 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64
,
209 clock_class
, frequency
);
210 BT_ASSERT_PRE(clock_class
->offset_cycles
< frequency
,
211 "Offset (cycles) is greater than clock class's frequency: "
212 "%![cc-]+K, new-freq=%" PRIu64
, clock_class
, frequency
);
213 clock_class
->frequency
= frequency
;
214 set_base_offset(clock_class
);
215 BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class
);
218 uint64_t bt_clock_class_get_precision(const struct bt_clock_class
*clock_class
)
220 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
221 return clock_class
->precision
;
224 void bt_clock_class_set_precision(struct bt_clock_class
*clock_class
,
227 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
228 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
229 BT_ASSERT_PRE(precision
!= UINT64_C(-1),
230 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64
,
231 clock_class
, precision
);
232 clock_class
->precision
= precision
;
233 BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class
);
236 void bt_clock_class_get_offset(const struct bt_clock_class
*clock_class
,
237 int64_t *seconds
, uint64_t *cycles
)
239 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
240 BT_ASSERT_PRE_NON_NULL(seconds
, "Seconds (output)");
241 BT_ASSERT_PRE_NON_NULL(cycles
, "Cycles (output)");
242 *seconds
= clock_class
->offset_seconds
;
243 *cycles
= clock_class
->offset_cycles
;
246 void bt_clock_class_set_offset(struct bt_clock_class
*clock_class
,
247 int64_t seconds
, uint64_t cycles
)
249 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
250 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
251 BT_ASSERT_PRE(cycles
< clock_class
->frequency
,
252 "Offset (cycles) is greater than clock class's frequency: "
253 "%![cc-]+K, new-offset-cycles=%" PRIu64
, clock_class
, cycles
);
254 clock_class
->offset_seconds
= seconds
;
255 clock_class
->offset_cycles
= cycles
;
256 set_base_offset(clock_class
);
257 BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class
);
260 bt_bool
bt_clock_class_is_absolute(const struct bt_clock_class
*clock_class
)
262 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
263 return (bool) clock_class
->is_absolute
;
266 void bt_clock_class_set_is_absolute(struct bt_clock_class
*clock_class
,
269 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
270 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
271 clock_class
->is_absolute
= (bool) is_absolute
;
272 BT_LIB_LOGV("Set clock class's absolute property: %!+K",
276 bt_uuid
bt_clock_class_get_uuid(const struct bt_clock_class
*clock_class
)
278 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
279 return clock_class
->uuid
.value
;
282 void bt_clock_class_set_uuid(struct bt_clock_class
*clock_class
,
285 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
286 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
287 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
288 memcpy(clock_class
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
289 clock_class
->uuid
.value
= clock_class
->uuid
.uuid
;
290 BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class
);
294 void _bt_clock_class_freeze(const struct bt_clock_class
*clock_class
)
296 BT_ASSERT(clock_class
);
298 if (clock_class
->frozen
) {
302 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class
);
303 ((struct bt_clock_class
*) clock_class
)->frozen
= 1;
306 int bt_clock_class_cycles_to_ns_from_origin(
307 const struct bt_clock_class
*clock_class
,
308 uint64_t cycles
, int64_t *ns
)
312 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
313 BT_ASSERT_PRE_NON_NULL(ns
, "Nanoseconds (output)");
314 ret
= bt_util_ns_from_origin(clock_class
, cycles
, ns
);
316 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
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
);