projects / babeltrace.git / blob
? search:


0cdce8ef48ea365d323eeb23007448a2eeaad352
[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/format-internal.h>
31 #include <babeltrace/ctf/types.h>
32 #include <babeltrace/ctf/metadata.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf/events-internal.h>
35 #include <babeltrace/trace-handle-internal.h>
36 #include <babeltrace/context-internal.h>
37 #include <babeltrace/compat/uuid.h>
38 #include <babeltrace/endian.h>
39 #include <babeltrace/trace-debug-info.h>
40 #include <babeltrace/ctf/ctf-index.h>
41 #include <inttypes.h>
42 #include <stdio.h>
43 #include <sys/mman.h>
44 #include <errno.h>
45 #include <sys/types.h>
46 #include <sys/stat.h>
47 #include <fcntl.h>
48 #include <dirent.h>
49 #include <glib.h>
50 #include <unistd.h>
51 #include <stdlib.h>
52
53 #include "metadata/ctf-scanner.h"
54 #include "metadata/ctf-parser.h"
55 #include "metadata/ctf-ast.h"
56 #include "events-private.h"
57 #include <babeltrace/compat/memstream.h>
58 #include <babeltrace/compat/fcntl.h>
59
60 #define LOG2_CHAR_BIT 3
61
62 /*
63 * Length of first attempt at mapping a packet header, in bits.
64 */
65 #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT)
66
67 /*
68 * Lenght of packet to write, in bits.
69 */
70 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
71
72 #define NSEC_PER_SEC 1000000000ULL
73
74 #define INDEX_PATH "./index/%s.idx"
75
76 int opt_clock_cycles,
77 opt_clock_seconds,
78 opt_clock_date,
79 opt_clock_gmt;
80
81 uint64_t opt_clock_offset;
82 uint64_t opt_clock_offset_ns;
83
84 extern int yydebug;
85 char *opt_debug_info_dir;
86 char *opt_debug_info_target_prefix;
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 * Lost packets occur if the tracer overwrote some subbuffer(s) before the
426 * consumer had time to extract them. We keep track of those gaps with the
427 * packet sequence number in each packet.
428 */
429 void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream)
430 {
431 if ((!stream->events_discarded && !stream->packets_lost) ||
432 !babeltrace_ctf_console_output) {
433 return;
434 }
435 fflush(stdout);
436 if (stream->events_discarded) {
437 fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [",
438 stream->events_discarded);
439 } else if (stream->packets_lost) {
440 fprintf(fp, "[warning] Tracer lost %" PRIu64 " trace packets between [",
441 stream->packets_lost);
442 }
443 if (opt_clock_cycles) {
444 ctf_print_timestamp(fp, stream,
445 stream->prev.cycles.end);
446 fprintf(fp, "] and [");
447 ctf_print_timestamp(fp, stream,
448 stream->current.cycles.end);
449 } else {
450 ctf_print_timestamp(fp, stream,
451 stream->prev.real.end);
452 fprintf(fp, "] and [");
453 ctf_print_timestamp(fp, stream,
454 stream->current.real.end);
455 }
456 fprintf(fp, "] in trace UUID ");
457 print_uuid(fp, stream->stream_class->trace->uuid);
458 if (stream->stream_class->trace->parent.path[0])
459 fprintf(fp, ", at path: \"%s\"",
460 stream->stream_class->trace->parent.path);
461
462 fprintf(fp, ", within stream id %" PRIu64, stream->stream_id);
463 if (stream->path[0])
464 fprintf(fp, ", at relative path: \"%s\"", stream->path);
465 fprintf(fp, ". ");
466 fprintf(fp, "You should consider recording a new trace with larger "
467 "buffers or with fewer events enabled.\n");
468 fflush(fp);
469 }
470
471 static
472 int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream)
473 {
474 struct ctf_stream_pos *pos =
475 container_of(ppos, struct ctf_stream_pos, parent);
476 struct ctf_stream_declaration *stream_class = stream->stream_class;
477 struct ctf_event_definition *event;
478 uint64_t id = 0;
479 int ret;
480
481 /* We need to check for EOF here for empty files. */
482 if (unlikely(pos->offset == EOF))
483 return EOF;
484
485 ctf_pos_get_event(pos);
486
487 /* save the current position as a restore point */
488 pos->last_offset = pos->offset;
489
490 /*
491 * This is the EOF check after we've advanced the position in
492 * ctf_pos_get_event.
493 */
494 if (unlikely(pos->offset == EOF))
495 return EOF;
496
497 /* Stream is inactive for now (live reading). */
498 if (unlikely(pos->content_size == 0))
499 return EAGAIN;
500
501 /*
502 * Packet seeked to by ctf_pos_get_event() only contains
503 * headers, no event. Consider stream as inactive (live
504 * reading).
505 */
506 if (unlikely(pos->data_offset == pos->content_size))
507 return EAGAIN;
508
509 assert(pos->offset < pos->content_size);
510
511 /* Read event header */
512 if (likely(stream->stream_event_header)) {
513 struct definition_integer *integer_definition;
514 struct bt_definition *variant;
515
516 ret = generic_rw(ppos, &stream->stream_event_header->p);
517 if (unlikely(ret))
518 goto error;
519 /* lookup event id */
520 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "id", FALSE);
521 if (integer_definition) {
522 id = integer_definition->value._unsigned;
523 } else {
524 struct definition_enum *enum_definition;
525
526 enum_definition = bt_lookup_enum(&stream->stream_event_header->p, "id", FALSE);
527 if (enum_definition) {
528 id = enum_definition->integer->value._unsigned;
529 }
530 }
531
532 variant = bt_lookup_variant(&stream->stream_event_header->p, "v");
533 if (variant) {
534 integer_definition = bt_lookup_integer(variant, "id", FALSE);
535 if (integer_definition) {
536 id = integer_definition->value._unsigned;
537 }
538 }
539 stream->event_id = id;
540
541 /* lookup timestamp */
542 stream->has_timestamp = 0;
543 integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
544 if (integer_definition) {
545 ctf_update_timestamp(stream, integer_definition);
546 stream->has_timestamp = 1;
547 } else {
548 if (variant) {
549 integer_definition = bt_lookup_integer(variant, "timestamp", FALSE);
550 if (integer_definition) {
551 ctf_update_timestamp(stream, integer_definition);
552 stream->has_timestamp = 1;
553 }
554 }
555 }
556 }
557
558 /* Read stream-declared event context */
559 if (stream->stream_event_context) {
560 ret = generic_rw(ppos, &stream->stream_event_context->p);
561 if (ret)
562 goto error;
563 }
564
565 if (unlikely(id >= stream_class->events_by_id->len)) {
566 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
567 return -EINVAL;
568 }
569 event = g_ptr_array_index(stream->events_by_id, id);
570 if (unlikely(!event)) {
571 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
572 return -EINVAL;
573 }
574
575 /* Read event-declared event context */
576 if (event->event_context) {
577 ret = generic_rw(ppos, &event->event_context->p);
578 if (ret)
579 goto error;
580 }
581
582 /* Read event payload */
583 if (likely(event->event_fields)) {
584 ret = generic_rw(ppos, &event->event_fields->p);
585 if (ret)
586 goto error;
587 }
588
589 if (pos->last_offset == pos->offset) {
590 fprintf(stderr, "[error] Invalid 0 byte event encountered.\n");
591 return -EINVAL;
592 }
593
594 return 0;
595
596 error:
597 fprintf(stderr, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
598 return ret;
599 }
600
601 static
602 int ctf_write_event(struct bt_stream_pos *pos, struct ctf_stream_definition *stream)
603 {
604 struct ctf_stream_declaration *stream_class = stream->stream_class;
605 struct ctf_event_definition *event;
606 uint64_t id;
607 int ret;
608
609 id = stream->event_id;
610
611 /* print event header */
612 if (likely(stream->stream_event_header)) {
613 ret = generic_rw(pos, &stream->stream_event_header->p);
614 if (ret)
615 goto error;
616 }
617
618 /* print stream-declared event context */
619 if (stream->stream_event_context) {
620 ret = generic_rw(pos, &stream->stream_event_context->p);
621 if (ret)
622 goto error;
623 }
624
625 if (unlikely(id >= stream_class->events_by_id->len)) {
626 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
627 return -EINVAL;
628 }
629 event = g_ptr_array_index(stream->events_by_id, id);
630 if (unlikely(!event)) {
631 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
632 return -EINVAL;
633 }
634
635 /* print event-declared event context */
636 if (event->event_context) {
637 ret = generic_rw(pos, &event->event_context->p);
638 if (ret)
639 goto error;
640 }
641
642 /* Read and print event payload */
643 if (likely(event->event_fields)) {
644 ret = generic_rw(pos, &event->event_fields->p);
645 if (ret)
646 goto error;
647 }
648
649 return 0;
650
651 error:
652 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
653 return ret;
654 }
655
656 /*
657 * One side-effect of this function is to unmap pos mmap base if one is
658 * mapped.
659 */
660 static
661 int find_data_offset(struct ctf_stream_pos *pos,
662 struct ctf_file_stream *file_stream,
663 struct packet_index *packet_index)
664 {
665 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
666 struct stat filestats;
667 size_t filesize;
668 int ret;
669
670 pos = &file_stream->pos;
671
672 ret = fstat(pos->fd, &filestats);
673 if (ret < 0)
674 return ret;
675 filesize = filestats.st_size;
676
677 /* Deal with empty files */
678 if (!filesize) {
679 return 0;
680 }
681
682 begin:
683 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
684 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
685 }
686
687 if (pos->base_mma) {
688 /* unmap old base */
689 ret = munmap_align(pos->base_mma);
690 if (ret) {
691 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
692 strerror(errno));
693 return ret;
694 }
695 pos->base_mma = NULL;
696 }
697 /* map new base. Need mapping length from header. */
698 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
699 MAP_PRIVATE, pos->fd, pos->mmap_offset);
700 assert(pos->base_mma != MAP_FAILED);
701
702 pos->content_size = packet_map_len;
703 pos->packet_size = packet_map_len;
704 pos->offset = 0; /* Position of the packet header */
705
706 /* update trace_packet_header and stream_packet_context */
707 if (pos->prot == PROT_READ && file_stream->parent.trace_packet_header) {
708 /* Read packet header */
709 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
710 if (ret) {
711 if (ret == -EFAULT)
712 goto retry;
713 }
714 }
715 if (pos->prot == PROT_READ && file_stream->parent.stream_packet_context) {
716 /* Read packet context */
717 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
718 if (ret) {
719 if (ret == -EFAULT)
720 goto retry;
721 }
722 }
723 packet_index->data_offset = pos->offset;
724
725 /* unmap old base */
726 ret = munmap_align(pos->base_mma);
727 if (ret) {
728 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
729 strerror(errno));
730 return ret;
731 }
732 pos->base_mma = NULL;
733
734 return 0;
735
736 /* Retry with larger mapping */
737 retry:
738 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
739 /*
740 * Reached EOF, but still expecting header/context data.
741 */
742 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
743 return -EFAULT;
744 }
745 /* Double the mapping len, and retry */
746 tmp_map_len = packet_map_len << 1;
747 if (tmp_map_len >> 1 != packet_map_len) {
748 /* Overflow */
749 fprintf(stderr, "[error] Packet mapping length overflow\n");
750 return -EFAULT;
751 }
752 packet_map_len = tmp_map_len;
753 goto begin;
754 }
755
756
757 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
758 int fd, int open_flags)
759 {
760 pos->fd = fd;
761 if (fd >= 0) {
762 pos->packet_index = g_array_new(FALSE, TRUE,
763 sizeof(struct packet_index));
764 } else {
765 pos->packet_index = NULL;
766 }
767 switch (open_flags & O_ACCMODE) {
768 case O_RDONLY:
769 pos->prot = PROT_READ;
770 pos->flags = MAP_PRIVATE;
771 pos->parent.rw_table = read_dispatch_table;
772 pos->parent.event_cb = ctf_read_event;
773 pos->parent.trace = trace;
774 break;
775 case O_RDWR:
776 pos->prot = PROT_READ | PROT_WRITE;
777 pos->flags = MAP_SHARED;
778 pos->parent.rw_table = write_dispatch_table;
779 pos->parent.event_cb = ctf_write_event;
780 pos->parent.trace = trace;
781 if (fd >= 0)
782 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
783 break;
784 default:
785 assert(0);
786 }
787 return 0;
788 }
789
790 int ctf_fini_pos(struct ctf_stream_pos *pos)
791 {
792 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
793 *pos->content_size_loc = pos->offset;
794 if (pos->base_mma) {
795 int ret;
796
797 /* unmap old base */
798 ret = munmap_align(pos->base_mma);
799 if (ret) {
800 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
801 strerror(errno));
802 return -1;
803 }
804 }
805 if (pos->packet_index)
806 (void) g_array_free(pos->packet_index, TRUE);
807 return 0;
808 }
809
810 void ctf_update_current_packet_index(struct ctf_stream_definition *stream,
811 struct packet_index *prev_index,
812 struct packet_index *cur_index)
813 {
814 uint64_t events_discarded_diff;
815 uint64_t packets_lost_diff = 0;
816
817 /* Update packet index time information */
818
819 /* Current packet begin/end */
820 stream->current.real.begin =
821 cur_index->ts_real.timestamp_begin;
822 stream->current.cycles.begin =
823 cur_index->ts_cycles.timestamp_begin;
824 stream->current.real.end =
825 cur_index->ts_real.timestamp_end;
826 stream->current.cycles.end =
827 cur_index->ts_cycles.timestamp_end;
828
829 /* Update packet index discarded event information */
830 events_discarded_diff = cur_index->events_discarded;
831 if (prev_index) {
832 /* Previous packet begin/end */
833 stream->prev.cycles.begin =
834 prev_index->ts_cycles.timestamp_begin;
835 stream->prev.real.begin =
836 prev_index->ts_real.timestamp_begin;
837 stream->prev.cycles.end =
838 prev_index->ts_cycles.timestamp_end;
839 stream->prev.real.end =
840 prev_index->ts_real.timestamp_end;
841
842 events_discarded_diff -= prev_index->events_discarded;
843 /* packet_seq_num stays at 0 if not produced by the tracer */
844 if (cur_index->packet_seq_num) {
845 packets_lost_diff = cur_index->packet_seq_num -
846 prev_index->packet_seq_num - 1;
847 }
848 /*
849 * Deal with 32-bit wrap-around if the tracer provided a
850 * 32-bit field.
851 */
852 if (prev_index->events_discarded_len == 32) {
853 events_discarded_diff = (uint32_t) events_discarded_diff;
854 }
855 } else {
856 /*
857 * First packet: use current packet info as limits for
858 * previous packet.
859 */
860 stream->prev.cycles.begin =
861 stream->prev.cycles.end =
862 stream->current.cycles.begin;
863 stream->prev.real.begin =
864 stream->prev.real.end =
865 stream->current.real.begin;
866 }
867 stream->events_discarded = events_discarded_diff;
868 stream->packets_lost = packets_lost_diff;
869 }
870
871 /*
872 * Find the timerange where all the streams in the trace are active
873 * simultaneously.
874 *
875 * Return 0 and update begin/end if necessary on success, return 1 for
876 * empty streams and return a negative value on error.
877 */
878 static
879 int ctf_find_stream_intersection(struct bt_trace_descriptor *td_read,
880 struct packet_index_time *_real,
881 struct packet_index_time *_cycles)
882 {
883 int stream_id, ret = 0;
884 struct packet_index_time real = { 0, UINT64_MAX },
885 cycles = { 0, UINT64_MAX };
886 struct ctf_trace *tin = container_of(td_read, struct ctf_trace, parent);
887
888 /* At least one of the two return args must be provided. */
889 if (!_real && !_cycles) {
890 ret = -1;
891 goto end;
892 }
893
894 if (tin->streams->len == 0) {
895 ret = 1;
896 goto end;
897 }
898
899 for (stream_id = 0; stream_id < tin->streams->len;
900 stream_id++) {
901 int filenr;
902 struct ctf_stream_declaration *stream_class;
903
904 stream_class = g_ptr_array_index(tin->streams, stream_id);
905 if (!stream_class) {
906 continue;
907 }
908 for (filenr = 0; filenr < stream_class->streams->len; filenr++) {
909 struct ctf_file_stream *file_stream;
910 struct ctf_stream_pos *stream_pos;
911 struct packet_index *index;
912
913 file_stream = g_ptr_array_index(stream_class->streams,
914 filenr);
915 if (!file_stream) {
916 continue;
917 }
918 stream_pos = &file_stream->pos;
919 if (!stream_pos->packet_index ||
920 stream_pos->packet_index->len <= 0) {
921 ret = 1;
922 goto end;
923 }
924 index = &g_array_index(stream_pos->packet_index,
925 struct packet_index, 0);
926 real.timestamp_begin = max(real.timestamp_begin,
927 index->ts_real.timestamp_begin);
928 cycles.timestamp_begin = max(cycles.timestamp_begin,
929 index->ts_cycles.timestamp_begin);
930
931 index = &g_array_index(stream_pos->packet_index,
932 struct packet_index,
933 stream_pos->packet_index->len - 1);
934 real.timestamp_end = min(real.timestamp_end,
935 index->ts_real.timestamp_end);
936 cycles.timestamp_end = min(cycles.timestamp_end,
937 index->ts_cycles.timestamp_end);
938 }
939 }
940 end:
941 if (ret == 0) {
942 if (_real) {
943 *_real = real;
944 }
945 if (_cycles) {
946 *_cycles = cycles;
947 }
948 }
949 return ret;
950 }
951
952 /*
953 * Find the union of all active regions in the trace collection's traces.
954 * Returns "real" timestamps.
955 *
956 * Return 0 on success.
957 * Return 1 if no intersections are found.
958 * Return a negative value on error.
959 */
960 int ctf_find_tc_stream_packet_intersection_union(struct bt_context *ctx,
961 uint64_t *_ts_begin, uint64_t *_ts_end)
962 {
963 int ret = 0, i;
964 uint64_t ts_begin = UINT64_MAX, ts_end = 0;
965
966 if (!ctx || !ctx->tc || !ctx->tc->array || !_ts_begin || !_ts_end) {
967 ret = -EINVAL;
968 goto end;
969 }
970
971 for (i = 0; i < ctx->tc->array->len; i++) {
972 struct bt_trace_descriptor *td_read;
973 struct packet_index_time intersection_real;
974
975 td_read = g_ptr_array_index(ctx->tc->array, i);
976 if (!td_read) {
977 continue;
978 }
979 ret = ctf_find_stream_intersection(td_read, &intersection_real,
980 NULL);
981 if (ret == 1) {
982 /* Empty trace or no stream intersection. */
983 continue;
984 } else if (ret < 0) {
985 goto end;
986 }
987
988 ts_begin = min(intersection_real.timestamp_begin, ts_begin);
989 ts_end = max(intersection_real.timestamp_end, ts_end);
990 }
991
992 if (ts_end < ts_begin) {
993 ret = 1;
994 goto end;
995 }
996 *_ts_begin = ts_begin;
997 *_ts_end = ts_end;
998 end:
999 return ret;
1000 }
1001
1002 int ctf_tc_set_stream_intersection_mode(struct bt_context *ctx)
1003 {
1004 int ret = 0, i;
1005
1006 if (!ctx || !ctx->tc || !ctx->tc->array) {
1007 ret = -EINVAL;
1008 goto end;
1009 }
1010
1011 for (i = 0; i < ctx->tc->array->len; i++) {
1012 struct bt_trace_descriptor *td_read;
1013 struct packet_index_time intersection_real;
1014
1015 td_read = g_ptr_array_index(ctx->tc->array, i);
1016 if (!td_read) {
1017 continue;
1018 }
1019
1020 ret = ctf_find_stream_intersection(td_read, &intersection_real,
1021 NULL);
1022 if (ret == 1) {
1023 /* Empty trace or no stream intersection. */
1024 continue;
1025 } else if (ret < 0) {
1026 goto end;
1027 }
1028
1029 td_read->interval_real = intersection_real;
1030 td_read->interval_set = true;
1031 }
1032 end:
1033 return ret;
1034 }
1035
1036 /*
1037 * for SEEK_CUR: go to next packet.
1038 * for SEEK_SET: go to packet numer (index).
1039 */
1040 void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
1041 {
1042 struct ctf_stream_pos *pos =
1043 container_of(stream_pos, struct ctf_stream_pos, parent);
1044 struct ctf_file_stream *file_stream =
1045 container_of(pos, struct ctf_file_stream, pos);
1046 int ret;
1047 struct packet_index *packet_index, *prev_index;
1048
1049 switch (whence) {
1050 case SEEK_CUR:
1051 case SEEK_SET: /* Fall-through */
1052 break; /* OK */
1053 default:
1054 assert(0);
1055 }
1056
1057 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
1058 *pos->content_size_loc = pos->offset;
1059
1060 if (pos->base_mma) {
1061 /* unmap old base */
1062 ret = munmap_align(pos->base_mma);
1063 if (ret) {
1064 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1065 strerror(errno));
1066 assert(0);
1067 }
1068 pos->base_mma = NULL;
1069 }
1070
1071 /*
1072 * The caller should never ask for ctf_move_pos across packets,
1073 * except to get exactly at the beginning of the next packet.
1074 */
1075 if (pos->prot & PROT_WRITE) {
1076 switch (whence) {
1077 case SEEK_CUR:
1078 /* The writer will add padding */
1079 pos->mmap_offset += pos->packet_size / CHAR_BIT;
1080 break;
1081 case SEEK_SET:
1082 assert(index == 0); /* only seek supported for now */
1083 pos->cur_index = 0;
1084 break;
1085 default:
1086 assert(0);
1087 }
1088 pos->content_size = -1U; /* Unknown at this point */
1089 pos->packet_size = WRITE_PACKET_LEN;
1090 do {
1091 ret = bt_posix_fallocate(pos->fd, pos->mmap_offset,
1092 pos->packet_size / CHAR_BIT);
1093 } while (ret == EINTR);
1094 assert(ret == 0);
1095 pos->offset = 0;
1096 } else {
1097 read_next_packet:
1098 switch (whence) {
1099 case SEEK_CUR:
1100 {
1101 if (pos->offset == EOF) {
1102 return;
1103 }
1104 assert(pos->cur_index < pos->packet_index->len);
1105 /* The reader will expect us to skip padding */
1106 ++pos->cur_index;
1107 break;
1108 }
1109 case SEEK_SET:
1110 if (index >= pos->packet_index->len) {
1111 pos->offset = EOF;
1112 return;
1113 }
1114 pos->cur_index = index;
1115 break;
1116 default:
1117 assert(0);
1118 }
1119
1120 if (pos->cur_index >= pos->packet_index->len) {
1121 pos->offset = EOF;
1122 return;
1123 }
1124
1125 packet_index = &g_array_index(pos->packet_index,
1126 struct packet_index, pos->cur_index);
1127 if (pos->cur_index > 0) {
1128 prev_index = &g_array_index(pos->packet_index,
1129 struct packet_index,
1130 pos->cur_index - 1);
1131 } else {
1132 prev_index = NULL;
1133 }
1134 ctf_update_current_packet_index(&file_stream->parent,
1135 prev_index, packet_index);
1136
1137 /*
1138 * We need to check if we are in trace read or called
1139 * from packet indexing. In this last case, the
1140 * collection is not there, so we cannot print the
1141 * timestamps.
1142 */
1143 if ((&file_stream->parent)->stream_class->trace->parent.collection) {
1144 ctf_print_discarded_lost(stderr, &file_stream->parent);
1145 }
1146
1147 packet_index = &g_array_index(pos->packet_index,
1148 struct packet_index,
1149 pos->cur_index);
1150 file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
1151
1152 file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin;
1153
1154 /* Lookup context/packet size in index */
1155 if (packet_index->data_offset == -1) {
1156 ret = find_data_offset(pos, file_stream, packet_index);
1157 if (ret < 0) {
1158 return;
1159 }
1160 }
1161 pos->content_size = packet_index->content_size;
1162 pos->packet_size = packet_index->packet_size;
1163 pos->mmap_offset = packet_index->offset;
1164 pos->data_offset = packet_index->data_offset;
1165 if (pos->data_offset < packet_index->content_size) {
1166 pos->offset = 0; /* will read headers */
1167 } else if (pos->data_offset == packet_index->content_size) {
1168 /* empty packet */
1169 pos->offset = packet_index->data_offset;
1170 whence = SEEK_CUR;
1171 goto read_next_packet;
1172 } else {
1173 pos->offset = EOF;
1174 return;
1175 }
1176 }
1177 /* map new base. Need mapping length from header. */
1178 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
1179 pos->flags, pos->fd, pos->mmap_offset);
1180 if (pos->base_mma == MAP_FAILED) {
1181 fprintf(stderr, "[error] mmap error %s.\n",
1182 strerror(errno));
1183 assert(0);
1184 }
1185
1186 /* update trace_packet_header and stream_packet_context */
1187 if (!(pos->prot & PROT_WRITE) &&
1188 file_stream->parent.trace_packet_header) {
1189 /* Read packet header */
1190 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1191 assert(!ret);
1192 }
1193 if (!(pos->prot & PROT_WRITE) &&
1194 file_stream->parent.stream_packet_context) {
1195 /* Read packet context */
1196 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1197 assert(!ret);
1198 }
1199 }
1200
1201 static
1202 int packet_metadata(struct ctf_trace *td, FILE *fp)
1203 {
1204 uint32_t magic;
1205 size_t len;
1206 int ret = 0;
1207
1208 len = fread(&magic, sizeof(magic), 1, fp);
1209 if (len != 1) {
1210 goto end;
1211 }
1212 if (magic == TSDL_MAGIC) {
1213 ret = 1;
1214 td->byte_order = BYTE_ORDER;
1215 CTF_TRACE_SET_FIELD(td, byte_order);
1216 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
1217 ret = 1;
1218 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
1219 LITTLE_ENDIAN : BIG_ENDIAN;
1220 CTF_TRACE_SET_FIELD(td, byte_order);
1221 }
1222 end:
1223 rewind(fp);
1224 return ret;
1225 }
1226
1227 /*
1228 * Returns 0 on success, -1 on error.
1229 */
1230 static
1231 int check_version(unsigned int major, unsigned int minor)
1232 {
1233 switch (major) {
1234 case 1:
1235 switch (minor) {
1236 case 8:
1237 return 0;
1238 default:
1239 goto warning;
1240 }
1241 default:
1242 goto warning;
1243
1244 }
1245
1246 /* eventually return an error instead of warning */
1247 warning:
1248 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1249 major, minor);
1250 return 0;
1251 }
1252
1253 static
1254 int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
1255 FILE *out)
1256 {
1257 struct metadata_packet_header header;
1258 size_t readlen, writelen, toread;
1259 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
1260 int ret = 0;
1261
1262 readlen = fread(&header, header_sizeof(header), 1, in);
1263 if (readlen < 1)
1264 return -EINVAL;
1265
1266 if (td->byte_order != BYTE_ORDER) {
1267 header.magic = GUINT32_SWAP_LE_BE(header.magic);
1268 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
1269 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
1270 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
1271 }
1272 if (header.checksum)
1273 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
1274 if (header.compression_scheme) {
1275 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
1276 header.compression_scheme);
1277 return -EINVAL;
1278 }
1279 if (header.encryption_scheme) {
1280 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
1281 header.encryption_scheme);
1282 return -EINVAL;
1283 }
1284 if (header.checksum_scheme) {
1285 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
1286 header.checksum_scheme);
1287 return -EINVAL;
1288 }
1289 if (check_version(header.major, header.minor) < 0)
1290 return -EINVAL;
1291 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
1292 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
1293 CTF_TRACE_SET_FIELD(td, uuid);
1294 } else {
1295 if (bt_uuid_compare(header.uuid, td->uuid))
1296 return -EINVAL;
1297 }
1298
1299 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
1300 return -EINVAL;
1301
1302 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
1303
1304 for (;;) {
1305 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
1306 if (ferror(in)) {
1307 ret = -EINVAL;
1308 break;
1309 }
1310 if (babeltrace_debug) {
1311 buf[readlen] = '\0';
1312 fprintf(stderr, "[debug] metadata packet read: %s\n",
1313 buf);
1314 }
1315
1316 writelen = fwrite(buf, sizeof(char), readlen, out);
1317 if (writelen < readlen) {
1318 ret = -EIO;
1319 break;
1320 }
1321 if (ferror(out)) {
1322 ret = -EINVAL;
1323 break;
1324 }
1325 toread -= readlen;
1326 if (!toread) {
1327 ret = 0; /* continue reading next packet */
1328 goto read_padding;
1329 }
1330 }
1331 return ret;
1332
1333 read_padding:
1334 toread = (header.packet_size - header.content_size) / CHAR_BIT;
1335 ret = fseek(in, toread, SEEK_CUR);
1336 if (ret < 0) {
1337 fprintf(stderr, "[warning] Missing padding at end of file\n");
1338 ret = 0;
1339 }
1340 return ret;
1341 }
1342
1343 static
1344 int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
1345 char **buf)
1346 {
1347 FILE *in, *out;
1348 size_t size, buflen;
1349 int ret;
1350
1351 in = *fp;
1352 /*
1353 * Using strlen on *buf instead of size of open_memstream
1354 * because its size includes garbage at the end (after final
1355 * \0). This is the allocated size, not the actual string size.
1356 */
1357 out = babeltrace_open_memstream(buf, &size);
1358 if (out == NULL) {
1359 perror("Metadata open_memstream");
1360 return -errno;
1361 }
1362 for (;;) {
1363 ret = ctf_trace_metadata_packet_read(td, in, out);
1364 if (ret) {
1365 break;
1366 }
1367 if (feof(in)) {
1368 ret = 0;
1369 break;
1370 }
1371 }
1372 /* close to flush the buffer */
1373 ret = babeltrace_close_memstream(buf, &size, out);
1374 if (ret < 0) {
1375 int closeret;
1376
1377 perror("babeltrace_flush_memstream");
1378 ret = -errno;
1379 closeret = fclose(in);
1380 if (closeret) {
1381 perror("Error in fclose");
1382 }
1383 return ret;
1384 }
1385 ret = fclose(in);
1386 if (ret) {
1387 perror("Error in fclose");
1388 }
1389 /* open for reading */
1390 buflen = strlen(*buf);
1391 if (!buflen) {
1392 *fp = NULL;
1393 return -ENOENT;
1394 }
1395 *fp = babeltrace_fmemopen(*buf, buflen, "rb");
1396 if (!*fp) {
1397 perror("Metadata fmemopen");
1398 return -errno;
1399 }
1400 return 0;
1401 }
1402
1403 static
1404 int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp,
1405 struct ctf_scanner *scanner, int append)
1406 {
1407 struct ctf_file_stream *metadata_stream;
1408 FILE *fp;
1409 char *buf = NULL;
1410 int ret = 0, closeret;
1411
1412 metadata_stream = g_new0(struct ctf_file_stream, 1);
1413 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1414
1415 if (metadata_fp) {
1416 fp = metadata_fp;
1417 metadata_stream->pos.fd = -1;
1418 } else {
1419 td->metadata = &metadata_stream->parent;
1420 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1421 if (metadata_stream->pos.fd < 0) {
1422 fprintf(stderr, "Unable to open metadata.\n");
1423 ret = -1;
1424 goto end_free;
1425 }
1426
1427 fp = fdopen(metadata_stream->pos.fd, "r");
1428 if (!fp) {
1429 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1430 perror("Metadata stream open");
1431 ret = -errno;
1432 goto end_stream;
1433 }
1434 /* fd now belongs to fp */
1435 metadata_stream->pos.fd = -1;
1436 }
1437 if (babeltrace_debug)
1438 yydebug = 1;
1439
1440 if (packet_metadata(td, fp)) {
1441 ret = ctf_trace_metadata_stream_read(td, &fp, &buf);
1442 if (ret) {
1443 goto end;
1444 }
1445 td->metadata_string = buf;
1446 td->metadata_packetized = 1;
1447 } else {
1448 if (!append) {
1449 unsigned int major, minor;
1450 ssize_t nr_items;
1451
1452 td->byte_order = BYTE_ORDER;
1453
1454 /* Check text-only metadata header and version */
1455 nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
1456 if (nr_items < 2)
1457 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1458 if (check_version(major, minor) < 0) {
1459 ret = -EINVAL;
1460 goto end;
1461 }
1462 rewind(fp);
1463 }
1464 }
1465
1466 ret = ctf_scanner_append_ast(scanner, fp);
1467 if (ret) {
1468 fprintf(stderr, "[error] Error creating AST\n");
1469 goto end;
1470 }
1471
1472 if (babeltrace_debug) {
1473 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1474 if (ret) {
1475 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1476 goto end;
1477 }
1478 }
1479
1480 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1481 if (ret) {
1482 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1483 goto end;
1484 }
1485 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1486 td, td->byte_order);
1487 if (ret) {
1488 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1489 goto end;
1490 }
1491 end:
1492 if (fp) {
1493 closeret = fclose(fp);
1494 if (closeret) {
1495 perror("Error on fclose");
1496 }
1497 }
1498 end_stream:
1499 if (metadata_stream->pos.fd >= 0) {
1500 closeret = close(metadata_stream->pos.fd);
1501 if (closeret) {
1502 perror("Error on metadata stream fd close");
1503 }
1504 }
1505 end_free:
1506 if (ret)
1507 g_free(metadata_stream);
1508 return ret;
1509 }
1510
1511 static
1512 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1513 struct ctf_stream_definition *stream,
1514 struct ctf_event_declaration *event)
1515 {
1516 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1517
1518 if (event->context_decl) {
1519 struct bt_definition *definition =
1520 event->context_decl->p.definition_new(&event->context_decl->p,
1521 stream->parent_def_scope, 0, 0, "event.context");
1522 if (!definition) {
1523 goto error;
1524 }
1525 stream_event->event_context = container_of(definition,
1526 struct definition_struct, p);
1527 stream->parent_def_scope = stream_event->event_context->p.scope;
1528 }
1529 if (event->fields_decl) {
1530 struct bt_definition *definition =
1531 event->fields_decl->p.definition_new(&event->fields_decl->p,
1532 stream->parent_def_scope, 0, 0, "event.fields");
1533 if (!definition) {
1534 goto error;
1535 }
1536 stream_event->event_fields = container_of(definition,
1537 struct definition_struct, p);
1538 stream->parent_def_scope = stream_event->event_fields->p.scope;
1539 }
1540 stream_event->stream = stream;
1541 return stream_event;
1542
1543 error:
1544 if (stream_event->event_fields)
1545 bt_definition_unref(&stream_event->event_fields->p);
1546 if (stream_event->event_context)
1547 bt_definition_unref(&stream_event->event_context->p);
1548 fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n",
1549 g_quark_to_string(event->name));
1550 return NULL;
1551 }
1552
1553 static
1554 int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td,
1555 struct ctf_stream_declaration *stream_class,
1556 struct ctf_stream_definition *stream)
1557 {
1558 size_t def_size, class_size, i;
1559 int ret = 0;
1560
1561 def_size = stream->events_by_id->len;
1562 class_size = stream_class->events_by_id->len;
1563
1564 g_ptr_array_set_size(stream->events_by_id, class_size);
1565 for (i = def_size; i < class_size; i++) {
1566 struct ctf_event_declaration *event =
1567 g_ptr_array_index(stream_class->events_by_id, i);
1568 struct ctf_event_definition *stream_event;
1569
1570 if (!event)
1571 continue;
1572 stream_event = create_event_definitions(td, stream, event);
1573 if (!stream_event) {
1574 ret = -EINVAL;
1575 goto error;
1576 }
1577 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1578 }
1579 error:
1580 return ret;
1581 }
1582
1583 static
1584 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1585 {
1586 struct ctf_stream_declaration *stream_class;
1587 int ret;
1588 int i;
1589
1590 if (stream->stream_definitions_created)
1591 return 0;
1592
1593 stream_class = stream->stream_class;
1594
1595 if (stream_class->packet_context_decl) {
1596 struct bt_definition *definition =
1597 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1598 stream->parent_def_scope, 0, 0, "stream.packet.context");
1599 if (!definition) {
1600 ret = -EINVAL;
1601 goto error;
1602 }
1603 stream->stream_packet_context = container_of(definition,
1604 struct definition_struct, p);
1605 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1606 }
1607 if (stream_class->event_header_decl) {
1608 struct bt_definition *definition =
1609 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1610 stream->parent_def_scope, 0, 0, "stream.event.header");
1611 if (!definition) {
1612 ret = -EINVAL;
1613 goto error;
1614 }
1615 stream->stream_event_header =
1616 container_of(definition, struct definition_struct, p);
1617 stream->parent_def_scope = stream->stream_event_header->p.scope;
1618 }
1619 if (stream_class->event_context_decl) {
1620 struct bt_definition *definition =
1621 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1622 stream->parent_def_scope, 0, 0, "stream.event.context");
1623 if (!definition) {
1624 ret = -EINVAL;
1625 goto error;
1626 }
1627 stream->stream_event_context =
1628 container_of(definition, struct definition_struct, p);
1629 stream->parent_def_scope = stream->stream_event_context->p.scope;
1630 }
1631 stream->events_by_id = g_ptr_array_new();
1632 ret = copy_event_declarations_stream_class_to_stream(td,
1633 stream_class, stream);
1634 if (ret)
1635 goto error_event;
1636 return 0;
1637
1638 error_event:
1639 for (i = 0; i < stream->events_by_id->len; i++) {
1640 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1641 if (stream_event)
1642 g_free(stream_event);
1643 }
1644 g_ptr_array_free(stream->events_by_id, TRUE);
1645 error:
1646 if (stream->stream_event_context)
1647 bt_definition_unref(&stream->stream_event_context->p);
1648 if (stream->stream_event_header)
1649 bt_definition_unref(&stream->stream_event_header->p);
1650 if (stream->stream_packet_context)
1651 bt_definition_unref(&stream->stream_packet_context->p);
1652 fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n",
1653 stream_class->stream_id, strerror(-ret));
1654 return ret;
1655 }
1656
1657 static
1658 int stream_assign_class(struct ctf_trace *td,
1659 struct ctf_file_stream *file_stream,
1660 uint64_t stream_id)
1661 {
1662 struct ctf_stream_declaration *stream;
1663 int ret;
1664
1665 file_stream->parent.stream_id = stream_id;
1666 if (stream_id >= td->streams->len) {
1667 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1668 return -EINVAL;
1669 }
1670 stream = g_ptr_array_index(td->streams, stream_id);
1671 if (!stream) {
1672 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1673 return -EINVAL;
1674 }
1675 file_stream->parent.stream_class = stream;
1676 ret = create_stream_definitions(td, &file_stream->parent);
1677 if (ret)
1678 return ret;
1679 return 0;
1680 }
1681
1682 static
1683 int create_stream_one_packet_index(struct ctf_stream_pos *pos,
1684 struct ctf_trace *td,
1685 struct ctf_file_stream *file_stream,
1686 size_t filesize)
1687 {
1688 struct packet_index packet_index;
1689 uint64_t stream_id = 0;
1690 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
1691 int first_packet = 0;
1692 int len_index;
1693 int ret;
1694
1695 begin:
1696 memset(&packet_index, 0, sizeof(packet_index));
1697 if (!pos->mmap_offset) {
1698 first_packet = 1;
1699 }
1700
1701 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
1702 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
1703 }
1704
1705 if (pos->base_mma) {
1706 /* unmap old base */
1707 ret = munmap_align(pos->base_mma);
1708 if (ret) {
1709 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1710 strerror(errno));
1711 return ret;
1712 }
1713 pos->base_mma = NULL;
1714 }
1715 /* map new base. Need mapping length from header. */
1716 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
1717 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1718 assert(pos->base_mma != MAP_FAILED);
1719 /*
1720 * Use current mapping size as temporary content and packet
1721 * size.
1722 */
1723 pos->content_size = packet_map_len;
1724 pos->packet_size = packet_map_len;
1725 pos->offset = 0; /* Position of the packet header */
1726
1727 packet_index.offset = pos->mmap_offset;
1728
1729 /* read and check header, set stream id (and check) */
1730 if (file_stream->parent.trace_packet_header) {
1731 /* Read packet header */
1732 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1733 if (ret) {
1734 if (ret == -EFAULT)
1735 goto retry;
1736 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1737 return ret;
1738 }
1739 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1740 if (len_index >= 0) {
1741 struct bt_definition *field;
1742 uint64_t magic;
1743
1744 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1745 magic = bt_get_unsigned_int(field);
1746 if (magic != CTF_MAGIC) {
1747 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1748 magic,
1749 file_stream->pos.packet_index->len,
1750 (ssize_t) pos->mmap_offset);
1751 return -EINVAL;
1752 }
1753 }
1754
1755 /* check uuid */
1756 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1757 if (len_index >= 0) {
1758 struct definition_array *defarray;
1759 struct bt_definition *field;
1760 uint64_t i;
1761 uint8_t uuidval[BABELTRACE_UUID_LEN];
1762
1763 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1764 assert(field->declaration->id == CTF_TYPE_ARRAY);
1765 defarray = container_of(field, struct definition_array, p);
1766 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1767
1768 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1769 struct bt_definition *elem;
1770
1771 elem = bt_array_index(defarray, i);
1772 uuidval[i] = bt_get_unsigned_int(elem);
1773 }
1774 ret = bt_uuid_compare(td->uuid, uuidval);
1775 if (ret) {
1776 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1777 return -EINVAL;
1778 }
1779 }
1780
1781 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1782 if (len_index >= 0) {
1783 struct bt_definition *field;
1784
1785 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1786 stream_id = bt_get_unsigned_int(field);
1787 }
1788 }
1789
1790 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1791 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1792 stream_id,
1793 file_stream->parent.stream_id);
1794 return -EINVAL;
1795 }
1796 if (first_packet) {
1797 ret = stream_assign_class(td, file_stream, stream_id);
1798 if (ret)
1799 return ret;
1800 }
1801
1802 if (file_stream->parent.stream_packet_context) {
1803 /* Read packet context */
1804 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1805 if (ret) {
1806 if (ret == -EFAULT)
1807 goto retry;
1808 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1809 return ret;
1810 }
1811 /* read packet size from header */
1812 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1813 if (len_index >= 0) {
1814 struct bt_definition *field;
1815
1816 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1817 packet_index.packet_size = bt_get_unsigned_int(field);
1818 } else {
1819 /* Use file size for packet size */
1820 packet_index.packet_size = filesize * CHAR_BIT;
1821 }
1822
1823 /* read content size from header */
1824 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1825 if (len_index >= 0) {
1826 struct bt_definition *field;
1827
1828 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1829 packet_index.content_size = bt_get_unsigned_int(field);
1830 } else {
1831 /* Use packet size if non-zero, else file size */
1832 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1833 }
1834
1835 /* read timestamp begin from header */
1836 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1837 if (len_index >= 0) {
1838 struct bt_definition *field;
1839
1840 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1841 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1842 if (file_stream->parent.stream_class->trace->parent.collection) {
1843 packet_index.ts_real.timestamp_begin =
1844 ctf_get_real_timestamp(
1845 &file_stream->parent,
1846 packet_index.ts_cycles.timestamp_begin);
1847 }
1848 }
1849
1850 /* read timestamp end from header */
1851 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1852 if (len_index >= 0) {
1853 struct bt_definition *field;
1854
1855 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1856 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1857 if (file_stream->parent.stream_class->trace->parent.collection) {
1858 packet_index.ts_real.timestamp_end =
1859 ctf_get_real_timestamp(
1860 &file_stream->parent,
1861 packet_index.ts_cycles.timestamp_end);
1862 }
1863 }
1864
1865 /* read events discarded from header */
1866 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1867 if (len_index >= 0) {
1868 struct bt_definition *field;
1869
1870 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1871 packet_index.events_discarded = bt_get_unsigned_int(field);
1872 packet_index.events_discarded_len = bt_get_int_len(field);
1873 }
1874
1875 /* read packet_seq_num from header */
1876 len_index = bt_struct_declaration_lookup_field_index(
1877 file_stream->parent.stream_packet_context->declaration,
1878 g_quark_from_static_string("packet_seq_num"));
1879 if (len_index >= 0) {
1880 struct bt_definition *field;
1881
1882 field = bt_struct_definition_get_field_from_index(
1883 file_stream->parent.stream_packet_context,
1884 len_index);
1885 packet_index.packet_seq_num = bt_get_unsigned_int(field);
1886 }
1887 } else {
1888 /* Use file size for packet size */
1889 packet_index.packet_size = filesize * CHAR_BIT;
1890 /* Use packet size if non-zero, else file size */
1891 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1892 }
1893
1894 /* Validate content size and packet size values */
1895 if (packet_index.content_size > packet_index.packet_size) {
1896 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1897 packet_index.content_size, packet_index.packet_size);
1898 return -EINVAL;
1899 }
1900
1901 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1902 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1903 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1904 return -EINVAL;
1905 }
1906
1907 if (packet_index.content_size < pos->offset) {
1908 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1909 return -EINVAL;
1910 }
1911
1912 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1913 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1914 return -EINVAL;
1915 }
1916
1917 /* Save position after header and context */
1918 packet_index.data_offset = pos->offset;
1919
1920 /* add index to packet array */
1921 g_array_append_val(file_stream->pos.packet_index, packet_index);
1922
1923 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1924
1925 return 0;
1926
1927 /* Retry with larger mapping */
1928 retry:
1929 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1930 /*
1931 * Reached EOF, but still expecting header/context data.
1932 */
1933 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1934 return -EFAULT;
1935 }
1936 /* Double the mapping len, and retry */
1937 tmp_map_len = packet_map_len << 1;
1938 if (tmp_map_len >> 1 != packet_map_len) {
1939 /* Overflow */
1940 fprintf(stderr, "[error] Packet mapping length overflow\n");
1941 return -EFAULT;
1942 }
1943 packet_map_len = tmp_map_len;
1944 goto begin;
1945 }
1946
1947 static
1948 int create_stream_packet_index(struct ctf_trace *td,
1949 struct ctf_file_stream *file_stream)
1950 {
1951 struct ctf_stream_pos *pos;
1952 struct stat filestats;
1953 int ret;
1954
1955 pos = &file_stream->pos;
1956
1957 ret = fstat(pos->fd, &filestats);
1958 if (ret < 0)
1959 return ret;
1960
1961 /* Deal with empty files */
1962 if (!filestats.st_size) {
1963 if (file_stream->parent.trace_packet_header
1964 || file_stream->parent.stream_packet_context) {
1965 /*
1966 * We expect a trace packet header and/or stream packet
1967 * context. Since a trace needs to have at least one
1968 * packet, empty files are therefore not accepted.
1969 */
1970 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1971 return -EINVAL;
1972 } else {
1973 /*
1974 * Without trace packet header nor stream packet
1975 * context, a one-packet trace can indeed be empty. This
1976 * is only valid if there is only one stream class: 0.
1977 */
1978 ret = stream_assign_class(td, file_stream, 0);
1979 if (ret)
1980 return ret;
1981 return 0;
1982 }
1983 }
1984
1985 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1986 ret = create_stream_one_packet_index(pos, td, file_stream,
1987 filestats.st_size);
1988 if (ret)
1989 return ret;
1990 }
1991 return 0;
1992 }
1993
1994 static
1995 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1996 {
1997 int ret;
1998
1999 if (td->packet_header_decl) {
2000 struct bt_definition *definition =
2001 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
2002 stream->parent_def_scope, 0, 0, "trace.packet.header");
2003 if (!definition) {
2004 ret = -EINVAL;
2005 goto error;
2006 }
2007 stream->trace_packet_header =
2008 container_of(definition, struct definition_struct, p);
2009 stream->parent_def_scope = stream->trace_packet_header->p.scope;
2010 }
2011
2012 return 0;
2013
2014 error:
2015 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
2016 return ret;
2017 }
2018
2019 static
2020 int import_stream_packet_index(struct ctf_trace *td,
2021 struct ctf_file_stream *file_stream)
2022 {
2023 struct ctf_stream_pos *pos;
2024 struct ctf_packet_index *ctf_index = NULL;
2025 struct ctf_packet_index_file_hdr index_hdr;
2026 struct packet_index index;
2027 uint32_t packet_index_len, index_minor;
2028 int ret = 0;
2029 int first_packet = 1;
2030 size_t len;
2031
2032 pos = &file_stream->pos;
2033
2034 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
2035 if (len != 1) {
2036 perror("read index file header");
2037 goto error;
2038 }
2039
2040 /* Check the index header */
2041 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
2042 fprintf(stderr, "[error] wrong index magic\n");
2043 ret = -1;
2044 goto error;
2045 }
2046 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
2047 fprintf(stderr, "[error] Incompatible index file %" PRIu32
2048 ".%" PRIu32 ", supported %d.%d\n",
2049 be32toh(index_hdr.index_major),
2050 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
2051 CTF_INDEX_MINOR);
2052 ret = -1;
2053 goto error;
2054 }
2055 index_minor = be32toh(index_hdr.index_minor);
2056
2057 packet_index_len = be32toh(index_hdr.packet_index_len);
2058 if (packet_index_len == 0) {
2059 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
2060 ret = -1;
2061 goto error;
2062 }
2063 /*
2064 * Allocate the index length found in header, not internal
2065 * representation.
2066 */
2067 ctf_index = g_malloc0(packet_index_len);
2068 while (fread(ctf_index, packet_index_len, 1,
2069 pos->index_fp) == 1) {
2070 uint64_t stream_id;
2071 struct ctf_stream_declaration *stream = NULL;
2072
2073 memset(&index, 0, sizeof(index));
2074 index.offset = be64toh(ctf_index->offset);
2075 index.packet_size = be64toh(ctf_index->packet_size);
2076 index.content_size = be64toh(ctf_index->content_size);
2077 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
2078 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
2079 index.events_discarded = be64toh(ctf_index->events_discarded);
2080 index.events_discarded_len = 64;
2081 index.data_offset = -1;
2082 stream_id = be64toh(ctf_index->stream_id);
2083 if (index_minor >= 1) {
2084 index.stream_instance_id = be64toh(ctf_index->stream_instance_id);
2085 index.packet_seq_num = be64toh(ctf_index->packet_seq_num);
2086 }
2087
2088 if (!first_packet) {
2089 /* add index to packet array */
2090 g_array_append_val(file_stream->pos.packet_index, index);
2091 continue;
2092 }
2093
2094 file_stream->parent.stream_id = stream_id;
2095 if (stream_id < td->streams->len) {
2096 stream = g_ptr_array_index(td->streams, stream_id);
2097 }
2098 if (!stream) {
2099 fprintf(stderr, "[error] Stream %" PRIu64
2100 " is not declared in metadata.\n",
2101 stream_id);
2102 ret = -EINVAL;
2103 goto error;
2104 }
2105 file_stream->parent.stream_class = stream;
2106 ret = create_stream_definitions(td, &file_stream->parent);
2107 if (ret)
2108 goto error;
2109 first_packet = 0;
2110 /* add index to packet array */
2111 g_array_append_val(file_stream->pos.packet_index, index);
2112 }
2113
2114 /* Index containing only the header. */
2115 if (!file_stream->parent.stream_class) {
2116 ret = -1;
2117 goto error;
2118 }
2119
2120 ret = 0;
2121
2122 error:
2123 g_free(ctf_index);
2124 return ret;
2125 }
2126
2127 /*
2128 * Note: many file streams can inherit from the same stream class
2129 * description (metadata).
2130 */
2131 static
2132 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
2133 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2134 int whence))
2135 {
2136 int ret, fd, closeret;
2137 struct ctf_file_stream *file_stream;
2138 struct stat statbuf;
2139 char *index_name;
2140
2141 fd = openat(td->dirfd, path, flags);
2142 if (fd < 0) {
2143 perror("File stream openat()");
2144 ret = fd;
2145 goto error;
2146 }
2147
2148 /* Don't try to mmap subdirectories. Skip them, return success. */
2149 ret = fstat(fd, &statbuf);
2150 if (ret) {
2151 perror("File stream fstat()");
2152 goto fstat_error;
2153 }
2154 if (S_ISDIR(statbuf.st_mode)) {
2155 if (strncmp(path, "index", 5) != 0) {
2156 fprintf(stderr, "[warning] Skipping directory '%s' "
2157 "found in trace\n", path);
2158 }
2159 ret = 0;
2160 goto fd_is_dir_ok;
2161 }
2162 if (!statbuf.st_size) {
2163 /** Skip empty files. */
2164 ret = 0;
2165 goto fd_is_empty_file;
2166 }
2167
2168 file_stream = g_new0(struct ctf_file_stream, 1);
2169 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2170 file_stream->pos.fd = -1;
2171 file_stream->pos.index_fp = NULL;
2172
2173 strncpy(file_stream->parent.path, path, PATH_MAX);
2174 file_stream->parent.path[PATH_MAX - 1] = '\0';
2175
2176 if (packet_seek) {
2177 file_stream->pos.packet_seek = packet_seek;
2178 } else {
2179 fprintf(stderr, "[error] packet_seek function undefined.\n");
2180 ret = -1;
2181 goto error_def;
2182 }
2183
2184 ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags);
2185 if (ret)
2186 goto error_def;
2187 ret = create_trace_definitions(td, &file_stream->parent);
2188 if (ret)
2189 goto error_def;
2190 /*
2191 * For now, only a single clock per trace is supported.
2192 */
2193 file_stream->parent.current_clock = td->parent.single_clock;
2194
2195 /*
2196 * Allocate the index name for this stream and try to open it.
2197 */
2198 index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char));
2199 if (!index_name) {
2200 fprintf(stderr, "[error] Cannot allocate index filename\n");
2201 ret = -ENOMEM;
2202 goto error_def;
2203 }
2204 snprintf(index_name, strlen(path) + sizeof(INDEX_PATH),
2205 INDEX_PATH, path);
2206
2207 if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) {
2208 ret = create_stream_packet_index(td, file_stream);
2209 if (ret) {
2210 fprintf(stderr, "[error] Stream index creation error.\n");
2211 goto error_index;
2212 }
2213 } else {
2214 ret = openat(td->dirfd, index_name, flags);
2215 if (ret < 0) {
2216 perror("Index file openat()");
2217 ret = -1;
2218 goto error_free;
2219 }
2220 file_stream->pos.index_fp = fdopen(ret, "r");
2221 if (!file_stream->pos.index_fp) {
2222 perror("fdopen() error");
2223 goto error_free;
2224 }
2225 ret = import_stream_packet_index(td, file_stream);
2226 if (ret) {
2227 ret = -1;
2228 goto error_index;
2229 }
2230 ret = fclose(file_stream->pos.index_fp);
2231 if (ret < 0) {
2232 perror("close index");
2233 goto error_free;
2234 }
2235 }
2236 free(index_name);
2237
2238 /* Add stream file to stream class */
2239 g_ptr_array_add(file_stream->parent.stream_class->streams,
2240 &file_stream->parent);
2241 return 0;
2242
2243 error_index:
2244 if (file_stream->pos.index_fp) {
2245 ret = fclose(file_stream->pos.index_fp);
2246 if (ret < 0) {
2247 perror("close index");
2248 }
2249 }
2250 if (file_stream->parent.trace_packet_header)
2251 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2252 error_free:
2253 free(index_name);
2254 error_def:
2255 closeret = ctf_fini_pos(&file_stream->pos);
2256 if (closeret) {
2257 fprintf(stderr, "Error on ctf_fini_pos\n");
2258 }
2259 g_free(file_stream);
2260 fd_is_empty_file:
2261 fd_is_dir_ok:
2262 fstat_error:
2263 closeret = close(fd);
2264 if (closeret) {
2265 perror("Error on fd close");
2266 }
2267 error:
2268 return ret;
2269 }
2270
2271 static
2272 int ctf_open_trace_read(struct ctf_trace *td,
2273 const char *path, int flags,
2274 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2275 int whence), FILE *metadata_fp)
2276 {
2277 struct ctf_scanner *scanner;
2278 int ret, closeret;
2279 struct dirent *dirent;
2280 struct dirent *diriter;
2281 size_t dirent_len;
2282 char *ext;
2283
2284 td->flags = flags;
2285
2286 /* Open trace directory */
2287 td->dir = opendir(path);
2288 if (!td->dir) {
2289 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
2290 ret = -ENOENT;
2291 goto error;
2292 }
2293
2294 td->dirfd = open(path, 0);
2295 if (td->dirfd < 0) {
2296 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
2297 perror("Trace directory open");
2298 ret = -errno;
2299 goto error_dirfd;
2300 }
2301 strncpy(td->parent.path, path, sizeof(td->parent.path));
2302 td->parent.path[sizeof(td->parent.path) - 1] = '\0';
2303
2304 /*
2305 * Keep the metadata file separate.
2306 * Keep scanner object local to the open. We don't support
2307 * incremental metadata append for on-disk traces.
2308 */
2309 scanner = ctf_scanner_alloc();
2310 if (!scanner) {
2311 fprintf(stderr, "[error] Error allocating scanner\n");
2312 ret = -ENOMEM;
2313 goto error_metadata;
2314 }
2315 ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0);
2316 ctf_scanner_free(scanner);
2317 if (ret) {
2318 if (ret == -ENOENT) {
2319 fprintf(stderr, "[warning] Empty metadata.\n");
2320 }
2321 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
2322 goto error_metadata;
2323 }
2324
2325 /*
2326 * Open each stream: for each file, try to open, check magic
2327 * number, and get the stream ID to add to the right location in
2328 * the stream array.
2329 */
2330
2331 dirent_len = offsetof(struct dirent, d_name) +
2332 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
2333
2334 dirent = malloc(dirent_len);
2335
2336 for (;;) {
2337 ret = readdir_r(td->dir, dirent, &diriter);
2338 if (ret) {
2339 fprintf(stderr, "[error] Readdir error.\n");
2340 goto readdir_error;
2341 }
2342 if (!diriter)
2343 break;
2344 /* Ignore hidden files, ., .. and metadata. */
2345 if (!strncmp(diriter->d_name, ".", 1)
2346 || !strcmp(diriter->d_name, "..")
2347 || !strcmp(diriter->d_name, "metadata"))
2348 continue;
2349
2350 /* Ignore index files : *.idx */
2351 ext = strrchr(diriter->d_name, '.');
2352 if (ext && (!strcmp(ext, ".idx"))) {
2353 continue;
2354 }
2355
2356 ret = ctf_open_file_stream_read(td, diriter->d_name,
2357 flags, packet_seek);
2358 if (ret) {
2359 fprintf(stderr, "[error] Open file stream error.\n");
2360 goto readdir_error;
2361 }
2362 }
2363
2364 free(dirent);
2365 return 0;
2366
2367 readdir_error:
2368 free(dirent);
2369 error_metadata:
2370 closeret = close(td->dirfd);
2371 if (closeret) {
2372 perror("Error on fd close");
2373 }
2374 error_dirfd:
2375 closeret = closedir(td->dir);
2376 if (closeret) {
2377 perror("Error on closedir");
2378 }
2379 error:
2380 return ret;
2381 }
2382
2383 /*
2384 * ctf_open_trace: Open a CTF trace and index it.
2385 * Note that the user must seek the trace after the open (using the iterator)
2386 * since the index creation read it entirely.
2387 */
2388 static
2389 struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags,
2390 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2391 int whence), FILE *metadata_fp)
2392 {
2393 struct ctf_trace *td;
2394 int ret;
2395
2396 /*
2397 * If packet_seek is NULL, we provide our default version.
2398 */
2399 if (!packet_seek)
2400 packet_seek = ctf_packet_seek;
2401
2402 td = g_new0(struct ctf_trace, 1);
2403 if (!td) {
2404 goto error;
2405 }
2406 init_trace_descriptor(&td->parent);
2407
2408 switch (flags & O_ACCMODE) {
2409 case O_RDONLY:
2410 if (!path) {
2411 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
2412 goto error;
2413 }
2414 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
2415 if (ret)
2416 goto error;
2417 break;
2418 case O_RDWR:
2419 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
2420 goto error;
2421 default:
2422 fprintf(stderr, "[error] Incorrect open flags.\n");
2423 goto error;
2424 }
2425
2426 ret = trace_debug_info_create(td);
2427 if (ret) {
2428 goto error;
2429 }
2430
2431 return &td->parent;
2432 error:
2433 if (td) {
2434 trace_debug_info_destroy(td);
2435 g_free(td);
2436 }
2437 return NULL;
2438 }
2439
2440 static
2441 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
2442 struct bt_mmap_stream *mmap_info)
2443 {
2444 pos->mmap_offset = 0;
2445 pos->packet_size = 0;
2446 pos->content_size = 0;
2447 pos->content_size_loc = NULL;
2448 pos->fd = mmap_info->fd;
2449 pos->base_mma = NULL;
2450 pos->offset = 0;
2451 pos->dummy = false;
2452 pos->cur_index = 0;
2453 pos->prot = PROT_READ;
2454 pos->flags = MAP_PRIVATE;
2455 pos->parent.rw_table = read_dispatch_table;
2456 pos->parent.event_cb = ctf_read_event;
2457 pos->priv = mmap_info->priv;
2458 pos->packet_index = g_array_new(FALSE, TRUE,
2459 sizeof(struct packet_index));
2460 }
2461
2462 static
2463 int prepare_mmap_stream_definition(struct ctf_trace *td,
2464 struct ctf_file_stream *file_stream,
2465 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2466 int whence))
2467 {
2468 struct ctf_stream_declaration *stream;
2469 uint64_t stream_id;
2470 int ret;
2471
2472 /* Ask for the first packet to get the stream_id. */
2473 packet_seek(&file_stream->pos.parent, 0, SEEK_SET);
2474 stream_id = file_stream->parent.stream_id;
2475 if (stream_id >= td->streams->len) {
2476 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2477 "in metadata.\n", stream_id);
2478 ret = -EINVAL;
2479 goto end;
2480 }
2481 stream = g_ptr_array_index(td->streams, stream_id);
2482 if (!stream) {
2483 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
2484 "in metadata.\n", stream_id);
2485 ret = -EINVAL;
2486 goto end;
2487 }
2488 file_stream->parent.stream_class = stream;
2489 ret = create_stream_definitions(td, &file_stream->parent);
2490 end:
2491 return ret;
2492 }
2493
2494 static
2495 int ctf_open_mmap_stream_read(struct ctf_trace *td,
2496 struct bt_mmap_stream *mmap_info,
2497 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2498 int whence))
2499 {
2500 int ret;
2501 struct ctf_file_stream *file_stream;
2502
2503 file_stream = g_new0(struct ctf_file_stream, 1);
2504 file_stream->parent.stream_id = -1ULL;
2505 file_stream->pos.last_offset = LAST_OFFSET_POISON;
2506 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
2507
2508 file_stream->pos.packet_seek = packet_seek;
2509
2510 ret = create_trace_definitions(td, &file_stream->parent);
2511 if (ret) {
2512 goto error_def;
2513 }
2514
2515 ret = prepare_mmap_stream_definition(td, file_stream, packet_seek);
2516 if (ret)
2517 goto error_index;
2518
2519 /*
2520 * For now, only a single clock per trace is supported.
2521 */
2522 file_stream->parent.current_clock = td->parent.single_clock;
2523
2524 /* Add stream file to stream class */
2525 g_ptr_array_add(file_stream->parent.stream_class->streams,
2526 &file_stream->parent);
2527 return 0;
2528
2529 error_index:
2530 if (file_stream->parent.trace_packet_header)
2531 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2532 error_def:
2533 g_free(file_stream);
2534 return ret;
2535 }
2536
2537 static
2538 int ctf_open_mmap_trace_read(struct ctf_trace *td,
2539 struct bt_mmap_stream_list *mmap_list,
2540 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2541 int whence),
2542 FILE *metadata_fp)
2543 {
2544 int ret;
2545 struct bt_mmap_stream *mmap_info;
2546
2547 td->scanner = ctf_scanner_alloc();
2548 if (!td->scanner) {
2549 fprintf(stderr, "[error] Error allocating scanner\n");
2550 ret = -ENOMEM;
2551 goto error;
2552 }
2553 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0);
2554 if (ret) {
2555 if (ret == -ENOENT) {
2556 fprintf(stderr, "[warning] Empty metadata.\n");
2557 }
2558 goto error;
2559 }
2560
2561 /*
2562 * for each stream, try to open, check magic number, and get the
2563 * stream ID to add to the right location in the stream array.
2564 */
2565 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
2566 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
2567 if (ret) {
2568 fprintf(stderr, "[error] Open file mmap stream error.\n");
2569 goto error;
2570 }
2571 }
2572 return 0;
2573
2574 error:
2575 ctf_scanner_free(td->scanner);
2576 return ret;
2577 }
2578
2579 static
2580 struct bt_trace_descriptor *ctf_open_mmap_trace(
2581 struct bt_mmap_stream_list *mmap_list,
2582 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
2583 int whence),
2584 FILE *metadata_fp)
2585 {
2586 struct ctf_trace *td;
2587 int ret;
2588
2589 if (!metadata_fp) {
2590 fprintf(stderr, "[error] No metadata file pointer associated, "
2591 "required for mmap parsing\n");
2592 goto error;
2593 }
2594 if (!packet_seek) {
2595 fprintf(stderr, "[error] packet_seek function undefined.\n");
2596 goto error;
2597 }
2598 td = g_new0(struct ctf_trace, 1);
2599 td->dirfd = -1;
2600 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
2601 if (ret)
2602 goto error_free;
2603
2604 ret = trace_debug_info_create(td);
2605 if (ret) {
2606 goto error_free;
2607 }
2608
2609 return &td->parent;
2610
2611 error_free:
2612 g_free(td);
2613 error:
2614 return NULL;
2615 }
2616
2617 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
2618 FILE *metadata_fp)
2619 {
2620 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2621 int i, j;
2622 int ret;
2623
2624 if (!td->scanner)
2625 return -EINVAL;
2626 ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1);
2627 if (ret)
2628 return ret;
2629 /* for each stream_class */
2630 for (i = 0; i < td->streams->len; i++) {
2631 struct ctf_stream_declaration *stream_class;
2632
2633 stream_class = g_ptr_array_index(td->streams, i);
2634 if (!stream_class)
2635 continue;
2636 /* for each stream */
2637 for (j = 0; j < stream_class->streams->len; j++) {
2638 struct ctf_stream_definition *stream;
2639
2640 stream = g_ptr_array_index(stream_class->streams, j);
2641 if (!stream)
2642 continue;
2643 ret = copy_event_declarations_stream_class_to_stream(td,
2644 stream_class, stream);
2645 if (ret)
2646 return ret;
2647 }
2648 }
2649 return 0;
2650 }
2651
2652 static
2653 int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp)
2654 {
2655 int i, j, k;
2656 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2657
2658 /* for each stream_class */
2659 for (i = 0; i < td->streams->len; i++) {
2660 struct ctf_stream_declaration *stream_class;
2661
2662 stream_class = g_ptr_array_index(td->streams, i);
2663 if (!stream_class)
2664 continue;
2665 /* for each file_stream */
2666 for (j = 0; j < stream_class->streams->len; j++) {
2667 struct ctf_stream_definition *stream;
2668 struct ctf_stream_pos *stream_pos;
2669 struct ctf_file_stream *cfs;
2670
2671 stream = g_ptr_array_index(stream_class->streams, j);
2672 if (!stream)
2673 continue;
2674 cfs = container_of(stream, struct ctf_file_stream,
2675 parent);
2676 stream_pos = &cfs->pos;
2677 if (!stream_pos->packet_index)
2678 continue;
2679
2680 for (k = 0; k < stream_pos->packet_index->len; k++) {
2681 struct packet_index *index;
2682
2683 index = &g_array_index(stream_pos->packet_index,
2684 struct packet_index, k);
2685 index->ts_real.timestamp_begin =
2686 ctf_get_real_timestamp(stream,
2687 index->ts_cycles.timestamp_begin);
2688 index->ts_real.timestamp_end =
2689 ctf_get_real_timestamp(stream,
2690 index->ts_cycles.timestamp_end);
2691 }
2692 }
2693 }
2694 return 0;
2695 }
2696
2697 static
2698 int ctf_close_file_stream(struct ctf_file_stream *file_stream)
2699 {
2700 int ret;
2701
2702 ret = ctf_fini_pos(&file_stream->pos);
2703 if (ret) {
2704 fprintf(stderr, "Error on ctf_fini_pos\n");
2705 return -1;
2706 }
2707 if (file_stream->pos.fd >= 0) {
2708 ret = close(file_stream->pos.fd);
2709 if (ret) {
2710 perror("Error closing file fd");
2711 return -1;
2712 }
2713 }
2714 return 0;
2715 }
2716
2717 static
2718 int ctf_close_trace(struct bt_trace_descriptor *tdp)
2719 {
2720 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
2721 int ret;
2722
2723 if (td->streams) {
2724 int i;
2725
2726 for (i = 0; i < td->streams->len; i++) {
2727 struct ctf_stream_declaration *stream;
2728 int j;
2729
2730 stream = g_ptr_array_index(td->streams, i);
2731 if (!stream)
2732 continue;
2733 for (j = 0; j < stream->streams->len; j++) {
2734 struct ctf_file_stream *file_stream;
2735 file_stream = container_of(g_ptr_array_index(stream->streams, j),
2736 struct ctf_file_stream, parent);
2737 ret = ctf_close_file_stream(file_stream);
2738 if (ret)
2739 return ret;
2740 }
2741 }
2742 }
2743 ctf_destroy_metadata(td);
2744 ctf_scanner_free(td->scanner);
2745 if (td->dirfd >= 0) {
2746 ret = close(td->dirfd);
2747 if (ret) {
2748 perror("Error closing dirfd");
2749 return ret;
2750 }
2751 }
2752 if (td->dir) {
2753 ret = closedir(td->dir);
2754 if (ret) {
2755 perror("Error closedir");
2756 return ret;
2757 }
2758 }
2759 free(td->metadata_string);
2760 trace_debug_info_destroy(td);
2761 g_free(td);
2762 return 0;
2763 }
2764
2765 static
2766 void ctf_set_context(struct bt_trace_descriptor *descriptor,
2767 struct bt_context *ctx)
2768 {
2769 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2770 parent);
2771
2772 td->parent.ctx = ctx;
2773 }
2774
2775 static
2776 void ctf_set_handle(struct bt_trace_descriptor *descriptor,
2777 struct bt_trace_handle *handle)
2778 {
2779 struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
2780 parent);
2781
2782 td->parent.handle = handle;
2783 }
2784
2785 static
2786 void __attribute__((constructor)) ctf_init(void)
2787 {
2788 int ret;
2789
2790 ctf_format.name = g_quark_from_static_string("ctf");
2791 ret = bt_register_format(&ctf_format);
2792 assert(!ret);
2793 }
2794
2795 static
2796 void __attribute__((destructor)) ctf_exit(void)
2797 {
2798 bt_unregister_format(&ctf_format);
2799 }
BabelTrace - Trace Format Babel Tower
This page took 0.139117 seconds and 3 git commands to generate.