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>
42 #include <sys/types.h>
50 #include "metadata/ctf-scanner.h"
51 #include "metadata/ctf-parser.h"
52 #include "metadata/ctf-ast.h"
53 #include "events-private.h"
54 #include <babeltrace/compat/memstream.h>
56 #define LOG2_CHAR_BIT 3
59 * Length of first attempt at mapping a packet header, in bits.
61 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
64 * Lenght of packet to write, in bits.
66 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
69 #define min(a, b) (((a) < (b)) ? (a) : (b))
72 #define NSEC_PER_SEC 1000000000ULL
79 uint64_t opt_clock_offset
;
80 uint64_t opt_clock_offset_ns
;
85 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
86 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
90 struct bt_trace_descriptor
*ctf_open_mmap_trace(
91 struct bt_mmap_stream_list
*mmap_list
,
92 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
96 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
97 struct bt_context
*ctx
);
99 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
100 struct bt_trace_handle
*handle
);
103 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
105 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
106 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
108 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
109 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
111 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
114 rw_dispatch read_dispatch_table
[] = {
115 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
116 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
117 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
118 [ CTF_TYPE_STRING
] = ctf_string_read
,
119 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
120 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
121 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
122 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
126 rw_dispatch write_dispatch_table
[] = {
127 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
128 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
129 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
130 [ CTF_TYPE_STRING
] = ctf_string_write
,
131 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
132 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
133 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
134 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
138 struct bt_format ctf_format
= {
139 .open_trace
= ctf_open_trace
,
140 .open_mmap_trace
= ctf_open_mmap_trace
,
141 .close_trace
= ctf_close_trace
,
142 .set_context
= ctf_set_context
,
143 .set_handle
= ctf_set_handle
,
144 .timestamp_begin
= ctf_timestamp_begin
,
145 .timestamp_end
= ctf_timestamp_end
,
146 .convert_index_timestamp
= ctf_convert_index_timestamp
,
150 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
151 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
153 struct ctf_trace
*tin
;
154 uint64_t begin
= ULLONG_MAX
;
157 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
162 /* for each stream_class */
163 for (i
= 0; i
< tin
->streams
->len
; i
++) {
164 struct ctf_stream_declaration
*stream_class
;
166 stream_class
= g_ptr_array_index(tin
->streams
, i
);
169 /* for each file_stream */
170 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
171 struct ctf_stream_definition
*stream
;
172 struct ctf_file_stream
*cfs
;
173 struct ctf_stream_pos
*stream_pos
;
174 struct packet_index
*index
;
176 stream
= g_ptr_array_index(stream_class
->streams
, j
);
177 cfs
= container_of(stream
, struct ctf_file_stream
,
179 stream_pos
= &cfs
->pos
;
181 if (!stream_pos
->packet_real_index
)
184 if (stream_pos
->packet_real_index
->len
<= 0)
187 if (type
== BT_CLOCK_REAL
) {
188 index
= &g_array_index(stream_pos
->packet_real_index
,
190 stream_pos
->packet_real_index
->len
- 1);
191 } else if (type
== BT_CLOCK_CYCLES
) {
192 index
= &g_array_index(stream_pos
->packet_cycles_index
,
194 stream_pos
->packet_real_index
->len
- 1);
199 if (index
->timestamp_begin
< begin
)
200 begin
= index
->timestamp_begin
;
211 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
212 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
214 struct ctf_trace
*tin
;
218 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
223 /* for each stream_class */
224 for (i
= 0; i
< tin
->streams
->len
; i
++) {
225 struct ctf_stream_declaration
*stream_class
;
227 stream_class
= g_ptr_array_index(tin
->streams
, i
);
230 /* for each file_stream */
231 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
232 struct ctf_stream_definition
*stream
;
233 struct ctf_file_stream
*cfs
;
234 struct ctf_stream_pos
*stream_pos
;
235 struct packet_index
*index
;
237 stream
= g_ptr_array_index(stream_class
->streams
, j
);
238 cfs
= container_of(stream
, struct ctf_file_stream
,
240 stream_pos
= &cfs
->pos
;
242 if (!stream_pos
->packet_real_index
)
245 if (stream_pos
->packet_real_index
->len
<= 0)
248 if (type
== BT_CLOCK_REAL
) {
249 index
= &g_array_index(stream_pos
->packet_real_index
,
251 stream_pos
->packet_real_index
->len
- 1);
252 } else if (type
== BT_CLOCK_CYCLES
) {
253 index
= &g_array_index(stream_pos
->packet_cycles_index
,
255 stream_pos
->packet_real_index
->len
- 1);
260 if (index
->timestamp_end
> end
)
261 end
= index
->timestamp_end
;
272 * Update stream current timestamp
275 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
276 struct definition_integer
*integer_definition
)
278 struct declaration_integer
*integer_declaration
=
279 integer_definition
->declaration
;
280 uint64_t oldval
, newval
, updateval
;
282 if (unlikely(integer_declaration
->len
== 64)) {
283 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
284 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
285 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
286 stream
->prev_cycles_timestamp
);
287 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
288 stream
->cycles_timestamp
);
292 oldval
= stream
->cycles_timestamp
;
293 oldval
&= (1ULL << integer_declaration
->len
) - 1;
294 newval
= integer_definition
->value
._unsigned
;
295 /* Test for overflow by comparing low bits */
297 newval
+= 1ULL << integer_declaration
->len
;
298 /* updateval contains old high bits, and new low bits (sum) */
299 updateval
= stream
->cycles_timestamp
;
300 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
302 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
303 stream
->cycles_timestamp
= updateval
;
305 /* convert to real timestamp */
306 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
307 stream
->prev_cycles_timestamp
);
308 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
309 stream
->cycles_timestamp
);
313 * Print timestamp, rescaling clock frequency to nanoseconds and
314 * applying offsets as needed (unix time).
317 void ctf_print_timestamp_real(FILE *fp
,
318 struct ctf_stream_definition
*stream
,
321 uint64_t ts_sec
= 0, ts_nsec
;
325 /* Add command-line offset in ns*/
326 ts_nsec
+= opt_clock_offset_ns
;
328 /* Add command-line offset */
329 ts_sec
+= opt_clock_offset
;
331 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
332 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
334 if (!opt_clock_seconds
) {
336 time_t time_s
= (time_t) ts_sec
;
338 if (!opt_clock_gmt
) {
341 res
= localtime_r(&time_s
, &tm
);
343 fprintf(stderr
, "[warning] Unable to get localtime.\n");
349 res
= gmtime_r(&time_s
, &tm
);
351 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
355 if (opt_clock_date
) {
359 /* Print date and time */
360 res
= strftime(timestr
, sizeof(timestr
),
363 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
366 fprintf(fp
, "%s", timestr
);
368 /* Print time in HH:MM:SS.ns */
369 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
370 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
374 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
382 * Print timestamp, in cycles
385 void ctf_print_timestamp_cycles(FILE *fp
,
386 struct ctf_stream_definition
*stream
,
389 fprintf(fp
, "%020" PRIu64
, timestamp
);
392 void ctf_print_timestamp(FILE *fp
,
393 struct ctf_stream_definition
*stream
,
396 if (opt_clock_cycles
) {
397 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
399 ctf_print_timestamp_real(fp
, stream
, timestamp
);
404 void print_uuid(FILE *fp
, unsigned char *uuid
)
408 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
409 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
412 void ctf_print_discarded(FILE *fp
, struct ctf_stream_definition
*stream
,
415 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events %sbetween [",
416 stream
->events_discarded
,
417 end_stream
? "at end of stream " : "");
418 if (opt_clock_cycles
) {
419 ctf_print_timestamp(fp
, stream
,
420 stream
->prev_cycles_timestamp
);
421 fprintf(fp
, "] and [");
422 ctf_print_timestamp(fp
, stream
,
423 stream
->prev_cycles_timestamp_end
);
425 ctf_print_timestamp(fp
, stream
,
426 stream
->prev_real_timestamp
);
427 fprintf(fp
, "] and [");
428 ctf_print_timestamp(fp
, stream
,
429 stream
->prev_real_timestamp_end
);
431 fprintf(fp
, "] in trace UUID ");
432 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
433 if (stream
->stream_class
->trace
->parent
.path
[0])
434 fprintf(fp
, ", at path: \"%s\"",
435 stream
->stream_class
->trace
->parent
.path
);
437 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
439 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
441 fprintf(fp
, "You should consider recording a new trace with larger "
442 "buffers or with fewer events enabled.\n");
447 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
449 struct ctf_stream_pos
*pos
=
450 container_of(ppos
, struct ctf_stream_pos
, parent
);
451 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
452 struct ctf_event_definition
*event
;
456 /* We need to check for EOF here for empty files. */
457 if (unlikely(pos
->offset
== EOF
))
460 ctf_pos_get_event(pos
);
462 /* save the current position as a restore point */
463 pos
->last_offset
= pos
->offset
;
466 * This is the EOF check after we've advanced the position in
469 if (unlikely(pos
->offset
== EOF
))
471 assert(pos
->offset
< pos
->content_size
);
473 /* Read event header */
474 if (likely(stream
->stream_event_header
)) {
475 struct definition_integer
*integer_definition
;
476 struct bt_definition
*variant
;
478 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
481 /* lookup event id */
482 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
483 if (integer_definition
) {
484 id
= integer_definition
->value
._unsigned
;
486 struct definition_enum
*enum_definition
;
488 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
489 if (enum_definition
) {
490 id
= enum_definition
->integer
->value
._unsigned
;
494 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
496 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
497 if (integer_definition
) {
498 id
= integer_definition
->value
._unsigned
;
501 stream
->event_id
= id
;
503 /* lookup timestamp */
504 stream
->has_timestamp
= 0;
505 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
506 if (integer_definition
) {
507 ctf_update_timestamp(stream
, integer_definition
);
508 stream
->has_timestamp
= 1;
511 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
512 if (integer_definition
) {
513 ctf_update_timestamp(stream
, integer_definition
);
514 stream
->has_timestamp
= 1;
520 /* Read stream-declared event context */
521 if (stream
->stream_event_context
) {
522 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
527 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
528 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
531 event
= g_ptr_array_index(stream
->events_by_id
, id
);
532 if (unlikely(!event
)) {
533 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
537 /* Read event-declared event context */
538 if (event
->event_context
) {
539 ret
= generic_rw(ppos
, &event
->event_context
->p
);
544 /* Read event payload */
545 if (likely(event
->event_fields
)) {
546 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
551 if (pos
->last_offset
== pos
->offset
) {
552 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
559 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
564 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
566 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
567 struct ctf_event_definition
*event
;
571 id
= stream
->event_id
;
573 /* print event header */
574 if (likely(stream
->stream_event_header
)) {
575 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
580 /* print stream-declared event context */
581 if (stream
->stream_event_context
) {
582 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
587 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
588 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
591 event
= g_ptr_array_index(stream
->events_by_id
, id
);
592 if (unlikely(!event
)) {
593 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
597 /* print event-declared event context */
598 if (event
->event_context
) {
599 ret
= generic_rw(pos
, &event
->event_context
->p
);
604 /* Read and print event payload */
605 if (likely(event
->event_fields
)) {
606 ret
= generic_rw(pos
, &event
->event_fields
->p
);
614 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
618 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
619 int fd
, int open_flags
)
623 pos
->packet_cycles_index
= g_array_new(FALSE
, TRUE
,
624 sizeof(struct packet_index
));
625 pos
->packet_real_index
= g_array_new(FALSE
, TRUE
,
626 sizeof(struct packet_index
));
628 pos
->packet_cycles_index
= NULL
;
629 pos
->packet_real_index
= NULL
;
631 switch (open_flags
& O_ACCMODE
) {
633 pos
->prot
= PROT_READ
;
634 pos
->flags
= MAP_PRIVATE
;
635 pos
->parent
.rw_table
= read_dispatch_table
;
636 pos
->parent
.event_cb
= ctf_read_event
;
637 pos
->parent
.trace
= trace
;
640 pos
->prot
= PROT_WRITE
; /* Write has priority */
641 pos
->flags
= MAP_SHARED
;
642 pos
->parent
.rw_table
= write_dispatch_table
;
643 pos
->parent
.event_cb
= ctf_write_event
;
644 pos
->parent
.trace
= trace
;
646 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
654 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
656 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
657 *pos
->content_size_loc
= pos
->offset
;
662 ret
= munmap_align(pos
->base_mma
);
664 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
669 if (pos
->packet_cycles_index
)
670 (void) g_array_free(pos
->packet_cycles_index
, TRUE
);
671 if (pos
->packet_real_index
)
672 (void) g_array_free(pos
->packet_real_index
, TRUE
);
677 * for SEEK_CUR: go to next packet.
678 * for SEEK_SET: go to packet numer (index).
680 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
682 struct ctf_stream_pos
*pos
=
683 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
684 struct ctf_file_stream
*file_stream
=
685 container_of(pos
, struct ctf_file_stream
, pos
);
688 struct packet_index
*packet_index
;
692 case SEEK_SET
: /* Fall-through */
698 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
699 *pos
->content_size_loc
= pos
->offset
;
703 ret
= munmap_align(pos
->base_mma
);
705 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
709 pos
->base_mma
= NULL
;
713 * The caller should never ask for ctf_move_pos across packets,
714 * except to get exactly at the beginning of the next packet.
716 if (pos
->prot
== PROT_WRITE
) {
719 /* The writer will add padding */
720 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
723 assert(index
== 0); /* only seek supported for now */
729 pos
->content_size
= -1U; /* Unknown at this point */
730 pos
->packet_size
= WRITE_PACKET_LEN
;
731 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
732 pos
->packet_size
/ CHAR_BIT
);
740 uint64_t events_discarded_diff
;
742 if (pos
->offset
== EOF
) {
745 assert(pos
->cur_index
< pos
->packet_cycles_index
->len
);
746 assert(pos
->cur_index
< pos
->packet_real_index
->len
);
748 /* For printing discarded event count */
749 packet_index
= &g_array_index(pos
->packet_cycles_index
,
750 struct packet_index
, pos
->cur_index
);
751 file_stream
->parent
.prev_cycles_timestamp_end
=
752 packet_index
->timestamp_end
;
753 file_stream
->parent
.prev_cycles_timestamp
=
754 packet_index
->timestamp_begin
;
756 packet_index
= &g_array_index(pos
->packet_real_index
,
757 struct packet_index
, pos
->cur_index
);
758 file_stream
->parent
.prev_real_timestamp_end
=
759 packet_index
->timestamp_end
;
760 file_stream
->parent
.prev_real_timestamp
=
761 packet_index
->timestamp_begin
;
763 events_discarded_diff
= packet_index
->events_discarded
;
764 if (pos
->cur_index
> 0) {
765 packet_index
= &g_array_index(pos
->packet_real_index
,
768 events_discarded_diff
-= packet_index
->events_discarded
;
770 * Deal with 32-bit wrap-around if the
771 * tracer provided a 32-bit field.
773 if (packet_index
->events_discarded_len
== 32) {
774 events_discarded_diff
= (uint32_t) events_discarded_diff
;
777 file_stream
->parent
.events_discarded
= events_discarded_diff
;
778 file_stream
->parent
.prev_real_timestamp
= file_stream
->parent
.real_timestamp
;
779 file_stream
->parent
.prev_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
780 /* The reader will expect us to skip padding */
785 if (index
>= pos
->packet_cycles_index
->len
) {
789 packet_index
= &g_array_index(pos
->packet_cycles_index
,
790 struct packet_index
, index
);
791 pos
->last_events_discarded
= packet_index
->events_discarded
;
792 pos
->cur_index
= index
;
793 file_stream
->parent
.prev_real_timestamp
= 0;
794 file_stream
->parent
.prev_real_timestamp_end
= 0;
795 file_stream
->parent
.prev_cycles_timestamp
= 0;
796 file_stream
->parent
.prev_cycles_timestamp_end
= 0;
801 if (pos
->cur_index
>= pos
->packet_real_index
->len
) {
803 * We need to check if we are in trace read or
804 * called from packet indexing. In this last
805 * case, the collection is not there, so we
806 * cannot print the timestamps.
808 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
810 * When a stream reaches the end of the
811 * file, we need to show the number of
812 * events discarded ourselves, because
813 * there is no next event scheduled to
814 * be printed in the output.
816 if (file_stream
->parent
.events_discarded
) {
818 ctf_print_discarded(stderr
,
819 &file_stream
->parent
,
821 file_stream
->parent
.events_discarded
= 0;
827 packet_index
= &g_array_index(pos
->packet_cycles_index
,
830 file_stream
->parent
.cycles_timestamp
= packet_index
->timestamp_begin
;
832 packet_index
= &g_array_index(pos
->packet_real_index
,
835 file_stream
->parent
.real_timestamp
= packet_index
->timestamp_begin
;
836 pos
->mmap_offset
= packet_index
->offset
;
838 /* Lookup context/packet size in index */
839 pos
->content_size
= packet_index
->content_size
;
840 pos
->packet_size
= packet_index
->packet_size
;
841 if (packet_index
->data_offset
< packet_index
->content_size
) {
842 pos
->offset
= 0; /* will read headers */
843 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
845 pos
->offset
= packet_index
->data_offset
;
847 goto read_next_packet
;
853 /* map new base. Need mapping length from header. */
854 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
855 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
856 if (pos
->base_mma
== MAP_FAILED
) {
857 fprintf(stderr
, "[error] mmap error %s.\n",
862 /* update trace_packet_header and stream_packet_context */
863 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
864 /* Read packet header */
865 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
868 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
869 /* Read packet context */
870 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
876 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
882 len
= fread(&magic
, sizeof(magic
), 1, fp
);
886 if (magic
== TSDL_MAGIC
) {
888 td
->byte_order
= BYTE_ORDER
;
889 CTF_TRACE_SET_FIELD(td
, byte_order
);
890 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
892 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
893 LITTLE_ENDIAN
: BIG_ENDIAN
;
894 CTF_TRACE_SET_FIELD(td
, byte_order
);
902 * Returns 0 on success, -1 on error.
905 int check_version(unsigned int major
, unsigned int minor
)
920 /* eventually return an error instead of warning */
922 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
928 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
931 struct metadata_packet_header header
;
932 size_t readlen
, writelen
, toread
;
933 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
936 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
940 if (td
->byte_order
!= BYTE_ORDER
) {
941 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
942 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
943 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
944 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
947 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
948 if (header
.compression_scheme
) {
949 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
950 header
.compression_scheme
);
953 if (header
.encryption_scheme
) {
954 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
955 header
.encryption_scheme
);
958 if (header
.checksum_scheme
) {
959 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
960 header
.checksum_scheme
);
963 if (check_version(header
.major
, header
.minor
) < 0)
965 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
966 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
967 CTF_TRACE_SET_FIELD(td
, uuid
);
969 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
973 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
976 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
979 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
984 if (babeltrace_debug
) {
986 fprintf(stderr
, "[debug] metadata packet read: %s\n",
990 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
991 if (writelen
< readlen
) {
1001 ret
= 0; /* continue reading next packet */
1008 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1009 ret
= fseek(in
, toread
, SEEK_CUR
);
1011 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1018 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1022 size_t size
, buflen
;
1027 * Using strlen on *buf instead of size of open_memstream
1028 * because its size includes garbage at the end (after final
1029 * \0). This is the allocated size, not the actual string size.
1031 out
= babeltrace_open_memstream(buf
, &size
);
1033 perror("Metadata open_memstream");
1037 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
1046 /* close to flush the buffer */
1047 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1051 perror("babeltrace_flush_memstream");
1053 closeret
= fclose(in
);
1055 perror("Error in fclose");
1061 perror("Error in fclose");
1063 /* open for reading */
1064 buflen
= strlen(*buf
);
1069 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1071 perror("Metadata fmemopen");
1078 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
1079 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1080 int whence
), FILE *metadata_fp
)
1082 struct ctf_scanner
*scanner
;
1083 struct ctf_file_stream
*metadata_stream
;
1086 int ret
= 0, closeret
;
1088 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1089 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1092 metadata_stream
->pos
.packet_seek
= packet_seek
;
1094 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1101 metadata_stream
->pos
.fd
= -1;
1103 td
->metadata
= &metadata_stream
->parent
;
1104 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1105 if (metadata_stream
->pos
.fd
< 0) {
1106 fprintf(stderr
, "Unable to open metadata.\n");
1111 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1113 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1114 perror("Metadata stream open");
1118 /* fd now belongs to fp */
1119 metadata_stream
->pos
.fd
= -1;
1121 if (babeltrace_debug
)
1124 if (packet_metadata(td
, fp
)) {
1125 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
1127 /* Warn about empty metadata */
1128 fprintf(stderr
, "[warning] Empty metadata.\n");
1129 goto end_packet_read
;
1131 td
->metadata_string
= buf
;
1132 td
->metadata_packetized
= 1;
1134 unsigned int major
, minor
;
1137 td
->byte_order
= BYTE_ORDER
;
1139 /* Check text-only metadata header and version */
1140 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1142 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1143 if (check_version(major
, minor
) < 0) {
1145 goto end_packet_read
;
1150 scanner
= ctf_scanner_alloc(fp
);
1152 fprintf(stderr
, "[error] Error allocating scanner\n");
1154 goto end_scanner_alloc
;
1156 ret
= ctf_scanner_append_ast(scanner
);
1158 fprintf(stderr
, "[error] Error creating AST\n");
1162 if (babeltrace_debug
) {
1163 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1165 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1170 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1172 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1175 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1176 td
, td
->byte_order
);
1178 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1182 ctf_scanner_free(scanner
);
1186 closeret
= fclose(fp
);
1188 perror("Error on fclose");
1192 if (metadata_stream
->pos
.fd
>= 0) {
1193 closeret
= close(metadata_stream
->pos
.fd
);
1195 perror("Error on metadata stream fd close");
1200 g_free(metadata_stream
);
1205 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1206 struct ctf_stream_definition
*stream
,
1207 struct ctf_event_declaration
*event
)
1209 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1211 if (event
->context_decl
) {
1212 struct bt_definition
*definition
=
1213 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1214 stream
->parent_def_scope
, 0, 0, "event.context");
1218 stream_event
->event_context
= container_of(definition
,
1219 struct definition_struct
, p
);
1220 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1222 if (event
->fields_decl
) {
1223 struct bt_definition
*definition
=
1224 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1225 stream
->parent_def_scope
, 0, 0, "event.fields");
1229 stream_event
->event_fields
= container_of(definition
,
1230 struct definition_struct
, p
);
1231 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1233 stream_event
->stream
= stream
;
1234 return stream_event
;
1237 if (stream_event
->event_fields
)
1238 bt_definition_unref(&stream_event
->event_fields
->p
);
1239 if (stream_event
->event_context
)
1240 bt_definition_unref(&stream_event
->event_context
->p
);
1241 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1242 g_quark_to_string(event
->name
));
1247 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1249 struct ctf_stream_declaration
*stream_class
;
1253 if (stream
->stream_definitions_created
)
1256 stream_class
= stream
->stream_class
;
1258 if (stream_class
->packet_context_decl
) {
1259 struct bt_definition
*definition
=
1260 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1261 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1266 stream
->stream_packet_context
= container_of(definition
,
1267 struct definition_struct
, p
);
1268 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1270 if (stream_class
->event_header_decl
) {
1271 struct bt_definition
*definition
=
1272 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1273 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1278 stream
->stream_event_header
=
1279 container_of(definition
, struct definition_struct
, p
);
1280 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1282 if (stream_class
->event_context_decl
) {
1283 struct bt_definition
*definition
=
1284 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1285 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1290 stream
->stream_event_context
=
1291 container_of(definition
, struct definition_struct
, p
);
1292 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1294 stream
->events_by_id
= g_ptr_array_new();
1295 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
1296 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1297 struct ctf_event_declaration
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
1298 struct ctf_event_definition
*stream_event
;
1302 stream_event
= create_event_definitions(td
, stream
, event
);
1303 if (!stream_event
) {
1307 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1312 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1313 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1315 g_free(stream_event
);
1317 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1319 if (stream
->stream_event_context
)
1320 bt_definition_unref(&stream
->stream_event_context
->p
);
1321 if (stream
->stream_event_header
)
1322 bt_definition_unref(&stream
->stream_event_header
->p
);
1323 if (stream
->stream_packet_context
)
1324 bt_definition_unref(&stream
->stream_packet_context
->p
);
1325 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1326 stream_class
->stream_id
, strerror(-ret
));
1331 int stream_assign_class(struct ctf_trace
*td
,
1332 struct ctf_file_stream
*file_stream
,
1335 struct ctf_stream_declaration
*stream
;
1338 file_stream
->parent
.stream_id
= stream_id
;
1339 if (stream_id
>= td
->streams
->len
) {
1340 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1343 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1345 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1348 file_stream
->parent
.stream_class
= stream
;
1349 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1356 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1357 struct ctf_trace
*td
,
1358 struct ctf_file_stream
*file_stream
,
1361 struct packet_index packet_index
;
1362 uint64_t stream_id
= 0;
1363 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1364 int first_packet
= 0;
1369 if (!pos
->mmap_offset
) {
1373 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1374 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1377 if (pos
->base_mma
) {
1378 /* unmap old base */
1379 ret
= munmap_align(pos
->base_mma
);
1381 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1385 pos
->base_mma
= NULL
;
1387 /* map new base. Need mapping length from header. */
1388 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1389 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1390 assert(pos
->base_mma
!= MAP_FAILED
);
1392 * Use current mapping size as temporary content and packet
1395 pos
->content_size
= packet_map_len
;
1396 pos
->packet_size
= packet_map_len
;
1397 pos
->offset
= 0; /* Position of the packet header */
1399 packet_index
.offset
= pos
->mmap_offset
;
1400 packet_index
.content_size
= 0;
1401 packet_index
.packet_size
= 0;
1402 packet_index
.timestamp_begin
= 0;
1403 packet_index
.timestamp_end
= 0;
1404 packet_index
.events_discarded
= 0;
1405 packet_index
.events_discarded_len
= 0;
1407 /* read and check header, set stream id (and check) */
1408 if (file_stream
->parent
.trace_packet_header
) {
1409 /* Read packet header */
1410 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1414 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1417 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1418 if (len_index
>= 0) {
1419 struct bt_definition
*field
;
1422 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1423 magic
= bt_get_unsigned_int(field
);
1424 if (magic
!= CTF_MAGIC
) {
1425 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1427 file_stream
->pos
.packet_cycles_index
->len
,
1428 (ssize_t
) pos
->mmap_offset
);
1434 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1435 if (len_index
>= 0) {
1436 struct definition_array
*defarray
;
1437 struct bt_definition
*field
;
1439 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1441 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1442 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1443 defarray
= container_of(field
, struct definition_array
, p
);
1444 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1446 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1447 struct bt_definition
*elem
;
1449 elem
= bt_array_index(defarray
, i
);
1450 uuidval
[i
] = bt_get_unsigned_int(elem
);
1452 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1454 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1459 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1460 if (len_index
>= 0) {
1461 struct bt_definition
*field
;
1463 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1464 stream_id
= bt_get_unsigned_int(field
);
1468 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1469 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1471 file_stream
->parent
.stream_id
);
1475 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1480 if (file_stream
->parent
.stream_packet_context
) {
1481 /* Read packet context */
1482 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1486 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1489 /* read packet size from header */
1490 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1491 if (len_index
>= 0) {
1492 struct bt_definition
*field
;
1494 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1495 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1497 /* Use file size for packet size */
1498 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1501 /* read content size from header */
1502 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1503 if (len_index
>= 0) {
1504 struct bt_definition
*field
;
1506 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1507 packet_index
.content_size
= bt_get_unsigned_int(field
);
1509 /* Use packet size if non-zero, else file size */
1510 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1513 /* read timestamp begin from header */
1514 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1515 if (len_index
>= 0) {
1516 struct bt_definition
*field
;
1518 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1519 packet_index
.timestamp_begin
= bt_get_unsigned_int(field
);
1520 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1521 packet_index
.timestamp_begin
=
1522 ctf_get_real_timestamp(
1523 &file_stream
->parent
,
1524 packet_index
.timestamp_begin
);
1528 /* read timestamp end from header */
1529 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1530 if (len_index
>= 0) {
1531 struct bt_definition
*field
;
1533 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1534 packet_index
.timestamp_end
= bt_get_unsigned_int(field
);
1535 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1536 packet_index
.timestamp_end
=
1537 ctf_get_real_timestamp(
1538 &file_stream
->parent
,
1539 packet_index
.timestamp_end
);
1543 /* read events discarded from header */
1544 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1545 if (len_index
>= 0) {
1546 struct bt_definition
*field
;
1548 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1549 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1550 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1553 /* Use file size for packet size */
1554 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1555 /* Use packet size if non-zero, else file size */
1556 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1559 /* Validate content size and packet size values */
1560 if (packet_index
.content_size
> packet_index
.packet_size
) {
1561 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1562 packet_index
.content_size
, packet_index
.packet_size
);
1566 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1567 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1568 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1572 if (packet_index
.content_size
< pos
->offset
) {
1573 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1577 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1578 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1582 /* Save position after header and context */
1583 packet_index
.data_offset
= pos
->offset
;
1585 /* add index to packet array */
1586 g_array_append_val(file_stream
->pos
.packet_cycles_index
, packet_index
);
1588 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1592 /* Retry with larger mapping */
1594 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1596 * Reached EOF, but still expecting header/context data.
1598 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1601 /* Double the mapping len, and retry */
1602 tmp_map_len
= packet_map_len
<< 1;
1603 if (tmp_map_len
>> 1 != packet_map_len
) {
1605 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1608 packet_map_len
= tmp_map_len
;
1613 int create_stream_packet_index(struct ctf_trace
*td
,
1614 struct ctf_file_stream
*file_stream
)
1616 struct ctf_stream_pos
*pos
;
1617 struct stat filestats
;
1620 pos
= &file_stream
->pos
;
1622 ret
= fstat(pos
->fd
, &filestats
);
1626 /* Deal with empty files */
1627 if (!filestats
.st_size
) {
1628 if (file_stream
->parent
.trace_packet_header
1629 || file_stream
->parent
.stream_packet_context
) {
1631 * We expect a trace packet header and/or stream packet
1632 * context. Since a trace needs to have at least one
1633 * packet, empty files are therefore not accepted.
1635 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1639 * Without trace packet header nor stream packet
1640 * context, a one-packet trace can indeed be empty. This
1641 * is only valid if there is only one stream class: 0.
1643 ret
= stream_assign_class(td
, file_stream
, 0);
1650 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1651 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1660 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1664 if (td
->packet_header_decl
) {
1665 struct bt_definition
*definition
=
1666 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1667 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1672 stream
->trace_packet_header
=
1673 container_of(definition
, struct definition_struct
, p
);
1674 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1680 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
1685 * Note: many file streams can inherit from the same stream class
1686 * description (metadata).
1689 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1690 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1693 int ret
, fd
, closeret
;
1694 struct ctf_file_stream
*file_stream
;
1695 struct stat statbuf
;
1697 fd
= openat(td
->dirfd
, path
, flags
);
1699 perror("File stream openat()");
1704 /* Don't try to mmap subdirectories. Skip them, return success. */
1705 ret
= fstat(fd
, &statbuf
);
1707 perror("File stream fstat()");
1710 if (S_ISDIR(statbuf
.st_mode
)) {
1711 fprintf(stderr
, "[warning] Skipping directory '%s' found in trace\n", path
);
1716 file_stream
= g_new0(struct ctf_file_stream
, 1);
1717 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1719 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
1720 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
1723 file_stream
->pos
.packet_seek
= packet_seek
;
1725 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1730 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
1733 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1737 * For now, only a single clock per trace is supported.
1739 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
1740 ret
= create_stream_packet_index(td
, file_stream
);
1742 fprintf(stderr
, "[error] Stream index creation error.\n");
1745 /* Add stream file to stream class */
1746 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1747 &file_stream
->parent
);
1751 if (file_stream
->parent
.trace_packet_header
)
1752 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1754 closeret
= ctf_fini_pos(&file_stream
->pos
);
1756 fprintf(stderr
, "Error on ctf_fini_pos\n");
1758 g_free(file_stream
);
1761 closeret
= close(fd
);
1763 perror("Error on fd close");
1770 int ctf_open_trace_read(struct ctf_trace
*td
,
1771 const char *path
, int flags
,
1772 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1773 int whence
), FILE *metadata_fp
)
1776 struct dirent
*dirent
;
1777 struct dirent
*diriter
;
1782 /* Open trace directory */
1783 td
->dir
= opendir(path
);
1785 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
1790 td
->dirfd
= open(path
, 0);
1791 if (td
->dirfd
< 0) {
1792 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
1793 perror("Trace directory open");
1797 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
1798 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
1801 * Keep the metadata file separate.
1804 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1806 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
1807 goto error_metadata
;
1811 * Open each stream: for each file, try to open, check magic
1812 * number, and get the stream ID to add to the right location in
1816 dirent_len
= offsetof(struct dirent
, d_name
) +
1817 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1819 dirent
= malloc(dirent_len
);
1822 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1824 fprintf(stderr
, "[error] Readdir error.\n");
1829 /* Ignore hidden files, ., .. and metadata. */
1830 if (!strncmp(diriter
->d_name
, ".", 1)
1831 || !strcmp(diriter
->d_name
, "..")
1832 || !strcmp(diriter
->d_name
, "metadata"))
1834 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1835 flags
, packet_seek
);
1837 fprintf(stderr
, "[error] Open file stream error.\n");
1848 closeret
= close(td
->dirfd
);
1850 perror("Error on fd close");
1853 closeret
= closedir(td
->dir
);
1855 perror("Error on closedir");
1862 * ctf_open_trace: Open a CTF trace and index it.
1863 * Note that the user must seek the trace after the open (using the iterator)
1864 * since the index creation read it entirely.
1867 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1868 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1869 int whence
), FILE *metadata_fp
)
1871 struct ctf_trace
*td
;
1875 * If packet_seek is NULL, we provide our default version.
1878 packet_seek
= ctf_packet_seek
;
1880 td
= g_new0(struct ctf_trace
, 1);
1882 switch (flags
& O_ACCMODE
) {
1885 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1888 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
1893 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1896 fprintf(stderr
, "[error] Incorrect open flags.\n");
1907 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1908 struct bt_mmap_stream
*mmap_info
)
1910 pos
->mmap_offset
= 0;
1911 pos
->packet_size
= 0;
1912 pos
->content_size
= 0;
1913 pos
->content_size_loc
= NULL
;
1914 pos
->fd
= mmap_info
->fd
;
1915 pos
->base_mma
= NULL
;
1919 pos
->packet_cycles_index
= NULL
;
1920 pos
->packet_real_index
= NULL
;
1921 pos
->prot
= PROT_READ
;
1922 pos
->flags
= MAP_PRIVATE
;
1923 pos
->parent
.rw_table
= read_dispatch_table
;
1924 pos
->parent
.event_cb
= ctf_read_event
;
1928 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1929 struct ctf_file_stream
*file_stream
)
1931 struct ctf_stream_declaration
*stream
;
1932 uint64_t stream_id
= 0;
1935 file_stream
->parent
.stream_id
= stream_id
;
1936 if (stream_id
>= td
->streams
->len
) {
1937 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1938 "in metadata.\n", stream_id
);
1942 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1944 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1945 "in metadata.\n", stream_id
);
1949 file_stream
->parent
.stream_class
= stream
;
1950 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1956 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1957 struct bt_mmap_stream
*mmap_info
,
1958 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1962 struct ctf_file_stream
*file_stream
;
1964 file_stream
= g_new0(struct ctf_file_stream
, 1);
1965 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1966 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1968 file_stream
->pos
.packet_seek
= packet_seek
;
1970 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1975 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1980 * For now, only a single clock per trace is supported.
1982 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
1984 /* Add stream file to stream class */
1985 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1986 &file_stream
->parent
);
1990 if (file_stream
->parent
.trace_packet_header
)
1991 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1993 g_free(file_stream
);
1998 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1999 struct bt_mmap_stream_list
*mmap_list
,
2000 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2005 struct bt_mmap_stream
*mmap_info
;
2007 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
2013 * for each stream, try to open, check magic number, and get the
2014 * stream ID to add to the right location in the stream array.
2016 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2017 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2019 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2031 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2032 struct bt_mmap_stream_list
*mmap_list
,
2033 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2037 struct ctf_trace
*td
;
2041 fprintf(stderr
, "[error] No metadata file pointer associated, "
2042 "required for mmap parsing\n");
2046 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2049 td
= g_new0(struct ctf_trace
, 1);
2050 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2063 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2066 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2068 /* for each stream_class */
2069 for (i
= 0; i
< td
->streams
->len
; i
++) {
2070 struct ctf_stream_declaration
*stream_class
;
2072 stream_class
= g_ptr_array_index(td
->streams
, i
);
2075 /* for each file_stream */
2076 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2077 struct ctf_stream_definition
*stream
;
2078 struct ctf_stream_pos
*stream_pos
;
2079 struct ctf_file_stream
*cfs
;
2081 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2084 cfs
= container_of(stream
, struct ctf_file_stream
,
2086 stream_pos
= &cfs
->pos
;
2087 if (!stream_pos
->packet_cycles_index
)
2090 for (k
= 0; k
< stream_pos
->packet_cycles_index
->len
; k
++) {
2091 struct packet_index
*index
;
2092 struct packet_index new_index
;
2094 index
= &g_array_index(stream_pos
->packet_cycles_index
,
2095 struct packet_index
, k
);
2096 memcpy(&new_index
, index
,
2097 sizeof(struct packet_index
));
2098 new_index
.timestamp_begin
=
2099 ctf_get_real_timestamp(stream
,
2100 index
->timestamp_begin
);
2101 new_index
.timestamp_end
=
2102 ctf_get_real_timestamp(stream
,
2103 index
->timestamp_end
);
2104 g_array_append_val(stream_pos
->packet_real_index
,
2113 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2117 ret
= ctf_fini_pos(&file_stream
->pos
);
2119 fprintf(stderr
, "Error on ctf_fini_pos\n");
2122 ret
= close(file_stream
->pos
.fd
);
2124 perror("Error closing file fd");
2131 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2133 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2139 for (i
= 0; i
< td
->streams
->len
; i
++) {
2140 struct ctf_stream_declaration
*stream
;
2143 stream
= g_ptr_array_index(td
->streams
, i
);
2146 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2147 struct ctf_file_stream
*file_stream
;
2148 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2149 struct ctf_file_stream
, parent
);
2150 ret
= ctf_close_file_stream(file_stream
);
2156 ctf_destroy_metadata(td
);
2157 ret
= close(td
->dirfd
);
2159 perror("Error closing dirfd");
2162 ret
= closedir(td
->dir
);
2164 perror("Error closedir");
2167 free(td
->metadata_string
);
2173 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2174 struct bt_context
*ctx
)
2176 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2179 td
->parent
.ctx
= ctx
;
2183 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2184 struct bt_trace_handle
*handle
)
2186 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2189 td
->parent
.handle
= handle
;
2193 void __attribute__((constructor
)) ctf_init(void)
2197 ctf_format
.name
= g_quark_from_static_string("ctf");
2198 ret
= bt_register_format(&ctf_format
);
2203 void __attribute__((destructor
)) ctf_exit(void)
2205 bt_unregister_format(&ctf_format
);