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