Change -EOF for EOF (it is worth -1), fix assertion
[babeltrace.git] / formats / ctf / ctf.c
1 /*
2 * BabelTrace - Common Trace Format (CTF)
3 *
4 * Format registration.
5 *
6 * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 */
18
19 #include <babeltrace/format.h>
20 #include <babeltrace/ctf/types.h>
21 #include <babeltrace/ctf/metadata.h>
22 #include <babeltrace/babeltrace.h>
23 #include <inttypes.h>
24 #include <uuid/uuid.h>
25 #include <sys/mman.h>
26 #include <errno.h>
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <fcntl.h>
30 #include <dirent.h>
31 #include <glib.h>
32 #include <unistd.h>
33 #include <stdlib.h>
34
35 #include "metadata/ctf-scanner.h"
36 #include "metadata/ctf-parser.h"
37 #include "metadata/ctf-ast.h"
38
39 /*
40 * We currently simply map a page to read the packet header and packet
41 * context to get the packet length and content length. (in bits)
42 */
43 #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT)
44 #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT)
45 #define UUID_LEN 16 /* uuid by value len */
46
47 extern int yydebug;
48
49 struct trace_descriptor *ctf_open_trace(const char *path, int flags);
50 void ctf_close_trace(struct trace_descriptor *descriptor);
51
52 static
53 rw_dispatch read_dispatch_table[] = {
54 [ CTF_TYPE_INTEGER ] = ctf_integer_read,
55 [ CTF_TYPE_FLOAT ] = ctf_float_read,
56 [ CTF_TYPE_ENUM ] = ctf_enum_read,
57 [ CTF_TYPE_STRING ] = ctf_string_read,
58 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
59 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
60 [ CTF_TYPE_ARRAY ] = ctf_array_rw,
61 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_rw,
62 };
63
64 static
65 rw_dispatch write_dispatch_table[] = {
66 [ CTF_TYPE_INTEGER ] = ctf_integer_write,
67 [ CTF_TYPE_FLOAT ] = ctf_float_write,
68 [ CTF_TYPE_ENUM ] = ctf_enum_write,
69 [ CTF_TYPE_STRING ] = ctf_string_write,
70 [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
71 [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
72 [ CTF_TYPE_ARRAY ] = ctf_array_rw,
73 [ CTF_TYPE_SEQUENCE ] = ctf_sequence_rw,
74 };
75
76 static
77 struct format ctf_format = {
78 .open_trace = ctf_open_trace,
79 .close_trace = ctf_close_trace,
80 };
81
82 void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
83 {
84 pos->fd = fd;
85 pos->mmap_offset = 0;
86 pos->packet_size = 0;
87 pos->content_size = 0;
88 pos->content_size_loc = NULL;
89 pos->base = NULL;
90 pos->offset = 0;
91 pos->dummy = false;
92 pos->cur_index = 0;
93 if (fd >= 0)
94 pos->packet_index = g_array_new(FALSE, TRUE,
95 sizeof(struct packet_index));
96 else
97 pos->packet_index = NULL;
98 switch (open_flags & O_ACCMODE) {
99 case O_RDONLY:
100 pos->prot = PROT_READ;
101 pos->flags = MAP_PRIVATE;
102 pos->parent.rw_table = read_dispatch_table;
103 break;
104 case O_WRONLY:
105 case O_RDWR:
106 pos->prot = PROT_WRITE; /* Write has priority */
107 pos->flags = MAP_SHARED;
108 pos->parent.rw_table = write_dispatch_table;
109 if (fd >= 0)
110 ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */
111 break;
112 default:
113 assert(0);
114 }
115 }
116
117 void ctf_fini_pos(struct ctf_stream_pos *pos)
118 {
119 int ret;
120
121 if (pos->prot == PROT_WRITE && pos->content_size_loc)
122 *pos->content_size_loc = pos->offset;
123 if (pos->base) {
124 /* unmap old base */
125 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
126 if (ret) {
127 fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
128 strerror(errno));
129 assert(0);
130 }
131 }
132 (void) g_array_free(pos->packet_index, TRUE);
133 }
134
135 void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
136 {
137 int ret;
138 off_t off;
139 struct packet_index *index;
140
141 /* Only allow random seek in read mode */
142 assert(pos->prot != PROT_WRITE || whence == SEEK_CUR);
143
144 if (pos->prot == PROT_WRITE && pos->content_size_loc)
145 *pos->content_size_loc = pos->offset;
146
147 if (pos->base) {
148 /* unmap old base */
149 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
150 if (ret) {
151 fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
152 strerror(errno));
153 assert(0);
154 }
155 pos->base = NULL;
156 }
157
158 /*
159 * The caller should never ask for ctf_move_pos across packets,
160 * except to get exactly at the beginning of the next packet.
161 */
162 if (pos->prot == PROT_WRITE) {
163 /* The writer will add padding */
164 assert(pos->offset + offset == pos->packet_size);
165
166 /*
167 * Don't increment for initial stream move (only condition where
168 * pos->offset can be 0.
169 */
170 if (pos->offset)
171 pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
172 pos->content_size = -1U; /* Unknown at this point */
173 pos->packet_size = WRITE_PACKET_LEN;
174 off = posix_fallocate(pos->fd, pos->mmap_offset, pos->packet_size / CHAR_BIT);
175 assert(off >= 0);
176 pos->offset = 0;
177 } else {
178 switch (whence) {
179 case SEEK_CUR:
180 /* The reader will expect us to skip padding */
181 assert(pos->offset + offset == pos->content_size);
182 ++pos->cur_index;
183 break;
184 case SEEK_SET:
185 assert(offset == 0); /* only seek supported for now */
186 pos->cur_index = 0;
187 break;
188 default:
189 assert(0);
190 }
191 if (pos->cur_index >= pos->packet_index->len) {
192 pos->offset = EOF;
193 return;
194 }
195 index = &g_array_index(pos->packet_index, struct packet_index,
196 pos->cur_index);
197 pos->mmap_offset = index->offset;
198
199 /* Lookup context/packet size in index */
200 pos->content_size = index->content_size;
201 pos->packet_size = index->packet_size;
202 pos->offset = index->data_offset;
203 }
204 /* map new base. Need mapping length from header. */
205 pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot,
206 pos->flags, pos->fd, pos->mmap_offset);
207 if (pos->base == MAP_FAILED) {
208 fprintf(stdout, "[error] mmap error %s.\n",
209 strerror(errno));
210 assert(0);
211 }
212 }
213
214 /*
215 * TODO: for now, we treat the metadata file as a simple text file
216 * (without any header nor packets nor padding).
217 */
218 static
219 int ctf_open_trace_metadata_read(struct ctf_trace *td)
220 {
221 struct ctf_scanner *scanner;
222 FILE *fp;
223 int ret = 0;
224
225 td->metadata.pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
226 if (td->metadata.pos.fd < 0) {
227 fprintf(stdout, "Unable to open metadata.\n");
228 return td->metadata.pos.fd;
229 }
230
231 if (babeltrace_debug)
232 yydebug = 1;
233
234 fp = fdopen(td->metadata.pos.fd, "r");
235 if (!fp) {
236 fprintf(stdout, "[error] Unable to open metadata stream.\n");
237 ret = -errno;
238 goto end_stream;
239 }
240
241 scanner = ctf_scanner_alloc(fp);
242 if (!scanner) {
243 fprintf(stdout, "[error] Error allocating scanner\n");
244 ret = -ENOMEM;
245 goto end_scanner_alloc;
246 }
247 ret = ctf_scanner_append_ast(scanner);
248 if (ret) {
249 fprintf(stdout, "[error] Error creating AST\n");
250 goto end;
251 }
252
253 if (babeltrace_debug) {
254 ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root);
255 if (ret) {
256 fprintf(stdout, "[error] Error visiting AST for XML output\n");
257 goto end;
258 }
259 }
260
261 ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root);
262 if (ret) {
263 fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret);
264 goto end;
265 }
266 ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root,
267 td, BYTE_ORDER);
268 if (ret) {
269 fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret);
270 goto end;
271 }
272 end:
273 ctf_scanner_free(scanner);
274 end_scanner_alloc:
275 fclose(fp);
276 end_stream:
277 close(td->metadata.pos.fd);
278 return ret;
279 }
280
281
282 static
283 int create_stream_packet_index(struct ctf_trace *td,
284 struct ctf_file_stream *file_stream)
285 {
286 struct ctf_stream *stream;
287 int len_index;
288 struct ctf_stream_pos *pos;
289 struct stat filestats;
290 struct packet_index packet_index;
291 int first_packet = 1;
292 int ret;
293
294 pos = &file_stream->pos;
295
296 ret = fstat(pos->fd, &filestats);
297 if (ret < 0)
298 return ret;
299
300 for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
301 uint64_t stream_id = 0;
302
303 if (pos->base) {
304 /* unmap old base */
305 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
306 if (ret) {
307 fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
308 strerror(errno));
309 return ret;
310 }
311 pos->base = NULL;
312 }
313 /* map new base. Need mapping length from header. */
314 pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
315 MAP_PRIVATE, pos->fd, pos->mmap_offset);
316 pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
317 pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */
318 pos->offset = 0; /* Position of the packet header */
319
320 packet_index.offset = pos->mmap_offset;
321 packet_index.content_size = 0;
322 packet_index.packet_size = 0;
323
324 /* read and check header, set stream id (and check) */
325 if (td->packet_header) {
326 /* Read packet header */
327 ret = generic_rw(&pos->parent, &td->packet_header->p);
328 if (ret)
329 return ret;
330 len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("magic"));
331 if (len_index >= 0) {
332 struct definition_integer *defint;
333 struct field *field;
334
335 field = struct_definition_get_field_from_index(td->packet_header, len_index);
336 assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
337 defint = container_of(field->definition, struct definition_integer, p);
338 assert(defint->declaration->signedness == FALSE);
339 if (defint->value._unsigned != CTF_MAGIC) {
340 fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
341 defint->value._unsigned,
342 file_stream->pos.packet_index->len,
343 (ssize_t) pos->mmap_offset);
344 return -EINVAL;
345 }
346 }
347
348 /* check uuid */
349 len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("trace_uuid"));
350 if (len_index >= 0) {
351 struct definition_array *defarray;
352 struct field *field;
353 uint64_t i;
354 uint8_t uuidval[UUID_LEN];
355
356 field = struct_definition_get_field_from_index(td->packet_header, len_index);
357 assert(field->definition->declaration->id == CTF_TYPE_ARRAY);
358 defarray = container_of(field->definition, struct definition_array, p);
359 assert(array_len(defarray) == UUID_LEN);
360 assert(defarray->declaration->elem->id == CTF_TYPE_INTEGER);
361
362 for (i = 0; i < UUID_LEN; i++) {
363 struct definition *elem;
364 struct definition_integer *defint;
365
366 elem = array_index(defarray, i);
367 assert(elem);
368 defint = container_of(elem, struct definition_integer, p);
369 uuidval[i] = defint->value._unsigned;
370 }
371 ret = uuid_compare(td->uuid, uuidval);
372 if (ret) {
373 fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n");
374 return -EINVAL;
375 }
376 }
377
378
379 len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("stream_id"));
380 if (len_index >= 0) {
381 struct definition_integer *defint;
382 struct field *field;
383
384 field = struct_definition_get_field_from_index(td->packet_header, len_index);
385 assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
386 defint = container_of(field->definition, struct definition_integer, p);
387 assert(defint->declaration->signedness == FALSE);
388 stream_id = defint->value._unsigned;
389 }
390 }
391
392 if (!first_packet && file_stream->stream_id != stream_id) {
393 fprintf(stdout, "[error] Stream ID is changing within a stream.\n");
394 return -EINVAL;
395 }
396 if (first_packet) {
397 file_stream->stream_id = stream_id;
398 if (stream_id >= td->streams->len) {
399 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
400 return -EINVAL;
401 }
402 stream = g_ptr_array_index(td->streams, stream_id);
403 if (!stream) {
404 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
405 return -EINVAL;
406 }
407 file_stream->stream = stream;
408 }
409 first_packet = 0;
410
411 if (stream->packet_context) {
412 /* Read packet context */
413 ret = generic_rw(&pos->parent, &stream->packet_context->p);
414 if (ret)
415 return ret;
416 /* read content size from header */
417 len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("content_size"));
418 if (len_index >= 0) {
419 struct definition_integer *defint;
420 struct field *field;
421
422 field = struct_definition_get_field_from_index(stream->packet_context, len_index);
423 assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
424 defint = container_of(field->definition, struct definition_integer, p);
425 assert(defint->declaration->signedness == FALSE);
426 packet_index.content_size = defint->value._unsigned;
427 } else {
428 /* Use file size for packet size */
429 packet_index.content_size = filestats.st_size * CHAR_BIT;
430 }
431
432 /* read packet size from header */
433 len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("packet_size"));
434 if (len_index >= 0) {
435 struct definition_integer *defint;
436 struct field *field;
437
438 field = struct_definition_get_field_from_index(stream->packet_context, len_index);
439 assert(field->definition->declaration->id == CTF_TYPE_INTEGER);
440 defint = container_of(field->definition, struct definition_integer, p);
441 assert(defint->declaration->signedness == FALSE);
442 packet_index.packet_size = defint->value._unsigned;
443 } else {
444 /* Use content size if non-zero, else file size */
445 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
446 }
447 } else {
448 /* Use file size for packet size */
449 packet_index.content_size = filestats.st_size * CHAR_BIT;
450 /* Use content size if non-zero, else file size */
451 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
452 }
453
454 /* Validate content size and packet size values */
455 if (packet_index.content_size > packet_index.packet_size) {
456 fprintf(stdout, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
457 packet_index.content_size, packet_index.packet_size);
458 return -EINVAL;
459 }
460
461 if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) {
462 fprintf(stdout, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
463 packet_index.content_size, (filestats.st_size - packet_index.offset) * CHAR_BIT);
464 return -EINVAL;
465 }
466
467 /* Save position after header and context */
468 packet_index.data_offset = pos->offset;
469
470 /* add index to packet array */
471 g_array_append_val(file_stream->pos.packet_index, packet_index);
472
473 pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
474 }
475
476 /* Move pos back to beginning of file */
477 ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */
478
479 return 0;
480 }
481
482 /*
483 * Note: many file streams can inherit from the same stream class
484 * description (metadata).
485 */
486 static
487 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags)
488 {
489 int ret;
490 struct ctf_file_stream *file_stream;
491
492 ret = openat(td->dirfd, path, flags);
493 if (ret < 0)
494 goto error;
495 file_stream = g_new0(struct ctf_file_stream, 1);
496 ctf_init_pos(&file_stream->pos, ret, flags);
497 ret = create_stream_packet_index(td, file_stream);
498 if (ret)
499 goto error_index;
500 /* Add stream file to stream class */
501 g_ptr_array_add(file_stream->stream->files, file_stream);
502 return 0;
503
504 error_index:
505 ctf_fini_pos(&file_stream->pos);
506 close(file_stream->pos.fd);
507 g_free(file_stream);
508 error:
509 return ret;
510 }
511
512 static
513 int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags)
514 {
515 int ret;
516 struct dirent *dirent;
517 struct dirent *diriter;
518 size_t dirent_len;
519
520 td->flags = flags;
521
522 /* Open trace directory */
523 td->dir = opendir(path);
524 if (!td->dir) {
525 fprintf(stdout, "[error] Unable to open trace directory.\n");
526 ret = -ENOENT;
527 goto error;
528 }
529
530 td->dirfd = open(path, 0);
531 if (td->dirfd < 0) {
532 fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n");
533 ret = -ENOENT;
534 goto error_dirfd;
535 }
536
537 td->streams = g_ptr_array_new();
538
539 /*
540 * Keep the metadata file separate.
541 */
542
543 ret = ctf_open_trace_metadata_read(td);
544 if (ret) {
545 goto error_metadata;
546 }
547
548 /*
549 * Open each stream: for each file, try to open, check magic
550 * number, and get the stream ID to add to the right location in
551 * the stream array.
552 */
553
554 dirent_len = offsetof(struct dirent, d_name) +
555 fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
556
557 dirent = malloc(dirent_len);
558
559 for (;;) {
560 ret = readdir_r(td->dir, dirent, &diriter);
561 if (ret) {
562 fprintf(stdout, "[error] Readdir error.\n");
563 goto readdir_error;
564 }
565 if (!diriter)
566 break;
567 /* Ignore hidden files, ., .. and metadata. */
568 if (!strncmp(diriter->d_name, ".", 1)
569 || !strcmp(diriter->d_name, "..")
570 || !strcmp(diriter->d_name, "metadata"))
571 continue;
572 ret = ctf_open_file_stream_read(td, diriter->d_name, flags);
573 if (ret) {
574 fprintf(stdout, "[error] Open file stream error.\n");
575 goto readdir_error;
576 }
577 }
578
579 free(dirent);
580 return 0;
581
582 readdir_error:
583 free(dirent);
584 error_metadata:
585 g_ptr_array_free(td->streams, TRUE);
586 close(td->dirfd);
587 error_dirfd:
588 closedir(td->dir);
589 error:
590 return ret;
591 }
592
593 struct trace_descriptor *ctf_open_trace(const char *path, int flags)
594 {
595 struct ctf_trace *td;
596 int ret;
597
598 td = g_new0(struct ctf_trace, 1);
599
600 switch (flags & O_ACCMODE) {
601 case O_RDONLY:
602 if (!path) {
603 fprintf(stdout, "[error] Path missing for input CTF trace.\n");
604 goto error;
605 }
606 ret = ctf_open_trace_read(td, path, flags);
607 if (ret)
608 goto error;
609 break;
610 case O_WRONLY:
611 fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n");
612 goto error;
613 default:
614 fprintf(stdout, "[error] Incorrect open flags.\n");
615 goto error;
616 }
617
618 return &td->parent;
619 error:
620 g_free(td);
621 return NULL;
622 }
623
624 static
625 void ctf_close_file_stream(struct ctf_file_stream *file_stream)
626 {
627 ctf_fini_pos(&file_stream->pos);
628 close(file_stream->pos.fd);
629 }
630
631 void ctf_close_trace(struct trace_descriptor *tdp)
632 {
633 struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
634 int i;
635
636 if (td->streams) {
637 for (i = 0; i < td->streams->len; i++) {
638 struct ctf_stream *stream;
639 int j;
640 stream = g_ptr_array_index(td->streams, i);
641 for (j = 0; j < stream->files->len; j++) {
642 struct ctf_file_stream *file_stream;
643 file_stream = g_ptr_array_index(stream->files, j);
644 ctf_close_file_stream(file_stream);
645 }
646
647 }
648 g_ptr_array_free(td->streams, TRUE);
649 }
650 closedir(td->dir);
651 g_free(td);
652 }
653
654 void __attribute__((constructor)) ctf_init(void)
655 {
656 int ret;
657
658 ctf_format.name = g_quark_from_static_string("ctf");
659 ret = bt_register_format(&ctf_format);
660 assert(!ret);
661 }
662
663 /* TODO: finalize */
This page took 0.041935 seconds and 4 git commands to generate.