2 * SPDX-License-Identifier: MIT
4 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
7 * Babeltrace CTF writer - Clock
10 #define BT_LOG_TAG "CTF-WRITER/CLOCK"
13 #include "common/assert.h"
14 #include "common/uuid.h"
15 #include "compat/compiler.h"
16 #include <babeltrace2-ctf-writer/utils.h>
17 #include <babeltrace2-ctf-writer/object.h>
20 #include "clock-class.h"
26 void bt_ctf_clock_destroy(struct bt_ctf_object
*obj
);
28 struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
)
31 struct bt_ctf_clock
*clock
= NULL
;
34 BT_CTF_ASSERT_PRE_NON_NULL(name
, "Name");
35 clock
= g_new0(struct bt_ctf_clock
, 1);
40 bt_ctf_object_init_shared(&clock
->base
, bt_ctf_clock_destroy
);
43 /* Pre-2.0.0 backward compatibility: default frequency is 1 GHz */
44 clock
->clock_class
= (void *) bt_ctf_clock_class_create(name
, 1000000000);
45 if (!clock
->clock_class
) {
49 /* Automatically set clock class's UUID. */
50 bt_uuid_generate(cc_uuid
);
52 ret
= bt_ctf_clock_class_set_uuid(clock
->clock_class
, cc_uuid
);
53 BT_ASSERT_DBG(ret
== 0);
57 BT_CTF_OBJECT_PUT_REF_AND_RESET(clock
);
61 const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
)
63 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
64 return bt_ctf_clock_class_get_name(clock
->clock_class
);
67 const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
)
69 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
70 return bt_ctf_clock_class_get_description(clock
->clock_class
);
73 int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
, const char *desc
)
75 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
76 return bt_ctf_clock_class_set_description(clock
->clock_class
,
80 uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
)
82 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
83 return bt_ctf_clock_class_get_frequency(clock
->clock_class
);
86 int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
, uint64_t freq
)
88 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
89 return bt_ctf_clock_class_set_frequency(clock
->clock_class
,
93 uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
)
95 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
96 return bt_ctf_clock_class_get_precision(clock
->clock_class
);
99 int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
, uint64_t precision
)
101 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
102 return bt_ctf_clock_class_set_precision(clock
->clock_class
,
106 int bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
, int64_t *offset_s
)
108 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
109 return bt_ctf_clock_class_get_offset_s(clock
->clock_class
,
113 int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
, int64_t offset_s
)
115 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
116 return bt_ctf_clock_class_set_offset_s(clock
->clock_class
,
120 int bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
, int64_t *offset
)
122 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
123 return bt_ctf_clock_class_get_offset_cycles(clock
->clock_class
,
127 int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
, int64_t offset
)
129 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
130 return bt_ctf_clock_class_set_offset_cycles(clock
->clock_class
,
134 int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
)
136 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
137 return bt_ctf_clock_class_is_absolute(clock
->clock_class
);
140 int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
, int is_absolute
)
142 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
143 return bt_ctf_clock_class_set_is_absolute(clock
->clock_class
,
147 const uint8_t *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
)
149 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
150 return bt_ctf_clock_class_get_uuid(clock
->clock_class
);
153 int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
, const uint8_t *uuid
)
155 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
156 return bt_ctf_clock_class_set_uuid(clock
->clock_class
, uuid
);
159 int bt_ctf_clock_set_time(struct bt_ctf_clock
*clock
, int64_t time
)
162 struct bt_ctf_clock_class
*cc
;
164 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
165 cc
= clock
->clock_class
;
167 /* Common case where cycles are actually nanoseconds */
168 if (cc
->frequency
== 1000000000) {
171 value
= (uint64_t) (((double) time
*
172 (double) cc
->frequency
) / 1e9
);
175 BT_CTF_ASSERT_PRE(clock
->value
<= value
,
176 "CTF writer clock value must be updated monotonically: "
177 "prev-value=%" PRId64
", new-value=%" PRId64
,
178 clock
->value
, value
);
179 clock
->value
= value
;
184 int bt_ctf_clock_get_value(struct bt_ctf_clock
*clock
, uint64_t *value
)
186 BT_CTF_ASSERT_PRE_NON_NULL(clock
, "CTF writer clock");
187 BT_CTF_ASSERT_PRE_NON_NULL(value
, "Value");
188 *value
= clock
->value
;
193 void bt_ctf_clock_destroy(struct bt_ctf_object
*obj
)
195 struct bt_ctf_clock
*clock
;
197 clock
= container_of(obj
, struct bt_ctf_clock
, base
);
198 bt_ctf_object_put_ref(clock
->clock_class
);
203 void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class
*clock_class
,
204 struct metadata_context
*context
)
208 BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, "
209 "name=\"%s\", metadata-context-addr=%p", clock_class
,
210 bt_ctf_clock_class_get_name(clock_class
),
213 if (!clock_class
|| !context
) {
214 BT_LOGW("Invalid parameter: clock class or metadata context is NULL: "
215 "clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p",
217 bt_ctf_clock_class_get_name(clock_class
),
222 uuid
= clock_class
->uuid
;
223 g_string_append(context
->string
, "clock {\n");
224 g_string_append_printf(context
->string
, "\tname = %s;\n",
225 clock_class
->name
->str
);
227 if (clock_class
->uuid_set
) {
228 g_string_append_printf(context
->string
,
229 "\tuuid = \"" BT_UUID_FMT
"\";\n",
230 BT_UUID_FMT_VALUES(uuid
));
233 if (clock_class
->description
) {
234 g_string_append_printf(context
->string
, "\tdescription = \"%s\";\n",
235 clock_class
->description
->str
);
238 g_string_append_printf(context
->string
, "\tfreq = %" PRIu64
";\n",
239 clock_class
->frequency
);
240 g_string_append_printf(context
->string
, "\tprecision = %" PRIu64
";\n",
241 clock_class
->precision
);
242 g_string_append_printf(context
->string
, "\toffset_s = %" PRIu64
";\n",
243 clock_class
->offset_s
);
244 g_string_append_printf(context
->string
, "\toffset = %" PRIu64
";\n",
245 clock_class
->offset
);
246 g_string_append_printf(context
->string
, "\tabsolute = %s;\n",
247 clock_class
->absolute
? "true" : "false");
248 g_string_append(context
->string
, "};\n\n");
This page took 0.035785 seconds and 4 git commands to generate.