2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
7 #define BT_COMP_LOG_SELF_COMP (stream->trace->fs_sink->self_comp)
8 #define BT_LOG_OUTPUT_LEVEL (stream->log_level)
9 #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/STREAM"
10 #include "logging/comp-logging.h"
12 #include <babeltrace2/babeltrace.h>
16 #include "common/assert.h"
17 #include "ctfser/ctfser.h"
18 #include "compat/endian.h"
20 #include "fs-sink.hpp"
21 #include "fs-sink-trace.hpp"
22 #include "fs-sink-stream.hpp"
23 #include "translate-trace-ir-to-ctf-ir.hpp"
25 void fs_sink_stream_destroy(struct fs_sink_stream
*stream
)
31 bt_ctfser_fini(&stream
->ctfser
);
33 if (stream
->file_name
) {
34 g_string_free(stream
->file_name
, TRUE
);
35 stream
->file_name
= NULL
;
38 bt_packet_put_ref(stream
->packet_state
.packet
);
45 static bool stream_file_name_exists(struct fs_sink_trace
*trace
, const char *name
)
51 g_hash_table_iter_init(&iter
, trace
->streams
);
53 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
54 struct fs_sink_stream
*stream
= (fs_sink_stream
*) value
;
56 if (strcmp(name
, stream
->file_name
->str
) == 0) {
66 static GString
*sanitize_stream_file_name(const char *file_name
)
68 GString
*san_file_name
= g_string_new(NULL
);
72 BT_ASSERT(san_file_name
);
74 basename
= g_path_get_basename(file_name
);
76 for (ch
= basename
; *ch
!= '\0'; ch
++) {
78 g_string_append_c(san_file_name
, '_');
80 g_string_append_c(san_file_name
, *ch
);
84 /* Do not allow `.` and `..` either */
85 if (strcmp(san_file_name
->str
, ".") == 0 || strcmp(san_file_name
->str
, "..") == 0) {
86 g_string_assign(san_file_name
, "stream");
93 static GString
*make_unique_stream_file_name(struct fs_sink_trace
*trace
, const char *base
)
95 GString
*san_base
= sanitize_stream_file_name(base
);
96 GString
*name
= g_string_new(san_base
->str
);
97 unsigned int suffix
= 0;
101 while (stream_file_name_exists(trace
, name
->str
) || strcmp(name
->str
, "metadata") == 0) {
102 g_string_printf(name
, "%s-%u", san_base
->str
, suffix
);
106 g_string_free(san_base
, TRUE
);
110 static void set_stream_file_name(struct fs_sink_stream
*stream
)
112 const char *base_name
= bt_stream_get_name(stream
->ir_stream
);
115 base_name
= "stream";
118 BT_ASSERT(!stream
->file_name
);
119 stream
->file_name
= make_unique_stream_file_name(stream
->trace
, base_name
);
122 struct fs_sink_stream
*fs_sink_stream_create(struct fs_sink_trace
*trace
,
123 const bt_stream
*ir_stream
)
125 struct fs_sink_stream
*stream
= g_new0(struct fs_sink_stream
, 1);
127 GString
*path
= g_string_new(trace
->path
->str
);
133 stream
->log_level
= trace
->log_level
;
134 stream
->trace
= trace
;
135 stream
->ir_stream
= ir_stream
;
136 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
137 stream
->packet_state
.end_cs
= UINT64_C(-1);
138 stream
->prev_packet_state
.end_cs
= UINT64_C(-1);
139 stream
->prev_packet_state
.discarded_events_counter
= UINT64_C(-1);
140 stream
->prev_packet_state
.seq_num
= UINT64_C(-1);
141 ret
= try_translate_stream_class_trace_ir_to_ctf_ir(
142 trace
->fs_sink
, trace
->trace
, bt_stream_borrow_class_const(ir_stream
), &stream
->sc
);
147 set_stream_file_name(stream
);
148 g_string_append_printf(path
, "/%s", stream
->file_name
->str
);
149 ret
= bt_ctfser_init(&stream
->ctfser
, path
->str
, stream
->log_level
);
154 g_hash_table_insert(trace
->streams
, (gpointer
) ir_stream
, stream
);
158 fs_sink_stream_destroy(stream
);
163 g_string_free(path
, TRUE
);
169 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
170 const bt_field
*field
);
172 static inline int write_bool_field(struct fs_sink_stream
*stream
,
173 struct fs_sink_ctf_field_class_bool
*fc
, const bt_field
*field
)
176 * CTF 1.8 has no boolean field class type, so this component
177 * translates this boolean field to an 8-bit unsigned integer
178 * field which has the value 0 (false) or 1 (true).
180 return bt_ctfser_write_unsigned_int(&stream
->ctfser
, bt_field_bool_get_value(field
) ? 1 : 0,
181 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
184 static inline int write_bit_array_field(struct fs_sink_stream
*stream
,
185 struct fs_sink_ctf_field_class_bit_array
*fc
,
186 const bt_field
*field
)
189 * CTF 1.8 has no bit array field class type, so this component
190 * translates this bit array field to an unsigned integer field.
192 return bt_ctfser_write_unsigned_int(&stream
->ctfser
,
193 bt_field_bit_array_get_value_as_integer(field
),
194 fc
->base
.alignment
, fc
->size
, BYTE_ORDER
);
197 static inline int write_int_field(struct fs_sink_stream
*stream
,
198 struct fs_sink_ctf_field_class_int
*fc
, const bt_field
*field
)
203 ret
= bt_ctfser_write_signed_int(&stream
->ctfser
, bt_field_integer_signed_get_value(field
),
204 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
206 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
207 bt_field_integer_unsigned_get_value(field
),
208 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
214 static inline int write_float_field(struct fs_sink_stream
*stream
,
215 struct fs_sink_ctf_field_class_float
*fc
, const bt_field
*field
)
220 if (fc
->base
.size
== 32) {
221 val
= (double) bt_field_real_single_precision_get_value(field
);
222 ret
= bt_ctfser_write_float32(&stream
->ctfser
, val
, fc
->base
.base
.alignment
, BYTE_ORDER
);
224 val
= bt_field_real_double_precision_get_value(field
);
225 ret
= bt_ctfser_write_float64(&stream
->ctfser
, val
, fc
->base
.base
.alignment
, BYTE_ORDER
);
231 static inline int write_string_field(struct fs_sink_stream
*stream
, const bt_field
*field
)
233 return bt_ctfser_write_string(&stream
->ctfser
, bt_field_string_get_value(field
));
236 static inline int write_array_base_field_elements(struct fs_sink_stream
*stream
,
237 struct fs_sink_ctf_field_class_array_base
*fc
,
238 const bt_field
*field
)
241 uint64_t len
= bt_field_array_get_length(field
);
244 for (i
= 0; i
< len
; i
++) {
245 const bt_field
*elem_field
= bt_field_array_borrow_element_field_by_index_const(field
, i
);
246 ret
= write_field(stream
, fc
->elem_fc
, elem_field
);
247 if (G_UNLIKELY(ret
)) {
256 static inline int write_sequence_field(struct fs_sink_stream
*stream
,
257 struct fs_sink_ctf_field_class_sequence
*fc
,
258 const bt_field
*field
)
262 if (fc
->length_is_before
) {
263 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, bt_field_array_get_length(field
), 8, 32,
265 if (G_UNLIKELY(ret
)) {
270 ret
= write_array_base_field_elements(stream
, &fc
->base
, field
);
276 static inline int write_struct_field(struct fs_sink_stream
*stream
,
277 struct fs_sink_ctf_field_class_struct
*fc
,
278 const bt_field
*field
, bool align_struct
)
283 if (G_LIKELY(align_struct
)) {
284 ret
= bt_ctfser_align_offset_in_current_packet(&stream
->ctfser
, fc
->base
.alignment
);
285 if (G_UNLIKELY(ret
)) {
290 for (i
= 0; i
< fc
->members
->len
; i
++) {
291 const bt_field
*memb_field
=
292 bt_field_structure_borrow_member_field_by_index_const(field
, i
);
293 struct fs_sink_ctf_field_class
*member_fc
=
294 fs_sink_ctf_field_class_struct_borrow_member_by_index(fc
, i
)->fc
;
296 ret
= write_field(stream
, member_fc
, memb_field
);
297 if (G_UNLIKELY(ret
)) {
306 static inline int write_option_field(struct fs_sink_stream
*stream
,
307 struct fs_sink_ctf_field_class_option
*fc
,
308 const bt_field
*field
)
311 const bt_field
*content_field
= bt_field_option_borrow_field_const(field
);
313 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, content_field
? 1 : 0, 8, 8, BYTE_ORDER
);
314 if (G_UNLIKELY(ret
)) {
319 * CTF 1.8 has no option field class type, so this component
320 * translates the option field class to a variant field class
321 * where the options are:
323 * * An empty structure field class (field occupies 0 bits).
324 * * The optional field class itself.
326 * If `content_field` is `NULL`, do not write anything (empty
330 ret
= write_field(stream
, fc
->content_fc
, content_field
);
337 static inline int write_variant_field(struct fs_sink_stream
*stream
,
338 struct fs_sink_ctf_field_class_variant
*fc
,
339 const bt_field
*field
)
341 uint64_t opt_index
= bt_field_variant_get_selected_option_index(field
);
344 if (fc
->tag_is_before
) {
345 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, opt_index
, 8, 16, BYTE_ORDER
);
346 if (G_UNLIKELY(ret
)) {
351 ret
= write_field(stream
,
352 fs_sink_ctf_field_class_variant_borrow_option_by_index(fc
, opt_index
)->fc
,
353 bt_field_variant_borrow_selected_option_field_const(field
));
359 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
360 const bt_field
*field
)
365 case FS_SINK_CTF_FIELD_CLASS_TYPE_BOOL
:
366 ret
= write_bool_field(stream
, fs_sink_ctf_field_class_as_bool(fc
), field
);
368 case FS_SINK_CTF_FIELD_CLASS_TYPE_BIT_ARRAY
:
369 ret
= write_bit_array_field(stream
, fs_sink_ctf_field_class_as_bit_array(fc
), field
);
371 case FS_SINK_CTF_FIELD_CLASS_TYPE_INT
:
372 ret
= write_int_field(stream
, fs_sink_ctf_field_class_as_int(fc
), field
);
374 case FS_SINK_CTF_FIELD_CLASS_TYPE_FLOAT
:
375 ret
= write_float_field(stream
, fs_sink_ctf_field_class_as_float(fc
), field
);
377 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRING
:
378 ret
= write_string_field(stream
, field
);
380 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
381 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(fc
), field
, true);
383 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
384 ret
= write_array_base_field_elements(stream
, fs_sink_ctf_field_class_as_array_base(fc
),
387 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
388 ret
= write_sequence_field(stream
, fs_sink_ctf_field_class_as_sequence(fc
), field
);
390 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
391 ret
= write_option_field(stream
, fs_sink_ctf_field_class_as_option(fc
), field
);
393 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
394 ret
= write_variant_field(stream
, fs_sink_ctf_field_class_as_variant(fc
), field
);
403 static inline int write_event_header(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
404 struct fs_sink_ctf_event_class
*ec
)
409 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
410 &stream
->ctfser
, bt_event_class_get_id(ec
->ir_ec
), 8, 64, BYTE_ORDER
);
411 if (G_UNLIKELY(ret
)) {
416 if (stream
->sc
->default_clock_class
) {
418 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
419 &stream
->ctfser
, bt_clock_snapshot_get_value(cs
), 8, 64, BYTE_ORDER
);
420 if (G_UNLIKELY(ret
)) {
429 int fs_sink_stream_write_event(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
430 const bt_event
*event
, struct fs_sink_ctf_event_class
*ec
)
433 const bt_field
*field
;
436 ret
= write_event_header(stream
, cs
, ec
);
437 if (G_UNLIKELY(ret
)) {
442 if (stream
->sc
->event_common_context_fc
) {
443 field
= bt_event_borrow_common_context_field_const(event
);
444 BT_ASSERT_DBG(field
);
445 ret
= write_struct_field(
446 stream
, fs_sink_ctf_field_class_as_struct(stream
->sc
->event_common_context_fc
), field
,
448 if (G_UNLIKELY(ret
)) {
453 /* Specific context */
454 if (ec
->spec_context_fc
) {
455 field
= bt_event_borrow_specific_context_field_const(event
);
456 BT_ASSERT_DBG(field
);
457 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(ec
->spec_context_fc
),
459 if (G_UNLIKELY(ret
)) {
464 /* Specific context */
465 if (ec
->payload_fc
) {
466 field
= bt_event_borrow_payload_field_const(event
);
467 BT_ASSERT_DBG(field
);
468 ret
= write_struct_field(stream
, fs_sink_ctf_field_class_as_struct(ec
->payload_fc
), field
,
470 if (G_UNLIKELY(ret
)) {
479 static int write_packet_context(struct fs_sink_stream
*stream
)
483 /* Packet total size */
484 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
485 &stream
->ctfser
, stream
->packet_state
.total_size
, 8, 64, BYTE_ORDER
);
490 /* Packet content size */
491 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
492 &stream
->ctfser
, stream
->packet_state
.content_size
, 8, 64, BYTE_ORDER
);
497 if (stream
->sc
->packets_have_ts_begin
) {
499 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
500 &stream
->ctfser
, stream
->packet_state
.beginning_cs
, 8, 64, BYTE_ORDER
);
506 if (stream
->sc
->packets_have_ts_end
) {
508 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
509 &stream
->ctfser
, stream
->packet_state
.end_cs
, 8, 64, BYTE_ORDER
);
515 if (stream
->sc
->has_discarded_events
) {
516 /* Discarded event counter */
517 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
518 &stream
->ctfser
, stream
->packet_state
.discarded_events_counter
, 8, 64, BYTE_ORDER
);
524 /* Sequence number */
525 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, stream
->packet_state
.seq_num
,
532 if (stream
->sc
->packet_context_fc
) {
533 const bt_field
*packet_context_field
;
535 BT_ASSERT(stream
->packet_state
.packet
);
536 packet_context_field
= bt_packet_borrow_context_field_const(stream
->packet_state
.packet
);
537 BT_ASSERT(packet_context_field
);
538 ret
= write_struct_field(stream
,
539 fs_sink_ctf_field_class_as_struct(stream
->sc
->packet_context_fc
),
540 packet_context_field
, false);
550 int fs_sink_stream_open_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
551 const bt_packet
*packet
)
556 BT_ASSERT(!stream
->packet_state
.is_open
);
557 bt_packet_put_ref(stream
->packet_state
.packet
);
558 stream
->packet_state
.packet
= packet
;
559 bt_packet_get_ref(stream
->packet_state
.packet
);
561 stream
->packet_state
.beginning_cs
= bt_clock_snapshot_get_value(cs
);
565 ret
= bt_ctfser_open_packet(&stream
->ctfser
);
567 /* bt_ctfser_open_packet() logs errors */
571 /* Packet header: magic */
572 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, UINT64_C(0xc1fc1fc1), 8, 32,
575 BT_COMP_LOGE("Error writing packet header magic: stream-file-name=%s",
576 stream
->file_name
->str
);
580 /* Packet header: UUID */
581 for (i
= 0; i
< BT_UUID_LEN
; i
++) {
582 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
583 &stream
->ctfser
, (uint64_t) stream
->sc
->trace
->uuid
[i
], 8, 8, BYTE_ORDER
);
585 BT_COMP_LOGE("Error writing packet header UUID: stream-file-name=%s",
586 stream
->file_name
->str
);
591 /* Packet header: stream class ID */
592 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
593 &stream
->ctfser
, bt_stream_class_get_id(stream
->sc
->ir_sc
), 8, 64, BYTE_ORDER
);
595 BT_COMP_LOGE("Error writing packet header stream class id: "
596 "stream-file-name=%s, stream-class-id=%" PRIu64
,
597 stream
->file_name
->str
, bt_stream_class_get_id(stream
->sc
->ir_sc
));
601 /* Packet header: stream ID */
602 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
603 &stream
->ctfser
, bt_stream_get_id(stream
->ir_stream
), 8, 64, BYTE_ORDER
);
605 BT_COMP_LOGE("Error writing packet header stream id: "
606 "stream-file-name=%s, stream-id=%" PRIu64
,
607 stream
->file_name
->str
, bt_stream_get_id(stream
->ir_stream
));
611 /* Save packet context's offset to rewrite it later */
612 stream
->packet_state
.context_offset_bits
=
613 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
615 /* Write packet context just to advance to content (first event) */
616 ret
= write_packet_context(stream
);
621 stream
->packet_state
.is_open
= true;
627 int fs_sink_stream_close_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
)
631 BT_ASSERT(stream
->packet_state
.is_open
);
634 stream
->packet_state
.end_cs
= bt_clock_snapshot_get_value(cs
);
637 stream
->packet_state
.content_size
=
638 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
639 stream
->packet_state
.total_size
= (stream
->packet_state
.content_size
+ 7) & ~UINT64_C(7);
641 /* Rewrite packet context */
642 bt_ctfser_set_offset_in_current_packet_bits(&stream
->ctfser
,
643 stream
->packet_state
.context_offset_bits
);
644 ret
= write_packet_context(stream
);
650 bt_ctfser_close_current_packet(&stream
->ctfser
, stream
->packet_state
.total_size
/ 8);
652 /* Partially copy current packet state to previous packet state */
653 stream
->prev_packet_state
.end_cs
= stream
->packet_state
.end_cs
;
654 stream
->prev_packet_state
.discarded_events_counter
=
655 stream
->packet_state
.discarded_events_counter
;
656 stream
->prev_packet_state
.seq_num
= stream
->packet_state
.seq_num
;
658 /* Reset current packet state */
659 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
660 stream
->packet_state
.end_cs
= UINT64_C(-1);
661 stream
->packet_state
.content_size
= 0;
662 stream
->packet_state
.total_size
= 0;
663 stream
->packet_state
.seq_num
+= 1;
664 stream
->packet_state
.context_offset_bits
= 0;
665 stream
->packet_state
.is_open
= false;
666 BT_PACKET_PUT_REF_AND_RESET(stream
->packet_state
.packet
);