Implement fallback for systems lacking open_memstream and fopenmem
[babeltrace.git] / formats / ctf / ctf.c
CommitLineData
fc93b2bd
MD
1/*
2 * BabelTrace - Common Trace Format (CTF)
3 *
4 * Format registration.
5 *
64fa3fec
MD
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fc93b2bd 9 *
ccd7e1c8
MD
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:
fc93b2bd 16 *
ccd7e1c8
MD
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
fc93b2bd
MD
19 */
20
21#include <babeltrace/format.h>
22#include <babeltrace/ctf/types.h>
bbefb8dd 23#include <babeltrace/ctf/metadata.h>
70bd0a12 24#include <babeltrace/babeltrace-internal.h>
e4195791 25#include <babeltrace/ctf/events-internal.h>
43e34335
MD
26#include <babeltrace/uuid.h>
27#include <babeltrace/endian.h>
0f980a35 28#include <inttypes.h>
b4c19c1e 29#include <stdio.h>
0f980a35 30#include <sys/mman.h>
bbefb8dd 31#include <errno.h>
bbefb8dd 32#include <sys/types.h>
65102a8c 33#include <sys/stat.h>
bbefb8dd 34#include <fcntl.h>
65102a8c 35#include <dirent.h>
bbefb8dd 36#include <glib.h>
65102a8c
MD
37#include <unistd.h>
38#include <stdlib.h>
39
65102a8c
MD
40#include "metadata/ctf-scanner.h"
41#include "metadata/ctf-parser.h"
42#include "metadata/ctf-ast.h"
c34ea0fa 43#include "events-private.h"
f8370579 44#include "memstream.h"
65102a8c 45
0f980a35
MD
46/*
47 * We currently simply map a page to read the packet header and packet
8c572eba 48 * context to get the packet length and content length. (in bits)
0f980a35 49 */
8c572eba
MD
50#define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
51#define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
0f980a35 52
a0fe7d97
MD
53#ifndef min
54#define min(a, b) (((a) < (b)) ? (a) : (b))
55#endif
56
7d97fad9
MD
57#define NSEC_PER_SEC 1000000000ULL
58
59int opt_clock_raw,
60 opt_clock_seconds,
61 opt_clock_date,
62 opt_clock_gmt;
63
64uint64_t opt_clock_offset;
65
65102a8c 66extern int yydebug;
bbefb8dd 67
e9378815 68static
5b80ddfb 69struct trace_descriptor *ctf_open_trace(const char *path, int flags,
20d0dcf9
MD
70 void (*packet_seek)(struct stream_pos *pos, size_t index,
71 int whence),
72 FILE *metadata_fp);
e9378815 73static
f571dfb1
JD
74struct trace_descriptor *ctf_open_mmap_trace(
75 struct mmap_stream_list *mmap_list,
20d0dcf9
MD
76 void (*packet_seek)(struct stream_pos *pos, size_t index,
77 int whence),
f571dfb1
JD
78 FILE *metadata_fp);
79
80static
bbefb8dd 81void ctf_close_trace(struct trace_descriptor *descriptor);
fc93b2bd 82
1ae19169
MD
83static
84rw_dispatch read_dispatch_table[] = {
d11e9c49
MD
85 [ CTF_TYPE_INTEGER ] = ctf_integer_read,
86 [ CTF_TYPE_FLOAT ] = ctf_float_read,
87 [ CTF_TYPE_ENUM ] = ctf_enum_read,
88 [ CTF_TYPE_STRING ] = ctf_string_read,
89 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
90 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
81dee1bb
MD
91 [ CTF_TYPE_ARRAY ] = ctf_array_read,
92 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
d11e9c49
MD
93};
94
1ae19169
MD
95static
96rw_dispatch write_dispatch_table[] = {
d11e9c49
MD
97 [ CTF_TYPE_INTEGER ] = ctf_integer_write,
98 [ CTF_TYPE_FLOAT ] = ctf_float_write,
99 [ CTF_TYPE_ENUM ] = ctf_enum_write,
100 [ CTF_TYPE_STRING ] = ctf_string_write,
101 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
102 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
81dee1bb
MD
103 [ CTF_TYPE_ARRAY ] = ctf_array_write,
104 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
d11e9c49
MD
105};
106
1ae19169 107static
d11e9c49 108struct format ctf_format = {
bbefb8dd 109 .open_trace = ctf_open_trace,
f571dfb1 110 .open_mmap_trace = ctf_open_mmap_trace,
bbefb8dd 111 .close_trace = ctf_close_trace,
fc93b2bd
MD
112};
113
25ccc85b
MD
114/*
115 * Update stream current timestamp, keep at clock frequency.
116 */
2b9a764d
MD
117static
118void ctf_update_timestamp(struct ctf_stream *stream,
119 struct definition_integer *integer_definition)
120{
121 struct declaration_integer *integer_declaration =
122 integer_definition->declaration;
123 uint64_t oldval, newval, updateval;
124
7f3f572b 125 if (unlikely(integer_declaration->len == 64)) {
2b9a764d
MD
126 stream->timestamp = integer_definition->value._unsigned;
127 return;
128 }
129 /* keep low bits */
130 oldval = stream->timestamp;
131 oldval &= (1ULL << integer_declaration->len) - 1;
132 newval = integer_definition->value._unsigned;
133 /* Test for overflow by comparing low bits */
134 if (newval < oldval)
135 newval += 1ULL << integer_declaration->len;
136 /* updateval contains old high bits, and new low bits (sum) */
137 updateval = stream->timestamp;
138 updateval &= ~((1ULL << integer_declaration->len) - 1);
139 updateval += newval;
fca04958 140 stream->prev_timestamp = stream->timestamp;
2b9a764d
MD
141 stream->timestamp = updateval;
142}
143
25ccc85b
MD
144/*
145 * Print timestamp, rescaling clock frequency to nanoseconds and
146 * applying offsets as needed (unix time).
147 */
7d97fad9
MD
148void ctf_print_timestamp(FILE *fp,
149 struct ctf_stream *stream,
150 uint64_t timestamp)
151{
152 uint64_t ts_sec = 0, ts_nsec;
7d97fad9 153
c34ea0fa
MD
154 if (opt_clock_raw) {
155 ts_nsec = ctf_get_timestamp_raw(stream, timestamp);
25ccc85b 156 } else {
c34ea0fa 157 ts_nsec = ctf_get_timestamp(stream, timestamp);
25ccc85b 158 }
7d97fad9 159
c34ea0fa 160 /* Add command-line offset */
7d97fad9
MD
161 ts_sec += opt_clock_offset;
162
163 ts_sec += ts_nsec / NSEC_PER_SEC;
164 ts_nsec = ts_nsec % NSEC_PER_SEC;
165
166 if (!opt_clock_seconds) {
167 struct tm tm;
168 time_t time_s = (time_t) ts_sec;
169
170 if (!opt_clock_gmt) {
171 struct tm *res;
172
173 res = localtime_r(&time_s, &tm);
174 if (!res) {
175 fprintf(stderr, "[warning] Unable to get localtime.\n");
176 goto seconds;
177 }
178 } else {
179 struct tm *res;
180
181 res = gmtime_r(&time_s, &tm);
182 if (!res) {
183 fprintf(stderr, "[warning] Unable to get gmtime.\n");
184 goto seconds;
185 }
186 }
187 if (opt_clock_date) {
188 char timestr[26];
189 size_t res;
190
191 /* Print date and time */
192 res = strftime(timestr, sizeof(timestr),
193 "%F ", &tm);
194 if (!res) {
195 fprintf(stderr, "[warning] Unable to print ascii time.\n");
196 goto seconds;
197 }
198 fprintf(fp, "%s", timestr);
199 }
200 /* Print time in HH:MM:SS.ns */
201 fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
202 tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
203 goto end;
204 }
205seconds:
206 fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
207 ts_sec, ts_nsec);
208
209end:
210 return;
211}
212
31262354 213static
764af3f4 214int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
31262354
MD
215{
216 struct ctf_stream_pos *pos =
217 container_of(ppos, struct ctf_stream_pos, parent);
764af3f4 218 struct ctf_stream_class *stream_class = stream->stream_class;
42dc00b7 219 struct ctf_stream_event *event;
31262354 220 uint64_t id = 0;
31262354
MD
221 int ret;
222
3abe83c7
MD
223 /* We need to check for EOF here for empty files. */
224 if (unlikely(pos->offset == EOF))
225 return EOF;
226
5f643ed7
MD
227 ctf_pos_get_event(pos);
228
90fcbacc
JD
229 /* save the current position as a restore point */
230 pos->last_offset = pos->offset;
231 /* we just read the event, it is consumed when used by the caller */
232 stream->consumed = 0;
233
3abe83c7
MD
234 /*
235 * This is the EOF check after we've advanced the position in
236 * ctf_pos_get_event.
237 */
7f3f572b 238 if (unlikely(pos->offset == EOF))
31262354 239 return EOF;
5f643ed7 240 assert(pos->offset < pos->content_size);
31262354
MD
241
242 /* Read event header */
7f3f572b 243 if (likely(stream->stream_event_header)) {
a35173fe 244 struct definition_integer *integer_definition;
ccdb988e 245 struct definition *variant;
a35173fe 246
e28d4618 247 ret = generic_rw(ppos, &stream->stream_event_header->p);
7f3f572b 248 if (unlikely(ret))
31262354
MD
249 goto error;
250 /* lookup event id */
e28d4618 251 integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
a35173fe
MD
252 if (integer_definition) {
253 id = integer_definition->value._unsigned;
254 } else {
255 struct definition_enum *enum_definition;
256
e28d4618 257 enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
a35173fe
MD
258 if (enum_definition) {
259 id = enum_definition->integer->value._unsigned;
260 }
31262354 261 }
764af3f4 262
e28d4618 263 variant = lookup_variant(&stream->stream_event_header->p, "v");
ccdb988e
MD
264 if (variant) {
265 integer_definition = lookup_integer(variant, "id", FALSE);
266 if (integer_definition) {
267 id = integer_definition->value._unsigned;
268 }
269 }
c87a8eb2 270 stream->event_id = id;
ccdb988e 271
764af3f4 272 /* lookup timestamp */
5e2eb0ae 273 stream->has_timestamp = 0;
e28d4618 274 integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
a35173fe 275 if (integer_definition) {
2b9a764d 276 ctf_update_timestamp(stream, integer_definition);
5e2eb0ae 277 stream->has_timestamp = 1;
a35173fe 278 } else {
ccdb988e
MD
279 if (variant) {
280 integer_definition = lookup_integer(variant, "timestamp", FALSE);
a35173fe 281 if (integer_definition) {
2b9a764d 282 ctf_update_timestamp(stream, integer_definition);
5e2eb0ae 283 stream->has_timestamp = 1;
a35173fe
MD
284 }
285 }
764af3f4 286 }
31262354
MD
287 }
288
289 /* Read stream-declared event context */
e28d4618
MD
290 if (stream->stream_event_context) {
291 ret = generic_rw(ppos, &stream->stream_event_context->p);
31262354
MD
292 if (ret)
293 goto error;
294 }
295
7f3f572b 296 if (unlikely(id >= stream_class->events_by_id->len)) {
3394d22e 297 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
31262354
MD
298 return -EINVAL;
299 }
e28d4618 300 event = g_ptr_array_index(stream->events_by_id, id);
7f3f572b 301 if (unlikely(!event)) {
3394d22e 302 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
31262354
MD
303 return -EINVAL;
304 }
305
306 /* Read event-declared event context */
e28d4618
MD
307 if (event->event_context) {
308 ret = generic_rw(ppos, &event->event_context->p);
31262354
MD
309 if (ret)
310 goto error;
311 }
312
313 /* Read event payload */
7f3f572b 314 if (likely(event->event_fields)) {
e28d4618 315 ret = generic_rw(ppos, &event->event_fields->p);
31262354
MD
316 if (ret)
317 goto error;
318 }
319
320 return 0;
321
322error:
3394d22e 323 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
31262354
MD
324 return ret;
325}
326
327static
764af3f4 328int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream)
31262354 329{
764af3f4 330 struct ctf_stream_class *stream_class = stream->stream_class;
42dc00b7 331 struct ctf_stream_event *event;
c87a8eb2 332 uint64_t id;
31262354
MD
333 int ret;
334
c87a8eb2
MD
335 id = stream->event_id;
336
31262354 337 /* print event header */
7f3f572b 338 if (likely(stream->stream_event_header)) {
e28d4618 339 ret = generic_rw(pos, &stream->stream_event_header->p);
31262354
MD
340 if (ret)
341 goto error;
342 }
343
344 /* print stream-declared event context */
e28d4618
MD
345 if (stream->stream_event_context) {
346 ret = generic_rw(pos, &stream->stream_event_context->p);
31262354
MD
347 if (ret)
348 goto error;
349 }
350
7f3f572b 351 if (unlikely(id >= stream_class->events_by_id->len)) {
3394d22e 352 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
31262354
MD
353 return -EINVAL;
354 }
e28d4618 355 event = g_ptr_array_index(stream->events_by_id, id);
7f3f572b 356 if (unlikely(!event)) {
3394d22e 357 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
31262354
MD
358 return -EINVAL;
359 }
360
361 /* print event-declared event context */
e28d4618
MD
362 if (event->event_context) {
363 ret = generic_rw(pos, &event->event_context->p);
31262354
MD
364 if (ret)
365 goto error;
366 }
367
368 /* Read and print event payload */
7f3f572b 369 if (likely(event->event_fields)) {
e28d4618 370 ret = generic_rw(pos, &event->event_fields->p);
31262354
MD
371 if (ret)
372 goto error;
373 }
374
375 return 0;
376
377error:
3394d22e 378 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
31262354
MD
379 return ret;
380}
381
8563e754 382void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
8c572eba
MD
383{
384 pos->fd = fd;
385 pos->mmap_offset = 0;
386 pos->packet_size = 0;
387 pos->content_size = 0;
388 pos->content_size_loc = NULL;
389 pos->base = NULL;
390 pos->offset = 0;
391 pos->dummy = false;
8c572eba 392 pos->cur_index = 0;
8563e754
MD
393 if (fd >= 0)
394 pos->packet_index = g_array_new(FALSE, TRUE,
395 sizeof(struct packet_index));
396 else
397 pos->packet_index = NULL;
8563e754
MD
398 switch (open_flags & O_ACCMODE) {
399 case O_RDONLY:
400 pos->prot = PROT_READ;
401 pos->flags = MAP_PRIVATE;
402 pos->parent.rw_table = read_dispatch_table;
31262354 403 pos->parent.event_cb = ctf_read_event;
8563e754 404 break;
8563e754
MD
405 case O_RDWR:
406 pos->prot = PROT_WRITE; /* Write has priority */
407 pos->flags = MAP_SHARED;
408 pos->parent.rw_table = write_dispatch_table;
31262354 409 pos->parent.event_cb = ctf_write_event;
8563e754 410 if (fd >= 0)
06789ffd 411 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
8563e754
MD
412 break;
413 default:
414 assert(0);
8c572eba
MD
415 }
416}
417
46322b33 418void ctf_fini_pos(struct ctf_stream_pos *pos)
8c572eba
MD
419{
420 int ret;
421
422 if (pos->prot == PROT_WRITE && pos->content_size_loc)
423 *pos->content_size_loc = pos->offset;
424 if (pos->base) {
425 /* unmap old base */
426 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
427 if (ret) {
3394d22e 428 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
8c572eba
MD
429 strerror(errno));
430 assert(0);
431 }
432 }
433 (void) g_array_free(pos->packet_index, TRUE);
434}
435
20d0dcf9
MD
436/*
437 * for SEEK_CUR: go to next packet.
438 * for SEEK_POS: go to packet numer (index).
439 */
440void ctf_packet_seek(struct stream_pos *stream_pos, size_t index, int whence)
0f980a35 441{
d6425aaf
MD
442 struct ctf_stream_pos *pos =
443 container_of(stream_pos, struct ctf_stream_pos, parent);
75cc2c35
MD
444 struct ctf_file_stream *file_stream =
445 container_of(pos, struct ctf_file_stream, pos);
0f980a35 446 int ret;
8c572eba 447 off_t off;
20d0dcf9 448 struct packet_index *packet_index;
0f980a35 449
8c572eba
MD
450 if (pos->prot == PROT_WRITE && pos->content_size_loc)
451 *pos->content_size_loc = pos->offset;
0f980a35
MD
452
453 if (pos->base) {
454 /* unmap old base */
8c572eba 455 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
0f980a35 456 if (ret) {
3394d22e 457 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
0f980a35
MD
458 strerror(errno));
459 assert(0);
460 }
847bf71a 461 pos->base = NULL;
0f980a35
MD
462 }
463
8c572eba 464 /*
46322b33 465 * The caller should never ask for ctf_move_pos across packets,
8c572eba
MD
466 * except to get exactly at the beginning of the next packet.
467 */
468 if (pos->prot == PROT_WRITE) {
989c73bc
MD
469 switch (whence) {
470 case SEEK_CUR:
471 /* The writer will add padding */
8c572eba 472 pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
989c73bc
MD
473 break;
474 case SEEK_SET:
20d0dcf9 475 assert(index == 0); /* only seek supported for now */
989c73bc
MD
476 pos->cur_index = 0;
477 break;
478 default:
479 assert(0);
480 }
8c572eba
MD
481 pos->content_size = -1U; /* Unknown at this point */
482 pos->packet_size = WRITE_PACKET_LEN;
989c73bc
MD
483 off = posix_fallocate(pos->fd, pos->mmap_offset,
484 pos->packet_size / CHAR_BIT);
8c572eba 485 assert(off >= 0);
847bf71a 486 pos->offset = 0;
8c572eba 487 } else {
5f643ed7 488 read_next_packet:
847bf71a
MD
489 switch (whence) {
490 case SEEK_CUR:
41e82e00
MD
491 {
492 uint32_t events_discarded_diff;
493
7d97fad9
MD
494 if (pos->offset == EOF) {
495 return;
496 }
3217ac37 497 /* For printing discarded event count */
20d0dcf9 498 packet_index = &g_array_index(pos->packet_index,
41e82e00 499 struct packet_index, pos->cur_index);
20d0dcf9 500 events_discarded_diff = packet_index->events_discarded;
3217ac37 501 file_stream->parent.prev_timestamp_end =
20d0dcf9 502 packet_index->timestamp_end;
41e82e00 503 if (pos->cur_index > 0) {
20d0dcf9 504 packet_index = &g_array_index(pos->packet_index,
41e82e00
MD
505 struct packet_index,
506 pos->cur_index - 1);
20d0dcf9 507 events_discarded_diff -= packet_index->events_discarded;
41e82e00 508 }
fca04958 509 file_stream->parent.events_discarded = events_discarded_diff;
7d97fad9 510 file_stream->parent.prev_timestamp = file_stream->parent.timestamp;
847bf71a 511 /* The reader will expect us to skip padding */
8c572eba 512 ++pos->cur_index;
847bf71a 513 break;
41e82e00 514 }
847bf71a 515 case SEEK_SET:
20d0dcf9 516 pos->cur_index = index;
fca04958 517 file_stream->parent.prev_timestamp = 0;
3217ac37 518 file_stream->parent.prev_timestamp_end = 0;
847bf71a
MD
519 break;
520 default:
521 assert(0);
522 }
523 if (pos->cur_index >= pos->packet_index->len) {
7d97fad9
MD
524 /*
525 * When a stream reaches the end of the
526 * file, we need to show the number of
527 * events discarded ourselves, because
528 * there is no next event scheduled to
529 * be printed in the output.
530 */
531 if (file_stream->parent.events_discarded) {
badea1a2
JD
532 /*
533 * We need to check if we are in trace
534 * read or called from packet indexing.
535 * In this last case, the collection is
536 * not there, so we cannot print the
537 * timestamps.
538 */
539 if ((&file_stream->parent)->stream_class->trace->collection) {
540 fflush(stdout);
541 fprintf(stderr, "[warning] Tracer discarded %d events at end of stream between [",
542 file_stream->parent.events_discarded);
543 ctf_print_timestamp(stderr, &file_stream->parent,
544 file_stream->parent.prev_timestamp);
545 fprintf(stderr, "] and [");
546 ctf_print_timestamp(stderr, &file_stream->parent,
547 file_stream->parent.prev_timestamp_end);
548 fprintf(stderr, "]. You should consider increasing the buffer size.\n");
549 fflush(stderr);
550 }
7d97fad9
MD
551 file_stream->parent.events_discarded = 0;
552 }
670977d3 553 pos->offset = EOF;
847bf71a
MD
554 return;
555 }
20d0dcf9 556 packet_index = &g_array_index(pos->packet_index, struct packet_index,
8c572eba 557 pos->cur_index);
20d0dcf9 558 pos->mmap_offset = packet_index->offset;
8c572eba
MD
559
560 /* Lookup context/packet size in index */
20d0dcf9
MD
561 file_stream->parent.timestamp = packet_index->timestamp_begin;
562 pos->content_size = packet_index->content_size;
563 pos->packet_size = packet_index->packet_size;
564 if (packet_index->data_offset < packet_index->content_size) {
75cc2c35 565 pos->offset = 0; /* will read headers */
20d0dcf9 566 } else if (packet_index->data_offset == packet_index->content_size) {
5f643ed7 567 /* empty packet */
20d0dcf9 568 pos->offset = packet_index->data_offset;
3abe83c7 569 whence = SEEK_CUR;
5f643ed7 570 goto read_next_packet;
7eda6fc7 571 } else {
2b9a764d
MD
572 pos->offset = EOF;
573 return;
574 }
8c572eba 575 }
0f980a35 576 /* map new base. Need mapping length from header. */
8c572eba
MD
577 pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot,
578 pos->flags, pos->fd, pos->mmap_offset);
847bf71a 579 if (pos->base == MAP_FAILED) {
3394d22e 580 fprintf(stderr, "[error] mmap error %s.\n",
847bf71a
MD
581 strerror(errno));
582 assert(0);
583 }
75cc2c35
MD
584
585 /* update trace_packet_header and stream_packet_context */
2d0bea29 586 if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) {
75cc2c35 587 /* Read packet header */
2d0bea29 588 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
75cc2c35
MD
589 assert(!ret);
590 }
2d0bea29 591 if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) {
75cc2c35 592 /* Read packet context */
2d0bea29 593 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
75cc2c35
MD
594 assert(!ret);
595 }
0f980a35
MD
596}
597
b4c19c1e
MD
598static
599int packet_metadata(struct ctf_trace *td, FILE *fp)
600{
601 uint32_t magic;
602 size_t len;
603 int ret = 0;
604
605 len = fread(&magic, sizeof(magic), 1, fp);
a0fe7d97 606 if (len != 1) {
b4c19c1e
MD
607 goto end;
608 }
609 if (magic == TSDL_MAGIC) {
610 ret = 1;
611 td->byte_order = BYTE_ORDER;
0d336fdf 612 CTF_TRACE_SET_FIELD(td, byte_order);
b4c19c1e
MD
613 } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
614 ret = 1;
615 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
616 LITTLE_ENDIAN : BIG_ENDIAN;
0d336fdf 617 CTF_TRACE_SET_FIELD(td, byte_order);
b4c19c1e
MD
618 }
619end:
620 rewind(fp);
621 return ret;
622}
623
5c262147
MD
624/*
625 * Returns 0 on success, -1 on error.
626 */
627static
628int check_version(unsigned int major, unsigned int minor)
629{
630 switch (major) {
631 case 1:
632 switch (minor) {
633 case 8:
634 return 0;
635 default:
636 goto warning;
637 }
638 default:
639 goto warning;
640
641 }
642
643 /* eventually return an error instead of warning */
644warning:
3394d22e 645 fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
5c262147
MD
646 major, minor);
647 return 0;
648}
649
b4c19c1e
MD
650static
651int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
652 FILE *out)
653{
654 struct metadata_packet_header header;
a0fe7d97 655 size_t readlen, writelen, toread;
f8254867 656 char buf[4096 + 1]; /* + 1 for debug-mode \0 */
b4c19c1e
MD
657 int ret = 0;
658
a91a962e 659 readlen = fread(&header, header_sizeof(header), 1, in);
a0fe7d97 660 if (readlen < 1)
b4c19c1e
MD
661 return -EINVAL;
662
663 if (td->byte_order != BYTE_ORDER) {
664 header.magic = GUINT32_SWAP_LE_BE(header.magic);
665 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
666 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
667 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
668 }
669 if (header.checksum)
3394d22e 670 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
b4c19c1e 671 if (header.compression_scheme) {
3394d22e 672 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
b4c19c1e
MD
673 header.compression_scheme);
674 return -EINVAL;
675 }
676 if (header.encryption_scheme) {
3394d22e 677 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
b4c19c1e
MD
678 header.encryption_scheme);
679 return -EINVAL;
680 }
681 if (header.checksum_scheme) {
3394d22e 682 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
b4c19c1e
MD
683 header.checksum_scheme);
684 return -EINVAL;
685 }
5c262147
MD
686 if (check_version(header.major, header.minor) < 0)
687 return -EINVAL;
b4c19c1e
MD
688 if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
689 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
690 CTF_TRACE_SET_FIELD(td, uuid);
691 } else {
43e34335 692 if (babeltrace_uuid_compare(header.uuid, td->uuid))
b4c19c1e
MD
693 return -EINVAL;
694 }
695
255b2138 696 toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
a0fe7d97
MD
697
698 for (;;) {
f8254867 699 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
b4c19c1e
MD
700 if (ferror(in)) {
701 ret = -EINVAL;
702 break;
703 }
4152822b 704 if (babeltrace_debug) {
f8254867 705 buf[readlen] = '\0';
3394d22e 706 fprintf(stderr, "[debug] metadata packet read: %s\n",
4152822b
MD
707 buf);
708 }
709
b4c19c1e
MD
710 writelen = fwrite(buf, sizeof(char), readlen, out);
711 if (writelen < readlen) {
712 ret = -EIO;
713 break;
714 }
715 if (ferror(out)) {
716 ret = -EINVAL;
717 break;
718 }
a0fe7d97
MD
719 toread -= readlen;
720 if (!toread) {
7f4b5c4d 721 ret = 0; /* continue reading next packet */
ddbc52af 722 goto read_padding;
a0fe7d97 723 }
b4c19c1e
MD
724 }
725 return ret;
ddbc52af
MD
726
727read_padding:
728 toread = (header.packet_size - header.content_size) / CHAR_BIT;
729 ret = fseek(in, toread, SEEK_CUR);
730 if (ret < 0) {
3394d22e 731 fprintf(stderr, "[warning] Missing padding at end of file\n");
ddbc52af
MD
732 ret = 0;
733 }
734 return ret;
b4c19c1e
MD
735}
736
737static
738int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
739 char **buf)
740{
741 FILE *in, *out;
742 size_t size;
743 int ret;
744
745 in = *fp;
c4f5487e
MD
746 /*
747 * Using strlen on *buf instead of size of open_memstream
748 * because its size includes garbage at the end (after final
749 * \0). This is the allocated size, not the actual string size.
750 */
f8370579 751 out = babeltrace_open_memstream(buf, &size);
a569a564
MD
752 if (out == NULL) {
753 perror("Metadata open_memstream");
b4c19c1e 754 return -errno;
a569a564 755 }
b4c19c1e
MD
756 for (;;) {
757 ret = ctf_open_trace_metadata_packet_read(td, in, out);
7f4b5c4d 758 if (ret) {
b4c19c1e 759 break;
7f4b5c4d
MD
760 }
761 if (feof(in)) {
762 ret = 0;
b4c19c1e
MD
763 break;
764 }
765 }
f8370579
MD
766 /* close to flush the buffer */
767 ret = babeltrace_close_memstream(buf, &size, out);
768 if (ret < 0) {
769 perror("babeltrace_flush_memstream");
770 fclose(in);
771 return -errno;
772 }
b4c19c1e
MD
773 fclose(in);
774 /* open for reading */
f8370579 775 *fp = babeltrace_fmemopen(*buf, strlen(*buf), "rb");
a569a564
MD
776 if (!*fp) {
777 perror("Metadata fmemopen");
778 return -errno;
779 }
b4c19c1e
MD
780 return 0;
781}
782
65102a8c 783static
b086c01a 784int ctf_open_trace_metadata_read(struct ctf_trace *td,
20d0dcf9 785 void (*packet_seek)(struct stream_pos *pos, size_t index,
ae23d232 786 int whence), FILE *metadata_fp)
65102a8c
MD
787{
788 struct ctf_scanner *scanner;
2d0bea29 789 struct ctf_file_stream *metadata_stream;
65102a8c 790 FILE *fp;
b4c19c1e 791 char *buf = NULL;
65102a8c
MD
792 int ret = 0;
793
2d0bea29 794 metadata_stream = g_new0(struct ctf_file_stream, 1);
b086c01a 795
06789ffd
MD
796 if (packet_seek) {
797 metadata_stream->pos.packet_seek = packet_seek;
b086c01a 798 } else {
06789ffd 799 fprintf(stderr, "[error] packet_seek function undefined.\n");
b086c01a
JD
800 ret = -1;
801 goto end_stream;
802 }
803
ae23d232
JD
804 if (metadata_fp) {
805 fp = metadata_fp;
806 } else {
807 td->metadata = &metadata_stream->parent;
808 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
809 if (metadata_stream->pos.fd < 0) {
3394d22e 810 fprintf(stderr, "Unable to open metadata.\n");
ae23d232
JD
811 return metadata_stream->pos.fd;
812 }
65102a8c 813
ae23d232
JD
814 fp = fdopen(metadata_stream->pos.fd, "r");
815 if (!fp) {
3394d22e 816 fprintf(stderr, "[error] Unable to open metadata stream.\n");
a569a564 817 perror("Metadata stream open");
ae23d232
JD
818 ret = -errno;
819 goto end_stream;
820 }
821 }
65102a8c
MD
822 if (babeltrace_debug)
823 yydebug = 1;
824
b4c19c1e
MD
825 if (packet_metadata(td, fp)) {
826 ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf);
827 if (ret)
828 goto end_packet_read;
da75b0f7 829 } else {
5c262147
MD
830 unsigned int major, minor;
831 ssize_t nr_items;
8c2df3f5 832
da75b0f7 833 td->byte_order = BYTE_ORDER;
8c2df3f5 834
5c262147
MD
835 /* Check text-only metadata header and version */
836 nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor);
837 if (nr_items < 2)
3394d22e 838 fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
5c262147
MD
839 if (check_version(major, minor) < 0) {
840 ret = -EINVAL;
841 goto end_packet_read;
842 }
8c2df3f5 843 rewind(fp);
b4c19c1e
MD
844 }
845
65102a8c
MD
846 scanner = ctf_scanner_alloc(fp);
847 if (!scanner) {
3394d22e 848 fprintf(stderr, "[error] Error allocating scanner\n");
65102a8c
MD
849 ret = -ENOMEM;
850 goto end_scanner_alloc;
851 }
852 ret = ctf_scanner_append_ast(scanner);
853 if (ret) {
3394d22e 854 fprintf(stderr, "[error] Error creating AST\n");
65102a8c
MD
855 goto end;
856 }
857
858 if (babeltrace_debug) {
3394d22e 859 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
65102a8c 860 if (ret) {
3394d22e 861 fprintf(stderr, "[error] Error visiting AST for XML output\n");
65102a8c
MD
862 goto end;
863 }
864 }
865
3394d22e 866 ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
65102a8c 867 if (ret) {
3394d22e 868 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
65102a8c
MD
869 goto end;
870 }
3394d22e 871 ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
ac5c6ca0 872 td, td->byte_order);
65102a8c 873 if (ret) {
3394d22e 874 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
65102a8c
MD
875 goto end;
876 }
877end:
878 ctf_scanner_free(scanner);
879end_scanner_alloc:
b4c19c1e 880end_packet_read:
65102a8c 881 fclose(fp);
b4c19c1e 882 free(buf);
65102a8c 883end_stream:
2d0bea29
MD
884 close(metadata_stream->pos.fd);
885 if (ret)
886 g_free(metadata_stream);
0f980a35
MD
887 return ret;
888}
889
e28d4618 890static
42dc00b7
MD
891struct ctf_stream_event *create_event_definitions(struct ctf_trace *td,
892 struct ctf_stream *stream,
893 struct ctf_event *event)
e28d4618 894{
42dc00b7 895 struct ctf_stream_event *stream_event = g_new0(struct ctf_stream_event, 1);
e28d4618
MD
896
897 if (event->context_decl) {
898 struct definition *definition =
899 event->context_decl->p.definition_new(&event->context_decl->p,
900 stream->parent_def_scope, 0, 0, "event.context");
901 if (!definition) {
902 goto error;
903 }
42dc00b7 904 stream_event->event_context = container_of(definition,
e28d4618 905 struct definition_struct, p);
42dc00b7 906 stream->parent_def_scope = stream_event->event_context->p.scope;
e28d4618
MD
907 }
908 if (event->fields_decl) {
909 struct definition *definition =
910 event->fields_decl->p.definition_new(&event->fields_decl->p,
911 stream->parent_def_scope, 0, 0, "event.fields");
912 if (!definition) {
913 goto error;
914 }
42dc00b7 915 stream_event->event_fields = container_of(definition,
e28d4618 916 struct definition_struct, p);
42dc00b7 917 stream->parent_def_scope = stream_event->event_fields->p.scope;
e28d4618 918 }
42dc00b7 919 return stream_event;
e28d4618
MD
920
921error:
42dc00b7
MD
922 if (stream_event->event_fields)
923 definition_unref(&stream_event->event_fields->p);
924 if (stream_event->event_context)
925 definition_unref(&stream_event->event_context->p);
e28d4618
MD
926 return NULL;
927}
928
929static
930int create_stream_definitions(struct ctf_trace *td, struct ctf_stream *stream)
931{
932 struct ctf_stream_class *stream_class;
933 int ret;
934 int i;
935
936 if (stream->stream_definitions_created)
937 return 0;
938
939 stream_class = stream->stream_class;
940
941 if (stream_class->packet_context_decl) {
942 struct definition *definition =
943 stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
944 stream->parent_def_scope, 0, 0, "stream.packet.context");
945 if (!definition) {
946 ret = -EINVAL;
947 goto error;
948 }
949 stream->stream_packet_context = container_of(definition,
950 struct definition_struct, p);
951 stream->parent_def_scope = stream->stream_packet_context->p.scope;
952 }
953 if (stream_class->event_header_decl) {
954 struct definition *definition =
955 stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
956 stream->parent_def_scope, 0, 0, "stream.event.header");
957 if (!definition) {
958 ret = -EINVAL;
959 goto error;
960 }
961 stream->stream_event_header =
962 container_of(definition, struct definition_struct, p);
963 stream->parent_def_scope = stream->stream_event_header->p.scope;
964 }
965 if (stream_class->event_context_decl) {
966 struct definition *definition =
967 stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
968 stream->parent_def_scope, 0, 0, "stream.event.context");
969 if (!definition) {
970 ret = -EINVAL;
971 goto error;
972 }
973 stream->stream_event_context =
974 container_of(definition, struct definition_struct, p);
975 stream->parent_def_scope = stream->stream_event_context->p.scope;
976 }
977 stream->events_by_id = g_ptr_array_new();
978 g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len);
979 for (i = 0; i < stream->events_by_id->len; i++) {
980 struct ctf_event *event = g_ptr_array_index(stream_class->events_by_id, i);
42dc00b7 981 struct ctf_stream_event *stream_event;
e28d4618
MD
982
983 if (!event)
984 continue;
42dc00b7
MD
985 stream_event = create_event_definitions(td, stream, event);
986 if (!stream_event)
e28d4618 987 goto error_event;
42dc00b7 988 g_ptr_array_index(stream->events_by_id, i) = stream_event;
e28d4618
MD
989 }
990 return 0;
991
992error_event:
993 for (i = 0; i < stream->events_by_id->len; i++) {
42dc00b7
MD
994 struct ctf_stream_event *stream_event = g_ptr_array_index(stream->events_by_id, i);
995 if (stream_event)
996 g_free(stream_event);
e28d4618
MD
997 }
998 g_ptr_array_free(stream->events_by_id, TRUE);
999error:
1000 if (stream->stream_event_context)
1001 definition_unref(&stream->stream_event_context->p);
1002 if (stream->stream_event_header)
1003 definition_unref(&stream->stream_event_header->p);
1004 if (stream->stream_packet_context)
1005 definition_unref(&stream->stream_packet_context->p);
1006 return ret;
1007}
1008
0f980a35
MD
1009
1010static
46322b33 1011int create_stream_packet_index(struct ctf_trace *td,
0f980a35
MD
1012 struct ctf_file_stream *file_stream)
1013{
aa6bffae 1014 struct ctf_stream_class *stream;
0f980a35 1015 int len_index;
46322b33 1016 struct ctf_stream_pos *pos;
0f980a35
MD
1017 struct stat filestats;
1018 struct packet_index packet_index;
1019 int first_packet = 1;
1020 int ret;
1021
1022 pos = &file_stream->pos;
1023
1024 ret = fstat(pos->fd, &filestats);
1025 if (ret < 0)
1026 return ret;
1027
8895362d
MD
1028 if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT)
1029 return -EINVAL;
1030
0f980a35
MD
1031 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1032 uint64_t stream_id = 0;
1033
1034 if (pos->base) {
1035 /* unmap old base */
8c572eba 1036 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
0f980a35 1037 if (ret) {
3394d22e 1038 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
0f980a35
MD
1039 strerror(errno));
1040 return ret;
1041 }
8c572eba 1042 pos->base = NULL;
0f980a35
MD
1043 }
1044 /* map new base. Need mapping length from header. */
8c572eba 1045 pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
0f980a35 1046 MAP_PRIVATE, pos->fd, pos->mmap_offset);
dc48ecad
MD
1047 pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
1048 pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
0f980a35
MD
1049 pos->offset = 0; /* Position of the packet header */
1050
8c572eba
MD
1051 packet_index.offset = pos->mmap_offset;
1052 packet_index.content_size = 0;
1053 packet_index.packet_size = 0;
75cc2c35
MD
1054 packet_index.timestamp_begin = 0;
1055 packet_index.timestamp_end = 0;
41e82e00 1056 packet_index.events_discarded = 0;
8c572eba 1057
0f980a35 1058 /* read and check header, set stream id (and check) */
2d0bea29 1059 if (file_stream->parent.trace_packet_header) {
0f980a35 1060 /* Read packet header */
2d0bea29 1061 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
c5e74408
MD
1062 if (ret)
1063 return ret;
2d0bea29 1064 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
0f980a35 1065 if (len_index >= 0) {
b1a2f580 1066 struct definition *field;
f4c56ac2 1067 uint64_t magic;
0f980a35 1068
2d0bea29 1069 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
f4c56ac2
MD
1070 magic = get_unsigned_int(field);
1071 if (magic != CTF_MAGIC) {
3394d22e 1072 fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
f4c56ac2 1073 magic,
8c572eba
MD
1074 file_stream->pos.packet_index->len,
1075 (ssize_t) pos->mmap_offset);
0f980a35
MD
1076 return -EINVAL;
1077 }
1078 }
1079
1080 /* check uuid */
2d0bea29 1081 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
0f980a35
MD
1082 if (len_index >= 0) {
1083 struct definition_array *defarray;
b1a2f580 1084 struct definition *field;
0f980a35 1085 uint64_t i;
43e34335 1086 uint8_t uuidval[BABELTRACE_UUID_LEN];
0f980a35 1087
2d0bea29 1088 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
b1a2f580
MD
1089 assert(field->declaration->id == CTF_TYPE_ARRAY);
1090 defarray = container_of(field, struct definition_array, p);
43e34335 1091 assert(array_len(defarray) == BABELTRACE_UUID_LEN);
0f980a35 1092
43e34335 1093 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
0f980a35 1094 struct definition *elem;
0f980a35
MD
1095
1096 elem = array_index(defarray, i);
f4c56ac2 1097 uuidval[i] = get_unsigned_int(elem);
0f980a35 1098 }
43e34335 1099 ret = babeltrace_uuid_compare(td->uuid, uuidval);
0f980a35 1100 if (ret) {
3394d22e 1101 fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
0f980a35
MD
1102 return -EINVAL;
1103 }
1104 }
1105
1106
2d0bea29 1107 len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
0f980a35 1108 if (len_index >= 0) {
b1a2f580 1109 struct definition *field;
0f980a35 1110
2d0bea29 1111 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
f4c56ac2 1112 stream_id = get_unsigned_int(field);
0f980a35
MD
1113 }
1114 }
1115
2d0bea29 1116 if (!first_packet && file_stream->parent.stream_id != stream_id) {
3394d22e 1117 fprintf(stderr, "[error] Stream ID is changing within a stream.\n");
0f980a35
MD
1118 return -EINVAL;
1119 }
1120 if (first_packet) {
2d0bea29 1121 file_stream->parent.stream_id = stream_id;
46322b33 1122 if (stream_id >= td->streams->len) {
3394d22e 1123 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
0f980a35
MD
1124 return -EINVAL;
1125 }
46322b33 1126 stream = g_ptr_array_index(td->streams, stream_id);
0f980a35 1127 if (!stream) {
3394d22e 1128 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
0f980a35
MD
1129 return -EINVAL;
1130 }
2d0bea29 1131 file_stream->parent.stream_class = stream;
01c76b24 1132 ret = create_stream_definitions(td, &file_stream->parent);
862434ec
MD
1133 if (ret)
1134 return ret;
0f980a35
MD
1135 }
1136 first_packet = 0;
1137
2d0bea29 1138 if (file_stream->parent.stream_packet_context) {
dc48ecad 1139 /* Read packet context */
2d0bea29 1140 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
c5e74408
MD
1141 if (ret)
1142 return ret;
dc48ecad 1143 /* read content size from header */
2d0bea29 1144 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
dc48ecad 1145 if (len_index >= 0) {
b1a2f580 1146 struct definition *field;
dc48ecad 1147
2d0bea29 1148 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
f4c56ac2 1149 packet_index.content_size = get_unsigned_int(field);
dc48ecad
MD
1150 } else {
1151 /* Use file size for packet size */
8c572eba 1152 packet_index.content_size = filestats.st_size * CHAR_BIT;
dc48ecad
MD
1153 }
1154
1155 /* read packet size from header */
2d0bea29 1156 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
dc48ecad 1157 if (len_index >= 0) {
b1a2f580 1158 struct definition *field;
dc48ecad 1159
2d0bea29 1160 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
f4c56ac2 1161 packet_index.packet_size = get_unsigned_int(field);
dc48ecad
MD
1162 } else {
1163 /* Use content size if non-zero, else file size */
8c572eba 1164 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
dc48ecad 1165 }
75cc2c35
MD
1166
1167 /* read timestamp begin from header */
2d0bea29 1168 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
75cc2c35 1169 if (len_index >= 0) {
75cc2c35
MD
1170 struct definition *field;
1171
2d0bea29 1172 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
f4c56ac2 1173 packet_index.timestamp_begin = get_unsigned_int(field);
75cc2c35
MD
1174 }
1175
1176 /* read timestamp end from header */
2d0bea29 1177 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
75cc2c35 1178 if (len_index >= 0) {
75cc2c35
MD
1179 struct definition *field;
1180
2d0bea29 1181 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
f4c56ac2 1182 packet_index.timestamp_end = get_unsigned_int(field);
75cc2c35 1183 }
41e82e00
MD
1184
1185 /* read events discarded from header */
1186 len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1187 if (len_index >= 0) {
1188 struct definition *field;
1189
1190 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1191 packet_index.events_discarded = get_unsigned_int(field);
1192 }
0f980a35
MD
1193 } else {
1194 /* Use file size for packet size */
8c572eba 1195 packet_index.content_size = filestats.st_size * CHAR_BIT;
0f980a35 1196 /* Use content size if non-zero, else file size */
8c572eba 1197 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
0f980a35 1198 }
546293fa
MD
1199
1200 /* Validate content size and packet size values */
1201 if (packet_index.content_size > packet_index.packet_size) {
7e18eedf 1202 fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
546293fa
MD
1203 packet_index.content_size, packet_index.packet_size);
1204 return -EINVAL;
1205 }
1206
7e18eedf
JN
1207 if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) {
1208 fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1209 packet_index.content_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT);
546293fa
MD
1210 return -EINVAL;
1211 }
1212
847bf71a
MD
1213 /* Save position after header and context */
1214 packet_index.data_offset = pos->offset;
0f980a35 1215
0f980a35
MD
1216 /* add index to packet array */
1217 g_array_append_val(file_stream->pos.packet_index, packet_index);
1218
8c572eba 1219 pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
0f980a35
MD
1220 }
1221
847bf71a 1222 /* Move pos back to beginning of file */
06789ffd 1223 ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */
847bf71a 1224
0f980a35
MD
1225 return 0;
1226}
1227
e28d4618
MD
1228static
1229int create_trace_definitions(struct ctf_trace *td, struct ctf_stream *stream)
1230{
1231 int ret;
1232
1233 if (td->packet_header_decl) {
1234 struct definition *definition =
1235 td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1236 stream->parent_def_scope, 0, 0, "trace.packet.header");
1237 if (!definition) {
1238 ret = -EINVAL;
1239 goto error;
1240 }
1241 stream->trace_packet_header =
1242 container_of(definition, struct definition_struct, p);
1243 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1244 }
1245
1246 return 0;
1247
1248error:
1249 return ret;
1250}
1251
0f980a35
MD
1252/*
1253 * Note: many file streams can inherit from the same stream class
1254 * description (metadata).
1255 */
1256static
b086c01a 1257int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
20d0dcf9 1258 void (*packet_seek)(struct stream_pos *pos, size_t index,
b086c01a 1259 int whence))
0f980a35
MD
1260{
1261 int ret;
1262 struct ctf_file_stream *file_stream;
1263
46322b33 1264 ret = openat(td->dirfd, path, flags);
a569a564
MD
1265 if (ret < 0) {
1266 perror("File stream openat()");
0f980a35 1267 goto error;
a569a564 1268 }
0f980a35 1269 file_stream = g_new0(struct ctf_file_stream, 1);
b086c01a 1270
06789ffd
MD
1271 if (packet_seek) {
1272 file_stream->pos.packet_seek = packet_seek;
b086c01a 1273 } else {
06789ffd 1274 fprintf(stderr, "[error] packet_seek function undefined.\n");
b086c01a
JD
1275 ret = -1;
1276 goto error_def;
1277 }
1278
8563e754 1279 ctf_init_pos(&file_stream->pos, ret, flags);
2d0bea29 1280 ret = create_trace_definitions(td, &file_stream->parent);
e28d4618
MD
1281 if (ret)
1282 goto error_def;
25ccc85b
MD
1283 /*
1284 * For now, only a single slock is supported.
1285 */
1286 file_stream->parent.current_clock = td->single_clock;
0f980a35
MD
1287 ret = create_stream_packet_index(td, file_stream);
1288 if (ret)
1289 goto error_index;
1290 /* Add stream file to stream class */
2d0bea29
MD
1291 g_ptr_array_add(file_stream->parent.stream_class->streams,
1292 &file_stream->parent);
0f980a35
MD
1293 return 0;
1294
1295error_index:
2d0bea29
MD
1296 if (file_stream->parent.trace_packet_header)
1297 definition_unref(&file_stream->parent.trace_packet_header->p);
e28d4618 1298error_def:
46322b33 1299 ctf_fini_pos(&file_stream->pos);
0f980a35
MD
1300 close(file_stream->pos.fd);
1301 g_free(file_stream);
1302error:
65102a8c
MD
1303 return ret;
1304}
1305
bbefb8dd 1306static
5b80ddfb 1307int ctf_open_trace_read(struct ctf_trace *td,
8c250d87 1308 const char *path, int flags,
20d0dcf9 1309 void (*packet_seek)(struct stream_pos *pos, size_t index,
ae23d232 1310 int whence), FILE *metadata_fp)
bbefb8dd
MD
1311{
1312 int ret;
65102a8c
MD
1313 struct dirent *dirent;
1314 struct dirent *diriter;
1315 size_t dirent_len;
bbefb8dd 1316
46322b33 1317 td->flags = flags;
bbefb8dd
MD
1318
1319 /* Open trace directory */
46322b33
MD
1320 td->dir = opendir(path);
1321 if (!td->dir) {
3394d22e 1322 fprintf(stderr, "[error] Unable to open trace directory.\n");
bbefb8dd
MD
1323 ret = -ENOENT;
1324 goto error;
1325 }
1326
46322b33
MD
1327 td->dirfd = open(path, 0);
1328 if (td->dirfd < 0) {
3394d22e 1329 fprintf(stderr, "[error] Unable to open trace directory file descriptor.\n");
a569a564
MD
1330 perror("Trace directory open");
1331 ret = -errno;
65102a8c
MD
1332 goto error_dirfd;
1333 }
5b80ddfb
MD
1334 strncpy(td->path, path, sizeof(td->path));
1335 td->path[sizeof(td->path) - 1] = '\0';
0f980a35 1336
65102a8c
MD
1337 /*
1338 * Keep the metadata file separate.
1339 */
bbefb8dd 1340
06789ffd 1341 ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp);
65102a8c
MD
1342 if (ret) {
1343 goto error_metadata;
1344 }
bbefb8dd
MD
1345
1346 /*
1347 * Open each stream: for each file, try to open, check magic
1348 * number, and get the stream ID to add to the right location in
1349 * the stream array.
bbefb8dd
MD
1350 */
1351
65102a8c 1352 dirent_len = offsetof(struct dirent, d_name) +
46322b33 1353 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
bbefb8dd 1354
65102a8c 1355 dirent = malloc(dirent_len);
bbefb8dd 1356
65102a8c 1357 for (;;) {
46322b33 1358 ret = readdir_r(td->dir, dirent, &diriter);
65102a8c 1359 if (ret) {
3394d22e 1360 fprintf(stderr, "[error] Readdir error.\n");
65102a8c 1361 goto readdir_error;
65102a8c
MD
1362 }
1363 if (!diriter)
1364 break;
d8ea2d29
MD
1365 /* Ignore hidden files, ., .. and metadata. */
1366 if (!strncmp(diriter->d_name, ".", 1)
65102a8c
MD
1367 || !strcmp(diriter->d_name, "..")
1368 || !strcmp(diriter->d_name, "metadata"))
1369 continue;
06789ffd
MD
1370 ret = ctf_open_file_stream_read(td, diriter->d_name,
1371 flags, packet_seek);
dc48ecad 1372 if (ret) {
3394d22e 1373 fprintf(stderr, "[error] Open file stream error.\n");
dc48ecad
MD
1374 goto readdir_error;
1375 }
65102a8c 1376 }
bbefb8dd 1377
65102a8c 1378 free(dirent);
bbefb8dd 1379 return 0;
65102a8c
MD
1380
1381readdir_error:
1382 free(dirent);
1383error_metadata:
46322b33 1384 close(td->dirfd);
65102a8c 1385error_dirfd:
46322b33 1386 closedir(td->dir);
bbefb8dd
MD
1387error:
1388 return ret;
1389}
1390
e9378815 1391static
5b80ddfb 1392struct trace_descriptor *ctf_open_trace(const char *path, int flags,
20d0dcf9 1393 void (*packet_seek)(struct stream_pos *pos, size_t index,
ae23d232 1394 int whence), FILE *metadata_fp)
bbefb8dd 1395{
46322b33 1396 struct ctf_trace *td;
bbefb8dd
MD
1397 int ret;
1398
2715de36
MD
1399 /*
1400 * If packet_seek is NULL, we provide our default version.
1401 */
1402 if (!packet_seek)
1403 packet_seek = ctf_packet_seek;
1404
46322b33 1405 td = g_new0(struct ctf_trace, 1);
bbefb8dd 1406
8c572eba 1407 switch (flags & O_ACCMODE) {
bbefb8dd 1408 case O_RDONLY:
b61922b5 1409 if (!path) {
3394d22e 1410 fprintf(stderr, "[error] Path missing for input CTF trace.\n");
b61922b5
MD
1411 goto error;
1412 }
06789ffd 1413 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
bbefb8dd
MD
1414 if (ret)
1415 goto error;
1416 break;
989c73bc 1417 case O_RDWR:
3394d22e 1418 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
46322b33 1419 goto error;
bbefb8dd 1420 default:
3394d22e 1421 fprintf(stderr, "[error] Incorrect open flags.\n");
bbefb8dd
MD
1422 goto error;
1423 }
1424
46322b33 1425 return &td->parent;
bbefb8dd
MD
1426error:
1427 g_free(td);
1428 return NULL;
1429}
1430
f571dfb1
JD
1431
1432void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
1433 struct mmap_stream *mmap_info)
1434{
1435 pos->mmap_offset = 0;
1436 pos->packet_size = 0;
1437 pos->content_size = 0;
1438 pos->content_size_loc = NULL;
1439 pos->fd = mmap_info->fd;
1440 pos->base = 0;
1441 pos->offset = 0;
1442 pos->dummy = false;
1443 pos->cur_index = 0;
1444 pos->packet_index = NULL;
1445 pos->prot = PROT_READ;
1446 pos->flags = MAP_PRIVATE;
1447 pos->parent.rw_table = read_dispatch_table;
1448 pos->parent.event_cb = ctf_read_event;
1449}
1450
1451static
1452int prepare_mmap_stream_definition(struct ctf_trace *td,
1453 struct ctf_file_stream *file_stream)
1454{
1455 struct ctf_stream_class *stream;
1456 uint64_t stream_id = 0;
1457 int ret;
1458
1459 file_stream->parent.stream_id = stream_id;
1460 if (stream_id >= td->streams->len) {
3394d22e 1461 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
f571dfb1
JD
1462 "in metadata.\n", stream_id);
1463 ret = -EINVAL;
1464 goto end;
1465 }
1466 stream = g_ptr_array_index(td->streams, stream_id);
1467 if (!stream) {
3394d22e 1468 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
f571dfb1
JD
1469 "in metadata.\n", stream_id);
1470 ret = -EINVAL;
1471 goto end;
1472 }
1473 file_stream->parent.stream_class = stream;
1474 ret = create_stream_definitions(td, &file_stream->parent);
1475end:
1476 return ret;
1477}
1478
1479static
1480int ctf_open_mmap_stream_read(struct ctf_trace *td,
1481 struct mmap_stream *mmap_info,
20d0dcf9 1482 void (*packet_seek)(struct stream_pos *pos, size_t index,
f571dfb1
JD
1483 int whence))
1484{
1485 int ret;
1486 struct ctf_file_stream *file_stream;
1487
1488 file_stream = g_new0(struct ctf_file_stream, 1);
1489 ctf_init_mmap_pos(&file_stream->pos, mmap_info);
1490
06789ffd 1491 file_stream->pos.packet_seek = packet_seek;
f571dfb1
JD
1492
1493 ret = create_trace_definitions(td, &file_stream->parent);
1494 if (ret) {
1495 goto error_def;
1496 }
1497
1498 ret = prepare_mmap_stream_definition(td, file_stream);
1499 if (ret)
1500 goto error_index;
1501
1502 /* Add stream file to stream class */
1503 g_ptr_array_add(file_stream->parent.stream_class->streams,
1504 &file_stream->parent);
1505 return 0;
1506
1507error_index:
1508 if (file_stream->parent.trace_packet_header)
1509 definition_unref(&file_stream->parent.trace_packet_header->p);
1510error_def:
1511 g_free(file_stream);
1512 return ret;
1513}
1514
1515int ctf_open_mmap_trace_read(struct ctf_trace *td,
1516 struct mmap_stream_list *mmap_list,
20d0dcf9 1517 void (*packet_seek)(struct stream_pos *pos, size_t index,
f571dfb1
JD
1518 int whence),
1519 FILE *metadata_fp)
1520{
1521 int ret;
1522 struct mmap_stream *mmap_info;
1523
06789ffd 1524 ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp);
f571dfb1
JD
1525 if (ret) {
1526 goto error;
1527 }
1528
1529 /*
1530 * for each stream, try to open, check magic number, and get the
1531 * stream ID to add to the right location in the stream array.
1532 */
3122e6f0 1533 bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
06789ffd 1534 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
f571dfb1 1535 if (ret) {
3394d22e 1536 fprintf(stderr, "[error] Open file mmap stream error.\n");
f571dfb1
JD
1537 goto error;
1538 }
1539 }
1540
1541 return 0;
1542
1543error:
1544 return ret;
1545}
1546
1547static
1548struct trace_descriptor *ctf_open_mmap_trace(
1549 struct mmap_stream_list *mmap_list,
20d0dcf9
MD
1550 void (*packet_seek)(struct stream_pos *pos, size_t index,
1551 int whence),
f571dfb1
JD
1552 FILE *metadata_fp)
1553{
1554 struct ctf_trace *td;
1555 int ret;
1556
1557 if (!metadata_fp) {
1558 fprintf(stderr, "[error] No metadata file pointer associated, "
1559 "required for mmap parsing\n");
1560 goto error;
1561 }
06789ffd
MD
1562 if (!packet_seek) {
1563 fprintf(stderr, "[error] packet_seek function undefined.\n");
f571dfb1
JD
1564 goto error;
1565 }
1566 td = g_new0(struct ctf_trace, 1);
06789ffd 1567 ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
f571dfb1
JD
1568 if (ret)
1569 goto error_free;
1570
1571 return &td->parent;
1572
1573error_free:
1574 g_free(td);
1575error:
1576 return NULL;
1577}
1578
0f980a35
MD
1579static
1580void ctf_close_file_stream(struct ctf_file_stream *file_stream)
1581{
46322b33 1582 ctf_fini_pos(&file_stream->pos);
0f980a35
MD
1583 close(file_stream->pos.fd);
1584}
1585
e9378815 1586static
46322b33 1587void ctf_close_trace(struct trace_descriptor *tdp)
bbefb8dd 1588{
46322b33 1589 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
0f980a35
MD
1590 int i;
1591
46322b33
MD
1592 if (td->streams) {
1593 for (i = 0; i < td->streams->len; i++) {
aa6bffae 1594 struct ctf_stream_class *stream;
0f980a35 1595 int j;
e9378815 1596
46322b33 1597 stream = g_ptr_array_index(td->streams, i);
e9378815
MD
1598 if (!stream)
1599 continue;
2d0bea29 1600 for (j = 0; j < stream->streams->len; j++) {
0f980a35 1601 struct ctf_file_stream *file_stream;
2d0bea29 1602 file_stream = container_of(g_ptr_array_index(stream->streams, j), struct ctf_file_stream, parent);
0f980a35
MD
1603 ctf_close_file_stream(file_stream);
1604 }
1605
1606 }
46322b33 1607 g_ptr_array_free(td->streams, TRUE);
0f980a35 1608 }
46322b33 1609 closedir(td->dir);
bbefb8dd
MD
1610 g_free(td);
1611}
1612
7fb21036 1613void __attribute__((constructor)) ctf_init(void)
fc93b2bd
MD
1614{
1615 int ret;
1616
4c8bfb7e 1617 ctf_format.name = g_quark_from_static_string("ctf");
fc93b2bd
MD
1618 ret = bt_register_format(&ctf_format);
1619 assert(!ret);
1620}
698f0fe4
MD
1621
1622/* TODO: finalize */
This page took 0.191887 seconds and 4 git commands to generate.