2 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #define BT_COMP_LOG_SELF_COMP (stream->trace->fs_sink->self_comp)
24 #define BT_LOG_OUTPUT_LEVEL (stream->log_level)
25 #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/STREAM"
26 #include "logging/comp-logging.h"
28 #include <babeltrace2/babeltrace.h>
32 #include "common/assert.h"
33 #include "ctfser/ctfser.h"
34 #include "compat/endian.h"
37 #include "fs-sink-trace.h"
38 #include "fs-sink-stream.h"
39 #include "translate-trace-ir-to-ctf-ir.h"
42 void fs_sink_stream_destroy(struct fs_sink_stream
*stream
)
48 bt_ctfser_fini(&stream
->ctfser
);
50 if (stream
->file_name
) {
51 g_string_free(stream
->file_name
, TRUE
);
52 stream
->file_name
= NULL
;
55 bt_packet_put_ref(stream
->packet_state
.packet
);
63 bool stream_file_name_exists(struct fs_sink_trace
*trace
, const char *name
)
69 g_hash_table_iter_init(&iter
, trace
->streams
);
71 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
72 struct fs_sink_stream
*stream
= value
;
74 if (strcmp(name
, stream
->file_name
->str
) == 0) {
85 GString
*sanitize_stream_file_name(const char *file_name
)
87 GString
*san_file_name
= g_string_new(NULL
);
91 BT_ASSERT(san_file_name
);
93 basename
= g_path_get_basename(file_name
);
95 for (ch
= basename
; *ch
!= '\0'; ch
++) {
97 g_string_append_c(san_file_name
, '_');
99 g_string_append_c(san_file_name
, *ch
);
103 /* Do not allow `.` and `..` either */
104 if (strcmp(san_file_name
->str
, ".") == 0 ||
105 strcmp(san_file_name
->str
, "..") == 0) {
106 g_string_assign(san_file_name
, "stream");
110 return san_file_name
;
114 GString
*make_unique_stream_file_name(struct fs_sink_trace
*trace
,
117 GString
*san_base
= sanitize_stream_file_name(base
);
118 GString
*name
= g_string_new(san_base
->str
);
119 unsigned int suffix
= 0;
123 while (stream_file_name_exists(trace
, name
->str
) &&
124 strcmp(name
->str
, "metadata") == 0) {
125 g_string_printf(name
, "%s-%u", san_base
->str
, suffix
);
129 g_string_free(san_base
, TRUE
);
134 void set_stream_file_name(struct fs_sink_stream
*stream
)
136 const char *base_name
= bt_stream_get_name(stream
->ir_stream
);
139 base_name
= "stream";
142 BT_ASSERT(!stream
->file_name
);
143 stream
->file_name
= make_unique_stream_file_name(stream
->trace
,
148 struct fs_sink_stream
*fs_sink_stream_create(struct fs_sink_trace
*trace
,
149 const bt_stream
*ir_stream
)
151 struct fs_sink_stream
*stream
= g_new0(struct fs_sink_stream
, 1);
153 GString
*path
= g_string_new(trace
->path
->str
);
159 stream
->log_level
= trace
->log_level
;
160 stream
->trace
= trace
;
161 stream
->ir_stream
= ir_stream
;
162 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
163 stream
->packet_state
.end_cs
= UINT64_C(-1);
164 stream
->prev_packet_state
.end_cs
= UINT64_C(-1);
165 stream
->prev_packet_state
.discarded_events_counter
= UINT64_C(-1);
166 stream
->prev_packet_state
.seq_num
= UINT64_C(-1);
167 ret
= try_translate_stream_class_trace_ir_to_ctf_ir(trace
->fs_sink
,
168 trace
->trace
, bt_stream_borrow_class_const(ir_stream
),
174 set_stream_file_name(stream
);
175 g_string_append_printf(path
, "/%s", stream
->file_name
->str
);
176 ret
= bt_ctfser_init(&stream
->ctfser
, path
->str
,
182 g_hash_table_insert(trace
->streams
, (gpointer
) ir_stream
, stream
);
186 fs_sink_stream_destroy(stream
);
191 g_string_free(path
, TRUE
);
198 int write_field(struct fs_sink_stream
*stream
,
199 struct fs_sink_ctf_field_class
*fc
, const bt_field
*field
);
202 int write_bool_field(struct fs_sink_stream
*stream
,
203 struct fs_sink_ctf_field_class_int
*fc
, const bt_field
*field
)
206 * CTF 1.8 has no boolean field class type, so this component
207 * translates this boolean field to an 8-bit unsigned integer
208 * field which has the value 0 (false) or 1 (true).
210 return bt_ctfser_write_unsigned_int(&stream
->ctfser
,
211 bt_field_bool_get_value(field
) ? 1 : 0,
212 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
216 int write_int_field(struct fs_sink_stream
*stream
,
217 struct fs_sink_ctf_field_class_int
*fc
, const bt_field
*field
)
222 ret
= bt_ctfser_write_signed_int(&stream
->ctfser
,
223 bt_field_integer_signed_get_value(field
),
224 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
226 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
227 bt_field_integer_unsigned_get_value(field
),
228 fc
->base
.base
.alignment
, fc
->base
.size
, BYTE_ORDER
);
235 int write_float_field(struct fs_sink_stream
*stream
,
236 struct fs_sink_ctf_field_class_float
*fc
, const bt_field
*field
)
239 double val
= bt_field_real_get_value(field
);
241 if (fc
->base
.size
== 32) {
242 ret
= bt_ctfser_write_float32(&stream
->ctfser
, val
,
243 fc
->base
.base
.alignment
, BYTE_ORDER
);
245 ret
= bt_ctfser_write_float64(&stream
->ctfser
, val
,
246 fc
->base
.base
.alignment
, BYTE_ORDER
);
253 int write_string_field(struct fs_sink_stream
*stream
,
254 struct fs_sink_ctf_field_class_string
*fc
, const bt_field
*field
)
256 return bt_ctfser_write_string(&stream
->ctfser
,
257 bt_field_string_get_value(field
));
261 int write_array_field_elements(struct fs_sink_stream
*stream
,
262 struct fs_sink_ctf_field_class_array_base
*fc
,
263 const bt_field
*field
)
266 uint64_t len
= bt_field_array_get_length(field
);
269 for (i
= 0; i
< len
; i
++) {
270 const bt_field
*elem_field
=
271 bt_field_array_borrow_element_field_by_index_const(
273 ret
= write_field(stream
, fc
->elem_fc
, elem_field
);
274 if (G_UNLIKELY(ret
)) {
284 int write_sequence_field(struct fs_sink_stream
*stream
,
285 struct fs_sink_ctf_field_class_sequence
*fc
,
286 const bt_field
*field
)
290 if (fc
->length_is_before
) {
291 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
292 bt_field_array_get_length(field
), 8, 32, BYTE_ORDER
);
293 if (G_UNLIKELY(ret
)) {
298 ret
= write_array_field_elements(stream
, (void *) fc
, field
);
305 int write_struct_field(struct fs_sink_stream
*stream
,
306 struct fs_sink_ctf_field_class_struct
*fc
,
307 const bt_field
*field
, bool align_struct
)
312 if (G_LIKELY(align_struct
)) {
313 ret
= bt_ctfser_align_offset_in_current_packet(&stream
->ctfser
,
315 if (G_UNLIKELY(ret
)) {
320 for (i
= 0; i
< fc
->members
->len
; i
++) {
321 const bt_field
*memb_field
=
322 bt_field_structure_borrow_member_field_by_index_const(
324 struct fs_sink_ctf_field_class
*member_fc
=
325 fs_sink_ctf_field_class_struct_borrow_member_by_index(
328 ret
= write_field(stream
, member_fc
, memb_field
);
329 if (G_UNLIKELY(ret
)) {
339 int write_option_field(struct fs_sink_stream
*stream
,
340 struct fs_sink_ctf_field_class_option
*fc
,
341 const bt_field
*field
)
344 const bt_field
*content_field
=
345 bt_field_option_borrow_field_const(field
);
347 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
348 content_field
? 1 : 0, 8, 8, BYTE_ORDER
);
349 if (G_UNLIKELY(ret
)) {
354 * CTF 1.8 has no option field class type, so this component
355 * translates the option field class to a variant field class
356 * where the options are:
358 * * An empty structure field class (field occupies 0 bits).
359 * * The optional field class itself.
361 * If `content_field` is `NULL`, do not write anything (empty
365 ret
= write_field(stream
, fc
->content_fc
, content_field
);
373 int write_variant_field(struct fs_sink_stream
*stream
,
374 struct fs_sink_ctf_field_class_variant
*fc
,
375 const bt_field
*field
)
378 bt_field_variant_get_selected_option_field_index(field
);
381 if (fc
->tag_is_before
) {
382 ret
= bt_ctfser_write_unsigned_int(&stream
->ctfser
,
383 opt_index
, 8, 16, BYTE_ORDER
);
384 if (G_UNLIKELY(ret
)) {
389 ret
= write_field(stream
,
390 fs_sink_ctf_field_class_variant_borrow_option_by_index(fc
,
392 bt_field_variant_borrow_selected_option_field_const(field
));
399 int write_field(struct fs_sink_stream
*stream
,
400 struct fs_sink_ctf_field_class
*fc
, const bt_field
*field
)
405 case FS_SINK_CTF_FIELD_CLASS_TYPE_BOOL
:
406 ret
= write_bool_field(stream
, (void *) fc
, field
);
408 case FS_SINK_CTF_FIELD_CLASS_TYPE_INT
:
409 ret
= write_int_field(stream
, (void *) fc
, field
);
411 case FS_SINK_CTF_FIELD_CLASS_TYPE_FLOAT
:
412 ret
= write_float_field(stream
, (void *) fc
, field
);
414 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRING
:
415 ret
= write_string_field(stream
, (void *) fc
, field
);
417 case FS_SINK_CTF_FIELD_CLASS_TYPE_STRUCT
:
418 ret
= write_struct_field(stream
, (void *) fc
, field
, true);
420 case FS_SINK_CTF_FIELD_CLASS_TYPE_ARRAY
:
421 ret
= write_array_field_elements(stream
, (void *) fc
, field
);
423 case FS_SINK_CTF_FIELD_CLASS_TYPE_SEQUENCE
:
424 ret
= write_sequence_field(stream
, (void *) fc
, field
);
426 case FS_SINK_CTF_FIELD_CLASS_TYPE_OPTION
:
427 ret
= write_option_field(stream
, (void *) fc
, field
);
429 case FS_SINK_CTF_FIELD_CLASS_TYPE_VARIANT
:
430 ret
= write_variant_field(stream
, (void *) fc
, field
);
440 int write_event_header(struct fs_sink_stream
*stream
,
441 const bt_clock_snapshot
*cs
, struct fs_sink_ctf_event_class
*ec
)
446 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
447 bt_event_class_get_id(ec
->ir_ec
), 8, 64, BYTE_ORDER
);
448 if (G_UNLIKELY(ret
)) {
453 if (stream
->sc
->default_clock_class
) {
455 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
456 bt_clock_snapshot_get_value(cs
), 8, 64, BYTE_ORDER
);
457 if (G_UNLIKELY(ret
)) {
467 int fs_sink_stream_write_event(struct fs_sink_stream
*stream
,
468 const bt_clock_snapshot
*cs
, const bt_event
*event
,
469 struct fs_sink_ctf_event_class
*ec
)
472 const bt_field
*field
;
475 ret
= write_event_header(stream
, cs
, ec
);
476 if (G_UNLIKELY(ret
)) {
481 if (stream
->sc
->event_common_context_fc
) {
482 field
= bt_event_borrow_common_context_field_const(event
);
484 ret
= write_struct_field(stream
,
485 (void *) stream
->sc
->event_common_context_fc
,
487 if (G_UNLIKELY(ret
)) {
492 /* Specific context */
493 if (ec
->spec_context_fc
) {
494 field
= bt_event_borrow_specific_context_field_const(event
);
496 ret
= write_struct_field(stream
, (void *) ec
->spec_context_fc
,
498 if (G_UNLIKELY(ret
)) {
503 /* Specific context */
504 if (ec
->payload_fc
) {
505 field
= bt_event_borrow_payload_field_const(event
);
507 ret
= write_struct_field(stream
, (void *) ec
->payload_fc
,
509 if (G_UNLIKELY(ret
)) {
519 int write_packet_context(struct fs_sink_stream
*stream
)
523 /* Packet total size */
524 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
525 stream
->packet_state
.total_size
, 8, 64, BYTE_ORDER
);
530 /* Packet content size */
531 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
532 stream
->packet_state
.content_size
, 8, 64, BYTE_ORDER
);
537 if (stream
->sc
->packets_have_ts_begin
) {
539 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
540 stream
->packet_state
.beginning_cs
, 8, 64, BYTE_ORDER
);
546 if (stream
->sc
->packets_have_ts_end
) {
548 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
549 stream
->packet_state
.end_cs
, 8, 64, BYTE_ORDER
);
555 if (stream
->sc
->has_discarded_events
) {
556 /* Discarded event counter */
557 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
558 stream
->packet_state
.discarded_events_counter
, 8, 64,
565 /* Sequence number */
566 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
567 stream
->packet_state
.seq_num
, 8, 64, BYTE_ORDER
);
573 if (stream
->sc
->packet_context_fc
) {
574 const bt_field
*packet_context_field
;
576 BT_ASSERT(stream
->packet_state
.packet
);
577 packet_context_field
= bt_packet_borrow_context_field_const(
578 stream
->packet_state
.packet
);
579 BT_ASSERT(packet_context_field
);
580 ret
= write_struct_field(stream
,
581 (void *) stream
->sc
->packet_context_fc
,
582 packet_context_field
, false);
593 int fs_sink_stream_open_packet(struct fs_sink_stream
*stream
,
594 const bt_clock_snapshot
*cs
, const bt_packet
*packet
)
599 BT_ASSERT(!stream
->packet_state
.is_open
);
600 bt_packet_put_ref(stream
->packet_state
.packet
);
601 stream
->packet_state
.packet
= packet
;
602 bt_packet_get_ref(stream
->packet_state
.packet
);
604 stream
->packet_state
.beginning_cs
=
605 bt_clock_snapshot_get_value(cs
);
609 ret
= bt_ctfser_open_packet(&stream
->ctfser
);
611 /* bt_ctfser_open_packet() logs errors */
615 /* Packet header: magic */
616 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
617 UINT64_C(0xc1fc1fc1), 8, 32, BYTE_ORDER
);
619 BT_COMP_LOGE("Error writing packet header magic: stream-file-name=%s",
620 stream
->file_name
->str
);
624 /* Packet header: UUID */
625 for (i
= 0; i
< BT_UUID_LEN
; i
++) {
626 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
627 (uint64_t) stream
->sc
->trace
->uuid
[i
], 8, 8, BYTE_ORDER
);
629 BT_COMP_LOGE("Error writing packet header UUID: stream-file-name=%s",
630 stream
->file_name
->str
);
635 /* Packet header: stream class ID */
636 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
637 bt_stream_class_get_id(stream
->sc
->ir_sc
), 8, 64, BYTE_ORDER
);
639 BT_COMP_LOGE("Error writing packet header stream class id: "
640 "stream-file-name=%s, stream-class-id=%"PRIu64
,
641 stream
->file_name
->str
,
642 bt_stream_class_get_id(stream
->sc
->ir_sc
));
646 /* Packet header: stream ID */
647 ret
= bt_ctfser_write_byte_aligned_unsigned_int(&stream
->ctfser
,
648 bt_stream_get_id(stream
->ir_stream
), 8, 64, BYTE_ORDER
);
650 BT_COMP_LOGE("Error writing packet header stream id: "
651 "stream-file-name=%s, stream-id=%"PRIu64
,
652 stream
->file_name
->str
,
653 bt_stream_get_id(stream
->ir_stream
));
657 /* Save packet context's offset to rewrite it later */
658 stream
->packet_state
.context_offset_bits
=
659 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
661 /* Write packet context just to advance to content (first event) */
662 ret
= write_packet_context(stream
);
667 stream
->packet_state
.is_open
= true;
674 int fs_sink_stream_close_packet(struct fs_sink_stream
*stream
,
675 const bt_clock_snapshot
*cs
)
679 BT_ASSERT(stream
->packet_state
.is_open
);
682 stream
->packet_state
.end_cs
= bt_clock_snapshot_get_value(cs
);
685 stream
->packet_state
.content_size
=
686 bt_ctfser_get_offset_in_current_packet_bits(&stream
->ctfser
);
687 stream
->packet_state
.total_size
=
688 (stream
->packet_state
.content_size
+ 7) & ~UINT64_C(7);
690 /* Rewrite packet context */
691 bt_ctfser_set_offset_in_current_packet_bits(&stream
->ctfser
,
692 stream
->packet_state
.context_offset_bits
);
693 ret
= write_packet_context(stream
);
699 bt_ctfser_close_current_packet(&stream
->ctfser
,
700 stream
->packet_state
.total_size
/ 8);
702 /* Partially copy current packet state to previous packet state */
703 stream
->prev_packet_state
.end_cs
= stream
->packet_state
.end_cs
;
704 stream
->prev_packet_state
.discarded_events_counter
=
705 stream
->packet_state
.discarded_events_counter
;
706 stream
->prev_packet_state
.seq_num
=
707 stream
->packet_state
.seq_num
;
709 /* Reset current packet state */
710 stream
->packet_state
.beginning_cs
= UINT64_C(-1);
711 stream
->packet_state
.end_cs
= UINT64_C(-1);
712 stream
->packet_state
.content_size
= 0;
713 stream
->packet_state
.total_size
= 0;
714 stream
->packet_state
.seq_num
+= 1;
715 stream
->packet_state
.context_offset_bits
= 0;
716 stream
->packet_state
.is_open
= false;
717 BT_PACKET_PUT_REF_AND_RESET(stream
->packet_state
.packet
);