865e2c2e0e8e21ebddcce42c55db55f497e182c9
[babeltrace.git] / formats / ctf / ctf.c
1 /*
2 * BabelTrace - Common Trace Format (CTF)
3 *
4 * Format registration.
5 *
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29 #include <babeltrace/format.h>
30 #include <babeltrace/ctf/types.h>
31 #include <babeltrace/ctf/metadata.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/ctf/events-internal.h>
34 #include <babeltrace/trace-handle-internal.h>
35 #include <babeltrace/context-internal.h>
36 #include <babeltrace/compat/uuid.h>
37 #include <babeltrace/endian.h>
38 #include <babeltrace/ctf/ctf-index.h>
39 #include <inttypes.h>
40 #include <stdio.h>
41 #include <sys/mman.h>
42 #include <errno.h>
43 #include <sys/types.h>
44 #include <sys/stat.h>
45 #include <fcntl.h>
46 #include <dirent.h>
47 #include <glib.h>
48 #include <unistd.h>
49 #include <stdlib.h>
50
51 #include "metadata/ctf-scanner.h"
52 #include "metadata/ctf-parser.h"
53 #include "metadata/ctf-ast.h"
54 #include "events-private.h"
55 #include <babeltrace/compat/memstream.h>
56
57 #define LOG2_CHAR_BIT 3
58
59 /*
60 * Length of first attempt at mapping a packet header, in bits.
61 */
62 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
63
64 /*
65 * Lenght of packet to write, in bits.
66 */
67 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
68
69 #ifndef min
70 #define min(a, b) (((a) < (b)) ? (a) : (b))
71 #endif
72
73 #define NSEC_PER_SEC 1000000000ULL
74
75 #define INDEX_PATH "./index/%s.idx"
76
77 int opt_clock_cycles,
78 opt_clock_seconds,
79 opt_clock_date,
80 opt_clock_gmt;
81
82 uint64_t opt_clock_offset;
83 uint64_t opt_clock_offset_ns;
84
85 extern int yydebug;
86
87 /*
88 * TODO: babeltrace_ctf_console_output ensures that we only print
89 * discarded events when ctf-text plugin is used. Should be cleaned up
90 * with the plugin system redesign.
91 */
92 int babeltrace_ctf_console_output;
93
94 static
95 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
96 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
97 int whence),
98 FILE *metadata_fp);
99 static
100 struct bt_trace_descriptor *ctf_open_mmap_trace(
101 struct bt_mmap_stream_list *mmap_list,
102 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
103 int whence),
104 FILE *metadata_fp);
105 static
106 void ctf_set_context(struct bt_trace_descriptor *descriptor,
107 struct bt_context *ctx);
108 static
109 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
110 struct bt_trace_handle *handle);
111
112 static
113 int ctf_close_trace(struct bt_trace_descriptor *descriptor);
114 static
115 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor,
116 struct bt_trace_handle *handle, enum bt_clock_type type);
117 static
118 uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor,
119 struct bt_trace_handle *handle, enum bt_clock_type type);
120 static
121 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp);
122
123 static
124 rw_dispatch read_dispatch_table[] = {
125 [ CTF_TYPE_INTEGER ] = ctf_integer_read,
126 [ CTF_TYPE_FLOAT ] = ctf_float_read,
127 [ CTF_TYPE_ENUM ] = ctf_enum_read,
128 [ CTF_TYPE_STRING ] = ctf_string_read,
129 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
130 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
131 [ CTF_TYPE_ARRAY ] = ctf_array_read,
132 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
133 };
134
135 static
136 rw_dispatch write_dispatch_table[] = {
137 [ CTF_TYPE_INTEGER ] = ctf_integer_write,
138 [ CTF_TYPE_FLOAT ] = ctf_float_write,
139 [ CTF_TYPE_ENUM ] = ctf_enum_write,
140 [ CTF_TYPE_STRING ] = ctf_string_write,
141 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
142 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
143 [ CTF_TYPE_ARRAY ] = ctf_array_write,
144 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
145 };
146
147 static
148 struct bt_format ctf_format = {
149 .open_trace = ctf_open_trace,
150 .open_mmap_trace = ctf_open_mmap_trace,
151 .close_trace = ctf_close_trace,
152 .set_context = ctf_set_context,
153 .set_handle = ctf_set_handle,
154 .timestamp_begin = ctf_timestamp_begin,
155 .timestamp_end = ctf_timestamp_end,
156 .convert_index_timestamp = ctf_convert_index_timestamp,
157 };
158
159 static
160 uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor,
161 struct bt_trace_handle *handle, enum bt_clock_type type)
162 {
163 struct ctf_trace *tin;
164 uint64_t begin = ULLONG_MAX;
165 int i, j;
166
167 tin = container_of(descriptor, struct ctf_trace, parent);
168
169 if (!tin)
170 goto error;
171
172 /* for each stream_class */
173 for (i = 0; i < tin->streams->len; i++) {
174 struct ctf_stream_declaration *stream_class;
175
176 stream_class = g_ptr_array_index(tin->streams, i);
177 if (!stream_class)
178 continue;
179 /* for each file_stream */
180 for (j = 0; j < stream_class->streams->len; j++) {
181 struct ctf_stream_definition *stream;
182 struct ctf_file_stream *cfs;
183 struct ctf_stream_pos *stream_pos;
184 struct packet_index *index;
185
186 stream = g_ptr_array_index(stream_class->streams, j);
187 cfs = container_of(stream, struct ctf_file_stream,
188 parent);
189 stream_pos = &cfs->pos;
190
191 if (!stream_pos->packet_index)
192 goto error;
193
194 if (stream_pos->packet_index->len <= 0)
195 continue;
196
197 index = &g_array_index(stream_pos->packet_index,
198 struct packet_index,
199 stream_pos->packet_index->len - 1);
200 if (type == BT_CLOCK_REAL) {
201 if (index->ts_real.timestamp_begin < begin)
202 begin = index->ts_real.timestamp_begin;
203 } else if (type == BT_CLOCK_CYCLES) {
204 if (index->ts_cycles.timestamp_begin < begin)
205 begin = index->ts_cycles.timestamp_begin;
206 } else {
207 goto error;
208 }
209 }
210 }
211
212 return begin;
213
214 error:
215 return -1ULL;
216 }
217
218 static
219 uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor,
220 struct bt_trace_handle *handle, enum bt_clock_type type)
221 {
222 struct ctf_trace *tin;
223 uint64_t end = 0;
224 int i, j;
225
226 tin = container_of(descriptor, struct ctf_trace, parent);
227
228 if (!tin)
229 goto error;
230
231 /* for each stream_class */
232 for (i = 0; i < tin->streams->len; i++) {
233 struct ctf_stream_declaration *stream_class;
234
235 stream_class = g_ptr_array_index(tin->streams, i);
236 if (!stream_class)
237 continue;
238 /* for each file_stream */
239 for (j = 0; j < stream_class->streams->len; j++) {
240 struct ctf_stream_definition *stream;
241 struct ctf_file_stream *cfs;
242 struct ctf_stream_pos *stream_pos;
243 struct packet_index *index;
244
245 stream = g_ptr_array_index(stream_class->streams, j);
246 cfs = container_of(stream, struct ctf_file_stream,
247 parent);
248 stream_pos = &cfs->pos;
249
250 if (!stream_pos->packet_index)
251 goto error;
252
253 if (stream_pos->packet_index->len <= 0)
254 continue;
255
256 index = &g_array_index(stream_pos->packet_index,
257 struct packet_index,
258 stream_pos->packet_index->len - 1);
259 if (type == BT_CLOCK_REAL) {
260 if (index->ts_real.timestamp_end > end)
261 end = index->ts_real.timestamp_end;
262 } else if (type == BT_CLOCK_CYCLES) {
263 if (index->ts_cycles.timestamp_end > end)
264 end = index->ts_cycles.timestamp_end;
265 } else {
266 goto error;
267 }
268 }
269 }
270
271 return end;
272
273 error:
274 return -1ULL;
275 }
276
277 /*
278 * Update stream current timestamp
279 */
280 static
281 void ctf_update_timestamp(struct ctf_stream_definition *stream,
282 struct definition_integer *integer_definition)
283 {
284 struct declaration_integer *integer_declaration =
285 integer_definition->declaration;
286 uint64_t oldval, newval, updateval;
287
288 if (unlikely(integer_declaration->len == 64)) {
289 stream->cycles_timestamp = integer_definition->value._unsigned;
290 stream->real_timestamp = ctf_get_real_timestamp(stream,
291 stream->cycles_timestamp);
292 return;
293 }
294 /* keep low bits */
295 oldval = stream->cycles_timestamp;
296 oldval &= (1ULL << integer_declaration->len) - 1;
297 newval = integer_definition->value._unsigned;
298 /* Test for overflow by comparing low bits */
299 if (newval < oldval)
300 newval += 1ULL << integer_declaration->len;
301 /* updateval contains old high bits, and new low bits (sum) */
302 updateval = stream->cycles_timestamp;
303 updateval &= ~((1ULL << integer_declaration->len) - 1);
304 updateval += newval;
305 stream->cycles_timestamp = updateval;
306
307 /* convert to real timestamp */
308 stream->real_timestamp = ctf_get_real_timestamp(stream,
309 stream->cycles_timestamp);
310 }
311
312 /*
313 * Print timestamp, rescaling clock frequency to nanoseconds and
314 * applying offsets as needed (unix time).
315 */
316 static
317 void ctf_print_timestamp_real(FILE *fp,
318 struct ctf_stream_definition *stream,
319 uint64_t timestamp)
320 {
321 uint64_t ts_sec = 0, ts_nsec;
322
323 ts_nsec = timestamp;
324
325 /* Add command-line offset in ns*/
326 ts_nsec += opt_clock_offset_ns;
327
328 /* Add command-line offset */
329 ts_sec += opt_clock_offset;
330
331 ts_sec += ts_nsec / NSEC_PER_SEC;
332 ts_nsec = ts_nsec % NSEC_PER_SEC;
333
334 if (!opt_clock_seconds) {
335 struct tm tm;
336 time_t time_s = (time_t) ts_sec;
337
338 if (!opt_clock_gmt) {
339 struct tm *res;
340
341 res = localtime_r(&time_s, &tm);
342 if (!res) {
343 fprintf(stderr, "[warning] Unable to get localtime.\n");
344 goto seconds;
345 }
346 } else {
347 struct tm *res;
348
349 res = gmtime_r(&time_s, &tm);
350 if (!res) {
351 fprintf(stderr, "[warning] Unable to get gmtime.\n");
352 goto seconds;
353 }
354 }
355 if (opt_clock_date) {
356 char timestr[26];
357 size_t res;
358
359 /* Print date and time */
360 res = strftime(timestr, sizeof(timestr),
361 "%F ", &tm);
362 if (!res) {
363 fprintf(stderr, "[warning] Unable to print ascii time.\n");
364 goto seconds;
365 }
366 fprintf(fp, "%s", timestr);
367 }
368 /* Print time in HH:MM:SS.ns */
369 fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
370 tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
371 goto end;
372 }
373 seconds:
374 fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
375 ts_sec, ts_nsec);
376
377 end:
378 return;
379 }
380
381 /*
382 * Print timestamp, in cycles
383 */
384 static
385 void ctf_print_timestamp_cycles(FILE *fp,
386 struct ctf_stream_definition *stream,
387 uint64_t timestamp)
388 {
389 fprintf(fp, "%020" PRIu64, timestamp);
390 }
391
392 void ctf_print_timestamp(FILE *fp,
393 struct ctf_stream_definition *stream,
394 uint64_t timestamp)
395 {
396 if (opt_clock_cycles) {
397 ctf_print_timestamp_cycles(fp, stream, timestamp);
398 } else {
399 ctf_print_timestamp_real(fp, stream, timestamp);
400 }
401 }
402
403 static
404 void print_uuid(FILE *fp, unsigned char *uuid)
405 {
406 int i;
407
408 for (i = 0; i < BABELTRACE_UUID_LEN; i++)
409 fprintf(fp, "%x", (unsigned int) uuid[i]);
410 }
411
412 /*
413 * Discarded events can be either:
414 * - discarded after end of previous buffer due to buffer full:
415 * happened within range: [ prev_timestamp_end, timestamp_begin ]
416 * - discarded within current buffer due to either event too large or
417 * nested wrap-around:
418 * happened within range: [ timestamp_begin, timestamp_end ]
419 *
420 * Given we have discarded counters of those two types merged into the
421 * events_discarded counter, we need to use the union of those ranges:
422 * [ prev_timestamp_end, timestamp_end ]
423 */
424 static
425 void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream)
426 {
427 if (!stream->events_discarded || !babeltrace_ctf_console_output) {
428 return;
429 }
430 fflush(stdout);
431 fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [",
432 stream->events_discarded);
433 if (opt_clock_cycles) {
434 ctf_print_timestamp(fp, stream,
435 stream->prev.cycles.end);
436 fprintf(fp, "] and [");
437 ctf_print_timestamp(fp, stream,
438 stream->current.cycles.end);
439 } else {
440 ctf_print_timestamp(fp, stream,
441 stream->prev.real.end);
442 fprintf(fp, "] and [");
443 ctf_print_timestamp(fp, stream,
444 stream->current.real.end);
445 }
446 fprintf(fp, "] in trace UUID ");
447 print_uuid(fp, stream->stream_class->trace->uuid);
448 if (stream->stream_class->trace->parent.path[0])
449 fprintf(fp, ", at path: \"%s\"",
450 stream->stream_class->trace->parent.path);
451
452 fprintf(fp, ", within stream id %" PRIu64, stream->stream_id);
453 if (stream->path[0])
454 fprintf(fp, ", at relative path: \"%s\"", stream->path);
455 fprintf(fp, ". ");
456 fprintf(fp, "You should consider recording a new trace with larger "
457 "buffers or with fewer events enabled.\n");
458 fflush(fp);
459 }
460
461 static
462 int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream)
463 {
464 struct ctf_stream_pos *pos =
465 container_of(ppos, struct ctf_stream_pos, parent);
466 struct ctf_stream_declaration *stream_class = stream->stream_class;
467 struct ctf_event_definition *event;
468 uint64_t id = 0;
469 int ret;
470
471 /* We need to check for EOF here for empty files. */
472 if (unlikely(pos->offset == EOF))
473 return EOF;
474
475 ctf_pos_get_event(pos);
476
477 /* save the current position as a restore point */
478 pos->last_offset = pos->offset;
479
480 /*
481 * This is the EOF check after we've advanced the position in
482 * ctf_pos_get_event.
483 */
484 if (unlikely(pos->offset == EOF))
485 return EOF;
486
487 /* Stream is inactive for now (live reading). */
488 if (unlikely(pos->content_size == 0))
489 return EAGAIN;
490
491 /*
492 * Packet seeked to by ctf_pos_get_event() only contains
493 * headers, no event. Consider stream as inactive (live
494 * reading).
495 */
496 if (unlikely(pos->data_offset == pos->content_size))
497 return EAGAIN;
498
499 assert(pos->offset < pos->content_size);
500
501 /* Read event header */
502 if (likely(stream->stream_event_header)) {
503 struct definition_integer *integer_definition;
504 struct bt_definition *variant;
505
506 ret = generic_rw(ppos, &stream->stream_event_header->p);
507 if (unlikely(ret))
508 goto error;
509 /* lookup event id */
510 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "id", FALSE);
511 if (integer_definition) {
512 id = integer_definition->value._unsigned;
513 } else {
514 struct definition_enum *enum_definition;
515
516 enum_definition = bt_lookup_enum(&stream->stream_event_header->p, "id", FALSE);
517 if (enum_definition) {
518 id = enum_definition->integer->value._unsigned;
519 }
520 }
521
522 variant = bt_lookup_variant(&stream->stream_event_header->p, "v");
523 if (variant) {
524 integer_definition = bt_lookup_integer(variant, "id", FALSE);
525 if (integer_definition) {
526 id = integer_definition->value._unsigned;
527 }
528 }
529 stream->event_id = id;
530
531 /* lookup timestamp */
532 stream->has_timestamp = 0;
533 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
534 if (integer_definition) {
535 ctf_update_timestamp(stream, integer_definition);
536 stream->has_timestamp = 1;
537 } else {
538 if (variant) {
539 integer_definition = bt_lookup_integer(variant, "timestamp", FALSE);
540 if (integer_definition) {
541 ctf_update_timestamp(stream, integer_definition);
542 stream->has_timestamp = 1;
543 }
544 }
545 }
546 }
547
548 /* Read stream-declared event context */
549 if (stream->stream_event_context) {
550 ret = generic_rw(ppos, &stream->stream_event_context->p);
551 if (ret)
552 goto error;
553 }
554
555 if (unlikely(id >= stream_class->events_by_id->len)) {
556 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
557 return -EINVAL;
558 }
559 event = g_ptr_array_index(stream->events_by_id, id);
560 if (unlikely(!event)) {
561 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
562 return -EINVAL;
563 }
564
565 /* Read event-declared event context */
566 if (event->event_context) {
567 ret = generic_rw(ppos, &event->event_context->p);
568 if (ret)
569 goto error;
570 }
571
572 /* Read event payload */
573 if (likely(event->event_fields)) {
574 ret = generic_rw(ppos, &event->event_fields->p);
575 if (ret)
576 goto error;
577 }
578
579 if (pos->last_offset == pos->offset) {
580 fprintf(stderr, "[error] Invalid 0 byte event encountered.\n");
581 return -EINVAL;
582 }
583
584 return 0;
585
586 error:
587 fprintf(stderr, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
588 return ret;
589 }
590
591 static
592 int ctf_write_event(struct bt_stream_pos *pos, struct ctf_stream_definition *stream)
593 {
594 struct ctf_stream_declaration *stream_class = stream->stream_class;
595 struct ctf_event_definition *event;
596 uint64_t id;
597 int ret;
598
599 id = stream->event_id;
600
601 /* print event header */
602 if (likely(stream->stream_event_header)) {
603 ret = generic_rw(pos, &stream->stream_event_header->p);
604 if (ret)
605 goto error;
606 }
607
608 /* print stream-declared event context */
609 if (stream->stream_event_context) {
610 ret = generic_rw(pos, &stream->stream_event_context->p);
611 if (ret)
612 goto error;
613 }
614
615 if (unlikely(id >= stream_class->events_by_id->len)) {
616 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
617 return -EINVAL;
618 }
619 event = g_ptr_array_index(stream->events_by_id, id);
620 if (unlikely(!event)) {
621 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
622 return -EINVAL;
623 }
624
625 /* print event-declared event context */
626 if (event->event_context) {
627 ret = generic_rw(pos, &event->event_context->p);
628 if (ret)
629 goto error;
630 }
631
632 /* Read and print event payload */
633 if (likely(event->event_fields)) {
634 ret = generic_rw(pos, &event->event_fields->p);
635 if (ret)
636 goto error;
637 }
638
639 return 0;
640
641 error:
642 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
643 return ret;
644 }
645
646 /*
647 * One side-effect of this function is to unmap pos mmap base if one is
648 * mapped.
649 */
650 static
651 int find_data_offset(struct ctf_stream_pos *pos,
652 struct ctf_file_stream *file_stream,
653 struct packet_index *packet_index)
654 {
655 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
656 struct stat filestats;
657 size_t filesize;
658 int ret;
659
660 pos = &file_stream->pos;
661
662 ret = fstat(pos->fd, &filestats);
663 if (ret < 0)
664 return ret;
665 filesize = filestats.st_size;
666
667 /* Deal with empty files */
668 if (!filesize) {
669 return 0;
670 }
671
672 begin:
673 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
674 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
675 }
676
677 if (pos->base_mma) {
678 /* unmap old base */
679 ret = munmap_align(pos->base_mma);
680 if (ret) {
681 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
682 strerror(errno));
683 return ret;
684 }
685 pos->base_mma = NULL;
686 }
687 /* map new base. Need mapping length from header. */
688 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
689 MAP_PRIVATE, pos->fd, pos->mmap_offset);
690 assert(pos->base_mma != MAP_FAILED);
691
692 pos->content_size = packet_map_len;
693 pos->packet_size = packet_map_len;
694 pos->offset = 0; /* Position of the packet header */
695
696 /* update trace_packet_header and stream_packet_context */
697 if (pos->prot == PROT_READ && file_stream->parent.trace_packet_header) {
698 /* Read packet header */
699 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
700 if (ret) {
701 if (ret == -EFAULT)
702 goto retry;
703 }
704 }
705 if (pos->prot == PROT_READ && file_stream->parent.stream_packet_context) {
706 /* Read packet context */
707 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
708 if (ret) {
709 if (ret == -EFAULT)
710 goto retry;
711 }
712 }
713 packet_index->data_offset = pos->offset;
714
715 /* unmap old base */
716 ret = munmap_align(pos->base_mma);
717 if (ret) {
718 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
719 strerror(errno));
720 return ret;
721 }
722 pos->base_mma = NULL;
723
724 return 0;
725
726 /* Retry with larger mapping */
727 retry:
728 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
729 /*
730 * Reached EOF, but still expecting header/context data.
731 */
732 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
733 return -EFAULT;
734 }
735 /* Double the mapping len, and retry */
736 tmp_map_len = packet_map_len << 1;
737 if (tmp_map_len >> 1 != packet_map_len) {
738 /* Overflow */
739 fprintf(stderr, "[error] Packet mapping length overflow\n");
740 return -EFAULT;
741 }
742 packet_map_len = tmp_map_len;
743 goto begin;
744 }
745
746
747 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
748 int fd, int open_flags)
749 {
750 pos->fd = fd;
751 if (fd >= 0) {
752 pos->packet_index = g_array_new(FALSE, TRUE,
753 sizeof(struct packet_index));
754 } else {
755 pos->packet_index = NULL;
756 }
757 switch (open_flags & O_ACCMODE) {
758 case O_RDONLY:
759 pos->prot = PROT_READ;
760 pos->flags = MAP_PRIVATE;
761 pos->parent.rw_table = read_dispatch_table;
762 pos->parent.event_cb = ctf_read_event;
763 pos->parent.trace = trace;
764 break;
765 case O_RDWR:
766 pos->prot = PROT_READ | PROT_WRITE;
767 pos->flags = MAP_SHARED;
768 pos->parent.rw_table = write_dispatch_table;
769 pos->parent.event_cb = ctf_write_event;
770 pos->parent.trace = trace;
771 if (fd >= 0)
772 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
773 break;
774 default:
775 assert(0);
776 }
777 return 0;
778 }
779
780 int ctf_fini_pos(struct ctf_stream_pos *pos)
781 {
782 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
783 *pos->content_size_loc = pos->offset;
784 if (pos->base_mma) {
785 int ret;
786
787 /* unmap old base */
788 ret = munmap_align(pos->base_mma);
789 if (ret) {
790 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
791 strerror(errno));
792 return -1;
793 }
794 }
795 if (pos->packet_index)
796 (void) g_array_free(pos->packet_index, TRUE);
797 return 0;
798 }
799
800 void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
801 struct packet_index *prev_index,
802 struct packet_index *cur_index)
803 {
804 uint64_t events_discarded_diff;
805
806 /* Update packet index time information */
807
808 /* Current packet begin/end */
809 stream->current.real.begin =
810 cur_index->ts_real.timestamp_begin;
811 stream->current.cycles.begin =
812 cur_index->ts_cycles.timestamp_begin;
813 stream->current.real.end =
814 cur_index->ts_real.timestamp_end;
815 stream->current.cycles.end =
816 cur_index->ts_cycles.timestamp_end;
817
818 /* Update packet index discarded event information */
819 events_discarded_diff = cur_index->events_discarded;
820 if (prev_index) {
821 /* Previous packet begin/end */
822 stream->prev.cycles.begin =
823 prev_index->ts_cycles.timestamp_begin;
824 stream->prev.real.begin =
825 prev_index->ts_real.timestamp_begin;
826 stream->prev.cycles.end =
827 prev_index->ts_cycles.timestamp_end;
828 stream->prev.real.end =
829 prev_index->ts_real.timestamp_end;
830
831 events_discarded_diff -= prev_index->events_discarded;
832 /*
833 * Deal with 32-bit wrap-around if the tracer provided a
834 * 32-bit field.
835 */
836 if (prev_index->events_discarded_len == 32) {
837 events_discarded_diff = (uint32_t) events_discarded_diff;
838 }
839 } else {
840 /*
841 * First packet: use current packet info as limits for
842 * previous packet.
843 */
844 stream->prev.cycles.begin =
845 stream->prev.cycles.end =
846 stream->current.cycles.begin;
847 stream->prev.real.begin =
848 stream->prev.real.end =
849 stream->current.real.begin;
850 }
851 stream->events_discarded = events_discarded_diff;
852 }
853
854 /*
855 * for SEEK_CUR: go to next packet.
856 * for SEEK_SET: go to packet numer (index).
857 */
858 void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
859 {
860 struct ctf_stream_pos *pos =
861 container_of(stream_pos, struct ctf_stream_pos, parent);
862 struct ctf_file_stream *file_stream =
863 container_of(pos, struct ctf_file_stream, pos);
864 int ret;
865 off_t off;
866 struct packet_index *packet_index, *prev_index;
867
868 switch (whence) {
869 case SEEK_CUR:
870 case SEEK_SET: /* Fall-through */
871 break; /* OK */
872 default:
873 assert(0);
874 }
875
876 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
877 *pos->content_size_loc = pos->offset;
878
879 if (pos->base_mma) {
880 /* unmap old base */
881 ret = munmap_align(pos->base_mma);
882 if (ret) {
883 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
884 strerror(errno));
885 assert(0);
886 }
887 pos->base_mma = NULL;
888 }
889
890 /*
891 * The caller should never ask for ctf_move_pos across packets,
892 * except to get exactly at the beginning of the next packet.
893 */
894 if (pos->prot & PROT_WRITE) {
895 switch (whence) {
896 case SEEK_CUR:
897 /* The writer will add padding */
898 pos->mmap_offset += pos->packet_size / CHAR_BIT;
899 break;
900 case SEEK_SET:
901 assert(index == 0); /* only seek supported for now */
902 pos->cur_index = 0;
903 break;
904 default:
905 assert(0);
906 }
907 pos->content_size = -1U; /* Unknown at this point */
908 pos->packet_size = WRITE_PACKET_LEN;
909 off = posix_fallocate(pos->fd, pos->mmap_offset,
910 pos->packet_size / CHAR_BIT);
911 assert(off == 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
1553 /* read and check header, set stream id (and check) */
1554 if (file_stream->parent.trace_packet_header) {
1555 /* Read packet header */
1556 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1557 if (ret) {
1558 if (ret == -EFAULT)
1559 goto retry;
1560 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1561 return ret;
1562 }
1563 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1564 if (len_index >= 0) {
1565 struct bt_definition *field;
1566 uint64_t magic;
1567
1568 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1569 magic = bt_get_unsigned_int(field);
1570 if (magic != CTF_MAGIC) {
1571 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1572 magic,
1573 file_stream->pos.packet_index->len,
1574 (ssize_t) pos->mmap_offset);
1575 return -EINVAL;
1576 }
1577 }
1578
1579 /* check uuid */
1580 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1581 if (len_index >= 0) {
1582 struct definition_array *defarray;
1583 struct bt_definition *field;
1584 uint64_t i;
1585 uint8_t uuidval[BABELTRACE_UUID_LEN];
1586
1587 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1588 assert(field->declaration->id == CTF_TYPE_ARRAY);
1589 defarray = container_of(field, struct definition_array, p);
1590 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1591
1592 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1593 struct bt_definition *elem;
1594
1595 elem = bt_array_index(defarray, i);
1596 uuidval[i] = bt_get_unsigned_int(elem);
1597 }
1598 ret = bt_uuid_compare(td->uuid, uuidval);
1599 if (ret) {
1600 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1601 return -EINVAL;
1602 }
1603 }
1604
1605 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1606 if (len_index >= 0) {
1607 struct bt_definition *field;
1608
1609 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1610 stream_id = bt_get_unsigned_int(field);
1611 }
1612 }
1613
1614 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1615 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1616 stream_id,
1617 file_stream->parent.stream_id);
1618 return -EINVAL;
1619 }
1620 if (first_packet) {
1621 ret = stream_assign_class(td, file_stream, stream_id);
1622 if (ret)
1623 return ret;
1624 }
1625
1626 if (file_stream->parent.stream_packet_context) {
1627 /* Read packet context */
1628 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1629 if (ret) {
1630 if (ret == -EFAULT)
1631 goto retry;
1632 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1633 return ret;
1634 }
1635 /* read packet size from header */
1636 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1637 if (len_index >= 0) {
1638 struct bt_definition *field;
1639
1640 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1641 packet_index.packet_size = bt_get_unsigned_int(field);
1642 } else {
1643 /* Use file size for packet size */
1644 packet_index.packet_size = filesize * CHAR_BIT;
1645 }
1646
1647 /* read content size from header */
1648 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1649 if (len_index >= 0) {
1650 struct bt_definition *field;
1651
1652 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1653 packet_index.content_size = bt_get_unsigned_int(field);
1654 } else {
1655 /* Use packet size if non-zero, else file size */
1656 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1657 }
1658
1659 /* read timestamp begin from header */
1660 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1661 if (len_index >= 0) {
1662 struct bt_definition *field;
1663
1664 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1665 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1666 if (file_stream->parent.stream_class->trace->parent.collection) {
1667 packet_index.ts_real.timestamp_begin =
1668 ctf_get_real_timestamp(
1669 &file_stream->parent,
1670 packet_index.ts_cycles.timestamp_begin);
1671 }
1672 }
1673
1674 /* read timestamp end from header */
1675 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1676 if (len_index >= 0) {
1677 struct bt_definition *field;
1678
1679 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1680 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1681 if (file_stream->parent.stream_class->trace->parent.collection) {
1682 packet_index.ts_real.timestamp_end =
1683 ctf_get_real_timestamp(
1684 &file_stream->parent,
1685 packet_index.ts_cycles.timestamp_end);
1686 }
1687 }
1688
1689 /* read events discarded from header */
1690 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1691 if (len_index >= 0) {
1692 struct bt_definition *field;
1693
1694 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1695 packet_index.events_discarded = bt_get_unsigned_int(field);
1696 packet_index.events_discarded_len = bt_get_int_len(field);
1697 }
1698 } else {
1699 /* Use file size for packet size */
1700 packet_index.packet_size = filesize * CHAR_BIT;
1701 /* Use packet size if non-zero, else file size */
1702 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1703 }
1704
1705 /* Validate content size and packet size values */
1706 if (packet_index.content_size > packet_index.packet_size) {
1707 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1708 packet_index.content_size, packet_index.packet_size);
1709 return -EINVAL;
1710 }
1711
1712 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1713 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1714 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1715 return -EINVAL;
1716 }
1717
1718 if (packet_index.content_size < pos->offset) {
1719 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1720 return -EINVAL;
1721 }
1722
1723 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1724 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1725 return -EINVAL;
1726 }
1727
1728 /* Save position after header and context */
1729 packet_index.data_offset = pos->offset;
1730
1731 /* add index to packet array */
1732 g_array_append_val(file_stream->pos.packet_index, packet_index);
1733
1734 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1735
1736 return 0;
1737
1738 /* Retry with larger mapping */
1739 retry:
1740 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1741 /*
1742 * Reached EOF, but still expecting header/context data.
1743 */
1744 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1745 return -EFAULT;
1746 }
1747 /* Double the mapping len, and retry */
1748 tmp_map_len = packet_map_len << 1;
1749 if (tmp_map_len >> 1 != packet_map_len) {
1750 /* Overflow */
1751 fprintf(stderr, "[error] Packet mapping length overflow\n");
1752 return -EFAULT;
1753 }
1754 packet_map_len = tmp_map_len;
1755 goto begin;
1756 }
1757
1758 static
1759 int create_stream_packet_index(struct ctf_trace *td,
1760 struct ctf_file_stream *file_stream)
1761 {
1762 struct ctf_stream_pos *pos;
1763 struct stat filestats;
1764 int ret;
1765
1766 pos = &file_stream->pos;
1767
1768 ret = fstat(pos->fd, &filestats);
1769 if (ret < 0)
1770 return ret;
1771
1772 /* Deal with empty files */
1773 if (!filestats.st_size) {
1774 if (file_stream->parent.trace_packet_header
1775 || file_stream->parent.stream_packet_context) {
1776 /*
1777 * We expect a trace packet header and/or stream packet
1778 * context. Since a trace needs to have at least one
1779 * packet, empty files are therefore not accepted.
1780 */
1781 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1782 return -EINVAL;
1783 } else {
1784 /*
1785 * Without trace packet header nor stream packet
1786 * context, a one-packet trace can indeed be empty. This
1787 * is only valid if there is only one stream class: 0.
1788 */
1789 ret = stream_assign_class(td, file_stream, 0);
1790 if (ret)
1791 return ret;
1792 return 0;
1793 }
1794 }
1795
1796 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1797 ret = create_stream_one_packet_index(pos, td, file_stream,
1798 filestats.st_size);
1799 if (ret)
1800 return ret;
1801 }
1802 return 0;
1803 }
1804
1805 static
1806 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1807 {
1808 int ret;
1809
1810 if (td->packet_header_decl) {
1811 struct bt_definition *definition =
1812 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1813 stream->parent_def_scope, 0, 0, "trace.packet.header");
1814 if (!definition) {
1815 ret = -EINVAL;
1816 goto error;
1817 }
1818 stream->trace_packet_header =
1819 container_of(definition, struct definition_struct, p);
1820 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1821 }
1822
1823 return 0;
1824
1825 error:
1826 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1827 return ret;
1828 }
1829
1830 static
1831 int import_stream_packet_index(struct ctf_trace *td,
1832 struct ctf_file_stream *file_stream)
1833 {
1834 struct ctf_stream_pos *pos;
1835 struct ctf_packet_index *ctf_index = NULL;
1836 struct ctf_packet_index_file_hdr index_hdr;
1837 struct packet_index index;
1838 uint32_t packet_index_len;
1839 int ret = 0;
1840 int first_packet = 1;
1841 size_t len;
1842
1843 pos = &file_stream->pos;
1844
1845 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1846 if (len != 1) {
1847 perror("read index file header");
1848 goto error;
1849 }
1850
1851 /* Check the index header */
1852 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1853 fprintf(stderr, "[error] wrong index magic\n");
1854 ret = -1;
1855 goto error;
1856 }
1857 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1858 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1859 ".%" PRIu32 ", supported %d.%d\n",
1860 be32toh(index_hdr.index_major),
1861 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1862 CTF_INDEX_MINOR);
1863 ret = -1;
1864 goto error;
1865 }
1866 packet_index_len = be32toh(index_hdr.packet_index_len);
1867 if (packet_index_len == 0) {
1868 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1869 ret = -1;
1870 goto error;
1871 }
1872 /*
1873 * Allocate the index length found in header, not internal
1874 * representation.
1875 */
1876 ctf_index = g_malloc0(packet_index_len);
1877 while (fread(ctf_index, packet_index_len, 1,
1878 pos->index_fp) == 1) {
1879 uint64_t stream_id;
1880 struct ctf_stream_declaration *stream = NULL;
1881
1882 memset(&index, 0, sizeof(index));
1883 index.offset = be64toh(ctf_index->offset);
1884 index.packet_size = be64toh(ctf_index->packet_size);
1885 index.content_size = be64toh(ctf_index->content_size);
1886 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
1887 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
1888 index.events_discarded = be64toh(ctf_index->events_discarded);
1889 index.events_discarded_len = 64;
1890 index.data_offset = -1;
1891 stream_id = be64toh(ctf_index->stream_id);
1892
1893 if (!first_packet) {
1894 /* add index to packet array */
1895 g_array_append_val(file_stream->pos.packet_index, index);
1896 continue;
1897 }
1898
1899 file_stream->parent.stream_id = stream_id;
1900 if (stream_id < td->streams->len) {
1901 stream = g_ptr_array_index(td->streams, stream_id);
1902 }
1903 if (!stream) {
1904 fprintf(stderr, "[error] Stream %" PRIu64
1905 " is not declared in metadata.\n",
1906 stream_id);
1907 ret = -EINVAL;
1908 goto error;
1909 }
1910 file_stream->parent.stream_class = stream;
1911 ret = create_stream_definitions(td, &file_stream->parent);
1912 if (ret)
1913 goto error;
1914 first_packet = 0;
1915 /* add index to packet array */
1916 g_array_append_val(file_stream->pos.packet_index, index);
1917 }
1918
1919 /* Index containing only the header. */
1920 if (!file_stream->parent.stream_class) {
1921 ret = -1;
1922 goto error;
1923 }
1924
1925 ret = 0;
1926
1927 error:
1928 g_free(ctf_index);
1929 return ret;
1930 }
1931
1932 /*
1933 * Note: many file streams can inherit from the same stream class
1934 * description (metadata).
1935 */
1936 static
1937 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1938 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
1939 int whence))
1940 {
1941 int ret, fd, closeret;
1942 struct ctf_file_stream *file_stream;
1943 struct stat statbuf;
1944 char *index_name;
1945
1946 fd = openat(td->dirfd, path, flags);
1947 if (fd < 0) {
1948 perror("File stream openat()");
1949 ret = fd;
1950 goto error;
1951 }
1952
1953 /* Don't try to mmap subdirectories. Skip them, return success. */
1954 ret = fstat(fd, &statbuf);
1955 if (ret) {
1956 perror("File stream fstat()");
1957 goto fstat_error;
1958 }
1959 if (S_ISDIR(statbuf.st_mode)) {
1960 if (strncmp(path, "index", 5) != 0) {
1961 fprintf(stderr, "[warning] Skipping directory '%s' "
1962 "found in trace\n", path);
1963 }
1964 ret = 0;
1965 goto fd_is_dir_ok;
1966 }
1967 if (!statbuf.st_size) {
1968 /** Skip empty files. */
1969 ret = 0;
1970 goto fd_is_empty_file;
1971 }
1972
1973 file_stream = g_new0(struct ctf_file_stream, 1);
1974 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1975 file_stream->pos.fd = -1;
1976 file_stream->pos.index_fp = NULL;
1977
1978 strncpy(file_stream->parent.path, path, PATH_MAX);
1979 file_stream->parent.path[PATH_MAX - 1] = '\0';
1980
1981 if (packet_seek) {
1982 file_stream->pos.packet_seek = packet_seek;
1983 } else {
1984 fprintf(stderr, "[error] packet_seek function undefined.\n");
1985 ret = -1;
1986 goto error_def;
1987 }
1988
1989 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
1990 if (ret)
1991 goto error_def;
1992 ret = create_trace_definitions(td, &file_stream->parent);
1993 if (ret)
1994 goto error_def;
1995 /*
1996 * For now, only a single clock per trace is supported.
1997 */
1998 file_stream->parent.current_clock = td->parent.single_clock;
1999
2000 /*
2001 * Allocate the index name for this stream and try to open it.
2002 */
2003 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2004 if (!index_name) {
2005 fprintf(stderr, "[error] Cannot allocate index filename\n");
2006 ret = -ENOMEM;
2007 goto error_def;
2008 }
2009 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2010 INDEX_PATH, path);
2011
2012 if (faccessat(td->dirfd, index_name, O_RDONLY, flags) < 0) {
2013 ret = create_stream_packet_index(td, file_stream);
2014 if (ret) {
2015 fprintf(stderr, "[error] Stream index creation error.\n");
2016 goto error_index;
2017 }
2018 } else {
2019 ret = openat(td->dirfd, index_name, flags);
2020 if (ret < 0) {
2021 perror("Index file openat()");
2022 ret = -1;
2023 goto error_free;
2024 }
2025 file_stream->pos.index_fp = fdopen(ret, "r");
2026 if (!file_stream->pos.index_fp) {
2027 perror("fdopen() error");
2028 goto error_free;
2029 }
2030 ret = import_stream_packet_index(td, file_stream);
2031 if (ret) {
2032 ret = -1;
2033 goto error_index;
2034 }
2035 ret = fclose(file_stream->pos.index_fp);
2036 if (ret < 0) {
2037 perror("close index");
2038 goto error_free;
2039 }
2040 }
2041 free(index_name);
2042
2043 /* Add stream file to stream class */
2044 g_ptr_array_add(file_stream->parent.stream_class->streams,
2045 &file_stream->parent);
2046 return 0;
2047
2048 error_index:
2049 if (file_stream->pos.index_fp) {
2050 ret = fclose(file_stream->pos.index_fp);
2051 if (ret < 0) {
2052 perror("close index");
2053 }
2054 }
2055 if (file_stream->parent.trace_packet_header)
2056 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2057 error_free:
2058 free(index_name);
2059 error_def:
2060 closeret = ctf_fini_pos(&file_stream->pos);
2061 if (closeret) {
2062 fprintf(stderr, "Error on ctf_fini_pos\n");
2063 }
2064 g_free(file_stream);
2065 fd_is_empty_file:
2066 fd_is_dir_ok:
2067 fstat_error:
2068 closeret = close(fd);
2069 if (closeret) {
2070 perror("Error on fd close");
2071 }
2072 error:
2073 return ret;
2074 }
2075
2076 static
2077 int ctf_open_trace_read(struct ctf_trace *td,
2078 const char *path, int flags,
2079 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2080 int whence), FILE *metadata_fp)
2081 {
2082 struct ctf_scanner *scanner;
2083 int ret, closeret;
2084 struct dirent *dirent;
2085 struct dirent *diriter;
2086 size_t dirent_len;
2087 char *ext;
2088
2089 td->flags = flags;
2090
2091 /* Open trace directory */
2092 td->dir = opendir(path);
2093 if (!td->dir) {
2094 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2095 ret = -ENOENT;
2096 goto error;
2097 }
2098
2099 td->dirfd = open(path, 0);
2100 if (td->dirfd < 0) {
2101 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2102 perror("Trace directory open");
2103 ret = -errno;
2104 goto error_dirfd;
2105 }
2106 strncpy(td->parent.path, path, sizeof(td->parent.path));
2107 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2108
2109 /*
2110 * Keep the metadata file separate.
2111 * Keep scanner object local to the open. We don't support
2112 * incremental metadata append for on-disk traces.
2113 */
2114 scanner = ctf_scanner_alloc();
2115 if (!scanner) {
2116 fprintf(stderr, "[error] Error allocating scanner\n");
2117 ret = -ENOMEM;
2118 goto error_metadata;
2119 }
2120 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2121 ctf_scanner_free(scanner);
2122 if (ret) {
2123 if (ret == -ENOENT) {
2124 fprintf(stderr, "[warning] Empty metadata.\n");
2125 }
2126 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2127 goto error_metadata;
2128 }
2129
2130 /*
2131 * Open each stream: for each file, try to open, check magic
2132 * number, and get the stream ID to add to the right location in
2133 * the stream array.
2134 */
2135
2136 dirent_len = offsetof(struct dirent, d_name) +
2137 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2138
2139 dirent = malloc(dirent_len);
2140
2141 for (;;) {
2142 ret = readdir_r(td->dir, dirent, &diriter);
2143 if (ret) {
2144 fprintf(stderr, "[error] Readdir error.\n");
2145 goto readdir_error;
2146 }
2147 if (!diriter)
2148 break;
2149 /* Ignore hidden files, ., .. and metadata. */
2150 if (!strncmp(diriter->d_name, ".", 1)
2151 || !strcmp(diriter->d_name, "..")
2152 || !strcmp(diriter->d_name, "metadata"))
2153 continue;
2154
2155 /* Ignore index files : *.idx */
2156 ext = strrchr(diriter->d_name, '.');
2157 if (ext && (!strcmp(ext, ".idx"))) {
2158 continue;
2159 }
2160
2161 ret = ctf_open_file_stream_read(td, diriter->d_name,
2162 flags, packet_seek);
2163 if (ret) {
2164 fprintf(stderr, "[error] Open file stream error.\n");
2165 goto readdir_error;
2166 }
2167 }
2168
2169 free(dirent);
2170 return 0;
2171
2172 readdir_error:
2173 free(dirent);
2174 error_metadata:
2175 closeret = close(td->dirfd);
2176 if (closeret) {
2177 perror("Error on fd close");
2178 }
2179 error_dirfd:
2180 closeret = closedir(td->dir);
2181 if (closeret) {
2182 perror("Error on closedir");
2183 }
2184 error:
2185 return ret;
2186 }
2187
2188 /*
2189 * ctf_open_trace: Open a CTF trace and index it.
2190 * Note that the user must seek the trace after the open (using the iterator)
2191 * since the index creation read it entirely.
2192 */
2193 static
2194 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2195 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2196 int whence), FILE *metadata_fp)
2197 {
2198 struct ctf_trace *td;
2199 int ret;
2200
2201 /*
2202 * If packet_seek is NULL, we provide our default version.
2203 */
2204 if (!packet_seek)
2205 packet_seek = ctf_packet_seek;
2206
2207 td = g_new0(struct ctf_trace, 1);
2208
2209 switch (flags & O_ACCMODE) {
2210 case O_RDONLY:
2211 if (!path) {
2212 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2213 goto error;
2214 }
2215 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2216 if (ret)
2217 goto error;
2218 break;
2219 case O_RDWR:
2220 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2221 goto error;
2222 default:
2223 fprintf(stderr, "[error] Incorrect open flags.\n");
2224 goto error;
2225 }
2226
2227 return &td->parent;
2228 error:
2229 g_free(td);
2230 return NULL;
2231 }
2232
2233 static
2234 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2235 struct bt_mmap_stream *mmap_info)
2236 {
2237 pos->mmap_offset = 0;
2238 pos->packet_size = 0;
2239 pos->content_size = 0;
2240 pos->content_size_loc = NULL;
2241 pos->fd = mmap_info->fd;
2242 pos->base_mma = NULL;
2243 pos->offset = 0;
2244 pos->dummy = false;
2245 pos->cur_index = 0;
2246 pos->prot = PROT_READ;
2247 pos->flags = MAP_PRIVATE;
2248 pos->parent.rw_table = read_dispatch_table;
2249 pos->parent.event_cb = ctf_read_event;
2250 pos->priv = mmap_info->priv;
2251 pos->packet_index = g_array_new(FALSE, TRUE,
2252 sizeof(struct packet_index));
2253 }
2254
2255 static
2256 int prepare_mmap_stream_definition(struct ctf_trace *td,
2257 struct ctf_file_stream *file_stream,
2258 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2259 int whence))
2260 {
2261 struct ctf_stream_declaration *stream;
2262 uint64_t stream_id;
2263 int ret;
2264
2265 /* Ask for the first packet to get the stream_id. */
2266 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2267 stream_id = file_stream->parent.stream_id;
2268 if (stream_id >= td->streams->len) {
2269 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2270 "in metadata.\n", stream_id);
2271 ret = -EINVAL;
2272 goto end;
2273 }
2274 stream = g_ptr_array_index(td->streams, stream_id);
2275 if (!stream) {
2276 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2277 "in metadata.\n", stream_id);
2278 ret = -EINVAL;
2279 goto end;
2280 }
2281 file_stream->parent.stream_class = stream;
2282 ret = create_stream_definitions(td, &file_stream->parent);
2283 end:
2284 return ret;
2285 }
2286
2287 static
2288 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2289 struct bt_mmap_stream *mmap_info,
2290 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2291 int whence))
2292 {
2293 int ret;
2294 struct ctf_file_stream *file_stream;
2295
2296 file_stream = g_new0(struct ctf_file_stream, 1);
2297 file_stream->parent.stream_id = -1ULL;
2298 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2299 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2300
2301 file_stream->pos.packet_seek = packet_seek;
2302
2303 ret = create_trace_definitions(td, &file_stream->parent);
2304 if (ret) {
2305 goto error_def;
2306 }
2307
2308 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2309 if (ret)
2310 goto error_index;
2311
2312 /*
2313 * For now, only a single clock per trace is supported.
2314 */
2315 file_stream->parent.current_clock = td->parent.single_clock;
2316
2317 /* Add stream file to stream class */
2318 g_ptr_array_add(file_stream->parent.stream_class->streams,
2319 &file_stream->parent);
2320 return 0;
2321
2322 error_index:
2323 if (file_stream->parent.trace_packet_header)
2324 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2325 error_def:
2326 g_free(file_stream);
2327 return ret;
2328 }
2329
2330 static
2331 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2332 struct bt_mmap_stream_list *mmap_list,
2333 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2334 int whence),
2335 FILE *metadata_fp)
2336 {
2337 int ret;
2338 struct bt_mmap_stream *mmap_info;
2339
2340 td->scanner = ctf_scanner_alloc();
2341 if (!td->scanner) {
2342 fprintf(stderr, "[error] Error allocating scanner\n");
2343 ret = -ENOMEM;
2344 goto error;
2345 }
2346 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2347 if (ret) {
2348 if (ret == -ENOENT) {
2349 fprintf(stderr, "[warning] Empty metadata.\n");
2350 }
2351 goto error;
2352 }
2353
2354 /*
2355 * for each stream, try to open, check magic number, and get the
2356 * stream ID to add to the right location in the stream array.
2357 */
2358 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2359 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2360 if (ret) {
2361 fprintf(stderr, "[error] Open file mmap stream error.\n");
2362 goto error;
2363 }
2364 }
2365 return 0;
2366
2367 error:
2368 ctf_scanner_free(td->scanner);
2369 return ret;
2370 }
2371
2372 static
2373 struct bt_trace_descriptor *ctf_open_mmap_trace(
2374 struct bt_mmap_stream_list *mmap_list,
2375 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2376 int whence),
2377 FILE *metadata_fp)
2378 {
2379 struct ctf_trace *td;
2380 int ret;
2381
2382 if (!metadata_fp) {
2383 fprintf(stderr, "[error] No metadata file pointer associated, "
2384 "required for mmap parsing\n");
2385 goto error;
2386 }
2387 if (!packet_seek) {
2388 fprintf(stderr, "[error] packet_seek function undefined.\n");
2389 goto error;
2390 }
2391 td = g_new0(struct ctf_trace, 1);
2392 td->dirfd = -1;
2393 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2394 if (ret)
2395 goto error_free;
2396
2397 return &td->parent;
2398
2399 error_free:
2400 g_free(td);
2401 error:
2402 return NULL;
2403 }
2404
2405 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2406 FILE *metadata_fp)
2407 {
2408 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2409 int i, j;
2410 int ret;
2411
2412 if (!td->scanner)
2413 return -EINVAL;
2414 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2415 if (ret)
2416 return ret;
2417 /* for each stream_class */
2418 for (i = 0; i < td->streams->len; i++) {
2419 struct ctf_stream_declaration *stream_class;
2420
2421 stream_class = g_ptr_array_index(td->streams, i);
2422 if (!stream_class)
2423 continue;
2424 /* for each stream */
2425 for (j = 0; j < stream_class->streams->len; j++) {
2426 struct ctf_stream_definition *stream;
2427
2428 stream = g_ptr_array_index(stream_class->streams, j);
2429 if (!stream)
2430 continue;
2431 ret = copy_event_declarations_stream_class_to_stream(td,
2432 stream_class, stream);
2433 if (ret)
2434 return ret;
2435 }
2436 }
2437 return 0;
2438 }
2439
2440 static
2441 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2442 {
2443 int i, j, k;
2444 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2445
2446 /* for each stream_class */
2447 for (i = 0; i < td->streams->len; i++) {
2448 struct ctf_stream_declaration *stream_class;
2449
2450 stream_class = g_ptr_array_index(td->streams, i);
2451 if (!stream_class)
2452 continue;
2453 /* for each file_stream */
2454 for (j = 0; j < stream_class->streams->len; j++) {
2455 struct ctf_stream_definition *stream;
2456 struct ctf_stream_pos *stream_pos;
2457 struct ctf_file_stream *cfs;
2458
2459 stream = g_ptr_array_index(stream_class->streams, j);
2460 if (!stream)
2461 continue;
2462 cfs = container_of(stream, struct ctf_file_stream,
2463 parent);
2464 stream_pos = &cfs->pos;
2465 if (!stream_pos->packet_index)
2466 continue;
2467
2468 for (k = 0; k < stream_pos->packet_index->len; k++) {
2469 struct packet_index *index;
2470
2471 index = &g_array_index(stream_pos->packet_index,
2472 struct packet_index, k);
2473 index->ts_real.timestamp_begin =
2474 ctf_get_real_timestamp(stream,
2475 index->ts_cycles.timestamp_begin);
2476 index->ts_real.timestamp_end =
2477 ctf_get_real_timestamp(stream,
2478 index->ts_cycles.timestamp_end);
2479 }
2480 }
2481 }
2482 return 0;
2483 }
2484
2485 static
2486 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2487 {
2488 int ret;
2489
2490 ret = ctf_fini_pos(&file_stream->pos);
2491 if (ret) {
2492 fprintf(stderr, "Error on ctf_fini_pos\n");
2493 return -1;
2494 }
2495 if (file_stream->pos.fd >= 0) {
2496 ret = close(file_stream->pos.fd);
2497 if (ret) {
2498 perror("Error closing file fd");
2499 return -1;
2500 }
2501 }
2502 return 0;
2503 }
2504
2505 static
2506 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2507 {
2508 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2509 int ret;
2510
2511 if (td->streams) {
2512 int i;
2513
2514 for (i = 0; i < td->streams->len; i++) {
2515 struct ctf_stream_declaration *stream;
2516 int j;
2517
2518 stream = g_ptr_array_index(td->streams, i);
2519 if (!stream)
2520 continue;
2521 for (j = 0; j < stream->streams->len; j++) {
2522 struct ctf_file_stream *file_stream;
2523 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2524 struct ctf_file_stream, parent);
2525 ret = ctf_close_file_stream(file_stream);
2526 if (ret)
2527 return ret;
2528 }
2529 }
2530 }
2531 ctf_destroy_metadata(td);
2532 ctf_scanner_free(td->scanner);
2533 if (td->dirfd >= 0) {
2534 ret = close(td->dirfd);
2535 if (ret) {
2536 perror("Error closing dirfd");
2537 return ret;
2538 }
2539 }
2540 if (td->dir) {
2541 ret = closedir(td->dir);
2542 if (ret) {
2543 perror("Error closedir");
2544 return ret;
2545 }
2546 }
2547 free(td->metadata_string);
2548 g_free(td);
2549 return 0;
2550 }
2551
2552 static
2553 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2554 struct bt_context *ctx)
2555 {
2556 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2557 parent);
2558
2559 td->parent.ctx = ctx;
2560 }
2561
2562 static
2563 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2564 struct bt_trace_handle *handle)
2565 {
2566 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2567 parent);
2568
2569 td->parent.handle = handle;
2570 }
2571
2572 static
2573 void __attribute__((constructor)) ctf_init(void)
2574 {
2575 int ret;
2576
2577 ctf_format.name = g_quark_from_static_string("ctf");
2578 ret = bt_register_format(&ctf_format);
2579 assert(!ret);
2580 }
2581
2582 static
2583 void __attribute__((destructor)) ctf_exit(void)
2584 {
2585 bt_unregister_format(&ctf_format);
2586 }
This page took 0.109706 seconds and 3 git commands to generate.