2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
11 #include <babeltrace2/babeltrace.h>
13 #define BT_COMP_LOG_SELF_COMP (stream->trace->fs_sink->self_comp)
14 #define BT_LOG_OUTPUT_LEVEL (stream->log_level)
15 #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/STREAM"
16 #include "logging/comp-logging.h"
18 #include "common/assert.h"
19 #include "compat/endian.h"
20 #include "ctfser/ctfser.h"
22 #include "fs-sink-stream.hpp"
23 #include "fs-sink-trace.hpp"
24 #include "fs-sink.hpp"
25 #include "translate-trace-ir-to-ctf-ir.hpp"
27 void fs_sink_stream_destroy(struct fs_sink_stream
*stream
)
33 bt_ctfser_fini(&stream
->ctfser
);
35 if (stream
->file_name
) {
36 g_string_free(stream
->file_name
, TRUE
);
37 stream
->file_name
= NULL
;
40 bt_packet_put_ref(stream
->packet_state
.packet
);
47 static bool stream_file_name_exists(struct fs_sink_trace
*trace
, const char *name
)
53 g_hash_table_iter_init(&iter
, trace
->streams
);
55 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
56 struct fs_sink_stream
*stream
= (fs_sink_stream
*) value
;
58 if (strcmp(name
, stream
->file_name
->str
) == 0) {
68 static GString
*sanitize_stream_file_name(const char *file_name
)
70 GString
*san_file_name
= g_string_new(NULL
);
74 BT_ASSERT(san_file_name
);
76 basename
= g_path_get_basename(file_name
);
78 for (ch
= basename
; *ch
!= '\0'; ch
++) {
80 g_string_append_c(san_file_name
, '_');
82 g_string_append_c(san_file_name
, *ch
);
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");
95 static GString
*make_unique_stream_file_name(struct fs_sink_trace
*trace
, const char *base
)
97 GString
*san_base
= sanitize_stream_file_name(base
);
98 GString
*name
= g_string_new(san_base
->str
);
99 unsigned int suffix
= 0;
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
);
108 g_string_free(san_base
, TRUE
);
112 static void set_stream_file_name(struct fs_sink_stream
*stream
)
114 const char *base_name
= bt_stream_get_name(stream
->ir_stream
);
117 base_name
= "stream";
120 BT_ASSERT(!stream
->file_name
);
121 stream
->file_name
= make_unique_stream_file_name(stream
->trace
, base_name
);
124 struct fs_sink_stream
*fs_sink_stream_create(struct fs_sink_trace
*trace
,
125 const bt_stream
*ir_stream
)
127 struct fs_sink_stream
*stream
= g_new0(struct fs_sink_stream
, 1);
129 GString
*path
= g_string_new(trace
->path
->str
);
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
);
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
);
156 g_hash_table_insert(trace
->streams
, (gpointer
) ir_stream
, stream
);
160 fs_sink_stream_destroy(stream
);
165 g_string_free(path
, TRUE
);
171 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
172 const bt_field
*field
);
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
)
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).
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
);
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
)
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.
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
);
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
)
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
);
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
);
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
)
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
);
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
);
233 static inline int write_string_field(struct fs_sink_stream
*stream
, const bt_field
*field
)
235 return bt_ctfser_write_string(&stream
->ctfser
, bt_field_string_get_value(field
));
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
)
243 uint64_t len
= bt_field_array_get_length(field
);
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
)) {
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
)
264 if (fc
->length_is_before
) {
265 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, bt_field_array_get_length(field
), 8, 32,
267 if (G_UNLIKELY(ret
)) {
272 ret
= write_array_base_field_elements(stream
, &fc
->base
, field
);
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
)
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
)) {
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
;
298 ret
= write_field(stream
, member_fc
, memb_field
);
299 if (G_UNLIKELY(ret
)) {
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
)
313 const bt_field
*content_field
= bt_field_option_borrow_field_const(field
);
315 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
, content_field
? 1 : 0, 8, 8, BYTE_ORDER
);
316 if (G_UNLIKELY(ret
)) {
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:
325 * * An empty structure field class (field occupies 0 bits).
326 * * The optional field class itself.
328 * If `content_field` is `NULL`, do not write anything (empty
332 ret
= write_field(stream
, fc
->content_fc
, content_field
);
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
)
343 uint64_t opt_index
= bt_field_variant_get_selected_option_index(field
);
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
)) {
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
));
361 static int write_field(struct fs_sink_stream
*stream
, struct fs_sink_ctf_field_class
*fc
,
362 const bt_field
*field
)
367 case FS_SINK_CTF_FIELD_CLASS_TYPE_BOOL
:
368 ret
= write_bool_field(stream
, fs_sink_ctf_field_class_as_bool(fc
), field
);
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
);
373 case FS_SINK_CTF_FIELD_CLASS_TYPE_INT
:
374 ret
= write_int_field(stream
, fs_sink_ctf_field_class_as_int(fc
), field
);
376 case FS_SINK_CTF_FIELD_CLASS_TYPE_FLOAT
:
377 ret
= write_float_field(stream
, fs_sink_ctf_field_class_as_float(fc
), field
);
379 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRING
:
380 ret
= write_string_field(stream
, field
);
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);
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
),
389 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
390 ret
= write_sequence_field(stream
, fs_sink_ctf_field_class_as_sequence(fc
), field
);
392 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
393 ret
= write_option_field(stream
, fs_sink_ctf_field_class_as_option(fc
), field
);
395 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
396 ret
= write_variant_field(stream
, fs_sink_ctf_field_class_as_variant(fc
), field
);
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
)
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
)) {
418 if (stream
->sc
->default_clock_class
) {
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
)) {
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
)
435 const bt_field
*field
;
438 ret
= write_event_header(stream
, cs
, ec
);
439 if (G_UNLIKELY(ret
)) {
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
,
450 if (G_UNLIKELY(ret
)) {
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
),
461 if (G_UNLIKELY(ret
)) {
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
,
472 if (G_UNLIKELY(ret
)) {
481 static int write_packet_context(struct fs_sink_stream
*stream
)
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
);
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
);
499 if (stream
->sc
->packets_have_ts_begin
) {
501 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
502 &stream
->ctfser
, stream
->packet_state
.beginning_cs
, 8, 64, BYTE_ORDER
);
508 if (stream
->sc
->packets_have_ts_end
) {
510 ret
= bt_ctfser_write_byte_aligned_unsigned_int(
511 &stream
->ctfser
, stream
->packet_state
.end_cs
, 8, 64, BYTE_ORDER
);
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
);
526 /* Sequence number */
527 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, stream
->packet_state
.seq_num
,
534 if (stream
->sc
->packet_context_fc
) {
535 const bt_field
*packet_context_field
;
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);
552 int fs_sink_stream_open_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
,
553 const bt_packet
*packet
)
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
);
563 stream
->packet_state
.beginning_cs
= bt_clock_snapshot_get_value(cs
);
567 ret
= bt_ctfser_open_packet(&stream
->ctfser
);
569 /* bt_ctfser_open_packet() logs errors */
573 /* Packet header: magic */
574 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
, UINT64_C(0xc1fc1fc1), 8, 32,
577 BT_COMP_LOGE("Error writing packet header magic: stream-file-name=%s",
578 stream
->file_name
->str
);
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
);
587 BT_COMP_LOGE("Error writing packet header UUID: stream-file-name=%s",
588 stream
->file_name
->str
);
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
);
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
));
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
);
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
));
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
);
617 /* Write packet context just to advance to content (first event) */
618 ret
= write_packet_context(stream
);
623 stream
->packet_state
.is_open
= true;
629 int fs_sink_stream_close_packet(struct fs_sink_stream
*stream
, const bt_clock_snapshot
*cs
)
633 BT_ASSERT(stream
->packet_state
.is_open
);
636 stream
->packet_state
.end_cs
= bt_clock_snapshot_get_value(cs
);
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);
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
);
652 bt_ctfser_close_current_packet(&stream
->ctfser
, stream
->packet_state
.total_size
/ 8);
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
;
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
);