2 * Babeltrace - CTF notification 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-NOTIF-ITER"
34 #include <babeltrace/assert-internal.h>
36 #include <babeltrace/babeltrace.h>
37 #include <babeltrace/common-internal.h>
41 #include "notif-iter.h"
42 #include "../bfcr/bfcr.h"
46 /* A visit stack entry */
49 * Current base field, one of:
59 struct bt_field
*base
;
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_EMIT_NOTIF_NEW_STREAM
,
84 STATE_EMIT_NOTIF_NEW_PACKET
,
85 STATE_DSCOPE_EVENT_HEADER_BEGIN
,
86 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
87 STATE_AFTER_EVENT_HEADER
,
88 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
,
89 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
90 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
91 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
92 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
93 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
94 STATE_EMIT_NOTIF_EVENT
,
95 STATE_EMIT_NOTIF_END_OF_PACKET
,
97 STATE_SKIP_PACKET_PADDING
,
100 /* CTF notification iterator */
101 struct bt_notif_iter
{
105 /* Current notification iterator to create notifications (weak) */
106 struct bt_self_notification_iterator
*notif_iter
;
109 * Current dynamic scope field pointer.
111 * This is set by read_dscope_begin_state() and contains the
112 * value of one of the pointers in `dscopes` below.
114 struct bt_field
*cur_dscope_field
;
117 * True if we're done filling a string field from a text
118 * array/sequence payload.
120 bool done_filling_string
;
122 /* Trace and classes */
124 struct ctf_trace_class
*tc
;
125 struct ctf_stream_class
*sc
;
126 struct ctf_event_class
*ec
;
129 /* Current packet header field wrapper (NULL if not created yet) */
130 struct bt_packet_header_field
*packet_header_field
;
132 /* Current packet header field wrapper (NULL if not created yet) */
133 struct bt_packet_context_field
*packet_context_field
;
135 /* Current event header field (NULL if not created yet) */
136 struct bt_event_header_field
*event_header_field
;
138 /* Current packet (NULL if not created yet) */
139 struct bt_packet
*packet
;
141 /* Current stream (NULL if not set yet) */
142 struct bt_stream
*stream
;
144 /* Current event (NULL if not created yet) */
145 struct bt_event
*event
;
147 /* Current event notification (NULL if not created yet) */
148 struct bt_notification
*event_notif
;
150 /* Database of current dynamic scopes */
152 struct bt_field
*trace_packet_header
;
153 struct bt_field
*stream_packet_context
;
154 struct bt_field
*event_header
;
155 struct bt_field
*event_common_context
;
156 struct bt_field
*event_spec_context
;
157 struct bt_field
*event_payload
;
163 /* Current medium buffer data */
165 /* Last address provided by medium */
168 /* Buffer size provided by medium (bytes) */
171 /* Offset within whole packet of addr (bits) */
172 size_t packet_offset
;
174 /* Current position from addr (bits) */
177 /* Position of the last event header from addr (bits) */
181 /* Binary type reader */
182 struct bt_bfcr
*bfcr
;
184 /* Current medium data */
186 struct bt_notif_iter_medium_ops medops
;
187 size_t max_request_sz
;
191 /* Stream beginning was emitted */
192 bool stream_begin_emitted
;
194 /* Current packet size (bits) (-1 if unknown) */
195 int64_t cur_exp_packet_total_size
;
197 /* Current content size (bits) (-1 if unknown) */
198 int64_t cur_exp_packet_content_size
;
200 /* Current stream class ID */
201 int64_t cur_stream_class_id
;
203 /* Current event class ID */
204 int64_t cur_event_class_id
;
206 /* Current data stream ID */
207 int64_t cur_data_stream_id
;
210 * Offset, in the underlying media, of the current packet's
211 * start (-1 if unknown).
213 off_t cur_packet_offset
;
215 /* Default clock's current value */
216 uint64_t default_clock_val
;
218 /* End of packet snapshots */
220 uint64_t discarded_events
;
222 uint64_t beginning_clock
;
226 /* Stored values (for sequence lengths, variant tags) */
227 GArray
*stored_values
;
231 const char *state_string(enum state state
)
236 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
237 return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
238 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
239 return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
240 case STATE_AFTER_TRACE_PACKET_HEADER
:
241 return "STATE_AFTER_TRACE_PACKET_HEADER";
242 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
243 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
244 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
245 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
246 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
247 return "STATE_AFTER_STREAM_PACKET_CONTEXT";
248 case STATE_EMIT_NOTIF_NEW_PACKET
:
249 return "STATE_EMIT_NOTIF_NEW_PACKET";
250 case STATE_EMIT_NOTIF_NEW_STREAM
:
251 return "STATE_EMIT_NOTIF_NEW_STREAM";
252 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
253 return "STATE_DSCOPE_EVENT_HEADER_BEGIN";
254 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
255 return "STATE_DSCOPE_EVENT_HEADER_CONTINUE";
256 case STATE_AFTER_EVENT_HEADER
:
257 return "STATE_AFTER_EVENT_HEADER";
258 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
259 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
260 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
261 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
262 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
263 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
264 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
265 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
266 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
267 return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
268 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
269 return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
270 case STATE_EMIT_NOTIF_EVENT
:
271 return "STATE_EMIT_NOTIF_EVENT";
272 case STATE_EMIT_NOTIF_END_OF_PACKET
:
273 return "STATE_EMIT_NOTIF_END_OF_PACKET";
276 case STATE_SKIP_PACKET_PADDING
:
277 return "STATE_SKIP_PACKET_PADDING";
284 int bt_notif_iter_switch_packet(struct bt_notif_iter
*notit
);
287 struct stack
*stack_new(struct bt_notif_iter
*notit
)
289 struct stack
*stack
= NULL
;
291 stack
= g_new0(struct stack
, 1);
293 BT_LOGE_STR("Failed to allocate one stack.");
297 stack
->entries
= g_array_new(FALSE
, TRUE
, sizeof(struct stack_entry
));
298 if (!stack
->entries
) {
299 BT_LOGE_STR("Failed to allocate a GArray.");
303 BT_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit
, stack
);
315 void stack_destroy(struct stack
*stack
)
318 BT_LOGD("Destroying stack: addr=%p", stack
);
320 if (stack
->entries
) {
321 g_array_free(stack
->entries
, TRUE
);
328 void stack_push(struct stack
*stack
, struct bt_field
*base
)
330 struct stack_entry
*entry
;
334 BT_LOGV("Pushing base field on stack: stack-addr=%p, "
335 "stack-size-before=%zu, stack-size-after=%zu",
336 stack
, stack
->size
, stack
->size
+ 1);
338 if (stack
->entries
->len
== stack
->size
) {
339 g_array_set_size(stack
->entries
, stack
->size
+ 1);
342 entry
= &g_array_index(stack
->entries
, struct stack_entry
, stack
->size
);
349 unsigned int stack_size(struct stack
*stack
)
356 void stack_pop(struct stack
*stack
)
359 BT_ASSERT(stack_size(stack
));
360 BT_LOGV("Popping from stack: "
361 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
362 stack
, stack
->size
, stack
->size
- 1);
367 struct stack_entry
*stack_top(struct stack
*stack
)
370 BT_ASSERT(stack_size(stack
));
371 return &g_array_index(stack
->entries
, struct stack_entry
,
376 bool stack_empty(struct stack
*stack
)
378 return stack_size(stack
) == 0;
382 void stack_clear(struct stack
*stack
)
389 enum bt_notif_iter_status
notif_iter_status_from_m_status(
390 enum bt_notif_iter_medium_status m_status
)
392 /* They are the same */
393 return (int) m_status
;
397 size_t buf_size_bits(struct bt_notif_iter
*notit
)
399 return notit
->buf
.sz
* 8;
403 size_t buf_available_bits(struct bt_notif_iter
*notit
)
405 return buf_size_bits(notit
) - notit
->buf
.at
;
409 size_t packet_at(struct bt_notif_iter
*notit
)
411 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
415 void buf_consume_bits(struct bt_notif_iter
*notit
, size_t incr
)
417 BT_LOGV("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
418 notit
, notit
->buf
.at
, notit
->buf
.at
+ incr
);
419 notit
->buf
.at
+= incr
;
423 enum bt_notif_iter_status
request_medium_bytes(
424 struct bt_notif_iter
*notit
)
426 uint8_t *buffer_addr
= NULL
;
427 size_t buffer_sz
= 0;
428 enum bt_notif_iter_medium_status m_status
;
430 BT_LOGV("Calling user function (request bytes): notit-addr=%p, "
431 "request-size=%zu", notit
, notit
->medium
.max_request_sz
);
432 m_status
= notit
->medium
.medops
.request_bytes(
433 notit
->medium
.max_request_sz
, &buffer_addr
,
434 &buffer_sz
, notit
->medium
.data
);
435 BT_LOGV("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
436 bt_notif_iter_medium_status_string(m_status
),
437 buffer_addr
, buffer_sz
);
438 if (m_status
== BT_NOTIF_ITER_MEDIUM_STATUS_OK
) {
439 BT_ASSERT(buffer_sz
!= 0);
441 /* New packet offset is old one + old size (in bits) */
442 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
444 /* Restart at the beginning of the new medium buffer */
446 notit
->buf
.last_eh_at
= SIZE_MAX
;
448 /* New medium buffer size */
449 notit
->buf
.sz
= buffer_sz
;
451 /* New medium buffer address */
452 notit
->buf
.addr
= buffer_addr
;
454 BT_LOGV("User function returned new bytes: "
455 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
456 notit
->buf
.packet_offset
, notit
->buf
.at
,
457 notit
->buf
.sz
, notit
->buf
.addr
);
458 BT_LOGV_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
460 } else if (m_status
== BT_NOTIF_ITER_MEDIUM_STATUS_EOF
) {
462 * User returned end of stream: validate that we're not
463 * in the middle of a packet header, packet context, or
466 if (notit
->cur_exp_packet_total_size
>= 0) {
467 if (packet_at(notit
) ==
468 notit
->cur_exp_packet_total_size
) {
472 if (packet_at(notit
) == 0) {
476 if (notit
->buf
.last_eh_at
!= SIZE_MAX
&&
477 notit
->buf
.at
== notit
->buf
.last_eh_at
) {
482 /* All other states are invalid */
483 BT_LOGW("User function returned %s, but notification iterator is in an unexpected state: "
484 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
485 "packet-cur=%zu, last-eh-at=%zu",
486 bt_notif_iter_medium_status_string(m_status
),
487 state_string(notit
->state
),
488 notit
->cur_exp_packet_total_size
,
489 notit
->buf
.at
, packet_at(notit
),
490 notit
->buf
.last_eh_at
);
491 m_status
= BT_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
492 } else if (m_status
< 0) {
493 BT_LOGW("User function failed: status=%s",
494 bt_notif_iter_medium_status_string(m_status
));
498 return notif_iter_status_from_m_status(m_status
);
502 enum bt_notif_iter_status
buf_ensure_available_bits(
503 struct bt_notif_iter
*notit
)
505 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
507 if (unlikely(buf_available_bits(notit
) == 0)) {
509 * This _cannot_ return BT_NOTIF_ITER_STATUS_OK
512 status
= request_medium_bytes(notit
);
519 enum bt_notif_iter_status
read_dscope_begin_state(
520 struct bt_notif_iter
*notit
,
521 struct ctf_field_class
*dscope_fc
,
522 enum state done_state
, enum state continue_state
,
523 struct bt_field
*dscope_field
)
525 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
526 enum bt_bfcr_status bfcr_status
;
527 size_t consumed_bits
;
529 notit
->cur_dscope_field
= dscope_field
;
530 BT_LOGV("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
531 notit
, notit
->bfcr
, dscope_fc
);
532 consumed_bits
= bt_bfcr_start(notit
->bfcr
, dscope_fc
,
533 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
534 notit
->buf
.sz
, &bfcr_status
);
535 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits
);
537 switch (bfcr_status
) {
538 case BT_BFCR_STATUS_OK
:
539 /* Field class was read completely */
540 BT_LOGV_STR("Field was completely decoded.");
541 notit
->state
= done_state
;
543 case BT_BFCR_STATUS_EOF
:
544 BT_LOGV_STR("BFCR needs more data to decode field completely.");
545 notit
->state
= continue_state
;
548 BT_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
549 "status=%s", notit
, notit
->bfcr
,
550 bt_bfcr_status_string(bfcr_status
));
551 status
= BT_NOTIF_ITER_STATUS_ERROR
;
555 /* Consume bits now since we know we're not in an error state */
556 buf_consume_bits(notit
, consumed_bits
);
563 enum bt_notif_iter_status
read_dscope_continue_state(
564 struct bt_notif_iter
*notit
, enum state done_state
)
566 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
567 enum bt_bfcr_status bfcr_status
;
568 size_t consumed_bits
;
570 BT_LOGV("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
573 status
= buf_ensure_available_bits(notit
);
574 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
576 BT_LOGW("Cannot ensure that buffer has at least one byte: "
577 "notif-addr=%p, status=%s",
578 notit
, bt_notif_iter_status_string(status
));
580 BT_LOGV("Cannot ensure that buffer has at least one byte: "
581 "notif-addr=%p, status=%s",
582 notit
, bt_notif_iter_status_string(status
));
588 consumed_bits
= bt_bfcr_continue(notit
->bfcr
, notit
->buf
.addr
,
589 notit
->buf
.sz
, &bfcr_status
);
590 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits
);
592 switch (bfcr_status
) {
593 case BT_BFCR_STATUS_OK
:
594 /* Type was read completely. */
595 BT_LOGV_STR("Field was completely decoded.");
596 notit
->state
= done_state
;
598 case BT_BFCR_STATUS_EOF
:
599 /* Stay in this continue state. */
600 BT_LOGV_STR("BFCR needs more data to decode field completely.");
603 BT_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
604 "status=%s", notit
, notit
->bfcr
,
605 bt_bfcr_status_string(bfcr_status
));
606 status
= BT_NOTIF_ITER_STATUS_ERROR
;
610 /* Consume bits now since we know we're not in an error state. */
611 buf_consume_bits(notit
, consumed_bits
);
617 void release_event_dscopes(struct bt_notif_iter
*notit
)
619 notit
->dscopes
.event_header
= NULL
;
621 if (notit
->event_header_field
) {
622 bt_event_header_field_release(notit
->event_header_field
);
623 notit
->event_header_field
= NULL
;
626 notit
->dscopes
.event_common_context
= NULL
;
627 notit
->dscopes
.event_spec_context
= NULL
;
628 notit
->dscopes
.event_payload
= NULL
;
632 void release_all_dscopes(struct bt_notif_iter
*notit
)
634 notit
->dscopes
.trace_packet_header
= NULL
;
636 if (notit
->packet_header_field
) {
637 bt_packet_header_field_release(notit
->packet_header_field
);
638 notit
->packet_header_field
= NULL
;
641 notit
->dscopes
.stream_packet_context
= NULL
;
643 if (notit
->packet_context_field
) {
644 bt_packet_context_field_release(notit
->packet_context_field
);
645 notit
->packet_context_field
= NULL
;
648 release_event_dscopes(notit
);
652 enum bt_notif_iter_status
read_packet_header_begin_state(
653 struct bt_notif_iter
*notit
)
655 struct ctf_field_class
*packet_header_fc
= NULL
;
656 enum bt_notif_iter_status ret
= BT_NOTIF_ITER_STATUS_OK
;
658 if (bt_notif_iter_switch_packet(notit
)) {
659 BT_LOGW("Cannot switch packet: notit-addr=%p", notit
);
660 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
664 /* Packet header class is common to the whole trace. */
665 packet_header_fc
= notit
->meta
.tc
->packet_header_fc
;
666 if (!packet_header_fc
) {
667 notit
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
671 BT_ASSERT(!notit
->packet_header_field
);
673 if (packet_header_fc
->in_ir
) {
675 * Create free packet header field from trace. This
676 * field is going to be moved to the packet once we
677 * create it. We cannot create the packet now because:
679 * 1. A packet is created from a stream.
680 * 2. A stream is created from a stream class.
681 * 3. We need the packet header field's content to know
682 * the ID of the stream class to select.
684 notit
->packet_header_field
=
685 bt_packet_header_field_create(
686 notit
->meta
.tc
->ir_tc
);
687 if (!notit
->packet_header_field
) {
688 BT_LOGE_STR("Cannot create packet header field wrapper from trace.");
689 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
693 notit
->dscopes
.trace_packet_header
=
694 bt_packet_header_field_borrow_field(
695 notit
->packet_header_field
);
696 BT_ASSERT(notit
->dscopes
.trace_packet_header
);
699 notit
->cur_stream_class_id
= -1;
700 notit
->cur_event_class_id
= -1;
701 notit
->cur_data_stream_id
= -1;
702 BT_LOGV("Decoding packet header field:"
703 "notit-addr=%p, trace-addr=%p, trace-name=\"%s\", fc-addr=%p",
704 notit
, notit
->meta
.tc
,
705 notit
->meta
.tc
->name
->str
, packet_header_fc
);
706 ret
= read_dscope_begin_state(notit
, packet_header_fc
,
707 STATE_AFTER_TRACE_PACKET_HEADER
,
708 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
709 notit
->dscopes
.trace_packet_header
);
711 BT_LOGW("Cannot decode packet header field: "
712 "notit-addr=%p, trace-addr=%p, "
713 "trace-name=\"%s\", fc-addr=%p",
714 notit
, notit
->meta
.tc
,
715 notit
->meta
.tc
->name
->str
,
724 enum bt_notif_iter_status
read_packet_header_continue_state(
725 struct bt_notif_iter
*notit
)
727 return read_dscope_continue_state(notit
,
728 STATE_AFTER_TRACE_PACKET_HEADER
);
732 enum bt_notif_iter_status
set_current_stream_class(struct bt_notif_iter
*notit
)
734 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
735 struct ctf_stream_class
*new_stream_class
= NULL
;
737 if (notit
->cur_stream_class_id
== -1) {
739 * No current stream class ID field, therefore only one
742 if (notit
->meta
.tc
->stream_classes
->len
!= 1) {
743 BT_LOGW("Need exactly one stream class since there's "
744 "no stream class ID field: "
745 "notit-addr=%p, trace-name=\"%s\"",
746 notit
, notit
->meta
.tc
->name
->str
);
747 status
= BT_NOTIF_ITER_STATUS_ERROR
;
751 new_stream_class
= notit
->meta
.tc
->stream_classes
->pdata
[0];
752 notit
->cur_stream_class_id
= new_stream_class
->id
;
755 new_stream_class
= ctf_trace_class_borrow_stream_class_by_id(
756 notit
->meta
.tc
, notit
->cur_stream_class_id
);
757 if (!new_stream_class
) {
758 BT_LOGW("No stream class with ID of stream class ID to use in trace: "
759 "notit-addr=%p, stream-class-id=%" PRIu64
", "
760 "trace-addr=%p, trace-name=\"%s\"",
761 notit
, notit
->cur_stream_class_id
, notit
->meta
.tc
,
762 notit
->meta
.tc
->name
->str
);
763 status
= BT_NOTIF_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
", "
774 "trace-addr=%p, trace-name=\"%s\"",
775 notit
, notit
->meta
.sc
,
778 new_stream_class
->id
,
780 notit
->meta
.tc
->name
->str
);
781 status
= BT_NOTIF_ITER_STATUS_ERROR
;
785 notit
->meta
.sc
= new_stream_class
;
788 BT_LOGV("Set current stream class: "
789 "notit-addr=%p, stream-class-addr=%p, "
790 "stream-class-id=%" PRId64
,
791 notit
, notit
->meta
.sc
, notit
->meta
.sc
->id
);
798 enum bt_notif_iter_status
set_current_stream(struct bt_notif_iter
*notit
)
800 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
801 struct bt_stream
*stream
= NULL
;
803 BT_LOGV("Calling user function (get stream): notit-addr=%p, "
804 "stream-class-addr=%p, stream-class-id=%" PRId64
,
805 notit
, notit
->meta
.sc
,
807 stream
= notit
->medium
.medops
.borrow_stream(
808 notit
->meta
.sc
->ir_sc
, notit
->cur_data_stream_id
,
810 bt_object_get_ref(stream
);
811 BT_LOGV("User function returned: stream-addr=%p", stream
);
813 BT_LOGW_STR("User function failed to return a stream object "
814 "for the given stream class.");
815 status
= BT_NOTIF_ITER_STATUS_ERROR
;
819 if (notit
->stream
&& stream
!= notit
->stream
) {
820 BT_LOGW("User function returned a different stream than the "
821 "previous one for the same sequence of packets.");
822 status
= BT_NOTIF_ITER_STATUS_ERROR
;
826 BT_OBJECT_MOVE_REF(notit
->stream
, stream
);
829 bt_object_put_ref(stream
);
834 enum bt_notif_iter_status
set_current_packet(struct bt_notif_iter
*notit
)
836 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
837 struct bt_packet
*packet
= NULL
;
839 BT_LOGV("Creating packet for packet notification: "
840 "notit-addr=%p", notit
);
841 BT_LOGV("Creating packet from stream: "
842 "notit-addr=%p, stream-addr=%p, "
843 "stream-class-addr=%p, "
844 "stream-class-id=%" PRId64
,
845 notit
, notit
->stream
, notit
->meta
.sc
,
849 BT_ASSERT(notit
->stream
);
850 packet
= bt_packet_create(notit
->stream
);
852 BT_LOGE("Cannot create 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
,
864 BT_OBJECT_PUT_REF_AND_RESET(packet
);
865 status
= BT_NOTIF_ITER_STATUS_ERROR
;
868 BT_OBJECT_MOVE_REF(notit
->packet
, packet
);
873 enum bt_notif_iter_status
after_packet_header_state(
874 struct bt_notif_iter
*notit
)
876 enum bt_notif_iter_status status
;
878 status
= set_current_stream_class(notit
);
879 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
883 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
890 enum bt_notif_iter_status
read_packet_context_begin_state(
891 struct bt_notif_iter
*notit
)
893 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
894 struct ctf_field_class
*packet_context_fc
;
896 BT_ASSERT(notit
->meta
.sc
);
897 packet_context_fc
= notit
->meta
.sc
->packet_context_fc
;
898 if (!packet_context_fc
) {
899 BT_LOGV("No packet packet context field class in stream class: continuing: "
900 "notit-addr=%p, stream-class-addr=%p, "
901 "stream-class-id=%" PRId64
,
902 notit
, notit
->meta
.sc
,
904 notit
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
908 BT_ASSERT(!notit
->packet_context_field
);
910 if (packet_context_fc
->in_ir
) {
912 * Create free packet context field from stream class.
913 * This field is going to be moved to the packet once we
914 * create it. We cannot create the packet now because a
915 * packet is created from a stream, and this API must be
916 * able to return the packet header and context fields
917 * without creating a stream
918 * (bt_notif_iter_borrow_packet_header_context_fields()).
920 notit
->packet_context_field
=
921 bt_packet_context_field_create(
922 notit
->meta
.sc
->ir_sc
);
923 if (!notit
->packet_context_field
) {
924 BT_LOGE_STR("Cannot create packet context field wrapper from stream class.");
925 status
= BT_NOTIF_ITER_STATUS_ERROR
;
929 notit
->dscopes
.stream_packet_context
=
930 bt_packet_context_field_borrow_field(
931 notit
->packet_context_field
);
932 BT_ASSERT(notit
->dscopes
.stream_packet_context
);
935 BT_LOGV("Decoding packet context field: "
936 "notit-addr=%p, stream-class-addr=%p, "
937 "stream-class-id=%" PRId64
", fc-addr=%p",
938 notit
, notit
->meta
.sc
,
939 notit
->meta
.sc
->id
, packet_context_fc
);
940 status
= read_dscope_begin_state(notit
, packet_context_fc
,
941 STATE_AFTER_STREAM_PACKET_CONTEXT
,
942 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
943 notit
->dscopes
.stream_packet_context
);
945 BT_LOGW("Cannot decode packet context field: "
946 "notit-addr=%p, stream-class-addr=%p, "
947 "stream-class-id=%" PRId64
", fc-addr=%p",
948 notit
, notit
->meta
.sc
,
958 enum bt_notif_iter_status
read_packet_context_continue_state(
959 struct bt_notif_iter
*notit
)
961 return read_dscope_continue_state(notit
,
962 STATE_AFTER_STREAM_PACKET_CONTEXT
);
966 enum bt_notif_iter_status
set_current_packet_content_sizes(
967 struct bt_notif_iter
*notit
)
969 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
971 if (notit
->cur_exp_packet_total_size
== -1) {
972 if (notit
->cur_exp_packet_content_size
!= -1) {
973 BT_LOGW("Content size is set, but packet size is not: "
974 "notit-addr=%p, packet-context-field-addr=%p, "
975 "packet-size=%" PRId64
", content-size=%" PRId64
,
976 notit
, notit
->dscopes
.stream_packet_context
,
977 notit
->cur_exp_packet_total_size
,
978 notit
->cur_exp_packet_content_size
);
979 status
= BT_NOTIF_ITER_STATUS_ERROR
;
983 if (notit
->cur_exp_packet_content_size
== -1) {
984 notit
->cur_exp_packet_content_size
=
985 notit
->cur_exp_packet_total_size
;
989 if (notit
->cur_exp_packet_content_size
>
990 notit
->cur_exp_packet_total_size
) {
991 BT_LOGW("Invalid packet or content size: "
992 "content size is greater than packet size: "
993 "notit-addr=%p, packet-context-field-addr=%p, "
994 "packet-size=%" PRId64
", content-size=%" PRId64
,
995 notit
, notit
->dscopes
.stream_packet_context
,
996 notit
->cur_exp_packet_total_size
,
997 notit
->cur_exp_packet_content_size
);
998 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1002 BT_LOGV("Set current packet and content sizes: "
1003 "notit-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1004 notit
, notit
->cur_exp_packet_total_size
,
1005 notit
->cur_exp_packet_content_size
);
1011 enum bt_notif_iter_status
after_packet_context_state(
1012 struct bt_notif_iter
*notit
)
1014 enum bt_notif_iter_status status
;
1016 status
= set_current_packet_content_sizes(notit
);
1017 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1021 if (notit
->stream_begin_emitted
) {
1022 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
1024 notit
->state
= STATE_EMIT_NOTIF_NEW_STREAM
;
1032 enum bt_notif_iter_status
read_event_header_begin_state(
1033 struct bt_notif_iter
*notit
)
1035 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1036 struct ctf_field_class
*event_header_fc
= NULL
;
1038 /* Reset the position of the last event header */
1039 notit
->buf
.last_eh_at
= notit
->buf
.at
;
1040 notit
->cur_event_class_id
= -1;
1042 /* Check if we have some content left */
1043 if (notit
->cur_exp_packet_content_size
>= 0) {
1044 if (unlikely(packet_at(notit
) ==
1045 notit
->cur_exp_packet_content_size
)) {
1046 /* No more events! */
1047 BT_LOGV("Reached end of packet: notit-addr=%p, "
1048 "cur=%zu", notit
, packet_at(notit
));
1049 notit
->state
= STATE_EMIT_NOTIF_END_OF_PACKET
;
1051 } else if (unlikely(packet_at(notit
) >
1052 notit
->cur_exp_packet_content_size
)) {
1053 /* That's not supposed to happen */
1054 BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
1055 "notit-addr=%p, content-size=%" PRId64
", "
1057 notit
->cur_exp_packet_content_size
,
1059 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1064 * "Infinite" content: we're done when the medium has
1065 * nothing else for us.
1067 status
= buf_ensure_available_bits(notit
);
1068 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1070 * If this function returns
1071 * `BT_NOTIF_ITER_STATUS_EOF`:
1073 * 1. bt_notif_iter_get_next_notification()
1074 * emits a "packet end" notification. This
1075 * resets the current packet. The state
1076 * remains unchanged otherwise.
1077 * 2. This function is called again. It returns
1078 * `BT_NOTIF_ITER_STATUS_EOF` again.
1079 * 3. bt_notif_iter_get_next_notification()
1080 * emits a "stream end" notification because
1081 * there's no current packet. It sets the
1082 * current state to `STATE_DONE`.
1088 release_event_dscopes(notit
);
1089 BT_ASSERT(notit
->meta
.sc
);
1090 event_header_fc
= notit
->meta
.sc
->event_header_fc
;
1091 if (!event_header_fc
) {
1092 notit
->state
= STATE_AFTER_EVENT_HEADER
;
1096 if (event_header_fc
->in_ir
) {
1097 BT_ASSERT(!notit
->event_header_field
);
1098 notit
->event_header_field
=
1099 bt_event_header_field_create(
1100 notit
->meta
.sc
->ir_sc
);
1101 if (!notit
->event_header_field
) {
1102 BT_LOGE_STR("Cannot create event header field wrapper from trace.");
1103 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1107 notit
->dscopes
.event_header
=
1108 bt_event_header_field_borrow_field(
1109 notit
->event_header_field
);
1110 BT_ASSERT(notit
->dscopes
.event_header
);
1113 BT_LOGV("Decoding event header field: "
1114 "notit-addr=%p, stream-class-addr=%p, "
1115 "stream-class-id=%" PRId64
", "
1117 notit
, notit
->meta
.sc
,
1120 status
= read_dscope_begin_state(notit
, event_header_fc
,
1121 STATE_AFTER_EVENT_HEADER
,
1122 STATE_DSCOPE_EVENT_HEADER_CONTINUE
,
1123 notit
->dscopes
.event_header
);
1125 BT_LOGW("Cannot decode event header field: "
1126 "notit-addr=%p, stream-class-addr=%p, "
1127 "stream-class-id=%" PRId64
", fc-addr=%p",
1128 notit
, notit
->meta
.sc
,
1138 enum bt_notif_iter_status
read_event_header_continue_state(
1139 struct bt_notif_iter
*notit
)
1141 return read_dscope_continue_state(notit
,
1142 STATE_AFTER_EVENT_HEADER
);
1146 enum bt_notif_iter_status
set_current_event_class(struct bt_notif_iter
*notit
)
1148 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1150 struct ctf_event_class
*new_event_class
= NULL
;
1152 if (notit
->cur_event_class_id
== -1) {
1154 * No current event class ID field, therefore only one
1157 if (notit
->meta
.sc
->event_classes
->len
!= 1) {
1158 BT_LOGW("Need exactly one event class since there's "
1159 "no event class ID field: "
1160 "notit-addr=%p, trace-name=\"%s\"",
1161 notit
, notit
->meta
.tc
->name
->str
);
1162 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1166 new_event_class
= notit
->meta
.sc
->event_classes
->pdata
[0];
1167 notit
->cur_event_class_id
= new_event_class
->id
;
1170 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1171 notit
->meta
.sc
, notit
->cur_event_class_id
);
1172 if (!new_event_class
) {
1173 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1174 "notit-addr=%p, stream-class-id=%" PRIu64
", "
1175 "event-class-id=%" PRIu64
", "
1176 "trace-addr=%p, trace-name=\"%s\"",
1177 notit
, notit
->meta
.sc
->id
, notit
->cur_event_class_id
,
1178 notit
->meta
.tc
, notit
->meta
.tc
->name
->str
);
1179 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1183 notit
->meta
.ec
= new_event_class
;
1184 BT_LOGV("Set current event class: "
1185 "notit-addr=%p, event-class-addr=%p, "
1186 "event-class-id=%" PRId64
", "
1187 "event-class-name=\"%s\"",
1188 notit
, notit
->meta
.ec
, notit
->meta
.ec
->id
,
1189 notit
->meta
.ec
->name
->str
);
1196 enum bt_notif_iter_status
set_current_event_notification(
1197 struct bt_notif_iter
*notit
)
1199 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1200 struct bt_notification
*notif
= NULL
;
1202 BT_ASSERT(notit
->meta
.ec
);
1203 BT_ASSERT(notit
->packet
);
1204 BT_LOGV("Creating event notification from event class and packet: "
1205 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1206 notit
, notit
->meta
.ec
,
1207 notit
->meta
.ec
->name
->str
,
1209 BT_ASSERT(notit
->notif_iter
);
1210 notif
= bt_notification_event_create(notit
->notif_iter
,
1211 notit
->meta
.ec
->ir_ec
, notit
->packet
);
1213 BT_LOGE("Cannot create event notification: "
1214 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1216 notit
, notit
->meta
.ec
,
1217 notit
->meta
.ec
->name
->str
,
1225 BT_OBJECT_PUT_REF_AND_RESET(notif
);
1226 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1229 BT_OBJECT_MOVE_REF(notit
->event_notif
, notif
);
1234 enum bt_notif_iter_status
after_event_header_state(
1235 struct bt_notif_iter
*notit
)
1237 enum bt_notif_iter_status status
;
1239 status
= set_current_event_class(notit
);
1240 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1244 status
= set_current_event_notification(notit
);
1245 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1249 notit
->event
= bt_notification_event_borrow_event(
1250 notit
->event_notif
);
1251 BT_ASSERT(notit
->event
);
1253 if (notit
->event_header_field
) {
1256 BT_ASSERT(notit
->event
);
1257 ret
= bt_event_move_header_field(notit
->event
,
1258 notit
->event_header_field
);
1260 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1264 notit
->event_header_field
= NULL
;
1267 * At this point notit->dscopes.event_header has
1268 * the same value as the event header field within
1271 BT_ASSERT(bt_event_borrow_header_field(
1272 notit
->event
) == notit
->dscopes
.event_header
);
1275 notit
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1282 enum bt_notif_iter_status
read_event_common_context_begin_state(
1283 struct bt_notif_iter
*notit
)
1285 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1286 struct ctf_field_class
*event_common_context_fc
;
1288 event_common_context_fc
= notit
->meta
.sc
->event_common_context_fc
;
1289 if (!event_common_context_fc
) {
1290 notit
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1294 if (event_common_context_fc
->in_ir
) {
1295 BT_ASSERT(!notit
->dscopes
.event_common_context
);
1296 notit
->dscopes
.event_common_context
=
1297 bt_event_borrow_common_context_field(
1299 BT_ASSERT(notit
->dscopes
.event_common_context
);
1302 BT_LOGV("Decoding event common context field: "
1303 "notit-addr=%p, stream-class-addr=%p, "
1304 "stream-class-id=%" PRId64
", "
1306 notit
, notit
->meta
.sc
,
1308 event_common_context_fc
);
1309 status
= read_dscope_begin_state(notit
, event_common_context_fc
,
1310 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1311 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1312 notit
->dscopes
.event_common_context
);
1314 BT_LOGW("Cannot decode event common context field: "
1315 "notit-addr=%p, stream-class-addr=%p, "
1316 "stream-class-id=%" PRId64
", fc-addr=%p",
1317 notit
, notit
->meta
.sc
,
1319 event_common_context_fc
);
1327 enum bt_notif_iter_status
read_event_common_context_continue_state(
1328 struct bt_notif_iter
*notit
)
1330 return read_dscope_continue_state(notit
,
1331 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1335 enum bt_notif_iter_status
read_event_spec_context_begin_state(
1336 struct bt_notif_iter
*notit
)
1338 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1339 struct ctf_field_class
*event_spec_context_fc
;
1341 event_spec_context_fc
= notit
->meta
.ec
->spec_context_fc
;
1342 if (!event_spec_context_fc
) {
1343 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1347 if (event_spec_context_fc
->in_ir
) {
1348 BT_ASSERT(!notit
->dscopes
.event_spec_context
);
1349 notit
->dscopes
.event_spec_context
=
1350 bt_event_borrow_specific_context_field(
1352 BT_ASSERT(notit
->dscopes
.event_spec_context
);
1355 BT_LOGV("Decoding event specific context field: "
1356 "notit-addr=%p, event-class-addr=%p, "
1357 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1359 notit
, notit
->meta
.ec
,
1360 notit
->meta
.ec
->name
->str
,
1362 event_spec_context_fc
);
1363 status
= read_dscope_begin_state(notit
, event_spec_context_fc
,
1364 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1365 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1366 notit
->dscopes
.event_spec_context
);
1368 BT_LOGW("Cannot decode event specific context field: "
1369 "notit-addr=%p, event-class-addr=%p, "
1370 "event-class-name=\"%s\", "
1371 "event-class-id=%" PRId64
", fc-addr=%p",
1372 notit
, notit
->meta
.ec
,
1373 notit
->meta
.ec
->name
->str
,
1375 event_spec_context_fc
);
1383 enum bt_notif_iter_status
read_event_spec_context_continue_state(
1384 struct bt_notif_iter
*notit
)
1386 return read_dscope_continue_state(notit
,
1387 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1391 enum bt_notif_iter_status
read_event_payload_begin_state(
1392 struct bt_notif_iter
*notit
)
1394 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1395 struct ctf_field_class
*event_payload_fc
;
1397 event_payload_fc
= notit
->meta
.ec
->payload_fc
;
1398 if (!event_payload_fc
) {
1399 notit
->state
= STATE_EMIT_NOTIF_EVENT
;
1403 if (event_payload_fc
->in_ir
) {
1404 BT_ASSERT(!notit
->dscopes
.event_payload
);
1405 notit
->dscopes
.event_payload
=
1406 bt_event_borrow_payload_field(
1408 BT_ASSERT(notit
->dscopes
.event_payload
);
1411 BT_LOGV("Decoding event payload field: "
1412 "notit-addr=%p, event-class-addr=%p, "
1413 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1415 notit
, notit
->meta
.ec
,
1416 notit
->meta
.ec
->name
->str
,
1419 status
= read_dscope_begin_state(notit
, event_payload_fc
,
1420 STATE_EMIT_NOTIF_EVENT
,
1421 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1422 notit
->dscopes
.event_payload
);
1424 BT_LOGW("Cannot decode event payload field: "
1425 "notit-addr=%p, event-class-addr=%p, "
1426 "event-class-name=\"%s\", "
1427 "event-class-id=%" PRId64
", fc-addr=%p",
1428 notit
, notit
->meta
.ec
,
1429 notit
->meta
.ec
->name
->str
,
1439 enum bt_notif_iter_status
read_event_payload_continue_state(
1440 struct bt_notif_iter
*notit
)
1442 return read_dscope_continue_state(notit
, STATE_EMIT_NOTIF_EVENT
);
1446 enum bt_notif_iter_status
skip_packet_padding_state(
1447 struct bt_notif_iter
*notit
)
1449 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1450 size_t bits_to_skip
;
1452 BT_ASSERT(notit
->cur_exp_packet_total_size
> 0);
1453 bits_to_skip
= notit
->cur_exp_packet_total_size
- packet_at(notit
);
1454 if (bits_to_skip
== 0) {
1455 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1458 size_t bits_to_consume
;
1460 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1461 bits_to_skip
, notit
, bits_to_skip
);
1462 status
= buf_ensure_available_bits(notit
);
1463 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1467 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1468 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1469 bits_to_consume
, notit
, bits_to_consume
);
1470 buf_consume_bits(notit
, bits_to_consume
);
1471 bits_to_skip
= notit
->cur_exp_packet_total_size
-
1473 if (bits_to_skip
== 0) {
1474 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1484 enum bt_notif_iter_status
handle_state(struct bt_notif_iter
*notit
)
1486 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1487 const enum state state
= notit
->state
;
1489 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1490 notit
, state_string(state
));
1492 // TODO: optimalize!
1495 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1497 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1498 status
= read_packet_header_begin_state(notit
);
1500 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1501 status
= read_packet_header_continue_state(notit
);
1503 case STATE_AFTER_TRACE_PACKET_HEADER
:
1504 status
= after_packet_header_state(notit
);
1506 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1507 status
= read_packet_context_begin_state(notit
);
1509 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1510 status
= read_packet_context_continue_state(notit
);
1512 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1513 status
= after_packet_context_state(notit
);
1515 case STATE_EMIT_NOTIF_NEW_STREAM
:
1516 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
1518 case STATE_EMIT_NOTIF_NEW_PACKET
:
1519 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1521 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1522 status
= read_event_header_begin_state(notit
);
1524 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1525 status
= read_event_header_continue_state(notit
);
1527 case STATE_AFTER_EVENT_HEADER
:
1528 status
= after_event_header_state(notit
);
1530 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1531 status
= read_event_common_context_begin_state(notit
);
1533 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1534 status
= read_event_common_context_continue_state(notit
);
1536 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1537 status
= read_event_spec_context_begin_state(notit
);
1539 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1540 status
= read_event_spec_context_continue_state(notit
);
1542 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1543 status
= read_event_payload_begin_state(notit
);
1545 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1546 status
= read_event_payload_continue_state(notit
);
1548 case STATE_EMIT_NOTIF_EVENT
:
1549 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1551 case STATE_SKIP_PACKET_PADDING
:
1552 status
= skip_packet_padding_state(notit
);
1554 case STATE_EMIT_NOTIF_END_OF_PACKET
:
1555 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1558 BT_LOGD("Unknown CTF plugin notification iterator state: "
1559 "notit-addr=%p, state=%d", notit
, notit
->state
);
1563 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1564 "prev-state=%s, cur-state=%s",
1565 notit
, bt_notif_iter_status_string(status
),
1566 state_string(state
), state_string(notit
->state
));
1571 * Resets the internal state of a CTF notification iterator.
1574 void bt_notif_iter_reset(struct bt_notif_iter
*notit
)
1577 BT_LOGD("Resetting notification iterator: addr=%p", notit
);
1578 stack_clear(notit
->stack
);
1579 notit
->meta
.sc
= NULL
;
1580 notit
->meta
.ec
= NULL
;
1581 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
1582 BT_OBJECT_PUT_REF_AND_RESET(notit
->stream
);
1583 BT_OBJECT_PUT_REF_AND_RESET(notit
->event_notif
);
1584 release_all_dscopes(notit
);
1585 notit
->cur_dscope_field
= NULL
;
1587 if (notit
->packet_header_field
) {
1588 bt_packet_header_field_release(notit
->packet_header_field
);
1589 notit
->packet_header_field
= NULL
;
1592 if (notit
->packet_context_field
) {
1593 bt_packet_context_field_release(notit
->packet_context_field
);
1594 notit
->packet_context_field
= NULL
;
1597 if (notit
->event_header_field
) {
1598 bt_event_header_field_release(notit
->event_header_field
);
1599 notit
->event_header_field
= NULL
;
1602 notit
->buf
.addr
= NULL
;
1605 notit
->buf
.last_eh_at
= SIZE_MAX
;
1606 notit
->buf
.packet_offset
= 0;
1607 notit
->state
= STATE_INIT
;
1608 notit
->cur_exp_packet_content_size
= -1;
1609 notit
->cur_exp_packet_total_size
= -1;
1610 notit
->cur_packet_offset
= -1;
1611 notit
->cur_stream_class_id
= -1;
1612 notit
->cur_event_class_id
= -1;
1613 notit
->cur_data_stream_id
= -1;
1614 notit
->stream_begin_emitted
= false;
1618 int bt_notif_iter_switch_packet(struct bt_notif_iter
*notit
)
1623 * We don't put the stream class here because we need to make
1624 * sure that all the packets processed by the same notification
1625 * iterator refer to the same stream class (the first one).
1629 if (notit
->cur_exp_packet_total_size
!= -1) {
1630 notit
->cur_packet_offset
+= notit
->cur_exp_packet_total_size
;
1633 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1634 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
1635 notit
->cur_packet_offset
);
1636 stack_clear(notit
->stack
);
1637 notit
->meta
.ec
= NULL
;
1638 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
1639 BT_OBJECT_PUT_REF_AND_RESET(notit
->event_notif
);
1640 release_all_dscopes(notit
);
1641 notit
->cur_dscope_field
= NULL
;
1644 * Adjust current buffer so that addr points to the beginning of the new
1647 if (notit
->buf
.addr
) {
1648 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1650 /* Packets are assumed to start on a byte frontier. */
1651 if (notit
->buf
.at
% CHAR_BIT
) {
1652 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1653 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
1658 notit
->buf
.addr
+= consumed_bytes
;
1659 notit
->buf
.sz
-= consumed_bytes
;
1661 notit
->buf
.packet_offset
= 0;
1662 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1663 notit
->buf
.addr
, notit
->buf
.sz
);
1666 notit
->cur_exp_packet_content_size
= -1;
1667 notit
->cur_exp_packet_total_size
= -1;
1668 notit
->cur_stream_class_id
= -1;
1669 notit
->cur_event_class_id
= -1;
1670 notit
->cur_data_stream_id
= -1;
1671 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1672 notit
->snapshots
.packets
= UINT64_C(-1);
1673 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1674 notit
->snapshots
.end_clock
= UINT64_C(-1);
1681 struct bt_field
*borrow_next_field(struct bt_notif_iter
*notit
)
1683 struct bt_field
*next_field
= NULL
;
1684 struct bt_field
*base_field
;
1685 const struct bt_field_class
*base_fc
;
1688 BT_ASSERT(!stack_empty(notit
->stack
));
1689 index
= stack_top(notit
->stack
)->index
;
1690 base_field
= stack_top(notit
->stack
)->base
;
1691 BT_ASSERT(base_field
);
1692 base_fc
= bt_field_borrow_class_const(base_field
);
1695 switch (bt_field_class_get_type(base_fc
)) {
1696 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1699 bt_field_class_structure_get_member_count(
1700 bt_field_borrow_class_const(
1703 bt_field_structure_borrow_member_field_by_index(
1707 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1708 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1709 BT_ASSERT(index
< bt_field_array_get_length(base_field
));
1710 next_field
= bt_field_array_borrow_element_field_by_index(
1713 case BT_FIELD_CLASS_TYPE_VARIANT
:
1714 BT_ASSERT(index
== 0);
1715 next_field
= bt_field_variant_borrow_selected_option_field(
1722 BT_ASSERT(next_field
);
1727 void update_default_clock(struct bt_notif_iter
*notit
, uint64_t new_val
,
1728 uint64_t new_val_size
)
1730 uint64_t new_val_mask
;
1731 uint64_t cur_value_masked
;
1733 BT_ASSERT(new_val_size
> 0);
1736 * Special case for a 64-bit new value, which is the limit
1737 * of a clock value as of this version: overwrite the
1738 * current value directly.
1740 if (new_val_size
== 64) {
1741 notit
->default_clock_val
= new_val
;
1745 new_val_mask
= (1ULL << new_val_size
) - 1;
1746 cur_value_masked
= notit
->default_clock_val
& new_val_mask
;
1748 if (new_val
< cur_value_masked
) {
1750 * It looks like a wrap happened on the number of bits
1751 * of the requested new value. Assume that the clock
1752 * value wrapped only one time.
1754 notit
->default_clock_val
+= new_val_mask
+ 1;
1757 /* Clear the low bits of the current clock value. */
1758 notit
->default_clock_val
&= ~new_val_mask
;
1760 /* Set the low bits of the current clock value. */
1761 notit
->default_clock_val
|= new_val
;
1764 BT_LOGV("Updated default clock's value from integer field's value: "
1765 "value=%" PRIu64
, notit
->default_clock_val
);
1769 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1770 struct ctf_field_class
*fc
, void *data
)
1772 struct bt_notif_iter
*notit
= data
;
1773 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1774 struct bt_field
*field
= NULL
;
1775 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1777 BT_LOGV("Unsigned integer function called from BFCR: "
1778 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1779 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1780 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1782 if (likely(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1783 goto update_def_clock
;
1786 switch (int_fc
->meaning
) {
1787 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1788 notit
->cur_event_class_id
= value
;
1790 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1791 notit
->cur_data_stream_id
= value
;
1793 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1794 notit
->snapshots
.beginning_clock
= value
;
1796 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1797 notit
->snapshots
.end_clock
= value
;
1799 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1800 notit
->cur_stream_class_id
= value
;
1802 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1803 if (value
!= 0xc1fc1fc1) {
1804 BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
1805 "magic=%" PRIx64
, notit
, value
);
1806 status
= BT_BFCR_STATUS_ERROR
;
1811 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1812 notit
->snapshots
.packets
= value
;
1814 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1815 notit
->snapshots
.discarded_events
= value
;
1817 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1818 notit
->cur_exp_packet_total_size
= value
;
1820 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1821 notit
->cur_exp_packet_content_size
= value
;
1828 if (unlikely(int_fc
->mapped_clock_class
)) {
1829 update_default_clock(notit
, value
, int_fc
->base
.size
);
1832 if (unlikely(int_fc
->storing_index
>= 0)) {
1833 g_array_index(notit
->stored_values
, uint64_t,
1834 (uint64_t) int_fc
->storing_index
) = value
;
1837 if (unlikely(!fc
->in_ir
)) {
1841 field
= borrow_next_field(notit
);
1843 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1844 BT_ASSERT(bt_field_get_class_type(field
) ==
1845 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
1846 bt_field_get_class_type(field
) ==
1847 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
);
1848 bt_field_unsigned_integer_set_value(field
, value
);
1849 stack_top(notit
->stack
)->index
++;
1856 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
1857 struct ctf_field_class
*fc
, void *data
)
1860 struct bt_notif_iter
*notit
= data
;
1861 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1862 struct bt_field
*string_field
= NULL
;
1863 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1864 char str
[2] = {'\0', '\0'};
1866 BT_LOGV("Unsigned integer character function called from BFCR: "
1867 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1868 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1869 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1870 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1871 BT_ASSERT(!int_fc
->mapped_clock_class
);
1872 BT_ASSERT(int_fc
->storing_index
< 0);
1874 if (unlikely(!fc
->in_ir
)) {
1878 if (notit
->done_filling_string
) {
1883 notit
->done_filling_string
= true;
1887 string_field
= stack_top(notit
->stack
)->base
;
1888 BT_ASSERT(bt_field_get_class_type(string_field
) ==
1889 BT_FIELD_CLASS_TYPE_STRING
);
1891 /* Append character */
1892 str
[0] = (char) value
;
1893 ret
= bt_field_string_append_with_length(string_field
, str
, 1);
1895 BT_LOGE("Cannot append character to string field's value: "
1896 "notit-addr=%p, field-addr=%p, ret=%d",
1897 notit
, string_field
, ret
);
1898 status
= BT_BFCR_STATUS_ERROR
;
1907 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
1908 struct ctf_field_class
*fc
, void *data
)
1910 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1911 struct bt_field
*field
= NULL
;
1912 struct bt_notif_iter
*notit
= data
;
1913 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1915 BT_LOGV("Signed integer function called from BFCR: "
1916 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1917 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
1918 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1919 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1921 if (unlikely(int_fc
->storing_index
>= 0)) {
1922 g_array_index(notit
->stored_values
, uint64_t,
1923 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
1926 if (unlikely(!fc
->in_ir
)) {
1930 field
= borrow_next_field(notit
);
1932 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1933 BT_ASSERT(bt_field_get_class_type(field
) ==
1934 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
1935 bt_field_get_class_type(field
) ==
1936 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
);
1937 bt_field_signed_integer_set_value(field
, value
);
1938 stack_top(notit
->stack
)->index
++;
1945 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
1946 struct ctf_field_class
*fc
, void *data
)
1948 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1949 struct bt_field
*field
= NULL
;
1950 struct bt_notif_iter
*notit
= data
;
1952 BT_LOGV("Floating point number function called from BFCR: "
1953 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1954 "fc-type=%d, fc-in-ir=%d, value=%f",
1955 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1956 BT_ASSERT(fc
->in_ir
);
1957 field
= borrow_next_field(notit
);
1959 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1960 BT_ASSERT(bt_field_get_class_type(field
) ==
1961 BT_FIELD_CLASS_TYPE_REAL
);
1962 bt_field_real_set_value(field
, value
);
1963 stack_top(notit
->stack
)->index
++;
1968 enum bt_bfcr_status
bfcr_string_begin_cb(
1969 struct ctf_field_class
*fc
, void *data
)
1971 struct bt_field
*field
= NULL
;
1972 struct bt_notif_iter
*notit
= data
;
1975 BT_LOGV("String (beginning) function called from BFCR: "
1976 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1977 "fc-type=%d, fc-in-ir=%d",
1978 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
1980 BT_ASSERT(fc
->in_ir
);
1981 field
= borrow_next_field(notit
);
1983 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
1984 BT_ASSERT(bt_field_get_class_type(field
) ==
1985 BT_FIELD_CLASS_TYPE_STRING
);
1986 ret
= bt_field_string_clear(field
);
1987 BT_ASSERT(ret
== 0);
1990 * Push on stack. Not a compound class per se, but we know that
1991 * only bfcr_string_cb() may be called between this call and a
1992 * subsequent call to bfcr_string_end_cb().
1994 stack_push(notit
->stack
, field
);
1995 return BT_BFCR_STATUS_OK
;
1999 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2000 size_t len
, struct ctf_field_class
*fc
, void *data
)
2002 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2003 struct bt_field
*field
= NULL
;
2004 struct bt_notif_iter
*notit
= data
;
2007 BT_LOGV("String (substring) function called from BFCR: "
2008 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2009 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2010 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2012 BT_ASSERT(fc
->in_ir
);
2013 field
= stack_top(notit
->stack
)->base
;
2016 /* Append current substring */
2017 ret
= bt_field_string_append_with_length(field
, value
, len
);
2019 BT_LOGE("Cannot append substring to string field's value: "
2020 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2021 "ret=%d", notit
, field
, len
, ret
);
2022 status
= BT_BFCR_STATUS_ERROR
;
2031 enum bt_bfcr_status
bfcr_string_end_cb(
2032 struct ctf_field_class
*fc
, void *data
)
2034 struct bt_notif_iter
*notit
= data
;
2036 BT_LOGV("String (end) function called from BFCR: "
2037 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2038 "fc-type=%d, fc-in-ir=%d",
2039 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2040 BT_ASSERT(fc
->in_ir
);
2042 /* Pop string field */
2043 stack_pop(notit
->stack
);
2045 /* Go to next field */
2046 stack_top(notit
->stack
)->index
++;
2047 return BT_BFCR_STATUS_OK
;
2050 enum bt_bfcr_status
bfcr_compound_begin_cb(
2051 struct ctf_field_class
*fc
, void *data
)
2053 struct bt_notif_iter
*notit
= data
;
2054 struct bt_field
*field
;
2056 BT_LOGV("Compound (beginning) function called from BFCR: "
2057 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2058 "fc-type=%d, fc-in-ir=%d",
2059 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2066 if (stack_empty(notit
->stack
)) {
2067 /* Root: already set by read_dscope_begin_state() */
2068 field
= notit
->cur_dscope_field
;
2070 field
= borrow_next_field(notit
);
2076 BT_ASSERT(bt_field_borrow_class_const(field
) == fc
->ir_fc
);
2077 stack_push(notit
->stack
, field
);
2080 * Change BFCR "unsigned int" callback if it's a text
2083 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2084 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2085 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2087 if (array_fc
->is_text
) {
2090 BT_ASSERT(bt_field_get_class_type(field
) ==
2091 BT_FIELD_CLASS_TYPE_STRING
);
2092 notit
->done_filling_string
= false;
2093 ret
= bt_field_string_clear(field
);
2094 BT_ASSERT(ret
== 0);
2095 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2096 bfcr_unsigned_int_char_cb
);
2101 return BT_BFCR_STATUS_OK
;
2104 enum bt_bfcr_status
bfcr_compound_end_cb(
2105 struct ctf_field_class
*fc
, void *data
)
2107 struct bt_notif_iter
*notit
= data
;
2109 BT_LOGV("Compound (end) function called from BFCR: "
2110 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2111 "fc-type=%d, fc-in-ir=%d",
2112 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2118 BT_ASSERT(!stack_empty(notit
->stack
));
2119 BT_ASSERT(bt_field_borrow_class_const(stack_top(notit
->stack
)->base
) ==
2123 * Reset BFCR "unsigned int" callback if it's a text
2126 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2127 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2128 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2130 if (array_fc
->is_text
) {
2131 BT_ASSERT(bt_field_get_class_type(
2132 stack_top(notit
->stack
)->base
) ==
2133 BT_FIELD_CLASS_TYPE_STRING
);
2134 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2135 bfcr_unsigned_int_cb
);
2140 stack_pop(notit
->stack
);
2142 /* If the stack is not empty, increment the base's index */
2143 if (!stack_empty(notit
->stack
)) {
2144 stack_top(notit
->stack
)->index
++;
2148 return BT_BFCR_STATUS_OK
;
2152 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2154 struct bt_field
*seq_field
;
2155 struct bt_notif_iter
*notit
= data
;
2156 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2157 int64_t length
= -1;
2160 length
= (uint64_t) g_array_index(notit
->stored_values
, uint64_t,
2161 seq_fc
->stored_length_index
);
2162 seq_field
= stack_top(notit
->stack
)->base
;
2163 BT_ASSERT(seq_field
);
2164 ret
= bt_field_dynamic_array_set_length(seq_field
, (uint64_t) length
);
2166 BT_LOGE("Cannot set dynamic array field's length field: "
2167 "notit-addr=%p, field-addr=%p, "
2168 "length=%" PRIu64
, notit
, seq_field
, length
);
2175 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2176 struct ctf_field_class
*fc
, void *data
)
2180 int64_t option_index
= -1;
2181 struct bt_notif_iter
*notit
= data
;
2182 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2183 struct ctf_named_field_class
*selected_option
= NULL
;
2184 struct ctf_field_class
*ret_fc
= NULL
;
2190 /* Get variant's tag */
2191 tag
.u
= g_array_index(notit
->stored_values
, uint64_t,
2192 var_fc
->stored_tag_index
);
2195 * Check each range to find the selected option's index.
2197 if (var_fc
->tag_fc
->base
.is_signed
) {
2198 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2199 struct ctf_field_class_variant_range
*range
=
2200 ctf_field_class_variant_borrow_range_by_index(
2203 if (tag
.i
>= range
->range
.lower
.i
&&
2204 tag
.i
<= range
->range
.upper
.i
) {
2205 option_index
= (int64_t) range
->option_index
;
2210 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2211 struct ctf_field_class_variant_range
*range
=
2212 ctf_field_class_variant_borrow_range_by_index(
2215 if (tag
.u
>= range
->range
.lower
.u
&&
2216 tag
.u
<= range
->range
.upper
.u
) {
2217 option_index
= (int64_t) range
->option_index
;
2223 if (option_index
< 0) {
2224 BT_LOGW("Cannot find variant field class's option: "
2225 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2226 "i-tag=%" PRId64
, notit
, var_fc
, tag
.u
, tag
.i
);
2230 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2231 var_fc
, (uint64_t) option_index
);
2233 if (selected_option
->fc
->in_ir
) {
2234 struct bt_field
*var_field
= stack_top(notit
->stack
)->base
;
2236 ret
= bt_field_variant_select_option_field(
2237 var_field
, option_index
);
2239 BT_LOGW("Cannot select variant field's option field: "
2240 "notit-addr=%p, var-field-addr=%p, "
2241 "opt-index=%" PRId64
, notit
, var_field
,
2247 ret_fc
= selected_option
->fc
;
2254 void set_event_default_clock_value(struct bt_notif_iter
*notit
)
2256 struct bt_event
*event
=
2257 bt_notification_event_borrow_event(
2258 notit
->event_notif
);
2259 struct bt_stream_class
*sc
= notit
->meta
.sc
->ir_sc
;
2263 if (bt_stream_class_borrow_default_clock_class(sc
)) {
2264 bt_event_set_default_clock_value(event
,
2265 notit
->default_clock_val
);
2270 void notify_new_stream(struct bt_notif_iter
*notit
,
2271 struct bt_notification
**notification
)
2273 enum bt_notif_iter_status status
;
2274 struct bt_notification
*ret
= NULL
;
2276 status
= set_current_stream(notit
);
2277 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2278 BT_OBJECT_PUT_REF_AND_RESET(ret
);
2282 BT_ASSERT(notit
->stream
);
2283 BT_ASSERT(notit
->notif_iter
);
2284 ret
= bt_notification_stream_begin_create(notit
->notif_iter
,
2287 BT_LOGE("Cannot create stream beginning notification: "
2288 "notit-addr=%p, stream-addr=%p",
2289 notit
, notit
->stream
);
2294 *notification
= ret
;
2298 void notify_end_of_stream(struct bt_notif_iter
*notit
,
2299 struct bt_notification
**notification
)
2301 struct bt_notification
*ret
;
2303 if (!notit
->stream
) {
2304 BT_LOGE("Cannot create stream for stream notification: "
2305 "notit-addr=%p", notit
);
2309 BT_ASSERT(notit
->notif_iter
);
2310 ret
= bt_notification_stream_end_create(notit
->notif_iter
,
2313 BT_LOGE("Cannot create stream beginning notification: "
2314 "notit-addr=%p, stream-addr=%p",
2315 notit
, notit
->stream
);
2318 *notification
= ret
;
2322 void notify_new_packet(struct bt_notif_iter
*notit
,
2323 struct bt_notification
**notification
)
2326 enum bt_notif_iter_status status
;
2327 struct bt_notification
*notif
= NULL
;
2328 const struct bt_stream_class
*sc
;
2330 status
= set_current_packet(notit
);
2331 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2335 BT_ASSERT(notit
->packet
);
2336 sc
= notit
->meta
.sc
->ir_sc
;
2339 if (bt_stream_class_packets_have_discarded_event_counter_snapshot(sc
)) {
2340 BT_ASSERT(notit
->snapshots
.discarded_events
!= UINT64_C(-1));
2341 bt_packet_set_discarded_event_counter_snapshot(
2342 notit
->packet
, notit
->snapshots
.discarded_events
);
2345 if (bt_stream_class_packets_have_packet_counter_snapshot(sc
)) {
2346 BT_ASSERT(notit
->snapshots
.packets
!= UINT64_C(-1));
2347 bt_packet_set_packet_counter_snapshot(
2348 notit
->packet
, notit
->snapshots
.packets
);
2351 if (bt_stream_class_packets_have_default_beginning_clock_value(sc
)) {
2352 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2353 bt_packet_set_default_beginning_clock_value(
2354 notit
->packet
, notit
->snapshots
.beginning_clock
);
2357 if (bt_stream_class_packets_have_default_end_clock_value(sc
)) {
2358 BT_ASSERT(notit
->snapshots
.end_clock
!= UINT64_C(-1));
2359 bt_packet_set_default_end_clock_value(
2360 notit
->packet
, notit
->snapshots
.end_clock
);
2363 if (notit
->packet_header_field
) {
2364 ret
= bt_packet_move_header_field(
2365 notit
->packet
, notit
->packet_header_field
);
2370 notit
->packet_header_field
= NULL
;
2373 * At this point notit->dscopes.trace_packet_header has
2374 * the same value as the packet header field within
2377 BT_ASSERT(bt_packet_borrow_header_field(
2379 notit
->dscopes
.trace_packet_header
);
2382 if (notit
->packet_context_field
) {
2383 ret
= bt_packet_move_context_field(
2384 notit
->packet
, notit
->packet_context_field
);
2389 notit
->packet_context_field
= NULL
;
2392 * At this point notit->dscopes.trace_packet_header has
2393 * the same value as the packet header field within
2396 BT_ASSERT(bt_packet_borrow_context_field(
2398 notit
->dscopes
.stream_packet_context
);
2401 BT_ASSERT(notit
->notif_iter
);
2402 notif
= bt_notification_packet_begin_create(notit
->notif_iter
,
2405 BT_LOGE("Cannot create packet beginning notification: "
2406 "notit-addr=%p, packet-addr=%p",
2407 notit
, notit
->packet
);
2411 *notification
= notif
;
2418 void notify_end_of_packet(struct bt_notif_iter
*notit
,
2419 struct bt_notification
**notification
)
2421 struct bt_notification
*notif
;
2423 if (!notit
->packet
) {
2427 /* Update default clock from packet's end time */
2428 if (notit
->snapshots
.end_clock
!= UINT64_C(-1)) {
2429 notit
->default_clock_val
= notit
->snapshots
.end_clock
;
2432 BT_ASSERT(notit
->notif_iter
);
2433 notif
= bt_notification_packet_end_create(notit
->notif_iter
,
2436 BT_LOGE("Cannot create packet end notification: "
2437 "notit-addr=%p, packet-addr=%p",
2438 notit
, notit
->packet
);
2443 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
2444 *notification
= notif
;
2448 struct bt_notif_iter
*bt_notif_iter_create(struct ctf_trace_class
*tc
,
2449 size_t max_request_sz
,
2450 struct bt_notif_iter_medium_ops medops
, void *data
)
2452 struct bt_notif_iter
*notit
= NULL
;
2453 struct bt_bfcr_cbs cbs
= {
2455 .signed_int
= bfcr_signed_int_cb
,
2456 .unsigned_int
= bfcr_unsigned_int_cb
,
2457 .floating_point
= bfcr_floating_point_cb
,
2458 .string_begin
= bfcr_string_begin_cb
,
2459 .string
= bfcr_string_cb
,
2460 .string_end
= bfcr_string_end_cb
,
2461 .compound_begin
= bfcr_compound_begin_cb
,
2462 .compound_end
= bfcr_compound_end_cb
,
2465 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2466 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2471 BT_ASSERT(medops
.request_bytes
);
2472 BT_ASSERT(medops
.borrow_stream
);
2473 BT_LOGD("Creating CTF plugin notification iterator: "
2474 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
2475 "data=%p", tc
, tc
->name
->str
, max_request_sz
, data
);
2476 notit
= g_new0(struct bt_notif_iter
, 1);
2478 BT_LOGE_STR("Failed to allocate one CTF plugin notification iterator.");
2481 notit
->meta
.tc
= tc
;
2482 notit
->medium
.medops
= medops
;
2483 notit
->medium
.max_request_sz
= max_request_sz
;
2484 notit
->medium
.data
= data
;
2485 notit
->stack
= stack_new(notit
);
2486 notit
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2487 g_array_set_size(notit
->stored_values
, tc
->stored_value_count
);
2489 if (!notit
->stack
) {
2490 BT_LOGE_STR("Failed to create field stack.");
2494 notit
->bfcr
= bt_bfcr_create(cbs
, notit
);
2496 BT_LOGE_STR("Failed to create binary class reader (BFCR).");
2500 bt_notif_iter_reset(notit
);
2501 BT_LOGD("Created CTF plugin notification iterator: "
2502 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
2503 "data=%p, notit-addr=%p",
2504 tc
, tc
->name
->str
, max_request_sz
, data
,
2506 notit
->cur_packet_offset
= 0;
2512 bt_notif_iter_destroy(notit
);
2517 void bt_notif_iter_destroy(struct bt_notif_iter
*notit
)
2519 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
2520 BT_OBJECT_PUT_REF_AND_RESET(notit
->stream
);
2521 release_all_dscopes(notit
);
2523 BT_LOGD("Destroying CTF plugin notification iterator: addr=%p", notit
);
2526 BT_LOGD_STR("Destroying field stack.");
2527 stack_destroy(notit
->stack
);
2531 BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit
->bfcr
);
2532 bt_bfcr_destroy(notit
->bfcr
);
2535 if (notit
->stored_values
) {
2536 g_array_free(notit
->stored_values
, TRUE
);
2542 enum bt_notif_iter_status
bt_notif_iter_get_next_notification(
2543 struct bt_notif_iter
*notit
,
2544 struct bt_self_notification_iterator
*notif_iter
,
2545 struct bt_notification
**notification
)
2547 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
2550 BT_ASSERT(notification
);
2552 if (notit
->state
== STATE_DONE
) {
2553 status
= BT_NOTIF_ITER_STATUS_EOF
;
2557 notit
->notif_iter
= notif_iter
;
2559 BT_LOGV("Getting next notification: notit-addr=%p", notit
);
2562 status
= handle_state(notit
);
2563 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
2564 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
2568 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2569 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
2570 enum state next_state
= notit
->state
;
2572 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
2574 if (notit
->packet
) {
2575 notify_end_of_packet(notit
,
2578 notify_end_of_stream(notit
,
2580 next_state
= STATE_DONE
;
2583 if (!*notification
) {
2584 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2588 status
= BT_NOTIF_ITER_STATUS_OK
;
2589 notit
->state
= next_state
;
2591 BT_LOGW("Cannot handle state: "
2592 "notit-addr=%p, state=%s",
2593 notit
, state_string(notit
->state
));
2599 switch (notit
->state
) {
2600 case STATE_EMIT_NOTIF_NEW_STREAM
:
2601 /* notify_new_stream() logs errors */
2602 notify_new_stream(notit
, notification
);
2604 if (!*notification
) {
2605 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2608 notit
->stream_begin_emitted
= true;
2610 case STATE_EMIT_NOTIF_NEW_PACKET
:
2611 /* notify_new_packet() logs errors */
2612 notify_new_packet(notit
, notification
);
2614 if (!*notification
) {
2615 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2619 case STATE_EMIT_NOTIF_EVENT
:
2620 BT_ASSERT(notit
->event_notif
);
2621 set_event_default_clock_value(notit
);
2622 *notification
= notit
->event_notif
;
2623 notit
->event_notif
= NULL
;
2625 case STATE_EMIT_NOTIF_END_OF_PACKET
:
2626 /* notify_end_of_packet() logs errors */
2627 notify_end_of_packet(notit
, notification
);
2629 if (!*notification
) {
2630 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2635 /* Non-emitting state: continue */
2645 enum bt_notif_iter_status
bt_notif_iter_borrow_packet_header_context_fields(
2646 struct bt_notif_iter
*notit
,
2647 struct bt_field
**packet_header_field
,
2648 struct bt_field
**packet_context_field
)
2651 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
2655 if (notit
->state
== STATE_EMIT_NOTIF_NEW_PACKET
) {
2656 /* We're already there */
2661 status
= handle_state(notit
);
2662 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
2663 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
2666 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2667 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
2668 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
2670 BT_LOGW("Cannot handle state: "
2671 "notit-addr=%p, state=%s",
2672 notit
, state_string(notit
->state
));
2677 switch (notit
->state
) {
2678 case STATE_EMIT_NOTIF_NEW_PACKET
:
2680 * Packet header and context fields are
2681 * potentially decoded (or they don't exist).
2685 case STATE_EMIT_NOTIF_NEW_STREAM
:
2686 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
2687 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
2688 case STATE_AFTER_TRACE_PACKET_HEADER
:
2689 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
2690 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
2691 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
2692 /* Non-emitting state: continue */
2696 * We should never get past the
2697 * STATE_EMIT_NOTIF_NEW_PACKET state.
2699 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
2700 notit
, state_string(notit
->state
));
2706 ret
= set_current_packet_content_sizes(notit
);
2708 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2712 if (packet_header_field
) {
2713 *packet_header_field
= notit
->dscopes
.trace_packet_header
;
2716 if (packet_context_field
) {
2717 *packet_context_field
= notit
->dscopes
.stream_packet_context
;
2725 void bt_notif_iter_set_medops_data(struct bt_notif_iter
*notit
,
2729 notit
->medium
.data
= medops_data
;
2733 enum bt_notif_iter_status
bt_notif_iter_seek(
2734 struct bt_notif_iter
*notit
, off_t offset
)
2736 enum bt_notif_iter_status ret
= BT_NOTIF_ITER_STATUS_OK
;
2737 enum bt_notif_iter_medium_status medium_status
;
2741 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset
);
2742 ret
= BT_NOTIF_ITER_STATUS_INVAL
;
2746 if (!notit
->medium
.medops
.seek
) {
2747 ret
= BT_NOTIF_ITER_STATUS_UNSUPPORTED
;
2748 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2752 medium_status
= notit
->medium
.medops
.seek(
2753 BT_NOTIF_ITER_SEEK_WHENCE_SET
, offset
, notit
->medium
.data
);
2754 if (medium_status
!= BT_NOTIF_ITER_MEDIUM_STATUS_OK
) {
2755 if (medium_status
== BT_NOTIF_ITER_MEDIUM_STATUS_EOF
) {
2756 ret
= BT_NOTIF_ITER_STATUS_EOF
;
2758 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
2763 bt_notif_iter_reset(notit
);
2764 notit
->cur_packet_offset
= offset
;
2771 off_t
bt_notif_iter_get_current_packet_offset(struct bt_notif_iter
*notit
)
2774 return notit
->cur_packet_offset
;
2778 off_t
bt_notif_iter_get_current_packet_size(
2779 struct bt_notif_iter
*notit
)
2782 return notit
->cur_exp_packet_total_size
;
2786 void bt_notif_trace_class_changed(struct bt_notif_iter
*notit
)
2788 if (notit
->meta
.tc
->stored_value_count
> notit
->stored_values
->len
) {
2789 g_array_set_size(notit
->stored_values
,
2790 notit
->meta
.tc
->stored_value_count
);
2795 enum bt_notif_iter_status
bt_notif_iter_get_packet_properties(
2796 struct bt_notif_iter
*notit
,
2797 struct bt_notif_iter_packet_properties
*props
)
2802 props
->exp_packet_total_size
=
2803 (uint64_t) notit
->cur_exp_packet_total_size
;
2804 props
->exp_packet_content_size
=
2805 (uint64_t) notit
->cur_exp_packet_content_size
;
2806 BT_ASSERT(props
->stream_class_id
>= 0);
2807 props
->stream_class_id
= (uint64_t) notit
->cur_stream_class_id
;
2808 props
->data_stream_id
= notit
->cur_data_stream_id
;
2809 props
->snapshots
.discarded_events
= notit
->snapshots
.discarded_events
;
2810 props
->snapshots
.packets
= notit
->snapshots
.packets
;
2811 props
->snapshots
.beginning_clock
= notit
->snapshots
.beginning_clock
;
2812 props
->snapshots
.end_clock
= notit
->snapshots
.end_clock
;
2813 return BT_NOTIF_ITER_STATUS_OK
;