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/trace-debug-info.h>
40 #include <babeltrace/ctf/ctf-index.h>
45 #include <sys/types.h>
53 #include "metadata/ctf-scanner.h"
54 #include "metadata/ctf-parser.h"
55 #include "metadata/ctf-ast.h"
56 #include "events-private.h"
57 #include <babeltrace/compat/memstream.h>
58 #include <babeltrace/compat/fcntl.h>
60 #define LOG2_CHAR_BIT 3
63 * Length of first attempt at mapping a packet header, in bits.
65 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
68 * Lenght of packet to write, in bits.
70 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
72 #define NSEC_PER_SEC 1000000000ULL
74 #define INDEX_PATH "./index/%s.idx"
81 uint64_t opt_clock_offset
;
82 uint64_t opt_clock_offset_ns
;
85 char *opt_debug_info_dir
;
86 char *opt_debug_info_target_prefix
;
89 * TODO: babeltrace_ctf_console_output ensures that we only print
90 * discarded events when ctf-text plugin is used. Should be cleaned up
91 * with the plugin system redesign.
93 int babeltrace_ctf_console_output
;
96 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
97 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
101 struct bt_trace_descriptor
*ctf_open_mmap_trace(
102 struct bt_mmap_stream_list
*mmap_list
,
103 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
107 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
108 struct bt_context
*ctx
);
110 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
111 struct bt_trace_handle
*handle
);
114 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
116 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
117 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
119 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
120 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
122 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
125 rw_dispatch read_dispatch_table
[] = {
126 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
127 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
128 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
129 [ CTF_TYPE_STRING
] = ctf_string_read
,
130 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
131 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
132 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
133 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
137 rw_dispatch write_dispatch_table
[] = {
138 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
139 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
140 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
141 [ CTF_TYPE_STRING
] = ctf_string_write
,
142 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
143 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
144 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
145 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
149 struct bt_format ctf_format
= {
150 .open_trace
= ctf_open_trace
,
151 .open_mmap_trace
= ctf_open_mmap_trace
,
152 .close_trace
= ctf_close_trace
,
153 .set_context
= ctf_set_context
,
154 .set_handle
= ctf_set_handle
,
155 .timestamp_begin
= ctf_timestamp_begin
,
156 .timestamp_end
= ctf_timestamp_end
,
157 .convert_index_timestamp
= ctf_convert_index_timestamp
,
160 void bt_ctf_hook(void)
163 * Dummy function to prevent the linker from discarding this format as
164 * "unused" in static builds.
169 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
170 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
172 struct ctf_trace
*tin
;
173 uint64_t begin
= ULLONG_MAX
;
176 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
181 /* for each stream_class */
182 for (i
= 0; i
< tin
->streams
->len
; i
++) {
183 struct ctf_stream_declaration
*stream_class
;
185 stream_class
= g_ptr_array_index(tin
->streams
, i
);
188 /* for each file_stream */
189 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
190 struct ctf_stream_definition
*stream
;
191 struct ctf_file_stream
*cfs
;
192 struct ctf_stream_pos
*stream_pos
;
193 struct packet_index
*index
;
195 stream
= g_ptr_array_index(stream_class
->streams
, j
);
196 cfs
= container_of(stream
, struct ctf_file_stream
,
198 stream_pos
= &cfs
->pos
;
200 if (!stream_pos
->packet_index
)
203 if (stream_pos
->packet_index
->len
<= 0)
206 index
= &g_array_index(stream_pos
->packet_index
,
208 stream_pos
->packet_index
->len
- 1);
209 if (type
== BT_CLOCK_REAL
) {
210 if (index
->ts_real
.timestamp_begin
< begin
)
211 begin
= index
->ts_real
.timestamp_begin
;
212 } else if (type
== BT_CLOCK_CYCLES
) {
213 if (index
->ts_cycles
.timestamp_begin
< begin
)
214 begin
= index
->ts_cycles
.timestamp_begin
;
228 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
229 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
231 struct ctf_trace
*tin
;
235 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
240 /* for each stream_class */
241 for (i
= 0; i
< tin
->streams
->len
; i
++) {
242 struct ctf_stream_declaration
*stream_class
;
244 stream_class
= g_ptr_array_index(tin
->streams
, i
);
247 /* for each file_stream */
248 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
249 struct ctf_stream_definition
*stream
;
250 struct ctf_file_stream
*cfs
;
251 struct ctf_stream_pos
*stream_pos
;
252 struct packet_index
*index
;
254 stream
= g_ptr_array_index(stream_class
->streams
, j
);
255 cfs
= container_of(stream
, struct ctf_file_stream
,
257 stream_pos
= &cfs
->pos
;
259 if (!stream_pos
->packet_index
)
262 if (stream_pos
->packet_index
->len
<= 0)
265 index
= &g_array_index(stream_pos
->packet_index
,
267 stream_pos
->packet_index
->len
- 1);
268 if (type
== BT_CLOCK_REAL
) {
269 if (index
->ts_real
.timestamp_end
> end
)
270 end
= index
->ts_real
.timestamp_end
;
271 } else if (type
== BT_CLOCK_CYCLES
) {
272 if (index
->ts_cycles
.timestamp_end
> end
)
273 end
= index
->ts_cycles
.timestamp_end
;
287 * Update stream current timestamp
290 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
291 struct definition_integer
*integer_definition
)
293 struct declaration_integer
*integer_declaration
=
294 integer_definition
->declaration
;
295 uint64_t oldval
, newval
, updateval
;
297 if (unlikely(integer_declaration
->len
== 64)) {
298 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
299 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
300 stream
->cycles_timestamp
);
304 oldval
= stream
->cycles_timestamp
;
305 oldval
&= (1ULL << integer_declaration
->len
) - 1;
306 newval
= integer_definition
->value
._unsigned
;
307 /* Test for overflow by comparing low bits */
309 newval
+= 1ULL << integer_declaration
->len
;
310 /* updateval contains old high bits, and new low bits (sum) */
311 updateval
= stream
->cycles_timestamp
;
312 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
314 stream
->cycles_timestamp
= updateval
;
316 /* convert to real timestamp */
317 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
318 stream
->cycles_timestamp
);
322 * Print timestamp, rescaling clock frequency to nanoseconds and
323 * applying offsets as needed (unix time).
326 void ctf_print_timestamp_real(FILE *fp
,
327 struct ctf_stream_definition
*stream
,
330 uint64_t ts_sec
= 0, ts_nsec
;
334 /* Add command-line offset in ns*/
335 ts_nsec
+= opt_clock_offset_ns
;
337 /* Add command-line offset */
338 ts_sec
+= opt_clock_offset
;
340 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
341 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
343 if (!opt_clock_seconds
) {
345 time_t time_s
= (time_t) ts_sec
;
347 if (!opt_clock_gmt
) {
350 res
= localtime_r(&time_s
, &tm
);
352 fprintf(stderr
, "[warning] Unable to get localtime.\n");
358 res
= gmtime_r(&time_s
, &tm
);
360 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
364 if (opt_clock_date
) {
368 /* Print date and time */
369 res
= strftime(timestr
, sizeof(timestr
),
372 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
375 fprintf(fp
, "%s", timestr
);
377 /* Print time in HH:MM:SS.ns */
378 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
379 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
383 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
391 * Print timestamp, in cycles
394 void ctf_print_timestamp_cycles(FILE *fp
,
395 struct ctf_stream_definition
*stream
,
398 fprintf(fp
, "%020" PRIu64
, timestamp
);
401 void ctf_print_timestamp(FILE *fp
,
402 struct ctf_stream_definition
*stream
,
405 if (opt_clock_cycles
) {
406 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
408 ctf_print_timestamp_real(fp
, stream
, timestamp
);
413 void print_uuid(FILE *fp
, unsigned char *uuid
)
417 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
418 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
422 * Discarded events can be either:
423 * - discarded after end of previous buffer due to buffer full:
424 * happened within range: [ prev_timestamp_end, timestamp_begin ]
425 * - discarded within current buffer due to either event too large or
426 * nested wrap-around:
427 * happened within range: [ timestamp_begin, timestamp_end ]
429 * Given we have discarded counters of those two types merged into the
430 * events_discarded counter, we need to use the union of those ranges:
431 * [ prev_timestamp_end, timestamp_end ]
433 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
434 * consumer had time to extract them. We keep track of those gaps with the
435 * packet sequence number in each packet.
437 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
)
439 if ((!stream
->events_discarded
&& !stream
->packets_lost
) ||
440 !babeltrace_ctf_console_output
) {
444 if (stream
->events_discarded
) {
445 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events between [",
446 stream
->events_discarded
);
447 } else if (stream
->packets_lost
) {
448 fprintf(fp
, "[warning] Tracer lost %" PRIu64
" trace packets between [",
449 stream
->packets_lost
);
451 if (opt_clock_cycles
) {
452 ctf_print_timestamp(fp
, stream
,
453 stream
->prev
.cycles
.end
);
454 fprintf(fp
, "] and [");
455 ctf_print_timestamp(fp
, stream
,
456 stream
->current
.cycles
.end
);
458 ctf_print_timestamp(fp
, stream
,
459 stream
->prev
.real
.end
);
460 fprintf(fp
, "] and [");
461 ctf_print_timestamp(fp
, stream
,
462 stream
->current
.real
.end
);
464 fprintf(fp
, "] in trace UUID ");
465 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
466 if (stream
->stream_class
->trace
->parent
.path
[0])
467 fprintf(fp
, ", at path: \"%s\"",
468 stream
->stream_class
->trace
->parent
.path
);
470 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
472 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
474 fprintf(fp
, "You should consider recording a new trace with larger "
475 "buffers or with fewer events enabled.\n");
480 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
482 struct ctf_stream_pos
*pos
=
483 container_of(ppos
, struct ctf_stream_pos
, parent
);
484 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
485 struct ctf_event_definition
*event
;
489 /* We need to check for EOF here for empty files. */
490 if (unlikely(pos
->offset
== EOF
))
493 ctf_pos_get_event(pos
);
495 /* save the current position as a restore point */
496 pos
->last_offset
= pos
->offset
;
499 * This is the EOF check after we've advanced the position in
502 if (unlikely(pos
->offset
== EOF
))
505 /* Stream is inactive for now (live reading). */
506 if (unlikely(pos
->content_size
== 0))
510 * Packet seeked to by ctf_pos_get_event() only contains
511 * headers, no event. Consider stream as inactive (live
514 if (unlikely(pos
->data_offset
== pos
->content_size
))
517 assert(pos
->offset
< pos
->content_size
);
519 /* Read event header */
520 if (likely(stream
->stream_event_header
)) {
521 struct definition_integer
*integer_definition
;
522 struct bt_definition
*variant
;
524 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
527 /* lookup event id */
528 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
529 if (integer_definition
) {
530 id
= integer_definition
->value
._unsigned
;
532 struct definition_enum
*enum_definition
;
534 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
535 if (enum_definition
) {
536 id
= enum_definition
->integer
->value
._unsigned
;
540 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
542 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
543 if (integer_definition
) {
544 id
= integer_definition
->value
._unsigned
;
547 stream
->event_id
= id
;
549 /* lookup timestamp */
550 stream
->has_timestamp
= 0;
551 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
552 if (integer_definition
) {
553 ctf_update_timestamp(stream
, integer_definition
);
554 stream
->has_timestamp
= 1;
557 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
558 if (integer_definition
) {
559 ctf_update_timestamp(stream
, integer_definition
);
560 stream
->has_timestamp
= 1;
566 /* Read stream-declared event context */
567 if (stream
->stream_event_context
) {
568 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
573 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
574 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
577 event
= g_ptr_array_index(stream
->events_by_id
, id
);
578 if (unlikely(!event
)) {
579 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
583 /* Read event-declared event context */
584 if (event
->event_context
) {
585 ret
= generic_rw(ppos
, &event
->event_context
->p
);
590 /* Read event payload */
591 if (likely(event
->event_fields
)) {
592 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
597 if (pos
->last_offset
== pos
->offset
) {
598 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
605 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
610 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
612 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
613 struct ctf_event_definition
*event
;
617 id
= stream
->event_id
;
619 /* print event header */
620 if (likely(stream
->stream_event_header
)) {
621 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
626 /* print stream-declared event context */
627 if (stream
->stream_event_context
) {
628 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
633 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
634 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
637 event
= g_ptr_array_index(stream
->events_by_id
, id
);
638 if (unlikely(!event
)) {
639 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
643 /* print event-declared event context */
644 if (event
->event_context
) {
645 ret
= generic_rw(pos
, &event
->event_context
->p
);
650 /* Read and print event payload */
651 if (likely(event
->event_fields
)) {
652 ret
= generic_rw(pos
, &event
->event_fields
->p
);
660 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
665 * One side-effect of this function is to unmap pos mmap base if one is
669 int find_data_offset(struct ctf_stream_pos
*pos
,
670 struct ctf_file_stream
*file_stream
,
671 struct packet_index
*packet_index
)
673 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
674 struct stat filestats
;
678 pos
= &file_stream
->pos
;
680 ret
= fstat(pos
->fd
, &filestats
);
683 filesize
= filestats
.st_size
;
685 /* Deal with empty files */
691 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
692 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
697 ret
= munmap_align(pos
->base_mma
);
699 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
703 pos
->base_mma
= NULL
;
705 /* map new base. Need mapping length from header. */
706 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
707 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
708 assert(pos
->base_mma
!= MAP_FAILED
);
710 pos
->content_size
= packet_map_len
;
711 pos
->packet_size
= packet_map_len
;
712 pos
->offset
= 0; /* Position of the packet header */
714 /* update trace_packet_header and stream_packet_context */
715 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
716 /* Read packet header */
717 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
723 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
724 /* Read packet context */
725 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
731 packet_index
->data_offset
= pos
->offset
;
734 ret
= munmap_align(pos
->base_mma
);
736 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
740 pos
->base_mma
= NULL
;
744 /* Retry with larger mapping */
746 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
748 * Reached EOF, but still expecting header/context data.
750 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
753 /* Double the mapping len, and retry */
754 tmp_map_len
= packet_map_len
<< 1;
755 if (tmp_map_len
>> 1 != packet_map_len
) {
757 fprintf(stderr
, "[error] Packet mapping length overflow\n");
760 packet_map_len
= tmp_map_len
;
765 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
766 int fd
, int open_flags
)
770 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
771 sizeof(struct packet_index
));
773 pos
->packet_index
= NULL
;
775 switch (open_flags
& O_ACCMODE
) {
777 pos
->prot
= PROT_READ
;
778 pos
->flags
= MAP_PRIVATE
;
779 pos
->parent
.rw_table
= read_dispatch_table
;
780 pos
->parent
.event_cb
= ctf_read_event
;
781 pos
->parent
.trace
= trace
;
784 pos
->prot
= PROT_READ
| PROT_WRITE
;
785 pos
->flags
= MAP_SHARED
;
786 pos
->parent
.rw_table
= write_dispatch_table
;
787 pos
->parent
.event_cb
= ctf_write_event
;
788 pos
->parent
.trace
= trace
;
796 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
798 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
799 *pos
->content_size_loc
= pos
->offset
;
804 ret
= munmap_align(pos
->base_mma
);
806 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
811 if (pos
->packet_index
)
812 (void) g_array_free(pos
->packet_index
, TRUE
);
816 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
817 struct packet_index
*prev_index
,
818 struct packet_index
*cur_index
)
820 uint64_t events_discarded_diff
;
821 uint64_t packets_lost_diff
= 0;
823 /* Update packet index time information */
825 /* Current packet begin/end */
826 stream
->current
.real
.begin
=
827 cur_index
->ts_real
.timestamp_begin
;
828 stream
->current
.cycles
.begin
=
829 cur_index
->ts_cycles
.timestamp_begin
;
830 stream
->current
.real
.end
=
831 cur_index
->ts_real
.timestamp_end
;
832 stream
->current
.cycles
.end
=
833 cur_index
->ts_cycles
.timestamp_end
;
835 /* Update packet index discarded event information */
836 events_discarded_diff
= cur_index
->events_discarded
;
838 /* Previous packet begin/end */
839 stream
->prev
.cycles
.begin
=
840 prev_index
->ts_cycles
.timestamp_begin
;
841 stream
->prev
.real
.begin
=
842 prev_index
->ts_real
.timestamp_begin
;
843 stream
->prev
.cycles
.end
=
844 prev_index
->ts_cycles
.timestamp_end
;
845 stream
->prev
.real
.end
=
846 prev_index
->ts_real
.timestamp_end
;
848 events_discarded_diff
-= prev_index
->events_discarded
;
849 /* packet_seq_num stays at 0 if not produced by the tracer */
850 if (cur_index
->packet_seq_num
) {
851 packets_lost_diff
= cur_index
->packet_seq_num
-
852 prev_index
->packet_seq_num
- 1;
855 * Deal with 32-bit wrap-around if the tracer provided a
858 if (prev_index
->events_discarded_len
== 32) {
859 events_discarded_diff
= (uint32_t) events_discarded_diff
;
863 * First packet: use current packet info as limits for
866 stream
->prev
.cycles
.begin
=
867 stream
->prev
.cycles
.end
=
868 stream
->current
.cycles
.begin
;
869 stream
->prev
.real
.begin
=
870 stream
->prev
.real
.end
=
871 stream
->current
.real
.begin
;
873 stream
->events_discarded
= events_discarded_diff
;
874 stream
->packets_lost
= packets_lost_diff
;
878 * Find the timerange where all the streams in the trace are active
881 * Return 0 and update begin/end if necessary on success, return 1 for
882 * empty streams and return a negative value on error.
885 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
886 struct packet_index_time
*_real
,
887 struct packet_index_time
*_cycles
)
889 int stream_id
, ret
= 0;
890 struct packet_index_time real
= { 0, UINT64_MAX
},
891 cycles
= { 0, UINT64_MAX
};
892 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
894 /* At least one of the two return args must be provided. */
895 if (!_real
&& !_cycles
) {
900 if (tin
->streams
->len
== 0) {
905 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
908 struct ctf_stream_declaration
*stream_class
;
910 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
914 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
915 struct ctf_file_stream
*file_stream
;
916 struct ctf_stream_pos
*stream_pos
;
917 struct packet_index
*index
;
919 file_stream
= g_ptr_array_index(stream_class
->streams
,
924 stream_pos
= &file_stream
->pos
;
925 if (!stream_pos
->packet_index
||
926 stream_pos
->packet_index
->len
<= 0) {
930 index
= &g_array_index(stream_pos
->packet_index
,
931 struct packet_index
, 0);
932 real
.timestamp_begin
= max(real
.timestamp_begin
,
933 index
->ts_real
.timestamp_begin
);
934 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
935 index
->ts_cycles
.timestamp_begin
);
937 index
= &g_array_index(stream_pos
->packet_index
,
939 stream_pos
->packet_index
->len
- 1);
940 real
.timestamp_end
= min(real
.timestamp_end
,
941 index
->ts_real
.timestamp_end
);
942 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
943 index
->ts_cycles
.timestamp_end
);
959 * Find the union of all active regions in the trace collection's traces.
960 * Returns "real" timestamps.
962 * Return 0 on success.
963 * Return 1 if no intersections are found.
964 * Return a negative value on error.
966 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
967 uint64_t *_ts_begin
, uint64_t *_ts_end
)
970 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
972 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
977 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
978 struct bt_trace_descriptor
*td_read
;
979 struct packet_index_time intersection_real
;
981 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
985 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
988 /* Empty trace or no stream intersection. */
990 } else if (ret
< 0) {
994 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
995 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
998 if (ts_end
< ts_begin
) {
1002 *_ts_begin
= ts_begin
;
1008 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1012 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1017 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1018 struct bt_trace_descriptor
*td_read
;
1019 struct packet_index_time intersection_real
;
1021 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1026 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1029 /* Empty trace or no stream intersection. */
1031 } else if (ret
< 0) {
1035 td_read
->interval_real
= intersection_real
;
1036 td_read
->interval_set
= true;
1043 * for SEEK_CUR: go to next packet.
1044 * for SEEK_SET: go to packet numer (index).
1046 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1048 struct ctf_stream_pos
*pos
=
1049 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1050 struct ctf_file_stream
*file_stream
=
1051 container_of(pos
, struct ctf_file_stream
, pos
);
1053 struct packet_index
*packet_index
, *prev_index
;
1057 case SEEK_SET
: /* Fall-through */
1063 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1064 *pos
->content_size_loc
= pos
->offset
;
1066 if (pos
->base_mma
) {
1067 /* unmap old base */
1068 ret
= munmap_align(pos
->base_mma
);
1070 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1074 pos
->base_mma
= NULL
;
1078 * The caller should never ask for ctf_move_pos across packets,
1079 * except to get exactly at the beginning of the next packet.
1081 if (pos
->prot
& PROT_WRITE
) {
1084 /* The writer will add padding */
1085 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1088 assert(index
== 0); /* only seek supported for now */
1094 pos
->content_size
= -1U; /* Unknown at this point */
1095 pos
->packet_size
= WRITE_PACKET_LEN
;
1097 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1098 pos
->packet_size
/ CHAR_BIT
);
1099 } while (ret
== EINTR
);
1107 if (pos
->offset
== EOF
) {
1110 assert(pos
->cur_index
< pos
->packet_index
->len
);
1111 /* The reader will expect us to skip padding */
1116 if (index
>= pos
->packet_index
->len
) {
1120 pos
->cur_index
= index
;
1126 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1131 packet_index
= &g_array_index(pos
->packet_index
,
1132 struct packet_index
, pos
->cur_index
);
1133 if (pos
->cur_index
> 0) {
1134 prev_index
= &g_array_index(pos
->packet_index
,
1135 struct packet_index
,
1136 pos
->cur_index
- 1);
1140 ctf_update_current_packet_index(&file_stream
->parent
,
1141 prev_index
, packet_index
);
1144 * We need to check if we are in trace read or called
1145 * from packet indexing. In this last case, the
1146 * collection is not there, so we cannot print the
1149 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1150 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1153 packet_index
= &g_array_index(pos
->packet_index
,
1154 struct packet_index
,
1156 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1158 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1160 /* Lookup context/packet size in index */
1161 if (packet_index
->data_offset
== -1) {
1162 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1167 pos
->content_size
= packet_index
->content_size
;
1168 pos
->packet_size
= packet_index
->packet_size
;
1169 pos
->mmap_offset
= packet_index
->offset
;
1170 pos
->data_offset
= packet_index
->data_offset
;
1171 if (pos
->data_offset
< packet_index
->content_size
) {
1172 pos
->offset
= 0; /* will read headers */
1173 } else if (pos
->data_offset
== packet_index
->content_size
) {
1175 pos
->offset
= packet_index
->data_offset
;
1177 goto read_next_packet
;
1183 /* map new base. Need mapping length from header. */
1184 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1185 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1186 if (pos
->base_mma
== MAP_FAILED
) {
1187 fprintf(stderr
, "[error] mmap error %s.\n",
1192 /* update trace_packet_header and stream_packet_context */
1193 if (!(pos
->prot
& PROT_WRITE
) &&
1194 file_stream
->parent
.trace_packet_header
) {
1195 /* Read packet header */
1196 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1199 if (!(pos
->prot
& PROT_WRITE
) &&
1200 file_stream
->parent
.stream_packet_context
) {
1201 /* Read packet context */
1202 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1208 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1214 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1218 if (magic
== TSDL_MAGIC
) {
1220 td
->byte_order
= BYTE_ORDER
;
1221 CTF_TRACE_SET_FIELD(td
, byte_order
);
1222 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1224 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1225 LITTLE_ENDIAN
: BIG_ENDIAN
;
1226 CTF_TRACE_SET_FIELD(td
, byte_order
);
1234 * Returns 0 on success, -1 on error.
1237 int check_version(unsigned int major
, unsigned int minor
)
1252 /* eventually return an error instead of warning */
1254 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1260 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1263 struct metadata_packet_header header
;
1264 size_t readlen
, writelen
, toread
;
1265 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1268 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1272 if (td
->byte_order
!= BYTE_ORDER
) {
1273 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1274 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1275 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1276 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1278 if (header
.checksum
)
1279 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1280 if (header
.compression_scheme
) {
1281 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1282 header
.compression_scheme
);
1285 if (header
.encryption_scheme
) {
1286 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1287 header
.encryption_scheme
);
1290 if (header
.checksum_scheme
) {
1291 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1292 header
.checksum_scheme
);
1295 if (check_version(header
.major
, header
.minor
) < 0)
1297 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1298 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1299 CTF_TRACE_SET_FIELD(td
, uuid
);
1301 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1305 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1308 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1311 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1316 if (babeltrace_debug
) {
1317 buf
[readlen
] = '\0';
1318 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1322 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1323 if (writelen
< readlen
) {
1333 ret
= 0; /* continue reading next packet */
1340 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1341 ret
= fseek(in
, toread
, SEEK_CUR
);
1343 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1350 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1354 size_t size
, buflen
;
1359 * Using strlen on *buf instead of size of open_memstream
1360 * because its size includes garbage at the end (after final
1361 * \0). This is the allocated size, not the actual string size.
1363 out
= babeltrace_open_memstream(buf
, &size
);
1365 perror("Metadata open_memstream");
1369 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1378 /* close to flush the buffer */
1379 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1383 perror("babeltrace_flush_memstream");
1385 closeret
= fclose(in
);
1387 perror("Error in fclose");
1393 perror("Error in fclose");
1395 /* open for reading */
1396 buflen
= strlen(*buf
);
1401 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1403 perror("Metadata fmemopen");
1410 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1411 struct ctf_scanner
*scanner
, int append
)
1413 struct ctf_file_stream
*metadata_stream
;
1416 int ret
= 0, closeret
;
1418 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1419 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1423 metadata_stream
->pos
.fd
= -1;
1425 td
->metadata
= &metadata_stream
->parent
;
1426 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1427 if (metadata_stream
->pos
.fd
< 0) {
1428 fprintf(stderr
, "Unable to open metadata.\n");
1433 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1435 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1436 perror("Metadata stream open");
1440 /* fd now belongs to fp */
1441 metadata_stream
->pos
.fd
= -1;
1443 if (babeltrace_debug
)
1446 if (packet_metadata(td
, fp
)) {
1447 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1451 td
->metadata_string
= buf
;
1452 td
->metadata_packetized
= 1;
1455 unsigned int major
, minor
;
1458 td
->byte_order
= BYTE_ORDER
;
1460 /* Check text-only metadata header and version */
1461 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1463 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1464 if (check_version(major
, minor
) < 0) {
1472 ret
= ctf_scanner_append_ast(scanner
, fp
);
1474 fprintf(stderr
, "[error] Error creating AST\n");
1478 if (babeltrace_debug
) {
1479 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1481 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1486 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1488 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1491 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1492 td
, td
->byte_order
);
1494 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1499 closeret
= fclose(fp
);
1501 perror("Error on fclose");
1505 if (metadata_stream
->pos
.fd
>= 0) {
1506 closeret
= close(metadata_stream
->pos
.fd
);
1508 perror("Error on metadata stream fd close");
1513 g_free(metadata_stream
);
1518 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1519 struct ctf_stream_definition
*stream
,
1520 struct ctf_event_declaration
*event
)
1522 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1524 if (event
->context_decl
) {
1525 struct bt_definition
*definition
=
1526 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1527 stream
->parent_def_scope
, 0, 0, "event.context");
1531 stream_event
->event_context
= container_of(definition
,
1532 struct definition_struct
, p
);
1533 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1535 if (event
->fields_decl
) {
1536 struct bt_definition
*definition
=
1537 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1538 stream
->parent_def_scope
, 0, 0, "event.fields");
1542 stream_event
->event_fields
= container_of(definition
,
1543 struct definition_struct
, p
);
1544 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1546 stream_event
->stream
= stream
;
1547 return stream_event
;
1550 if (stream_event
->event_fields
)
1551 bt_definition_unref(&stream_event
->event_fields
->p
);
1552 if (stream_event
->event_context
)
1553 bt_definition_unref(&stream_event
->event_context
->p
);
1554 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1555 g_quark_to_string(event
->name
));
1560 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1561 struct ctf_stream_declaration
*stream_class
,
1562 struct ctf_stream_definition
*stream
)
1564 size_t def_size
, class_size
, i
;
1567 def_size
= stream
->events_by_id
->len
;
1568 class_size
= stream_class
->events_by_id
->len
;
1570 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1571 for (i
= def_size
; i
< class_size
; i
++) {
1572 struct ctf_event_declaration
*event
=
1573 g_ptr_array_index(stream_class
->events_by_id
, i
);
1574 struct ctf_event_definition
*stream_event
;
1578 stream_event
= create_event_definitions(td
, stream
, event
);
1579 if (!stream_event
) {
1583 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1590 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1592 struct ctf_stream_declaration
*stream_class
;
1596 if (stream
->stream_definitions_created
)
1599 stream_class
= stream
->stream_class
;
1601 if (stream_class
->packet_context_decl
) {
1602 struct bt_definition
*definition
=
1603 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1604 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1609 stream
->stream_packet_context
= container_of(definition
,
1610 struct definition_struct
, p
);
1611 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1613 if (stream_class
->event_header_decl
) {
1614 struct bt_definition
*definition
=
1615 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1616 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1621 stream
->stream_event_header
=
1622 container_of(definition
, struct definition_struct
, p
);
1623 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1625 if (stream_class
->event_context_decl
) {
1626 struct bt_definition
*definition
=
1627 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1628 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1633 stream
->stream_event_context
=
1634 container_of(definition
, struct definition_struct
, p
);
1635 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1637 stream
->events_by_id
= g_ptr_array_new();
1638 ret
= copy_event_declarations_stream_class_to_stream(td
,
1639 stream_class
, stream
);
1645 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1646 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1648 g_free(stream_event
);
1650 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1652 if (stream
->stream_event_context
)
1653 bt_definition_unref(&stream
->stream_event_context
->p
);
1654 if (stream
->stream_event_header
)
1655 bt_definition_unref(&stream
->stream_event_header
->p
);
1656 if (stream
->stream_packet_context
)
1657 bt_definition_unref(&stream
->stream_packet_context
->p
);
1658 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1659 stream_class
->stream_id
, strerror(-ret
));
1664 int stream_assign_class(struct ctf_trace
*td
,
1665 struct ctf_file_stream
*file_stream
,
1668 struct ctf_stream_declaration
*stream
;
1671 file_stream
->parent
.stream_id
= stream_id
;
1672 if (stream_id
>= td
->streams
->len
) {
1673 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1676 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1678 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1681 file_stream
->parent
.stream_class
= stream
;
1682 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1689 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1690 struct ctf_trace
*td
,
1691 struct ctf_file_stream
*file_stream
,
1694 struct packet_index packet_index
;
1695 uint64_t stream_id
= 0;
1696 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1697 int first_packet
= 0;
1702 memset(&packet_index
, 0, sizeof(packet_index
));
1703 if (!pos
->mmap_offset
) {
1707 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1708 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1711 if (pos
->base_mma
) {
1712 /* unmap old base */
1713 ret
= munmap_align(pos
->base_mma
);
1715 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1719 pos
->base_mma
= NULL
;
1721 /* map new base. Need mapping length from header. */
1722 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1723 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1724 assert(pos
->base_mma
!= MAP_FAILED
);
1726 * Use current mapping size as temporary content and packet
1729 pos
->content_size
= packet_map_len
;
1730 pos
->packet_size
= packet_map_len
;
1731 pos
->offset
= 0; /* Position of the packet header */
1733 packet_index
.offset
= pos
->mmap_offset
;
1735 /* read and check header, set stream id (and check) */
1736 if (file_stream
->parent
.trace_packet_header
) {
1737 /* Read packet header */
1738 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1742 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1745 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1746 if (len_index
>= 0) {
1747 struct bt_definition
*field
;
1750 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1751 magic
= bt_get_unsigned_int(field
);
1752 if (magic
!= CTF_MAGIC
) {
1753 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1755 file_stream
->pos
.packet_index
->len
,
1756 (ssize_t
) pos
->mmap_offset
);
1762 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1763 if (len_index
>= 0) {
1764 struct definition_array
*defarray
;
1765 struct bt_definition
*field
;
1767 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1769 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1770 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1771 defarray
= container_of(field
, struct definition_array
, p
);
1772 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1774 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1775 struct bt_definition
*elem
;
1777 elem
= bt_array_index(defarray
, i
);
1778 uuidval
[i
] = bt_get_unsigned_int(elem
);
1780 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1782 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1787 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1788 if (len_index
>= 0) {
1789 struct bt_definition
*field
;
1791 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1792 stream_id
= bt_get_unsigned_int(field
);
1796 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1797 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1799 file_stream
->parent
.stream_id
);
1803 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1808 if (file_stream
->parent
.stream_packet_context
) {
1809 /* Read packet context */
1810 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1814 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1817 /* read packet size from header */
1818 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1819 if (len_index
>= 0) {
1820 struct bt_definition
*field
;
1822 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1823 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1825 /* Use file size for packet size */
1826 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1829 /* read content size from header */
1830 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1831 if (len_index
>= 0) {
1832 struct bt_definition
*field
;
1834 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1835 packet_index
.content_size
= bt_get_unsigned_int(field
);
1837 /* Use packet size if non-zero, else file size */
1838 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1841 /* read timestamp begin from header */
1842 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1843 if (len_index
>= 0) {
1844 struct bt_definition
*field
;
1846 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1847 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1848 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1849 packet_index
.ts_real
.timestamp_begin
=
1850 ctf_get_real_timestamp(
1851 &file_stream
->parent
,
1852 packet_index
.ts_cycles
.timestamp_begin
);
1856 /* read timestamp end from header */
1857 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1858 if (len_index
>= 0) {
1859 struct bt_definition
*field
;
1861 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1862 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1863 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1864 packet_index
.ts_real
.timestamp_end
=
1865 ctf_get_real_timestamp(
1866 &file_stream
->parent
,
1867 packet_index
.ts_cycles
.timestamp_end
);
1871 /* read events discarded from header */
1872 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1873 if (len_index
>= 0) {
1874 struct bt_definition
*field
;
1876 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1877 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1878 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1881 /* read packet_seq_num from header */
1882 len_index
= bt_struct_declaration_lookup_field_index(
1883 file_stream
->parent
.stream_packet_context
->declaration
,
1884 g_quark_from_static_string("packet_seq_num"));
1885 if (len_index
>= 0) {
1886 struct bt_definition
*field
;
1888 field
= bt_struct_definition_get_field_from_index(
1889 file_stream
->parent
.stream_packet_context
,
1891 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1894 /* Use file size for packet size */
1895 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1896 /* Use packet size if non-zero, else file size */
1897 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1900 /* Validate content size and packet size values */
1901 if (packet_index
.content_size
> packet_index
.packet_size
) {
1902 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1903 packet_index
.content_size
, packet_index
.packet_size
);
1907 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1908 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1909 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1913 if (packet_index
.content_size
< pos
->offset
) {
1914 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1918 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1919 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1923 /* Save position after header and context */
1924 packet_index
.data_offset
= pos
->offset
;
1926 /* add index to packet array */
1927 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1929 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1933 /* Retry with larger mapping */
1935 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1937 * Reached EOF, but still expecting header/context data.
1939 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1942 /* Double the mapping len, and retry */
1943 tmp_map_len
= packet_map_len
<< 1;
1944 if (tmp_map_len
>> 1 != packet_map_len
) {
1946 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1949 packet_map_len
= tmp_map_len
;
1954 int create_stream_packet_index(struct ctf_trace
*td
,
1955 struct ctf_file_stream
*file_stream
)
1957 struct ctf_stream_pos
*pos
;
1958 struct stat filestats
;
1961 pos
= &file_stream
->pos
;
1963 ret
= fstat(pos
->fd
, &filestats
);
1967 /* Deal with empty files */
1968 if (!filestats
.st_size
) {
1969 if (file_stream
->parent
.trace_packet_header
1970 || file_stream
->parent
.stream_packet_context
) {
1972 * We expect a trace packet header and/or stream packet
1973 * context. Since a trace needs to have at least one
1974 * packet, empty files are therefore not accepted.
1976 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1980 * Without trace packet header nor stream packet
1981 * context, a one-packet trace can indeed be empty. This
1982 * is only valid if there is only one stream class: 0.
1984 ret
= stream_assign_class(td
, file_stream
, 0);
1991 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1992 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
2001 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
2005 if (td
->packet_header_decl
) {
2006 struct bt_definition
*definition
=
2007 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2008 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2013 stream
->trace_packet_header
=
2014 container_of(definition
, struct definition_struct
, p
);
2015 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2021 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2026 int import_stream_packet_index(struct ctf_trace
*td
,
2027 struct ctf_file_stream
*file_stream
)
2029 struct ctf_stream_pos
*pos
;
2030 struct ctf_packet_index
*ctf_index
= NULL
;
2031 struct ctf_packet_index_file_hdr index_hdr
;
2032 struct packet_index index
;
2033 uint32_t packet_index_len
, index_minor
;
2035 int first_packet
= 1;
2038 pos
= &file_stream
->pos
;
2040 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2042 perror("read index file header");
2046 /* Check the index header */
2047 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2048 fprintf(stderr
, "[error] wrong index magic\n");
2052 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2053 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2054 ".%" PRIu32
", supported %d.%d\n",
2055 be32toh(index_hdr
.index_major
),
2056 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2061 index_minor
= be32toh(index_hdr
.index_minor
);
2063 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2064 if (packet_index_len
== 0) {
2065 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2070 * Allocate the index length found in header, not internal
2073 ctf_index
= g_malloc0(packet_index_len
);
2074 while (fread(ctf_index
, packet_index_len
, 1,
2075 pos
->index_fp
) == 1) {
2077 struct ctf_stream_declaration
*stream
= NULL
;
2079 memset(&index
, 0, sizeof(index
));
2080 index
.offset
= be64toh(ctf_index
->offset
);
2081 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2082 index
.content_size
= be64toh(ctf_index
->content_size
);
2083 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2084 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2085 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2086 index
.events_discarded_len
= 64;
2087 index
.data_offset
= -1;
2088 stream_id
= be64toh(ctf_index
->stream_id
);
2089 if (index_minor
>= 1) {
2090 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2091 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2094 if (!first_packet
) {
2095 /* add index to packet array */
2096 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2100 file_stream
->parent
.stream_id
= stream_id
;
2101 if (stream_id
< td
->streams
->len
) {
2102 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2105 fprintf(stderr
, "[error] Stream %" PRIu64
2106 " is not declared in metadata.\n",
2111 file_stream
->parent
.stream_class
= stream
;
2112 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2116 /* add index to packet array */
2117 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2120 /* Index containing only the header. */
2121 if (!file_stream
->parent
.stream_class
) {
2134 * Note: many file streams can inherit from the same stream class
2135 * description (metadata).
2138 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2139 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2142 int ret
, fd
, closeret
;
2143 struct ctf_file_stream
*file_stream
;
2144 struct stat statbuf
;
2147 fd
= openat(td
->dirfd
, path
, flags
);
2149 perror("File stream openat()");
2154 /* Don't try to mmap subdirectories. Skip them, return success. */
2155 ret
= fstat(fd
, &statbuf
);
2157 perror("File stream fstat()");
2160 if (S_ISDIR(statbuf
.st_mode
)) {
2161 if (strncmp(path
, "index", 5) != 0) {
2162 fprintf(stderr
, "[warning] Skipping directory '%s' "
2163 "found in trace\n", path
);
2168 if (!statbuf
.st_size
) {
2169 /** Skip empty files. */
2171 goto fd_is_empty_file
;
2174 file_stream
= g_new0(struct ctf_file_stream
, 1);
2175 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2176 file_stream
->pos
.fd
= -1;
2177 file_stream
->pos
.index_fp
= NULL
;
2179 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2180 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2183 file_stream
->pos
.packet_seek
= packet_seek
;
2185 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2190 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2193 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2197 * For now, only a single clock per trace is supported.
2199 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2202 * Allocate the index name for this stream and try to open it.
2204 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2206 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2210 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2213 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2214 ret
= create_stream_packet_index(td
, file_stream
);
2216 fprintf(stderr
, "[error] Stream index creation error.\n");
2220 ret
= openat(td
->dirfd
, index_name
, flags
);
2222 perror("Index file openat()");
2226 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2227 if (!file_stream
->pos
.index_fp
) {
2228 perror("fdopen() error");
2231 ret
= import_stream_packet_index(td
, file_stream
);
2236 ret
= fclose(file_stream
->pos
.index_fp
);
2238 perror("close index");
2244 /* Add stream file to stream class */
2245 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2246 &file_stream
->parent
);
2250 if (file_stream
->pos
.index_fp
) {
2251 ret
= fclose(file_stream
->pos
.index_fp
);
2253 perror("close index");
2256 if (file_stream
->parent
.trace_packet_header
)
2257 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2261 closeret
= ctf_fini_pos(&file_stream
->pos
);
2263 fprintf(stderr
, "Error on ctf_fini_pos\n");
2265 g_free(file_stream
);
2269 closeret
= close(fd
);
2271 perror("Error on fd close");
2278 int ctf_open_trace_read(struct ctf_trace
*td
,
2279 const char *path
, int flags
,
2280 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2281 int whence
), FILE *metadata_fp
)
2283 struct ctf_scanner
*scanner
;
2285 struct dirent
*dirent
;
2286 struct dirent
*diriter
;
2292 /* Open trace directory */
2293 td
->dir
= opendir(path
);
2295 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2300 td
->dirfd
= open(path
, 0);
2301 if (td
->dirfd
< 0) {
2302 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2303 perror("Trace directory open");
2307 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2308 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2311 * Keep the metadata file separate.
2312 * Keep scanner object local to the open. We don't support
2313 * incremental metadata append for on-disk traces.
2315 scanner
= ctf_scanner_alloc();
2317 fprintf(stderr
, "[error] Error allocating scanner\n");
2319 goto error_metadata
;
2321 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2322 ctf_scanner_free(scanner
);
2324 if (ret
== -ENOENT
) {
2325 fprintf(stderr
, "[warning] Empty metadata.\n");
2327 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2328 goto error_metadata
;
2332 * Open each stream: for each file, try to open, check magic
2333 * number, and get the stream ID to add to the right location in
2337 dirent_len
= offsetof(struct dirent
, d_name
) +
2338 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2340 dirent
= malloc(dirent_len
);
2343 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2345 fprintf(stderr
, "[error] Readdir error.\n");
2350 /* Ignore hidden files, ., .. and metadata. */
2351 if (!strncmp(diriter
->d_name
, ".", 1)
2352 || !strcmp(diriter
->d_name
, "..")
2353 || !strcmp(diriter
->d_name
, "metadata"))
2356 /* Ignore index files : *.idx */
2357 ext
= strrchr(diriter
->d_name
, '.');
2358 if (ext
&& (!strcmp(ext
, ".idx"))) {
2362 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2363 flags
, packet_seek
);
2365 fprintf(stderr
, "[error] Open file stream error.\n");
2376 closeret
= close(td
->dirfd
);
2378 perror("Error on fd close");
2381 closeret
= closedir(td
->dir
);
2383 perror("Error on closedir");
2390 * ctf_open_trace: Open a CTF trace and index it.
2391 * Note that the user must seek the trace after the open (using the iterator)
2392 * since the index creation read it entirely.
2395 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2396 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2397 int whence
), FILE *metadata_fp
)
2399 struct ctf_trace
*td
;
2403 * If packet_seek is NULL, we provide our default version.
2406 packet_seek
= ctf_packet_seek
;
2408 td
= g_new0(struct ctf_trace
, 1);
2412 init_trace_descriptor(&td
->parent
);
2414 switch (flags
& O_ACCMODE
) {
2417 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2420 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2425 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2428 fprintf(stderr
, "[error] Incorrect open flags.\n");
2432 ret
= trace_debug_info_create(td
);
2440 trace_debug_info_destroy(td
);
2447 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2448 struct bt_mmap_stream
*mmap_info
)
2450 pos
->mmap_offset
= 0;
2451 pos
->packet_size
= 0;
2452 pos
->content_size
= 0;
2453 pos
->content_size_loc
= NULL
;
2454 pos
->fd
= mmap_info
->fd
;
2455 pos
->base_mma
= NULL
;
2459 pos
->prot
= PROT_READ
;
2460 pos
->flags
= MAP_PRIVATE
;
2461 pos
->parent
.rw_table
= read_dispatch_table
;
2462 pos
->parent
.event_cb
= ctf_read_event
;
2463 pos
->priv
= mmap_info
->priv
;
2464 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2465 sizeof(struct packet_index
));
2469 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2470 struct ctf_file_stream
*file_stream
,
2471 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2474 struct ctf_stream_declaration
*stream
;
2478 /* Ask for the first packet to get the stream_id. */
2479 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2480 stream_id
= file_stream
->parent
.stream_id
;
2481 if (stream_id
>= td
->streams
->len
) {
2482 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2483 "in metadata.\n", stream_id
);
2487 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2489 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2490 "in metadata.\n", stream_id
);
2494 file_stream
->parent
.stream_class
= stream
;
2495 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2501 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2502 struct bt_mmap_stream
*mmap_info
,
2503 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2507 struct ctf_file_stream
*file_stream
;
2509 file_stream
= g_new0(struct ctf_file_stream
, 1);
2510 file_stream
->parent
.stream_id
= -1ULL;
2511 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2512 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2514 file_stream
->pos
.packet_seek
= packet_seek
;
2516 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2521 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2526 * For now, only a single clock per trace is supported.
2528 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2530 /* Add stream file to stream class */
2531 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2532 &file_stream
->parent
);
2536 if (file_stream
->parent
.trace_packet_header
)
2537 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2539 g_free(file_stream
);
2544 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2545 struct bt_mmap_stream_list
*mmap_list
,
2546 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2551 struct bt_mmap_stream
*mmap_info
;
2553 td
->scanner
= ctf_scanner_alloc();
2555 fprintf(stderr
, "[error] Error allocating scanner\n");
2559 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2561 if (ret
== -ENOENT
) {
2562 fprintf(stderr
, "[warning] Empty metadata.\n");
2568 * for each stream, try to open, check magic number, and get the
2569 * stream ID to add to the right location in the stream array.
2571 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2572 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2574 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2581 ctf_scanner_free(td
->scanner
);
2586 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2587 struct bt_mmap_stream_list
*mmap_list
,
2588 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2592 struct ctf_trace
*td
;
2596 fprintf(stderr
, "[error] No metadata file pointer associated, "
2597 "required for mmap parsing\n");
2601 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2604 td
= g_new0(struct ctf_trace
, 1);
2606 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2610 ret
= trace_debug_info_create(td
);
2623 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2626 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2632 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2635 /* for each stream_class */
2636 for (i
= 0; i
< td
->streams
->len
; i
++) {
2637 struct ctf_stream_declaration
*stream_class
;
2639 stream_class
= g_ptr_array_index(td
->streams
, i
);
2642 /* for each stream */
2643 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2644 struct ctf_stream_definition
*stream
;
2646 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2649 ret
= copy_event_declarations_stream_class_to_stream(td
,
2650 stream_class
, stream
);
2659 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2662 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2664 /* for each stream_class */
2665 for (i
= 0; i
< td
->streams
->len
; i
++) {
2666 struct ctf_stream_declaration
*stream_class
;
2668 stream_class
= g_ptr_array_index(td
->streams
, i
);
2671 /* for each file_stream */
2672 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2673 struct ctf_stream_definition
*stream
;
2674 struct ctf_stream_pos
*stream_pos
;
2675 struct ctf_file_stream
*cfs
;
2677 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2680 cfs
= container_of(stream
, struct ctf_file_stream
,
2682 stream_pos
= &cfs
->pos
;
2683 if (!stream_pos
->packet_index
)
2686 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2687 struct packet_index
*index
;
2689 index
= &g_array_index(stream_pos
->packet_index
,
2690 struct packet_index
, k
);
2691 index
->ts_real
.timestamp_begin
=
2692 ctf_get_real_timestamp(stream
,
2693 index
->ts_cycles
.timestamp_begin
);
2694 index
->ts_real
.timestamp_end
=
2695 ctf_get_real_timestamp(stream
,
2696 index
->ts_cycles
.timestamp_end
);
2704 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2708 ret
= ctf_fini_pos(&file_stream
->pos
);
2710 fprintf(stderr
, "Error on ctf_fini_pos\n");
2713 if (file_stream
->pos
.fd
>= 0) {
2714 ret
= close(file_stream
->pos
.fd
);
2716 perror("Error closing file fd");
2724 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2726 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2732 for (i
= 0; i
< td
->streams
->len
; i
++) {
2733 struct ctf_stream_declaration
*stream
;
2736 stream
= g_ptr_array_index(td
->streams
, i
);
2739 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2740 struct ctf_file_stream
*file_stream
;
2741 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2742 struct ctf_file_stream
, parent
);
2743 ret
= ctf_close_file_stream(file_stream
);
2749 ctf_destroy_metadata(td
);
2750 ctf_scanner_free(td
->scanner
);
2751 if (td
->dirfd
>= 0) {
2752 ret
= close(td
->dirfd
);
2754 perror("Error closing dirfd");
2759 ret
= closedir(td
->dir
);
2761 perror("Error closedir");
2765 free(td
->metadata_string
);
2766 trace_debug_info_destroy(td
);
2772 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2773 struct bt_context
*ctx
)
2775 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2778 td
->parent
.ctx
= ctx
;
2782 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2783 struct bt_trace_handle
*handle
)
2785 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2788 td
->parent
.handle
= handle
;
2792 void __attribute__((constructor
)) ctf_init(void)
2796 ctf_format
.name
= g_quark_from_static_string("ctf");
2797 ret
= bt_register_format(&ctf_format
);
2802 void __attribute__((destructor
)) ctf_exit(void)
2804 bt_unregister_format(&ctf_format
);