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