| 1 | /* |
| 2 | * clock.c |
| 3 | * |
| 4 | * Babeltrace CTF IR - Clock |
| 5 | * |
| 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 7 | * |
| 8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 9 | * |
| 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: |
| 16 | * |
| 17 | * The above copyright notice and this permission notice shall be included in |
| 18 | * all copies or substantial portions of the Software. |
| 19 | * |
| 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 |
| 26 | * SOFTWARE. |
| 27 | */ |
| 28 | |
| 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> |
| 35 | #include <inttypes.h> |
| 36 | |
| 37 | static |
| 38 | void bt_ctf_clock_destroy(struct bt_object *obj); |
| 39 | |
| 40 | BT_HIDDEN |
| 41 | bool bt_ctf_clock_is_valid(struct bt_ctf_clock *clock) |
| 42 | { |
| 43 | return clock && clock->name; |
| 44 | } |
| 45 | |
| 46 | int bt_ctf_clock_set_name(struct bt_ctf_clock *clock, |
| 47 | const char *name) |
| 48 | { |
| 49 | int ret = 0; |
| 50 | |
| 51 | if (!clock || clock->frozen) { |
| 52 | ret = -1; |
| 53 | goto end; |
| 54 | } |
| 55 | |
| 56 | if (bt_ctf_validate_identifier(name)) { |
| 57 | ret = -1; |
| 58 | goto end; |
| 59 | } |
| 60 | |
| 61 | if (clock->name) { |
| 62 | g_string_assign(clock->name, name); |
| 63 | } else { |
| 64 | clock->name = g_string_new(name); |
| 65 | if (!clock->name) { |
| 66 | ret = -1; |
| 67 | goto end; |
| 68 | } |
| 69 | } |
| 70 | |
| 71 | end: |
| 72 | return ret; |
| 73 | } |
| 74 | |
| 75 | struct bt_ctf_clock *bt_ctf_clock_create(const char *name) |
| 76 | { |
| 77 | int ret; |
| 78 | struct bt_ctf_clock *clock = g_new0(struct bt_ctf_clock, 1); |
| 79 | |
| 80 | if (!clock) { |
| 81 | goto error; |
| 82 | } |
| 83 | |
| 84 | clock->precision = 1; |
| 85 | clock->frequency = 1000000000; |
| 86 | bt_object_init(clock, bt_ctf_clock_destroy); |
| 87 | |
| 88 | if (name) { |
| 89 | ret = bt_ctf_clock_set_name(clock, name); |
| 90 | if (ret) { |
| 91 | goto error; |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | ret = bt_uuid_generate(clock->uuid); |
| 96 | if (ret) { |
| 97 | goto error; |
| 98 | } |
| 99 | |
| 100 | /* |
| 101 | * For backward compatibility reasons, a fresh clock can have |
| 102 | * a value because it could be added to a trace created by a |
| 103 | * CTF writer. As soon as this clock is added to a non-writer |
| 104 | * trace, then its value/time functions will be disabled. |
| 105 | */ |
| 106 | clock->has_value = 1; |
| 107 | clock->uuid_set = 1; |
| 108 | return clock; |
| 109 | error: |
| 110 | BT_PUT(clock); |
| 111 | return clock; |
| 112 | } |
| 113 | |
| 114 | const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock) |
| 115 | { |
| 116 | const char *ret = NULL; |
| 117 | |
| 118 | if (!clock) { |
| 119 | goto end; |
| 120 | } |
| 121 | |
| 122 | if (clock->name) { |
| 123 | ret = clock->name->str; |
| 124 | } |
| 125 | |
| 126 | end: |
| 127 | return ret; |
| 128 | } |
| 129 | |
| 130 | const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock) |
| 131 | { |
| 132 | const char *ret = NULL; |
| 133 | |
| 134 | if (!clock) { |
| 135 | goto end; |
| 136 | } |
| 137 | |
| 138 | if (clock->description) { |
| 139 | ret = clock->description->str; |
| 140 | } |
| 141 | end: |
| 142 | return ret; |
| 143 | } |
| 144 | |
| 145 | int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc) |
| 146 | { |
| 147 | int ret = 0; |
| 148 | |
| 149 | if (!clock || !desc || clock->frozen) { |
| 150 | ret = -1; |
| 151 | goto end; |
| 152 | } |
| 153 | |
| 154 | clock->description = g_string_new(desc); |
| 155 | ret = clock->description ? 0 : -1; |
| 156 | end: |
| 157 | return ret; |
| 158 | } |
| 159 | |
| 160 | uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock) |
| 161 | { |
| 162 | uint64_t ret = -1ULL; |
| 163 | |
| 164 | if (!clock) { |
| 165 | goto end; |
| 166 | } |
| 167 | |
| 168 | ret = clock->frequency; |
| 169 | end: |
| 170 | return ret; |
| 171 | } |
| 172 | |
| 173 | int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq) |
| 174 | { |
| 175 | int ret = 0; |
| 176 | |
| 177 | if (!clock || clock->frozen) { |
| 178 | ret = -1; |
| 179 | goto end; |
| 180 | } |
| 181 | |
| 182 | clock->frequency = freq; |
| 183 | end: |
| 184 | return ret; |
| 185 | } |
| 186 | |
| 187 | uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock) |
| 188 | { |
| 189 | uint64_t ret = -1ULL; |
| 190 | |
| 191 | if (!clock) { |
| 192 | goto end; |
| 193 | } |
| 194 | |
| 195 | ret = clock->precision; |
| 196 | end: |
| 197 | return ret; |
| 198 | } |
| 199 | |
| 200 | int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision) |
| 201 | { |
| 202 | int ret = 0; |
| 203 | |
| 204 | if (!clock || clock->frozen) { |
| 205 | ret = -1; |
| 206 | goto end; |
| 207 | } |
| 208 | |
| 209 | clock->precision = precision; |
| 210 | end: |
| 211 | return ret; |
| 212 | } |
| 213 | |
| 214 | int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, int64_t *offset_s) |
| 215 | { |
| 216 | int ret = 0; |
| 217 | |
| 218 | if (!clock || !offset_s) { |
| 219 | ret = -1; |
| 220 | goto end; |
| 221 | } |
| 222 | |
| 223 | *offset_s = clock->offset_s; |
| 224 | end: |
| 225 | return ret; |
| 226 | } |
| 227 | |
| 228 | int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, int64_t offset_s) |
| 229 | { |
| 230 | int ret = 0; |
| 231 | |
| 232 | if (!clock || clock->frozen) { |
| 233 | ret = -1; |
| 234 | goto end; |
| 235 | } |
| 236 | |
| 237 | clock->offset_s = offset_s; |
| 238 | end: |
| 239 | return ret; |
| 240 | } |
| 241 | |
| 242 | int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, int64_t *offset) |
| 243 | { |
| 244 | int ret = 0; |
| 245 | |
| 246 | if (!clock || !offset) { |
| 247 | ret = -1; |
| 248 | goto end; |
| 249 | } |
| 250 | |
| 251 | *offset = clock->offset; |
| 252 | end: |
| 253 | return ret; |
| 254 | } |
| 255 | |
| 256 | int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, int64_t offset) |
| 257 | { |
| 258 | int ret = 0; |
| 259 | |
| 260 | if (!clock || clock->frozen) { |
| 261 | ret = -1; |
| 262 | goto end; |
| 263 | } |
| 264 | |
| 265 | clock->offset = offset; |
| 266 | end: |
| 267 | return ret; |
| 268 | } |
| 269 | |
| 270 | int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock) |
| 271 | { |
| 272 | int ret = -1; |
| 273 | |
| 274 | if (!clock) { |
| 275 | goto end; |
| 276 | } |
| 277 | |
| 278 | ret = clock->absolute; |
| 279 | end: |
| 280 | return ret; |
| 281 | } |
| 282 | |
| 283 | int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute) |
| 284 | { |
| 285 | int ret = 0; |
| 286 | |
| 287 | if (!clock || clock->frozen) { |
| 288 | ret = -1; |
| 289 | goto end; |
| 290 | } |
| 291 | |
| 292 | clock->absolute = !!is_absolute; |
| 293 | end: |
| 294 | return ret; |
| 295 | } |
| 296 | |
| 297 | const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock) |
| 298 | { |
| 299 | const unsigned char *ret; |
| 300 | |
| 301 | if (!clock || !clock->uuid_set) { |
| 302 | ret = NULL; |
| 303 | goto end; |
| 304 | } |
| 305 | |
| 306 | ret = clock->uuid; |
| 307 | end: |
| 308 | return ret; |
| 309 | } |
| 310 | |
| 311 | int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock, const unsigned char *uuid) |
| 312 | { |
| 313 | int ret = 0; |
| 314 | |
| 315 | if (!clock || !uuid || clock->frozen) { |
| 316 | ret = -1; |
| 317 | goto end; |
| 318 | } |
| 319 | |
| 320 | memcpy(clock->uuid, uuid, sizeof(uuid_t)); |
| 321 | clock->uuid_set = 1; |
| 322 | end: |
| 323 | return ret; |
| 324 | } |
| 325 | |
| 326 | uint64_t ns_from_value(uint64_t frequency, uint64_t value) |
| 327 | { |
| 328 | uint64_t ns; |
| 329 | |
| 330 | if (frequency == 1000000000) { |
| 331 | ns = value; |
| 332 | } else { |
| 333 | ns = (uint64_t) ((1e9 * (double) value) / (double) frequency); |
| 334 | } |
| 335 | |
| 336 | return ns; |
| 337 | } |
| 338 | |
| 339 | int bt_ctf_clock_get_time(struct bt_ctf_clock *clock, int64_t *time) |
| 340 | { |
| 341 | int ret = 0; |
| 342 | |
| 343 | if (!clock || !time) { |
| 344 | ret = -1; |
| 345 | goto end; |
| 346 | } |
| 347 | |
| 348 | |
| 349 | if (!clock->has_value) { |
| 350 | /* |
| 351 | * Clock belongs to a non-writer mode trace and thus |
| 352 | * this function is disabled. |
| 353 | */ |
| 354 | goto end; |
| 355 | } |
| 356 | |
| 357 | *time = (int64_t) ns_from_value(clock->frequency, clock->value); |
| 358 | |
| 359 | end: |
| 360 | return ret; |
| 361 | } |
| 362 | |
| 363 | int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time) |
| 364 | { |
| 365 | int ret = 0; |
| 366 | int64_t value; |
| 367 | |
| 368 | /* Timestamps are strictly monotonic */ |
| 369 | if (!clock) { |
| 370 | ret = -1; |
| 371 | goto end; |
| 372 | } |
| 373 | |
| 374 | |
| 375 | if (!clock->has_value) { |
| 376 | /* |
| 377 | * Clock belongs to a non-writer mode trace and thus |
| 378 | * this function is disabled. |
| 379 | */ |
| 380 | ret = -1; |
| 381 | goto end; |
| 382 | } |
| 383 | |
| 384 | /* Common case where cycles are actually nanoseconds */ |
| 385 | if (clock->frequency == 1000000000) { |
| 386 | value = time; |
| 387 | } else { |
| 388 | value = (uint64_t) (((double) time * |
| 389 | (double) clock->frequency) / 1e9); |
| 390 | } |
| 391 | |
| 392 | ret = bt_ctf_clock_set_value(clock, value); |
| 393 | end: |
| 394 | return ret; |
| 395 | } |
| 396 | |
| 397 | uint64_t bt_ctf_clock_get_value(struct bt_ctf_clock *clock) |
| 398 | { |
| 399 | uint64_t ret = -1ULL; |
| 400 | |
| 401 | if (!clock) { |
| 402 | goto end; |
| 403 | } |
| 404 | |
| 405 | if (!clock->has_value) { |
| 406 | /* |
| 407 | * Clock belongs to a non-writer mode trace and thus |
| 408 | * this function is disabled. |
| 409 | */ |
| 410 | goto end; |
| 411 | } |
| 412 | |
| 413 | ret = clock->value; |
| 414 | end: |
| 415 | return ret; |
| 416 | } |
| 417 | |
| 418 | int bt_ctf_clock_set_value(struct bt_ctf_clock *clock, uint64_t value) |
| 419 | { |
| 420 | int ret = 0; |
| 421 | |
| 422 | if (!clock) { |
| 423 | ret = -1; |
| 424 | goto end; |
| 425 | } |
| 426 | |
| 427 | if (!clock->has_value) { |
| 428 | /* |
| 429 | * Clock belongs to a non-writer mode trace and thus |
| 430 | * this function is disabled. |
| 431 | */ |
| 432 | ret = -1; |
| 433 | goto end; |
| 434 | } |
| 435 | |
| 436 | /* Timestamps are strictly monotonic */ |
| 437 | if (value < clock->value) { |
| 438 | ret = -1; |
| 439 | goto end; |
| 440 | } |
| 441 | |
| 442 | clock->value = value; |
| 443 | end: |
| 444 | return ret; |
| 445 | } |
| 446 | |
| 447 | void bt_ctf_clock_get(struct bt_ctf_clock *clock) |
| 448 | { |
| 449 | bt_get(clock); |
| 450 | } |
| 451 | |
| 452 | void bt_ctf_clock_put(struct bt_ctf_clock *clock) |
| 453 | { |
| 454 | bt_put(clock); |
| 455 | } |
| 456 | |
| 457 | BT_HIDDEN |
| 458 | void bt_ctf_clock_freeze(struct bt_ctf_clock *clock) |
| 459 | { |
| 460 | if (!clock) { |
| 461 | return; |
| 462 | } |
| 463 | |
| 464 | clock->frozen = 1; |
| 465 | } |
| 466 | |
| 467 | BT_HIDDEN |
| 468 | void bt_ctf_clock_serialize(struct bt_ctf_clock *clock, |
| 469 | struct metadata_context *context) |
| 470 | { |
| 471 | unsigned char *uuid; |
| 472 | |
| 473 | if (!clock || !context) { |
| 474 | return; |
| 475 | } |
| 476 | |
| 477 | uuid = clock->uuid; |
| 478 | g_string_append(context->string, "clock {\n"); |
| 479 | g_string_append_printf(context->string, "\tname = %s;\n", |
| 480 | clock->name->str); |
| 481 | g_string_append_printf(context->string, |
| 482 | "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n", |
| 483 | uuid[0], uuid[1], uuid[2], uuid[3], |
| 484 | uuid[4], uuid[5], uuid[6], uuid[7], |
| 485 | uuid[8], uuid[9], uuid[10], uuid[11], |
| 486 | uuid[12], uuid[13], uuid[14], uuid[15]); |
| 487 | if (clock->description) { |
| 488 | g_string_append_printf(context->string, "\tdescription = \"%s\";\n", |
| 489 | clock->description->str); |
| 490 | } |
| 491 | |
| 492 | g_string_append_printf(context->string, "\tfreq = %" PRIu64 ";\n", |
| 493 | clock->frequency); |
| 494 | g_string_append_printf(context->string, "\tprecision = %" PRIu64 ";\n", |
| 495 | clock->precision); |
| 496 | g_string_append_printf(context->string, "\toffset_s = %" PRIu64 ";\n", |
| 497 | clock->offset_s); |
| 498 | g_string_append_printf(context->string, "\toffset = %" PRIu64 ";\n", |
| 499 | clock->offset); |
| 500 | g_string_append_printf(context->string, "\tabsolute = %s;\n", |
| 501 | clock->absolute ? "TRUE" : "FALSE"); |
| 502 | g_string_append(context->string, "};\n\n"); |
| 503 | } |
| 504 | |
| 505 | static |
| 506 | void bt_ctf_clock_destroy(struct bt_object *obj) |
| 507 | { |
| 508 | struct bt_ctf_clock *clock; |
| 509 | |
| 510 | clock = container_of(obj, struct bt_ctf_clock, base); |
| 511 | if (clock->name) { |
| 512 | g_string_free(clock->name, TRUE); |
| 513 | } |
| 514 | |
| 515 | if (clock->description) { |
| 516 | g_string_free(clock->description, TRUE); |
| 517 | } |
| 518 | |
| 519 | g_free(clock); |
| 520 | } |
| 521 | |
| 522 | int64_t bt_ctf_clock_ns_from_value(struct bt_ctf_clock *clock, uint64_t value) |
| 523 | { |
| 524 | int64_t ns = -1ULL; |
| 525 | |
| 526 | if (!clock) { |
| 527 | goto end; |
| 528 | } |
| 529 | |
| 530 | /* Initialize nanosecond timestamp to clock's offset in seconds */ |
| 531 | ns = clock->offset_s * 1000000000; |
| 532 | |
| 533 | /* Add offset in cycles, converted to nanoseconds */ |
| 534 | ns += ns_from_value(clock->frequency, clock->offset); |
| 535 | |
| 536 | /* Add given value, converter to nanoseconds */ |
| 537 | ns += ns_from_value(clock->frequency, value); |
| 538 | |
| 539 | end: |
| 540 | return ns; |
| 541 | } |