Fix: test content size vs headers len
[babeltrace.git] / formats / ctf / ctf.c
index 58f937d8f1c9e8708690c81eb15ab95bc7839476..794e428c51d069a97354826b17f0f391afbafcbf 100644 (file)
@@ -33,8 +33,9 @@
 #include <babeltrace/ctf/events-internal.h>
 #include <babeltrace/trace-handle-internal.h>
 #include <babeltrace/context-internal.h>
-#include <babeltrace/uuid.h>
+#include <babeltrace/compat/uuid.h>
 #include <babeltrace/endian.h>
+#include <babeltrace/ctf/ctf-index.h>
 #include <inttypes.h>
 #include <stdio.h>
 #include <sys/mman.h>
@@ -51,7 +52,7 @@
 #include "metadata/ctf-parser.h"
 #include "metadata/ctf-ast.h"
 #include "events-private.h"
-#include "memstream.h"
+#include <babeltrace/compat/memstream.h>
 
 #define LOG2_CHAR_BIT  3
 
 
 #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;
 
@@ -321,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;
 
@@ -544,10 +551,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;
 }
 
@@ -666,7 +678,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)
 {
@@ -678,6 +690,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;
 
@@ -700,7 +720,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 */
@@ -725,6 +745,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);
@@ -762,6 +785,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;
@@ -1303,6 +1330,31 @@ error:
        return ret;
 }
 
+static
+int stream_assign_class(struct ctf_trace *td,
+               struct ctf_file_stream *file_stream,
+               uint64_t stream_id)
+{
+       struct ctf_stream_declaration *stream;
+       int ret;
+
+       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;
+}
+
 static
 int create_stream_one_packet_index(struct ctf_stream_pos *pos,
                        struct ctf_trace *td,
@@ -1310,7 +1362,6 @@ int create_stream_one_packet_index(struct ctf_stream_pos *pos,
                        size_t filesize)
 {
        struct packet_index packet_index;
-       struct ctf_stream_declaration *stream;
        uint64_t stream_id = 0;
        uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len;
        int first_packet = 0;
@@ -1424,18 +1475,7 @@ begin:
                return -EINVAL;
        }
        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;
-               }
-               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);
+               ret = stream_assign_class(td, file_stream, stream_id);
                if (ret)
                        return ret;
        }
@@ -1449,28 +1489,28 @@ begin:
                        fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-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"));
+               /* 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;
 
                        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);
+                       packet_index.packet_size = bt_get_unsigned_int(field);
                } else {
                        /* Use file size for packet size */
-                       packet_index.content_size = filesize * CHAR_BIT;
+                       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"));
+               /* 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.packet_size = bt_get_unsigned_int(field);
+                       packet_index.content_size = bt_get_unsigned_int(field);
                } else {
-                       /* Use content size if non-zero, else file size */
-                       packet_index.packet_size = packet_index.content_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 timestamp begin from header */
@@ -1514,9 +1554,9 @@ begin:
                }
        } else {
                /* Use file size for packet size */
-               packet_index.content_size = filesize * CHAR_BIT;
-               /* Use content size if non-zero, else file size */
-               packet_index.packet_size = packet_index.content_size ? : filesize * CHAR_BIT;
+               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;
        }
 
        /* Validate content size and packet size values */
@@ -1532,6 +1572,16 @@ begin:
                return -EINVAL;
        }
 
+       if (packet_index.content_size < pos->offset) {
+               fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n");
+               return -EINVAL;
+       }
+
+       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;
+       }
+
        /* Save position after header and context */
        packet_index.data_offset = pos->offset;
 
@@ -1576,6 +1626,30 @@ int create_stream_packet_index(struct ctf_trace *td,
        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);
@@ -1610,6 +1684,93 @@ error:
        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;
+               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;
+}
+
 /*
  * Note: many file streams can inherit from the same stream class
  * description (metadata).
@@ -1622,6 +1783,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) {
@@ -1637,13 +1799,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';
@@ -1666,19 +1833,65 @@ 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->parent.single_clock;
-       ret = create_stream_packet_index(td, file_stream);
-       if (ret) {
-               fprintf(stderr, "[error] Stream index creation error.\n");
-               goto error_index;
+
+       /*
+        * 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) {
@@ -1705,6 +1918,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;
 
@@ -1760,6 +1974,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) {
This page took 0.03 seconds and 4 git commands to generate.