| 1 | /* |
| 2 | * SPDX-License-Identifier: MIT |
| 3 | * |
| 4 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
| 5 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 6 | * Copyright 2017-2019 Philippe Proulx <pproulx@efficios.com> |
| 7 | * |
| 8 | * The Common Trace Format (CTF) Specification is available at |
| 9 | * http://www.efficios.com/ctf |
| 10 | */ |
| 11 | |
| 12 | #ifndef BABELTRACE_CTFSER_CTFSER_H |
| 13 | #define BABELTRACE_CTFSER_CTFSER_H |
| 14 | |
| 15 | #include <stdbool.h> |
| 16 | #include <stdlib.h> |
| 17 | #include <stdint.h> |
| 18 | #include <limits.h> |
| 19 | #include "compat/mman.h" |
| 20 | #include <sys/types.h> |
| 21 | #include <sys/stat.h> |
| 22 | #include <fcntl.h> |
| 23 | #include "common/align.h" |
| 24 | #include "compat/endian.h" |
| 25 | #include "common/common.h" |
| 26 | #include "common/mmap-align.h" |
| 27 | #include "common/assert.h" |
| 28 | #include "common/macros.h" |
| 29 | #include "compat/bitfield.h" |
| 30 | #include <glib.h> |
| 31 | |
| 32 | struct bt_ctfser { |
| 33 | /* Stream file's descriptor */ |
| 34 | int fd; |
| 35 | |
| 36 | /* Offset (bytes) of memory map (current packet) in the stream file */ |
| 37 | off_t mmap_offset; |
| 38 | |
| 39 | /* Offset (bytes) of packet's first byte in the memory map */ |
| 40 | off_t mmap_base_offset; |
| 41 | |
| 42 | /* Current offset (bits) within current packet */ |
| 43 | uint64_t offset_in_cur_packet_bits; |
| 44 | |
| 45 | /* Current packet size (bytes) */ |
| 46 | uint64_t cur_packet_size_bytes; |
| 47 | |
| 48 | /* Previous packet size (bytes) */ |
| 49 | uint64_t prev_packet_size_bytes; |
| 50 | |
| 51 | /* Current stream size (bytes) */ |
| 52 | uint64_t stream_size_bytes; |
| 53 | |
| 54 | /* Memory map base address */ |
| 55 | struct mmap_align_data *base_mma; |
| 56 | |
| 57 | /* Stream file's path (for debugging) */ |
| 58 | GString *path; |
| 59 | |
| 60 | /* Serializer's log level */ |
| 61 | int log_level; |
| 62 | }; |
| 63 | |
| 64 | /* |
| 65 | * Initializes a CTF serializer. |
| 66 | * |
| 67 | * This function opens the file `path` for writing. |
| 68 | */ |
| 69 | BT_EXTERN_C |
| 70 | int bt_ctfser_init(struct bt_ctfser *ctfser, const char *path, |
| 71 | int log_level); |
| 72 | |
| 73 | /* |
| 74 | * Finalizes a CTF serializer. |
| 75 | * |
| 76 | * This function truncates the stream file so that there's no extra |
| 77 | * padding after the last packet, and then closes the file. |
| 78 | */ |
| 79 | BT_EXTERN_C |
| 80 | int bt_ctfser_fini(struct bt_ctfser *ctfser); |
| 81 | |
| 82 | /* |
| 83 | * Opens a new packet. |
| 84 | * |
| 85 | * All the next writing functions are performed within this new packet. |
| 86 | */ |
| 87 | BT_EXTERN_C |
| 88 | int bt_ctfser_open_packet(struct bt_ctfser *ctfser); |
| 89 | |
| 90 | /* |
| 91 | * Closes the current packet, making its size `packet_size_bytes`. |
| 92 | */ |
| 93 | BT_EXTERN_C |
| 94 | void bt_ctfser_close_current_packet(struct bt_ctfser *ctfser, |
| 95 | uint64_t packet_size_bytes); |
| 96 | |
| 97 | BT_EXTERN_C |
| 98 | int _bt_ctfser_increase_cur_packet_size(struct bt_ctfser *ctfser); |
| 99 | |
| 100 | static inline |
| 101 | uint64_t _bt_ctfser_cur_packet_size_bits(struct bt_ctfser *ctfser) |
| 102 | { |
| 103 | return ctfser->cur_packet_size_bytes * 8; |
| 104 | } |
| 105 | |
| 106 | static inline |
| 107 | uint64_t _bt_ctfser_prev_packet_size_bits(struct bt_ctfser *ctfser) |
| 108 | { |
| 109 | return ctfser->prev_packet_size_bytes * 8; |
| 110 | } |
| 111 | |
| 112 | static inline |
| 113 | uint64_t _bt_ctfser_offset_bytes(struct bt_ctfser *ctfser) |
| 114 | { |
| 115 | return ctfser->offset_in_cur_packet_bits / 8; |
| 116 | } |
| 117 | |
| 118 | static inline |
| 119 | uint8_t *_bt_ctfser_get_addr(struct bt_ctfser *ctfser) |
| 120 | { |
| 121 | /* Only makes sense to get the address after aligning on byte */ |
| 122 | BT_ASSERT_DBG(ctfser->offset_in_cur_packet_bits % 8 == 0); |
| 123 | return ((uint8_t *) mmap_align_addr(ctfser->base_mma)) + |
| 124 | ctfser->mmap_base_offset + _bt_ctfser_offset_bytes(ctfser); |
| 125 | } |
| 126 | |
| 127 | static inline |
| 128 | bool _bt_ctfser_has_space_left(struct bt_ctfser *ctfser, uint64_t size_bits) |
| 129 | { |
| 130 | bool has_space_left = true; |
| 131 | |
| 132 | if (G_UNLIKELY((ctfser->offset_in_cur_packet_bits + size_bits > |
| 133 | _bt_ctfser_cur_packet_size_bits(ctfser)))) { |
| 134 | has_space_left = false; |
| 135 | goto end; |
| 136 | } |
| 137 | |
| 138 | if (G_UNLIKELY(size_bits > UINT64_MAX - ctfser->offset_in_cur_packet_bits)) { |
| 139 | has_space_left = false; |
| 140 | goto end; |
| 141 | } |
| 142 | |
| 143 | end: |
| 144 | return has_space_left; |
| 145 | } |
| 146 | |
| 147 | static inline |
| 148 | void _bt_ctfser_incr_offset(struct bt_ctfser *ctfser, uint64_t size_bits) |
| 149 | { |
| 150 | BT_ASSERT_DBG(_bt_ctfser_has_space_left(ctfser, size_bits)); |
| 151 | ctfser->offset_in_cur_packet_bits += size_bits; |
| 152 | } |
| 153 | |
| 154 | /* |
| 155 | * Aligns the current offset within the current packet to |
| 156 | * `alignment_bits` bits (power of two, > 0). |
| 157 | */ |
| 158 | static inline |
| 159 | int bt_ctfser_align_offset_in_current_packet(struct bt_ctfser *ctfser, |
| 160 | uint64_t alignment_bits) |
| 161 | { |
| 162 | int ret = 0; |
| 163 | uint64_t align_size_bits; |
| 164 | |
| 165 | BT_ASSERT_DBG(alignment_bits > 0); |
| 166 | align_size_bits = BT_ALIGN(ctfser->offset_in_cur_packet_bits, |
| 167 | alignment_bits) - ctfser->offset_in_cur_packet_bits; |
| 168 | |
| 169 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, align_size_bits))) { |
| 170 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 171 | if (G_UNLIKELY(ret)) { |
| 172 | goto end; |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | _bt_ctfser_incr_offset(ctfser, align_size_bits); |
| 177 | |
| 178 | end: |
| 179 | return ret; |
| 180 | } |
| 181 | |
| 182 | static inline |
| 183 | int _bt_ctfser_write_byte_aligned_unsigned_int_no_align( |
| 184 | struct bt_ctfser *ctfser, uint64_t value, |
| 185 | unsigned int size_bits, int byte_order) |
| 186 | { |
| 187 | int ret = 0; |
| 188 | |
| 189 | /* Reverse byte order? */ |
| 190 | bool rbo = byte_order != BYTE_ORDER; |
| 191 | |
| 192 | BT_ASSERT_DBG(size_bits % 8 == 0); |
| 193 | BT_ASSERT_DBG(_bt_ctfser_has_space_left(ctfser, size_bits)); |
| 194 | |
| 195 | switch (size_bits) { |
| 196 | case 8: |
| 197 | { |
| 198 | uint8_t v = (uint8_t) value; |
| 199 | |
| 200 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 201 | break; |
| 202 | } |
| 203 | case 16: |
| 204 | { |
| 205 | uint16_t v = (uint16_t) value; |
| 206 | |
| 207 | if (rbo) { |
| 208 | v = GUINT16_SWAP_LE_BE(v); |
| 209 | } |
| 210 | |
| 211 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 212 | break; |
| 213 | } |
| 214 | case 32: |
| 215 | { |
| 216 | uint32_t v = (uint32_t) value; |
| 217 | |
| 218 | if (rbo) { |
| 219 | v = GUINT32_SWAP_LE_BE(v); |
| 220 | } |
| 221 | |
| 222 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 223 | break; |
| 224 | } |
| 225 | case 64: |
| 226 | { |
| 227 | uint64_t v = (uint64_t) value; |
| 228 | |
| 229 | if (rbo) { |
| 230 | v = GUINT64_SWAP_LE_BE(v); |
| 231 | } |
| 232 | |
| 233 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 234 | break; |
| 235 | } |
| 236 | default: |
| 237 | bt_common_abort(); |
| 238 | } |
| 239 | |
| 240 | _bt_ctfser_incr_offset(ctfser, size_bits); |
| 241 | return ret; |
| 242 | } |
| 243 | |
| 244 | static inline |
| 245 | int _bt_ctfser_write_byte_aligned_signed_int_no_align( |
| 246 | struct bt_ctfser *ctfser, int64_t value, |
| 247 | unsigned int size_bits, int byte_order) |
| 248 | { |
| 249 | int ret = 0; |
| 250 | |
| 251 | /* Reverse byte order? */ |
| 252 | bool rbo = byte_order != BYTE_ORDER; |
| 253 | |
| 254 | BT_ASSERT_DBG(size_bits % 8 == 0); |
| 255 | BT_ASSERT_DBG(_bt_ctfser_has_space_left(ctfser, size_bits)); |
| 256 | |
| 257 | switch (size_bits) { |
| 258 | case 8: |
| 259 | { |
| 260 | int8_t v = (int8_t) value; |
| 261 | |
| 262 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 263 | break; |
| 264 | } |
| 265 | case 16: |
| 266 | { |
| 267 | int16_t v = (int16_t) value; |
| 268 | |
| 269 | if (rbo) { |
| 270 | v = GUINT16_SWAP_LE_BE(v); |
| 271 | } |
| 272 | |
| 273 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 274 | break; |
| 275 | } |
| 276 | case 32: |
| 277 | { |
| 278 | int32_t v = (int32_t) value; |
| 279 | |
| 280 | if (rbo) { |
| 281 | v = GUINT32_SWAP_LE_BE(v); |
| 282 | } |
| 283 | |
| 284 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 285 | break; |
| 286 | } |
| 287 | case 64: |
| 288 | { |
| 289 | int64_t v = (int64_t) value; |
| 290 | |
| 291 | if (rbo) { |
| 292 | v = GUINT64_SWAP_LE_BE(v); |
| 293 | } |
| 294 | |
| 295 | memcpy(_bt_ctfser_get_addr(ctfser), &v, sizeof(v)); |
| 296 | break; |
| 297 | } |
| 298 | default: |
| 299 | bt_common_abort(); |
| 300 | } |
| 301 | |
| 302 | _bt_ctfser_incr_offset(ctfser, size_bits); |
| 303 | return ret; |
| 304 | } |
| 305 | |
| 306 | /* |
| 307 | * Writes an unsigned integer known to have a size that is a multiple of |
| 308 | * 8 and an alignment that is >= 8 at the current offset within the |
| 309 | * current packet. |
| 310 | */ |
| 311 | static inline |
| 312 | int bt_ctfser_write_byte_aligned_unsigned_int(struct bt_ctfser *ctfser, |
| 313 | uint64_t value, unsigned int alignment_bits, |
| 314 | unsigned int size_bits, int byte_order) |
| 315 | { |
| 316 | int ret; |
| 317 | |
| 318 | BT_ASSERT_DBG(alignment_bits % 8 == 0); |
| 319 | ret = bt_ctfser_align_offset_in_current_packet(ctfser, alignment_bits); |
| 320 | if (G_UNLIKELY(ret)) { |
| 321 | goto end; |
| 322 | } |
| 323 | |
| 324 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, size_bits))) { |
| 325 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 326 | if (G_UNLIKELY(ret)) { |
| 327 | goto end; |
| 328 | } |
| 329 | } |
| 330 | |
| 331 | ret = _bt_ctfser_write_byte_aligned_unsigned_int_no_align(ctfser, value, |
| 332 | size_bits, byte_order); |
| 333 | if (G_UNLIKELY(ret)) { |
| 334 | goto end; |
| 335 | } |
| 336 | |
| 337 | end: |
| 338 | return ret; |
| 339 | } |
| 340 | |
| 341 | /* |
| 342 | * Writes a signed integer known to have a size that is a multiple of 8 |
| 343 | * and an alignment that is >= 8 at the current offset within the |
| 344 | * current packet. |
| 345 | */ |
| 346 | static inline |
| 347 | int bt_ctfser_write_byte_aligned_signed_int(struct bt_ctfser *ctfser, |
| 348 | int64_t value, unsigned int alignment_bits, |
| 349 | unsigned int size_bits, int byte_order) |
| 350 | { |
| 351 | int ret; |
| 352 | |
| 353 | BT_ASSERT_DBG(alignment_bits % 8 == 0); |
| 354 | ret = bt_ctfser_align_offset_in_current_packet(ctfser, alignment_bits); |
| 355 | if (G_UNLIKELY(ret)) { |
| 356 | goto end; |
| 357 | } |
| 358 | |
| 359 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, size_bits))) { |
| 360 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 361 | if (G_UNLIKELY(ret)) { |
| 362 | goto end; |
| 363 | } |
| 364 | } |
| 365 | |
| 366 | ret = _bt_ctfser_write_byte_aligned_signed_int_no_align(ctfser, value, |
| 367 | size_bits, byte_order); |
| 368 | if (G_UNLIKELY(ret)) { |
| 369 | goto end; |
| 370 | } |
| 371 | |
| 372 | end: |
| 373 | return ret; |
| 374 | } |
| 375 | |
| 376 | /* |
| 377 | * Writes an unsigned integer at the current offset within the current |
| 378 | * packet. |
| 379 | */ |
| 380 | static inline |
| 381 | int bt_ctfser_write_unsigned_int(struct bt_ctfser *ctfser, uint64_t value, |
| 382 | unsigned int alignment_bits, unsigned int size_bits, |
| 383 | int byte_order) |
| 384 | { |
| 385 | int ret = 0; |
| 386 | |
| 387 | ret = bt_ctfser_align_offset_in_current_packet(ctfser, alignment_bits); |
| 388 | if (G_UNLIKELY(ret)) { |
| 389 | goto end; |
| 390 | } |
| 391 | |
| 392 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, size_bits))) { |
| 393 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 394 | if (G_UNLIKELY(ret)) { |
| 395 | goto end; |
| 396 | } |
| 397 | } |
| 398 | |
| 399 | if (alignment_bits % 8 == 0 && size_bits % 8 == 0) { |
| 400 | ret = _bt_ctfser_write_byte_aligned_unsigned_int_no_align( |
| 401 | ctfser, value, size_bits, byte_order); |
| 402 | goto end; |
| 403 | } |
| 404 | |
| 405 | if (byte_order == LITTLE_ENDIAN) { |
| 406 | bt_bitfield_write_le((uint8_t *) mmap_align_addr(ctfser->base_mma) + |
| 407 | ctfser->mmap_base_offset, uint8_t, |
| 408 | ctfser->offset_in_cur_packet_bits, size_bits, value); |
| 409 | } else { |
| 410 | bt_bitfield_write_be((uint8_t *) mmap_align_addr(ctfser->base_mma) + |
| 411 | ctfser->mmap_base_offset, uint8_t, |
| 412 | ctfser->offset_in_cur_packet_bits, size_bits, value); |
| 413 | } |
| 414 | |
| 415 | _bt_ctfser_incr_offset(ctfser, size_bits); |
| 416 | |
| 417 | end: |
| 418 | return ret; |
| 419 | } |
| 420 | |
| 421 | /* |
| 422 | * Writes a signed integer at the current offset within the current |
| 423 | * packet. |
| 424 | */ |
| 425 | static inline |
| 426 | int bt_ctfser_write_signed_int(struct bt_ctfser *ctfser, int64_t value, |
| 427 | unsigned int alignment_bits, unsigned int size_bits, |
| 428 | int byte_order) |
| 429 | { |
| 430 | int ret = 0; |
| 431 | |
| 432 | ret = bt_ctfser_align_offset_in_current_packet(ctfser, alignment_bits); |
| 433 | if (G_UNLIKELY(ret)) { |
| 434 | goto end; |
| 435 | } |
| 436 | |
| 437 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, size_bits))) { |
| 438 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 439 | if (G_UNLIKELY(ret)) { |
| 440 | goto end; |
| 441 | } |
| 442 | } |
| 443 | |
| 444 | if (alignment_bits % 8 == 0 && size_bits % 8 == 0) { |
| 445 | ret = _bt_ctfser_write_byte_aligned_signed_int_no_align( |
| 446 | ctfser, value, size_bits, byte_order); |
| 447 | goto end; |
| 448 | } |
| 449 | |
| 450 | if (byte_order == LITTLE_ENDIAN) { |
| 451 | bt_bitfield_write_le((uint8_t *) mmap_align_addr(ctfser->base_mma) + |
| 452 | ctfser->mmap_base_offset, uint8_t, |
| 453 | ctfser->offset_in_cur_packet_bits, size_bits, value); |
| 454 | } else { |
| 455 | bt_bitfield_write_be((uint8_t *) mmap_align_addr(ctfser->base_mma) + |
| 456 | ctfser->mmap_base_offset, uint8_t, |
| 457 | ctfser->offset_in_cur_packet_bits, size_bits, value); |
| 458 | } |
| 459 | |
| 460 | _bt_ctfser_incr_offset(ctfser, size_bits); |
| 461 | |
| 462 | end: |
| 463 | return ret; |
| 464 | } |
| 465 | |
| 466 | /* |
| 467 | * Writes a 32-bit floating point number at the current offset within |
| 468 | * the current packet. |
| 469 | */ |
| 470 | static inline |
| 471 | int bt_ctfser_write_float32(struct bt_ctfser *ctfser, double value, |
| 472 | unsigned int alignment_bits, int byte_order) |
| 473 | { |
| 474 | union u32f { |
| 475 | uint32_t u; |
| 476 | float f; |
| 477 | } u32f; |
| 478 | |
| 479 | u32f.f = (float) value; |
| 480 | return bt_ctfser_write_unsigned_int(ctfser, (uint64_t) u32f.u, |
| 481 | alignment_bits, 32, byte_order); |
| 482 | } |
| 483 | |
| 484 | /* |
| 485 | * Writes a 64-bit floating point number at the current offset within |
| 486 | * the current packet. |
| 487 | */ |
| 488 | static inline |
| 489 | int bt_ctfser_write_float64(struct bt_ctfser *ctfser, double value, |
| 490 | unsigned int alignment_bits, int byte_order) |
| 491 | { |
| 492 | union u64f { |
| 493 | uint64_t u; |
| 494 | double d; |
| 495 | } u64f; |
| 496 | |
| 497 | u64f.d = value; |
| 498 | return bt_ctfser_write_unsigned_int(ctfser, u64f.u, alignment_bits, |
| 499 | 64, byte_order); |
| 500 | } |
| 501 | |
| 502 | /* |
| 503 | * Writes a C string, including the terminating null character, at the |
| 504 | * current offset within the current packet. |
| 505 | */ |
| 506 | static inline |
| 507 | int bt_ctfser_write_string(struct bt_ctfser *ctfser, const char *value) |
| 508 | { |
| 509 | int ret = 0; |
| 510 | const char *at = value; |
| 511 | |
| 512 | ret = bt_ctfser_align_offset_in_current_packet(ctfser, 8); |
| 513 | if (G_UNLIKELY(ret)) { |
| 514 | goto end; |
| 515 | } |
| 516 | |
| 517 | while (true) { |
| 518 | if (G_UNLIKELY(!_bt_ctfser_has_space_left(ctfser, 8))) { |
| 519 | ret = _bt_ctfser_increase_cur_packet_size(ctfser); |
| 520 | if (G_UNLIKELY(ret)) { |
| 521 | goto end; |
| 522 | } |
| 523 | } |
| 524 | |
| 525 | memcpy(_bt_ctfser_get_addr(ctfser), at, sizeof(*at)); |
| 526 | _bt_ctfser_incr_offset(ctfser, 8); |
| 527 | |
| 528 | if (G_UNLIKELY(*at == '\0')) { |
| 529 | break; |
| 530 | } |
| 531 | |
| 532 | at++; |
| 533 | } |
| 534 | |
| 535 | end: |
| 536 | return ret; |
| 537 | } |
| 538 | |
| 539 | /* |
| 540 | * Returns the current offset within the current packet (bits). |
| 541 | */ |
| 542 | static inline |
| 543 | uint64_t bt_ctfser_get_offset_in_current_packet_bits(struct bt_ctfser *ctfser) |
| 544 | { |
| 545 | return ctfser->offset_in_cur_packet_bits; |
| 546 | } |
| 547 | |
| 548 | /* |
| 549 | * Sets the current offset within the current packet (bits). |
| 550 | */ |
| 551 | static inline |
| 552 | void bt_ctfser_set_offset_in_current_packet_bits(struct bt_ctfser *ctfser, |
| 553 | uint64_t offset_bits) |
| 554 | { |
| 555 | BT_ASSERT_DBG(offset_bits <= _bt_ctfser_cur_packet_size_bits(ctfser)); |
| 556 | ctfser->offset_in_cur_packet_bits = offset_bits; |
| 557 | } |
| 558 | |
| 559 | static inline |
| 560 | const char *bt_ctfser_get_file_path(struct bt_ctfser *ctfser) |
| 561 | { |
| 562 | return ctfser->path->str; |
| 563 | } |
| 564 | |
| 565 | #endif /* BABELTRACE_CTFSER_CTFSER_H */ |