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/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 "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
;
84 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
85 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
89 struct bt_trace_descriptor
*ctf_open_mmap_trace(
90 struct bt_mmap_stream_list
*mmap_list
,
91 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
95 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
96 struct bt_context
*ctx
);
98 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
99 struct bt_trace_handle
*handle
);
102 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
104 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
105 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
107 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
108 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
110 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
113 rw_dispatch read_dispatch_table
[] = {
114 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
115 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
116 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
117 [ CTF_TYPE_STRING
] = ctf_string_read
,
118 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
119 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
120 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
121 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
125 rw_dispatch write_dispatch_table
[] = {
126 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
127 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
128 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
129 [ CTF_TYPE_STRING
] = ctf_string_write
,
130 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
131 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
132 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
133 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
137 struct bt_format ctf_format
= {
138 .open_trace
= ctf_open_trace
,
139 .open_mmap_trace
= ctf_open_mmap_trace
,
140 .close_trace
= ctf_close_trace
,
141 .set_context
= ctf_set_context
,
142 .set_handle
= ctf_set_handle
,
143 .timestamp_begin
= ctf_timestamp_begin
,
144 .timestamp_end
= ctf_timestamp_end
,
145 .convert_index_timestamp
= ctf_convert_index_timestamp
,
149 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
150 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
152 struct ctf_trace
*tin
;
153 uint64_t begin
= ULLONG_MAX
;
156 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
161 /* for each stream_class */
162 for (i
= 0; i
< tin
->streams
->len
; i
++) {
163 struct ctf_stream_declaration
*stream_class
;
165 stream_class
= g_ptr_array_index(tin
->streams
, i
);
168 /* for each file_stream */
169 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
170 struct ctf_stream_definition
*stream
;
171 struct ctf_file_stream
*cfs
;
172 struct ctf_stream_pos
*stream_pos
;
173 struct packet_index
*index
;
175 stream
= g_ptr_array_index(stream_class
->streams
, j
);
176 cfs
= container_of(stream
, struct ctf_file_stream
,
178 stream_pos
= &cfs
->pos
;
180 if (!stream_pos
->packet_real_index
)
183 if (stream_pos
->packet_real_index
->len
<= 0)
186 if (type
== BT_CLOCK_REAL
) {
187 index
= &g_array_index(stream_pos
->packet_real_index
,
189 stream_pos
->packet_real_index
->len
- 1);
190 } else if (type
== BT_CLOCK_CYCLES
) {
191 index
= &g_array_index(stream_pos
->packet_cycles_index
,
193 stream_pos
->packet_real_index
->len
- 1);
198 if (index
->timestamp_begin
< begin
)
199 begin
= index
->timestamp_begin
;
210 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
211 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
213 struct ctf_trace
*tin
;
217 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
222 /* for each stream_class */
223 for (i
= 0; i
< tin
->streams
->len
; i
++) {
224 struct ctf_stream_declaration
*stream_class
;
226 stream_class
= g_ptr_array_index(tin
->streams
, i
);
229 /* for each file_stream */
230 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
231 struct ctf_stream_definition
*stream
;
232 struct ctf_file_stream
*cfs
;
233 struct ctf_stream_pos
*stream_pos
;
234 struct packet_index
*index
;
236 stream
= g_ptr_array_index(stream_class
->streams
, j
);
237 cfs
= container_of(stream
, struct ctf_file_stream
,
239 stream_pos
= &cfs
->pos
;
241 if (!stream_pos
->packet_real_index
)
244 if (stream_pos
->packet_real_index
->len
<= 0)
247 if (type
== BT_CLOCK_REAL
) {
248 index
= &g_array_index(stream_pos
->packet_real_index
,
250 stream_pos
->packet_real_index
->len
- 1);
251 } else if (type
== BT_CLOCK_CYCLES
) {
252 index
= &g_array_index(stream_pos
->packet_cycles_index
,
254 stream_pos
->packet_real_index
->len
- 1);
259 if (index
->timestamp_end
> end
)
260 end
= index
->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 */
325 ts_sec
+= opt_clock_offset
;
327 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
328 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
330 if (!opt_clock_seconds
) {
332 time_t time_s
= (time_t) ts_sec
;
334 if (!opt_clock_gmt
) {
337 res
= localtime_r(&time_s
, &tm
);
339 fprintf(stderr
, "[warning] Unable to get localtime.\n");
345 res
= gmtime_r(&time_s
, &tm
);
347 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
351 if (opt_clock_date
) {
355 /* Print date and time */
356 res
= strftime(timestr
, sizeof(timestr
),
359 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
362 fprintf(fp
, "%s", timestr
);
364 /* Print time in HH:MM:SS.ns */
365 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
366 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
370 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
378 * Print timestamp, in cycles
381 void ctf_print_timestamp_cycles(FILE *fp
,
382 struct ctf_stream_definition
*stream
,
385 fprintf(fp
, "%020" PRIu64
, timestamp
);
388 void ctf_print_timestamp(FILE *fp
,
389 struct ctf_stream_definition
*stream
,
392 if (opt_clock_cycles
) {
393 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
395 ctf_print_timestamp_real(fp
, stream
, timestamp
);
400 void print_uuid(FILE *fp
, unsigned char *uuid
)
404 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
405 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
408 void ctf_print_discarded(FILE *fp
, struct ctf_stream_definition
*stream
,
411 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events %sbetween [",
412 stream
->events_discarded
,
413 end_stream
? "at end of stream " : "");
414 if (opt_clock_cycles
) {
415 ctf_print_timestamp(fp
, stream
,
416 stream
->prev_cycles_timestamp
);
417 fprintf(fp
, "] and [");
418 ctf_print_timestamp(fp
, stream
,
419 stream
->prev_cycles_timestamp_end
);
421 ctf_print_timestamp(fp
, stream
,
422 stream
->prev_real_timestamp
);
423 fprintf(fp
, "] and [");
424 ctf_print_timestamp(fp
, stream
,
425 stream
->prev_real_timestamp_end
);
427 fprintf(fp
, "] in trace UUID ");
428 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
429 if (stream
->stream_class
->trace
->parent
.path
[0])
430 fprintf(fp
, ", at path: \"%s\"",
431 stream
->stream_class
->trace
->parent
.path
);
433 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
435 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
437 fprintf(fp
, "You should consider recording a new trace with larger "
438 "buffers or with fewer events enabled.\n");
443 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
445 struct ctf_stream_pos
*pos
=
446 container_of(ppos
, struct ctf_stream_pos
, parent
);
447 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
448 struct ctf_event_definition
*event
;
452 /* We need to check for EOF here for empty files. */
453 if (unlikely(pos
->offset
== EOF
))
456 ctf_pos_get_event(pos
);
458 /* save the current position as a restore point */
459 pos
->last_offset
= pos
->offset
;
462 * This is the EOF check after we've advanced the position in
465 if (unlikely(pos
->offset
== EOF
))
467 assert(pos
->offset
< pos
->content_size
);
469 /* Read event header */
470 if (likely(stream
->stream_event_header
)) {
471 struct definition_integer
*integer_definition
;
472 struct bt_definition
*variant
;
474 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
477 /* lookup event id */
478 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
479 if (integer_definition
) {
480 id
= integer_definition
->value
._unsigned
;
482 struct definition_enum
*enum_definition
;
484 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
485 if (enum_definition
) {
486 id
= enum_definition
->integer
->value
._unsigned
;
490 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
492 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
493 if (integer_definition
) {
494 id
= integer_definition
->value
._unsigned
;
497 stream
->event_id
= id
;
499 /* lookup timestamp */
500 stream
->has_timestamp
= 0;
501 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
502 if (integer_definition
) {
503 ctf_update_timestamp(stream
, integer_definition
);
504 stream
->has_timestamp
= 1;
507 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
508 if (integer_definition
) {
509 ctf_update_timestamp(stream
, integer_definition
);
510 stream
->has_timestamp
= 1;
516 /* Read stream-declared event context */
517 if (stream
->stream_event_context
) {
518 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
523 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
524 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
527 event
= g_ptr_array_index(stream
->events_by_id
, id
);
528 if (unlikely(!event
)) {
529 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
533 /* Read event-declared event context */
534 if (event
->event_context
) {
535 ret
= generic_rw(ppos
, &event
->event_context
->p
);
540 /* Read event payload */
541 if (likely(event
->event_fields
)) {
542 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
550 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
555 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
557 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
558 struct ctf_event_definition
*event
;
562 id
= stream
->event_id
;
564 /* print event header */
565 if (likely(stream
->stream_event_header
)) {
566 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
571 /* print stream-declared event context */
572 if (stream
->stream_event_context
) {
573 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
578 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
579 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
582 event
= g_ptr_array_index(stream
->events_by_id
, id
);
583 if (unlikely(!event
)) {
584 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
588 /* print event-declared event context */
589 if (event
->event_context
) {
590 ret
= generic_rw(pos
, &event
->event_context
->p
);
595 /* Read and print event payload */
596 if (likely(event
->event_fields
)) {
597 ret
= generic_rw(pos
, &event
->event_fields
->p
);
605 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
609 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
610 int fd
, int open_flags
)
614 pos
->packet_cycles_index
= g_array_new(FALSE
, TRUE
,
615 sizeof(struct packet_index
));
616 pos
->packet_real_index
= g_array_new(FALSE
, TRUE
,
617 sizeof(struct packet_index
));
619 pos
->packet_cycles_index
= NULL
;
620 pos
->packet_real_index
= NULL
;
622 switch (open_flags
& O_ACCMODE
) {
624 pos
->prot
= PROT_READ
;
625 pos
->flags
= MAP_PRIVATE
;
626 pos
->parent
.rw_table
= read_dispatch_table
;
627 pos
->parent
.event_cb
= ctf_read_event
;
628 pos
->parent
.trace
= trace
;
631 pos
->prot
= PROT_WRITE
; /* Write has priority */
632 pos
->flags
= MAP_SHARED
;
633 pos
->parent
.rw_table
= write_dispatch_table
;
634 pos
->parent
.event_cb
= ctf_write_event
;
635 pos
->parent
.trace
= trace
;
637 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
645 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
647 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
648 *pos
->content_size_loc
= pos
->offset
;
653 ret
= munmap_align(pos
->base_mma
);
655 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
660 if (pos
->packet_cycles_index
)
661 (void) g_array_free(pos
->packet_cycles_index
, TRUE
);
662 if (pos
->packet_real_index
)
663 (void) g_array_free(pos
->packet_real_index
, TRUE
);
668 * for SEEK_CUR: go to next packet.
669 * for SEEK_POS: go to packet numer (index).
671 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
673 struct ctf_stream_pos
*pos
=
674 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
675 struct ctf_file_stream
*file_stream
=
676 container_of(pos
, struct ctf_file_stream
, pos
);
679 struct packet_index
*packet_index
;
681 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
682 *pos
->content_size_loc
= pos
->offset
;
686 ret
= munmap_align(pos
->base_mma
);
688 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
692 pos
->base_mma
= NULL
;
696 * The caller should never ask for ctf_move_pos across packets,
697 * except to get exactly at the beginning of the next packet.
699 if (pos
->prot
== PROT_WRITE
) {
702 /* The writer will add padding */
703 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
706 assert(index
== 0); /* only seek supported for now */
712 pos
->content_size
= -1U; /* Unknown at this point */
713 pos
->packet_size
= WRITE_PACKET_LEN
;
714 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
715 pos
->packet_size
/ CHAR_BIT
);
723 uint64_t events_discarded_diff
;
725 if (pos
->offset
== EOF
) {
728 /* For printing discarded event count */
729 packet_index
= &g_array_index(pos
->packet_cycles_index
,
730 struct packet_index
, pos
->cur_index
);
731 file_stream
->parent
.prev_cycles_timestamp_end
=
732 packet_index
->timestamp_end
;
733 file_stream
->parent
.prev_cycles_timestamp
=
734 packet_index
->timestamp_begin
;
736 packet_index
= &g_array_index(pos
->packet_real_index
,
737 struct packet_index
, pos
->cur_index
);
738 file_stream
->parent
.prev_real_timestamp_end
=
739 packet_index
->timestamp_end
;
740 file_stream
->parent
.prev_real_timestamp
=
741 packet_index
->timestamp_begin
;
743 events_discarded_diff
= packet_index
->events_discarded
;
744 if (pos
->cur_index
> 0) {
745 packet_index
= &g_array_index(pos
->packet_real_index
,
748 events_discarded_diff
-= packet_index
->events_discarded
;
750 * Deal with 32-bit wrap-around if the
751 * tracer provided a 32-bit field.
753 if (packet_index
->events_discarded_len
== 32) {
754 events_discarded_diff
= (uint32_t) events_discarded_diff
;
757 file_stream
->parent
.events_discarded
= events_discarded_diff
;
758 file_stream
->parent
.prev_real_timestamp
= file_stream
->parent
.real_timestamp
;
759 file_stream
->parent
.prev_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
760 /* The reader will expect us to skip padding */
765 packet_index
= &g_array_index(pos
->packet_cycles_index
,
766 struct packet_index
, index
);
767 pos
->last_events_discarded
= packet_index
->events_discarded
;
768 pos
->cur_index
= index
;
769 file_stream
->parent
.prev_real_timestamp
= 0;
770 file_stream
->parent
.prev_real_timestamp_end
= 0;
771 file_stream
->parent
.prev_cycles_timestamp
= 0;
772 file_stream
->parent
.prev_cycles_timestamp_end
= 0;
777 if (pos
->cur_index
>= pos
->packet_real_index
->len
) {
779 * We need to check if we are in trace read or
780 * called from packet indexing. In this last
781 * case, the collection is not there, so we
782 * cannot print the timestamps.
784 if ((&file_stream
->parent
)->stream_class
->trace
->collection
) {
786 * When a stream reaches the end of the
787 * file, we need to show the number of
788 * events discarded ourselves, because
789 * there is no next event scheduled to
790 * be printed in the output.
792 if (file_stream
->parent
.events_discarded
) {
794 ctf_print_discarded(stderr
,
795 &file_stream
->parent
,
797 file_stream
->parent
.events_discarded
= 0;
803 packet_index
= &g_array_index(pos
->packet_cycles_index
,
806 file_stream
->parent
.cycles_timestamp
= packet_index
->timestamp_begin
;
808 packet_index
= &g_array_index(pos
->packet_real_index
,
811 file_stream
->parent
.real_timestamp
= packet_index
->timestamp_begin
;
812 pos
->mmap_offset
= packet_index
->offset
;
814 /* Lookup context/packet size in index */
815 pos
->content_size
= packet_index
->content_size
;
816 pos
->packet_size
= packet_index
->packet_size
;
817 if (packet_index
->data_offset
< packet_index
->content_size
) {
818 pos
->offset
= 0; /* will read headers */
819 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
821 pos
->offset
= packet_index
->data_offset
;
823 goto read_next_packet
;
829 /* map new base. Need mapping length from header. */
830 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
831 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
832 if (pos
->base_mma
== MAP_FAILED
) {
833 fprintf(stderr
, "[error] mmap error %s.\n",
838 /* update trace_packet_header and stream_packet_context */
839 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
840 /* Read packet header */
841 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
844 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
845 /* Read packet context */
846 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
852 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
858 len
= fread(&magic
, sizeof(magic
), 1, fp
);
862 if (magic
== TSDL_MAGIC
) {
864 td
->byte_order
= BYTE_ORDER
;
865 CTF_TRACE_SET_FIELD(td
, byte_order
);
866 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
868 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
869 LITTLE_ENDIAN
: BIG_ENDIAN
;
870 CTF_TRACE_SET_FIELD(td
, byte_order
);
878 * Returns 0 on success, -1 on error.
881 int check_version(unsigned int major
, unsigned int minor
)
896 /* eventually return an error instead of warning */
898 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
904 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
907 struct metadata_packet_header header
;
908 size_t readlen
, writelen
, toread
;
909 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
912 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
916 if (td
->byte_order
!= BYTE_ORDER
) {
917 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
918 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
919 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
920 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
923 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
924 if (header
.compression_scheme
) {
925 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
926 header
.compression_scheme
);
929 if (header
.encryption_scheme
) {
930 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
931 header
.encryption_scheme
);
934 if (header
.checksum_scheme
) {
935 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
936 header
.checksum_scheme
);
939 if (check_version(header
.major
, header
.minor
) < 0)
941 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
942 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
943 CTF_TRACE_SET_FIELD(td
, uuid
);
945 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
949 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
952 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
955 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
960 if (babeltrace_debug
) {
962 fprintf(stderr
, "[debug] metadata packet read: %s\n",
966 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
967 if (writelen
< readlen
) {
977 ret
= 0; /* continue reading next packet */
984 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
985 ret
= fseek(in
, toread
, SEEK_CUR
);
987 fprintf(stderr
, "[warning] Missing padding at end of file\n");
994 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1003 * Using strlen on *buf instead of size of open_memstream
1004 * because its size includes garbage at the end (after final
1005 * \0). This is the allocated size, not the actual string size.
1007 out
= babeltrace_open_memstream(buf
, &size
);
1009 perror("Metadata open_memstream");
1013 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
1022 /* close to flush the buffer */
1023 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1027 perror("babeltrace_flush_memstream");
1029 closeret
= fclose(in
);
1031 perror("Error in fclose");
1037 perror("Error in fclose");
1039 /* open for reading */
1040 buflen
= strlen(*buf
);
1045 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1047 perror("Metadata fmemopen");
1054 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
1055 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1056 int whence
), FILE *metadata_fp
)
1058 struct ctf_scanner
*scanner
;
1059 struct ctf_file_stream
*metadata_stream
;
1062 int ret
= 0, closeret
;
1064 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1065 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1068 metadata_stream
->pos
.packet_seek
= packet_seek
;
1070 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1077 metadata_stream
->pos
.fd
= -1;
1079 td
->metadata
= &metadata_stream
->parent
;
1080 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1081 if (metadata_stream
->pos
.fd
< 0) {
1082 fprintf(stderr
, "Unable to open metadata.\n");
1087 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1089 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1090 perror("Metadata stream open");
1094 /* fd now belongs to fp */
1095 metadata_stream
->pos
.fd
= -1;
1097 if (babeltrace_debug
)
1100 if (packet_metadata(td
, fp
)) {
1101 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
1103 /* Warn about empty metadata */
1104 fprintf(stderr
, "[warning] Empty metadata.\n");
1105 goto end_packet_read
;
1107 td
->metadata_string
= buf
;
1108 td
->metadata_packetized
= 1;
1110 unsigned int major
, minor
;
1113 td
->byte_order
= BYTE_ORDER
;
1115 /* Check text-only metadata header and version */
1116 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
1118 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1119 if (check_version(major
, minor
) < 0) {
1121 goto end_packet_read
;
1126 scanner
= ctf_scanner_alloc(fp
);
1128 fprintf(stderr
, "[error] Error allocating scanner\n");
1130 goto end_scanner_alloc
;
1132 ret
= ctf_scanner_append_ast(scanner
);
1134 fprintf(stderr
, "[error] Error creating AST\n");
1138 if (babeltrace_debug
) {
1139 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1141 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1146 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1148 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1151 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1152 td
, td
->byte_order
);
1154 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1158 ctf_scanner_free(scanner
);
1162 closeret
= fclose(fp
);
1164 perror("Error on fclose");
1168 if (metadata_stream
->pos
.fd
>= 0) {
1169 closeret
= close(metadata_stream
->pos
.fd
);
1171 perror("Error on metadata stream fd close");
1176 g_free(metadata_stream
);
1181 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1182 struct ctf_stream_definition
*stream
,
1183 struct ctf_event_declaration
*event
)
1185 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1187 if (event
->context_decl
) {
1188 struct bt_definition
*definition
=
1189 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1190 stream
->parent_def_scope
, 0, 0, "event.context");
1194 stream_event
->event_context
= container_of(definition
,
1195 struct definition_struct
, p
);
1196 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1198 if (event
->fields_decl
) {
1199 struct bt_definition
*definition
=
1200 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1201 stream
->parent_def_scope
, 0, 0, "event.fields");
1205 stream_event
->event_fields
= container_of(definition
,
1206 struct definition_struct
, p
);
1207 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1209 stream_event
->stream
= stream
;
1210 return stream_event
;
1213 if (stream_event
->event_fields
)
1214 bt_definition_unref(&stream_event
->event_fields
->p
);
1215 if (stream_event
->event_context
)
1216 bt_definition_unref(&stream_event
->event_context
->p
);
1221 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1223 struct ctf_stream_declaration
*stream_class
;
1227 if (stream
->stream_definitions_created
)
1230 stream_class
= stream
->stream_class
;
1232 if (stream_class
->packet_context_decl
) {
1233 struct bt_definition
*definition
=
1234 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1235 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1240 stream
->stream_packet_context
= container_of(definition
,
1241 struct definition_struct
, p
);
1242 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1244 if (stream_class
->event_header_decl
) {
1245 struct bt_definition
*definition
=
1246 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1247 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1252 stream
->stream_event_header
=
1253 container_of(definition
, struct definition_struct
, p
);
1254 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1256 if (stream_class
->event_context_decl
) {
1257 struct bt_definition
*definition
=
1258 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1259 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1264 stream
->stream_event_context
=
1265 container_of(definition
, struct definition_struct
, p
);
1266 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1268 stream
->events_by_id
= g_ptr_array_new();
1269 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
1270 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1271 struct ctf_event_declaration
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
1272 struct ctf_event_definition
*stream_event
;
1276 stream_event
= create_event_definitions(td
, stream
, event
);
1279 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1284 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1285 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1287 g_free(stream_event
);
1289 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1291 if (stream
->stream_event_context
)
1292 bt_definition_unref(&stream
->stream_event_context
->p
);
1293 if (stream
->stream_event_header
)
1294 bt_definition_unref(&stream
->stream_event_header
->p
);
1295 if (stream
->stream_packet_context
)
1296 bt_definition_unref(&stream
->stream_packet_context
->p
);
1301 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1302 struct ctf_trace
*td
,
1303 struct ctf_file_stream
*file_stream
,
1306 struct packet_index packet_index
;
1307 struct ctf_stream_declaration
*stream
;
1308 uint64_t stream_id
= 0;
1309 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1310 int first_packet
= 0;
1315 if (!pos
->mmap_offset
) {
1319 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1320 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1323 if (pos
->base_mma
) {
1324 /* unmap old base */
1325 ret
= munmap_align(pos
->base_mma
);
1327 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1331 pos
->base_mma
= NULL
;
1333 /* map new base. Need mapping length from header. */
1334 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1335 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1336 assert(pos
->base_mma
!= MAP_FAILED
);
1338 * Use current mapping size as temporary content and packet
1341 pos
->content_size
= packet_map_len
;
1342 pos
->packet_size
= packet_map_len
;
1343 pos
->offset
= 0; /* Position of the packet header */
1345 packet_index
.offset
= pos
->mmap_offset
;
1346 packet_index
.content_size
= 0;
1347 packet_index
.packet_size
= 0;
1348 packet_index
.timestamp_begin
= 0;
1349 packet_index
.timestamp_end
= 0;
1350 packet_index
.events_discarded
= 0;
1351 packet_index
.events_discarded_len
= 0;
1353 /* read and check header, set stream id (and check) */
1354 if (file_stream
->parent
.trace_packet_header
) {
1355 /* Read packet header */
1356 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1362 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1363 if (len_index
>= 0) {
1364 struct bt_definition
*field
;
1367 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1368 magic
= bt_get_unsigned_int(field
);
1369 if (magic
!= CTF_MAGIC
) {
1370 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1372 file_stream
->pos
.packet_cycles_index
->len
,
1373 (ssize_t
) pos
->mmap_offset
);
1379 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1380 if (len_index
>= 0) {
1381 struct definition_array
*defarray
;
1382 struct bt_definition
*field
;
1384 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1386 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1387 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1388 defarray
= container_of(field
, struct definition_array
, p
);
1389 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1391 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1392 struct bt_definition
*elem
;
1394 elem
= bt_array_index(defarray
, i
);
1395 uuidval
[i
] = bt_get_unsigned_int(elem
);
1397 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1399 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1404 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1405 if (len_index
>= 0) {
1406 struct bt_definition
*field
;
1408 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1409 stream_id
= bt_get_unsigned_int(field
);
1413 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1414 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1416 file_stream
->parent
.stream_id
);
1420 file_stream
->parent
.stream_id
= stream_id
;
1421 if (stream_id
>= td
->streams
->len
) {
1422 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1425 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1427 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1430 file_stream
->parent
.stream_class
= stream
;
1431 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1436 if (file_stream
->parent
.stream_packet_context
) {
1437 /* Read packet context */
1438 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1444 /* read content size from header */
1445 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1446 if (len_index
>= 0) {
1447 struct bt_definition
*field
;
1449 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1450 packet_index
.content_size
= bt_get_unsigned_int(field
);
1452 /* Use file size for packet size */
1453 packet_index
.content_size
= filesize
* CHAR_BIT
;
1456 /* read packet size from header */
1457 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1458 if (len_index
>= 0) {
1459 struct bt_definition
*field
;
1461 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1462 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1464 /* Use content size if non-zero, else file size */
1465 packet_index
.packet_size
= packet_index
.content_size
? : filesize
* CHAR_BIT
;
1468 /* read timestamp begin from header */
1469 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1470 if (len_index
>= 0) {
1471 struct bt_definition
*field
;
1473 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1474 packet_index
.timestamp_begin
= bt_get_unsigned_int(field
);
1475 if (file_stream
->parent
.stream_class
->trace
->collection
) {
1476 packet_index
.timestamp_begin
=
1477 ctf_get_real_timestamp(
1478 &file_stream
->parent
,
1479 packet_index
.timestamp_begin
);
1483 /* read timestamp end from header */
1484 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1485 if (len_index
>= 0) {
1486 struct bt_definition
*field
;
1488 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1489 packet_index
.timestamp_end
= bt_get_unsigned_int(field
);
1490 if (file_stream
->parent
.stream_class
->trace
->collection
) {
1491 packet_index
.timestamp_end
=
1492 ctf_get_real_timestamp(
1493 &file_stream
->parent
,
1494 packet_index
.timestamp_end
);
1498 /* read events discarded from header */
1499 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1500 if (len_index
>= 0) {
1501 struct bt_definition
*field
;
1503 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1504 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1505 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1508 /* Use file size for packet size */
1509 packet_index
.content_size
= filesize
* CHAR_BIT
;
1510 /* Use content size if non-zero, else file size */
1511 packet_index
.packet_size
= packet_index
.content_size
? : filesize
* CHAR_BIT
;
1514 /* Validate content size and packet size values */
1515 if (packet_index
.content_size
> packet_index
.packet_size
) {
1516 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1517 packet_index
.content_size
, packet_index
.packet_size
);
1521 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1522 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1523 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1527 /* Save position after header and context */
1528 packet_index
.data_offset
= pos
->offset
;
1530 /* add index to packet array */
1531 g_array_append_val(file_stream
->pos
.packet_cycles_index
, packet_index
);
1533 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1537 /* Retry with larger mapping */
1539 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1541 * Reached EOF, but still expecting header/context data.
1543 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1546 /* Double the mapping len, and retry */
1547 tmp_map_len
= packet_map_len
<< 1;
1548 if (tmp_map_len
>> 1 != packet_map_len
) {
1552 packet_map_len
= tmp_map_len
;
1557 int create_stream_packet_index(struct ctf_trace
*td
,
1558 struct ctf_file_stream
*file_stream
)
1560 struct ctf_stream_pos
*pos
;
1561 struct stat filestats
;
1564 pos
= &file_stream
->pos
;
1566 ret
= fstat(pos
->fd
, &filestats
);
1570 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1571 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1580 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1584 if (td
->packet_header_decl
) {
1585 struct bt_definition
*definition
=
1586 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1587 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1592 stream
->trace_packet_header
=
1593 container_of(definition
, struct definition_struct
, p
);
1594 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1604 * Note: many file streams can inherit from the same stream class
1605 * description (metadata).
1608 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1609 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1612 int ret
, fd
, closeret
;
1613 struct ctf_file_stream
*file_stream
;
1614 struct stat statbuf
;
1616 fd
= openat(td
->dirfd
, path
, flags
);
1618 perror("File stream openat()");
1623 /* Don't try to mmap subdirectories. Skip them, return success. */
1624 ret
= fstat(fd
, &statbuf
);
1626 perror("File stream fstat()");
1629 if (S_ISDIR(statbuf
.st_mode
)) {
1630 fprintf(stderr
, "[warning] Skipping directory '%s' found in trace\n", path
);
1635 file_stream
= g_new0(struct ctf_file_stream
, 1);
1636 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1638 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
1639 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
1642 file_stream
->pos
.packet_seek
= packet_seek
;
1644 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1649 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
1652 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1656 * For now, only a single clock per trace is supported.
1658 file_stream
->parent
.current_clock
= td
->single_clock
;
1659 ret
= create_stream_packet_index(td
, file_stream
);
1662 /* Add stream file to stream class */
1663 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1664 &file_stream
->parent
);
1668 if (file_stream
->parent
.trace_packet_header
)
1669 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1671 closeret
= ctf_fini_pos(&file_stream
->pos
);
1673 fprintf(stderr
, "Error on ctf_fini_pos\n");
1675 g_free(file_stream
);
1678 closeret
= close(fd
);
1680 perror("Error on fd close");
1687 int ctf_open_trace_read(struct ctf_trace
*td
,
1688 const char *path
, int flags
,
1689 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1690 int whence
), FILE *metadata_fp
)
1693 struct dirent
*dirent
;
1694 struct dirent
*diriter
;
1699 /* Open trace directory */
1700 td
->dir
= opendir(path
);
1702 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
1707 td
->dirfd
= open(path
, 0);
1708 if (td
->dirfd
< 0) {
1709 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
1710 perror("Trace directory open");
1714 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
1715 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
1718 * Keep the metadata file separate.
1721 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1723 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
1724 goto error_metadata
;
1728 * Open each stream: for each file, try to open, check magic
1729 * number, and get the stream ID to add to the right location in
1733 dirent_len
= offsetof(struct dirent
, d_name
) +
1734 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1736 dirent
= malloc(dirent_len
);
1739 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1741 fprintf(stderr
, "[error] Readdir error.\n");
1746 /* Ignore hidden files, ., .. and metadata. */
1747 if (!strncmp(diriter
->d_name
, ".", 1)
1748 || !strcmp(diriter
->d_name
, "..")
1749 || !strcmp(diriter
->d_name
, "metadata"))
1751 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1752 flags
, packet_seek
);
1754 fprintf(stderr
, "[error] Open file stream error.\n");
1765 closeret
= close(td
->dirfd
);
1767 perror("Error on fd close");
1770 closeret
= closedir(td
->dir
);
1772 perror("Error on closedir");
1779 * ctf_open_trace: Open a CTF trace and index it.
1780 * Note that the user must seek the trace after the open (using the iterator)
1781 * since the index creation read it entirely.
1784 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1785 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1786 int whence
), FILE *metadata_fp
)
1788 struct ctf_trace
*td
;
1792 * If packet_seek is NULL, we provide our default version.
1795 packet_seek
= ctf_packet_seek
;
1797 td
= g_new0(struct ctf_trace
, 1);
1799 switch (flags
& O_ACCMODE
) {
1802 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1805 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
1810 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1813 fprintf(stderr
, "[error] Incorrect open flags.\n");
1824 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1825 struct bt_mmap_stream
*mmap_info
)
1827 pos
->mmap_offset
= 0;
1828 pos
->packet_size
= 0;
1829 pos
->content_size
= 0;
1830 pos
->content_size_loc
= NULL
;
1831 pos
->fd
= mmap_info
->fd
;
1832 pos
->base_mma
= NULL
;
1836 pos
->packet_cycles_index
= NULL
;
1837 pos
->packet_real_index
= NULL
;
1838 pos
->prot
= PROT_READ
;
1839 pos
->flags
= MAP_PRIVATE
;
1840 pos
->parent
.rw_table
= read_dispatch_table
;
1841 pos
->parent
.event_cb
= ctf_read_event
;
1845 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1846 struct ctf_file_stream
*file_stream
)
1848 struct ctf_stream_declaration
*stream
;
1849 uint64_t stream_id
= 0;
1852 file_stream
->parent
.stream_id
= stream_id
;
1853 if (stream_id
>= td
->streams
->len
) {
1854 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1855 "in metadata.\n", stream_id
);
1859 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1861 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1862 "in metadata.\n", stream_id
);
1866 file_stream
->parent
.stream_class
= stream
;
1867 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1873 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1874 struct bt_mmap_stream
*mmap_info
,
1875 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1879 struct ctf_file_stream
*file_stream
;
1881 file_stream
= g_new0(struct ctf_file_stream
, 1);
1882 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1883 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1885 file_stream
->pos
.packet_seek
= packet_seek
;
1887 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1892 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1897 * For now, only a single clock per trace is supported.
1899 file_stream
->parent
.current_clock
= td
->single_clock
;
1901 /* Add stream file to stream class */
1902 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1903 &file_stream
->parent
);
1907 if (file_stream
->parent
.trace_packet_header
)
1908 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1910 g_free(file_stream
);
1915 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1916 struct bt_mmap_stream_list
*mmap_list
,
1917 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1922 struct bt_mmap_stream
*mmap_info
;
1924 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
1930 * for each stream, try to open, check magic number, and get the
1931 * stream ID to add to the right location in the stream array.
1933 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
1934 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
1936 fprintf(stderr
, "[error] Open file mmap stream error.\n");
1948 struct bt_trace_descriptor
*ctf_open_mmap_trace(
1949 struct bt_mmap_stream_list
*mmap_list
,
1950 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
1954 struct ctf_trace
*td
;
1958 fprintf(stderr
, "[error] No metadata file pointer associated, "
1959 "required for mmap parsing\n");
1963 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1966 td
= g_new0(struct ctf_trace
, 1);
1967 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
1980 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
1983 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1985 /* for each stream_class */
1986 for (i
= 0; i
< td
->streams
->len
; i
++) {
1987 struct ctf_stream_declaration
*stream_class
;
1989 stream_class
= g_ptr_array_index(td
->streams
, i
);
1992 /* for each file_stream */
1993 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
1994 struct ctf_stream_definition
*stream
;
1995 struct ctf_stream_pos
*stream_pos
;
1996 struct ctf_file_stream
*cfs
;
1998 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2001 cfs
= container_of(stream
, struct ctf_file_stream
,
2003 stream_pos
= &cfs
->pos
;
2004 if (!stream_pos
->packet_cycles_index
)
2007 for (k
= 0; k
< stream_pos
->packet_cycles_index
->len
; k
++) {
2008 struct packet_index
*index
;
2009 struct packet_index new_index
;
2011 index
= &g_array_index(stream_pos
->packet_cycles_index
,
2012 struct packet_index
, k
);
2013 memcpy(&new_index
, index
,
2014 sizeof(struct packet_index
));
2015 new_index
.timestamp_begin
=
2016 ctf_get_real_timestamp(stream
,
2017 index
->timestamp_begin
);
2018 new_index
.timestamp_end
=
2019 ctf_get_real_timestamp(stream
,
2020 index
->timestamp_end
);
2021 g_array_append_val(stream_pos
->packet_real_index
,
2030 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2034 ret
= ctf_fini_pos(&file_stream
->pos
);
2036 fprintf(stderr
, "Error on ctf_fini_pos\n");
2039 ret
= close(file_stream
->pos
.fd
);
2041 perror("Error closing file fd");
2048 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2050 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2056 for (i
= 0; i
< td
->streams
->len
; i
++) {
2057 struct ctf_stream_declaration
*stream
;
2060 stream
= g_ptr_array_index(td
->streams
, i
);
2063 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2064 struct ctf_file_stream
*file_stream
;
2065 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2066 struct ctf_file_stream
, parent
);
2067 ret
= ctf_close_file_stream(file_stream
);
2073 ctf_destroy_metadata(td
);
2074 ret
= close(td
->dirfd
);
2076 perror("Error closing dirfd");
2079 ret
= closedir(td
->dir
);
2081 perror("Error closedir");
2084 free(td
->metadata_string
);
2090 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2091 struct bt_context
*ctx
)
2093 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2100 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2101 struct bt_trace_handle
*handle
)
2103 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2106 td
->handle
= handle
;
2110 void __attribute__((constructor
)) ctf_init(void)
2114 ctf_format
.name
= g_quark_from_static_string("ctf");
2115 ret
= bt_register_format(&ctf_format
);
2120 void __attribute__((destructor
)) ctf_exit(void)
2122 bt_unregister_format(&ctf_format
);