projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix: ctf: verify that field class is int before calling ctf_field_class_as_int
[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 = &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 &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 BT_HIDDEN
1676 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter *msg_it)
1677 {
1678 BT_ASSERT(msg_it);
1679 BT_COMP_LOGD("Resetting message iterator: addr=%p", msg_it);
1680 stack_clear(msg_it->stack);
1681 msg_it->meta.sc = NULL;
1682 msg_it->meta.ec = NULL;
1683 BT_PACKET_PUT_REF_AND_RESET(msg_it->packet);
1684 BT_STREAM_PUT_REF_AND_RESET(msg_it->stream);
1685 BT_MESSAGE_PUT_REF_AND_RESET(msg_it->event_msg);
1686 release_all_dscopes(msg_it);
1687 msg_it->cur_dscope_field = NULL;
1688
1689 msg_it->buf.addr = NULL;
1690 msg_it->buf.sz = 0;
1691 msg_it->buf.at = 0;
1692 msg_it->buf.last_eh_at = SIZE_MAX;
1693 msg_it->buf.packet_offset = 0;
1694 msg_it->state = STATE_INIT;
1695 msg_it->cur_exp_packet_content_size = -1;
1696 msg_it->cur_exp_packet_total_size = -1;
1697 msg_it->cur_packet_offset = -1;
1698 msg_it->cur_event_class_id = -1;
1699 msg_it->snapshots.beginning_clock = UINT64_C(-1);
1700 msg_it->snapshots.end_clock = UINT64_C(-1);
1701 }
1702
1703 /**
1704 * Resets the internal state of a CTF message iterator.
1705 */
1706 BT_HIDDEN
1707 void ctf_msg_iter_reset(struct ctf_msg_iter *msg_it)
1708 {
1709 ctf_msg_iter_reset_for_next_stream_file(msg_it);
1710 msg_it->cur_stream_class_id = -1;
1711 msg_it->cur_data_stream_id = -1;
1712 msg_it->snapshots.discarded_events = UINT64_C(-1);
1713 msg_it->snapshots.packets = UINT64_C(-1);
1714 msg_it->prev_packet_snapshots.discarded_events = UINT64_C(-1);
1715 msg_it->prev_packet_snapshots.packets = UINT64_C(-1);
1716 msg_it->prev_packet_snapshots.beginning_clock = UINT64_C(-1);
1717 msg_it->prev_packet_snapshots.end_clock = UINT64_C(-1);
1718 msg_it->emit_stream_beginning_message = true;
1719 msg_it->emit_stream_end_message = false;
1720 }
1721
1722 static bt_field *borrow_next_field(struct ctf_msg_iter *msg_it)
1723 {
1724 bt_field *next_field = NULL;
1725 bt_field *base_field;
1726 const bt_field_class *base_fc;
1727 bt_field_class_type base_fc_type;
1728 size_t index;
1729
1730 BT_ASSERT_DBG(!stack_empty(msg_it->stack));
1731 index = stack_top(msg_it->stack)->index;
1732 base_field = stack_top(msg_it->stack)->base;
1733 BT_ASSERT_DBG(base_field);
1734 base_fc = bt_field_borrow_class_const(base_field);
1735 BT_ASSERT_DBG(base_fc);
1736 base_fc_type = bt_field_class_get_type(base_fc);
1737
1738 if (base_fc_type == BT_FIELD_CLASS_TYPE_STRUCTURE) {
1739 BT_ASSERT_DBG(index < bt_field_class_structure_get_member_count(
1740 bt_field_borrow_class_const(base_field)));
1741 next_field = bt_field_structure_borrow_member_field_by_index(base_field, index);
1742 } else if (bt_field_class_type_is(base_fc_type, BT_FIELD_CLASS_TYPE_ARRAY)) {
1743 BT_ASSERT_DBG(index < bt_field_array_get_length(base_field));
1744 next_field = bt_field_array_borrow_element_field_by_index(base_field, index);
1745 } else if (bt_field_class_type_is(base_fc_type, BT_FIELD_CLASS_TYPE_VARIANT)) {
1746 BT_ASSERT_DBG(index == 0);
1747 next_field = bt_field_variant_borrow_selected_option_field(base_field);
1748 } else {
1749 bt_common_abort();
1750 }
1751
1752 BT_ASSERT_DBG(next_field);
1753 return next_field;
1754 }
1755
1756 static void update_default_clock(struct ctf_msg_iter *msg_it, uint64_t new_val,
1757 uint64_t new_val_size)
1758 {
1759 uint64_t new_val_mask;
1760 uint64_t cur_value_masked;
1761
1762 BT_ASSERT_DBG(new_val_size > 0);
1763
1764 /*
1765 * Special case for a 64-bit new value, which is the limit
1766 * of a clock value as of this version: overwrite the
1767 * current value directly.
1768 */
1769 if (new_val_size == 64) {
1770 msg_it->default_clock_snapshot = new_val;
1771 goto end;
1772 }
1773
1774 new_val_mask = (1ULL << new_val_size) - 1;
1775 cur_value_masked = msg_it->default_clock_snapshot & new_val_mask;
1776
1777 if (new_val < cur_value_masked) {
1778 /*
1779 * It looks like a wrap happened on the number of bits
1780 * of the requested new value. Assume that the clock
1781 * value wrapped only one time.
1782 */
1783 msg_it->default_clock_snapshot += new_val_mask + 1;
1784 }
1785
1786 /* Clear the low bits of the current clock value. */
1787 msg_it->default_clock_snapshot &= ~new_val_mask;
1788
1789 /* Set the low bits of the current clock value. */
1790 msg_it->default_clock_snapshot |= new_val;
1791
1792 end:
1793 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1794 "value=%" PRIu64,
1795 msg_it->default_clock_snapshot);
1796 }
1797
1798 static enum bt_bfcr_status bfcr_unsigned_int_cb(uint64_t value, struct ctf_field_class *fc,
1799 void *data)
1800 {
1801 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
1802 bt_self_component *self_comp = msg_it->self_comp;
1803 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1804
1805 bt_field *field = NULL;
1806
1807 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1808 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1809 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1810 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value);
1811
1812 ctf_field_class_int *int_fc = ctf_field_class_as_int(fc);
1813
1814 if (G_LIKELY(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE)) {
1815 goto update_def_clock;
1816 }
1817
1818 switch (int_fc->meaning) {
1819 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID:
1820 msg_it->cur_event_class_id = value;
1821 break;
1822 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID:
1823 msg_it->cur_data_stream_id = value;
1824 break;
1825 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME:
1826 msg_it->snapshots.beginning_clock = value;
1827 break;
1828 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME:
1829 msg_it->snapshots.end_clock = value;
1830 break;
1831 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID:
1832 msg_it->cur_stream_class_id = value;
1833 break;
1834 case CTF_FIELD_CLASS_MEANING_MAGIC:
1835 if (value != 0xc1fc1fc1) {
1836 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1837 "Invalid CTF magic number: msg-it-addr=%p, "
1838 "magic=%" PRIx64,
1839 msg_it, value);
1840 status = BT_BFCR_STATUS_ERROR;
1841 goto end;
1842 }
1843
1844 break;
1845 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT:
1846 msg_it->snapshots.packets = value;
1847 break;
1848 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT:
1849 msg_it->snapshots.discarded_events = value;
1850 break;
1851 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE:
1852 msg_it->cur_exp_packet_total_size = value;
1853 break;
1854 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE:
1855 msg_it->cur_exp_packet_content_size = value;
1856 break;
1857 default:
1858 bt_common_abort();
1859 }
1860
1861 update_def_clock:
1862 if (G_UNLIKELY(int_fc->mapped_clock_class)) {
1863 update_default_clock(msg_it, value, int_fc->base.size);
1864 }
1865
1866 if (G_UNLIKELY(int_fc->storing_index >= 0)) {
1867 g_array_index(msg_it->stored_values, uint64_t, (uint64_t) int_fc->storing_index) = value;
1868 }
1869
1870 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
1871 goto end;
1872 }
1873
1874 field = borrow_next_field(msg_it);
1875 BT_ASSERT_DBG(field);
1876 BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc);
1877 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field),
1878 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER));
1879 bt_field_integer_unsigned_set_value(field, value);
1880 stack_top(msg_it->stack)->index++;
1881
1882 end:
1883 return status;
1884 }
1885
1886 static enum bt_bfcr_status bfcr_unsigned_int_char_cb(uint64_t value, struct ctf_field_class *fc,
1887 void *data)
1888 {
1889 int ret;
1890 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
1891 bt_self_component *self_comp = msg_it->self_comp;
1892 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1893 bt_field *string_field = NULL;
1894 char str[2] = {'\0', '\0'};
1895
1896 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
1897 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1898 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1899 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value);
1900
1901 ctf_field_class_int *int_fc = ctf_field_class_as_int(fc);
1902 BT_ASSERT_DBG(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
1903 BT_ASSERT_DBG(!int_fc->mapped_clock_class);
1904 BT_ASSERT_DBG(int_fc->storing_index < 0);
1905
1906 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
1907 goto end;
1908 }
1909
1910 if (msg_it->done_filling_string) {
1911 goto end;
1912 }
1913
1914 if (value == 0) {
1915 msg_it->done_filling_string = true;
1916 goto end;
1917 }
1918
1919 string_field = stack_top(msg_it->stack)->base;
1920 BT_ASSERT_DBG(bt_field_get_class_type(string_field) == BT_FIELD_CLASS_TYPE_STRING);
1921
1922 /* Append character */
1923 str[0] = (char) value;
1924 ret = bt_field_string_append_with_length(string_field, str, 1);
1925 if (ret) {
1926 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1927 "Cannot append character to string field's value: "
1928 "msg-it-addr=%p, field-addr=%p, ret=%d",
1929 msg_it, string_field, ret);
1930 status = BT_BFCR_STATUS_ERROR;
1931 goto end;
1932 }
1933
1934 end:
1935 return status;
1936 }
1937
1938 static enum bt_bfcr_status bfcr_signed_int_cb(int64_t value, struct ctf_field_class *fc, void *data)
1939 {
1940 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1941 bt_field *field = NULL;
1942 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
1943
1944 BT_COMP_LOGT("Signed integer function called from BFCR: "
1945 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1946 "fc-type=%d, fc-in-ir=%d, value=%" PRId64,
1947 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value);
1948
1949 ctf_field_class_int *int_fc = ctf_field_class_as_int(fc);
1950 BT_ASSERT_DBG(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
1951
1952 if (G_UNLIKELY(int_fc->storing_index >= 0)) {
1953 g_array_index(msg_it->stored_values, uint64_t, (uint64_t) int_fc->storing_index) =
1954 (uint64_t) value;
1955 }
1956
1957 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
1958 goto end;
1959 }
1960
1961 field = borrow_next_field(msg_it);
1962 BT_ASSERT_DBG(field);
1963 BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc);
1964 BT_ASSERT_DBG(
1965 bt_field_class_type_is(bt_field_get_class_type(field), BT_FIELD_CLASS_TYPE_SIGNED_INTEGER));
1966 bt_field_integer_signed_set_value(field, value);
1967 stack_top(msg_it->stack)->index++;
1968
1969 end:
1970 return status;
1971 }
1972
1973 static enum bt_bfcr_status bfcr_floating_point_cb(double value, struct ctf_field_class *fc,
1974 void *data)
1975 {
1976 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1977 bt_field *field = NULL;
1978 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
1979 bt_field_class_type type;
1980
1981 BT_COMP_LOGT("Floating point number function called from BFCR: "
1982 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1983 "fc-type=%d, fc-in-ir=%d, value=%f",
1984 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, value);
1985
1986 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
1987 goto end;
1988 }
1989
1990 field = borrow_next_field(msg_it);
1991 type = bt_field_get_class_type(field);
1992 BT_ASSERT_DBG(field);
1993 BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc);
1994 BT_ASSERT_DBG(bt_field_class_type_is(type, BT_FIELD_CLASS_TYPE_REAL));
1995
1996 if (type == BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL) {
1997 bt_field_real_single_precision_set_value(field, (float) value);
1998 } else {
1999 bt_field_real_double_precision_set_value(field, value);
2000 }
2001 stack_top(msg_it->stack)->index++;
2002
2003 end:
2004 return status;
2005 }
2006
2007 static enum bt_bfcr_status bfcr_string_begin_cb(struct ctf_field_class *fc, void *data)
2008 {
2009 bt_field *field = NULL;
2010 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2011
2012 BT_COMP_LOGT("String (beginning) function called from BFCR: "
2013 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2014 "fc-type=%d, fc-in-ir=%d",
2015 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir);
2016
2017 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
2018 goto end;
2019 }
2020
2021 field = borrow_next_field(msg_it);
2022 BT_ASSERT_DBG(field);
2023 BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc);
2024 BT_ASSERT_DBG(bt_field_get_class_type(field) == BT_FIELD_CLASS_TYPE_STRING);
2025 bt_field_string_clear(field);
2026
2027 /*
2028 * Push on stack. Not a compound class per se, but we know that
2029 * only bfcr_string_cb() may be called between this call and a
2030 * subsequent call to bfcr_string_end_cb().
2031 */
2032 stack_push(msg_it->stack, field);
2033
2034 end:
2035 return BT_BFCR_STATUS_OK;
2036 }
2037
2038 static enum bt_bfcr_status bfcr_string_cb(const char *value, size_t len, struct ctf_field_class *fc,
2039 void *data)
2040 {
2041 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2042 bt_field *field = NULL;
2043 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2044 bt_self_component *self_comp = msg_it->self_comp;
2045 int ret;
2046
2047 BT_COMP_LOGT("String (substring) function called from BFCR: "
2048 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2049 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2050 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir, len);
2051
2052 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
2053 goto end;
2054 }
2055
2056 field = stack_top(msg_it->stack)->base;
2057 BT_ASSERT_DBG(field);
2058
2059 /* Append current substring */
2060 ret = bt_field_string_append_with_length(field, value, len);
2061 if (ret) {
2062 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2063 "Cannot append substring to string field's value: "
2064 "msg-it-addr=%p, field-addr=%p, string-length=%zu, "
2065 "ret=%d",
2066 msg_it, field, len, ret);
2067 status = BT_BFCR_STATUS_ERROR;
2068 goto end;
2069 }
2070
2071 end:
2072 return status;
2073 }
2074
2075 static enum bt_bfcr_status bfcr_string_end_cb(struct ctf_field_class *fc, void *data)
2076 {
2077 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2078
2079 BT_COMP_LOGT("String (end) function called from BFCR: "
2080 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2081 "fc-type=%d, fc-in-ir=%d",
2082 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir);
2083
2084 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
2085 goto end;
2086 }
2087
2088 /* Pop string field */
2089 stack_pop(msg_it->stack);
2090
2091 /* Go to next field */
2092 stack_top(msg_it->stack)->index++;
2093
2094 end:
2095 return BT_BFCR_STATUS_OK;
2096 }
2097
2098 static enum bt_bfcr_status bfcr_compound_begin_cb(struct ctf_field_class *fc, void *data)
2099 {
2100 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2101 bt_field *field;
2102
2103 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2104 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2105 "fc-type=%d, fc-in-ir=%d",
2106 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir);
2107
2108 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
2109 goto end;
2110 }
2111
2112 /* Borrow field */
2113 if (stack_empty(msg_it->stack)) {
2114 /* Root: already set by read_dscope_begin_state() */
2115 field = msg_it->cur_dscope_field;
2116 } else {
2117 field = borrow_next_field(msg_it);
2118 BT_ASSERT_DBG(field);
2119 }
2120
2121 /* Push field */
2122 BT_ASSERT_DBG(field);
2123 BT_ASSERT_DBG(bt_field_borrow_class_const(field) == fc->ir_fc);
2124 stack_push(msg_it->stack, field);
2125
2126 /*
2127 * Change BFCR "unsigned int" callback if it's a text
2128 * array/sequence.
2129 */
2130 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY || fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2131 ctf_field_class_array_base *array_fc = ctf_field_class_as_array_base(fc);
2132
2133 if (array_fc->is_text) {
2134 BT_ASSERT_DBG(bt_field_get_class_type(field) == BT_FIELD_CLASS_TYPE_STRING);
2135 msg_it->done_filling_string = false;
2136 bt_field_string_clear(field);
2137 bt_bfcr_set_unsigned_int_cb(msg_it->bfcr, bfcr_unsigned_int_char_cb);
2138 }
2139 }
2140
2141 end:
2142 return BT_BFCR_STATUS_OK;
2143 }
2144
2145 static enum bt_bfcr_status bfcr_compound_end_cb(struct ctf_field_class *fc, void *data)
2146 {
2147 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2148
2149 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2150 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2151 "fc-type=%d, fc-in-ir=%d",
2152 msg_it, msg_it->bfcr, fc, fc->type, fc->in_ir);
2153
2154 if (G_UNLIKELY(!fc->in_ir || msg_it->dry_run)) {
2155 goto end;
2156 }
2157
2158 BT_ASSERT_DBG(!stack_empty(msg_it->stack));
2159 BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(msg_it->stack)->base) == fc->ir_fc);
2160
2161 /*
2162 * Reset BFCR "unsigned int" callback if it's a text
2163 * array/sequence.
2164 */
2165 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY || fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2166 ctf_field_class_array_base *array_fc = ctf_field_class_as_array_base(fc);
2167
2168 if (array_fc->is_text) {
2169 BT_ASSERT_DBG(bt_field_get_class_type(stack_top(msg_it->stack)->base) ==
2170 BT_FIELD_CLASS_TYPE_STRING);
2171 bt_bfcr_set_unsigned_int_cb(msg_it->bfcr, bfcr_unsigned_int_cb);
2172 }
2173 }
2174
2175 /* Pop stack */
2176 stack_pop(msg_it->stack);
2177
2178 /* If the stack is not empty, increment the base's index */
2179 if (!stack_empty(msg_it->stack)) {
2180 stack_top(msg_it->stack)->index++;
2181 }
2182
2183 end:
2184 return BT_BFCR_STATUS_OK;
2185 }
2186
2187 static int64_t bfcr_get_sequence_length_cb(struct ctf_field_class *fc, void *data)
2188 {
2189 bt_field *seq_field;
2190 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2191 bt_self_component *self_comp = msg_it->self_comp;
2192 struct ctf_field_class_sequence *seq_fc = ctf_field_class_as_sequence(fc);
2193 int64_t length;
2194 int ret;
2195
2196 length = (uint64_t) g_array_index(msg_it->stored_values, uint64_t, seq_fc->stored_length_index);
2197
2198 if (G_UNLIKELY(msg_it->dry_run)) {
2199 goto end;
2200 }
2201
2202 seq_field = stack_top(msg_it->stack)->base;
2203 BT_ASSERT_DBG(seq_field);
2204
2205 /*
2206 * bfcr_get_sequence_length_cb() also gets called back for a
2207 * text sequence, but the destination field is a string field.
2208 * Only set the field's sequence length if the destination field
2209 * is a sequence field.
2210 */
2211 if (!seq_fc->base.is_text) {
2212 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(seq_field),
2213 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY));
2214 ret = bt_field_array_dynamic_set_length(seq_field, (uint64_t) length);
2215 if (ret) {
2216 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2217 "Cannot set dynamic array field's length field: "
2218 "msg-it-addr=%p, field-addr=%p, "
2219 "length=%" PRIu64,
2220 msg_it, seq_field, length);
2221 length = -1;
2222 }
2223 }
2224
2225 end:
2226 return length;
2227 }
2228
2229 static struct ctf_field_class *
2230 bfcr_borrow_variant_selected_field_class_cb(struct ctf_field_class *fc, void *data)
2231 {
2232 int ret;
2233 uint64_t i;
2234 int64_t option_index = -1;
2235 ctf_msg_iter *msg_it = (ctf_msg_iter *) data;
2236 ctf_field_class_variant *var_fc = ctf_field_class_as_variant(fc);
2237 struct ctf_named_field_class *selected_option = NULL;
2238 bt_self_component *self_comp = msg_it->self_comp;
2239 struct ctf_field_class *ret_fc = NULL;
2240 union
2241 {
2242 uint64_t u;
2243 int64_t i;
2244 } tag;
2245
2246 /* Get variant's tag */
2247 tag.u = g_array_index(msg_it->stored_values, uint64_t, var_fc->stored_tag_index);
2248
2249 /*
2250 * Check each range to find the selected option's index.
2251 */
2252 if (var_fc->tag_fc->base.is_signed) {
2253 for (i = 0; i < var_fc->ranges->len; i++) {
2254 struct ctf_field_class_variant_range *range =
2255 ctf_field_class_variant_borrow_range_by_index(var_fc, i);
2256
2257 if (tag.i >= range->range.lower.i && tag.i <= range->range.upper.i) {
2258 option_index = (int64_t) range->option_index;
2259 break;
2260 }
2261 }
2262 } else {
2263 for (i = 0; i < var_fc->ranges->len; i++) {
2264 struct ctf_field_class_variant_range *range =
2265 ctf_field_class_variant_borrow_range_by_index(var_fc, i);
2266
2267 if (tag.u >= range->range.lower.u && tag.u <= range->range.upper.u) {
2268 option_index = (int64_t) range->option_index;
2269 break;
2270 }
2271 }
2272 }
2273
2274 if (option_index < 0) {
2275 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2276 "Cannot find variant field class's option: "
2277 "msg-it-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64 ", "
2278 "i-tag=%" PRId64,
2279 msg_it, var_fc, tag.u, tag.i);
2280 ret_fc = NULL;
2281 goto end;
2282 }
2283
2284 selected_option =
2285 ctf_field_class_variant_borrow_option_by_index(var_fc, (uint64_t) option_index);
2286
2287 if (selected_option->fc->in_ir && !msg_it->dry_run) {
2288 bt_field *var_field = stack_top(msg_it->stack)->base;
2289
2290 ret = bt_field_variant_select_option_by_index(var_field, option_index);
2291 if (ret) {
2292 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2293 "Cannot select variant field's option field: "
2294 "msg-it-addr=%p, var-field-addr=%p, "
2295 "opt-index=%" PRId64,
2296 msg_it, var_field, option_index);
2297 ret_fc = NULL;
2298 goto end;
2299 }
2300 }
2301
2302 ret_fc = selected_option->fc;
2303
2304 end:
2305 return ret_fc;
2306 }
2307
2308 static bt_message *create_msg_stream_beginning(struct ctf_msg_iter *msg_it)
2309 {
2310 bt_self_component *self_comp = msg_it->self_comp;
2311 bt_message *msg;
2312
2313 BT_ASSERT(msg_it->stream);
2314 BT_ASSERT(msg_it->self_msg_iter);
2315 msg = bt_message_stream_beginning_create(msg_it->self_msg_iter, msg_it->stream);
2316 if (!msg) {
2317 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2318 "Cannot create stream beginning message: "
2319 "msg-it-addr=%p, stream-addr=%p",
2320 msg_it, msg_it->stream);
2321 }
2322
2323 return msg;
2324 }
2325
2326 static bt_message *create_msg_stream_end(struct ctf_msg_iter *msg_it)
2327 {
2328 bt_self_component *self_comp = msg_it->self_comp;
2329 bt_message *msg;
2330
2331 if (!msg_it->stream) {
2332 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2333 "Cannot create stream end message because stream is NULL: "
2334 "msg-it-addr=%p",
2335 msg_it);
2336 msg = NULL;
2337 goto end;
2338 }
2339
2340 BT_ASSERT(msg_it->self_msg_iter);
2341 msg = bt_message_stream_end_create(msg_it->self_msg_iter, msg_it->stream);
2342 if (!msg) {
2343 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2344 "Cannot create stream end message: "
2345 "msg-it-addr=%p, stream-addr=%p",
2346 msg_it, msg_it->stream);
2347 }
2348
2349 end:
2350 return msg;
2351 }
2352
2353 static bt_message *create_msg_packet_beginning(struct ctf_msg_iter *msg_it, bool use_default_cs)
2354 {
2355 bt_self_component *self_comp = msg_it->self_comp;
2356 bt_message *msg;
2357 const bt_stream_class *sc = msg_it->meta.sc->ir_sc;
2358
2359 BT_ASSERT(msg_it->packet);
2360 BT_ASSERT(sc);
2361 BT_ASSERT(msg_it->self_msg_iter);
2362
2363 if (msg_it->meta.sc->packets_have_ts_begin) {
2364 BT_ASSERT(msg_it->snapshots.beginning_clock != UINT64_C(-1));
2365 uint64_t raw_cs_value;
2366
2367 /*
2368 * Either use the decoded packet `timestamp_begin` field or the
2369 * current stream's default clock_snapshot.
2370 */
2371 if (use_default_cs) {
2372 raw_cs_value = msg_it->default_clock_snapshot;
2373 } else {
2374 raw_cs_value = msg_it->snapshots.beginning_clock;
2375 }
2376
2377 msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
2378 msg_it->self_msg_iter, msg_it->packet, raw_cs_value);
2379 } else {
2380 msg = bt_message_packet_beginning_create(msg_it->self_msg_iter, msg_it->packet);
2381 }
2382
2383 if (!msg) {
2384 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2385 "Cannot create packet beginning message: "
2386 "msg-it-addr=%p, packet-addr=%p",
2387 msg_it, msg_it->packet);
2388 goto end;
2389 }
2390
2391 end:
2392 return msg;
2393 }
2394
2395 static bt_message *emit_delayed_packet_beg_msg(struct ctf_msg_iter *msg_it)
2396 {
2397 bool packet_beg_ts_need_fix_up;
2398
2399 msg_it->emit_delayed_packet_beginning_msg = false;
2400
2401 /*
2402 * Only fix the packet's timestamp_begin if it's larger than the first
2403 * event of the packet. If there was no event in the packet, the
2404 * `default_clock_snapshot` field will be either equal or greater than
2405 * `snapshots.beginning_clock` so there is not fix needed.
2406 */
2407 packet_beg_ts_need_fix_up = msg_it->default_clock_snapshot < msg_it->snapshots.beginning_clock;
2408
2409 /* create_msg_packet_beginning() logs errors */
2410 return create_msg_packet_beginning(msg_it, packet_beg_ts_need_fix_up);
2411 }
2412
2413 static bt_message *create_msg_packet_end(struct ctf_msg_iter *msg_it)
2414 {
2415 bt_message *msg;
2416 bool update_default_cs = true;
2417 bt_self_component *self_comp = msg_it->self_comp;
2418
2419 if (!msg_it->packet) {
2420 msg = NULL;
2421 goto end;
2422 }
2423
2424 /*
2425 * Check if we need to emit the delayed packet
2426 * beginning message instead of the packet end message.
2427 */
2428 if (G_UNLIKELY(msg_it->emit_delayed_packet_beginning_msg)) {
2429 msg = emit_delayed_packet_beg_msg(msg_it);
2430 /* Don't forget to emit the packet end message. */
2431 msg_it->state = STATE_EMIT_QUEUED_MSG_PACKET_END;
2432 goto end;
2433 }
2434
2435 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2436 if (G_UNLIKELY(msg_it->meta.tc->quirks.lttng_crash)) {
2437 /*
2438 * Check if the `timestamp_begin` field is non-zero but
2439 * `timestamp_end` is zero. It means the trace is affected by
2440 * the lttng-crash packet `timestamp_end` quirk and must be
2441 * fixed up by omitting to update the default clock snapshot to
2442 * the `timestamp_end` as is typically done.
2443 */
2444 if (msg_it->snapshots.beginning_clock != 0 && msg_it->snapshots.end_clock == 0) {
2445 update_default_cs = false;
2446 }
2447 }
2448
2449 /*
2450 * Check if may be affected by lttng event-after-packet `timestamp_end`
2451 * quirk.
2452 */
2453 if (msg_it->meta.tc->quirks.lttng_event_after_packet) {
2454 /*
2455 * Check if `timestamp_end` is smaller then the current
2456 * default_clock_snapshot (which is set to the last event
2457 * decoded). It means the trace is affected by the lttng
2458 * `event-after-packet` packet `timestamp_end` quirk and must
2459 * be fixed up by omitting to update the default clock snapshot
2460 * to the `timestamp_end` as is typically done.
2461 */
2462 if (msg_it->snapshots.end_clock < msg_it->default_clock_snapshot) {
2463 update_default_cs = false;
2464 }
2465 }
2466
2467 /* Update default clock from packet's end time. */
2468 if (msg_it->snapshots.end_clock != UINT64_C(-1) && update_default_cs) {
2469 msg_it->default_clock_snapshot = msg_it->snapshots.end_clock;
2470 }
2471
2472 BT_ASSERT(msg_it->self_msg_iter);
2473
2474 if (msg_it->meta.sc->packets_have_ts_end) {
2475 BT_ASSERT(msg_it->snapshots.end_clock != UINT64_C(-1));
2476 msg = bt_message_packet_end_create_with_default_clock_snapshot(
2477 msg_it->self_msg_iter, msg_it->packet, msg_it->default_clock_snapshot);
2478 } else {
2479 msg = bt_message_packet_end_create(msg_it->self_msg_iter, msg_it->packet);
2480 }
2481
2482 if (!msg) {
2483 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2484 "Cannot create packet end message: "
2485 "msg-it-addr=%p, packet-addr=%p",
2486 msg_it, msg_it->packet);
2487 goto end;
2488 }
2489
2490 BT_PACKET_PUT_REF_AND_RESET(msg_it->packet);
2491
2492 end:
2493 return msg;
2494 }
2495
2496 static bt_message *create_msg_discarded_events(struct ctf_msg_iter *msg_it)
2497 {
2498 bt_message *msg;
2499 bt_self_component *self_comp = msg_it->self_comp;
2500 uint64_t beginning_raw_value = UINT64_C(-1);
2501 uint64_t end_raw_value = UINT64_C(-1);
2502
2503 BT_ASSERT(msg_it->self_msg_iter);
2504 BT_ASSERT(msg_it->stream);
2505 BT_ASSERT(msg_it->meta.sc->has_discarded_events);
2506
2507 if (msg_it->meta.sc->discarded_events_have_default_cs) {
2508 if (msg_it->prev_packet_snapshots.discarded_events == UINT64_C(-1)) {
2509 /*
2510 * We discarded events, but before (and possibly
2511 * including) the current packet: use this packet's time
2512 * range, and do not have a specific count.
2513 */
2514 beginning_raw_value = msg_it->snapshots.beginning_clock;
2515 end_raw_value = msg_it->snapshots.end_clock;
2516 } else {
2517 beginning_raw_value = msg_it->prev_packet_snapshots.end_clock;
2518 end_raw_value = msg_it->snapshots.end_clock;
2519 }
2520
2521 BT_ASSERT(beginning_raw_value != UINT64_C(-1));
2522 BT_ASSERT(end_raw_value != UINT64_C(-1));
2523 msg = bt_message_discarded_events_create_with_default_clock_snapshots(
2524 msg_it->self_msg_iter, msg_it->stream, beginning_raw_value, end_raw_value);
2525 } else {
2526 msg = bt_message_discarded_events_create(msg_it->self_msg_iter, msg_it->stream);
2527 }
2528
2529 if (!msg) {
2530 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2531 "Cannot create discarded events message: "
2532 "msg-it-addr=%p, stream-addr=%p",
2533 msg_it, msg_it->stream);
2534 goto end;
2535 }
2536
2537 if (msg_it->prev_packet_snapshots.discarded_events != UINT64_C(-1)) {
2538 bt_message_discarded_events_set_count(msg,
2539 msg_it->snapshots.discarded_events -
2540 msg_it->prev_packet_snapshots.discarded_events);
2541 }
2542
2543 end:
2544 return msg;
2545 }
2546
2547 static bt_message *create_msg_discarded_packets(struct ctf_msg_iter *msg_it)
2548 {
2549 bt_message *msg;
2550 bt_self_component *self_comp = msg_it->self_comp;
2551
2552 BT_ASSERT(msg_it->self_msg_iter);
2553 BT_ASSERT(msg_it->stream);
2554 BT_ASSERT(msg_it->meta.sc->has_discarded_packets);
2555 BT_ASSERT(msg_it->prev_packet_snapshots.packets != UINT64_C(-1));
2556
2557 if (msg_it->meta.sc->discarded_packets_have_default_cs) {
2558 BT_ASSERT(msg_it->prev_packet_snapshots.end_clock != UINT64_C(-1));
2559 BT_ASSERT(msg_it->snapshots.beginning_clock != UINT64_C(-1));
2560 msg = bt_message_discarded_packets_create_with_default_clock_snapshots(
2561 msg_it->self_msg_iter, msg_it->stream, msg_it->prev_packet_snapshots.end_clock,
2562 msg_it->snapshots.beginning_clock);
2563 } else {
2564 msg = bt_message_discarded_packets_create(msg_it->self_msg_iter, msg_it->stream);
2565 }
2566
2567 if (!msg) {
2568 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
2569 "Cannot create discarded packets message: "
2570 "msg-it-addr=%p, stream-addr=%p",
2571 msg_it, msg_it->stream);
2572 goto end;
2573 }
2574
2575 bt_message_discarded_packets_set_count(msg, msg_it->snapshots.packets -
2576 msg_it->prev_packet_snapshots.packets - 1);
2577
2578 end:
2579 return msg;
2580 }
2581
2582 BT_HIDDEN
2583 struct ctf_msg_iter *ctf_msg_iter_create(struct ctf_trace_class *tc, size_t max_request_sz,
2584 struct ctf_msg_iter_medium_ops medops, void *data,
2585 bt_logging_level log_level, bt_self_component *self_comp,
2586 bt_self_message_iterator *self_msg_iter)
2587 {
2588 struct ctf_msg_iter *msg_it = NULL;
2589 struct bt_bfcr_cbs cbs = {
2590 .classes =
2591 {
2592 .signed_int = bfcr_signed_int_cb,
2593 .unsigned_int = bfcr_unsigned_int_cb,
2594 .floating_point = bfcr_floating_point_cb,
2595 .string_begin = bfcr_string_begin_cb,
2596 .string = bfcr_string_cb,
2597 .string_end = bfcr_string_end_cb,
2598 .compound_begin = bfcr_compound_begin_cb,
2599 .compound_end = bfcr_compound_end_cb,
2600 },
2601 .query =
2602 {
2603 .get_sequence_length = bfcr_get_sequence_length_cb,
2604 .borrow_variant_selected_field_class = bfcr_borrow_variant_selected_field_class_cb,
2605 },
2606 };
2607
2608 BT_ASSERT(tc);
2609 BT_ASSERT(medops.request_bytes);
2610 BT_ASSERT(medops.borrow_stream);
2611 BT_ASSERT(max_request_sz > 0);
2612
2613 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, log_level, self_comp,
2614 "Creating CTF plugin message iterator: "
2615 "trace-addr=%p, max-request-size=%zu, "
2616 "data=%p, log-level=%s",
2617 tc, max_request_sz, data, bt_common_logging_level_string(log_level));
2618 msg_it = g_new0(struct ctf_msg_iter, 1);
2619 if (!msg_it) {
2620 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
2621 "Failed to allocate one CTF plugin message iterator.");
2622 goto end;
2623 }
2624 msg_it->self_comp = self_comp;
2625 msg_it->self_msg_iter = self_msg_iter;
2626 msg_it->log_level = log_level;
2627 msg_it->meta.tc = tc;
2628 msg_it->medium.medops = medops;
2629 msg_it->medium.max_request_sz = max_request_sz;
2630 msg_it->medium.data = data;
2631 msg_it->stack = stack_new(msg_it);
2632 msg_it->stored_values = g_array_new(FALSE, TRUE, sizeof(uint64_t));
2633 g_array_set_size(msg_it->stored_values, tc->stored_value_count);
2634
2635 if (!msg_it->stack) {
2636 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create field stack.");
2637 goto error;
2638 }
2639
2640 msg_it->bfcr = bt_bfcr_create(cbs, msg_it, log_level, NULL);
2641 if (!msg_it->bfcr) {
2642 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create binary class reader (BFCR).");
2643 goto error;
2644 }
2645
2646 ctf_msg_iter_reset(msg_it);
2647 BT_COMP_LOGD("Created CTF plugin message iterator: "
2648 "trace-addr=%p, max-request-size=%zu, "
2649 "data=%p, msg-it-addr=%p, log-level=%s",
2650 tc, max_request_sz, data, msg_it, bt_common_logging_level_string(log_level));
2651 msg_it->cur_packet_offset = 0;
2652
2653 end:
2654 return msg_it;
2655
2656 error:
2657 ctf_msg_iter_destroy(msg_it);
2658 msg_it = NULL;
2659 goto end;
2660 }
2661
2662 void ctf_msg_iter_destroy(struct ctf_msg_iter *msg_it)
2663 {
2664 BT_PACKET_PUT_REF_AND_RESET(msg_it->packet);
2665 BT_STREAM_PUT_REF_AND_RESET(msg_it->stream);
2666 release_all_dscopes(msg_it);
2667
2668 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it);
2669
2670 if (msg_it->stack) {
2671 BT_COMP_LOGD_STR("Destroying field stack.");
2672 stack_destroy(msg_it->stack);
2673 }
2674
2675 if (msg_it->bfcr) {
2676 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it->bfcr);
2677 bt_bfcr_destroy(msg_it->bfcr);
2678 }
2679
2680 if (msg_it->stored_values) {
2681 g_array_free(msg_it->stored_values, TRUE);
2682 }
2683
2684 g_free(msg_it);
2685 }
2686
2687 enum ctf_msg_iter_status ctf_msg_iter_get_next_message(struct ctf_msg_iter *msg_it,
2688 const bt_message **message)
2689 {
2690 enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK;
2691 bt_self_component *self_comp = msg_it->self_comp;
2692
2693 BT_ASSERT_DBG(msg_it);
2694 BT_ASSERT_DBG(message);
2695 BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it);
2696
2697 while (true) {
2698 status = handle_state(msg_it);
2699 if (G_UNLIKELY(status == CTF_MSG_ITER_STATUS_AGAIN)) {
2700 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2701 goto end;
2702 } else if (G_UNLIKELY(status != CTF_MSG_ITER_STATUS_OK)) {
2703 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot handle state: msg-it-addr=%p, state=%s",
2704 msg_it, state_string(msg_it->state));
2705 goto end;
2706 }
2707
2708 switch (msg_it->state) {
2709 case STATE_EMIT_MSG_EVENT:
2710 BT_ASSERT_DBG(msg_it->event_msg);
2711
2712 /*
2713 * Check if we need to emit the delayed packet
2714 * beginning message instead of the event message.
2715 */
2716 if (G_UNLIKELY(msg_it->emit_delayed_packet_beginning_msg)) {
2717 *message = emit_delayed_packet_beg_msg(msg_it);
2718 if (!*message) {
2719 status = CTF_MSG_ITER_STATUS_ERROR;
2720 }
2721
2722 /*
2723 * Don't forget to emit the event message of
2724 * the event record that was just decoded.
2725 */
2726 msg_it->state = STATE_EMIT_QUEUED_MSG_EVENT;
2727
2728 } else {
2729 *message = msg_it->event_msg;
2730 msg_it->event_msg = NULL;
2731 }
2732 goto end;
2733 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2734 /* create_msg_discared_events() logs errors */
2735 *message = create_msg_discarded_events(msg_it);
2736
2737 if (!*message) {
2738 status = CTF_MSG_ITER_STATUS_ERROR;
2739 }
2740
2741 goto end;
2742 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2743 /* create_msg_discared_packets() logs errors */
2744 *message = create_msg_discarded_packets(msg_it);
2745
2746 if (!*message) {
2747 status = CTF_MSG_ITER_STATUS_ERROR;
2748 }
2749
2750 goto end;
2751 case STATE_EMIT_MSG_PACKET_BEGINNING:
2752 if (G_UNLIKELY(msg_it->meta.tc->quirks.barectf_event_before_packet)) {
2753 msg_it->emit_delayed_packet_beginning_msg = true;
2754 /*
2755 * There is no message to return yet as this
2756 * packet beginning message is delayed until we
2757 * decode the first event message of the
2758 * packet.
2759 */
2760 break;
2761 } else {
2762 /* create_msg_packet_beginning() logs errors */
2763 *message = create_msg_packet_beginning(msg_it, false);
2764 if (!*message) {
2765 status = CTF_MSG_ITER_STATUS_ERROR;
2766 }
2767 }
2768
2769 goto end;
2770 case STATE_EMIT_MSG_PACKET_END_SINGLE:
2771 case STATE_EMIT_MSG_PACKET_END_MULTI:
2772 /* create_msg_packet_end() logs errors */
2773 *message = create_msg_packet_end(msg_it);
2774
2775 if (!*message) {
2776 status = CTF_MSG_ITER_STATUS_ERROR;
2777 }
2778
2779 goto end;
2780 case STATE_EMIT_MSG_STREAM_BEGINNING:
2781 /* create_msg_stream_beginning() logs errors */
2782 *message = create_msg_stream_beginning(msg_it);
2783 msg_it->emit_stream_beginning_message = false;
2784 msg_it->emit_stream_end_message = true;
2785
2786 if (!*message) {
2787 status = CTF_MSG_ITER_STATUS_ERROR;
2788 }
2789
2790 goto end;
2791 case STATE_EMIT_MSG_STREAM_END:
2792 /* create_msg_stream_end() logs errors */
2793 *message = create_msg_stream_end(msg_it);
2794 msg_it->emit_stream_end_message = false;
2795
2796 if (!*message) {
2797 status = CTF_MSG_ITER_STATUS_ERROR;
2798 }
2799
2800 goto end;
2801 case STATE_DONE:
2802 status = CTF_MSG_ITER_STATUS_EOF;
2803 goto end;
2804 default:
2805 /* Non-emitting state: continue */
2806 break;
2807 }
2808 }
2809
2810 end:
2811 return status;
2812 }
2813
2814 static enum ctf_msg_iter_status decode_until_state(struct ctf_msg_iter *msg_it,
2815 enum state target_state_1,
2816 enum state target_state_2)
2817 {
2818 enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK;
2819 bt_self_component *self_comp = msg_it->self_comp;
2820
2821 BT_ASSERT_DBG(msg_it);
2822
2823 do {
2824 /*
2825 * Check if we reached the state at which we want to stop
2826 * decoding.
2827 */
2828 if (msg_it->state == target_state_1 || msg_it->state == target_state_2) {
2829 goto end;
2830 }
2831
2832 status = handle_state(msg_it);
2833 if (G_UNLIKELY(status == CTF_MSG_ITER_STATUS_AGAIN)) {
2834 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2835 goto end;
2836 } else if (G_UNLIKELY(status != CTF_MSG_ITER_STATUS_OK)) {
2837 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot handle state: msg-it-addr=%p, state=%s",
2838 msg_it, state_string(msg_it->state));
2839 goto end;
2840 }
2841
2842 switch (msg_it->state) {
2843 case STATE_INIT:
2844 case STATE_SWITCH_PACKET:
2845 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
2846 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
2847 case STATE_AFTER_TRACE_PACKET_HEADER:
2848 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
2849 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
2850 case STATE_AFTER_STREAM_PACKET_CONTEXT:
2851 case STATE_EMIT_MSG_STREAM_BEGINNING:
2852 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS:
2853 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2854 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS:
2855 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2856 case STATE_EMIT_MSG_PACKET_BEGINNING:
2857 case STATE_DSCOPE_EVENT_HEADER_BEGIN:
2858 case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
2859 case STATE_AFTER_EVENT_HEADER:
2860 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
2861 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
2862 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
2863 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
2864 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
2865 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE:
2866 case STATE_EMIT_MSG_EVENT:
2867 case STATE_EMIT_QUEUED_MSG_EVENT:
2868 case STATE_SKIP_PACKET_PADDING:
2869 case STATE_EMIT_MSG_PACKET_END_MULTI:
2870 case STATE_EMIT_MSG_PACKET_END_SINGLE:
2871 case STATE_EMIT_QUEUED_MSG_PACKET_END:
2872 case STATE_EMIT_MSG_STREAM_END:
2873 break;
2874 case STATE_DONE:
2875 /* fall-through */
2876 default:
2877 /* We should never get to the STATE_DONE state. */
2878 BT_COMP_LOGF("Unexpected state: msg-it-addr=%p, state=%s", msg_it,
2879 state_string(msg_it->state));
2880 bt_common_abort();
2881 }
2882 } while (true);
2883
2884 end:
2885 return status;
2886 }
2887
2888 static enum ctf_msg_iter_status read_packet_header_context_fields(struct ctf_msg_iter *msg_it)
2889 {
2890 int ret;
2891 enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK;
2892
2893 status = decode_until_state(msg_it, STATE_EMIT_MSG_PACKET_BEGINNING, (state) -1);
2894 if (status != CTF_MSG_ITER_STATUS_OK) {
2895 goto end;
2896 }
2897
2898 ret = set_current_packet_content_sizes(msg_it);
2899 if (ret) {
2900 status = CTF_MSG_ITER_STATUS_ERROR;
2901 goto end;
2902 }
2903
2904 end:
2905 return status;
2906 }
2907
2908 BT_HIDDEN
2909 enum ctf_msg_iter_status ctf_msg_iter_seek(struct ctf_msg_iter *msg_it, off_t offset)
2910 {
2911 enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK;
2912 enum ctf_msg_iter_medium_status medium_status;
2913
2914 BT_ASSERT(msg_it);
2915 BT_ASSERT(offset >= 0);
2916 BT_ASSERT(msg_it->medium.medops.seek);
2917
2918 medium_status = msg_it->medium.medops.seek(offset, msg_it->medium.data);
2919 if (medium_status != CTF_MSG_ITER_MEDIUM_STATUS_OK) {
2920 if (medium_status == CTF_MSG_ITER_MEDIUM_STATUS_EOF) {
2921 status = CTF_MSG_ITER_STATUS_EOF;
2922 } else {
2923 status = CTF_MSG_ITER_STATUS_ERROR;
2924 goto end;
2925 }
2926 }
2927
2928 ctf_msg_iter_reset(msg_it);
2929 msg_it->cur_packet_offset = offset;
2930
2931 end:
2932 return status;
2933 }
2934
2935 static enum ctf_msg_iter_status clock_snapshot_at_msg_iter_state(struct ctf_msg_iter *msg_it,
2936 enum state target_state_1,
2937 enum state target_state_2,
2938 uint64_t *clock_snapshot)
2939 {
2940 enum ctf_msg_iter_status status = CTF_MSG_ITER_STATUS_OK;
2941
2942 BT_ASSERT_DBG(msg_it);
2943 BT_ASSERT_DBG(clock_snapshot);
2944 status = decode_until_state(msg_it, target_state_1, target_state_2);
2945 if (status != CTF_MSG_ITER_STATUS_OK) {
2946 goto end;
2947 }
2948
2949 *clock_snapshot = msg_it->default_clock_snapshot;
2950 end:
2951 return status;
2952 }
2953
2954 BT_HIDDEN
2955 enum ctf_msg_iter_status
2956 ctf_msg_iter_curr_packet_first_event_clock_snapshot(struct ctf_msg_iter *msg_it,
2957 uint64_t *first_clock_snapshot)
2958 {
2959 return clock_snapshot_at_msg_iter_state(msg_it, STATE_AFTER_EVENT_HEADER, (state) -1,
2960 first_clock_snapshot);
2961 }
2962
2963 BT_HIDDEN
2964 enum ctf_msg_iter_status
2965 ctf_msg_iter_curr_packet_last_event_clock_snapshot(struct ctf_msg_iter *msg_it,
2966 uint64_t *last_clock_snapshot)
2967 {
2968 return clock_snapshot_at_msg_iter_state(msg_it, STATE_EMIT_MSG_PACKET_END_SINGLE,
2969 STATE_EMIT_MSG_PACKET_END_MULTI, last_clock_snapshot);
2970 }
2971
2972 BT_HIDDEN
2973 enum ctf_msg_iter_status
2974 ctf_msg_iter_get_packet_properties(struct ctf_msg_iter *msg_it,
2975 struct ctf_msg_iter_packet_properties *props)
2976 {
2977 enum ctf_msg_iter_status status;
2978
2979 BT_ASSERT_DBG(msg_it);
2980 BT_ASSERT_DBG(props);
2981 status = read_packet_header_context_fields(msg_it);
2982 if (status != CTF_MSG_ITER_STATUS_OK) {
2983 goto end;
2984 }
2985
2986 props->exp_packet_total_size = msg_it->cur_exp_packet_total_size;
2987 props->exp_packet_content_size = msg_it->cur_exp_packet_content_size;
2988 props->stream_class_id = (uint64_t) msg_it->cur_stream_class_id;
2989 props->data_stream_id = msg_it->cur_data_stream_id;
2990 props->snapshots.discarded_events = msg_it->snapshots.discarded_events;
2991 props->snapshots.packets = msg_it->snapshots.packets;
2992 props->snapshots.beginning_clock = msg_it->snapshots.beginning_clock;
2993 props->snapshots.end_clock = msg_it->snapshots.end_clock;
2994
2995 end:
2996 return status;
2997 }
2998
2999 BT_HIDDEN
3000 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter *msg_it, bool val)
3001 {
3002 msg_it->dry_run = val;
3003 }
BabelTrace - Trace Format Babel Tower
This page took 0.146783 seconds and 4 git commands to generate.