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 "compat/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_LOGE_STR("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_LOGE_STR("Failed to allocate a GString.");
104 clock_class
->description
.str
= g_string_new(NULL
);
105 if (!clock_class
->description
.str
) {
106 BT_LOGE_STR("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_LOGE("Failed to initialize clock snapshot pool: ret=%d",
124 BT_LIB_LOGD("Created clock class object: %!+K", clock_class
);
128 BT_OBJECT_PUT_REF_AND_RESET(clock_class
);
134 const char *bt_clock_class_get_name(const struct bt_clock_class
*clock_class
)
136 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
137 return clock_class
->name
.value
;
140 enum bt_clock_class_set_name_status
bt_clock_class_set_name(
141 struct bt_clock_class
*clock_class
, const char *name
)
143 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
144 BT_ASSERT_PRE_NON_NULL(name
, "Name");
145 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
146 g_string_assign(clock_class
->name
.str
, name
);
147 clock_class
->name
.value
= clock_class
->name
.str
->str
;
148 BT_LIB_LOGD("Set clock class's name: %!+K", clock_class
);
149 return BT_FUNC_STATUS_OK
;
152 const char *bt_clock_class_get_description(
153 const struct bt_clock_class
*clock_class
)
155 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
156 return clock_class
->description
.value
;
159 enum bt_clock_class_set_description_status
bt_clock_class_set_description(
160 struct bt_clock_class
*clock_class
, const char *descr
)
162 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
163 BT_ASSERT_PRE_NON_NULL(descr
, "Description");
164 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
165 g_string_assign(clock_class
->description
.str
, descr
);
166 clock_class
->description
.value
= clock_class
->description
.str
->str
;
167 BT_LIB_LOGD("Set clock class's description: %!+K",
169 return BT_FUNC_STATUS_OK
;
172 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class
*clock_class
)
174 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
175 return clock_class
->frequency
;
178 void bt_clock_class_set_frequency(struct bt_clock_class
*clock_class
,
181 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
182 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
183 BT_ASSERT_PRE(frequency
!= UINT64_C(-1) && frequency
!= 0,
184 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64
,
185 clock_class
, frequency
);
186 BT_ASSERT_PRE(clock_class
->offset_cycles
< frequency
,
187 "Offset (cycles) is greater than clock class's frequency: "
188 "%![cc-]+K, new-freq=%" PRIu64
, clock_class
, frequency
);
189 clock_class
->frequency
= frequency
;
190 set_base_offset(clock_class
);
191 BT_LIB_LOGD("Set clock class's frequency: %!+K", clock_class
);
194 uint64_t bt_clock_class_get_precision(const struct bt_clock_class
*clock_class
)
196 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
197 return clock_class
->precision
;
200 void bt_clock_class_set_precision(struct bt_clock_class
*clock_class
,
203 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
204 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
205 BT_ASSERT_PRE(precision
!= UINT64_C(-1),
206 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64
,
207 clock_class
, precision
);
208 clock_class
->precision
= precision
;
209 BT_LIB_LOGD("Set clock class's precision: %!+K", clock_class
);
212 void bt_clock_class_get_offset(const struct bt_clock_class
*clock_class
,
213 int64_t *seconds
, uint64_t *cycles
)
215 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
216 BT_ASSERT_PRE_NON_NULL(seconds
, "Seconds (output)");
217 BT_ASSERT_PRE_NON_NULL(cycles
, "Cycles (output)");
218 *seconds
= clock_class
->offset_seconds
;
219 *cycles
= clock_class
->offset_cycles
;
222 void bt_clock_class_set_offset(struct bt_clock_class
*clock_class
,
223 int64_t seconds
, uint64_t cycles
)
225 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
226 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
227 BT_ASSERT_PRE(cycles
< clock_class
->frequency
,
228 "Offset (cycles) is greater than clock class's frequency: "
229 "%![cc-]+K, new-offset-cycles=%" PRIu64
, clock_class
, cycles
);
230 clock_class
->offset_seconds
= seconds
;
231 clock_class
->offset_cycles
= cycles
;
232 set_base_offset(clock_class
);
233 BT_LIB_LOGD("Set clock class's offset: %!+K", clock_class
);
236 bt_bool
bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class
*clock_class
)
238 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
239 return (bool) clock_class
->origin_is_unix_epoch
;
242 void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class
*clock_class
,
243 bt_bool origin_is_unix_epoch
)
245 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
246 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
247 clock_class
->origin_is_unix_epoch
= (bool) origin_is_unix_epoch
;
248 BT_LIB_LOGD("Set clock class's origin is Unix epoch property: %!+K",
252 bt_uuid
bt_clock_class_get_uuid(const struct bt_clock_class
*clock_class
)
254 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
255 return clock_class
->uuid
.value
;
258 void bt_clock_class_set_uuid(struct bt_clock_class
*clock_class
,
261 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
262 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
263 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
264 memcpy(clock_class
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
265 clock_class
->uuid
.value
= clock_class
->uuid
.uuid
;
266 BT_LIB_LOGD("Set clock class's UUID: %!+K", clock_class
);
270 void _bt_clock_class_freeze(const struct bt_clock_class
*clock_class
)
272 BT_ASSERT(clock_class
);
274 if (clock_class
->frozen
) {
278 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class
);
279 ((struct bt_clock_class
*) clock_class
)->frozen
= 1;
282 enum bt_clock_class_cycles_to_ns_from_origin_status
283 bt_clock_class_cycles_to_ns_from_origin(
284 const struct bt_clock_class
*clock_class
,
285 uint64_t cycles
, int64_t *ns
)
289 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
290 BT_ASSERT_PRE_NON_NULL(ns
, "Nanoseconds (output)");
291 ret
= bt_util_ns_from_origin_clock_class(clock_class
, cycles
, ns
);
293 ret
= BT_FUNC_STATUS_OVERFLOW
;
294 BT_LIB_LOGD("Cannot convert cycles to nanoseconds "
295 "from origin for given clock class: "
296 "value overflows the signed 64-bit integer range: "
297 "%![cc-]+K, cycles=%" PRIu64
,
298 clock_class
, cycles
);
304 void bt_clock_class_get_ref(const struct bt_clock_class
*clock_class
)
306 bt_object_get_ref(clock_class
);
309 void bt_clock_class_put_ref(const struct bt_clock_class
*clock_class
)
311 bt_object_put_ref(clock_class
);