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 *collection_path
, 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 struct trace_descriptor
*ctf_open_mmap_trace(
63 struct mmap_stream_list
*mmap_list
,
64 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
, int whence
),
68 void ctf_close_trace(struct trace_descriptor
*descriptor
);
71 rw_dispatch read_dispatch_table
[] = {
72 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
73 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
74 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
75 [ CTF_TYPE_STRING
] = ctf_string_read
,
76 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
77 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
78 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
79 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
83 rw_dispatch write_dispatch_table
[] = {
84 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
85 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
86 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
87 [ CTF_TYPE_STRING
] = ctf_string_write
,
88 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
89 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
90 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
91 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
95 struct format ctf_format
= {
96 .open_trace
= ctf_open_trace
,
97 .open_mmap_trace
= ctf_open_mmap_trace
,
98 .close_trace
= ctf_close_trace
,
102 void ctf_update_timestamp(struct ctf_stream
*stream
,
103 struct definition_integer
*integer_definition
)
105 struct declaration_integer
*integer_declaration
=
106 integer_definition
->declaration
;
107 uint64_t oldval
, newval
, updateval
;
109 if (unlikely(integer_declaration
->len
== 64)) {
110 stream
->timestamp
= integer_definition
->value
._unsigned
;
114 oldval
= stream
->timestamp
;
115 oldval
&= (1ULL << integer_declaration
->len
) - 1;
116 newval
= integer_definition
->value
._unsigned
;
117 /* Test for overflow by comparing low bits */
119 newval
+= 1ULL << integer_declaration
->len
;
120 /* updateval contains old high bits, and new low bits (sum) */
121 updateval
= stream
->timestamp
;
122 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
124 stream
->timestamp
= updateval
;
128 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
130 struct ctf_stream_pos
*pos
=
131 container_of(ppos
, struct ctf_stream_pos
, parent
);
132 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
133 struct ctf_stream_event
*event
;
137 /* We need to check for EOF here for empty files. */
138 if (unlikely(pos
->offset
== EOF
))
141 ctf_pos_get_event(pos
);
144 * This is the EOF check after we've advanced the position in
147 if (unlikely(pos
->offset
== EOF
))
149 assert(pos
->offset
< pos
->content_size
);
151 /* Read event header */
152 if (likely(stream
->stream_event_header
)) {
153 struct definition_integer
*integer_definition
;
154 struct definition
*variant
;
156 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
159 /* lookup event id */
160 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
161 if (integer_definition
) {
162 id
= integer_definition
->value
._unsigned
;
164 struct definition_enum
*enum_definition
;
166 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
167 if (enum_definition
) {
168 id
= enum_definition
->integer
->value
._unsigned
;
172 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
174 integer_definition
= lookup_integer(variant
, "id", FALSE
);
175 if (integer_definition
) {
176 id
= integer_definition
->value
._unsigned
;
179 stream
->event_id
= id
;
181 /* lookup timestamp */
182 stream
->has_timestamp
= 0;
183 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
184 if (integer_definition
) {
185 ctf_update_timestamp(stream
, integer_definition
);
186 stream
->has_timestamp
= 1;
189 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
190 if (integer_definition
) {
191 ctf_update_timestamp(stream
, integer_definition
);
192 stream
->has_timestamp
= 1;
198 /* Read stream-declared event context */
199 if (stream
->stream_event_context
) {
200 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
205 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
206 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
209 event
= g_ptr_array_index(stream
->events_by_id
, id
);
210 if (unlikely(!event
)) {
211 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
215 /* Read event-declared event context */
216 if (event
->event_context
) {
217 ret
= generic_rw(ppos
, &event
->event_context
->p
);
222 /* Read event payload */
223 if (likely(event
->event_fields
)) {
224 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
232 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
237 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
239 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
240 struct ctf_stream_event
*event
;
244 id
= stream
->event_id
;
246 /* print event header */
247 if (likely(stream
->stream_event_header
)) {
248 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
253 /* print stream-declared event context */
254 if (stream
->stream_event_context
) {
255 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
260 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
261 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
264 event
= g_ptr_array_index(stream
->events_by_id
, id
);
265 if (unlikely(!event
)) {
266 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
270 /* print event-declared event context */
271 if (event
->event_context
) {
272 ret
= generic_rw(pos
, &event
->event_context
->p
);
277 /* Read and print event payload */
278 if (likely(event
->event_fields
)) {
279 ret
= generic_rw(pos
, &event
->event_fields
->p
);
287 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
291 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
294 pos
->mmap_offset
= 0;
295 pos
->packet_size
= 0;
296 pos
->content_size
= 0;
297 pos
->content_size_loc
= NULL
;
303 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
304 sizeof(struct packet_index
));
306 pos
->packet_index
= NULL
;
307 switch (open_flags
& O_ACCMODE
) {
309 pos
->prot
= PROT_READ
;
310 pos
->flags
= MAP_PRIVATE
;
311 pos
->parent
.rw_table
= read_dispatch_table
;
312 pos
->parent
.event_cb
= ctf_read_event
;
315 pos
->prot
= PROT_WRITE
; /* Write has priority */
316 pos
->flags
= MAP_SHARED
;
317 pos
->parent
.rw_table
= write_dispatch_table
;
318 pos
->parent
.event_cb
= ctf_write_event
;
320 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
327 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
331 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
332 *pos
->content_size_loc
= pos
->offset
;
335 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
337 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
342 (void) g_array_free(pos
->packet_index
, TRUE
);
345 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
)
347 struct ctf_file_stream
*file_stream
=
348 container_of(pos
, struct ctf_file_stream
, pos
);
351 struct packet_index
*index
;
353 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
354 *pos
->content_size_loc
= pos
->offset
;
358 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
360 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
368 * The caller should never ask for ctf_move_pos across packets,
369 * except to get exactly at the beginning of the next packet.
371 if (pos
->prot
== PROT_WRITE
) {
374 /* The writer will add padding */
375 assert(pos
->offset
+ offset
== pos
->packet_size
);
376 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
379 assert(offset
== 0); /* only seek supported for now */
385 pos
->content_size
= -1U; /* Unknown at this point */
386 pos
->packet_size
= WRITE_PACKET_LEN
;
387 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
388 pos
->packet_size
/ CHAR_BIT
);
396 uint32_t events_discarded_diff
;
398 /* Print lost event count */
399 index
= &g_array_index(pos
->packet_index
,
400 struct packet_index
, pos
->cur_index
);
401 events_discarded_diff
= index
->events_discarded
;
402 if (pos
->cur_index
> 0) {
403 index
= &g_array_index(pos
->packet_index
,
406 events_discarded_diff
-= index
->events_discarded
;
408 if (events_discarded_diff
!= 0) {
410 fprintf(stderr
, "[warning] %d events discarded by tracer. You should try using larger buffers.\n",
411 events_discarded_diff
);
414 if (pos
->offset
== EOF
)
416 /* The reader will expect us to skip padding */
417 assert(pos
->offset
+ offset
== pos
->content_size
);
422 assert(offset
== 0); /* only seek supported for now */
428 if (pos
->cur_index
>= pos
->packet_index
->len
) {
432 index
= &g_array_index(pos
->packet_index
, struct packet_index
,
434 pos
->mmap_offset
= index
->offset
;
436 /* Lookup context/packet size in index */
437 file_stream
->parent
.timestamp
= index
->timestamp_begin
;
438 pos
->content_size
= index
->content_size
;
439 pos
->packet_size
= index
->packet_size
;
440 if (index
->data_offset
< index
->content_size
) {
441 pos
->offset
= 0; /* will read headers */
442 } else if (index
->data_offset
== index
->content_size
) {
444 pos
->offset
= index
->data_offset
;
447 goto read_next_packet
;
453 /* map new base. Need mapping length from header. */
454 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
455 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
456 if (pos
->base
== MAP_FAILED
) {
457 fprintf(stderr
, "[error] mmap error %s.\n",
462 /* update trace_packet_header and stream_packet_context */
463 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
464 /* Read packet header */
465 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
468 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
469 /* Read packet context */
470 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
476 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
482 len
= fread(&magic
, sizeof(magic
), 1, fp
);
486 if (magic
== TSDL_MAGIC
) {
488 td
->byte_order
= BYTE_ORDER
;
489 CTF_TRACE_SET_FIELD(td
, byte_order
);
490 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
492 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
493 LITTLE_ENDIAN
: BIG_ENDIAN
;
494 CTF_TRACE_SET_FIELD(td
, byte_order
);
502 * Returns 0 on success, -1 on error.
505 int check_version(unsigned int major
, unsigned int minor
)
520 /* eventually return an error instead of warning */
522 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
528 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
531 struct metadata_packet_header header
;
532 size_t readlen
, writelen
, toread
;
533 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
536 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
540 if (td
->byte_order
!= BYTE_ORDER
) {
541 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
542 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
543 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
544 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
547 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
548 if (header
.compression_scheme
) {
549 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
550 header
.compression_scheme
);
553 if (header
.encryption_scheme
) {
554 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
555 header
.encryption_scheme
);
558 if (header
.checksum_scheme
) {
559 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
560 header
.checksum_scheme
);
563 if (check_version(header
.major
, header
.minor
) < 0)
565 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
566 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
567 CTF_TRACE_SET_FIELD(td
, uuid
);
569 if (uuid_compare(header
.uuid
, td
->uuid
))
573 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
576 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
581 if (babeltrace_debug
) {
583 fprintf(stderr
, "[debug] metadata packet read: %s\n",
587 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
588 if (writelen
< readlen
) {
598 ret
= 0; /* continue reading next packet */
605 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
606 ret
= fseek(in
, toread
, SEEK_CUR
);
608 fprintf(stderr
, "[warning] Missing padding at end of file\n");
615 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
624 * Using strlen on *buf instead of size of open_memstream
625 * because its size includes garbage at the end (after final
626 * \0). This is the allocated size, not the actual string size.
628 out
= open_memstream(buf
, &size
);
630 perror("Metadata open_memstream");
634 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
643 fclose(out
); /* flush the buffer */
645 /* open for reading */
646 *fp
= fmemopen(*buf
, strlen(*buf
), "rb");
648 perror("Metadata fmemopen");
655 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
656 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
657 int whence
), FILE *metadata_fp
)
659 struct ctf_scanner
*scanner
;
660 struct ctf_file_stream
*metadata_stream
;
665 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
668 metadata_stream
->pos
.move_pos_slow
= move_pos_slow
;
670 fprintf(stderr
, "[error] move_pos_slow function undefined.\n");
678 td
->metadata
= &metadata_stream
->parent
;
679 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
680 if (metadata_stream
->pos
.fd
< 0) {
681 fprintf(stderr
, "Unable to open metadata.\n");
682 return metadata_stream
->pos
.fd
;
685 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
687 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
688 perror("Metadata stream open");
693 if (babeltrace_debug
)
696 if (packet_metadata(td
, fp
)) {
697 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
699 goto end_packet_read
;
701 unsigned int major
, minor
;
704 td
->byte_order
= BYTE_ORDER
;
706 /* Check text-only metadata header and version */
707 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
709 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
710 if (check_version(major
, minor
) < 0) {
712 goto end_packet_read
;
717 scanner
= ctf_scanner_alloc(fp
);
719 fprintf(stderr
, "[error] Error allocating scanner\n");
721 goto end_scanner_alloc
;
723 ret
= ctf_scanner_append_ast(scanner
);
725 fprintf(stderr
, "[error] Error creating AST\n");
729 if (babeltrace_debug
) {
730 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
732 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
737 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
739 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
742 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
745 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
749 ctf_scanner_free(scanner
);
755 close(metadata_stream
->pos
.fd
);
757 g_free(metadata_stream
);
762 struct ctf_stream_event
*create_event_definitions(struct ctf_trace
*td
,
763 struct ctf_stream
*stream
,
764 struct ctf_event
*event
)
766 struct ctf_stream_event
*stream_event
= g_new0(struct ctf_stream_event
, 1);
768 if (event
->context_decl
) {
769 struct definition
*definition
=
770 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
771 stream
->parent_def_scope
, 0, 0, "event.context");
775 stream_event
->event_context
= container_of(definition
,
776 struct definition_struct
, p
);
777 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
779 if (event
->fields_decl
) {
780 struct definition
*definition
=
781 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
782 stream
->parent_def_scope
, 0, 0, "event.fields");
786 stream_event
->event_fields
= container_of(definition
,
787 struct definition_struct
, p
);
788 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
793 if (stream_event
->event_fields
)
794 definition_unref(&stream_event
->event_fields
->p
);
795 if (stream_event
->event_context
)
796 definition_unref(&stream_event
->event_context
->p
);
801 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
803 struct ctf_stream_class
*stream_class
;
807 if (stream
->stream_definitions_created
)
810 stream_class
= stream
->stream_class
;
812 if (stream_class
->packet_context_decl
) {
813 struct definition
*definition
=
814 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
815 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
820 stream
->stream_packet_context
= container_of(definition
,
821 struct definition_struct
, p
);
822 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
824 if (stream_class
->event_header_decl
) {
825 struct definition
*definition
=
826 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
827 stream
->parent_def_scope
, 0, 0, "stream.event.header");
832 stream
->stream_event_header
=
833 container_of(definition
, struct definition_struct
, p
);
834 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
836 if (stream_class
->event_context_decl
) {
837 struct definition
*definition
=
838 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
839 stream
->parent_def_scope
, 0, 0, "stream.event.context");
844 stream
->stream_event_context
=
845 container_of(definition
, struct definition_struct
, p
);
846 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
848 stream
->events_by_id
= g_ptr_array_new();
849 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
850 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
851 struct ctf_event
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
852 struct ctf_stream_event
*stream_event
;
856 stream_event
= create_event_definitions(td
, stream
, event
);
859 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
864 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
865 struct ctf_stream_event
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
867 g_free(stream_event
);
869 g_ptr_array_free(stream
->events_by_id
, TRUE
);
871 if (stream
->stream_event_context
)
872 definition_unref(&stream
->stream_event_context
->p
);
873 if (stream
->stream_event_header
)
874 definition_unref(&stream
->stream_event_header
->p
);
875 if (stream
->stream_packet_context
)
876 definition_unref(&stream
->stream_packet_context
->p
);
882 int create_stream_packet_index(struct ctf_trace
*td
,
883 struct ctf_file_stream
*file_stream
)
885 struct ctf_stream_class
*stream
;
887 struct ctf_stream_pos
*pos
;
888 struct stat filestats
;
889 struct packet_index packet_index
;
890 int first_packet
= 1;
893 pos
= &file_stream
->pos
;
895 ret
= fstat(pos
->fd
, &filestats
);
899 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
902 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
903 uint64_t stream_id
= 0;
907 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
909 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
915 /* map new base. Need mapping length from header. */
916 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
917 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
918 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
919 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
920 pos
->offset
= 0; /* Position of the packet header */
922 packet_index
.offset
= pos
->mmap_offset
;
923 packet_index
.content_size
= 0;
924 packet_index
.packet_size
= 0;
925 packet_index
.timestamp_begin
= 0;
926 packet_index
.timestamp_end
= 0;
927 packet_index
.events_discarded
= 0;
929 /* read and check header, set stream id (and check) */
930 if (file_stream
->parent
.trace_packet_header
) {
931 /* Read packet header */
932 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
935 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
936 if (len_index
>= 0) {
937 struct definition
*field
;
940 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
941 magic
= get_unsigned_int(field
);
942 if (magic
!= CTF_MAGIC
) {
943 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
945 file_stream
->pos
.packet_index
->len
,
946 (ssize_t
) pos
->mmap_offset
);
952 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
953 if (len_index
>= 0) {
954 struct definition_array
*defarray
;
955 struct definition
*field
;
957 uint8_t uuidval
[UUID_LEN
];
959 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
960 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
961 defarray
= container_of(field
, struct definition_array
, p
);
962 assert(array_len(defarray
) == UUID_LEN
);
964 for (i
= 0; i
< UUID_LEN
; i
++) {
965 struct definition
*elem
;
967 elem
= array_index(defarray
, i
);
968 uuidval
[i
] = get_unsigned_int(elem
);
970 ret
= uuid_compare(td
->uuid
, uuidval
);
972 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
978 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
979 if (len_index
>= 0) {
980 struct definition
*field
;
982 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
983 stream_id
= get_unsigned_int(field
);
987 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
988 fprintf(stderr
, "[error] Stream ID is changing within a stream.\n");
992 file_stream
->parent
.stream_id
= stream_id
;
993 if (stream_id
>= td
->streams
->len
) {
994 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
997 stream
= g_ptr_array_index(td
->streams
, stream_id
);
999 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1002 file_stream
->parent
.stream_class
= stream
;
1003 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1009 if (file_stream
->parent
.stream_packet_context
) {
1010 /* Read packet context */
1011 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1014 /* read content size from header */
1015 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1016 if (len_index
>= 0) {
1017 struct definition
*field
;
1019 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1020 packet_index
.content_size
= get_unsigned_int(field
);
1022 /* Use file size for packet size */
1023 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1026 /* read packet size from header */
1027 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1028 if (len_index
>= 0) {
1029 struct definition
*field
;
1031 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1032 packet_index
.packet_size
= get_unsigned_int(field
);
1034 /* Use content size if non-zero, else file size */
1035 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1038 /* read timestamp begin from header */
1039 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1040 if (len_index
>= 0) {
1041 struct definition
*field
;
1043 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1044 packet_index
.timestamp_begin
= get_unsigned_int(field
);
1047 /* read timestamp end from header */
1048 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1049 if (len_index
>= 0) {
1050 struct definition
*field
;
1052 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1053 packet_index
.timestamp_end
= get_unsigned_int(field
);
1056 /* read events discarded from header */
1057 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1058 if (len_index
>= 0) {
1059 struct definition
*field
;
1061 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1062 packet_index
.events_discarded
= get_unsigned_int(field
);
1065 /* Use file size for packet size */
1066 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1067 /* Use content size if non-zero, else file size */
1068 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1071 /* Validate content size and packet size values */
1072 if (packet_index
.content_size
> packet_index
.packet_size
) {
1073 fprintf(stderr
, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
1074 packet_index
.content_size
, packet_index
.packet_size
);
1078 if (packet_index
.packet_size
> (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
1079 fprintf(stderr
, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
1080 packet_index
.content_size
, (size_t) (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
1084 /* Save position after header and context */
1085 packet_index
.data_offset
= pos
->offset
;
1087 /* add index to packet array */
1088 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1090 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1093 /* Move pos back to beginning of file */
1094 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
1100 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
1104 if (td
->packet_header_decl
) {
1105 struct definition
*definition
=
1106 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1107 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1112 stream
->trace_packet_header
=
1113 container_of(definition
, struct definition_struct
, p
);
1114 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1124 * Note: many file streams can inherit from the same stream class
1125 * description (metadata).
1128 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1129 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1133 struct ctf_file_stream
*file_stream
;
1135 ret
= openat(td
->dirfd
, path
, flags
);
1137 perror("File stream openat()");
1140 file_stream
= g_new0(struct ctf_file_stream
, 1);
1142 if (move_pos_slow
) {
1143 file_stream
->pos
.move_pos_slow
= move_pos_slow
;
1145 fprintf(stderr
, "[error] move_pos_slow function undefined.\n");
1150 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
1151 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1154 ret
= create_stream_packet_index(td
, file_stream
);
1157 /* Add stream file to stream class */
1158 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1159 &file_stream
->parent
);
1163 if (file_stream
->parent
.trace_packet_header
)
1164 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1166 ctf_fini_pos(&file_stream
->pos
);
1167 close(file_stream
->pos
.fd
);
1168 g_free(file_stream
);
1174 init_domain_name(struct ctf_trace
*td
)
1178 start
= td
->path
+ strlen(td
->collection_path
);
1179 while (start
[0] == '/')
1180 start
++; /* skip / */
1181 end
= strchr(start
, '/');
1183 end
= start
+ strlen(start
);
1184 memcpy(td
->domain
, start
, end
- start
);
1185 td
->domain
[end
- start
] = '\0';
1189 init_proc_name(struct ctf_trace
*td
)
1194 if (td
->domain
[0] == '\0')
1196 memcpy(buf
, td
->path
, PATH_MAX
);
1197 start
= buf
+ strlen(td
->collection_path
);
1198 while (start
[0] == '/')
1199 start
++; /* skip / */
1200 start
= strchr(start
, '/'); /* get begin of domain content */
1203 while (start
[0] == '/')
1204 start
++; /* skip / */
1205 /* find last -, skips time */
1206 end
= strrchr(start
, '-');
1210 /* find previous -, skips date */
1211 end
= strrchr(start
, '-');
1215 /* find previous -, skips pid */
1216 end
= strrchr(start
, '-');
1221 memcpy(td
->procname
, start
, end
- start
);
1222 td
->procname
[end
- start
] = '\0';
1226 init_vpid(struct ctf_trace
*td
)
1231 if (td
->domain
[0] == '\0')
1233 memcpy(buf
, td
->path
, PATH_MAX
);
1234 start
= buf
+ strlen(td
->collection_path
);
1235 while (start
[0] == '/')
1236 start
++; /* skip / */
1237 start
= strchr(start
, '/'); /* get begin of domain content */
1240 while (start
[0] == '/')
1241 start
++; /* skip / */
1242 /* find last -, skips time */
1243 end
= strrchr(start
, '-');
1247 /* find previous -, skips date */
1248 end
= strrchr(start
, '-');
1252 /* find previous -, skips pid */
1253 start
= strrchr(start
, '-');
1256 start
++; /* skip - */
1258 memcpy(td
->vpid
, start
, end
- start
);
1259 td
->vpid
[end
- start
] = '\0';
1263 int ctf_open_trace_read(struct ctf_trace
*td
, const char *collection_path
,
1264 const char *path
, int flags
,
1265 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1266 int whence
), FILE *metadata_fp
)
1269 struct dirent
*dirent
;
1270 struct dirent
*diriter
;
1272 char *respath
, *rescolpath
;
1276 /* Open trace directory */
1277 td
->dir
= opendir(path
);
1279 fprintf(stderr
, "[error] Unable to open trace directory.\n");
1284 td
->dirfd
= open(path
, 0);
1285 if (td
->dirfd
< 0) {
1286 fprintf(stderr
, "[error] Unable to open trace directory file descriptor.\n");
1287 perror("Trace directory open");
1291 rescolpath
= realpath(collection_path
, td
->collection_path
);
1293 fprintf(stderr
, "[error] collection path resolution failure\n");
1296 respath
= realpath(path
, td
->path
);
1298 fprintf(stderr
, "[error] path resolution failure\n");
1301 init_domain_name(td
);
1306 * Keep the metadata file separate.
1309 ret
= ctf_open_trace_metadata_read(td
, move_pos_slow
, metadata_fp
);
1311 goto error_metadata
;
1315 * Open each stream: for each file, try to open, check magic
1316 * number, and get the stream ID to add to the right location in
1320 dirent_len
= offsetof(struct dirent
, d_name
) +
1321 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1323 dirent
= malloc(dirent_len
);
1326 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1328 fprintf(stderr
, "[error] Readdir error.\n");
1333 /* Ignore hidden files, ., .. and metadata. */
1334 if (!strncmp(diriter
->d_name
, ".", 1)
1335 || !strcmp(diriter
->d_name
, "..")
1336 || !strcmp(diriter
->d_name
, "metadata"))
1338 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
, flags
, move_pos_slow
);
1340 fprintf(stderr
, "[error] Open file stream error.\n");
1359 struct trace_descriptor
*ctf_open_trace(const char *collection_path
, const char *path
, int flags
,
1360 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1361 int whence
), FILE *metadata_fp
)
1363 struct ctf_trace
*td
;
1366 td
= g_new0(struct ctf_trace
, 1);
1368 switch (flags
& O_ACCMODE
) {
1371 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1374 ret
= ctf_open_trace_read(td
, collection_path
, path
, flags
, move_pos_slow
, metadata_fp
);
1379 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1382 fprintf(stderr
, "[error] Incorrect open flags.\n");
1393 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1394 struct mmap_stream
*mmap_info
)
1396 pos
->mmap_offset
= 0;
1397 pos
->packet_size
= 0;
1398 pos
->content_size
= 0;
1399 pos
->content_size_loc
= NULL
;
1400 pos
->fd
= mmap_info
->fd
;
1405 pos
->packet_index
= NULL
;
1406 pos
->prot
= PROT_READ
;
1407 pos
->flags
= MAP_PRIVATE
;
1408 pos
->parent
.rw_table
= read_dispatch_table
;
1409 pos
->parent
.event_cb
= ctf_read_event
;
1413 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1414 struct ctf_file_stream
*file_stream
)
1416 struct ctf_stream_class
*stream
;
1417 uint64_t stream_id
= 0;
1420 file_stream
->parent
.stream_id
= stream_id
;
1421 if (stream_id
>= td
->streams
->len
) {
1422 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1423 "in metadata.\n", stream_id
);
1427 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1429 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1430 "in metadata.\n", stream_id
);
1434 file_stream
->parent
.stream_class
= stream
;
1435 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1441 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1442 struct mmap_stream
*mmap_info
,
1443 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1447 struct ctf_file_stream
*file_stream
;
1449 file_stream
= g_new0(struct ctf_file_stream
, 1);
1450 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1452 file_stream
->pos
.move_pos_slow
= move_pos_slow
;
1454 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1459 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1463 /* Add stream file to stream class */
1464 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1465 &file_stream
->parent
);
1469 if (file_stream
->parent
.trace_packet_header
)
1470 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1472 g_free(file_stream
);
1476 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1477 struct mmap_stream_list
*mmap_list
,
1478 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
,
1483 struct mmap_stream
*mmap_info
;
1485 ret
= ctf_open_trace_metadata_read(td
, ctf_move_pos_slow
, metadata_fp
);
1491 * for each stream, try to open, check magic number, and get the
1492 * stream ID to add to the right location in the stream array.
1494 cds_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
1495 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, move_pos_slow
);
1497 fprintf(stderr
, "[error] Open file mmap stream error.\n");
1509 struct trace_descriptor
*ctf_open_mmap_trace(
1510 struct mmap_stream_list
*mmap_list
,
1511 void (*move_pos_slow
)(struct ctf_stream_pos
*pos
, size_t offset
, int whence
),
1514 struct ctf_trace
*td
;
1518 fprintf(stderr
, "[error] No metadata file pointer associated, "
1519 "required for mmap parsing\n");
1522 if (!move_pos_slow
) {
1523 fprintf(stderr
, "[error] move_pos_slow function undefined.\n");
1526 td
= g_new0(struct ctf_trace
, 1);
1527 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, move_pos_slow
, metadata_fp
);
1540 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1542 ctf_fini_pos(&file_stream
->pos
);
1543 close(file_stream
->pos
.fd
);
1547 void ctf_close_trace(struct trace_descriptor
*tdp
)
1549 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1553 for (i
= 0; i
< td
->streams
->len
; i
++) {
1554 struct ctf_stream_class
*stream
;
1557 stream
= g_ptr_array_index(td
->streams
, i
);
1560 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1561 struct ctf_file_stream
*file_stream
;
1562 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
), struct ctf_file_stream
, parent
);
1563 ctf_close_file_stream(file_stream
);
1567 g_ptr_array_free(td
->streams
, TRUE
);
1573 void __attribute__((constructor
)) ctf_init(void)
1577 ctf_format
.name
= g_quark_from_static_string("ctf");
1578 ret
= bt_register_format(&ctf_format
);
1582 /* TODO: finalize */