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>
26 #include <babeltrace/uuid.h>
27 #include <babeltrace/endian.h>
32 #include <sys/types.h>
40 #include "metadata/ctf-scanner.h"
41 #include "metadata/ctf-parser.h"
42 #include "metadata/ctf-ast.h"
43 #include "events-private.h"
46 * We currently simply map a page to read the packet header and packet
47 * context to get the packet length and content length. (in bits)
49 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
50 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
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
;
154 ts_nsec
= ctf_get_timestamp_raw(stream
, timestamp
);
156 ts_nsec
= ctf_get_timestamp(stream
, timestamp
);
159 /* Add command-line offset */
160 ts_sec
+= opt_clock_offset
;
162 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
163 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
165 if (!opt_clock_seconds
) {
167 time_t time_s
= (time_t) ts_sec
;
169 if (!opt_clock_gmt
) {
172 res
= localtime_r(&time_s
, &tm
);
174 fprintf(stderr
, "[warning] Unable to get localtime.\n");
180 res
= gmtime_r(&time_s
, &tm
);
182 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
186 if (opt_clock_date
) {
190 /* Print date and time */
191 res
= strftime(timestr
, sizeof(timestr
),
194 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
197 fprintf(fp
, "%s", timestr
);
199 /* Print time in HH:MM:SS.ns */
200 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
201 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
205 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
213 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream
*stream
)
215 struct ctf_stream_pos
*pos
=
216 container_of(ppos
, struct ctf_stream_pos
, parent
);
217 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
218 struct ctf_stream_event
*event
;
222 /* We need to check for EOF here for empty files. */
223 if (unlikely(pos
->offset
== EOF
))
226 ctf_pos_get_event(pos
);
228 /* save the current position as a restore point */
229 pos
->last_offset
= pos
->offset
;
230 /* we just read the event, it is consumed when used by the caller */
231 stream
->consumed
= 0;
234 * This is the EOF check after we've advanced the position in
237 if (unlikely(pos
->offset
== EOF
))
239 assert(pos
->offset
< pos
->content_size
);
241 /* Read event header */
242 if (likely(stream
->stream_event_header
)) {
243 struct definition_integer
*integer_definition
;
244 struct definition
*variant
;
246 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
249 /* lookup event id */
250 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
251 if (integer_definition
) {
252 id
= integer_definition
->value
._unsigned
;
254 struct definition_enum
*enum_definition
;
256 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
257 if (enum_definition
) {
258 id
= enum_definition
->integer
->value
._unsigned
;
262 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
264 integer_definition
= lookup_integer(variant
, "id", FALSE
);
265 if (integer_definition
) {
266 id
= integer_definition
->value
._unsigned
;
269 stream
->event_id
= id
;
271 /* lookup timestamp */
272 stream
->has_timestamp
= 0;
273 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
274 if (integer_definition
) {
275 ctf_update_timestamp(stream
, integer_definition
);
276 stream
->has_timestamp
= 1;
279 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
280 if (integer_definition
) {
281 ctf_update_timestamp(stream
, integer_definition
);
282 stream
->has_timestamp
= 1;
288 /* Read stream-declared event context */
289 if (stream
->stream_event_context
) {
290 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
295 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
296 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
299 event
= g_ptr_array_index(stream
->events_by_id
, id
);
300 if (unlikely(!event
)) {
301 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
305 /* Read event-declared event context */
306 if (event
->event_context
) {
307 ret
= generic_rw(ppos
, &event
->event_context
->p
);
312 /* Read event payload */
313 if (likely(event
->event_fields
)) {
314 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
322 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
327 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream
*stream
)
329 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
330 struct ctf_stream_event
*event
;
334 id
= stream
->event_id
;
336 /* print event header */
337 if (likely(stream
->stream_event_header
)) {
338 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
343 /* print stream-declared event context */
344 if (stream
->stream_event_context
) {
345 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
350 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
351 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
354 event
= g_ptr_array_index(stream
->events_by_id
, id
);
355 if (unlikely(!event
)) {
356 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
360 /* print event-declared event context */
361 if (event
->event_context
) {
362 ret
= generic_rw(pos
, &event
->event_context
->p
);
367 /* Read and print event payload */
368 if (likely(event
->event_fields
)) {
369 ret
= generic_rw(pos
, &event
->event_fields
->p
);
377 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
381 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
384 pos
->mmap_offset
= 0;
385 pos
->packet_size
= 0;
386 pos
->content_size
= 0;
387 pos
->content_size_loc
= NULL
;
393 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
394 sizeof(struct packet_index
));
396 pos
->packet_index
= NULL
;
397 switch (open_flags
& O_ACCMODE
) {
399 pos
->prot
= PROT_READ
;
400 pos
->flags
= MAP_PRIVATE
;
401 pos
->parent
.rw_table
= read_dispatch_table
;
402 pos
->parent
.event_cb
= ctf_read_event
;
405 pos
->prot
= PROT_WRITE
; /* Write has priority */
406 pos
->flags
= MAP_SHARED
;
407 pos
->parent
.rw_table
= write_dispatch_table
;
408 pos
->parent
.event_cb
= ctf_write_event
;
410 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
417 void ctf_fini_pos(struct ctf_stream_pos
*pos
)
421 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
422 *pos
->content_size_loc
= pos
->offset
;
425 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
427 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
432 (void) g_array_free(pos
->packet_index
, TRUE
);
436 * for SEEK_CUR: go to next packet.
437 * for SEEK_POS: go to packet numer (index).
439 void ctf_packet_seek(struct stream_pos
*stream_pos
, size_t index
, int whence
)
441 struct ctf_stream_pos
*pos
=
442 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
443 struct ctf_file_stream
*file_stream
=
444 container_of(pos
, struct ctf_file_stream
, pos
);
447 struct packet_index
*packet_index
;
449 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
450 *pos
->content_size_loc
= pos
->offset
;
454 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
456 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
464 * The caller should never ask for ctf_move_pos across packets,
465 * except to get exactly at the beginning of the next packet.
467 if (pos
->prot
== PROT_WRITE
) {
470 /* The writer will add padding */
471 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
474 assert(index
== 0); /* only seek supported for now */
480 pos
->content_size
= -1U; /* Unknown at this point */
481 pos
->packet_size
= WRITE_PACKET_LEN
;
482 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
483 pos
->packet_size
/ CHAR_BIT
);
491 uint32_t events_discarded_diff
;
493 if (pos
->offset
== EOF
) {
496 /* For printing discarded event count */
497 packet_index
= &g_array_index(pos
->packet_index
,
498 struct packet_index
, pos
->cur_index
);
499 events_discarded_diff
= packet_index
->events_discarded
;
500 file_stream
->parent
.prev_timestamp_end
=
501 packet_index
->timestamp_end
;
502 if (pos
->cur_index
> 0) {
503 packet_index
= &g_array_index(pos
->packet_index
,
506 events_discarded_diff
-= packet_index
->events_discarded
;
508 file_stream
->parent
.events_discarded
= events_discarded_diff
;
509 file_stream
->parent
.prev_timestamp
= file_stream
->parent
.timestamp
;
510 /* The reader will expect us to skip padding */
515 pos
->cur_index
= index
;
516 file_stream
->parent
.prev_timestamp
= 0;
517 file_stream
->parent
.prev_timestamp_end
= 0;
522 if (pos
->cur_index
>= pos
->packet_index
->len
) {
524 * When a stream reaches the end of the
525 * file, we need to show the number of
526 * events discarded ourselves, because
527 * there is no next event scheduled to
528 * be printed in the output.
530 if (file_stream
->parent
.events_discarded
) {
532 * We need to check if we are in trace
533 * read or called from packet indexing.
534 * In this last case, the collection is
535 * not there, so we cannot print the
538 if ((&file_stream
->parent
)->stream_class
->trace
->collection
) {
540 fprintf(stderr
, "[warning] Tracer discarded %d events at end of stream between [",
541 file_stream
->parent
.events_discarded
);
542 ctf_print_timestamp(stderr
, &file_stream
->parent
,
543 file_stream
->parent
.prev_timestamp
);
544 fprintf(stderr
, "] and [");
545 ctf_print_timestamp(stderr
, &file_stream
->parent
,
546 file_stream
->parent
.prev_timestamp_end
);
547 fprintf(stderr
, "]. You should consider increasing the buffer size.\n");
550 file_stream
->parent
.events_discarded
= 0;
555 packet_index
= &g_array_index(pos
->packet_index
, struct packet_index
,
557 pos
->mmap_offset
= packet_index
->offset
;
559 /* Lookup context/packet size in index */
560 file_stream
->parent
.timestamp
= packet_index
->timestamp_begin
;
561 pos
->content_size
= packet_index
->content_size
;
562 pos
->packet_size
= packet_index
->packet_size
;
563 if (packet_index
->data_offset
< packet_index
->content_size
) {
564 pos
->offset
= 0; /* will read headers */
565 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
567 pos
->offset
= packet_index
->data_offset
;
569 goto read_next_packet
;
575 /* map new base. Need mapping length from header. */
576 pos
->base
= mmap(NULL
, pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
577 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
578 if (pos
->base
== MAP_FAILED
) {
579 fprintf(stderr
, "[error] mmap error %s.\n",
584 /* update trace_packet_header and stream_packet_context */
585 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
586 /* Read packet header */
587 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
590 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
591 /* Read packet context */
592 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
598 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
604 len
= fread(&magic
, sizeof(magic
), 1, fp
);
608 if (magic
== TSDL_MAGIC
) {
610 td
->byte_order
= BYTE_ORDER
;
611 CTF_TRACE_SET_FIELD(td
, byte_order
);
612 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
614 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
615 LITTLE_ENDIAN
: BIG_ENDIAN
;
616 CTF_TRACE_SET_FIELD(td
, byte_order
);
624 * Returns 0 on success, -1 on error.
627 int check_version(unsigned int major
, unsigned int minor
)
642 /* eventually return an error instead of warning */
644 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
650 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
653 struct metadata_packet_header header
;
654 size_t readlen
, writelen
, toread
;
655 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
658 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
662 if (td
->byte_order
!= BYTE_ORDER
) {
663 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
664 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
665 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
666 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
669 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
670 if (header
.compression_scheme
) {
671 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
672 header
.compression_scheme
);
675 if (header
.encryption_scheme
) {
676 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
677 header
.encryption_scheme
);
680 if (header
.checksum_scheme
) {
681 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
682 header
.checksum_scheme
);
685 if (check_version(header
.major
, header
.minor
) < 0)
687 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
688 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
689 CTF_TRACE_SET_FIELD(td
, uuid
);
691 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
695 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
698 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
703 if (babeltrace_debug
) {
705 fprintf(stderr
, "[debug] metadata packet read: %s\n",
709 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
710 if (writelen
< readlen
) {
720 ret
= 0; /* continue reading next packet */
727 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
728 ret
= fseek(in
, toread
, SEEK_CUR
);
730 fprintf(stderr
, "[warning] Missing padding at end of file\n");
737 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
746 * Using strlen on *buf instead of size of open_memstream
747 * because its size includes garbage at the end (after final
748 * \0). This is the allocated size, not the actual string size.
750 out
= open_memstream(buf
, &size
);
752 perror("Metadata open_memstream");
756 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
765 fclose(out
); /* flush the buffer */
767 /* open for reading */
768 *fp
= fmemopen(*buf
, strlen(*buf
), "rb");
770 perror("Metadata fmemopen");
777 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
778 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
779 int whence
), FILE *metadata_fp
)
781 struct ctf_scanner
*scanner
;
782 struct ctf_file_stream
*metadata_stream
;
787 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
790 metadata_stream
->pos
.packet_seek
= packet_seek
;
792 fprintf(stderr
, "[error] packet_seek function undefined.\n");
800 td
->metadata
= &metadata_stream
->parent
;
801 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
802 if (metadata_stream
->pos
.fd
< 0) {
803 fprintf(stderr
, "Unable to open metadata.\n");
804 return metadata_stream
->pos
.fd
;
807 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
809 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
810 perror("Metadata stream open");
815 if (babeltrace_debug
)
818 if (packet_metadata(td
, fp
)) {
819 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
821 goto end_packet_read
;
823 unsigned int major
, minor
;
826 td
->byte_order
= BYTE_ORDER
;
828 /* Check text-only metadata header and version */
829 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
831 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
832 if (check_version(major
, minor
) < 0) {
834 goto end_packet_read
;
839 scanner
= ctf_scanner_alloc(fp
);
841 fprintf(stderr
, "[error] Error allocating scanner\n");
843 goto end_scanner_alloc
;
845 ret
= ctf_scanner_append_ast(scanner
);
847 fprintf(stderr
, "[error] Error creating AST\n");
851 if (babeltrace_debug
) {
852 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
854 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
859 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
861 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
864 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
867 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
871 ctf_scanner_free(scanner
);
877 close(metadata_stream
->pos
.fd
);
879 g_free(metadata_stream
);
884 struct ctf_stream_event
*create_event_definitions(struct ctf_trace
*td
,
885 struct ctf_stream
*stream
,
886 struct ctf_event
*event
)
888 struct ctf_stream_event
*stream_event
= g_new0(struct ctf_stream_event
, 1);
890 if (event
->context_decl
) {
891 struct definition
*definition
=
892 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
893 stream
->parent_def_scope
, 0, 0, "event.context");
897 stream_event
->event_context
= container_of(definition
,
898 struct definition_struct
, p
);
899 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
901 if (event
->fields_decl
) {
902 struct definition
*definition
=
903 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
904 stream
->parent_def_scope
, 0, 0, "event.fields");
908 stream_event
->event_fields
= container_of(definition
,
909 struct definition_struct
, p
);
910 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
915 if (stream_event
->event_fields
)
916 definition_unref(&stream_event
->event_fields
->p
);
917 if (stream_event
->event_context
)
918 definition_unref(&stream_event
->event_context
->p
);
923 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
925 struct ctf_stream_class
*stream_class
;
929 if (stream
->stream_definitions_created
)
932 stream_class
= stream
->stream_class
;
934 if (stream_class
->packet_context_decl
) {
935 struct definition
*definition
=
936 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
937 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
942 stream
->stream_packet_context
= container_of(definition
,
943 struct definition_struct
, p
);
944 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
946 if (stream_class
->event_header_decl
) {
947 struct definition
*definition
=
948 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
949 stream
->parent_def_scope
, 0, 0, "stream.event.header");
954 stream
->stream_event_header
=
955 container_of(definition
, struct definition_struct
, p
);
956 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
958 if (stream_class
->event_context_decl
) {
959 struct definition
*definition
=
960 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
961 stream
->parent_def_scope
, 0, 0, "stream.event.context");
966 stream
->stream_event_context
=
967 container_of(definition
, struct definition_struct
, p
);
968 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
970 stream
->events_by_id
= g_ptr_array_new();
971 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
972 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
973 struct ctf_event
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
974 struct ctf_stream_event
*stream_event
;
978 stream_event
= create_event_definitions(td
, stream
, event
);
981 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
986 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
987 struct ctf_stream_event
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
989 g_free(stream_event
);
991 g_ptr_array_free(stream
->events_by_id
, TRUE
);
993 if (stream
->stream_event_context
)
994 definition_unref(&stream
->stream_event_context
->p
);
995 if (stream
->stream_event_header
)
996 definition_unref(&stream
->stream_event_header
->p
);
997 if (stream
->stream_packet_context
)
998 definition_unref(&stream
->stream_packet_context
->p
);
1004 int create_stream_packet_index(struct ctf_trace
*td
,
1005 struct ctf_file_stream
*file_stream
)
1007 struct ctf_stream_class
*stream
;
1009 struct ctf_stream_pos
*pos
;
1010 struct stat filestats
;
1011 struct packet_index packet_index
;
1012 int first_packet
= 1;
1015 pos
= &file_stream
->pos
;
1017 ret
= fstat(pos
->fd
, &filestats
);
1021 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
1024 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1025 uint64_t stream_id
= 0;
1028 /* unmap old base */
1029 ret
= munmap(pos
->base
, pos
->packet_size
/ CHAR_BIT
);
1031 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1037 /* map new base. Need mapping length from header. */
1038 pos
->base
= mmap(NULL
, MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
1039 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1040 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1041 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1042 pos
->offset
= 0; /* Position of the packet header */
1044 packet_index
.offset
= pos
->mmap_offset
;
1045 packet_index
.content_size
= 0;
1046 packet_index
.packet_size
= 0;
1047 packet_index
.timestamp_begin
= 0;
1048 packet_index
.timestamp_end
= 0;
1049 packet_index
.events_discarded
= 0;
1051 /* read and check header, set stream id (and check) */
1052 if (file_stream
->parent
.trace_packet_header
) {
1053 /* Read packet header */
1054 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1057 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1058 if (len_index
>= 0) {
1059 struct definition
*field
;
1062 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1063 magic
= get_unsigned_int(field
);
1064 if (magic
!= CTF_MAGIC
) {
1065 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1067 file_stream
->pos
.packet_index
->len
,
1068 (ssize_t
) pos
->mmap_offset
);
1074 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1075 if (len_index
>= 0) {
1076 struct definition_array
*defarray
;
1077 struct definition
*field
;
1079 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1081 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1082 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1083 defarray
= container_of(field
, struct definition_array
, p
);
1084 assert(array_len(defarray
) == BABELTRACE_UUID_LEN
);
1086 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1087 struct definition
*elem
;
1089 elem
= array_index(defarray
, i
);
1090 uuidval
[i
] = get_unsigned_int(elem
);
1092 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1094 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1100 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1101 if (len_index
>= 0) {
1102 struct definition
*field
;
1104 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1105 stream_id
= get_unsigned_int(field
);
1109 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1110 fprintf(stderr
, "[error] Stream ID is changing within a stream.\n");
1114 file_stream
->parent
.stream_id
= stream_id
;
1115 if (stream_id
>= td
->streams
->len
) {
1116 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1119 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1121 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1124 file_stream
->parent
.stream_class
= stream
;
1125 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1131 if (file_stream
->parent
.stream_packet_context
) {
1132 /* Read packet context */
1133 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1136 /* read content size from header */
1137 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1138 if (len_index
>= 0) {
1139 struct definition
*field
;
1141 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1142 packet_index
.content_size
= get_unsigned_int(field
);
1144 /* Use file size for packet size */
1145 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1148 /* read packet size from header */
1149 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1150 if (len_index
>= 0) {
1151 struct definition
*field
;
1153 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1154 packet_index
.packet_size
= get_unsigned_int(field
);
1156 /* Use content size if non-zero, else file size */
1157 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1160 /* read timestamp begin from header */
1161 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1162 if (len_index
>= 0) {
1163 struct definition
*field
;
1165 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1166 packet_index
.timestamp_begin
= get_unsigned_int(field
);
1169 /* read timestamp end from header */
1170 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1171 if (len_index
>= 0) {
1172 struct definition
*field
;
1174 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1175 packet_index
.timestamp_end
= get_unsigned_int(field
);
1178 /* read events discarded from header */
1179 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1180 if (len_index
>= 0) {
1181 struct definition
*field
;
1183 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1184 packet_index
.events_discarded
= get_unsigned_int(field
);
1187 /* Use file size for packet size */
1188 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1189 /* Use content size if non-zero, else file size */
1190 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1193 /* Validate content size and packet size values */
1194 if (packet_index
.content_size
> packet_index
.packet_size
) {
1195 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1196 packet_index
.content_size
, packet_index
.packet_size
);
1200 if (packet_index
.packet_size
> ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
1201 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1202 packet_index
.content_size
, ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
1206 /* Save position after header and context */
1207 packet_index
.data_offset
= pos
->offset
;
1209 /* add index to packet array */
1210 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1212 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1215 /* Move pos back to beginning of file */
1216 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
1222 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream
*stream
)
1226 if (td
->packet_header_decl
) {
1227 struct definition
*definition
=
1228 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1229 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1234 stream
->trace_packet_header
=
1235 container_of(definition
, struct definition_struct
, p
);
1236 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1246 * Note: many file streams can inherit from the same stream class
1247 * description (metadata).
1250 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1251 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1255 struct ctf_file_stream
*file_stream
;
1257 ret
= openat(td
->dirfd
, path
, flags
);
1259 perror("File stream openat()");
1262 file_stream
= g_new0(struct ctf_file_stream
, 1);
1265 file_stream
->pos
.packet_seek
= packet_seek
;
1267 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1272 ctf_init_pos(&file_stream
->pos
, ret
, flags
);
1273 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1277 * For now, only a single slock is supported.
1279 file_stream
->parent
.current_clock
= td
->single_clock
;
1280 ret
= create_stream_packet_index(td
, file_stream
);
1283 /* Add stream file to stream class */
1284 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1285 &file_stream
->parent
);
1289 if (file_stream
->parent
.trace_packet_header
)
1290 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1292 ctf_fini_pos(&file_stream
->pos
);
1293 close(file_stream
->pos
.fd
);
1294 g_free(file_stream
);
1300 int ctf_open_trace_read(struct ctf_trace
*td
,
1301 const char *path
, int flags
,
1302 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1303 int whence
), FILE *metadata_fp
)
1306 struct dirent
*dirent
;
1307 struct dirent
*diriter
;
1312 /* Open trace directory */
1313 td
->dir
= opendir(path
);
1315 fprintf(stderr
, "[error] Unable to open trace directory.\n");
1320 td
->dirfd
= open(path
, 0);
1321 if (td
->dirfd
< 0) {
1322 fprintf(stderr
, "[error] Unable to open trace directory file descriptor.\n");
1323 perror("Trace directory open");
1327 strncpy(td
->path
, path
, sizeof(td
->path
));
1328 td
->path
[sizeof(td
->path
) - 1] = '\0';
1331 * Keep the metadata file separate.
1334 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1336 goto error_metadata
;
1340 * Open each stream: for each file, try to open, check magic
1341 * number, and get the stream ID to add to the right location in
1345 dirent_len
= offsetof(struct dirent
, d_name
) +
1346 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1348 dirent
= malloc(dirent_len
);
1351 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1353 fprintf(stderr
, "[error] Readdir error.\n");
1358 /* Ignore hidden files, ., .. and metadata. */
1359 if (!strncmp(diriter
->d_name
, ".", 1)
1360 || !strcmp(diriter
->d_name
, "..")
1361 || !strcmp(diriter
->d_name
, "metadata"))
1363 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1364 flags
, packet_seek
);
1366 fprintf(stderr
, "[error] Open file stream error.\n");
1385 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1386 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1387 int whence
), FILE *metadata_fp
)
1389 struct ctf_trace
*td
;
1393 * If packet_seek is NULL, we provide our default version.
1396 packet_seek
= ctf_packet_seek
;
1398 td
= g_new0(struct ctf_trace
, 1);
1400 switch (flags
& O_ACCMODE
) {
1403 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1406 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
1411 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1414 fprintf(stderr
, "[error] Incorrect open flags.\n");
1425 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1426 struct mmap_stream
*mmap_info
)
1428 pos
->mmap_offset
= 0;
1429 pos
->packet_size
= 0;
1430 pos
->content_size
= 0;
1431 pos
->content_size_loc
= NULL
;
1432 pos
->fd
= mmap_info
->fd
;
1437 pos
->packet_index
= NULL
;
1438 pos
->prot
= PROT_READ
;
1439 pos
->flags
= MAP_PRIVATE
;
1440 pos
->parent
.rw_table
= read_dispatch_table
;
1441 pos
->parent
.event_cb
= ctf_read_event
;
1445 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1446 struct ctf_file_stream
*file_stream
)
1448 struct ctf_stream_class
*stream
;
1449 uint64_t stream_id
= 0;
1452 file_stream
->parent
.stream_id
= stream_id
;
1453 if (stream_id
>= td
->streams
->len
) {
1454 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1455 "in metadata.\n", stream_id
);
1459 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1461 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1462 "in metadata.\n", stream_id
);
1466 file_stream
->parent
.stream_class
= stream
;
1467 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1473 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1474 struct mmap_stream
*mmap_info
,
1475 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1479 struct ctf_file_stream
*file_stream
;
1481 file_stream
= g_new0(struct ctf_file_stream
, 1);
1482 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1484 file_stream
->pos
.packet_seek
= packet_seek
;
1486 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1491 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1495 /* Add stream file to stream class */
1496 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1497 &file_stream
->parent
);
1501 if (file_stream
->parent
.trace_packet_header
)
1502 definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1504 g_free(file_stream
);
1508 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1509 struct mmap_stream_list
*mmap_list
,
1510 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1515 struct mmap_stream
*mmap_info
;
1517 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
1523 * for each stream, try to open, check magic number, and get the
1524 * stream ID to add to the right location in the stream array.
1526 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
1527 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
1529 fprintf(stderr
, "[error] Open file mmap stream error.\n");
1541 struct trace_descriptor
*ctf_open_mmap_trace(
1542 struct mmap_stream_list
*mmap_list
,
1543 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1547 struct ctf_trace
*td
;
1551 fprintf(stderr
, "[error] No metadata file pointer associated, "
1552 "required for mmap parsing\n");
1556 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1559 td
= g_new0(struct ctf_trace
, 1);
1560 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
1573 void ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1575 ctf_fini_pos(&file_stream
->pos
);
1576 close(file_stream
->pos
.fd
);
1580 void ctf_close_trace(struct trace_descriptor
*tdp
)
1582 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1586 for (i
= 0; i
< td
->streams
->len
; i
++) {
1587 struct ctf_stream_class
*stream
;
1590 stream
= g_ptr_array_index(td
->streams
, i
);
1593 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1594 struct ctf_file_stream
*file_stream
;
1595 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
), struct ctf_file_stream
, parent
);
1596 ctf_close_file_stream(file_stream
);
1600 g_ptr_array_free(td
->streams
, TRUE
);
1606 void __attribute__((constructor
)) ctf_init(void)
1610 ctf_format
.name
= g_quark_from_static_string("ctf");
1611 ret
= bt_register_format(&ctf_format
);
1615 /* TODO: finalize */