projects / babeltrace.git / blob
? search:


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