7d51b7dc544e2a700e8be0c0512a1cc883b1f690
[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 if (pos->cur_index >= pos->packet_index->len) {
940 pos->offset = EOF;
941 return;
942 }
943
944 packet_index = &g_array_index(pos->packet_index,
945 struct packet_index, pos->cur_index);
946 if (pos->cur_index > 0) {
947 prev_index = &g_array_index(pos->packet_index,
948 struct packet_index,
949 pos->cur_index - 1);
950 } else {
951 prev_index = NULL;
952 }
953 ctf_update_current_packet_index(&file_stream->parent,
954 prev_index, packet_index);
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 packet_index.stream_instance_id = 0;
1555 packet_index.packet_seq_num = 0;
1556
1557 /* read and check header, set stream id (and check) */
1558 if (file_stream->parent.trace_packet_header) {
1559 /* Read packet header */
1560 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1561 if (ret) {
1562 if (ret == -EFAULT)
1563 goto retry;
1564 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1565 return ret;
1566 }
1567 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1568 if (len_index >= 0) {
1569 struct bt_definition *field;
1570 uint64_t magic;
1571
1572 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1573 magic = bt_get_unsigned_int(field);
1574 if (magic != CTF_MAGIC) {
1575 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1576 magic,
1577 file_stream->pos.packet_index->len,
1578 (ssize_t) pos->mmap_offset);
1579 return -EINVAL;
1580 }
1581 }
1582
1583 /* check uuid */
1584 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1585 if (len_index >= 0) {
1586 struct definition_array *defarray;
1587 struct bt_definition *field;
1588 uint64_t i;
1589 uint8_t uuidval[BABELTRACE_UUID_LEN];
1590
1591 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1592 assert(field->declaration->id == CTF_TYPE_ARRAY);
1593 defarray = container_of(field, struct definition_array, p);
1594 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1595
1596 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1597 struct bt_definition *elem;
1598
1599 elem = bt_array_index(defarray, i);
1600 uuidval[i] = bt_get_unsigned_int(elem);
1601 }
1602 ret = bt_uuid_compare(td->uuid, uuidval);
1603 if (ret) {
1604 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1605 return -EINVAL;
1606 }
1607 }
1608
1609 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1610 if (len_index >= 0) {
1611 struct bt_definition *field;
1612
1613 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1614 stream_id = bt_get_unsigned_int(field);
1615 }
1616 }
1617
1618 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1619 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1620 stream_id,
1621 file_stream->parent.stream_id);
1622 return -EINVAL;
1623 }
1624 if (first_packet) {
1625 ret = stream_assign_class(td, file_stream, stream_id);
1626 if (ret)
1627 return ret;
1628 }
1629
1630 if (file_stream->parent.stream_packet_context) {
1631 /* Read packet context */
1632 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1633 if (ret) {
1634 if (ret == -EFAULT)
1635 goto retry;
1636 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1637 return ret;
1638 }
1639 /* read packet size from header */
1640 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1641 if (len_index >= 0) {
1642 struct bt_definition *field;
1643
1644 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1645 packet_index.packet_size = bt_get_unsigned_int(field);
1646 } else {
1647 /* Use file size for packet size */
1648 packet_index.packet_size = filesize * CHAR_BIT;
1649 }
1650
1651 /* read content size from header */
1652 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1653 if (len_index >= 0) {
1654 struct bt_definition *field;
1655
1656 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1657 packet_index.content_size = bt_get_unsigned_int(field);
1658 } else {
1659 /* Use packet size if non-zero, else file size */
1660 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1661 }
1662
1663 /* read timestamp begin from header */
1664 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1665 if (len_index >= 0) {
1666 struct bt_definition *field;
1667
1668 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1669 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1670 if (file_stream->parent.stream_class->trace->parent.collection) {
1671 packet_index.ts_real.timestamp_begin =
1672 ctf_get_real_timestamp(
1673 &file_stream->parent,
1674 packet_index.ts_cycles.timestamp_begin);
1675 }
1676 }
1677
1678 /* read timestamp end from header */
1679 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1680 if (len_index >= 0) {
1681 struct bt_definition *field;
1682
1683 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1684 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1685 if (file_stream->parent.stream_class->trace->parent.collection) {
1686 packet_index.ts_real.timestamp_end =
1687 ctf_get_real_timestamp(
1688 &file_stream->parent,
1689 packet_index.ts_cycles.timestamp_end);
1690 }
1691 }
1692
1693 /* read events discarded from header */
1694 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1695 if (len_index >= 0) {
1696 struct bt_definition *field;
1697
1698 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1699 packet_index.events_discarded = bt_get_unsigned_int(field);
1700 packet_index.events_discarded_len = bt_get_int_len(field);
1701 }
1702 } else {
1703 /* Use file size for packet size */
1704 packet_index.packet_size = filesize * CHAR_BIT;
1705 /* Use packet size if non-zero, else file size */
1706 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1707 }
1708
1709 /* Validate content size and packet size values */
1710 if (packet_index.content_size > packet_index.packet_size) {
1711 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1712 packet_index.content_size, packet_index.packet_size);
1713 return -EINVAL;
1714 }
1715
1716 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1717 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1718 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1719 return -EINVAL;
1720 }
1721
1722 if (packet_index.content_size < pos->offset) {
1723 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1724 return -EINVAL;
1725 }
1726
1727 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1728 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1729 return -EINVAL;
1730 }
1731
1732 /* Save position after header and context */
1733 packet_index.data_offset = pos->offset;
1734
1735 /* add index to packet array */
1736 g_array_append_val(file_stream->pos.packet_index, packet_index);
1737
1738 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1739
1740 return 0;
1741
1742 /* Retry with larger mapping */
1743 retry:
1744 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1745 /*
1746 * Reached EOF, but still expecting header/context data.
1747 */
1748 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1749 return -EFAULT;
1750 }
1751 /* Double the mapping len, and retry */
1752 tmp_map_len = packet_map_len << 1;
1753 if (tmp_map_len >> 1 != packet_map_len) {
1754 /* Overflow */
1755 fprintf(stderr, "[error] Packet mapping length overflow\n");
1756 return -EFAULT;
1757 }
1758 packet_map_len = tmp_map_len;
1759 goto begin;
1760 }
1761
1762 static
1763 int create_stream_packet_index(struct ctf_trace *td,
1764 struct ctf_file_stream *file_stream)
1765 {
1766 struct ctf_stream_pos *pos;
1767 struct stat filestats;
1768 int ret;
1769
1770 pos = &file_stream->pos;
1771
1772 ret = fstat(pos->fd, &filestats);
1773 if (ret < 0)
1774 return ret;
1775
1776 /* Deal with empty files */
1777 if (!filestats.st_size) {
1778 if (file_stream->parent.trace_packet_header
1779 || file_stream->parent.stream_packet_context) {
1780 /*
1781 * We expect a trace packet header and/or stream packet
1782 * context. Since a trace needs to have at least one
1783 * packet, empty files are therefore not accepted.
1784 */
1785 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1786 return -EINVAL;
1787 } else {
1788 /*
1789 * Without trace packet header nor stream packet
1790 * context, a one-packet trace can indeed be empty. This
1791 * is only valid if there is only one stream class: 0.
1792 */
1793 ret = stream_assign_class(td, file_stream, 0);
1794 if (ret)
1795 return ret;
1796 return 0;
1797 }
1798 }
1799
1800 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1801 ret = create_stream_one_packet_index(pos, td, file_stream,
1802 filestats.st_size);
1803 if (ret)
1804 return ret;
1805 }
1806 return 0;
1807 }
1808
1809 static
1810 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1811 {
1812 int ret;
1813
1814 if (td->packet_header_decl) {
1815 struct bt_definition *definition =
1816 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1817 stream->parent_def_scope, 0, 0, "trace.packet.header");
1818 if (!definition) {
1819 ret = -EINVAL;
1820 goto error;
1821 }
1822 stream->trace_packet_header =
1823 container_of(definition, struct definition_struct, p);
1824 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1825 }
1826
1827 return 0;
1828
1829 error:
1830 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1831 return ret;
1832 }
1833
1834 static
1835 int import_stream_packet_index(struct ctf_trace *td,
1836 struct ctf_file_stream *file_stream)
1837 {
1838 struct ctf_stream_pos *pos;
1839 struct ctf_packet_index *ctf_index = NULL;
1840 struct ctf_packet_index_file_hdr index_hdr;
1841 struct packet_index index;
1842 uint32_t packet_index_len, index_minor;
1843 int ret = 0;
1844 int first_packet = 1;
1845 size_t len;
1846
1847 pos = &file_stream->pos;
1848
1849 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1850 if (len != 1) {
1851 perror("read index file header");
1852 goto error;
1853 }
1854
1855 /* Check the index header */
1856 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1857 fprintf(stderr, "[error] wrong index magic\n");
1858 ret = -1;
1859 goto error;
1860 }
1861 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1862 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1863 ".%" PRIu32 ", supported %d.%d\n",
1864 be32toh(index_hdr.index_major),
1865 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1866 CTF_INDEX_MINOR);
1867 ret = -1;
1868 goto error;
1869 }
1870 index_minor = be32toh(index_hdr.index_minor);
1871
1872 packet_index_len = be32toh(index_hdr.packet_index_len);
1873 if (packet_index_len == 0) {
1874 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1875 ret = -1;
1876 goto error;
1877 }
1878 /*
1879 * Allocate the index length found in header, not internal
1880 * representation.
1881 */
1882 ctf_index = g_malloc0(packet_index_len);
1883 while (fread(ctf_index, packet_index_len, 1,
1884 pos->index_fp) == 1) {
1885 uint64_t stream_id;
1886 struct ctf_stream_declaration *stream = NULL;
1887
1888 memset(&index, 0, sizeof(index));
1889 index.offset = be64toh(ctf_index->offset);
1890 index.packet_size = be64toh(ctf_index->packet_size);
1891 index.content_size = be64toh(ctf_index->content_size);
1892 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
1893 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
1894 index.events_discarded = be64toh(ctf_index->events_discarded);
1895 index.events_discarded_len = 64;
1896 index.data_offset = -1;
1897 stream_id = be64toh(ctf_index->stream_id);
1898 if (index_minor >= 1) {
1899 index.stream_instance_id = be64toh(ctf_index->stream_instance_id);
1900 index.packet_seq_num = be64toh(ctf_index->packet_seq_num);
1901 }
1902
1903 if (!first_packet) {
1904 /* add index to packet array */
1905 g_array_append_val(file_stream->pos.packet_index, index);
1906 continue;
1907 }
1908
1909 file_stream->parent.stream_id = stream_id;
1910 if (stream_id < td->streams->len) {
1911 stream = g_ptr_array_index(td->streams, stream_id);
1912 }
1913 if (!stream) {
1914 fprintf(stderr, "[error] Stream %" PRIu64
1915 " is not declared in metadata.\n",
1916 stream_id);
1917 ret = -EINVAL;
1918 goto error;
1919 }
1920 file_stream->parent.stream_class = stream;
1921 ret = create_stream_definitions(td, &file_stream->parent);
1922 if (ret)
1923 goto error;
1924 first_packet = 0;
1925 /* add index to packet array */
1926 g_array_append_val(file_stream->pos.packet_index, index);
1927 }
1928
1929 /* Index containing only the header. */
1930 if (!file_stream->parent.stream_class) {
1931 ret = -1;
1932 goto error;
1933 }
1934
1935 ret = 0;
1936
1937 error:
1938 g_free(ctf_index);
1939 return ret;
1940 }
1941
1942 /*
1943 * Note: many file streams can inherit from the same stream class
1944 * description (metadata).
1945 */
1946 static
1947 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1948 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
1949 int whence))
1950 {
1951 int ret, fd, closeret;
1952 struct ctf_file_stream *file_stream;
1953 struct stat statbuf;
1954 char *index_name;
1955
1956 fd = openat(td->dirfd, path, flags);
1957 if (fd < 0) {
1958 perror("File stream openat()");
1959 ret = fd;
1960 goto error;
1961 }
1962
1963 /* Don't try to mmap subdirectories. Skip them, return success. */
1964 ret = fstat(fd, &statbuf);
1965 if (ret) {
1966 perror("File stream fstat()");
1967 goto fstat_error;
1968 }
1969 if (S_ISDIR(statbuf.st_mode)) {
1970 if (strncmp(path, "index", 5) != 0) {
1971 fprintf(stderr, "[warning] Skipping directory '%s' "
1972 "found in trace\n", path);
1973 }
1974 ret = 0;
1975 goto fd_is_dir_ok;
1976 }
1977 if (!statbuf.st_size) {
1978 /** Skip empty files. */
1979 ret = 0;
1980 goto fd_is_empty_file;
1981 }
1982
1983 file_stream = g_new0(struct ctf_file_stream, 1);
1984 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1985 file_stream->pos.fd = -1;
1986 file_stream->pos.index_fp = NULL;
1987
1988 strncpy(file_stream->parent.path, path, PATH_MAX);
1989 file_stream->parent.path[PATH_MAX - 1] = '\0';
1990
1991 if (packet_seek) {
1992 file_stream->pos.packet_seek = packet_seek;
1993 } else {
1994 fprintf(stderr, "[error] packet_seek function undefined.\n");
1995 ret = -1;
1996 goto error_def;
1997 }
1998
1999 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
2000 if (ret)
2001 goto error_def;
2002 ret = create_trace_definitions(td, &file_stream->parent);
2003 if (ret)
2004 goto error_def;
2005 /*
2006 * For now, only a single clock per trace is supported.
2007 */
2008 file_stream->parent.current_clock = td->parent.single_clock;
2009
2010 /*
2011 * Allocate the index name for this stream and try to open it.
2012 */
2013 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2014 if (!index_name) {
2015 fprintf(stderr, "[error] Cannot allocate index filename\n");
2016 ret = -ENOMEM;
2017 goto error_def;
2018 }
2019 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2020 INDEX_PATH, path);
2021
2022 if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) {
2023 ret = create_stream_packet_index(td, file_stream);
2024 if (ret) {
2025 fprintf(stderr, "[error] Stream index creation error.\n");
2026 goto error_index;
2027 }
2028 } else {
2029 ret = openat(td->dirfd, index_name, flags);
2030 if (ret < 0) {
2031 perror("Index file openat()");
2032 ret = -1;
2033 goto error_free;
2034 }
2035 file_stream->pos.index_fp = fdopen(ret, "r");
2036 if (!file_stream->pos.index_fp) {
2037 perror("fdopen() error");
2038 goto error_free;
2039 }
2040 ret = import_stream_packet_index(td, file_stream);
2041 if (ret) {
2042 ret = -1;
2043 goto error_index;
2044 }
2045 ret = fclose(file_stream->pos.index_fp);
2046 if (ret < 0) {
2047 perror("close index");
2048 goto error_free;
2049 }
2050 }
2051 free(index_name);
2052
2053 /* Add stream file to stream class */
2054 g_ptr_array_add(file_stream->parent.stream_class->streams,
2055 &file_stream->parent);
2056 return 0;
2057
2058 error_index:
2059 if (file_stream->pos.index_fp) {
2060 ret = fclose(file_stream->pos.index_fp);
2061 if (ret < 0) {
2062 perror("close index");
2063 }
2064 }
2065 if (file_stream->parent.trace_packet_header)
2066 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2067 error_free:
2068 free(index_name);
2069 error_def:
2070 closeret = ctf_fini_pos(&file_stream->pos);
2071 if (closeret) {
2072 fprintf(stderr, "Error on ctf_fini_pos\n");
2073 }
2074 g_free(file_stream);
2075 fd_is_empty_file:
2076 fd_is_dir_ok:
2077 fstat_error:
2078 closeret = close(fd);
2079 if (closeret) {
2080 perror("Error on fd close");
2081 }
2082 error:
2083 return ret;
2084 }
2085
2086 static
2087 int ctf_open_trace_read(struct ctf_trace *td,
2088 const char *path, int flags,
2089 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2090 int whence), FILE *metadata_fp)
2091 {
2092 struct ctf_scanner *scanner;
2093 int ret, closeret;
2094 struct dirent *dirent;
2095 struct dirent *diriter;
2096 size_t dirent_len;
2097 char *ext;
2098
2099 td->flags = flags;
2100
2101 /* Open trace directory */
2102 td->dir = opendir(path);
2103 if (!td->dir) {
2104 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2105 ret = -ENOENT;
2106 goto error;
2107 }
2108
2109 td->dirfd = open(path, 0);
2110 if (td->dirfd < 0) {
2111 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2112 perror("Trace directory open");
2113 ret = -errno;
2114 goto error_dirfd;
2115 }
2116 strncpy(td->parent.path, path, sizeof(td->parent.path));
2117 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2118
2119 /*
2120 * Keep the metadata file separate.
2121 * Keep scanner object local to the open. We don't support
2122 * incremental metadata append for on-disk traces.
2123 */
2124 scanner = ctf_scanner_alloc();
2125 if (!scanner) {
2126 fprintf(stderr, "[error] Error allocating scanner\n");
2127 ret = -ENOMEM;
2128 goto error_metadata;
2129 }
2130 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2131 ctf_scanner_free(scanner);
2132 if (ret) {
2133 if (ret == -ENOENT) {
2134 fprintf(stderr, "[warning] Empty metadata.\n");
2135 }
2136 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2137 goto error_metadata;
2138 }
2139
2140 /*
2141 * Open each stream: for each file, try to open, check magic
2142 * number, and get the stream ID to add to the right location in
2143 * the stream array.
2144 */
2145
2146 dirent_len = offsetof(struct dirent, d_name) +
2147 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2148
2149 dirent = malloc(dirent_len);
2150
2151 for (;;) {
2152 ret = readdir_r(td->dir, dirent, &diriter);
2153 if (ret) {
2154 fprintf(stderr, "[error] Readdir error.\n");
2155 goto readdir_error;
2156 }
2157 if (!diriter)
2158 break;
2159 /* Ignore hidden files, ., .. and metadata. */
2160 if (!strncmp(diriter->d_name, ".", 1)
2161 || !strcmp(diriter->d_name, "..")
2162 || !strcmp(diriter->d_name, "metadata"))
2163 continue;
2164
2165 /* Ignore index files : *.idx */
2166 ext = strrchr(diriter->d_name, '.');
2167 if (ext && (!strcmp(ext, ".idx"))) {
2168 continue;
2169 }
2170
2171 ret = ctf_open_file_stream_read(td, diriter->d_name,
2172 flags, packet_seek);
2173 if (ret) {
2174 fprintf(stderr, "[error] Open file stream error.\n");
2175 goto readdir_error;
2176 }
2177 }
2178
2179 free(dirent);
2180 return 0;
2181
2182 readdir_error:
2183 free(dirent);
2184 error_metadata:
2185 closeret = close(td->dirfd);
2186 if (closeret) {
2187 perror("Error on fd close");
2188 }
2189 error_dirfd:
2190 closeret = closedir(td->dir);
2191 if (closeret) {
2192 perror("Error on closedir");
2193 }
2194 error:
2195 return ret;
2196 }
2197
2198 /*
2199 * ctf_open_trace: Open a CTF trace and index it.
2200 * Note that the user must seek the trace after the open (using the iterator)
2201 * since the index creation read it entirely.
2202 */
2203 static
2204 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2205 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2206 int whence), FILE *metadata_fp)
2207 {
2208 struct ctf_trace *td;
2209 int ret;
2210
2211 /*
2212 * If packet_seek is NULL, we provide our default version.
2213 */
2214 if (!packet_seek)
2215 packet_seek = ctf_packet_seek;
2216
2217 td = g_new0(struct ctf_trace, 1);
2218
2219 switch (flags & O_ACCMODE) {
2220 case O_RDONLY:
2221 if (!path) {
2222 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2223 goto error;
2224 }
2225 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2226 if (ret)
2227 goto error;
2228 break;
2229 case O_RDWR:
2230 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2231 goto error;
2232 default:
2233 fprintf(stderr, "[error] Incorrect open flags.\n");
2234 goto error;
2235 }
2236
2237 return &td->parent;
2238 error:
2239 g_free(td);
2240 return NULL;
2241 }
2242
2243 static
2244 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2245 struct bt_mmap_stream *mmap_info)
2246 {
2247 pos->mmap_offset = 0;
2248 pos->packet_size = 0;
2249 pos->content_size = 0;
2250 pos->content_size_loc = NULL;
2251 pos->fd = mmap_info->fd;
2252 pos->base_mma = NULL;
2253 pos->offset = 0;
2254 pos->dummy = false;
2255 pos->cur_index = 0;
2256 pos->prot = PROT_READ;
2257 pos->flags = MAP_PRIVATE;
2258 pos->parent.rw_table = read_dispatch_table;
2259 pos->parent.event_cb = ctf_read_event;
2260 pos->priv = mmap_info->priv;
2261 pos->packet_index = g_array_new(FALSE, TRUE,
2262 sizeof(struct packet_index));
2263 }
2264
2265 static
2266 int prepare_mmap_stream_definition(struct ctf_trace *td,
2267 struct ctf_file_stream *file_stream,
2268 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2269 int whence))
2270 {
2271 struct ctf_stream_declaration *stream;
2272 uint64_t stream_id;
2273 int ret;
2274
2275 /* Ask for the first packet to get the stream_id. */
2276 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2277 stream_id = file_stream->parent.stream_id;
2278 if (stream_id >= td->streams->len) {
2279 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2280 "in metadata.\n", stream_id);
2281 ret = -EINVAL;
2282 goto end;
2283 }
2284 stream = g_ptr_array_index(td->streams, stream_id);
2285 if (!stream) {
2286 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2287 "in metadata.\n", stream_id);
2288 ret = -EINVAL;
2289 goto end;
2290 }
2291 file_stream->parent.stream_class = stream;
2292 ret = create_stream_definitions(td, &file_stream->parent);
2293 end:
2294 return ret;
2295 }
2296
2297 static
2298 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2299 struct bt_mmap_stream *mmap_info,
2300 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2301 int whence))
2302 {
2303 int ret;
2304 struct ctf_file_stream *file_stream;
2305
2306 file_stream = g_new0(struct ctf_file_stream, 1);
2307 file_stream->parent.stream_id = -1ULL;
2308 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2309 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2310
2311 file_stream->pos.packet_seek = packet_seek;
2312
2313 ret = create_trace_definitions(td, &file_stream->parent);
2314 if (ret) {
2315 goto error_def;
2316 }
2317
2318 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2319 if (ret)
2320 goto error_index;
2321
2322 /*
2323 * For now, only a single clock per trace is supported.
2324 */
2325 file_stream->parent.current_clock = td->parent.single_clock;
2326
2327 /* Add stream file to stream class */
2328 g_ptr_array_add(file_stream->parent.stream_class->streams,
2329 &file_stream->parent);
2330 return 0;
2331
2332 error_index:
2333 if (file_stream->parent.trace_packet_header)
2334 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2335 error_def:
2336 g_free(file_stream);
2337 return ret;
2338 }
2339
2340 static
2341 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2342 struct bt_mmap_stream_list *mmap_list,
2343 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2344 int whence),
2345 FILE *metadata_fp)
2346 {
2347 int ret;
2348 struct bt_mmap_stream *mmap_info;
2349
2350 td->scanner = ctf_scanner_alloc();
2351 if (!td->scanner) {
2352 fprintf(stderr, "[error] Error allocating scanner\n");
2353 ret = -ENOMEM;
2354 goto error;
2355 }
2356 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2357 if (ret) {
2358 if (ret == -ENOENT) {
2359 fprintf(stderr, "[warning] Empty metadata.\n");
2360 }
2361 goto error;
2362 }
2363
2364 /*
2365 * for each stream, try to open, check magic number, and get the
2366 * stream ID to add to the right location in the stream array.
2367 */
2368 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2369 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2370 if (ret) {
2371 fprintf(stderr, "[error] Open file mmap stream error.\n");
2372 goto error;
2373 }
2374 }
2375 return 0;
2376
2377 error:
2378 ctf_scanner_free(td->scanner);
2379 return ret;
2380 }
2381
2382 static
2383 struct bt_trace_descriptor *ctf_open_mmap_trace(
2384 struct bt_mmap_stream_list *mmap_list,
2385 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2386 int whence),
2387 FILE *metadata_fp)
2388 {
2389 struct ctf_trace *td;
2390 int ret;
2391
2392 if (!metadata_fp) {
2393 fprintf(stderr, "[error] No metadata file pointer associated, "
2394 "required for mmap parsing\n");
2395 goto error;
2396 }
2397 if (!packet_seek) {
2398 fprintf(stderr, "[error] packet_seek function undefined.\n");
2399 goto error;
2400 }
2401 td = g_new0(struct ctf_trace, 1);
2402 td->dirfd = -1;
2403 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2404 if (ret)
2405 goto error_free;
2406
2407 return &td->parent;
2408
2409 error_free:
2410 g_free(td);
2411 error:
2412 return NULL;
2413 }
2414
2415 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2416 FILE *metadata_fp)
2417 {
2418 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2419 int i, j;
2420 int ret;
2421
2422 if (!td->scanner)
2423 return -EINVAL;
2424 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2425 if (ret)
2426 return ret;
2427 /* for each stream_class */
2428 for (i = 0; i < td->streams->len; i++) {
2429 struct ctf_stream_declaration *stream_class;
2430
2431 stream_class = g_ptr_array_index(td->streams, i);
2432 if (!stream_class)
2433 continue;
2434 /* for each stream */
2435 for (j = 0; j < stream_class->streams->len; j++) {
2436 struct ctf_stream_definition *stream;
2437
2438 stream = g_ptr_array_index(stream_class->streams, j);
2439 if (!stream)
2440 continue;
2441 ret = copy_event_declarations_stream_class_to_stream(td,
2442 stream_class, stream);
2443 if (ret)
2444 return ret;
2445 }
2446 }
2447 return 0;
2448 }
2449
2450 static
2451 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2452 {
2453 int i, j, k;
2454 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2455
2456 /* for each stream_class */
2457 for (i = 0; i < td->streams->len; i++) {
2458 struct ctf_stream_declaration *stream_class;
2459
2460 stream_class = g_ptr_array_index(td->streams, i);
2461 if (!stream_class)
2462 continue;
2463 /* for each file_stream */
2464 for (j = 0; j < stream_class->streams->len; j++) {
2465 struct ctf_stream_definition *stream;
2466 struct ctf_stream_pos *stream_pos;
2467 struct ctf_file_stream *cfs;
2468
2469 stream = g_ptr_array_index(stream_class->streams, j);
2470 if (!stream)
2471 continue;
2472 cfs = container_of(stream, struct ctf_file_stream,
2473 parent);
2474 stream_pos = &cfs->pos;
2475 if (!stream_pos->packet_index)
2476 continue;
2477
2478 for (k = 0; k < stream_pos->packet_index->len; k++) {
2479 struct packet_index *index;
2480
2481 index = &g_array_index(stream_pos->packet_index,
2482 struct packet_index, k);
2483 index->ts_real.timestamp_begin =
2484 ctf_get_real_timestamp(stream,
2485 index->ts_cycles.timestamp_begin);
2486 index->ts_real.timestamp_end =
2487 ctf_get_real_timestamp(stream,
2488 index->ts_cycles.timestamp_end);
2489 }
2490 }
2491 }
2492 return 0;
2493 }
2494
2495 static
2496 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2497 {
2498 int ret;
2499
2500 ret = ctf_fini_pos(&file_stream->pos);
2501 if (ret) {
2502 fprintf(stderr, "Error on ctf_fini_pos\n");
2503 return -1;
2504 }
2505 if (file_stream->pos.fd >= 0) {
2506 ret = close(file_stream->pos.fd);
2507 if (ret) {
2508 perror("Error closing file fd");
2509 return -1;
2510 }
2511 }
2512 return 0;
2513 }
2514
2515 static
2516 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2517 {
2518 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2519 int ret;
2520
2521 if (td->streams) {
2522 int i;
2523
2524 for (i = 0; i < td->streams->len; i++) {
2525 struct ctf_stream_declaration *stream;
2526 int j;
2527
2528 stream = g_ptr_array_index(td->streams, i);
2529 if (!stream)
2530 continue;
2531 for (j = 0; j < stream->streams->len; j++) {
2532 struct ctf_file_stream *file_stream;
2533 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2534 struct ctf_file_stream, parent);
2535 ret = ctf_close_file_stream(file_stream);
2536 if (ret)
2537 return ret;
2538 }
2539 }
2540 }
2541 ctf_destroy_metadata(td);
2542 ctf_scanner_free(td->scanner);
2543 if (td->dirfd >= 0) {
2544 ret = close(td->dirfd);
2545 if (ret) {
2546 perror("Error closing dirfd");
2547 return ret;
2548 }
2549 }
2550 if (td->dir) {
2551 ret = closedir(td->dir);
2552 if (ret) {
2553 perror("Error closedir");
2554 return ret;
2555 }
2556 }
2557 free(td->metadata_string);
2558 g_free(td);
2559 return 0;
2560 }
2561
2562 static
2563 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2564 struct bt_context *ctx)
2565 {
2566 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2567 parent);
2568
2569 td->parent.ctx = ctx;
2570 }
2571
2572 static
2573 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2574 struct bt_trace_handle *handle)
2575 {
2576 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2577 parent);
2578
2579 td->parent.handle = handle;
2580 }
2581
2582 static
2583 void __attribute__((constructor)) ctf_init(void)
2584 {
2585 int ret;
2586
2587 ctf_format.name = g_quark_from_static_string("ctf");
2588 ret = bt_register_format(&ctf_format);
2589 assert(!ret);
2590 }
2591
2592 static
2593 void __attribute__((destructor)) ctf_exit(void)
2594 {
2595 bt_unregister_format(&ctf_format);
2596 }
This page took 0.092229 seconds and 3 git commands to generate.