2 * BabelTrace - Common Trace Format (CTF)
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/format.h>
30 #include <babeltrace/format-internal.h>
31 #include <babeltrace/ctf/types.h>
32 #include <babeltrace/ctf/metadata.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf/events-internal.h>
35 #include <babeltrace/trace-handle-internal.h>
36 #include <babeltrace/context-internal.h>
37 #include <babeltrace/compat/uuid.h>
38 #include <babeltrace/endian.h>
39 #include <babeltrace/error.h>
40 #include <babeltrace/trace-debug-info.h>
41 #include <babeltrace/ctf/ctf-index.h>
46 #include <sys/types.h>
54 #include "metadata/ctf-scanner.h"
55 #include "metadata/ctf-parser.h"
56 #include "metadata/ctf-ast.h"
57 #include "events-private.h"
58 #include <babeltrace/compat/memstream.h>
59 #include <babeltrace/compat/fcntl.h>
61 #define LOG2_CHAR_BIT 3
64 * Length of first attempt at mapping a packet header, in bits.
66 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
69 * Lenght of packet to write, in bits.
71 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
73 #define NSEC_PER_SEC 1000000000ULL
75 #define INDEX_PATH "./index/%s.idx"
82 uint64_t opt_clock_offset
;
83 uint64_t opt_clock_offset_ns
;
86 char *opt_debug_info_dir
;
87 char *opt_debug_info_target_prefix
;
90 * TODO: babeltrace_ctf_console_output ensures that we only print
91 * discarded events when ctf-text plugin is used. Should be cleaned up
92 * with the plugin system redesign.
94 int babeltrace_ctf_console_output
;
97 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
98 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
102 struct bt_trace_descriptor
*ctf_open_mmap_trace(
103 struct bt_mmap_stream_list
*mmap_list
,
104 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
108 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
109 struct bt_context
*ctx
);
111 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
112 struct bt_trace_handle
*handle
);
115 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
117 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
118 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
120 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
121 struct bt_trace_handle
*handle
, enum bt_clock_type type
);
123 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
126 rw_dispatch read_dispatch_table
[] = {
127 [ CTF_TYPE_INTEGER
] = ctf_integer_read
,
128 [ CTF_TYPE_FLOAT
] = ctf_float_read
,
129 [ CTF_TYPE_ENUM
] = ctf_enum_read
,
130 [ CTF_TYPE_STRING
] = ctf_string_read
,
131 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
132 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
133 [ CTF_TYPE_ARRAY
] = ctf_array_read
,
134 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_read
,
138 rw_dispatch write_dispatch_table
[] = {
139 [ CTF_TYPE_INTEGER
] = ctf_integer_write
,
140 [ CTF_TYPE_FLOAT
] = ctf_float_write
,
141 [ CTF_TYPE_ENUM
] = ctf_enum_write
,
142 [ CTF_TYPE_STRING
] = ctf_string_write
,
143 [ CTF_TYPE_STRUCT
] = ctf_struct_rw
,
144 [ CTF_TYPE_VARIANT
] = ctf_variant_rw
,
145 [ CTF_TYPE_ARRAY
] = ctf_array_write
,
146 [ CTF_TYPE_SEQUENCE
] = ctf_sequence_write
,
150 struct bt_format ctf_format
= {
151 .open_trace
= ctf_open_trace
,
152 .open_mmap_trace
= ctf_open_mmap_trace
,
153 .close_trace
= ctf_close_trace
,
154 .set_context
= ctf_set_context
,
155 .set_handle
= ctf_set_handle
,
156 .timestamp_begin
= ctf_timestamp_begin
,
157 .timestamp_end
= ctf_timestamp_end
,
158 .convert_index_timestamp
= ctf_convert_index_timestamp
,
161 void bt_ctf_hook(void)
164 * Dummy function to prevent the linker from discarding this format as
165 * "unused" in static builds.
170 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
171 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
173 struct ctf_trace
*tin
;
174 uint64_t begin
= ULLONG_MAX
;
177 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
182 /* for each stream_class */
183 for (i
= 0; i
< tin
->streams
->len
; i
++) {
184 struct ctf_stream_declaration
*stream_class
;
186 stream_class
= g_ptr_array_index(tin
->streams
, i
);
189 /* for each file_stream */
190 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
191 struct ctf_stream_definition
*stream
;
192 struct ctf_file_stream
*cfs
;
193 struct ctf_stream_pos
*stream_pos
;
194 struct packet_index
*index
;
196 stream
= g_ptr_array_index(stream_class
->streams
, j
);
197 cfs
= container_of(stream
, struct ctf_file_stream
,
199 stream_pos
= &cfs
->pos
;
201 if (!stream_pos
->packet_index
)
204 if (stream_pos
->packet_index
->len
<= 0)
207 index
= &g_array_index(stream_pos
->packet_index
,
209 stream_pos
->packet_index
->len
- 1);
210 if (type
== BT_CLOCK_REAL
) {
211 if (index
->ts_real
.timestamp_begin
< begin
)
212 begin
= index
->ts_real
.timestamp_begin
;
213 } else if (type
== BT_CLOCK_CYCLES
) {
214 if (index
->ts_cycles
.timestamp_begin
< begin
)
215 begin
= index
->ts_cycles
.timestamp_begin
;
229 uint64_t ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
230 struct bt_trace_handle
*handle
, enum bt_clock_type type
)
232 struct ctf_trace
*tin
;
236 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
241 /* for each stream_class */
242 for (i
= 0; i
< tin
->streams
->len
; i
++) {
243 struct ctf_stream_declaration
*stream_class
;
245 stream_class
= g_ptr_array_index(tin
->streams
, i
);
248 /* for each file_stream */
249 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
250 struct ctf_stream_definition
*stream
;
251 struct ctf_file_stream
*cfs
;
252 struct ctf_stream_pos
*stream_pos
;
253 struct packet_index
*index
;
255 stream
= g_ptr_array_index(stream_class
->streams
, j
);
256 cfs
= container_of(stream
, struct ctf_file_stream
,
258 stream_pos
= &cfs
->pos
;
260 if (!stream_pos
->packet_index
)
263 if (stream_pos
->packet_index
->len
<= 0)
266 index
= &g_array_index(stream_pos
->packet_index
,
268 stream_pos
->packet_index
->len
- 1);
269 if (type
== BT_CLOCK_REAL
) {
270 if (index
->ts_real
.timestamp_end
> end
)
271 end
= index
->ts_real
.timestamp_end
;
272 } else if (type
== BT_CLOCK_CYCLES
) {
273 if (index
->ts_cycles
.timestamp_end
> end
)
274 end
= index
->ts_cycles
.timestamp_end
;
288 * Update stream current timestamp
291 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
292 struct definition_integer
*integer_definition
)
294 struct declaration_integer
*integer_declaration
=
295 integer_definition
->declaration
;
296 uint64_t oldval
, newval
, updateval
;
298 if (unlikely(integer_declaration
->len
== 64)) {
299 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
300 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
301 stream
->cycles_timestamp
);
305 oldval
= stream
->cycles_timestamp
;
306 oldval
&= (1ULL << integer_declaration
->len
) - 1;
307 newval
= integer_definition
->value
._unsigned
;
308 /* Test for overflow by comparing low bits */
310 newval
+= 1ULL << integer_declaration
->len
;
311 /* updateval contains old high bits, and new low bits (sum) */
312 updateval
= stream
->cycles_timestamp
;
313 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
315 stream
->cycles_timestamp
= updateval
;
317 /* convert to real timestamp */
318 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
319 stream
->cycles_timestamp
);
323 * Print timestamp, rescaling clock frequency to nanoseconds and
324 * applying offsets as needed (unix time).
327 void ctf_print_timestamp_real(FILE *fp
,
328 struct ctf_stream_definition
*stream
,
331 uint64_t ts_sec
= 0, ts_nsec
;
335 /* Add command-line offset in ns*/
336 ts_nsec
+= opt_clock_offset_ns
;
338 /* Add command-line offset */
339 ts_sec
+= opt_clock_offset
;
341 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
342 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
344 if (!opt_clock_seconds
) {
346 time_t time_s
= (time_t) ts_sec
;
348 if (!opt_clock_gmt
) {
351 res
= localtime_r(&time_s
, &tm
);
353 fprintf(stderr
, "[warning] Unable to get localtime.\n");
359 res
= gmtime_r(&time_s
, &tm
);
361 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
365 if (opt_clock_date
) {
369 /* Print date and time */
370 res
= strftime(timestr
, sizeof(timestr
),
373 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
376 fprintf(fp
, "%s", timestr
);
378 /* Print time in HH:MM:SS.ns */
379 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
380 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec
);
384 fprintf(fp
, "%3" PRIu64
".%09" PRIu64
,
392 * Print timestamp, in cycles
395 void ctf_print_timestamp_cycles(FILE *fp
,
396 struct ctf_stream_definition
*stream
,
399 fprintf(fp
, "%020" PRIu64
, timestamp
);
402 void ctf_print_timestamp(FILE *fp
,
403 struct ctf_stream_definition
*stream
,
406 if (opt_clock_cycles
) {
407 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
409 ctf_print_timestamp_real(fp
, stream
, timestamp
);
414 void print_uuid(FILE *fp
, unsigned char *uuid
)
418 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
419 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
423 * Discarded events can be either:
424 * - discarded after end of previous buffer due to buffer full:
425 * happened within range: [ prev_timestamp_end, timestamp_begin ]
426 * - discarded within current buffer due to either event too large or
427 * nested wrap-around:
428 * happened within range: [ timestamp_begin, timestamp_end ]
430 * Given we have discarded counters of those two types merged into the
431 * events_discarded counter, we need to use the union of those ranges:
432 * [ prev_timestamp_end, timestamp_end ]
434 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
435 * consumer had time to extract them. We keep track of those gaps with the
436 * packet sequence number in each packet.
438 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
)
440 if ((!stream
->events_discarded
&& !stream
->packets_lost
) ||
441 !babeltrace_ctf_console_output
) {
445 if (stream
->events_discarded
) {
446 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events between [",
447 stream
->events_discarded
);
448 } else if (stream
->packets_lost
) {
449 fprintf(fp
, "[warning] Tracer lost %" PRIu64
" trace packets between [",
450 stream
->packets_lost
);
452 if (opt_clock_cycles
) {
453 ctf_print_timestamp(fp
, stream
,
454 stream
->prev
.cycles
.end
);
455 fprintf(fp
, "] and [");
456 ctf_print_timestamp(fp
, stream
,
457 stream
->current
.cycles
.end
);
459 ctf_print_timestamp(fp
, stream
,
460 stream
->prev
.real
.end
);
461 fprintf(fp
, "] and [");
462 ctf_print_timestamp(fp
, stream
,
463 stream
->current
.real
.end
);
465 fprintf(fp
, "] in trace UUID ");
466 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
467 if (stream
->stream_class
->trace
->parent
.path
[0])
468 fprintf(fp
, ", at path: \"%s\"",
469 stream
->stream_class
->trace
->parent
.path
);
471 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
473 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
475 fprintf(fp
, "You should consider recording a new trace with larger "
476 "buffers or with fewer events enabled.\n");
481 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
483 struct ctf_stream_pos
*pos
=
484 container_of(ppos
, struct ctf_stream_pos
, parent
);
485 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
486 struct ctf_event_definition
*event
;
490 /* We need to check for EOF here for empty files. */
491 if (unlikely(pos
->offset
== EOF
))
494 if (ctf_pos_get_event(pos
))
497 /* save the current position as a restore point */
498 pos
->last_offset
= pos
->offset
;
501 * This is the EOF check after we've advanced the position in
504 if (unlikely(pos
->offset
== EOF
))
507 /* Stream is inactive for now (live reading). */
508 if (unlikely(pos
->content_size
== 0))
512 * Packet seeked to by ctf_pos_get_event() only contains
513 * headers, no event. Consider stream as inactive (live
516 if (unlikely(pos
->data_offset
== pos
->content_size
))
519 assert(pos
->offset
< pos
->content_size
);
521 /* Read event header */
522 if (likely(stream
->stream_event_header
)) {
523 struct definition_integer
*integer_definition
;
524 struct bt_definition
*variant
;
526 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
529 /* lookup event id */
530 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
531 if (integer_definition
) {
532 id
= integer_definition
->value
._unsigned
;
534 struct definition_enum
*enum_definition
;
536 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
537 if (enum_definition
) {
538 id
= enum_definition
->integer
->value
._unsigned
;
542 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
544 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
545 if (integer_definition
) {
546 id
= integer_definition
->value
._unsigned
;
549 stream
->event_id
= id
;
551 /* lookup timestamp */
552 stream
->has_timestamp
= 0;
553 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
554 if (integer_definition
) {
555 ctf_update_timestamp(stream
, integer_definition
);
556 stream
->has_timestamp
= 1;
559 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
560 if (integer_definition
) {
561 ctf_update_timestamp(stream
, integer_definition
);
562 stream
->has_timestamp
= 1;
568 /* Read stream-declared event context */
569 if (stream
->stream_event_context
) {
570 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
575 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
576 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
579 event
= g_ptr_array_index(stream
->events_by_id
, id
);
580 if (unlikely(!event
)) {
581 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
585 /* Read event-declared event context */
586 if (event
->event_context
) {
587 ret
= generic_rw(ppos
, &event
->event_context
->p
);
592 /* Read event payload */
593 if (likely(event
->event_fields
)) {
594 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
599 if (pos
->last_offset
== pos
->offset
) {
600 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
607 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
612 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
614 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
615 struct ctf_event_definition
*event
;
619 id
= stream
->event_id
;
621 /* print event header */
622 if (likely(stream
->stream_event_header
)) {
623 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
628 /* print stream-declared event context */
629 if (stream
->stream_event_context
) {
630 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
635 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
636 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
639 event
= g_ptr_array_index(stream
->events_by_id
, id
);
640 if (unlikely(!event
)) {
641 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
645 /* print event-declared event context */
646 if (event
->event_context
) {
647 ret
= generic_rw(pos
, &event
->event_context
->p
);
652 /* Read and print event payload */
653 if (likely(event
->event_fields
)) {
654 ret
= generic_rw(pos
, &event
->event_fields
->p
);
662 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
667 * One side-effect of this function is to unmap pos mmap base if one is
671 int find_data_offset(struct ctf_stream_pos
*pos
,
672 struct ctf_file_stream
*file_stream
,
673 struct packet_index
*packet_index
)
675 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
676 struct stat filestats
;
680 pos
= &file_stream
->pos
;
682 ret
= fstat(pos
->fd
, &filestats
);
685 filesize
= filestats
.st_size
;
687 /* Deal with empty files */
693 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
694 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
699 ret
= munmap_align(pos
->base_mma
);
701 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
705 pos
->base_mma
= NULL
;
707 /* map new base. Need mapping length from header. */
708 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
709 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
710 assert(pos
->base_mma
!= MAP_FAILED
);
712 pos
->content_size
= packet_map_len
;
713 pos
->packet_size
= packet_map_len
;
714 pos
->offset
= 0; /* Position of the packet header */
716 /* update trace_packet_header and stream_packet_context */
717 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
718 /* Read packet header */
719 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
725 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
726 /* Read packet context */
727 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
733 packet_index
->data_offset
= pos
->offset
;
736 ret
= munmap_align(pos
->base_mma
);
738 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
742 pos
->base_mma
= NULL
;
746 /* Retry with larger mapping */
748 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
750 * Reached EOF, but still expecting header/context data.
752 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
755 /* Double the mapping len, and retry */
756 tmp_map_len
= packet_map_len
<< 1;
757 if (tmp_map_len
>> 1 != packet_map_len
) {
759 fprintf(stderr
, "[error] Packet mapping length overflow\n");
762 packet_map_len
= tmp_map_len
;
767 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
768 int fd
, int open_flags
)
772 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
773 sizeof(struct packet_index
));
775 pos
->packet_index
= NULL
;
777 switch (open_flags
& O_ACCMODE
) {
779 pos
->prot
= PROT_READ
;
780 pos
->flags
= MAP_PRIVATE
;
781 pos
->parent
.rw_table
= read_dispatch_table
;
782 pos
->parent
.event_cb
= ctf_read_event
;
783 pos
->parent
.trace
= trace
;
786 pos
->prot
= PROT_READ
| PROT_WRITE
;
787 pos
->flags
= MAP_SHARED
;
788 pos
->parent
.rw_table
= write_dispatch_table
;
789 pos
->parent
.event_cb
= ctf_write_event
;
790 pos
->parent
.trace
= trace
;
798 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
800 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
801 *pos
->content_size_loc
= pos
->offset
;
806 ret
= munmap_align(pos
->base_mma
);
808 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
813 if (pos
->packet_index
)
814 (void) g_array_free(pos
->packet_index
, TRUE
);
818 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
819 struct packet_index
*prev_index
,
820 struct packet_index
*cur_index
)
822 uint64_t events_discarded_diff
;
823 uint64_t packets_lost_diff
= 0;
825 /* Update packet index time information */
827 /* Current packet begin/end */
828 stream
->current
.real
.begin
=
829 cur_index
->ts_real
.timestamp_begin
;
830 stream
->current
.cycles
.begin
=
831 cur_index
->ts_cycles
.timestamp_begin
;
832 stream
->current
.real
.end
=
833 cur_index
->ts_real
.timestamp_end
;
834 stream
->current
.cycles
.end
=
835 cur_index
->ts_cycles
.timestamp_end
;
837 /* Update packet index discarded event information */
838 events_discarded_diff
= cur_index
->events_discarded
;
840 /* Previous packet begin/end */
841 stream
->prev
.cycles
.begin
=
842 prev_index
->ts_cycles
.timestamp_begin
;
843 stream
->prev
.real
.begin
=
844 prev_index
->ts_real
.timestamp_begin
;
845 stream
->prev
.cycles
.end
=
846 prev_index
->ts_cycles
.timestamp_end
;
847 stream
->prev
.real
.end
=
848 prev_index
->ts_real
.timestamp_end
;
850 events_discarded_diff
-= prev_index
->events_discarded
;
851 /* packet_seq_num stays at 0 if not produced by the tracer */
852 if (cur_index
->packet_seq_num
) {
853 packets_lost_diff
= cur_index
->packet_seq_num
-
854 prev_index
->packet_seq_num
- 1;
857 * Deal with 32-bit wrap-around if the tracer provided a
860 if (prev_index
->events_discarded_len
== 32) {
861 events_discarded_diff
= (uint32_t) events_discarded_diff
;
865 * First packet: use current packet info as limits for
868 stream
->prev
.cycles
.begin
=
869 stream
->prev
.cycles
.end
=
870 stream
->current
.cycles
.begin
;
871 stream
->prev
.real
.begin
=
872 stream
->prev
.real
.end
=
873 stream
->current
.real
.begin
;
875 stream
->events_discarded
= events_discarded_diff
;
876 stream
->packets_lost
= packets_lost_diff
;
880 * Find the timerange where all the streams in the trace are active
883 * Return 0 and update begin/end if necessary on success, return 1 for
884 * empty streams and return a negative value on error.
887 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
888 struct packet_index_time
*_real
,
889 struct packet_index_time
*_cycles
)
891 int stream_id
, ret
= 0;
892 struct packet_index_time real
= { 0, UINT64_MAX
},
893 cycles
= { 0, UINT64_MAX
};
894 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
896 /* At least one of the two return args must be provided. */
897 if (!_real
&& !_cycles
) {
902 if (tin
->streams
->len
== 0) {
907 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
910 struct ctf_stream_declaration
*stream_class
;
912 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
916 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
917 struct ctf_file_stream
*file_stream
;
918 struct ctf_stream_pos
*stream_pos
;
919 struct packet_index
*index
;
921 file_stream
= g_ptr_array_index(stream_class
->streams
,
926 stream_pos
= &file_stream
->pos
;
927 if (!stream_pos
->packet_index
||
928 stream_pos
->packet_index
->len
<= 0) {
932 index
= &g_array_index(stream_pos
->packet_index
,
933 struct packet_index
, 0);
934 real
.timestamp_begin
= max(real
.timestamp_begin
,
935 index
->ts_real
.timestamp_begin
);
936 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
937 index
->ts_cycles
.timestamp_begin
);
939 index
= &g_array_index(stream_pos
->packet_index
,
941 stream_pos
->packet_index
->len
- 1);
942 real
.timestamp_end
= min(real
.timestamp_end
,
943 index
->ts_real
.timestamp_end
);
944 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
945 index
->ts_cycles
.timestamp_end
);
961 * Find the union of all active regions in the trace collection's traces.
962 * Returns "real" timestamps.
964 * Return 0 on success.
965 * Return 1 if no intersections are found.
966 * Return a negative value on error.
968 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
969 uint64_t *_ts_begin
, uint64_t *_ts_end
)
972 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
974 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
979 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
980 struct bt_trace_descriptor
*td_read
;
981 struct packet_index_time intersection_real
;
983 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
987 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
990 /* Empty trace or no stream intersection. */
992 } else if (ret
< 0) {
996 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
997 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
1000 if (ts_end
< ts_begin
) {
1004 *_ts_begin
= ts_begin
;
1010 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1014 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1019 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1020 struct bt_trace_descriptor
*td_read
;
1021 struct packet_index_time intersection_real
;
1023 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1028 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1031 /* Empty trace or no stream intersection. */
1033 } else if (ret
< 0) {
1037 td_read
->interval_real
= intersection_real
;
1038 td_read
->interval_set
= true;
1045 * for SEEK_CUR: go to next packet.
1046 * for SEEK_SET: go to packet numer (index).
1048 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1050 struct ctf_stream_pos
*pos
=
1051 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1052 struct ctf_file_stream
*file_stream
=
1053 container_of(pos
, struct ctf_file_stream
, pos
);
1055 struct packet_index
*packet_index
, *prev_index
;
1059 case SEEK_SET
: /* Fall-through */
1066 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1067 *pos
->content_size_loc
= pos
->offset
;
1069 if (pos
->base_mma
) {
1070 /* unmap old base */
1071 ret
= munmap_align(pos
->base_mma
);
1073 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1078 pos
->base_mma
= NULL
;
1082 * The caller should never ask for ctf_move_pos across packets,
1083 * except to get exactly at the beginning of the next packet.
1085 if (pos
->prot
& PROT_WRITE
) {
1088 /* The writer will add padding */
1089 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1092 assert(index
== 0); /* only seek supported for now */
1099 pos
->content_size
= -1U; /* Unknown at this point */
1100 pos
->packet_size
= WRITE_PACKET_LEN
;
1102 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1103 pos
->packet_size
/ CHAR_BIT
);
1104 } while (ret
== EINTR
);
1112 if (pos
->offset
== EOF
) {
1116 assert(pos
->cur_index
< pos
->packet_index
->len
);
1117 /* The reader will expect us to skip padding */
1122 if (index
>= pos
->packet_index
->len
) {
1127 pos
->cur_index
= index
;
1134 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1140 packet_index
= &g_array_index(pos
->packet_index
,
1141 struct packet_index
, pos
->cur_index
);
1142 if (pos
->cur_index
> 0) {
1143 prev_index
= &g_array_index(pos
->packet_index
,
1144 struct packet_index
,
1145 pos
->cur_index
- 1);
1149 ctf_update_current_packet_index(&file_stream
->parent
,
1150 prev_index
, packet_index
);
1152 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1159 * We need to check if we are in trace read or called
1160 * from packet indexing. In this last case, the
1161 * collection is not there, so we cannot print the
1164 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1165 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1168 packet_index
= &g_array_index(pos
->packet_index
,
1169 struct packet_index
,
1171 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1173 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1175 /* Lookup context/packet size in index */
1176 if (packet_index
->data_offset
== -1) {
1177 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1184 if (packet_index
->packet_size
> ((uint64_t) pos
->file_length
- packet_index
->offset
) * CHAR_BIT
) {
1185 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1186 packet_index
->packet_size
, ((uint64_t) pos
->file_length
- packet_index
->offset
) * CHAR_BIT
);
1191 pos
->content_size
= packet_index
->content_size
;
1192 pos
->packet_size
= packet_index
->packet_size
;
1193 pos
->mmap_offset
= packet_index
->offset
;
1194 pos
->data_offset
= packet_index
->data_offset
;
1195 if (pos
->data_offset
< packet_index
->content_size
) {
1196 pos
->offset
= 0; /* will read headers */
1197 } else if (pos
->data_offset
== packet_index
->content_size
) {
1199 pos
->offset
= packet_index
->data_offset
;
1201 goto read_next_packet
;
1208 /* map new base. Need mapping length from header. */
1209 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1210 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1211 if (pos
->base_mma
== MAP_FAILED
) {
1212 fprintf(stderr
, "[error] mmap error %s.\n",
1217 /* update trace_packet_header and stream_packet_context */
1218 if (!(pos
->prot
& PROT_WRITE
) &&
1219 file_stream
->parent
.trace_packet_header
) {
1220 /* Read packet header */
1221 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1224 if (!(pos
->prot
& PROT_WRITE
) &&
1225 file_stream
->parent
.stream_packet_context
) {
1226 /* Read packet context */
1227 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1232 bt_packet_seek_set_error(ret
);
1236 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1242 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1246 if (magic
== TSDL_MAGIC
) {
1248 td
->byte_order
= BYTE_ORDER
;
1249 CTF_TRACE_SET_FIELD(td
, byte_order
);
1250 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1252 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1253 LITTLE_ENDIAN
: BIG_ENDIAN
;
1254 CTF_TRACE_SET_FIELD(td
, byte_order
);
1262 * Returns 0 on success, -1 on error.
1265 int check_version(unsigned int major
, unsigned int minor
)
1280 /* eventually return an error instead of warning */
1282 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1288 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1291 struct metadata_packet_header header
;
1292 size_t readlen
, writelen
, toread
;
1293 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1296 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1300 if (td
->byte_order
!= BYTE_ORDER
) {
1301 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1302 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1303 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1304 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1306 if (header
.checksum
)
1307 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1308 if (header
.compression_scheme
) {
1309 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1310 header
.compression_scheme
);
1313 if (header
.encryption_scheme
) {
1314 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1315 header
.encryption_scheme
);
1318 if (header
.checksum_scheme
) {
1319 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1320 header
.checksum_scheme
);
1323 if (check_version(header
.major
, header
.minor
) < 0)
1325 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1326 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1327 CTF_TRACE_SET_FIELD(td
, uuid
);
1329 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1333 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1336 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1339 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1344 if (babeltrace_debug
) {
1345 buf
[readlen
] = '\0';
1346 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1350 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1351 if (writelen
< readlen
) {
1361 ret
= 0; /* continue reading next packet */
1368 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1369 ret
= fseek(in
, toread
, SEEK_CUR
);
1371 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1378 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1382 size_t size
, buflen
;
1387 * Using strlen on *buf instead of size of open_memstream
1388 * because its size includes garbage at the end (after final
1389 * \0). This is the allocated size, not the actual string size.
1391 out
= babeltrace_open_memstream(buf
, &size
);
1393 perror("Metadata open_memstream");
1397 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1406 /* close to flush the buffer */
1407 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1411 perror("babeltrace_flush_memstream");
1413 closeret
= fclose(in
);
1415 perror("Error in fclose");
1421 perror("Error in fclose");
1423 /* open for reading */
1424 buflen
= strlen(*buf
);
1429 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1431 perror("Metadata fmemopen");
1438 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1439 struct ctf_scanner
*scanner
, int append
)
1441 struct ctf_file_stream
*metadata_stream
;
1444 int ret
= 0, closeret
;
1446 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1447 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1451 metadata_stream
->pos
.fd
= -1;
1453 td
->metadata
= &metadata_stream
->parent
;
1454 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1455 if (metadata_stream
->pos
.fd
< 0) {
1456 fprintf(stderr
, "Unable to open metadata.\n");
1461 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1463 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1464 perror("Metadata stream open");
1468 /* fd now belongs to fp */
1469 metadata_stream
->pos
.fd
= -1;
1471 if (babeltrace_debug
)
1474 if (packet_metadata(td
, fp
)) {
1475 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1479 td
->metadata_string
= buf
;
1480 td
->metadata_packetized
= 1;
1483 unsigned int major
, minor
;
1486 td
->byte_order
= BYTE_ORDER
;
1488 /* Check text-only metadata header and version */
1489 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1491 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1492 if (check_version(major
, minor
) < 0) {
1500 ret
= ctf_scanner_append_ast(scanner
, fp
);
1502 fprintf(stderr
, "[error] Error creating AST\n");
1506 if (babeltrace_debug
) {
1507 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1509 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1514 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1516 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1519 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1520 td
, td
->byte_order
);
1522 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1527 closeret
= fclose(fp
);
1529 perror("Error on fclose");
1533 if (metadata_stream
->pos
.fd
>= 0) {
1534 closeret
= close(metadata_stream
->pos
.fd
);
1536 perror("Error on metadata stream fd close");
1541 g_free(metadata_stream
);
1546 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1547 struct ctf_stream_definition
*stream
,
1548 struct ctf_event_declaration
*event
)
1550 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1552 if (event
->context_decl
) {
1553 struct bt_definition
*definition
=
1554 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1555 stream
->parent_def_scope
, 0, 0, "event.context");
1559 stream_event
->event_context
= container_of(definition
,
1560 struct definition_struct
, p
);
1561 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1563 if (event
->fields_decl
) {
1564 struct bt_definition
*definition
=
1565 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1566 stream
->parent_def_scope
, 0, 0, "event.fields");
1570 stream_event
->event_fields
= container_of(definition
,
1571 struct definition_struct
, p
);
1572 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1574 stream_event
->stream
= stream
;
1575 return stream_event
;
1578 if (stream_event
->event_fields
)
1579 bt_definition_unref(&stream_event
->event_fields
->p
);
1580 if (stream_event
->event_context
)
1581 bt_definition_unref(&stream_event
->event_context
->p
);
1582 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1583 g_quark_to_string(event
->name
));
1588 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1589 struct ctf_stream_declaration
*stream_class
,
1590 struct ctf_stream_definition
*stream
)
1592 size_t def_size
, class_size
, i
;
1595 def_size
= stream
->events_by_id
->len
;
1596 class_size
= stream_class
->events_by_id
->len
;
1598 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1599 for (i
= def_size
; i
< class_size
; i
++) {
1600 struct ctf_event_declaration
*event
=
1601 g_ptr_array_index(stream_class
->events_by_id
, i
);
1602 struct ctf_event_definition
*stream_event
;
1606 stream_event
= create_event_definitions(td
, stream
, event
);
1607 if (!stream_event
) {
1611 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1618 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1620 struct ctf_stream_declaration
*stream_class
;
1624 if (stream
->stream_definitions_created
)
1627 stream_class
= stream
->stream_class
;
1629 if (stream_class
->packet_context_decl
) {
1630 struct bt_definition
*definition
=
1631 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1632 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1637 stream
->stream_packet_context
= container_of(definition
,
1638 struct definition_struct
, p
);
1639 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1641 if (stream_class
->event_header_decl
) {
1642 struct bt_definition
*definition
=
1643 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1644 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1649 stream
->stream_event_header
=
1650 container_of(definition
, struct definition_struct
, p
);
1651 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1653 if (stream_class
->event_context_decl
) {
1654 struct bt_definition
*definition
=
1655 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1656 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1661 stream
->stream_event_context
=
1662 container_of(definition
, struct definition_struct
, p
);
1663 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1665 stream
->events_by_id
= g_ptr_array_new();
1666 ret
= copy_event_declarations_stream_class_to_stream(td
,
1667 stream_class
, stream
);
1673 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1674 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1676 g_free(stream_event
);
1678 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1680 if (stream
->stream_event_context
)
1681 bt_definition_unref(&stream
->stream_event_context
->p
);
1682 if (stream
->stream_event_header
)
1683 bt_definition_unref(&stream
->stream_event_header
->p
);
1684 if (stream
->stream_packet_context
)
1685 bt_definition_unref(&stream
->stream_packet_context
->p
);
1686 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1687 stream_class
->stream_id
, strerror(-ret
));
1692 int stream_assign_class(struct ctf_trace
*td
,
1693 struct ctf_file_stream
*file_stream
,
1696 struct ctf_stream_declaration
*stream
;
1699 file_stream
->parent
.stream_id
= stream_id
;
1700 if (stream_id
>= td
->streams
->len
) {
1701 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1704 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1706 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1709 file_stream
->parent
.stream_class
= stream
;
1710 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1717 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1718 struct ctf_trace
*td
,
1719 struct ctf_file_stream
*file_stream
)
1721 struct packet_index packet_index
;
1722 uint64_t stream_id
= 0;
1723 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1724 int first_packet
= 0;
1729 memset(&packet_index
, 0, sizeof(packet_index
));
1730 if (!pos
->mmap_offset
) {
1734 if (pos
->file_length
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1735 packet_map_len
= (pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1738 if (pos
->base_mma
) {
1739 /* unmap old base */
1740 ret
= munmap_align(pos
->base_mma
);
1742 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1746 pos
->base_mma
= NULL
;
1748 /* map new base. Need mapping length from header. */
1749 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1750 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1751 assert(pos
->base_mma
!= MAP_FAILED
);
1753 * Use current mapping size as temporary content and packet
1756 pos
->content_size
= packet_map_len
;
1757 pos
->packet_size
= packet_map_len
;
1758 pos
->offset
= 0; /* Position of the packet header */
1760 packet_index
.offset
= pos
->mmap_offset
;
1762 /* read and check header, set stream id (and check) */
1763 if (file_stream
->parent
.trace_packet_header
) {
1764 /* Read packet header */
1765 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1769 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1772 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1773 if (len_index
>= 0) {
1774 struct bt_definition
*field
;
1777 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1778 magic
= bt_get_unsigned_int(field
);
1779 if (magic
!= CTF_MAGIC
) {
1780 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1782 file_stream
->pos
.packet_index
->len
,
1783 (ssize_t
) pos
->mmap_offset
);
1789 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1790 if (len_index
>= 0) {
1791 struct definition_array
*defarray
;
1792 struct bt_definition
*field
;
1794 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1796 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1797 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1798 defarray
= container_of(field
, struct definition_array
, p
);
1799 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1801 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1802 struct bt_definition
*elem
;
1804 elem
= bt_array_index(defarray
, i
);
1805 uuidval
[i
] = bt_get_unsigned_int(elem
);
1807 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1809 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1814 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1815 if (len_index
>= 0) {
1816 struct bt_definition
*field
;
1818 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1819 stream_id
= bt_get_unsigned_int(field
);
1823 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1824 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1826 file_stream
->parent
.stream_id
);
1830 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1835 if (file_stream
->parent
.stream_packet_context
) {
1836 /* Read packet context */
1837 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1841 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1844 /* read packet size from header */
1845 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1846 if (len_index
>= 0) {
1847 struct bt_definition
*field
;
1849 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1850 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1852 /* Use file size for packet size */
1853 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1856 /* read content size from header */
1857 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1858 if (len_index
>= 0) {
1859 struct bt_definition
*field
;
1861 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1862 packet_index
.content_size
= bt_get_unsigned_int(field
);
1864 /* Use packet size if non-zero, else file size */
1865 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1868 /* read timestamp begin from header */
1869 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1870 if (len_index
>= 0) {
1871 struct bt_definition
*field
;
1873 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1874 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1875 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1876 packet_index
.ts_real
.timestamp_begin
=
1877 ctf_get_real_timestamp(
1878 &file_stream
->parent
,
1879 packet_index
.ts_cycles
.timestamp_begin
);
1883 /* read timestamp end from header */
1884 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1885 if (len_index
>= 0) {
1886 struct bt_definition
*field
;
1888 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1889 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1890 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1891 packet_index
.ts_real
.timestamp_end
=
1892 ctf_get_real_timestamp(
1893 &file_stream
->parent
,
1894 packet_index
.ts_cycles
.timestamp_end
);
1898 /* read events discarded from header */
1899 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1900 if (len_index
>= 0) {
1901 struct bt_definition
*field
;
1903 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1904 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1905 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1908 /* read packet_seq_num from header */
1909 len_index
= bt_struct_declaration_lookup_field_index(
1910 file_stream
->parent
.stream_packet_context
->declaration
,
1911 g_quark_from_static_string("packet_seq_num"));
1912 if (len_index
>= 0) {
1913 struct bt_definition
*field
;
1915 field
= bt_struct_definition_get_field_from_index(
1916 file_stream
->parent
.stream_packet_context
,
1918 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1921 /* Use file size for packet size */
1922 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1923 /* Use packet size if non-zero, else file size */
1924 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1927 /* Validate content size and packet size values */
1928 if (packet_index
.content_size
> packet_index
.packet_size
) {
1929 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1930 packet_index
.content_size
, packet_index
.packet_size
);
1934 if (packet_index
.content_size
< pos
->offset
) {
1935 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1939 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1940 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1944 /* Save position after header and context */
1945 packet_index
.data_offset
= pos
->offset
;
1947 /* add index to packet array */
1948 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1950 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1954 /* Retry with larger mapping */
1956 if (packet_map_len
== ((pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1958 * Reached EOF, but still expecting header/context data.
1960 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1963 /* Double the mapping len, and retry */
1964 tmp_map_len
= packet_map_len
<< 1;
1965 if (tmp_map_len
>> 1 != packet_map_len
) {
1967 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1970 packet_map_len
= tmp_map_len
;
1975 int create_stream_packet_index(struct ctf_trace
*td
,
1976 struct ctf_file_stream
*file_stream
)
1978 struct ctf_stream_pos
*pos
;
1981 pos
= &file_stream
->pos
;
1983 /* Deal with empty files */
1984 if (!pos
->file_length
) {
1985 if (file_stream
->parent
.trace_packet_header
1986 || file_stream
->parent
.stream_packet_context
) {
1988 * We expect a trace packet header and/or stream packet
1989 * context. Since a trace needs to have at least one
1990 * packet, empty files are therefore not accepted.
1992 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1996 * Without trace packet header nor stream packet
1997 * context, a one-packet trace can indeed be empty. This
1998 * is only valid if there is only one stream class: 0.
2000 ret
= stream_assign_class(td
, file_stream
, 0);
2007 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< pos
->file_length
; ) {
2008 ret
= create_stream_one_packet_index(pos
, td
, file_stream
);
2016 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
2020 if (td
->packet_header_decl
) {
2021 struct bt_definition
*definition
=
2022 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2023 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2028 stream
->trace_packet_header
=
2029 container_of(definition
, struct definition_struct
, p
);
2030 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2036 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2041 int import_stream_packet_index(struct ctf_trace
*td
,
2042 struct ctf_file_stream
*file_stream
)
2044 struct ctf_stream_pos
*pos
;
2045 struct ctf_packet_index
*ctf_index
= NULL
;
2046 struct ctf_packet_index_file_hdr index_hdr
;
2047 struct packet_index index
;
2048 uint32_t packet_index_len
, index_minor
;
2050 int first_packet
= 1;
2053 pos
= &file_stream
->pos
;
2055 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2057 perror("read index file header");
2061 /* Check the index header */
2062 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2063 fprintf(stderr
, "[error] wrong index magic\n");
2067 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2068 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2069 ".%" PRIu32
", supported %d.%d\n",
2070 be32toh(index_hdr
.index_major
),
2071 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2076 index_minor
= be32toh(index_hdr
.index_minor
);
2078 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2079 if (packet_index_len
== 0) {
2080 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2085 * Allocate the index length found in header, not internal
2088 ctf_index
= g_malloc0(packet_index_len
);
2089 while (fread(ctf_index
, packet_index_len
, 1,
2090 pos
->index_fp
) == 1) {
2092 struct ctf_stream_declaration
*stream
= NULL
;
2094 memset(&index
, 0, sizeof(index
));
2095 index
.offset
= be64toh(ctf_index
->offset
);
2096 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2097 index
.content_size
= be64toh(ctf_index
->content_size
);
2098 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2099 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2100 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2101 index
.events_discarded_len
= 64;
2102 index
.data_offset
= -1;
2103 stream_id
= be64toh(ctf_index
->stream_id
);
2104 if (index_minor
>= 1) {
2105 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2106 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2109 if (!first_packet
) {
2110 /* add index to packet array */
2111 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2115 file_stream
->parent
.stream_id
= stream_id
;
2116 if (stream_id
< td
->streams
->len
) {
2117 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2120 fprintf(stderr
, "[error] Stream %" PRIu64
2121 " is not declared in metadata.\n",
2126 file_stream
->parent
.stream_class
= stream
;
2127 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2131 /* add index to packet array */
2132 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2135 /* Index containing only the header. */
2136 if (!file_stream
->parent
.stream_class
) {
2149 * Note: many file streams can inherit from the same stream class
2150 * description (metadata).
2153 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2154 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2157 int ret
, fd
, closeret
;
2158 struct ctf_file_stream
*file_stream
;
2159 struct stat statbuf
;
2162 fd
= openat(td
->dirfd
, path
, flags
);
2164 perror("File stream openat()");
2169 /* Don't try to mmap subdirectories. Skip them, return success. */
2170 ret
= fstat(fd
, &statbuf
);
2172 perror("File stream fstat()");
2175 if (S_ISDIR(statbuf
.st_mode
)) {
2176 if (strncmp(path
, "index", 5) != 0) {
2177 fprintf(stderr
, "[warning] Skipping directory '%s' "
2178 "found in trace\n", path
);
2183 if (!statbuf
.st_size
) {
2184 /** Skip empty files. */
2186 goto fd_is_empty_file
;
2189 file_stream
= g_new0(struct ctf_file_stream
, 1);
2190 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2191 file_stream
->pos
.fd
= -1;
2192 file_stream
->pos
.index_fp
= NULL
;
2193 file_stream
->pos
.file_length
= statbuf
.st_size
;
2195 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2196 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2199 file_stream
->pos
.packet_seek
= packet_seek
;
2201 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2206 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2209 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2213 * For now, only a single clock per trace is supported.
2215 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2218 * Allocate the index name for this stream and try to open it.
2220 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2222 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2226 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2229 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2230 ret
= create_stream_packet_index(td
, file_stream
);
2232 fprintf(stderr
, "[error] Stream index creation error.\n");
2236 ret
= openat(td
->dirfd
, index_name
, flags
);
2238 perror("Index file openat()");
2242 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2243 if (!file_stream
->pos
.index_fp
) {
2244 perror("fdopen() error");
2247 ret
= import_stream_packet_index(td
, file_stream
);
2252 ret
= fclose(file_stream
->pos
.index_fp
);
2254 perror("close index");
2260 /* Add stream file to stream class */
2261 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2262 &file_stream
->parent
);
2266 if (file_stream
->pos
.index_fp
) {
2267 ret
= fclose(file_stream
->pos
.index_fp
);
2269 perror("close index");
2272 if (file_stream
->parent
.trace_packet_header
)
2273 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2277 closeret
= ctf_fini_pos(&file_stream
->pos
);
2279 fprintf(stderr
, "Error on ctf_fini_pos\n");
2281 g_free(file_stream
);
2285 closeret
= close(fd
);
2287 perror("Error on fd close");
2294 int ctf_open_trace_read(struct ctf_trace
*td
,
2295 const char *path
, int flags
,
2296 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2297 int whence
), FILE *metadata_fp
)
2299 struct ctf_scanner
*scanner
;
2301 struct dirent
*dirent
;
2302 struct dirent
*diriter
;
2308 /* Open trace directory */
2309 td
->dir
= opendir(path
);
2311 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2316 td
->dirfd
= open(path
, 0);
2317 if (td
->dirfd
< 0) {
2318 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2319 perror("Trace directory open");
2323 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2324 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2327 * Keep the metadata file separate.
2328 * Keep scanner object local to the open. We don't support
2329 * incremental metadata append for on-disk traces.
2331 scanner
= ctf_scanner_alloc();
2333 fprintf(stderr
, "[error] Error allocating scanner\n");
2335 goto error_metadata
;
2337 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2338 ctf_scanner_free(scanner
);
2340 if (ret
== -ENOENT
) {
2341 fprintf(stderr
, "[warning] Empty metadata.\n");
2343 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2344 goto error_metadata
;
2348 * Open each stream: for each file, try to open, check magic
2349 * number, and get the stream ID to add to the right location in
2353 dirent_len
= offsetof(struct dirent
, d_name
) +
2354 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2356 dirent
= malloc(dirent_len
);
2359 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2361 fprintf(stderr
, "[error] Readdir error.\n");
2366 /* Ignore hidden files, ., .. and metadata. */
2367 if (!strncmp(diriter
->d_name
, ".", 1)
2368 || !strcmp(diriter
->d_name
, "..")
2369 || !strcmp(diriter
->d_name
, "metadata"))
2372 /* Ignore index files : *.idx */
2373 ext
= strrchr(diriter
->d_name
, '.');
2374 if (ext
&& (!strcmp(ext
, ".idx"))) {
2378 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2379 flags
, packet_seek
);
2381 fprintf(stderr
, "[error] Open file stream error.\n");
2392 closeret
= close(td
->dirfd
);
2394 perror("Error on fd close");
2397 closeret
= closedir(td
->dir
);
2399 perror("Error on closedir");
2406 * ctf_open_trace: Open a CTF trace and index it.
2407 * Note that the user must seek the trace after the open (using the iterator)
2408 * since the index creation read it entirely.
2411 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2412 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2413 int whence
), FILE *metadata_fp
)
2415 struct ctf_trace
*td
;
2419 * If packet_seek is NULL, we provide our default version.
2422 packet_seek
= ctf_packet_seek
;
2424 td
= g_new0(struct ctf_trace
, 1);
2428 init_trace_descriptor(&td
->parent
);
2430 switch (flags
& O_ACCMODE
) {
2433 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2436 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2441 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2444 fprintf(stderr
, "[error] Incorrect open flags.\n");
2448 ret
= trace_debug_info_create(td
);
2456 trace_debug_info_destroy(td
);
2463 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2464 struct bt_mmap_stream
*mmap_info
)
2466 pos
->mmap_offset
= 0;
2467 pos
->packet_size
= 0;
2468 pos
->content_size
= 0;
2469 pos
->content_size_loc
= NULL
;
2470 pos
->fd
= mmap_info
->fd
;
2471 pos
->base_mma
= NULL
;
2475 pos
->prot
= PROT_READ
;
2476 pos
->flags
= MAP_PRIVATE
;
2477 pos
->parent
.rw_table
= read_dispatch_table
;
2478 pos
->parent
.event_cb
= ctf_read_event
;
2479 pos
->priv
= mmap_info
->priv
;
2480 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2481 sizeof(struct packet_index
));
2485 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2486 struct ctf_file_stream
*file_stream
,
2487 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2490 struct ctf_stream_declaration
*stream
;
2494 /* Ask for the first packet to get the stream_id. */
2495 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2496 ret
= bt_packet_seek_get_error();
2500 stream_id
= file_stream
->parent
.stream_id
;
2501 if (stream_id
>= td
->streams
->len
) {
2502 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2503 "in metadata.\n", stream_id
);
2507 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2509 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2510 "in metadata.\n", stream_id
);
2514 file_stream
->parent
.stream_class
= stream
;
2515 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2521 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2522 struct bt_mmap_stream
*mmap_info
,
2523 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2527 struct ctf_file_stream
*file_stream
;
2529 file_stream
= g_new0(struct ctf_file_stream
, 1);
2530 file_stream
->parent
.stream_id
= -1ULL;
2531 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2532 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2534 file_stream
->pos
.packet_seek
= packet_seek
;
2536 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2541 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2546 * For now, only a single clock per trace is supported.
2548 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2550 /* Add stream file to stream class */
2551 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2552 &file_stream
->parent
);
2556 if (file_stream
->parent
.trace_packet_header
)
2557 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2559 g_free(file_stream
);
2564 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2565 struct bt_mmap_stream_list
*mmap_list
,
2566 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2571 struct bt_mmap_stream
*mmap_info
;
2573 td
->scanner
= ctf_scanner_alloc();
2575 fprintf(stderr
, "[error] Error allocating scanner\n");
2579 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2581 if (ret
== -ENOENT
) {
2582 fprintf(stderr
, "[warning] Empty metadata.\n");
2588 * for each stream, try to open, check magic number, and get the
2589 * stream ID to add to the right location in the stream array.
2591 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2592 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2594 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2601 ctf_scanner_free(td
->scanner
);
2606 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2607 struct bt_mmap_stream_list
*mmap_list
,
2608 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2612 struct ctf_trace
*td
;
2616 fprintf(stderr
, "[error] No metadata file pointer associated, "
2617 "required for mmap parsing\n");
2621 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2624 td
= g_new0(struct ctf_trace
, 1);
2626 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2630 ret
= trace_debug_info_create(td
);
2643 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2646 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2652 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2655 /* for each stream_class */
2656 for (i
= 0; i
< td
->streams
->len
; i
++) {
2657 struct ctf_stream_declaration
*stream_class
;
2659 stream_class
= g_ptr_array_index(td
->streams
, i
);
2662 /* for each stream */
2663 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2664 struct ctf_stream_definition
*stream
;
2666 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2669 ret
= copy_event_declarations_stream_class_to_stream(td
,
2670 stream_class
, stream
);
2679 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2682 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2684 /* for each stream_class */
2685 for (i
= 0; i
< td
->streams
->len
; i
++) {
2686 struct ctf_stream_declaration
*stream_class
;
2688 stream_class
= g_ptr_array_index(td
->streams
, i
);
2691 /* for each file_stream */
2692 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2693 struct ctf_stream_definition
*stream
;
2694 struct ctf_stream_pos
*stream_pos
;
2695 struct ctf_file_stream
*cfs
;
2697 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2700 cfs
= container_of(stream
, struct ctf_file_stream
,
2702 stream_pos
= &cfs
->pos
;
2703 if (!stream_pos
->packet_index
)
2706 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2707 struct packet_index
*index
;
2709 index
= &g_array_index(stream_pos
->packet_index
,
2710 struct packet_index
, k
);
2711 index
->ts_real
.timestamp_begin
=
2712 ctf_get_real_timestamp(stream
,
2713 index
->ts_cycles
.timestamp_begin
);
2714 index
->ts_real
.timestamp_end
=
2715 ctf_get_real_timestamp(stream
,
2716 index
->ts_cycles
.timestamp_end
);
2724 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2728 ret
= ctf_fini_pos(&file_stream
->pos
);
2730 fprintf(stderr
, "Error on ctf_fini_pos\n");
2733 if (file_stream
->pos
.fd
>= 0) {
2734 ret
= close(file_stream
->pos
.fd
);
2736 perror("Error closing file fd");
2744 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2746 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2752 for (i
= 0; i
< td
->streams
->len
; i
++) {
2753 struct ctf_stream_declaration
*stream
;
2756 stream
= g_ptr_array_index(td
->streams
, i
);
2759 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2760 struct ctf_file_stream
*file_stream
;
2761 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2762 struct ctf_file_stream
, parent
);
2763 ret
= ctf_close_file_stream(file_stream
);
2769 ctf_destroy_metadata(td
);
2770 ctf_scanner_free(td
->scanner
);
2771 if (td
->dirfd
>= 0) {
2772 ret
= close(td
->dirfd
);
2774 perror("Error closing dirfd");
2779 ret
= closedir(td
->dir
);
2781 perror("Error closedir");
2785 free(td
->metadata_string
);
2786 trace_debug_info_destroy(td
);
2792 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2793 struct bt_context
*ctx
)
2795 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2798 td
->parent
.ctx
= ctx
;
2802 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2803 struct bt_trace_handle
*handle
)
2805 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2808 td
->parent
.handle
= handle
;
2812 void __attribute__((constructor
)) ctf_init(void)
2816 ctf_format
.name
= g_quark_from_static_string("ctf");
2817 ret
= bt_register_format(&ctf_format
);
2822 void __attribute__((destructor
)) ctf_exit(void)
2824 bt_unregister_format(&ctf_format
);