projects / babeltrace.git / blob
? search:


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