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 "plugins/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 */
83 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
84 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
85 STATE_AFTER_TRACE_PACKET_HEADER
,
86 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
87 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
88 STATE_AFTER_STREAM_PACKET_CONTEXT
,
89 STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
,
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_SKIP_PACKET_PADDING
,
107 STATE_EMIT_MSG_PACKET_END_MULTI
,
108 STATE_EMIT_MSG_PACKET_END_SINGLE
,
109 STATE_CHECK_EMIT_MSG_STREAM_END
,
110 STATE_EMIT_MSG_STREAM_END
,
114 struct end_of_packet_snapshots
{
115 uint64_t discarded_events
;
117 uint64_t beginning_clock
;
121 /* CTF message iterator */
126 /* Current message iterator to create messages (weak) */
127 bt_self_message_iterator
*msg_iter
;
129 /* True to emit a stream beginning message. */
130 bool emit_stream_begin_msg
;
132 /* True to emit a stream end message. */
133 bool emit_stream_end_msg
;
135 /* True to set the stream */
139 * Current dynamic scope field pointer.
141 * This is set by read_dscope_begin_state() and contains the
142 * value of one of the pointers in `dscopes` below.
144 bt_field
*cur_dscope_field
;
147 * True if we're done filling a string field from a text
148 * array/sequence payload.
150 bool done_filling_string
;
152 /* Trace and classes */
153 /* True to set IR fields */
157 struct ctf_trace_class
*tc
;
158 struct ctf_stream_class
*sc
;
159 struct ctf_event_class
*ec
;
162 /* Current packet context field wrapper (NULL if not created yet) */
163 bt_packet_context_field
*packet_context_field
;
165 /* Current packet (NULL if not created yet) */
168 /* Current stream (NULL if not set yet) */
171 /* Current event (NULL if not created yet) */
174 /* Current event message (NULL if not created yet) */
175 bt_message
*event_msg
;
177 /* Database of current dynamic scopes */
179 bt_field
*stream_packet_context
;
180 bt_field
*event_common_context
;
181 bt_field
*event_spec_context
;
182 bt_field
*event_payload
;
188 /* Current medium buffer data */
190 /* Last address provided by medium */
193 /* Buffer size provided by medium (bytes) */
196 /* Offset within whole packet of addr (bits) */
197 size_t packet_offset
;
199 /* Current position from addr (bits) */
202 /* Position of the last event header from addr (bits) */
206 /* Binary type reader */
207 struct bt_bfcr
*bfcr
;
209 /* Current medium data */
211 struct bt_msg_iter_medium_ops medops
;
212 size_t max_request_sz
;
216 /* Current packet size (bits) (-1 if unknown) */
217 int64_t cur_exp_packet_total_size
;
219 /* Current content size (bits) (-1 if unknown) */
220 int64_t cur_exp_packet_content_size
;
222 /* Current stream class ID */
223 int64_t cur_stream_class_id
;
225 /* Current event class ID */
226 int64_t cur_event_class_id
;
228 /* Current data stream ID */
229 int64_t cur_data_stream_id
;
232 * Offset, in the underlying media, of the current packet's
233 * start (-1 if unknown).
235 off_t cur_packet_offset
;
237 /* Default clock's current value */
238 uint64_t default_clock_snapshot
;
240 /* End of current packet snapshots */
241 struct end_of_packet_snapshots snapshots
;
243 /* End of previous packet snapshots */
244 struct end_of_packet_snapshots prev_packet_snapshots
;
246 /* Stored values (for sequence lengths, variant tags) */
247 GArray
*stored_values
;
249 /* Iterator's current log level */
250 bt_logging_level log_level
;
252 /* Iterator's owning self component, or `NULL` if none (query) */
253 bt_self_component
*self_comp
;
257 const char *state_string(enum state state
)
262 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
263 return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
264 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
265 return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
266 case STATE_AFTER_TRACE_PACKET_HEADER
:
267 return "STATE_AFTER_TRACE_PACKET_HEADER";
268 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
269 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
270 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
271 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
272 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
273 return "STATE_AFTER_STREAM_PACKET_CONTEXT";
274 case STATE_EMIT_MSG_STREAM_BEGINNING
:
275 return "STATE_EMIT_MSG_STREAM_BEGINNING";
276 case STATE_EMIT_MSG_PACKET_BEGINNING
:
277 return "STATE_EMIT_MSG_PACKET_BEGINNING";
278 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
279 return "STATE_EMIT_MSG_DISCARDED_EVENTS";
280 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
281 return "STATE_EMIT_MSG_DISCARDED_PACKETS";
282 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
283 return "STATE_DSCOPE_EVENT_HEADER_BEGIN";
284 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
285 return "STATE_DSCOPE_EVENT_HEADER_CONTINUE";
286 case STATE_AFTER_EVENT_HEADER
:
287 return "STATE_AFTER_EVENT_HEADER";
288 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
289 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
290 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
291 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
292 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
293 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
294 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
295 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
296 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
297 return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
298 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
299 return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
300 case STATE_EMIT_MSG_EVENT
:
301 return "STATE_EMIT_MSG_EVENT";
302 case STATE_SKIP_PACKET_PADDING
:
303 return "STATE_SKIP_PACKET_PADDING";
304 case STATE_EMIT_MSG_PACKET_END_MULTI
:
305 return "STATE_EMIT_MSG_PACKET_END_MULTI";
306 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
307 return "STATE_EMIT_MSG_PACKET_END_SINGLE";
308 case STATE_EMIT_MSG_STREAM_END
:
309 return "STATE_EMIT_MSG_STREAM_END";
318 int bt_msg_iter_switch_packet(struct bt_msg_iter
*notit
);
321 struct stack
*stack_new(struct bt_msg_iter
*notit
)
323 struct stack
*stack
= NULL
;
325 stack
= g_new0(struct stack
, 1);
327 BT_COMP_LOGE_STR("Failed to allocate one stack.");
331 stack
->notit
= notit
;
332 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
333 if (!stack
->entries
) {
334 BT_COMP_LOGE_STR("Failed to allocate a GArray.");
338 BT_COMP_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit
, stack
);
350 void stack_destroy(struct stack
*stack
)
352 struct bt_msg_iter
*notit
;
355 notit
= stack
->notit
;
356 BT_COMP_LOGD("Destroying stack: addr=%p", stack
);
358 if (stack
->entries
) {
359 g_array_free(stack
->entries
, TRUE
);
366 void stack_push(struct stack
*stack
, bt_field
*base
)
368 struct stack_entry
*entry
;
369 struct bt_msg_iter
*notit
;
372 notit
= stack
->notit
;
374 BT_COMP_LOGT("Pushing base field on stack: stack-addr=%p, "
375 "stack-size-before=%zu, stack-size-after=%zu",
376 stack
, stack
->size
, stack
->size
+ 1);
378 if (stack
->entries
->len
== stack
->size
) {
379 g_array_set_size(stack
->entries
, stack
->size
+ 1);
382 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
389 unsigned int stack_size(struct stack
*stack
)
396 void stack_pop(struct stack
*stack
)
398 struct bt_msg_iter
*notit
;
401 BT_ASSERT(stack_size(stack
));
402 notit
= stack
->notit
;
403 BT_COMP_LOGT("Popping from stack: "
404 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
405 stack
, stack
->size
, stack
->size
- 1);
410 struct stack_entry
*stack_top(struct stack
*stack
)
413 BT_ASSERT(stack_size(stack
));
414 return &g_array_index(stack
->entries
, struct stack_entry
,
419 bool stack_empty(struct stack
*stack
)
421 return stack_size(stack
) == 0;
425 void stack_clear(struct stack
*stack
)
432 enum bt_msg_iter_status
msg_iter_status_from_m_status(
433 enum bt_msg_iter_medium_status m_status
)
435 /* They are the same */
436 return (int) m_status
;
440 size_t buf_size_bits(struct bt_msg_iter
*notit
)
442 return notit
->buf
.sz
* 8;
446 size_t buf_available_bits(struct bt_msg_iter
*notit
)
448 return buf_size_bits(notit
) - notit
->buf
.at
;
452 size_t packet_at(struct bt_msg_iter
*notit
)
454 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
458 void buf_consume_bits(struct bt_msg_iter
*notit
, size_t incr
)
460 BT_COMP_LOGT("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
461 notit
, notit
->buf
.at
, notit
->buf
.at
+ incr
);
462 notit
->buf
.at
+= incr
;
466 enum bt_msg_iter_status
request_medium_bytes(
467 struct bt_msg_iter
*notit
)
469 uint8_t *buffer_addr
= NULL
;
470 size_t buffer_sz
= 0;
471 enum bt_msg_iter_medium_status m_status
;
473 BT_COMP_LOGD("Calling user function (request bytes): notit-addr=%p, "
474 "request-size=%zu", notit
, notit
->medium
.max_request_sz
);
475 m_status
= notit
->medium
.medops
.request_bytes(
476 notit
->medium
.max_request_sz
, &buffer_addr
,
477 &buffer_sz
, notit
->medium
.data
);
478 BT_COMP_LOGD("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
479 bt_msg_iter_medium_status_string(m_status
),
480 buffer_addr
, buffer_sz
);
481 if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_OK
) {
482 BT_ASSERT(buffer_sz
!= 0);
484 /* New packet offset is old one + old size (in bits) */
485 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
487 /* Restart at the beginning of the new medium buffer */
489 notit
->buf
.last_eh_at
= SIZE_MAX
;
491 /* New medium buffer size */
492 notit
->buf
.sz
= buffer_sz
;
494 /* New medium buffer address */
495 notit
->buf
.addr
= buffer_addr
;
497 BT_COMP_LOGD("User function returned new bytes: "
498 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
499 notit
->buf
.packet_offset
, notit
->buf
.at
,
500 notit
->buf
.sz
, notit
->buf
.addr
);
501 BT_COMP_LOGD_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
503 } else if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
505 * User returned end of stream: validate that we're not
506 * in the middle of a packet header, packet context, or
509 if (notit
->cur_exp_packet_total_size
>= 0) {
510 if (packet_at(notit
) ==
511 notit
->cur_exp_packet_total_size
) {
515 if (packet_at(notit
) == 0) {
519 if (notit
->buf
.last_eh_at
!= SIZE_MAX
&&
520 notit
->buf
.at
== notit
->buf
.last_eh_at
) {
525 /* All other states are invalid */
526 BT_COMP_LOGW("User function returned %s, but message iterator is in an unexpected state: "
527 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
528 "packet-cur=%zu, last-eh-at=%zu",
529 bt_msg_iter_medium_status_string(m_status
),
530 state_string(notit
->state
),
531 notit
->cur_exp_packet_total_size
,
532 notit
->buf
.at
, packet_at(notit
),
533 notit
->buf
.last_eh_at
);
534 m_status
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
535 } else if (m_status
< 0) {
536 BT_COMP_LOGW("User function failed: status=%s",
537 bt_msg_iter_medium_status_string(m_status
));
541 return msg_iter_status_from_m_status(m_status
);
545 enum bt_msg_iter_status
buf_ensure_available_bits(
546 struct bt_msg_iter
*notit
)
548 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
550 if (G_UNLIKELY(buf_available_bits(notit
) == 0)) {
552 * This _cannot_ return BT_MSG_ITER_STATUS_OK
555 status
= request_medium_bytes(notit
);
562 enum bt_msg_iter_status
read_dscope_begin_state(
563 struct bt_msg_iter
*notit
,
564 struct ctf_field_class
*dscope_fc
,
565 enum state done_state
, enum state continue_state
,
566 bt_field
*dscope_field
)
568 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
569 enum bt_bfcr_status bfcr_status
;
570 size_t consumed_bits
;
572 notit
->cur_dscope_field
= dscope_field
;
573 BT_COMP_LOGT("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
574 notit
, notit
->bfcr
, dscope_fc
);
575 consumed_bits
= bt_bfcr_start(notit
->bfcr
, dscope_fc
,
576 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
577 notit
->buf
.sz
, &bfcr_status
);
578 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
580 switch (bfcr_status
) {
581 case BT_BFCR_STATUS_OK
:
582 /* Field class was read completely */
583 BT_COMP_LOGT_STR("Field was completely decoded.");
584 notit
->state
= done_state
;
586 case BT_BFCR_STATUS_EOF
:
587 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
588 notit
->state
= continue_state
;
591 BT_COMP_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
592 "status=%s", notit
, notit
->bfcr
,
593 bt_bfcr_status_string(bfcr_status
));
594 status
= BT_MSG_ITER_STATUS_ERROR
;
598 /* Consume bits now since we know we're not in an error state */
599 buf_consume_bits(notit
, consumed_bits
);
606 enum bt_msg_iter_status
read_dscope_continue_state(
607 struct bt_msg_iter
*notit
, enum state done_state
)
609 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
610 enum bt_bfcr_status bfcr_status
;
611 size_t consumed_bits
;
613 BT_COMP_LOGT("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
616 status
= buf_ensure_available_bits(notit
);
617 if (status
!= BT_MSG_ITER_STATUS_OK
) {
619 BT_COMP_LOGW("Cannot ensure that buffer has at least one byte: "
620 "msg-addr=%p, status=%s",
621 notit
, bt_msg_iter_status_string(status
));
623 BT_COMP_LOGT("Cannot ensure that buffer has at least one byte: "
624 "msg-addr=%p, status=%s",
625 notit
, bt_msg_iter_status_string(status
));
631 consumed_bits
= bt_bfcr_continue(notit
->bfcr
, notit
->buf
.addr
,
632 notit
->buf
.sz
, &bfcr_status
);
633 BT_COMP_LOGT("BFCR consumed bits: size=%zu", consumed_bits
);
635 switch (bfcr_status
) {
636 case BT_BFCR_STATUS_OK
:
637 /* Type was read completely. */
638 BT_COMP_LOGT_STR("Field was completely decoded.");
639 notit
->state
= done_state
;
641 case BT_BFCR_STATUS_EOF
:
642 /* Stay in this continue state. */
643 BT_COMP_LOGT_STR("BFCR needs more data to decode field completely.");
646 BT_COMP_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
647 "status=%s", notit
, notit
->bfcr
,
648 bt_bfcr_status_string(bfcr_status
));
649 status
= BT_MSG_ITER_STATUS_ERROR
;
653 /* Consume bits now since we know we're not in an error state. */
654 buf_consume_bits(notit
, consumed_bits
);
660 void release_event_dscopes(struct bt_msg_iter
*notit
)
662 notit
->dscopes
.event_common_context
= NULL
;
663 notit
->dscopes
.event_spec_context
= NULL
;
664 notit
->dscopes
.event_payload
= NULL
;
668 void release_all_dscopes(struct bt_msg_iter
*notit
)
670 notit
->dscopes
.stream_packet_context
= NULL
;
672 if (notit
->packet_context_field
) {
673 bt_packet_context_field_release(notit
->packet_context_field
);
674 notit
->packet_context_field
= NULL
;
677 release_event_dscopes(notit
);
681 enum bt_msg_iter_status
read_packet_header_begin_state(
682 struct bt_msg_iter
*notit
)
684 struct ctf_field_class
*packet_header_fc
= NULL
;
685 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
687 if (bt_msg_iter_switch_packet(notit
)) {
688 BT_COMP_LOGW("Cannot switch packet: notit-addr=%p", notit
);
689 ret
= BT_MSG_ITER_STATUS_ERROR
;
694 * Make sure at least one bit is available for this packet. An
695 * empty packet is impossible. If we reach the end of the medium
696 * at this point, then it's considered the end of the stream.
698 ret
= buf_ensure_available_bits(notit
);
700 case BT_MSG_ITER_STATUS_OK
:
702 case BT_MSG_ITER_STATUS_EOF
:
703 ret
= BT_MSG_ITER_STATUS_OK
;
704 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
710 /* Packet header class is common to the whole trace class. */
711 packet_header_fc
= notit
->meta
.tc
->packet_header_fc
;
712 if (!packet_header_fc
) {
713 notit
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
717 notit
->cur_stream_class_id
= -1;
718 notit
->cur_event_class_id
= -1;
719 notit
->cur_data_stream_id
= -1;
720 BT_COMP_LOGD("Decoding packet header field:"
721 "notit-addr=%p, trace-class-addr=%p, fc-addr=%p",
722 notit
, notit
->meta
.tc
, packet_header_fc
);
723 ret
= read_dscope_begin_state(notit
, packet_header_fc
,
724 STATE_AFTER_TRACE_PACKET_HEADER
,
725 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
727 BT_COMP_LOGW("Cannot decode packet header field: "
728 "notit-addr=%p, trace-class-addr=%p, "
730 notit
, notit
->meta
.tc
, packet_header_fc
);
738 enum bt_msg_iter_status
read_packet_header_continue_state(
739 struct bt_msg_iter
*notit
)
741 return read_dscope_continue_state(notit
,
742 STATE_AFTER_TRACE_PACKET_HEADER
);
746 enum bt_msg_iter_status
set_current_stream_class(struct bt_msg_iter
*notit
)
748 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
749 struct ctf_stream_class
*new_stream_class
= NULL
;
751 if (notit
->cur_stream_class_id
== -1) {
753 * No current stream class ID field, therefore only one
756 if (notit
->meta
.tc
->stream_classes
->len
!= 1) {
757 BT_COMP_LOGW("Need exactly one stream class since there's "
758 "no stream class ID field: "
759 "notit-addr=%p", notit
);
760 status
= BT_MSG_ITER_STATUS_ERROR
;
764 new_stream_class
= notit
->meta
.tc
->stream_classes
->pdata
[0];
765 notit
->cur_stream_class_id
= new_stream_class
->id
;
768 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
769 notit
->meta
.tc
, notit
->cur_stream_class_id
);
770 if (!new_stream_class
) {
771 BT_COMP_LOGW("No stream class with ID of stream class ID to use in trace class: "
772 "notit-addr=%p, stream-class-id=%" PRIu64
", "
773 "trace-class-addr=%p",
774 notit
, notit
->cur_stream_class_id
, notit
->meta
.tc
);
775 status
= BT_MSG_ITER_STATUS_ERROR
;
779 if (notit
->meta
.sc
) {
780 if (new_stream_class
!= notit
->meta
.sc
) {
781 BT_COMP_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
782 "notit-addr=%p, prev-stream-class-addr=%p, "
783 "prev-stream-class-id=%" PRId64
", "
784 "next-stream-class-addr=%p, "
785 "next-stream-class-id=%" PRId64
", "
787 notit
, notit
->meta
.sc
,
790 new_stream_class
->id
,
792 status
= BT_MSG_ITER_STATUS_ERROR
;
796 notit
->meta
.sc
= new_stream_class
;
799 BT_COMP_LOGD("Set current stream class: "
800 "notit-addr=%p, stream-class-addr=%p, "
801 "stream-class-id=%" PRId64
,
802 notit
, notit
->meta
.sc
, notit
->meta
.sc
->id
);
809 enum bt_msg_iter_status
set_current_stream(struct bt_msg_iter
*notit
)
811 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
812 bt_stream
*stream
= NULL
;
814 BT_COMP_LOGD("Calling user function (get stream): notit-addr=%p, "
815 "stream-class-addr=%p, stream-class-id=%" PRId64
,
816 notit
, notit
->meta
.sc
,
818 stream
= notit
->medium
.medops
.borrow_stream(
819 notit
->meta
.sc
->ir_sc
, notit
->cur_data_stream_id
,
821 bt_stream_get_ref(stream
);
822 BT_COMP_LOGD("User function returned: stream-addr=%p", stream
);
824 BT_COMP_LOGW_STR("User function failed to return a stream object "
825 "for the given stream class.");
826 status
= BT_MSG_ITER_STATUS_ERROR
;
830 if (notit
->stream
&& stream
!= notit
->stream
) {
831 BT_COMP_LOGW("User function returned a different stream than the "
832 "previous one for the same sequence of packets.");
833 status
= BT_MSG_ITER_STATUS_ERROR
;
837 BT_STREAM_MOVE_REF(notit
->stream
, stream
);
840 bt_stream_put_ref(stream
);
845 enum bt_msg_iter_status
set_current_packet(struct bt_msg_iter
*notit
)
847 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
848 bt_packet
*packet
= NULL
;
850 BT_COMP_LOGD("Creating packet for packet message: "
851 "notit-addr=%p", notit
);
852 BT_COMP_LOGD("Creating packet from stream: "
853 "notit-addr=%p, stream-addr=%p, "
854 "stream-class-addr=%p, "
855 "stream-class-id=%" PRId64
,
856 notit
, notit
->stream
, notit
->meta
.sc
,
860 BT_ASSERT(notit
->stream
);
861 packet
= bt_packet_create(notit
->stream
);
863 BT_COMP_LOGE("Cannot create packet from stream: "
864 "notit-addr=%p, stream-addr=%p, "
865 "stream-class-addr=%p, "
866 "stream-class-id=%" PRId64
,
867 notit
, notit
->stream
, notit
->meta
.sc
,
875 BT_PACKET_PUT_REF_AND_RESET(packet
);
876 status
= BT_MSG_ITER_STATUS_ERROR
;
879 BT_PACKET_MOVE_REF(notit
->packet
, packet
);
884 enum bt_msg_iter_status
after_packet_header_state(
885 struct bt_msg_iter
*notit
)
887 enum bt_msg_iter_status status
;
889 status
= set_current_stream_class(notit
);
890 if (status
!= BT_MSG_ITER_STATUS_OK
) {
894 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
901 enum bt_msg_iter_status
read_packet_context_begin_state(
902 struct bt_msg_iter
*notit
)
904 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
905 struct ctf_field_class
*packet_context_fc
;
907 BT_ASSERT(notit
->meta
.sc
);
908 packet_context_fc
= notit
->meta
.sc
->packet_context_fc
;
909 if (!packet_context_fc
) {
910 BT_COMP_LOGD("No packet packet context field class in stream class: continuing: "
911 "notit-addr=%p, stream-class-addr=%p, "
912 "stream-class-id=%" PRId64
,
913 notit
, notit
->meta
.sc
,
915 notit
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
919 BT_ASSERT(!notit
->packet_context_field
);
921 if (packet_context_fc
->in_ir
) {
923 * Create free packet context field from stream class.
924 * This field is going to be moved to the packet once we
925 * create it. We cannot create the packet now because a
926 * packet is created from a stream, and this API must be
927 * able to return the packet context properties without
929 * (bt_msg_iter_get_packet_properties()).
931 notit
->packet_context_field
=
932 bt_packet_context_field_create(
933 notit
->meta
.sc
->ir_sc
);
934 if (!notit
->packet_context_field
) {
935 BT_COMP_LOGE_STR("Cannot create packet context field wrapper from stream class.");
936 status
= BT_MSG_ITER_STATUS_ERROR
;
940 notit
->dscopes
.stream_packet_context
=
941 bt_packet_context_field_borrow_field(
942 notit
->packet_context_field
);
943 BT_ASSERT(notit
->dscopes
.stream_packet_context
);
946 BT_COMP_LOGD("Decoding packet context field: "
947 "notit-addr=%p, stream-class-addr=%p, "
948 "stream-class-id=%" PRId64
", fc-addr=%p",
949 notit
, notit
->meta
.sc
,
950 notit
->meta
.sc
->id
, packet_context_fc
);
951 status
= read_dscope_begin_state(notit
, packet_context_fc
,
952 STATE_AFTER_STREAM_PACKET_CONTEXT
,
953 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
954 notit
->dscopes
.stream_packet_context
);
956 BT_COMP_LOGW("Cannot decode packet context field: "
957 "notit-addr=%p, stream-class-addr=%p, "
958 "stream-class-id=%" PRId64
", fc-addr=%p",
959 notit
, notit
->meta
.sc
,
969 enum bt_msg_iter_status
read_packet_context_continue_state(
970 struct bt_msg_iter
*notit
)
972 return read_dscope_continue_state(notit
,
973 STATE_AFTER_STREAM_PACKET_CONTEXT
);
977 enum bt_msg_iter_status
set_current_packet_content_sizes(
978 struct bt_msg_iter
*notit
)
980 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
982 if (notit
->cur_exp_packet_total_size
== -1) {
983 if (notit
->cur_exp_packet_content_size
!= -1) {
984 notit
->cur_exp_packet_total_size
=
985 notit
->cur_exp_packet_content_size
;
988 if (notit
->cur_exp_packet_content_size
== -1) {
989 notit
->cur_exp_packet_content_size
=
990 notit
->cur_exp_packet_total_size
;
994 BT_ASSERT((notit
->cur_exp_packet_total_size
>= 0 &&
995 notit
->cur_exp_packet_content_size
>= 0) ||
996 (notit
->cur_exp_packet_total_size
< 0 &&
997 notit
->cur_exp_packet_content_size
< 0));
999 if (notit
->cur_exp_packet_content_size
>
1000 notit
->cur_exp_packet_total_size
) {
1001 BT_COMP_LOGW("Invalid packet or content size: "
1002 "content size is greater than packet size: "
1003 "notit-addr=%p, packet-context-field-addr=%p, "
1004 "packet-size=%" PRId64
", content-size=%" PRId64
,
1005 notit
, notit
->dscopes
.stream_packet_context
,
1006 notit
->cur_exp_packet_total_size
,
1007 notit
->cur_exp_packet_content_size
);
1008 status
= BT_MSG_ITER_STATUS_ERROR
;
1012 BT_COMP_LOGD("Set current packet and content sizes: "
1013 "notit-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1014 notit
, notit
->cur_exp_packet_total_size
,
1015 notit
->cur_exp_packet_content_size
);
1022 enum bt_msg_iter_status
after_packet_context_state(struct bt_msg_iter
*notit
)
1024 enum bt_msg_iter_status status
;
1026 status
= set_current_packet_content_sizes(notit
);
1027 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1031 if (notit
->stream
) {
1033 * Stream exists, which means we already emitted at
1034 * least one packet beginning message, so the initial
1035 * stream beginning message was also emitted.
1037 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1039 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
;
1047 enum bt_msg_iter_status
read_event_header_begin_state(struct bt_msg_iter
*notit
)
1049 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1050 struct ctf_field_class
*event_header_fc
= NULL
;
1052 /* Reset the position of the last event header */
1053 notit
->buf
.last_eh_at
= notit
->buf
.at
;
1054 notit
->cur_event_class_id
= -1;
1056 /* Check if we have some content left */
1057 if (notit
->cur_exp_packet_content_size
>= 0) {
1058 if (G_UNLIKELY(packet_at(notit
) ==
1059 notit
->cur_exp_packet_content_size
)) {
1060 /* No more events! */
1061 BT_COMP_LOGD("Reached end of packet: notit-addr=%p, "
1062 "cur=%zu", notit
, packet_at(notit
));
1063 notit
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1065 } else if (G_UNLIKELY(packet_at(notit
) >
1066 notit
->cur_exp_packet_content_size
)) {
1067 /* That's not supposed to happen */
1068 BT_COMP_LOGD("Before decoding event header field: cursor is passed the packet's content: "
1069 "notit-addr=%p, content-size=%" PRId64
", "
1071 notit
->cur_exp_packet_content_size
,
1073 status
= BT_MSG_ITER_STATUS_ERROR
;
1078 * "Infinite" content: we're done when the medium has
1079 * nothing else for us.
1081 status
= buf_ensure_available_bits(notit
);
1083 case BT_MSG_ITER_STATUS_OK
:
1085 case BT_MSG_ITER_STATUS_EOF
:
1086 status
= BT_MSG_ITER_STATUS_OK
;
1087 notit
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1094 release_event_dscopes(notit
);
1095 BT_ASSERT(notit
->meta
.sc
);
1096 event_header_fc
= notit
->meta
.sc
->event_header_fc
;
1097 if (!event_header_fc
) {
1098 notit
->state
= STATE_AFTER_EVENT_HEADER
;
1102 BT_COMP_LOGD("Decoding event header field: "
1103 "notit-addr=%p, stream-class-addr=%p, "
1104 "stream-class-id=%" PRId64
", "
1106 notit
, notit
->meta
.sc
,
1109 status
= read_dscope_begin_state(notit
, event_header_fc
,
1110 STATE_AFTER_EVENT_HEADER
,
1111 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1113 BT_COMP_LOGW("Cannot decode event header field: "
1114 "notit-addr=%p, stream-class-addr=%p, "
1115 "stream-class-id=%" PRId64
", fc-addr=%p",
1116 notit
, notit
->meta
.sc
,
1126 enum bt_msg_iter_status
read_event_header_continue_state(
1127 struct bt_msg_iter
*notit
)
1129 return read_dscope_continue_state(notit
,
1130 STATE_AFTER_EVENT_HEADER
);
1134 enum bt_msg_iter_status
set_current_event_class(struct bt_msg_iter
*notit
)
1136 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1138 struct ctf_event_class
*new_event_class
= NULL
;
1140 if (notit
->cur_event_class_id
== -1) {
1142 * No current event class ID field, therefore only one
1145 if (notit
->meta
.sc
->event_classes
->len
!= 1) {
1146 BT_COMP_LOGW("Need exactly one event class since there's "
1147 "no event class ID field: "
1148 "notit-addr=%p", notit
);
1149 status
= BT_MSG_ITER_STATUS_ERROR
;
1153 new_event_class
= notit
->meta
.sc
->event_classes
->pdata
[0];
1154 notit
->cur_event_class_id
= new_event_class
->id
;
1157 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1158 notit
->meta
.sc
, notit
->cur_event_class_id
);
1159 if (!new_event_class
) {
1160 BT_COMP_LOGW("No event class with ID of event class ID to use in stream class: "
1161 "notit-addr=%p, stream-class-id=%" PRIu64
", "
1162 "event-class-id=%" PRIu64
", "
1163 "trace-class-addr=%p",
1164 notit
, notit
->meta
.sc
->id
, notit
->cur_event_class_id
,
1166 status
= BT_MSG_ITER_STATUS_ERROR
;
1170 notit
->meta
.ec
= new_event_class
;
1171 BT_COMP_LOGD("Set current event class: "
1172 "notit-addr=%p, event-class-addr=%p, "
1173 "event-class-id=%" PRId64
", "
1174 "event-class-name=\"%s\"",
1175 notit
, notit
->meta
.ec
, notit
->meta
.ec
->id
,
1176 notit
->meta
.ec
->name
->str
);
1183 enum bt_msg_iter_status
set_current_event_message(
1184 struct bt_msg_iter
*notit
)
1186 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1187 bt_message
*msg
= NULL
;
1189 BT_ASSERT(notit
->meta
.ec
);
1190 BT_ASSERT(notit
->packet
);
1191 BT_COMP_LOGD("Creating event message from event class and packet: "
1192 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1193 notit
, notit
->meta
.ec
,
1194 notit
->meta
.ec
->name
->str
,
1196 BT_ASSERT(notit
->msg_iter
);
1197 BT_ASSERT(notit
->meta
.sc
);
1199 if (bt_stream_class_borrow_default_clock_class(notit
->meta
.sc
->ir_sc
)) {
1200 msg
= bt_message_event_create_with_packet_and_default_clock_snapshot(
1201 notit
->msg_iter
, notit
->meta
.ec
->ir_ec
,
1202 notit
->packet
, notit
->default_clock_snapshot
);
1204 msg
= bt_message_event_create_with_packet(notit
->msg_iter
,
1205 notit
->meta
.ec
->ir_ec
, notit
->packet
);
1209 BT_COMP_LOGE("Cannot create event message: "
1210 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1212 notit
, notit
->meta
.ec
,
1213 notit
->meta
.ec
->name
->str
,
1221 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1222 status
= BT_MSG_ITER_STATUS_ERROR
;
1225 BT_MESSAGE_MOVE_REF(notit
->event_msg
, msg
);
1230 enum bt_msg_iter_status
after_event_header_state(
1231 struct bt_msg_iter
*notit
)
1233 enum bt_msg_iter_status status
;
1235 status
= set_current_event_class(notit
);
1236 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1240 status
= set_current_event_message(notit
);
1241 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1245 notit
->event
= bt_message_event_borrow_event(
1247 BT_ASSERT(notit
->event
);
1248 notit
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1255 enum bt_msg_iter_status
read_event_common_context_begin_state(
1256 struct bt_msg_iter
*notit
)
1258 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1259 struct ctf_field_class
*event_common_context_fc
;
1261 event_common_context_fc
= notit
->meta
.sc
->event_common_context_fc
;
1262 if (!event_common_context_fc
) {
1263 notit
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1267 if (event_common_context_fc
->in_ir
) {
1268 BT_ASSERT(!notit
->dscopes
.event_common_context
);
1269 notit
->dscopes
.event_common_context
=
1270 bt_event_borrow_common_context_field(
1272 BT_ASSERT(notit
->dscopes
.event_common_context
);
1275 BT_COMP_LOGT("Decoding event common context field: "
1276 "notit-addr=%p, stream-class-addr=%p, "
1277 "stream-class-id=%" PRId64
", "
1279 notit
, notit
->meta
.sc
,
1281 event_common_context_fc
);
1282 status
= read_dscope_begin_state(notit
, event_common_context_fc
,
1283 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1284 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1285 notit
->dscopes
.event_common_context
);
1287 BT_COMP_LOGW("Cannot decode event common context field: "
1288 "notit-addr=%p, stream-class-addr=%p, "
1289 "stream-class-id=%" PRId64
", fc-addr=%p",
1290 notit
, notit
->meta
.sc
,
1292 event_common_context_fc
);
1300 enum bt_msg_iter_status
read_event_common_context_continue_state(
1301 struct bt_msg_iter
*notit
)
1303 return read_dscope_continue_state(notit
,
1304 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1308 enum bt_msg_iter_status
read_event_spec_context_begin_state(
1309 struct bt_msg_iter
*notit
)
1311 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1312 struct ctf_field_class
*event_spec_context_fc
;
1314 event_spec_context_fc
= notit
->meta
.ec
->spec_context_fc
;
1315 if (!event_spec_context_fc
) {
1316 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1320 if (event_spec_context_fc
->in_ir
) {
1321 BT_ASSERT(!notit
->dscopes
.event_spec_context
);
1322 notit
->dscopes
.event_spec_context
=
1323 bt_event_borrow_specific_context_field(
1325 BT_ASSERT(notit
->dscopes
.event_spec_context
);
1328 BT_COMP_LOGT("Decoding event specific context field: "
1329 "notit-addr=%p, event-class-addr=%p, "
1330 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1332 notit
, notit
->meta
.ec
,
1333 notit
->meta
.ec
->name
->str
,
1335 event_spec_context_fc
);
1336 status
= read_dscope_begin_state(notit
, event_spec_context_fc
,
1337 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1338 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1339 notit
->dscopes
.event_spec_context
);
1341 BT_COMP_LOGW("Cannot decode event specific context field: "
1342 "notit-addr=%p, event-class-addr=%p, "
1343 "event-class-name=\"%s\", "
1344 "event-class-id=%" PRId64
", fc-addr=%p",
1345 notit
, notit
->meta
.ec
,
1346 notit
->meta
.ec
->name
->str
,
1348 event_spec_context_fc
);
1356 enum bt_msg_iter_status
read_event_spec_context_continue_state(
1357 struct bt_msg_iter
*notit
)
1359 return read_dscope_continue_state(notit
,
1360 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1364 enum bt_msg_iter_status
read_event_payload_begin_state(
1365 struct bt_msg_iter
*notit
)
1367 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1368 struct ctf_field_class
*event_payload_fc
;
1370 event_payload_fc
= notit
->meta
.ec
->payload_fc
;
1371 if (!event_payload_fc
) {
1372 notit
->state
= STATE_EMIT_MSG_EVENT
;
1376 if (event_payload_fc
->in_ir
) {
1377 BT_ASSERT(!notit
->dscopes
.event_payload
);
1378 notit
->dscopes
.event_payload
=
1379 bt_event_borrow_payload_field(
1381 BT_ASSERT(notit
->dscopes
.event_payload
);
1384 BT_COMP_LOGT("Decoding event payload field: "
1385 "notit-addr=%p, event-class-addr=%p, "
1386 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1388 notit
, notit
->meta
.ec
,
1389 notit
->meta
.ec
->name
->str
,
1392 status
= read_dscope_begin_state(notit
, event_payload_fc
,
1393 STATE_EMIT_MSG_EVENT
,
1394 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1395 notit
->dscopes
.event_payload
);
1397 BT_COMP_LOGW("Cannot decode event payload field: "
1398 "notit-addr=%p, event-class-addr=%p, "
1399 "event-class-name=\"%s\", "
1400 "event-class-id=%" PRId64
", fc-addr=%p",
1401 notit
, notit
->meta
.ec
,
1402 notit
->meta
.ec
->name
->str
,
1412 enum bt_msg_iter_status
read_event_payload_continue_state(
1413 struct bt_msg_iter
*notit
)
1415 return read_dscope_continue_state(notit
, STATE_EMIT_MSG_EVENT
);
1419 enum bt_msg_iter_status
skip_packet_padding_state(struct bt_msg_iter
*notit
)
1421 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1422 size_t bits_to_skip
;
1424 BT_ASSERT(notit
->cur_exp_packet_total_size
> 0);
1425 bits_to_skip
= notit
->cur_exp_packet_total_size
- packet_at(notit
);
1426 if (bits_to_skip
== 0) {
1427 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1430 size_t bits_to_consume
;
1432 BT_COMP_LOGD("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1433 bits_to_skip
, notit
, bits_to_skip
);
1434 status
= buf_ensure_available_bits(notit
);
1435 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1439 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1440 BT_COMP_LOGD("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1441 bits_to_consume
, notit
, bits_to_consume
);
1442 buf_consume_bits(notit
, bits_to_consume
);
1443 bits_to_skip
= notit
->cur_exp_packet_total_size
-
1445 if (bits_to_skip
== 0) {
1446 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1456 enum bt_msg_iter_status
check_emit_msg_stream_beginning_state(
1457 struct bt_msg_iter
*notit
)
1459 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1461 if (notit
->set_stream
) {
1462 status
= set_current_stream(notit
);
1463 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1468 if (notit
->emit_stream_begin_msg
) {
1469 notit
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1471 /* Stream's first packet */
1472 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1480 enum bt_msg_iter_status
check_emit_msg_discarded_events(
1481 struct bt_msg_iter
*notit
)
1483 notit
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1485 if (!notit
->meta
.sc
->has_discarded_events
) {
1486 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1490 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1491 if (notit
->snapshots
.discarded_events
== 0 ||
1492 notit
->snapshots
.discarded_events
== UINT64_C(-1)) {
1494 * Stream's first packet with no discarded
1495 * events or no information about discarded
1496 * events: do not emit.
1498 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1502 * If the previous packet has a value for this counter,
1503 * then this counter is defined for the whole stream.
1505 BT_ASSERT(notit
->snapshots
.discarded_events
!= UINT64_C(-1));
1507 if (notit
->snapshots
.discarded_events
-
1508 notit
->prev_packet_snapshots
.discarded_events
== 0) {
1510 * No discarded events since previous packet: do
1513 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1518 return BT_MSG_ITER_STATUS_OK
;
1522 enum bt_msg_iter_status
check_emit_msg_discarded_packets(
1523 struct bt_msg_iter
*notit
)
1525 notit
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1527 if (!notit
->meta
.sc
->has_discarded_packets
) {
1528 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1532 if (notit
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1534 * Stream's first packet or no information about
1535 * discarded packets: do not emit. In other words, if
1536 * this is the first packet and its sequence number is
1537 * not 0, do not consider that packets were previously
1538 * lost: we might be reading a partial stream (LTTng
1539 * snapshot for example).
1541 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1544 * If the previous packet has a value for this counter,
1545 * then this counter is defined for the whole stream.
1547 BT_ASSERT(notit
->snapshots
.packets
!= UINT64_C(-1));
1549 if (notit
->snapshots
.packets
-
1550 notit
->prev_packet_snapshots
.packets
<= 1) {
1552 * No discarded packets since previous packet:
1555 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1560 return BT_MSG_ITER_STATUS_OK
;
1564 enum bt_msg_iter_status
check_emit_msg_stream_end(
1565 struct bt_msg_iter
*notit
)
1567 if (notit
->emit_stream_end_msg
) {
1568 notit
->state
= STATE_EMIT_MSG_STREAM_END
;
1570 notit
->state
= STATE_DONE
;
1573 return BT_MSG_ITER_STATUS_OK
;
1577 enum bt_msg_iter_status
handle_state(struct bt_msg_iter
*notit
)
1579 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1580 const enum state state
= notit
->state
;
1582 BT_COMP_LOGT("Handling state: notit-addr=%p, state=%s",
1583 notit
, state_string(state
));
1585 // TODO: optimalize!
1588 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1590 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1591 status
= read_packet_header_begin_state(notit
);
1593 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1594 status
= read_packet_header_continue_state(notit
);
1596 case STATE_AFTER_TRACE_PACKET_HEADER
:
1597 status
= after_packet_header_state(notit
);
1599 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1600 status
= read_packet_context_begin_state(notit
);
1602 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1603 status
= read_packet_context_continue_state(notit
);
1605 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1606 status
= after_packet_context_state(notit
);
1608 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
1609 status
= check_emit_msg_stream_beginning_state(notit
);
1611 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1612 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1614 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1615 status
= check_emit_msg_discarded_events(notit
);
1617 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1618 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1620 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1621 status
= check_emit_msg_discarded_packets(notit
);
1623 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1624 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1626 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1627 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1629 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1630 status
= read_event_header_begin_state(notit
);
1632 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1633 status
= read_event_header_continue_state(notit
);
1635 case STATE_AFTER_EVENT_HEADER
:
1636 status
= after_event_header_state(notit
);
1638 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1639 status
= read_event_common_context_begin_state(notit
);
1641 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1642 status
= read_event_common_context_continue_state(notit
);
1644 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1645 status
= read_event_spec_context_begin_state(notit
);
1647 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1648 status
= read_event_spec_context_continue_state(notit
);
1650 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1651 status
= read_event_payload_begin_state(notit
);
1653 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1654 status
= read_event_payload_continue_state(notit
);
1656 case STATE_EMIT_MSG_EVENT
:
1657 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1659 case STATE_SKIP_PACKET_PADDING
:
1660 status
= skip_packet_padding_state(notit
);
1662 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1663 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1665 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1666 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_END
;
1668 case STATE_CHECK_EMIT_MSG_STREAM_END
:
1669 status
= check_emit_msg_stream_end(notit
);
1671 case STATE_EMIT_MSG_STREAM_END
:
1672 notit
->state
= STATE_DONE
;
1677 BT_COMP_LOGF("Unknown CTF plugin message iterator state: "
1678 "notit-addr=%p, state=%d", notit
, notit
->state
);
1682 BT_COMP_LOGT("Handled state: notit-addr=%p, status=%s, "
1683 "prev-state=%s, cur-state=%s",
1684 notit
, bt_msg_iter_status_string(status
),
1685 state_string(state
), state_string(notit
->state
));
1690 void bt_msg_iter_reset_for_next_stream_file(struct bt_msg_iter
*notit
)
1693 BT_COMP_LOGD("Resetting message iterator: addr=%p", notit
);
1694 stack_clear(notit
->stack
);
1695 notit
->meta
.sc
= NULL
;
1696 notit
->meta
.ec
= NULL
;
1697 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
1698 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
1699 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
1700 release_all_dscopes(notit
);
1701 notit
->cur_dscope_field
= NULL
;
1703 if (notit
->packet_context_field
) {
1704 bt_packet_context_field_release(notit
->packet_context_field
);
1705 notit
->packet_context_field
= NULL
;
1708 notit
->buf
.addr
= NULL
;
1711 notit
->buf
.last_eh_at
= SIZE_MAX
;
1712 notit
->buf
.packet_offset
= 0;
1713 notit
->state
= STATE_INIT
;
1714 notit
->cur_exp_packet_content_size
= -1;
1715 notit
->cur_exp_packet_total_size
= -1;
1716 notit
->cur_packet_offset
= -1;
1717 notit
->cur_event_class_id
= -1;
1718 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1719 notit
->snapshots
.end_clock
= UINT64_C(-1);
1723 * Resets the internal state of a CTF message iterator.
1726 void bt_msg_iter_reset(struct bt_msg_iter
*notit
)
1728 bt_msg_iter_reset_for_next_stream_file(notit
);
1729 notit
->cur_stream_class_id
= -1;
1730 notit
->cur_data_stream_id
= -1;
1731 notit
->emit_stream_begin_msg
= true;
1732 notit
->emit_stream_end_msg
= true;
1733 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1734 notit
->snapshots
.packets
= UINT64_C(-1);
1735 notit
->prev_packet_snapshots
.discarded_events
= UINT64_C(-1);
1736 notit
->prev_packet_snapshots
.packets
= UINT64_C(-1);
1737 notit
->prev_packet_snapshots
.beginning_clock
= UINT64_C(-1);
1738 notit
->prev_packet_snapshots
.end_clock
= UINT64_C(-1);
1742 int bt_msg_iter_switch_packet(struct bt_msg_iter
*notit
)
1747 * We don't put the stream class here because we need to make
1748 * sure that all the packets processed by the same message
1749 * iterator refer to the same stream class (the first one).
1753 if (notit
->cur_exp_packet_total_size
!= -1) {
1754 notit
->cur_packet_offset
+= notit
->cur_exp_packet_total_size
;
1757 BT_COMP_LOGD("Switching packet: notit-addr=%p, cur=%zu, "
1758 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
1759 notit
->cur_packet_offset
);
1760 stack_clear(notit
->stack
);
1761 notit
->meta
.ec
= NULL
;
1762 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
1763 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
1764 release_all_dscopes(notit
);
1765 notit
->cur_dscope_field
= NULL
;
1768 * Adjust current buffer so that addr points to the beginning of the new
1771 if (notit
->buf
.addr
) {
1772 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1774 /* Packets are assumed to start on a byte frontier. */
1775 if (notit
->buf
.at
% CHAR_BIT
) {
1776 BT_COMP_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1777 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
1782 notit
->buf
.addr
+= consumed_bytes
;
1783 notit
->buf
.sz
-= consumed_bytes
;
1785 notit
->buf
.packet_offset
= 0;
1786 BT_COMP_LOGD("Adjusted buffer: addr=%p, size=%zu",
1787 notit
->buf
.addr
, notit
->buf
.sz
);
1790 notit
->cur_exp_packet_content_size
= -1;
1791 notit
->cur_exp_packet_total_size
= -1;
1792 notit
->cur_stream_class_id
= -1;
1793 notit
->cur_event_class_id
= -1;
1794 notit
->cur_data_stream_id
= -1;
1795 notit
->prev_packet_snapshots
= notit
->snapshots
;
1796 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1797 notit
->snapshots
.packets
= UINT64_C(-1);
1798 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1799 notit
->snapshots
.end_clock
= UINT64_C(-1);
1806 bt_field
*borrow_next_field(struct bt_msg_iter
*notit
)
1808 bt_field
*next_field
= NULL
;
1809 bt_field
*base_field
;
1810 const bt_field_class
*base_fc
;
1813 BT_ASSERT(!stack_empty(notit
->stack
));
1814 index
= stack_top(notit
->stack
)->index
;
1815 base_field
= stack_top(notit
->stack
)->base
;
1816 BT_ASSERT(base_field
);
1817 base_fc
= bt_field_borrow_class_const(base_field
);
1820 switch (bt_field_class_get_type(base_fc
)) {
1821 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1824 bt_field_class_structure_get_member_count(
1825 bt_field_borrow_class_const(
1828 bt_field_structure_borrow_member_field_by_index(
1832 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1833 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1834 BT_ASSERT(index
< bt_field_array_get_length(base_field
));
1835 next_field
= bt_field_array_borrow_element_field_by_index(
1838 case BT_FIELD_CLASS_TYPE_VARIANT
:
1839 BT_ASSERT(index
== 0);
1840 next_field
= bt_field_variant_borrow_selected_option_field(
1847 BT_ASSERT(next_field
);
1852 void update_default_clock(struct bt_msg_iter
*notit
, uint64_t new_val
,
1853 uint64_t new_val_size
)
1855 uint64_t new_val_mask
;
1856 uint64_t cur_value_masked
;
1858 BT_ASSERT(new_val_size
> 0);
1861 * Special case for a 64-bit new value, which is the limit
1862 * of a clock value as of this version: overwrite the
1863 * current value directly.
1865 if (new_val_size
== 64) {
1866 notit
->default_clock_snapshot
= new_val
;
1870 new_val_mask
= (1ULL << new_val_size
) - 1;
1871 cur_value_masked
= notit
->default_clock_snapshot
& new_val_mask
;
1873 if (new_val
< cur_value_masked
) {
1875 * It looks like a wrap happened on the number of bits
1876 * of the requested new value. Assume that the clock
1877 * value wrapped only one time.
1879 notit
->default_clock_snapshot
+= new_val_mask
+ 1;
1882 /* Clear the low bits of the current clock value. */
1883 notit
->default_clock_snapshot
&= ~new_val_mask
;
1885 /* Set the low bits of the current clock value. */
1886 notit
->default_clock_snapshot
|= new_val
;
1889 BT_COMP_LOGT("Updated default clock's value from integer field's value: "
1890 "value=%" PRIu64
, notit
->default_clock_snapshot
);
1894 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1895 struct ctf_field_class
*fc
, void *data
)
1897 struct bt_msg_iter
*notit
= data
;
1898 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1899 bt_field
*field
= NULL
;
1900 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1902 BT_COMP_LOGT("Unsigned integer function called from BFCR: "
1903 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1904 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1905 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1907 if (G_LIKELY(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1908 goto update_def_clock
;
1911 switch (int_fc
->meaning
) {
1912 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1913 notit
->cur_event_class_id
= value
;
1915 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1916 notit
->cur_data_stream_id
= value
;
1918 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1919 notit
->snapshots
.beginning_clock
= value
;
1921 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1922 notit
->snapshots
.end_clock
= value
;
1924 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1925 notit
->cur_stream_class_id
= value
;
1927 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1928 if (value
!= 0xc1fc1fc1) {
1929 BT_COMP_LOGW("Invalid CTF magic number: notit-addr=%p, "
1930 "magic=%" PRIx64
, notit
, value
);
1931 status
= BT_BFCR_STATUS_ERROR
;
1936 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1937 notit
->snapshots
.packets
= value
;
1939 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1940 notit
->snapshots
.discarded_events
= value
;
1942 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1943 notit
->cur_exp_packet_total_size
= value
;
1945 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1946 notit
->cur_exp_packet_content_size
= value
;
1953 if (G_UNLIKELY(int_fc
->mapped_clock_class
)) {
1954 update_default_clock(notit
, value
, int_fc
->base
.size
);
1957 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
1958 g_array_index(notit
->stored_values
, uint64_t,
1959 (uint64_t) int_fc
->storing_index
) = value
;
1962 if (G_UNLIKELY(!fc
->in_ir
)) {
1966 field
= borrow_next_field(notit
);
1968 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1969 BT_ASSERT(bt_field_get_class_type(field
) ==
1970 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
1971 bt_field_get_class_type(field
) ==
1972 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
);
1973 bt_field_unsigned_integer_set_value(field
, value
);
1974 stack_top(notit
->stack
)->index
++;
1981 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
1982 struct ctf_field_class
*fc
, void *data
)
1985 struct bt_msg_iter
*notit
= data
;
1986 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1987 bt_field
*string_field
= NULL
;
1988 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1989 char str
[2] = {'\0', '\0'};
1991 BT_COMP_LOGT("Unsigned integer character function called from BFCR: "
1992 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1993 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1994 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1995 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1996 BT_ASSERT(!int_fc
->mapped_clock_class
);
1997 BT_ASSERT(int_fc
->storing_index
< 0);
1999 if (G_UNLIKELY(!fc
->in_ir
)) {
2003 if (notit
->done_filling_string
) {
2008 notit
->done_filling_string
= true;
2012 string_field
= stack_top(notit
->stack
)->base
;
2013 BT_ASSERT(bt_field_get_class_type(string_field
) ==
2014 BT_FIELD_CLASS_TYPE_STRING
);
2016 /* Append character */
2017 str
[0] = (char) value
;
2018 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
2020 BT_COMP_LOGE("Cannot append character to string field's value: "
2021 "notit-addr=%p, field-addr=%p, ret=%d",
2022 notit
, string_field
, ret
);
2023 status
= BT_BFCR_STATUS_ERROR
;
2032 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
2033 struct ctf_field_class
*fc
, void *data
)
2035 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2036 bt_field
*field
= NULL
;
2037 struct bt_msg_iter
*notit
= data
;
2038 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2040 BT_COMP_LOGT("Signed integer function called from BFCR: "
2041 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2042 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
2043 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2044 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2046 if (G_UNLIKELY(int_fc
->storing_index
>= 0)) {
2047 g_array_index(notit
->stored_values
, uint64_t,
2048 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
2051 if (G_UNLIKELY(!fc
->in_ir
)) {
2055 field
= borrow_next_field(notit
);
2057 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2058 BT_ASSERT(bt_field_get_class_type(field
) ==
2059 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
2060 bt_field_get_class_type(field
) ==
2061 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
);
2062 bt_field_signed_integer_set_value(field
, value
);
2063 stack_top(notit
->stack
)->index
++;
2070 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
2071 struct ctf_field_class
*fc
, void *data
)
2073 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2074 bt_field
*field
= NULL
;
2075 struct bt_msg_iter
*notit
= data
;
2077 BT_COMP_LOGT("Floating point number function called from BFCR: "
2078 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2079 "fc-type=%d, fc-in-ir=%d, value=%f",
2080 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2082 if (G_UNLIKELY(!fc
->in_ir
)) {
2086 field
= borrow_next_field(notit
);
2088 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2089 BT_ASSERT(bt_field_get_class_type(field
) ==
2090 BT_FIELD_CLASS_TYPE_REAL
);
2091 bt_field_real_set_value(field
, value
);
2092 stack_top(notit
->stack
)->index
++;
2099 enum bt_bfcr_status
bfcr_string_begin_cb(
2100 struct ctf_field_class
*fc
, void *data
)
2102 bt_field
*field
= NULL
;
2103 struct bt_msg_iter
*notit
= data
;
2105 BT_COMP_LOGT("String (beginning) function called from BFCR: "
2106 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2107 "fc-type=%d, fc-in-ir=%d",
2108 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2110 if (G_UNLIKELY(!fc
->in_ir
)) {
2114 field
= borrow_next_field(notit
);
2116 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2117 BT_ASSERT(bt_field_get_class_type(field
) ==
2118 BT_FIELD_CLASS_TYPE_STRING
);
2119 bt_field_string_clear(field
);
2122 * Push on stack. Not a compound class per se, but we know that
2123 * only bfcr_string_cb() may be called between this call and a
2124 * subsequent call to bfcr_string_end_cb().
2126 stack_push(notit
->stack
, field
);
2129 return BT_BFCR_STATUS_OK
;
2133 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2134 size_t len
, struct ctf_field_class
*fc
, void *data
)
2136 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2137 bt_field
*field
= NULL
;
2138 struct bt_msg_iter
*notit
= data
;
2141 BT_COMP_LOGT("String (substring) function called from BFCR: "
2142 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2143 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2144 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2147 if (G_UNLIKELY(!fc
->in_ir
)) {
2151 field
= stack_top(notit
->stack
)->base
;
2154 /* Append current substring */
2155 ret
= bt_field_string_append_with_length(field
, value
, len
);
2157 BT_COMP_LOGE("Cannot append substring to string field's value: "
2158 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2159 "ret=%d", notit
, field
, len
, ret
);
2160 status
= BT_BFCR_STATUS_ERROR
;
2169 enum bt_bfcr_status
bfcr_string_end_cb(
2170 struct ctf_field_class
*fc
, void *data
)
2172 struct bt_msg_iter
*notit
= data
;
2174 BT_COMP_LOGT("String (end) function called from BFCR: "
2175 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2176 "fc-type=%d, fc-in-ir=%d",
2177 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2179 if (G_UNLIKELY(!fc
->in_ir
)) {
2183 /* Pop string field */
2184 stack_pop(notit
->stack
);
2186 /* Go to next field */
2187 stack_top(notit
->stack
)->index
++;
2190 return BT_BFCR_STATUS_OK
;
2193 enum bt_bfcr_status
bfcr_compound_begin_cb(
2194 struct ctf_field_class
*fc
, void *data
)
2196 struct bt_msg_iter
*notit
= data
;
2199 BT_COMP_LOGT("Compound (beginning) function called from BFCR: "
2200 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2201 "fc-type=%d, fc-in-ir=%d",
2202 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2209 if (stack_empty(notit
->stack
)) {
2210 /* Root: already set by read_dscope_begin_state() */
2211 field
= notit
->cur_dscope_field
;
2213 field
= borrow_next_field(notit
);
2219 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2220 stack_push(notit
->stack
, field
);
2223 * Change BFCR "unsigned int" callback if it's a text
2226 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2227 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2228 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2230 if (array_fc
->is_text
) {
2231 BT_ASSERT(bt_field_get_class_type(field
) ==
2232 BT_FIELD_CLASS_TYPE_STRING
);
2233 notit
->done_filling_string
= false;
2234 bt_field_string_clear(field
);
2235 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2236 bfcr_unsigned_int_char_cb
);
2241 return BT_BFCR_STATUS_OK
;
2244 enum bt_bfcr_status
bfcr_compound_end_cb(
2245 struct ctf_field_class
*fc
, void *data
)
2247 struct bt_msg_iter
*notit
= data
;
2249 BT_COMP_LOGT("Compound (end) function called from BFCR: "
2250 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2251 "fc-type=%d, fc-in-ir=%d",
2252 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2258 BT_ASSERT(!stack_empty(notit
->stack
));
2259 BT_ASSERT(bt_field_borrow_class_const(stack_top(notit
->stack
)->base
) ==
2263 * Reset BFCR "unsigned int" callback if it's a text
2266 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2267 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2268 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2270 if (array_fc
->is_text
) {
2271 BT_ASSERT(bt_field_get_class_type(
2272 stack_top(notit
->stack
)->base
) ==
2273 BT_FIELD_CLASS_TYPE_STRING
);
2274 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2275 bfcr_unsigned_int_cb
);
2280 stack_pop(notit
->stack
);
2282 /* If the stack is not empty, increment the base's index */
2283 if (!stack_empty(notit
->stack
)) {
2284 stack_top(notit
->stack
)->index
++;
2288 return BT_BFCR_STATUS_OK
;
2292 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2294 bt_field
*seq_field
;
2295 struct bt_msg_iter
*notit
= data
;
2296 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2297 int64_t length
= -1;
2300 length
= (uint64_t) g_array_index(notit
->stored_values
, uint64_t,
2301 seq_fc
->stored_length_index
);
2302 seq_field
= stack_top(notit
->stack
)->base
;
2303 BT_ASSERT(seq_field
);
2306 * bfcr_get_sequence_length_cb() also gets called back for a
2307 * text sequence, but the destination field is a string field.
2308 * Only set the field's sequence length if the destination field
2309 * is a sequence field.
2311 if (!seq_fc
->base
.is_text
) {
2312 BT_ASSERT(bt_field_get_class_type(seq_field
) ==
2313 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
);
2314 ret
= bt_field_dynamic_array_set_length(seq_field
,
2317 BT_COMP_LOGE("Cannot set dynamic array field's length field: "
2318 "notit-addr=%p, field-addr=%p, "
2319 "length=%" PRIu64
, notit
, seq_field
, length
);
2327 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2328 struct ctf_field_class
*fc
, void *data
)
2332 int64_t option_index
= -1;
2333 struct bt_msg_iter
*notit
= data
;
2334 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2335 struct ctf_named_field_class
*selected_option
= NULL
;
2336 struct ctf_field_class
*ret_fc
= NULL
;
2342 /* Get variant's tag */
2343 tag
.u
= g_array_index(notit
->stored_values
, uint64_t,
2344 var_fc
->stored_tag_index
);
2347 * Check each range to find the selected option's index.
2349 if (var_fc
->tag_fc
->base
.is_signed
) {
2350 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2351 struct ctf_field_class_variant_range
*range
=
2352 ctf_field_class_variant_borrow_range_by_index(
2355 if (tag
.i
>= range
->range
.lower
.i
&&
2356 tag
.i
<= range
->range
.upper
.i
) {
2357 option_index
= (int64_t) range
->option_index
;
2362 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2363 struct ctf_field_class_variant_range
*range
=
2364 ctf_field_class_variant_borrow_range_by_index(
2367 if (tag
.u
>= range
->range
.lower
.u
&&
2368 tag
.u
<= range
->range
.upper
.u
) {
2369 option_index
= (int64_t) range
->option_index
;
2375 if (option_index
< 0) {
2376 BT_COMP_LOGW("Cannot find variant field class's option: "
2377 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2378 "i-tag=%" PRId64
, notit
, var_fc
, tag
.u
, tag
.i
);
2382 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2383 var_fc
, (uint64_t) option_index
);
2385 if (selected_option
->fc
->in_ir
) {
2386 bt_field
*var_field
= stack_top(notit
->stack
)->base
;
2388 ret
= bt_field_variant_select_option_field(
2389 var_field
, option_index
);
2391 BT_COMP_LOGW("Cannot select variant field's option field: "
2392 "notit-addr=%p, var-field-addr=%p, "
2393 "opt-index=%" PRId64
, notit
, var_field
,
2399 ret_fc
= selected_option
->fc
;
2406 void create_msg_stream_beginning(struct bt_msg_iter
*notit
,
2407 bt_message
**message
)
2409 bt_message
*ret
= NULL
;
2411 BT_ASSERT(notit
->stream
);
2412 BT_ASSERT(notit
->msg_iter
);
2413 ret
= bt_message_stream_beginning_create(notit
->msg_iter
,
2416 BT_COMP_LOGE("Cannot create stream beginning message: "
2417 "notit-addr=%p, stream-addr=%p",
2418 notit
, notit
->stream
);
2426 void create_msg_stream_end(struct bt_msg_iter
*notit
, bt_message
**message
)
2430 if (!notit
->stream
) {
2431 BT_COMP_LOGE("Cannot create stream for stream message: "
2432 "notit-addr=%p", notit
);
2436 BT_ASSERT(notit
->msg_iter
);
2437 ret
= bt_message_stream_end_create(notit
->msg_iter
,
2440 BT_COMP_LOGE("Cannot create stream end message: "
2441 "notit-addr=%p, stream-addr=%p",
2442 notit
, notit
->stream
);
2450 void create_msg_packet_beginning(struct bt_msg_iter
*notit
,
2451 bt_message
**message
)
2454 enum bt_msg_iter_status status
;
2455 bt_message
*msg
= NULL
;
2456 const bt_stream_class
*sc
;
2458 status
= set_current_packet(notit
);
2459 if (status
!= BT_MSG_ITER_STATUS_OK
) {
2463 BT_ASSERT(notit
->packet
);
2464 sc
= notit
->meta
.sc
->ir_sc
;
2467 if (notit
->packet_context_field
) {
2468 ret
= bt_packet_move_context_field(
2469 notit
->packet
, notit
->packet_context_field
);
2474 notit
->packet_context_field
= NULL
;
2477 * At this point notit->dscopes.stream_packet_context
2478 * has the same value as the packet context field within
2481 BT_ASSERT(bt_packet_borrow_context_field(
2483 notit
->dscopes
.stream_packet_context
);
2486 BT_ASSERT(notit
->msg_iter
);
2488 if (notit
->meta
.sc
->packets_have_ts_begin
) {
2489 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2490 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2491 notit
->msg_iter
, notit
->packet
,
2492 notit
->snapshots
.beginning_clock
);
2494 msg
= bt_message_packet_beginning_create(notit
->msg_iter
,
2499 BT_COMP_LOGE("Cannot create packet beginning message: "
2500 "notit-addr=%p, packet-addr=%p",
2501 notit
, notit
->packet
);
2512 void create_msg_packet_end(struct bt_msg_iter
*notit
, bt_message
**message
)
2516 if (!notit
->packet
) {
2520 /* Update default clock from packet's end time */
2521 if (notit
->snapshots
.end_clock
!= UINT64_C(-1)) {
2522 notit
->default_clock_snapshot
= notit
->snapshots
.end_clock
;
2525 BT_ASSERT(notit
->msg_iter
);
2527 if (notit
->meta
.sc
->packets_have_ts_end
) {
2528 BT_ASSERT(notit
->snapshots
.end_clock
!= UINT64_C(-1));
2529 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2530 notit
->msg_iter
, notit
->packet
,
2531 notit
->snapshots
.end_clock
);
2533 msg
= bt_message_packet_end_create(notit
->msg_iter
,
2538 BT_COMP_LOGE("Cannot create packet end message: "
2539 "notit-addr=%p, packet-addr=%p",
2540 notit
, notit
->packet
);
2545 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2550 void create_msg_discarded_events(struct bt_msg_iter
*notit
,
2551 bt_message
**message
)
2554 uint64_t beginning_raw_value
= UINT64_C(-1);
2555 uint64_t end_raw_value
= UINT64_C(-1);
2557 BT_ASSERT(notit
->msg_iter
);
2558 BT_ASSERT(notit
->stream
);
2559 BT_ASSERT(notit
->meta
.sc
->has_discarded_events
);
2561 if (notit
->meta
.sc
->discarded_events_have_default_cs
) {
2562 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2564 * We discarded events, but before (and possibly
2565 * including) the current packet: use this packet's time
2566 * range, and do not have a specific count.
2568 beginning_raw_value
= notit
->snapshots
.beginning_clock
;
2569 end_raw_value
= notit
->snapshots
.end_clock
;
2571 beginning_raw_value
= notit
->prev_packet_snapshots
.end_clock
;
2572 end_raw_value
= notit
->snapshots
.end_clock
;
2575 BT_ASSERT(beginning_raw_value
!= UINT64_C(-1));
2576 BT_ASSERT(end_raw_value
!= UINT64_C(-1));
2577 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2578 notit
->msg_iter
, notit
->stream
, beginning_raw_value
,
2581 msg
= bt_message_discarded_events_create(notit
->msg_iter
,
2586 BT_COMP_LOGE("Cannot create discarded events message: "
2587 "notit-addr=%p, stream-addr=%p",
2588 notit
, notit
->stream
);
2592 if (notit
->prev_packet_snapshots
.discarded_events
!= UINT64_C(-1)) {
2593 bt_message_discarded_events_set_count(msg
,
2594 notit
->snapshots
.discarded_events
-
2595 notit
->prev_packet_snapshots
.discarded_events
);
2602 void create_msg_discarded_packets(struct bt_msg_iter
*notit
,
2603 bt_message
**message
)
2607 BT_ASSERT(notit
->msg_iter
);
2608 BT_ASSERT(notit
->stream
);
2609 BT_ASSERT(notit
->meta
.sc
->has_discarded_packets
);
2610 BT_ASSERT(notit
->prev_packet_snapshots
.packets
!=
2613 if (notit
->meta
.sc
->discarded_packets_have_default_cs
) {
2614 BT_ASSERT(notit
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1));
2615 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2616 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2617 notit
->msg_iter
, notit
->stream
,
2618 notit
->prev_packet_snapshots
.end_clock
,
2619 notit
->snapshots
.beginning_clock
);
2621 msg
= bt_message_discarded_packets_create(notit
->msg_iter
,
2626 BT_COMP_LOGE("Cannot create discarded packets message: "
2627 "notit-addr=%p, stream-addr=%p",
2628 notit
, notit
->stream
);
2632 bt_message_discarded_packets_set_count(msg
,
2633 notit
->snapshots
.packets
-
2634 notit
->prev_packet_snapshots
.packets
- 1);
2639 struct bt_msg_iter
*bt_msg_iter_create(struct ctf_trace_class
*tc
,
2640 size_t max_request_sz
,
2641 struct bt_msg_iter_medium_ops medops
, void *data
,
2642 bt_logging_level log_level
, bt_self_component
*self_comp
)
2644 struct bt_msg_iter
*notit
= NULL
;
2645 struct bt_bfcr_cbs cbs
= {
2647 .signed_int
= bfcr_signed_int_cb
,
2648 .unsigned_int
= bfcr_unsigned_int_cb
,
2649 .floating_point
= bfcr_floating_point_cb
,
2650 .string_begin
= bfcr_string_begin_cb
,
2651 .string
= bfcr_string_cb
,
2652 .string_end
= bfcr_string_end_cb
,
2653 .compound_begin
= bfcr_compound_begin_cb
,
2654 .compound_end
= bfcr_compound_end_cb
,
2657 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2658 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2663 BT_ASSERT(medops
.request_bytes
);
2664 BT_ASSERT(medops
.borrow_stream
);
2665 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, log_level
, self_comp
,
2666 "Creating CTF plugin message iterator: "
2667 "trace-addr=%p, max-request-size=%zu, "
2668 "data=%p, log-level=%s", tc
, max_request_sz
, data
,
2669 bt_common_logging_level_string(log_level
));
2670 notit
= g_new0(struct bt_msg_iter
, 1);
2672 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
2673 "Failed to allocate one CTF plugin message iterator.");
2676 notit
->self_comp
= self_comp
;
2677 notit
->log_level
= log_level
;
2678 notit
->meta
.tc
= tc
;
2679 notit
->medium
.medops
= medops
;
2680 notit
->medium
.max_request_sz
= max_request_sz
;
2681 notit
->medium
.data
= data
;
2682 notit
->stack
= stack_new(notit
);
2683 notit
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2684 g_array_set_size(notit
->stored_values
, tc
->stored_value_count
);
2686 if (!notit
->stack
) {
2687 BT_COMP_LOGE_STR("Failed to create field stack.");
2691 notit
->bfcr
= bt_bfcr_create(cbs
, notit
, log_level
, NULL
);
2693 BT_COMP_LOGE_STR("Failed to create binary class reader (BFCR).");
2697 bt_msg_iter_reset(notit
);
2698 BT_COMP_LOGD("Created CTF plugin message iterator: "
2699 "trace-addr=%p, max-request-size=%zu, "
2700 "data=%p, notit-addr=%p, log-level=%s",
2701 tc
, max_request_sz
, data
, notit
,
2702 bt_common_logging_level_string(log_level
));
2703 notit
->cur_packet_offset
= 0;
2709 bt_msg_iter_destroy(notit
);
2714 void bt_msg_iter_destroy(struct bt_msg_iter
*notit
)
2716 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2717 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
2718 release_all_dscopes(notit
);
2720 BT_COMP_LOGD("Destroying CTF plugin message iterator: addr=%p", notit
);
2723 BT_COMP_LOGD_STR("Destroying field stack.");
2724 stack_destroy(notit
->stack
);
2728 BT_COMP_LOGD("Destroying BFCR: bfcr-addr=%p", notit
->bfcr
);
2729 bt_bfcr_destroy(notit
->bfcr
);
2732 if (notit
->stored_values
) {
2733 g_array_free(notit
->stored_values
, TRUE
);
2739 enum bt_msg_iter_status
bt_msg_iter_get_next_message(
2740 struct bt_msg_iter
*notit
,
2741 bt_self_message_iterator
*msg_iter
, bt_message
**message
)
2743 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2747 notit
->msg_iter
= msg_iter
;
2748 notit
->set_stream
= true;
2749 BT_COMP_LOGD("Getting next message: notit-addr=%p", notit
);
2752 status
= handle_state(notit
);
2753 if (G_UNLIKELY(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2754 BT_COMP_LOGD_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2756 } else if (G_UNLIKELY(status
!= BT_MSG_ITER_STATUS_OK
)) {
2757 BT_COMP_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2758 notit
, state_string(notit
->state
));
2762 switch (notit
->state
) {
2763 case STATE_EMIT_MSG_EVENT
:
2764 BT_ASSERT(notit
->event_msg
);
2765 *message
= notit
->event_msg
;
2766 notit
->event_msg
= NULL
;
2768 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2769 /* create_msg_discared_events() logs errors */
2770 create_msg_discarded_events(notit
, message
);
2773 status
= BT_MSG_ITER_STATUS_ERROR
;
2777 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2778 /* create_msg_discared_packets() logs errors */
2779 create_msg_discarded_packets(notit
, message
);
2782 status
= BT_MSG_ITER_STATUS_ERROR
;
2786 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2787 /* create_msg_packet_beginning() logs errors */
2788 create_msg_packet_beginning(notit
, message
);
2791 status
= BT_MSG_ITER_STATUS_ERROR
;
2795 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2796 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2797 /* create_msg_packet_end() logs errors */
2798 create_msg_packet_end(notit
, message
);
2801 status
= BT_MSG_ITER_STATUS_ERROR
;
2805 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2806 /* create_msg_stream_beginning() logs errors */
2807 create_msg_stream_beginning(notit
, message
);
2810 status
= BT_MSG_ITER_STATUS_ERROR
;
2814 case STATE_EMIT_MSG_STREAM_END
:
2815 /* create_msg_stream_end() logs errors */
2816 create_msg_stream_end(notit
, message
);
2819 status
= BT_MSG_ITER_STATUS_ERROR
;
2824 status
= BT_MSG_ITER_STATUS_EOF
;
2827 /* Non-emitting state: continue */
2837 enum bt_msg_iter_status
read_packet_header_context_fields(
2838 struct bt_msg_iter
*notit
)
2841 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2844 notit
->set_stream
= false;
2846 if (notit
->state
== STATE_EMIT_MSG_PACKET_BEGINNING
) {
2847 /* We're already there */
2852 status
= handle_state(notit
);
2853 if (G_UNLIKELY(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2854 BT_COMP_LOGD_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2856 } else if (G_UNLIKELY(status
!= BT_MSG_ITER_STATUS_OK
)) {
2857 BT_COMP_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2858 notit
, state_string(notit
->state
));
2862 switch (notit
->state
) {
2863 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2865 * Packet header and context fields are
2866 * potentially decoded (or they don't exist).
2870 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
2871 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
2872 case STATE_AFTER_TRACE_PACKET_HEADER
:
2873 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
2874 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
2875 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
2876 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
2877 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2878 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
2879 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2880 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
2881 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2882 /* Non-emitting state: continue */
2886 * We should never get past the
2887 * STATE_EMIT_MSG_PACKET_BEGINNING state.
2889 BT_COMP_LOGF("Unexpected state: notit-addr=%p, state=%s",
2890 notit
, state_string(notit
->state
));
2896 ret
= set_current_packet_content_sizes(notit
);
2898 status
= BT_MSG_ITER_STATUS_ERROR
;
2905 void bt_msg_iter_set_medops_data(struct bt_msg_iter
*notit
,
2909 notit
->medium
.data
= medops_data
;
2913 enum bt_msg_iter_status
bt_msg_iter_seek(struct bt_msg_iter
*notit
,
2916 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
2917 enum bt_msg_iter_medium_status medium_status
;
2921 BT_COMP_LOGE("Cannot seek to negative offset: offset=%jd", offset
);
2922 ret
= BT_MSG_ITER_STATUS_INVAL
;
2926 if (!notit
->medium
.medops
.seek
) {
2927 ret
= BT_MSG_ITER_STATUS_UNSUPPORTED
;
2928 BT_COMP_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2932 medium_status
= notit
->medium
.medops
.seek(
2933 BT_MSG_ITER_SEEK_WHENCE_SET
, offset
, notit
->medium
.data
);
2934 if (medium_status
!= BT_MSG_ITER_MEDIUM_STATUS_OK
) {
2935 if (medium_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
2936 ret
= BT_MSG_ITER_STATUS_EOF
;
2938 ret
= BT_MSG_ITER_STATUS_ERROR
;
2943 bt_msg_iter_reset(notit
);
2944 notit
->cur_packet_offset
= offset
;
2951 enum bt_msg_iter_status
bt_msg_iter_get_packet_properties(
2952 struct bt_msg_iter
*notit
,
2953 struct bt_msg_iter_packet_properties
*props
)
2955 enum bt_msg_iter_status status
;
2959 status
= read_packet_header_context_fields(notit
);
2960 if (status
!= BT_MSG_ITER_STATUS_OK
) {
2964 props
->exp_packet_total_size
= notit
->cur_exp_packet_total_size
;
2965 props
->exp_packet_content_size
= notit
->cur_exp_packet_content_size
;
2966 props
->stream_class_id
= (uint64_t) notit
->cur_stream_class_id
;
2967 props
->data_stream_id
= notit
->cur_data_stream_id
;
2968 props
->snapshots
.discarded_events
= notit
->snapshots
.discarded_events
;
2969 props
->snapshots
.packets
= notit
->snapshots
.packets
;
2970 props
->snapshots
.beginning_clock
= notit
->snapshots
.beginning_clock
;
2971 props
->snapshots
.end_clock
= notit
->snapshots
.end_clock
;
2978 void bt_msg_iter_set_emit_stream_beginning_message(struct bt_msg_iter
*notit
,
2981 notit
->emit_stream_begin_msg
= val
;
2985 void bt_msg_iter_set_emit_stream_end_message(struct bt_msg_iter
*notit
,
2988 notit
->emit_stream_end_msg
= val
;