2 * SPDX-License-Identifier: MIT
4 * Copyright (c) 2015-2018 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
7 * Babeltrace - CTF message iterator
19 #include <babeltrace2/babeltrace.h>
21 #define BT_COMP_LOG_SELF_COMP (msg_it->self_comp)
22 #define BT_LOG_OUTPUT_LEVEL (msg_it->log_level)
23 #define BT_LOG_TAG "PLUGIN/CTF/MSG-ITER"
24 #include "logging/comp-logging.h"
26 #include "common/assert.h"
27 #include "common/common.h"
29 #include "../bfcr/bfcr.hpp"
30 #include "msg-iter.hpp"
34 /* A visit stack entry */
38 * Current base field, one of:
50 /* Index of next field to set */
59 struct ctf_msg_iter
*msg_it
;
61 /* Entries (struct stack_entry) */
64 /* Number of active entries */
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
,
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
,
105 struct end_of_packet_snapshots
107 uint64_t discarded_events
;
109 uint64_t beginning_clock
;
113 /* CTF message iterator */
119 /* Current message iterator to create messages (weak) */
120 bt_self_message_iterator
*self_msg_iter
;
123 * True if library objects are unavailable during the decoding and
124 * should not be created/used.
129 * Current dynamic scope field pointer.
131 * This is set by read_dscope_begin_state() and contains the
132 * value of one of the pointers in `dscopes` below.
134 bt_field
*cur_dscope_field
;
137 * True if we're done filling a string field from a text
138 * array/sequence payload.
140 bool done_filling_string
;
142 /* Trace and classes */
143 /* True to set IR fields */
148 struct ctf_trace_class
*tc
;
149 struct ctf_stream_class
*sc
;
150 struct ctf_event_class
*ec
;
153 /* Current packet (NULL if not created yet) */
156 /* Current stream (NULL if not set yet) */
159 /* Current event (NULL if not created yet) */
162 /* Current event message (NULL if not created yet) */
163 bt_message
*event_msg
;
166 * True if we need to emit a packet beginning message before we emit
167 * the next event message or the packet end message.
169 bool emit_delayed_packet_beginning_msg
;
172 * True if this is the first packet we are reading, and therefore if we
173 * should emit a stream beginning message.
175 bool emit_stream_beginning_message
;
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.
183 bool emit_stream_end_message
;
185 /* Database of current dynamic scopes */
188 bt_field
*stream_packet_context
;
189 bt_field
*event_common_context
;
190 bt_field
*event_spec_context
;
191 bt_field
*event_payload
;
197 /* Current medium buffer data */
200 /* Last address provided by medium */
203 /* Buffer size provided by medium (bytes) */
206 /* Offset within whole packet of addr (bits) */
207 size_t packet_offset
;
209 /* Current position from addr (bits) */
212 /* Position of the last event header from addr (bits) */
216 /* Binary type reader */
217 struct bt_bfcr
*bfcr
;
219 /* Current medium data */
222 struct ctf_msg_iter_medium_ops medops
;
223 size_t max_request_sz
;
227 /* Current packet size (bits) (-1 if unknown) */
228 int64_t cur_exp_packet_total_size
;
230 /* Current content size (bits) (-1 if unknown) */
231 int64_t cur_exp_packet_content_size
;
233 /* Current stream class ID */
234 int64_t cur_stream_class_id
;
236 /* Current event class ID */
237 int64_t cur_event_class_id
;
239 /* Current data stream ID */
240 int64_t cur_data_stream_id
;
243 * Offset, in the underlying media, of the current packet's
244 * start (-1 if unknown).
246 off_t cur_packet_offset
;
248 /* Default clock's current value */
249 uint64_t default_clock_snapshot
;
251 /* End of current packet snapshots */
252 struct end_of_packet_snapshots snapshots
;
254 /* End of previous packet snapshots */
255 struct end_of_packet_snapshots prev_packet_snapshots
;
257 /* Stored values (for sequence lengths, variant tags) */
258 GArray
*stored_values
;
260 /* Iterator's current log level */
261 bt_logging_level log_level
;
263 /* Iterator's owning self component, or `NULL` if none (query) */
264 bt_self_component
*self_comp
;
267 static inline const char *state_string(enum state state
)
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";
339 static struct stack
*stack_new(struct ctf_msg_iter
*msg_it
)
341 bt_self_component
*self_comp
= msg_it
->self_comp
;
342 struct stack
*stack
= NULL
;
344 stack
= g_new0(struct stack
, 1);
346 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to allocate one stack.");
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.");
357 BT_COMP_LOGD("Created stack: msg-it-addr=%p, stack-addr=%p", msg_it
, stack
);
368 static void stack_destroy(struct stack
*stack
)
370 struct ctf_msg_iter
*msg_it
;
372 BT_ASSERT_DBG(stack
);
373 msg_it
= stack
->msg_it
;
374 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
376 if (stack
->entries
) {
377 g_array_free(stack
->entries
, TRUE
);
383 static void stack_push(struct stack
*stack
, bt_field
*base
)
385 struct stack_entry
*entry
;
386 struct ctf_msg_iter
*msg_it
;
388 BT_ASSERT_DBG(stack
);
389 msg_it
= stack
->msg_it
;
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);
395 if (stack
->entries
->len
== stack
->size
) {
396 g_array_set_size(stack
->entries
, stack
->size
+ 1);
399 entry
= &bt_g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
405 static inline unsigned int stack_size(struct stack
*stack
)
407 BT_ASSERT_DBG(stack
);
411 static void stack_pop(struct stack
*stack
)
413 struct ctf_msg_iter
*msg_it
;
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);
424 static inline struct stack_entry
*stack_top(struct stack
*stack
)
426 BT_ASSERT_DBG(stack
);
427 BT_ASSERT_DBG(stack_size(stack
));
428 return &bt_g_array_index(stack
->entries
, struct stack_entry
, stack
->size
- 1);
431 static inline bool stack_empty(struct stack
*stack
)
433 return stack_size(stack
) == 0;
436 static void stack_clear(struct stack
*stack
)
438 BT_ASSERT_DBG(stack
);
442 static inline enum ctf_msg_iter_status
443 msg_iter_status_from_m_status(enum ctf_msg_iter_medium_status m_status
)
445 /* They are the same */
446 return (ctf_msg_iter_status
) m_status
;
449 static inline size_t buf_size_bits(struct ctf_msg_iter
*msg_it
)
451 return msg_it
->buf
.sz
* 8;
454 static inline size_t buf_available_bits(struct ctf_msg_iter
*msg_it
)
456 return buf_size_bits(msg_it
) - msg_it
->buf
.at
;
459 static inline size_t packet_at(struct ctf_msg_iter
*msg_it
)
461 return msg_it
->buf
.packet_offset
+ msg_it
->buf
.at
;
464 static inline void buf_consume_bits(struct ctf_msg_iter
*msg_it
, size_t incr
)
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
;
471 static enum ctf_msg_iter_status
request_medium_bytes(struct ctf_msg_iter
*msg_it
)
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
;
478 BT_COMP_LOGD("Calling user function (request bytes): msg-it-addr=%p, "
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);
488 /* New packet offset is old one + old size (in bits) */
489 msg_it
->buf
.packet_offset
+= buf_size_bits(msg_it
);
491 /* Restart at the beginning of the new medium buffer */
493 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
495 /* New medium buffer size */
496 msg_it
->buf
.sz
= buffer_sz
;
498 /* New medium buffer address */
499 msg_it
->buf
.addr
= buffer_addr
;
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
) {
507 * User returned end of stream: validate that we're not
508 * in the middle of a packet header, packet context, or
511 if (msg_it
->cur_exp_packet_total_size
>= 0) {
512 if (packet_at(msg_it
) == msg_it
->cur_exp_packet_total_size
) {
516 if (packet_at(msg_it
) == 0) {
520 if (msg_it
->buf
.last_eh_at
!= SIZE_MAX
&& msg_it
->buf
.at
== msg_it
->buf
.last_eh_at
) {
525 /* All other states are invalid */
526 BT_COMP_LOGE_APPEND_CAUSE(
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: "
539 ctf_msg_iter_medium_status_string(m_status
));
543 return msg_iter_status_from_m_status(m_status
);
546 static inline enum ctf_msg_iter_status
buf_ensure_available_bits(struct ctf_msg_iter
*msg_it
)
548 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
550 if (G_UNLIKELY(buf_available_bits(msg_it
) == 0)) {
552 * This _cannot_ return CTF_MSG_ITER_STATUS_OK
555 status
= request_medium_bytes(msg_it
);
561 static enum ctf_msg_iter_status
562 read_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
)
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
;
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
,
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
);
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
;
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
;
588 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
589 "BFCR failed to start: msg-it-addr=%p, bfcr-addr=%p, "
591 msg_it
, msg_it
->bfcr
, bt_bfcr_status_string(bfcr_status
));
592 status
= CTF_MSG_ITER_STATUS_ERROR
;
596 /* Consume bits now since we know we're not in an error state */
597 buf_consume_bits(msg_it
, consumed_bits
);
603 static enum ctf_msg_iter_status
read_dscope_continue_state(struct ctf_msg_iter
*msg_it
,
604 enum state done_state
)
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
;
611 BT_COMP_LOGT("Continuing BFCR: msg-it-addr=%p, bfcr-addr=%p", msg_it
, msg_it
->bfcr
);
613 status
= buf_ensure_available_bits(msg_it
);
614 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
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
));
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
));
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
);
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
;
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.");
643 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
644 "BFCR failed to continue: msg-it-addr=%p, bfcr-addr=%p, "
646 msg_it
, msg_it
->bfcr
, bt_bfcr_status_string(bfcr_status
));
647 status
= CTF_MSG_ITER_STATUS_ERROR
;
651 /* Consume bits now since we know we're not in an error state. */
652 buf_consume_bits(msg_it
, consumed_bits
);
657 static void release_event_dscopes(struct ctf_msg_iter
*msg_it
)
659 msg_it
->dscopes
.event_common_context
= NULL
;
660 msg_it
->dscopes
.event_spec_context
= NULL
;
661 msg_it
->dscopes
.event_payload
= NULL
;
664 static void release_all_dscopes(struct ctf_msg_iter
*msg_it
)
666 msg_it
->dscopes
.stream_packet_context
= NULL
;
668 release_event_dscopes(msg_it
);
671 static enum ctf_msg_iter_status
switch_packet_state(struct ctf_msg_iter
*msg_it
)
673 enum ctf_msg_iter_status status
;
674 bt_self_component
*self_comp
= msg_it
->self_comp
;
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).
683 if (msg_it
->cur_exp_packet_total_size
!= -1) {
684 msg_it
->cur_packet_offset
+= msg_it
->cur_exp_packet_total_size
;
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
;
697 if (msg_it
->medium
.medops
.switch_packet
) {
698 enum ctf_msg_iter_medium_status medium_status
;
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
;
706 } else if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
707 status
= msg_iter_status_from_m_status(medium_status
);
712 * After the packet switch, the medium might want to give us a
713 * different buffer for the new packet.
715 status
= request_medium_bytes(msg_it
);
716 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
722 * Adjust current buffer so that addr points to the beginning of the new
725 if (msg_it
->buf
.addr
) {
726 size_t consumed_bytes
= (size_t) (msg_it
->buf
.at
/ CHAR_BIT
);
728 /* Packets are assumed to start on a byte frontier. */
729 if (msg_it
->buf
.at
% CHAR_BIT
) {
730 BT_COMP_LOGE_APPEND_CAUSE(
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
;
739 msg_it
->buf
.addr
+= consumed_bytes
;
740 msg_it
->buf
.sz
-= consumed_bytes
;
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
);
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
;
758 status
= CTF_MSG_ITER_STATUS_OK
;
763 static enum ctf_msg_iter_status
read_packet_header_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
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.
774 status
= buf_ensure_available_bits(msg_it
);
776 case CTF_MSG_ITER_STATUS_OK
:
778 case CTF_MSG_ITER_STATUS_EOF
:
779 status
= CTF_MSG_ITER_STATUS_OK
;
780 msg_it
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
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
;
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
);
802 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
803 "Cannot decode packet header field: "
804 "msg-it-addr=%p, trace-class-addr=%p, "
806 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
813 static enum ctf_msg_iter_status
read_packet_header_continue_state(struct ctf_msg_iter
*msg_it
)
815 return read_dscope_continue_state(msg_it
, STATE_AFTER_TRACE_PACKET_HEADER
);
818 static inline enum ctf_msg_iter_status
set_current_stream_class(struct ctf_msg_iter
*msg_it
)
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
;
824 if (msg_it
->cur_stream_class_id
== -1) {
826 * No current stream class ID field, therefore only one
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: "
835 status
= CTF_MSG_ITER_STATUS_ERROR
;
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
;
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(
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
;
856 if (msg_it
->meta
.sc
) {
857 if (new_stream_class
!= msg_it
->meta
.sc
) {
858 BT_COMP_LOGE_APPEND_CAUSE(
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
", "
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
;
872 msg_it
->meta
.sc
= new_stream_class
;
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
);
884 static inline enum ctf_msg_iter_status
set_current_stream(struct ctf_msg_iter
*msg_it
)
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
;
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
);
898 BT_COMP_LOGE_APPEND_CAUSE(
900 "User function failed to return a stream object for the given stream class.");
901 status
= CTF_MSG_ITER_STATUS_ERROR
;
905 if (msg_it
->stream
&& stream
!= msg_it
->stream
) {
906 BT_COMP_LOGE_APPEND_CAUSE(
908 "User function returned a different stream than the previous one for the same sequence of packets.");
909 status
= CTF_MSG_ITER_STATUS_ERROR
;
913 BT_STREAM_MOVE_REF(msg_it
->stream
, stream
);
916 bt_stream_put_ref(stream
);
920 static inline enum ctf_msg_iter_status
set_current_packet(struct ctf_msg_iter
*msg_it
)
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
;
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
);
933 BT_ASSERT(msg_it
->stream
);
934 packet
= bt_packet_create(msg_it
->stream
);
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
);
948 BT_PACKET_PUT_REF_AND_RESET(packet
);
949 status
= CTF_MSG_ITER_STATUS_ERROR
;
952 BT_PACKET_MOVE_REF(msg_it
->packet
, packet
);
956 static enum ctf_msg_iter_status
after_packet_header_state(struct ctf_msg_iter
*msg_it
)
958 enum ctf_msg_iter_status status
;
960 status
= set_current_stream_class(msg_it
);
961 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
965 if (!msg_it
->dry_run
) {
966 status
= set_current_stream(msg_it
);
967 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
971 status
= set_current_packet(msg_it
);
972 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
977 msg_it
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
979 status
= CTF_MSG_ITER_STATUS_OK
;
985 static enum ctf_msg_iter_status
read_packet_context_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
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
;
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
);
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
);
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
);
1028 static enum ctf_msg_iter_status
read_packet_context_continue_state(struct ctf_msg_iter
*msg_it
)
1030 return read_dscope_continue_state(msg_it
, STATE_AFTER_STREAM_PACKET_CONTEXT
);
1033 static enum ctf_msg_iter_status
set_current_packet_content_sizes(struct ctf_msg_iter
*msg_it
)
1035 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1036 bt_self_component
*self_comp
= msg_it
->self_comp
;
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
;
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
;
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));
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
;
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
);
1073 static enum ctf_msg_iter_status
after_packet_context_state(struct ctf_msg_iter
*msg_it
)
1075 enum ctf_msg_iter_status status
;
1077 status
= set_current_packet_content_sizes(msg_it
);
1078 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1082 if (msg_it
->emit_stream_beginning_message
) {
1083 msg_it
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1085 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1092 static enum ctf_msg_iter_status
read_event_header_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
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;
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, "
1108 msg_it
, packet_at(msg_it
));
1109 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1111 } else if (G_UNLIKELY(packet_at(msg_it
) > msg_it
->cur_exp_packet_content_size
)) {
1112 /* That's not supposed to happen */
1114 "Before decoding event header field: cursor is passed the packet's content: "
1115 "msg-it-addr=%p, content-size=%" PRId64
", "
1117 msg_it
, msg_it
->cur_exp_packet_content_size
, packet_at(msg_it
));
1118 status
= CTF_MSG_ITER_STATUS_ERROR
;
1123 * "Infinite" content: we're done when the medium has
1124 * nothing else for us.
1126 status
= buf_ensure_available_bits(msg_it
);
1128 case CTF_MSG_ITER_STATUS_OK
:
1130 case CTF_MSG_ITER_STATUS_EOF
:
1131 status
= CTF_MSG_ITER_STATUS_OK
;
1132 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
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
;
1147 BT_COMP_LOGD("Decoding event header field: "
1148 "msg-it-addr=%p, stream-class-addr=%p, "
1149 "stream-class-id=%" PRId64
", "
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
);
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
);
1166 static enum ctf_msg_iter_status
read_event_header_continue_state(struct ctf_msg_iter
*msg_it
)
1168 return read_dscope_continue_state(msg_it
, STATE_AFTER_EVENT_HEADER
);
1171 static inline enum ctf_msg_iter_status
set_current_event_class(struct ctf_msg_iter
*msg_it
)
1173 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1174 bt_self_component
*self_comp
= msg_it
->self_comp
;
1176 struct ctf_event_class
*new_event_class
= NULL
;
1178 if (msg_it
->cur_event_class_id
== -1) {
1180 * No current event class ID field, therefore only one
1183 if (msg_it
->meta
.sc
->event_classes
->len
!= 1) {
1184 BT_COMP_LOGE_APPEND_CAUSE(
1186 "Need exactly one event class since there's no event class ID field: "
1189 status
= CTF_MSG_ITER_STATUS_ERROR
;
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
;
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(
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
;
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
);
1222 static inline enum ctf_msg_iter_status
set_current_event_message(struct ctf_msg_iter
*msg_it
)
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
;
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
);
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
);
1241 msg
= bt_message_event_create_with_packet(msg_it
->self_msg_iter
, msg_it
->meta
.ec
->ir_ec
,
1246 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1247 "Cannot create event message: "
1248 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1250 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
,
1258 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1259 status
= CTF_MSG_ITER_STATUS_ERROR
;
1262 BT_MESSAGE_MOVE_REF(msg_it
->event_msg
, msg
);
1266 static enum ctf_msg_iter_status
after_event_header_state(struct ctf_msg_iter
*msg_it
)
1268 enum ctf_msg_iter_status status
;
1270 status
= set_current_event_class(msg_it
);
1271 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1275 if (G_UNLIKELY(msg_it
->dry_run
)) {
1279 status
= set_current_event_message(msg_it
);
1280 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1284 msg_it
->event
= bt_message_event_borrow_event(msg_it
->event_msg
);
1285 BT_ASSERT_DBG(msg_it
->event
);
1288 msg_it
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1294 static enum ctf_msg_iter_status
read_event_common_context_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
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
;
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
);
1312 BT_COMP_LOGT("Decoding event common context field: "
1313 "msg-it-addr=%p, stream-class-addr=%p, "
1314 "stream-class-id=%" PRId64
", "
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
);
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
);
1333 static enum ctf_msg_iter_status
1334 read_event_common_context_continue_state(struct ctf_msg_iter
*msg_it
)
1336 return read_dscope_continue_state(msg_it
, STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1339 static enum ctf_msg_iter_status
read_event_spec_context_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
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
;
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
);
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
", "
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
);
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
);
1380 static enum ctf_msg_iter_status
read_event_spec_context_continue_state(struct ctf_msg_iter
*msg_it
)
1382 return read_dscope_continue_state(msg_it
, STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1385 static enum ctf_msg_iter_status
read_event_payload_begin_state(struct ctf_msg_iter
*msg_it
)
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
;
1391 event_payload_fc
= msg_it
->meta
.ec
->payload_fc
;
1392 if (!event_payload_fc
) {
1393 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
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
);
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
", "
1407 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
, msg_it
->meta
.ec
->id
,
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
);
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
);
1426 static enum ctf_msg_iter_status
read_event_payload_continue_state(struct ctf_msg_iter
*msg_it
)
1428 return read_dscope_continue_state(msg_it
, STATE_EMIT_MSG_EVENT
);
1431 static enum ctf_msg_iter_status
skip_packet_padding_state(struct ctf_msg_iter
*msg_it
)
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
;
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
;
1443 size_t bits_to_consume
;
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
) {
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
;
1467 static enum ctf_msg_iter_status
check_emit_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
1469 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1471 if (!msg_it
->meta
.sc
->has_discarded_events
) {
1472 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
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)) {
1480 * Stream's first packet with no discarded
1481 * events or no information about discarded
1482 * events: do not emit.
1484 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1488 * If the previous packet has a value for this counter,
1489 * then this counter is defined for the whole stream.
1491 BT_ASSERT(msg_it
->snapshots
.discarded_events
!= UINT64_C(-1));
1493 if (msg_it
->snapshots
.discarded_events
- msg_it
->prev_packet_snapshots
.discarded_events
==
1496 * No discarded events since previous packet: do
1499 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1504 return CTF_MSG_ITER_STATUS_OK
;
1507 static enum ctf_msg_iter_status
check_emit_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
1509 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1511 if (!msg_it
->meta
.sc
->has_discarded_packets
) {
1512 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1516 if (msg_it
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
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).
1525 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1528 * If the previous packet has a value for this counter,
1529 * then this counter is defined for the whole stream.
1531 BT_ASSERT(msg_it
->snapshots
.packets
!= UINT64_C(-1));
1533 if (msg_it
->snapshots
.packets
- msg_it
->prev_packet_snapshots
.packets
<= 1) {
1535 * No discarded packets since previous packet:
1538 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1543 return CTF_MSG_ITER_STATUS_OK
;
1546 static inline enum state
check_emit_msg_stream_end(struct ctf_msg_iter
*msg_it
)
1548 enum state next_state
;
1550 if (msg_it
->emit_stream_end_message
) {
1551 next_state
= STATE_EMIT_MSG_STREAM_END
;
1553 next_state
= STATE_DONE
;
1559 static inline enum ctf_msg_iter_status
handle_state(struct ctf_msg_iter
*msg_it
)
1561 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1562 const enum state state
= msg_it
->state
;
1564 BT_COMP_LOGT("Handling state: msg-it-addr=%p, state=%s", msg_it
, state_string(state
));
1566 // TODO: optimalize!
1569 msg_it
->state
= STATE_SWITCH_PACKET
;
1571 case STATE_SWITCH_PACKET
:
1572 status
= switch_packet_state(msg_it
);
1574 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1575 status
= read_packet_header_begin_state(msg_it
);
1577 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1578 status
= read_packet_header_continue_state(msg_it
);
1580 case STATE_AFTER_TRACE_PACKET_HEADER
:
1581 status
= after_packet_header_state(msg_it
);
1583 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1584 status
= read_packet_context_begin_state(msg_it
);
1586 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1587 status
= read_packet_context_continue_state(msg_it
);
1589 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1590 status
= after_packet_context_state(msg_it
);
1592 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1593 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1595 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1596 status
= check_emit_msg_discarded_events(msg_it
);
1598 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1599 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1601 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1602 status
= check_emit_msg_discarded_packets(msg_it
);
1604 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1605 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1607 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1608 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1610 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1611 status
= read_event_header_begin_state(msg_it
);
1613 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1614 status
= read_event_header_continue_state(msg_it
);
1616 case STATE_AFTER_EVENT_HEADER
:
1617 status
= after_event_header_state(msg_it
);
1619 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1620 status
= read_event_common_context_begin_state(msg_it
);
1622 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1623 status
= read_event_common_context_continue_state(msg_it
);
1625 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1626 status
= read_event_spec_context_begin_state(msg_it
);
1628 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1629 status
= read_event_spec_context_continue_state(msg_it
);
1631 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1632 status
= read_event_payload_begin_state(msg_it
);
1634 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1635 status
= read_event_payload_continue_state(msg_it
);
1637 case STATE_EMIT_MSG_EVENT
:
1638 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1640 case STATE_EMIT_QUEUED_MSG_EVENT
:
1641 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1643 case STATE_SKIP_PACKET_PADDING
:
1644 status
= skip_packet_padding_state(msg_it
);
1646 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1647 msg_it
->state
= STATE_SKIP_PACKET_PADDING
;
1649 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1650 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
1652 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
1653 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1655 case STATE_CHECK_EMIT_MSG_STREAM_END
:
1656 msg_it
->state
= check_emit_msg_stream_end(msg_it
);
1658 case STATE_EMIT_MSG_STREAM_END
:
1659 msg_it
->state
= STATE_DONE
;
1664 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1665 "msg-it-addr=%p, state=%d",
1666 msg_it
, msg_it
->state
);
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
));
1677 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter
*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
;
1690 msg_it
->buf
.addr
= NULL
;
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);
1705 * Resets the internal state of a CTF message iterator.
1707 void ctf_msg_iter_reset(struct ctf_msg_iter
*msg_it
)
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;
1722 static bt_field
*borrow_next_field(struct ctf_msg_iter
*msg_it
)
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
;
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
);
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
);
1752 BT_ASSERT_DBG(next_field
);
1756 static void update_default_clock(struct ctf_msg_iter
*msg_it
, uint64_t new_val
,
1757 uint64_t new_val_size
)
1759 uint64_t new_val_mask
;
1760 uint64_t cur_value_masked
;
1762 BT_ASSERT_DBG(new_val_size
> 0);
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.
1769 if (new_val_size
== 64) {
1770 msg_it
->default_clock_snapshot
= new_val
;
1774 new_val_mask
= (1ULL << new_val_size
) - 1;
1775 cur_value_masked
= msg_it
->default_clock_snapshot
& new_val_mask
;
1777 if (new_val
< cur_value_masked
) {
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.
1783 msg_it
->default_clock_snapshot
+= new_val_mask
+ 1;
1786 /* Clear the low bits of the current clock value. */
1787 msg_it
->default_clock_snapshot
&= ~new_val_mask
;
1789 /* Set the low bits of the current clock value. */
1790 msg_it
->default_clock_snapshot
|= new_val
;
1793 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1795 msg_it
->default_clock_snapshot
);
1799 * Ensure the message iterator's `stored_values` array is large enough to
1800 * accomodate `storing_index`.
1802 * We may need more slots in the array than initially allocated if more
1803 * metadata arrives along the way.
1805 static void ensure_stored_values_size(ctf_msg_iter
*msg_it
, uint64_t storing_index
)
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
);
1812 static enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
, struct ctf_field_class
*fc
,
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
;
1819 bt_field
*field
= NULL
;
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
);
1826 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
1828 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1829 goto update_def_clock
;
1832 switch (int_fc
->meaning
) {
1833 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1834 msg_it
->cur_event_class_id
= value
;
1836 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1837 msg_it
->cur_data_stream_id
= value
;
1839 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1840 msg_it
->snapshots
.beginning_clock
= value
;
1842 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1843 msg_it
->snapshots
.end_clock
= value
;
1845 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1846 msg_it
->cur_stream_class_id
= value
;
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, "
1854 status
= BT_BFCR_STATUS_ERROR
;
1859 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1860 msg_it
->snapshots
.packets
= value
;
1862 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1863 msg_it
->snapshots
.discarded_events
= value
;
1865 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1866 msg_it
->cur_exp_packet_total_size
= value
;
1868 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1869 msg_it
->cur_exp_packet_content_size
= value
;
1876 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
1877 update_default_clock(msg_it
, value
, int_fc
->base
.size
);
1880 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1881 ensure_stored_values_size(msg_it
, int_fc
->storing_index
);
1882 bt_g_array_index(msg_it
->stored_values
, uint64_t, (uint64_t) int_fc
->storing_index
) = value
;
1885 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
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
++;
1901 static enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
, struct ctf_field_class
*fc
,
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
;
1909 char str
[2] = {'\0', '\0'};
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
);
1916 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
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);
1921 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
1925 if (msg_it
->done_filling_string
) {
1930 msg_it
->done_filling_string
= true;
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
);
1937 /* Append character */
1938 str
[0] = (char) value
;
1939 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
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
;
1953 static enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
, struct ctf_field_class
*fc
, void *data
)
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
;
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
);
1964 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
1965 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1967 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1968 ensure_stored_values_size(msg_it
, int_fc
->storing_index
);
1969 bt_g_array_index(msg_it
->stored_values
, uint64_t, (uint64_t) int_fc
->storing_index
) =
1973 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
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
);
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
++;
1989 static enum bt_bfcr_status
bfcr_floating_point_cb(double value
, struct ctf_field_class
*fc
,
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
;
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
);
2002 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
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
));
2012 if (type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
2013 bt_field_real_single_precision_set_value(field
, (float) value
);
2015 bt_field_real_double_precision_set_value(field
, value
);
2017 stack_top(msg_it
->stack
)->index
++;
2023 static enum bt_bfcr_status
bfcr_string_begin_cb(struct ctf_field_class
*fc
, void *data
)
2025 bt_field
*field
= NULL
;
2026 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
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
);
2033 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
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
);
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().
2048 stack_push(msg_it
->stack
, field
);
2051 return BT_BFCR_STATUS_OK
;
2054 static enum bt_bfcr_status
bfcr_string_cb(const char *value
, size_t len
, struct ctf_field_class
*fc
,
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
;
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
);
2068 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2072 field
= stack_top(msg_it
->stack
)->base
;
2073 BT_ASSERT_DBG(field
);
2075 /* Append current substring */
2076 ret
= bt_field_string_append_with_length(field
, value
, len
);
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, "
2082 msg_it
, field
, len
, ret
);
2083 status
= BT_BFCR_STATUS_ERROR
;
2091 static enum bt_bfcr_status
bfcr_string_end_cb(struct ctf_field_class
*fc
, void *data
)
2093 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
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
);
2100 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2104 /* Pop string field */
2105 stack_pop(msg_it
->stack
);
2107 /* Go to next field */
2108 stack_top(msg_it
->stack
)->index
++;
2111 return BT_BFCR_STATUS_OK
;
2114 static enum bt_bfcr_status
bfcr_compound_begin_cb(struct ctf_field_class
*fc
, void *data
)
2116 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
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
);
2124 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2129 if (stack_empty(msg_it
->stack
)) {
2130 /* Root: already set by read_dscope_begin_state() */
2131 field
= msg_it
->cur_dscope_field
;
2133 field
= borrow_next_field(msg_it
);
2134 BT_ASSERT_DBG(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
);
2143 * Change BFCR "unsigned int" callback if it's a text
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
);
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
);
2158 return BT_BFCR_STATUS_OK
;
2161 static enum bt_bfcr_status
bfcr_compound_end_cb(struct ctf_field_class
*fc
, void *data
)
2163 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
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
);
2170 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
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
);
2178 * Reset BFCR "unsigned int" callback if it's a text
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
);
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
);
2192 stack_pop(msg_it
->stack
);
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
++;
2200 return BT_BFCR_STATUS_OK
;
2203 static int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
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
);
2213 (uint64_t) bt_g_array_index(msg_it
->stored_values
, uint64_t, seq_fc
->stored_length_index
);
2215 if (G_UNLIKELY(msg_it
->dry_run
)) {
2219 seq_field
= stack_top(msg_it
->stack
)->base
;
2220 BT_ASSERT_DBG(seq_field
);
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.
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
);
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, "
2237 msg_it
, seq_field
, length
);
2246 static struct ctf_field_class
*
2247 bfcr_borrow_variant_selected_field_class_cb(struct ctf_field_class
*fc
, void *data
)
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
;
2263 /* Get variant's tag */
2264 tag
.u
= bt_g_array_index(msg_it
->stored_values
, uint64_t, var_fc
->stored_tag_index
);
2267 * Check each range to find the selected option's index.
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
);
2274 if (tag
.i
>= range
->range
.lower
.i
&& tag
.i
<= range
->range
.upper
.i
) {
2275 option_index
= (int64_t) range
->option_index
;
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
);
2284 if (tag
.u
>= range
->range
.lower
.u
&& tag
.u
<= range
->range
.upper
.u
) {
2285 option_index
= (int64_t) range
->option_index
;
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
", "
2296 msg_it
, var_fc
, tag
.u
, tag
.i
);
2302 ctf_field_class_variant_borrow_option_by_index(var_fc
, (uint64_t) option_index
);
2304 if (selected_option
->fc
->in_ir
&& !msg_it
->dry_run
) {
2305 bt_field
*var_field
= stack_top(msg_it
->stack
)->base
;
2307 ret
= bt_field_variant_select_option_by_index(var_field
, option_index
);
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
);
2319 ret_fc
= selected_option
->fc
;
2325 static bt_message
*create_msg_stream_beginning(struct ctf_msg_iter
*msg_it
)
2327 bt_self_component
*self_comp
= msg_it
->self_comp
;
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
);
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
);
2343 static bt_message
*create_msg_stream_end(struct ctf_msg_iter
*msg_it
)
2345 bt_self_component
*self_comp
= msg_it
->self_comp
;
2348 if (!msg_it
->stream
) {
2349 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2350 "Cannot create stream end message because stream is NULL: "
2357 BT_ASSERT(msg_it
->self_msg_iter
);
2358 msg
= bt_message_stream_end_create(msg_it
->self_msg_iter
, msg_it
->stream
);
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
);
2370 static bt_message
*create_msg_packet_beginning(struct ctf_msg_iter
*msg_it
, bool use_default_cs
)
2372 bt_self_component
*self_comp
= msg_it
->self_comp
;
2374 const bt_stream_class
*sc
= msg_it
->meta
.sc
->ir_sc
;
2376 BT_ASSERT(msg_it
->packet
);
2378 BT_ASSERT(msg_it
->self_msg_iter
);
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
;
2385 * Either use the decoded packet `timestamp_begin` field or the
2386 * current stream's default clock_snapshot.
2388 if (use_default_cs
) {
2389 raw_cs_value
= msg_it
->default_clock_snapshot
;
2391 raw_cs_value
= msg_it
->snapshots
.beginning_clock
;
2394 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2395 msg_it
->self_msg_iter
, msg_it
->packet
, raw_cs_value
);
2397 msg
= bt_message_packet_beginning_create(msg_it
->self_msg_iter
, msg_it
->packet
);
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
);
2412 static bt_message
*emit_delayed_packet_beg_msg(struct ctf_msg_iter
*msg_it
)
2414 bool packet_beg_ts_need_fix_up
;
2416 msg_it
->emit_delayed_packet_beginning_msg
= false;
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.
2424 packet_beg_ts_need_fix_up
= msg_it
->default_clock_snapshot
< msg_it
->snapshots
.beginning_clock
;
2426 /* create_msg_packet_beginning() logs errors */
2427 return create_msg_packet_beginning(msg_it
, packet_beg_ts_need_fix_up
);
2430 static bt_message
*create_msg_packet_end(struct ctf_msg_iter
*msg_it
)
2433 bool update_default_cs
= true;
2434 bt_self_component
*self_comp
= msg_it
->self_comp
;
2436 if (!msg_it
->packet
) {
2442 * Check if we need to emit the delayed packet
2443 * beginning message instead of the packet end message.
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
;
2452 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2453 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.lttng_crash
)) {
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.
2461 if (msg_it
->snapshots
.beginning_clock
!= 0 && msg_it
->snapshots
.end_clock
== 0) {
2462 update_default_cs
= false;
2467 * Check if may be affected by lttng event-after-packet `timestamp_end`
2470 if (msg_it
->meta
.tc
->quirks
.lttng_event_after_packet
) {
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.
2479 if (msg_it
->snapshots
.end_clock
< msg_it
->default_clock_snapshot
) {
2480 update_default_cs
= false;
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
;
2489 BT_ASSERT(msg_it
->self_msg_iter
);
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
);
2496 msg
= bt_message_packet_end_create(msg_it
->self_msg_iter
, msg_it
->packet
);
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
);
2507 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2513 static bt_message
*create_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
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);
2520 BT_ASSERT(msg_it
->self_msg_iter
);
2521 BT_ASSERT(msg_it
->stream
);
2522 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_events
);
2524 if (msg_it
->meta
.sc
->discarded_events_have_default_cs
) {
2525 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
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.
2531 beginning_raw_value
= msg_it
->snapshots
.beginning_clock
;
2532 end_raw_value
= msg_it
->snapshots
.end_clock
;
2534 beginning_raw_value
= msg_it
->prev_packet_snapshots
.end_clock
;
2535 end_raw_value
= msg_it
->snapshots
.end_clock
;
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
);
2543 msg
= bt_message_discarded_events_create(msg_it
->self_msg_iter
, msg_it
->stream
);
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
);
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
);
2564 static bt_message
*create_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
2567 bt_self_component
*self_comp
= msg_it
->self_comp
;
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));
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
);
2581 msg
= bt_message_discarded_packets_create(msg_it
->self_msg_iter
, msg_it
->stream
);
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
);
2592 bt_message_discarded_packets_set_count(msg
, msg_it
->snapshots
.packets
-
2593 msg_it
->prev_packet_snapshots
.packets
- 1);
2599 struct 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
)
2604 struct ctf_msg_iter
*msg_it
= NULL
;
2605 struct bt_bfcr_cbs cbs
= {
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
,
2619 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2620 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2625 BT_ASSERT(medops
.request_bytes
);
2626 BT_ASSERT(medops
.borrow_stream
);
2627 BT_ASSERT(max_request_sz
> 0);
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);
2636 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2637 "Failed to allocate one CTF plugin message iterator.");
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
);
2651 if (!msg_it
->stack
) {
2652 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create field stack.");
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).");
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;
2673 ctf_msg_iter_destroy(msg_it
);
2678 void ctf_msg_iter_destroy(struct ctf_msg_iter
*msg_it
)
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
);
2684 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it
);
2686 if (msg_it
->stack
) {
2687 BT_COMP_LOGD_STR("Destroying field stack.");
2688 stack_destroy(msg_it
->stack
);
2692 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it
->bfcr
);
2693 bt_bfcr_destroy(msg_it
->bfcr
);
2696 if (msg_it
->stored_values
) {
2697 g_array_free(msg_it
->stored_values
, TRUE
);
2703 enum ctf_msg_iter_status
ctf_msg_iter_get_next_message(struct ctf_msg_iter
*msg_it
,
2704 const bt_message
**message
)
2706 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2707 bt_self_component
*self_comp
= msg_it
->self_comp
;
2709 BT_ASSERT_DBG(msg_it
);
2710 BT_ASSERT_DBG(message
);
2711 BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it
);
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.");
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
));
2724 switch (msg_it
->state
) {
2725 case STATE_EMIT_MSG_EVENT
:
2726 BT_ASSERT_DBG(msg_it
->event_msg
);
2729 * Check if we need to emit the delayed packet
2730 * beginning message instead of the event message.
2732 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2733 *message
= emit_delayed_packet_beg_msg(msg_it
);
2735 status
= CTF_MSG_ITER_STATUS_ERROR
;
2739 * Don't forget to emit the event message of
2740 * the event record that was just decoded.
2742 msg_it
->state
= STATE_EMIT_QUEUED_MSG_EVENT
;
2745 *message
= msg_it
->event_msg
;
2746 msg_it
->event_msg
= NULL
;
2749 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2750 /* create_msg_discared_events() logs errors */
2751 *message
= create_msg_discarded_events(msg_it
);
2754 status
= CTF_MSG_ITER_STATUS_ERROR
;
2758 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2759 /* create_msg_discared_packets() logs errors */
2760 *message
= create_msg_discarded_packets(msg_it
);
2763 status
= CTF_MSG_ITER_STATUS_ERROR
;
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;
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
2778 /* create_msg_packet_beginning() logs errors */
2779 *message
= create_msg_packet_beginning(msg_it
, false);
2781 status
= CTF_MSG_ITER_STATUS_ERROR
;
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
);
2792 status
= CTF_MSG_ITER_STATUS_ERROR
;
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;
2803 status
= CTF_MSG_ITER_STATUS_ERROR
;
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;
2813 status
= CTF_MSG_ITER_STATUS_ERROR
;
2818 status
= CTF_MSG_ITER_STATUS_EOF
;
2821 /* Non-emitting state: continue */
2830 static 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
)
2834 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2835 bt_self_component
*self_comp
= msg_it
->self_comp
;
2837 BT_ASSERT_DBG(msg_it
);
2841 * Check if we reached the state at which we want to stop
2844 if (msg_it
->state
== target_state_1
|| msg_it
->state
== target_state_2
) {
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.");
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
));
2858 switch (msg_it
->state
) {
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
:
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
));
2904 static enum ctf_msg_iter_status
read_packet_header_context_fields(struct ctf_msg_iter
*msg_it
)
2907 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2909 status
= decode_until_state(msg_it
, STATE_EMIT_MSG_PACKET_BEGINNING
, (state
) -1);
2910 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
2914 ret
= set_current_packet_content_sizes(msg_it
);
2916 status
= CTF_MSG_ITER_STATUS_ERROR
;
2924 enum ctf_msg_iter_status
ctf_msg_iter_seek(struct ctf_msg_iter
*msg_it
, off_t offset
)
2926 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2927 enum ctf_msg_iter_medium_status medium_status
;
2930 BT_ASSERT(offset
>= 0);
2931 BT_ASSERT(msg_it
->medium
.medops
.seek
);
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
;
2938 status
= CTF_MSG_ITER_STATUS_ERROR
;
2943 ctf_msg_iter_reset(msg_it
);
2944 msg_it
->cur_packet_offset
= offset
;
2950 static 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
)
2955 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
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
) {
2964 *clock_snapshot
= msg_it
->default_clock_snapshot
;
2969 enum ctf_msg_iter_status
2970 ctf_msg_iter_curr_packet_first_event_clock_snapshot(struct ctf_msg_iter
*msg_it
,
2971 uint64_t *first_clock_snapshot
)
2973 return clock_snapshot_at_msg_iter_state(msg_it
, STATE_AFTER_EVENT_HEADER
, (state
) -1,
2974 first_clock_snapshot
);
2977 enum ctf_msg_iter_status
2978 ctf_msg_iter_curr_packet_last_event_clock_snapshot(struct ctf_msg_iter
*msg_it
,
2979 uint64_t *last_clock_snapshot
)
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
);
2985 enum ctf_msg_iter_status
2986 ctf_msg_iter_get_packet_properties(struct ctf_msg_iter
*msg_it
,
2987 struct ctf_msg_iter_packet_properties
*props
)
2989 enum ctf_msg_iter_status status
;
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
) {
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
;
3011 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter
*msg_it
, bool val
)
3013 msg_it
->dry_run
= val
;