| 1 | /* |
| 2 | * Babeltrace - CTF message iterator |
| 3 | * |
| 4 | * Copyright (c) 2015-2018 EfficiOS Inc. and Linux Foundation |
| 5 | * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com> |
| 6 | * |
| 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 8 | * of this software and associated documentation files (the "Software"), to deal |
| 9 | * in the Software without restriction, including without limitation the rights |
| 10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 11 | * copies of the Software, and to permit persons to whom the Software is |
| 12 | * furnished to do so, subject to the following conditions: |
| 13 | * |
| 14 | * The above copyright notice and this permission notice shall be included in |
| 15 | * all copies or substantial portions of the Software. |
| 16 | * |
| 17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 23 | * SOFTWARE. |
| 24 | */ |
| 25 | |
| 26 | #define BT_COMP_LOG_SELF_COMP (msg_it->self_comp) |
| 27 | #define BT_LOG_OUTPUT_LEVEL (msg_it->log_level) |
| 28 | #define BT_LOG_TAG "PLUGIN/CTF/MSG-ITER" |
| 29 | #include "logging/comp-logging.h" |
| 30 | |
| 31 | #include <stdint.h> |
| 32 | #include <inttypes.h> |
| 33 | #include <stdio.h> |
| 34 | #include <stddef.h> |
| 35 | #include <stdbool.h> |
| 36 | #include "common/assert.h" |
| 37 | #include <string.h> |
| 38 | #include <babeltrace2/babeltrace.h> |
| 39 | #include "common/common.h" |
| 40 | #include <glib.h> |
| 41 | #include <stdlib.h> |
| 42 | |
| 43 | #include "msg-iter.h" |
| 44 | #include "../bfcr/bfcr.h" |
| 45 | |
| 46 | struct ctf_msg_iter; |
| 47 | |
| 48 | /* A visit stack entry */ |
| 49 | struct stack_entry { |
| 50 | /* |
| 51 | * Current base field, one of: |
| 52 | * |
| 53 | * * string |
| 54 | * * structure |
| 55 | * * array |
| 56 | * * sequence |
| 57 | * * variant |
| 58 | * |
| 59 | * Field is borrowed. |
| 60 | */ |
| 61 | bt_field *base; |
| 62 | |
| 63 | /* Index of next field to set */ |
| 64 | size_t index; |
| 65 | }; |
| 66 | |
| 67 | struct ctf_msg_iter; |
| 68 | |
| 69 | /* Visit stack */ |
| 70 | struct stack { |
| 71 | struct ctf_msg_iter *msg_it; |
| 72 | |
| 73 | /* Entries (struct stack_entry) */ |
| 74 | GArray *entries; |
| 75 | |
| 76 | /* Number of active entries */ |
| 77 | size_t size; |
| 78 | }; |
| 79 | |
| 80 | /* State */ |
| 81 | enum state { |
| 82 | STATE_INIT, |
| 83 | STATE_SWITCH_PACKET, |
| 84 | STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN, |
| 85 | STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE, |
| 86 | STATE_AFTER_TRACE_PACKET_HEADER, |
| 87 | STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN, |
| 88 | STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE, |
| 89 | STATE_AFTER_STREAM_PACKET_CONTEXT, |
| 90 | STATE_CHECK_EMIT_MSG_STREAM_BEGINNING, |
| 91 | STATE_EMIT_MSG_STREAM_BEGINNING, |
| 92 | STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS, |
| 93 | STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS, |
| 94 | STATE_EMIT_MSG_DISCARDED_EVENTS, |
| 95 | STATE_EMIT_MSG_DISCARDED_PACKETS, |
| 96 | STATE_EMIT_MSG_PACKET_BEGINNING, |
| 97 | STATE_DSCOPE_EVENT_HEADER_BEGIN, |
| 98 | STATE_DSCOPE_EVENT_HEADER_CONTINUE, |
| 99 | STATE_AFTER_EVENT_HEADER, |
| 100 | STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN, |
| 101 | STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE, |
| 102 | STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN, |
| 103 | STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE, |
| 104 | STATE_DSCOPE_EVENT_PAYLOAD_BEGIN, |
| 105 | STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE, |
| 106 | STATE_EMIT_MSG_EVENT, |
| 107 | STATE_EMIT_QUEUED_MSG_EVENT, |
| 108 | STATE_SKIP_PACKET_PADDING, |
| 109 | STATE_EMIT_MSG_PACKET_END_MULTI, |
| 110 | STATE_EMIT_MSG_PACKET_END_SINGLE, |
| 111 | STATE_CHECK_EMIT_MSG_STREAM_END, |
| 112 | STATE_EMIT_QUEUED_MSG_PACKET_END, |
| 113 | STATE_EMIT_MSG_STREAM_END, |
| 114 | STATE_DONE, |
| 115 | }; |
| 116 | |
| 117 | struct end_of_packet_snapshots { |
| 118 | uint64_t discarded_events; |
| 119 | uint64_t packets; |
| 120 | uint64_t beginning_clock; |
| 121 | uint64_t end_clock; |
| 122 | }; |
| 123 | |
| 124 | /* CTF message iterator */ |
| 125 | struct ctf_msg_iter { |
| 126 | /* Visit stack */ |
| 127 | struct stack *stack; |
| 128 | |
| 129 | /* Current message iterator to create messages (weak) */ |
| 130 | bt_self_message_iterator *self_msg_iter; |
| 131 | |
| 132 | /* True to emit a stream beginning message. */ |
| 133 | bool emit_stream_begin_msg; |
| 134 | |
| 135 | /* True to emit a stream end message. */ |
| 136 | bool emit_stream_end_msg; |
| 137 | |
| 138 | /* |
| 139 | * True if library objects are unavailable during the decoding and |
| 140 | * should not be created/used. |
| 141 | */ |
| 142 | bool dry_run; |
| 143 | |
| 144 | /* True to set the stream */ |
| 145 | bool set_stream; |
| 146 | |
| 147 | /* |
| 148 | * Current dynamic scope field pointer. |
| 149 | * |
| 150 | * This is set by read_dscope_begin_state() and contains the |
| 151 | * value of one of the pointers in `dscopes` below. |
| 152 | */ |
| 153 | bt_field *cur_dscope_field; |
| 154 | |
| 155 | /* |
| 156 | * True if we're done filling a string field from a text |
| 157 | * array/sequence payload. |
| 158 | */ |
| 159 | bool done_filling_string; |
| 160 | |
| 161 | /* Trace and classes */ |
| 162 | /* True to set IR fields */ |
| 163 | bool set_ir_fields; |
| 164 | |
| 165 | struct { |
| 166 | struct ctf_trace_class *tc; |
| 167 | struct ctf_stream_class *sc; |
| 168 | struct ctf_event_class *ec; |
| 169 | } meta; |
| 170 | |
| 171 | /* Current packet context field wrapper (NULL if not created yet) */ |
| 172 | bt_packet_context_field *packet_context_field; |
| 173 | |
| 174 | /* Current packet (NULL if not created yet) */ |
| 175 | bt_packet *packet; |
| 176 | |
| 177 | /* Current stream (NULL if not set yet) */ |
| 178 | bt_stream *stream; |
| 179 | |
| 180 | /* Current event (NULL if not created yet) */ |
| 181 | bt_event *event; |
| 182 | |
| 183 | /* Current event message (NULL if not created yet) */ |
| 184 | bt_message *event_msg; |
| 185 | |
| 186 | /* |
| 187 | * True if we need to emit a packet beginning message before we emit |
| 188 | * the next event message or the packet end message. |
| 189 | */ |
| 190 | bool emit_delayed_packet_beginning_msg; |
| 191 | |
| 192 | /* Database of current dynamic scopes */ |
| 193 | struct { |
| 194 | bt_field *stream_packet_context; |
| 195 | bt_field *event_common_context; |
| 196 | bt_field *event_spec_context; |
| 197 | bt_field *event_payload; |
| 198 | } dscopes; |
| 199 | |
| 200 | /* Current state */ |
| 201 | enum state state; |
| 202 | |
| 203 | /* Current medium buffer data */ |
| 204 | struct { |
| 205 | /* Last address provided by medium */ |
| 206 | const uint8_t *addr; |
| 207 | |
| 208 | /* Buffer size provided by medium (bytes) */ |
| 209 | size_t sz; |
| 210 | |
| 211 | /* Offset within whole packet of addr (bits) */ |
| 212 | size_t packet_offset; |
| 213 | |
| 214 | /* Current position from addr (bits) */ |
| 215 | size_t at; |
| 216 | |
| 217 | /* Position of the last event header from addr (bits) */ |
| 218 | size_t last_eh_at; |
| 219 | } buf; |
| 220 | |
| 221 | /* Binary type reader */ |
| 222 | struct bt_bfcr *bfcr; |
| 223 | |
| 224 | /* Current medium data */ |
| 225 | struct { |
| 226 | struct ctf_msg_iter_medium_ops medops; |
| 227 | size_t max_request_sz; |
| 228 | void *data; |
| 229 | } medium; |
| 230 | |
| 231 | /* Current packet size (bits) (-1 if unknown) */ |
| 232 | int64_t cur_exp_packet_total_size; |
| 233 | |
| 234 | /* Current content size (bits) (-1 if unknown) */ |
| 235 | int64_t cur_exp_packet_content_size; |
| 236 | |
| 237 | /* Current stream class ID */ |
| 238 | int64_t cur_stream_class_id; |
| 239 | |
| 240 | /* Current event class ID */ |
| 241 | int64_t cur_event_class_id; |
| 242 | |
| 243 | /* Current data stream ID */ |
| 244 | int64_t cur_data_stream_id; |
| 245 | |
| 246 | /* |
| 247 | * Offset, in the underlying media, of the current packet's |
| 248 | * start (-1 if unknown). |
| 249 | */ |
| 250 | off_t cur_packet_offset; |
| 251 | |
| 252 | /* Default clock's current value */ |
| 253 | uint64_t default_clock_snapshot; |
| 254 | |
| 255 | /* End of current packet snapshots */ |
| 256 | struct end_of_packet_snapshots snapshots; |
| 257 | |
| 258 | /* End of previous packet snapshots */ |
| 259 | struct end_of_packet_snapshots prev_packet_snapshots; |
| 260 | |
| 261 | /* Stored values (for sequence lengths, variant tags) */ |
| 262 | GArray *stored_values; |
| 263 | |
| 264 | /* Iterator's current log level */ |
| 265 | bt_logging_level log_level; |
| 266 | |
| 267 | /* Iterator's owning self component, or `NULL` if none (query) */ |
| 268 | bt_self_component *self_comp; |
| 269 | }; |
| 270 | |
| 271 | static inline |
| 272 | const char *state_string(enum state state) |
| 273 | { |
| 274 | switch (state) { |
| 275 | case STATE_INIT: |
| 276 | return "INIT"; |
| 277 | case STATE_SWITCH_PACKET: |
| 278 | return "SWITCH_PACKET"; |
| 279 | case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN: |
| 280 | return "DSCOPE_TRACE_PACKET_HEADER_BEGIN"; |
| 281 | case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE: |
| 282 | return "DSCOPE_TRACE_PACKET_HEADER_CONTINUE"; |
| 283 | case STATE_AFTER_TRACE_PACKET_HEADER: |
| 284 | return "AFTER_TRACE_PACKET_HEADER"; |
| 285 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN: |
| 286 | return "DSCOPE_STREAM_PACKET_CONTEXT_BEGIN"; |
| 287 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE: |
| 288 | return "DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE"; |
| 289 | case STATE_AFTER_STREAM_PACKET_CONTEXT: |
| 290 | return "AFTER_STREAM_PACKET_CONTEXT"; |
| 291 | case STATE_EMIT_MSG_STREAM_BEGINNING: |
| 292 | return "EMIT_MSG_STREAM_BEGINNING"; |
| 293 | case STATE_EMIT_MSG_PACKET_BEGINNING: |
| 294 | return "EMIT_MSG_PACKET_BEGINNING"; |
| 295 | case STATE_EMIT_MSG_DISCARDED_EVENTS: |
| 296 | return "EMIT_MSG_DISCARDED_EVENTS"; |
| 297 | case STATE_EMIT_MSG_DISCARDED_PACKETS: |
| 298 | return "EMIT_MSG_DISCARDED_PACKETS"; |
| 299 | case STATE_DSCOPE_EVENT_HEADER_BEGIN: |
| 300 | return "DSCOPE_EVENT_HEADER_BEGIN"; |
| 301 | case STATE_DSCOPE_EVENT_HEADER_CONTINUE: |
| 302 | return "DSCOPE_EVENT_HEADER_CONTINUE"; |
| 303 | case STATE_AFTER_EVENT_HEADER: |
| 304 | return "AFTER_EVENT_HEADER"; |
| 305 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN: |
| 306 | return "DSCOPE_EVENT_COMMON_CONTEXT_BEGIN"; |
| 307 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE: |
| 308 | return "DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE"; |
| 309 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN: |
| 310 | return "DSCOPE_EVENT_SPEC_CONTEXT_BEGIN"; |
| 311 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE: |
| 312 | return "DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE"; |
| 313 | case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN: |
| 314 | return "DSCOPE_EVENT_PAYLOAD_BEGIN"; |
| 315 | case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE: |
| 316 | return "DSCOPE_EVENT_PAYLOAD_CONTINUE"; |
| 317 | case STATE_EMIT_MSG_EVENT: |
| 318 | return "EMIT_MSG_EVENT"; |
| 319 | case STATE_EMIT_QUEUED_MSG_EVENT: |
| 320 | return "EMIT_QUEUED_MSG_EVENT"; |
| 321 | case STATE_SKIP_PACKET_PADDING: |
| 322 | return "SKIP_PACKET_PADDING"; |
| 323 | case STATE_EMIT_MSG_PACKET_END_MULTI: |
| 324 | return "EMIT_MSG_PACKET_END_MULTI"; |
| 325 | case STATE_EMIT_MSG_PACKET_END_SINGLE: |
| 326 | return "EMIT_MSG_PACKET_END_SINGLE"; |
| 327 | case STATE_EMIT_QUEUED_MSG_PACKET_END: |
| 328 | return "EMIT_QUEUED_MSG_PACKET_END"; |
| 329 | case STATE_EMIT_MSG_STREAM_END: |
| 330 | return "EMIT_MSG_STREAM_END"; |
| 331 | case STATE_DONE: |
| 332 | return "DONE"; |
| 333 | default: |
| 334 | return "(unknown)"; |
| 335 | } |
| 336 | } |
| 337 | |
| 338 | static |
| 339 | struct stack *stack_new(struct ctf_msg_iter *msg_it) |
| 340 | { |
| 341 | bt_self_component *self_comp = msg_it->self_comp; |
| 342 | struct stack *stack = NULL; |
| 343 | |
| 344 | stack = g_new0(struct stack, 1); |
| 345 | if (!stack) { |
| 346 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 347 | "Failed to allocate one stack."); |
| 348 | goto error; |
| 349 | } |
| 350 | |
| 351 | stack->msg_it = msg_it; |
| 352 | stack->entries = g_array_new(FALSE, TRUE, sizeof(struct stack_entry)); |
| 353 | if (!stack->entries) { |
| 354 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 355 | "Failed to allocate a GArray."); |
| 356 | goto error; |
| 357 | } |
| 358 | |
| 359 | BT_COMP_LOGD("Created stack: msg-it-addr=%p, stack-addr=%p", msg_it, stack); |
| 360 | goto end; |
| 361 | |
| 362 | error: |
| 363 | g_free(stack); |
| 364 | stack = NULL; |
| 365 | |
| 366 | end: |
| 367 | return stack; |
| 368 | } |
| 369 | |
| 370 | static |
| 371 | void stack_destroy(struct stack *stack) |
| 372 | { |
| 373 | struct ctf_msg_iter *msg_it; |
| 374 | |
| 375 | BT_ASSERT_DBG(stack); |
| 376 | msg_it = stack->msg_it; |
| 377 | BT_COMP_LOGD("Destroying stack: addr=%p", stack); |
| 378 | |
| 379 | if (stack->entries) { |
| 380 | g_array_free(stack->entries, TRUE); |
| 381 | } |
| 382 | |
| 383 | g_free(stack); |
| 384 | } |
| 385 | |
| 386 | static |
| 387 | void stack_push(struct stack *stack, bt_field *base) |
| 388 | { |
| 389 | struct stack_entry *entry; |
| 390 | struct ctf_msg_iter *msg_it; |
| 391 | |
| 392 | BT_ASSERT_DBG(stack); |
| 393 | msg_it = stack->msg_it; |
| 394 | BT_ASSERT_DBG(base); |
| 395 | BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, " |
| 396 | "stack-size-before=%zu, stack-size-after=%zu", |
| 397 | stack, stack->size, stack->size + 1); |
| 398 | |
| 399 | if (stack->entries->len == stack->size) { |
| 400 | g_array_set_size(stack->entries, stack->size + 1); |
| 401 | } |
| 402 | |
| 403 | entry = &g_array_index(stack->entries, struct stack_entry, stack->size); |
| 404 | entry->base = base; |
| 405 | entry->index = 0; |
| 406 | stack->size++; |
| 407 | } |
| 408 | |
| 409 | static inline |
| 410 | unsigned int stack_size(struct stack *stack) |
| 411 | { |
| 412 | BT_ASSERT_DBG(stack); |
| 413 | return stack->size; |
| 414 | } |
| 415 | |
| 416 | static |
| 417 | void stack_pop(struct stack *stack) |
| 418 | { |
| 419 | struct ctf_msg_iter *msg_it; |
| 420 | |
| 421 | BT_ASSERT_DBG(stack); |
| 422 | BT_ASSERT_DBG(stack_size(stack)); |
| 423 | msg_it = stack->msg_it; |
| 424 | BT_COMP_LOGT("Popping from stack: " |
| 425 | "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu", |
| 426 | stack, stack->size, stack->size - 1); |
| 427 | stack->size--; |
| 428 | } |
| 429 | |
| 430 | static inline |
| 431 | struct stack_entry *stack_top(struct stack *stack) |
| 432 | { |
| 433 | BT_ASSERT_DBG(stack); |
| 434 | BT_ASSERT_DBG(stack_size(stack)); |
| 435 | return &g_array_index(stack->entries, struct stack_entry, |
| 436 | stack->size - 1); |
| 437 | } |
| 438 | |
| 439 | static inline |
| 440 | bool stack_empty(struct stack *stack) |
| 441 | { |
| 442 | return stack_size(stack) == 0; |
| 443 | } |
| 444 | |
| 445 | static |
| 446 | void stack_clear(struct stack *stack) |
| 447 | { |
| 448 | BT_ASSERT_DBG(stack); |
| 449 | stack->size = 0; |
| 450 | } |
| 451 | |
| 452 | static inline |
| 453 | enum ctf_msg_iter_status msg_iter_status_from_m_status( |
| 454 | enum ctf_msg_iter_medium_status m_status) |
| 455 | { |
| 456 | /* They are the same */ |
| 457 | return (int) m_status; |
| 458 | } |
| 459 | |
| 460 | static inline |
| 461 | size_t buf_size_bits(struct ctf_msg_iter *msg_it) |
| 462 | { |
| 463 | return msg_it->buf.sz * 8; |
| 464 | } |
| 465 | |
| 466 | static inline |
| 467 | size_t buf_available_bits(struct ctf_msg_iter *msg_it) |
| 468 | { |
| 469 | return buf_size_bits(msg_it) - msg_it->buf.at; |
| 470 | } |
| 471 | |
| 472 | static inline |
| 473 | size_t packet_at(struct ctf_msg_iter *msg_it) |
| 474 | { |
| 475 | return msg_it->buf.packet_offset + msg_it->buf.at; |
| 476 | } |
| 477 | |
| 478 | static inline |
| 479 | void buf_consume_bits(struct ctf_msg_iter *msg_it, size_t incr) |
| 480 | { |
| 481 | BT_COMP_LOGT("Advancing cursor: msg-it-addr=%p, cur-before=%zu, cur-after=%zu", |
| 482 | msg_it, msg_it->buf.at, msg_it->buf.at + incr); |
| 483 | msg_it->buf.at += incr; |
| 484 | } |
| 485 | |
| 486 | static |
| 487 | enum ctf_msg_iter_status request_medium_bytes( |
| 488 | struct ctf_msg_iter *msg_it) |
| 489 | { |
| 490 | bt_self_component *self_comp = msg_it->self_comp; |
| 491 | uint8_t *buffer_addr = NULL; |
| 492 | size_t buffer_sz = 0; |
| 493 | enum ctf_msg_iter_medium_status m_status; |
| 494 | |
| 495 | BT_COMP_LOGD("Calling user function (request bytes): msg-it-addr=%p, " |
| 496 | "request-size=%zu", msg_it, msg_it->medium.max_request_sz); |
| 497 | m_status = msg_it->medium.medops.request_bytes( |
| 498 | msg_it->medium.max_request_sz, &buffer_addr, |
| 499 | &buffer_sz, msg_it->medium.data); |
| 500 | BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu", |
| 501 | ctf_msg_iter_medium_status_string(m_status), |
| 502 | buffer_addr, buffer_sz); |
| 503 | if (m_status == CTF_MSG_ITER_MEDIUM_STATUS_OK) { |
| 504 | BT_ASSERT(buffer_sz != 0); |
| 505 | |
| 506 | /* New packet offset is old one + old size (in bits) */ |
| 507 | msg_it->buf.packet_offset += buf_size_bits(msg_it); |
| 508 | |
| 509 | /* Restart at the beginning of the new medium buffer */ |
| 510 | msg_it->buf.at = 0; |
| 511 | msg_it->buf.last_eh_at = SIZE_MAX; |
| 512 | |
| 513 | /* New medium buffer size */ |
| 514 | msg_it->buf.sz = buffer_sz; |
| 515 | |
| 516 | /* New medium buffer address */ |
| 517 | msg_it->buf.addr = buffer_addr; |
| 518 | |
| 519 | BT_COMP_LOGD("User function returned new bytes: " |
| 520 | "packet-offset=%zu, cur=%zu, size=%zu, addr=%p", |
| 521 | msg_it->buf.packet_offset, msg_it->buf.at, |
| 522 | msg_it->buf.sz, msg_it->buf.addr); |
| 523 | BT_COMP_LOGD_MEM(buffer_addr, buffer_sz, "Returned bytes at %p:", |
| 524 | buffer_addr); |
| 525 | } else if (m_status == CTF_MSG_ITER_MEDIUM_STATUS_EOF) { |
| 526 | /* |
| 527 | * User returned end of stream: validate that we're not |
| 528 | * in the middle of a packet header, packet context, or |
| 529 | * event. |
| 530 | */ |
| 531 | if (msg_it->cur_exp_packet_total_size >= 0) { |
| 532 | if (packet_at(msg_it) == |
| 533 | msg_it->cur_exp_packet_total_size) { |
| 534 | goto end; |
| 535 | } |
| 536 | } else { |
| 537 | if (packet_at(msg_it) == 0) { |
| 538 | goto end; |
| 539 | } |
| 540 | |
| 541 | if (msg_it->buf.last_eh_at != SIZE_MAX && |
| 542 | msg_it->buf.at == msg_it->buf.last_eh_at) { |
| 543 | goto end; |
| 544 | } |
| 545 | } |
| 546 | |
| 547 | /* All other states are invalid */ |
| 548 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 549 | "User function returned %s, but message iterator is in an unexpected state: " |
| 550 | "state=%s, cur-packet-size=%" PRId64 ", cur=%zu, " |
| 551 | "packet-cur=%zu, last-eh-at=%zu", |
| 552 | ctf_msg_iter_medium_status_string(m_status), |
| 553 | state_string(msg_it->state), |
| 554 | msg_it->cur_exp_packet_total_size, |
| 555 | msg_it->buf.at, packet_at(msg_it), |
| 556 | msg_it->buf.last_eh_at); |
| 557 | m_status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR; |
| 558 | } else if (m_status < 0) { |
| 559 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "User function failed: " |
| 560 | "status=%s", ctf_msg_iter_medium_status_string(m_status)); |
| 561 | } |
| 562 | |
| 563 | end: |
| 564 | return msg_iter_status_from_m_status(m_status); |
| 565 | } |
| 566 | |
| 567 | static inline |
| 568 | enum ctf_msg_iter_status buf_ensure_available_bits( |
| 569 | struct ctf_msg_iter *msg_it) |
| 570 | { |
| 571 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 572 | |
| 573 | if (G_UNLIKELY(buf_available_bits(msg_it) == 0)) { |
| 574 | /* |
| 575 | * This _cannot_ return CTF_MSG_ITER_STATUS_OK |
| 576 | * _and_ no bits. |
| 577 | */ |
| 578 | status = request_medium_bytes(msg_it); |
| 579 | } |
| 580 | |
| 581 | return status; |
| 582 | } |
| 583 | |
| 584 | static |
| 585 | enum ctf_msg_iter_status read_dscope_begin_state( |
| 586 | struct ctf_msg_iter *msg_it, |
| 587 | struct ctf_field_class *dscope_fc, |
| 588 | enum state done_state, enum state continue_state, |
| 589 | bt_field *dscope_field) |
| 590 | { |
| 591 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 592 | bt_self_component *self_comp = msg_it->self_comp; |
| 593 | enum bt_bfcr_status bfcr_status; |
| 594 | size_t consumed_bits; |
| 595 | |
| 596 | msg_it->cur_dscope_field = dscope_field; |
| 597 | BT_COMP_LOGT("Starting BFCR: msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p", |
| 598 | msg_it, msg_it->bfcr, dscope_fc); |
| 599 | consumed_bits = bt_bfcr_start(msg_it->bfcr, dscope_fc, |
| 600 | msg_it->buf.addr, msg_it->buf.at, packet_at(msg_it), |
| 601 | msg_it->buf.sz, &bfcr_status); |
| 602 | BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits); |
| 603 | |
| 604 | switch (bfcr_status) { |
| 605 | case BT_BFCR_STATUS_OK: |
| 606 | /* Field class was read completely */ |
| 607 | BT_COMP_LOGT_STR("Field was completely decoded."); |
| 608 | msg_it->state = done_state; |
| 609 | break; |
| 610 | case BT_BFCR_STATUS_EOF: |
| 611 | BT_COMP_LOGT_STR("BFCR needs more data to decode field completely."); |
| 612 | msg_it->state = continue_state; |
| 613 | break; |
| 614 | default: |
| 615 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 616 | "BFCR failed to start: msg-it-addr=%p, bfcr-addr=%p, " |
| 617 | "status=%s", msg_it, msg_it->bfcr, |
| 618 | bt_bfcr_status_string(bfcr_status)); |
| 619 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 620 | goto end; |
| 621 | } |
| 622 | |
| 623 | /* Consume bits now since we know we're not in an error state */ |
| 624 | buf_consume_bits(msg_it, consumed_bits); |
| 625 | |
| 626 | end: |
| 627 | return status; |
| 628 | } |
| 629 | |
| 630 | static |
| 631 | enum ctf_msg_iter_status read_dscope_continue_state( |
| 632 | struct ctf_msg_iter *msg_it, enum state done_state) |
| 633 | { |
| 634 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 635 | bt_self_component *self_comp = msg_it->self_comp; |
| 636 | enum bt_bfcr_status bfcr_status; |
| 637 | size_t consumed_bits; |
| 638 | |
| 639 | BT_COMP_LOGT("Continuing BFCR: msg-it-addr=%p, bfcr-addr=%p", |
| 640 | msg_it, msg_it->bfcr); |
| 641 | |
| 642 | status = buf_ensure_available_bits(msg_it); |
| 643 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 644 | if (status < 0) { |
| 645 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 646 | "Cannot ensure that buffer has at least one byte: " |
| 647 | "msg-addr=%p, status=%s", |
| 648 | msg_it, ctf_msg_iter_status_string(status)); |
| 649 | } else { |
| 650 | BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: " |
| 651 | "msg-addr=%p, status=%s", |
| 652 | msg_it, ctf_msg_iter_status_string(status)); |
| 653 | } |
| 654 | |
| 655 | goto end; |
| 656 | } |
| 657 | |
| 658 | consumed_bits = bt_bfcr_continue(msg_it->bfcr, msg_it->buf.addr, |
| 659 | msg_it->buf.sz, &bfcr_status); |
| 660 | BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits); |
| 661 | |
| 662 | switch (bfcr_status) { |
| 663 | case BT_BFCR_STATUS_OK: |
| 664 | /* Type was read completely. */ |
| 665 | BT_COMP_LOGT_STR("Field was completely decoded."); |
| 666 | msg_it->state = done_state; |
| 667 | break; |
| 668 | case BT_BFCR_STATUS_EOF: |
| 669 | /* Stay in this continue state. */ |
| 670 | BT_COMP_LOGT_STR("BFCR needs more data to decode field completely."); |
| 671 | break; |
| 672 | default: |
| 673 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 674 | "BFCR failed to continue: msg-it-addr=%p, bfcr-addr=%p, " |
| 675 | "status=%s", msg_it, msg_it->bfcr, |
| 676 | bt_bfcr_status_string(bfcr_status)); |
| 677 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 678 | goto end; |
| 679 | } |
| 680 | |
| 681 | /* Consume bits now since we know we're not in an error state. */ |
| 682 | buf_consume_bits(msg_it, consumed_bits); |
| 683 | end: |
| 684 | return status; |
| 685 | } |
| 686 | |
| 687 | static |
| 688 | void release_event_dscopes(struct ctf_msg_iter *msg_it) |
| 689 | { |
| 690 | msg_it->dscopes.event_common_context = NULL; |
| 691 | msg_it->dscopes.event_spec_context = NULL; |
| 692 | msg_it->dscopes.event_payload = NULL; |
| 693 | } |
| 694 | |
| 695 | static |
| 696 | void release_all_dscopes(struct ctf_msg_iter *msg_it) |
| 697 | { |
| 698 | msg_it->dscopes.stream_packet_context = NULL; |
| 699 | |
| 700 | if (msg_it->packet_context_field) { |
| 701 | bt_packet_context_field_release(msg_it->packet_context_field); |
| 702 | msg_it->packet_context_field = NULL; |
| 703 | } |
| 704 | |
| 705 | release_event_dscopes(msg_it); |
| 706 | } |
| 707 | |
| 708 | static |
| 709 | enum ctf_msg_iter_status switch_packet_state(struct ctf_msg_iter *msg_it) |
| 710 | { |
| 711 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 712 | bt_self_component *self_comp = msg_it->self_comp; |
| 713 | |
| 714 | /* |
| 715 | * We don't put the stream class here because we need to make |
| 716 | * sure that all the packets processed by the same message |
| 717 | * iterator refer to the same stream class (the first one). |
| 718 | */ |
| 719 | BT_ASSERT(msg_it); |
| 720 | |
| 721 | if (msg_it->cur_exp_packet_total_size != -1) { |
| 722 | msg_it->cur_packet_offset += msg_it->cur_exp_packet_total_size; |
| 723 | } |
| 724 | |
| 725 | BT_COMP_LOGD("Switching packet: msg-it-addr=%p, cur=%zu, " |
| 726 | "packet-offset=%" PRId64, msg_it, msg_it->buf.at, |
| 727 | msg_it->cur_packet_offset); |
| 728 | stack_clear(msg_it->stack); |
| 729 | msg_it->meta.ec = NULL; |
| 730 | BT_PACKET_PUT_REF_AND_RESET(msg_it->packet); |
| 731 | BT_MESSAGE_PUT_REF_AND_RESET(msg_it->event_msg); |
| 732 | release_all_dscopes(msg_it); |
| 733 | msg_it->cur_dscope_field = NULL; |
| 734 | |
| 735 | /* |
| 736 | * Adjust current buffer so that addr points to the beginning of the new |
| 737 | * packet. |
| 738 | */ |
| 739 | if (msg_it->buf.addr) { |
| 740 | size_t consumed_bytes = (size_t) (msg_it->buf.at / CHAR_BIT); |
| 741 | |
| 742 | /* Packets are assumed to start on a byte frontier. */ |
| 743 | if (msg_it->buf.at % CHAR_BIT) { |
| 744 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 745 | "Cannot switch packet: current position is not a multiple of 8: " |
| 746 | "msg-it-addr=%p, cur=%zu", msg_it, msg_it->buf.at); |
| 747 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 748 | goto end; |
| 749 | } |
| 750 | |
| 751 | msg_it->buf.addr += consumed_bytes; |
| 752 | msg_it->buf.sz -= consumed_bytes; |
| 753 | msg_it->buf.at = 0; |
| 754 | msg_it->buf.packet_offset = 0; |
| 755 | BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu", |
| 756 | msg_it->buf.addr, msg_it->buf.sz); |
| 757 | } |
| 758 | |
| 759 | msg_it->cur_exp_packet_content_size = -1; |
| 760 | msg_it->cur_exp_packet_total_size = -1; |
| 761 | msg_it->cur_stream_class_id = -1; |
| 762 | msg_it->cur_event_class_id = -1; |
| 763 | msg_it->cur_data_stream_id = -1; |
| 764 | msg_it->prev_packet_snapshots = msg_it->snapshots; |
| 765 | msg_it->snapshots.discarded_events = UINT64_C(-1); |
| 766 | msg_it->snapshots.packets = UINT64_C(-1); |
| 767 | msg_it->snapshots.beginning_clock = UINT64_C(-1); |
| 768 | msg_it->snapshots.end_clock = UINT64_C(-1); |
| 769 | msg_it->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN; |
| 770 | |
| 771 | end: |
| 772 | return status; |
| 773 | } |
| 774 | |
| 775 | static |
| 776 | enum ctf_msg_iter_status read_packet_header_begin_state( |
| 777 | struct ctf_msg_iter *msg_it) |
| 778 | { |
| 779 | struct ctf_field_class *packet_header_fc = NULL; |
| 780 | bt_self_component *self_comp = msg_it->self_comp; |
| 781 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 782 | |
| 783 | /* |
| 784 | * Make sure at least one bit is available for this packet. An |
| 785 | * empty packet is impossible. If we reach the end of the medium |
| 786 | * at this point, then it's considered the end of the stream. |
| 787 | */ |
| 788 | status = buf_ensure_available_bits(msg_it); |
| 789 | switch (status) { |
| 790 | case CTF_MSG_ITER_STATUS_OK: |
| 791 | break; |
| 792 | case CTF_MSG_ITER_STATUS_EOF: |
| 793 | status = CTF_MSG_ITER_STATUS_OK; |
| 794 | msg_it->state = STATE_CHECK_EMIT_MSG_STREAM_END; |
| 795 | goto end; |
| 796 | default: |
| 797 | goto end; |
| 798 | } |
| 799 | |
| 800 | /* Packet header class is common to the whole trace class. */ |
| 801 | packet_header_fc = msg_it->meta.tc->packet_header_fc; |
| 802 | if (!packet_header_fc) { |
| 803 | msg_it->state = STATE_AFTER_TRACE_PACKET_HEADER; |
| 804 | goto end; |
| 805 | } |
| 806 | |
| 807 | msg_it->cur_stream_class_id = -1; |
| 808 | msg_it->cur_event_class_id = -1; |
| 809 | msg_it->cur_data_stream_id = -1; |
| 810 | BT_COMP_LOGD("Decoding packet header field:" |
| 811 | "msg-it-addr=%p, trace-class-addr=%p, fc-addr=%p", |
| 812 | msg_it, msg_it->meta.tc, packet_header_fc); |
| 813 | status = read_dscope_begin_state(msg_it, packet_header_fc, |
| 814 | STATE_AFTER_TRACE_PACKET_HEADER, |
| 815 | STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE, NULL); |
| 816 | if (status < 0) { |
| 817 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 818 | "Cannot decode packet header field: " |
| 819 | "msg-it-addr=%p, trace-class-addr=%p, " |
| 820 | "fc-addr=%p", |
| 821 | msg_it, msg_it->meta.tc, packet_header_fc); |
| 822 | } |
| 823 | |
| 824 | end: |
| 825 | return status; |
| 826 | } |
| 827 | |
| 828 | static |
| 829 | enum ctf_msg_iter_status read_packet_header_continue_state( |
| 830 | struct ctf_msg_iter *msg_it) |
| 831 | { |
| 832 | return read_dscope_continue_state(msg_it, |
| 833 | STATE_AFTER_TRACE_PACKET_HEADER); |
| 834 | } |
| 835 | |
| 836 | static inline |
| 837 | enum ctf_msg_iter_status set_current_stream_class(struct ctf_msg_iter *msg_it) |
| 838 | { |
| 839 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 840 | bt_self_component *self_comp = msg_it->self_comp; |
| 841 | struct ctf_stream_class *new_stream_class = NULL; |
| 842 | |
| 843 | if (msg_it->cur_stream_class_id == -1) { |
| 844 | /* |
| 845 | * No current stream class ID field, therefore only one |
| 846 | * stream class. |
| 847 | */ |
| 848 | if (msg_it->meta.tc->stream_classes->len != 1) { |
| 849 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 850 | "Need exactly one stream class since there's " |
| 851 | "no stream class ID field: " |
| 852 | "msg-it-addr=%p", msg_it); |
| 853 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 854 | goto end; |
| 855 | } |
| 856 | |
| 857 | new_stream_class = msg_it->meta.tc->stream_classes->pdata[0]; |
| 858 | msg_it->cur_stream_class_id = new_stream_class->id; |
| 859 | } |
| 860 | |
| 861 | new_stream_class = ctf_trace_class_borrow_stream_class_by_id( |
| 862 | msg_it->meta.tc, msg_it->cur_stream_class_id); |
| 863 | if (!new_stream_class) { |
| 864 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 865 | "No stream class with ID of stream class ID to use in trace class: " |
| 866 | "msg-it-addr=%p, stream-class-id=%" PRIu64 ", " |
| 867 | "trace-class-addr=%p", |
| 868 | msg_it, msg_it->cur_stream_class_id, msg_it->meta.tc); |
| 869 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 870 | goto end; |
| 871 | } |
| 872 | |
| 873 | if (msg_it->meta.sc) { |
| 874 | if (new_stream_class != msg_it->meta.sc) { |
| 875 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 876 | "Two packets refer to two different stream classes within the same packet sequence: " |
| 877 | "msg-it-addr=%p, prev-stream-class-addr=%p, " |
| 878 | "prev-stream-class-id=%" PRId64 ", " |
| 879 | "next-stream-class-addr=%p, " |
| 880 | "next-stream-class-id=%" PRId64 ", " |
| 881 | "trace-addr=%p", |
| 882 | msg_it, msg_it->meta.sc, |
| 883 | msg_it->meta.sc->id, |
| 884 | new_stream_class, |
| 885 | new_stream_class->id, |
| 886 | msg_it->meta.tc); |
| 887 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 888 | goto end; |
| 889 | } |
| 890 | } else { |
| 891 | msg_it->meta.sc = new_stream_class; |
| 892 | } |
| 893 | |
| 894 | BT_COMP_LOGD("Set current stream class: " |
| 895 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 896 | "stream-class-id=%" PRId64, |
| 897 | msg_it, msg_it->meta.sc, msg_it->meta.sc->id); |
| 898 | |
| 899 | end: |
| 900 | return status; |
| 901 | } |
| 902 | |
| 903 | static inline |
| 904 | enum ctf_msg_iter_status set_current_stream(struct ctf_msg_iter *msg_it) |
| 905 | { |
| 906 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 907 | bt_self_component *self_comp = msg_it->self_comp; |
| 908 | bt_stream *stream = NULL; |
| 909 | |
| 910 | BT_COMP_LOGD("Calling user function (get stream): msg-it-addr=%p, " |
| 911 | "stream-class-addr=%p, stream-class-id=%" PRId64, |
| 912 | msg_it, msg_it->meta.sc, |
| 913 | msg_it->meta.sc->id); |
| 914 | stream = msg_it->medium.medops.borrow_stream( |
| 915 | msg_it->meta.sc->ir_sc, msg_it->cur_data_stream_id, |
| 916 | msg_it->medium.data); |
| 917 | bt_stream_get_ref(stream); |
| 918 | BT_COMP_LOGD("User function returned: stream-addr=%p", stream); |
| 919 | if (!stream) { |
| 920 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 921 | "User function failed to return a stream object for the given stream class."); |
| 922 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 923 | goto end; |
| 924 | } |
| 925 | |
| 926 | if (msg_it->stream && stream != msg_it->stream) { |
| 927 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 928 | "User function returned a different stream than the previous one for the same sequence of packets."); |
| 929 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 930 | goto end; |
| 931 | } |
| 932 | |
| 933 | BT_STREAM_MOVE_REF(msg_it->stream, stream); |
| 934 | |
| 935 | end: |
| 936 | bt_stream_put_ref(stream); |
| 937 | return status; |
| 938 | } |
| 939 | |
| 940 | static inline |
| 941 | enum ctf_msg_iter_status set_current_packet(struct ctf_msg_iter *msg_it) |
| 942 | { |
| 943 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 944 | bt_self_component *self_comp = msg_it->self_comp; |
| 945 | bt_packet *packet = NULL; |
| 946 | |
| 947 | BT_COMP_LOGD("Creating packet from stream: " |
| 948 | "msg-it-addr=%p, stream-addr=%p, " |
| 949 | "stream-class-addr=%p, " |
| 950 | "stream-class-id=%" PRId64, |
| 951 | msg_it, msg_it->stream, msg_it->meta.sc, |
| 952 | msg_it->meta.sc->id); |
| 953 | |
| 954 | /* Create packet */ |
| 955 | BT_ASSERT(msg_it->stream); |
| 956 | packet = bt_packet_create(msg_it->stream); |
| 957 | if (!packet) { |
| 958 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 959 | "Cannot create packet from stream: " |
| 960 | "msg-it-addr=%p, stream-addr=%p, " |
| 961 | "stream-class-addr=%p, " |
| 962 | "stream-class-id=%" PRId64, |
| 963 | msg_it, msg_it->stream, msg_it->meta.sc, |
| 964 | msg_it->meta.sc->id); |
| 965 | goto error; |
| 966 | } |
| 967 | |
| 968 | goto end; |
| 969 | |
| 970 | error: |
| 971 | BT_PACKET_PUT_REF_AND_RESET(packet); |
| 972 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 973 | |
| 974 | end: |
| 975 | BT_PACKET_MOVE_REF(msg_it->packet, packet); |
| 976 | return status; |
| 977 | } |
| 978 | |
| 979 | static |
| 980 | enum ctf_msg_iter_status after_packet_header_state( |
| 981 | struct ctf_msg_iter *msg_it) |
| 982 | { |
| 983 | enum ctf_msg_iter_status status; |
| 984 | |
| 985 | status = set_current_stream_class(msg_it); |
| 986 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 987 | goto end; |
| 988 | } |
| 989 | |
| 990 | msg_it->state = STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN; |
| 991 | |
| 992 | end: |
| 993 | return status; |
| 994 | } |
| 995 | |
| 996 | static |
| 997 | enum ctf_msg_iter_status read_packet_context_begin_state( |
| 998 | struct ctf_msg_iter *msg_it) |
| 999 | { |
| 1000 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1001 | bt_self_component *self_comp = msg_it->self_comp; |
| 1002 | struct ctf_field_class *packet_context_fc; |
| 1003 | |
| 1004 | BT_ASSERT(msg_it->meta.sc); |
| 1005 | packet_context_fc = msg_it->meta.sc->packet_context_fc; |
| 1006 | if (!packet_context_fc) { |
| 1007 | BT_COMP_LOGD("No packet packet context field class in stream class: continuing: " |
| 1008 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1009 | "stream-class-id=%" PRId64, |
| 1010 | msg_it, msg_it->meta.sc, |
| 1011 | msg_it->meta.sc->id); |
| 1012 | msg_it->state = STATE_AFTER_STREAM_PACKET_CONTEXT; |
| 1013 | goto end; |
| 1014 | } |
| 1015 | |
| 1016 | BT_ASSERT(!msg_it->packet_context_field); |
| 1017 | |
| 1018 | if (packet_context_fc->in_ir && !msg_it->dry_run) { |
| 1019 | /* |
| 1020 | * Create free packet context field from stream class. |
| 1021 | * This field is going to be moved to the packet once we |
| 1022 | * create it. We cannot create the packet now because a |
| 1023 | * packet is created from a stream, and this API must be |
| 1024 | * able to return the packet context properties without |
| 1025 | * creating a stream |
| 1026 | * (ctf_msg_iter_get_packet_properties()). |
| 1027 | */ |
| 1028 | msg_it->packet_context_field = |
| 1029 | bt_packet_context_field_create( |
| 1030 | msg_it->meta.sc->ir_sc); |
| 1031 | if (!msg_it->packet_context_field) { |
| 1032 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1033 | "Cannot create packet context field wrapper from stream class."); |
| 1034 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1035 | goto end; |
| 1036 | } |
| 1037 | |
| 1038 | msg_it->dscopes.stream_packet_context = |
| 1039 | bt_packet_context_field_borrow_field( |
| 1040 | msg_it->packet_context_field); |
| 1041 | BT_ASSERT(msg_it->dscopes.stream_packet_context); |
| 1042 | } |
| 1043 | |
| 1044 | BT_COMP_LOGD("Decoding packet context field: " |
| 1045 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1046 | "stream-class-id=%" PRId64 ", fc-addr=%p", |
| 1047 | msg_it, msg_it->meta.sc, |
| 1048 | msg_it->meta.sc->id, packet_context_fc); |
| 1049 | status = read_dscope_begin_state(msg_it, packet_context_fc, |
| 1050 | STATE_AFTER_STREAM_PACKET_CONTEXT, |
| 1051 | STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE, |
| 1052 | msg_it->dscopes.stream_packet_context); |
| 1053 | if (status < 0) { |
| 1054 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1055 | "Cannot decode packet context field: " |
| 1056 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1057 | "stream-class-id=%" PRId64 ", fc-addr=%p", |
| 1058 | msg_it, msg_it->meta.sc, |
| 1059 | msg_it->meta.sc->id, |
| 1060 | packet_context_fc); |
| 1061 | } |
| 1062 | |
| 1063 | end: |
| 1064 | return status; |
| 1065 | } |
| 1066 | |
| 1067 | static |
| 1068 | enum ctf_msg_iter_status read_packet_context_continue_state( |
| 1069 | struct ctf_msg_iter *msg_it) |
| 1070 | { |
| 1071 | return read_dscope_continue_state(msg_it, |
| 1072 | STATE_AFTER_STREAM_PACKET_CONTEXT); |
| 1073 | } |
| 1074 | |
| 1075 | static |
| 1076 | enum ctf_msg_iter_status set_current_packet_content_sizes( |
| 1077 | struct ctf_msg_iter *msg_it) |
| 1078 | { |
| 1079 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1080 | bt_self_component *self_comp = msg_it->self_comp; |
| 1081 | |
| 1082 | if (msg_it->cur_exp_packet_total_size == -1) { |
| 1083 | if (msg_it->cur_exp_packet_content_size != -1) { |
| 1084 | msg_it->cur_exp_packet_total_size = |
| 1085 | msg_it->cur_exp_packet_content_size; |
| 1086 | } |
| 1087 | } else { |
| 1088 | if (msg_it->cur_exp_packet_content_size == -1) { |
| 1089 | msg_it->cur_exp_packet_content_size = |
| 1090 | msg_it->cur_exp_packet_total_size; |
| 1091 | } |
| 1092 | } |
| 1093 | |
| 1094 | BT_ASSERT((msg_it->cur_exp_packet_total_size >= 0 && |
| 1095 | msg_it->cur_exp_packet_content_size >= 0) || |
| 1096 | (msg_it->cur_exp_packet_total_size < 0 && |
| 1097 | msg_it->cur_exp_packet_content_size < 0)); |
| 1098 | |
| 1099 | if (msg_it->cur_exp_packet_content_size > |
| 1100 | msg_it->cur_exp_packet_total_size) { |
| 1101 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1102 | "Invalid packet or content size: " |
| 1103 | "content size is greater than packet size: " |
| 1104 | "msg-it-addr=%p, packet-context-field-addr=%p, " |
| 1105 | "packet-size=%" PRId64 ", content-size=%" PRId64, |
| 1106 | msg_it, msg_it->dscopes.stream_packet_context, |
| 1107 | msg_it->cur_exp_packet_total_size, |
| 1108 | msg_it->cur_exp_packet_content_size); |
| 1109 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1110 | goto end; |
| 1111 | } |
| 1112 | |
| 1113 | BT_COMP_LOGD("Set current packet and content sizes: " |
| 1114 | "msg-it-addr=%p, packet-size=%" PRIu64 ", content-size=%" PRIu64, |
| 1115 | msg_it, msg_it->cur_exp_packet_total_size, |
| 1116 | msg_it->cur_exp_packet_content_size); |
| 1117 | |
| 1118 | end: |
| 1119 | return status; |
| 1120 | } |
| 1121 | |
| 1122 | static |
| 1123 | enum ctf_msg_iter_status after_packet_context_state(struct ctf_msg_iter *msg_it) |
| 1124 | { |
| 1125 | enum ctf_msg_iter_status status; |
| 1126 | |
| 1127 | status = set_current_packet_content_sizes(msg_it); |
| 1128 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 1129 | goto end; |
| 1130 | } |
| 1131 | |
| 1132 | if (msg_it->stream) { |
| 1133 | /* |
| 1134 | * Stream exists, which means we already emitted at |
| 1135 | * least one packet beginning message, so the initial |
| 1136 | * stream beginning message was also emitted. |
| 1137 | */ |
| 1138 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS; |
| 1139 | } else { |
| 1140 | msg_it->state = STATE_CHECK_EMIT_MSG_STREAM_BEGINNING; |
| 1141 | } |
| 1142 | |
| 1143 | end: |
| 1144 | return status; |
| 1145 | } |
| 1146 | |
| 1147 | static |
| 1148 | enum ctf_msg_iter_status read_event_header_begin_state(struct ctf_msg_iter *msg_it) |
| 1149 | { |
| 1150 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1151 | bt_self_component *self_comp = msg_it->self_comp; |
| 1152 | struct ctf_field_class *event_header_fc = NULL; |
| 1153 | |
| 1154 | /* Reset the position of the last event header */ |
| 1155 | msg_it->buf.last_eh_at = msg_it->buf.at; |
| 1156 | msg_it->cur_event_class_id = -1; |
| 1157 | |
| 1158 | /* Check if we have some content left */ |
| 1159 | if (msg_it->cur_exp_packet_content_size >= 0) { |
| 1160 | if (G_UNLIKELY(packet_at(msg_it) == |
| 1161 | msg_it->cur_exp_packet_content_size)) { |
| 1162 | /* No more events! */ |
| 1163 | BT_COMP_LOGD("Reached end of packet: msg-it-addr=%p, " |
| 1164 | "cur=%zu", msg_it, packet_at(msg_it)); |
| 1165 | msg_it->state = STATE_EMIT_MSG_PACKET_END_MULTI; |
| 1166 | goto end; |
| 1167 | } else if (G_UNLIKELY(packet_at(msg_it) > |
| 1168 | msg_it->cur_exp_packet_content_size)) { |
| 1169 | /* That's not supposed to happen */ |
| 1170 | BT_COMP_LOGD("Before decoding event header field: cursor is passed the packet's content: " |
| 1171 | "msg-it-addr=%p, content-size=%" PRId64 ", " |
| 1172 | "cur=%zu", msg_it, |
| 1173 | msg_it->cur_exp_packet_content_size, |
| 1174 | packet_at(msg_it)); |
| 1175 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1176 | goto end; |
| 1177 | } |
| 1178 | } else { |
| 1179 | /* |
| 1180 | * "Infinite" content: we're done when the medium has |
| 1181 | * nothing else for us. |
| 1182 | */ |
| 1183 | status = buf_ensure_available_bits(msg_it); |
| 1184 | switch (status) { |
| 1185 | case CTF_MSG_ITER_STATUS_OK: |
| 1186 | break; |
| 1187 | case CTF_MSG_ITER_STATUS_EOF: |
| 1188 | status = CTF_MSG_ITER_STATUS_OK; |
| 1189 | msg_it->state = STATE_EMIT_MSG_PACKET_END_SINGLE; |
| 1190 | goto end; |
| 1191 | default: |
| 1192 | goto end; |
| 1193 | } |
| 1194 | } |
| 1195 | |
| 1196 | release_event_dscopes(msg_it); |
| 1197 | BT_ASSERT(msg_it->meta.sc); |
| 1198 | event_header_fc = msg_it->meta.sc->event_header_fc; |
| 1199 | if (!event_header_fc) { |
| 1200 | msg_it->state = STATE_AFTER_EVENT_HEADER; |
| 1201 | goto end; |
| 1202 | } |
| 1203 | |
| 1204 | BT_COMP_LOGD("Decoding event header field: " |
| 1205 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1206 | "stream-class-id=%" PRId64 ", " |
| 1207 | "fc-addr=%p", |
| 1208 | msg_it, msg_it->meta.sc, |
| 1209 | msg_it->meta.sc->id, |
| 1210 | event_header_fc); |
| 1211 | status = read_dscope_begin_state(msg_it, event_header_fc, |
| 1212 | STATE_AFTER_EVENT_HEADER, |
| 1213 | STATE_DSCOPE_EVENT_HEADER_CONTINUE, NULL); |
| 1214 | if (status < 0) { |
| 1215 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1216 | "Cannot decode event header field: " |
| 1217 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1218 | "stream-class-id=%" PRId64 ", fc-addr=%p", |
| 1219 | msg_it, msg_it->meta.sc, |
| 1220 | msg_it->meta.sc->id, |
| 1221 | event_header_fc); |
| 1222 | } |
| 1223 | |
| 1224 | end: |
| 1225 | return status; |
| 1226 | } |
| 1227 | |
| 1228 | static |
| 1229 | enum ctf_msg_iter_status read_event_header_continue_state( |
| 1230 | struct ctf_msg_iter *msg_it) |
| 1231 | { |
| 1232 | return read_dscope_continue_state(msg_it, |
| 1233 | STATE_AFTER_EVENT_HEADER); |
| 1234 | } |
| 1235 | |
| 1236 | static inline |
| 1237 | enum ctf_msg_iter_status set_current_event_class(struct ctf_msg_iter *msg_it) |
| 1238 | { |
| 1239 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1240 | bt_self_component *self_comp = msg_it->self_comp; |
| 1241 | |
| 1242 | struct ctf_event_class *new_event_class = NULL; |
| 1243 | |
| 1244 | if (msg_it->cur_event_class_id == -1) { |
| 1245 | /* |
| 1246 | * No current event class ID field, therefore only one |
| 1247 | * event class. |
| 1248 | */ |
| 1249 | if (msg_it->meta.sc->event_classes->len != 1) { |
| 1250 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1251 | "Need exactly one event class since there's no event class ID field: " |
| 1252 | "msg-it-addr=%p", msg_it); |
| 1253 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1254 | goto end; |
| 1255 | } |
| 1256 | |
| 1257 | new_event_class = msg_it->meta.sc->event_classes->pdata[0]; |
| 1258 | msg_it->cur_event_class_id = new_event_class->id; |
| 1259 | } |
| 1260 | |
| 1261 | new_event_class = ctf_stream_class_borrow_event_class_by_id( |
| 1262 | msg_it->meta.sc, msg_it->cur_event_class_id); |
| 1263 | if (!new_event_class) { |
| 1264 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1265 | "No event class with ID of event class ID to use in stream class: " |
| 1266 | "msg-it-addr=%p, stream-class-id=%" PRIu64 ", " |
| 1267 | "event-class-id=%" PRIu64 ", " |
| 1268 | "trace-class-addr=%p", |
| 1269 | msg_it, msg_it->meta.sc->id, msg_it->cur_event_class_id, |
| 1270 | msg_it->meta.tc); |
| 1271 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1272 | goto end; |
| 1273 | } |
| 1274 | |
| 1275 | msg_it->meta.ec = new_event_class; |
| 1276 | BT_COMP_LOGD("Set current event class: " |
| 1277 | "msg-it-addr=%p, event-class-addr=%p, " |
| 1278 | "event-class-id=%" PRId64 ", " |
| 1279 | "event-class-name=\"%s\"", |
| 1280 | msg_it, msg_it->meta.ec, msg_it->meta.ec->id, |
| 1281 | msg_it->meta.ec->name->str); |
| 1282 | |
| 1283 | end: |
| 1284 | return status; |
| 1285 | } |
| 1286 | |
| 1287 | static inline |
| 1288 | enum ctf_msg_iter_status set_current_event_message( |
| 1289 | struct ctf_msg_iter *msg_it) |
| 1290 | { |
| 1291 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1292 | bt_self_component *self_comp = msg_it->self_comp; |
| 1293 | bt_message *msg = NULL; |
| 1294 | |
| 1295 | BT_ASSERT_DBG(msg_it->meta.ec); |
| 1296 | BT_ASSERT_DBG(msg_it->packet); |
| 1297 | BT_COMP_LOGD("Creating event message from event class and packet: " |
| 1298 | "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p", |
| 1299 | msg_it, msg_it->meta.ec, |
| 1300 | msg_it->meta.ec->name->str, |
| 1301 | msg_it->packet); |
| 1302 | BT_ASSERT_DBG(msg_it->self_msg_iter); |
| 1303 | BT_ASSERT_DBG(msg_it->meta.sc); |
| 1304 | |
| 1305 | if (bt_stream_class_borrow_default_clock_class(msg_it->meta.sc->ir_sc)) { |
| 1306 | msg = bt_message_event_create_with_packet_and_default_clock_snapshot( |
| 1307 | msg_it->self_msg_iter, msg_it->meta.ec->ir_ec, |
| 1308 | msg_it->packet, msg_it->default_clock_snapshot); |
| 1309 | } else { |
| 1310 | msg = bt_message_event_create_with_packet(msg_it->self_msg_iter, |
| 1311 | msg_it->meta.ec->ir_ec, msg_it->packet); |
| 1312 | } |
| 1313 | |
| 1314 | if (!msg) { |
| 1315 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1316 | "Cannot create event message: " |
| 1317 | "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", " |
| 1318 | "packet-addr=%p", |
| 1319 | msg_it, msg_it->meta.ec, |
| 1320 | msg_it->meta.ec->name->str, |
| 1321 | msg_it->packet); |
| 1322 | goto error; |
| 1323 | } |
| 1324 | |
| 1325 | goto end; |
| 1326 | |
| 1327 | error: |
| 1328 | BT_MESSAGE_PUT_REF_AND_RESET(msg); |
| 1329 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 1330 | |
| 1331 | end: |
| 1332 | BT_MESSAGE_MOVE_REF(msg_it->event_msg, msg); |
| 1333 | return status; |
| 1334 | } |
| 1335 | |
| 1336 | static |
| 1337 | enum ctf_msg_iter_status after_event_header_state( |
| 1338 | struct ctf_msg_iter *msg_it) |
| 1339 | { |
| 1340 | enum ctf_msg_iter_status status; |
| 1341 | |
| 1342 | status = set_current_event_class(msg_it); |
| 1343 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 1344 | goto end; |
| 1345 | } |
| 1346 | |
| 1347 | if (G_UNLIKELY(msg_it->dry_run)) { |
| 1348 | goto next_state; |
| 1349 | } |
| 1350 | |
| 1351 | status = set_current_event_message(msg_it); |
| 1352 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 1353 | goto end; |
| 1354 | } |
| 1355 | |
| 1356 | msg_it->event = bt_message_event_borrow_event( |
| 1357 | msg_it->event_msg); |
| 1358 | BT_ASSERT_DBG(msg_it->event); |
| 1359 | |
| 1360 | next_state: |
| 1361 | msg_it->state = STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN; |
| 1362 | |
| 1363 | end: |
| 1364 | return status; |
| 1365 | } |
| 1366 | |
| 1367 | static |
| 1368 | enum ctf_msg_iter_status read_event_common_context_begin_state( |
| 1369 | struct ctf_msg_iter *msg_it) |
| 1370 | { |
| 1371 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1372 | bt_self_component *self_comp = msg_it->self_comp; |
| 1373 | struct ctf_field_class *event_common_context_fc; |
| 1374 | |
| 1375 | event_common_context_fc = msg_it->meta.sc->event_common_context_fc; |
| 1376 | if (!event_common_context_fc) { |
| 1377 | msg_it->state = STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN; |
| 1378 | goto end; |
| 1379 | } |
| 1380 | |
| 1381 | if (event_common_context_fc->in_ir && !msg_it->dry_run) { |
| 1382 | BT_ASSERT_DBG(!msg_it->dscopes.event_common_context); |
| 1383 | msg_it->dscopes.event_common_context = |
| 1384 | bt_event_borrow_common_context_field( |
| 1385 | msg_it->event); |
| 1386 | BT_ASSERT_DBG(msg_it->dscopes.event_common_context); |
| 1387 | } |
| 1388 | |
| 1389 | BT_COMP_LOGT("Decoding event common context field: " |
| 1390 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1391 | "stream-class-id=%" PRId64 ", " |
| 1392 | "fc-addr=%p", |
| 1393 | msg_it, msg_it->meta.sc, |
| 1394 | msg_it->meta.sc->id, |
| 1395 | event_common_context_fc); |
| 1396 | status = read_dscope_begin_state(msg_it, event_common_context_fc, |
| 1397 | STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN, |
| 1398 | STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE, |
| 1399 | msg_it->dscopes.event_common_context); |
| 1400 | if (status < 0) { |
| 1401 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1402 | "Cannot decode event common context field: " |
| 1403 | "msg-it-addr=%p, stream-class-addr=%p, " |
| 1404 | "stream-class-id=%" PRId64 ", fc-addr=%p", |
| 1405 | msg_it, msg_it->meta.sc, |
| 1406 | msg_it->meta.sc->id, |
| 1407 | event_common_context_fc); |
| 1408 | } |
| 1409 | |
| 1410 | end: |
| 1411 | return status; |
| 1412 | } |
| 1413 | |
| 1414 | static |
| 1415 | enum ctf_msg_iter_status read_event_common_context_continue_state( |
| 1416 | struct ctf_msg_iter *msg_it) |
| 1417 | { |
| 1418 | return read_dscope_continue_state(msg_it, |
| 1419 | STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN); |
| 1420 | } |
| 1421 | |
| 1422 | static |
| 1423 | enum ctf_msg_iter_status read_event_spec_context_begin_state( |
| 1424 | struct ctf_msg_iter *msg_it) |
| 1425 | { |
| 1426 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1427 | bt_self_component *self_comp = msg_it->self_comp; |
| 1428 | struct ctf_field_class *event_spec_context_fc; |
| 1429 | |
| 1430 | event_spec_context_fc = msg_it->meta.ec->spec_context_fc; |
| 1431 | if (!event_spec_context_fc) { |
| 1432 | msg_it->state = STATE_DSCOPE_EVENT_PAYLOAD_BEGIN; |
| 1433 | goto end; |
| 1434 | } |
| 1435 | |
| 1436 | if (event_spec_context_fc->in_ir && !msg_it->dry_run) { |
| 1437 | BT_ASSERT_DBG(!msg_it->dscopes.event_spec_context); |
| 1438 | msg_it->dscopes.event_spec_context = |
| 1439 | bt_event_borrow_specific_context_field( |
| 1440 | msg_it->event); |
| 1441 | BT_ASSERT_DBG(msg_it->dscopes.event_spec_context); |
| 1442 | } |
| 1443 | |
| 1444 | BT_COMP_LOGT("Decoding event specific context field: " |
| 1445 | "msg-it-addr=%p, event-class-addr=%p, " |
| 1446 | "event-class-name=\"%s\", event-class-id=%" PRId64 ", " |
| 1447 | "fc-addr=%p", |
| 1448 | msg_it, msg_it->meta.ec, |
| 1449 | msg_it->meta.ec->name->str, |
| 1450 | msg_it->meta.ec->id, |
| 1451 | event_spec_context_fc); |
| 1452 | status = read_dscope_begin_state(msg_it, event_spec_context_fc, |
| 1453 | STATE_DSCOPE_EVENT_PAYLOAD_BEGIN, |
| 1454 | STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE, |
| 1455 | msg_it->dscopes.event_spec_context); |
| 1456 | if (status < 0) { |
| 1457 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1458 | "Cannot decode event specific context field: " |
| 1459 | "msg-it-addr=%p, event-class-addr=%p, " |
| 1460 | "event-class-name=\"%s\", " |
| 1461 | "event-class-id=%" PRId64 ", fc-addr=%p", |
| 1462 | msg_it, msg_it->meta.ec, |
| 1463 | msg_it->meta.ec->name->str, |
| 1464 | msg_it->meta.ec->id, |
| 1465 | event_spec_context_fc); |
| 1466 | } |
| 1467 | |
| 1468 | end: |
| 1469 | return status; |
| 1470 | } |
| 1471 | |
| 1472 | static |
| 1473 | enum ctf_msg_iter_status read_event_spec_context_continue_state( |
| 1474 | struct ctf_msg_iter *msg_it) |
| 1475 | { |
| 1476 | return read_dscope_continue_state(msg_it, |
| 1477 | STATE_DSCOPE_EVENT_PAYLOAD_BEGIN); |
| 1478 | } |
| 1479 | |
| 1480 | static |
| 1481 | enum ctf_msg_iter_status read_event_payload_begin_state( |
| 1482 | struct ctf_msg_iter *msg_it) |
| 1483 | { |
| 1484 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1485 | bt_self_component *self_comp = msg_it->self_comp; |
| 1486 | struct ctf_field_class *event_payload_fc; |
| 1487 | |
| 1488 | event_payload_fc = msg_it->meta.ec->payload_fc; |
| 1489 | if (!event_payload_fc) { |
| 1490 | msg_it->state = STATE_EMIT_MSG_EVENT; |
| 1491 | goto end; |
| 1492 | } |
| 1493 | |
| 1494 | if (event_payload_fc->in_ir && !msg_it->dry_run) { |
| 1495 | BT_ASSERT_DBG(!msg_it->dscopes.event_payload); |
| 1496 | msg_it->dscopes.event_payload = |
| 1497 | bt_event_borrow_payload_field( |
| 1498 | msg_it->event); |
| 1499 | BT_ASSERT_DBG(msg_it->dscopes.event_payload); |
| 1500 | } |
| 1501 | |
| 1502 | BT_COMP_LOGT("Decoding event payload field: " |
| 1503 | "msg-it-addr=%p, event-class-addr=%p, " |
| 1504 | "event-class-name=\"%s\", event-class-id=%" PRId64 ", " |
| 1505 | "fc-addr=%p", |
| 1506 | msg_it, msg_it->meta.ec, |
| 1507 | msg_it->meta.ec->name->str, |
| 1508 | msg_it->meta.ec->id, |
| 1509 | event_payload_fc); |
| 1510 | status = read_dscope_begin_state(msg_it, event_payload_fc, |
| 1511 | STATE_EMIT_MSG_EVENT, |
| 1512 | STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE, |
| 1513 | msg_it->dscopes.event_payload); |
| 1514 | if (status < 0) { |
| 1515 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1516 | "Cannot decode event payload field: " |
| 1517 | "msg-it-addr=%p, event-class-addr=%p, " |
| 1518 | "event-class-name=\"%s\", " |
| 1519 | "event-class-id=%" PRId64 ", fc-addr=%p", |
| 1520 | msg_it, msg_it->meta.ec, |
| 1521 | msg_it->meta.ec->name->str, |
| 1522 | msg_it->meta.ec->id, |
| 1523 | event_payload_fc); |
| 1524 | } |
| 1525 | |
| 1526 | end: |
| 1527 | return status; |
| 1528 | } |
| 1529 | |
| 1530 | static |
| 1531 | enum ctf_msg_iter_status read_event_payload_continue_state( |
| 1532 | struct ctf_msg_iter *msg_it) |
| 1533 | { |
| 1534 | return read_dscope_continue_state(msg_it, STATE_EMIT_MSG_EVENT); |
| 1535 | } |
| 1536 | |
| 1537 | static |
| 1538 | enum ctf_msg_iter_status skip_packet_padding_state(struct ctf_msg_iter *msg_it) |
| 1539 | { |
| 1540 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1541 | size_t bits_to_skip; |
| 1542 | const enum state next_state = STATE_SWITCH_PACKET; |
| 1543 | |
| 1544 | BT_ASSERT(msg_it->cur_exp_packet_total_size > 0); |
| 1545 | bits_to_skip = msg_it->cur_exp_packet_total_size - packet_at(msg_it); |
| 1546 | if (bits_to_skip == 0) { |
| 1547 | msg_it->state = next_state; |
| 1548 | goto end; |
| 1549 | } else { |
| 1550 | size_t bits_to_consume; |
| 1551 | |
| 1552 | BT_COMP_LOGD("Trying to skip %zu bits of padding: msg-it-addr=%p, size=%zu", |
| 1553 | bits_to_skip, msg_it, bits_to_skip); |
| 1554 | status = buf_ensure_available_bits(msg_it); |
| 1555 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 1556 | goto end; |
| 1557 | } |
| 1558 | |
| 1559 | bits_to_consume = MIN(buf_available_bits(msg_it), bits_to_skip); |
| 1560 | BT_COMP_LOGD("Skipping %zu bits of padding: msg-it-addr=%p, size=%zu", |
| 1561 | bits_to_consume, msg_it, bits_to_consume); |
| 1562 | buf_consume_bits(msg_it, bits_to_consume); |
| 1563 | bits_to_skip = msg_it->cur_exp_packet_total_size - |
| 1564 | packet_at(msg_it); |
| 1565 | if (bits_to_skip == 0) { |
| 1566 | msg_it->state = next_state; |
| 1567 | goto end; |
| 1568 | } |
| 1569 | } |
| 1570 | |
| 1571 | end: |
| 1572 | return status; |
| 1573 | } |
| 1574 | |
| 1575 | static |
| 1576 | enum ctf_msg_iter_status check_emit_msg_stream_beginning_state( |
| 1577 | struct ctf_msg_iter *msg_it) |
| 1578 | { |
| 1579 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1580 | |
| 1581 | if (msg_it->set_stream) { |
| 1582 | status = set_current_stream(msg_it); |
| 1583 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 1584 | goto end; |
| 1585 | } |
| 1586 | } |
| 1587 | |
| 1588 | if (msg_it->emit_stream_begin_msg) { |
| 1589 | msg_it->state = STATE_EMIT_MSG_STREAM_BEGINNING; |
| 1590 | } else { |
| 1591 | /* Stream's first packet */ |
| 1592 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS; |
| 1593 | } |
| 1594 | |
| 1595 | end: |
| 1596 | return status; |
| 1597 | } |
| 1598 | |
| 1599 | static |
| 1600 | enum ctf_msg_iter_status check_emit_msg_discarded_events( |
| 1601 | struct ctf_msg_iter *msg_it) |
| 1602 | { |
| 1603 | msg_it->state = STATE_EMIT_MSG_DISCARDED_EVENTS; |
| 1604 | |
| 1605 | if (!msg_it->meta.sc->has_discarded_events) { |
| 1606 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS; |
| 1607 | goto end; |
| 1608 | } |
| 1609 | |
| 1610 | if (msg_it->prev_packet_snapshots.discarded_events == UINT64_C(-1)) { |
| 1611 | if (msg_it->snapshots.discarded_events == 0 || |
| 1612 | msg_it->snapshots.discarded_events == UINT64_C(-1)) { |
| 1613 | /* |
| 1614 | * Stream's first packet with no discarded |
| 1615 | * events or no information about discarded |
| 1616 | * events: do not emit. |
| 1617 | */ |
| 1618 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS; |
| 1619 | } |
| 1620 | } else { |
| 1621 | /* |
| 1622 | * If the previous packet has a value for this counter, |
| 1623 | * then this counter is defined for the whole stream. |
| 1624 | */ |
| 1625 | BT_ASSERT(msg_it->snapshots.discarded_events != UINT64_C(-1)); |
| 1626 | |
| 1627 | if (msg_it->snapshots.discarded_events - |
| 1628 | msg_it->prev_packet_snapshots.discarded_events == 0) { |
| 1629 | /* |
| 1630 | * No discarded events since previous packet: do |
| 1631 | * not emit. |
| 1632 | */ |
| 1633 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS; |
| 1634 | } |
| 1635 | } |
| 1636 | |
| 1637 | end: |
| 1638 | return CTF_MSG_ITER_STATUS_OK; |
| 1639 | } |
| 1640 | |
| 1641 | static |
| 1642 | enum ctf_msg_iter_status check_emit_msg_discarded_packets( |
| 1643 | struct ctf_msg_iter *msg_it) |
| 1644 | { |
| 1645 | msg_it->state = STATE_EMIT_MSG_DISCARDED_PACKETS; |
| 1646 | |
| 1647 | if (!msg_it->meta.sc->has_discarded_packets) { |
| 1648 | msg_it->state = STATE_EMIT_MSG_PACKET_BEGINNING; |
| 1649 | goto end; |
| 1650 | } |
| 1651 | |
| 1652 | if (msg_it->prev_packet_snapshots.packets == UINT64_C(-1)) { |
| 1653 | /* |
| 1654 | * Stream's first packet or no information about |
| 1655 | * discarded packets: do not emit. In other words, if |
| 1656 | * this is the first packet and its sequence number is |
| 1657 | * not 0, do not consider that packets were previously |
| 1658 | * lost: we might be reading a partial stream (LTTng |
| 1659 | * snapshot for example). |
| 1660 | */ |
| 1661 | msg_it->state = STATE_EMIT_MSG_PACKET_BEGINNING; |
| 1662 | } else { |
| 1663 | /* |
| 1664 | * If the previous packet has a value for this counter, |
| 1665 | * then this counter is defined for the whole stream. |
| 1666 | */ |
| 1667 | BT_ASSERT(msg_it->snapshots.packets != UINT64_C(-1)); |
| 1668 | |
| 1669 | if (msg_it->snapshots.packets - |
| 1670 | msg_it->prev_packet_snapshots.packets <= 1) { |
| 1671 | /* |
| 1672 | * No discarded packets since previous packet: |
| 1673 | * do not emit. |
| 1674 | */ |
| 1675 | msg_it->state = STATE_EMIT_MSG_PACKET_BEGINNING; |
| 1676 | } |
| 1677 | } |
| 1678 | |
| 1679 | end: |
| 1680 | return CTF_MSG_ITER_STATUS_OK; |
| 1681 | } |
| 1682 | |
| 1683 | static |
| 1684 | enum ctf_msg_iter_status check_emit_msg_stream_end( |
| 1685 | struct ctf_msg_iter *msg_it) |
| 1686 | { |
| 1687 | if (msg_it->emit_stream_end_msg) { |
| 1688 | msg_it->state = STATE_EMIT_MSG_STREAM_END; |
| 1689 | } else { |
| 1690 | msg_it->state = STATE_DONE; |
| 1691 | } |
| 1692 | |
| 1693 | return CTF_MSG_ITER_STATUS_OK; |
| 1694 | } |
| 1695 | |
| 1696 | static inline |
| 1697 | enum ctf_msg_iter_status handle_state(struct ctf_msg_iter *msg_it) |
| 1698 | { |
| 1699 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 1700 | const enum state state = msg_it->state; |
| 1701 | |
| 1702 | BT_COMP_LOGT("Handling state: msg-it-addr=%p, state=%s", |
| 1703 | msg_it, state_string(state)); |
| 1704 | |
| 1705 | // TODO: optimalize! |
| 1706 | switch (state) { |
| 1707 | case STATE_INIT: |
| 1708 | msg_it->state = STATE_SWITCH_PACKET; |
| 1709 | break; |
| 1710 | case STATE_SWITCH_PACKET: |
| 1711 | status = switch_packet_state(msg_it); |
| 1712 | break; |
| 1713 | case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN: |
| 1714 | status = read_packet_header_begin_state(msg_it); |
| 1715 | break; |
| 1716 | case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE: |
| 1717 | status = read_packet_header_continue_state(msg_it); |
| 1718 | break; |
| 1719 | case STATE_AFTER_TRACE_PACKET_HEADER: |
| 1720 | status = after_packet_header_state(msg_it); |
| 1721 | break; |
| 1722 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN: |
| 1723 | status = read_packet_context_begin_state(msg_it); |
| 1724 | break; |
| 1725 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE: |
| 1726 | status = read_packet_context_continue_state(msg_it); |
| 1727 | break; |
| 1728 | case STATE_AFTER_STREAM_PACKET_CONTEXT: |
| 1729 | status = after_packet_context_state(msg_it); |
| 1730 | break; |
| 1731 | case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING: |
| 1732 | status = check_emit_msg_stream_beginning_state(msg_it); |
| 1733 | break; |
| 1734 | case STATE_EMIT_MSG_STREAM_BEGINNING: |
| 1735 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS; |
| 1736 | break; |
| 1737 | case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS: |
| 1738 | status = check_emit_msg_discarded_events(msg_it); |
| 1739 | break; |
| 1740 | case STATE_EMIT_MSG_DISCARDED_EVENTS: |
| 1741 | msg_it->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS; |
| 1742 | break; |
| 1743 | case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS: |
| 1744 | status = check_emit_msg_discarded_packets(msg_it); |
| 1745 | break; |
| 1746 | case STATE_EMIT_MSG_DISCARDED_PACKETS: |
| 1747 | msg_it->state = STATE_EMIT_MSG_PACKET_BEGINNING; |
| 1748 | break; |
| 1749 | case STATE_EMIT_MSG_PACKET_BEGINNING: |
| 1750 | msg_it->state = STATE_DSCOPE_EVENT_HEADER_BEGIN; |
| 1751 | break; |
| 1752 | case STATE_DSCOPE_EVENT_HEADER_BEGIN: |
| 1753 | status = read_event_header_begin_state(msg_it); |
| 1754 | break; |
| 1755 | case STATE_DSCOPE_EVENT_HEADER_CONTINUE: |
| 1756 | status = read_event_header_continue_state(msg_it); |
| 1757 | break; |
| 1758 | case STATE_AFTER_EVENT_HEADER: |
| 1759 | status = after_event_header_state(msg_it); |
| 1760 | break; |
| 1761 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN: |
| 1762 | status = read_event_common_context_begin_state(msg_it); |
| 1763 | break; |
| 1764 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE: |
| 1765 | status = read_event_common_context_continue_state(msg_it); |
| 1766 | break; |
| 1767 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN: |
| 1768 | status = read_event_spec_context_begin_state(msg_it); |
| 1769 | break; |
| 1770 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE: |
| 1771 | status = read_event_spec_context_continue_state(msg_it); |
| 1772 | break; |
| 1773 | case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN: |
| 1774 | status = read_event_payload_begin_state(msg_it); |
| 1775 | break; |
| 1776 | case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE: |
| 1777 | status = read_event_payload_continue_state(msg_it); |
| 1778 | break; |
| 1779 | case STATE_EMIT_MSG_EVENT: |
| 1780 | msg_it->state = STATE_DSCOPE_EVENT_HEADER_BEGIN; |
| 1781 | break; |
| 1782 | case STATE_EMIT_QUEUED_MSG_EVENT: |
| 1783 | msg_it->state = STATE_EMIT_MSG_EVENT; |
| 1784 | break; |
| 1785 | case STATE_SKIP_PACKET_PADDING: |
| 1786 | status = skip_packet_padding_state(msg_it); |
| 1787 | break; |
| 1788 | case STATE_EMIT_MSG_PACKET_END_MULTI: |
| 1789 | msg_it->state = STATE_SKIP_PACKET_PADDING; |
| 1790 | break; |
| 1791 | case STATE_EMIT_MSG_PACKET_END_SINGLE: |
| 1792 | msg_it->state = STATE_CHECK_EMIT_MSG_STREAM_END; |
| 1793 | break; |
| 1794 | case STATE_CHECK_EMIT_MSG_STREAM_END: |
| 1795 | status = check_emit_msg_stream_end(msg_it); |
| 1796 | break; |
| 1797 | case STATE_EMIT_QUEUED_MSG_PACKET_END: |
| 1798 | msg_it->state = STATE_EMIT_MSG_PACKET_END_SINGLE; |
| 1799 | break; |
| 1800 | case STATE_EMIT_MSG_STREAM_END: |
| 1801 | msg_it->state = STATE_DONE; |
| 1802 | break; |
| 1803 | case STATE_DONE: |
| 1804 | break; |
| 1805 | default: |
| 1806 | BT_COMP_LOGF("Unknown CTF plugin message iterator state: " |
| 1807 | "msg-it-addr=%p, state=%d", msg_it, msg_it->state); |
| 1808 | bt_common_abort(); |
| 1809 | } |
| 1810 | |
| 1811 | BT_COMP_LOGT("Handled state: msg-it-addr=%p, status=%s, " |
| 1812 | "prev-state=%s, cur-state=%s", |
| 1813 | msg_it, ctf_msg_iter_status_string(status), |
| 1814 | state_string(state), state_string(msg_it->state)); |
| 1815 | return status; |
| 1816 | } |
| 1817 | |
| 1818 | BT_HIDDEN |
| 1819 | void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter *msg_it) |
| 1820 | { |
| 1821 | BT_ASSERT(msg_it); |
| 1822 | BT_COMP_LOGD("Resetting message iterator: addr=%p", msg_it); |
| 1823 | stack_clear(msg_it->stack); |
| 1824 | msg_it->meta.sc = NULL; |
| 1825 | msg_it->meta.ec = NULL; |
| 1826 | BT_PACKET_PUT_REF_AND_RESET(msg_it->packet); |
| 1827 | BT_STREAM_PUT_REF_AND_RESET(msg_it->stream); |
| 1828 | BT_MESSAGE_PUT_REF_AND_RESET(msg_it->event_msg); |
| 1829 | release_all_dscopes(msg_it); |
| 1830 | msg_it->cur_dscope_field = NULL; |
| 1831 | |
| 1832 | if (msg_it->packet_context_field) { |
| 1833 | bt_packet_context_field_release(msg_it->packet_context_field); |
| 1834 | msg_it->packet_context_field = NULL; |
| 1835 | } |
| 1836 | |
| 1837 | msg_it->buf.addr = NULL; |
| 1838 | msg_it->buf.sz = 0; |
| 1839 | msg_it->buf.at = 0; |
| 1840 | msg_it->buf.last_eh_at = SIZE_MAX; |
| 1841 | msg_it->buf.packet_offset = 0; |
| 1842 | msg_it->state = STATE_INIT; |
| 1843 | msg_it->cur_exp_packet_content_size = -1; |
| 1844 | msg_it->cur_exp_packet_total_size = -1; |
| 1845 | msg_it->cur_packet_offset = -1; |
| 1846 | msg_it->cur_event_class_id = -1; |
| 1847 | msg_it->snapshots.beginning_clock = UINT64_C(-1); |
| 1848 | msg_it->snapshots.end_clock = UINT64_C(-1); |
| 1849 | } |
| 1850 | |
| 1851 | /** |
| 1852 | * Resets the internal state of a CTF message iterator. |
| 1853 | */ |
| 1854 | BT_HIDDEN |
| 1855 | void ctf_msg_iter_reset(struct ctf_msg_iter *msg_it) |
| 1856 | { |
| 1857 | ctf_msg_iter_reset_for_next_stream_file(msg_it); |
| 1858 | msg_it->cur_stream_class_id = -1; |
| 1859 | msg_it->cur_data_stream_id = -1; |
| 1860 | msg_it->snapshots.discarded_events = UINT64_C(-1); |
| 1861 | msg_it->snapshots.packets = UINT64_C(-1); |
| 1862 | msg_it->prev_packet_snapshots.discarded_events = UINT64_C(-1); |
| 1863 | msg_it->prev_packet_snapshots.packets = UINT64_C(-1); |
| 1864 | msg_it->prev_packet_snapshots.beginning_clock = UINT64_C(-1); |
| 1865 | msg_it->prev_packet_snapshots.end_clock = UINT64_C(-1); |
| 1866 | } |
| 1867 | |
| 1868 | static |
| 1869 | bt_field *borrow_next_field(struct ctf_msg_iter *msg_it) |
| 1870 | { |
| 1871 | bt_field *next_field = NULL; |
| 1872 | bt_field *base_field; |
| 1873 | const bt_field_class *base_fc; |
| 1874 | bt_field_class_type base_fc_type; |
| 1875 | size_t index; |
| 1876 | |
| 1877 | BT_ASSERT_DBG(!stack_empty(msg_it->stack)); |
| 1878 | index = stack_top(msg_it->stack)->index; |
| 1879 | base_field = stack_top(msg_it->stack)->base; |
| 1880 | BT_ASSERT_DBG(base_field); |
| 1881 | base_fc = bt_field_borrow_class_const(base_field); |
| 1882 | BT_ASSERT_DBG(base_fc); |
| 1883 | base_fc_type = bt_field_class_get_type(base_fc); |
| 1884 | |
| 1885 | if (base_fc_type == BT_FIELD_CLASS_TYPE_STRUCTURE) { |
| 1886 | BT_ASSERT_DBG(index < |
| 1887 | bt_field_class_structure_get_member_count( |
| 1888 | bt_field_borrow_class_const( |
| 1889 | base_field))); |
| 1890 | next_field = |
| 1891 | bt_field_structure_borrow_member_field_by_index( |
| 1892 | base_field, index); |
| 1893 | } else if (bt_field_class_type_is(base_fc_type, |
| 1894 | BT_FIELD_CLASS_TYPE_ARRAY)) { |
| 1895 | BT_ASSERT_DBG(index < bt_field_array_get_length(base_field)); |
| 1896 | next_field = bt_field_array_borrow_element_field_by_index( |
| 1897 | base_field, index); |
| 1898 | } else if (bt_field_class_type_is(base_fc_type, |
| 1899 | BT_FIELD_CLASS_TYPE_VARIANT)) { |
| 1900 | BT_ASSERT_DBG(index == 0); |
| 1901 | next_field = bt_field_variant_borrow_selected_option_field( |
| 1902 | base_field); |
| 1903 | } else { |
| 1904 | bt_common_abort(); |
| 1905 | } |
| 1906 | |
| 1907 | BT_ASSERT_DBG(next_field); |
| 1908 | return next_field; |
| 1909 | } |
| 1910 | |
| 1911 | static |
| 1912 | void update_default_clock(struct ctf_msg_iter *msg_it, uint64_t new_val, |
| 1913 | uint64_t new_val_size) |
| 1914 | { |
| 1915 | uint64_t new_val_mask; |
| 1916 | uint64_t cur_value_masked; |
| 1917 | |
| 1918 | BT_ASSERT_DBG(new_val_size > 0); |
| 1919 | |
| 1920 | /* |
| 1921 | * Special case for a 64-bit new value, which is the limit |
| 1922 | * of a clock value as of this version: overwrite the |
| 1923 | * current value directly. |
| 1924 | */ |
| 1925 | if (new_val_size == 64) { |
| 1926 | msg_it->default_clock_snapshot = new_val; |
| 1927 | goto end; |
| 1928 | } |
| 1929 | |
| 1930 | new_val_mask = (1ULL << new_val_size) - 1; |
| 1931 | cur_value_masked = msg_it->default_clock_snapshot & new_val_mask; |
| 1932 | |
| 1933 | if (new_val < cur_value_masked) { |
| 1934 | /* |
| 1935 | * It looks like a wrap happened on the number of bits |
| 1936 | * of the requested new value. Assume that the clock |
| 1937 | * value wrapped only one time. |
| 1938 | */ |
| 1939 | msg_it->default_clock_snapshot += new_val_mask + 1; |
| 1940 | } |
| 1941 | |
| 1942 | /* Clear the low bits of the current clock value. */ |
| 1943 | msg_it->default_clock_snapshot &= ~new_val_mask; |
| 1944 | |
| 1945 | /* Set the low bits of the current clock value. */ |
| 1946 | msg_it->default_clock_snapshot |= new_val; |
| 1947 | |
| 1948 | end: |
| 1949 | BT_COMP_LOGT("Updated default clock's value from integer field's value: " |
| 1950 | "value=%" PRIu64, msg_it->default_clock_snapshot); |
| 1951 | } |
| 1952 | |
| 1953 | static |
| 1954 | enum bt_bfcr_status bfcr_unsigned_int_cb(uint64_t value, |
| 1955 | struct ctf_field_class *fc, void *data) |
| 1956 | { |
| 1957 | struct ctf_msg_iter *msg_it = data; |
| 1958 | bt_self_component *self_comp = msg_it->self_comp; |
| 1959 | enum bt_bfcr_status status = BT_BFCR_STATUS_OK; |
| 1960 | |
| 1961 | bt_field *field = NULL; |
| 1962 | struct ctf_field_class_int *int_fc = (void *) fc; |
| 1963 | |
| 1964 | BT_COMP_LOGT("Unsigned integer function called from BFCR: " |
| 1965 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 1966 | "fc-type=%d, fc-in-ir=%d, value=%" PRIu64, |
| 1967 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value); |
| 1968 | |
| 1969 | if (G_LIKELY(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE)) { |
| 1970 | goto update_def_clock; |
| 1971 | } |
| 1972 | |
| 1973 | switch (int_fc->meaning) { |
| 1974 | case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID: |
| 1975 | msg_it->cur_event_class_id = value; |
| 1976 | break; |
| 1977 | case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID: |
| 1978 | msg_it->cur_data_stream_id = value; |
| 1979 | break; |
| 1980 | case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME: |
| 1981 | msg_it->snapshots.beginning_clock = value; |
| 1982 | break; |
| 1983 | case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME: |
| 1984 | msg_it->snapshots.end_clock = value; |
| 1985 | break; |
| 1986 | case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID: |
| 1987 | msg_it->cur_stream_class_id = value; |
| 1988 | break; |
| 1989 | case CTF_FIELD_CLASS_MEANING_MAGIC: |
| 1990 | if (value != 0xc1fc1fc1) { |
| 1991 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 1992 | "Invalid CTF magic number: msg-it-addr=%p, " |
| 1993 | "magic=%" PRIx64, msg_it, value); |
| 1994 | status = BT_BFCR_STATUS_ERROR; |
| 1995 | goto end; |
| 1996 | } |
| 1997 | |
| 1998 | break; |
| 1999 | case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT: |
| 2000 | msg_it->snapshots.packets = value; |
| 2001 | break; |
| 2002 | case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT: |
| 2003 | msg_it->snapshots.discarded_events = value; |
| 2004 | break; |
| 2005 | case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE: |
| 2006 | msg_it->cur_exp_packet_total_size = value; |
| 2007 | break; |
| 2008 | case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE: |
| 2009 | msg_it->cur_exp_packet_content_size = value; |
| 2010 | break; |
| 2011 | default: |
| 2012 | bt_common_abort(); |
| 2013 | } |
| 2014 | |
| 2015 | update_def_clock: |
| 2016 | if (G_UNLIKELY(int_fc->mapped_clock_class)) { |
| 2017 | update_default_clock(msg_it, value, int_fc->base.size); |
| 2018 | } |
| 2019 | |
| 2020 | if (G_UNLIKELY(int_fc->storing_index >= 0)) { |
| 2021 | g_array_index(msg_it->stored_values, uint64_t, |
| 2022 | (uint64_t) int_fc->storing_index) = value; |
| 2023 | } |
| 2024 | |
| 2025 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2026 | goto end; |
| 2027 | } |
| 2028 | |
| 2029 | field = borrow_next_field(msg_it); |
| 2030 | BT_ASSERT_DBG(field); |
| 2031 | BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc); |
| 2032 | BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field), |
| 2033 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER)); |
| 2034 | bt_field_integer_unsigned_set_value(field, value); |
| 2035 | stack_top(msg_it->stack)->index++; |
| 2036 | |
| 2037 | end: |
| 2038 | return status; |
| 2039 | } |
| 2040 | |
| 2041 | static |
| 2042 | enum bt_bfcr_status bfcr_unsigned_int_char_cb(uint64_t value, |
| 2043 | struct ctf_field_class *fc, void *data) |
| 2044 | { |
| 2045 | int ret; |
| 2046 | struct ctf_msg_iter *msg_it = data; |
| 2047 | bt_self_component *self_comp = msg_it->self_comp; |
| 2048 | enum bt_bfcr_status status = BT_BFCR_STATUS_OK; |
| 2049 | bt_field *string_field = NULL; |
| 2050 | struct ctf_field_class_int *int_fc = (void *) fc; |
| 2051 | char str[2] = {'\0', '\0'}; |
| 2052 | |
| 2053 | BT_COMP_LOGT("Unsigned integer character function called from BFCR: " |
| 2054 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2055 | "fc-type=%d, fc-in-ir=%d, value=%" PRIu64, |
| 2056 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value); |
| 2057 | BT_ASSERT_DBG(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE); |
| 2058 | BT_ASSERT_DBG(!int_fc->mapped_clock_class); |
| 2059 | BT_ASSERT_DBG(int_fc->storing_index < 0); |
| 2060 | |
| 2061 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2062 | goto end; |
| 2063 | } |
| 2064 | |
| 2065 | if (msg_it->done_filling_string) { |
| 2066 | goto end; |
| 2067 | } |
| 2068 | |
| 2069 | if (value == 0) { |
| 2070 | msg_it->done_filling_string = true; |
| 2071 | goto end; |
| 2072 | } |
| 2073 | |
| 2074 | string_field = stack_top(msg_it->stack)->base; |
| 2075 | BT_ASSERT_DBG(bt_field_get_class_type(string_field) == |
| 2076 | BT_FIELD_CLASS_TYPE_STRING); |
| 2077 | |
| 2078 | /* Append character */ |
| 2079 | str[0] = (char) value; |
| 2080 | ret = bt_field_string_append_with_length(string_field, str, 1); |
| 2081 | if (ret) { |
| 2082 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2083 | "Cannot append character to string field's value: " |
| 2084 | "msg-it-addr=%p, field-addr=%p, ret=%d", |
| 2085 | msg_it, string_field, ret); |
| 2086 | status = BT_BFCR_STATUS_ERROR; |
| 2087 | goto end; |
| 2088 | } |
| 2089 | |
| 2090 | end: |
| 2091 | return status; |
| 2092 | } |
| 2093 | |
| 2094 | static |
| 2095 | enum bt_bfcr_status bfcr_signed_int_cb(int64_t value, |
| 2096 | struct ctf_field_class *fc, void *data) |
| 2097 | { |
| 2098 | enum bt_bfcr_status status = BT_BFCR_STATUS_OK; |
| 2099 | bt_field *field = NULL; |
| 2100 | struct ctf_msg_iter *msg_it = data; |
| 2101 | struct ctf_field_class_int *int_fc = (void *) fc; |
| 2102 | |
| 2103 | BT_COMP_LOGT("Signed integer function called from BFCR: " |
| 2104 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2105 | "fc-type=%d, fc-in-ir=%d, value=%" PRId64, |
| 2106 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value); |
| 2107 | BT_ASSERT_DBG(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE); |
| 2108 | |
| 2109 | if (G_UNLIKELY(int_fc->storing_index >= 0)) { |
| 2110 | g_array_index(msg_it->stored_values, uint64_t, |
| 2111 | (uint64_t) int_fc->storing_index) = (uint64_t) value; |
| 2112 | } |
| 2113 | |
| 2114 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2115 | goto end; |
| 2116 | } |
| 2117 | |
| 2118 | field = borrow_next_field(msg_it); |
| 2119 | BT_ASSERT_DBG(field); |
| 2120 | BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc); |
| 2121 | BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field), |
| 2122 | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER)); |
| 2123 | bt_field_integer_signed_set_value(field, value); |
| 2124 | stack_top(msg_it->stack)->index++; |
| 2125 | |
| 2126 | end: |
| 2127 | return status; |
| 2128 | } |
| 2129 | |
| 2130 | static |
| 2131 | enum bt_bfcr_status bfcr_floating_point_cb(double value, |
| 2132 | struct ctf_field_class *fc, void *data) |
| 2133 | { |
| 2134 | enum bt_bfcr_status status = BT_BFCR_STATUS_OK; |
| 2135 | bt_field *field = NULL; |
| 2136 | struct ctf_msg_iter *msg_it = data; |
| 2137 | bt_field_class_type type; |
| 2138 | |
| 2139 | BT_COMP_LOGT("Floating point number function called from BFCR: " |
| 2140 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2141 | "fc-type=%d, fc-in-ir=%d, value=%f", |
| 2142 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value); |
| 2143 | |
| 2144 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2145 | goto end; |
| 2146 | } |
| 2147 | |
| 2148 | field = borrow_next_field(msg_it); |
| 2149 | type = bt_field_get_class_type(field); |
| 2150 | BT_ASSERT_DBG(field); |
| 2151 | BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc); |
| 2152 | BT_ASSERT_DBG(bt_field_class_type_is(type, BT_FIELD_CLASS_TYPE_REAL)); |
| 2153 | |
| 2154 | if (type == BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL) { |
| 2155 | bt_field_real_single_precision_set_value(field, (float) value); |
| 2156 | } else { |
| 2157 | bt_field_real_double_precision_set_value(field, value); |
| 2158 | } |
| 2159 | stack_top(msg_it->stack)->index++; |
| 2160 | |
| 2161 | end: |
| 2162 | return status; |
| 2163 | } |
| 2164 | |
| 2165 | static |
| 2166 | enum bt_bfcr_status bfcr_string_begin_cb( |
| 2167 | struct ctf_field_class *fc, void *data) |
| 2168 | { |
| 2169 | bt_field *field = NULL; |
| 2170 | struct ctf_msg_iter *msg_it = data; |
| 2171 | |
| 2172 | BT_COMP_LOGT("String (beginning) function called from BFCR: " |
| 2173 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2174 | "fc-type=%d, fc-in-ir=%d", |
| 2175 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir); |
| 2176 | |
| 2177 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2178 | goto end; |
| 2179 | } |
| 2180 | |
| 2181 | field = borrow_next_field(msg_it); |
| 2182 | BT_ASSERT_DBG(field); |
| 2183 | BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc); |
| 2184 | BT_ASSERT_DBG(bt_field_get_class_type(field) == |
| 2185 | BT_FIELD_CLASS_TYPE_STRING); |
| 2186 | bt_field_string_clear(field); |
| 2187 | |
| 2188 | /* |
| 2189 | * Push on stack. Not a compound class per se, but we know that |
| 2190 | * only bfcr_string_cb() may be called between this call and a |
| 2191 | * subsequent call to bfcr_string_end_cb(). |
| 2192 | */ |
| 2193 | stack_push(msg_it->stack, field); |
| 2194 | |
| 2195 | end: |
| 2196 | return BT_BFCR_STATUS_OK; |
| 2197 | } |
| 2198 | |
| 2199 | static |
| 2200 | enum bt_bfcr_status bfcr_string_cb(const char *value, |
| 2201 | size_t len, struct ctf_field_class *fc, void *data) |
| 2202 | { |
| 2203 | enum bt_bfcr_status status = BT_BFCR_STATUS_OK; |
| 2204 | bt_field *field = NULL; |
| 2205 | struct ctf_msg_iter *msg_it = data; |
| 2206 | bt_self_component *self_comp = msg_it->self_comp; |
| 2207 | int ret; |
| 2208 | |
| 2209 | BT_COMP_LOGT("String (substring) function called from BFCR: " |
| 2210 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2211 | "fc-type=%d, fc-in-ir=%d, string-length=%zu", |
| 2212 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, |
| 2213 | len); |
| 2214 | |
| 2215 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2216 | goto end; |
| 2217 | } |
| 2218 | |
| 2219 | field = stack_top(msg_it->stack)->base; |
| 2220 | BT_ASSERT_DBG(field); |
| 2221 | |
| 2222 | /* Append current substring */ |
| 2223 | ret = bt_field_string_append_with_length(field, value, len); |
| 2224 | if (ret) { |
| 2225 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2226 | "Cannot append substring to string field's value: " |
| 2227 | "msg-it-addr=%p, field-addr=%p, string-length=%zu, " |
| 2228 | "ret=%d", msg_it, field, len, ret); |
| 2229 | status = BT_BFCR_STATUS_ERROR; |
| 2230 | goto end; |
| 2231 | } |
| 2232 | |
| 2233 | end: |
| 2234 | return status; |
| 2235 | } |
| 2236 | |
| 2237 | static |
| 2238 | enum bt_bfcr_status bfcr_string_end_cb( |
| 2239 | struct ctf_field_class *fc, void *data) |
| 2240 | { |
| 2241 | struct ctf_msg_iter *msg_it = data; |
| 2242 | |
| 2243 | BT_COMP_LOGT("String (end) function called from BFCR: " |
| 2244 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2245 | "fc-type=%d, fc-in-ir=%d", |
| 2246 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir); |
| 2247 | |
| 2248 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2249 | goto end; |
| 2250 | } |
| 2251 | |
| 2252 | /* Pop string field */ |
| 2253 | stack_pop(msg_it->stack); |
| 2254 | |
| 2255 | /* Go to next field */ |
| 2256 | stack_top(msg_it->stack)->index++; |
| 2257 | |
| 2258 | end: |
| 2259 | return BT_BFCR_STATUS_OK; |
| 2260 | } |
| 2261 | |
| 2262 | static |
| 2263 | enum bt_bfcr_status bfcr_compound_begin_cb( |
| 2264 | struct ctf_field_class *fc, void *data) |
| 2265 | { |
| 2266 | struct ctf_msg_iter *msg_it = data; |
| 2267 | bt_field *field; |
| 2268 | |
| 2269 | BT_COMP_LOGT("Compound (beginning) function called from BFCR: " |
| 2270 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2271 | "fc-type=%d, fc-in-ir=%d", |
| 2272 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir); |
| 2273 | |
| 2274 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2275 | goto end; |
| 2276 | } |
| 2277 | |
| 2278 | /* Borrow field */ |
| 2279 | if (stack_empty(msg_it->stack)) { |
| 2280 | /* Root: already set by read_dscope_begin_state() */ |
| 2281 | field = msg_it->cur_dscope_field; |
| 2282 | } else { |
| 2283 | field = borrow_next_field(msg_it); |
| 2284 | BT_ASSERT_DBG(field); |
| 2285 | } |
| 2286 | |
| 2287 | /* Push field */ |
| 2288 | BT_ASSERT_DBG(field); |
| 2289 | BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc); |
| 2290 | stack_push(msg_it->stack, field); |
| 2291 | |
| 2292 | /* |
| 2293 | * Change BFCR "unsigned int" callback if it's a text |
| 2294 | * array/sequence. |
| 2295 | */ |
| 2296 | if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY || |
| 2297 | fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) { |
| 2298 | struct ctf_field_class_array_base *array_fc = (void *) fc; |
| 2299 | |
| 2300 | if (array_fc->is_text) { |
| 2301 | BT_ASSERT_DBG(bt_field_get_class_type(field) == |
| 2302 | BT_FIELD_CLASS_TYPE_STRING); |
| 2303 | msg_it->done_filling_string = false; |
| 2304 | bt_field_string_clear(field); |
| 2305 | bt_bfcr_set_unsigned_int_cb(msg_it->bfcr, |
| 2306 | bfcr_unsigned_int_char_cb); |
| 2307 | } |
| 2308 | } |
| 2309 | |
| 2310 | end: |
| 2311 | return BT_BFCR_STATUS_OK; |
| 2312 | } |
| 2313 | |
| 2314 | static |
| 2315 | enum bt_bfcr_status bfcr_compound_end_cb( |
| 2316 | struct ctf_field_class *fc, void *data) |
| 2317 | { |
| 2318 | struct ctf_msg_iter *msg_it = data; |
| 2319 | |
| 2320 | BT_COMP_LOGT("Compound (end) function called from BFCR: " |
| 2321 | "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, " |
| 2322 | "fc-type=%d, fc-in-ir=%d", |
| 2323 | msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir); |
| 2324 | |
| 2325 | if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) { |
| 2326 | goto end; |
| 2327 | } |
| 2328 | |
| 2329 | BT_ASSERT_DBG(!stack_empty(msg_it->stack)); |
| 2330 | BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(msg_it->stack)->base) == |
| 2331 | fc->ir_fc); |
| 2332 | |
| 2333 | /* |
| 2334 | * Reset BFCR "unsigned int" callback if it's a text |
| 2335 | * array/sequence. |
| 2336 | */ |
| 2337 | if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY || |
| 2338 | fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) { |
| 2339 | struct ctf_field_class_array_base *array_fc = (void *) fc; |
| 2340 | |
| 2341 | if (array_fc->is_text) { |
| 2342 | BT_ASSERT_DBG(bt_field_get_class_type( |
| 2343 | stack_top(msg_it->stack)->base) == |
| 2344 | BT_FIELD_CLASS_TYPE_STRING); |
| 2345 | bt_bfcr_set_unsigned_int_cb(msg_it->bfcr, |
| 2346 | bfcr_unsigned_int_cb); |
| 2347 | } |
| 2348 | } |
| 2349 | |
| 2350 | /* Pop stack */ |
| 2351 | stack_pop(msg_it->stack); |
| 2352 | |
| 2353 | /* If the stack is not empty, increment the base's index */ |
| 2354 | if (!stack_empty(msg_it->stack)) { |
| 2355 | stack_top(msg_it->stack)->index++; |
| 2356 | } |
| 2357 | |
| 2358 | end: |
| 2359 | return BT_BFCR_STATUS_OK; |
| 2360 | } |
| 2361 | |
| 2362 | static |
| 2363 | int64_t bfcr_get_sequence_length_cb(struct ctf_field_class *fc, void *data) |
| 2364 | { |
| 2365 | bt_field *seq_field; |
| 2366 | struct ctf_msg_iter *msg_it = data; |
| 2367 | bt_self_component *self_comp = msg_it->self_comp; |
| 2368 | struct ctf_field_class_sequence *seq_fc = (void *) fc; |
| 2369 | int64_t length; |
| 2370 | int ret; |
| 2371 | |
| 2372 | length = (uint64_t) g_array_index(msg_it->stored_values, uint64_t, |
| 2373 | seq_fc->stored_length_index); |
| 2374 | |
| 2375 | if (G_UNLIKELY(msg_it->dry_run)){ |
| 2376 | goto end; |
| 2377 | } |
| 2378 | |
| 2379 | seq_field = stack_top(msg_it->stack)->base; |
| 2380 | BT_ASSERT_DBG(seq_field); |
| 2381 | |
| 2382 | /* |
| 2383 | * bfcr_get_sequence_length_cb() also gets called back for a |
| 2384 | * text sequence, but the destination field is a string field. |
| 2385 | * Only set the field's sequence length if the destination field |
| 2386 | * is a sequence field. |
| 2387 | */ |
| 2388 | if (!seq_fc->base.is_text) { |
| 2389 | BT_ASSERT_DBG(bt_field_class_type_is( |
| 2390 | bt_field_get_class_type(seq_field), |
| 2391 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)); |
| 2392 | ret = bt_field_array_dynamic_set_length(seq_field, |
| 2393 | (uint64_t) length); |
| 2394 | if (ret) { |
| 2395 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2396 | "Cannot set dynamic array field's length field: " |
| 2397 | "msg-it-addr=%p, field-addr=%p, " |
| 2398 | "length=%" PRIu64, msg_it, seq_field, length); |
| 2399 | length = -1; |
| 2400 | } |
| 2401 | } |
| 2402 | |
| 2403 | end: |
| 2404 | return length; |
| 2405 | } |
| 2406 | |
| 2407 | static |
| 2408 | struct ctf_field_class *bfcr_borrow_variant_selected_field_class_cb( |
| 2409 | struct ctf_field_class *fc, void *data) |
| 2410 | { |
| 2411 | int ret; |
| 2412 | uint64_t i; |
| 2413 | int64_t option_index = -1; |
| 2414 | struct ctf_msg_iter *msg_it = data; |
| 2415 | struct ctf_field_class_variant *var_fc = (void *) fc; |
| 2416 | struct ctf_named_field_class *selected_option = NULL; |
| 2417 | bt_self_component *self_comp = msg_it->self_comp; |
| 2418 | struct ctf_field_class *ret_fc = NULL; |
| 2419 | union { |
| 2420 | uint64_t u; |
| 2421 | int64_t i; |
| 2422 | } tag; |
| 2423 | |
| 2424 | /* Get variant's tag */ |
| 2425 | tag.u = g_array_index(msg_it->stored_values, uint64_t, |
| 2426 | var_fc->stored_tag_index); |
| 2427 | |
| 2428 | /* |
| 2429 | * Check each range to find the selected option's index. |
| 2430 | */ |
| 2431 | if (var_fc->tag_fc->base.is_signed) { |
| 2432 | for (i = 0; i < var_fc->ranges->len; i++) { |
| 2433 | struct ctf_field_class_variant_range *range = |
| 2434 | ctf_field_class_variant_borrow_range_by_index( |
| 2435 | var_fc, i); |
| 2436 | |
| 2437 | if (tag.i >= range->range.lower.i && |
| 2438 | tag.i <= range->range.upper.i) { |
| 2439 | option_index = (int64_t) range->option_index; |
| 2440 | break; |
| 2441 | } |
| 2442 | } |
| 2443 | } else { |
| 2444 | for (i = 0; i < var_fc->ranges->len; i++) { |
| 2445 | struct ctf_field_class_variant_range *range = |
| 2446 | ctf_field_class_variant_borrow_range_by_index( |
| 2447 | var_fc, i); |
| 2448 | |
| 2449 | if (tag.u >= range->range.lower.u && |
| 2450 | tag.u <= range->range.upper.u) { |
| 2451 | option_index = (int64_t) range->option_index; |
| 2452 | break; |
| 2453 | } |
| 2454 | } |
| 2455 | } |
| 2456 | |
| 2457 | if (option_index < 0) { |
| 2458 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2459 | "Cannot find variant field class's option: " |
| 2460 | "msg-it-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64 ", " |
| 2461 | "i-tag=%" PRId64, msg_it, var_fc, tag.u, tag.i); |
| 2462 | ret_fc = NULL; |
| 2463 | goto end; |
| 2464 | } |
| 2465 | |
| 2466 | selected_option = ctf_field_class_variant_borrow_option_by_index( |
| 2467 | var_fc, (uint64_t) option_index); |
| 2468 | |
| 2469 | if (selected_option->fc->in_ir && !msg_it->dry_run) { |
| 2470 | bt_field *var_field = stack_top(msg_it->stack)->base; |
| 2471 | |
| 2472 | ret = bt_field_variant_select_option_field_by_index( |
| 2473 | var_field, option_index); |
| 2474 | if (ret) { |
| 2475 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2476 | "Cannot select variant field's option field: " |
| 2477 | "msg-it-addr=%p, var-field-addr=%p, " |
| 2478 | "opt-index=%" PRId64, msg_it, var_field, |
| 2479 | option_index); |
| 2480 | ret_fc = NULL; |
| 2481 | goto end; |
| 2482 | } |
| 2483 | } |
| 2484 | |
| 2485 | ret_fc = selected_option->fc; |
| 2486 | |
| 2487 | end: |
| 2488 | return ret_fc; |
| 2489 | } |
| 2490 | |
| 2491 | static |
| 2492 | bt_message *create_msg_stream_beginning(struct ctf_msg_iter *msg_it) |
| 2493 | { |
| 2494 | bt_self_component *self_comp = msg_it->self_comp; |
| 2495 | bt_message *msg; |
| 2496 | |
| 2497 | BT_ASSERT(msg_it->stream); |
| 2498 | BT_ASSERT(msg_it->self_msg_iter); |
| 2499 | msg = bt_message_stream_beginning_create(msg_it->self_msg_iter, |
| 2500 | msg_it->stream); |
| 2501 | if (!msg) { |
| 2502 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2503 | "Cannot create stream beginning message: " |
| 2504 | "msg-it-addr=%p, stream-addr=%p", |
| 2505 | msg_it, msg_it->stream); |
| 2506 | } |
| 2507 | |
| 2508 | return msg; |
| 2509 | } |
| 2510 | |
| 2511 | static |
| 2512 | bt_message *create_msg_stream_end(struct ctf_msg_iter *msg_it) |
| 2513 | { |
| 2514 | bt_self_component *self_comp = msg_it->self_comp; |
| 2515 | bt_message *msg; |
| 2516 | |
| 2517 | if (!msg_it->stream) { |
| 2518 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2519 | "Cannot create stream end message because stream is NULL: " |
| 2520 | "msg-it-addr=%p", msg_it); |
| 2521 | msg = NULL; |
| 2522 | goto end; |
| 2523 | } |
| 2524 | |
| 2525 | BT_ASSERT(msg_it->self_msg_iter); |
| 2526 | msg = bt_message_stream_end_create(msg_it->self_msg_iter, |
| 2527 | msg_it->stream); |
| 2528 | if (!msg) { |
| 2529 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2530 | "Cannot create stream end message: " |
| 2531 | "msg-it-addr=%p, stream-addr=%p", |
| 2532 | msg_it, msg_it->stream); |
| 2533 | } |
| 2534 | |
| 2535 | end: |
| 2536 | return msg; |
| 2537 | } |
| 2538 | |
| 2539 | static |
| 2540 | bt_message *create_msg_packet_beginning(struct ctf_msg_iter *msg_it, |
| 2541 | bool use_default_cs) |
| 2542 | { |
| 2543 | bt_self_component *self_comp = msg_it->self_comp; |
| 2544 | int ret; |
| 2545 | bt_message *msg; |
| 2546 | const bt_stream_class *sc = msg_it->meta.sc->ir_sc; |
| 2547 | |
| 2548 | BT_ASSERT(msg_it->packet); |
| 2549 | BT_ASSERT(sc); |
| 2550 | |
| 2551 | if (msg_it->packet_context_field) { |
| 2552 | ret = bt_packet_move_context_field( |
| 2553 | msg_it->packet, msg_it->packet_context_field); |
| 2554 | if (ret) { |
| 2555 | msg = NULL; |
| 2556 | goto end; |
| 2557 | } |
| 2558 | |
| 2559 | msg_it->packet_context_field = NULL; |
| 2560 | |
| 2561 | /* |
| 2562 | * At this point msg_it->dscopes.stream_packet_context |
| 2563 | * has the same value as the packet context field within |
| 2564 | * msg_it->packet. |
| 2565 | */ |
| 2566 | BT_ASSERT(bt_packet_borrow_context_field( |
| 2567 | msg_it->packet) == |
| 2568 | msg_it->dscopes.stream_packet_context); |
| 2569 | } |
| 2570 | |
| 2571 | BT_ASSERT(msg_it->self_msg_iter); |
| 2572 | |
| 2573 | if (msg_it->meta.sc->packets_have_ts_begin) { |
| 2574 | BT_ASSERT(msg_it->snapshots.beginning_clock != UINT64_C(-1)); |
| 2575 | uint64_t raw_cs_value; |
| 2576 | |
| 2577 | /* |
| 2578 | * Either use the decoded packet `timestamp_begin` field or the |
| 2579 | * current stream's default clock_snapshot. |
| 2580 | */ |
| 2581 | if (use_default_cs) { |
| 2582 | raw_cs_value = msg_it->default_clock_snapshot; |
| 2583 | } else { |
| 2584 | raw_cs_value = msg_it->snapshots.beginning_clock; |
| 2585 | } |
| 2586 | |
| 2587 | msg = bt_message_packet_beginning_create_with_default_clock_snapshot( |
| 2588 | msg_it->self_msg_iter, msg_it->packet, |
| 2589 | raw_cs_value); |
| 2590 | } else { |
| 2591 | msg = bt_message_packet_beginning_create(msg_it->self_msg_iter, |
| 2592 | msg_it->packet); |
| 2593 | } |
| 2594 | |
| 2595 | if (!msg) { |
| 2596 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2597 | "Cannot create packet beginning message: " |
| 2598 | "msg-it-addr=%p, packet-addr=%p", |
| 2599 | msg_it, msg_it->packet); |
| 2600 | goto end; |
| 2601 | } |
| 2602 | |
| 2603 | end: |
| 2604 | return msg; |
| 2605 | } |
| 2606 | |
| 2607 | static |
| 2608 | bt_message *emit_delayed_packet_beg_msg(struct ctf_msg_iter *msg_it) |
| 2609 | { |
| 2610 | bool packet_beg_ts_need_fix_up; |
| 2611 | |
| 2612 | msg_it->emit_delayed_packet_beginning_msg = false; |
| 2613 | |
| 2614 | /* |
| 2615 | * Only fix the packet's timestamp_begin if it's larger than the first |
| 2616 | * event of the packet. If there was no event in the packet, the |
| 2617 | * `default_clock_snapshot` field will be either equal or greater than |
| 2618 | * `snapshots.beginning_clock` so there is not fix needed. |
| 2619 | */ |
| 2620 | packet_beg_ts_need_fix_up = |
| 2621 | msg_it->default_clock_snapshot < msg_it->snapshots.beginning_clock; |
| 2622 | |
| 2623 | /* create_msg_packet_beginning() logs errors */ |
| 2624 | return create_msg_packet_beginning(msg_it, packet_beg_ts_need_fix_up); |
| 2625 | } |
| 2626 | |
| 2627 | |
| 2628 | static |
| 2629 | bt_message *create_msg_packet_end(struct ctf_msg_iter *msg_it) |
| 2630 | { |
| 2631 | bt_message *msg; |
| 2632 | bool update_default_cs = true; |
| 2633 | bt_self_component *self_comp = msg_it->self_comp; |
| 2634 | |
| 2635 | if (!msg_it->packet) { |
| 2636 | msg = NULL; |
| 2637 | goto end; |
| 2638 | } |
| 2639 | |
| 2640 | /* |
| 2641 | * Check if we need to emit the delayed packet |
| 2642 | * beginning message instead of the packet end message. |
| 2643 | */ |
| 2644 | if (G_UNLIKELY(msg_it->emit_delayed_packet_beginning_msg)) { |
| 2645 | msg = emit_delayed_packet_beg_msg(msg_it); |
| 2646 | /* Don't forget to emit the packet end message. */ |
| 2647 | msg_it->state = STATE_EMIT_QUEUED_MSG_PACKET_END; |
| 2648 | goto end; |
| 2649 | } |
| 2650 | |
| 2651 | /* Check if may be affected by lttng-crash timestamp_end quirk. */ |
| 2652 | if (G_UNLIKELY(msg_it->meta.tc->quirks.lttng_crash)) { |
| 2653 | /* |
| 2654 | * Check if the `timestamp_begin` field is non-zero but |
| 2655 | * `timestamp_end` is zero. It means the trace is affected by |
| 2656 | * the lttng-crash packet `timestamp_end` quirk and must be |
| 2657 | * fixed up by omitting to update the default clock snapshot to |
| 2658 | * the `timestamp_end` as is typically done. |
| 2659 | */ |
| 2660 | if (msg_it->snapshots.beginning_clock != 0 && |
| 2661 | msg_it->snapshots.end_clock == 0) { |
| 2662 | update_default_cs = false; |
| 2663 | } |
| 2664 | } |
| 2665 | |
| 2666 | /* |
| 2667 | * Check if may be affected by lttng event-after-packet `timestamp_end` |
| 2668 | * quirk. |
| 2669 | */ |
| 2670 | if (msg_it->meta.tc->quirks.lttng_event_after_packet) { |
| 2671 | /* |
| 2672 | * Check if `timestamp_end` is smaller then the current |
| 2673 | * default_clock_snapshot (which is set to the last event |
| 2674 | * decoded). It means the trace is affected by the lttng |
| 2675 | * `event-after-packet` packet `timestamp_end` quirk and must |
| 2676 | * be fixed up by omitting to update the default clock snapshot |
| 2677 | * to the `timestamp_end` as is typically done. |
| 2678 | */ |
| 2679 | if (msg_it->snapshots.end_clock < msg_it->default_clock_snapshot) { |
| 2680 | update_default_cs = false; |
| 2681 | } |
| 2682 | } |
| 2683 | |
| 2684 | /* Update default clock from packet's end time. */ |
| 2685 | if (msg_it->snapshots.end_clock != UINT64_C(-1) && update_default_cs) { |
| 2686 | msg_it->default_clock_snapshot = msg_it->snapshots.end_clock; |
| 2687 | } |
| 2688 | |
| 2689 | BT_ASSERT(msg_it->self_msg_iter); |
| 2690 | |
| 2691 | if (msg_it->meta.sc->packets_have_ts_end) { |
| 2692 | BT_ASSERT(msg_it->snapshots.end_clock != UINT64_C(-1)); |
| 2693 | msg = bt_message_packet_end_create_with_default_clock_snapshot( |
| 2694 | msg_it->self_msg_iter, msg_it->packet, |
| 2695 | msg_it->default_clock_snapshot); |
| 2696 | } else { |
| 2697 | msg = bt_message_packet_end_create(msg_it->self_msg_iter, |
| 2698 | msg_it->packet); |
| 2699 | } |
| 2700 | |
| 2701 | if (!msg) { |
| 2702 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2703 | "Cannot create packet end message: " |
| 2704 | "msg-it-addr=%p, packet-addr=%p", |
| 2705 | msg_it, msg_it->packet); |
| 2706 | goto end; |
| 2707 | |
| 2708 | } |
| 2709 | |
| 2710 | BT_PACKET_PUT_REF_AND_RESET(msg_it->packet); |
| 2711 | |
| 2712 | end: |
| 2713 | return msg; |
| 2714 | } |
| 2715 | |
| 2716 | static |
| 2717 | bt_message *create_msg_discarded_events(struct ctf_msg_iter *msg_it) |
| 2718 | { |
| 2719 | bt_message *msg; |
| 2720 | bt_self_component *self_comp = msg_it->self_comp; |
| 2721 | uint64_t beginning_raw_value = UINT64_C(-1); |
| 2722 | uint64_t end_raw_value = UINT64_C(-1); |
| 2723 | |
| 2724 | BT_ASSERT(msg_it->self_msg_iter); |
| 2725 | BT_ASSERT(msg_it->stream); |
| 2726 | BT_ASSERT(msg_it->meta.sc->has_discarded_events); |
| 2727 | |
| 2728 | if (msg_it->meta.sc->discarded_events_have_default_cs) { |
| 2729 | if (msg_it->prev_packet_snapshots.discarded_events == UINT64_C(-1)) { |
| 2730 | /* |
| 2731 | * We discarded events, but before (and possibly |
| 2732 | * including) the current packet: use this packet's time |
| 2733 | * range, and do not have a specific count. |
| 2734 | */ |
| 2735 | beginning_raw_value = msg_it->snapshots.beginning_clock; |
| 2736 | end_raw_value = msg_it->snapshots.end_clock; |
| 2737 | } else { |
| 2738 | beginning_raw_value = msg_it->prev_packet_snapshots.end_clock; |
| 2739 | end_raw_value = msg_it->snapshots.end_clock; |
| 2740 | } |
| 2741 | |
| 2742 | BT_ASSERT(beginning_raw_value != UINT64_C(-1)); |
| 2743 | BT_ASSERT(end_raw_value != UINT64_C(-1)); |
| 2744 | msg = bt_message_discarded_events_create_with_default_clock_snapshots( |
| 2745 | msg_it->self_msg_iter, msg_it->stream, beginning_raw_value, |
| 2746 | end_raw_value); |
| 2747 | } else { |
| 2748 | msg = bt_message_discarded_events_create(msg_it->self_msg_iter, |
| 2749 | msg_it->stream); |
| 2750 | } |
| 2751 | |
| 2752 | if (!msg) { |
| 2753 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2754 | "Cannot create discarded events message: " |
| 2755 | "msg-it-addr=%p, stream-addr=%p", |
| 2756 | msg_it, msg_it->stream); |
| 2757 | goto end; |
| 2758 | } |
| 2759 | |
| 2760 | if (msg_it->prev_packet_snapshots.discarded_events != UINT64_C(-1)) { |
| 2761 | bt_message_discarded_events_set_count(msg, |
| 2762 | msg_it->snapshots.discarded_events - |
| 2763 | msg_it->prev_packet_snapshots.discarded_events); |
| 2764 | } |
| 2765 | |
| 2766 | end: |
| 2767 | return msg; |
| 2768 | } |
| 2769 | |
| 2770 | static |
| 2771 | bt_message *create_msg_discarded_packets(struct ctf_msg_iter *msg_it) |
| 2772 | { |
| 2773 | bt_message *msg; |
| 2774 | bt_self_component *self_comp = msg_it->self_comp; |
| 2775 | |
| 2776 | BT_ASSERT(msg_it->self_msg_iter); |
| 2777 | BT_ASSERT(msg_it->stream); |
| 2778 | BT_ASSERT(msg_it->meta.sc->has_discarded_packets); |
| 2779 | BT_ASSERT(msg_it->prev_packet_snapshots.packets != |
| 2780 | UINT64_C(-1)); |
| 2781 | |
| 2782 | if (msg_it->meta.sc->discarded_packets_have_default_cs) { |
| 2783 | BT_ASSERT(msg_it->prev_packet_snapshots.end_clock != UINT64_C(-1)); |
| 2784 | BT_ASSERT(msg_it->snapshots.beginning_clock != UINT64_C(-1)); |
| 2785 | msg = bt_message_discarded_packets_create_with_default_clock_snapshots( |
| 2786 | msg_it->self_msg_iter, msg_it->stream, |
| 2787 | msg_it->prev_packet_snapshots.end_clock, |
| 2788 | msg_it->snapshots.beginning_clock); |
| 2789 | } else { |
| 2790 | msg = bt_message_discarded_packets_create(msg_it->self_msg_iter, |
| 2791 | msg_it->stream); |
| 2792 | } |
| 2793 | |
| 2794 | if (!msg) { |
| 2795 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2796 | "Cannot create discarded packets message: " |
| 2797 | "msg-it-addr=%p, stream-addr=%p", |
| 2798 | msg_it, msg_it->stream); |
| 2799 | goto end; |
| 2800 | } |
| 2801 | |
| 2802 | bt_message_discarded_packets_set_count(msg, |
| 2803 | msg_it->snapshots.packets - |
| 2804 | msg_it->prev_packet_snapshots.packets - 1); |
| 2805 | |
| 2806 | end: |
| 2807 | return msg; |
| 2808 | } |
| 2809 | |
| 2810 | BT_HIDDEN |
| 2811 | struct ctf_msg_iter *ctf_msg_iter_create( |
| 2812 | struct ctf_trace_class *tc, |
| 2813 | size_t max_request_sz, |
| 2814 | struct ctf_msg_iter_medium_ops medops, void *data, |
| 2815 | bt_logging_level log_level, |
| 2816 | bt_self_component *self_comp, |
| 2817 | bt_self_message_iterator *self_msg_iter) |
| 2818 | { |
| 2819 | struct ctf_msg_iter *msg_it = NULL; |
| 2820 | struct bt_bfcr_cbs cbs = { |
| 2821 | .classes = { |
| 2822 | .signed_int = bfcr_signed_int_cb, |
| 2823 | .unsigned_int = bfcr_unsigned_int_cb, |
| 2824 | .floating_point = bfcr_floating_point_cb, |
| 2825 | .string_begin = bfcr_string_begin_cb, |
| 2826 | .string = bfcr_string_cb, |
| 2827 | .string_end = bfcr_string_end_cb, |
| 2828 | .compound_begin = bfcr_compound_begin_cb, |
| 2829 | .compound_end = bfcr_compound_end_cb, |
| 2830 | }, |
| 2831 | .query = { |
| 2832 | .get_sequence_length = bfcr_get_sequence_length_cb, |
| 2833 | .borrow_variant_selected_field_class = bfcr_borrow_variant_selected_field_class_cb, |
| 2834 | }, |
| 2835 | }; |
| 2836 | |
| 2837 | BT_ASSERT(tc); |
| 2838 | BT_ASSERT(medops.request_bytes); |
| 2839 | BT_ASSERT(medops.borrow_stream); |
| 2840 | BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, log_level, self_comp, |
| 2841 | "Creating CTF plugin message iterator: " |
| 2842 | "trace-addr=%p, max-request-size=%zu, " |
| 2843 | "data=%p, log-level=%s", tc, max_request_sz, data, |
| 2844 | bt_common_logging_level_string(log_level)); |
| 2845 | msg_it = g_new0(struct ctf_msg_iter, 1); |
| 2846 | if (!msg_it) { |
| 2847 | BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp, |
| 2848 | "Failed to allocate one CTF plugin message iterator."); |
| 2849 | goto end; |
| 2850 | } |
| 2851 | msg_it->self_comp = self_comp; |
| 2852 | msg_it->self_msg_iter = self_msg_iter; |
| 2853 | msg_it->log_level = log_level; |
| 2854 | msg_it->meta.tc = tc; |
| 2855 | msg_it->medium.medops = medops; |
| 2856 | msg_it->medium.max_request_sz = max_request_sz; |
| 2857 | msg_it->medium.data = data; |
| 2858 | msg_it->stack = stack_new(msg_it); |
| 2859 | msg_it->stored_values = g_array_new(FALSE, TRUE, sizeof(uint64_t)); |
| 2860 | g_array_set_size(msg_it->stored_values, tc->stored_value_count); |
| 2861 | |
| 2862 | if (!msg_it->stack) { |
| 2863 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2864 | "Failed to create field stack."); |
| 2865 | goto error; |
| 2866 | } |
| 2867 | |
| 2868 | msg_it->bfcr = bt_bfcr_create(cbs, msg_it, log_level, NULL); |
| 2869 | if (!msg_it->bfcr) { |
| 2870 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2871 | "Failed to create binary class reader (BFCR)."); |
| 2872 | goto error; |
| 2873 | } |
| 2874 | |
| 2875 | ctf_msg_iter_reset(msg_it); |
| 2876 | BT_COMP_LOGD("Created CTF plugin message iterator: " |
| 2877 | "trace-addr=%p, max-request-size=%zu, " |
| 2878 | "data=%p, msg-it-addr=%p, log-level=%s", |
| 2879 | tc, max_request_sz, data, msg_it, |
| 2880 | bt_common_logging_level_string(log_level)); |
| 2881 | msg_it->cur_packet_offset = 0; |
| 2882 | |
| 2883 | end: |
| 2884 | return msg_it; |
| 2885 | |
| 2886 | error: |
| 2887 | ctf_msg_iter_destroy(msg_it); |
| 2888 | msg_it = NULL; |
| 2889 | goto end; |
| 2890 | } |
| 2891 | |
| 2892 | void ctf_msg_iter_destroy(struct ctf_msg_iter *msg_it) |
| 2893 | { |
| 2894 | BT_PACKET_PUT_REF_AND_RESET(msg_it->packet); |
| 2895 | BT_STREAM_PUT_REF_AND_RESET(msg_it->stream); |
| 2896 | release_all_dscopes(msg_it); |
| 2897 | |
| 2898 | BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it); |
| 2899 | |
| 2900 | if (msg_it->stack) { |
| 2901 | BT_COMP_LOGD_STR("Destroying field stack."); |
| 2902 | stack_destroy(msg_it->stack); |
| 2903 | } |
| 2904 | |
| 2905 | if (msg_it->bfcr) { |
| 2906 | BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it->bfcr); |
| 2907 | bt_bfcr_destroy(msg_it->bfcr); |
| 2908 | } |
| 2909 | |
| 2910 | if (msg_it->stored_values) { |
| 2911 | g_array_free(msg_it->stored_values, TRUE); |
| 2912 | } |
| 2913 | |
| 2914 | g_free(msg_it); |
| 2915 | } |
| 2916 | |
| 2917 | enum ctf_msg_iter_status ctf_msg_iter_get_next_message( |
| 2918 | struct ctf_msg_iter *msg_it, |
| 2919 | bt_message **message) |
| 2920 | { |
| 2921 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 2922 | bt_self_component *self_comp = msg_it->self_comp; |
| 2923 | |
| 2924 | BT_ASSERT_DBG(msg_it); |
| 2925 | BT_ASSERT_DBG(message); |
| 2926 | msg_it->set_stream = true; |
| 2927 | BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it); |
| 2928 | |
| 2929 | while (true) { |
| 2930 | status = handle_state(msg_it); |
| 2931 | if (G_UNLIKELY(status == CTF_MSG_ITER_STATUS_AGAIN)) { |
| 2932 | BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN."); |
| 2933 | goto end; |
| 2934 | } else if (G_UNLIKELY(status != CTF_MSG_ITER_STATUS_OK)) { |
| 2935 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 2936 | "Cannot handle state: msg-it-addr=%p, state=%s", |
| 2937 | msg_it, state_string(msg_it->state)); |
| 2938 | goto end; |
| 2939 | } |
| 2940 | |
| 2941 | switch (msg_it->state) { |
| 2942 | case STATE_EMIT_MSG_EVENT: |
| 2943 | BT_ASSERT_DBG(msg_it->event_msg); |
| 2944 | |
| 2945 | /* |
| 2946 | * Check if we need to emit the delayed packet |
| 2947 | * beginning message instead of the event message. |
| 2948 | */ |
| 2949 | if (G_UNLIKELY(msg_it->emit_delayed_packet_beginning_msg)) { |
| 2950 | *message = emit_delayed_packet_beg_msg(msg_it); |
| 2951 | if (!*message) { |
| 2952 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 2953 | } |
| 2954 | |
| 2955 | /* |
| 2956 | * Don't forget to emit the event message of |
| 2957 | * the event record that was just decoded. |
| 2958 | */ |
| 2959 | msg_it->state = STATE_EMIT_QUEUED_MSG_EVENT; |
| 2960 | |
| 2961 | } else { |
| 2962 | *message = msg_it->event_msg; |
| 2963 | msg_it->event_msg = NULL; |
| 2964 | } |
| 2965 | goto end; |
| 2966 | case STATE_EMIT_MSG_DISCARDED_EVENTS: |
| 2967 | /* create_msg_discared_events() logs errors */ |
| 2968 | *message = create_msg_discarded_events(msg_it); |
| 2969 | |
| 2970 | if (!*message) { |
| 2971 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 2972 | } |
| 2973 | |
| 2974 | goto end; |
| 2975 | case STATE_EMIT_MSG_DISCARDED_PACKETS: |
| 2976 | /* create_msg_discared_packets() logs errors */ |
| 2977 | *message = create_msg_discarded_packets(msg_it); |
| 2978 | |
| 2979 | if (!*message) { |
| 2980 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 2981 | } |
| 2982 | |
| 2983 | goto end; |
| 2984 | case STATE_EMIT_MSG_PACKET_BEGINNING: |
| 2985 | status = set_current_packet(msg_it); |
| 2986 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 2987 | goto end; |
| 2988 | } |
| 2989 | |
| 2990 | if (G_UNLIKELY(msg_it->meta.tc->quirks.barectf_event_before_packet)) { |
| 2991 | msg_it->emit_delayed_packet_beginning_msg = true; |
| 2992 | /* |
| 2993 | * There is no message to return yet as this |
| 2994 | * packet beginning message is delayed until we |
| 2995 | * decode the first event message of the |
| 2996 | * packet. |
| 2997 | */ |
| 2998 | break; |
| 2999 | } else { |
| 3000 | /* create_msg_packet_beginning() logs errors */ |
| 3001 | *message = create_msg_packet_beginning(msg_it, false); |
| 3002 | if (!*message) { |
| 3003 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3004 | } |
| 3005 | } |
| 3006 | |
| 3007 | goto end; |
| 3008 | case STATE_EMIT_MSG_PACKET_END_SINGLE: |
| 3009 | case STATE_EMIT_MSG_PACKET_END_MULTI: |
| 3010 | /* create_msg_packet_end() logs errors */ |
| 3011 | *message = create_msg_packet_end(msg_it); |
| 3012 | |
| 3013 | if (!*message) { |
| 3014 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3015 | } |
| 3016 | |
| 3017 | goto end; |
| 3018 | case STATE_EMIT_MSG_STREAM_BEGINNING: |
| 3019 | /* create_msg_stream_beginning() logs errors */ |
| 3020 | *message = create_msg_stream_beginning(msg_it); |
| 3021 | |
| 3022 | if (!*message) { |
| 3023 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3024 | } |
| 3025 | |
| 3026 | goto end; |
| 3027 | case STATE_EMIT_MSG_STREAM_END: |
| 3028 | /* create_msg_stream_end() logs errors */ |
| 3029 | *message = create_msg_stream_end(msg_it); |
| 3030 | |
| 3031 | if (!*message) { |
| 3032 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3033 | } |
| 3034 | |
| 3035 | goto end; |
| 3036 | case STATE_DONE: |
| 3037 | status = CTF_MSG_ITER_STATUS_EOF; |
| 3038 | goto end; |
| 3039 | default: |
| 3040 | /* Non-emitting state: continue */ |
| 3041 | break; |
| 3042 | } |
| 3043 | } |
| 3044 | |
| 3045 | end: |
| 3046 | return status; |
| 3047 | } |
| 3048 | |
| 3049 | static |
| 3050 | enum ctf_msg_iter_status decode_until_state( struct ctf_msg_iter *msg_it, |
| 3051 | enum state target_state_1, enum state target_state_2) |
| 3052 | { |
| 3053 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 3054 | bt_self_component *self_comp = msg_it->self_comp; |
| 3055 | |
| 3056 | BT_ASSERT_DBG(msg_it); |
| 3057 | msg_it->set_stream = false; |
| 3058 | |
| 3059 | do { |
| 3060 | /* |
| 3061 | * Check if we reached the state at which we want to stop |
| 3062 | * decoding. |
| 3063 | */ |
| 3064 | if (msg_it->state == target_state_1 || |
| 3065 | msg_it->state == target_state_2) { |
| 3066 | goto end; |
| 3067 | } |
| 3068 | |
| 3069 | status = handle_state(msg_it); |
| 3070 | if (G_UNLIKELY(status == CTF_MSG_ITER_STATUS_AGAIN)) { |
| 3071 | BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN."); |
| 3072 | goto end; |
| 3073 | } else if (G_UNLIKELY(status != CTF_MSG_ITER_STATUS_OK)) { |
| 3074 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 3075 | "Cannot handle state: msg-it-addr=%p, state=%s", |
| 3076 | msg_it, state_string(msg_it->state)); |
| 3077 | goto end; |
| 3078 | } |
| 3079 | |
| 3080 | switch (msg_it->state) { |
| 3081 | case STATE_INIT: |
| 3082 | case STATE_SWITCH_PACKET: |
| 3083 | case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN: |
| 3084 | case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE: |
| 3085 | case STATE_AFTER_TRACE_PACKET_HEADER: |
| 3086 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN: |
| 3087 | case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE: |
| 3088 | case STATE_AFTER_STREAM_PACKET_CONTEXT: |
| 3089 | case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING: |
| 3090 | case STATE_EMIT_MSG_STREAM_BEGINNING: |
| 3091 | case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS: |
| 3092 | case STATE_EMIT_MSG_DISCARDED_EVENTS: |
| 3093 | case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS: |
| 3094 | case STATE_EMIT_MSG_DISCARDED_PACKETS: |
| 3095 | case STATE_EMIT_MSG_PACKET_BEGINNING: |
| 3096 | case STATE_DSCOPE_EVENT_HEADER_BEGIN: |
| 3097 | case STATE_DSCOPE_EVENT_HEADER_CONTINUE: |
| 3098 | case STATE_AFTER_EVENT_HEADER: |
| 3099 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN: |
| 3100 | case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE: |
| 3101 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN: |
| 3102 | case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE: |
| 3103 | case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN: |
| 3104 | case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE: |
| 3105 | case STATE_EMIT_MSG_EVENT: |
| 3106 | case STATE_EMIT_QUEUED_MSG_EVENT: |
| 3107 | case STATE_SKIP_PACKET_PADDING: |
| 3108 | case STATE_EMIT_MSG_PACKET_END_MULTI: |
| 3109 | case STATE_EMIT_MSG_PACKET_END_SINGLE: |
| 3110 | case STATE_EMIT_QUEUED_MSG_PACKET_END: |
| 3111 | case STATE_CHECK_EMIT_MSG_STREAM_END: |
| 3112 | case STATE_EMIT_MSG_STREAM_END: |
| 3113 | break; |
| 3114 | case STATE_DONE: |
| 3115 | /* fall-through */ |
| 3116 | default: |
| 3117 | /* We should never get to the STATE_DONE state. */ |
| 3118 | BT_COMP_LOGF("Unexpected state: msg-it-addr=%p, state=%s", |
| 3119 | msg_it, state_string(msg_it->state)); |
| 3120 | bt_common_abort(); |
| 3121 | } |
| 3122 | } while (true); |
| 3123 | |
| 3124 | end: |
| 3125 | return status; |
| 3126 | } |
| 3127 | |
| 3128 | static |
| 3129 | enum ctf_msg_iter_status read_packet_header_context_fields( |
| 3130 | struct ctf_msg_iter *msg_it) |
| 3131 | { |
| 3132 | int ret; |
| 3133 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 3134 | |
| 3135 | status = decode_until_state(msg_it, STATE_EMIT_MSG_PACKET_BEGINNING, -1); |
| 3136 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 3137 | goto end; |
| 3138 | } |
| 3139 | |
| 3140 | ret = set_current_packet_content_sizes(msg_it); |
| 3141 | if (ret) { |
| 3142 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3143 | goto end; |
| 3144 | } |
| 3145 | |
| 3146 | end: |
| 3147 | return status; |
| 3148 | } |
| 3149 | |
| 3150 | BT_HIDDEN |
| 3151 | void ctf_msg_iter_set_medops_data(struct ctf_msg_iter *msg_it, |
| 3152 | void *medops_data) |
| 3153 | { |
| 3154 | BT_ASSERT(msg_it); |
| 3155 | msg_it->medium.data = medops_data; |
| 3156 | } |
| 3157 | |
| 3158 | BT_HIDDEN |
| 3159 | enum ctf_msg_iter_status ctf_msg_iter_seek(struct ctf_msg_iter *msg_it, |
| 3160 | off_t offset) |
| 3161 | { |
| 3162 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 3163 | bt_self_component *self_comp = msg_it->self_comp; |
| 3164 | enum ctf_msg_iter_medium_status medium_status; |
| 3165 | |
| 3166 | BT_ASSERT(msg_it); |
| 3167 | if (offset < 0) { |
| 3168 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 3169 | "Cannot seek to negative offset: offset=%jd", |
| 3170 | (intmax_t) offset); |
| 3171 | status = CTF_MSG_ITER_STATUS_INVAL; |
| 3172 | goto end; |
| 3173 | } |
| 3174 | |
| 3175 | if (!msg_it->medium.medops.seek) { |
| 3176 | status = CTF_MSG_ITER_STATUS_UNSUPPORTED; |
| 3177 | BT_COMP_LOGD("Aborting seek as the iterator's underlying media does not implement seek support."); |
| 3178 | goto end; |
| 3179 | } |
| 3180 | |
| 3181 | medium_status = msg_it->medium.medops.seek( |
| 3182 | CTF_MSG_ITER_SEEK_WHENCE_SET, offset, msg_it->medium.data); |
| 3183 | if (medium_status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { |
| 3184 | if (medium_status == CTF_MSG_ITER_MEDIUM_STATUS_EOF) { |
| 3185 | status = CTF_MSG_ITER_STATUS_EOF; |
| 3186 | } else { |
| 3187 | status = CTF_MSG_ITER_STATUS_ERROR; |
| 3188 | goto end; |
| 3189 | } |
| 3190 | } |
| 3191 | |
| 3192 | ctf_msg_iter_reset(msg_it); |
| 3193 | msg_it->cur_packet_offset = offset; |
| 3194 | |
| 3195 | end: |
| 3196 | return status; |
| 3197 | } |
| 3198 | |
| 3199 | static |
| 3200 | enum ctf_msg_iter_status clock_snapshot_at_msg_iter_state( |
| 3201 | struct ctf_msg_iter *msg_it, enum state target_state_1, |
| 3202 | enum state target_state_2, uint64_t *clock_snapshot) |
| 3203 | { |
| 3204 | enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK; |
| 3205 | |
| 3206 | BT_ASSERT_DBG(msg_it); |
| 3207 | BT_ASSERT_DBG(clock_snapshot); |
| 3208 | status = decode_until_state(msg_it, target_state_1, target_state_2); |
| 3209 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 3210 | goto end; |
| 3211 | } |
| 3212 | |
| 3213 | *clock_snapshot = msg_it->default_clock_snapshot; |
| 3214 | end: |
| 3215 | return status; |
| 3216 | } |
| 3217 | |
| 3218 | BT_HIDDEN |
| 3219 | enum ctf_msg_iter_status ctf_msg_iter_curr_packet_first_event_clock_snapshot( |
| 3220 | struct ctf_msg_iter *msg_it, uint64_t *first_clock_snapshot) |
| 3221 | { |
| 3222 | return clock_snapshot_at_msg_iter_state(msg_it, |
| 3223 | STATE_AFTER_EVENT_HEADER, -1, first_clock_snapshot); |
| 3224 | } |
| 3225 | |
| 3226 | BT_HIDDEN |
| 3227 | enum ctf_msg_iter_status ctf_msg_iter_curr_packet_last_event_clock_snapshot( |
| 3228 | struct ctf_msg_iter *msg_it, uint64_t *last_clock_snapshot) |
| 3229 | { |
| 3230 | return clock_snapshot_at_msg_iter_state(msg_it, |
| 3231 | STATE_EMIT_MSG_PACKET_END_SINGLE, |
| 3232 | STATE_EMIT_MSG_PACKET_END_MULTI, last_clock_snapshot); |
| 3233 | } |
| 3234 | |
| 3235 | BT_HIDDEN |
| 3236 | enum ctf_msg_iter_status ctf_msg_iter_get_packet_properties( |
| 3237 | struct ctf_msg_iter *msg_it, |
| 3238 | struct ctf_msg_iter_packet_properties *props) |
| 3239 | { |
| 3240 | enum ctf_msg_iter_status status; |
| 3241 | |
| 3242 | BT_ASSERT_DBG(msg_it); |
| 3243 | BT_ASSERT_DBG(props); |
| 3244 | status = read_packet_header_context_fields(msg_it); |
| 3245 | if (status != CTF_MSG_ITER_STATUS_OK) { |
| 3246 | goto end; |
| 3247 | } |
| 3248 | |
| 3249 | props->exp_packet_total_size = msg_it->cur_exp_packet_total_size; |
| 3250 | props->exp_packet_content_size = msg_it->cur_exp_packet_content_size; |
| 3251 | props->stream_class_id = (uint64_t) msg_it->cur_stream_class_id; |
| 3252 | props->data_stream_id = msg_it->cur_data_stream_id; |
| 3253 | props->snapshots.discarded_events = msg_it->snapshots.discarded_events; |
| 3254 | props->snapshots.packets = msg_it->snapshots.packets; |
| 3255 | props->snapshots.beginning_clock = msg_it->snapshots.beginning_clock; |
| 3256 | props->snapshots.end_clock = msg_it->snapshots.end_clock; |
| 3257 | |
| 3258 | end: |
| 3259 | return status; |
| 3260 | } |
| 3261 | |
| 3262 | BT_HIDDEN |
| 3263 | void ctf_msg_iter_set_emit_stream_beginning_message(struct ctf_msg_iter *msg_it, |
| 3264 | bool val) |
| 3265 | { |
| 3266 | msg_it->emit_stream_begin_msg = val; |
| 3267 | } |
| 3268 | |
| 3269 | BT_HIDDEN |
| 3270 | void ctf_msg_iter_set_emit_stream_end_message(struct ctf_msg_iter *msg_it, |
| 3271 | bool val) |
| 3272 | { |
| 3273 | msg_it->emit_stream_end_msg = val; |
| 3274 | } |
| 3275 | |
| 3276 | BT_HIDDEN |
| 3277 | void ctf_msg_iter_set_dry_run(struct ctf_msg_iter *msg_it, |
| 3278 | bool val) |
| 3279 | { |
| 3280 | msg_it->dry_run = val; |
| 3281 | } |