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