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>
24 #include <uuid/uuid.h>
27 #include <sys/types.h>
35 #include "metadata/ctf-scanner.h"
36 #include "metadata/ctf-parser.h"
37 #include "metadata/ctf-ast.h"
40 * We currently simply map a page to read the packet header and packet
41 * context to get the packet length and content length. (in bits)
43 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
44 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
45 #define UUID_LEN 16 /* uuid by value len */
49 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
);
50 void ctf_close_trace(struct trace_descriptor
*descriptor
);
53 rw_dispatch read_dispatch_table
[] = {
54 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
55 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
56 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
57 [ CTF_TYPE_STRING
] = ctf_string_read
,
58 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
59 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
60 [ CTF_TYPE_ARRAY
] = ctf_array_rw
,
61 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_rw
,
65 rw_dispatch write_dispatch_table
[] = {
66 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
67 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
68 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
69 [ CTF_TYPE_STRING
] = ctf_string_write
,
70 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
71 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
72 [ CTF_TYPE_ARRAY
] = ctf_array_rw
,
73 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_rw
,
77 struct format ctf_format
= {
78 .open_trace
= ctf_open_trace
,
79 .close_trace
= ctf_close_trace
,
83 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
85 struct ctf_stream_pos
*pos
=
86 container_of(ppos
, struct ctf_stream_pos
, parent
);
87 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
88 struct ctf_event
*event_class
;
93 if (pos
->offset
== EOF
)
96 /* Read event header */
97 if (stream_class
->event_header
) {
98 ret
= generic_rw(ppos
, &stream_class
->event_header
->p
);
101 /* lookup event id */
102 len_index
= struct_declaration_lookup_field_index(stream_class
->event_header_decl
,
103 g_quark_from_static_string("id"));
104 if (len_index
>= 0) {
105 struct definition_integer
*defint
;
106 struct definition
*field
;
108 field
= struct_definition_get_field_from_index(stream_class
->event_header
, len_index
);
109 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
110 defint
= container_of(field
, struct definition_integer
, p
);
111 assert(defint
->declaration
->signedness
== FALSE
);
112 id
= defint
->value
._unsigned
; /* set id */
115 /* lookup timestamp */
116 len_index
= struct_declaration_lookup_field_index(stream_class
->event_header_decl
,
117 g_quark_from_static_string("timestamp"));
118 if (len_index
>= 0) {
119 struct definition_integer
*defint
;
120 struct definition
*field
;
122 field
= struct_definition_get_field_from_index(stream_class
->event_header
, len_index
);
123 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
124 defint
= container_of(field
, struct definition_integer
, p
);
125 assert(defint
->declaration
->signedness
== FALSE
);
126 /* update timestamp */
127 stream
->timestamp
= defint
->value
._unsigned
;
132 /* Read stream-declared event context */
133 if (stream_class
->event_context
) {
134 ret
= generic_rw(ppos
, &stream_class
->event_context
->p
);
139 if (id
>= stream_class
->events_by_id
->len
) {
140 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
143 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
145 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
149 /* Read event-declared event context */
150 if (event_class
->context
) {
151 ret
= generic_rw(ppos
, &event_class
->context
->p
);
156 /* Read event payload */
157 if (event_class
->fields
) {
158 ret
= generic_rw(ppos
, &event_class
->fields
->p
);
166 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
171 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
173 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
174 struct ctf_event
*event_class
;
179 /* print event header */
180 if (stream_class
->event_header
) {
181 /* lookup event id */
182 len_index
= struct_declaration_lookup_field_index(stream_class
->event_header_decl
,
183 g_quark_from_static_string("id"));
184 if (len_index
>= 0) {
185 struct definition_integer
*defint
;
186 struct definition
*field
;
188 field
= struct_definition_get_field_from_index(stream_class
->event_header
, len_index
);
189 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
190 defint
= container_of(field
, struct definition_integer
, p
);
191 assert(defint
->declaration
->signedness
== FALSE
);
192 id
= defint
->value
._unsigned
; /* set id */
195 ret
= generic_rw(pos
, &stream_class
->event_header
->p
);
200 /* print stream-declared event context */
201 if (stream_class
->event_context
) {
202 ret
= generic_rw(pos
, &stream_class
->event_context
->p
);
207 if (id
>= stream_class
->events_by_id
->len
) {
208 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
211 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
213 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
217 /* print event-declared event context */
218 if (event_class
->context
) {
219 ret
= generic_rw(pos
, &event_class
->context
->p
);
224 /* Read and print event payload */
225 if (event_class
->fields
) {
226 ret
= generic_rw(pos
, &event_class
->fields
->p
);
234 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
238 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
241 pos
->mmap_offset
= 0;
242 pos
->packet_size
= 0;
243 pos
->content_size
= 0;
244 pos
->content_size_loc
= NULL
;
250 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
251 sizeof(struct packet_index
));
253 pos
->packet_index
= NULL
;
254 switch (open_flags
& O_ACCMODE
) {
256 pos
->prot
= PROT_READ
;
257 pos
->flags
= MAP_PRIVATE
;
258 pos
->parent
.rw_table
= read_dispatch_table
;
259 pos
->parent
.event_cb
= ctf_read_event
;
262 pos
->prot
= PROT_WRITE
; /* Write has priority */
263 pos
->flags
= MAP_SHARED
;
264 pos
->parent
.rw_table
= write_dispatch_table
;
265 pos
->parent
.event_cb
= ctf_write_event
;
267 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
274 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
278 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
279 *pos
->content_size_loc
= pos
->offset
;
282 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
284 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
289 (void) g_array_free(pos
->packet_index
, TRUE
);
292 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
)
296 struct packet_index
*index
;
298 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
299 *pos
->content_size_loc
= pos
->offset
;
303 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
305 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
313 * The caller should never ask for ctf_move_pos across packets,
314 * except to get exactly at the beginning of the next packet.
316 if (pos
->prot
== PROT_WRITE
) {
319 /* The writer will add padding */
320 assert(pos
->offset
+ offset
== pos
->packet_size
);
321 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
324 assert(offset
== 0); /* only seek supported for now */
330 pos
->content_size
= -1U; /* Unknown at this point */
331 pos
->packet_size
= WRITE_PACKET_LEN
;
332 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
333 pos
->packet_size
/ CHAR_BIT
);
339 /* The reader will expect us to skip padding */
340 assert(pos
->offset
+ offset
== pos
->content_size
);
344 assert(offset
== 0); /* only seek supported for now */
350 if (pos
->cur_index
>= pos
->packet_index
->len
) {
354 index
= &g_array_index(pos
->packet_index
, struct packet_index
,
356 pos
->mmap_offset
= index
->offset
;
358 /* Lookup context/packet size in index */
359 pos
->content_size
= index
->content_size
;
360 pos
->packet_size
= index
->packet_size
;
361 pos
->offset
= index
->data_offset
;
363 /* map new base. Need mapping length from header. */
364 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
365 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
366 if (pos
->base
== MAP_FAILED
) {
367 fprintf(stdout
, "[error] mmap error %s.\n",
374 * TODO: for now, we treat the metadata file as a simple text file
375 * (without any header nor packets nor padding).
378 int ctf_open_trace_metadata_read(struct ctf_trace
*td
)
380 struct ctf_scanner
*scanner
;
384 td
->metadata
.pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
385 if (td
->metadata
.pos
.fd
< 0) {
386 fprintf(stdout
, "Unable to open metadata.\n");
387 return td
->metadata
.pos
.fd
;
390 if (babeltrace_debug
)
393 fp
= fdopen(td
->metadata
.pos
.fd
, "r");
395 fprintf(stdout
, "[error] Unable to open metadata stream.\n");
400 scanner
= ctf_scanner_alloc(fp
);
402 fprintf(stdout
, "[error] Error allocating scanner\n");
404 goto end_scanner_alloc
;
406 ret
= ctf_scanner_append_ast(scanner
);
408 fprintf(stdout
, "[error] Error creating AST\n");
412 if (babeltrace_debug
) {
413 ret
= ctf_visitor_print_xml(stdout
, 0, &scanner
->ast
->root
);
415 fprintf(stdout
, "[error] Error visiting AST for XML output\n");
420 ret
= ctf_visitor_semantic_check(stdout
, 0, &scanner
->ast
->root
);
422 fprintf(stdout
, "[error] Error in CTF semantic validation %d\n", ret
);
425 ret
= ctf_visitor_construct_metadata(stdout
, 0, &scanner
->ast
->root
,
428 fprintf(stdout
, "[error] Error in CTF metadata constructor %d\n", ret
);
432 ctf_scanner_free(scanner
);
436 close(td
->metadata
.pos
.fd
);
442 int create_stream_packet_index(struct ctf_trace
*td
,
443 struct ctf_file_stream
*file_stream
)
445 struct ctf_stream_class
*stream
;
447 struct ctf_stream_pos
*pos
;
448 struct stat filestats
;
449 struct packet_index packet_index
;
450 int first_packet
= 1;
453 pos
= &file_stream
->pos
;
455 ret
= fstat(pos
->fd
, &filestats
);
459 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
460 uint64_t stream_id
= 0;
464 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
466 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
472 /* map new base. Need mapping length from header. */
473 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
474 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
475 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
476 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
477 pos
->offset
= 0; /* Position of the packet header */
479 packet_index
.offset
= pos
->mmap_offset
;
480 packet_index
.content_size
= 0;
481 packet_index
.packet_size
= 0;
483 /* read and check header, set stream id (and check) */
484 if (td
->packet_header
) {
485 /* Read packet header */
486 ret
= generic_rw(&pos
->parent
, &td
->packet_header
->p
);
489 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("magic"));
490 if (len_index
>= 0) {
491 struct definition_integer
*defint
;
492 struct definition
*field
;
494 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
495 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
496 defint
= container_of(field
, struct definition_integer
, p
);
497 assert(defint
->declaration
->signedness
== FALSE
);
498 if (defint
->value
._unsigned
!= CTF_MAGIC
) {
499 fprintf(stdout
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
500 defint
->value
._unsigned
,
501 file_stream
->pos
.packet_index
->len
,
502 (ssize_t
) pos
->mmap_offset
);
508 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("trace_uuid"));
509 if (len_index
>= 0) {
510 struct definition_array
*defarray
;
511 struct definition
*field
;
513 uint8_t uuidval
[UUID_LEN
];
515 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
516 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
517 defarray
= container_of(field
, struct definition_array
, p
);
518 assert(array_len(defarray
) == UUID_LEN
);
519 assert(defarray
->declaration
->elem
->id
== CTF_TYPE_INTEGER
);
521 for (i
= 0; i
< UUID_LEN
; i
++) {
522 struct definition
*elem
;
523 struct definition_integer
*defint
;
525 elem
= array_index(defarray
, i
);
527 defint
= container_of(elem
, struct definition_integer
, p
);
528 uuidval
[i
] = defint
->value
._unsigned
;
530 ret
= uuid_compare(td
->uuid
, uuidval
);
532 fprintf(stdout
, "[error] Unique Universal Identifiers do not match.\n");
538 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("stream_id"));
539 if (len_index
>= 0) {
540 struct definition_integer
*defint
;
541 struct definition
*field
;
543 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
544 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
545 defint
= container_of(field
, struct definition_integer
, p
);
546 assert(defint
->declaration
->signedness
== FALSE
);
547 stream_id
= defint
->value
._unsigned
;
551 if (!first_packet
&& file_stream
->stream_id
!= stream_id
) {
552 fprintf(stdout
, "[error] Stream ID is changing within a stream.\n");
556 file_stream
->stream_id
= stream_id
;
557 if (stream_id
>= td
->streams
->len
) {
558 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
561 stream
= g_ptr_array_index(td
->streams
, stream_id
);
563 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
566 file_stream
->stream
.stream_class
= stream
;
570 if (stream
->packet_context
) {
571 /* Read packet context */
572 ret
= generic_rw(&pos
->parent
, &stream
->packet_context
->p
);
575 /* read content size from header */
576 len_index
= struct_declaration_lookup_field_index(stream
->packet_context
->declaration
, g_quark_from_static_string("content_size"));
577 if (len_index
>= 0) {
578 struct definition_integer
*defint
;
579 struct definition
*field
;
581 field
= struct_definition_get_field_from_index(stream
->packet_context
, len_index
);
582 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
583 defint
= container_of(field
, struct definition_integer
, p
);
584 assert(defint
->declaration
->signedness
== FALSE
);
585 packet_index
.content_size
= defint
->value
._unsigned
;
587 /* Use file size for packet size */
588 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
591 /* read packet size from header */
592 len_index
= struct_declaration_lookup_field_index(stream
->packet_context
->declaration
, g_quark_from_static_string("packet_size"));
593 if (len_index
>= 0) {
594 struct definition_integer
*defint
;
595 struct definition
*field
;
597 field
= struct_definition_get_field_from_index(stream
->packet_context
, len_index
);
598 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
599 defint
= container_of(field
, struct definition_integer
, p
);
600 assert(defint
->declaration
->signedness
== FALSE
);
601 packet_index
.packet_size
= defint
->value
._unsigned
;
603 /* Use content size if non-zero, else file size */
604 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
607 /* Use file size for packet size */
608 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
609 /* Use content size if non-zero, else file size */
610 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
613 /* Validate content size and packet size values */
614 if (packet_index
.content_size
> packet_index
.packet_size
) {
615 fprintf(stdout
, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
616 packet_index
.content_size
, packet_index
.packet_size
);
620 if (packet_index
.packet_size
> (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
621 fprintf(stdout
, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
622 packet_index
.content_size
, (filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
626 /* Save position after header and context */
627 packet_index
.data_offset
= pos
->offset
;
629 /* add index to packet array */
630 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
632 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
635 /* Move pos back to beginning of file */
636 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
642 * Note: many file streams can inherit from the same stream class
643 * description (metadata).
646 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
)
649 struct ctf_file_stream
*file_stream
;
651 ret
= openat(td
->dirfd
, path
, flags
);
654 file_stream
= g_new0(struct ctf_file_stream
, 1);
655 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
656 ret
= create_stream_packet_index(td
, file_stream
);
659 /* Add stream file to stream class */
660 g_ptr_array_add(file_stream
->stream
.stream_class
->files
, file_stream
);
664 ctf_fini_pos(&file_stream
->pos
);
665 close(file_stream
->pos
.fd
);
672 int ctf_open_trace_read(struct ctf_trace
*td
, const char *path
, int flags
)
675 struct dirent
*dirent
;
676 struct dirent
*diriter
;
681 /* Open trace directory */
682 td
->dir
= opendir(path
);
684 fprintf(stdout
, "[error] Unable to open trace directory.\n");
689 td
->dirfd
= open(path
, 0);
691 fprintf(stdout
, "[error] Unable to open trace directory file descriptor.\n");
696 td
->streams
= g_ptr_array_new();
699 * Keep the metadata file separate.
702 ret
= ctf_open_trace_metadata_read(td
);
708 * Open each stream: for each file, try to open, check magic
709 * number, and get the stream ID to add to the right location in
713 dirent_len
= offsetof(struct dirent
, d_name
) +
714 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
716 dirent
= malloc(dirent_len
);
719 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
721 fprintf(stdout
, "[error] Readdir error.\n");
726 /* Ignore hidden files, ., .. and metadata. */
727 if (!strncmp(diriter
->d_name
, ".", 1)
728 || !strcmp(diriter
->d_name
, "..")
729 || !strcmp(diriter
->d_name
, "metadata"))
731 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
, flags
);
733 fprintf(stdout
, "[error] Open file stream error.\n");
744 g_ptr_array_free(td
->streams
, TRUE
);
752 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
)
754 struct ctf_trace
*td
;
757 td
= g_new0(struct ctf_trace
, 1);
759 switch (flags
& O_ACCMODE
) {
762 fprintf(stdout
, "[error] Path missing for input CTF trace.\n");
765 ret
= ctf_open_trace_read(td
, path
, flags
);
770 fprintf(stdout
, "[error] Opening CTF traces for output is not supported yet.\n");
773 fprintf(stdout
, "[error] Incorrect open flags.\n");
784 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
786 ctf_fini_pos(&file_stream
->pos
);
787 close(file_stream
->pos
.fd
);
790 void ctf_close_trace(struct trace_descriptor
*tdp
)
792 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
796 for (i
= 0; i
< td
->streams
->len
; i
++) {
797 struct ctf_stream_class
*stream
;
799 stream
= g_ptr_array_index(td
->streams
, i
);
800 for (j
= 0; j
< stream
->files
->len
; j
++) {
801 struct ctf_file_stream
*file_stream
;
802 file_stream
= g_ptr_array_index(stream
->files
, j
);
803 ctf_close_file_stream(file_stream
);
807 g_ptr_array_free(td
->streams
, TRUE
);
813 void __attribute__((constructor
)) ctf_init(void)
817 ctf_format
.name
= g_quark_from_static_string("ctf");
818 ret
= bt_register_format(&ctf_format
);