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_private_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_private_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_private_packet_header_field
*packet_header_field
;
132 /* Current packet header field wrapper (NULL if not created yet) */
133 struct bt_private_packet_context_field
*packet_context_field
;
135 /* Current event header field (NULL if not created yet) */
136 struct bt_private_event_header_field
*event_header_field
;
138 /* Current packet (NULL if not created yet) */
139 struct bt_private_packet
*packet
;
141 /* Current stream (NULL if not set yet) */
142 struct bt_private_stream
*stream
;
144 /* Current event (NULL if not created yet) */
145 struct bt_private_event
*event
;
147 /* Current event notification (NULL if not created yet) */
148 struct bt_private_notification
*event_notif
;
150 /* Database of current dynamic scopes */
152 struct bt_private_field
*trace_packet_header
;
153 struct bt_private_field
*stream_packet_context
;
154 struct bt_private_field
*event_header
;
155 struct bt_private_field
*event_common_context
;
156 struct bt_private_field
*event_spec_context
;
157 struct bt_private_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_private_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_private_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_private_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_private_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_private_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_private_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_private_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
;
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: "
760 "notit-addr=%p, stream-class-id=%" PRIu64
", "
761 "trace-addr=%p, trace-name=\"%s\"",
762 notit
, notit
->cur_stream_class_id
, notit
->meta
.tc
,
763 notit
->meta
.tc
->name
->str
);
764 status
= BT_NOTIF_ITER_STATUS_ERROR
;
768 if (notit
->meta
.sc
) {
769 if (new_stream_class
!= notit
->meta
.sc
) {
770 BT_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
771 "notit-addr=%p, prev-stream-class-addr=%p, "
772 "prev-stream-class-id=%" PRId64
", "
773 "next-stream-class-addr=%p, "
774 "next-stream-class-id=%" PRId64
", "
775 "trace-addr=%p, trace-name=\"%s\"",
776 notit
, notit
->meta
.sc
,
779 new_stream_class
->id
,
781 notit
->meta
.tc
->name
->str
);
782 status
= BT_NOTIF_ITER_STATUS_ERROR
;
786 notit
->meta
.sc
= new_stream_class
;
789 BT_LOGV("Set current stream class: "
790 "notit-addr=%p, stream-class-addr=%p, "
791 "stream-class-id=%" PRId64
,
792 notit
, notit
->meta
.sc
, notit
->meta
.sc
->id
);
799 enum bt_notif_iter_status
set_current_stream(struct bt_notif_iter
*notit
)
801 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
802 struct bt_private_stream
*stream
= NULL
;
804 BT_LOGV("Calling user function (get stream): notit-addr=%p, "
805 "stream-class-addr=%p, stream-class-id=%" PRId64
,
806 notit
, notit
->meta
.sc
,
808 stream
= bt_object_get_ref(notit
->medium
.medops
.borrow_stream(
809 notit
->meta
.sc
->ir_sc
, notit
->cur_data_stream_id
,
810 notit
->medium
.data
));
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_private_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_private_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_private_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_private_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_private_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_private_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
;
1171 new_event_class
= ctf_stream_class_borrow_event_class_by_id(
1172 notit
->meta
.sc
, notit
->cur_event_class_id
);
1173 if (!new_event_class
) {
1174 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1175 "notit-addr=%p, stream-class-id=%" PRIu64
", "
1176 "event-class-id=%" PRIu64
", "
1177 "trace-addr=%p, trace-name=\"%s\"",
1178 notit
, notit
->meta
.sc
->id
, notit
->cur_event_class_id
,
1179 notit
->meta
.tc
, notit
->meta
.tc
->name
->str
);
1180 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1184 notit
->meta
.ec
= new_event_class
;
1185 BT_LOGV("Set current event class: "
1186 "notit-addr=%p, event-class-addr=%p, "
1187 "event-class-id=%" PRId64
", "
1188 "event-class-name=\"%s\"",
1189 notit
, notit
->meta
.ec
, notit
->meta
.ec
->id
,
1190 notit
->meta
.ec
->name
->str
);
1197 enum bt_notif_iter_status
set_current_event_notification(
1198 struct bt_notif_iter
*notit
)
1200 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1201 struct bt_private_notification
*notif
= NULL
;
1203 BT_ASSERT(notit
->meta
.ec
);
1204 BT_ASSERT(notit
->packet
);
1205 BT_LOGV("Creating event notification from event class and packet: "
1206 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1207 notit
, notit
->meta
.ec
,
1208 notit
->meta
.ec
->name
->str
,
1210 BT_ASSERT(notit
->notif_iter
);
1211 notif
= bt_private_notification_event_create(notit
->notif_iter
,
1212 notit
->meta
.ec
->ir_ec
, notit
->packet
);
1214 BT_LOGE("Cannot create event notification: "
1215 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1217 notit
, notit
->meta
.ec
,
1218 notit
->meta
.ec
->name
->str
,
1226 BT_OBJECT_PUT_REF_AND_RESET(notif
);
1227 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1230 BT_OBJECT_MOVE_REF(notit
->event_notif
, notif
);
1235 enum bt_notif_iter_status
after_event_header_state(
1236 struct bt_notif_iter
*notit
)
1238 enum bt_notif_iter_status status
;
1240 status
= set_current_event_class(notit
);
1241 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1245 status
= set_current_event_notification(notit
);
1246 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1250 notit
->event
= bt_private_notification_event_borrow_event(
1251 notit
->event_notif
);
1252 BT_ASSERT(notit
->event
);
1254 if (notit
->event_header_field
) {
1257 BT_ASSERT(notit
->event
);
1258 ret
= bt_private_event_move_header_field(notit
->event
,
1259 notit
->event_header_field
);
1261 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1265 notit
->event_header_field
= NULL
;
1268 * At this point notit->dscopes.event_header has
1269 * the same value as the event header field within
1272 BT_ASSERT(bt_private_event_borrow_header_field(
1273 notit
->event
) == notit
->dscopes
.event_header
);
1276 notit
->state
= STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
;
1283 enum bt_notif_iter_status
read_event_common_context_begin_state(
1284 struct bt_notif_iter
*notit
)
1286 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1287 struct ctf_field_class
*event_common_context_fc
;
1289 event_common_context_fc
= notit
->meta
.sc
->event_common_context_fc
;
1290 if (!event_common_context_fc
) {
1291 notit
->state
= STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
;
1295 if (event_common_context_fc
->in_ir
) {
1296 BT_ASSERT(!notit
->dscopes
.event_common_context
);
1297 notit
->dscopes
.event_common_context
=
1298 bt_private_event_borrow_common_context_field(
1300 BT_ASSERT(notit
->dscopes
.event_common_context
);
1303 BT_LOGV("Decoding event common context field: "
1304 "notit-addr=%p, stream-class-addr=%p, "
1305 "stream-class-id=%" PRId64
", "
1307 notit
, notit
->meta
.sc
,
1309 event_common_context_fc
);
1310 status
= read_dscope_begin_state(notit
, event_common_context_fc
,
1311 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
,
1312 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
,
1313 notit
->dscopes
.event_common_context
);
1315 BT_LOGW("Cannot decode event common context field: "
1316 "notit-addr=%p, stream-class-addr=%p, "
1317 "stream-class-id=%" PRId64
", fc-addr=%p",
1318 notit
, notit
->meta
.sc
,
1320 event_common_context_fc
);
1328 enum bt_notif_iter_status
read_event_common_context_continue_state(
1329 struct bt_notif_iter
*notit
)
1331 return read_dscope_continue_state(notit
,
1332 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
);
1336 enum bt_notif_iter_status
read_event_spec_context_begin_state(
1337 struct bt_notif_iter
*notit
)
1339 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1340 struct ctf_field_class
*event_spec_context_fc
;
1342 event_spec_context_fc
= notit
->meta
.ec
->spec_context_fc
;
1343 if (!event_spec_context_fc
) {
1344 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1348 if (event_spec_context_fc
->in_ir
) {
1349 BT_ASSERT(!notit
->dscopes
.event_spec_context
);
1350 notit
->dscopes
.event_spec_context
=
1351 bt_private_event_borrow_specific_context_field(
1353 BT_ASSERT(notit
->dscopes
.event_spec_context
);
1356 BT_LOGV("Decoding event specific context field: "
1357 "notit-addr=%p, event-class-addr=%p, "
1358 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1360 notit
, notit
->meta
.ec
,
1361 notit
->meta
.ec
->name
->str
,
1363 event_spec_context_fc
);
1364 status
= read_dscope_begin_state(notit
, event_spec_context_fc
,
1365 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1366 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
,
1367 notit
->dscopes
.event_spec_context
);
1369 BT_LOGW("Cannot decode event specific context field: "
1370 "notit-addr=%p, event-class-addr=%p, "
1371 "event-class-name=\"%s\", "
1372 "event-class-id=%" PRId64
", fc-addr=%p",
1373 notit
, notit
->meta
.ec
,
1374 notit
->meta
.ec
->name
->str
,
1376 event_spec_context_fc
);
1384 enum bt_notif_iter_status
read_event_spec_context_continue_state(
1385 struct bt_notif_iter
*notit
)
1387 return read_dscope_continue_state(notit
,
1388 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1392 enum bt_notif_iter_status
read_event_payload_begin_state(
1393 struct bt_notif_iter
*notit
)
1395 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1396 struct ctf_field_class
*event_payload_fc
;
1398 event_payload_fc
= notit
->meta
.ec
->payload_fc
;
1399 if (!event_payload_fc
) {
1400 notit
->state
= STATE_EMIT_NOTIF_EVENT
;
1404 if (event_payload_fc
->in_ir
) {
1405 BT_ASSERT(!notit
->dscopes
.event_payload
);
1406 notit
->dscopes
.event_payload
=
1407 bt_private_event_borrow_payload_field(
1409 BT_ASSERT(notit
->dscopes
.event_payload
);
1412 BT_LOGV("Decoding event payload field: "
1413 "notit-addr=%p, event-class-addr=%p, "
1414 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1416 notit
, notit
->meta
.ec
,
1417 notit
->meta
.ec
->name
->str
,
1420 status
= read_dscope_begin_state(notit
, event_payload_fc
,
1421 STATE_EMIT_NOTIF_EVENT
,
1422 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1423 notit
->dscopes
.event_payload
);
1425 BT_LOGW("Cannot decode event payload field: "
1426 "notit-addr=%p, event-class-addr=%p, "
1427 "event-class-name=\"%s\", "
1428 "event-class-id=%" PRId64
", fc-addr=%p",
1429 notit
, notit
->meta
.ec
,
1430 notit
->meta
.ec
->name
->str
,
1440 enum bt_notif_iter_status
read_event_payload_continue_state(
1441 struct bt_notif_iter
*notit
)
1443 return read_dscope_continue_state(notit
, STATE_EMIT_NOTIF_EVENT
);
1447 enum bt_notif_iter_status
skip_packet_padding_state(
1448 struct bt_notif_iter
*notit
)
1450 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1451 size_t bits_to_skip
;
1453 BT_ASSERT(notit
->cur_exp_packet_total_size
> 0);
1454 bits_to_skip
= notit
->cur_exp_packet_total_size
- packet_at(notit
);
1455 if (bits_to_skip
== 0) {
1456 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1459 size_t bits_to_consume
;
1461 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1462 bits_to_skip
, notit
, bits_to_skip
);
1463 status
= buf_ensure_available_bits(notit
);
1464 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1468 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1469 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1470 bits_to_consume
, notit
, bits_to_consume
);
1471 buf_consume_bits(notit
, bits_to_consume
);
1472 bits_to_skip
= notit
->cur_exp_packet_total_size
-
1474 if (bits_to_skip
== 0) {
1475 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1485 enum bt_notif_iter_status
handle_state(struct bt_notif_iter
*notit
)
1487 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1488 const enum state state
= notit
->state
;
1490 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1491 notit
, state_string(state
));
1493 // TODO: optimalize!
1496 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1498 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1499 status
= read_packet_header_begin_state(notit
);
1501 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1502 status
= read_packet_header_continue_state(notit
);
1504 case STATE_AFTER_TRACE_PACKET_HEADER
:
1505 status
= after_packet_header_state(notit
);
1507 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1508 status
= read_packet_context_begin_state(notit
);
1510 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1511 status
= read_packet_context_continue_state(notit
);
1513 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1514 status
= after_packet_context_state(notit
);
1516 case STATE_EMIT_NOTIF_NEW_STREAM
:
1517 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
1519 case STATE_EMIT_NOTIF_NEW_PACKET
:
1520 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1522 case STATE_DSCOPE_EVENT_HEADER_BEGIN
:
1523 status
= read_event_header_begin_state(notit
);
1525 case STATE_DSCOPE_EVENT_HEADER_CONTINUE
:
1526 status
= read_event_header_continue_state(notit
);
1528 case STATE_AFTER_EVENT_HEADER
:
1529 status
= after_event_header_state(notit
);
1531 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN
:
1532 status
= read_event_common_context_begin_state(notit
);
1534 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE
:
1535 status
= read_event_common_context_continue_state(notit
);
1537 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN
:
1538 status
= read_event_spec_context_begin_state(notit
);
1540 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE
:
1541 status
= read_event_spec_context_continue_state(notit
);
1543 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1544 status
= read_event_payload_begin_state(notit
);
1546 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1547 status
= read_event_payload_continue_state(notit
);
1549 case STATE_EMIT_NOTIF_EVENT
:
1550 notit
->state
= STATE_DSCOPE_EVENT_HEADER_BEGIN
;
1552 case STATE_SKIP_PACKET_PADDING
:
1553 status
= skip_packet_padding_state(notit
);
1555 case STATE_EMIT_NOTIF_END_OF_PACKET
:
1556 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1559 BT_LOGD("Unknown CTF plugin notification iterator state: "
1560 "notit-addr=%p, state=%d", notit
, notit
->state
);
1564 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1565 "prev-state=%s, cur-state=%s",
1566 notit
, bt_notif_iter_status_string(status
),
1567 state_string(state
), state_string(notit
->state
));
1572 * Resets the internal state of a CTF notification iterator.
1575 void bt_notif_iter_reset(struct bt_notif_iter
*notit
)
1578 BT_LOGD("Resetting notification iterator: addr=%p", notit
);
1579 stack_clear(notit
->stack
);
1580 notit
->meta
.sc
= NULL
;
1581 notit
->meta
.ec
= NULL
;
1582 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
1583 BT_OBJECT_PUT_REF_AND_RESET(notit
->stream
);
1584 BT_OBJECT_PUT_REF_AND_RESET(notit
->event_notif
);
1585 release_all_dscopes(notit
);
1586 notit
->cur_dscope_field
= NULL
;
1588 if (notit
->packet_header_field
) {
1589 bt_private_packet_header_field_release(notit
->packet_header_field
);
1590 notit
->packet_header_field
= NULL
;
1593 if (notit
->packet_context_field
) {
1594 bt_private_packet_context_field_release(notit
->packet_context_field
);
1595 notit
->packet_context_field
= NULL
;
1598 if (notit
->event_header_field
) {
1599 bt_private_event_header_field_release(notit
->event_header_field
);
1600 notit
->event_header_field
= NULL
;
1603 notit
->buf
.addr
= NULL
;
1606 notit
->buf
.last_eh_at
= SIZE_MAX
;
1607 notit
->buf
.packet_offset
= 0;
1608 notit
->state
= STATE_INIT
;
1609 notit
->cur_exp_packet_content_size
= -1;
1610 notit
->cur_exp_packet_total_size
= -1;
1611 notit
->cur_packet_offset
= -1;
1612 notit
->cur_stream_class_id
= -1;
1613 notit
->cur_event_class_id
= -1;
1614 notit
->cur_data_stream_id
= -1;
1615 notit
->stream_begin_emitted
= false;
1619 int bt_notif_iter_switch_packet(struct bt_notif_iter
*notit
)
1624 * We don't put the stream class here because we need to make
1625 * sure that all the packets processed by the same notification
1626 * iterator refer to the same stream class (the first one).
1630 if (notit
->cur_exp_packet_total_size
!= -1) {
1631 notit
->cur_packet_offset
+= notit
->cur_exp_packet_total_size
;
1634 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1635 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
1636 notit
->cur_packet_offset
);
1637 stack_clear(notit
->stack
);
1638 notit
->meta
.ec
= NULL
;
1639 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
1640 BT_OBJECT_PUT_REF_AND_RESET(notit
->event_notif
);
1641 release_all_dscopes(notit
);
1642 notit
->cur_dscope_field
= NULL
;
1645 * Adjust current buffer so that addr points to the beginning of the new
1648 if (notit
->buf
.addr
) {
1649 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1651 /* Packets are assumed to start on a byte frontier. */
1652 if (notit
->buf
.at
% CHAR_BIT
) {
1653 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1654 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
1659 notit
->buf
.addr
+= consumed_bytes
;
1660 notit
->buf
.sz
-= consumed_bytes
;
1662 notit
->buf
.packet_offset
= 0;
1663 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1664 notit
->buf
.addr
, notit
->buf
.sz
);
1667 notit
->cur_exp_packet_content_size
= -1;
1668 notit
->cur_exp_packet_total_size
= -1;
1669 notit
->cur_stream_class_id
= -1;
1670 notit
->cur_event_class_id
= -1;
1671 notit
->cur_data_stream_id
= -1;
1672 notit
->snapshots
.discarded_events
= UINT64_C(-1);
1673 notit
->snapshots
.packets
= UINT64_C(-1);
1674 notit
->snapshots
.beginning_clock
= UINT64_C(-1);
1675 notit
->snapshots
.end_clock
= UINT64_C(-1);
1682 struct bt_private_field
*borrow_next_field(struct bt_notif_iter
*notit
)
1684 struct bt_private_field
*next_field
= NULL
;
1685 struct bt_private_field
*base_field
;
1686 struct bt_private_field_class
*base_fc
;
1689 BT_ASSERT(!stack_empty(notit
->stack
));
1690 index
= stack_top(notit
->stack
)->index
;
1691 base_field
= stack_top(notit
->stack
)->base
;
1692 BT_ASSERT(base_field
);
1693 base_fc
= bt_private_field_borrow_class(base_field
);
1696 switch (bt_field_class_get_type(
1697 bt_private_field_class_as_field_class(base_fc
))) {
1698 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1701 bt_field_class_structure_get_member_count(
1702 bt_private_field_class_as_field_class(
1703 bt_private_field_borrow_class(
1706 bt_private_field_structure_borrow_member_field_by_index(
1710 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1711 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1712 BT_ASSERT(index
< bt_field_array_get_length(
1713 bt_private_field_as_field(base_field
)));
1714 next_field
= bt_private_field_array_borrow_element_field_by_index(
1717 case BT_FIELD_CLASS_TYPE_VARIANT
:
1718 BT_ASSERT(index
== 0);
1719 next_field
= bt_private_field_variant_borrow_selected_option_field(
1726 BT_ASSERT(next_field
);
1731 void update_default_clock(struct bt_notif_iter
*notit
, uint64_t new_val
,
1732 uint64_t new_val_size
)
1734 uint64_t new_val_mask
;
1735 uint64_t cur_value_masked
;
1737 BT_ASSERT(new_val_size
> 0);
1740 * Special case for a 64-bit new value, which is the limit
1741 * of a clock value as of this version: overwrite the
1742 * current value directly.
1744 if (new_val_size
== 64) {
1745 notit
->default_clock_val
= new_val
;
1749 new_val_mask
= (1ULL << new_val_size
) - 1;
1750 cur_value_masked
= notit
->default_clock_val
& new_val_mask
;
1752 if (new_val
< cur_value_masked
) {
1754 * It looks like a wrap happened on the number of bits
1755 * of the requested new value. Assume that the clock
1756 * value wrapped only one time.
1758 notit
->default_clock_val
+= new_val_mask
+ 1;
1761 /* Clear the low bits of the current clock value. */
1762 notit
->default_clock_val
&= ~new_val_mask
;
1764 /* Set the low bits of the current clock value. */
1765 notit
->default_clock_val
|= new_val
;
1768 BT_LOGV("Updated default clock's value from integer field's value: "
1769 "value=%" PRIu64
, notit
->default_clock_val
);
1773 enum bt_bfcr_status
bfcr_unsigned_int_cb(uint64_t value
,
1774 struct ctf_field_class
*fc
, void *data
)
1776 struct bt_notif_iter
*notit
= data
;
1777 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1778 struct bt_private_field
*field
= NULL
;
1779 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1781 BT_LOGV("Unsigned integer function called from BFCR: "
1782 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1783 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1784 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1786 if (likely(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
)) {
1787 goto update_def_clock
;
1790 switch (int_fc
->meaning
) {
1791 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID
:
1792 notit
->cur_event_class_id
= value
;
1794 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID
:
1795 notit
->cur_data_stream_id
= value
;
1797 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME
:
1798 notit
->snapshots
.beginning_clock
= value
;
1800 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME
:
1801 notit
->snapshots
.end_clock
= value
;
1803 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID
:
1804 notit
->cur_stream_class_id
= value
;
1806 case CTF_FIELD_CLASS_MEANING_MAGIC
:
1807 if (value
!= 0xc1fc1fc1) {
1808 BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
1809 "magic=%" PRIx64
, notit
, value
);
1810 status
= BT_BFCR_STATUS_ERROR
;
1815 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT
:
1816 notit
->snapshots
.packets
= value
;
1818 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT
:
1819 notit
->snapshots
.discarded_events
= value
;
1821 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE
:
1822 notit
->cur_exp_packet_total_size
= value
;
1824 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE
:
1825 notit
->cur_exp_packet_content_size
= value
;
1832 if (unlikely(int_fc
->mapped_clock_class
)) {
1833 update_default_clock(notit
, value
, int_fc
->base
.size
);
1836 if (unlikely(int_fc
->storing_index
>= 0)) {
1837 g_array_index(notit
->stored_values
, uint64_t,
1838 (uint64_t) int_fc
->storing_index
) = value
;
1841 if (unlikely(!fc
->in_ir
)) {
1845 field
= borrow_next_field(notit
);
1847 BT_ASSERT(bt_private_field_borrow_class(field
) == fc
->ir_fc
);
1848 BT_ASSERT(bt_field_get_class_type(
1849 bt_private_field_as_field(field
)) ==
1850 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
1851 bt_field_get_class_type(bt_private_field_as_field(field
)) ==
1852 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
);
1853 bt_private_field_unsigned_integer_set_value(field
, value
);
1854 stack_top(notit
->stack
)->index
++;
1861 enum bt_bfcr_status
bfcr_unsigned_int_char_cb(uint64_t value
,
1862 struct ctf_field_class
*fc
, void *data
)
1865 struct bt_notif_iter
*notit
= data
;
1866 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1867 struct bt_private_field
*string_field
= NULL
;
1868 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1869 char str
[2] = {'\0', '\0'};
1871 BT_LOGV("Unsigned integer character function called from BFCR: "
1872 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1873 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64
,
1874 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1875 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1876 BT_ASSERT(!int_fc
->mapped_clock_class
);
1877 BT_ASSERT(int_fc
->storing_index
< 0);
1879 if (unlikely(!fc
->in_ir
)) {
1883 if (notit
->done_filling_string
) {
1888 notit
->done_filling_string
= true;
1892 string_field
= stack_top(notit
->stack
)->base
;
1893 BT_ASSERT(bt_field_get_class_type(
1894 bt_private_field_as_field(string_field
)) ==
1895 BT_FIELD_CLASS_TYPE_STRING
);
1897 /* Append character */
1898 str
[0] = (char) value
;
1899 ret
= bt_private_field_string_append_with_length(string_field
, str
, 1);
1901 BT_LOGE("Cannot append character to string field's value: "
1902 "notit-addr=%p, field-addr=%p, ret=%d",
1903 notit
, string_field
, ret
);
1904 status
= BT_BFCR_STATUS_ERROR
;
1913 enum bt_bfcr_status
bfcr_signed_int_cb(int64_t value
,
1914 struct ctf_field_class
*fc
, void *data
)
1916 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1917 struct bt_private_field
*field
= NULL
;
1918 struct bt_notif_iter
*notit
= data
;
1919 struct ctf_field_class_int
*int_fc
= (void *) fc
;
1921 BT_LOGV("Signed integer function called from BFCR: "
1922 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1923 "fc-type=%d, fc-in-ir=%d, value=%" PRId64
,
1924 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1925 BT_ASSERT(int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
);
1927 if (unlikely(int_fc
->storing_index
>= 0)) {
1928 g_array_index(notit
->stored_values
, uint64_t,
1929 (uint64_t) int_fc
->storing_index
) = (uint64_t) value
;
1932 if (unlikely(!fc
->in_ir
)) {
1936 field
= borrow_next_field(notit
);
1938 BT_ASSERT(bt_private_field_borrow_class(field
) == fc
->ir_fc
);
1939 BT_ASSERT(bt_field_get_class_type(
1940 bt_private_field_as_field(field
)) ==
1941 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
||
1942 bt_field_get_class_type(bt_private_field_as_field(field
)) ==
1943 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
);
1944 bt_private_field_signed_integer_set_value(field
, value
);
1945 stack_top(notit
->stack
)->index
++;
1952 enum bt_bfcr_status
bfcr_floating_point_cb(double value
,
1953 struct ctf_field_class
*fc
, void *data
)
1955 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
1956 struct bt_private_field
*field
= NULL
;
1957 struct bt_notif_iter
*notit
= data
;
1959 BT_LOGV("Floating point number function called from BFCR: "
1960 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1961 "fc-type=%d, fc-in-ir=%d, value=%f",
1962 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
, value
);
1963 BT_ASSERT(fc
->in_ir
);
1964 field
= borrow_next_field(notit
);
1966 BT_ASSERT(bt_private_field_borrow_class(field
) == fc
->ir_fc
);
1967 BT_ASSERT(bt_field_get_class_type(
1968 bt_private_field_as_field(field
)) ==
1969 BT_FIELD_CLASS_TYPE_REAL
);
1970 bt_private_field_real_set_value(field
, value
);
1971 stack_top(notit
->stack
)->index
++;
1976 enum bt_bfcr_status
bfcr_string_begin_cb(
1977 struct ctf_field_class
*fc
, void *data
)
1979 struct bt_private_field
*field
= NULL
;
1980 struct bt_notif_iter
*notit
= data
;
1983 BT_LOGV("String (beginning) function called from BFCR: "
1984 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1985 "fc-type=%d, fc-in-ir=%d",
1986 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
1988 BT_ASSERT(fc
->in_ir
);
1989 field
= borrow_next_field(notit
);
1991 BT_ASSERT(bt_private_field_borrow_class(field
) == fc
->ir_fc
);
1992 BT_ASSERT(bt_field_get_class_type(
1993 bt_private_field_as_field(field
)) ==
1994 BT_FIELD_CLASS_TYPE_STRING
);
1995 ret
= bt_private_field_string_clear(field
);
1996 BT_ASSERT(ret
== 0);
1999 * Push on stack. Not a compound class per se, but we know that
2000 * only bfcr_string_cb() may be called between this call and a
2001 * subsequent call to bfcr_string_end_cb().
2003 stack_push(notit
->stack
, field
);
2004 return BT_BFCR_STATUS_OK
;
2008 enum bt_bfcr_status
bfcr_string_cb(const char *value
,
2009 size_t len
, struct ctf_field_class
*fc
, void *data
)
2011 enum bt_bfcr_status status
= BT_BFCR_STATUS_OK
;
2012 struct bt_private_field
*field
= NULL
;
2013 struct bt_notif_iter
*notit
= data
;
2016 BT_LOGV("String (substring) function called from BFCR: "
2017 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2018 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2019 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
,
2021 BT_ASSERT(fc
->in_ir
);
2022 field
= stack_top(notit
->stack
)->base
;
2025 /* Append current substring */
2026 ret
= bt_private_field_string_append_with_length(field
, value
, len
);
2028 BT_LOGE("Cannot append substring to string field's value: "
2029 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2030 "ret=%d", notit
, field
, len
, ret
);
2031 status
= BT_BFCR_STATUS_ERROR
;
2040 enum bt_bfcr_status
bfcr_string_end_cb(
2041 struct ctf_field_class
*fc
, void *data
)
2043 struct bt_notif_iter
*notit
= data
;
2045 BT_LOGV("String (end) function called from BFCR: "
2046 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2047 "fc-type=%d, fc-in-ir=%d",
2048 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2049 BT_ASSERT(fc
->in_ir
);
2051 /* Pop string field */
2052 stack_pop(notit
->stack
);
2054 /* Go to next field */
2055 stack_top(notit
->stack
)->index
++;
2056 return BT_BFCR_STATUS_OK
;
2059 enum bt_bfcr_status
bfcr_compound_begin_cb(
2060 struct ctf_field_class
*fc
, void *data
)
2062 struct bt_notif_iter
*notit
= data
;
2063 struct bt_private_field
*field
;
2065 BT_LOGV("Compound (beginning) function called from BFCR: "
2066 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2067 "fc-type=%d, fc-in-ir=%d",
2068 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2075 if (stack_empty(notit
->stack
)) {
2076 /* Root: already set by read_dscope_begin_state() */
2077 field
= notit
->cur_dscope_field
;
2079 field
= borrow_next_field(notit
);
2085 BT_ASSERT(bt_private_field_borrow_class(field
) == fc
->ir_fc
);
2086 stack_push(notit
->stack
, field
);
2089 * Change BFCR "unsigned int" callback if it's a text
2092 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2093 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2094 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2096 if (array_fc
->is_text
) {
2099 BT_ASSERT(bt_field_get_class_type(
2100 bt_private_field_as_field(field
)) ==
2101 BT_FIELD_CLASS_TYPE_STRING
);
2102 notit
->done_filling_string
= false;
2103 ret
= bt_private_field_string_clear(field
);
2104 BT_ASSERT(ret
== 0);
2105 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2106 bfcr_unsigned_int_char_cb
);
2111 return BT_BFCR_STATUS_OK
;
2114 enum bt_bfcr_status
bfcr_compound_end_cb(
2115 struct ctf_field_class
*fc
, void *data
)
2117 struct bt_notif_iter
*notit
= data
;
2119 BT_LOGV("Compound (end) function called from BFCR: "
2120 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2121 "fc-type=%d, fc-in-ir=%d",
2122 notit
, notit
->bfcr
, fc
, fc
->type
, fc
->in_ir
);
2128 BT_ASSERT(!stack_empty(notit
->stack
));
2129 BT_ASSERT(bt_private_field_borrow_class(stack_top(notit
->stack
)->base
) ==
2133 * Reset BFCR "unsigned int" callback if it's a text
2136 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
||
2137 fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
2138 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
2140 if (array_fc
->is_text
) {
2141 BT_ASSERT(bt_field_get_class_type(
2142 bt_private_field_as_field(
2143 stack_top(notit
->stack
)->base
)) ==
2144 BT_FIELD_CLASS_TYPE_STRING
);
2145 bt_bfcr_set_unsigned_int_cb(notit
->bfcr
,
2146 bfcr_unsigned_int_cb
);
2151 stack_pop(notit
->stack
);
2153 /* If the stack is not empty, increment the base's index */
2154 if (!stack_empty(notit
->stack
)) {
2155 stack_top(notit
->stack
)->index
++;
2159 return BT_BFCR_STATUS_OK
;
2163 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class
*fc
, void *data
)
2165 struct bt_private_field
*seq_field
;
2166 struct bt_notif_iter
*notit
= data
;
2167 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
2168 int64_t length
= -1;
2171 length
= (uint64_t) g_array_index(notit
->stored_values
, uint64_t,
2172 seq_fc
->stored_length_index
);
2173 seq_field
= stack_top(notit
->stack
)->base
;
2174 BT_ASSERT(seq_field
);
2175 ret
= bt_private_field_dynamic_array_set_length(seq_field
, (uint64_t) length
);
2177 BT_LOGE("Cannot set dynamic array field's length field: "
2178 "notit-addr=%p, field-addr=%p, "
2179 "length=%" PRIu64
, notit
, seq_field
, length
);
2186 struct ctf_field_class
*bfcr_borrow_variant_selected_field_class_cb(
2187 struct ctf_field_class
*fc
, void *data
)
2191 int64_t option_index
= -1;
2192 struct bt_notif_iter
*notit
= data
;
2193 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
2194 struct ctf_named_field_class
*selected_option
= NULL
;
2195 struct ctf_field_class
*ret_fc
= NULL
;
2201 /* Get variant's tag */
2202 tag
.u
= g_array_index(notit
->stored_values
, uint64_t,
2203 var_fc
->stored_tag_index
);
2206 * Check each range to find the selected option's index.
2208 if (var_fc
->tag_fc
->base
.is_signed
) {
2209 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2210 struct ctf_field_class_variant_range
*range
=
2211 ctf_field_class_variant_borrow_range_by_index(
2214 if (tag
.i
>= range
->range
.lower
.i
&&
2215 tag
.i
<= range
->range
.upper
.i
) {
2216 option_index
= (int64_t) range
->option_index
;
2221 for (i
= 0; i
< var_fc
->ranges
->len
; i
++) {
2222 struct ctf_field_class_variant_range
*range
=
2223 ctf_field_class_variant_borrow_range_by_index(
2226 if (tag
.u
>= range
->range
.lower
.u
&&
2227 tag
.u
<= range
->range
.upper
.u
) {
2228 option_index
= (int64_t) range
->option_index
;
2234 if (option_index
< 0) {
2235 BT_LOGW("Cannot find variant field class's option: "
2236 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64
", "
2237 "i-tag=%" PRId64
, notit
, var_fc
, tag
.u
, tag
.i
);
2241 selected_option
= ctf_field_class_variant_borrow_option_by_index(
2242 var_fc
, (uint64_t) option_index
);
2244 if (selected_option
->fc
->in_ir
) {
2245 struct bt_private_field
*var_field
= stack_top(notit
->stack
)->base
;
2247 ret
= bt_private_field_variant_select_option_field(
2248 var_field
, option_index
);
2250 BT_LOGW("Cannot select variant field's option field: "
2251 "notit-addr=%p, var-field-addr=%p, "
2252 "opt-index=%" PRId64
, notit
, var_field
,
2258 ret_fc
= selected_option
->fc
;
2265 void set_event_default_clock_value(struct bt_notif_iter
*notit
)
2267 struct bt_private_event
*event
=
2268 bt_private_notification_event_borrow_event(
2269 notit
->event_notif
);
2270 struct bt_stream_class
*sc
= bt_private_stream_class_as_stream_class(
2271 notit
->meta
.sc
->ir_sc
);
2275 if (bt_stream_class_borrow_default_clock_class(sc
)) {
2276 bt_private_event_set_default_clock_value(event
,
2277 notit
->default_clock_val
);
2282 void notify_new_stream(struct bt_notif_iter
*notit
,
2283 struct bt_private_notification
**notification
)
2285 enum bt_notif_iter_status status
;
2286 struct bt_private_notification
*ret
= NULL
;
2288 status
= set_current_stream(notit
);
2289 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2290 BT_OBJECT_PUT_REF_AND_RESET(ret
);
2294 BT_ASSERT(notit
->stream
);
2295 BT_ASSERT(notit
->notif_iter
);
2296 ret
= bt_private_notification_stream_begin_create(notit
->notif_iter
,
2299 BT_LOGE("Cannot create stream beginning notification: "
2300 "notit-addr=%p, stream-addr=%p",
2301 notit
, notit
->stream
);
2306 *notification
= ret
;
2310 void notify_end_of_stream(struct bt_notif_iter
*notit
,
2311 struct bt_private_notification
**notification
)
2313 struct bt_private_notification
*ret
;
2315 if (!notit
->stream
) {
2316 BT_LOGE("Cannot create stream for stream notification: "
2317 "notit-addr=%p", notit
);
2321 BT_ASSERT(notit
->notif_iter
);
2322 ret
= bt_private_notification_stream_end_create(notit
->notif_iter
,
2325 BT_LOGE("Cannot create stream beginning notification: "
2326 "notit-addr=%p, stream-addr=%p",
2327 notit
, notit
->stream
);
2330 *notification
= ret
;
2334 void notify_new_packet(struct bt_notif_iter
*notit
,
2335 struct bt_private_notification
**notification
)
2338 enum bt_notif_iter_status status
;
2339 struct bt_private_notification
*notif
= NULL
;
2340 struct bt_stream_class
*sc
;
2342 status
= set_current_packet(notit
);
2343 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2347 BT_ASSERT(notit
->packet
);
2348 sc
= bt_private_stream_class_as_stream_class(notit
->meta
.sc
->ir_sc
);
2351 if (bt_stream_class_packets_have_discarded_event_counter_snapshot(sc
)) {
2352 BT_ASSERT(notit
->snapshots
.discarded_events
!= UINT64_C(-1));
2353 bt_private_packet_set_discarded_event_counter_snapshot(
2354 notit
->packet
, notit
->snapshots
.discarded_events
);
2357 if (bt_stream_class_packets_have_packet_counter_snapshot(sc
)) {
2358 BT_ASSERT(notit
->snapshots
.packets
!= UINT64_C(-1));
2359 bt_private_packet_set_packet_counter_snapshot(
2360 notit
->packet
, notit
->snapshots
.packets
);
2363 if (bt_stream_class_packets_have_default_beginning_clock_value(sc
)) {
2364 BT_ASSERT(notit
->snapshots
.beginning_clock
!= UINT64_C(-1));
2365 bt_private_packet_set_default_beginning_clock_value(
2366 notit
->packet
, notit
->snapshots
.beginning_clock
);
2369 if (bt_stream_class_packets_have_default_end_clock_value(sc
)) {
2370 BT_ASSERT(notit
->snapshots
.end_clock
!= UINT64_C(-1));
2371 bt_private_packet_set_default_end_clock_value(
2372 notit
->packet
, notit
->snapshots
.end_clock
);
2375 if (notit
->packet_header_field
) {
2376 ret
= bt_private_packet_move_header_field(
2377 notit
->packet
, notit
->packet_header_field
);
2382 notit
->packet_header_field
= NULL
;
2385 * At this point notit->dscopes.trace_packet_header has
2386 * the same value as the packet header field within
2389 BT_ASSERT(bt_private_packet_borrow_header_field(
2391 notit
->dscopes
.trace_packet_header
);
2394 if (notit
->packet_context_field
) {
2395 ret
= bt_private_packet_move_context_field(
2396 notit
->packet
, notit
->packet_context_field
);
2401 notit
->packet_context_field
= NULL
;
2404 * At this point notit->dscopes.trace_packet_header has
2405 * the same value as the packet header field within
2408 BT_ASSERT(bt_private_packet_borrow_context_field(
2410 notit
->dscopes
.stream_packet_context
);
2413 BT_ASSERT(notit
->notif_iter
);
2414 notif
= bt_private_notification_packet_begin_create(notit
->notif_iter
,
2417 BT_LOGE("Cannot create packet beginning notification: "
2418 "notit-addr=%p, packet-addr=%p",
2419 notit
, notit
->packet
);
2423 *notification
= notif
;
2430 void notify_end_of_packet(struct bt_notif_iter
*notit
,
2431 struct bt_private_notification
**notification
)
2433 struct bt_private_notification
*notif
;
2435 if (!notit
->packet
) {
2439 /* Update default clock from packet's end time */
2440 if (notit
->snapshots
.end_clock
!= UINT64_C(-1)) {
2441 notit
->default_clock_val
= notit
->snapshots
.end_clock
;
2444 BT_ASSERT(notit
->notif_iter
);
2445 notif
= bt_private_notification_packet_end_create(notit
->notif_iter
,
2448 BT_LOGE("Cannot create packet end notification: "
2449 "notit-addr=%p, packet-addr=%p",
2450 notit
, notit
->packet
);
2455 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
2456 *notification
= notif
;
2460 struct bt_notif_iter
*bt_notif_iter_create(struct ctf_trace_class
*tc
,
2461 size_t max_request_sz
,
2462 struct bt_notif_iter_medium_ops medops
, void *data
)
2464 struct bt_notif_iter
*notit
= NULL
;
2465 struct bt_bfcr_cbs cbs
= {
2467 .signed_int
= bfcr_signed_int_cb
,
2468 .unsigned_int
= bfcr_unsigned_int_cb
,
2469 .floating_point
= bfcr_floating_point_cb
,
2470 .string_begin
= bfcr_string_begin_cb
,
2471 .string
= bfcr_string_cb
,
2472 .string_end
= bfcr_string_end_cb
,
2473 .compound_begin
= bfcr_compound_begin_cb
,
2474 .compound_end
= bfcr_compound_end_cb
,
2477 .get_sequence_length
= bfcr_get_sequence_length_cb
,
2478 .borrow_variant_selected_field_class
= bfcr_borrow_variant_selected_field_class_cb
,
2483 BT_ASSERT(medops
.request_bytes
);
2484 BT_ASSERT(medops
.borrow_stream
);
2485 BT_LOGD("Creating CTF plugin notification iterator: "
2486 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
2487 "data=%p", tc
, tc
->name
->str
, max_request_sz
, data
);
2488 notit
= g_new0(struct bt_notif_iter
, 1);
2490 BT_LOGE_STR("Failed to allocate one CTF plugin notification iterator.");
2493 notit
->meta
.tc
= tc
;
2494 notit
->medium
.medops
= medops
;
2495 notit
->medium
.max_request_sz
= max_request_sz
;
2496 notit
->medium
.data
= data
;
2497 notit
->stack
= stack_new(notit
);
2498 notit
->stored_values
= g_array_new(FALSE
, TRUE
, sizeof(uint64_t));
2499 g_array_set_size(notit
->stored_values
, tc
->stored_value_count
);
2501 if (!notit
->stack
) {
2502 BT_LOGE_STR("Failed to create field stack.");
2506 notit
->bfcr
= bt_bfcr_create(cbs
, notit
);
2508 BT_LOGE_STR("Failed to create binary class reader (BFCR).");
2512 bt_notif_iter_reset(notit
);
2513 BT_LOGD("Created CTF plugin notification iterator: "
2514 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
2515 "data=%p, notit-addr=%p",
2516 tc
, tc
->name
->str
, max_request_sz
, data
,
2518 notit
->cur_packet_offset
= 0;
2524 bt_notif_iter_destroy(notit
);
2529 void bt_notif_iter_destroy(struct bt_notif_iter
*notit
)
2531 BT_OBJECT_PUT_REF_AND_RESET(notit
->packet
);
2532 BT_OBJECT_PUT_REF_AND_RESET(notit
->stream
);
2533 release_all_dscopes(notit
);
2535 BT_LOGD("Destroying CTF plugin notification iterator: addr=%p", notit
);
2538 BT_LOGD_STR("Destroying field stack.");
2539 stack_destroy(notit
->stack
);
2543 BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit
->bfcr
);
2544 bt_bfcr_destroy(notit
->bfcr
);
2547 if (notit
->stored_values
) {
2548 g_array_free(notit
->stored_values
, TRUE
);
2554 enum bt_notif_iter_status
bt_notif_iter_get_next_notification(
2555 struct bt_notif_iter
*notit
,
2556 struct bt_self_notification_iterator
*notif_iter
,
2557 struct bt_private_notification
**notification
)
2559 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
2562 BT_ASSERT(notification
);
2564 if (notit
->state
== STATE_DONE
) {
2565 status
= BT_NOTIF_ITER_STATUS_EOF
;
2569 notit
->notif_iter
= notif_iter
;
2571 BT_LOGV("Getting next notification: notit-addr=%p", notit
);
2574 status
= handle_state(notit
);
2575 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
2576 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
2580 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2581 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
2582 enum state next_state
= notit
->state
;
2584 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
2586 if (notit
->packet
) {
2587 notify_end_of_packet(notit
,
2590 notify_end_of_stream(notit
,
2592 next_state
= STATE_DONE
;
2595 if (!*notification
) {
2596 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2600 status
= BT_NOTIF_ITER_STATUS_OK
;
2601 notit
->state
= next_state
;
2603 BT_LOGW("Cannot handle state: "
2604 "notit-addr=%p, state=%s",
2605 notit
, state_string(notit
->state
));
2611 switch (notit
->state
) {
2612 case STATE_EMIT_NOTIF_NEW_STREAM
:
2613 /* notify_new_stream() logs errors */
2614 notify_new_stream(notit
, notification
);
2616 if (!*notification
) {
2617 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2620 notit
->stream_begin_emitted
= true;
2622 case STATE_EMIT_NOTIF_NEW_PACKET
:
2623 /* notify_new_packet() logs errors */
2624 notify_new_packet(notit
, notification
);
2626 if (!*notification
) {
2627 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2631 case STATE_EMIT_NOTIF_EVENT
:
2632 BT_ASSERT(notit
->event_notif
);
2633 set_event_default_clock_value(notit
);
2634 *notification
= notit
->event_notif
;
2635 notit
->event_notif
= NULL
;
2637 case STATE_EMIT_NOTIF_END_OF_PACKET
:
2638 /* notify_end_of_packet() logs errors */
2639 notify_end_of_packet(notit
, notification
);
2641 if (!*notification
) {
2642 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2647 /* Non-emitting state: continue */
2657 enum bt_notif_iter_status
bt_notif_iter_borrow_packet_header_context_fields(
2658 struct bt_notif_iter
*notit
,
2659 struct bt_private_field
**packet_header_field
,
2660 struct bt_private_field
**packet_context_field
)
2663 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
2667 if (notit
->state
== STATE_EMIT_NOTIF_NEW_PACKET
) {
2668 /* We're already there */
2673 status
= handle_state(notit
);
2674 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
2675 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
2678 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
2679 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
2680 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
2682 BT_LOGW("Cannot handle state: "
2683 "notit-addr=%p, state=%s",
2684 notit
, state_string(notit
->state
));
2689 switch (notit
->state
) {
2690 case STATE_EMIT_NOTIF_NEW_PACKET
:
2692 * Packet header and context fields are
2693 * potentially decoded (or they don't exist).
2697 case STATE_EMIT_NOTIF_NEW_STREAM
:
2698 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
2699 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
2700 case STATE_AFTER_TRACE_PACKET_HEADER
:
2701 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
2702 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
2703 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
2704 /* Non-emitting state: continue */
2708 * We should never get past the
2709 * STATE_EMIT_NOTIF_NEW_PACKET state.
2711 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
2712 notit
, state_string(notit
->state
));
2718 ret
= set_current_packet_content_sizes(notit
);
2720 status
= BT_NOTIF_ITER_STATUS_ERROR
;
2724 if (packet_header_field
) {
2725 *packet_header_field
= notit
->dscopes
.trace_packet_header
;
2728 if (packet_context_field
) {
2729 *packet_context_field
= notit
->dscopes
.stream_packet_context
;
2737 void bt_notif_iter_set_medops_data(struct bt_notif_iter
*notit
,
2741 notit
->medium
.data
= medops_data
;
2745 enum bt_notif_iter_status
bt_notif_iter_seek(
2746 struct bt_notif_iter
*notit
, off_t offset
)
2748 enum bt_notif_iter_status ret
= BT_NOTIF_ITER_STATUS_OK
;
2749 enum bt_notif_iter_medium_status medium_status
;
2753 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset
);
2754 ret
= BT_NOTIF_ITER_STATUS_INVAL
;
2758 if (!notit
->medium
.medops
.seek
) {
2759 ret
= BT_NOTIF_ITER_STATUS_UNSUPPORTED
;
2760 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2764 medium_status
= notit
->medium
.medops
.seek(
2765 BT_NOTIF_ITER_SEEK_WHENCE_SET
, offset
, notit
->medium
.data
);
2766 if (medium_status
!= BT_NOTIF_ITER_MEDIUM_STATUS_OK
) {
2767 if (medium_status
== BT_NOTIF_ITER_MEDIUM_STATUS_EOF
) {
2768 ret
= BT_NOTIF_ITER_STATUS_EOF
;
2770 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
2775 bt_notif_iter_reset(notit
);
2776 notit
->cur_packet_offset
= offset
;
2783 off_t
bt_notif_iter_get_current_packet_offset(struct bt_notif_iter
*notit
)
2786 return notit
->cur_packet_offset
;
2790 off_t
bt_notif_iter_get_current_packet_size(
2791 struct bt_notif_iter
*notit
)
2794 return notit
->cur_exp_packet_total_size
;
2798 void bt_notif_trace_class_changed(struct bt_notif_iter
*notit
)
2800 if (notit
->meta
.tc
->stored_value_count
> notit
->stored_values
->len
) {
2801 g_array_set_size(notit
->stored_values
,
2802 notit
->meta
.tc
->stored_value_count
);
2807 enum bt_notif_iter_status
bt_notif_iter_get_packet_properties(
2808 struct bt_notif_iter
*notit
,
2809 struct bt_notif_iter_packet_properties
*props
)
2814 props
->exp_packet_total_size
=
2815 (uint64_t) notit
->cur_exp_packet_total_size
;
2816 props
->exp_packet_content_size
=
2817 (uint64_t) notit
->cur_exp_packet_content_size
;
2818 BT_ASSERT(props
->stream_class_id
>= 0);
2819 props
->stream_class_id
= (uint64_t) notit
->cur_stream_class_id
;
2820 props
->data_stream_id
= notit
->cur_data_stream_id
;
2821 props
->snapshots
.discarded_events
= notit
->snapshots
.discarded_events
;
2822 props
->snapshots
.packets
= notit
->snapshots
.packets
;
2823 props
->snapshots
.beginning_clock
= notit
->snapshots
.beginning_clock
;
2824 props
->snapshots
.end_clock
= notit
->snapshots
.end_clock
;
2825 return BT_NOTIF_ITER_STATUS_OK
;