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