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