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.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/format.h>
30 #include <babeltrace/ctf/types.h>
31 #include <babeltrace/ctf/metadata.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/ctf/events-internal.h>
34 #include <babeltrace/trace-handle-internal.h>
35 #include <babeltrace/context-internal.h>
36 #include <babeltrace/compat/uuid.h>
37 #include <babeltrace/endian.h>
38 #include <babeltrace/ctf/ctf-index.h>
43 #include <sys/types.h>
51 #include "metadata/ctf-scanner.h"
52 #include "metadata/ctf-parser.h"
53 #include "metadata/ctf-ast.h"
54 #include "events-private.h"
55 #include <babeltrace/compat/memstream.h>
57 #define LOG2_CHAR_BIT 3
60 * Length of first attempt at mapping a packet header, in bits.
62 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
65 * Lenght of packet to write, in bits.
67 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
70 #define min(a, b) (((a) < (b)) ? (a) : (b))
73 #define NSEC_PER_SEC 1000000000ULL
75 #define INDEX_PATH "./index/%s.idx"
82 uint64_t opt_clock_offset
;
83 uint64_t opt_clock_offset_ns
;
88 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
89 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
93 struct bt_trace_descriptor
*ctf_open_mmap_trace(
94 struct bt_mmap_stream_list
*mmap_list
,
95 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
99 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
100 struct bt_context
*ctx
);
102 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
103 struct bt_trace_handle
*handle
);
106 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
108 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
109 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
111 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
112 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
114 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
117 rw_dispatch read_dispatch_table
[] = {
118 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
119 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
120 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
121 [ CTF_TYPE_STRING
] = ctf_string_read
,
122 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
123 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
124 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
125 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
129 rw_dispatch write_dispatch_table
[] = {
130 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
131 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
132 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
133 [ CTF_TYPE_STRING
] = ctf_string_write
,
134 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
135 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
136 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
137 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
141 struct bt_format ctf_format
= {
142 .open_trace
= ctf_open_trace
,
143 .open_mmap_trace
= ctf_open_mmap_trace
,
144 .close_trace
= ctf_close_trace
,
145 .set_context
= ctf_set_context
,
146 .set_handle
= ctf_set_handle
,
147 .timestamp_begin
= ctf_timestamp_begin
,
148 .timestamp_end
= ctf_timestamp_end
,
149 .convert_index_timestamp
= ctf_convert_index_timestamp
,
153 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
154 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
156 struct ctf_trace
*tin
;
157 uint64_t begin
= ULLONG_MAX
;
160 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
165 /* for each stream_class */
166 for (i
= 0; i
< tin
->streams
->len
; i
++) {
167 struct ctf_stream_declaration
*stream_class
;
169 stream_class
= g_ptr_array_index(tin
->streams
, i
);
172 /* for each file_stream */
173 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
174 struct ctf_stream_definition
*stream
;
175 struct ctf_file_stream
*cfs
;
176 struct ctf_stream_pos
*stream_pos
;
177 struct packet_index
*index
;
179 stream
= g_ptr_array_index(stream_class
->streams
, j
);
180 cfs
= container_of(stream
, struct ctf_file_stream
,
182 stream_pos
= &cfs
->pos
;
184 if (!stream_pos
->packet_real_index
)
187 if (stream_pos
->packet_real_index
->len
<= 0)
190 if (type
== BT_CLOCK_REAL
) {
191 index
= &g_array_index(stream_pos
->packet_real_index
,
193 stream_pos
->packet_real_index
->len
- 1);
194 } else if (type
== BT_CLOCK_CYCLES
) {
195 index
= &g_array_index(stream_pos
->packet_cycles_index
,
197 stream_pos
->packet_real_index
->len
- 1);
202 if (index
->timestamp_begin
< begin
)
203 begin
= index
->timestamp_begin
;
214 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
215 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
217 struct ctf_trace
*tin
;
221 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
226 /* for each stream_class */
227 for (i
= 0; i
< tin
->streams
->len
; i
++) {
228 struct ctf_stream_declaration
*stream_class
;
230 stream_class
= g_ptr_array_index(tin
->streams
, i
);
233 /* for each file_stream */
234 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
235 struct ctf_stream_definition
*stream
;
236 struct ctf_file_stream
*cfs
;
237 struct ctf_stream_pos
*stream_pos
;
238 struct packet_index
*index
;
240 stream
= g_ptr_array_index(stream_class
->streams
, j
);
241 cfs
= container_of(stream
, struct ctf_file_stream
,
243 stream_pos
= &cfs
->pos
;
245 if (!stream_pos
->packet_real_index
)
248 if (stream_pos
->packet_real_index
->len
<= 0)
251 if (type
== BT_CLOCK_REAL
) {
252 index
= &g_array_index(stream_pos
->packet_real_index
,
254 stream_pos
->packet_real_index
->len
- 1);
255 } else if (type
== BT_CLOCK_CYCLES
) {
256 index
= &g_array_index(stream_pos
->packet_cycles_index
,
258 stream_pos
->packet_real_index
->len
- 1);
263 if (index
->timestamp_end
> end
)
264 end
= index
->timestamp_end
;
275 * Update stream current timestamp
278 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
279 struct definition_integer
*integer_definition
)
281 struct declaration_integer
*integer_declaration
=
282 integer_definition
->declaration
;
283 uint64_t oldval
, newval
, updateval
;
285 if (unlikely(integer_declaration
->len
== 64)) {
286 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
287 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
288 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
289 stream
->prev_cycles_timestamp
);
290 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
291 stream
->cycles_timestamp
);
295 oldval
= stream
->cycles_timestamp
;
296 oldval
&= (1ULL << integer_declaration
->len
) - 1;
297 newval
= integer_definition
->value
._unsigned
;
298 /* Test for overflow by comparing low bits */
300 newval
+= 1ULL << integer_declaration
->len
;
301 /* updateval contains old high bits, and new low bits (sum) */
302 updateval
= stream
->cycles_timestamp
;
303 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
305 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
306 stream
->cycles_timestamp
= updateval
;
308 /* convert to real timestamp */
309 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
310 stream
->prev_cycles_timestamp
);
311 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
312 stream
->cycles_timestamp
);
316 * Print timestamp, rescaling clock frequency to nanoseconds and
317 * applying offsets as needed (unix time).
320 void ctf_print_timestamp_real(FILE *fp
,
321 struct ctf_stream_definition
*stream
,
324 uint64_t ts_sec
= 0, ts_nsec
;
328 /* Add command-line offset in ns*/
329 ts_nsec
+= opt_clock_offset_ns
;
331 /* Add command-line offset */
332 ts_sec
+= opt_clock_offset
;
334 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
335 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
337 if (!opt_clock_seconds
) {
339 time_t time_s
= (time_t) ts_sec
;
341 if (!opt_clock_gmt
) {
344 res
= localtime_r(&time_s
, &tm
);
346 fprintf(stderr
, "[warning] Unable to get localtime.\n");
352 res
= gmtime_r(&time_s
, &tm
);
354 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
358 if (opt_clock_date
) {
362 /* Print date and time */
363 res
= strftime(timestr
, sizeof(timestr
),
366 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
369 fprintf(fp
, "%s", timestr
);
371 /* Print time in HH:MM:SS.ns */
372 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
373 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
377 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
385 * Print timestamp, in cycles
388 void ctf_print_timestamp_cycles(FILE *fp
,
389 struct ctf_stream_definition
*stream
,
392 fprintf(fp
, "%020" PRIu64
, timestamp
);
395 void ctf_print_timestamp(FILE *fp
,
396 struct ctf_stream_definition
*stream
,
399 if (opt_clock_cycles
) {
400 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
402 ctf_print_timestamp_real(fp
, stream
, timestamp
);
407 void print_uuid(FILE *fp
, unsigned char *uuid
)
411 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
412 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
415 void ctf_print_discarded(FILE *fp
, struct ctf_stream_definition
*stream
,
418 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events %sbetween [",
419 stream
->events_discarded
,
420 end_stream
? "at end of stream " : "");
421 if (opt_clock_cycles
) {
422 ctf_print_timestamp(fp
, stream
,
423 stream
->prev_cycles_timestamp
);
424 fprintf(fp
, "] and [");
425 ctf_print_timestamp(fp
, stream
,
426 stream
->prev_cycles_timestamp_end
);
428 ctf_print_timestamp(fp
, stream
,
429 stream
->prev_real_timestamp
);
430 fprintf(fp
, "] and [");
431 ctf_print_timestamp(fp
, stream
,
432 stream
->prev_real_timestamp_end
);
434 fprintf(fp
, "] in trace UUID ");
435 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
436 if (stream
->stream_class
->trace
->parent
.path
[0])
437 fprintf(fp
, ", at path: \"%s\"",
438 stream
->stream_class
->trace
->parent
.path
);
440 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
442 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
444 fprintf(fp
, "You should consider recording a new trace with larger "
445 "buffers or with fewer events enabled.\n");
450 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
452 struct ctf_stream_pos
*pos
=
453 container_of(ppos
, struct ctf_stream_pos
, parent
);
454 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
455 struct ctf_event_definition
*event
;
459 /* We need to check for EOF here for empty files. */
460 if (unlikely(pos
->offset
== EOF
))
463 ctf_pos_get_event(pos
);
465 /* save the current position as a restore point */
466 pos
->last_offset
= pos
->offset
;
469 * This is the EOF check after we've advanced the position in
472 if (unlikely(pos
->offset
== EOF
))
475 if (pos
->content_size
== 0) {
476 /* Stream is inactive for now (live reading). */
479 assert(pos
->offset
< pos
->content_size
);
481 /* Read event header */
482 if (likely(stream
->stream_event_header
)) {
483 struct definition_integer
*integer_definition
;
484 struct bt_definition
*variant
;
486 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
489 /* lookup event id */
490 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
491 if (integer_definition
) {
492 id
= integer_definition
->value
._unsigned
;
494 struct definition_enum
*enum_definition
;
496 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
497 if (enum_definition
) {
498 id
= enum_definition
->integer
->value
._unsigned
;
502 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
504 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
505 if (integer_definition
) {
506 id
= integer_definition
->value
._unsigned
;
509 stream
->event_id
= id
;
511 /* lookup timestamp */
512 stream
->has_timestamp
= 0;
513 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
514 if (integer_definition
) {
515 ctf_update_timestamp(stream
, integer_definition
);
516 stream
->has_timestamp
= 1;
519 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
520 if (integer_definition
) {
521 ctf_update_timestamp(stream
, integer_definition
);
522 stream
->has_timestamp
= 1;
528 /* Read stream-declared event context */
529 if (stream
->stream_event_context
) {
530 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
535 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
536 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
539 event
= g_ptr_array_index(stream
->events_by_id
, id
);
540 if (unlikely(!event
)) {
541 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
545 /* Read event-declared event context */
546 if (event
->event_context
) {
547 ret
= generic_rw(ppos
, &event
->event_context
->p
);
552 /* Read event payload */
553 if (likely(event
->event_fields
)) {
554 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
559 if (pos
->last_offset
== pos
->offset
) {
560 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
567 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
572 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
574 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
575 struct ctf_event_definition
*event
;
579 id
= stream
->event_id
;
581 /* print event header */
582 if (likely(stream
->stream_event_header
)) {
583 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
588 /* print stream-declared event context */
589 if (stream
->stream_event_context
) {
590 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
595 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
596 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
599 event
= g_ptr_array_index(stream
->events_by_id
, id
);
600 if (unlikely(!event
)) {
601 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
605 /* print event-declared event context */
606 if (event
->event_context
) {
607 ret
= generic_rw(pos
, &event
->event_context
->p
);
612 /* Read and print event payload */
613 if (likely(event
->event_fields
)) {
614 ret
= generic_rw(pos
, &event
->event_fields
->p
);
622 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
626 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
627 int fd
, int open_flags
)
631 pos
->packet_cycles_index
= g_array_new(FALSE
, TRUE
,
632 sizeof(struct packet_index
));
633 pos
->packet_real_index
= g_array_new(FALSE
, TRUE
,
634 sizeof(struct packet_index
));
636 pos
->packet_cycles_index
= NULL
;
637 pos
->packet_real_index
= NULL
;
639 switch (open_flags
& O_ACCMODE
) {
641 pos
->prot
= PROT_READ
;
642 pos
->flags
= MAP_PRIVATE
;
643 pos
->parent
.rw_table
= read_dispatch_table
;
644 pos
->parent
.event_cb
= ctf_read_event
;
645 pos
->parent
.trace
= trace
;
648 pos
->prot
= PROT_WRITE
; /* Write has priority */
649 pos
->flags
= MAP_SHARED
;
650 pos
->parent
.rw_table
= write_dispatch_table
;
651 pos
->parent
.event_cb
= ctf_write_event
;
652 pos
->parent
.trace
= trace
;
654 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
662 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
664 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
665 *pos
->content_size_loc
= pos
->offset
;
670 ret
= munmap_align(pos
->base_mma
);
672 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
677 if (pos
->packet_cycles_index
)
678 (void) g_array_free(pos
->packet_cycles_index
, TRUE
);
679 if (pos
->packet_real_index
)
680 (void) g_array_free(pos
->packet_real_index
, TRUE
);
685 * for SEEK_CUR: go to next packet.
686 * for SEEK_SET: go to packet numer (index).
688 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
690 struct ctf_stream_pos
*pos
=
691 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
692 struct ctf_file_stream
*file_stream
=
693 container_of(pos
, struct ctf_file_stream
, pos
);
696 struct packet_index
*packet_index
;
700 case SEEK_SET
: /* Fall-through */
706 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
707 *pos
->content_size_loc
= pos
->offset
;
711 ret
= munmap_align(pos
->base_mma
);
713 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
717 pos
->base_mma
= NULL
;
721 * The caller should never ask for ctf_move_pos across packets,
722 * except to get exactly at the beginning of the next packet.
724 if (pos
->prot
== PROT_WRITE
) {
727 /* The writer will add padding */
728 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
731 assert(index
== 0); /* only seek supported for now */
737 pos
->content_size
= -1U; /* Unknown at this point */
738 pos
->packet_size
= WRITE_PACKET_LEN
;
739 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
740 pos
->packet_size
/ CHAR_BIT
);
748 uint64_t events_discarded_diff
;
750 if (pos
->offset
== EOF
) {
753 assert(pos
->cur_index
< pos
->packet_cycles_index
->len
);
754 assert(pos
->cur_index
< pos
->packet_real_index
->len
);
756 /* For printing discarded event count */
757 packet_index
= &g_array_index(pos
->packet_cycles_index
,
758 struct packet_index
, pos
->cur_index
);
759 file_stream
->parent
.prev_cycles_timestamp_end
=
760 packet_index
->timestamp_end
;
761 file_stream
->parent
.prev_cycles_timestamp
=
762 packet_index
->timestamp_begin
;
764 packet_index
= &g_array_index(pos
->packet_real_index
,
765 struct packet_index
, pos
->cur_index
);
766 file_stream
->parent
.prev_real_timestamp_end
=
767 packet_index
->timestamp_end
;
768 file_stream
->parent
.prev_real_timestamp
=
769 packet_index
->timestamp_begin
;
771 events_discarded_diff
= packet_index
->events_discarded
;
772 if (pos
->cur_index
> 0) {
773 packet_index
= &g_array_index(pos
->packet_real_index
,
776 events_discarded_diff
-= packet_index
->events_discarded
;
778 * Deal with 32-bit wrap-around if the
779 * tracer provided a 32-bit field.
781 if (packet_index
->events_discarded_len
== 32) {
782 events_discarded_diff
= (uint32_t) events_discarded_diff
;
785 file_stream
->parent
.events_discarded
= events_discarded_diff
;
786 file_stream
->parent
.prev_real_timestamp
= file_stream
->parent
.real_timestamp
;
787 file_stream
->parent
.prev_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
788 /* The reader will expect us to skip padding */
793 if (index
>= pos
->packet_cycles_index
->len
) {
797 packet_index
= &g_array_index(pos
->packet_cycles_index
,
798 struct packet_index
, index
);
799 pos
->last_events_discarded
= packet_index
->events_discarded
;
800 pos
->cur_index
= index
;
801 file_stream
->parent
.prev_real_timestamp
= 0;
802 file_stream
->parent
.prev_real_timestamp_end
= 0;
803 file_stream
->parent
.prev_cycles_timestamp
= 0;
804 file_stream
->parent
.prev_cycles_timestamp_end
= 0;
809 if (pos
->cur_index
>= pos
->packet_real_index
->len
) {
811 * We need to check if we are in trace read or
812 * called from packet indexing. In this last
813 * case, the collection is not there, so we
814 * cannot print the timestamps.
816 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
818 * When a stream reaches the end of the
819 * file, we need to show the number of
820 * events discarded ourselves, because
821 * there is no next event scheduled to
822 * be printed in the output.
824 if (file_stream
->parent
.events_discarded
) {
826 ctf_print_discarded(stderr
,
827 &file_stream
->parent
,
829 file_stream
->parent
.events_discarded
= 0;
835 packet_index
= &g_array_index(pos
->packet_cycles_index
,
838 file_stream
->parent
.cycles_timestamp
= packet_index
->timestamp_begin
;
840 packet_index
= &g_array_index(pos
->packet_real_index
,
843 file_stream
->parent
.real_timestamp
= packet_index
->timestamp_begin
;
844 pos
->mmap_offset
= packet_index
->offset
;
846 /* Lookup context/packet size in index */
847 pos
->content_size
= packet_index
->content_size
;
848 pos
->packet_size
= packet_index
->packet_size
;
849 if (packet_index
->data_offset
< packet_index
->content_size
) {
850 pos
->offset
= 0; /* will read headers */
851 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
853 pos
->offset
= packet_index
->data_offset
;
855 goto read_next_packet
;
861 /* map new base. Need mapping length from header. */
862 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
863 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
864 if (pos
->base_mma
== MAP_FAILED
) {
865 fprintf(stderr
, "[error] mmap error %s.\n",
870 /* update trace_packet_header and stream_packet_context */
871 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
872 /* Read packet header */
873 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
876 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
877 /* Read packet context */
878 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
884 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
890 len
= fread(&magic
, sizeof(magic
), 1, fp
);
894 if (magic
== TSDL_MAGIC
) {
896 td
->byte_order
= BYTE_ORDER
;
897 CTF_TRACE_SET_FIELD(td
, byte_order
);
898 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
900 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
901 LITTLE_ENDIAN
: BIG_ENDIAN
;
902 CTF_TRACE_SET_FIELD(td
, byte_order
);
910 * Returns 0 on success, -1 on error.
913 int check_version(unsigned int major
, unsigned int minor
)
928 /* eventually return an error instead of warning */
930 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
936 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
939 struct metadata_packet_header header
;
940 size_t readlen
, writelen
, toread
;
941 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
944 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
948 if (td
->byte_order
!= BYTE_ORDER
) {
949 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
950 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
951 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
952 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
955 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
956 if (header
.compression_scheme
) {
957 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
958 header
.compression_scheme
);
961 if (header
.encryption_scheme
) {
962 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
963 header
.encryption_scheme
);
966 if (header
.checksum_scheme
) {
967 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
968 header
.checksum_scheme
);
971 if (check_version(header
.major
, header
.minor
) < 0)
973 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
974 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
975 CTF_TRACE_SET_FIELD(td
, uuid
);
977 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
981 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
984 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
987 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
992 if (babeltrace_debug
) {
994 fprintf(stderr
, "[debug] metadata packet read: %s\n",
998 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
999 if (writelen
< readlen
) {
1009 ret
= 0; /* continue reading next packet */
1016 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1017 ret
= fseek(in
, toread
, SEEK_CUR
);
1019 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1026 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1030 size_t size
, buflen
;
1035 * Using strlen on *buf instead of size of open_memstream
1036 * because its size includes garbage at the end (after final
1037 * \0). This is the allocated size, not the actual string size.
1039 out
= babeltrace_open_memstream(buf
, &size
);
1041 perror("Metadata open_memstream");
1045 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
1054 /* close to flush the buffer */
1055 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1059 perror("babeltrace_flush_memstream");
1061 closeret
= fclose(in
);
1063 perror("Error in fclose");
1069 perror("Error in fclose");
1071 /* open for reading */
1072 buflen
= strlen(*buf
);
1077 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1079 perror("Metadata fmemopen");
1086 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
1087 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1088 int whence
), FILE *metadata_fp
)
1090 struct ctf_scanner
*scanner
;
1091 struct ctf_file_stream
*metadata_stream
;
1094 int ret
= 0, closeret
;
1096 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1097 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1100 metadata_stream
->pos
.packet_seek
= packet_seek
;
1102 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1109 metadata_stream
->pos
.fd
= -1;
1111 td
->metadata
= &metadata_stream
->parent
;
1112 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1113 if (metadata_stream
->pos
.fd
< 0) {
1114 fprintf(stderr
, "Unable to open metadata.\n");
1119 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1121 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1122 perror("Metadata stream open");
1126 /* fd now belongs to fp */
1127 metadata_stream
->pos
.fd
= -1;
1129 if (babeltrace_debug
)
1132 if (packet_metadata(td
, fp
)) {
1133 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
1135 /* Warn about empty metadata */
1136 fprintf(stderr
, "[warning] Empty metadata.\n");
1137 goto end_packet_read
;
1139 td
->metadata_string
= buf
;
1140 td
->metadata_packetized
= 1;
1142 unsigned int major
, minor
;
1145 td
->byte_order
= BYTE_ORDER
;
1147 /* Check text-only metadata header and version */
1148 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
1150 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1151 if (check_version(major
, minor
) < 0) {
1153 goto end_packet_read
;
1158 scanner
= ctf_scanner_alloc(fp
);
1160 fprintf(stderr
, "[error] Error allocating scanner\n");
1162 goto end_scanner_alloc
;
1164 ret
= ctf_scanner_append_ast(scanner
);
1166 fprintf(stderr
, "[error] Error creating AST\n");
1170 if (babeltrace_debug
) {
1171 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1173 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1178 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1180 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1183 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1184 td
, td
->byte_order
);
1186 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1190 ctf_scanner_free(scanner
);
1194 closeret
= fclose(fp
);
1196 perror("Error on fclose");
1200 if (metadata_stream
->pos
.fd
>= 0) {
1201 closeret
= close(metadata_stream
->pos
.fd
);
1203 perror("Error on metadata stream fd close");
1208 g_free(metadata_stream
);
1213 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1214 struct ctf_stream_definition
*stream
,
1215 struct ctf_event_declaration
*event
)
1217 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1219 if (event
->context_decl
) {
1220 struct bt_definition
*definition
=
1221 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1222 stream
->parent_def_scope
, 0, 0, "event.context");
1226 stream_event
->event_context
= container_of(definition
,
1227 struct definition_struct
, p
);
1228 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1230 if (event
->fields_decl
) {
1231 struct bt_definition
*definition
=
1232 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1233 stream
->parent_def_scope
, 0, 0, "event.fields");
1237 stream_event
->event_fields
= container_of(definition
,
1238 struct definition_struct
, p
);
1239 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1241 stream_event
->stream
= stream
;
1242 return stream_event
;
1245 if (stream_event
->event_fields
)
1246 bt_definition_unref(&stream_event
->event_fields
->p
);
1247 if (stream_event
->event_context
)
1248 bt_definition_unref(&stream_event
->event_context
->p
);
1249 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1250 g_quark_to_string(event
->name
));
1255 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1257 struct ctf_stream_declaration
*stream_class
;
1261 if (stream
->stream_definitions_created
)
1264 stream_class
= stream
->stream_class
;
1266 if (stream_class
->packet_context_decl
) {
1267 struct bt_definition
*definition
=
1268 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1269 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1274 stream
->stream_packet_context
= container_of(definition
,
1275 struct definition_struct
, p
);
1276 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1278 if (stream_class
->event_header_decl
) {
1279 struct bt_definition
*definition
=
1280 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1281 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1286 stream
->stream_event_header
=
1287 container_of(definition
, struct definition_struct
, p
);
1288 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1290 if (stream_class
->event_context_decl
) {
1291 struct bt_definition
*definition
=
1292 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1293 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1298 stream
->stream_event_context
=
1299 container_of(definition
, struct definition_struct
, p
);
1300 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1302 stream
->events_by_id
= g_ptr_array_new();
1303 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
1304 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1305 struct ctf_event_declaration
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
1306 struct ctf_event_definition
*stream_event
;
1310 stream_event
= create_event_definitions(td
, stream
, event
);
1311 if (!stream_event
) {
1315 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1320 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1321 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1323 g_free(stream_event
);
1325 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1327 if (stream
->stream_event_context
)
1328 bt_definition_unref(&stream
->stream_event_context
->p
);
1329 if (stream
->stream_event_header
)
1330 bt_definition_unref(&stream
->stream_event_header
->p
);
1331 if (stream
->stream_packet_context
)
1332 bt_definition_unref(&stream
->stream_packet_context
->p
);
1333 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1334 stream_class
->stream_id
, strerror(-ret
));
1339 int stream_assign_class(struct ctf_trace
*td
,
1340 struct ctf_file_stream
*file_stream
,
1343 struct ctf_stream_declaration
*stream
;
1346 file_stream
->parent
.stream_id
= stream_id
;
1347 if (stream_id
>= td
->streams
->len
) {
1348 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1351 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1353 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1356 file_stream
->parent
.stream_class
= stream
;
1357 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1364 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1365 struct ctf_trace
*td
,
1366 struct ctf_file_stream
*file_stream
,
1369 struct packet_index packet_index
;
1370 uint64_t stream_id
= 0;
1371 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1372 int first_packet
= 0;
1377 if (!pos
->mmap_offset
) {
1381 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1382 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1385 if (pos
->base_mma
) {
1386 /* unmap old base */
1387 ret
= munmap_align(pos
->base_mma
);
1389 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1393 pos
->base_mma
= NULL
;
1395 /* map new base. Need mapping length from header. */
1396 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1397 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1398 assert(pos
->base_mma
!= MAP_FAILED
);
1400 * Use current mapping size as temporary content and packet
1403 pos
->content_size
= packet_map_len
;
1404 pos
->packet_size
= packet_map_len
;
1405 pos
->offset
= 0; /* Position of the packet header */
1407 packet_index
.offset
= pos
->mmap_offset
;
1408 packet_index
.content_size
= 0;
1409 packet_index
.packet_size
= 0;
1410 packet_index
.timestamp_begin
= 0;
1411 packet_index
.timestamp_end
= 0;
1412 packet_index
.events_discarded
= 0;
1413 packet_index
.events_discarded_len
= 0;
1415 /* read and check header, set stream id (and check) */
1416 if (file_stream
->parent
.trace_packet_header
) {
1417 /* Read packet header */
1418 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1422 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1425 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1426 if (len_index
>= 0) {
1427 struct bt_definition
*field
;
1430 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1431 magic
= bt_get_unsigned_int(field
);
1432 if (magic
!= CTF_MAGIC
) {
1433 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1435 file_stream
->pos
.packet_cycles_index
->len
,
1436 (ssize_t
) pos
->mmap_offset
);
1442 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1443 if (len_index
>= 0) {
1444 struct definition_array
*defarray
;
1445 struct bt_definition
*field
;
1447 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1449 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1450 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1451 defarray
= container_of(field
, struct definition_array
, p
);
1452 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1454 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1455 struct bt_definition
*elem
;
1457 elem
= bt_array_index(defarray
, i
);
1458 uuidval
[i
] = bt_get_unsigned_int(elem
);
1460 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1462 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1467 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1468 if (len_index
>= 0) {
1469 struct bt_definition
*field
;
1471 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1472 stream_id
= bt_get_unsigned_int(field
);
1476 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1477 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1479 file_stream
->parent
.stream_id
);
1483 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1488 if (file_stream
->parent
.stream_packet_context
) {
1489 /* Read packet context */
1490 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1494 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1497 /* read packet size from header */
1498 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1499 if (len_index
>= 0) {
1500 struct bt_definition
*field
;
1502 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1503 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1505 /* Use file size for packet size */
1506 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1509 /* read content size from header */
1510 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1511 if (len_index
>= 0) {
1512 struct bt_definition
*field
;
1514 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1515 packet_index
.content_size
= bt_get_unsigned_int(field
);
1517 /* Use packet size if non-zero, else file size */
1518 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1521 /* read timestamp begin from header */
1522 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1523 if (len_index
>= 0) {
1524 struct bt_definition
*field
;
1526 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1527 packet_index
.timestamp_begin
= bt_get_unsigned_int(field
);
1528 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1529 packet_index
.timestamp_begin
=
1530 ctf_get_real_timestamp(
1531 &file_stream
->parent
,
1532 packet_index
.timestamp_begin
);
1536 /* read timestamp end from header */
1537 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1538 if (len_index
>= 0) {
1539 struct bt_definition
*field
;
1541 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1542 packet_index
.timestamp_end
= bt_get_unsigned_int(field
);
1543 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1544 packet_index
.timestamp_end
=
1545 ctf_get_real_timestamp(
1546 &file_stream
->parent
,
1547 packet_index
.timestamp_end
);
1551 /* read events discarded from header */
1552 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1553 if (len_index
>= 0) {
1554 struct bt_definition
*field
;
1556 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1557 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1558 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1561 /* Use file size for packet size */
1562 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1563 /* Use packet size if non-zero, else file size */
1564 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1567 /* Validate content size and packet size values */
1568 if (packet_index
.content_size
> packet_index
.packet_size
) {
1569 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1570 packet_index
.content_size
, packet_index
.packet_size
);
1574 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1575 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1576 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1580 if (packet_index
.content_size
< pos
->offset
) {
1581 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1585 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1586 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1590 /* Save position after header and context */
1591 packet_index
.data_offset
= pos
->offset
;
1593 /* add index to packet array */
1594 g_array_append_val(file_stream
->pos
.packet_cycles_index
, packet_index
);
1596 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1600 /* Retry with larger mapping */
1602 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1604 * Reached EOF, but still expecting header/context data.
1606 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1609 /* Double the mapping len, and retry */
1610 tmp_map_len
= packet_map_len
<< 1;
1611 if (tmp_map_len
>> 1 != packet_map_len
) {
1613 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1616 packet_map_len
= tmp_map_len
;
1621 int create_stream_packet_index(struct ctf_trace
*td
,
1622 struct ctf_file_stream
*file_stream
)
1624 struct ctf_stream_pos
*pos
;
1625 struct stat filestats
;
1628 pos
= &file_stream
->pos
;
1630 ret
= fstat(pos
->fd
, &filestats
);
1634 /* Deal with empty files */
1635 if (!filestats
.st_size
) {
1636 if (file_stream
->parent
.trace_packet_header
1637 || file_stream
->parent
.stream_packet_context
) {
1639 * We expect a trace packet header and/or stream packet
1640 * context. Since a trace needs to have at least one
1641 * packet, empty files are therefore not accepted.
1643 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1647 * Without trace packet header nor stream packet
1648 * context, a one-packet trace can indeed be empty. This
1649 * is only valid if there is only one stream class: 0.
1651 ret
= stream_assign_class(td
, file_stream
, 0);
1658 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1659 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1668 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1672 if (td
->packet_header_decl
) {
1673 struct bt_definition
*definition
=
1674 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1675 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1680 stream
->trace_packet_header
=
1681 container_of(definition
, struct definition_struct
, p
);
1682 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1688 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
1693 int import_stream_packet_index(struct ctf_trace
*td
,
1694 struct ctf_file_stream
*file_stream
)
1696 struct ctf_stream_declaration
*stream
;
1697 struct ctf_stream_pos
*pos
;
1698 struct ctf_packet_index ctf_index
;
1699 struct ctf_packet_index_file_hdr index_hdr
;
1700 struct packet_index index
;
1703 int first_packet
= 1;
1706 pos
= &file_stream
->pos
;
1708 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
1710 perror("read index file header");
1714 /* Check the index header */
1715 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
1716 fprintf(stderr
, "[error] wrong index magic\n");
1720 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
1721 fprintf(stderr
, "[error] Incompatible index file %" PRIu64
1722 ".%" PRIu64
", supported %d.%d\n",
1723 be64toh(index_hdr
.index_major
),
1724 be64toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
1729 if (index_hdr
.packet_index_len
== 0) {
1730 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
1735 while ((index_read
= fread(&ctf_index
, index_hdr
.packet_index_len
, 1,
1736 pos
->index_fp
)) == 1) {
1739 memset(&index
, 0, sizeof(index
));
1740 index
.offset
= be64toh(ctf_index
.offset
);
1741 index
.packet_size
= be64toh(ctf_index
.packet_size
);
1742 index
.content_size
= be64toh(ctf_index
.content_size
);
1743 index
.timestamp_begin
= be64toh(ctf_index
.timestamp_begin
);
1744 index
.timestamp_end
= be64toh(ctf_index
.timestamp_end
);
1745 index
.events_discarded
= be64toh(ctf_index
.events_discarded
);
1746 index
.events_discarded_len
= 64;
1747 stream_id
= be64toh(ctf_index
.stream_id
);
1749 if (!first_packet
) {
1750 /* add index to packet array */
1751 g_array_append_val(file_stream
->pos
.packet_cycles_index
, index
);
1755 file_stream
->parent
.stream_id
= stream_id
;
1756 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1758 fprintf(stderr
, "[error] Stream %" PRIu64
1759 " is not declared in metadata.\n",
1764 file_stream
->parent
.stream_class
= stream
;
1765 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1769 /* add index to packet array */
1770 g_array_append_val(file_stream
->pos
.packet_cycles_index
, index
);
1780 * Note: many file streams can inherit from the same stream class
1781 * description (metadata).
1784 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1785 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1788 int ret
, fd
, closeret
;
1789 struct ctf_file_stream
*file_stream
;
1790 struct stat statbuf
;
1793 fd
= openat(td
->dirfd
, path
, flags
);
1795 perror("File stream openat()");
1800 /* Don't try to mmap subdirectories. Skip them, return success. */
1801 ret
= fstat(fd
, &statbuf
);
1803 perror("File stream fstat()");
1806 if (S_ISDIR(statbuf
.st_mode
)) {
1807 if (strncmp(path
, "index", 5) != 0) {
1808 fprintf(stderr
, "[warning] Skipping directory '%s' "
1809 "found in trace\n", path
);
1815 file_stream
= g_new0(struct ctf_file_stream
, 1);
1816 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1817 file_stream
->pos
.fd
= -1;
1818 file_stream
->pos
.index_fp
= NULL
;
1820 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
1821 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
1824 file_stream
->pos
.packet_seek
= packet_seek
;
1826 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1831 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
1834 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1838 * For now, only a single clock per trace is supported.
1840 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
1843 * Allocate the index name for this stream and try to open it.
1845 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
1847 fprintf(stderr
, "[error] Cannot allocate index filename\n");
1850 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
1853 if (faccessat(td
->dirfd
, index_name
, O_RDONLY
, flags
) < 0) {
1854 ret
= create_stream_packet_index(td
, file_stream
);
1856 fprintf(stderr
, "[error] Stream index creation error.\n");
1860 ret
= openat(td
->dirfd
, index_name
, flags
);
1862 perror("Index file openat()");
1866 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
1867 if (!file_stream
->pos
.index_fp
) {
1868 perror("fdopen() error");
1871 ret
= import_stream_packet_index(td
, file_stream
);
1876 ret
= fclose(file_stream
->pos
.index_fp
);
1878 perror("close index");
1884 /* Add stream file to stream class */
1885 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1886 &file_stream
->parent
);
1890 if (file_stream
->pos
.index_fp
) {
1891 ret
= fclose(file_stream
->pos
.index_fp
);
1893 perror("close index");
1896 if (file_stream
->parent
.trace_packet_header
)
1897 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1901 closeret
= ctf_fini_pos(&file_stream
->pos
);
1903 fprintf(stderr
, "Error on ctf_fini_pos\n");
1905 g_free(file_stream
);
1908 closeret
= close(fd
);
1910 perror("Error on fd close");
1917 int ctf_open_trace_read(struct ctf_trace
*td
,
1918 const char *path
, int flags
,
1919 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1920 int whence
), FILE *metadata_fp
)
1923 struct dirent
*dirent
;
1924 struct dirent
*diriter
;
1930 /* Open trace directory */
1931 td
->dir
= opendir(path
);
1933 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
1938 td
->dirfd
= open(path
, 0);
1939 if (td
->dirfd
< 0) {
1940 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
1941 perror("Trace directory open");
1945 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
1946 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
1949 * Keep the metadata file separate.
1952 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1954 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
1955 goto error_metadata
;
1959 * Open each stream: for each file, try to open, check magic
1960 * number, and get the stream ID to add to the right location in
1964 dirent_len
= offsetof(struct dirent
, d_name
) +
1965 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1967 dirent
= malloc(dirent_len
);
1970 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1972 fprintf(stderr
, "[error] Readdir error.\n");
1977 /* Ignore hidden files, ., .. and metadata. */
1978 if (!strncmp(diriter
->d_name
, ".", 1)
1979 || !strcmp(diriter
->d_name
, "..")
1980 || !strcmp(diriter
->d_name
, "metadata"))
1983 /* Ignore index files : *.idx */
1984 ext
= strrchr(diriter
->d_name
, '.');
1985 if (ext
&& (!strcmp(ext
, ".idx"))) {
1989 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1990 flags
, packet_seek
);
1992 fprintf(stderr
, "[error] Open file stream error.\n");
2003 closeret
= close(td
->dirfd
);
2005 perror("Error on fd close");
2008 closeret
= closedir(td
->dir
);
2010 perror("Error on closedir");
2017 * ctf_open_trace: Open a CTF trace and index it.
2018 * Note that the user must seek the trace after the open (using the iterator)
2019 * since the index creation read it entirely.
2022 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2023 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2024 int whence
), FILE *metadata_fp
)
2026 struct ctf_trace
*td
;
2030 * If packet_seek is NULL, we provide our default version.
2033 packet_seek
= ctf_packet_seek
;
2035 td
= g_new0(struct ctf_trace
, 1);
2037 switch (flags
& O_ACCMODE
) {
2040 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2043 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2048 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2051 fprintf(stderr
, "[error] Incorrect open flags.\n");
2062 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2063 struct bt_mmap_stream
*mmap_info
)
2065 pos
->mmap_offset
= 0;
2066 pos
->packet_size
= 0;
2067 pos
->content_size
= 0;
2068 pos
->content_size_loc
= NULL
;
2069 pos
->fd
= mmap_info
->fd
;
2070 pos
->base_mma
= NULL
;
2074 pos
->packet_cycles_index
= NULL
;
2075 pos
->packet_real_index
= NULL
;
2076 pos
->prot
= PROT_READ
;
2077 pos
->flags
= MAP_PRIVATE
;
2078 pos
->parent
.rw_table
= read_dispatch_table
;
2079 pos
->parent
.event_cb
= ctf_read_event
;
2083 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2084 struct ctf_file_stream
*file_stream
)
2086 struct ctf_stream_declaration
*stream
;
2087 uint64_t stream_id
= 0;
2090 file_stream
->parent
.stream_id
= stream_id
;
2091 if (stream_id
>= td
->streams
->len
) {
2092 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2093 "in metadata.\n", stream_id
);
2097 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2099 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2100 "in metadata.\n", stream_id
);
2104 file_stream
->parent
.stream_class
= stream
;
2105 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2111 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2112 struct bt_mmap_stream
*mmap_info
,
2113 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2117 struct ctf_file_stream
*file_stream
;
2119 file_stream
= g_new0(struct ctf_file_stream
, 1);
2120 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2121 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2123 file_stream
->pos
.packet_seek
= packet_seek
;
2125 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2130 ret
= prepare_mmap_stream_definition(td
, file_stream
);
2135 * For now, only a single clock per trace is supported.
2137 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2139 /* Add stream file to stream class */
2140 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2141 &file_stream
->parent
);
2145 if (file_stream
->parent
.trace_packet_header
)
2146 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2148 g_free(file_stream
);
2153 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2154 struct bt_mmap_stream_list
*mmap_list
,
2155 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2160 struct bt_mmap_stream
*mmap_info
;
2162 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
2168 * for each stream, try to open, check magic number, and get the
2169 * stream ID to add to the right location in the stream array.
2171 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2172 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2174 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2186 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2187 struct bt_mmap_stream_list
*mmap_list
,
2188 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2192 struct ctf_trace
*td
;
2196 fprintf(stderr
, "[error] No metadata file pointer associated, "
2197 "required for mmap parsing\n");
2201 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2204 td
= g_new0(struct ctf_trace
, 1);
2205 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2218 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2221 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2223 /* for each stream_class */
2224 for (i
= 0; i
< td
->streams
->len
; i
++) {
2225 struct ctf_stream_declaration
*stream_class
;
2227 stream_class
= g_ptr_array_index(td
->streams
, i
);
2230 /* for each file_stream */
2231 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2232 struct ctf_stream_definition
*stream
;
2233 struct ctf_stream_pos
*stream_pos
;
2234 struct ctf_file_stream
*cfs
;
2236 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2239 cfs
= container_of(stream
, struct ctf_file_stream
,
2241 stream_pos
= &cfs
->pos
;
2242 if (!stream_pos
->packet_cycles_index
)
2245 for (k
= 0; k
< stream_pos
->packet_cycles_index
->len
; k
++) {
2246 struct packet_index
*index
;
2247 struct packet_index new_index
;
2249 index
= &g_array_index(stream_pos
->packet_cycles_index
,
2250 struct packet_index
, k
);
2251 memcpy(&new_index
, index
,
2252 sizeof(struct packet_index
));
2253 new_index
.timestamp_begin
=
2254 ctf_get_real_timestamp(stream
,
2255 index
->timestamp_begin
);
2256 new_index
.timestamp_end
=
2257 ctf_get_real_timestamp(stream
,
2258 index
->timestamp_end
);
2259 g_array_append_val(stream_pos
->packet_real_index
,
2268 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2272 ret
= ctf_fini_pos(&file_stream
->pos
);
2274 fprintf(stderr
, "Error on ctf_fini_pos\n");
2277 ret
= close(file_stream
->pos
.fd
);
2279 perror("Error closing file fd");
2286 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2288 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2294 for (i
= 0; i
< td
->streams
->len
; i
++) {
2295 struct ctf_stream_declaration
*stream
;
2298 stream
= g_ptr_array_index(td
->streams
, i
);
2301 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2302 struct ctf_file_stream
*file_stream
;
2303 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2304 struct ctf_file_stream
, parent
);
2305 ret
= ctf_close_file_stream(file_stream
);
2311 ctf_destroy_metadata(td
);
2312 ret
= close(td
->dirfd
);
2314 perror("Error closing dirfd");
2317 ret
= closedir(td
->dir
);
2319 perror("Error closedir");
2322 free(td
->metadata_string
);
2328 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2329 struct bt_context
*ctx
)
2331 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2334 td
->parent
.ctx
= ctx
;
2338 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2339 struct bt_trace_handle
*handle
)
2341 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2344 td
->parent
.handle
= handle
;
2348 void __attribute__((constructor
)) ctf_init(void)
2352 ctf_format
.name
= g_quark_from_static_string("ctf");
2353 ret
= bt_register_format(&ctf_format
);
2358 void __attribute__((destructor
)) ctf_exit(void)
2360 bt_unregister_format(&ctf_format
);