projects / babeltrace.git / blob
? search:


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