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
,
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.
429 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
)
431 if ((!stream
->events_discarded
&& !stream
->packets_lost
) ||
432 !babeltrace_ctf_console_output
) {
436 if (stream
->events_discarded
) {
437 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events between [",
438 stream
->events_discarded
);
439 } else if (stream
->packets_lost
) {
440 fprintf(fp
, "[warning] Tracer lost %" PRIu64
" trace packets between [",
441 stream
->packets_lost
);
443 if (opt_clock_cycles
) {
444 ctf_print_timestamp(fp
, stream
,
445 stream
->prev
.cycles
.end
);
446 fprintf(fp
, "] and [");
447 ctf_print_timestamp(fp
, stream
,
448 stream
->current
.cycles
.end
);
450 ctf_print_timestamp(fp
, stream
,
451 stream
->prev
.real
.end
);
452 fprintf(fp
, "] and [");
453 ctf_print_timestamp(fp
, stream
,
454 stream
->current
.real
.end
);
456 fprintf(fp
, "] in trace UUID ");
457 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
458 if (stream
->stream_class
->trace
->parent
.path
[0])
459 fprintf(fp
, ", at path: \"%s\"",
460 stream
->stream_class
->trace
->parent
.path
);
462 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
464 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
466 fprintf(fp
, "You should consider recording a new trace with larger "
467 "buffers or with fewer events enabled.\n");
472 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
474 struct ctf_stream_pos
*pos
=
475 container_of(ppos
, struct ctf_stream_pos
, parent
);
476 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
477 struct ctf_event_definition
*event
;
481 /* We need to check for EOF here for empty files. */
482 if (unlikely(pos
->offset
== EOF
))
485 ctf_pos_get_event(pos
);
487 /* save the current position as a restore point */
488 pos
->last_offset
= pos
->offset
;
491 * This is the EOF check after we've advanced the position in
494 if (unlikely(pos
->offset
== EOF
))
497 /* Stream is inactive for now (live reading). */
498 if (unlikely(pos
->content_size
== 0))
502 * Packet seeked to by ctf_pos_get_event() only contains
503 * headers, no event. Consider stream as inactive (live
506 if (unlikely(pos
->data_offset
== pos
->content_size
))
509 assert(pos
->offset
< pos
->content_size
);
511 /* Read event header */
512 if (likely(stream
->stream_event_header
)) {
513 struct definition_integer
*integer_definition
;
514 struct bt_definition
*variant
;
516 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
519 /* lookup event id */
520 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
521 if (integer_definition
) {
522 id
= integer_definition
->value
._unsigned
;
524 struct definition_enum
*enum_definition
;
526 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
527 if (enum_definition
) {
528 id
= enum_definition
->integer
->value
._unsigned
;
532 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
534 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
535 if (integer_definition
) {
536 id
= integer_definition
->value
._unsigned
;
539 stream
->event_id
= id
;
541 /* lookup timestamp */
542 stream
->has_timestamp
= 0;
543 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
544 if (integer_definition
) {
545 ctf_update_timestamp(stream
, integer_definition
);
546 stream
->has_timestamp
= 1;
549 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
550 if (integer_definition
) {
551 ctf_update_timestamp(stream
, integer_definition
);
552 stream
->has_timestamp
= 1;
558 /* Read stream-declared event context */
559 if (stream
->stream_event_context
) {
560 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
565 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
566 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
569 event
= g_ptr_array_index(stream
->events_by_id
, id
);
570 if (unlikely(!event
)) {
571 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
575 /* Read event-declared event context */
576 if (event
->event_context
) {
577 ret
= generic_rw(ppos
, &event
->event_context
->p
);
582 /* Read event payload */
583 if (likely(event
->event_fields
)) {
584 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
589 if (pos
->last_offset
== pos
->offset
) {
590 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
597 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
602 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
604 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
605 struct ctf_event_definition
*event
;
609 id
= stream
->event_id
;
611 /* print event header */
612 if (likely(stream
->stream_event_header
)) {
613 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
618 /* print stream-declared event context */
619 if (stream
->stream_event_context
) {
620 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
625 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
626 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
629 event
= g_ptr_array_index(stream
->events_by_id
, id
);
630 if (unlikely(!event
)) {
631 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
635 /* print event-declared event context */
636 if (event
->event_context
) {
637 ret
= generic_rw(pos
, &event
->event_context
->p
);
642 /* Read and print event payload */
643 if (likely(event
->event_fields
)) {
644 ret
= generic_rw(pos
, &event
->event_fields
->p
);
652 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
657 * One side-effect of this function is to unmap pos mmap base if one is
661 int find_data_offset(struct ctf_stream_pos
*pos
,
662 struct ctf_file_stream
*file_stream
,
663 struct packet_index
*packet_index
)
665 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
666 struct stat filestats
;
670 pos
= &file_stream
->pos
;
672 ret
= fstat(pos
->fd
, &filestats
);
675 filesize
= filestats
.st_size
;
677 /* Deal with empty files */
683 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
684 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
689 ret
= munmap_align(pos
->base_mma
);
691 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
695 pos
->base_mma
= NULL
;
697 /* map new base. Need mapping length from header. */
698 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
699 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
700 assert(pos
->base_mma
!= MAP_FAILED
);
702 pos
->content_size
= packet_map_len
;
703 pos
->packet_size
= packet_map_len
;
704 pos
->offset
= 0; /* Position of the packet header */
706 /* update trace_packet_header and stream_packet_context */
707 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
708 /* Read packet header */
709 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
715 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
716 /* Read packet context */
717 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
723 packet_index
->data_offset
= pos
->offset
;
726 ret
= munmap_align(pos
->base_mma
);
728 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
732 pos
->base_mma
= NULL
;
736 /* Retry with larger mapping */
738 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
740 * Reached EOF, but still expecting header/context data.
742 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
745 /* Double the mapping len, and retry */
746 tmp_map_len
= packet_map_len
<< 1;
747 if (tmp_map_len
>> 1 != packet_map_len
) {
749 fprintf(stderr
, "[error] Packet mapping length overflow\n");
752 packet_map_len
= tmp_map_len
;
757 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
758 int fd
, int open_flags
)
762 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
763 sizeof(struct packet_index
));
765 pos
->packet_index
= NULL
;
767 switch (open_flags
& O_ACCMODE
) {
769 pos
->prot
= PROT_READ
;
770 pos
->flags
= MAP_PRIVATE
;
771 pos
->parent
.rw_table
= read_dispatch_table
;
772 pos
->parent
.event_cb
= ctf_read_event
;
773 pos
->parent
.trace
= trace
;
776 pos
->prot
= PROT_READ
| PROT_WRITE
;
777 pos
->flags
= MAP_SHARED
;
778 pos
->parent
.rw_table
= write_dispatch_table
;
779 pos
->parent
.event_cb
= ctf_write_event
;
780 pos
->parent
.trace
= trace
;
782 ctf_packet_seek(&pos
->parent
, 0, SEEK_SET
); /* position for write */
790 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
792 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
793 *pos
->content_size_loc
= pos
->offset
;
798 ret
= munmap_align(pos
->base_mma
);
800 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
805 if (pos
->packet_index
)
806 (void) g_array_free(pos
->packet_index
, TRUE
);
810 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
811 struct packet_index
*prev_index
,
812 struct packet_index
*cur_index
)
814 uint64_t events_discarded_diff
;
815 uint64_t packets_lost_diff
= 0;
817 /* Update packet index time information */
819 /* Current packet begin/end */
820 stream
->current
.real
.begin
=
821 cur_index
->ts_real
.timestamp_begin
;
822 stream
->current
.cycles
.begin
=
823 cur_index
->ts_cycles
.timestamp_begin
;
824 stream
->current
.real
.end
=
825 cur_index
->ts_real
.timestamp_end
;
826 stream
->current
.cycles
.end
=
827 cur_index
->ts_cycles
.timestamp_end
;
829 /* Update packet index discarded event information */
830 events_discarded_diff
= cur_index
->events_discarded
;
832 /* Previous packet begin/end */
833 stream
->prev
.cycles
.begin
=
834 prev_index
->ts_cycles
.timestamp_begin
;
835 stream
->prev
.real
.begin
=
836 prev_index
->ts_real
.timestamp_begin
;
837 stream
->prev
.cycles
.end
=
838 prev_index
->ts_cycles
.timestamp_end
;
839 stream
->prev
.real
.end
=
840 prev_index
->ts_real
.timestamp_end
;
842 events_discarded_diff
-= prev_index
->events_discarded
;
843 /* packet_seq_num stays at 0 if not produced by the tracer */
844 if (cur_index
->packet_seq_num
) {
845 packets_lost_diff
= cur_index
->packet_seq_num
-
846 prev_index
->packet_seq_num
- 1;
849 * Deal with 32-bit wrap-around if the tracer provided a
852 if (prev_index
->events_discarded_len
== 32) {
853 events_discarded_diff
= (uint32_t) events_discarded_diff
;
857 * First packet: use current packet info as limits for
860 stream
->prev
.cycles
.begin
=
861 stream
->prev
.cycles
.end
=
862 stream
->current
.cycles
.begin
;
863 stream
->prev
.real
.begin
=
864 stream
->prev
.real
.end
=
865 stream
->current
.real
.begin
;
867 stream
->events_discarded
= events_discarded_diff
;
868 stream
->packets_lost
= packets_lost_diff
;
872 * Find the timerange where all the streams in the trace are active
875 * Return 0 and update begin/end if necessary on success, return 1 for
876 * empty streams and return a negative value on error.
879 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
880 struct packet_index_time
*_real
,
881 struct packet_index_time
*_cycles
)
883 int stream_id
, ret
= 0;
884 struct packet_index_time real
= { 0, UINT64_MAX
},
885 cycles
= { 0, UINT64_MAX
};
886 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
888 /* At least one of the two return args must be provided. */
889 if (!_real
&& !_cycles
) {
894 if (tin
->streams
->len
== 0) {
899 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
902 struct ctf_stream_declaration
*stream_class
;
904 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
908 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
909 struct ctf_file_stream
*file_stream
;
910 struct ctf_stream_pos
*stream_pos
;
911 struct packet_index
*index
;
913 file_stream
= g_ptr_array_index(stream_class
->streams
,
918 stream_pos
= &file_stream
->pos
;
919 if (!stream_pos
->packet_index
||
920 stream_pos
->packet_index
->len
<= 0) {
924 index
= &g_array_index(stream_pos
->packet_index
,
925 struct packet_index
, 0);
926 real
.timestamp_begin
= max(real
.timestamp_begin
,
927 index
->ts_real
.timestamp_begin
);
928 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
929 index
->ts_cycles
.timestamp_begin
);
931 index
= &g_array_index(stream_pos
->packet_index
,
933 stream_pos
->packet_index
->len
- 1);
934 real
.timestamp_end
= min(real
.timestamp_end
,
935 index
->ts_real
.timestamp_end
);
936 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
937 index
->ts_cycles
.timestamp_end
);
953 * Find the union of all active regions in the trace collection's traces.
954 * Returns "real" timestamps.
956 * Return 0 on success.
957 * Return 1 if no intersections are found.
958 * Return a negative value on error.
960 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
961 uint64_t *_ts_begin
, uint64_t *_ts_end
)
964 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
966 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
971 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
972 struct bt_trace_descriptor
*td_read
;
973 struct packet_index_time intersection_real
;
975 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
979 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
982 /* Empty trace or no stream intersection. */
984 } else if (ret
< 0) {
988 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
989 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
992 if (ts_end
< ts_begin
) {
996 *_ts_begin
= ts_begin
;
1002 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1006 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1011 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1012 struct bt_trace_descriptor
*td_read
;
1013 struct packet_index_time intersection_real
;
1015 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1020 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1023 /* Empty trace or no stream intersection. */
1025 } else if (ret
< 0) {
1029 td_read
->interval_real
= intersection_real
;
1030 td_read
->interval_set
= true;
1037 * for SEEK_CUR: go to next packet.
1038 * for SEEK_SET: go to packet numer (index).
1040 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1042 struct ctf_stream_pos
*pos
=
1043 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1044 struct ctf_file_stream
*file_stream
=
1045 container_of(pos
, struct ctf_file_stream
, pos
);
1047 struct packet_index
*packet_index
, *prev_index
;
1051 case SEEK_SET
: /* Fall-through */
1057 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1058 *pos
->content_size_loc
= pos
->offset
;
1060 if (pos
->base_mma
) {
1061 /* unmap old base */
1062 ret
= munmap_align(pos
->base_mma
);
1064 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1068 pos
->base_mma
= NULL
;
1072 * The caller should never ask for ctf_move_pos across packets,
1073 * except to get exactly at the beginning of the next packet.
1075 if (pos
->prot
& PROT_WRITE
) {
1078 /* The writer will add padding */
1079 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1082 assert(index
== 0); /* only seek supported for now */
1088 pos
->content_size
= -1U; /* Unknown at this point */
1089 pos
->packet_size
= WRITE_PACKET_LEN
;
1091 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1092 pos
->packet_size
/ CHAR_BIT
);
1093 } while (ret
== EINTR
);
1101 if (pos
->offset
== EOF
) {
1104 assert(pos
->cur_index
< pos
->packet_index
->len
);
1105 /* The reader will expect us to skip padding */
1110 if (index
>= pos
->packet_index
->len
) {
1114 pos
->cur_index
= index
;
1120 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1125 packet_index
= &g_array_index(pos
->packet_index
,
1126 struct packet_index
, pos
->cur_index
);
1127 if (pos
->cur_index
> 0) {
1128 prev_index
= &g_array_index(pos
->packet_index
,
1129 struct packet_index
,
1130 pos
->cur_index
- 1);
1134 ctf_update_current_packet_index(&file_stream
->parent
,
1135 prev_index
, packet_index
);
1138 * We need to check if we are in trace read or called
1139 * from packet indexing. In this last case, the
1140 * collection is not there, so we cannot print the
1143 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1144 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1147 packet_index
= &g_array_index(pos
->packet_index
,
1148 struct packet_index
,
1150 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1152 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1154 /* Lookup context/packet size in index */
1155 if (packet_index
->data_offset
== -1) {
1156 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1161 pos
->content_size
= packet_index
->content_size
;
1162 pos
->packet_size
= packet_index
->packet_size
;
1163 pos
->mmap_offset
= packet_index
->offset
;
1164 pos
->data_offset
= packet_index
->data_offset
;
1165 if (pos
->data_offset
< packet_index
->content_size
) {
1166 pos
->offset
= 0; /* will read headers */
1167 } else if (pos
->data_offset
== packet_index
->content_size
) {
1169 pos
->offset
= packet_index
->data_offset
;
1171 goto read_next_packet
;
1177 /* map new base. Need mapping length from header. */
1178 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1179 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1180 if (pos
->base_mma
== MAP_FAILED
) {
1181 fprintf(stderr
, "[error] mmap error %s.\n",
1186 /* update trace_packet_header and stream_packet_context */
1187 if (!(pos
->prot
& PROT_WRITE
) &&
1188 file_stream
->parent
.trace_packet_header
) {
1189 /* Read packet header */
1190 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1193 if (!(pos
->prot
& PROT_WRITE
) &&
1194 file_stream
->parent
.stream_packet_context
) {
1195 /* Read packet context */
1196 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1202 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1208 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1212 if (magic
== TSDL_MAGIC
) {
1214 td
->byte_order
= BYTE_ORDER
;
1215 CTF_TRACE_SET_FIELD(td
, byte_order
);
1216 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1218 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1219 LITTLE_ENDIAN
: BIG_ENDIAN
;
1220 CTF_TRACE_SET_FIELD(td
, byte_order
);
1228 * Returns 0 on success, -1 on error.
1231 int check_version(unsigned int major
, unsigned int minor
)
1246 /* eventually return an error instead of warning */
1248 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1254 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1257 struct metadata_packet_header header
;
1258 size_t readlen
, writelen
, toread
;
1259 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1262 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1266 if (td
->byte_order
!= BYTE_ORDER
) {
1267 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1268 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1269 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1270 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1272 if (header
.checksum
)
1273 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1274 if (header
.compression_scheme
) {
1275 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1276 header
.compression_scheme
);
1279 if (header
.encryption_scheme
) {
1280 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1281 header
.encryption_scheme
);
1284 if (header
.checksum_scheme
) {
1285 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1286 header
.checksum_scheme
);
1289 if (check_version(header
.major
, header
.minor
) < 0)
1291 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1292 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1293 CTF_TRACE_SET_FIELD(td
, uuid
);
1295 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1299 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1302 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1305 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1310 if (babeltrace_debug
) {
1311 buf
[readlen
] = '\0';
1312 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1316 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1317 if (writelen
< readlen
) {
1327 ret
= 0; /* continue reading next packet */
1334 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1335 ret
= fseek(in
, toread
, SEEK_CUR
);
1337 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1344 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1348 size_t size
, buflen
;
1353 * Using strlen on *buf instead of size of open_memstream
1354 * because its size includes garbage at the end (after final
1355 * \0). This is the allocated size, not the actual string size.
1357 out
= babeltrace_open_memstream(buf
, &size
);
1359 perror("Metadata open_memstream");
1363 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1372 /* close to flush the buffer */
1373 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1377 perror("babeltrace_flush_memstream");
1379 closeret
= fclose(in
);
1381 perror("Error in fclose");
1387 perror("Error in fclose");
1389 /* open for reading */
1390 buflen
= strlen(*buf
);
1395 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1397 perror("Metadata fmemopen");
1404 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1405 struct ctf_scanner
*scanner
, int append
)
1407 struct ctf_file_stream
*metadata_stream
;
1410 int ret
= 0, closeret
;
1412 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1413 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1417 metadata_stream
->pos
.fd
= -1;
1419 td
->metadata
= &metadata_stream
->parent
;
1420 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1421 if (metadata_stream
->pos
.fd
< 0) {
1422 fprintf(stderr
, "Unable to open metadata.\n");
1427 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1429 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1430 perror("Metadata stream open");
1434 /* fd now belongs to fp */
1435 metadata_stream
->pos
.fd
= -1;
1437 if (babeltrace_debug
)
1440 if (packet_metadata(td
, fp
)) {
1441 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1445 td
->metadata_string
= buf
;
1446 td
->metadata_packetized
= 1;
1449 unsigned int major
, minor
;
1452 td
->byte_order
= BYTE_ORDER
;
1454 /* Check text-only metadata header and version */
1455 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1457 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1458 if (check_version(major
, minor
) < 0) {
1466 ret
= ctf_scanner_append_ast(scanner
, fp
);
1468 fprintf(stderr
, "[error] Error creating AST\n");
1472 if (babeltrace_debug
) {
1473 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1475 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1480 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1482 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1485 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1486 td
, td
->byte_order
);
1488 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1493 closeret
= fclose(fp
);
1495 perror("Error on fclose");
1499 if (metadata_stream
->pos
.fd
>= 0) {
1500 closeret
= close(metadata_stream
->pos
.fd
);
1502 perror("Error on metadata stream fd close");
1507 g_free(metadata_stream
);
1512 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1513 struct ctf_stream_definition
*stream
,
1514 struct ctf_event_declaration
*event
)
1516 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1518 if (event
->context_decl
) {
1519 struct bt_definition
*definition
=
1520 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1521 stream
->parent_def_scope
, 0, 0, "event.context");
1525 stream_event
->event_context
= container_of(definition
,
1526 struct definition_struct
, p
);
1527 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1529 if (event
->fields_decl
) {
1530 struct bt_definition
*definition
=
1531 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1532 stream
->parent_def_scope
, 0, 0, "event.fields");
1536 stream_event
->event_fields
= container_of(definition
,
1537 struct definition_struct
, p
);
1538 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1540 stream_event
->stream
= stream
;
1541 return stream_event
;
1544 if (stream_event
->event_fields
)
1545 bt_definition_unref(&stream_event
->event_fields
->p
);
1546 if (stream_event
->event_context
)
1547 bt_definition_unref(&stream_event
->event_context
->p
);
1548 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1549 g_quark_to_string(event
->name
));
1554 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1555 struct ctf_stream_declaration
*stream_class
,
1556 struct ctf_stream_definition
*stream
)
1558 size_t def_size
, class_size
, i
;
1561 def_size
= stream
->events_by_id
->len
;
1562 class_size
= stream_class
->events_by_id
->len
;
1564 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1565 for (i
= def_size
; i
< class_size
; i
++) {
1566 struct ctf_event_declaration
*event
=
1567 g_ptr_array_index(stream_class
->events_by_id
, i
);
1568 struct ctf_event_definition
*stream_event
;
1572 stream_event
= create_event_definitions(td
, stream
, event
);
1573 if (!stream_event
) {
1577 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1584 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1586 struct ctf_stream_declaration
*stream_class
;
1590 if (stream
->stream_definitions_created
)
1593 stream_class
= stream
->stream_class
;
1595 if (stream_class
->packet_context_decl
) {
1596 struct bt_definition
*definition
=
1597 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1598 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1603 stream
->stream_packet_context
= container_of(definition
,
1604 struct definition_struct
, p
);
1605 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1607 if (stream_class
->event_header_decl
) {
1608 struct bt_definition
*definition
=
1609 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1610 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1615 stream
->stream_event_header
=
1616 container_of(definition
, struct definition_struct
, p
);
1617 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1619 if (stream_class
->event_context_decl
) {
1620 struct bt_definition
*definition
=
1621 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1622 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1627 stream
->stream_event_context
=
1628 container_of(definition
, struct definition_struct
, p
);
1629 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1631 stream
->events_by_id
= g_ptr_array_new();
1632 ret
= copy_event_declarations_stream_class_to_stream(td
,
1633 stream_class
, stream
);
1639 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1640 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1642 g_free(stream_event
);
1644 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1646 if (stream
->stream_event_context
)
1647 bt_definition_unref(&stream
->stream_event_context
->p
);
1648 if (stream
->stream_event_header
)
1649 bt_definition_unref(&stream
->stream_event_header
->p
);
1650 if (stream
->stream_packet_context
)
1651 bt_definition_unref(&stream
->stream_packet_context
->p
);
1652 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1653 stream_class
->stream_id
, strerror(-ret
));
1658 int stream_assign_class(struct ctf_trace
*td
,
1659 struct ctf_file_stream
*file_stream
,
1662 struct ctf_stream_declaration
*stream
;
1665 file_stream
->parent
.stream_id
= stream_id
;
1666 if (stream_id
>= td
->streams
->len
) {
1667 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1670 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1672 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1675 file_stream
->parent
.stream_class
= stream
;
1676 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1683 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1684 struct ctf_trace
*td
,
1685 struct ctf_file_stream
*file_stream
,
1688 struct packet_index packet_index
;
1689 uint64_t stream_id
= 0;
1690 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1691 int first_packet
= 0;
1696 memset(&packet_index
, 0, sizeof(packet_index
));
1697 if (!pos
->mmap_offset
) {
1701 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1702 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1705 if (pos
->base_mma
) {
1706 /* unmap old base */
1707 ret
= munmap_align(pos
->base_mma
);
1709 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1713 pos
->base_mma
= NULL
;
1715 /* map new base. Need mapping length from header. */
1716 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1717 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1718 assert(pos
->base_mma
!= MAP_FAILED
);
1720 * Use current mapping size as temporary content and packet
1723 pos
->content_size
= packet_map_len
;
1724 pos
->packet_size
= packet_map_len
;
1725 pos
->offset
= 0; /* Position of the packet header */
1727 packet_index
.offset
= pos
->mmap_offset
;
1729 /* read and check header, set stream id (and check) */
1730 if (file_stream
->parent
.trace_packet_header
) {
1731 /* Read packet header */
1732 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1736 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1739 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1740 if (len_index
>= 0) {
1741 struct bt_definition
*field
;
1744 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1745 magic
= bt_get_unsigned_int(field
);
1746 if (magic
!= CTF_MAGIC
) {
1747 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1749 file_stream
->pos
.packet_index
->len
,
1750 (ssize_t
) pos
->mmap_offset
);
1756 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1757 if (len_index
>= 0) {
1758 struct definition_array
*defarray
;
1759 struct bt_definition
*field
;
1761 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1763 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1764 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1765 defarray
= container_of(field
, struct definition_array
, p
);
1766 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1768 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1769 struct bt_definition
*elem
;
1771 elem
= bt_array_index(defarray
, i
);
1772 uuidval
[i
] = bt_get_unsigned_int(elem
);
1774 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1776 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1781 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1782 if (len_index
>= 0) {
1783 struct bt_definition
*field
;
1785 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1786 stream_id
= bt_get_unsigned_int(field
);
1790 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1791 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1793 file_stream
->parent
.stream_id
);
1797 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1802 if (file_stream
->parent
.stream_packet_context
) {
1803 /* Read packet context */
1804 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1808 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1811 /* read packet size from header */
1812 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1813 if (len_index
>= 0) {
1814 struct bt_definition
*field
;
1816 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1817 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1819 /* Use file size for packet size */
1820 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1823 /* read content size from header */
1824 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1825 if (len_index
>= 0) {
1826 struct bt_definition
*field
;
1828 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1829 packet_index
.content_size
= bt_get_unsigned_int(field
);
1831 /* Use packet size if non-zero, else file size */
1832 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1835 /* read timestamp begin from header */
1836 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1837 if (len_index
>= 0) {
1838 struct bt_definition
*field
;
1840 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1841 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1842 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1843 packet_index
.ts_real
.timestamp_begin
=
1844 ctf_get_real_timestamp(
1845 &file_stream
->parent
,
1846 packet_index
.ts_cycles
.timestamp_begin
);
1850 /* read timestamp end from header */
1851 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1852 if (len_index
>= 0) {
1853 struct bt_definition
*field
;
1855 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1856 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1857 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1858 packet_index
.ts_real
.timestamp_end
=
1859 ctf_get_real_timestamp(
1860 &file_stream
->parent
,
1861 packet_index
.ts_cycles
.timestamp_end
);
1865 /* read events discarded from header */
1866 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1867 if (len_index
>= 0) {
1868 struct bt_definition
*field
;
1870 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1871 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1872 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1875 /* read packet_seq_num from header */
1876 len_index
= bt_struct_declaration_lookup_field_index(
1877 file_stream
->parent
.stream_packet_context
->declaration
,
1878 g_quark_from_static_string("packet_seq_num"));
1879 if (len_index
>= 0) {
1880 struct bt_definition
*field
;
1882 field
= bt_struct_definition_get_field_from_index(
1883 file_stream
->parent
.stream_packet_context
,
1885 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1888 /* Use file size for packet size */
1889 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1890 /* Use packet size if non-zero, else file size */
1891 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1894 /* Validate content size and packet size values */
1895 if (packet_index
.content_size
> packet_index
.packet_size
) {
1896 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1897 packet_index
.content_size
, packet_index
.packet_size
);
1901 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1902 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1903 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1907 if (packet_index
.content_size
< pos
->offset
) {
1908 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1912 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1913 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1917 /* Save position after header and context */
1918 packet_index
.data_offset
= pos
->offset
;
1920 /* add index to packet array */
1921 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1923 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1927 /* Retry with larger mapping */
1929 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1931 * Reached EOF, but still expecting header/context data.
1933 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1936 /* Double the mapping len, and retry */
1937 tmp_map_len
= packet_map_len
<< 1;
1938 if (tmp_map_len
>> 1 != packet_map_len
) {
1940 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1943 packet_map_len
= tmp_map_len
;
1948 int create_stream_packet_index(struct ctf_trace
*td
,
1949 struct ctf_file_stream
*file_stream
)
1951 struct ctf_stream_pos
*pos
;
1952 struct stat filestats
;
1955 pos
= &file_stream
->pos
;
1957 ret
= fstat(pos
->fd
, &filestats
);
1961 /* Deal with empty files */
1962 if (!filestats
.st_size
) {
1963 if (file_stream
->parent
.trace_packet_header
1964 || file_stream
->parent
.stream_packet_context
) {
1966 * We expect a trace packet header and/or stream packet
1967 * context. Since a trace needs to have at least one
1968 * packet, empty files are therefore not accepted.
1970 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1974 * Without trace packet header nor stream packet
1975 * context, a one-packet trace can indeed be empty. This
1976 * is only valid if there is only one stream class: 0.
1978 ret
= stream_assign_class(td
, file_stream
, 0);
1985 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1986 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1995 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1999 if (td
->packet_header_decl
) {
2000 struct bt_definition
*definition
=
2001 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2002 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2007 stream
->trace_packet_header
=
2008 container_of(definition
, struct definition_struct
, p
);
2009 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2015 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2020 int import_stream_packet_index(struct ctf_trace
*td
,
2021 struct ctf_file_stream
*file_stream
)
2023 struct ctf_stream_pos
*pos
;
2024 struct ctf_packet_index
*ctf_index
= NULL
;
2025 struct ctf_packet_index_file_hdr index_hdr
;
2026 struct packet_index index
;
2027 uint32_t packet_index_len
, index_minor
;
2029 int first_packet
= 1;
2032 pos
= &file_stream
->pos
;
2034 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2036 perror("read index file header");
2040 /* Check the index header */
2041 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2042 fprintf(stderr
, "[error] wrong index magic\n");
2046 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2047 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2048 ".%" PRIu32
", supported %d.%d\n",
2049 be32toh(index_hdr
.index_major
),
2050 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2055 index_minor
= be32toh(index_hdr
.index_minor
);
2057 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2058 if (packet_index_len
== 0) {
2059 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2064 * Allocate the index length found in header, not internal
2067 ctf_index
= g_malloc0(packet_index_len
);
2068 while (fread(ctf_index
, packet_index_len
, 1,
2069 pos
->index_fp
) == 1) {
2071 struct ctf_stream_declaration
*stream
= NULL
;
2073 memset(&index
, 0, sizeof(index
));
2074 index
.offset
= be64toh(ctf_index
->offset
);
2075 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2076 index
.content_size
= be64toh(ctf_index
->content_size
);
2077 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2078 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2079 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2080 index
.events_discarded_len
= 64;
2081 index
.data_offset
= -1;
2082 stream_id
= be64toh(ctf_index
->stream_id
);
2083 if (index_minor
>= 1) {
2084 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2085 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2088 if (!first_packet
) {
2089 /* add index to packet array */
2090 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2094 file_stream
->parent
.stream_id
= stream_id
;
2095 if (stream_id
< td
->streams
->len
) {
2096 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2099 fprintf(stderr
, "[error] Stream %" PRIu64
2100 " is not declared in metadata.\n",
2105 file_stream
->parent
.stream_class
= stream
;
2106 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2110 /* add index to packet array */
2111 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2114 /* Index containing only the header. */
2115 if (!file_stream
->parent
.stream_class
) {
2128 * Note: many file streams can inherit from the same stream class
2129 * description (metadata).
2132 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2133 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2136 int ret
, fd
, closeret
;
2137 struct ctf_file_stream
*file_stream
;
2138 struct stat statbuf
;
2141 fd
= openat(td
->dirfd
, path
, flags
);
2143 perror("File stream openat()");
2148 /* Don't try to mmap subdirectories. Skip them, return success. */
2149 ret
= fstat(fd
, &statbuf
);
2151 perror("File stream fstat()");
2154 if (S_ISDIR(statbuf
.st_mode
)) {
2155 if (strncmp(path
, "index", 5) != 0) {
2156 fprintf(stderr
, "[warning] Skipping directory '%s' "
2157 "found in trace\n", path
);
2162 if (!statbuf
.st_size
) {
2163 /** Skip empty files. */
2165 goto fd_is_empty_file
;
2168 file_stream
= g_new0(struct ctf_file_stream
, 1);
2169 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2170 file_stream
->pos
.fd
= -1;
2171 file_stream
->pos
.index_fp
= NULL
;
2173 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2174 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2177 file_stream
->pos
.packet_seek
= packet_seek
;
2179 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2184 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2187 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2191 * For now, only a single clock per trace is supported.
2193 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2196 * Allocate the index name for this stream and try to open it.
2198 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2200 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2204 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2207 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2208 ret
= create_stream_packet_index(td
, file_stream
);
2210 fprintf(stderr
, "[error] Stream index creation error.\n");
2214 ret
= openat(td
->dirfd
, index_name
, flags
);
2216 perror("Index file openat()");
2220 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2221 if (!file_stream
->pos
.index_fp
) {
2222 perror("fdopen() error");
2225 ret
= import_stream_packet_index(td
, file_stream
);
2230 ret
= fclose(file_stream
->pos
.index_fp
);
2232 perror("close index");
2238 /* Add stream file to stream class */
2239 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2240 &file_stream
->parent
);
2244 if (file_stream
->pos
.index_fp
) {
2245 ret
= fclose(file_stream
->pos
.index_fp
);
2247 perror("close index");
2250 if (file_stream
->parent
.trace_packet_header
)
2251 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2255 closeret
= ctf_fini_pos(&file_stream
->pos
);
2257 fprintf(stderr
, "Error on ctf_fini_pos\n");
2259 g_free(file_stream
);
2263 closeret
= close(fd
);
2265 perror("Error on fd close");
2272 int ctf_open_trace_read(struct ctf_trace
*td
,
2273 const char *path
, int flags
,
2274 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2275 int whence
), FILE *metadata_fp
)
2277 struct ctf_scanner
*scanner
;
2279 struct dirent
*dirent
;
2280 struct dirent
*diriter
;
2286 /* Open trace directory */
2287 td
->dir
= opendir(path
);
2289 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2294 td
->dirfd
= open(path
, 0);
2295 if (td
->dirfd
< 0) {
2296 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2297 perror("Trace directory open");
2301 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2302 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2305 * Keep the metadata file separate.
2306 * Keep scanner object local to the open. We don't support
2307 * incremental metadata append for on-disk traces.
2309 scanner
= ctf_scanner_alloc();
2311 fprintf(stderr
, "[error] Error allocating scanner\n");
2313 goto error_metadata
;
2315 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2316 ctf_scanner_free(scanner
);
2318 if (ret
== -ENOENT
) {
2319 fprintf(stderr
, "[warning] Empty metadata.\n");
2321 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2322 goto error_metadata
;
2326 * Open each stream: for each file, try to open, check magic
2327 * number, and get the stream ID to add to the right location in
2331 dirent_len
= offsetof(struct dirent
, d_name
) +
2332 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2334 dirent
= malloc(dirent_len
);
2337 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2339 fprintf(stderr
, "[error] Readdir error.\n");
2344 /* Ignore hidden files, ., .. and metadata. */
2345 if (!strncmp(diriter
->d_name
, ".", 1)
2346 || !strcmp(diriter
->d_name
, "..")
2347 || !strcmp(diriter
->d_name
, "metadata"))
2350 /* Ignore index files : *.idx */
2351 ext
= strrchr(diriter
->d_name
, '.');
2352 if (ext
&& (!strcmp(ext
, ".idx"))) {
2356 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2357 flags
, packet_seek
);
2359 fprintf(stderr
, "[error] Open file stream error.\n");
2370 closeret
= close(td
->dirfd
);
2372 perror("Error on fd close");
2375 closeret
= closedir(td
->dir
);
2377 perror("Error on closedir");
2384 * ctf_open_trace: Open a CTF trace and index it.
2385 * Note that the user must seek the trace after the open (using the iterator)
2386 * since the index creation read it entirely.
2389 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2390 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2391 int whence
), FILE *metadata_fp
)
2393 struct ctf_trace
*td
;
2397 * If packet_seek is NULL, we provide our default version.
2400 packet_seek
= ctf_packet_seek
;
2402 td
= g_new0(struct ctf_trace
, 1);
2406 init_trace_descriptor(&td
->parent
);
2408 switch (flags
& O_ACCMODE
) {
2411 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2414 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2419 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2422 fprintf(stderr
, "[error] Incorrect open flags.\n");
2426 ret
= trace_debug_info_create(td
);
2434 trace_debug_info_destroy(td
);
2441 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2442 struct bt_mmap_stream
*mmap_info
)
2444 pos
->mmap_offset
= 0;
2445 pos
->packet_size
= 0;
2446 pos
->content_size
= 0;
2447 pos
->content_size_loc
= NULL
;
2448 pos
->fd
= mmap_info
->fd
;
2449 pos
->base_mma
= NULL
;
2453 pos
->prot
= PROT_READ
;
2454 pos
->flags
= MAP_PRIVATE
;
2455 pos
->parent
.rw_table
= read_dispatch_table
;
2456 pos
->parent
.event_cb
= ctf_read_event
;
2457 pos
->priv
= mmap_info
->priv
;
2458 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2459 sizeof(struct packet_index
));
2463 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2464 struct ctf_file_stream
*file_stream
,
2465 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2468 struct ctf_stream_declaration
*stream
;
2472 /* Ask for the first packet to get the stream_id. */
2473 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2474 stream_id
= file_stream
->parent
.stream_id
;
2475 if (stream_id
>= td
->streams
->len
) {
2476 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2477 "in metadata.\n", stream_id
);
2481 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2483 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2484 "in metadata.\n", stream_id
);
2488 file_stream
->parent
.stream_class
= stream
;
2489 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2495 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2496 struct bt_mmap_stream
*mmap_info
,
2497 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2501 struct ctf_file_stream
*file_stream
;
2503 file_stream
= g_new0(struct ctf_file_stream
, 1);
2504 file_stream
->parent
.stream_id
= -1ULL;
2505 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2506 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2508 file_stream
->pos
.packet_seek
= packet_seek
;
2510 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2515 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2520 * For now, only a single clock per trace is supported.
2522 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2524 /* Add stream file to stream class */
2525 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2526 &file_stream
->parent
);
2530 if (file_stream
->parent
.trace_packet_header
)
2531 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2533 g_free(file_stream
);
2538 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2539 struct bt_mmap_stream_list
*mmap_list
,
2540 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2545 struct bt_mmap_stream
*mmap_info
;
2547 td
->scanner
= ctf_scanner_alloc();
2549 fprintf(stderr
, "[error] Error allocating scanner\n");
2553 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2555 if (ret
== -ENOENT
) {
2556 fprintf(stderr
, "[warning] Empty metadata.\n");
2562 * for each stream, try to open, check magic number, and get the
2563 * stream ID to add to the right location in the stream array.
2565 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2566 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2568 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2575 ctf_scanner_free(td
->scanner
);
2580 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2581 struct bt_mmap_stream_list
*mmap_list
,
2582 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2586 struct ctf_trace
*td
;
2590 fprintf(stderr
, "[error] No metadata file pointer associated, "
2591 "required for mmap parsing\n");
2595 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2598 td
= g_new0(struct ctf_trace
, 1);
2600 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2604 ret
= trace_debug_info_create(td
);
2617 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2620 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2626 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2629 /* for each stream_class */
2630 for (i
= 0; i
< td
->streams
->len
; i
++) {
2631 struct ctf_stream_declaration
*stream_class
;
2633 stream_class
= g_ptr_array_index(td
->streams
, i
);
2636 /* for each stream */
2637 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2638 struct ctf_stream_definition
*stream
;
2640 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2643 ret
= copy_event_declarations_stream_class_to_stream(td
,
2644 stream_class
, stream
);
2653 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2656 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2658 /* for each stream_class */
2659 for (i
= 0; i
< td
->streams
->len
; i
++) {
2660 struct ctf_stream_declaration
*stream_class
;
2662 stream_class
= g_ptr_array_index(td
->streams
, i
);
2665 /* for each file_stream */
2666 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2667 struct ctf_stream_definition
*stream
;
2668 struct ctf_stream_pos
*stream_pos
;
2669 struct ctf_file_stream
*cfs
;
2671 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2674 cfs
= container_of(stream
, struct ctf_file_stream
,
2676 stream_pos
= &cfs
->pos
;
2677 if (!stream_pos
->packet_index
)
2680 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2681 struct packet_index
*index
;
2683 index
= &g_array_index(stream_pos
->packet_index
,
2684 struct packet_index
, k
);
2685 index
->ts_real
.timestamp_begin
=
2686 ctf_get_real_timestamp(stream
,
2687 index
->ts_cycles
.timestamp_begin
);
2688 index
->ts_real
.timestamp_end
=
2689 ctf_get_real_timestamp(stream
,
2690 index
->ts_cycles
.timestamp_end
);
2698 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2702 ret
= ctf_fini_pos(&file_stream
->pos
);
2704 fprintf(stderr
, "Error on ctf_fini_pos\n");
2707 if (file_stream
->pos
.fd
>= 0) {
2708 ret
= close(file_stream
->pos
.fd
);
2710 perror("Error closing file fd");
2718 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2720 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2726 for (i
= 0; i
< td
->streams
->len
; i
++) {
2727 struct ctf_stream_declaration
*stream
;
2730 stream
= g_ptr_array_index(td
->streams
, i
);
2733 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2734 struct ctf_file_stream
*file_stream
;
2735 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2736 struct ctf_file_stream
, parent
);
2737 ret
= ctf_close_file_stream(file_stream
);
2743 ctf_destroy_metadata(td
);
2744 ctf_scanner_free(td
->scanner
);
2745 if (td
->dirfd
>= 0) {
2746 ret
= close(td
->dirfd
);
2748 perror("Error closing dirfd");
2753 ret
= closedir(td
->dir
);
2755 perror("Error closedir");
2759 free(td
->metadata_string
);
2760 trace_debug_info_destroy(td
);
2766 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2767 struct bt_context
*ctx
)
2769 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2772 td
->parent
.ctx
= ctx
;
2776 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2777 struct bt_trace_handle
*handle
)
2779 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2782 td
->parent
.handle
= handle
;
2786 void __attribute__((constructor
)) ctf_init(void)
2790 ctf_format
.name
= g_quark_from_static_string("ctf");
2791 ret
= bt_register_format(&ctf_format
);
2796 void __attribute__((destructor
)) ctf_exit(void)
2798 bt_unregister_format(&ctf_format
);