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