X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=formats%2Fctf%2Fctf.c;h=af1809efc8a0390986027bded924e6d2b3bb932e;hp=8f8af52517c407f1c32e80779f2fa35e69f717e1;hb=edcad9c1c88e6e698040855d7518d0c27dfc4489;hpb=87148dc74de9861a656aa4f38f03b51743471049 diff --git a/formats/ctf/ctf.c b/formats/ctf/ctf.c index 8f8af525..af1809ef 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,19 @@ #include "metadata/ctf-parser.h" #include "metadata/ctf-ast.h" #include "events-private.h" -#include "memstream.h" +#include +#include + +#define LOG2_CHAR_BIT 3 + +/* + * Length of first attempt at mapping a packet header, in bits. + */ +#define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT) /* - * We currently simply map a page to read the packet header and packet - * context to get the packet length and content length. (in bits) + * 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,15 +73,25 @@ #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; +/* + * TODO: babeltrace_ctf_console_output ensures that we only print + * discarded events when ctf-text plugin is used. Should be cleaned up + * with the plugin system redesign. + */ +int babeltrace_ctf_console_output; + static struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags, void (*packet_seek)(struct bt_stream_pos *pos, size_t index, @@ -172,26 +189,24 @@ uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor, parent); stream_pos = &cfs->pos; - if (!stream_pos->packet_real_index) + if (!stream_pos->packet_index) goto error; - if (stream_pos->packet_real_index->len <= 0) + if (stream_pos->packet_index->len <= 0) continue; + index = &g_array_index(stream_pos->packet_index, + struct packet_index, + stream_pos->packet_index->len - 1); if (type == BT_CLOCK_REAL) { - index = &g_array_index(stream_pos->packet_real_index, - struct packet_index, - stream_pos->packet_real_index->len - 1); + if (index->ts_real.timestamp_begin < begin) + begin = index->ts_real.timestamp_begin; } else if (type == BT_CLOCK_CYCLES) { - index = &g_array_index(stream_pos->packet_cycles_index, - struct packet_index, - stream_pos->packet_real_index->len - 1); - + if (index->ts_cycles.timestamp_begin < begin) + begin = index->ts_cycles.timestamp_begin; } else { goto error; } - if (index->timestamp_begin < begin) - begin = index->timestamp_begin; } } @@ -233,26 +248,24 @@ uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor, parent); stream_pos = &cfs->pos; - if (!stream_pos->packet_real_index) + if (!stream_pos->packet_index) goto error; - if (stream_pos->packet_real_index->len <= 0) + if (stream_pos->packet_index->len <= 0) continue; + index = &g_array_index(stream_pos->packet_index, + struct packet_index, + stream_pos->packet_index->len - 1); if (type == BT_CLOCK_REAL) { - index = &g_array_index(stream_pos->packet_real_index, - struct packet_index, - stream_pos->packet_real_index->len - 1); + if (index->ts_real.timestamp_end > end) + end = index->ts_real.timestamp_end; } else if (type == BT_CLOCK_CYCLES) { - index = &g_array_index(stream_pos->packet_cycles_index, - struct packet_index, - stream_pos->packet_real_index->len - 1); - + if (index->ts_cycles.timestamp_end > end) + end = index->ts_cycles.timestamp_end; } else { goto error; } - if (index->timestamp_end > end) - end = index->timestamp_end; } } @@ -274,10 +287,7 @@ void ctf_update_timestamp(struct ctf_stream_definition *stream, uint64_t oldval, newval, updateval; if (unlikely(integer_declaration->len == 64)) { - stream->prev_cycles_timestamp = stream->cycles_timestamp; stream->cycles_timestamp = integer_definition->value._unsigned; - stream->prev_real_timestamp = ctf_get_real_timestamp(stream, - stream->prev_cycles_timestamp); stream->real_timestamp = ctf_get_real_timestamp(stream, stream->cycles_timestamp); return; @@ -293,12 +303,9 @@ void ctf_update_timestamp(struct ctf_stream_definition *stream, updateval = stream->cycles_timestamp; updateval &= ~((1ULL << integer_declaration->len) - 1); updateval += newval; - stream->prev_cycles_timestamp = stream->cycles_timestamp; stream->cycles_timestamp = updateval; /* convert to real timestamp */ - stream->prev_real_timestamp = ctf_get_real_timestamp(stream, - stream->prev_cycles_timestamp); stream->real_timestamp = ctf_get_real_timestamp(stream, stream->cycles_timestamp); } @@ -316,6 +323,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,28 +410,45 @@ void print_uuid(FILE *fp, unsigned char *uuid) fprintf(fp, "%x", (unsigned int) uuid[i]); } +/* + * Discarded events can be either: + * - discarded after end of previous buffer due to buffer full: + * happened within range: [ prev_timestamp_end, timestamp_begin ] + * - discarded within current buffer due to either event too large or + * nested wrap-around: + * happened within range: [ timestamp_begin, timestamp_end ] + * + * Given we have discarded counters of those two types merged into the + * events_discarded counter, we need to use the union of those ranges: + * [ prev_timestamp_end, timestamp_end ] + */ +static void ctf_print_discarded(FILE *fp, struct ctf_stream_definition *stream) { + if (!stream->events_discarded || !babeltrace_ctf_console_output) { + return; + } + fflush(stdout); fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [", stream->events_discarded); if (opt_clock_cycles) { ctf_print_timestamp(fp, stream, - stream->prev_cycles_timestamp); + stream->prev.cycles.end); fprintf(fp, "] and ["); ctf_print_timestamp(fp, stream, - stream->prev_cycles_timestamp_end); + stream->current.cycles.end); } else { ctf_print_timestamp(fp, stream, - stream->prev_real_timestamp); + stream->prev.real.end); fprintf(fp, "] and ["); ctf_print_timestamp(fp, stream, - stream->prev_real_timestamp_end); + stream->current.real.end); } 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 +484,19 @@ int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *str */ if (unlikely(pos->offset == EOF)) return EOF; + + /* Stream is inactive for now (live reading). */ + if (unlikely(pos->content_size == 0)) + return EAGAIN; + + /* + * Packet seeked to by ctf_pos_get_event() only contains + * headers, no event. Consider stream as inactive (live + * reading). + */ + if (unlikely(pos->data_offset == pos->content_size)) + return EAGAIN; + assert(pos->offset < pos->content_size); /* Read event header */ @@ -537,10 +577,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,17 +644,116 @@ 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) { - pos->packet_cycles_index = g_array_new(FALSE, TRUE, - sizeof(struct packet_index)); - pos->packet_real_index = g_array_new(FALSE, TRUE, + pos->packet_index = g_array_new(FALSE, TRUE, sizeof(struct packet_index)); } else { - pos->packet_cycles_index = NULL; - pos->packet_real_index = NULL; + pos->packet_index = NULL; } switch (open_flags & O_ACCMODE) { case O_RDONLY: @@ -617,12 +761,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->prot = PROT_READ | PROT_WRITE; 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; @@ -634,7 +780,7 @@ int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) int ctf_fini_pos(struct ctf_stream_pos *pos) { - if (pos->prot == PROT_WRITE && pos->content_size_loc) + if ((pos->prot & PROT_WRITE) && pos->content_size_loc) *pos->content_size_loc = pos->offset; if (pos->base_mma) { int ret; @@ -647,16 +793,68 @@ int ctf_fini_pos(struct ctf_stream_pos *pos) return -1; } } - if (pos->packet_cycles_index) - (void) g_array_free(pos->packet_cycles_index, TRUE); - if (pos->packet_real_index) - (void) g_array_free(pos->packet_real_index, TRUE); + if (pos->packet_index) + (void) g_array_free(pos->packet_index, TRUE); return 0; } +void ctf_update_current_packet_index(struct ctf_stream_definition *stream, + struct packet_index *prev_index, + struct packet_index *cur_index) +{ + uint64_t events_discarded_diff; + + /* Update packet index time information */ + + /* Current packet begin/end */ + stream->current.real.begin = + cur_index->ts_real.timestamp_begin; + stream->current.cycles.begin = + cur_index->ts_cycles.timestamp_begin; + stream->current.real.end = + cur_index->ts_real.timestamp_end; + stream->current.cycles.end = + cur_index->ts_cycles.timestamp_end; + + /* Update packet index discarded event information */ + events_discarded_diff = cur_index->events_discarded; + if (prev_index) { + /* Previous packet begin/end */ + stream->prev.cycles.begin = + prev_index->ts_cycles.timestamp_begin; + stream->prev.real.begin = + prev_index->ts_real.timestamp_begin; + stream->prev.cycles.end = + prev_index->ts_cycles.timestamp_end; + stream->prev.real.end = + prev_index->ts_real.timestamp_end; + + events_discarded_diff -= prev_index->events_discarded; + /* + * Deal with 32-bit wrap-around if the tracer provided a + * 32-bit field. + */ + if (prev_index->events_discarded_len == 32) { + events_discarded_diff = (uint32_t) events_discarded_diff; + } + } else { + /* + * First packet: use current packet info as limits for + * previous packet. + */ + stream->prev.cycles.begin = + stream->prev.cycles.end = + stream->current.cycles.begin; + stream->prev.real.begin = + stream->prev.real.end = + stream->current.real.begin; + } + stream->events_discarded = events_discarded_diff; +} + /* * 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) { @@ -666,9 +864,17 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) container_of(pos, struct ctf_file_stream, pos); int ret; off_t off; - struct packet_index *packet_index; + struct packet_index *packet_index, *prev_index; - if (pos->prot == PROT_WRITE && pos->content_size_loc) + 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; if (pos->base_mma) { @@ -686,11 +892,11 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) * 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) { + if (pos->prot & PROT_WRITE) { 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 */ @@ -701,110 +907,82 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) } pos->content_size = -1U; /* Unknown at this point */ pos->packet_size = WRITE_PACKET_LEN; - off = posix_fallocate(pos->fd, pos->mmap_offset, + off = bt_posix_fallocate(pos->fd, pos->mmap_offset, pos->packet_size / CHAR_BIT); - assert(off >= 0); + assert(off == 0); pos->offset = 0; } else { read_next_packet: switch (whence) { case SEEK_CUR: { - uint64_t events_discarded_diff; - if (pos->offset == EOF) { return; } - /* For printing discarded event count */ - packet_index = &g_array_index(pos->packet_cycles_index, - struct packet_index, pos->cur_index); - file_stream->parent.prev_cycles_timestamp_end = - packet_index->timestamp_end; - file_stream->parent.prev_cycles_timestamp = - packet_index->timestamp_begin; - - packet_index = &g_array_index(pos->packet_real_index, - struct packet_index, pos->cur_index); - file_stream->parent.prev_real_timestamp_end = - packet_index->timestamp_end; - file_stream->parent.prev_real_timestamp = - packet_index->timestamp_begin; - - events_discarded_diff = packet_index->events_discarded; - if (pos->cur_index > 0) { - packet_index = &g_array_index(pos->packet_real_index, - struct packet_index, - pos->cur_index - 1); - events_discarded_diff -= packet_index->events_discarded; - /* - * Deal with 32-bit wrap-around if the - * tracer provided a 32-bit field. - */ - if (packet_index->events_discarded_len == 32) { - events_discarded_diff = (uint32_t) events_discarded_diff; - } - } - file_stream->parent.events_discarded = events_discarded_diff; - file_stream->parent.prev_real_timestamp = file_stream->parent.real_timestamp; - file_stream->parent.prev_cycles_timestamp = file_stream->parent.cycles_timestamp; + assert(pos->cur_index < pos->packet_index->len); /* The reader will expect us to skip padding */ ++pos->cur_index; break; } case SEEK_SET: - packet_index = &g_array_index(pos->packet_cycles_index, - struct packet_index, index); - pos->last_events_discarded = packet_index->events_discarded; + if (index >= pos->packet_index->len) { + pos->offset = EOF; + return; + } pos->cur_index = index; - file_stream->parent.prev_real_timestamp = 0; - file_stream->parent.prev_real_timestamp_end = 0; - file_stream->parent.prev_cycles_timestamp = 0; - file_stream->parent.prev_cycles_timestamp_end = 0; break; default: assert(0); } - if (pos->cur_index >= pos->packet_real_index->len) { - /* - * We need to check if we are in trace read or - * called from packet indexing. In this last - * case, the collection is not there, so we - * cannot print the timestamps. - */ - if ((&file_stream->parent)->stream_class->trace->collection) { - /* - * When a stream reaches the end of the - * file, we need to show the number of - * events discarded ourselves, because - * there is no next event scheduled to - * be printed in the output. - */ - if (file_stream->parent.events_discarded) { - fflush(stdout); - ctf_print_discarded(stderr, &file_stream->parent); - file_stream->parent.events_discarded = 0; - } - } + + packet_index = &g_array_index(pos->packet_index, + struct packet_index, pos->cur_index); + if (pos->cur_index > 0) { + prev_index = &g_array_index(pos->packet_index, + struct packet_index, + pos->cur_index - 1); + } else { + prev_index = NULL; + } + ctf_update_current_packet_index(&file_stream->parent, + prev_index, packet_index); + + if (pos->cur_index >= pos->packet_index->len) { pos->offset = EOF; return; } - packet_index = &g_array_index(pos->packet_cycles_index, - struct packet_index, - pos->cur_index); - file_stream->parent.cycles_timestamp = packet_index->timestamp_begin; - packet_index = &g_array_index(pos->packet_real_index, + /* + * We need to check if we are in trace read or called + * from packet indexing. In this last case, the + * collection is not there, so we cannot print the + * timestamps. + */ + if ((&file_stream->parent)->stream_class->trace->parent.collection) { + ctf_print_discarded(stderr, &file_stream->parent); + } + + packet_index = &g_array_index(pos->packet_index, struct packet_index, pos->cur_index); - file_stream->parent.real_timestamp = packet_index->timestamp_begin; - pos->mmap_offset = packet_index->offset; + file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin; + + file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin; /* 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; - if (packet_index->data_offset < packet_index->content_size) { + pos->mmap_offset = packet_index->offset; + pos->data_offset = packet_index->data_offset; + if (pos->data_offset < packet_index->content_size) { pos->offset = 0; /* will read headers */ - } else if (packet_index->data_offset == packet_index->content_size) { + } else if (pos->data_offset == packet_index->content_size) { /* empty packet */ pos->offset = packet_index->data_offset; whence = SEEK_CUR; @@ -824,12 +1002,14 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) } /* update trace_packet_header and stream_packet_context */ - if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) { + if (!(pos->prot & PROT_WRITE) && + file_stream->parent.trace_packet_header) { /* Read packet header */ ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); assert(!ret); } - if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) { + if (!(pos->prot & PROT_WRITE) && + file_stream->parent.stream_packet_context) { /* Read packet context */ ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); assert(!ret); @@ -889,7 +1069,7 @@ warning: } static -int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, +int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, FILE *out) { struct metadata_packet_header header; @@ -930,7 +1110,7 @@ int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, memcpy(td->uuid, header.uuid, sizeof(header.uuid)); CTF_TRACE_SET_FIELD(td, uuid); } else { - if (babeltrace_uuid_compare(header.uuid, td->uuid)) + if (bt_uuid_compare(header.uuid, td->uuid)) return -EINVAL; } @@ -979,7 +1159,7 @@ read_padding: } static -int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, +int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, char **buf) { FILE *in, *out; @@ -998,7 +1178,7 @@ int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, return -errno; } for (;;) { - ret = ctf_open_trace_metadata_packet_read(td, in, out); + ret = ctf_trace_metadata_packet_read(td, in, out); if (ret) { break; } @@ -1028,7 +1208,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) { @@ -1039,11 +1219,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, - void (*packet_seek)(struct bt_stream_pos *pos, size_t index, - int whence), FILE *metadata_fp) +int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp, + struct ctf_scanner *scanner, int append) { - struct ctf_scanner *scanner; struct ctf_file_stream *metadata_stream; FILE *fp; char *buf = NULL; @@ -1052,14 +1230,6 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td, metadata_stream = g_new0(struct ctf_file_stream, 1); metadata_stream->pos.last_offset = LAST_OFFSET_POISON; - if (packet_seek) { - metadata_stream->pos.packet_seek = packet_seek; - } else { - fprintf(stderr, "[error] packet_seek function undefined.\n"); - ret = -1; - goto end_free; - } - if (metadata_fp) { fp = metadata_fp; metadata_stream->pos.fd = -1; @@ -1086,36 +1256,32 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td, yydebug = 1; if (packet_metadata(td, fp)) { - ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf); + ret = ctf_trace_metadata_stream_read(td, &fp, &buf); if (ret) { - /* Warn about empty metadata */ - fprintf(stderr, "[warning] Empty metadata.\n"); - goto end_packet_read; + goto end; } + td->metadata_string = buf; + td->metadata_packetized = 1; } 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(stderr, "[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; + if (!append) { + 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 %10u.%10u", &major, &minor); + if (nr_items < 2) + fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n"); + if (check_version(major, minor) < 0) { + ret = -EINVAL; + goto end; + } + rewind(fp); } - rewind(fp); } - scanner = ctf_scanner_alloc(fp); - if (!scanner) { - fprintf(stderr, "[error] Error allocating scanner\n"); - ret = -ENOMEM; - goto end_scanner_alloc; - } - ret = ctf_scanner_append_ast(scanner); + ret = ctf_scanner_append_ast(scanner, fp); if (ret) { fprintf(stderr, "[error] Error creating AST\n"); goto end; @@ -1141,16 +1307,12 @@ int ctf_open_trace_metadata_read(struct ctf_trace *td, goto end; } end: - ctf_scanner_free(scanner); -end_scanner_alloc: -end_packet_read: if (fp) { closeret = fclose(fp); if (closeret) { perror("Error on fclose"); } } - free(buf); end_stream: if (metadata_stream->pos.fd >= 0) { closeret = close(metadata_stream->pos.fd); @@ -1201,9 +1363,41 @@ 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; } +static +int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td, + struct ctf_stream_declaration *stream_class, + struct ctf_stream_definition *stream) +{ + size_t def_size, class_size, i; + int ret = 0; + + def_size = stream->events_by_id->len; + class_size = stream_class->events_by_id->len; + + g_ptr_array_set_size(stream->events_by_id, class_size); + for (i = def_size; i < class_size; i++) { + struct ctf_event_declaration *event = + g_ptr_array_index(stream_class->events_by_id, i); + struct ctf_event_definition *stream_event; + + if (!event) + continue; + stream_event = create_event_definitions(td, stream, event); + if (!stream_event) { + ret = -EINVAL; + goto error; + } + g_ptr_array_index(stream->events_by_id, i) = stream_event; + } +error: + return ret; +} + static int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream) { @@ -1253,18 +1447,10 @@ int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition stream->parent_def_scope = stream->stream_event_context->p.scope; } stream->events_by_id = g_ptr_array_new(); - g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len); - for (i = 0; i < stream->events_by_id->len; i++) { - struct ctf_event_declaration *event = g_ptr_array_index(stream_class->events_by_id, i); - struct ctf_event_definition *stream_event; - - if (!event) - continue; - stream_event = create_event_definitions(td, stream, event); - if (!stream_event) - goto error_event; - g_ptr_array_index(stream->events_by_id, i) = stream_event; - } + ret = copy_event_declarations_stream_class_to_stream(td, + stream_class, stream); + if (ret) + goto error_event; return 0; error_event: @@ -1281,239 +1467,339 @@ 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.ts_real.timestamp_begin = 0; + packet_index.ts_real.timestamp_end = 0; + packet_index.ts_cycles.timestamp_begin = 0; + packet_index.ts_cycles.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_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 = bt_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.ts_cycles.timestamp_begin = bt_get_unsigned_int(field); + if (file_stream->parent.stream_class->trace->parent.collection) { + packet_index.ts_real.timestamp_begin = + ctf_get_real_timestamp( + &file_stream->parent, + packet_index.ts_cycles.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.ts_cycles.timestamp_end = bt_get_unsigned_int(field); + if (file_stream->parent.stream_class->trace->parent.collection) { + packet_index.ts_real.timestamp_end = + ctf_get_real_timestamp( + &file_stream->parent, + packet_index.ts_cycles.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_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->mmap_offset += packet_index.packet_size / CHAR_BIT; + pos = &file_stream->pos; + + ret = fstat(pos->fd, &filestats); + if (ret < 0) + return ret; + + /* 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; } @@ -1538,6 +1824,109 @@ 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_pos *pos; + struct ctf_packet_index *ctf_index = NULL; + struct ctf_packet_index_file_hdr index_hdr; + struct packet_index index; + uint32_t packet_index_len; + 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 %" PRIu32 + ".%" PRIu32 ", supported %d.%d\n", + be32toh(index_hdr.index_major), + be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR, + CTF_INDEX_MINOR); + ret = -1; + goto error; + } + packet_index_len = be32toh(index_hdr.packet_index_len); + if (packet_index_len == 0) { + fprintf(stderr, "[error] Packet index length cannot be 0.\n"); + ret = -1; + goto error; + } + /* + * Allocate the index length found in header, not internal + * representation. + */ + ctf_index = g_malloc0(packet_index_len); + while (fread(ctf_index, packet_index_len, 1, + pos->index_fp) == 1) { + uint64_t stream_id; + struct ctf_stream_declaration *stream = NULL; + + 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.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin); + index.ts_cycles.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_index, index); + continue; + } + + file_stream->parent.stream_id = stream_id; + if (stream_id < td->streams->len) { + 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_index, index); + } + + /* Index containing only the header. */ + if (!file_stream->parent.stream_class) { + ret = -1; + goto error; + } + + ret = 0; + +error: + g_free(ctf_index); return ret; } @@ -1553,6 +1942,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 +1958,23 @@ 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; } + if (!statbuf.st_size) { + /** Skip empty files. */ + ret = 0; + goto fd_is_empty_file; + } 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 +1987,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,24 +1996,74 @@ 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"); + ret = -ENOMEM; + 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) { fprintf(stderr, "Error on ctf_fini_pos\n"); } g_free(file_stream); +fd_is_empty_file: fd_is_dir_ok: fstat_error: closeret = close(fd); @@ -1630,10 +2080,12 @@ int ctf_open_trace_read(struct ctf_trace *td, void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence), FILE *metadata_fp) { + struct ctf_scanner *scanner; int ret, closeret; struct dirent *dirent; struct dirent *diriter; size_t dirent_len; + char *ext; td->flags = flags; @@ -1652,15 +2104,26 @@ 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. + * Keep scanner object local to the open. We don't support + * incremental metadata append for on-disk traces. */ - - ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp); + scanner = ctf_scanner_alloc(); + if (!scanner) { + fprintf(stderr, "[error] Error allocating scanner\n"); + ret = -ENOMEM; + goto error_metadata; + } + ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0); + ctf_scanner_free(scanner); if (ret) { + if (ret == -ENOENT) { + fprintf(stderr, "[warning] Empty metadata.\n"); + } fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path); goto error_metadata; } @@ -1689,6 +2152,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) { @@ -1774,23 +2244,28 @@ void ctf_init_mmap_pos(struct ctf_stream_pos *pos, pos->offset = 0; pos->dummy = false; pos->cur_index = 0; - pos->packet_cycles_index = NULL; - pos->packet_real_index = NULL; pos->prot = PROT_READ; pos->flags = MAP_PRIVATE; pos->parent.rw_table = read_dispatch_table; pos->parent.event_cb = ctf_read_event; + pos->priv = mmap_info->priv; + pos->packet_index = g_array_new(FALSE, TRUE, + sizeof(struct packet_index)); } static int prepare_mmap_stream_definition(struct ctf_trace *td, - struct ctf_file_stream *file_stream) + struct ctf_file_stream *file_stream, + void (*packet_seek)(struct bt_stream_pos *pos, size_t index, + int whence)) { struct ctf_stream_declaration *stream; - uint64_t stream_id = 0; + uint64_t stream_id; int ret; - file_stream->parent.stream_id = stream_id; + /* Ask for the first packet to get the stream_id. */ + packet_seek(&file_stream->pos.parent, 0, SEEK_SET); + stream_id = file_stream->parent.stream_id; if (stream_id >= td->streams->len) { fprintf(stderr, "[error] Stream %" PRIu64 " is not declared " "in metadata.\n", stream_id); @@ -1820,6 +2295,7 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td, struct ctf_file_stream *file_stream; file_stream = g_new0(struct ctf_file_stream, 1); + file_stream->parent.stream_id = -1ULL; file_stream->pos.last_offset = LAST_OFFSET_POISON; ctf_init_mmap_pos(&file_stream->pos, mmap_info); @@ -1830,14 +2306,14 @@ int ctf_open_mmap_stream_read(struct ctf_trace *td, goto error_def; } - ret = prepare_mmap_stream_definition(td, file_stream); + ret = prepare_mmap_stream_definition(td, file_stream, packet_seek); if (ret) goto error_index; /* * 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, @@ -1862,8 +2338,17 @@ int ctf_open_mmap_trace_read(struct ctf_trace *td, int ret; struct bt_mmap_stream *mmap_info; - ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp); + td->scanner = ctf_scanner_alloc(); + if (!td->scanner) { + fprintf(stderr, "[error] Error allocating scanner\n"); + ret = -ENOMEM; + goto error; + } + ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0); if (ret) { + if (ret == -ENOENT) { + fprintf(stderr, "[warning] Empty metadata.\n"); + } goto error; } @@ -1878,10 +2363,10 @@ int ctf_open_mmap_trace_read(struct ctf_trace *td, goto error; } } - return 0; error: + ctf_scanner_free(td->scanner); return ret; } @@ -1905,6 +2390,7 @@ struct bt_trace_descriptor *ctf_open_mmap_trace( goto error; } td = g_new0(struct ctf_trace, 1); + td->dirfd = -1; ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp); if (ret) goto error_free; @@ -1917,6 +2403,41 @@ error: return NULL; } +int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp, + FILE *metadata_fp) +{ + struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); + int i, j; + int ret; + + if (!td->scanner) + return -EINVAL; + ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1); + if (ret) + return ret; + /* for each stream_class */ + for (i = 0; i < td->streams->len; i++) { + struct ctf_stream_declaration *stream_class; + + stream_class = g_ptr_array_index(td->streams, i); + if (!stream_class) + continue; + /* for each stream */ + for (j = 0; j < stream_class->streams->len; j++) { + struct ctf_stream_definition *stream; + + stream = g_ptr_array_index(stream_class->streams, j); + if (!stream) + continue; + ret = copy_event_declarations_stream_class_to_stream(td, + stream_class, stream); + if (ret) + return ret; + } + } + return 0; +} + static int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp) { @@ -1942,25 +2463,20 @@ int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp) cfs = container_of(stream, struct ctf_file_stream, parent); stream_pos = &cfs->pos; - if (!stream_pos->packet_cycles_index) + if (!stream_pos->packet_index) continue; - for (k = 0; k < stream_pos->packet_cycles_index->len; k++) { + for (k = 0; k < stream_pos->packet_index->len; k++) { struct packet_index *index; - struct packet_index new_index; - index = &g_array_index(stream_pos->packet_cycles_index, + index = &g_array_index(stream_pos->packet_index, struct packet_index, k); - memcpy(&new_index, index, - sizeof(struct packet_index)); - new_index.timestamp_begin = + index->ts_real.timestamp_begin = ctf_get_real_timestamp(stream, - index->timestamp_begin); - new_index.timestamp_end = + index->ts_cycles.timestamp_begin); + index->ts_real.timestamp_end = ctf_get_real_timestamp(stream, - index->timestamp_end); - g_array_append_val(stream_pos->packet_real_index, - new_index); + index->ts_cycles.timestamp_end); } } } @@ -1977,10 +2493,12 @@ int ctf_close_file_stream(struct ctf_file_stream *file_stream) fprintf(stderr, "Error on ctf_fini_pos\n"); return -1; } - ret = close(file_stream->pos.fd); - if (ret) { - perror("Error closing file fd"); - return -1; + if (file_stream->pos.fd >= 0) { + ret = close(file_stream->pos.fd); + if (ret) { + perror("Error closing file fd"); + return -1; + } } return 0; } @@ -2012,16 +2530,22 @@ int ctf_close_trace(struct bt_trace_descriptor *tdp) } } ctf_destroy_metadata(td); - ret = close(td->dirfd); - if (ret) { - perror("Error closing dirfd"); - return ret; + ctf_scanner_free(td->scanner); + if (td->dirfd >= 0) { + ret = close(td->dirfd); + if (ret) { + perror("Error closing dirfd"); + return ret; + } } - ret = closedir(td->dir); - if (ret) { - perror("Error closedir"); - return ret; + if (td->dir) { + ret = closedir(td->dir); + if (ret) { + perror("Error closedir"); + return ret; + } } + free(td->metadata_string); g_free(td); return 0; } @@ -2033,7 +2557,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 +2567,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