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"
57 * We currently simply map a page to read the packet header and packet
58 * context to get the packet length and content length. (in bits)
60 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
61 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
64 #define min(a, b) (((a) < (b)) ? (a) : (b))
67 #define NSEC_PER_SEC 1000000000ULL
74 uint64_t opt_clock_offset
;
79 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
80 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
84 struct trace_descriptor
*ctf_open_mmap_trace(
85 struct mmap_stream_list
*mmap_list
,
86 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
90 void ctf_set_context(struct trace_descriptor
*descriptor
,
91 struct bt_context
*ctx
);
93 void ctf_set_handle(struct trace_descriptor
*descriptor
,
94 struct bt_trace_handle
*handle
);
97 int ctf_close_trace(struct trace_descriptor
*descriptor
);
99 uint64_t ctf_timestamp_begin(struct trace_descriptor
*descriptor
,
100 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
102 uint64_t ctf_timestamp_end(struct trace_descriptor
*descriptor
,
103 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
105 int ctf_convert_index_timestamp(struct trace_descriptor
*tdp
);
108 rw_dispatch read_dispatch_table
[] = {
109 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
110 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
111 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
112 [ CTF_TYPE_STRING
] = ctf_string_read
,
113 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
114 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
115 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
116 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
120 rw_dispatch write_dispatch_table
[] = {
121 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
122 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
123 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
124 [ CTF_TYPE_STRING
] = ctf_string_write
,
125 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
126 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
127 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
128 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
132 struct format ctf_format
= {
133 .open_trace
= ctf_open_trace
,
134 .open_mmap_trace
= ctf_open_mmap_trace
,
135 .close_trace
= ctf_close_trace
,
136 .set_context
= ctf_set_context
,
137 .set_handle
= ctf_set_handle
,
138 .timestamp_begin
= ctf_timestamp_begin
,
139 .timestamp_end
= ctf_timestamp_end
,
140 .convert_index_timestamp
= ctf_convert_index_timestamp
,
144 uint64_t ctf_timestamp_begin(struct trace_descriptor
*descriptor
,
145 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
147 struct ctf_trace
*tin
;
148 uint64_t begin
= ULLONG_MAX
;
151 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
156 /* for each stream_class */
157 for (i
= 0; i
< tin
->streams
->len
; i
++) {
158 struct ctf_stream_declaration
*stream_class
;
160 stream_class
= g_ptr_array_index(tin
->streams
, i
);
163 /* for each file_stream */
164 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
165 struct ctf_stream_definition
*stream
;
166 struct ctf_file_stream
*cfs
;
167 struct ctf_stream_pos
*stream_pos
;
168 struct packet_index
*index
;
170 stream
= g_ptr_array_index(stream_class
->streams
, j
);
171 cfs
= container_of(stream
, struct ctf_file_stream
,
173 stream_pos
= &cfs
->pos
;
175 if (!stream_pos
->packet_real_index
)
178 if (stream_pos
->packet_real_index
->len
<= 0)
181 if (type
== BT_CLOCK_REAL
) {
182 index
= &g_array_index(stream_pos
->packet_real_index
,
184 stream_pos
->packet_real_index
->len
- 1);
185 } else if (type
== BT_CLOCK_CYCLES
) {
186 index
= &g_array_index(stream_pos
->packet_cycles_index
,
188 stream_pos
->packet_real_index
->len
- 1);
193 if (index
->timestamp_begin
< begin
)
194 begin
= index
->timestamp_begin
;
205 uint64_t ctf_timestamp_end(struct trace_descriptor
*descriptor
,
206 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
208 struct ctf_trace
*tin
;
212 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
217 /* for each stream_class */
218 for (i
= 0; i
< tin
->streams
->len
; i
++) {
219 struct ctf_stream_declaration
*stream_class
;
221 stream_class
= g_ptr_array_index(tin
->streams
, i
);
224 /* for each file_stream */
225 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
226 struct ctf_stream_definition
*stream
;
227 struct ctf_file_stream
*cfs
;
228 struct ctf_stream_pos
*stream_pos
;
229 struct packet_index
*index
;
231 stream
= g_ptr_array_index(stream_class
->streams
, j
);
232 cfs
= container_of(stream
, struct ctf_file_stream
,
234 stream_pos
= &cfs
->pos
;
236 if (!stream_pos
->packet_real_index
)
239 if (stream_pos
->packet_real_index
->len
<= 0)
242 if (type
== BT_CLOCK_REAL
) {
243 index
= &g_array_index(stream_pos
->packet_real_index
,
245 stream_pos
->packet_real_index
->len
- 1);
246 } else if (type
== BT_CLOCK_CYCLES
) {
247 index
= &g_array_index(stream_pos
->packet_cycles_index
,
249 stream_pos
->packet_real_index
->len
- 1);
254 if (index
->timestamp_end
> end
)
255 end
= index
->timestamp_end
;
266 * Update stream current timestamp
269 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
270 struct definition_integer
*integer_definition
)
272 struct declaration_integer
*integer_declaration
=
273 integer_definition
->declaration
;
274 uint64_t oldval
, newval
, updateval
;
276 if (unlikely(integer_declaration
->len
== 64)) {
277 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
278 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
279 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
280 stream
->prev_cycles_timestamp
);
281 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
282 stream
->cycles_timestamp
);
286 oldval
= stream
->cycles_timestamp
;
287 oldval
&= (1ULL << integer_declaration
->len
) - 1;
288 newval
= integer_definition
->value
._unsigned
;
289 /* Test for overflow by comparing low bits */
291 newval
+= 1ULL << integer_declaration
->len
;
292 /* updateval contains old high bits, and new low bits (sum) */
293 updateval
= stream
->cycles_timestamp
;
294 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
296 stream
->prev_cycles_timestamp
= stream
->cycles_timestamp
;
297 stream
->cycles_timestamp
= updateval
;
299 /* convert to real timestamp */
300 stream
->prev_real_timestamp
= ctf_get_real_timestamp(stream
,
301 stream
->prev_cycles_timestamp
);
302 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
303 stream
->cycles_timestamp
);
307 * Print timestamp, rescaling clock frequency to nanoseconds and
308 * applying offsets as needed (unix time).
311 void ctf_print_timestamp_real(FILE *fp
,
312 struct ctf_stream_definition
*stream
,
315 uint64_t ts_sec
= 0, ts_nsec
;
319 /* Add command-line offset */
320 ts_sec
+= opt_clock_offset
;
322 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
323 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
325 if (!opt_clock_seconds
) {
327 time_t time_s
= (time_t) ts_sec
;
329 if (!opt_clock_gmt
) {
332 res
= localtime_r(&time_s
, &tm
);
334 fprintf(stderr
, "[warning] Unable to get localtime.\n");
340 res
= gmtime_r(&time_s
, &tm
);
342 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
346 if (opt_clock_date
) {
350 /* Print date and time */
351 res
= strftime(timestr
, sizeof(timestr
),
354 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
357 fprintf(fp
, "%s", timestr
);
359 /* Print time in HH:MM:SS.ns */
360 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
361 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
365 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
373 * Print timestamp, in cycles
376 void ctf_print_timestamp_cycles(FILE *fp
,
377 struct ctf_stream_definition
*stream
,
380 fprintf(fp
, "%020" PRIu64
, timestamp
);
383 void ctf_print_timestamp(FILE *fp
,
384 struct ctf_stream_definition
*stream
,
387 if (opt_clock_cycles
) {
388 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
390 ctf_print_timestamp_real(fp
, stream
, timestamp
);
395 int ctf_read_event(struct stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
397 struct ctf_stream_pos
*pos
=
398 container_of(ppos
, struct ctf_stream_pos
, parent
);
399 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
400 struct ctf_event_definition
*event
;
404 /* We need to check for EOF here for empty files. */
405 if (unlikely(pos
->offset
== EOF
))
408 ctf_pos_get_event(pos
);
410 /* save the current position as a restore point */
411 pos
->last_offset
= pos
->offset
;
414 * This is the EOF check after we've advanced the position in
417 if (unlikely(pos
->offset
== EOF
))
419 assert(pos
->offset
< pos
->content_size
);
421 /* Read event header */
422 if (likely(stream
->stream_event_header
)) {
423 struct definition_integer
*integer_definition
;
424 struct definition
*variant
;
426 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
429 /* lookup event id */
430 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
431 if (integer_definition
) {
432 id
= integer_definition
->value
._unsigned
;
434 struct definition_enum
*enum_definition
;
436 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
437 if (enum_definition
) {
438 id
= enum_definition
->integer
->value
._unsigned
;
442 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
444 integer_definition
= lookup_integer(variant
, "id", FALSE
);
445 if (integer_definition
) {
446 id
= integer_definition
->value
._unsigned
;
449 stream
->event_id
= id
;
451 /* lookup timestamp */
452 stream
->has_timestamp
= 0;
453 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
454 if (integer_definition
) {
455 ctf_update_timestamp(stream
, integer_definition
);
456 stream
->has_timestamp
= 1;
459 integer_definition
= lookup_integer(variant
, "timestamp", FALSE
);
460 if (integer_definition
) {
461 ctf_update_timestamp(stream
, integer_definition
);
462 stream
->has_timestamp
= 1;
468 /* Read stream-declared event context */
469 if (stream
->stream_event_context
) {
470 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
475 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
476 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
479 event
= g_ptr_array_index(stream
->events_by_id
, id
);
480 if (unlikely(!event
)) {
481 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
485 /* Read event-declared event context */
486 if (event
->event_context
) {
487 ret
= generic_rw(ppos
, &event
->event_context
->p
);
492 /* Read event payload */
493 if (likely(event
->event_fields
)) {
494 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
502 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
507 int ctf_write_event(struct stream_pos
*pos
, struct ctf_stream_definition
*stream
)
509 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
510 struct ctf_event_definition
*event
;
514 id
= stream
->event_id
;
516 /* print event header */
517 if (likely(stream
->stream_event_header
)) {
518 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
523 /* print stream-declared event context */
524 if (stream
->stream_event_context
) {
525 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
530 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
531 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
534 event
= g_ptr_array_index(stream
->events_by_id
, id
);
535 if (unlikely(!event
)) {
536 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
540 /* print event-declared event context */
541 if (event
->event_context
) {
542 ret
= generic_rw(pos
, &event
->event_context
->p
);
547 /* Read and print event payload */
548 if (likely(event
->event_fields
)) {
549 ret
= generic_rw(pos
, &event
->event_fields
->p
);
557 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
561 int ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
)
565 pos
->packet_cycles_index
= g_array_new(FALSE
, TRUE
,
566 sizeof(struct packet_index
));
567 pos
->packet_real_index
= g_array_new(FALSE
, TRUE
,
568 sizeof(struct packet_index
));
570 pos
->packet_cycles_index
= NULL
;
571 pos
->packet_real_index
= NULL
;
573 switch (open_flags
& O_ACCMODE
) {
575 pos
->prot
= PROT_READ
;
576 pos
->flags
= MAP_PRIVATE
;
577 pos
->parent
.rw_table
= read_dispatch_table
;
578 pos
->parent
.event_cb
= ctf_read_event
;
581 pos
->prot
= PROT_WRITE
; /* Write has priority */
582 pos
->flags
= MAP_SHARED
;
583 pos
->parent
.rw_table
= write_dispatch_table
;
584 pos
->parent
.event_cb
= ctf_write_event
;
586 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
594 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
596 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
597 *pos
->content_size_loc
= pos
->offset
;
602 ret
= munmap_align(pos
->base_mma
);
604 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
609 if (pos
->packet_cycles_index
)
610 (void) g_array_free(pos
->packet_cycles_index
, TRUE
);
611 if (pos
->packet_real_index
)
612 (void) g_array_free(pos
->packet_real_index
, TRUE
);
617 * for SEEK_CUR: go to next packet.
618 * for SEEK_POS: go to packet numer (index).
620 void ctf_packet_seek(struct stream_pos
*stream_pos
, size_t index
, int whence
)
622 struct ctf_stream_pos
*pos
=
623 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
624 struct ctf_file_stream
*file_stream
=
625 container_of(pos
, struct ctf_file_stream
, pos
);
628 struct packet_index
*packet_index
;
630 if (pos
->prot
== PROT_WRITE
&& pos
->content_size_loc
)
631 *pos
->content_size_loc
= pos
->offset
;
635 ret
= munmap_align(pos
->base_mma
);
637 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
641 pos
->base_mma
= NULL
;
645 * The caller should never ask for ctf_move_pos across packets,
646 * except to get exactly at the beginning of the next packet.
648 if (pos
->prot
== PROT_WRITE
) {
651 /* The writer will add padding */
652 pos
->mmap_offset
+= WRITE_PACKET_LEN
/ CHAR_BIT
;
655 assert(index
== 0); /* only seek supported for now */
661 pos
->content_size
= -1U; /* Unknown at this point */
662 pos
->packet_size
= WRITE_PACKET_LEN
;
663 off
= posix_fallocate(pos
->fd
, pos
->mmap_offset
,
664 pos
->packet_size
/ CHAR_BIT
);
672 uint64_t events_discarded_diff
;
674 if (pos
->offset
== EOF
) {
677 /* For printing discarded event count */
678 packet_index
= &g_array_index(pos
->packet_cycles_index
,
679 struct packet_index
, pos
->cur_index
);
680 file_stream
->parent
.prev_cycles_timestamp_end
=
681 packet_index
->timestamp_end
;
682 file_stream
->parent
.prev_cycles_timestamp
=
683 packet_index
->timestamp_begin
;
685 packet_index
= &g_array_index(pos
->packet_real_index
,
686 struct packet_index
, pos
->cur_index
);
687 file_stream
->parent
.prev_real_timestamp_end
=
688 packet_index
->timestamp_end
;
689 file_stream
->parent
.prev_real_timestamp
=
690 packet_index
->timestamp_begin
;
692 events_discarded_diff
= packet_index
->events_discarded
;
693 if (pos
->cur_index
> 0) {
694 packet_index
= &g_array_index(pos
->packet_real_index
,
697 events_discarded_diff
-= packet_index
->events_discarded
;
699 * Deal with 32-bit wrap-around if the
700 * tracer provided a 32-bit field.
702 if (packet_index
->events_discarded_len
== 32) {
703 events_discarded_diff
= (uint32_t) events_discarded_diff
;
706 file_stream
->parent
.events_discarded
= events_discarded_diff
;
707 file_stream
->parent
.prev_real_timestamp
= file_stream
->parent
.real_timestamp
;
708 file_stream
->parent
.prev_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
709 /* The reader will expect us to skip padding */
714 packet_index
= &g_array_index(pos
->packet_cycles_index
,
715 struct packet_index
, index
);
716 pos
->last_events_discarded
= packet_index
->events_discarded
;
717 pos
->cur_index
= index
;
718 file_stream
->parent
.prev_real_timestamp
= 0;
719 file_stream
->parent
.prev_real_timestamp_end
= 0;
720 file_stream
->parent
.prev_cycles_timestamp
= 0;
721 file_stream
->parent
.prev_cycles_timestamp_end
= 0;
726 if (pos
->cur_index
>= pos
->packet_real_index
->len
) {
728 * When a stream reaches the end of the
729 * file, we need to show the number of
730 * events discarded ourselves, because
731 * there is no next event scheduled to
732 * be printed in the output.
734 if (file_stream
->parent
.events_discarded
) {
736 * We need to check if we are in trace
737 * read or called from packet indexing.
738 * In this last case, the collection is
739 * not there, so we cannot print the
742 if ((&file_stream
->parent
)->stream_class
->trace
->collection
) {
744 fprintf(stderr
, "[warning] Tracer discarded %" PRIu64
" events at end of stream between [",
745 file_stream
->parent
.events_discarded
);
746 if (opt_clock_cycles
) {
747 ctf_print_timestamp(stderr
,
748 &file_stream
->parent
,
749 file_stream
->parent
.prev_cycles_timestamp
);
750 fprintf(stderr
, "] and [");
751 ctf_print_timestamp(stderr
, &file_stream
->parent
,
752 file_stream
->parent
.prev_cycles_timestamp_end
);
754 ctf_print_timestamp(stderr
,
755 &file_stream
->parent
,
756 file_stream
->parent
.prev_real_timestamp
);
757 fprintf(stderr
, "] and [");
758 ctf_print_timestamp(stderr
, &file_stream
->parent
,
759 file_stream
->parent
.prev_real_timestamp_end
);
761 fprintf(stderr
, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\n");
764 file_stream
->parent
.events_discarded
= 0;
769 packet_index
= &g_array_index(pos
->packet_cycles_index
,
772 file_stream
->parent
.cycles_timestamp
= packet_index
->timestamp_begin
;
774 packet_index
= &g_array_index(pos
->packet_real_index
,
777 file_stream
->parent
.real_timestamp
= packet_index
->timestamp_begin
;
778 pos
->mmap_offset
= packet_index
->offset
;
780 /* Lookup context/packet size in index */
781 pos
->content_size
= packet_index
->content_size
;
782 pos
->packet_size
= packet_index
->packet_size
;
783 if (packet_index
->data_offset
< packet_index
->content_size
) {
784 pos
->offset
= 0; /* will read headers */
785 } else if (packet_index
->data_offset
== packet_index
->content_size
) {
787 pos
->offset
= packet_index
->data_offset
;
789 goto read_next_packet
;
795 /* map new base. Need mapping length from header. */
796 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
797 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
798 if (pos
->base_mma
== MAP_FAILED
) {
799 fprintf(stderr
, "[error] mmap error %s.\n",
804 /* update trace_packet_header and stream_packet_context */
805 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.trace_packet_header
) {
806 /* Read packet header */
807 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
810 if (pos
->prot
!= PROT_WRITE
&& file_stream
->parent
.stream_packet_context
) {
811 /* Read packet context */
812 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
818 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
824 len
= fread(&magic
, sizeof(magic
), 1, fp
);
828 if (magic
== TSDL_MAGIC
) {
830 td
->byte_order
= BYTE_ORDER
;
831 CTF_TRACE_SET_FIELD(td
, byte_order
);
832 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
834 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
835 LITTLE_ENDIAN
: BIG_ENDIAN
;
836 CTF_TRACE_SET_FIELD(td
, byte_order
);
844 * Returns 0 on success, -1 on error.
847 int check_version(unsigned int major
, unsigned int minor
)
862 /* eventually return an error instead of warning */
864 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
870 int ctf_open_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
873 struct metadata_packet_header header
;
874 size_t readlen
, writelen
, toread
;
875 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
878 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
882 if (td
->byte_order
!= BYTE_ORDER
) {
883 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
884 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
885 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
886 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
889 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
890 if (header
.compression_scheme
) {
891 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
892 header
.compression_scheme
);
895 if (header
.encryption_scheme
) {
896 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
897 header
.encryption_scheme
);
900 if (header
.checksum_scheme
) {
901 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
902 header
.checksum_scheme
);
905 if (check_version(header
.major
, header
.minor
) < 0)
907 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
908 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
909 CTF_TRACE_SET_FIELD(td
, uuid
);
911 if (babeltrace_uuid_compare(header
.uuid
, td
->uuid
))
915 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
918 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
921 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
926 if (babeltrace_debug
) {
928 fprintf(stderr
, "[debug] metadata packet read: %s\n",
932 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
933 if (writelen
< readlen
) {
943 ret
= 0; /* continue reading next packet */
950 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
951 ret
= fseek(in
, toread
, SEEK_CUR
);
953 fprintf(stderr
, "[warning] Missing padding at end of file\n");
960 int ctf_open_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
969 * Using strlen on *buf instead of size of open_memstream
970 * because its size includes garbage at the end (after final
971 * \0). This is the allocated size, not the actual string size.
973 out
= babeltrace_open_memstream(buf
, &size
);
975 perror("Metadata open_memstream");
979 ret
= ctf_open_trace_metadata_packet_read(td
, in
, out
);
988 /* close to flush the buffer */
989 ret
= babeltrace_close_memstream(buf
, &size
, out
);
993 perror("babeltrace_flush_memstream");
995 closeret
= fclose(in
);
997 perror("Error in fclose");
1003 perror("Error in fclose");
1005 /* open for reading */
1006 *fp
= babeltrace_fmemopen(*buf
, strlen(*buf
), "rb");
1008 perror("Metadata fmemopen");
1015 int ctf_open_trace_metadata_read(struct ctf_trace
*td
,
1016 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1017 int whence
), FILE *metadata_fp
)
1019 struct ctf_scanner
*scanner
;
1020 struct ctf_file_stream
*metadata_stream
;
1023 int ret
= 0, closeret
;
1025 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1026 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1029 metadata_stream
->pos
.packet_seek
= packet_seek
;
1031 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1038 metadata_stream
->pos
.fd
= -1;
1040 td
->metadata
= &metadata_stream
->parent
;
1041 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1042 if (metadata_stream
->pos
.fd
< 0) {
1043 fprintf(stderr
, "Unable to open metadata.\n");
1048 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1050 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1051 perror("Metadata stream open");
1055 /* fd now belongs to fp */
1056 metadata_stream
->pos
.fd
= -1;
1058 if (babeltrace_debug
)
1061 if (packet_metadata(td
, fp
)) {
1062 ret
= ctf_open_trace_metadata_stream_read(td
, &fp
, &buf
);
1064 goto end_packet_read
;
1066 unsigned int major
, minor
;
1069 td
->byte_order
= BYTE_ORDER
;
1071 /* Check text-only metadata header and version */
1072 nr_items
= fscanf(fp
, "/* CTF %u.%u", &major
, &minor
);
1074 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1075 if (check_version(major
, minor
) < 0) {
1077 goto end_packet_read
;
1082 scanner
= ctf_scanner_alloc(fp
);
1084 fprintf(stderr
, "[error] Error allocating scanner\n");
1086 goto end_scanner_alloc
;
1088 ret
= ctf_scanner_append_ast(scanner
);
1090 fprintf(stderr
, "[error] Error creating AST\n");
1094 if (babeltrace_debug
) {
1095 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1097 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1102 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1104 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1107 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1108 td
, td
->byte_order
);
1110 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1114 ctf_scanner_free(scanner
);
1118 closeret
= fclose(fp
);
1120 perror("Error on fclose");
1125 if (metadata_stream
->pos
.fd
>= 0) {
1126 closeret
= close(metadata_stream
->pos
.fd
);
1128 perror("Error on metadata stream fd close");
1133 g_free(metadata_stream
);
1138 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1139 struct ctf_stream_definition
*stream
,
1140 struct ctf_event_declaration
*event
)
1142 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1144 if (event
->context_decl
) {
1145 struct definition
*definition
=
1146 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1147 stream
->parent_def_scope
, 0, 0, "event.context");
1151 stream_event
->event_context
= container_of(definition
,
1152 struct definition_struct
, p
);
1153 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1155 if (event
->fields_decl
) {
1156 struct definition
*definition
=
1157 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1158 stream
->parent_def_scope
, 0, 0, "event.fields");
1162 stream_event
->event_fields
= container_of(definition
,
1163 struct definition_struct
, p
);
1164 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1166 stream_event
->stream
= stream
;
1167 return stream_event
;
1170 if (stream_event
->event_fields
)
1171 bt_definition_unref(&stream_event
->event_fields
->p
);
1172 if (stream_event
->event_context
)
1173 bt_definition_unref(&stream_event
->event_context
->p
);
1178 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1180 struct ctf_stream_declaration
*stream_class
;
1184 if (stream
->stream_definitions_created
)
1187 stream_class
= stream
->stream_class
;
1189 if (stream_class
->packet_context_decl
) {
1190 struct definition
*definition
=
1191 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1192 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1197 stream
->stream_packet_context
= container_of(definition
,
1198 struct definition_struct
, p
);
1199 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1201 if (stream_class
->event_header_decl
) {
1202 struct definition
*definition
=
1203 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1204 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1209 stream
->stream_event_header
=
1210 container_of(definition
, struct definition_struct
, p
);
1211 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1213 if (stream_class
->event_context_decl
) {
1214 struct definition
*definition
=
1215 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1216 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1221 stream
->stream_event_context
=
1222 container_of(definition
, struct definition_struct
, p
);
1223 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1225 stream
->events_by_id
= g_ptr_array_new();
1226 g_ptr_array_set_size(stream
->events_by_id
, stream_class
->events_by_id
->len
);
1227 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1228 struct ctf_event_declaration
*event
= g_ptr_array_index(stream_class
->events_by_id
, i
);
1229 struct ctf_event_definition
*stream_event
;
1233 stream_event
= create_event_definitions(td
, stream
, event
);
1236 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1241 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1242 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1244 g_free(stream_event
);
1246 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1248 if (stream
->stream_event_context
)
1249 bt_definition_unref(&stream
->stream_event_context
->p
);
1250 if (stream
->stream_event_header
)
1251 bt_definition_unref(&stream
->stream_event_header
->p
);
1252 if (stream
->stream_packet_context
)
1253 bt_definition_unref(&stream
->stream_packet_context
->p
);
1259 int create_stream_packet_index(struct ctf_trace
*td
,
1260 struct ctf_file_stream
*file_stream
)
1262 struct ctf_stream_declaration
*stream
;
1264 struct ctf_stream_pos
*pos
;
1265 struct stat filestats
;
1266 struct packet_index packet_index
;
1267 int first_packet
= 1;
1270 pos
= &file_stream
->pos
;
1272 ret
= fstat(pos
->fd
, &filestats
);
1276 if (filestats
.st_size
< MAX_PACKET_HEADER_LEN
/ CHAR_BIT
)
1279 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1280 uint64_t stream_id
= 0;
1282 if (pos
->base_mma
) {
1283 /* unmap old base */
1284 ret
= munmap_align(pos
->base_mma
);
1286 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1290 pos
->base_mma
= NULL
;
1292 /* map new base. Need mapping length from header. */
1293 pos
->base_mma
= mmap_align(MAX_PACKET_HEADER_LEN
/ CHAR_BIT
, PROT_READ
,
1294 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1295 assert(pos
->base_mma
!= MAP_FAILED
);
1296 pos
->content_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1297 pos
->packet_size
= MAX_PACKET_HEADER_LEN
; /* Unknown at this point */
1298 pos
->offset
= 0; /* Position of the packet header */
1300 packet_index
.offset
= pos
->mmap_offset
;
1301 packet_index
.content_size
= 0;
1302 packet_index
.packet_size
= 0;
1303 packet_index
.timestamp_begin
= 0;
1304 packet_index
.timestamp_end
= 0;
1305 packet_index
.events_discarded
= 0;
1306 packet_index
.events_discarded_len
= 0;
1308 /* read and check header, set stream id (and check) */
1309 if (file_stream
->parent
.trace_packet_header
) {
1310 /* Read packet header */
1311 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1314 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1315 if (len_index
>= 0) {
1316 struct definition
*field
;
1319 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1320 magic
= bt_get_unsigned_int(field
);
1321 if (magic
!= CTF_MAGIC
) {
1322 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1324 file_stream
->pos
.packet_cycles_index
->len
,
1325 (ssize_t
) pos
->mmap_offset
);
1331 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1332 if (len_index
>= 0) {
1333 struct definition_array
*defarray
;
1334 struct definition
*field
;
1336 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1338 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1339 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1340 defarray
= container_of(field
, struct definition_array
, p
);
1341 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1343 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1344 struct definition
*elem
;
1346 elem
= bt_array_index(defarray
, i
);
1347 uuidval
[i
] = bt_get_unsigned_int(elem
);
1349 ret
= babeltrace_uuid_compare(td
->uuid
, uuidval
);
1351 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1357 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1358 if (len_index
>= 0) {
1359 struct definition
*field
;
1361 field
= struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1362 stream_id
= bt_get_unsigned_int(field
);
1366 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1367 fprintf(stderr
, "[error] Stream ID is changing within a stream.\n");
1371 file_stream
->parent
.stream_id
= stream_id
;
1372 if (stream_id
>= td
->streams
->len
) {
1373 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1376 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1378 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1381 file_stream
->parent
.stream_class
= stream
;
1382 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1388 if (file_stream
->parent
.stream_packet_context
) {
1389 /* Read packet context */
1390 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1393 /* read content size from header */
1394 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1395 if (len_index
>= 0) {
1396 struct definition
*field
;
1398 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1399 packet_index
.content_size
= bt_get_unsigned_int(field
);
1401 /* Use file size for packet size */
1402 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1405 /* read packet size from header */
1406 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1407 if (len_index
>= 0) {
1408 struct definition
*field
;
1410 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1411 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1413 /* Use content size if non-zero, else file size */
1414 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1417 /* read timestamp begin from header */
1418 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1419 if (len_index
>= 0) {
1420 struct definition
*field
;
1422 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1423 packet_index
.timestamp_begin
= bt_get_unsigned_int(field
);
1424 if (file_stream
->parent
.stream_class
->trace
->collection
) {
1425 packet_index
.timestamp_begin
=
1426 ctf_get_real_timestamp(
1427 &file_stream
->parent
,
1428 packet_index
.timestamp_begin
);
1432 /* read timestamp end from header */
1433 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1434 if (len_index
>= 0) {
1435 struct definition
*field
;
1437 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1438 packet_index
.timestamp_end
= bt_get_unsigned_int(field
);
1439 if (file_stream
->parent
.stream_class
->trace
->collection
) {
1440 packet_index
.timestamp_end
=
1441 ctf_get_real_timestamp(
1442 &file_stream
->parent
,
1443 packet_index
.timestamp_end
);
1447 /* read events discarded from header */
1448 len_index
= struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1449 if (len_index
>= 0) {
1450 struct definition
*field
;
1452 field
= struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1453 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1454 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1457 /* Use file size for packet size */
1458 packet_index
.content_size
= filestats
.st_size
* CHAR_BIT
;
1459 /* Use content size if non-zero, else file size */
1460 packet_index
.packet_size
= packet_index
.content_size
? : filestats
.st_size
* CHAR_BIT
;
1463 /* Validate content size and packet size values */
1464 if (packet_index
.content_size
> packet_index
.packet_size
) {
1465 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1466 packet_index
.content_size
, packet_index
.packet_size
);
1470 if (packet_index
.packet_size
> ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
) {
1471 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1472 packet_index
.packet_size
, ((uint64_t)filestats
.st_size
- packet_index
.offset
) * CHAR_BIT
);
1476 /* Save position after header and context */
1477 packet_index
.data_offset
= pos
->offset
;
1479 /* add index to packet array */
1480 g_array_append_val(file_stream
->pos
.packet_cycles_index
, packet_index
);
1482 pos
->mmap_offset
+= packet_index
.packet_size
/ CHAR_BIT
;
1489 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1493 if (td
->packet_header_decl
) {
1494 struct definition
*definition
=
1495 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1496 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1501 stream
->trace_packet_header
=
1502 container_of(definition
, struct definition_struct
, p
);
1503 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
1513 * Note: many file streams can inherit from the same stream class
1514 * description (metadata).
1517 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
1518 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1521 int ret
, fd
, closeret
;
1522 struct ctf_file_stream
*file_stream
;
1523 struct stat statbuf
;
1525 fd
= openat(td
->dirfd
, path
, flags
);
1527 perror("File stream openat()");
1532 /* Don't try to mmap subdirectories. Skip them, return success. */
1533 ret
= fstat(fd
, &statbuf
);
1535 perror("File stream fstat()");
1538 if (S_ISDIR(statbuf
.st_mode
)) {
1539 fprintf(stderr
, "[warning] Skipping directory '%s' found in trace\n", path
);
1544 file_stream
= g_new0(struct ctf_file_stream
, 1);
1545 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1548 file_stream
->pos
.packet_seek
= packet_seek
;
1550 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1555 ret
= ctf_init_pos(&file_stream
->pos
, fd
, flags
);
1558 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1562 * For now, only a single clock per trace is supported.
1564 file_stream
->parent
.current_clock
= td
->single_clock
;
1565 ret
= create_stream_packet_index(td
, file_stream
);
1568 /* Add stream file to stream class */
1569 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1570 &file_stream
->parent
);
1574 if (file_stream
->parent
.trace_packet_header
)
1575 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1577 closeret
= ctf_fini_pos(&file_stream
->pos
);
1579 fprintf(stderr
, "Error on ctf_fini_pos\n");
1581 g_free(file_stream
);
1584 closeret
= close(fd
);
1586 perror("Error on fd close");
1593 int ctf_open_trace_read(struct ctf_trace
*td
,
1594 const char *path
, int flags
,
1595 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1596 int whence
), FILE *metadata_fp
)
1599 struct dirent
*dirent
;
1600 struct dirent
*diriter
;
1605 /* Open trace directory */
1606 td
->dir
= opendir(path
);
1608 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
1613 td
->dirfd
= open(path
, 0);
1614 if (td
->dirfd
< 0) {
1615 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
1616 perror("Trace directory open");
1620 strncpy(td
->path
, path
, sizeof(td
->path
));
1621 td
->path
[sizeof(td
->path
) - 1] = '\0';
1624 * Keep the metadata file separate.
1627 ret
= ctf_open_trace_metadata_read(td
, packet_seek
, metadata_fp
);
1629 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
1630 goto error_metadata
;
1634 * Open each stream: for each file, try to open, check magic
1635 * number, and get the stream ID to add to the right location in
1639 dirent_len
= offsetof(struct dirent
, d_name
) +
1640 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
1642 dirent
= malloc(dirent_len
);
1645 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
1647 fprintf(stderr
, "[error] Readdir error.\n");
1652 /* Ignore hidden files, ., .. and metadata. */
1653 if (!strncmp(diriter
->d_name
, ".", 1)
1654 || !strcmp(diriter
->d_name
, "..")
1655 || !strcmp(diriter
->d_name
, "metadata"))
1657 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
1658 flags
, packet_seek
);
1660 fprintf(stderr
, "[error] Open file stream error.\n");
1671 closeret
= close(td
->dirfd
);
1673 perror("Error on fd close");
1676 closeret
= closedir(td
->dir
);
1678 perror("Error on closedir");
1685 * ctf_open_trace: Open a CTF trace and index it.
1686 * Note that the user must seek the trace after the open (using the iterator)
1687 * since the index creation read it entirely.
1690 struct trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
1691 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1692 int whence
), FILE *metadata_fp
)
1694 struct ctf_trace
*td
;
1698 * If packet_seek is NULL, we provide our default version.
1701 packet_seek
= ctf_packet_seek
;
1703 td
= g_new0(struct ctf_trace
, 1);
1705 switch (flags
& O_ACCMODE
) {
1708 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
1711 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
1716 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
1719 fprintf(stderr
, "[error] Incorrect open flags.\n");
1730 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
1731 struct mmap_stream
*mmap_info
)
1733 pos
->mmap_offset
= 0;
1734 pos
->packet_size
= 0;
1735 pos
->content_size
= 0;
1736 pos
->content_size_loc
= NULL
;
1737 pos
->fd
= mmap_info
->fd
;
1738 pos
->base_mma
= NULL
;
1742 pos
->packet_cycles_index
= NULL
;
1743 pos
->packet_real_index
= NULL
;
1744 pos
->prot
= PROT_READ
;
1745 pos
->flags
= MAP_PRIVATE
;
1746 pos
->parent
.rw_table
= read_dispatch_table
;
1747 pos
->parent
.event_cb
= ctf_read_event
;
1751 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
1752 struct ctf_file_stream
*file_stream
)
1754 struct ctf_stream_declaration
*stream
;
1755 uint64_t stream_id
= 0;
1758 file_stream
->parent
.stream_id
= stream_id
;
1759 if (stream_id
>= td
->streams
->len
) {
1760 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1761 "in metadata.\n", stream_id
);
1765 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1767 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
1768 "in metadata.\n", stream_id
);
1772 file_stream
->parent
.stream_class
= stream
;
1773 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1779 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
1780 struct mmap_stream
*mmap_info
,
1781 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1785 struct ctf_file_stream
*file_stream
;
1787 file_stream
= g_new0(struct ctf_file_stream
, 1);
1788 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1789 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
1791 file_stream
->pos
.packet_seek
= packet_seek
;
1793 ret
= create_trace_definitions(td
, &file_stream
->parent
);
1798 ret
= prepare_mmap_stream_definition(td
, file_stream
);
1803 * For now, only a single clock per trace is supported.
1805 file_stream
->parent
.current_clock
= td
->single_clock
;
1807 /* Add stream file to stream class */
1808 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
1809 &file_stream
->parent
);
1813 if (file_stream
->parent
.trace_packet_header
)
1814 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
1816 g_free(file_stream
);
1821 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
1822 struct mmap_stream_list
*mmap_list
,
1823 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1828 struct mmap_stream
*mmap_info
;
1830 ret
= ctf_open_trace_metadata_read(td
, ctf_packet_seek
, metadata_fp
);
1836 * for each stream, try to open, check magic number, and get the
1837 * stream ID to add to the right location in the stream array.
1839 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
1840 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
1842 fprintf(stderr
, "[error] Open file mmap stream error.\n");
1854 struct trace_descriptor
*ctf_open_mmap_trace(
1855 struct mmap_stream_list
*mmap_list
,
1856 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
1860 struct ctf_trace
*td
;
1864 fprintf(stderr
, "[error] No metadata file pointer associated, "
1865 "required for mmap parsing\n");
1869 fprintf(stderr
, "[error] packet_seek function undefined.\n");
1872 td
= g_new0(struct ctf_trace
, 1);
1873 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
1886 int ctf_convert_index_timestamp(struct trace_descriptor
*tdp
)
1889 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1891 /* for each stream_class */
1892 for (i
= 0; i
< td
->streams
->len
; i
++) {
1893 struct ctf_stream_declaration
*stream_class
;
1895 stream_class
= g_ptr_array_index(td
->streams
, i
);
1898 /* for each file_stream */
1899 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
1900 struct ctf_stream_definition
*stream
;
1901 struct ctf_stream_pos
*stream_pos
;
1902 struct ctf_file_stream
*cfs
;
1904 stream
= g_ptr_array_index(stream_class
->streams
, j
);
1907 cfs
= container_of(stream
, struct ctf_file_stream
,
1909 stream_pos
= &cfs
->pos
;
1910 if (!stream_pos
->packet_cycles_index
)
1913 for (k
= 0; k
< stream_pos
->packet_cycles_index
->len
; k
++) {
1914 struct packet_index
*index
;
1915 struct packet_index new_index
;
1917 index
= &g_array_index(stream_pos
->packet_cycles_index
,
1918 struct packet_index
, k
);
1919 memcpy(&new_index
, index
,
1920 sizeof(struct packet_index
));
1921 new_index
.timestamp_begin
=
1922 ctf_get_real_timestamp(stream
,
1923 index
->timestamp_begin
);
1924 new_index
.timestamp_end
=
1925 ctf_get_real_timestamp(stream
,
1926 index
->timestamp_end
);
1927 g_array_append_val(stream_pos
->packet_real_index
,
1936 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
1940 ret
= ctf_fini_pos(&file_stream
->pos
);
1942 fprintf(stderr
, "Error on ctf_fini_pos\n");
1945 ret
= close(file_stream
->pos
.fd
);
1947 perror("Error closing file fd");
1954 int ctf_close_trace(struct trace_descriptor
*tdp
)
1956 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
1962 for (i
= 0; i
< td
->streams
->len
; i
++) {
1963 struct ctf_stream_declaration
*stream
;
1966 stream
= g_ptr_array_index(td
->streams
, i
);
1969 for (j
= 0; j
< stream
->streams
->len
; j
++) {
1970 struct ctf_file_stream
*file_stream
;
1971 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
1972 struct ctf_file_stream
, parent
);
1973 ret
= ctf_close_file_stream(file_stream
);
1979 ctf_destroy_metadata(td
);
1980 ret
= close(td
->dirfd
);
1982 perror("Error closing dirfd");
1985 ret
= closedir(td
->dir
);
1987 perror("Error closedir");
1995 void ctf_set_context(struct trace_descriptor
*descriptor
,
1996 struct bt_context
*ctx
)
1998 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2005 void ctf_set_handle(struct trace_descriptor
*descriptor
,
2006 struct bt_trace_handle
*handle
)
2008 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2011 td
->handle
= handle
;
2015 void __attribute__((constructor
)) ctf_init(void)
2019 ctf_format
.name
= g_quark_from_static_string("ctf");
2020 ret
= bt_register_format(&ctf_format
);
2025 void __attribute__((destructor
)) ctf_exit(void)
2027 bt_unregister_format(&ctf_format
);