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_CHECK_EMIT_MSG_STREAM_END
,
112 STATE_EMIT_MSG_STREAM_END
,
116 struct end_of_packet_snapshots
{
117 uint64_t discarded_events
;
119 uint64_t beginning_clock
;
123 /* CTF message iterator */
124 struct ctf_msg_iter
{
128 /* Current message iterator to create messages (weak) */
129 bt_self_message_iterator
*self_msg_iter
;
132 * True if library objects are unavailable during the decoding and
133 * should not be created/used.
138 * Current dynamic scope field pointer.
140 * This is set by read_dscope_begin_state() and contains the
141 * value of one of the pointers in `dscopes` below.
143 bt_field
*cur_dscope_field
;
146 * True if we're done filling a string field from a text
147 * array/sequence payload.
149 bool done_filling_string
;
151 /* Trace and classes */
152 /* True to set IR fields */
156 struct ctf_trace_class
*tc
;
157 struct ctf_stream_class
*sc
;
158 struct ctf_event_class
*ec
;
161 /* Current packet (NULL if not created yet) */
164 /* Current stream (NULL if not set yet) */
167 /* Current event (NULL if not created yet) */
170 /* Current event message (NULL if not created yet) */
171 bt_message
*event_msg
;
174 * True if we need to emit a packet beginning message before we emit
175 * the next event message or the packet end message.
177 bool emit_delayed_packet_beginning_msg
;
180 * True if this is the first packet we are reading, and therefore if we
181 * should emit a stream beginning message.
183 bool emit_stream_beginning_message
;
186 * True if we need to emit a stream end message at the end of the
187 * current stream. A live stream may never receive any data and thus
188 * never send a stream beginning message which removes the need to emit
189 * a stream end message.
191 bool emit_stream_end_message
;
193 /* Database of current dynamic scopes */
195 bt_field
*stream_packet_context
;
196 bt_field
*event_common_context
;
197 bt_field
*event_spec_context
;
198 bt_field
*event_payload
;
204 /* Current medium buffer data */
206 /* Last address provided by medium */
209 /* Buffer size provided by medium (bytes) */
212 /* Offset within whole packet of addr (bits) */
213 size_t packet_offset
;
215 /* Current position from addr (bits) */
218 /* Position of the last event header from addr (bits) */
222 /* Binary type reader */
223 struct bt_bfcr
*bfcr
;
225 /* Current medium data */
227 struct ctf_msg_iter_medium_ops medops
;
228 size_t max_request_sz
;
232 /* Current packet size (bits) (-1 if unknown) */
233 int64_t cur_exp_packet_total_size
;
235 /* Current content size (bits) (-1 if unknown) */
236 int64_t cur_exp_packet_content_size
;
238 /* Current stream class ID */
239 int64_t cur_stream_class_id
;
241 /* Current event class ID */
242 int64_t cur_event_class_id
;
244 /* Current data stream ID */
245 int64_t cur_data_stream_id
;
248 * Offset, in the underlying media, of the current packet's
249 * start (-1 if unknown).
251 off_t cur_packet_offset
;
253 /* Default clock's current value */
254 uint64_t default_clock_snapshot
;
256 /* End of current packet snapshots */
257 struct end_of_packet_snapshots snapshots
;
259 /* End of previous packet snapshots */
260 struct end_of_packet_snapshots prev_packet_snapshots
;
262 /* Stored values (for sequence lengths, variant tags) */
263 GArray
*stored_values
;
265 /* Iterator's current log level */
266 bt_logging_level log_level
;
268 /* Iterator's owning self component, or `NULL` if none (query) */
269 bt_self_component
*self_comp
;
273 const char *state_string(enum state state
)
278 case STATE_SWITCH_PACKET
:
279 return "SWITCH_PACKET";
280 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
281 return "DSCOPE_TRACE_PACKET_HEADER_BEGIN";
282 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
283 return "DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
284 case STATE_AFTER_TRACE_PACKET_HEADER
:
285 return "AFTER_TRACE_PACKET_HEADER";
286 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
287 return "DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
288 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
289 return "DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
290 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
291 return "AFTER_STREAM_PACKET_CONTEXT";
292 case STATE_EMIT_MSG_STREAM_BEGINNING
:
293 return "EMIT_MSG_STREAM_BEGINNING";
294 case STATE_EMIT_MSG_PACKET_BEGINNING
:
295 return "EMIT_MSG_PACKET_BEGINNING";
296 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
297 return "EMIT_MSG_DISCARDED_EVENTS";
298 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
299 return "EMIT_MSG_DISCARDED_PACKETS";
300 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
301 return "DSCOPE_EVENT_HEADER_BEGIN";
302 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
303 return "DSCOPE_EVENT_HEADER_CONTINUE";
304 case STATE_AFTER_EVENT_HEADER
:
305 return "AFTER_EVENT_HEADER";
306 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
307 return "DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
308 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
309 return "DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
310 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
311 return "DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
312 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
313 return "DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
314 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
315 return "DSCOPE_EVENT_PAYLOAD_BEGIN";
316 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
317 return "DSCOPE_EVENT_PAYLOAD_CONTINUE";
318 case STATE_EMIT_MSG_EVENT
:
319 return "EMIT_MSG_EVENT";
320 case STATE_EMIT_QUEUED_MSG_EVENT
:
321 return "EMIT_QUEUED_MSG_EVENT";
322 case STATE_SKIP_PACKET_PADDING
:
323 return "SKIP_PACKET_PADDING";
324 case STATE_EMIT_MSG_PACKET_END_MULTI
:
325 return "EMIT_MSG_PACKET_END_MULTI";
326 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
327 return "EMIT_MSG_PACKET_END_SINGLE";
328 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
329 return "EMIT_QUEUED_MSG_PACKET_END";
330 case STATE_CHECK_EMIT_MSG_STREAM_END
:
331 return "CHECK_EMIT_MSG_STREAM_END";
332 case STATE_EMIT_MSG_STREAM_END
:
333 return "EMIT_MSG_STREAM_END";
342 struct stack
*stack_new(struct ctf_msg_iter
*msg_it
)
344 bt_self_component
*self_comp
= msg_it
->self_comp
;
345 struct stack
*stack
= NULL
;
347 stack
= g_new0(struct stack
, 1);
349 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
350 "Failed to allocate one stack.");
354 stack
->msg_it
= msg_it
;
355 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
356 if (!stack
->entries
) {
357 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
358 "Failed to allocate a GArray.");
362 BT_COMP_LOGD("Created stack: msg-it-addr=%p, stack-addr=%p", msg_it
, stack
);
374 void stack_destroy(struct stack
*stack
)
376 struct ctf_msg_iter
*msg_it
;
378 BT_ASSERT_DBG(stack
);
379 msg_it
= stack
->msg_it
;
380 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
382 if (stack
->entries
) {
383 g_array_free(stack
->entries
, TRUE
);
390 void stack_push(struct stack
*stack
, bt_field
*base
)
392 struct stack_entry
*entry
;
393 struct ctf_msg_iter
*msg_it
;
395 BT_ASSERT_DBG(stack
);
396 msg_it
= stack
->msg_it
;
398 BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, "
399 "stack-size-before=%zu, stack-size-after=%zu",
400 stack
, stack
->size
, stack
->size
+ 1);
402 if (stack
->entries
->len
== stack
->size
) {
403 g_array_set_size(stack
->entries
, stack
->size
+ 1);
406 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
413 unsigned int stack_size(struct stack
*stack
)
415 BT_ASSERT_DBG(stack
);
420 void stack_pop(struct stack
*stack
)
422 struct ctf_msg_iter
*msg_it
;
424 BT_ASSERT_DBG(stack
);
425 BT_ASSERT_DBG(stack_size(stack
));
426 msg_it
= stack
->msg_it
;
427 BT_COMP_LOGT("Popping from stack: "
428 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
429 stack
, stack
->size
, stack
->size
- 1);
434 struct stack_entry
*stack_top(struct stack
*stack
)
436 BT_ASSERT_DBG(stack
);
437 BT_ASSERT_DBG(stack_size(stack
));
438 return &g_array_index(stack
->entries
, struct stack_entry
,
443 bool stack_empty(struct stack
*stack
)
445 return stack_size(stack
) == 0;
449 void stack_clear(struct stack
*stack
)
451 BT_ASSERT_DBG(stack
);
456 enum ctf_msg_iter_status
msg_iter_status_from_m_status(
457 enum ctf_msg_iter_medium_status m_status
)
459 /* They are the same */
460 return (int) m_status
;
464 size_t buf_size_bits(struct ctf_msg_iter
*msg_it
)
466 return msg_it
->buf
.sz
* 8;
470 size_t buf_available_bits(struct ctf_msg_iter
*msg_it
)
472 return buf_size_bits(msg_it
) - msg_it
->buf
.at
;
476 size_t packet_at(struct ctf_msg_iter
*msg_it
)
478 return msg_it
->buf
.packet_offset
+ msg_it
->buf
.at
;
482 void buf_consume_bits(struct ctf_msg_iter
*msg_it
, size_t incr
)
484 BT_COMP_LOGT("Advancing cursor: msg-it-addr=%p, cur-before=%zu, cur-after=%zu",
485 msg_it
, msg_it
->buf
.at
, msg_it
->buf
.at
+ incr
);
486 msg_it
->buf
.at
+= incr
;
490 enum ctf_msg_iter_status
request_medium_bytes(
491 struct ctf_msg_iter
*msg_it
)
493 bt_self_component
*self_comp
= msg_it
->self_comp
;
494 uint8_t *buffer_addr
= NULL
;
495 size_t buffer_sz
= 0;
496 enum ctf_msg_iter_medium_status m_status
;
498 BT_COMP_LOGD("Calling user function (request bytes): msg-it-addr=%p, "
499 "request-size=%zu", msg_it
, msg_it
->medium
.max_request_sz
);
500 m_status
= msg_it
->medium
.medops
.request_bytes(
501 msg_it
->medium
.max_request_sz
, &buffer_addr
,
502 &buffer_sz
, msg_it
->medium
.data
);
503 BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
504 ctf_msg_iter_medium_status_string(m_status
),
505 buffer_addr
, buffer_sz
);
506 if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
507 BT_ASSERT(buffer_sz
!= 0);
509 /* New packet offset is old one + old size (in bits) */
510 msg_it
->buf
.packet_offset
+= buf_size_bits(msg_it
);
512 /* Restart at the beginning of the new medium buffer */
514 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
516 /* New medium buffer size */
517 msg_it
->buf
.sz
= buffer_sz
;
519 /* New medium buffer address */
520 msg_it
->buf
.addr
= buffer_addr
;
522 BT_COMP_LOGD("User function returned new bytes: "
523 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
524 msg_it
->buf
.packet_offset
, msg_it
->buf
.at
,
525 msg_it
->buf
.sz
, msg_it
->buf
.addr
);
526 BT_COMP_LOGD_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
528 } else if (m_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
530 * User returned end of stream: validate that we're not
531 * in the middle of a packet header, packet context, or
534 if (msg_it
->cur_exp_packet_total_size
>= 0) {
535 if (packet_at(msg_it
) ==
536 msg_it
->cur_exp_packet_total_size
) {
540 if (packet_at(msg_it
) == 0) {
544 if (msg_it
->buf
.last_eh_at
!= SIZE_MAX
&&
545 msg_it
->buf
.at
== msg_it
->buf
.last_eh_at
) {
550 /* All other states are invalid */
551 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
552 "User function returned %s, but message iterator is in an unexpected state: "
553 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
554 "packet-cur=%zu, last-eh-at=%zu",
555 ctf_msg_iter_medium_status_string(m_status
),
556 state_string(msg_it
->state
),
557 msg_it
->cur_exp_packet_total_size
,
558 msg_it
->buf
.at
, packet_at(msg_it
),
559 msg_it
->buf
.last_eh_at
);
560 m_status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
561 } else if (m_status
< 0) {
562 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "User function failed: "
563 "status=%s", ctf_msg_iter_medium_status_string(m_status
));
567 return msg_iter_status_from_m_status(m_status
);
571 enum ctf_msg_iter_status
buf_ensure_available_bits(
572 struct ctf_msg_iter
*msg_it
)
574 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
576 if (G_UNLIKELY(buf_available_bits(msg_it
) == 0)) {
578 * This _cannot_ return CTF_MSG_ITER_STATUS_OK
581 status
= request_medium_bytes(msg_it
);
588 enum ctf_msg_iter_status
read_dscope_begin_state(
589 struct ctf_msg_iter
*msg_it
,
590 struct ctf_field_class
*dscope_fc
,
591 enum state done_state
, enum state continue_state
,
592 bt_field
*dscope_field
)
594 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
595 bt_self_component
*self_comp
= msg_it
->self_comp
;
596 enum bt_bfcr_status bfcr_status
;
597 size_t consumed_bits
;
599 msg_it
->cur_dscope_field
= dscope_field
;
600 BT_COMP_LOGT("Starting BFCR: msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p",
601 msg_it
, msg_it
->bfcr
, dscope_fc
);
602 consumed_bits
= bt_bfcr_start(msg_it
->bfcr
, dscope_fc
,
603 msg_it
->buf
.addr
, msg_it
->buf
.at
, packet_at(msg_it
),
604 msg_it
->buf
.sz
, &bfcr_status
);
605 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
607 switch (bfcr_status
) {
608 case BT_BFCR_STATUS_OK
:
609 /* Field class was read completely */
610 BT_COMP_LOGT_STR("Field was completely decoded.");
611 msg_it
->state
= done_state
;
613 case BT_BFCR_STATUS_EOF
:
614 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
615 msg_it
->state
= continue_state
;
618 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
619 "BFCR failed to start: msg-it-addr=%p, bfcr-addr=%p, "
620 "status=%s", msg_it
, msg_it
->bfcr
,
621 bt_bfcr_status_string(bfcr_status
));
622 status
= CTF_MSG_ITER_STATUS_ERROR
;
626 /* Consume bits now since we know we're not in an error state */
627 buf_consume_bits(msg_it
, consumed_bits
);
634 enum ctf_msg_iter_status
read_dscope_continue_state(
635 struct ctf_msg_iter
*msg_it
, enum state done_state
)
637 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
638 bt_self_component
*self_comp
= msg_it
->self_comp
;
639 enum bt_bfcr_status bfcr_status
;
640 size_t consumed_bits
;
642 BT_COMP_LOGT("Continuing BFCR: msg-it-addr=%p, bfcr-addr=%p",
643 msg_it
, msg_it
->bfcr
);
645 status
= buf_ensure_available_bits(msg_it
);
646 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
648 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
649 "Cannot ensure that buffer has at least one byte: "
650 "msg-addr=%p, status=%s",
651 msg_it
, ctf_msg_iter_status_string(status
));
653 BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: "
654 "msg-addr=%p, status=%s",
655 msg_it
, ctf_msg_iter_status_string(status
));
661 consumed_bits
= bt_bfcr_continue(msg_it
->bfcr
, msg_it
->buf
.addr
,
662 msg_it
->buf
.sz
, &bfcr_status
);
663 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
665 switch (bfcr_status
) {
666 case BT_BFCR_STATUS_OK
:
667 /* Type was read completely. */
668 BT_COMP_LOGT_STR("Field was completely decoded.");
669 msg_it
->state
= done_state
;
671 case BT_BFCR_STATUS_EOF
:
672 /* Stay in this continue state. */
673 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
676 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
677 "BFCR failed to continue: msg-it-addr=%p, bfcr-addr=%p, "
678 "status=%s", msg_it
, msg_it
->bfcr
,
679 bt_bfcr_status_string(bfcr_status
));
680 status
= CTF_MSG_ITER_STATUS_ERROR
;
684 /* Consume bits now since we know we're not in an error state. */
685 buf_consume_bits(msg_it
, consumed_bits
);
691 void release_event_dscopes(struct ctf_msg_iter
*msg_it
)
693 msg_it
->dscopes
.event_common_context
= NULL
;
694 msg_it
->dscopes
.event_spec_context
= NULL
;
695 msg_it
->dscopes
.event_payload
= NULL
;
699 void release_all_dscopes(struct ctf_msg_iter
*msg_it
)
701 msg_it
->dscopes
.stream_packet_context
= NULL
;
703 release_event_dscopes(msg_it
);
707 enum ctf_msg_iter_status
switch_packet_state(struct ctf_msg_iter
*msg_it
)
709 enum ctf_msg_iter_status status
;
710 bt_self_component
*self_comp
= msg_it
->self_comp
;
713 * We don't put the stream class here because we need to make
714 * sure that all the packets processed by the same message
715 * iterator refer to the same stream class (the first one).
719 if (msg_it
->cur_exp_packet_total_size
!= -1) {
720 msg_it
->cur_packet_offset
+= msg_it
->cur_exp_packet_total_size
;
723 BT_COMP_LOGD("Switching packet: msg-it-addr=%p, cur=%zu, "
724 "packet-offset=%" PRId64
, msg_it
, msg_it
->buf
.at
,
725 msg_it
->cur_packet_offset
);
726 stack_clear(msg_it
->stack
);
727 msg_it
->meta
.ec
= NULL
;
728 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
729 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
730 release_all_dscopes(msg_it
);
731 msg_it
->cur_dscope_field
= NULL
;
733 if (msg_it
->medium
.medops
.switch_packet
) {
734 enum ctf_msg_iter_medium_status medium_status
;
736 medium_status
= msg_it
->medium
.medops
.switch_packet(msg_it
->medium
.data
);
737 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
738 /* No more packets. */
739 msg_it
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
740 status
= CTF_MSG_ITER_STATUS_OK
;
742 } else if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
743 status
= (int) medium_status
;
748 * After the packet switch, the medium might want to give us a
749 * different buffer for the new packet.
751 status
= request_medium_bytes(msg_it
);
752 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
758 * Adjust current buffer so that addr points to the beginning of the new
761 if (msg_it
->buf
.addr
) {
762 size_t consumed_bytes
= (size_t) (msg_it
->buf
.at
/ CHAR_BIT
);
764 /* Packets are assumed to start on a byte frontier. */
765 if (msg_it
->buf
.at
% CHAR_BIT
) {
766 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
767 "Cannot switch packet: current position is not a multiple of 8: "
768 "msg-it-addr=%p, cur=%zu", msg_it
, msg_it
->buf
.at
);
769 status
= CTF_MSG_ITER_STATUS_ERROR
;
773 msg_it
->buf
.addr
+= consumed_bytes
;
774 msg_it
->buf
.sz
-= consumed_bytes
;
776 msg_it
->buf
.packet_offset
= 0;
777 BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu",
778 msg_it
->buf
.addr
, msg_it
->buf
.sz
);
781 msg_it
->cur_exp_packet_content_size
= -1;
782 msg_it
->cur_exp_packet_total_size
= -1;
783 msg_it
->cur_stream_class_id
= -1;
784 msg_it
->cur_event_class_id
= -1;
785 msg_it
->cur_data_stream_id
= -1;
786 msg_it
->prev_packet_snapshots
= msg_it
->snapshots
;
787 msg_it
->snapshots
.discarded_events
= UINT64_C(-1);
788 msg_it
->snapshots
.packets
= UINT64_C(-1);
789 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
790 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
791 msg_it
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
793 status
= CTF_MSG_ITER_STATUS_OK
;
799 enum ctf_msg_iter_status
read_packet_header_begin_state(
800 struct ctf_msg_iter
*msg_it
)
802 struct ctf_field_class
*packet_header_fc
= NULL
;
803 bt_self_component
*self_comp
= msg_it
->self_comp
;
804 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
807 * Make sure at least one bit is available for this packet. An
808 * empty packet is impossible. If we reach the end of the medium
809 * at this point, then it's considered the end of the stream.
811 status
= buf_ensure_available_bits(msg_it
);
813 case CTF_MSG_ITER_STATUS_OK
:
815 case CTF_MSG_ITER_STATUS_EOF
:
816 status
= CTF_MSG_ITER_STATUS_OK
;
817 msg_it
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
823 /* Packet header class is common to the whole trace class. */
824 packet_header_fc
= msg_it
->meta
.tc
->packet_header_fc
;
825 if (!packet_header_fc
) {
826 msg_it
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
830 msg_it
->cur_stream_class_id
= -1;
831 msg_it
->cur_event_class_id
= -1;
832 msg_it
->cur_data_stream_id
= -1;
833 BT_COMP_LOGD("Decoding packet header field:"
834 "msg-it-addr=%p, trace-class-addr=%p, fc-addr=%p",
835 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
836 status
= read_dscope_begin_state(msg_it
, packet_header_fc
,
837 STATE_AFTER_TRACE_PACKET_HEADER
,
838 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
840 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
841 "Cannot decode packet header field: "
842 "msg-it-addr=%p, trace-class-addr=%p, "
844 msg_it
, msg_it
->meta
.tc
, packet_header_fc
);
852 enum ctf_msg_iter_status
read_packet_header_continue_state(
853 struct ctf_msg_iter
*msg_it
)
855 return read_dscope_continue_state(msg_it
,
856 STATE_AFTER_TRACE_PACKET_HEADER
);
860 enum ctf_msg_iter_status
set_current_stream_class(struct ctf_msg_iter
*msg_it
)
862 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
863 bt_self_component
*self_comp
= msg_it
->self_comp
;
864 struct ctf_stream_class
*new_stream_class
= NULL
;
866 if (msg_it
->cur_stream_class_id
== -1) {
868 * No current stream class ID field, therefore only one
871 if (msg_it
->meta
.tc
->stream_classes
->len
!= 1) {
872 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
873 "Need exactly one stream class since there's "
874 "no stream class ID field: "
875 "msg-it-addr=%p", msg_it
);
876 status
= CTF_MSG_ITER_STATUS_ERROR
;
880 new_stream_class
= msg_it
->meta
.tc
->stream_classes
->pdata
[0];
881 msg_it
->cur_stream_class_id
= new_stream_class
->id
;
884 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
885 msg_it
->meta
.tc
, msg_it
->cur_stream_class_id
);
886 if (!new_stream_class
) {
887 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
888 "No stream class with ID of stream class ID to use in trace class: "
889 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
890 "trace-class-addr=%p",
891 msg_it
, msg_it
->cur_stream_class_id
, msg_it
->meta
.tc
);
892 status
= CTF_MSG_ITER_STATUS_ERROR
;
896 if (msg_it
->meta
.sc
) {
897 if (new_stream_class
!= msg_it
->meta
.sc
) {
898 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
899 "Two packets refer to two different stream classes within the same packet sequence: "
900 "msg-it-addr=%p, prev-stream-class-addr=%p, "
901 "prev-stream-class-id=%" PRId64
", "
902 "next-stream-class-addr=%p, "
903 "next-stream-class-id=%" PRId64
", "
905 msg_it
, msg_it
->meta
.sc
,
908 new_stream_class
->id
,
910 status
= CTF_MSG_ITER_STATUS_ERROR
;
914 msg_it
->meta
.sc
= new_stream_class
;
917 BT_COMP_LOGD("Set current stream class: "
918 "msg-it-addr=%p, stream-class-addr=%p, "
919 "stream-class-id=%" PRId64
,
920 msg_it
, msg_it
->meta
.sc
, msg_it
->meta
.sc
->id
);
927 enum ctf_msg_iter_status
set_current_stream(struct ctf_msg_iter
*msg_it
)
929 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
930 bt_self_component
*self_comp
= msg_it
->self_comp
;
931 bt_stream
*stream
= NULL
;
933 BT_COMP_LOGD("Calling user function (get stream): msg-it-addr=%p, "
934 "stream-class-addr=%p, stream-class-id=%" PRId64
,
935 msg_it
, msg_it
->meta
.sc
,
936 msg_it
->meta
.sc
->id
);
937 stream
= msg_it
->medium
.medops
.borrow_stream(
938 msg_it
->meta
.sc
->ir_sc
, msg_it
->cur_data_stream_id
,
939 msg_it
->medium
.data
);
940 bt_stream_get_ref(stream
);
941 BT_COMP_LOGD("User function returned: stream-addr=%p", stream
);
943 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
944 "User function failed to return a stream object for the given stream class.");
945 status
= CTF_MSG_ITER_STATUS_ERROR
;
949 if (msg_it
->stream
&& stream
!= msg_it
->stream
) {
950 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
951 "User function returned a different stream than the previous one for the same sequence of packets.");
952 status
= CTF_MSG_ITER_STATUS_ERROR
;
956 BT_STREAM_MOVE_REF(msg_it
->stream
, stream
);
959 bt_stream_put_ref(stream
);
964 enum ctf_msg_iter_status
set_current_packet(struct ctf_msg_iter
*msg_it
)
966 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
967 bt_self_component
*self_comp
= msg_it
->self_comp
;
968 bt_packet
*packet
= NULL
;
970 BT_COMP_LOGD("Creating packet from stream: "
971 "msg-it-addr=%p, stream-addr=%p, "
972 "stream-class-addr=%p, "
973 "stream-class-id=%" PRId64
,
974 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
,
975 msg_it
->meta
.sc
->id
);
978 BT_ASSERT(msg_it
->stream
);
979 packet
= bt_packet_create(msg_it
->stream
);
981 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
982 "Cannot create packet from stream: "
983 "msg-it-addr=%p, stream-addr=%p, "
984 "stream-class-addr=%p, "
985 "stream-class-id=%" PRId64
,
986 msg_it
, msg_it
->stream
, msg_it
->meta
.sc
,
987 msg_it
->meta
.sc
->id
);
994 BT_PACKET_PUT_REF_AND_RESET(packet
);
995 status
= CTF_MSG_ITER_STATUS_ERROR
;
998 BT_PACKET_MOVE_REF(msg_it
->packet
, packet
);
1003 enum ctf_msg_iter_status
after_packet_header_state(
1004 struct ctf_msg_iter
*msg_it
)
1006 enum ctf_msg_iter_status status
;
1008 status
= set_current_stream_class(msg_it
);
1009 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1013 if (!msg_it
->dry_run
) {
1014 status
= set_current_stream(msg_it
);
1015 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1019 status
= set_current_packet(msg_it
);
1020 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1025 msg_it
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
1027 status
= CTF_MSG_ITER_STATUS_OK
;
1034 enum ctf_msg_iter_status
read_packet_context_begin_state(
1035 struct ctf_msg_iter
*msg_it
)
1037 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1038 bt_self_component
*self_comp
= msg_it
->self_comp
;
1039 struct ctf_field_class
*packet_context_fc
;
1041 BT_ASSERT(msg_it
->meta
.sc
);
1042 packet_context_fc
= msg_it
->meta
.sc
->packet_context_fc
;
1043 if (!packet_context_fc
) {
1044 BT_COMP_LOGD("No packet packet context field class in stream class: continuing: "
1045 "msg-it-addr=%p, stream-class-addr=%p, "
1046 "stream-class-id=%" PRId64
,
1047 msg_it
, msg_it
->meta
.sc
,
1048 msg_it
->meta
.sc
->id
);
1049 msg_it
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
1053 if (packet_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1054 BT_ASSERT(!msg_it
->dscopes
.stream_packet_context
);
1055 BT_ASSERT(msg_it
->packet
);
1056 msg_it
->dscopes
.stream_packet_context
=
1057 bt_packet_borrow_context_field(msg_it
->packet
);
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
->emit_stream_beginning_message
) {
1150 msg_it
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1152 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1160 enum ctf_msg_iter_status
read_event_header_begin_state(struct ctf_msg_iter
*msg_it
)
1162 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1163 bt_self_component
*self_comp
= msg_it
->self_comp
;
1164 struct ctf_field_class
*event_header_fc
= NULL
;
1166 /* Reset the position of the last event header */
1167 msg_it
->buf
.last_eh_at
= msg_it
->buf
.at
;
1168 msg_it
->cur_event_class_id
= -1;
1170 /* Check if we have some content left */
1171 if (msg_it
->cur_exp_packet_content_size
>= 0) {
1172 if (G_UNLIKELY(packet_at(msg_it
) ==
1173 msg_it
->cur_exp_packet_content_size
)) {
1174 /* No more events! */
1175 BT_COMP_LOGD("Reached end of packet: msg-it-addr=%p, "
1176 "cur=%zu", msg_it
, packet_at(msg_it
));
1177 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1179 } else if (G_UNLIKELY(packet_at(msg_it
) >
1180 msg_it
->cur_exp_packet_content_size
)) {
1181 /* That's not supposed to happen */
1182 BT_COMP_LOGD("Before decoding event header field: cursor is passed the packet's content: "
1183 "msg-it-addr=%p, content-size=%" PRId64
", "
1185 msg_it
->cur_exp_packet_content_size
,
1187 status
= CTF_MSG_ITER_STATUS_ERROR
;
1192 * "Infinite" content: we're done when the medium has
1193 * nothing else for us.
1195 status
= buf_ensure_available_bits(msg_it
);
1197 case CTF_MSG_ITER_STATUS_OK
:
1199 case CTF_MSG_ITER_STATUS_EOF
:
1200 status
= CTF_MSG_ITER_STATUS_OK
;
1201 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1208 release_event_dscopes(msg_it
);
1209 BT_ASSERT(msg_it
->meta
.sc
);
1210 event_header_fc
= msg_it
->meta
.sc
->event_header_fc
;
1211 if (!event_header_fc
) {
1212 msg_it
->state
= STATE_AFTER_EVENT_HEADER
;
1216 BT_COMP_LOGD("Decoding event header field: "
1217 "msg-it-addr=%p, stream-class-addr=%p, "
1218 "stream-class-id=%" PRId64
", "
1220 msg_it
, msg_it
->meta
.sc
,
1221 msg_it
->meta
.sc
->id
,
1223 status
= read_dscope_begin_state(msg_it
, event_header_fc
,
1224 STATE_AFTER_EVENT_HEADER
,
1225 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1227 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1228 "Cannot decode event header field: "
1229 "msg-it-addr=%p, stream-class-addr=%p, "
1230 "stream-class-id=%" PRId64
", fc-addr=%p",
1231 msg_it
, msg_it
->meta
.sc
,
1232 msg_it
->meta
.sc
->id
,
1241 enum ctf_msg_iter_status
read_event_header_continue_state(
1242 struct ctf_msg_iter
*msg_it
)
1244 return read_dscope_continue_state(msg_it
,
1245 STATE_AFTER_EVENT_HEADER
);
1249 enum ctf_msg_iter_status
set_current_event_class(struct ctf_msg_iter
*msg_it
)
1251 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1252 bt_self_component
*self_comp
= msg_it
->self_comp
;
1254 struct ctf_event_class
*new_event_class
= NULL
;
1256 if (msg_it
->cur_event_class_id
== -1) {
1258 * No current event class ID field, therefore only one
1261 if (msg_it
->meta
.sc
->event_classes
->len
!= 1) {
1262 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1263 "Need exactly one event class since there's no event class ID field: "
1264 "msg-it-addr=%p", msg_it
);
1265 status
= CTF_MSG_ITER_STATUS_ERROR
;
1269 new_event_class
= msg_it
->meta
.sc
->event_classes
->pdata
[0];
1270 msg_it
->cur_event_class_id
= new_event_class
->id
;
1273 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1274 msg_it
->meta
.sc
, msg_it
->cur_event_class_id
);
1275 if (!new_event_class
) {
1276 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1277 "No event class with ID of event class ID to use in stream class: "
1278 "msg-it-addr=%p, stream-class-id=%" PRIu64
", "
1279 "event-class-id=%" PRIu64
", "
1280 "trace-class-addr=%p",
1281 msg_it
, msg_it
->meta
.sc
->id
, msg_it
->cur_event_class_id
,
1283 status
= CTF_MSG_ITER_STATUS_ERROR
;
1287 msg_it
->meta
.ec
= new_event_class
;
1288 BT_COMP_LOGD("Set current event class: "
1289 "msg-it-addr=%p, event-class-addr=%p, "
1290 "event-class-id=%" PRId64
", "
1291 "event-class-name=\"%s\"",
1292 msg_it
, msg_it
->meta
.ec
, msg_it
->meta
.ec
->id
,
1293 msg_it
->meta
.ec
->name
->str
);
1300 enum ctf_msg_iter_status
set_current_event_message(
1301 struct ctf_msg_iter
*msg_it
)
1303 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1304 bt_self_component
*self_comp
= msg_it
->self_comp
;
1305 bt_message
*msg
= NULL
;
1307 BT_ASSERT_DBG(msg_it
->meta
.ec
);
1308 BT_ASSERT_DBG(msg_it
->packet
);
1309 BT_COMP_LOGD("Creating event message from event class and packet: "
1310 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1311 msg_it
, msg_it
->meta
.ec
,
1312 msg_it
->meta
.ec
->name
->str
,
1314 BT_ASSERT_DBG(msg_it
->self_msg_iter
);
1315 BT_ASSERT_DBG(msg_it
->meta
.sc
);
1317 if (bt_stream_class_borrow_default_clock_class(msg_it
->meta
.sc
->ir_sc
)) {
1318 msg
= bt_message_event_create_with_packet_and_default_clock_snapshot(
1319 msg_it
->self_msg_iter
, msg_it
->meta
.ec
->ir_ec
,
1320 msg_it
->packet
, msg_it
->default_clock_snapshot
);
1322 msg
= bt_message_event_create_with_packet(msg_it
->self_msg_iter
,
1323 msg_it
->meta
.ec
->ir_ec
, msg_it
->packet
);
1327 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1328 "Cannot create event message: "
1329 "msg-it-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1331 msg_it
, msg_it
->meta
.ec
,
1332 msg_it
->meta
.ec
->name
->str
,
1340 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1341 status
= CTF_MSG_ITER_STATUS_ERROR
;
1344 BT_MESSAGE_MOVE_REF(msg_it
->event_msg
, msg
);
1349 enum ctf_msg_iter_status
after_event_header_state(
1350 struct ctf_msg_iter
*msg_it
)
1352 enum ctf_msg_iter_status status
;
1354 status
= set_current_event_class(msg_it
);
1355 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1359 if (G_UNLIKELY(msg_it
->dry_run
)) {
1363 status
= set_current_event_message(msg_it
);
1364 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1368 msg_it
->event
= bt_message_event_borrow_event(
1370 BT_ASSERT_DBG(msg_it
->event
);
1373 msg_it
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1380 enum ctf_msg_iter_status
read_event_common_context_begin_state(
1381 struct ctf_msg_iter
*msg_it
)
1383 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1384 bt_self_component
*self_comp
= msg_it
->self_comp
;
1385 struct ctf_field_class
*event_common_context_fc
;
1387 event_common_context_fc
= msg_it
->meta
.sc
->event_common_context_fc
;
1388 if (!event_common_context_fc
) {
1389 msg_it
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1393 if (event_common_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1394 BT_ASSERT_DBG(!msg_it
->dscopes
.event_common_context
);
1395 msg_it
->dscopes
.event_common_context
=
1396 bt_event_borrow_common_context_field(
1398 BT_ASSERT_DBG(msg_it
->dscopes
.event_common_context
);
1401 BT_COMP_LOGT("Decoding event common context field: "
1402 "msg-it-addr=%p, stream-class-addr=%p, "
1403 "stream-class-id=%" PRId64
", "
1405 msg_it
, msg_it
->meta
.sc
,
1406 msg_it
->meta
.sc
->id
,
1407 event_common_context_fc
);
1408 status
= read_dscope_begin_state(msg_it
, event_common_context_fc
,
1409 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1410 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1411 msg_it
->dscopes
.event_common_context
);
1413 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1414 "Cannot decode event common context field: "
1415 "msg-it-addr=%p, stream-class-addr=%p, "
1416 "stream-class-id=%" PRId64
", fc-addr=%p",
1417 msg_it
, msg_it
->meta
.sc
,
1418 msg_it
->meta
.sc
->id
,
1419 event_common_context_fc
);
1427 enum ctf_msg_iter_status
read_event_common_context_continue_state(
1428 struct ctf_msg_iter
*msg_it
)
1430 return read_dscope_continue_state(msg_it
,
1431 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1435 enum ctf_msg_iter_status
read_event_spec_context_begin_state(
1436 struct ctf_msg_iter
*msg_it
)
1438 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1439 bt_self_component
*self_comp
= msg_it
->self_comp
;
1440 struct ctf_field_class
*event_spec_context_fc
;
1442 event_spec_context_fc
= msg_it
->meta
.ec
->spec_context_fc
;
1443 if (!event_spec_context_fc
) {
1444 msg_it
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1448 if (event_spec_context_fc
->in_ir
&& !msg_it
->dry_run
) {
1449 BT_ASSERT_DBG(!msg_it
->dscopes
.event_spec_context
);
1450 msg_it
->dscopes
.event_spec_context
=
1451 bt_event_borrow_specific_context_field(
1453 BT_ASSERT_DBG(msg_it
->dscopes
.event_spec_context
);
1456 BT_COMP_LOGT("Decoding event specific context field: "
1457 "msg-it-addr=%p, event-class-addr=%p, "
1458 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1460 msg_it
, msg_it
->meta
.ec
,
1461 msg_it
->meta
.ec
->name
->str
,
1462 msg_it
->meta
.ec
->id
,
1463 event_spec_context_fc
);
1464 status
= read_dscope_begin_state(msg_it
, event_spec_context_fc
,
1465 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1466 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1467 msg_it
->dscopes
.event_spec_context
);
1469 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1470 "Cannot decode event specific context field: "
1471 "msg-it-addr=%p, event-class-addr=%p, "
1472 "event-class-name=\"%s\", "
1473 "event-class-id=%" PRId64
", fc-addr=%p",
1474 msg_it
, msg_it
->meta
.ec
,
1475 msg_it
->meta
.ec
->name
->str
,
1476 msg_it
->meta
.ec
->id
,
1477 event_spec_context_fc
);
1485 enum ctf_msg_iter_status
read_event_spec_context_continue_state(
1486 struct ctf_msg_iter
*msg_it
)
1488 return read_dscope_continue_state(msg_it
,
1489 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1493 enum ctf_msg_iter_status
read_event_payload_begin_state(
1494 struct ctf_msg_iter
*msg_it
)
1496 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1497 bt_self_component
*self_comp
= msg_it
->self_comp
;
1498 struct ctf_field_class
*event_payload_fc
;
1500 event_payload_fc
= msg_it
->meta
.ec
->payload_fc
;
1501 if (!event_payload_fc
) {
1502 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1506 if (event_payload_fc
->in_ir
&& !msg_it
->dry_run
) {
1507 BT_ASSERT_DBG(!msg_it
->dscopes
.event_payload
);
1508 msg_it
->dscopes
.event_payload
=
1509 bt_event_borrow_payload_field(
1511 BT_ASSERT_DBG(msg_it
->dscopes
.event_payload
);
1514 BT_COMP_LOGT("Decoding event payload field: "
1515 "msg-it-addr=%p, event-class-addr=%p, "
1516 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1518 msg_it
, msg_it
->meta
.ec
,
1519 msg_it
->meta
.ec
->name
->str
,
1520 msg_it
->meta
.ec
->id
,
1522 status
= read_dscope_begin_state(msg_it
, event_payload_fc
,
1523 STATE_EMIT_MSG_EVENT
,
1524 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1525 msg_it
->dscopes
.event_payload
);
1527 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1528 "Cannot decode event payload field: "
1529 "msg-it-addr=%p, event-class-addr=%p, "
1530 "event-class-name=\"%s\", "
1531 "event-class-id=%" PRId64
", fc-addr=%p",
1532 msg_it
, msg_it
->meta
.ec
,
1533 msg_it
->meta
.ec
->name
->str
,
1534 msg_it
->meta
.ec
->id
,
1543 enum ctf_msg_iter_status
read_event_payload_continue_state(
1544 struct ctf_msg_iter
*msg_it
)
1546 return read_dscope_continue_state(msg_it
, STATE_EMIT_MSG_EVENT
);
1550 enum ctf_msg_iter_status
skip_packet_padding_state(struct ctf_msg_iter
*msg_it
)
1552 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1553 size_t bits_to_skip
;
1554 const enum state next_state
= STATE_SWITCH_PACKET
;
1556 BT_ASSERT(msg_it
->cur_exp_packet_total_size
> 0);
1557 bits_to_skip
= msg_it
->cur_exp_packet_total_size
- packet_at(msg_it
);
1558 if (bits_to_skip
== 0) {
1559 msg_it
->state
= next_state
;
1562 size_t bits_to_consume
;
1564 BT_COMP_LOGD("Trying to skip %zu bits of padding: msg-it-addr=%p, size=%zu",
1565 bits_to_skip
, msg_it
, bits_to_skip
);
1566 status
= buf_ensure_available_bits(msg_it
);
1567 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
1571 bits_to_consume
= MIN(buf_available_bits(msg_it
), bits_to_skip
);
1572 BT_COMP_LOGD("Skipping %zu bits of padding: msg-it-addr=%p, size=%zu",
1573 bits_to_consume
, msg_it
, bits_to_consume
);
1574 buf_consume_bits(msg_it
, bits_to_consume
);
1575 bits_to_skip
= msg_it
->cur_exp_packet_total_size
-
1577 if (bits_to_skip
== 0) {
1578 msg_it
->state
= next_state
;
1588 enum ctf_msg_iter_status
check_emit_msg_discarded_events(
1589 struct ctf_msg_iter
*msg_it
)
1591 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1593 if (!msg_it
->meta
.sc
->has_discarded_events
) {
1594 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1598 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1599 if (msg_it
->snapshots
.discarded_events
== 0 ||
1600 msg_it
->snapshots
.discarded_events
== UINT64_C(-1)) {
1602 * Stream's first packet with no discarded
1603 * events or no information about discarded
1604 * events: do not emit.
1606 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1610 * If the previous packet has a value for this counter,
1611 * then this counter is defined for the whole stream.
1613 BT_ASSERT(msg_it
->snapshots
.discarded_events
!= UINT64_C(-1));
1615 if (msg_it
->snapshots
.discarded_events
-
1616 msg_it
->prev_packet_snapshots
.discarded_events
== 0) {
1618 * No discarded events since previous packet: do
1621 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1626 return CTF_MSG_ITER_STATUS_OK
;
1630 enum ctf_msg_iter_status
check_emit_msg_discarded_packets(
1631 struct ctf_msg_iter
*msg_it
)
1633 msg_it
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1635 if (!msg_it
->meta
.sc
->has_discarded_packets
) {
1636 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1640 if (msg_it
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1642 * Stream's first packet or no information about
1643 * discarded packets: do not emit. In other words, if
1644 * this is the first packet and its sequence number is
1645 * not 0, do not consider that packets were previously
1646 * lost: we might be reading a partial stream (LTTng
1647 * snapshot for example).
1649 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1652 * If the previous packet has a value for this counter,
1653 * then this counter is defined for the whole stream.
1655 BT_ASSERT(msg_it
->snapshots
.packets
!= UINT64_C(-1));
1657 if (msg_it
->snapshots
.packets
-
1658 msg_it
->prev_packet_snapshots
.packets
<= 1) {
1660 * No discarded packets since previous packet:
1663 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1668 return CTF_MSG_ITER_STATUS_OK
;
1672 enum state
check_emit_msg_stream_end(struct ctf_msg_iter
*msg_it
)
1674 enum state next_state
;
1676 if (msg_it
->emit_stream_end_message
) {
1677 next_state
= STATE_EMIT_MSG_STREAM_END
;
1679 next_state
= STATE_DONE
;
1686 enum ctf_msg_iter_status
handle_state(struct ctf_msg_iter
*msg_it
)
1688 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
1689 const enum state state
= msg_it
->state
;
1691 BT_COMP_LOGT("Handling state: msg-it-addr=%p, state=%s",
1692 msg_it
, state_string(state
));
1694 // TODO: optimalize!
1697 msg_it
->state
= STATE_SWITCH_PACKET
;
1699 case STATE_SWITCH_PACKET
:
1700 status
= switch_packet_state(msg_it
);
1702 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1703 status
= read_packet_header_begin_state(msg_it
);
1705 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1706 status
= read_packet_header_continue_state(msg_it
);
1708 case STATE_AFTER_TRACE_PACKET_HEADER
:
1709 status
= after_packet_header_state(msg_it
);
1711 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1712 status
= read_packet_context_begin_state(msg_it
);
1714 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1715 status
= read_packet_context_continue_state(msg_it
);
1717 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1718 status
= after_packet_context_state(msg_it
);
1720 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1721 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1723 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1724 status
= check_emit_msg_discarded_events(msg_it
);
1726 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1727 msg_it
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1729 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1730 status
= check_emit_msg_discarded_packets(msg_it
);
1732 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1733 msg_it
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1735 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1736 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1738 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1739 status
= read_event_header_begin_state(msg_it
);
1741 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1742 status
= read_event_header_continue_state(msg_it
);
1744 case STATE_AFTER_EVENT_HEADER
:
1745 status
= after_event_header_state(msg_it
);
1747 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1748 status
= read_event_common_context_begin_state(msg_it
);
1750 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1751 status
= read_event_common_context_continue_state(msg_it
);
1753 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1754 status
= read_event_spec_context_begin_state(msg_it
);
1756 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1757 status
= read_event_spec_context_continue_state(msg_it
);
1759 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1760 status
= read_event_payload_begin_state(msg_it
);
1762 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1763 status
= read_event_payload_continue_state(msg_it
);
1765 case STATE_EMIT_MSG_EVENT
:
1766 msg_it
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1768 case STATE_EMIT_QUEUED_MSG_EVENT
:
1769 msg_it
->state
= STATE_EMIT_MSG_EVENT
;
1771 case STATE_SKIP_PACKET_PADDING
:
1772 status
= skip_packet_padding_state(msg_it
);
1774 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1775 msg_it
->state
= STATE_SKIP_PACKET_PADDING
;
1777 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1778 msg_it
->state
= STATE_EMIT_MSG_STREAM_END
;
1780 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
1781 msg_it
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1783 case STATE_CHECK_EMIT_MSG_STREAM_END
:
1784 msg_it
->state
= check_emit_msg_stream_end(msg_it
);
1786 case STATE_EMIT_MSG_STREAM_END
:
1787 msg_it
->state
= STATE_DONE
;
1792 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1793 "msg-it-addr=%p, state=%d", msg_it
, msg_it
->state
);
1797 BT_COMP_LOGT("Handled state: msg-it-addr=%p, status=%s, "
1798 "prev-state=%s, cur-state=%s",
1799 msg_it
, ctf_msg_iter_status_string(status
),
1800 state_string(state
), state_string(msg_it
->state
));
1805 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter
*msg_it
)
1808 BT_COMP_LOGD("Resetting message iterator: addr=%p", msg_it
);
1809 stack_clear(msg_it
->stack
);
1810 msg_it
->meta
.sc
= NULL
;
1811 msg_it
->meta
.ec
= NULL
;
1812 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
1813 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
1814 BT_MESSAGE_PUT_REF_AND_RESET(msg_it
->event_msg
);
1815 release_all_dscopes(msg_it
);
1816 msg_it
->cur_dscope_field
= NULL
;
1818 msg_it
->buf
.addr
= NULL
;
1821 msg_it
->buf
.last_eh_at
= SIZE_MAX
;
1822 msg_it
->buf
.packet_offset
= 0;
1823 msg_it
->state
= STATE_INIT
;
1824 msg_it
->cur_exp_packet_content_size
= -1;
1825 msg_it
->cur_exp_packet_total_size
= -1;
1826 msg_it
->cur_packet_offset
= -1;
1827 msg_it
->cur_event_class_id
= -1;
1828 msg_it
->snapshots
.beginning_clock
= UINT64_C(-1);
1829 msg_it
->snapshots
.end_clock
= UINT64_C(-1);
1833 * Resets the internal state of a CTF message iterator.
1836 void ctf_msg_iter_reset(struct ctf_msg_iter
*msg_it
)
1838 ctf_msg_iter_reset_for_next_stream_file(msg_it
);
1839 msg_it
->cur_stream_class_id
= -1;
1840 msg_it
->cur_data_stream_id
= -1;
1841 msg_it
->snapshots
.discarded_events
= UINT64_C(-1);
1842 msg_it
->snapshots
.packets
= UINT64_C(-1);
1843 msg_it
->prev_packet_snapshots
.discarded_events
= UINT64_C(-1);
1844 msg_it
->prev_packet_snapshots
.packets
= UINT64_C(-1);
1845 msg_it
->prev_packet_snapshots
.beginning_clock
= UINT64_C(-1);
1846 msg_it
->prev_packet_snapshots
.end_clock
= UINT64_C(-1);
1847 msg_it
->emit_stream_beginning_message
= true;
1848 msg_it
->emit_stream_end_message
= false;
1852 bt_field
*borrow_next_field(struct ctf_msg_iter
*msg_it
)
1854 bt_field
*next_field
= NULL
;
1855 bt_field
*base_field
;
1856 const bt_field_class
*base_fc
;
1857 bt_field_class_type base_fc_type
;
1860 BT_ASSERT_DBG(!stack_empty(msg_it
->stack
));
1861 index
= stack_top(msg_it
->stack
)->index
;
1862 base_field
= stack_top(msg_it
->stack
)->base
;
1863 BT_ASSERT_DBG(base_field
);
1864 base_fc
= bt_field_borrow_class_const(base_field
);
1865 BT_ASSERT_DBG(base_fc
);
1866 base_fc_type
= bt_field_class_get_type(base_fc
);
1868 if (base_fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
1869 BT_ASSERT_DBG(index
<
1870 bt_field_class_structure_get_member_count(
1871 bt_field_borrow_class_const(
1874 bt_field_structure_borrow_member_field_by_index(
1876 } else if (bt_field_class_type_is(base_fc_type
,
1877 BT_FIELD_CLASS_TYPE_ARRAY
)) {
1878 BT_ASSERT_DBG(index
< bt_field_array_get_length(base_field
));
1879 next_field
= bt_field_array_borrow_element_field_by_index(
1881 } else if (bt_field_class_type_is(base_fc_type
,
1882 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1883 BT_ASSERT_DBG(index
== 0);
1884 next_field
= bt_field_variant_borrow_selected_option_field(
1890 BT_ASSERT_DBG(next_field
);
1895 void update_default_clock(struct ctf_msg_iter
*msg_it
, uint64_t new_val
,
1896 uint64_t new_val_size
)
1898 uint64_t new_val_mask
;
1899 uint64_t cur_value_masked
;
1901 BT_ASSERT_DBG(new_val_size
> 0);
1904 * Special case for a 64-bit new value, which is the limit
1905 * of a clock value as of this version: overwrite the
1906 * current value directly.
1908 if (new_val_size
== 64) {
1909 msg_it
->default_clock_snapshot
= new_val
;
1913 new_val_mask
= (1ULL << new_val_size
) - 1;
1914 cur_value_masked
= msg_it
->default_clock_snapshot
& new_val_mask
;
1916 if (new_val
< cur_value_masked
) {
1918 * It looks like a wrap happened on the number of bits
1919 * of the requested new value. Assume that the clock
1920 * value wrapped only one time.
1922 msg_it
->default_clock_snapshot
+= new_val_mask
+ 1;
1925 /* Clear the low bits of the current clock value. */
1926 msg_it
->default_clock_snapshot
&= ~new_val_mask
;
1928 /* Set the low bits of the current clock value. */
1929 msg_it
->default_clock_snapshot
|= new_val
;
1932 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1933 "value=%" PRIu64
, msg_it
->default_clock_snapshot
);
1937 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1938 struct ctf_field_class
*fc
, void *data
)
1940 struct ctf_msg_iter
*msg_it
= data
;
1941 bt_self_component
*self_comp
= msg_it
->self_comp
;
1942 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1944 bt_field
*field
= NULL
;
1945 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1947 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1948 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1949 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1950 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1952 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1953 goto update_def_clock
;
1956 switch (int_fc
->meaning
) {
1957 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1958 msg_it
->cur_event_class_id
= value
;
1960 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1961 msg_it
->cur_data_stream_id
= value
;
1963 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1964 msg_it
->snapshots
.beginning_clock
= value
;
1966 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1967 msg_it
->snapshots
.end_clock
= value
;
1969 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1970 msg_it
->cur_stream_class_id
= value
;
1972 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1973 if (value
!= 0xc1fc1fc1) {
1974 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1975 "Invalid CTF magic number: msg-it-addr=%p, "
1976 "magic=%" PRIx64
, msg_it
, value
);
1977 status
= BT_BFCR_STATUS_ERROR
;
1982 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1983 msg_it
->snapshots
.packets
= value
;
1985 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1986 msg_it
->snapshots
.discarded_events
= value
;
1988 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1989 msg_it
->cur_exp_packet_total_size
= value
;
1991 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1992 msg_it
->cur_exp_packet_content_size
= value
;
1999 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
2000 update_default_clock(msg_it
, value
, int_fc
->base
.size
);
2003 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
2004 g_array_index(msg_it
->stored_values
, uint64_t,
2005 (uint64_t) int_fc
->storing_index
) = value
;
2008 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2012 field
= borrow_next_field(msg_it
);
2013 BT_ASSERT_DBG(field
);
2014 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2015 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
2016 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
));
2017 bt_field_integer_unsigned_set_value(field
, value
);
2018 stack_top(msg_it
->stack
)->index
++;
2025 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
2026 struct ctf_field_class
*fc
, void *data
)
2029 struct ctf_msg_iter
*msg_it
= data
;
2030 bt_self_component
*self_comp
= msg_it
->self_comp
;
2031 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2032 bt_field
*string_field
= NULL
;
2033 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2034 char str
[2] = {'\0', '\0'};
2036 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
2037 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2038 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
2039 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2040 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2041 BT_ASSERT_DBG(!int_fc
->mapped_clock_class
);
2042 BT_ASSERT_DBG(int_fc
->storing_index
< 0);
2044 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2048 if (msg_it
->done_filling_string
) {
2053 msg_it
->done_filling_string
= true;
2057 string_field
= stack_top(msg_it
->stack
)->base
;
2058 BT_ASSERT_DBG(bt_field_get_class_type(string_field
) ==
2059 BT_FIELD_CLASS_TYPE_STRING
);
2061 /* Append character */
2062 str
[0] = (char) value
;
2063 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
2065 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2066 "Cannot append character to string field's value: "
2067 "msg-it-addr=%p, field-addr=%p, ret=%d",
2068 msg_it
, string_field
, ret
);
2069 status
= BT_BFCR_STATUS_ERROR
;
2078 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
2079 struct ctf_field_class
*fc
, void *data
)
2081 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2082 bt_field
*field
= NULL
;
2083 struct ctf_msg_iter
*msg_it
= data
;
2084 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2086 BT_COMP_LOGT("Signed integer function called from BFCR: "
2087 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2088 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
2089 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2090 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2092 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
2093 g_array_index(msg_it
->stored_values
, uint64_t,
2094 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
2097 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2101 field
= borrow_next_field(msg_it
);
2102 BT_ASSERT_DBG(field
);
2103 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2104 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
2105 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
));
2106 bt_field_integer_signed_set_value(field
, value
);
2107 stack_top(msg_it
->stack
)->index
++;
2114 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
2115 struct ctf_field_class
*fc
, void *data
)
2117 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2118 bt_field
*field
= NULL
;
2119 struct ctf_msg_iter
*msg_it
= data
;
2120 bt_field_class_type type
;
2122 BT_COMP_LOGT("Floating point number function called from BFCR: "
2123 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2124 "fc-type=%d, fc-in-ir=%d, value=%f",
2125 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2127 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2131 field
= borrow_next_field(msg_it
);
2132 type
= bt_field_get_class_type(field
);
2133 BT_ASSERT_DBG(field
);
2134 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2135 BT_ASSERT_DBG(bt_field_class_type_is(type
, BT_FIELD_CLASS_TYPE_REAL
));
2137 if (type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
2138 bt_field_real_single_precision_set_value(field
, (float) value
);
2140 bt_field_real_double_precision_set_value(field
, value
);
2142 stack_top(msg_it
->stack
)->index
++;
2149 enum bt_bfcr_status
bfcr_string_begin_cb(
2150 struct ctf_field_class
*fc
, void *data
)
2152 bt_field
*field
= NULL
;
2153 struct ctf_msg_iter
*msg_it
= data
;
2155 BT_COMP_LOGT("String (beginning) function called from BFCR: "
2156 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2157 "fc-type=%d, fc-in-ir=%d",
2158 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2160 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2164 field
= borrow_next_field(msg_it
);
2165 BT_ASSERT_DBG(field
);
2166 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2167 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2168 BT_FIELD_CLASS_TYPE_STRING
);
2169 bt_field_string_clear(field
);
2172 * Push on stack. Not a compound class per se, but we know that
2173 * only bfcr_string_cb() may be called between this call and a
2174 * subsequent call to bfcr_string_end_cb().
2176 stack_push(msg_it
->stack
, field
);
2179 return BT_BFCR_STATUS_OK
;
2183 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2184 size_t len
, struct ctf_field_class
*fc
, void *data
)
2186 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2187 bt_field
*field
= NULL
;
2188 struct ctf_msg_iter
*msg_it
= data
;
2189 bt_self_component
*self_comp
= msg_it
->self_comp
;
2192 BT_COMP_LOGT("String (substring) function called from BFCR: "
2193 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2194 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2195 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2198 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2202 field
= stack_top(msg_it
->stack
)->base
;
2203 BT_ASSERT_DBG(field
);
2205 /* Append current substring */
2206 ret
= bt_field_string_append_with_length(field
, value
, len
);
2208 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2209 "Cannot append substring to string field's value: "
2210 "msg-it-addr=%p, field-addr=%p, string-length=%zu, "
2211 "ret=%d", msg_it
, field
, len
, ret
);
2212 status
= BT_BFCR_STATUS_ERROR
;
2221 enum bt_bfcr_status
bfcr_string_end_cb(
2222 struct ctf_field_class
*fc
, void *data
)
2224 struct ctf_msg_iter
*msg_it
= data
;
2226 BT_COMP_LOGT("String (end) function called from BFCR: "
2227 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2228 "fc-type=%d, fc-in-ir=%d",
2229 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2231 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2235 /* Pop string field */
2236 stack_pop(msg_it
->stack
);
2238 /* Go to next field */
2239 stack_top(msg_it
->stack
)->index
++;
2242 return BT_BFCR_STATUS_OK
;
2246 enum bt_bfcr_status
bfcr_compound_begin_cb(
2247 struct ctf_field_class
*fc
, void *data
)
2249 struct ctf_msg_iter
*msg_it
= data
;
2252 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2253 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2254 "fc-type=%d, fc-in-ir=%d",
2255 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2257 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2262 if (stack_empty(msg_it
->stack
)) {
2263 /* Root: already set by read_dscope_begin_state() */
2264 field
= msg_it
->cur_dscope_field
;
2266 field
= borrow_next_field(msg_it
);
2267 BT_ASSERT_DBG(field
);
2271 BT_ASSERT_DBG(field
);
2272 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2273 stack_push(msg_it
->stack
, field
);
2276 * Change BFCR "unsigned int" callback if it's a text
2279 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2280 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2281 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2283 if (array_fc
->is_text
) {
2284 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2285 BT_FIELD_CLASS_TYPE_STRING
);
2286 msg_it
->done_filling_string
= false;
2287 bt_field_string_clear(field
);
2288 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
,
2289 bfcr_unsigned_int_char_cb
);
2294 return BT_BFCR_STATUS_OK
;
2298 enum bt_bfcr_status
bfcr_compound_end_cb(
2299 struct ctf_field_class
*fc
, void *data
)
2301 struct ctf_msg_iter
*msg_it
= data
;
2303 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2304 "msg-it-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2305 "fc-type=%d, fc-in-ir=%d",
2306 msg_it
, msg_it
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2308 if (G_UNLIKELY(!fc
->in_ir
|| msg_it
->dry_run
)) {
2312 BT_ASSERT_DBG(!stack_empty(msg_it
->stack
));
2313 BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(msg_it
->stack
)->base
) ==
2317 * Reset BFCR "unsigned int" callback if it's a text
2320 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2321 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2322 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2324 if (array_fc
->is_text
) {
2325 BT_ASSERT_DBG(bt_field_get_class_type(
2326 stack_top(msg_it
->stack
)->base
) ==
2327 BT_FIELD_CLASS_TYPE_STRING
);
2328 bt_bfcr_set_unsigned_int_cb(msg_it
->bfcr
,
2329 bfcr_unsigned_int_cb
);
2334 stack_pop(msg_it
->stack
);
2336 /* If the stack is not empty, increment the base's index */
2337 if (!stack_empty(msg_it
->stack
)) {
2338 stack_top(msg_it
->stack
)->index
++;
2342 return BT_BFCR_STATUS_OK
;
2346 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2348 bt_field
*seq_field
;
2349 struct ctf_msg_iter
*msg_it
= data
;
2350 bt_self_component
*self_comp
= msg_it
->self_comp
;
2351 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2355 length
= (uint64_t) g_array_index(msg_it
->stored_values
, uint64_t,
2356 seq_fc
->stored_length_index
);
2358 if (G_UNLIKELY(msg_it
->dry_run
)){
2362 seq_field
= stack_top(msg_it
->stack
)->base
;
2363 BT_ASSERT_DBG(seq_field
);
2366 * bfcr_get_sequence_length_cb() also gets called back for a
2367 * text sequence, but the destination field is a string field.
2368 * Only set the field's sequence length if the destination field
2369 * is a sequence field.
2371 if (!seq_fc
->base
.is_text
) {
2372 BT_ASSERT_DBG(bt_field_class_type_is(
2373 bt_field_get_class_type(seq_field
),
2374 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
));
2375 ret
= bt_field_array_dynamic_set_length(seq_field
,
2378 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2379 "Cannot set dynamic array field's length field: "
2380 "msg-it-addr=%p, field-addr=%p, "
2381 "length=%" PRIu64
, msg_it
, seq_field
, length
);
2391 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2392 struct ctf_field_class
*fc
, void *data
)
2396 int64_t option_index
= -1;
2397 struct ctf_msg_iter
*msg_it
= data
;
2398 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2399 struct ctf_named_field_class
*selected_option
= NULL
;
2400 bt_self_component
*self_comp
= msg_it
->self_comp
;
2401 struct ctf_field_class
*ret_fc
= NULL
;
2407 /* Get variant's tag */
2408 tag
.u
= g_array_index(msg_it
->stored_values
, uint64_t,
2409 var_fc
->stored_tag_index
);
2412 * Check each range to find the selected option's index.
2414 if (var_fc
->tag_fc
->base
.is_signed
) {
2415 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2416 struct ctf_field_class_variant_range
*range
=
2417 ctf_field_class_variant_borrow_range_by_index(
2420 if (tag
.i
>= range
->range
.lower
.i
&&
2421 tag
.i
<= range
->range
.upper
.i
) {
2422 option_index
= (int64_t) range
->option_index
;
2427 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2428 struct ctf_field_class_variant_range
*range
=
2429 ctf_field_class_variant_borrow_range_by_index(
2432 if (tag
.u
>= range
->range
.lower
.u
&&
2433 tag
.u
<= range
->range
.upper
.u
) {
2434 option_index
= (int64_t) range
->option_index
;
2440 if (option_index
< 0) {
2441 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2442 "Cannot find variant field class's option: "
2443 "msg-it-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2444 "i-tag=%" PRId64
, msg_it
, var_fc
, tag
.u
, tag
.i
);
2449 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2450 var_fc
, (uint64_t) option_index
);
2452 if (selected_option
->fc
->in_ir
&& !msg_it
->dry_run
) {
2453 bt_field
*var_field
= stack_top(msg_it
->stack
)->base
;
2455 ret
= bt_field_variant_select_option_by_index(
2456 var_field
, option_index
);
2458 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2459 "Cannot select variant field's option field: "
2460 "msg-it-addr=%p, var-field-addr=%p, "
2461 "opt-index=%" PRId64
, msg_it
, var_field
,
2468 ret_fc
= selected_option
->fc
;
2475 bt_message
*create_msg_stream_beginning(struct ctf_msg_iter
*msg_it
)
2477 bt_self_component
*self_comp
= msg_it
->self_comp
;
2480 BT_ASSERT(msg_it
->stream
);
2481 BT_ASSERT(msg_it
->self_msg_iter
);
2482 msg
= bt_message_stream_beginning_create(msg_it
->self_msg_iter
,
2485 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2486 "Cannot create stream beginning message: "
2487 "msg-it-addr=%p, stream-addr=%p",
2488 msg_it
, msg_it
->stream
);
2495 bt_message
*create_msg_stream_end(struct ctf_msg_iter
*msg_it
)
2497 bt_self_component
*self_comp
= msg_it
->self_comp
;
2500 if (!msg_it
->stream
) {
2501 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2502 "Cannot create stream end message because stream is NULL: "
2503 "msg-it-addr=%p", msg_it
);
2508 BT_ASSERT(msg_it
->self_msg_iter
);
2509 msg
= bt_message_stream_end_create(msg_it
->self_msg_iter
,
2512 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2513 "Cannot create stream end message: "
2514 "msg-it-addr=%p, stream-addr=%p",
2515 msg_it
, msg_it
->stream
);
2523 bt_message
*create_msg_packet_beginning(struct ctf_msg_iter
*msg_it
,
2524 bool use_default_cs
)
2526 bt_self_component
*self_comp
= msg_it
->self_comp
;
2528 const bt_stream_class
*sc
= msg_it
->meta
.sc
->ir_sc
;
2530 BT_ASSERT(msg_it
->packet
);
2532 BT_ASSERT(msg_it
->self_msg_iter
);
2534 if (msg_it
->meta
.sc
->packets_have_ts_begin
) {
2535 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2536 uint64_t raw_cs_value
;
2539 * Either use the decoded packet `timestamp_begin` field or the
2540 * current stream's default clock_snapshot.
2542 if (use_default_cs
) {
2543 raw_cs_value
= msg_it
->default_clock_snapshot
;
2545 raw_cs_value
= msg_it
->snapshots
.beginning_clock
;
2548 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2549 msg_it
->self_msg_iter
, msg_it
->packet
,
2552 msg
= bt_message_packet_beginning_create(msg_it
->self_msg_iter
,
2557 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2558 "Cannot create packet beginning message: "
2559 "msg-it-addr=%p, packet-addr=%p",
2560 msg_it
, msg_it
->packet
);
2569 bt_message
*emit_delayed_packet_beg_msg(struct ctf_msg_iter
*msg_it
)
2571 bool packet_beg_ts_need_fix_up
;
2573 msg_it
->emit_delayed_packet_beginning_msg
= false;
2576 * Only fix the packet's timestamp_begin if it's larger than the first
2577 * event of the packet. If there was no event in the packet, the
2578 * `default_clock_snapshot` field will be either equal or greater than
2579 * `snapshots.beginning_clock` so there is not fix needed.
2581 packet_beg_ts_need_fix_up
=
2582 msg_it
->default_clock_snapshot
< msg_it
->snapshots
.beginning_clock
;
2584 /* create_msg_packet_beginning() logs errors */
2585 return create_msg_packet_beginning(msg_it
, packet_beg_ts_need_fix_up
);
2590 bt_message
*create_msg_packet_end(struct ctf_msg_iter
*msg_it
)
2593 bool update_default_cs
= true;
2594 bt_self_component
*self_comp
= msg_it
->self_comp
;
2596 if (!msg_it
->packet
) {
2602 * Check if we need to emit the delayed packet
2603 * beginning message instead of the packet end message.
2605 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2606 msg
= emit_delayed_packet_beg_msg(msg_it
);
2607 /* Don't forget to emit the packet end message. */
2608 msg_it
->state
= STATE_EMIT_QUEUED_MSG_PACKET_END
;
2612 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2613 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.lttng_crash
)) {
2615 * Check if the `timestamp_begin` field is non-zero but
2616 * `timestamp_end` is zero. It means the trace is affected by
2617 * the lttng-crash packet `timestamp_end` quirk and must be
2618 * fixed up by omitting to update the default clock snapshot to
2619 * the `timestamp_end` as is typically done.
2621 if (msg_it
->snapshots
.beginning_clock
!= 0 &&
2622 msg_it
->snapshots
.end_clock
== 0) {
2623 update_default_cs
= false;
2628 * Check if may be affected by lttng event-after-packet `timestamp_end`
2631 if (msg_it
->meta
.tc
->quirks
.lttng_event_after_packet
) {
2633 * Check if `timestamp_end` is smaller then the current
2634 * default_clock_snapshot (which is set to the last event
2635 * decoded). It means the trace is affected by the lttng
2636 * `event-after-packet` packet `timestamp_end` quirk and must
2637 * be fixed up by omitting to update the default clock snapshot
2638 * to the `timestamp_end` as is typically done.
2640 if (msg_it
->snapshots
.end_clock
< msg_it
->default_clock_snapshot
) {
2641 update_default_cs
= false;
2645 /* Update default clock from packet's end time. */
2646 if (msg_it
->snapshots
.end_clock
!= UINT64_C(-1) && update_default_cs
) {
2647 msg_it
->default_clock_snapshot
= msg_it
->snapshots
.end_clock
;
2650 BT_ASSERT(msg_it
->self_msg_iter
);
2652 if (msg_it
->meta
.sc
->packets_have_ts_end
) {
2653 BT_ASSERT(msg_it
->snapshots
.end_clock
!= UINT64_C(-1));
2654 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2655 msg_it
->self_msg_iter
, msg_it
->packet
,
2656 msg_it
->default_clock_snapshot
);
2658 msg
= bt_message_packet_end_create(msg_it
->self_msg_iter
,
2663 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2664 "Cannot create packet end message: "
2665 "msg-it-addr=%p, packet-addr=%p",
2666 msg_it
, msg_it
->packet
);
2671 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2678 bt_message
*create_msg_discarded_events(struct ctf_msg_iter
*msg_it
)
2681 bt_self_component
*self_comp
= msg_it
->self_comp
;
2682 uint64_t beginning_raw_value
= UINT64_C(-1);
2683 uint64_t end_raw_value
= UINT64_C(-1);
2685 BT_ASSERT(msg_it
->self_msg_iter
);
2686 BT_ASSERT(msg_it
->stream
);
2687 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_events
);
2689 if (msg_it
->meta
.sc
->discarded_events_have_default_cs
) {
2690 if (msg_it
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2692 * We discarded events, but before (and possibly
2693 * including) the current packet: use this packet's time
2694 * range, and do not have a specific count.
2696 beginning_raw_value
= msg_it
->snapshots
.beginning_clock
;
2697 end_raw_value
= msg_it
->snapshots
.end_clock
;
2699 beginning_raw_value
= msg_it
->prev_packet_snapshots
.end_clock
;
2700 end_raw_value
= msg_it
->snapshots
.end_clock
;
2703 BT_ASSERT(beginning_raw_value
!= UINT64_C(-1));
2704 BT_ASSERT(end_raw_value
!= UINT64_C(-1));
2705 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2706 msg_it
->self_msg_iter
, msg_it
->stream
, beginning_raw_value
,
2709 msg
= bt_message_discarded_events_create(msg_it
->self_msg_iter
,
2714 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2715 "Cannot create discarded events message: "
2716 "msg-it-addr=%p, stream-addr=%p",
2717 msg_it
, msg_it
->stream
);
2721 if (msg_it
->prev_packet_snapshots
.discarded_events
!= UINT64_C(-1)) {
2722 bt_message_discarded_events_set_count(msg
,
2723 msg_it
->snapshots
.discarded_events
-
2724 msg_it
->prev_packet_snapshots
.discarded_events
);
2732 bt_message
*create_msg_discarded_packets(struct ctf_msg_iter
*msg_it
)
2735 bt_self_component
*self_comp
= msg_it
->self_comp
;
2737 BT_ASSERT(msg_it
->self_msg_iter
);
2738 BT_ASSERT(msg_it
->stream
);
2739 BT_ASSERT(msg_it
->meta
.sc
->has_discarded_packets
);
2740 BT_ASSERT(msg_it
->prev_packet_snapshots
.packets
!=
2743 if (msg_it
->meta
.sc
->discarded_packets_have_default_cs
) {
2744 BT_ASSERT(msg_it
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1));
2745 BT_ASSERT(msg_it
->snapshots
.beginning_clock
!= UINT64_C(-1));
2746 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2747 msg_it
->self_msg_iter
, msg_it
->stream
,
2748 msg_it
->prev_packet_snapshots
.end_clock
,
2749 msg_it
->snapshots
.beginning_clock
);
2751 msg
= bt_message_discarded_packets_create(msg_it
->self_msg_iter
,
2756 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2757 "Cannot create discarded packets message: "
2758 "msg-it-addr=%p, stream-addr=%p",
2759 msg_it
, msg_it
->stream
);
2763 bt_message_discarded_packets_set_count(msg
,
2764 msg_it
->snapshots
.packets
-
2765 msg_it
->prev_packet_snapshots
.packets
- 1);
2772 struct ctf_msg_iter
*ctf_msg_iter_create(
2773 struct ctf_trace_class
*tc
,
2774 size_t max_request_sz
,
2775 struct ctf_msg_iter_medium_ops medops
, void *data
,
2776 bt_logging_level log_level
,
2777 bt_self_component
*self_comp
,
2778 bt_self_message_iterator
*self_msg_iter
)
2780 struct ctf_msg_iter
*msg_it
= NULL
;
2781 struct bt_bfcr_cbs cbs
= {
2783 .signed_int
= bfcr_signed_int_cb
,
2784 .unsigned_int
= bfcr_unsigned_int_cb
,
2785 .floating_point
= bfcr_floating_point_cb
,
2786 .string_begin
= bfcr_string_begin_cb
,
2787 .string
= bfcr_string_cb
,
2788 .string_end
= bfcr_string_end_cb
,
2789 .compound_begin
= bfcr_compound_begin_cb
,
2790 .compound_end
= bfcr_compound_end_cb
,
2793 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2794 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2799 BT_ASSERT(medops
.request_bytes
);
2800 BT_ASSERT(medops
.borrow_stream
);
2801 BT_ASSERT(max_request_sz
> 0);
2803 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, log_level
, self_comp
,
2804 "Creating CTF plugin message iterator: "
2805 "trace-addr=%p, max-request-size=%zu, "
2806 "data=%p, log-level=%s", tc
, max_request_sz
, data
,
2807 bt_common_logging_level_string(log_level
));
2808 msg_it
= g_new0(struct ctf_msg_iter
, 1);
2810 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2811 "Failed to allocate one CTF plugin message iterator.");
2814 msg_it
->self_comp
= self_comp
;
2815 msg_it
->self_msg_iter
= self_msg_iter
;
2816 msg_it
->log_level
= log_level
;
2817 msg_it
->meta
.tc
= tc
;
2818 msg_it
->medium
.medops
= medops
;
2819 msg_it
->medium
.max_request_sz
= max_request_sz
;
2820 msg_it
->medium
.data
= data
;
2821 msg_it
->stack
= stack_new(msg_it
);
2822 msg_it
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2823 g_array_set_size(msg_it
->stored_values
, tc
->stored_value_count
);
2825 if (!msg_it
->stack
) {
2826 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2827 "Failed to create field stack.");
2831 msg_it
->bfcr
= bt_bfcr_create(cbs
, msg_it
, log_level
, NULL
);
2832 if (!msg_it
->bfcr
) {
2833 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2834 "Failed to create binary class reader (BFCR).");
2838 ctf_msg_iter_reset(msg_it
);
2839 BT_COMP_LOGD("Created CTF plugin message iterator: "
2840 "trace-addr=%p, max-request-size=%zu, "
2841 "data=%p, msg-it-addr=%p, log-level=%s",
2842 tc
, max_request_sz
, data
, msg_it
,
2843 bt_common_logging_level_string(log_level
));
2844 msg_it
->cur_packet_offset
= 0;
2850 ctf_msg_iter_destroy(msg_it
);
2855 void ctf_msg_iter_destroy(struct ctf_msg_iter
*msg_it
)
2857 BT_PACKET_PUT_REF_AND_RESET(msg_it
->packet
);
2858 BT_STREAM_PUT_REF_AND_RESET(msg_it
->stream
);
2859 release_all_dscopes(msg_it
);
2861 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", msg_it
);
2863 if (msg_it
->stack
) {
2864 BT_COMP_LOGD_STR("Destroying field stack.");
2865 stack_destroy(msg_it
->stack
);
2869 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", msg_it
->bfcr
);
2870 bt_bfcr_destroy(msg_it
->bfcr
);
2873 if (msg_it
->stored_values
) {
2874 g_array_free(msg_it
->stored_values
, TRUE
);
2880 enum ctf_msg_iter_status
ctf_msg_iter_get_next_message(
2881 struct ctf_msg_iter
*msg_it
,
2882 const bt_message
**message
)
2884 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
2885 bt_self_component
*self_comp
= msg_it
->self_comp
;
2887 BT_ASSERT_DBG(msg_it
);
2888 BT_ASSERT_DBG(message
);
2889 BT_COMP_LOGD("Getting next message: msg-it-addr=%p", msg_it
);
2892 status
= handle_state(msg_it
);
2893 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
2894 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
2896 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
2897 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2898 "Cannot handle state: msg-it-addr=%p, state=%s",
2899 msg_it
, state_string(msg_it
->state
));
2903 switch (msg_it
->state
) {
2904 case STATE_EMIT_MSG_EVENT
:
2905 BT_ASSERT_DBG(msg_it
->event_msg
);
2908 * Check if we need to emit the delayed packet
2909 * beginning message instead of the event message.
2911 if (G_UNLIKELY(msg_it
->emit_delayed_packet_beginning_msg
)) {
2912 *message
= emit_delayed_packet_beg_msg(msg_it
);
2914 status
= CTF_MSG_ITER_STATUS_ERROR
;
2918 * Don't forget to emit the event message of
2919 * the event record that was just decoded.
2921 msg_it
->state
= STATE_EMIT_QUEUED_MSG_EVENT
;
2924 *message
= msg_it
->event_msg
;
2925 msg_it
->event_msg
= NULL
;
2928 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2929 /* create_msg_discared_events() logs errors */
2930 *message
= create_msg_discarded_events(msg_it
);
2933 status
= CTF_MSG_ITER_STATUS_ERROR
;
2937 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2938 /* create_msg_discared_packets() logs errors */
2939 *message
= create_msg_discarded_packets(msg_it
);
2942 status
= CTF_MSG_ITER_STATUS_ERROR
;
2946 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2947 if (G_UNLIKELY(msg_it
->meta
.tc
->quirks
.barectf_event_before_packet
)) {
2948 msg_it
->emit_delayed_packet_beginning_msg
= true;
2950 * There is no message to return yet as this
2951 * packet beginning message is delayed until we
2952 * decode the first event message of the
2957 /* create_msg_packet_beginning() logs errors */
2958 *message
= create_msg_packet_beginning(msg_it
, false);
2960 status
= CTF_MSG_ITER_STATUS_ERROR
;
2965 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2966 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2967 /* create_msg_packet_end() logs errors */
2968 *message
= create_msg_packet_end(msg_it
);
2971 status
= CTF_MSG_ITER_STATUS_ERROR
;
2975 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2976 /* create_msg_stream_beginning() logs errors */
2977 *message
= create_msg_stream_beginning(msg_it
);
2978 msg_it
->emit_stream_beginning_message
= false;
2979 msg_it
->emit_stream_end_message
= true;
2982 status
= CTF_MSG_ITER_STATUS_ERROR
;
2986 case STATE_EMIT_MSG_STREAM_END
:
2987 /* create_msg_stream_end() logs errors */
2988 *message
= create_msg_stream_end(msg_it
);
2989 msg_it
->emit_stream_end_message
= false;
2992 status
= CTF_MSG_ITER_STATUS_ERROR
;
2997 status
= CTF_MSG_ITER_STATUS_EOF
;
3000 /* Non-emitting state: continue */
3010 enum ctf_msg_iter_status
decode_until_state( struct ctf_msg_iter
*msg_it
,
3011 enum state target_state_1
, enum state target_state_2
)
3013 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3014 bt_self_component
*self_comp
= msg_it
->self_comp
;
3016 BT_ASSERT_DBG(msg_it
);
3020 * Check if we reached the state at which we want to stop
3023 if (msg_it
->state
== target_state_1
||
3024 msg_it
->state
== target_state_2
) {
3028 status
= handle_state(msg_it
);
3029 if (G_UNLIKELY(status
== CTF_MSG_ITER_STATUS_AGAIN
)) {
3030 BT_COMP_LOGD_STR("Medium returned CTF_MSG_ITER_STATUS_AGAIN.");
3032 } else if (G_UNLIKELY(status
!= CTF_MSG_ITER_STATUS_OK
)) {
3033 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
3034 "Cannot handle state: msg-it-addr=%p, state=%s",
3035 msg_it
, state_string(msg_it
->state
));
3039 switch (msg_it
->state
) {
3041 case STATE_SWITCH_PACKET
:
3042 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
3043 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
3044 case STATE_AFTER_TRACE_PACKET_HEADER
:
3045 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
3046 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
3047 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
3048 case STATE_EMIT_MSG_STREAM_BEGINNING
:
3049 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
3050 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
3051 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
3052 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
3053 case STATE_EMIT_MSG_PACKET_BEGINNING
:
3054 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
3055 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
3056 case STATE_AFTER_EVENT_HEADER
:
3057 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
3058 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
3059 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
3060 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
3061 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
3062 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
3063 case STATE_EMIT_MSG_EVENT
:
3064 case STATE_EMIT_QUEUED_MSG_EVENT
:
3065 case STATE_SKIP_PACKET_PADDING
:
3066 case STATE_EMIT_MSG_PACKET_END_MULTI
:
3067 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
3068 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
3069 case STATE_EMIT_MSG_STREAM_END
:
3074 /* We should never get to the STATE_DONE state. */
3075 BT_COMP_LOGF("Unexpected state: msg-it-addr=%p, state=%s",
3076 msg_it
, state_string(msg_it
->state
));
3086 enum ctf_msg_iter_status
read_packet_header_context_fields(
3087 struct ctf_msg_iter
*msg_it
)
3090 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3092 status
= decode_until_state(msg_it
, STATE_EMIT_MSG_PACKET_BEGINNING
, -1);
3093 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3097 ret
= set_current_packet_content_sizes(msg_it
);
3099 status
= CTF_MSG_ITER_STATUS_ERROR
;
3108 enum ctf_msg_iter_status
ctf_msg_iter_seek(struct ctf_msg_iter
*msg_it
,
3111 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3112 enum ctf_msg_iter_medium_status medium_status
;
3115 BT_ASSERT(offset
>= 0);
3116 BT_ASSERT(msg_it
->medium
.medops
.seek
);
3118 medium_status
= msg_it
->medium
.medops
.seek(offset
, msg_it
->medium
.data
);
3119 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
3120 if (medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_EOF
) {
3121 status
= CTF_MSG_ITER_STATUS_EOF
;
3123 status
= CTF_MSG_ITER_STATUS_ERROR
;
3128 ctf_msg_iter_reset(msg_it
);
3129 msg_it
->cur_packet_offset
= offset
;
3136 enum ctf_msg_iter_status
clock_snapshot_at_msg_iter_state(
3137 struct ctf_msg_iter
*msg_it
, enum state target_state_1
,
3138 enum state target_state_2
, uint64_t *clock_snapshot
)
3140 enum ctf_msg_iter_status status
= CTF_MSG_ITER_STATUS_OK
;
3142 BT_ASSERT_DBG(msg_it
);
3143 BT_ASSERT_DBG(clock_snapshot
);
3144 status
= decode_until_state(msg_it
, target_state_1
, target_state_2
);
3145 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3149 *clock_snapshot
= msg_it
->default_clock_snapshot
;
3155 enum ctf_msg_iter_status
ctf_msg_iter_curr_packet_first_event_clock_snapshot(
3156 struct ctf_msg_iter
*msg_it
, uint64_t *first_clock_snapshot
)
3158 return clock_snapshot_at_msg_iter_state(msg_it
,
3159 STATE_AFTER_EVENT_HEADER
, -1, first_clock_snapshot
);
3163 enum ctf_msg_iter_status
ctf_msg_iter_curr_packet_last_event_clock_snapshot(
3164 struct ctf_msg_iter
*msg_it
, uint64_t *last_clock_snapshot
)
3166 return clock_snapshot_at_msg_iter_state(msg_it
,
3167 STATE_EMIT_MSG_PACKET_END_SINGLE
,
3168 STATE_EMIT_MSG_PACKET_END_MULTI
, last_clock_snapshot
);
3172 enum ctf_msg_iter_status
ctf_msg_iter_get_packet_properties(
3173 struct ctf_msg_iter
*msg_it
,
3174 struct ctf_msg_iter_packet_properties
*props
)
3176 enum ctf_msg_iter_status status
;
3178 BT_ASSERT_DBG(msg_it
);
3179 BT_ASSERT_DBG(props
);
3180 status
= read_packet_header_context_fields(msg_it
);
3181 if (status
!= CTF_MSG_ITER_STATUS_OK
) {
3185 props
->exp_packet_total_size
= msg_it
->cur_exp_packet_total_size
;
3186 props
->exp_packet_content_size
= msg_it
->cur_exp_packet_content_size
;
3187 props
->stream_class_id
= (uint64_t) msg_it
->cur_stream_class_id
;
3188 props
->data_stream_id
= msg_it
->cur_data_stream_id
;
3189 props
->snapshots
.discarded_events
= msg_it
->snapshots
.discarded_events
;
3190 props
->snapshots
.packets
= msg_it
->snapshots
.packets
;
3191 props
->snapshots
.beginning_clock
= msg_it
->snapshots
.beginning_clock
;
3192 props
->snapshots
.end_clock
= msg_it
->snapshots
.end_clock
;
3199 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter
*msg_it
,
3202 msg_it
->dry_run
= val
;