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/format-internal.h>
31 #include <babeltrace/ctf/types.h>
32 #include <babeltrace/ctf/metadata.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf/events-internal.h>
35 #include <babeltrace/trace-handle-internal.h>
36 #include <babeltrace/context-internal.h>
37 #include <babeltrace/compat/uuid.h>
38 #include <babeltrace/endian.h>
39 #include <babeltrace/error.h>
40 #include <babeltrace/trace-debug-info.h>
41 #include <babeltrace/ctf/ctf-index.h>
46 #include <sys/types.h>
54 #include "metadata/ctf-scanner.h"
55 #include "metadata/ctf-parser.h"
56 #include "metadata/ctf-ast.h"
57 #include "events-private.h"
58 #include <babeltrace/compat/memstream.h>
59 #include <babeltrace/compat/fcntl.h>
61 #define LOG2_CHAR_BIT 3
64 * Length of first attempt at mapping a packet header, in bits.
66 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
69 * Lenght of packet to write, in bits.
71 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
73 #define NSEC_PER_SEC 1000000000ULL
75 #define INDEX_PATH "./index/%s.idx"
82 uint64_t opt_clock_offset
;
83 uint64_t opt_clock_offset_ns
;
86 char *opt_debug_info_dir
;
87 char *opt_debug_info_target_prefix
;
90 * TODO: babeltrace_ctf_console_output ensures that we only print
91 * discarded events when ctf-text plugin is used. Should be cleaned up
92 * with the plugin system redesign.
94 int babeltrace_ctf_console_output
;
97 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
98 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
102 struct bt_trace_descriptor
*ctf_open_mmap_trace(
103 struct bt_mmap_stream_list
*mmap_list
,
104 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
108 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
109 struct bt_context
*ctx
);
111 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
112 struct bt_trace_handle
*handle
);
115 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
117 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
118 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
120 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
121 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
123 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
126 rw_dispatch read_dispatch_table
[] = {
127 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
128 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
129 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
130 [ CTF_TYPE_STRING
] = ctf_string_read
,
131 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
132 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
133 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
134 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
138 rw_dispatch write_dispatch_table
[] = {
139 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
140 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
141 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
142 [ CTF_TYPE_STRING
] = ctf_string_write
,
143 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
144 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
145 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
146 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
150 struct bt_format ctf_format
= {
151 .open_trace
= ctf_open_trace
,
152 .open_mmap_trace
= ctf_open_mmap_trace
,
153 .close_trace
= ctf_close_trace
,
154 .set_context
= ctf_set_context
,
155 .set_handle
= ctf_set_handle
,
156 .timestamp_begin
= ctf_timestamp_begin
,
157 .timestamp_end
= ctf_timestamp_end
,
158 .convert_index_timestamp
= ctf_convert_index_timestamp
,
162 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
163 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
165 struct ctf_trace
*tin
;
166 uint64_t begin
= ULLONG_MAX
;
169 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
174 /* for each stream_class */
175 for (i
= 0; i
< tin
->streams
->len
; i
++) {
176 struct ctf_stream_declaration
*stream_class
;
178 stream_class
= g_ptr_array_index(tin
->streams
, i
);
181 /* for each file_stream */
182 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
183 struct ctf_stream_definition
*stream
;
184 struct ctf_file_stream
*cfs
;
185 struct ctf_stream_pos
*stream_pos
;
186 struct packet_index
*index
;
188 stream
= g_ptr_array_index(stream_class
->streams
, j
);
189 cfs
= container_of(stream
, struct ctf_file_stream
,
191 stream_pos
= &cfs
->pos
;
193 if (!stream_pos
->packet_index
)
196 if (stream_pos
->packet_index
->len
<= 0)
199 index
= &g_array_index(stream_pos
->packet_index
,
201 stream_pos
->packet_index
->len
- 1);
202 if (type
== BT_CLOCK_REAL
) {
203 if (index
->ts_real
.timestamp_begin
< begin
)
204 begin
= index
->ts_real
.timestamp_begin
;
205 } else if (type
== BT_CLOCK_CYCLES
) {
206 if (index
->ts_cycles
.timestamp_begin
< begin
)
207 begin
= index
->ts_cycles
.timestamp_begin
;
221 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
222 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
224 struct ctf_trace
*tin
;
228 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
233 /* for each stream_class */
234 for (i
= 0; i
< tin
->streams
->len
; i
++) {
235 struct ctf_stream_declaration
*stream_class
;
237 stream_class
= g_ptr_array_index(tin
->streams
, i
);
240 /* for each file_stream */
241 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
242 struct ctf_stream_definition
*stream
;
243 struct ctf_file_stream
*cfs
;
244 struct ctf_stream_pos
*stream_pos
;
245 struct packet_index
*index
;
247 stream
= g_ptr_array_index(stream_class
->streams
, j
);
248 cfs
= container_of(stream
, struct ctf_file_stream
,
250 stream_pos
= &cfs
->pos
;
252 if (!stream_pos
->packet_index
)
255 if (stream_pos
->packet_index
->len
<= 0)
258 index
= &g_array_index(stream_pos
->packet_index
,
260 stream_pos
->packet_index
->len
- 1);
261 if (type
== BT_CLOCK_REAL
) {
262 if (index
->ts_real
.timestamp_end
> end
)
263 end
= index
->ts_real
.timestamp_end
;
264 } else if (type
== BT_CLOCK_CYCLES
) {
265 if (index
->ts_cycles
.timestamp_end
> end
)
266 end
= index
->ts_cycles
.timestamp_end
;
280 * Update stream current timestamp
283 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
284 struct definition_integer
*integer_definition
)
286 struct declaration_integer
*integer_declaration
=
287 integer_definition
->declaration
;
288 uint64_t oldval
, newval
, updateval
;
290 if (unlikely(integer_declaration
->len
== 64)) {
291 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
292 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
293 stream
->cycles_timestamp
);
297 oldval
= stream
->cycles_timestamp
;
298 oldval
&= (1ULL << integer_declaration
->len
) - 1;
299 newval
= integer_definition
->value
._unsigned
;
300 /* Test for overflow by comparing low bits */
302 newval
+= 1ULL << integer_declaration
->len
;
303 /* updateval contains old high bits, and new low bits (sum) */
304 updateval
= stream
->cycles_timestamp
;
305 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
307 stream
->cycles_timestamp
= updateval
;
309 /* convert to real timestamp */
310 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
311 stream
->cycles_timestamp
);
315 * Print timestamp, rescaling clock frequency to nanoseconds and
316 * applying offsets as needed (unix time).
319 void ctf_print_timestamp_real(FILE *fp
,
320 struct ctf_stream_definition
*stream
,
323 uint64_t ts_sec
= 0, ts_nsec
;
327 /* Add command-line offset in ns*/
328 ts_nsec
+= opt_clock_offset_ns
;
330 /* Add command-line offset */
331 ts_sec
+= opt_clock_offset
;
333 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
334 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
336 if (!opt_clock_seconds
) {
338 time_t time_s
= (time_t) ts_sec
;
340 if (!opt_clock_gmt
) {
343 res
= localtime_r(&time_s
, &tm
);
345 fprintf(stderr
, "[warning] Unable to get localtime.\n");
351 res
= gmtime_r(&time_s
, &tm
);
353 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
357 if (opt_clock_date
) {
361 /* Print date and time */
362 res
= strftime(timestr
, sizeof(timestr
),
365 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
368 fprintf(fp
, "%s", timestr
);
370 /* Print time in HH:MM:SS.ns */
371 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
372 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
376 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
384 * Print timestamp, in cycles
387 void ctf_print_timestamp_cycles(FILE *fp
,
388 struct ctf_stream_definition
*stream
,
391 fprintf(fp
, "%020" PRIu64
, timestamp
);
394 void ctf_print_timestamp(FILE *fp
,
395 struct ctf_stream_definition
*stream
,
398 if (opt_clock_cycles
) {
399 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
401 ctf_print_timestamp_real(fp
, stream
, timestamp
);
406 void print_uuid(FILE *fp
, unsigned char *uuid
)
410 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
411 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
415 * Discarded events can be either:
416 * - discarded after end of previous buffer due to buffer full:
417 * happened within range: [ prev_timestamp_end, timestamp_begin ]
418 * - discarded within current buffer due to either event too large or
419 * nested wrap-around:
420 * happened within range: [ timestamp_begin, timestamp_end ]
422 * Given we have discarded counters of those two types merged into the
423 * events_discarded counter, we need to use the union of those ranges:
424 * [ prev_timestamp_end, timestamp_end ]
426 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
427 * consumer had time to extract them. We keep track of those gaps with the
428 * packet sequence number in each packet.
430 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
)
432 if ((!stream
->events_discarded
&& !stream
->packets_lost
) ||
433 !babeltrace_ctf_console_output
) {
437 if (stream
->events_discarded
) {
438 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events between [",
439 stream
->events_discarded
);
440 } else if (stream
->packets_lost
) {
441 fprintf(fp
, "[warning] Tracer lost %" PRIu64
" trace packets between [",
442 stream
->packets_lost
);
444 if (opt_clock_cycles
) {
445 ctf_print_timestamp(fp
, stream
,
446 stream
->prev
.cycles
.end
);
447 fprintf(fp
, "] and [");
448 ctf_print_timestamp(fp
, stream
,
449 stream
->current
.cycles
.end
);
451 ctf_print_timestamp(fp
, stream
,
452 stream
->prev
.real
.end
);
453 fprintf(fp
, "] and [");
454 ctf_print_timestamp(fp
, stream
,
455 stream
->current
.real
.end
);
457 fprintf(fp
, "] in trace UUID ");
458 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
459 if (stream
->stream_class
->trace
->parent
.path
[0])
460 fprintf(fp
, ", at path: \"%s\"",
461 stream
->stream_class
->trace
->parent
.path
);
463 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
465 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
467 fprintf(fp
, "You should consider recording a new trace with larger "
468 "buffers or with fewer events enabled.\n");
473 void ctf_print_truncated_packet(FILE *fp
, struct ctf_stream_definition
*stream
,
474 uint64_t packet_size
, uint64_t remaining_file_size
)
476 fprintf(fp
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits) in trace with UUID \"",
477 packet_size
, remaining_file_size
);
478 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
481 if (stream
->stream_class
->trace
->parent
.path
[0] != '\0') {
482 fprintf(fp
, ", at path: \"%s\"",
483 stream
->stream_class
->trace
->parent
.path
);
486 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
487 if (stream
->path
[0] != '\0') {
488 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
496 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
498 struct ctf_stream_pos
*pos
=
499 container_of(ppos
, struct ctf_stream_pos
, parent
);
500 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
501 struct ctf_event_definition
*event
;
505 /* We need to check for EOF here for empty files. */
506 if (unlikely(pos
->offset
== EOF
))
509 ret
= ctf_pos_get_event(pos
);
510 if (ret
== -BT_PACKET_SEEK_ERROR_TRUNCATED_PACKET
) {
516 /* save the current position as a restore point */
517 pos
->last_offset
= pos
->offset
;
520 * This is the EOF check after we've advanced the position in
523 if (unlikely(pos
->offset
== EOF
))
526 /* Stream is inactive for now (live reading). */
527 if (unlikely(pos
->content_size
== 0))
531 * Packet seeked to by ctf_pos_get_event() only contains
532 * headers, no event. Consider stream as inactive (live
535 if (unlikely(pos
->data_offset
== pos
->content_size
))
538 assert(pos
->offset
< pos
->content_size
);
540 /* Read event header */
541 if (likely(stream
->stream_event_header
)) {
542 struct definition_integer
*integer_definition
;
543 struct bt_definition
*variant
;
545 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
548 /* lookup event id */
549 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
550 if (integer_definition
) {
551 id
= integer_definition
->value
._unsigned
;
553 struct definition_enum
*enum_definition
;
555 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
556 if (enum_definition
) {
557 id
= enum_definition
->integer
->value
._unsigned
;
561 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
563 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
564 if (integer_definition
) {
565 id
= integer_definition
->value
._unsigned
;
568 stream
->event_id
= id
;
570 /* lookup timestamp */
571 stream
->has_timestamp
= 0;
572 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
573 if (integer_definition
) {
574 ctf_update_timestamp(stream
, integer_definition
);
575 stream
->has_timestamp
= 1;
578 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
579 if (integer_definition
) {
580 ctf_update_timestamp(stream
, integer_definition
);
581 stream
->has_timestamp
= 1;
587 /* Read stream-declared event context */
588 if (stream
->stream_event_context
) {
589 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
594 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
595 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
598 event
= g_ptr_array_index(stream
->events_by_id
, id
);
599 if (unlikely(!event
)) {
600 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
604 /* Read event-declared event context */
605 if (event
->event_context
) {
606 ret
= generic_rw(ppos
, &event
->event_context
->p
);
611 /* Read event payload */
612 if (likely(event
->event_fields
)) {
613 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
618 if (pos
->last_offset
== pos
->offset
) {
619 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
626 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
631 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
633 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
634 struct ctf_event_definition
*event
;
638 id
= stream
->event_id
;
640 /* print event header */
641 if (likely(stream
->stream_event_header
)) {
642 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
647 /* print stream-declared event context */
648 if (stream
->stream_event_context
) {
649 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
654 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
655 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
658 event
= g_ptr_array_index(stream
->events_by_id
, id
);
659 if (unlikely(!event
)) {
660 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
664 /* print event-declared event context */
665 if (event
->event_context
) {
666 ret
= generic_rw(pos
, &event
->event_context
->p
);
671 /* Read and print event payload */
672 if (likely(event
->event_fields
)) {
673 ret
= generic_rw(pos
, &event
->event_fields
->p
);
681 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
686 * One side-effect of this function is to unmap pos mmap base if one is
690 int find_data_offset(struct ctf_stream_pos
*pos
,
691 struct ctf_file_stream
*file_stream
,
692 struct packet_index
*packet_index
)
694 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
695 struct stat filestats
;
699 pos
= &file_stream
->pos
;
701 ret
= fstat(pos
->fd
, &filestats
);
704 filesize
= filestats
.st_size
;
706 /* Deal with empty files */
712 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
713 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
718 ret
= munmap_align(pos
->base_mma
);
720 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
724 pos
->base_mma
= NULL
;
726 /* map new base. Need mapping length from header. */
727 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
728 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
729 assert(pos
->base_mma
!= MAP_FAILED
);
731 pos
->content_size
= packet_map_len
;
732 pos
->packet_size
= packet_map_len
;
733 pos
->offset
= 0; /* Position of the packet header */
735 /* update trace_packet_header and stream_packet_context */
736 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
737 /* Read packet header */
738 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
744 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
745 /* Read packet context */
746 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
752 packet_index
->data_offset
= pos
->offset
;
755 ret
= munmap_align(pos
->base_mma
);
757 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
761 pos
->base_mma
= NULL
;
765 /* Retry with larger mapping */
767 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
769 * Reached EOF, but still expecting header/context data.
771 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
774 /* Double the mapping len, and retry */
775 tmp_map_len
= packet_map_len
<< 1;
776 if (tmp_map_len
>> 1 != packet_map_len
) {
778 fprintf(stderr
, "[error] Packet mapping length overflow\n");
781 packet_map_len
= tmp_map_len
;
786 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
787 int fd
, int open_flags
)
791 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
792 sizeof(struct packet_index
));
794 pos
->packet_index
= NULL
;
796 switch (open_flags
& O_ACCMODE
) {
798 pos
->prot
= PROT_READ
;
799 pos
->flags
= MAP_PRIVATE
;
800 pos
->parent
.rw_table
= read_dispatch_table
;
801 pos
->parent
.event_cb
= ctf_read_event
;
802 pos
->parent
.trace
= trace
;
805 pos
->prot
= PROT_READ
| PROT_WRITE
;
806 pos
->flags
= MAP_SHARED
;
807 pos
->parent
.rw_table
= write_dispatch_table
;
808 pos
->parent
.event_cb
= ctf_write_event
;
809 pos
->parent
.trace
= trace
;
811 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
819 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
821 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
822 *pos
->content_size_loc
= pos
->offset
;
827 ret
= munmap_align(pos
->base_mma
);
829 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
834 if (pos
->packet_index
)
835 (void) g_array_free(pos
->packet_index
, TRUE
);
839 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
840 struct packet_index
*prev_index
,
841 struct packet_index
*cur_index
)
843 uint64_t events_discarded_diff
;
844 uint64_t packets_lost_diff
= 0;
846 /* Update packet index time information */
848 /* Current packet begin/end */
849 stream
->current
.real
.begin
=
850 cur_index
->ts_real
.timestamp_begin
;
851 stream
->current
.cycles
.begin
=
852 cur_index
->ts_cycles
.timestamp_begin
;
853 stream
->current
.real
.end
=
854 cur_index
->ts_real
.timestamp_end
;
855 stream
->current
.cycles
.end
=
856 cur_index
->ts_cycles
.timestamp_end
;
858 /* Update packet index discarded event information */
859 events_discarded_diff
= cur_index
->events_discarded
;
861 /* Previous packet begin/end */
862 stream
->prev
.cycles
.begin
=
863 prev_index
->ts_cycles
.timestamp_begin
;
864 stream
->prev
.real
.begin
=
865 prev_index
->ts_real
.timestamp_begin
;
866 stream
->prev
.cycles
.end
=
867 prev_index
->ts_cycles
.timestamp_end
;
868 stream
->prev
.real
.end
=
869 prev_index
->ts_real
.timestamp_end
;
871 events_discarded_diff
-= prev_index
->events_discarded
;
872 /* packet_seq_num stays at 0 if not produced by the tracer */
873 if (cur_index
->packet_seq_num
) {
874 packets_lost_diff
= cur_index
->packet_seq_num
-
875 prev_index
->packet_seq_num
- 1;
878 * Deal with 32-bit wrap-around if the tracer provided a
881 if (prev_index
->events_discarded_len
== 32) {
882 events_discarded_diff
= (uint32_t) events_discarded_diff
;
886 * First packet: use current packet info as limits for
889 stream
->prev
.cycles
.begin
=
890 stream
->prev
.cycles
.end
=
891 stream
->current
.cycles
.begin
;
892 stream
->prev
.real
.begin
=
893 stream
->prev
.real
.end
=
894 stream
->current
.real
.begin
;
896 stream
->events_discarded
= events_discarded_diff
;
897 stream
->packets_lost
= packets_lost_diff
;
901 * Find the timerange where all the streams in the trace are active
904 * Return 0 and update begin/end if necessary on success, return 1 for
905 * empty streams and return a negative value on error.
908 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
909 struct packet_index_time
*_real
,
910 struct packet_index_time
*_cycles
)
912 int stream_id
, ret
= 0;
913 struct packet_index_time real
= { 0, UINT64_MAX
},
914 cycles
= { 0, UINT64_MAX
};
915 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
917 /* At least one of the two return args must be provided. */
918 if (!_real
&& !_cycles
) {
923 if (tin
->streams
->len
== 0) {
928 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
931 struct ctf_stream_declaration
*stream_class
;
933 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
937 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
938 struct ctf_file_stream
*file_stream
;
939 struct ctf_stream_pos
*stream_pos
;
940 struct packet_index
*index
;
942 file_stream
= g_ptr_array_index(stream_class
->streams
,
947 stream_pos
= &file_stream
->pos
;
948 if (!stream_pos
->packet_index
||
949 stream_pos
->packet_index
->len
<= 0) {
953 index
= &g_array_index(stream_pos
->packet_index
,
954 struct packet_index
, 0);
955 real
.timestamp_begin
= max(real
.timestamp_begin
,
956 index
->ts_real
.timestamp_begin
);
957 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
958 index
->ts_cycles
.timestamp_begin
);
960 index
= &g_array_index(stream_pos
->packet_index
,
962 stream_pos
->packet_index
->len
- 1);
963 real
.timestamp_end
= min(real
.timestamp_end
,
964 index
->ts_real
.timestamp_end
);
965 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
966 index
->ts_cycles
.timestamp_end
);
982 * Find the union of all active regions in the trace collection's traces.
983 * Returns "real" timestamps.
985 * Return 0 on success.
986 * Return 1 if no intersections are found.
987 * Return a negative value on error.
989 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
990 uint64_t *_ts_begin
, uint64_t *_ts_end
)
993 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
995 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
1000 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1001 struct bt_trace_descriptor
*td_read
;
1002 struct packet_index_time intersection_real
;
1004 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1008 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1011 /* Empty trace or no stream intersection. */
1013 } else if (ret
< 0) {
1017 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
1018 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
1021 if (ts_end
< ts_begin
) {
1025 *_ts_begin
= ts_begin
;
1031 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1035 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1040 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1041 struct bt_trace_descriptor
*td_read
;
1042 struct packet_index_time intersection_real
;
1044 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1049 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1052 /* Empty trace or no stream intersection. */
1054 } else if (ret
< 0) {
1058 td_read
->interval_real
= intersection_real
;
1059 td_read
->interval_set
= true;
1066 * for SEEK_CUR: go to next packet.
1067 * for SEEK_SET: go to packet numer (index).
1069 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1071 struct ctf_stream_pos
*pos
=
1072 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1073 struct ctf_file_stream
*file_stream
=
1074 container_of(pos
, struct ctf_file_stream
, pos
);
1076 struct packet_index
*packet_index
, *prev_index
;
1080 case SEEK_SET
: /* Fall-through */
1083 ret
= -BT_PACKET_SEEK_ERROR
;
1087 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1088 *pos
->content_size_loc
= pos
->offset
;
1090 if (pos
->base_mma
) {
1091 /* unmap old base */
1092 ret
= munmap_align(pos
->base_mma
);
1094 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1096 ret
= -BT_PACKET_SEEK_ERROR
;
1099 pos
->base_mma
= NULL
;
1103 * The caller should never ask for ctf_move_pos across packets,
1104 * except to get exactly at the beginning of the next packet.
1106 if (pos
->prot
& PROT_WRITE
) {
1109 /* The writer will add padding */
1110 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1113 assert(index
== 0); /* only seek supported for now */
1117 ret
= -BT_PACKET_SEEK_ERROR
;
1120 pos
->content_size
= -1U; /* Unknown at this point */
1121 pos
->packet_size
= WRITE_PACKET_LEN
;
1123 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1124 pos
->packet_size
/ CHAR_BIT
);
1125 } while (ret
== EINTR
);
1129 uint64_t remaining_file_size
;
1134 if (pos
->offset
== EOF
) {
1138 assert(pos
->cur_index
< pos
->packet_index
->len
);
1139 /* The reader will expect us to skip padding */
1144 if (index
>= pos
->packet_index
->len
) {
1149 pos
->cur_index
= index
;
1152 ret
= -BT_PACKET_SEEK_ERROR
;
1156 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1162 packet_index
= &g_array_index(pos
->packet_index
,
1163 struct packet_index
, pos
->cur_index
);
1164 if (pos
->cur_index
> 0) {
1165 prev_index
= &g_array_index(pos
->packet_index
,
1166 struct packet_index
,
1167 pos
->cur_index
- 1);
1171 ctf_update_current_packet_index(&file_stream
->parent
,
1172 prev_index
, packet_index
);
1174 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1181 * We need to check if we are in trace read or called
1182 * from packet indexing. In this last case, the
1183 * collection is not there, so we cannot print the
1186 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1187 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1190 packet_index
= &g_array_index(pos
->packet_index
,
1191 struct packet_index
,
1193 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1195 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1197 /* Lookup context/packet size in index */
1198 if (packet_index
->data_offset
== -1) {
1199 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1201 ret
= -BT_PACKET_SEEK_ERROR
;
1206 remaining_file_size
= (pos
->file_length
- ((uint64_t) packet_index
->offset
)) * CHAR_BIT
;
1207 if (packet_index
->packet_size
> remaining_file_size
) {
1209 ctf_print_truncated_packet(stderr
, &file_stream
->parent
,
1210 packet_index
->packet_size
,
1211 remaining_file_size
);
1213 ret
= -BT_PACKET_SEEK_ERROR_TRUNCATED_PACKET
;
1217 pos
->content_size
= packet_index
->content_size
;
1218 pos
->packet_size
= packet_index
->packet_size
;
1219 pos
->mmap_offset
= packet_index
->offset
;
1220 pos
->data_offset
= packet_index
->data_offset
;
1221 if (pos
->data_offset
< packet_index
->content_size
) {
1222 pos
->offset
= 0; /* will read headers */
1223 } else if (pos
->data_offset
== packet_index
->content_size
) {
1225 pos
->offset
= packet_index
->data_offset
;
1227 goto read_next_packet
;
1234 /* map new base. Need mapping length from header. */
1235 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1236 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1237 if (pos
->base_mma
== MAP_FAILED
) {
1238 fprintf(stderr
, "[error] mmap error %s.\n",
1243 /* update trace_packet_header and stream_packet_context */
1244 if (!(pos
->prot
& PROT_WRITE
) &&
1245 file_stream
->parent
.trace_packet_header
) {
1246 /* Read packet header */
1247 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1250 if (!(pos
->prot
& PROT_WRITE
) &&
1251 file_stream
->parent
.stream_packet_context
) {
1252 /* Read packet context */
1253 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1258 bt_packet_seek_set_error(ret
);
1262 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1268 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1272 if (magic
== TSDL_MAGIC
) {
1274 td
->byte_order
= BYTE_ORDER
;
1275 CTF_TRACE_SET_FIELD(td
, byte_order
);
1276 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1278 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1279 LITTLE_ENDIAN
: BIG_ENDIAN
;
1280 CTF_TRACE_SET_FIELD(td
, byte_order
);
1288 * Returns 0 on success, -1 on error.
1291 int check_version(unsigned int major
, unsigned int minor
)
1306 /* eventually return an error instead of warning */
1308 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1314 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1317 struct metadata_packet_header header
;
1318 size_t readlen
, writelen
, toread
;
1319 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1322 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1326 if (td
->byte_order
!= BYTE_ORDER
) {
1327 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1328 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1329 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1330 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1332 if (header
.checksum
)
1333 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1334 if (header
.compression_scheme
) {
1335 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1336 header
.compression_scheme
);
1339 if (header
.encryption_scheme
) {
1340 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1341 header
.encryption_scheme
);
1344 if (header
.checksum_scheme
) {
1345 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1346 header
.checksum_scheme
);
1349 if (check_version(header
.major
, header
.minor
) < 0)
1351 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1352 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1353 CTF_TRACE_SET_FIELD(td
, uuid
);
1355 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1359 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1362 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1365 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1370 if (babeltrace_debug
) {
1371 buf
[readlen
] = '\0';
1372 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1376 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1377 if (writelen
< readlen
) {
1387 ret
= 0; /* continue reading next packet */
1394 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1395 ret
= fseek(in
, toread
, SEEK_CUR
);
1397 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1404 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1408 size_t size
, buflen
;
1413 * Using strlen on *buf instead of size of open_memstream
1414 * because its size includes garbage at the end (after final
1415 * \0). This is the allocated size, not the actual string size.
1417 out
= babeltrace_open_memstream(buf
, &size
);
1419 perror("Metadata open_memstream");
1423 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1432 /* close to flush the buffer */
1433 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1437 perror("babeltrace_flush_memstream");
1439 closeret
= fclose(in
);
1441 perror("Error in fclose");
1447 perror("Error in fclose");
1449 /* open for reading */
1450 buflen
= strlen(*buf
);
1455 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1457 perror("Metadata fmemopen");
1464 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1465 struct ctf_scanner
*scanner
, int append
)
1467 struct ctf_file_stream
*metadata_stream
;
1470 int ret
= 0, closeret
;
1472 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1473 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1477 metadata_stream
->pos
.fd
= -1;
1479 td
->metadata
= &metadata_stream
->parent
;
1480 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1481 if (metadata_stream
->pos
.fd
< 0) {
1482 fprintf(stderr
, "Unable to open metadata.\n");
1487 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1489 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1490 perror("Metadata stream open");
1494 /* fd now belongs to fp */
1495 metadata_stream
->pos
.fd
= -1;
1497 if (babeltrace_debug
)
1500 if (packet_metadata(td
, fp
)) {
1501 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1505 td
->metadata_string
= buf
;
1506 td
->metadata_packetized
= 1;
1509 unsigned int major
, minor
;
1512 td
->byte_order
= BYTE_ORDER
;
1514 /* Check text-only metadata header and version */
1515 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1517 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1518 if (check_version(major
, minor
) < 0) {
1526 ret
= ctf_scanner_append_ast(scanner
, fp
);
1528 fprintf(stderr
, "[error] Error creating AST\n");
1532 if (babeltrace_debug
) {
1533 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1535 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1540 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1542 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1545 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1546 td
, td
->byte_order
);
1548 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1553 closeret
= fclose(fp
);
1555 perror("Error on fclose");
1559 if (metadata_stream
->pos
.fd
>= 0) {
1560 closeret
= close(metadata_stream
->pos
.fd
);
1562 perror("Error on metadata stream fd close");
1567 g_free(metadata_stream
);
1572 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1573 struct ctf_stream_definition
*stream
,
1574 struct ctf_event_declaration
*event
)
1576 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1578 if (event
->context_decl
) {
1579 struct bt_definition
*definition
=
1580 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1581 stream
->parent_def_scope
, 0, 0, "event.context");
1585 stream_event
->event_context
= container_of(definition
,
1586 struct definition_struct
, p
);
1587 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1589 if (event
->fields_decl
) {
1590 struct bt_definition
*definition
=
1591 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1592 stream
->parent_def_scope
, 0, 0, "event.fields");
1596 stream_event
->event_fields
= container_of(definition
,
1597 struct definition_struct
, p
);
1598 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1600 stream_event
->stream
= stream
;
1601 return stream_event
;
1604 if (stream_event
->event_fields
)
1605 bt_definition_unref(&stream_event
->event_fields
->p
);
1606 if (stream_event
->event_context
)
1607 bt_definition_unref(&stream_event
->event_context
->p
);
1608 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1609 g_quark_to_string(event
->name
));
1614 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1615 struct ctf_stream_declaration
*stream_class
,
1616 struct ctf_stream_definition
*stream
)
1618 size_t def_size
, class_size
, i
;
1621 def_size
= stream
->events_by_id
->len
;
1622 class_size
= stream_class
->events_by_id
->len
;
1624 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1625 for (i
= def_size
; i
< class_size
; i
++) {
1626 struct ctf_event_declaration
*event
=
1627 g_ptr_array_index(stream_class
->events_by_id
, i
);
1628 struct ctf_event_definition
*stream_event
;
1632 stream_event
= create_event_definitions(td
, stream
, event
);
1633 if (!stream_event
) {
1637 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1644 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1646 struct ctf_stream_declaration
*stream_class
;
1650 if (stream
->stream_definitions_created
)
1653 stream_class
= stream
->stream_class
;
1655 if (stream_class
->packet_context_decl
) {
1656 struct bt_definition
*definition
=
1657 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1658 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1663 stream
->stream_packet_context
= container_of(definition
,
1664 struct definition_struct
, p
);
1665 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1667 if (stream_class
->event_header_decl
) {
1668 struct bt_definition
*definition
=
1669 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1670 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1675 stream
->stream_event_header
=
1676 container_of(definition
, struct definition_struct
, p
);
1677 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1679 if (stream_class
->event_context_decl
) {
1680 struct bt_definition
*definition
=
1681 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1682 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1687 stream
->stream_event_context
=
1688 container_of(definition
, struct definition_struct
, p
);
1689 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1691 stream
->events_by_id
= g_ptr_array_new();
1692 ret
= copy_event_declarations_stream_class_to_stream(td
,
1693 stream_class
, stream
);
1699 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1700 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1702 g_free(stream_event
);
1704 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1706 if (stream
->stream_event_context
)
1707 bt_definition_unref(&stream
->stream_event_context
->p
);
1708 if (stream
->stream_event_header
)
1709 bt_definition_unref(&stream
->stream_event_header
->p
);
1710 if (stream
->stream_packet_context
)
1711 bt_definition_unref(&stream
->stream_packet_context
->p
);
1712 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1713 stream_class
->stream_id
, strerror(-ret
));
1718 int stream_assign_class(struct ctf_trace
*td
,
1719 struct ctf_file_stream
*file_stream
,
1722 struct ctf_stream_declaration
*stream
;
1725 file_stream
->parent
.stream_id
= stream_id
;
1726 if (stream_id
>= td
->streams
->len
) {
1727 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1730 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1732 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1735 file_stream
->parent
.stream_class
= stream
;
1736 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1743 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1744 struct ctf_trace
*td
,
1745 struct ctf_file_stream
*file_stream
)
1747 struct packet_index packet_index
;
1748 uint64_t stream_id
= 0;
1749 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1750 int first_packet
= 0;
1755 memset(&packet_index
, 0, sizeof(packet_index
));
1756 if (!pos
->mmap_offset
) {
1760 if (pos
->file_length
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1761 packet_map_len
= (pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1764 if (pos
->base_mma
) {
1765 /* unmap old base */
1766 ret
= munmap_align(pos
->base_mma
);
1768 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1772 pos
->base_mma
= NULL
;
1774 /* map new base. Need mapping length from header. */
1775 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1776 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1777 assert(pos
->base_mma
!= MAP_FAILED
);
1779 * Use current mapping size as temporary content and packet
1782 pos
->content_size
= packet_map_len
;
1783 pos
->packet_size
= packet_map_len
;
1784 pos
->offset
= 0; /* Position of the packet header */
1786 packet_index
.offset
= pos
->mmap_offset
;
1788 /* read and check header, set stream id (and check) */
1789 if (file_stream
->parent
.trace_packet_header
) {
1790 /* Read packet header */
1791 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1795 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1798 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1799 if (len_index
>= 0) {
1800 struct bt_definition
*field
;
1803 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1804 magic
= bt_get_unsigned_int(field
);
1805 if (magic
!= CTF_MAGIC
) {
1806 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1808 file_stream
->pos
.packet_index
->len
,
1809 (ssize_t
) pos
->mmap_offset
);
1815 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1816 if (len_index
>= 0) {
1817 struct definition_array
*defarray
;
1818 struct bt_definition
*field
;
1820 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1822 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1823 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1824 defarray
= container_of(field
, struct definition_array
, p
);
1825 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1827 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1828 struct bt_definition
*elem
;
1830 elem
= bt_array_index(defarray
, i
);
1831 uuidval
[i
] = bt_get_unsigned_int(elem
);
1833 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1835 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1840 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1841 if (len_index
>= 0) {
1842 struct bt_definition
*field
;
1844 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1845 stream_id
= bt_get_unsigned_int(field
);
1849 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1850 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1852 file_stream
->parent
.stream_id
);
1856 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1861 if (file_stream
->parent
.stream_packet_context
) {
1862 /* Read packet context */
1863 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1867 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1870 /* read packet size from header */
1871 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1872 if (len_index
>= 0) {
1873 struct bt_definition
*field
;
1875 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1876 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1878 /* Use file size for packet size */
1879 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1882 /* read content size from header */
1883 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1884 if (len_index
>= 0) {
1885 struct bt_definition
*field
;
1887 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1888 packet_index
.content_size
= bt_get_unsigned_int(field
);
1890 /* Use packet size if non-zero, else file size */
1891 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1894 /* read timestamp begin from header */
1895 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1896 if (len_index
>= 0) {
1897 struct bt_definition
*field
;
1899 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1900 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1901 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1902 packet_index
.ts_real
.timestamp_begin
=
1903 ctf_get_real_timestamp(
1904 &file_stream
->parent
,
1905 packet_index
.ts_cycles
.timestamp_begin
);
1909 /* read timestamp end from header */
1910 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1911 if (len_index
>= 0) {
1912 struct bt_definition
*field
;
1914 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1915 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1916 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1917 packet_index
.ts_real
.timestamp_end
=
1918 ctf_get_real_timestamp(
1919 &file_stream
->parent
,
1920 packet_index
.ts_cycles
.timestamp_end
);
1924 /* read events discarded from header */
1925 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1926 if (len_index
>= 0) {
1927 struct bt_definition
*field
;
1929 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1930 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1931 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1934 /* read packet_seq_num from header */
1935 len_index
= bt_struct_declaration_lookup_field_index(
1936 file_stream
->parent
.stream_packet_context
->declaration
,
1937 g_quark_from_static_string("packet_seq_num"));
1938 if (len_index
>= 0) {
1939 struct bt_definition
*field
;
1941 field
= bt_struct_definition_get_field_from_index(
1942 file_stream
->parent
.stream_packet_context
,
1944 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1947 /* Use file size for packet size */
1948 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1949 /* Use packet size if non-zero, else file size */
1950 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1953 /* Validate content size and packet size values */
1954 if (packet_index
.content_size
> packet_index
.packet_size
) {
1955 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1956 packet_index
.content_size
, packet_index
.packet_size
);
1960 if (packet_index
.content_size
< pos
->offset
) {
1961 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1965 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1966 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1970 /* Save position after header and context */
1971 packet_index
.data_offset
= pos
->offset
;
1973 /* add index to packet array */
1974 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1976 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1980 /* Retry with larger mapping */
1982 if (packet_map_len
== ((pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1984 * Reached EOF, but still expecting header/context data.
1986 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1989 /* Double the mapping len, and retry */
1990 tmp_map_len
= packet_map_len
<< 1;
1991 if (tmp_map_len
>> 1 != packet_map_len
) {
1993 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1996 packet_map_len
= tmp_map_len
;
2001 int create_stream_packet_index(struct ctf_trace
*td
,
2002 struct ctf_file_stream
*file_stream
)
2004 struct ctf_stream_pos
*pos
;
2007 pos
= &file_stream
->pos
;
2009 /* Deal with empty files */
2010 if (!pos
->file_length
) {
2011 if (file_stream
->parent
.trace_packet_header
2012 || file_stream
->parent
.stream_packet_context
) {
2014 * We expect a trace packet header and/or stream packet
2015 * context. Since a trace needs to have at least one
2016 * packet, empty files are therefore not accepted.
2018 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
2022 * Without trace packet header nor stream packet
2023 * context, a one-packet trace can indeed be empty. This
2024 * is only valid if there is only one stream class: 0.
2026 ret
= stream_assign_class(td
, file_stream
, 0);
2033 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< pos
->file_length
; ) {
2034 ret
= create_stream_one_packet_index(pos
, td
, file_stream
);
2042 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
2046 if (td
->packet_header_decl
) {
2047 struct bt_definition
*definition
=
2048 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2049 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2054 stream
->trace_packet_header
=
2055 container_of(definition
, struct definition_struct
, p
);
2056 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2062 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2067 int import_stream_packet_index(struct ctf_trace
*td
,
2068 struct ctf_file_stream
*file_stream
)
2070 struct ctf_stream_pos
*pos
;
2071 struct ctf_packet_index
*ctf_index
= NULL
;
2072 struct ctf_packet_index_file_hdr index_hdr
;
2073 struct packet_index index
;
2074 uint32_t packet_index_len
, index_minor
;
2076 int first_packet
= 1;
2079 pos
= &file_stream
->pos
;
2081 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2083 perror("read index file header");
2087 /* Check the index header */
2088 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2089 fprintf(stderr
, "[error] wrong index magic\n");
2093 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2094 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2095 ".%" PRIu32
", supported %d.%d\n",
2096 be32toh(index_hdr
.index_major
),
2097 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2102 index_minor
= be32toh(index_hdr
.index_minor
);
2104 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2105 if (packet_index_len
== 0) {
2106 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2111 * Allocate the index length found in header, not internal
2114 ctf_index
= g_malloc0(packet_index_len
);
2115 while (fread(ctf_index
, packet_index_len
, 1,
2116 pos
->index_fp
) == 1) {
2118 struct ctf_stream_declaration
*stream
= NULL
;
2120 memset(&index
, 0, sizeof(index
));
2121 index
.offset
= be64toh(ctf_index
->offset
);
2122 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2123 index
.content_size
= be64toh(ctf_index
->content_size
);
2124 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2125 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2126 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2127 index
.events_discarded_len
= 64;
2128 index
.data_offset
= -1;
2129 stream_id
= be64toh(ctf_index
->stream_id
);
2130 if (index_minor
>= 1) {
2131 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2132 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2135 if (!first_packet
) {
2136 /* add index to packet array */
2137 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2141 file_stream
->parent
.stream_id
= stream_id
;
2142 if (stream_id
< td
->streams
->len
) {
2143 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2146 fprintf(stderr
, "[error] Stream %" PRIu64
2147 " is not declared in metadata.\n",
2152 file_stream
->parent
.stream_class
= stream
;
2153 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2157 /* add index to packet array */
2158 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2161 /* Index containing only the header. */
2162 if (!file_stream
->parent
.stream_class
) {
2175 * Note: many file streams can inherit from the same stream class
2176 * description (metadata).
2179 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2180 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2183 int ret
, fd
, closeret
;
2184 struct ctf_file_stream
*file_stream
;
2185 struct stat statbuf
;
2188 fd
= openat(td
->dirfd
, path
, flags
);
2190 perror("File stream openat()");
2195 /* Don't try to mmap subdirectories. Skip them, return success. */
2196 ret
= fstat(fd
, &statbuf
);
2198 perror("File stream fstat()");
2201 if (S_ISDIR(statbuf
.st_mode
)) {
2202 if (strncmp(path
, "index", 5) != 0) {
2203 fprintf(stderr
, "[warning] Skipping directory '%s' "
2204 "found in trace\n", path
);
2209 if (!statbuf
.st_size
) {
2210 /** Skip empty files. */
2212 goto fd_is_empty_file
;
2215 file_stream
= g_new0(struct ctf_file_stream
, 1);
2216 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2217 file_stream
->pos
.fd
= -1;
2218 file_stream
->pos
.index_fp
= NULL
;
2219 file_stream
->pos
.file_length
= statbuf
.st_size
;
2221 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2222 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2225 file_stream
->pos
.packet_seek
= packet_seek
;
2227 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2232 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2235 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2239 * For now, only a single clock per trace is supported.
2241 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2244 * Allocate the index name for this stream and try to open it.
2246 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2248 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2252 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2255 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2256 ret
= create_stream_packet_index(td
, file_stream
);
2258 fprintf(stderr
, "[error] Stream index creation error.\n");
2262 ret
= openat(td
->dirfd
, index_name
, flags
);
2264 perror("Index file openat()");
2268 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2269 if (!file_stream
->pos
.index_fp
) {
2270 perror("fdopen() error");
2273 ret
= import_stream_packet_index(td
, file_stream
);
2278 ret
= fclose(file_stream
->pos
.index_fp
);
2280 perror("close index");
2286 /* Add stream file to stream class */
2287 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2288 &file_stream
->parent
);
2292 if (file_stream
->pos
.index_fp
) {
2293 ret
= fclose(file_stream
->pos
.index_fp
);
2295 perror("close index");
2298 if (file_stream
->parent
.trace_packet_header
)
2299 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2303 closeret
= ctf_fini_pos(&file_stream
->pos
);
2305 fprintf(stderr
, "Error on ctf_fini_pos\n");
2307 g_free(file_stream
);
2311 closeret
= close(fd
);
2313 perror("Error on fd close");
2320 int ctf_open_trace_read(struct ctf_trace
*td
,
2321 const char *path
, int flags
,
2322 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2323 int whence
), FILE *metadata_fp
)
2325 struct ctf_scanner
*scanner
;
2327 struct dirent
*dirent
;
2328 struct dirent
*diriter
;
2334 /* Open trace directory */
2335 td
->dir
= opendir(path
);
2337 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2342 td
->dirfd
= open(path
, 0);
2343 if (td
->dirfd
< 0) {
2344 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2345 perror("Trace directory open");
2349 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2350 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2353 * Keep the metadata file separate.
2354 * Keep scanner object local to the open. We don't support
2355 * incremental metadata append for on-disk traces.
2357 scanner
= ctf_scanner_alloc();
2359 fprintf(stderr
, "[error] Error allocating scanner\n");
2361 goto error_metadata
;
2363 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2364 ctf_scanner_free(scanner
);
2366 if (ret
== -ENOENT
) {
2367 fprintf(stderr
, "[warning] Empty metadata.\n");
2369 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2370 goto error_metadata
;
2374 * Open each stream: for each file, try to open, check magic
2375 * number, and get the stream ID to add to the right location in
2379 dirent_len
= offsetof(struct dirent
, d_name
) +
2380 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2382 dirent
= malloc(dirent_len
);
2385 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2387 fprintf(stderr
, "[error] Readdir error.\n");
2392 /* Ignore hidden files, ., .. and metadata. */
2393 if (!strncmp(diriter
->d_name
, ".", 1)
2394 || !strcmp(diriter
->d_name
, "..")
2395 || !strcmp(diriter
->d_name
, "metadata"))
2398 /* Ignore index files : *.idx */
2399 ext
= strrchr(diriter
->d_name
, '.');
2400 if (ext
&& (!strcmp(ext
, ".idx"))) {
2404 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2405 flags
, packet_seek
);
2407 fprintf(stderr
, "[error] Open file stream error.\n");
2418 closeret
= close(td
->dirfd
);
2420 perror("Error on fd close");
2423 closeret
= closedir(td
->dir
);
2425 perror("Error on closedir");
2432 * ctf_open_trace: Open a CTF trace and index it.
2433 * Note that the user must seek the trace after the open (using the iterator)
2434 * since the index creation read it entirely.
2437 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2438 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2439 int whence
), FILE *metadata_fp
)
2441 struct ctf_trace
*td
;
2445 * If packet_seek is NULL, we provide our default version.
2448 packet_seek
= ctf_packet_seek
;
2450 td
= g_new0(struct ctf_trace
, 1);
2454 init_trace_descriptor(&td
->parent
);
2456 switch (flags
& O_ACCMODE
) {
2459 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2462 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2467 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2470 fprintf(stderr
, "[error] Incorrect open flags.\n");
2474 ret
= trace_debug_info_create(td
);
2482 trace_debug_info_destroy(td
);
2489 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2490 struct bt_mmap_stream
*mmap_info
)
2492 pos
->mmap_offset
= 0;
2493 pos
->packet_size
= 0;
2494 pos
->content_size
= 0;
2495 pos
->content_size_loc
= NULL
;
2496 pos
->fd
= mmap_info
->fd
;
2497 pos
->base_mma
= NULL
;
2501 pos
->prot
= PROT_READ
;
2502 pos
->flags
= MAP_PRIVATE
;
2503 pos
->parent
.rw_table
= read_dispatch_table
;
2504 pos
->parent
.event_cb
= ctf_read_event
;
2505 pos
->priv
= mmap_info
->priv
;
2506 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2507 sizeof(struct packet_index
));
2511 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2512 struct ctf_file_stream
*file_stream
,
2513 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2516 struct ctf_stream_declaration
*stream
;
2520 /* Ask for the first packet to get the stream_id. */
2521 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2522 ret
= bt_packet_seek_get_error();
2526 stream_id
= file_stream
->parent
.stream_id
;
2527 if (stream_id
>= td
->streams
->len
) {
2528 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2529 "in metadata.\n", stream_id
);
2533 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2535 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2536 "in metadata.\n", stream_id
);
2540 file_stream
->parent
.stream_class
= stream
;
2541 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2547 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2548 struct bt_mmap_stream
*mmap_info
,
2549 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2553 struct ctf_file_stream
*file_stream
;
2555 file_stream
= g_new0(struct ctf_file_stream
, 1);
2556 file_stream
->parent
.stream_id
= -1ULL;
2557 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2558 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2560 file_stream
->pos
.packet_seek
= packet_seek
;
2562 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2567 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2572 * For now, only a single clock per trace is supported.
2574 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2576 /* Add stream file to stream class */
2577 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2578 &file_stream
->parent
);
2582 if (file_stream
->parent
.trace_packet_header
)
2583 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2585 g_free(file_stream
);
2590 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2591 struct bt_mmap_stream_list
*mmap_list
,
2592 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2597 struct bt_mmap_stream
*mmap_info
;
2599 td
->scanner
= ctf_scanner_alloc();
2601 fprintf(stderr
, "[error] Error allocating scanner\n");
2605 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2607 if (ret
== -ENOENT
) {
2608 fprintf(stderr
, "[warning] Empty metadata.\n");
2614 * for each stream, try to open, check magic number, and get the
2615 * stream ID to add to the right location in the stream array.
2617 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2618 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2620 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2627 ctf_scanner_free(td
->scanner
);
2632 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2633 struct bt_mmap_stream_list
*mmap_list
,
2634 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2638 struct ctf_trace
*td
;
2642 fprintf(stderr
, "[error] No metadata file pointer associated, "
2643 "required for mmap parsing\n");
2647 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2650 td
= g_new0(struct ctf_trace
, 1);
2652 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2656 ret
= trace_debug_info_create(td
);
2669 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2672 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2678 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2681 /* for each stream_class */
2682 for (i
= 0; i
< td
->streams
->len
; i
++) {
2683 struct ctf_stream_declaration
*stream_class
;
2685 stream_class
= g_ptr_array_index(td
->streams
, i
);
2688 /* for each stream */
2689 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2690 struct ctf_stream_definition
*stream
;
2692 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2695 ret
= copy_event_declarations_stream_class_to_stream(td
,
2696 stream_class
, stream
);
2705 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2708 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2710 /* for each stream_class */
2711 for (i
= 0; i
< td
->streams
->len
; i
++) {
2712 struct ctf_stream_declaration
*stream_class
;
2714 stream_class
= g_ptr_array_index(td
->streams
, i
);
2717 /* for each file_stream */
2718 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2719 struct ctf_stream_definition
*stream
;
2720 struct ctf_stream_pos
*stream_pos
;
2721 struct ctf_file_stream
*cfs
;
2723 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2726 cfs
= container_of(stream
, struct ctf_file_stream
,
2728 stream_pos
= &cfs
->pos
;
2729 if (!stream_pos
->packet_index
)
2732 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2733 struct packet_index
*index
;
2735 index
= &g_array_index(stream_pos
->packet_index
,
2736 struct packet_index
, k
);
2737 index
->ts_real
.timestamp_begin
=
2738 ctf_get_real_timestamp(stream
,
2739 index
->ts_cycles
.timestamp_begin
);
2740 index
->ts_real
.timestamp_end
=
2741 ctf_get_real_timestamp(stream
,
2742 index
->ts_cycles
.timestamp_end
);
2750 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2754 ret
= ctf_fini_pos(&file_stream
->pos
);
2756 fprintf(stderr
, "Error on ctf_fini_pos\n");
2759 if (file_stream
->pos
.fd
>= 0) {
2760 ret
= close(file_stream
->pos
.fd
);
2762 perror("Error closing file fd");
2770 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2772 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2778 for (i
= 0; i
< td
->streams
->len
; i
++) {
2779 struct ctf_stream_declaration
*stream
;
2782 stream
= g_ptr_array_index(td
->streams
, i
);
2785 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2786 struct ctf_file_stream
*file_stream
;
2787 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2788 struct ctf_file_stream
, parent
);
2789 ret
= ctf_close_file_stream(file_stream
);
2795 ctf_destroy_metadata(td
);
2796 ctf_scanner_free(td
->scanner
);
2797 if (td
->dirfd
>= 0) {
2798 ret
= close(td
->dirfd
);
2800 perror("Error closing dirfd");
2805 ret
= closedir(td
->dir
);
2807 perror("Error closedir");
2811 free(td
->metadata_string
);
2812 trace_debug_info_destroy(td
);
2818 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2819 struct bt_context
*ctx
)
2821 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2824 td
->parent
.ctx
= ctx
;
2828 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2829 struct bt_trace_handle
*handle
)
2831 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2834 td
->parent
.handle
= handle
;
2838 void __attribute__((constructor
)) ctf_init(void)
2842 ctf_format
.name
= g_quark_from_static_string("ctf");
2843 ret
= bt_register_format(&ctf_format
);
2848 void __attribute__((destructor
)) ctf_exit(void)
2850 bt_unregister_format(&ctf_format
);