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
10 #define BT_COMP_LOG_SELF_COMP (msg_it->self_comp)
11 #define BT_LOG_OUTPUT_LEVEL (msg_it->log_level)
12 #define BT_LOG_TAG "PLUGIN/CTF/MSG-ITER"
13 #include "logging/comp-logging.h"
20 #include "common/assert.h"
22 #include <babeltrace2/babeltrace.h>
23 #include "common/common.h"
27 #include "msg-iter.hpp"
28 #include "../bfcr/bfcr.hpp"
32 /* A visit stack entry */
36 * Current base field, one of:
48 /* Index of next field to set */
57 struct ctf_msg_iter
*msg_it
;
59 /* Entries (struct stack_entry) */
62 /* Number of active entries */
71 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
72 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
73 STATE_AFTER_TRACE_PACKET_HEADER
,
74 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
75 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
76 STATE_AFTER_STREAM_PACKET_CONTEXT
,
77 STATE_EMIT_MSG_STREAM_BEGINNING
,
78 STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
,
79 STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
,
80 STATE_EMIT_MSG_DISCARDED_EVENTS
,
81 STATE_EMIT_MSG_DISCARDED_PACKETS
,
82 STATE_EMIT_MSG_PACKET_BEGINNING
,
83 STATE_DSCOPE_EVENT_HEADER_BEGIN
,
84 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
85 STATE_AFTER_EVENT_HEADER
,
86 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
,
87 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
88 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
89 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
90 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
91 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
93 STATE_EMIT_QUEUED_MSG_EVENT
,
94 STATE_SKIP_PACKET_PADDING
,
95 STATE_EMIT_MSG_PACKET_END_MULTI
,
96 STATE_EMIT_MSG_PACKET_END_SINGLE
,
97 STATE_EMIT_QUEUED_MSG_PACKET_END
,
98 STATE_CHECK_EMIT_MSG_STREAM_END
,
99 STATE_EMIT_MSG_STREAM_END
,
103 struct end_of_packet_snapshots
105 uint64_t discarded_events
;
107 uint64_t beginning_clock
;
111 /* CTF message iterator */
117 /* Current message iterator to create messages (weak) */
118 bt_self_message_iterator
*self_msg_iter
;
121 * True if library objects are unavailable during the decoding and
122 * should not be created/used.
127 * Current dynamic scope field pointer.
129 * This is set by read_dscope_begin_state() and contains the
130 * value of one of the pointers in `dscopes` below.
132 bt_field
*cur_dscope_field
;
135 * True if we're done filling a string field from a text
136 * array/sequence payload.
138 bool done_filling_string
;
140 /* Trace and classes */
141 /* True to set IR fields */
146 struct ctf_trace_class
*tc
;
147 struct ctf_stream_class
*sc
;
148 struct ctf_event_class
*ec
;
151 /* Current packet (NULL if not created yet) */
154 /* Current stream (NULL if not set yet) */
157 /* Current event (NULL if not created yet) */
160 /* Current event message (NULL if not created yet) */
161 bt_message
*event_msg
;
164 * True if we need to emit a packet beginning message before we emit
165 * the next event message or the packet end message.
167 bool emit_delayed_packet_beginning_msg
;
170 * True if this is the first packet we are reading, and therefore if we
171 * should emit a stream beginning message.
173 bool emit_stream_beginning_message
;
176 * True if we need to emit a stream end message at the end of the
177 * current stream. A live stream may never receive any data and thus
178 * never send a stream beginning message which removes the need to emit
179 * a stream end message.
181 bool emit_stream_end_message
;
183 /* Database of current dynamic scopes */
186 bt_field
*stream_packet_context
;
187 bt_field
*event_common_context
;
188 bt_field
*event_spec_context
;
189 bt_field
*event_payload
;
195 /* Current medium buffer data */
198 /* Last address provided by medium */
201 /* Buffer size provided by medium (bytes) */
204 /* Offset within whole packet of addr (bits) */
205 size_t packet_offset
;
207 /* Current position from addr (bits) */
210 /* Position of the last event header from addr (bits) */
214 /* Binary type reader */
215 struct bt_bfcr
*bfcr
;
217 /* Current medium data */
220 struct ctf_msg_iter_medium_ops medops
;
221 size_t max_request_sz
;
225 /* Current packet size (bits) (-1 if unknown) */
226 int64_t cur_exp_packet_total_size
;
228 /* Current content size (bits) (-1 if unknown) */
229 int64_t cur_exp_packet_content_size
;
231 /* Current stream class ID */
232 int64_t cur_stream_class_id
;
234 /* Current event class ID */
235 int64_t cur_event_class_id
;
237 /* Current data stream ID */
238 int64_t cur_data_stream_id
;
241 * Offset, in the underlying media, of the current packet's
242 * start (-1 if unknown).
244 off_t cur_packet_offset
;
246 /* Default clock's current value */
247 uint64_t default_clock_snapshot
;
249 /* End of current packet snapshots */
250 struct end_of_packet_snapshots snapshots
;
252 /* End of previous packet snapshots */
253 struct end_of_packet_snapshots prev_packet_snapshots
;
255 /* Stored values (for sequence lengths, variant tags) */
256 GArray
*stored_values
;
258 /* Iterator's current log level */
259 bt_logging_level log_level
;
261 /* Iterator's owning self component, or `NULL` if none (query) */
262 bt_self_component
*self_comp
;
265 static inline const char *state_string(enum state state
)
270 case STATE_SWITCH_PACKET
:
271 return "SWITCH_PACKET";
272 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
273 return "DSCOPE_TRACE_PACKET_HEADER_BEGIN";
274 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
275 return "DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
276 case STATE_AFTER_TRACE_PACKET_HEADER
:
277 return "AFTER_TRACE_PACKET_HEADER";
278 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
279 return "DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
280 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
281 return "DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
282 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
283 return "AFTER_STREAM_PACKET_CONTEXT";
284 case STATE_EMIT_MSG_STREAM_BEGINNING
:
285 return "EMIT_MSG_STREAM_BEGINNING";
286 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
287 return "CHECK_EMIT_MSG_DISCARDED_EVENTS";
288 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
289 return "CHECK_EMIT_MSG_DISCARDED_PACKETS";
290 case STATE_EMIT_MSG_PACKET_BEGINNING
:
291 return "EMIT_MSG_PACKET_BEGINNING";
292 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
293 return "EMIT_MSG_DISCARDED_EVENTS";
294 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
295 return "EMIT_MSG_DISCARDED_PACKETS";
296 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
297 return "DSCOPE_EVENT_HEADER_BEGIN";
298 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
299 return "DSCOPE_EVENT_HEADER_CONTINUE";
300 case STATE_AFTER_EVENT_HEADER
:
301 return "AFTER_EVENT_HEADER";
302 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
303 return "DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
304 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
305 return "DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
306 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
307 return "DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
308 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
309 return "DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
310 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
311 return "DSCOPE_EVENT_PAYLOAD_BEGIN";
312 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
313 return "DSCOPE_EVENT_PAYLOAD_CONTINUE";
314 case STATE_EMIT_MSG_EVENT
:
315 return "EMIT_MSG_EVENT";
316 case STATE_EMIT_QUEUED_MSG_EVENT
:
317 return "EMIT_QUEUED_MSG_EVENT";
318 case STATE_SKIP_PACKET_PADDING
:
319 return "SKIP_PACKET_PADDING";
320 case STATE_EMIT_MSG_PACKET_END_MULTI
:
321 return "EMIT_MSG_PACKET_END_MULTI";
322 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
323 return "EMIT_MSG_PACKET_END_SINGLE";
324 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
325 return "EMIT_QUEUED_MSG_PACKET_END";
326 case STATE_CHECK_EMIT_MSG_STREAM_END
:
327 return "CHECK_EMIT_MSG_STREAM_END";
328 case STATE_EMIT_MSG_STREAM_END
:
329 return "EMIT_MSG_STREAM_END";
337 static struct stack
*stack_new(struct ctf_msg_iter
*msg_it
)
339 bt_self_component
*self_comp
= msg_it
->self_comp
;
340 struct stack
*stack
= NULL
;
342 stack
= g_new0(struct stack
, 1);
344 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to allocate one stack.");
348 stack
->msg_it
= msg_it
;
349 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
350 if (!stack
->entries
) {
351 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to allocate a GArray.");
355 BT_COMP_LOGD("Created stack: msg-it-addr=%p, stack-addr=%p", msg_it
, stack
);
366 static void stack_destroy(struct stack
*stack
)
368 struct ctf_msg_iter
*msg_it
;
370 BT_ASSERT_DBG(stack
);
371 msg_it
= stack
->msg_it
;
372 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
374 if (stack
->entries
) {
375 g_array_free(stack
->entries
, TRUE
);
381 static void stack_push(struct stack
*stack
, bt_field
*base
)
383 struct stack_entry
*entry
;
384 struct ctf_msg_iter
*msg_it
;
386 BT_ASSERT_DBG(stack
);
387 msg_it
= stack
->msg_it
;
389 BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, "
390 "stack-size-before=%zu, stack-size-after=%zu",
391 stack
, stack
->size
, stack
->size
+ 1);
393 if (stack
->entries
->len
== stack
->size
) {
394 g_array_set_size(stack
->entries
, stack
->size
+ 1);
397 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
403 static inline unsigned int stack_size(struct stack
*stack
)
405 BT_ASSERT_DBG(stack
);
409 static void stack_pop(struct stack
*stack
)
411 struct ctf_msg_iter
*msg_it
;
413 BT_ASSERT_DBG(stack
);
414 BT_ASSERT_DBG(stack_size(stack
));
415 msg_it
= stack
->msg_it
;
416 BT_COMP_LOGT("Popping from stack: "
417 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
418 stack
, stack
->size
, stack
->size
- 1);
422 static inline struct stack_entry
*stack_top(struct stack
*stack
)
424 BT_ASSERT_DBG(stack
);
425 BT_ASSERT_DBG(stack_size(stack
));
426 return &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
- 1);
429 static inline bool stack_empty(struct stack
*stack
)
431 return stack_size(stack
) == 0;
434 static void stack_clear(struct stack
*stack
)
436 BT_ASSERT_DBG(stack
);
440 static inline enum ctf_msg_iter_status
441 msg_iter_status_from_m_status(enum ctf_msg_iter_medium_status m_status
)
443 /* They are the same */
444 return (ctf_msg_iter_status
) m_status
;
447 static inline size_t buf_size_bits(struct ctf_msg_iter
*msg_it
)
449 return msg_it
->buf
.sz
* 8;
452 static inline size_t buf_available_bits(struct ctf_msg_iter
*msg_it
)
454 return buf_size_bits(msg_it
) - msg_it
->buf
.at
;
457 static inline size_t packet_at(struct ctf_msg_iter
*msg_it
)
459 return msg_it
->buf
.packet_offset
+ msg_it
->buf
.at
;
462 static inline void buf_consume_bits(struct ctf_msg_iter
*msg_it
, size_t incr
)
464 BT_COMP_LOGT("Advancing cursor: msg-it-addr=%p, cur-before=%zu, cur-after=%zu", msg_it
,
465 msg_it
->buf
.at
, msg_it
->buf
.at
+ incr
);
466 msg_it
->buf
.at
+= incr
;
469 static enum ctf_msg_iter_status
request_medium_bytes(struct ctf_msg_iter
*msg_it
)
471 bt_self_component
*self_comp
= msg_it
->self_comp
;
472 uint8_t *buffer_addr
= NULL
;
473 size_t buffer_sz
= 0;
474 enum ctf_msg_iter_medium_status m_status
;
476 BT_COMP_LOGD("Calling user function (request bytes): msg-it-addr=%p, "
478 msg_it
, msg_it
->medium
.max_request_sz
);
479 m_status
= msg_it
->medium
.medops
.request_bytes(msg_it
->medium
.max_request_sz
, &buffer_addr
,
480 &buffer_sz
, msg_it
->medium
.data
);
481 BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
482 ctf_msg_iter_medium_status_string(m_status
), buffer_addr
, buffer_sz
);
483 if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
484 BT_ASSERT(buffer_sz
!= 0);
486 /* New packet offset is old one + old size (in bits) */
487 msg_it
->buf
.packet_offset
+= buf_size_bits(msg_it
);
489 /* Restart at the beginning of the new medium buffer */
491 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
493 /* New medium buffer size */
494 msg_it
->buf
.sz
= buffer_sz
;
496 /* New medium buffer address */
497 msg_it
->buf
.addr
= buffer_addr
;
499 BT_COMP_LOGD("User function returned new bytes: "
500 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
501 msg_it
->buf
.packet_offset
, msg_it
->buf
.at
, msg_it
->buf
.sz
, msg_it
->buf
.addr
);
502 BT_COMP_LOGT_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:", buffer_addr
);
503 } else if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
505 * User returned end of stream: validate that we're not
506 * in the middle of a packet header, packet context, or
509 if (msg_it
->cur_exp_packet_total_size
>= 0) {
510 if (packet_at(msg_it
) == msg_it
->cur_exp_packet_total_size
) {
514 if (packet_at(msg_it
) == 0) {
518 if (msg_it
->buf
.last_eh_at
!= SIZE_MAX
&& msg_it
->buf
.at
== msg_it
->buf
.last_eh_at
) {
523 /* All other states are invalid */
524 BT_COMP_LOGE_APPEND_CAUSE(
526 "User function returned %s, but message iterator is in an unexpected state: "
527 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
528 "packet-cur=%zu, last-eh-at=%zu",
529 ctf_msg_iter_medium_status_string(m_status
), state_string(msg_it
->state
),
530 msg_it
->cur_exp_packet_total_size
, msg_it
->buf
.at
, packet_at(msg_it
),
531 msg_it
->buf
.last_eh_at
);
532 m_status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
533 } else if (m_status
< 0) {
534 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
535 "User function failed: "
537 ctf_msg_iter_medium_status_string(m_status
));
541 return msg_iter_status_from_m_status(m_status
);
544 static inline enum ctf_msg_iter_status
buf_ensure_available_bits(struct ctf_msg_iter
*msg_it
)
546 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
548 if (G_UNLIKELY(buf_available_bits(msg_it
) == 0)) {
550 * This _cannot_ return CTF_MSG_ITER_STATUS_OK
553 status
= request_medium_bytes(msg_it
);
559 static enum ctf_msg_iter_status
560 read_dscope_begin_state(struct ctf_msg_iter
*msg_it
, struct ctf_field_class
*dscope_fc
,
561 enum state done_state
, enum state continue_state
, bt_field
*dscope_field
)
563 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
564 bt_self_component
*self_comp
= msg_it
->self_comp
;
565 enum bt_bfcr_status bfcr_status
;
566 size_t consumed_bits
;
568 msg_it
->cur_dscope_field
= dscope_field
;
569 BT_COMP_LOGT("Starting BFCR: msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p", msg_it
, msg_it
->bfcr
,
571 consumed_bits
= bt_bfcr_start(msg_it
->bfcr
, dscope_fc
, msg_it
->buf
.addr
, msg_it
->buf
.at
,
572 packet_at(msg_it
), msg_it
->buf
.sz
, &bfcr_status
);
573 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
575 switch (bfcr_status
) {
576 case BT_BFCR_STATUS_OK
:
577 /* Field class was read completely */
578 BT_COMP_LOGT_STR("Field was completely decoded.");
579 msg_it
->state
= done_state
;
581 case BT_BFCR_STATUS_EOF
:
582 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
583 msg_it
->state
= continue_state
;
586 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
587 "BFCR failed to start: msg-it-addr=%p, bfcr-addr=%p, "
589 msg_it
, msg_it
->bfcr
, bt_bfcr_status_string(bfcr_status
));
590 status
= CTF_MSG_ITER_STATUS_ERROR
;
594 /* Consume bits now since we know we're not in an error state */
595 buf_consume_bits(msg_it
, consumed_bits
);
601 static enum ctf_msg_iter_status
read_dscope_continue_state(struct ctf_msg_iter
*msg_it
,
602 enum state done_state
)
604 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
605 bt_self_component
*self_comp
= msg_it
->self_comp
;
606 enum bt_bfcr_status bfcr_status
;
607 size_t consumed_bits
;
609 BT_COMP_LOGT("Continuing BFCR: msg-it-addr=%p, bfcr-addr=%p", msg_it
, msg_it
->bfcr
);
611 status
= buf_ensure_available_bits(msg_it
);
612 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
614 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
615 "Cannot ensure that buffer has at least one byte: "
616 "msg-addr=%p, status=%s",
617 msg_it
, ctf_msg_iter_status_string(status
));
619 BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: "
620 "msg-addr=%p, status=%s",
621 msg_it
, ctf_msg_iter_status_string(status
));
627 consumed_bits
= bt_bfcr_continue(msg_it
->bfcr
, msg_it
->buf
.addr
, msg_it
->buf
.sz
, &bfcr_status
);
628 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
630 switch (bfcr_status
) {
631 case BT_BFCR_STATUS_OK
:
632 /* Type was read completely. */
633 BT_COMP_LOGT_STR("Field was completely decoded.");
634 msg_it
->state
= done_state
;
636 case BT_BFCR_STATUS_EOF
:
637 /* Stay in this continue state. */
638 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
641 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
642 "BFCR failed to continue: msg-it-addr=%p, bfcr-addr=%p, "
644 msg_it
, msg_it
->bfcr
, bt_bfcr_status_string(bfcr_status
));
645 status
= CTF_MSG_ITER_STATUS_ERROR
;
649 /* Consume bits now since we know we're not in an error state. */
650 buf_consume_bits(msg_it
, consumed_bits
);
655 static void release_event_dscopes(struct ctf_msg_iter
*msg_it
)
657 msg_it
->dscopes
.event_common_context
= NULL
;
658 msg_it
->dscopes
.event_spec_context
= NULL
;
659 msg_it
->dscopes
.event_payload
= NULL
;
662 static void release_all_dscopes(struct ctf_msg_iter
*msg_it
)
664 msg_it
->dscopes
.stream_packet_context
= NULL
;
666 release_event_dscopes(msg_it
);
669 static enum ctf_msg_iter_status
switch_packet_state(struct ctf_msg_iter
*msg_it
)
671 enum ctf_msg_iter_status status
;
672 bt_self_component
*self_comp
= msg_it
->self_comp
;
675 * We don't put the stream class here because we need to make
676 * sure that all the packets processed by the same message
677 * iterator refer to the same stream class (the first one).
681 if (msg_it
->cur_exp_packet_total_size
!= -1) {
682 msg_it
->cur_packet_offset
+= msg_it
->cur_exp_packet_total_size
;
685 BT_COMP_LOGD("Switching packet: msg-it-addr=%p, cur=%zu, "
686 "packet-offset=%" PRId64
,
687 msg_it
, msg_it
->buf
.at
, msg_it
->cur_packet_offset
);
688 stack_clear(msg_it
->stack
);
689 msg_it
->meta
.ec
= NULL
;
690 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
691 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
692 release_all_dscopes(msg_it
);
693 msg_it
->cur_dscope_field
= NULL
;
695 if (msg_it
->medium
.medops
.switch_packet
) {
696 enum ctf_msg_iter_medium_status medium_status
;
698 medium_status
= msg_it
->medium
.medops
.switch_packet(msg_it
->medium
.data
);
699 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
700 /* No more packets. */
701 msg_it
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
702 status
= CTF_MSG_ITER_STATUS_OK
;
704 } else if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
705 status
= msg_iter_status_from_m_status(medium_status
);
710 * After the packet switch, the medium might want to give us a
711 * different buffer for the new packet.
713 status
= request_medium_bytes(msg_it
);
714 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
720 * Adjust current buffer so that addr points to the beginning of the new
723 if (msg_it
->buf
.addr
) {
724 size_t consumed_bytes
= (size_t) (msg_it
->buf
.at
/ CHAR_BIT
);
726 /* Packets are assumed to start on a byte frontier. */
727 if (msg_it
->buf
.at
% CHAR_BIT
) {
728 BT_COMP_LOGE_APPEND_CAUSE(
730 "Cannot switch packet: current position is not a multiple of 8: "
731 "msg-it-addr=%p, cur=%zu",
732 msg_it
, msg_it
->buf
.at
);
733 status
= CTF_MSG_ITER_STATUS_ERROR
;
737 msg_it
->buf
.addr
+= consumed_bytes
;
738 msg_it
->buf
.sz
-= consumed_bytes
;
740 msg_it
->buf
.packet_offset
= 0;
741 BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu", msg_it
->buf
.addr
, msg_it
->buf
.sz
);
744 msg_it
->cur_exp_packet_content_size
= -1;
745 msg_it
->cur_exp_packet_total_size
= -1;
746 msg_it
->cur_stream_class_id
= -1;
747 msg_it
->cur_event_class_id
= -1;
748 msg_it
->cur_data_stream_id
= -1;
749 msg_it
->prev_packet_snapshots
= msg_it
->snapshots
;
750 msg_it
->snapshots
.discarded_events
= UINT64_C(-1);
751 msg_it
->snapshots
.packets
= UINT64_C(-1);
752 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
753 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
754 msg_it
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
756 status
= CTF_MSG_ITER_STATUS_OK
;
761 static enum ctf_msg_iter_status
read_packet_header_begin_state(struct ctf_msg_iter
*msg_it
)
763 struct ctf_field_class
*packet_header_fc
= NULL
;
764 bt_self_component
*self_comp
= msg_it
->self_comp
;
765 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
768 * Make sure at least one bit is available for this packet. An
769 * empty packet is impossible. If we reach the end of the medium
770 * at this point, then it's considered the end of the stream.
772 status
= buf_ensure_available_bits(msg_it
);
774 case CTF_MSG_ITER_STATUS_OK
:
776 case CTF_MSG_ITER_STATUS_EOF
:
777 status
= CTF_MSG_ITER_STATUS_OK
;
778 msg_it
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
784 /* Packet header class is common to the whole trace class. */
785 packet_header_fc
= msg_it
->meta
.tc
->packet_header_fc
;
786 if (!packet_header_fc
) {
787 msg_it
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
791 msg_it
->cur_stream_class_id
= -1;
792 msg_it
->cur_event_class_id
= -1;
793 msg_it
->cur_data_stream_id
= -1;
794 BT_COMP_LOGD("Decoding packet header field: "
795 "msg-it-addr=%p, trace-class-addr=%p, fc-addr=%p",
796 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
797 status
= read_dscope_begin_state(msg_it
, packet_header_fc
, STATE_AFTER_TRACE_PACKET_HEADER
,
798 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
800 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
801 "Cannot decode packet header field: "
802 "msg-it-addr=%p, trace-class-addr=%p, "
804 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
811 static enum ctf_msg_iter_status
read_packet_header_continue_state(struct ctf_msg_iter
*msg_it
)
813 return read_dscope_continue_state(msg_it
, STATE_AFTER_TRACE_PACKET_HEADER
);
816 static inline enum ctf_msg_iter_status
set_current_stream_class(struct ctf_msg_iter
*msg_it
)
818 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
819 bt_self_component
*self_comp
= msg_it
->self_comp
;
820 struct ctf_stream_class
*new_stream_class
= NULL
;
822 if (msg_it
->cur_stream_class_id
== -1) {
824 * No current stream class ID field, therefore only one
827 if (msg_it
->meta
.tc
->stream_classes
->len
!= 1) {
828 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
829 "Need exactly one stream class since there's "
830 "no stream class ID field: "
833 status
= CTF_MSG_ITER_STATUS_ERROR
;
837 new_stream_class
= (ctf_stream_class
*) msg_it
->meta
.tc
->stream_classes
->pdata
[0];
838 msg_it
->cur_stream_class_id
= new_stream_class
->id
;
842 ctf_trace_class_borrow_stream_class_by_id(msg_it
->meta
.tc
, msg_it
->cur_stream_class_id
);
843 if (!new_stream_class
) {
844 BT_COMP_LOGE_APPEND_CAUSE(
846 "No stream class with ID of stream class ID to use in trace class: "
847 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
848 "trace-class-addr=%p",
849 msg_it
, msg_it
->cur_stream_class_id
, msg_it
->meta
.tc
);
850 status
= CTF_MSG_ITER_STATUS_ERROR
;
854 if (msg_it
->meta
.sc
) {
855 if (new_stream_class
!= msg_it
->meta
.sc
) {
856 BT_COMP_LOGE_APPEND_CAUSE(
858 "Two packets refer to two different stream classes within the same packet sequence: "
859 "msg-it-addr=%p, prev-stream-class-addr=%p, "
860 "prev-stream-class-id=%" PRId64
", "
861 "next-stream-class-addr=%p, "
862 "next-stream-class-id=%" PRId64
", "
864 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, new_stream_class
,
865 new_stream_class
->id
, msg_it
->meta
.tc
);
866 status
= CTF_MSG_ITER_STATUS_ERROR
;
870 msg_it
->meta
.sc
= new_stream_class
;
873 BT_COMP_LOGD("Set current stream class: "
874 "msg-it-addr=%p, stream-class-addr=%p, "
875 "stream-class-id=%" PRId64
,
876 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
882 static inline enum ctf_msg_iter_status
set_current_stream(struct ctf_msg_iter
*msg_it
)
884 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
885 bt_self_component
*self_comp
= msg_it
->self_comp
;
886 bt_stream
*stream
= NULL
;
888 BT_COMP_LOGD("Calling user function (get stream): msg-it-addr=%p, "
889 "stream-class-addr=%p, stream-class-id=%" PRId64
,
890 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
891 stream
= msg_it
->medium
.medops
.borrow_stream(msg_it
->meta
.sc
->ir_sc
, msg_it
->cur_data_stream_id
,
892 msg_it
->medium
.data
);
893 bt_stream_get_ref(stream
);
894 BT_COMP_LOGD("User function returned: stream-addr=%p", stream
);
896 BT_COMP_LOGE_APPEND_CAUSE(
898 "User function failed to return a stream object for the given stream class.");
899 status
= CTF_MSG_ITER_STATUS_ERROR
;
903 if (msg_it
->stream
&& stream
!= msg_it
->stream
) {
904 BT_COMP_LOGE_APPEND_CAUSE(
906 "User function returned a different stream than the previous one for the same sequence of packets.");
907 status
= CTF_MSG_ITER_STATUS_ERROR
;
911 BT_STREAM_MOVE_REF(msg_it
->stream
, stream
);
914 bt_stream_put_ref(stream
);
918 static inline enum ctf_msg_iter_status
set_current_packet(struct ctf_msg_iter
*msg_it
)
920 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
921 bt_self_component
*self_comp
= msg_it
->self_comp
;
922 bt_packet
*packet
= NULL
;
924 BT_COMP_LOGD("Creating packet from stream: "
925 "msg-it-addr=%p, stream-addr=%p, "
926 "stream-class-addr=%p, "
927 "stream-class-id=%" PRId64
,
928 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
931 BT_ASSERT(msg_it
->stream
);
932 packet
= bt_packet_create(msg_it
->stream
);
934 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
935 "Cannot create packet from stream: "
936 "msg-it-addr=%p, stream-addr=%p, "
937 "stream-class-addr=%p, "
938 "stream-class-id=%" PRId64
,
939 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
946 BT_PACKET_PUT_REF_AND_RESET(packet
);
947 status
= CTF_MSG_ITER_STATUS_ERROR
;
950 BT_PACKET_MOVE_REF(msg_it
->packet
, packet
);
954 static enum ctf_msg_iter_status
after_packet_header_state(struct ctf_msg_iter
*msg_it
)
956 enum ctf_msg_iter_status status
;
958 status
= set_current_stream_class(msg_it
);
959 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
963 if (!msg_it
->dry_run
) {
964 status
= set_current_stream(msg_it
);
965 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
969 status
= set_current_packet(msg_it
);
970 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
975 msg_it
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
977 status
= CTF_MSG_ITER_STATUS_OK
;
983 static enum ctf_msg_iter_status
read_packet_context_begin_state(struct ctf_msg_iter
*msg_it
)
985 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
986 bt_self_component
*self_comp
= msg_it
->self_comp
;
987 struct ctf_field_class
*packet_context_fc
;
989 BT_ASSERT(msg_it
->meta
.sc
);
990 packet_context_fc
= msg_it
->meta
.sc
->packet_context_fc
;
991 if (!packet_context_fc
) {
992 BT_COMP_LOGD("No packet packet context field class in stream class: continuing: "
993 "msg-it-addr=%p, stream-class-addr=%p, "
994 "stream-class-id=%" PRId64
,
995 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
996 msg_it
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
1000 if (packet_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1001 BT_ASSERT(!msg_it
->dscopes
.stream_packet_context
);
1002 BT_ASSERT(msg_it
->packet
);
1003 msg_it
->dscopes
.stream_packet_context
= bt_packet_borrow_context_field(msg_it
->packet
);
1004 BT_ASSERT(msg_it
->dscopes
.stream_packet_context
);
1007 BT_COMP_LOGD("Decoding packet context field: "
1008 "msg-it-addr=%p, stream-class-addr=%p, "
1009 "stream-class-id=%" PRId64
", fc-addr=%p",
1010 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, packet_context_fc
);
1011 status
= read_dscope_begin_state(msg_it
, packet_context_fc
, STATE_AFTER_STREAM_PACKET_CONTEXT
,
1012 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
1013 msg_it
->dscopes
.stream_packet_context
);
1015 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1016 "Cannot decode packet context field: "
1017 "msg-it-addr=%p, stream-class-addr=%p, "
1018 "stream-class-id=%" PRId64
", fc-addr=%p",
1019 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, packet_context_fc
);
1026 static enum ctf_msg_iter_status
read_packet_context_continue_state(struct ctf_msg_iter
*msg_it
)
1028 return read_dscope_continue_state(msg_it
, STATE_AFTER_STREAM_PACKET_CONTEXT
);
1031 static enum ctf_msg_iter_status
set_current_packet_content_sizes(struct ctf_msg_iter
*msg_it
)
1033 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1034 bt_self_component
*self_comp
= msg_it
->self_comp
;
1036 if (msg_it
->cur_exp_packet_total_size
== -1) {
1037 if (msg_it
->cur_exp_packet_content_size
!= -1) {
1038 msg_it
->cur_exp_packet_total_size
= msg_it
->cur_exp_packet_content_size
;
1041 if (msg_it
->cur_exp_packet_content_size
== -1) {
1042 msg_it
->cur_exp_packet_content_size
= msg_it
->cur_exp_packet_total_size
;
1047 (msg_it
->cur_exp_packet_total_size
>= 0 && msg_it
->cur_exp_packet_content_size
>= 0) ||
1048 (msg_it
->cur_exp_packet_total_size
< 0 && msg_it
->cur_exp_packet_content_size
< 0));
1050 if (msg_it
->cur_exp_packet_content_size
> msg_it
->cur_exp_packet_total_size
) {
1051 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1052 "Invalid packet or content size: "
1053 "content size is greater than packet size: "
1054 "msg-it-addr=%p, packet-context-field-addr=%p, "
1055 "packet-size=%" PRId64
", content-size=%" PRId64
,
1056 msg_it
, msg_it
->dscopes
.stream_packet_context
,
1057 msg_it
->cur_exp_packet_total_size
,
1058 msg_it
->cur_exp_packet_content_size
);
1059 status
= CTF_MSG_ITER_STATUS_ERROR
;
1063 BT_COMP_LOGD("Set current packet and content sizes: "
1064 "msg-it-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1065 msg_it
, msg_it
->cur_exp_packet_total_size
, msg_it
->cur_exp_packet_content_size
);
1071 static enum ctf_msg_iter_status
after_packet_context_state(struct ctf_msg_iter
*msg_it
)
1073 enum ctf_msg_iter_status status
;
1075 status
= set_current_packet_content_sizes(msg_it
);
1076 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1080 if (msg_it
->emit_stream_beginning_message
) {
1081 msg_it
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1083 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1090 static enum ctf_msg_iter_status
read_event_header_begin_state(struct ctf_msg_iter
*msg_it
)
1092 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1093 bt_self_component
*self_comp
= msg_it
->self_comp
;
1094 struct ctf_field_class
*event_header_fc
= NULL
;
1096 /* Reset the position of the last event header */
1097 msg_it
->buf
.last_eh_at
= msg_it
->buf
.at
;
1098 msg_it
->cur_event_class_id
= -1;
1100 /* Check if we have some content left */
1101 if (msg_it
->cur_exp_packet_content_size
>= 0) {
1102 if (G_UNLIKELY(packet_at(msg_it
) == msg_it
->cur_exp_packet_content_size
)) {
1103 /* No more events! */
1104 BT_COMP_LOGD("Reached end of packet: msg-it-addr=%p, "
1106 msg_it
, packet_at(msg_it
));
1107 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1109 } else if (G_UNLIKELY(packet_at(msg_it
) > msg_it
->cur_exp_packet_content_size
)) {
1110 /* That's not supposed to happen */
1112 "Before decoding event header field: cursor is passed the packet's content: "
1113 "msg-it-addr=%p, content-size=%" PRId64
", "
1115 msg_it
, msg_it
->cur_exp_packet_content_size
, packet_at(msg_it
));
1116 status
= CTF_MSG_ITER_STATUS_ERROR
;
1121 * "Infinite" content: we're done when the medium has
1122 * nothing else for us.
1124 status
= buf_ensure_available_bits(msg_it
);
1126 case CTF_MSG_ITER_STATUS_OK
:
1128 case CTF_MSG_ITER_STATUS_EOF
:
1129 status
= CTF_MSG_ITER_STATUS_OK
;
1130 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1137 release_event_dscopes(msg_it
);
1138 BT_ASSERT(msg_it
->meta
.sc
);
1139 event_header_fc
= msg_it
->meta
.sc
->event_header_fc
;
1140 if (!event_header_fc
) {
1141 msg_it
->state
= STATE_AFTER_EVENT_HEADER
;
1145 BT_COMP_LOGD("Decoding event header field: "
1146 "msg-it-addr=%p, stream-class-addr=%p, "
1147 "stream-class-id=%" PRId64
", "
1149 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, event_header_fc
);
1150 status
= read_dscope_begin_state(msg_it
, event_header_fc
, STATE_AFTER_EVENT_HEADER
,
1151 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1153 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1154 "Cannot decode event header field: "
1155 "msg-it-addr=%p, stream-class-addr=%p, "
1156 "stream-class-id=%" PRId64
", fc-addr=%p",
1157 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, event_header_fc
);
1164 static enum ctf_msg_iter_status
read_event_header_continue_state(struct ctf_msg_iter
*msg_it
)
1166 return read_dscope_continue_state(msg_it
, STATE_AFTER_EVENT_HEADER
);
1169 static inline enum ctf_msg_iter_status
set_current_event_class(struct ctf_msg_iter
*msg_it
)
1171 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1172 bt_self_component
*self_comp
= msg_it
->self_comp
;
1174 struct ctf_event_class
*new_event_class
= NULL
;
1176 if (msg_it
->cur_event_class_id
== -1) {
1178 * No current event class ID field, therefore only one
1181 if (msg_it
->meta
.sc
->event_classes
->len
!= 1) {
1182 BT_COMP_LOGE_APPEND_CAUSE(
1184 "Need exactly one event class since there's no event class ID field: "
1187 status
= CTF_MSG_ITER_STATUS_ERROR
;
1191 new_event_class
= (ctf_event_class
*) msg_it
->meta
.sc
->event_classes
->pdata
[0];
1192 msg_it
->cur_event_class_id
= new_event_class
->id
;
1196 ctf_stream_class_borrow_event_class_by_id(msg_it
->meta
.sc
, msg_it
->cur_event_class_id
);
1197 if (!new_event_class
) {
1198 BT_COMP_LOGE_APPEND_CAUSE(
1200 "No event class with ID of event class ID to use in stream class: "
1201 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
1202 "event-class-id=%" PRIu64
", "
1203 "trace-class-addr=%p",
1204 msg_it
, msg_it
->meta
.sc
->id
, msg_it
->cur_event_class_id
, msg_it
->meta
.tc
);
1205 status
= CTF_MSG_ITER_STATUS_ERROR
;
1209 msg_it
->meta
.ec
= new_event_class
;
1210 BT_COMP_LOGD("Set current event class: "
1211 "msg-it-addr=%p, event-class-addr=%p, "
1212 "event-class-id=%" PRId64
", "
1213 "event-class-name=\"%s\"",
1214 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->id
, msg_it
->meta
.ec
->name
->str
);
1220 static inline enum ctf_msg_iter_status
set_current_event_message(struct ctf_msg_iter
*msg_it
)
1222 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1223 bt_self_component
*self_comp
= msg_it
->self_comp
;
1224 bt_message
*msg
= NULL
;
1226 BT_ASSERT_DBG(msg_it
->meta
.ec
);
1227 BT_ASSERT_DBG(msg_it
->packet
);
1228 BT_COMP_LOGD("Creating event message from event class and packet: "
1229 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1230 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
, msg_it
->packet
);
1231 BT_ASSERT_DBG(msg_it
->self_msg_iter
);
1232 BT_ASSERT_DBG(msg_it
->meta
.sc
);
1234 if (bt_stream_class_borrow_default_clock_class(msg_it
->meta
.sc
->ir_sc
)) {
1235 msg
= bt_message_event_create_with_packet_and_default_clock_snapshot(
1236 msg_it
->self_msg_iter
, msg_it
->meta
.ec
->ir_ec
, msg_it
->packet
,
1237 msg_it
->default_clock_snapshot
);
1239 msg
= bt_message_event_create_with_packet(msg_it
->self_msg_iter
, msg_it
->meta
.ec
->ir_ec
,
1244 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1245 "Cannot create event message: "
1246 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1248 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
,
1256 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1257 status
= CTF_MSG_ITER_STATUS_ERROR
;
1260 BT_MESSAGE_MOVE_REF(msg_it
->event_msg
, msg
);
1264 static enum ctf_msg_iter_status
after_event_header_state(struct ctf_msg_iter
*msg_it
)
1266 enum ctf_msg_iter_status status
;
1268 status
= set_current_event_class(msg_it
);
1269 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1273 if (G_UNLIKELY(msg_it
->dry_run
)) {
1277 status
= set_current_event_message(msg_it
);
1278 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1282 msg_it
->event
= bt_message_event_borrow_event(msg_it
->event_msg
);
1283 BT_ASSERT_DBG(msg_it
->event
);
1286 msg_it
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1292 static enum ctf_msg_iter_status
read_event_common_context_begin_state(struct ctf_msg_iter
*msg_it
)
1294 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1295 bt_self_component
*self_comp
= msg_it
->self_comp
;
1296 struct ctf_field_class
*event_common_context_fc
;
1298 event_common_context_fc
= msg_it
->meta
.sc
->event_common_context_fc
;
1299 if (!event_common_context_fc
) {
1300 msg_it
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1304 if (event_common_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1305 BT_ASSERT_DBG(!msg_it
->dscopes
.event_common_context
);
1306 msg_it
->dscopes
.event_common_context
= bt_event_borrow_common_context_field(msg_it
->event
);
1307 BT_ASSERT_DBG(msg_it
->dscopes
.event_common_context
);
1310 BT_COMP_LOGT("Decoding event common context field: "
1311 "msg-it-addr=%p, stream-class-addr=%p, "
1312 "stream-class-id=%" PRId64
", "
1314 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
, event_common_context_fc
);
1315 status
= read_dscope_begin_state(
1316 msg_it
, event_common_context_fc
, STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1317 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
, msg_it
->dscopes
.event_common_context
);
1319 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1320 "Cannot decode event common context field: "
1321 "msg-it-addr=%p, stream-class-addr=%p, "
1322 "stream-class-id=%" PRId64
", fc-addr=%p",
1323 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
,
1324 event_common_context_fc
);
1331 static enum ctf_msg_iter_status
1332 read_event_common_context_continue_state(struct ctf_msg_iter
*msg_it
)
1334 return read_dscope_continue_state(msg_it
, STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1337 static enum ctf_msg_iter_status
read_event_spec_context_begin_state(struct ctf_msg_iter
*msg_it
)
1339 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1340 bt_self_component
*self_comp
= msg_it
->self_comp
;
1341 struct ctf_field_class
*event_spec_context_fc
;
1343 event_spec_context_fc
= msg_it
->meta
.ec
->spec_context_fc
;
1344 if (!event_spec_context_fc
) {
1345 msg_it
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1349 if (event_spec_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1350 BT_ASSERT_DBG(!msg_it
->dscopes
.event_spec_context
);
1351 msg_it
->dscopes
.event_spec_context
= bt_event_borrow_specific_context_field(msg_it
->event
);
1352 BT_ASSERT_DBG(msg_it
->dscopes
.event_spec_context
);
1355 BT_COMP_LOGT("Decoding event specific context field: "
1356 "msg-it-addr=%p, event-class-addr=%p, "
1357 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1359 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
, msg_it
->meta
.ec
->id
,
1360 event_spec_context_fc
);
1361 status
= read_dscope_begin_state(
1362 msg_it
, event_spec_context_fc
, STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1363 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
, msg_it
->dscopes
.event_spec_context
);
1365 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1366 "Cannot decode event specific context field: "
1367 "msg-it-addr=%p, event-class-addr=%p, "
1368 "event-class-name=\"%s\", "
1369 "event-class-id=%" PRId64
", fc-addr=%p",
1370 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
,
1371 msg_it
->meta
.ec
->id
, event_spec_context_fc
);
1378 static enum ctf_msg_iter_status
read_event_spec_context_continue_state(struct ctf_msg_iter
*msg_it
)
1380 return read_dscope_continue_state(msg_it
, STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1383 static enum ctf_msg_iter_status
read_event_payload_begin_state(struct ctf_msg_iter
*msg_it
)
1385 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1386 bt_self_component
*self_comp
= msg_it
->self_comp
;
1387 struct ctf_field_class
*event_payload_fc
;
1389 event_payload_fc
= msg_it
->meta
.ec
->payload_fc
;
1390 if (!event_payload_fc
) {
1391 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1395 if (event_payload_fc
->in_ir
&& !msg_it
->dry_run
) {
1396 BT_ASSERT_DBG(!msg_it
->dscopes
.event_payload
);
1397 msg_it
->dscopes
.event_payload
= bt_event_borrow_payload_field(msg_it
->event
);
1398 BT_ASSERT_DBG(msg_it
->dscopes
.event_payload
);
1401 BT_COMP_LOGT("Decoding event payload field: "
1402 "msg-it-addr=%p, event-class-addr=%p, "
1403 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1405 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
, msg_it
->meta
.ec
->id
,
1408 read_dscope_begin_state(msg_it
, event_payload_fc
, STATE_EMIT_MSG_EVENT
,
1409 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
, msg_it
->dscopes
.event_payload
);
1411 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1412 "Cannot decode event payload field: "
1413 "msg-it-addr=%p, event-class-addr=%p, "
1414 "event-class-name=\"%s\", "
1415 "event-class-id=%" PRId64
", fc-addr=%p",
1416 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->name
->str
,
1417 msg_it
->meta
.ec
->id
, event_payload_fc
);
1424 static enum ctf_msg_iter_status
read_event_payload_continue_state(struct ctf_msg_iter
*msg_it
)
1426 return read_dscope_continue_state(msg_it
, STATE_EMIT_MSG_EVENT
);
1429 static enum ctf_msg_iter_status
skip_packet_padding_state(struct ctf_msg_iter
*msg_it
)
1431 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1432 size_t bits_to_skip
;
1433 const enum state next_state
= STATE_SWITCH_PACKET
;
1435 BT_ASSERT(msg_it
->cur_exp_packet_total_size
> 0);
1436 bits_to_skip
= msg_it
->cur_exp_packet_total_size
- packet_at(msg_it
);
1437 if (bits_to_skip
== 0) {
1438 msg_it
->state
= next_state
;
1441 size_t bits_to_consume
;
1443 BT_COMP_LOGD("Trying to skip %zu bits of padding: msg-it-addr=%p, size=%zu", bits_to_skip
,
1444 msg_it
, bits_to_skip
);
1445 status
= buf_ensure_available_bits(msg_it
);
1446 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1450 bits_to_consume
= MIN(buf_available_bits(msg_it
), bits_to_skip
);
1451 BT_COMP_LOGD("Skipping %zu bits of padding: msg-it-addr=%p, size=%zu", bits_to_consume
,
1452 msg_it
, bits_to_consume
);
1453 buf_consume_bits(msg_it
, bits_to_consume
);
1454 bits_to_skip
= msg_it
->cur_exp_packet_total_size
- packet_at(msg_it
);
1455 if (bits_to_skip
== 0) {
1456 msg_it
->state
= next_state
;
1465 static enum ctf_msg_iter_status
check_emit_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
1467 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1469 if (!msg_it
->meta
.sc
->has_discarded_events
) {
1470 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1474 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1475 if (msg_it
->snapshots
.discarded_events
== 0 ||
1476 msg_it
->snapshots
.discarded_events
== UINT64_C(-1)) {
1478 * Stream's first packet with no discarded
1479 * events or no information about discarded
1480 * events: do not emit.
1482 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1486 * If the previous packet has a value for this counter,
1487 * then this counter is defined for the whole stream.
1489 BT_ASSERT(msg_it
->snapshots
.discarded_events
!= UINT64_C(-1));
1491 if (msg_it
->snapshots
.discarded_events
- msg_it
->prev_packet_snapshots
.discarded_events
==
1494 * No discarded events since previous packet: do
1497 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1502 return CTF_MSG_ITER_STATUS_OK
;
1505 static enum ctf_msg_iter_status
check_emit_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
1507 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1509 if (!msg_it
->meta
.sc
->has_discarded_packets
) {
1510 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1514 if (msg_it
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1516 * Stream's first packet or no information about
1517 * discarded packets: do not emit. In other words, if
1518 * this is the first packet and its sequence number is
1519 * not 0, do not consider that packets were previously
1520 * lost: we might be reading a partial stream (LTTng
1521 * snapshot for example).
1523 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1526 * If the previous packet has a value for this counter,
1527 * then this counter is defined for the whole stream.
1529 BT_ASSERT(msg_it
->snapshots
.packets
!= UINT64_C(-1));
1531 if (msg_it
->snapshots
.packets
- msg_it
->prev_packet_snapshots
.packets
<= 1) {
1533 * No discarded packets since previous packet:
1536 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1541 return CTF_MSG_ITER_STATUS_OK
;
1544 static inline enum state
check_emit_msg_stream_end(struct ctf_msg_iter
*msg_it
)
1546 enum state next_state
;
1548 if (msg_it
->emit_stream_end_message
) {
1549 next_state
= STATE_EMIT_MSG_STREAM_END
;
1551 next_state
= STATE_DONE
;
1557 static inline enum ctf_msg_iter_status
handle_state(struct ctf_msg_iter
*msg_it
)
1559 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1560 const enum state state
= msg_it
->state
;
1562 BT_COMP_LOGT("Handling state: msg-it-addr=%p, state=%s", msg_it
, state_string(state
));
1564 // TODO: optimalize!
1567 msg_it
->state
= STATE_SWITCH_PACKET
;
1569 case STATE_SWITCH_PACKET
:
1570 status
= switch_packet_state(msg_it
);
1572 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1573 status
= read_packet_header_begin_state(msg_it
);
1575 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1576 status
= read_packet_header_continue_state(msg_it
);
1578 case STATE_AFTER_TRACE_PACKET_HEADER
:
1579 status
= after_packet_header_state(msg_it
);
1581 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1582 status
= read_packet_context_begin_state(msg_it
);
1584 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1585 status
= read_packet_context_continue_state(msg_it
);
1587 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1588 status
= after_packet_context_state(msg_it
);
1590 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1591 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1593 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1594 status
= check_emit_msg_discarded_events(msg_it
);
1596 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1597 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1599 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1600 status
= check_emit_msg_discarded_packets(msg_it
);
1602 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1603 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1605 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1606 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1608 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1609 status
= read_event_header_begin_state(msg_it
);
1611 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1612 status
= read_event_header_continue_state(msg_it
);
1614 case STATE_AFTER_EVENT_HEADER
:
1615 status
= after_event_header_state(msg_it
);
1617 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1618 status
= read_event_common_context_begin_state(msg_it
);
1620 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1621 status
= read_event_common_context_continue_state(msg_it
);
1623 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1624 status
= read_event_spec_context_begin_state(msg_it
);
1626 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1627 status
= read_event_spec_context_continue_state(msg_it
);
1629 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1630 status
= read_event_payload_begin_state(msg_it
);
1632 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1633 status
= read_event_payload_continue_state(msg_it
);
1635 case STATE_EMIT_MSG_EVENT
:
1636 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1638 case STATE_EMIT_QUEUED_MSG_EVENT
:
1639 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1641 case STATE_SKIP_PACKET_PADDING
:
1642 status
= skip_packet_padding_state(msg_it
);
1644 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1645 msg_it
->state
= STATE_SKIP_PACKET_PADDING
;
1647 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1648 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
1650 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
1651 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1653 case STATE_CHECK_EMIT_MSG_STREAM_END
:
1654 msg_it
->state
= check_emit_msg_stream_end(msg_it
);
1656 case STATE_EMIT_MSG_STREAM_END
:
1657 msg_it
->state
= STATE_DONE
;
1662 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1663 "msg-it-addr=%p, state=%d",
1664 msg_it
, msg_it
->state
);
1668 BT_COMP_LOGT("Handled state: msg-it-addr=%p, status=%s, "
1669 "prev-state=%s, cur-state=%s",
1670 msg_it
, ctf_msg_iter_status_string(status
), state_string(state
),
1671 state_string(msg_it
->state
));
1676 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter
*msg_it
)
1679 BT_COMP_LOGD("Resetting message iterator: addr=%p", msg_it
);
1680 stack_clear(msg_it
->stack
);
1681 msg_it
->meta
.sc
= NULL
;
1682 msg_it
->meta
.ec
= NULL
;
1683 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
1684 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
1685 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
1686 release_all_dscopes(msg_it
);
1687 msg_it
->cur_dscope_field
= NULL
;
1689 msg_it
->buf
.addr
= NULL
;
1692 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
1693 msg_it
->buf
.packet_offset
= 0;
1694 msg_it
->state
= STATE_INIT
;
1695 msg_it
->cur_exp_packet_content_size
= -1;
1696 msg_it
->cur_exp_packet_total_size
= -1;
1697 msg_it
->cur_packet_offset
= -1;
1698 msg_it
->cur_event_class_id
= -1;
1699 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
1700 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
1704 * 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
);
1798 static enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
, struct ctf_field_class
*fc
,
1801 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
1802 bt_self_component
*self_comp
= msg_it
->self_comp
;
1803 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1805 bt_field
*field
= NULL
;
1806 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
1808 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1809 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1810 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1811 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1813 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1814 goto update_def_clock
;
1817 switch (int_fc
->meaning
) {
1818 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1819 msg_it
->cur_event_class_id
= value
;
1821 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1822 msg_it
->cur_data_stream_id
= value
;
1824 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1825 msg_it
->snapshots
.beginning_clock
= value
;
1827 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1828 msg_it
->snapshots
.end_clock
= value
;
1830 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1831 msg_it
->cur_stream_class_id
= value
;
1833 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1834 if (value
!= 0xc1fc1fc1) {
1835 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1836 "Invalid CTF magic number: msg-it-addr=%p, "
1839 status
= BT_BFCR_STATUS_ERROR
;
1844 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1845 msg_it
->snapshots
.packets
= value
;
1847 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1848 msg_it
->snapshots
.discarded_events
= value
;
1850 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1851 msg_it
->cur_exp_packet_total_size
= value
;
1853 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1854 msg_it
->cur_exp_packet_content_size
= value
;
1861 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
1862 update_default_clock(msg_it
, value
, int_fc
->base
.size
);
1865 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1866 g_array_index(msg_it
->stored_values
, uint64_t, (uint64_t) int_fc
->storing_index
) = value
;
1869 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
1873 field
= borrow_next_field(msg_it
);
1874 BT_ASSERT_DBG(field
);
1875 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1876 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
1877 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
));
1878 bt_field_integer_unsigned_set_value(field
, value
);
1879 stack_top(msg_it
->stack
)->index
++;
1885 static enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
, struct ctf_field_class
*fc
,
1889 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
1890 bt_self_component
*self_comp
= msg_it
->self_comp
;
1891 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1892 bt_field
*string_field
= NULL
;
1893 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
1894 char str
[2] = {'\0', '\0'};
1896 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
1897 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1898 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1899 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1900 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1901 BT_ASSERT_DBG(!int_fc
->mapped_clock_class
);
1902 BT_ASSERT_DBG(int_fc
->storing_index
< 0);
1904 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
1908 if (msg_it
->done_filling_string
) {
1913 msg_it
->done_filling_string
= true;
1917 string_field
= stack_top(msg_it
->stack
)->base
;
1918 BT_ASSERT_DBG(bt_field_get_class_type(string_field
) == BT_FIELD_CLASS_TYPE_STRING
);
1920 /* Append character */
1921 str
[0] = (char) value
;
1922 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
1924 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1925 "Cannot append character to string field's value: "
1926 "msg-it-addr=%p, field-addr=%p, ret=%d",
1927 msg_it
, string_field
, ret
);
1928 status
= BT_BFCR_STATUS_ERROR
;
1936 static enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
, struct ctf_field_class
*fc
, void *data
)
1938 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1939 bt_field
*field
= NULL
;
1940 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
1941 ctf_field_class_int
*int_fc
= ctf_field_class_as_int(fc
);
1943 BT_COMP_LOGT("Signed integer function called from BFCR: "
1944 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1945 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
1946 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1947 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1949 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1950 g_array_index(msg_it
->stored_values
, uint64_t, (uint64_t) int_fc
->storing_index
) =
1954 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
1958 field
= borrow_next_field(msg_it
);
1959 BT_ASSERT_DBG(field
);
1960 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1962 bt_field_class_type_is(bt_field_get_class_type(field
), BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
));
1963 bt_field_integer_signed_set_value(field
, value
);
1964 stack_top(msg_it
->stack
)->index
++;
1970 static enum bt_bfcr_status
bfcr_floating_point_cb(double value
, struct ctf_field_class
*fc
,
1973 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1974 bt_field
*field
= NULL
;
1975 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
1976 bt_field_class_type type
;
1978 BT_COMP_LOGT("Floating point number function called from BFCR: "
1979 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1980 "fc-type=%d, fc-in-ir=%d, value=%f",
1981 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1983 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
1987 field
= borrow_next_field(msg_it
);
1988 type
= bt_field_get_class_type(field
);
1989 BT_ASSERT_DBG(field
);
1990 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1991 BT_ASSERT_DBG(bt_field_class_type_is(type
, BT_FIELD_CLASS_TYPE_REAL
));
1993 if (type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
1994 bt_field_real_single_precision_set_value(field
, (float) value
);
1996 bt_field_real_double_precision_set_value(field
, value
);
1998 stack_top(msg_it
->stack
)->index
++;
2004 static enum bt_bfcr_status
bfcr_string_begin_cb(struct ctf_field_class
*fc
, void *data
)
2006 bt_field
*field
= NULL
;
2007 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2009 BT_COMP_LOGT("String (beginning) function called from BFCR: "
2010 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2011 "fc-type=%d, fc-in-ir=%d",
2012 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2014 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2018 field
= borrow_next_field(msg_it
);
2019 BT_ASSERT_DBG(field
);
2020 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2021 BT_ASSERT_DBG(bt_field_get_class_type(field
) == BT_FIELD_CLASS_TYPE_STRING
);
2022 bt_field_string_clear(field
);
2025 * Push on stack. Not a compound class per se, but we know that
2026 * only bfcr_string_cb() may be called between this call and a
2027 * subsequent call to bfcr_string_end_cb().
2029 stack_push(msg_it
->stack
, field
);
2032 return BT_BFCR_STATUS_OK
;
2035 static enum bt_bfcr_status
bfcr_string_cb(const char *value
, size_t len
, struct ctf_field_class
*fc
,
2038 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2039 bt_field
*field
= NULL
;
2040 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2041 bt_self_component
*self_comp
= msg_it
->self_comp
;
2044 BT_COMP_LOGT("String (substring) function called from BFCR: "
2045 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2046 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2047 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, len
);
2049 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2053 field
= stack_top(msg_it
->stack
)->base
;
2054 BT_ASSERT_DBG(field
);
2056 /* Append current substring */
2057 ret
= bt_field_string_append_with_length(field
, value
, len
);
2059 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2060 "Cannot append substring to string field's value: "
2061 "msg-it-addr=%p, field-addr=%p, string-length=%zu, "
2063 msg_it
, field
, len
, ret
);
2064 status
= BT_BFCR_STATUS_ERROR
;
2072 static enum bt_bfcr_status
bfcr_string_end_cb(struct ctf_field_class
*fc
, void *data
)
2074 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2076 BT_COMP_LOGT("String (end) function called from BFCR: "
2077 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2078 "fc-type=%d, fc-in-ir=%d",
2079 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2081 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2085 /* Pop string field */
2086 stack_pop(msg_it
->stack
);
2088 /* Go to next field */
2089 stack_top(msg_it
->stack
)->index
++;
2092 return BT_BFCR_STATUS_OK
;
2095 static enum bt_bfcr_status
bfcr_compound_begin_cb(struct ctf_field_class
*fc
, void *data
)
2097 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2100 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2101 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2102 "fc-type=%d, fc-in-ir=%d",
2103 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2105 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2110 if (stack_empty(msg_it
->stack
)) {
2111 /* Root: already set by read_dscope_begin_state() */
2112 field
= msg_it
->cur_dscope_field
;
2114 field
= borrow_next_field(msg_it
);
2115 BT_ASSERT_DBG(field
);
2119 BT_ASSERT_DBG(field
);
2120 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2121 stack_push(msg_it
->stack
, field
);
2124 * Change BFCR "unsigned int" callback if it's a text
2127 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
|| fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2128 ctf_field_class_array_base
*array_fc
= ctf_field_class_as_array_base(fc
);
2130 if (array_fc
->is_text
) {
2131 BT_ASSERT_DBG(bt_field_get_class_type(field
) == BT_FIELD_CLASS_TYPE_STRING
);
2132 msg_it
->done_filling_string
= false;
2133 bt_field_string_clear(field
);
2134 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
, bfcr_unsigned_int_char_cb
);
2139 return BT_BFCR_STATUS_OK
;
2142 static enum bt_bfcr_status
bfcr_compound_end_cb(struct ctf_field_class
*fc
, void *data
)
2144 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2146 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2147 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2148 "fc-type=%d, fc-in-ir=%d",
2149 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2151 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2155 BT_ASSERT_DBG(!stack_empty(msg_it
->stack
));
2156 BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(msg_it
->stack
)->base
) == fc
->ir_fc
);
2159 * Reset BFCR "unsigned int" callback if it's a text
2162 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
|| fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2163 ctf_field_class_array_base
*array_fc
= ctf_field_class_as_array_base(fc
);
2165 if (array_fc
->is_text
) {
2166 BT_ASSERT_DBG(bt_field_get_class_type(stack_top(msg_it
->stack
)->base
) ==
2167 BT_FIELD_CLASS_TYPE_STRING
);
2168 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
, bfcr_unsigned_int_cb
);
2173 stack_pop(msg_it
->stack
);
2175 /* If the stack is not empty, increment the base's index */
2176 if (!stack_empty(msg_it
->stack
)) {
2177 stack_top(msg_it
->stack
)->index
++;
2181 return BT_BFCR_STATUS_OK
;
2184 static int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2186 bt_field
*seq_field
;
2187 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2188 bt_self_component
*self_comp
= msg_it
->self_comp
;
2189 struct ctf_field_class_sequence
*seq_fc
= ctf_field_class_as_sequence(fc
);
2193 length
= (uint64_t) g_array_index(msg_it
->stored_values
, uint64_t, seq_fc
->stored_length_index
);
2195 if (G_UNLIKELY(msg_it
->dry_run
)) {
2199 seq_field
= stack_top(msg_it
->stack
)->base
;
2200 BT_ASSERT_DBG(seq_field
);
2203 * bfcr_get_sequence_length_cb() also gets called back for a
2204 * text sequence, but the destination field is a string field.
2205 * Only set the field's sequence length if the destination field
2206 * is a sequence field.
2208 if (!seq_fc
->base
.is_text
) {
2209 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(seq_field
),
2210 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
));
2211 ret
= bt_field_array_dynamic_set_length(seq_field
, (uint64_t) length
);
2213 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2214 "Cannot set dynamic array field's length field: "
2215 "msg-it-addr=%p, field-addr=%p, "
2217 msg_it
, seq_field
, length
);
2226 static struct ctf_field_class
*
2227 bfcr_borrow_variant_selected_field_class_cb(struct ctf_field_class
*fc
, void *data
)
2231 int64_t option_index
= -1;
2232 ctf_msg_iter
*msg_it
= (ctf_msg_iter
*) data
;
2233 ctf_field_class_variant
*var_fc
= ctf_field_class_as_variant(fc
);
2234 struct ctf_named_field_class
*selected_option
= NULL
;
2235 bt_self_component
*self_comp
= msg_it
->self_comp
;
2236 struct ctf_field_class
*ret_fc
= NULL
;
2243 /* Get variant's tag */
2244 tag
.u
= g_array_index(msg_it
->stored_values
, uint64_t, var_fc
->stored_tag_index
);
2247 * Check each range to find the selected option's index.
2249 if (var_fc
->tag_fc
->base
.is_signed
) {
2250 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2251 struct ctf_field_class_variant_range
*range
=
2252 ctf_field_class_variant_borrow_range_by_index(var_fc
, i
);
2254 if (tag
.i
>= range
->range
.lower
.i
&& tag
.i
<= range
->range
.upper
.i
) {
2255 option_index
= (int64_t) range
->option_index
;
2260 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2261 struct ctf_field_class_variant_range
*range
=
2262 ctf_field_class_variant_borrow_range_by_index(var_fc
, i
);
2264 if (tag
.u
>= range
->range
.lower
.u
&& tag
.u
<= range
->range
.upper
.u
) {
2265 option_index
= (int64_t) range
->option_index
;
2271 if (option_index
< 0) {
2272 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2273 "Cannot find variant field class's option: "
2274 "msg-it-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2276 msg_it
, var_fc
, tag
.u
, tag
.i
);
2282 ctf_field_class_variant_borrow_option_by_index(var_fc
, (uint64_t) option_index
);
2284 if (selected_option
->fc
->in_ir
&& !msg_it
->dry_run
) {
2285 bt_field
*var_field
= stack_top(msg_it
->stack
)->base
;
2287 ret
= bt_field_variant_select_option_by_index(var_field
, option_index
);
2289 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2290 "Cannot select variant field's option field: "
2291 "msg-it-addr=%p, var-field-addr=%p, "
2292 "opt-index=%" PRId64
,
2293 msg_it
, var_field
, option_index
);
2299 ret_fc
= selected_option
->fc
;
2305 static bt_message
*create_msg_stream_beginning(struct ctf_msg_iter
*msg_it
)
2307 bt_self_component
*self_comp
= msg_it
->self_comp
;
2310 BT_ASSERT(msg_it
->stream
);
2311 BT_ASSERT(msg_it
->self_msg_iter
);
2312 msg
= bt_message_stream_beginning_create(msg_it
->self_msg_iter
, msg_it
->stream
);
2314 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2315 "Cannot create stream beginning message: "
2316 "msg-it-addr=%p, stream-addr=%p",
2317 msg_it
, msg_it
->stream
);
2323 static bt_message
*create_msg_stream_end(struct ctf_msg_iter
*msg_it
)
2325 bt_self_component
*self_comp
= msg_it
->self_comp
;
2328 if (!msg_it
->stream
) {
2329 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2330 "Cannot create stream end message because stream is NULL: "
2337 BT_ASSERT(msg_it
->self_msg_iter
);
2338 msg
= bt_message_stream_end_create(msg_it
->self_msg_iter
, msg_it
->stream
);
2340 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2341 "Cannot create stream end message: "
2342 "msg-it-addr=%p, stream-addr=%p",
2343 msg_it
, msg_it
->stream
);
2350 static bt_message
*create_msg_packet_beginning(struct ctf_msg_iter
*msg_it
, bool use_default_cs
)
2352 bt_self_component
*self_comp
= msg_it
->self_comp
;
2354 const bt_stream_class
*sc
= msg_it
->meta
.sc
->ir_sc
;
2356 BT_ASSERT(msg_it
->packet
);
2358 BT_ASSERT(msg_it
->self_msg_iter
);
2360 if (msg_it
->meta
.sc
->packets_have_ts_begin
) {
2361 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2362 uint64_t raw_cs_value
;
2365 * Either use the decoded packet `timestamp_begin` field or the
2366 * current stream's default clock_snapshot.
2368 if (use_default_cs
) {
2369 raw_cs_value
= msg_it
->default_clock_snapshot
;
2371 raw_cs_value
= msg_it
->snapshots
.beginning_clock
;
2374 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2375 msg_it
->self_msg_iter
, msg_it
->packet
, raw_cs_value
);
2377 msg
= bt_message_packet_beginning_create(msg_it
->self_msg_iter
, msg_it
->packet
);
2381 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2382 "Cannot create packet beginning message: "
2383 "msg-it-addr=%p, packet-addr=%p",
2384 msg_it
, msg_it
->packet
);
2392 static bt_message
*emit_delayed_packet_beg_msg(struct ctf_msg_iter
*msg_it
)
2394 bool packet_beg_ts_need_fix_up
;
2396 msg_it
->emit_delayed_packet_beginning_msg
= false;
2399 * Only fix the packet's timestamp_begin if it's larger than the first
2400 * event of the packet. If there was no event in the packet, the
2401 * `default_clock_snapshot` field will be either equal or greater than
2402 * `snapshots.beginning_clock` so there is not fix needed.
2404 packet_beg_ts_need_fix_up
= msg_it
->default_clock_snapshot
< msg_it
->snapshots
.beginning_clock
;
2406 /* create_msg_packet_beginning() logs errors */
2407 return create_msg_packet_beginning(msg_it
, packet_beg_ts_need_fix_up
);
2410 static bt_message
*create_msg_packet_end(struct ctf_msg_iter
*msg_it
)
2413 bool update_default_cs
= true;
2414 bt_self_component
*self_comp
= msg_it
->self_comp
;
2416 if (!msg_it
->packet
) {
2422 * Check if we need to emit the delayed packet
2423 * beginning message instead of the packet end message.
2425 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2426 msg
= emit_delayed_packet_beg_msg(msg_it
);
2427 /* Don't forget to emit the packet end message. */
2428 msg_it
->state
= STATE_EMIT_QUEUED_MSG_PACKET_END
;
2432 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2433 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.lttng_crash
)) {
2435 * Check if the `timestamp_begin` field is non-zero but
2436 * `timestamp_end` is zero. It means the trace is affected by
2437 * the lttng-crash packet `timestamp_end` quirk and must be
2438 * fixed up by omitting to update the default clock snapshot to
2439 * the `timestamp_end` as is typically done.
2441 if (msg_it
->snapshots
.beginning_clock
!= 0 && msg_it
->snapshots
.end_clock
== 0) {
2442 update_default_cs
= false;
2447 * Check if may be affected by lttng event-after-packet `timestamp_end`
2450 if (msg_it
->meta
.tc
->quirks
.lttng_event_after_packet
) {
2452 * Check if `timestamp_end` is smaller then the current
2453 * default_clock_snapshot (which is set to the last event
2454 * decoded). It means the trace is affected by the lttng
2455 * `event-after-packet` packet `timestamp_end` quirk and must
2456 * be fixed up by omitting to update the default clock snapshot
2457 * to the `timestamp_end` as is typically done.
2459 if (msg_it
->snapshots
.end_clock
< msg_it
->default_clock_snapshot
) {
2460 update_default_cs
= false;
2464 /* Update default clock from packet's end time. */
2465 if (msg_it
->snapshots
.end_clock
!= UINT64_C(-1) && update_default_cs
) {
2466 msg_it
->default_clock_snapshot
= msg_it
->snapshots
.end_clock
;
2469 BT_ASSERT(msg_it
->self_msg_iter
);
2471 if (msg_it
->meta
.sc
->packets_have_ts_end
) {
2472 BT_ASSERT(msg_it
->snapshots
.end_clock
!= UINT64_C(-1));
2473 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2474 msg_it
->self_msg_iter
, msg_it
->packet
, msg_it
->default_clock_snapshot
);
2476 msg
= bt_message_packet_end_create(msg_it
->self_msg_iter
, msg_it
->packet
);
2480 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2481 "Cannot create packet end message: "
2482 "msg-it-addr=%p, packet-addr=%p",
2483 msg_it
, msg_it
->packet
);
2487 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2493 static bt_message
*create_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
2496 bt_self_component
*self_comp
= msg_it
->self_comp
;
2497 uint64_t beginning_raw_value
= UINT64_C(-1);
2498 uint64_t end_raw_value
= UINT64_C(-1);
2500 BT_ASSERT(msg_it
->self_msg_iter
);
2501 BT_ASSERT(msg_it
->stream
);
2502 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_events
);
2504 if (msg_it
->meta
.sc
->discarded_events_have_default_cs
) {
2505 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2507 * We discarded events, but before (and possibly
2508 * including) the current packet: use this packet's time
2509 * range, and do not have a specific count.
2511 beginning_raw_value
= msg_it
->snapshots
.beginning_clock
;
2512 end_raw_value
= msg_it
->snapshots
.end_clock
;
2514 beginning_raw_value
= msg_it
->prev_packet_snapshots
.end_clock
;
2515 end_raw_value
= msg_it
->snapshots
.end_clock
;
2518 BT_ASSERT(beginning_raw_value
!= UINT64_C(-1));
2519 BT_ASSERT(end_raw_value
!= UINT64_C(-1));
2520 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2521 msg_it
->self_msg_iter
, msg_it
->stream
, beginning_raw_value
, end_raw_value
);
2523 msg
= bt_message_discarded_events_create(msg_it
->self_msg_iter
, msg_it
->stream
);
2527 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2528 "Cannot create discarded events message: "
2529 "msg-it-addr=%p, stream-addr=%p",
2530 msg_it
, msg_it
->stream
);
2534 if (msg_it
->prev_packet_snapshots
.discarded_events
!= UINT64_C(-1)) {
2535 bt_message_discarded_events_set_count(msg
,
2536 msg_it
->snapshots
.discarded_events
-
2537 msg_it
->prev_packet_snapshots
.discarded_events
);
2544 static bt_message
*create_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
2547 bt_self_component
*self_comp
= msg_it
->self_comp
;
2549 BT_ASSERT(msg_it
->self_msg_iter
);
2550 BT_ASSERT(msg_it
->stream
);
2551 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_packets
);
2552 BT_ASSERT(msg_it
->prev_packet_snapshots
.packets
!= UINT64_C(-1));
2554 if (msg_it
->meta
.sc
->discarded_packets_have_default_cs
) {
2555 BT_ASSERT(msg_it
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1));
2556 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2557 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2558 msg_it
->self_msg_iter
, msg_it
->stream
, msg_it
->prev_packet_snapshots
.end_clock
,
2559 msg_it
->snapshots
.beginning_clock
);
2561 msg
= bt_message_discarded_packets_create(msg_it
->self_msg_iter
, msg_it
->stream
);
2565 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2566 "Cannot create discarded packets message: "
2567 "msg-it-addr=%p, stream-addr=%p",
2568 msg_it
, msg_it
->stream
);
2572 bt_message_discarded_packets_set_count(msg
, msg_it
->snapshots
.packets
-
2573 msg_it
->prev_packet_snapshots
.packets
- 1);
2580 struct ctf_msg_iter
*ctf_msg_iter_create(struct ctf_trace_class
*tc
, size_t max_request_sz
,
2581 struct ctf_msg_iter_medium_ops medops
, void *data
,
2582 bt_logging_level log_level
, bt_self_component
*self_comp
,
2583 bt_self_message_iterator
*self_msg_iter
)
2585 struct ctf_msg_iter
*msg_it
= NULL
;
2586 struct bt_bfcr_cbs cbs
= {
2589 .signed_int
= bfcr_signed_int_cb
,
2590 .unsigned_int
= bfcr_unsigned_int_cb
,
2591 .floating_point
= bfcr_floating_point_cb
,
2592 .string_begin
= bfcr_string_begin_cb
,
2593 .string
= bfcr_string_cb
,
2594 .string_end
= bfcr_string_end_cb
,
2595 .compound_begin
= bfcr_compound_begin_cb
,
2596 .compound_end
= bfcr_compound_end_cb
,
2600 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2601 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2606 BT_ASSERT(medops
.request_bytes
);
2607 BT_ASSERT(medops
.borrow_stream
);
2608 BT_ASSERT(max_request_sz
> 0);
2610 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, log_level
, self_comp
,
2611 "Creating CTF plugin message iterator: "
2612 "trace-addr=%p, max-request-size=%zu, "
2613 "data=%p, log-level=%s",
2614 tc
, max_request_sz
, data
, bt_common_logging_level_string(log_level
));
2615 msg_it
= g_new0(struct ctf_msg_iter
, 1);
2617 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2618 "Failed to allocate one CTF plugin message iterator.");
2621 msg_it
->self_comp
= self_comp
;
2622 msg_it
->self_msg_iter
= self_msg_iter
;
2623 msg_it
->log_level
= log_level
;
2624 msg_it
->meta
.tc
= tc
;
2625 msg_it
->medium
.medops
= medops
;
2626 msg_it
->medium
.max_request_sz
= max_request_sz
;
2627 msg_it
->medium
.data
= data
;
2628 msg_it
->stack
= stack_new(msg_it
);
2629 msg_it
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2630 g_array_set_size(msg_it
->stored_values
, tc
->stored_value_count
);
2632 if (!msg_it
->stack
) {
2633 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create field stack.");
2637 msg_it
->bfcr
= bt_bfcr_create(cbs
, msg_it
, log_level
, NULL
);
2638 if (!msg_it
->bfcr
) {
2639 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create binary class reader (BFCR).");
2643 ctf_msg_iter_reset(msg_it
);
2644 BT_COMP_LOGD("Created CTF plugin message iterator: "
2645 "trace-addr=%p, max-request-size=%zu, "
2646 "data=%p, msg-it-addr=%p, log-level=%s",
2647 tc
, max_request_sz
, data
, msg_it
, bt_common_logging_level_string(log_level
));
2648 msg_it
->cur_packet_offset
= 0;
2654 ctf_msg_iter_destroy(msg_it
);
2659 void ctf_msg_iter_destroy(struct ctf_msg_iter
*msg_it
)
2661 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2662 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
2663 release_all_dscopes(msg_it
);
2665 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it
);
2667 if (msg_it
->stack
) {
2668 BT_COMP_LOGD_STR("Destroying field stack.");
2669 stack_destroy(msg_it
->stack
);
2673 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it
->bfcr
);
2674 bt_bfcr_destroy(msg_it
->bfcr
);
2677 if (msg_it
->stored_values
) {
2678 g_array_free(msg_it
->stored_values
, TRUE
);
2684 enum ctf_msg_iter_status
ctf_msg_iter_get_next_message(struct ctf_msg_iter
*msg_it
,
2685 const bt_message
**message
)
2687 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2688 bt_self_component
*self_comp
= msg_it
->self_comp
;
2690 BT_ASSERT_DBG(msg_it
);
2691 BT_ASSERT_DBG(message
);
2692 BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it
);
2695 status
= handle_state(msg_it
);
2696 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
2697 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2699 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
2700 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot handle state: msg-it-addr=%p, state=%s",
2701 msg_it
, state_string(msg_it
->state
));
2705 switch (msg_it
->state
) {
2706 case STATE_EMIT_MSG_EVENT
:
2707 BT_ASSERT_DBG(msg_it
->event_msg
);
2710 * Check if we need to emit the delayed packet
2711 * beginning message instead of the event message.
2713 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2714 *message
= emit_delayed_packet_beg_msg(msg_it
);
2716 status
= CTF_MSG_ITER_STATUS_ERROR
;
2720 * Don't forget to emit the event message of
2721 * the event record that was just decoded.
2723 msg_it
->state
= STATE_EMIT_QUEUED_MSG_EVENT
;
2726 *message
= msg_it
->event_msg
;
2727 msg_it
->event_msg
= NULL
;
2730 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2731 /* create_msg_discared_events() logs errors */
2732 *message
= create_msg_discarded_events(msg_it
);
2735 status
= CTF_MSG_ITER_STATUS_ERROR
;
2739 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2740 /* create_msg_discared_packets() logs errors */
2741 *message
= create_msg_discarded_packets(msg_it
);
2744 status
= CTF_MSG_ITER_STATUS_ERROR
;
2748 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2749 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.barectf_event_before_packet
)) {
2750 msg_it
->emit_delayed_packet_beginning_msg
= true;
2752 * There is no message to return yet as this
2753 * packet beginning message is delayed until we
2754 * decode the first event message of the
2759 /* create_msg_packet_beginning() logs errors */
2760 *message
= create_msg_packet_beginning(msg_it
, false);
2762 status
= CTF_MSG_ITER_STATUS_ERROR
;
2767 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2768 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2769 /* create_msg_packet_end() logs errors */
2770 *message
= create_msg_packet_end(msg_it
);
2773 status
= CTF_MSG_ITER_STATUS_ERROR
;
2777 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2778 /* create_msg_stream_beginning() logs errors */
2779 *message
= create_msg_stream_beginning(msg_it
);
2780 msg_it
->emit_stream_beginning_message
= false;
2781 msg_it
->emit_stream_end_message
= true;
2784 status
= CTF_MSG_ITER_STATUS_ERROR
;
2788 case STATE_EMIT_MSG_STREAM_END
:
2789 /* create_msg_stream_end() logs errors */
2790 *message
= create_msg_stream_end(msg_it
);
2791 msg_it
->emit_stream_end_message
= false;
2794 status
= CTF_MSG_ITER_STATUS_ERROR
;
2799 status
= CTF_MSG_ITER_STATUS_EOF
;
2802 /* Non-emitting state: continue */
2811 static enum ctf_msg_iter_status
decode_until_state(struct ctf_msg_iter
*msg_it
,
2812 enum state target_state_1
,
2813 enum state target_state_2
)
2815 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2816 bt_self_component
*self_comp
= msg_it
->self_comp
;
2818 BT_ASSERT_DBG(msg_it
);
2822 * Check if we reached the state at which we want to stop
2825 if (msg_it
->state
== target_state_1
|| msg_it
->state
== target_state_2
) {
2829 status
= handle_state(msg_it
);
2830 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
2831 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2833 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
2834 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot handle state: msg-it-addr=%p, state=%s",
2835 msg_it
, state_string(msg_it
->state
));
2839 switch (msg_it
->state
) {
2841 case STATE_SWITCH_PACKET
:
2842 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
2843 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
2844 case STATE_AFTER_TRACE_PACKET_HEADER
:
2845 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
2846 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
2847 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
2848 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2849 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
2850 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2851 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
2852 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2853 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2854 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
2855 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
2856 case STATE_AFTER_EVENT_HEADER
:
2857 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
2858 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
2859 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
2860 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
2861 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
2862 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
2863 case STATE_EMIT_MSG_EVENT
:
2864 case STATE_EMIT_QUEUED_MSG_EVENT
:
2865 case STATE_SKIP_PACKET_PADDING
:
2866 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2867 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2868 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
2869 case STATE_EMIT_MSG_STREAM_END
:
2874 /* We should never get to the STATE_DONE state. */
2875 BT_COMP_LOGF("Unexpected state: msg-it-addr=%p, state=%s", msg_it
,
2876 state_string(msg_it
->state
));
2885 static enum ctf_msg_iter_status
read_packet_header_context_fields(struct ctf_msg_iter
*msg_it
)
2888 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2890 status
= decode_until_state(msg_it
, STATE_EMIT_MSG_PACKET_BEGINNING
, (state
) -1);
2891 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
2895 ret
= set_current_packet_content_sizes(msg_it
);
2897 status
= CTF_MSG_ITER_STATUS_ERROR
;
2906 enum ctf_msg_iter_status
ctf_msg_iter_seek(struct ctf_msg_iter
*msg_it
, off_t offset
)
2908 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2909 enum ctf_msg_iter_medium_status medium_status
;
2912 BT_ASSERT(offset
>= 0);
2913 BT_ASSERT(msg_it
->medium
.medops
.seek
);
2915 medium_status
= msg_it
->medium
.medops
.seek(offset
, msg_it
->medium
.data
);
2916 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
2917 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
2918 status
= CTF_MSG_ITER_STATUS_EOF
;
2920 status
= CTF_MSG_ITER_STATUS_ERROR
;
2925 ctf_msg_iter_reset(msg_it
);
2926 msg_it
->cur_packet_offset
= offset
;
2932 static enum ctf_msg_iter_status
clock_snapshot_at_msg_iter_state(struct ctf_msg_iter
*msg_it
,
2933 enum state target_state_1
,
2934 enum state target_state_2
,
2935 uint64_t *clock_snapshot
)
2937 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2939 BT_ASSERT_DBG(msg_it
);
2940 BT_ASSERT_DBG(clock_snapshot
);
2941 status
= decode_until_state(msg_it
, target_state_1
, target_state_2
);
2942 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
2946 *clock_snapshot
= msg_it
->default_clock_snapshot
;
2952 enum ctf_msg_iter_status
2953 ctf_msg_iter_curr_packet_first_event_clock_snapshot(struct ctf_msg_iter
*msg_it
,
2954 uint64_t *first_clock_snapshot
)
2956 return clock_snapshot_at_msg_iter_state(msg_it
, STATE_AFTER_EVENT_HEADER
, (state
) -1,
2957 first_clock_snapshot
);
2961 enum ctf_msg_iter_status
2962 ctf_msg_iter_curr_packet_last_event_clock_snapshot(struct ctf_msg_iter
*msg_it
,
2963 uint64_t *last_clock_snapshot
)
2965 return clock_snapshot_at_msg_iter_state(msg_it
, STATE_EMIT_MSG_PACKET_END_SINGLE
,
2966 STATE_EMIT_MSG_PACKET_END_MULTI
, last_clock_snapshot
);
2970 enum ctf_msg_iter_status
2971 ctf_msg_iter_get_packet_properties(struct ctf_msg_iter
*msg_it
,
2972 struct ctf_msg_iter_packet_properties
*props
)
2974 enum ctf_msg_iter_status status
;
2976 BT_ASSERT_DBG(msg_it
);
2977 BT_ASSERT_DBG(props
);
2978 status
= read_packet_header_context_fields(msg_it
);
2979 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
2983 props
->exp_packet_total_size
= msg_it
->cur_exp_packet_total_size
;
2984 props
->exp_packet_content_size
= msg_it
->cur_exp_packet_content_size
;
2985 props
->stream_class_id
= (uint64_t) msg_it
->cur_stream_class_id
;
2986 props
->data_stream_id
= msg_it
->cur_data_stream_id
;
2987 props
->snapshots
.discarded_events
= msg_it
->snapshots
.discarded_events
;
2988 props
->snapshots
.packets
= msg_it
->snapshots
.packets
;
2989 props
->snapshots
.beginning_clock
= msg_it
->snapshots
.beginning_clock
;
2990 props
->snapshots
.end_clock
= msg_it
->snapshots
.end_clock
;
2997 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter
*msg_it
, bool val
)
2999 msg_it
->dry_run
= val
;