Commit | Line | Data |
---|---|---|
ac0c6bdd | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
ac0c6bdd PP |
3 | * |
4 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
5 | * Copyright 2017 Philippe Proulx <pproulx@efficios.com> | |
6 | * | |
0235b0db | 7 | * Babeltrace CTF writer - Clock |
ac0c6bdd PP |
8 | */ |
9 | ||
350ad6c1 | 10 | #define BT_LOG_TAG "CTF-WRITER/CLOCK" |
67d2ce02 | 11 | #include "logging.h" |
f6ccaed9 | 12 | |
578e048b | 13 | #include "common/assert.h" |
6162e6b7 | 14 | #include "common/uuid.h" |
578e048b | 15 | #include "compat/compiler.h" |
217cf9d3 PP |
16 | #include <babeltrace2-ctf-writer/utils.h> |
17 | #include <babeltrace2-ctf-writer/object.h> | |
ac0c6bdd PP |
18 | #include <inttypes.h> |
19 | ||
578e048b MJ |
20 | #include "clock-class.h" |
21 | #include "clock.h" | |
22 | #include "object.h" | |
23 | #include "writer.h" | |
24 | ||
ac0c6bdd | 25 | static |
e1e02a22 | 26 | void bt_ctf_clock_destroy(struct bt_ctf_object *obj); |
ac0c6bdd | 27 | |
1353b066 | 28 | BT_EXPORT |
ac0c6bdd PP |
29 | struct bt_ctf_clock *bt_ctf_clock_create(const char *name) |
30 | { | |
75c3fca1 | 31 | int ret; |
ac0c6bdd | 32 | struct bt_ctf_clock *clock = NULL; |
6162e6b7 | 33 | bt_uuid_t cc_uuid; |
ac0c6bdd | 34 | |
67d2ce02 | 35 | BT_CTF_ASSERT_PRE_NON_NULL(name, "Name"); |
ac0c6bdd | 36 | clock = g_new0(struct bt_ctf_clock, 1); |
ac0c6bdd PP |
37 | if (!clock) { |
38 | goto error; | |
39 | } | |
40 | ||
e1e02a22 | 41 | bt_ctf_object_init_shared(&clock->base, bt_ctf_clock_destroy); |
ac0c6bdd | 42 | clock->value = 0; |
f3534905 PP |
43 | |
44 | /* Pre-2.0.0 backward compatibility: default frequency is 1 GHz */ | |
16ca5ff0 | 45 | clock->clock_class = (void *) bt_ctf_clock_class_create(name, 1000000000); |
ac0c6bdd PP |
46 | if (!clock->clock_class) { |
47 | goto error; | |
48 | } | |
75c3fca1 PP |
49 | |
50 | /* Automatically set clock class's UUID. */ | |
6162e6b7 | 51 | bt_uuid_generate(cc_uuid); |
75c3fca1 | 52 | |
16ca5ff0 | 53 | ret = bt_ctf_clock_class_set_uuid(clock->clock_class, cc_uuid); |
98b15851 | 54 | BT_ASSERT_DBG(ret == 0); |
ac0c6bdd PP |
55 | return clock; |
56 | ||
57 | error: | |
e1e02a22 | 58 | BT_CTF_OBJECT_PUT_REF_AND_RESET(clock); |
ac0c6bdd PP |
59 | return clock; |
60 | } | |
61 | ||
1353b066 | 62 | BT_EXPORT |
ac0c6bdd PP |
63 | const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock) |
64 | { | |
67d2ce02 | 65 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 66 | return bt_ctf_clock_class_get_name(clock->clock_class); |
ac0c6bdd PP |
67 | } |
68 | ||
1353b066 | 69 | BT_EXPORT |
ac0c6bdd PP |
70 | const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock) |
71 | { | |
67d2ce02 | 72 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 73 | return bt_ctf_clock_class_get_description(clock->clock_class); |
ac0c6bdd PP |
74 | } |
75 | ||
1353b066 | 76 | BT_EXPORT |
ac0c6bdd PP |
77 | int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc) |
78 | { | |
67d2ce02 | 79 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 80 | return bt_ctf_clock_class_set_description(clock->clock_class, |
3dca2276 | 81 | desc); |
ac0c6bdd PP |
82 | } |
83 | ||
1353b066 | 84 | BT_EXPORT |
ac0c6bdd PP |
85 | uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock) |
86 | { | |
67d2ce02 | 87 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 88 | return bt_ctf_clock_class_get_frequency(clock->clock_class); |
ac0c6bdd PP |
89 | } |
90 | ||
1353b066 | 91 | BT_EXPORT |
ac0c6bdd PP |
92 | int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq) |
93 | { | |
67d2ce02 | 94 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 95 | return bt_ctf_clock_class_set_frequency(clock->clock_class, |
3dca2276 | 96 | freq); |
ac0c6bdd PP |
97 | } |
98 | ||
1353b066 | 99 | BT_EXPORT |
ac0c6bdd PP |
100 | uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock) |
101 | { | |
67d2ce02 | 102 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 103 | return bt_ctf_clock_class_get_precision(clock->clock_class); |
ac0c6bdd PP |
104 | } |
105 | ||
1353b066 | 106 | BT_EXPORT |
ac0c6bdd PP |
107 | int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision) |
108 | { | |
67d2ce02 | 109 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 110 | return bt_ctf_clock_class_set_precision(clock->clock_class, |
3dca2276 | 111 | precision); |
ac0c6bdd PP |
112 | } |
113 | ||
1353b066 | 114 | BT_EXPORT |
ac0c6bdd PP |
115 | int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, int64_t *offset_s) |
116 | { | |
67d2ce02 | 117 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 118 | return bt_ctf_clock_class_get_offset_s(clock->clock_class, |
3dca2276 | 119 | offset_s); |
ac0c6bdd PP |
120 | } |
121 | ||
1353b066 | 122 | BT_EXPORT |
ac0c6bdd PP |
123 | int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s) |
124 | { | |
67d2ce02 | 125 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 126 | return bt_ctf_clock_class_set_offset_s(clock->clock_class, |
3dca2276 | 127 | offset_s); |
ac0c6bdd PP |
128 | } |
129 | ||
1353b066 | 130 | BT_EXPORT |
ac0c6bdd PP |
131 | int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, int64_t *offset) |
132 | { | |
67d2ce02 | 133 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 134 | return bt_ctf_clock_class_get_offset_cycles(clock->clock_class, |
3dca2276 | 135 | offset); |
ac0c6bdd PP |
136 | } |
137 | ||
1353b066 | 138 | BT_EXPORT |
ac0c6bdd PP |
139 | int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset) |
140 | { | |
67d2ce02 | 141 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 142 | return bt_ctf_clock_class_set_offset_cycles(clock->clock_class, |
3dca2276 | 143 | offset); |
ac0c6bdd PP |
144 | } |
145 | ||
1353b066 | 146 | BT_EXPORT |
ac0c6bdd PP |
147 | int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock) |
148 | { | |
67d2ce02 | 149 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 150 | return bt_ctf_clock_class_is_absolute(clock->clock_class); |
ac0c6bdd PP |
151 | } |
152 | ||
1353b066 | 153 | BT_EXPORT |
ac0c6bdd PP |
154 | int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute) |
155 | { | |
67d2ce02 | 156 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 157 | return bt_ctf_clock_class_set_is_absolute(clock->clock_class, |
3dca2276 | 158 | is_absolute); |
ac0c6bdd PP |
159 | } |
160 | ||
1353b066 | 161 | BT_EXPORT |
6162e6b7 | 162 | const uint8_t *bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock) |
ac0c6bdd | 163 | { |
67d2ce02 | 164 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 165 | return bt_ctf_clock_class_get_uuid(clock->clock_class); |
ac0c6bdd PP |
166 | } |
167 | ||
1353b066 | 168 | BT_EXPORT |
6162e6b7 | 169 | int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock, const uint8_t *uuid) |
ac0c6bdd | 170 | { |
67d2ce02 | 171 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 172 | return bt_ctf_clock_class_set_uuid(clock->clock_class, uuid); |
ac0c6bdd PP |
173 | } |
174 | ||
1353b066 | 175 | BT_EXPORT |
ac0c6bdd PP |
176 | int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time) |
177 | { | |
ac0c6bdd | 178 | int64_t value; |
16ca5ff0 | 179 | struct bt_ctf_clock_class *cc; |
ac0c6bdd | 180 | |
67d2ce02 | 181 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
16ca5ff0 | 182 | cc = clock->clock_class; |
ac0c6bdd PP |
183 | |
184 | /* Common case where cycles are actually nanoseconds */ | |
3dca2276 | 185 | if (cc->frequency == 1000000000) { |
ac0c6bdd PP |
186 | value = time; |
187 | } else { | |
188 | value = (uint64_t) (((double) time * | |
3dca2276 | 189 | (double) cc->frequency) / 1e9); |
ac0c6bdd PP |
190 | } |
191 | ||
67d2ce02 | 192 | BT_CTF_ASSERT_PRE(clock->value <= value, |
f6ccaed9 PP |
193 | "CTF writer clock value must be updated monotonically: " |
194 | "prev-value=%" PRId64 ", new-value=%" PRId64, | |
195 | clock->value, value); | |
ac0c6bdd | 196 | clock->value = value; |
f6ccaed9 | 197 | return 0; |
ac0c6bdd PP |
198 | } |
199 | ||
ac0c6bdd PP |
200 | int bt_ctf_clock_get_value(struct bt_ctf_clock *clock, uint64_t *value) |
201 | { | |
67d2ce02 MJ |
202 | BT_CTF_ASSERT_PRE_NON_NULL(clock, "CTF writer clock"); |
203 | BT_CTF_ASSERT_PRE_NON_NULL(value, "Value"); | |
ac0c6bdd | 204 | *value = clock->value; |
f6ccaed9 | 205 | return 0; |
ac0c6bdd PP |
206 | } |
207 | ||
208 | static | |
e1e02a22 | 209 | void bt_ctf_clock_destroy(struct bt_ctf_object *obj) |
ac0c6bdd PP |
210 | { |
211 | struct bt_ctf_clock *clock; | |
212 | ||
213 | clock = container_of(obj, struct bt_ctf_clock, base); | |
e1e02a22 | 214 | bt_ctf_object_put_ref(clock->clock_class); |
ac0c6bdd PP |
215 | g_free(clock); |
216 | } | |
3dca2276 | 217 | |
3dca2276 PP |
218 | void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class, |
219 | struct metadata_context *context) | |
220 | { | |
6162e6b7 | 221 | uint8_t *uuid; |
3dca2276 PP |
222 | |
223 | BT_LOGD("Serializing clock class's metadata: clock-class-addr=%p, " | |
224 | "name=\"%s\", metadata-context-addr=%p", clock_class, | |
16ca5ff0 | 225 | bt_ctf_clock_class_get_name(clock_class), |
3dca2276 PP |
226 | context); |
227 | ||
228 | if (!clock_class || !context) { | |
229 | BT_LOGW("Invalid parameter: clock class or metadata context is NULL: " | |
230 | "clock-class-addr=%p, name=\"%s\", metadata-context-addr=%p", | |
231 | clock_class, | |
16ca5ff0 | 232 | bt_ctf_clock_class_get_name(clock_class), |
3dca2276 PP |
233 | context); |
234 | return; | |
235 | } | |
236 | ||
16ca5ff0 | 237 | uuid = clock_class->uuid; |
3dca2276 PP |
238 | g_string_append(context->string, "clock {\n"); |
239 | g_string_append_printf(context->string, "\tname = %s;\n", | |
16ca5ff0 | 240 | clock_class->name->str); |
3dca2276 | 241 | |
16ca5ff0 | 242 | if (clock_class->uuid_set) { |
3dca2276 | 243 | g_string_append_printf(context->string, |
6162e6b7 MJ |
244 | "\tuuid = \"" BT_UUID_FMT "\";\n", |
245 | BT_UUID_FMT_VALUES(uuid)); | |
3dca2276 PP |
246 | } |
247 | ||
16ca5ff0 | 248 | if (clock_class->description) { |
3dca2276 | 249 | g_string_append_printf(context->string, "\tdescription = \"%s\";\n", |
16ca5ff0 | 250 | clock_class->description->str); |
3dca2276 PP |
251 | } |
252 | ||
253 | g_string_append_printf(context->string, "\tfreq = %" PRIu64 ";\n", | |
16ca5ff0 | 254 | clock_class->frequency); |
3dca2276 | 255 | g_string_append_printf(context->string, "\tprecision = %" PRIu64 ";\n", |
16ca5ff0 | 256 | clock_class->precision); |
3dca2276 | 257 | g_string_append_printf(context->string, "\toffset_s = %" PRIu64 ";\n", |
16ca5ff0 | 258 | clock_class->offset_s); |
3dca2276 | 259 | g_string_append_printf(context->string, "\toffset = %" PRIu64 ";\n", |
16ca5ff0 | 260 | clock_class->offset); |
3dca2276 | 261 | g_string_append_printf(context->string, "\tabsolute = %s;\n", |
16ca5ff0 | 262 | clock_class->absolute ? "true" : "false"); |
3dca2276 PP |
263 | g_string_append(context->string, "};\n\n"); |
264 | } |