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/ctf-ir/clock-class-internal.h>
33 #include <babeltrace/ctf-ir/utils.h>
34 #include <babeltrace/ref.h>
35 #include <babeltrace/compiler-internal.h>
36 #include <babeltrace/types.h>
38 #include <babeltrace/object-internal.h>
41 void bt_ctf_clock_class_destroy(struct bt_object
*obj
);
44 bt_bool
bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class
*clock_class
)
46 return clock_class
&& clock_class
->name
;
49 int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class
*clock_class
,
55 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
60 if (clock_class
->frozen
) {
61 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
62 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
67 if (bt_ctf_validate_identifier(name
)) {
68 BT_LOGE("Clock class's name is not a valid CTF identifier: "
69 "addr=%p, name=\"%s\"",
75 if (clock_class
->name
) {
76 g_string_assign(clock_class
->name
, name
);
78 clock_class
->name
= g_string_new(name
);
79 if (!clock_class
->name
) {
80 BT_LOGE_STR("Failed to allocate a GString.");
86 BT_LOGV("Set clock class's name: addr=%p, name=\"%s\"",
93 struct bt_ctf_clock_class
*bt_ctf_clock_class_create(const char *name
)
96 struct bt_ctf_clock_class
*clock_class
;
98 BT_LOGD("Creating default clock class object: name=\"%s\"",
100 clock_class
= g_new0(struct bt_ctf_clock_class
, 1);
102 BT_LOGE_STR("Failed to allocate one clock class.");
106 clock_class
->precision
= 1;
107 clock_class
->frequency
= 1000000000;
108 bt_object_init(clock_class
, bt_ctf_clock_class_destroy
);
111 ret
= bt_ctf_clock_class_set_name(clock_class
, name
);
113 BT_LOGE("Cannot set clock class's name: "
114 "addr=%p, name=\"%s\"",
120 ret
= bt_uuid_generate(clock_class
->uuid
);
122 BT_LOGE_STR("Failed to generate a UUID.");
126 clock_class
->uuid_set
= 1;
127 BT_LOGD("Created clock class object: addr=%p, name=\"%s\"",
135 const char *bt_ctf_clock_class_get_name(struct bt_ctf_clock_class
*clock_class
)
137 const char *ret
= NULL
;
140 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
144 if (clock_class
->name
) {
145 ret
= clock_class
->name
->str
;
152 const char *bt_ctf_clock_class_get_description(
153 struct bt_ctf_clock_class
*clock_class
)
155 const char *ret
= NULL
;
158 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
162 if (clock_class
->description
) {
163 ret
= clock_class
->description
->str
;
169 int bt_ctf_clock_class_set_description(struct bt_ctf_clock_class
*clock_class
,
174 if (!clock_class
|| !desc
) {
175 BT_LOGW("Invalid parameter: clock class or description is NULL: "
176 "clock-class-addr=%p, name=\"%s\", desc-addr=%p",
177 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
183 if (clock_class
->frozen
) {
184 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
185 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
190 clock_class
->description
= g_string_new(desc
);
191 ret
= clock_class
->description
? 0 : -1;
192 BT_LOGV("Set clock class's description: addr=%p, "
193 "name=\"%s\", desc=\"%s\"",
194 clock_class
, bt_ctf_clock_class_get_name(clock_class
), desc
);
199 uint64_t bt_ctf_clock_class_get_frequency(
200 struct bt_ctf_clock_class
*clock_class
)
202 uint64_t ret
= -1ULL;
205 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
209 ret
= clock_class
->frequency
;
214 int bt_ctf_clock_class_set_frequency(struct bt_ctf_clock_class
*clock_class
,
219 if (!clock_class
|| freq
== -1ULL) {
220 BT_LOGW("Invalid parameter: clock class is NULL or frequency is invalid: "
221 "addr=%p, name=\"%s\", freq=%" PRIu64
,
222 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
228 if (clock_class
->frozen
) {
229 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
230 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
235 clock_class
->frequency
= freq
;
236 BT_LOGV("Set clock class's frequency: addr=%p, name=\"%s\", freq=%" PRIu64
,
237 clock_class
, bt_ctf_clock_class_get_name(clock_class
), freq
);
242 uint64_t bt_ctf_clock_class_get_precision(struct bt_ctf_clock_class
*clock_class
)
244 uint64_t ret
= -1ULL;
247 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
251 ret
= clock_class
->precision
;
256 int bt_ctf_clock_class_set_precision(struct bt_ctf_clock_class
*clock_class
,
261 if (!clock_class
|| precision
== -1ULL) {
262 BT_LOGW("Invalid parameter: clock class is NULL or precision is invalid: "
263 "addr=%p, name=\"%s\", precision=%" PRIu64
,
264 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
270 if (clock_class
->frozen
) {
271 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
272 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
277 clock_class
->precision
= precision
;
278 BT_LOGV("Set clock class's precision: addr=%p, name=\"%s\", precision=%" PRIu64
,
279 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
285 int bt_ctf_clock_class_get_offset_s(struct bt_ctf_clock_class
*clock_class
,
290 if (!clock_class
|| !offset_s
) {
291 BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
292 "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
293 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
299 *offset_s
= clock_class
->offset_s
;
304 int bt_ctf_clock_class_set_offset_s(struct bt_ctf_clock_class
*clock_class
,
310 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
315 if (clock_class
->frozen
) {
316 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
317 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
322 clock_class
->offset_s
= offset_s
;
323 BT_LOGV("Set clock class's offset (seconds): "
324 "addr=%p, name=\"%s\", offset-s=%" PRId64
,
325 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
331 int bt_ctf_clock_class_get_offset_cycles(struct bt_ctf_clock_class
*clock_class
,
336 if (!clock_class
|| !offset
) {
337 BT_LOGW("Invalid parameter: clock class or offset pointer is NULL: "
338 "clock-class-addr=%p, name=\"%s\", offset-addr=%p",
339 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
345 *offset
= clock_class
->offset
;
350 int bt_ctf_clock_class_set_offset_cycles(struct bt_ctf_clock_class
*clock_class
,
356 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
361 if (clock_class
->frozen
) {
362 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
363 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
368 clock_class
->offset
= offset
;
369 BT_LOGV("Set clock class's offset (cycles): addr=%p, name=\"%s\", offset-cycles=%" PRId64
,
370 clock_class
, bt_ctf_clock_class_get_name(clock_class
), offset
);
375 bt_bool
bt_ctf_clock_class_is_absolute(struct bt_ctf_clock_class
*clock_class
)
380 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
384 ret
= clock_class
->absolute
;
389 int bt_ctf_clock_class_set_is_absolute(struct bt_ctf_clock_class
*clock_class
,
395 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
400 if (clock_class
->frozen
) {
401 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
402 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
407 clock_class
->absolute
= !!is_absolute
;
408 BT_LOGV("Set clock class's absolute flag: addr=%p, name=\"%s\", is-absolute=%d",
409 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
415 const unsigned char *bt_ctf_clock_class_get_uuid(
416 struct bt_ctf_clock_class
*clock_class
)
418 const unsigned char *ret
;
421 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
426 if (!clock_class
->uuid_set
) {
427 BT_LOGV("Clock class's UUID is not set: addr=%p, name=\"%s\"",
428 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
433 ret
= clock_class
->uuid
;
438 int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class
*clock_class
,
439 const unsigned char *uuid
)
443 if (!clock_class
|| !uuid
) {
444 BT_LOGW("Invalid parameter: clock class or UUID is NULL: "
445 "clock-class-addr=%p, name=\"%s\", uuid-addr=%p",
446 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
452 if (clock_class
->frozen
) {
453 BT_LOGW("Invalid parameter: clock class is frozen: addr=%p, name=\"%s\"",
454 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
459 memcpy(clock_class
->uuid
, uuid
, sizeof(uuid_t
));
460 clock_class
->uuid_set
= 1;
461 BT_LOGV("Set clock class's UUID: addr=%p, name=\"%s\", "
462 "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
463 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
464 (unsigned int) uuid
[0],
465 (unsigned int) uuid
[1],
466 (unsigned int) uuid
[2],
467 (unsigned int) uuid
[3],
468 (unsigned int) uuid
[4],
469 (unsigned int) uuid
[5],
470 (unsigned int) uuid
[6],
471 (unsigned int) uuid
[7],
472 (unsigned int) uuid
[8],
473 (unsigned int) uuid
[9],
474 (unsigned int) uuid
[10],
475 (unsigned int) uuid
[11],
476 (unsigned int) uuid
[12],
477 (unsigned int) uuid
[13],
478 (unsigned int) uuid
[14],
479 (unsigned int) uuid
[15]);
484 static uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
488 if (frequency
== 1000000000) {
491 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
498 void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class
*clock_class
)
501 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
505 if (!clock_class
->frozen
) {
506 BT_LOGD("Freezing clock class: addr=%p, name=\"%s\"",
507 clock_class
, bt_ctf_clock_class_get_name(clock_class
));
508 clock_class
->frozen
= 1;
513 void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class
*clock_class
,
514 struct metadata_context
*context
)
518 BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
519 "name=\"%s\", metadata-context-addr=%p", clock_class
,
520 bt_ctf_clock_class_get_name(clock_class
), context
);
522 if (!clock_class
|| !context
) {
523 BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
524 "clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
525 clock_class
, bt_ctf_clock_class_get_name(clock_class
),
530 uuid
= clock_class
->uuid
;
531 g_string_append(context
->string
, "clock {\n");
532 g_string_append_printf(context
->string
, "\tname = %s;\n",
533 clock_class
->name
->str
);
534 g_string_append_printf(context
->string
,
535 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
536 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
537 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
538 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
539 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
540 if (clock_class
->description
) {
541 g_string_append_printf(context
->string
, "\tdescription = \"%s\";\n",
542 clock_class
->description
->str
);
545 g_string_append_printf(context
->string
, "\tfreq = %" PRIu64
";\n",
546 clock_class
->frequency
);
547 g_string_append_printf(context
->string
, "\tprecision = %" PRIu64
";\n",
548 clock_class
->precision
);
549 g_string_append_printf(context
->string
, "\toffset_s = %" PRIu64
";\n",
550 clock_class
->offset_s
);
551 g_string_append_printf(context
->string
, "\toffset = %" PRIu64
";\n",
552 clock_class
->offset
);
553 g_string_append_printf(context
->string
, "\tabsolute = %s;\n",
554 clock_class
->absolute
? "TRUE" : "FALSE");
555 g_string_append(context
->string
, "};\n\n");
559 void bt_ctf_clock_class_destroy(struct bt_object
*obj
)
561 struct bt_ctf_clock_class
*clock_class
;
563 clock_class
= container_of(obj
, struct bt_ctf_clock_class
, base
);
564 BT_LOGD("Destroying clock class: addr=%p, name=\"%s\"",
565 obj
, bt_ctf_clock_class_get_name(clock_class
));
566 if (clock_class
->name
) {
567 g_string_free(clock_class
->name
, TRUE
);
569 if (clock_class
->description
) {
570 g_string_free(clock_class
->description
, TRUE
);
577 void bt_ctf_clock_value_destroy(struct bt_object
*obj
)
579 struct bt_ctf_clock_value
*value
;
585 value
= container_of(obj
, struct bt_ctf_clock_value
, base
);
586 BT_LOGD("Destroying clock value: addr=%p, clock-class-addr=%p, "
587 "clock-class-name=\"%s\"", obj
, value
->clock_class
,
588 bt_ctf_clock_class_get_name(value
->clock_class
));
589 bt_put(value
->clock_class
);
593 struct bt_ctf_clock_value
*bt_ctf_clock_value_create(
594 struct bt_ctf_clock_class
*clock_class
, uint64_t value
)
596 struct bt_ctf_clock_value
*ret
= NULL
;
598 BT_LOGD("Creating clock value object: clock-class-addr=%p, "
599 "clock-class-name=\"%s\", value=%" PRIu64
, clock_class
,
600 bt_ctf_clock_class_get_name(clock_class
), value
);
603 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
607 ret
= g_new0(struct bt_ctf_clock_value
, 1);
609 BT_LOGE_STR("Failed to allocate one clock value.");
613 bt_object_init(ret
, bt_ctf_clock_value_destroy
);
614 ret
->clock_class
= bt_get(clock_class
);
616 BT_LOGD("Created clock value object: clock-value-addr=%p, "
617 "clock-class-addr=%p, clock-class-name=\"%s\"",
618 ret
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
623 int bt_ctf_clock_value_get_value(
624 struct bt_ctf_clock_value
*clock_value
, uint64_t *raw_value
)
628 if (!clock_value
|| !raw_value
) {
629 BT_LOGW("Invalid parameter: clock value or raw value is NULL: "
630 "clock-value-addr=%p, raw-value-addr=%p",
631 clock_value
, raw_value
);
636 *raw_value
= clock_value
->value
;
641 int bt_ctf_clock_value_get_value_ns_from_epoch(struct bt_ctf_clock_value
*value
,
642 int64_t *ret_value_ns
)
647 if (!value
|| !ret_value_ns
) {
648 BT_LOGW("Invalid parameter: clock value or return value pointer is NULL: "
649 "clock-value-addr=%p, ret-value-addr=%p",
650 value
, ret_value_ns
);
655 /* Initialize nanosecond timestamp to clock's offset in seconds. */
656 ns
= value
->clock_class
->offset_s
* (int64_t) 1000000000;
658 /* Add offset in cycles, converted to nanoseconds. */
659 ns
+= ns_from_value(value
->clock_class
->frequency
,
660 value
->clock_class
->offset
);
662 /* Add given value, converter to nanoseconds. */
663 ns
+= ns_from_value(value
->clock_class
->frequency
, value
->value
);
670 struct bt_ctf_clock_class
*bt_ctf_clock_value_get_class(
671 struct bt_ctf_clock_value
*clock_value
)
673 struct bt_ctf_clock_class
*clock_class
= NULL
;
676 BT_LOGW_STR("Invalid parameter: clock value is NULL.");
680 clock_class
= bt_get(clock_value
->clock_class
);