4 * Babeltrace CTF IR - Clock
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 #include <babeltrace/ctf-ir/clock-internal.h>
30 #include <babeltrace/ctf-ir/utils.h>
31 #include <babeltrace/ref.h>
32 #include <babeltrace/ctf-writer/writer-internal.h>
33 #include <babeltrace/object-internal.h>
34 #include <babeltrace/compiler.h>
38 void bt_ctf_clock_destroy(struct bt_object
*obj
);
41 struct bt_ctf_clock
*_bt_ctf_clock_create(void)
43 struct bt_ctf_clock
*clock
= g_new0(
44 struct bt_ctf_clock
, 1);
51 clock
->frequency
= 1000000000;
52 bt_object_init(clock
, bt_ctf_clock_destroy
);
58 int bt_ctf_clock_set_name(struct bt_ctf_clock
*clock
,
63 if (bt_ctf_validate_identifier(name
)) {
69 g_string_assign(clock
->name
, name
);
71 clock
->name
= g_string_new(name
);
82 struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
)
85 struct bt_ctf_clock
*clock
= NULL
;
87 clock
= _bt_ctf_clock_create();
92 ret
= bt_ctf_clock_set_name(clock
, name
);
97 ret
= bt_uuid_generate(clock
->uuid
);
103 * For backward compatibility reasons, a fresh clock can have
104 * a value because it could be added to a trace created by a
105 * CTF writer. As soon as this clock is added to a non-writer
106 * trace, then its value/time functions will be disabled.
108 clock
->has_value
= 1;
117 const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
)
119 const char *ret
= NULL
;
126 ret
= clock
->name
->str
;
134 const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
)
136 const char *ret
= NULL
;
142 if (clock
->description
) {
143 ret
= clock
->description
->str
;
149 int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
, const char *desc
)
153 if (!clock
|| !desc
|| clock
->frozen
) {
158 clock
->description
= g_string_new(desc
);
159 ret
= clock
->description
? 0 : -1;
165 uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
)
167 uint64_t ret
= -1ULL;
173 ret
= clock
->frequency
;
178 int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
, uint64_t freq
)
182 if (!clock
|| clock
->frozen
) {
187 clock
->frequency
= freq
;
193 uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
)
195 uint64_t ret
= -1ULL;
201 ret
= clock
->precision
;
206 int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
, uint64_t precision
)
210 if (!clock
|| clock
->frozen
) {
215 clock
->precision
= precision
;
221 int bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
, int64_t *offset_s
)
225 if (!clock
|| !offset_s
) {
230 *offset_s
= clock
->offset_s
;
235 int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
, int64_t offset_s
)
239 if (!clock
|| clock
->frozen
) {
244 clock
->offset_s
= offset_s
;
250 int bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
, int64_t *offset
)
254 if (!clock
|| !offset
) {
259 *offset
= clock
->offset
;
264 int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
, int64_t offset
)
268 if (!clock
|| clock
->frozen
) {
273 clock
->offset
= offset
;
279 int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
)
287 ret
= clock
->absolute
;
292 int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
, int is_absolute
)
296 if (!clock
|| clock
->frozen
) {
301 clock
->absolute
= !!is_absolute
;
307 const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
)
309 const unsigned char *ret
;
311 if (!clock
|| !clock
->uuid_set
) {
322 int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
, const unsigned char *uuid
)
326 if (!clock
|| !uuid
|| clock
->frozen
) {
331 memcpy(clock
->uuid
, uuid
, sizeof(uuid_t
));
338 uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
342 if (frequency
== 1000000000) {
345 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
352 int bt_ctf_clock_get_time(struct bt_ctf_clock
*clock
, int64_t *time
)
356 if (!clock
|| !time
) {
362 if (!clock
->has_value
) {
364 * Clock belongs to a non-writer mode trace and thus
365 * this function is disabled.
370 *time
= (int64_t) ns_from_value(clock
->frequency
, clock
->value
);
376 int bt_ctf_clock_set_time(struct bt_ctf_clock
*clock
, int64_t time
)
381 /* Timestamps are strictly monotonic */
388 if (!clock
->has_value
) {
390 * Clock belongs to a non-writer mode trace and thus
391 * this function is disabled.
397 /* Common case where cycles are actually nanoseconds */
398 if (clock
->frequency
== 1000000000) {
401 value
= (uint64_t) (((double) time
*
402 (double) clock
->frequency
) / 1e9
);
405 ret
= bt_ctf_clock_set_value(clock
, value
);
411 uint64_t bt_ctf_clock_get_value(struct bt_ctf_clock
*clock
)
413 uint64_t ret
= -1ULL;
419 if (!clock
->has_value
) {
421 * Clock belongs to a non-writer mode trace and thus
422 * this function is disabled.
433 int bt_ctf_clock_set_value(struct bt_ctf_clock
*clock
, uint64_t value
)
442 if (!clock
->has_value
) {
444 * Clock belongs to a non-writer mode trace and thus
445 * this function is disabled.
451 /* Timestamps are strictly monotonic */
452 if (value
< clock
->value
) {
457 clock
->value
= value
;
462 void bt_ctf_clock_get(struct bt_ctf_clock
*clock
)
467 void bt_ctf_clock_put(struct bt_ctf_clock
*clock
)
473 void bt_ctf_clock_freeze(struct bt_ctf_clock
*clock
)
483 void bt_ctf_clock_serialize(struct bt_ctf_clock
*clock
,
484 struct metadata_context
*context
)
488 if (!clock
|| !context
) {
493 g_string_append(context
->string
, "clock {\n");
494 g_string_append_printf(context
->string
, "\tname = %s;\n",
496 g_string_append_printf(context
->string
,
497 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
498 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
499 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
500 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
501 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
502 if (clock
->description
) {
503 g_string_append_printf(context
->string
, "\tdescription = \"%s\";\n",
504 clock
->description
->str
);
507 g_string_append_printf(context
->string
, "\tfreq = %" PRIu64
";\n",
509 g_string_append_printf(context
->string
, "\tprecision = %" PRIu64
";\n",
511 g_string_append_printf(context
->string
, "\toffset_s = %" PRIu64
";\n",
513 g_string_append_printf(context
->string
, "\toffset = %" PRIu64
";\n",
515 g_string_append_printf(context
->string
, "\tabsolute = %s;\n",
516 clock
->absolute
? "TRUE" : "FALSE");
517 g_string_append(context
->string
, "};\n\n");
521 void bt_ctf_clock_destroy(struct bt_object
*obj
)
523 struct bt_ctf_clock
*clock
;
525 clock
= container_of(obj
, struct bt_ctf_clock
, base
);
527 g_string_free(clock
->name
, TRUE
);
530 if (clock
->description
) {
531 g_string_free(clock
->description
, TRUE
);
538 int64_t bt_ctf_clock_ns_from_value(struct bt_ctf_clock
*clock
, uint64_t value
)
546 /* Initialize nanosecond timestamp to clock's offset in seconds */
547 ns
= clock
->offset_s
* 1000000000;
549 /* Add offset in cycles, converted to nanoseconds */
550 ns
+= ns_from_value(clock
->frequency
, clock
->offset
);
552 /* Add given value, converter to nanoseconds */
553 ns
+= ns_from_value(clock
->frequency
, value
);
This page took 0.044614 seconds and 5 git commands to generate.