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 <babeltrace2/lib-logging-internal.h>
27 #include <babeltrace2/assert-pre-internal.h>
28 #include <babeltrace2/compat/uuid-internal.h>
29 #include <babeltrace2/trace-ir/clock-class-const.h>
30 #include <babeltrace2/trace-ir/clock-class.h>
31 #include <babeltrace2/trace-ir/clock-class-internal.h>
32 #include <babeltrace2/trace-ir/clock-snapshot-internal.h>
33 #include <babeltrace2/trace-ir/utils-internal.h>
34 #include <babeltrace2/compiler-internal.h>
35 #include <babeltrace2/types.h>
36 #include <babeltrace2/compat/string-internal.h>
38 #include <babeltrace2/object-internal.h>
39 #include <babeltrace2/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
->cs_pool
);
68 void free_clock_snapshot(struct bt_clock_snapshot
*clock_snapshot
,
69 struct bt_clock_class
*clock_class
)
71 bt_clock_snapshot_destroy(clock_snapshot
);
75 void set_base_offset(struct bt_clock_class
*clock_class
)
77 clock_class
->base_offset
.overflows
= bt_util_get_base_offset_ns(
78 clock_class
->offset_seconds
, clock_class
->offset_cycles
,
79 clock_class
->frequency
, &clock_class
->base_offset
.value_ns
);
82 struct bt_clock_class
*bt_clock_class_create(bt_self_component
*self_comp
)
85 struct bt_clock_class
*clock_class
= NULL
;
87 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
88 BT_LOGD_STR("Creating default clock class object");
90 clock_class
= g_new0(struct bt_clock_class
, 1);
92 BT_LOGE_STR("Failed to allocate one clock class.");
96 bt_object_init_shared(&clock_class
->base
, destroy_clock_class
);
97 clock_class
->name
.str
= g_string_new(NULL
);
98 if (!clock_class
->name
.str
) {
99 BT_LOGE_STR("Failed to allocate a GString.");
103 clock_class
->description
.str
= g_string_new(NULL
);
104 if (!clock_class
->description
.str
) {
105 BT_LOGE_STR("Failed to allocate a GString.");
109 clock_class
->frequency
= UINT64_C(1000000000);
110 clock_class
->origin_is_unix_epoch
= BT_TRUE
;
111 set_base_offset(clock_class
);
112 ret
= bt_object_pool_initialize(&clock_class
->cs_pool
,
113 (bt_object_pool_new_object_func
) bt_clock_snapshot_new
,
114 (bt_object_pool_destroy_object_func
)
118 BT_LOGE("Failed to initialize clock snapshot pool: ret=%d",
123 BT_LIB_LOGD("Created clock class object: %!+K", clock_class
);
127 BT_OBJECT_PUT_REF_AND_RESET(clock_class
);
133 const char *bt_clock_class_get_name(const struct bt_clock_class
*clock_class
)
135 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
136 return clock_class
->name
.value
;
139 enum bt_clock_class_status
bt_clock_class_set_name(
140 struct bt_clock_class
*clock_class
, const char *name
)
142 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
143 BT_ASSERT_PRE_NON_NULL(name
, "Name");
144 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
145 g_string_assign(clock_class
->name
.str
, name
);
146 clock_class
->name
.value
= clock_class
->name
.str
->str
;
147 BT_LIB_LOGV("Set clock class's name: %!+K", clock_class
);
148 return BT_CLOCK_CLASS_STATUS_OK
;
151 const char *bt_clock_class_get_description(
152 const struct bt_clock_class
*clock_class
)
154 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
155 return clock_class
->description
.value
;
158 enum bt_clock_class_status
bt_clock_class_set_description(
159 struct bt_clock_class
*clock_class
, const char *descr
)
161 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
162 BT_ASSERT_PRE_NON_NULL(descr
, "Description");
163 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
164 g_string_assign(clock_class
->description
.str
, descr
);
165 clock_class
->description
.value
= clock_class
->description
.str
->str
;
166 BT_LIB_LOGV("Set clock class's description: %!+K",
168 return BT_CLOCK_CLASS_STATUS_OK
;
171 uint64_t bt_clock_class_get_frequency(const struct bt_clock_class
*clock_class
)
173 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
174 return clock_class
->frequency
;
177 void bt_clock_class_set_frequency(struct bt_clock_class
*clock_class
,
180 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
181 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
182 BT_ASSERT_PRE(frequency
!= UINT64_C(-1) && frequency
!= 0,
183 "Invalid frequency: %![cc-]+K, new-freq=%" PRIu64
,
184 clock_class
, frequency
);
185 BT_ASSERT_PRE(clock_class
->offset_cycles
< frequency
,
186 "Offset (cycles) is greater than clock class's frequency: "
187 "%![cc-]+K, new-freq=%" PRIu64
, clock_class
, frequency
);
188 clock_class
->frequency
= frequency
;
189 set_base_offset(clock_class
);
190 BT_LIB_LOGV("Set clock class's frequency: %!+K", clock_class
);
193 uint64_t bt_clock_class_get_precision(const struct bt_clock_class
*clock_class
)
195 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
196 return clock_class
->precision
;
199 void bt_clock_class_set_precision(struct bt_clock_class
*clock_class
,
202 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
203 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
204 BT_ASSERT_PRE(precision
!= UINT64_C(-1),
205 "Invalid precision: %![cc-]+K, new-precision=%" PRIu64
,
206 clock_class
, precision
);
207 clock_class
->precision
= precision
;
208 BT_LIB_LOGV("Set clock class's precision: %!+K", clock_class
);
211 void bt_clock_class_get_offset(const struct bt_clock_class
*clock_class
,
212 int64_t *seconds
, uint64_t *cycles
)
214 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
215 BT_ASSERT_PRE_NON_NULL(seconds
, "Seconds (output)");
216 BT_ASSERT_PRE_NON_NULL(cycles
, "Cycles (output)");
217 *seconds
= clock_class
->offset_seconds
;
218 *cycles
= clock_class
->offset_cycles
;
221 void bt_clock_class_set_offset(struct bt_clock_class
*clock_class
,
222 int64_t seconds
, uint64_t cycles
)
224 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
225 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
226 BT_ASSERT_PRE(cycles
< clock_class
->frequency
,
227 "Offset (cycles) is greater than clock class's frequency: "
228 "%![cc-]+K, new-offset-cycles=%" PRIu64
, clock_class
, cycles
);
229 clock_class
->offset_seconds
= seconds
;
230 clock_class
->offset_cycles
= cycles
;
231 set_base_offset(clock_class
);
232 BT_LIB_LOGV("Set clock class's offset: %!+K", clock_class
);
235 bt_bool
bt_clock_class_origin_is_unix_epoch(const struct bt_clock_class
*clock_class
)
237 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
238 return (bool) clock_class
->origin_is_unix_epoch
;
241 void bt_clock_class_set_origin_is_unix_epoch(struct bt_clock_class
*clock_class
,
242 bt_bool origin_is_unix_epoch
)
244 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
245 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
246 clock_class
->origin_is_unix_epoch
= (bool) origin_is_unix_epoch
;
247 BT_LIB_LOGV("Set clock class's origin is Unix epoch property: %!+K",
251 bt_uuid
bt_clock_class_get_uuid(const struct bt_clock_class
*clock_class
)
253 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
254 return clock_class
->uuid
.value
;
257 void bt_clock_class_set_uuid(struct bt_clock_class
*clock_class
,
260 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
261 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
262 BT_ASSERT_PRE_CLOCK_CLASS_HOT(clock_class
);
263 memcpy(clock_class
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
264 clock_class
->uuid
.value
= clock_class
->uuid
.uuid
;
265 BT_LIB_LOGV("Set clock class's UUID: %!+K", clock_class
);
269 void _bt_clock_class_freeze(const struct bt_clock_class
*clock_class
)
271 BT_ASSERT(clock_class
);
273 if (clock_class
->frozen
) {
277 BT_LIB_LOGD("Freezing clock class: %!+K", clock_class
);
278 ((struct bt_clock_class
*) clock_class
)->frozen
= 1;
281 enum bt_clock_class_status
bt_clock_class_cycles_to_ns_from_origin(
282 const struct bt_clock_class
*clock_class
,
283 uint64_t cycles
, int64_t *ns
)
287 BT_ASSERT_PRE_NON_NULL(clock_class
, "Clock class");
288 BT_ASSERT_PRE_NON_NULL(ns
, "Nanoseconds (output)");
289 ret
= bt_util_ns_from_origin_clock_class(clock_class
, cycles
, ns
);
291 ret
= BT_CLOCK_CLASS_STATUS_OVERFLOW
;
292 BT_LIB_LOGW("Cannot convert cycles to nanoseconds "
293 "from origin for given clock class: "
294 "value overflows the signed 64-bit integer range: "
295 "%![cc-]+K, cycles=%" PRIu64
,
296 clock_class
, cycles
);
302 void bt_clock_class_get_ref(const struct bt_clock_class
*clock_class
)
304 bt_object_get_ref(clock_class
);
307 void bt_clock_class_put_ref(const struct bt_clock_class
*clock_class
)
309 bt_object_put_ref(clock_class
);