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/ctf/types.h>
31 #include <babeltrace/ctf/metadata.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/ctf/events-internal.h>
34 #include <babeltrace/trace-handle-internal.h>
35 #include <babeltrace/context-internal.h>
36 #include <babeltrace/compat/uuid.h>
37 #include <babeltrace/endian.h>
38 #include <babeltrace/ctf/ctf-index.h>
43 #include <sys/types.h>
51 #include "metadata/ctf-scanner.h"
52 #include "metadata/ctf-parser.h"
53 #include "metadata/ctf-ast.h"
54 #include "events-private.h"
55 #include <babeltrace/compat/memstream.h>
56 #include <babeltrace/compat/fcntl.h>
58 #define LOG2_CHAR_BIT 3
61 * Length of first attempt at mapping a packet header, in bits.
63 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
66 * Lenght of packet to write, in bits.
68 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
71 #define min(a, b) (((a) < (b)) ? (a) : (b))
74 #define NSEC_PER_SEC 1000000000LL
76 #define INDEX_PATH "./index/%s.idx"
83 int64_t opt_clock_offset
;
84 int64_t opt_clock_offset_ns
;
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] for printing 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_intersect_trace(struct bt_trace_descriptor
*td_read
,
933 uint64_t *begin
, uint64_t *end
)
935 struct ctf_trace
*tin
;
936 int stream_id
, ret
= 0;
938 tin
= container_of(td_read
, struct ctf_trace
, parent
);
940 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
943 struct ctf_stream_declaration
*stream_class
;
945 stream_class
= g_ptr_array_index(tin
->streams
, stream_id
);
949 for (filenr
= 0; filenr
< stream_class
->streams
->len
; filenr
++) {
950 struct ctf_file_stream
*file_stream
;
951 struct ctf_stream_pos
*stream_pos
;
952 struct packet_index
*index
;
954 file_stream
= g_ptr_array_index(stream_class
->streams
,
959 stream_pos
= &file_stream
->pos
;
960 if (!stream_pos
->packet_index
||
961 stream_pos
->packet_index
->len
<= 0) {
965 index
= &g_array_index(stream_pos
->packet_index
,
966 struct packet_index
, 0);
967 if (index
->ts_real
.timestamp_begin
> *begin
) {
968 *begin
= index
->ts_real
.timestamp_begin
;
970 index
= &g_array_index(stream_pos
->packet_index
,
972 stream_pos
->packet_index
->len
- 1);
973 if (index
->ts_real
.timestamp_end
< *end
) {
974 *end
= index
->ts_real
.timestamp_end
;
984 * Find the timerange where all streams in the trace collection are active
987 * Return 0 on success.
988 * Return 1 if no intersections are found.
989 * Return a negative value on error.
991 int ctf_find_packets_intersection(struct bt_context
*ctx
,
992 uint64_t *ts_begin
, uint64_t *ts_end
)
996 if (!ctx
|| !ctx
->tc
|| !ctx
->tc
->array
) {
1001 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
1002 struct bt_trace_descriptor
*td_read
;
1004 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
1008 ret
= ctf_intersect_trace(td_read
, ts_begin
, ts_end
);
1013 if (*ts_end
< *ts_begin
) {
1023 * for SEEK_CUR: go to next packet.
1024 * for SEEK_SET: go to packet numer (index).
1026 void ctf_packet_seek(struct bt_stream_pos
*stream_pos
, size_t index
, int whence
)
1028 struct ctf_stream_pos
*pos
=
1029 container_of(stream_pos
, struct ctf_stream_pos
, parent
);
1030 struct ctf_file_stream
*file_stream
=
1031 container_of(pos
, struct ctf_file_stream
, pos
);
1033 struct packet_index
*packet_index
, *prev_index
;
1037 case SEEK_SET
: /* Fall-through */
1043 if ((pos
->prot
& PROT_WRITE
) && pos
->content_size_loc
)
1044 *pos
->content_size_loc
= pos
->offset
;
1046 if (pos
->base_mma
) {
1047 /* unmap old base */
1048 ret
= munmap_align(pos
->base_mma
);
1050 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1054 pos
->base_mma
= NULL
;
1058 * The caller should never ask for ctf_move_pos across packets,
1059 * except to get exactly at the beginning of the next packet.
1061 if (pos
->prot
& PROT_WRITE
) {
1064 /* The writer will add padding */
1065 pos
->mmap_offset
+= pos
->packet_size
/ CHAR_BIT
;
1068 assert(index
== 0); /* only seek supported for now */
1074 pos
->content_size
= -1U; /* Unknown at this point */
1075 pos
->packet_size
= WRITE_PACKET_LEN
;
1077 ret
= bt_posix_fallocate(pos
->fd
, pos
->mmap_offset
,
1078 pos
->packet_size
/ CHAR_BIT
);
1079 } while (ret
== EINTR
);
1087 if (pos
->offset
== EOF
) {
1090 assert(pos
->cur_index
< pos
->packet_index
->len
);
1091 /* The reader will expect us to skip padding */
1096 if (index
>= pos
->packet_index
->len
) {
1100 pos
->cur_index
= index
;
1106 if (pos
->cur_index
>= pos
->packet_index
->len
) {
1111 packet_index
= &g_array_index(pos
->packet_index
,
1112 struct packet_index
, pos
->cur_index
);
1113 if (pos
->cur_index
> 0) {
1114 prev_index
= &g_array_index(pos
->packet_index
,
1115 struct packet_index
,
1116 pos
->cur_index
- 1);
1120 ctf_update_current_packet_index(&file_stream
->parent
,
1121 prev_index
, packet_index
);
1124 * We need to check if we are in trace read or called
1125 * from packet indexing. In this last case, the
1126 * collection is not there, so we cannot print the
1129 if ((&file_stream
->parent
)->stream_class
->trace
->parent
.collection
) {
1130 ctf_print_discarded_lost(stderr
, &file_stream
->parent
);
1133 packet_index
= &g_array_index(pos
->packet_index
,
1134 struct packet_index
,
1136 file_stream
->parent
.cycles_timestamp
= packet_index
->ts_cycles
.timestamp_begin
;
1138 file_stream
->parent
.real_timestamp
= packet_index
->ts_real
.timestamp_begin
;
1140 /* Lookup context/packet size in index */
1141 if (packet_index
->data_offset
== -1) {
1142 ret
= find_data_offset(pos
, file_stream
, packet_index
);
1147 pos
->content_size
= packet_index
->content_size
;
1148 pos
->packet_size
= packet_index
->packet_size
;
1149 pos
->mmap_offset
= packet_index
->offset
;
1150 pos
->data_offset
= packet_index
->data_offset
;
1151 if (pos
->data_offset
< packet_index
->content_size
) {
1152 pos
->offset
= 0; /* will read headers */
1153 } else if (pos
->data_offset
== packet_index
->content_size
) {
1155 pos
->offset
= packet_index
->data_offset
;
1157 goto read_next_packet
;
1163 /* map new base. Need mapping length from header. */
1164 pos
->base_mma
= mmap_align(pos
->packet_size
/ CHAR_BIT
, pos
->prot
,
1165 pos
->flags
, pos
->fd
, pos
->mmap_offset
);
1166 if (pos
->base_mma
== MAP_FAILED
) {
1167 fprintf(stderr
, "[error] mmap error %s.\n",
1172 /* update trace_packet_header and stream_packet_context */
1173 if (!(pos
->prot
& PROT_WRITE
) &&
1174 file_stream
->parent
.trace_packet_header
) {
1175 /* Read packet header */
1176 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1179 if (!(pos
->prot
& PROT_WRITE
) &&
1180 file_stream
->parent
.stream_packet_context
) {
1181 /* Read packet context */
1182 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1188 int packet_metadata(struct ctf_trace
*td
, FILE *fp
)
1194 len
= fread(&magic
, sizeof(magic
), 1, fp
);
1198 if (magic
== TSDL_MAGIC
) {
1200 td
->byte_order
= BYTE_ORDER
;
1201 CTF_TRACE_SET_FIELD(td
, byte_order
);
1202 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
1204 td
->byte_order
= (BYTE_ORDER
== BIG_ENDIAN
) ?
1205 LITTLE_ENDIAN
: BIG_ENDIAN
;
1206 CTF_TRACE_SET_FIELD(td
, byte_order
);
1214 * Returns 0 on success, -1 on error.
1217 int check_version(unsigned int major
, unsigned int minor
)
1232 /* eventually return an error instead of warning */
1234 fprintf(stderr
, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1240 int ctf_trace_metadata_packet_read(struct ctf_trace
*td
, FILE *in
,
1243 struct metadata_packet_header header
;
1244 size_t readlen
, writelen
, toread
;
1245 char buf
[4096 + 1]; /* + 1 for debug-mode \0 */
1248 readlen
= fread(&header
, header_sizeof(header
), 1, in
);
1252 if (td
->byte_order
!= BYTE_ORDER
) {
1253 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
1254 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
1255 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
1256 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
1258 if (header
.checksum
)
1259 fprintf(stderr
, "[warning] checksum verification not supported yet.\n");
1260 if (header
.compression_scheme
) {
1261 fprintf(stderr
, "[error] compression (%u) not supported yet.\n",
1262 header
.compression_scheme
);
1265 if (header
.encryption_scheme
) {
1266 fprintf(stderr
, "[error] encryption (%u) not supported yet.\n",
1267 header
.encryption_scheme
);
1270 if (header
.checksum_scheme
) {
1271 fprintf(stderr
, "[error] checksum (%u) not supported yet.\n",
1272 header
.checksum_scheme
);
1275 if (check_version(header
.major
, header
.minor
) < 0)
1277 if (!CTF_TRACE_FIELD_IS_SET(td
, uuid
)) {
1278 memcpy(td
->uuid
, header
.uuid
, sizeof(header
.uuid
));
1279 CTF_TRACE_SET_FIELD(td
, uuid
);
1281 if (bt_uuid_compare(header
.uuid
, td
->uuid
))
1285 if ((header
.content_size
/ CHAR_BIT
) < header_sizeof(header
))
1288 toread
= (header
.content_size
/ CHAR_BIT
) - header_sizeof(header
);
1291 readlen
= fread(buf
, sizeof(char), min(sizeof(buf
) - 1, toread
), in
);
1296 if (babeltrace_debug
) {
1297 buf
[readlen
] = '\0';
1298 fprintf(stderr
, "[debug] metadata packet read: %s\n",
1302 writelen
= fwrite(buf
, sizeof(char), readlen
, out
);
1303 if (writelen
< readlen
) {
1313 ret
= 0; /* continue reading next packet */
1320 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
1321 ret
= fseek(in
, toread
, SEEK_CUR
);
1323 fprintf(stderr
, "[warning] Missing padding at end of file\n");
1330 int ctf_trace_metadata_stream_read(struct ctf_trace
*td
, FILE **fp
,
1334 size_t size
, buflen
;
1339 * Using strlen on *buf instead of size of open_memstream
1340 * because its size includes garbage at the end (after final
1341 * \0). This is the allocated size, not the actual string size.
1343 out
= babeltrace_open_memstream(buf
, &size
);
1345 perror("Metadata open_memstream");
1349 ret
= ctf_trace_metadata_packet_read(td
, in
, out
);
1358 /* close to flush the buffer */
1359 ret
= babeltrace_close_memstream(buf
, &size
, out
);
1363 perror("babeltrace_flush_memstream");
1365 closeret
= fclose(in
);
1367 perror("Error in fclose");
1373 perror("Error in fclose");
1375 /* open for reading */
1376 buflen
= strlen(*buf
);
1381 *fp
= babeltrace_fmemopen(*buf
, buflen
, "rb");
1383 perror("Metadata fmemopen");
1390 int ctf_trace_metadata_read(struct ctf_trace
*td
, FILE *metadata_fp
,
1391 struct ctf_scanner
*scanner
, int append
)
1393 struct ctf_file_stream
*metadata_stream
;
1396 int ret
= 0, closeret
;
1398 metadata_stream
= g_new0(struct ctf_file_stream
, 1);
1399 metadata_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
1403 metadata_stream
->pos
.fd
= -1;
1405 td
->metadata
= &metadata_stream
->parent
;
1406 metadata_stream
->pos
.fd
= openat(td
->dirfd
, "metadata", O_RDONLY
);
1407 if (metadata_stream
->pos
.fd
< 0) {
1408 fprintf(stderr
, "Unable to open metadata.\n");
1413 fp
= fdopen(metadata_stream
->pos
.fd
, "r");
1415 fprintf(stderr
, "[error] Unable to open metadata stream.\n");
1416 perror("Metadata stream open");
1420 /* fd now belongs to fp */
1421 metadata_stream
->pos
.fd
= -1;
1423 if (babeltrace_debug
)
1426 if (packet_metadata(td
, fp
)) {
1427 ret
= ctf_trace_metadata_stream_read(td
, &fp
, &buf
);
1431 td
->metadata_string
= buf
;
1432 td
->metadata_packetized
= 1;
1435 unsigned int major
, minor
;
1438 td
->byte_order
= BYTE_ORDER
;
1440 /* Check text-only metadata header and version */
1441 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
1443 fprintf(stderr
, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1444 if (check_version(major
, minor
) < 0) {
1452 ret
= ctf_scanner_append_ast(scanner
, fp
);
1454 fprintf(stderr
, "[error] Error creating AST\n");
1458 if (babeltrace_debug
) {
1459 ret
= ctf_visitor_print_xml(stderr
, 0, &scanner
->ast
->root
);
1461 fprintf(stderr
, "[error] Error visiting AST for XML output\n");
1466 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
1468 fprintf(stderr
, "[error] Error in CTF semantic validation %d\n", ret
);
1471 ret
= ctf_visitor_construct_metadata(stderr
, 0, &scanner
->ast
->root
,
1472 td
, td
->byte_order
);
1474 fprintf(stderr
, "[error] Error in CTF metadata constructor %d\n", ret
);
1479 closeret
= fclose(fp
);
1481 perror("Error on fclose");
1485 if (metadata_stream
->pos
.fd
>= 0) {
1486 closeret
= close(metadata_stream
->pos
.fd
);
1488 perror("Error on metadata stream fd close");
1493 g_free(metadata_stream
);
1498 struct ctf_event_definition
*create_event_definitions(struct ctf_trace
*td
,
1499 struct ctf_stream_definition
*stream
,
1500 struct ctf_event_declaration
*event
)
1502 struct ctf_event_definition
*stream_event
= g_new0(struct ctf_event_definition
, 1);
1504 if (event
->context_decl
) {
1505 struct bt_definition
*definition
=
1506 event
->context_decl
->p
.definition_new(&event
->context_decl
->p
,
1507 stream
->parent_def_scope
, 0, 0, "event.context");
1511 stream_event
->event_context
= container_of(definition
,
1512 struct definition_struct
, p
);
1513 stream
->parent_def_scope
= stream_event
->event_context
->p
.scope
;
1515 if (event
->fields_decl
) {
1516 struct bt_definition
*definition
=
1517 event
->fields_decl
->p
.definition_new(&event
->fields_decl
->p
,
1518 stream
->parent_def_scope
, 0, 0, "event.fields");
1522 stream_event
->event_fields
= container_of(definition
,
1523 struct definition_struct
, p
);
1524 stream
->parent_def_scope
= stream_event
->event_fields
->p
.scope
;
1526 stream_event
->stream
= stream
;
1527 return stream_event
;
1530 if (stream_event
->event_fields
)
1531 bt_definition_unref(&stream_event
->event_fields
->p
);
1532 if (stream_event
->event_context
)
1533 bt_definition_unref(&stream_event
->event_context
->p
);
1534 fprintf(stderr
, "[error] Unable to create event definition for event \"%s\".\n",
1535 g_quark_to_string(event
->name
));
1540 int copy_event_declarations_stream_class_to_stream(struct ctf_trace
*td
,
1541 struct ctf_stream_declaration
*stream_class
,
1542 struct ctf_stream_definition
*stream
)
1544 size_t def_size
, class_size
, i
;
1547 def_size
= stream
->events_by_id
->len
;
1548 class_size
= stream_class
->events_by_id
->len
;
1550 g_ptr_array_set_size(stream
->events_by_id
, class_size
);
1551 for (i
= def_size
; i
< class_size
; i
++) {
1552 struct ctf_event_declaration
*event
=
1553 g_ptr_array_index(stream_class
->events_by_id
, i
);
1554 struct ctf_event_definition
*stream_event
;
1558 stream_event
= create_event_definitions(td
, stream
, event
);
1559 if (!stream_event
) {
1563 g_ptr_array_index(stream
->events_by_id
, i
) = stream_event
;
1570 int create_stream_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1572 struct ctf_stream_declaration
*stream_class
;
1576 if (stream
->stream_definitions_created
)
1579 stream_class
= stream
->stream_class
;
1581 if (stream_class
->packet_context_decl
) {
1582 struct bt_definition
*definition
=
1583 stream_class
->packet_context_decl
->p
.definition_new(&stream_class
->packet_context_decl
->p
,
1584 stream
->parent_def_scope
, 0, 0, "stream.packet.context");
1589 stream
->stream_packet_context
= container_of(definition
,
1590 struct definition_struct
, p
);
1591 stream
->parent_def_scope
= stream
->stream_packet_context
->p
.scope
;
1593 if (stream_class
->event_header_decl
) {
1594 struct bt_definition
*definition
=
1595 stream_class
->event_header_decl
->p
.definition_new(&stream_class
->event_header_decl
->p
,
1596 stream
->parent_def_scope
, 0, 0, "stream.event.header");
1601 stream
->stream_event_header
=
1602 container_of(definition
, struct definition_struct
, p
);
1603 stream
->parent_def_scope
= stream
->stream_event_header
->p
.scope
;
1605 if (stream_class
->event_context_decl
) {
1606 struct bt_definition
*definition
=
1607 stream_class
->event_context_decl
->p
.definition_new(&stream_class
->event_context_decl
->p
,
1608 stream
->parent_def_scope
, 0, 0, "stream.event.context");
1613 stream
->stream_event_context
=
1614 container_of(definition
, struct definition_struct
, p
);
1615 stream
->parent_def_scope
= stream
->stream_event_context
->p
.scope
;
1617 stream
->events_by_id
= g_ptr_array_new();
1618 ret
= copy_event_declarations_stream_class_to_stream(td
,
1619 stream_class
, stream
);
1625 for (i
= 0; i
< stream
->events_by_id
->len
; i
++) {
1626 struct ctf_event_definition
*stream_event
= g_ptr_array_index(stream
->events_by_id
, i
);
1628 g_free(stream_event
);
1630 g_ptr_array_free(stream
->events_by_id
, TRUE
);
1632 if (stream
->stream_event_context
)
1633 bt_definition_unref(&stream
->stream_event_context
->p
);
1634 if (stream
->stream_event_header
)
1635 bt_definition_unref(&stream
->stream_event_header
->p
);
1636 if (stream
->stream_packet_context
)
1637 bt_definition_unref(&stream
->stream_packet_context
->p
);
1638 fprintf(stderr
, "[error] Unable to create stream (%" PRIu64
") definitions: %s\n",
1639 stream_class
->stream_id
, strerror(-ret
));
1644 int stream_assign_class(struct ctf_trace
*td
,
1645 struct ctf_file_stream
*file_stream
,
1648 struct ctf_stream_declaration
*stream
;
1651 file_stream
->parent
.stream_id
= stream_id
;
1652 if (stream_id
>= td
->streams
->len
) {
1653 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1656 stream
= g_ptr_array_index(td
->streams
, stream_id
);
1658 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared in metadata.\n", stream_id
);
1661 file_stream
->parent
.stream_class
= stream
;
1662 ret
= create_stream_definitions(td
, &file_stream
->parent
);
1669 int create_stream_one_packet_index(struct ctf_stream_pos
*pos
,
1670 struct ctf_trace
*td
,
1671 struct ctf_file_stream
*file_stream
,
1674 struct packet_index packet_index
;
1675 uint64_t stream_id
= 0;
1676 uint64_t packet_map_len
= DEFAULT_HEADER_LEN
, tmp_map_len
;
1677 int first_packet
= 0;
1682 memset(&packet_index
, 0, sizeof(packet_index
));
1683 if (!pos
->mmap_offset
) {
1687 if (filesize
- pos
->mmap_offset
< (packet_map_len
>> LOG2_CHAR_BIT
)) {
1688 packet_map_len
= (filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
;
1691 if (pos
->base_mma
) {
1692 /* unmap old base */
1693 ret
= munmap_align(pos
->base_mma
);
1695 fprintf(stderr
, "[error] Unable to unmap old base: %s.\n",
1699 pos
->base_mma
= NULL
;
1701 /* map new base. Need mapping length from header. */
1702 pos
->base_mma
= mmap_align(packet_map_len
>> LOG2_CHAR_BIT
, PROT_READ
,
1703 MAP_PRIVATE
, pos
->fd
, pos
->mmap_offset
);
1704 assert(pos
->base_mma
!= MAP_FAILED
);
1706 * Use current mapping size as temporary content and packet
1709 pos
->content_size
= packet_map_len
;
1710 pos
->packet_size
= packet_map_len
;
1711 pos
->offset
= 0; /* Position of the packet header */
1713 packet_index
.offset
= pos
->mmap_offset
;
1715 /* read and check header, set stream id (and check) */
1716 if (file_stream
->parent
.trace_packet_header
) {
1717 /* Read packet header */
1718 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.trace_packet_header
->p
);
1722 fprintf(stderr
, "[error] Unable to read packet header: %s\n", strerror(-ret
));
1725 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("magic"));
1726 if (len_index
>= 0) {
1727 struct bt_definition
*field
;
1730 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1731 magic
= bt_get_unsigned_int(field
);
1732 if (magic
!= CTF_MAGIC
) {
1733 fprintf(stderr
, "[error] Invalid magic number 0x%" PRIX64
" at packet %u (file offset %zd).\n",
1735 file_stream
->pos
.packet_index
->len
,
1736 (ssize_t
) pos
->mmap_offset
);
1742 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("uuid"));
1743 if (len_index
>= 0) {
1744 struct definition_array
*defarray
;
1745 struct bt_definition
*field
;
1747 uint8_t uuidval
[BABELTRACE_UUID_LEN
];
1749 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1750 assert(field
->declaration
->id
== BT_CTF_TYPE_ID_ARRAY
);
1751 defarray
= container_of(field
, struct definition_array
, p
);
1752 assert(bt_array_len(defarray
) == BABELTRACE_UUID_LEN
);
1754 for (i
= 0; i
< BABELTRACE_UUID_LEN
; i
++) {
1755 struct bt_definition
*elem
;
1757 elem
= bt_array_index(defarray
, i
);
1758 uuidval
[i
] = bt_get_unsigned_int(elem
);
1760 ret
= bt_uuid_compare(td
->uuid
, uuidval
);
1762 fprintf(stderr
, "[error] Unique Universal Identifiers do not match.\n");
1767 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.trace_packet_header
->declaration
, g_quark_from_static_string("stream_id"));
1768 if (len_index
>= 0) {
1769 struct bt_definition
*field
;
1771 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.trace_packet_header
, len_index
);
1772 stream_id
= bt_get_unsigned_int(field
);
1776 if (!first_packet
&& file_stream
->parent
.stream_id
!= stream_id
) {
1777 fprintf(stderr
, "[error] Stream ID is changing within a stream: expecting %" PRIu64
", but packet has %" PRIu64
"\n",
1779 file_stream
->parent
.stream_id
);
1783 ret
= stream_assign_class(td
, file_stream
, stream_id
);
1788 if (file_stream
->parent
.stream_packet_context
) {
1789 /* Read packet context */
1790 ret
= generic_rw(&pos
->parent
, &file_stream
->parent
.stream_packet_context
->p
);
1794 fprintf(stderr
, "[error] Unable to read packet context: %s\n", strerror(-ret
));
1797 /* read packet size from header */
1798 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("packet_size"));
1799 if (len_index
>= 0) {
1800 struct bt_definition
*field
;
1802 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1803 packet_index
.packet_size
= bt_get_unsigned_int(field
);
1805 /* Use file size for packet size */
1806 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1809 /* read content size from header */
1810 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("content_size"));
1811 if (len_index
>= 0) {
1812 struct bt_definition
*field
;
1814 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1815 packet_index
.content_size
= bt_get_unsigned_int(field
);
1817 /* Use packet size if non-zero, else file size */
1818 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1821 /* read timestamp begin from header */
1822 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_begin"));
1823 if (len_index
>= 0) {
1824 struct bt_definition
*field
;
1826 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1827 packet_index
.ts_cycles
.timestamp_begin
= bt_get_unsigned_int(field
);
1828 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1829 packet_index
.ts_real
.timestamp_begin
=
1830 ctf_get_real_timestamp(
1831 &file_stream
->parent
,
1832 packet_index
.ts_cycles
.timestamp_begin
);
1836 /* read timestamp end from header */
1837 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("timestamp_end"));
1838 if (len_index
>= 0) {
1839 struct bt_definition
*field
;
1841 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1842 packet_index
.ts_cycles
.timestamp_end
= bt_get_unsigned_int(field
);
1843 if (file_stream
->parent
.stream_class
->trace
->parent
.collection
) {
1844 packet_index
.ts_real
.timestamp_end
=
1845 ctf_get_real_timestamp(
1846 &file_stream
->parent
,
1847 packet_index
.ts_cycles
.timestamp_end
);
1851 /* read events discarded from header */
1852 len_index
= bt_struct_declaration_lookup_field_index(file_stream
->parent
.stream_packet_context
->declaration
, g_quark_from_static_string("events_discarded"));
1853 if (len_index
>= 0) {
1854 struct bt_definition
*field
;
1856 field
= bt_struct_definition_get_field_from_index(file_stream
->parent
.stream_packet_context
, len_index
);
1857 packet_index
.events_discarded
= bt_get_unsigned_int(field
);
1858 packet_index
.events_discarded_len
= bt_get_int_len(field
);
1861 /* read packet_seq_num from header */
1862 len_index
= bt_struct_declaration_lookup_field_index(
1863 file_stream
->parent
.stream_packet_context
->declaration
,
1864 g_quark_from_static_string("packet_seq_num"));
1865 if (len_index
>= 0) {
1866 struct bt_definition
*field
;
1868 field
= bt_struct_definition_get_field_from_index(
1869 file_stream
->parent
.stream_packet_context
,
1871 packet_index
.packet_seq_num
= bt_get_unsigned_int(field
);
1874 /* Use file size for packet size */
1875 packet_index
.packet_size
= filesize
* CHAR_BIT
;
1876 /* Use packet size if non-zero, else file size */
1877 packet_index
.content_size
= packet_index
.packet_size
? : filesize
* CHAR_BIT
;
1880 /* Validate content size and packet size values */
1881 if (packet_index
.content_size
> packet_index
.packet_size
) {
1882 fprintf(stderr
, "[error] Content size (%" PRIu64
" bits) is larger than packet size (%" PRIu64
" bits).\n",
1883 packet_index
.content_size
, packet_index
.packet_size
);
1887 if (packet_index
.packet_size
> ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
) {
1888 fprintf(stderr
, "[error] Packet size (%" PRIu64
" bits) is larger than remaining file size (%" PRIu64
" bits).\n",
1889 packet_index
.packet_size
, ((uint64_t) filesize
- packet_index
.offset
) * CHAR_BIT
);
1893 if (packet_index
.content_size
< pos
->offset
) {
1894 fprintf(stderr
, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1898 if ((packet_index
.packet_size
>> LOG2_CHAR_BIT
) == 0) {
1899 fprintf(stderr
, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1903 /* Save position after header and context */
1904 packet_index
.data_offset
= pos
->offset
;
1906 /* add index to packet array */
1907 g_array_append_val(file_stream
->pos
.packet_index
, packet_index
);
1909 pos
->mmap_offset
+= packet_index
.packet_size
>> LOG2_CHAR_BIT
;
1913 /* Retry with larger mapping */
1915 if (packet_map_len
== ((filesize
- pos
->mmap_offset
) << LOG2_CHAR_BIT
)) {
1917 * Reached EOF, but still expecting header/context data.
1919 fprintf(stderr
, "[error] Reached end of file, but still expecting header or context fields.\n");
1922 /* Double the mapping len, and retry */
1923 tmp_map_len
= packet_map_len
<< 1;
1924 if (tmp_map_len
>> 1 != packet_map_len
) {
1926 fprintf(stderr
, "[error] Packet mapping length overflow\n");
1929 packet_map_len
= tmp_map_len
;
1934 int create_stream_packet_index(struct ctf_trace
*td
,
1935 struct ctf_file_stream
*file_stream
)
1937 struct ctf_stream_pos
*pos
;
1938 struct stat filestats
;
1941 pos
= &file_stream
->pos
;
1943 ret
= fstat(pos
->fd
, &filestats
);
1947 /* Deal with empty files */
1948 if (!filestats
.st_size
) {
1949 if (file_stream
->parent
.trace_packet_header
1950 || file_stream
->parent
.stream_packet_context
) {
1952 * We expect a trace packet header and/or stream packet
1953 * context. Since a trace needs to have at least one
1954 * packet, empty files are therefore not accepted.
1956 fprintf(stderr
, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1960 * Without trace packet header nor stream packet
1961 * context, a one-packet trace can indeed be empty. This
1962 * is only valid if there is only one stream class: 0.
1964 ret
= stream_assign_class(td
, file_stream
, 0);
1971 for (pos
->mmap_offset
= 0; pos
->mmap_offset
< filestats
.st_size
; ) {
1972 ret
= create_stream_one_packet_index(pos
, td
, file_stream
,
1981 int create_trace_definitions(struct ctf_trace
*td
, struct ctf_stream_definition
*stream
)
1985 if (td
->packet_header_decl
) {
1986 struct bt_definition
*definition
=
1987 td
->packet_header_decl
->p
.definition_new(&td
->packet_header_decl
->p
,
1988 stream
->parent_def_scope
, 0, 0, "trace.packet.header");
1993 stream
->trace_packet_header
=
1994 container_of(definition
, struct definition_struct
, p
);
1995 stream
->parent_def_scope
= stream
->trace_packet_header
->p
.scope
;
2001 fprintf(stderr
, "[error] Unable to create trace definitions: %s\n", strerror(-ret
));
2006 int import_stream_packet_index(struct ctf_trace
*td
,
2007 struct ctf_file_stream
*file_stream
)
2009 struct ctf_stream_pos
*pos
;
2010 struct ctf_packet_index
*ctf_index
= NULL
;
2011 struct ctf_packet_index_file_hdr index_hdr
;
2012 struct packet_index index
;
2013 uint32_t packet_index_len
, index_minor
;
2015 int first_packet
= 1;
2018 pos
= &file_stream
->pos
;
2020 len
= fread(&index_hdr
, sizeof(index_hdr
), 1, pos
->index_fp
);
2022 perror("read index file header");
2026 /* Check the index header */
2027 if (be32toh(index_hdr
.magic
) != CTF_INDEX_MAGIC
) {
2028 fprintf(stderr
, "[error] wrong index magic\n");
2032 if (be32toh(index_hdr
.index_major
) != CTF_INDEX_MAJOR
) {
2033 fprintf(stderr
, "[error] Incompatible index file %" PRIu32
2034 ".%" PRIu32
", supported %d.%d\n",
2035 be32toh(index_hdr
.index_major
),
2036 be32toh(index_hdr
.index_minor
), CTF_INDEX_MAJOR
,
2041 index_minor
= be32toh(index_hdr
.index_minor
);
2043 packet_index_len
= be32toh(index_hdr
.packet_index_len
);
2044 if (packet_index_len
== 0) {
2045 fprintf(stderr
, "[error] Packet index length cannot be 0.\n");
2050 * Allocate the index length found in header, not internal
2053 ctf_index
= g_malloc0(packet_index_len
);
2054 while (fread(ctf_index
, packet_index_len
, 1,
2055 pos
->index_fp
) == 1) {
2057 struct ctf_stream_declaration
*stream
= NULL
;
2059 memset(&index
, 0, sizeof(index
));
2060 index
.offset
= be64toh(ctf_index
->offset
);
2061 index
.packet_size
= be64toh(ctf_index
->packet_size
);
2062 index
.content_size
= be64toh(ctf_index
->content_size
);
2063 index
.ts_cycles
.timestamp_begin
= be64toh(ctf_index
->timestamp_begin
);
2064 index
.ts_cycles
.timestamp_end
= be64toh(ctf_index
->timestamp_end
);
2065 index
.events_discarded
= be64toh(ctf_index
->events_discarded
);
2066 index
.events_discarded_len
= 64;
2067 index
.data_offset
= -1;
2068 stream_id
= be64toh(ctf_index
->stream_id
);
2069 if (index_minor
>= 1) {
2070 index
.stream_instance_id
= be64toh(ctf_index
->stream_instance_id
);
2071 index
.packet_seq_num
= be64toh(ctf_index
->packet_seq_num
);
2074 if (!first_packet
) {
2075 /* add index to packet array */
2076 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2080 file_stream
->parent
.stream_id
= stream_id
;
2081 if (stream_id
< td
->streams
->len
) {
2082 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2085 fprintf(stderr
, "[error] Stream %" PRIu64
2086 " is not declared in metadata.\n",
2091 file_stream
->parent
.stream_class
= stream
;
2092 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2096 /* add index to packet array */
2097 g_array_append_val(file_stream
->pos
.packet_index
, index
);
2100 /* Index containing only the header. */
2101 if (!file_stream
->parent
.stream_class
) {
2114 * Note: many file streams can inherit from the same stream class
2115 * description (metadata).
2118 int ctf_open_file_stream_read(struct ctf_trace
*td
, const char *path
, int flags
,
2119 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2122 int ret
, fd
, closeret
;
2123 struct ctf_file_stream
*file_stream
;
2124 struct stat statbuf
;
2127 fd
= openat(td
->dirfd
, path
, flags
);
2129 perror("File stream openat()");
2134 /* Don't try to mmap subdirectories. Skip them, return success. */
2135 ret
= fstat(fd
, &statbuf
);
2137 perror("File stream fstat()");
2140 if (S_ISDIR(statbuf
.st_mode
)) {
2141 if (strncmp(path
, "index", 5) != 0) {
2142 fprintf(stderr
, "[warning] Skipping directory '%s' "
2143 "found in trace\n", path
);
2148 if (!statbuf
.st_size
) {
2149 /** Skip empty files. */
2151 goto fd_is_empty_file
;
2154 file_stream
= g_new0(struct ctf_file_stream
, 1);
2155 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2156 file_stream
->pos
.fd
= -1;
2157 file_stream
->pos
.index_fp
= NULL
;
2159 strncpy(file_stream
->parent
.path
, path
, PATH_MAX
);
2160 file_stream
->parent
.path
[PATH_MAX
- 1] = '\0';
2163 file_stream
->pos
.packet_seek
= packet_seek
;
2165 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2170 ret
= ctf_init_pos(&file_stream
->pos
, &td
->parent
, fd
, flags
);
2173 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2177 * For now, only a single clock per trace is supported.
2179 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2182 * Allocate the index name for this stream and try to open it.
2184 index_name
= malloc((strlen(path
) + sizeof(INDEX_PATH
)) * sizeof(char));
2186 fprintf(stderr
, "[error] Cannot allocate index filename\n");
2190 snprintf(index_name
, strlen(path
) + sizeof(INDEX_PATH
),
2193 if (bt_faccessat(td
->dirfd
, td
->parent
.path
, index_name
, O_RDONLY
, 0) < 0) {
2194 ret
= create_stream_packet_index(td
, file_stream
);
2196 fprintf(stderr
, "[error] Stream index creation error.\n");
2200 ret
= openat(td
->dirfd
, index_name
, flags
);
2202 perror("Index file openat()");
2206 file_stream
->pos
.index_fp
= fdopen(ret
, "r");
2207 if (!file_stream
->pos
.index_fp
) {
2208 perror("fdopen() error");
2211 ret
= import_stream_packet_index(td
, file_stream
);
2216 ret
= fclose(file_stream
->pos
.index_fp
);
2218 perror("close index");
2224 /* Add stream file to stream class */
2225 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2226 &file_stream
->parent
);
2230 if (file_stream
->pos
.index_fp
) {
2231 ret
= fclose(file_stream
->pos
.index_fp
);
2233 perror("close index");
2236 if (file_stream
->parent
.trace_packet_header
)
2237 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2241 closeret
= ctf_fini_pos(&file_stream
->pos
);
2243 fprintf(stderr
, "Error on ctf_fini_pos\n");
2245 g_free(file_stream
);
2249 closeret
= close(fd
);
2251 perror("Error on fd close");
2258 int ctf_open_trace_read(struct ctf_trace
*td
,
2259 const char *path
, int flags
,
2260 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2261 int whence
), FILE *metadata_fp
)
2263 struct ctf_scanner
*scanner
;
2265 struct dirent
*dirent
;
2266 struct dirent
*diriter
;
2273 /* Open trace directory */
2274 td
->dir
= opendir(path
);
2276 fprintf(stderr
, "[error] Unable to open trace directory \"%s\".\n", path
);
2281 td
->dirfd
= open(path
, 0);
2282 if (td
->dirfd
< 0) {
2283 fprintf(stderr
, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path
);
2284 perror("Trace directory open");
2288 strncpy(td
->parent
.path
, path
, sizeof(td
->parent
.path
));
2289 td
->parent
.path
[sizeof(td
->parent
.path
) - 1] = '\0';
2292 * Keep the metadata file separate.
2293 * Keep scanner object local to the open. We don't support
2294 * incremental metadata append for on-disk traces.
2296 scanner
= ctf_scanner_alloc();
2298 fprintf(stderr
, "[error] Error allocating scanner\n");
2300 goto error_metadata
;
2302 ret
= ctf_trace_metadata_read(td
, metadata_fp
, scanner
, 0);
2303 ctf_scanner_free(scanner
);
2305 if (ret
== -ENOENT
) {
2306 fprintf(stderr
, "[warning] Empty metadata.\n");
2308 fprintf(stderr
, "[warning] Unable to open trace metadata for path \"%s\".\n", path
);
2309 goto error_metadata
;
2313 * Open each stream: for each file, try to open, check magic
2314 * number, and get the stream ID to add to the right location in
2318 pc_name_max
= fpathconf(td
->dirfd
, _PC_NAME_MAX
);
2319 if (pc_name_max
< 0) {
2320 perror("Error on fpathconf");
2321 fprintf(stderr
, "[error] Failed to get _PC_NAME_MAX for path \"%s\".\n", path
);
2323 goto error_metadata
;
2326 dirent_len
= offsetof(struct dirent
, d_name
) + pc_name_max
+ 1;
2328 dirent
= malloc(dirent_len
);
2331 ret
= readdir_r(td
->dir
, dirent
, &diriter
);
2333 fprintf(stderr
, "[error] Readdir error.\n");
2338 /* Ignore hidden files, ., .. and metadata. */
2339 if (!strncmp(diriter
->d_name
, ".", 1)
2340 || !strcmp(diriter
->d_name
, "..")
2341 || !strcmp(diriter
->d_name
, "metadata"))
2344 /* Ignore index files : *.idx */
2345 ext
= strrchr(diriter
->d_name
, '.');
2346 if (ext
&& (!strcmp(ext
, ".idx"))) {
2350 ret
= ctf_open_file_stream_read(td
, diriter
->d_name
,
2351 flags
, packet_seek
);
2353 fprintf(stderr
, "[error] Open file stream error.\n");
2364 closeret
= close(td
->dirfd
);
2366 perror("Error on fd close");
2369 closeret
= closedir(td
->dir
);
2371 perror("Error on closedir");
2378 * ctf_open_trace: Open a CTF trace and index it.
2379 * Note that the user must seek the trace after the open (using the iterator)
2380 * since the index creation read it entirely.
2383 struct bt_trace_descriptor
*ctf_open_trace(const char *path
, int flags
,
2384 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2385 int whence
), FILE *metadata_fp
)
2387 struct ctf_trace
*td
;
2391 * If packet_seek is NULL, we provide our default version.
2394 packet_seek
= ctf_packet_seek
;
2396 td
= g_new0(struct ctf_trace
, 1);
2398 switch (flags
& O_ACCMODE
) {
2401 fprintf(stderr
, "[error] Path missing for input CTF trace.\n");
2404 ret
= ctf_open_trace_read(td
, path
, flags
, packet_seek
, metadata_fp
);
2409 fprintf(stderr
, "[error] Opening CTF traces for output is not supported yet.\n");
2412 fprintf(stderr
, "[error] Incorrect open flags.\n");
2423 void ctf_init_mmap_pos(struct ctf_stream_pos
*pos
,
2424 struct bt_mmap_stream
*mmap_info
)
2426 pos
->mmap_offset
= 0;
2427 pos
->packet_size
= 0;
2428 pos
->content_size
= 0;
2429 pos
->content_size_loc
= NULL
;
2430 pos
->fd
= mmap_info
->fd
;
2431 pos
->base_mma
= NULL
;
2435 pos
->prot
= PROT_READ
;
2436 pos
->flags
= MAP_PRIVATE
;
2437 pos
->parent
.rw_table
= read_dispatch_table
;
2438 pos
->parent
.event_cb
= ctf_read_event
;
2439 pos
->priv
= mmap_info
->priv
;
2440 pos
->packet_index
= g_array_new(FALSE
, TRUE
,
2441 sizeof(struct packet_index
));
2445 int prepare_mmap_stream_definition(struct ctf_trace
*td
,
2446 struct ctf_file_stream
*file_stream
,
2447 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2450 struct ctf_stream_declaration
*stream
;
2454 /* Ask for the first packet to get the stream_id. */
2455 packet_seek(&file_stream
->pos
.parent
, 0, SEEK_SET
);
2456 stream_id
= file_stream
->parent
.stream_id
;
2457 if (stream_id
>= td
->streams
->len
) {
2458 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2459 "in metadata.\n", stream_id
);
2463 stream
= g_ptr_array_index(td
->streams
, stream_id
);
2465 fprintf(stderr
, "[error] Stream %" PRIu64
" is not declared "
2466 "in metadata.\n", stream_id
);
2470 file_stream
->parent
.stream_class
= stream
;
2471 ret
= create_stream_definitions(td
, &file_stream
->parent
);
2477 int ctf_open_mmap_stream_read(struct ctf_trace
*td
,
2478 struct bt_mmap_stream
*mmap_info
,
2479 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2483 struct ctf_file_stream
*file_stream
;
2485 file_stream
= g_new0(struct ctf_file_stream
, 1);
2486 file_stream
->parent
.stream_id
= -1ULL;
2487 file_stream
->pos
.last_offset
= LAST_OFFSET_POISON
;
2488 ctf_init_mmap_pos(&file_stream
->pos
, mmap_info
);
2490 file_stream
->pos
.packet_seek
= packet_seek
;
2492 ret
= create_trace_definitions(td
, &file_stream
->parent
);
2497 ret
= prepare_mmap_stream_definition(td
, file_stream
, packet_seek
);
2502 * For now, only a single clock per trace is supported.
2504 file_stream
->parent
.current_clock
= td
->parent
.single_clock
;
2506 /* Add stream file to stream class */
2507 g_ptr_array_add(file_stream
->parent
.stream_class
->streams
,
2508 &file_stream
->parent
);
2512 if (file_stream
->parent
.trace_packet_header
)
2513 bt_definition_unref(&file_stream
->parent
.trace_packet_header
->p
);
2515 g_free(file_stream
);
2520 int ctf_open_mmap_trace_read(struct ctf_trace
*td
,
2521 struct bt_mmap_stream_list
*mmap_list
,
2522 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2527 struct bt_mmap_stream
*mmap_info
;
2529 td
->scanner
= ctf_scanner_alloc();
2531 fprintf(stderr
, "[error] Error allocating scanner\n");
2535 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 0);
2537 if (ret
== -ENOENT
) {
2538 fprintf(stderr
, "[warning] Empty metadata.\n");
2544 * for each stream, try to open, check magic number, and get the
2545 * stream ID to add to the right location in the stream array.
2547 bt_list_for_each_entry(mmap_info
, &mmap_list
->head
, list
) {
2548 ret
= ctf_open_mmap_stream_read(td
, mmap_info
, packet_seek
);
2550 fprintf(stderr
, "[error] Open file mmap stream error.\n");
2557 ctf_scanner_free(td
->scanner
);
2562 struct bt_trace_descriptor
*ctf_open_mmap_trace(
2563 struct bt_mmap_stream_list
*mmap_list
,
2564 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
2568 struct ctf_trace
*td
;
2572 fprintf(stderr
, "[error] No metadata file pointer associated, "
2573 "required for mmap parsing\n");
2577 fprintf(stderr
, "[error] packet_seek function undefined.\n");
2580 td
= g_new0(struct ctf_trace
, 1);
2582 ret
= ctf_open_mmap_trace_read(td
, mmap_list
, packet_seek
, metadata_fp
);
2594 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
2597 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2603 ret
= ctf_trace_metadata_read(td
, metadata_fp
, td
->scanner
, 1);
2606 /* for each stream_class */
2607 for (i
= 0; i
< td
->streams
->len
; i
++) {
2608 struct ctf_stream_declaration
*stream_class
;
2610 stream_class
= g_ptr_array_index(td
->streams
, i
);
2613 /* for each stream */
2614 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2615 struct ctf_stream_definition
*stream
;
2617 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2620 ret
= copy_event_declarations_stream_class_to_stream(td
,
2621 stream_class
, stream
);
2630 int ctf_convert_index_timestamp(struct bt_trace_descriptor
*tdp
)
2633 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2635 /* for each stream_class */
2636 for (i
= 0; i
< td
->streams
->len
; i
++) {
2637 struct ctf_stream_declaration
*stream_class
;
2639 stream_class
= g_ptr_array_index(td
->streams
, i
);
2642 /* for each file_stream */
2643 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
2644 struct ctf_stream_definition
*stream
;
2645 struct ctf_stream_pos
*stream_pos
;
2646 struct ctf_file_stream
*cfs
;
2648 stream
= g_ptr_array_index(stream_class
->streams
, j
);
2651 cfs
= container_of(stream
, struct ctf_file_stream
,
2653 stream_pos
= &cfs
->pos
;
2654 if (!stream_pos
->packet_index
)
2657 for (k
= 0; k
< stream_pos
->packet_index
->len
; k
++) {
2658 struct packet_index
*index
;
2660 index
= &g_array_index(stream_pos
->packet_index
,
2661 struct packet_index
, k
);
2662 index
->ts_real
.timestamp_begin
=
2663 ctf_get_real_timestamp(stream
,
2664 index
->ts_cycles
.timestamp_begin
);
2665 index
->ts_real
.timestamp_end
=
2666 ctf_get_real_timestamp(stream
,
2667 index
->ts_cycles
.timestamp_end
);
2675 int ctf_close_file_stream(struct ctf_file_stream
*file_stream
)
2679 ret
= ctf_fini_pos(&file_stream
->pos
);
2681 fprintf(stderr
, "Error on ctf_fini_pos\n");
2684 if (file_stream
->pos
.fd
>= 0) {
2685 ret
= close(file_stream
->pos
.fd
);
2687 perror("Error closing file fd");
2695 int ctf_close_trace(struct bt_trace_descriptor
*tdp
)
2697 struct ctf_trace
*td
= container_of(tdp
, struct ctf_trace
, parent
);
2703 for (i
= 0; i
< td
->streams
->len
; i
++) {
2704 struct ctf_stream_declaration
*stream
;
2707 stream
= g_ptr_array_index(td
->streams
, i
);
2710 for (j
= 0; j
< stream
->streams
->len
; j
++) {
2711 struct ctf_file_stream
*file_stream
;
2712 file_stream
= container_of(g_ptr_array_index(stream
->streams
, j
),
2713 struct ctf_file_stream
, parent
);
2714 ret
= ctf_close_file_stream(file_stream
);
2720 ctf_destroy_metadata(td
);
2721 ctf_scanner_free(td
->scanner
);
2722 if (td
->dirfd
>= 0) {
2723 ret
= close(td
->dirfd
);
2725 perror("Error closing dirfd");
2730 ret
= closedir(td
->dir
);
2732 perror("Error closedir");
2736 free(td
->metadata_string
);
2742 void ctf_set_context(struct bt_trace_descriptor
*descriptor
,
2743 struct bt_context
*ctx
)
2745 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2748 td
->parent
.ctx
= ctx
;
2752 void ctf_set_handle(struct bt_trace_descriptor
*descriptor
,
2753 struct bt_trace_handle
*handle
)
2755 struct ctf_trace
*td
= container_of(descriptor
, struct ctf_trace
,
2758 td
->parent
.handle
= handle
;
2762 void __attribute__((constructor
)) ctf_init(void)
2766 ctf_format
.name
= g_quark_from_static_string("ctf");
2767 ret
= bt_register_format(&ctf_format
);
2772 void __attribute__((destructor
)) ctf_exit(void)
2774 bt_unregister_format(&ctf_format
);