X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=formats%2Fctf%2Fctf.c;h=eec3350f3ba73b2c40c27c479943f3d80b4c093c;hb=e69dd258fa9c5f460a9071f4c6a9fcc98aaa010e;hp=8f8af52517c407f1c32e80779f2fa35e69f717e1;hpb=87148dc74de9861a656aa4f38f03b51743471049;p=babeltrace.git diff --git a/formats/ctf/ctf.c b/formats/ctf/ctf.c index 8f8af525..eec3350f 100644 --- a/formats/ctf/ctf.c +++ b/formats/ctf/ctf.c @@ -33,8 +33,9 @@ #include #include #include -#include +#include #include +#include #include #include #include @@ -51,13 +52,18 @@ #include "metadata/ctf-parser.h" #include "metadata/ctf-ast.h" #include "events-private.h" -#include "memstream.h" +#include + +#define LOG2_CHAR_BIT 3 /* - * We currently simply map a page to read the packet header and packet - * context to get the packet length and content length. (in bits) + * Length of first attempt at mapping a packet header, in bits. + */ +#define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT) + +/* + * Lenght of packet to write, in bits. */ -#define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT) #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) #ifndef min @@ -66,12 +72,15 @@ #define NSEC_PER_SEC 1000000000ULL +#define INDEX_PATH "./index/%s.idx" + int opt_clock_cycles, opt_clock_seconds, opt_clock_date, opt_clock_gmt; uint64_t opt_clock_offset; +uint64_t opt_clock_offset_ns; extern int yydebug; @@ -316,6 +325,9 @@ void ctf_print_timestamp_real(FILE *fp, ts_nsec = timestamp; + /* Add command-line offset in ns*/ + ts_nsec += opt_clock_offset_ns; + /* Add command-line offset */ ts_sec += opt_clock_offset; @@ -400,10 +412,12 @@ void print_uuid(FILE *fp, unsigned char *uuid) fprintf(fp, "%x", (unsigned int) uuid[i]); } -void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream) +void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream, + int end_stream) { - fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [", - stream->events_discarded); + fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events %sbetween [", + stream->events_discarded, + end_stream ? "at end of stream " : ""); if (opt_clock_cycles) { ctf_print_timestamp(fp, stream, stream->prev_cycles_timestamp); @@ -419,9 +433,9 @@ void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream) } fprintf(fp, "] in trace UUID "); print_uuid(fp, stream->stream_class->trace->uuid); - if (stream->stream_class->trace->path[0]) + if (stream->stream_class->trace->parent.path[0]) fprintf(fp, ", at path: \"%s\"", - stream->stream_class->trace->path); + stream->stream_class->trace->parent.path); fprintf(fp, ", within stream id %" PRIu64, stream->stream_id); if (stream->path[0]) @@ -457,6 +471,15 @@ int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *str */ if (unlikely(pos->offset == EOF)) return EOF; + + if (pos->content_size == 0) { + /* Stream is inactive for now (live reading). */ + return EAGAIN; + } + /* Packet only contains headers */ + if (pos->offset == pos->content_size) + return EAGAIN; + assert(pos->offset < pos->content_size); /* Read event header */ @@ -537,10 +560,15 @@ int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *str goto error; } + if (pos->last_offset == pos->offset) { + fprintf(stderr, "[error] Invalid 0 byte event encountered.\n"); + return -EINVAL; + } + return 0; error: - fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); + fprintf(stderr, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); return ret; } @@ -599,7 +627,109 @@ error: return ret; } -int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) +/* + * One side-effect of this function is to unmap pos mmap base if one is + * mapped. + */ +static +int find_data_offset(struct ctf_stream_pos *pos, + struct ctf_file_stream *file_stream, + struct packet_index *packet_index) +{ + uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len; + struct stat filestats; + size_t filesize; + int ret; + + pos = &file_stream->pos; + + ret = fstat(pos->fd, &filestats); + if (ret < 0) + return ret; + filesize = filestats.st_size; + + /* Deal with empty files */ + if (!filesize) { + return 0; + } + +begin: + if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) { + packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT; + } + + if (pos->base_mma) { + /* unmap old base */ + ret = munmap_align(pos->base_mma); + if (ret) { + fprintf(stderr, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + return ret; + } + pos->base_mma = NULL; + } + /* map new base. Need mapping length from header. */ + pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ, + MAP_PRIVATE, pos->fd, pos->mmap_offset); + assert(pos->base_mma != MAP_FAILED); + + pos->content_size = packet_map_len; + pos->packet_size = packet_map_len; + pos->offset = 0; /* Position of the packet header */ + + /* update trace_packet_header and stream_packet_context */ + if (pos->prot == PROT_READ && file_stream->parent.trace_packet_header) { + /* Read packet header */ + ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); + if (ret) { + if (ret == -EFAULT) + goto retry; + } + } + if (pos->prot == PROT_READ && file_stream->parent.stream_packet_context) { + /* Read packet context */ + ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); + if (ret) { + if (ret == -EFAULT) + goto retry; + } + } + packet_index->data_offset = pos->offset; + + /* unmap old base */ + ret = munmap_align(pos->base_mma); + if (ret) { + fprintf(stderr, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + return ret; + } + pos->base_mma = NULL; + + return 0; + + /* Retry with larger mapping */ +retry: + if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) { + /* + * Reached EOF, but still expecting header/context data. + */ + fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n"); + return -EFAULT; + } + /* Double the mapping len, and retry */ + tmp_map_len = packet_map_len << 1; + if (tmp_map_len >> 1 != packet_map_len) { + /* Overflow */ + fprintf(stderr, "[error] Packet mapping length overflow\n"); + return -EFAULT; + } + packet_map_len = tmp_map_len; + goto begin; +} + + +int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace, + int fd, int open_flags) { pos->fd = fd; if (fd >= 0) { @@ -617,12 +747,14 @@ int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) pos->flags = MAP_PRIVATE; pos->parent.rw_table = read_dispatch_table; pos->parent.event_cb = ctf_read_event; + pos->parent.trace = trace; break; case O_RDWR: pos->prot = PROT_WRITE; /* Write has priority */ pos->flags = MAP_SHARED; pos->parent.rw_table = write_dispatch_table; pos->parent.event_cb = ctf_write_event; + pos->parent.trace = trace; if (fd >= 0) ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */ break; @@ -656,7 +788,7 @@ int ctf_fini_pos(struct ctf_stream_pos *pos) /* * for SEEK_CUR: go to next packet. - * for SEEK_POS: go to packet numer (index). + * for SEEK_SET: go to packet numer (index). */ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) { @@ -668,6 +800,14 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) off_t off; struct packet_index *packet_index; + switch (whence) { + case SEEK_CUR: + case SEEK_SET: /* Fall-through */ + break; /* OK */ + default: + assert(0); + } + if (pos->prot == PROT_WRITE && pos->content_size_loc) *pos->content_size_loc = pos->offset; @@ -690,7 +830,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) switch (whence) { case SEEK_CUR: /* The writer will add padding */ - pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT; + pos->mmap_offset += pos->packet_size / CHAR_BIT; break; case SEEK_SET: assert(index == 0); /* only seek supported for now */ @@ -715,6 +855,9 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) if (pos->offset == EOF) { return; } + assert(pos->cur_index < pos->packet_cycles_index->len); + assert(pos->cur_index < pos->packet_real_index->len); + /* For printing discarded event count */ packet_index = &g_array_index(pos->packet_cycles_index, struct packet_index, pos->cur_index); @@ -752,6 +895,10 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) break; } case SEEK_SET: + if (index >= pos->packet_cycles_index->len) { + pos->offset = EOF; + return; + } packet_index = &g_array_index(pos->packet_cycles_index, struct packet_index, index); pos->last_events_discarded = packet_index->events_discarded; @@ -771,7 +918,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) * case, the collection is not there, so we * cannot print the timestamps. */ - if ((&file_stream->parent)->stream_class->trace->collection) { + if ((&file_stream->parent)->stream_class->trace->parent.collection) { /* * When a stream reaches the end of the * file, we need to show the number of @@ -781,7 +928,9 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) */ if (file_stream->parent.events_discarded) { fflush(stdout); - ctf_print_discarded(stderr, &file_stream->parent); + ctf_print_discarded(stderr, + &file_stream->parent, + 1); file_stream->parent.events_discarded = 0; } } @@ -797,11 +946,17 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) struct packet_index, pos->cur_index); file_stream->parent.real_timestamp = packet_index->timestamp_begin; - pos->mmap_offset = packet_index->offset; /* Lookup context/packet size in index */ + if (packet_index->data_offset == -1) { + ret = find_data_offset(pos, file_stream, packet_index); + if (ret < 0) { + return; + } + } pos->content_size = packet_index->content_size; pos->packet_size = packet_index->packet_size; + pos->mmap_offset = packet_index->offset; if (packet_index->data_offset < packet_index->content_size) { pos->offset = 0; /* will read headers */ } else if (packet_index->data_offset == packet_index->content_size) { @@ -1028,7 +1183,7 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, buflen = strlen(*buf); if (!buflen) { *fp = NULL; - return -ENODATA; + return -ENOENT; } *fp = babeltrace_fmemopen(*buf, buflen, "rb"); if (!*fp) { @@ -1092,6 +1247,8 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td, fprintf(stderr, "[warning] Empty metadata.\n"); goto end_packet_read; } + td->metadata_string = buf; + td->metadata_packetized = 1; } else { unsigned int major, minor; ssize_t nr_items; @@ -1150,7 +1307,6 @@ end_packet_read: perror("Error on fclose"); } } - free(buf); end_stream: if (metadata_stream->pos.fd >= 0) { closeret = close(metadata_stream->pos.fd); @@ -1201,6 +1357,8 @@ error: bt_definition_unref(&stream_event->event_fields->p); if (stream_event->event_context) bt_definition_unref(&stream_event->event_context->p); + fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n", + g_quark_to_string(event->name)); return NULL; } @@ -1261,8 +1419,10 @@ int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition if (!event) continue; stream_event = create_event_definitions(td, stream, event); - if (!stream_event) + if (!stream_event) { + ret = -EINVAL; goto error_event; + } g_ptr_array_index(stream->events_by_id, i) = stream_event; } return 0; @@ -1281,239 +1441,337 @@ error: bt_definition_unref(&stream->stream_event_header->p); if (stream->stream_packet_context) bt_definition_unref(&stream->stream_packet_context->p); + fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n", + stream_class->stream_id, strerror(-ret)); return ret; } - static -int create_stream_packet_index(struct ctf_trace *td, - struct ctf_file_stream *file_stream) +int stream_assign_class(struct ctf_trace *td, + struct ctf_file_stream *file_stream, + uint64_t stream_id) { struct ctf_stream_declaration *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) + file_stream->parent.stream_id = stream_id; + if (stream_id >= td->streams->len) { + fprintf(stderr, "[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(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); + return -EINVAL; + } + file_stream->parent.stream_class = stream; + ret = create_stream_definitions(td, &file_stream->parent); + if (ret) return ret; + return 0; +} - if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT) - return -EINVAL; +static +int create_stream_one_packet_index(struct ctf_stream_pos *pos, + struct ctf_trace *td, + struct ctf_file_stream *file_stream, + size_t filesize) +{ + struct packet_index packet_index; + uint64_t stream_id = 0; + uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len; + int first_packet = 0; + int len_index; + int ret; - for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { - uint64_t stream_id = 0; +begin: + if (!pos->mmap_offset) { + first_packet = 1; + } - if (pos->base_mma) { - /* unmap old base */ - ret = munmap_align(pos->base_mma); - if (ret) { - fprintf(stderr, "[error] Unable to unmap old base: %s.\n", - strerror(errno)); - return ret; - } - pos->base_mma = NULL; - } - /* map new base. Need mapping length from header. */ - pos->base_mma = mmap_align(MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ, - MAP_PRIVATE, pos->fd, pos->mmap_offset); - assert(pos->base_mma != MAP_FAILED); - 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; - packet_index.timestamp_begin = 0; - packet_index.timestamp_end = 0; - packet_index.events_discarded = 0; - packet_index.events_discarded_len = 0; - - /* read and check header, set stream id (and check) */ - if (file_stream->parent.trace_packet_header) { - /* Read packet header */ - ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); - if (ret) - return ret; - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); - if (len_index >= 0) { - struct bt_definition *field; - uint64_t magic; - - field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); - magic = bt_get_unsigned_int(field); - if (magic != CTF_MAGIC) { - fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", - magic, - file_stream->pos.packet_cycles_index->len, - (ssize_t) pos->mmap_offset); - return -EINVAL; - } + if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) { + packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT; + } + + if (pos->base_mma) { + /* unmap old base */ + ret = munmap_align(pos->base_mma); + if (ret) { + fprintf(stderr, "[error] Unable to unmap old base: %s.\n", + strerror(errno)); + return ret; + } + pos->base_mma = NULL; + } + /* map new base. Need mapping length from header. */ + pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ, + MAP_PRIVATE, pos->fd, pos->mmap_offset); + assert(pos->base_mma != MAP_FAILED); + /* + * Use current mapping size as temporary content and packet + * size. + */ + pos->content_size = packet_map_len; + pos->packet_size = packet_map_len; + pos->offset = 0; /* Position of the packet header */ + + packet_index.offset = pos->mmap_offset; + packet_index.content_size = 0; + packet_index.packet_size = 0; + packet_index.timestamp_begin = 0; + packet_index.timestamp_end = 0; + packet_index.events_discarded = 0; + packet_index.events_discarded_len = 0; + + /* read and check header, set stream id (and check) */ + if (file_stream->parent.trace_packet_header) { + /* Read packet header */ + ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); + if (ret) { + if (ret == -EFAULT) + goto retry; + fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret)); + return ret; + } + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); + if (len_index >= 0) { + struct bt_definition *field; + uint64_t magic; + + field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); + magic = bt_get_unsigned_int(field); + if (magic != CTF_MAGIC) { + fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", + magic, + file_stream->pos.packet_cycles_index->len, + (ssize_t) pos->mmap_offset); + return -EINVAL; } + } - /* check uuid */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid")); - if (len_index >= 0) { - struct definition_array *defarray; - struct bt_definition *field; - uint64_t i; - uint8_t uuidval[BABELTRACE_UUID_LEN]; + /* check uuid */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid")); + if (len_index >= 0) { + struct definition_array *defarray; + struct bt_definition *field; + uint64_t i; + uint8_t uuidval[BABELTRACE_UUID_LEN]; - field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); - assert(field->declaration->id == CTF_TYPE_ARRAY); - defarray = container_of(field, struct definition_array, p); - assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN); + field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); + assert(field->declaration->id == CTF_TYPE_ARRAY); + defarray = container_of(field, struct definition_array, p); + assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN); - for (i = 0; i < BABELTRACE_UUID_LEN; i++) { - struct bt_definition *elem; + for (i = 0; i < BABELTRACE_UUID_LEN; i++) { + struct bt_definition *elem; - elem = bt_array_index(defarray, i); - uuidval[i] = bt_get_unsigned_int(elem); - } - ret = babeltrace_uuid_compare(td->uuid, uuidval); - if (ret) { - fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n"); - return -EINVAL; - } + elem = bt_array_index(defarray, i); + uuidval[i] = bt_get_unsigned_int(elem); } + ret = babeltrace_uuid_compare(td->uuid, uuidval); + if (ret) { + fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n"); + return -EINVAL; + } + } + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); + if (len_index >= 0) { + struct bt_definition *field; - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); - if (len_index >= 0) { - struct bt_definition *field; + field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); + stream_id = bt_get_unsigned_int(field); + } + } - field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); - stream_id = bt_get_unsigned_int(field); - } + if (!first_packet && file_stream->parent.stream_id != stream_id) { + fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n", + stream_id, + file_stream->parent.stream_id); + return -EINVAL; + } + if (first_packet) { + ret = stream_assign_class(td, file_stream, stream_id); + 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); + if (ret) { + if (ret == -EFAULT) + goto retry; + fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret)); + return ret; } + /* read packet size from header */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); + if (len_index >= 0) { + struct bt_definition *field; - if (!first_packet && file_stream->parent.stream_id != stream_id) { - fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n", - stream_id, - file_stream->parent.stream_id); - return -EINVAL; + field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); + packet_index.packet_size = bt_get_unsigned_int(field); + } else { + /* Use file size for packet size */ + packet_index.packet_size = filesize * CHAR_BIT; } - if (first_packet) { - file_stream->parent.stream_id = stream_id; - if (stream_id >= td->streams->len) { - fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); - return -EINVAL; + + /* read content size from header */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); + if (len_index >= 0) { + struct bt_definition *field; + + field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); + packet_index.content_size = bt_get_unsigned_int(field); + } else { + /* Use packet size if non-zero, else file size */ + packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT; + } + + /* read timestamp begin from header */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); + if (len_index >= 0) { + struct bt_definition *field; + + field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); + packet_index.timestamp_begin = bt_get_unsigned_int(field); + if (file_stream->parent.stream_class->trace->parent.collection) { + packet_index.timestamp_begin = + ctf_get_real_timestamp( + &file_stream->parent, + packet_index.timestamp_begin); } - stream = g_ptr_array_index(td->streams, stream_id); - if (!stream) { - fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); - return -EINVAL; + } + + /* read timestamp end from header */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); + if (len_index >= 0) { + struct bt_definition *field; + + field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); + packet_index.timestamp_end = bt_get_unsigned_int(field); + if (file_stream->parent.stream_class->trace->parent.collection) { + packet_index.timestamp_end = + ctf_get_real_timestamp( + &file_stream->parent, + packet_index.timestamp_end); } - file_stream->parent.stream_class = stream; - ret = create_stream_definitions(td, &file_stream->parent); - if (ret) - return ret; } - first_packet = 0; - if (file_stream->parent.stream_packet_context) { - /* Read packet context */ - ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); - if (ret) - return ret; - /* read content size from header */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); - if (len_index >= 0) { - struct bt_definition *field; + /* read events discarded from header */ + len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded")); + if (len_index >= 0) { + struct bt_definition *field; - field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - packet_index.content_size = bt_get_unsigned_int(field); - } else { - /* Use file size for packet size */ - packet_index.content_size = filestats.st_size * CHAR_BIT; - } + field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); + packet_index.events_discarded = bt_get_unsigned_int(field); + packet_index.events_discarded_len = bt_get_int_len(field); + } + } else { + /* Use file size for packet size */ + packet_index.packet_size = filesize * CHAR_BIT; + /* Use packet size if non-zero, else file size */ + packet_index.content_size = packet_index.packet_size ? : filesize * CHAR_BIT; + } - /* read packet size from header */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); - if (len_index >= 0) { - struct bt_definition *field; + /* Validate content size and packet size values */ + if (packet_index.content_size > packet_index.packet_size) { + fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n", + packet_index.content_size, packet_index.packet_size); + return -EINVAL; + } - field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - packet_index.packet_size = bt_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; - } + if (packet_index.packet_size > ((uint64_t) filesize - packet_index.offset) * CHAR_BIT) { + fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n", + packet_index.packet_size, ((uint64_t) filesize - packet_index.offset) * CHAR_BIT); + return -EINVAL; + } - /* read timestamp begin from header */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); - if (len_index >= 0) { - struct bt_definition *field; - - field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - packet_index.timestamp_begin = bt_get_unsigned_int(field); - if (file_stream->parent.stream_class->trace->collection) { - packet_index.timestamp_begin = - ctf_get_real_timestamp( - &file_stream->parent, - packet_index.timestamp_begin); - } - } + if (packet_index.content_size < pos->offset) { + fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n"); + return -EINVAL; + } - /* read timestamp end from header */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); - if (len_index >= 0) { - struct bt_definition *field; - - field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - packet_index.timestamp_end = bt_get_unsigned_int(field); - if (file_stream->parent.stream_class->trace->collection) { - packet_index.timestamp_end = - ctf_get_real_timestamp( - &file_stream->parent, - packet_index.timestamp_end); - } - } + if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) { + fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n"); + return -EINVAL; + } - /* read events discarded from header */ - len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded")); - if (len_index >= 0) { - struct bt_definition *field; + /* Save position after header and context */ + packet_index.data_offset = pos->offset; - field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); - packet_index.events_discarded = bt_get_unsigned_int(field); - packet_index.events_discarded_len = bt_get_int_len(field); - } - } 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_cycles_index, packet_index); - /* Validate content size and packet size values */ - if (packet_index.content_size > packet_index.packet_size) { - fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n", - packet_index.content_size, packet_index.packet_size); - return -EINVAL; - } + pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT; - if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) { - fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n", - packet_index.packet_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT); - return -EINVAL; - } + return 0; - /* Save position after header and context */ - packet_index.data_offset = pos->offset; + /* Retry with larger mapping */ +retry: + if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) { + /* + * Reached EOF, but still expecting header/context data. + */ + fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n"); + return -EFAULT; + } + /* Double the mapping len, and retry */ + tmp_map_len = packet_map_len << 1; + if (tmp_map_len >> 1 != packet_map_len) { + /* Overflow */ + fprintf(stderr, "[error] Packet mapping length overflow\n"); + return -EFAULT; + } + packet_map_len = tmp_map_len; + goto begin; +} - /* add index to packet array */ - g_array_append_val(file_stream->pos.packet_cycles_index, packet_index); +static +int create_stream_packet_index(struct ctf_trace *td, + struct ctf_file_stream *file_stream) +{ + struct ctf_stream_pos *pos; + struct stat filestats; + int ret; + + pos = &file_stream->pos; + + ret = fstat(pos->fd, &filestats); + if (ret < 0) + return ret; - pos->mmap_offset += packet_index.packet_size / CHAR_BIT; + /* Deal with empty files */ + if (!filestats.st_size) { + if (file_stream->parent.trace_packet_header + || file_stream->parent.stream_packet_context) { + /* + * We expect a trace packet header and/or stream packet + * context. Since a trace needs to have at least one + * packet, empty files are therefore not accepted. + */ + fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n"); + return -EINVAL; + } else { + /* + * Without trace packet header nor stream packet + * context, a one-packet trace can indeed be empty. This + * is only valid if there is only one stream class: 0. + */ + ret = stream_assign_class(td, file_stream, 0); + if (ret) + return ret; + return 0; + } } + for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { + ret = create_stream_one_packet_index(pos, td, file_stream, + filestats.st_size); + if (ret) + return ret; + } return 0; } @@ -1537,6 +1795,95 @@ int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition return 0; +error: + fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret)); + return ret; +} + +static +int import_stream_packet_index(struct ctf_trace *td, + struct ctf_file_stream *file_stream) +{ + struct ctf_stream_declaration *stream; + struct ctf_stream_pos *pos; + struct ctf_packet_index ctf_index; + struct ctf_packet_index_file_hdr index_hdr; + struct packet_index index; + int index_read; + int ret = 0; + int first_packet = 1; + size_t len; + + pos = &file_stream->pos; + + len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp); + if (len != 1) { + perror("read index file header"); + goto error; + } + + /* Check the index header */ + if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) { + fprintf(stderr, "[error] wrong index magic\n"); + ret = -1; + goto error; + } + if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) { + fprintf(stderr, "[error] Incompatible index file %" PRIu64 + ".%" PRIu64 ", supported %d.%d\n", + be64toh(index_hdr.index_major), + be64toh(index_hdr.index_minor), CTF_INDEX_MAJOR, + CTF_INDEX_MINOR); + ret = -1; + goto error; + } + if (index_hdr.packet_index_len == 0) { + fprintf(stderr, "[error] Packet index length cannot be 0.\n"); + ret = -1; + goto error; + } + + while ((index_read = fread(&ctf_index, index_hdr.packet_index_len, 1, + pos->index_fp)) == 1) { + uint64_t stream_id; + + memset(&index, 0, sizeof(index)); + index.offset = be64toh(ctf_index.offset); + index.packet_size = be64toh(ctf_index.packet_size); + index.content_size = be64toh(ctf_index.content_size); + index.timestamp_begin = be64toh(ctf_index.timestamp_begin); + index.timestamp_end = be64toh(ctf_index.timestamp_end); + index.events_discarded = be64toh(ctf_index.events_discarded); + index.events_discarded_len = 64; + index.data_offset = -1; + stream_id = be64toh(ctf_index.stream_id); + + if (!first_packet) { + /* add index to packet array */ + g_array_append_val(file_stream->pos.packet_cycles_index, index); + continue; + } + + file_stream->parent.stream_id = stream_id; + stream = g_ptr_array_index(td->streams, stream_id); + if (!stream) { + fprintf(stderr, "[error] Stream %" PRIu64 + " is not declared in metadata.\n", + stream_id); + ret = -EINVAL; + goto error; + } + file_stream->parent.stream_class = stream; + ret = create_stream_definitions(td, &file_stream->parent); + if (ret) + goto error; + first_packet = 0; + /* add index to packet array */ + g_array_append_val(file_stream->pos.packet_cycles_index, index); + } + + ret = 0; + error: return ret; } @@ -1553,6 +1900,7 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, int ret, fd, closeret; struct ctf_file_stream *file_stream; struct stat statbuf; + char *index_name; fd = openat(td->dirfd, path, flags); if (fd < 0) { @@ -1568,13 +1916,18 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, goto fstat_error; } if (S_ISDIR(statbuf.st_mode)) { - fprintf(stderr, "[warning] Skipping directory '%s' found in trace\n", path); + if (strncmp(path, "index", 5) != 0) { + fprintf(stderr, "[warning] Skipping directory '%s' " + "found in trace\n", path); + } ret = 0; goto fd_is_dir_ok; } file_stream = g_new0(struct ctf_file_stream, 1); file_stream->pos.last_offset = LAST_OFFSET_POISON; + file_stream->pos.fd = -1; + file_stream->pos.index_fp = NULL; strncpy(file_stream->parent.path, path, PATH_MAX); file_stream->parent.path[PATH_MAX - 1] = '\0'; @@ -1587,7 +1940,7 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, goto error_def; } - ret = ctf_init_pos(&file_stream->pos, fd, flags); + ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags); if (ret) goto error_def; ret = create_trace_definitions(td, &file_stream->parent); @@ -1596,18 +1949,66 @@ int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, /* * For now, only a single clock per trace is supported. */ - file_stream->parent.current_clock = td->single_clock; - ret = create_stream_packet_index(td, file_stream); - if (ret) - goto error_index; + file_stream->parent.current_clock = td->parent.single_clock; + + /* + * Allocate the index name for this stream and try to open it. + */ + index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char)); + if (!index_name) { + fprintf(stderr, "[error] Cannot allocate index filename\n"); + goto error_def; + } + snprintf(index_name, strlen(path) + sizeof(INDEX_PATH), + INDEX_PATH, path); + + if (faccessat(td->dirfd, index_name, O_RDONLY, flags) < 0) { + ret = create_stream_packet_index(td, file_stream); + if (ret) { + fprintf(stderr, "[error] Stream index creation error.\n"); + goto error_index; + } + } else { + ret = openat(td->dirfd, index_name, flags); + if (ret < 0) { + perror("Index file openat()"); + ret = -1; + goto error_free; + } + file_stream->pos.index_fp = fdopen(ret, "r"); + if (!file_stream->pos.index_fp) { + perror("fdopen() error"); + goto error_free; + } + ret = import_stream_packet_index(td, file_stream); + if (ret) { + ret = -1; + goto error_index; + } + ret = fclose(file_stream->pos.index_fp); + if (ret < 0) { + perror("close index"); + goto error_free; + } + } + free(index_name); + /* Add stream file to stream class */ g_ptr_array_add(file_stream->parent.stream_class->streams, &file_stream->parent); return 0; error_index: + if (file_stream->pos.index_fp) { + ret = fclose(file_stream->pos.index_fp); + if (ret < 0) { + perror("close index"); + } + } if (file_stream->parent.trace_packet_header) bt_definition_unref(&file_stream->parent.trace_packet_header->p); +error_free: + free(index_name); error_def: closeret = ctf_fini_pos(&file_stream->pos); if (closeret) { @@ -1634,6 +2035,7 @@ int ctf_open_trace_read(struct ctf_trace *td, struct dirent *dirent; struct dirent *diriter; size_t dirent_len; + char *ext; td->flags = flags; @@ -1652,8 +2054,8 @@ int ctf_open_trace_read(struct ctf_trace *td, ret = -errno; goto error_dirfd; } - strncpy(td->path, path, sizeof(td->path)); - td->path[sizeof(td->path) - 1] = '\0'; + strncpy(td->parent.path, path, sizeof(td->parent.path)); + td->parent.path[sizeof(td->parent.path) - 1] = '\0'; /* * Keep the metadata file separate. @@ -1689,6 +2091,13 @@ int ctf_open_trace_read(struct ctf_trace *td, || !strcmp(diriter->d_name, "..") || !strcmp(diriter->d_name, "metadata")) continue; + + /* Ignore index files : *.idx */ + ext = strrchr(diriter->d_name, '.'); + if (ext && (!strcmp(ext, ".idx"))) { + continue; + } + ret = ctf_open_file_stream_read(td, diriter->d_name, flags, packet_seek); if (ret) { @@ -1837,7 +2246,7 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td, /* * For now, only a single clock per trace is supported. */ - file_stream->parent.current_clock = td->single_clock; + file_stream->parent.current_clock = td->parent.single_clock; /* Add stream file to stream class */ g_ptr_array_add(file_stream->parent.stream_class->streams, @@ -2022,6 +2431,7 @@ int ctf_close_trace(struct bt_trace_descriptor *tdp) perror("Error closedir"); return ret; } + free(td->metadata_string); g_free(td); return 0; } @@ -2033,7 +2443,7 @@ void ctf_set_context(struct bt_trace_descriptor *descriptor, struct ctf_trace *td = container_of(descriptor, struct ctf_trace, parent); - td->ctx = ctx; + td->parent.ctx = ctx; } static @@ -2043,7 +2453,7 @@ void ctf_set_handle(struct bt_trace_descriptor *descriptor, struct ctf_trace *td = container_of(descriptor, struct ctf_trace, parent); - td->handle = handle; + td->parent.handle = handle; } static