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