Add missing permission notice in each source file
[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/uuid.h>
37 #include <babeltrace/endian.h>
38 #include <inttypes.h>
39 #include <stdio.h>
40 #include <sys/mman.h>
41 #include <errno.h>
42 #include <sys/types.h>
43 #include <sys/stat.h>
44 #include <fcntl.h>
45 #include <dirent.h>
46 #include <glib.h>
47 #include <unistd.h>
48 #include <stdlib.h>
49
50 #include "metadata/ctf-scanner.h"
51 #include "metadata/ctf-parser.h"
52 #include "metadata/ctf-ast.h"
53 #include "events-private.h"
54 #include "memstream.h"
55
56 /*
57 * We currently simply map a page to read the packet header and packet
58 * context to get the packet length and content length. (in bits)
59 */
60 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
61 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
62
63 #ifndef min
64 #define min(a, b) (((a) < (b)) ? (a) : (b))
65 #endif
66
67 #define NSEC_PER_SEC 1000000000ULL
68
69 int opt_clock_cycles,
70 opt_clock_seconds,
71 opt_clock_date,
72 opt_clock_gmt;
73
74 uint64_t opt_clock_offset;
75
76 extern int yydebug;
77
78 static
79 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
80 void (*packet_seek)(struct stream_pos *pos, size_t index,
81 int whence),
82 FILE *metadata_fp);
83 static
84 struct trace_descriptor *ctf_open_mmap_trace(
85 struct mmap_stream_list *mmap_list,
86 void (*packet_seek)(struct stream_pos *pos, size_t index,
87 int whence),
88 FILE *metadata_fp);
89 static
90 void ctf_set_context(struct trace_descriptor *descriptor,
91 struct bt_context *ctx);
92 static
93 void ctf_set_handle(struct trace_descriptor *descriptor,
94 struct bt_trace_handle *handle);
95
96 static
97 int ctf_close_trace(struct trace_descriptor *descriptor);
98 static
99 uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor,
100 struct bt_trace_handle *handle, enum bt_clock_type type);
101 static
102 uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor,
103 struct bt_trace_handle *handle, enum bt_clock_type type);
104 static
105 int ctf_convert_index_timestamp(struct trace_descriptor *tdp);
106
107 static
108 rw_dispatch read_dispatch_table[] = {
109 [ CTF_TYPE_INTEGER ] = ctf_integer_read,
110 [ CTF_TYPE_FLOAT ] = ctf_float_read,
111 [ CTF_TYPE_ENUM ] = ctf_enum_read,
112 [ CTF_TYPE_STRING ] = ctf_string_read,
113 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
114 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
115 [ CTF_TYPE_ARRAY ] = ctf_array_read,
116 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
117 };
118
119 static
120 rw_dispatch write_dispatch_table[] = {
121 [ CTF_TYPE_INTEGER ] = ctf_integer_write,
122 [ CTF_TYPE_FLOAT ] = ctf_float_write,
123 [ CTF_TYPE_ENUM ] = ctf_enum_write,
124 [ CTF_TYPE_STRING ] = ctf_string_write,
125 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
126 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
127 [ CTF_TYPE_ARRAY ] = ctf_array_write,
128 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
129 };
130
131 static
132 struct format ctf_format = {
133 .open_trace = ctf_open_trace,
134 .open_mmap_trace = ctf_open_mmap_trace,
135 .close_trace = ctf_close_trace,
136 .set_context = ctf_set_context,
137 .set_handle = ctf_set_handle,
138 .timestamp_begin = ctf_timestamp_begin,
139 .timestamp_end = ctf_timestamp_end,
140 .convert_index_timestamp = ctf_convert_index_timestamp,
141 };
142
143 static
144 uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor,
145 struct bt_trace_handle *handle, enum bt_clock_type type)
146 {
147 struct ctf_trace *tin;
148 uint64_t begin = ULLONG_MAX;
149 int i, j;
150
151 tin = container_of(descriptor, struct ctf_trace, parent);
152
153 if (!tin)
154 goto error;
155
156 /* for each stream_class */
157 for (i = 0; i < tin->streams->len; i++) {
158 struct ctf_stream_declaration *stream_class;
159
160 stream_class = g_ptr_array_index(tin->streams, i);
161 if (!stream_class)
162 continue;
163 /* for each file_stream */
164 for (j = 0; j < stream_class->streams->len; j++) {
165 struct ctf_stream_definition *stream;
166 struct ctf_file_stream *cfs;
167 struct ctf_stream_pos *stream_pos;
168 struct packet_index *index;
169
170 stream = g_ptr_array_index(stream_class->streams, j);
171 cfs = container_of(stream, struct ctf_file_stream,
172 parent);
173 stream_pos = &cfs->pos;
174
175 if (!stream_pos->packet_real_index)
176 goto error;
177
178 if (stream_pos->packet_real_index->len <= 0)
179 continue;
180
181 if (type == BT_CLOCK_REAL) {
182 index = &g_array_index(stream_pos->packet_real_index,
183 struct packet_index,
184 stream_pos->packet_real_index->len - 1);
185 } else if (type == BT_CLOCK_CYCLES) {
186 index = &g_array_index(stream_pos->packet_cycles_index,
187 struct packet_index,
188 stream_pos->packet_real_index->len - 1);
189
190 } else {
191 goto error;
192 }
193 if (index->timestamp_begin < begin)
194 begin = index->timestamp_begin;
195 }
196 }
197
198 return begin;
199
200 error:
201 return -1ULL;
202 }
203
204 static
205 uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor,
206 struct bt_trace_handle *handle, enum bt_clock_type type)
207 {
208 struct ctf_trace *tin;
209 uint64_t end = 0;
210 int i, j;
211
212 tin = container_of(descriptor, struct ctf_trace, parent);
213
214 if (!tin)
215 goto error;
216
217 /* for each stream_class */
218 for (i = 0; i < tin->streams->len; i++) {
219 struct ctf_stream_declaration *stream_class;
220
221 stream_class = g_ptr_array_index(tin->streams, i);
222 if (!stream_class)
223 continue;
224 /* for each file_stream */
225 for (j = 0; j < stream_class->streams->len; j++) {
226 struct ctf_stream_definition *stream;
227 struct ctf_file_stream *cfs;
228 struct ctf_stream_pos *stream_pos;
229 struct packet_index *index;
230
231 stream = g_ptr_array_index(stream_class->streams, j);
232 cfs = container_of(stream, struct ctf_file_stream,
233 parent);
234 stream_pos = &cfs->pos;
235
236 if (!stream_pos->packet_real_index)
237 goto error;
238
239 if (stream_pos->packet_real_index->len <= 0)
240 continue;
241
242 if (type == BT_CLOCK_REAL) {
243 index = &g_array_index(stream_pos->packet_real_index,
244 struct packet_index,
245 stream_pos->packet_real_index->len - 1);
246 } else if (type == BT_CLOCK_CYCLES) {
247 index = &g_array_index(stream_pos->packet_cycles_index,
248 struct packet_index,
249 stream_pos->packet_real_index->len - 1);
250
251 } else {
252 goto error;
253 }
254 if (index->timestamp_end > end)
255 end = index->timestamp_end;
256 }
257 }
258
259 return end;
260
261 error:
262 return -1ULL;
263 }
264
265 /*
266 * Update stream current timestamp
267 */
268 static
269 void ctf_update_timestamp(struct ctf_stream_definition *stream,
270 struct definition_integer *integer_definition)
271 {
272 struct declaration_integer *integer_declaration =
273 integer_definition->declaration;
274 uint64_t oldval, newval, updateval;
275
276 if (unlikely(integer_declaration->len == 64)) {
277 stream->prev_cycles_timestamp = stream->cycles_timestamp;
278 stream->cycles_timestamp = integer_definition->value._unsigned;
279 stream->prev_real_timestamp = ctf_get_real_timestamp(stream,
280 stream->prev_cycles_timestamp);
281 stream->real_timestamp = ctf_get_real_timestamp(stream,
282 stream->cycles_timestamp);
283 return;
284 }
285 /* keep low bits */
286 oldval = stream->cycles_timestamp;
287 oldval &= (1ULL << integer_declaration->len) - 1;
288 newval = integer_definition->value._unsigned;
289 /* Test for overflow by comparing low bits */
290 if (newval < oldval)
291 newval += 1ULL << integer_declaration->len;
292 /* updateval contains old high bits, and new low bits (sum) */
293 updateval = stream->cycles_timestamp;
294 updateval &= ~((1ULL << integer_declaration->len) - 1);
295 updateval += newval;
296 stream->prev_cycles_timestamp = stream->cycles_timestamp;
297 stream->cycles_timestamp = updateval;
298
299 /* convert to real timestamp */
300 stream->prev_real_timestamp = ctf_get_real_timestamp(stream,
301 stream->prev_cycles_timestamp);
302 stream->real_timestamp = ctf_get_real_timestamp(stream,
303 stream->cycles_timestamp);
304 }
305
306 /*
307 * Print timestamp, rescaling clock frequency to nanoseconds and
308 * applying offsets as needed (unix time).
309 */
310 void ctf_print_timestamp_real(FILE *fp,
311 struct ctf_stream_definition *stream,
312 uint64_t timestamp)
313 {
314 uint64_t ts_sec = 0, ts_nsec;
315
316 ts_nsec = timestamp;
317
318 /* Add command-line offset */
319 ts_sec += opt_clock_offset;
320
321 ts_sec += ts_nsec / NSEC_PER_SEC;
322 ts_nsec = ts_nsec % NSEC_PER_SEC;
323
324 if (!opt_clock_seconds) {
325 struct tm tm;
326 time_t time_s = (time_t) ts_sec;
327
328 if (!opt_clock_gmt) {
329 struct tm *res;
330
331 res = localtime_r(&time_s, &tm);
332 if (!res) {
333 fprintf(stderr, "[warning] Unable to get localtime.\n");
334 goto seconds;
335 }
336 } else {
337 struct tm *res;
338
339 res = gmtime_r(&time_s, &tm);
340 if (!res) {
341 fprintf(stderr, "[warning] Unable to get gmtime.\n");
342 goto seconds;
343 }
344 }
345 if (opt_clock_date) {
346 char timestr[26];
347 size_t res;
348
349 /* Print date and time */
350 res = strftime(timestr, sizeof(timestr),
351 "%F ", &tm);
352 if (!res) {
353 fprintf(stderr, "[warning] Unable to print ascii time.\n");
354 goto seconds;
355 }
356 fprintf(fp, "%s", timestr);
357 }
358 /* Print time in HH:MM:SS.ns */
359 fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
360 tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
361 goto end;
362 }
363 seconds:
364 fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
365 ts_sec, ts_nsec);
366
367 end:
368 return;
369 }
370
371 /*
372 * Print timestamp, in cycles
373 */
374 void ctf_print_timestamp_cycles(FILE *fp,
375 struct ctf_stream_definition *stream,
376 uint64_t timestamp)
377 {
378 fprintf(fp, "%020" PRIu64, timestamp);
379 }
380
381 void ctf_print_timestamp(FILE *fp,
382 struct ctf_stream_definition *stream,
383 uint64_t timestamp)
384 {
385 if (opt_clock_cycles) {
386 ctf_print_timestamp_cycles(fp, stream, timestamp);
387 } else {
388 ctf_print_timestamp_real(fp, stream, timestamp);
389 }
390 }
391
392 static
393 int ctf_read_event(struct stream_pos *ppos, struct ctf_stream_definition *stream)
394 {
395 struct ctf_stream_pos *pos =
396 container_of(ppos, struct ctf_stream_pos, parent);
397 struct ctf_stream_declaration *stream_class = stream->stream_class;
398 struct ctf_event_definition *event;
399 uint64_t id = 0;
400 int ret;
401
402 /* We need to check for EOF here for empty files. */
403 if (unlikely(pos->offset == EOF))
404 return EOF;
405
406 ctf_pos_get_event(pos);
407
408 /* save the current position as a restore point */
409 pos->last_offset = pos->offset;
410
411 /*
412 * This is the EOF check after we've advanced the position in
413 * ctf_pos_get_event.
414 */
415 if (unlikely(pos->offset == EOF))
416 return EOF;
417 assert(pos->offset < pos->content_size);
418
419 /* Read event header */
420 if (likely(stream->stream_event_header)) {
421 struct definition_integer *integer_definition;
422 struct definition *variant;
423
424 ret = generic_rw(ppos, &stream->stream_event_header->p);
425 if (unlikely(ret))
426 goto error;
427 /* lookup event id */
428 integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
429 if (integer_definition) {
430 id = integer_definition->value._unsigned;
431 } else {
432 struct definition_enum *enum_definition;
433
434 enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
435 if (enum_definition) {
436 id = enum_definition->integer->value._unsigned;
437 }
438 }
439
440 variant = lookup_variant(&stream->stream_event_header->p, "v");
441 if (variant) {
442 integer_definition = lookup_integer(variant, "id", FALSE);
443 if (integer_definition) {
444 id = integer_definition->value._unsigned;
445 }
446 }
447 stream->event_id = id;
448
449 /* lookup timestamp */
450 stream->has_timestamp = 0;
451 integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
452 if (integer_definition) {
453 ctf_update_timestamp(stream, integer_definition);
454 stream->has_timestamp = 1;
455 } else {
456 if (variant) {
457 integer_definition = lookup_integer(variant, "timestamp", FALSE);
458 if (integer_definition) {
459 ctf_update_timestamp(stream, integer_definition);
460 stream->has_timestamp = 1;
461 }
462 }
463 }
464 }
465
466 /* Read stream-declared event context */
467 if (stream->stream_event_context) {
468 ret = generic_rw(ppos, &stream->stream_event_context->p);
469 if (ret)
470 goto error;
471 }
472
473 if (unlikely(id >= stream_class->events_by_id->len)) {
474 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
475 return -EINVAL;
476 }
477 event = g_ptr_array_index(stream->events_by_id, id);
478 if (unlikely(!event)) {
479 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
480 return -EINVAL;
481 }
482
483 /* Read event-declared event context */
484 if (event->event_context) {
485 ret = generic_rw(ppos, &event->event_context->p);
486 if (ret)
487 goto error;
488 }
489
490 /* Read event payload */
491 if (likely(event->event_fields)) {
492 ret = generic_rw(ppos, &event->event_fields->p);
493 if (ret)
494 goto error;
495 }
496
497 return 0;
498
499 error:
500 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
501 return ret;
502 }
503
504 static
505 int ctf_write_event(struct stream_pos *pos, struct ctf_stream_definition *stream)
506 {
507 struct ctf_stream_declaration *stream_class = stream->stream_class;
508 struct ctf_event_definition *event;
509 uint64_t id;
510 int ret;
511
512 id = stream->event_id;
513
514 /* print event header */
515 if (likely(stream->stream_event_header)) {
516 ret = generic_rw(pos, &stream->stream_event_header->p);
517 if (ret)
518 goto error;
519 }
520
521 /* print stream-declared event context */
522 if (stream->stream_event_context) {
523 ret = generic_rw(pos, &stream->stream_event_context->p);
524 if (ret)
525 goto error;
526 }
527
528 if (unlikely(id >= stream_class->events_by_id->len)) {
529 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
530 return -EINVAL;
531 }
532 event = g_ptr_array_index(stream->events_by_id, id);
533 if (unlikely(!event)) {
534 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
535 return -EINVAL;
536 }
537
538 /* print event-declared event context */
539 if (event->event_context) {
540 ret = generic_rw(pos, &event->event_context->p);
541 if (ret)
542 goto error;
543 }
544
545 /* Read and print event payload */
546 if (likely(event->event_fields)) {
547 ret = generic_rw(pos, &event->event_fields->p);
548 if (ret)
549 goto error;
550 }
551
552 return 0;
553
554 error:
555 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
556 return ret;
557 }
558
559 int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
560 {
561 pos->fd = fd;
562 if (fd >= 0) {
563 pos->packet_cycles_index = g_array_new(FALSE, TRUE,
564 sizeof(struct packet_index));
565 pos->packet_real_index = g_array_new(FALSE, TRUE,
566 sizeof(struct packet_index));
567 } else {
568 pos->packet_cycles_index = NULL;
569 pos->packet_real_index = NULL;
570 }
571 switch (open_flags & O_ACCMODE) {
572 case O_RDONLY:
573 pos->prot = PROT_READ;
574 pos->flags = MAP_PRIVATE;
575 pos->parent.rw_table = read_dispatch_table;
576 pos->parent.event_cb = ctf_read_event;
577 break;
578 case O_RDWR:
579 pos->prot = PROT_WRITE; /* Write has priority */
580 pos->flags = MAP_SHARED;
581 pos->parent.rw_table = write_dispatch_table;
582 pos->parent.event_cb = ctf_write_event;
583 if (fd >= 0)
584 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
585 break;
586 default:
587 assert(0);
588 }
589 return 0;
590 }
591
592 int ctf_fini_pos(struct ctf_stream_pos *pos)
593 {
594 if (pos->prot == PROT_WRITE && pos->content_size_loc)
595 *pos->content_size_loc = pos->offset;
596 if (pos->base_mma) {
597 int ret;
598
599 /* unmap old base */
600 ret = munmap_align(pos->base_mma);
601 if (ret) {
602 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
603 strerror(errno));
604 return -1;
605 }
606 }
607 if (pos->packet_cycles_index)
608 (void) g_array_free(pos->packet_cycles_index, TRUE);
609 if (pos->packet_real_index)
610 (void) g_array_free(pos->packet_real_index, TRUE);
611 return 0;
612 }
613
614 /*
615 * for SEEK_CUR: go to next packet.
616 * for SEEK_POS: go to packet numer (index).
617 */
618 void ctf_packet_seek(struct stream_pos *stream_pos, size_t index, int whence)
619 {
620 struct ctf_stream_pos *pos =
621 container_of(stream_pos, struct ctf_stream_pos, parent);
622 struct ctf_file_stream *file_stream =
623 container_of(pos, struct ctf_file_stream, pos);
624 int ret;
625 off_t off;
626 struct packet_index *packet_index;
627
628 if (pos->prot == PROT_WRITE && pos->content_size_loc)
629 *pos->content_size_loc = pos->offset;
630
631 if (pos->base_mma) {
632 /* unmap old base */
633 ret = munmap_align(pos->base_mma);
634 if (ret) {
635 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
636 strerror(errno));
637 assert(0);
638 }
639 pos->base_mma = NULL;
640 }
641
642 /*
643 * The caller should never ask for ctf_move_pos across packets,
644 * except to get exactly at the beginning of the next packet.
645 */
646 if (pos->prot == PROT_WRITE) {
647 switch (whence) {
648 case SEEK_CUR:
649 /* The writer will add padding */
650 pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
651 break;
652 case SEEK_SET:
653 assert(index == 0); /* only seek supported for now */
654 pos->cur_index = 0;
655 break;
656 default:
657 assert(0);
658 }
659 pos->content_size = -1U; /* Unknown at this point */
660 pos->packet_size = WRITE_PACKET_LEN;
661 off = posix_fallocate(pos->fd, pos->mmap_offset,
662 pos->packet_size / CHAR_BIT);
663 assert(off >= 0);
664 pos->offset = 0;
665 } else {
666 read_next_packet:
667 switch (whence) {
668 case SEEK_CUR:
669 {
670 uint64_t events_discarded_diff;
671
672 if (pos->offset == EOF) {
673 return;
674 }
675 /* For printing discarded event count */
676 packet_index = &g_array_index(pos->packet_cycles_index,
677 struct packet_index, pos->cur_index);
678 file_stream->parent.prev_cycles_timestamp_end =
679 packet_index->timestamp_end;
680 file_stream->parent.prev_cycles_timestamp =
681 packet_index->timestamp_begin;
682
683 packet_index = &g_array_index(pos->packet_real_index,
684 struct packet_index, pos->cur_index);
685 file_stream->parent.prev_real_timestamp_end =
686 packet_index->timestamp_end;
687 file_stream->parent.prev_real_timestamp =
688 packet_index->timestamp_begin;
689
690 events_discarded_diff = packet_index->events_discarded;
691 if (pos->cur_index > 0) {
692 packet_index = &g_array_index(pos->packet_real_index,
693 struct packet_index,
694 pos->cur_index - 1);
695 events_discarded_diff -= packet_index->events_discarded;
696 /*
697 * Deal with 32-bit wrap-around if the
698 * tracer provided a 32-bit field.
699 */
700 if (packet_index->events_discarded_len == 32) {
701 events_discarded_diff = (uint32_t) events_discarded_diff;
702 }
703 }
704 file_stream->parent.events_discarded = events_discarded_diff;
705 file_stream->parent.prev_real_timestamp = file_stream->parent.real_timestamp;
706 file_stream->parent.prev_cycles_timestamp = file_stream->parent.cycles_timestamp;
707 /* The reader will expect us to skip padding */
708 ++pos->cur_index;
709 break;
710 }
711 case SEEK_SET:
712 packet_index = &g_array_index(pos->packet_cycles_index,
713 struct packet_index, index);
714 pos->last_events_discarded = packet_index->events_discarded;
715 pos->cur_index = index;
716 file_stream->parent.prev_real_timestamp = 0;
717 file_stream->parent.prev_real_timestamp_end = 0;
718 file_stream->parent.prev_cycles_timestamp = 0;
719 file_stream->parent.prev_cycles_timestamp_end = 0;
720 break;
721 default:
722 assert(0);
723 }
724 if (pos->cur_index >= pos->packet_real_index->len) {
725 /*
726 * When a stream reaches the end of the
727 * file, we need to show the number of
728 * events discarded ourselves, because
729 * there is no next event scheduled to
730 * be printed in the output.
731 */
732 if (file_stream->parent.events_discarded) {
733 /*
734 * We need to check if we are in trace
735 * read or called from packet indexing.
736 * In this last case, the collection is
737 * not there, so we cannot print the
738 * timestamps.
739 */
740 if ((&file_stream->parent)->stream_class->trace->collection) {
741 fflush(stdout);
742 fprintf(stderr, "[warning] Tracer discarded %" PRIu64 " events at end of stream between [",
743 file_stream->parent.events_discarded);
744 if (opt_clock_cycles) {
745 ctf_print_timestamp(stderr,
746 &file_stream->parent,
747 file_stream->parent.prev_cycles_timestamp);
748 fprintf(stderr, "] and [");
749 ctf_print_timestamp(stderr, &file_stream->parent,
750 file_stream->parent.prev_cycles_timestamp_end);
751 } else {
752 ctf_print_timestamp(stderr,
753 &file_stream->parent,
754 file_stream->parent.prev_real_timestamp);
755 fprintf(stderr, "] and [");
756 ctf_print_timestamp(stderr, &file_stream->parent,
757 file_stream->parent.prev_real_timestamp_end);
758 }
759 fprintf(stderr, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\n");
760 fflush(stderr);
761 }
762 file_stream->parent.events_discarded = 0;
763 }
764 pos->offset = EOF;
765 return;
766 }
767 packet_index = &g_array_index(pos->packet_cycles_index,
768 struct packet_index,
769 pos->cur_index);
770 file_stream->parent.cycles_timestamp = packet_index->timestamp_begin;
771
772 packet_index = &g_array_index(pos->packet_real_index,
773 struct packet_index,
774 pos->cur_index);
775 file_stream->parent.real_timestamp = packet_index->timestamp_begin;
776 pos->mmap_offset = packet_index->offset;
777
778 /* Lookup context/packet size in index */
779 pos->content_size = packet_index->content_size;
780 pos->packet_size = packet_index->packet_size;
781 if (packet_index->data_offset < packet_index->content_size) {
782 pos->offset = 0; /* will read headers */
783 } else if (packet_index->data_offset == packet_index->content_size) {
784 /* empty packet */
785 pos->offset = packet_index->data_offset;
786 whence = SEEK_CUR;
787 goto read_next_packet;
788 } else {
789 pos->offset = EOF;
790 return;
791 }
792 }
793 /* map new base. Need mapping length from header. */
794 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
795 pos->flags, pos->fd, pos->mmap_offset);
796 if (pos->base_mma == MAP_FAILED) {
797 fprintf(stderr, "[error] mmap error %s.\n",
798 strerror(errno));
799 assert(0);
800 }
801
802 /* update trace_packet_header and stream_packet_context */
803 if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) {
804 /* Read packet header */
805 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
806 assert(!ret);
807 }
808 if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) {
809 /* Read packet context */
810 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
811 assert(!ret);
812 }
813 }
814
815 static
816 int packet_metadata(struct ctf_trace *td, FILE *fp)
817 {
818 uint32_t magic;
819 size_t len;
820 int ret = 0;
821
822 len = fread(&magic, sizeof(magic), 1, fp);
823 if (len != 1) {
824 goto end;
825 }
826 if (magic == TSDL_MAGIC) {
827 ret = 1;
828 td->byte_order = BYTE_ORDER;
829 CTF_TRACE_SET_FIELD(td, byte_order);
830 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
831 ret = 1;
832 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
833 LITTLE_ENDIAN : BIG_ENDIAN;
834 CTF_TRACE_SET_FIELD(td, byte_order);
835 }
836 end:
837 rewind(fp);
838 return ret;
839 }
840
841 /*
842 * Returns 0 on success, -1 on error.
843 */
844 static
845 int check_version(unsigned int major, unsigned int minor)
846 {
847 switch (major) {
848 case 1:
849 switch (minor) {
850 case 8:
851 return 0;
852 default:
853 goto warning;
854 }
855 default:
856 goto warning;
857
858 }
859
860 /* eventually return an error instead of warning */
861 warning:
862 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
863 major, minor);
864 return 0;
865 }
866
867 static
868 int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
869 FILE *out)
870 {
871 struct metadata_packet_header header;
872 size_t readlen, writelen, toread;
873 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
874 int ret = 0;
875
876 readlen = fread(&header, header_sizeof(header), 1, in);
877 if (readlen < 1)
878 return -EINVAL;
879
880 if (td->byte_order != BYTE_ORDER) {
881 header.magic = GUINT32_SWAP_LE_BE(header.magic);
882 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
883 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
884 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
885 }
886 if (header.checksum)
887 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
888 if (header.compression_scheme) {
889 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
890 header.compression_scheme);
891 return -EINVAL;
892 }
893 if (header.encryption_scheme) {
894 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
895 header.encryption_scheme);
896 return -EINVAL;
897 }
898 if (header.checksum_scheme) {
899 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
900 header.checksum_scheme);
901 return -EINVAL;
902 }
903 if (check_version(header.major, header.minor) < 0)
904 return -EINVAL;
905 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
906 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
907 CTF_TRACE_SET_FIELD(td, uuid);
908 } else {
909 if (babeltrace_uuid_compare(header.uuid, td->uuid))
910 return -EINVAL;
911 }
912
913 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
914 return -EINVAL;
915
916 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
917
918 for (;;) {
919 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
920 if (ferror(in)) {
921 ret = -EINVAL;
922 break;
923 }
924 if (babeltrace_debug) {
925 buf[readlen] = '\0';
926 fprintf(stderr, "[debug] metadata packet read: %s\n",
927 buf);
928 }
929
930 writelen = fwrite(buf, sizeof(char), readlen, out);
931 if (writelen < readlen) {
932 ret = -EIO;
933 break;
934 }
935 if (ferror(out)) {
936 ret = -EINVAL;
937 break;
938 }
939 toread -= readlen;
940 if (!toread) {
941 ret = 0; /* continue reading next packet */
942 goto read_padding;
943 }
944 }
945 return ret;
946
947 read_padding:
948 toread = (header.packet_size - header.content_size) / CHAR_BIT;
949 ret = fseek(in, toread, SEEK_CUR);
950 if (ret < 0) {
951 fprintf(stderr, "[warning] Missing padding at end of file\n");
952 ret = 0;
953 }
954 return ret;
955 }
956
957 static
958 int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
959 char **buf)
960 {
961 FILE *in, *out;
962 size_t size;
963 int ret;
964
965 in = *fp;
966 /*
967 * Using strlen on *buf instead of size of open_memstream
968 * because its size includes garbage at the end (after final
969 * \0). This is the allocated size, not the actual string size.
970 */
971 out = babeltrace_open_memstream(buf, &size);
972 if (out == NULL) {
973 perror("Metadata open_memstream");
974 return -errno;
975 }
976 for (;;) {
977 ret = ctf_open_trace_metadata_packet_read(td, in, out);
978 if (ret) {
979 break;
980 }
981 if (feof(in)) {
982 ret = 0;
983 break;
984 }
985 }
986 /* close to flush the buffer */
987 ret = babeltrace_close_memstream(buf, &size, out);
988 if (ret < 0) {
989 int closeret;
990
991 perror("babeltrace_flush_memstream");
992 ret = -errno;
993 closeret = fclose(in);
994 if (closeret) {
995 perror("Error in fclose");
996 }
997 return ret;
998 }
999 ret = fclose(in);
1000 if (ret) {
1001 perror("Error in fclose");
1002 }
1003 /* open for reading */
1004 *fp = babeltrace_fmemopen(*buf, strlen(*buf), "rb");
1005 if (!*fp) {
1006 perror("Metadata fmemopen");
1007 return -errno;
1008 }
1009 return 0;
1010 }
1011
1012 static
1013 int ctf_open_trace_metadata_read(struct ctf_trace *td,
1014 void (*packet_seek)(struct stream_pos *pos, size_t index,
1015 int whence), FILE *metadata_fp)
1016 {
1017 struct ctf_scanner *scanner;
1018 struct ctf_file_stream *metadata_stream;
1019 FILE *fp;
1020 char *buf = NULL;
1021 int ret = 0, closeret;
1022
1023 metadata_stream = g_new0(struct ctf_file_stream, 1);
1024 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1025
1026 if (packet_seek) {
1027 metadata_stream->pos.packet_seek = packet_seek;
1028 } else {
1029 fprintf(stderr, "[error] packet_seek function undefined.\n");
1030 ret = -1;
1031 goto end_free;
1032 }
1033
1034 if (metadata_fp) {
1035 fp = metadata_fp;
1036 metadata_stream->pos.fd = -1;
1037 } else {
1038 td->metadata = &metadata_stream->parent;
1039 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1040 if (metadata_stream->pos.fd < 0) {
1041 fprintf(stderr, "Unable to open metadata.\n");
1042 ret = -1;
1043 goto end_free;
1044 }
1045
1046 fp = fdopen(metadata_stream->pos.fd, "r");
1047 if (!fp) {
1048 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1049 perror("Metadata stream open");
1050 ret = -errno;
1051 goto end_stream;
1052 }
1053 /* fd now belongs to fp */
1054 metadata_stream->pos.fd = -1;
1055 }
1056 if (babeltrace_debug)
1057 yydebug = 1;
1058
1059 if (packet_metadata(td, fp)) {
1060 ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf);
1061 if (ret)
1062 goto end_packet_read;
1063 } else {
1064 unsigned int major, minor;
1065 ssize_t nr_items;
1066
1067 td->byte_order = BYTE_ORDER;
1068
1069 /* Check text-only metadata header and version */
1070 nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor);
1071 if (nr_items < 2)
1072 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1073 if (check_version(major, minor) < 0) {
1074 ret = -EINVAL;
1075 goto end_packet_read;
1076 }
1077 rewind(fp);
1078 }
1079
1080 scanner = ctf_scanner_alloc(fp);
1081 if (!scanner) {
1082 fprintf(stderr, "[error] Error allocating scanner\n");
1083 ret = -ENOMEM;
1084 goto end_scanner_alloc;
1085 }
1086 ret = ctf_scanner_append_ast(scanner);
1087 if (ret) {
1088 fprintf(stderr, "[error] Error creating AST\n");
1089 goto end;
1090 }
1091
1092 if (babeltrace_debug) {
1093 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1094 if (ret) {
1095 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1096 goto end;
1097 }
1098 }
1099
1100 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1101 if (ret) {
1102 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1103 goto end;
1104 }
1105 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1106 td, td->byte_order);
1107 if (ret) {
1108 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1109 goto end;
1110 }
1111 end:
1112 ctf_scanner_free(scanner);
1113 end_scanner_alloc:
1114 end_packet_read:
1115 if (fp) {
1116 closeret = fclose(fp);
1117 if (closeret) {
1118 perror("Error on fclose");
1119 }
1120 }
1121 free(buf);
1122 end_stream:
1123 if (metadata_stream->pos.fd >= 0) {
1124 closeret = close(metadata_stream->pos.fd);
1125 if (closeret) {
1126 perror("Error on metadata stream fd close");
1127 }
1128 }
1129 end_free:
1130 if (ret)
1131 g_free(metadata_stream);
1132 return ret;
1133 }
1134
1135 static
1136 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1137 struct ctf_stream_definition *stream,
1138 struct ctf_event_declaration *event)
1139 {
1140 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1141
1142 if (event->context_decl) {
1143 struct definition *definition =
1144 event->context_decl->p.definition_new(&event->context_decl->p,
1145 stream->parent_def_scope, 0, 0, "event.context");
1146 if (!definition) {
1147 goto error;
1148 }
1149 stream_event->event_context = container_of(definition,
1150 struct definition_struct, p);
1151 stream->parent_def_scope = stream_event->event_context->p.scope;
1152 }
1153 if (event->fields_decl) {
1154 struct definition *definition =
1155 event->fields_decl->p.definition_new(&event->fields_decl->p,
1156 stream->parent_def_scope, 0, 0, "event.fields");
1157 if (!definition) {
1158 goto error;
1159 }
1160 stream_event->event_fields = container_of(definition,
1161 struct definition_struct, p);
1162 stream->parent_def_scope = stream_event->event_fields->p.scope;
1163 }
1164 stream_event->stream = stream;
1165 return stream_event;
1166
1167 error:
1168 if (stream_event->event_fields)
1169 definition_unref(&stream_event->event_fields->p);
1170 if (stream_event->event_context)
1171 definition_unref(&stream_event->event_context->p);
1172 return NULL;
1173 }
1174
1175 static
1176 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1177 {
1178 struct ctf_stream_declaration *stream_class;
1179 int ret;
1180 int i;
1181
1182 if (stream->stream_definitions_created)
1183 return 0;
1184
1185 stream_class = stream->stream_class;
1186
1187 if (stream_class->packet_context_decl) {
1188 struct definition *definition =
1189 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1190 stream->parent_def_scope, 0, 0, "stream.packet.context");
1191 if (!definition) {
1192 ret = -EINVAL;
1193 goto error;
1194 }
1195 stream->stream_packet_context = container_of(definition,
1196 struct definition_struct, p);
1197 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1198 }
1199 if (stream_class->event_header_decl) {
1200 struct definition *definition =
1201 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1202 stream->parent_def_scope, 0, 0, "stream.event.header");
1203 if (!definition) {
1204 ret = -EINVAL;
1205 goto error;
1206 }
1207 stream->stream_event_header =
1208 container_of(definition, struct definition_struct, p);
1209 stream->parent_def_scope = stream->stream_event_header->p.scope;
1210 }
1211 if (stream_class->event_context_decl) {
1212 struct definition *definition =
1213 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1214 stream->parent_def_scope, 0, 0, "stream.event.context");
1215 if (!definition) {
1216 ret = -EINVAL;
1217 goto error;
1218 }
1219 stream->stream_event_context =
1220 container_of(definition, struct definition_struct, p);
1221 stream->parent_def_scope = stream->stream_event_context->p.scope;
1222 }
1223 stream->events_by_id = g_ptr_array_new();
1224 g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len);
1225 for (i = 0; i < stream->events_by_id->len; i++) {
1226 struct ctf_event_declaration *event = g_ptr_array_index(stream_class->events_by_id, i);
1227 struct ctf_event_definition *stream_event;
1228
1229 if (!event)
1230 continue;
1231 stream_event = create_event_definitions(td, stream, event);
1232 if (!stream_event)
1233 goto error_event;
1234 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1235 }
1236 return 0;
1237
1238 error_event:
1239 for (i = 0; i < stream->events_by_id->len; i++) {
1240 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1241 if (stream_event)
1242 g_free(stream_event);
1243 }
1244 g_ptr_array_free(stream->events_by_id, TRUE);
1245 error:
1246 if (stream->stream_event_context)
1247 definition_unref(&stream->stream_event_context->p);
1248 if (stream->stream_event_header)
1249 definition_unref(&stream->stream_event_header->p);
1250 if (stream->stream_packet_context)
1251 definition_unref(&stream->stream_packet_context->p);
1252 return ret;
1253 }
1254
1255
1256 static
1257 int create_stream_packet_index(struct ctf_trace *td,
1258 struct ctf_file_stream *file_stream)
1259 {
1260 struct ctf_stream_declaration *stream;
1261 int len_index;
1262 struct ctf_stream_pos *pos;
1263 struct stat filestats;
1264 struct packet_index packet_index;
1265 int first_packet = 1;
1266 int ret;
1267
1268 pos = &file_stream->pos;
1269
1270 ret = fstat(pos->fd, &filestats);
1271 if (ret < 0)
1272 return ret;
1273
1274 if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT)
1275 return -EINVAL;
1276
1277 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1278 uint64_t stream_id = 0;
1279
1280 if (pos->base_mma) {
1281 /* unmap old base */
1282 ret = munmap_align(pos->base_mma);
1283 if (ret) {
1284 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1285 strerror(errno));
1286 return ret;
1287 }
1288 pos->base_mma = NULL;
1289 }
1290 /* map new base. Need mapping length from header. */
1291 pos->base_mma = mmap_align(MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
1292 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1293 assert(pos->base_mma != MAP_FAILED);
1294 pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
1295 pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
1296 pos->offset = 0; /* Position of the packet header */
1297
1298 packet_index.offset = pos->mmap_offset;
1299 packet_index.content_size = 0;
1300 packet_index.packet_size = 0;
1301 packet_index.timestamp_begin = 0;
1302 packet_index.timestamp_end = 0;
1303 packet_index.events_discarded = 0;
1304 packet_index.events_discarded_len = 0;
1305
1306 /* read and check header, set stream id (and check) */
1307 if (file_stream->parent.trace_packet_header) {
1308 /* Read packet header */
1309 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1310 if (ret)
1311 return ret;
1312 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1313 if (len_index >= 0) {
1314 struct definition *field;
1315 uint64_t magic;
1316
1317 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1318 magic = get_unsigned_int(field);
1319 if (magic != CTF_MAGIC) {
1320 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1321 magic,
1322 file_stream->pos.packet_cycles_index->len,
1323 (ssize_t) pos->mmap_offset);
1324 return -EINVAL;
1325 }
1326 }
1327
1328 /* check uuid */
1329 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1330 if (len_index >= 0) {
1331 struct definition_array *defarray;
1332 struct definition *field;
1333 uint64_t i;
1334 uint8_t uuidval[BABELTRACE_UUID_LEN];
1335
1336 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1337 assert(field->declaration->id == CTF_TYPE_ARRAY);
1338 defarray = container_of(field, struct definition_array, p);
1339 assert(array_len(defarray) == BABELTRACE_UUID_LEN);
1340
1341 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1342 struct definition *elem;
1343
1344 elem = array_index(defarray, i);
1345 uuidval[i] = get_unsigned_int(elem);
1346 }
1347 ret = babeltrace_uuid_compare(td->uuid, uuidval);
1348 if (ret) {
1349 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1350 return -EINVAL;
1351 }
1352 }
1353
1354
1355 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1356 if (len_index >= 0) {
1357 struct definition *field;
1358
1359 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1360 stream_id = get_unsigned_int(field);
1361 }
1362 }
1363
1364 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1365 fprintf(stderr, "[error] Stream ID is changing within a stream.\n");
1366 return -EINVAL;
1367 }
1368 if (first_packet) {
1369 file_stream->parent.stream_id = stream_id;
1370 if (stream_id >= td->streams->len) {
1371 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1372 return -EINVAL;
1373 }
1374 stream = g_ptr_array_index(td->streams, stream_id);
1375 if (!stream) {
1376 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1377 return -EINVAL;
1378 }
1379 file_stream->parent.stream_class = stream;
1380 ret = create_stream_definitions(td, &file_stream->parent);
1381 if (ret)
1382 return ret;
1383 }
1384 first_packet = 0;
1385
1386 if (file_stream->parent.stream_packet_context) {
1387 /* Read packet context */
1388 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1389 if (ret)
1390 return ret;
1391 /* read content size from header */
1392 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1393 if (len_index >= 0) {
1394 struct definition *field;
1395
1396 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1397 packet_index.content_size = get_unsigned_int(field);
1398 } else {
1399 /* Use file size for packet size */
1400 packet_index.content_size = filestats.st_size * CHAR_BIT;
1401 }
1402
1403 /* read packet size from header */
1404 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1405 if (len_index >= 0) {
1406 struct definition *field;
1407
1408 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1409 packet_index.packet_size = get_unsigned_int(field);
1410 } else {
1411 /* Use content size if non-zero, else file size */
1412 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1413 }
1414
1415 /* read timestamp begin from header */
1416 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1417 if (len_index >= 0) {
1418 struct definition *field;
1419
1420 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1421 packet_index.timestamp_begin = get_unsigned_int(field);
1422 if (file_stream->parent.stream_class->trace->collection) {
1423 packet_index.timestamp_begin =
1424 ctf_get_real_timestamp(
1425 &file_stream->parent,
1426 packet_index.timestamp_begin);
1427 }
1428 }
1429
1430 /* read timestamp end from header */
1431 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1432 if (len_index >= 0) {
1433 struct definition *field;
1434
1435 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1436 packet_index.timestamp_end = get_unsigned_int(field);
1437 if (file_stream->parent.stream_class->trace->collection) {
1438 packet_index.timestamp_end =
1439 ctf_get_real_timestamp(
1440 &file_stream->parent,
1441 packet_index.timestamp_end);
1442 }
1443 }
1444
1445 /* read events discarded from header */
1446 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1447 if (len_index >= 0) {
1448 struct definition *field;
1449
1450 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1451 packet_index.events_discarded = get_unsigned_int(field);
1452 packet_index.events_discarded_len = get_int_len(field);
1453 }
1454 } else {
1455 /* Use file size for packet size */
1456 packet_index.content_size = filestats.st_size * CHAR_BIT;
1457 /* Use content size if non-zero, else file size */
1458 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1459 }
1460
1461 /* Validate content size and packet size values */
1462 if (packet_index.content_size > packet_index.packet_size) {
1463 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1464 packet_index.content_size, packet_index.packet_size);
1465 return -EINVAL;
1466 }
1467
1468 if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) {
1469 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1470 packet_index.packet_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT);
1471 return -EINVAL;
1472 }
1473
1474 /* Save position after header and context */
1475 packet_index.data_offset = pos->offset;
1476
1477 /* add index to packet array */
1478 g_array_append_val(file_stream->pos.packet_cycles_index, packet_index);
1479
1480 pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
1481 }
1482
1483 return 0;
1484 }
1485
1486 static
1487 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1488 {
1489 int ret;
1490
1491 if (td->packet_header_decl) {
1492 struct definition *definition =
1493 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1494 stream->parent_def_scope, 0, 0, "trace.packet.header");
1495 if (!definition) {
1496 ret = -EINVAL;
1497 goto error;
1498 }
1499 stream->trace_packet_header =
1500 container_of(definition, struct definition_struct, p);
1501 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1502 }
1503
1504 return 0;
1505
1506 error:
1507 return ret;
1508 }
1509
1510 /*
1511 * Note: many file streams can inherit from the same stream class
1512 * description (metadata).
1513 */
1514 static
1515 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1516 void (*packet_seek)(struct stream_pos *pos, size_t index,
1517 int whence))
1518 {
1519 int ret, fd, closeret;
1520 struct ctf_file_stream *file_stream;
1521 struct stat statbuf;
1522
1523 fd = openat(td->dirfd, path, flags);
1524 if (fd < 0) {
1525 perror("File stream openat()");
1526 ret = fd;
1527 goto error;
1528 }
1529
1530 /* Don't try to mmap subdirectories. Skip them, return success. */
1531 ret = fstat(fd, &statbuf);
1532 if (ret) {
1533 perror("File stream fstat()");
1534 goto fstat_error;
1535 }
1536 if (S_ISDIR(statbuf.st_mode)) {
1537 fprintf(stderr, "[warning] Skipping directory '%s' found in trace\n", path);
1538 ret = 0;
1539 goto fd_is_dir_ok;
1540 }
1541
1542 file_stream = g_new0(struct ctf_file_stream, 1);
1543 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1544
1545 if (packet_seek) {
1546 file_stream->pos.packet_seek = packet_seek;
1547 } else {
1548 fprintf(stderr, "[error] packet_seek function undefined.\n");
1549 ret = -1;
1550 goto error_def;
1551 }
1552
1553 ret = ctf_init_pos(&file_stream->pos, fd, flags);
1554 if (ret)
1555 goto error_def;
1556 ret = create_trace_definitions(td, &file_stream->parent);
1557 if (ret)
1558 goto error_def;
1559 /*
1560 * For now, only a single clock per trace is supported.
1561 */
1562 file_stream->parent.current_clock = td->single_clock;
1563 ret = create_stream_packet_index(td, file_stream);
1564 if (ret)
1565 goto error_index;
1566 /* Add stream file to stream class */
1567 g_ptr_array_add(file_stream->parent.stream_class->streams,
1568 &file_stream->parent);
1569 return 0;
1570
1571 error_index:
1572 if (file_stream->parent.trace_packet_header)
1573 definition_unref(&file_stream->parent.trace_packet_header->p);
1574 error_def:
1575 closeret = ctf_fini_pos(&file_stream->pos);
1576 if (closeret) {
1577 fprintf(stderr, "Error on ctf_fini_pos\n");
1578 }
1579 g_free(file_stream);
1580 fd_is_dir_ok:
1581 fstat_error:
1582 closeret = close(fd);
1583 if (closeret) {
1584 perror("Error on fd close");
1585 }
1586 error:
1587 return ret;
1588 }
1589
1590 static
1591 int ctf_open_trace_read(struct ctf_trace *td,
1592 const char *path, int flags,
1593 void (*packet_seek)(struct stream_pos *pos, size_t index,
1594 int whence), FILE *metadata_fp)
1595 {
1596 int ret, closeret;
1597 struct dirent *dirent;
1598 struct dirent *diriter;
1599 size_t dirent_len;
1600
1601 td->flags = flags;
1602
1603 /* Open trace directory */
1604 td->dir = opendir(path);
1605 if (!td->dir) {
1606 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
1607 ret = -ENOENT;
1608 goto error;
1609 }
1610
1611 td->dirfd = open(path, 0);
1612 if (td->dirfd < 0) {
1613 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
1614 perror("Trace directory open");
1615 ret = -errno;
1616 goto error_dirfd;
1617 }
1618 strncpy(td->path, path, sizeof(td->path));
1619 td->path[sizeof(td->path) - 1] = '\0';
1620
1621 /*
1622 * Keep the metadata file separate.
1623 */
1624
1625 ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp);
1626 if (ret) {
1627 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
1628 goto error_metadata;
1629 }
1630
1631 /*
1632 * Open each stream: for each file, try to open, check magic
1633 * number, and get the stream ID to add to the right location in
1634 * the stream array.
1635 */
1636
1637 dirent_len = offsetof(struct dirent, d_name) +
1638 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
1639
1640 dirent = malloc(dirent_len);
1641
1642 for (;;) {
1643 ret = readdir_r(td->dir, dirent, &diriter);
1644 if (ret) {
1645 fprintf(stderr, "[error] Readdir error.\n");
1646 goto readdir_error;
1647 }
1648 if (!diriter)
1649 break;
1650 /* Ignore hidden files, ., .. and metadata. */
1651 if (!strncmp(diriter->d_name, ".", 1)
1652 || !strcmp(diriter->d_name, "..")
1653 || !strcmp(diriter->d_name, "metadata"))
1654 continue;
1655 ret = ctf_open_file_stream_read(td, diriter->d_name,
1656 flags, packet_seek);
1657 if (ret) {
1658 fprintf(stderr, "[error] Open file stream error.\n");
1659 goto readdir_error;
1660 }
1661 }
1662
1663 free(dirent);
1664 return 0;
1665
1666 readdir_error:
1667 free(dirent);
1668 error_metadata:
1669 closeret = close(td->dirfd);
1670 if (closeret) {
1671 perror("Error on fd close");
1672 }
1673 error_dirfd:
1674 closeret = closedir(td->dir);
1675 if (closeret) {
1676 perror("Error on closedir");
1677 }
1678 error:
1679 return ret;
1680 }
1681
1682 /*
1683 * ctf_open_trace: Open a CTF trace and index it.
1684 * Note that the user must seek the trace after the open (using the iterator)
1685 * since the index creation read it entirely.
1686 */
1687 static
1688 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
1689 void (*packet_seek)(struct stream_pos *pos, size_t index,
1690 int whence), FILE *metadata_fp)
1691 {
1692 struct ctf_trace *td;
1693 int ret;
1694
1695 /*
1696 * If packet_seek is NULL, we provide our default version.
1697 */
1698 if (!packet_seek)
1699 packet_seek = ctf_packet_seek;
1700
1701 td = g_new0(struct ctf_trace, 1);
1702
1703 switch (flags & O_ACCMODE) {
1704 case O_RDONLY:
1705 if (!path) {
1706 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
1707 goto error;
1708 }
1709 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
1710 if (ret)
1711 goto error;
1712 break;
1713 case O_RDWR:
1714 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
1715 goto error;
1716 default:
1717 fprintf(stderr, "[error] Incorrect open flags.\n");
1718 goto error;
1719 }
1720
1721 return &td->parent;
1722 error:
1723 g_free(td);
1724 return NULL;
1725 }
1726
1727
1728 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
1729 struct mmap_stream *mmap_info)
1730 {
1731 pos->mmap_offset = 0;
1732 pos->packet_size = 0;
1733 pos->content_size = 0;
1734 pos->content_size_loc = NULL;
1735 pos->fd = mmap_info->fd;
1736 pos->base_mma = NULL;
1737 pos->offset = 0;
1738 pos->dummy = false;
1739 pos->cur_index = 0;
1740 pos->packet_cycles_index = NULL;
1741 pos->packet_real_index = NULL;
1742 pos->prot = PROT_READ;
1743 pos->flags = MAP_PRIVATE;
1744 pos->parent.rw_table = read_dispatch_table;
1745 pos->parent.event_cb = ctf_read_event;
1746 }
1747
1748 static
1749 int prepare_mmap_stream_definition(struct ctf_trace *td,
1750 struct ctf_file_stream *file_stream)
1751 {
1752 struct ctf_stream_declaration *stream;
1753 uint64_t stream_id = 0;
1754 int ret;
1755
1756 file_stream->parent.stream_id = stream_id;
1757 if (stream_id >= td->streams->len) {
1758 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
1759 "in metadata.\n", stream_id);
1760 ret = -EINVAL;
1761 goto end;
1762 }
1763 stream = g_ptr_array_index(td->streams, stream_id);
1764 if (!stream) {
1765 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
1766 "in metadata.\n", stream_id);
1767 ret = -EINVAL;
1768 goto end;
1769 }
1770 file_stream->parent.stream_class = stream;
1771 ret = create_stream_definitions(td, &file_stream->parent);
1772 end:
1773 return ret;
1774 }
1775
1776 static
1777 int ctf_open_mmap_stream_read(struct ctf_trace *td,
1778 struct mmap_stream *mmap_info,
1779 void (*packet_seek)(struct stream_pos *pos, size_t index,
1780 int whence))
1781 {
1782 int ret;
1783 struct ctf_file_stream *file_stream;
1784
1785 file_stream = g_new0(struct ctf_file_stream, 1);
1786 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1787 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
1788
1789 file_stream->pos.packet_seek = packet_seek;
1790
1791 ret = create_trace_definitions(td, &file_stream->parent);
1792 if (ret) {
1793 goto error_def;
1794 }
1795
1796 ret = prepare_mmap_stream_definition(td, file_stream);
1797 if (ret)
1798 goto error_index;
1799
1800 /*
1801 * For now, only a single clock per trace is supported.
1802 */
1803 file_stream->parent.current_clock = td->single_clock;
1804
1805 /* Add stream file to stream class */
1806 g_ptr_array_add(file_stream->parent.stream_class->streams,
1807 &file_stream->parent);
1808 return 0;
1809
1810 error_index:
1811 if (file_stream->parent.trace_packet_header)
1812 definition_unref(&file_stream->parent.trace_packet_header->p);
1813 error_def:
1814 g_free(file_stream);
1815 return ret;
1816 }
1817
1818 int ctf_open_mmap_trace_read(struct ctf_trace *td,
1819 struct mmap_stream_list *mmap_list,
1820 void (*packet_seek)(struct stream_pos *pos, size_t index,
1821 int whence),
1822 FILE *metadata_fp)
1823 {
1824 int ret;
1825 struct mmap_stream *mmap_info;
1826
1827 ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp);
1828 if (ret) {
1829 goto error;
1830 }
1831
1832 /*
1833 * for each stream, try to open, check magic number, and get the
1834 * stream ID to add to the right location in the stream array.
1835 */
1836 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
1837 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
1838 if (ret) {
1839 fprintf(stderr, "[error] Open file mmap stream error.\n");
1840 goto error;
1841 }
1842 }
1843
1844 return 0;
1845
1846 error:
1847 return ret;
1848 }
1849
1850 static
1851 struct trace_descriptor *ctf_open_mmap_trace(
1852 struct mmap_stream_list *mmap_list,
1853 void (*packet_seek)(struct stream_pos *pos, size_t index,
1854 int whence),
1855 FILE *metadata_fp)
1856 {
1857 struct ctf_trace *td;
1858 int ret;
1859
1860 if (!metadata_fp) {
1861 fprintf(stderr, "[error] No metadata file pointer associated, "
1862 "required for mmap parsing\n");
1863 goto error;
1864 }
1865 if (!packet_seek) {
1866 fprintf(stderr, "[error] packet_seek function undefined.\n");
1867 goto error;
1868 }
1869 td = g_new0(struct ctf_trace, 1);
1870 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
1871 if (ret)
1872 goto error_free;
1873
1874 return &td->parent;
1875
1876 error_free:
1877 g_free(td);
1878 error:
1879 return NULL;
1880 }
1881
1882 static
1883 int ctf_convert_index_timestamp(struct trace_descriptor *tdp)
1884 {
1885 int i, j, k;
1886 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
1887
1888 /* for each stream_class */
1889 for (i = 0; i < td->streams->len; i++) {
1890 struct ctf_stream_declaration *stream_class;
1891
1892 stream_class = g_ptr_array_index(td->streams, i);
1893 if (!stream_class)
1894 continue;
1895 /* for each file_stream */
1896 for (j = 0; j < stream_class->streams->len; j++) {
1897 struct ctf_stream_definition *stream;
1898 struct ctf_stream_pos *stream_pos;
1899 struct ctf_file_stream *cfs;
1900
1901 stream = g_ptr_array_index(stream_class->streams, j);
1902 if (!stream)
1903 continue;
1904 cfs = container_of(stream, struct ctf_file_stream,
1905 parent);
1906 stream_pos = &cfs->pos;
1907 if (!stream_pos->packet_cycles_index)
1908 continue;
1909
1910 for (k = 0; k < stream_pos->packet_cycles_index->len; k++) {
1911 struct packet_index *index;
1912 struct packet_index new_index;
1913
1914 index = &g_array_index(stream_pos->packet_cycles_index,
1915 struct packet_index, k);
1916 memcpy(&new_index, index,
1917 sizeof(struct packet_index));
1918 new_index.timestamp_begin =
1919 ctf_get_real_timestamp(stream,
1920 index->timestamp_begin);
1921 new_index.timestamp_end =
1922 ctf_get_real_timestamp(stream,
1923 index->timestamp_end);
1924 g_array_append_val(stream_pos->packet_real_index,
1925 new_index);
1926 }
1927 }
1928 }
1929 return 0;
1930 }
1931
1932 static
1933 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
1934 {
1935 int ret;
1936
1937 ret = ctf_fini_pos(&file_stream->pos);
1938 if (ret) {
1939 fprintf(stderr, "Error on ctf_fini_pos\n");
1940 return -1;
1941 }
1942 ret = close(file_stream->pos.fd);
1943 if (ret) {
1944 perror("Error closing file fd");
1945 return -1;
1946 }
1947 return 0;
1948 }
1949
1950 static
1951 int ctf_close_trace(struct trace_descriptor *tdp)
1952 {
1953 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
1954 int ret;
1955
1956 if (td->streams) {
1957 int i;
1958
1959 for (i = 0; i < td->streams->len; i++) {
1960 struct ctf_stream_declaration *stream;
1961 int j;
1962
1963 stream = g_ptr_array_index(td->streams, i);
1964 if (!stream)
1965 continue;
1966 for (j = 0; j < stream->streams->len; j++) {
1967 struct ctf_file_stream *file_stream;
1968 file_stream = container_of(g_ptr_array_index(stream->streams, j),
1969 struct ctf_file_stream, parent);
1970 ret = ctf_close_file_stream(file_stream);
1971 if (ret)
1972 return ret;
1973 }
1974 }
1975 }
1976 ctf_destroy_metadata(td);
1977 ret = close(td->dirfd);
1978 if (ret) {
1979 perror("Error closing dirfd");
1980 return ret;
1981 }
1982 ret = closedir(td->dir);
1983 if (ret) {
1984 perror("Error closedir");
1985 return ret;
1986 }
1987 g_free(td);
1988 return 0;
1989 }
1990
1991 static
1992 void ctf_set_context(struct trace_descriptor *descriptor,
1993 struct bt_context *ctx)
1994 {
1995 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
1996 parent);
1997
1998 td->ctx = ctx;
1999 }
2000
2001 static
2002 void ctf_set_handle(struct trace_descriptor *descriptor,
2003 struct bt_trace_handle *handle)
2004 {
2005 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2006 parent);
2007
2008 td->handle = handle;
2009 }
2010
2011 static
2012 void __attribute__((constructor)) ctf_init(void)
2013 {
2014 int ret;
2015
2016 ctf_format.name = g_quark_from_static_string("ctf");
2017 ret = bt_register_format(&ctf_format);
2018 assert(!ret);
2019 }
2020
2021 static
2022 void __attribute__((destructor)) ctf_exit(void)
2023 {
2024 bt_unregister_format(&ctf_format);
2025 }
This page took 0.123586 seconds and 4 git commands to generate.