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
26 #define BT_LOG_TAG "PLUGIN-CTF-NOTIF-ITER"
34 #include <babeltrace/assert-internal.h>
36 #include <babeltrace/babeltrace.h>
37 #include <babeltrace/ctf-ir/field-types-internal.h>
38 #include <babeltrace/ctf-ir/field-path-internal.h>
42 #include "notif-iter.h"
43 #include "../btr/btr.h"
47 /* A visit stack entry */
50 * Current base field, one of:
58 * Field is owned by this.
60 struct bt_field
*base
;
62 /* index of next field to set */
68 /* Entries (struct stack_entry *) (top is last element) */
75 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
,
76 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
77 STATE_AFTER_TRACE_PACKET_HEADER
,
78 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
,
79 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
80 STATE_AFTER_STREAM_PACKET_CONTEXT
,
81 STATE_EMIT_NOTIF_NEW_STREAM
,
82 STATE_EMIT_NOTIF_NEW_PACKET
,
83 STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
,
84 STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
,
85 STATE_AFTER_STREAM_EVENT_HEADER
,
86 STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
,
87 STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
,
88 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
,
89 STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
,
90 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
91 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
92 STATE_EMIT_NOTIF_EVENT
,
93 STATE_EMIT_NOTIF_END_OF_PACKET
,
95 STATE_SKIP_PACKET_PADDING
,
98 struct trace_field_path_cache
{
100 * Indexes of the stream_id and stream_instance_id field in the packet
101 * header structure, -1 if unset.
104 int stream_instance_id
;
107 struct stream_class_field_path_cache
{
109 * Indexes of the v and id fields in the stream event header structure,
116 * index of the timestamp_end, packet_size and content_size fields in
117 * the stream packet context structure. Set to -1 if the fields were
125 struct field_cb_override
{
126 enum bt_btr_status (* func
)(void *value
,
127 struct bt_field_type
*type
, void *data
);
131 /* CTF notification iterator */
132 struct bt_notif_iter
{
137 * Current dynamic scope field pointer.
139 * This is set when a dynamic scope field is first created by
140 * btr_compound_begin_cb(). It points to one of the fields in
143 struct bt_field
**cur_dscope_field
;
145 /* Trace and classes (owned by this) */
147 struct bt_trace
*trace
;
148 struct bt_stream_class
*stream_class
;
149 struct bt_event_class
*event_class
;
152 /* Current packet (NULL if not created yet) */
153 struct bt_packet
*packet
;
155 /* Current stream (NULL if not set yet) */
156 struct bt_stream
*stream
;
159 * Current timestamp_end field (to consider before switching packets).
161 struct bt_field
*cur_timestamp_end
;
163 /* Database of current dynamic scopes (owned by this) */
165 struct bt_field
*trace_packet_header
;
166 struct bt_field
*stream_packet_context
;
167 struct bt_field
*stream_event_header
;
168 struct bt_field
*stream_event_context
;
169 struct bt_field
*event_context
;
170 struct bt_field
*event_payload
;
174 * Special field overrides.
176 * Overrides are used to implement the behaviours of special fields such
177 * as "timestamp_end" (which must be ignored until the end of the
178 * packet), "id" (event id) which can be present multiple times and must
179 * be updated multiple time.
181 * This should be used to implement the behaviour of integer fields
182 * mapped to clocks and other "tagged" fields (in CTF 2).
184 * bt_field_type to struct field_cb_override
186 GHashTable
*field_overrides
;
191 /* Current medium buffer data */
193 /* Last address provided by medium */
196 /* Buffer size provided by medium (bytes) */
199 /* Offset within whole packet of addr (bits) */
200 size_t packet_offset
;
202 /* Current position from addr (bits) */
205 /* Position of the last event header from addr (bits) */
209 /* Binary type reader */
212 /* Current medium data */
214 struct bt_notif_iter_medium_ops medops
;
215 size_t max_request_sz
;
219 /* Stream beginning was emitted */
220 bool stream_begin_emitted
;
222 /* Current packet size (bits) (-1 if unknown) */
223 int64_t cur_packet_size
;
225 /* Current content size (bits) (-1 if unknown) */
226 int64_t cur_content_size
;
229 * Offset, in the underlying media, of the current packet's start
232 off_t cur_packet_offset
;
234 /* bt_clock_class to uint64_t. */
235 GHashTable
*clock_states
;
238 * Cache of the trace-constant field paths (event header type)
239 * associated to the current trace.
241 struct trace_field_path_cache trace_field_path_cache
;
244 * Field path cache associated with the current stream class.
245 * Ownership of this structure belongs to the field_path_caches HT.
247 struct stream_class_field_path_cache
*cur_sc_field_path_cache
;
249 /* bt_stream_class to struct stream_class_field_path_cache. */
250 GHashTable
*sc_field_path_caches
;
254 const char *state_string(enum state state
)
259 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
260 return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
261 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
262 return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
263 case STATE_AFTER_TRACE_PACKET_HEADER
:
264 return "STATE_AFTER_TRACE_PACKET_HEADER";
265 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
266 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
267 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
268 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
269 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
270 return "STATE_AFTER_STREAM_PACKET_CONTEXT";
271 case STATE_EMIT_NOTIF_NEW_PACKET
:
272 return "STATE_EMIT_NOTIF_NEW_PACKET";
273 case STATE_EMIT_NOTIF_NEW_STREAM
:
274 return "STATE_EMIT_NOTIF_NEW_STREAM";
275 case STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
:
276 return "STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN";
277 case STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
:
278 return "STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE";
279 case STATE_AFTER_STREAM_EVENT_HEADER
:
280 return "STATE_AFTER_STREAM_EVENT_HEADER";
281 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
:
282 return "STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN";
283 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
:
284 return "STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE";
285 case STATE_DSCOPE_EVENT_CONTEXT_BEGIN
:
286 return "STATE_DSCOPE_EVENT_CONTEXT_BEGIN";
287 case STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
:
288 return "STATE_DSCOPE_EVENT_CONTEXT_CONTINUE";
289 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
290 return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
291 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
292 return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
293 case STATE_EMIT_NOTIF_EVENT
:
294 return "STATE_EMIT_NOTIF_EVENT";
295 case STATE_EMIT_NOTIF_END_OF_PACKET
:
296 return "STATE_EMIT_NOTIF_END_OF_PACKET";
299 case STATE_SKIP_PACKET_PADDING
:
300 return "STATE_SKIP_PACKET_PADDING";
307 int bt_notif_iter_switch_packet(struct bt_notif_iter
*notit
);
310 enum bt_btr_status
btr_timestamp_end_cb(void *value
,
311 struct bt_field_type
*type
, void *data
);
314 void stack_entry_free_func(gpointer data
)
316 struct stack_entry
*entry
= data
;
323 struct stack
*stack_new(struct bt_notif_iter
*notit
)
325 struct stack
*stack
= NULL
;
327 stack
= g_new0(struct stack
, 1);
329 BT_LOGE_STR("Failed to allocate one stack.");
333 stack
->entries
= g_ptr_array_new_with_free_func(stack_entry_free_func
);
334 if (!stack
->entries
) {
335 BT_LOGE_STR("Failed to allocate a GPtrArray.");
339 BT_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit
, stack
);
348 void stack_destroy(struct stack
*stack
)
351 BT_LOGD("Destroying stack: addr=%p", stack
);
352 g_ptr_array_free(stack
->entries
, TRUE
);
357 int stack_push(struct stack
*stack
, struct bt_field
*base
)
360 struct stack_entry
*entry
;
364 BT_LOGV("Pushing base field on stack: stack-addr=%p, "
365 "stack-size-before=%u, stack-size-after=%u",
366 stack
, stack
->entries
->len
, stack
->entries
->len
+ 1);
367 entry
= g_new0(struct stack_entry
, 1);
369 BT_LOGE_STR("Failed to allocate one stack entry.");
374 entry
->base
= bt_get(base
);
375 g_ptr_array_add(stack
->entries
, entry
);
382 unsigned int stack_size(struct stack
*stack
)
386 return stack
->entries
->len
;
390 void stack_pop(struct stack
*stack
)
393 BT_ASSERT(stack_size(stack
));
394 BT_LOGV("Popping from stack: "
395 "stack-addr=%p, stack-size-before=%u, stack-size-after=%u",
396 stack
, stack
->entries
->len
, stack
->entries
->len
- 1);
397 g_ptr_array_remove_index(stack
->entries
, stack
->entries
->len
- 1);
401 struct stack_entry
*stack_top(struct stack
*stack
)
404 BT_ASSERT(stack_size(stack
));
406 return g_ptr_array_index(stack
->entries
, stack
->entries
->len
- 1);
410 bool stack_empty(struct stack
*stack
)
412 return stack_size(stack
) == 0;
416 void stack_clear(struct stack
*stack
)
420 if (!stack_empty(stack
)) {
421 BT_LOGV("Clearing stack: stack-addr=%p, stack-size=%u",
422 stack
, stack
->entries
->len
);
423 g_ptr_array_remove_range(stack
->entries
, 0, stack_size(stack
));
426 BT_ASSERT(stack_empty(stack
));
430 enum bt_notif_iter_status
notif_iter_status_from_m_status(
431 enum bt_notif_iter_medium_status m_status
)
433 return (int) m_status
;
437 size_t buf_size_bits(struct bt_notif_iter
*notit
)
439 return notit
->buf
.sz
* 8;
443 size_t buf_available_bits(struct bt_notif_iter
*notit
)
445 return buf_size_bits(notit
) - notit
->buf
.at
;
449 size_t packet_at(struct bt_notif_iter
*notit
)
451 return notit
->buf
.packet_offset
+ notit
->buf
.at
;
455 void buf_consume_bits(struct bt_notif_iter
*notit
, size_t incr
)
457 BT_LOGV("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
458 notit
, notit
->buf
.at
, notit
->buf
.at
+ incr
);
459 notit
->buf
.at
+= incr
;
463 enum bt_notif_iter_status
request_medium_bytes(
464 struct bt_notif_iter
*notit
)
466 uint8_t *buffer_addr
= NULL
;
467 size_t buffer_sz
= 0;
468 enum bt_notif_iter_medium_status m_status
;
470 BT_LOGV("Calling user function (request bytes): notit-addr=%p, "
471 "request-size=%zu", notit
, notit
->medium
.max_request_sz
);
472 m_status
= notit
->medium
.medops
.request_bytes(
473 notit
->medium
.max_request_sz
, &buffer_addr
,
474 &buffer_sz
, notit
->medium
.data
);
475 BT_LOGV("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
476 bt_notif_iter_medium_status_string(m_status
),
477 buffer_addr
, buffer_sz
);
478 if (m_status
== BT_NOTIF_ITER_MEDIUM_STATUS_OK
) {
479 BT_ASSERT(buffer_sz
!= 0);
481 /* New packet offset is old one + old size (in bits) */
482 notit
->buf
.packet_offset
+= buf_size_bits(notit
);
484 /* Restart at the beginning of the new medium buffer */
486 notit
->buf
.last_eh_at
= SIZE_MAX
;
488 /* New medium buffer size */
489 notit
->buf
.sz
= buffer_sz
;
491 /* New medium buffer address */
492 notit
->buf
.addr
= buffer_addr
;
494 BT_LOGV("User function returned new bytes: "
495 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
496 notit
->buf
.packet_offset
, notit
->buf
.at
,
497 notit
->buf
.sz
, notit
->buf
.addr
);
498 BT_LOGV_MEM(buffer_addr
, buffer_sz
, "Returned bytes at %p:",
500 } else if (m_status
== BT_NOTIF_ITER_MEDIUM_STATUS_EOF
) {
502 * User returned end of stream: validate that we're not
503 * in the middle of a packet header, packet context, or
506 if (notit
->cur_packet_size
>= 0) {
507 if (packet_at(notit
) == notit
->cur_packet_size
) {
511 if (packet_at(notit
) == 0) {
515 if (notit
->buf
.last_eh_at
!= SIZE_MAX
&&
516 notit
->buf
.at
== notit
->buf
.last_eh_at
) {
521 /* All other states are invalid */
522 BT_LOGW("User function returned %s, but notification iterator is in an unexpected state: "
523 "state=%s, cur-packet-size=%" PRId64
", cur=%zu, "
524 "packet-cur=%zu, last-eh-at=%zu",
525 bt_notif_iter_medium_status_string(m_status
),
526 state_string(notit
->state
),
527 notit
->cur_packet_size
,
528 notit
->buf
.at
, packet_at(notit
),
529 notit
->buf
.last_eh_at
);
530 m_status
= BT_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
531 } else if (m_status
< 0) {
532 BT_LOGW("User function failed: status=%s",
533 bt_notif_iter_medium_status_string(m_status
));
537 return notif_iter_status_from_m_status(m_status
);
541 enum bt_notif_iter_status
buf_ensure_available_bits(
542 struct bt_notif_iter
*notit
)
544 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
546 if (buf_available_bits(notit
) == 0) {
548 * This _cannot_ return BT_NOTIF_ITER_STATUS_OK
551 status
= request_medium_bytes(notit
);
558 enum bt_notif_iter_status
read_dscope_begin_state(
559 struct bt_notif_iter
*notit
,
560 struct bt_field_type
*dscope_field_type
,
561 enum state done_state
, enum state continue_state
,
562 struct bt_field
**dscope_field
)
564 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
565 enum bt_btr_status btr_status
;
566 size_t consumed_bits
;
568 bt_put(*dscope_field
);
569 notit
->cur_dscope_field
= dscope_field
;
570 BT_LOGV("Starting BTR: notit-addr=%p, btr-addr=%p, ft-addr=%p",
571 notit
, notit
->btr
, dscope_field_type
);
572 consumed_bits
= bt_btr_start(notit
->btr
, dscope_field_type
,
573 notit
->buf
.addr
, notit
->buf
.at
, packet_at(notit
),
574 notit
->buf
.sz
, &btr_status
);
575 BT_LOGV("BTR consumed bits: size=%zu", consumed_bits
);
577 switch (btr_status
) {
578 case BT_BTR_STATUS_OK
:
579 /* type was read completely */
580 BT_LOGV_STR("Field was completely decoded.");
581 notit
->state
= done_state
;
583 case BT_BTR_STATUS_EOF
:
584 BT_LOGV_STR("BTR needs more data to decode field completely.");
585 notit
->state
= continue_state
;
588 BT_LOGW("BTR failed to start: notit-addr=%p, btr-addr=%p, "
589 "status=%s", notit
, notit
->btr
,
590 bt_btr_status_string(btr_status
));
591 status
= BT_NOTIF_ITER_STATUS_ERROR
;
595 /* Consume bits now since we know we're not in an error state */
596 buf_consume_bits(notit
, consumed_bits
);
603 enum bt_notif_iter_status
read_dscope_continue_state(
604 struct bt_notif_iter
*notit
, enum state done_state
)
606 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
607 enum bt_btr_status btr_status
;
608 size_t consumed_bits
;
610 BT_LOGV("Continuing BTR: notit-addr=%p, btr-addr=%p",
613 status
= buf_ensure_available_bits(notit
);
614 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
616 BT_LOGW("Cannot ensure that buffer has at least one byte: "
617 "notif-addr=%p, status=%s",
618 notit
, bt_notif_iter_status_string(status
));
620 BT_LOGV("Cannot ensure that buffer has at least one byte: "
621 "notif-addr=%p, status=%s",
622 notit
, bt_notif_iter_status_string(status
));
629 consumed_bits
= bt_btr_continue(notit
->btr
, notit
->buf
.addr
,
630 notit
->buf
.sz
, &btr_status
);
631 BT_LOGV("BTR consumed bits: size=%zu", consumed_bits
);
633 switch (btr_status
) {
634 case BT_BTR_STATUS_OK
:
635 /* Type was read completely. */
636 BT_LOGV_STR("Field was completely decoded.");
637 notit
->state
= done_state
;
639 case BT_BTR_STATUS_EOF
:
640 /* Stay in this continue state. */
641 BT_LOGV_STR("BTR needs more data to decode field completely.");
644 BT_LOGW("BTR failed to continue: notit-addr=%p, btr-addr=%p, "
645 "status=%s", notit
, notit
->btr
,
646 bt_btr_status_string(btr_status
));
647 status
= BT_NOTIF_ITER_STATUS_ERROR
;
651 /* Consume bits now since we know we're not in an error state. */
652 buf_consume_bits(notit
, consumed_bits
);
658 void put_event_dscopes(struct bt_notif_iter
*notit
)
660 BT_LOGV_STR("Putting event header field.");
661 BT_PUT(notit
->dscopes
.stream_event_header
);
662 BT_LOGV_STR("Putting stream event context field.");
663 BT_PUT(notit
->dscopes
.stream_event_context
);
664 BT_LOGV_STR("Putting event context field.");
665 BT_PUT(notit
->dscopes
.event_context
);
666 BT_LOGV_STR("Putting event payload field.");
667 BT_PUT(notit
->dscopes
.event_payload
);
671 void put_all_dscopes(struct bt_notif_iter
*notit
)
673 BT_LOGV_STR("Putting packet header field.");
674 BT_PUT(notit
->dscopes
.trace_packet_header
);
675 BT_LOGV_STR("Putting packet context field.");
676 BT_PUT(notit
->dscopes
.stream_packet_context
);
677 put_event_dscopes(notit
);
681 enum bt_notif_iter_status
read_packet_header_begin_state(
682 struct bt_notif_iter
*notit
)
684 struct bt_field_type
*packet_header_type
= NULL
;
685 enum bt_notif_iter_status ret
= BT_NOTIF_ITER_STATUS_OK
;
687 if (bt_notif_iter_switch_packet(notit
)) {
688 BT_LOGW("Cannot switch packet: notit-addr=%p", notit
);
689 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
693 /* Packet header type is common to the whole trace. */
694 packet_header_type
= bt_trace_get_packet_header_type(
696 if (!packet_header_type
) {
697 notit
->state
= STATE_AFTER_TRACE_PACKET_HEADER
;
701 BT_LOGV("Decoding packet header field:"
702 "notit-addr=%p, trace-addr=%p, trace-name=\"%s\", ft-addr=%p",
703 notit
, notit
->meta
.trace
,
704 bt_trace_get_name(notit
->meta
.trace
), packet_header_type
);
705 ret
= read_dscope_begin_state(notit
, packet_header_type
,
706 STATE_AFTER_TRACE_PACKET_HEADER
,
707 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
,
708 ¬it
->dscopes
.trace_packet_header
);
710 BT_LOGW("Cannot decode packet header field: "
711 "notit-addr=%p, trace-addr=%p, "
712 "trace-name=\"%s\", ft-addr=%p",
713 notit
, notit
->meta
.trace
,
714 bt_trace_get_name(notit
->meta
.trace
),
718 BT_PUT(packet_header_type
);
723 enum bt_notif_iter_status
read_packet_header_continue_state(
724 struct bt_notif_iter
*notit
)
726 return read_dscope_continue_state(notit
,
727 STATE_AFTER_TRACE_PACKET_HEADER
);
731 bool is_struct_type(struct bt_field_type
*field_type
)
733 return bt_field_type_get_type_id(field_type
) ==
734 BT_FIELD_TYPE_ID_STRUCT
;
738 bool is_variant_type(struct bt_field_type
*field_type
)
740 return bt_field_type_get_type_id(field_type
) ==
741 BT_FIELD_TYPE_ID_VARIANT
;
745 struct stream_class_field_path_cache
*
746 create_stream_class_field_path_cache_entry(
747 struct bt_notif_iter
*notit
,
748 struct bt_stream_class
*stream_class
)
752 int timestamp_end
= -1;
753 int packet_size
= -1;
754 int content_size
= -1;
755 struct stream_class_field_path_cache
*cache_entry
= g_new0(
756 struct stream_class_field_path_cache
, 1);
757 struct bt_field_type
*event_header
= NULL
, *packet_context
= NULL
;
760 BT_LOGE_STR("Failed to allocate one stream class field path cache.");
764 event_header
= bt_stream_class_get_event_header_type(stream_class
);
765 if (event_header
&& bt_field_type_is_structure(event_header
)) {
768 count
= bt_field_type_structure_get_field_count(
770 BT_ASSERT(count
>= 0);
772 for (i
= 0; i
< count
; i
++) {
776 ret
= bt_field_type_structure_get_field_by_index(
777 event_header
, &name
, NULL
, i
);
779 BT_LOGE("Cannot get event header structure field type's field: "
780 "notit-addr=%p, stream-class-addr=%p, "
781 "stream-class-name=\"%s\", "
782 "stream-class-id=%" PRId64
", "
783 "ft-addr=%p, index=%d",
785 bt_stream_class_get_name(stream_class
),
786 bt_stream_class_get_id(stream_class
),
791 if (v
!= -1 && id
!= -1) {
795 if (v
== -1 && strcmp(name
, "v") == 0) {
797 } else if (id
== -1 && !strcmp(name
, "id")) {
803 packet_context
= bt_stream_class_get_packet_context_type(
805 if (packet_context
&& bt_field_type_is_structure(packet_context
)) {
808 count
= bt_field_type_structure_get_field_count(
810 BT_ASSERT(count
>= 0);
812 for (i
= 0; i
< count
; i
++) {
815 struct bt_field_type
*field_type
;
817 if (timestamp_end
!= -1 && packet_size
!= -1 &&
818 content_size
!= -1) {
822 ret
= bt_field_type_structure_get_field_by_index(
823 packet_context
, &name
, &field_type
, i
);
825 BT_LOGE("Cannot get packet context structure field type's field: "
826 "notit-addr=%p, stream-class-addr=%p, "
827 "stream-class-name=\"%s\", "
828 "stream-class-id=%" PRId64
", "
829 "ft-addr=%p, index=%d",
831 bt_stream_class_get_name(stream_class
),
832 bt_stream_class_get_id(stream_class
),
837 if (timestamp_end
== -1 &&
838 strcmp(name
, "timestamp_end") == 0) {
839 struct field_cb_override
*override
= g_new0(
840 struct field_cb_override
, 1);
847 override
->func
= btr_timestamp_end_cb
;
848 override
->data
= notit
;
849 g_hash_table_insert(notit
->field_overrides
,
850 bt_get(field_type
), override
);
852 } else if (packet_size
== -1 &&
853 !strcmp(name
, "packet_size")) {
855 } else if (content_size
== -1 &&
856 !strcmp(name
, "content_size")) {
864 cache_entry
->id
= id
;
865 cache_entry
->timestamp_end
= timestamp_end
;
866 cache_entry
->packet_size
= packet_size
;
867 cache_entry
->content_size
= content_size
;
869 BT_PUT(event_header
);
870 BT_PUT(packet_context
);
879 struct stream_class_field_path_cache
*get_stream_class_field_path_cache(
880 struct bt_notif_iter
*notit
,
881 struct bt_stream_class
*stream_class
)
883 bool cache_entry_found
;
884 struct stream_class_field_path_cache
*cache_entry
;
886 cache_entry_found
= g_hash_table_lookup_extended(
887 notit
->sc_field_path_caches
,
888 stream_class
, NULL
, (gpointer
) &cache_entry
);
889 if (unlikely(!cache_entry_found
)) {
890 cache_entry
= create_stream_class_field_path_cache_entry(notit
,
892 g_hash_table_insert(notit
->sc_field_path_caches
,
893 bt_get(stream_class
), (gpointer
) cache_entry
);
900 enum bt_notif_iter_status
set_current_stream_class(
901 struct bt_notif_iter
*notit
)
903 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
904 struct bt_field_type
*packet_header_type
= NULL
;
905 struct bt_field_type
*stream_id_field_type
= NULL
;
906 struct bt_stream_class
*new_stream_class
= NULL
;
909 /* Clear the current stream class field path cache. */
910 notit
->cur_sc_field_path_cache
= NULL
;
912 /* Is there any "stream_id" field in the packet header? */
913 packet_header_type
= bt_trace_get_packet_header_type(
915 if (!packet_header_type
) {
917 * No packet header, therefore no `stream_id` field,
918 * therefore only one stream class.
920 goto single_stream_class
;
923 BT_ASSERT(is_struct_type(packet_header_type
));
926 stream_id_field_type
=
927 bt_field_type_structure_get_field_type_by_name(
928 packet_header_type
, "stream_id");
929 if (stream_id_field_type
) {
930 /* Find appropriate stream class using current stream ID */
932 struct bt_field
*stream_id_field
= NULL
;
934 BT_ASSERT(notit
->dscopes
.trace_packet_header
);
937 stream_id_field
= bt_field_structure_get_field_by_name(
938 notit
->dscopes
.trace_packet_header
, "stream_id");
939 BT_ASSERT(stream_id_field
);
940 ret
= bt_field_unsigned_integer_get_value(
941 stream_id_field
, &stream_id
);
943 BT_PUT(stream_id_field
);
946 /* Only one stream: pick the first stream class */
947 BT_ASSERT(bt_trace_get_stream_class_count(
948 notit
->meta
.trace
) == 1);
952 BT_LOGV("Found stream class ID to use: notit-addr=%p, "
953 "stream-class-id=%" PRIu64
", "
954 "trace-addr=%p, trace-name=\"%s\"",
955 notit
, stream_id
, notit
->meta
.trace
,
956 bt_trace_get_name(notit
->meta
.trace
));
958 new_stream_class
= bt_trace_get_stream_class_by_id(
959 notit
->meta
.trace
, stream_id
);
960 if (!new_stream_class
) {
961 BT_LOGW("No stream class with ID of stream class ID to use in trace: "
962 "notit-addr=%p, stream-class-id=%" PRIu64
", "
963 "trace-addr=%p, trace-name=\"%s\"",
964 notit
, stream_id
, notit
->meta
.trace
,
965 bt_trace_get_name(notit
->meta
.trace
));
966 status
= BT_NOTIF_ITER_STATUS_ERROR
;
970 if (notit
->meta
.stream_class
) {
971 if (new_stream_class
!= notit
->meta
.stream_class
) {
972 BT_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
973 "notit-addr=%p, prev-stream-class-addr=%p, "
974 "prev-stream-class-name=\"%s\", "
975 "prev-stream-class-id=%" PRId64
", "
976 "next-stream-class-addr=%p, "
977 "next-stream-class-name=\"%s\", "
978 "next-stream-class-id=%" PRId64
", "
979 "trace-addr=%p, trace-name=\"%s\"",
980 notit
, notit
->meta
.stream_class
,
981 bt_stream_class_get_name(notit
->meta
.stream_class
),
982 bt_stream_class_get_id(notit
->meta
.stream_class
),
984 bt_stream_class_get_name(new_stream_class
),
985 bt_stream_class_get_id(new_stream_class
),
987 bt_trace_get_name(notit
->meta
.trace
));
988 status
= BT_NOTIF_ITER_STATUS_ERROR
;
992 BT_MOVE(notit
->meta
.stream_class
, new_stream_class
);
995 BT_LOGV("Set current stream class: "
996 "notit-addr=%p, stream-class-addr=%p, "
997 "stream-class-name=\"%s\", stream-class-id=%" PRId64
,
998 notit
, notit
->meta
.stream_class
,
999 bt_stream_class_get_name(notit
->meta
.stream_class
),
1000 bt_stream_class_get_id(notit
->meta
.stream_class
));
1003 * Retrieve (or lazily create) the current stream class field path
1006 notit
->cur_sc_field_path_cache
= get_stream_class_field_path_cache(
1007 notit
, notit
->meta
.stream_class
);
1008 if (!notit
->cur_sc_field_path_cache
) {
1009 BT_LOGW("Cannot retrieve stream class field path from cache: "
1010 "notit-addr=%p, stream-class-addr=%p, "
1011 "stream-class-name=\"%s\", stream-class-id=%" PRId64
,
1012 notit
, notit
->meta
.stream_class
,
1013 bt_stream_class_get_name(notit
->meta
.stream_class
),
1014 bt_stream_class_get_id(notit
->meta
.stream_class
));
1015 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1019 BT_PUT(packet_header_type
);
1020 BT_PUT(stream_id_field_type
);
1021 bt_put(new_stream_class
);
1026 enum bt_notif_iter_status
after_packet_header_state(
1027 struct bt_notif_iter
*notit
)
1029 enum bt_notif_iter_status status
;
1031 status
= set_current_stream_class(notit
);
1032 if (status
== BT_NOTIF_ITER_STATUS_OK
) {
1033 notit
->state
= STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
;
1040 enum bt_notif_iter_status
read_packet_context_begin_state(
1041 struct bt_notif_iter
*notit
)
1043 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1044 struct bt_field_type
*packet_context_type
;
1046 BT_ASSERT(notit
->meta
.stream_class
);
1047 packet_context_type
= bt_stream_class_get_packet_context_type(
1048 notit
->meta
.stream_class
);
1049 if (!packet_context_type
) {
1050 BT_LOGV("No packet packet context field type in stream class: continuing: "
1051 "notit-addr=%p, stream-class-addr=%p, "
1052 "stream-class-name=\"%s\", stream-class-id=%" PRId64
,
1053 notit
, notit
->meta
.stream_class
,
1054 bt_stream_class_get_name(notit
->meta
.stream_class
),
1055 bt_stream_class_get_id(notit
->meta
.stream_class
));
1056 notit
->state
= STATE_AFTER_STREAM_PACKET_CONTEXT
;
1060 BT_LOGV("Decoding packet context field: "
1061 "notit-addr=%p, stream-class-addr=%p, "
1062 "stream-class-name=\"%s\", stream-class-id=%" PRId64
", "
1064 notit
, notit
->meta
.stream_class
,
1065 bt_stream_class_get_name(notit
->meta
.stream_class
),
1066 bt_stream_class_get_id(notit
->meta
.stream_class
),
1067 packet_context_type
);
1068 status
= read_dscope_begin_state(notit
, packet_context_type
,
1069 STATE_AFTER_STREAM_PACKET_CONTEXT
,
1070 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
,
1071 ¬it
->dscopes
.stream_packet_context
);
1073 BT_LOGW("Cannot decode packet context field: "
1074 "notit-addr=%p, stream-class-addr=%p, "
1075 "stream-class-name=\"%s\", "
1076 "stream-class-id=%" PRId64
", ft-addr=%p",
1077 notit
, notit
->meta
.stream_class
,
1078 bt_stream_class_get_name(notit
->meta
.stream_class
),
1079 bt_stream_class_get_id(notit
->meta
.stream_class
),
1080 packet_context_type
);
1084 BT_PUT(packet_context_type
);
1089 enum bt_notif_iter_status
read_packet_context_continue_state(
1090 struct bt_notif_iter
*notit
)
1092 return read_dscope_continue_state(notit
,
1093 STATE_AFTER_STREAM_PACKET_CONTEXT
);
1097 enum bt_notif_iter_status
set_current_packet_content_sizes(
1098 struct bt_notif_iter
*notit
)
1100 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1101 struct bt_field
*packet_size_field
= NULL
;
1102 struct bt_field
*content_size_field
= NULL
;
1103 uint64_t content_size
= -1ULL, packet_size
= -1ULL;
1105 if (!notit
->dscopes
.stream_packet_context
) {
1109 packet_size_field
= bt_field_structure_get_field_by_name(
1110 notit
->dscopes
.stream_packet_context
, "packet_size");
1111 content_size_field
= bt_field_structure_get_field_by_name(
1112 notit
->dscopes
.stream_packet_context
, "content_size");
1113 if (packet_size_field
) {
1114 int ret
= bt_field_unsigned_integer_get_value(
1115 packet_size_field
, &packet_size
);
1117 BT_ASSERT(ret
== 0);
1118 if (packet_size
== 0) {
1119 BT_LOGW("Invalid packet size: packet context field indicates packet size is zero: "
1120 "notit-addr=%p, packet-context-field-addr=%p",
1121 notit
, notit
->dscopes
.stream_packet_context
);
1122 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1124 } else if ((packet_size
% 8) != 0) {
1125 BT_LOGW("Invalid packet size: packet context field indicates packet size is not a multiple of 8: "
1126 "notit-addr=%p, packet-context-field-addr=%p, "
1127 "packet-size=%" PRIu64
,
1128 notit
, notit
->dscopes
.stream_packet_context
,
1130 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1135 if (content_size_field
) {
1136 int ret
= bt_field_unsigned_integer_get_value(
1137 content_size_field
, &content_size
);
1139 BT_ASSERT(ret
== 0);
1141 content_size
= packet_size
;
1144 if (content_size
> packet_size
) {
1145 BT_LOGW("Invalid packet or content size: packet context field indicates content size is greater than packet size: "
1146 "notit-addr=%p, packet-context-field-addr=%p, "
1147 "packet-size=%" PRIu64
", content-size=%" PRIu64
,
1148 notit
, notit
->dscopes
.stream_packet_context
,
1149 packet_size
, content_size
);
1150 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1154 if (packet_size
!= -1ULL) {
1155 notit
->cur_packet_size
= packet_size
;
1158 * Use the content size as packet size indicator if the
1159 * packet size field is missing. This means there is no
1160 * padding in this stream.
1162 notit
->cur_packet_size
= content_size
;
1164 notit
->cur_content_size
= content_size
;
1165 BT_LOGV("Set current packet and content sizes: "
1166 "notit-addr=%p, packet-size=%" PRIu64
", content-size=%" PRIu64
,
1167 notit
, packet_size
, content_size
);
1169 BT_PUT(packet_size_field
);
1170 BT_PUT(content_size_field
);
1175 enum bt_notif_iter_status
after_packet_context_state(
1176 struct bt_notif_iter
*notit
)
1178 enum bt_notif_iter_status status
;
1180 status
= set_current_packet_content_sizes(notit
);
1181 if (status
== BT_NOTIF_ITER_STATUS_OK
) {
1182 if (notit
->stream_begin_emitted
) {
1183 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
1185 notit
->state
= STATE_EMIT_NOTIF_NEW_STREAM
;
1193 enum bt_notif_iter_status
read_event_header_begin_state(
1194 struct bt_notif_iter
*notit
)
1196 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1197 struct bt_field_type
*event_header_type
= NULL
;
1199 /* Reset the position of the last event header */
1200 notit
->buf
.last_eh_at
= notit
->buf
.at
;
1202 /* Check if we have some content left */
1203 if (notit
->cur_content_size
>= 0) {
1204 if (packet_at(notit
) == notit
->cur_content_size
) {
1205 /* No more events! */
1206 BT_LOGV("Reached end of packet: notit-addr=%p, "
1207 "cur=%zu", notit
, packet_at(notit
));
1208 notit
->state
= STATE_EMIT_NOTIF_END_OF_PACKET
;
1210 } else if (packet_at(notit
) > notit
->cur_content_size
) {
1211 /* That's not supposed to happen */
1212 BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
1213 "notit-addr=%p, content-size=%" PRId64
", "
1214 "cur=%zu", notit
, notit
->cur_content_size
,
1216 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1221 event_header_type
= bt_stream_class_get_event_header_type(
1222 notit
->meta
.stream_class
);
1223 if (!event_header_type
) {
1224 notit
->state
= STATE_AFTER_STREAM_EVENT_HEADER
;
1228 put_event_dscopes(notit
);
1229 BT_LOGV("Decoding event header field: "
1230 "notit-addr=%p, stream-class-addr=%p, "
1231 "stream-class-name=\"%s\", stream-class-id=%" PRId64
", "
1233 notit
, notit
->meta
.stream_class
,
1234 bt_stream_class_get_name(notit
->meta
.stream_class
),
1235 bt_stream_class_get_id(notit
->meta
.stream_class
),
1237 status
= read_dscope_begin_state(notit
, event_header_type
,
1238 STATE_AFTER_STREAM_EVENT_HEADER
,
1239 STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
,
1240 ¬it
->dscopes
.stream_event_header
);
1242 BT_LOGW("Cannot decode event header field: "
1243 "notit-addr=%p, stream-class-addr=%p, "
1244 "stream-class-name=\"%s\", "
1245 "stream-class-id=%" PRId64
", ft-addr=%p",
1246 notit
, notit
->meta
.stream_class
,
1247 bt_stream_class_get_name(notit
->meta
.stream_class
),
1248 bt_stream_class_get_id(notit
->meta
.stream_class
),
1252 BT_PUT(event_header_type
);
1258 enum bt_notif_iter_status
read_event_header_continue_state(
1259 struct bt_notif_iter
*notit
)
1261 return read_dscope_continue_state(notit
,
1262 STATE_AFTER_STREAM_EVENT_HEADER
);
1266 enum bt_notif_iter_status
set_current_event_class(struct bt_notif_iter
*notit
)
1269 * The assert() calls in this function are okay because it is
1270 * assumed here that all the metadata objects have been
1271 * validated for CTF correctness before decoding actual streams.
1274 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1275 struct bt_field_type
*event_header_type
;
1276 struct bt_field_type
*id_field_type
= NULL
;
1277 struct bt_field_type
*v_field_type
= NULL
;
1278 uint64_t event_id
= -1ULL;
1281 event_header_type
= bt_stream_class_get_event_header_type(
1282 notit
->meta
.stream_class
);
1283 if (!event_header_type
) {
1285 * No event header, therefore no event class ID field,
1286 * therefore only one event class.
1288 goto single_event_class
;
1291 /* Is there any "id"/"v" field in the event header? */
1292 BT_ASSERT(is_struct_type(event_header_type
));
1293 id_field_type
= bt_field_type_structure_get_field_type_by_name(
1294 event_header_type
, "id");
1295 v_field_type
= bt_field_type_structure_get_field_type_by_name(
1296 event_header_type
, "v");
1297 BT_ASSERT(notit
->dscopes
.stream_event_header
);
1301 * | | |_ _|_ _| __ __ _
1302 * | | | | | || '_ \ / _` |
1303 * | |___| | | || | | | (_| | S P E C I A L
1304 * |_____|_| |_||_| |_|\__, | C A S E â„¢
1307 struct bt_field
*v_field
= NULL
;
1308 struct bt_field
*v_struct_field
= NULL
;
1309 struct bt_field
*v_struct_id_field
= NULL
;
1311 // TODO: optimalize!
1312 v_field
= bt_field_structure_get_field_by_name(
1313 notit
->dscopes
.stream_event_header
, "v");
1317 bt_field_variant_get_current_field(v_field
);
1318 if (!v_struct_field
) {
1319 goto end_v_field_type
;
1322 // TODO: optimalize!
1324 bt_field_structure_get_field_by_name(v_struct_field
, "id");
1325 if (!v_struct_id_field
) {
1326 goto end_v_field_type
;
1329 if (bt_field_is_integer(v_struct_id_field
)) {
1330 ret
= bt_field_unsigned_integer_get_value(
1331 v_struct_id_field
, &event_id
);
1333 BT_LOGV("Cannot get value of unsigned integer field (`id`): continuing: "
1334 "notit=%p, field-addr=%p",
1335 notit
, v_struct_id_field
);
1342 BT_PUT(v_struct_field
);
1343 BT_PUT(v_struct_id_field
);
1346 if (id_field_type
&& event_id
== -1ULL) {
1347 /* Check "id" field */
1348 struct bt_field
*id_field
= NULL
;
1349 int ret_get_value
= 0;
1351 // TODO: optimalize!
1352 id_field
= bt_field_structure_get_field_by_name(
1353 notit
->dscopes
.stream_event_header
, "id");
1355 goto check_event_id
;
1358 if (bt_field_is_integer(id_field
)) {
1359 ret_get_value
= bt_field_unsigned_integer_get_value(
1360 id_field
, &event_id
);
1361 } else if (bt_field_is_enumeration(id_field
)) {
1362 struct bt_field
*container
;
1364 container
= bt_field_enumeration_get_container(
1366 BT_ASSERT(container
);
1367 ret_get_value
= bt_field_unsigned_integer_get_value(
1368 container
, &event_id
);
1372 BT_ASSERT(ret_get_value
== 0);
1377 if (event_id
== -1ULL) {
1379 /* Event ID not found: single event? */
1380 BT_ASSERT(bt_stream_class_get_event_class_count(
1381 notit
->meta
.stream_class
) == 1);
1385 BT_LOGV("Found event class ID to use: notit-addr=%p, "
1386 "stream-class-addr=%p, stream-class-name=\"%s\", "
1387 "stream-class-id=%" PRId64
", "
1388 "event-class-id=%" PRIu64
,
1389 notit
, notit
->meta
.stream_class
,
1390 bt_stream_class_get_name(notit
->meta
.stream_class
),
1391 bt_stream_class_get_id(notit
->meta
.stream_class
),
1393 BT_PUT(notit
->meta
.event_class
);
1394 notit
->meta
.event_class
= bt_stream_class_get_event_class_by_id(
1395 notit
->meta
.stream_class
, event_id
);
1396 if (!notit
->meta
.event_class
) {
1397 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1398 "notit-addr=%p, stream-class-addr=%p, "
1399 "stream-class-name=\"%s\", "
1400 "stream-class-id=%" PRId64
", "
1401 "event-class-id=%" PRIu64
,
1402 notit
, notit
->meta
.stream_class
,
1403 bt_stream_class_get_name(notit
->meta
.stream_class
),
1404 bt_stream_class_get_id(notit
->meta
.stream_class
),
1406 status
= BT_NOTIF_ITER_STATUS_ERROR
;
1410 BT_LOGV("Set current event class: "
1411 "notit-addr=%p, event-class-addr=%p, "
1412 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1413 notit
, notit
->meta
.event_class
,
1414 bt_event_class_get_name(notit
->meta
.event_class
),
1415 bt_event_class_get_id(notit
->meta
.event_class
));
1418 BT_PUT(event_header_type
);
1419 BT_PUT(id_field_type
);
1420 BT_PUT(v_field_type
);
1426 enum bt_notif_iter_status
after_event_header_state(
1427 struct bt_notif_iter
*notit
)
1429 enum bt_notif_iter_status status
;
1431 status
= set_current_event_class(notit
);
1432 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1436 notit
->state
= STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
;
1443 enum bt_notif_iter_status
read_stream_event_context_begin_state(
1444 struct bt_notif_iter
*notit
)
1446 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1447 struct bt_field_type
*stream_event_context_type
;
1449 stream_event_context_type
= bt_stream_class_get_event_context_type(
1450 notit
->meta
.stream_class
);
1451 if (!stream_event_context_type
) {
1452 notit
->state
= STATE_DSCOPE_EVENT_CONTEXT_BEGIN
;
1456 BT_LOGV("Decoding stream event context field: "
1457 "notit-addr=%p, stream-class-addr=%p, "
1458 "stream-class-name=\"%s\", stream-class-id=%" PRId64
", "
1460 notit
, notit
->meta
.stream_class
,
1461 bt_stream_class_get_name(notit
->meta
.stream_class
),
1462 bt_stream_class_get_id(notit
->meta
.stream_class
),
1463 stream_event_context_type
);
1464 status
= read_dscope_begin_state(notit
, stream_event_context_type
,
1465 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
,
1466 STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
,
1467 ¬it
->dscopes
.stream_event_context
);
1469 BT_LOGW("Cannot decode stream event context field: "
1470 "notit-addr=%p, stream-class-addr=%p, "
1471 "stream-class-name=\"%s\", "
1472 "stream-class-id=%" PRId64
", ft-addr=%p",
1473 notit
, notit
->meta
.stream_class
,
1474 bt_stream_class_get_name(notit
->meta
.stream_class
),
1475 bt_stream_class_get_id(notit
->meta
.stream_class
),
1476 stream_event_context_type
);
1480 BT_PUT(stream_event_context_type
);
1486 enum bt_notif_iter_status
read_stream_event_context_continue_state(
1487 struct bt_notif_iter
*notit
)
1489 return read_dscope_continue_state(notit
,
1490 STATE_DSCOPE_EVENT_CONTEXT_BEGIN
);
1494 enum bt_notif_iter_status
read_event_context_begin_state(
1495 struct bt_notif_iter
*notit
)
1497 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1498 struct bt_field_type
*event_context_type
;
1500 event_context_type
= bt_event_class_get_context_type(
1501 notit
->meta
.event_class
);
1502 if (!event_context_type
) {
1503 notit
->state
= STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
;
1507 BT_LOGV("Decoding event context field: "
1508 "notit-addr=%p, event-class-addr=%p, "
1509 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1511 notit
, notit
->meta
.event_class
,
1512 bt_event_class_get_name(notit
->meta
.event_class
),
1513 bt_event_class_get_id(notit
->meta
.event_class
),
1514 event_context_type
);
1515 status
= read_dscope_begin_state(notit
, event_context_type
,
1516 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
,
1517 STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
,
1518 ¬it
->dscopes
.event_context
);
1520 BT_LOGW("Cannot decode event context field: "
1521 "notit-addr=%p, event-class-addr=%p, "
1522 "event-class-name=\"%s\", "
1523 "event-class-id=%" PRId64
", ft-addr=%p",
1524 notit
, notit
->meta
.event_class
,
1525 bt_event_class_get_name(notit
->meta
.event_class
),
1526 bt_event_class_get_id(notit
->meta
.event_class
),
1527 event_context_type
);
1531 BT_PUT(event_context_type
);
1537 enum bt_notif_iter_status
read_event_context_continue_state(
1538 struct bt_notif_iter
*notit
)
1540 return read_dscope_continue_state(notit
,
1541 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
);
1545 enum bt_notif_iter_status
read_event_payload_begin_state(
1546 struct bt_notif_iter
*notit
)
1548 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1549 struct bt_field_type
*event_payload_type
;
1551 event_payload_type
= bt_event_class_get_payload_type(
1552 notit
->meta
.event_class
);
1553 if (!event_payload_type
) {
1554 notit
->state
= STATE_EMIT_NOTIF_EVENT
;
1558 BT_LOGV("Decoding event payload field: "
1559 "notit-addr=%p, event-class-addr=%p, "
1560 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1562 notit
, notit
->meta
.event_class
,
1563 bt_event_class_get_name(notit
->meta
.event_class
),
1564 bt_event_class_get_id(notit
->meta
.event_class
),
1565 event_payload_type
);
1566 status
= read_dscope_begin_state(notit
, event_payload_type
,
1567 STATE_EMIT_NOTIF_EVENT
,
1568 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
,
1569 ¬it
->dscopes
.event_payload
);
1571 BT_LOGW("Cannot decode event payload field: "
1572 "notit-addr=%p, event-class-addr=%p, "
1573 "event-class-name=\"%s\", "
1574 "event-class-id=%" PRId64
", ft-addr=%p",
1575 notit
, notit
->meta
.event_class
,
1576 bt_event_class_get_name(notit
->meta
.event_class
),
1577 bt_event_class_get_id(notit
->meta
.event_class
),
1578 event_payload_type
);
1582 BT_PUT(event_payload_type
);
1588 enum bt_notif_iter_status
read_event_payload_continue_state(
1589 struct bt_notif_iter
*notit
)
1591 return read_dscope_continue_state(notit
, STATE_EMIT_NOTIF_EVENT
);
1595 enum bt_notif_iter_status
skip_packet_padding_state(
1596 struct bt_notif_iter
*notit
)
1598 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1599 size_t bits_to_skip
;
1601 BT_ASSERT(notit
->cur_packet_size
> 0);
1602 bits_to_skip
= notit
->cur_packet_size
- packet_at(notit
);
1603 if (bits_to_skip
== 0) {
1604 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1607 size_t bits_to_consume
;
1609 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1610 bits_to_skip
, notit
, bits_to_skip
);
1611 status
= buf_ensure_available_bits(notit
);
1612 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
1616 bits_to_consume
= MIN(buf_available_bits(notit
), bits_to_skip
);
1617 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1618 bits_to_consume
, notit
, bits_to_consume
);
1619 buf_consume_bits(notit
, bits_to_consume
);
1620 bits_to_skip
= notit
->cur_packet_size
- packet_at(notit
);
1621 if (bits_to_skip
== 0) {
1622 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1632 enum bt_notif_iter_status
handle_state(struct bt_notif_iter
*notit
)
1634 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
1635 const enum state state
= notit
->state
;
1637 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1638 notit
, state_string(state
));
1640 // TODO: optimalize!
1643 notit
->state
= STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
;
1645 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
1646 status
= read_packet_header_begin_state(notit
);
1648 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
1649 status
= read_packet_header_continue_state(notit
);
1651 case STATE_AFTER_TRACE_PACKET_HEADER
:
1652 status
= after_packet_header_state(notit
);
1654 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
1655 status
= read_packet_context_begin_state(notit
);
1657 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
1658 status
= read_packet_context_continue_state(notit
);
1660 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
1661 status
= after_packet_context_state(notit
);
1663 case STATE_EMIT_NOTIF_NEW_STREAM
:
1664 notit
->state
= STATE_EMIT_NOTIF_NEW_PACKET
;
1666 case STATE_EMIT_NOTIF_NEW_PACKET
:
1667 notit
->state
= STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
;
1669 case STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
:
1670 status
= read_event_header_begin_state(notit
);
1672 case STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE
:
1673 status
= read_event_header_continue_state(notit
);
1675 case STATE_AFTER_STREAM_EVENT_HEADER
:
1676 status
= after_event_header_state(notit
);
1678 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN
:
1679 status
= read_stream_event_context_begin_state(notit
);
1681 case STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE
:
1682 status
= read_stream_event_context_continue_state(notit
);
1684 case STATE_DSCOPE_EVENT_CONTEXT_BEGIN
:
1685 status
= read_event_context_begin_state(notit
);
1687 case STATE_DSCOPE_EVENT_CONTEXT_CONTINUE
:
1688 status
= read_event_context_continue_state(notit
);
1690 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN
:
1691 status
= read_event_payload_begin_state(notit
);
1693 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE
:
1694 status
= read_event_payload_continue_state(notit
);
1696 case STATE_EMIT_NOTIF_EVENT
:
1697 notit
->state
= STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN
;
1699 case STATE_SKIP_PACKET_PADDING
:
1700 status
= skip_packet_padding_state(notit
);
1702 case STATE_EMIT_NOTIF_END_OF_PACKET
:
1703 notit
->state
= STATE_SKIP_PACKET_PADDING
;
1706 BT_LOGD("Unknown CTF plugin notification iterator state: "
1707 "notit-addr=%p, state=%d", notit
, notit
->state
);
1711 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1712 "prev-state=%s, cur-state=%s",
1713 notit
, bt_notif_iter_status_string(status
),
1714 state_string(state
), state_string(notit
->state
));
1719 * Resets the internal state of a CTF notification iterator.
1722 void bt_notif_iter_reset(struct bt_notif_iter
*notit
)
1725 BT_LOGD("Resetting notification iterator: addr=%p", notit
);
1726 stack_clear(notit
->stack
);
1727 BT_PUT(notit
->meta
.stream_class
);
1728 BT_PUT(notit
->meta
.event_class
);
1729 BT_PUT(notit
->packet
);
1730 BT_PUT(notit
->stream
);
1731 put_all_dscopes(notit
);
1732 notit
->buf
.addr
= NULL
;
1735 notit
->buf
.last_eh_at
= SIZE_MAX
;
1736 notit
->buf
.packet_offset
= 0;
1737 notit
->state
= STATE_INIT
;
1738 notit
->cur_content_size
= -1;
1739 notit
->cur_packet_size
= -1;
1740 notit
->cur_packet_offset
= -1;
1741 notit
->stream_begin_emitted
= false;
1745 int bt_notif_iter_switch_packet(struct bt_notif_iter
*notit
)
1750 * We don't put the stream class here because we need to make
1751 * sure that all the packets processed by the same notification
1752 * iterator refer to the same stream class (the first one).
1755 if (notit
->cur_packet_size
!= -1) {
1756 notit
->cur_packet_offset
+= notit
->cur_packet_size
;
1758 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1759 "packet-offset=%" PRId64
, notit
, notit
->buf
.at
,
1760 notit
->cur_packet_offset
);
1761 stack_clear(notit
->stack
);
1762 BT_PUT(notit
->meta
.event_class
);
1763 BT_PUT(notit
->packet
);
1764 BT_PUT(notit
->cur_timestamp_end
);
1765 put_all_dscopes(notit
);
1768 * Adjust current buffer so that addr points to the beginning of the new
1771 if (notit
->buf
.addr
) {
1772 size_t consumed_bytes
= (size_t) (notit
->buf
.at
/ CHAR_BIT
);
1774 /* Packets are assumed to start on a byte frontier. */
1775 if (notit
->buf
.at
% CHAR_BIT
) {
1776 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1777 "notit-addr=%p, cur=%zu", notit
, notit
->buf
.at
);
1782 notit
->buf
.addr
+= consumed_bytes
;
1783 notit
->buf
.sz
-= consumed_bytes
;
1785 notit
->buf
.packet_offset
= 0;
1786 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1787 notit
->buf
.addr
, notit
->buf
.sz
);
1790 notit
->cur_content_size
= -1;
1791 notit
->cur_packet_size
= -1;
1792 notit
->cur_sc_field_path_cache
= NULL
;
1799 struct bt_field
*get_next_field(struct bt_notif_iter
*notit
)
1801 struct bt_field
*next_field
= NULL
;
1802 struct bt_field
*base_field
;
1803 struct bt_field_type
*base_type
;
1806 BT_ASSERT(!stack_empty(notit
->stack
));
1807 index
= stack_top(notit
->stack
)->index
;
1808 base_field
= stack_top(notit
->stack
)->base
;
1809 BT_ASSERT(base_field
);
1810 base_type
= bt_field_get_type(base_field
);
1811 BT_ASSERT(base_type
);
1813 switch (bt_field_type_get_type_id(base_type
)) {
1814 case BT_FIELD_TYPE_ID_STRUCT
:
1816 next_field
= bt_field_structure_get_field_by_index(
1819 bt_field_type_structure_get_field_by_index(base_type
,
1820 &name
, NULL
, index
);
1823 case BT_FIELD_TYPE_ID_ARRAY
:
1824 next_field
= bt_field_array_get_field(base_field
, index
);
1826 case BT_FIELD_TYPE_ID_SEQUENCE
:
1827 next_field
= bt_field_sequence_get_field(base_field
, index
);
1829 case BT_FIELD_TYPE_ID_VARIANT
:
1830 next_field
= bt_field_variant_get_current_field(base_field
);
1833 BT_LOGF("Unknown base field type ID: "
1834 "notit-addr=%p, ft-addr=%p, ft-id=%s",
1836 bt_field_type_id_string(
1837 bt_field_type_get_type_id(base_type
)));
1846 void update_clock_state(uint64_t *state
,
1847 struct bt_field
*value_field
)
1849 struct bt_field_type
*value_type
= NULL
;
1850 uint64_t requested_new_value
;
1851 uint64_t requested_new_value_mask
;
1852 uint64_t cur_value_masked
;
1853 int requested_new_value_size
;
1856 value_type
= bt_field_get_type(value_field
);
1857 BT_ASSERT(value_type
);
1858 BT_ASSERT(bt_field_type_is_integer(value_type
));
1859 requested_new_value_size
=
1860 bt_field_type_integer_get_size(value_type
);
1861 BT_ASSERT(requested_new_value_size
> 0);
1862 ret
= bt_field_unsigned_integer_get_value(value_field
,
1863 &requested_new_value
);
1867 * Special case for a 64-bit new value, which is the limit
1868 * of a clock value as of this version: overwrite the
1869 * current value directly.
1871 if (requested_new_value_size
== 64) {
1872 *state
= requested_new_value
;
1876 requested_new_value_mask
= (1ULL << requested_new_value_size
) - 1;
1877 cur_value_masked
= *state
& requested_new_value_mask
;
1879 if (requested_new_value
< cur_value_masked
) {
1881 * It looks like a wrap happened on the number of bits
1882 * of the requested new value. Assume that the clock
1883 * value wrapped only one time.
1885 *state
+= requested_new_value_mask
+ 1;
1888 /* Clear the low bits of the current clock value. */
1889 *state
&= ~requested_new_value_mask
;
1891 /* Set the low bits of the current clock value. */
1892 *state
|= requested_new_value
;
1894 BT_LOGV("Updated clock's value from integer field's value: "
1895 "value=%" PRIu64
, *state
);
1900 enum bt_btr_status
update_clock(struct bt_notif_iter
*notit
,
1901 struct bt_field
*int_field
)
1903 gboolean clock_class_found
;
1904 uint64_t *clock_state
= NULL
;
1905 struct bt_field_type
*int_field_type
= NULL
;
1906 enum bt_btr_status ret
= BT_BTR_STATUS_OK
;
1907 struct bt_clock_class
*clock_class
= NULL
;
1909 int_field_type
= bt_field_get_type(int_field
);
1910 BT_ASSERT(int_field_type
);
1911 clock_class
= bt_field_type_integer_get_mapped_clock_class(
1913 if (likely(!clock_class
)) {
1917 clock_class_found
= g_hash_table_lookup_extended(notit
->clock_states
,
1918 clock_class
, NULL
, (gpointer
) &clock_state
);
1919 if (!clock_class_found
) {
1920 clock_state
= g_new0(uint64_t, 1);
1922 BT_LOGE_STR("Failed to allocate a uint64_t.");
1923 ret
= BT_BTR_STATUS_ENOMEM
;
1927 g_hash_table_insert(notit
->clock_states
, bt_get(clock_class
),
1931 /* Update the clock's state. */
1932 BT_LOGV("Updating notification iterator's clock's value from integer field: "
1933 "notit-addr=%p, clock-class-addr=%p, "
1934 "clock-class-name=\"%s\", value=%" PRIu64
,
1936 bt_clock_class_get_name(clock_class
), *clock_state
);
1937 update_clock_state(clock_state
, int_field
);
1939 bt_put(int_field_type
);
1940 bt_put(clock_class
);
1945 enum bt_btr_status
btr_unsigned_int_common(uint64_t value
,
1946 struct bt_field_type
*type
, void *data
,
1947 struct bt_field
**out_int_field
)
1949 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
1950 struct bt_field
*field
= NULL
;
1951 struct bt_field
*int_field
= NULL
;
1952 struct bt_notif_iter
*notit
= data
;
1955 BT_LOGV("Common unsigned integer function called from BTR: "
1956 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
1957 "ft-id=%s, value=%" PRIu64
,
1958 notit
, notit
->btr
, type
,
1959 bt_field_type_id_string(
1960 bt_field_type_get_type_id(type
)),
1963 /* Create next field */
1964 field
= get_next_field(notit
);
1966 BT_LOGW("Cannot get next field: notit-addr=%p", notit
);
1967 status
= BT_BTR_STATUS_ERROR
;
1971 switch(bt_field_type_get_type_id(type
)) {
1972 case BT_FIELD_TYPE_ID_INTEGER
:
1973 /* Integer field is created field */
1974 BT_MOVE(int_field
, field
);
1977 case BT_FIELD_TYPE_ID_ENUM
:
1978 int_field
= bt_field_enumeration_get_container(field
);
1979 BT_ASSERT(int_field
);
1980 type
= bt_field_get_type(int_field
);
1984 BT_LOGF("Unexpected field type ID: "
1985 "notit-addr=%p, ft-addr=%p, ft-id=%s",
1987 bt_field_type_id_string(
1988 bt_field_type_get_type_id(type
)));
1992 BT_ASSERT(int_field
);
1993 ret
= bt_field_unsigned_integer_set_value(int_field
, value
);
1994 BT_ASSERT(ret
== 0);
1995 stack_top(notit
->stack
)->index
++;
1996 *out_int_field
= int_field
;
2005 enum bt_btr_status
btr_timestamp_end_cb(void *value
,
2006 struct bt_field_type
*type
, void *data
)
2008 enum bt_btr_status status
;
2009 struct bt_field
*field
= NULL
;
2010 struct bt_notif_iter
*notit
= data
;
2012 BT_LOGV("`timestamp_end` unsigned integer function called from BTR: "
2013 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2015 notit
, notit
->btr
, type
,
2016 bt_field_type_id_string(
2017 bt_field_type_get_type_id(type
)));
2018 status
= btr_unsigned_int_common(*((uint64_t *) value
), type
, data
,
2021 /* Set as the current packet's timestamp_end field. */
2022 BT_MOVE(notit
->cur_timestamp_end
, field
);
2027 enum bt_btr_status
btr_unsigned_int_cb(uint64_t value
,
2028 struct bt_field_type
*type
, void *data
)
2030 struct bt_notif_iter
*notit
= data
;
2031 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2032 struct bt_field
*field
= NULL
;
2033 struct field_cb_override
*override
;
2035 BT_LOGV("Unsigned integer function called from BTR: "
2036 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2037 "ft-id=%s, value=%" PRIu64
,
2038 notit
, notit
->btr
, type
,
2039 bt_field_type_id_string(
2040 bt_field_type_get_type_id(type
)),
2042 override
= g_hash_table_lookup(notit
->field_overrides
, type
);
2043 if (unlikely(override
)) {
2044 /* Override function logs errors */
2045 status
= override
->func(&value
, type
, override
->data
);
2049 status
= btr_unsigned_int_common(value
, type
, data
, &field
);
2050 if (status
!= BT_BTR_STATUS_OK
) {
2051 /* btr_unsigned_int_common() logs errors */
2055 status
= update_clock(notit
, field
);
2062 enum bt_btr_status
btr_signed_int_cb(int64_t value
,
2063 struct bt_field_type
*type
, void *data
)
2065 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2066 struct bt_field
*field
= NULL
;
2067 struct bt_field
*int_field
= NULL
;
2068 struct bt_notif_iter
*notit
= data
;
2071 BT_LOGV("Signed integer function called from BTR: "
2072 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2073 "ft-id=%s, value=%" PRId64
,
2074 notit
, notit
->btr
, type
,
2075 bt_field_type_id_string(
2076 bt_field_type_get_type_id(type
)),
2079 /* create next field */
2080 field
= get_next_field(notit
);
2082 BT_LOGW("Cannot get next field: notit-addr=%p", notit
);
2083 status
= BT_BTR_STATUS_ERROR
;
2087 switch(bt_field_type_get_type_id(type
)) {
2088 case BT_FIELD_TYPE_ID_INTEGER
:
2089 /* Integer field is created field */
2090 BT_MOVE(int_field
, field
);
2093 case BT_FIELD_TYPE_ID_ENUM
:
2094 int_field
= bt_field_enumeration_get_container(field
);
2095 BT_ASSERT(int_field
);
2096 type
= bt_field_get_type(int_field
);
2100 BT_LOGF("Unexpected field type ID: "
2101 "notit-addr=%p, ft-addr=%p, ft-id=%s",
2103 bt_field_type_id_string(
2104 bt_field_type_get_type_id(type
)));
2108 BT_ASSERT(int_field
);
2109 ret
= bt_field_signed_integer_set_value(int_field
, value
);
2111 stack_top(notit
->stack
)->index
++;
2112 status
= update_clock(notit
, int_field
);
2122 enum bt_btr_status
btr_floating_point_cb(double value
,
2123 struct bt_field_type
*type
, void *data
)
2125 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2126 struct bt_field
*field
= NULL
;
2127 struct bt_notif_iter
*notit
= data
;
2130 BT_LOGV("Floating point number function called from BTR: "
2131 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2132 "ft-id=%s, value=%f",
2133 notit
, notit
->btr
, type
,
2134 bt_field_type_id_string(
2135 bt_field_type_get_type_id(type
)),
2138 /* Create next field */
2139 field
= get_next_field(notit
);
2141 BT_LOGW("Cannot get next field: notit-addr=%p", notit
);
2142 status
= BT_BTR_STATUS_ERROR
;
2146 ret
= bt_field_floating_point_set_value(field
, value
);
2148 stack_top(notit
->stack
)->index
++;
2156 enum bt_btr_status
btr_string_begin_cb(
2157 struct bt_field_type
*type
, void *data
)
2159 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2160 struct bt_field
*field
= NULL
;
2161 struct bt_notif_iter
*notit
= data
;
2164 BT_LOGV("String (beginning) function called from BTR: "
2165 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2167 notit
, notit
->btr
, type
,
2168 bt_field_type_id_string(
2169 bt_field_type_get_type_id(type
)));
2171 /* Create next field */
2172 field
= get_next_field(notit
);
2174 BT_LOGW("Cannot get next field: notit-addr=%p", notit
);
2175 status
= BT_BTR_STATUS_ERROR
;
2180 * Push on stack. Not a compound type per se, but we know that only
2181 * btr_string_cb() may be called between this call and a subsequent
2182 * call to btr_string_end_cb().
2184 ret
= stack_push(notit
->stack
, field
);
2186 BT_LOGE("Cannot push string field on stack: "
2187 "notit-addr=%p, field-addr=%p", notit
, field
);
2188 status
= BT_BTR_STATUS_ERROR
;
2193 * Initialize string field payload to an empty string since in the
2194 * case of a length 0 string the btr_string_cb won't be called and
2195 * we will end up with an unset string payload.
2197 ret
= bt_field_string_set_value(field
, "");
2199 BT_LOGE("Cannot initialize string field's value to an empty string: "
2200 "notit-addr=%p, field-addr=%p, ret=%d",
2202 status
= BT_BTR_STATUS_ERROR
;
2213 enum bt_btr_status
btr_string_cb(const char *value
,
2214 size_t len
, struct bt_field_type
*type
, void *data
)
2216 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2217 struct bt_field
*field
= NULL
;
2218 struct bt_notif_iter
*notit
= data
;
2221 BT_LOGV("String (substring) function called from BTR: "
2222 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2223 "ft-id=%s, string-length=%zu",
2224 notit
, notit
->btr
, type
,
2225 bt_field_type_id_string(
2226 bt_field_type_get_type_id(type
)),
2229 /* Get string field */
2230 field
= stack_top(notit
->stack
)->base
;
2233 /* Append current string */
2234 ret
= bt_field_string_append_len(field
, value
, len
);
2236 BT_LOGE("Cannot append substring to string field's value: "
2237 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2238 "ret=%d", notit
, field
, len
, ret
);
2239 status
= BT_BTR_STATUS_ERROR
;
2248 enum bt_btr_status
btr_string_end_cb(
2249 struct bt_field_type
*type
, void *data
)
2251 struct bt_notif_iter
*notit
= data
;
2253 BT_LOGV("String (end) function called from BTR: "
2254 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2256 notit
, notit
->btr
, type
,
2257 bt_field_type_id_string(
2258 bt_field_type_get_type_id(type
)));
2260 /* Pop string field */
2261 stack_pop(notit
->stack
);
2263 /* Go to next field */
2264 stack_top(notit
->stack
)->index
++;
2265 return BT_BTR_STATUS_OK
;
2268 enum bt_btr_status
btr_compound_begin_cb(
2269 struct bt_field_type
*type
, void *data
)
2271 enum bt_btr_status status
= BT_BTR_STATUS_OK
;
2272 struct bt_notif_iter
*notit
= data
;
2273 struct bt_field
*field
;
2276 BT_LOGV("Compound (beginning) function called from BTR: "
2277 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2279 notit
, notit
->btr
, type
,
2280 bt_field_type_id_string(
2281 bt_field_type_get_type_id(type
)));
2284 if (stack_empty(notit
->stack
)) {
2285 /* Root: create dynamic scope field */
2286 *notit
->cur_dscope_field
= bt_field_create(type
);
2287 field
= *notit
->cur_dscope_field
;
2290 * Field will be put at the end of this function
2291 * (stack_push() will take one reference, but this
2292 * reference is lost upon the equivalent stack_pop()
2293 * later), so also get it for our context to own it.
2295 bt_get(*notit
->cur_dscope_field
);
2298 BT_LOGE("Cannot create compound field: "
2299 "notit-addr=%p, ft-addr=%p, ft-id=%s",
2301 bt_field_type_id_string(
2302 bt_field_type_get_type_id(type
)));
2303 status
= BT_BTR_STATUS_ERROR
;
2307 field
= get_next_field(notit
);
2309 BT_LOGW("Cannot get next field: notit-addr=%p", notit
);
2310 status
= BT_BTR_STATUS_ERROR
;
2317 ret
= stack_push(notit
->stack
, field
);
2319 BT_LOGE("Cannot push compound field onto the stack: "
2320 "notit-addr=%p, ft-addr=%p, ft-id=%s, ret=%d",
2322 bt_field_type_id_string(
2323 bt_field_type_get_type_id(type
)),
2325 status
= BT_BTR_STATUS_ERROR
;
2335 enum bt_btr_status
btr_compound_end_cb(
2336 struct bt_field_type
*type
, void *data
)
2338 struct bt_notif_iter
*notit
= data
;
2340 BT_LOGV("Compound (end) function called from BTR: "
2341 "notit-addr=%p, btr-addr=%p, ft-addr=%p, "
2343 notit
, notit
->btr
, type
,
2344 bt_field_type_id_string(
2345 bt_field_type_get_type_id(type
)));
2346 BT_ASSERT(!stack_empty(notit
->stack
));
2349 stack_pop(notit
->stack
);
2351 /* If the stack is not empty, increment the base's index */
2352 if (!stack_empty(notit
->stack
)) {
2353 stack_top(notit
->stack
)->index
++;
2356 return BT_BTR_STATUS_OK
;
2360 struct bt_field
*resolve_field(struct bt_notif_iter
*notit
,
2361 struct bt_field_path
*path
)
2363 struct bt_field
*field
= NULL
;
2366 if (BT_LOG_ON_VERBOSE
) {
2367 GString
*gstr
= bt_field_path_string(path
);
2369 BT_LOGV("Resolving field path: notit-addr=%p, field-path=\"%s\"",
2370 notit
, gstr
? gstr
->str
: NULL
);
2373 g_string_free(gstr
, TRUE
);
2377 switch (bt_field_path_get_root_scope(path
)) {
2378 case BT_SCOPE_TRACE_PACKET_HEADER
:
2379 field
= notit
->dscopes
.trace_packet_header
;
2381 case BT_SCOPE_STREAM_PACKET_CONTEXT
:
2382 field
= notit
->dscopes
.stream_packet_context
;
2384 case BT_SCOPE_STREAM_EVENT_HEADER
:
2385 field
= notit
->dscopes
.stream_event_header
;
2387 case BT_SCOPE_STREAM_EVENT_CONTEXT
:
2388 field
= notit
->dscopes
.stream_event_context
;
2390 case BT_SCOPE_EVENT_CONTEXT
:
2391 field
= notit
->dscopes
.event_context
;
2393 case BT_SCOPE_EVENT_FIELDS
:
2394 field
= notit
->dscopes
.event_payload
;
2397 BT_LOGF("Cannot resolve field path: unknown scope: "
2398 "notit-addr=%p, root-scope=%s",
2399 notit
, bt_scope_string(
2400 bt_field_path_get_root_scope(path
)));
2405 BT_LOGW("Cannot resolve field path: root field not found: "
2406 "notit-addr=%p, root-scope=%s",
2407 notit
, bt_scope_string(
2408 bt_field_path_get_root_scope(path
)));
2414 for (i
= 0; i
< bt_field_path_get_index_count(path
); ++i
) {
2415 struct bt_field
*next_field
= NULL
;
2416 struct bt_field_type
*field_type
;
2417 int index
= bt_field_path_get_index(path
, i
);
2419 field_type
= bt_field_get_type(field
);
2420 BT_ASSERT(field_type
);
2422 if (is_struct_type(field_type
)) {
2423 next_field
= bt_field_structure_get_field_by_index(
2425 } else if (is_variant_type(field_type
)) {
2427 bt_field_variant_get_current_field(field
);
2434 BT_LOGW("Cannot find next field: "
2435 "notit-addr=%p, ft-addr=%p, ft-id=%s, index=%d",
2437 bt_field_type_id_string(
2438 bt_field_type_get_type_id(field_type
)),
2443 /* Move next field -> field */
2444 BT_MOVE(field
, next_field
);
2452 int64_t btr_get_sequence_length_cb(struct bt_field_type
*type
, void *data
)
2456 struct bt_field
*seq_field
;
2457 struct bt_field_path
*field_path
;
2458 struct bt_notif_iter
*notit
= data
;
2459 struct bt_field
*length_field
= NULL
;
2462 field_path
= bt_field_type_sequence_get_length_field_path(type
);
2463 BT_ASSERT(field_path
);
2464 length_field
= resolve_field(notit
, field_path
);
2465 if (!length_field
) {
2466 BT_LOGW("Cannot resolve sequence field type's length field path: "
2467 "notit-addr=%p, ft-addr=%p",
2472 iret
= bt_field_unsigned_integer_get_value(length_field
, &length
);
2474 BT_LOGE("Cannot get value of sequence length field: "
2475 "notit-addr=%p, field-addr=%p",
2476 notit
, length_field
);
2480 seq_field
= stack_top(notit
->stack
)->base
;
2481 iret
= bt_field_sequence_set_length(seq_field
, length_field
);
2483 BT_LOGE("Cannot set sequence field's length field: "
2484 "notit-addr=%p, seq-field-addr=%p, "
2485 "length-field-addr=%p, ",
2486 notit
, seq_field
, length_field
);
2490 ret
= (int64_t) length
;
2493 BT_PUT(length_field
);
2500 struct bt_field_type
*btr_get_variant_type_cb(
2501 struct bt_field_type
*type
, void *data
)
2503 struct bt_field_path
*path
;
2504 struct bt_notif_iter
*notit
= data
;
2505 struct bt_field
*var_field
;
2506 struct bt_field
*tag_field
= NULL
;
2507 struct bt_field
*selected_field
= NULL
;
2508 struct bt_field_type
*selected_field_type
= NULL
;
2510 path
= bt_field_type_variant_get_tag_field_path(type
);
2512 tag_field
= resolve_field(notit
, path
);
2514 BT_LOGW("Cannot resolve variant field type's tag field path: "
2515 "notit-addr=%p, ft-addr=%p",
2521 * We found the enumeration tag field instance which should be
2522 * able to select a current field for this variant. This
2523 * callback function we're in is called _after_
2524 * compound_begin(), so the current stack top's base field is
2525 * the variant field in question. We get the selected field here
2526 * thanks to this tag field (thus creating the selected field),
2527 * which will also provide us with its type. Then, this field
2528 * will remain the current selected one until the next callback
2529 * function call which is used to fill the current selected
2532 var_field
= stack_top(notit
->stack
)->base
;
2533 selected_field
= bt_field_variant_get_field(var_field
, tag_field
);
2534 if (!selected_field
) {
2535 BT_LOGW("Cannot get variant field's selection using tag field: "
2536 "notit-addr=%p, var-field-addr=%p, tag-field-addr=%p",
2537 notit
, var_field
, tag_field
);
2541 selected_field_type
= bt_field_get_type(selected_field
);
2545 BT_PUT(selected_field
);
2548 return selected_field_type
;
2552 int set_event_clocks(struct bt_event
*event
,
2553 struct bt_notif_iter
*notit
)
2556 GHashTableIter iter
;
2557 struct bt_clock_class
*clock_class
;
2558 uint64_t *clock_state
;
2560 g_hash_table_iter_init(&iter
, notit
->clock_states
);
2562 while (g_hash_table_iter_next(&iter
, (gpointer
) &clock_class
,
2563 (gpointer
) &clock_state
)) {
2564 struct bt_clock_value
*clock_value
;
2566 clock_value
= bt_clock_value_create(clock_class
,
2569 BT_LOGE("Cannot create clock value from clock class: "
2570 "notit-addr=%p, clock-class-addr=%p, "
2571 "clock-class-name=\"%s\"",
2573 bt_clock_class_get_name(clock_class
));
2577 ret
= bt_event_set_clock_value(event
, clock_value
);
2578 bt_put(clock_value
);
2580 struct bt_event_class
*event_class
=
2581 bt_event_get_class(event
);
2583 BT_ASSERT(event_class
);
2584 BT_LOGE("Cannot set event's clock value: "
2585 "notit-addr=%p, event-addr=%p, "
2586 "event-class-name=\"%s\", "
2587 "event-class-id=%" PRId64
", "
2588 "clock-class-addr=%p, "
2589 "clock-class-name=\"%s\", "
2590 "clock-value-addr=%p",
2592 bt_event_class_get_name(event_class
),
2593 bt_event_class_get_id(event_class
),
2595 bt_clock_class_get_name(clock_class
),
2597 bt_put(event_class
);
2608 struct bt_event
*create_event(struct bt_notif_iter
*notit
)
2611 struct bt_event
*event
;
2613 BT_LOGV("Creating event for event notification: "
2614 "notit-addr=%p, event-class-addr=%p, "
2615 "event-class-name=\"%s\", "
2616 "event-class-id=%" PRId64
,
2617 notit
, notit
->meta
.event_class
,
2618 bt_event_class_get_name(notit
->meta
.event_class
),
2619 bt_event_class_get_id(notit
->meta
.event_class
));
2621 /* Create event object. */
2622 event
= bt_event_create(notit
->meta
.event_class
);
2624 BT_LOGE("Cannot create event: "
2625 "notit-addr=%p, event-class-addr=%p, "
2626 "event-class-name=\"%s\", "
2627 "event-class-id=%" PRId64
,
2628 notit
, notit
->meta
.event_class
,
2629 bt_event_class_get_name(notit
->meta
.event_class
),
2630 bt_event_class_get_id(notit
->meta
.event_class
));
2634 /* Set header, stream event context, context, and payload fields. */
2635 ret
= bt_event_set_header(event
,
2636 notit
->dscopes
.stream_event_header
);
2638 BT_LOGE("Cannot set event's header field: "
2639 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2640 "event-class-name=\"%s\", "
2641 "event-class-id=%" PRId64
", field-addr=%p",
2642 notit
, event
, notit
->meta
.event_class
,
2643 bt_event_class_get_name(notit
->meta
.event_class
),
2644 bt_event_class_get_id(notit
->meta
.event_class
),
2645 notit
->dscopes
.stream_event_header
);
2649 ret
= bt_event_set_stream_event_context(event
,
2650 notit
->dscopes
.stream_event_context
);
2652 BT_LOGE("Cannot set event's context field: "
2653 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2654 "event-class-name=\"%s\", "
2655 "event-class-id=%" PRId64
", field-addr=%p",
2656 notit
, event
, notit
->meta
.event_class
,
2657 bt_event_class_get_name(notit
->meta
.event_class
),
2658 bt_event_class_get_id(notit
->meta
.event_class
),
2659 notit
->dscopes
.stream_event_context
);
2663 ret
= bt_event_set_event_context(event
,
2664 notit
->dscopes
.event_context
);
2666 BT_LOGE("Cannot set event's stream event context field: "
2667 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2668 "event-class-name=\"%s\", "
2669 "event-class-id=%" PRId64
", field-addr=%p",
2670 notit
, event
, notit
->meta
.event_class
,
2671 bt_event_class_get_name(notit
->meta
.event_class
),
2672 bt_event_class_get_id(notit
->meta
.event_class
),
2673 notit
->dscopes
.event_context
);
2677 ret
= bt_event_set_event_payload(event
,
2678 notit
->dscopes
.event_payload
);
2680 BT_LOGE("Cannot set event's payload field: "
2681 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2682 "event-class-name=\"%s\", "
2683 "event-class-id=%" PRId64
", field-addr=%p",
2684 notit
, event
, notit
->meta
.event_class
,
2685 bt_event_class_get_name(notit
->meta
.event_class
),
2686 bt_event_class_get_id(notit
->meta
.event_class
),
2687 notit
->dscopes
.event_payload
);
2691 ret
= set_event_clocks(event
, notit
);
2693 BT_LOGE("Cannot set event's clock values: "
2694 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2695 "event-class-name=\"%s\", "
2696 "event-class-id=%" PRId64
,
2697 notit
, event
, notit
->meta
.event_class
,
2698 bt_event_class_get_name(notit
->meta
.event_class
),
2699 bt_event_class_get_id(notit
->meta
.event_class
));
2703 /* Associate with current packet. */
2704 BT_ASSERT(notit
->packet
);
2705 ret
= bt_event_set_packet(event
, notit
->packet
);
2707 BT_LOGE("Cannot set event's header field: "
2708 "notit-addr=%p, event-addr=%p, event-class-addr=%p, "
2709 "event-class-name=\"%s\", "
2710 "event-class-id=%" PRId64
", packet-addr=%p",
2711 notit
, event
, notit
->meta
.event_class
,
2712 bt_event_class_get_name(notit
->meta
.event_class
),
2713 bt_event_class_get_id(notit
->meta
.event_class
),
2728 uint64_t get_cur_stream_instance_id(struct bt_notif_iter
*notit
)
2730 struct bt_field
*stream_instance_id_field
= NULL
;
2731 uint64_t stream_instance_id
= -1ULL;
2734 if (!notit
->dscopes
.trace_packet_header
) {
2738 stream_instance_id_field
= bt_field_structure_get_field_by_name(
2739 notit
->dscopes
.trace_packet_header
, "stream_instance_id");
2740 if (!stream_instance_id_field
) {
2744 ret
= bt_field_unsigned_integer_get_value(stream_instance_id_field
,
2745 &stream_instance_id
);
2747 stream_instance_id
= -1ULL;
2752 bt_put(stream_instance_id_field
);
2753 return stream_instance_id
;
2757 int set_stream(struct bt_notif_iter
*notit
)
2760 struct bt_stream
*stream
= NULL
;
2762 BT_LOGV("Calling user function (get stream): notit-addr=%p, "
2763 "stream-class-addr=%p, stream-class-name=\"%s\", "
2764 "stream-class-id=%" PRId64
,
2765 notit
, notit
->meta
.stream_class
,
2766 bt_stream_class_get_name(notit
->meta
.stream_class
),
2767 bt_stream_class_get_id(notit
->meta
.stream_class
));
2768 stream
= bt_get(notit
->medium
.medops
.get_stream(
2769 notit
->meta
.stream_class
, get_cur_stream_instance_id(notit
),
2770 notit
->medium
.data
));
2771 BT_LOGV("User function returned: stream-addr=%p", stream
);
2773 BT_LOGW_STR("User function failed to return a stream object for the given stream class.");
2778 if (notit
->stream
&& stream
!= notit
->stream
) {
2779 BT_LOGW("User function returned a different stream than the previous one for the same sequence of packets.");
2784 BT_MOVE(notit
->stream
, stream
);
2792 void create_packet(struct bt_notif_iter
*notit
)
2795 struct bt_packet
*packet
= NULL
;
2797 BT_LOGV("Creating packet for packet notification: "
2798 "notit-addr=%p", notit
);
2799 BT_LOGV("Creating packet from stream: "
2800 "notit-addr=%p, stream-addr=%p, "
2801 "stream-class-addr=%p, "
2802 "stream-class-name=\"%s\", "
2803 "stream-class-id=%" PRId64
,
2804 notit
, notit
->stream
, notit
->meta
.stream_class
,
2805 bt_stream_class_get_name(notit
->meta
.stream_class
),
2806 bt_stream_class_get_id(notit
->meta
.stream_class
));
2809 BT_ASSERT(notit
->stream
);
2810 packet
= bt_packet_create(notit
->stream
);
2812 BT_LOGE("Cannot create packet from stream: "
2813 "notit-addr=%p, stream-addr=%p, "
2814 "stream-class-addr=%p, "
2815 "stream-class-name=\"%s\", "
2816 "stream-class-id=%" PRId64
,
2817 notit
, notit
->stream
, notit
->meta
.stream_class
,
2818 bt_stream_class_get_name(notit
->meta
.stream_class
),
2819 bt_stream_class_get_id(notit
->meta
.stream_class
));
2823 /* Set packet's context and header fields */
2824 if (notit
->dscopes
.trace_packet_header
) {
2825 ret
= bt_packet_set_header(packet
,
2826 notit
->dscopes
.trace_packet_header
);
2828 BT_LOGE("Cannot set packet's header field: "
2829 "notit-addr=%p, packet-addr=%p, "
2831 "stream-class-addr=%p, "
2832 "stream-class-name=\"%s\", "
2833 "stream-class-id=%" PRId64
", "
2835 notit
, packet
, notit
->stream
, notit
->meta
.stream_class
,
2836 bt_stream_class_get_name(notit
->meta
.stream_class
),
2837 bt_stream_class_get_id(notit
->meta
.stream_class
),
2838 notit
->dscopes
.trace_packet_header
);
2843 if (notit
->dscopes
.stream_packet_context
) {
2844 ret
= bt_packet_set_context(packet
,
2845 notit
->dscopes
.stream_packet_context
);
2847 BT_LOGE("Cannot set packet's context field: "
2848 "notit-addr=%p, packet-addr=%p, "
2850 "stream-class-addr=%p, "
2851 "stream-class-name=\"%s\", "
2852 "stream-class-id=%" PRId64
", "
2854 notit
, packet
, notit
->stream
, notit
->meta
.stream_class
,
2855 bt_stream_class_get_name(notit
->meta
.stream_class
),
2856 bt_stream_class_get_id(notit
->meta
.stream_class
),
2857 notit
->dscopes
.trace_packet_header
);
2868 BT_MOVE(notit
->packet
, packet
);
2872 void notify_new_stream(struct bt_notif_iter
*notit
,
2873 struct bt_notification
**notification
)
2875 struct bt_notification
*ret
= NULL
;
2878 /* Ask the user for the stream */
2879 iret
= set_stream(notit
);
2884 BT_ASSERT(notit
->stream
);
2885 ret
= bt_notification_stream_begin_create(notit
->stream
);
2887 BT_LOGE("Cannot create stream beginning notification: "
2888 "notit-addr=%p, stream-addr=%p",
2889 notit
, notit
->stream
);
2894 *notification
= ret
;
2898 void notify_end_of_stream(struct bt_notif_iter
*notit
,
2899 struct bt_notification
**notification
)
2901 struct bt_notification
*ret
;
2903 if (!notit
->stream
) {
2904 BT_LOGE("Cannot create stream for stream notification: "
2905 "notit-addr=%p", notit
);
2909 ret
= bt_notification_stream_end_create(notit
->stream
);
2911 BT_LOGE("Cannot create stream beginning notification: "
2912 "notit-addr=%p, stream-addr=%p",
2913 notit
, notit
->stream
);
2916 *notification
= ret
;
2920 void notify_new_packet(struct bt_notif_iter
*notit
,
2921 struct bt_notification
**notification
)
2923 struct bt_notification
*ret
;
2925 /* Initialize the iterator's current packet */
2926 create_packet(notit
);
2927 if (!notit
->packet
) {
2928 BT_LOGE("Cannot create packet for packet notification: "
2929 "notit-addr=%p", notit
);
2933 ret
= bt_notification_packet_begin_create(notit
->packet
);
2935 BT_LOGE("Cannot create packet beginning notification: "
2936 "notit-addr=%p, packet-addr=%p",
2937 notit
, notit
->packet
);
2940 *notification
= ret
;
2944 void notify_end_of_packet(struct bt_notif_iter
*notit
,
2945 struct bt_notification
**notification
)
2947 struct bt_notification
*ret
;
2949 if (!notit
->packet
) {
2953 ret
= bt_notification_packet_end_create(notit
->packet
);
2955 BT_LOGE("Cannot create packet end notification: "
2956 "notit-addr=%p, packet-addr=%p",
2957 notit
, notit
->packet
);
2960 BT_PUT(notit
->packet
);
2961 *notification
= ret
;
2965 void notify_event(struct bt_notif_iter
*notit
,
2966 struct bt_clock_class_priority_map
*cc_prio_map
,
2967 struct bt_notification
**notification
)
2969 struct bt_event
*event
= NULL
;
2970 struct bt_notification
*ret
= NULL
;
2972 /* Make sure that the event contains at least one bit of data */
2973 if (notit
->buf
.at
== notit
->buf
.last_eh_at
) {
2974 BT_LOGE("Cannot create empty event with 0 bits of data: "
2975 "notit-addr=%p, packet-cur=%zu",
2976 notit
, packet_at(notit
));
2981 event
= create_event(notit
);
2983 BT_LOGE("Cannot create event for event notification: "
2984 "notit-addr=%p", notit
);
2988 ret
= bt_notification_event_create(event
, cc_prio_map
);
2990 BT_LOGE("Cannot create event notification: "
2991 "notit-addr=%p, event-addr=%p, "
2992 "cc-prio-map-addr=%p",
2993 notit
, event
, cc_prio_map
);
2996 *notification
= ret
;
3002 void init_trace_field_path_cache(struct bt_trace
*trace
,
3003 struct trace_field_path_cache
*trace_field_path_cache
)
3006 int stream_instance_id
= -1;
3008 struct bt_field_type
*packet_header
= NULL
;
3010 packet_header
= bt_trace_get_packet_header_type(trace
);
3011 if (!packet_header
) {
3015 if (!bt_field_type_is_structure(packet_header
)) {
3019 count
= bt_field_type_structure_get_field_count(packet_header
);
3020 BT_ASSERT(count
>= 0);
3022 for (i
= 0; (i
< count
&& (stream_id
== -1 || stream_instance_id
== -1)); i
++) {
3024 const char *field_name
;
3026 ret
= bt_field_type_structure_get_field_by_index(packet_header
,
3027 &field_name
, NULL
, i
);
3029 BT_LOGE("Cannot get structure field's field: "
3030 "field-addr=%p, index=%d",
3035 if (stream_id
== -1 && !strcmp(field_name
, "stream_id")) {
3037 } else if (stream_instance_id
== -1 &&
3038 !strcmp(field_name
, "stream_instance_id")) {
3039 stream_instance_id
= i
;
3044 trace_field_path_cache
->stream_id
= stream_id
;
3045 trace_field_path_cache
->stream_instance_id
= stream_instance_id
;
3046 BT_PUT(packet_header
);
3050 struct bt_notif_iter
*bt_notif_iter_create(struct bt_trace
*trace
,
3051 size_t max_request_sz
,
3052 struct bt_notif_iter_medium_ops medops
, void *data
)
3054 struct bt_notif_iter
*notit
= NULL
;
3055 struct bt_btr_cbs cbs
= {
3057 .signed_int
= btr_signed_int_cb
,
3058 .unsigned_int
= btr_unsigned_int_cb
,
3059 .floating_point
= btr_floating_point_cb
,
3060 .string_begin
= btr_string_begin_cb
,
3061 .string
= btr_string_cb
,
3062 .string_end
= btr_string_end_cb
,
3063 .compound_begin
= btr_compound_begin_cb
,
3064 .compound_end
= btr_compound_end_cb
,
3067 .get_sequence_length
= btr_get_sequence_length_cb
,
3068 .get_variant_type
= btr_get_variant_type_cb
,
3073 BT_ASSERT(medops
.request_bytes
);
3074 BT_ASSERT(medops
.get_stream
);
3075 BT_LOGD("Creating CTF plugin notification iterator: "
3076 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
3078 trace
, bt_trace_get_name(trace
), max_request_sz
, data
);
3079 notit
= g_new0(struct bt_notif_iter
, 1);
3081 BT_LOGE_STR("Failed to allocate one CTF plugin notification iterator.");
3084 notit
->clock_states
= g_hash_table_new_full(g_direct_hash
,
3085 g_direct_equal
, bt_put
, g_free
);
3086 if (!notit
->clock_states
) {
3087 BT_LOGE_STR("Failed to allocate a GHashTable.");
3090 notit
->meta
.trace
= bt_get(trace
);
3091 notit
->medium
.medops
= medops
;
3092 notit
->medium
.max_request_sz
= max_request_sz
;
3093 notit
->medium
.data
= data
;
3094 notit
->stack
= stack_new(notit
);
3095 if (!notit
->stack
) {
3096 BT_LOGE_STR("Failed to create field stack.");
3100 notit
->btr
= bt_btr_create(cbs
, notit
);
3102 BT_LOGE_STR("Failed to create binary type reader (BTR).");
3106 bt_notif_iter_reset(notit
);
3107 init_trace_field_path_cache(trace
, ¬it
->trace_field_path_cache
);
3108 notit
->sc_field_path_caches
= g_hash_table_new_full(g_direct_hash
,
3109 g_direct_equal
, bt_put
, g_free
);
3110 if (!notit
->sc_field_path_caches
) {
3111 BT_LOGE_STR("Failed to allocate a GHashTable.");
3115 notit
->field_overrides
= g_hash_table_new_full(g_direct_hash
,
3116 g_direct_equal
, bt_put
, g_free
);
3117 if (!notit
->field_overrides
) {
3118 BT_LOGE_STR("Failed to allocate a GHashTable.");
3122 BT_LOGD("Created CTF plugin notification iterator: "
3123 "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
3124 "data=%p, notit-addr=%p",
3125 trace
, bt_trace_get_name(trace
), max_request_sz
, data
,
3127 notit
->cur_packet_offset
= 0;
3133 bt_notif_iter_destroy(notit
);
3138 void bt_notif_iter_destroy(struct bt_notif_iter
*notit
)
3140 BT_PUT(notit
->meta
.trace
);
3141 BT_PUT(notit
->meta
.stream_class
);
3142 BT_PUT(notit
->meta
.event_class
);
3143 BT_PUT(notit
->packet
);
3144 BT_PUT(notit
->stream
);
3145 BT_PUT(notit
->cur_timestamp_end
);
3146 put_all_dscopes(notit
);
3148 BT_LOGD("Destroying CTF plugin notification iterator: addr=%p", notit
);
3151 BT_LOGD_STR("Destroying field stack.");
3152 stack_destroy(notit
->stack
);
3156 BT_LOGD("Destroying BTR: btr-addr=%p", notit
->btr
);
3157 bt_btr_destroy(notit
->btr
);
3160 if (notit
->clock_states
) {
3161 g_hash_table_destroy(notit
->clock_states
);
3164 if (notit
->sc_field_path_caches
) {
3165 g_hash_table_destroy(notit
->sc_field_path_caches
);
3168 if (notit
->field_overrides
) {
3169 g_hash_table_destroy(notit
->field_overrides
);
3175 enum bt_notif_iter_status
bt_notif_iter_get_next_notification(
3176 struct bt_notif_iter
*notit
,
3177 struct bt_clock_class_priority_map
*cc_prio_map
,
3178 struct bt_notification
**notification
)
3180 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
3183 BT_ASSERT(notification
);
3185 if (notit
->state
== STATE_DONE
) {
3186 status
= BT_NOTIF_ITER_STATUS_EOF
;
3190 BT_LOGV("Getting next notification: notit-addr=%p, cc-prio-map-addr=%p",
3191 notit
, cc_prio_map
);
3194 status
= handle_state(notit
);
3195 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
3196 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
3199 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
3200 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
3201 enum state next_state
= notit
->state
;
3203 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
3205 if (notit
->packet
) {
3206 notify_end_of_packet(notit
, notification
);
3208 notify_end_of_stream(notit
, notification
);
3209 next_state
= STATE_DONE
;
3212 if (!*notification
) {
3213 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3217 status
= BT_NOTIF_ITER_STATUS_OK
;
3218 notit
->state
= next_state
;
3221 BT_LOGW("Cannot handle state: "
3222 "notit-addr=%p, state=%s",
3223 notit
, state_string(notit
->state
));
3228 switch (notit
->state
) {
3229 case STATE_EMIT_NOTIF_NEW_STREAM
:
3230 /* notify_new_stream() logs errors */
3231 notify_new_stream(notit
, notification
);
3232 if (!*notification
) {
3233 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3235 notit
->stream_begin_emitted
= true;
3237 case STATE_EMIT_NOTIF_NEW_PACKET
:
3238 /* notify_new_packet() logs errors */
3239 notify_new_packet(notit
, notification
);
3240 if (!*notification
) {
3241 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3244 case STATE_EMIT_NOTIF_EVENT
:
3245 /* notify_event() logs errors */
3246 notify_event(notit
, cc_prio_map
, notification
);
3247 if (!*notification
) {
3248 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3251 case STATE_EMIT_NOTIF_END_OF_PACKET
:
3252 /* Update clock with timestamp_end field. */
3253 if (notit
->cur_timestamp_end
) {
3254 enum bt_btr_status btr_status
;
3255 struct bt_field_type
*field_type
=
3257 notit
->cur_timestamp_end
);
3259 BT_ASSERT(field_type
);
3260 btr_status
= update_clock(notit
,
3261 notit
->cur_timestamp_end
);
3263 if (btr_status
!= BT_BTR_STATUS_OK
) {
3264 BT_LOGW("Cannot update stream's clock value: "
3265 "notit-addr=%p", notit
);
3266 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3271 /* notify_end_of_packet() logs errors */
3272 notify_end_of_packet(notit
, notification
);
3273 if (!*notification
) {
3274 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3278 /* Non-emitting state: continue */
3288 enum bt_notif_iter_status
bt_notif_iter_get_packet_header_context_fields(
3289 struct bt_notif_iter
*notit
,
3290 struct bt_field
**packet_header_field
,
3291 struct bt_field
**packet_context_field
)
3294 enum bt_notif_iter_status status
= BT_NOTIF_ITER_STATUS_OK
;
3298 if (notit
->state
== STATE_EMIT_NOTIF_NEW_PACKET
) {
3299 /* We're already there */
3304 status
= handle_state(notit
);
3305 if (status
== BT_NOTIF_ITER_STATUS_AGAIN
) {
3306 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
3309 if (status
!= BT_NOTIF_ITER_STATUS_OK
) {
3310 if (status
== BT_NOTIF_ITER_STATUS_EOF
) {
3311 BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
3313 BT_LOGW("Cannot handle state: "
3314 "notit-addr=%p, state=%s",
3315 notit
, state_string(notit
->state
));
3320 switch (notit
->state
) {
3321 case STATE_EMIT_NOTIF_NEW_PACKET
:
3323 * Packet header and context fields are
3324 * potentially decoded (or they don't exist).
3328 case STATE_EMIT_NOTIF_NEW_STREAM
:
3329 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN
:
3330 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE
:
3331 case STATE_AFTER_TRACE_PACKET_HEADER
:
3332 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN
:
3333 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE
:
3334 case STATE_AFTER_STREAM_PACKET_CONTEXT
:
3335 /* Non-emitting state: continue */
3339 * We should never get past the
3340 * STATE_EMIT_NOTIF_NEW_PACKET state.
3342 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
3343 notit
, state_string(notit
->state
));
3349 if (packet_header_field
) {
3350 *packet_header_field
= bt_get(notit
->dscopes
.trace_packet_header
);
3353 if (packet_context_field
) {
3354 *packet_context_field
= bt_get(notit
->dscopes
.stream_packet_context
);
3357 ret
= set_current_packet_content_sizes(notit
);
3359 status
= BT_NOTIF_ITER_STATUS_ERROR
;
3367 void bt_notif_iter_set_medops_data(struct bt_notif_iter
*notit
,
3371 notit
->medium
.data
= medops_data
;
3375 enum bt_notif_iter_status
bt_notif_iter_seek(
3376 struct bt_notif_iter
*notit
, off_t offset
)
3378 enum bt_notif_iter_status ret
= BT_NOTIF_ITER_STATUS_OK
;
3379 enum bt_notif_iter_medium_status medium_status
;
3383 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset
);
3384 ret
= BT_NOTIF_ITER_STATUS_INVAL
;
3388 if (!notit
->medium
.medops
.seek
) {
3389 ret
= BT_NOTIF_ITER_STATUS_UNSUPPORTED
;
3390 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
3394 medium_status
= notit
->medium
.medops
.seek(
3395 BT_NOTIF_ITER_SEEK_WHENCE_SET
, offset
,
3396 notit
->medium
.data
);
3397 if (medium_status
!= BT_NOTIF_ITER_MEDIUM_STATUS_OK
) {
3398 if (medium_status
== BT_NOTIF_ITER_MEDIUM_STATUS_EOF
) {
3399 ret
= BT_NOTIF_ITER_STATUS_EOF
;
3401 ret
= BT_NOTIF_ITER_STATUS_ERROR
;
3406 bt_notif_iter_reset(notit
);
3407 notit
->cur_packet_offset
= offset
;
3413 off_t
bt_notif_iter_get_current_packet_offset(
3414 struct bt_notif_iter
*notit
)
3417 return notit
->cur_packet_offset
;
3421 off_t
bt_notif_iter_get_current_packet_size(
3422 struct bt_notif_iter
*notit
)
3425 return notit
->cur_packet_size
;