2 * Babeltrace - CTF notification iterator
4 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015-2016 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
33 #include <babeltrace/ctf-ir/field-types.h>
34 #include <babeltrace/ctf-ir/field-path.h>
35 #include <babeltrace/ctf-ir/fields.h>
36 #include <babeltrace/ctf-ir/stream-class.h>
37 #include <babeltrace/ctf-ir/packet.h>
38 #include <babeltrace/ctf-ir/stream.h>
39 #include <babeltrace/ctf-ir/clock.h>
40 #include <babeltrace/ctf-ir/event-class.h>
41 #include <babeltrace/plugin/notification/packet.h>
42 #include <babeltrace/plugin/notification/event.h>
43 #include <babeltrace/ref.h>
46 #define PRINT_ERR_STREAM notit->err_stream
47 #define PRINT_PREFIX "ctf-notif-iter"
50 #include "notif-iter.h"
51 #include "../btr/btr.h"
53 #define BYTES_TO_BITS(x) ((x) * 8)
55 struct bt_ctf_notif_iter
;
57 /* A visit stack entry */
60 * Current base field, one of:
68 * Field is owned by this.
70 struct bt_ctf_field
*base
;
72 /* index of next field to set */
78 /* Entries (struct stack_entry *) (top is last element) */
85 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
86 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
87 STATE_AFTER_TRACE_PACKET_HEADER
,
88 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
89 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
90 STATE_AFTER_STREAM_PACKET_CONTEXT
,
91 STATE_EMIT_NOTIF_NEW_PACKET
,
92 STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
,
93 STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
,
94 STATE_AFTER_STREAM_EVENT_HEADER
,
95 STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
,
96 STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
,
97 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
,
98 STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
,
99 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
100 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
101 STATE_EMIT_NOTIF_EVENT
,
102 STATE_EMIT_NOTIF_END_OF_PACKET
,
103 STATE_SKIP_PACKET_PADDING
,
106 /* CTF notification iterator */
107 struct bt_ctf_notif_iter
{
111 /* Error stream (may be NULL) */
115 * Current dynamic scope field pointer.
117 * This is set when a dynamic scope field is first created by
118 * btr_compound_begin_cb(). It points to one of the fields in
121 struct bt_ctf_field
**cur_dscope_field
;
123 /* Trace and classes (owned by this) */
125 struct bt_ctf_trace
*trace
;
126 struct bt_ctf_stream_class
*stream_class
;
127 struct bt_ctf_event_class
*event_class
;
130 /* Current packet (NULL if not created yet) */
131 struct bt_ctf_packet
*packet
;
133 /* Database of current dynamic scopes (owned by this) */
135 struct bt_ctf_field
*trace_packet_header
;
136 struct bt_ctf_field
*stream_packet_context
;
137 struct bt_ctf_field
*stream_event_header
;
138 struct bt_ctf_field
*stream_event_context
;
139 struct bt_ctf_field
*event_context
;
140 struct bt_ctf_field
*event_payload
;
146 /* Current medium buffer data */
148 /* Last address provided by medium */
151 /* Buffer size provided by medium (bytes) */
154 /* Offset within whole packet of addr (bits) */
155 size_t packet_offset
;
157 /* Current position from addr (bits) */
161 /* Binary type reader */
162 struct bt_ctf_btr
*btr
;
164 /* Current medium data */
166 struct bt_ctf_notif_iter_medium_ops medops
;
167 size_t max_request_sz
;
171 /* Current packet size (bits) (-1 if unknown) */
172 int64_t cur_packet_size
;
174 /* Current content size (bits) (-1 if unknown) */
175 int64_t cur_content_size
;
179 int bt_ctf_notif_iter_switch_packet(struct bt_ctf_notif_iter
*notit
);
182 void stack_entry_free_func(gpointer data
)
184 struct stack_entry
*entry
= data
;
191 struct stack
*stack_new(struct bt_ctf_notif_iter
*notit
)
193 struct stack
*stack
= NULL
;
195 stack
= g_new0(struct stack
, 1);
200 stack
->entries
= g_ptr_array_new_with_free_func(stack_entry_free_func
);
201 if (!stack
->entries
) {
212 void stack_destroy(struct stack
*stack
)
215 g_ptr_array_free(stack
->entries
, TRUE
);
220 int stack_push(struct stack
*stack
, struct bt_ctf_field
*base
)
223 struct stack_entry
*entry
;
227 entry
= g_new0(struct stack_entry
, 1);
233 entry
->base
= bt_get(base
);
234 g_ptr_array_add(stack
->entries
, entry
);
241 unsigned int stack_size(struct stack
*stack
)
245 return stack
->entries
->len
;
249 void stack_pop(struct stack
*stack
)
252 assert(stack_size(stack
));
253 g_ptr_array_remove_index(stack
->entries
, stack
->entries
->len
- 1);
257 struct stack_entry
*stack_top(struct stack
*stack
)
260 assert(stack_size(stack
));
262 return g_ptr_array_index(stack
->entries
, stack
->entries
->len
- 1);
266 bool stack_empty(struct stack
*stack
)
268 return stack_size(stack
) == 0;
272 void stack_clear(struct stack
*stack
)
276 if (!stack_empty(stack
)) {
277 g_ptr_array_remove_range(stack
->entries
, 0, stack_size(stack
));
280 assert(stack_empty(stack
));
284 enum bt_ctf_notif_iter_status
notif_iter_status_from_m_status(
285 enum bt_ctf_notif_iter_medium_status m_status
)
291 size_t buf_size_bits(struct bt_ctf_notif_iter
*notit
)
293 return BYTES_TO_BITS(notit
->buf
.sz
);
297 size_t buf_available_bits(struct bt_ctf_notif_iter
*notit
)
299 return buf_size_bits(notit
) - notit
->buf
.at
;
303 size_t packet_at(struct bt_ctf_notif_iter
*notit
)
305 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
309 size_t remaining_content_bits(struct bt_ctf_notif_iter
*notit
)
311 if (notit
->cur_content_size
== -1) {
315 return notit
->cur_content_size
- packet_at(notit
);
319 size_t remaining_packet_bits(struct bt_ctf_notif_iter
*notit
)
321 if (notit
->cur_packet_size
== -1) {
325 return notit
->cur_packet_size
- packet_at(notit
);
329 void buf_consume_bits(struct bt_ctf_notif_iter
*notit
, size_t incr
)
331 notit
->buf
.at
+= incr
;
335 bool buf_has_enough_bits(struct bt_ctf_notif_iter
*notit
, size_t sz
)
337 return buf_available_bits(notit
) >= sz
;
341 enum bt_ctf_notif_iter_status
request_medium_bytes(
342 struct bt_ctf_notif_iter
*notit
)
344 uint8_t *buffer_addr
;
346 enum bt_ctf_notif_iter_medium_status m_status
;
348 m_status
= notit
->medium
.medops
.request_bytes(
349 notit
->medium
.max_request_sz
, &buffer_addr
,
350 &buffer_sz
, notit
->medium
.data
);
351 if (m_status
== BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
) {
352 assert(buffer_sz
!= 0);
354 /* New packet offset is old one + old size (in bits) */
355 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
357 /* Restart at the beginning of the new medium buffer */
360 /* New medium buffer size */
361 notit
->buf
.sz
= buffer_sz
;
363 /* New medium buffer address */
364 notit
->buf
.addr
= buffer_addr
;
367 return notif_iter_status_from_m_status(m_status
);
371 enum bt_ctf_notif_iter_status
buf_ensure_available_bits(
372 struct bt_ctf_notif_iter
*notit
)
374 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
376 if (buf_available_bits(notit
) == 0) {
378 * This _cannot_ return BT_CTF_NOTIF_ITER_STATUS_OK
381 status
= request_medium_bytes(notit
);
388 enum bt_ctf_notif_iter_status
read_dscope_begin_state(
389 struct bt_ctf_notif_iter
*notit
,
390 struct bt_ctf_field_type
*dscope_field_type
,
391 enum state done_state
, enum state continue_state
,
392 struct bt_ctf_field
**dscope_field
)
394 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
395 enum bt_ctf_btr_status btr_status
;
396 size_t consumed_bits
;
398 status
= buf_ensure_available_bits(notit
);
399 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
403 bt_put(*dscope_field
);
404 notit
->cur_dscope_field
= dscope_field
;
405 consumed_bits
= bt_ctf_btr_start(notit
->btr
, dscope_field_type
,
406 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
407 notit
->buf
.sz
, &btr_status
);
409 switch (btr_status
) {
410 case BT_CTF_BTR_STATUS_OK
:
411 /* type was read completely */
412 notit
->state
= done_state
;
414 case BT_CTF_BTR_STATUS_EOF
:
415 notit
->state
= continue_state
;
418 PERR("Binary type reader failed to start\n");
419 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
423 /* Consume bits now since we know we're not in an error state */
424 buf_consume_bits(notit
, consumed_bits
);
431 enum bt_ctf_notif_iter_status
read_dscope_continue_state(
432 struct bt_ctf_notif_iter
*notit
, enum state done_state
)
434 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
435 enum bt_ctf_btr_status btr_status
;
436 size_t consumed_bits
;
438 status
= buf_ensure_available_bits(notit
);
439 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
443 consumed_bits
= bt_ctf_btr_continue(notit
->btr
, notit
->buf
.addr
,
444 notit
->buf
.sz
, &btr_status
);
446 switch (btr_status
) {
447 case BT_CTF_BTR_STATUS_OK
:
448 /* Type was read completely. */
449 notit
->state
= done_state
;
451 case BT_CTF_BTR_STATUS_EOF
:
452 /* Stay in this continue state. */
455 PERR("Binary type reader failed to continue\n");
456 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
460 /* Consume bits now since we know we're not in an error state. */
461 buf_consume_bits(notit
, consumed_bits
);
467 void put_event_dscopes(struct bt_ctf_notif_iter
*notit
)
469 BT_PUT(notit
->dscopes
.stream_event_header
);
470 BT_PUT(notit
->dscopes
.stream_event_context
);
471 BT_PUT(notit
->dscopes
.event_context
);
472 BT_PUT(notit
->dscopes
.event_payload
);
476 void put_all_dscopes(struct bt_ctf_notif_iter
*notit
)
478 BT_PUT(notit
->dscopes
.trace_packet_header
);
479 BT_PUT(notit
->dscopes
.stream_packet_context
);
480 put_event_dscopes(notit
);
484 enum bt_ctf_notif_iter_status
read_packet_header_begin_state(
485 struct bt_ctf_notif_iter
*notit
)
487 struct bt_ctf_field_type
*packet_header_type
= NULL
;
488 enum bt_ctf_notif_iter_status ret
= BT_CTF_NOTIF_ITER_STATUS_OK
;
490 if (bt_ctf_notif_iter_switch_packet(notit
)) {
491 ret
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
495 /* Packet header type is common to the whole trace. */
496 packet_header_type
= bt_ctf_trace_get_packet_header_type(
498 if (!packet_header_type
) {
499 PERR("Failed to retrieve trace's packet header type\n");
500 ret
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
504 ret
= read_dscope_begin_state(notit
, packet_header_type
,
505 STATE_AFTER_TRACE_PACKET_HEADER
,
506 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
507 ¬it
->dscopes
.trace_packet_header
);
509 BT_PUT(packet_header_type
);
514 enum bt_ctf_notif_iter_status
read_packet_header_continue_state(
515 struct bt_ctf_notif_iter
*notit
)
517 return read_dscope_continue_state(notit
,
518 STATE_AFTER_TRACE_PACKET_HEADER
);
522 bool is_struct_type(struct bt_ctf_field_type
*field_type
)
524 return bt_ctf_field_type_get_type_id(field_type
) ==
525 BT_CTF_TYPE_ID_STRUCT
;
529 bool is_variant_type(struct bt_ctf_field_type
*field_type
)
531 return bt_ctf_field_type_get_type_id(field_type
) ==
532 BT_CTF_TYPE_ID_VARIANT
;
536 enum bt_ctf_notif_iter_status
set_current_stream_class(struct bt_ctf_notif_iter
*notit
)
538 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
539 struct bt_ctf_field_type
*packet_header_type
;
540 struct bt_ctf_field_type
*stream_id_field_type
= NULL
;
543 /* Is there any "stream_id" field in the packet header? */
544 packet_header_type
= bt_ctf_trace_get_packet_header_type(
546 if (!packet_header_type
) {
547 PERR("Failed to retrieve trace's packet header type\n");
548 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
552 assert(is_struct_type(packet_header_type
));
555 stream_id_field_type
=
556 bt_ctf_field_type_structure_get_field_type_by_name(
557 packet_header_type
, "stream_id");
558 if (stream_id_field_type
) {
559 /* Find appropriate stream class using current stream ID */
560 struct bt_ctf_field
*stream_id_field
= NULL
;
563 assert(notit
->dscopes
.trace_packet_header
);
566 stream_id_field
= bt_ctf_field_structure_get_field(
567 notit
->dscopes
.trace_packet_header
, "stream_id");
568 assert(stream_id_field
);
569 ret
= bt_ctf_field_unsigned_integer_get_value(
570 stream_id_field
, &stream_id
);
572 BT_PUT(stream_id_field
);
574 /* Only one stream: pick the first stream class */
575 assert(bt_ctf_trace_get_stream_class_count(
576 notit
->meta
.trace
) == 1);
580 BT_PUT(notit
->meta
.stream_class
);
583 notit
->meta
.stream_class
= bt_ctf_trace_get_stream_class(
584 notit
->meta
.trace
, stream_id
);
585 if (!notit
->meta
.stream_class
) {
586 PERR("Cannot find stream class with ID %" PRIu64
"\n",
588 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
593 BT_PUT(packet_header_type
);
594 BT_PUT(stream_id_field_type
);
600 enum bt_ctf_notif_iter_status
after_packet_header_state(
601 struct bt_ctf_notif_iter
*notit
)
603 enum bt_ctf_notif_iter_status status
;
605 status
= set_current_stream_class(notit
);
606 if (status
== BT_CTF_NOTIF_ITER_STATUS_OK
) {
607 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
614 enum bt_ctf_notif_iter_status
read_packet_context_begin_state(
615 struct bt_ctf_notif_iter
*notit
)
617 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
618 struct bt_ctf_field_type
*packet_context_type
;
620 assert(notit
->meta
.stream_class
);
621 packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
622 notit
->meta
.stream_class
);
623 if (!packet_context_type
) {
624 PERR("Failed to retrieve stream class's packet context\n");
625 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
629 status
= read_dscope_begin_state(notit
, packet_context_type
,
630 STATE_AFTER_STREAM_PACKET_CONTEXT
,
631 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
632 ¬it
->dscopes
.stream_packet_context
);
635 BT_PUT(packet_context_type
);
640 enum bt_ctf_notif_iter_status
read_packet_context_continue_state(
641 struct bt_ctf_notif_iter
*notit
)
643 return read_dscope_continue_state(notit
,
644 STATE_AFTER_STREAM_PACKET_CONTEXT
);
648 enum bt_ctf_notif_iter_status
set_current_packet_content_sizes(
649 struct bt_ctf_notif_iter
*notit
)
651 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
652 struct bt_ctf_field
*packet_size_field
= NULL
;
653 struct bt_ctf_field
*content_size_field
= NULL
;
654 uint64_t content_size
= -1, packet_size
= -1;
656 assert(notit
->dscopes
.stream_packet_context
);
658 packet_size_field
= bt_ctf_field_structure_get_field(
659 notit
->dscopes
.stream_packet_context
, "packet_size");
660 content_size_field
= bt_ctf_field_structure_get_field(
661 notit
->dscopes
.stream_packet_context
, "content_size");
662 if (packet_size_field
) {
663 int ret
= bt_ctf_field_unsigned_integer_get_value(
664 packet_size_field
, &packet_size
);
667 if (packet_size
== 0) {
668 PERR("Decoded packet size is 0\n");
669 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
671 } else if ((packet_size
% 8) != 0) {
672 PERR("Decoded packet size is not a multiple of 8\n");
673 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
678 if (content_size_field
) {
679 int ret
= bt_ctf_field_unsigned_integer_get_value(
680 content_size_field
, &content_size
);
684 content_size
= packet_size
;
687 notit
->cur_packet_size
= packet_size
;
688 notit
->cur_content_size
= content_size
;
690 BT_PUT(packet_size_field
);
691 BT_PUT(content_size_field
);
696 enum bt_ctf_notif_iter_status
after_packet_context_state(
697 struct bt_ctf_notif_iter
*notit
)
699 enum bt_ctf_notif_iter_status status
;
701 status
= set_current_packet_content_sizes(notit
);
702 if (status
== BT_CTF_NOTIF_ITER_STATUS_OK
) {
703 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
710 enum bt_ctf_notif_iter_status
read_event_header_begin_state(
711 struct bt_ctf_notif_iter
*notit
)
713 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
714 struct bt_ctf_field_type
*event_header_type
= NULL
;
716 /* Check if we have some content left */
717 if (notit
->cur_content_size
>= 0) {
718 if (packet_at(notit
) == notit
->cur_content_size
) {
719 /* No more events! */
720 notit
->state
= STATE_EMIT_NOTIF_END_OF_PACKET
;
722 } else if (packet_at(notit
) > notit
->cur_content_size
) {
723 /* That's not supposed to happen */
724 PERR("Cursor passed packet's content size:\n");
725 PERR("\tDecoded content size: %zu\n",
726 notit
->cur_content_size
);
727 PERR("\tCursor position: %zu\n", packet_at(notit
));
728 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
733 event_header_type
= bt_ctf_stream_class_get_event_header_type(
734 notit
->meta
.stream_class
);
735 if (!event_header_type
) {
736 PERR("Failed to retrieve stream class's event header type\n");
737 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
741 put_event_dscopes(notit
);
742 status
= read_dscope_begin_state(notit
, event_header_type
,
743 STATE_AFTER_STREAM_EVENT_HEADER
,
744 STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
,
745 ¬it
->dscopes
.stream_event_header
);
747 BT_PUT(event_header_type
);
753 enum bt_ctf_notif_iter_status
read_event_header_continue_state(
754 struct bt_ctf_notif_iter
*notit
)
756 return read_dscope_continue_state(notit
,
757 STATE_AFTER_STREAM_EVENT_HEADER
);
761 enum bt_ctf_notif_iter_status
set_current_event_class(struct bt_ctf_notif_iter
*notit
)
764 * The assert() calls in this function are okay because it is
765 * assumed here that all the metadata objects have been
766 * validated for CTF correctness before decoding actual streams.
769 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
770 struct bt_ctf_field_type
*event_header_type
;
771 struct bt_ctf_field_type
*id_field_type
= NULL
;
772 struct bt_ctf_field_type
*v_field_type
= NULL
;
773 uint64_t event_id
= -1ULL;
776 event_header_type
= bt_ctf_stream_class_get_event_header_type(
777 notit
->meta
.stream_class
);
778 if (!event_header_type
) {
779 PERR("Failed to retrieve stream class's event header type\n");
780 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
784 /* Is there any "id"/"v" field in the event header? */
785 assert(is_struct_type(event_header_type
));
786 id_field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
787 event_header_type
, "id");
788 v_field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
789 event_header_type
, "v");
790 assert(notit
->dscopes
.stream_event_header
);
794 * | | |_ _|_ _| __ __ _
795 * | | | | | || '_ \ / _` |
796 * | |___| | | || | | | (_| | S P E C I A L
797 * |_____|_| |_||_| |_|\__, | C A S E â„¢
800 struct bt_ctf_field
*v_field
= NULL
;
801 struct bt_ctf_field
*v_struct_field
= NULL
;
802 struct bt_ctf_field
*v_struct_id_field
= NULL
;
805 v_field
= bt_ctf_field_structure_get_field(
806 notit
->dscopes
.stream_event_header
, "v");
810 bt_ctf_field_variant_get_current_field(v_field
);
811 if (!v_struct_field
) {
812 goto end_v_field_type
;
817 bt_ctf_field_structure_get_field(v_struct_field
, "id");
818 if (!v_struct_id_field
) {
819 goto end_v_field_type
;
822 ret
= bt_ctf_field_unsigned_integer_get_value(
823 v_struct_id_field
, &event_id
);
830 BT_PUT(v_struct_field
);
831 BT_PUT(v_struct_id_field
);
834 if (id_field_type
&& event_id
== -1ULL) {
835 /* Check "id" field */
836 struct bt_ctf_field
*id_field
= NULL
;
840 id_field
= bt_ctf_field_structure_get_field(
841 notit
->dscopes
.stream_event_header
, "id");
843 assert(bt_ctf_field_is_integer(id_field
) ||
844 bt_ctf_field_is_enumeration(id_field
));
846 if (bt_ctf_field_is_integer(id_field
)) {
847 ret
= bt_ctf_field_unsigned_integer_get_value(
848 id_field
, &event_id
);
850 struct bt_ctf_field
*container
;
852 container
= bt_ctf_field_enumeration_get_container(
855 ret
= bt_ctf_field_unsigned_integer_get_value(
856 container
, &event_id
);
863 if (event_id
== -1ULL) {
864 /* Event ID not found: single event? */
865 assert(bt_ctf_stream_class_get_event_class_count(
866 notit
->meta
.stream_class
) == 1);
870 BT_PUT(notit
->meta
.event_class
);
871 notit
->meta
.event_class
= bt_ctf_stream_class_get_event_class_by_id(
872 notit
->meta
.stream_class
, event_id
);
873 if (!notit
->meta
.event_class
) {
874 PERR("Cannot find event class with ID %" PRIu64
"\n", event_id
);
875 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
880 BT_PUT(event_header_type
);
881 BT_PUT(id_field_type
);
882 BT_PUT(v_field_type
);
888 enum bt_ctf_notif_iter_status
after_event_header_state(
889 struct bt_ctf_notif_iter
*notit
)
891 enum bt_ctf_notif_iter_status status
;
893 status
= set_current_packet_content_sizes(notit
);
894 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
895 PERR("Failed to set current packet and content sizes\n");
899 status
= set_current_event_class(notit
);
900 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
901 PERR("Failed to set current event class\n");
905 notit
->state
= STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
;
912 enum bt_ctf_notif_iter_status
read_stream_event_context_begin_state(
913 struct bt_ctf_notif_iter
*notit
)
915 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
916 struct bt_ctf_field_type
*stream_event_context_type
;
918 stream_event_context_type
= bt_ctf_stream_class_get_event_context_type(
919 notit
->meta
.stream_class
);
920 if (!stream_event_context_type
) {
921 PERR("Failed to retrieve stream class's event context type\n");
922 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
926 status
= read_dscope_begin_state(notit
, stream_event_context_type
,
927 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
,
928 STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
,
929 ¬it
->dscopes
.stream_event_context
);
932 BT_PUT(stream_event_context_type
);
938 enum bt_ctf_notif_iter_status
read_stream_event_context_continue_state(
939 struct bt_ctf_notif_iter
*notit
)
941 return read_dscope_continue_state(notit
,
942 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
);
946 enum bt_ctf_notif_iter_status
read_event_context_begin_state(
947 struct bt_ctf_notif_iter
*notit
)
949 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
950 struct bt_ctf_field_type
*event_context_type
;
952 event_context_type
= bt_ctf_event_class_get_context_type(
953 notit
->meta
.event_class
);
954 if (!event_context_type
) {
955 PERR("Failed to retrieve event class's context type\n");
956 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
960 status
= read_dscope_begin_state(notit
, event_context_type
,
961 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
962 STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
,
963 ¬it
->dscopes
.event_context
);
966 BT_PUT(event_context_type
);
972 enum bt_ctf_notif_iter_status
read_event_context_continue_state(
973 struct bt_ctf_notif_iter
*notit
)
975 return read_dscope_continue_state(notit
,
976 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
980 enum bt_ctf_notif_iter_status
read_event_payload_begin_state(
981 struct bt_ctf_notif_iter
*notit
)
983 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
984 struct bt_ctf_field_type
*event_payload_type
;
986 event_payload_type
= bt_ctf_event_class_get_payload_type(
987 notit
->meta
.event_class
);
988 if (!event_payload_type
) {
989 PERR("Failed to retrieve event class's payload type\n");
990 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
994 status
= read_dscope_begin_state(notit
, event_payload_type
,
995 STATE_EMIT_NOTIF_EVENT
,
996 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
997 ¬it
->dscopes
.event_payload
);
1000 BT_PUT(event_payload_type
);
1006 enum bt_ctf_notif_iter_status
read_event_payload_continue_state(
1007 struct bt_ctf_notif_iter
*notit
)
1009 return read_dscope_continue_state(notit
, STATE_EMIT_NOTIF_EVENT
);
1013 enum bt_ctf_notif_iter_status
skip_packet_padding_state(
1014 struct bt_ctf_notif_iter
*notit
)
1016 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
1017 size_t bits_to_skip
;
1019 assert(notit
->cur_packet_size
> 0);
1020 bits_to_skip
= notit
->cur_packet_size
- packet_at(notit
);
1021 if (bits_to_skip
== 0) {
1022 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1025 size_t bits_to_consume
;
1026 status
= buf_ensure_available_bits(notit
);
1027 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
1031 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1032 buf_consume_bits(notit
, bits_to_consume
);
1033 bits_to_skip
= notit
->cur_packet_size
- packet_at(notit
);
1034 if (bits_to_skip
== 0) {
1035 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1045 enum bt_ctf_notif_iter_status
handle_state(struct bt_ctf_notif_iter
*notit
)
1047 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
1049 PDBG("Handling state %d\n", notit
->state
);
1051 // TODO: optimalize!
1052 switch (notit
->state
) {
1054 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1056 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1057 status
= read_packet_header_begin_state(notit
);
1059 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1060 status
= read_packet_header_continue_state(notit
);
1062 case STATE_AFTER_TRACE_PACKET_HEADER
:
1063 status
= after_packet_header_state(notit
);
1065 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1066 status
= read_packet_context_begin_state(notit
);
1068 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1069 status
= read_packet_context_continue_state(notit
);
1071 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1072 status
= after_packet_context_state(notit
);
1074 case STATE_EMIT_NOTIF_NEW_PACKET
:
1075 notit
->state
= STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
;
1077 case STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
:
1078 status
= read_event_header_begin_state(notit
);
1080 case STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
:
1081 status
= read_event_header_continue_state(notit
);
1083 case STATE_AFTER_STREAM_EVENT_HEADER
:
1084 status
= after_event_header_state(notit
);
1086 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
:
1087 status
= read_stream_event_context_begin_state(notit
);
1089 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
:
1090 status
= read_stream_event_context_continue_state(notit
);
1092 case STATE_DSCOPE_EVENT_CONTEXT_BEGIN
:
1093 status
= read_event_context_begin_state(notit
);
1095 case STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
:
1096 status
= read_event_context_continue_state(notit
);
1098 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1099 status
= read_event_payload_begin_state(notit
);
1101 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1102 status
= read_event_payload_continue_state(notit
);
1104 case STATE_EMIT_NOTIF_EVENT
:
1105 notit
->state
= STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
;
1107 case STATE_SKIP_PACKET_PADDING
:
1108 status
= skip_packet_padding_state(notit
);
1110 case STATE_EMIT_NOTIF_END_OF_PACKET
:
1111 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1120 * Resets the internal state of a CTF notification iterator.
1122 * This function can be used when it is desired to seek to the beginning
1123 * of another packet. It is expected that the next call to
1124 * bt_ctf_notif_iter_medium_ops::request_bytes() made by this
1125 * notification iterator will return the \em first bytes of a \em
1128 * @param notif_iter CTF notification iterator
1131 void bt_ctf_notif_iter_reset(struct bt_ctf_notif_iter
*notit
)
1134 stack_clear(notit
->stack
);
1135 BT_PUT(notit
->meta
.stream_class
);
1136 BT_PUT(notit
->meta
.event_class
);
1137 BT_PUT(notit
->packet
);
1138 put_all_dscopes(notit
);
1139 notit
->buf
.addr
= NULL
;
1142 notit
->buf
.packet_offset
= 0;
1143 notit
->state
= STATE_INIT
;
1144 notit
->cur_content_size
= -1;
1145 notit
->cur_packet_size
= -1;
1149 int bt_ctf_notif_iter_switch_packet(struct bt_ctf_notif_iter
*notit
)
1154 stack_clear(notit
->stack
);
1155 BT_PUT(notit
->meta
.stream_class
);
1156 BT_PUT(notit
->meta
.event_class
);
1157 BT_PUT(notit
->packet
);
1158 put_all_dscopes(notit
);
1161 * Adjust current buffer so that addr points to the beginning of the new
1164 if (notit
->buf
.addr
) {
1165 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1167 /* Packets are assumed to start on a byte frontier. */
1168 if (notit
->buf
.at
% CHAR_BIT
) {
1173 notit
->buf
.addr
+= consumed_bytes
;
1174 notit
->buf
.sz
-= consumed_bytes
;
1176 notit
->buf
.packet_offset
= 0;
1179 notit
->cur_content_size
= -1;
1180 notit
->cur_packet_size
= -1;
1186 struct bt_ctf_field
*get_next_field(struct bt_ctf_notif_iter
*notit
)
1188 struct bt_ctf_field
*next_field
= NULL
;
1189 struct bt_ctf_field
*base_field
;
1190 struct bt_ctf_field_type
*base_type
;
1193 assert(!stack_empty(notit
->stack
));
1194 index
= stack_top(notit
->stack
)->index
;
1195 base_field
= stack_top(notit
->stack
)->base
;
1196 base_type
= bt_ctf_field_get_type(base_field
);
1198 PERR("Failed to get base field's type\n");
1202 switch (bt_ctf_field_type_get_type_id(base_type
)) {
1203 case BT_CTF_TYPE_ID_STRUCT
:
1204 next_field
= bt_ctf_field_structure_get_field_by_index(
1207 case BT_CTF_TYPE_ID_ARRAY
:
1208 next_field
= bt_ctf_field_array_get_field(base_field
, index
);
1210 case BT_CTF_TYPE_ID_SEQUENCE
:
1211 next_field
= bt_ctf_field_sequence_get_field(base_field
, index
);
1213 case BT_CTF_TYPE_ID_VARIANT
:
1214 next_field
= bt_ctf_field_variant_get_current_field(base_field
);
1232 enum bt_ctf_btr_status
btr_signed_int_cb(int64_t value
,
1233 struct bt_ctf_field_type
*type
, void *data
)
1235 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1236 struct bt_ctf_field
*field
= NULL
;
1237 struct bt_ctf_field
*int_field
= NULL
;
1238 struct bt_ctf_notif_iter
*notit
= data
;
1241 /* create next field */
1242 field
= get_next_field(notit
);
1244 PERR("Failed to get next field (signed int)\n");
1245 status
= BT_CTF_BTR_STATUS_ERROR
;
1249 switch(bt_ctf_field_type_get_type_id(type
)) {
1250 case BT_CTF_TYPE_ID_INTEGER
:
1251 /* Integer field is created field */
1252 BT_MOVE(int_field
, field
);
1254 case BT_CTF_TYPE_ID_ENUM
:
1255 int_field
= bt_ctf_field_enumeration_get_container(field
);
1262 PERR("Failed to get integer field\n");
1263 status
= BT_CTF_BTR_STATUS_ERROR
;
1267 ret
= bt_ctf_field_signed_integer_set_value(int_field
, value
);
1269 stack_top(notit
->stack
)->index
++;
1279 enum bt_ctf_btr_status
btr_unsigned_int_cb(uint64_t value
,
1280 struct bt_ctf_field_type
*type
, void *data
)
1282 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1283 struct bt_ctf_field
*field
= NULL
;
1284 struct bt_ctf_field
*int_field
= NULL
;
1285 struct bt_ctf_notif_iter
*notit
= data
;
1288 /* Create next field */
1289 field
= get_next_field(notit
);
1291 PERR("Failed to get next field (unsigned int)\n");
1292 status
= BT_CTF_BTR_STATUS_ERROR
;
1296 switch(bt_ctf_field_type_get_type_id(type
)) {
1297 case BT_CTF_TYPE_ID_INTEGER
:
1298 /* Integer field is created field */
1299 BT_MOVE(int_field
, field
);
1301 case BT_CTF_TYPE_ID_ENUM
:
1302 int_field
= bt_ctf_field_enumeration_get_container(field
);
1309 PERR("Failed to get integer field\n");
1310 status
= BT_CTF_BTR_STATUS_ERROR
;
1314 ret
= bt_ctf_field_unsigned_integer_set_value(int_field
, value
);
1316 stack_top(notit
->stack
)->index
++;
1326 enum bt_ctf_btr_status
btr_floating_point_cb(double value
,
1327 struct bt_ctf_field_type
*type
, void *data
)
1329 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1330 struct bt_ctf_field
*field
= NULL
;
1331 struct bt_ctf_notif_iter
*notit
= data
;
1334 /* Create next field */
1335 field
= get_next_field(notit
);
1337 PERR("Failed to get next field (floating point number)\n");
1338 status
= BT_CTF_BTR_STATUS_ERROR
;
1342 ret
= bt_ctf_field_floating_point_set_value(field
, value
);
1344 stack_top(notit
->stack
)->index
++;
1353 enum bt_ctf_btr_status
btr_string_begin_cb(
1354 struct bt_ctf_field_type
*type
, void *data
)
1356 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1357 struct bt_ctf_field
*field
= NULL
;
1358 struct bt_ctf_notif_iter
*notit
= data
;
1361 /* Create next field */
1362 field
= get_next_field(notit
);
1364 PERR("Failed to get next field (string)\n");
1365 status
= BT_CTF_BTR_STATUS_ERROR
;
1370 * Push on stack. Not a compound type per se, but we know that only
1371 * btr_string_cb() may be called between this call and a subsequent
1372 * call to btr_string_end_cb().
1374 ret
= stack_push(notit
->stack
, field
);
1376 PERR("Failed to push string field onto the stack\n");
1377 status
= BT_CTF_BTR_STATUS_ERROR
;
1388 enum bt_ctf_btr_status
btr_string_cb(const char *value
,
1389 size_t len
, struct bt_ctf_field_type
*type
, void *data
)
1391 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1392 struct bt_ctf_field
*field
= NULL
;
1393 struct bt_ctf_notif_iter
*notit
= data
;
1396 /* Get string field */
1397 field
= stack_top(notit
->stack
)->base
;
1400 /* Append current string */
1401 ret
= bt_ctf_field_string_append_len(field
, value
, len
);
1403 PERR("Failed to append a string to a string field\n");
1404 status
= BT_CTF_BTR_STATUS_ERROR
;
1413 enum bt_ctf_btr_status
btr_string_end_cb(
1414 struct bt_ctf_field_type
*type
, void *data
)
1416 struct bt_ctf_notif_iter
*notit
= data
;
1418 /* Pop string field */
1419 stack_pop(notit
->stack
);
1421 /* Go to next field */
1422 stack_top(notit
->stack
)->index
++;
1424 return BT_CTF_BTR_STATUS_OK
;
1427 enum bt_ctf_btr_status
btr_compound_begin_cb(
1428 struct bt_ctf_field_type
*type
, void *data
)
1430 enum bt_ctf_btr_status status
= BT_CTF_BTR_STATUS_OK
;
1431 struct bt_ctf_notif_iter
*notit
= data
;
1432 struct bt_ctf_field
*field
;
1436 if (stack_empty(notit
->stack
)) {
1437 /* Root: create dynamic scope field */
1438 *notit
->cur_dscope_field
= bt_ctf_field_create(type
);
1439 field
= *notit
->cur_dscope_field
;
1442 * Field will be put at the end of this function
1443 * (stack_push() will take one reference, but this
1444 * reference is lost upon the equivalent stack_pop()
1445 * later), so also get it for our context to own it.
1447 bt_get(*notit
->cur_dscope_field
);
1449 field
= get_next_field(notit
);
1453 PERR("Failed to get next field or create dynamic scope field\n");
1454 status
= BT_CTF_BTR_STATUS_ERROR
;
1459 ret
= stack_push(notit
->stack
, field
);
1461 PERR("Failed to push compound field onto the stack\n");
1462 status
= BT_CTF_BTR_STATUS_ERROR
;
1472 enum bt_ctf_btr_status
btr_compound_end_cb(
1473 struct bt_ctf_field_type
*type
, void *data
)
1475 struct bt_ctf_notif_iter
*notit
= data
;
1477 assert(!stack_empty(notit
->stack
));
1480 stack_pop(notit
->stack
);
1482 /* If the stack is not empty, increment the base's index */
1483 if (!stack_empty(notit
->stack
)) {
1484 stack_top(notit
->stack
)->index
++;
1487 return BT_CTF_BTR_STATUS_OK
;
1491 struct bt_ctf_field
*resolve_field(struct bt_ctf_notif_iter
*notit
,
1492 struct bt_ctf_field_path
*path
)
1494 struct bt_ctf_field
*field
= NULL
;
1497 switch (bt_ctf_field_path_get_root_scope(path
)) {
1498 case BT_CTF_SCOPE_TRACE_PACKET_HEADER
:
1499 field
= notit
->dscopes
.trace_packet_header
;
1501 case BT_CTF_SCOPE_STREAM_PACKET_CONTEXT
:
1502 field
= notit
->dscopes
.stream_packet_context
;
1504 case BT_CTF_SCOPE_STREAM_EVENT_HEADER
:
1505 field
= notit
->dscopes
.stream_event_header
;
1507 case BT_CTF_SCOPE_STREAM_EVENT_CONTEXT
:
1508 field
= notit
->dscopes
.stream_event_context
;
1510 case BT_CTF_SCOPE_EVENT_CONTEXT
:
1511 field
= notit
->dscopes
.event_context
;
1513 case BT_CTF_SCOPE_EVENT_FIELDS
:
1514 field
= notit
->dscopes
.event_payload
;
1526 for (i
= 0; i
< bt_ctf_field_path_get_index_count(path
); ++i
) {
1527 struct bt_ctf_field
*next_field
= NULL
;
1528 struct bt_ctf_field_type
*field_type
;
1529 int index
= bt_ctf_field_path_get_index(path
, i
);
1531 field_type
= bt_ctf_field_get_type(field
);
1537 if (is_struct_type(field_type
)) {
1538 next_field
= bt_ctf_field_structure_get_field_by_index(
1540 } else if (is_variant_type(field_type
)) {
1542 bt_ctf_field_variant_get_current_field(field
);
1552 /* Move next field -> field */
1553 BT_MOVE(field
, next_field
);
1561 int64_t btr_get_sequence_length_cb(struct bt_ctf_field_type
*type
, void *data
)
1565 struct bt_ctf_field_path
*field_path
;
1566 struct bt_ctf_notif_iter
*notit
= data
;
1567 struct bt_ctf_field
*length_field
= NULL
;
1570 field_path
= bt_ctf_field_type_sequence_get_length_field_path(type
);
1575 length_field
= resolve_field(notit
, field_path
);
1576 if (!length_field
) {
1580 iret
= bt_ctf_field_unsigned_integer_get_value(length_field
, &length
);
1585 iret
= bt_ctf_field_sequence_set_length(stack_top(notit
->stack
)->base
,
1590 ret
= (int64_t) length
;
1593 BT_PUT(length_field
);
1600 struct bt_ctf_field_type
*btr_get_variant_type_cb(
1601 struct bt_ctf_field_type
*type
, void *data
)
1603 struct bt_ctf_field_path
*path
;
1604 struct bt_ctf_notif_iter
*notit
= data
;
1605 struct bt_ctf_field
*tag_field
= NULL
;
1606 struct bt_ctf_field
*selected_field
= NULL
;
1607 struct bt_ctf_field_type
*selected_field_type
= NULL
;
1609 path
= bt_ctf_field_type_variant_get_tag_field_path(type
);
1614 tag_field
= resolve_field(notit
, path
);
1620 * We found the enumeration tag field instance which should be
1621 * able to select a current field for this variant. This
1622 * callback function we're in is called _after_
1623 * compound_begin(), so the current stack top's base field is
1624 * the variant field in question. We get the selected field here
1625 * thanks to this tag field (thus creating the selected field),
1626 * which will also provide us with its type. Then, this field
1627 * will remain the current selected one until the next callback
1628 * function call which is used to fill the current selected
1631 selected_field
= bt_ctf_field_variant_get_field(
1632 stack_top(notit
->stack
)->base
, tag_field
);
1633 if (!selected_field
) {
1637 selected_field_type
= bt_ctf_field_get_type(selected_field
);
1641 BT_PUT(selected_field
);
1643 return selected_field_type
;
1647 struct bt_ctf_event
*create_event(struct bt_ctf_notif_iter
*notit
)
1650 struct bt_ctf_event
*event
;
1652 /* Create event object. */
1653 event
= bt_ctf_event_create(notit
->meta
.event_class
);
1658 /* Set header, stream event context, context, and payload fields. */
1659 ret
= bt_ctf_event_set_header(event
,
1660 notit
->dscopes
.stream_event_header
);
1665 ret
= bt_ctf_event_set_stream_event_context(event
,
1666 notit
->dscopes
.stream_event_context
);
1671 ret
= bt_ctf_event_set_event_context(event
,
1672 notit
->dscopes
.event_context
);
1677 ret
= bt_ctf_event_set_payload_field(event
,
1678 notit
->dscopes
.event_payload
);
1683 /* Associate with current packet. */
1684 assert(notit
->packet
);
1685 ret
= bt_ctf_event_set_packet(event
, notit
->packet
);
1698 void create_packet(struct bt_ctf_notif_iter
*notit
)
1701 struct bt_ctf_stream
*stream
= NULL
;
1702 struct bt_ctf_packet
*packet
= NULL
;
1704 /* Ask the user for the stream */
1705 stream
= notit
->medium
.medops
.get_stream(notit
->meta
.stream_class
,
1706 notit
->medium
.data
);
1712 packet
= bt_ctf_packet_create(stream
);
1717 /* Set packet's context and header fields */
1718 if (notit
->dscopes
.trace_packet_header
) {
1719 ret
= bt_ctf_packet_set_header(packet
,
1720 notit
->dscopes
.trace_packet_header
);
1726 if (notit
->dscopes
.stream_packet_context
) {
1727 ret
= bt_ctf_packet_set_context(packet
,
1728 notit
->dscopes
.stream_packet_context
);
1738 BT_MOVE(notit
->packet
, packet
);
1742 void notify_new_packet(struct bt_ctf_notif_iter
*notit
,
1743 struct bt_notification
**notification
)
1745 struct bt_notification
*ret
;
1747 /* Initialize the iterator's current packet */
1748 create_packet(notit
);
1749 if (!notit
->packet
) {
1753 ret
= bt_notification_packet_start_create(notit
->packet
);
1757 *notification
= ret
;
1761 void notify_end_of_packet(struct bt_ctf_notif_iter
*notit
,
1762 struct bt_notification
**notification
)
1764 struct bt_notification
*ret
;
1766 if (!notit
->packet
) {
1770 ret
= bt_notification_packet_end_create(notit
->packet
);
1774 BT_PUT(notit
->packet
);
1775 *notification
= ret
;
1779 void notify_event(struct bt_ctf_notif_iter
*notit
,
1780 struct bt_notification
**notification
)
1782 struct bt_ctf_event
*event
;
1783 struct bt_notification
*ret
= NULL
;
1786 event
= create_event(notit
);
1791 ret
= bt_notification_event_create(event
);
1795 *notification
= ret
;
1801 void notify_eos(struct bt_ctf_notif_iter
*notit
,
1802 struct bt_notification
**notification
)
1804 struct bt_ctf_event
*event
;
1805 struct bt_notification
*ret
= NULL
;
1808 event
= create_event(notit
);
1813 ret
= bt_notification_stream_end_create(event
);
1817 *notification
= ret
;
1822 struct bt_ctf_notif_iter
*bt_ctf_notif_iter_create(struct bt_ctf_trace
*trace
,
1823 size_t max_request_sz
,
1824 struct bt_ctf_notif_iter_medium_ops medops
,
1825 void *data
, FILE *err_stream
)
1827 struct bt_ctf_notif_iter
*notit
= NULL
;
1828 struct bt_ctf_btr_cbs cbs
= {
1830 .signed_int
= btr_signed_int_cb
,
1831 .unsigned_int
= btr_unsigned_int_cb
,
1832 .floating_point
= btr_floating_point_cb
,
1833 .string_begin
= btr_string_begin_cb
,
1834 .string
= btr_string_cb
,
1835 .string_end
= btr_string_end_cb
,
1836 .compound_begin
= btr_compound_begin_cb
,
1837 .compound_end
= btr_compound_end_cb
,
1840 .get_sequence_length
= btr_get_sequence_length_cb
,
1841 .get_variant_type
= btr_get_variant_type_cb
,
1846 assert(medops
.request_bytes
);
1847 notit
= g_new0(struct bt_ctf_notif_iter
, 1);
1849 PERR("Failed to allocate memory for CTF notification iterator\n");
1853 notit
->meta
.trace
= trace
;
1854 bt_get(notit
->meta
.trace
);
1855 notit
->medium
.medops
= medops
;
1856 notit
->medium
.max_request_sz
= max_request_sz
;
1857 notit
->medium
.data
= data
;
1858 notit
->err_stream
= err_stream
;
1859 notit
->stack
= stack_new(notit
);
1860 if (!notit
->stack
) {
1861 PERR("Failed to create stack\n");
1862 bt_ctf_notif_iter_destroy(notit
);
1867 notit
->btr
= bt_ctf_btr_create(cbs
, notit
, err_stream
);
1869 PERR("Failed to create binary type reader\n");
1870 bt_ctf_notif_iter_destroy(notit
);
1875 bt_ctf_notif_iter_reset(notit
);
1881 void bt_ctf_notif_iter_destroy(struct bt_ctf_notif_iter
*notit
)
1883 BT_PUT(notit
->meta
.trace
);
1884 BT_PUT(notit
->meta
.stream_class
);
1885 BT_PUT(notit
->meta
.event_class
);
1886 BT_PUT(notit
->packet
);
1887 put_all_dscopes(notit
);
1890 stack_destroy(notit
->stack
);
1894 bt_ctf_btr_destroy(notit
->btr
);
1900 enum bt_ctf_notif_iter_status
bt_ctf_notif_iter_get_next_notification(
1901 struct bt_ctf_notif_iter
*notit
,
1902 struct bt_notification
**notification
)
1904 enum bt_ctf_notif_iter_status status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
1907 assert(notification
);
1910 status
= handle_state(notit
);
1911 if (status
!= BT_CTF_NOTIF_ITER_STATUS_OK
) {
1912 if (status
== BT_CTF_NOTIF_ITER_STATUS_EOF
) {
1913 PDBG("Medium operation reported end of stream\n");
1915 PERR("Failed to handle state:\n");
1916 PERR("\tState: %d\n", notit
->state
);
1921 switch (notit
->state
) {
1922 case STATE_EMIT_NOTIF_NEW_PACKET
:
1923 PDBG("Emitting new packet notification\n");
1924 notify_new_packet(notit
, notification
);
1925 if (!*notification
) {
1926 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
1929 case STATE_EMIT_NOTIF_EVENT
:
1930 PDBG("Emitting event notification\n");
1931 notify_event(notit
, notification
);
1932 if (!*notification
) {
1933 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
1936 case STATE_EMIT_NOTIF_END_OF_PACKET
:
1937 PDBG("Emitting end of packet notification\n");
1938 notify_end_of_packet(notit
, notification
);
1939 if (!*notification
) {
1940 status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
1944 /* Non-emitting state: continue */