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