Commit | Line | Data |
---|---|---|
15fe47e0 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
15fe47e0 | 3 | * |
0235b0db | 4 | * Copyright 2019 Philippe Proulx <pproulx@efficios.com> |
15fe47e0 PP |
5 | */ |
6 | ||
c802cacb | 7 | #include <glib.h> |
c802cacb SM |
8 | #include <stdio.h> |
9 | ||
10 | #include <babeltrace2/babeltrace.h> | |
11 | ||
aa1a7452 | 12 | #define BT_COMP_LOG_SELF_COMP (stream->trace->fs_sink->self_comp) |
4164020e SM |
13 | #define BT_LOG_OUTPUT_LEVEL (stream->log_level) |
14 | #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/STREAM" | |
d9c39b0a | 15 | #include "logging/comp-logging.h" |
15fe47e0 | 16 | |
578e048b | 17 | #include "common/assert.h" |
83ad336c | 18 | #include "compat/endian.h" /* IWYU pragma: keep */ |
c802cacb | 19 | #include "ctfser/ctfser.h" |
15fe47e0 | 20 | |
c7e1be4b | 21 | #include "fs-sink-ctf-meta.hpp" |
087cd0f5 | 22 | #include "fs-sink-stream.hpp" |
c802cacb SM |
23 | #include "fs-sink-trace.hpp" |
24 | #include "fs-sink.hpp" | |
087cd0f5 | 25 | #include "translate-trace-ir-to-ctf-ir.hpp" |
15fe47e0 | 26 | |
15fe47e0 PP |
27 | void fs_sink_stream_destroy(struct fs_sink_stream *stream) |
28 | { | |
4164020e SM |
29 | if (!stream) { |
30 | goto end; | |
31 | } | |
15fe47e0 | 32 | |
4164020e | 33 | bt_ctfser_fini(&stream->ctfser); |
15fe47e0 | 34 | |
4164020e SM |
35 | if (stream->file_name) { |
36 | g_string_free(stream->file_name, TRUE); | |
37 | stream->file_name = NULL; | |
38 | } | |
15fe47e0 | 39 | |
4164020e SM |
40 | bt_packet_put_ref(stream->packet_state.packet); |
41 | g_free(stream); | |
15fe47e0 PP |
42 | |
43 | end: | |
4164020e | 44 | return; |
15fe47e0 PP |
45 | } |
46 | ||
4164020e | 47 | static bool stream_file_name_exists(struct fs_sink_trace *trace, const char *name) |
15fe47e0 | 48 | { |
4164020e SM |
49 | bool exists = false; |
50 | GHashTableIter iter; | |
51 | gpointer key, value; | |
15fe47e0 | 52 | |
4164020e | 53 | g_hash_table_iter_init(&iter, trace->streams); |
15fe47e0 | 54 | |
4164020e SM |
55 | while (g_hash_table_iter_next(&iter, &key, &value)) { |
56 | struct fs_sink_stream *stream = (fs_sink_stream *) value; | |
15fe47e0 | 57 | |
4164020e SM |
58 | if (strcmp(name, stream->file_name->str) == 0) { |
59 | exists = true; | |
60 | goto end; | |
61 | } | |
62 | } | |
15fe47e0 PP |
63 | |
64 | end: | |
4164020e | 65 | return exists; |
15fe47e0 PP |
66 | } |
67 | ||
4164020e | 68 | static GString *sanitize_stream_file_name(const char *file_name) |
15fe47e0 | 69 | { |
4164020e SM |
70 | GString *san_file_name = g_string_new(NULL); |
71 | const char *ch; | |
72 | gchar *basename; | |
73 | ||
74 | BT_ASSERT(san_file_name); | |
75 | BT_ASSERT(file_name); | |
76 | basename = g_path_get_basename(file_name); | |
77 | ||
78 | for (ch = basename; *ch != '\0'; ch++) { | |
79 | if (*ch == '/') { | |
80 | g_string_append_c(san_file_name, '_'); | |
81 | } else { | |
82 | g_string_append_c(san_file_name, *ch); | |
83 | } | |
84 | } | |
85 | ||
86 | /* Do not allow `.` and `..` either */ | |
87 | if (strcmp(san_file_name->str, ".") == 0 || strcmp(san_file_name->str, "..") == 0) { | |
88 | g_string_assign(san_file_name, "stream"); | |
89 | } | |
90 | ||
91 | g_free(basename); | |
92 | return san_file_name; | |
15fe47e0 PP |
93 | } |
94 | ||
4164020e | 95 | static GString *make_unique_stream_file_name(struct fs_sink_trace *trace, const char *base) |
15fe47e0 | 96 | { |
4164020e SM |
97 | GString *san_base = sanitize_stream_file_name(base); |
98 | GString *name = g_string_new(san_base->str); | |
99 | unsigned int suffix = 0; | |
15fe47e0 | 100 | |
4164020e | 101 | BT_ASSERT(name); |
15fe47e0 | 102 | |
4164020e SM |
103 | while (stream_file_name_exists(trace, name->str) || strcmp(name->str, "metadata") == 0) { |
104 | g_string_printf(name, "%s-%u", san_base->str, suffix); | |
105 | suffix++; | |
106 | } | |
15fe47e0 | 107 | |
4164020e SM |
108 | g_string_free(san_base, TRUE); |
109 | return name; | |
15fe47e0 PP |
110 | } |
111 | ||
4164020e | 112 | static void set_stream_file_name(struct fs_sink_stream *stream) |
15fe47e0 | 113 | { |
4164020e | 114 | const char *base_name = bt_stream_get_name(stream->ir_stream); |
15fe47e0 | 115 | |
4164020e SM |
116 | if (!base_name) { |
117 | base_name = "stream"; | |
118 | } | |
15fe47e0 | 119 | |
4164020e SM |
120 | BT_ASSERT(!stream->file_name); |
121 | stream->file_name = make_unique_stream_file_name(stream->trace, base_name); | |
15fe47e0 PP |
122 | } |
123 | ||
15fe47e0 | 124 | struct fs_sink_stream *fs_sink_stream_create(struct fs_sink_trace *trace, |
4164020e | 125 | const bt_stream *ir_stream) |
15fe47e0 | 126 | { |
4164020e SM |
127 | struct fs_sink_stream *stream = g_new0(struct fs_sink_stream, 1); |
128 | int ret; | |
129 | GString *path = g_string_new(trace->path->str); | |
130 | ||
131 | if (!stream) { | |
132 | goto end; | |
133 | } | |
134 | ||
135 | stream->log_level = trace->log_level; | |
136 | stream->trace = trace; | |
137 | stream->ir_stream = ir_stream; | |
138 | stream->packet_state.beginning_cs = UINT64_C(-1); | |
139 | stream->packet_state.end_cs = UINT64_C(-1); | |
140 | stream->prev_packet_state.end_cs = UINT64_C(-1); | |
141 | stream->prev_packet_state.discarded_events_counter = UINT64_C(-1); | |
142 | stream->prev_packet_state.seq_num = UINT64_C(-1); | |
143 | ret = try_translate_stream_class_trace_ir_to_ctf_ir( | |
144 | trace->fs_sink, trace->trace, bt_stream_borrow_class_const(ir_stream), &stream->sc); | |
145 | if (ret) { | |
146 | goto error; | |
147 | } | |
148 | ||
149 | set_stream_file_name(stream); | |
150 | g_string_append_printf(path, "/%s", stream->file_name->str); | |
151 | ret = bt_ctfser_init(&stream->ctfser, path->str, stream->log_level); | |
152 | if (ret) { | |
153 | goto error; | |
154 | } | |
155 | ||
156 | g_hash_table_insert(trace->streams, (gpointer) ir_stream, stream); | |
157 | goto end; | |
15fe47e0 PP |
158 | |
159 | error: | |
4164020e SM |
160 | fs_sink_stream_destroy(stream); |
161 | stream = NULL; | |
15fe47e0 PP |
162 | |
163 | end: | |
4164020e SM |
164 | if (path) { |
165 | g_string_free(path, TRUE); | |
166 | } | |
15fe47e0 | 167 | |
4164020e | 168 | return stream; |
15fe47e0 PP |
169 | } |
170 | ||
4164020e SM |
171 | static int write_field(struct fs_sink_stream *stream, struct fs_sink_ctf_field_class *fc, |
172 | const bt_field *field); | |
15fe47e0 | 173 | |
4164020e SM |
174 | static inline int write_bool_field(struct fs_sink_stream *stream, |
175 | struct fs_sink_ctf_field_class_bool *fc, const bt_field *field) | |
ecd27ae4 | 176 | { |
4164020e SM |
177 | /* |
178 | * CTF 1.8 has no boolean field class type, so this component | |
179 | * translates this boolean field to an 8-bit unsigned integer | |
180 | * field which has the value 0 (false) or 1 (true). | |
181 | */ | |
182 | return bt_ctfser_write_unsigned_int(&stream->ctfser, bt_field_bool_get_value(field) ? 1 : 0, | |
183 | fc->base.base.alignment, fc->base.size, BYTE_ORDER); | |
ecd27ae4 PP |
184 | } |
185 | ||
4164020e SM |
186 | static inline int write_bit_array_field(struct fs_sink_stream *stream, |
187 | struct fs_sink_ctf_field_class_bit_array *fc, | |
188 | const bt_field *field) | |
43a94dc9 | 189 | { |
4164020e SM |
190 | /* |
191 | * CTF 1.8 has no bit array field class type, so this component | |
192 | * translates this bit array field to an unsigned integer field. | |
193 | */ | |
194 | return bt_ctfser_write_unsigned_int(&stream->ctfser, | |
195 | bt_field_bit_array_get_value_as_integer(field), | |
196 | fc->base.alignment, fc->size, BYTE_ORDER); | |
43a94dc9 PP |
197 | } |
198 | ||
4164020e SM |
199 | static inline int write_int_field(struct fs_sink_stream *stream, |
200 | struct fs_sink_ctf_field_class_int *fc, const bt_field *field) | |
15fe47e0 | 201 | { |
4164020e SM |
202 | int ret; |
203 | ||
204 | if (fc->is_signed) { | |
205 | ret = bt_ctfser_write_signed_int(&stream->ctfser, bt_field_integer_signed_get_value(field), | |
206 | fc->base.base.alignment, fc->base.size, BYTE_ORDER); | |
207 | } else { | |
208 | ret = bt_ctfser_write_unsigned_int(&stream->ctfser, | |
209 | bt_field_integer_unsigned_get_value(field), | |
210 | fc->base.base.alignment, fc->base.size, BYTE_ORDER); | |
211 | } | |
212 | ||
213 | return ret; | |
15fe47e0 PP |
214 | } |
215 | ||
4164020e SM |
216 | static inline int write_float_field(struct fs_sink_stream *stream, |
217 | struct fs_sink_ctf_field_class_float *fc, const bt_field *field) | |
15fe47e0 | 218 | { |
4164020e SM |
219 | int ret; |
220 | double val; | |
221 | ||
222 | if (fc->base.size == 32) { | |
223 | val = (double) bt_field_real_single_precision_get_value(field); | |
224 | ret = bt_ctfser_write_float32(&stream->ctfser, val, fc->base.base.alignment, BYTE_ORDER); | |
225 | } else { | |
226 | val = bt_field_real_double_precision_get_value(field); | |
227 | ret = bt_ctfser_write_float64(&stream->ctfser, val, fc->base.base.alignment, BYTE_ORDER); | |
228 | } | |
229 | ||
230 | return ret; | |
15fe47e0 PP |
231 | } |
232 | ||
0326ed80 | 233 | static inline int write_string_field(struct fs_sink_stream *stream, const bt_field *field) |
15fe47e0 | 234 | { |
4164020e | 235 | return bt_ctfser_write_string(&stream->ctfser, bt_field_string_get_value(field)); |
15fe47e0 PP |
236 | } |
237 | ||
4164020e SM |
238 | static inline int write_array_base_field_elements(struct fs_sink_stream *stream, |
239 | struct fs_sink_ctf_field_class_array_base *fc, | |
240 | const bt_field *field) | |
15fe47e0 | 241 | { |
4164020e SM |
242 | uint64_t i; |
243 | uint64_t len = bt_field_array_get_length(field); | |
244 | int ret = 0; | |
245 | ||
246 | for (i = 0; i < len; i++) { | |
247 | const bt_field *elem_field = bt_field_array_borrow_element_field_by_index_const(field, i); | |
248 | ret = write_field(stream, fc->elem_fc, elem_field); | |
249 | if (G_UNLIKELY(ret)) { | |
250 | goto end; | |
251 | } | |
252 | } | |
15fe47e0 PP |
253 | |
254 | end: | |
4164020e | 255 | return ret; |
15fe47e0 PP |
256 | } |
257 | ||
4164020e SM |
258 | static inline int write_sequence_field(struct fs_sink_stream *stream, |
259 | struct fs_sink_ctf_field_class_sequence *fc, | |
260 | const bt_field *field) | |
15fe47e0 | 261 | { |
4164020e | 262 | int ret; |
15fe47e0 | 263 | |
4164020e SM |
264 | if (fc->length_is_before) { |
265 | ret = bt_ctfser_write_unsigned_int(&stream->ctfser, bt_field_array_get_length(field), 8, 32, | |
266 | BYTE_ORDER); | |
267 | if (G_UNLIKELY(ret)) { | |
268 | goto end; | |
269 | } | |
270 | } | |
15fe47e0 | 271 | |
4164020e | 272 | ret = write_array_base_field_elements(stream, &fc->base, field); |
15fe47e0 PP |
273 | |
274 | end: | |
4164020e | 275 | return ret; |
15fe47e0 PP |
276 | } |
277 | ||
4164020e SM |
278 | static inline int write_struct_field(struct fs_sink_stream *stream, |
279 | struct fs_sink_ctf_field_class_struct *fc, | |
280 | const bt_field *field, bool align_struct) | |
15fe47e0 | 281 | { |
4164020e SM |
282 | int ret = 0; |
283 | uint64_t i; | |
284 | ||
285 | if (G_LIKELY(align_struct)) { | |
286 | ret = bt_ctfser_align_offset_in_current_packet(&stream->ctfser, fc->base.alignment); | |
287 | if (G_UNLIKELY(ret)) { | |
288 | goto end; | |
289 | } | |
290 | } | |
291 | ||
292 | for (i = 0; i < fc->members->len; i++) { | |
293 | const bt_field *memb_field = | |
294 | bt_field_structure_borrow_member_field_by_index_const(field, i); | |
295 | struct fs_sink_ctf_field_class *member_fc = | |
296 | fs_sink_ctf_field_class_struct_borrow_member_by_index(fc, i)->fc; | |
297 | ||
298 | ret = write_field(stream, member_fc, memb_field); | |
299 | if (G_UNLIKELY(ret)) { | |
300 | goto end; | |
301 | } | |
302 | } | |
15fe47e0 PP |
303 | |
304 | end: | |
4164020e | 305 | return ret; |
15fe47e0 PP |
306 | } |
307 | ||
4164020e SM |
308 | static inline int write_option_field(struct fs_sink_stream *stream, |
309 | struct fs_sink_ctf_field_class_option *fc, | |
310 | const bt_field *field) | |
c25f8e53 | 311 | { |
4164020e SM |
312 | int ret; |
313 | const bt_field *content_field = bt_field_option_borrow_field_const(field); | |
314 | ||
315 | ret = bt_ctfser_write_unsigned_int(&stream->ctfser, content_field ? 1 : 0, 8, 8, BYTE_ORDER); | |
316 | if (G_UNLIKELY(ret)) { | |
317 | goto end; | |
318 | } | |
319 | ||
320 | /* | |
321 | * CTF 1.8 has no option field class type, so this component | |
322 | * translates the option field class to a variant field class | |
323 | * where the options are: | |
324 | * | |
325 | * * An empty structure field class (field occupies 0 bits). | |
326 | * * The optional field class itself. | |
327 | * | |
328 | * If `content_field` is `NULL`, do not write anything (empty | |
329 | * structure). | |
330 | */ | |
331 | if (content_field) { | |
332 | ret = write_field(stream, fc->content_fc, content_field); | |
333 | } | |
c25f8e53 PP |
334 | |
335 | end: | |
4164020e | 336 | return ret; |
c25f8e53 PP |
337 | } |
338 | ||
4164020e SM |
339 | static inline int write_variant_field(struct fs_sink_stream *stream, |
340 | struct fs_sink_ctf_field_class_variant *fc, | |
341 | const bt_field *field) | |
15fe47e0 | 342 | { |
4164020e SM |
343 | uint64_t opt_index = bt_field_variant_get_selected_option_index(field); |
344 | int ret; | |
345 | ||
346 | if (fc->tag_is_before) { | |
347 | ret = bt_ctfser_write_unsigned_int(&stream->ctfser, opt_index, 8, 16, BYTE_ORDER); | |
348 | if (G_UNLIKELY(ret)) { | |
349 | goto end; | |
350 | } | |
351 | } | |
352 | ||
353 | ret = write_field(stream, | |
354 | fs_sink_ctf_field_class_variant_borrow_option_by_index(fc, opt_index)->fc, | |
355 | bt_field_variant_borrow_selected_option_field_const(field)); | |
15fe47e0 PP |
356 | |
357 | end: | |
4164020e | 358 | return ret; |
15fe47e0 PP |
359 | } |
360 | ||
4164020e SM |
361 | static int write_field(struct fs_sink_stream *stream, struct fs_sink_ctf_field_class *fc, |
362 | const bt_field *field) | |
15fe47e0 | 363 | { |
4164020e SM |
364 | int ret; |
365 | ||
366 | switch (fc->type) { | |
367 | case FS_SINK_CTF_FIELD_CLASS_TYPE_BOOL: | |
368 | ret = write_bool_field(stream, fs_sink_ctf_field_class_as_bool(fc), field); | |
369 | break; | |
370 | case FS_SINK_CTF_FIELD_CLASS_TYPE_BIT_ARRAY: | |
371 | ret = write_bit_array_field(stream, fs_sink_ctf_field_class_as_bit_array(fc), field); | |
372 | break; | |
373 | case FS_SINK_CTF_FIELD_CLASS_TYPE_INT: | |
374 | ret = write_int_field(stream, fs_sink_ctf_field_class_as_int(fc), field); | |
375 | break; | |
376 | case FS_SINK_CTF_FIELD_CLASS_TYPE_FLOAT: | |
377 | ret = write_float_field(stream, fs_sink_ctf_field_class_as_float(fc), field); | |
378 | break; | |
379 | case FS_SINK_CTF_FIELD_CLASS_TYPE_STRING: | |
0326ed80 | 380 | ret = write_string_field(stream, field); |
4164020e SM |
381 | break; |
382 | case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT: | |
383 | ret = write_struct_field(stream, fs_sink_ctf_field_class_as_struct(fc), field, true); | |
384 | break; | |
385 | case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY: | |
386 | ret = write_array_base_field_elements(stream, fs_sink_ctf_field_class_as_array_base(fc), | |
387 | field); | |
388 | break; | |
389 | case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE: | |
390 | ret = write_sequence_field(stream, fs_sink_ctf_field_class_as_sequence(fc), field); | |
391 | break; | |
392 | case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION: | |
393 | ret = write_option_field(stream, fs_sink_ctf_field_class_as_option(fc), field); | |
394 | break; | |
395 | case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT: | |
396 | ret = write_variant_field(stream, fs_sink_ctf_field_class_as_variant(fc), field); | |
397 | break; | |
398 | default: | |
399 | bt_common_abort(); | |
400 | } | |
401 | ||
402 | return ret; | |
15fe47e0 PP |
403 | } |
404 | ||
4164020e SM |
405 | static inline int write_event_header(struct fs_sink_stream *stream, const bt_clock_snapshot *cs, |
406 | struct fs_sink_ctf_event_class *ec) | |
15fe47e0 | 407 | { |
4164020e SM |
408 | int ret; |
409 | ||
410 | /* Event class ID */ | |
411 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
412 | &stream->ctfser, bt_event_class_get_id(ec->ir_ec), 8, 64, BYTE_ORDER); | |
413 | if (G_UNLIKELY(ret)) { | |
414 | goto end; | |
415 | } | |
416 | ||
417 | /* Time */ | |
418 | if (stream->sc->default_clock_class) { | |
419 | BT_ASSERT_DBG(cs); | |
420 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
421 | &stream->ctfser, bt_clock_snapshot_get_value(cs), 8, 64, BYTE_ORDER); | |
422 | if (G_UNLIKELY(ret)) { | |
423 | goto end; | |
424 | } | |
425 | } | |
15fe47e0 PP |
426 | |
427 | end: | |
4164020e | 428 | return ret; |
15fe47e0 PP |
429 | } |
430 | ||
4164020e SM |
431 | int fs_sink_stream_write_event(struct fs_sink_stream *stream, const bt_clock_snapshot *cs, |
432 | const bt_event *event, struct fs_sink_ctf_event_class *ec) | |
15fe47e0 | 433 | { |
4164020e SM |
434 | int ret; |
435 | const bt_field *field; | |
436 | ||
437 | /* Header */ | |
438 | ret = write_event_header(stream, cs, ec); | |
439 | if (G_UNLIKELY(ret)) { | |
440 | goto end; | |
441 | } | |
442 | ||
443 | /* Common context */ | |
444 | if (stream->sc->event_common_context_fc) { | |
445 | field = bt_event_borrow_common_context_field_const(event); | |
446 | BT_ASSERT_DBG(field); | |
447 | ret = write_struct_field( | |
448 | stream, fs_sink_ctf_field_class_as_struct(stream->sc->event_common_context_fc), field, | |
449 | true); | |
450 | if (G_UNLIKELY(ret)) { | |
451 | goto end; | |
452 | } | |
453 | } | |
454 | ||
455 | /* Specific context */ | |
456 | if (ec->spec_context_fc) { | |
457 | field = bt_event_borrow_specific_context_field_const(event); | |
458 | BT_ASSERT_DBG(field); | |
459 | ret = write_struct_field(stream, fs_sink_ctf_field_class_as_struct(ec->spec_context_fc), | |
460 | field, true); | |
461 | if (G_UNLIKELY(ret)) { | |
462 | goto end; | |
463 | } | |
464 | } | |
465 | ||
466 | /* Specific context */ | |
467 | if (ec->payload_fc) { | |
468 | field = bt_event_borrow_payload_field_const(event); | |
469 | BT_ASSERT_DBG(field); | |
470 | ret = write_struct_field(stream, fs_sink_ctf_field_class_as_struct(ec->payload_fc), field, | |
471 | true); | |
472 | if (G_UNLIKELY(ret)) { | |
473 | goto end; | |
474 | } | |
475 | } | |
15fe47e0 PP |
476 | |
477 | end: | |
4164020e | 478 | return ret; |
15fe47e0 PP |
479 | } |
480 | ||
4164020e | 481 | static int write_packet_context(struct fs_sink_stream *stream) |
15fe47e0 | 482 | { |
4164020e SM |
483 | int ret; |
484 | ||
485 | /* Packet total size */ | |
486 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
487 | &stream->ctfser, stream->packet_state.total_size, 8, 64, BYTE_ORDER); | |
488 | if (ret) { | |
489 | goto end; | |
490 | } | |
491 | ||
492 | /* Packet content size */ | |
493 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
494 | &stream->ctfser, stream->packet_state.content_size, 8, 64, BYTE_ORDER); | |
495 | if (ret) { | |
496 | goto end; | |
497 | } | |
498 | ||
499 | if (stream->sc->packets_have_ts_begin) { | |
500 | /* Beginning time */ | |
501 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
502 | &stream->ctfser, stream->packet_state.beginning_cs, 8, 64, BYTE_ORDER); | |
503 | if (ret) { | |
504 | goto end; | |
505 | } | |
506 | } | |
507 | ||
508 | if (stream->sc->packets_have_ts_end) { | |
509 | /* End time */ | |
510 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
511 | &stream->ctfser, stream->packet_state.end_cs, 8, 64, BYTE_ORDER); | |
512 | if (ret) { | |
513 | goto end; | |
514 | } | |
515 | } | |
516 | ||
517 | if (stream->sc->has_discarded_events) { | |
518 | /* Discarded event counter */ | |
519 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
520 | &stream->ctfser, stream->packet_state.discarded_events_counter, 8, 64, BYTE_ORDER); | |
521 | if (ret) { | |
522 | goto end; | |
523 | } | |
524 | } | |
525 | ||
526 | /* Sequence number */ | |
527 | ret = bt_ctfser_write_byte_aligned_unsigned_int(&stream->ctfser, stream->packet_state.seq_num, | |
528 | 8, 64, BYTE_ORDER); | |
529 | if (ret) { | |
530 | goto end; | |
531 | } | |
532 | ||
533 | /* Other members */ | |
534 | if (stream->sc->packet_context_fc) { | |
535 | const bt_field *packet_context_field; | |
536 | ||
537 | BT_ASSERT(stream->packet_state.packet); | |
538 | packet_context_field = bt_packet_borrow_context_field_const(stream->packet_state.packet); | |
539 | BT_ASSERT(packet_context_field); | |
540 | ret = write_struct_field(stream, | |
541 | fs_sink_ctf_field_class_as_struct(stream->sc->packet_context_fc), | |
542 | packet_context_field, false); | |
543 | if (ret) { | |
544 | goto end; | |
545 | } | |
546 | } | |
15fe47e0 PP |
547 | |
548 | end: | |
4164020e | 549 | return ret; |
15fe47e0 PP |
550 | } |
551 | ||
4164020e SM |
552 | int fs_sink_stream_open_packet(struct fs_sink_stream *stream, const bt_clock_snapshot *cs, |
553 | const bt_packet *packet) | |
15fe47e0 | 554 | { |
4164020e SM |
555 | int ret; |
556 | uint64_t i; | |
557 | ||
558 | BT_ASSERT(!stream->packet_state.is_open); | |
559 | bt_packet_put_ref(stream->packet_state.packet); | |
560 | stream->packet_state.packet = packet; | |
561 | bt_packet_get_ref(stream->packet_state.packet); | |
562 | if (cs) { | |
563 | stream->packet_state.beginning_cs = bt_clock_snapshot_get_value(cs); | |
564 | } | |
565 | ||
566 | /* Open packet */ | |
567 | ret = bt_ctfser_open_packet(&stream->ctfser); | |
568 | if (ret) { | |
569 | /* bt_ctfser_open_packet() logs errors */ | |
570 | goto end; | |
571 | } | |
572 | ||
573 | /* Packet header: magic */ | |
574 | ret = bt_ctfser_write_byte_aligned_unsigned_int(&stream->ctfser, UINT64_C(0xc1fc1fc1), 8, 32, | |
575 | BYTE_ORDER); | |
576 | if (ret) { | |
577 | BT_COMP_LOGE("Error writing packet header magic: stream-file-name=%s", | |
578 | stream->file_name->str); | |
579 | goto end; | |
580 | } | |
581 | ||
582 | /* Packet header: UUID */ | |
583 | for (i = 0; i < BT_UUID_LEN; i++) { | |
584 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
585 | &stream->ctfser, (uint64_t) stream->sc->trace->uuid[i], 8, 8, BYTE_ORDER); | |
586 | if (ret) { | |
587 | BT_COMP_LOGE("Error writing packet header UUID: stream-file-name=%s", | |
588 | stream->file_name->str); | |
589 | goto end; | |
590 | } | |
591 | } | |
592 | ||
593 | /* Packet header: stream class ID */ | |
594 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
595 | &stream->ctfser, bt_stream_class_get_id(stream->sc->ir_sc), 8, 64, BYTE_ORDER); | |
596 | if (ret) { | |
597 | BT_COMP_LOGE("Error writing packet header stream class id: " | |
598 | "stream-file-name=%s, stream-class-id=%" PRIu64, | |
599 | stream->file_name->str, bt_stream_class_get_id(stream->sc->ir_sc)); | |
600 | goto end; | |
601 | } | |
602 | ||
603 | /* Packet header: stream ID */ | |
604 | ret = bt_ctfser_write_byte_aligned_unsigned_int( | |
605 | &stream->ctfser, bt_stream_get_id(stream->ir_stream), 8, 64, BYTE_ORDER); | |
606 | if (ret) { | |
607 | BT_COMP_LOGE("Error writing packet header stream id: " | |
608 | "stream-file-name=%s, stream-id=%" PRIu64, | |
609 | stream->file_name->str, bt_stream_get_id(stream->ir_stream)); | |
610 | goto end; | |
611 | } | |
612 | ||
613 | /* Save packet context's offset to rewrite it later */ | |
614 | stream->packet_state.context_offset_bits = | |
615 | bt_ctfser_get_offset_in_current_packet_bits(&stream->ctfser); | |
616 | ||
617 | /* Write packet context just to advance to content (first event) */ | |
618 | ret = write_packet_context(stream); | |
619 | if (ret) { | |
620 | goto end; | |
621 | } | |
622 | ||
623 | stream->packet_state.is_open = true; | |
15fe47e0 PP |
624 | |
625 | end: | |
4164020e | 626 | return ret; |
15fe47e0 PP |
627 | } |
628 | ||
4164020e | 629 | int fs_sink_stream_close_packet(struct fs_sink_stream *stream, const bt_clock_snapshot *cs) |
15fe47e0 | 630 | { |
4164020e SM |
631 | int ret; |
632 | ||
633 | BT_ASSERT(stream->packet_state.is_open); | |
634 | ||
635 | if (cs) { | |
636 | stream->packet_state.end_cs = bt_clock_snapshot_get_value(cs); | |
637 | } | |
638 | ||
639 | stream->packet_state.content_size = | |
640 | bt_ctfser_get_offset_in_current_packet_bits(&stream->ctfser); | |
641 | stream->packet_state.total_size = (stream->packet_state.content_size + 7) & ~UINT64_C(7); | |
642 | ||
643 | /* Rewrite packet context */ | |
644 | bt_ctfser_set_offset_in_current_packet_bits(&stream->ctfser, | |
645 | stream->packet_state.context_offset_bits); | |
646 | ret = write_packet_context(stream); | |
647 | if (ret) { | |
648 | goto end; | |
649 | } | |
650 | ||
651 | /* Close packet */ | |
652 | bt_ctfser_close_current_packet(&stream->ctfser, stream->packet_state.total_size / 8); | |
653 | ||
654 | /* Partially copy current packet state to previous packet state */ | |
655 | stream->prev_packet_state.end_cs = stream->packet_state.end_cs; | |
656 | stream->prev_packet_state.discarded_events_counter = | |
657 | stream->packet_state.discarded_events_counter; | |
658 | stream->prev_packet_state.seq_num = stream->packet_state.seq_num; | |
659 | ||
660 | /* Reset current packet state */ | |
661 | stream->packet_state.beginning_cs = UINT64_C(-1); | |
662 | stream->packet_state.end_cs = UINT64_C(-1); | |
663 | stream->packet_state.content_size = 0; | |
664 | stream->packet_state.total_size = 0; | |
665 | stream->packet_state.seq_num += 1; | |
666 | stream->packet_state.context_offset_bits = 0; | |
667 | stream->packet_state.is_open = false; | |
668 | BT_PACKET_PUT_REF_AND_RESET(stream->packet_state.packet); | |
15fe47e0 PP |
669 | |
670 | end: | |
4164020e | 671 | return ret; |
15fe47e0 | 672 | } |