X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=formats%2Fctf%2Fctf.c;h=7767c3478ca0e2b005f732e4b858f602d58310f4;hp=6e45ea3612f603664cbee66fb5d0d90e512f215a;hb=f4c56ac2f6ef228de5f1dcdf7047f69c61a22a36;hpb=5aebb2eea13e39362abaad9ceb63f08c7e2c4ea3 diff --git a/formats/ctf/ctf.c b/formats/ctf/ctf.c index 6e45ea36..7767c347 100644 --- a/formats/ctf/ctf.c +++ b/formats/ctf/ctf.c @@ -3,7 +3,9 @@ * * Format registration. * - * Copyright 2010, 2011 - Mathieu Desnoyers + * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation + * + * Author: Mathieu Desnoyers * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -19,7 +21,7 @@ #include #include #include -#include +#include #include #include #include @@ -53,7 +55,9 @@ extern int yydebug; static -struct trace_descriptor *ctf_open_trace(const char *path, int flags); +struct trace_descriptor *ctf_open_trace(const char *path, int flags, + void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, + int whence), FILE *metadata_fp); static void ctf_close_trace(struct trace_descriptor *descriptor); @@ -95,7 +99,7 @@ void ctf_update_timestamp(struct ctf_stream *stream, integer_definition->declaration; uint64_t oldval, newval, updateval; - if (integer_declaration->len == 64) { + if (unlikely(integer_declaration->len == 64)) { stream->timestamp = integer_definition->value._unsigned; return; } @@ -123,16 +127,27 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) uint64_t id = 0; int ret; - if (pos->offset == EOF) + /* We need to check for EOF here for empty files. */ + if (unlikely(pos->offset == EOF)) + return EOF; + + ctf_pos_get_event(pos); + + /* + * This is the EOF check after we've advanced the position in + * ctf_pos_get_event. + */ + if (unlikely(pos->offset == EOF)) return EOF; + assert(pos->offset < pos->content_size); /* Read event header */ - if (stream->stream_event_header) { + if (likely(stream->stream_event_header)) { struct definition_integer *integer_definition; struct definition *variant; ret = generic_rw(ppos, &stream->stream_event_header->p); - if (ret) + if (unlikely(ret)) goto error; /* lookup event id */ integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE); @@ -154,16 +169,20 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) id = integer_definition->value._unsigned; } } + stream->event_id = id; /* lookup timestamp */ + stream->has_timestamp = 0; integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE); if (integer_definition) { ctf_update_timestamp(stream, integer_definition); + stream->has_timestamp = 1; } else { if (variant) { integer_definition = lookup_integer(variant, "timestamp", FALSE); if (integer_definition) { ctf_update_timestamp(stream, integer_definition); + stream->has_timestamp = 1; } } } @@ -176,12 +195,12 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) goto error; } - if (id >= stream_class->events_by_id->len) { + if (unlikely(id >= stream_class->events_by_id->len)) { fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); return -EINVAL; } event = g_ptr_array_index(stream->events_by_id, id); - if (!event) { + if (unlikely(!event)) { fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); return -EINVAL; } @@ -194,7 +213,7 @@ int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) } /* Read event payload */ - if (event->event_fields) { + if (likely(event->event_fields)) { ret = generic_rw(ppos, &event->event_fields->p); if (ret) goto error; @@ -212,35 +231,13 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream) { struct ctf_stream_class *stream_class = stream->stream_class; struct ctf_stream_event *event; - uint64_t id = 0; + uint64_t id; int ret; - /* print event header */ - if (stream->stream_event_header) { - struct definition_integer *integer_definition; - struct definition *variant; - - /* lookup event id */ - integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE); - if (integer_definition) { - id = integer_definition->value._unsigned; - } else { - struct definition_enum *enum_definition; - - enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE); - if (enum_definition) { - id = enum_definition->integer->value._unsigned; - } - } - - variant = lookup_variant(&stream->stream_event_header->p, "v"); - if (variant) { - integer_definition = lookup_integer(variant, "id", FALSE); - if (integer_definition) { - id = integer_definition->value._unsigned; - } - } + id = stream->event_id; + /* print event header */ + if (likely(stream->stream_event_header)) { ret = generic_rw(pos, &stream->stream_event_header->p); if (ret) goto error; @@ -253,12 +250,12 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream) goto error; } - if (id >= stream_class->events_by_id->len) { + if (unlikely(id >= stream_class->events_by_id->len)) { fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); return -EINVAL; } event = g_ptr_array_index(stream->events_by_id, id); - if (!event) { + if (unlikely(!event)) { fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); return -EINVAL; } @@ -271,7 +268,7 @@ int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream) } /* Read and print event payload */ - if (event->event_fields) { + if (likely(event->event_fields)) { ret = generic_rw(pos, &event->event_fields->p); if (ret) goto error; @@ -385,8 +382,11 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence) assert(off >= 0); pos->offset = 0; } else { + read_next_packet: switch (whence) { case SEEK_CUR: + if (pos->offset == EOF) + return; /* The reader will expect us to skip padding */ assert(pos->offset + offset == pos->content_size); ++pos->cur_index; @@ -410,9 +410,15 @@ void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence) file_stream->parent.timestamp = index->timestamp_begin; pos->content_size = index->content_size; pos->packet_size = index->packet_size; - if (index->data_offset < index->content_size) + if (index->data_offset < index->content_size) { pos->offset = 0; /* will read headers */ - else { + } else if (index->data_offset == index->content_size) { + /* empty packet */ + pos->offset = index->data_offset; + offset = 0; + whence = SEEK_CUR; + goto read_next_packet; + } else { pos->offset = EOF; return; } @@ -453,24 +459,51 @@ int packet_metadata(struct ctf_trace *td, FILE *fp) if (magic == TSDL_MAGIC) { ret = 1; td->byte_order = BYTE_ORDER; + CTF_TRACE_SET_FIELD(td, byte_order); } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { ret = 1; td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ? LITTLE_ENDIAN : BIG_ENDIAN; + CTF_TRACE_SET_FIELD(td, byte_order); } - CTF_TRACE_SET_FIELD(td, byte_order); end: rewind(fp); return ret; } +/* + * Returns 0 on success, -1 on error. + */ +static +int check_version(unsigned int major, unsigned int minor) +{ + switch (major) { + case 1: + switch (minor) { + case 8: + return 0; + default: + goto warning; + } + default: + goto warning; + + } + + /* eventually return an error instead of warning */ +warning: + fprintf(stdout, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n", + major, minor); + return 0; +} + static int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, FILE *out) { struct metadata_packet_header header; size_t readlen, writelen, toread; - char buf[4096]; + char buf[4096 + 1]; /* + 1 for debug-mode \0 */ int ret = 0; readlen = fread(&header, header_sizeof(header), 1, in); @@ -500,6 +533,8 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, header.checksum_scheme); return -EINVAL; } + if (check_version(header.major, header.minor) < 0) + return -EINVAL; if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) { memcpy(td->uuid, header.uuid, sizeof(header.uuid)); CTF_TRACE_SET_FIELD(td, uuid); @@ -511,12 +546,13 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, toread = (header.content_size / CHAR_BIT) - header_sizeof(header); for (;;) { - readlen = fread(buf, sizeof(char), min(sizeof(buf), toread), in); + readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in); if (ferror(in)) { ret = -EINVAL; break; } if (babeltrace_debug) { + buf[readlen] = '\0'; fprintf(stdout, "[debug] metadata packet read: %s\n", buf); } @@ -533,10 +569,19 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, toread -= readlen; if (!toread) { ret = 0; /* continue reading next packet */ - break; + goto read_padding; } } return ret; + +read_padding: + toread = (header.packet_size - header.content_size) / CHAR_BIT; + ret = fseek(in, toread, SEEK_CUR); + if (ret < 0) { + fprintf(stdout, "[warning] Missing padding at end of file\n"); + ret = 0; + } + return ret; } static @@ -575,7 +620,9 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, } static -int ctf_open_trace_metadata_read(struct ctf_trace *td) +int ctf_open_trace_metadata_read(struct ctf_trace *td, + void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, + int whence), FILE *metadata_fp) { struct ctf_scanner *scanner; struct ctf_file_stream *metadata_stream; @@ -584,27 +631,54 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td) int ret = 0; metadata_stream = g_new0(struct ctf_file_stream, 1); - td->metadata = &metadata_stream->parent; - metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY); - if (metadata_stream->pos.fd < 0) { - fprintf(stdout, "Unable to open metadata.\n"); - return metadata_stream->pos.fd; + + if (move_pos_slow) { + metadata_stream->pos.move_pos_slow = move_pos_slow; + } else { + fprintf(stderr, "[error] move_pos_slow function undefined.\n"); + ret = -1; + goto end_stream; } - if (babeltrace_debug) - yydebug = 1; + if (metadata_fp) { + fp = metadata_fp; + } else { + td->metadata = &metadata_stream->parent; + metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY); + if (metadata_stream->pos.fd < 0) { + fprintf(stdout, "Unable to open metadata.\n"); + return metadata_stream->pos.fd; + } - fp = fdopen(metadata_stream->pos.fd, "r"); - if (!fp) { - fprintf(stdout, "[error] Unable to open metadata stream.\n"); - ret = -errno; - goto end_stream; + fp = fdopen(metadata_stream->pos.fd, "r"); + if (!fp) { + fprintf(stdout, "[error] Unable to open metadata stream.\n"); + ret = -errno; + goto end_stream; + } } + if (babeltrace_debug) + yydebug = 1; if (packet_metadata(td, fp)) { ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf); if (ret) goto end_packet_read; + } else { + unsigned int major, minor; + ssize_t nr_items; + + td->byte_order = BYTE_ORDER; + + /* Check text-only metadata header and version */ + nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor); + if (nr_items < 2) + fprintf(stdout, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n"); + if (check_version(major, minor) < 0) { + ret = -EINVAL; + goto end_packet_read; + } + rewind(fp); } scanner = ctf_scanner_alloc(fp); @@ -633,7 +707,7 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td) goto end; } ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root, - td, BYTE_ORDER); + td, td->byte_order); if (ret) { fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret); goto end; @@ -826,16 +900,14 @@ int create_stream_packet_index(struct ctf_trace *td, return ret; len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; + uint64_t magic; field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - if (defint->value._unsigned != CTF_MAGIC) { + magic = get_unsigned_int(field); + if (magic != CTF_MAGIC) { fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", - defint->value._unsigned, + magic, file_stream->pos.packet_index->len, (ssize_t) pos->mmap_offset); return -EINVAL; @@ -854,16 +926,12 @@ int create_stream_packet_index(struct ctf_trace *td, assert(field->declaration->id == CTF_TYPE_ARRAY); defarray = container_of(field, 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; + uuidval[i] = get_unsigned_int(elem); } ret = uuid_compare(td->uuid, uuidval); if (ret) { @@ -875,14 +943,10 @@ int create_stream_packet_index(struct ctf_trace *td, len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - stream_id = defint->value._unsigned; + stream_id = get_unsigned_int(field); } } @@ -902,13 +966,12 @@ int create_stream_packet_index(struct ctf_trace *td, return -EINVAL; } file_stream->parent.stream_class = stream; + ret = create_stream_definitions(td, &file_stream->parent); + if (ret) + return ret; } first_packet = 0; - ret = create_stream_definitions(td, &file_stream->parent); - if (ret) - return ret; - if (file_stream->parent.stream_packet_context) { /* Read packet context */ ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); @@ -917,14 +980,10 @@ int create_stream_packet_index(struct ctf_trace *td, /* read content size from header */ len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - packet_index.content_size = defint->value._unsigned; + packet_index.content_size = get_unsigned_int(field); } else { /* Use file size for packet size */ packet_index.content_size = filestats.st_size * CHAR_BIT; @@ -933,14 +992,10 @@ int create_stream_packet_index(struct ctf_trace *td, /* read packet size from header */ len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - packet_index.packet_size = defint->value._unsigned; + packet_index.packet_size = get_unsigned_int(field); } else { /* Use content size if non-zero, else file size */ packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; @@ -949,27 +1004,19 @@ int create_stream_packet_index(struct ctf_trace *td, /* read timestamp begin from header */ len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - packet_index.timestamp_begin = defint->value._unsigned; + packet_index.timestamp_begin = get_unsigned_int(field); } /* read timestamp end from header */ len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); if (len_index >= 0) { - struct definition_integer *defint; struct definition *field; field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - assert(field->declaration->id == CTF_TYPE_INTEGER); - defint = container_of(field, struct definition_integer, p); - assert(defint->declaration->signedness == FALSE); - packet_index.timestamp_end = defint->value._unsigned; + packet_index.timestamp_end = get_unsigned_int(field); } } else { /* Use file size for packet size */ @@ -1035,7 +1082,9 @@ error: * description (metadata). */ static -int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags) +int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, + void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, + int whence)) { int ret; struct ctf_file_stream *file_stream; @@ -1044,6 +1093,15 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags) if (ret < 0) goto error; file_stream = g_new0(struct ctf_file_stream, 1); + + if (move_pos_slow) { + file_stream->pos.move_pos_slow = move_pos_slow; + } else { + fprintf(stderr, "[error] move_pos_slow function undefined.\n"); + ret = -1; + goto error_def; + } + ctf_init_pos(&file_stream->pos, ret, flags); ret = create_trace_definitions(td, &file_stream->parent); if (ret) @@ -1068,7 +1126,9 @@ error: } static -int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) +int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags, + void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, + int whence), FILE *metadata_fp) { int ret; struct dirent *dirent; @@ -1096,7 +1156,7 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) * Keep the metadata file separate. */ - ret = ctf_open_trace_metadata_read(td); + ret = ctf_open_trace_metadata_read(td, move_pos_slow, metadata_fp); if (ret) { goto error_metadata; } @@ -1125,7 +1185,7 @@ int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) || !strcmp(diriter->d_name, "..") || !strcmp(diriter->d_name, "metadata")) continue; - ret = ctf_open_file_stream_read(td, diriter->d_name, flags); + ret = ctf_open_file_stream_read(td, diriter->d_name, flags, move_pos_slow); if (ret) { fprintf(stdout, "[error] Open file stream error.\n"); goto readdir_error; @@ -1146,7 +1206,9 @@ error: } static -struct trace_descriptor *ctf_open_trace(const char *path, int flags) +struct trace_descriptor *ctf_open_trace(const char *path, int flags, + void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, + int whence), FILE *metadata_fp) { struct ctf_trace *td; int ret; @@ -1159,7 +1221,7 @@ struct trace_descriptor *ctf_open_trace(const char *path, int flags) fprintf(stdout, "[error] Path missing for input CTF trace.\n"); goto error; } - ret = ctf_open_trace_read(td, path, flags); + ret = ctf_open_trace_read(td, path, flags, move_pos_slow, metadata_fp); if (ret) goto error; break;