2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "CLOCK-CLASS"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/compat/uuid-internal.h>
30 #include <babeltrace/trace-ir/clock-class-internal.h>
31 #include <babeltrace/trace-ir/clock-value-internal.h>
32 #include <babeltrace/trace-ir/utils-internal.h>
33 #include <babeltrace/object.h>
34 #include <babeltrace/compiler-internal.h>
35 #include <babeltrace/types.h>
36 #include <babeltrace/compat/string-internal.h>
38 #include <babeltrace/object-internal.h>
39 #include <babeltrace/assert-internal.h>
41 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
42 BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
45 void destroy_clock_class(struct bt_object
*obj
)
47 struct bt_clock_class
*clock_class
= (void *) obj
;
49 BT_LIB_LOGD("Destroying clock class: %!+K", clock_class
);
51 if (clock_class
->name
.str
) {
52 g_string_free(clock_class
->name
.str
, TRUE
);
53 clock_class
->name
.str
= NULL
;
54 clock_class
->name
.value
= NULL
;
57 if (clock_class
->description
.str
) {
58 g_string_free(clock_class
->description
.str
, TRUE
);
59 clock_class
->description
.str
= NULL
;
60 clock_class
->description
.value
= NULL
;
63 bt_object_pool_finalize(&clock_class
->cv_pool
);
68 void free_clock_value(struct bt_clock_value
*clock_value
,
69 struct bt_clock_class
*clock_class
)
71 bt_clock_value_destroy(clock_value
);
75 void set_base_offset(struct bt_clock_class
*clock_class
)
77 uint64_t offset_cycles_ns
;
79 /* Initialize nanosecond timestamp to clock's offset in seconds */
80 if (clock_class
->offset_seconds
<= (INT64_MIN
/ INT64_C(1000000000) - 1) ||
81 clock_class
->offset_seconds
>= (INT64_MAX
/ INT64_C(1000000000)) - 1) {
83 * Overflow: offset in seconds converted to nanoseconds
84 * is outside the int64_t range. We also subtract 1 here
85 * to leave "space" for the offset in cycles converted
86 * to nanoseconds (which is always less than 1 second by
89 clock_class
->base_offset
.overflows
= true;
93 /* Offset (seconds) to nanoseconds */
94 clock_class
->base_offset
.value_ns
= clock_class
->offset_seconds
*
97 /* Add offset in cycles */
98 BT_ASSERT(clock_class
->offset_cycles
< clock_class
->frequency
);
99 offset_cycles_ns
= bt_util_ns_from_value(clock_class
->frequency
,
100 clock_class
->offset_cycles
);
101 BT_ASSERT(offset_cycles_ns
< 1000000000);
102 clock_class
->base_offset
.value_ns
+= (int64_t) offset_cycles_ns
;
103 clock_class
->base_offset
.overflows
= false;
109 struct bt_private_clock_class
*bt_private_clock_class_create(void)
112 struct bt_clock_class
*clock_class
= NULL
;
114 BT_LOGD_STR("Creating default clock class object");
116 clock_class
= g_new0(struct bt_clock_class
, 1);
118 BT_LOGE_STR("Failed to allocate one clock class.");
122 bt_object_init_shared(&clock_class
->base
, destroy_clock_class
);
123 clock_class
->name
.str
= g_string_new(NULL
);
124 if (!clock_class
->name
.str
) {
125 BT_LOGE_STR("Failed to allocate a GString.");
129 clock_class
->description
.str
= g_string_new(NULL
);
130 if (!clock_class
->description
.str
) {
131 BT_LOGE_STR("Failed to allocate a GString.");
135 clock_class
->frequency
= UINT64_C(1000000000);
136 clock_class
->is_absolute
= BT_TRUE
;
137 set_base_offset(clock_class
);
138 ret
= bt_object_pool_initialize(&clock_class
->cv_pool
,
139 (bt_object_pool_new_object_func
) bt_clock_value_new
,
140 (bt_object_pool_destroy_object_func
)
144 BT_LOGE("Failed to initialize clock value pool: ret=%d",
149 BT_LIB_LOGD("Created clock class object: %!+K", clock_class
);
153 BT_OBJECT_PUT_REF_AND_RESET(clock_class
);
156 return (void *) clock_class
;
159 const char *bt_clock_class_get_name(
160 struct bt_clock_class
*clock_class
)
162 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
163 return clock_class
->name
.value
;
166 int bt_private_clock_class_set_name(
167 struct bt_private_clock_class
*priv_clock_class
,
170 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
172 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
173 BT_ASSERT_PRE_NON_NULL(name
, "Name");
174 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
175 g_string_assign(clock_class
->name
.str
, name
);
176 clock_class
->name
.value
= clock_class
->name
.str
->str
;
177 BT_LIB_LOGV("Set clock class's name: %!+K", clock_class
);
181 const char *bt_clock_class_get_description(struct bt_clock_class
*clock_class
)
183 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
184 return clock_class
->description
.value
;
187 int bt_private_clock_class_set_description(
188 struct bt_private_clock_class
*priv_clock_class
,
191 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
193 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
194 BT_ASSERT_PRE_NON_NULL(descr
, "Description");
195 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
196 g_string_assign(clock_class
->description
.str
, descr
);
197 clock_class
->description
.value
= clock_class
->description
.str
->str
;
198 BT_LIB_LOGV("Set clock class's description: %!+K",
203 uint64_t bt_clock_class_get_frequency(struct bt_clock_class
*clock_class
)
205 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
206 return clock_class
->frequency
;
209 void bt_private_clock_class_set_frequency(
210 struct bt_private_clock_class
*priv_clock_class
,
213 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
215 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
216 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
217 BT_ASSERT_PRE(frequency
!= UINT64_C(-1) && frequency
!= 0,
218 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64
,
219 clock_class
, frequency
);
220 BT_ASSERT_PRE(clock_class
->offset_cycles
< frequency
,
221 "Offset (cycles) is greater than clock class's frequency: "
222 "%![cc-]+K, new-freq=%" PRIu64
, clock_class
, frequency
);
223 clock_class
->frequency
= frequency
;
224 set_base_offset(clock_class
);
225 BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class
);
228 uint64_t bt_clock_class_get_precision(struct bt_clock_class
*clock_class
)
230 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
231 return clock_class
->precision
;
234 void bt_private_clock_class_set_precision(
235 struct bt_private_clock_class
*priv_clock_class
,
238 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
240 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
241 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
242 BT_ASSERT_PRE(precision
!= UINT64_C(-1),
243 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64
,
244 clock_class
, precision
);
245 clock_class
->precision
= precision
;
246 BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class
);
249 void bt_clock_class_get_offset(struct bt_clock_class
*clock_class
,
250 int64_t *seconds
, uint64_t *cycles
)
252 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
253 BT_ASSERT_PRE_NON_NULL(seconds
, "Seconds (output)");
254 BT_ASSERT_PRE_NON_NULL(cycles
, "Cycles (output)");
255 *seconds
= clock_class
->offset_seconds
;
256 *cycles
= clock_class
->offset_cycles
;
259 void bt_private_clock_class_set_offset(
260 struct bt_private_clock_class
*priv_clock_class
,
261 int64_t seconds
, uint64_t cycles
)
263 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
265 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
266 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
267 BT_ASSERT_PRE(cycles
< clock_class
->frequency
,
268 "Offset (cycles) is greater than clock class's frequency: "
269 "%![cc-]+K, new-offset-cycles=%" PRIu64
, clock_class
, cycles
);
270 clock_class
->offset_seconds
= seconds
;
271 clock_class
->offset_cycles
= cycles
;
272 set_base_offset(clock_class
);
273 BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class
);
276 bt_bool
bt_clock_class_is_absolute(struct bt_clock_class
*clock_class
)
278 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
279 return (bool) clock_class
->is_absolute
;
282 void bt_private_clock_class_set_is_absolute(
283 struct bt_private_clock_class
*priv_clock_class
,
286 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
288 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
289 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
290 clock_class
->is_absolute
= (bool) is_absolute
;
291 BT_LIB_LOGV("Set clock class's absolute property: %!+K",
295 bt_uuid
bt_clock_class_get_uuid(struct bt_clock_class
*clock_class
)
297 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
298 return clock_class
->uuid
.value
;
301 void bt_private_clock_class_set_uuid(
302 struct bt_private_clock_class
*priv_clock_class
,
305 struct bt_clock_class
*clock_class
= (void *) priv_clock_class
;
307 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
308 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
309 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
310 memcpy(clock_class
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
311 clock_class
->uuid
.value
= clock_class
->uuid
.uuid
;
312 BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class
);
316 void _bt_clock_class_freeze(struct bt_clock_class
*clock_class
)
318 BT_ASSERT(clock_class
);
320 if (clock_class
->frozen
) {
324 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class
);
325 clock_class
->frozen
= 1;
328 int bt_clock_class_cycles_to_ns_from_origin(struct bt_clock_class
*clock_class
,
329 uint64_t cycles
, int64_t *ns
)
333 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
334 BT_ASSERT_PRE_NON_NULL(ns
, "Nanoseconds (output)");
335 ret
= bt_util_ns_from_origin(clock_class
, cycles
, ns
);
337 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
338 "from origin for given clock class: "
339 "value overflows the signed 64-bit integer range: "
340 "%![cc-]+K, cycles=%" PRIu64
,
341 clock_class
, cycles
);