projects / babeltrace.git / blob
? search:


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