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 "LIB/CLOCK-CLASS"
25 #include "lib/logging.h"
27 #include "lib/assert-pre.h"
28 #include "common/uuid.h"
29 #include <babeltrace2/trace-ir/clock-class-const.h>
30 #include <babeltrace2/trace-ir/clock-class.h>
31 #include "clock-class.h"
32 #include "clock-snapshot.h"
34 #include "compat/compiler.h"
35 #include <babeltrace2/types.h>
36 #include "compat/string.h"
38 #include "lib/object.h"
39 #include "common/assert.h"
40 #include "lib/func-status.h"
42 #define BT_ASSERT_PRE_CLOCK_CLASS_HOT(_cc) \
43 BT_ASSERT_PRE_HOT((_cc), "Clock class", ": %!+K", (_cc))
46 void destroy_clock_class(struct bt_object
*obj
)
48 struct bt_clock_class
*clock_class
= (void *) obj
;
50 BT_LIB_LOGD("Destroying clock class: %!+K", clock_class
);
52 if (clock_class
->name
.str
) {
53 g_string_free(clock_class
->name
.str
, TRUE
);
54 clock_class
->name
.str
= NULL
;
55 clock_class
->name
.value
= NULL
;
58 if (clock_class
->description
.str
) {
59 g_string_free(clock_class
->description
.str
, TRUE
);
60 clock_class
->description
.str
= NULL
;
61 clock_class
->description
.value
= NULL
;
64 bt_object_pool_finalize(&clock_class
->cs_pool
);
69 void free_clock_snapshot(struct bt_clock_snapshot
*clock_snapshot
,
70 struct bt_clock_class
*clock_class
)
72 bt_clock_snapshot_destroy(clock_snapshot
);
76 void set_base_offset(struct bt_clock_class
*clock_class
)
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
);
83 struct bt_clock_class
*bt_clock_class_create(bt_self_component
*self_comp
)
86 struct bt_clock_class
*clock_class
= NULL
;
88 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
89 BT_LOGD_STR("Creating default clock class object");
91 clock_class
= g_new0(struct bt_clock_class
, 1);
93 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one clock class.");
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
) {
100 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
104 clock_class
->description
.str
= g_string_new(NULL
);
105 if (!clock_class
->description
.str
) {
106 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
110 clock_class
->frequency
= UINT64_C(1000000000);
111 clock_class
->origin_is_unix_epoch
= BT_TRUE
;
112 set_base_offset(clock_class
);
113 ret
= bt_object_pool_initialize(&clock_class
->cs_pool
,
114 (bt_object_pool_new_object_func
) bt_clock_snapshot_new
,
115 (bt_object_pool_destroy_object_func
)
119 BT_LIB_LOGE_APPEND_CAUSE(
120 "Failed to initialize clock snapshot pool: ret=%d",
125 BT_LIB_LOGD("Created clock class object: %!+K", clock_class
);
129 BT_OBJECT_PUT_REF_AND_RESET(clock_class
);
135 const char *bt_clock_class_get_name(const struct bt_clock_class
*clock_class
)
137 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
138 return clock_class
->name
.value
;
141 enum bt_clock_class_set_name_status
bt_clock_class_set_name(
142 struct bt_clock_class
*clock_class
, const char *name
)
144 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
145 BT_ASSERT_PRE_NON_NULL(name
, "Name");
146 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
147 g_string_assign(clock_class
->name
.str
, name
);
148 clock_class
->name
.value
= clock_class
->name
.str
->str
;
149 BT_LIB_LOGD("Set clock class's name: %!+K", clock_class
);
150 return BT_FUNC_STATUS_OK
;
153 const char *bt_clock_class_get_description(
154 const struct bt_clock_class
*clock_class
)
156 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
157 return clock_class
->description
.value
;
160 enum bt_clock_class_set_description_status
bt_clock_class_set_description(
161 struct bt_clock_class
*clock_class
, const char *descr
)
163 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
164 BT_ASSERT_PRE_NON_NULL(descr
, "Description");
165 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
166 g_string_assign(clock_class
->description
.str
, descr
);
167 clock_class
->description
.value
= clock_class
->description
.str
->str
;
168 BT_LIB_LOGD("Set clock class's description: %!+K",
170 return BT_FUNC_STATUS_OK
;
173 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class
*clock_class
)
175 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
176 return clock_class
->frequency
;
179 void bt_clock_class_set_frequency(struct bt_clock_class
*clock_class
,
182 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
183 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
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
);
192 BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class
);
195 uint64_t bt_clock_class_get_precision(const struct bt_clock_class
*clock_class
)
197 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
198 return clock_class
->precision
;
201 void bt_clock_class_set_precision(struct bt_clock_class
*clock_class
,
204 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
205 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
206 BT_ASSERT_PRE(precision
!= UINT64_C(-1),
207 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64
,
208 clock_class
, precision
);
209 clock_class
->precision
= precision
;
210 BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class
);
213 void bt_clock_class_get_offset(const struct bt_clock_class
*clock_class
,
214 int64_t *seconds
, uint64_t *cycles
)
216 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
217 BT_ASSERT_PRE_NON_NULL(seconds
, "Seconds (output)");
218 BT_ASSERT_PRE_NON_NULL(cycles
, "Cycles (output)");
219 *seconds
= clock_class
->offset_seconds
;
220 *cycles
= clock_class
->offset_cycles
;
223 void bt_clock_class_set_offset(struct bt_clock_class
*clock_class
,
224 int64_t seconds
, uint64_t cycles
)
226 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
227 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
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
);
234 BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class
);
237 bt_bool
bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class
*clock_class
)
239 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
240 return (bool) clock_class
->origin_is_unix_epoch
;
243 void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class
*clock_class
,
244 bt_bool origin_is_unix_epoch
)
246 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
247 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
248 clock_class
->origin_is_unix_epoch
= (bool) origin_is_unix_epoch
;
249 BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
253 bt_uuid
bt_clock_class_get_uuid(const struct bt_clock_class
*clock_class
)
255 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
256 return clock_class
->uuid
.value
;
259 void bt_clock_class_set_uuid(struct bt_clock_class
*clock_class
,
262 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
263 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
264 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
265 bt_uuid_copy(clock_class
->uuid
.uuid
, uuid
);
266 clock_class
->uuid
.value
= clock_class
->uuid
.uuid
;
267 BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class
);
271 void _bt_clock_class_freeze(const struct bt_clock_class
*clock_class
)
273 BT_ASSERT(clock_class
);
275 if (clock_class
->frozen
) {
279 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class
);
280 ((struct bt_clock_class
*) clock_class
)->frozen
= 1;
283 enum bt_clock_class_cycles_to_ns_from_origin_status
284 bt_clock_class_cycles_to_ns_from_origin(
285 const struct bt_clock_class
*clock_class
,
286 uint64_t cycles
, int64_t *ns
)
290 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
291 BT_ASSERT_PRE_NON_NULL(ns
, "Nanoseconds (output)");
292 ret
= bt_util_ns_from_origin_clock_class(clock_class
, cycles
, ns
);
294 ret
= BT_FUNC_STATUS_OVERFLOW
;
295 BT_LIB_LOGD("Cannot convert cycles to nanoseconds "
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
);
305 void bt_clock_class_get_ref(const struct bt_clock_class
*clock_class
)
307 bt_object_get_ref(clock_class
);
310 void bt_clock_class_put_ref(const struct bt_clock_class
*clock_class
)
312 bt_object_put_ref(clock_class
);