projects / babeltrace.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Clean-up: Use memset() to initialize packet_index
[babeltrace.git] / formats / ctf / ctf.c
... / ...
CommitLineData
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
78int opt_clock_cycles,
79 opt_clock_seconds,
80 opt_clock_date,
81 opt_clock_gmt;
82
83uint64_t opt_clock_offset;
84uint64_t opt_clock_offset_ns;
85
86extern 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 */
93int babeltrace_ctf_console_output;
94
95static
96struct 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);
100static
101struct 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);
106static
107void ctf_set_context(struct bt_trace_descriptor *descriptor,
108 struct bt_context *ctx);
109static
110void ctf_set_handle(struct bt_trace_descriptor *descriptor,
111 struct bt_trace_handle *handle);
112
113static
114int ctf_close_trace(struct bt_trace_descriptor *descriptor);
115static
116uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor,
117 struct bt_trace_handle *handle, enum bt_clock_type type);
118static
119uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor,
120 struct bt_trace_handle *handle, enum bt_clock_type type);
121static
122int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp);
123
124static
125rw_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
136static
137rw_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
148static
149struct 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
160static
161uint64_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
215error:
216 return -1ULL;
217}
218
219static
220uint64_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
274error:
275 return -1ULL;
276}
277
278/*
279 * Update stream current timestamp
280 */
281static
282void 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 */
317static
318void 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 }
374seconds:
375 fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
376 ts_sec, ts_nsec);
377
378end:
379 return;
380}
381
382/*
383 * Print timestamp, in cycles
384 */
385static
386void 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
393void 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
404static
405void 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 */
425static
426void 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
462static
463int 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
587error:
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
592static
593int 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
642error:
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 */
651static
652int 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
673begin:
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 */
728retry:
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
748int 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
779int 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
799void 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 */
857void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
858{
859 struct ctf_stream_pos *pos =
860 container_of(stream_pos, struct ctf_stream_pos, parent);
861 struct ctf_file_stream *file_stream =
862 container_of(pos, struct ctf_file_stream, pos);
863 int ret;
864 struct packet_index *packet_index, *prev_index;
865
866 switch (whence) {
867 case SEEK_CUR:
868 case SEEK_SET: /* Fall-through */
869 break; /* OK */
870 default:
871 assert(0);
872 }
873
874 if ((pos->prot & PROT_WRITE) && pos->content_size_loc)
875 *pos->content_size_loc = pos->offset;
876
877 if (pos->base_mma) {
878 /* unmap old base */
879 ret = munmap_align(pos->base_mma);
880 if (ret) {
881 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
882 strerror(errno));
883 assert(0);
884 }
885 pos->base_mma = NULL;
886 }
887
888 /*
889 * The caller should never ask for ctf_move_pos across packets,
890 * except to get exactly at the beginning of the next packet.
891 */
892 if (pos->prot & PROT_WRITE) {
893 switch (whence) {
894 case SEEK_CUR:
895 /* The writer will add padding */
896 pos->mmap_offset += pos->packet_size / CHAR_BIT;
897 break;
898 case SEEK_SET:
899 assert(index == 0); /* only seek supported for now */
900 pos->cur_index = 0;
901 break;
902 default:
903 assert(0);
904 }
905 pos->content_size = -1U; /* Unknown at this point */
906 pos->packet_size = WRITE_PACKET_LEN;
907 do {
908 ret = bt_posix_fallocate(pos->fd, pos->mmap_offset,
909 pos->packet_size / CHAR_BIT);
910 } while (ret == EINTR);
911 assert(ret == 0);
912 pos->offset = 0;
913 } else {
914 read_next_packet:
915 switch (whence) {
916 case SEEK_CUR:
917 {
918 if (pos->offset == EOF) {
919 return;
920 }
921 assert(pos->cur_index < pos->packet_index->len);
922 /* The reader will expect us to skip padding */
923 ++pos->cur_index;
924 break;
925 }
926 case SEEK_SET:
927 if (index >= pos->packet_index->len) {
928 pos->offset = EOF;
929 return;
930 }
931 pos->cur_index = index;
932 break;
933 default:
934 assert(0);
935 }
936
937 packet_index = &g_array_index(pos->packet_index,
938 struct packet_index, pos->cur_index);
939 if (pos->cur_index > 0) {
940 prev_index = &g_array_index(pos->packet_index,
941 struct packet_index,
942 pos->cur_index - 1);
943 } else {
944 prev_index = NULL;
945 }
946 ctf_update_current_packet_index(&file_stream->parent,
947 prev_index, packet_index);
948
949 if (pos->cur_index >= pos->packet_index->len) {
950 pos->offset = EOF;
951 return;
952 }
953
954 /*
955 * We need to check if we are in trace read or called
956 * from packet indexing. In this last case, the
957 * collection is not there, so we cannot print the
958 * timestamps.
959 */
960 if ((&file_stream->parent)->stream_class->trace->parent.collection) {
961 ctf_print_discarded(stderr, &file_stream->parent);
962 }
963
964 packet_index = &g_array_index(pos->packet_index,
965 struct packet_index,
966 pos->cur_index);
967 file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
968
969 file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin;
970
971 /* Lookup context/packet size in index */
972 if (packet_index->data_offset == -1) {
973 ret = find_data_offset(pos, file_stream, packet_index);
974 if (ret < 0) {
975 return;
976 }
977 }
978 pos->content_size = packet_index->content_size;
979 pos->packet_size = packet_index->packet_size;
980 pos->mmap_offset = packet_index->offset;
981 pos->data_offset = packet_index->data_offset;
982 if (pos->data_offset < packet_index->content_size) {
983 pos->offset = 0; /* will read headers */
984 } else if (pos->data_offset == packet_index->content_size) {
985 /* empty packet */
986 pos->offset = packet_index->data_offset;
987 whence = SEEK_CUR;
988 goto read_next_packet;
989 } else {
990 pos->offset = EOF;
991 return;
992 }
993 }
994 /* map new base. Need mapping length from header. */
995 pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
996 pos->flags, pos->fd, pos->mmap_offset);
997 if (pos->base_mma == MAP_FAILED) {
998 fprintf(stderr, "[error] mmap error %s.\n",
999 strerror(errno));
1000 assert(0);
1001 }
1002
1003 /* update trace_packet_header and stream_packet_context */
1004 if (!(pos->prot & PROT_WRITE) &&
1005 file_stream->parent.trace_packet_header) {
1006 /* Read packet header */
1007 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1008 assert(!ret);
1009 }
1010 if (!(pos->prot & PROT_WRITE) &&
1011 file_stream->parent.stream_packet_context) {
1012 /* Read packet context */
1013 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1014 assert(!ret);
1015 }
1016}
1017
1018static
1019int packet_metadata(struct ctf_trace *td, FILE *fp)
1020{
1021 uint32_t magic;
1022 size_t len;
1023 int ret = 0;
1024
1025 len = fread(&magic, sizeof(magic), 1, fp);
1026 if (len != 1) {
1027 goto end;
1028 }
1029 if (magic == TSDL_MAGIC) {
1030 ret = 1;
1031 td->byte_order = BYTE_ORDER;
1032 CTF_TRACE_SET_FIELD(td, byte_order);
1033 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
1034 ret = 1;
1035 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
1036 LITTLE_ENDIAN : BIG_ENDIAN;
1037 CTF_TRACE_SET_FIELD(td, byte_order);
1038 }
1039end:
1040 rewind(fp);
1041 return ret;
1042}
1043
1044/*
1045 * Returns 0 on success, -1 on error.
1046 */
1047static
1048int check_version(unsigned int major, unsigned int minor)
1049{
1050 switch (major) {
1051 case 1:
1052 switch (minor) {
1053 case 8:
1054 return 0;
1055 default:
1056 goto warning;
1057 }
1058 default:
1059 goto warning;
1060
1061 }
1062
1063 /* eventually return an error instead of warning */
1064warning:
1065 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
1066 major, minor);
1067 return 0;
1068}
1069
1070static
1071int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
1072 FILE *out)
1073{
1074 struct metadata_packet_header header;
1075 size_t readlen, writelen, toread;
1076 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
1077 int ret = 0;
1078
1079 readlen = fread(&header, header_sizeof(header), 1, in);
1080 if (readlen < 1)
1081 return -EINVAL;
1082
1083 if (td->byte_order != BYTE_ORDER) {
1084 header.magic = GUINT32_SWAP_LE_BE(header.magic);
1085 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
1086 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
1087 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
1088 }
1089 if (header.checksum)
1090 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
1091 if (header.compression_scheme) {
1092 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
1093 header.compression_scheme);
1094 return -EINVAL;
1095 }
1096 if (header.encryption_scheme) {
1097 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
1098 header.encryption_scheme);
1099 return -EINVAL;
1100 }
1101 if (header.checksum_scheme) {
1102 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
1103 header.checksum_scheme);
1104 return -EINVAL;
1105 }
1106 if (check_version(header.major, header.minor) < 0)
1107 return -EINVAL;
1108 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
1109 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
1110 CTF_TRACE_SET_FIELD(td, uuid);
1111 } else {
1112 if (bt_uuid_compare(header.uuid, td->uuid))
1113 return -EINVAL;
1114 }
1115
1116 if ((header.content_size / CHAR_BIT) < header_sizeof(header))
1117 return -EINVAL;
1118
1119 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
1120
1121 for (;;) {
1122 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
1123 if (ferror(in)) {
1124 ret = -EINVAL;
1125 break;
1126 }
1127 if (babeltrace_debug) {
1128 buf[readlen] = '\0';
1129 fprintf(stderr, "[debug] metadata packet read: %s\n",
1130 buf);
1131 }
1132
1133 writelen = fwrite(buf, sizeof(char), readlen, out);
1134 if (writelen < readlen) {
1135 ret = -EIO;
1136 break;
1137 }
1138 if (ferror(out)) {
1139 ret = -EINVAL;
1140 break;
1141 }
1142 toread -= readlen;
1143 if (!toread) {
1144 ret = 0; /* continue reading next packet */
1145 goto read_padding;
1146 }
1147 }
1148 return ret;
1149
1150read_padding:
1151 toread = (header.packet_size - header.content_size) / CHAR_BIT;
1152 ret = fseek(in, toread, SEEK_CUR);
1153 if (ret < 0) {
1154 fprintf(stderr, "[warning] Missing padding at end of file\n");
1155 ret = 0;
1156 }
1157 return ret;
1158}
1159
1160static
1161int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
1162 char **buf)
1163{
1164 FILE *in, *out;
1165 size_t size, buflen;
1166 int ret;
1167
1168 in = *fp;
1169 /*
1170 * Using strlen on *buf instead of size of open_memstream
1171 * because its size includes garbage at the end (after final
1172 * \0). This is the allocated size, not the actual string size.
1173 */
1174 out = babeltrace_open_memstream(buf, &size);
1175 if (out == NULL) {
1176 perror("Metadata open_memstream");
1177 return -errno;
1178 }
1179 for (;;) {
1180 ret = ctf_trace_metadata_packet_read(td, in, out);
1181 if (ret) {
1182 break;
1183 }
1184 if (feof(in)) {
1185 ret = 0;
1186 break;
1187 }
1188 }
1189 /* close to flush the buffer */
1190 ret = babeltrace_close_memstream(buf, &size, out);
1191 if (ret < 0) {
1192 int closeret;
1193
1194 perror("babeltrace_flush_memstream");
1195 ret = -errno;
1196 closeret = fclose(in);
1197 if (closeret) {
1198 perror("Error in fclose");
1199 }
1200 return ret;
1201 }
1202 ret = fclose(in);
1203 if (ret) {
1204 perror("Error in fclose");
1205 }
1206 /* open for reading */
1207 buflen = strlen(*buf);
1208 if (!buflen) {
1209 *fp = NULL;
1210 return -ENOENT;
1211 }
1212 *fp = babeltrace_fmemopen(*buf, buflen, "rb");
1213 if (!*fp) {
1214 perror("Metadata fmemopen");
1215 return -errno;
1216 }
1217 return 0;
1218}
1219
1220static
1221int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp,
1222 struct ctf_scanner *scanner, int append)
1223{
1224 struct ctf_file_stream *metadata_stream;
1225 FILE *fp;
1226 char *buf = NULL;
1227 int ret = 0, closeret;
1228
1229 metadata_stream = g_new0(struct ctf_file_stream, 1);
1230 metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1231
1232 if (metadata_fp) {
1233 fp = metadata_fp;
1234 metadata_stream->pos.fd = -1;
1235 } else {
1236 td->metadata = &metadata_stream->parent;
1237 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1238 if (metadata_stream->pos.fd < 0) {
1239 fprintf(stderr, "Unable to open metadata.\n");
1240 ret = -1;
1241 goto end_free;
1242 }
1243
1244 fp = fdopen(metadata_stream->pos.fd, "r");
1245 if (!fp) {
1246 fprintf(stderr, "[error] Unable to open metadata stream.\n");
1247 perror("Metadata stream open");
1248 ret = -errno;
1249 goto end_stream;
1250 }
1251 /* fd now belongs to fp */
1252 metadata_stream->pos.fd = -1;
1253 }
1254 if (babeltrace_debug)
1255 yydebug = 1;
1256
1257 if (packet_metadata(td, fp)) {
1258 ret = ctf_trace_metadata_stream_read(td, &fp, &buf);
1259 if (ret) {
1260 goto end;
1261 }
1262 td->metadata_string = buf;
1263 td->metadata_packetized = 1;
1264 } else {
1265 if (!append) {
1266 unsigned int major, minor;
1267 ssize_t nr_items;
1268
1269 td->byte_order = BYTE_ORDER;
1270
1271 /* Check text-only metadata header and version */
1272 nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
1273 if (nr_items < 2)
1274 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1275 if (check_version(major, minor) < 0) {
1276 ret = -EINVAL;
1277 goto end;
1278 }
1279 rewind(fp);
1280 }
1281 }
1282
1283 ret = ctf_scanner_append_ast(scanner, fp);
1284 if (ret) {
1285 fprintf(stderr, "[error] Error creating AST\n");
1286 goto end;
1287 }
1288
1289 if (babeltrace_debug) {
1290 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1291 if (ret) {
1292 fprintf(stderr, "[error] Error visiting AST for XML output\n");
1293 goto end;
1294 }
1295 }
1296
1297 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1298 if (ret) {
1299 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1300 goto end;
1301 }
1302 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1303 td, td->byte_order);
1304 if (ret) {
1305 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1306 goto end;
1307 }
1308end:
1309 if (fp) {
1310 closeret = fclose(fp);
1311 if (closeret) {
1312 perror("Error on fclose");
1313 }
1314 }
1315end_stream:
1316 if (metadata_stream->pos.fd >= 0) {
1317 closeret = close(metadata_stream->pos.fd);
1318 if (closeret) {
1319 perror("Error on metadata stream fd close");
1320 }
1321 }
1322end_free:
1323 if (ret)
1324 g_free(metadata_stream);
1325 return ret;
1326}
1327
1328static
1329struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1330 struct ctf_stream_definition *stream,
1331 struct ctf_event_declaration *event)
1332{
1333 struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1334
1335 if (event->context_decl) {
1336 struct bt_definition *definition =
1337 event->context_decl->p.definition_new(&event->context_decl->p,
1338 stream->parent_def_scope, 0, 0, "event.context");
1339 if (!definition) {
1340 goto error;
1341 }
1342 stream_event->event_context = container_of(definition,
1343 struct definition_struct, p);
1344 stream->parent_def_scope = stream_event->event_context->p.scope;
1345 }
1346 if (event->fields_decl) {
1347 struct bt_definition *definition =
1348 event->fields_decl->p.definition_new(&event->fields_decl->p,
1349 stream->parent_def_scope, 0, 0, "event.fields");
1350 if (!definition) {
1351 goto error;
1352 }
1353 stream_event->event_fields = container_of(definition,
1354 struct definition_struct, p);
1355 stream->parent_def_scope = stream_event->event_fields->p.scope;
1356 }
1357 stream_event->stream = stream;
1358 return stream_event;
1359
1360error:
1361 if (stream_event->event_fields)
1362 bt_definition_unref(&stream_event->event_fields->p);
1363 if (stream_event->event_context)
1364 bt_definition_unref(&stream_event->event_context->p);
1365 fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n",
1366 g_quark_to_string(event->name));
1367 return NULL;
1368}
1369
1370static
1371int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td,
1372 struct ctf_stream_declaration *stream_class,
1373 struct ctf_stream_definition *stream)
1374{
1375 size_t def_size, class_size, i;
1376 int ret = 0;
1377
1378 def_size = stream->events_by_id->len;
1379 class_size = stream_class->events_by_id->len;
1380
1381 g_ptr_array_set_size(stream->events_by_id, class_size);
1382 for (i = def_size; i < class_size; i++) {
1383 struct ctf_event_declaration *event =
1384 g_ptr_array_index(stream_class->events_by_id, i);
1385 struct ctf_event_definition *stream_event;
1386
1387 if (!event)
1388 continue;
1389 stream_event = create_event_definitions(td, stream, event);
1390 if (!stream_event) {
1391 ret = -EINVAL;
1392 goto error;
1393 }
1394 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1395 }
1396error:
1397 return ret;
1398}
1399
1400static
1401int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1402{
1403 struct ctf_stream_declaration *stream_class;
1404 int ret;
1405 int i;
1406
1407 if (stream->stream_definitions_created)
1408 return 0;
1409
1410 stream_class = stream->stream_class;
1411
1412 if (stream_class->packet_context_decl) {
1413 struct bt_definition *definition =
1414 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1415 stream->parent_def_scope, 0, 0, "stream.packet.context");
1416 if (!definition) {
1417 ret = -EINVAL;
1418 goto error;
1419 }
1420 stream->stream_packet_context = container_of(definition,
1421 struct definition_struct, p);
1422 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1423 }
1424 if (stream_class->event_header_decl) {
1425 struct bt_definition *definition =
1426 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1427 stream->parent_def_scope, 0, 0, "stream.event.header");
1428 if (!definition) {
1429 ret = -EINVAL;
1430 goto error;
1431 }
1432 stream->stream_event_header =
1433 container_of(definition, struct definition_struct, p);
1434 stream->parent_def_scope = stream->stream_event_header->p.scope;
1435 }
1436 if (stream_class->event_context_decl) {
1437 struct bt_definition *definition =
1438 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1439 stream->parent_def_scope, 0, 0, "stream.event.context");
1440 if (!definition) {
1441 ret = -EINVAL;
1442 goto error;
1443 }
1444 stream->stream_event_context =
1445 container_of(definition, struct definition_struct, p);
1446 stream->parent_def_scope = stream->stream_event_context->p.scope;
1447 }
1448 stream->events_by_id = g_ptr_array_new();
1449 ret = copy_event_declarations_stream_class_to_stream(td,
1450 stream_class, stream);
1451 if (ret)
1452 goto error_event;
1453 return 0;
1454
1455error_event:
1456 for (i = 0; i < stream->events_by_id->len; i++) {
1457 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1458 if (stream_event)
1459 g_free(stream_event);
1460 }
1461 g_ptr_array_free(stream->events_by_id, TRUE);
1462error:
1463 if (stream->stream_event_context)
1464 bt_definition_unref(&stream->stream_event_context->p);
1465 if (stream->stream_event_header)
1466 bt_definition_unref(&stream->stream_event_header->p);
1467 if (stream->stream_packet_context)
1468 bt_definition_unref(&stream->stream_packet_context->p);
1469 fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n",
1470 stream_class->stream_id, strerror(-ret));
1471 return ret;
1472}
1473
1474static
1475int stream_assign_class(struct ctf_trace *td,
1476 struct ctf_file_stream *file_stream,
1477 uint64_t stream_id)
1478{
1479 struct ctf_stream_declaration *stream;
1480 int ret;
1481
1482 file_stream->parent.stream_id = stream_id;
1483 if (stream_id >= td->streams->len) {
1484 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1485 return -EINVAL;
1486 }
1487 stream = g_ptr_array_index(td->streams, stream_id);
1488 if (!stream) {
1489 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1490 return -EINVAL;
1491 }
1492 file_stream->parent.stream_class = stream;
1493 ret = create_stream_definitions(td, &file_stream->parent);
1494 if (ret)
1495 return ret;
1496 return 0;
1497}
1498
1499static
1500int create_stream_one_packet_index(struct ctf_stream_pos *pos,
1501 struct ctf_trace *td,
1502 struct ctf_file_stream *file_stream,
1503 size_t filesize)
1504{
1505 struct packet_index packet_index;
1506 uint64_t stream_id = 0;
1507 uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
1508 int first_packet = 0;
1509 int len_index;
1510 int ret;
1511
1512begin:
1513 memset(&packet_index, 0, sizeof(packet_index));
1514 if (!pos->mmap_offset) {
1515 first_packet = 1;
1516 }
1517
1518 if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) {
1519 packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT;
1520 }
1521
1522 if (pos->base_mma) {
1523 /* unmap old base */
1524 ret = munmap_align(pos->base_mma);
1525 if (ret) {
1526 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1527 strerror(errno));
1528 return ret;
1529 }
1530 pos->base_mma = NULL;
1531 }
1532 /* map new base. Need mapping length from header. */
1533 pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ,
1534 MAP_PRIVATE, pos->fd, pos->mmap_offset);
1535 assert(pos->base_mma != MAP_FAILED);
1536 /*
1537 * Use current mapping size as temporary content and packet
1538 * size.
1539 */
1540 pos->content_size = packet_map_len;
1541 pos->packet_size = packet_map_len;
1542 pos->offset = 0; /* Position of the packet header */
1543
1544 packet_index.offset = pos->mmap_offset;
1545
1546 /* read and check header, set stream id (and check) */
1547 if (file_stream->parent.trace_packet_header) {
1548 /* Read packet header */
1549 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1550 if (ret) {
1551 if (ret == -EFAULT)
1552 goto retry;
1553 fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret));
1554 return ret;
1555 }
1556 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1557 if (len_index >= 0) {
1558 struct bt_definition *field;
1559 uint64_t magic;
1560
1561 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1562 magic = bt_get_unsigned_int(field);
1563 if (magic != CTF_MAGIC) {
1564 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1565 magic,
1566 file_stream->pos.packet_index->len,
1567 (ssize_t) pos->mmap_offset);
1568 return -EINVAL;
1569 }
1570 }
1571
1572 /* check uuid */
1573 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1574 if (len_index >= 0) {
1575 struct definition_array *defarray;
1576 struct bt_definition *field;
1577 uint64_t i;
1578 uint8_t uuidval[BABELTRACE_UUID_LEN];
1579
1580 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1581 assert(field->declaration->id == CTF_TYPE_ARRAY);
1582 defarray = container_of(field, struct definition_array, p);
1583 assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN);
1584
1585 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1586 struct bt_definition *elem;
1587
1588 elem = bt_array_index(defarray, i);
1589 uuidval[i] = bt_get_unsigned_int(elem);
1590 }
1591 ret = bt_uuid_compare(td->uuid, uuidval);
1592 if (ret) {
1593 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1594 return -EINVAL;
1595 }
1596 }
1597
1598 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1599 if (len_index >= 0) {
1600 struct bt_definition *field;
1601
1602 field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1603 stream_id = bt_get_unsigned_int(field);
1604 }
1605 }
1606
1607 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1608 fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n",
1609 stream_id,
1610 file_stream->parent.stream_id);
1611 return -EINVAL;
1612 }
1613 if (first_packet) {
1614 ret = stream_assign_class(td, file_stream, stream_id);
1615 if (ret)
1616 return ret;
1617 }
1618
1619 if (file_stream->parent.stream_packet_context) {
1620 /* Read packet context */
1621 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1622 if (ret) {
1623 if (ret == -EFAULT)
1624 goto retry;
1625 fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret));
1626 return ret;
1627 }
1628 /* read packet size from header */
1629 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1630 if (len_index >= 0) {
1631 struct bt_definition *field;
1632
1633 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1634 packet_index.packet_size = bt_get_unsigned_int(field);
1635 } else {
1636 /* Use file size for packet size */
1637 packet_index.packet_size = filesize * CHAR_BIT;
1638 }
1639
1640 /* read content size from header */
1641 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1642 if (len_index >= 0) {
1643 struct bt_definition *field;
1644
1645 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1646 packet_index.content_size = bt_get_unsigned_int(field);
1647 } else {
1648 /* Use packet size if non-zero, else file size */
1649 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1650 }
1651
1652 /* read timestamp begin from header */
1653 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1654 if (len_index >= 0) {
1655 struct bt_definition *field;
1656
1657 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1658 packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
1659 if (file_stream->parent.stream_class->trace->parent.collection) {
1660 packet_index.ts_real.timestamp_begin =
1661 ctf_get_real_timestamp(
1662 &file_stream->parent,
1663 packet_index.ts_cycles.timestamp_begin);
1664 }
1665 }
1666
1667 /* read timestamp end from header */
1668 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1669 if (len_index >= 0) {
1670 struct bt_definition *field;
1671
1672 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1673 packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
1674 if (file_stream->parent.stream_class->trace->parent.collection) {
1675 packet_index.ts_real.timestamp_end =
1676 ctf_get_real_timestamp(
1677 &file_stream->parent,
1678 packet_index.ts_cycles.timestamp_end);
1679 }
1680 }
1681
1682 /* read events discarded from header */
1683 len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1684 if (len_index >= 0) {
1685 struct bt_definition *field;
1686
1687 field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1688 packet_index.events_discarded = bt_get_unsigned_int(field);
1689 packet_index.events_discarded_len = bt_get_int_len(field);
1690 }
1691 } else {
1692 /* Use file size for packet size */
1693 packet_index.packet_size = filesize * CHAR_BIT;
1694 /* Use packet size if non-zero, else file size */
1695 packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT;
1696 }
1697
1698 /* Validate content size and packet size values */
1699 if (packet_index.content_size > packet_index.packet_size) {
1700 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1701 packet_index.content_size, packet_index.packet_size);
1702 return -EINVAL;
1703 }
1704
1705 if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) {
1706 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1707 packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT);
1708 return -EINVAL;
1709 }
1710
1711 if (packet_index.content_size < pos->offset) {
1712 fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
1713 return -EINVAL;
1714 }
1715
1716 if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) {
1717 fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n");
1718 return -EINVAL;
1719 }
1720
1721 /* Save position after header and context */
1722 packet_index.data_offset = pos->offset;
1723
1724 /* add index to packet array */
1725 g_array_append_val(file_stream->pos.packet_index, packet_index);
1726
1727 pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
1728
1729 return 0;
1730
1731 /* Retry with larger mapping */
1732retry:
1733 if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) {
1734 /*
1735 * Reached EOF, but still expecting header/context data.
1736 */
1737 fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n");
1738 return -EFAULT;
1739 }
1740 /* Double the mapping len, and retry */
1741 tmp_map_len = packet_map_len << 1;
1742 if (tmp_map_len >> 1 != packet_map_len) {
1743 /* Overflow */
1744 fprintf(stderr, "[error] Packet mapping length overflow\n");
1745 return -EFAULT;
1746 }
1747 packet_map_len = tmp_map_len;
1748 goto begin;
1749}
1750
1751static
1752int create_stream_packet_index(struct ctf_trace *td,
1753 struct ctf_file_stream *file_stream)
1754{
1755 struct ctf_stream_pos *pos;
1756 struct stat filestats;
1757 int ret;
1758
1759 pos = &file_stream->pos;
1760
1761 ret = fstat(pos->fd, &filestats);
1762 if (ret < 0)
1763 return ret;
1764
1765 /* Deal with empty files */
1766 if (!filestats.st_size) {
1767 if (file_stream->parent.trace_packet_header
1768 || file_stream->parent.stream_packet_context) {
1769 /*
1770 * We expect a trace packet header and/or stream packet
1771 * context. Since a trace needs to have at least one
1772 * packet, empty files are therefore not accepted.
1773 */
1774 fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n");
1775 return -EINVAL;
1776 } else {
1777 /*
1778 * Without trace packet header nor stream packet
1779 * context, a one-packet trace can indeed be empty. This
1780 * is only valid if there is only one stream class: 0.
1781 */
1782 ret = stream_assign_class(td, file_stream, 0);
1783 if (ret)
1784 return ret;
1785 return 0;
1786 }
1787 }
1788
1789 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1790 ret = create_stream_one_packet_index(pos, td, file_stream,
1791 filestats.st_size);
1792 if (ret)
1793 return ret;
1794 }
1795 return 0;
1796}
1797
1798static
1799int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1800{
1801 int ret;
1802
1803 if (td->packet_header_decl) {
1804 struct bt_definition *definition =
1805 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1806 stream->parent_def_scope, 0, 0, "trace.packet.header");
1807 if (!definition) {
1808 ret = -EINVAL;
1809 goto error;
1810 }
1811 stream->trace_packet_header =
1812 container_of(definition, struct definition_struct, p);
1813 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1814 }
1815
1816 return 0;
1817
1818error:
1819 fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret));
1820 return ret;
1821}
1822
1823static
1824int import_stream_packet_index(struct ctf_trace *td,
1825 struct ctf_file_stream *file_stream)
1826{
1827 struct ctf_stream_pos *pos;
1828 struct ctf_packet_index *ctf_index = NULL;
1829 struct ctf_packet_index_file_hdr index_hdr;
1830 struct packet_index index;
1831 uint32_t packet_index_len, index_minor;
1832 int ret = 0;
1833 int first_packet = 1;
1834 size_t len;
1835
1836 pos = &file_stream->pos;
1837
1838 len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp);
1839 if (len != 1) {
1840 perror("read index file header");
1841 goto error;
1842 }
1843
1844 /* Check the index header */
1845 if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) {
1846 fprintf(stderr, "[error] wrong index magic\n");
1847 ret = -1;
1848 goto error;
1849 }
1850 if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) {
1851 fprintf(stderr, "[error] Incompatible index file %" PRIu32
1852 ".%" PRIu32 ", supported %d.%d\n",
1853 be32toh(index_hdr.index_major),
1854 be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR,
1855 CTF_INDEX_MINOR);
1856 ret = -1;
1857 goto error;
1858 }
1859 index_minor = be32toh(index_hdr.index_minor);
1860
1861 packet_index_len = be32toh(index_hdr.packet_index_len);
1862 if (packet_index_len == 0) {
1863 fprintf(stderr, "[error] Packet index length cannot be 0.\n");
1864 ret = -1;
1865 goto error;
1866 }
1867 /*
1868 * Allocate the index length found in header, not internal
1869 * representation.
1870 */
1871 ctf_index = g_malloc0(packet_index_len);
1872 while (fread(ctf_index, packet_index_len, 1,
1873 pos->index_fp) == 1) {
1874 uint64_t stream_id;
1875 struct ctf_stream_declaration *stream = NULL;
1876
1877 memset(&index, 0, sizeof(index));
1878 index.offset = be64toh(ctf_index->offset);
1879 index.packet_size = be64toh(ctf_index->packet_size);
1880 index.content_size = be64toh(ctf_index->content_size);
1881 index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin);
1882 index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end);
1883 index.events_discarded = be64toh(ctf_index->events_discarded);
1884 index.events_discarded_len = 64;
1885 index.data_offset = -1;
1886 stream_id = be64toh(ctf_index->stream_id);
1887 if (index_minor >= 1) {
1888 index.stream_instance_id = be64toh(ctf_index->stream_instance_id);
1889 index.packet_seq_num = be64toh(ctf_index->packet_seq_num);
1890 }
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
1926error:
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 */
1935static
1936int 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
2047error_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);
2056error_free:
2057 free(index_name);
2058error_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);
2064fd_is_empty_file:
2065fd_is_dir_ok:
2066fstat_error:
2067 closeret = close(fd);
2068 if (closeret) {
2069 perror("Error on fd close");
2070 }
2071error:
2072 return ret;
2073}
2074
2075static
2076int 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
2171readdir_error:
2172 free(dirent);
2173error_metadata:
2174 closeret = close(td->dirfd);
2175 if (closeret) {
2176 perror("Error on fd close");
2177 }
2178error_dirfd:
2179 closeret = closedir(td->dir);
2180 if (closeret) {
2181 perror("Error on closedir");
2182 }
2183error:
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 */
2192static
2193struct 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;
2227error:
2228 g_free(td);
2229 return NULL;
2230}
2231
2232static
2233void 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
2254static
2255int 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);
2282end:
2283 return ret;
2284}
2285
2286static
2287int 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
2321error_index:
2322 if (file_stream->parent.trace_packet_header)
2323 bt_definition_unref(&file_stream->parent.trace_packet_header->p);
2324error_def:
2325 g_free(file_stream);
2326 return ret;
2327}
2328
2329static
2330int 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
2366error:
2367 ctf_scanner_free(td->scanner);
2368 return ret;
2369}
2370
2371static
2372struct 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
2398error_free:
2399 g_free(td);
2400error:
2401 return NULL;
2402}
2403
2404int 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
2439static
2440int 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
2484static
2485int 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
2504static
2505int 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
2551static
2552void 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
2561static
2562void 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
2571static
2572void __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
2581static
2582void __attribute__((destructor)) ctf_exit(void)
2583{
2584 bt_unregister_format(&ctf_format);
2585}
BabelTrace - Trace Format Babel Tower
This page took 0.031487 seconds and 4 git commands to generate.