X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=formats%2Fctf%2Fctf.c;h=a63eb60b496c1ca85c9b2621ec7a3985d9c4635d;hp=9a0e003a2fa3e5081ca331cad3c533c7223706af;hb=1ae19169d9cb823765444d22cdb05cd2ed3f162f;hpb=a52d7f6a6dfe8c55b65eef0996b848873db39fe7 diff --git a/formats/ctf/ctf.c b/formats/ctf/ctf.c index 9a0e003a..a63eb60b 100644 --- a/formats/ctf/ctf.c +++ b/formats/ctf/ctf.c @@ -3,53 +3,646 @@ * * Format registration. * - * Copyright (c) 2010 Mathieu Desnoyers + * Copyright 2010, 2011 - Mathieu Desnoyers * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. */ #include #include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "metadata/ctf-scanner.h" +#include "metadata/ctf-parser.h" +#include "metadata/ctf-ast.h" + +/* + * We currently simply map a page to read the packet header and packet + * context to get the packet length and content length. (in bits) + */ +#define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT) +#define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) +#define UUID_LEN 16 /* uuid by value len */ + +extern int yydebug; -void __attribute__((constructor)) ctf_init(void); - -static const struct format ctf_format = { - .uint_read = ctf_uint_read, - .int_read = ctf_int_read, - .uint_write = ctf_uint_write, - .int_write = ctf_int_write, - .bitfield_unsigned_read = ctf_bitfield_unsigned_read, - .bitfield_signed_read = ctf_bitfield_signed_read, - .bitfield_unsigned_write = ctf_bitfield_unsigned_write, - .bitfield_signed_write = ctf_bitfield_signed_write, - .double_read = ctf_double_read, - .double_write = ctf_double_write, - .float_copy = ctf_float_copy, - .string_copy = ctf_string_copy, - .string_read = ctf_string_read, - .string_write = ctf_string_write, - .string_free_temp = ctf_string_free_temp, - .enum_read = ctf_enum_read, - .enum_write = ctf_enum_write, +struct trace_descriptor *ctf_open_trace(const char *path, int flags); +void ctf_close_trace(struct trace_descriptor *descriptor); + +static +rw_dispatch read_dispatch_table[] = { + [ CTF_TYPE_INTEGER ] = ctf_integer_read, + [ CTF_TYPE_FLOAT ] = ctf_float_read, + [ CTF_TYPE_ENUM ] = ctf_enum_read, + [ CTF_TYPE_STRING ] = ctf_string_read, + [ CTF_TYPE_STRUCT ] = ctf_struct_rw, + [ CTF_TYPE_VARIANT ] = ctf_variant_rw, + [ CTF_TYPE_ARRAY ] = ctf_array_rw, + [ CTF_TYPE_SEQUENCE ] = ctf_sequence_rw, }; -void ctf_init(void) +static +rw_dispatch write_dispatch_table[] = { + [ CTF_TYPE_INTEGER ] = ctf_integer_write, + [ CTF_TYPE_FLOAT ] = ctf_float_write, + [ CTF_TYPE_ENUM ] = ctf_enum_write, + [ CTF_TYPE_STRING ] = ctf_string_write, + [ CTF_TYPE_STRUCT ] = ctf_struct_rw, + [ CTF_TYPE_VARIANT ] = ctf_variant_rw, + [ CTF_TYPE_ARRAY ] = ctf_array_rw, + [ CTF_TYPE_SEQUENCE ] = ctf_sequence_rw, +}; + +static +struct format ctf_format = { + .open_trace = ctf_open_trace, + .close_trace = ctf_close_trace, +}; + +void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) +{ + pos->fd = fd; + pos->mmap_offset = 0; + pos->packet_size = 0; + pos->content_size = 0; + pos->content_size_loc = NULL; + pos->base = NULL; + pos->offset = 0; + pos->dummy = false; + pos->cur_index = 0; + if (fd >= 0) + pos->packet_index = g_array_new(FALSE, TRUE, + sizeof(struct packet_index)); + else + pos->packet_index = NULL; + switch (open_flags & O_ACCMODE) { + case O_RDONLY: + pos->prot = PROT_READ; + pos->flags = MAP_PRIVATE; + pos->parent.rw_table = read_dispatch_table; + break; + case O_WRONLY: + case O_RDWR: + pos->prot = PROT_WRITE; /* Write has priority */ + pos->flags = MAP_SHARED; + pos->parent.rw_table = write_dispatch_table; + if (fd >= 0) + ctf_move_pos_slow(pos, 0); /* position for write */ + break; + default: + assert(0); + } +} + +void ctf_fini_pos(struct ctf_stream_pos *pos) +{ + int ret; + + if (pos->prot == PROT_WRITE && pos->content_size_loc) + *pos->content_size_loc = pos->offset; + if (pos->base) { + /* unmap old base */ + ret = munmap(pos->base, pos->packet_size / CHAR_BIT); + if (ret) { + fprintf(stdout, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + assert(0); + } + } + (void) g_array_free(pos->packet_index, TRUE); +} + +void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset) +{ + int ret; + off_t off; + struct packet_index *index; + + + if (pos->prot == PROT_WRITE && pos->content_size_loc) + *pos->content_size_loc = pos->offset; + + if (pos->base) { + /* unmap old base */ + ret = munmap(pos->base, pos->packet_size / CHAR_BIT); + if (ret) { + fprintf(stdout, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + assert(0); + } + } + + /* + * The caller should never ask for ctf_move_pos across packets, + * except to get exactly at the beginning of the next packet. + */ + if (pos->prot == PROT_WRITE) { + /* The writer will add padding */ + assert(pos->offset + offset == pos->packet_size); + + /* + * Don't increment for initial stream move (only condition where + * pos->offset can be 0. + */ + if (pos->offset) + pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT; + pos->content_size = -1U; /* Unknown at this point */ + pos->packet_size = WRITE_PACKET_LEN; + off = posix_fallocate(pos->fd, pos->mmap_offset, pos->packet_size / CHAR_BIT); + assert(off >= 0); + } else { + /* The reader will expect us to skip padding */ + assert(pos->offset + offset == pos->content_size); + + /* + * Don't increment for initial stream move (only condition where + * pos->offset can be 0). + */ + if (pos->offset) + ++pos->cur_index; + index = &g_array_index(pos->packet_index, struct packet_index, + pos->cur_index); + pos->mmap_offset = index->offset; + + /* Lookup context/packet size in index */ + pos->content_size = index->content_size; + pos->packet_size = index->packet_size; + } + /* map new base. Need mapping length from header. */ + pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot, + pos->flags, pos->fd, pos->mmap_offset); + pos->offset = 0; +} + +/* + * TODO: for now, we treat the metadata file as a simple text file + * (without any header nor packets nor padding). + */ +static +int ctf_open_trace_metadata_read(struct ctf_trace *td) +{ + struct ctf_scanner *scanner; + FILE *fp; + int ret = 0; + + td->metadata.pos.fd = openat(td->dirfd, "metadata", O_RDONLY); + if (td->metadata.pos.fd < 0) { + fprintf(stdout, "Unable to open metadata.\n"); + return td->metadata.pos.fd; + } + + if (babeltrace_debug) + yydebug = 1; + + fp = fdopen(td->metadata.pos.fd, "r"); + if (!fp) { + fprintf(stdout, "[error] Unable to open metadata stream.\n"); + ret = -errno; + goto end_stream; + } + + scanner = ctf_scanner_alloc(fp); + if (!scanner) { + fprintf(stdout, "[error] Error allocating scanner\n"); + ret = -ENOMEM; + goto end_scanner_alloc; + } + ret = ctf_scanner_append_ast(scanner); + if (ret) { + fprintf(stdout, "[error] Error creating AST\n"); + goto end; + } + + if (babeltrace_debug) { + ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root); + if (ret) { + fprintf(stdout, "[error] Error visiting AST for XML output\n"); + goto end; + } + } + + ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root); + if (ret) { + fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret); + goto end; + } + ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root, + td, BYTE_ORDER); + if (ret) { + fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret); + goto end; + } +end: + ctf_scanner_free(scanner); +end_scanner_alloc: + fclose(fp); +end_stream: + close(td->metadata.pos.fd); + return ret; +} + + +static +int create_stream_packet_index(struct ctf_trace *td, + struct ctf_file_stream *file_stream) +{ + struct ctf_stream *stream; + int len_index; + struct ctf_stream_pos *pos; + struct stat filestats; + struct packet_index packet_index; + int first_packet = 1; + int ret; + + pos = &file_stream->pos; + + ret = fstat(pos->fd, &filestats); + if (ret < 0) + return ret; + + for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { + uint64_t stream_id = 0; + + if (pos->base) { + /* unmap old base */ + ret = munmap(pos->base, pos->packet_size / CHAR_BIT); + if (ret) { + fprintf(stdout, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + return ret; + } + pos->base = NULL; + } + /* map new base. Need mapping length from header. */ + pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ, + MAP_PRIVATE, pos->fd, pos->mmap_offset); + pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ + pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ + pos->offset = 0; /* Position of the packet header */ + + packet_index.offset = pos->mmap_offset; + packet_index.content_size = 0; + packet_index.packet_size = 0; + + /* read and check header, set stream id (and check) */ + if (td->packet_header) { + /* Read packet header */ + generic_rw(&pos->parent, &td->packet_header->p); + + len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("magic")); + if (len_index >= 0) { + struct definition_integer *defint; + struct field *field; + + field = struct_definition_get_field_from_index(td->packet_header, len_index); + assert(field->definition->declaration->id == CTF_TYPE_INTEGER); + defint = container_of(field->definition, struct definition_integer, p); + assert(defint->declaration->signedness == FALSE); + if (defint->value._unsigned != CTF_MAGIC) { + fprintf(stdout, "[error] Invalid magic number %" PRIX64 " at packet %u (file offset %zd).\n", + defint->value._unsigned, + file_stream->pos.packet_index->len, + (ssize_t) pos->mmap_offset); + return -EINVAL; + } + } + + /* check uuid */ + len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("trace_uuid")); + if (len_index >= 0) { + struct definition_array *defarray; + struct field *field; + uint64_t i; + uint8_t uuidval[UUID_LEN]; + + field = struct_definition_get_field_from_index(td->packet_header, len_index); + assert(field->definition->declaration->id == CTF_TYPE_ARRAY); + defarray = container_of(field->definition, struct definition_array, p); + assert(array_len(defarray) == UUID_LEN); + assert(defarray->declaration->elem->id == CTF_TYPE_INTEGER); + + for (i = 0; i < UUID_LEN; i++) { + struct definition *elem; + struct definition_integer *defint; + + elem = array_index(defarray, i); + assert(elem); + defint = container_of(elem, struct definition_integer, p); + uuidval[i] = defint->value._unsigned; + } + ret = uuid_compare(td->uuid, uuidval); + if (ret) { + fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n"); + return -EINVAL; + } + } + + + len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("stream_id")); + if (len_index >= 0) { + struct definition_integer *defint; + struct field *field; + + field = struct_definition_get_field_from_index(td->packet_header, len_index); + assert(field->definition->declaration->id == CTF_TYPE_INTEGER); + defint = container_of(field->definition, struct definition_integer, p); + assert(defint->declaration->signedness == FALSE); + stream_id = defint->value._unsigned; + } + } + + if (!first_packet && file_stream->stream_id != stream_id) { + fprintf(stdout, "[error] Stream ID is changing within a stream.\n"); + return -EINVAL; + } + if (first_packet) { + file_stream->stream_id = stream_id; + if (stream_id >= td->streams->len) { + fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); + return -EINVAL; + } + stream = g_ptr_array_index(td->streams, stream_id); + if (!stream) { + fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); + return -EINVAL; + } + file_stream->stream = stream; + } + first_packet = 0; + + if (stream->packet_context) { + /* Read packet context */ + generic_rw(&pos->parent, &stream->packet_context->p); + + /* read content size from header */ + len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("content_size")); + if (len_index >= 0) { + struct definition_integer *defint; + struct field *field; + + field = struct_definition_get_field_from_index(stream->packet_context, len_index); + assert(field->definition->declaration->id == CTF_TYPE_INTEGER); + defint = container_of(field->definition, struct definition_integer, p); + assert(defint->declaration->signedness == FALSE); + packet_index.content_size = defint->value._unsigned; + } else { + /* Use file size for packet size */ + packet_index.content_size = filestats.st_size * CHAR_BIT; + } + + /* read packet size from header */ + len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("packet_size")); + if (len_index >= 0) { + struct definition_integer *defint; + struct field *field; + + field = struct_definition_get_field_from_index(stream->packet_context, len_index); + assert(field->definition->declaration->id == CTF_TYPE_INTEGER); + defint = container_of(field->definition, struct definition_integer, p); + assert(defint->declaration->signedness == FALSE); + packet_index.packet_size = defint->value._unsigned; + } else { + /* Use content size if non-zero, else file size */ + packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; + } + } else { + /* Use file size for packet size */ + packet_index.content_size = filestats.st_size * CHAR_BIT; + /* Use content size if non-zero, else file size */ + packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; + } + + /* add index to packet array */ + g_array_append_val(file_stream->pos.packet_index, packet_index); + + pos->mmap_offset += packet_index.packet_size / CHAR_BIT; + } + + return 0; +} + +/* + * Note: many file streams can inherit from the same stream class + * description (metadata). + */ +static +int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags) +{ + int ret; + struct ctf_file_stream *file_stream; + + ret = openat(td->dirfd, path, flags); + if (ret < 0) + goto error; + file_stream = g_new0(struct ctf_file_stream, 1); + ctf_init_pos(&file_stream->pos, ret, flags); + ret = create_stream_packet_index(td, file_stream); + if (ret) + goto error_index; + /* Add stream file to stream class */ + g_ptr_array_add(file_stream->stream->files, file_stream); + return 0; + +error_index: + ctf_fini_pos(&file_stream->pos); + close(file_stream->pos.fd); + g_free(file_stream); +error: + return ret; +} + +static +int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) +{ + int ret; + struct dirent *dirent; + struct dirent *diriter; + size_t dirent_len; + + td->flags = flags; + + /* Open trace directory */ + td->dir = opendir(path); + if (!td->dir) { + fprintf(stdout, "[error] Unable to open trace directory.\n"); + ret = -ENOENT; + goto error; + } + + td->dirfd = open(path, 0); + if (td->dirfd < 0) { + fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n"); + ret = -ENOENT; + goto error_dirfd; + } + + td->streams = g_ptr_array_new(); + + /* + * Keep the metadata file separate. + */ + + ret = ctf_open_trace_metadata_read(td); + if (ret) { + goto error_metadata; + } + + /* + * Open each stream: for each file, try to open, check magic + * number, and get the stream ID to add to the right location in + * the stream array. + */ + + dirent_len = offsetof(struct dirent, d_name) + + fpathconf(td->dirfd, _PC_NAME_MAX) + 1; + + dirent = malloc(dirent_len); + + for (;;) { + ret = readdir_r(td->dir, dirent, &diriter); + if (ret) { + fprintf(stdout, "[error] Readdir error.\n"); + goto readdir_error; + } + if (!diriter) + break; + if (!strcmp(diriter->d_name, ".") + || !strcmp(diriter->d_name, "..") + || !strcmp(diriter->d_name, "metadata")) + continue; + ret = ctf_open_file_stream_read(td, diriter->d_name, flags); + if (ret) { + fprintf(stdout, "[error] Open file stream error.\n"); + goto readdir_error; + } + } + + free(dirent); + return 0; + +readdir_error: + free(dirent); +error_metadata: + g_ptr_array_free(td->streams, TRUE); + close(td->dirfd); +error_dirfd: + closedir(td->dir); +error: + return ret; +} + +static +int ctf_open_trace_write(struct ctf_trace *td, const char *path, int flags) +{ + int ret; + + ret = mkdir(path, S_IRWXU|S_IRWXG); + if (ret) + return ret; + + /* Open trace directory */ + td->dir = opendir(path); + if (!td->dir) { + fprintf(stdout, "[error] Unable to open trace directory.\n"); + ret = -ENOENT; + goto error; + } + + + return 0; + +error: + return ret; +} + +struct trace_descriptor *ctf_open_trace(const char *path, int flags) +{ + struct ctf_trace *td; + int ret; + + td = g_new0(struct ctf_trace, 1); + + switch (flags & O_ACCMODE) { + case O_RDONLY: + ret = ctf_open_trace_read(td, path, flags); + if (ret) + goto error; + break; + case O_WRONLY: + fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n"); + goto error; +#if 0 + ret = ctf_open_trace_write(td, path, flags); + if (ret) + goto error; +#endif //0 + break; + default: + fprintf(stdout, "[error] Incorrect open flags.\n"); + goto error; + } + + return &td->parent; +error: + g_free(td); + return NULL; +} + +static +void ctf_close_file_stream(struct ctf_file_stream *file_stream) +{ + ctf_fini_pos(&file_stream->pos); + close(file_stream->pos.fd); +} + +void ctf_close_trace(struct trace_descriptor *tdp) +{ + struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); + int i; + + if (td->streams) { + for (i = 0; i < td->streams->len; i++) { + struct ctf_stream *stream; + int j; + stream = g_ptr_array_index(td->streams, i); + for (j = 0; j < stream->files->len; j++) { + struct ctf_file_stream *file_stream; + file_stream = g_ptr_array_index(stream->files, j); + ctf_close_file_stream(file_stream); + } + + } + g_ptr_array_free(td->streams, TRUE); + } + closedir(td->dir); + g_free(td); +} + +void __attribute__((constructor)) ctf_init(void) { int ret; - ctf_format->name = g_quark_from_static_string("ctf"); + ctf_format.name = g_quark_from_static_string("ctf"); ret = bt_register_format(&ctf_format); assert(!ret); }