2 * Babeltrace - CTF message iterator
4 * Copyright (c) 2015-2018 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #define BT_COMP_LOG_SELF_COMP (msg_it->self_comp)
27 #define BT_LOG_OUTPUT_LEVEL (msg_it->log_level)
28 #define BT_LOG_TAG "PLUGIN/CTF/MSG-ITER"
29 #include "logging/comp-logging.h"
36 #include "common/assert.h"
38 #include <babeltrace2/babeltrace.h>
39 #include "common/common.h"
44 #include "../bfcr/bfcr.h"
48 /* A visit stack entry */
51 * Current base field, one of:
63 /* Index of next field to set */
71 struct ctf_msg_iter
*msg_it
;
73 /* Entries (struct stack_entry) */
76 /* Number of active entries */
84 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
85 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
86 STATE_AFTER_TRACE_PACKET_HEADER
,
87 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
88 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
89 STATE_AFTER_STREAM_PACKET_CONTEXT
,
90 STATE_EMIT_MSG_STREAM_BEGINNING
,
91 STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
,
92 STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
,
93 STATE_EMIT_MSG_DISCARDED_EVENTS
,
94 STATE_EMIT_MSG_DISCARDED_PACKETS
,
95 STATE_EMIT_MSG_PACKET_BEGINNING
,
96 STATE_DSCOPE_EVENT_HEADER_BEGIN
,
97 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
98 STATE_AFTER_EVENT_HEADER
,
99 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
,
100 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
101 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
102 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
103 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
104 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
105 STATE_EMIT_MSG_EVENT
,
106 STATE_EMIT_QUEUED_MSG_EVENT
,
107 STATE_SKIP_PACKET_PADDING
,
108 STATE_EMIT_MSG_PACKET_END_MULTI
,
109 STATE_EMIT_MSG_PACKET_END_SINGLE
,
110 STATE_EMIT_QUEUED_MSG_PACKET_END
,
111 STATE_EMIT_MSG_STREAM_END
,
115 struct end_of_packet_snapshots
{
116 uint64_t discarded_events
;
118 uint64_t beginning_clock
;
122 /* CTF message iterator */
123 struct ctf_msg_iter
{
127 /* Current message iterator to create messages (weak) */
128 bt_self_message_iterator
*self_msg_iter
;
131 * True if library objects are unavailable during the decoding and
132 * should not be created/used.
136 /* True to set the stream */
140 * Current dynamic scope field pointer.
142 * This is set by read_dscope_begin_state() and contains the
143 * value of one of the pointers in `dscopes` below.
145 bt_field
*cur_dscope_field
;
148 * True if we're done filling a string field from a text
149 * array/sequence payload.
151 bool done_filling_string
;
153 /* Trace and classes */
154 /* True to set IR fields */
158 struct ctf_trace_class
*tc
;
159 struct ctf_stream_class
*sc
;
160 struct ctf_event_class
*ec
;
163 /* Current packet context field wrapper (NULL if not created yet) */
164 bt_packet_context_field
*packet_context_field
;
166 /* Current packet (NULL if not created yet) */
169 /* Current stream (NULL if not set yet) */
172 /* Current event (NULL if not created yet) */
175 /* Current event message (NULL if not created yet) */
176 bt_message
*event_msg
;
179 * True if we need to emit a packet beginning message before we emit
180 * the next event message or the packet end message.
182 bool emit_delayed_packet_beginning_msg
;
184 /* 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 */
197 /* Last address provided by medium */
200 /* Buffer size provided by medium (bytes) */
203 /* Offset within whole packet of addr (bits) */
204 size_t packet_offset
;
206 /* Current position from addr (bits) */
209 /* Position of the last event header from addr (bits) */
213 /* Binary type reader */
214 struct bt_bfcr
*bfcr
;
216 /* Current medium data */
218 struct ctf_msg_iter_medium_ops medops
;
219 size_t max_request_sz
;
223 /* Current packet size (bits) (-1 if unknown) */
224 int64_t cur_exp_packet_total_size
;
226 /* Current content size (bits) (-1 if unknown) */
227 int64_t cur_exp_packet_content_size
;
229 /* Current stream class ID */
230 int64_t cur_stream_class_id
;
232 /* Current event class ID */
233 int64_t cur_event_class_id
;
235 /* Current data stream ID */
236 int64_t cur_data_stream_id
;
239 * Offset, in the underlying media, of the current packet's
240 * start (-1 if unknown).
242 off_t cur_packet_offset
;
244 /* Default clock's current value */
245 uint64_t default_clock_snapshot
;
247 /* End of current packet snapshots */
248 struct end_of_packet_snapshots snapshots
;
250 /* End of previous packet snapshots */
251 struct end_of_packet_snapshots prev_packet_snapshots
;
253 /* Stored values (for sequence lengths, variant tags) */
254 GArray
*stored_values
;
256 /* Iterator's current log level */
257 bt_logging_level log_level
;
259 /* Iterator's owning self component, or `NULL` if none (query) */
260 bt_self_component
*self_comp
;
264 const char *state_string(enum state state
)
269 case STATE_SWITCH_PACKET
:
270 return "SWITCH_PACKET";
271 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
272 return "DSCOPE_TRACE_PACKET_HEADER_BEGIN";
273 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
274 return "DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
275 case STATE_AFTER_TRACE_PACKET_HEADER
:
276 return "AFTER_TRACE_PACKET_HEADER";
277 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
278 return "DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
279 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
280 return "DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
281 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
282 return "AFTER_STREAM_PACKET_CONTEXT";
283 case STATE_EMIT_MSG_STREAM_BEGINNING
:
284 return "EMIT_MSG_STREAM_BEGINNING";
285 case STATE_EMIT_MSG_PACKET_BEGINNING
:
286 return "EMIT_MSG_PACKET_BEGINNING";
287 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
288 return "EMIT_MSG_DISCARDED_EVENTS";
289 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
290 return "EMIT_MSG_DISCARDED_PACKETS";
291 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
292 return "DSCOPE_EVENT_HEADER_BEGIN";
293 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
294 return "DSCOPE_EVENT_HEADER_CONTINUE";
295 case STATE_AFTER_EVENT_HEADER
:
296 return "AFTER_EVENT_HEADER";
297 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
298 return "DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
299 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
300 return "DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
301 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
302 return "DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
303 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
304 return "DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
305 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
306 return "DSCOPE_EVENT_PAYLOAD_BEGIN";
307 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
308 return "DSCOPE_EVENT_PAYLOAD_CONTINUE";
309 case STATE_EMIT_MSG_EVENT
:
310 return "EMIT_MSG_EVENT";
311 case STATE_EMIT_QUEUED_MSG_EVENT
:
312 return "EMIT_QUEUED_MSG_EVENT";
313 case STATE_SKIP_PACKET_PADDING
:
314 return "SKIP_PACKET_PADDING";
315 case STATE_EMIT_MSG_PACKET_END_MULTI
:
316 return "EMIT_MSG_PACKET_END_MULTI";
317 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
318 return "EMIT_MSG_PACKET_END_SINGLE";
319 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
320 return "EMIT_QUEUED_MSG_PACKET_END";
321 case STATE_EMIT_MSG_STREAM_END
:
322 return "EMIT_MSG_STREAM_END";
331 struct stack
*stack_new(struct ctf_msg_iter
*msg_it
)
333 bt_self_component
*self_comp
= msg_it
->self_comp
;
334 struct stack
*stack
= NULL
;
336 stack
= g_new0(struct stack
, 1);
338 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
339 "Failed to allocate one stack.");
343 stack
->msg_it
= msg_it
;
344 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
345 if (!stack
->entries
) {
346 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
347 "Failed to allocate a GArray.");
351 BT_COMP_LOGD("Created stack: msg-it-addr=%p, stack-addr=%p", msg_it
, stack
);
363 void stack_destroy(struct stack
*stack
)
365 struct ctf_msg_iter
*msg_it
;
367 BT_ASSERT_DBG(stack
);
368 msg_it
= stack
->msg_it
;
369 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
371 if (stack
->entries
) {
372 g_array_free(stack
->entries
, TRUE
);
379 void stack_push(struct stack
*stack
, bt_field
*base
)
381 struct stack_entry
*entry
;
382 struct ctf_msg_iter
*msg_it
;
384 BT_ASSERT_DBG(stack
);
385 msg_it
= stack
->msg_it
;
387 BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, "
388 "stack-size-before=%zu, stack-size-after=%zu",
389 stack
, stack
->size
, stack
->size
+ 1);
391 if (stack
->entries
->len
== stack
->size
) {
392 g_array_set_size(stack
->entries
, stack
->size
+ 1);
395 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
402 unsigned int stack_size(struct stack
*stack
)
404 BT_ASSERT_DBG(stack
);
409 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);
423 struct stack_entry
*stack_top(struct stack
*stack
)
425 BT_ASSERT_DBG(stack
);
426 BT_ASSERT_DBG(stack_size(stack
));
427 return &g_array_index(stack
->entries
, struct stack_entry
,
432 bool stack_empty(struct stack
*stack
)
434 return stack_size(stack
) == 0;
438 void stack_clear(struct stack
*stack
)
440 BT_ASSERT_DBG(stack
);
445 enum ctf_msg_iter_status
msg_iter_status_from_m_status(
446 enum ctf_msg_iter_medium_status m_status
)
448 /* They are the same */
449 return (int) m_status
;
453 size_t buf_size_bits(struct ctf_msg_iter
*msg_it
)
455 return msg_it
->buf
.sz
* 8;
459 size_t buf_available_bits(struct ctf_msg_iter
*msg_it
)
461 return buf_size_bits(msg_it
) - msg_it
->buf
.at
;
465 size_t packet_at(struct ctf_msg_iter
*msg_it
)
467 return msg_it
->buf
.packet_offset
+ msg_it
->buf
.at
;
471 void buf_consume_bits(struct ctf_msg_iter
*msg_it
, size_t incr
)
473 BT_COMP_LOGT("Advancing cursor: msg-it-addr=%p, cur-before=%zu, cur-after=%zu",
474 msg_it
, msg_it
->buf
.at
, msg_it
->buf
.at
+ incr
);
475 msg_it
->buf
.at
+= incr
;
479 enum ctf_msg_iter_status
request_medium_bytes(
480 struct ctf_msg_iter
*msg_it
)
482 bt_self_component
*self_comp
= msg_it
->self_comp
;
483 uint8_t *buffer_addr
= NULL
;
484 size_t buffer_sz
= 0;
485 enum ctf_msg_iter_medium_status m_status
;
487 BT_COMP_LOGD("Calling user function (request bytes): msg-it-addr=%p, "
488 "request-size=%zu", msg_it
, msg_it
->medium
.max_request_sz
);
489 m_status
= msg_it
->medium
.medops
.request_bytes(
490 msg_it
->medium
.max_request_sz
, &buffer_addr
,
491 &buffer_sz
, msg_it
->medium
.data
);
492 BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
493 ctf_msg_iter_medium_status_string(m_status
),
494 buffer_addr
, buffer_sz
);
495 if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
496 BT_ASSERT(buffer_sz
!= 0);
498 /* New packet offset is old one + old size (in bits) */
499 msg_it
->buf
.packet_offset
+= buf_size_bits(msg_it
);
501 /* Restart at the beginning of the new medium buffer */
503 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
505 /* New medium buffer size */
506 msg_it
->buf
.sz
= buffer_sz
;
508 /* New medium buffer address */
509 msg_it
->buf
.addr
= buffer_addr
;
511 BT_COMP_LOGD("User function returned new bytes: "
512 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
513 msg_it
->buf
.packet_offset
, msg_it
->buf
.at
,
514 msg_it
->buf
.sz
, msg_it
->buf
.addr
);
515 BT_COMP_LOGD_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
517 } else if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
519 * User returned end of stream: validate that we're not
520 * in the middle of a packet header, packet context, or
523 if (msg_it
->cur_exp_packet_total_size
>= 0) {
524 if (packet_at(msg_it
) ==
525 msg_it
->cur_exp_packet_total_size
) {
529 if (packet_at(msg_it
) == 0) {
533 if (msg_it
->buf
.last_eh_at
!= SIZE_MAX
&&
534 msg_it
->buf
.at
== msg_it
->buf
.last_eh_at
) {
539 /* All other states are invalid */
540 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
541 "User function returned %s, but message iterator is in an unexpected state: "
542 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
543 "packet-cur=%zu, last-eh-at=%zu",
544 ctf_msg_iter_medium_status_string(m_status
),
545 state_string(msg_it
->state
),
546 msg_it
->cur_exp_packet_total_size
,
547 msg_it
->buf
.at
, packet_at(msg_it
),
548 msg_it
->buf
.last_eh_at
);
549 m_status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
550 } else if (m_status
< 0) {
551 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "User function failed: "
552 "status=%s", ctf_msg_iter_medium_status_string(m_status
));
556 return msg_iter_status_from_m_status(m_status
);
560 enum ctf_msg_iter_status
buf_ensure_available_bits(
561 struct ctf_msg_iter
*msg_it
)
563 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
565 if (G_UNLIKELY(buf_available_bits(msg_it
) == 0)) {
567 * This _cannot_ return CTF_MSG_ITER_STATUS_OK
570 status
= request_medium_bytes(msg_it
);
577 enum ctf_msg_iter_status
read_dscope_begin_state(
578 struct ctf_msg_iter
*msg_it
,
579 struct ctf_field_class
*dscope_fc
,
580 enum state done_state
, enum state continue_state
,
581 bt_field
*dscope_field
)
583 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
584 bt_self_component
*self_comp
= msg_it
->self_comp
;
585 enum bt_bfcr_status bfcr_status
;
586 size_t consumed_bits
;
588 msg_it
->cur_dscope_field
= dscope_field
;
589 BT_COMP_LOGT("Starting BFCR: msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p",
590 msg_it
, msg_it
->bfcr
, dscope_fc
);
591 consumed_bits
= bt_bfcr_start(msg_it
->bfcr
, dscope_fc
,
592 msg_it
->buf
.addr
, msg_it
->buf
.at
, packet_at(msg_it
),
593 msg_it
->buf
.sz
, &bfcr_status
);
594 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
596 switch (bfcr_status
) {
597 case BT_BFCR_STATUS_OK
:
598 /* Field class was read completely */
599 BT_COMP_LOGT_STR("Field was completely decoded.");
600 msg_it
->state
= done_state
;
602 case BT_BFCR_STATUS_EOF
:
603 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
604 msg_it
->state
= continue_state
;
607 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
608 "BFCR failed to start: msg-it-addr=%p, bfcr-addr=%p, "
609 "status=%s", msg_it
, msg_it
->bfcr
,
610 bt_bfcr_status_string(bfcr_status
));
611 status
= CTF_MSG_ITER_STATUS_ERROR
;
615 /* Consume bits now since we know we're not in an error state */
616 buf_consume_bits(msg_it
, consumed_bits
);
623 enum ctf_msg_iter_status
read_dscope_continue_state(
624 struct ctf_msg_iter
*msg_it
, enum state done_state
)
626 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
627 bt_self_component
*self_comp
= msg_it
->self_comp
;
628 enum bt_bfcr_status bfcr_status
;
629 size_t consumed_bits
;
631 BT_COMP_LOGT("Continuing BFCR: msg-it-addr=%p, bfcr-addr=%p",
632 msg_it
, msg_it
->bfcr
);
634 status
= buf_ensure_available_bits(msg_it
);
635 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
637 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
638 "Cannot ensure that buffer has at least one byte: "
639 "msg-addr=%p, status=%s",
640 msg_it
, ctf_msg_iter_status_string(status
));
642 BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: "
643 "msg-addr=%p, status=%s",
644 msg_it
, ctf_msg_iter_status_string(status
));
650 consumed_bits
= bt_bfcr_continue(msg_it
->bfcr
, msg_it
->buf
.addr
,
651 msg_it
->buf
.sz
, &bfcr_status
);
652 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
654 switch (bfcr_status
) {
655 case BT_BFCR_STATUS_OK
:
656 /* Type was read completely. */
657 BT_COMP_LOGT_STR("Field was completely decoded.");
658 msg_it
->state
= done_state
;
660 case BT_BFCR_STATUS_EOF
:
661 /* Stay in this continue state. */
662 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
665 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
666 "BFCR failed to continue: msg-it-addr=%p, bfcr-addr=%p, "
667 "status=%s", msg_it
, msg_it
->bfcr
,
668 bt_bfcr_status_string(bfcr_status
));
669 status
= CTF_MSG_ITER_STATUS_ERROR
;
673 /* Consume bits now since we know we're not in an error state. */
674 buf_consume_bits(msg_it
, consumed_bits
);
680 void release_event_dscopes(struct ctf_msg_iter
*msg_it
)
682 msg_it
->dscopes
.event_common_context
= NULL
;
683 msg_it
->dscopes
.event_spec_context
= NULL
;
684 msg_it
->dscopes
.event_payload
= NULL
;
688 void release_all_dscopes(struct ctf_msg_iter
*msg_it
)
690 msg_it
->dscopes
.stream_packet_context
= NULL
;
692 if (msg_it
->packet_context_field
) {
693 bt_packet_context_field_release(msg_it
->packet_context_field
);
694 msg_it
->packet_context_field
= NULL
;
697 release_event_dscopes(msg_it
);
701 enum ctf_msg_iter_status
switch_packet_state(struct ctf_msg_iter
*msg_it
)
703 enum ctf_msg_iter_status status
;
704 bt_self_component
*self_comp
= msg_it
->self_comp
;
707 * We don't put the stream class here because we need to make
708 * sure that all the packets processed by the same message
709 * iterator refer to the same stream class (the first one).
713 if (msg_it
->cur_exp_packet_total_size
!= -1) {
714 msg_it
->cur_packet_offset
+= msg_it
->cur_exp_packet_total_size
;
717 BT_COMP_LOGD("Switching packet: msg-it-addr=%p, cur=%zu, "
718 "packet-offset=%" PRId64
, msg_it
, msg_it
->buf
.at
,
719 msg_it
->cur_packet_offset
);
720 stack_clear(msg_it
->stack
);
721 msg_it
->meta
.ec
= NULL
;
722 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
723 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
724 release_all_dscopes(msg_it
);
725 msg_it
->cur_dscope_field
= NULL
;
727 if (msg_it
->medium
.medops
.switch_packet
) {
728 enum ctf_msg_iter_medium_status medium_status
;
730 medium_status
= msg_it
->medium
.medops
.switch_packet(msg_it
->medium
.data
);
731 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
732 /* No more packets. */
733 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
734 status
= CTF_MSG_ITER_STATUS_OK
;
736 } else if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
737 status
= (int) medium_status
;
742 * After the packet switch, the medium might want to give us a
743 * different buffer for the new packet.
745 status
= request_medium_bytes(msg_it
);
746 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
752 * Adjust current buffer so that addr points to the beginning of the new
755 if (msg_it
->buf
.addr
) {
756 size_t consumed_bytes
= (size_t) (msg_it
->buf
.at
/ CHAR_BIT
);
758 /* Packets are assumed to start on a byte frontier. */
759 if (msg_it
->buf
.at
% CHAR_BIT
) {
760 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
761 "Cannot switch packet: current position is not a multiple of 8: "
762 "msg-it-addr=%p, cur=%zu", msg_it
, msg_it
->buf
.at
);
763 status
= CTF_MSG_ITER_STATUS_ERROR
;
767 msg_it
->buf
.addr
+= consumed_bytes
;
768 msg_it
->buf
.sz
-= consumed_bytes
;
770 msg_it
->buf
.packet_offset
= 0;
771 BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu",
772 msg_it
->buf
.addr
, msg_it
->buf
.sz
);
775 msg_it
->cur_exp_packet_content_size
= -1;
776 msg_it
->cur_exp_packet_total_size
= -1;
777 msg_it
->cur_stream_class_id
= -1;
778 msg_it
->cur_event_class_id
= -1;
779 msg_it
->cur_data_stream_id
= -1;
780 msg_it
->prev_packet_snapshots
= msg_it
->snapshots
;
781 msg_it
->snapshots
.discarded_events
= UINT64_C(-1);
782 msg_it
->snapshots
.packets
= UINT64_C(-1);
783 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
784 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
785 msg_it
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
787 status
= CTF_MSG_ITER_STATUS_OK
;
793 enum ctf_msg_iter_status
read_packet_header_begin_state(
794 struct ctf_msg_iter
*msg_it
)
796 struct ctf_field_class
*packet_header_fc
= NULL
;
797 bt_self_component
*self_comp
= msg_it
->self_comp
;
798 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
801 * Make sure at least one bit is available for this packet. An
802 * empty packet is impossible. If we reach the end of the medium
803 * at this point, then it's considered the end of the stream.
805 status
= buf_ensure_available_bits(msg_it
);
807 case CTF_MSG_ITER_STATUS_OK
:
809 case CTF_MSG_ITER_STATUS_EOF
:
810 status
= CTF_MSG_ITER_STATUS_OK
;
811 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
817 /* Packet header class is common to the whole trace class. */
818 packet_header_fc
= msg_it
->meta
.tc
->packet_header_fc
;
819 if (!packet_header_fc
) {
820 msg_it
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
824 msg_it
->cur_stream_class_id
= -1;
825 msg_it
->cur_event_class_id
= -1;
826 msg_it
->cur_data_stream_id
= -1;
827 BT_COMP_LOGD("Decoding packet header field:"
828 "msg-it-addr=%p, trace-class-addr=%p, fc-addr=%p",
829 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
830 status
= read_dscope_begin_state(msg_it
, packet_header_fc
,
831 STATE_AFTER_TRACE_PACKET_HEADER
,
832 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
834 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
835 "Cannot decode packet header field: "
836 "msg-it-addr=%p, trace-class-addr=%p, "
838 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
846 enum ctf_msg_iter_status
read_packet_header_continue_state(
847 struct ctf_msg_iter
*msg_it
)
849 return read_dscope_continue_state(msg_it
,
850 STATE_AFTER_TRACE_PACKET_HEADER
);
854 enum ctf_msg_iter_status
set_current_stream_class(struct ctf_msg_iter
*msg_it
)
856 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
857 bt_self_component
*self_comp
= msg_it
->self_comp
;
858 struct ctf_stream_class
*new_stream_class
= NULL
;
860 if (msg_it
->cur_stream_class_id
== -1) {
862 * No current stream class ID field, therefore only one
865 if (msg_it
->meta
.tc
->stream_classes
->len
!= 1) {
866 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
867 "Need exactly one stream class since there's "
868 "no stream class ID field: "
869 "msg-it-addr=%p", msg_it
);
870 status
= CTF_MSG_ITER_STATUS_ERROR
;
874 new_stream_class
= msg_it
->meta
.tc
->stream_classes
->pdata
[0];
875 msg_it
->cur_stream_class_id
= new_stream_class
->id
;
878 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
879 msg_it
->meta
.tc
, msg_it
->cur_stream_class_id
);
880 if (!new_stream_class
) {
881 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
882 "No stream class with ID of stream class ID to use in trace class: "
883 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
884 "trace-class-addr=%p",
885 msg_it
, msg_it
->cur_stream_class_id
, msg_it
->meta
.tc
);
886 status
= CTF_MSG_ITER_STATUS_ERROR
;
890 if (msg_it
->meta
.sc
) {
891 if (new_stream_class
!= msg_it
->meta
.sc
) {
892 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
893 "Two packets refer to two different stream classes within the same packet sequence: "
894 "msg-it-addr=%p, prev-stream-class-addr=%p, "
895 "prev-stream-class-id=%" PRId64
", "
896 "next-stream-class-addr=%p, "
897 "next-stream-class-id=%" PRId64
", "
899 msg_it
, msg_it
->meta
.sc
,
902 new_stream_class
->id
,
904 status
= CTF_MSG_ITER_STATUS_ERROR
;
908 msg_it
->meta
.sc
= new_stream_class
;
911 BT_COMP_LOGD("Set current stream class: "
912 "msg-it-addr=%p, stream-class-addr=%p, "
913 "stream-class-id=%" PRId64
,
914 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
921 enum ctf_msg_iter_status
set_current_stream(struct ctf_msg_iter
*msg_it
)
923 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
924 bt_self_component
*self_comp
= msg_it
->self_comp
;
925 bt_stream
*stream
= NULL
;
927 BT_COMP_LOGD("Calling user function (get stream): msg-it-addr=%p, "
928 "stream-class-addr=%p, stream-class-id=%" PRId64
,
929 msg_it
, msg_it
->meta
.sc
,
930 msg_it
->meta
.sc
->id
);
931 stream
= msg_it
->medium
.medops
.borrow_stream(
932 msg_it
->meta
.sc
->ir_sc
, msg_it
->cur_data_stream_id
,
933 msg_it
->medium
.data
);
934 bt_stream_get_ref(stream
);
935 BT_COMP_LOGD("User function returned: stream-addr=%p", stream
);
937 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
938 "User function failed to return a stream object for the given stream class.");
939 status
= CTF_MSG_ITER_STATUS_ERROR
;
943 if (msg_it
->stream
&& stream
!= msg_it
->stream
) {
944 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
945 "User function returned a different stream than the previous one for the same sequence of packets.");
946 status
= CTF_MSG_ITER_STATUS_ERROR
;
950 BT_STREAM_MOVE_REF(msg_it
->stream
, stream
);
953 bt_stream_put_ref(stream
);
958 enum ctf_msg_iter_status
set_current_packet(struct ctf_msg_iter
*msg_it
)
960 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
961 bt_self_component
*self_comp
= msg_it
->self_comp
;
962 bt_packet
*packet
= NULL
;
964 BT_COMP_LOGD("Creating packet from stream: "
965 "msg-it-addr=%p, stream-addr=%p, "
966 "stream-class-addr=%p, "
967 "stream-class-id=%" PRId64
,
968 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
,
969 msg_it
->meta
.sc
->id
);
972 BT_ASSERT(msg_it
->stream
);
973 packet
= bt_packet_create(msg_it
->stream
);
975 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
976 "Cannot create packet from stream: "
977 "msg-it-addr=%p, stream-addr=%p, "
978 "stream-class-addr=%p, "
979 "stream-class-id=%" PRId64
,
980 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
,
981 msg_it
->meta
.sc
->id
);
988 BT_PACKET_PUT_REF_AND_RESET(packet
);
989 status
= CTF_MSG_ITER_STATUS_ERROR
;
992 BT_PACKET_MOVE_REF(msg_it
->packet
, packet
);
997 enum ctf_msg_iter_status
after_packet_header_state(
998 struct ctf_msg_iter
*msg_it
)
1000 enum ctf_msg_iter_status status
;
1002 status
= set_current_stream_class(msg_it
);
1003 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1007 msg_it
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
1014 enum ctf_msg_iter_status
read_packet_context_begin_state(
1015 struct ctf_msg_iter
*msg_it
)
1017 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1018 bt_self_component
*self_comp
= msg_it
->self_comp
;
1019 struct ctf_field_class
*packet_context_fc
;
1021 BT_ASSERT(msg_it
->meta
.sc
);
1022 packet_context_fc
= msg_it
->meta
.sc
->packet_context_fc
;
1023 if (!packet_context_fc
) {
1024 BT_COMP_LOGD("No packet packet context field class in stream class: continuing: "
1025 "msg-it-addr=%p, stream-class-addr=%p, "
1026 "stream-class-id=%" PRId64
,
1027 msg_it
, msg_it
->meta
.sc
,
1028 msg_it
->meta
.sc
->id
);
1029 msg_it
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
1033 BT_ASSERT(!msg_it
->packet_context_field
);
1035 if (packet_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1037 * Create free packet context field from stream class.
1038 * This field is going to be moved to the packet once we
1039 * create it. We cannot create the packet now because a
1040 * packet is created from a stream, and this API must be
1041 * able to return the packet context properties without
1043 * (ctf_msg_iter_get_packet_properties()).
1045 msg_it
->packet_context_field
=
1046 bt_packet_context_field_create(
1047 msg_it
->meta
.sc
->ir_sc
);
1048 if (!msg_it
->packet_context_field
) {
1049 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1050 "Cannot create packet context field wrapper from stream class.");
1051 status
= CTF_MSG_ITER_STATUS_ERROR
;
1055 msg_it
->dscopes
.stream_packet_context
=
1056 bt_packet_context_field_borrow_field(
1057 msg_it
->packet_context_field
);
1058 BT_ASSERT(msg_it
->dscopes
.stream_packet_context
);
1061 BT_COMP_LOGD("Decoding packet context field: "
1062 "msg-it-addr=%p, stream-class-addr=%p, "
1063 "stream-class-id=%" PRId64
", fc-addr=%p",
1064 msg_it
, msg_it
->meta
.sc
,
1065 msg_it
->meta
.sc
->id
, packet_context_fc
);
1066 status
= read_dscope_begin_state(msg_it
, packet_context_fc
,
1067 STATE_AFTER_STREAM_PACKET_CONTEXT
,
1068 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
1069 msg_it
->dscopes
.stream_packet_context
);
1071 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1072 "Cannot decode packet context field: "
1073 "msg-it-addr=%p, stream-class-addr=%p, "
1074 "stream-class-id=%" PRId64
", fc-addr=%p",
1075 msg_it
, msg_it
->meta
.sc
,
1076 msg_it
->meta
.sc
->id
,
1085 enum ctf_msg_iter_status
read_packet_context_continue_state(
1086 struct ctf_msg_iter
*msg_it
)
1088 return read_dscope_continue_state(msg_it
,
1089 STATE_AFTER_STREAM_PACKET_CONTEXT
);
1093 enum ctf_msg_iter_status
set_current_packet_content_sizes(
1094 struct ctf_msg_iter
*msg_it
)
1096 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1097 bt_self_component
*self_comp
= msg_it
->self_comp
;
1099 if (msg_it
->cur_exp_packet_total_size
== -1) {
1100 if (msg_it
->cur_exp_packet_content_size
!= -1) {
1101 msg_it
->cur_exp_packet_total_size
=
1102 msg_it
->cur_exp_packet_content_size
;
1105 if (msg_it
->cur_exp_packet_content_size
== -1) {
1106 msg_it
->cur_exp_packet_content_size
=
1107 msg_it
->cur_exp_packet_total_size
;
1111 BT_ASSERT((msg_it
->cur_exp_packet_total_size
>= 0 &&
1112 msg_it
->cur_exp_packet_content_size
>= 0) ||
1113 (msg_it
->cur_exp_packet_total_size
< 0 &&
1114 msg_it
->cur_exp_packet_content_size
< 0));
1116 if (msg_it
->cur_exp_packet_content_size
>
1117 msg_it
->cur_exp_packet_total_size
) {
1118 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1119 "Invalid packet or content size: "
1120 "content size is greater than packet size: "
1121 "msg-it-addr=%p, packet-context-field-addr=%p, "
1122 "packet-size=%" PRId64
", content-size=%" PRId64
,
1123 msg_it
, msg_it
->dscopes
.stream_packet_context
,
1124 msg_it
->cur_exp_packet_total_size
,
1125 msg_it
->cur_exp_packet_content_size
);
1126 status
= CTF_MSG_ITER_STATUS_ERROR
;
1130 BT_COMP_LOGD("Set current packet and content sizes: "
1131 "msg-it-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1132 msg_it
, msg_it
->cur_exp_packet_total_size
,
1133 msg_it
->cur_exp_packet_content_size
);
1140 enum ctf_msg_iter_status
after_packet_context_state(struct ctf_msg_iter
*msg_it
)
1142 enum ctf_msg_iter_status status
;
1144 status
= set_current_packet_content_sizes(msg_it
);
1145 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1149 if (msg_it
->stream
) {
1151 * Stream exists, which means we already emitted at
1152 * least one packet beginning message, so the initial
1153 * stream beginning message was also emitted.
1155 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1157 msg_it
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1165 enum ctf_msg_iter_status
read_event_header_begin_state(struct ctf_msg_iter
*msg_it
)
1167 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1168 bt_self_component
*self_comp
= msg_it
->self_comp
;
1169 struct ctf_field_class
*event_header_fc
= NULL
;
1171 /* Reset the position of the last event header */
1172 msg_it
->buf
.last_eh_at
= msg_it
->buf
.at
;
1173 msg_it
->cur_event_class_id
= -1;
1175 /* Check if we have some content left */
1176 if (msg_it
->cur_exp_packet_content_size
>= 0) {
1177 if (G_UNLIKELY(packet_at(msg_it
) ==
1178 msg_it
->cur_exp_packet_content_size
)) {
1179 /* No more events! */
1180 BT_COMP_LOGD("Reached end of packet: msg-it-addr=%p, "
1181 "cur=%zu", msg_it
, packet_at(msg_it
));
1182 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1184 } else if (G_UNLIKELY(packet_at(msg_it
) >
1185 msg_it
->cur_exp_packet_content_size
)) {
1186 /* That's not supposed to happen */
1187 BT_COMP_LOGD("Before decoding event header field: cursor is passed the packet's content: "
1188 "msg-it-addr=%p, content-size=%" PRId64
", "
1190 msg_it
->cur_exp_packet_content_size
,
1192 status
= CTF_MSG_ITER_STATUS_ERROR
;
1197 * "Infinite" content: we're done when the medium has
1198 * nothing else for us.
1200 status
= buf_ensure_available_bits(msg_it
);
1202 case CTF_MSG_ITER_STATUS_OK
:
1204 case CTF_MSG_ITER_STATUS_EOF
:
1205 status
= CTF_MSG_ITER_STATUS_OK
;
1206 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1213 release_event_dscopes(msg_it
);
1214 BT_ASSERT(msg_it
->meta
.sc
);
1215 event_header_fc
= msg_it
->meta
.sc
->event_header_fc
;
1216 if (!event_header_fc
) {
1217 msg_it
->state
= STATE_AFTER_EVENT_HEADER
;
1221 BT_COMP_LOGD("Decoding event header field: "
1222 "msg-it-addr=%p, stream-class-addr=%p, "
1223 "stream-class-id=%" PRId64
", "
1225 msg_it
, msg_it
->meta
.sc
,
1226 msg_it
->meta
.sc
->id
,
1228 status
= read_dscope_begin_state(msg_it
, event_header_fc
,
1229 STATE_AFTER_EVENT_HEADER
,
1230 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1232 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1233 "Cannot decode event header field: "
1234 "msg-it-addr=%p, stream-class-addr=%p, "
1235 "stream-class-id=%" PRId64
", fc-addr=%p",
1236 msg_it
, msg_it
->meta
.sc
,
1237 msg_it
->meta
.sc
->id
,
1246 enum ctf_msg_iter_status
read_event_header_continue_state(
1247 struct ctf_msg_iter
*msg_it
)
1249 return read_dscope_continue_state(msg_it
,
1250 STATE_AFTER_EVENT_HEADER
);
1254 enum ctf_msg_iter_status
set_current_event_class(struct ctf_msg_iter
*msg_it
)
1256 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1257 bt_self_component
*self_comp
= msg_it
->self_comp
;
1259 struct ctf_event_class
*new_event_class
= NULL
;
1261 if (msg_it
->cur_event_class_id
== -1) {
1263 * No current event class ID field, therefore only one
1266 if (msg_it
->meta
.sc
->event_classes
->len
!= 1) {
1267 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1268 "Need exactly one event class since there's no event class ID field: "
1269 "msg-it-addr=%p", msg_it
);
1270 status
= CTF_MSG_ITER_STATUS_ERROR
;
1274 new_event_class
= msg_it
->meta
.sc
->event_classes
->pdata
[0];
1275 msg_it
->cur_event_class_id
= new_event_class
->id
;
1278 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1279 msg_it
->meta
.sc
, msg_it
->cur_event_class_id
);
1280 if (!new_event_class
) {
1281 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1282 "No event class with ID of event class ID to use in stream class: "
1283 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
1284 "event-class-id=%" PRIu64
", "
1285 "trace-class-addr=%p",
1286 msg_it
, msg_it
->meta
.sc
->id
, msg_it
->cur_event_class_id
,
1288 status
= CTF_MSG_ITER_STATUS_ERROR
;
1292 msg_it
->meta
.ec
= new_event_class
;
1293 BT_COMP_LOGD("Set current event class: "
1294 "msg-it-addr=%p, event-class-addr=%p, "
1295 "event-class-id=%" PRId64
", "
1296 "event-class-name=\"%s\"",
1297 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->id
,
1298 msg_it
->meta
.ec
->name
->str
);
1305 enum ctf_msg_iter_status
set_current_event_message(
1306 struct ctf_msg_iter
*msg_it
)
1308 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1309 bt_self_component
*self_comp
= msg_it
->self_comp
;
1310 bt_message
*msg
= NULL
;
1312 BT_ASSERT_DBG(msg_it
->meta
.ec
);
1313 BT_ASSERT_DBG(msg_it
->packet
);
1314 BT_COMP_LOGD("Creating event message from event class and packet: "
1315 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1316 msg_it
, msg_it
->meta
.ec
,
1317 msg_it
->meta
.ec
->name
->str
,
1319 BT_ASSERT_DBG(msg_it
->self_msg_iter
);
1320 BT_ASSERT_DBG(msg_it
->meta
.sc
);
1322 if (bt_stream_class_borrow_default_clock_class(msg_it
->meta
.sc
->ir_sc
)) {
1323 msg
= bt_message_event_create_with_packet_and_default_clock_snapshot(
1324 msg_it
->self_msg_iter
, msg_it
->meta
.ec
->ir_ec
,
1325 msg_it
->packet
, msg_it
->default_clock_snapshot
);
1327 msg
= bt_message_event_create_with_packet(msg_it
->self_msg_iter
,
1328 msg_it
->meta
.ec
->ir_ec
, msg_it
->packet
);
1332 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1333 "Cannot create event message: "
1334 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1336 msg_it
, msg_it
->meta
.ec
,
1337 msg_it
->meta
.ec
->name
->str
,
1345 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1346 status
= CTF_MSG_ITER_STATUS_ERROR
;
1349 BT_MESSAGE_MOVE_REF(msg_it
->event_msg
, msg
);
1354 enum ctf_msg_iter_status
after_event_header_state(
1355 struct ctf_msg_iter
*msg_it
)
1357 enum ctf_msg_iter_status status
;
1359 status
= set_current_event_class(msg_it
);
1360 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1364 if (G_UNLIKELY(msg_it
->dry_run
)) {
1368 status
= set_current_event_message(msg_it
);
1369 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1373 msg_it
->event
= bt_message_event_borrow_event(
1375 BT_ASSERT_DBG(msg_it
->event
);
1378 msg_it
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1385 enum ctf_msg_iter_status
read_event_common_context_begin_state(
1386 struct ctf_msg_iter
*msg_it
)
1388 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1389 bt_self_component
*self_comp
= msg_it
->self_comp
;
1390 struct ctf_field_class
*event_common_context_fc
;
1392 event_common_context_fc
= msg_it
->meta
.sc
->event_common_context_fc
;
1393 if (!event_common_context_fc
) {
1394 msg_it
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1398 if (event_common_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1399 BT_ASSERT_DBG(!msg_it
->dscopes
.event_common_context
);
1400 msg_it
->dscopes
.event_common_context
=
1401 bt_event_borrow_common_context_field(
1403 BT_ASSERT_DBG(msg_it
->dscopes
.event_common_context
);
1406 BT_COMP_LOGT("Decoding event common context field: "
1407 "msg-it-addr=%p, stream-class-addr=%p, "
1408 "stream-class-id=%" PRId64
", "
1410 msg_it
, msg_it
->meta
.sc
,
1411 msg_it
->meta
.sc
->id
,
1412 event_common_context_fc
);
1413 status
= read_dscope_begin_state(msg_it
, event_common_context_fc
,
1414 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1415 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1416 msg_it
->dscopes
.event_common_context
);
1418 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1419 "Cannot decode event common context field: "
1420 "msg-it-addr=%p, stream-class-addr=%p, "
1421 "stream-class-id=%" PRId64
", fc-addr=%p",
1422 msg_it
, msg_it
->meta
.sc
,
1423 msg_it
->meta
.sc
->id
,
1424 event_common_context_fc
);
1432 enum ctf_msg_iter_status
read_event_common_context_continue_state(
1433 struct ctf_msg_iter
*msg_it
)
1435 return read_dscope_continue_state(msg_it
,
1436 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1440 enum ctf_msg_iter_status
read_event_spec_context_begin_state(
1441 struct ctf_msg_iter
*msg_it
)
1443 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1444 bt_self_component
*self_comp
= msg_it
->self_comp
;
1445 struct ctf_field_class
*event_spec_context_fc
;
1447 event_spec_context_fc
= msg_it
->meta
.ec
->spec_context_fc
;
1448 if (!event_spec_context_fc
) {
1449 msg_it
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1453 if (event_spec_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1454 BT_ASSERT_DBG(!msg_it
->dscopes
.event_spec_context
);
1455 msg_it
->dscopes
.event_spec_context
=
1456 bt_event_borrow_specific_context_field(
1458 BT_ASSERT_DBG(msg_it
->dscopes
.event_spec_context
);
1461 BT_COMP_LOGT("Decoding event specific context field: "
1462 "msg-it-addr=%p, event-class-addr=%p, "
1463 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1465 msg_it
, msg_it
->meta
.ec
,
1466 msg_it
->meta
.ec
->name
->str
,
1467 msg_it
->meta
.ec
->id
,
1468 event_spec_context_fc
);
1469 status
= read_dscope_begin_state(msg_it
, event_spec_context_fc
,
1470 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1471 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1472 msg_it
->dscopes
.event_spec_context
);
1474 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1475 "Cannot decode event specific context field: "
1476 "msg-it-addr=%p, event-class-addr=%p, "
1477 "event-class-name=\"%s\", "
1478 "event-class-id=%" PRId64
", fc-addr=%p",
1479 msg_it
, msg_it
->meta
.ec
,
1480 msg_it
->meta
.ec
->name
->str
,
1481 msg_it
->meta
.ec
->id
,
1482 event_spec_context_fc
);
1490 enum ctf_msg_iter_status
read_event_spec_context_continue_state(
1491 struct ctf_msg_iter
*msg_it
)
1493 return read_dscope_continue_state(msg_it
,
1494 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1498 enum ctf_msg_iter_status
read_event_payload_begin_state(
1499 struct ctf_msg_iter
*msg_it
)
1501 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1502 bt_self_component
*self_comp
= msg_it
->self_comp
;
1503 struct ctf_field_class
*event_payload_fc
;
1505 event_payload_fc
= msg_it
->meta
.ec
->payload_fc
;
1506 if (!event_payload_fc
) {
1507 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1511 if (event_payload_fc
->in_ir
&& !msg_it
->dry_run
) {
1512 BT_ASSERT_DBG(!msg_it
->dscopes
.event_payload
);
1513 msg_it
->dscopes
.event_payload
=
1514 bt_event_borrow_payload_field(
1516 BT_ASSERT_DBG(msg_it
->dscopes
.event_payload
);
1519 BT_COMP_LOGT("Decoding event payload field: "
1520 "msg-it-addr=%p, event-class-addr=%p, "
1521 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1523 msg_it
, msg_it
->meta
.ec
,
1524 msg_it
->meta
.ec
->name
->str
,
1525 msg_it
->meta
.ec
->id
,
1527 status
= read_dscope_begin_state(msg_it
, event_payload_fc
,
1528 STATE_EMIT_MSG_EVENT
,
1529 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1530 msg_it
->dscopes
.event_payload
);
1532 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1533 "Cannot decode event payload field: "
1534 "msg-it-addr=%p, event-class-addr=%p, "
1535 "event-class-name=\"%s\", "
1536 "event-class-id=%" PRId64
", fc-addr=%p",
1537 msg_it
, msg_it
->meta
.ec
,
1538 msg_it
->meta
.ec
->name
->str
,
1539 msg_it
->meta
.ec
->id
,
1548 enum ctf_msg_iter_status
read_event_payload_continue_state(
1549 struct ctf_msg_iter
*msg_it
)
1551 return read_dscope_continue_state(msg_it
, STATE_EMIT_MSG_EVENT
);
1555 enum ctf_msg_iter_status
skip_packet_padding_state(struct ctf_msg_iter
*msg_it
)
1557 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1558 size_t bits_to_skip
;
1559 const enum state next_state
= STATE_SWITCH_PACKET
;
1561 BT_ASSERT(msg_it
->cur_exp_packet_total_size
> 0);
1562 bits_to_skip
= msg_it
->cur_exp_packet_total_size
- packet_at(msg_it
);
1563 if (bits_to_skip
== 0) {
1564 msg_it
->state
= next_state
;
1567 size_t bits_to_consume
;
1569 BT_COMP_LOGD("Trying to skip %zu bits of padding: msg-it-addr=%p, size=%zu",
1570 bits_to_skip
, msg_it
, bits_to_skip
);
1571 status
= buf_ensure_available_bits(msg_it
);
1572 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1576 bits_to_consume
= MIN(buf_available_bits(msg_it
), bits_to_skip
);
1577 BT_COMP_LOGD("Skipping %zu bits of padding: msg-it-addr=%p, size=%zu",
1578 bits_to_consume
, msg_it
, bits_to_consume
);
1579 buf_consume_bits(msg_it
, bits_to_consume
);
1580 bits_to_skip
= msg_it
->cur_exp_packet_total_size
-
1582 if (bits_to_skip
== 0) {
1583 msg_it
->state
= next_state
;
1593 enum ctf_msg_iter_status
check_emit_msg_discarded_events(
1594 struct ctf_msg_iter
*msg_it
)
1596 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1598 if (!msg_it
->meta
.sc
->has_discarded_events
) {
1599 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1603 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1604 if (msg_it
->snapshots
.discarded_events
== 0 ||
1605 msg_it
->snapshots
.discarded_events
== UINT64_C(-1)) {
1607 * Stream's first packet with no discarded
1608 * events or no information about discarded
1609 * events: do not emit.
1611 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1615 * If the previous packet has a value for this counter,
1616 * then this counter is defined for the whole stream.
1618 BT_ASSERT(msg_it
->snapshots
.discarded_events
!= UINT64_C(-1));
1620 if (msg_it
->snapshots
.discarded_events
-
1621 msg_it
->prev_packet_snapshots
.discarded_events
== 0) {
1623 * No discarded events since previous packet: do
1626 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1631 return CTF_MSG_ITER_STATUS_OK
;
1635 enum ctf_msg_iter_status
check_emit_msg_discarded_packets(
1636 struct ctf_msg_iter
*msg_it
)
1638 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1640 if (!msg_it
->meta
.sc
->has_discarded_packets
) {
1641 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1645 if (msg_it
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1647 * Stream's first packet or no information about
1648 * discarded packets: do not emit. In other words, if
1649 * this is the first packet and its sequence number is
1650 * not 0, do not consider that packets were previously
1651 * lost: we might be reading a partial stream (LTTng
1652 * snapshot for example).
1654 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1657 * If the previous packet has a value for this counter,
1658 * then this counter is defined for the whole stream.
1660 BT_ASSERT(msg_it
->snapshots
.packets
!= UINT64_C(-1));
1662 if (msg_it
->snapshots
.packets
-
1663 msg_it
->prev_packet_snapshots
.packets
<= 1) {
1665 * No discarded packets since previous packet:
1668 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1673 return CTF_MSG_ITER_STATUS_OK
;
1677 enum ctf_msg_iter_status
handle_state(struct ctf_msg_iter
*msg_it
)
1679 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1680 const enum state state
= msg_it
->state
;
1682 BT_COMP_LOGT("Handling state: msg-it-addr=%p, state=%s",
1683 msg_it
, state_string(state
));
1685 // TODO: optimalize!
1688 msg_it
->state
= STATE_SWITCH_PACKET
;
1690 case STATE_SWITCH_PACKET
:
1691 status
= switch_packet_state(msg_it
);
1693 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1694 status
= read_packet_header_begin_state(msg_it
);
1696 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1697 status
= read_packet_header_continue_state(msg_it
);
1699 case STATE_AFTER_TRACE_PACKET_HEADER
:
1700 status
= after_packet_header_state(msg_it
);
1702 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1703 status
= read_packet_context_begin_state(msg_it
);
1705 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1706 status
= read_packet_context_continue_state(msg_it
);
1708 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1709 status
= after_packet_context_state(msg_it
);
1711 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1712 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1714 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1715 status
= check_emit_msg_discarded_events(msg_it
);
1717 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1718 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1720 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1721 status
= check_emit_msg_discarded_packets(msg_it
);
1723 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1724 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1726 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1727 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1729 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1730 status
= read_event_header_begin_state(msg_it
);
1732 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1733 status
= read_event_header_continue_state(msg_it
);
1735 case STATE_AFTER_EVENT_HEADER
:
1736 status
= after_event_header_state(msg_it
);
1738 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1739 status
= read_event_common_context_begin_state(msg_it
);
1741 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1742 status
= read_event_common_context_continue_state(msg_it
);
1744 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1745 status
= read_event_spec_context_begin_state(msg_it
);
1747 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1748 status
= read_event_spec_context_continue_state(msg_it
);
1750 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1751 status
= read_event_payload_begin_state(msg_it
);
1753 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1754 status
= read_event_payload_continue_state(msg_it
);
1756 case STATE_EMIT_MSG_EVENT
:
1757 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1759 case STATE_EMIT_QUEUED_MSG_EVENT
:
1760 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1762 case STATE_SKIP_PACKET_PADDING
:
1763 status
= skip_packet_padding_state(msg_it
);
1765 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1766 msg_it
->state
= STATE_SKIP_PACKET_PADDING
;
1768 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1769 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
1771 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
1772 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1774 case STATE_EMIT_MSG_STREAM_END
:
1775 msg_it
->state
= STATE_DONE
;
1780 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1781 "msg-it-addr=%p, state=%d", msg_it
, msg_it
->state
);
1785 BT_COMP_LOGT("Handled state: msg-it-addr=%p, status=%s, "
1786 "prev-state=%s, cur-state=%s",
1787 msg_it
, ctf_msg_iter_status_string(status
),
1788 state_string(state
), state_string(msg_it
->state
));
1793 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter
*msg_it
)
1796 BT_COMP_LOGD("Resetting message iterator: addr=%p", msg_it
);
1797 stack_clear(msg_it
->stack
);
1798 msg_it
->meta
.sc
= NULL
;
1799 msg_it
->meta
.ec
= NULL
;
1800 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
1801 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
1802 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
1803 release_all_dscopes(msg_it
);
1804 msg_it
->cur_dscope_field
= NULL
;
1806 if (msg_it
->packet_context_field
) {
1807 bt_packet_context_field_release(msg_it
->packet_context_field
);
1808 msg_it
->packet_context_field
= NULL
;
1811 msg_it
->buf
.addr
= NULL
;
1814 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
1815 msg_it
->buf
.packet_offset
= 0;
1816 msg_it
->state
= STATE_INIT
;
1817 msg_it
->cur_exp_packet_content_size
= -1;
1818 msg_it
->cur_exp_packet_total_size
= -1;
1819 msg_it
->cur_packet_offset
= -1;
1820 msg_it
->cur_event_class_id
= -1;
1821 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
1822 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
1826 * Resets the internal state of a CTF message iterator.
1829 void ctf_msg_iter_reset(struct ctf_msg_iter
*msg_it
)
1831 ctf_msg_iter_reset_for_next_stream_file(msg_it
);
1832 msg_it
->cur_stream_class_id
= -1;
1833 msg_it
->cur_data_stream_id
= -1;
1834 msg_it
->snapshots
.discarded_events
= UINT64_C(-1);
1835 msg_it
->snapshots
.packets
= UINT64_C(-1);
1836 msg_it
->prev_packet_snapshots
.discarded_events
= UINT64_C(-1);
1837 msg_it
->prev_packet_snapshots
.packets
= UINT64_C(-1);
1838 msg_it
->prev_packet_snapshots
.beginning_clock
= UINT64_C(-1);
1839 msg_it
->prev_packet_snapshots
.end_clock
= UINT64_C(-1);
1843 bt_field
*borrow_next_field(struct ctf_msg_iter
*msg_it
)
1845 bt_field
*next_field
= NULL
;
1846 bt_field
*base_field
;
1847 const bt_field_class
*base_fc
;
1848 bt_field_class_type base_fc_type
;
1851 BT_ASSERT_DBG(!stack_empty(msg_it
->stack
));
1852 index
= stack_top(msg_it
->stack
)->index
;
1853 base_field
= stack_top(msg_it
->stack
)->base
;
1854 BT_ASSERT_DBG(base_field
);
1855 base_fc
= bt_field_borrow_class_const(base_field
);
1856 BT_ASSERT_DBG(base_fc
);
1857 base_fc_type
= bt_field_class_get_type(base_fc
);
1859 if (base_fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
1860 BT_ASSERT_DBG(index
<
1861 bt_field_class_structure_get_member_count(
1862 bt_field_borrow_class_const(
1865 bt_field_structure_borrow_member_field_by_index(
1867 } else if (bt_field_class_type_is(base_fc_type
,
1868 BT_FIELD_CLASS_TYPE_ARRAY
)) {
1869 BT_ASSERT_DBG(index
< bt_field_array_get_length(base_field
));
1870 next_field
= bt_field_array_borrow_element_field_by_index(
1872 } else if (bt_field_class_type_is(base_fc_type
,
1873 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1874 BT_ASSERT_DBG(index
== 0);
1875 next_field
= bt_field_variant_borrow_selected_option_field(
1881 BT_ASSERT_DBG(next_field
);
1886 void update_default_clock(struct ctf_msg_iter
*msg_it
, uint64_t new_val
,
1887 uint64_t new_val_size
)
1889 uint64_t new_val_mask
;
1890 uint64_t cur_value_masked
;
1892 BT_ASSERT_DBG(new_val_size
> 0);
1895 * Special case for a 64-bit new value, which is the limit
1896 * of a clock value as of this version: overwrite the
1897 * current value directly.
1899 if (new_val_size
== 64) {
1900 msg_it
->default_clock_snapshot
= new_val
;
1904 new_val_mask
= (1ULL << new_val_size
) - 1;
1905 cur_value_masked
= msg_it
->default_clock_snapshot
& new_val_mask
;
1907 if (new_val
< cur_value_masked
) {
1909 * It looks like a wrap happened on the number of bits
1910 * of the requested new value. Assume that the clock
1911 * value wrapped only one time.
1913 msg_it
->default_clock_snapshot
+= new_val_mask
+ 1;
1916 /* Clear the low bits of the current clock value. */
1917 msg_it
->default_clock_snapshot
&= ~new_val_mask
;
1919 /* Set the low bits of the current clock value. */
1920 msg_it
->default_clock_snapshot
|= new_val
;
1923 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1924 "value=%" PRIu64
, msg_it
->default_clock_snapshot
);
1928 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1929 struct ctf_field_class
*fc
, void *data
)
1931 struct ctf_msg_iter
*msg_it
= data
;
1932 bt_self_component
*self_comp
= msg_it
->self_comp
;
1933 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1935 bt_field
*field
= NULL
;
1936 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1938 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1939 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1940 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1941 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1943 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1944 goto update_def_clock
;
1947 switch (int_fc
->meaning
) {
1948 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1949 msg_it
->cur_event_class_id
= value
;
1951 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1952 msg_it
->cur_data_stream_id
= value
;
1954 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1955 msg_it
->snapshots
.beginning_clock
= value
;
1957 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1958 msg_it
->snapshots
.end_clock
= value
;
1960 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1961 msg_it
->cur_stream_class_id
= value
;
1963 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1964 if (value
!= 0xc1fc1fc1) {
1965 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1966 "Invalid CTF magic number: msg-it-addr=%p, "
1967 "magic=%" PRIx64
, msg_it
, value
);
1968 status
= BT_BFCR_STATUS_ERROR
;
1973 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1974 msg_it
->snapshots
.packets
= value
;
1976 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1977 msg_it
->snapshots
.discarded_events
= value
;
1979 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1980 msg_it
->cur_exp_packet_total_size
= value
;
1982 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1983 msg_it
->cur_exp_packet_content_size
= value
;
1990 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
1991 update_default_clock(msg_it
, value
, int_fc
->base
.size
);
1994 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1995 g_array_index(msg_it
->stored_values
, uint64_t,
1996 (uint64_t) int_fc
->storing_index
) = value
;
1999 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2003 field
= borrow_next_field(msg_it
);
2004 BT_ASSERT_DBG(field
);
2005 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2006 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
2007 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
));
2008 bt_field_integer_unsigned_set_value(field
, value
);
2009 stack_top(msg_it
->stack
)->index
++;
2016 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
2017 struct ctf_field_class
*fc
, void *data
)
2020 struct ctf_msg_iter
*msg_it
= data
;
2021 bt_self_component
*self_comp
= msg_it
->self_comp
;
2022 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2023 bt_field
*string_field
= NULL
;
2024 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2025 char str
[2] = {'\0', '\0'};
2027 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
2028 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2029 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
2030 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2031 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2032 BT_ASSERT_DBG(!int_fc
->mapped_clock_class
);
2033 BT_ASSERT_DBG(int_fc
->storing_index
< 0);
2035 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2039 if (msg_it
->done_filling_string
) {
2044 msg_it
->done_filling_string
= true;
2048 string_field
= stack_top(msg_it
->stack
)->base
;
2049 BT_ASSERT_DBG(bt_field_get_class_type(string_field
) ==
2050 BT_FIELD_CLASS_TYPE_STRING
);
2052 /* Append character */
2053 str
[0] = (char) value
;
2054 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
2056 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2057 "Cannot append character to string field's value: "
2058 "msg-it-addr=%p, field-addr=%p, ret=%d",
2059 msg_it
, string_field
, ret
);
2060 status
= BT_BFCR_STATUS_ERROR
;
2069 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
2070 struct ctf_field_class
*fc
, void *data
)
2072 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2073 bt_field
*field
= NULL
;
2074 struct ctf_msg_iter
*msg_it
= data
;
2075 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2077 BT_COMP_LOGT("Signed integer function called from BFCR: "
2078 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2079 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
2080 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2081 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2083 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
2084 g_array_index(msg_it
->stored_values
, uint64_t,
2085 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
2088 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2092 field
= borrow_next_field(msg_it
);
2093 BT_ASSERT_DBG(field
);
2094 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2095 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
2096 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
));
2097 bt_field_integer_signed_set_value(field
, value
);
2098 stack_top(msg_it
->stack
)->index
++;
2105 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
2106 struct ctf_field_class
*fc
, void *data
)
2108 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2109 bt_field
*field
= NULL
;
2110 struct ctf_msg_iter
*msg_it
= data
;
2111 bt_field_class_type type
;
2113 BT_COMP_LOGT("Floating point number function called from BFCR: "
2114 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2115 "fc-type=%d, fc-in-ir=%d, value=%f",
2116 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2118 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2122 field
= borrow_next_field(msg_it
);
2123 type
= bt_field_get_class_type(field
);
2124 BT_ASSERT_DBG(field
);
2125 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2126 BT_ASSERT_DBG(bt_field_class_type_is(type
, BT_FIELD_CLASS_TYPE_REAL
));
2128 if (type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
2129 bt_field_real_single_precision_set_value(field
, (float) value
);
2131 bt_field_real_double_precision_set_value(field
, value
);
2133 stack_top(msg_it
->stack
)->index
++;
2140 enum bt_bfcr_status
bfcr_string_begin_cb(
2141 struct ctf_field_class
*fc
, void *data
)
2143 bt_field
*field
= NULL
;
2144 struct ctf_msg_iter
*msg_it
= data
;
2146 BT_COMP_LOGT("String (beginning) 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 field
= borrow_next_field(msg_it
);
2156 BT_ASSERT_DBG(field
);
2157 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2158 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2159 BT_FIELD_CLASS_TYPE_STRING
);
2160 bt_field_string_clear(field
);
2163 * Push on stack. Not a compound class per se, but we know that
2164 * only bfcr_string_cb() may be called between this call and a
2165 * subsequent call to bfcr_string_end_cb().
2167 stack_push(msg_it
->stack
, field
);
2170 return BT_BFCR_STATUS_OK
;
2174 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2175 size_t len
, struct ctf_field_class
*fc
, void *data
)
2177 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2178 bt_field
*field
= NULL
;
2179 struct ctf_msg_iter
*msg_it
= data
;
2180 bt_self_component
*self_comp
= msg_it
->self_comp
;
2183 BT_COMP_LOGT("String (substring) function called from BFCR: "
2184 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2185 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2186 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2189 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2193 field
= stack_top(msg_it
->stack
)->base
;
2194 BT_ASSERT_DBG(field
);
2196 /* Append current substring */
2197 ret
= bt_field_string_append_with_length(field
, value
, len
);
2199 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2200 "Cannot append substring to string field's value: "
2201 "msg-it-addr=%p, field-addr=%p, string-length=%zu, "
2202 "ret=%d", msg_it
, field
, len
, ret
);
2203 status
= BT_BFCR_STATUS_ERROR
;
2212 enum bt_bfcr_status
bfcr_string_end_cb(
2213 struct ctf_field_class
*fc
, void *data
)
2215 struct ctf_msg_iter
*msg_it
= data
;
2217 BT_COMP_LOGT("String (end) function called from BFCR: "
2218 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2219 "fc-type=%d, fc-in-ir=%d",
2220 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2222 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2226 /* Pop string field */
2227 stack_pop(msg_it
->stack
);
2229 /* Go to next field */
2230 stack_top(msg_it
->stack
)->index
++;
2233 return BT_BFCR_STATUS_OK
;
2237 enum bt_bfcr_status
bfcr_compound_begin_cb(
2238 struct ctf_field_class
*fc
, void *data
)
2240 struct ctf_msg_iter
*msg_it
= data
;
2243 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2244 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2245 "fc-type=%d, fc-in-ir=%d",
2246 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2248 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2253 if (stack_empty(msg_it
->stack
)) {
2254 /* Root: already set by read_dscope_begin_state() */
2255 field
= msg_it
->cur_dscope_field
;
2257 field
= borrow_next_field(msg_it
);
2258 BT_ASSERT_DBG(field
);
2262 BT_ASSERT_DBG(field
);
2263 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2264 stack_push(msg_it
->stack
, field
);
2267 * Change BFCR "unsigned int" callback if it's a text
2270 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2271 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2272 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2274 if (array_fc
->is_text
) {
2275 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2276 BT_FIELD_CLASS_TYPE_STRING
);
2277 msg_it
->done_filling_string
= false;
2278 bt_field_string_clear(field
);
2279 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
,
2280 bfcr_unsigned_int_char_cb
);
2285 return BT_BFCR_STATUS_OK
;
2289 enum bt_bfcr_status
bfcr_compound_end_cb(
2290 struct ctf_field_class
*fc
, void *data
)
2292 struct ctf_msg_iter
*msg_it
= data
;
2294 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2295 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2296 "fc-type=%d, fc-in-ir=%d",
2297 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2299 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2303 BT_ASSERT_DBG(!stack_empty(msg_it
->stack
));
2304 BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(msg_it
->stack
)->base
) ==
2308 * Reset BFCR "unsigned int" callback if it's a text
2311 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2312 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2313 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2315 if (array_fc
->is_text
) {
2316 BT_ASSERT_DBG(bt_field_get_class_type(
2317 stack_top(msg_it
->stack
)->base
) ==
2318 BT_FIELD_CLASS_TYPE_STRING
);
2319 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
,
2320 bfcr_unsigned_int_cb
);
2325 stack_pop(msg_it
->stack
);
2327 /* If the stack is not empty, increment the base's index */
2328 if (!stack_empty(msg_it
->stack
)) {
2329 stack_top(msg_it
->stack
)->index
++;
2333 return BT_BFCR_STATUS_OK
;
2337 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2339 bt_field
*seq_field
;
2340 struct ctf_msg_iter
*msg_it
= data
;
2341 bt_self_component
*self_comp
= msg_it
->self_comp
;
2342 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2346 length
= (uint64_t) g_array_index(msg_it
->stored_values
, uint64_t,
2347 seq_fc
->stored_length_index
);
2349 if (G_UNLIKELY(msg_it
->dry_run
)){
2353 seq_field
= stack_top(msg_it
->stack
)->base
;
2354 BT_ASSERT_DBG(seq_field
);
2357 * bfcr_get_sequence_length_cb() also gets called back for a
2358 * text sequence, but the destination field is a string field.
2359 * Only set the field's sequence length if the destination field
2360 * is a sequence field.
2362 if (!seq_fc
->base
.is_text
) {
2363 BT_ASSERT_DBG(bt_field_class_type_is(
2364 bt_field_get_class_type(seq_field
),
2365 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
));
2366 ret
= bt_field_array_dynamic_set_length(seq_field
,
2369 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2370 "Cannot set dynamic array field's length field: "
2371 "msg-it-addr=%p, field-addr=%p, "
2372 "length=%" PRIu64
, msg_it
, seq_field
, length
);
2382 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2383 struct ctf_field_class
*fc
, void *data
)
2387 int64_t option_index
= -1;
2388 struct ctf_msg_iter
*msg_it
= data
;
2389 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2390 struct ctf_named_field_class
*selected_option
= NULL
;
2391 bt_self_component
*self_comp
= msg_it
->self_comp
;
2392 struct ctf_field_class
*ret_fc
= NULL
;
2398 /* Get variant's tag */
2399 tag
.u
= g_array_index(msg_it
->stored_values
, uint64_t,
2400 var_fc
->stored_tag_index
);
2403 * Check each range to find the selected option's index.
2405 if (var_fc
->tag_fc
->base
.is_signed
) {
2406 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2407 struct ctf_field_class_variant_range
*range
=
2408 ctf_field_class_variant_borrow_range_by_index(
2411 if (tag
.i
>= range
->range
.lower
.i
&&
2412 tag
.i
<= range
->range
.upper
.i
) {
2413 option_index
= (int64_t) range
->option_index
;
2418 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2419 struct ctf_field_class_variant_range
*range
=
2420 ctf_field_class_variant_borrow_range_by_index(
2423 if (tag
.u
>= range
->range
.lower
.u
&&
2424 tag
.u
<= range
->range
.upper
.u
) {
2425 option_index
= (int64_t) range
->option_index
;
2431 if (option_index
< 0) {
2432 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2433 "Cannot find variant field class's option: "
2434 "msg-it-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2435 "i-tag=%" PRId64
, msg_it
, var_fc
, tag
.u
, tag
.i
);
2440 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2441 var_fc
, (uint64_t) option_index
);
2443 if (selected_option
->fc
->in_ir
&& !msg_it
->dry_run
) {
2444 bt_field
*var_field
= stack_top(msg_it
->stack
)->base
;
2446 ret
= bt_field_variant_select_option_field_by_index(
2447 var_field
, option_index
);
2449 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2450 "Cannot select variant field's option field: "
2451 "msg-it-addr=%p, var-field-addr=%p, "
2452 "opt-index=%" PRId64
, msg_it
, var_field
,
2459 ret_fc
= selected_option
->fc
;
2466 bt_message
*create_msg_stream_beginning(struct ctf_msg_iter
*msg_it
)
2468 bt_self_component
*self_comp
= msg_it
->self_comp
;
2471 BT_ASSERT(msg_it
->stream
);
2472 BT_ASSERT(msg_it
->self_msg_iter
);
2473 msg
= bt_message_stream_beginning_create(msg_it
->self_msg_iter
,
2476 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2477 "Cannot create stream beginning message: "
2478 "msg-it-addr=%p, stream-addr=%p",
2479 msg_it
, msg_it
->stream
);
2486 bt_message
*create_msg_stream_end(struct ctf_msg_iter
*msg_it
)
2488 bt_self_component
*self_comp
= msg_it
->self_comp
;
2491 if (!msg_it
->stream
) {
2492 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2493 "Cannot create stream end message because stream is NULL: "
2494 "msg-it-addr=%p", msg_it
);
2499 BT_ASSERT(msg_it
->self_msg_iter
);
2500 msg
= bt_message_stream_end_create(msg_it
->self_msg_iter
,
2503 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2504 "Cannot create stream end message: "
2505 "msg-it-addr=%p, stream-addr=%p",
2506 msg_it
, msg_it
->stream
);
2514 bt_message
*create_msg_packet_beginning(struct ctf_msg_iter
*msg_it
,
2515 bool use_default_cs
)
2517 bt_self_component
*self_comp
= msg_it
->self_comp
;
2520 const bt_stream_class
*sc
= msg_it
->meta
.sc
->ir_sc
;
2522 BT_ASSERT(msg_it
->packet
);
2525 if (msg_it
->packet_context_field
) {
2526 ret
= bt_packet_move_context_field(
2527 msg_it
->packet
, msg_it
->packet_context_field
);
2533 msg_it
->packet_context_field
= NULL
;
2536 * At this point msg_it->dscopes.stream_packet_context
2537 * has the same value as the packet context field within
2540 BT_ASSERT(bt_packet_borrow_context_field(
2542 msg_it
->dscopes
.stream_packet_context
);
2545 BT_ASSERT(msg_it
->self_msg_iter
);
2547 if (msg_it
->meta
.sc
->packets_have_ts_begin
) {
2548 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2549 uint64_t raw_cs_value
;
2552 * Either use the decoded packet `timestamp_begin` field or the
2553 * current stream's default clock_snapshot.
2555 if (use_default_cs
) {
2556 raw_cs_value
= msg_it
->default_clock_snapshot
;
2558 raw_cs_value
= msg_it
->snapshots
.beginning_clock
;
2561 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2562 msg_it
->self_msg_iter
, msg_it
->packet
,
2565 msg
= bt_message_packet_beginning_create(msg_it
->self_msg_iter
,
2570 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2571 "Cannot create packet beginning message: "
2572 "msg-it-addr=%p, packet-addr=%p",
2573 msg_it
, msg_it
->packet
);
2582 bt_message
*emit_delayed_packet_beg_msg(struct ctf_msg_iter
*msg_it
)
2584 bool packet_beg_ts_need_fix_up
;
2586 msg_it
->emit_delayed_packet_beginning_msg
= false;
2589 * Only fix the packet's timestamp_begin if it's larger than the first
2590 * event of the packet. If there was no event in the packet, the
2591 * `default_clock_snapshot` field will be either equal or greater than
2592 * `snapshots.beginning_clock` so there is not fix needed.
2594 packet_beg_ts_need_fix_up
=
2595 msg_it
->default_clock_snapshot
< msg_it
->snapshots
.beginning_clock
;
2597 /* create_msg_packet_beginning() logs errors */
2598 return create_msg_packet_beginning(msg_it
, packet_beg_ts_need_fix_up
);
2603 bt_message
*create_msg_packet_end(struct ctf_msg_iter
*msg_it
)
2606 bool update_default_cs
= true;
2607 bt_self_component
*self_comp
= msg_it
->self_comp
;
2609 if (!msg_it
->packet
) {
2615 * Check if we need to emit the delayed packet
2616 * beginning message instead of the packet end message.
2618 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2619 msg
= emit_delayed_packet_beg_msg(msg_it
);
2620 /* Don't forget to emit the packet end message. */
2621 msg_it
->state
= STATE_EMIT_QUEUED_MSG_PACKET_END
;
2625 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2626 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.lttng_crash
)) {
2628 * Check if the `timestamp_begin` field is non-zero but
2629 * `timestamp_end` is zero. It means the trace is affected by
2630 * the lttng-crash packet `timestamp_end` quirk and must be
2631 * fixed up by omitting to update the default clock snapshot to
2632 * the `timestamp_end` as is typically done.
2634 if (msg_it
->snapshots
.beginning_clock
!= 0 &&
2635 msg_it
->snapshots
.end_clock
== 0) {
2636 update_default_cs
= false;
2641 * Check if may be affected by lttng event-after-packet `timestamp_end`
2644 if (msg_it
->meta
.tc
->quirks
.lttng_event_after_packet
) {
2646 * Check if `timestamp_end` is smaller then the current
2647 * default_clock_snapshot (which is set to the last event
2648 * decoded). It means the trace is affected by the lttng
2649 * `event-after-packet` packet `timestamp_end` quirk and must
2650 * be fixed up by omitting to update the default clock snapshot
2651 * to the `timestamp_end` as is typically done.
2653 if (msg_it
->snapshots
.end_clock
< msg_it
->default_clock_snapshot
) {
2654 update_default_cs
= false;
2658 /* Update default clock from packet's end time. */
2659 if (msg_it
->snapshots
.end_clock
!= UINT64_C(-1) && update_default_cs
) {
2660 msg_it
->default_clock_snapshot
= msg_it
->snapshots
.end_clock
;
2663 BT_ASSERT(msg_it
->self_msg_iter
);
2665 if (msg_it
->meta
.sc
->packets_have_ts_end
) {
2666 BT_ASSERT(msg_it
->snapshots
.end_clock
!= UINT64_C(-1));
2667 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2668 msg_it
->self_msg_iter
, msg_it
->packet
,
2669 msg_it
->default_clock_snapshot
);
2671 msg
= bt_message_packet_end_create(msg_it
->self_msg_iter
,
2676 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2677 "Cannot create packet end message: "
2678 "msg-it-addr=%p, packet-addr=%p",
2679 msg_it
, msg_it
->packet
);
2684 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2691 bt_message
*create_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
2694 bt_self_component
*self_comp
= msg_it
->self_comp
;
2695 uint64_t beginning_raw_value
= UINT64_C(-1);
2696 uint64_t end_raw_value
= UINT64_C(-1);
2698 BT_ASSERT(msg_it
->self_msg_iter
);
2699 BT_ASSERT(msg_it
->stream
);
2700 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_events
);
2702 if (msg_it
->meta
.sc
->discarded_events_have_default_cs
) {
2703 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2705 * We discarded events, but before (and possibly
2706 * including) the current packet: use this packet's time
2707 * range, and do not have a specific count.
2709 beginning_raw_value
= msg_it
->snapshots
.beginning_clock
;
2710 end_raw_value
= msg_it
->snapshots
.end_clock
;
2712 beginning_raw_value
= msg_it
->prev_packet_snapshots
.end_clock
;
2713 end_raw_value
= msg_it
->snapshots
.end_clock
;
2716 BT_ASSERT(beginning_raw_value
!= UINT64_C(-1));
2717 BT_ASSERT(end_raw_value
!= UINT64_C(-1));
2718 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2719 msg_it
->self_msg_iter
, msg_it
->stream
, beginning_raw_value
,
2722 msg
= bt_message_discarded_events_create(msg_it
->self_msg_iter
,
2727 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2728 "Cannot create discarded events message: "
2729 "msg-it-addr=%p, stream-addr=%p",
2730 msg_it
, msg_it
->stream
);
2734 if (msg_it
->prev_packet_snapshots
.discarded_events
!= UINT64_C(-1)) {
2735 bt_message_discarded_events_set_count(msg
,
2736 msg_it
->snapshots
.discarded_events
-
2737 msg_it
->prev_packet_snapshots
.discarded_events
);
2745 bt_message
*create_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
2748 bt_self_component
*self_comp
= msg_it
->self_comp
;
2750 BT_ASSERT(msg_it
->self_msg_iter
);
2751 BT_ASSERT(msg_it
->stream
);
2752 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_packets
);
2753 BT_ASSERT(msg_it
->prev_packet_snapshots
.packets
!=
2756 if (msg_it
->meta
.sc
->discarded_packets_have_default_cs
) {
2757 BT_ASSERT(msg_it
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1));
2758 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2759 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2760 msg_it
->self_msg_iter
, msg_it
->stream
,
2761 msg_it
->prev_packet_snapshots
.end_clock
,
2762 msg_it
->snapshots
.beginning_clock
);
2764 msg
= bt_message_discarded_packets_create(msg_it
->self_msg_iter
,
2769 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2770 "Cannot create discarded packets message: "
2771 "msg-it-addr=%p, stream-addr=%p",
2772 msg_it
, msg_it
->stream
);
2776 bt_message_discarded_packets_set_count(msg
,
2777 msg_it
->snapshots
.packets
-
2778 msg_it
->prev_packet_snapshots
.packets
- 1);
2785 struct ctf_msg_iter
*ctf_msg_iter_create(
2786 struct ctf_trace_class
*tc
,
2787 size_t max_request_sz
,
2788 struct ctf_msg_iter_medium_ops medops
, void *data
,
2789 bt_logging_level log_level
,
2790 bt_self_component
*self_comp
,
2791 bt_self_message_iterator
*self_msg_iter
)
2793 struct ctf_msg_iter
*msg_it
= NULL
;
2794 struct bt_bfcr_cbs cbs
= {
2796 .signed_int
= bfcr_signed_int_cb
,
2797 .unsigned_int
= bfcr_unsigned_int_cb
,
2798 .floating_point
= bfcr_floating_point_cb
,
2799 .string_begin
= bfcr_string_begin_cb
,
2800 .string
= bfcr_string_cb
,
2801 .string_end
= bfcr_string_end_cb
,
2802 .compound_begin
= bfcr_compound_begin_cb
,
2803 .compound_end
= bfcr_compound_end_cb
,
2806 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2807 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2812 BT_ASSERT(medops
.request_bytes
);
2813 BT_ASSERT(medops
.borrow_stream
);
2814 BT_ASSERT(max_request_sz
> 0);
2816 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, log_level
, self_comp
,
2817 "Creating CTF plugin message iterator: "
2818 "trace-addr=%p, max-request-size=%zu, "
2819 "data=%p, log-level=%s", tc
, max_request_sz
, data
,
2820 bt_common_logging_level_string(log_level
));
2821 msg_it
= g_new0(struct ctf_msg_iter
, 1);
2823 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2824 "Failed to allocate one CTF plugin message iterator.");
2827 msg_it
->self_comp
= self_comp
;
2828 msg_it
->self_msg_iter
= self_msg_iter
;
2829 msg_it
->log_level
= log_level
;
2830 msg_it
->meta
.tc
= tc
;
2831 msg_it
->medium
.medops
= medops
;
2832 msg_it
->medium
.max_request_sz
= max_request_sz
;
2833 msg_it
->medium
.data
= data
;
2834 msg_it
->stack
= stack_new(msg_it
);
2835 msg_it
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2836 g_array_set_size(msg_it
->stored_values
, tc
->stored_value_count
);
2838 if (!msg_it
->stack
) {
2839 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2840 "Failed to create field stack.");
2844 msg_it
->bfcr
= bt_bfcr_create(cbs
, msg_it
, log_level
, NULL
);
2845 if (!msg_it
->bfcr
) {
2846 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2847 "Failed to create binary class reader (BFCR).");
2851 ctf_msg_iter_reset(msg_it
);
2852 BT_COMP_LOGD("Created CTF plugin message iterator: "
2853 "trace-addr=%p, max-request-size=%zu, "
2854 "data=%p, msg-it-addr=%p, log-level=%s",
2855 tc
, max_request_sz
, data
, msg_it
,
2856 bt_common_logging_level_string(log_level
));
2857 msg_it
->cur_packet_offset
= 0;
2863 ctf_msg_iter_destroy(msg_it
);
2868 void ctf_msg_iter_destroy(struct ctf_msg_iter
*msg_it
)
2870 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2871 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
2872 release_all_dscopes(msg_it
);
2874 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it
);
2876 if (msg_it
->stack
) {
2877 BT_COMP_LOGD_STR("Destroying field stack.");
2878 stack_destroy(msg_it
->stack
);
2882 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it
->bfcr
);
2883 bt_bfcr_destroy(msg_it
->bfcr
);
2886 if (msg_it
->stored_values
) {
2887 g_array_free(msg_it
->stored_values
, TRUE
);
2893 enum ctf_msg_iter_status
ctf_msg_iter_get_next_message(
2894 struct ctf_msg_iter
*msg_it
,
2895 const bt_message
**message
)
2897 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2898 bt_self_component
*self_comp
= msg_it
->self_comp
;
2900 BT_ASSERT_DBG(msg_it
);
2901 BT_ASSERT_DBG(message
);
2902 msg_it
->set_stream
= true;
2903 BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it
);
2906 status
= handle_state(msg_it
);
2907 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
2908 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2910 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
2911 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2912 "Cannot handle state: msg-it-addr=%p, state=%s",
2913 msg_it
, state_string(msg_it
->state
));
2917 switch (msg_it
->state
) {
2918 case STATE_EMIT_MSG_EVENT
:
2919 BT_ASSERT_DBG(msg_it
->event_msg
);
2922 * Check if we need to emit the delayed packet
2923 * beginning message instead of the event message.
2925 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2926 *message
= emit_delayed_packet_beg_msg(msg_it
);
2928 status
= CTF_MSG_ITER_STATUS_ERROR
;
2932 * Don't forget to emit the event message of
2933 * the event record that was just decoded.
2935 msg_it
->state
= STATE_EMIT_QUEUED_MSG_EVENT
;
2938 *message
= msg_it
->event_msg
;
2939 msg_it
->event_msg
= NULL
;
2942 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2943 /* create_msg_discared_events() logs errors */
2944 *message
= create_msg_discarded_events(msg_it
);
2947 status
= CTF_MSG_ITER_STATUS_ERROR
;
2951 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2952 /* create_msg_discared_packets() logs errors */
2953 *message
= create_msg_discarded_packets(msg_it
);
2956 status
= CTF_MSG_ITER_STATUS_ERROR
;
2960 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2961 status
= set_current_packet(msg_it
);
2962 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
2966 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.barectf_event_before_packet
)) {
2967 msg_it
->emit_delayed_packet_beginning_msg
= true;
2969 * There is no message to return yet as this
2970 * packet beginning message is delayed until we
2971 * decode the first event message of the
2976 /* create_msg_packet_beginning() logs errors */
2977 *message
= create_msg_packet_beginning(msg_it
, false);
2979 status
= CTF_MSG_ITER_STATUS_ERROR
;
2984 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2985 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2986 /* create_msg_packet_end() logs errors */
2987 *message
= create_msg_packet_end(msg_it
);
2990 status
= CTF_MSG_ITER_STATUS_ERROR
;
2994 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2995 BT_ASSERT(!msg_it
->stream
);
2996 status
= set_current_stream(msg_it
);
2997 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3001 /* create_msg_stream_beginning() logs errors */
3002 *message
= create_msg_stream_beginning(msg_it
);
3005 status
= CTF_MSG_ITER_STATUS_ERROR
;
3009 case STATE_EMIT_MSG_STREAM_END
:
3010 /* create_msg_stream_end() logs errors */
3011 *message
= create_msg_stream_end(msg_it
);
3014 status
= CTF_MSG_ITER_STATUS_ERROR
;
3019 status
= CTF_MSG_ITER_STATUS_EOF
;
3022 /* Non-emitting state: continue */
3032 enum ctf_msg_iter_status
decode_until_state( struct ctf_msg_iter
*msg_it
,
3033 enum state target_state_1
, enum state target_state_2
)
3035 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3036 bt_self_component
*self_comp
= msg_it
->self_comp
;
3038 BT_ASSERT_DBG(msg_it
);
3039 msg_it
->set_stream
= false;
3043 * Check if we reached the state at which we want to stop
3046 if (msg_it
->state
== target_state_1
||
3047 msg_it
->state
== target_state_2
) {
3051 status
= handle_state(msg_it
);
3052 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
3053 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
3055 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
3056 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
3057 "Cannot handle state: msg-it-addr=%p, state=%s",
3058 msg_it
, state_string(msg_it
->state
));
3062 switch (msg_it
->state
) {
3064 case STATE_SWITCH_PACKET
:
3065 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
3066 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
3067 case STATE_AFTER_TRACE_PACKET_HEADER
:
3068 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
3069 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
3070 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
3071 case STATE_EMIT_MSG_STREAM_BEGINNING
:
3072 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
3073 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
3074 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
3075 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
3076 case STATE_EMIT_MSG_PACKET_BEGINNING
:
3077 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
3078 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
3079 case STATE_AFTER_EVENT_HEADER
:
3080 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
3081 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
3082 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
3083 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
3084 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
3085 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
3086 case STATE_EMIT_MSG_EVENT
:
3087 case STATE_EMIT_QUEUED_MSG_EVENT
:
3088 case STATE_SKIP_PACKET_PADDING
:
3089 case STATE_EMIT_MSG_PACKET_END_MULTI
:
3090 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
3091 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
3092 case STATE_EMIT_MSG_STREAM_END
:
3097 /* We should never get to the STATE_DONE state. */
3098 BT_COMP_LOGF("Unexpected state: msg-it-addr=%p, state=%s",
3099 msg_it
, state_string(msg_it
->state
));
3109 enum ctf_msg_iter_status
read_packet_header_context_fields(
3110 struct ctf_msg_iter
*msg_it
)
3113 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3115 status
= decode_until_state(msg_it
, STATE_EMIT_MSG_PACKET_BEGINNING
, -1);
3116 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3120 ret
= set_current_packet_content_sizes(msg_it
);
3122 status
= CTF_MSG_ITER_STATUS_ERROR
;
3131 enum ctf_msg_iter_status
ctf_msg_iter_seek(struct ctf_msg_iter
*msg_it
,
3134 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3135 enum ctf_msg_iter_medium_status medium_status
;
3138 BT_ASSERT(offset
>= 0);
3139 BT_ASSERT(msg_it
->medium
.medops
.seek
);
3141 medium_status
= msg_it
->medium
.medops
.seek(offset
, msg_it
->medium
.data
);
3142 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
3143 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
3144 status
= CTF_MSG_ITER_STATUS_EOF
;
3146 status
= CTF_MSG_ITER_STATUS_ERROR
;
3151 ctf_msg_iter_reset(msg_it
);
3152 msg_it
->cur_packet_offset
= offset
;
3159 enum ctf_msg_iter_status
clock_snapshot_at_msg_iter_state(
3160 struct ctf_msg_iter
*msg_it
, enum state target_state_1
,
3161 enum state target_state_2
, uint64_t *clock_snapshot
)
3163 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3165 BT_ASSERT_DBG(msg_it
);
3166 BT_ASSERT_DBG(clock_snapshot
);
3167 status
= decode_until_state(msg_it
, target_state_1
, target_state_2
);
3168 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3172 *clock_snapshot
= msg_it
->default_clock_snapshot
;
3178 enum ctf_msg_iter_status
ctf_msg_iter_curr_packet_first_event_clock_snapshot(
3179 struct ctf_msg_iter
*msg_it
, uint64_t *first_clock_snapshot
)
3181 return clock_snapshot_at_msg_iter_state(msg_it
,
3182 STATE_AFTER_EVENT_HEADER
, -1, first_clock_snapshot
);
3186 enum ctf_msg_iter_status
ctf_msg_iter_curr_packet_last_event_clock_snapshot(
3187 struct ctf_msg_iter
*msg_it
, uint64_t *last_clock_snapshot
)
3189 return clock_snapshot_at_msg_iter_state(msg_it
,
3190 STATE_EMIT_MSG_PACKET_END_SINGLE
,
3191 STATE_EMIT_MSG_PACKET_END_MULTI
, last_clock_snapshot
);
3195 enum ctf_msg_iter_status
ctf_msg_iter_get_packet_properties(
3196 struct ctf_msg_iter
*msg_it
,
3197 struct ctf_msg_iter_packet_properties
*props
)
3199 enum ctf_msg_iter_status status
;
3201 BT_ASSERT_DBG(msg_it
);
3202 BT_ASSERT_DBG(props
);
3203 status
= read_packet_header_context_fields(msg_it
);
3204 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3208 props
->exp_packet_total_size
= msg_it
->cur_exp_packet_total_size
;
3209 props
->exp_packet_content_size
= msg_it
->cur_exp_packet_content_size
;
3210 props
->stream_class_id
= (uint64_t) msg_it
->cur_stream_class_id
;
3211 props
->data_stream_id
= msg_it
->cur_data_stream_id
;
3212 props
->snapshots
.discarded_events
= msg_it
->snapshots
.discarded_events
;
3213 props
->snapshots
.packets
= msg_it
->snapshots
.packets
;
3214 props
->snapshots
.beginning_clock
= msg_it
->snapshots
.beginning_clock
;
3215 props
->snapshots
.end_clock
= msg_it
->snapshots
.end_clock
;
3222 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter
*msg_it
,
3225 msg_it
->dry_run
= val
;