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_LOG_TAG "PLUGIN-CTF-MSG-ITER"
34 #include <babeltrace/assert-internal.h>
36 #include <babeltrace/babeltrace.h>
37 #include <babeltrace/common-internal.h>
42 #include "../bfcr/bfcr.h"
46 /* A visit stack entry */
49 * Current base field, one of:
61 /* Index of next field to set */
67 /* Entries (struct stack_entry) */
70 /* Number of active entries */
77 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
78 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
79 STATE_AFTER_TRACE_PACKET_HEADER
,
80 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
81 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
82 STATE_AFTER_STREAM_PACKET_CONTEXT
,
83 STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
,
84 STATE_EMIT_MSG_STREAM_BEGINNING
,
85 STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
,
86 STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
,
87 STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
,
88 STATE_EMIT_MSG_DISCARDED_EVENTS
,
89 STATE_EMIT_MSG_DISCARDED_PACKETS
,
90 STATE_EMIT_MSG_PACKET_BEGINNING
,
91 STATE_DSCOPE_EVENT_HEADER_BEGIN
,
92 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
93 STATE_AFTER_EVENT_HEADER
,
94 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
,
95 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
96 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
97 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
98 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
99 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
100 STATE_EMIT_MSG_EVENT
,
101 STATE_SKIP_PACKET_PADDING
,
102 STATE_EMIT_MSG_PACKET_END_MULTI
,
103 STATE_EMIT_MSG_PACKET_END_SINGLE
,
104 STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END
,
105 STATE_EMIT_MSG_STREAM_ACTIVITY_END
,
106 STATE_EMIT_MSG_STREAM_END
,
110 struct end_of_packet_snapshots
{
111 uint64_t discarded_events
;
113 uint64_t beginning_clock
;
117 /* CTF message iterator */
122 /* Current message iterator to create messages (weak) */
123 bt_self_message_iterator
*msg_iter
;
126 * True to emit stream beginning and stream activity beginning
129 bool emit_stream_begin_msg
;
131 /* True to emit stream end and stream activity end messages */
132 bool emit_stream_end_msg
;
134 /* True to set the stream */
138 * Current dynamic scope field pointer.
140 * This is set by read_dscope_begin_state() and contains the
141 * value of one of the pointers in `dscopes` below.
143 bt_field
*cur_dscope_field
;
146 * True if we're done filling a string field from a text
147 * array/sequence payload.
149 bool done_filling_string
;
151 /* Trace and classes */
152 /* True to set IR fields */
156 struct ctf_trace_class
*tc
;
157 struct ctf_stream_class
*sc
;
158 struct ctf_event_class
*ec
;
161 /* Current packet context field wrapper (NULL if not created yet) */
162 bt_packet_context_field
*packet_context_field
;
164 /* Current packet (NULL if not created yet) */
167 /* Current stream (NULL if not set yet) */
170 /* Current event (NULL if not created yet) */
173 /* Current event message (NULL if not created yet) */
174 bt_message
*event_msg
;
176 /* Database of current dynamic scopes */
178 bt_field
*stream_packet_context
;
179 bt_field
*event_common_context
;
180 bt_field
*event_spec_context
;
181 bt_field
*event_payload
;
187 /* Current medium buffer data */
189 /* Last address provided by medium */
192 /* Buffer size provided by medium (bytes) */
195 /* Offset within whole packet of addr (bits) */
196 size_t packet_offset
;
198 /* Current position from addr (bits) */
201 /* Position of the last event header from addr (bits) */
205 /* Binary type reader */
206 struct bt_bfcr
*bfcr
;
208 /* Current medium data */
210 struct bt_msg_iter_medium_ops medops
;
211 size_t max_request_sz
;
215 /* Current packet size (bits) (-1 if unknown) */
216 int64_t cur_exp_packet_total_size
;
218 /* Current content size (bits) (-1 if unknown) */
219 int64_t cur_exp_packet_content_size
;
221 /* Current stream class ID */
222 int64_t cur_stream_class_id
;
224 /* Current event class ID */
225 int64_t cur_event_class_id
;
227 /* Current data stream ID */
228 int64_t cur_data_stream_id
;
231 * Offset, in the underlying media, of the current packet's
232 * start (-1 if unknown).
234 off_t cur_packet_offset
;
236 /* Default clock's current value */
237 uint64_t default_clock_snapshot
;
239 /* End of current packet snapshots */
240 struct end_of_packet_snapshots snapshots
;
242 /* End of previous packet snapshots */
243 struct end_of_packet_snapshots prev_packet_snapshots
;
245 /* Stored values (for sequence lengths, variant tags) */
246 GArray
*stored_values
;
250 const char *state_string(enum state state
)
255 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
256 return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
257 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
258 return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
259 case STATE_AFTER_TRACE_PACKET_HEADER
:
260 return "STATE_AFTER_TRACE_PACKET_HEADER";
261 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
262 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
263 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
264 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
265 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
266 return "STATE_AFTER_STREAM_PACKET_CONTEXT";
267 case STATE_EMIT_MSG_STREAM_BEGINNING
:
268 return "STATE_EMIT_MSG_STREAM_BEGINNING";
269 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
:
270 return "STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING";
271 case STATE_EMIT_MSG_PACKET_BEGINNING
:
272 return "STATE_EMIT_MSG_PACKET_BEGINNING";
273 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
274 return "STATE_EMIT_MSG_DISCARDED_EVENTS";
275 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
276 return "STATE_EMIT_MSG_DISCARDED_PACKETS";
277 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
278 return "STATE_DSCOPE_EVENT_HEADER_BEGIN";
279 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
280 return "STATE_DSCOPE_EVENT_HEADER_CONTINUE";
281 case STATE_AFTER_EVENT_HEADER
:
282 return "STATE_AFTER_EVENT_HEADER";
283 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
284 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
285 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
286 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
287 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
288 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
289 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
290 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
291 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
292 return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
293 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
294 return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
295 case STATE_EMIT_MSG_EVENT
:
296 return "STATE_EMIT_MSG_EVENT";
297 case STATE_SKIP_PACKET_PADDING
:
298 return "STATE_SKIP_PACKET_PADDING";
299 case STATE_EMIT_MSG_PACKET_END_MULTI
:
300 return "STATE_EMIT_MSG_PACKET_END_MULTI";
301 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
302 return "STATE_EMIT_MSG_PACKET_END_SINGLE";
303 case STATE_EMIT_MSG_STREAM_ACTIVITY_END
:
304 return "STATE_EMIT_MSG_STREAM_ACTIVITY_END";
305 case STATE_EMIT_MSG_STREAM_END
:
306 return "STATE_EMIT_MSG_STREAM_END";
315 int bt_msg_iter_switch_packet(struct bt_msg_iter
*notit
);
318 struct stack
*stack_new(struct bt_msg_iter
*notit
)
320 struct stack
*stack
= NULL
;
322 stack
= g_new0(struct stack
, 1);
324 BT_LOGE_STR("Failed to allocate one stack.");
328 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
329 if (!stack
->entries
) {
330 BT_LOGE_STR("Failed to allocate a GArray.");
334 BT_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit
, stack
);
346 void stack_destroy(struct stack
*stack
)
349 BT_LOGD("Destroying stack: addr=%p", stack
);
351 if (stack
->entries
) {
352 g_array_free(stack
->entries
, TRUE
);
359 void stack_push(struct stack
*stack
, bt_field
*base
)
361 struct stack_entry
*entry
;
365 BT_LOGV("Pushing base field on stack: stack-addr=%p, "
366 "stack-size-before=%zu, stack-size-after=%zu",
367 stack
, stack
->size
, stack
->size
+ 1);
369 if (stack
->entries
->len
== stack
->size
) {
370 g_array_set_size(stack
->entries
, stack
->size
+ 1);
373 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
380 unsigned int stack_size(struct stack
*stack
)
387 void stack_pop(struct stack
*stack
)
390 BT_ASSERT(stack_size(stack
));
391 BT_LOGV("Popping from stack: "
392 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
393 stack
, stack
->size
, stack
->size
- 1);
398 struct stack_entry
*stack_top(struct stack
*stack
)
401 BT_ASSERT(stack_size(stack
));
402 return &g_array_index(stack
->entries
, struct stack_entry
,
407 bool stack_empty(struct stack
*stack
)
409 return stack_size(stack
) == 0;
413 void stack_clear(struct stack
*stack
)
420 enum bt_msg_iter_status
msg_iter_status_from_m_status(
421 enum bt_msg_iter_medium_status m_status
)
423 /* They are the same */
424 return (int) m_status
;
428 size_t buf_size_bits(struct bt_msg_iter
*notit
)
430 return notit
->buf
.sz
* 8;
434 size_t buf_available_bits(struct bt_msg_iter
*notit
)
436 return buf_size_bits(notit
) - notit
->buf
.at
;
440 size_t packet_at(struct bt_msg_iter
*notit
)
442 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
446 void buf_consume_bits(struct bt_msg_iter
*notit
, size_t incr
)
448 BT_LOGV("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
449 notit
, notit
->buf
.at
, notit
->buf
.at
+ incr
);
450 notit
->buf
.at
+= incr
;
454 enum bt_msg_iter_status
request_medium_bytes(
455 struct bt_msg_iter
*notit
)
457 uint8_t *buffer_addr
= NULL
;
458 size_t buffer_sz
= 0;
459 enum bt_msg_iter_medium_status m_status
;
461 BT_LOGV("Calling user function (request bytes): notit-addr=%p, "
462 "request-size=%zu", notit
, notit
->medium
.max_request_sz
);
463 m_status
= notit
->medium
.medops
.request_bytes(
464 notit
->medium
.max_request_sz
, &buffer_addr
,
465 &buffer_sz
, notit
->medium
.data
);
466 BT_LOGV("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
467 bt_msg_iter_medium_status_string(m_status
),
468 buffer_addr
, buffer_sz
);
469 if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_OK
) {
470 BT_ASSERT(buffer_sz
!= 0);
472 /* New packet offset is old one + old size (in bits) */
473 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
475 /* Restart at the beginning of the new medium buffer */
477 notit
->buf
.last_eh_at
= SIZE_MAX
;
479 /* New medium buffer size */
480 notit
->buf
.sz
= buffer_sz
;
482 /* New medium buffer address */
483 notit
->buf
.addr
= buffer_addr
;
485 BT_LOGV("User function returned new bytes: "
486 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
487 notit
->buf
.packet_offset
, notit
->buf
.at
,
488 notit
->buf
.sz
, notit
->buf
.addr
);
489 BT_LOGV_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
491 } else if (m_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
493 * User returned end of stream: validate that we're not
494 * in the middle of a packet header, packet context, or
497 if (notit
->cur_exp_packet_total_size
>= 0) {
498 if (packet_at(notit
) ==
499 notit
->cur_exp_packet_total_size
) {
503 if (packet_at(notit
) == 0) {
507 if (notit
->buf
.last_eh_at
!= SIZE_MAX
&&
508 notit
->buf
.at
== notit
->buf
.last_eh_at
) {
513 /* All other states are invalid */
514 BT_LOGW("User function returned %s, but message iterator is in an unexpected state: "
515 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
516 "packet-cur=%zu, last-eh-at=%zu",
517 bt_msg_iter_medium_status_string(m_status
),
518 state_string(notit
->state
),
519 notit
->cur_exp_packet_total_size
,
520 notit
->buf
.at
, packet_at(notit
),
521 notit
->buf
.last_eh_at
);
522 m_status
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
523 } else if (m_status
< 0) {
524 BT_LOGW("User function failed: status=%s",
525 bt_msg_iter_medium_status_string(m_status
));
529 return msg_iter_status_from_m_status(m_status
);
533 enum bt_msg_iter_status
buf_ensure_available_bits(
534 struct bt_msg_iter
*notit
)
536 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
538 if (unlikely(buf_available_bits(notit
) == 0)) {
540 * This _cannot_ return BT_MSG_ITER_STATUS_OK
543 status
= request_medium_bytes(notit
);
550 enum bt_msg_iter_status
read_dscope_begin_state(
551 struct bt_msg_iter
*notit
,
552 struct ctf_field_class
*dscope_fc
,
553 enum state done_state
, enum state continue_state
,
554 bt_field
*dscope_field
)
556 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
557 enum bt_bfcr_status bfcr_status
;
558 size_t consumed_bits
;
560 notit
->cur_dscope_field
= dscope_field
;
561 BT_LOGV("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
562 notit
, notit
->bfcr
, dscope_fc
);
563 consumed_bits
= bt_bfcr_start(notit
->bfcr
, dscope_fc
,
564 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
565 notit
->buf
.sz
, &bfcr_status
);
566 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits
);
568 switch (bfcr_status
) {
569 case BT_BFCR_STATUS_OK
:
570 /* Field class was read completely */
571 BT_LOGV_STR("Field was completely decoded.");
572 notit
->state
= done_state
;
574 case BT_BFCR_STATUS_EOF
:
575 BT_LOGV_STR("BFCR needs more data to decode field completely.");
576 notit
->state
= continue_state
;
579 BT_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
580 "status=%s", notit
, notit
->bfcr
,
581 bt_bfcr_status_string(bfcr_status
));
582 status
= BT_MSG_ITER_STATUS_ERROR
;
586 /* Consume bits now since we know we're not in an error state */
587 buf_consume_bits(notit
, consumed_bits
);
594 enum bt_msg_iter_status
read_dscope_continue_state(
595 struct bt_msg_iter
*notit
, enum state done_state
)
597 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
598 enum bt_bfcr_status bfcr_status
;
599 size_t consumed_bits
;
601 BT_LOGV("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
604 status
= buf_ensure_available_bits(notit
);
605 if (status
!= BT_MSG_ITER_STATUS_OK
) {
607 BT_LOGW("Cannot ensure that buffer has at least one byte: "
608 "msg-addr=%p, status=%s",
609 notit
, bt_msg_iter_status_string(status
));
611 BT_LOGV("Cannot ensure that buffer has at least one byte: "
612 "msg-addr=%p, status=%s",
613 notit
, bt_msg_iter_status_string(status
));
619 consumed_bits
= bt_bfcr_continue(notit
->bfcr
, notit
->buf
.addr
,
620 notit
->buf
.sz
, &bfcr_status
);
621 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits
);
623 switch (bfcr_status
) {
624 case BT_BFCR_STATUS_OK
:
625 /* Type was read completely. */
626 BT_LOGV_STR("Field was completely decoded.");
627 notit
->state
= done_state
;
629 case BT_BFCR_STATUS_EOF
:
630 /* Stay in this continue state. */
631 BT_LOGV_STR("BFCR needs more data to decode field completely.");
634 BT_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
635 "status=%s", notit
, notit
->bfcr
,
636 bt_bfcr_status_string(bfcr_status
));
637 status
= BT_MSG_ITER_STATUS_ERROR
;
641 /* Consume bits now since we know we're not in an error state. */
642 buf_consume_bits(notit
, consumed_bits
);
648 void release_event_dscopes(struct bt_msg_iter
*notit
)
650 notit
->dscopes
.event_common_context
= NULL
;
651 notit
->dscopes
.event_spec_context
= NULL
;
652 notit
->dscopes
.event_payload
= NULL
;
656 void release_all_dscopes(struct bt_msg_iter
*notit
)
658 notit
->dscopes
.stream_packet_context
= NULL
;
660 if (notit
->packet_context_field
) {
661 bt_packet_context_field_release(notit
->packet_context_field
);
662 notit
->packet_context_field
= NULL
;
665 release_event_dscopes(notit
);
669 enum bt_msg_iter_status
read_packet_header_begin_state(
670 struct bt_msg_iter
*notit
)
672 struct ctf_field_class
*packet_header_fc
= NULL
;
673 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
675 if (bt_msg_iter_switch_packet(notit
)) {
676 BT_LOGW("Cannot switch packet: notit-addr=%p", notit
);
677 ret
= BT_MSG_ITER_STATUS_ERROR
;
682 * Make sure at least one bit is available for this packet. An
683 * empty packet is impossible. If we reach the end of the medium
684 * at this point, then it's considered the end of the stream.
686 ret
= buf_ensure_available_bits(notit
);
688 case BT_MSG_ITER_STATUS_OK
:
690 case BT_MSG_ITER_STATUS_EOF
:
691 ret
= BT_MSG_ITER_STATUS_OK
;
692 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END
;
698 /* Packet header class is common to the whole trace class. */
699 packet_header_fc
= notit
->meta
.tc
->packet_header_fc
;
700 if (!packet_header_fc
) {
701 notit
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
705 notit
->cur_stream_class_id
= -1;
706 notit
->cur_event_class_id
= -1;
707 notit
->cur_data_stream_id
= -1;
708 BT_LOGV("Decoding packet header field:"
709 "notit-addr=%p, trace-class-addr=%p, fc-addr=%p",
710 notit
, notit
->meta
.tc
, packet_header_fc
);
711 ret
= read_dscope_begin_state(notit
, packet_header_fc
,
712 STATE_AFTER_TRACE_PACKET_HEADER
,
713 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
, NULL
);
715 BT_LOGW("Cannot decode packet header field: "
716 "notit-addr=%p, trace-class-addr=%p, "
718 notit
, notit
->meta
.tc
, packet_header_fc
);
726 enum bt_msg_iter_status
read_packet_header_continue_state(
727 struct bt_msg_iter
*notit
)
729 return read_dscope_continue_state(notit
,
730 STATE_AFTER_TRACE_PACKET_HEADER
);
734 enum bt_msg_iter_status
set_current_stream_class(struct bt_msg_iter
*notit
)
736 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
737 struct ctf_stream_class
*new_stream_class
= NULL
;
739 if (notit
->cur_stream_class_id
== -1) {
741 * No current stream class ID field, therefore only one
744 if (notit
->meta
.tc
->stream_classes
->len
!= 1) {
745 BT_LOGW("Need exactly one stream class since there's "
746 "no stream class ID field: "
747 "notit-addr=%p", notit
);
748 status
= BT_MSG_ITER_STATUS_ERROR
;
752 new_stream_class
= notit
->meta
.tc
->stream_classes
->pdata
[0];
753 notit
->cur_stream_class_id
= new_stream_class
->id
;
756 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
757 notit
->meta
.tc
, notit
->cur_stream_class_id
);
758 if (!new_stream_class
) {
759 BT_LOGW("No stream class with ID of stream class ID to use in trace class: "
760 "notit-addr=%p, stream-class-id=%" PRIu64
", "
761 "trace-class-addr=%p",
762 notit
, notit
->cur_stream_class_id
, notit
->meta
.tc
);
763 status
= BT_MSG_ITER_STATUS_ERROR
;
767 if (notit
->meta
.sc
) {
768 if (new_stream_class
!= notit
->meta
.sc
) {
769 BT_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
770 "notit-addr=%p, prev-stream-class-addr=%p, "
771 "prev-stream-class-id=%" PRId64
", "
772 "next-stream-class-addr=%p, "
773 "next-stream-class-id=%" PRId64
", "
775 notit
, notit
->meta
.sc
,
778 new_stream_class
->id
,
780 status
= BT_MSG_ITER_STATUS_ERROR
;
784 notit
->meta
.sc
= new_stream_class
;
787 BT_LOGV("Set current stream class: "
788 "notit-addr=%p, stream-class-addr=%p, "
789 "stream-class-id=%" PRId64
,
790 notit
, notit
->meta
.sc
, notit
->meta
.sc
->id
);
797 enum bt_msg_iter_status
set_current_stream(struct bt_msg_iter
*notit
)
799 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
800 bt_stream
*stream
= NULL
;
802 BT_LOGV("Calling user function (get stream): notit-addr=%p, "
803 "stream-class-addr=%p, stream-class-id=%" PRId64
,
804 notit
, notit
->meta
.sc
,
806 stream
= notit
->medium
.medops
.borrow_stream(
807 notit
->meta
.sc
->ir_sc
, notit
->cur_data_stream_id
,
809 bt_stream_get_ref(stream
);
810 BT_LOGV("User function returned: stream-addr=%p", stream
);
812 BT_LOGW_STR("User function failed to return a stream object "
813 "for the given stream class.");
814 status
= BT_MSG_ITER_STATUS_ERROR
;
818 if (notit
->stream
&& stream
!= notit
->stream
) {
819 BT_LOGW("User function returned a different stream than the "
820 "previous one for the same sequence of packets.");
821 status
= BT_MSG_ITER_STATUS_ERROR
;
825 BT_STREAM_MOVE_REF(notit
->stream
, stream
);
828 bt_stream_put_ref(stream
);
833 enum bt_msg_iter_status
set_current_packet(struct bt_msg_iter
*notit
)
835 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
836 bt_packet
*packet
= NULL
;
838 BT_LOGV("Creating packet for packet message: "
839 "notit-addr=%p", notit
);
840 BT_LOGV("Creating packet from stream: "
841 "notit-addr=%p, stream-addr=%p, "
842 "stream-class-addr=%p, "
843 "stream-class-id=%" PRId64
,
844 notit
, notit
->stream
, notit
->meta
.sc
,
848 BT_ASSERT(notit
->stream
);
849 packet
= bt_packet_create(notit
->stream
);
851 BT_LOGE("Cannot create packet from stream: "
852 "notit-addr=%p, stream-addr=%p, "
853 "stream-class-addr=%p, "
854 "stream-class-id=%" PRId64
,
855 notit
, notit
->stream
, notit
->meta
.sc
,
863 BT_PACKET_PUT_REF_AND_RESET(packet
);
864 status
= BT_MSG_ITER_STATUS_ERROR
;
867 BT_PACKET_MOVE_REF(notit
->packet
, packet
);
872 enum bt_msg_iter_status
after_packet_header_state(
873 struct bt_msg_iter
*notit
)
875 enum bt_msg_iter_status status
;
877 status
= set_current_stream_class(notit
);
878 if (status
!= BT_MSG_ITER_STATUS_OK
) {
882 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
889 enum bt_msg_iter_status
read_packet_context_begin_state(
890 struct bt_msg_iter
*notit
)
892 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
893 struct ctf_field_class
*packet_context_fc
;
895 BT_ASSERT(notit
->meta
.sc
);
896 packet_context_fc
= notit
->meta
.sc
->packet_context_fc
;
897 if (!packet_context_fc
) {
898 BT_LOGV("No packet packet context field class in stream class: continuing: "
899 "notit-addr=%p, stream-class-addr=%p, "
900 "stream-class-id=%" PRId64
,
901 notit
, notit
->meta
.sc
,
903 notit
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
907 BT_ASSERT(!notit
->packet_context_field
);
909 if (packet_context_fc
->in_ir
) {
911 * Create free packet context field from stream class.
912 * This field is going to be moved to the packet once we
913 * create it. We cannot create the packet now because a
914 * packet is created from a stream, and this API must be
915 * able to return the packet context properties without
917 * (bt_msg_iter_get_packet_properties()).
919 notit
->packet_context_field
=
920 bt_packet_context_field_create(
921 notit
->meta
.sc
->ir_sc
);
922 if (!notit
->packet_context_field
) {
923 BT_LOGE_STR("Cannot create packet context field wrapper from stream class.");
924 status
= BT_MSG_ITER_STATUS_ERROR
;
928 notit
->dscopes
.stream_packet_context
=
929 bt_packet_context_field_borrow_field(
930 notit
->packet_context_field
);
931 BT_ASSERT(notit
->dscopes
.stream_packet_context
);
934 BT_LOGV("Decoding packet context field: "
935 "notit-addr=%p, stream-class-addr=%p, "
936 "stream-class-id=%" PRId64
", fc-addr=%p",
937 notit
, notit
->meta
.sc
,
938 notit
->meta
.sc
->id
, packet_context_fc
);
939 status
= read_dscope_begin_state(notit
, packet_context_fc
,
940 STATE_AFTER_STREAM_PACKET_CONTEXT
,
941 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
942 notit
->dscopes
.stream_packet_context
);
944 BT_LOGW("Cannot decode packet context field: "
945 "notit-addr=%p, stream-class-addr=%p, "
946 "stream-class-id=%" PRId64
", fc-addr=%p",
947 notit
, notit
->meta
.sc
,
957 enum bt_msg_iter_status
read_packet_context_continue_state(
958 struct bt_msg_iter
*notit
)
960 return read_dscope_continue_state(notit
,
961 STATE_AFTER_STREAM_PACKET_CONTEXT
);
965 enum bt_msg_iter_status
set_current_packet_content_sizes(
966 struct bt_msg_iter
*notit
)
968 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
970 if (notit
->cur_exp_packet_total_size
== -1) {
971 if (notit
->cur_exp_packet_content_size
!= -1) {
972 BT_LOGW("Content size is set, but packet size is not: "
973 "notit-addr=%p, packet-context-field-addr=%p, "
974 "packet-size=%" PRId64
", content-size=%" PRId64
,
975 notit
, notit
->dscopes
.stream_packet_context
,
976 notit
->cur_exp_packet_total_size
,
977 notit
->cur_exp_packet_content_size
);
978 status
= BT_MSG_ITER_STATUS_ERROR
;
982 if (notit
->cur_exp_packet_content_size
== -1) {
983 notit
->cur_exp_packet_content_size
=
984 notit
->cur_exp_packet_total_size
;
988 if (notit
->cur_exp_packet_content_size
>
989 notit
->cur_exp_packet_total_size
) {
990 BT_LOGW("Invalid packet or content size: "
991 "content size is greater than packet size: "
992 "notit-addr=%p, packet-context-field-addr=%p, "
993 "packet-size=%" PRId64
", content-size=%" PRId64
,
994 notit
, notit
->dscopes
.stream_packet_context
,
995 notit
->cur_exp_packet_total_size
,
996 notit
->cur_exp_packet_content_size
);
997 status
= BT_MSG_ITER_STATUS_ERROR
;
1001 BT_LOGV("Set current packet and content sizes: "
1002 "notit-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1003 notit
, notit
->cur_exp_packet_total_size
,
1004 notit
->cur_exp_packet_content_size
);
1011 enum bt_msg_iter_status
after_packet_context_state(struct bt_msg_iter
*notit
)
1013 enum bt_msg_iter_status status
;
1015 status
= set_current_packet_content_sizes(notit
);
1016 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1020 if (notit
->stream
) {
1022 * Stream exists, which means we already emitted at
1023 * least one packet beginning message, so the initial
1024 * stream beginning message was also emitted.
1026 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1028 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
;
1036 enum bt_msg_iter_status
read_event_header_begin_state(struct bt_msg_iter
*notit
)
1038 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1039 struct ctf_field_class
*event_header_fc
= NULL
;
1041 /* Reset the position of the last event header */
1042 notit
->buf
.last_eh_at
= notit
->buf
.at
;
1043 notit
->cur_event_class_id
= -1;
1045 /* Check if we have some content left */
1046 if (notit
->cur_exp_packet_content_size
>= 0) {
1047 if (unlikely(packet_at(notit
) ==
1048 notit
->cur_exp_packet_content_size
)) {
1049 /* No more events! */
1050 BT_LOGV("Reached end of packet: notit-addr=%p, "
1051 "cur=%zu", notit
, packet_at(notit
));
1052 notit
->state
= STATE_EMIT_MSG_PACKET_END_MULTI
;
1054 } else if (unlikely(packet_at(notit
) >
1055 notit
->cur_exp_packet_content_size
)) {
1056 /* That's not supposed to happen */
1057 BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
1058 "notit-addr=%p, content-size=%" PRId64
", "
1060 notit
->cur_exp_packet_content_size
,
1062 status
= BT_MSG_ITER_STATUS_ERROR
;
1067 * "Infinite" content: we're done when the medium has
1068 * nothing else for us.
1070 status
= buf_ensure_available_bits(notit
);
1072 case BT_MSG_ITER_STATUS_OK
:
1074 case BT_MSG_ITER_STATUS_EOF
:
1075 status
= BT_MSG_ITER_STATUS_OK
;
1076 notit
->state
= STATE_EMIT_MSG_PACKET_END_SINGLE
;
1083 release_event_dscopes(notit
);
1084 BT_ASSERT(notit
->meta
.sc
);
1085 event_header_fc
= notit
->meta
.sc
->event_header_fc
;
1086 if (!event_header_fc
) {
1087 notit
->state
= STATE_AFTER_EVENT_HEADER
;
1091 BT_LOGV("Decoding event header field: "
1092 "notit-addr=%p, stream-class-addr=%p, "
1093 "stream-class-id=%" PRId64
", "
1095 notit
, notit
->meta
.sc
,
1098 status
= read_dscope_begin_state(notit
, event_header_fc
,
1099 STATE_AFTER_EVENT_HEADER
,
1100 STATE_DSCOPE_EVENT_HEADER_CONTINUE
, NULL
);
1102 BT_LOGW("Cannot decode event header field: "
1103 "notit-addr=%p, stream-class-addr=%p, "
1104 "stream-class-id=%" PRId64
", fc-addr=%p",
1105 notit
, notit
->meta
.sc
,
1115 enum bt_msg_iter_status
read_event_header_continue_state(
1116 struct bt_msg_iter
*notit
)
1118 return read_dscope_continue_state(notit
,
1119 STATE_AFTER_EVENT_HEADER
);
1123 enum bt_msg_iter_status
set_current_event_class(struct bt_msg_iter
*notit
)
1125 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1127 struct ctf_event_class
*new_event_class
= NULL
;
1129 if (notit
->cur_event_class_id
== -1) {
1131 * No current event class ID field, therefore only one
1134 if (notit
->meta
.sc
->event_classes
->len
!= 1) {
1135 BT_LOGW("Need exactly one event class since there's "
1136 "no event class ID field: "
1137 "notit-addr=%p", notit
);
1138 status
= BT_MSG_ITER_STATUS_ERROR
;
1142 new_event_class
= notit
->meta
.sc
->event_classes
->pdata
[0];
1143 notit
->cur_event_class_id
= new_event_class
->id
;
1146 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1147 notit
->meta
.sc
, notit
->cur_event_class_id
);
1148 if (!new_event_class
) {
1149 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1150 "notit-addr=%p, stream-class-id=%" PRIu64
", "
1151 "event-class-id=%" PRIu64
", "
1152 "trace-class-addr=%p",
1153 notit
, notit
->meta
.sc
->id
, notit
->cur_event_class_id
,
1155 status
= BT_MSG_ITER_STATUS_ERROR
;
1159 notit
->meta
.ec
= new_event_class
;
1160 BT_LOGV("Set current event class: "
1161 "notit-addr=%p, event-class-addr=%p, "
1162 "event-class-id=%" PRId64
", "
1163 "event-class-name=\"%s\"",
1164 notit
, notit
->meta
.ec
, notit
->meta
.ec
->id
,
1165 notit
->meta
.ec
->name
->str
);
1172 enum bt_msg_iter_status
set_current_event_message(
1173 struct bt_msg_iter
*notit
)
1175 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1176 bt_message
*msg
= NULL
;
1178 BT_ASSERT(notit
->meta
.ec
);
1179 BT_ASSERT(notit
->packet
);
1180 BT_LOGV("Creating event message from event class and packet: "
1181 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1182 notit
, notit
->meta
.ec
,
1183 notit
->meta
.ec
->name
->str
,
1185 BT_ASSERT(notit
->msg_iter
);
1186 msg
= bt_message_event_create(notit
->msg_iter
,
1187 notit
->meta
.ec
->ir_ec
, notit
->packet
);
1189 BT_LOGE("Cannot create event message: "
1190 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1192 notit
, notit
->meta
.ec
,
1193 notit
->meta
.ec
->name
->str
,
1201 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1202 status
= BT_MSG_ITER_STATUS_ERROR
;
1205 BT_MESSAGE_MOVE_REF(notit
->event_msg
, msg
);
1210 enum bt_msg_iter_status
after_event_header_state(
1211 struct bt_msg_iter
*notit
)
1213 enum bt_msg_iter_status status
;
1215 status
= set_current_event_class(notit
);
1216 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1220 status
= set_current_event_message(notit
);
1221 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1225 notit
->event
= bt_message_event_borrow_event(
1227 BT_ASSERT(notit
->event
);
1228 notit
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1235 enum bt_msg_iter_status
read_event_common_context_begin_state(
1236 struct bt_msg_iter
*notit
)
1238 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1239 struct ctf_field_class
*event_common_context_fc
;
1241 event_common_context_fc
= notit
->meta
.sc
->event_common_context_fc
;
1242 if (!event_common_context_fc
) {
1243 notit
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1247 if (event_common_context_fc
->in_ir
) {
1248 BT_ASSERT(!notit
->dscopes
.event_common_context
);
1249 notit
->dscopes
.event_common_context
=
1250 bt_event_borrow_common_context_field(
1252 BT_ASSERT(notit
->dscopes
.event_common_context
);
1255 BT_LOGV("Decoding event common context field: "
1256 "notit-addr=%p, stream-class-addr=%p, "
1257 "stream-class-id=%" PRId64
", "
1259 notit
, notit
->meta
.sc
,
1261 event_common_context_fc
);
1262 status
= read_dscope_begin_state(notit
, event_common_context_fc
,
1263 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1264 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1265 notit
->dscopes
.event_common_context
);
1267 BT_LOGW("Cannot decode event common context field: "
1268 "notit-addr=%p, stream-class-addr=%p, "
1269 "stream-class-id=%" PRId64
", fc-addr=%p",
1270 notit
, notit
->meta
.sc
,
1272 event_common_context_fc
);
1280 enum bt_msg_iter_status
read_event_common_context_continue_state(
1281 struct bt_msg_iter
*notit
)
1283 return read_dscope_continue_state(notit
,
1284 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1288 enum bt_msg_iter_status
read_event_spec_context_begin_state(
1289 struct bt_msg_iter
*notit
)
1291 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1292 struct ctf_field_class
*event_spec_context_fc
;
1294 event_spec_context_fc
= notit
->meta
.ec
->spec_context_fc
;
1295 if (!event_spec_context_fc
) {
1296 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1300 if (event_spec_context_fc
->in_ir
) {
1301 BT_ASSERT(!notit
->dscopes
.event_spec_context
);
1302 notit
->dscopes
.event_spec_context
=
1303 bt_event_borrow_specific_context_field(
1305 BT_ASSERT(notit
->dscopes
.event_spec_context
);
1308 BT_LOGV("Decoding event specific context field: "
1309 "notit-addr=%p, event-class-addr=%p, "
1310 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1312 notit
, notit
->meta
.ec
,
1313 notit
->meta
.ec
->name
->str
,
1315 event_spec_context_fc
);
1316 status
= read_dscope_begin_state(notit
, event_spec_context_fc
,
1317 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1318 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1319 notit
->dscopes
.event_spec_context
);
1321 BT_LOGW("Cannot decode event specific context field: "
1322 "notit-addr=%p, event-class-addr=%p, "
1323 "event-class-name=\"%s\", "
1324 "event-class-id=%" PRId64
", fc-addr=%p",
1325 notit
, notit
->meta
.ec
,
1326 notit
->meta
.ec
->name
->str
,
1328 event_spec_context_fc
);
1336 enum bt_msg_iter_status
read_event_spec_context_continue_state(
1337 struct bt_msg_iter
*notit
)
1339 return read_dscope_continue_state(notit
,
1340 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1344 enum bt_msg_iter_status
read_event_payload_begin_state(
1345 struct bt_msg_iter
*notit
)
1347 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1348 struct ctf_field_class
*event_payload_fc
;
1350 event_payload_fc
= notit
->meta
.ec
->payload_fc
;
1351 if (!event_payload_fc
) {
1352 notit
->state
= STATE_EMIT_MSG_EVENT
;
1356 if (event_payload_fc
->in_ir
) {
1357 BT_ASSERT(!notit
->dscopes
.event_payload
);
1358 notit
->dscopes
.event_payload
=
1359 bt_event_borrow_payload_field(
1361 BT_ASSERT(notit
->dscopes
.event_payload
);
1364 BT_LOGV("Decoding event payload field: "
1365 "notit-addr=%p, event-class-addr=%p, "
1366 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1368 notit
, notit
->meta
.ec
,
1369 notit
->meta
.ec
->name
->str
,
1372 status
= read_dscope_begin_state(notit
, event_payload_fc
,
1373 STATE_EMIT_MSG_EVENT
,
1374 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1375 notit
->dscopes
.event_payload
);
1377 BT_LOGW("Cannot decode event payload field: "
1378 "notit-addr=%p, event-class-addr=%p, "
1379 "event-class-name=\"%s\", "
1380 "event-class-id=%" PRId64
", fc-addr=%p",
1381 notit
, notit
->meta
.ec
,
1382 notit
->meta
.ec
->name
->str
,
1392 enum bt_msg_iter_status
read_event_payload_continue_state(
1393 struct bt_msg_iter
*notit
)
1395 return read_dscope_continue_state(notit
, STATE_EMIT_MSG_EVENT
);
1399 enum bt_msg_iter_status
skip_packet_padding_state(struct bt_msg_iter
*notit
)
1401 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1402 size_t bits_to_skip
;
1404 BT_ASSERT(notit
->cur_exp_packet_total_size
> 0);
1405 bits_to_skip
= notit
->cur_exp_packet_total_size
- packet_at(notit
);
1406 if (bits_to_skip
== 0) {
1407 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1410 size_t bits_to_consume
;
1412 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1413 bits_to_skip
, notit
, bits_to_skip
);
1414 status
= buf_ensure_available_bits(notit
);
1415 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1419 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1420 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1421 bits_to_consume
, notit
, bits_to_consume
);
1422 buf_consume_bits(notit
, bits_to_consume
);
1423 bits_to_skip
= notit
->cur_exp_packet_total_size
-
1425 if (bits_to_skip
== 0) {
1426 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1436 enum bt_msg_iter_status
check_emit_msg_stream_beginning_state(
1437 struct bt_msg_iter
*notit
)
1439 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1441 if (notit
->set_stream
) {
1442 status
= set_current_stream(notit
);
1443 if (status
!= BT_MSG_ITER_STATUS_OK
) {
1448 if (notit
->emit_stream_begin_msg
) {
1449 notit
->state
= STATE_EMIT_MSG_STREAM_BEGINNING
;
1451 /* Stream's first packet */
1452 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1460 enum bt_msg_iter_status
check_emit_msg_discarded_events(
1461 struct bt_msg_iter
*notit
)
1463 notit
->state
= STATE_EMIT_MSG_DISCARDED_EVENTS
;
1465 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
1466 if (notit
->snapshots
.discarded_events
== 0 ||
1467 notit
->snapshots
.discarded_events
== UINT64_C(-1)) {
1469 * Stream's first packet with no discarded
1470 * events or no information about discarded
1471 * events: do not emit.
1473 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1477 * If the previous packet has a value for this counter,
1478 * then this counter is defined for the whole stream.
1480 BT_ASSERT(notit
->snapshots
.discarded_events
!= UINT64_C(-1));
1482 if (notit
->snapshots
.discarded_events
-
1483 notit
->prev_packet_snapshots
.discarded_events
== 0) {
1485 * No discarded events since previous packet: do
1488 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1492 return BT_MSG_ITER_STATUS_OK
;
1496 enum bt_msg_iter_status
check_emit_msg_discarded_packets(
1497 struct bt_msg_iter
*notit
)
1499 notit
->state
= STATE_EMIT_MSG_DISCARDED_PACKETS
;
1501 if (notit
->prev_packet_snapshots
.packets
== UINT64_C(-1)) {
1503 * Stream's first packet or no information about
1504 * discarded packets: do not emit. In other words, if
1505 * this is the first packet and its sequence number is
1506 * not 0, do not consider that packets were previously
1507 * lost: we might be reading a partial stream (LTTng
1508 * snapshot for example).
1510 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1513 * If the previous packet has a value for this counter,
1514 * then this counter is defined for the whole stream.
1516 BT_ASSERT(notit
->snapshots
.packets
!= UINT64_C(-1));
1518 if (notit
->snapshots
.packets
-
1519 notit
->prev_packet_snapshots
.packets
<= 1) {
1521 * No discarded packets since previous packet:
1524 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1528 return BT_MSG_ITER_STATUS_OK
;
1532 enum bt_msg_iter_status
check_emit_msg_stream_activity_end(
1533 struct bt_msg_iter
*notit
)
1535 if (notit
->emit_stream_end_msg
) {
1536 notit
->state
= STATE_EMIT_MSG_STREAM_ACTIVITY_END
;
1538 notit
->state
= STATE_DONE
;
1541 return BT_MSG_ITER_STATUS_OK
;
1545 enum bt_msg_iter_status
handle_state(struct bt_msg_iter
*notit
)
1547 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
1548 const enum state state
= notit
->state
;
1550 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1551 notit
, state_string(state
));
1553 // TODO: optimalize!
1556 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1558 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1559 status
= read_packet_header_begin_state(notit
);
1561 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1562 status
= read_packet_header_continue_state(notit
);
1564 case STATE_AFTER_TRACE_PACKET_HEADER
:
1565 status
= after_packet_header_state(notit
);
1567 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1568 status
= read_packet_context_begin_state(notit
);
1570 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1571 status
= read_packet_context_continue_state(notit
);
1573 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1574 status
= after_packet_context_state(notit
);
1576 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
1577 status
= check_emit_msg_stream_beginning_state(notit
);
1579 case STATE_EMIT_MSG_STREAM_BEGINNING
:
1580 notit
->state
= STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
;
1582 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
:
1583 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
;
1585 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
1586 status
= check_emit_msg_discarded_events(notit
);
1588 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
1589 notit
->state
= STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
;
1591 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
1592 status
= check_emit_msg_discarded_packets(notit
);
1594 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
1595 notit
->state
= STATE_EMIT_MSG_PACKET_BEGINNING
;
1597 case STATE_EMIT_MSG_PACKET_BEGINNING
:
1598 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1600 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1601 status
= read_event_header_begin_state(notit
);
1603 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1604 status
= read_event_header_continue_state(notit
);
1606 case STATE_AFTER_EVENT_HEADER
:
1607 status
= after_event_header_state(notit
);
1609 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1610 status
= read_event_common_context_begin_state(notit
);
1612 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1613 status
= read_event_common_context_continue_state(notit
);
1615 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1616 status
= read_event_spec_context_begin_state(notit
);
1618 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1619 status
= read_event_spec_context_continue_state(notit
);
1621 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1622 status
= read_event_payload_begin_state(notit
);
1624 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1625 status
= read_event_payload_continue_state(notit
);
1627 case STATE_EMIT_MSG_EVENT
:
1628 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1630 case STATE_SKIP_PACKET_PADDING
:
1631 status
= skip_packet_padding_state(notit
);
1633 case STATE_EMIT_MSG_PACKET_END_MULTI
:
1634 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1636 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
1637 notit
->state
= STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END
;
1639 case STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END
:
1640 status
= check_emit_msg_stream_activity_end(notit
);
1642 case STATE_EMIT_MSG_STREAM_ACTIVITY_END
:
1643 notit
->state
= STATE_EMIT_MSG_STREAM_END
;
1645 case STATE_EMIT_MSG_STREAM_END
:
1646 notit
->state
= STATE_DONE
;
1651 BT_LOGD("Unknown CTF plugin message iterator state: "
1652 "notit-addr=%p, state=%d", notit
, notit
->state
);
1656 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1657 "prev-state=%s, cur-state=%s",
1658 notit
, bt_msg_iter_status_string(status
),
1659 state_string(state
), state_string(notit
->state
));
1664 void bt_msg_iter_reset_for_next_stream_file(struct bt_msg_iter
*notit
)
1667 BT_LOGD("Resetting message iterator: addr=%p", notit
);
1668 stack_clear(notit
->stack
);
1669 notit
->meta
.sc
= NULL
;
1670 notit
->meta
.ec
= NULL
;
1671 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
1672 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
1673 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
1674 release_all_dscopes(notit
);
1675 notit
->cur_dscope_field
= NULL
;
1677 if (notit
->packet_context_field
) {
1678 bt_packet_context_field_release(notit
->packet_context_field
);
1679 notit
->packet_context_field
= NULL
;
1682 notit
->buf
.addr
= NULL
;
1685 notit
->buf
.last_eh_at
= SIZE_MAX
;
1686 notit
->buf
.packet_offset
= 0;
1687 notit
->state
= STATE_INIT
;
1688 notit
->cur_exp_packet_content_size
= -1;
1689 notit
->cur_exp_packet_total_size
= -1;
1690 notit
->cur_packet_offset
= -1;
1691 notit
->cur_event_class_id
= -1;
1692 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1693 notit
->snapshots
.end_clock
= UINT64_C(-1);
1697 * Resets the internal state of a CTF message iterator.
1700 void bt_msg_iter_reset(struct bt_msg_iter
*notit
)
1702 bt_msg_iter_reset_for_next_stream_file(notit
);
1703 notit
->cur_stream_class_id
= -1;
1704 notit
->cur_data_stream_id
= -1;
1705 notit
->emit_stream_begin_msg
= true;
1706 notit
->emit_stream_end_msg
= true;
1707 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1708 notit
->snapshots
.packets
= UINT64_C(-1);
1709 notit
->prev_packet_snapshots
.discarded_events
= UINT64_C(-1);
1710 notit
->prev_packet_snapshots
.packets
= UINT64_C(-1);
1711 notit
->prev_packet_snapshots
.beginning_clock
= UINT64_C(-1);
1712 notit
->prev_packet_snapshots
.end_clock
= UINT64_C(-1);
1716 int bt_msg_iter_switch_packet(struct bt_msg_iter
*notit
)
1721 * We don't put the stream class here because we need to make
1722 * sure that all the packets processed by the same message
1723 * iterator refer to the same stream class (the first one).
1727 if (notit
->cur_exp_packet_total_size
!= -1) {
1728 notit
->cur_packet_offset
+= notit
->cur_exp_packet_total_size
;
1731 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1732 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
1733 notit
->cur_packet_offset
);
1734 stack_clear(notit
->stack
);
1735 notit
->meta
.ec
= NULL
;
1736 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
1737 BT_MESSAGE_PUT_REF_AND_RESET(notit
->event_msg
);
1738 release_all_dscopes(notit
);
1739 notit
->cur_dscope_field
= NULL
;
1742 * Adjust current buffer so that addr points to the beginning of the new
1745 if (notit
->buf
.addr
) {
1746 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1748 /* Packets are assumed to start on a byte frontier. */
1749 if (notit
->buf
.at
% CHAR_BIT
) {
1750 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1751 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
1756 notit
->buf
.addr
+= consumed_bytes
;
1757 notit
->buf
.sz
-= consumed_bytes
;
1759 notit
->buf
.packet_offset
= 0;
1760 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1761 notit
->buf
.addr
, notit
->buf
.sz
);
1764 notit
->cur_exp_packet_content_size
= -1;
1765 notit
->cur_exp_packet_total_size
= -1;
1766 notit
->cur_stream_class_id
= -1;
1767 notit
->cur_event_class_id
= -1;
1768 notit
->cur_data_stream_id
= -1;
1769 notit
->prev_packet_snapshots
= notit
->snapshots
;
1770 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1771 notit
->snapshots
.packets
= UINT64_C(-1);
1772 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1773 notit
->snapshots
.end_clock
= UINT64_C(-1);
1780 bt_field
*borrow_next_field(struct bt_msg_iter
*notit
)
1782 bt_field
*next_field
= NULL
;
1783 bt_field
*base_field
;
1784 const bt_field_class
*base_fc
;
1787 BT_ASSERT(!stack_empty(notit
->stack
));
1788 index
= stack_top(notit
->stack
)->index
;
1789 base_field
= stack_top(notit
->stack
)->base
;
1790 BT_ASSERT(base_field
);
1791 base_fc
= bt_field_borrow_class_const(base_field
);
1794 switch (bt_field_class_get_type(base_fc
)) {
1795 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1798 bt_field_class_structure_get_member_count(
1799 bt_field_borrow_class_const(
1802 bt_field_structure_borrow_member_field_by_index(
1806 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1807 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1808 BT_ASSERT(index
< bt_field_array_get_length(base_field
));
1809 next_field
= bt_field_array_borrow_element_field_by_index(
1812 case BT_FIELD_CLASS_TYPE_VARIANT
:
1813 BT_ASSERT(index
== 0);
1814 next_field
= bt_field_variant_borrow_selected_option_field(
1821 BT_ASSERT(next_field
);
1826 void update_default_clock(struct bt_msg_iter
*notit
, uint64_t new_val
,
1827 uint64_t new_val_size
)
1829 uint64_t new_val_mask
;
1830 uint64_t cur_value_masked
;
1832 BT_ASSERT(new_val_size
> 0);
1835 * Special case for a 64-bit new value, which is the limit
1836 * of a clock value as of this version: overwrite the
1837 * current value directly.
1839 if (new_val_size
== 64) {
1840 notit
->default_clock_snapshot
= new_val
;
1844 new_val_mask
= (1ULL << new_val_size
) - 1;
1845 cur_value_masked
= notit
->default_clock_snapshot
& new_val_mask
;
1847 if (new_val
< cur_value_masked
) {
1849 * It looks like a wrap happened on the number of bits
1850 * of the requested new value. Assume that the clock
1851 * value wrapped only one time.
1853 notit
->default_clock_snapshot
+= new_val_mask
+ 1;
1856 /* Clear the low bits of the current clock value. */
1857 notit
->default_clock_snapshot
&= ~new_val_mask
;
1859 /* Set the low bits of the current clock value. */
1860 notit
->default_clock_snapshot
|= new_val
;
1863 BT_LOGV("Updated default clock's value from integer field's value: "
1864 "value=%" PRIu64
, notit
->default_clock_snapshot
);
1868 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1869 struct ctf_field_class
*fc
, void *data
)
1871 struct bt_msg_iter
*notit
= data
;
1872 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1873 bt_field
*field
= NULL
;
1874 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1876 BT_LOGV("Unsigned integer function called from BFCR: "
1877 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1878 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1879 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1881 if (likely(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1882 goto update_def_clock
;
1885 switch (int_fc
->meaning
) {
1886 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1887 notit
->cur_event_class_id
= value
;
1889 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1890 notit
->cur_data_stream_id
= value
;
1892 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1893 notit
->snapshots
.beginning_clock
= value
;
1895 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1896 notit
->snapshots
.end_clock
= value
;
1898 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1899 notit
->cur_stream_class_id
= value
;
1901 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1902 if (value
!= 0xc1fc1fc1) {
1903 BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
1904 "magic=%" PRIx64
, notit
, value
);
1905 status
= BT_BFCR_STATUS_ERROR
;
1910 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1911 notit
->snapshots
.packets
= value
;
1913 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1914 notit
->snapshots
.discarded_events
= value
;
1916 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1917 notit
->cur_exp_packet_total_size
= value
;
1919 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1920 notit
->cur_exp_packet_content_size
= value
;
1927 if (unlikely(int_fc
->mapped_clock_class
)) {
1928 update_default_clock(notit
, value
, int_fc
->base
.size
);
1931 if (unlikely(int_fc
->storing_index
>= 0)) {
1932 g_array_index(notit
->stored_values
, uint64_t,
1933 (uint64_t) int_fc
->storing_index
) = value
;
1936 if (unlikely(!fc
->in_ir
)) {
1940 field
= borrow_next_field(notit
);
1942 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1943 BT_ASSERT(bt_field_get_class_type(field
) ==
1944 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
1945 bt_field_get_class_type(field
) ==
1946 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
);
1947 bt_field_unsigned_integer_set_value(field
, value
);
1948 stack_top(notit
->stack
)->index
++;
1955 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
1956 struct ctf_field_class
*fc
, void *data
)
1959 struct bt_msg_iter
*notit
= data
;
1960 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1961 bt_field
*string_field
= NULL
;
1962 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1963 char str
[2] = {'\0', '\0'};
1965 BT_LOGV("Unsigned integer character function called from BFCR: "
1966 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1967 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1968 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1969 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1970 BT_ASSERT(!int_fc
->mapped_clock_class
);
1971 BT_ASSERT(int_fc
->storing_index
< 0);
1973 if (unlikely(!fc
->in_ir
)) {
1977 if (notit
->done_filling_string
) {
1982 notit
->done_filling_string
= true;
1986 string_field
= stack_top(notit
->stack
)->base
;
1987 BT_ASSERT(bt_field_get_class_type(string_field
) ==
1988 BT_FIELD_CLASS_TYPE_STRING
);
1990 /* Append character */
1991 str
[0] = (char) value
;
1992 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
1994 BT_LOGE("Cannot append character to string field's value: "
1995 "notit-addr=%p, field-addr=%p, ret=%d",
1996 notit
, string_field
, ret
);
1997 status
= BT_BFCR_STATUS_ERROR
;
2006 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
2007 struct ctf_field_class
*fc
, void *data
)
2009 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2010 bt_field
*field
= NULL
;
2011 struct bt_msg_iter
*notit
= data
;
2012 struct ctf_field_class_int
*int_fc
= (void *) fc
;
2014 BT_LOGV("Signed integer function called from BFCR: "
2015 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2016 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
2017 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2018 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
2020 if (unlikely(int_fc
->storing_index
>= 0)) {
2021 g_array_index(notit
->stored_values
, uint64_t,
2022 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
2025 if (unlikely(!fc
->in_ir
)) {
2029 field
= borrow_next_field(notit
);
2031 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2032 BT_ASSERT(bt_field_get_class_type(field
) ==
2033 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
2034 bt_field_get_class_type(field
) ==
2035 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
);
2036 bt_field_signed_integer_set_value(field
, value
);
2037 stack_top(notit
->stack
)->index
++;
2044 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
2045 struct ctf_field_class
*fc
, void *data
)
2047 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2048 bt_field
*field
= NULL
;
2049 struct bt_msg_iter
*notit
= data
;
2051 BT_LOGV("Floating point number function called from BFCR: "
2052 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2053 "fc-type=%d, fc-in-ir=%d, value=%f",
2054 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
2056 if (unlikely(!fc
->in_ir
)) {
2060 field
= borrow_next_field(notit
);
2062 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2063 BT_ASSERT(bt_field_get_class_type(field
) ==
2064 BT_FIELD_CLASS_TYPE_REAL
);
2065 bt_field_real_set_value(field
, value
);
2066 stack_top(notit
->stack
)->index
++;
2073 enum bt_bfcr_status
bfcr_string_begin_cb(
2074 struct ctf_field_class
*fc
, void *data
)
2076 bt_field
*field
= NULL
;
2077 struct bt_msg_iter
*notit
= data
;
2080 BT_LOGV("String (beginning) function called from BFCR: "
2081 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2082 "fc-type=%d, fc-in-ir=%d",
2083 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2085 if (unlikely(!fc
->in_ir
)) {
2089 field
= borrow_next_field(notit
);
2091 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2092 BT_ASSERT(bt_field_get_class_type(field
) ==
2093 BT_FIELD_CLASS_TYPE_STRING
);
2094 ret
= bt_field_string_clear(field
);
2095 BT_ASSERT(ret
== 0);
2098 * Push on stack. Not a compound class per se, but we know that
2099 * only bfcr_string_cb() may be called between this call and a
2100 * subsequent call to bfcr_string_end_cb().
2102 stack_push(notit
->stack
, field
);
2105 return BT_BFCR_STATUS_OK
;
2109 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2110 size_t len
, struct ctf_field_class
*fc
, void *data
)
2112 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2113 bt_field
*field
= NULL
;
2114 struct bt_msg_iter
*notit
= data
;
2117 BT_LOGV("String (substring) function called from BFCR: "
2118 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2119 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2120 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2123 if (unlikely(!fc
->in_ir
)) {
2127 field
= stack_top(notit
->stack
)->base
;
2130 /* Append current substring */
2131 ret
= bt_field_string_append_with_length(field
, value
, len
);
2133 BT_LOGE("Cannot append substring to string field's value: "
2134 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2135 "ret=%d", notit
, field
, len
, ret
);
2136 status
= BT_BFCR_STATUS_ERROR
;
2145 enum bt_bfcr_status
bfcr_string_end_cb(
2146 struct ctf_field_class
*fc
, void *data
)
2148 struct bt_msg_iter
*notit
= data
;
2150 BT_LOGV("String (end) function called from BFCR: "
2151 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2152 "fc-type=%d, fc-in-ir=%d",
2153 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2155 if (unlikely(!fc
->in_ir
)) {
2159 /* Pop string field */
2160 stack_pop(notit
->stack
);
2162 /* Go to next field */
2163 stack_top(notit
->stack
)->index
++;
2166 return BT_BFCR_STATUS_OK
;
2169 enum bt_bfcr_status
bfcr_compound_begin_cb(
2170 struct ctf_field_class
*fc
, void *data
)
2172 struct bt_msg_iter
*notit
= data
;
2175 BT_LOGV("Compound (beginning) function called from BFCR: "
2176 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2177 "fc-type=%d, fc-in-ir=%d",
2178 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2185 if (stack_empty(notit
->stack
)) {
2186 /* Root: already set by read_dscope_begin_state() */
2187 field
= notit
->cur_dscope_field
;
2189 field
= borrow_next_field(notit
);
2195 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2196 stack_push(notit
->stack
, field
);
2199 * Change BFCR "unsigned int" callback if it's a text
2202 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2203 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2204 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2206 if (array_fc
->is_text
) {
2209 BT_ASSERT(bt_field_get_class_type(field
) ==
2210 BT_FIELD_CLASS_TYPE_STRING
);
2211 notit
->done_filling_string
= false;
2212 ret
= bt_field_string_clear(field
);
2213 BT_ASSERT(ret
== 0);
2214 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2215 bfcr_unsigned_int_char_cb
);
2220 return BT_BFCR_STATUS_OK
;
2223 enum bt_bfcr_status
bfcr_compound_end_cb(
2224 struct ctf_field_class
*fc
, void *data
)
2226 struct bt_msg_iter
*notit
= data
;
2228 BT_LOGV("Compound (end) function called from BFCR: "
2229 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2230 "fc-type=%d, fc-in-ir=%d",
2231 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2237 BT_ASSERT(!stack_empty(notit
->stack
));
2238 BT_ASSERT(bt_field_borrow_class_const(stack_top(notit
->stack
)->base
) ==
2242 * Reset BFCR "unsigned int" callback if it's a text
2245 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2246 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2247 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2249 if (array_fc
->is_text
) {
2250 BT_ASSERT(bt_field_get_class_type(
2251 stack_top(notit
->stack
)->base
) ==
2252 BT_FIELD_CLASS_TYPE_STRING
);
2253 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2254 bfcr_unsigned_int_cb
);
2259 stack_pop(notit
->stack
);
2261 /* If the stack is not empty, increment the base's index */
2262 if (!stack_empty(notit
->stack
)) {
2263 stack_top(notit
->stack
)->index
++;
2267 return BT_BFCR_STATUS_OK
;
2271 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2273 bt_field
*seq_field
;
2274 struct bt_msg_iter
*notit
= data
;
2275 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2276 int64_t length
= -1;
2279 length
= (uint64_t) g_array_index(notit
->stored_values
, uint64_t,
2280 seq_fc
->stored_length_index
);
2281 seq_field
= stack_top(notit
->stack
)->base
;
2282 BT_ASSERT(seq_field
);
2283 ret
= bt_field_dynamic_array_set_length(seq_field
, (uint64_t) length
);
2285 BT_LOGE("Cannot set dynamic array field's length field: "
2286 "notit-addr=%p, field-addr=%p, "
2287 "length=%" PRIu64
, notit
, seq_field
, length
);
2294 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2295 struct ctf_field_class
*fc
, void *data
)
2299 int64_t option_index
= -1;
2300 struct bt_msg_iter
*notit
= data
;
2301 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2302 struct ctf_named_field_class
*selected_option
= NULL
;
2303 struct ctf_field_class
*ret_fc
= NULL
;
2309 /* Get variant's tag */
2310 tag
.u
= g_array_index(notit
->stored_values
, uint64_t,
2311 var_fc
->stored_tag_index
);
2314 * Check each range to find the selected option's index.
2316 if (var_fc
->tag_fc
->base
.is_signed
) {
2317 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2318 struct ctf_field_class_variant_range
*range
=
2319 ctf_field_class_variant_borrow_range_by_index(
2322 if (tag
.i
>= range
->range
.lower
.i
&&
2323 tag
.i
<= range
->range
.upper
.i
) {
2324 option_index
= (int64_t) range
->option_index
;
2329 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2330 struct ctf_field_class_variant_range
*range
=
2331 ctf_field_class_variant_borrow_range_by_index(
2334 if (tag
.u
>= range
->range
.lower
.u
&&
2335 tag
.u
<= range
->range
.upper
.u
) {
2336 option_index
= (int64_t) range
->option_index
;
2342 if (option_index
< 0) {
2343 BT_LOGW("Cannot find variant field class's option: "
2344 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2345 "i-tag=%" PRId64
, notit
, var_fc
, tag
.u
, tag
.i
);
2349 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2350 var_fc
, (uint64_t) option_index
);
2352 if (selected_option
->fc
->in_ir
) {
2353 bt_field
*var_field
= stack_top(notit
->stack
)->base
;
2355 ret
= bt_field_variant_select_option_field(
2356 var_field
, option_index
);
2358 BT_LOGW("Cannot select variant field's option field: "
2359 "notit-addr=%p, var-field-addr=%p, "
2360 "opt-index=%" PRId64
, notit
, var_field
,
2366 ret_fc
= selected_option
->fc
;
2373 void set_event_default_clock_snapshot(struct bt_msg_iter
*notit
)
2375 bt_event
*event
= bt_message_event_borrow_event(notit
->event_msg
);
2376 bt_stream_class
*sc
= notit
->meta
.sc
->ir_sc
;
2380 if (bt_stream_class_borrow_default_clock_class(sc
)) {
2381 bt_event_set_default_clock_snapshot(event
,
2382 notit
->default_clock_snapshot
);
2387 void create_msg_stream_beginning(struct bt_msg_iter
*notit
,
2388 bt_message
**message
)
2390 bt_message
*ret
= NULL
;
2392 BT_ASSERT(notit
->stream
);
2393 BT_ASSERT(notit
->msg_iter
);
2394 ret
= bt_message_stream_beginning_create(notit
->msg_iter
,
2397 BT_LOGE("Cannot create stream beginning message: "
2398 "notit-addr=%p, stream-addr=%p",
2399 notit
, notit
->stream
);
2407 void create_msg_stream_activity_beginning(struct bt_msg_iter
*notit
,
2408 bt_message
**message
)
2410 bt_message
*ret
= NULL
;
2412 BT_ASSERT(notit
->stream
);
2413 BT_ASSERT(notit
->msg_iter
);
2414 ret
= bt_message_stream_activity_beginning_create(notit
->msg_iter
,
2417 BT_LOGE("Cannot create stream activity beginning message: "
2418 "notit-addr=%p, stream-addr=%p",
2419 notit
, notit
->stream
);
2427 void create_msg_stream_activity_end(struct bt_msg_iter
*notit
,
2428 bt_message
**message
)
2430 bt_message
*ret
= NULL
;
2432 if (!notit
->stream
) {
2433 BT_LOGE("Cannot create stream for stream message: "
2434 "notit-addr=%p", notit
);
2438 BT_ASSERT(notit
->stream
);
2439 BT_ASSERT(notit
->msg_iter
);
2440 ret
= bt_message_stream_activity_end_create(notit
->msg_iter
,
2443 BT_LOGE("Cannot create stream activity end message: "
2444 "notit-addr=%p, stream-addr=%p",
2445 notit
, notit
->stream
);
2453 void create_msg_stream_end(struct bt_msg_iter
*notit
, bt_message
**message
)
2457 if (!notit
->stream
) {
2458 BT_LOGE("Cannot create stream for stream message: "
2459 "notit-addr=%p", notit
);
2463 BT_ASSERT(notit
->msg_iter
);
2464 ret
= bt_message_stream_end_create(notit
->msg_iter
,
2467 BT_LOGE("Cannot create stream end message: "
2468 "notit-addr=%p, stream-addr=%p",
2469 notit
, notit
->stream
);
2477 void create_msg_packet_beginning(struct bt_msg_iter
*notit
,
2478 bt_message
**message
)
2481 enum bt_msg_iter_status status
;
2482 bt_message
*msg
= NULL
;
2483 const bt_stream_class
*sc
;
2485 status
= set_current_packet(notit
);
2486 if (status
!= BT_MSG_ITER_STATUS_OK
) {
2490 BT_ASSERT(notit
->packet
);
2491 sc
= notit
->meta
.sc
->ir_sc
;
2494 if (notit
->packet_context_field
) {
2495 ret
= bt_packet_move_context_field(
2496 notit
->packet
, notit
->packet_context_field
);
2501 notit
->packet_context_field
= NULL
;
2504 * At this point notit->dscopes.stream_packet_context
2505 * has the same value as the packet context field within
2508 BT_ASSERT(bt_packet_borrow_context_field(
2510 notit
->dscopes
.stream_packet_context
);
2513 BT_ASSERT(notit
->msg_iter
);
2515 if (notit
->snapshots
.beginning_clock
== UINT64_C(-1)) {
2516 msg
= bt_message_packet_beginning_create(notit
->msg_iter
,
2519 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
2520 notit
->msg_iter
, notit
->packet
,
2521 notit
->snapshots
.beginning_clock
);
2525 BT_LOGE("Cannot create packet beginning message: "
2526 "notit-addr=%p, packet-addr=%p",
2527 notit
, notit
->packet
);
2538 void create_msg_packet_end(struct bt_msg_iter
*notit
, bt_message
**message
)
2542 if (!notit
->packet
) {
2546 /* Update default clock from packet's end time */
2547 if (notit
->snapshots
.end_clock
!= UINT64_C(-1)) {
2548 notit
->default_clock_snapshot
= notit
->snapshots
.end_clock
;
2551 BT_ASSERT(notit
->msg_iter
);
2553 if (notit
->snapshots
.end_clock
== UINT64_C(-1)) {
2554 msg
= bt_message_packet_end_create(notit
->msg_iter
,
2557 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
2558 notit
->msg_iter
, notit
->packet
,
2559 notit
->snapshots
.end_clock
);
2563 BT_LOGE("Cannot create packet end message: "
2564 "notit-addr=%p, packet-addr=%p",
2565 notit
, notit
->packet
);
2570 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2575 void create_msg_discarded_events(struct bt_msg_iter
*notit
,
2576 bt_message
**message
)
2579 uint64_t beginning_raw_value
= UINT64_C(-1);
2580 uint64_t end_raw_value
= UINT64_C(-1);
2581 uint64_t count
= UINT64_C(-1);
2583 BT_ASSERT(notit
->msg_iter
);
2584 BT_ASSERT(notit
->stream
);
2586 if (notit
->prev_packet_snapshots
.discarded_events
== UINT64_C(-1)) {
2588 * We discarded events, but before (and possibly
2589 * including) the current packet: use this packet's time
2590 * range, and do not have a specific count.
2592 beginning_raw_value
= notit
->snapshots
.beginning_clock
;
2593 end_raw_value
= notit
->snapshots
.end_clock
;
2595 count
= notit
->snapshots
.discarded_events
-
2596 notit
->prev_packet_snapshots
.discarded_events
;
2597 BT_ASSERT(count
> 0);
2598 beginning_raw_value
= notit
->prev_packet_snapshots
.end_clock
;
2599 end_raw_value
= notit
->snapshots
.end_clock
;
2602 if (beginning_raw_value
!= UINT64_C(-1) &&
2603 end_raw_value
!= UINT64_C(-1)) {
2604 msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
2605 notit
->msg_iter
, notit
->stream
, beginning_raw_value
,
2608 msg
= bt_message_discarded_events_create(notit
->msg_iter
,
2613 BT_LOGE("Cannot create discarded events message: "
2614 "notit-addr=%p, stream-addr=%p",
2615 notit
, notit
->stream
);
2619 if (count
!= UINT64_C(-1)) {
2620 bt_message_discarded_events_set_count(msg
, count
);
2627 void create_msg_discarded_packets(struct bt_msg_iter
*notit
,
2628 bt_message
**message
)
2632 BT_ASSERT(notit
->msg_iter
);
2633 BT_ASSERT(notit
->stream
);
2634 BT_ASSERT(notit
->prev_packet_snapshots
.packets
!=
2637 if (notit
->prev_packet_snapshots
.end_clock
!= UINT64_C(-1) &&
2638 notit
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
2639 msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
2640 notit
->msg_iter
, notit
->stream
,
2641 notit
->prev_packet_snapshots
.end_clock
,
2642 notit
->snapshots
.beginning_clock
);
2644 msg
= bt_message_discarded_packets_create(notit
->msg_iter
,
2649 BT_LOGE("Cannot create discarded packets message: "
2650 "notit-addr=%p, stream-addr=%p",
2651 notit
, notit
->stream
);
2655 bt_message_discarded_packets_set_count(msg
,
2656 notit
->snapshots
.packets
-
2657 notit
->prev_packet_snapshots
.packets
- 1);
2662 struct bt_msg_iter
*bt_msg_iter_create(struct ctf_trace_class
*tc
,
2663 size_t max_request_sz
,
2664 struct bt_msg_iter_medium_ops medops
, void *data
)
2666 struct bt_msg_iter
*notit
= NULL
;
2667 struct bt_bfcr_cbs cbs
= {
2669 .signed_int
= bfcr_signed_int_cb
,
2670 .unsigned_int
= bfcr_unsigned_int_cb
,
2671 .floating_point
= bfcr_floating_point_cb
,
2672 .string_begin
= bfcr_string_begin_cb
,
2673 .string
= bfcr_string_cb
,
2674 .string_end
= bfcr_string_end_cb
,
2675 .compound_begin
= bfcr_compound_begin_cb
,
2676 .compound_end
= bfcr_compound_end_cb
,
2679 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2680 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2685 BT_ASSERT(medops
.request_bytes
);
2686 BT_ASSERT(medops
.borrow_stream
);
2687 BT_LOGD("Creating CTF plugin message iterator: "
2688 "trace-addr=%p, max-request-size=%zu, "
2689 "data=%p", tc
, max_request_sz
, data
);
2690 notit
= g_new0(struct bt_msg_iter
, 1);
2692 BT_LOGE_STR("Failed to allocate one CTF plugin message iterator.");
2695 notit
->meta
.tc
= tc
;
2696 notit
->medium
.medops
= medops
;
2697 notit
->medium
.max_request_sz
= max_request_sz
;
2698 notit
->medium
.data
= data
;
2699 notit
->stack
= stack_new(notit
);
2700 notit
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2701 g_array_set_size(notit
->stored_values
, tc
->stored_value_count
);
2703 if (!notit
->stack
) {
2704 BT_LOGE_STR("Failed to create field stack.");
2708 notit
->bfcr
= bt_bfcr_create(cbs
, notit
);
2710 BT_LOGE_STR("Failed to create binary class reader (BFCR).");
2714 bt_msg_iter_reset(notit
);
2715 BT_LOGD("Created CTF plugin message iterator: "
2716 "trace-addr=%p, max-request-size=%zu, "
2717 "data=%p, notit-addr=%p",
2718 tc
, max_request_sz
, data
, notit
);
2719 notit
->cur_packet_offset
= 0;
2725 bt_msg_iter_destroy(notit
);
2730 void bt_msg_iter_destroy(struct bt_msg_iter
*notit
)
2732 BT_PACKET_PUT_REF_AND_RESET(notit
->packet
);
2733 BT_STREAM_PUT_REF_AND_RESET(notit
->stream
);
2734 release_all_dscopes(notit
);
2736 BT_LOGD("Destroying CTF plugin message iterator: addr=%p", notit
);
2739 BT_LOGD_STR("Destroying field stack.");
2740 stack_destroy(notit
->stack
);
2744 BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit
->bfcr
);
2745 bt_bfcr_destroy(notit
->bfcr
);
2748 if (notit
->stored_values
) {
2749 g_array_free(notit
->stored_values
, TRUE
);
2755 enum bt_msg_iter_status
bt_msg_iter_get_next_message(
2756 struct bt_msg_iter
*notit
,
2757 bt_self_message_iterator
*msg_iter
, bt_message
**message
)
2759 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2763 notit
->msg_iter
= msg_iter
;
2764 notit
->set_stream
= true;
2765 BT_LOGV("Getting next message: notit-addr=%p", notit
);
2768 status
= handle_state(notit
);
2769 if (unlikely(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2770 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2772 } else if (unlikely(status
!= BT_MSG_ITER_STATUS_OK
)) {
2773 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2774 notit
, state_string(notit
->state
));
2778 switch (notit
->state
) {
2779 case STATE_EMIT_MSG_EVENT
:
2780 BT_ASSERT(notit
->event_msg
);
2781 set_event_default_clock_snapshot(notit
);
2782 *message
= notit
->event_msg
;
2783 notit
->event_msg
= NULL
;
2785 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2786 /* create_msg_discared_events() logs errors */
2787 create_msg_discarded_events(notit
, message
);
2790 status
= BT_MSG_ITER_STATUS_ERROR
;
2794 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2795 /* create_msg_discared_packets() logs errors */
2796 create_msg_discarded_packets(notit
, message
);
2799 status
= BT_MSG_ITER_STATUS_ERROR
;
2803 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2804 /* create_msg_packet_beginning() logs errors */
2805 create_msg_packet_beginning(notit
, message
);
2808 status
= BT_MSG_ITER_STATUS_ERROR
;
2812 case STATE_EMIT_MSG_PACKET_END_SINGLE
:
2813 case STATE_EMIT_MSG_PACKET_END_MULTI
:
2814 /* create_msg_packet_end() logs errors */
2815 create_msg_packet_end(notit
, message
);
2818 status
= BT_MSG_ITER_STATUS_ERROR
;
2822 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
:
2823 /* create_msg_stream_activity_beginning() logs errors */
2824 create_msg_stream_activity_beginning(notit
, message
);
2827 status
= BT_MSG_ITER_STATUS_ERROR
;
2831 case STATE_EMIT_MSG_STREAM_ACTIVITY_END
:
2832 /* create_msg_stream_activity_end() logs errors */
2833 create_msg_stream_activity_end(notit
, message
);
2836 status
= BT_MSG_ITER_STATUS_ERROR
;
2840 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2841 /* create_msg_stream_beginning() logs errors */
2842 create_msg_stream_beginning(notit
, message
);
2845 status
= BT_MSG_ITER_STATUS_ERROR
;
2849 case STATE_EMIT_MSG_STREAM_END
:
2850 /* create_msg_stream_end() logs errors */
2851 create_msg_stream_end(notit
, message
);
2854 status
= BT_MSG_ITER_STATUS_ERROR
;
2859 status
= BT_MSG_ITER_STATUS_EOF
;
2862 /* Non-emitting state: continue */
2872 enum bt_msg_iter_status
read_packet_header_context_fields(
2873 struct bt_msg_iter
*notit
)
2876 enum bt_msg_iter_status status
= BT_MSG_ITER_STATUS_OK
;
2879 notit
->set_stream
= false;
2881 if (notit
->state
== STATE_EMIT_MSG_PACKET_BEGINNING
) {
2882 /* We're already there */
2887 status
= handle_state(notit
);
2888 if (unlikely(status
== BT_MSG_ITER_STATUS_AGAIN
)) {
2889 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2891 } else if (unlikely(status
!= BT_MSG_ITER_STATUS_OK
)) {
2892 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2893 notit
, state_string(notit
->state
));
2897 switch (notit
->state
) {
2898 case STATE_EMIT_MSG_PACKET_BEGINNING
:
2900 * Packet header and context fields are
2901 * potentially decoded (or they don't exist).
2905 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
2906 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
2907 case STATE_AFTER_TRACE_PACKET_HEADER
:
2908 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
2909 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
2910 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
2911 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING
:
2912 case STATE_EMIT_MSG_STREAM_BEGINNING
:
2913 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING
:
2914 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS
:
2915 case STATE_EMIT_MSG_DISCARDED_EVENTS
:
2916 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS
:
2917 case STATE_EMIT_MSG_DISCARDED_PACKETS
:
2918 /* Non-emitting state: continue */
2922 * We should never get past the
2923 * STATE_EMIT_MSG_PACKET_BEGINNING state.
2925 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
2926 notit
, state_string(notit
->state
));
2932 ret
= set_current_packet_content_sizes(notit
);
2934 status
= BT_MSG_ITER_STATUS_ERROR
;
2942 void bt_msg_iter_set_medops_data(struct bt_msg_iter
*notit
,
2946 notit
->medium
.data
= medops_data
;
2950 enum bt_msg_iter_status
bt_msg_iter_seek(struct bt_msg_iter
*notit
,
2953 enum bt_msg_iter_status ret
= BT_MSG_ITER_STATUS_OK
;
2954 enum bt_msg_iter_medium_status medium_status
;
2958 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset
);
2959 ret
= BT_MSG_ITER_STATUS_INVAL
;
2963 if (!notit
->medium
.medops
.seek
) {
2964 ret
= BT_MSG_ITER_STATUS_UNSUPPORTED
;
2965 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2969 medium_status
= notit
->medium
.medops
.seek(
2970 BT_MSG_ITER_SEEK_WHENCE_SET
, offset
, notit
->medium
.data
);
2971 if (medium_status
!= BT_MSG_ITER_MEDIUM_STATUS_OK
) {
2972 if (medium_status
== BT_MSG_ITER_MEDIUM_STATUS_EOF
) {
2973 ret
= BT_MSG_ITER_STATUS_EOF
;
2975 ret
= BT_MSG_ITER_STATUS_ERROR
;
2980 bt_msg_iter_reset(notit
);
2981 notit
->cur_packet_offset
= offset
;
2988 enum bt_msg_iter_status
bt_msg_iter_get_packet_properties(
2989 struct bt_msg_iter
*notit
,
2990 struct bt_msg_iter_packet_properties
*props
)
2992 enum bt_msg_iter_status status
;
2996 status
= read_packet_header_context_fields(notit
);
2997 if (status
!= BT_MSG_ITER_STATUS_OK
) {
3001 props
->exp_packet_total_size
= notit
->cur_exp_packet_total_size
;
3002 props
->exp_packet_content_size
= notit
->cur_exp_packet_content_size
;
3003 BT_ASSERT(props
->stream_class_id
>= 0);
3004 props
->stream_class_id
= (uint64_t) notit
->cur_stream_class_id
;
3005 props
->data_stream_id
= notit
->cur_data_stream_id
;
3006 props
->snapshots
.discarded_events
= notit
->snapshots
.discarded_events
;
3007 props
->snapshots
.packets
= notit
->snapshots
.packets
;
3008 props
->snapshots
.beginning_clock
= notit
->snapshots
.beginning_clock
;
3009 props
->snapshots
.end_clock
= notit
->snapshots
.end_clock
;
3016 void bt_msg_iter_set_emit_stream_beginning_message(struct bt_msg_iter
*notit
,
3019 notit
->emit_stream_begin_msg
= val
;
3023 void bt_msg_iter_set_emit_stream_end_message(struct bt_msg_iter
*notit
,
3026 notit
->emit_stream_end_msg
= val
;