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_index
)
187 if (stream_pos
->packet_index
->len
<= 0)
190 index
= &g_array_index(stream_pos
->packet_index
,
192 stream_pos
->packet_index
->len
- 1);
193 if (type
== BT_CLOCK_REAL
) {
194 if (index
->ts_real
.timestamp_begin
< begin
)
195 begin
= index
->ts_real
.timestamp_begin
;
196 } else if (type
== BT_CLOCK_CYCLES
) {
197 if (index
->ts_cycles
.timestamp_begin
< begin
)
198 begin
= index
->ts_cycles
.timestamp_begin
;
212 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
213 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
215 struct ctf_trace
*tin
;
219 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
224 /* for each stream_class */
225 for (i
= 0; i
< tin
->streams
->len
; i
++) {
226 struct ctf_stream_declaration
*stream_class
;
228 stream_class
= g_ptr_array_index(tin
->streams
, i
);
231 /* for each file_stream */
232 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
233 struct ctf_stream_definition
*stream
;
234 struct ctf_file_stream
*cfs
;
235 struct ctf_stream_pos
*stream_pos
;
236 struct packet_index
*index
;
238 stream
= g_ptr_array_index(stream_class
->streams
, j
);
239 cfs
= container_of(stream
, struct ctf_file_stream
,
241 stream_pos
= &cfs
->pos
;
243 if (!stream_pos
->packet_index
)
246 if (stream_pos
->packet_index
->len
<= 0)
249 index
= &g_array_index(stream_pos
->packet_index
,
251 stream_pos
->packet_index
->len
- 1);
252 if (type
== BT_CLOCK_REAL
) {
253 if (index
->ts_real
.timestamp_end
> end
)
254 end
= index
->ts_real
.timestamp_end
;
255 } else if (type
== BT_CLOCK_CYCLES
) {
256 if (index
->ts_cycles
.timestamp_end
> end
)
257 end
= index
->ts_cycles
.timestamp_end
;
271 * Update stream current timestamp
274 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
275 struct definition_integer
*integer_definition
)
277 struct declaration_integer
*integer_declaration
=
278 integer_definition
->declaration
;
279 uint64_t oldval
, newval
, updateval
;
281 if (unlikely(integer_declaration
->len
== 64)) {
282 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
283 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
284 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
285 stream
->prev_cycles_timestamp
);
286 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
287 stream
->cycles_timestamp
);
291 oldval
= stream
->cycles_timestamp
;
292 oldval
&= (1ULL << integer_declaration
->len
) - 1;
293 newval
= integer_definition
->value
._unsigned
;
294 /* Test for overflow by comparing low bits */
296 newval
+= 1ULL << integer_declaration
->len
;
297 /* updateval contains old high bits, and new low bits (sum) */
298 updateval
= stream
->cycles_timestamp
;
299 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
301 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
302 stream
->cycles_timestamp
= updateval
;
304 /* convert to real timestamp */
305 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
306 stream
->prev_cycles_timestamp
);
307 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
308 stream
->cycles_timestamp
);
312 * Print timestamp, rescaling clock frequency to nanoseconds and
313 * applying offsets as needed (unix time).
316 void ctf_print_timestamp_real(FILE *fp
,
317 struct ctf_stream_definition
*stream
,
320 uint64_t ts_sec
= 0, ts_nsec
;
324 /* Add command-line offset in ns*/
325 ts_nsec
+= opt_clock_offset_ns
;
327 /* Add command-line offset */
328 ts_sec
+= opt_clock_offset
;
330 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
331 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
333 if (!opt_clock_seconds
) {
335 time_t time_s
= (time_t) ts_sec
;
337 if (!opt_clock_gmt
) {
340 res
= localtime_r(&time_s
, &tm
);
342 fprintf(stderr
, "[warning] Unable to get localtime.\n");
348 res
= gmtime_r(&time_s
, &tm
);
350 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
354 if (opt_clock_date
) {
358 /* Print date and time */
359 res
= strftime(timestr
, sizeof(timestr
),
362 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
365 fprintf(fp
, "%s", timestr
);
367 /* Print time in HH:MM:SS.ns */
368 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
369 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
373 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
381 * Print timestamp, in cycles
384 void ctf_print_timestamp_cycles(FILE *fp
,
385 struct ctf_stream_definition
*stream
,
388 fprintf(fp
, "%020" PRIu64
, timestamp
);
391 void ctf_print_timestamp(FILE *fp
,
392 struct ctf_stream_definition
*stream
,
395 if (opt_clock_cycles
) {
396 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
398 ctf_print_timestamp_real(fp
, stream
, timestamp
);
403 void print_uuid(FILE *fp
, unsigned char *uuid
)
407 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
408 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
411 void ctf_print_discarded(FILE *fp
, struct ctf_stream_definition
*stream
,
414 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events %sbetween [",
415 stream
->events_discarded
,
416 end_stream
? "at end of stream " : "");
417 if (opt_clock_cycles
) {
418 ctf_print_timestamp(fp
, stream
,
419 stream
->prev_cycles_timestamp
);
420 fprintf(fp
, "] and [");
421 ctf_print_timestamp(fp
, stream
,
422 stream
->prev_cycles_timestamp_end
);
424 ctf_print_timestamp(fp
, stream
,
425 stream
->prev_real_timestamp
);
426 fprintf(fp
, "] and [");
427 ctf_print_timestamp(fp
, stream
,
428 stream
->prev_real_timestamp_end
);
430 fprintf(fp
, "] in trace UUID ");
431 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
432 if (stream
->stream_class
->trace
->parent
.path
[0])
433 fprintf(fp
, ", at path: \"%s\"",
434 stream
->stream_class
->trace
->parent
.path
);
436 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
438 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
440 fprintf(fp
, "You should consider recording a new trace with larger "
441 "buffers or with fewer events enabled.\n");
446 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
448 struct ctf_stream_pos
*pos
=
449 container_of(ppos
, struct ctf_stream_pos
, parent
);
450 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
451 struct ctf_event_definition
*event
;
455 /* We need to check for EOF here for empty files. */
456 if (unlikely(pos
->offset
== EOF
))
459 ctf_pos_get_event(pos
);
461 /* save the current position as a restore point */
462 pos
->last_offset
= pos
->offset
;
465 * This is the EOF check after we've advanced the position in
468 if (unlikely(pos
->offset
== EOF
))
471 /* Stream is inactive for now (live reading). */
472 if (unlikely(pos
->content_size
== 0))
476 * Packet seeked to by ctf_pos_get_event() only contains
477 * headers, no event. Consider stream as inactive (live
480 if (unlikely(pos
->data_offset
== pos
->content_size
))
483 assert(pos
->offset
< pos
->content_size
);
485 /* Read event header */
486 if (likely(stream
->stream_event_header
)) {
487 struct definition_integer
*integer_definition
;
488 struct bt_definition
*variant
;
490 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
493 /* lookup event id */
494 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
495 if (integer_definition
) {
496 id
= integer_definition
->value
._unsigned
;
498 struct definition_enum
*enum_definition
;
500 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
501 if (enum_definition
) {
502 id
= enum_definition
->integer
->value
._unsigned
;
506 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
508 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
509 if (integer_definition
) {
510 id
= integer_definition
->value
._unsigned
;
513 stream
->event_id
= id
;
515 /* lookup timestamp */
516 stream
->has_timestamp
= 0;
517 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
518 if (integer_definition
) {
519 ctf_update_timestamp(stream
, integer_definition
);
520 stream
->has_timestamp
= 1;
523 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
524 if (integer_definition
) {
525 ctf_update_timestamp(stream
, integer_definition
);
526 stream
->has_timestamp
= 1;
532 /* Read stream-declared event context */
533 if (stream
->stream_event_context
) {
534 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
539 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
540 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
543 event
= g_ptr_array_index(stream
->events_by_id
, id
);
544 if (unlikely(!event
)) {
545 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
549 /* Read event-declared event context */
550 if (event
->event_context
) {
551 ret
= generic_rw(ppos
, &event
->event_context
->p
);
556 /* Read event payload */
557 if (likely(event
->event_fields
)) {
558 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
563 if (pos
->last_offset
== pos
->offset
) {
564 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
571 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
576 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
578 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
579 struct ctf_event_definition
*event
;
583 id
= stream
->event_id
;
585 /* print event header */
586 if (likely(stream
->stream_event_header
)) {
587 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
592 /* print stream-declared event context */
593 if (stream
->stream_event_context
) {
594 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
599 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
600 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
603 event
= g_ptr_array_index(stream
->events_by_id
, id
);
604 if (unlikely(!event
)) {
605 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
609 /* print event-declared event context */
610 if (event
->event_context
) {
611 ret
= generic_rw(pos
, &event
->event_context
->p
);
616 /* Read and print event payload */
617 if (likely(event
->event_fields
)) {
618 ret
= generic_rw(pos
, &event
->event_fields
->p
);
626 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
631 * One side-effect of this function is to unmap pos mmap base if one is
635 int find_data_offset(struct ctf_stream_pos
*pos
,
636 struct ctf_file_stream
*file_stream
,
637 struct packet_index
*packet_index
)
639 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
640 struct stat filestats
;
644 pos
= &file_stream
->pos
;
646 ret
= fstat(pos
->fd
, &filestats
);
649 filesize
= filestats
.st_size
;
651 /* Deal with empty files */
657 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
658 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
663 ret
= munmap_align(pos
->base_mma
);
665 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
669 pos
->base_mma
= NULL
;
671 /* map new base. Need mapping length from header. */
672 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
673 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
674 assert(pos
->base_mma
!= MAP_FAILED
);
676 pos
->content_size
= packet_map_len
;
677 pos
->packet_size
= packet_map_len
;
678 pos
->offset
= 0; /* Position of the packet header */
680 /* update trace_packet_header and stream_packet_context */
681 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
682 /* Read packet header */
683 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
689 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
690 /* Read packet context */
691 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
697 packet_index
->data_offset
= pos
->offset
;
700 ret
= munmap_align(pos
->base_mma
);
702 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
706 pos
->base_mma
= NULL
;
710 /* Retry with larger mapping */
712 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
714 * Reached EOF, but still expecting header/context data.
716 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
719 /* Double the mapping len, and retry */
720 tmp_map_len
= packet_map_len
<< 1;
721 if (tmp_map_len
>> 1 != packet_map_len
) {
723 fprintf(stderr
, "[error] Packet mapping length overflow\n");
726 packet_map_len
= tmp_map_len
;
731 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
732 int fd
, int open_flags
)
736 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
737 sizeof(struct packet_index
));
739 pos
->packet_index
= NULL
;
741 switch (open_flags
& O_ACCMODE
) {
743 pos
->prot
= PROT_READ
;
744 pos
->flags
= MAP_PRIVATE
;
745 pos
->parent
.rw_table
= read_dispatch_table
;
746 pos
->parent
.event_cb
= ctf_read_event
;
747 pos
->parent
.trace
= trace
;
750 pos
->prot
= PROT_WRITE
; /* Write has priority */
751 pos
->flags
= MAP_SHARED
;
752 pos
->parent
.rw_table
= write_dispatch_table
;
753 pos
->parent
.event_cb
= ctf_write_event
;
754 pos
->parent
.trace
= trace
;
756 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
764 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
766 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
767 *pos
->content_size_loc
= pos
->offset
;
772 ret
= munmap_align(pos
->base_mma
);
774 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
779 if (pos
->packet_index
)
780 (void) g_array_free(pos
->packet_index
, TRUE
);
785 * for SEEK_CUR: go to next packet.
786 * for SEEK_SET: go to packet numer (index).
788 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
790 struct ctf_stream_pos
*pos
=
791 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
792 struct ctf_file_stream
*file_stream
=
793 container_of(pos
, struct ctf_file_stream
, pos
);
796 struct packet_index
*packet_index
;
800 case SEEK_SET
: /* Fall-through */
806 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
807 *pos
->content_size_loc
= pos
->offset
;
811 ret
= munmap_align(pos
->base_mma
);
813 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
817 pos
->base_mma
= NULL
;
821 * The caller should never ask for ctf_move_pos across packets,
822 * except to get exactly at the beginning of the next packet.
824 if (pos
->prot
== PROT_WRITE
) {
827 /* The writer will add padding */
828 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
831 assert(index
== 0); /* only seek supported for now */
837 pos
->content_size
= -1U; /* Unknown at this point */
838 pos
->packet_size
= WRITE_PACKET_LEN
;
839 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
840 pos
->packet_size
/ CHAR_BIT
);
848 uint64_t events_discarded_diff
;
850 if (pos
->offset
== EOF
) {
853 assert(pos
->cur_index
< pos
->packet_index
->len
);
855 /* For printing discarded event count */
856 packet_index
= &g_array_index(pos
->packet_index
,
857 struct packet_index
, pos
->cur_index
);
858 file_stream
->parent
.prev_cycles_timestamp_end
=
859 packet_index
->ts_cycles
.timestamp_end
;
860 file_stream
->parent
.prev_cycles_timestamp
=
861 packet_index
->ts_cycles
.timestamp_begin
;
862 file_stream
->parent
.prev_real_timestamp_end
=
863 packet_index
->ts_real
.timestamp_end
;
864 file_stream
->parent
.prev_real_timestamp
=
865 packet_index
->ts_real
.timestamp_begin
;
867 events_discarded_diff
= packet_index
->events_discarded
;
868 if (pos
->cur_index
> 0) {
869 packet_index
= &g_array_index(pos
->packet_index
,
872 events_discarded_diff
-= packet_index
->events_discarded
;
874 * Deal with 32-bit wrap-around if the
875 * tracer provided a 32-bit field.
877 if (packet_index
->events_discarded_len
== 32) {
878 events_discarded_diff
= (uint32_t) events_discarded_diff
;
881 file_stream
->parent
.events_discarded
= events_discarded_diff
;
882 file_stream
->parent
.prev_real_timestamp
= file_stream
->parent
.real_timestamp
;
883 file_stream
->parent
.prev_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
884 /* The reader will expect us to skip padding */
889 if (index
>= pos
->packet_index
->len
) {
893 packet_index
= &g_array_index(pos
->packet_index
,
894 struct packet_index
, index
);
895 pos
->last_events_discarded
= packet_index
->events_discarded
;
896 pos
->cur_index
= index
;
897 file_stream
->parent
.prev_real_timestamp
= 0;
898 file_stream
->parent
.prev_real_timestamp_end
= 0;
899 file_stream
->parent
.prev_cycles_timestamp
= 0;
900 file_stream
->parent
.prev_cycles_timestamp_end
= 0;
905 if (pos
->cur_index
>= pos
->packet_index
->len
) {
907 * We need to check if we are in trace read or
908 * called from packet indexing. In this last
909 * case, the collection is not there, so we
910 * cannot print the timestamps.
912 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
914 * When a stream reaches the end of the
915 * file, we need to show the number of
916 * events discarded ourselves, because
917 * there is no next event scheduled to
918 * be printed in the output.
920 if (file_stream
->parent
.events_discarded
) {
922 ctf_print_discarded(stderr
,
923 &file_stream
->parent
,
925 file_stream
->parent
.events_discarded
= 0;
931 packet_index
= &g_array_index(pos
->packet_index
,
934 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
936 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
938 /* Lookup context/packet size in index */
939 if (packet_index
->data_offset
== -1) {
940 ret
= find_data_offset(pos
, file_stream
, packet_index
);
945 pos
->content_size
= packet_index
->content_size
;
946 pos
->packet_size
= packet_index
->packet_size
;
947 pos
->mmap_offset
= packet_index
->offset
;
948 pos
->data_offset
= packet_index
->data_offset
;
949 if (pos
->data_offset
< packet_index
->content_size
) {
950 pos
->offset
= 0; /* will read headers */
951 } else if (pos
->data_offset
== packet_index
->content_size
) {
953 pos
->offset
= packet_index
->data_offset
;
955 goto read_next_packet
;
961 /* map new base. Need mapping length from header. */
962 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
963 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
964 if (pos
->base_mma
== MAP_FAILED
) {
965 fprintf(stderr
, "[error] mmap error %s.\n",
970 /* update trace_packet_header and stream_packet_context */
971 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
972 /* Read packet header */
973 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
976 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
977 /* Read packet context */
978 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
984 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
990 len
= fread(&magic
, sizeof(magic
), 1, fp
);
994 if (magic
== TSDL_MAGIC
) {
996 td
->byte_order
= BYTE_ORDER
;
997 CTF_TRACE_SET_FIELD(td
, byte_order
);
998 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1000 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1001 LITTLE_ENDIAN
: BIG_ENDIAN
;
1002 CTF_TRACE_SET_FIELD(td
, byte_order
);
1010 * Returns 0 on success, -1 on error.
1013 int check_version(unsigned int major
, unsigned int minor
)
1028 /* eventually return an error instead of warning */
1030 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1036 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1039 struct metadata_packet_header header
;
1040 size_t readlen
, writelen
, toread
;
1041 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1044 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1048 if (td
->byte_order
!= BYTE_ORDER
) {
1049 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1050 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1051 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1052 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1054 if (header
.checksum
)
1055 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1056 if (header
.compression_scheme
) {
1057 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1058 header
.compression_scheme
);
1061 if (header
.encryption_scheme
) {
1062 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1063 header
.encryption_scheme
);
1066 if (header
.checksum_scheme
) {
1067 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1068 header
.checksum_scheme
);
1071 if (check_version(header
.major
, header
.minor
) < 0)
1073 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1074 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1075 CTF_TRACE_SET_FIELD(td
, uuid
);
1077 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
1081 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1084 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1087 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1092 if (babeltrace_debug
) {
1093 buf
[readlen
] = '\0';
1094 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1098 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1099 if (writelen
< readlen
) {
1109 ret
= 0; /* continue reading next packet */
1116 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1117 ret
= fseek(in
, toread
, SEEK_CUR
);
1119 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1126 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1130 size_t size
, buflen
;
1135 * Using strlen on *buf instead of size of open_memstream
1136 * because its size includes garbage at the end (after final
1137 * \0). This is the allocated size, not the actual string size.
1139 out
= babeltrace_open_memstream(buf
, &size
);
1141 perror("Metadata open_memstream");
1145 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
1154 /* close to flush the buffer */
1155 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1159 perror("babeltrace_flush_memstream");
1161 closeret
= fclose(in
);
1163 perror("Error in fclose");
1169 perror("Error in fclose");
1171 /* open for reading */
1172 buflen
= strlen(*buf
);
1177 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1179 perror("Metadata fmemopen");
1186 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
1187 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1188 int whence
), FILE *metadata_fp
)
1190 struct ctf_scanner
*scanner
;
1191 struct ctf_file_stream
*metadata_stream
;
1194 int ret
= 0, closeret
;
1196 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1197 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1200 metadata_stream
->pos
.packet_seek
= packet_seek
;
1202 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1209 metadata_stream
->pos
.fd
= -1;
1211 td
->metadata
= &metadata_stream
->parent
;
1212 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1213 if (metadata_stream
->pos
.fd
< 0) {
1214 fprintf(stderr
, "Unable to open metadata.\n");
1219 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1221 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1222 perror("Metadata stream open");
1226 /* fd now belongs to fp */
1227 metadata_stream
->pos
.fd
= -1;
1229 if (babeltrace_debug
)
1232 if (packet_metadata(td
, fp
)) {
1233 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
1235 /* Warn about empty metadata */
1236 fprintf(stderr
, "[warning] Empty metadata.\n");
1237 goto end_packet_read
;
1239 td
->metadata_string
= buf
;
1240 td
->metadata_packetized
= 1;
1242 unsigned int major
, minor
;
1245 td
->byte_order
= BYTE_ORDER
;
1247 /* Check text-only metadata header and version */
1248 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
1250 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1251 if (check_version(major
, minor
) < 0) {
1253 goto end_packet_read
;
1258 scanner
= ctf_scanner_alloc(fp
);
1260 fprintf(stderr
, "[error] Error allocating scanner\n");
1262 goto end_scanner_alloc
;
1264 ret
= ctf_scanner_append_ast(scanner
);
1266 fprintf(stderr
, "[error] Error creating AST\n");
1270 if (babeltrace_debug
) {
1271 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1273 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1278 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1280 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1283 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1284 td
, td
->byte_order
);
1286 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1290 ctf_scanner_free(scanner
);
1294 closeret
= fclose(fp
);
1296 perror("Error on fclose");
1300 if (metadata_stream
->pos
.fd
>= 0) {
1301 closeret
= close(metadata_stream
->pos
.fd
);
1303 perror("Error on metadata stream fd close");
1308 g_free(metadata_stream
);
1313 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1314 struct ctf_stream_definition
*stream
,
1315 struct ctf_event_declaration
*event
)
1317 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1319 if (event
->context_decl
) {
1320 struct bt_definition
*definition
=
1321 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1322 stream
->parent_def_scope
, 0, 0, "event.context");
1326 stream_event
->event_context
= container_of(definition
,
1327 struct definition_struct
, p
);
1328 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1330 if (event
->fields_decl
) {
1331 struct bt_definition
*definition
=
1332 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1333 stream
->parent_def_scope
, 0, 0, "event.fields");
1337 stream_event
->event_fields
= container_of(definition
,
1338 struct definition_struct
, p
);
1339 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1341 stream_event
->stream
= stream
;
1342 return stream_event
;
1345 if (stream_event
->event_fields
)
1346 bt_definition_unref(&stream_event
->event_fields
->p
);
1347 if (stream_event
->event_context
)
1348 bt_definition_unref(&stream_event
->event_context
->p
);
1349 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1350 g_quark_to_string(event
->name
));
1355 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1357 struct ctf_stream_declaration
*stream_class
;
1361 if (stream
->stream_definitions_created
)
1364 stream_class
= stream
->stream_class
;
1366 if (stream_class
->packet_context_decl
) {
1367 struct bt_definition
*definition
=
1368 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1369 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1374 stream
->stream_packet_context
= container_of(definition
,
1375 struct definition_struct
, p
);
1376 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1378 if (stream_class
->event_header_decl
) {
1379 struct bt_definition
*definition
=
1380 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1381 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1386 stream
->stream_event_header
=
1387 container_of(definition
, struct definition_struct
, p
);
1388 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1390 if (stream_class
->event_context_decl
) {
1391 struct bt_definition
*definition
=
1392 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1393 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1398 stream
->stream_event_context
=
1399 container_of(definition
, struct definition_struct
, p
);
1400 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1402 stream
->events_by_id
= g_ptr_array_new();
1403 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
1404 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1405 struct ctf_event_declaration
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
1406 struct ctf_event_definition
*stream_event
;
1410 stream_event
= create_event_definitions(td
, stream
, event
);
1411 if (!stream_event
) {
1415 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1420 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1421 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1423 g_free(stream_event
);
1425 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1427 if (stream
->stream_event_context
)
1428 bt_definition_unref(&stream
->stream_event_context
->p
);
1429 if (stream
->stream_event_header
)
1430 bt_definition_unref(&stream
->stream_event_header
->p
);
1431 if (stream
->stream_packet_context
)
1432 bt_definition_unref(&stream
->stream_packet_context
->p
);
1433 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1434 stream_class
->stream_id
, strerror(-ret
));
1439 int stream_assign_class(struct ctf_trace
*td
,
1440 struct ctf_file_stream
*file_stream
,
1443 struct ctf_stream_declaration
*stream
;
1446 file_stream
->parent
.stream_id
= stream_id
;
1447 if (stream_id
>= td
->streams
->len
) {
1448 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1451 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1453 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1456 file_stream
->parent
.stream_class
= stream
;
1457 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1464 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1465 struct ctf_trace
*td
,
1466 struct ctf_file_stream
*file_stream
,
1469 struct packet_index packet_index
;
1470 uint64_t stream_id
= 0;
1471 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1472 int first_packet
= 0;
1477 if (!pos
->mmap_offset
) {
1481 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1482 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1485 if (pos
->base_mma
) {
1486 /* unmap old base */
1487 ret
= munmap_align(pos
->base_mma
);
1489 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1493 pos
->base_mma
= NULL
;
1495 /* map new base. Need mapping length from header. */
1496 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1497 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1498 assert(pos
->base_mma
!= MAP_FAILED
);
1500 * Use current mapping size as temporary content and packet
1503 pos
->content_size
= packet_map_len
;
1504 pos
->packet_size
= packet_map_len
;
1505 pos
->offset
= 0; /* Position of the packet header */
1507 packet_index
.offset
= pos
->mmap_offset
;
1508 packet_index
.content_size
= 0;
1509 packet_index
.packet_size
= 0;
1510 packet_index
.ts_real
.timestamp_begin
= 0;
1511 packet_index
.ts_real
.timestamp_end
= 0;
1512 packet_index
.ts_cycles
.timestamp_begin
= 0;
1513 packet_index
.ts_cycles
.timestamp_end
= 0;
1514 packet_index
.events_discarded
= 0;
1515 packet_index
.events_discarded_len
= 0;
1517 /* read and check header, set stream id (and check) */
1518 if (file_stream
->parent
.trace_packet_header
) {
1519 /* Read packet header */
1520 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1524 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1527 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1528 if (len_index
>= 0) {
1529 struct bt_definition
*field
;
1532 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1533 magic
= bt_get_unsigned_int(field
);
1534 if (magic
!= CTF_MAGIC
) {
1535 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1537 file_stream
->pos
.packet_index
->len
,
1538 (ssize_t
) pos
->mmap_offset
);
1544 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1545 if (len_index
>= 0) {
1546 struct definition_array
*defarray
;
1547 struct bt_definition
*field
;
1549 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1551 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1552 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1553 defarray
= container_of(field
, struct definition_array
, p
);
1554 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1556 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1557 struct bt_definition
*elem
;
1559 elem
= bt_array_index(defarray
, i
);
1560 uuidval
[i
] = bt_get_unsigned_int(elem
);
1562 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1564 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1569 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1570 if (len_index
>= 0) {
1571 struct bt_definition
*field
;
1573 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1574 stream_id
= bt_get_unsigned_int(field
);
1578 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1579 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1581 file_stream
->parent
.stream_id
);
1585 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1590 if (file_stream
->parent
.stream_packet_context
) {
1591 /* Read packet context */
1592 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1596 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1599 /* read packet size from header */
1600 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1601 if (len_index
>= 0) {
1602 struct bt_definition
*field
;
1604 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1605 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1607 /* Use file size for packet size */
1608 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1611 /* read content size from header */
1612 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1613 if (len_index
>= 0) {
1614 struct bt_definition
*field
;
1616 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1617 packet_index
.content_size
= bt_get_unsigned_int(field
);
1619 /* Use packet size if non-zero, else file size */
1620 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1623 /* read timestamp begin from header */
1624 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1625 if (len_index
>= 0) {
1626 struct bt_definition
*field
;
1628 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1629 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1630 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1631 packet_index
.ts_real
.timestamp_begin
=
1632 ctf_get_real_timestamp(
1633 &file_stream
->parent
,
1634 packet_index
.ts_cycles
.timestamp_begin
);
1638 /* read timestamp end from header */
1639 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1640 if (len_index
>= 0) {
1641 struct bt_definition
*field
;
1643 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1644 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1645 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1646 packet_index
.ts_real
.timestamp_end
=
1647 ctf_get_real_timestamp(
1648 &file_stream
->parent
,
1649 packet_index
.ts_cycles
.timestamp_end
);
1653 /* read events discarded from header */
1654 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1655 if (len_index
>= 0) {
1656 struct bt_definition
*field
;
1658 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1659 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1660 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1663 /* Use file size for packet size */
1664 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1665 /* Use packet size if non-zero, else file size */
1666 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1669 /* Validate content size and packet size values */
1670 if (packet_index
.content_size
> packet_index
.packet_size
) {
1671 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1672 packet_index
.content_size
, packet_index
.packet_size
);
1676 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1677 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1678 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1682 if (packet_index
.content_size
< pos
->offset
) {
1683 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1687 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1688 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1692 /* Save position after header and context */
1693 packet_index
.data_offset
= pos
->offset
;
1695 /* add index to packet array */
1696 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1698 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1702 /* Retry with larger mapping */
1704 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1706 * Reached EOF, but still expecting header/context data.
1708 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1711 /* Double the mapping len, and retry */
1712 tmp_map_len
= packet_map_len
<< 1;
1713 if (tmp_map_len
>> 1 != packet_map_len
) {
1715 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1718 packet_map_len
= tmp_map_len
;
1723 int create_stream_packet_index(struct ctf_trace
*td
,
1724 struct ctf_file_stream
*file_stream
)
1726 struct ctf_stream_pos
*pos
;
1727 struct stat filestats
;
1730 pos
= &file_stream
->pos
;
1732 ret
= fstat(pos
->fd
, &filestats
);
1736 /* Deal with empty files */
1737 if (!filestats
.st_size
) {
1738 if (file_stream
->parent
.trace_packet_header
1739 || file_stream
->parent
.stream_packet_context
) {
1741 * We expect a trace packet header and/or stream packet
1742 * context. Since a trace needs to have at least one
1743 * packet, empty files are therefore not accepted.
1745 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1749 * Without trace packet header nor stream packet
1750 * context, a one-packet trace can indeed be empty. This
1751 * is only valid if there is only one stream class: 0.
1753 ret
= stream_assign_class(td
, file_stream
, 0);
1760 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1761 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1770 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1774 if (td
->packet_header_decl
) {
1775 struct bt_definition
*definition
=
1776 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1777 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1782 stream
->trace_packet_header
=
1783 container_of(definition
, struct definition_struct
, p
);
1784 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1790 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
1795 int import_stream_packet_index(struct ctf_trace
*td
,
1796 struct ctf_file_stream
*file_stream
)
1798 struct ctf_stream_declaration
*stream
;
1799 struct ctf_stream_pos
*pos
;
1800 struct ctf_packet_index ctf_index
;
1801 struct ctf_packet_index_file_hdr index_hdr
;
1802 struct packet_index index
;
1804 int first_packet
= 1;
1807 pos
= &file_stream
->pos
;
1809 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
1811 perror("read index file header");
1815 /* Check the index header */
1816 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
1817 fprintf(stderr
, "[error] wrong index magic\n");
1821 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
1822 fprintf(stderr
, "[error] Incompatible index file %" PRIu64
1823 ".%" PRIu64
", supported %d.%d\n",
1824 be64toh(index_hdr
.index_major
),
1825 be64toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
1830 if (index_hdr
.packet_index_len
== 0) {
1831 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
1836 while (fread(&ctf_index
, index_hdr
.packet_index_len
, 1,
1837 pos
->index_fp
) == 1) {
1840 memset(&index
, 0, sizeof(index
));
1841 index
.offset
= be64toh(ctf_index
.offset
);
1842 index
.packet_size
= be64toh(ctf_index
.packet_size
);
1843 index
.content_size
= be64toh(ctf_index
.content_size
);
1844 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
.timestamp_begin
);
1845 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
.timestamp_end
);
1846 index
.events_discarded
= be64toh(ctf_index
.events_discarded
);
1847 index
.events_discarded_len
= 64;
1848 index
.data_offset
= -1;
1849 stream_id
= be64toh(ctf_index
.stream_id
);
1851 if (!first_packet
) {
1852 /* add index to packet array */
1853 g_array_append_val(file_stream
->pos
.packet_index
, index
);
1857 file_stream
->parent
.stream_id
= stream_id
;
1858 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1860 fprintf(stderr
, "[error] Stream %" PRIu64
1861 " is not declared in metadata.\n",
1866 file_stream
->parent
.stream_class
= stream
;
1867 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1871 /* add index to packet array */
1872 g_array_append_val(file_stream
->pos
.packet_index
, index
);
1875 /* Index containing only the header. */
1876 if (!file_stream
->parent
.stream_class
) {
1888 * Note: many file streams can inherit from the same stream class
1889 * description (metadata).
1892 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1893 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1896 int ret
, fd
, closeret
;
1897 struct ctf_file_stream
*file_stream
;
1898 struct stat statbuf
;
1901 fd
= openat(td
->dirfd
, path
, flags
);
1903 perror("File stream openat()");
1908 /* Don't try to mmap subdirectories. Skip them, return success. */
1909 ret
= fstat(fd
, &statbuf
);
1911 perror("File stream fstat()");
1914 if (S_ISDIR(statbuf
.st_mode
)) {
1915 if (strncmp(path
, "index", 5) != 0) {
1916 fprintf(stderr
, "[warning] Skipping directory '%s' "
1917 "found in trace\n", path
);
1923 file_stream
= g_new0(struct ctf_file_stream
, 1);
1924 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1925 file_stream
->pos
.fd
= -1;
1926 file_stream
->pos
.index_fp
= NULL
;
1928 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
1929 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
1932 file_stream
->pos
.packet_seek
= packet_seek
;
1934 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1939 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
1942 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1946 * For now, only a single clock per trace is supported.
1948 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
1951 * Allocate the index name for this stream and try to open it.
1953 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
1955 fprintf(stderr
, "[error] Cannot allocate index filename\n");
1958 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
1961 if (faccessat(td
->dirfd
, index_name
, O_RDONLY
, flags
) < 0) {
1962 ret
= create_stream_packet_index(td
, file_stream
);
1964 fprintf(stderr
, "[error] Stream index creation error.\n");
1968 ret
= openat(td
->dirfd
, index_name
, flags
);
1970 perror("Index file openat()");
1974 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
1975 if (!file_stream
->pos
.index_fp
) {
1976 perror("fdopen() error");
1979 ret
= import_stream_packet_index(td
, file_stream
);
1984 ret
= fclose(file_stream
->pos
.index_fp
);
1986 perror("close index");
1992 /* Add stream file to stream class */
1993 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1994 &file_stream
->parent
);
1998 if (file_stream
->pos
.index_fp
) {
1999 ret
= fclose(file_stream
->pos
.index_fp
);
2001 perror("close index");
2004 if (file_stream
->parent
.trace_packet_header
)
2005 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2009 closeret
= ctf_fini_pos(&file_stream
->pos
);
2011 fprintf(stderr
, "Error on ctf_fini_pos\n");
2013 g_free(file_stream
);
2016 closeret
= close(fd
);
2018 perror("Error on fd close");
2025 int ctf_open_trace_read(struct ctf_trace
*td
,
2026 const char *path
, int flags
,
2027 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2028 int whence
), FILE *metadata_fp
)
2031 struct dirent
*dirent
;
2032 struct dirent
*diriter
;
2038 /* Open trace directory */
2039 td
->dir
= opendir(path
);
2041 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2046 td
->dirfd
= open(path
, 0);
2047 if (td
->dirfd
< 0) {
2048 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2049 perror("Trace directory open");
2053 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2054 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2057 * Keep the metadata file separate.
2060 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
2062 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2063 goto error_metadata
;
2067 * Open each stream: for each file, try to open, check magic
2068 * number, and get the stream ID to add to the right location in
2072 dirent_len
= offsetof(struct dirent
, d_name
) +
2073 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2075 dirent
= malloc(dirent_len
);
2078 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2080 fprintf(stderr
, "[error] Readdir error.\n");
2085 /* Ignore hidden files, ., .. and metadata. */
2086 if (!strncmp(diriter
->d_name
, ".", 1)
2087 || !strcmp(diriter
->d_name
, "..")
2088 || !strcmp(diriter
->d_name
, "metadata"))
2091 /* Ignore index files : *.idx */
2092 ext
= strrchr(diriter
->d_name
, '.');
2093 if (ext
&& (!strcmp(ext
, ".idx"))) {
2097 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2098 flags
, packet_seek
);
2100 fprintf(stderr
, "[error] Open file stream error.\n");
2111 closeret
= close(td
->dirfd
);
2113 perror("Error on fd close");
2116 closeret
= closedir(td
->dir
);
2118 perror("Error on closedir");
2125 * ctf_open_trace: Open a CTF trace and index it.
2126 * Note that the user must seek the trace after the open (using the iterator)
2127 * since the index creation read it entirely.
2130 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2131 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2132 int whence
), FILE *metadata_fp
)
2134 struct ctf_trace
*td
;
2138 * If packet_seek is NULL, we provide our default version.
2141 packet_seek
= ctf_packet_seek
;
2143 td
= g_new0(struct ctf_trace
, 1);
2145 switch (flags
& O_ACCMODE
) {
2148 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2151 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2156 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2159 fprintf(stderr
, "[error] Incorrect open flags.\n");
2170 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2171 struct bt_mmap_stream
*mmap_info
)
2173 pos
->mmap_offset
= 0;
2174 pos
->packet_size
= 0;
2175 pos
->content_size
= 0;
2176 pos
->content_size_loc
= NULL
;
2177 pos
->fd
= mmap_info
->fd
;
2178 pos
->base_mma
= NULL
;
2182 pos
->packet_index
= NULL
;
2183 pos
->prot
= PROT_READ
;
2184 pos
->flags
= MAP_PRIVATE
;
2185 pos
->parent
.rw_table
= read_dispatch_table
;
2186 pos
->parent
.event_cb
= ctf_read_event
;
2187 pos
->priv
= mmap_info
->priv
;
2191 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2192 struct ctf_file_stream
*file_stream
)
2194 struct ctf_stream_declaration
*stream
;
2195 uint64_t stream_id
= 0;
2198 file_stream
->parent
.stream_id
= stream_id
;
2199 if (stream_id
>= td
->streams
->len
) {
2200 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2201 "in metadata.\n", stream_id
);
2205 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2207 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2208 "in metadata.\n", stream_id
);
2212 file_stream
->parent
.stream_class
= stream
;
2213 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2219 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2220 struct bt_mmap_stream
*mmap_info
,
2221 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2225 struct ctf_file_stream
*file_stream
;
2227 file_stream
= g_new0(struct ctf_file_stream
, 1);
2228 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2229 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2231 file_stream
->pos
.packet_seek
= packet_seek
;
2233 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2238 ret
= prepare_mmap_stream_definition(td
, file_stream
);
2243 * For now, only a single clock per trace is supported.
2245 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2247 /* Add stream file to stream class */
2248 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2249 &file_stream
->parent
);
2253 if (file_stream
->parent
.trace_packet_header
)
2254 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2256 g_free(file_stream
);
2261 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2262 struct bt_mmap_stream_list
*mmap_list
,
2263 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2268 struct bt_mmap_stream
*mmap_info
;
2270 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
2276 * for each stream, try to open, check magic number, and get the
2277 * stream ID to add to the right location in the stream array.
2279 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2280 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2282 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2294 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2295 struct bt_mmap_stream_list
*mmap_list
,
2296 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2300 struct ctf_trace
*td
;
2304 fprintf(stderr
, "[error] No metadata file pointer associated, "
2305 "required for mmap parsing\n");
2309 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2312 td
= g_new0(struct ctf_trace
, 1);
2313 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2326 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2329 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2331 /* for each stream_class */
2332 for (i
= 0; i
< td
->streams
->len
; i
++) {
2333 struct ctf_stream_declaration
*stream_class
;
2335 stream_class
= g_ptr_array_index(td
->streams
, i
);
2338 /* for each file_stream */
2339 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2340 struct ctf_stream_definition
*stream
;
2341 struct ctf_stream_pos
*stream_pos
;
2342 struct ctf_file_stream
*cfs
;
2344 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2347 cfs
= container_of(stream
, struct ctf_file_stream
,
2349 stream_pos
= &cfs
->pos
;
2350 if (!stream_pos
->packet_index
)
2353 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2354 struct packet_index
*index
;
2356 index
= &g_array_index(stream_pos
->packet_index
,
2357 struct packet_index
, k
);
2358 index
->ts_real
.timestamp_begin
=
2359 ctf_get_real_timestamp(stream
,
2360 index
->ts_cycles
.timestamp_begin
);
2361 index
->ts_real
.timestamp_end
=
2362 ctf_get_real_timestamp(stream
,
2363 index
->ts_cycles
.timestamp_end
);
2371 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2375 ret
= ctf_fini_pos(&file_stream
->pos
);
2377 fprintf(stderr
, "Error on ctf_fini_pos\n");
2380 if (file_stream
->pos
.fd
>= 0) {
2381 ret
= close(file_stream
->pos
.fd
);
2383 perror("Error closing file fd");
2391 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2393 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2399 for (i
= 0; i
< td
->streams
->len
; i
++) {
2400 struct ctf_stream_declaration
*stream
;
2403 stream
= g_ptr_array_index(td
->streams
, i
);
2406 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2407 struct ctf_file_stream
*file_stream
;
2408 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2409 struct ctf_file_stream
, parent
);
2410 ret
= ctf_close_file_stream(file_stream
);
2416 ctf_destroy_metadata(td
);
2417 if (td
->dirfd
>= 0) {
2418 ret
= close(td
->dirfd
);
2420 perror("Error closing dirfd");
2425 ret
= closedir(td
->dir
);
2427 perror("Error closedir");
2431 free(td
->metadata_string
);
2437 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2438 struct bt_context
*ctx
)
2440 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2443 td
->parent
.ctx
= ctx
;
2447 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2448 struct bt_trace_handle
*handle
)
2450 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2453 td
->parent
.handle
= handle
;
2457 void __attribute__((constructor
)) ctf_init(void)
2461 ctf_format
.name
= g_quark_from_static_string("ctf");
2462 ret
= bt_register_format(&ctf_format
);
2467 void __attribute__((destructor
)) ctf_exit(void)
2469 bt_unregister_format(&ctf_format
);