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 (notit->self_comp)
27 #define BT_LOG_OUTPUT_LEVEL (notit->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 bt_msg_iter
*notit
;
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_CHECK_EMIT_MSG_STREAM_BEGINNING
,
91 STATE_EMIT_MSG_STREAM_BEGINNING
,
92 STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
,
93 STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
,
94 STATE_EMIT_MSG_DISCARDED_EVENTS
,
95 STATE_EMIT_MSG_DISCARDED_PACKETS
,
96 STATE_EMIT_MSG_PACKET_BEGINNING
,
97 STATE_DSCOPE_EVENT_HEADER_BEGIN
,
98 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
99 STATE_AFTER_EVENT_HEADER
,
100 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
,
101 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
102 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
103 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
104 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
105 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
106 STATE_EMIT_MSG_EVENT
,
107 STATE_EMIT_QUEUED_MSG_EVENT
,
108 STATE_SKIP_PACKET_PADDING
,
109 STATE_EMIT_MSG_PACKET_END_MULTI
,
110 STATE_EMIT_MSG_PACKET_END_SINGLE
,
111 STATE_CHECK_EMIT_MSG_STREAM_END
,
112 STATE_EMIT_QUEUED_MSG_PACKET_END
,
113 STATE_EMIT_MSG_STREAM_END
,
117 struct end_of_packet_snapshots
{
118 uint64_t discarded_events
;
120 uint64_t beginning_clock
;
124 /* CTF message iterator */
129 /* Current message iterator to create messages (weak) */
130 bt_self_message_iterator
*msg_iter
;
132 /* True to emit a stream beginning message. */
133 bool emit_stream_begin_msg
;
135 /* True to emit a stream end message. */
136 bool emit_stream_end_msg
;
139 * True if library objects are unavailable during the decoding and
140 * should not be created/used.
144 /* True to set the stream */
148 * Current dynamic scope field pointer.
150 * This is set by read_dscope_begin_state() and contains the
151 * value of one of the pointers in `dscopes` below.
153 bt_field
*cur_dscope_field
;
156 * True if we're done filling a string field from a text
157 * array/sequence payload.
159 bool done_filling_string
;
161 /* Trace and classes */
162 /* True to set IR fields */
166 struct ctf_trace_class
*tc
;
167 struct ctf_stream_class
*sc
;
168 struct ctf_event_class
*ec
;
171 /* Current packet context field wrapper (NULL if not created yet) */
172 bt_packet_context_field
*packet_context_field
;
174 /* Current packet (NULL if not created yet) */
177 /* Current stream (NULL if not set yet) */
180 /* Current event (NULL if not created yet) */
183 /* Current event message (NULL if not created yet) */
184 bt_message
*event_msg
;
187 * True if we need to emit a packet beginning message before we emit
188 * the next event message or the packet end message.
190 bool emit_delayed_packet_beginning_msg
;
192 /* Database of current dynamic scopes */
194 bt_field
*stream_packet_context
;
195 bt_field
*event_common_context
;
196 bt_field
*event_spec_context
;
197 bt_field
*event_payload
;
203 /* Current medium buffer data */
205 /* Last address provided by medium */
208 /* Buffer size provided by medium (bytes) */
211 /* Offset within whole packet of addr (bits) */
212 size_t packet_offset
;
214 /* Current position from addr (bits) */
217 /* Position of the last event header from addr (bits) */
221 /* Binary type reader */
222 struct bt_bfcr
*bfcr
;
224 /* Current medium data */
226 struct bt_msg_iter_medium_ops medops
;
227 size_t max_request_sz
;
231 /* Current packet size (bits) (-1 if unknown) */
232 int64_t cur_exp_packet_total_size
;
234 /* Current content size (bits) (-1 if unknown) */
235 int64_t cur_exp_packet_content_size
;
237 /* Current stream class ID */
238 int64_t cur_stream_class_id
;
240 /* Current event class ID */
241 int64_t cur_event_class_id
;
243 /* Current data stream ID */
244 int64_t cur_data_stream_id
;
247 * Offset, in the underlying media, of the current packet's
248 * start (-1 if unknown).
250 off_t cur_packet_offset
;
252 /* Default clock's current value */
253 uint64_t default_clock_snapshot
;
255 /* End of current packet snapshots */
256 struct end_of_packet_snapshots snapshots
;
258 /* End of previous packet snapshots */
259 struct end_of_packet_snapshots prev_packet_snapshots
;
261 /* Stored values (for sequence lengths, variant tags) */
262 GArray
*stored_values
;
264 /* Iterator's current log level */
265 bt_logging_level log_level
;
267 /* Iterator's owning self component, or `NULL` if none (query) */
268 bt_self_component
*self_comp
;
272 const char *state_string(enum state state
)
277 case STATE_SWITCH_PACKET
:
278 return "SWITCH_PACKET";
279 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
280 return "DSCOPE_TRACE_PACKET_HEADER_BEGIN";
281 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
282 return "DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
283 case STATE_AFTER_TRACE_PACKET_HEADER
:
284 return "AFTER_TRACE_PACKET_HEADER";
285 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
286 return "DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
287 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
288 return "DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
289 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
290 return "AFTER_STREAM_PACKET_CONTEXT";
291 case STATE_EMIT_MSG_STREAM_BEGINNING
:
292 return "EMIT_MSG_STREAM_BEGINNING";
293 case STATE_EMIT_MSG_PACKET_BEGINNING
:
294 return "EMIT_MSG_PACKET_BEGINNING";
295 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
296 return "EMIT_MSG_DISCARDED_EVENTS";
297 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
298 return "EMIT_MSG_DISCARDED_PACKETS";
299 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
300 return "DSCOPE_EVENT_HEADER_BEGIN";
301 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
302 return "DSCOPE_EVENT_HEADER_CONTINUE";
303 case STATE_AFTER_EVENT_HEADER
:
304 return "AFTER_EVENT_HEADER";
305 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
306 return "DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
307 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
308 return "DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
309 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
310 return "DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
311 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
312 return "DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
313 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
314 return "DSCOPE_EVENT_PAYLOAD_BEGIN";
315 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
316 return "DSCOPE_EVENT_PAYLOAD_CONTINUE";
317 case STATE_EMIT_MSG_EVENT
:
318 return "EMIT_MSG_EVENT";
319 case STATE_EMIT_QUEUED_MSG_EVENT
:
320 return "EMIT_QUEUED_MSG_EVENT";
321 case STATE_SKIP_PACKET_PADDING
:
322 return "SKIP_PACKET_PADDING";
323 case STATE_EMIT_MSG_PACKET_END_MULTI
:
324 return "EMIT_MSG_PACKET_END_MULTI";
325 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
326 return "EMIT_MSG_PACKET_END_SINGLE";
327 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
328 return "EMIT_QUEUED_MSG_PACKET_END";
329 case STATE_EMIT_MSG_STREAM_END
:
330 return "EMIT_MSG_STREAM_END";
339 struct stack
*stack_new(struct bt_msg_iter
*notit
)
341 struct stack
*stack
= NULL
;
343 stack
= g_new0(struct stack
, 1);
345 BT_COMP_LOGE_STR("Failed to allocate one stack.");
349 stack
->notit
= notit
;
350 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
351 if (!stack
->entries
) {
352 BT_COMP_LOGE_STR("Failed to allocate a GArray.");
356 BT_COMP_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit
, stack
);
368 void stack_destroy(struct stack
*stack
)
370 struct bt_msg_iter
*notit
;
372 BT_ASSERT_DBG(stack
);
373 notit
= stack
->notit
;
374 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
376 if (stack
->entries
) {
377 g_array_free(stack
->entries
, TRUE
);
384 void stack_push(struct stack
*stack
, bt_field
*base
)
386 struct stack_entry
*entry
;
387 struct bt_msg_iter
*notit
;
389 BT_ASSERT_DBG(stack
);
390 notit
= stack
->notit
;
392 BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, "
393 "stack-size-before=%zu, stack-size-after=%zu",
394 stack
, stack
->size
, stack
->size
+ 1);
396 if (stack
->entries
->len
== stack
->size
) {
397 g_array_set_size(stack
->entries
, stack
->size
+ 1);
400 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
407 unsigned int stack_size(struct stack
*stack
)
409 BT_ASSERT_DBG(stack
);
414 void stack_pop(struct stack
*stack
)
416 struct bt_msg_iter
*notit
;
418 BT_ASSERT_DBG(stack
);
419 BT_ASSERT_DBG(stack_size(stack
));
420 notit
= stack
->notit
;
421 BT_COMP_LOGT("Popping from stack: "
422 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
423 stack
, stack
->size
, stack
->size
- 1);
428 struct stack_entry
*stack_top(struct stack
*stack
)
430 BT_ASSERT_DBG(stack
);
431 BT_ASSERT_DBG(stack_size(stack
));
432 return &g_array_index(stack
->entries
, struct stack_entry
,
437 bool stack_empty(struct stack
*stack
)
439 return stack_size(stack
) == 0;
443 void stack_clear(struct stack
*stack
)
445 BT_ASSERT_DBG(stack
);
450 enum bt_msg_iter_status
msg_iter_status_from_m_status(
451 enum bt_msg_iter_medium_status m_status
)
453 /* They are the same */
454 return (int) m_status
;
458 size_t buf_size_bits(struct bt_msg_iter
*notit
)
460 return notit
->buf
.sz
* 8;
464 size_t buf_available_bits(struct bt_msg_iter
*notit
)
466 return buf_size_bits(notit
) - notit
->buf
.at
;
470 size_t packet_at(struct bt_msg_iter
*notit
)
472 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
476 void buf_consume_bits(struct bt_msg_iter
*notit
, size_t incr
)
478 BT_COMP_LOGT("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
479 notit
, notit
->buf
.at
, notit
->buf
.at
+ incr
);
480 notit
->buf
.at
+= incr
;
484 enum bt_msg_iter_status
request_medium_bytes(
485 struct bt_msg_iter
*notit
)
487 uint8_t *buffer_addr
= NULL
;
488 size_t buffer_sz
= 0;
489 enum bt_msg_iter_medium_status m_status
;
491 BT_COMP_LOGD("Calling user function (request bytes): notit-addr=%p, "
492 "request-size=%zu", notit
, notit
->medium
.max_request_sz
);
493 m_status
= notit
->medium
.medops
.request_bytes(
494 notit
->medium
.max_request_sz
, &buffer_addr
,
495 &buffer_sz
, notit
->medium
.data
);
496 BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
497 bt_msg_iter_medium_status_string(m_status
),
498 buffer_addr
, buffer_sz
);
499 if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_OK
) {
500 BT_ASSERT(buffer_sz
!= 0);
502 /* New packet offset is old one + old size (in bits) */
503 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
505 /* Restart at the beginning of the new medium buffer */
507 notit
->buf
.last_eh_at
= SIZE_MAX
;
509 /* New medium buffer size */
510 notit
->buf
.sz
= buffer_sz
;
512 /* New medium buffer address */
513 notit
->buf
.addr
= buffer_addr
;
515 BT_COMP_LOGD("User function returned new bytes: "
516 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
517 notit
->buf
.packet_offset
, notit
->buf
.at
,
518 notit
->buf
.sz
, notit
->buf
.addr
);
519 BT_COMP_LOGD_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
521 } else if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
523 * User returned end of stream: validate that we're not
524 * in the middle of a packet header, packet context, or
527 if (notit
->cur_exp_packet_total_size
>= 0) {
528 if (packet_at(notit
) ==
529 notit
->cur_exp_packet_total_size
) {
533 if (packet_at(notit
) == 0) {
537 if (notit
->buf
.last_eh_at
!= SIZE_MAX
&&
538 notit
->buf
.at
== notit
->buf
.last_eh_at
) {
543 /* All other states are invalid */
544 BT_COMP_LOGW("User function returned %s, but message iterator is in an unexpected state: "
545 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
546 "packet-cur=%zu, last-eh-at=%zu",
547 bt_msg_iter_medium_status_string(m_status
),
548 state_string(notit
->state
),
549 notit
->cur_exp_packet_total_size
,
550 notit
->buf
.at
, packet_at(notit
),
551 notit
->buf
.last_eh_at
);
552 m_status
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
553 } else if (m_status
< 0) {
554 BT_COMP_LOGW("User function failed: status=%s",
555 bt_msg_iter_medium_status_string(m_status
));
559 return msg_iter_status_from_m_status(m_status
);
563 enum bt_msg_iter_status
buf_ensure_available_bits(
564 struct bt_msg_iter
*notit
)
566 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
568 if (G_UNLIKELY(buf_available_bits(notit
) == 0)) {
570 * This _cannot_ return BT_MSG_ITER_STATUS_OK
573 status
= request_medium_bytes(notit
);
580 enum bt_msg_iter_status
read_dscope_begin_state(
581 struct bt_msg_iter
*notit
,
582 struct ctf_field_class
*dscope_fc
,
583 enum state done_state
, enum state continue_state
,
584 bt_field
*dscope_field
)
586 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
587 enum bt_bfcr_status bfcr_status
;
588 size_t consumed_bits
;
590 notit
->cur_dscope_field
= dscope_field
;
591 BT_COMP_LOGT("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
592 notit
, notit
->bfcr
, dscope_fc
);
593 consumed_bits
= bt_bfcr_start(notit
->bfcr
, dscope_fc
,
594 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
595 notit
->buf
.sz
, &bfcr_status
);
596 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
598 switch (bfcr_status
) {
599 case BT_BFCR_STATUS_OK
:
600 /* Field class was read completely */
601 BT_COMP_LOGT_STR("Field was completely decoded.");
602 notit
->state
= done_state
;
604 case BT_BFCR_STATUS_EOF
:
605 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
606 notit
->state
= continue_state
;
609 BT_COMP_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
610 "status=%s", notit
, notit
->bfcr
,
611 bt_bfcr_status_string(bfcr_status
));
612 status
= BT_MSG_ITER_STATUS_ERROR
;
616 /* Consume bits now since we know we're not in an error state */
617 buf_consume_bits(notit
, consumed_bits
);
624 enum bt_msg_iter_status
read_dscope_continue_state(
625 struct bt_msg_iter
*notit
, enum state done_state
)
627 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
628 enum bt_bfcr_status bfcr_status
;
629 size_t consumed_bits
;
631 BT_COMP_LOGT("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
634 status
= buf_ensure_available_bits(notit
);
635 if (status
!= BT_MSG_ITER_STATUS_OK
) {
637 BT_COMP_LOGW("Cannot ensure that buffer has at least one byte: "
638 "msg-addr=%p, status=%s",
639 notit
, bt_msg_iter_status_string(status
));
641 BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: "
642 "msg-addr=%p, status=%s",
643 notit
, bt_msg_iter_status_string(status
));
649 consumed_bits
= bt_bfcr_continue(notit
->bfcr
, notit
->buf
.addr
,
650 notit
->buf
.sz
, &bfcr_status
);
651 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
653 switch (bfcr_status
) {
654 case BT_BFCR_STATUS_OK
:
655 /* Type was read completely. */
656 BT_COMP_LOGT_STR("Field was completely decoded.");
657 notit
->state
= done_state
;
659 case BT_BFCR_STATUS_EOF
:
660 /* Stay in this continue state. */
661 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
664 BT_COMP_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
665 "status=%s", notit
, notit
->bfcr
,
666 bt_bfcr_status_string(bfcr_status
));
667 status
= BT_MSG_ITER_STATUS_ERROR
;
671 /* Consume bits now since we know we're not in an error state. */
672 buf_consume_bits(notit
, consumed_bits
);
678 void release_event_dscopes(struct bt_msg_iter
*notit
)
680 notit
->dscopes
.event_common_context
= NULL
;
681 notit
->dscopes
.event_spec_context
= NULL
;
682 notit
->dscopes
.event_payload
= NULL
;
686 void release_all_dscopes(struct bt_msg_iter
*notit
)
688 notit
->dscopes
.stream_packet_context
= NULL
;
690 if (notit
->packet_context_field
) {
691 bt_packet_context_field_release(notit
->packet_context_field
);
692 notit
->packet_context_field
= NULL
;
695 release_event_dscopes(notit
);
699 enum bt_msg_iter_status
switch_packet_state(struct bt_msg_iter
*notit
)
701 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
704 * We don't put the stream class here because we need to make
705 * sure that all the packets processed by the same message
706 * iterator refer to the same stream class (the first one).
710 if (notit
->cur_exp_packet_total_size
!= -1) {
711 notit
->cur_packet_offset
+= notit
->cur_exp_packet_total_size
;
714 BT_COMP_LOGD("Switching packet: notit-addr=%p, cur=%zu, "
715 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
716 notit
->cur_packet_offset
);
717 stack_clear(notit
->stack
);
718 notit
->meta
.ec
= NULL
;
719 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
720 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
721 release_all_dscopes(notit
);
722 notit
->cur_dscope_field
= NULL
;
725 * Adjust current buffer so that addr points to the beginning of the new
728 if (notit
->buf
.addr
) {
729 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
731 /* Packets are assumed to start on a byte frontier. */
732 if (notit
->buf
.at
% CHAR_BIT
) {
733 BT_COMP_LOGW("Cannot switch packet: current position is not a multiple of 8: "
734 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
735 status
= BT_MSG_ITER_STATUS_ERROR
;
739 notit
->buf
.addr
+= consumed_bytes
;
740 notit
->buf
.sz
-= consumed_bytes
;
742 notit
->buf
.packet_offset
= 0;
743 BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu",
744 notit
->buf
.addr
, notit
->buf
.sz
);
747 notit
->cur_exp_packet_content_size
= -1;
748 notit
->cur_exp_packet_total_size
= -1;
749 notit
->cur_stream_class_id
= -1;
750 notit
->cur_event_class_id
= -1;
751 notit
->cur_data_stream_id
= -1;
752 notit
->prev_packet_snapshots
= notit
->snapshots
;
753 notit
->snapshots
.discarded_events
= UINT64_C(-1);
754 notit
->snapshots
.packets
= UINT64_C(-1);
755 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
756 notit
->snapshots
.end_clock
= UINT64_C(-1);
757 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
764 enum bt_msg_iter_status
read_packet_header_begin_state(
765 struct bt_msg_iter
*notit
)
767 struct ctf_field_class
*packet_header_fc
= NULL
;
768 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
771 * Make sure at least one bit is available for this packet. An
772 * empty packet is impossible. If we reach the end of the medium
773 * at this point, then it's considered the end of the stream.
775 ret
= buf_ensure_available_bits(notit
);
777 case BT_MSG_ITER_STATUS_OK
:
779 case BT_MSG_ITER_STATUS_EOF
:
780 ret
= BT_MSG_ITER_STATUS_OK
;
781 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
787 /* Packet header class is common to the whole trace class. */
788 packet_header_fc
= notit
->meta
.tc
->packet_header_fc
;
789 if (!packet_header_fc
) {
790 notit
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
794 notit
->cur_stream_class_id
= -1;
795 notit
->cur_event_class_id
= -1;
796 notit
->cur_data_stream_id
= -1;
797 BT_COMP_LOGD("Decoding packet header field:"
798 "notit-addr=%p, trace-class-addr=%p, fc-addr=%p",
799 notit
, notit
->meta
.tc
, packet_header_fc
);
800 ret
= read_dscope_begin_state(notit
, packet_header_fc
,
801 STATE_AFTER_TRACE_PACKET_HEADER
,
802 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
804 BT_COMP_LOGW("Cannot decode packet header field: "
805 "notit-addr=%p, trace-class-addr=%p, "
807 notit
, notit
->meta
.tc
, packet_header_fc
);
815 enum bt_msg_iter_status
read_packet_header_continue_state(
816 struct bt_msg_iter
*notit
)
818 return read_dscope_continue_state(notit
,
819 STATE_AFTER_TRACE_PACKET_HEADER
);
823 enum bt_msg_iter_status
set_current_stream_class(struct bt_msg_iter
*notit
)
825 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
826 struct ctf_stream_class
*new_stream_class
= NULL
;
828 if (notit
->cur_stream_class_id
== -1) {
830 * No current stream class ID field, therefore only one
833 if (notit
->meta
.tc
->stream_classes
->len
!= 1) {
834 BT_COMP_LOGW("Need exactly one stream class since there's "
835 "no stream class ID field: "
836 "notit-addr=%p", notit
);
837 status
= BT_MSG_ITER_STATUS_ERROR
;
841 new_stream_class
= notit
->meta
.tc
->stream_classes
->pdata
[0];
842 notit
->cur_stream_class_id
= new_stream_class
->id
;
845 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
846 notit
->meta
.tc
, notit
->cur_stream_class_id
);
847 if (!new_stream_class
) {
848 BT_COMP_LOGW("No stream class with ID of stream class ID to use in trace class: "
849 "notit-addr=%p, stream-class-id=%" PRIu64
", "
850 "trace-class-addr=%p",
851 notit
, notit
->cur_stream_class_id
, notit
->meta
.tc
);
852 status
= BT_MSG_ITER_STATUS_ERROR
;
856 if (notit
->meta
.sc
) {
857 if (new_stream_class
!= notit
->meta
.sc
) {
858 BT_COMP_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
859 "notit-addr=%p, prev-stream-class-addr=%p, "
860 "prev-stream-class-id=%" PRId64
", "
861 "next-stream-class-addr=%p, "
862 "next-stream-class-id=%" PRId64
", "
864 notit
, notit
->meta
.sc
,
867 new_stream_class
->id
,
869 status
= BT_MSG_ITER_STATUS_ERROR
;
873 notit
->meta
.sc
= new_stream_class
;
876 BT_COMP_LOGD("Set current stream class: "
877 "notit-addr=%p, stream-class-addr=%p, "
878 "stream-class-id=%" PRId64
,
879 notit
, notit
->meta
.sc
, notit
->meta
.sc
->id
);
886 enum bt_msg_iter_status
set_current_stream(struct bt_msg_iter
*notit
)
888 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
889 bt_stream
*stream
= NULL
;
891 BT_COMP_LOGD("Calling user function (get stream): notit-addr=%p, "
892 "stream-class-addr=%p, stream-class-id=%" PRId64
,
893 notit
, notit
->meta
.sc
,
895 stream
= notit
->medium
.medops
.borrow_stream(
896 notit
->meta
.sc
->ir_sc
, notit
->cur_data_stream_id
,
898 bt_stream_get_ref(stream
);
899 BT_COMP_LOGD("User function returned: stream-addr=%p", stream
);
901 BT_COMP_LOGW_STR("User function failed to return a stream object "
902 "for the given stream class.");
903 status
= BT_MSG_ITER_STATUS_ERROR
;
907 if (notit
->stream
&& stream
!= notit
->stream
) {
908 BT_COMP_LOGW("User function returned a different stream than the "
909 "previous one for the same sequence of packets.");
910 status
= BT_MSG_ITER_STATUS_ERROR
;
914 BT_STREAM_MOVE_REF(notit
->stream
, stream
);
917 bt_stream_put_ref(stream
);
922 enum bt_msg_iter_status
set_current_packet(struct bt_msg_iter
*notit
)
924 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
925 bt_packet
*packet
= NULL
;
927 BT_COMP_LOGD("Creating packet from stream: "
928 "notit-addr=%p, stream-addr=%p, "
929 "stream-class-addr=%p, "
930 "stream-class-id=%" PRId64
,
931 notit
, notit
->stream
, notit
->meta
.sc
,
935 BT_ASSERT(notit
->stream
);
936 packet
= bt_packet_create(notit
->stream
);
938 BT_COMP_LOGE("Cannot create packet from stream: "
939 "notit-addr=%p, stream-addr=%p, "
940 "stream-class-addr=%p, "
941 "stream-class-id=%" PRId64
,
942 notit
, notit
->stream
, notit
->meta
.sc
,
950 BT_PACKET_PUT_REF_AND_RESET(packet
);
951 status
= BT_MSG_ITER_STATUS_ERROR
;
954 BT_PACKET_MOVE_REF(notit
->packet
, packet
);
959 enum bt_msg_iter_status
after_packet_header_state(
960 struct bt_msg_iter
*notit
)
962 enum bt_msg_iter_status status
;
964 status
= set_current_stream_class(notit
);
965 if (status
!= BT_MSG_ITER_STATUS_OK
) {
969 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
976 enum bt_msg_iter_status
read_packet_context_begin_state(
977 struct bt_msg_iter
*notit
)
979 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
980 struct ctf_field_class
*packet_context_fc
;
982 BT_ASSERT(notit
->meta
.sc
);
983 packet_context_fc
= notit
->meta
.sc
->packet_context_fc
;
984 if (!packet_context_fc
) {
985 BT_COMP_LOGD("No packet packet context field class in stream class: continuing: "
986 "notit-addr=%p, stream-class-addr=%p, "
987 "stream-class-id=%" PRId64
,
988 notit
, notit
->meta
.sc
,
990 notit
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
994 BT_ASSERT(!notit
->packet_context_field
);
996 if (packet_context_fc
->in_ir
&& !notit
->dry_run
) {
998 * Create free packet context field from stream class.
999 * This field is going to be moved to the packet once we
1000 * create it. We cannot create the packet now because a
1001 * packet is created from a stream, and this API must be
1002 * able to return the packet context properties without
1004 * (bt_msg_iter_get_packet_properties()).
1006 notit
->packet_context_field
=
1007 bt_packet_context_field_create(
1008 notit
->meta
.sc
->ir_sc
);
1009 if (!notit
->packet_context_field
) {
1010 BT_COMP_LOGE_STR("Cannot create packet context field wrapper from stream class.");
1011 status
= BT_MSG_ITER_STATUS_ERROR
;
1015 notit
->dscopes
.stream_packet_context
=
1016 bt_packet_context_field_borrow_field(
1017 notit
->packet_context_field
);
1018 BT_ASSERT(notit
->dscopes
.stream_packet_context
);
1021 BT_COMP_LOGD("Decoding packet context field: "
1022 "notit-addr=%p, stream-class-addr=%p, "
1023 "stream-class-id=%" PRId64
", fc-addr=%p",
1024 notit
, notit
->meta
.sc
,
1025 notit
->meta
.sc
->id
, packet_context_fc
);
1026 status
= read_dscope_begin_state(notit
, packet_context_fc
,
1027 STATE_AFTER_STREAM_PACKET_CONTEXT
,
1028 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
1029 notit
->dscopes
.stream_packet_context
);
1031 BT_COMP_LOGW("Cannot decode packet context field: "
1032 "notit-addr=%p, stream-class-addr=%p, "
1033 "stream-class-id=%" PRId64
", fc-addr=%p",
1034 notit
, notit
->meta
.sc
,
1044 enum bt_msg_iter_status
read_packet_context_continue_state(
1045 struct bt_msg_iter
*notit
)
1047 return read_dscope_continue_state(notit
,
1048 STATE_AFTER_STREAM_PACKET_CONTEXT
);
1052 enum bt_msg_iter_status
set_current_packet_content_sizes(
1053 struct bt_msg_iter
*notit
)
1055 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1057 if (notit
->cur_exp_packet_total_size
== -1) {
1058 if (notit
->cur_exp_packet_content_size
!= -1) {
1059 notit
->cur_exp_packet_total_size
=
1060 notit
->cur_exp_packet_content_size
;
1063 if (notit
->cur_exp_packet_content_size
== -1) {
1064 notit
->cur_exp_packet_content_size
=
1065 notit
->cur_exp_packet_total_size
;
1069 BT_ASSERT((notit
->cur_exp_packet_total_size
>= 0 &&
1070 notit
->cur_exp_packet_content_size
>= 0) ||
1071 (notit
->cur_exp_packet_total_size
< 0 &&
1072 notit
->cur_exp_packet_content_size
< 0));
1074 if (notit
->cur_exp_packet_content_size
>
1075 notit
->cur_exp_packet_total_size
) {
1076 BT_COMP_LOGW("Invalid packet or content size: "
1077 "content size is greater than packet size: "
1078 "notit-addr=%p, packet-context-field-addr=%p, "
1079 "packet-size=%" PRId64
", content-size=%" PRId64
,
1080 notit
, notit
->dscopes
.stream_packet_context
,
1081 notit
->cur_exp_packet_total_size
,
1082 notit
->cur_exp_packet_content_size
);
1083 status
= BT_MSG_ITER_STATUS_ERROR
;
1087 BT_COMP_LOGD("Set current packet and content sizes: "
1088 "notit-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1089 notit
, notit
->cur_exp_packet_total_size
,
1090 notit
->cur_exp_packet_content_size
);
1097 enum bt_msg_iter_status
after_packet_context_state(struct bt_msg_iter
*notit
)
1099 enum bt_msg_iter_status status
;
1101 status
= set_current_packet_content_sizes(notit
);
1102 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1106 if (notit
->stream
) {
1108 * Stream exists, which means we already emitted at
1109 * least one packet beginning message, so the initial
1110 * stream beginning message was also emitted.
1112 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1114 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
;
1122 enum bt_msg_iter_status
read_event_header_begin_state(struct bt_msg_iter
*notit
)
1124 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1125 struct ctf_field_class
*event_header_fc
= NULL
;
1127 /* Reset the position of the last event header */
1128 notit
->buf
.last_eh_at
= notit
->buf
.at
;
1129 notit
->cur_event_class_id
= -1;
1131 /* Check if we have some content left */
1132 if (notit
->cur_exp_packet_content_size
>= 0) {
1133 if (G_UNLIKELY(packet_at(notit
) ==
1134 notit
->cur_exp_packet_content_size
)) {
1135 /* No more events! */
1136 BT_COMP_LOGD("Reached end of packet: notit-addr=%p, "
1137 "cur=%zu", notit
, packet_at(notit
));
1138 notit
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1140 } else if (G_UNLIKELY(packet_at(notit
) >
1141 notit
->cur_exp_packet_content_size
)) {
1142 /* That's not supposed to happen */
1143 BT_COMP_LOGD("Before decoding event header field: cursor is passed the packet's content: "
1144 "notit-addr=%p, content-size=%" PRId64
", "
1146 notit
->cur_exp_packet_content_size
,
1148 status
= BT_MSG_ITER_STATUS_ERROR
;
1153 * "Infinite" content: we're done when the medium has
1154 * nothing else for us.
1156 status
= buf_ensure_available_bits(notit
);
1158 case BT_MSG_ITER_STATUS_OK
:
1160 case BT_MSG_ITER_STATUS_EOF
:
1161 status
= BT_MSG_ITER_STATUS_OK
;
1162 notit
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1169 release_event_dscopes(notit
);
1170 BT_ASSERT(notit
->meta
.sc
);
1171 event_header_fc
= notit
->meta
.sc
->event_header_fc
;
1172 if (!event_header_fc
) {
1173 notit
->state
= STATE_AFTER_EVENT_HEADER
;
1177 BT_COMP_LOGD("Decoding event header field: "
1178 "notit-addr=%p, stream-class-addr=%p, "
1179 "stream-class-id=%" PRId64
", "
1181 notit
, notit
->meta
.sc
,
1184 status
= read_dscope_begin_state(notit
, event_header_fc
,
1185 STATE_AFTER_EVENT_HEADER
,
1186 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1188 BT_COMP_LOGW("Cannot decode event header field: "
1189 "notit-addr=%p, stream-class-addr=%p, "
1190 "stream-class-id=%" PRId64
", fc-addr=%p",
1191 notit
, notit
->meta
.sc
,
1201 enum bt_msg_iter_status
read_event_header_continue_state(
1202 struct bt_msg_iter
*notit
)
1204 return read_dscope_continue_state(notit
,
1205 STATE_AFTER_EVENT_HEADER
);
1209 enum bt_msg_iter_status
set_current_event_class(struct bt_msg_iter
*notit
)
1211 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1213 struct ctf_event_class
*new_event_class
= NULL
;
1215 if (notit
->cur_event_class_id
== -1) {
1217 * No current event class ID field, therefore only one
1220 if (notit
->meta
.sc
->event_classes
->len
!= 1) {
1221 BT_COMP_LOGW("Need exactly one event class since there's "
1222 "no event class ID field: "
1223 "notit-addr=%p", notit
);
1224 status
= BT_MSG_ITER_STATUS_ERROR
;
1228 new_event_class
= notit
->meta
.sc
->event_classes
->pdata
[0];
1229 notit
->cur_event_class_id
= new_event_class
->id
;
1232 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1233 notit
->meta
.sc
, notit
->cur_event_class_id
);
1234 if (!new_event_class
) {
1235 BT_COMP_LOGW("No event class with ID of event class ID to use in stream class: "
1236 "notit-addr=%p, stream-class-id=%" PRIu64
", "
1237 "event-class-id=%" PRIu64
", "
1238 "trace-class-addr=%p",
1239 notit
, notit
->meta
.sc
->id
, notit
->cur_event_class_id
,
1241 status
= BT_MSG_ITER_STATUS_ERROR
;
1245 notit
->meta
.ec
= new_event_class
;
1246 BT_COMP_LOGD("Set current event class: "
1247 "notit-addr=%p, event-class-addr=%p, "
1248 "event-class-id=%" PRId64
", "
1249 "event-class-name=\"%s\"",
1250 notit
, notit
->meta
.ec
, notit
->meta
.ec
->id
,
1251 notit
->meta
.ec
->name
->str
);
1258 enum bt_msg_iter_status
set_current_event_message(
1259 struct bt_msg_iter
*notit
)
1261 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1262 bt_message
*msg
= NULL
;
1264 BT_ASSERT_DBG(notit
->meta
.ec
);
1265 BT_ASSERT_DBG(notit
->packet
);
1266 BT_COMP_LOGD("Creating event message from event class and packet: "
1267 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1268 notit
, notit
->meta
.ec
,
1269 notit
->meta
.ec
->name
->str
,
1271 BT_ASSERT_DBG(notit
->msg_iter
);
1272 BT_ASSERT_DBG(notit
->meta
.sc
);
1274 if (bt_stream_class_borrow_default_clock_class(notit
->meta
.sc
->ir_sc
)) {
1275 msg
= bt_message_event_create_with_packet_and_default_clock_snapshot(
1276 notit
->msg_iter
, notit
->meta
.ec
->ir_ec
,
1277 notit
->packet
, notit
->default_clock_snapshot
);
1279 msg
= bt_message_event_create_with_packet(notit
->msg_iter
,
1280 notit
->meta
.ec
->ir_ec
, notit
->packet
);
1284 BT_COMP_LOGE("Cannot create event message: "
1285 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1287 notit
, notit
->meta
.ec
,
1288 notit
->meta
.ec
->name
->str
,
1296 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1297 status
= BT_MSG_ITER_STATUS_ERROR
;
1300 BT_MESSAGE_MOVE_REF(notit
->event_msg
, msg
);
1305 enum bt_msg_iter_status
after_event_header_state(
1306 struct bt_msg_iter
*notit
)
1308 enum bt_msg_iter_status status
;
1310 status
= set_current_event_class(notit
);
1311 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1315 if (G_UNLIKELY(notit
->dry_run
)) {
1319 status
= set_current_event_message(notit
);
1320 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1324 notit
->event
= bt_message_event_borrow_event(
1326 BT_ASSERT_DBG(notit
->event
);
1329 notit
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1336 enum bt_msg_iter_status
read_event_common_context_begin_state(
1337 struct bt_msg_iter
*notit
)
1339 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1340 struct ctf_field_class
*event_common_context_fc
;
1342 event_common_context_fc
= notit
->meta
.sc
->event_common_context_fc
;
1343 if (!event_common_context_fc
) {
1344 notit
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1348 if (event_common_context_fc
->in_ir
&& !notit
->dry_run
) {
1349 BT_ASSERT_DBG(!notit
->dscopes
.event_common_context
);
1350 notit
->dscopes
.event_common_context
=
1351 bt_event_borrow_common_context_field(
1353 BT_ASSERT_DBG(notit
->dscopes
.event_common_context
);
1356 BT_COMP_LOGT("Decoding event common context field: "
1357 "notit-addr=%p, stream-class-addr=%p, "
1358 "stream-class-id=%" PRId64
", "
1360 notit
, notit
->meta
.sc
,
1362 event_common_context_fc
);
1363 status
= read_dscope_begin_state(notit
, event_common_context_fc
,
1364 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1365 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1366 notit
->dscopes
.event_common_context
);
1368 BT_COMP_LOGW("Cannot decode event common context field: "
1369 "notit-addr=%p, stream-class-addr=%p, "
1370 "stream-class-id=%" PRId64
", fc-addr=%p",
1371 notit
, notit
->meta
.sc
,
1373 event_common_context_fc
);
1381 enum bt_msg_iter_status
read_event_common_context_continue_state(
1382 struct bt_msg_iter
*notit
)
1384 return read_dscope_continue_state(notit
,
1385 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1389 enum bt_msg_iter_status
read_event_spec_context_begin_state(
1390 struct bt_msg_iter
*notit
)
1392 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1393 struct ctf_field_class
*event_spec_context_fc
;
1395 event_spec_context_fc
= notit
->meta
.ec
->spec_context_fc
;
1396 if (!event_spec_context_fc
) {
1397 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1401 if (event_spec_context_fc
->in_ir
&& !notit
->dry_run
) {
1402 BT_ASSERT_DBG(!notit
->dscopes
.event_spec_context
);
1403 notit
->dscopes
.event_spec_context
=
1404 bt_event_borrow_specific_context_field(
1406 BT_ASSERT_DBG(notit
->dscopes
.event_spec_context
);
1409 BT_COMP_LOGT("Decoding event specific context field: "
1410 "notit-addr=%p, event-class-addr=%p, "
1411 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1413 notit
, notit
->meta
.ec
,
1414 notit
->meta
.ec
->name
->str
,
1416 event_spec_context_fc
);
1417 status
= read_dscope_begin_state(notit
, event_spec_context_fc
,
1418 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1419 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1420 notit
->dscopes
.event_spec_context
);
1422 BT_COMP_LOGW("Cannot decode event specific context field: "
1423 "notit-addr=%p, event-class-addr=%p, "
1424 "event-class-name=\"%s\", "
1425 "event-class-id=%" PRId64
", fc-addr=%p",
1426 notit
, notit
->meta
.ec
,
1427 notit
->meta
.ec
->name
->str
,
1429 event_spec_context_fc
);
1437 enum bt_msg_iter_status
read_event_spec_context_continue_state(
1438 struct bt_msg_iter
*notit
)
1440 return read_dscope_continue_state(notit
,
1441 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1445 enum bt_msg_iter_status
read_event_payload_begin_state(
1446 struct bt_msg_iter
*notit
)
1448 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1449 struct ctf_field_class
*event_payload_fc
;
1451 event_payload_fc
= notit
->meta
.ec
->payload_fc
;
1452 if (!event_payload_fc
) {
1453 notit
->state
= STATE_EMIT_MSG_EVENT
;
1457 if (event_payload_fc
->in_ir
&& !notit
->dry_run
) {
1458 BT_ASSERT_DBG(!notit
->dscopes
.event_payload
);
1459 notit
->dscopes
.event_payload
=
1460 bt_event_borrow_payload_field(
1462 BT_ASSERT_DBG(notit
->dscopes
.event_payload
);
1465 BT_COMP_LOGT("Decoding event payload field: "
1466 "notit-addr=%p, event-class-addr=%p, "
1467 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1469 notit
, notit
->meta
.ec
,
1470 notit
->meta
.ec
->name
->str
,
1473 status
= read_dscope_begin_state(notit
, event_payload_fc
,
1474 STATE_EMIT_MSG_EVENT
,
1475 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1476 notit
->dscopes
.event_payload
);
1478 BT_COMP_LOGW("Cannot decode event payload field: "
1479 "notit-addr=%p, event-class-addr=%p, "
1480 "event-class-name=\"%s\", "
1481 "event-class-id=%" PRId64
", fc-addr=%p",
1482 notit
, notit
->meta
.ec
,
1483 notit
->meta
.ec
->name
->str
,
1493 enum bt_msg_iter_status
read_event_payload_continue_state(
1494 struct bt_msg_iter
*notit
)
1496 return read_dscope_continue_state(notit
, STATE_EMIT_MSG_EVENT
);
1500 enum bt_msg_iter_status
skip_packet_padding_state(struct bt_msg_iter
*notit
)
1502 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1503 size_t bits_to_skip
;
1504 const enum state next_state
= STATE_SWITCH_PACKET
;
1506 BT_ASSERT(notit
->cur_exp_packet_total_size
> 0);
1507 bits_to_skip
= notit
->cur_exp_packet_total_size
- packet_at(notit
);
1508 if (bits_to_skip
== 0) {
1509 notit
->state
= next_state
;
1512 size_t bits_to_consume
;
1514 BT_COMP_LOGD("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1515 bits_to_skip
, notit
, bits_to_skip
);
1516 status
= buf_ensure_available_bits(notit
);
1517 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1521 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1522 BT_COMP_LOGD("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1523 bits_to_consume
, notit
, bits_to_consume
);
1524 buf_consume_bits(notit
, bits_to_consume
);
1525 bits_to_skip
= notit
->cur_exp_packet_total_size
-
1527 if (bits_to_skip
== 0) {
1528 notit
->state
= next_state
;
1538 enum bt_msg_iter_status
check_emit_msg_stream_beginning_state(
1539 struct bt_msg_iter
*notit
)
1541 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1543 if (notit
->set_stream
) {
1544 status
= set_current_stream(notit
);
1545 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1550 if (notit
->emit_stream_begin_msg
) {
1551 notit
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1553 /* Stream's first packet */
1554 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1562 enum bt_msg_iter_status
check_emit_msg_discarded_events(
1563 struct bt_msg_iter
*notit
)
1565 notit
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1567 if (!notit
->meta
.sc
->has_discarded_events
) {
1568 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1572 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1573 if (notit
->snapshots
.discarded_events
== 0 ||
1574 notit
->snapshots
.discarded_events
== UINT64_C(-1)) {
1576 * Stream's first packet with no discarded
1577 * events or no information about discarded
1578 * events: do not emit.
1580 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1584 * If the previous packet has a value for this counter,
1585 * then this counter is defined for the whole stream.
1587 BT_ASSERT(notit
->snapshots
.discarded_events
!= UINT64_C(-1));
1589 if (notit
->snapshots
.discarded_events
-
1590 notit
->prev_packet_snapshots
.discarded_events
== 0) {
1592 * No discarded events since previous packet: do
1595 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1600 return BT_MSG_ITER_STATUS_OK
;
1604 enum bt_msg_iter_status
check_emit_msg_discarded_packets(
1605 struct bt_msg_iter
*notit
)
1607 notit
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1609 if (!notit
->meta
.sc
->has_discarded_packets
) {
1610 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1614 if (notit
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1616 * Stream's first packet or no information about
1617 * discarded packets: do not emit. In other words, if
1618 * this is the first packet and its sequence number is
1619 * not 0, do not consider that packets were previously
1620 * lost: we might be reading a partial stream (LTTng
1621 * snapshot for example).
1623 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1626 * If the previous packet has a value for this counter,
1627 * then this counter is defined for the whole stream.
1629 BT_ASSERT(notit
->snapshots
.packets
!= UINT64_C(-1));
1631 if (notit
->snapshots
.packets
-
1632 notit
->prev_packet_snapshots
.packets
<= 1) {
1634 * No discarded packets since previous packet:
1637 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1642 return BT_MSG_ITER_STATUS_OK
;
1646 enum bt_msg_iter_status
check_emit_msg_stream_end(
1647 struct bt_msg_iter
*notit
)
1649 if (notit
->emit_stream_end_msg
) {
1650 notit
->state
= STATE_EMIT_MSG_STREAM_END
;
1652 notit
->state
= STATE_DONE
;
1655 return BT_MSG_ITER_STATUS_OK
;
1659 enum bt_msg_iter_status
handle_state(struct bt_msg_iter
*notit
)
1661 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1662 const enum state state
= notit
->state
;
1664 BT_COMP_LOGT("Handling state: notit-addr=%p, state=%s",
1665 notit
, state_string(state
));
1667 // TODO: optimalize!
1670 notit
->state
= STATE_SWITCH_PACKET
;
1672 case STATE_SWITCH_PACKET
:
1673 status
= switch_packet_state(notit
);
1675 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1676 status
= read_packet_header_begin_state(notit
);
1678 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1679 status
= read_packet_header_continue_state(notit
);
1681 case STATE_AFTER_TRACE_PACKET_HEADER
:
1682 status
= after_packet_header_state(notit
);
1684 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1685 status
= read_packet_context_begin_state(notit
);
1687 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1688 status
= read_packet_context_continue_state(notit
);
1690 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1691 status
= after_packet_context_state(notit
);
1693 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
1694 status
= check_emit_msg_stream_beginning_state(notit
);
1696 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1697 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1699 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1700 status
= check_emit_msg_discarded_events(notit
);
1702 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1703 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1705 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1706 status
= check_emit_msg_discarded_packets(notit
);
1708 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1709 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1711 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1712 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1714 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1715 status
= read_event_header_begin_state(notit
);
1717 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1718 status
= read_event_header_continue_state(notit
);
1720 case STATE_AFTER_EVENT_HEADER
:
1721 status
= after_event_header_state(notit
);
1723 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1724 status
= read_event_common_context_begin_state(notit
);
1726 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1727 status
= read_event_common_context_continue_state(notit
);
1729 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1730 status
= read_event_spec_context_begin_state(notit
);
1732 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1733 status
= read_event_spec_context_continue_state(notit
);
1735 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1736 status
= read_event_payload_begin_state(notit
);
1738 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1739 status
= read_event_payload_continue_state(notit
);
1741 case STATE_EMIT_MSG_EVENT
:
1742 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1744 case STATE_EMIT_QUEUED_MSG_EVENT
:
1745 notit
->state
= STATE_EMIT_MSG_EVENT
;
1747 case STATE_SKIP_PACKET_PADDING
:
1748 status
= skip_packet_padding_state(notit
);
1750 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1751 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1753 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1754 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
1756 case STATE_CHECK_EMIT_MSG_STREAM_END
:
1757 status
= check_emit_msg_stream_end(notit
);
1759 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
1760 notit
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1762 case STATE_EMIT_MSG_STREAM_END
:
1763 notit
->state
= STATE_DONE
;
1768 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1769 "notit-addr=%p, state=%d", notit
, notit
->state
);
1773 BT_COMP_LOGT("Handled state: notit-addr=%p, status=%s, "
1774 "prev-state=%s, cur-state=%s",
1775 notit
, bt_msg_iter_status_string(status
),
1776 state_string(state
), state_string(notit
->state
));
1781 void bt_msg_iter_reset_for_next_stream_file(struct bt_msg_iter
*notit
)
1784 BT_COMP_LOGD("Resetting message iterator: addr=%p", notit
);
1785 stack_clear(notit
->stack
);
1786 notit
->meta
.sc
= NULL
;
1787 notit
->meta
.ec
= NULL
;
1788 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
1789 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
1790 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
1791 release_all_dscopes(notit
);
1792 notit
->cur_dscope_field
= NULL
;
1794 if (notit
->packet_context_field
) {
1795 bt_packet_context_field_release(notit
->packet_context_field
);
1796 notit
->packet_context_field
= NULL
;
1799 notit
->buf
.addr
= NULL
;
1802 notit
->buf
.last_eh_at
= SIZE_MAX
;
1803 notit
->buf
.packet_offset
= 0;
1804 notit
->state
= STATE_INIT
;
1805 notit
->cur_exp_packet_content_size
= -1;
1806 notit
->cur_exp_packet_total_size
= -1;
1807 notit
->cur_packet_offset
= -1;
1808 notit
->cur_event_class_id
= -1;
1809 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1810 notit
->snapshots
.end_clock
= UINT64_C(-1);
1814 * Resets the internal state of a CTF message iterator.
1817 void bt_msg_iter_reset(struct bt_msg_iter
*notit
)
1819 bt_msg_iter_reset_for_next_stream_file(notit
);
1820 notit
->cur_stream_class_id
= -1;
1821 notit
->cur_data_stream_id
= -1;
1822 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1823 notit
->snapshots
.packets
= UINT64_C(-1);
1824 notit
->prev_packet_snapshots
.discarded_events
= UINT64_C(-1);
1825 notit
->prev_packet_snapshots
.packets
= UINT64_C(-1);
1826 notit
->prev_packet_snapshots
.beginning_clock
= UINT64_C(-1);
1827 notit
->prev_packet_snapshots
.end_clock
= UINT64_C(-1);
1831 bt_field
*borrow_next_field(struct bt_msg_iter
*notit
)
1833 bt_field
*next_field
= NULL
;
1834 bt_field
*base_field
;
1835 const bt_field_class
*base_fc
;
1836 bt_field_class_type base_fc_type
;
1839 BT_ASSERT_DBG(!stack_empty(notit
->stack
));
1840 index
= stack_top(notit
->stack
)->index
;
1841 base_field
= stack_top(notit
->stack
)->base
;
1842 BT_ASSERT_DBG(base_field
);
1843 base_fc
= bt_field_borrow_class_const(base_field
);
1844 BT_ASSERT_DBG(base_fc
);
1845 base_fc_type
= bt_field_class_get_type(base_fc
);
1847 if (base_fc_type
== BT_FIELD_CLASS_TYPE_STRUCTURE
) {
1848 BT_ASSERT_DBG(index
<
1849 bt_field_class_structure_get_member_count(
1850 bt_field_borrow_class_const(
1853 bt_field_structure_borrow_member_field_by_index(
1855 } else if (bt_field_class_type_is(base_fc_type
,
1856 BT_FIELD_CLASS_TYPE_ARRAY
)) {
1857 BT_ASSERT_DBG(index
< bt_field_array_get_length(base_field
));
1858 next_field
= bt_field_array_borrow_element_field_by_index(
1860 } else if (bt_field_class_type_is(base_fc_type
,
1861 BT_FIELD_CLASS_TYPE_VARIANT
)) {
1862 BT_ASSERT_DBG(index
== 0);
1863 next_field
= bt_field_variant_borrow_selected_option_field(
1869 BT_ASSERT_DBG(next_field
);
1874 void update_default_clock(struct bt_msg_iter
*notit
, uint64_t new_val
,
1875 uint64_t new_val_size
)
1877 uint64_t new_val_mask
;
1878 uint64_t cur_value_masked
;
1880 BT_ASSERT_DBG(new_val_size
> 0);
1883 * Special case for a 64-bit new value, which is the limit
1884 * of a clock value as of this version: overwrite the
1885 * current value directly.
1887 if (new_val_size
== 64) {
1888 notit
->default_clock_snapshot
= new_val
;
1892 new_val_mask
= (1ULL << new_val_size
) - 1;
1893 cur_value_masked
= notit
->default_clock_snapshot
& new_val_mask
;
1895 if (new_val
< cur_value_masked
) {
1897 * It looks like a wrap happened on the number of bits
1898 * of the requested new value. Assume that the clock
1899 * value wrapped only one time.
1901 notit
->default_clock_snapshot
+= new_val_mask
+ 1;
1904 /* Clear the low bits of the current clock value. */
1905 notit
->default_clock_snapshot
&= ~new_val_mask
;
1907 /* Set the low bits of the current clock value. */
1908 notit
->default_clock_snapshot
|= new_val
;
1911 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1912 "value=%" PRIu64
, notit
->default_clock_snapshot
);
1916 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1917 struct ctf_field_class
*fc
, void *data
)
1919 struct bt_msg_iter
*notit
= data
;
1920 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1921 bt_field
*field
= NULL
;
1922 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1924 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1925 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1926 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1927 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1929 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1930 goto update_def_clock
;
1933 switch (int_fc
->meaning
) {
1934 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1935 notit
->cur_event_class_id
= value
;
1937 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1938 notit
->cur_data_stream_id
= value
;
1940 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1941 notit
->snapshots
.beginning_clock
= value
;
1943 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1944 notit
->snapshots
.end_clock
= value
;
1946 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1947 notit
->cur_stream_class_id
= value
;
1949 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1950 if (value
!= 0xc1fc1fc1) {
1951 BT_COMP_LOGW("Invalid CTF magic number: notit-addr=%p, "
1952 "magic=%" PRIx64
, notit
, value
);
1953 status
= BT_BFCR_STATUS_ERROR
;
1958 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1959 notit
->snapshots
.packets
= value
;
1961 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1962 notit
->snapshots
.discarded_events
= value
;
1964 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1965 notit
->cur_exp_packet_total_size
= value
;
1967 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1968 notit
->cur_exp_packet_content_size
= value
;
1975 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
1976 update_default_clock(notit
, value
, int_fc
->base
.size
);
1979 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1980 g_array_index(notit
->stored_values
, uint64_t,
1981 (uint64_t) int_fc
->storing_index
) = value
;
1984 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
1988 field
= borrow_next_field(notit
);
1989 BT_ASSERT_DBG(field
);
1990 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1991 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
1992 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
));
1993 bt_field_integer_unsigned_set_value(field
, value
);
1994 stack_top(notit
->stack
)->index
++;
2001 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
2002 struct ctf_field_class
*fc
, void *data
)
2005 struct bt_msg_iter
*notit
= data
;
2006 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2007 bt_field
*string_field
= NULL
;
2008 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2009 char str
[2] = {'\0', '\0'};
2011 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
2012 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2013 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
2014 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2015 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2016 BT_ASSERT_DBG(!int_fc
->mapped_clock_class
);
2017 BT_ASSERT_DBG(int_fc
->storing_index
< 0);
2019 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2023 if (notit
->done_filling_string
) {
2028 notit
->done_filling_string
= true;
2032 string_field
= stack_top(notit
->stack
)->base
;
2033 BT_ASSERT_DBG(bt_field_get_class_type(string_field
) ==
2034 BT_FIELD_CLASS_TYPE_STRING
);
2036 /* Append character */
2037 str
[0] = (char) value
;
2038 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
2040 BT_COMP_LOGE("Cannot append character to string field's value: "
2041 "notit-addr=%p, field-addr=%p, ret=%d",
2042 notit
, string_field
, ret
);
2043 status
= BT_BFCR_STATUS_ERROR
;
2052 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
2053 struct ctf_field_class
*fc
, void *data
)
2055 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2056 bt_field
*field
= NULL
;
2057 struct bt_msg_iter
*notit
= data
;
2058 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2060 BT_COMP_LOGT("Signed integer function called from BFCR: "
2061 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2062 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
2063 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2064 BT_ASSERT_DBG(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2066 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
2067 g_array_index(notit
->stored_values
, uint64_t,
2068 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
2071 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2075 field
= borrow_next_field(notit
);
2076 BT_ASSERT_DBG(field
);
2077 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2078 BT_ASSERT_DBG(bt_field_class_type_is(bt_field_get_class_type(field
),
2079 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
));
2080 bt_field_integer_signed_set_value(field
, value
);
2081 stack_top(notit
->stack
)->index
++;
2088 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
2089 struct ctf_field_class
*fc
, void *data
)
2091 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2092 bt_field
*field
= NULL
;
2093 struct bt_msg_iter
*notit
= data
;
2094 bt_field_class_type type
;
2096 BT_COMP_LOGT("Floating point number function called from BFCR: "
2097 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2098 "fc-type=%d, fc-in-ir=%d, value=%f",
2099 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2101 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2105 field
= borrow_next_field(notit
);
2106 type
= bt_field_get_class_type(field
);
2107 BT_ASSERT_DBG(field
);
2108 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2109 BT_ASSERT_DBG(bt_field_class_type_is(type
, BT_FIELD_CLASS_TYPE_REAL
));
2111 if (type
== BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
) {
2112 bt_field_real_single_precision_set_value(field
, (float) value
);
2114 bt_field_real_double_precision_set_value(field
, value
);
2116 stack_top(notit
->stack
)->index
++;
2123 enum bt_bfcr_status
bfcr_string_begin_cb(
2124 struct ctf_field_class
*fc
, void *data
)
2126 bt_field
*field
= NULL
;
2127 struct bt_msg_iter
*notit
= data
;
2129 BT_COMP_LOGT("String (beginning) function called from BFCR: "
2130 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2131 "fc-type=%d, fc-in-ir=%d",
2132 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2134 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2138 field
= borrow_next_field(notit
);
2139 BT_ASSERT_DBG(field
);
2140 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2141 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2142 BT_FIELD_CLASS_TYPE_STRING
);
2143 bt_field_string_clear(field
);
2146 * Push on stack. Not a compound class per se, but we know that
2147 * only bfcr_string_cb() may be called between this call and a
2148 * subsequent call to bfcr_string_end_cb().
2150 stack_push(notit
->stack
, field
);
2153 return BT_BFCR_STATUS_OK
;
2157 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2158 size_t len
, struct ctf_field_class
*fc
, void *data
)
2160 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2161 bt_field
*field
= NULL
;
2162 struct bt_msg_iter
*notit
= data
;
2165 BT_COMP_LOGT("String (substring) function called from BFCR: "
2166 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2167 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2168 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2171 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2175 field
= stack_top(notit
->stack
)->base
;
2176 BT_ASSERT_DBG(field
);
2178 /* Append current substring */
2179 ret
= bt_field_string_append_with_length(field
, value
, len
);
2181 BT_COMP_LOGE("Cannot append substring to string field's value: "
2182 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2183 "ret=%d", notit
, field
, len
, ret
);
2184 status
= BT_BFCR_STATUS_ERROR
;
2193 enum bt_bfcr_status
bfcr_string_end_cb(
2194 struct ctf_field_class
*fc
, void *data
)
2196 struct bt_msg_iter
*notit
= data
;
2198 BT_COMP_LOGT("String (end) function called from BFCR: "
2199 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2200 "fc-type=%d, fc-in-ir=%d",
2201 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2203 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2207 /* Pop string field */
2208 stack_pop(notit
->stack
);
2210 /* Go to next field */
2211 stack_top(notit
->stack
)->index
++;
2214 return BT_BFCR_STATUS_OK
;
2218 enum bt_bfcr_status
bfcr_compound_begin_cb(
2219 struct ctf_field_class
*fc
, void *data
)
2221 struct bt_msg_iter
*notit
= data
;
2224 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2225 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2226 "fc-type=%d, fc-in-ir=%d",
2227 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2229 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2234 if (stack_empty(notit
->stack
)) {
2235 /* Root: already set by read_dscope_begin_state() */
2236 field
= notit
->cur_dscope_field
;
2238 field
= borrow_next_field(notit
);
2239 BT_ASSERT_DBG(field
);
2243 BT_ASSERT_DBG(field
);
2244 BT_ASSERT_DBG(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2245 stack_push(notit
->stack
, field
);
2248 * Change BFCR "unsigned int" callback if it's a text
2251 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2252 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2253 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2255 if (array_fc
->is_text
) {
2256 BT_ASSERT_DBG(bt_field_get_class_type(field
) ==
2257 BT_FIELD_CLASS_TYPE_STRING
);
2258 notit
->done_filling_string
= false;
2259 bt_field_string_clear(field
);
2260 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2261 bfcr_unsigned_int_char_cb
);
2266 return BT_BFCR_STATUS_OK
;
2270 enum bt_bfcr_status
bfcr_compound_end_cb(
2271 struct ctf_field_class
*fc
, void *data
)
2273 struct bt_msg_iter
*notit
= data
;
2275 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2276 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2277 "fc-type=%d, fc-in-ir=%d",
2278 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2280 if (G_UNLIKELY(!fc
->in_ir
|| notit
->dry_run
)) {
2284 BT_ASSERT_DBG(!stack_empty(notit
->stack
));
2285 BT_ASSERT_DBG(bt_field_borrow_class_const(stack_top(notit
->stack
)->base
) ==
2289 * Reset BFCR "unsigned int" callback if it's a text
2292 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2293 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2294 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2296 if (array_fc
->is_text
) {
2297 BT_ASSERT_DBG(bt_field_get_class_type(
2298 stack_top(notit
->stack
)->base
) ==
2299 BT_FIELD_CLASS_TYPE_STRING
);
2300 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2301 bfcr_unsigned_int_cb
);
2306 stack_pop(notit
->stack
);
2308 /* If the stack is not empty, increment the base's index */
2309 if (!stack_empty(notit
->stack
)) {
2310 stack_top(notit
->stack
)->index
++;
2314 return BT_BFCR_STATUS_OK
;
2318 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2320 bt_field
*seq_field
;
2321 struct bt_msg_iter
*notit
= data
;
2322 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2323 int64_t length
= -1;
2326 length
= (uint64_t) g_array_index(notit
->stored_values
, uint64_t,
2327 seq_fc
->stored_length_index
);
2329 if (G_UNLIKELY(notit
->dry_run
)){
2333 seq_field
= stack_top(notit
->stack
)->base
;
2334 BT_ASSERT_DBG(seq_field
);
2337 * bfcr_get_sequence_length_cb() also gets called back for a
2338 * text sequence, but the destination field is a string field.
2339 * Only set the field's sequence length if the destination field
2340 * is a sequence field.
2342 if (!seq_fc
->base
.is_text
) {
2343 BT_ASSERT_DBG(bt_field_class_type_is(
2344 bt_field_get_class_type(seq_field
),
2345 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
));
2346 ret
= bt_field_array_dynamic_set_length(seq_field
,
2349 BT_COMP_LOGE("Cannot set dynamic array field's length field: "
2350 "notit-addr=%p, field-addr=%p, "
2351 "length=%" PRIu64
, notit
, seq_field
, length
);
2360 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2361 struct ctf_field_class
*fc
, void *data
)
2365 int64_t option_index
= -1;
2366 struct bt_msg_iter
*notit
= data
;
2367 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2368 struct ctf_named_field_class
*selected_option
= NULL
;
2369 struct ctf_field_class
*ret_fc
= NULL
;
2375 /* Get variant's tag */
2376 tag
.u
= g_array_index(notit
->stored_values
, uint64_t,
2377 var_fc
->stored_tag_index
);
2380 * Check each range to find the selected option's index.
2382 if (var_fc
->tag_fc
->base
.is_signed
) {
2383 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2384 struct ctf_field_class_variant_range
*range
=
2385 ctf_field_class_variant_borrow_range_by_index(
2388 if (tag
.i
>= range
->range
.lower
.i
&&
2389 tag
.i
<= range
->range
.upper
.i
) {
2390 option_index
= (int64_t) range
->option_index
;
2395 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2396 struct ctf_field_class_variant_range
*range
=
2397 ctf_field_class_variant_borrow_range_by_index(
2400 if (tag
.u
>= range
->range
.lower
.u
&&
2401 tag
.u
<= range
->range
.upper
.u
) {
2402 option_index
= (int64_t) range
->option_index
;
2408 if (option_index
< 0) {
2409 BT_COMP_LOGW("Cannot find variant field class's option: "
2410 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2411 "i-tag=%" PRId64
, notit
, var_fc
, tag
.u
, tag
.i
);
2415 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2416 var_fc
, (uint64_t) option_index
);
2418 if (selected_option
->fc
->in_ir
&& !notit
->dry_run
) {
2419 bt_field
*var_field
= stack_top(notit
->stack
)->base
;
2421 ret
= bt_field_variant_select_option_field_by_index(
2422 var_field
, option_index
);
2424 BT_COMP_LOGW("Cannot select variant field's option field: "
2425 "notit-addr=%p, var-field-addr=%p, "
2426 "opt-index=%" PRId64
, notit
, var_field
,
2432 ret_fc
= selected_option
->fc
;
2439 bt_message
*create_msg_stream_beginning(struct bt_msg_iter
*notit
)
2443 BT_ASSERT(notit
->stream
);
2444 BT_ASSERT(notit
->msg_iter
);
2445 msg
= bt_message_stream_beginning_create(notit
->msg_iter
,
2448 BT_COMP_LOGE("Cannot create stream beginning message: "
2449 "notit-addr=%p, stream-addr=%p",
2450 notit
, notit
->stream
);
2457 bt_message
*create_msg_stream_end(struct bt_msg_iter
*notit
)
2461 if (!notit
->stream
) {
2462 BT_COMP_LOGE("Cannot create stream for stream message: "
2463 "notit-addr=%p", notit
);
2468 BT_ASSERT(notit
->msg_iter
);
2469 msg
= bt_message_stream_end_create(notit
->msg_iter
,
2472 BT_COMP_LOGE("Cannot create stream end message: "
2473 "notit-addr=%p, stream-addr=%p",
2474 notit
, notit
->stream
);
2482 bt_message
*create_msg_packet_beginning(struct bt_msg_iter
*notit
,
2483 bool use_default_cs
)
2487 const bt_stream_class
*sc
= notit
->meta
.sc
->ir_sc
;
2489 BT_ASSERT(notit
->packet
);
2492 if (notit
->packet_context_field
) {
2493 ret
= bt_packet_move_context_field(
2494 notit
->packet
, notit
->packet_context_field
);
2500 notit
->packet_context_field
= NULL
;
2503 * At this point notit->dscopes.stream_packet_context
2504 * has the same value as the packet context field within
2507 BT_ASSERT(bt_packet_borrow_context_field(
2509 notit
->dscopes
.stream_packet_context
);
2512 BT_ASSERT(notit
->msg_iter
);
2514 if (notit
->meta
.sc
->packets_have_ts_begin
) {
2515 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2516 uint64_t raw_cs_value
;
2519 * Either use the decoded packet `timestamp_begin` field or the
2520 * current stream's default clock_snapshot.
2522 if (use_default_cs
) {
2523 raw_cs_value
= notit
->default_clock_snapshot
;
2525 raw_cs_value
= notit
->snapshots
.beginning_clock
;
2528 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2529 notit
->msg_iter
, notit
->packet
,
2532 msg
= bt_message_packet_beginning_create(notit
->msg_iter
,
2537 BT_COMP_LOGE("Cannot create packet beginning message: "
2538 "notit-addr=%p, packet-addr=%p",
2539 notit
, notit
->packet
);
2548 bt_message
*emit_delayed_packet_beg_msg(struct bt_msg_iter
*notit
)
2550 bool packet_beg_ts_need_fix_up
;
2552 notit
->emit_delayed_packet_beginning_msg
= false;
2555 * Only fix the packet's timestamp_begin if it's larger than the first
2556 * event of the packet. If there was no event in the packet, the
2557 * `default_clock_snapshot` field will be either equal or greater than
2558 * `snapshots.beginning_clock` so there is not fix needed.
2560 packet_beg_ts_need_fix_up
=
2561 notit
->default_clock_snapshot
< notit
->snapshots
.beginning_clock
;
2563 /* create_msg_packet_beginning() logs errors */
2564 return create_msg_packet_beginning(notit
, packet_beg_ts_need_fix_up
);
2569 bt_message
*create_msg_packet_end(struct bt_msg_iter
*notit
)
2572 bool update_default_cs
= true;
2574 if (!notit
->packet
) {
2580 * Check if we need to emit the delayed packet
2581 * beginning message instead of the packet end message.
2583 if (G_UNLIKELY(notit
->emit_delayed_packet_beginning_msg
)) {
2584 msg
= emit_delayed_packet_beg_msg(notit
);
2585 /* Don't forget to emit the packet end message. */
2586 notit
->state
= STATE_EMIT_QUEUED_MSG_PACKET_END
;
2590 /* Check if may be affected by lttng-crash timestamp_end quirk. */
2591 if (G_UNLIKELY(notit
->meta
.tc
->quirks
.lttng_crash
)) {
2593 * Check if the `timestamp_begin` field is non-zero but
2594 * `timestamp_end` is zero. It means the trace is affected by
2595 * the lttng-crash packet `timestamp_end` quirk and must be
2596 * fixed up by omitting to update the default clock snapshot to
2597 * the `timestamp_end` as is typically done.
2599 if (notit
->snapshots
.beginning_clock
!= 0 &&
2600 notit
->snapshots
.end_clock
== 0) {
2601 update_default_cs
= false;
2606 * Check if may be affected by lttng event-after-packet `timestamp_end`
2609 if (notit
->meta
.tc
->quirks
.lttng_event_after_packet
) {
2611 * Check if `timestamp_end` is smaller then the current
2612 * default_clock_snapshot (which is set to the last event
2613 * decoded). It means the trace is affected by the lttng
2614 * `event-after-packet` packet `timestamp_end` quirk and must
2615 * be fixed up by omitting to update the default clock snapshot
2616 * to the `timestamp_end` as is typically done.
2618 if (notit
->snapshots
.end_clock
< notit
->default_clock_snapshot
) {
2619 update_default_cs
= false;
2623 /* Update default clock from packet's end time. */
2624 if (notit
->snapshots
.end_clock
!= UINT64_C(-1) && update_default_cs
) {
2625 notit
->default_clock_snapshot
= notit
->snapshots
.end_clock
;
2628 BT_ASSERT(notit
->msg_iter
);
2630 if (notit
->meta
.sc
->packets_have_ts_end
) {
2631 BT_ASSERT(notit
->snapshots
.end_clock
!= UINT64_C(-1));
2632 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2633 notit
->msg_iter
, notit
->packet
,
2634 notit
->default_clock_snapshot
);
2636 msg
= bt_message_packet_end_create(notit
->msg_iter
,
2641 BT_COMP_LOGE("Cannot create packet end message: "
2642 "notit-addr=%p, packet-addr=%p",
2643 notit
, notit
->packet
);
2648 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2655 bt_message
*create_msg_discarded_events(struct bt_msg_iter
*notit
)
2658 uint64_t beginning_raw_value
= UINT64_C(-1);
2659 uint64_t end_raw_value
= UINT64_C(-1);
2661 BT_ASSERT(notit
->msg_iter
);
2662 BT_ASSERT(notit
->stream
);
2663 BT_ASSERT(notit
->meta
.sc
->has_discarded_events
);
2665 if (notit
->meta
.sc
->discarded_events_have_default_cs
) {
2666 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2668 * We discarded events, but before (and possibly
2669 * including) the current packet: use this packet's time
2670 * range, and do not have a specific count.
2672 beginning_raw_value
= notit
->snapshots
.beginning_clock
;
2673 end_raw_value
= notit
->snapshots
.end_clock
;
2675 beginning_raw_value
= notit
->prev_packet_snapshots
.end_clock
;
2676 end_raw_value
= notit
->snapshots
.end_clock
;
2679 BT_ASSERT(beginning_raw_value
!= UINT64_C(-1));
2680 BT_ASSERT(end_raw_value
!= UINT64_C(-1));
2681 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2682 notit
->msg_iter
, notit
->stream
, beginning_raw_value
,
2685 msg
= bt_message_discarded_events_create(notit
->msg_iter
,
2690 BT_COMP_LOGE("Cannot create discarded events message: "
2691 "notit-addr=%p, stream-addr=%p",
2692 notit
, notit
->stream
);
2696 if (notit
->prev_packet_snapshots
.discarded_events
!= UINT64_C(-1)) {
2697 bt_message_discarded_events_set_count(msg
,
2698 notit
->snapshots
.discarded_events
-
2699 notit
->prev_packet_snapshots
.discarded_events
);
2707 bt_message
*create_msg_discarded_packets(struct bt_msg_iter
*notit
)
2711 BT_ASSERT(notit
->msg_iter
);
2712 BT_ASSERT(notit
->stream
);
2713 BT_ASSERT(notit
->meta
.sc
->has_discarded_packets
);
2714 BT_ASSERT(notit
->prev_packet_snapshots
.packets
!=
2717 if (notit
->meta
.sc
->discarded_packets_have_default_cs
) {
2718 BT_ASSERT(notit
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1));
2719 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2720 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2721 notit
->msg_iter
, notit
->stream
,
2722 notit
->prev_packet_snapshots
.end_clock
,
2723 notit
->snapshots
.beginning_clock
);
2725 msg
= bt_message_discarded_packets_create(notit
->msg_iter
,
2730 BT_COMP_LOGE("Cannot create discarded packets message: "
2731 "notit-addr=%p, stream-addr=%p",
2732 notit
, notit
->stream
);
2736 bt_message_discarded_packets_set_count(msg
,
2737 notit
->snapshots
.packets
-
2738 notit
->prev_packet_snapshots
.packets
- 1);
2745 struct bt_msg_iter
*bt_msg_iter_create(struct ctf_trace_class
*tc
,
2746 size_t max_request_sz
,
2747 struct bt_msg_iter_medium_ops medops
, void *data
,
2748 bt_logging_level log_level
, bt_self_component
*self_comp
)
2750 struct bt_msg_iter
*notit
= NULL
;
2751 struct bt_bfcr_cbs cbs
= {
2753 .signed_int
= bfcr_signed_int_cb
,
2754 .unsigned_int
= bfcr_unsigned_int_cb
,
2755 .floating_point
= bfcr_floating_point_cb
,
2756 .string_begin
= bfcr_string_begin_cb
,
2757 .string
= bfcr_string_cb
,
2758 .string_end
= bfcr_string_end_cb
,
2759 .compound_begin
= bfcr_compound_begin_cb
,
2760 .compound_end
= bfcr_compound_end_cb
,
2763 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2764 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2769 BT_ASSERT(medops
.request_bytes
);
2770 BT_ASSERT(medops
.borrow_stream
);
2771 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, log_level
, self_comp
,
2772 "Creating CTF plugin message iterator: "
2773 "trace-addr=%p, max-request-size=%zu, "
2774 "data=%p, log-level=%s", tc
, max_request_sz
, data
,
2775 bt_common_logging_level_string(log_level
));
2776 notit
= g_new0(struct bt_msg_iter
, 1);
2778 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2779 "Failed to allocate one CTF plugin message iterator.");
2782 notit
->self_comp
= self_comp
;
2783 notit
->log_level
= log_level
;
2784 notit
->meta
.tc
= tc
;
2785 notit
->medium
.medops
= medops
;
2786 notit
->medium
.max_request_sz
= max_request_sz
;
2787 notit
->medium
.data
= data
;
2788 notit
->stack
= stack_new(notit
);
2789 notit
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2790 g_array_set_size(notit
->stored_values
, tc
->stored_value_count
);
2792 if (!notit
->stack
) {
2793 BT_COMP_LOGE_STR("Failed to create field stack.");
2797 notit
->bfcr
= bt_bfcr_create(cbs
, notit
, log_level
, NULL
);
2799 BT_COMP_LOGE_STR("Failed to create binary class reader (BFCR).");
2803 bt_msg_iter_reset(notit
);
2804 BT_COMP_LOGD("Created CTF plugin message iterator: "
2805 "trace-addr=%p, max-request-size=%zu, "
2806 "data=%p, notit-addr=%p, log-level=%s",
2807 tc
, max_request_sz
, data
, notit
,
2808 bt_common_logging_level_string(log_level
));
2809 notit
->cur_packet_offset
= 0;
2815 bt_msg_iter_destroy(notit
);
2820 void bt_msg_iter_destroy(struct bt_msg_iter
*notit
)
2822 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2823 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
2824 release_all_dscopes(notit
);
2826 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", notit
);
2829 BT_COMP_LOGD_STR("Destroying field stack.");
2830 stack_destroy(notit
->stack
);
2834 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", notit
->bfcr
);
2835 bt_bfcr_destroy(notit
->bfcr
);
2838 if (notit
->stored_values
) {
2839 g_array_free(notit
->stored_values
, TRUE
);
2845 enum bt_msg_iter_status
bt_msg_iter_get_next_message(
2846 struct bt_msg_iter
*notit
,
2847 bt_self_message_iterator
*msg_iter
, bt_message
**message
)
2849 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2851 BT_ASSERT_DBG(notit
);
2852 BT_ASSERT_DBG(message
);
2853 notit
->msg_iter
= msg_iter
;
2854 notit
->set_stream
= true;
2855 BT_COMP_LOGD("Getting next message: notit-addr=%p", notit
);
2858 status
= handle_state(notit
);
2859 if (G_UNLIKELY(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2860 BT_COMP_LOGD_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2862 } else if (G_UNLIKELY(status
!= BT_MSG_ITER_STATUS_OK
)) {
2863 BT_COMP_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2864 notit
, state_string(notit
->state
));
2868 switch (notit
->state
) {
2869 case STATE_EMIT_MSG_EVENT
:
2870 BT_ASSERT_DBG(notit
->event_msg
);
2873 * Check if we need to emit the delayed packet
2874 * beginning message instead of the event message.
2876 if (G_UNLIKELY(notit
->emit_delayed_packet_beginning_msg
)) {
2877 *message
= emit_delayed_packet_beg_msg(notit
);
2879 status
= BT_MSG_ITER_STATUS_ERROR
;
2883 * Don't forget to emit the event message of
2884 * the event record that was just decoded.
2886 notit
->state
= STATE_EMIT_QUEUED_MSG_EVENT
;
2889 *message
= notit
->event_msg
;
2890 notit
->event_msg
= NULL
;
2893 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2894 /* create_msg_discared_events() logs errors */
2895 *message
= create_msg_discarded_events(notit
);
2898 status
= BT_MSG_ITER_STATUS_ERROR
;
2902 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2903 /* create_msg_discared_packets() logs errors */
2904 *message
= create_msg_discarded_packets(notit
);
2907 status
= BT_MSG_ITER_STATUS_ERROR
;
2911 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2912 status
= set_current_packet(notit
);
2913 if (status
!= BT_MSG_ITER_STATUS_OK
) {
2917 if (G_UNLIKELY(notit
->meta
.tc
->quirks
.barectf_event_before_packet
)) {
2918 notit
->emit_delayed_packet_beginning_msg
= true;
2920 * There is no message to return yet as this
2921 * packet beginning message is delayed until we
2922 * decode the first event message of the
2927 /* create_msg_packet_beginning() logs errors */
2928 *message
= create_msg_packet_beginning(notit
, false);
2930 status
= BT_MSG_ITER_STATUS_ERROR
;
2935 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2936 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2937 /* create_msg_packet_end() logs errors */
2938 *message
= create_msg_packet_end(notit
);
2941 status
= BT_MSG_ITER_STATUS_ERROR
;
2945 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2946 /* create_msg_stream_beginning() logs errors */
2947 *message
= create_msg_stream_beginning(notit
);
2950 status
= BT_MSG_ITER_STATUS_ERROR
;
2954 case STATE_EMIT_MSG_STREAM_END
:
2955 /* create_msg_stream_end() logs errors */
2956 *message
= create_msg_stream_end(notit
);
2959 status
= BT_MSG_ITER_STATUS_ERROR
;
2964 status
= BT_MSG_ITER_STATUS_EOF
;
2967 /* Non-emitting state: continue */
2977 enum bt_msg_iter_status
decode_until_state( struct bt_msg_iter
*notit
,
2978 enum state target_state_1
, enum state target_state_2
)
2980 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2982 BT_ASSERT_DBG(notit
);
2983 notit
->set_stream
= false;
2987 * Check if we reached the state at which we want to stop
2990 if (notit
->state
== target_state_1
||
2991 notit
->state
== target_state_2
) {
2995 status
= handle_state(notit
);
2996 if (G_UNLIKELY(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2997 BT_COMP_LOGD_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2999 } else if (G_UNLIKELY(status
!= BT_MSG_ITER_STATUS_OK
)) {
3000 BT_COMP_LOGW("Cannot handle state: notit-addr=%p, state=%s",
3001 notit
, state_string(notit
->state
));
3005 switch (notit
->state
) {
3007 case STATE_SWITCH_PACKET
:
3008 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
3009 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
3010 case STATE_AFTER_TRACE_PACKET_HEADER
:
3011 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
3012 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
3013 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
3014 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
3015 case STATE_EMIT_MSG_STREAM_BEGINNING
:
3016 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
3017 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
3018 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
3019 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
3020 case STATE_EMIT_MSG_PACKET_BEGINNING
:
3021 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
3022 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
3023 case STATE_AFTER_EVENT_HEADER
:
3024 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
3025 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
3026 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
3027 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
3028 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
3029 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
3030 case STATE_EMIT_MSG_EVENT
:
3031 case STATE_EMIT_QUEUED_MSG_EVENT
:
3032 case STATE_SKIP_PACKET_PADDING
:
3033 case STATE_EMIT_MSG_PACKET_END_MULTI
:
3034 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
3035 case STATE_EMIT_QUEUED_MSG_PACKET_END
:
3036 case STATE_CHECK_EMIT_MSG_STREAM_END
:
3037 case STATE_EMIT_MSG_STREAM_END
:
3042 /* We should never get to the STATE_DONE state. */
3043 BT_COMP_LOGF("Unexpected state: notit-addr=%p, state=%s",
3044 notit
, state_string(notit
->state
));
3054 enum bt_msg_iter_status
read_packet_header_context_fields(
3055 struct bt_msg_iter
*notit
)
3058 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
3060 status
= decode_until_state(notit
, STATE_EMIT_MSG_PACKET_BEGINNING
, -1);
3061 if (status
!= BT_MSG_ITER_STATUS_OK
) {
3065 ret
= set_current_packet_content_sizes(notit
);
3067 status
= BT_MSG_ITER_STATUS_ERROR
;
3076 void bt_msg_iter_set_medops_data(struct bt_msg_iter
*notit
,
3080 notit
->medium
.data
= medops_data
;
3084 enum bt_msg_iter_status
bt_msg_iter_seek(struct bt_msg_iter
*notit
,
3087 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
3088 enum bt_msg_iter_medium_status medium_status
;
3092 BT_COMP_LOGE("Cannot seek to negative offset: offset=%jd", (intmax_t) offset
);
3093 ret
= BT_MSG_ITER_STATUS_INVAL
;
3097 if (!notit
->medium
.medops
.seek
) {
3098 ret
= BT_MSG_ITER_STATUS_UNSUPPORTED
;
3099 BT_COMP_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
3103 medium_status
= notit
->medium
.medops
.seek(
3104 BT_MSG_ITER_SEEK_WHENCE_SET
, offset
, notit
->medium
.data
);
3105 if (medium_status
!= BT_MSG_ITER_MEDIUM_STATUS_OK
) {
3106 if (medium_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
3107 ret
= BT_MSG_ITER_STATUS_EOF
;
3109 ret
= BT_MSG_ITER_STATUS_ERROR
;
3114 bt_msg_iter_reset(notit
);
3115 notit
->cur_packet_offset
= offset
;
3122 enum bt_msg_iter_status
clock_snapshot_at_msg_iter_state(
3123 struct bt_msg_iter
*notit
, enum state target_state_1
,
3124 enum state target_state_2
, uint64_t *clock_snapshot
)
3126 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
3128 BT_ASSERT_DBG(notit
);
3129 BT_ASSERT_DBG(clock_snapshot
);
3130 status
= decode_until_state(notit
, target_state_1
, target_state_2
);
3131 if (status
!= BT_MSG_ITER_STATUS_OK
) {
3135 *clock_snapshot
= notit
->default_clock_snapshot
;
3141 enum bt_msg_iter_status
bt_msg_iter_curr_packet_first_event_clock_snapshot(
3142 struct bt_msg_iter
*notit
, uint64_t *first_clock_snapshot
)
3144 return clock_snapshot_at_msg_iter_state(notit
,
3145 STATE_AFTER_EVENT_HEADER
, -1, first_clock_snapshot
);
3149 enum bt_msg_iter_status
bt_msg_iter_curr_packet_last_event_clock_snapshot(
3150 struct bt_msg_iter
*notit
, uint64_t *last_clock_snapshot
)
3152 return clock_snapshot_at_msg_iter_state(notit
,
3153 STATE_EMIT_MSG_PACKET_END_SINGLE
,
3154 STATE_EMIT_MSG_PACKET_END_MULTI
, last_clock_snapshot
);
3158 enum bt_msg_iter_status
bt_msg_iter_get_packet_properties(
3159 struct bt_msg_iter
*notit
,
3160 struct bt_msg_iter_packet_properties
*props
)
3162 enum bt_msg_iter_status status
;
3164 BT_ASSERT_DBG(notit
);
3165 BT_ASSERT_DBG(props
);
3166 status
= read_packet_header_context_fields(notit
);
3167 if (status
!= BT_MSG_ITER_STATUS_OK
) {
3171 props
->exp_packet_total_size
= notit
->cur_exp_packet_total_size
;
3172 props
->exp_packet_content_size
= notit
->cur_exp_packet_content_size
;
3173 props
->stream_class_id
= (uint64_t) notit
->cur_stream_class_id
;
3174 props
->data_stream_id
= notit
->cur_data_stream_id
;
3175 props
->snapshots
.discarded_events
= notit
->snapshots
.discarded_events
;
3176 props
->snapshots
.packets
= notit
->snapshots
.packets
;
3177 props
->snapshots
.beginning_clock
= notit
->snapshots
.beginning_clock
;
3178 props
->snapshots
.end_clock
= notit
->snapshots
.end_clock
;
3185 void bt_msg_iter_set_emit_stream_beginning_message(struct bt_msg_iter
*notit
,
3188 notit
->emit_stream_begin_msg
= val
;
3192 void bt_msg_iter_set_emit_stream_end_message(struct bt_msg_iter
*notit
,
3195 notit
->emit_stream_end_msg
= val
;
3199 void bt_msg_iter_set_dry_run(struct bt_msg_iter
*notit
,
3202 notit
->dry_run
= val
;