2 * BabelTrace - Common Trace Format (CTF)
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
21 #include <babeltrace/format.h>
22 #include <babeltrace/ctf/types.h>
23 #include <babeltrace/ctf/metadata.h>
24 #include <babeltrace/babeltrace-internal.h>
27 #include <uuid/uuid.h>
31 #include <sys/types.h>
39 #include "metadata/ctf-scanner.h"
40 #include "metadata/ctf-parser.h"
41 #include "metadata/ctf-ast.h"
44 * We currently simply map a page to read the packet header and packet
45 * context to get the packet length and content length. (in bits)
47 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
48 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
49 #define UUID_LEN 16 /* uuid by value len */
52 #define min(a, b) (((a) < (b)) ? (a) : (b))
58 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
59 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
60 int whence
), FILE *metadata_fp
);
62 void ctf_close_trace(struct trace_descriptor
*descriptor
);
65 rw_dispatch read_dispatch_table
[] = {
66 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
67 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
68 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
69 [ CTF_TYPE_STRING
] = ctf_string_read
,
70 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
71 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
72 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
73 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
77 rw_dispatch write_dispatch_table
[] = {
78 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
79 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
80 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
81 [ CTF_TYPE_STRING
] = ctf_string_write
,
82 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
83 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
84 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
85 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
89 struct format ctf_format
= {
90 .open_trace
= ctf_open_trace
,
91 .close_trace
= ctf_close_trace
,
95 void ctf_update_timestamp(struct ctf_stream
*stream
,
96 struct definition_integer
*integer_definition
)
98 struct declaration_integer
*integer_declaration
=
99 integer_definition
->declaration
;
100 uint64_t oldval
, newval
, updateval
;
102 if (unlikely(integer_declaration
->len
== 64)) {
103 stream
->timestamp
= integer_definition
->value
._unsigned
;
107 oldval
= stream
->timestamp
;
108 oldval
&= (1ULL << integer_declaration
->len
) - 1;
109 newval
= integer_definition
->value
._unsigned
;
110 /* Test for overflow by comparing low bits */
112 newval
+= 1ULL << integer_declaration
->len
;
113 /* updateval contains old high bits, and new low bits (sum) */
114 updateval
= stream
->timestamp
;
115 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
117 stream
->timestamp
= updateval
;
121 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
123 struct ctf_stream_pos
*pos
=
124 container_of(ppos
, struct ctf_stream_pos
, parent
);
125 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
126 struct ctf_stream_event
*event
;
130 ctf_pos_get_event(pos
);
132 if (unlikely(pos
->offset
== EOF
))
134 assert(pos
->offset
< pos
->content_size
);
136 /* Read event header */
137 if (likely(stream
->stream_event_header
)) {
138 struct definition_integer
*integer_definition
;
139 struct definition
*variant
;
141 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
144 /* lookup event id */
145 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
146 if (integer_definition
) {
147 id
= integer_definition
->value
._unsigned
;
149 struct definition_enum
*enum_definition
;
151 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
152 if (enum_definition
) {
153 id
= enum_definition
->integer
->value
._unsigned
;
157 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
159 integer_definition
= lookup_integer(variant
, "id", FALSE
);
160 if (integer_definition
) {
161 id
= integer_definition
->value
._unsigned
;
164 stream
->event_id
= id
;
166 /* lookup timestamp */
167 stream
->has_timestamp
= 0;
168 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
169 if (integer_definition
) {
170 ctf_update_timestamp(stream
, integer_definition
);
171 stream
->has_timestamp
= 1;
174 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
175 if (integer_definition
) {
176 ctf_update_timestamp(stream
, integer_definition
);
177 stream
->has_timestamp
= 1;
183 /* Read stream-declared event context */
184 if (stream
->stream_event_context
) {
185 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
190 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
191 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
194 event
= g_ptr_array_index(stream
->events_by_id
, id
);
195 if (unlikely(!event
)) {
196 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
200 /* Read event-declared event context */
201 if (event
->event_context
) {
202 ret
= generic_rw(ppos
, &event
->event_context
->p
);
207 /* Read event payload */
208 if (likely(event
->event_fields
)) {
209 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
217 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
222 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
224 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
225 struct ctf_stream_event
*event
;
229 id
= stream
->event_id
;
231 /* print event header */
232 if (likely(stream
->stream_event_header
)) {
233 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
238 /* print stream-declared event context */
239 if (stream
->stream_event_context
) {
240 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
245 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
246 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
249 event
= g_ptr_array_index(stream
->events_by_id
, id
);
250 if (unlikely(!event
)) {
251 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
255 /* print event-declared event context */
256 if (event
->event_context
) {
257 ret
= generic_rw(pos
, &event
->event_context
->p
);
262 /* Read and print event payload */
263 if (likely(event
->event_fields
)) {
264 ret
= generic_rw(pos
, &event
->event_fields
->p
);
272 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
276 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
279 pos
->mmap_offset
= 0;
280 pos
->packet_size
= 0;
281 pos
->content_size
= 0;
282 pos
->content_size_loc
= NULL
;
288 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
289 sizeof(struct packet_index
));
291 pos
->packet_index
= NULL
;
292 switch (open_flags
& O_ACCMODE
) {
294 pos
->prot
= PROT_READ
;
295 pos
->flags
= MAP_PRIVATE
;
296 pos
->parent
.rw_table
= read_dispatch_table
;
297 pos
->parent
.event_cb
= ctf_read_event
;
300 pos
->prot
= PROT_WRITE
; /* Write has priority */
301 pos
->flags
= MAP_SHARED
;
302 pos
->parent
.rw_table
= write_dispatch_table
;
303 pos
->parent
.event_cb
= ctf_write_event
;
305 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
312 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
316 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
317 *pos
->content_size_loc
= pos
->offset
;
320 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
322 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
327 (void) g_array_free(pos
->packet_index
, TRUE
);
330 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
)
332 struct ctf_file_stream
*file_stream
=
333 container_of(pos
, struct ctf_file_stream
, pos
);
336 struct packet_index
*index
;
338 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
339 *pos
->content_size_loc
= pos
->offset
;
343 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
345 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
353 * The caller should never ask for ctf_move_pos across packets,
354 * except to get exactly at the beginning of the next packet.
356 if (pos
->prot
== PROT_WRITE
) {
359 /* The writer will add padding */
360 assert(pos
->offset
+ offset
== pos
->packet_size
);
361 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
364 assert(offset
== 0); /* only seek supported for now */
370 pos
->content_size
= -1U; /* Unknown at this point */
371 pos
->packet_size
= WRITE_PACKET_LEN
;
372 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
373 pos
->packet_size
/ CHAR_BIT
);
380 if (pos
->offset
== EOF
)
382 /* The reader will expect us to skip padding */
383 assert(pos
->offset
+ offset
== pos
->content_size
);
387 assert(offset
== 0); /* only seek supported for now */
393 if (pos
->cur_index
>= pos
->packet_index
->len
) {
397 index
= &g_array_index(pos
->packet_index
, struct packet_index
,
399 pos
->mmap_offset
= index
->offset
;
401 /* Lookup context/packet size in index */
402 file_stream
->parent
.timestamp
= index
->timestamp_begin
;
403 pos
->content_size
= index
->content_size
;
404 pos
->packet_size
= index
->packet_size
;
405 if (index
->data_offset
< index
->content_size
) {
406 pos
->offset
= 0; /* will read headers */
407 } else if (index
->data_offset
== index
->content_size
) {
409 pos
->offset
= index
->data_offset
;
411 goto read_next_packet
;
417 /* map new base. Need mapping length from header. */
418 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
419 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
420 if (pos
->base
== MAP_FAILED
) {
421 fprintf(stdout
, "[error] mmap error %s.\n",
426 /* update trace_packet_header and stream_packet_context */
427 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
428 /* Read packet header */
429 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
432 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
433 /* Read packet context */
434 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
440 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
446 len
= fread(&magic
, sizeof(magic
), 1, fp
);
450 if (magic
== TSDL_MAGIC
) {
452 td
->byte_order
= BYTE_ORDER
;
453 CTF_TRACE_SET_FIELD(td
, byte_order
);
454 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
456 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
457 LITTLE_ENDIAN
: BIG_ENDIAN
;
458 CTF_TRACE_SET_FIELD(td
, byte_order
);
466 * Returns 0 on success, -1 on error.
469 int check_version(unsigned int major
, unsigned int minor
)
484 /* eventually return an error instead of warning */
486 fprintf(stdout
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
492 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
495 struct metadata_packet_header header
;
496 size_t readlen
, writelen
, toread
;
497 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
500 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
504 if (td
->byte_order
!= BYTE_ORDER
) {
505 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
506 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
507 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
508 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
511 fprintf(stdout
, "[warning] checksum verification not supported yet.\n");
512 if (header
.compression_scheme
) {
513 fprintf(stdout
, "[error] compression (%u) not supported yet.\n",
514 header
.compression_scheme
);
517 if (header
.encryption_scheme
) {
518 fprintf(stdout
, "[error] encryption (%u) not supported yet.\n",
519 header
.encryption_scheme
);
522 if (header
.checksum_scheme
) {
523 fprintf(stdout
, "[error] checksum (%u) not supported yet.\n",
524 header
.checksum_scheme
);
527 if (check_version(header
.major
, header
.minor
) < 0)
529 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
530 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
531 CTF_TRACE_SET_FIELD(td
, uuid
);
533 if (uuid_compare(header
.uuid
, td
->uuid
))
537 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
540 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
545 if (babeltrace_debug
) {
547 fprintf(stdout
, "[debug] metadata packet read: %s\n",
551 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
552 if (writelen
< readlen
) {
562 ret
= 0; /* continue reading next packet */
569 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
570 ret
= fseek(in
, toread
, SEEK_CUR
);
572 fprintf(stdout
, "[warning] Missing padding at end of file\n");
579 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
588 * Using strlen on *buf instead of size of open_memstream
589 * because its size includes garbage at the end (after final
590 * \0). This is the allocated size, not the actual string size.
592 out
= open_memstream(buf
, &size
);
597 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
606 fclose(out
); /* flush the buffer */
608 /* open for reading */
609 *fp
= fmemopen(*buf
, strlen(*buf
), "rb");
614 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
615 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
616 int whence
), FILE *metadata_fp
)
618 struct ctf_scanner
*scanner
;
619 struct ctf_file_stream
*metadata_stream
;
624 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
627 metadata_stream
->pos
.move_pos_slow
= move_pos_slow
;
629 fprintf(stderr
, "[error] move_pos_slow function undefined.\n");
637 td
->metadata
= &metadata_stream
->parent
;
638 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
639 if (metadata_stream
->pos
.fd
< 0) {
640 fprintf(stdout
, "Unable to open metadata.\n");
641 return metadata_stream
->pos
.fd
;
644 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
646 fprintf(stdout
, "[error] Unable to open metadata stream.\n");
651 if (babeltrace_debug
)
654 if (packet_metadata(td
, fp
)) {
655 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
657 goto end_packet_read
;
659 unsigned int major
, minor
;
662 td
->byte_order
= BYTE_ORDER
;
664 /* Check text-only metadata header and version */
665 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
667 fprintf(stdout
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
668 if (check_version(major
, minor
) < 0) {
670 goto end_packet_read
;
675 scanner
= ctf_scanner_alloc(fp
);
677 fprintf(stdout
, "[error] Error allocating scanner\n");
679 goto end_scanner_alloc
;
681 ret
= ctf_scanner_append_ast(scanner
);
683 fprintf(stdout
, "[error] Error creating AST\n");
687 if (babeltrace_debug
) {
688 ret
= ctf_visitor_print_xml(stdout
, 0, &scanner
->ast
->root
);
690 fprintf(stdout
, "[error] Error visiting AST for XML output\n");
695 ret
= ctf_visitor_semantic_check(stdout
, 0, &scanner
->ast
->root
);
697 fprintf(stdout
, "[error] Error in CTF semantic validation %d\n", ret
);
700 ret
= ctf_visitor_construct_metadata(stdout
, 0, &scanner
->ast
->root
,
703 fprintf(stdout
, "[error] Error in CTF metadata constructor %d\n", ret
);
707 ctf_scanner_free(scanner
);
713 close(metadata_stream
->pos
.fd
);
715 g_free(metadata_stream
);
720 struct ctf_stream_event
*create_event_definitions(struct ctf_trace
*td
,
721 struct ctf_stream
*stream
,
722 struct ctf_event
*event
)
724 struct ctf_stream_event
*stream_event
= g_new0(struct ctf_stream_event
, 1);
726 if (event
->context_decl
) {
727 struct definition
*definition
=
728 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
729 stream
->parent_def_scope
, 0, 0, "event.context");
733 stream_event
->event_context
= container_of(definition
,
734 struct definition_struct
, p
);
735 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
737 if (event
->fields_decl
) {
738 struct definition
*definition
=
739 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
740 stream
->parent_def_scope
, 0, 0, "event.fields");
744 stream_event
->event_fields
= container_of(definition
,
745 struct definition_struct
, p
);
746 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
751 if (stream_event
->event_fields
)
752 definition_unref(&stream_event
->event_fields
->p
);
753 if (stream_event
->event_context
)
754 definition_unref(&stream_event
->event_context
->p
);
759 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
761 struct ctf_stream_class
*stream_class
;
765 if (stream
->stream_definitions_created
)
768 stream_class
= stream
->stream_class
;
770 if (stream_class
->packet_context_decl
) {
771 struct definition
*definition
=
772 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
773 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
778 stream
->stream_packet_context
= container_of(definition
,
779 struct definition_struct
, p
);
780 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
782 if (stream_class
->event_header_decl
) {
783 struct definition
*definition
=
784 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
785 stream
->parent_def_scope
, 0, 0, "stream.event.header");
790 stream
->stream_event_header
=
791 container_of(definition
, struct definition_struct
, p
);
792 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
794 if (stream_class
->event_context_decl
) {
795 struct definition
*definition
=
796 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
797 stream
->parent_def_scope
, 0, 0, "stream.event.context");
802 stream
->stream_event_context
=
803 container_of(definition
, struct definition_struct
, p
);
804 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
806 stream
->events_by_id
= g_ptr_array_new();
807 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
808 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
809 struct ctf_event
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
810 struct ctf_stream_event
*stream_event
;
814 stream_event
= create_event_definitions(td
, stream
, event
);
817 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
822 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
823 struct ctf_stream_event
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
825 g_free(stream_event
);
827 g_ptr_array_free(stream
->events_by_id
, TRUE
);
829 if (stream
->stream_event_context
)
830 definition_unref(&stream
->stream_event_context
->p
);
831 if (stream
->stream_event_header
)
832 definition_unref(&stream
->stream_event_header
->p
);
833 if (stream
->stream_packet_context
)
834 definition_unref(&stream
->stream_packet_context
->p
);
840 int create_stream_packet_index(struct ctf_trace
*td
,
841 struct ctf_file_stream
*file_stream
)
843 struct ctf_stream_class
*stream
;
845 struct ctf_stream_pos
*pos
;
846 struct stat filestats
;
847 struct packet_index packet_index
;
848 int first_packet
= 1;
851 pos
= &file_stream
->pos
;
853 ret
= fstat(pos
->fd
, &filestats
);
857 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
860 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
861 uint64_t stream_id
= 0;
865 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
867 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
873 /* map new base. Need mapping length from header. */
874 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
875 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
876 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
877 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
878 pos
->offset
= 0; /* Position of the packet header */
880 packet_index
.offset
= pos
->mmap_offset
;
881 packet_index
.content_size
= 0;
882 packet_index
.packet_size
= 0;
883 packet_index
.timestamp_begin
= 0;
884 packet_index
.timestamp_end
= 0;
886 /* read and check header, set stream id (and check) */
887 if (file_stream
->parent
.trace_packet_header
) {
888 /* Read packet header */
889 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
892 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
893 if (len_index
>= 0) {
894 struct definition_integer
*defint
;
895 struct definition
*field
;
897 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
898 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
899 defint
= container_of(field
, struct definition_integer
, p
);
900 assert(defint
->declaration
->signedness
== FALSE
);
901 if (defint
->value
._unsigned
!= CTF_MAGIC
) {
902 fprintf(stdout
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
903 defint
->value
._unsigned
,
904 file_stream
->pos
.packet_index
->len
,
905 (ssize_t
) pos
->mmap_offset
);
911 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
912 if (len_index
>= 0) {
913 struct definition_array
*defarray
;
914 struct definition
*field
;
916 uint8_t uuidval
[UUID_LEN
];
918 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
919 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
920 defarray
= container_of(field
, struct definition_array
, p
);
921 assert(array_len(defarray
) == UUID_LEN
);
922 assert(defarray
->declaration
->elem
->id
== CTF_TYPE_INTEGER
);
924 for (i
= 0; i
< UUID_LEN
; i
++) {
925 struct definition
*elem
;
926 struct definition_integer
*defint
;
928 elem
= array_index(defarray
, i
);
930 defint
= container_of(elem
, struct definition_integer
, p
);
931 uuidval
[i
] = defint
->value
._unsigned
;
933 ret
= uuid_compare(td
->uuid
, uuidval
);
935 fprintf(stdout
, "[error] Unique Universal Identifiers do not match.\n");
941 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
942 if (len_index
>= 0) {
943 struct definition_integer
*defint
;
944 struct definition
*field
;
946 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
947 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
948 defint
= container_of(field
, struct definition_integer
, p
);
949 assert(defint
->declaration
->signedness
== FALSE
);
950 stream_id
= defint
->value
._unsigned
;
954 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
955 fprintf(stdout
, "[error] Stream ID is changing within a stream.\n");
959 file_stream
->parent
.stream_id
= stream_id
;
960 if (stream_id
>= td
->streams
->len
) {
961 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
964 stream
= g_ptr_array_index(td
->streams
, stream_id
);
966 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
969 file_stream
->parent
.stream_class
= stream
;
970 ret
= create_stream_definitions(td
, &file_stream
->parent
);
976 if (file_stream
->parent
.stream_packet_context
) {
977 /* Read packet context */
978 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
981 /* read content size from header */
982 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
983 if (len_index
>= 0) {
984 struct definition_integer
*defint
;
985 struct definition
*field
;
987 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
988 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
989 defint
= container_of(field
, struct definition_integer
, p
);
990 assert(defint
->declaration
->signedness
== FALSE
);
991 packet_index
.content_size
= defint
->value
._unsigned
;
993 /* Use file size for packet size */
994 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
997 /* read packet size from header */
998 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
999 if (len_index
>= 0) {
1000 struct definition_integer
*defint
;
1001 struct definition
*field
;
1003 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1004 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
1005 defint
= container_of(field
, struct definition_integer
, p
);
1006 assert(defint
->declaration
->signedness
== FALSE
);
1007 packet_index
.packet_size
= defint
->value
._unsigned
;
1009 /* Use content size if non-zero, else file size */
1010 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1013 /* read timestamp begin from header */
1014 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1015 if (len_index
>= 0) {
1016 struct definition_integer
*defint
;
1017 struct definition
*field
;
1019 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1020 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
1021 defint
= container_of(field
, struct definition_integer
, p
);
1022 assert(defint
->declaration
->signedness
== FALSE
);
1023 packet_index
.timestamp_begin
= defint
->value
._unsigned
;
1026 /* read timestamp end from header */
1027 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1028 if (len_index
>= 0) {
1029 struct definition_integer
*defint
;
1030 struct definition
*field
;
1032 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1033 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
1034 defint
= container_of(field
, struct definition_integer
, p
);
1035 assert(defint
->declaration
->signedness
== FALSE
);
1036 packet_index
.timestamp_end
= defint
->value
._unsigned
;
1039 /* Use file size for packet size */
1040 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1041 /* Use content size if non-zero, else file size */
1042 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1045 /* Validate content size and packet size values */
1046 if (packet_index
.content_size
> packet_index
.packet_size
) {
1047 fprintf(stdout
, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
1048 packet_index
.content_size
, packet_index
.packet_size
);
1052 if (packet_index
.packet_size
> (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
1053 fprintf(stdout
, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
1054 packet_index
.content_size
, (size_t) (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
1058 /* Save position after header and context */
1059 packet_index
.data_offset
= pos
->offset
;
1061 /* add index to packet array */
1062 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1064 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1067 /* Move pos back to beginning of file */
1068 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
1074 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
1078 if (td
->packet_header_decl
) {
1079 struct definition
*definition
=
1080 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1081 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1086 stream
->trace_packet_header
=
1087 container_of(definition
, struct definition_struct
, p
);
1088 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1098 * Note: many file streams can inherit from the same stream class
1099 * description (metadata).
1102 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1103 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1107 struct ctf_file_stream
*file_stream
;
1109 ret
= openat(td
->dirfd
, path
, flags
);
1112 file_stream
= g_new0(struct ctf_file_stream
, 1);
1114 if (move_pos_slow
) {
1115 file_stream
->pos
.move_pos_slow
= move_pos_slow
;
1117 fprintf(stderr
, "[error] move_pos_slow function undefined.\n");
1122 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
1123 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1126 ret
= create_stream_packet_index(td
, file_stream
);
1129 /* Add stream file to stream class */
1130 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1131 &file_stream
->parent
);
1135 if (file_stream
->parent
.trace_packet_header
)
1136 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1138 ctf_fini_pos(&file_stream
->pos
);
1139 close(file_stream
->pos
.fd
);
1140 g_free(file_stream
);
1146 int ctf_open_trace_read(struct ctf_trace
*td
, const char *path
, int flags
,
1147 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1148 int whence
), FILE *metadata_fp
)
1151 struct dirent
*dirent
;
1152 struct dirent
*diriter
;
1157 /* Open trace directory */
1158 td
->dir
= opendir(path
);
1160 fprintf(stdout
, "[error] Unable to open trace directory.\n");
1165 td
->dirfd
= open(path
, 0);
1166 if (td
->dirfd
< 0) {
1167 fprintf(stdout
, "[error] Unable to open trace directory file descriptor.\n");
1173 * Keep the metadata file separate.
1176 ret
= ctf_open_trace_metadata_read(td
, move_pos_slow
, metadata_fp
);
1178 goto error_metadata
;
1182 * Open each stream: for each file, try to open, check magic
1183 * number, and get the stream ID to add to the right location in
1187 dirent_len
= offsetof(struct dirent
, d_name
) +
1188 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1190 dirent
= malloc(dirent_len
);
1193 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1195 fprintf(stdout
, "[error] Readdir error.\n");
1200 /* Ignore hidden files, ., .. and metadata. */
1201 if (!strncmp(diriter
->d_name
, ".", 1)
1202 || !strcmp(diriter
->d_name
, "..")
1203 || !strcmp(diriter
->d_name
, "metadata"))
1205 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
, flags
, move_pos_slow
);
1207 fprintf(stdout
, "[error] Open file stream error.\n");
1226 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1227 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1228 int whence
), FILE *metadata_fp
)
1230 struct ctf_trace
*td
;
1233 td
= g_new0(struct ctf_trace
, 1);
1235 switch (flags
& O_ACCMODE
) {
1238 fprintf(stdout
, "[error] Path missing for input CTF trace.\n");
1241 ret
= ctf_open_trace_read(td
, path
, flags
, move_pos_slow
, metadata_fp
);
1246 fprintf(stdout
, "[error] Opening CTF traces for output is not supported yet.\n");
1249 fprintf(stdout
, "[error] Incorrect open flags.\n");
1260 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1262 ctf_fini_pos(&file_stream
->pos
);
1263 close(file_stream
->pos
.fd
);
1267 void ctf_close_trace(struct trace_descriptor
*tdp
)
1269 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1273 for (i
= 0; i
< td
->streams
->len
; i
++) {
1274 struct ctf_stream_class
*stream
;
1277 stream
= g_ptr_array_index(td
->streams
, i
);
1280 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1281 struct ctf_file_stream
*file_stream
;
1282 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
), struct ctf_file_stream
, parent
);
1283 ctf_close_file_stream(file_stream
);
1287 g_ptr_array_free(td
->streams
, TRUE
);
1293 void __attribute__((constructor
)) ctf_init(void)
1297 ctf_format
.name
= g_quark_from_static_string("ctf");
1298 ret
= bt_register_format(&ctf_format
);
1302 /* TODO: finalize */