4 * Babeltrace CTF IR - Clock class
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "CLOCK-CLASS"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/compat/uuid-internal.h>
33 #include <babeltrace/ctf-ir/clock-class-internal.h>
34 #include <babeltrace/ctf-ir/utils.h>
35 #include <babeltrace/ref.h>
36 #include <babeltrace/compiler-internal.h>
37 #include <babeltrace/types.h>
38 #include <babeltrace/compat/string-internal.h>
40 #include <babeltrace/object-internal.h>
43 void bt_ctf_clock_class_destroy(struct bt_object
*obj
);
46 bt_bool
bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class
*clock_class
)
48 return clock_class
&& clock_class
->name
;
51 int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class
*clock_class
,
57 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
62 if (clock_class
->frozen
) {
63 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
64 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
69 if (bt_ctf_validate_identifier(name
)) {
70 BT_LOGE("Clock class's name is not a valid CTF identifier: "
71 "addr=%p, name=\"%s\"",
77 if (clock_class
->name
) {
78 g_string_assign(clock_class
->name
, name
);
80 clock_class
->name
= g_string_new(name
);
81 if (!clock_class
->name
) {
82 BT_LOGE_STR("Failed to allocate a GString.");
88 BT_LOGV("Set clock class's name: addr=%p, name=\"%s\"",
95 struct bt_ctf_clock_class
*bt_ctf_clock_class_create(const char *name
)
98 struct bt_ctf_clock_class
*clock_class
;
100 BT_LOGD("Creating default clock class object: name=\"%s\"",
102 clock_class
= g_new0(struct bt_ctf_clock_class
, 1);
104 BT_LOGE_STR("Failed to allocate one clock class.");
108 clock_class
->precision
= 1;
109 clock_class
->frequency
= 1000000000;
110 bt_object_init(clock_class
, bt_ctf_clock_class_destroy
);
113 ret
= bt_ctf_clock_class_set_name(clock_class
, name
);
115 BT_LOGE("Cannot set clock class's name: "
116 "addr=%p, name=\"%s\"",
122 BT_LOGD("Created clock class object: addr=%p, name=\"%s\"",
130 const char *bt_ctf_clock_class_get_name(struct bt_ctf_clock_class
*clock_class
)
132 const char *ret
= NULL
;
135 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
139 if (clock_class
->name
) {
140 ret
= clock_class
->name
->str
;
147 const char *bt_ctf_clock_class_get_description(
148 struct bt_ctf_clock_class
*clock_class
)
150 const char *ret
= NULL
;
153 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
157 if (clock_class
->description
) {
158 ret
= clock_class
->description
->str
;
164 int bt_ctf_clock_class_set_description(struct bt_ctf_clock_class
*clock_class
,
169 if (!clock_class
|| !desc
) {
170 BT_LOGW("Invalid parameter: clock class or description is NULL: "
171 "clock-class-addr=%p, name=\"%s\", desc-addr=%p",
172 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
178 if (clock_class
->frozen
) {
179 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
180 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
185 clock_class
->description
= g_string_new(desc
);
186 ret
= clock_class
->description
? 0 : -1;
187 BT_LOGV("Set clock class's description: addr=%p, "
188 "name=\"%s\", desc=\"%s\"",
189 clock_class
, bt_ctf_clock_class_get_name(clock_class
), desc
);
194 uint64_t bt_ctf_clock_class_get_frequency(
195 struct bt_ctf_clock_class
*clock_class
)
197 uint64_t ret
= -1ULL;
200 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
204 ret
= clock_class
->frequency
;
209 int bt_ctf_clock_class_set_frequency(struct bt_ctf_clock_class
*clock_class
,
214 if (!clock_class
|| freq
== -1ULL) {
215 BT_LOGW("Invalid parameter: clock class is NULL or frequency is invalid: "
216 "addr=%p, name=\"%s\", freq=%" PRIu64
,
217 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
223 if (clock_class
->frozen
) {
224 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
225 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
230 clock_class
->frequency
= freq
;
231 BT_LOGV("Set clock class's frequency: addr=%p, name=\"%s\", freq=%" PRIu64
,
232 clock_class
, bt_ctf_clock_class_get_name(clock_class
), freq
);
237 uint64_t bt_ctf_clock_class_get_precision(struct bt_ctf_clock_class
*clock_class
)
239 uint64_t ret
= -1ULL;
242 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
246 ret
= clock_class
->precision
;
251 int bt_ctf_clock_class_set_precision(struct bt_ctf_clock_class
*clock_class
,
256 if (!clock_class
|| precision
== -1ULL) {
257 BT_LOGW("Invalid parameter: clock class is NULL or precision is invalid: "
258 "addr=%p, name=\"%s\", precision=%" PRIu64
,
259 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
265 if (clock_class
->frozen
) {
266 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
267 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
272 clock_class
->precision
= precision
;
273 BT_LOGV("Set clock class's precision: addr=%p, name=\"%s\", precision=%" PRIu64
,
274 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
280 int bt_ctf_clock_class_get_offset_s(struct bt_ctf_clock_class
*clock_class
,
285 if (!clock_class
|| !offset_s
) {
286 BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
287 "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
288 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
294 *offset_s
= clock_class
->offset_s
;
299 int bt_ctf_clock_class_set_offset_s(struct bt_ctf_clock_class
*clock_class
,
305 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
310 if (clock_class
->frozen
) {
311 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
312 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
317 clock_class
->offset_s
= offset_s
;
318 BT_LOGV("Set clock class's offset (seconds): "
319 "addr=%p, name=\"%s\", offset-s=%" PRId64
,
320 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
326 int bt_ctf_clock_class_get_offset_cycles(struct bt_ctf_clock_class
*clock_class
,
331 if (!clock_class
|| !offset
) {
332 BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
333 "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
334 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
340 *offset
= clock_class
->offset
;
345 int bt_ctf_clock_class_set_offset_cycles(struct bt_ctf_clock_class
*clock_class
,
351 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
356 if (clock_class
->frozen
) {
357 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
358 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
363 clock_class
->offset
= offset
;
364 BT_LOGV("Set clock class's offset (cycles): addr=%p, name=\"%s\", offset-cycles=%" PRId64
,
365 clock_class
, bt_ctf_clock_class_get_name(clock_class
), offset
);
370 bt_bool
bt_ctf_clock_class_is_absolute(struct bt_ctf_clock_class
*clock_class
)
375 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
379 ret
= clock_class
->absolute
;
384 int bt_ctf_clock_class_set_is_absolute(struct bt_ctf_clock_class
*clock_class
,
390 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
395 if (clock_class
->frozen
) {
396 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
397 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
402 clock_class
->absolute
= !!is_absolute
;
403 BT_LOGV("Set clock class's absolute flag: addr=%p, name=\"%s\", is-absolute=%d",
404 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
410 const unsigned char *bt_ctf_clock_class_get_uuid(
411 struct bt_ctf_clock_class
*clock_class
)
413 const unsigned char *ret
;
416 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
421 if (!clock_class
->uuid_set
) {
422 BT_LOGV("Clock class's UUID is not set: addr=%p, name=\"%s\"",
423 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
428 ret
= clock_class
->uuid
;
433 int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class
*clock_class
,
434 const unsigned char *uuid
)
438 if (!clock_class
|| !uuid
) {
439 BT_LOGW("Invalid parameter: clock class or UUID is NULL: "
440 "clock-class-addr=%p, name=\"%s\", uuid-addr=%p",
441 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
447 if (clock_class
->frozen
) {
448 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
449 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
454 memcpy(clock_class
->uuid
, uuid
, BABELTRACE_UUID_LEN
);
455 clock_class
->uuid_set
= 1;
456 BT_LOGV("Set clock class's UUID: addr=%p, name=\"%s\", "
457 "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
458 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
459 (unsigned int) uuid
[0],
460 (unsigned int) uuid
[1],
461 (unsigned int) uuid
[2],
462 (unsigned int) uuid
[3],
463 (unsigned int) uuid
[4],
464 (unsigned int) uuid
[5],
465 (unsigned int) uuid
[6],
466 (unsigned int) uuid
[7],
467 (unsigned int) uuid
[8],
468 (unsigned int) uuid
[9],
469 (unsigned int) uuid
[10],
470 (unsigned int) uuid
[11],
471 (unsigned int) uuid
[12],
472 (unsigned int) uuid
[13],
473 (unsigned int) uuid
[14],
474 (unsigned int) uuid
[15]);
479 static uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
483 if (frequency
== 1000000000) {
486 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
493 void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class
*clock_class
)
496 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
500 if (!clock_class
->frozen
) {
501 BT_LOGD("Freezing clock class: addr=%p, name=\"%s\"",
502 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
503 clock_class
->frozen
= 1;
508 void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class
*clock_class
,
509 struct metadata_context
*context
)
513 BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
514 "name=\"%s\", metadata-context-addr=%p", clock_class
,
515 bt_ctf_clock_class_get_name(clock_class
), context
);
517 if (!clock_class
|| !context
) {
518 BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
519 "clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
520 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
525 uuid
= clock_class
->uuid
;
526 g_string_append(context
->string
, "clock {\n");
527 g_string_append_printf(context
->string
, "\tname = %s;\n",
528 clock_class
->name
->str
);
529 g_string_append_printf(context
->string
,
530 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
531 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
532 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
533 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
534 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
535 if (clock_class
->description
) {
536 g_string_append_printf(context
->string
, "\tdescription = \"%s\";\n",
537 clock_class
->description
->str
);
540 g_string_append_printf(context
->string
, "\tfreq = %" PRIu64
";\n",
541 clock_class
->frequency
);
542 g_string_append_printf(context
->string
, "\tprecision = %" PRIu64
";\n",
543 clock_class
->precision
);
544 g_string_append_printf(context
->string
, "\toffset_s = %" PRIu64
";\n",
545 clock_class
->offset_s
);
546 g_string_append_printf(context
->string
, "\toffset = %" PRIu64
";\n",
547 clock_class
->offset
);
548 g_string_append_printf(context
->string
, "\tabsolute = %s;\n",
549 clock_class
->absolute
? "TRUE" : "FALSE");
550 g_string_append(context
->string
, "};\n\n");
554 void bt_ctf_clock_class_destroy(struct bt_object
*obj
)
556 struct bt_ctf_clock_class
*clock_class
;
558 clock_class
= container_of(obj
, struct bt_ctf_clock_class
, base
);
559 BT_LOGD("Destroying clock class: addr=%p, name=\"%s\"",
560 obj
, bt_ctf_clock_class_get_name(clock_class
));
561 if (clock_class
->name
) {
562 g_string_free(clock_class
->name
, TRUE
);
564 if (clock_class
->description
) {
565 g_string_free(clock_class
->description
, TRUE
);
572 void bt_ctf_clock_value_destroy(struct bt_object
*obj
)
574 struct bt_ctf_clock_value
*value
;
580 value
= container_of(obj
, struct bt_ctf_clock_value
, base
);
581 BT_LOGD("Destroying clock value: addr=%p, clock-class-addr=%p, "
582 "clock-class-name=\"%s\"", obj
, value
->clock_class
,
583 bt_ctf_clock_class_get_name(value
->clock_class
));
584 bt_put(value
->clock_class
);
588 struct bt_ctf_clock_value
*bt_ctf_clock_value_create(
589 struct bt_ctf_clock_class
*clock_class
, uint64_t value
)
591 struct bt_ctf_clock_value
*ret
= NULL
;
593 BT_LOGD("Creating clock value object: clock-class-addr=%p, "
594 "clock-class-name=\"%s\", value=%" PRIu64
, clock_class
,
595 bt_ctf_clock_class_get_name(clock_class
), value
);
598 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
602 ret
= g_new0(struct bt_ctf_clock_value
, 1);
604 BT_LOGE_STR("Failed to allocate one clock value.");
608 bt_object_init(ret
, bt_ctf_clock_value_destroy
);
609 ret
->clock_class
= bt_get(clock_class
);
611 BT_LOGD("Created clock value object: clock-value-addr=%p, "
612 "clock-class-addr=%p, clock-class-name=\"%s\"",
613 ret
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
618 int bt_ctf_clock_value_get_value(
619 struct bt_ctf_clock_value
*clock_value
, uint64_t *raw_value
)
623 if (!clock_value
|| !raw_value
) {
624 BT_LOGW("Invalid parameter: clock value or raw value is NULL: "
625 "clock-value-addr=%p, raw-value-addr=%p",
626 clock_value
, raw_value
);
631 *raw_value
= clock_value
->value
;
636 int bt_ctf_clock_value_get_value_ns_from_epoch(struct bt_ctf_clock_value
*value
,
637 int64_t *ret_value_ns
)
642 if (!value
|| !ret_value_ns
) {
643 BT_LOGW("Invalid parameter: clock value or return value pointer is NULL: "
644 "clock-value-addr=%p, ret-value-addr=%p",
645 value
, ret_value_ns
);
650 /* Initialize nanosecond timestamp to clock's offset in seconds. */
651 ns
= value
->clock_class
->offset_s
* (int64_t) 1000000000;
653 /* Add offset in cycles, converted to nanoseconds. */
654 ns
+= ns_from_value(value
->clock_class
->frequency
,
655 value
->clock_class
->offset
);
657 /* Add given value, converter to nanoseconds. */
658 ns
+= ns_from_value(value
->clock_class
->frequency
, value
->value
);
665 struct bt_ctf_clock_class
*bt_ctf_clock_value_get_class(
666 struct bt_ctf_clock_value
*clock_value
)
668 struct bt_ctf_clock_class
*clock_class
= NULL
;
671 BT_LOGW_STR("Invalid parameter: clock value is NULL.");
675 clock_class
= bt_get(clock_value
->clock_class
);