Port: implement posix_fallocate wrapper
[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 off_t off;
867 struct packet_index *packet_index, *prev_index;
868
869 switch (whence) {
870 case SEEK_CUR:
871 case SEEK_SET: /* Fall-through */
872 break; /* OK */
873 default:
874 assert(0);
875 }
876
877 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
878 *pos->content_size_loc = pos->offset;
879
880 if (pos->base_mma) {
881 /* unmap old base */
882 ret = munmap_align(pos->base_mma);
883 if (ret) {
884 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
885 strerror(errno));
886 assert(0);
887 }
888 pos->base_mma = NULL;
889 }
890
891 /*
892 * The caller should never ask for ctf_move_pos across packets,
893 * except to get exactly at the beginning of the next packet.
894 */
895 if (pos->prot & PROT_WRITE) {
896 switch (whence) {
897 case SEEK_CUR:
898 /* The writer will add padding */
899 pos->mmap_offset += pos->packet_size / CHAR_BIT;
900 break;
901 case SEEK_SET:
902 assert(index == 0); /* only seek supported for now */
903 pos->cur_index = 0;
904 break;
905 default:
906 assert(0);
907 }
908 pos->content_size = -1U; /* Unknown at this point */
909 pos->packet_size = WRITE_PACKET_LEN;
910 off = bt_posix_fallocate(pos->fd, pos->mmap_offset,
911 pos->packet_size / CHAR_BIT);
912 assert(off == 0);
913 pos->offset = 0;
914 } else {
915 read_next_packet:
916 switch (whence) {
917 case SEEK_CUR:
918 {
919 if (pos->offset == EOF) {
920 return;
921 }
922 assert(pos->cur_index < pos->packet_index->len);
923 /* The reader will expect us to skip padding */
924 ++pos->cur_index;
925 break;
926 }
927 case SEEK_SET:
928 if (index >= pos->packet_index->len) {
929 pos->offset = EOF;
930 return;
931 }
932 pos->cur_index = index;
933 break;
934 default:
935 assert(0);
936 }
937
938 packet_index = &g_array_index(pos->packet_index,
939 struct packet_index, pos->cur_index);
940 if (pos->cur_index > 0) {
941 prev_index = &g_array_index(pos->packet_index,
942 struct packet_index,
943 pos->cur_index - 1);
944 } else {
945 prev_index = NULL;
946 }
947 ctf_update_current_packet_index(&file_stream->parent,
948 prev_index, packet_index);
949
950 if (pos->cur_index >= pos->packet_index->len) {
951 pos->offset = EOF;
952 return;
953 }
954
955 /*
956 * We need to check if we are in trace read or called
957 * from packet indexing. In this last case, the
958 * collection is not there, so we cannot print the
959 * timestamps.
960 */
961 if ((&file_stream->parent)->stream_class->trace->parent.collection) {
962 ctf_print_discarded(stderr, &file_stream->parent);
963 }
964
965 packet_index = &g_array_index(pos->packet_index,
966 struct packet_index,
967 pos->cur_index);
968 file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
969
970 file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin;
971
972 /* Lookup context/packet size in index */
973 if (packet_index->data_offset == -1) {
974 ret = find_data_offset(pos, file_stream, packet_index);
975 if (ret < 0) {
976 return;
977 }
978 }
979 pos->content_size = packet_index->content_size;
980 pos->packet_size = packet_index->packet_size;
981 pos->mmap_offset = packet_index->offset;
982 pos->data_offset = packet_index->data_offset;
983 if (pos->data_offset < packet_index->content_size) {
984 pos->offset = 0; /* will read headers */
985 } else if (pos->data_offset == packet_index->content_size) {
986 /* empty packet */
987 pos->offset = packet_index->data_offset;
988 whence = SEEK_CUR;
989 goto read_next_packet;
990 } else {
991 pos->offset = EOF;
992 return;
993 }
994 }
995 /* map new base. Need mapping length from header. */
996 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
997 pos->flags, pos->fd, pos->mmap_offset);
998 if (pos->base_mma == MAP_FAILED) {
999 fprintf(stderr, "[error] mmap error %s.\n",
1000 strerror(errno));
1001 assert(0);
1002 }
1003
1004 /* update trace_packet_header and stream_packet_context */
1005 if (!(pos->prot & PROT_WRITE) &&
1006 file_stream->parent.trace_packet_header) {
1007 /* Read packet header */
1008 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1009 assert(!ret);
1010 }
1011 if (!(pos->prot & PROT_WRITE) &&
1012 file_stream->parent.stream_packet_context) {
1013 /* Read packet context */
1014 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1015 assert(!ret);
1016 }
1017 }
1018
1019 static
1020 int packet_metadata(struct ctf_trace *td, FILE *fp)
1021 {
1022 uint32_t magic;
1023 size_t len;
1024 int ret = 0;
1025
1026 len = fread(&magic, sizeof(magic), 1, fp);
1027 if (len != 1) {
1028 goto end;
1029 }
1030 if (magic == TSDL_MAGIC) {
1031 ret = 1;
1032 td->byte_order = BYTE_ORDER;
1033 CTF_TRACE_SET_FIELD(td, byte_order);
1034 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
1035 ret = 1;
1036 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
1037 LITTLE_ENDIAN : BIG_ENDIAN;
1038 CTF_TRACE_SET_FIELD(td, byte_order);
1039 }
1040 end:
1041 rewind(fp);
1042 return ret;
1043 }
1044
1045 /*
1046 * Returns 0 on success, -1 on error.
1047 */
1048 static
1049 int check_version(unsigned int major, unsigned int minor)
1050 {
1051 switch (major) {
1052 case 1:
1053 switch (minor) {
1054 case 8:
1055 return 0;
1056 default:
1057 goto warning;
1058 }
1059 default:
1060 goto warning;
1061
1062 }
1063
1064 /* eventually return an error instead of warning */
1065 warning:
1066 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1067 major, minor);
1068 return 0;
1069 }
1070
1071 static
1072 int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
1073 FILE *out)
1074 {
1075 struct metadata_packet_header header;
1076 size_t readlen, writelen, toread;
1077 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
1078 int ret = 0;
1079
1080 readlen = fread(&header, header_sizeof(header), 1, in);
1081 if (readlen < 1)
1082 return -EINVAL;
1083
1084 if (td->byte_order != BYTE_ORDER) {
1085 header.magic = GUINT32_SWAP_LE_BE(header.magic);
1086 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
1087 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
1088 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
1089 }
1090 if (header.checksum)
1091 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
1092 if (header.compression_scheme) {
1093 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
1094 header.compression_scheme);
1095 return -EINVAL;
1096 }
1097 if (header.encryption_scheme) {
1098 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
1099 header.encryption_scheme);
1100 return -EINVAL;
1101 }
1102 if (header.checksum_scheme) {
1103 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
1104 header.checksum_scheme);
1105 return -EINVAL;
1106 }
1107 if (check_version(header.major, header.minor) < 0)
1108 return -EINVAL;
1109 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
1110 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
1111 CTF_TRACE_SET_FIELD(td, uuid);
1112 } else {
1113 if (bt_uuid_compare(header.uuid, td->uuid))
1114 return -EINVAL;
1115 }
1116
1117 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
1118 return -EINVAL;
1119
1120 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
1121
1122 for (;;) {
1123 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
1124 if (ferror(in)) {
1125 ret = -EINVAL;
1126 break;
1127 }
1128 if (babeltrace_debug) {
1129 buf[readlen] = '\0';
1130 fprintf(stderr, "[debug] metadata packet read: %s\n",
1131 buf);
1132 }
1133
1134 writelen = fwrite(buf, sizeof(char), readlen, out);
1135 if (writelen < readlen) {
1136 ret = -EIO;
1137 break;
1138 }
1139 if (ferror(out)) {
1140 ret = -EINVAL;
1141 break;
1142 }
1143 toread -= readlen;
1144 if (!toread) {
1145 ret = 0; /* continue reading next packet */
1146 goto read_padding;
1147 }
1148 }
1149 return ret;
1150
1151 read_padding:
1152 toread = (header.packet_size - header.content_size) / CHAR_BIT;
1153 ret = fseek(in, toread, SEEK_CUR);
1154 if (ret < 0) {
1155 fprintf(stderr, "[warning] Missing padding at end of file\n");
1156 ret = 0;
1157 }
1158 return ret;
1159 }
1160
1161 static
1162 int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
1163 char **buf)
1164 {
1165 FILE *in, *out;
1166 size_t size, buflen;
1167 int ret;
1168
1169 in = *fp;
1170 /*
1171 * Using strlen on *buf instead of size of open_memstream
1172 * because its size includes garbage at the end (after final
1173 * \0). This is the allocated size, not the actual string size.
1174 */
1175 out = babeltrace_open_memstream(buf, &size);
1176 if (out == NULL) {
1177 perror("Metadata open_memstream");
1178 return -errno;
1179 }
1180 for (;;) {
1181 ret = ctf_trace_metadata_packet_read(td, in, out);
1182 if (ret) {
1183 break;
1184 }
1185 if (feof(in)) {
1186 ret = 0;
1187 break;
1188 }
1189 }
1190 /* close to flush the buffer */
1191 ret = babeltrace_close_memstream(buf, &size, out);
1192 if (ret < 0) {
1193 int closeret;
1194
1195 perror("babeltrace_flush_memstream");
1196 ret = -errno;
1197 closeret = fclose(in);
1198 if (closeret) {
1199 perror("Error in fclose");
1200 }
1201 return ret;
1202 }
1203 ret = fclose(in);
1204 if (ret) {
1205 perror("Error in fclose");
1206 }
1207 /* open for reading */
1208 buflen = strlen(*buf);
1209 if (!buflen) {
1210 *fp = NULL;
1211 return -ENOENT;
1212 }
1213 *fp = babeltrace_fmemopen(*buf, buflen, "rb");
1214 if (!*fp) {
1215 perror("Metadata fmemopen");
1216 return -errno;
1217 }
1218 return 0;
1219 }
1220
1221 static
1222 int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp,
1223 struct ctf_scanner *scanner, int append)
1224 {
1225 struct ctf_file_stream *metadata_stream;
1226 FILE *fp;
1227 char *buf = NULL;
1228 int ret = 0, closeret;
1229
1230 metadata_stream = g_new0(struct ctf_file_stream, 1);
1231 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1232
1233 if (metadata_fp) {
1234 fp = metadata_fp;
1235 metadata_stream->pos.fd = -1;
1236 } else {
1237 td->metadata = &metadata_stream->parent;
1238 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1239 if (metadata_stream->pos.fd < 0) {
1240 fprintf(stderr, "Unable to open metadata.\n");
1241 ret = -1;
1242 goto end_free;
1243 }
1244
1245 fp = fdopen(metadata_stream->pos.fd, "r");
1246 if (!fp) {
1247 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1248 perror("Metadata stream open");
1249 ret = -errno;
1250 goto end_stream;
1251 }
1252 /* fd now belongs to fp */
1253 metadata_stream->pos.fd = -1;
1254 }
1255 if (babeltrace_debug)
1256 yydebug = 1;
1257
1258 if (packet_metadata(td, fp)) {
1259 ret = ctf_trace_metadata_stream_read(td, &fp, &buf);
1260 if (ret) {
1261 goto end;
1262 }
1263 td->metadata_string = buf;
1264 td->metadata_packetized = 1;
1265 } else {
1266 if (!append) {
1267 unsigned int major, minor;
1268 ssize_t nr_items;
1269
1270 td->byte_order = BYTE_ORDER;
1271
1272 /* Check text-only metadata header and version */
1273 nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
1274 if (nr_items < 2)
1275 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1276 if (check_version(major, minor) < 0) {
1277 ret = -EINVAL;
1278 goto end;
1279 }
1280 rewind(fp);
1281 }
1282 }
1283
1284 ret = ctf_scanner_append_ast(scanner, fp);
1285 if (ret) {
1286 fprintf(stderr, "[error] Error creating AST\n");
1287 goto end;
1288 }
1289
1290 if (babeltrace_debug) {
1291 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1292 if (ret) {
1293 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1294 goto end;
1295 }
1296 }
1297
1298 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1299 if (ret) {
1300 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1301 goto end;
1302 }
1303 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1304 td, td->byte_order);
1305 if (ret) {
1306 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1307 goto end;
1308 }
1309 end:
1310 if (fp) {
1311 closeret = fclose(fp);
1312 if (closeret) {
1313 perror("Error on fclose");
1314 }
1315 }
1316 end_stream:
1317 if (metadata_stream->pos.fd >= 0) {
1318 closeret = close(metadata_stream->pos.fd);
1319 if (closeret) {
1320 perror("Error on metadata stream fd close");
1321 }
1322 }
1323 end_free:
1324 if (ret)
1325 g_free(metadata_stream);
1326 return ret;
1327 }
1328
1329 static
1330 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1331 struct ctf_stream_definition *stream,
1332 struct ctf_event_declaration *event)
1333 {
1334 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1335
1336 if (event->context_decl) {
1337 struct bt_definition *definition =
1338 event->context_decl->p.definition_new(&event->context_decl->p,
1339 stream->parent_def_scope, 0, 0, "event.context");
1340 if (!definition) {
1341 goto error;
1342 }
1343 stream_event->event_context = container_of(definition,
1344 struct definition_struct, p);
1345 stream->parent_def_scope = stream_event->event_context->p.scope;
1346 }
1347 if (event->fields_decl) {
1348 struct bt_definition *definition =
1349 event->fields_decl->p.definition_new(&event->fields_decl->p,
1350 stream->parent_def_scope, 0, 0, "event.fields");
1351 if (!definition) {
1352 goto error;
1353 }
1354 stream_event->event_fields = container_of(definition,
1355 struct definition_struct, p);
1356 stream->parent_def_scope = stream_event->event_fields->p.scope;
1357 }
1358 stream_event->stream = stream;
1359 return stream_event;
1360
1361 error:
1362 if (stream_event->event_fields)
1363 bt_definition_unref(&stream_event->event_fields->p);
1364 if (stream_event->event_context)
1365 bt_definition_unref(&stream_event->event_context->p);
1366 fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n",
1367 g_quark_to_string(event->name));
1368 return NULL;
1369 }
1370
1371 static
1372 int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td,
1373 struct ctf_stream_declaration *stream_class,
1374 struct ctf_stream_definition *stream)
1375 {
1376 size_t def_size, class_size, i;
1377 int ret = 0;
1378
1379 def_size = stream->events_by_id->len;
1380 class_size = stream_class->events_by_id->len;
1381
1382 g_ptr_array_set_size(stream->events_by_id, class_size);
1383 for (i = def_size; i < class_size; i++) {
1384 struct ctf_event_declaration *event =
1385 g_ptr_array_index(stream_class->events_by_id, i);
1386 struct ctf_event_definition *stream_event;
1387
1388 if (!event)
1389 continue;
1390 stream_event = create_event_definitions(td, stream, event);
1391 if (!stream_event) {
1392 ret = -EINVAL;
1393 goto error;
1394 }
1395 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1396 }
1397 error:
1398 return ret;
1399 }
1400
1401 static
1402 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1403 {
1404 struct ctf_stream_declaration *stream_class;
1405 int ret;
1406 int i;
1407
1408 if (stream->stream_definitions_created)
1409 return 0;
1410
1411 stream_class = stream->stream_class;
1412
1413 if (stream_class->packet_context_decl) {
1414 struct bt_definition *definition =
1415 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1416 stream->parent_def_scope, 0, 0, "stream.packet.context");
1417 if (!definition) {
1418 ret = -EINVAL;
1419 goto error;
1420 }
1421 stream->stream_packet_context = container_of(definition,
1422 struct definition_struct, p);
1423 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1424 }
1425 if (stream_class->event_header_decl) {
1426 struct bt_definition *definition =
1427 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1428 stream->parent_def_scope, 0, 0, "stream.event.header");
1429 if (!definition) {
1430 ret = -EINVAL;
1431 goto error;
1432 }
1433 stream->stream_event_header =
1434 container_of(definition, struct definition_struct, p);
1435 stream->parent_def_scope = stream->stream_event_header->p.scope;
1436 }
1437 if (stream_class->event_context_decl) {
1438 struct bt_definition *definition =
1439 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1440 stream->parent_def_scope, 0, 0, "stream.event.context");
1441 if (!definition) {
1442 ret = -EINVAL;
1443 goto error;
1444 }
1445 stream->stream_event_context =
1446 container_of(definition, struct definition_struct, p);
1447 stream->parent_def_scope = stream->stream_event_context->p.scope;
1448 }
1449 stream->events_by_id = g_ptr_array_new();
1450 ret = copy_event_declarations_stream_class_to_stream(td,
1451 stream_class, stream);
1452 if (ret)
1453 goto error_event;
1454 return 0;
1455
1456 error_event:
1457 for (i = 0; i < stream->events_by_id->len; i++) {
1458 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1459 if (stream_event)
1460 g_free(stream_event);
1461 }
1462 g_ptr_array_free(stream->events_by_id, TRUE);
1463 error:
1464 if (stream->stream_event_context)
1465 bt_definition_unref(&stream->stream_event_context->p);
1466 if (stream->stream_event_header)
1467 bt_definition_unref(&stream->stream_event_header->p);
1468 if (stream->stream_packet_context)
1469 bt_definition_unref(&stream->stream_packet_context->p);
1470 fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n",
1471 stream_class->stream_id, strerror(-ret));
1472 return ret;
1473 }
1474
1475 static
1476 int stream_assign_class(struct ctf_trace *td,
1477 struct ctf_file_stream *file_stream,
1478 uint64_t stream_id)
1479 {
1480 struct ctf_stream_declaration *stream;
1481 int ret;
1482
1483 file_stream->parent.stream_id = stream_id;
1484 if (stream_id >= td->streams->len) {
1485 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1486 return -EINVAL;
1487 }
1488 stream = g_ptr_array_index(td->streams, stream_id);
1489 if (!stream) {
1490 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1491 return -EINVAL;
1492 }
1493 file_stream->parent.stream_class = stream;
1494 ret = create_stream_definitions(td, &file_stream->parent);
1495 if (ret)
1496 return ret;
1497 return 0;
1498 }
1499
1500 static
1501 int create_stream_one_packet_index(struct ctf_stream_pos *pos,
1502 struct ctf_trace *td,
1503 struct ctf_file_stream *file_stream,
1504 size_t filesize)
1505 {
1506 struct packet_index packet_index;
1507 uint64_t stream_id = 0;
1508 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
1509 int first_packet = 0;
1510 int len_index;
1511 int ret;
1512
1513 begin:
1514 if (!pos->mmap_offset) {
1515 first_packet = 1;
1516 }
1517
1518 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
1519 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
1520 }
1521
1522 if (pos->base_mma) {
1523 /* unmap old base */
1524 ret = munmap_align(pos->base_mma);
1525 if (ret) {
1526 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1527 strerror(errno));
1528 return ret;
1529 }
1530 pos->base_mma = NULL;
1531 }
1532 /* map new base. Need mapping length from header. */
1533 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
1534 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1535 assert(pos->base_mma != MAP_FAILED);
1536 /*
1537 * Use current mapping size as temporary content and packet
1538 * size.
1539 */
1540 pos->content_size = packet_map_len;
1541 pos->packet_size = packet_map_len;
1542 pos->offset = 0; /* Position of the packet header */
1543
1544 packet_index.offset = pos->mmap_offset;
1545 packet_index.content_size = 0;
1546 packet_index.packet_size = 0;
1547 packet_index.ts_real.timestamp_begin = 0;
1548 packet_index.ts_real.timestamp_end = 0;
1549 packet_index.ts_cycles.timestamp_begin = 0;
1550 packet_index.ts_cycles.timestamp_end = 0;
1551 packet_index.events_discarded = 0;
1552 packet_index.events_discarded_len = 0;
1553
1554 /* read and check header, set stream id (and check) */
1555 if (file_stream->parent.trace_packet_header) {
1556 /* Read packet header */
1557 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1558 if (ret) {
1559 if (ret == -EFAULT)
1560 goto retry;
1561 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1562 return ret;
1563 }
1564 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1565 if (len_index >= 0) {
1566 struct bt_definition *field;
1567 uint64_t magic;
1568
1569 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1570 magic = bt_get_unsigned_int(field);
1571 if (magic != CTF_MAGIC) {
1572 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1573 magic,
1574 file_stream->pos.packet_index->len,
1575 (ssize_t) pos->mmap_offset);
1576 return -EINVAL;
1577 }
1578 }
1579
1580 /* check uuid */
1581 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1582 if (len_index >= 0) {
1583 struct definition_array *defarray;
1584 struct bt_definition *field;
1585 uint64_t i;
1586 uint8_t uuidval[BABELTRACE_UUID_LEN];
1587
1588 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1589 assert(field->declaration->id == CTF_TYPE_ARRAY);
1590 defarray = container_of(field, struct definition_array, p);
1591 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1592
1593 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1594 struct bt_definition *elem;
1595
1596 elem = bt_array_index(defarray, i);
1597 uuidval[i] = bt_get_unsigned_int(elem);
1598 }
1599 ret = bt_uuid_compare(td->uuid, uuidval);
1600 if (ret) {
1601 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1602 return -EINVAL;
1603 }
1604 }
1605
1606 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1607 if (len_index >= 0) {
1608 struct bt_definition *field;
1609
1610 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1611 stream_id = bt_get_unsigned_int(field);
1612 }
1613 }
1614
1615 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1616 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1617 stream_id,
1618 file_stream->parent.stream_id);
1619 return -EINVAL;
1620 }
1621 if (first_packet) {
1622 ret = stream_assign_class(td, file_stream, stream_id);
1623 if (ret)
1624 return ret;
1625 }
1626
1627 if (file_stream->parent.stream_packet_context) {
1628 /* Read packet context */
1629 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1630 if (ret) {
1631 if (ret == -EFAULT)
1632 goto retry;
1633 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1634 return ret;
1635 }
1636 /* read packet size from header */
1637 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1638 if (len_index >= 0) {
1639 struct bt_definition *field;
1640
1641 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1642 packet_index.packet_size = bt_get_unsigned_int(field);
1643 } else {
1644 /* Use file size for packet size */
1645 packet_index.packet_size = filesize * CHAR_BIT;
1646 }
1647
1648 /* read content size from header */
1649 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1650 if (len_index >= 0) {
1651 struct bt_definition *field;
1652
1653 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1654 packet_index.content_size = bt_get_unsigned_int(field);
1655 } else {
1656 /* Use packet size if non-zero, else file size */
1657 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1658 }
1659
1660 /* read timestamp begin from header */
1661 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1662 if (len_index >= 0) {
1663 struct bt_definition *field;
1664
1665 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1666 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1667 if (file_stream->parent.stream_class->trace->parent.collection) {
1668 packet_index.ts_real.timestamp_begin =
1669 ctf_get_real_timestamp(
1670 &file_stream->parent,
1671 packet_index.ts_cycles.timestamp_begin);
1672 }
1673 }
1674
1675 /* read timestamp end from header */
1676 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1677 if (len_index >= 0) {
1678 struct bt_definition *field;
1679
1680 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1681 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1682 if (file_stream->parent.stream_class->trace->parent.collection) {
1683 packet_index.ts_real.timestamp_end =
1684 ctf_get_real_timestamp(
1685 &file_stream->parent,
1686 packet_index.ts_cycles.timestamp_end);
1687 }
1688 }
1689
1690 /* read events discarded from header */
1691 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1692 if (len_index >= 0) {
1693 struct bt_definition *field;
1694
1695 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1696 packet_index.events_discarded = bt_get_unsigned_int(field);
1697 packet_index.events_discarded_len = bt_get_int_len(field);
1698 }
1699 } else {
1700 /* Use file size for packet size */
1701 packet_index.packet_size = filesize * CHAR_BIT;
1702 /* Use packet size if non-zero, else file size */
1703 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1704 }
1705
1706 /* Validate content size and packet size values */
1707 if (packet_index.content_size > packet_index.packet_size) {
1708 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1709 packet_index.content_size, packet_index.packet_size);
1710 return -EINVAL;
1711 }
1712
1713 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1714 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1715 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1716 return -EINVAL;
1717 }
1718
1719 if (packet_index.content_size < pos->offset) {
1720 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1721 return -EINVAL;
1722 }
1723
1724 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1725 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1726 return -EINVAL;
1727 }
1728
1729 /* Save position after header and context */
1730 packet_index.data_offset = pos->offset;
1731
1732 /* add index to packet array */
1733 g_array_append_val(file_stream->pos.packet_index, packet_index);
1734
1735 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1736
1737 return 0;
1738
1739 /* Retry with larger mapping */
1740 retry:
1741 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1742 /*
1743 * Reached EOF, but still expecting header/context data.
1744 */
1745 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1746 return -EFAULT;
1747 }
1748 /* Double the mapping len, and retry */
1749 tmp_map_len = packet_map_len << 1;
1750 if (tmp_map_len >> 1 != packet_map_len) {
1751 /* Overflow */
1752 fprintf(stderr, "[error] Packet mapping length overflow\n");
1753 return -EFAULT;
1754 }
1755 packet_map_len = tmp_map_len;
1756 goto begin;
1757 }
1758
1759 static
1760 int create_stream_packet_index(struct ctf_trace *td,
1761 struct ctf_file_stream *file_stream)
1762 {
1763 struct ctf_stream_pos *pos;
1764 struct stat filestats;
1765 int ret;
1766
1767 pos = &file_stream->pos;
1768
1769 ret = fstat(pos->fd, &filestats);
1770 if (ret < 0)
1771 return ret;
1772
1773 /* Deal with empty files */
1774 if (!filestats.st_size) {
1775 if (file_stream->parent.trace_packet_header
1776 || file_stream->parent.stream_packet_context) {
1777 /*
1778 * We expect a trace packet header and/or stream packet
1779 * context. Since a trace needs to have at least one
1780 * packet, empty files are therefore not accepted.
1781 */
1782 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1783 return -EINVAL;
1784 } else {
1785 /*
1786 * Without trace packet header nor stream packet
1787 * context, a one-packet trace can indeed be empty. This
1788 * is only valid if there is only one stream class: 0.
1789 */
1790 ret = stream_assign_class(td, file_stream, 0);
1791 if (ret)
1792 return ret;
1793 return 0;
1794 }
1795 }
1796
1797 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1798 ret = create_stream_one_packet_index(pos, td, file_stream,
1799 filestats.st_size);
1800 if (ret)
1801 return ret;
1802 }
1803 return 0;
1804 }
1805
1806 static
1807 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1808 {
1809 int ret;
1810
1811 if (td->packet_header_decl) {
1812 struct bt_definition *definition =
1813 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1814 stream->parent_def_scope, 0, 0, "trace.packet.header");
1815 if (!definition) {
1816 ret = -EINVAL;
1817 goto error;
1818 }
1819 stream->trace_packet_header =
1820 container_of(definition, struct definition_struct, p);
1821 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1822 }
1823
1824 return 0;
1825
1826 error:
1827 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1828 return ret;
1829 }
1830
1831 static
1832 int import_stream_packet_index(struct ctf_trace *td,
1833 struct ctf_file_stream *file_stream)
1834 {
1835 struct ctf_stream_pos *pos;
1836 struct ctf_packet_index *ctf_index = NULL;
1837 struct ctf_packet_index_file_hdr index_hdr;
1838 struct packet_index index;
1839 uint32_t packet_index_len;
1840 int ret = 0;
1841 int first_packet = 1;
1842 size_t len;
1843
1844 pos = &file_stream->pos;
1845
1846 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1847 if (len != 1) {
1848 perror("read index file header");
1849 goto error;
1850 }
1851
1852 /* Check the index header */
1853 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1854 fprintf(stderr, "[error] wrong index magic\n");
1855 ret = -1;
1856 goto error;
1857 }
1858 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1859 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1860 ".%" PRIu32 ", supported %d.%d\n",
1861 be32toh(index_hdr.index_major),
1862 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1863 CTF_INDEX_MINOR);
1864 ret = -1;
1865 goto error;
1866 }
1867 packet_index_len = be32toh(index_hdr.packet_index_len);
1868 if (packet_index_len == 0) {
1869 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1870 ret = -1;
1871 goto error;
1872 }
1873 /*
1874 * Allocate the index length found in header, not internal
1875 * representation.
1876 */
1877 ctf_index = g_malloc0(packet_index_len);
1878 while (fread(ctf_index, packet_index_len, 1,
1879 pos->index_fp) == 1) {
1880 uint64_t stream_id;
1881 struct ctf_stream_declaration *stream = NULL;
1882
1883 memset(&index, 0, sizeof(index));
1884 index.offset = be64toh(ctf_index->offset);
1885 index.packet_size = be64toh(ctf_index->packet_size);
1886 index.content_size = be64toh(ctf_index->content_size);
1887 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
1888 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
1889 index.events_discarded = be64toh(ctf_index->events_discarded);
1890 index.events_discarded_len = 64;
1891 index.data_offset = -1;
1892 stream_id = be64toh(ctf_index->stream_id);
1893
1894 if (!first_packet) {
1895 /* add index to packet array */
1896 g_array_append_val(file_stream->pos.packet_index, index);
1897 continue;
1898 }
1899
1900 file_stream->parent.stream_id = stream_id;
1901 if (stream_id < td->streams->len) {
1902 stream = g_ptr_array_index(td->streams, stream_id);
1903 }
1904 if (!stream) {
1905 fprintf(stderr, "[error] Stream %" PRIu64
1906 " is not declared in metadata.\n",
1907 stream_id);
1908 ret = -EINVAL;
1909 goto error;
1910 }
1911 file_stream->parent.stream_class = stream;
1912 ret = create_stream_definitions(td, &file_stream->parent);
1913 if (ret)
1914 goto error;
1915 first_packet = 0;
1916 /* add index to packet array */
1917 g_array_append_val(file_stream->pos.packet_index, index);
1918 }
1919
1920 /* Index containing only the header. */
1921 if (!file_stream->parent.stream_class) {
1922 ret = -1;
1923 goto error;
1924 }
1925
1926 ret = 0;
1927
1928 error:
1929 g_free(ctf_index);
1930 return ret;
1931 }
1932
1933 /*
1934 * Note: many file streams can inherit from the same stream class
1935 * description (metadata).
1936 */
1937 static
1938 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1939 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
1940 int whence))
1941 {
1942 int ret, fd, closeret;
1943 struct ctf_file_stream *file_stream;
1944 struct stat statbuf;
1945 char *index_name;
1946
1947 fd = openat(td->dirfd, path, flags);
1948 if (fd < 0) {
1949 perror("File stream openat()");
1950 ret = fd;
1951 goto error;
1952 }
1953
1954 /* Don't try to mmap subdirectories. Skip them, return success. */
1955 ret = fstat(fd, &statbuf);
1956 if (ret) {
1957 perror("File stream fstat()");
1958 goto fstat_error;
1959 }
1960 if (S_ISDIR(statbuf.st_mode)) {
1961 if (strncmp(path, "index", 5) != 0) {
1962 fprintf(stderr, "[warning] Skipping directory '%s' "
1963 "found in trace\n", path);
1964 }
1965 ret = 0;
1966 goto fd_is_dir_ok;
1967 }
1968 if (!statbuf.st_size) {
1969 /** Skip empty files. */
1970 ret = 0;
1971 goto fd_is_empty_file;
1972 }
1973
1974 file_stream = g_new0(struct ctf_file_stream, 1);
1975 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1976 file_stream->pos.fd = -1;
1977 file_stream->pos.index_fp = NULL;
1978
1979 strncpy(file_stream->parent.path, path, PATH_MAX);
1980 file_stream->parent.path[PATH_MAX - 1] = '\0';
1981
1982 if (packet_seek) {
1983 file_stream->pos.packet_seek = packet_seek;
1984 } else {
1985 fprintf(stderr, "[error] packet_seek function undefined.\n");
1986 ret = -1;
1987 goto error_def;
1988 }
1989
1990 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
1991 if (ret)
1992 goto error_def;
1993 ret = create_trace_definitions(td, &file_stream->parent);
1994 if (ret)
1995 goto error_def;
1996 /*
1997 * For now, only a single clock per trace is supported.
1998 */
1999 file_stream->parent.current_clock = td->parent.single_clock;
2000
2001 /*
2002 * Allocate the index name for this stream and try to open it.
2003 */
2004 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2005 if (!index_name) {
2006 fprintf(stderr, "[error] Cannot allocate index filename\n");
2007 ret = -ENOMEM;
2008 goto error_def;
2009 }
2010 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2011 INDEX_PATH, path);
2012
2013 if (faccessat(td->dirfd, index_name, O_RDONLY, flags) < 0) {
2014 ret = create_stream_packet_index(td, file_stream);
2015 if (ret) {
2016 fprintf(stderr, "[error] Stream index creation error.\n");
2017 goto error_index;
2018 }
2019 } else {
2020 ret = openat(td->dirfd, index_name, flags);
2021 if (ret < 0) {
2022 perror("Index file openat()");
2023 ret = -1;
2024 goto error_free;
2025 }
2026 file_stream->pos.index_fp = fdopen(ret, "r");
2027 if (!file_stream->pos.index_fp) {
2028 perror("fdopen() error");
2029 goto error_free;
2030 }
2031 ret = import_stream_packet_index(td, file_stream);
2032 if (ret) {
2033 ret = -1;
2034 goto error_index;
2035 }
2036 ret = fclose(file_stream->pos.index_fp);
2037 if (ret < 0) {
2038 perror("close index");
2039 goto error_free;
2040 }
2041 }
2042 free(index_name);
2043
2044 /* Add stream file to stream class */
2045 g_ptr_array_add(file_stream->parent.stream_class->streams,
2046 &file_stream->parent);
2047 return 0;
2048
2049 error_index:
2050 if (file_stream->pos.index_fp) {
2051 ret = fclose(file_stream->pos.index_fp);
2052 if (ret < 0) {
2053 perror("close index");
2054 }
2055 }
2056 if (file_stream->parent.trace_packet_header)
2057 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2058 error_free:
2059 free(index_name);
2060 error_def:
2061 closeret = ctf_fini_pos(&file_stream->pos);
2062 if (closeret) {
2063 fprintf(stderr, "Error on ctf_fini_pos\n");
2064 }
2065 g_free(file_stream);
2066 fd_is_empty_file:
2067 fd_is_dir_ok:
2068 fstat_error:
2069 closeret = close(fd);
2070 if (closeret) {
2071 perror("Error on fd close");
2072 }
2073 error:
2074 return ret;
2075 }
2076
2077 static
2078 int ctf_open_trace_read(struct ctf_trace *td,
2079 const char *path, int flags,
2080 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2081 int whence), FILE *metadata_fp)
2082 {
2083 struct ctf_scanner *scanner;
2084 int ret, closeret;
2085 struct dirent *dirent;
2086 struct dirent *diriter;
2087 size_t dirent_len;
2088 char *ext;
2089
2090 td->flags = flags;
2091
2092 /* Open trace directory */
2093 td->dir = opendir(path);
2094 if (!td->dir) {
2095 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2096 ret = -ENOENT;
2097 goto error;
2098 }
2099
2100 td->dirfd = open(path, 0);
2101 if (td->dirfd < 0) {
2102 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2103 perror("Trace directory open");
2104 ret = -errno;
2105 goto error_dirfd;
2106 }
2107 strncpy(td->parent.path, path, sizeof(td->parent.path));
2108 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2109
2110 /*
2111 * Keep the metadata file separate.
2112 * Keep scanner object local to the open. We don't support
2113 * incremental metadata append for on-disk traces.
2114 */
2115 scanner = ctf_scanner_alloc();
2116 if (!scanner) {
2117 fprintf(stderr, "[error] Error allocating scanner\n");
2118 ret = -ENOMEM;
2119 goto error_metadata;
2120 }
2121 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2122 ctf_scanner_free(scanner);
2123 if (ret) {
2124 if (ret == -ENOENT) {
2125 fprintf(stderr, "[warning] Empty metadata.\n");
2126 }
2127 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2128 goto error_metadata;
2129 }
2130
2131 /*
2132 * Open each stream: for each file, try to open, check magic
2133 * number, and get the stream ID to add to the right location in
2134 * the stream array.
2135 */
2136
2137 dirent_len = offsetof(struct dirent, d_name) +
2138 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2139
2140 dirent = malloc(dirent_len);
2141
2142 for (;;) {
2143 ret = readdir_r(td->dir, dirent, &diriter);
2144 if (ret) {
2145 fprintf(stderr, "[error] Readdir error.\n");
2146 goto readdir_error;
2147 }
2148 if (!diriter)
2149 break;
2150 /* Ignore hidden files, ., .. and metadata. */
2151 if (!strncmp(diriter->d_name, ".", 1)
2152 || !strcmp(diriter->d_name, "..")
2153 || !strcmp(diriter->d_name, "metadata"))
2154 continue;
2155
2156 /* Ignore index files : *.idx */
2157 ext = strrchr(diriter->d_name, '.');
2158 if (ext && (!strcmp(ext, ".idx"))) {
2159 continue;
2160 }
2161
2162 ret = ctf_open_file_stream_read(td, diriter->d_name,
2163 flags, packet_seek);
2164 if (ret) {
2165 fprintf(stderr, "[error] Open file stream error.\n");
2166 goto readdir_error;
2167 }
2168 }
2169
2170 free(dirent);
2171 return 0;
2172
2173 readdir_error:
2174 free(dirent);
2175 error_metadata:
2176 closeret = close(td->dirfd);
2177 if (closeret) {
2178 perror("Error on fd close");
2179 }
2180 error_dirfd:
2181 closeret = closedir(td->dir);
2182 if (closeret) {
2183 perror("Error on closedir");
2184 }
2185 error:
2186 return ret;
2187 }
2188
2189 /*
2190 * ctf_open_trace: Open a CTF trace and index it.
2191 * Note that the user must seek the trace after the open (using the iterator)
2192 * since the index creation read it entirely.
2193 */
2194 static
2195 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2196 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2197 int whence), FILE *metadata_fp)
2198 {
2199 struct ctf_trace *td;
2200 int ret;
2201
2202 /*
2203 * If packet_seek is NULL, we provide our default version.
2204 */
2205 if (!packet_seek)
2206 packet_seek = ctf_packet_seek;
2207
2208 td = g_new0(struct ctf_trace, 1);
2209
2210 switch (flags & O_ACCMODE) {
2211 case O_RDONLY:
2212 if (!path) {
2213 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2214 goto error;
2215 }
2216 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2217 if (ret)
2218 goto error;
2219 break;
2220 case O_RDWR:
2221 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2222 goto error;
2223 default:
2224 fprintf(stderr, "[error] Incorrect open flags.\n");
2225 goto error;
2226 }
2227
2228 return &td->parent;
2229 error:
2230 g_free(td);
2231 return NULL;
2232 }
2233
2234 static
2235 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2236 struct bt_mmap_stream *mmap_info)
2237 {
2238 pos->mmap_offset = 0;
2239 pos->packet_size = 0;
2240 pos->content_size = 0;
2241 pos->content_size_loc = NULL;
2242 pos->fd = mmap_info->fd;
2243 pos->base_mma = NULL;
2244 pos->offset = 0;
2245 pos->dummy = false;
2246 pos->cur_index = 0;
2247 pos->prot = PROT_READ;
2248 pos->flags = MAP_PRIVATE;
2249 pos->parent.rw_table = read_dispatch_table;
2250 pos->parent.event_cb = ctf_read_event;
2251 pos->priv = mmap_info->priv;
2252 pos->packet_index = g_array_new(FALSE, TRUE,
2253 sizeof(struct packet_index));
2254 }
2255
2256 static
2257 int prepare_mmap_stream_definition(struct ctf_trace *td,
2258 struct ctf_file_stream *file_stream,
2259 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2260 int whence))
2261 {
2262 struct ctf_stream_declaration *stream;
2263 uint64_t stream_id;
2264 int ret;
2265
2266 /* Ask for the first packet to get the stream_id. */
2267 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2268 stream_id = file_stream->parent.stream_id;
2269 if (stream_id >= td->streams->len) {
2270 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2271 "in metadata.\n", stream_id);
2272 ret = -EINVAL;
2273 goto end;
2274 }
2275 stream = g_ptr_array_index(td->streams, stream_id);
2276 if (!stream) {
2277 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2278 "in metadata.\n", stream_id);
2279 ret = -EINVAL;
2280 goto end;
2281 }
2282 file_stream->parent.stream_class = stream;
2283 ret = create_stream_definitions(td, &file_stream->parent);
2284 end:
2285 return ret;
2286 }
2287
2288 static
2289 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2290 struct bt_mmap_stream *mmap_info,
2291 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2292 int whence))
2293 {
2294 int ret;
2295 struct ctf_file_stream *file_stream;
2296
2297 file_stream = g_new0(struct ctf_file_stream, 1);
2298 file_stream->parent.stream_id = -1ULL;
2299 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2300 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2301
2302 file_stream->pos.packet_seek = packet_seek;
2303
2304 ret = create_trace_definitions(td, &file_stream->parent);
2305 if (ret) {
2306 goto error_def;
2307 }
2308
2309 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2310 if (ret)
2311 goto error_index;
2312
2313 /*
2314 * For now, only a single clock per trace is supported.
2315 */
2316 file_stream->parent.current_clock = td->parent.single_clock;
2317
2318 /* Add stream file to stream class */
2319 g_ptr_array_add(file_stream->parent.stream_class->streams,
2320 &file_stream->parent);
2321 return 0;
2322
2323 error_index:
2324 if (file_stream->parent.trace_packet_header)
2325 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2326 error_def:
2327 g_free(file_stream);
2328 return ret;
2329 }
2330
2331 static
2332 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2333 struct bt_mmap_stream_list *mmap_list,
2334 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2335 int whence),
2336 FILE *metadata_fp)
2337 {
2338 int ret;
2339 struct bt_mmap_stream *mmap_info;
2340
2341 td->scanner = ctf_scanner_alloc();
2342 if (!td->scanner) {
2343 fprintf(stderr, "[error] Error allocating scanner\n");
2344 ret = -ENOMEM;
2345 goto error;
2346 }
2347 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2348 if (ret) {
2349 if (ret == -ENOENT) {
2350 fprintf(stderr, "[warning] Empty metadata.\n");
2351 }
2352 goto error;
2353 }
2354
2355 /*
2356 * for each stream, try to open, check magic number, and get the
2357 * stream ID to add to the right location in the stream array.
2358 */
2359 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2360 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2361 if (ret) {
2362 fprintf(stderr, "[error] Open file mmap stream error.\n");
2363 goto error;
2364 }
2365 }
2366 return 0;
2367
2368 error:
2369 ctf_scanner_free(td->scanner);
2370 return ret;
2371 }
2372
2373 static
2374 struct bt_trace_descriptor *ctf_open_mmap_trace(
2375 struct bt_mmap_stream_list *mmap_list,
2376 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2377 int whence),
2378 FILE *metadata_fp)
2379 {
2380 struct ctf_trace *td;
2381 int ret;
2382
2383 if (!metadata_fp) {
2384 fprintf(stderr, "[error] No metadata file pointer associated, "
2385 "required for mmap parsing\n");
2386 goto error;
2387 }
2388 if (!packet_seek) {
2389 fprintf(stderr, "[error] packet_seek function undefined.\n");
2390 goto error;
2391 }
2392 td = g_new0(struct ctf_trace, 1);
2393 td->dirfd = -1;
2394 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2395 if (ret)
2396 goto error_free;
2397
2398 return &td->parent;
2399
2400 error_free:
2401 g_free(td);
2402 error:
2403 return NULL;
2404 }
2405
2406 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2407 FILE *metadata_fp)
2408 {
2409 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2410 int i, j;
2411 int ret;
2412
2413 if (!td->scanner)
2414 return -EINVAL;
2415 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2416 if (ret)
2417 return ret;
2418 /* for each stream_class */
2419 for (i = 0; i < td->streams->len; i++) {
2420 struct ctf_stream_declaration *stream_class;
2421
2422 stream_class = g_ptr_array_index(td->streams, i);
2423 if (!stream_class)
2424 continue;
2425 /* for each stream */
2426 for (j = 0; j < stream_class->streams->len; j++) {
2427 struct ctf_stream_definition *stream;
2428
2429 stream = g_ptr_array_index(stream_class->streams, j);
2430 if (!stream)
2431 continue;
2432 ret = copy_event_declarations_stream_class_to_stream(td,
2433 stream_class, stream);
2434 if (ret)
2435 return ret;
2436 }
2437 }
2438 return 0;
2439 }
2440
2441 static
2442 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2443 {
2444 int i, j, k;
2445 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2446
2447 /* for each stream_class */
2448 for (i = 0; i < td->streams->len; i++) {
2449 struct ctf_stream_declaration *stream_class;
2450
2451 stream_class = g_ptr_array_index(td->streams, i);
2452 if (!stream_class)
2453 continue;
2454 /* for each file_stream */
2455 for (j = 0; j < stream_class->streams->len; j++) {
2456 struct ctf_stream_definition *stream;
2457 struct ctf_stream_pos *stream_pos;
2458 struct ctf_file_stream *cfs;
2459
2460 stream = g_ptr_array_index(stream_class->streams, j);
2461 if (!stream)
2462 continue;
2463 cfs = container_of(stream, struct ctf_file_stream,
2464 parent);
2465 stream_pos = &cfs->pos;
2466 if (!stream_pos->packet_index)
2467 continue;
2468
2469 for (k = 0; k < stream_pos->packet_index->len; k++) {
2470 struct packet_index *index;
2471
2472 index = &g_array_index(stream_pos->packet_index,
2473 struct packet_index, k);
2474 index->ts_real.timestamp_begin =
2475 ctf_get_real_timestamp(stream,
2476 index->ts_cycles.timestamp_begin);
2477 index->ts_real.timestamp_end =
2478 ctf_get_real_timestamp(stream,
2479 index->ts_cycles.timestamp_end);
2480 }
2481 }
2482 }
2483 return 0;
2484 }
2485
2486 static
2487 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2488 {
2489 int ret;
2490
2491 ret = ctf_fini_pos(&file_stream->pos);
2492 if (ret) {
2493 fprintf(stderr, "Error on ctf_fini_pos\n");
2494 return -1;
2495 }
2496 if (file_stream->pos.fd >= 0) {
2497 ret = close(file_stream->pos.fd);
2498 if (ret) {
2499 perror("Error closing file fd");
2500 return -1;
2501 }
2502 }
2503 return 0;
2504 }
2505
2506 static
2507 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2508 {
2509 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2510 int ret;
2511
2512 if (td->streams) {
2513 int i;
2514
2515 for (i = 0; i < td->streams->len; i++) {
2516 struct ctf_stream_declaration *stream;
2517 int j;
2518
2519 stream = g_ptr_array_index(td->streams, i);
2520 if (!stream)
2521 continue;
2522 for (j = 0; j < stream->streams->len; j++) {
2523 struct ctf_file_stream *file_stream;
2524 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2525 struct ctf_file_stream, parent);
2526 ret = ctf_close_file_stream(file_stream);
2527 if (ret)
2528 return ret;
2529 }
2530 }
2531 }
2532 ctf_destroy_metadata(td);
2533 ctf_scanner_free(td->scanner);
2534 if (td->dirfd >= 0) {
2535 ret = close(td->dirfd);
2536 if (ret) {
2537 perror("Error closing dirfd");
2538 return ret;
2539 }
2540 }
2541 if (td->dir) {
2542 ret = closedir(td->dir);
2543 if (ret) {
2544 perror("Error closedir");
2545 return ret;
2546 }
2547 }
2548 free(td->metadata_string);
2549 g_free(td);
2550 return 0;
2551 }
2552
2553 static
2554 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2555 struct bt_context *ctx)
2556 {
2557 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2558 parent);
2559
2560 td->parent.ctx = ctx;
2561 }
2562
2563 static
2564 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2565 struct bt_trace_handle *handle)
2566 {
2567 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2568 parent);
2569
2570 td->parent.handle = handle;
2571 }
2572
2573 static
2574 void __attribute__((constructor)) ctf_init(void)
2575 {
2576 int ret;
2577
2578 ctf_format.name = g_quark_from_static_string("ctf");
2579 ret = bt_register_format(&ctf_format);
2580 assert(!ret);
2581 }
2582
2583 static
2584 void __attribute__((destructor)) ctf_exit(void)
2585 {
2586 bt_unregister_format(&ctf_format);
2587 }
This page took 0.087136 seconds and 4 git commands to generate.