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