projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
`ctf` plugin: infer packet's total size from packet's content size
[babeltrace.git] / plugins / ctf / common / msg-iter / msg-iter.c
1 /*
2 * Babeltrace - CTF message iterator
3 *
4 * Copyright (c) 2015-2018 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
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
23 * SOFTWARE.
24 */
25
26 #define BT_LOG_TAG "PLUGIN-CTF-MSG-ITER"
27 #include "logging.h"
28
29 #include <stdint.h>
30 #include <inttypes.h>
31 #include <stdio.h>
32 #include <stddef.h>
33 #include <stdbool.h>
34 #include <babeltrace/assert-internal.h>
35 #include <string.h>
36 #include <babeltrace/babeltrace.h>
37 #include <babeltrace/common-internal.h>
38 #include <glib.h>
39 #include <stdlib.h>
40
41 #include "msg-iter.h"
42 #include "../bfcr/bfcr.h"
43
44 struct bt_msg_iter;
45
46 /* A visit stack entry */
47 struct stack_entry {
48 /*
49 * Current base field, one of:
50 *
51 * * string
52 * * structure
53 * * array
54 * * sequence
55 * * variant
56 *
57 * Field is borrowed.
58 */
59 bt_field *base;
60
61 /* Index of next field to set */
62 size_t index;
63 };
64
65 /* Visit stack */
66 struct stack {
67 /* Entries (struct stack_entry) */
68 GArray *entries;
69
70 /* Number of active entries */
71 size_t size;
72 };
73
74 /* State */
75 enum state {
76 STATE_INIT,
77 STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN,
78 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE,
79 STATE_AFTER_TRACE_PACKET_HEADER,
80 STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN,
81 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE,
82 STATE_AFTER_STREAM_PACKET_CONTEXT,
83 STATE_CHECK_EMIT_MSG_STREAM_BEGINNING,
84 STATE_EMIT_MSG_STREAM_BEGINNING,
85 STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING,
86 STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS,
87 STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS,
88 STATE_EMIT_MSG_DISCARDED_EVENTS,
89 STATE_EMIT_MSG_DISCARDED_PACKETS,
90 STATE_EMIT_MSG_PACKET_BEGINNING,
91 STATE_DSCOPE_EVENT_HEADER_BEGIN,
92 STATE_DSCOPE_EVENT_HEADER_CONTINUE,
93 STATE_AFTER_EVENT_HEADER,
94 STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN,
95 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE,
96 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN,
97 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE,
98 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN,
99 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE,
100 STATE_EMIT_MSG_EVENT,
101 STATE_SKIP_PACKET_PADDING,
102 STATE_EMIT_MSG_PACKET_END_MULTI,
103 STATE_EMIT_MSG_PACKET_END_SINGLE,
104 STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END,
105 STATE_EMIT_MSG_STREAM_ACTIVITY_END,
106 STATE_EMIT_MSG_STREAM_END,
107 STATE_DONE,
108 };
109
110 struct end_of_packet_snapshots {
111 uint64_t discarded_events;
112 uint64_t packets;
113 uint64_t beginning_clock;
114 uint64_t end_clock;
115 };
116
117 /* CTF message iterator */
118 struct bt_msg_iter {
119 /* Visit stack */
120 struct stack *stack;
121
122 /* Current message iterator to create messages (weak) */
123 bt_self_message_iterator *msg_iter;
124
125 /*
126 * True to emit stream beginning and stream activity beginning
127 * messages.
128 */
129 bool emit_stream_begin_msg;
130
131 /* True to emit stream end and stream activity end messages */
132 bool emit_stream_end_msg;
133
134 /* True to set the stream */
135 bool set_stream;
136
137 /*
138 * Current dynamic scope field pointer.
139 *
140 * This is set by read_dscope_begin_state() and contains the
141 * value of one of the pointers in `dscopes` below.
142 */
143 bt_field *cur_dscope_field;
144
145 /*
146 * True if we're done filling a string field from a text
147 * array/sequence payload.
148 */
149 bool done_filling_string;
150
151 /* Trace and classes */
152 /* True to set IR fields */
153 bool set_ir_fields;
154
155 struct {
156 struct ctf_trace_class *tc;
157 struct ctf_stream_class *sc;
158 struct ctf_event_class *ec;
159 } meta;
160
161 /* Current packet context field wrapper (NULL if not created yet) */
162 bt_packet_context_field *packet_context_field;
163
164 /* Current packet (NULL if not created yet) */
165 bt_packet *packet;
166
167 /* Current stream (NULL if not set yet) */
168 bt_stream *stream;
169
170 /* Current event (NULL if not created yet) */
171 bt_event *event;
172
173 /* Current event message (NULL if not created yet) */
174 bt_message *event_msg;
175
176 /* Database of current dynamic scopes */
177 struct {
178 bt_field *stream_packet_context;
179 bt_field *event_common_context;
180 bt_field *event_spec_context;
181 bt_field *event_payload;
182 } dscopes;
183
184 /* Current state */
185 enum state state;
186
187 /* Current medium buffer data */
188 struct {
189 /* Last address provided by medium */
190 const uint8_t *addr;
191
192 /* Buffer size provided by medium (bytes) */
193 size_t sz;
194
195 /* Offset within whole packet of addr (bits) */
196 size_t packet_offset;
197
198 /* Current position from addr (bits) */
199 size_t at;
200
201 /* Position of the last event header from addr (bits) */
202 size_t last_eh_at;
203 } buf;
204
205 /* Binary type reader */
206 struct bt_bfcr *bfcr;
207
208 /* Current medium data */
209 struct {
210 struct bt_msg_iter_medium_ops medops;
211 size_t max_request_sz;
212 void *data;
213 } medium;
214
215 /* Current packet size (bits) (-1 if unknown) */
216 int64_t cur_exp_packet_total_size;
217
218 /* Current content size (bits) (-1 if unknown) */
219 int64_t cur_exp_packet_content_size;
220
221 /* Current stream class ID */
222 int64_t cur_stream_class_id;
223
224 /* Current event class ID */
225 int64_t cur_event_class_id;
226
227 /* Current data stream ID */
228 int64_t cur_data_stream_id;
229
230 /*
231 * Offset, in the underlying media, of the current packet's
232 * start (-1 if unknown).
233 */
234 off_t cur_packet_offset;
235
236 /* Default clock's current value */
237 uint64_t default_clock_snapshot;
238
239 /* End of current packet snapshots */
240 struct end_of_packet_snapshots snapshots;
241
242 /* End of previous packet snapshots */
243 struct end_of_packet_snapshots prev_packet_snapshots;
244
245 /* Stored values (for sequence lengths, variant tags) */
246 GArray *stored_values;
247 };
248
249 static inline
250 const char *state_string(enum state state)
251 {
252 switch (state) {
253 case STATE_INIT:
254 return "STATE_INIT";
255 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
256 return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
257 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
258 return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
259 case STATE_AFTER_TRACE_PACKET_HEADER:
260 return "STATE_AFTER_TRACE_PACKET_HEADER";
261 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
262 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
263 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
264 return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
265 case STATE_AFTER_STREAM_PACKET_CONTEXT:
266 return "STATE_AFTER_STREAM_PACKET_CONTEXT";
267 case STATE_EMIT_MSG_STREAM_BEGINNING:
268 return "STATE_EMIT_MSG_STREAM_BEGINNING";
269 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
270 return "STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING";
271 case STATE_EMIT_MSG_PACKET_BEGINNING:
272 return "STATE_EMIT_MSG_PACKET_BEGINNING";
273 case STATE_EMIT_MSG_DISCARDED_EVENTS:
274 return "STATE_EMIT_MSG_DISCARDED_EVENTS";
275 case STATE_EMIT_MSG_DISCARDED_PACKETS:
276 return "STATE_EMIT_MSG_DISCARDED_PACKETS";
277 case STATE_DSCOPE_EVENT_HEADER_BEGIN:
278 return "STATE_DSCOPE_EVENT_HEADER_BEGIN";
279 case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
280 return "STATE_DSCOPE_EVENT_HEADER_CONTINUE";
281 case STATE_AFTER_EVENT_HEADER:
282 return "STATE_AFTER_EVENT_HEADER";
283 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
284 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
285 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
286 return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
287 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
288 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
289 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
290 return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
291 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
292 return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
293 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE:
294 return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
295 case STATE_EMIT_MSG_EVENT:
296 return "STATE_EMIT_MSG_EVENT";
297 case STATE_SKIP_PACKET_PADDING:
298 return "STATE_SKIP_PACKET_PADDING";
299 case STATE_EMIT_MSG_PACKET_END_MULTI:
300 return "STATE_EMIT_MSG_PACKET_END_MULTI";
301 case STATE_EMIT_MSG_PACKET_END_SINGLE:
302 return "STATE_EMIT_MSG_PACKET_END_SINGLE";
303 case STATE_EMIT_MSG_STREAM_ACTIVITY_END:
304 return "STATE_EMIT_MSG_STREAM_ACTIVITY_END";
305 case STATE_EMIT_MSG_STREAM_END:
306 return "STATE_EMIT_MSG_STREAM_END";
307 case STATE_DONE:
308 return "STATE_DONE";
309 default:
310 return "(unknown)";
311 }
312 }
313
314 static
315 int bt_msg_iter_switch_packet(struct bt_msg_iter *notit);
316
317 static
318 struct stack *stack_new(struct bt_msg_iter *notit)
319 {
320 struct stack *stack = NULL;
321
322 stack = g_new0(struct stack, 1);
323 if (!stack) {
324 BT_LOGE_STR("Failed to allocate one stack.");
325 goto error;
326 }
327
328 stack->entries = g_array_new(FALSE, TRUE, sizeof(struct stack_entry));
329 if (!stack->entries) {
330 BT_LOGE_STR("Failed to allocate a GArray.");
331 goto error;
332 }
333
334 BT_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit, stack);
335 goto end;
336
337 error:
338 g_free(stack);
339 stack = NULL;
340
341 end:
342 return stack;
343 }
344
345 static
346 void stack_destroy(struct stack *stack)
347 {
348 BT_ASSERT(stack);
349 BT_LOGD("Destroying stack: addr=%p", stack);
350
351 if (stack->entries) {
352 g_array_free(stack->entries, TRUE);
353 }
354
355 g_free(stack);
356 }
357
358 static
359 void stack_push(struct stack *stack, bt_field *base)
360 {
361 struct stack_entry *entry;
362
363 BT_ASSERT(stack);
364 BT_ASSERT(base);
365 BT_LOGV("Pushing base field on stack: stack-addr=%p, "
366 "stack-size-before=%zu, stack-size-after=%zu",
367 stack, stack->size, stack->size + 1);
368
369 if (stack->entries->len == stack->size) {
370 g_array_set_size(stack->entries, stack->size + 1);
371 }
372
373 entry = &g_array_index(stack->entries, struct stack_entry, stack->size);
374 entry->base = base;
375 entry->index = 0;
376 stack->size++;
377 }
378
379 static inline
380 unsigned int stack_size(struct stack *stack)
381 {
382 BT_ASSERT(stack);
383 return stack->size;
384 }
385
386 static
387 void stack_pop(struct stack *stack)
388 {
389 BT_ASSERT(stack);
390 BT_ASSERT(stack_size(stack));
391 BT_LOGV("Popping from stack: "
392 "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
393 stack, stack->size, stack->size - 1);
394 stack->size--;
395 }
396
397 static inline
398 struct stack_entry *stack_top(struct stack *stack)
399 {
400 BT_ASSERT(stack);
401 BT_ASSERT(stack_size(stack));
402 return &g_array_index(stack->entries, struct stack_entry,
403 stack->size - 1);
404 }
405
406 static inline
407 bool stack_empty(struct stack *stack)
408 {
409 return stack_size(stack) == 0;
410 }
411
412 static
413 void stack_clear(struct stack *stack)
414 {
415 BT_ASSERT(stack);
416 stack->size = 0;
417 }
418
419 static inline
420 enum bt_msg_iter_status msg_iter_status_from_m_status(
421 enum bt_msg_iter_medium_status m_status)
422 {
423 /* They are the same */
424 return (int) m_status;
425 }
426
427 static inline
428 size_t buf_size_bits(struct bt_msg_iter *notit)
429 {
430 return notit->buf.sz * 8;
431 }
432
433 static inline
434 size_t buf_available_bits(struct bt_msg_iter *notit)
435 {
436 return buf_size_bits(notit) - notit->buf.at;
437 }
438
439 static inline
440 size_t packet_at(struct bt_msg_iter *notit)
441 {
442 return notit->buf.packet_offset + notit->buf.at;
443 }
444
445 static inline
446 void buf_consume_bits(struct bt_msg_iter *notit, size_t incr)
447 {
448 BT_LOGV("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
449 notit, notit->buf.at, notit->buf.at + incr);
450 notit->buf.at += incr;
451 }
452
453 static
454 enum bt_msg_iter_status request_medium_bytes(
455 struct bt_msg_iter *notit)
456 {
457 uint8_t *buffer_addr = NULL;
458 size_t buffer_sz = 0;
459 enum bt_msg_iter_medium_status m_status;
460
461 BT_LOGV("Calling user function (request bytes): notit-addr=%p, "
462 "request-size=%zu", notit, notit->medium.max_request_sz);
463 m_status = notit->medium.medops.request_bytes(
464 notit->medium.max_request_sz, &buffer_addr,
465 &buffer_sz, notit->medium.data);
466 BT_LOGV("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
467 bt_msg_iter_medium_status_string(m_status),
468 buffer_addr, buffer_sz);
469 if (m_status == BT_MSG_ITER_MEDIUM_STATUS_OK) {
470 BT_ASSERT(buffer_sz != 0);
471
472 /* New packet offset is old one + old size (in bits) */
473 notit->buf.packet_offset += buf_size_bits(notit);
474
475 /* Restart at the beginning of the new medium buffer */
476 notit->buf.at = 0;
477 notit->buf.last_eh_at = SIZE_MAX;
478
479 /* New medium buffer size */
480 notit->buf.sz = buffer_sz;
481
482 /* New medium buffer address */
483 notit->buf.addr = buffer_addr;
484
485 BT_LOGV("User function returned new bytes: "
486 "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
487 notit->buf.packet_offset, notit->buf.at,
488 notit->buf.sz, notit->buf.addr);
489 BT_LOGV_MEM(buffer_addr, buffer_sz, "Returned bytes at %p:",
490 buffer_addr);
491 } else if (m_status == BT_MSG_ITER_MEDIUM_STATUS_EOF) {
492 /*
493 * User returned end of stream: validate that we're not
494 * in the middle of a packet header, packet context, or
495 * event.
496 */
497 if (notit->cur_exp_packet_total_size >= 0) {
498 if (packet_at(notit) ==
499 notit->cur_exp_packet_total_size) {
500 goto end;
501 }
502 } else {
503 if (packet_at(notit) == 0) {
504 goto end;
505 }
506
507 if (notit->buf.last_eh_at != SIZE_MAX &&
508 notit->buf.at == notit->buf.last_eh_at) {
509 goto end;
510 }
511 }
512
513 /* All other states are invalid */
514 BT_LOGW("User function returned %s, but message iterator is in an unexpected state: "
515 "state=%s, cur-packet-size=%" PRId64 ", cur=%zu, "
516 "packet-cur=%zu, last-eh-at=%zu",
517 bt_msg_iter_medium_status_string(m_status),
518 state_string(notit->state),
519 notit->cur_exp_packet_total_size,
520 notit->buf.at, packet_at(notit),
521 notit->buf.last_eh_at);
522 m_status = BT_MSG_ITER_MEDIUM_STATUS_ERROR;
523 } else if (m_status < 0) {
524 BT_LOGW("User function failed: status=%s",
525 bt_msg_iter_medium_status_string(m_status));
526 }
527
528 end:
529 return msg_iter_status_from_m_status(m_status);
530 }
531
532 static inline
533 enum bt_msg_iter_status buf_ensure_available_bits(
534 struct bt_msg_iter *notit)
535 {
536 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
537
538 if (unlikely(buf_available_bits(notit) == 0)) {
539 /*
540 * This _cannot_ return BT_MSG_ITER_STATUS_OK
541 * _and_ no bits.
542 */
543 status = request_medium_bytes(notit);
544 }
545
546 return status;
547 }
548
549 static
550 enum bt_msg_iter_status read_dscope_begin_state(
551 struct bt_msg_iter *notit,
552 struct ctf_field_class *dscope_fc,
553 enum state done_state, enum state continue_state,
554 bt_field *dscope_field)
555 {
556 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
557 enum bt_bfcr_status bfcr_status;
558 size_t consumed_bits;
559
560 notit->cur_dscope_field = dscope_field;
561 BT_LOGV("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
562 notit, notit->bfcr, dscope_fc);
563 consumed_bits = bt_bfcr_start(notit->bfcr, dscope_fc,
564 notit->buf.addr, notit->buf.at, packet_at(notit),
565 notit->buf.sz, &bfcr_status);
566 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits);
567
568 switch (bfcr_status) {
569 case BT_BFCR_STATUS_OK:
570 /* Field class was read completely */
571 BT_LOGV_STR("Field was completely decoded.");
572 notit->state = done_state;
573 break;
574 case BT_BFCR_STATUS_EOF:
575 BT_LOGV_STR("BFCR needs more data to decode field completely.");
576 notit->state = continue_state;
577 break;
578 default:
579 BT_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
580 "status=%s", notit, notit->bfcr,
581 bt_bfcr_status_string(bfcr_status));
582 status = BT_MSG_ITER_STATUS_ERROR;
583 goto end;
584 }
585
586 /* Consume bits now since we know we're not in an error state */
587 buf_consume_bits(notit, consumed_bits);
588
589 end:
590 return status;
591 }
592
593 static
594 enum bt_msg_iter_status read_dscope_continue_state(
595 struct bt_msg_iter *notit, enum state done_state)
596 {
597 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
598 enum bt_bfcr_status bfcr_status;
599 size_t consumed_bits;
600
601 BT_LOGV("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
602 notit, notit->bfcr);
603
604 status = buf_ensure_available_bits(notit);
605 if (status != BT_MSG_ITER_STATUS_OK) {
606 if (status < 0) {
607 BT_LOGW("Cannot ensure that buffer has at least one byte: "
608 "msg-addr=%p, status=%s",
609 notit, bt_msg_iter_status_string(status));
610 } else {
611 BT_LOGV("Cannot ensure that buffer has at least one byte: "
612 "msg-addr=%p, status=%s",
613 notit, bt_msg_iter_status_string(status));
614 }
615
616 goto end;
617 }
618
619 consumed_bits = bt_bfcr_continue(notit->bfcr, notit->buf.addr,
620 notit->buf.sz, &bfcr_status);
621 BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits);
622
623 switch (bfcr_status) {
624 case BT_BFCR_STATUS_OK:
625 /* Type was read completely. */
626 BT_LOGV_STR("Field was completely decoded.");
627 notit->state = done_state;
628 break;
629 case BT_BFCR_STATUS_EOF:
630 /* Stay in this continue state. */
631 BT_LOGV_STR("BFCR needs more data to decode field completely.");
632 break;
633 default:
634 BT_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
635 "status=%s", notit, notit->bfcr,
636 bt_bfcr_status_string(bfcr_status));
637 status = BT_MSG_ITER_STATUS_ERROR;
638 goto end;
639 }
640
641 /* Consume bits now since we know we're not in an error state. */
642 buf_consume_bits(notit, consumed_bits);
643 end:
644 return status;
645 }
646
647 static
648 void release_event_dscopes(struct bt_msg_iter *notit)
649 {
650 notit->dscopes.event_common_context = NULL;
651 notit->dscopes.event_spec_context = NULL;
652 notit->dscopes.event_payload = NULL;
653 }
654
655 static
656 void release_all_dscopes(struct bt_msg_iter *notit)
657 {
658 notit->dscopes.stream_packet_context = NULL;
659
660 if (notit->packet_context_field) {
661 bt_packet_context_field_release(notit->packet_context_field);
662 notit->packet_context_field = NULL;
663 }
664
665 release_event_dscopes(notit);
666 }
667
668 static
669 enum bt_msg_iter_status read_packet_header_begin_state(
670 struct bt_msg_iter *notit)
671 {
672 struct ctf_field_class *packet_header_fc = NULL;
673 enum bt_msg_iter_status ret = BT_MSG_ITER_STATUS_OK;
674
675 if (bt_msg_iter_switch_packet(notit)) {
676 BT_LOGW("Cannot switch packet: notit-addr=%p", notit);
677 ret = BT_MSG_ITER_STATUS_ERROR;
678 goto end;
679 }
680
681 /*
682 * Make sure at least one bit is available for this packet. An
683 * empty packet is impossible. If we reach the end of the medium
684 * at this point, then it's considered the end of the stream.
685 */
686 ret = buf_ensure_available_bits(notit);
687 switch (ret) {
688 case BT_MSG_ITER_STATUS_OK:
689 break;
690 case BT_MSG_ITER_STATUS_EOF:
691 ret = BT_MSG_ITER_STATUS_OK;
692 notit->state = STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END;
693 goto end;
694 default:
695 goto end;
696 }
697
698 /* Packet header class is common to the whole trace class. */
699 packet_header_fc = notit->meta.tc->packet_header_fc;
700 if (!packet_header_fc) {
701 notit->state = STATE_AFTER_TRACE_PACKET_HEADER;
702 goto end;
703 }
704
705 notit->cur_stream_class_id = -1;
706 notit->cur_event_class_id = -1;
707 notit->cur_data_stream_id = -1;
708 BT_LOGV("Decoding packet header field:"
709 "notit-addr=%p, trace-class-addr=%p, fc-addr=%p",
710 notit, notit->meta.tc, packet_header_fc);
711 ret = read_dscope_begin_state(notit, packet_header_fc,
712 STATE_AFTER_TRACE_PACKET_HEADER,
713 STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE, NULL);
714 if (ret < 0) {
715 BT_LOGW("Cannot decode packet header field: "
716 "notit-addr=%p, trace-class-addr=%p, "
717 "fc-addr=%p",
718 notit, notit->meta.tc, packet_header_fc);
719 }
720
721 end:
722 return ret;
723 }
724
725 static
726 enum bt_msg_iter_status read_packet_header_continue_state(
727 struct bt_msg_iter *notit)
728 {
729 return read_dscope_continue_state(notit,
730 STATE_AFTER_TRACE_PACKET_HEADER);
731 }
732
733 static inline
734 enum bt_msg_iter_status set_current_stream_class(struct bt_msg_iter *notit)
735 {
736 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
737 struct ctf_stream_class *new_stream_class = NULL;
738
739 if (notit->cur_stream_class_id == -1) {
740 /*
741 * No current stream class ID field, therefore only one
742 * stream class.
743 */
744 if (notit->meta.tc->stream_classes->len != 1) {
745 BT_LOGW("Need exactly one stream class since there's "
746 "no stream class ID field: "
747 "notit-addr=%p", notit);
748 status = BT_MSG_ITER_STATUS_ERROR;
749 goto end;
750 }
751
752 new_stream_class = notit->meta.tc->stream_classes->pdata[0];
753 notit->cur_stream_class_id = new_stream_class->id;
754 }
755
756 new_stream_class = ctf_trace_class_borrow_stream_class_by_id(
757 notit->meta.tc, notit->cur_stream_class_id);
758 if (!new_stream_class) {
759 BT_LOGW("No stream class with ID of stream class ID to use in trace class: "
760 "notit-addr=%p, stream-class-id=%" PRIu64 ", "
761 "trace-class-addr=%p",
762 notit, notit->cur_stream_class_id, notit->meta.tc);
763 status = BT_MSG_ITER_STATUS_ERROR;
764 goto end;
765 }
766
767 if (notit->meta.sc) {
768 if (new_stream_class != notit->meta.sc) {
769 BT_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
770 "notit-addr=%p, prev-stream-class-addr=%p, "
771 "prev-stream-class-id=%" PRId64 ", "
772 "next-stream-class-addr=%p, "
773 "next-stream-class-id=%" PRId64 ", "
774 "trace-addr=%p",
775 notit, notit->meta.sc,
776 notit->meta.sc->id,
777 new_stream_class,
778 new_stream_class->id,
779 notit->meta.tc);
780 status = BT_MSG_ITER_STATUS_ERROR;
781 goto end;
782 }
783 } else {
784 notit->meta.sc = new_stream_class;
785 }
786
787 BT_LOGV("Set current stream class: "
788 "notit-addr=%p, stream-class-addr=%p, "
789 "stream-class-id=%" PRId64,
790 notit, notit->meta.sc, notit->meta.sc->id);
791
792 end:
793 return status;
794 }
795
796 static inline
797 enum bt_msg_iter_status set_current_stream(struct bt_msg_iter *notit)
798 {
799 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
800 bt_stream *stream = NULL;
801
802 BT_LOGV("Calling user function (get stream): notit-addr=%p, "
803 "stream-class-addr=%p, stream-class-id=%" PRId64,
804 notit, notit->meta.sc,
805 notit->meta.sc->id);
806 stream = notit->medium.medops.borrow_stream(
807 notit->meta.sc->ir_sc, notit->cur_data_stream_id,
808 notit->medium.data);
809 bt_stream_get_ref(stream);
810 BT_LOGV("User function returned: stream-addr=%p", stream);
811 if (!stream) {
812 BT_LOGW_STR("User function failed to return a stream object "
813 "for the given stream class.");
814 status = BT_MSG_ITER_STATUS_ERROR;
815 goto end;
816 }
817
818 if (notit->stream && stream != notit->stream) {
819 BT_LOGW("User function returned a different stream than the "
820 "previous one for the same sequence of packets.");
821 status = BT_MSG_ITER_STATUS_ERROR;
822 goto end;
823 }
824
825 BT_STREAM_MOVE_REF(notit->stream, stream);
826
827 end:
828 bt_stream_put_ref(stream);
829 return status;
830 }
831
832 static inline
833 enum bt_msg_iter_status set_current_packet(struct bt_msg_iter *notit)
834 {
835 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
836 bt_packet *packet = NULL;
837
838 BT_LOGV("Creating packet for packet message: "
839 "notit-addr=%p", notit);
840 BT_LOGV("Creating packet from stream: "
841 "notit-addr=%p, stream-addr=%p, "
842 "stream-class-addr=%p, "
843 "stream-class-id=%" PRId64,
844 notit, notit->stream, notit->meta.sc,
845 notit->meta.sc->id);
846
847 /* Create packet */
848 BT_ASSERT(notit->stream);
849 packet = bt_packet_create(notit->stream);
850 if (!packet) {
851 BT_LOGE("Cannot create packet from stream: "
852 "notit-addr=%p, stream-addr=%p, "
853 "stream-class-addr=%p, "
854 "stream-class-id=%" PRId64,
855 notit, notit->stream, notit->meta.sc,
856 notit->meta.sc->id);
857 goto error;
858 }
859
860 goto end;
861
862 error:
863 BT_PACKET_PUT_REF_AND_RESET(packet);
864 status = BT_MSG_ITER_STATUS_ERROR;
865
866 end:
867 BT_PACKET_MOVE_REF(notit->packet, packet);
868 return status;
869 }
870
871 static
872 enum bt_msg_iter_status after_packet_header_state(
873 struct bt_msg_iter *notit)
874 {
875 enum bt_msg_iter_status status;
876
877 status = set_current_stream_class(notit);
878 if (status != BT_MSG_ITER_STATUS_OK) {
879 goto end;
880 }
881
882 notit->state = STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN;
883
884 end:
885 return status;
886 }
887
888 static
889 enum bt_msg_iter_status read_packet_context_begin_state(
890 struct bt_msg_iter *notit)
891 {
892 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
893 struct ctf_field_class *packet_context_fc;
894
895 BT_ASSERT(notit->meta.sc);
896 packet_context_fc = notit->meta.sc->packet_context_fc;
897 if (!packet_context_fc) {
898 BT_LOGV("No packet packet context field class in stream class: continuing: "
899 "notit-addr=%p, stream-class-addr=%p, "
900 "stream-class-id=%" PRId64,
901 notit, notit->meta.sc,
902 notit->meta.sc->id);
903 notit->state = STATE_AFTER_STREAM_PACKET_CONTEXT;
904 goto end;
905 }
906
907 BT_ASSERT(!notit->packet_context_field);
908
909 if (packet_context_fc->in_ir) {
910 /*
911 * Create free packet context field from stream class.
912 * This field is going to be moved to the packet once we
913 * create it. We cannot create the packet now because a
914 * packet is created from a stream, and this API must be
915 * able to return the packet context properties without
916 * creating a stream
917 * (bt_msg_iter_get_packet_properties()).
918 */
919 notit->packet_context_field =
920 bt_packet_context_field_create(
921 notit->meta.sc->ir_sc);
922 if (!notit->packet_context_field) {
923 BT_LOGE_STR("Cannot create packet context field wrapper from stream class.");
924 status = BT_MSG_ITER_STATUS_ERROR;
925 goto end;
926 }
927
928 notit->dscopes.stream_packet_context =
929 bt_packet_context_field_borrow_field(
930 notit->packet_context_field);
931 BT_ASSERT(notit->dscopes.stream_packet_context);
932 }
933
934 BT_LOGV("Decoding packet context field: "
935 "notit-addr=%p, stream-class-addr=%p, "
936 "stream-class-id=%" PRId64 ", fc-addr=%p",
937 notit, notit->meta.sc,
938 notit->meta.sc->id, packet_context_fc);
939 status = read_dscope_begin_state(notit, packet_context_fc,
940 STATE_AFTER_STREAM_PACKET_CONTEXT,
941 STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE,
942 notit->dscopes.stream_packet_context);
943 if (status < 0) {
944 BT_LOGW("Cannot decode packet context field: "
945 "notit-addr=%p, stream-class-addr=%p, "
946 "stream-class-id=%" PRId64 ", fc-addr=%p",
947 notit, notit->meta.sc,
948 notit->meta.sc->id,
949 packet_context_fc);
950 }
951
952 end:
953 return status;
954 }
955
956 static
957 enum bt_msg_iter_status read_packet_context_continue_state(
958 struct bt_msg_iter *notit)
959 {
960 return read_dscope_continue_state(notit,
961 STATE_AFTER_STREAM_PACKET_CONTEXT);
962 }
963
964 static
965 enum bt_msg_iter_status set_current_packet_content_sizes(
966 struct bt_msg_iter *notit)
967 {
968 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
969
970 if (notit->cur_exp_packet_total_size == -1) {
971 if (notit->cur_exp_packet_content_size != -1) {
972 notit->cur_exp_packet_total_size =
973 notit->cur_exp_packet_content_size;
974 }
975 } else {
976 if (notit->cur_exp_packet_content_size == -1) {
977 notit->cur_exp_packet_content_size =
978 notit->cur_exp_packet_total_size;
979 }
980 }
981
982 BT_ASSERT(notit->cur_exp_packet_total_size != -1);
983 BT_ASSERT(notit->cur_exp_packet_content_size != -1);
984
985 if (notit->cur_exp_packet_content_size >
986 notit->cur_exp_packet_total_size) {
987 BT_LOGW("Invalid packet or content size: "
988 "content size is greater than packet size: "
989 "notit-addr=%p, packet-context-field-addr=%p, "
990 "packet-size=%" PRId64 ", content-size=%" PRId64,
991 notit, notit->dscopes.stream_packet_context,
992 notit->cur_exp_packet_total_size,
993 notit->cur_exp_packet_content_size);
994 status = BT_MSG_ITER_STATUS_ERROR;
995 goto end;
996 }
997
998 BT_LOGV("Set current packet and content sizes: "
999 "notit-addr=%p, packet-size=%" PRIu64 ", content-size=%" PRIu64,
1000 notit, notit->cur_exp_packet_total_size,
1001 notit->cur_exp_packet_content_size);
1002
1003 end:
1004 return status;
1005 }
1006
1007 static
1008 enum bt_msg_iter_status after_packet_context_state(struct bt_msg_iter *notit)
1009 {
1010 enum bt_msg_iter_status status;
1011
1012 status = set_current_packet_content_sizes(notit);
1013 if (status != BT_MSG_ITER_STATUS_OK) {
1014 goto end;
1015 }
1016
1017 if (notit->stream) {
1018 /*
1019 * Stream exists, which means we already emitted at
1020 * least one packet beginning message, so the initial
1021 * stream beginning message was also emitted.
1022 */
1023 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1024 } else {
1025 notit->state = STATE_CHECK_EMIT_MSG_STREAM_BEGINNING;
1026 }
1027
1028 end:
1029 return status;
1030 }
1031
1032 static
1033 enum bt_msg_iter_status read_event_header_begin_state(struct bt_msg_iter *notit)
1034 {
1035 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1036 struct ctf_field_class *event_header_fc = NULL;
1037
1038 /* Reset the position of the last event header */
1039 notit->buf.last_eh_at = notit->buf.at;
1040 notit->cur_event_class_id = -1;
1041
1042 /* Check if we have some content left */
1043 if (notit->cur_exp_packet_content_size >= 0) {
1044 if (unlikely(packet_at(notit) ==
1045 notit->cur_exp_packet_content_size)) {
1046 /* No more events! */
1047 BT_LOGV("Reached end of packet: notit-addr=%p, "
1048 "cur=%zu", notit, packet_at(notit));
1049 notit->state = STATE_EMIT_MSG_PACKET_END_MULTI;
1050 goto end;
1051 } else if (unlikely(packet_at(notit) >
1052 notit->cur_exp_packet_content_size)) {
1053 /* That's not supposed to happen */
1054 BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
1055 "notit-addr=%p, content-size=%" PRId64 ", "
1056 "cur=%zu", notit,
1057 notit->cur_exp_packet_content_size,
1058 packet_at(notit));
1059 status = BT_MSG_ITER_STATUS_ERROR;
1060 goto end;
1061 }
1062 } else {
1063 /*
1064 * "Infinite" content: we're done when the medium has
1065 * nothing else for us.
1066 */
1067 status = buf_ensure_available_bits(notit);
1068 switch (status) {
1069 case BT_MSG_ITER_STATUS_OK:
1070 break;
1071 case BT_MSG_ITER_STATUS_EOF:
1072 status = BT_MSG_ITER_STATUS_OK;
1073 notit->state = STATE_EMIT_MSG_PACKET_END_SINGLE;
1074 goto end;
1075 default:
1076 goto end;
1077 }
1078 }
1079
1080 release_event_dscopes(notit);
1081 BT_ASSERT(notit->meta.sc);
1082 event_header_fc = notit->meta.sc->event_header_fc;
1083 if (!event_header_fc) {
1084 notit->state = STATE_AFTER_EVENT_HEADER;
1085 goto end;
1086 }
1087
1088 BT_LOGV("Decoding event header field: "
1089 "notit-addr=%p, stream-class-addr=%p, "
1090 "stream-class-id=%" PRId64 ", "
1091 "fc-addr=%p",
1092 notit, notit->meta.sc,
1093 notit->meta.sc->id,
1094 event_header_fc);
1095 status = read_dscope_begin_state(notit, event_header_fc,
1096 STATE_AFTER_EVENT_HEADER,
1097 STATE_DSCOPE_EVENT_HEADER_CONTINUE, NULL);
1098 if (status < 0) {
1099 BT_LOGW("Cannot decode event header field: "
1100 "notit-addr=%p, stream-class-addr=%p, "
1101 "stream-class-id=%" PRId64 ", fc-addr=%p",
1102 notit, notit->meta.sc,
1103 notit->meta.sc->id,
1104 event_header_fc);
1105 }
1106
1107 end:
1108 return status;
1109 }
1110
1111 static
1112 enum bt_msg_iter_status read_event_header_continue_state(
1113 struct bt_msg_iter *notit)
1114 {
1115 return read_dscope_continue_state(notit,
1116 STATE_AFTER_EVENT_HEADER);
1117 }
1118
1119 static inline
1120 enum bt_msg_iter_status set_current_event_class(struct bt_msg_iter *notit)
1121 {
1122 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1123
1124 struct ctf_event_class *new_event_class = NULL;
1125
1126 if (notit->cur_event_class_id == -1) {
1127 /*
1128 * No current event class ID field, therefore only one
1129 * event class.
1130 */
1131 if (notit->meta.sc->event_classes->len != 1) {
1132 BT_LOGW("Need exactly one event class since there's "
1133 "no event class ID field: "
1134 "notit-addr=%p", notit);
1135 status = BT_MSG_ITER_STATUS_ERROR;
1136 goto end;
1137 }
1138
1139 new_event_class = notit->meta.sc->event_classes->pdata[0];
1140 notit->cur_event_class_id = new_event_class->id;
1141 }
1142
1143 new_event_class = ctf_stream_class_borrow_event_class_by_id(
1144 notit->meta.sc, notit->cur_event_class_id);
1145 if (!new_event_class) {
1146 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1147 "notit-addr=%p, stream-class-id=%" PRIu64 ", "
1148 "event-class-id=%" PRIu64 ", "
1149 "trace-class-addr=%p",
1150 notit, notit->meta.sc->id, notit->cur_event_class_id,
1151 notit->meta.tc);
1152 status = BT_MSG_ITER_STATUS_ERROR;
1153 goto end;
1154 }
1155
1156 notit->meta.ec = new_event_class;
1157 BT_LOGV("Set current event class: "
1158 "notit-addr=%p, event-class-addr=%p, "
1159 "event-class-id=%" PRId64 ", "
1160 "event-class-name=\"%s\"",
1161 notit, notit->meta.ec, notit->meta.ec->id,
1162 notit->meta.ec->name->str);
1163
1164 end:
1165 return status;
1166 }
1167
1168 static inline
1169 enum bt_msg_iter_status set_current_event_message(
1170 struct bt_msg_iter *notit)
1171 {
1172 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1173 bt_message *msg = NULL;
1174
1175 BT_ASSERT(notit->meta.ec);
1176 BT_ASSERT(notit->packet);
1177 BT_LOGV("Creating event message from event class and packet: "
1178 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1179 notit, notit->meta.ec,
1180 notit->meta.ec->name->str,
1181 notit->packet);
1182 BT_ASSERT(notit->msg_iter);
1183 BT_ASSERT(notit->meta.sc);
1184
1185 if (bt_stream_class_borrow_default_clock_class(notit->meta.sc->ir_sc)) {
1186 msg = bt_message_event_create_with_default_clock_snapshot(
1187 notit->msg_iter, notit->meta.ec->ir_ec,
1188 notit->packet, notit->default_clock_snapshot);
1189 } else {
1190 msg = bt_message_event_create(notit->msg_iter,
1191 notit->meta.ec->ir_ec, notit->packet);
1192 }
1193
1194 if (!msg) {
1195 BT_LOGE("Cannot create event message: "
1196 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1197 "packet-addr=%p",
1198 notit, notit->meta.ec,
1199 notit->meta.ec->name->str,
1200 notit->packet);
1201 goto error;
1202 }
1203
1204 goto end;
1205
1206 error:
1207 BT_MESSAGE_PUT_REF_AND_RESET(msg);
1208 status = BT_MSG_ITER_STATUS_ERROR;
1209
1210 end:
1211 BT_MESSAGE_MOVE_REF(notit->event_msg, msg);
1212 return status;
1213 }
1214
1215 static
1216 enum bt_msg_iter_status after_event_header_state(
1217 struct bt_msg_iter *notit)
1218 {
1219 enum bt_msg_iter_status status;
1220
1221 status = set_current_event_class(notit);
1222 if (status != BT_MSG_ITER_STATUS_OK) {
1223 goto end;
1224 }
1225
1226 status = set_current_event_message(notit);
1227 if (status != BT_MSG_ITER_STATUS_OK) {
1228 goto end;
1229 }
1230
1231 notit->event = bt_message_event_borrow_event(
1232 notit->event_msg);
1233 BT_ASSERT(notit->event);
1234 notit->state = STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN;
1235
1236 end:
1237 return status;
1238 }
1239
1240 static
1241 enum bt_msg_iter_status read_event_common_context_begin_state(
1242 struct bt_msg_iter *notit)
1243 {
1244 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1245 struct ctf_field_class *event_common_context_fc;
1246
1247 event_common_context_fc = notit->meta.sc->event_common_context_fc;
1248 if (!event_common_context_fc) {
1249 notit->state = STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN;
1250 goto end;
1251 }
1252
1253 if (event_common_context_fc->in_ir) {
1254 BT_ASSERT(!notit->dscopes.event_common_context);
1255 notit->dscopes.event_common_context =
1256 bt_event_borrow_common_context_field(
1257 notit->event);
1258 BT_ASSERT(notit->dscopes.event_common_context);
1259 }
1260
1261 BT_LOGV("Decoding event common context field: "
1262 "notit-addr=%p, stream-class-addr=%p, "
1263 "stream-class-id=%" PRId64 ", "
1264 "fc-addr=%p",
1265 notit, notit->meta.sc,
1266 notit->meta.sc->id,
1267 event_common_context_fc);
1268 status = read_dscope_begin_state(notit, event_common_context_fc,
1269 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN,
1270 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE,
1271 notit->dscopes.event_common_context);
1272 if (status < 0) {
1273 BT_LOGW("Cannot decode event common context field: "
1274 "notit-addr=%p, stream-class-addr=%p, "
1275 "stream-class-id=%" PRId64 ", fc-addr=%p",
1276 notit, notit->meta.sc,
1277 notit->meta.sc->id,
1278 event_common_context_fc);
1279 }
1280
1281 end:
1282 return status;
1283 }
1284
1285 static
1286 enum bt_msg_iter_status read_event_common_context_continue_state(
1287 struct bt_msg_iter *notit)
1288 {
1289 return read_dscope_continue_state(notit,
1290 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN);
1291 }
1292
1293 static
1294 enum bt_msg_iter_status read_event_spec_context_begin_state(
1295 struct bt_msg_iter *notit)
1296 {
1297 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1298 struct ctf_field_class *event_spec_context_fc;
1299
1300 event_spec_context_fc = notit->meta.ec->spec_context_fc;
1301 if (!event_spec_context_fc) {
1302 notit->state = STATE_DSCOPE_EVENT_PAYLOAD_BEGIN;
1303 goto end;
1304 }
1305
1306 if (event_spec_context_fc->in_ir) {
1307 BT_ASSERT(!notit->dscopes.event_spec_context);
1308 notit->dscopes.event_spec_context =
1309 bt_event_borrow_specific_context_field(
1310 notit->event);
1311 BT_ASSERT(notit->dscopes.event_spec_context);
1312 }
1313
1314 BT_LOGV("Decoding event specific context field: "
1315 "notit-addr=%p, event-class-addr=%p, "
1316 "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
1317 "fc-addr=%p",
1318 notit, notit->meta.ec,
1319 notit->meta.ec->name->str,
1320 notit->meta.ec->id,
1321 event_spec_context_fc);
1322 status = read_dscope_begin_state(notit, event_spec_context_fc,
1323 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN,
1324 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE,
1325 notit->dscopes.event_spec_context);
1326 if (status < 0) {
1327 BT_LOGW("Cannot decode event specific context field: "
1328 "notit-addr=%p, event-class-addr=%p, "
1329 "event-class-name=\"%s\", "
1330 "event-class-id=%" PRId64 ", fc-addr=%p",
1331 notit, notit->meta.ec,
1332 notit->meta.ec->name->str,
1333 notit->meta.ec->id,
1334 event_spec_context_fc);
1335 }
1336
1337 end:
1338 return status;
1339 }
1340
1341 static
1342 enum bt_msg_iter_status read_event_spec_context_continue_state(
1343 struct bt_msg_iter *notit)
1344 {
1345 return read_dscope_continue_state(notit,
1346 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN);
1347 }
1348
1349 static
1350 enum bt_msg_iter_status read_event_payload_begin_state(
1351 struct bt_msg_iter *notit)
1352 {
1353 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1354 struct ctf_field_class *event_payload_fc;
1355
1356 event_payload_fc = notit->meta.ec->payload_fc;
1357 if (!event_payload_fc) {
1358 notit->state = STATE_EMIT_MSG_EVENT;
1359 goto end;
1360 }
1361
1362 if (event_payload_fc->in_ir) {
1363 BT_ASSERT(!notit->dscopes.event_payload);
1364 notit->dscopes.event_payload =
1365 bt_event_borrow_payload_field(
1366 notit->event);
1367 BT_ASSERT(notit->dscopes.event_payload);
1368 }
1369
1370 BT_LOGV("Decoding event payload field: "
1371 "notit-addr=%p, event-class-addr=%p, "
1372 "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
1373 "fc-addr=%p",
1374 notit, notit->meta.ec,
1375 notit->meta.ec->name->str,
1376 notit->meta.ec->id,
1377 event_payload_fc);
1378 status = read_dscope_begin_state(notit, event_payload_fc,
1379 STATE_EMIT_MSG_EVENT,
1380 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE,
1381 notit->dscopes.event_payload);
1382 if (status < 0) {
1383 BT_LOGW("Cannot decode event payload field: "
1384 "notit-addr=%p, event-class-addr=%p, "
1385 "event-class-name=\"%s\", "
1386 "event-class-id=%" PRId64 ", fc-addr=%p",
1387 notit, notit->meta.ec,
1388 notit->meta.ec->name->str,
1389 notit->meta.ec->id,
1390 event_payload_fc);
1391 }
1392
1393 end:
1394 return status;
1395 }
1396
1397 static
1398 enum bt_msg_iter_status read_event_payload_continue_state(
1399 struct bt_msg_iter *notit)
1400 {
1401 return read_dscope_continue_state(notit, STATE_EMIT_MSG_EVENT);
1402 }
1403
1404 static
1405 enum bt_msg_iter_status skip_packet_padding_state(struct bt_msg_iter *notit)
1406 {
1407 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1408 size_t bits_to_skip;
1409
1410 BT_ASSERT(notit->cur_exp_packet_total_size > 0);
1411 bits_to_skip = notit->cur_exp_packet_total_size - packet_at(notit);
1412 if (bits_to_skip == 0) {
1413 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1414 goto end;
1415 } else {
1416 size_t bits_to_consume;
1417
1418 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1419 bits_to_skip, notit, bits_to_skip);
1420 status = buf_ensure_available_bits(notit);
1421 if (status != BT_MSG_ITER_STATUS_OK) {
1422 goto end;
1423 }
1424
1425 bits_to_consume = MIN(buf_available_bits(notit), bits_to_skip);
1426 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1427 bits_to_consume, notit, bits_to_consume);
1428 buf_consume_bits(notit, bits_to_consume);
1429 bits_to_skip = notit->cur_exp_packet_total_size -
1430 packet_at(notit);
1431 if (bits_to_skip == 0) {
1432 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1433 goto end;
1434 }
1435 }
1436
1437 end:
1438 return status;
1439 }
1440
1441 static
1442 enum bt_msg_iter_status check_emit_msg_stream_beginning_state(
1443 struct bt_msg_iter *notit)
1444 {
1445 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1446
1447 if (notit->set_stream) {
1448 status = set_current_stream(notit);
1449 if (status != BT_MSG_ITER_STATUS_OK) {
1450 goto end;
1451 }
1452 }
1453
1454 if (notit->emit_stream_begin_msg) {
1455 notit->state = STATE_EMIT_MSG_STREAM_BEGINNING;
1456 } else {
1457 /* Stream's first packet */
1458 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1459 }
1460
1461 end:
1462 return status;
1463 }
1464
1465 static
1466 enum bt_msg_iter_status check_emit_msg_discarded_events(
1467 struct bt_msg_iter *notit)
1468 {
1469 notit->state = STATE_EMIT_MSG_DISCARDED_EVENTS;
1470
1471 if (notit->prev_packet_snapshots.discarded_events == UINT64_C(-1)) {
1472 if (notit->snapshots.discarded_events == 0 ||
1473 notit->snapshots.discarded_events == UINT64_C(-1)) {
1474 /*
1475 * Stream's first packet with no discarded
1476 * events or no information about discarded
1477 * events: do not emit.
1478 */
1479 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1480 }
1481 } else {
1482 /*
1483 * If the previous packet has a value for this counter,
1484 * then this counter is defined for the whole stream.
1485 */
1486 BT_ASSERT(notit->snapshots.discarded_events != UINT64_C(-1));
1487
1488 if (notit->snapshots.discarded_events -
1489 notit->prev_packet_snapshots.discarded_events == 0) {
1490 /*
1491 * No discarded events since previous packet: do
1492 * not emit.
1493 */
1494 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1495 }
1496 }
1497
1498 return BT_MSG_ITER_STATUS_OK;
1499 }
1500
1501 static
1502 enum bt_msg_iter_status check_emit_msg_discarded_packets(
1503 struct bt_msg_iter *notit)
1504 {
1505 notit->state = STATE_EMIT_MSG_DISCARDED_PACKETS;
1506
1507 if (notit->prev_packet_snapshots.packets == UINT64_C(-1)) {
1508 /*
1509 * Stream's first packet or no information about
1510 * discarded packets: do not emit. In other words, if
1511 * this is the first packet and its sequence number is
1512 * not 0, do not consider that packets were previously
1513 * lost: we might be reading a partial stream (LTTng
1514 * snapshot for example).
1515 */
1516 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1517 } else {
1518 /*
1519 * If the previous packet has a value for this counter,
1520 * then this counter is defined for the whole stream.
1521 */
1522 BT_ASSERT(notit->snapshots.packets != UINT64_C(-1));
1523
1524 if (notit->snapshots.packets -
1525 notit->prev_packet_snapshots.packets <= 1) {
1526 /*
1527 * No discarded packets since previous packet:
1528 * do not emit.
1529 */
1530 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1531 }
1532 }
1533
1534 return BT_MSG_ITER_STATUS_OK;
1535 }
1536
1537 static
1538 enum bt_msg_iter_status check_emit_msg_stream_activity_end(
1539 struct bt_msg_iter *notit)
1540 {
1541 if (notit->emit_stream_end_msg) {
1542 notit->state = STATE_EMIT_MSG_STREAM_ACTIVITY_END;
1543 } else {
1544 notit->state = STATE_DONE;
1545 }
1546
1547 return BT_MSG_ITER_STATUS_OK;
1548 }
1549
1550 static inline
1551 enum bt_msg_iter_status handle_state(struct bt_msg_iter *notit)
1552 {
1553 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1554 const enum state state = notit->state;
1555
1556 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1557 notit, state_string(state));
1558
1559 // TODO: optimalize!
1560 switch (state) {
1561 case STATE_INIT:
1562 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1563 break;
1564 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
1565 status = read_packet_header_begin_state(notit);
1566 break;
1567 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
1568 status = read_packet_header_continue_state(notit);
1569 break;
1570 case STATE_AFTER_TRACE_PACKET_HEADER:
1571 status = after_packet_header_state(notit);
1572 break;
1573 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
1574 status = read_packet_context_begin_state(notit);
1575 break;
1576 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
1577 status = read_packet_context_continue_state(notit);
1578 break;
1579 case STATE_AFTER_STREAM_PACKET_CONTEXT:
1580 status = after_packet_context_state(notit);
1581 break;
1582 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING:
1583 status = check_emit_msg_stream_beginning_state(notit);
1584 break;
1585 case STATE_EMIT_MSG_STREAM_BEGINNING:
1586 notit->state = STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING;
1587 break;
1588 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
1589 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1590 break;
1591 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS:
1592 status = check_emit_msg_discarded_events(notit);
1593 break;
1594 case STATE_EMIT_MSG_DISCARDED_EVENTS:
1595 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1596 break;
1597 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS:
1598 status = check_emit_msg_discarded_packets(notit);
1599 break;
1600 case STATE_EMIT_MSG_DISCARDED_PACKETS:
1601 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1602 break;
1603 case STATE_EMIT_MSG_PACKET_BEGINNING:
1604 notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
1605 break;
1606 case STATE_DSCOPE_EVENT_HEADER_BEGIN:
1607 status = read_event_header_begin_state(notit);
1608 break;
1609 case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
1610 status = read_event_header_continue_state(notit);
1611 break;
1612 case STATE_AFTER_EVENT_HEADER:
1613 status = after_event_header_state(notit);
1614 break;
1615 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
1616 status = read_event_common_context_begin_state(notit);
1617 break;
1618 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
1619 status = read_event_common_context_continue_state(notit);
1620 break;
1621 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
1622 status = read_event_spec_context_begin_state(notit);
1623 break;
1624 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
1625 status = read_event_spec_context_continue_state(notit);
1626 break;
1627 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
1628 status = read_event_payload_begin_state(notit);
1629 break;
1630 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE:
1631 status = read_event_payload_continue_state(notit);
1632 break;
1633 case STATE_EMIT_MSG_EVENT:
1634 notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
1635 break;
1636 case STATE_SKIP_PACKET_PADDING:
1637 status = skip_packet_padding_state(notit);
1638 break;
1639 case STATE_EMIT_MSG_PACKET_END_MULTI:
1640 notit->state = STATE_SKIP_PACKET_PADDING;
1641 break;
1642 case STATE_EMIT_MSG_PACKET_END_SINGLE:
1643 notit->state = STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END;
1644 break;
1645 case STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END:
1646 status = check_emit_msg_stream_activity_end(notit);
1647 break;
1648 case STATE_EMIT_MSG_STREAM_ACTIVITY_END:
1649 notit->state = STATE_EMIT_MSG_STREAM_END;
1650 break;
1651 case STATE_EMIT_MSG_STREAM_END:
1652 notit->state = STATE_DONE;
1653 break;
1654 case STATE_DONE:
1655 break;
1656 default:
1657 BT_LOGD("Unknown CTF plugin message iterator state: "
1658 "notit-addr=%p, state=%d", notit, notit->state);
1659 abort();
1660 }
1661
1662 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1663 "prev-state=%s, cur-state=%s",
1664 notit, bt_msg_iter_status_string(status),
1665 state_string(state), state_string(notit->state));
1666 return status;
1667 }
1668
1669 BT_HIDDEN
1670 void bt_msg_iter_reset_for_next_stream_file(struct bt_msg_iter *notit)
1671 {
1672 BT_ASSERT(notit);
1673 BT_LOGD("Resetting message iterator: addr=%p", notit);
1674 stack_clear(notit->stack);
1675 notit->meta.sc = NULL;
1676 notit->meta.ec = NULL;
1677 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
1678 BT_STREAM_PUT_REF_AND_RESET(notit->stream);
1679 BT_MESSAGE_PUT_REF_AND_RESET(notit->event_msg);
1680 release_all_dscopes(notit);
1681 notit->cur_dscope_field = NULL;
1682
1683 if (notit->packet_context_field) {
1684 bt_packet_context_field_release(notit->packet_context_field);
1685 notit->packet_context_field = NULL;
1686 }
1687
1688 notit->buf.addr = NULL;
1689 notit->buf.sz = 0;
1690 notit->buf.at = 0;
1691 notit->buf.last_eh_at = SIZE_MAX;
1692 notit->buf.packet_offset = 0;
1693 notit->state = STATE_INIT;
1694 notit->cur_exp_packet_content_size = -1;
1695 notit->cur_exp_packet_total_size = -1;
1696 notit->cur_packet_offset = -1;
1697 notit->cur_event_class_id = -1;
1698 notit->snapshots.beginning_clock = UINT64_C(-1);
1699 notit->snapshots.end_clock = UINT64_C(-1);
1700 }
1701
1702 /**
1703 * Resets the internal state of a CTF message iterator.
1704 */
1705 BT_HIDDEN
1706 void bt_msg_iter_reset(struct bt_msg_iter *notit)
1707 {
1708 bt_msg_iter_reset_for_next_stream_file(notit);
1709 notit->cur_stream_class_id = -1;
1710 notit->cur_data_stream_id = -1;
1711 notit->emit_stream_begin_msg = true;
1712 notit->emit_stream_end_msg = true;
1713 notit->snapshots.discarded_events = UINT64_C(-1);
1714 notit->snapshots.packets = UINT64_C(-1);
1715 notit->prev_packet_snapshots.discarded_events = UINT64_C(-1);
1716 notit->prev_packet_snapshots.packets = UINT64_C(-1);
1717 notit->prev_packet_snapshots.beginning_clock = UINT64_C(-1);
1718 notit->prev_packet_snapshots.end_clock = UINT64_C(-1);
1719 }
1720
1721 static
1722 int bt_msg_iter_switch_packet(struct bt_msg_iter *notit)
1723 {
1724 int ret = 0;
1725
1726 /*
1727 * We don't put the stream class here because we need to make
1728 * sure that all the packets processed by the same message
1729 * iterator refer to the same stream class (the first one).
1730 */
1731 BT_ASSERT(notit);
1732
1733 if (notit->cur_exp_packet_total_size != -1) {
1734 notit->cur_packet_offset += notit->cur_exp_packet_total_size;
1735 }
1736
1737 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1738 "packet-offset=%" PRId64, notit, notit->buf.at,
1739 notit->cur_packet_offset);
1740 stack_clear(notit->stack);
1741 notit->meta.ec = NULL;
1742 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
1743 BT_MESSAGE_PUT_REF_AND_RESET(notit->event_msg);
1744 release_all_dscopes(notit);
1745 notit->cur_dscope_field = NULL;
1746
1747 /*
1748 * Adjust current buffer so that addr points to the beginning of the new
1749 * packet.
1750 */
1751 if (notit->buf.addr) {
1752 size_t consumed_bytes = (size_t) (notit->buf.at / CHAR_BIT);
1753
1754 /* Packets are assumed to start on a byte frontier. */
1755 if (notit->buf.at % CHAR_BIT) {
1756 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1757 "notit-addr=%p, cur=%zu", notit, notit->buf.at);
1758 ret = -1;
1759 goto end;
1760 }
1761
1762 notit->buf.addr += consumed_bytes;
1763 notit->buf.sz -= consumed_bytes;
1764 notit->buf.at = 0;
1765 notit->buf.packet_offset = 0;
1766 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1767 notit->buf.addr, notit->buf.sz);
1768 }
1769
1770 notit->cur_exp_packet_content_size = -1;
1771 notit->cur_exp_packet_total_size = -1;
1772 notit->cur_stream_class_id = -1;
1773 notit->cur_event_class_id = -1;
1774 notit->cur_data_stream_id = -1;
1775 notit->prev_packet_snapshots = notit->snapshots;
1776 notit->snapshots.discarded_events = UINT64_C(-1);
1777 notit->snapshots.packets = UINT64_C(-1);
1778 notit->snapshots.beginning_clock = UINT64_C(-1);
1779 notit->snapshots.end_clock = UINT64_C(-1);
1780
1781 end:
1782 return ret;
1783 }
1784
1785 static
1786 bt_field *borrow_next_field(struct bt_msg_iter *notit)
1787 {
1788 bt_field *next_field = NULL;
1789 bt_field *base_field;
1790 const bt_field_class *base_fc;
1791 size_t index;
1792
1793 BT_ASSERT(!stack_empty(notit->stack));
1794 index = stack_top(notit->stack)->index;
1795 base_field = stack_top(notit->stack)->base;
1796 BT_ASSERT(base_field);
1797 base_fc = bt_field_borrow_class_const(base_field);
1798 BT_ASSERT(base_fc);
1799
1800 switch (bt_field_class_get_type(base_fc)) {
1801 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1802 {
1803 BT_ASSERT(index <
1804 bt_field_class_structure_get_member_count(
1805 bt_field_borrow_class_const(
1806 base_field)));
1807 next_field =
1808 bt_field_structure_borrow_member_field_by_index(
1809 base_field, index);
1810 break;
1811 }
1812 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
1813 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
1814 BT_ASSERT(index < bt_field_array_get_length(base_field));
1815 next_field = bt_field_array_borrow_element_field_by_index(
1816 base_field, index);
1817 break;
1818 case BT_FIELD_CLASS_TYPE_VARIANT:
1819 BT_ASSERT(index == 0);
1820 next_field = bt_field_variant_borrow_selected_option_field(
1821 base_field);
1822 break;
1823 default:
1824 abort();
1825 }
1826
1827 BT_ASSERT(next_field);
1828 return next_field;
1829 }
1830
1831 static
1832 void update_default_clock(struct bt_msg_iter *notit, uint64_t new_val,
1833 uint64_t new_val_size)
1834 {
1835 uint64_t new_val_mask;
1836 uint64_t cur_value_masked;
1837
1838 BT_ASSERT(new_val_size > 0);
1839
1840 /*
1841 * Special case for a 64-bit new value, which is the limit
1842 * of a clock value as of this version: overwrite the
1843 * current value directly.
1844 */
1845 if (new_val_size == 64) {
1846 notit->default_clock_snapshot = new_val;
1847 goto end;
1848 }
1849
1850 new_val_mask = (1ULL << new_val_size) - 1;
1851 cur_value_masked = notit->default_clock_snapshot & new_val_mask;
1852
1853 if (new_val < cur_value_masked) {
1854 /*
1855 * It looks like a wrap happened on the number of bits
1856 * of the requested new value. Assume that the clock
1857 * value wrapped only one time.
1858 */
1859 notit->default_clock_snapshot += new_val_mask + 1;
1860 }
1861
1862 /* Clear the low bits of the current clock value. */
1863 notit->default_clock_snapshot &= ~new_val_mask;
1864
1865 /* Set the low bits of the current clock value. */
1866 notit->default_clock_snapshot |= new_val;
1867
1868 end:
1869 BT_LOGV("Updated default clock's value from integer field's value: "
1870 "value=%" PRIu64, notit->default_clock_snapshot);
1871 }
1872
1873 static
1874 enum bt_bfcr_status bfcr_unsigned_int_cb(uint64_t value,
1875 struct ctf_field_class *fc, void *data)
1876 {
1877 struct bt_msg_iter *notit = data;
1878 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1879 bt_field *field = NULL;
1880 struct ctf_field_class_int *int_fc = (void *) fc;
1881
1882 BT_LOGV("Unsigned integer function called from BFCR: "
1883 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1884 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1885 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
1886
1887 if (likely(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE)) {
1888 goto update_def_clock;
1889 }
1890
1891 switch (int_fc->meaning) {
1892 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID:
1893 notit->cur_event_class_id = value;
1894 break;
1895 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID:
1896 notit->cur_data_stream_id = value;
1897 break;
1898 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME:
1899 notit->snapshots.beginning_clock = value;
1900 break;
1901 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME:
1902 notit->snapshots.end_clock = value;
1903 break;
1904 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID:
1905 notit->cur_stream_class_id = value;
1906 break;
1907 case CTF_FIELD_CLASS_MEANING_MAGIC:
1908 if (value != 0xc1fc1fc1) {
1909 BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
1910 "magic=%" PRIx64, notit, value);
1911 status = BT_BFCR_STATUS_ERROR;
1912 goto end;
1913 }
1914
1915 break;
1916 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT:
1917 notit->snapshots.packets = value;
1918 break;
1919 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT:
1920 notit->snapshots.discarded_events = value;
1921 break;
1922 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE:
1923 notit->cur_exp_packet_total_size = value;
1924 break;
1925 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE:
1926 notit->cur_exp_packet_content_size = value;
1927 break;
1928 default:
1929 abort();
1930 }
1931
1932 update_def_clock:
1933 if (unlikely(int_fc->mapped_clock_class)) {
1934 update_default_clock(notit, value, int_fc->base.size);
1935 }
1936
1937 if (unlikely(int_fc->storing_index >= 0)) {
1938 g_array_index(notit->stored_values, uint64_t,
1939 (uint64_t) int_fc->storing_index) = value;
1940 }
1941
1942 if (unlikely(!fc->in_ir)) {
1943 goto end;
1944 }
1945
1946 field = borrow_next_field(notit);
1947 BT_ASSERT(field);
1948 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
1949 BT_ASSERT(bt_field_get_class_type(field) ==
1950 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
1951 bt_field_get_class_type(field) ==
1952 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
1953 bt_field_unsigned_integer_set_value(field, value);
1954 stack_top(notit->stack)->index++;
1955
1956 end:
1957 return status;
1958 }
1959
1960 static
1961 enum bt_bfcr_status bfcr_unsigned_int_char_cb(uint64_t value,
1962 struct ctf_field_class *fc, void *data)
1963 {
1964 int ret;
1965 struct bt_msg_iter *notit = data;
1966 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1967 bt_field *string_field = NULL;
1968 struct ctf_field_class_int *int_fc = (void *) fc;
1969 char str[2] = {'\0', '\0'};
1970
1971 BT_LOGV("Unsigned integer character function called from BFCR: "
1972 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1973 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1974 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
1975 BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
1976 BT_ASSERT(!int_fc->mapped_clock_class);
1977 BT_ASSERT(int_fc->storing_index < 0);
1978
1979 if (unlikely(!fc->in_ir)) {
1980 goto end;
1981 }
1982
1983 if (notit->done_filling_string) {
1984 goto end;
1985 }
1986
1987 if (value == 0) {
1988 notit->done_filling_string = true;
1989 goto end;
1990 }
1991
1992 string_field = stack_top(notit->stack)->base;
1993 BT_ASSERT(bt_field_get_class_type(string_field) ==
1994 BT_FIELD_CLASS_TYPE_STRING);
1995
1996 /* Append character */
1997 str[0] = (char) value;
1998 ret = bt_field_string_append_with_length(string_field, str, 1);
1999 if (ret) {
2000 BT_LOGE("Cannot append character to string field's value: "
2001 "notit-addr=%p, field-addr=%p, ret=%d",
2002 notit, string_field, ret);
2003 status = BT_BFCR_STATUS_ERROR;
2004 goto end;
2005 }
2006
2007 end:
2008 return status;
2009 }
2010
2011 static
2012 enum bt_bfcr_status bfcr_signed_int_cb(int64_t value,
2013 struct ctf_field_class *fc, void *data)
2014 {
2015 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2016 bt_field *field = NULL;
2017 struct bt_msg_iter *notit = data;
2018 struct ctf_field_class_int *int_fc = (void *) fc;
2019
2020 BT_LOGV("Signed integer function called from BFCR: "
2021 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2022 "fc-type=%d, fc-in-ir=%d, value=%" PRId64,
2023 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
2024 BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
2025
2026 if (unlikely(int_fc->storing_index >= 0)) {
2027 g_array_index(notit->stored_values, uint64_t,
2028 (uint64_t) int_fc->storing_index) = (uint64_t) value;
2029 }
2030
2031 if (unlikely(!fc->in_ir)) {
2032 goto end;
2033 }
2034
2035 field = borrow_next_field(notit);
2036 BT_ASSERT(field);
2037 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2038 BT_ASSERT(bt_field_get_class_type(field) ==
2039 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
2040 bt_field_get_class_type(field) ==
2041 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
2042 bt_field_signed_integer_set_value(field, value);
2043 stack_top(notit->stack)->index++;
2044
2045 end:
2046 return status;
2047 }
2048
2049 static
2050 enum bt_bfcr_status bfcr_floating_point_cb(double value,
2051 struct ctf_field_class *fc, void *data)
2052 {
2053 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2054 bt_field *field = NULL;
2055 struct bt_msg_iter *notit = data;
2056
2057 BT_LOGV("Floating point number function called from BFCR: "
2058 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2059 "fc-type=%d, fc-in-ir=%d, value=%f",
2060 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
2061
2062 if (unlikely(!fc->in_ir)) {
2063 goto end;
2064 }
2065
2066 field = borrow_next_field(notit);
2067 BT_ASSERT(field);
2068 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2069 BT_ASSERT(bt_field_get_class_type(field) ==
2070 BT_FIELD_CLASS_TYPE_REAL);
2071 bt_field_real_set_value(field, value);
2072 stack_top(notit->stack)->index++;
2073
2074 end:
2075 return status;
2076 }
2077
2078 static
2079 enum bt_bfcr_status bfcr_string_begin_cb(
2080 struct ctf_field_class *fc, void *data)
2081 {
2082 bt_field *field = NULL;
2083 struct bt_msg_iter *notit = data;
2084 int ret;
2085
2086 BT_LOGV("String (beginning) function called from BFCR: "
2087 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2088 "fc-type=%d, fc-in-ir=%d",
2089 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2090
2091 if (unlikely(!fc->in_ir)) {
2092 goto end;
2093 }
2094
2095 field = borrow_next_field(notit);
2096 BT_ASSERT(field);
2097 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2098 BT_ASSERT(bt_field_get_class_type(field) ==
2099 BT_FIELD_CLASS_TYPE_STRING);
2100 ret = bt_field_string_clear(field);
2101 BT_ASSERT(ret == 0);
2102
2103 /*
2104 * Push on stack. Not a compound class per se, but we know that
2105 * only bfcr_string_cb() may be called between this call and a
2106 * subsequent call to bfcr_string_end_cb().
2107 */
2108 stack_push(notit->stack, field);
2109
2110 end:
2111 return BT_BFCR_STATUS_OK;
2112 }
2113
2114 static
2115 enum bt_bfcr_status bfcr_string_cb(const char *value,
2116 size_t len, struct ctf_field_class *fc, void *data)
2117 {
2118 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2119 bt_field *field = NULL;
2120 struct bt_msg_iter *notit = data;
2121 int ret;
2122
2123 BT_LOGV("String (substring) function called from BFCR: "
2124 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2125 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2126 notit, notit->bfcr, fc, fc->type, fc->in_ir,
2127 len);
2128
2129 if (unlikely(!fc->in_ir)) {
2130 goto end;
2131 }
2132
2133 field = stack_top(notit->stack)->base;
2134 BT_ASSERT(field);
2135
2136 /* Append current substring */
2137 ret = bt_field_string_append_with_length(field, value, len);
2138 if (ret) {
2139 BT_LOGE("Cannot append substring to string field's value: "
2140 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2141 "ret=%d", notit, field, len, ret);
2142 status = BT_BFCR_STATUS_ERROR;
2143 goto end;
2144 }
2145
2146 end:
2147 return status;
2148 }
2149
2150 static
2151 enum bt_bfcr_status bfcr_string_end_cb(
2152 struct ctf_field_class *fc, void *data)
2153 {
2154 struct bt_msg_iter *notit = data;
2155
2156 BT_LOGV("String (end) function called from BFCR: "
2157 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2158 "fc-type=%d, fc-in-ir=%d",
2159 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2160
2161 if (unlikely(!fc->in_ir)) {
2162 goto end;
2163 }
2164
2165 /* Pop string field */
2166 stack_pop(notit->stack);
2167
2168 /* Go to next field */
2169 stack_top(notit->stack)->index++;
2170
2171 end:
2172 return BT_BFCR_STATUS_OK;
2173 }
2174
2175 enum bt_bfcr_status bfcr_compound_begin_cb(
2176 struct ctf_field_class *fc, void *data)
2177 {
2178 struct bt_msg_iter *notit = data;
2179 bt_field *field;
2180
2181 BT_LOGV("Compound (beginning) function called from BFCR: "
2182 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2183 "fc-type=%d, fc-in-ir=%d",
2184 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2185
2186 if (!fc->in_ir) {
2187 goto end;
2188 }
2189
2190 /* Borrow field */
2191 if (stack_empty(notit->stack)) {
2192 /* Root: already set by read_dscope_begin_state() */
2193 field = notit->cur_dscope_field;
2194 } else {
2195 field = borrow_next_field(notit);
2196 BT_ASSERT(field);
2197 }
2198
2199 /* Push field */
2200 BT_ASSERT(field);
2201 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2202 stack_push(notit->stack, field);
2203
2204 /*
2205 * Change BFCR "unsigned int" callback if it's a text
2206 * array/sequence.
2207 */
2208 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
2209 fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2210 struct ctf_field_class_array_base *array_fc = (void *) fc;
2211
2212 if (array_fc->is_text) {
2213 int ret;
2214
2215 BT_ASSERT(bt_field_get_class_type(field) ==
2216 BT_FIELD_CLASS_TYPE_STRING);
2217 notit->done_filling_string = false;
2218 ret = bt_field_string_clear(field);
2219 BT_ASSERT(ret == 0);
2220 bt_bfcr_set_unsigned_int_cb(notit->bfcr,
2221 bfcr_unsigned_int_char_cb);
2222 }
2223 }
2224
2225 end:
2226 return BT_BFCR_STATUS_OK;
2227 }
2228
2229 enum bt_bfcr_status bfcr_compound_end_cb(
2230 struct ctf_field_class *fc, void *data)
2231 {
2232 struct bt_msg_iter *notit = data;
2233
2234 BT_LOGV("Compound (end) function called from BFCR: "
2235 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2236 "fc-type=%d, fc-in-ir=%d",
2237 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2238
2239 if (!fc->in_ir) {
2240 goto end;
2241 }
2242
2243 BT_ASSERT(!stack_empty(notit->stack));
2244 BT_ASSERT(bt_field_borrow_class_const(stack_top(notit->stack)->base) ==
2245 fc->ir_fc);
2246
2247 /*
2248 * Reset BFCR "unsigned int" callback if it's a text
2249 * array/sequence.
2250 */
2251 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
2252 fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2253 struct ctf_field_class_array_base *array_fc = (void *) fc;
2254
2255 if (array_fc->is_text) {
2256 BT_ASSERT(bt_field_get_class_type(
2257 stack_top(notit->stack)->base) ==
2258 BT_FIELD_CLASS_TYPE_STRING);
2259 bt_bfcr_set_unsigned_int_cb(notit->bfcr,
2260 bfcr_unsigned_int_cb);
2261 }
2262 }
2263
2264 /* Pop stack */
2265 stack_pop(notit->stack);
2266
2267 /* If the stack is not empty, increment the base's index */
2268 if (!stack_empty(notit->stack)) {
2269 stack_top(notit->stack)->index++;
2270 }
2271
2272 end:
2273 return BT_BFCR_STATUS_OK;
2274 }
2275
2276 static
2277 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class *fc, void *data)
2278 {
2279 bt_field *seq_field;
2280 struct bt_msg_iter *notit = data;
2281 struct ctf_field_class_sequence *seq_fc = (void *) fc;
2282 int64_t length = -1;
2283 int ret;
2284
2285 length = (uint64_t) g_array_index(notit->stored_values, uint64_t,
2286 seq_fc->stored_length_index);
2287 seq_field = stack_top(notit->stack)->base;
2288 BT_ASSERT(seq_field);
2289 ret = bt_field_dynamic_array_set_length(seq_field, (uint64_t) length);
2290 if (ret) {
2291 BT_LOGE("Cannot set dynamic array field's length field: "
2292 "notit-addr=%p, field-addr=%p, "
2293 "length=%" PRIu64, notit, seq_field, length);
2294 }
2295
2296 return length;
2297 }
2298
2299 static
2300 struct ctf_field_class *bfcr_borrow_variant_selected_field_class_cb(
2301 struct ctf_field_class *fc, void *data)
2302 {
2303 int ret;
2304 uint64_t i;
2305 int64_t option_index = -1;
2306 struct bt_msg_iter *notit = data;
2307 struct ctf_field_class_variant *var_fc = (void *) fc;
2308 struct ctf_named_field_class *selected_option = NULL;
2309 struct ctf_field_class *ret_fc = NULL;
2310 union {
2311 uint64_t u;
2312 int64_t i;
2313 } tag;
2314
2315 /* Get variant's tag */
2316 tag.u = g_array_index(notit->stored_values, uint64_t,
2317 var_fc->stored_tag_index);
2318
2319 /*
2320 * Check each range to find the selected option's index.
2321 */
2322 if (var_fc->tag_fc->base.is_signed) {
2323 for (i = 0; i < var_fc->ranges->len; i++) {
2324 struct ctf_field_class_variant_range *range =
2325 ctf_field_class_variant_borrow_range_by_index(
2326 var_fc, i);
2327
2328 if (tag.i >= range->range.lower.i &&
2329 tag.i <= range->range.upper.i) {
2330 option_index = (int64_t) range->option_index;
2331 break;
2332 }
2333 }
2334 } else {
2335 for (i = 0; i < var_fc->ranges->len; i++) {
2336 struct ctf_field_class_variant_range *range =
2337 ctf_field_class_variant_borrow_range_by_index(
2338 var_fc, i);
2339
2340 if (tag.u >= range->range.lower.u &&
2341 tag.u <= range->range.upper.u) {
2342 option_index = (int64_t) range->option_index;
2343 break;
2344 }
2345 }
2346 }
2347
2348 if (option_index < 0) {
2349 BT_LOGW("Cannot find variant field class's option: "
2350 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64 ", "
2351 "i-tag=%" PRId64, notit, var_fc, tag.u, tag.i);
2352 goto end;
2353 }
2354
2355 selected_option = ctf_field_class_variant_borrow_option_by_index(
2356 var_fc, (uint64_t) option_index);
2357
2358 if (selected_option->fc->in_ir) {
2359 bt_field *var_field = stack_top(notit->stack)->base;
2360
2361 ret = bt_field_variant_select_option_field(
2362 var_field, option_index);
2363 if (ret) {
2364 BT_LOGW("Cannot select variant field's option field: "
2365 "notit-addr=%p, var-field-addr=%p, "
2366 "opt-index=%" PRId64, notit, var_field,
2367 option_index);
2368 goto end;
2369 }
2370 }
2371
2372 ret_fc = selected_option->fc;
2373
2374 end:
2375 return ret_fc;
2376 }
2377
2378 static
2379 void create_msg_stream_beginning(struct bt_msg_iter *notit,
2380 bt_message **message)
2381 {
2382 bt_message *ret = NULL;
2383
2384 BT_ASSERT(notit->stream);
2385 BT_ASSERT(notit->msg_iter);
2386 ret = bt_message_stream_beginning_create(notit->msg_iter,
2387 notit->stream);
2388 if (!ret) {
2389 BT_LOGE("Cannot create stream beginning message: "
2390 "notit-addr=%p, stream-addr=%p",
2391 notit, notit->stream);
2392 return;
2393 }
2394
2395 *message = ret;
2396 }
2397
2398 static
2399 void create_msg_stream_activity_beginning(struct bt_msg_iter *notit,
2400 bt_message **message)
2401 {
2402 bt_message *ret = NULL;
2403
2404 BT_ASSERT(notit->stream);
2405 BT_ASSERT(notit->msg_iter);
2406 ret = bt_message_stream_activity_beginning_create(notit->msg_iter,
2407 notit->stream);
2408 if (!ret) {
2409 BT_LOGE("Cannot create stream activity beginning message: "
2410 "notit-addr=%p, stream-addr=%p",
2411 notit, notit->stream);
2412 return;
2413 }
2414
2415 *message = ret;
2416 }
2417
2418 static
2419 void create_msg_stream_activity_end(struct bt_msg_iter *notit,
2420 bt_message **message)
2421 {
2422 bt_message *ret = NULL;
2423
2424 if (!notit->stream) {
2425 BT_LOGE("Cannot create stream for stream message: "
2426 "notit-addr=%p", notit);
2427 return;
2428 }
2429
2430 BT_ASSERT(notit->stream);
2431 BT_ASSERT(notit->msg_iter);
2432 ret = bt_message_stream_activity_end_create(notit->msg_iter,
2433 notit->stream);
2434 if (!ret) {
2435 BT_LOGE("Cannot create stream activity end message: "
2436 "notit-addr=%p, stream-addr=%p",
2437 notit, notit->stream);
2438 return;
2439 }
2440
2441 *message = ret;
2442 }
2443
2444 static
2445 void create_msg_stream_end(struct bt_msg_iter *notit, bt_message **message)
2446 {
2447 bt_message *ret;
2448
2449 if (!notit->stream) {
2450 BT_LOGE("Cannot create stream for stream message: "
2451 "notit-addr=%p", notit);
2452 return;
2453 }
2454
2455 BT_ASSERT(notit->msg_iter);
2456 ret = bt_message_stream_end_create(notit->msg_iter,
2457 notit->stream);
2458 if (!ret) {
2459 BT_LOGE("Cannot create stream end message: "
2460 "notit-addr=%p, stream-addr=%p",
2461 notit, notit->stream);
2462 return;
2463 }
2464
2465 *message = ret;
2466 }
2467
2468 static
2469 void create_msg_packet_beginning(struct bt_msg_iter *notit,
2470 bt_message **message)
2471 {
2472 int ret;
2473 enum bt_msg_iter_status status;
2474 bt_message *msg = NULL;
2475 const bt_stream_class *sc;
2476
2477 status = set_current_packet(notit);
2478 if (status != BT_MSG_ITER_STATUS_OK) {
2479 goto end;
2480 }
2481
2482 BT_ASSERT(notit->packet);
2483 sc = notit->meta.sc->ir_sc;
2484 BT_ASSERT(sc);
2485
2486 if (notit->packet_context_field) {
2487 ret = bt_packet_move_context_field(
2488 notit->packet, notit->packet_context_field);
2489 if (ret) {
2490 goto end;
2491 }
2492
2493 notit->packet_context_field = NULL;
2494
2495 /*
2496 * At this point notit->dscopes.stream_packet_context
2497 * has the same value as the packet context field within
2498 * notit->packet.
2499 */
2500 BT_ASSERT(bt_packet_borrow_context_field(
2501 notit->packet) ==
2502 notit->dscopes.stream_packet_context);
2503 }
2504
2505 BT_ASSERT(notit->msg_iter);
2506
2507 if (bt_stream_class_borrow_default_clock_class(notit->meta.sc->ir_sc)) {
2508 uint64_t value = 0;
2509
2510 if (notit->snapshots.beginning_clock == UINT64_C(-1)) {
2511 if (notit->prev_packet_snapshots.end_clock != UINT64_C(-1)) {
2512 value = notit->prev_packet_snapshots.end_clock;
2513 }
2514 } else {
2515 value = notit->snapshots.beginning_clock;
2516 }
2517
2518
2519 msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
2520 notit->msg_iter, notit->packet, value);
2521 } else {
2522 msg = bt_message_packet_beginning_create(notit->msg_iter,
2523 notit->packet);
2524 }
2525
2526 if (!msg) {
2527 BT_LOGE("Cannot create packet beginning message: "
2528 "notit-addr=%p, packet-addr=%p",
2529 notit, notit->packet);
2530 goto end;
2531 }
2532
2533 *message = msg;
2534
2535 end:
2536 return;
2537 }
2538
2539 static
2540 void create_msg_packet_end(struct bt_msg_iter *notit, bt_message **message)
2541 {
2542 bt_message *msg;
2543
2544 if (!notit->packet) {
2545 return;
2546 }
2547
2548 /* Update default clock from packet's end time */
2549 if (notit->snapshots.end_clock != UINT64_C(-1)) {
2550 notit->default_clock_snapshot = notit->snapshots.end_clock;
2551 }
2552
2553 BT_ASSERT(notit->msg_iter);
2554
2555 if (bt_stream_class_borrow_default_clock_class(notit->meta.sc->ir_sc)) {
2556 if (notit->snapshots.end_clock == UINT64_C(-1)) {
2557 notit->snapshots.end_clock =
2558 notit->default_clock_snapshot;
2559 }
2560
2561 BT_ASSERT(notit->snapshots.end_clock != UINT64_C(-1));
2562 msg = bt_message_packet_end_create_with_default_clock_snapshot(
2563 notit->msg_iter, notit->packet,
2564 notit->snapshots.end_clock);
2565 } else {
2566 msg = bt_message_packet_end_create(notit->msg_iter,
2567 notit->packet);
2568 }
2569
2570 if (!msg) {
2571 BT_LOGE("Cannot create packet end message: "
2572 "notit-addr=%p, packet-addr=%p",
2573 notit, notit->packet);
2574 return;
2575
2576 }
2577
2578 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
2579 *message = msg;
2580 }
2581
2582 static
2583 void create_msg_discarded_events(struct bt_msg_iter *notit,
2584 bt_message **message)
2585 {
2586 bt_message *msg;
2587 uint64_t beginning_raw_value = UINT64_C(-1);
2588 uint64_t end_raw_value = UINT64_C(-1);
2589 uint64_t count = UINT64_C(-1);
2590
2591 BT_ASSERT(notit->msg_iter);
2592 BT_ASSERT(notit->stream);
2593
2594 if (notit->prev_packet_snapshots.discarded_events == UINT64_C(-1)) {
2595 /*
2596 * We discarded events, but before (and possibly
2597 * including) the current packet: use this packet's time
2598 * range, and do not have a specific count.
2599 */
2600 beginning_raw_value = notit->snapshots.beginning_clock;
2601 end_raw_value = notit->snapshots.end_clock;
2602 } else {
2603 count = notit->snapshots.discarded_events -
2604 notit->prev_packet_snapshots.discarded_events;
2605 BT_ASSERT(count > 0);
2606 beginning_raw_value = notit->prev_packet_snapshots.end_clock;
2607 end_raw_value = notit->snapshots.end_clock;
2608 }
2609
2610 if (beginning_raw_value != UINT64_C(-1) &&
2611 end_raw_value != UINT64_C(-1)) {
2612 msg = bt_message_discarded_events_create_with_default_clock_snapshots(
2613 notit->msg_iter, notit->stream, beginning_raw_value,
2614 end_raw_value);
2615 } else {
2616 msg = bt_message_discarded_events_create(notit->msg_iter,
2617 notit->stream);
2618 }
2619
2620 if (!msg) {
2621 BT_LOGE("Cannot create discarded events message: "
2622 "notit-addr=%p, stream-addr=%p",
2623 notit, notit->stream);
2624 return;
2625 }
2626
2627 if (count != UINT64_C(-1)) {
2628 bt_message_discarded_events_set_count(msg, count);
2629 }
2630
2631 *message = msg;
2632 }
2633
2634 static
2635 void create_msg_discarded_packets(struct bt_msg_iter *notit,
2636 bt_message **message)
2637 {
2638 bt_message *msg;
2639
2640 BT_ASSERT(notit->msg_iter);
2641 BT_ASSERT(notit->stream);
2642 BT_ASSERT(notit->prev_packet_snapshots.packets !=
2643 UINT64_C(-1));
2644
2645 if (notit->prev_packet_snapshots.end_clock != UINT64_C(-1) &&
2646 notit->snapshots.beginning_clock != UINT64_C(-1)) {
2647 msg = bt_message_discarded_packets_create_with_default_clock_snapshots(
2648 notit->msg_iter, notit->stream,
2649 notit->prev_packet_snapshots.end_clock,
2650 notit->snapshots.beginning_clock);
2651 } else {
2652 msg = bt_message_discarded_packets_create(notit->msg_iter,
2653 notit->stream);
2654 }
2655
2656 if (!msg) {
2657 BT_LOGE("Cannot create discarded packets message: "
2658 "notit-addr=%p, stream-addr=%p",
2659 notit, notit->stream);
2660 return;
2661 }
2662
2663 bt_message_discarded_packets_set_count(msg,
2664 notit->snapshots.packets -
2665 notit->prev_packet_snapshots.packets - 1);
2666 *message = msg;
2667 }
2668
2669 BT_HIDDEN
2670 struct bt_msg_iter *bt_msg_iter_create(struct ctf_trace_class *tc,
2671 size_t max_request_sz,
2672 struct bt_msg_iter_medium_ops medops, void *data)
2673 {
2674 struct bt_msg_iter *notit = NULL;
2675 struct bt_bfcr_cbs cbs = {
2676 .classes = {
2677 .signed_int = bfcr_signed_int_cb,
2678 .unsigned_int = bfcr_unsigned_int_cb,
2679 .floating_point = bfcr_floating_point_cb,
2680 .string_begin = bfcr_string_begin_cb,
2681 .string = bfcr_string_cb,
2682 .string_end = bfcr_string_end_cb,
2683 .compound_begin = bfcr_compound_begin_cb,
2684 .compound_end = bfcr_compound_end_cb,
2685 },
2686 .query = {
2687 .get_sequence_length = bfcr_get_sequence_length_cb,
2688 .borrow_variant_selected_field_class = bfcr_borrow_variant_selected_field_class_cb,
2689 },
2690 };
2691
2692 BT_ASSERT(tc);
2693 BT_ASSERT(medops.request_bytes);
2694 BT_ASSERT(medops.borrow_stream);
2695 BT_LOGD("Creating CTF plugin message iterator: "
2696 "trace-addr=%p, max-request-size=%zu, "
2697 "data=%p", tc, max_request_sz, data);
2698 notit = g_new0(struct bt_msg_iter, 1);
2699 if (!notit) {
2700 BT_LOGE_STR("Failed to allocate one CTF plugin message iterator.");
2701 goto end;
2702 }
2703 notit->meta.tc = tc;
2704 notit->medium.medops = medops;
2705 notit->medium.max_request_sz = max_request_sz;
2706 notit->medium.data = data;
2707 notit->stack = stack_new(notit);
2708 notit->stored_values = g_array_new(FALSE, TRUE, sizeof(uint64_t));
2709 g_array_set_size(notit->stored_values, tc->stored_value_count);
2710
2711 if (!notit->stack) {
2712 BT_LOGE_STR("Failed to create field stack.");
2713 goto error;
2714 }
2715
2716 notit->bfcr = bt_bfcr_create(cbs, notit);
2717 if (!notit->bfcr) {
2718 BT_LOGE_STR("Failed to create binary class reader (BFCR).");
2719 goto error;
2720 }
2721
2722 bt_msg_iter_reset(notit);
2723 BT_LOGD("Created CTF plugin message iterator: "
2724 "trace-addr=%p, max-request-size=%zu, "
2725 "data=%p, notit-addr=%p",
2726 tc, max_request_sz, data, notit);
2727 notit->cur_packet_offset = 0;
2728
2729 end:
2730 return notit;
2731
2732 error:
2733 bt_msg_iter_destroy(notit);
2734 notit = NULL;
2735 goto end;
2736 }
2737
2738 void bt_msg_iter_destroy(struct bt_msg_iter *notit)
2739 {
2740 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
2741 BT_STREAM_PUT_REF_AND_RESET(notit->stream);
2742 release_all_dscopes(notit);
2743
2744 BT_LOGD("Destroying CTF plugin message iterator: addr=%p", notit);
2745
2746 if (notit->stack) {
2747 BT_LOGD_STR("Destroying field stack.");
2748 stack_destroy(notit->stack);
2749 }
2750
2751 if (notit->bfcr) {
2752 BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit->bfcr);
2753 bt_bfcr_destroy(notit->bfcr);
2754 }
2755
2756 if (notit->stored_values) {
2757 g_array_free(notit->stored_values, TRUE);
2758 }
2759
2760 g_free(notit);
2761 }
2762
2763 enum bt_msg_iter_status bt_msg_iter_get_next_message(
2764 struct bt_msg_iter *notit,
2765 bt_self_message_iterator *msg_iter, bt_message **message)
2766 {
2767 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
2768
2769 BT_ASSERT(notit);
2770 BT_ASSERT(message);
2771 notit->msg_iter = msg_iter;
2772 notit->set_stream = true;
2773 BT_LOGV("Getting next message: notit-addr=%p", notit);
2774
2775 while (true) {
2776 status = handle_state(notit);
2777 if (unlikely(status == BT_MSG_ITER_STATUS_AGAIN)) {
2778 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2779 goto end;
2780 } else if (unlikely(status != BT_MSG_ITER_STATUS_OK)) {
2781 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2782 notit, state_string(notit->state));
2783 goto end;
2784 }
2785
2786 switch (notit->state) {
2787 case STATE_EMIT_MSG_EVENT:
2788 BT_ASSERT(notit->event_msg);
2789 *message = notit->event_msg;
2790 notit->event_msg = NULL;
2791 goto end;
2792 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2793 /* create_msg_discared_events() logs errors */
2794 create_msg_discarded_events(notit, message);
2795
2796 if (!*message) {
2797 status = BT_MSG_ITER_STATUS_ERROR;
2798 }
2799
2800 goto end;
2801 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2802 /* create_msg_discared_packets() logs errors */
2803 create_msg_discarded_packets(notit, message);
2804
2805 if (!*message) {
2806 status = BT_MSG_ITER_STATUS_ERROR;
2807 }
2808
2809 goto end;
2810 case STATE_EMIT_MSG_PACKET_BEGINNING:
2811 /* create_msg_packet_beginning() logs errors */
2812 create_msg_packet_beginning(notit, message);
2813
2814 if (!*message) {
2815 status = BT_MSG_ITER_STATUS_ERROR;
2816 }
2817
2818 goto end;
2819 case STATE_EMIT_MSG_PACKET_END_SINGLE:
2820 case STATE_EMIT_MSG_PACKET_END_MULTI:
2821 /* create_msg_packet_end() logs errors */
2822 create_msg_packet_end(notit, message);
2823
2824 if (!*message) {
2825 status = BT_MSG_ITER_STATUS_ERROR;
2826 }
2827
2828 goto end;
2829 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
2830 /* create_msg_stream_activity_beginning() logs errors */
2831 create_msg_stream_activity_beginning(notit, message);
2832
2833 if (!*message) {
2834 status = BT_MSG_ITER_STATUS_ERROR;
2835 }
2836
2837 goto end;
2838 case STATE_EMIT_MSG_STREAM_ACTIVITY_END:
2839 /* create_msg_stream_activity_end() logs errors */
2840 create_msg_stream_activity_end(notit, message);
2841
2842 if (!*message) {
2843 status = BT_MSG_ITER_STATUS_ERROR;
2844 }
2845
2846 goto end;
2847 case STATE_EMIT_MSG_STREAM_BEGINNING:
2848 /* create_msg_stream_beginning() logs errors */
2849 create_msg_stream_beginning(notit, message);
2850
2851 if (!*message) {
2852 status = BT_MSG_ITER_STATUS_ERROR;
2853 }
2854
2855 goto end;
2856 case STATE_EMIT_MSG_STREAM_END:
2857 /* create_msg_stream_end() logs errors */
2858 create_msg_stream_end(notit, message);
2859
2860 if (!*message) {
2861 status = BT_MSG_ITER_STATUS_ERROR;
2862 }
2863
2864 goto end;
2865 case STATE_DONE:
2866 status = BT_MSG_ITER_STATUS_EOF;
2867 goto end;
2868 default:
2869 /* Non-emitting state: continue */
2870 break;
2871 }
2872 }
2873
2874 end:
2875 return status;
2876 }
2877
2878 static
2879 enum bt_msg_iter_status read_packet_header_context_fields(
2880 struct bt_msg_iter *notit)
2881 {
2882 int ret;
2883 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
2884
2885 BT_ASSERT(notit);
2886 notit->set_stream = false;
2887
2888 if (notit->state == STATE_EMIT_MSG_PACKET_BEGINNING) {
2889 /* We're already there */
2890 goto end;
2891 }
2892
2893 while (true) {
2894 status = handle_state(notit);
2895 if (unlikely(status == BT_MSG_ITER_STATUS_AGAIN)) {
2896 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2897 goto end;
2898 } else if (unlikely(status != BT_MSG_ITER_STATUS_OK)) {
2899 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2900 notit, state_string(notit->state));
2901 goto end;
2902 }
2903
2904 switch (notit->state) {
2905 case STATE_EMIT_MSG_PACKET_BEGINNING:
2906 /*
2907 * Packet header and context fields are
2908 * potentially decoded (or they don't exist).
2909 */
2910 goto end;
2911 case STATE_INIT:
2912 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
2913 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
2914 case STATE_AFTER_TRACE_PACKET_HEADER:
2915 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
2916 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
2917 case STATE_AFTER_STREAM_PACKET_CONTEXT:
2918 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING:
2919 case STATE_EMIT_MSG_STREAM_BEGINNING:
2920 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
2921 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS:
2922 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2923 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS:
2924 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2925 /* Non-emitting state: continue */
2926 break;
2927 default:
2928 /*
2929 * We should never get past the
2930 * STATE_EMIT_MSG_PACKET_BEGINNING state.
2931 */
2932 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
2933 notit, state_string(notit->state));
2934 abort();
2935 }
2936 }
2937
2938 end:
2939 ret = set_current_packet_content_sizes(notit);
2940 if (ret) {
2941 status = BT_MSG_ITER_STATUS_ERROR;
2942 }
2943
2944 return status;
2945 }
2946
2947 BT_HIDDEN
2948 void bt_msg_iter_set_medops_data(struct bt_msg_iter *notit,
2949 void *medops_data)
2950 {
2951 BT_ASSERT(notit);
2952 notit->medium.data = medops_data;
2953 }
2954
2955 BT_HIDDEN
2956 enum bt_msg_iter_status bt_msg_iter_seek(struct bt_msg_iter *notit,
2957 off_t offset)
2958 {
2959 enum bt_msg_iter_status ret = BT_MSG_ITER_STATUS_OK;
2960 enum bt_msg_iter_medium_status medium_status;
2961
2962 BT_ASSERT(notit);
2963 if (offset < 0) {
2964 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset);
2965 ret = BT_MSG_ITER_STATUS_INVAL;
2966 goto end;
2967 }
2968
2969 if (!notit->medium.medops.seek) {
2970 ret = BT_MSG_ITER_STATUS_UNSUPPORTED;
2971 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2972 goto end;
2973 }
2974
2975 medium_status = notit->medium.medops.seek(
2976 BT_MSG_ITER_SEEK_WHENCE_SET, offset, notit->medium.data);
2977 if (medium_status != BT_MSG_ITER_MEDIUM_STATUS_OK) {
2978 if (medium_status == BT_MSG_ITER_MEDIUM_STATUS_EOF) {
2979 ret = BT_MSG_ITER_STATUS_EOF;
2980 } else {
2981 ret = BT_MSG_ITER_STATUS_ERROR;
2982 goto end;
2983 }
2984 }
2985
2986 bt_msg_iter_reset(notit);
2987 notit->cur_packet_offset = offset;
2988
2989 end:
2990 return ret;
2991 }
2992
2993 BT_HIDDEN
2994 enum bt_msg_iter_status bt_msg_iter_get_packet_properties(
2995 struct bt_msg_iter *notit,
2996 struct bt_msg_iter_packet_properties *props)
2997 {
2998 enum bt_msg_iter_status status;
2999
3000 BT_ASSERT(notit);
3001 BT_ASSERT(props);
3002 status = read_packet_header_context_fields(notit);
3003 if (status != BT_MSG_ITER_STATUS_OK) {
3004 goto end;
3005 }
3006
3007 props->exp_packet_total_size = notit->cur_exp_packet_total_size;
3008 props->exp_packet_content_size = notit->cur_exp_packet_content_size;
3009 props->stream_class_id = (uint64_t) notit->cur_stream_class_id;
3010 BT_ASSERT(props->stream_class_id >= 0);
3011 props->data_stream_id = notit->cur_data_stream_id;
3012 props->snapshots.discarded_events = notit->snapshots.discarded_events;
3013 props->snapshots.packets = notit->snapshots.packets;
3014 props->snapshots.beginning_clock = notit->snapshots.beginning_clock;
3015 props->snapshots.end_clock = notit->snapshots.end_clock;
3016
3017 end:
3018 return status;
3019 }
3020
3021 BT_HIDDEN
3022 void bt_msg_iter_set_emit_stream_beginning_message(struct bt_msg_iter *notit,
3023 bool val)
3024 {
3025 notit->emit_stream_begin_msg = val;
3026 }
3027
3028 BT_HIDDEN
3029 void bt_msg_iter_set_emit_stream_end_message(struct bt_msg_iter *notit,
3030 bool val)
3031 {
3032 notit->emit_stream_end_msg = val;
3033 }
BabelTrace - Trace Format Babel Tower
This page took 0.088703 seconds and 5 git commands to generate.