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