2 * BabelTrace - Common Trace Format (CTF)
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/format.h>
30 #include <babeltrace/format-internal.h>
31 #include <babeltrace/ctf/types.h>
32 #include <babeltrace/ctf/metadata.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf/events-internal.h>
35 #include <babeltrace/trace-handle-internal.h>
36 #include <babeltrace/context-internal.h>
37 #include <babeltrace/compat/uuid.h>
38 #include <babeltrace/endian.h>
39 #include <babeltrace/trace-debug-info.h>
40 #include <babeltrace/ctf/ctf-index.h>
45 #include <sys/types.h>
53 #include "metadata/ctf-scanner.h"
54 #include "metadata/ctf-parser.h"
55 #include "metadata/ctf-ast.h"
56 #include "events-private.h"
57 #include <babeltrace/compat/memstream.h>
58 #include <babeltrace/compat/fcntl.h>
60 #define LOG2_CHAR_BIT 3
63 * Length of first attempt at mapping a packet header, in bits.
65 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
68 * Lenght of packet to write, in bits.
70 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
72 #define NSEC_PER_SEC 1000000000LL
74 #define INDEX_PATH "./index/%s.idx"
81 int64_t opt_clock_offset
;
82 int64_t opt_clock_offset_ns
;
85 char *opt_debug_info_dir
;
86 char *opt_debug_info_target_prefix
;
89 * TODO: babeltrace_ctf_console_output ensures that we only print
90 * discarded events when ctf-text plugin is used. Should be cleaned up
91 * with the plugin system redesign.
93 int babeltrace_ctf_console_output
;
96 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
97 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
101 struct bt_trace_descriptor
*ctf_open_mmap_trace(
102 struct bt_mmap_stream_list
*mmap_list
,
103 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
107 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
108 struct bt_context
*ctx
);
110 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
111 struct bt_trace_handle
*handle
);
114 int ctf_close_trace(struct bt_trace_descriptor
*descriptor
);
116 int ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
117 struct bt_trace_handle
*handle
, enum bt_clock_type type
,
120 int ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
121 struct bt_trace_handle
*handle
, enum bt_clock_type type
,
124 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
);
127 rw_dispatch read_dispatch_table
[] = {
128 [ BT_CTF_TYPE_ID_INTEGER
] = ctf_integer_read
,
129 [ BT_CTF_TYPE_ID_FLOAT
] = ctf_float_read
,
130 [ BT_CTF_TYPE_ID_ENUM
] = ctf_enum_read
,
131 [ BT_CTF_TYPE_ID_STRING
] = ctf_string_read
,
132 [ BT_CTF_TYPE_ID_STRUCT
] = ctf_struct_rw
,
133 [ BT_CTF_TYPE_ID_VARIANT
] = ctf_variant_rw
,
134 [ BT_CTF_TYPE_ID_ARRAY
] = ctf_array_read
,
135 [ BT_CTF_TYPE_ID_SEQUENCE
] = ctf_sequence_read
,
139 rw_dispatch write_dispatch_table
[] = {
140 [ BT_CTF_TYPE_ID_INTEGER
] = ctf_integer_write
,
141 [ BT_CTF_TYPE_ID_FLOAT
] = ctf_float_write
,
142 [ BT_CTF_TYPE_ID_ENUM
] = ctf_enum_write
,
143 [ BT_CTF_TYPE_ID_STRING
] = ctf_string_write
,
144 [ BT_CTF_TYPE_ID_STRUCT
] = ctf_struct_rw
,
145 [ BT_CTF_TYPE_ID_VARIANT
] = ctf_variant_rw
,
146 [ BT_CTF_TYPE_ID_ARRAY
] = ctf_array_write
,
147 [ BT_CTF_TYPE_ID_SEQUENCE
] = ctf_sequence_write
,
151 struct bt_format ctf_format
= {
152 .open_trace
= ctf_open_trace
,
153 .open_mmap_trace
= ctf_open_mmap_trace
,
154 .close_trace
= ctf_close_trace
,
155 .set_context
= ctf_set_context
,
156 .set_handle
= ctf_set_handle
,
157 .timestamp_begin
= ctf_timestamp_begin
,
158 .timestamp_end
= ctf_timestamp_end
,
159 .convert_index_timestamp
= ctf_convert_index_timestamp
,
163 int ctf_timestamp_begin(struct bt_trace_descriptor
*descriptor
,
164 struct bt_trace_handle
*handle
, enum bt_clock_type type
,
167 struct ctf_trace
*tin
;
168 int64_t begin
= LLONG_MAX
;
171 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
173 if (!tin
|| !timestamp
) {
178 /* for each stream_class */
179 for (i
= 0; i
< tin
->streams
->len
; i
++) {
180 struct ctf_stream_declaration
*stream_class
;
182 stream_class
= g_ptr_array_index(tin
->streams
, i
);
185 /* for each file_stream */
186 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
187 struct ctf_stream_definition
*stream
;
188 struct ctf_file_stream
*cfs
;
189 struct ctf_stream_pos
*stream_pos
;
190 struct packet_index
*index
;
192 stream
= g_ptr_array_index(stream_class
->streams
, j
);
193 cfs
= container_of(stream
, struct ctf_file_stream
,
195 stream_pos
= &cfs
->pos
;
197 if (!stream_pos
->packet_index
) {
202 if (stream_pos
->packet_index
->len
<= 0)
205 index
= &g_array_index(stream_pos
->packet_index
,
207 stream_pos
->packet_index
->len
- 1);
208 if (type
== BT_CLOCK_REAL
) {
209 if (index
->ts_real
.timestamp_begin
< begin
)
210 begin
= index
->ts_real
.timestamp_begin
;
211 } else if (type
== BT_CLOCK_CYCLES
) {
212 if (index
->ts_cycles
.timestamp_begin
< begin
)
213 begin
= index
->ts_cycles
.timestamp_begin
;
220 if (begin
== LLONG_MAX
) {
232 int ctf_timestamp_end(struct bt_trace_descriptor
*descriptor
,
233 struct bt_trace_handle
*handle
, enum bt_clock_type type
,
236 struct ctf_trace
*tin
;
237 int64_t end
= LLONG_MIN
;
240 tin
= container_of(descriptor
, struct ctf_trace
, parent
);
242 if (!tin
|| !timestamp
) {
247 /* for each stream_class */
248 for (i
= 0; i
< tin
->streams
->len
; i
++) {
249 struct ctf_stream_declaration
*stream_class
;
251 stream_class
= g_ptr_array_index(tin
->streams
, i
);
254 /* for each file_stream */
255 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
256 struct ctf_stream_definition
*stream
;
257 struct ctf_file_stream
*cfs
;
258 struct ctf_stream_pos
*stream_pos
;
259 struct packet_index
*index
;
261 stream
= g_ptr_array_index(stream_class
->streams
, j
);
262 cfs
= container_of(stream
, struct ctf_file_stream
,
264 stream_pos
= &cfs
->pos
;
266 if (!stream_pos
->packet_index
) {
271 if (stream_pos
->packet_index
->len
<= 0)
274 index
= &g_array_index(stream_pos
->packet_index
,
276 stream_pos
->packet_index
->len
- 1);
277 if (type
== BT_CLOCK_REAL
) {
278 if (index
->ts_real
.timestamp_end
> end
)
279 end
= index
->ts_real
.timestamp_end
;
280 } else if (type
== BT_CLOCK_CYCLES
) {
281 if (index
->ts_cycles
.timestamp_end
> end
)
282 end
= index
->ts_cycles
.timestamp_end
;
289 if (end
== LLONG_MIN
) {
301 * Update stream current timestamp
304 void ctf_update_timestamp(struct ctf_stream_definition
*stream
,
305 struct definition_integer
*integer_definition
)
307 struct declaration_integer
*integer_declaration
=
308 integer_definition
->declaration
;
309 uint64_t oldval
, newval
, updateval
;
311 if (unlikely(integer_declaration
->len
== 64)) {
312 stream
->cycles_timestamp
= integer_definition
->value
._unsigned
;
313 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
314 stream
->cycles_timestamp
);
318 oldval
= stream
->cycles_timestamp
;
319 oldval
&= (1ULL << integer_declaration
->len
) - 1;
320 newval
= integer_definition
->value
._unsigned
;
321 /* Test for overflow by comparing low bits */
323 newval
+= 1ULL << integer_declaration
->len
;
324 /* updateval contains old high bits, and new low bits (sum) */
325 updateval
= stream
->cycles_timestamp
;
326 updateval
&= ~((1ULL << integer_declaration
->len
) - 1);
328 stream
->cycles_timestamp
= updateval
;
330 /* convert to real timestamp */
331 stream
->real_timestamp
= ctf_get_real_timestamp(stream
,
332 stream
->cycles_timestamp
);
336 * Print timestamp, rescaling clock frequency to nanoseconds and
337 * applying offsets as needed (unix time).
340 void ctf_print_timestamp_real(FILE *fp
,
341 struct ctf_stream_definition
*stream
,
344 int64_t ts_sec
= 0, ts_nsec
;
345 uint64_t ts_sec_abs
, ts_nsec_abs
;
350 /* Add command-line offset in ns */
351 ts_nsec
+= opt_clock_offset_ns
;
353 /* Add command-line offset */
354 ts_sec
+= opt_clock_offset
;
356 ts_sec
+= ts_nsec
/ NSEC_PER_SEC
;
357 ts_nsec
= ts_nsec
% NSEC_PER_SEC
;
358 if (ts_sec
>= 0 && ts_nsec
>= 0) {
361 ts_nsec_abs
= ts_nsec
;
362 } else if (ts_sec
> 0 && ts_nsec
< 0) {
364 ts_sec_abs
= ts_sec
- 1;
365 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
366 } else if (ts_sec
== 0 && ts_nsec
< 0) {
369 ts_nsec_abs
= -ts_nsec
;
370 } else if (ts_sec
< 0 && ts_nsec
> 0) {
372 ts_sec_abs
= -(ts_sec
+ 1);
373 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
374 } else if (ts_sec
< 0 && ts_nsec
== 0) {
376 ts_sec_abs
= -ts_sec
;
377 ts_nsec_abs
= ts_nsec
;
378 } else { /* (ts_sec < 0 && ts_nsec < 0) */
380 ts_sec_abs
= -ts_sec
;
381 ts_nsec_abs
= -ts_nsec
;
384 if (!opt_clock_seconds
) {
386 time_t time_s
= (time_t) ts_sec_abs
;
389 fprintf(stderr
, "[warning] Fallback to [sec.ns] to print negative time value. Use --clock-seconds.\n");
393 if (!opt_clock_gmt
) {
396 res
= localtime_r(&time_s
, &tm
);
398 fprintf(stderr
, "[warning] Unable to get localtime.\n");
404 res
= gmtime_r(&time_s
, &tm
);
406 fprintf(stderr
, "[warning] Unable to get gmtime.\n");
410 if (opt_clock_date
) {
414 /* Print date and time */
415 res
= strftime(timestr
, sizeof(timestr
),
418 fprintf(stderr
, "[warning] Unable to print ascii time.\n");
421 fprintf(fp
, "%s", timestr
);
423 /* Print time in HH:MM:SS.ns */
424 fprintf(fp
, "%02d:%02d:%02d.%09" PRIu64
,
425 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, ts_nsec_abs
);
429 fprintf(fp
, "%s%" PRId64
".%09" PRIu64
,
430 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
437 * Print timestamp, in cycles
440 void ctf_print_timestamp_cycles(FILE *fp
,
441 struct ctf_stream_definition
*stream
,
444 fprintf(fp
, "%020" PRIu64
, timestamp
);
447 void ctf_print_timestamp(FILE *fp
,
448 struct ctf_stream_definition
*stream
,
451 if (opt_clock_cycles
) {
452 ctf_print_timestamp_cycles(fp
, stream
, timestamp
);
454 ctf_print_timestamp_real(fp
, stream
, timestamp
);
459 void print_uuid(FILE *fp
, unsigned char *uuid
)
463 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++)
464 fprintf(fp
, "%x", (unsigned int) uuid
[i
]);
468 * Discarded events can be either:
469 * - discarded after end of previous buffer due to buffer full:
470 * happened within range: [ prev_timestamp_end, timestamp_begin ]
471 * - discarded within current buffer due to either event too large or
472 * nested wrap-around:
473 * happened within range: [ timestamp_begin, timestamp_end ]
475 * Given we have discarded counters of those two types merged into the
476 * events_discarded counter, we need to use the union of those ranges:
477 * [ prev_timestamp_end, timestamp_end ]
479 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
480 * consumer had time to extract them. We keep track of those gaps with the
481 * packet sequence number in each packet.
484 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
)
486 if ((!stream
->events_discarded
&& !stream
->packets_lost
) ||
487 !babeltrace_ctf_console_output
) {
491 if (stream
->events_discarded
) {
492 fprintf(fp
, "[warning] Tracer discarded %" PRIu64
" events between [",
493 stream
->events_discarded
);
494 } else if (stream
->packets_lost
) {
495 fprintf(fp
, "[warning] Tracer lost %" PRIu64
" trace packets between [",
496 stream
->packets_lost
);
498 if (opt_clock_cycles
) {
499 ctf_print_timestamp(fp
, stream
,
500 stream
->prev
.cycles
.end
);
501 fprintf(fp
, "] and [");
502 ctf_print_timestamp(fp
, stream
,
503 stream
->current
.cycles
.end
);
505 ctf_print_timestamp(fp
, stream
,
506 stream
->prev
.real
.end
);
507 fprintf(fp
, "] and [");
508 ctf_print_timestamp(fp
, stream
,
509 stream
->current
.real
.end
);
511 fprintf(fp
, "] in trace UUID ");
512 print_uuid(fp
, stream
->stream_class
->trace
->uuid
);
513 if (stream
->stream_class
->trace
->parent
.path
[0])
514 fprintf(fp
, ", at path: \"%s\"",
515 stream
->stream_class
->trace
->parent
.path
);
517 fprintf(fp
, ", within stream id %" PRIu64
, stream
->stream_id
);
519 fprintf(fp
, ", at relative path: \"%s\"", stream
->path
);
521 fprintf(fp
, "You should consider recording a new trace with larger "
522 "buffers or with fewer events enabled.\n");
527 int ctf_read_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
529 struct ctf_stream_pos
*pos
=
530 container_of(ppos
, struct ctf_stream_pos
, parent
);
531 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
532 struct ctf_event_definition
*event
;
536 /* We need to check for EOF here for empty files. */
537 if (unlikely(pos
->offset
== EOF
))
540 ctf_pos_get_event(pos
);
542 /* save the current position as a restore point */
543 pos
->last_offset
= pos
->offset
;
546 * This is the EOF check after we've advanced the position in
549 if (unlikely(pos
->offset
== EOF
))
552 /* Stream is inactive for now (live reading). */
553 if (unlikely(pos
->content_size
== 0))
557 * Packet seeked to by ctf_pos_get_event() only contains
558 * headers, no event. Consider stream as inactive (live
561 if (unlikely(pos
->data_offset
== pos
->content_size
))
564 assert(pos
->offset
< pos
->content_size
);
566 /* Read event header */
567 if (likely(stream
->stream_event_header
)) {
568 struct definition_integer
*integer_definition
;
569 struct bt_definition
*variant
;
571 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
574 /* lookup event id */
575 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
576 if (integer_definition
) {
577 id
= integer_definition
->value
._unsigned
;
579 struct definition_enum
*enum_definition
;
581 enum_definition
= bt_lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
582 if (enum_definition
) {
583 id
= enum_definition
->integer
->value
._unsigned
;
587 variant
= bt_lookup_variant(&stream
->stream_event_header
->p
, "v");
589 integer_definition
= bt_lookup_integer(variant
, "id", FALSE
);
590 if (integer_definition
) {
591 id
= integer_definition
->value
._unsigned
;
594 stream
->event_id
= id
;
596 /* lookup timestamp */
597 stream
->has_timestamp
= 0;
598 integer_definition
= bt_lookup_integer(&stream
->stream_event_header
->p
, "timestamp", FALSE
);
599 if (integer_definition
) {
600 ctf_update_timestamp(stream
, integer_definition
);
601 stream
->has_timestamp
= 1;
604 integer_definition
= bt_lookup_integer(variant
, "timestamp", FALSE
);
605 if (integer_definition
) {
606 ctf_update_timestamp(stream
, integer_definition
);
607 stream
->has_timestamp
= 1;
613 /* Read stream-declared event context */
614 if (stream
->stream_event_context
) {
615 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
620 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
621 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
624 event
= g_ptr_array_index(stream
->events_by_id
, id
);
625 if (unlikely(!event
)) {
626 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
630 /* Read event-declared event context */
631 if (event
->event_context
) {
632 ret
= generic_rw(ppos
, &event
->event_context
->p
);
637 /* Read event payload */
638 if (likely(event
->event_fields
)) {
639 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
644 if (pos
->last_offset
== pos
->offset
) {
645 fprintf(stderr
, "[error] Invalid 0 byte event encountered.\n");
652 fprintf(stderr
, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
657 int ctf_write_event(struct bt_stream_pos
*pos
, struct ctf_stream_definition
*stream
)
659 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
660 struct ctf_event_definition
*event
;
664 id
= stream
->event_id
;
666 /* print event header */
667 if (likely(stream
->stream_event_header
)) {
668 ret
= generic_rw(pos
, &stream
->stream_event_header
->p
);
673 /* print stream-declared event context */
674 if (stream
->stream_event_context
) {
675 ret
= generic_rw(pos
, &stream
->stream_event_context
->p
);
680 if (unlikely(id
>= stream_class
->events_by_id
->len
)) {
681 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
684 event
= g_ptr_array_index(stream
->events_by_id
, id
);
685 if (unlikely(!event
)) {
686 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
690 /* print event-declared event context */
691 if (event
->event_context
) {
692 ret
= generic_rw(pos
, &event
->event_context
->p
);
697 /* Read and print event payload */
698 if (likely(event
->event_fields
)) {
699 ret
= generic_rw(pos
, &event
->event_fields
->p
);
707 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
712 * One side-effect of this function is to unmap pos mmap base if one is
716 int find_data_offset(struct ctf_stream_pos
*pos
,
717 struct ctf_file_stream
*file_stream
,
718 struct packet_index
*packet_index
)
720 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
721 struct stat filestats
;
725 pos
= &file_stream
->pos
;
727 ret
= fstat(pos
->fd
, &filestats
);
730 filesize
= filestats
.st_size
;
732 /* Deal with empty files */
738 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
739 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
744 ret
= munmap_align(pos
->base_mma
);
746 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
750 pos
->base_mma
= NULL
;
752 /* map new base. Need mapping length from header. */
753 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
754 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
755 assert(pos
->base_mma
!= MAP_FAILED
);
757 pos
->content_size
= packet_map_len
;
758 pos
->packet_size
= packet_map_len
;
759 pos
->offset
= 0; /* Position of the packet header */
761 /* update trace_packet_header and stream_packet_context */
762 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.trace_packet_header
) {
763 /* Read packet header */
764 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
770 if (pos
->prot
== PROT_READ
&& file_stream
->parent
.stream_packet_context
) {
771 /* Read packet context */
772 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
778 packet_index
->data_offset
= pos
->offset
;
781 ret
= munmap_align(pos
->base_mma
);
783 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
787 pos
->base_mma
= NULL
;
791 /* Retry with larger mapping */
793 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
795 * Reached EOF, but still expecting header/context data.
797 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
800 /* Double the mapping len, and retry */
801 tmp_map_len
= packet_map_len
<< 1;
802 if (tmp_map_len
>> 1 != packet_map_len
) {
804 fprintf(stderr
, "[error] Packet mapping length overflow\n");
807 packet_map_len
= tmp_map_len
;
812 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
813 int fd
, int open_flags
)
817 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
818 sizeof(struct packet_index
));
820 pos
->packet_index
= NULL
;
822 switch (open_flags
& O_ACCMODE
) {
824 pos
->prot
= PROT_READ
;
825 pos
->flags
= MAP_PRIVATE
;
826 pos
->parent
.rw_table
= read_dispatch_table
;
827 pos
->parent
.event_cb
= ctf_read_event
;
828 pos
->parent
.trace
= trace
;
831 pos
->prot
= PROT_READ
| PROT_WRITE
;
832 pos
->flags
= MAP_SHARED
;
833 pos
->parent
.rw_table
= write_dispatch_table
;
834 pos
->parent
.event_cb
= ctf_write_event
;
835 pos
->parent
.trace
= trace
;
843 int ctf_fini_pos(struct ctf_stream_pos
*pos
)
845 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
846 *pos
->content_size_loc
= pos
->offset
;
851 ret
= munmap_align(pos
->base_mma
);
853 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
858 if (pos
->packet_index
)
859 (void) g_array_free(pos
->packet_index
, TRUE
);
863 void ctf_update_current_packet_index(struct ctf_stream_definition
*stream
,
864 struct packet_index
*prev_index
,
865 struct packet_index
*cur_index
)
867 uint64_t events_discarded_diff
;
868 uint64_t packets_lost_diff
= 0;
870 /* Update packet index time information */
872 /* Current packet begin/end */
873 stream
->current
.real
.begin
=
874 cur_index
->ts_real
.timestamp_begin
;
875 stream
->current
.cycles
.begin
=
876 cur_index
->ts_cycles
.timestamp_begin
;
877 stream
->current
.real
.end
=
878 cur_index
->ts_real
.timestamp_end
;
879 stream
->current
.cycles
.end
=
880 cur_index
->ts_cycles
.timestamp_end
;
882 /* Update packet index discarded event information */
883 events_discarded_diff
= cur_index
->events_discarded
;
885 /* Previous packet begin/end */
886 stream
->prev
.cycles
.begin
=
887 prev_index
->ts_cycles
.timestamp_begin
;
888 stream
->prev
.real
.begin
=
889 prev_index
->ts_real
.timestamp_begin
;
890 stream
->prev
.cycles
.end
=
891 prev_index
->ts_cycles
.timestamp_end
;
892 stream
->prev
.real
.end
=
893 prev_index
->ts_real
.timestamp_end
;
895 events_discarded_diff
-= prev_index
->events_discarded
;
896 /* packet_seq_num stays at 0 if not produced by the tracer */
897 if (cur_index
->packet_seq_num
) {
898 packets_lost_diff
= cur_index
->packet_seq_num
-
899 prev_index
->packet_seq_num
- 1;
902 * Deal with 32-bit wrap-around if the tracer provided a
905 if (prev_index
->events_discarded_len
== 32) {
906 events_discarded_diff
= (uint32_t) events_discarded_diff
;
910 * First packet: use current packet info as limits for
913 stream
->prev
.cycles
.begin
=
914 stream
->prev
.cycles
.end
=
915 stream
->current
.cycles
.begin
;
916 stream
->prev
.real
.begin
=
917 stream
->prev
.real
.end
=
918 stream
->current
.real
.begin
;
920 stream
->events_discarded
= events_discarded_diff
;
921 stream
->packets_lost
= packets_lost_diff
;
925 * Find the timerange where all the streams in the trace are active
928 * Return 0 and update begin/end if necessary on success, return 1 for
929 * empty streams and return a negative value on error.
932 int ctf_find_stream_intersection(struct bt_trace_descriptor
*td_read
,
933 struct packet_index_time
*_real
,
934 struct packet_index_time
*_cycles
)
936 int stream_id
, ret
= 0;
937 struct packet_index_time real
= { INT64_MIN
, INT64_MAX
},
938 cycles
= { INT64_MIN
, INT64_MAX
};
939 struct ctf_trace
*tin
= container_of(td_read
, struct ctf_trace
, parent
);
941 /* At least one of the two return args must be provided. */
942 if (!_real
&& !_cycles
) {
947 if (tin
->streams
->len
== 0) {
952 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
955 struct ctf_stream_declaration
*stream_class
;
957 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
961 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
962 struct ctf_file_stream
*file_stream
;
963 struct ctf_stream_pos
*stream_pos
;
964 struct packet_index
*index
;
966 file_stream
= g_ptr_array_index(stream_class
->streams
,
971 stream_pos
= &file_stream
->pos
;
972 if (!stream_pos
->packet_index
||
973 stream_pos
->packet_index
->len
<= 0) {
977 index
= &g_array_index(stream_pos
->packet_index
,
978 struct packet_index
, 0);
979 real
.timestamp_begin
= max(real
.timestamp_begin
,
980 index
->ts_real
.timestamp_begin
);
981 cycles
.timestamp_begin
= max(cycles
.timestamp_begin
,
982 index
->ts_cycles
.timestamp_begin
);
984 index
= &g_array_index(stream_pos
->packet_index
,
986 stream_pos
->packet_index
->len
- 1);
987 real
.timestamp_end
= min(real
.timestamp_end
,
988 index
->ts_real
.timestamp_end
);
989 cycles
.timestamp_end
= min(cycles
.timestamp_end
,
990 index
->ts_cycles
.timestamp_end
);
1006 * Find the union of all active regions in the trace collection's traces.
1007 * Returns "real" timestamps.
1009 * Return 0 on success.
1010 * Return 1 if no intersections are found.
1011 * Return a negative value on error.
1013 int ctf_find_tc_stream_packet_intersection_union(struct bt_context
*ctx
,
1014 int64_t *_ts_begin
, int64_t *_ts_end
)
1017 int64_t ts_begin
= INT64_MAX
, ts_end
= INT64_MIN
;
1019 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
|| !_ts_begin
|| !_ts_end
) {
1024 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1025 struct bt_trace_descriptor
*td_read
;
1026 struct packet_index_time intersection_real
;
1028 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1032 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1035 /* Empty trace or no stream intersection. */
1037 } else if (ret
< 0) {
1041 ts_begin
= min(intersection_real
.timestamp_begin
, ts_begin
);
1042 ts_end
= max(intersection_real
.timestamp_end
, ts_end
);
1045 if (ts_end
< ts_begin
) {
1049 *_ts_begin
= ts_begin
;
1055 int ctf_tc_set_stream_intersection_mode(struct bt_context
*ctx
)
1059 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1064 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1065 struct bt_trace_descriptor
*td_read
;
1066 struct packet_index_time intersection_real
;
1068 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1073 ret
= ctf_find_stream_intersection(td_read
, &intersection_real
,
1076 /* Empty trace or no stream intersection. */
1078 } else if (ret
< 0) {
1082 td_read
->interval_real
= intersection_real
;
1083 td_read
->interval_set
= true;
1090 * for SEEK_CUR: go to next packet.
1091 * for SEEK_SET: go to packet numer (index).
1093 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1095 struct ctf_stream_pos
*pos
=
1096 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1097 struct ctf_file_stream
*file_stream
=
1098 container_of(pos
, struct ctf_file_stream
, pos
);
1100 struct packet_index
*packet_index
, *prev_index
;
1104 case SEEK_SET
: /* Fall-through */
1110 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1111 *pos
->content_size_loc
= pos
->offset
;
1113 if (pos
->base_mma
) {
1114 /* unmap old base */
1115 ret
= munmap_align(pos
->base_mma
);
1117 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1121 pos
->base_mma
= NULL
;
1125 * The caller should never ask for ctf_move_pos across packets,
1126 * except to get exactly at the beginning of the next packet.
1128 if (pos
->prot
& PROT_WRITE
) {
1131 /* The writer will add padding */
1132 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1135 assert(index
== 0); /* only seek supported for now */
1141 pos
->content_size
= -1U; /* Unknown at this point */
1142 pos
->packet_size
= WRITE_PACKET_LEN
;
1144 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1145 pos
->packet_size
/ CHAR_BIT
);
1146 } while (ret
== EINTR
);
1154 if (pos
->offset
== EOF
) {
1157 assert(pos
->cur_index
< pos
->packet_index
->len
);
1158 /* The reader will expect us to skip padding */
1163 if (index
>= pos
->packet_index
->len
) {
1167 pos
->cur_index
= index
;
1173 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1178 packet_index
= &g_array_index(pos
->packet_index
,
1179 struct packet_index
, pos
->cur_index
);
1180 if (pos
->cur_index
> 0) {
1181 prev_index
= &g_array_index(pos
->packet_index
,
1182 struct packet_index
,
1183 pos
->cur_index
- 1);
1187 ctf_update_current_packet_index(&file_stream
->parent
,
1188 prev_index
, packet_index
);
1191 * We need to check if we are in trace read or called
1192 * from packet indexing. In this last case, the
1193 * collection is not there, so we cannot print the
1196 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1197 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1200 packet_index
= &g_array_index(pos
->packet_index
,
1201 struct packet_index
,
1203 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1205 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1207 /* Lookup context/packet size in index */
1208 if (packet_index
->data_offset
== -1) {
1209 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1214 pos
->content_size
= packet_index
->content_size
;
1215 pos
->packet_size
= packet_index
->packet_size
;
1216 pos
->mmap_offset
= packet_index
->offset
;
1217 pos
->data_offset
= packet_index
->data_offset
;
1218 if (pos
->data_offset
< packet_index
->content_size
) {
1219 pos
->offset
= 0; /* will read headers */
1220 } else if (pos
->data_offset
== packet_index
->content_size
) {
1222 pos
->offset
= packet_index
->data_offset
;
1224 goto read_next_packet
;
1230 /* map new base. Need mapping length from header. */
1231 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1232 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1233 if (pos
->base_mma
== MAP_FAILED
) {
1234 fprintf(stderr
, "[error] mmap error %s.\n",
1239 /* update trace_packet_header and stream_packet_context */
1240 if (!(pos
->prot
& PROT_WRITE
) &&
1241 file_stream
->parent
.trace_packet_header
) {
1242 /* Read packet header */
1243 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1246 if (!(pos
->prot
& PROT_WRITE
) &&
1247 file_stream
->parent
.stream_packet_context
) {
1248 /* Read packet context */
1249 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1255 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1261 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1265 if (magic
== TSDL_MAGIC
) {
1267 td
->byte_order
= BYTE_ORDER
;
1268 CTF_TRACE_SET_FIELD(td
, byte_order
);
1269 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1271 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1272 LITTLE_ENDIAN
: BIG_ENDIAN
;
1273 CTF_TRACE_SET_FIELD(td
, byte_order
);
1281 * Returns 0 on success, -1 on error.
1284 int check_version(unsigned int major
, unsigned int minor
)
1299 /* eventually return an error instead of warning */
1301 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1307 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1310 struct metadata_packet_header header
;
1311 size_t readlen
, writelen
, toread
;
1312 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1315 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1319 if (td
->byte_order
!= BYTE_ORDER
) {
1320 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1321 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1322 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1323 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1325 if (header
.checksum
)
1326 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1327 if (header
.compression_scheme
) {
1328 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1329 header
.compression_scheme
);
1332 if (header
.encryption_scheme
) {
1333 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1334 header
.encryption_scheme
);
1337 if (header
.checksum_scheme
) {
1338 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1339 header
.checksum_scheme
);
1342 if (check_version(header
.major
, header
.minor
) < 0)
1344 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1345 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1346 CTF_TRACE_SET_FIELD(td
, uuid
);
1348 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1352 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1355 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1358 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1363 if (babeltrace_debug
) {
1364 buf
[readlen
] = '\0';
1365 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1369 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1370 if (writelen
< readlen
) {
1380 ret
= 0; /* continue reading next packet */
1387 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1388 ret
= fseek(in
, toread
, SEEK_CUR
);
1390 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1397 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1401 size_t size
, buflen
;
1406 * Using strlen on *buf instead of size of open_memstream
1407 * because its size includes garbage at the end (after final
1408 * \0). This is the allocated size, not the actual string size.
1410 out
= babeltrace_open_memstream(buf
, &size
);
1412 perror("Metadata open_memstream");
1416 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1425 /* close to flush the buffer */
1426 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1430 perror("babeltrace_flush_memstream");
1432 closeret
= fclose(in
);
1434 perror("Error in fclose");
1440 perror("Error in fclose");
1442 /* open for reading */
1443 buflen
= strlen(*buf
);
1448 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1450 perror("Metadata fmemopen");
1457 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1458 struct ctf_scanner
*scanner
, int append
)
1460 struct ctf_file_stream
*metadata_stream
;
1463 int ret
= 0, closeret
;
1465 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1466 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1470 metadata_stream
->pos
.fd
= -1;
1472 td
->metadata
= &metadata_stream
->parent
;
1473 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1474 if (metadata_stream
->pos
.fd
< 0) {
1475 fprintf(stderr
, "Unable to open metadata.\n");
1480 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1482 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1483 perror("Metadata stream open");
1487 /* fd now belongs to fp */
1488 metadata_stream
->pos
.fd
= -1;
1490 if (babeltrace_debug
)
1493 if (packet_metadata(td
, fp
)) {
1494 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1498 td
->metadata_string
= buf
;
1499 td
->metadata_packetized
= 1;
1502 unsigned int major
, minor
;
1505 td
->byte_order
= BYTE_ORDER
;
1507 /* Check text-only metadata header and version */
1508 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1510 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1511 if (check_version(major
, minor
) < 0) {
1519 ret
= ctf_scanner_append_ast(scanner
, fp
);
1521 fprintf(stderr
, "[error] Error creating AST\n");
1525 if (babeltrace_debug
) {
1526 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1528 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1533 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1535 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1538 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1539 td
, td
->byte_order
);
1541 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1546 closeret
= fclose(fp
);
1548 perror("Error on fclose");
1552 if (metadata_stream
->pos
.fd
>= 0) {
1553 closeret
= close(metadata_stream
->pos
.fd
);
1555 perror("Error on metadata stream fd close");
1560 g_free(metadata_stream
);
1565 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1566 struct ctf_stream_definition
*stream
,
1567 struct ctf_event_declaration
*event
)
1569 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1571 if (event
->context_decl
) {
1572 struct bt_definition
*definition
=
1573 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1574 stream
->parent_def_scope
, 0, 0, "event.context");
1578 stream_event
->event_context
= container_of(definition
,
1579 struct definition_struct
, p
);
1580 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1582 if (event
->fields_decl
) {
1583 struct bt_definition
*definition
=
1584 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1585 stream
->parent_def_scope
, 0, 0, "event.fields");
1589 stream_event
->event_fields
= container_of(definition
,
1590 struct definition_struct
, p
);
1591 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1593 stream_event
->stream
= stream
;
1594 return stream_event
;
1597 if (stream_event
->event_fields
)
1598 bt_definition_unref(&stream_event
->event_fields
->p
);
1599 if (stream_event
->event_context
)
1600 bt_definition_unref(&stream_event
->event_context
->p
);
1601 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1602 g_quark_to_string(event
->name
));
1607 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1608 struct ctf_stream_declaration
*stream_class
,
1609 struct ctf_stream_definition
*stream
)
1611 size_t def_size
, class_size
, i
;
1614 def_size
= stream
->events_by_id
->len
;
1615 class_size
= stream_class
->events_by_id
->len
;
1617 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1618 for (i
= def_size
; i
< class_size
; i
++) {
1619 struct ctf_event_declaration
*event
=
1620 g_ptr_array_index(stream_class
->events_by_id
, i
);
1621 struct ctf_event_definition
*stream_event
;
1625 stream_event
= create_event_definitions(td
, stream
, event
);
1626 if (!stream_event
) {
1630 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1637 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1639 struct ctf_stream_declaration
*stream_class
;
1643 if (stream
->stream_definitions_created
)
1646 stream_class
= stream
->stream_class
;
1648 if (stream_class
->packet_context_decl
) {
1649 struct bt_definition
*definition
=
1650 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1651 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1656 stream
->stream_packet_context
= container_of(definition
,
1657 struct definition_struct
, p
);
1658 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1660 if (stream_class
->event_header_decl
) {
1661 struct bt_definition
*definition
=
1662 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1663 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1668 stream
->stream_event_header
=
1669 container_of(definition
, struct definition_struct
, p
);
1670 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1672 if (stream_class
->event_context_decl
) {
1673 struct bt_definition
*definition
=
1674 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1675 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1680 stream
->stream_event_context
=
1681 container_of(definition
, struct definition_struct
, p
);
1682 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1684 stream
->events_by_id
= g_ptr_array_new();
1685 ret
= copy_event_declarations_stream_class_to_stream(td
,
1686 stream_class
, stream
);
1692 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1693 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1695 g_free(stream_event
);
1697 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1699 if (stream
->stream_event_context
)
1700 bt_definition_unref(&stream
->stream_event_context
->p
);
1701 if (stream
->stream_event_header
)
1702 bt_definition_unref(&stream
->stream_event_header
->p
);
1703 if (stream
->stream_packet_context
)
1704 bt_definition_unref(&stream
->stream_packet_context
->p
);
1705 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1706 stream_class
->stream_id
, strerror(-ret
));
1711 int stream_assign_class(struct ctf_trace
*td
,
1712 struct ctf_file_stream
*file_stream
,
1715 struct ctf_stream_declaration
*stream
;
1718 file_stream
->parent
.stream_id
= stream_id
;
1719 if (stream_id
>= td
->streams
->len
) {
1720 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1723 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1725 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1728 file_stream
->parent
.stream_class
= stream
;
1729 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1736 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1737 struct ctf_trace
*td
,
1738 struct ctf_file_stream
*file_stream
,
1741 struct packet_index packet_index
;
1742 uint64_t stream_id
= 0;
1743 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1744 int first_packet
= 0;
1749 memset(&packet_index
, 0, sizeof(packet_index
));
1750 if (!pos
->mmap_offset
) {
1754 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1755 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1758 if (pos
->base_mma
) {
1759 /* unmap old base */
1760 ret
= munmap_align(pos
->base_mma
);
1762 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1766 pos
->base_mma
= NULL
;
1768 /* map new base. Need mapping length from header. */
1769 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1770 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1771 assert(pos
->base_mma
!= MAP_FAILED
);
1773 * Use current mapping size as temporary content and packet
1776 pos
->content_size
= packet_map_len
;
1777 pos
->packet_size
= packet_map_len
;
1778 pos
->offset
= 0; /* Position of the packet header */
1780 packet_index
.offset
= pos
->mmap_offset
;
1782 /* read and check header, set stream id (and check) */
1783 if (file_stream
->parent
.trace_packet_header
) {
1784 /* Read packet header */
1785 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1789 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1792 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1793 if (len_index
>= 0) {
1794 struct bt_definition
*field
;
1797 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1798 magic
= bt_get_unsigned_int(field
);
1799 if (magic
!= CTF_MAGIC
) {
1800 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1802 file_stream
->pos
.packet_index
->len
,
1803 (ssize_t
) pos
->mmap_offset
);
1809 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1810 if (len_index
>= 0) {
1811 struct definition_array
*defarray
;
1812 struct bt_definition
*field
;
1814 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1816 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1817 assert(field
->declaration
->id
== BT_CTF_TYPE_ID_ARRAY
);
1818 defarray
= container_of(field
, struct definition_array
, p
);
1819 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1821 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1822 struct bt_definition
*elem
;
1824 elem
= bt_array_index(defarray
, i
);
1825 uuidval
[i
] = bt_get_unsigned_int(elem
);
1827 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1829 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1834 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1835 if (len_index
>= 0) {
1836 struct bt_definition
*field
;
1838 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1839 stream_id
= bt_get_unsigned_int(field
);
1843 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1844 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1846 file_stream
->parent
.stream_id
);
1850 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1855 if (file_stream
->parent
.stream_packet_context
) {
1856 /* Read packet context */
1857 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1861 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1864 /* read packet size from header */
1865 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1866 if (len_index
>= 0) {
1867 struct bt_definition
*field
;
1869 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1870 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1872 /* Use file size for packet size */
1873 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1876 /* read content size from header */
1877 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_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
.content_size
= bt_get_unsigned_int(field
);
1884 /* Use packet size if non-zero, else file size */
1885 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1888 /* read timestamp begin from header */
1889 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
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
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1895 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1896 packet_index
.ts_real
.timestamp_begin
=
1897 ctf_get_real_timestamp(
1898 &file_stream
->parent
,
1899 packet_index
.ts_cycles
.timestamp_begin
);
1903 /* read timestamp end from header */
1904 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1905 if (len_index
>= 0) {
1906 struct bt_definition
*field
;
1908 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1909 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1910 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1911 packet_index
.ts_real
.timestamp_end
=
1912 ctf_get_real_timestamp(
1913 &file_stream
->parent
,
1914 packet_index
.ts_cycles
.timestamp_end
);
1918 /* read events discarded from header */
1919 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1920 if (len_index
>= 0) {
1921 struct bt_definition
*field
;
1923 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1924 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1925 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1928 /* read packet_seq_num from header */
1929 len_index
= bt_struct_declaration_lookup_field_index(
1930 file_stream
->parent
.stream_packet_context
->declaration
,
1931 g_quark_from_static_string("packet_seq_num"));
1932 if (len_index
>= 0) {
1933 struct bt_definition
*field
;
1935 field
= bt_struct_definition_get_field_from_index(
1936 file_stream
->parent
.stream_packet_context
,
1938 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1941 /* Use file size for packet size */
1942 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1943 /* Use packet size if non-zero, else file size */
1944 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1947 /* Validate content size and packet size values */
1948 if (packet_index
.content_size
> packet_index
.packet_size
) {
1949 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1950 packet_index
.content_size
, packet_index
.packet_size
);
1954 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1955 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1956 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1960 if (packet_index
.content_size
< pos
->offset
) {
1961 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1965 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1966 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1970 /* Save position after header and context */
1971 packet_index
.data_offset
= pos
->offset
;
1973 /* add index to packet array */
1974 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1976 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1980 /* Retry with larger mapping */
1982 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1984 * Reached EOF, but still expecting header/context data.
1986 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1989 /* Double the mapping len, and retry */
1990 tmp_map_len
= packet_map_len
<< 1;
1991 if (tmp_map_len
>> 1 != packet_map_len
) {
1993 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1996 packet_map_len
= tmp_map_len
;
2001 int create_stream_packet_index(struct ctf_trace
*td
,
2002 struct ctf_file_stream
*file_stream
)
2004 struct ctf_stream_pos
*pos
;
2005 struct stat filestats
;
2008 pos
= &file_stream
->pos
;
2010 ret
= fstat(pos
->fd
, &filestats
);
2014 /* Deal with empty files */
2015 if (!filestats
.st_size
) {
2016 if (file_stream
->parent
.trace_packet_header
2017 || file_stream
->parent
.stream_packet_context
) {
2019 * We expect a trace packet header and/or stream packet
2020 * context. Since a trace needs to have at least one
2021 * packet, empty files are therefore not accepted.
2023 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
2027 * Without trace packet header nor stream packet
2028 * context, a one-packet trace can indeed be empty. This
2029 * is only valid if there is only one stream class: 0.
2031 ret
= stream_assign_class(td
, file_stream
, 0);
2038 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
2039 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
;
2226 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2227 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2230 file_stream
->pos
.packet_seek
= packet_seek
;
2232 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2237 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2240 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2244 * For now, only a single clock per trace is supported.
2246 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2249 * Allocate the index name for this stream and try to open it.
2251 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2253 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2257 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2260 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2261 ret
= create_stream_packet_index(td
, file_stream
);
2263 fprintf(stderr
, "[error] Stream index creation error.\n");
2267 ret
= openat(td
->dirfd
, index_name
, flags
);
2269 perror("Index file openat()");
2273 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2274 if (!file_stream
->pos
.index_fp
) {
2275 perror("fdopen() error");
2278 ret
= import_stream_packet_index(td
, file_stream
);
2283 ret
= fclose(file_stream
->pos
.index_fp
);
2285 perror("close index");
2291 /* Add stream file to stream class */
2292 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2293 &file_stream
->parent
);
2297 if (file_stream
->pos
.index_fp
) {
2298 ret
= fclose(file_stream
->pos
.index_fp
);
2300 perror("close index");
2303 if (file_stream
->parent
.trace_packet_header
)
2304 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2308 closeret
= ctf_fini_pos(&file_stream
->pos
);
2310 fprintf(stderr
, "Error on ctf_fini_pos\n");
2312 g_free(file_stream
);
2316 closeret
= close(fd
);
2318 perror("Error on fd close");
2325 int ctf_open_trace_read(struct ctf_trace
*td
,
2326 const char *path
, int flags
,
2327 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2328 int whence
), FILE *metadata_fp
)
2330 struct ctf_scanner
*scanner
;
2332 struct dirent
*dirent
;
2333 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 pc_name_max
= fpathconf(td
->dirfd
, _PC_NAME_MAX
);
2386 if (pc_name_max
< 0) {
2387 perror("Error on fpathconf");
2388 fprintf(stderr
, "[error] Failed to get _PC_NAME_MAX for path \"%s\".\n", path
);
2390 goto error_metadata
;
2393 dirent_len
= offsetof(struct dirent
, d_name
) + pc_name_max
+ 1;
2395 dirent
= malloc(dirent_len
);
2398 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2400 fprintf(stderr
, "[error] Readdir error.\n");
2405 /* Ignore hidden files, ., .. and metadata. */
2406 if (!strncmp(diriter
->d_name
, ".", 1)
2407 || !strcmp(diriter
->d_name
, "..")
2408 || !strcmp(diriter
->d_name
, "metadata"))
2411 /* Ignore index files : *.idx */
2412 ext
= strrchr(diriter
->d_name
, '.');
2413 if (ext
&& (!strcmp(ext
, ".idx"))) {
2417 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2418 flags
, packet_seek
);
2420 fprintf(stderr
, "[error] Open file stream error.\n");
2431 closeret
= close(td
->dirfd
);
2433 perror("Error on fd close");
2436 closeret
= closedir(td
->dir
);
2438 perror("Error on closedir");
2445 * ctf_open_trace: Open a CTF trace and index it.
2446 * Note that the user must seek the trace after the open (using the iterator)
2447 * since the index creation read it entirely.
2450 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2451 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2452 int whence
), FILE *metadata_fp
)
2454 struct ctf_trace
*td
;
2458 * If packet_seek is NULL, we provide our default version.
2461 packet_seek
= ctf_packet_seek
;
2463 td
= g_new0(struct ctf_trace
, 1);
2467 init_trace_descriptor(&td
->parent
);
2469 switch (flags
& O_ACCMODE
) {
2472 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2475 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2480 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2483 fprintf(stderr
, "[error] Incorrect open flags.\n");
2487 ret
= trace_debug_info_create(td
);
2495 trace_debug_info_destroy(td
);
2502 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2503 struct bt_mmap_stream
*mmap_info
)
2505 pos
->mmap_offset
= 0;
2506 pos
->packet_size
= 0;
2507 pos
->content_size
= 0;
2508 pos
->content_size_loc
= NULL
;
2509 pos
->fd
= mmap_info
->fd
;
2510 pos
->base_mma
= NULL
;
2514 pos
->prot
= PROT_READ
;
2515 pos
->flags
= MAP_PRIVATE
;
2516 pos
->parent
.rw_table
= read_dispatch_table
;
2517 pos
->parent
.event_cb
= ctf_read_event
;
2518 pos
->priv
= mmap_info
->priv
;
2519 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2520 sizeof(struct packet_index
));
2524 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2525 struct ctf_file_stream
*file_stream
,
2526 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2529 struct ctf_stream_declaration
*stream
;
2533 /* Ask for the first packet to get the stream_id. */
2534 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2535 stream_id
= file_stream
->parent
.stream_id
;
2536 if (stream_id
>= td
->streams
->len
) {
2537 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2538 "in metadata.\n", stream_id
);
2542 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2544 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2545 "in metadata.\n", stream_id
);
2549 file_stream
->parent
.stream_class
= stream
;
2550 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2556 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2557 struct bt_mmap_stream
*mmap_info
,
2558 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2562 struct ctf_file_stream
*file_stream
;
2564 file_stream
= g_new0(struct ctf_file_stream
, 1);
2565 file_stream
->parent
.stream_id
= -1ULL;
2566 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2567 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2569 file_stream
->pos
.packet_seek
= packet_seek
;
2571 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2576 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2581 * For now, only a single clock per trace is supported.
2583 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2585 /* Add stream file to stream class */
2586 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2587 &file_stream
->parent
);
2591 if (file_stream
->parent
.trace_packet_header
)
2592 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2594 g_free(file_stream
);
2599 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2600 struct bt_mmap_stream_list
*mmap_list
,
2601 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2606 struct bt_mmap_stream
*mmap_info
;
2608 td
->scanner
= ctf_scanner_alloc();
2610 fprintf(stderr
, "[error] Error allocating scanner\n");
2614 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2616 if (ret
== -ENOENT
) {
2617 fprintf(stderr
, "[warning] Empty metadata.\n");
2623 * for each stream, try to open, check magic number, and get the
2624 * stream ID to add to the right location in the stream array.
2626 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2627 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2629 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2636 ctf_scanner_free(td
->scanner
);
2641 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2642 struct bt_mmap_stream_list
*mmap_list
,
2643 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2647 struct ctf_trace
*td
;
2651 fprintf(stderr
, "[error] No metadata file pointer associated, "
2652 "required for mmap parsing\n");
2656 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2659 td
= g_new0(struct ctf_trace
, 1);
2661 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2665 ret
= trace_debug_info_create(td
);
2678 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2681 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2687 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2690 /* for each stream_class */
2691 for (i
= 0; i
< td
->streams
->len
; i
++) {
2692 struct ctf_stream_declaration
*stream_class
;
2694 stream_class
= g_ptr_array_index(td
->streams
, i
);
2697 /* for each stream */
2698 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2699 struct ctf_stream_definition
*stream
;
2701 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2704 ret
= copy_event_declarations_stream_class_to_stream(td
,
2705 stream_class
, stream
);
2714 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2717 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2719 /* for each stream_class */
2720 for (i
= 0; i
< td
->streams
->len
; i
++) {
2721 struct ctf_stream_declaration
*stream_class
;
2723 stream_class
= g_ptr_array_index(td
->streams
, i
);
2726 /* for each file_stream */
2727 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2728 struct ctf_stream_definition
*stream
;
2729 struct ctf_stream_pos
*stream_pos
;
2730 struct ctf_file_stream
*cfs
;
2732 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2735 cfs
= container_of(stream
, struct ctf_file_stream
,
2737 stream_pos
= &cfs
->pos
;
2738 if (!stream_pos
->packet_index
)
2741 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2742 struct packet_index
*index
;
2744 index
= &g_array_index(stream_pos
->packet_index
,
2745 struct packet_index
, k
);
2746 index
->ts_real
.timestamp_begin
=
2747 ctf_get_real_timestamp(stream
,
2748 index
->ts_cycles
.timestamp_begin
);
2749 index
->ts_real
.timestamp_end
=
2750 ctf_get_real_timestamp(stream
,
2751 index
->ts_cycles
.timestamp_end
);
2759 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2763 ret
= ctf_fini_pos(&file_stream
->pos
);
2765 fprintf(stderr
, "Error on ctf_fini_pos\n");
2768 if (file_stream
->pos
.fd
>= 0) {
2769 ret
= close(file_stream
->pos
.fd
);
2771 perror("Error closing file fd");
2779 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2781 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2787 for (i
= 0; i
< td
->streams
->len
; i
++) {
2788 struct ctf_stream_declaration
*stream
;
2791 stream
= g_ptr_array_index(td
->streams
, i
);
2794 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2795 struct ctf_file_stream
*file_stream
;
2796 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2797 struct ctf_file_stream
, parent
);
2798 ret
= ctf_close_file_stream(file_stream
);
2804 ctf_destroy_metadata(td
);
2805 ctf_scanner_free(td
->scanner
);
2806 if (td
->dirfd
>= 0) {
2807 ret
= close(td
->dirfd
);
2809 perror("Error closing dirfd");
2814 ret
= closedir(td
->dir
);
2816 perror("Error closedir");
2820 free(td
->metadata_string
);
2821 trace_debug_info_destroy(td
);
2827 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2828 struct bt_context
*ctx
)
2830 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2833 td
->parent
.ctx
= ctx
;
2837 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2838 struct bt_trace_handle
*handle
)
2840 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2843 td
->parent
.handle
= handle
;
2847 void __attribute__((constructor
)) ctf_init(void)
2851 ctf_format
.name
= g_quark_from_static_string("ctf");
2852 ret
= bt_register_format(&ctf_format
);
2857 void __attribute__((destructor
)) ctf_exit(void)
2859 bt_unregister_format(&ctf_format
);