2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
10 #include <babeltrace2/babeltrace.h>
12 #include "common/assert.h"
13 #include "compat/endian.h" /* IWYU pragma: keep */
14 #include "ctfser/ctfser.h"
16 #include "fs-sink-ctf-meta.hpp"
17 #include "fs-sink-stream.hpp"
18 #include "fs-sink-trace.hpp"
19 #include "translate-trace-ir-to-ctf-ir.hpp"
21 void fs_sink_stream_destroy(struct fs_sink_stream
*stream
)
27 bt_ctfser_fini(&stream
->ctfser
);
29 if (stream
->file_name
) {
30 g_string_free(stream
->file_name
, TRUE
);
31 stream
->file_name
= NULL
;
34 bt_packet_put_ref(stream
->packet_state
.packet
);
41 static bool stream_file_name_exists(struct fs_sink_trace
*trace
, const char *name
)
47 g_hash_table_iter_init(&iter
, trace
->streams
);
49 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
50 struct fs_sink_stream
*stream
= (fs_sink_stream
*) value
;
52 if (strcmp(name
, stream
->file_name
->str
) == 0) {
62 static GString
*sanitize_stream_file_name(const char *file_name
)
64 GString
*san_file_name
= g_string_new(NULL
);
68 BT_ASSERT(san_file_name
);
70 basename
= g_path_get_basename(file_name
);
72 for (ch
= basename
; *ch
!= '\0'; ch
++) {
74 g_string_append_c(san_file_name
, '_');
76 g_string_append_c(san_file_name
, *ch
);
80 /* Do not allow `.` and `..` either */
81 if (strcmp(san_file_name
->str
, ".") == 0 || strcmp(san_file_name
->str
, "..") == 0) {
82 g_string_assign(san_file_name
, "stream");
89 static GString
*make_unique_stream_file_name(struct fs_sink_trace
*trace
, const char *base
)
91 GString
*san_base
= sanitize_stream_file_name(base
);
92 GString
*name
= g_string_new(san_base
->str
);
93 unsigned int suffix
= 0;
97 while (stream_file_name_exists(trace
, name
->str
) || strcmp(name
->str
, "metadata") == 0) {
98 g_string_printf(name
, "%s-%u", san_base
->str
, suffix
);
102 g_string_free(san_base
, TRUE
);
106 static void set_stream_file_name(struct fs_sink_stream
*stream
)
108 const char *base_name
= bt_stream_get_name(stream
->ir_stream
);
111 base_name
= "stream";
114 BT_ASSERT(!stream
->file_name
);
115 stream
->file_name
= make_unique_stream_file_name(stream
->trace
, base_name
);
118 struct fs_sink_stream
*fs_sink_stream_create(struct fs_sink_trace
*trace
,
119 const bt_stream
*ir_stream
)
121 fs_sink_stream
*stream
= new fs_sink_stream
{trace
->logger
};
123 GString
*path
= g_string_new(trace
->path
->str
);
125 stream
->trace
= trace
;
126 stream
->ir_stream
= ir_stream
;
127 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
128 stream
->packet_state
.end_cs
= UINT64_C(-1);
129 stream
->prev_packet_state
.end_cs
= UINT64_C(-1);
130 stream
->prev_packet_state
.discarded_events_counter
= UINT64_C(-1);
131 stream
->prev_packet_state
.seq_num
= UINT64_C(-1);
132 ret
= try_translate_stream_class_trace_ir_to_ctf_ir(
133 trace
->fs_sink
, trace
->trace
, bt_stream_borrow_class_const(ir_stream
), &stream
->sc
);
138 set_stream_file_name(stream
);
139 g_string_append_printf(path
, "/%s", stream
->file_name
->str
);
140 ret
= bt_ctfser_init(&stream
->ctfser
, path
->str
, static_cast<int>(stream
->logger
.level()));
145 g_hash_table_insert(trace
->streams
, (gpointer
) ir_stream
, stream
);
149 fs_sink_stream_destroy(stream
);
154 g_string_free(path
, TRUE
);
160 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
161 const bt_field
*field
);
163 static inline int write_bool_field(struct fs_sink_stream
*stream
,
164 struct fs_sink_ctf_field_class_bool
*fc
, const bt_field
*field
)
167 * CTF 1.8 has no boolean field class type, so this component
168 * translates this boolean field to an 8-bit unsigned integer
169 * field which has the value 0 (false) or 1 (true).
171 return bt_ctfser_write_unsigned_int(&stream
->ctfser
, bt_field_bool_get_value(field
) ? 1 : 0,
172 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
175 static inline int write_bit_array_field(struct fs_sink_stream
*stream
,
176 struct fs_sink_ctf_field_class_bit_array
*fc
,
177 const bt_field
*field
)
180 * CTF 1.8 has no bit array field class type, so this component
181 * translates this bit array field to an unsigned integer field.
183 return bt_ctfser_write_unsigned_int(&stream
->ctfser
,
184 bt_field_bit_array_get_value_as_integer(field
),
185 fc
->base
.alignment
, fc
->size
, BYTE_ORDER
);
188 static inline int write_int_field(struct fs_sink_stream
*stream
,
189 struct fs_sink_ctf_field_class_int
*fc
, const bt_field
*field
)
194 ret
= bt_ctfser_write_signed_int(&stream
->ctfser
, bt_field_integer_signed_get_value(field
),
195 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
197 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
198 bt_field_integer_unsigned_get_value(field
),
199 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
205 static inline int write_float_field(struct fs_sink_stream
*stream
,
206 struct fs_sink_ctf_field_class_float
*fc
, const bt_field
*field
)
211 if (fc
->base
.size
== 32) {
212 val
= (double) bt_field_real_single_precision_get_value(field
);
213 ret
= bt_ctfser_write_float32(&stream
->ctfser
, val
, fc
->base
.base
.alignment
, BYTE_ORDER
);
215 val
= bt_field_real_double_precision_get_value(field
);
216 ret
= bt_ctfser_write_float64(&stream
->ctfser
, val
, fc
->base
.base
.alignment
, BYTE_ORDER
);
222 static inline int write_string_field(struct fs_sink_stream
*stream
, const bt_field
*field
)
224 return bt_ctfser_write_string(&stream
->ctfser
, bt_field_string_get_value(field
));
227 static inline int write_array_base_field_elements(struct fs_sink_stream
*stream
,
228 struct fs_sink_ctf_field_class_array_base
*fc
,
229 const bt_field
*field
)
232 uint64_t len
= bt_field_array_get_length(field
);
235 for (i
= 0; i
< len
; i
++) {
236 const bt_field
*elem_field
= bt_field_array_borrow_element_field_by_index_const(field
, i
);
237 ret
= write_field(stream
, fc
->elem_fc
, elem_field
);
238 if (G_UNLIKELY(ret
)) {
247 static inline int write_sequence_field(struct fs_sink_stream
*stream
,
248 struct fs_sink_ctf_field_class_sequence
*fc
,
249 const bt_field
*field
)
253 if (fc
->length_is_before
) {
254 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, bt_field_array_get_length(field
), 8, 32,
256 if (G_UNLIKELY(ret
)) {
261 ret
= write_array_base_field_elements(stream
, &fc
->base
, field
);
267 static inline int write_struct_field(struct fs_sink_stream
*stream
,
268 struct fs_sink_ctf_field_class_struct
*fc
,
269 const bt_field
*field
, bool align_struct
)
274 if (G_LIKELY(align_struct
)) {
275 ret
= bt_ctfser_align_offset_in_current_packet(&stream
->ctfser
, fc
->base
.alignment
);
276 if (G_UNLIKELY(ret
)) {
281 for (i
= 0; i
< fc
->members
->len
; i
++) {
282 const bt_field
*memb_field
=
283 bt_field_structure_borrow_member_field_by_index_const(field
, i
);
284 struct fs_sink_ctf_field_class
*member_fc
=
285 fs_sink_ctf_field_class_struct_borrow_member_by_index(fc
, i
)->fc
;
287 ret
= write_field(stream
, member_fc
, memb_field
);
288 if (G_UNLIKELY(ret
)) {
297 static inline int write_option_field(struct fs_sink_stream
*stream
,
298 struct fs_sink_ctf_field_class_option
*fc
,
299 const bt_field
*field
)
302 const bt_field
*content_field
= bt_field_option_borrow_field_const(field
);
304 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, content_field
? 1 : 0, 8, 8, BYTE_ORDER
);
305 if (G_UNLIKELY(ret
)) {
310 * CTF 1.8 has no option field class type, so this component
311 * translates the option field class to a variant field class
312 * where the options are:
314 * * An empty structure field class (field occupies 0 bits).
315 * * The optional field class itself.
317 * If `content_field` is `NULL`, do not write anything (empty
321 ret
= write_field(stream
, fc
->content_fc
, content_field
);
328 static inline int write_variant_field(struct fs_sink_stream
*stream
,
329 struct fs_sink_ctf_field_class_variant
*fc
,
330 const bt_field
*field
)
332 uint64_t opt_index
= bt_field_variant_get_selected_option_index(field
);
335 if (fc
->tag_is_before
) {
336 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, opt_index
, 8, 16, BYTE_ORDER
);
337 if (G_UNLIKELY(ret
)) {
342 ret
= write_field(stream
,
343 fs_sink_ctf_field_class_variant_borrow_option_by_index(fc
, opt_index
)->fc
,
344 bt_field_variant_borrow_selected_option_field_const(field
));
350 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
351 const bt_field
*field
)
356 case FS_SINK_CTF_FIELD_CLASS_TYPE_BOOL
:
357 ret
= write_bool_field(stream
, fs_sink_ctf_field_class_as_bool(fc
), field
);
359 case FS_SINK_CTF_FIELD_CLASS_TYPE_BIT_ARRAY
:
360 ret
= write_bit_array_field(stream
, fs_sink_ctf_field_class_as_bit_array(fc
), field
);
362 case FS_SINK_CTF_FIELD_CLASS_TYPE_INT
:
363 ret
= write_int_field(stream
, fs_sink_ctf_field_class_as_int(fc
), field
);
365 case FS_SINK_CTF_FIELD_CLASS_TYPE_FLOAT
:
366 ret
= write_float_field(stream
, fs_sink_ctf_field_class_as_float(fc
), field
);
368 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRING
:
369 ret
= write_string_field(stream
, field
);
371 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
372 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(fc
), field
, true);
374 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
375 ret
= write_array_base_field_elements(stream
, fs_sink_ctf_field_class_as_array_base(fc
),
378 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
379 ret
= write_sequence_field(stream
, fs_sink_ctf_field_class_as_sequence(fc
), field
);
381 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
382 ret
= write_option_field(stream
, fs_sink_ctf_field_class_as_option(fc
), field
);
384 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
385 ret
= write_variant_field(stream
, fs_sink_ctf_field_class_as_variant(fc
), field
);
394 static inline int write_event_header(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
395 struct fs_sink_ctf_event_class
*ec
)
400 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
401 &stream
->ctfser
, bt_event_class_get_id(ec
->ir_ec
), 8, 64, BYTE_ORDER
);
402 if (G_UNLIKELY(ret
)) {
407 if (stream
->sc
->default_clock_class
) {
409 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
410 &stream
->ctfser
, bt_clock_snapshot_get_value(cs
), 8, 64, BYTE_ORDER
);
411 if (G_UNLIKELY(ret
)) {
420 int fs_sink_stream_write_event(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
421 const bt_event
*event
, struct fs_sink_ctf_event_class
*ec
)
424 const bt_field
*field
;
427 ret
= write_event_header(stream
, cs
, ec
);
428 if (G_UNLIKELY(ret
)) {
433 if (stream
->sc
->event_common_context_fc
) {
434 field
= bt_event_borrow_common_context_field_const(event
);
435 BT_ASSERT_DBG(field
);
436 ret
= write_struct_field(
437 stream
, fs_sink_ctf_field_class_as_struct(stream
->sc
->event_common_context_fc
), field
,
439 if (G_UNLIKELY(ret
)) {
444 /* Specific context */
445 if (ec
->spec_context_fc
) {
446 field
= bt_event_borrow_specific_context_field_const(event
);
447 BT_ASSERT_DBG(field
);
448 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(ec
->spec_context_fc
),
450 if (G_UNLIKELY(ret
)) {
455 /* Specific context */
456 if (ec
->payload_fc
) {
457 field
= bt_event_borrow_payload_field_const(event
);
458 BT_ASSERT_DBG(field
);
459 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(ec
->payload_fc
), field
,
461 if (G_UNLIKELY(ret
)) {
470 static int write_packet_context(struct fs_sink_stream
*stream
)
474 /* Packet total size */
475 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
476 &stream
->ctfser
, stream
->packet_state
.total_size
, 8, 64, BYTE_ORDER
);
481 /* Packet content size */
482 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
483 &stream
->ctfser
, stream
->packet_state
.content_size
, 8, 64, BYTE_ORDER
);
488 if (stream
->sc
->packets_have_ts_begin
) {
490 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
491 &stream
->ctfser
, stream
->packet_state
.beginning_cs
, 8, 64, BYTE_ORDER
);
497 if (stream
->sc
->packets_have_ts_end
) {
499 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
500 &stream
->ctfser
, stream
->packet_state
.end_cs
, 8, 64, BYTE_ORDER
);
506 if (stream
->sc
->has_discarded_events
) {
507 /* Discarded event counter */
508 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
509 &stream
->ctfser
, stream
->packet_state
.discarded_events_counter
, 8, 64, BYTE_ORDER
);
515 /* Sequence number */
516 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, stream
->packet_state
.seq_num
,
523 if (stream
->sc
->packet_context_fc
) {
524 const bt_field
*packet_context_field
;
526 BT_ASSERT(stream
->packet_state
.packet
);
527 packet_context_field
= bt_packet_borrow_context_field_const(stream
->packet_state
.packet
);
528 BT_ASSERT(packet_context_field
);
529 ret
= write_struct_field(stream
,
530 fs_sink_ctf_field_class_as_struct(stream
->sc
->packet_context_fc
),
531 packet_context_field
, false);
541 int fs_sink_stream_open_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
542 const bt_packet
*packet
)
547 BT_ASSERT(!stream
->packet_state
.is_open
);
548 bt_packet_put_ref(stream
->packet_state
.packet
);
549 stream
->packet_state
.packet
= packet
;
550 bt_packet_get_ref(stream
->packet_state
.packet
);
552 stream
->packet_state
.beginning_cs
= bt_clock_snapshot_get_value(cs
);
556 ret
= bt_ctfser_open_packet(&stream
->ctfser
);
558 /* bt_ctfser_open_packet() logs errors */
562 /* Packet header: magic */
563 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, UINT64_C(0xc1fc1fc1), 8, 32,
566 BT_CPPLOGE_SPEC(stream
->logger
, "Error writing packet header magic: stream-file-name={}",
567 stream
->file_name
->str
);
571 /* Packet header: UUID */
572 for (i
= 0; i
< BT_UUID_LEN
; i
++) {
573 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
574 &stream
->ctfser
, (uint64_t) stream
->sc
->trace
->uuid
[i
], 8, 8, BYTE_ORDER
);
576 BT_CPPLOGE_SPEC(stream
->logger
, "Error writing packet header UUID: stream-file-name={}",
577 stream
->file_name
->str
);
582 /* Packet header: stream class ID */
583 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
584 &stream
->ctfser
, bt_stream_class_get_id(stream
->sc
->ir_sc
), 8, 64, BYTE_ORDER
);
586 BT_CPPLOGE_SPEC(stream
->logger
,
587 "Error writing packet header stream class id: "
588 "stream-file-name={}, stream-class-id={}",
589 stream
->file_name
->str
, bt_stream_class_get_id(stream
->sc
->ir_sc
));
593 /* Packet header: stream ID */
594 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
595 &stream
->ctfser
, bt_stream_get_id(stream
->ir_stream
), 8, 64, BYTE_ORDER
);
597 BT_CPPLOGE_SPEC(stream
->logger
,
598 "Error writing packet header stream id: "
599 "stream-file-name={}, stream-id={}",
600 stream
->file_name
->str
, bt_stream_get_id(stream
->ir_stream
));
604 /* Save packet context's offset to rewrite it later */
605 stream
->packet_state
.context_offset_bits
=
606 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
608 /* Write packet context just to advance to content (first event) */
609 ret
= write_packet_context(stream
);
614 stream
->packet_state
.is_open
= true;
620 int fs_sink_stream_close_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
)
624 BT_ASSERT(stream
->packet_state
.is_open
);
627 stream
->packet_state
.end_cs
= bt_clock_snapshot_get_value(cs
);
630 stream
->packet_state
.content_size
=
631 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
632 stream
->packet_state
.total_size
= (stream
->packet_state
.content_size
+ 7) & ~UINT64_C(7);
634 /* Rewrite packet context */
635 bt_ctfser_set_offset_in_current_packet_bits(&stream
->ctfser
,
636 stream
->packet_state
.context_offset_bits
);
637 ret
= write_packet_context(stream
);
643 bt_ctfser_close_current_packet(&stream
->ctfser
, stream
->packet_state
.total_size
/ 8);
645 /* Partially copy current packet state to previous packet state */
646 stream
->prev_packet_state
.end_cs
= stream
->packet_state
.end_cs
;
647 stream
->prev_packet_state
.discarded_events_counter
=
648 stream
->packet_state
.discarded_events_counter
;
649 stream
->prev_packet_state
.seq_num
= stream
->packet_state
.seq_num
;
651 /* Reset current packet state */
652 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
653 stream
->packet_state
.end_cs
= UINT64_C(-1);
654 stream
->packet_state
.content_size
= 0;
655 stream
->packet_state
.total_size
= 0;
656 stream
->packet_state
.seq_num
+= 1;
657 stream
->packet_state
.context_offset_bits
= 0;
658 stream
->packet_state
.is_open
= false;
659 BT_PACKET_PUT_REF_AND_RESET(stream
->packet_state
.packet
);