Fix: Unchecked array index when importing trace indexes
[babeltrace.git] / formats / ctf / ctf.c
index 5cf8097ce709892580c49957cf4751f9bc2e753b..6d21b876dad422628f0884ea7e9e21be7c2db063 100644 (file)
@@ -181,26 +181,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;
                }
        }
 
@@ -242,26 +240,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;
                }
        }
 
@@ -472,12 +468,16 @@ 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). */
+       /* Stream is inactive for now (live reading). */
+       if (unlikely(pos->content_size == 0))
                return EAGAIN;
-       }
-       /* Packet only contains headers */
-       if (pos->offset == pos->content_size)
+
+       /*
+        * 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);
@@ -627,18 +627,116 @@ error:
        return ret;
 }
 
+/*
+ * 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:
@@ -678,13 +776,47 @@ 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 */
+       stream->prev_cycles_timestamp_end =
+               cur_index->ts_cycles.timestamp_end;
+       stream->prev_cycles_timestamp =
+               cur_index->ts_cycles.timestamp_begin;
+       stream->prev_real_timestamp_end =
+               cur_index->ts_real.timestamp_end;
+       stream->prev_real_timestamp =
+               cur_index->ts_real.timestamp_begin;
+
+       stream->prev_real_timestamp =
+               stream->real_timestamp;
+       stream->prev_cycles_timestamp =
+               stream->cycles_timestamp;
+
+       /* Update packet index discarded event information */
+       events_discarded_diff = cur_index->events_discarded;
+       if (prev_index) {
+               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;
+               }
+       }
+       stream->events_discarded = events_discarded_diff;
+}
+
 /*
  * for SEEK_CUR: go to next packet.
  * for SEEK_SET: go to packet numer (index).
@@ -749,56 +881,32 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                switch (whence) {
                case SEEK_CUR:
                {
-                       uint64_t events_discarded_diff;
+                       struct packet_index *prev_index = NULL;
 
                        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,
+                       assert(pos->cur_index < pos->packet_index->len);
+                       packet_index = &g_array_index(pos->packet_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,
+                               prev_index = &g_array_index(pos->packet_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;
+                       ctf_update_current_packet_index(&file_stream->parent,
+                                       prev_index, packet_index);
+
                        /* The reader will expect us to skip padding */
                        ++pos->cur_index;
                        break;
                }
                case SEEK_SET:
-                       if (index >= pos->packet_cycles_index->len) {
+                       if (index >= pos->packet_index->len) {
                                pos->offset = EOF;
                                return;
                        }
-                       packet_index = &g_array_index(pos->packet_cycles_index,
+                       packet_index = &g_array_index(pos->packet_index,
                                        struct packet_index, index);
                        pos->last_events_discarded = packet_index->events_discarded;
                        pos->cur_index = index;
@@ -810,7 +918,7 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                default:
                        assert(0);
                }
-               if (pos->cur_index >= pos->packet_real_index->len) {
+               if (pos->cur_index >= pos->packet_index->len) {
                        /*
                         * We need to check if we are in trace read or
                         * called from packet indexing.  In this last
@@ -836,23 +944,27 @@ void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence)
                        pos->offset = EOF;
                        return;
                }
-               packet_index = &g_array_index(pos->packet_cycles_index,
+               packet_index = &g_array_index(pos->packet_index,
                                struct packet_index,
                                pos->cur_index);
-               file_stream->parent.cycles_timestamp = packet_index->timestamp_begin;
+               file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin;
 
-               packet_index = &g_array_index(pos->packet_real_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.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;
@@ -1411,8 +1523,10 @@ begin:
        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.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;
 
@@ -1436,7 +1550,7 @@ begin:
                        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,
+                                               file_stream->pos.packet_index->len,
                                                (ssize_t) pos->mmap_offset);
                                return -EINVAL;
                        }
@@ -1528,12 +1642,12 @@ begin:
                        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);
+                       packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field);
                        if (file_stream->parent.stream_class->trace->parent.collection) {
-                               packet_index.timestamp_begin =
+                               packet_index.ts_real.timestamp_begin =
                                        ctf_get_real_timestamp(
                                                &file_stream->parent,
-                                               packet_index.timestamp_begin);
+                                               packet_index.ts_cycles.timestamp_begin);
                        }
                }
 
@@ -1543,12 +1657,12 @@ begin:
                        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);
+                       packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field);
                        if (file_stream->parent.stream_class->trace->parent.collection) {
-                               packet_index.timestamp_end =
+                               packet_index.ts_real.timestamp_end =
                                        ctf_get_real_timestamp(
                                                &file_stream->parent,
-                                               packet_index.timestamp_end);
+                                               packet_index.ts_cycles.timestamp_end);
                        }
                }
 
@@ -1595,7 +1709,7 @@ begin:
        packet_index.data_offset = pos->offset;
 
        /* add index to packet array */
-       g_array_append_val(file_stream->pos.packet_cycles_index, packet_index);
+       g_array_append_val(file_stream->pos.packet_index, packet_index);
 
        pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT;
 
@@ -1697,12 +1811,10 @@ 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;
@@ -1736,28 +1848,32 @@ int import_stream_packet_index(struct ctf_trace *td,
                goto error;
        }
 
-       while ((index_read = fread(&ctf_index, index_hdr.packet_index_len, 1,
-                                       pos->index_fp)) == 1) {
+       while (fread(&ctf_index, index_hdr.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.timestamp_begin = be64toh(ctf_index.timestamp_begin);
-               index.timestamp_end = be64toh(ctf_index.timestamp_end);
+               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_cycles_index, index);
+                       g_array_append_val(file_stream->pos.packet_index, index);
                        continue;
                }
 
                file_stream->parent.stream_id = stream_id;
-               stream = g_ptr_array_index(td->streams, 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",
@@ -1771,7 +1887,13 @@ int import_stream_packet_index(struct ctf_trace *td,
                        goto error;
                first_packet = 0;
                /* add index to packet array */
-               g_array_append_val(file_stream->pos.packet_cycles_index, index);
+               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;
@@ -2075,12 +2197,13 @@ 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
@@ -2206,6 +2329,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;
@@ -2243,25 +2367,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);
                        }
                }
        }
@@ -2278,10 +2397,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;
 }
@@ -2313,15 +2434,19 @@ 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;
+       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);
This page took 0.038795 seconds and 4 git commands to generate.