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
,
82 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
87 pos
->content_size
= 0;
88 pos
->content_size_loc
= NULL
;
94 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
95 sizeof(struct packet_index
));
97 pos
->packet_index
= NULL
;
98 switch (open_flags
& O_ACCMODE
) {
100 pos
->prot
= PROT_READ
;
101 pos
->flags
= MAP_PRIVATE
;
102 pos
->parent
.rw_table
= read_dispatch_table
;
106 pos
->prot
= PROT_WRITE
; /* Write has priority */
107 pos
->flags
= MAP_SHARED
;
108 pos
->parent
.rw_table
= write_dispatch_table
;
110 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
117 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
121 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
122 *pos
->content_size_loc
= pos
->offset
;
125 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
127 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
132 (void) g_array_free(pos
->packet_index
, TRUE
);
135 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
)
139 struct packet_index
*index
;
141 /* Only allow random seek in read mode */
142 assert(pos
->prot
!= PROT_WRITE
|| whence
== SEEK_CUR
);
144 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
145 *pos
->content_size_loc
= pos
->offset
;
149 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
151 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
159 * The caller should never ask for ctf_move_pos across packets,
160 * except to get exactly at the beginning of the next packet.
162 if (pos
->prot
== PROT_WRITE
) {
163 /* The writer will add padding */
164 assert(pos
->offset
+ offset
== pos
->packet_size
);
167 * Don't increment for initial stream move (only condition where
168 * pos->offset can be 0.
171 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
172 pos
->content_size
= -1U; /* Unknown at this point */
173 pos
->packet_size
= WRITE_PACKET_LEN
;
174 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
, pos
->packet_size
/ CHAR_BIT
);
180 /* The reader will expect us to skip padding */
181 assert(pos
->offset
+ offset
== pos
->content_size
);
185 assert(offset
== 0); /* only seek supported for now */
191 if (pos
->cur_index
>= pos
->packet_index
->len
) {
195 index
= &g_array_index(pos
->packet_index
, struct packet_index
,
197 pos
->mmap_offset
= index
->offset
;
199 /* Lookup context/packet size in index */
200 pos
->content_size
= index
->content_size
;
201 pos
->packet_size
= index
->packet_size
;
202 pos
->offset
= index
->data_offset
;
204 /* map new base. Need mapping length from header. */
205 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
206 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
207 if (pos
->base
== MAP_FAILED
) {
208 fprintf(stdout
, "[error] mmap error %s.\n",
215 * TODO: for now, we treat the metadata file as a simple text file
216 * (without any header nor packets nor padding).
219 int ctf_open_trace_metadata_read(struct ctf_trace
*td
)
221 struct ctf_scanner
*scanner
;
225 td
->metadata
.pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
226 if (td
->metadata
.pos
.fd
< 0) {
227 fprintf(stdout
, "Unable to open metadata.\n");
228 return td
->metadata
.pos
.fd
;
231 if (babeltrace_debug
)
234 fp
= fdopen(td
->metadata
.pos
.fd
, "r");
236 fprintf(stdout
, "[error] Unable to open metadata stream.\n");
241 scanner
= ctf_scanner_alloc(fp
);
243 fprintf(stdout
, "[error] Error allocating scanner\n");
245 goto end_scanner_alloc
;
247 ret
= ctf_scanner_append_ast(scanner
);
249 fprintf(stdout
, "[error] Error creating AST\n");
253 if (babeltrace_debug
) {
254 ret
= ctf_visitor_print_xml(stdout
, 0, &scanner
->ast
->root
);
256 fprintf(stdout
, "[error] Error visiting AST for XML output\n");
261 ret
= ctf_visitor_semantic_check(stdout
, 0, &scanner
->ast
->root
);
263 fprintf(stdout
, "[error] Error in CTF semantic validation %d\n", ret
);
266 ret
= ctf_visitor_construct_metadata(stdout
, 0, &scanner
->ast
->root
,
269 fprintf(stdout
, "[error] Error in CTF metadata constructor %d\n", ret
);
273 ctf_scanner_free(scanner
);
277 close(td
->metadata
.pos
.fd
);
283 int create_stream_packet_index(struct ctf_trace
*td
,
284 struct ctf_file_stream
*file_stream
)
286 struct ctf_stream
*stream
;
288 struct ctf_stream_pos
*pos
;
289 struct stat filestats
;
290 struct packet_index packet_index
;
291 int first_packet
= 1;
294 pos
= &file_stream
->pos
;
296 ret
= fstat(pos
->fd
, &filestats
);
300 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
301 uint64_t stream_id
= 0;
305 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
307 fprintf(stdout
, "[error] Unable to unmap old base: %s.\n",
313 /* map new base. Need mapping length from header. */
314 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
315 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
316 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
317 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
318 pos
->offset
= 0; /* Position of the packet header */
320 packet_index
.offset
= pos
->mmap_offset
;
321 packet_index
.content_size
= 0;
322 packet_index
.packet_size
= 0;
324 /* read and check header, set stream id (and check) */
325 if (td
->packet_header
) {
326 /* Read packet header */
327 ret
= generic_rw(&pos
->parent
, &td
->packet_header
->p
);
330 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("magic"));
331 if (len_index
>= 0) {
332 struct definition_integer
*defint
;
335 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
336 assert(field
->definition
->declaration
->id
== CTF_TYPE_INTEGER
);
337 defint
= container_of(field
->definition
, struct definition_integer
, p
);
338 assert(defint
->declaration
->signedness
== FALSE
);
339 if (defint
->value
._unsigned
!= CTF_MAGIC
) {
340 fprintf(stdout
, "[error] Invalid magic number %" PRIX64
" at packet %u (file offset %zd).\n",
341 defint
->value
._unsigned
,
342 file_stream
->pos
.packet_index
->len
,
343 (ssize_t
) pos
->mmap_offset
);
349 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("trace_uuid"));
350 if (len_index
>= 0) {
351 struct definition_array
*defarray
;
354 uint8_t uuidval
[UUID_LEN
];
356 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
357 assert(field
->definition
->declaration
->id
== CTF_TYPE_ARRAY
);
358 defarray
= container_of(field
->definition
, struct definition_array
, p
);
359 assert(array_len(defarray
) == UUID_LEN
);
360 assert(defarray
->declaration
->elem
->id
== CTF_TYPE_INTEGER
);
362 for (i
= 0; i
< UUID_LEN
; i
++) {
363 struct definition
*elem
;
364 struct definition_integer
*defint
;
366 elem
= array_index(defarray
, i
);
368 defint
= container_of(elem
, struct definition_integer
, p
);
369 uuidval
[i
] = defint
->value
._unsigned
;
371 ret
= uuid_compare(td
->uuid
, uuidval
);
373 fprintf(stdout
, "[error] Unique Universal Identifiers do not match.\n");
379 len_index
= struct_declaration_lookup_field_index(td
->packet_header
->declaration
, g_quark_from_static_string("stream_id"));
380 if (len_index
>= 0) {
381 struct definition_integer
*defint
;
384 field
= struct_definition_get_field_from_index(td
->packet_header
, len_index
);
385 assert(field
->definition
->declaration
->id
== CTF_TYPE_INTEGER
);
386 defint
= container_of(field
->definition
, struct definition_integer
, p
);
387 assert(defint
->declaration
->signedness
== FALSE
);
388 stream_id
= defint
->value
._unsigned
;
392 if (!first_packet
&& file_stream
->stream_id
!= stream_id
) {
393 fprintf(stdout
, "[error] Stream ID is changing within a stream.\n");
397 file_stream
->stream_id
= stream_id
;
398 if (stream_id
>= td
->streams
->len
) {
399 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
402 stream
= g_ptr_array_index(td
->streams
, stream_id
);
404 fprintf(stdout
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
407 file_stream
->stream
= stream
;
411 if (stream
->packet_context
) {
412 /* Read packet context */
413 ret
= generic_rw(&pos
->parent
, &stream
->packet_context
->p
);
416 /* read content size from header */
417 len_index
= struct_declaration_lookup_field_index(stream
->packet_context
->declaration
, g_quark_from_static_string("content_size"));
418 if (len_index
>= 0) {
419 struct definition_integer
*defint
;
422 field
= struct_definition_get_field_from_index(stream
->packet_context
, len_index
);
423 assert(field
->definition
->declaration
->id
== CTF_TYPE_INTEGER
);
424 defint
= container_of(field
->definition
, struct definition_integer
, p
);
425 assert(defint
->declaration
->signedness
== FALSE
);
426 packet_index
.content_size
= defint
->value
._unsigned
;
428 /* Use file size for packet size */
429 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
432 /* read packet size from header */
433 len_index
= struct_declaration_lookup_field_index(stream
->packet_context
->declaration
, g_quark_from_static_string("packet_size"));
434 if (len_index
>= 0) {
435 struct definition_integer
*defint
;
438 field
= struct_definition_get_field_from_index(stream
->packet_context
, len_index
);
439 assert(field
->definition
->declaration
->id
== CTF_TYPE_INTEGER
);
440 defint
= container_of(field
->definition
, struct definition_integer
, p
);
441 assert(defint
->declaration
->signedness
== FALSE
);
442 packet_index
.packet_size
= defint
->value
._unsigned
;
444 /* Use content size if non-zero, else file size */
445 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
448 /* Use file size for packet size */
449 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
450 /* Use content size if non-zero, else file size */
451 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
454 /* Validate content size and packet size values */
455 if (packet_index
.content_size
> packet_index
.packet_size
) {
456 fprintf(stdout
, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
457 packet_index
.content_size
, packet_index
.packet_size
);
461 if (packet_index
.packet_size
> filestats
.st_size
* CHAR_BIT
) {
462 fprintf(stdout
, "[error] Packet size (%zu bits) is larger than file size (%zu bits).\n",
463 packet_index
.content_size
, filestats
.st_size
* CHAR_BIT
);
467 /* Save position after header and context */
468 packet_index
.data_offset
= pos
->offset
;
470 /* add index to packet array */
471 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
473 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
476 /* Move pos back to beginning of file */
477 ctf_move_pos_slow(pos
, 0, SEEK_SET
); /* position for write */
483 * Note: many file streams can inherit from the same stream class
484 * description (metadata).
487 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
)
490 struct ctf_file_stream
*file_stream
;
492 ret
= openat(td
->dirfd
, path
, flags
);
495 file_stream
= g_new0(struct ctf_file_stream
, 1);
496 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
497 ret
= create_stream_packet_index(td
, file_stream
);
500 /* Add stream file to stream class */
501 g_ptr_array_add(file_stream
->stream
->files
, file_stream
);
505 ctf_fini_pos(&file_stream
->pos
);
506 close(file_stream
->pos
.fd
);
513 int ctf_open_trace_read(struct ctf_trace
*td
, const char *path
, int flags
)
516 struct dirent
*dirent
;
517 struct dirent
*diriter
;
522 /* Open trace directory */
523 td
->dir
= opendir(path
);
525 fprintf(stdout
, "[error] Unable to open trace directory.\n");
530 td
->dirfd
= open(path
, 0);
532 fprintf(stdout
, "[error] Unable to open trace directory file descriptor.\n");
537 td
->streams
= g_ptr_array_new();
540 * Keep the metadata file separate.
543 ret
= ctf_open_trace_metadata_read(td
);
549 * Open each stream: for each file, try to open, check magic
550 * number, and get the stream ID to add to the right location in
554 dirent_len
= offsetof(struct dirent
, d_name
) +
555 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
557 dirent
= malloc(dirent_len
);
560 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
562 fprintf(stdout
, "[error] Readdir error.\n");
567 if (!strcmp(diriter
->d_name
, ".")
568 || !strcmp(diriter
->d_name
, "..")
569 || !strcmp(diriter
->d_name
, "metadata"))
571 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
, flags
);
573 fprintf(stdout
, "[error] Open file stream error.\n");
584 g_ptr_array_free(td
->streams
, TRUE
);
592 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
)
594 struct ctf_trace
*td
;
597 td
= g_new0(struct ctf_trace
, 1);
599 switch (flags
& O_ACCMODE
) {
602 fprintf(stdout
, "[error] Path missing for input CTF trace.\n");
605 ret
= ctf_open_trace_read(td
, path
, flags
);
610 fprintf(stdout
, "[error] Opening CTF traces for output is not supported yet.\n");
613 fprintf(stdout
, "[error] Incorrect open flags.\n");
624 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
626 ctf_fini_pos(&file_stream
->pos
);
627 close(file_stream
->pos
.fd
);
630 void ctf_close_trace(struct trace_descriptor
*tdp
)
632 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
636 for (i
= 0; i
< td
->streams
->len
; i
++) {
637 struct ctf_stream
*stream
;
639 stream
= g_ptr_array_index(td
->streams
, i
);
640 for (j
= 0; j
< stream
->files
->len
; j
++) {
641 struct ctf_file_stream
*file_stream
;
642 file_stream
= g_ptr_array_index(stream
->files
, j
);
643 ctf_close_file_stream(file_stream
);
647 g_ptr_array_free(td
->streams
, TRUE
);
653 void __attribute__((constructor
)) ctf_init(void)
657 ctf_format
.name
= g_quark_from_static_string("ctf");
658 ret
= bt_register_format(&ctf_format
);