projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Port: Implement faccessat wrapper
[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 off_t off;
865 struct packet_index *packet_index, *prev_index;
866
867 switch (whence) {
868 case SEEK_CUR:
869 case SEEK_SET: /* Fall-through */
870 break; /* OK */
871 default:
872 assert(0);
873 }
874
875 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
876 *pos->content_size_loc = pos->offset;
877
878 if (pos->base_mma) {
879 /* unmap old base */
880 ret = munmap_align(pos->base_mma);
881 if (ret) {
882 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
883 strerror(errno));
884 assert(0);
885 }
886 pos->base_mma = NULL;
887 }
888
889 /*
890 * The caller should never ask for ctf_move_pos across packets,
891 * except to get exactly at the beginning of the next packet.
892 */
893 if (pos->prot & PROT_WRITE) {
894 switch (whence) {
895 case SEEK_CUR:
896 /* The writer will add padding */
897 pos->mmap_offset += pos->packet_size / CHAR_BIT;
898 break;
899 case SEEK_SET:
900 assert(index == 0); /* only seek supported for now */
901 pos->cur_index = 0;
902 break;
903 default:
904 assert(0);
905 }
906 pos->content_size = -1U; /* Unknown at this point */
907 pos->packet_size = WRITE_PACKET_LEN;
908 off = bt_posix_fallocate(pos->fd, pos->mmap_offset,
909 pos->packet_size / CHAR_BIT);
910 assert(off == 0);
911 pos->offset = 0;
912 } else {
913 read_next_packet:
914 switch (whence) {
915 case SEEK_CUR:
916 {
917 if (pos->offset == EOF) {
918 return;
919 }
920 assert(pos->cur_index < pos->packet_index->len);
921 /* The reader will expect us to skip padding */
922 ++pos->cur_index;
923 break;
924 }
925 case SEEK_SET:
926 if (index >= pos->packet_index->len) {
927 pos->offset = EOF;
928 return;
929 }
930 pos->cur_index = index;
931 break;
932 default:
933 assert(0);
934 }
935
936 packet_index = &g_array_index(pos->packet_index,
937 struct packet_index, pos->cur_index);
938 if (pos->cur_index > 0) {
939 prev_index = &g_array_index(pos->packet_index,
940 struct packet_index,
941 pos->cur_index - 1);
942 } else {
943 prev_index = NULL;
944 }
945 ctf_update_current_packet_index(&file_stream->parent,
946 prev_index, packet_index);
947
948 if (pos->cur_index >= pos->packet_index->len) {
949 pos->offset = EOF;
950 return;
951 }
952
953 /*
954 * We need to check if we are in trace read or called
955 * from packet indexing. In this last case, the
956 * collection is not there, so we cannot print the
957 * timestamps.
958 */
959 if ((&file_stream->parent)->stream_class->trace->parent.collection) {
960 ctf_print_discarded(stderr, &file_stream->parent);
961 }
962
963 packet_index = &g_array_index(pos->packet_index,
964 struct packet_index,
965 pos->cur_index);
966 file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
967
968 file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin;
969
970 /* Lookup context/packet size in index */
971 if (packet_index->data_offset == -1) {
972 ret = find_data_offset(pos, file_stream, packet_index);
973 if (ret < 0) {
974 return;
975 }
976 }
977 pos->content_size = packet_index->content_size;
978 pos->packet_size = packet_index->packet_size;
979 pos->mmap_offset = packet_index->offset;
980 pos->data_offset = packet_index->data_offset;
981 if (pos->data_offset < packet_index->content_size) {
982 pos->offset = 0; /* will read headers */
983 } else if (pos->data_offset == packet_index->content_size) {
984 /* empty packet */
985 pos->offset = packet_index->data_offset;
986 whence = SEEK_CUR;
987 goto read_next_packet;
988 } else {
989 pos->offset = EOF;
990 return;
991 }
992 }
993 /* map new base. Need mapping length from header. */
994 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
995 pos->flags, pos->fd, pos->mmap_offset);
996 if (pos->base_mma == MAP_FAILED) {
997 fprintf(stderr, "[error] mmap error %s.\n",
998 strerror(errno));
999 assert(0);
1000 }
1001
1002 /* update trace_packet_header and stream_packet_context */
1003 if (!(pos->prot & PROT_WRITE) &&
1004 file_stream->parent.trace_packet_header) {
1005 /* Read packet header */
1006 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1007 assert(!ret);
1008 }
1009 if (!(pos->prot & PROT_WRITE) &&
1010 file_stream->parent.stream_packet_context) {
1011 /* Read packet context */
1012 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1013 assert(!ret);
1014 }
1015 }
1016
1017 static
1018 int packet_metadata(struct ctf_trace *td, FILE *fp)
1019 {
1020 uint32_t magic;
1021 size_t len;
1022 int ret = 0;
1023
1024 len = fread(&magic, sizeof(magic), 1, fp);
1025 if (len != 1) {
1026 goto end;
1027 }
1028 if (magic == TSDL_MAGIC) {
1029 ret = 1;
1030 td->byte_order = BYTE_ORDER;
1031 CTF_TRACE_SET_FIELD(td, byte_order);
1032 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
1033 ret = 1;
1034 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
1035 LITTLE_ENDIAN : BIG_ENDIAN;
1036 CTF_TRACE_SET_FIELD(td, byte_order);
1037 }
1038 end:
1039 rewind(fp);
1040 return ret;
1041 }
1042
1043 /*
1044 * Returns 0 on success, -1 on error.
1045 */
1046 static
1047 int check_version(unsigned int major, unsigned int minor)
1048 {
1049 switch (major) {
1050 case 1:
1051 switch (minor) {
1052 case 8:
1053 return 0;
1054 default:
1055 goto warning;
1056 }
1057 default:
1058 goto warning;
1059
1060 }
1061
1062 /* eventually return an error instead of warning */
1063 warning:
1064 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1065 major, minor);
1066 return 0;
1067 }
1068
1069 static
1070 int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
1071 FILE *out)
1072 {
1073 struct metadata_packet_header header;
1074 size_t readlen, writelen, toread;
1075 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
1076 int ret = 0;
1077
1078 readlen = fread(&header, header_sizeof(header), 1, in);
1079 if (readlen < 1)
1080 return -EINVAL;
1081
1082 if (td->byte_order != BYTE_ORDER) {
1083 header.magic = GUINT32_SWAP_LE_BE(header.magic);
1084 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
1085 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
1086 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
1087 }
1088 if (header.checksum)
1089 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
1090 if (header.compression_scheme) {
1091 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
1092 header.compression_scheme);
1093 return -EINVAL;
1094 }
1095 if (header.encryption_scheme) {
1096 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
1097 header.encryption_scheme);
1098 return -EINVAL;
1099 }
1100 if (header.checksum_scheme) {
1101 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
1102 header.checksum_scheme);
1103 return -EINVAL;
1104 }
1105 if (check_version(header.major, header.minor) < 0)
1106 return -EINVAL;
1107 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
1108 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
1109 CTF_TRACE_SET_FIELD(td, uuid);
1110 } else {
1111 if (bt_uuid_compare(header.uuid, td->uuid))
1112 return -EINVAL;
1113 }
1114
1115 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
1116 return -EINVAL;
1117
1118 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
1119
1120 for (;;) {
1121 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
1122 if (ferror(in)) {
1123 ret = -EINVAL;
1124 break;
1125 }
1126 if (babeltrace_debug) {
1127 buf[readlen] = '\0';
1128 fprintf(stderr, "[debug] metadata packet read: %s\n",
1129 buf);
1130 }
1131
1132 writelen = fwrite(buf, sizeof(char), readlen, out);
1133 if (writelen < readlen) {
1134 ret = -EIO;
1135 break;
1136 }
1137 if (ferror(out)) {
1138 ret = -EINVAL;
1139 break;
1140 }
1141 toread -= readlen;
1142 if (!toread) {
1143 ret = 0; /* continue reading next packet */
1144 goto read_padding;
1145 }
1146 }
1147 return ret;
1148
1149 read_padding:
1150 toread = (header.packet_size - header.content_size) / CHAR_BIT;
1151 ret = fseek(in, toread, SEEK_CUR);
1152 if (ret < 0) {
1153 fprintf(stderr, "[warning] Missing padding at end of file\n");
1154 ret = 0;
1155 }
1156 return ret;
1157 }
1158
1159 static
1160 int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
1161 char **buf)
1162 {
1163 FILE *in, *out;
1164 size_t size, buflen;
1165 int ret;
1166
1167 in = *fp;
1168 /*
1169 * Using strlen on *buf instead of size of open_memstream
1170 * because its size includes garbage at the end (after final
1171 * \0). This is the allocated size, not the actual string size.
1172 */
1173 out = babeltrace_open_memstream(buf, &size);
1174 if (out == NULL) {
1175 perror("Metadata open_memstream");
1176 return -errno;
1177 }
1178 for (;;) {
1179 ret = ctf_trace_metadata_packet_read(td, in, out);
1180 if (ret) {
1181 break;
1182 }
1183 if (feof(in)) {
1184 ret = 0;
1185 break;
1186 }
1187 }
1188 /* close to flush the buffer */
1189 ret = babeltrace_close_memstream(buf, &size, out);
1190 if (ret < 0) {
1191 int closeret;
1192
1193 perror("babeltrace_flush_memstream");
1194 ret = -errno;
1195 closeret = fclose(in);
1196 if (closeret) {
1197 perror("Error in fclose");
1198 }
1199 return ret;
1200 }
1201 ret = fclose(in);
1202 if (ret) {
1203 perror("Error in fclose");
1204 }
1205 /* open for reading */
1206 buflen = strlen(*buf);
1207 if (!buflen) {
1208 *fp = NULL;
1209 return -ENOENT;
1210 }
1211 *fp = babeltrace_fmemopen(*buf, buflen, "rb");
1212 if (!*fp) {
1213 perror("Metadata fmemopen");
1214 return -errno;
1215 }
1216 return 0;
1217 }
1218
1219 static
1220 int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp,
1221 struct ctf_scanner *scanner, int append)
1222 {
1223 struct ctf_file_stream *metadata_stream;
1224 FILE *fp;
1225 char *buf = NULL;
1226 int ret = 0, closeret;
1227
1228 metadata_stream = g_new0(struct ctf_file_stream, 1);
1229 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1230
1231 if (metadata_fp) {
1232 fp = metadata_fp;
1233 metadata_stream->pos.fd = -1;
1234 } else {
1235 td->metadata = &metadata_stream->parent;
1236 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1237 if (metadata_stream->pos.fd < 0) {
1238 fprintf(stderr, "Unable to open metadata.\n");
1239 ret = -1;
1240 goto end_free;
1241 }
1242
1243 fp = fdopen(metadata_stream->pos.fd, "r");
1244 if (!fp) {
1245 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1246 perror("Metadata stream open");
1247 ret = -errno;
1248 goto end_stream;
1249 }
1250 /* fd now belongs to fp */
1251 metadata_stream->pos.fd = -1;
1252 }
1253 if (babeltrace_debug)
1254 yydebug = 1;
1255
1256 if (packet_metadata(td, fp)) {
1257 ret = ctf_trace_metadata_stream_read(td, &fp, &buf);
1258 if (ret) {
1259 goto end;
1260 }
1261 td->metadata_string = buf;
1262 td->metadata_packetized = 1;
1263 } else {
1264 if (!append) {
1265 unsigned int major, minor;
1266 ssize_t nr_items;
1267
1268 td->byte_order = BYTE_ORDER;
1269
1270 /* Check text-only metadata header and version */
1271 nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
1272 if (nr_items < 2)
1273 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1274 if (check_version(major, minor) < 0) {
1275 ret = -EINVAL;
1276 goto end;
1277 }
1278 rewind(fp);
1279 }
1280 }
1281
1282 ret = ctf_scanner_append_ast(scanner, fp);
1283 if (ret) {
1284 fprintf(stderr, "[error] Error creating AST\n");
1285 goto end;
1286 }
1287
1288 if (babeltrace_debug) {
1289 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1290 if (ret) {
1291 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1292 goto end;
1293 }
1294 }
1295
1296 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1297 if (ret) {
1298 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1299 goto end;
1300 }
1301 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1302 td, td->byte_order);
1303 if (ret) {
1304 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1305 goto end;
1306 }
1307 end:
1308 if (fp) {
1309 closeret = fclose(fp);
1310 if (closeret) {
1311 perror("Error on fclose");
1312 }
1313 }
1314 end_stream:
1315 if (metadata_stream->pos.fd >= 0) {
1316 closeret = close(metadata_stream->pos.fd);
1317 if (closeret) {
1318 perror("Error on metadata stream fd close");
1319 }
1320 }
1321 end_free:
1322 if (ret)
1323 g_free(metadata_stream);
1324 return ret;
1325 }
1326
1327 static
1328 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1329 struct ctf_stream_definition *stream,
1330 struct ctf_event_declaration *event)
1331 {
1332 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1333
1334 if (event->context_decl) {
1335 struct bt_definition *definition =
1336 event->context_decl->p.definition_new(&event->context_decl->p,
1337 stream->parent_def_scope, 0, 0, "event.context");
1338 if (!definition) {
1339 goto error;
1340 }
1341 stream_event->event_context = container_of(definition,
1342 struct definition_struct, p);
1343 stream->parent_def_scope = stream_event->event_context->p.scope;
1344 }
1345 if (event->fields_decl) {
1346 struct bt_definition *definition =
1347 event->fields_decl->p.definition_new(&event->fields_decl->p,
1348 stream->parent_def_scope, 0, 0, "event.fields");
1349 if (!definition) {
1350 goto error;
1351 }
1352 stream_event->event_fields = container_of(definition,
1353 struct definition_struct, p);
1354 stream->parent_def_scope = stream_event->event_fields->p.scope;
1355 }
1356 stream_event->stream = stream;
1357 return stream_event;
1358
1359 error:
1360 if (stream_event->event_fields)
1361 bt_definition_unref(&stream_event->event_fields->p);
1362 if (stream_event->event_context)
1363 bt_definition_unref(&stream_event->event_context->p);
1364 fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n",
1365 g_quark_to_string(event->name));
1366 return NULL;
1367 }
1368
1369 static
1370 int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td,
1371 struct ctf_stream_declaration *stream_class,
1372 struct ctf_stream_definition *stream)
1373 {
1374 size_t def_size, class_size, i;
1375 int ret = 0;
1376
1377 def_size = stream->events_by_id->len;
1378 class_size = stream_class->events_by_id->len;
1379
1380 g_ptr_array_set_size(stream->events_by_id, class_size);
1381 for (i = def_size; i < class_size; i++) {
1382 struct ctf_event_declaration *event =
1383 g_ptr_array_index(stream_class->events_by_id, i);
1384 struct ctf_event_definition *stream_event;
1385
1386 if (!event)
1387 continue;
1388 stream_event = create_event_definitions(td, stream, event);
1389 if (!stream_event) {
1390 ret = -EINVAL;
1391 goto error;
1392 }
1393 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1394 }
1395 error:
1396 return ret;
1397 }
1398
1399 static
1400 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1401 {
1402 struct ctf_stream_declaration *stream_class;
1403 int ret;
1404 int i;
1405
1406 if (stream->stream_definitions_created)
1407 return 0;
1408
1409 stream_class = stream->stream_class;
1410
1411 if (stream_class->packet_context_decl) {
1412 struct bt_definition *definition =
1413 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1414 stream->parent_def_scope, 0, 0, "stream.packet.context");
1415 if (!definition) {
1416 ret = -EINVAL;
1417 goto error;
1418 }
1419 stream->stream_packet_context = container_of(definition,
1420 struct definition_struct, p);
1421 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1422 }
1423 if (stream_class->event_header_decl) {
1424 struct bt_definition *definition =
1425 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1426 stream->parent_def_scope, 0, 0, "stream.event.header");
1427 if (!definition) {
1428 ret = -EINVAL;
1429 goto error;
1430 }
1431 stream->stream_event_header =
1432 container_of(definition, struct definition_struct, p);
1433 stream->parent_def_scope = stream->stream_event_header->p.scope;
1434 }
1435 if (stream_class->event_context_decl) {
1436 struct bt_definition *definition =
1437 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1438 stream->parent_def_scope, 0, 0, "stream.event.context");
1439 if (!definition) {
1440 ret = -EINVAL;
1441 goto error;
1442 }
1443 stream->stream_event_context =
1444 container_of(definition, struct definition_struct, p);
1445 stream->parent_def_scope = stream->stream_event_context->p.scope;
1446 }
1447 stream->events_by_id = g_ptr_array_new();
1448 ret = copy_event_declarations_stream_class_to_stream(td,
1449 stream_class, stream);
1450 if (ret)
1451 goto error_event;
1452 return 0;
1453
1454 error_event:
1455 for (i = 0; i < stream->events_by_id->len; i++) {
1456 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1457 if (stream_event)
1458 g_free(stream_event);
1459 }
1460 g_ptr_array_free(stream->events_by_id, TRUE);
1461 error:
1462 if (stream->stream_event_context)
1463 bt_definition_unref(&stream->stream_event_context->p);
1464 if (stream->stream_event_header)
1465 bt_definition_unref(&stream->stream_event_header->p);
1466 if (stream->stream_packet_context)
1467 bt_definition_unref(&stream->stream_packet_context->p);
1468 fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n",
1469 stream_class->stream_id, strerror(-ret));
1470 return ret;
1471 }
1472
1473 static
1474 int stream_assign_class(struct ctf_trace *td,
1475 struct ctf_file_stream *file_stream,
1476 uint64_t stream_id)
1477 {
1478 struct ctf_stream_declaration *stream;
1479 int ret;
1480
1481 file_stream->parent.stream_id = stream_id;
1482 if (stream_id >= td->streams->len) {
1483 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1484 return -EINVAL;
1485 }
1486 stream = g_ptr_array_index(td->streams, stream_id);
1487 if (!stream) {
1488 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1489 return -EINVAL;
1490 }
1491 file_stream->parent.stream_class = stream;
1492 ret = create_stream_definitions(td, &file_stream->parent);
1493 if (ret)
1494 return ret;
1495 return 0;
1496 }
1497
1498 static
1499 int create_stream_one_packet_index(struct ctf_stream_pos *pos,
1500 struct ctf_trace *td,
1501 struct ctf_file_stream *file_stream,
1502 size_t filesize)
1503 {
1504 struct packet_index packet_index;
1505 uint64_t stream_id = 0;
1506 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
1507 int first_packet = 0;
1508 int len_index;
1509 int ret;
1510
1511 begin:
1512 if (!pos->mmap_offset) {
1513 first_packet = 1;
1514 }
1515
1516 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
1517 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
1518 }
1519
1520 if (pos->base_mma) {
1521 /* unmap old base */
1522 ret = munmap_align(pos->base_mma);
1523 if (ret) {
1524 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1525 strerror(errno));
1526 return ret;
1527 }
1528 pos->base_mma = NULL;
1529 }
1530 /* map new base. Need mapping length from header. */
1531 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
1532 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1533 assert(pos->base_mma != MAP_FAILED);
1534 /*
1535 * Use current mapping size as temporary content and packet
1536 * size.
1537 */
1538 pos->content_size = packet_map_len;
1539 pos->packet_size = packet_map_len;
1540 pos->offset = 0; /* Position of the packet header */
1541
1542 packet_index.offset = pos->mmap_offset;
1543 packet_index.content_size = 0;
1544 packet_index.packet_size = 0;
1545 packet_index.ts_real.timestamp_begin = 0;
1546 packet_index.ts_real.timestamp_end = 0;
1547 packet_index.ts_cycles.timestamp_begin = 0;
1548 packet_index.ts_cycles.timestamp_end = 0;
1549 packet_index.events_discarded = 0;
1550 packet_index.events_discarded_len = 0;
1551
1552 /* read and check header, set stream id (and check) */
1553 if (file_stream->parent.trace_packet_header) {
1554 /* Read packet header */
1555 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1556 if (ret) {
1557 if (ret == -EFAULT)
1558 goto retry;
1559 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1560 return ret;
1561 }
1562 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1563 if (len_index >= 0) {
1564 struct bt_definition *field;
1565 uint64_t magic;
1566
1567 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1568 magic = bt_get_unsigned_int(field);
1569 if (magic != CTF_MAGIC) {
1570 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1571 magic,
1572 file_stream->pos.packet_index->len,
1573 (ssize_t) pos->mmap_offset);
1574 return -EINVAL;
1575 }
1576 }
1577
1578 /* check uuid */
1579 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1580 if (len_index >= 0) {
1581 struct definition_array *defarray;
1582 struct bt_definition *field;
1583 uint64_t i;
1584 uint8_t uuidval[BABELTRACE_UUID_LEN];
1585
1586 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1587 assert(field->declaration->id == CTF_TYPE_ARRAY);
1588 defarray = container_of(field, struct definition_array, p);
1589 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1590
1591 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1592 struct bt_definition *elem;
1593
1594 elem = bt_array_index(defarray, i);
1595 uuidval[i] = bt_get_unsigned_int(elem);
1596 }
1597 ret = bt_uuid_compare(td->uuid, uuidval);
1598 if (ret) {
1599 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1600 return -EINVAL;
1601 }
1602 }
1603
1604 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1605 if (len_index >= 0) {
1606 struct bt_definition *field;
1607
1608 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1609 stream_id = bt_get_unsigned_int(field);
1610 }
1611 }
1612
1613 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1614 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1615 stream_id,
1616 file_stream->parent.stream_id);
1617 return -EINVAL;
1618 }
1619 if (first_packet) {
1620 ret = stream_assign_class(td, file_stream, stream_id);
1621 if (ret)
1622 return ret;
1623 }
1624
1625 if (file_stream->parent.stream_packet_context) {
1626 /* Read packet context */
1627 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1628 if (ret) {
1629 if (ret == -EFAULT)
1630 goto retry;
1631 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1632 return ret;
1633 }
1634 /* read packet size from header */
1635 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1636 if (len_index >= 0) {
1637 struct bt_definition *field;
1638
1639 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1640 packet_index.packet_size = bt_get_unsigned_int(field);
1641 } else {
1642 /* Use file size for packet size */
1643 packet_index.packet_size = filesize * CHAR_BIT;
1644 }
1645
1646 /* read content size from header */
1647 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1648 if (len_index >= 0) {
1649 struct bt_definition *field;
1650
1651 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1652 packet_index.content_size = bt_get_unsigned_int(field);
1653 } else {
1654 /* Use packet size if non-zero, else file size */
1655 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1656 }
1657
1658 /* read timestamp begin from header */
1659 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1660 if (len_index >= 0) {
1661 struct bt_definition *field;
1662
1663 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1664 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1665 if (file_stream->parent.stream_class->trace->parent.collection) {
1666 packet_index.ts_real.timestamp_begin =
1667 ctf_get_real_timestamp(
1668 &file_stream->parent,
1669 packet_index.ts_cycles.timestamp_begin);
1670 }
1671 }
1672
1673 /* read timestamp end from header */
1674 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1675 if (len_index >= 0) {
1676 struct bt_definition *field;
1677
1678 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1679 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1680 if (file_stream->parent.stream_class->trace->parent.collection) {
1681 packet_index.ts_real.timestamp_end =
1682 ctf_get_real_timestamp(
1683 &file_stream->parent,
1684 packet_index.ts_cycles.timestamp_end);
1685 }
1686 }
1687
1688 /* read events discarded from header */
1689 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1690 if (len_index >= 0) {
1691 struct bt_definition *field;
1692
1693 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1694 packet_index.events_discarded = bt_get_unsigned_int(field);
1695 packet_index.events_discarded_len = bt_get_int_len(field);
1696 }
1697 } else {
1698 /* Use file size for packet size */
1699 packet_index.packet_size = filesize * CHAR_BIT;
1700 /* Use packet size if non-zero, else file size */
1701 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1702 }
1703
1704 /* Validate content size and packet size values */
1705 if (packet_index.content_size > packet_index.packet_size) {
1706 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1707 packet_index.content_size, packet_index.packet_size);
1708 return -EINVAL;
1709 }
1710
1711 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1712 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1713 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1714 return -EINVAL;
1715 }
1716
1717 if (packet_index.content_size < pos->offset) {
1718 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1719 return -EINVAL;
1720 }
1721
1722 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1723 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1724 return -EINVAL;
1725 }
1726
1727 /* Save position after header and context */
1728 packet_index.data_offset = pos->offset;
1729
1730 /* add index to packet array */
1731 g_array_append_val(file_stream->pos.packet_index, packet_index);
1732
1733 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1734
1735 return 0;
1736
1737 /* Retry with larger mapping */
1738 retry:
1739 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1740 /*
1741 * Reached EOF, but still expecting header/context data.
1742 */
1743 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1744 return -EFAULT;
1745 }
1746 /* Double the mapping len, and retry */
1747 tmp_map_len = packet_map_len << 1;
1748 if (tmp_map_len >> 1 != packet_map_len) {
1749 /* Overflow */
1750 fprintf(stderr, "[error] Packet mapping length overflow\n");
1751 return -EFAULT;
1752 }
1753 packet_map_len = tmp_map_len;
1754 goto begin;
1755 }
1756
1757 static
1758 int create_stream_packet_index(struct ctf_trace *td,
1759 struct ctf_file_stream *file_stream)
1760 {
1761 struct ctf_stream_pos *pos;
1762 struct stat filestats;
1763 int ret;
1764
1765 pos = &file_stream->pos;
1766
1767 ret = fstat(pos->fd, &filestats);
1768 if (ret < 0)
1769 return ret;
1770
1771 /* Deal with empty files */
1772 if (!filestats.st_size) {
1773 if (file_stream->parent.trace_packet_header
1774 || file_stream->parent.stream_packet_context) {
1775 /*
1776 * We expect a trace packet header and/or stream packet
1777 * context. Since a trace needs to have at least one
1778 * packet, empty files are therefore not accepted.
1779 */
1780 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1781 return -EINVAL;
1782 } else {
1783 /*
1784 * Without trace packet header nor stream packet
1785 * context, a one-packet trace can indeed be empty. This
1786 * is only valid if there is only one stream class: 0.
1787 */
1788 ret = stream_assign_class(td, file_stream, 0);
1789 if (ret)
1790 return ret;
1791 return 0;
1792 }
1793 }
1794
1795 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1796 ret = create_stream_one_packet_index(pos, td, file_stream,
1797 filestats.st_size);
1798 if (ret)
1799 return ret;
1800 }
1801 return 0;
1802 }
1803
1804 static
1805 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1806 {
1807 int ret;
1808
1809 if (td->packet_header_decl) {
1810 struct bt_definition *definition =
1811 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1812 stream->parent_def_scope, 0, 0, "trace.packet.header");
1813 if (!definition) {
1814 ret = -EINVAL;
1815 goto error;
1816 }
1817 stream->trace_packet_header =
1818 container_of(definition, struct definition_struct, p);
1819 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1820 }
1821
1822 return 0;
1823
1824 error:
1825 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1826 return ret;
1827 }
1828
1829 static
1830 int import_stream_packet_index(struct ctf_trace *td,
1831 struct ctf_file_stream *file_stream)
1832 {
1833 struct ctf_stream_pos *pos;
1834 struct ctf_packet_index *ctf_index = NULL;
1835 struct ctf_packet_index_file_hdr index_hdr;
1836 struct packet_index index;
1837 uint32_t packet_index_len;
1838 int ret = 0;
1839 int first_packet = 1;
1840 size_t len;
1841
1842 pos = &file_stream->pos;
1843
1844 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1845 if (len != 1) {
1846 perror("read index file header");
1847 goto error;
1848 }
1849
1850 /* Check the index header */
1851 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1852 fprintf(stderr, "[error] wrong index magic\n");
1853 ret = -1;
1854 goto error;
1855 }
1856 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1857 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1858 ".%" PRIu32 ", supported %d.%d\n",
1859 be32toh(index_hdr.index_major),
1860 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1861 CTF_INDEX_MINOR);
1862 ret = -1;
1863 goto error;
1864 }
1865 packet_index_len = be32toh(index_hdr.packet_index_len);
1866 if (packet_index_len == 0) {
1867 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1868 ret = -1;
1869 goto error;
1870 }
1871 /*
1872 * Allocate the index length found in header, not internal
1873 * representation.
1874 */
1875 ctf_index = g_malloc0(packet_index_len);
1876 while (fread(ctf_index, packet_index_len, 1,
1877 pos->index_fp) == 1) {
1878 uint64_t stream_id;
1879 struct ctf_stream_declaration *stream = NULL;
1880
1881 memset(&index, 0, sizeof(index));
1882 index.offset = be64toh(ctf_index->offset);
1883 index.packet_size = be64toh(ctf_index->packet_size);
1884 index.content_size = be64toh(ctf_index->content_size);
1885 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
1886 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
1887 index.events_discarded = be64toh(ctf_index->events_discarded);
1888 index.events_discarded_len = 64;
1889 index.data_offset = -1;
1890 stream_id = be64toh(ctf_index->stream_id);
1891
1892 if (!first_packet) {
1893 /* add index to packet array */
1894 g_array_append_val(file_stream->pos.packet_index, index);
1895 continue;
1896 }
1897
1898 file_stream->parent.stream_id = stream_id;
1899 if (stream_id < td->streams->len) {
1900 stream = g_ptr_array_index(td->streams, stream_id);
1901 }
1902 if (!stream) {
1903 fprintf(stderr, "[error] Stream %" PRIu64
1904 " is not declared in metadata.\n",
1905 stream_id);
1906 ret = -EINVAL;
1907 goto error;
1908 }
1909 file_stream->parent.stream_class = stream;
1910 ret = create_stream_definitions(td, &file_stream->parent);
1911 if (ret)
1912 goto error;
1913 first_packet = 0;
1914 /* add index to packet array */
1915 g_array_append_val(file_stream->pos.packet_index, index);
1916 }
1917
1918 /* Index containing only the header. */
1919 if (!file_stream->parent.stream_class) {
1920 ret = -1;
1921 goto error;
1922 }
1923
1924 ret = 0;
1925
1926 error:
1927 g_free(ctf_index);
1928 return ret;
1929 }
1930
1931 /*
1932 * Note: many file streams can inherit from the same stream class
1933 * description (metadata).
1934 */
1935 static
1936 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1937 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
1938 int whence))
1939 {
1940 int ret, fd, closeret;
1941 struct ctf_file_stream *file_stream;
1942 struct stat statbuf;
1943 char *index_name;
1944
1945 fd = openat(td->dirfd, path, flags);
1946 if (fd < 0) {
1947 perror("File stream openat()");
1948 ret = fd;
1949 goto error;
1950 }
1951
1952 /* Don't try to mmap subdirectories. Skip them, return success. */
1953 ret = fstat(fd, &statbuf);
1954 if (ret) {
1955 perror("File stream fstat()");
1956 goto fstat_error;
1957 }
1958 if (S_ISDIR(statbuf.st_mode)) {
1959 if (strncmp(path, "index", 5) != 0) {
1960 fprintf(stderr, "[warning] Skipping directory '%s' "
1961 "found in trace\n", path);
1962 }
1963 ret = 0;
1964 goto fd_is_dir_ok;
1965 }
1966 if (!statbuf.st_size) {
1967 /** Skip empty files. */
1968 ret = 0;
1969 goto fd_is_empty_file;
1970 }
1971
1972 file_stream = g_new0(struct ctf_file_stream, 1);
1973 file_stream->pos.last_offset = LAST_OFFSET_POISON;
1974 file_stream->pos.fd = -1;
1975 file_stream->pos.index_fp = NULL;
1976
1977 strncpy(file_stream->parent.path, path, PATH_MAX);
1978 file_stream->parent.path[PATH_MAX - 1] = '\0';
1979
1980 if (packet_seek) {
1981 file_stream->pos.packet_seek = packet_seek;
1982 } else {
1983 fprintf(stderr, "[error] packet_seek function undefined.\n");
1984 ret = -1;
1985 goto error_def;
1986 }
1987
1988 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
1989 if (ret)
1990 goto error_def;
1991 ret = create_trace_definitions(td, &file_stream->parent);
1992 if (ret)
1993 goto error_def;
1994 /*
1995 * For now, only a single clock per trace is supported.
1996 */
1997 file_stream->parent.current_clock = td->parent.single_clock;
1998
1999 /*
2000 * Allocate the index name for this stream and try to open it.
2001 */
2002 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2003 if (!index_name) {
2004 fprintf(stderr, "[error] Cannot allocate index filename\n");
2005 ret = -ENOMEM;
2006 goto error_def;
2007 }
2008 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2009 INDEX_PATH, path);
2010
2011 if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) {
2012 ret = create_stream_packet_index(td, file_stream);
2013 if (ret) {
2014 fprintf(stderr, "[error] Stream index creation error.\n");
2015 goto error_index;
2016 }
2017 } else {
2018 ret = openat(td->dirfd, index_name, flags);
2019 if (ret < 0) {
2020 perror("Index file openat()");
2021 ret = -1;
2022 goto error_free;
2023 }
2024 file_stream->pos.index_fp = fdopen(ret, "r");
2025 if (!file_stream->pos.index_fp) {
2026 perror("fdopen() error");
2027 goto error_free;
2028 }
2029 ret = import_stream_packet_index(td, file_stream);
2030 if (ret) {
2031 ret = -1;
2032 goto error_index;
2033 }
2034 ret = fclose(file_stream->pos.index_fp);
2035 if (ret < 0) {
2036 perror("close index");
2037 goto error_free;
2038 }
2039 }
2040 free(index_name);
2041
2042 /* Add stream file to stream class */
2043 g_ptr_array_add(file_stream->parent.stream_class->streams,
2044 &file_stream->parent);
2045 return 0;
2046
2047 error_index:
2048 if (file_stream->pos.index_fp) {
2049 ret = fclose(file_stream->pos.index_fp);
2050 if (ret < 0) {
2051 perror("close index");
2052 }
2053 }
2054 if (file_stream->parent.trace_packet_header)
2055 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2056 error_free:
2057 free(index_name);
2058 error_def:
2059 closeret = ctf_fini_pos(&file_stream->pos);
2060 if (closeret) {
2061 fprintf(stderr, "Error on ctf_fini_pos\n");
2062 }
2063 g_free(file_stream);
2064 fd_is_empty_file:
2065 fd_is_dir_ok:
2066 fstat_error:
2067 closeret = close(fd);
2068 if (closeret) {
2069 perror("Error on fd close");
2070 }
2071 error:
2072 return ret;
2073 }
2074
2075 static
2076 int ctf_open_trace_read(struct ctf_trace *td,
2077 const char *path, int flags,
2078 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2079 int whence), FILE *metadata_fp)
2080 {
2081 struct ctf_scanner *scanner;
2082 int ret, closeret;
2083 struct dirent *dirent;
2084 struct dirent *diriter;
2085 size_t dirent_len;
2086 char *ext;
2087
2088 td->flags = flags;
2089
2090 /* Open trace directory */
2091 td->dir = opendir(path);
2092 if (!td->dir) {
2093 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2094 ret = -ENOENT;
2095 goto error;
2096 }
2097
2098 td->dirfd = open(path, 0);
2099 if (td->dirfd < 0) {
2100 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2101 perror("Trace directory open");
2102 ret = -errno;
2103 goto error_dirfd;
2104 }
2105 strncpy(td->parent.path, path, sizeof(td->parent.path));
2106 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2107
2108 /*
2109 * Keep the metadata file separate.
2110 * Keep scanner object local to the open. We don't support
2111 * incremental metadata append for on-disk traces.
2112 */
2113 scanner = ctf_scanner_alloc();
2114 if (!scanner) {
2115 fprintf(stderr, "[error] Error allocating scanner\n");
2116 ret = -ENOMEM;
2117 goto error_metadata;
2118 }
2119 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2120 ctf_scanner_free(scanner);
2121 if (ret) {
2122 if (ret == -ENOENT) {
2123 fprintf(stderr, "[warning] Empty metadata.\n");
2124 }
2125 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2126 goto error_metadata;
2127 }
2128
2129 /*
2130 * Open each stream: for each file, try to open, check magic
2131 * number, and get the stream ID to add to the right location in
2132 * the stream array.
2133 */
2134
2135 dirent_len = offsetof(struct dirent, d_name) +
2136 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2137
2138 dirent = malloc(dirent_len);
2139
2140 for (;;) {
2141 ret = readdir_r(td->dir, dirent, &diriter);
2142 if (ret) {
2143 fprintf(stderr, "[error] Readdir error.\n");
2144 goto readdir_error;
2145 }
2146 if (!diriter)
2147 break;
2148 /* Ignore hidden files, ., .. and metadata. */
2149 if (!strncmp(diriter->d_name, ".", 1)
2150 || !strcmp(diriter->d_name, "..")
2151 || !strcmp(diriter->d_name, "metadata"))
2152 continue;
2153
2154 /* Ignore index files : *.idx */
2155 ext = strrchr(diriter->d_name, '.');
2156 if (ext && (!strcmp(ext, ".idx"))) {
2157 continue;
2158 }
2159
2160 ret = ctf_open_file_stream_read(td, diriter->d_name,
2161 flags, packet_seek);
2162 if (ret) {
2163 fprintf(stderr, "[error] Open file stream error.\n");
2164 goto readdir_error;
2165 }
2166 }
2167
2168 free(dirent);
2169 return 0;
2170
2171 readdir_error:
2172 free(dirent);
2173 error_metadata:
2174 closeret = close(td->dirfd);
2175 if (closeret) {
2176 perror("Error on fd close");
2177 }
2178 error_dirfd:
2179 closeret = closedir(td->dir);
2180 if (closeret) {
2181 perror("Error on closedir");
2182 }
2183 error:
2184 return ret;
2185 }
2186
2187 /*
2188 * ctf_open_trace: Open a CTF trace and index it.
2189 * Note that the user must seek the trace after the open (using the iterator)
2190 * since the index creation read it entirely.
2191 */
2192 static
2193 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2194 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2195 int whence), FILE *metadata_fp)
2196 {
2197 struct ctf_trace *td;
2198 int ret;
2199
2200 /*
2201 * If packet_seek is NULL, we provide our default version.
2202 */
2203 if (!packet_seek)
2204 packet_seek = ctf_packet_seek;
2205
2206 td = g_new0(struct ctf_trace, 1);
2207
2208 switch (flags & O_ACCMODE) {
2209 case O_RDONLY:
2210 if (!path) {
2211 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2212 goto error;
2213 }
2214 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2215 if (ret)
2216 goto error;
2217 break;
2218 case O_RDWR:
2219 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2220 goto error;
2221 default:
2222 fprintf(stderr, "[error] Incorrect open flags.\n");
2223 goto error;
2224 }
2225
2226 return &td->parent;
2227 error:
2228 g_free(td);
2229 return NULL;
2230 }
2231
2232 static
2233 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2234 struct bt_mmap_stream *mmap_info)
2235 {
2236 pos->mmap_offset = 0;
2237 pos->packet_size = 0;
2238 pos->content_size = 0;
2239 pos->content_size_loc = NULL;
2240 pos->fd = mmap_info->fd;
2241 pos->base_mma = NULL;
2242 pos->offset = 0;
2243 pos->dummy = false;
2244 pos->cur_index = 0;
2245 pos->prot = PROT_READ;
2246 pos->flags = MAP_PRIVATE;
2247 pos->parent.rw_table = read_dispatch_table;
2248 pos->parent.event_cb = ctf_read_event;
2249 pos->priv = mmap_info->priv;
2250 pos->packet_index = g_array_new(FALSE, TRUE,
2251 sizeof(struct packet_index));
2252 }
2253
2254 static
2255 int prepare_mmap_stream_definition(struct ctf_trace *td,
2256 struct ctf_file_stream *file_stream,
2257 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2258 int whence))
2259 {
2260 struct ctf_stream_declaration *stream;
2261 uint64_t stream_id;
2262 int ret;
2263
2264 /* Ask for the first packet to get the stream_id. */
2265 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2266 stream_id = file_stream->parent.stream_id;
2267 if (stream_id >= td->streams->len) {
2268 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2269 "in metadata.\n", stream_id);
2270 ret = -EINVAL;
2271 goto end;
2272 }
2273 stream = g_ptr_array_index(td->streams, stream_id);
2274 if (!stream) {
2275 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2276 "in metadata.\n", stream_id);
2277 ret = -EINVAL;
2278 goto end;
2279 }
2280 file_stream->parent.stream_class = stream;
2281 ret = create_stream_definitions(td, &file_stream->parent);
2282 end:
2283 return ret;
2284 }
2285
2286 static
2287 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2288 struct bt_mmap_stream *mmap_info,
2289 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2290 int whence))
2291 {
2292 int ret;
2293 struct ctf_file_stream *file_stream;
2294
2295 file_stream = g_new0(struct ctf_file_stream, 1);
2296 file_stream->parent.stream_id = -1ULL;
2297 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2298 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2299
2300 file_stream->pos.packet_seek = packet_seek;
2301
2302 ret = create_trace_definitions(td, &file_stream->parent);
2303 if (ret) {
2304 goto error_def;
2305 }
2306
2307 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2308 if (ret)
2309 goto error_index;
2310
2311 /*
2312 * For now, only a single clock per trace is supported.
2313 */
2314 file_stream->parent.current_clock = td->parent.single_clock;
2315
2316 /* Add stream file to stream class */
2317 g_ptr_array_add(file_stream->parent.stream_class->streams,
2318 &file_stream->parent);
2319 return 0;
2320
2321 error_index:
2322 if (file_stream->parent.trace_packet_header)
2323 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2324 error_def:
2325 g_free(file_stream);
2326 return ret;
2327 }
2328
2329 static
2330 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2331 struct bt_mmap_stream_list *mmap_list,
2332 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2333 int whence),
2334 FILE *metadata_fp)
2335 {
2336 int ret;
2337 struct bt_mmap_stream *mmap_info;
2338
2339 td->scanner = ctf_scanner_alloc();
2340 if (!td->scanner) {
2341 fprintf(stderr, "[error] Error allocating scanner\n");
2342 ret = -ENOMEM;
2343 goto error;
2344 }
2345 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2346 if (ret) {
2347 if (ret == -ENOENT) {
2348 fprintf(stderr, "[warning] Empty metadata.\n");
2349 }
2350 goto error;
2351 }
2352
2353 /*
2354 * for each stream, try to open, check magic number, and get the
2355 * stream ID to add to the right location in the stream array.
2356 */
2357 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2358 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2359 if (ret) {
2360 fprintf(stderr, "[error] Open file mmap stream error.\n");
2361 goto error;
2362 }
2363 }
2364 return 0;
2365
2366 error:
2367 ctf_scanner_free(td->scanner);
2368 return ret;
2369 }
2370
2371 static
2372 struct bt_trace_descriptor *ctf_open_mmap_trace(
2373 struct bt_mmap_stream_list *mmap_list,
2374 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2375 int whence),
2376 FILE *metadata_fp)
2377 {
2378 struct ctf_trace *td;
2379 int ret;
2380
2381 if (!metadata_fp) {
2382 fprintf(stderr, "[error] No metadata file pointer associated, "
2383 "required for mmap parsing\n");
2384 goto error;
2385 }
2386 if (!packet_seek) {
2387 fprintf(stderr, "[error] packet_seek function undefined.\n");
2388 goto error;
2389 }
2390 td = g_new0(struct ctf_trace, 1);
2391 td->dirfd = -1;
2392 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2393 if (ret)
2394 goto error_free;
2395
2396 return &td->parent;
2397
2398 error_free:
2399 g_free(td);
2400 error:
2401 return NULL;
2402 }
2403
2404 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2405 FILE *metadata_fp)
2406 {
2407 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2408 int i, j;
2409 int ret;
2410
2411 if (!td->scanner)
2412 return -EINVAL;
2413 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2414 if (ret)
2415 return ret;
2416 /* for each stream_class */
2417 for (i = 0; i < td->streams->len; i++) {
2418 struct ctf_stream_declaration *stream_class;
2419
2420 stream_class = g_ptr_array_index(td->streams, i);
2421 if (!stream_class)
2422 continue;
2423 /* for each stream */
2424 for (j = 0; j < stream_class->streams->len; j++) {
2425 struct ctf_stream_definition *stream;
2426
2427 stream = g_ptr_array_index(stream_class->streams, j);
2428 if (!stream)
2429 continue;
2430 ret = copy_event_declarations_stream_class_to_stream(td,
2431 stream_class, stream);
2432 if (ret)
2433 return ret;
2434 }
2435 }
2436 return 0;
2437 }
2438
2439 static
2440 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2441 {
2442 int i, j, k;
2443 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2444
2445 /* for each stream_class */
2446 for (i = 0; i < td->streams->len; i++) {
2447 struct ctf_stream_declaration *stream_class;
2448
2449 stream_class = g_ptr_array_index(td->streams, i);
2450 if (!stream_class)
2451 continue;
2452 /* for each file_stream */
2453 for (j = 0; j < stream_class->streams->len; j++) {
2454 struct ctf_stream_definition *stream;
2455 struct ctf_stream_pos *stream_pos;
2456 struct ctf_file_stream *cfs;
2457
2458 stream = g_ptr_array_index(stream_class->streams, j);
2459 if (!stream)
2460 continue;
2461 cfs = container_of(stream, struct ctf_file_stream,
2462 parent);
2463 stream_pos = &cfs->pos;
2464 if (!stream_pos->packet_index)
2465 continue;
2466
2467 for (k = 0; k < stream_pos->packet_index->len; k++) {
2468 struct packet_index *index;
2469
2470 index = &g_array_index(stream_pos->packet_index,
2471 struct packet_index, k);
2472 index->ts_real.timestamp_begin =
2473 ctf_get_real_timestamp(stream,
2474 index->ts_cycles.timestamp_begin);
2475 index->ts_real.timestamp_end =
2476 ctf_get_real_timestamp(stream,
2477 index->ts_cycles.timestamp_end);
2478 }
2479 }
2480 }
2481 return 0;
2482 }
2483
2484 static
2485 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2486 {
2487 int ret;
2488
2489 ret = ctf_fini_pos(&file_stream->pos);
2490 if (ret) {
2491 fprintf(stderr, "Error on ctf_fini_pos\n");
2492 return -1;
2493 }
2494 if (file_stream->pos.fd >= 0) {
2495 ret = close(file_stream->pos.fd);
2496 if (ret) {
2497 perror("Error closing file fd");
2498 return -1;
2499 }
2500 }
2501 return 0;
2502 }
2503
2504 static
2505 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2506 {
2507 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2508 int ret;
2509
2510 if (td->streams) {
2511 int i;
2512
2513 for (i = 0; i < td->streams->len; i++) {
2514 struct ctf_stream_declaration *stream;
2515 int j;
2516
2517 stream = g_ptr_array_index(td->streams, i);
2518 if (!stream)
2519 continue;
2520 for (j = 0; j < stream->streams->len; j++) {
2521 struct ctf_file_stream *file_stream;
2522 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2523 struct ctf_file_stream, parent);
2524 ret = ctf_close_file_stream(file_stream);
2525 if (ret)
2526 return ret;
2527 }
2528 }
2529 }
2530 ctf_destroy_metadata(td);
2531 ctf_scanner_free(td->scanner);
2532 if (td->dirfd >= 0) {
2533 ret = close(td->dirfd);
2534 if (ret) {
2535 perror("Error closing dirfd");
2536 return ret;
2537 }
2538 }
2539 if (td->dir) {
2540 ret = closedir(td->dir);
2541 if (ret) {
2542 perror("Error closedir");
2543 return ret;
2544 }
2545 }
2546 free(td->metadata_string);
2547 g_free(td);
2548 return 0;
2549 }
2550
2551 static
2552 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2553 struct bt_context *ctx)
2554 {
2555 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2556 parent);
2557
2558 td->parent.ctx = ctx;
2559 }
2560
2561 static
2562 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2563 struct bt_trace_handle *handle)
2564 {
2565 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2566 parent);
2567
2568 td->parent.handle = handle;
2569 }
2570
2571 static
2572 void __attribute__((constructor)) ctf_init(void)
2573 {
2574 int ret;
2575
2576 ctf_format.name = g_quark_from_static_string("ctf");
2577 ret = bt_register_format(&ctf_format);
2578 assert(!ret);
2579 }
2580
2581 static
2582 void __attribute__((destructor)) ctf_exit(void)
2583 {
2584 bt_unregister_format(&ctf_format);
2585 }
BabelTrace - Trace Format Babel Tower
This page took 0.079548 seconds and 5 git commands to generate.