2 * BabelTrace - Common Trace Format (CTF)
6 * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
19 #include <babeltrace/format.h>
20 #include <babeltrace/ctf/types.h>
21 #include <babeltrace/ctf/metadata.h>
22 #include <babeltrace/babeltrace.h>
25 #include <uuid/uuid.h>
29 #include <sys/types.h>
37 #include "metadata/ctf-scanner.h"
38 #include "metadata/ctf-parser.h"
39 #include "metadata/ctf-ast.h"
42 * We currently simply map a page to read the packet header and packet
43 * context to get the packet length and content length. (in bits)
45 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
46 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
47 #define UUID_LEN 16 /* uuid by value len */
50 #define min(a, b) (((a) < (b)) ? (a) : (b))
56 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
);
58 void ctf_close_trace(struct trace_descriptor
*descriptor
);
61 rw_dispatch read_dispatch_table
[] = {
62 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
63 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
64 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
65 [ CTF_TYPE_STRING
] = ctf_string_read
,
66 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
67 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
68 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
69 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
73 rw_dispatch write_dispatch_table
[] = {
74 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
75 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
76 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
77 [ CTF_TYPE_STRING
] = ctf_string_write
,
78 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
79 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
80 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
81 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
85 struct format ctf_format
= {
86 .open_trace
= ctf_open_trace
,
87 .close_trace
= ctf_close_trace
,
91 void ctf_update_timestamp(struct ctf_stream
*stream
,
92 struct definition_integer
*integer_definition
)
94 struct declaration_integer
*integer_declaration
=
95 integer_definition
->declaration
;
96 uint64_t oldval
, newval
, updateval
;
98 if (integer_declaration
->len
== 64) {
99 stream
->timestamp
= integer_definition
->value
._unsigned
;
103 oldval
= stream
->timestamp
;
104 oldval
&= (1ULL << integer_declaration
->len
) - 1;
105 newval
= integer_definition
->value
._unsigned
;
106 /* Test for overflow by comparing low bits */
108 newval
+= 1ULL << integer_declaration
->len
;
109 /* updateval contains old high bits, and new low bits (sum) */
110 updateval
= stream
->timestamp
;
111 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
113 stream
->timestamp
= updateval
;
117 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
119 struct ctf_stream_pos
*pos
=
120 container_of(ppos
, struct ctf_stream_pos
, parent
);
121 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
122 struct ctf_stream_event
*event
;
126 if (pos
->offset
== EOF
)
129 /* Read event header */
130 if (stream
->stream_event_header
) {
131 struct definition_integer
*integer_definition
;
132 struct definition
*variant
;
134 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
137 /* lookup event id */
138 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
139 if (integer_definition
) {
140 id
= integer_definition
->value
._unsigned
;
142 struct definition_enum
*enum_definition
;
144 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
145 if (enum_definition
) {
146 id
= enum_definition
->integer
->value
._unsigned
;
150 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
152 integer_definition
= lookup_integer(variant
, "id", FALSE
);
153 if (integer_definition
) {
154 id
= integer_definition
->value
._unsigned
;
158 /* lookup timestamp */
159 stream
->has_timestamp
= 0;
160 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
161 if (integer_definition
) {
162 ctf_update_timestamp(stream
, integer_definition
);
163 stream
->has_timestamp
= 1;
166 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
167 if (integer_definition
) {
168 ctf_update_timestamp(stream
, integer_definition
);
169 stream
->has_timestamp
= 1;
175 /* Read stream-declared event context */
176 if (stream
->stream_event_context
) {
177 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
182 if (id
>= stream_class
->events_by_id
->len
) {
183 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
186 event
= g_ptr_array_index(stream
->events_by_id
, id
);
188 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
192 /* Read event-declared event context */
193 if (event
->event_context
) {
194 ret
= generic_rw(ppos
, &event
->event_context
->p
);
199 /* Read event payload */
200 if (event
->event_fields
) {
201 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
209 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
214 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
216 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
217 struct ctf_stream_event
*event
;
221 /* print event header */
222 if (stream
->stream_event_header
) {
223 struct definition_integer
*integer_definition
;
224 struct definition
*variant
;
226 /* lookup event id */
227 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
228 if (integer_definition
) {
229 id
= integer_definition
->value
._unsigned
;
231 struct definition_enum
*enum_definition
;
233 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
234 if (enum_definition
) {
235 id
= enum_definition
->integer
->value
._unsigned
;
239 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
241 integer_definition
= lookup_integer(variant
, "id", FALSE
);
242 if (integer_definition
) {
243 id
= integer_definition
->value
._unsigned
;
247 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
252 /* print stream-declared event context */
253 if (stream
->stream_event_context
) {
254 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
259 if (id
>= stream_class
->events_by_id
->len
) {
260 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
263 event
= g_ptr_array_index(stream
->events_by_id
, id
);
265 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
269 /* print event-declared event context */
270 if (event
->event_context
) {
271 ret
= generic_rw(pos
, &event
->event_context
->p
);
276 /* Read and print event payload */
277 if (event
->event_fields
) {
278 ret
= generic_rw(pos
, &event
->event_fields
->p
);
286 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
290 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
293 pos
->mmap_offset
= 0;
294 pos
->packet_size
= 0;
295 pos
->content_size
= 0;
296 pos
->content_size_loc
= NULL
;
302 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
303 sizeof(struct packet_index
));
305 pos
->packet_index
= NULL
;
306 switch (open_flags
& O_ACCMODE
) {
308 pos
->prot
= PROT_READ
;
309 pos
->flags
= MAP_PRIVATE
;
310 pos
->parent
.rw_table
= read_dispatch_table
;
311 pos
->parent
.event_cb
= ctf_read_event
;
314 pos
->prot
= PROT_WRITE
; /* Write has priority */
315 pos
->flags
= MAP_SHARED
;
316 pos
->parent
.rw_table
= write_dispatch_table
;
317 pos
->parent
.event_cb
= ctf_write_event
;
319 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
326 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
330 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
331 *pos
->content_size_loc
= pos
->offset
;
334 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
336 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
341 (void) g_array_free(pos
->packet_index
, TRUE
);
344 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
)
346 struct ctf_file_stream
*file_stream
=
347 container_of(pos
, struct ctf_file_stream
, pos
);
350 struct packet_index
*index
;
352 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
353 *pos
->content_size_loc
= pos
->offset
;
357 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
359 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
367 * The caller should never ask for ctf_move_pos across packets,
368 * except to get exactly at the beginning of the next packet.
370 if (pos
->prot
== PROT_WRITE
) {
373 /* The writer will add padding */
374 assert(pos
->offset
+ offset
== pos
->packet_size
);
375 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
378 assert(offset
== 0); /* only seek supported for now */
384 pos
->content_size
= -1U; /* Unknown at this point */
385 pos
->packet_size
= WRITE_PACKET_LEN
;
386 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
387 pos
->packet_size
/ CHAR_BIT
);
393 /* The reader will expect us to skip padding */
394 assert(pos
->offset
+ offset
== pos
->content_size
);
398 assert(offset
== 0); /* only seek supported for now */
404 if (pos
->cur_index
>= pos
->packet_index
->len
) {
408 index
= &g_array_index(pos
->packet_index
, struct packet_index
,
410 pos
->mmap_offset
= index
->offset
;
412 /* Lookup context/packet size in index */
413 file_stream
->parent
.timestamp
= index
->timestamp_begin
;
414 pos
->content_size
= index
->content_size
;
415 pos
->packet_size
= index
->packet_size
;
416 if (index
->data_offset
< index
->content_size
)
417 pos
->offset
= 0; /* will read headers */
423 /* map new base. Need mapping length from header. */
424 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
425 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
426 if (pos
->base
== MAP_FAILED
) {
427 fprintf(stdout
, "[error] mmap error %s.\n",
432 /* update trace_packet_header and stream_packet_context */
433 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
434 /* Read packet header */
435 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
438 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
439 /* Read packet context */
440 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
446 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
452 len
= fread(&magic
, sizeof(magic
), 1, fp
);
456 if (magic
== TSDL_MAGIC
) {
458 td
->byte_order
= BYTE_ORDER
;
459 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
461 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
462 LITTLE_ENDIAN
: BIG_ENDIAN
;
464 CTF_TRACE_SET_FIELD(td
, byte_order
);
471 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
474 struct metadata_packet_header header
;
475 size_t readlen
, writelen
, toread
;
479 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
483 if (td
->byte_order
!= BYTE_ORDER
) {
484 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
485 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
486 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
487 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
490 fprintf(stdout
, "[warning] checksum verification not supported yet.\n");
491 if (header
.compression_scheme
) {
492 fprintf(stdout
, "[error] compression (%u) not supported yet.\n",
493 header
.compression_scheme
);
496 if (header
.encryption_scheme
) {
497 fprintf(stdout
, "[error] encryption (%u) not supported yet.\n",
498 header
.encryption_scheme
);
501 if (header
.checksum_scheme
) {
502 fprintf(stdout
, "[error] checksum (%u) not supported yet.\n",
503 header
.checksum_scheme
);
506 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
507 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
508 CTF_TRACE_SET_FIELD(td
, uuid
);
510 if (uuid_compare(header
.uuid
, td
->uuid
))
514 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
517 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
), toread
), in
);
522 if (babeltrace_debug
) {
523 fprintf(stdout
, "[debug] metadata packet read: %s\n",
527 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
528 if (writelen
< readlen
) {
538 ret
= 0; /* continue reading next packet */
546 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
555 * Using strlen on *buf instead of size of open_memstream
556 * because its size includes garbage at the end (after final
557 * \0). This is the allocated size, not the actual string size.
559 out
= open_memstream(buf
, &size
);
564 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
573 fclose(out
); /* flush the buffer */
575 /* open for reading */
576 *fp
= fmemopen(*buf
, strlen(*buf
), "rb");
581 int ctf_open_trace_metadata_read(struct ctf_trace
*td
)
583 struct ctf_scanner
*scanner
;
584 struct ctf_file_stream
*metadata_stream
;
589 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
590 td
->metadata
= &metadata_stream
->parent
;
591 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
592 if (metadata_stream
->pos
.fd
< 0) {
593 fprintf(stdout
, "Unable to open metadata.\n");
594 return metadata_stream
->pos
.fd
;
597 if (babeltrace_debug
)
600 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
602 fprintf(stdout
, "[error] Unable to open metadata stream.\n");
607 if (packet_metadata(td
, fp
)) {
608 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
610 goto end_packet_read
;
613 scanner
= ctf_scanner_alloc(fp
);
615 fprintf(stdout
, "[error] Error allocating scanner\n");
617 goto end_scanner_alloc
;
619 ret
= ctf_scanner_append_ast(scanner
);
621 fprintf(stdout
, "[error] Error creating AST\n");
625 if (babeltrace_debug
) {
626 ret
= ctf_visitor_print_xml(stdout
, 0, &scanner
->ast
->root
);
628 fprintf(stdout
, "[error] Error visiting AST for XML output\n");
633 ret
= ctf_visitor_semantic_check(stdout
, 0, &scanner
->ast
->root
);
635 fprintf(stdout
, "[error] Error in CTF semantic validation %d\n", ret
);
638 ret
= ctf_visitor_construct_metadata(stdout
, 0, &scanner
->ast
->root
,
641 fprintf(stdout
, "[error] Error in CTF metadata constructor %d\n", ret
);
645 ctf_scanner_free(scanner
);
651 close(metadata_stream
->pos
.fd
);
653 g_free(metadata_stream
);
658 struct ctf_stream_event
*create_event_definitions(struct ctf_trace
*td
,
659 struct ctf_stream
*stream
,
660 struct ctf_event
*event
)
662 struct ctf_stream_event
*stream_event
= g_new0(struct ctf_stream_event
, 1);
664 if (event
->context_decl
) {
665 struct definition
*definition
=
666 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
667 stream
->parent_def_scope
, 0, 0, "event.context");
671 stream_event
->event_context
= container_of(definition
,
672 struct definition_struct
, p
);
673 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
675 if (event
->fields_decl
) {
676 struct definition
*definition
=
677 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
678 stream
->parent_def_scope
, 0, 0, "event.fields");
682 stream_event
->event_fields
= container_of(definition
,
683 struct definition_struct
, p
);
684 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
689 if (stream_event
->event_fields
)
690 definition_unref(&stream_event
->event_fields
->p
);
691 if (stream_event
->event_context
)
692 definition_unref(&stream_event
->event_context
->p
);
697 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
699 struct ctf_stream_class
*stream_class
;
703 if (stream
->stream_definitions_created
)
706 stream_class
= stream
->stream_class
;
708 if (stream_class
->packet_context_decl
) {
709 struct definition
*definition
=
710 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
711 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
716 stream
->stream_packet_context
= container_of(definition
,
717 struct definition_struct
, p
);
718 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
720 if (stream_class
->event_header_decl
) {
721 struct definition
*definition
=
722 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
723 stream
->parent_def_scope
, 0, 0, "stream.event.header");
728 stream
->stream_event_header
=
729 container_of(definition
, struct definition_struct
, p
);
730 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
732 if (stream_class
->event_context_decl
) {
733 struct definition
*definition
=
734 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
735 stream
->parent_def_scope
, 0, 0, "stream.event.context");
740 stream
->stream_event_context
=
741 container_of(definition
, struct definition_struct
, p
);
742 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
744 stream
->events_by_id
= g_ptr_array_new();
745 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
746 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
747 struct ctf_event
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
748 struct ctf_stream_event
*stream_event
;
752 stream_event
= create_event_definitions(td
, stream
, event
);
755 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
760 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
761 struct ctf_stream_event
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
763 g_free(stream_event
);
765 g_ptr_array_free(stream
->events_by_id
, TRUE
);
767 if (stream
->stream_event_context
)
768 definition_unref(&stream
->stream_event_context
->p
);
769 if (stream
->stream_event_header
)
770 definition_unref(&stream
->stream_event_header
->p
);
771 if (stream
->stream_packet_context
)
772 definition_unref(&stream
->stream_packet_context
->p
);
778 int create_stream_packet_index(struct ctf_trace
*td
,
779 struct ctf_file_stream
*file_stream
)
781 struct ctf_stream_class
*stream
;
783 struct ctf_stream_pos
*pos
;
784 struct stat filestats
;
785 struct packet_index packet_index
;
786 int first_packet
= 1;
789 pos
= &file_stream
->pos
;
791 ret
= fstat(pos
->fd
, &filestats
);
795 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
798 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
799 uint64_t stream_id
= 0;
803 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
805 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
811 /* map new base. Need mapping length from header. */
812 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
813 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
814 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
815 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
816 pos
->offset
= 0; /* Position of the packet header */
818 packet_index
.offset
= pos
->mmap_offset
;
819 packet_index
.content_size
= 0;
820 packet_index
.packet_size
= 0;
821 packet_index
.timestamp_begin
= 0;
822 packet_index
.timestamp_end
= 0;
824 /* read and check header, set stream id (and check) */
825 if (file_stream
->parent
.trace_packet_header
) {
826 /* Read packet header */
827 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
830 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
831 if (len_index
>= 0) {
832 struct definition_integer
*defint
;
833 struct definition
*field
;
835 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
836 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
837 defint
= container_of(field
, struct definition_integer
, p
);
838 assert(defint
->declaration
->signedness
== FALSE
);
839 if (defint
->value
._unsigned
!= CTF_MAGIC
) {
840 fprintf(stdout
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
841 defint
->value
._unsigned
,
842 file_stream
->pos
.packet_index
->len
,
843 (ssize_t
) pos
->mmap_offset
);
849 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
850 if (len_index
>= 0) {
851 struct definition_array
*defarray
;
852 struct definition
*field
;
854 uint8_t uuidval
[UUID_LEN
];
856 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
857 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
858 defarray
= container_of(field
, struct definition_array
, p
);
859 assert(array_len(defarray
) == UUID_LEN
);
860 assert(defarray
->declaration
->elem
->id
== CTF_TYPE_INTEGER
);
862 for (i
= 0; i
< UUID_LEN
; i
++) {
863 struct definition
*elem
;
864 struct definition_integer
*defint
;
866 elem
= array_index(defarray
, i
);
868 defint
= container_of(elem
, struct definition_integer
, p
);
869 uuidval
[i
] = defint
->value
._unsigned
;
871 ret
= uuid_compare(td
->uuid
, uuidval
);
873 fprintf(stdout
, "[error] Unique Universal Identifiers do not match.\n");
879 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
880 if (len_index
>= 0) {
881 struct definition_integer
*defint
;
882 struct definition
*field
;
884 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
885 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
886 defint
= container_of(field
, struct definition_integer
, p
);
887 assert(defint
->declaration
->signedness
== FALSE
);
888 stream_id
= defint
->value
._unsigned
;
892 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
893 fprintf(stdout
, "[error] Stream ID is changing within a stream.\n");
897 file_stream
->parent
.stream_id
= stream_id
;
898 if (stream_id
>= td
->streams
->len
) {
899 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
902 stream
= g_ptr_array_index(td
->streams
, stream_id
);
904 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
907 file_stream
->parent
.stream_class
= stream
;
911 ret
= create_stream_definitions(td
, &file_stream
->parent
);
915 if (file_stream
->parent
.stream_packet_context
) {
916 /* Read packet context */
917 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
920 /* read content size from header */
921 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
922 if (len_index
>= 0) {
923 struct definition_integer
*defint
;
924 struct definition
*field
;
926 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
927 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
928 defint
= container_of(field
, struct definition_integer
, p
);
929 assert(defint
->declaration
->signedness
== FALSE
);
930 packet_index
.content_size
= defint
->value
._unsigned
;
932 /* Use file size for packet size */
933 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
936 /* read packet size from header */
937 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
938 if (len_index
>= 0) {
939 struct definition_integer
*defint
;
940 struct definition
*field
;
942 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
943 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
944 defint
= container_of(field
, struct definition_integer
, p
);
945 assert(defint
->declaration
->signedness
== FALSE
);
946 packet_index
.packet_size
= defint
->value
._unsigned
;
948 /* Use content size if non-zero, else file size */
949 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
952 /* read timestamp begin from header */
953 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
954 if (len_index
>= 0) {
955 struct definition_integer
*defint
;
956 struct definition
*field
;
958 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
959 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
960 defint
= container_of(field
, struct definition_integer
, p
);
961 assert(defint
->declaration
->signedness
== FALSE
);
962 packet_index
.timestamp_begin
= defint
->value
._unsigned
;
965 /* read timestamp end from header */
966 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
967 if (len_index
>= 0) {
968 struct definition_integer
*defint
;
969 struct definition
*field
;
971 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
972 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
973 defint
= container_of(field
, struct definition_integer
, p
);
974 assert(defint
->declaration
->signedness
== FALSE
);
975 packet_index
.timestamp_end
= defint
->value
._unsigned
;
978 /* Use file size for packet size */
979 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
980 /* Use content size if non-zero, else file size */
981 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
984 /* Validate content size and packet size values */
985 if (packet_index
.content_size
> packet_index
.packet_size
) {
986 fprintf(stdout
, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
987 packet_index
.content_size
, packet_index
.packet_size
);
991 if (packet_index
.packet_size
> (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
992 fprintf(stdout
, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
993 packet_index
.content_size
, (size_t) (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
997 /* Save position after header and context */
998 packet_index
.data_offset
= pos
->offset
;
1000 /* add index to packet array */
1001 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1003 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1006 /* Move pos back to beginning of file */
1007 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
1013 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
1017 if (td
->packet_header_decl
) {
1018 struct definition
*definition
=
1019 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1020 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1025 stream
->trace_packet_header
=
1026 container_of(definition
, struct definition_struct
, p
);
1027 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1037 * Note: many file streams can inherit from the same stream class
1038 * description (metadata).
1041 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
)
1044 struct ctf_file_stream
*file_stream
;
1046 ret
= openat(td
->dirfd
, path
, flags
);
1049 file_stream
= g_new0(struct ctf_file_stream
, 1);
1050 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
1051 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1054 ret
= create_stream_packet_index(td
, file_stream
);
1057 /* Add stream file to stream class */
1058 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1059 &file_stream
->parent
);
1063 if (file_stream
->parent
.trace_packet_header
)
1064 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1066 ctf_fini_pos(&file_stream
->pos
);
1067 close(file_stream
->pos
.fd
);
1068 g_free(file_stream
);
1074 int ctf_open_trace_read(struct ctf_trace
*td
, const char *path
, int flags
)
1077 struct dirent
*dirent
;
1078 struct dirent
*diriter
;
1083 /* Open trace directory */
1084 td
->dir
= opendir(path
);
1086 fprintf(stdout
, "[error] Unable to open trace directory.\n");
1091 td
->dirfd
= open(path
, 0);
1092 if (td
->dirfd
< 0) {
1093 fprintf(stdout
, "[error] Unable to open trace directory file descriptor.\n");
1099 * Keep the metadata file separate.
1102 ret
= ctf_open_trace_metadata_read(td
);
1104 goto error_metadata
;
1108 * Open each stream: for each file, try to open, check magic
1109 * number, and get the stream ID to add to the right location in
1113 dirent_len
= offsetof(struct dirent
, d_name
) +
1114 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1116 dirent
= malloc(dirent_len
);
1119 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1121 fprintf(stdout
, "[error] Readdir error.\n");
1126 /* Ignore hidden files, ., .. and metadata. */
1127 if (!strncmp(diriter
->d_name
, ".", 1)
1128 || !strcmp(diriter
->d_name
, "..")
1129 || !strcmp(diriter
->d_name
, "metadata"))
1131 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
, flags
);
1133 fprintf(stdout
, "[error] Open file stream error.\n");
1152 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
)
1154 struct ctf_trace
*td
;
1157 td
= g_new0(struct ctf_trace
, 1);
1159 switch (flags
& O_ACCMODE
) {
1162 fprintf(stdout
, "[error] Path missing for input CTF trace.\n");
1165 ret
= ctf_open_trace_read(td
, path
, flags
);
1170 fprintf(stdout
, "[error] Opening CTF traces for output is not supported yet.\n");
1173 fprintf(stdout
, "[error] Incorrect open flags.\n");
1184 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1186 ctf_fini_pos(&file_stream
->pos
);
1187 close(file_stream
->pos
.fd
);
1191 void ctf_close_trace(struct trace_descriptor
*tdp
)
1193 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1197 for (i
= 0; i
< td
->streams
->len
; i
++) {
1198 struct ctf_stream_class
*stream
;
1201 stream
= g_ptr_array_index(td
->streams
, i
);
1204 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1205 struct ctf_file_stream
*file_stream
;
1206 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
), struct ctf_file_stream
, parent
);
1207 ctf_close_file_stream(file_stream
);
1211 g_ptr_array_free(td
->streams
, TRUE
);
1217 void __attribute__((constructor
)) ctf_init(void)
1221 ctf_format
.name
= g_quark_from_static_string("ctf");
1222 ret
= bt_register_format(&ctf_format
);
1226 /* TODO: finalize */