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-debuginfo.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
,
161 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
162 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
164 struct ctf_trace
*tin
;
165 uint64_t begin
= ULLONG_MAX
;
168 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
173 /* for each stream_class */
174 for (i
= 0; i
< tin
->streams
->len
; i
++) {
175 struct ctf_stream_declaration
*stream_class
;
177 stream_class
= g_ptr_array_index(tin
->streams
, i
);
180 /* for each file_stream */
181 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
182 struct ctf_stream_definition
*stream
;
183 struct ctf_file_stream
*cfs
;
184 struct ctf_stream_pos
*stream_pos
;
185 struct packet_index
*index
;
187 stream
= g_ptr_array_index(stream_class
->streams
, j
);
188 cfs
= container_of(stream
, struct ctf_file_stream
,
190 stream_pos
= &cfs
->pos
;
192 if (!stream_pos
->packet_index
)
195 if (stream_pos
->packet_index
->len
<= 0)
198 index
= &g_array_index(stream_pos
->packet_index
,
200 stream_pos
->packet_index
->len
- 1);
201 if (type
== BT_CLOCK_REAL
) {
202 if (index
->ts_real
.timestamp_begin
< begin
)
203 begin
= index
->ts_real
.timestamp_begin
;
204 } else if (type
== BT_CLOCK_CYCLES
) {
205 if (index
->ts_cycles
.timestamp_begin
< begin
)
206 begin
= index
->ts_cycles
.timestamp_begin
;
220 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
221 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
223 struct ctf_trace
*tin
;
227 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
232 /* for each stream_class */
233 for (i
= 0; i
< tin
->streams
->len
; i
++) {
234 struct ctf_stream_declaration
*stream_class
;
236 stream_class
= g_ptr_array_index(tin
->streams
, i
);
239 /* for each file_stream */
240 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
241 struct ctf_stream_definition
*stream
;
242 struct ctf_file_stream
*cfs
;
243 struct ctf_stream_pos
*stream_pos
;
244 struct packet_index
*index
;
246 stream
= g_ptr_array_index(stream_class
->streams
, j
);
247 cfs
= container_of(stream
, struct ctf_file_stream
,
249 stream_pos
= &cfs
->pos
;
251 if (!stream_pos
->packet_index
)
254 if (stream_pos
->packet_index
->len
<= 0)
257 index
= &g_array_index(stream_pos
->packet_index
,
259 stream_pos
->packet_index
->len
- 1);
260 if (type
== BT_CLOCK_REAL
) {
261 if (index
->ts_real
.timestamp_end
> end
)
262 end
= index
->ts_real
.timestamp_end
;
263 } else if (type
== BT_CLOCK_CYCLES
) {
264 if (index
->ts_cycles
.timestamp_end
> end
)
265 end
= index
->ts_cycles
.timestamp_end
;
279 * Update stream current timestamp
282 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
283 struct definition_integer
*integer_definition
)
285 struct declaration_integer
*integer_declaration
=
286 integer_definition
->declaration
;
287 uint64_t oldval
, newval
, updateval
;
289 if (unlikely(integer_declaration
->len
== 64)) {
290 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
291 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
292 stream
->cycles_timestamp
);
296 oldval
= stream
->cycles_timestamp
;
297 oldval
&= (1ULL << integer_declaration
->len
) - 1;
298 newval
= integer_definition
->value
._unsigned
;
299 /* Test for overflow by comparing low bits */
301 newval
+= 1ULL << integer_declaration
->len
;
302 /* updateval contains old high bits, and new low bits (sum) */
303 updateval
= stream
->cycles_timestamp
;
304 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
306 stream
->cycles_timestamp
= updateval
;
308 /* convert to real timestamp */
309 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
310 stream
->cycles_timestamp
);
314 * Print timestamp, rescaling clock frequency to nanoseconds and
315 * applying offsets as needed (unix time).
318 void ctf_print_timestamp_real(FILE *fp
,
319 struct ctf_stream_definition
*stream
,
322 uint64_t ts_sec
= 0, ts_nsec
;
326 /* Add command-line offset in ns*/
327 ts_nsec
+= opt_clock_offset_ns
;
329 /* Add command-line offset */
330 ts_sec
+= opt_clock_offset
;
332 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
333 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
335 if (!opt_clock_seconds
) {
337 time_t time_s
= (time_t) ts_sec
;
339 if (!opt_clock_gmt
) {
342 res
= localtime_r(&time_s
, &tm
);
344 fprintf(stderr
, "[warning] Unable to get localtime.\n");
350 res
= gmtime_r(&time_s
, &tm
);
352 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
356 if (opt_clock_date
) {
360 /* Print date and time */
361 res
= strftime(timestr
, sizeof(timestr
),
364 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
367 fprintf(fp
, "%s", timestr
);
369 /* Print time in HH:MM:SS.ns */
370 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
371 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
375 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
383 * Print timestamp, in cycles
386 void ctf_print_timestamp_cycles(FILE *fp
,
387 struct ctf_stream_definition
*stream
,
390 fprintf(fp
, "%020" PRIu64
, timestamp
);
393 void ctf_print_timestamp(FILE *fp
,
394 struct ctf_stream_definition
*stream
,
397 if (opt_clock_cycles
) {
398 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
400 ctf_print_timestamp_real(fp
, stream
, timestamp
);
405 void print_uuid(FILE *fp
, unsigned char *uuid
)
409 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
410 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
414 * Discarded events can be either:
415 * - discarded after end of previous buffer due to buffer full:
416 * happened within range: [ prev_timestamp_end, timestamp_begin ]
417 * - discarded within current buffer due to either event too large or
418 * nested wrap-around:
419 * happened within range: [ timestamp_begin, timestamp_end ]
421 * Given we have discarded counters of those two types merged into the
422 * events_discarded counter, we need to use the union of those ranges:
423 * [ prev_timestamp_end, timestamp_end ]
425 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
426 * consumer had time to extract them. We keep track of those gaps with the
427 * 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 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
475 struct ctf_stream_pos
*pos
=
476 container_of(ppos
, struct ctf_stream_pos
, parent
);
477 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
478 struct ctf_event_definition
*event
;
482 /* We need to check for EOF here for empty files. */
483 if (unlikely(pos
->offset
== EOF
))
486 ctf_pos_get_event(pos
);
488 /* save the current position as a restore point */
489 pos
->last_offset
= pos
->offset
;
492 * This is the EOF check after we've advanced the position in
495 if (unlikely(pos
->offset
== EOF
))
498 /* Stream is inactive for now (live reading). */
499 if (unlikely(pos
->content_size
== 0))
503 * Packet seeked to by ctf_pos_get_event() only contains
504 * headers, no event. Consider stream as inactive (live
507 if (unlikely(pos
->data_offset
== pos
->content_size
))
510 assert(pos
->offset
< pos
->content_size
);
512 /* Read event header */
513 if (likely(stream
->stream_event_header
)) {
514 struct definition_integer
*integer_definition
;
515 struct bt_definition
*variant
;
517 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
520 /* lookup event id */
521 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
522 if (integer_definition
) {
523 id
= integer_definition
->value
._unsigned
;
525 struct definition_enum
*enum_definition
;
527 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
528 if (enum_definition
) {
529 id
= enum_definition
->integer
->value
._unsigned
;
533 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
535 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
536 if (integer_definition
) {
537 id
= integer_definition
->value
._unsigned
;
540 stream
->event_id
= id
;
542 /* lookup timestamp */
543 stream
->has_timestamp
= 0;
544 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
545 if (integer_definition
) {
546 ctf_update_timestamp(stream
, integer_definition
);
547 stream
->has_timestamp
= 1;
550 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
551 if (integer_definition
) {
552 ctf_update_timestamp(stream
, integer_definition
);
553 stream
->has_timestamp
= 1;
559 /* Read stream-declared event context */
560 if (stream
->stream_event_context
) {
561 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
566 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
567 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
570 event
= g_ptr_array_index(stream
->events_by_id
, id
);
571 if (unlikely(!event
)) {
572 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
576 /* Read event-declared event context */
577 if (event
->event_context
) {
578 ret
= generic_rw(ppos
, &event
->event_context
->p
);
583 /* Read event payload */
584 if (likely(event
->event_fields
)) {
585 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
590 if (pos
->last_offset
== pos
->offset
) {
591 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
598 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
603 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
605 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
606 struct ctf_event_definition
*event
;
610 id
= stream
->event_id
;
612 /* print event header */
613 if (likely(stream
->stream_event_header
)) {
614 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
619 /* print stream-declared event context */
620 if (stream
->stream_event_context
) {
621 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
626 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
627 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
630 event
= g_ptr_array_index(stream
->events_by_id
, id
);
631 if (unlikely(!event
)) {
632 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
636 /* print event-declared event context */
637 if (event
->event_context
) {
638 ret
= generic_rw(pos
, &event
->event_context
->p
);
643 /* Read and print event payload */
644 if (likely(event
->event_fields
)) {
645 ret
= generic_rw(pos
, &event
->event_fields
->p
);
653 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
658 * One side-effect of this function is to unmap pos mmap base if one is
662 int find_data_offset(struct ctf_stream_pos
*pos
,
663 struct ctf_file_stream
*file_stream
,
664 struct packet_index
*packet_index
)
666 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
667 struct stat filestats
;
671 pos
= &file_stream
->pos
;
673 ret
= fstat(pos
->fd
, &filestats
);
676 filesize
= filestats
.st_size
;
678 /* Deal with empty files */
684 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
685 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
690 ret
= munmap_align(pos
->base_mma
);
692 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
696 pos
->base_mma
= NULL
;
698 /* map new base. Need mapping length from header. */
699 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
700 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
701 assert(pos
->base_mma
!= MAP_FAILED
);
703 pos
->content_size
= packet_map_len
;
704 pos
->packet_size
= packet_map_len
;
705 pos
->offset
= 0; /* Position of the packet header */
707 /* update trace_packet_header and stream_packet_context */
708 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
709 /* Read packet header */
710 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
716 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
717 /* Read packet context */
718 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
724 packet_index
->data_offset
= pos
->offset
;
727 ret
= munmap_align(pos
->base_mma
);
729 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
733 pos
->base_mma
= NULL
;
737 /* Retry with larger mapping */
739 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
741 * Reached EOF, but still expecting header/context data.
743 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
746 /* Double the mapping len, and retry */
747 tmp_map_len
= packet_map_len
<< 1;
748 if (tmp_map_len
>> 1 != packet_map_len
) {
750 fprintf(stderr
, "[error] Packet mapping length overflow\n");
753 packet_map_len
= tmp_map_len
;
758 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
759 int fd
, int open_flags
)
763 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
764 sizeof(struct packet_index
));
766 pos
->packet_index
= NULL
;
768 switch (open_flags
& O_ACCMODE
) {
770 pos
->prot
= PROT_READ
;
771 pos
->flags
= MAP_PRIVATE
;
772 pos
->parent
.rw_table
= read_dispatch_table
;
773 pos
->parent
.event_cb
= ctf_read_event
;
774 pos
->parent
.trace
= trace
;
777 pos
->prot
= PROT_READ
| PROT_WRITE
;
778 pos
->flags
= MAP_SHARED
;
779 pos
->parent
.rw_table
= write_dispatch_table
;
780 pos
->parent
.event_cb
= ctf_write_event
;
781 pos
->parent
.trace
= trace
;
783 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
791 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
793 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
794 *pos
->content_size_loc
= pos
->offset
;
799 ret
= munmap_align(pos
->base_mma
);
801 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
806 if (pos
->packet_index
)
807 (void) g_array_free(pos
->packet_index
, TRUE
);
811 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
812 struct packet_index
*prev_index
,
813 struct packet_index
*cur_index
)
815 uint64_t events_discarded_diff
;
816 uint64_t packets_lost_diff
= 0;
818 /* Update packet index time information */
820 /* Current packet begin/end */
821 stream
->current
.real
.begin
=
822 cur_index
->ts_real
.timestamp_begin
;
823 stream
->current
.cycles
.begin
=
824 cur_index
->ts_cycles
.timestamp_begin
;
825 stream
->current
.real
.end
=
826 cur_index
->ts_real
.timestamp_end
;
827 stream
->current
.cycles
.end
=
828 cur_index
->ts_cycles
.timestamp_end
;
830 /* Update packet index discarded event information */
831 events_discarded_diff
= cur_index
->events_discarded
;
833 /* Previous packet begin/end */
834 stream
->prev
.cycles
.begin
=
835 prev_index
->ts_cycles
.timestamp_begin
;
836 stream
->prev
.real
.begin
=
837 prev_index
->ts_real
.timestamp_begin
;
838 stream
->prev
.cycles
.end
=
839 prev_index
->ts_cycles
.timestamp_end
;
840 stream
->prev
.real
.end
=
841 prev_index
->ts_real
.timestamp_end
;
843 events_discarded_diff
-= prev_index
->events_discarded
;
844 /* packet_seq_num stays at 0 if not produced by the tracer */
845 if (cur_index
->packet_seq_num
) {
846 packets_lost_diff
= cur_index
->packet_seq_num
-
847 prev_index
->packet_seq_num
- 1;
850 * Deal with 32-bit wrap-around if the tracer provided a
853 if (prev_index
->events_discarded_len
== 32) {
854 events_discarded_diff
= (uint32_t) events_discarded_diff
;
858 * First packet: use current packet info as limits for
861 stream
->prev
.cycles
.begin
=
862 stream
->prev
.cycles
.end
=
863 stream
->current
.cycles
.begin
;
864 stream
->prev
.real
.begin
=
865 stream
->prev
.real
.end
=
866 stream
->current
.real
.begin
;
868 stream
->events_discarded
= events_discarded_diff
;
869 stream
->packets_lost
= packets_lost_diff
;
873 * Find the timerange where all the streams in the trace are active
876 * Return 0 and update begin/end if necessary on success, return 1 for
877 * empty streams and return a negative value on error.
880 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
881 struct packet_index_time
*_real
,
882 struct packet_index_time
*_cycles
)
884 int stream_id
, ret
= 0;
885 struct packet_index_time real
= { 0, UINT64_MAX
},
886 cycles
= { 0, UINT64_MAX
};
887 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
889 /* At least one of the two return args must be provided. */
890 if (!_real
&& !_cycles
) {
895 if (tin
->streams
->len
== 0) {
900 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
903 struct ctf_stream_declaration
*stream_class
;
905 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
909 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
910 struct ctf_file_stream
*file_stream
;
911 struct ctf_stream_pos
*stream_pos
;
912 struct packet_index
*index
;
914 file_stream
= g_ptr_array_index(stream_class
->streams
,
919 stream_pos
= &file_stream
->pos
;
920 if (!stream_pos
->packet_index
||
921 stream_pos
->packet_index
->len
<= 0) {
925 index
= &g_array_index(stream_pos
->packet_index
,
926 struct packet_index
, 0);
927 real
.timestamp_begin
= max(real
.timestamp_begin
,
928 index
->ts_real
.timestamp_begin
);
929 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
930 index
->ts_cycles
.timestamp_begin
);
932 index
= &g_array_index(stream_pos
->packet_index
,
934 stream_pos
->packet_index
->len
- 1);
935 real
.timestamp_end
= min(real
.timestamp_end
,
936 index
->ts_real
.timestamp_end
);
937 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
938 index
->ts_cycles
.timestamp_end
);
954 * Find the union of all active regions in the trace collection's traces.
955 * Returns "real" timestamps.
957 * Return 0 on success.
958 * Return 1 if no intersections are found.
959 * Return a negative value on error.
961 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
962 uint64_t *_ts_begin
, uint64_t *_ts_end
)
965 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
967 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
972 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
973 struct bt_trace_descriptor
*td_read
;
974 struct packet_index_time intersection_real
;
976 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
980 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
983 /* Empty trace or no stream intersection. */
985 } else if (ret
< 0) {
989 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
990 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
993 if (ts_end
< ts_begin
) {
997 *_ts_begin
= ts_begin
;
1003 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1007 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1012 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1013 struct bt_trace_descriptor
*td_read
;
1014 struct packet_index_time intersection_real
;
1016 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1021 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1024 /* Empty trace or no stream intersection. */
1026 } else if (ret
< 0) {
1030 td_read
->interval_real
= intersection_real
;
1031 td_read
->interval_set
= true;
1038 * for SEEK_CUR: go to next packet.
1039 * for SEEK_SET: go to packet numer (index).
1041 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1043 struct ctf_stream_pos
*pos
=
1044 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1045 struct ctf_file_stream
*file_stream
=
1046 container_of(pos
, struct ctf_file_stream
, pos
);
1048 struct packet_index
*packet_index
, *prev_index
;
1052 case SEEK_SET
: /* Fall-through */
1058 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1059 *pos
->content_size_loc
= pos
->offset
;
1061 if (pos
->base_mma
) {
1062 /* unmap old base */
1063 ret
= munmap_align(pos
->base_mma
);
1065 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1069 pos
->base_mma
= NULL
;
1073 * The caller should never ask for ctf_move_pos across packets,
1074 * except to get exactly at the beginning of the next packet.
1076 if (pos
->prot
& PROT_WRITE
) {
1079 /* The writer will add padding */
1080 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1083 assert(index
== 0); /* only seek supported for now */
1089 pos
->content_size
= -1U; /* Unknown at this point */
1090 pos
->packet_size
= WRITE_PACKET_LEN
;
1092 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1093 pos
->packet_size
/ CHAR_BIT
);
1094 } while (ret
== EINTR
);
1102 if (pos
->offset
== EOF
) {
1105 assert(pos
->cur_index
< pos
->packet_index
->len
);
1106 /* The reader will expect us to skip padding */
1111 if (index
>= pos
->packet_index
->len
) {
1115 pos
->cur_index
= index
;
1121 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1126 packet_index
= &g_array_index(pos
->packet_index
,
1127 struct packet_index
, pos
->cur_index
);
1128 if (pos
->cur_index
> 0) {
1129 prev_index
= &g_array_index(pos
->packet_index
,
1130 struct packet_index
,
1131 pos
->cur_index
- 1);
1135 ctf_update_current_packet_index(&file_stream
->parent
,
1136 prev_index
, packet_index
);
1139 * We need to check if we are in trace read or called
1140 * from packet indexing. In this last case, the
1141 * collection is not there, so we cannot print the
1144 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1145 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1148 packet_index
= &g_array_index(pos
->packet_index
,
1149 struct packet_index
,
1151 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1153 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1155 /* Lookup context/packet size in index */
1156 if (packet_index
->data_offset
== -1) {
1157 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1162 pos
->content_size
= packet_index
->content_size
;
1163 pos
->packet_size
= packet_index
->packet_size
;
1164 pos
->mmap_offset
= packet_index
->offset
;
1165 pos
->data_offset
= packet_index
->data_offset
;
1166 if (pos
->data_offset
< packet_index
->content_size
) {
1167 pos
->offset
= 0; /* will read headers */
1168 } else if (pos
->data_offset
== packet_index
->content_size
) {
1170 pos
->offset
= packet_index
->data_offset
;
1172 goto read_next_packet
;
1178 /* map new base. Need mapping length from header. */
1179 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1180 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1181 if (pos
->base_mma
== MAP_FAILED
) {
1182 fprintf(stderr
, "[error] mmap error %s.\n",
1187 /* update trace_packet_header and stream_packet_context */
1188 if (!(pos
->prot
& PROT_WRITE
) &&
1189 file_stream
->parent
.trace_packet_header
) {
1190 /* Read packet header */
1191 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1194 if (!(pos
->prot
& PROT_WRITE
) &&
1195 file_stream
->parent
.stream_packet_context
) {
1196 /* Read packet context */
1197 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1203 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1209 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1213 if (magic
== TSDL_MAGIC
) {
1215 td
->byte_order
= BYTE_ORDER
;
1216 CTF_TRACE_SET_FIELD(td
, byte_order
);
1217 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1219 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1220 LITTLE_ENDIAN
: BIG_ENDIAN
;
1221 CTF_TRACE_SET_FIELD(td
, byte_order
);
1229 * Returns 0 on success, -1 on error.
1232 int check_version(unsigned int major
, unsigned int minor
)
1247 /* eventually return an error instead of warning */
1249 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1255 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1258 struct metadata_packet_header header
;
1259 size_t readlen
, writelen
, toread
;
1260 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1263 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1267 if (td
->byte_order
!= BYTE_ORDER
) {
1268 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1269 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1270 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1271 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1273 if (header
.checksum
)
1274 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1275 if (header
.compression_scheme
) {
1276 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1277 header
.compression_scheme
);
1280 if (header
.encryption_scheme
) {
1281 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1282 header
.encryption_scheme
);
1285 if (header
.checksum_scheme
) {
1286 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1287 header
.checksum_scheme
);
1290 if (check_version(header
.major
, header
.minor
) < 0)
1292 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1293 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1294 CTF_TRACE_SET_FIELD(td
, uuid
);
1296 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1300 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1303 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1306 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1311 if (babeltrace_debug
) {
1312 buf
[readlen
] = '\0';
1313 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1317 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1318 if (writelen
< readlen
) {
1328 ret
= 0; /* continue reading next packet */
1335 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1336 ret
= fseek(in
, toread
, SEEK_CUR
);
1338 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1345 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1349 size_t size
, buflen
;
1354 * Using strlen on *buf instead of size of open_memstream
1355 * because its size includes garbage at the end (after final
1356 * \0). This is the allocated size, not the actual string size.
1358 out
= babeltrace_open_memstream(buf
, &size
);
1360 perror("Metadata open_memstream");
1364 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1373 /* close to flush the buffer */
1374 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1378 perror("babeltrace_flush_memstream");
1380 closeret
= fclose(in
);
1382 perror("Error in fclose");
1388 perror("Error in fclose");
1390 /* open for reading */
1391 buflen
= strlen(*buf
);
1396 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1398 perror("Metadata fmemopen");
1405 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1406 struct ctf_scanner
*scanner
, int append
)
1408 struct ctf_file_stream
*metadata_stream
;
1411 int ret
= 0, closeret
;
1413 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1414 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1418 metadata_stream
->pos
.fd
= -1;
1420 td
->metadata
= &metadata_stream
->parent
;
1421 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1422 if (metadata_stream
->pos
.fd
< 0) {
1423 fprintf(stderr
, "Unable to open metadata.\n");
1428 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1430 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1431 perror("Metadata stream open");
1435 /* fd now belongs to fp */
1436 metadata_stream
->pos
.fd
= -1;
1438 if (babeltrace_debug
)
1441 if (packet_metadata(td
, fp
)) {
1442 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1446 td
->metadata_string
= buf
;
1447 td
->metadata_packetized
= 1;
1450 unsigned int major
, minor
;
1453 td
->byte_order
= BYTE_ORDER
;
1455 /* Check text-only metadata header and version */
1456 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1458 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1459 if (check_version(major
, minor
) < 0) {
1467 ret
= ctf_scanner_append_ast(scanner
, fp
);
1469 fprintf(stderr
, "[error] Error creating AST\n");
1473 if (babeltrace_debug
) {
1474 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1476 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1481 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1483 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1486 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1487 td
, td
->byte_order
);
1489 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1494 closeret
= fclose(fp
);
1496 perror("Error on fclose");
1500 if (metadata_stream
->pos
.fd
>= 0) {
1501 closeret
= close(metadata_stream
->pos
.fd
);
1503 perror("Error on metadata stream fd close");
1508 g_free(metadata_stream
);
1513 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1514 struct ctf_stream_definition
*stream
,
1515 struct ctf_event_declaration
*event
)
1517 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1519 if (event
->context_decl
) {
1520 struct bt_definition
*definition
=
1521 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1522 stream
->parent_def_scope
, 0, 0, "event.context");
1526 stream_event
->event_context
= container_of(definition
,
1527 struct definition_struct
, p
);
1528 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1530 if (event
->fields_decl
) {
1531 struct bt_definition
*definition
=
1532 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1533 stream
->parent_def_scope
, 0, 0, "event.fields");
1537 stream_event
->event_fields
= container_of(definition
,
1538 struct definition_struct
, p
);
1539 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1541 stream_event
->stream
= stream
;
1542 return stream_event
;
1545 if (stream_event
->event_fields
)
1546 bt_definition_unref(&stream_event
->event_fields
->p
);
1547 if (stream_event
->event_context
)
1548 bt_definition_unref(&stream_event
->event_context
->p
);
1549 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1550 g_quark_to_string(event
->name
));
1555 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1556 struct ctf_stream_declaration
*stream_class
,
1557 struct ctf_stream_definition
*stream
)
1559 size_t def_size
, class_size
, i
;
1562 def_size
= stream
->events_by_id
->len
;
1563 class_size
= stream_class
->events_by_id
->len
;
1565 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1566 for (i
= def_size
; i
< class_size
; i
++) {
1567 struct ctf_event_declaration
*event
=
1568 g_ptr_array_index(stream_class
->events_by_id
, i
);
1569 struct ctf_event_definition
*stream_event
;
1573 stream_event
= create_event_definitions(td
, stream
, event
);
1574 if (!stream_event
) {
1578 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1585 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1587 struct ctf_stream_declaration
*stream_class
;
1591 if (stream
->stream_definitions_created
)
1594 stream_class
= stream
->stream_class
;
1596 if (stream_class
->packet_context_decl
) {
1597 struct bt_definition
*definition
=
1598 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1599 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1604 stream
->stream_packet_context
= container_of(definition
,
1605 struct definition_struct
, p
);
1606 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1608 if (stream_class
->event_header_decl
) {
1609 struct bt_definition
*definition
=
1610 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1611 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1616 stream
->stream_event_header
=
1617 container_of(definition
, struct definition_struct
, p
);
1618 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1620 if (stream_class
->event_context_decl
) {
1621 struct bt_definition
*definition
=
1622 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1623 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1628 stream
->stream_event_context
=
1629 container_of(definition
, struct definition_struct
, p
);
1630 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1632 stream
->events_by_id
= g_ptr_array_new();
1633 ret
= copy_event_declarations_stream_class_to_stream(td
,
1634 stream_class
, stream
);
1640 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1641 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1643 g_free(stream_event
);
1645 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1647 if (stream
->stream_event_context
)
1648 bt_definition_unref(&stream
->stream_event_context
->p
);
1649 if (stream
->stream_event_header
)
1650 bt_definition_unref(&stream
->stream_event_header
->p
);
1651 if (stream
->stream_packet_context
)
1652 bt_definition_unref(&stream
->stream_packet_context
->p
);
1653 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1654 stream_class
->stream_id
, strerror(-ret
));
1659 int stream_assign_class(struct ctf_trace
*td
,
1660 struct ctf_file_stream
*file_stream
,
1663 struct ctf_stream_declaration
*stream
;
1666 file_stream
->parent
.stream_id
= stream_id
;
1667 if (stream_id
>= td
->streams
->len
) {
1668 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1671 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1673 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1676 file_stream
->parent
.stream_class
= stream
;
1677 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1684 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1685 struct ctf_trace
*td
,
1686 struct ctf_file_stream
*file_stream
,
1689 struct packet_index packet_index
;
1690 uint64_t stream_id
= 0;
1691 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1692 int first_packet
= 0;
1697 memset(&packet_index
, 0, sizeof(packet_index
));
1698 if (!pos
->mmap_offset
) {
1702 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1703 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1706 if (pos
->base_mma
) {
1707 /* unmap old base */
1708 ret
= munmap_align(pos
->base_mma
);
1710 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1714 pos
->base_mma
= NULL
;
1716 /* map new base. Need mapping length from header. */
1717 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1718 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1719 assert(pos
->base_mma
!= MAP_FAILED
);
1721 * Use current mapping size as temporary content and packet
1724 pos
->content_size
= packet_map_len
;
1725 pos
->packet_size
= packet_map_len
;
1726 pos
->offset
= 0; /* Position of the packet header */
1728 packet_index
.offset
= pos
->mmap_offset
;
1730 /* read and check header, set stream id (and check) */
1731 if (file_stream
->parent
.trace_packet_header
) {
1732 /* Read packet header */
1733 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1737 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1740 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1741 if (len_index
>= 0) {
1742 struct bt_definition
*field
;
1745 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1746 magic
= bt_get_unsigned_int(field
);
1747 if (magic
!= CTF_MAGIC
) {
1748 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1750 file_stream
->pos
.packet_index
->len
,
1751 (ssize_t
) pos
->mmap_offset
);
1757 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1758 if (len_index
>= 0) {
1759 struct definition_array
*defarray
;
1760 struct bt_definition
*field
;
1762 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1764 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1765 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1766 defarray
= container_of(field
, struct definition_array
, p
);
1767 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1769 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1770 struct bt_definition
*elem
;
1772 elem
= bt_array_index(defarray
, i
);
1773 uuidval
[i
] = bt_get_unsigned_int(elem
);
1775 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1777 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1782 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1783 if (len_index
>= 0) {
1784 struct bt_definition
*field
;
1786 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1787 stream_id
= bt_get_unsigned_int(field
);
1791 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1792 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1794 file_stream
->parent
.stream_id
);
1798 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1803 if (file_stream
->parent
.stream_packet_context
) {
1804 /* Read packet context */
1805 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1809 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1812 /* read packet size from header */
1813 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1814 if (len_index
>= 0) {
1815 struct bt_definition
*field
;
1817 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1818 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1820 /* Use file size for packet size */
1821 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1824 /* read content size from header */
1825 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1826 if (len_index
>= 0) {
1827 struct bt_definition
*field
;
1829 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1830 packet_index
.content_size
= bt_get_unsigned_int(field
);
1832 /* Use packet size if non-zero, else file size */
1833 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1836 /* read timestamp begin from header */
1837 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1838 if (len_index
>= 0) {
1839 struct bt_definition
*field
;
1841 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1842 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1843 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1844 packet_index
.ts_real
.timestamp_begin
=
1845 ctf_get_real_timestamp(
1846 &file_stream
->parent
,
1847 packet_index
.ts_cycles
.timestamp_begin
);
1851 /* read timestamp end from header */
1852 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1853 if (len_index
>= 0) {
1854 struct bt_definition
*field
;
1856 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1857 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1858 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1859 packet_index
.ts_real
.timestamp_end
=
1860 ctf_get_real_timestamp(
1861 &file_stream
->parent
,
1862 packet_index
.ts_cycles
.timestamp_end
);
1866 /* read events discarded from header */
1867 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1868 if (len_index
>= 0) {
1869 struct bt_definition
*field
;
1871 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1872 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1873 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1876 /* read packet_seq_num from header */
1877 len_index
= bt_struct_declaration_lookup_field_index(
1878 file_stream
->parent
.stream_packet_context
->declaration
,
1879 g_quark_from_static_string("packet_seq_num"));
1880 if (len_index
>= 0) {
1881 struct bt_definition
*field
;
1883 field
= bt_struct_definition_get_field_from_index(
1884 file_stream
->parent
.stream_packet_context
,
1886 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1889 /* Use file size for packet size */
1890 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1891 /* Use packet size if non-zero, else file size */
1892 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1895 /* Validate content size and packet size values */
1896 if (packet_index
.content_size
> packet_index
.packet_size
) {
1897 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1898 packet_index
.content_size
, packet_index
.packet_size
);
1902 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1903 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1904 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1908 if (packet_index
.content_size
< pos
->offset
) {
1909 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1913 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1914 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1918 /* Save position after header and context */
1919 packet_index
.data_offset
= pos
->offset
;
1921 /* add index to packet array */
1922 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1924 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1928 /* Retry with larger mapping */
1930 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1932 * Reached EOF, but still expecting header/context data.
1934 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1937 /* Double the mapping len, and retry */
1938 tmp_map_len
= packet_map_len
<< 1;
1939 if (tmp_map_len
>> 1 != packet_map_len
) {
1941 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1944 packet_map_len
= tmp_map_len
;
1949 int create_stream_packet_index(struct ctf_trace
*td
,
1950 struct ctf_file_stream
*file_stream
)
1952 struct ctf_stream_pos
*pos
;
1953 struct stat filestats
;
1956 pos
= &file_stream
->pos
;
1958 ret
= fstat(pos
->fd
, &filestats
);
1962 /* Deal with empty files */
1963 if (!filestats
.st_size
) {
1964 if (file_stream
->parent
.trace_packet_header
1965 || file_stream
->parent
.stream_packet_context
) {
1967 * We expect a trace packet header and/or stream packet
1968 * context. Since a trace needs to have at least one
1969 * packet, empty files are therefore not accepted.
1971 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1975 * Without trace packet header nor stream packet
1976 * context, a one-packet trace can indeed be empty. This
1977 * is only valid if there is only one stream class: 0.
1979 ret
= stream_assign_class(td
, file_stream
, 0);
1986 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1987 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1996 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
2000 if (td
->packet_header_decl
) {
2001 struct bt_definition
*definition
=
2002 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2003 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2008 stream
->trace_packet_header
=
2009 container_of(definition
, struct definition_struct
, p
);
2010 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2016 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2021 int import_stream_packet_index(struct ctf_trace
*td
,
2022 struct ctf_file_stream
*file_stream
)
2024 struct ctf_stream_pos
*pos
;
2025 struct ctf_packet_index
*ctf_index
= NULL
;
2026 struct ctf_packet_index_file_hdr index_hdr
;
2027 struct packet_index index
;
2028 uint32_t packet_index_len
, index_minor
;
2030 int first_packet
= 1;
2033 pos
= &file_stream
->pos
;
2035 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2037 perror("read index file header");
2041 /* Check the index header */
2042 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2043 fprintf(stderr
, "[error] wrong index magic\n");
2047 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2048 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2049 ".%" PRIu32
", supported %d.%d\n",
2050 be32toh(index_hdr
.index_major
),
2051 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2056 index_minor
= be32toh(index_hdr
.index_minor
);
2058 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2059 if (packet_index_len
== 0) {
2060 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2065 * Allocate the index length found in header, not internal
2068 ctf_index
= g_malloc0(packet_index_len
);
2069 while (fread(ctf_index
, packet_index_len
, 1,
2070 pos
->index_fp
) == 1) {
2072 struct ctf_stream_declaration
*stream
= NULL
;
2074 memset(&index
, 0, sizeof(index
));
2075 index
.offset
= be64toh(ctf_index
->offset
);
2076 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2077 index
.content_size
= be64toh(ctf_index
->content_size
);
2078 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2079 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2080 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2081 index
.events_discarded_len
= 64;
2082 index
.data_offset
= -1;
2083 stream_id
= be64toh(ctf_index
->stream_id
);
2084 if (index_minor
>= 1) {
2085 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2086 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2089 if (!first_packet
) {
2090 /* add index to packet array */
2091 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2095 file_stream
->parent
.stream_id
= stream_id
;
2096 if (stream_id
< td
->streams
->len
) {
2097 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2100 fprintf(stderr
, "[error] Stream %" PRIu64
2101 " is not declared in metadata.\n",
2106 file_stream
->parent
.stream_class
= stream
;
2107 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2111 /* add index to packet array */
2112 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2115 /* Index containing only the header. */
2116 if (!file_stream
->parent
.stream_class
) {
2129 * Note: many file streams can inherit from the same stream class
2130 * description (metadata).
2133 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2134 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2137 int ret
, fd
, closeret
;
2138 struct ctf_file_stream
*file_stream
;
2139 struct stat statbuf
;
2142 fd
= openat(td
->dirfd
, path
, flags
);
2144 perror("File stream openat()");
2149 /* Don't try to mmap subdirectories. Skip them, return success. */
2150 ret
= fstat(fd
, &statbuf
);
2152 perror("File stream fstat()");
2155 if (S_ISDIR(statbuf
.st_mode
)) {
2156 if (strncmp(path
, "index", 5) != 0) {
2157 fprintf(stderr
, "[warning] Skipping directory '%s' "
2158 "found in trace\n", path
);
2163 if (!statbuf
.st_size
) {
2164 /** Skip empty files. */
2166 goto fd_is_empty_file
;
2169 file_stream
= g_new0(struct ctf_file_stream
, 1);
2170 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2171 file_stream
->pos
.fd
= -1;
2172 file_stream
->pos
.index_fp
= NULL
;
2174 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2175 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2178 file_stream
->pos
.packet_seek
= packet_seek
;
2180 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2185 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2188 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2192 * For now, only a single clock per trace is supported.
2194 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2197 * Allocate the index name for this stream and try to open it.
2199 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2201 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2205 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2208 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2209 ret
= create_stream_packet_index(td
, file_stream
);
2211 fprintf(stderr
, "[error] Stream index creation error.\n");
2215 ret
= openat(td
->dirfd
, index_name
, flags
);
2217 perror("Index file openat()");
2221 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2222 if (!file_stream
->pos
.index_fp
) {
2223 perror("fdopen() error");
2226 ret
= import_stream_packet_index(td
, file_stream
);
2231 ret
= fclose(file_stream
->pos
.index_fp
);
2233 perror("close index");
2239 /* Add stream file to stream class */
2240 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2241 &file_stream
->parent
);
2245 if (file_stream
->pos
.index_fp
) {
2246 ret
= fclose(file_stream
->pos
.index_fp
);
2248 perror("close index");
2251 if (file_stream
->parent
.trace_packet_header
)
2252 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2256 closeret
= ctf_fini_pos(&file_stream
->pos
);
2258 fprintf(stderr
, "Error on ctf_fini_pos\n");
2260 g_free(file_stream
);
2264 closeret
= close(fd
);
2266 perror("Error on fd close");
2273 int ctf_open_trace_read(struct ctf_trace
*td
,
2274 const char *path
, int flags
,
2275 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2276 int whence
), FILE *metadata_fp
)
2278 struct ctf_scanner
*scanner
;
2280 struct dirent
*dirent
;
2281 struct dirent
*diriter
;
2287 /* Open trace directory */
2288 td
->dir
= opendir(path
);
2290 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2295 td
->dirfd
= open(path
, 0);
2296 if (td
->dirfd
< 0) {
2297 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2298 perror("Trace directory open");
2302 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2303 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2306 * Keep the metadata file separate.
2307 * Keep scanner object local to the open. We don't support
2308 * incremental metadata append for on-disk traces.
2310 scanner
= ctf_scanner_alloc();
2312 fprintf(stderr
, "[error] Error allocating scanner\n");
2314 goto error_metadata
;
2316 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2317 ctf_scanner_free(scanner
);
2319 if (ret
== -ENOENT
) {
2320 fprintf(stderr
, "[warning] Empty metadata.\n");
2322 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2323 goto error_metadata
;
2327 * Open each stream: for each file, try to open, check magic
2328 * number, and get the stream ID to add to the right location in
2332 dirent_len
= offsetof(struct dirent
, d_name
) +
2333 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2335 dirent
= malloc(dirent_len
);
2338 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2340 fprintf(stderr
, "[error] Readdir error.\n");
2345 /* Ignore hidden files, ., .. and metadata. */
2346 if (!strncmp(diriter
->d_name
, ".", 1)
2347 || !strcmp(diriter
->d_name
, "..")
2348 || !strcmp(diriter
->d_name
, "metadata"))
2351 /* Ignore index files : *.idx */
2352 ext
= strrchr(diriter
->d_name
, '.');
2353 if (ext
&& (!strcmp(ext
, ".idx"))) {
2357 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2358 flags
, packet_seek
);
2360 fprintf(stderr
, "[error] Open file stream error.\n");
2371 closeret
= close(td
->dirfd
);
2373 perror("Error on fd close");
2376 closeret
= closedir(td
->dir
);
2378 perror("Error on closedir");
2385 * ctf_open_trace: Open a CTF trace and index it.
2386 * Note that the user must seek the trace after the open (using the iterator)
2387 * since the index creation read it entirely.
2390 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2391 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2392 int whence
), FILE *metadata_fp
)
2394 struct ctf_trace
*td
;
2398 * If packet_seek is NULL, we provide our default version.
2401 packet_seek
= ctf_packet_seek
;
2403 td
= g_new0(struct ctf_trace
, 1);
2407 init_trace_descriptor(&td
->parent
);
2409 switch (flags
& O_ACCMODE
) {
2412 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2415 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2420 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2423 fprintf(stderr
, "[error] Incorrect open flags.\n");
2427 ret
= trace_debug_info_create(td
);
2434 trace_debug_info_destroy(td
);
2440 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2441 struct bt_mmap_stream
*mmap_info
)
2443 pos
->mmap_offset
= 0;
2444 pos
->packet_size
= 0;
2445 pos
->content_size
= 0;
2446 pos
->content_size_loc
= NULL
;
2447 pos
->fd
= mmap_info
->fd
;
2448 pos
->base_mma
= NULL
;
2452 pos
->prot
= PROT_READ
;
2453 pos
->flags
= MAP_PRIVATE
;
2454 pos
->parent
.rw_table
= read_dispatch_table
;
2455 pos
->parent
.event_cb
= ctf_read_event
;
2456 pos
->priv
= mmap_info
->priv
;
2457 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2458 sizeof(struct packet_index
));
2462 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2463 struct ctf_file_stream
*file_stream
,
2464 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2467 struct ctf_stream_declaration
*stream
;
2471 /* Ask for the first packet to get the stream_id. */
2472 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2473 stream_id
= file_stream
->parent
.stream_id
;
2474 if (stream_id
>= td
->streams
->len
) {
2475 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2476 "in metadata.\n", stream_id
);
2480 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2482 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2483 "in metadata.\n", stream_id
);
2487 file_stream
->parent
.stream_class
= stream
;
2488 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2494 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2495 struct bt_mmap_stream
*mmap_info
,
2496 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2500 struct ctf_file_stream
*file_stream
;
2502 file_stream
= g_new0(struct ctf_file_stream
, 1);
2503 file_stream
->parent
.stream_id
= -1ULL;
2504 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2505 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2507 file_stream
->pos
.packet_seek
= packet_seek
;
2509 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2514 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2519 * For now, only a single clock per trace is supported.
2521 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2523 /* Add stream file to stream class */
2524 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2525 &file_stream
->parent
);
2529 if (file_stream
->parent
.trace_packet_header
)
2530 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2532 g_free(file_stream
);
2537 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2538 struct bt_mmap_stream_list
*mmap_list
,
2539 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2544 struct bt_mmap_stream
*mmap_info
;
2546 td
->scanner
= ctf_scanner_alloc();
2548 fprintf(stderr
, "[error] Error allocating scanner\n");
2552 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2554 if (ret
== -ENOENT
) {
2555 fprintf(stderr
, "[warning] Empty metadata.\n");
2561 * for each stream, try to open, check magic number, and get the
2562 * stream ID to add to the right location in the stream array.
2564 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2565 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2567 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2574 ctf_scanner_free(td
->scanner
);
2579 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2580 struct bt_mmap_stream_list
*mmap_list
,
2581 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2585 struct ctf_trace
*td
;
2589 fprintf(stderr
, "[error] No metadata file pointer associated, "
2590 "required for mmap parsing\n");
2594 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2597 td
= g_new0(struct ctf_trace
, 1);
2599 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2603 ret
= trace_debug_info_create(td
);
2616 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2619 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2625 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2628 /* for each stream_class */
2629 for (i
= 0; i
< td
->streams
->len
; i
++) {
2630 struct ctf_stream_declaration
*stream_class
;
2632 stream_class
= g_ptr_array_index(td
->streams
, i
);
2635 /* for each stream */
2636 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2637 struct ctf_stream_definition
*stream
;
2639 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2642 ret
= copy_event_declarations_stream_class_to_stream(td
,
2643 stream_class
, stream
);
2652 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2655 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2657 /* for each stream_class */
2658 for (i
= 0; i
< td
->streams
->len
; i
++) {
2659 struct ctf_stream_declaration
*stream_class
;
2661 stream_class
= g_ptr_array_index(td
->streams
, i
);
2664 /* for each file_stream */
2665 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2666 struct ctf_stream_definition
*stream
;
2667 struct ctf_stream_pos
*stream_pos
;
2668 struct ctf_file_stream
*cfs
;
2670 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2673 cfs
= container_of(stream
, struct ctf_file_stream
,
2675 stream_pos
= &cfs
->pos
;
2676 if (!stream_pos
->packet_index
)
2679 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2680 struct packet_index
*index
;
2682 index
= &g_array_index(stream_pos
->packet_index
,
2683 struct packet_index
, k
);
2684 index
->ts_real
.timestamp_begin
=
2685 ctf_get_real_timestamp(stream
,
2686 index
->ts_cycles
.timestamp_begin
);
2687 index
->ts_real
.timestamp_end
=
2688 ctf_get_real_timestamp(stream
,
2689 index
->ts_cycles
.timestamp_end
);
2697 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2701 ret
= ctf_fini_pos(&file_stream
->pos
);
2703 fprintf(stderr
, "Error on ctf_fini_pos\n");
2706 if (file_stream
->pos
.fd
>= 0) {
2707 ret
= close(file_stream
->pos
.fd
);
2709 perror("Error closing file fd");
2717 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2719 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2725 for (i
= 0; i
< td
->streams
->len
; i
++) {
2726 struct ctf_stream_declaration
*stream
;
2729 stream
= g_ptr_array_index(td
->streams
, i
);
2732 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2733 struct ctf_file_stream
*file_stream
;
2734 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2735 struct ctf_file_stream
, parent
);
2736 ret
= ctf_close_file_stream(file_stream
);
2742 ctf_destroy_metadata(td
);
2743 ctf_scanner_free(td
->scanner
);
2744 if (td
->dirfd
>= 0) {
2745 ret
= close(td
->dirfd
);
2747 perror("Error closing dirfd");
2752 ret
= closedir(td
->dir
);
2754 perror("Error closedir");
2758 free(td
->metadata_string
);
2759 trace_debug_info_destroy(td
);
2765 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2766 struct bt_context
*ctx
)
2768 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2771 td
->parent
.ctx
= ctx
;
2775 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2776 struct bt_trace_handle
*handle
)
2778 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2781 td
->parent
.handle
= handle
;
2785 void __attribute__((constructor
)) ctf_init(void)
2789 ctf_format
.name
= g_quark_from_static_string("ctf");
2790 ret
= bt_register_format(&ctf_format
);
2795 void __attribute__((destructor
)) ctf_exit(void)
2797 bt_unregister_format(&ctf_format
);