4dcec9032e413d10565beb64abad5993fdbade2f
[babeltrace.git] / formats / ctf / ctf.c
1 /*
2 * BabelTrace - Common Trace Format (CTF)
3 *
4 * Format registration.
5 *
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 *
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:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
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
26 * SOFTWARE.
27 */
28
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>
39 #include <inttypes.h>
40 #include <stdio.h>
41 #include <sys/mman.h>
42 #include <errno.h>
43 #include <sys/types.h>
44 #include <sys/stat.h>
45 #include <fcntl.h>
46 #include <dirent.h>
47 #include <glib.h>
48 #include <unistd.h>
49 #include <stdlib.h>
50
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>
57
58 #define LOG2_CHAR_BIT 3
59
60 /*
61 * Length of first attempt at mapping a packet header, in bits.
62 */
63 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
64
65 /*
66 * Lenght of packet to write, in bits.
67 */
68 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
69
70 #ifndef min
71 #define min(a, b) (((a) < (b)) ? (a) : (b))
72 #endif
73
74 #define NSEC_PER_SEC 1000000000ULL
75
76 #define INDEX_PATH "./index/%s.idx"
77
78 int opt_clock_cycles,
79 opt_clock_seconds,
80 opt_clock_date,
81 opt_clock_gmt;
82
83 uint64_t opt_clock_offset;
84 uint64_t opt_clock_offset_ns;
85
86 extern int yydebug;
87
88 /*
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.
92 */
93 int babeltrace_ctf_console_output;
94
95 static
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,
98 int whence),
99 FILE *metadata_fp);
100 static
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,
104 int whence),
105 FILE *metadata_fp);
106 static
107 void ctf_set_context(struct bt_trace_descriptor *descriptor,
108 struct bt_context *ctx);
109 static
110 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
111 struct bt_trace_handle *handle);
112
113 static
114 int ctf_close_trace(struct bt_trace_descriptor *descriptor);
115 static
116 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor,
117 struct bt_trace_handle *handle, enum bt_clock_type type);
118 static
119 uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor,
120 struct bt_trace_handle *handle, enum bt_clock_type type);
121 static
122 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp);
123
124 static
125 rw_dispatch read_dispatch_table[] = {
126 [ CTF_TYPE_INTEGER ] = ctf_integer_read,
127 [ CTF_TYPE_FLOAT ] = ctf_float_read,
128 [ CTF_TYPE_ENUM ] = ctf_enum_read,
129 [ CTF_TYPE_STRING ] = ctf_string_read,
130 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
131 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
132 [ CTF_TYPE_ARRAY ] = ctf_array_read,
133 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
134 };
135
136 static
137 rw_dispatch write_dispatch_table[] = {
138 [ CTF_TYPE_INTEGER ] = ctf_integer_write,
139 [ CTF_TYPE_FLOAT ] = ctf_float_write,
140 [ CTF_TYPE_ENUM ] = ctf_enum_write,
141 [ CTF_TYPE_STRING ] = ctf_string_write,
142 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
143 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
144 [ CTF_TYPE_ARRAY ] = ctf_array_write,
145 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
146 };
147
148 static
149 struct bt_format ctf_format = {
150 .open_trace = ctf_open_trace,
151 .open_mmap_trace = ctf_open_mmap_trace,
152 .close_trace = ctf_close_trace,
153 .set_context = ctf_set_context,
154 .set_handle = ctf_set_handle,
155 .timestamp_begin = ctf_timestamp_begin,
156 .timestamp_end = ctf_timestamp_end,
157 .convert_index_timestamp = ctf_convert_index_timestamp,
158 };
159
160 static
161 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor,
162 struct bt_trace_handle *handle, enum bt_clock_type type)
163 {
164 struct ctf_trace *tin;
165 uint64_t begin = ULLONG_MAX;
166 int i, j;
167
168 tin = container_of(descriptor, struct ctf_trace, parent);
169
170 if (!tin)
171 goto error;
172
173 /* for each stream_class */
174 for (i = 0; i < tin->streams->len; i++) {
175 struct ctf_stream_declaration *stream_class;
176
177 stream_class = g_ptr_array_index(tin->streams, i);
178 if (!stream_class)
179 continue;
180 /* for each file_stream */
181 for (j = 0; j < stream_class->streams->len; j++) {
182 struct ctf_stream_definition *stream;
183 struct ctf_file_stream *cfs;
184 struct ctf_stream_pos *stream_pos;
185 struct packet_index *index;
186
187 stream = g_ptr_array_index(stream_class->streams, j);
188 cfs = container_of(stream, struct ctf_file_stream,
189 parent);
190 stream_pos = &cfs->pos;
191
192 if (!stream_pos->packet_index)
193 goto error;
194
195 if (stream_pos->packet_index->len <= 0)
196 continue;
197
198 index = &g_array_index(stream_pos->packet_index,
199 struct packet_index,
200 stream_pos->packet_index->len - 1);
201 if (type == BT_CLOCK_REAL) {
202 if (index->ts_real.timestamp_begin < begin)
203 begin = index->ts_real.timestamp_begin;
204 } else if (type == BT_CLOCK_CYCLES) {
205 if (index->ts_cycles.timestamp_begin < begin)
206 begin = index->ts_cycles.timestamp_begin;
207 } else {
208 goto error;
209 }
210 }
211 }
212
213 return begin;
214
215 error:
216 return -1ULL;
217 }
218
219 static
220 uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor,
221 struct bt_trace_handle *handle, enum bt_clock_type type)
222 {
223 struct ctf_trace *tin;
224 uint64_t end = 0;
225 int i, j;
226
227 tin = container_of(descriptor, struct ctf_trace, parent);
228
229 if (!tin)
230 goto error;
231
232 /* for each stream_class */
233 for (i = 0; i < tin->streams->len; i++) {
234 struct ctf_stream_declaration *stream_class;
235
236 stream_class = g_ptr_array_index(tin->streams, i);
237 if (!stream_class)
238 continue;
239 /* for each file_stream */
240 for (j = 0; j < stream_class->streams->len; j++) {
241 struct ctf_stream_definition *stream;
242 struct ctf_file_stream *cfs;
243 struct ctf_stream_pos *stream_pos;
244 struct packet_index *index;
245
246 stream = g_ptr_array_index(stream_class->streams, j);
247 cfs = container_of(stream, struct ctf_file_stream,
248 parent);
249 stream_pos = &cfs->pos;
250
251 if (!stream_pos->packet_index)
252 goto error;
253
254 if (stream_pos->packet_index->len <= 0)
255 continue;
256
257 index = &g_array_index(stream_pos->packet_index,
258 struct packet_index,
259 stream_pos->packet_index->len - 1);
260 if (type == BT_CLOCK_REAL) {
261 if (index->ts_real.timestamp_end > end)
262 end = index->ts_real.timestamp_end;
263 } else if (type == BT_CLOCK_CYCLES) {
264 if (index->ts_cycles.timestamp_end > end)
265 end = index->ts_cycles.timestamp_end;
266 } else {
267 goto error;
268 }
269 }
270 }
271
272 return end;
273
274 error:
275 return -1ULL;
276 }
277
278 /*
279 * Update stream current timestamp
280 */
281 static
282 void ctf_update_timestamp(struct ctf_stream_definition *stream,
283 struct definition_integer *integer_definition)
284 {
285 struct declaration_integer *integer_declaration =
286 integer_definition->declaration;
287 uint64_t oldval, newval, updateval;
288
289 if (unlikely(integer_declaration->len == 64)) {
290 stream->cycles_timestamp = integer_definition->value._unsigned;
291 stream->real_timestamp = ctf_get_real_timestamp(stream,
292 stream->cycles_timestamp);
293 return;
294 }
295 /* keep low bits */
296 oldval = stream->cycles_timestamp;
297 oldval &= (1ULL << integer_declaration->len) - 1;
298 newval = integer_definition->value._unsigned;
299 /* Test for overflow by comparing low bits */
300 if (newval < oldval)
301 newval += 1ULL << integer_declaration->len;
302 /* updateval contains old high bits, and new low bits (sum) */
303 updateval = stream->cycles_timestamp;
304 updateval &= ~((1ULL << integer_declaration->len) - 1);
305 updateval += newval;
306 stream->cycles_timestamp = updateval;
307
308 /* convert to real timestamp */
309 stream->real_timestamp = ctf_get_real_timestamp(stream,
310 stream->cycles_timestamp);
311 }
312
313 /*
314 * Print timestamp, rescaling clock frequency to nanoseconds and
315 * applying offsets as needed (unix time).
316 */
317 static
318 void ctf_print_timestamp_real(FILE *fp,
319 struct ctf_stream_definition *stream,
320 uint64_t timestamp)
321 {
322 uint64_t ts_sec = 0, ts_nsec;
323
324 ts_nsec = timestamp;
325
326 /* Add command-line offset in ns*/
327 ts_nsec += opt_clock_offset_ns;
328
329 /* Add command-line offset */
330 ts_sec += opt_clock_offset;
331
332 ts_sec += ts_nsec / NSEC_PER_SEC;
333 ts_nsec = ts_nsec % NSEC_PER_SEC;
334
335 if (!opt_clock_seconds) {
336 struct tm tm;
337 time_t time_s = (time_t) ts_sec;
338
339 if (!opt_clock_gmt) {
340 struct tm *res;
341
342 res = localtime_r(&time_s, &tm);
343 if (!res) {
344 fprintf(stderr, "[warning] Unable to get localtime.\n");
345 goto seconds;
346 }
347 } else {
348 struct tm *res;
349
350 res = gmtime_r(&time_s, &tm);
351 if (!res) {
352 fprintf(stderr, "[warning] Unable to get gmtime.\n");
353 goto seconds;
354 }
355 }
356 if (opt_clock_date) {
357 char timestr[26];
358 size_t res;
359
360 /* Print date and time */
361 res = strftime(timestr, sizeof(timestr),
362 "%F ", &tm);
363 if (!res) {
364 fprintf(stderr, "[warning] Unable to print ascii time.\n");
365 goto seconds;
366 }
367 fprintf(fp, "%s", timestr);
368 }
369 /* Print time in HH:MM:SS.ns */
370 fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
371 tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
372 goto end;
373 }
374 seconds:
375 fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
376 ts_sec, ts_nsec);
377
378 end:
379 return;
380 }
381
382 /*
383 * Print timestamp, in cycles
384 */
385 static
386 void ctf_print_timestamp_cycles(FILE *fp,
387 struct ctf_stream_definition *stream,
388 uint64_t timestamp)
389 {
390 fprintf(fp, "%020" PRIu64, timestamp);
391 }
392
393 void ctf_print_timestamp(FILE *fp,
394 struct ctf_stream_definition *stream,
395 uint64_t timestamp)
396 {
397 if (opt_clock_cycles) {
398 ctf_print_timestamp_cycles(fp, stream, timestamp);
399 } else {
400 ctf_print_timestamp_real(fp, stream, timestamp);
401 }
402 }
403
404 static
405 void print_uuid(FILE *fp, unsigned char *uuid)
406 {
407 int i;
408
409 for (i = 0; i < BABELTRACE_UUID_LEN; i++)
410 fprintf(fp, "%x", (unsigned int) uuid[i]);
411 }
412
413 /*
414 * Discarded events can be either:
415 * - discarded after end of previous buffer due to buffer full:
416 * happened within range: [ prev_timestamp_end, timestamp_begin ]
417 * - discarded within current buffer due to either event too large or
418 * nested wrap-around:
419 * happened within range: [ timestamp_begin, timestamp_end ]
420 *
421 * Given we have discarded counters of those two types merged into the
422 * events_discarded counter, we need to use the union of those ranges:
423 * [ prev_timestamp_end, timestamp_end ]
424 *
425 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
426 * consumer had time to extract them. We keep track of those gaps with the
427 * packet sequence number in each packet.
428 */
429 static
430 void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream)
431 {
432 if ((!stream->events_discarded && !stream->packets_lost) ||
433 !babeltrace_ctf_console_output) {
434 return;
435 }
436 fflush(stdout);
437 if (stream->events_discarded) {
438 fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [",
439 stream->events_discarded);
440 } else if (stream->packets_lost) {
441 fprintf(fp, "[warning] Tracer lost %" PRIu64 " trace packets between [",
442 stream->packets_lost);
443 }
444 if (opt_clock_cycles) {
445 ctf_print_timestamp(fp, stream,
446 stream->prev.cycles.end);
447 fprintf(fp, "] and [");
448 ctf_print_timestamp(fp, stream,
449 stream->current.cycles.end);
450 } else {
451 ctf_print_timestamp(fp, stream,
452 stream->prev.real.end);
453 fprintf(fp, "] and [");
454 ctf_print_timestamp(fp, stream,
455 stream->current.real.end);
456 }
457 fprintf(fp, "] in trace UUID ");
458 print_uuid(fp, stream->stream_class->trace->uuid);
459 if (stream->stream_class->trace->parent.path[0])
460 fprintf(fp, ", at path: \"%s\"",
461 stream->stream_class->trace->parent.path);
462
463 fprintf(fp, ", within stream id %" PRIu64, stream->stream_id);
464 if (stream->path[0])
465 fprintf(fp, ", at relative path: \"%s\"", stream->path);
466 fprintf(fp, ". ");
467 fprintf(fp, "You should consider recording a new trace with larger "
468 "buffers or with fewer events enabled.\n");
469 fflush(fp);
470 }
471
472 static
473 int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream)
474 {
475 struct ctf_stream_pos *pos =
476 container_of(ppos, struct ctf_stream_pos, parent);
477 struct ctf_stream_declaration *stream_class = stream->stream_class;
478 struct ctf_event_definition *event;
479 uint64_t id = 0;
480 int ret;
481
482 /* We need to check for EOF here for empty files. */
483 if (unlikely(pos->offset == EOF))
484 return EOF;
485
486 ctf_pos_get_event(pos);
487
488 /* save the current position as a restore point */
489 pos->last_offset = pos->offset;
490
491 /*
492 * This is the EOF check after we've advanced the position in
493 * ctf_pos_get_event.
494 */
495 if (unlikely(pos->offset == EOF))
496 return EOF;
497
498 /* Stream is inactive for now (live reading). */
499 if (unlikely(pos->content_size == 0))
500 return EAGAIN;
501
502 /*
503 * Packet seeked to by ctf_pos_get_event() only contains
504 * headers, no event. Consider stream as inactive (live
505 * reading).
506 */
507 if (unlikely(pos->data_offset == pos->content_size))
508 return EAGAIN;
509
510 assert(pos->offset < pos->content_size);
511
512 /* Read event header */
513 if (likely(stream->stream_event_header)) {
514 struct definition_integer *integer_definition;
515 struct bt_definition *variant;
516
517 ret = generic_rw(ppos, &stream->stream_event_header->p);
518 if (unlikely(ret))
519 goto error;
520 /* lookup event id */
521 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "id", FALSE);
522 if (integer_definition) {
523 id = integer_definition->value._unsigned;
524 } else {
525 struct definition_enum *enum_definition;
526
527 enum_definition = bt_lookup_enum(&stream->stream_event_header->p, "id", FALSE);
528 if (enum_definition) {
529 id = enum_definition->integer->value._unsigned;
530 }
531 }
532
533 variant = bt_lookup_variant(&stream->stream_event_header->p, "v");
534 if (variant) {
535 integer_definition = bt_lookup_integer(variant, "id", FALSE);
536 if (integer_definition) {
537 id = integer_definition->value._unsigned;
538 }
539 }
540 stream->event_id = id;
541
542 /* lookup timestamp */
543 stream->has_timestamp = 0;
544 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
545 if (integer_definition) {
546 ctf_update_timestamp(stream, integer_definition);
547 stream->has_timestamp = 1;
548 } else {
549 if (variant) {
550 integer_definition = bt_lookup_integer(variant, "timestamp", FALSE);
551 if (integer_definition) {
552 ctf_update_timestamp(stream, integer_definition);
553 stream->has_timestamp = 1;
554 }
555 }
556 }
557 }
558
559 /* Read stream-declared event context */
560 if (stream->stream_event_context) {
561 ret = generic_rw(ppos, &stream->stream_event_context->p);
562 if (ret)
563 goto error;
564 }
565
566 if (unlikely(id >= stream_class->events_by_id->len)) {
567 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
568 return -EINVAL;
569 }
570 event = g_ptr_array_index(stream->events_by_id, id);
571 if (unlikely(!event)) {
572 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
573 return -EINVAL;
574 }
575
576 /* Read event-declared event context */
577 if (event->event_context) {
578 ret = generic_rw(ppos, &event->event_context->p);
579 if (ret)
580 goto error;
581 }
582
583 /* Read event payload */
584 if (likely(event->event_fields)) {
585 ret = generic_rw(ppos, &event->event_fields->p);
586 if (ret)
587 goto error;
588 }
589
590 if (pos->last_offset == pos->offset) {
591 fprintf(stderr, "[error] Invalid 0 byte event encountered.\n");
592 return -EINVAL;
593 }
594
595 return 0;
596
597 error:
598 fprintf(stderr, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
599 return ret;
600 }
601
602 static
603 int ctf_write_event(struct bt_stream_pos *pos, struct ctf_stream_definition *stream)
604 {
605 struct ctf_stream_declaration *stream_class = stream->stream_class;
606 struct ctf_event_definition *event;
607 uint64_t id;
608 int ret;
609
610 id = stream->event_id;
611
612 /* print event header */
613 if (likely(stream->stream_event_header)) {
614 ret = generic_rw(pos, &stream->stream_event_header->p);
615 if (ret)
616 goto error;
617 }
618
619 /* print stream-declared event context */
620 if (stream->stream_event_context) {
621 ret = generic_rw(pos, &stream->stream_event_context->p);
622 if (ret)
623 goto error;
624 }
625
626 if (unlikely(id >= stream_class->events_by_id->len)) {
627 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
628 return -EINVAL;
629 }
630 event = g_ptr_array_index(stream->events_by_id, id);
631 if (unlikely(!event)) {
632 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
633 return -EINVAL;
634 }
635
636 /* print event-declared event context */
637 if (event->event_context) {
638 ret = generic_rw(pos, &event->event_context->p);
639 if (ret)
640 goto error;
641 }
642
643 /* Read and print event payload */
644 if (likely(event->event_fields)) {
645 ret = generic_rw(pos, &event->event_fields->p);
646 if (ret)
647 goto error;
648 }
649
650 return 0;
651
652 error:
653 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
654 return ret;
655 }
656
657 /*
658 * One side-effect of this function is to unmap pos mmap base if one is
659 * mapped.
660 */
661 static
662 int find_data_offset(struct ctf_stream_pos *pos,
663 struct ctf_file_stream *file_stream,
664 struct packet_index *packet_index)
665 {
666 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
667 struct stat filestats;
668 size_t filesize;
669 int ret;
670
671 pos = &file_stream->pos;
672
673 ret = fstat(pos->fd, &filestats);
674 if (ret < 0)
675 return ret;
676 filesize = filestats.st_size;
677
678 /* Deal with empty files */
679 if (!filesize) {
680 return 0;
681 }
682
683 begin:
684 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
685 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
686 }
687
688 if (pos->base_mma) {
689 /* unmap old base */
690 ret = munmap_align(pos->base_mma);
691 if (ret) {
692 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
693 strerror(errno));
694 return ret;
695 }
696 pos->base_mma = NULL;
697 }
698 /* map new base. Need mapping length from header. */
699 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
700 MAP_PRIVATE, pos->fd, pos->mmap_offset);
701 assert(pos->base_mma != MAP_FAILED);
702
703 pos->content_size = packet_map_len;
704 pos->packet_size = packet_map_len;
705 pos->offset = 0; /* Position of the packet header */
706
707 /* update trace_packet_header and stream_packet_context */
708 if (pos->prot == PROT_READ && file_stream->parent.trace_packet_header) {
709 /* Read packet header */
710 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
711 if (ret) {
712 if (ret == -EFAULT)
713 goto retry;
714 }
715 }
716 if (pos->prot == PROT_READ && file_stream->parent.stream_packet_context) {
717 /* Read packet context */
718 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
719 if (ret) {
720 if (ret == -EFAULT)
721 goto retry;
722 }
723 }
724 packet_index->data_offset = pos->offset;
725
726 /* unmap old base */
727 ret = munmap_align(pos->base_mma);
728 if (ret) {
729 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
730 strerror(errno));
731 return ret;
732 }
733 pos->base_mma = NULL;
734
735 return 0;
736
737 /* Retry with larger mapping */
738 retry:
739 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
740 /*
741 * Reached EOF, but still expecting header/context data.
742 */
743 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
744 return -EFAULT;
745 }
746 /* Double the mapping len, and retry */
747 tmp_map_len = packet_map_len << 1;
748 if (tmp_map_len >> 1 != packet_map_len) {
749 /* Overflow */
750 fprintf(stderr, "[error] Packet mapping length overflow\n");
751 return -EFAULT;
752 }
753 packet_map_len = tmp_map_len;
754 goto begin;
755 }
756
757
758 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
759 int fd, int open_flags)
760 {
761 pos->fd = fd;
762 if (fd >= 0) {
763 pos->packet_index = g_array_new(FALSE, TRUE,
764 sizeof(struct packet_index));
765 } else {
766 pos->packet_index = NULL;
767 }
768 switch (open_flags & O_ACCMODE) {
769 case O_RDONLY:
770 pos->prot = PROT_READ;
771 pos->flags = MAP_PRIVATE;
772 pos->parent.rw_table = read_dispatch_table;
773 pos->parent.event_cb = ctf_read_event;
774 pos->parent.trace = trace;
775 break;
776 case O_RDWR:
777 pos->prot = PROT_READ | PROT_WRITE;
778 pos->flags = MAP_SHARED;
779 pos->parent.rw_table = write_dispatch_table;
780 pos->parent.event_cb = ctf_write_event;
781 pos->parent.trace = trace;
782 if (fd >= 0)
783 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
784 break;
785 default:
786 assert(0);
787 }
788 return 0;
789 }
790
791 int ctf_fini_pos(struct ctf_stream_pos *pos)
792 {
793 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
794 *pos->content_size_loc = pos->offset;
795 if (pos->base_mma) {
796 int ret;
797
798 /* unmap old base */
799 ret = munmap_align(pos->base_mma);
800 if (ret) {
801 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
802 strerror(errno));
803 return -1;
804 }
805 }
806 if (pos->packet_index)
807 (void) g_array_free(pos->packet_index, TRUE);
808 return 0;
809 }
810
811 void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
812 struct packet_index *prev_index,
813 struct packet_index *cur_index)
814 {
815 uint64_t events_discarded_diff;
816 uint64_t packets_lost_diff = 0;
817
818 /* Update packet index time information */
819
820 /* Current packet begin/end */
821 stream->current.real.begin =
822 cur_index->ts_real.timestamp_begin;
823 stream->current.cycles.begin =
824 cur_index->ts_cycles.timestamp_begin;
825 stream->current.real.end =
826 cur_index->ts_real.timestamp_end;
827 stream->current.cycles.end =
828 cur_index->ts_cycles.timestamp_end;
829
830 /* Update packet index discarded event information */
831 events_discarded_diff = cur_index->events_discarded;
832 if (prev_index) {
833 /* Previous packet begin/end */
834 stream->prev.cycles.begin =
835 prev_index->ts_cycles.timestamp_begin;
836 stream->prev.real.begin =
837 prev_index->ts_real.timestamp_begin;
838 stream->prev.cycles.end =
839 prev_index->ts_cycles.timestamp_end;
840 stream->prev.real.end =
841 prev_index->ts_real.timestamp_end;
842
843 events_discarded_diff -= prev_index->events_discarded;
844 /* packet_seq_num stays at 0 if not produced by the tracer */
845 if (cur_index->packet_seq_num) {
846 packets_lost_diff = cur_index->packet_seq_num -
847 prev_index->packet_seq_num - 1;
848 }
849 /*
850 * Deal with 32-bit wrap-around if the tracer provided a
851 * 32-bit field.
852 */
853 if (prev_index->events_discarded_len == 32) {
854 events_discarded_diff = (uint32_t) events_discarded_diff;
855 }
856 } else {
857 /*
858 * First packet: use current packet info as limits for
859 * previous packet.
860 */
861 stream->prev.cycles.begin =
862 stream->prev.cycles.end =
863 stream->current.cycles.begin;
864 stream->prev.real.begin =
865 stream->prev.real.end =
866 stream->current.real.begin;
867 }
868 stream->events_discarded = events_discarded_diff;
869 stream->packets_lost = packets_lost_diff;
870 }
871
872 /*
873 * Find the timerange where all the streams in the trace are active
874 * simultaneously.
875 *
876 * Return 0 and update begin/end if necessary on success, return 1 for
877 * empty streams and return a negative value on error.
878 */
879 static
880 int ctf_intersect_trace(struct bt_trace_descriptor *td_read,
881 uint64_t *begin, uint64_t *end)
882 {
883 struct ctf_trace *tin;
884 int stream_id, ret = 0;
885
886 tin = container_of(td_read, struct ctf_trace, parent);
887
888 for (stream_id = 0; stream_id < tin->streams->len;
889 stream_id++) {
890 int filenr;
891 struct ctf_stream_declaration *stream_class;
892
893 stream_class = g_ptr_array_index(tin->streams, stream_id);
894 if (!stream_class) {
895 continue;
896 }
897 for (filenr = 0; filenr < stream_class->streams->len; filenr++) {
898 struct ctf_file_stream *file_stream;
899 struct ctf_stream_pos *stream_pos;
900 struct packet_index *index;
901
902 file_stream = g_ptr_array_index(stream_class->streams,
903 filenr);
904 if (!file_stream) {
905 continue;
906 }
907 stream_pos = &file_stream->pos;
908 if (!stream_pos->packet_index ||
909 stream_pos->packet_index->len <= 0) {
910 ret = 1;
911 goto end;
912 }
913 index = &g_array_index(stream_pos->packet_index,
914 struct packet_index, 0);
915 if (index->ts_real.timestamp_begin > *begin) {
916 *begin = index->ts_real.timestamp_begin;
917 }
918 index = &g_array_index(stream_pos->packet_index,
919 struct packet_index,
920 stream_pos->packet_index->len - 1);
921 if (index->ts_real.timestamp_end < *end) {
922 *end = index->ts_real.timestamp_end;
923 }
924 }
925 }
926
927 end:
928 return ret;
929 }
930
931 /*
932 * Find the timerange where all streams in the trace collection are active
933 * simultaneously.
934 *
935 * Return 0 on success.
936 * Return 1 if no intersections are found.
937 * Return a negative value on error.
938 */
939 int ctf_find_packets_intersection(struct bt_context *ctx,
940 uint64_t *ts_begin, uint64_t *ts_end)
941 {
942 int ret, i;
943
944 if (!ctx || !ctx->tc || !ctx->tc->array) {
945 ret = -EINVAL;
946 goto end;
947 }
948
949 for (i = 0; i < ctx->tc->array->len; i++) {
950 struct bt_trace_descriptor *td_read;
951
952 td_read = g_ptr_array_index(ctx->tc->array, i);
953 if (!td_read) {
954 continue;
955 }
956 ret = ctf_intersect_trace(td_read, ts_begin, ts_end);
957 if (ret) {
958 goto end;
959 }
960 }
961 if (*ts_end < *ts_begin) {
962 ret = 1;
963 } else {
964 ret = 0;
965 }
966 end:
967 return ret;
968 }
969
970 /*
971 * for SEEK_CUR: go to next packet.
972 * for SEEK_SET: go to packet numer (index).
973 */
974 void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
975 {
976 struct ctf_stream_pos *pos =
977 container_of(stream_pos, struct ctf_stream_pos, parent);
978 struct ctf_file_stream *file_stream =
979 container_of(pos, struct ctf_file_stream, pos);
980 int ret;
981 struct packet_index *packet_index, *prev_index;
982
983 switch (whence) {
984 case SEEK_CUR:
985 case SEEK_SET: /* Fall-through */
986 break; /* OK */
987 default:
988 assert(0);
989 }
990
991 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
992 *pos->content_size_loc = pos->offset;
993
994 if (pos->base_mma) {
995 /* unmap old base */
996 ret = munmap_align(pos->base_mma);
997 if (ret) {
998 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
999 strerror(errno));
1000 assert(0);
1001 }
1002 pos->base_mma = NULL;
1003 }
1004
1005 /*
1006 * The caller should never ask for ctf_move_pos across packets,
1007 * except to get exactly at the beginning of the next packet.
1008 */
1009 if (pos->prot & PROT_WRITE) {
1010 switch (whence) {
1011 case SEEK_CUR:
1012 /* The writer will add padding */
1013 pos->mmap_offset += pos->packet_size / CHAR_BIT;
1014 break;
1015 case SEEK_SET:
1016 assert(index == 0); /* only seek supported for now */
1017 pos->cur_index = 0;
1018 break;
1019 default:
1020 assert(0);
1021 }
1022 pos->content_size = -1U; /* Unknown at this point */
1023 pos->packet_size = WRITE_PACKET_LEN;
1024 do {
1025 ret = bt_posix_fallocate(pos->fd, pos->mmap_offset,
1026 pos->packet_size / CHAR_BIT);
1027 } while (ret == EINTR);
1028 assert(ret == 0);
1029 pos->offset = 0;
1030 } else {
1031 read_next_packet:
1032 switch (whence) {
1033 case SEEK_CUR:
1034 {
1035 if (pos->offset == EOF) {
1036 return;
1037 }
1038 assert(pos->cur_index < pos->packet_index->len);
1039 /* The reader will expect us to skip padding */
1040 ++pos->cur_index;
1041 break;
1042 }
1043 case SEEK_SET:
1044 if (index >= pos->packet_index->len) {
1045 pos->offset = EOF;
1046 return;
1047 }
1048 pos->cur_index = index;
1049 break;
1050 default:
1051 assert(0);
1052 }
1053
1054 if (pos->cur_index >= pos->packet_index->len) {
1055 pos->offset = EOF;
1056 return;
1057 }
1058
1059 packet_index = &g_array_index(pos->packet_index,
1060 struct packet_index, pos->cur_index);
1061 if (pos->cur_index > 0) {
1062 prev_index = &g_array_index(pos->packet_index,
1063 struct packet_index,
1064 pos->cur_index - 1);
1065 } else {
1066 prev_index = NULL;
1067 }
1068 ctf_update_current_packet_index(&file_stream->parent,
1069 prev_index, packet_index);
1070
1071 /*
1072 * We need to check if we are in trace read or called
1073 * from packet indexing. In this last case, the
1074 * collection is not there, so we cannot print the
1075 * timestamps.
1076 */
1077 if ((&file_stream->parent)->stream_class->trace->parent.collection) {
1078 ctf_print_discarded_lost(stderr, &file_stream->parent);
1079 }
1080
1081 packet_index = &g_array_index(pos->packet_index,
1082 struct packet_index,
1083 pos->cur_index);
1084 file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
1085
1086 file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin;
1087
1088 /* Lookup context/packet size in index */
1089 if (packet_index->data_offset == -1) {
1090 ret = find_data_offset(pos, file_stream, packet_index);
1091 if (ret < 0) {
1092 return;
1093 }
1094 }
1095 pos->content_size = packet_index->content_size;
1096 pos->packet_size = packet_index->packet_size;
1097 pos->mmap_offset = packet_index->offset;
1098 pos->data_offset = packet_index->data_offset;
1099 if (pos->data_offset < packet_index->content_size) {
1100 pos->offset = 0; /* will read headers */
1101 } else if (pos->data_offset == packet_index->content_size) {
1102 /* empty packet */
1103 pos->offset = packet_index->data_offset;
1104 whence = SEEK_CUR;
1105 goto read_next_packet;
1106 } else {
1107 pos->offset = EOF;
1108 return;
1109 }
1110 }
1111 /* map new base. Need mapping length from header. */
1112 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
1113 pos->flags, pos->fd, pos->mmap_offset);
1114 if (pos->base_mma == MAP_FAILED) {
1115 fprintf(stderr, "[error] mmap error %s.\n",
1116 strerror(errno));
1117 assert(0);
1118 }
1119
1120 /* update trace_packet_header and stream_packet_context */
1121 if (!(pos->prot & PROT_WRITE) &&
1122 file_stream->parent.trace_packet_header) {
1123 /* Read packet header */
1124 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1125 assert(!ret);
1126 }
1127 if (!(pos->prot & PROT_WRITE) &&
1128 file_stream->parent.stream_packet_context) {
1129 /* Read packet context */
1130 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1131 assert(!ret);
1132 }
1133 }
1134
1135 static
1136 int packet_metadata(struct ctf_trace *td, FILE *fp)
1137 {
1138 uint32_t magic;
1139 size_t len;
1140 int ret = 0;
1141
1142 len = fread(&magic, sizeof(magic), 1, fp);
1143 if (len != 1) {
1144 goto end;
1145 }
1146 if (magic == TSDL_MAGIC) {
1147 ret = 1;
1148 td->byte_order = BYTE_ORDER;
1149 CTF_TRACE_SET_FIELD(td, byte_order);
1150 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
1151 ret = 1;
1152 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
1153 LITTLE_ENDIAN : BIG_ENDIAN;
1154 CTF_TRACE_SET_FIELD(td, byte_order);
1155 }
1156 end:
1157 rewind(fp);
1158 return ret;
1159 }
1160
1161 /*
1162 * Returns 0 on success, -1 on error.
1163 */
1164 static
1165 int check_version(unsigned int major, unsigned int minor)
1166 {
1167 switch (major) {
1168 case 1:
1169 switch (minor) {
1170 case 8:
1171 return 0;
1172 default:
1173 goto warning;
1174 }
1175 default:
1176 goto warning;
1177
1178 }
1179
1180 /* eventually return an error instead of warning */
1181 warning:
1182 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1183 major, minor);
1184 return 0;
1185 }
1186
1187 static
1188 int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
1189 FILE *out)
1190 {
1191 struct metadata_packet_header header;
1192 size_t readlen, writelen, toread;
1193 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
1194 int ret = 0;
1195
1196 readlen = fread(&header, header_sizeof(header), 1, in);
1197 if (readlen < 1)
1198 return -EINVAL;
1199
1200 if (td->byte_order != BYTE_ORDER) {
1201 header.magic = GUINT32_SWAP_LE_BE(header.magic);
1202 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
1203 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
1204 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
1205 }
1206 if (header.checksum)
1207 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
1208 if (header.compression_scheme) {
1209 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
1210 header.compression_scheme);
1211 return -EINVAL;
1212 }
1213 if (header.encryption_scheme) {
1214 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
1215 header.encryption_scheme);
1216 return -EINVAL;
1217 }
1218 if (header.checksum_scheme) {
1219 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
1220 header.checksum_scheme);
1221 return -EINVAL;
1222 }
1223 if (check_version(header.major, header.minor) < 0)
1224 return -EINVAL;
1225 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
1226 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
1227 CTF_TRACE_SET_FIELD(td, uuid);
1228 } else {
1229 if (bt_uuid_compare(header.uuid, td->uuid))
1230 return -EINVAL;
1231 }
1232
1233 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
1234 return -EINVAL;
1235
1236 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
1237
1238 for (;;) {
1239 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
1240 if (ferror(in)) {
1241 ret = -EINVAL;
1242 break;
1243 }
1244 if (babeltrace_debug) {
1245 buf[readlen] = '\0';
1246 fprintf(stderr, "[debug] metadata packet read: %s\n",
1247 buf);
1248 }
1249
1250 writelen = fwrite(buf, sizeof(char), readlen, out);
1251 if (writelen < readlen) {
1252 ret = -EIO;
1253 break;
1254 }
1255 if (ferror(out)) {
1256 ret = -EINVAL;
1257 break;
1258 }
1259 toread -= readlen;
1260 if (!toread) {
1261 ret = 0; /* continue reading next packet */
1262 goto read_padding;
1263 }
1264 }
1265 return ret;
1266
1267 read_padding:
1268 toread = (header.packet_size - header.content_size) / CHAR_BIT;
1269 ret = fseek(in, toread, SEEK_CUR);
1270 if (ret < 0) {
1271 fprintf(stderr, "[warning] Missing padding at end of file\n");
1272 ret = 0;
1273 }
1274 return ret;
1275 }
1276
1277 static
1278 int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
1279 char **buf)
1280 {
1281 FILE *in, *out;
1282 size_t size, buflen;
1283 int ret;
1284
1285 in = *fp;
1286 /*
1287 * Using strlen on *buf instead of size of open_memstream
1288 * because its size includes garbage at the end (after final
1289 * \0). This is the allocated size, not the actual string size.
1290 */
1291 out = babeltrace_open_memstream(buf, &size);
1292 if (out == NULL) {
1293 perror("Metadata open_memstream");
1294 return -errno;
1295 }
1296 for (;;) {
1297 ret = ctf_trace_metadata_packet_read(td, in, out);
1298 if (ret) {
1299 break;
1300 }
1301 if (feof(in)) {
1302 ret = 0;
1303 break;
1304 }
1305 }
1306 /* close to flush the buffer */
1307 ret = babeltrace_close_memstream(buf, &size, out);
1308 if (ret < 0) {
1309 int closeret;
1310
1311 perror("babeltrace_flush_memstream");
1312 ret = -errno;
1313 closeret = fclose(in);
1314 if (closeret) {
1315 perror("Error in fclose");
1316 }
1317 return ret;
1318 }
1319 ret = fclose(in);
1320 if (ret) {
1321 perror("Error in fclose");
1322 }
1323 /* open for reading */
1324 buflen = strlen(*buf);
1325 if (!buflen) {
1326 *fp = NULL;
1327 return -ENOENT;
1328 }
1329 *fp = babeltrace_fmemopen(*buf, buflen, "rb");
1330 if (!*fp) {
1331 perror("Metadata fmemopen");
1332 return -errno;
1333 }
1334 return 0;
1335 }
1336
1337 static
1338 int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp,
1339 struct ctf_scanner *scanner, int append)
1340 {
1341 struct ctf_file_stream *metadata_stream;
1342 FILE *fp;
1343 char *buf = NULL;
1344 int ret = 0, closeret;
1345
1346 metadata_stream = g_new0(struct ctf_file_stream, 1);
1347 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1348
1349 if (metadata_fp) {
1350 fp = metadata_fp;
1351 metadata_stream->pos.fd = -1;
1352 } else {
1353 td->metadata = &metadata_stream->parent;
1354 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1355 if (metadata_stream->pos.fd < 0) {
1356 fprintf(stderr, "Unable to open metadata.\n");
1357 ret = -1;
1358 goto end_free;
1359 }
1360
1361 fp = fdopen(metadata_stream->pos.fd, "r");
1362 if (!fp) {
1363 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1364 perror("Metadata stream open");
1365 ret = -errno;
1366 goto end_stream;
1367 }
1368 /* fd now belongs to fp */
1369 metadata_stream->pos.fd = -1;
1370 }
1371 if (babeltrace_debug)
1372 yydebug = 1;
1373
1374 if (packet_metadata(td, fp)) {
1375 ret = ctf_trace_metadata_stream_read(td, &fp, &buf);
1376 if (ret) {
1377 goto end;
1378 }
1379 td->metadata_string = buf;
1380 td->metadata_packetized = 1;
1381 } else {
1382 if (!append) {
1383 unsigned int major, minor;
1384 ssize_t nr_items;
1385
1386 td->byte_order = BYTE_ORDER;
1387
1388 /* Check text-only metadata header and version */
1389 nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
1390 if (nr_items < 2)
1391 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1392 if (check_version(major, minor) < 0) {
1393 ret = -EINVAL;
1394 goto end;
1395 }
1396 rewind(fp);
1397 }
1398 }
1399
1400 ret = ctf_scanner_append_ast(scanner, fp);
1401 if (ret) {
1402 fprintf(stderr, "[error] Error creating AST\n");
1403 goto end;
1404 }
1405
1406 if (babeltrace_debug) {
1407 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1408 if (ret) {
1409 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1410 goto end;
1411 }
1412 }
1413
1414 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1415 if (ret) {
1416 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1417 goto end;
1418 }
1419 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1420 td, td->byte_order);
1421 if (ret) {
1422 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1423 goto end;
1424 }
1425 end:
1426 if (fp) {
1427 closeret = fclose(fp);
1428 if (closeret) {
1429 perror("Error on fclose");
1430 }
1431 }
1432 end_stream:
1433 if (metadata_stream->pos.fd >= 0) {
1434 closeret = close(metadata_stream->pos.fd);
1435 if (closeret) {
1436 perror("Error on metadata stream fd close");
1437 }
1438 }
1439 end_free:
1440 if (ret)
1441 g_free(metadata_stream);
1442 return ret;
1443 }
1444
1445 static
1446 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1447 struct ctf_stream_definition *stream,
1448 struct ctf_event_declaration *event)
1449 {
1450 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1451
1452 if (event->context_decl) {
1453 struct bt_definition *definition =
1454 event->context_decl->p.definition_new(&event->context_decl->p,
1455 stream->parent_def_scope, 0, 0, "event.context");
1456 if (!definition) {
1457 goto error;
1458 }
1459 stream_event->event_context = container_of(definition,
1460 struct definition_struct, p);
1461 stream->parent_def_scope = stream_event->event_context->p.scope;
1462 }
1463 if (event->fields_decl) {
1464 struct bt_definition *definition =
1465 event->fields_decl->p.definition_new(&event->fields_decl->p,
1466 stream->parent_def_scope, 0, 0, "event.fields");
1467 if (!definition) {
1468 goto error;
1469 }
1470 stream_event->event_fields = container_of(definition,
1471 struct definition_struct, p);
1472 stream->parent_def_scope = stream_event->event_fields->p.scope;
1473 }
1474 stream_event->stream = stream;
1475 return stream_event;
1476
1477 error:
1478 if (stream_event->event_fields)
1479 bt_definition_unref(&stream_event->event_fields->p);
1480 if (stream_event->event_context)
1481 bt_definition_unref(&stream_event->event_context->p);
1482 fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n",
1483 g_quark_to_string(event->name));
1484 return NULL;
1485 }
1486
1487 static
1488 int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td,
1489 struct ctf_stream_declaration *stream_class,
1490 struct ctf_stream_definition *stream)
1491 {
1492 size_t def_size, class_size, i;
1493 int ret = 0;
1494
1495 def_size = stream->events_by_id->len;
1496 class_size = stream_class->events_by_id->len;
1497
1498 g_ptr_array_set_size(stream->events_by_id, class_size);
1499 for (i = def_size; i < class_size; i++) {
1500 struct ctf_event_declaration *event =
1501 g_ptr_array_index(stream_class->events_by_id, i);
1502 struct ctf_event_definition *stream_event;
1503
1504 if (!event)
1505 continue;
1506 stream_event = create_event_definitions(td, stream, event);
1507 if (!stream_event) {
1508 ret = -EINVAL;
1509 goto error;
1510 }
1511 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1512 }
1513 error:
1514 return ret;
1515 }
1516
1517 static
1518 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1519 {
1520 struct ctf_stream_declaration *stream_class;
1521 int ret;
1522 int i;
1523
1524 if (stream->stream_definitions_created)
1525 return 0;
1526
1527 stream_class = stream->stream_class;
1528
1529 if (stream_class->packet_context_decl) {
1530 struct bt_definition *definition =
1531 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1532 stream->parent_def_scope, 0, 0, "stream.packet.context");
1533 if (!definition) {
1534 ret = -EINVAL;
1535 goto error;
1536 }
1537 stream->stream_packet_context = container_of(definition,
1538 struct definition_struct, p);
1539 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1540 }
1541 if (stream_class->event_header_decl) {
1542 struct bt_definition *definition =
1543 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1544 stream->parent_def_scope, 0, 0, "stream.event.header");
1545 if (!definition) {
1546 ret = -EINVAL;
1547 goto error;
1548 }
1549 stream->stream_event_header =
1550 container_of(definition, struct definition_struct, p);
1551 stream->parent_def_scope = stream->stream_event_header->p.scope;
1552 }
1553 if (stream_class->event_context_decl) {
1554 struct bt_definition *definition =
1555 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1556 stream->parent_def_scope, 0, 0, "stream.event.context");
1557 if (!definition) {
1558 ret = -EINVAL;
1559 goto error;
1560 }
1561 stream->stream_event_context =
1562 container_of(definition, struct definition_struct, p);
1563 stream->parent_def_scope = stream->stream_event_context->p.scope;
1564 }
1565 stream->events_by_id = g_ptr_array_new();
1566 ret = copy_event_declarations_stream_class_to_stream(td,
1567 stream_class, stream);
1568 if (ret)
1569 goto error_event;
1570 return 0;
1571
1572 error_event:
1573 for (i = 0; i < stream->events_by_id->len; i++) {
1574 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1575 if (stream_event)
1576 g_free(stream_event);
1577 }
1578 g_ptr_array_free(stream->events_by_id, TRUE);
1579 error:
1580 if (stream->stream_event_context)
1581 bt_definition_unref(&stream->stream_event_context->p);
1582 if (stream->stream_event_header)
1583 bt_definition_unref(&stream->stream_event_header->p);
1584 if (stream->stream_packet_context)
1585 bt_definition_unref(&stream->stream_packet_context->p);
1586 fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n",
1587 stream_class->stream_id, strerror(-ret));
1588 return ret;
1589 }
1590
1591 static
1592 int stream_assign_class(struct ctf_trace *td,
1593 struct ctf_file_stream *file_stream,
1594 uint64_t stream_id)
1595 {
1596 struct ctf_stream_declaration *stream;
1597 int ret;
1598
1599 file_stream->parent.stream_id = stream_id;
1600 if (stream_id >= td->streams->len) {
1601 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1602 return -EINVAL;
1603 }
1604 stream = g_ptr_array_index(td->streams, stream_id);
1605 if (!stream) {
1606 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1607 return -EINVAL;
1608 }
1609 file_stream->parent.stream_class = stream;
1610 ret = create_stream_definitions(td, &file_stream->parent);
1611 if (ret)
1612 return ret;
1613 return 0;
1614 }
1615
1616 static
1617 int create_stream_one_packet_index(struct ctf_stream_pos *pos,
1618 struct ctf_trace *td,
1619 struct ctf_file_stream *file_stream,
1620 size_t filesize)
1621 {
1622 struct packet_index packet_index;
1623 uint64_t stream_id = 0;
1624 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
1625 int first_packet = 0;
1626 int len_index;
1627 int ret;
1628
1629 begin:
1630 memset(&packet_index, 0, sizeof(packet_index));
1631 if (!pos->mmap_offset) {
1632 first_packet = 1;
1633 }
1634
1635 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
1636 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
1637 }
1638
1639 if (pos->base_mma) {
1640 /* unmap old base */
1641 ret = munmap_align(pos->base_mma);
1642 if (ret) {
1643 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1644 strerror(errno));
1645 return ret;
1646 }
1647 pos->base_mma = NULL;
1648 }
1649 /* map new base. Need mapping length from header. */
1650 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
1651 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1652 assert(pos->base_mma != MAP_FAILED);
1653 /*
1654 * Use current mapping size as temporary content and packet
1655 * size.
1656 */
1657 pos->content_size = packet_map_len;
1658 pos->packet_size = packet_map_len;
1659 pos->offset = 0; /* Position of the packet header */
1660
1661 packet_index.offset = pos->mmap_offset;
1662
1663 /* read and check header, set stream id (and check) */
1664 if (file_stream->parent.trace_packet_header) {
1665 /* Read packet header */
1666 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1667 if (ret) {
1668 if (ret == -EFAULT)
1669 goto retry;
1670 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1671 return ret;
1672 }
1673 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1674 if (len_index >= 0) {
1675 struct bt_definition *field;
1676 uint64_t magic;
1677
1678 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1679 magic = bt_get_unsigned_int(field);
1680 if (magic != CTF_MAGIC) {
1681 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1682 magic,
1683 file_stream->pos.packet_index->len,
1684 (ssize_t) pos->mmap_offset);
1685 return -EINVAL;
1686 }
1687 }
1688
1689 /* check uuid */
1690 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1691 if (len_index >= 0) {
1692 struct definition_array *defarray;
1693 struct bt_definition *field;
1694 uint64_t i;
1695 uint8_t uuidval[BABELTRACE_UUID_LEN];
1696
1697 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1698 assert(field->declaration->id == CTF_TYPE_ARRAY);
1699 defarray = container_of(field, struct definition_array, p);
1700 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1701
1702 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1703 struct bt_definition *elem;
1704
1705 elem = bt_array_index(defarray, i);
1706 uuidval[i] = bt_get_unsigned_int(elem);
1707 }
1708 ret = bt_uuid_compare(td->uuid, uuidval);
1709 if (ret) {
1710 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1711 return -EINVAL;
1712 }
1713 }
1714
1715 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1716 if (len_index >= 0) {
1717 struct bt_definition *field;
1718
1719 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1720 stream_id = bt_get_unsigned_int(field);
1721 }
1722 }
1723
1724 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1725 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1726 stream_id,
1727 file_stream->parent.stream_id);
1728 return -EINVAL;
1729 }
1730 if (first_packet) {
1731 ret = stream_assign_class(td, file_stream, stream_id);
1732 if (ret)
1733 return ret;
1734 }
1735
1736 if (file_stream->parent.stream_packet_context) {
1737 /* Read packet context */
1738 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1739 if (ret) {
1740 if (ret == -EFAULT)
1741 goto retry;
1742 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1743 return ret;
1744 }
1745 /* read packet size from header */
1746 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1747 if (len_index >= 0) {
1748 struct bt_definition *field;
1749
1750 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1751 packet_index.packet_size = bt_get_unsigned_int(field);
1752 } else {
1753 /* Use file size for packet size */
1754 packet_index.packet_size = filesize * CHAR_BIT;
1755 }
1756
1757 /* read content size from header */
1758 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1759 if (len_index >= 0) {
1760 struct bt_definition *field;
1761
1762 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1763 packet_index.content_size = bt_get_unsigned_int(field);
1764 } else {
1765 /* Use packet size if non-zero, else file size */
1766 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1767 }
1768
1769 /* read timestamp begin from header */
1770 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1771 if (len_index >= 0) {
1772 struct bt_definition *field;
1773
1774 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1775 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1776 if (file_stream->parent.stream_class->trace->parent.collection) {
1777 packet_index.ts_real.timestamp_begin =
1778 ctf_get_real_timestamp(
1779 &file_stream->parent,
1780 packet_index.ts_cycles.timestamp_begin);
1781 }
1782 }
1783
1784 /* read timestamp end from header */
1785 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1786 if (len_index >= 0) {
1787 struct bt_definition *field;
1788
1789 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1790 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1791 if (file_stream->parent.stream_class->trace->parent.collection) {
1792 packet_index.ts_real.timestamp_end =
1793 ctf_get_real_timestamp(
1794 &file_stream->parent,
1795 packet_index.ts_cycles.timestamp_end);
1796 }
1797 }
1798
1799 /* read events discarded from header */
1800 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1801 if (len_index >= 0) {
1802 struct bt_definition *field;
1803
1804 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1805 packet_index.events_discarded = bt_get_unsigned_int(field);
1806 packet_index.events_discarded_len = bt_get_int_len(field);
1807 }
1808
1809 /* read packet_seq_num from header */
1810 len_index = bt_struct_declaration_lookup_field_index(
1811 file_stream->parent.stream_packet_context->declaration,
1812 g_quark_from_static_string("packet_seq_num"));
1813 if (len_index >= 0) {
1814 struct bt_definition *field;
1815
1816 field = bt_struct_definition_get_field_from_index(
1817 file_stream->parent.stream_packet_context,
1818 len_index);
1819 packet_index.packet_seq_num = bt_get_unsigned_int(field);
1820 }
1821 } else {
1822 /* Use file size for packet size */
1823 packet_index.packet_size = filesize * CHAR_BIT;
1824 /* Use packet size if non-zero, else file size */
1825 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1826 }
1827
1828 /* Validate content size and packet size values */
1829 if (packet_index.content_size > packet_index.packet_size) {
1830 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1831 packet_index.content_size, packet_index.packet_size);
1832 return -EINVAL;
1833 }
1834
1835 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1836 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1837 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1838 return -EINVAL;
1839 }
1840
1841 if (packet_index.content_size < pos->offset) {
1842 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1843 return -EINVAL;
1844 }
1845
1846 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1847 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1848 return -EINVAL;
1849 }
1850
1851 /* Save position after header and context */
1852 packet_index.data_offset = pos->offset;
1853
1854 /* add index to packet array */
1855 g_array_append_val(file_stream->pos.packet_index, packet_index);
1856
1857 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1858
1859 return 0;
1860
1861 /* Retry with larger mapping */
1862 retry:
1863 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1864 /*
1865 * Reached EOF, but still expecting header/context data.
1866 */
1867 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1868 return -EFAULT;
1869 }
1870 /* Double the mapping len, and retry */
1871 tmp_map_len = packet_map_len << 1;
1872 if (tmp_map_len >> 1 != packet_map_len) {
1873 /* Overflow */
1874 fprintf(stderr, "[error] Packet mapping length overflow\n");
1875 return -EFAULT;
1876 }
1877 packet_map_len = tmp_map_len;
1878 goto begin;
1879 }
1880
1881 static
1882 int create_stream_packet_index(struct ctf_trace *td,
1883 struct ctf_file_stream *file_stream)
1884 {
1885 struct ctf_stream_pos *pos;
1886 struct stat filestats;
1887 int ret;
1888
1889 pos = &file_stream->pos;
1890
1891 ret = fstat(pos->fd, &filestats);
1892 if (ret < 0)
1893 return ret;
1894
1895 /* Deal with empty files */
1896 if (!filestats.st_size) {
1897 if (file_stream->parent.trace_packet_header
1898 || file_stream->parent.stream_packet_context) {
1899 /*
1900 * We expect a trace packet header and/or stream packet
1901 * context. Since a trace needs to have at least one
1902 * packet, empty files are therefore not accepted.
1903 */
1904 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1905 return -EINVAL;
1906 } else {
1907 /*
1908 * Without trace packet header nor stream packet
1909 * context, a one-packet trace can indeed be empty. This
1910 * is only valid if there is only one stream class: 0.
1911 */
1912 ret = stream_assign_class(td, file_stream, 0);
1913 if (ret)
1914 return ret;
1915 return 0;
1916 }
1917 }
1918
1919 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1920 ret = create_stream_one_packet_index(pos, td, file_stream,
1921 filestats.st_size);
1922 if (ret)
1923 return ret;
1924 }
1925 return 0;
1926 }
1927
1928 static
1929 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1930 {
1931 int ret;
1932
1933 if (td->packet_header_decl) {
1934 struct bt_definition *definition =
1935 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1936 stream->parent_def_scope, 0, 0, "trace.packet.header");
1937 if (!definition) {
1938 ret = -EINVAL;
1939 goto error;
1940 }
1941 stream->trace_packet_header =
1942 container_of(definition, struct definition_struct, p);
1943 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1944 }
1945
1946 return 0;
1947
1948 error:
1949 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1950 return ret;
1951 }
1952
1953 static
1954 int import_stream_packet_index(struct ctf_trace *td,
1955 struct ctf_file_stream *file_stream)
1956 {
1957 struct ctf_stream_pos *pos;
1958 struct ctf_packet_index *ctf_index = NULL;
1959 struct ctf_packet_index_file_hdr index_hdr;
1960 struct packet_index index;
1961 uint32_t packet_index_len, index_minor;
1962 int ret = 0;
1963 int first_packet = 1;
1964 size_t len;
1965
1966 pos = &file_stream->pos;
1967
1968 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1969 if (len != 1) {
1970 perror("read index file header");
1971 goto error;
1972 }
1973
1974 /* Check the index header */
1975 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1976 fprintf(stderr, "[error] wrong index magic\n");
1977 ret = -1;
1978 goto error;
1979 }
1980 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1981 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1982 ".%" PRIu32 ", supported %d.%d\n",
1983 be32toh(index_hdr.index_major),
1984 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1985 CTF_INDEX_MINOR);
1986 ret = -1;
1987 goto error;
1988 }
1989 index_minor = be32toh(index_hdr.index_minor);
1990
1991 packet_index_len = be32toh(index_hdr.packet_index_len);
1992 if (packet_index_len == 0) {
1993 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1994 ret = -1;
1995 goto error;
1996 }
1997 /*
1998 * Allocate the index length found in header, not internal
1999 * representation.
2000 */
2001 ctf_index = g_malloc0(packet_index_len);
2002 while (fread(ctf_index, packet_index_len, 1,
2003 pos->index_fp) == 1) {
2004 uint64_t stream_id;
2005 struct ctf_stream_declaration *stream = NULL;
2006
2007 memset(&index, 0, sizeof(index));
2008 index.offset = be64toh(ctf_index->offset);
2009 index.packet_size = be64toh(ctf_index->packet_size);
2010 index.content_size = be64toh(ctf_index->content_size);
2011 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
2012 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
2013 index.events_discarded = be64toh(ctf_index->events_discarded);
2014 index.events_discarded_len = 64;
2015 index.data_offset = -1;
2016 stream_id = be64toh(ctf_index->stream_id);
2017 if (index_minor >= 1) {
2018 index.stream_instance_id = be64toh(ctf_index->stream_instance_id);
2019 index.packet_seq_num = be64toh(ctf_index->packet_seq_num);
2020 }
2021
2022 if (!first_packet) {
2023 /* add index to packet array */
2024 g_array_append_val(file_stream->pos.packet_index, index);
2025 continue;
2026 }
2027
2028 file_stream->parent.stream_id = stream_id;
2029 if (stream_id < td->streams->len) {
2030 stream = g_ptr_array_index(td->streams, stream_id);
2031 }
2032 if (!stream) {
2033 fprintf(stderr, "[error] Stream %" PRIu64
2034 " is not declared in metadata.\n",
2035 stream_id);
2036 ret = -EINVAL;
2037 goto error;
2038 }
2039 file_stream->parent.stream_class = stream;
2040 ret = create_stream_definitions(td, &file_stream->parent);
2041 if (ret)
2042 goto error;
2043 first_packet = 0;
2044 /* add index to packet array */
2045 g_array_append_val(file_stream->pos.packet_index, index);
2046 }
2047
2048 /* Index containing only the header. */
2049 if (!file_stream->parent.stream_class) {
2050 ret = -1;
2051 goto error;
2052 }
2053
2054 ret = 0;
2055
2056 error:
2057 g_free(ctf_index);
2058 return ret;
2059 }
2060
2061 /*
2062 * Note: many file streams can inherit from the same stream class
2063 * description (metadata).
2064 */
2065 static
2066 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
2067 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2068 int whence))
2069 {
2070 int ret, fd, closeret;
2071 struct ctf_file_stream *file_stream;
2072 struct stat statbuf;
2073 char *index_name;
2074
2075 fd = openat(td->dirfd, path, flags);
2076 if (fd < 0) {
2077 perror("File stream openat()");
2078 ret = fd;
2079 goto error;
2080 }
2081
2082 /* Don't try to mmap subdirectories. Skip them, return success. */
2083 ret = fstat(fd, &statbuf);
2084 if (ret) {
2085 perror("File stream fstat()");
2086 goto fstat_error;
2087 }
2088 if (S_ISDIR(statbuf.st_mode)) {
2089 if (strncmp(path, "index", 5) != 0) {
2090 fprintf(stderr, "[warning] Skipping directory '%s' "
2091 "found in trace\n", path);
2092 }
2093 ret = 0;
2094 goto fd_is_dir_ok;
2095 }
2096 if (!statbuf.st_size) {
2097 /** Skip empty files. */
2098 ret = 0;
2099 goto fd_is_empty_file;
2100 }
2101
2102 file_stream = g_new0(struct ctf_file_stream, 1);
2103 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2104 file_stream->pos.fd = -1;
2105 file_stream->pos.index_fp = NULL;
2106
2107 strncpy(file_stream->parent.path, path, PATH_MAX);
2108 file_stream->parent.path[PATH_MAX - 1] = '\0';
2109
2110 if (packet_seek) {
2111 file_stream->pos.packet_seek = packet_seek;
2112 } else {
2113 fprintf(stderr, "[error] packet_seek function undefined.\n");
2114 ret = -1;
2115 goto error_def;
2116 }
2117
2118 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
2119 if (ret)
2120 goto error_def;
2121 ret = create_trace_definitions(td, &file_stream->parent);
2122 if (ret)
2123 goto error_def;
2124 /*
2125 * For now, only a single clock per trace is supported.
2126 */
2127 file_stream->parent.current_clock = td->parent.single_clock;
2128
2129 /*
2130 * Allocate the index name for this stream and try to open it.
2131 */
2132 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2133 if (!index_name) {
2134 fprintf(stderr, "[error] Cannot allocate index filename\n");
2135 ret = -ENOMEM;
2136 goto error_def;
2137 }
2138 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2139 INDEX_PATH, path);
2140
2141 if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) {
2142 ret = create_stream_packet_index(td, file_stream);
2143 if (ret) {
2144 fprintf(stderr, "[error] Stream index creation error.\n");
2145 goto error_index;
2146 }
2147 } else {
2148 ret = openat(td->dirfd, index_name, flags);
2149 if (ret < 0) {
2150 perror("Index file openat()");
2151 ret = -1;
2152 goto error_free;
2153 }
2154 file_stream->pos.index_fp = fdopen(ret, "r");
2155 if (!file_stream->pos.index_fp) {
2156 perror("fdopen() error");
2157 goto error_free;
2158 }
2159 ret = import_stream_packet_index(td, file_stream);
2160 if (ret) {
2161 ret = -1;
2162 goto error_index;
2163 }
2164 ret = fclose(file_stream->pos.index_fp);
2165 if (ret < 0) {
2166 perror("close index");
2167 goto error_free;
2168 }
2169 }
2170 free(index_name);
2171
2172 /* Add stream file to stream class */
2173 g_ptr_array_add(file_stream->parent.stream_class->streams,
2174 &file_stream->parent);
2175 return 0;
2176
2177 error_index:
2178 if (file_stream->pos.index_fp) {
2179 ret = fclose(file_stream->pos.index_fp);
2180 if (ret < 0) {
2181 perror("close index");
2182 }
2183 }
2184 if (file_stream->parent.trace_packet_header)
2185 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2186 error_free:
2187 free(index_name);
2188 error_def:
2189 closeret = ctf_fini_pos(&file_stream->pos);
2190 if (closeret) {
2191 fprintf(stderr, "Error on ctf_fini_pos\n");
2192 }
2193 g_free(file_stream);
2194 fd_is_empty_file:
2195 fd_is_dir_ok:
2196 fstat_error:
2197 closeret = close(fd);
2198 if (closeret) {
2199 perror("Error on fd close");
2200 }
2201 error:
2202 return ret;
2203 }
2204
2205 static
2206 int ctf_open_trace_read(struct ctf_trace *td,
2207 const char *path, int flags,
2208 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2209 int whence), FILE *metadata_fp)
2210 {
2211 struct ctf_scanner *scanner;
2212 int ret, closeret;
2213 struct dirent *dirent;
2214 struct dirent *diriter;
2215 size_t dirent_len;
2216 char *ext;
2217
2218 td->flags = flags;
2219
2220 /* Open trace directory */
2221 td->dir = opendir(path);
2222 if (!td->dir) {
2223 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2224 ret = -ENOENT;
2225 goto error;
2226 }
2227
2228 td->dirfd = open(path, 0);
2229 if (td->dirfd < 0) {
2230 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2231 perror("Trace directory open");
2232 ret = -errno;
2233 goto error_dirfd;
2234 }
2235 strncpy(td->parent.path, path, sizeof(td->parent.path));
2236 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2237
2238 /*
2239 * Keep the metadata file separate.
2240 * Keep scanner object local to the open. We don't support
2241 * incremental metadata append for on-disk traces.
2242 */
2243 scanner = ctf_scanner_alloc();
2244 if (!scanner) {
2245 fprintf(stderr, "[error] Error allocating scanner\n");
2246 ret = -ENOMEM;
2247 goto error_metadata;
2248 }
2249 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2250 ctf_scanner_free(scanner);
2251 if (ret) {
2252 if (ret == -ENOENT) {
2253 fprintf(stderr, "[warning] Empty metadata.\n");
2254 }
2255 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2256 goto error_metadata;
2257 }
2258
2259 /*
2260 * Open each stream: for each file, try to open, check magic
2261 * number, and get the stream ID to add to the right location in
2262 * the stream array.
2263 */
2264
2265 dirent_len = offsetof(struct dirent, d_name) +
2266 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2267
2268 dirent = malloc(dirent_len);
2269
2270 for (;;) {
2271 ret = readdir_r(td->dir, dirent, &diriter);
2272 if (ret) {
2273 fprintf(stderr, "[error] Readdir error.\n");
2274 goto readdir_error;
2275 }
2276 if (!diriter)
2277 break;
2278 /* Ignore hidden files, ., .. and metadata. */
2279 if (!strncmp(diriter->d_name, ".", 1)
2280 || !strcmp(diriter->d_name, "..")
2281 || !strcmp(diriter->d_name, "metadata"))
2282 continue;
2283
2284 /* Ignore index files : *.idx */
2285 ext = strrchr(diriter->d_name, '.');
2286 if (ext && (!strcmp(ext, ".idx"))) {
2287 continue;
2288 }
2289
2290 ret = ctf_open_file_stream_read(td, diriter->d_name,
2291 flags, packet_seek);
2292 if (ret) {
2293 fprintf(stderr, "[error] Open file stream error.\n");
2294 goto readdir_error;
2295 }
2296 }
2297
2298 free(dirent);
2299 return 0;
2300
2301 readdir_error:
2302 free(dirent);
2303 error_metadata:
2304 closeret = close(td->dirfd);
2305 if (closeret) {
2306 perror("Error on fd close");
2307 }
2308 error_dirfd:
2309 closeret = closedir(td->dir);
2310 if (closeret) {
2311 perror("Error on closedir");
2312 }
2313 error:
2314 return ret;
2315 }
2316
2317 /*
2318 * ctf_open_trace: Open a CTF trace and index it.
2319 * Note that the user must seek the trace after the open (using the iterator)
2320 * since the index creation read it entirely.
2321 */
2322 static
2323 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2324 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2325 int whence), FILE *metadata_fp)
2326 {
2327 struct ctf_trace *td;
2328 int ret;
2329
2330 /*
2331 * If packet_seek is NULL, we provide our default version.
2332 */
2333 if (!packet_seek)
2334 packet_seek = ctf_packet_seek;
2335
2336 td = g_new0(struct ctf_trace, 1);
2337
2338 switch (flags & O_ACCMODE) {
2339 case O_RDONLY:
2340 if (!path) {
2341 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2342 goto error;
2343 }
2344 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2345 if (ret)
2346 goto error;
2347 break;
2348 case O_RDWR:
2349 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2350 goto error;
2351 default:
2352 fprintf(stderr, "[error] Incorrect open flags.\n");
2353 goto error;
2354 }
2355
2356 return &td->parent;
2357 error:
2358 g_free(td);
2359 return NULL;
2360 }
2361
2362 static
2363 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2364 struct bt_mmap_stream *mmap_info)
2365 {
2366 pos->mmap_offset = 0;
2367 pos->packet_size = 0;
2368 pos->content_size = 0;
2369 pos->content_size_loc = NULL;
2370 pos->fd = mmap_info->fd;
2371 pos->base_mma = NULL;
2372 pos->offset = 0;
2373 pos->dummy = false;
2374 pos->cur_index = 0;
2375 pos->prot = PROT_READ;
2376 pos->flags = MAP_PRIVATE;
2377 pos->parent.rw_table = read_dispatch_table;
2378 pos->parent.event_cb = ctf_read_event;
2379 pos->priv = mmap_info->priv;
2380 pos->packet_index = g_array_new(FALSE, TRUE,
2381 sizeof(struct packet_index));
2382 }
2383
2384 static
2385 int prepare_mmap_stream_definition(struct ctf_trace *td,
2386 struct ctf_file_stream *file_stream,
2387 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2388 int whence))
2389 {
2390 struct ctf_stream_declaration *stream;
2391 uint64_t stream_id;
2392 int ret;
2393
2394 /* Ask for the first packet to get the stream_id. */
2395 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2396 stream_id = file_stream->parent.stream_id;
2397 if (stream_id >= td->streams->len) {
2398 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2399 "in metadata.\n", stream_id);
2400 ret = -EINVAL;
2401 goto end;
2402 }
2403 stream = g_ptr_array_index(td->streams, stream_id);
2404 if (!stream) {
2405 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2406 "in metadata.\n", stream_id);
2407 ret = -EINVAL;
2408 goto end;
2409 }
2410 file_stream->parent.stream_class = stream;
2411 ret = create_stream_definitions(td, &file_stream->parent);
2412 end:
2413 return ret;
2414 }
2415
2416 static
2417 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2418 struct bt_mmap_stream *mmap_info,
2419 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2420 int whence))
2421 {
2422 int ret;
2423 struct ctf_file_stream *file_stream;
2424
2425 file_stream = g_new0(struct ctf_file_stream, 1);
2426 file_stream->parent.stream_id = -1ULL;
2427 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2428 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2429
2430 file_stream->pos.packet_seek = packet_seek;
2431
2432 ret = create_trace_definitions(td, &file_stream->parent);
2433 if (ret) {
2434 goto error_def;
2435 }
2436
2437 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2438 if (ret)
2439 goto error_index;
2440
2441 /*
2442 * For now, only a single clock per trace is supported.
2443 */
2444 file_stream->parent.current_clock = td->parent.single_clock;
2445
2446 /* Add stream file to stream class */
2447 g_ptr_array_add(file_stream->parent.stream_class->streams,
2448 &file_stream->parent);
2449 return 0;
2450
2451 error_index:
2452 if (file_stream->parent.trace_packet_header)
2453 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2454 error_def:
2455 g_free(file_stream);
2456 return ret;
2457 }
2458
2459 static
2460 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2461 struct bt_mmap_stream_list *mmap_list,
2462 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2463 int whence),
2464 FILE *metadata_fp)
2465 {
2466 int ret;
2467 struct bt_mmap_stream *mmap_info;
2468
2469 td->scanner = ctf_scanner_alloc();
2470 if (!td->scanner) {
2471 fprintf(stderr, "[error] Error allocating scanner\n");
2472 ret = -ENOMEM;
2473 goto error;
2474 }
2475 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2476 if (ret) {
2477 if (ret == -ENOENT) {
2478 fprintf(stderr, "[warning] Empty metadata.\n");
2479 }
2480 goto error;
2481 }
2482
2483 /*
2484 * for each stream, try to open, check magic number, and get the
2485 * stream ID to add to the right location in the stream array.
2486 */
2487 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2488 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2489 if (ret) {
2490 fprintf(stderr, "[error] Open file mmap stream error.\n");
2491 goto error;
2492 }
2493 }
2494 return 0;
2495
2496 error:
2497 ctf_scanner_free(td->scanner);
2498 return ret;
2499 }
2500
2501 static
2502 struct bt_trace_descriptor *ctf_open_mmap_trace(
2503 struct bt_mmap_stream_list *mmap_list,
2504 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2505 int whence),
2506 FILE *metadata_fp)
2507 {
2508 struct ctf_trace *td;
2509 int ret;
2510
2511 if (!metadata_fp) {
2512 fprintf(stderr, "[error] No metadata file pointer associated, "
2513 "required for mmap parsing\n");
2514 goto error;
2515 }
2516 if (!packet_seek) {
2517 fprintf(stderr, "[error] packet_seek function undefined.\n");
2518 goto error;
2519 }
2520 td = g_new0(struct ctf_trace, 1);
2521 td->dirfd = -1;
2522 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2523 if (ret)
2524 goto error_free;
2525
2526 return &td->parent;
2527
2528 error_free:
2529 g_free(td);
2530 error:
2531 return NULL;
2532 }
2533
2534 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2535 FILE *metadata_fp)
2536 {
2537 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2538 int i, j;
2539 int ret;
2540
2541 if (!td->scanner)
2542 return -EINVAL;
2543 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2544 if (ret)
2545 return ret;
2546 /* for each stream_class */
2547 for (i = 0; i < td->streams->len; i++) {
2548 struct ctf_stream_declaration *stream_class;
2549
2550 stream_class = g_ptr_array_index(td->streams, i);
2551 if (!stream_class)
2552 continue;
2553 /* for each stream */
2554 for (j = 0; j < stream_class->streams->len; j++) {
2555 struct ctf_stream_definition *stream;
2556
2557 stream = g_ptr_array_index(stream_class->streams, j);
2558 if (!stream)
2559 continue;
2560 ret = copy_event_declarations_stream_class_to_stream(td,
2561 stream_class, stream);
2562 if (ret)
2563 return ret;
2564 }
2565 }
2566 return 0;
2567 }
2568
2569 static
2570 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2571 {
2572 int i, j, k;
2573 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2574
2575 /* for each stream_class */
2576 for (i = 0; i < td->streams->len; i++) {
2577 struct ctf_stream_declaration *stream_class;
2578
2579 stream_class = g_ptr_array_index(td->streams, i);
2580 if (!stream_class)
2581 continue;
2582 /* for each file_stream */
2583 for (j = 0; j < stream_class->streams->len; j++) {
2584 struct ctf_stream_definition *stream;
2585 struct ctf_stream_pos *stream_pos;
2586 struct ctf_file_stream *cfs;
2587
2588 stream = g_ptr_array_index(stream_class->streams, j);
2589 if (!stream)
2590 continue;
2591 cfs = container_of(stream, struct ctf_file_stream,
2592 parent);
2593 stream_pos = &cfs->pos;
2594 if (!stream_pos->packet_index)
2595 continue;
2596
2597 for (k = 0; k < stream_pos->packet_index->len; k++) {
2598 struct packet_index *index;
2599
2600 index = &g_array_index(stream_pos->packet_index,
2601 struct packet_index, k);
2602 index->ts_real.timestamp_begin =
2603 ctf_get_real_timestamp(stream,
2604 index->ts_cycles.timestamp_begin);
2605 index->ts_real.timestamp_end =
2606 ctf_get_real_timestamp(stream,
2607 index->ts_cycles.timestamp_end);
2608 }
2609 }
2610 }
2611 return 0;
2612 }
2613
2614 static
2615 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2616 {
2617 int ret;
2618
2619 ret = ctf_fini_pos(&file_stream->pos);
2620 if (ret) {
2621 fprintf(stderr, "Error on ctf_fini_pos\n");
2622 return -1;
2623 }
2624 if (file_stream->pos.fd >= 0) {
2625 ret = close(file_stream->pos.fd);
2626 if (ret) {
2627 perror("Error closing file fd");
2628 return -1;
2629 }
2630 }
2631 return 0;
2632 }
2633
2634 static
2635 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2636 {
2637 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2638 int ret;
2639
2640 if (td->streams) {
2641 int i;
2642
2643 for (i = 0; i < td->streams->len; i++) {
2644 struct ctf_stream_declaration *stream;
2645 int j;
2646
2647 stream = g_ptr_array_index(td->streams, i);
2648 if (!stream)
2649 continue;
2650 for (j = 0; j < stream->streams->len; j++) {
2651 struct ctf_file_stream *file_stream;
2652 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2653 struct ctf_file_stream, parent);
2654 ret = ctf_close_file_stream(file_stream);
2655 if (ret)
2656 return ret;
2657 }
2658 }
2659 }
2660 ctf_destroy_metadata(td);
2661 ctf_scanner_free(td->scanner);
2662 if (td->dirfd >= 0) {
2663 ret = close(td->dirfd);
2664 if (ret) {
2665 perror("Error closing dirfd");
2666 return ret;
2667 }
2668 }
2669 if (td->dir) {
2670 ret = closedir(td->dir);
2671 if (ret) {
2672 perror("Error closedir");
2673 return ret;
2674 }
2675 }
2676 free(td->metadata_string);
2677 g_free(td);
2678 return 0;
2679 }
2680
2681 static
2682 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2683 struct bt_context *ctx)
2684 {
2685 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2686 parent);
2687
2688 td->parent.ctx = ctx;
2689 }
2690
2691 static
2692 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2693 struct bt_trace_handle *handle)
2694 {
2695 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2696 parent);
2697
2698 td->parent.handle = handle;
2699 }
2700
2701 static
2702 void __attribute__((constructor)) ctf_init(void)
2703 {
2704 int ret;
2705
2706 ctf_format.name = g_quark_from_static_string("ctf");
2707 ret = bt_register_format(&ctf_format);
2708 assert(!ret);
2709 }
2710
2711 static
2712 void __attribute__((destructor)) ctf_exit(void)
2713 {
2714 bt_unregister_format(&ctf_format);
2715 }
This page took 0.083897 seconds and 3 git commands to generate.