projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
lib: remove redundant `bt_packet` properties
[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 BT_LOGW("Content size is set, but packet size is not: "
973 "notit-addr=%p, packet-context-field-addr=%p, "
974 "packet-size=%" PRId64 ", content-size=%" PRId64,
975 notit, notit->dscopes.stream_packet_context,
976 notit->cur_exp_packet_total_size,
977 notit->cur_exp_packet_content_size);
978 status = BT_MSG_ITER_STATUS_ERROR;
979 goto end;
980 }
981 } else {
982 if (notit->cur_exp_packet_content_size == -1) {
983 notit->cur_exp_packet_content_size =
984 notit->cur_exp_packet_total_size;
985 }
986 }
987
988 if (notit->cur_exp_packet_content_size >
989 notit->cur_exp_packet_total_size) {
990 BT_LOGW("Invalid packet or content size: "
991 "content size is greater than packet size: "
992 "notit-addr=%p, packet-context-field-addr=%p, "
993 "packet-size=%" PRId64 ", content-size=%" PRId64,
994 notit, notit->dscopes.stream_packet_context,
995 notit->cur_exp_packet_total_size,
996 notit->cur_exp_packet_content_size);
997 status = BT_MSG_ITER_STATUS_ERROR;
998 goto end;
999 }
1000
1001 BT_LOGV("Set current packet and content sizes: "
1002 "notit-addr=%p, packet-size=%" PRIu64 ", content-size=%" PRIu64,
1003 notit, notit->cur_exp_packet_total_size,
1004 notit->cur_exp_packet_content_size);
1005
1006 end:
1007 return status;
1008 }
1009
1010 static
1011 enum bt_msg_iter_status after_packet_context_state(struct bt_msg_iter *notit)
1012 {
1013 enum bt_msg_iter_status status;
1014
1015 status = set_current_packet_content_sizes(notit);
1016 if (status != BT_MSG_ITER_STATUS_OK) {
1017 goto end;
1018 }
1019
1020 if (notit->stream) {
1021 /*
1022 * Stream exists, which means we already emitted at
1023 * least one packet beginning message, so the initial
1024 * stream beginning message was also emitted.
1025 */
1026 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1027 } else {
1028 notit->state = STATE_CHECK_EMIT_MSG_STREAM_BEGINNING;
1029 }
1030
1031 end:
1032 return status;
1033 }
1034
1035 static
1036 enum bt_msg_iter_status read_event_header_begin_state(struct bt_msg_iter *notit)
1037 {
1038 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1039 struct ctf_field_class *event_header_fc = NULL;
1040
1041 /* Reset the position of the last event header */
1042 notit->buf.last_eh_at = notit->buf.at;
1043 notit->cur_event_class_id = -1;
1044
1045 /* Check if we have some content left */
1046 if (notit->cur_exp_packet_content_size >= 0) {
1047 if (unlikely(packet_at(notit) ==
1048 notit->cur_exp_packet_content_size)) {
1049 /* No more events! */
1050 BT_LOGV("Reached end of packet: notit-addr=%p, "
1051 "cur=%zu", notit, packet_at(notit));
1052 notit->state = STATE_EMIT_MSG_PACKET_END_MULTI;
1053 goto end;
1054 } else if (unlikely(packet_at(notit) >
1055 notit->cur_exp_packet_content_size)) {
1056 /* That's not supposed to happen */
1057 BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
1058 "notit-addr=%p, content-size=%" PRId64 ", "
1059 "cur=%zu", notit,
1060 notit->cur_exp_packet_content_size,
1061 packet_at(notit));
1062 status = BT_MSG_ITER_STATUS_ERROR;
1063 goto end;
1064 }
1065 } else {
1066 /*
1067 * "Infinite" content: we're done when the medium has
1068 * nothing else for us.
1069 */
1070 status = buf_ensure_available_bits(notit);
1071 switch (status) {
1072 case BT_MSG_ITER_STATUS_OK:
1073 break;
1074 case BT_MSG_ITER_STATUS_EOF:
1075 status = BT_MSG_ITER_STATUS_OK;
1076 notit->state = STATE_EMIT_MSG_PACKET_END_SINGLE;
1077 goto end;
1078 default:
1079 goto end;
1080 }
1081 }
1082
1083 release_event_dscopes(notit);
1084 BT_ASSERT(notit->meta.sc);
1085 event_header_fc = notit->meta.sc->event_header_fc;
1086 if (!event_header_fc) {
1087 notit->state = STATE_AFTER_EVENT_HEADER;
1088 goto end;
1089 }
1090
1091 BT_LOGV("Decoding event header field: "
1092 "notit-addr=%p, stream-class-addr=%p, "
1093 "stream-class-id=%" PRId64 ", "
1094 "fc-addr=%p",
1095 notit, notit->meta.sc,
1096 notit->meta.sc->id,
1097 event_header_fc);
1098 status = read_dscope_begin_state(notit, event_header_fc,
1099 STATE_AFTER_EVENT_HEADER,
1100 STATE_DSCOPE_EVENT_HEADER_CONTINUE, NULL);
1101 if (status < 0) {
1102 BT_LOGW("Cannot decode event header field: "
1103 "notit-addr=%p, stream-class-addr=%p, "
1104 "stream-class-id=%" PRId64 ", fc-addr=%p",
1105 notit, notit->meta.sc,
1106 notit->meta.sc->id,
1107 event_header_fc);
1108 }
1109
1110 end:
1111 return status;
1112 }
1113
1114 static
1115 enum bt_msg_iter_status read_event_header_continue_state(
1116 struct bt_msg_iter *notit)
1117 {
1118 return read_dscope_continue_state(notit,
1119 STATE_AFTER_EVENT_HEADER);
1120 }
1121
1122 static inline
1123 enum bt_msg_iter_status set_current_event_class(struct bt_msg_iter *notit)
1124 {
1125 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1126
1127 struct ctf_event_class *new_event_class = NULL;
1128
1129 if (notit->cur_event_class_id == -1) {
1130 /*
1131 * No current event class ID field, therefore only one
1132 * event class.
1133 */
1134 if (notit->meta.sc->event_classes->len != 1) {
1135 BT_LOGW("Need exactly one event class since there's "
1136 "no event class ID field: "
1137 "notit-addr=%p", notit);
1138 status = BT_MSG_ITER_STATUS_ERROR;
1139 goto end;
1140 }
1141
1142 new_event_class = notit->meta.sc->event_classes->pdata[0];
1143 notit->cur_event_class_id = new_event_class->id;
1144 }
1145
1146 new_event_class = ctf_stream_class_borrow_event_class_by_id(
1147 notit->meta.sc, notit->cur_event_class_id);
1148 if (!new_event_class) {
1149 BT_LOGW("No event class with ID of event class ID to use in stream class: "
1150 "notit-addr=%p, stream-class-id=%" PRIu64 ", "
1151 "event-class-id=%" PRIu64 ", "
1152 "trace-class-addr=%p",
1153 notit, notit->meta.sc->id, notit->cur_event_class_id,
1154 notit->meta.tc);
1155 status = BT_MSG_ITER_STATUS_ERROR;
1156 goto end;
1157 }
1158
1159 notit->meta.ec = new_event_class;
1160 BT_LOGV("Set current event class: "
1161 "notit-addr=%p, event-class-addr=%p, "
1162 "event-class-id=%" PRId64 ", "
1163 "event-class-name=\"%s\"",
1164 notit, notit->meta.ec, notit->meta.ec->id,
1165 notit->meta.ec->name->str);
1166
1167 end:
1168 return status;
1169 }
1170
1171 static inline
1172 enum bt_msg_iter_status set_current_event_message(
1173 struct bt_msg_iter *notit)
1174 {
1175 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1176 bt_message *msg = NULL;
1177
1178 BT_ASSERT(notit->meta.ec);
1179 BT_ASSERT(notit->packet);
1180 BT_LOGV("Creating event message from event class and packet: "
1181 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
1182 notit, notit->meta.ec,
1183 notit->meta.ec->name->str,
1184 notit->packet);
1185 BT_ASSERT(notit->msg_iter);
1186 msg = bt_message_event_create(notit->msg_iter,
1187 notit->meta.ec->ir_ec, notit->packet);
1188 if (!msg) {
1189 BT_LOGE("Cannot create event message: "
1190 "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
1191 "packet-addr=%p",
1192 notit, notit->meta.ec,
1193 notit->meta.ec->name->str,
1194 notit->packet);
1195 goto error;
1196 }
1197
1198 goto end;
1199
1200 error:
1201 BT_MESSAGE_PUT_REF_AND_RESET(msg);
1202 status = BT_MSG_ITER_STATUS_ERROR;
1203
1204 end:
1205 BT_MESSAGE_MOVE_REF(notit->event_msg, msg);
1206 return status;
1207 }
1208
1209 static
1210 enum bt_msg_iter_status after_event_header_state(
1211 struct bt_msg_iter *notit)
1212 {
1213 enum bt_msg_iter_status status;
1214
1215 status = set_current_event_class(notit);
1216 if (status != BT_MSG_ITER_STATUS_OK) {
1217 goto end;
1218 }
1219
1220 status = set_current_event_message(notit);
1221 if (status != BT_MSG_ITER_STATUS_OK) {
1222 goto end;
1223 }
1224
1225 notit->event = bt_message_event_borrow_event(
1226 notit->event_msg);
1227 BT_ASSERT(notit->event);
1228 notit->state = STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN;
1229
1230 end:
1231 return status;
1232 }
1233
1234 static
1235 enum bt_msg_iter_status read_event_common_context_begin_state(
1236 struct bt_msg_iter *notit)
1237 {
1238 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1239 struct ctf_field_class *event_common_context_fc;
1240
1241 event_common_context_fc = notit->meta.sc->event_common_context_fc;
1242 if (!event_common_context_fc) {
1243 notit->state = STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN;
1244 goto end;
1245 }
1246
1247 if (event_common_context_fc->in_ir) {
1248 BT_ASSERT(!notit->dscopes.event_common_context);
1249 notit->dscopes.event_common_context =
1250 bt_event_borrow_common_context_field(
1251 notit->event);
1252 BT_ASSERT(notit->dscopes.event_common_context);
1253 }
1254
1255 BT_LOGV("Decoding event common context field: "
1256 "notit-addr=%p, stream-class-addr=%p, "
1257 "stream-class-id=%" PRId64 ", "
1258 "fc-addr=%p",
1259 notit, notit->meta.sc,
1260 notit->meta.sc->id,
1261 event_common_context_fc);
1262 status = read_dscope_begin_state(notit, event_common_context_fc,
1263 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN,
1264 STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE,
1265 notit->dscopes.event_common_context);
1266 if (status < 0) {
1267 BT_LOGW("Cannot decode event common context field: "
1268 "notit-addr=%p, stream-class-addr=%p, "
1269 "stream-class-id=%" PRId64 ", fc-addr=%p",
1270 notit, notit->meta.sc,
1271 notit->meta.sc->id,
1272 event_common_context_fc);
1273 }
1274
1275 end:
1276 return status;
1277 }
1278
1279 static
1280 enum bt_msg_iter_status read_event_common_context_continue_state(
1281 struct bt_msg_iter *notit)
1282 {
1283 return read_dscope_continue_state(notit,
1284 STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN);
1285 }
1286
1287 static
1288 enum bt_msg_iter_status read_event_spec_context_begin_state(
1289 struct bt_msg_iter *notit)
1290 {
1291 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1292 struct ctf_field_class *event_spec_context_fc;
1293
1294 event_spec_context_fc = notit->meta.ec->spec_context_fc;
1295 if (!event_spec_context_fc) {
1296 notit->state = STATE_DSCOPE_EVENT_PAYLOAD_BEGIN;
1297 goto end;
1298 }
1299
1300 if (event_spec_context_fc->in_ir) {
1301 BT_ASSERT(!notit->dscopes.event_spec_context);
1302 notit->dscopes.event_spec_context =
1303 bt_event_borrow_specific_context_field(
1304 notit->event);
1305 BT_ASSERT(notit->dscopes.event_spec_context);
1306 }
1307
1308 BT_LOGV("Decoding event specific context field: "
1309 "notit-addr=%p, event-class-addr=%p, "
1310 "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
1311 "fc-addr=%p",
1312 notit, notit->meta.ec,
1313 notit->meta.ec->name->str,
1314 notit->meta.ec->id,
1315 event_spec_context_fc);
1316 status = read_dscope_begin_state(notit, event_spec_context_fc,
1317 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN,
1318 STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE,
1319 notit->dscopes.event_spec_context);
1320 if (status < 0) {
1321 BT_LOGW("Cannot decode event specific context field: "
1322 "notit-addr=%p, event-class-addr=%p, "
1323 "event-class-name=\"%s\", "
1324 "event-class-id=%" PRId64 ", fc-addr=%p",
1325 notit, notit->meta.ec,
1326 notit->meta.ec->name->str,
1327 notit->meta.ec->id,
1328 event_spec_context_fc);
1329 }
1330
1331 end:
1332 return status;
1333 }
1334
1335 static
1336 enum bt_msg_iter_status read_event_spec_context_continue_state(
1337 struct bt_msg_iter *notit)
1338 {
1339 return read_dscope_continue_state(notit,
1340 STATE_DSCOPE_EVENT_PAYLOAD_BEGIN);
1341 }
1342
1343 static
1344 enum bt_msg_iter_status read_event_payload_begin_state(
1345 struct bt_msg_iter *notit)
1346 {
1347 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1348 struct ctf_field_class *event_payload_fc;
1349
1350 event_payload_fc = notit->meta.ec->payload_fc;
1351 if (!event_payload_fc) {
1352 notit->state = STATE_EMIT_MSG_EVENT;
1353 goto end;
1354 }
1355
1356 if (event_payload_fc->in_ir) {
1357 BT_ASSERT(!notit->dscopes.event_payload);
1358 notit->dscopes.event_payload =
1359 bt_event_borrow_payload_field(
1360 notit->event);
1361 BT_ASSERT(notit->dscopes.event_payload);
1362 }
1363
1364 BT_LOGV("Decoding event payload field: "
1365 "notit-addr=%p, event-class-addr=%p, "
1366 "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
1367 "fc-addr=%p",
1368 notit, notit->meta.ec,
1369 notit->meta.ec->name->str,
1370 notit->meta.ec->id,
1371 event_payload_fc);
1372 status = read_dscope_begin_state(notit, event_payload_fc,
1373 STATE_EMIT_MSG_EVENT,
1374 STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE,
1375 notit->dscopes.event_payload);
1376 if (status < 0) {
1377 BT_LOGW("Cannot decode event payload field: "
1378 "notit-addr=%p, event-class-addr=%p, "
1379 "event-class-name=\"%s\", "
1380 "event-class-id=%" PRId64 ", fc-addr=%p",
1381 notit, notit->meta.ec,
1382 notit->meta.ec->name->str,
1383 notit->meta.ec->id,
1384 event_payload_fc);
1385 }
1386
1387 end:
1388 return status;
1389 }
1390
1391 static
1392 enum bt_msg_iter_status read_event_payload_continue_state(
1393 struct bt_msg_iter *notit)
1394 {
1395 return read_dscope_continue_state(notit, STATE_EMIT_MSG_EVENT);
1396 }
1397
1398 static
1399 enum bt_msg_iter_status skip_packet_padding_state(struct bt_msg_iter *notit)
1400 {
1401 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1402 size_t bits_to_skip;
1403
1404 BT_ASSERT(notit->cur_exp_packet_total_size > 0);
1405 bits_to_skip = notit->cur_exp_packet_total_size - packet_at(notit);
1406 if (bits_to_skip == 0) {
1407 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1408 goto end;
1409 } else {
1410 size_t bits_to_consume;
1411
1412 BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
1413 bits_to_skip, notit, bits_to_skip);
1414 status = buf_ensure_available_bits(notit);
1415 if (status != BT_MSG_ITER_STATUS_OK) {
1416 goto end;
1417 }
1418
1419 bits_to_consume = MIN(buf_available_bits(notit), bits_to_skip);
1420 BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
1421 bits_to_consume, notit, bits_to_consume);
1422 buf_consume_bits(notit, bits_to_consume);
1423 bits_to_skip = notit->cur_exp_packet_total_size -
1424 packet_at(notit);
1425 if (bits_to_skip == 0) {
1426 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1427 goto end;
1428 }
1429 }
1430
1431 end:
1432 return status;
1433 }
1434
1435 static
1436 enum bt_msg_iter_status check_emit_msg_stream_beginning_state(
1437 struct bt_msg_iter *notit)
1438 {
1439 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1440
1441 if (notit->set_stream) {
1442 status = set_current_stream(notit);
1443 if (status != BT_MSG_ITER_STATUS_OK) {
1444 goto end;
1445 }
1446 }
1447
1448 if (notit->emit_stream_begin_msg) {
1449 notit->state = STATE_EMIT_MSG_STREAM_BEGINNING;
1450 } else {
1451 /* Stream's first packet */
1452 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1453 }
1454
1455 end:
1456 return status;
1457 }
1458
1459 static
1460 enum bt_msg_iter_status check_emit_msg_discarded_events(
1461 struct bt_msg_iter *notit)
1462 {
1463 notit->state = STATE_EMIT_MSG_DISCARDED_EVENTS;
1464
1465 if (notit->prev_packet_snapshots.discarded_events == UINT64_C(-1)) {
1466 if (notit->snapshots.discarded_events == 0 ||
1467 notit->snapshots.discarded_events == UINT64_C(-1)) {
1468 /*
1469 * Stream's first packet with no discarded
1470 * events or no information about discarded
1471 * events: do not emit.
1472 */
1473 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1474 }
1475 } else {
1476 /*
1477 * If the previous packet has a value for this counter,
1478 * then this counter is defined for the whole stream.
1479 */
1480 BT_ASSERT(notit->snapshots.discarded_events != UINT64_C(-1));
1481
1482 if (notit->snapshots.discarded_events -
1483 notit->prev_packet_snapshots.discarded_events == 0) {
1484 /*
1485 * No discarded events since previous packet: do
1486 * not emit.
1487 */
1488 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1489 }
1490 }
1491
1492 return BT_MSG_ITER_STATUS_OK;
1493 }
1494
1495 static
1496 enum bt_msg_iter_status check_emit_msg_discarded_packets(
1497 struct bt_msg_iter *notit)
1498 {
1499 notit->state = STATE_EMIT_MSG_DISCARDED_PACKETS;
1500
1501 if (notit->prev_packet_snapshots.packets == UINT64_C(-1)) {
1502 /*
1503 * Stream's first packet or no information about
1504 * discarded packets: do not emit. In other words, if
1505 * this is the first packet and its sequence number is
1506 * not 0, do not consider that packets were previously
1507 * lost: we might be reading a partial stream (LTTng
1508 * snapshot for example).
1509 */
1510 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1511 } else {
1512 /*
1513 * If the previous packet has a value for this counter,
1514 * then this counter is defined for the whole stream.
1515 */
1516 BT_ASSERT(notit->snapshots.packets != UINT64_C(-1));
1517
1518 if (notit->snapshots.packets -
1519 notit->prev_packet_snapshots.packets <= 1) {
1520 /*
1521 * No discarded packets since previous packet:
1522 * do not emit.
1523 */
1524 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1525 }
1526 }
1527
1528 return BT_MSG_ITER_STATUS_OK;
1529 }
1530
1531 static
1532 enum bt_msg_iter_status check_emit_msg_stream_activity_end(
1533 struct bt_msg_iter *notit)
1534 {
1535 if (notit->emit_stream_end_msg) {
1536 notit->state = STATE_EMIT_MSG_STREAM_ACTIVITY_END;
1537 } else {
1538 notit->state = STATE_DONE;
1539 }
1540
1541 return BT_MSG_ITER_STATUS_OK;
1542 }
1543
1544 static inline
1545 enum bt_msg_iter_status handle_state(struct bt_msg_iter *notit)
1546 {
1547 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
1548 const enum state state = notit->state;
1549
1550 BT_LOGV("Handling state: notit-addr=%p, state=%s",
1551 notit, state_string(state));
1552
1553 // TODO: optimalize!
1554 switch (state) {
1555 case STATE_INIT:
1556 notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
1557 break;
1558 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
1559 status = read_packet_header_begin_state(notit);
1560 break;
1561 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
1562 status = read_packet_header_continue_state(notit);
1563 break;
1564 case STATE_AFTER_TRACE_PACKET_HEADER:
1565 status = after_packet_header_state(notit);
1566 break;
1567 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
1568 status = read_packet_context_begin_state(notit);
1569 break;
1570 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
1571 status = read_packet_context_continue_state(notit);
1572 break;
1573 case STATE_AFTER_STREAM_PACKET_CONTEXT:
1574 status = after_packet_context_state(notit);
1575 break;
1576 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING:
1577 status = check_emit_msg_stream_beginning_state(notit);
1578 break;
1579 case STATE_EMIT_MSG_STREAM_BEGINNING:
1580 notit->state = STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING;
1581 break;
1582 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
1583 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS;
1584 break;
1585 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS:
1586 status = check_emit_msg_discarded_events(notit);
1587 break;
1588 case STATE_EMIT_MSG_DISCARDED_EVENTS:
1589 notit->state = STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS;
1590 break;
1591 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS:
1592 status = check_emit_msg_discarded_packets(notit);
1593 break;
1594 case STATE_EMIT_MSG_DISCARDED_PACKETS:
1595 notit->state = STATE_EMIT_MSG_PACKET_BEGINNING;
1596 break;
1597 case STATE_EMIT_MSG_PACKET_BEGINNING:
1598 notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
1599 break;
1600 case STATE_DSCOPE_EVENT_HEADER_BEGIN:
1601 status = read_event_header_begin_state(notit);
1602 break;
1603 case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
1604 status = read_event_header_continue_state(notit);
1605 break;
1606 case STATE_AFTER_EVENT_HEADER:
1607 status = after_event_header_state(notit);
1608 break;
1609 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
1610 status = read_event_common_context_begin_state(notit);
1611 break;
1612 case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
1613 status = read_event_common_context_continue_state(notit);
1614 break;
1615 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
1616 status = read_event_spec_context_begin_state(notit);
1617 break;
1618 case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
1619 status = read_event_spec_context_continue_state(notit);
1620 break;
1621 case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
1622 status = read_event_payload_begin_state(notit);
1623 break;
1624 case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE:
1625 status = read_event_payload_continue_state(notit);
1626 break;
1627 case STATE_EMIT_MSG_EVENT:
1628 notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
1629 break;
1630 case STATE_SKIP_PACKET_PADDING:
1631 status = skip_packet_padding_state(notit);
1632 break;
1633 case STATE_EMIT_MSG_PACKET_END_MULTI:
1634 notit->state = STATE_SKIP_PACKET_PADDING;
1635 break;
1636 case STATE_EMIT_MSG_PACKET_END_SINGLE:
1637 notit->state = STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END;
1638 break;
1639 case STATE_CHECK_EMIT_MSG_STREAM_ACTIVITY_END:
1640 status = check_emit_msg_stream_activity_end(notit);
1641 break;
1642 case STATE_EMIT_MSG_STREAM_ACTIVITY_END:
1643 notit->state = STATE_EMIT_MSG_STREAM_END;
1644 break;
1645 case STATE_EMIT_MSG_STREAM_END:
1646 notit->state = STATE_DONE;
1647 break;
1648 case STATE_DONE:
1649 break;
1650 default:
1651 BT_LOGD("Unknown CTF plugin message iterator state: "
1652 "notit-addr=%p, state=%d", notit, notit->state);
1653 abort();
1654 }
1655
1656 BT_LOGV("Handled state: notit-addr=%p, status=%s, "
1657 "prev-state=%s, cur-state=%s",
1658 notit, bt_msg_iter_status_string(status),
1659 state_string(state), state_string(notit->state));
1660 return status;
1661 }
1662
1663 BT_HIDDEN
1664 void bt_msg_iter_reset_for_next_stream_file(struct bt_msg_iter *notit)
1665 {
1666 BT_ASSERT(notit);
1667 BT_LOGD("Resetting message iterator: addr=%p", notit);
1668 stack_clear(notit->stack);
1669 notit->meta.sc = NULL;
1670 notit->meta.ec = NULL;
1671 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
1672 BT_STREAM_PUT_REF_AND_RESET(notit->stream);
1673 BT_MESSAGE_PUT_REF_AND_RESET(notit->event_msg);
1674 release_all_dscopes(notit);
1675 notit->cur_dscope_field = NULL;
1676
1677 if (notit->packet_context_field) {
1678 bt_packet_context_field_release(notit->packet_context_field);
1679 notit->packet_context_field = NULL;
1680 }
1681
1682 notit->buf.addr = NULL;
1683 notit->buf.sz = 0;
1684 notit->buf.at = 0;
1685 notit->buf.last_eh_at = SIZE_MAX;
1686 notit->buf.packet_offset = 0;
1687 notit->state = STATE_INIT;
1688 notit->cur_exp_packet_content_size = -1;
1689 notit->cur_exp_packet_total_size = -1;
1690 notit->cur_packet_offset = -1;
1691 notit->cur_event_class_id = -1;
1692 notit->snapshots.beginning_clock = UINT64_C(-1);
1693 notit->snapshots.end_clock = UINT64_C(-1);
1694 }
1695
1696 /**
1697 * Resets the internal state of a CTF message iterator.
1698 */
1699 BT_HIDDEN
1700 void bt_msg_iter_reset(struct bt_msg_iter *notit)
1701 {
1702 bt_msg_iter_reset_for_next_stream_file(notit);
1703 notit->cur_stream_class_id = -1;
1704 notit->cur_data_stream_id = -1;
1705 notit->emit_stream_begin_msg = true;
1706 notit->emit_stream_end_msg = true;
1707 notit->snapshots.discarded_events = UINT64_C(-1);
1708 notit->snapshots.packets = UINT64_C(-1);
1709 notit->prev_packet_snapshots.discarded_events = UINT64_C(-1);
1710 notit->prev_packet_snapshots.packets = UINT64_C(-1);
1711 notit->prev_packet_snapshots.beginning_clock = UINT64_C(-1);
1712 notit->prev_packet_snapshots.end_clock = UINT64_C(-1);
1713 }
1714
1715 static
1716 int bt_msg_iter_switch_packet(struct bt_msg_iter *notit)
1717 {
1718 int ret = 0;
1719
1720 /*
1721 * We don't put the stream class here because we need to make
1722 * sure that all the packets processed by the same message
1723 * iterator refer to the same stream class (the first one).
1724 */
1725 BT_ASSERT(notit);
1726
1727 if (notit->cur_exp_packet_total_size != -1) {
1728 notit->cur_packet_offset += notit->cur_exp_packet_total_size;
1729 }
1730
1731 BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
1732 "packet-offset=%" PRId64, notit, notit->buf.at,
1733 notit->cur_packet_offset);
1734 stack_clear(notit->stack);
1735 notit->meta.ec = NULL;
1736 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
1737 BT_MESSAGE_PUT_REF_AND_RESET(notit->event_msg);
1738 release_all_dscopes(notit);
1739 notit->cur_dscope_field = NULL;
1740
1741 /*
1742 * Adjust current buffer so that addr points to the beginning of the new
1743 * packet.
1744 */
1745 if (notit->buf.addr) {
1746 size_t consumed_bytes = (size_t) (notit->buf.at / CHAR_BIT);
1747
1748 /* Packets are assumed to start on a byte frontier. */
1749 if (notit->buf.at % CHAR_BIT) {
1750 BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
1751 "notit-addr=%p, cur=%zu", notit, notit->buf.at);
1752 ret = -1;
1753 goto end;
1754 }
1755
1756 notit->buf.addr += consumed_bytes;
1757 notit->buf.sz -= consumed_bytes;
1758 notit->buf.at = 0;
1759 notit->buf.packet_offset = 0;
1760 BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
1761 notit->buf.addr, notit->buf.sz);
1762 }
1763
1764 notit->cur_exp_packet_content_size = -1;
1765 notit->cur_exp_packet_total_size = -1;
1766 notit->cur_stream_class_id = -1;
1767 notit->cur_event_class_id = -1;
1768 notit->cur_data_stream_id = -1;
1769 notit->prev_packet_snapshots = notit->snapshots;
1770 notit->snapshots.discarded_events = UINT64_C(-1);
1771 notit->snapshots.packets = UINT64_C(-1);
1772 notit->snapshots.beginning_clock = UINT64_C(-1);
1773 notit->snapshots.end_clock = UINT64_C(-1);
1774
1775 end:
1776 return ret;
1777 }
1778
1779 static
1780 bt_field *borrow_next_field(struct bt_msg_iter *notit)
1781 {
1782 bt_field *next_field = NULL;
1783 bt_field *base_field;
1784 const bt_field_class *base_fc;
1785 size_t index;
1786
1787 BT_ASSERT(!stack_empty(notit->stack));
1788 index = stack_top(notit->stack)->index;
1789 base_field = stack_top(notit->stack)->base;
1790 BT_ASSERT(base_field);
1791 base_fc = bt_field_borrow_class_const(base_field);
1792 BT_ASSERT(base_fc);
1793
1794 switch (bt_field_class_get_type(base_fc)) {
1795 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1796 {
1797 BT_ASSERT(index <
1798 bt_field_class_structure_get_member_count(
1799 bt_field_borrow_class_const(
1800 base_field)));
1801 next_field =
1802 bt_field_structure_borrow_member_field_by_index(
1803 base_field, index);
1804 break;
1805 }
1806 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
1807 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
1808 BT_ASSERT(index < bt_field_array_get_length(base_field));
1809 next_field = bt_field_array_borrow_element_field_by_index(
1810 base_field, index);
1811 break;
1812 case BT_FIELD_CLASS_TYPE_VARIANT:
1813 BT_ASSERT(index == 0);
1814 next_field = bt_field_variant_borrow_selected_option_field(
1815 base_field);
1816 break;
1817 default:
1818 abort();
1819 }
1820
1821 BT_ASSERT(next_field);
1822 return next_field;
1823 }
1824
1825 static
1826 void update_default_clock(struct bt_msg_iter *notit, uint64_t new_val,
1827 uint64_t new_val_size)
1828 {
1829 uint64_t new_val_mask;
1830 uint64_t cur_value_masked;
1831
1832 BT_ASSERT(new_val_size > 0);
1833
1834 /*
1835 * Special case for a 64-bit new value, which is the limit
1836 * of a clock value as of this version: overwrite the
1837 * current value directly.
1838 */
1839 if (new_val_size == 64) {
1840 notit->default_clock_snapshot = new_val;
1841 goto end;
1842 }
1843
1844 new_val_mask = (1ULL << new_val_size) - 1;
1845 cur_value_masked = notit->default_clock_snapshot & new_val_mask;
1846
1847 if (new_val < cur_value_masked) {
1848 /*
1849 * It looks like a wrap happened on the number of bits
1850 * of the requested new value. Assume that the clock
1851 * value wrapped only one time.
1852 */
1853 notit->default_clock_snapshot += new_val_mask + 1;
1854 }
1855
1856 /* Clear the low bits of the current clock value. */
1857 notit->default_clock_snapshot &= ~new_val_mask;
1858
1859 /* Set the low bits of the current clock value. */
1860 notit->default_clock_snapshot |= new_val;
1861
1862 end:
1863 BT_LOGV("Updated default clock's value from integer field's value: "
1864 "value=%" PRIu64, notit->default_clock_snapshot);
1865 }
1866
1867 static
1868 enum bt_bfcr_status bfcr_unsigned_int_cb(uint64_t value,
1869 struct ctf_field_class *fc, void *data)
1870 {
1871 struct bt_msg_iter *notit = data;
1872 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1873 bt_field *field = NULL;
1874 struct ctf_field_class_int *int_fc = (void *) fc;
1875
1876 BT_LOGV("Unsigned integer function called from BFCR: "
1877 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1878 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1879 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
1880
1881 if (likely(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE)) {
1882 goto update_def_clock;
1883 }
1884
1885 switch (int_fc->meaning) {
1886 case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID:
1887 notit->cur_event_class_id = value;
1888 break;
1889 case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID:
1890 notit->cur_data_stream_id = value;
1891 break;
1892 case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME:
1893 notit->snapshots.beginning_clock = value;
1894 break;
1895 case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME:
1896 notit->snapshots.end_clock = value;
1897 break;
1898 case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID:
1899 notit->cur_stream_class_id = value;
1900 break;
1901 case CTF_FIELD_CLASS_MEANING_MAGIC:
1902 if (value != 0xc1fc1fc1) {
1903 BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
1904 "magic=%" PRIx64, notit, value);
1905 status = BT_BFCR_STATUS_ERROR;
1906 goto end;
1907 }
1908
1909 break;
1910 case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT:
1911 notit->snapshots.packets = value;
1912 break;
1913 case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT:
1914 notit->snapshots.discarded_events = value;
1915 break;
1916 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE:
1917 notit->cur_exp_packet_total_size = value;
1918 break;
1919 case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE:
1920 notit->cur_exp_packet_content_size = value;
1921 break;
1922 default:
1923 abort();
1924 }
1925
1926 update_def_clock:
1927 if (unlikely(int_fc->mapped_clock_class)) {
1928 update_default_clock(notit, value, int_fc->base.size);
1929 }
1930
1931 if (unlikely(int_fc->storing_index >= 0)) {
1932 g_array_index(notit->stored_values, uint64_t,
1933 (uint64_t) int_fc->storing_index) = value;
1934 }
1935
1936 if (unlikely(!fc->in_ir)) {
1937 goto end;
1938 }
1939
1940 field = borrow_next_field(notit);
1941 BT_ASSERT(field);
1942 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
1943 BT_ASSERT(bt_field_get_class_type(field) ==
1944 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
1945 bt_field_get_class_type(field) ==
1946 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
1947 bt_field_unsigned_integer_set_value(field, value);
1948 stack_top(notit->stack)->index++;
1949
1950 end:
1951 return status;
1952 }
1953
1954 static
1955 enum bt_bfcr_status bfcr_unsigned_int_char_cb(uint64_t value,
1956 struct ctf_field_class *fc, void *data)
1957 {
1958 int ret;
1959 struct bt_msg_iter *notit = data;
1960 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
1961 bt_field *string_field = NULL;
1962 struct ctf_field_class_int *int_fc = (void *) fc;
1963 char str[2] = {'\0', '\0'};
1964
1965 BT_LOGV("Unsigned integer character function called from BFCR: "
1966 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
1967 "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
1968 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
1969 BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
1970 BT_ASSERT(!int_fc->mapped_clock_class);
1971 BT_ASSERT(int_fc->storing_index < 0);
1972
1973 if (unlikely(!fc->in_ir)) {
1974 goto end;
1975 }
1976
1977 if (notit->done_filling_string) {
1978 goto end;
1979 }
1980
1981 if (value == 0) {
1982 notit->done_filling_string = true;
1983 goto end;
1984 }
1985
1986 string_field = stack_top(notit->stack)->base;
1987 BT_ASSERT(bt_field_get_class_type(string_field) ==
1988 BT_FIELD_CLASS_TYPE_STRING);
1989
1990 /* Append character */
1991 str[0] = (char) value;
1992 ret = bt_field_string_append_with_length(string_field, str, 1);
1993 if (ret) {
1994 BT_LOGE("Cannot append character to string field's value: "
1995 "notit-addr=%p, field-addr=%p, ret=%d",
1996 notit, string_field, ret);
1997 status = BT_BFCR_STATUS_ERROR;
1998 goto end;
1999 }
2000
2001 end:
2002 return status;
2003 }
2004
2005 static
2006 enum bt_bfcr_status bfcr_signed_int_cb(int64_t value,
2007 struct ctf_field_class *fc, void *data)
2008 {
2009 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2010 bt_field *field = NULL;
2011 struct bt_msg_iter *notit = data;
2012 struct ctf_field_class_int *int_fc = (void *) fc;
2013
2014 BT_LOGV("Signed integer function called from BFCR: "
2015 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2016 "fc-type=%d, fc-in-ir=%d, value=%" PRId64,
2017 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
2018 BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
2019
2020 if (unlikely(int_fc->storing_index >= 0)) {
2021 g_array_index(notit->stored_values, uint64_t,
2022 (uint64_t) int_fc->storing_index) = (uint64_t) value;
2023 }
2024
2025 if (unlikely(!fc->in_ir)) {
2026 goto end;
2027 }
2028
2029 field = borrow_next_field(notit);
2030 BT_ASSERT(field);
2031 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2032 BT_ASSERT(bt_field_get_class_type(field) ==
2033 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
2034 bt_field_get_class_type(field) ==
2035 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
2036 bt_field_signed_integer_set_value(field, value);
2037 stack_top(notit->stack)->index++;
2038
2039 end:
2040 return status;
2041 }
2042
2043 static
2044 enum bt_bfcr_status bfcr_floating_point_cb(double value,
2045 struct ctf_field_class *fc, void *data)
2046 {
2047 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2048 bt_field *field = NULL;
2049 struct bt_msg_iter *notit = data;
2050
2051 BT_LOGV("Floating point number function called from BFCR: "
2052 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2053 "fc-type=%d, fc-in-ir=%d, value=%f",
2054 notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
2055
2056 if (unlikely(!fc->in_ir)) {
2057 goto end;
2058 }
2059
2060 field = borrow_next_field(notit);
2061 BT_ASSERT(field);
2062 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2063 BT_ASSERT(bt_field_get_class_type(field) ==
2064 BT_FIELD_CLASS_TYPE_REAL);
2065 bt_field_real_set_value(field, value);
2066 stack_top(notit->stack)->index++;
2067
2068 end:
2069 return status;
2070 }
2071
2072 static
2073 enum bt_bfcr_status bfcr_string_begin_cb(
2074 struct ctf_field_class *fc, void *data)
2075 {
2076 bt_field *field = NULL;
2077 struct bt_msg_iter *notit = data;
2078 int ret;
2079
2080 BT_LOGV("String (beginning) function called from BFCR: "
2081 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2082 "fc-type=%d, fc-in-ir=%d",
2083 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2084
2085 if (unlikely(!fc->in_ir)) {
2086 goto end;
2087 }
2088
2089 field = borrow_next_field(notit);
2090 BT_ASSERT(field);
2091 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2092 BT_ASSERT(bt_field_get_class_type(field) ==
2093 BT_FIELD_CLASS_TYPE_STRING);
2094 ret = bt_field_string_clear(field);
2095 BT_ASSERT(ret == 0);
2096
2097 /*
2098 * Push on stack. Not a compound class per se, but we know that
2099 * only bfcr_string_cb() may be called between this call and a
2100 * subsequent call to bfcr_string_end_cb().
2101 */
2102 stack_push(notit->stack, field);
2103
2104 end:
2105 return BT_BFCR_STATUS_OK;
2106 }
2107
2108 static
2109 enum bt_bfcr_status bfcr_string_cb(const char *value,
2110 size_t len, struct ctf_field_class *fc, void *data)
2111 {
2112 enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
2113 bt_field *field = NULL;
2114 struct bt_msg_iter *notit = data;
2115 int ret;
2116
2117 BT_LOGV("String (substring) function called from BFCR: "
2118 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2119 "fc-type=%d, fc-in-ir=%d, string-length=%zu",
2120 notit, notit->bfcr, fc, fc->type, fc->in_ir,
2121 len);
2122
2123 if (unlikely(!fc->in_ir)) {
2124 goto end;
2125 }
2126
2127 field = stack_top(notit->stack)->base;
2128 BT_ASSERT(field);
2129
2130 /* Append current substring */
2131 ret = bt_field_string_append_with_length(field, value, len);
2132 if (ret) {
2133 BT_LOGE("Cannot append substring to string field's value: "
2134 "notit-addr=%p, field-addr=%p, string-length=%zu, "
2135 "ret=%d", notit, field, len, ret);
2136 status = BT_BFCR_STATUS_ERROR;
2137 goto end;
2138 }
2139
2140 end:
2141 return status;
2142 }
2143
2144 static
2145 enum bt_bfcr_status bfcr_string_end_cb(
2146 struct ctf_field_class *fc, void *data)
2147 {
2148 struct bt_msg_iter *notit = data;
2149
2150 BT_LOGV("String (end) function called from BFCR: "
2151 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2152 "fc-type=%d, fc-in-ir=%d",
2153 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2154
2155 if (unlikely(!fc->in_ir)) {
2156 goto end;
2157 }
2158
2159 /* Pop string field */
2160 stack_pop(notit->stack);
2161
2162 /* Go to next field */
2163 stack_top(notit->stack)->index++;
2164
2165 end:
2166 return BT_BFCR_STATUS_OK;
2167 }
2168
2169 enum bt_bfcr_status bfcr_compound_begin_cb(
2170 struct ctf_field_class *fc, void *data)
2171 {
2172 struct bt_msg_iter *notit = data;
2173 bt_field *field;
2174
2175 BT_LOGV("Compound (beginning) function called from BFCR: "
2176 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2177 "fc-type=%d, fc-in-ir=%d",
2178 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2179
2180 if (!fc->in_ir) {
2181 goto end;
2182 }
2183
2184 /* Borrow field */
2185 if (stack_empty(notit->stack)) {
2186 /* Root: already set by read_dscope_begin_state() */
2187 field = notit->cur_dscope_field;
2188 } else {
2189 field = borrow_next_field(notit);
2190 BT_ASSERT(field);
2191 }
2192
2193 /* Push field */
2194 BT_ASSERT(field);
2195 BT_ASSERT(bt_field_borrow_class_const(field) == fc->ir_fc);
2196 stack_push(notit->stack, field);
2197
2198 /*
2199 * Change BFCR "unsigned int" callback if it's a text
2200 * array/sequence.
2201 */
2202 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
2203 fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2204 struct ctf_field_class_array_base *array_fc = (void *) fc;
2205
2206 if (array_fc->is_text) {
2207 int ret;
2208
2209 BT_ASSERT(bt_field_get_class_type(field) ==
2210 BT_FIELD_CLASS_TYPE_STRING);
2211 notit->done_filling_string = false;
2212 ret = bt_field_string_clear(field);
2213 BT_ASSERT(ret == 0);
2214 bt_bfcr_set_unsigned_int_cb(notit->bfcr,
2215 bfcr_unsigned_int_char_cb);
2216 }
2217 }
2218
2219 end:
2220 return BT_BFCR_STATUS_OK;
2221 }
2222
2223 enum bt_bfcr_status bfcr_compound_end_cb(
2224 struct ctf_field_class *fc, void *data)
2225 {
2226 struct bt_msg_iter *notit = data;
2227
2228 BT_LOGV("Compound (end) function called from BFCR: "
2229 "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
2230 "fc-type=%d, fc-in-ir=%d",
2231 notit, notit->bfcr, fc, fc->type, fc->in_ir);
2232
2233 if (!fc->in_ir) {
2234 goto end;
2235 }
2236
2237 BT_ASSERT(!stack_empty(notit->stack));
2238 BT_ASSERT(bt_field_borrow_class_const(stack_top(notit->stack)->base) ==
2239 fc->ir_fc);
2240
2241 /*
2242 * Reset BFCR "unsigned int" callback if it's a text
2243 * array/sequence.
2244 */
2245 if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
2246 fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
2247 struct ctf_field_class_array_base *array_fc = (void *) fc;
2248
2249 if (array_fc->is_text) {
2250 BT_ASSERT(bt_field_get_class_type(
2251 stack_top(notit->stack)->base) ==
2252 BT_FIELD_CLASS_TYPE_STRING);
2253 bt_bfcr_set_unsigned_int_cb(notit->bfcr,
2254 bfcr_unsigned_int_cb);
2255 }
2256 }
2257
2258 /* Pop stack */
2259 stack_pop(notit->stack);
2260
2261 /* If the stack is not empty, increment the base's index */
2262 if (!stack_empty(notit->stack)) {
2263 stack_top(notit->stack)->index++;
2264 }
2265
2266 end:
2267 return BT_BFCR_STATUS_OK;
2268 }
2269
2270 static
2271 int64_t bfcr_get_sequence_length_cb(struct ctf_field_class *fc, void *data)
2272 {
2273 bt_field *seq_field;
2274 struct bt_msg_iter *notit = data;
2275 struct ctf_field_class_sequence *seq_fc = (void *) fc;
2276 int64_t length = -1;
2277 int ret;
2278
2279 length = (uint64_t) g_array_index(notit->stored_values, uint64_t,
2280 seq_fc->stored_length_index);
2281 seq_field = stack_top(notit->stack)->base;
2282 BT_ASSERT(seq_field);
2283 ret = bt_field_dynamic_array_set_length(seq_field, (uint64_t) length);
2284 if (ret) {
2285 BT_LOGE("Cannot set dynamic array field's length field: "
2286 "notit-addr=%p, field-addr=%p, "
2287 "length=%" PRIu64, notit, seq_field, length);
2288 }
2289
2290 return length;
2291 }
2292
2293 static
2294 struct ctf_field_class *bfcr_borrow_variant_selected_field_class_cb(
2295 struct ctf_field_class *fc, void *data)
2296 {
2297 int ret;
2298 uint64_t i;
2299 int64_t option_index = -1;
2300 struct bt_msg_iter *notit = data;
2301 struct ctf_field_class_variant *var_fc = (void *) fc;
2302 struct ctf_named_field_class *selected_option = NULL;
2303 struct ctf_field_class *ret_fc = NULL;
2304 union {
2305 uint64_t u;
2306 int64_t i;
2307 } tag;
2308
2309 /* Get variant's tag */
2310 tag.u = g_array_index(notit->stored_values, uint64_t,
2311 var_fc->stored_tag_index);
2312
2313 /*
2314 * Check each range to find the selected option's index.
2315 */
2316 if (var_fc->tag_fc->base.is_signed) {
2317 for (i = 0; i < var_fc->ranges->len; i++) {
2318 struct ctf_field_class_variant_range *range =
2319 ctf_field_class_variant_borrow_range_by_index(
2320 var_fc, i);
2321
2322 if (tag.i >= range->range.lower.i &&
2323 tag.i <= range->range.upper.i) {
2324 option_index = (int64_t) range->option_index;
2325 break;
2326 }
2327 }
2328 } else {
2329 for (i = 0; i < var_fc->ranges->len; i++) {
2330 struct ctf_field_class_variant_range *range =
2331 ctf_field_class_variant_borrow_range_by_index(
2332 var_fc, i);
2333
2334 if (tag.u >= range->range.lower.u &&
2335 tag.u <= range->range.upper.u) {
2336 option_index = (int64_t) range->option_index;
2337 break;
2338 }
2339 }
2340 }
2341
2342 if (option_index < 0) {
2343 BT_LOGW("Cannot find variant field class's option: "
2344 "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64 ", "
2345 "i-tag=%" PRId64, notit, var_fc, tag.u, tag.i);
2346 goto end;
2347 }
2348
2349 selected_option = ctf_field_class_variant_borrow_option_by_index(
2350 var_fc, (uint64_t) option_index);
2351
2352 if (selected_option->fc->in_ir) {
2353 bt_field *var_field = stack_top(notit->stack)->base;
2354
2355 ret = bt_field_variant_select_option_field(
2356 var_field, option_index);
2357 if (ret) {
2358 BT_LOGW("Cannot select variant field's option field: "
2359 "notit-addr=%p, var-field-addr=%p, "
2360 "opt-index=%" PRId64, notit, var_field,
2361 option_index);
2362 goto end;
2363 }
2364 }
2365
2366 ret_fc = selected_option->fc;
2367
2368 end:
2369 return ret_fc;
2370 }
2371
2372 static
2373 void set_event_default_clock_snapshot(struct bt_msg_iter *notit)
2374 {
2375 bt_event *event = bt_message_event_borrow_event(notit->event_msg);
2376 bt_stream_class *sc = notit->meta.sc->ir_sc;
2377
2378 BT_ASSERT(event);
2379
2380 if (bt_stream_class_borrow_default_clock_class(sc)) {
2381 bt_event_set_default_clock_snapshot(event,
2382 notit->default_clock_snapshot);
2383 }
2384 }
2385
2386 static
2387 void create_msg_stream_beginning(struct bt_msg_iter *notit,
2388 bt_message **message)
2389 {
2390 bt_message *ret = NULL;
2391
2392 BT_ASSERT(notit->stream);
2393 BT_ASSERT(notit->msg_iter);
2394 ret = bt_message_stream_beginning_create(notit->msg_iter,
2395 notit->stream);
2396 if (!ret) {
2397 BT_LOGE("Cannot create stream beginning message: "
2398 "notit-addr=%p, stream-addr=%p",
2399 notit, notit->stream);
2400 return;
2401 }
2402
2403 *message = ret;
2404 }
2405
2406 static
2407 void create_msg_stream_activity_beginning(struct bt_msg_iter *notit,
2408 bt_message **message)
2409 {
2410 bt_message *ret = NULL;
2411
2412 BT_ASSERT(notit->stream);
2413 BT_ASSERT(notit->msg_iter);
2414 ret = bt_message_stream_activity_beginning_create(notit->msg_iter,
2415 notit->stream);
2416 if (!ret) {
2417 BT_LOGE("Cannot create stream activity beginning message: "
2418 "notit-addr=%p, stream-addr=%p",
2419 notit, notit->stream);
2420 return;
2421 }
2422
2423 *message = ret;
2424 }
2425
2426 static
2427 void create_msg_stream_activity_end(struct bt_msg_iter *notit,
2428 bt_message **message)
2429 {
2430 bt_message *ret = NULL;
2431
2432 if (!notit->stream) {
2433 BT_LOGE("Cannot create stream for stream message: "
2434 "notit-addr=%p", notit);
2435 return;
2436 }
2437
2438 BT_ASSERT(notit->stream);
2439 BT_ASSERT(notit->msg_iter);
2440 ret = bt_message_stream_activity_end_create(notit->msg_iter,
2441 notit->stream);
2442 if (!ret) {
2443 BT_LOGE("Cannot create stream activity end message: "
2444 "notit-addr=%p, stream-addr=%p",
2445 notit, notit->stream);
2446 return;
2447 }
2448
2449 *message = ret;
2450 }
2451
2452 static
2453 void create_msg_stream_end(struct bt_msg_iter *notit, bt_message **message)
2454 {
2455 bt_message *ret;
2456
2457 if (!notit->stream) {
2458 BT_LOGE("Cannot create stream for stream message: "
2459 "notit-addr=%p", notit);
2460 return;
2461 }
2462
2463 BT_ASSERT(notit->msg_iter);
2464 ret = bt_message_stream_end_create(notit->msg_iter,
2465 notit->stream);
2466 if (!ret) {
2467 BT_LOGE("Cannot create stream end message: "
2468 "notit-addr=%p, stream-addr=%p",
2469 notit, notit->stream);
2470 return;
2471 }
2472
2473 *message = ret;
2474 }
2475
2476 static
2477 void create_msg_packet_beginning(struct bt_msg_iter *notit,
2478 bt_message **message)
2479 {
2480 int ret;
2481 enum bt_msg_iter_status status;
2482 bt_message *msg = NULL;
2483 const bt_stream_class *sc;
2484
2485 status = set_current_packet(notit);
2486 if (status != BT_MSG_ITER_STATUS_OK) {
2487 goto end;
2488 }
2489
2490 BT_ASSERT(notit->packet);
2491 sc = notit->meta.sc->ir_sc;
2492 BT_ASSERT(sc);
2493
2494 if (notit->packet_context_field) {
2495 ret = bt_packet_move_context_field(
2496 notit->packet, notit->packet_context_field);
2497 if (ret) {
2498 goto end;
2499 }
2500
2501 notit->packet_context_field = NULL;
2502
2503 /*
2504 * At this point notit->dscopes.stream_packet_context
2505 * has the same value as the packet context field within
2506 * notit->packet.
2507 */
2508 BT_ASSERT(bt_packet_borrow_context_field(
2509 notit->packet) ==
2510 notit->dscopes.stream_packet_context);
2511 }
2512
2513 BT_ASSERT(notit->msg_iter);
2514 msg = bt_message_packet_beginning_create(notit->msg_iter,
2515 notit->packet);
2516 if (!msg) {
2517 BT_LOGE("Cannot create packet beginning message: "
2518 "notit-addr=%p, packet-addr=%p",
2519 notit, notit->packet);
2520 goto end;
2521 }
2522
2523 *message = msg;
2524
2525 end:
2526 return;
2527 }
2528
2529 static
2530 void create_msg_packet_end(struct bt_msg_iter *notit, bt_message **message)
2531 {
2532 bt_message *msg;
2533
2534 if (!notit->packet) {
2535 return;
2536 }
2537
2538 /* Update default clock from packet's end time */
2539 if (notit->snapshots.end_clock != UINT64_C(-1)) {
2540 notit->default_clock_snapshot = notit->snapshots.end_clock;
2541 }
2542
2543 BT_ASSERT(notit->msg_iter);
2544 msg = bt_message_packet_end_create(notit->msg_iter,
2545 notit->packet);
2546 if (!msg) {
2547 BT_LOGE("Cannot create packet end message: "
2548 "notit-addr=%p, packet-addr=%p",
2549 notit, notit->packet);
2550 return;
2551
2552 }
2553
2554 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
2555 *message = msg;
2556 }
2557
2558 static
2559 void create_msg_discarded_events(struct bt_msg_iter *notit,
2560 bt_message **message)
2561 {
2562 bt_message *msg;
2563 uint64_t beginning_raw_value = UINT64_C(-1);
2564 uint64_t end_raw_value = UINT64_C(-1);
2565 uint64_t count = UINT64_C(-1);
2566
2567 BT_ASSERT(notit->msg_iter);
2568 BT_ASSERT(notit->stream);
2569
2570 if (notit->prev_packet_snapshots.discarded_events == UINT64_C(-1)) {
2571 /*
2572 * We discarded events, but before (and possibly
2573 * including) the current packet: use this packet's time
2574 * range, and do not have a specific count.
2575 */
2576 beginning_raw_value = notit->snapshots.beginning_clock;
2577 end_raw_value = notit->snapshots.end_clock;
2578 } else {
2579 count = notit->snapshots.discarded_events -
2580 notit->prev_packet_snapshots.discarded_events;
2581 BT_ASSERT(count > 0);
2582 beginning_raw_value = notit->prev_packet_snapshots.end_clock;
2583 end_raw_value = notit->snapshots.end_clock;
2584 }
2585
2586 if (beginning_raw_value != UINT64_C(-1) &&
2587 end_raw_value != UINT64_C(-1)) {
2588 msg = bt_message_discarded_events_create_with_default_clock_snapshots(
2589 notit->msg_iter, notit->stream, beginning_raw_value,
2590 end_raw_value);
2591 } else {
2592 msg = bt_message_discarded_events_create(notit->msg_iter,
2593 notit->stream);
2594 }
2595
2596 if (!msg) {
2597 BT_LOGE("Cannot create discarded events message: "
2598 "notit-addr=%p, stream-addr=%p",
2599 notit, notit->stream);
2600 return;
2601 }
2602
2603 if (count != UINT64_C(-1)) {
2604 bt_message_discarded_events_set_count(msg, count);
2605 }
2606
2607 *message = msg;
2608 }
2609
2610 static
2611 void create_msg_discarded_packets(struct bt_msg_iter *notit,
2612 bt_message **message)
2613 {
2614 bt_message *msg;
2615
2616 BT_ASSERT(notit->msg_iter);
2617 BT_ASSERT(notit->stream);
2618 BT_ASSERT(notit->prev_packet_snapshots.packets !=
2619 UINT64_C(-1));
2620
2621 if (notit->prev_packet_snapshots.end_clock != UINT64_C(-1) &&
2622 notit->snapshots.beginning_clock != UINT64_C(-1)) {
2623 msg = bt_message_discarded_packets_create_with_default_clock_snapshots(
2624 notit->msg_iter, notit->stream,
2625 notit->prev_packet_snapshots.end_clock,
2626 notit->snapshots.beginning_clock);
2627 } else {
2628 msg = bt_message_discarded_packets_create(notit->msg_iter,
2629 notit->stream);
2630 }
2631
2632 if (!msg) {
2633 BT_LOGE("Cannot create discarded packets message: "
2634 "notit-addr=%p, stream-addr=%p",
2635 notit, notit->stream);
2636 return;
2637 }
2638
2639 bt_message_discarded_packets_set_count(msg,
2640 notit->snapshots.packets -
2641 notit->prev_packet_snapshots.packets - 1);
2642 *message = msg;
2643 }
2644
2645 BT_HIDDEN
2646 struct bt_msg_iter *bt_msg_iter_create(struct ctf_trace_class *tc,
2647 size_t max_request_sz,
2648 struct bt_msg_iter_medium_ops medops, void *data)
2649 {
2650 struct bt_msg_iter *notit = NULL;
2651 struct bt_bfcr_cbs cbs = {
2652 .classes = {
2653 .signed_int = bfcr_signed_int_cb,
2654 .unsigned_int = bfcr_unsigned_int_cb,
2655 .floating_point = bfcr_floating_point_cb,
2656 .string_begin = bfcr_string_begin_cb,
2657 .string = bfcr_string_cb,
2658 .string_end = bfcr_string_end_cb,
2659 .compound_begin = bfcr_compound_begin_cb,
2660 .compound_end = bfcr_compound_end_cb,
2661 },
2662 .query = {
2663 .get_sequence_length = bfcr_get_sequence_length_cb,
2664 .borrow_variant_selected_field_class = bfcr_borrow_variant_selected_field_class_cb,
2665 },
2666 };
2667
2668 BT_ASSERT(tc);
2669 BT_ASSERT(medops.request_bytes);
2670 BT_ASSERT(medops.borrow_stream);
2671 BT_LOGD("Creating CTF plugin message iterator: "
2672 "trace-addr=%p, max-request-size=%zu, "
2673 "data=%p", tc, max_request_sz, data);
2674 notit = g_new0(struct bt_msg_iter, 1);
2675 if (!notit) {
2676 BT_LOGE_STR("Failed to allocate one CTF plugin message iterator.");
2677 goto end;
2678 }
2679 notit->meta.tc = tc;
2680 notit->medium.medops = medops;
2681 notit->medium.max_request_sz = max_request_sz;
2682 notit->medium.data = data;
2683 notit->stack = stack_new(notit);
2684 notit->stored_values = g_array_new(FALSE, TRUE, sizeof(uint64_t));
2685 g_array_set_size(notit->stored_values, tc->stored_value_count);
2686
2687 if (!notit->stack) {
2688 BT_LOGE_STR("Failed to create field stack.");
2689 goto error;
2690 }
2691
2692 notit->bfcr = bt_bfcr_create(cbs, notit);
2693 if (!notit->bfcr) {
2694 BT_LOGE_STR("Failed to create binary class reader (BFCR).");
2695 goto error;
2696 }
2697
2698 bt_msg_iter_reset(notit);
2699 BT_LOGD("Created CTF plugin message iterator: "
2700 "trace-addr=%p, max-request-size=%zu, "
2701 "data=%p, notit-addr=%p",
2702 tc, max_request_sz, data, notit);
2703 notit->cur_packet_offset = 0;
2704
2705 end:
2706 return notit;
2707
2708 error:
2709 bt_msg_iter_destroy(notit);
2710 notit = NULL;
2711 goto end;
2712 }
2713
2714 void bt_msg_iter_destroy(struct bt_msg_iter *notit)
2715 {
2716 BT_PACKET_PUT_REF_AND_RESET(notit->packet);
2717 BT_STREAM_PUT_REF_AND_RESET(notit->stream);
2718 release_all_dscopes(notit);
2719
2720 BT_LOGD("Destroying CTF plugin message iterator: addr=%p", notit);
2721
2722 if (notit->stack) {
2723 BT_LOGD_STR("Destroying field stack.");
2724 stack_destroy(notit->stack);
2725 }
2726
2727 if (notit->bfcr) {
2728 BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit->bfcr);
2729 bt_bfcr_destroy(notit->bfcr);
2730 }
2731
2732 if (notit->stored_values) {
2733 g_array_free(notit->stored_values, TRUE);
2734 }
2735
2736 g_free(notit);
2737 }
2738
2739 enum bt_msg_iter_status bt_msg_iter_get_next_message(
2740 struct bt_msg_iter *notit,
2741 bt_self_message_iterator *msg_iter, bt_message **message)
2742 {
2743 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
2744
2745 BT_ASSERT(notit);
2746 BT_ASSERT(message);
2747 notit->msg_iter = msg_iter;
2748 notit->set_stream = true;
2749 BT_LOGV("Getting next message: notit-addr=%p", notit);
2750
2751 while (true) {
2752 status = handle_state(notit);
2753 if (unlikely(status == BT_MSG_ITER_STATUS_AGAIN)) {
2754 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2755 goto end;
2756 } else if (unlikely(status != BT_MSG_ITER_STATUS_OK)) {
2757 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2758 notit, state_string(notit->state));
2759 goto end;
2760 }
2761
2762 switch (notit->state) {
2763 case STATE_EMIT_MSG_EVENT:
2764 BT_ASSERT(notit->event_msg);
2765 set_event_default_clock_snapshot(notit);
2766 *message = notit->event_msg;
2767 notit->event_msg = NULL;
2768 goto end;
2769 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2770 /* create_msg_discared_events() logs errors */
2771 create_msg_discarded_events(notit, message);
2772
2773 if (!*message) {
2774 status = BT_MSG_ITER_STATUS_ERROR;
2775 }
2776
2777 goto end;
2778 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2779 /* create_msg_discared_packets() logs errors */
2780 create_msg_discarded_packets(notit, message);
2781
2782 if (!*message) {
2783 status = BT_MSG_ITER_STATUS_ERROR;
2784 }
2785
2786 goto end;
2787 case STATE_EMIT_MSG_PACKET_BEGINNING:
2788 /* create_msg_packet_beginning() logs errors */
2789 create_msg_packet_beginning(notit, message);
2790
2791 if (!*message) {
2792 status = BT_MSG_ITER_STATUS_ERROR;
2793 }
2794
2795 goto end;
2796 case STATE_EMIT_MSG_PACKET_END_SINGLE:
2797 case STATE_EMIT_MSG_PACKET_END_MULTI:
2798 /* create_msg_packet_end() logs errors */
2799 create_msg_packet_end(notit, message);
2800
2801 if (!*message) {
2802 status = BT_MSG_ITER_STATUS_ERROR;
2803 }
2804
2805 goto end;
2806 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
2807 /* create_msg_stream_activity_beginning() logs errors */
2808 create_msg_stream_activity_beginning(notit, message);
2809
2810 if (!*message) {
2811 status = BT_MSG_ITER_STATUS_ERROR;
2812 }
2813
2814 goto end;
2815 case STATE_EMIT_MSG_STREAM_ACTIVITY_END:
2816 /* create_msg_stream_activity_end() logs errors */
2817 create_msg_stream_activity_end(notit, message);
2818
2819 if (!*message) {
2820 status = BT_MSG_ITER_STATUS_ERROR;
2821 }
2822
2823 goto end;
2824 case STATE_EMIT_MSG_STREAM_BEGINNING:
2825 /* create_msg_stream_beginning() logs errors */
2826 create_msg_stream_beginning(notit, message);
2827
2828 if (!*message) {
2829 status = BT_MSG_ITER_STATUS_ERROR;
2830 }
2831
2832 goto end;
2833 case STATE_EMIT_MSG_STREAM_END:
2834 /* create_msg_stream_end() logs errors */
2835 create_msg_stream_end(notit, message);
2836
2837 if (!*message) {
2838 status = BT_MSG_ITER_STATUS_ERROR;
2839 }
2840
2841 goto end;
2842 case STATE_DONE:
2843 status = BT_MSG_ITER_STATUS_EOF;
2844 goto end;
2845 default:
2846 /* Non-emitting state: continue */
2847 break;
2848 }
2849 }
2850
2851 end:
2852 return status;
2853 }
2854
2855 static
2856 enum bt_msg_iter_status read_packet_header_context_fields(
2857 struct bt_msg_iter *notit)
2858 {
2859 int ret;
2860 enum bt_msg_iter_status status = BT_MSG_ITER_STATUS_OK;
2861
2862 BT_ASSERT(notit);
2863 notit->set_stream = false;
2864
2865 if (notit->state == STATE_EMIT_MSG_PACKET_BEGINNING) {
2866 /* We're already there */
2867 goto end;
2868 }
2869
2870 while (true) {
2871 status = handle_state(notit);
2872 if (unlikely(status == BT_MSG_ITER_STATUS_AGAIN)) {
2873 BT_LOGV_STR("Medium returned BT_MSG_ITER_STATUS_AGAIN.");
2874 goto end;
2875 } else if (unlikely(status != BT_MSG_ITER_STATUS_OK)) {
2876 BT_LOGW("Cannot handle state: notit-addr=%p, state=%s",
2877 notit, state_string(notit->state));
2878 goto end;
2879 }
2880
2881 switch (notit->state) {
2882 case STATE_EMIT_MSG_PACKET_BEGINNING:
2883 /*
2884 * Packet header and context fields are
2885 * potentially decoded (or they don't exist).
2886 */
2887 goto end;
2888 case STATE_INIT:
2889 case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
2890 case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
2891 case STATE_AFTER_TRACE_PACKET_HEADER:
2892 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
2893 case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
2894 case STATE_AFTER_STREAM_PACKET_CONTEXT:
2895 case STATE_CHECK_EMIT_MSG_STREAM_BEGINNING:
2896 case STATE_EMIT_MSG_STREAM_BEGINNING:
2897 case STATE_EMIT_MSG_STREAM_ACTIVITY_BEGINNING:
2898 case STATE_CHECK_EMIT_MSG_DISCARDED_EVENTS:
2899 case STATE_EMIT_MSG_DISCARDED_EVENTS:
2900 case STATE_CHECK_EMIT_MSG_DISCARDED_PACKETS:
2901 case STATE_EMIT_MSG_DISCARDED_PACKETS:
2902 /* Non-emitting state: continue */
2903 break;
2904 default:
2905 /*
2906 * We should never get past the
2907 * STATE_EMIT_MSG_PACKET_BEGINNING state.
2908 */
2909 BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
2910 notit, state_string(notit->state));
2911 abort();
2912 }
2913 }
2914
2915 end:
2916 ret = set_current_packet_content_sizes(notit);
2917 if (ret) {
2918 status = BT_MSG_ITER_STATUS_ERROR;
2919 goto end;
2920 }
2921
2922 return status;
2923 }
2924
2925 BT_HIDDEN
2926 void bt_msg_iter_set_medops_data(struct bt_msg_iter *notit,
2927 void *medops_data)
2928 {
2929 BT_ASSERT(notit);
2930 notit->medium.data = medops_data;
2931 }
2932
2933 BT_HIDDEN
2934 enum bt_msg_iter_status bt_msg_iter_seek(struct bt_msg_iter *notit,
2935 off_t offset)
2936 {
2937 enum bt_msg_iter_status ret = BT_MSG_ITER_STATUS_OK;
2938 enum bt_msg_iter_medium_status medium_status;
2939
2940 BT_ASSERT(notit);
2941 if (offset < 0) {
2942 BT_LOGE("Cannot seek to negative offset: offset=%jd", offset);
2943 ret = BT_MSG_ITER_STATUS_INVAL;
2944 goto end;
2945 }
2946
2947 if (!notit->medium.medops.seek) {
2948 ret = BT_MSG_ITER_STATUS_UNSUPPORTED;
2949 BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
2950 goto end;
2951 }
2952
2953 medium_status = notit->medium.medops.seek(
2954 BT_MSG_ITER_SEEK_WHENCE_SET, offset, notit->medium.data);
2955 if (medium_status != BT_MSG_ITER_MEDIUM_STATUS_OK) {
2956 if (medium_status == BT_MSG_ITER_MEDIUM_STATUS_EOF) {
2957 ret = BT_MSG_ITER_STATUS_EOF;
2958 } else {
2959 ret = BT_MSG_ITER_STATUS_ERROR;
2960 goto end;
2961 }
2962 }
2963
2964 bt_msg_iter_reset(notit);
2965 notit->cur_packet_offset = offset;
2966
2967 end:
2968 return ret;
2969 }
2970
2971 BT_HIDDEN
2972 enum bt_msg_iter_status bt_msg_iter_get_packet_properties(
2973 struct bt_msg_iter *notit,
2974 struct bt_msg_iter_packet_properties *props)
2975 {
2976 enum bt_msg_iter_status status;
2977
2978 BT_ASSERT(notit);
2979 BT_ASSERT(props);
2980 status = read_packet_header_context_fields(notit);
2981 if (status != BT_MSG_ITER_STATUS_OK) {
2982 goto end;
2983 }
2984
2985 props->exp_packet_total_size = notit->cur_exp_packet_total_size;
2986 props->exp_packet_content_size = notit->cur_exp_packet_content_size;
2987 BT_ASSERT(props->stream_class_id >= 0);
2988 props->stream_class_id = (uint64_t) notit->cur_stream_class_id;
2989 props->data_stream_id = notit->cur_data_stream_id;
2990 props->snapshots.discarded_events = notit->snapshots.discarded_events;
2991 props->snapshots.packets = notit->snapshots.packets;
2992 props->snapshots.beginning_clock = notit->snapshots.beginning_clock;
2993 props->snapshots.end_clock = notit->snapshots.end_clock;
2994
2995 end:
2996 return status;
2997 }
2998
2999 BT_HIDDEN
3000 void bt_msg_iter_set_emit_stream_beginning_message(struct bt_msg_iter *notit,
3001 bool val)
3002 {
3003 notit->emit_stream_begin_msg = val;
3004 }
3005
3006 BT_HIDDEN
3007 void bt_msg_iter_set_emit_stream_end_message(struct bt_msg_iter *notit,
3008 bool val)
3009 {
3010 notit->emit_stream_end_msg = val;
3011 }
BabelTrace - Trace Format Babel Tower
This page took 0.142766 seconds and 4 git commands to generate.