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 void ctf_print_truncated_packet(FILE *fp
, struct ctf_stream_definition
*stream
,
482 uint64_t packet_size
, uint64_t remaining_file_size
)
484 fprintf(fp
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits) in trace with UUID \"",
485 packet_size
, remaining_file_size
);
486 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
489 if (stream
->stream_class
->trace
->parent
.path
[0] != '\0') {
490 fprintf(fp
, ", at path: \"%s\"",
491 stream
->stream_class
->trace
->parent
.path
);
494 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
495 if (stream
->path
[0] != '\0') {
496 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
504 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
506 struct ctf_stream_pos
*pos
=
507 container_of(ppos
, struct ctf_stream_pos
, parent
);
508 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
509 struct ctf_event_definition
*event
;
513 /* We need to check for EOF here for empty files. */
514 if (unlikely(pos
->offset
== EOF
))
517 ret
= ctf_pos_get_event(pos
);
518 if (ret
== -BT_PACKET_SEEK_ERROR_TRUNCATED_PACKET
) {
524 /* save the current position as a restore point */
525 pos
->last_offset
= pos
->offset
;
528 * This is the EOF check after we've advanced the position in
531 if (unlikely(pos
->offset
== EOF
))
534 /* Stream is inactive for now (live reading). */
535 if (unlikely(pos
->content_size
== 0))
539 * Packet seeked to by ctf_pos_get_event() only contains
540 * headers, no event. Consider stream as inactive (live
543 if (unlikely(pos
->data_offset
== pos
->content_size
))
546 assert(pos
->offset
< pos
->content_size
);
548 /* Read event header */
549 if (likely(stream
->stream_event_header
)) {
550 struct definition_integer
*integer_definition
;
551 struct bt_definition
*variant
;
553 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
556 /* lookup event id */
557 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
558 if (integer_definition
) {
559 id
= integer_definition
->value
._unsigned
;
561 struct definition_enum
*enum_definition
;
563 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
564 if (enum_definition
) {
565 id
= enum_definition
->integer
->value
._unsigned
;
569 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
571 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
572 if (integer_definition
) {
573 id
= integer_definition
->value
._unsigned
;
576 stream
->event_id
= id
;
578 /* lookup timestamp */
579 stream
->has_timestamp
= 0;
580 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
581 if (integer_definition
) {
582 ctf_update_timestamp(stream
, integer_definition
);
583 stream
->has_timestamp
= 1;
586 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
587 if (integer_definition
) {
588 ctf_update_timestamp(stream
, integer_definition
);
589 stream
->has_timestamp
= 1;
595 /* Read stream-declared event context */
596 if (stream
->stream_event_context
) {
597 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
602 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
603 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
606 event
= g_ptr_array_index(stream
->events_by_id
, id
);
607 if (unlikely(!event
)) {
608 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
612 /* Read event-declared event context */
613 if (event
->event_context
) {
614 ret
= generic_rw(ppos
, &event
->event_context
->p
);
619 /* Read event payload */
620 if (likely(event
->event_fields
)) {
621 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
626 if (pos
->last_offset
== pos
->offset
) {
627 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
634 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
639 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
641 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
642 struct ctf_event_definition
*event
;
646 id
= stream
->event_id
;
648 /* print event header */
649 if (likely(stream
->stream_event_header
)) {
650 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
655 /* print stream-declared event context */
656 if (stream
->stream_event_context
) {
657 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
662 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
663 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
666 event
= g_ptr_array_index(stream
->events_by_id
, id
);
667 if (unlikely(!event
)) {
668 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
672 /* print event-declared event context */
673 if (event
->event_context
) {
674 ret
= generic_rw(pos
, &event
->event_context
->p
);
679 /* Read and print event payload */
680 if (likely(event
->event_fields
)) {
681 ret
= generic_rw(pos
, &event
->event_fields
->p
);
689 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
694 * One side-effect of this function is to unmap pos mmap base if one is
698 int find_data_offset(struct ctf_stream_pos
*pos
,
699 struct ctf_file_stream
*file_stream
,
700 struct packet_index
*packet_index
)
702 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
703 struct stat filestats
;
707 pos
= &file_stream
->pos
;
709 ret
= fstat(pos
->fd
, &filestats
);
712 filesize
= filestats
.st_size
;
714 /* Deal with empty files */
720 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
721 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
726 ret
= munmap_align(pos
->base_mma
);
728 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
732 pos
->base_mma
= NULL
;
734 /* map new base. Need mapping length from header. */
735 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
736 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
737 assert(pos
->base_mma
!= MAP_FAILED
);
739 pos
->content_size
= packet_map_len
;
740 pos
->packet_size
= packet_map_len
;
741 pos
->offset
= 0; /* Position of the packet header */
743 /* update trace_packet_header and stream_packet_context */
744 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
745 /* Read packet header */
746 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
752 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
753 /* Read packet context */
754 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
760 packet_index
->data_offset
= pos
->offset
;
763 ret
= munmap_align(pos
->base_mma
);
765 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
769 pos
->base_mma
= NULL
;
773 /* Retry with larger mapping */
775 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
777 * Reached EOF, but still expecting header/context data.
779 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
782 /* Double the mapping len, and retry */
783 tmp_map_len
= packet_map_len
<< 1;
784 if (tmp_map_len
>> 1 != packet_map_len
) {
786 fprintf(stderr
, "[error] Packet mapping length overflow\n");
789 packet_map_len
= tmp_map_len
;
794 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
795 int fd
, int open_flags
)
799 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
800 sizeof(struct packet_index
));
802 pos
->packet_index
= NULL
;
804 switch (open_flags
& O_ACCMODE
) {
806 pos
->prot
= PROT_READ
;
807 pos
->flags
= MAP_PRIVATE
;
808 pos
->parent
.rw_table
= read_dispatch_table
;
809 pos
->parent
.event_cb
= ctf_read_event
;
810 pos
->parent
.trace
= trace
;
813 pos
->prot
= PROT_READ
| PROT_WRITE
;
814 pos
->flags
= MAP_SHARED
;
815 pos
->parent
.rw_table
= write_dispatch_table
;
816 pos
->parent
.event_cb
= ctf_write_event
;
817 pos
->parent
.trace
= trace
;
825 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
827 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
828 *pos
->content_size_loc
= pos
->offset
;
833 ret
= munmap_align(pos
->base_mma
);
835 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
840 if (pos
->packet_index
)
841 (void) g_array_free(pos
->packet_index
, TRUE
);
845 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
846 struct packet_index
*prev_index
,
847 struct packet_index
*cur_index
)
849 uint64_t events_discarded_diff
;
850 uint64_t packets_lost_diff
= 0;
852 /* Update packet index time information */
854 /* Current packet begin/end */
855 stream
->current
.real
.begin
=
856 cur_index
->ts_real
.timestamp_begin
;
857 stream
->current
.cycles
.begin
=
858 cur_index
->ts_cycles
.timestamp_begin
;
859 stream
->current
.real
.end
=
860 cur_index
->ts_real
.timestamp_end
;
861 stream
->current
.cycles
.end
=
862 cur_index
->ts_cycles
.timestamp_end
;
864 /* Update packet index discarded event information */
865 events_discarded_diff
= cur_index
->events_discarded
;
867 /* Previous packet begin/end */
868 stream
->prev
.cycles
.begin
=
869 prev_index
->ts_cycles
.timestamp_begin
;
870 stream
->prev
.real
.begin
=
871 prev_index
->ts_real
.timestamp_begin
;
872 stream
->prev
.cycles
.end
=
873 prev_index
->ts_cycles
.timestamp_end
;
874 stream
->prev
.real
.end
=
875 prev_index
->ts_real
.timestamp_end
;
877 events_discarded_diff
-= prev_index
->events_discarded
;
878 /* packet_seq_num stays at 0 if not produced by the tracer */
879 if (cur_index
->packet_seq_num
) {
880 packets_lost_diff
= cur_index
->packet_seq_num
-
881 prev_index
->packet_seq_num
- 1;
884 * Deal with 32-bit wrap-around if the tracer provided a
887 if (prev_index
->events_discarded_len
== 32) {
888 events_discarded_diff
= (uint32_t) events_discarded_diff
;
892 * First packet: use current packet info as limits for
895 stream
->prev
.cycles
.begin
=
896 stream
->prev
.cycles
.end
=
897 stream
->current
.cycles
.begin
;
898 stream
->prev
.real
.begin
=
899 stream
->prev
.real
.end
=
900 stream
->current
.real
.begin
;
902 stream
->events_discarded
= events_discarded_diff
;
903 stream
->packets_lost
= packets_lost_diff
;
907 * Find the timerange where all the streams in the trace are active
910 * Return 0 and update begin/end if necessary on success, return 1 for
911 * empty streams and return a negative value on error.
914 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
915 struct packet_index_time
*_real
,
916 struct packet_index_time
*_cycles
)
918 int stream_id
, ret
= 0;
919 struct packet_index_time real
= { 0, UINT64_MAX
},
920 cycles
= { 0, UINT64_MAX
};
921 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
923 /* At least one of the two return args must be provided. */
924 if (!_real
&& !_cycles
) {
929 if (tin
->streams
->len
== 0) {
934 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
937 struct ctf_stream_declaration
*stream_class
;
939 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
943 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
944 struct ctf_file_stream
*file_stream
;
945 struct ctf_stream_pos
*stream_pos
;
946 struct packet_index
*index
;
948 file_stream
= g_ptr_array_index(stream_class
->streams
,
953 stream_pos
= &file_stream
->pos
;
954 if (!stream_pos
->packet_index
||
955 stream_pos
->packet_index
->len
<= 0) {
959 index
= &g_array_index(stream_pos
->packet_index
,
960 struct packet_index
, 0);
961 real
.timestamp_begin
= max(real
.timestamp_begin
,
962 index
->ts_real
.timestamp_begin
);
963 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
964 index
->ts_cycles
.timestamp_begin
);
966 index
= &g_array_index(stream_pos
->packet_index
,
968 stream_pos
->packet_index
->len
- 1);
969 real
.timestamp_end
= min(real
.timestamp_end
,
970 index
->ts_real
.timestamp_end
);
971 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
972 index
->ts_cycles
.timestamp_end
);
988 * Find the union of all active regions in the trace collection's traces.
989 * Returns "real" timestamps.
991 * Return 0 on success.
992 * Return 1 if no intersections are found.
993 * Return a negative value on error.
995 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
996 uint64_t *_ts_begin
, uint64_t *_ts_end
)
999 uint64_t ts_begin
= UINT64_MAX
, ts_end
= 0;
1001 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
1006 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1007 struct bt_trace_descriptor
*td_read
;
1008 struct packet_index_time intersection_real
;
1010 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1014 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1017 /* Empty trace or no stream intersection. */
1019 } else if (ret
< 0) {
1023 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
1024 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
1027 if (ts_end
< ts_begin
) {
1031 *_ts_begin
= ts_begin
;
1037 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1041 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1046 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1047 struct bt_trace_descriptor
*td_read
;
1048 struct packet_index_time intersection_real
;
1050 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1055 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1058 /* Empty trace or no stream intersection. */
1060 } else if (ret
< 0) {
1064 td_read
->interval_real
= intersection_real
;
1065 td_read
->interval_set
= true;
1072 * for SEEK_CUR: go to next packet.
1073 * for SEEK_SET: go to packet numer (index).
1075 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1077 struct ctf_stream_pos
*pos
=
1078 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1079 struct ctf_file_stream
*file_stream
=
1080 container_of(pos
, struct ctf_file_stream
, pos
);
1082 struct packet_index
*packet_index
, *prev_index
;
1086 case SEEK_SET
: /* Fall-through */
1089 ret
= -BT_PACKET_SEEK_ERROR
;
1093 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1094 *pos
->content_size_loc
= pos
->offset
;
1096 if (pos
->base_mma
) {
1097 /* unmap old base */
1098 ret
= munmap_align(pos
->base_mma
);
1100 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1102 ret
= -BT_PACKET_SEEK_ERROR
;
1105 pos
->base_mma
= NULL
;
1109 * The caller should never ask for ctf_move_pos across packets,
1110 * except to get exactly at the beginning of the next packet.
1112 if (pos
->prot
& PROT_WRITE
) {
1115 /* The writer will add padding */
1116 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1119 assert(index
== 0); /* only seek supported for now */
1123 ret
= -BT_PACKET_SEEK_ERROR
;
1126 pos
->content_size
= -1U; /* Unknown at this point */
1127 pos
->packet_size
= WRITE_PACKET_LEN
;
1129 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1130 pos
->packet_size
/ CHAR_BIT
);
1131 } while (ret
== EINTR
);
1135 uint64_t remaining_file_size
;
1140 if (pos
->offset
== EOF
) {
1144 assert(pos
->cur_index
< pos
->packet_index
->len
);
1145 /* The reader will expect us to skip padding */
1150 if (index
>= pos
->packet_index
->len
) {
1155 pos
->cur_index
= index
;
1158 ret
= -BT_PACKET_SEEK_ERROR
;
1162 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1168 packet_index
= &g_array_index(pos
->packet_index
,
1169 struct packet_index
, pos
->cur_index
);
1170 if (pos
->cur_index
> 0) {
1171 prev_index
= &g_array_index(pos
->packet_index
,
1172 struct packet_index
,
1173 pos
->cur_index
- 1);
1177 ctf_update_current_packet_index(&file_stream
->parent
,
1178 prev_index
, packet_index
);
1180 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1187 * We need to check if we are in trace read or called
1188 * from packet indexing. In this last case, the
1189 * collection is not there, so we cannot print the
1192 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1193 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1196 packet_index
= &g_array_index(pos
->packet_index
,
1197 struct packet_index
,
1199 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1201 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1203 /* Lookup context/packet size in index */
1204 if (packet_index
->data_offset
== -1) {
1205 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1207 ret
= -BT_PACKET_SEEK_ERROR
;
1212 remaining_file_size
= (pos
->file_length
- ((uint64_t) packet_index
->offset
)) * CHAR_BIT
;
1213 if (packet_index
->packet_size
> remaining_file_size
) {
1215 ctf_print_truncated_packet(stderr
, &file_stream
->parent
,
1216 packet_index
->packet_size
,
1217 remaining_file_size
);
1219 ret
= -BT_PACKET_SEEK_ERROR_TRUNCATED_PACKET
;
1223 pos
->content_size
= packet_index
->content_size
;
1224 pos
->packet_size
= packet_index
->packet_size
;
1225 pos
->mmap_offset
= packet_index
->offset
;
1226 pos
->data_offset
= packet_index
->data_offset
;
1227 if (pos
->data_offset
< packet_index
->content_size
) {
1228 pos
->offset
= 0; /* will read headers */
1229 } else if (pos
->data_offset
== packet_index
->content_size
) {
1231 pos
->offset
= packet_index
->data_offset
;
1233 goto read_next_packet
;
1240 /* map new base. Need mapping length from header. */
1241 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1242 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1243 if (pos
->base_mma
== MAP_FAILED
) {
1244 fprintf(stderr
, "[error] mmap error %s.\n",
1249 /* update trace_packet_header and stream_packet_context */
1250 if (!(pos
->prot
& PROT_WRITE
) &&
1251 file_stream
->parent
.trace_packet_header
) {
1252 /* Read packet header */
1253 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1256 if (!(pos
->prot
& PROT_WRITE
) &&
1257 file_stream
->parent
.stream_packet_context
) {
1258 /* Read packet context */
1259 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1264 bt_packet_seek_set_error(ret
);
1268 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1274 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1278 if (magic
== TSDL_MAGIC
) {
1280 td
->byte_order
= BYTE_ORDER
;
1281 CTF_TRACE_SET_FIELD(td
, byte_order
);
1282 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1284 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1285 LITTLE_ENDIAN
: BIG_ENDIAN
;
1286 CTF_TRACE_SET_FIELD(td
, byte_order
);
1294 * Returns 0 on success, -1 on error.
1297 int check_version(unsigned int major
, unsigned int minor
)
1312 /* eventually return an error instead of warning */
1314 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1320 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1323 struct metadata_packet_header header
;
1324 size_t readlen
, writelen
, toread
;
1325 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1328 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1332 if (td
->byte_order
!= BYTE_ORDER
) {
1333 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1334 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1335 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1336 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1338 if (header
.checksum
)
1339 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1340 if (header
.compression_scheme
) {
1341 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1342 header
.compression_scheme
);
1345 if (header
.encryption_scheme
) {
1346 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1347 header
.encryption_scheme
);
1350 if (header
.checksum_scheme
) {
1351 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1352 header
.checksum_scheme
);
1355 if (check_version(header
.major
, header
.minor
) < 0)
1357 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1358 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1359 CTF_TRACE_SET_FIELD(td
, uuid
);
1361 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1365 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1368 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1371 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1376 if (babeltrace_debug
) {
1377 buf
[readlen
] = '\0';
1378 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1382 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1383 if (writelen
< readlen
) {
1393 ret
= 0; /* continue reading next packet */
1400 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1401 ret
= fseek(in
, toread
, SEEK_CUR
);
1403 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1410 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1414 size_t size
, buflen
;
1419 * Using strlen on *buf instead of size of open_memstream
1420 * because its size includes garbage at the end (after final
1421 * \0). This is the allocated size, not the actual string size.
1423 out
= babeltrace_open_memstream(buf
, &size
);
1425 perror("Metadata open_memstream");
1429 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1438 /* close to flush the buffer */
1439 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1443 perror("babeltrace_flush_memstream");
1445 closeret
= fclose(in
);
1447 perror("Error in fclose");
1453 perror("Error in fclose");
1455 /* open for reading */
1456 buflen
= strlen(*buf
);
1461 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1463 perror("Metadata fmemopen");
1470 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1471 struct ctf_scanner
*scanner
, int append
)
1473 struct ctf_file_stream
*metadata_stream
;
1476 int ret
= 0, closeret
;
1478 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1479 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1483 metadata_stream
->pos
.fd
= -1;
1485 td
->metadata
= &metadata_stream
->parent
;
1486 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1487 if (metadata_stream
->pos
.fd
< 0) {
1488 fprintf(stderr
, "Unable to open metadata.\n");
1493 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1495 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1496 perror("Metadata stream open");
1500 /* fd now belongs to fp */
1501 metadata_stream
->pos
.fd
= -1;
1503 if (babeltrace_debug
)
1506 if (packet_metadata(td
, fp
)) {
1507 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1511 td
->metadata_string
= buf
;
1512 td
->metadata_packetized
= 1;
1515 unsigned int major
, minor
;
1518 td
->byte_order
= BYTE_ORDER
;
1520 /* Check text-only metadata header and version */
1521 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1523 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1524 if (check_version(major
, minor
) < 0) {
1532 ret
= ctf_scanner_append_ast(scanner
, fp
);
1534 fprintf(stderr
, "[error] Error creating AST\n");
1538 if (babeltrace_debug
) {
1539 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1541 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1546 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1548 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1551 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1552 td
, td
->byte_order
);
1554 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1559 closeret
= fclose(fp
);
1561 perror("Error on fclose");
1565 if (metadata_stream
->pos
.fd
>= 0) {
1566 closeret
= close(metadata_stream
->pos
.fd
);
1568 perror("Error on metadata stream fd close");
1573 g_free(metadata_stream
);
1578 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1579 struct ctf_stream_definition
*stream
,
1580 struct ctf_event_declaration
*event
)
1582 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1584 if (event
->context_decl
) {
1585 struct bt_definition
*definition
=
1586 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1587 stream
->parent_def_scope
, 0, 0, "event.context");
1591 stream_event
->event_context
= container_of(definition
,
1592 struct definition_struct
, p
);
1593 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1595 if (event
->fields_decl
) {
1596 struct bt_definition
*definition
=
1597 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1598 stream
->parent_def_scope
, 0, 0, "event.fields");
1602 stream_event
->event_fields
= container_of(definition
,
1603 struct definition_struct
, p
);
1604 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1606 stream_event
->stream
= stream
;
1607 return stream_event
;
1610 if (stream_event
->event_fields
)
1611 bt_definition_unref(&stream_event
->event_fields
->p
);
1612 if (stream_event
->event_context
)
1613 bt_definition_unref(&stream_event
->event_context
->p
);
1614 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1615 g_quark_to_string(event
->name
));
1620 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1621 struct ctf_stream_declaration
*stream_class
,
1622 struct ctf_stream_definition
*stream
)
1624 size_t def_size
, class_size
, i
;
1627 def_size
= stream
->events_by_id
->len
;
1628 class_size
= stream_class
->events_by_id
->len
;
1630 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1631 for (i
= def_size
; i
< class_size
; i
++) {
1632 struct ctf_event_declaration
*event
=
1633 g_ptr_array_index(stream_class
->events_by_id
, i
);
1634 struct ctf_event_definition
*stream_event
;
1638 stream_event
= create_event_definitions(td
, stream
, event
);
1639 if (!stream_event
) {
1643 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1650 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1652 struct ctf_stream_declaration
*stream_class
;
1656 if (stream
->stream_definitions_created
)
1659 stream_class
= stream
->stream_class
;
1661 if (stream_class
->packet_context_decl
) {
1662 struct bt_definition
*definition
=
1663 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1664 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1669 stream
->stream_packet_context
= container_of(definition
,
1670 struct definition_struct
, p
);
1671 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1673 if (stream_class
->event_header_decl
) {
1674 struct bt_definition
*definition
=
1675 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1676 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1681 stream
->stream_event_header
=
1682 container_of(definition
, struct definition_struct
, p
);
1683 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1685 if (stream_class
->event_context_decl
) {
1686 struct bt_definition
*definition
=
1687 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1688 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1693 stream
->stream_event_context
=
1694 container_of(definition
, struct definition_struct
, p
);
1695 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1697 stream
->events_by_id
= g_ptr_array_new();
1698 ret
= copy_event_declarations_stream_class_to_stream(td
,
1699 stream_class
, stream
);
1705 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1706 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1708 g_free(stream_event
);
1710 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1712 if (stream
->stream_event_context
)
1713 bt_definition_unref(&stream
->stream_event_context
->p
);
1714 if (stream
->stream_event_header
)
1715 bt_definition_unref(&stream
->stream_event_header
->p
);
1716 if (stream
->stream_packet_context
)
1717 bt_definition_unref(&stream
->stream_packet_context
->p
);
1718 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1719 stream_class
->stream_id
, strerror(-ret
));
1724 int stream_assign_class(struct ctf_trace
*td
,
1725 struct ctf_file_stream
*file_stream
,
1728 struct ctf_stream_declaration
*stream
;
1731 file_stream
->parent
.stream_id
= stream_id
;
1732 if (stream_id
>= td
->streams
->len
) {
1733 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1736 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1738 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1741 file_stream
->parent
.stream_class
= stream
;
1742 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1749 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1750 struct ctf_trace
*td
,
1751 struct ctf_file_stream
*file_stream
)
1753 struct packet_index packet_index
;
1754 uint64_t stream_id
= 0;
1755 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1756 int first_packet
= 0;
1761 memset(&packet_index
, 0, sizeof(packet_index
));
1762 if (!pos
->mmap_offset
) {
1766 if (pos
->file_length
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1767 packet_map_len
= (pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1770 if (pos
->base_mma
) {
1771 /* unmap old base */
1772 ret
= munmap_align(pos
->base_mma
);
1774 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1778 pos
->base_mma
= NULL
;
1780 /* map new base. Need mapping length from header. */
1781 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1782 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1783 assert(pos
->base_mma
!= MAP_FAILED
);
1785 * Use current mapping size as temporary content and packet
1788 pos
->content_size
= packet_map_len
;
1789 pos
->packet_size
= packet_map_len
;
1790 pos
->offset
= 0; /* Position of the packet header */
1792 packet_index
.offset
= pos
->mmap_offset
;
1794 /* read and check header, set stream id (and check) */
1795 if (file_stream
->parent
.trace_packet_header
) {
1796 /* Read packet header */
1797 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1801 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1804 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1805 if (len_index
>= 0) {
1806 struct bt_definition
*field
;
1809 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1810 magic
= bt_get_unsigned_int(field
);
1811 if (magic
!= CTF_MAGIC
) {
1812 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1814 file_stream
->pos
.packet_index
->len
,
1815 (ssize_t
) pos
->mmap_offset
);
1821 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1822 if (len_index
>= 0) {
1823 struct definition_array
*defarray
;
1824 struct bt_definition
*field
;
1826 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1828 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1829 assert(field
->declaration
->id
== CTF_TYPE_ARRAY
);
1830 defarray
= container_of(field
, struct definition_array
, p
);
1831 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1833 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1834 struct bt_definition
*elem
;
1836 elem
= bt_array_index(defarray
, i
);
1837 uuidval
[i
] = bt_get_unsigned_int(elem
);
1839 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1841 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1846 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1847 if (len_index
>= 0) {
1848 struct bt_definition
*field
;
1850 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1851 stream_id
= bt_get_unsigned_int(field
);
1855 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1856 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1858 file_stream
->parent
.stream_id
);
1862 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1867 if (file_stream
->parent
.stream_packet_context
) {
1868 /* Read packet context */
1869 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1873 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1876 /* read packet size from header */
1877 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1878 if (len_index
>= 0) {
1879 struct bt_definition
*field
;
1881 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1882 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1884 /* Use file size for packet size */
1885 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1888 /* read content size from header */
1889 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1890 if (len_index
>= 0) {
1891 struct bt_definition
*field
;
1893 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1894 packet_index
.content_size
= bt_get_unsigned_int(field
);
1896 /* Use packet size if non-zero, else file size */
1897 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1900 /* read timestamp begin from header */
1901 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1902 if (len_index
>= 0) {
1903 struct bt_definition
*field
;
1905 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1906 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1907 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1908 packet_index
.ts_real
.timestamp_begin
=
1909 ctf_get_real_timestamp(
1910 &file_stream
->parent
,
1911 packet_index
.ts_cycles
.timestamp_begin
);
1915 /* read timestamp end from header */
1916 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1917 if (len_index
>= 0) {
1918 struct bt_definition
*field
;
1920 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1921 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1922 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1923 packet_index
.ts_real
.timestamp_end
=
1924 ctf_get_real_timestamp(
1925 &file_stream
->parent
,
1926 packet_index
.ts_cycles
.timestamp_end
);
1930 /* read events discarded from header */
1931 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1932 if (len_index
>= 0) {
1933 struct bt_definition
*field
;
1935 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1936 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1937 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1940 /* read packet_seq_num from header */
1941 len_index
= bt_struct_declaration_lookup_field_index(
1942 file_stream
->parent
.stream_packet_context
->declaration
,
1943 g_quark_from_static_string("packet_seq_num"));
1944 if (len_index
>= 0) {
1945 struct bt_definition
*field
;
1947 field
= bt_struct_definition_get_field_from_index(
1948 file_stream
->parent
.stream_packet_context
,
1950 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1953 /* Use file size for packet size */
1954 packet_index
.packet_size
= pos
->file_length
* CHAR_BIT
;
1955 /* Use packet size if non-zero, else file size */
1956 packet_index
.content_size
= packet_index
.packet_size
? : pos
->file_length
* CHAR_BIT
;
1959 /* Validate content size and packet size values */
1960 if (packet_index
.content_size
> packet_index
.packet_size
) {
1961 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1962 packet_index
.content_size
, packet_index
.packet_size
);
1966 if (packet_index
.content_size
< pos
->offset
) {
1967 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1971 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1972 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1976 /* Save position after header and context */
1977 packet_index
.data_offset
= pos
->offset
;
1979 /* add index to packet array */
1980 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1982 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1986 /* Retry with larger mapping */
1988 if (packet_map_len
== ((pos
->file_length
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1990 * Reached EOF, but still expecting header/context data.
1992 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1995 /* Double the mapping len, and retry */
1996 tmp_map_len
= packet_map_len
<< 1;
1997 if (tmp_map_len
>> 1 != packet_map_len
) {
1999 fprintf(stderr
, "[error] Packet mapping length overflow\n");
2002 packet_map_len
= tmp_map_len
;
2007 int create_stream_packet_index(struct ctf_trace
*td
,
2008 struct ctf_file_stream
*file_stream
)
2010 struct ctf_stream_pos
*pos
;
2013 pos
= &file_stream
->pos
;
2015 /* Deal with empty files */
2016 if (!pos
->file_length
) {
2017 if (file_stream
->parent
.trace_packet_header
2018 || file_stream
->parent
.stream_packet_context
) {
2020 * We expect a trace packet header and/or stream packet
2021 * context. Since a trace needs to have at least one
2022 * packet, empty files are therefore not accepted.
2024 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
2028 * Without trace packet header nor stream packet
2029 * context, a one-packet trace can indeed be empty. This
2030 * is only valid if there is only one stream class: 0.
2032 ret
= stream_assign_class(td
, file_stream
, 0);
2039 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< pos
->file_length
; ) {
2040 ret
= create_stream_one_packet_index(pos
, td
, file_stream
);
2048 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
2052 if (td
->packet_header_decl
) {
2053 struct bt_definition
*definition
=
2054 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
2055 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
2060 stream
->trace_packet_header
=
2061 container_of(definition
, struct definition_struct
, p
);
2062 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2068 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2073 int import_stream_packet_index(struct ctf_trace
*td
,
2074 struct ctf_file_stream
*file_stream
)
2076 struct ctf_stream_pos
*pos
;
2077 struct ctf_packet_index
*ctf_index
= NULL
;
2078 struct ctf_packet_index_file_hdr index_hdr
;
2079 struct packet_index index
;
2080 uint32_t packet_index_len
, index_minor
;
2082 int first_packet
= 1;
2085 pos
= &file_stream
->pos
;
2087 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2089 perror("read index file header");
2093 /* Check the index header */
2094 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2095 fprintf(stderr
, "[error] wrong index magic\n");
2099 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2100 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2101 ".%" PRIu32
", supported %d.%d\n",
2102 be32toh(index_hdr
.index_major
),
2103 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2108 index_minor
= be32toh(index_hdr
.index_minor
);
2110 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2111 if (packet_index_len
== 0) {
2112 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2117 * Allocate the index length found in header, not internal
2120 ctf_index
= g_malloc0(packet_index_len
);
2121 while (fread(ctf_index
, packet_index_len
, 1,
2122 pos
->index_fp
) == 1) {
2124 struct ctf_stream_declaration
*stream
= NULL
;
2126 memset(&index
, 0, sizeof(index
));
2127 index
.offset
= be64toh(ctf_index
->offset
);
2128 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2129 index
.content_size
= be64toh(ctf_index
->content_size
);
2130 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2131 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2132 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2133 index
.events_discarded_len
= 64;
2134 index
.data_offset
= -1;
2135 stream_id
= be64toh(ctf_index
->stream_id
);
2136 if (index_minor
>= 1) {
2137 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2138 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2141 if (!first_packet
) {
2142 /* add index to packet array */
2143 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2147 file_stream
->parent
.stream_id
= stream_id
;
2148 if (stream_id
< td
->streams
->len
) {
2149 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2152 fprintf(stderr
, "[error] Stream %" PRIu64
2153 " is not declared in metadata.\n",
2158 file_stream
->parent
.stream_class
= stream
;
2159 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2163 /* add index to packet array */
2164 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2167 /* Index containing only the header. */
2168 if (!file_stream
->parent
.stream_class
) {
2181 * Note: many file streams can inherit from the same stream class
2182 * description (metadata).
2185 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2186 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2189 int ret
, fd
, closeret
;
2190 struct ctf_file_stream
*file_stream
;
2191 struct stat statbuf
;
2194 fd
= openat(td
->dirfd
, path
, flags
);
2196 perror("File stream openat()");
2201 /* Don't try to mmap subdirectories. Skip them, return success. */
2202 ret
= fstat(fd
, &statbuf
);
2204 perror("File stream fstat()");
2207 if (S_ISDIR(statbuf
.st_mode
)) {
2208 if (strncmp(path
, "index", 5) != 0) {
2209 fprintf(stderr
, "[warning] Skipping directory '%s' "
2210 "found in trace\n", path
);
2215 if (!statbuf
.st_size
) {
2216 /** Skip empty files. */
2218 goto fd_is_empty_file
;
2221 file_stream
= g_new0(struct ctf_file_stream
, 1);
2222 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2223 file_stream
->pos
.fd
= -1;
2224 file_stream
->pos
.index_fp
= NULL
;
2225 file_stream
->pos
.file_length
= statbuf
.st_size
;
2227 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2228 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2231 file_stream
->pos
.packet_seek
= packet_seek
;
2233 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2238 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2241 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2245 * For now, only a single clock per trace is supported.
2247 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2250 * Allocate the index name for this stream and try to open it.
2252 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2254 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2258 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2261 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2262 ret
= create_stream_packet_index(td
, file_stream
);
2264 fprintf(stderr
, "[error] Stream index creation error.\n");
2268 ret
= openat(td
->dirfd
, index_name
, flags
);
2270 perror("Index file openat()");
2274 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2275 if (!file_stream
->pos
.index_fp
) {
2276 perror("fdopen() error");
2279 ret
= import_stream_packet_index(td
, file_stream
);
2284 ret
= fclose(file_stream
->pos
.index_fp
);
2286 perror("close index");
2292 /* Add stream file to stream class */
2293 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2294 &file_stream
->parent
);
2298 if (file_stream
->pos
.index_fp
) {
2299 ret
= fclose(file_stream
->pos
.index_fp
);
2301 perror("close index");
2304 if (file_stream
->parent
.trace_packet_header
)
2305 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2309 closeret
= ctf_fini_pos(&file_stream
->pos
);
2311 fprintf(stderr
, "Error on ctf_fini_pos\n");
2313 g_free(file_stream
);
2317 closeret
= close(fd
);
2319 perror("Error on fd close");
2326 int ctf_open_trace_read(struct ctf_trace
*td
,
2327 const char *path
, int flags
,
2328 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2329 int whence
), FILE *metadata_fp
)
2331 struct ctf_scanner
*scanner
;
2333 struct dirent
*dirent
;
2334 struct dirent
*diriter
;
2340 /* Open trace directory */
2341 td
->dir
= opendir(path
);
2343 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2348 td
->dirfd
= open(path
, 0);
2349 if (td
->dirfd
< 0) {
2350 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2351 perror("Trace directory open");
2355 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2356 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2359 * Keep the metadata file separate.
2360 * Keep scanner object local to the open. We don't support
2361 * incremental metadata append for on-disk traces.
2363 scanner
= ctf_scanner_alloc();
2365 fprintf(stderr
, "[error] Error allocating scanner\n");
2367 goto error_metadata
;
2369 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2370 ctf_scanner_free(scanner
);
2372 if (ret
== -ENOENT
) {
2373 fprintf(stderr
, "[warning] Empty metadata.\n");
2375 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2376 goto error_metadata
;
2380 * Open each stream: for each file, try to open, check magic
2381 * number, and get the stream ID to add to the right location in
2385 dirent_len
= offsetof(struct dirent
, d_name
) +
2386 fpathconf(td
->dirfd
, _PC_NAME_MAX
) + 1;
2388 dirent
= malloc(dirent_len
);
2391 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2393 fprintf(stderr
, "[error] Readdir error.\n");
2398 /* Ignore hidden files, ., .. and metadata. */
2399 if (!strncmp(diriter
->d_name
, ".", 1)
2400 || !strcmp(diriter
->d_name
, "..")
2401 || !strcmp(diriter
->d_name
, "metadata"))
2404 /* Ignore index files : *.idx */
2405 ext
= strrchr(diriter
->d_name
, '.');
2406 if (ext
&& (!strcmp(ext
, ".idx"))) {
2410 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2411 flags
, packet_seek
);
2413 fprintf(stderr
, "[error] Open file stream error.\n");
2424 closeret
= close(td
->dirfd
);
2426 perror("Error on fd close");
2429 closeret
= closedir(td
->dir
);
2431 perror("Error on closedir");
2438 * ctf_open_trace: Open a CTF trace and index it.
2439 * Note that the user must seek the trace after the open (using the iterator)
2440 * since the index creation read it entirely.
2443 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2444 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2445 int whence
), FILE *metadata_fp
)
2447 struct ctf_trace
*td
;
2451 * If packet_seek is NULL, we provide our default version.
2454 packet_seek
= ctf_packet_seek
;
2456 td
= g_new0(struct ctf_trace
, 1);
2460 init_trace_descriptor(&td
->parent
);
2462 switch (flags
& O_ACCMODE
) {
2465 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2468 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2473 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2476 fprintf(stderr
, "[error] Incorrect open flags.\n");
2480 ret
= trace_debug_info_create(td
);
2488 trace_debug_info_destroy(td
);
2495 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2496 struct bt_mmap_stream
*mmap_info
)
2498 pos
->mmap_offset
= 0;
2499 pos
->packet_size
= 0;
2500 pos
->content_size
= 0;
2501 pos
->content_size_loc
= NULL
;
2502 pos
->fd
= mmap_info
->fd
;
2503 pos
->base_mma
= NULL
;
2507 pos
->prot
= PROT_READ
;
2508 pos
->flags
= MAP_PRIVATE
;
2509 pos
->parent
.rw_table
= read_dispatch_table
;
2510 pos
->parent
.event_cb
= ctf_read_event
;
2511 pos
->priv
= mmap_info
->priv
;
2512 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2513 sizeof(struct packet_index
));
2517 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2518 struct ctf_file_stream
*file_stream
,
2519 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2522 struct ctf_stream_declaration
*stream
;
2526 /* Ask for the first packet to get the stream_id. */
2527 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2528 ret
= bt_packet_seek_get_error();
2532 stream_id
= file_stream
->parent
.stream_id
;
2533 if (stream_id
>= td
->streams
->len
) {
2534 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2535 "in metadata.\n", stream_id
);
2539 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2541 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2542 "in metadata.\n", stream_id
);
2546 file_stream
->parent
.stream_class
= stream
;
2547 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2553 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2554 struct bt_mmap_stream
*mmap_info
,
2555 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2559 struct ctf_file_stream
*file_stream
;
2561 file_stream
= g_new0(struct ctf_file_stream
, 1);
2562 file_stream
->parent
.stream_id
= -1ULL;
2563 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2564 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2566 file_stream
->pos
.packet_seek
= packet_seek
;
2568 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2573 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2578 * For now, only a single clock per trace is supported.
2580 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2582 /* Add stream file to stream class */
2583 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2584 &file_stream
->parent
);
2588 if (file_stream
->parent
.trace_packet_header
)
2589 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2591 g_free(file_stream
);
2596 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2597 struct bt_mmap_stream_list
*mmap_list
,
2598 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2603 struct bt_mmap_stream
*mmap_info
;
2605 td
->scanner
= ctf_scanner_alloc();
2607 fprintf(stderr
, "[error] Error allocating scanner\n");
2611 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2613 if (ret
== -ENOENT
) {
2614 fprintf(stderr
, "[warning] Empty metadata.\n");
2620 * for each stream, try to open, check magic number, and get the
2621 * stream ID to add to the right location in the stream array.
2623 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2624 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2626 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2633 ctf_scanner_free(td
->scanner
);
2638 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2639 struct bt_mmap_stream_list
*mmap_list
,
2640 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2644 struct ctf_trace
*td
;
2648 fprintf(stderr
, "[error] No metadata file pointer associated, "
2649 "required for mmap parsing\n");
2653 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2656 td
= g_new0(struct ctf_trace
, 1);
2658 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2662 ret
= trace_debug_info_create(td
);
2675 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2678 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2684 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2687 /* for each stream_class */
2688 for (i
= 0; i
< td
->streams
->len
; i
++) {
2689 struct ctf_stream_declaration
*stream_class
;
2691 stream_class
= g_ptr_array_index(td
->streams
, i
);
2694 /* for each stream */
2695 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2696 struct ctf_stream_definition
*stream
;
2698 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2701 ret
= copy_event_declarations_stream_class_to_stream(td
,
2702 stream_class
, stream
);
2711 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2714 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2716 /* for each stream_class */
2717 for (i
= 0; i
< td
->streams
->len
; i
++) {
2718 struct ctf_stream_declaration
*stream_class
;
2720 stream_class
= g_ptr_array_index(td
->streams
, i
);
2723 /* for each file_stream */
2724 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2725 struct ctf_stream_definition
*stream
;
2726 struct ctf_stream_pos
*stream_pos
;
2727 struct ctf_file_stream
*cfs
;
2729 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2732 cfs
= container_of(stream
, struct ctf_file_stream
,
2734 stream_pos
= &cfs
->pos
;
2735 if (!stream_pos
->packet_index
)
2738 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2739 struct packet_index
*index
;
2741 index
= &g_array_index(stream_pos
->packet_index
,
2742 struct packet_index
, k
);
2743 index
->ts_real
.timestamp_begin
=
2744 ctf_get_real_timestamp(stream
,
2745 index
->ts_cycles
.timestamp_begin
);
2746 index
->ts_real
.timestamp_end
=
2747 ctf_get_real_timestamp(stream
,
2748 index
->ts_cycles
.timestamp_end
);
2756 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2760 ret
= ctf_fini_pos(&file_stream
->pos
);
2762 fprintf(stderr
, "Error on ctf_fini_pos\n");
2765 if (file_stream
->pos
.fd
>= 0) {
2766 ret
= close(file_stream
->pos
.fd
);
2768 perror("Error closing file fd");
2776 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2778 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2784 for (i
= 0; i
< td
->streams
->len
; i
++) {
2785 struct ctf_stream_declaration
*stream
;
2788 stream
= g_ptr_array_index(td
->streams
, i
);
2791 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2792 struct ctf_file_stream
*file_stream
;
2793 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2794 struct ctf_file_stream
, parent
);
2795 ret
= ctf_close_file_stream(file_stream
);
2801 ctf_destroy_metadata(td
);
2802 ctf_scanner_free(td
->scanner
);
2803 if (td
->dirfd
>= 0) {
2804 ret
= close(td
->dirfd
);
2806 perror("Error closing dirfd");
2811 ret
= closedir(td
->dir
);
2813 perror("Error closedir");
2817 free(td
->metadata_string
);
2818 trace_debug_info_destroy(td
);
2824 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2825 struct bt_context
*ctx
)
2827 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2830 td
->parent
.ctx
= ctx
;
2834 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2835 struct bt_trace_handle
*handle
)
2837 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2840 td
->parent
.handle
= handle
;
2844 void __attribute__((constructor
)) ctf_init(void)
2848 ctf_format
.name
= g_quark_from_static_string("ctf");
2849 ret
= bt_register_format(&ctf_format
);
2854 void __attribute__((destructor
)) ctf_exit(void)
2856 bt_unregister_format(&ctf_format
);