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>
25 #include <babeltrace/ctf/events-internal.h>
28 #include <uuid/uuid.h>
32 #include <sys/types.h>
40 #include "metadata/ctf-scanner.h"
41 #include "metadata/ctf-parser.h"
42 #include "metadata/ctf-ast.h"
45 * We currently simply map a page to read the packet header and packet
46 * context to get the packet length and content length. (in bits)
48 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
49 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
50 #define UUID_LEN 16 /* uuid by value len */
53 #define min(a, b) (((a) < (b)) ? (a) : (b))
56 #define NSEC_PER_SEC 1000000000ULL
63 uint64_t opt_clock_offset
;
68 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
69 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
73 struct trace_descriptor
*ctf_open_mmap_trace(
74 struct mmap_stream_list
*mmap_list
,
75 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
80 void ctf_close_trace(struct trace_descriptor
*descriptor
);
83 rw_dispatch read_dispatch_table
[] = {
84 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
85 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
86 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
87 [ CTF_TYPE_STRING
] = ctf_string_read
,
88 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
89 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
90 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
91 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
95 rw_dispatch write_dispatch_table
[] = {
96 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
97 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
98 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
99 [ CTF_TYPE_STRING
] = ctf_string_write
,
100 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
101 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
102 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
103 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
107 struct format ctf_format
= {
108 .open_trace
= ctf_open_trace
,
109 .open_mmap_trace
= ctf_open_mmap_trace
,
110 .close_trace
= ctf_close_trace
,
114 * Update stream current timestamp, keep at clock frequency.
117 void ctf_update_timestamp(struct ctf_stream
*stream
,
118 struct definition_integer
*integer_definition
)
120 struct declaration_integer
*integer_declaration
=
121 integer_definition
->declaration
;
122 uint64_t oldval
, newval
, updateval
;
124 if (unlikely(integer_declaration
->len
== 64)) {
125 stream
->timestamp
= integer_definition
->value
._unsigned
;
129 oldval
= stream
->timestamp
;
130 oldval
&= (1ULL << integer_declaration
->len
) - 1;
131 newval
= integer_definition
->value
._unsigned
;
132 /* Test for overflow by comparing low bits */
134 newval
+= 1ULL << integer_declaration
->len
;
135 /* updateval contains old high bits, and new low bits (sum) */
136 updateval
= stream
->timestamp
;
137 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
139 stream
->prev_timestamp
= stream
->timestamp
;
140 stream
->timestamp
= updateval
;
144 * Print timestamp, rescaling clock frequency to nanoseconds and
145 * applying offsets as needed (unix time).
147 void ctf_print_timestamp(FILE *fp
,
148 struct ctf_stream
*stream
,
151 uint64_t ts_sec
= 0, ts_nsec
;
152 struct ctf_trace
*trace
= stream
->stream_class
->trace
;
153 struct trace_collection
*tc
= trace
->collection
;
154 uint64_t tc_offset
= tc
->single_clock_offset_avg
;
156 if (stream
->current_clock
->freq
== 1000000000ULL) {
159 ts_nsec
= (uint64_t) ((double) timestamp
* 1000000000.0
160 / (double) stream
->current_clock
->freq
);
164 if (!opt_clock_raw
) {
165 ts_nsec
+= tc_offset
;
167 ts_sec
+= opt_clock_offset
;
169 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
170 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
172 if (!opt_clock_seconds
) {
174 time_t time_s
= (time_t) ts_sec
;
176 if (!opt_clock_gmt
) {
179 res
= localtime_r(&time_s
, &tm
);
181 fprintf(stderr
, "[warning] Unable to get localtime.\n");
187 res
= gmtime_r(&time_s
, &tm
);
189 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
193 if (opt_clock_date
) {
197 /* Print date and time */
198 res
= strftime(timestr
, sizeof(timestr
),
201 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
204 fprintf(fp
, "%s", timestr
);
206 /* Print time in HH:MM:SS.ns */
207 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
208 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
212 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
220 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
222 struct ctf_stream_pos
*pos
=
223 container_of(ppos
, struct ctf_stream_pos
, parent
);
224 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
225 struct ctf_stream_event
*event
;
229 /* We need to check for EOF here for empty files. */
230 if (unlikely(pos
->offset
== EOF
))
233 ctf_pos_get_event(pos
);
235 /* save the current position as a restore point */
236 pos
->last_offset
= pos
->offset
;
237 /* we just read the event, it is consumed when used by the caller */
238 stream
->consumed
= 0;
241 * This is the EOF check after we've advanced the position in
244 if (unlikely(pos
->offset
== EOF
))
246 assert(pos
->offset
< pos
->content_size
);
248 /* Read event header */
249 if (likely(stream
->stream_event_header
)) {
250 struct definition_integer
*integer_definition
;
251 struct definition
*variant
;
253 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
256 /* lookup event id */
257 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
258 if (integer_definition
) {
259 id
= integer_definition
->value
._unsigned
;
261 struct definition_enum
*enum_definition
;
263 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
264 if (enum_definition
) {
265 id
= enum_definition
->integer
->value
._unsigned
;
269 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
271 integer_definition
= lookup_integer(variant
, "id", FALSE
);
272 if (integer_definition
) {
273 id
= integer_definition
->value
._unsigned
;
276 stream
->event_id
= id
;
278 /* lookup timestamp */
279 stream
->has_timestamp
= 0;
280 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
281 if (integer_definition
) {
282 ctf_update_timestamp(stream
, integer_definition
);
283 stream
->has_timestamp
= 1;
286 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
287 if (integer_definition
) {
288 ctf_update_timestamp(stream
, integer_definition
);
289 stream
->has_timestamp
= 1;
295 /* Read stream-declared event context */
296 if (stream
->stream_event_context
) {
297 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
302 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
303 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
306 event
= g_ptr_array_index(stream
->events_by_id
, id
);
307 if (unlikely(!event
)) {
308 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
312 /* Read event-declared event context */
313 if (event
->event_context
) {
314 ret
= generic_rw(ppos
, &event
->event_context
->p
);
319 /* Read event payload */
320 if (likely(event
->event_fields
)) {
321 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
329 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
334 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
336 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
337 struct ctf_stream_event
*event
;
341 id
= stream
->event_id
;
343 /* print event header */
344 if (likely(stream
->stream_event_header
)) {
345 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
350 /* print stream-declared event context */
351 if (stream
->stream_event_context
) {
352 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
357 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
358 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
361 event
= g_ptr_array_index(stream
->events_by_id
, id
);
362 if (unlikely(!event
)) {
363 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
367 /* print event-declared event context */
368 if (event
->event_context
) {
369 ret
= generic_rw(pos
, &event
->event_context
->p
);
374 /* Read and print event payload */
375 if (likely(event
->event_fields
)) {
376 ret
= generic_rw(pos
, &event
->event_fields
->p
);
384 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
388 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
391 pos
->mmap_offset
= 0;
392 pos
->packet_size
= 0;
393 pos
->content_size
= 0;
394 pos
->content_size_loc
= NULL
;
400 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
401 sizeof(struct packet_index
));
403 pos
->packet_index
= NULL
;
404 switch (open_flags
& O_ACCMODE
) {
406 pos
->prot
= PROT_READ
;
407 pos
->flags
= MAP_PRIVATE
;
408 pos
->parent
.rw_table
= read_dispatch_table
;
409 pos
->parent
.event_cb
= ctf_read_event
;
412 pos
->prot
= PROT_WRITE
; /* Write has priority */
413 pos
->flags
= MAP_SHARED
;
414 pos
->parent
.rw_table
= write_dispatch_table
;
415 pos
->parent
.event_cb
= ctf_write_event
;
417 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
424 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
428 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
429 *pos
->content_size_loc
= pos
->offset
;
432 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
434 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
439 (void) g_array_free(pos
->packet_index
, TRUE
);
443 * for SEEK_CUR: go to next packet.
444 * for SEEK_POS: go to packet numer (index).
446 void ctf_packet_seek(struct stream_pos
*stream_pos
, size_t index
, int whence
)
448 struct ctf_stream_pos
*pos
=
449 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
450 struct ctf_file_stream
*file_stream
=
451 container_of(pos
, struct ctf_file_stream
, pos
);
454 struct packet_index
*packet_index
;
456 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
457 *pos
->content_size_loc
= pos
->offset
;
461 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
463 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
471 * The caller should never ask for ctf_move_pos across packets,
472 * except to get exactly at the beginning of the next packet.
474 if (pos
->prot
== PROT_WRITE
) {
477 /* The writer will add padding */
478 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
481 assert(index
== 0); /* only seek supported for now */
487 pos
->content_size
= -1U; /* Unknown at this point */
488 pos
->packet_size
= WRITE_PACKET_LEN
;
489 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
490 pos
->packet_size
/ CHAR_BIT
);
498 uint32_t events_discarded_diff
;
500 if (pos
->offset
== EOF
) {
503 /* For printing discarded event count */
504 packet_index
= &g_array_index(pos
->packet_index
,
505 struct packet_index
, pos
->cur_index
);
506 events_discarded_diff
= packet_index
->events_discarded
;
507 file_stream
->parent
.prev_timestamp_end
=
508 packet_index
->timestamp_end
;
509 if (pos
->cur_index
> 0) {
510 packet_index
= &g_array_index(pos
->packet_index
,
513 events_discarded_diff
-= packet_index
->events_discarded
;
515 file_stream
->parent
.events_discarded
= events_discarded_diff
;
516 file_stream
->parent
.prev_timestamp
= file_stream
->parent
.timestamp
;
517 /* The reader will expect us to skip padding */
522 pos
->cur_index
= index
;
523 file_stream
->parent
.prev_timestamp
= 0;
524 file_stream
->parent
.prev_timestamp_end
= 0;
529 if (pos
->cur_index
>= pos
->packet_index
->len
) {
531 * When a stream reaches the end of the
532 * file, we need to show the number of
533 * events discarded ourselves, because
534 * there is no next event scheduled to
535 * be printed in the output.
537 if (file_stream
->parent
.events_discarded
) {
539 fprintf(stderr
, "[warning] Tracer discarded %d events at end of stream between [",
540 file_stream
->parent
.events_discarded
);
541 ctf_print_timestamp(stderr
, &file_stream
->parent
,
542 file_stream
->parent
.prev_timestamp
);
543 fprintf(stderr
, "] and [");
544 ctf_print_timestamp(stderr
, &file_stream
->parent
,
545 file_stream
->parent
.prev_timestamp_end
);
546 fprintf(stderr
, "]. You should consider increasing the buffer size.\n");
548 file_stream
->parent
.events_discarded
= 0;
553 packet_index
= &g_array_index(pos
->packet_index
, struct packet_index
,
555 pos
->mmap_offset
= packet_index
->offset
;
557 /* Lookup context/packet size in index */
558 file_stream
->parent
.timestamp
= packet_index
->timestamp_begin
;
559 pos
->content_size
= packet_index
->content_size
;
560 pos
->packet_size
= packet_index
->packet_size
;
561 if (packet_index
->data_offset
< packet_index
->content_size
) {
562 pos
->offset
= 0; /* will read headers */
563 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
565 pos
->offset
= packet_index
->data_offset
;
567 goto read_next_packet
;
573 /* map new base. Need mapping length from header. */
574 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
575 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
576 if (pos
->base
== MAP_FAILED
) {
577 fprintf(stderr
, "[error] mmap error %s.\n",
582 /* update trace_packet_header and stream_packet_context */
583 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
584 /* Read packet header */
585 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
588 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
589 /* Read packet context */
590 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
596 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
602 len
= fread(&magic
, sizeof(magic
), 1, fp
);
606 if (magic
== TSDL_MAGIC
) {
608 td
->byte_order
= BYTE_ORDER
;
609 CTF_TRACE_SET_FIELD(td
, byte_order
);
610 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
612 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
613 LITTLE_ENDIAN
: BIG_ENDIAN
;
614 CTF_TRACE_SET_FIELD(td
, byte_order
);
622 * Returns 0 on success, -1 on error.
625 int check_version(unsigned int major
, unsigned int minor
)
640 /* eventually return an error instead of warning */
642 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
648 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
651 struct metadata_packet_header header
;
652 size_t readlen
, writelen
, toread
;
653 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
656 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
660 if (td
->byte_order
!= BYTE_ORDER
) {
661 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
662 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
663 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
664 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
667 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
668 if (header
.compression_scheme
) {
669 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
670 header
.compression_scheme
);
673 if (header
.encryption_scheme
) {
674 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
675 header
.encryption_scheme
);
678 if (header
.checksum_scheme
) {
679 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
680 header
.checksum_scheme
);
683 if (check_version(header
.major
, header
.minor
) < 0)
685 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
686 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
687 CTF_TRACE_SET_FIELD(td
, uuid
);
689 if (uuid_compare(header
.uuid
, td
->uuid
))
693 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
696 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
701 if (babeltrace_debug
) {
703 fprintf(stderr
, "[debug] metadata packet read: %s\n",
707 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
708 if (writelen
< readlen
) {
718 ret
= 0; /* continue reading next packet */
725 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
726 ret
= fseek(in
, toread
, SEEK_CUR
);
728 fprintf(stderr
, "[warning] Missing padding at end of file\n");
735 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
744 * Using strlen on *buf instead of size of open_memstream
745 * because its size includes garbage at the end (after final
746 * \0). This is the allocated size, not the actual string size.
748 out
= open_memstream(buf
, &size
);
750 perror("Metadata open_memstream");
754 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
763 fclose(out
); /* flush the buffer */
765 /* open for reading */
766 *fp
= fmemopen(*buf
, strlen(*buf
), "rb");
768 perror("Metadata fmemopen");
775 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
776 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
777 int whence
), FILE *metadata_fp
)
779 struct ctf_scanner
*scanner
;
780 struct ctf_file_stream
*metadata_stream
;
785 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
788 metadata_stream
->pos
.packet_seek
= packet_seek
;
790 fprintf(stderr
, "[error] packet_seek function undefined.\n");
798 td
->metadata
= &metadata_stream
->parent
;
799 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
800 if (metadata_stream
->pos
.fd
< 0) {
801 fprintf(stderr
, "Unable to open metadata.\n");
802 return metadata_stream
->pos
.fd
;
805 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
807 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
808 perror("Metadata stream open");
813 if (babeltrace_debug
)
816 if (packet_metadata(td
, fp
)) {
817 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
819 goto end_packet_read
;
821 unsigned int major
, minor
;
824 td
->byte_order
= BYTE_ORDER
;
826 /* Check text-only metadata header and version */
827 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
829 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
830 if (check_version(major
, minor
) < 0) {
832 goto end_packet_read
;
837 scanner
= ctf_scanner_alloc(fp
);
839 fprintf(stderr
, "[error] Error allocating scanner\n");
841 goto end_scanner_alloc
;
843 ret
= ctf_scanner_append_ast(scanner
);
845 fprintf(stderr
, "[error] Error creating AST\n");
849 if (babeltrace_debug
) {
850 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
852 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
857 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
859 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
862 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
865 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
869 ctf_scanner_free(scanner
);
875 close(metadata_stream
->pos
.fd
);
877 g_free(metadata_stream
);
882 struct ctf_stream_event
*create_event_definitions(struct ctf_trace
*td
,
883 struct ctf_stream
*stream
,
884 struct ctf_event
*event
)
886 struct ctf_stream_event
*stream_event
= g_new0(struct ctf_stream_event
, 1);
888 if (event
->context_decl
) {
889 struct definition
*definition
=
890 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
891 stream
->parent_def_scope
, 0, 0, "event.context");
895 stream_event
->event_context
= container_of(definition
,
896 struct definition_struct
, p
);
897 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
899 if (event
->fields_decl
) {
900 struct definition
*definition
=
901 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
902 stream
->parent_def_scope
, 0, 0, "event.fields");
906 stream_event
->event_fields
= container_of(definition
,
907 struct definition_struct
, p
);
908 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
913 if (stream_event
->event_fields
)
914 definition_unref(&stream_event
->event_fields
->p
);
915 if (stream_event
->event_context
)
916 definition_unref(&stream_event
->event_context
->p
);
921 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
923 struct ctf_stream_class
*stream_class
;
927 if (stream
->stream_definitions_created
)
930 stream_class
= stream
->stream_class
;
932 if (stream_class
->packet_context_decl
) {
933 struct definition
*definition
=
934 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
935 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
940 stream
->stream_packet_context
= container_of(definition
,
941 struct definition_struct
, p
);
942 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
944 if (stream_class
->event_header_decl
) {
945 struct definition
*definition
=
946 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
947 stream
->parent_def_scope
, 0, 0, "stream.event.header");
952 stream
->stream_event_header
=
953 container_of(definition
, struct definition_struct
, p
);
954 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
956 if (stream_class
->event_context_decl
) {
957 struct definition
*definition
=
958 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
959 stream
->parent_def_scope
, 0, 0, "stream.event.context");
964 stream
->stream_event_context
=
965 container_of(definition
, struct definition_struct
, p
);
966 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
968 stream
->events_by_id
= g_ptr_array_new();
969 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
970 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
971 struct ctf_event
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
972 struct ctf_stream_event
*stream_event
;
976 stream_event
= create_event_definitions(td
, stream
, event
);
979 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
984 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
985 struct ctf_stream_event
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
987 g_free(stream_event
);
989 g_ptr_array_free(stream
->events_by_id
, TRUE
);
991 if (stream
->stream_event_context
)
992 definition_unref(&stream
->stream_event_context
->p
);
993 if (stream
->stream_event_header
)
994 definition_unref(&stream
->stream_event_header
->p
);
995 if (stream
->stream_packet_context
)
996 definition_unref(&stream
->stream_packet_context
->p
);
1002 int create_stream_packet_index(struct ctf_trace
*td
,
1003 struct ctf_file_stream
*file_stream
)
1005 struct ctf_stream_class
*stream
;
1007 struct ctf_stream_pos
*pos
;
1008 struct stat filestats
;
1009 struct packet_index packet_index
;
1010 int first_packet
= 1;
1013 pos
= &file_stream
->pos
;
1015 ret
= fstat(pos
->fd
, &filestats
);
1019 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
1022 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1023 uint64_t stream_id
= 0;
1026 /* unmap old base */
1027 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
1029 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1035 /* map new base. Need mapping length from header. */
1036 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
1037 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1038 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1039 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1040 pos
->offset
= 0; /* Position of the packet header */
1042 packet_index
.offset
= pos
->mmap_offset
;
1043 packet_index
.content_size
= 0;
1044 packet_index
.packet_size
= 0;
1045 packet_index
.timestamp_begin
= 0;
1046 packet_index
.timestamp_end
= 0;
1047 packet_index
.events_discarded
= 0;
1049 /* read and check header, set stream id (and check) */
1050 if (file_stream
->parent
.trace_packet_header
) {
1051 /* Read packet header */
1052 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1055 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1056 if (len_index
>= 0) {
1057 struct definition
*field
;
1060 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1061 magic
= get_unsigned_int(field
);
1062 if (magic
!= CTF_MAGIC
) {
1063 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1065 file_stream
->pos
.packet_index
->len
,
1066 (ssize_t
) pos
->mmap_offset
);
1072 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1073 if (len_index
>= 0) {
1074 struct definition_array
*defarray
;
1075 struct definition
*field
;
1077 uint8_t uuidval
[UUID_LEN
];
1079 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1080 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1081 defarray
= container_of(field
, struct definition_array
, p
);
1082 assert(array_len(defarray
) == UUID_LEN
);
1084 for (i
= 0; i
< UUID_LEN
; i
++) {
1085 struct definition
*elem
;
1087 elem
= array_index(defarray
, i
);
1088 uuidval
[i
] = get_unsigned_int(elem
);
1090 ret
= uuid_compare(td
->uuid
, uuidval
);
1092 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1098 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1099 if (len_index
>= 0) {
1100 struct definition
*field
;
1102 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1103 stream_id
= get_unsigned_int(field
);
1107 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1108 fprintf(stderr
, "[error] Stream ID is changing within a stream.\n");
1112 file_stream
->parent
.stream_id
= stream_id
;
1113 if (stream_id
>= td
->streams
->len
) {
1114 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1117 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1119 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1122 file_stream
->parent
.stream_class
= stream
;
1123 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1129 if (file_stream
->parent
.stream_packet_context
) {
1130 /* Read packet context */
1131 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1134 /* read content size from header */
1135 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1136 if (len_index
>= 0) {
1137 struct definition
*field
;
1139 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1140 packet_index
.content_size
= get_unsigned_int(field
);
1142 /* Use file size for packet size */
1143 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1146 /* read packet size from header */
1147 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1148 if (len_index
>= 0) {
1149 struct definition
*field
;
1151 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1152 packet_index
.packet_size
= get_unsigned_int(field
);
1154 /* Use content size if non-zero, else file size */
1155 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1158 /* read timestamp begin from header */
1159 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1160 if (len_index
>= 0) {
1161 struct definition
*field
;
1163 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1164 packet_index
.timestamp_begin
= get_unsigned_int(field
);
1167 /* read timestamp end from header */
1168 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1169 if (len_index
>= 0) {
1170 struct definition
*field
;
1172 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1173 packet_index
.timestamp_end
= get_unsigned_int(field
);
1176 /* read events discarded from header */
1177 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1178 if (len_index
>= 0) {
1179 struct definition
*field
;
1181 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1182 packet_index
.events_discarded
= get_unsigned_int(field
);
1185 /* Use file size for packet size */
1186 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1187 /* Use content size if non-zero, else file size */
1188 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1191 /* Validate content size and packet size values */
1192 if (packet_index
.content_size
> packet_index
.packet_size
) {
1193 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1194 packet_index
.content_size
, packet_index
.packet_size
);
1198 if (packet_index
.packet_size
> ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
1199 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1200 packet_index
.content_size
, ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
1204 /* Save position after header and context */
1205 packet_index
.data_offset
= pos
->offset
;
1207 /* add index to packet array */
1208 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1210 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1213 /* Move pos back to beginning of file */
1214 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
1220 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
1224 if (td
->packet_header_decl
) {
1225 struct definition
*definition
=
1226 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1227 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1232 stream
->trace_packet_header
=
1233 container_of(definition
, struct definition_struct
, p
);
1234 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1244 * Note: many file streams can inherit from the same stream class
1245 * description (metadata).
1248 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1249 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1253 struct ctf_file_stream
*file_stream
;
1255 ret
= openat(td
->dirfd
, path
, flags
);
1257 perror("File stream openat()");
1260 file_stream
= g_new0(struct ctf_file_stream
, 1);
1263 file_stream
->pos
.packet_seek
= packet_seek
;
1265 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1270 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
1271 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1275 * For now, only a single slock is supported.
1277 file_stream
->parent
.current_clock
= td
->single_clock
;
1278 ret
= create_stream_packet_index(td
, file_stream
);
1281 /* Add stream file to stream class */
1282 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1283 &file_stream
->parent
);
1287 if (file_stream
->parent
.trace_packet_header
)
1288 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1290 ctf_fini_pos(&file_stream
->pos
);
1291 close(file_stream
->pos
.fd
);
1292 g_free(file_stream
);
1298 int ctf_open_trace_read(struct ctf_trace
*td
,
1299 const char *path
, int flags
,
1300 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1301 int whence
), FILE *metadata_fp
)
1304 struct dirent
*dirent
;
1305 struct dirent
*diriter
;
1310 /* Open trace directory */
1311 td
->dir
= opendir(path
);
1313 fprintf(stderr
, "[error] Unable to open trace directory.\n");
1318 td
->dirfd
= open(path
, 0);
1319 if (td
->dirfd
< 0) {
1320 fprintf(stderr
, "[error] Unable to open trace directory file descriptor.\n");
1321 perror("Trace directory open");
1325 strncpy(td
->path
, path
, sizeof(td
->path
));
1326 td
->path
[sizeof(td
->path
) - 1] = '\0';
1329 * Keep the metadata file separate.
1332 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1334 goto error_metadata
;
1338 * Open each stream: for each file, try to open, check magic
1339 * number, and get the stream ID to add to the right location in
1343 dirent_len
= offsetof(struct dirent
, d_name
) +
1344 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1346 dirent
= malloc(dirent_len
);
1349 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1351 fprintf(stderr
, "[error] Readdir error.\n");
1356 /* Ignore hidden files, ., .. and metadata. */
1357 if (!strncmp(diriter
->d_name
, ".", 1)
1358 || !strcmp(diriter
->d_name
, "..")
1359 || !strcmp(diriter
->d_name
, "metadata"))
1361 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1362 flags
, packet_seek
);
1364 fprintf(stderr
, "[error] Open file stream error.\n");
1383 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1384 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1385 int whence
), FILE *metadata_fp
)
1387 struct ctf_trace
*td
;
1391 * If packet_seek is NULL, we provide our default version.
1394 packet_seek
= ctf_packet_seek
;
1396 td
= g_new0(struct ctf_trace
, 1);
1398 switch (flags
& O_ACCMODE
) {
1401 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1404 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
1409 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1412 fprintf(stderr
, "[error] Incorrect open flags.\n");
1423 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1424 struct mmap_stream
*mmap_info
)
1426 pos
->mmap_offset
= 0;
1427 pos
->packet_size
= 0;
1428 pos
->content_size
= 0;
1429 pos
->content_size_loc
= NULL
;
1430 pos
->fd
= mmap_info
->fd
;
1435 pos
->packet_index
= NULL
;
1436 pos
->prot
= PROT_READ
;
1437 pos
->flags
= MAP_PRIVATE
;
1438 pos
->parent
.rw_table
= read_dispatch_table
;
1439 pos
->parent
.event_cb
= ctf_read_event
;
1443 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1444 struct ctf_file_stream
*file_stream
)
1446 struct ctf_stream_class
*stream
;
1447 uint64_t stream_id
= 0;
1450 file_stream
->parent
.stream_id
= stream_id
;
1451 if (stream_id
>= td
->streams
->len
) {
1452 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1453 "in metadata.\n", stream_id
);
1457 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1459 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1460 "in metadata.\n", stream_id
);
1464 file_stream
->parent
.stream_class
= stream
;
1465 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1471 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1472 struct mmap_stream
*mmap_info
,
1473 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1477 struct ctf_file_stream
*file_stream
;
1479 file_stream
= g_new0(struct ctf_file_stream
, 1);
1480 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1482 file_stream
->pos
.packet_seek
= packet_seek
;
1484 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1489 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1493 /* Add stream file to stream class */
1494 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1495 &file_stream
->parent
);
1499 if (file_stream
->parent
.trace_packet_header
)
1500 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1502 g_free(file_stream
);
1506 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1507 struct mmap_stream_list
*mmap_list
,
1508 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1513 struct mmap_stream
*mmap_info
;
1515 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
1521 * for each stream, try to open, check magic number, and get the
1522 * stream ID to add to the right location in the stream array.
1524 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
1525 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
1527 fprintf(stderr
, "[error] Open file mmap stream error.\n");
1539 struct trace_descriptor
*ctf_open_mmap_trace(
1540 struct mmap_stream_list
*mmap_list
,
1541 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1545 struct ctf_trace
*td
;
1549 fprintf(stderr
, "[error] No metadata file pointer associated, "
1550 "required for mmap parsing\n");
1554 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1557 td
= g_new0(struct ctf_trace
, 1);
1558 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
1571 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1573 ctf_fini_pos(&file_stream
->pos
);
1574 close(file_stream
->pos
.fd
);
1578 void ctf_close_trace(struct trace_descriptor
*tdp
)
1580 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1584 for (i
= 0; i
< td
->streams
->len
; i
++) {
1585 struct ctf_stream_class
*stream
;
1588 stream
= g_ptr_array_index(td
->streams
, i
);
1591 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1592 struct ctf_file_stream
*file_stream
;
1593 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
), struct ctf_file_stream
, parent
);
1594 ctf_close_file_stream(file_stream
);
1598 g_ptr_array_free(td
->streams
, TRUE
);
1604 void __attribute__((constructor
)) ctf_init(void)
1608 ctf_format
.name
= g_quark_from_static_string("ctf");
1609 ret
= bt_register_format(&ctf_format
);
1613 /* TODO: finalize */