Fix: Don't assume that PROT_WRITE grants read permissions

[babeltrace.git] / include / babeltrace / ctf / types.h

diff --git a/include/babeltrace/ctf/types.h b/include/babeltrace/ctf/types.h
index 96c5083c2b7d5eea1e0154aa5954073353017139..c336632f7e6eb34b93190ae5e4d71c5f1a12d994 100644 (file)
--- a/include/babeltrace/ctf/types.h
+++ b/include/babeltrace/ctf/types.h
@@ -44,15 +44,20 @@
 
 struct bt_stream_callbacks;
 
+struct packet_index_time {
+       uint64_t timestamp_begin;
+       uint64_t timestamp_end;
+};
+
 struct packet_index {
        off_t offset;           /* offset of the packet in the file, in bytes */
        int64_t data_offset;    /* offset of data within the packet, in bits */
        uint64_t packet_size;   /* packet size, in bits */
        uint64_t content_size;  /* content size, in bits */
-       uint64_t timestamp_begin;
-       uint64_t timestamp_end;
        uint64_t events_discarded;
        uint64_t events_discarded_len;  /* length of the field, in bits */
+       struct packet_index_time ts_cycles;     /* timestamp in cycles */
+       struct packet_index_time ts_real;       /* realtime timestamp */
 };
 
 /*
@@ -61,8 +66,8 @@ struct packet_index {
 struct ctf_stream_pos {
        struct bt_stream_pos parent;
        int fd;                 /* backing file fd. -1 if unset. */
-       GArray *packet_cycles_index;    /* contains struct packet_index in cycles */
-       GArray *packet_real_index;      /* contains struct packet_index in ns */
+       FILE *index_fp;         /* backing index file fp. NULL if unset. */
+       GArray *packet_index;   /* contains struct packet_index */
        int prot;               /* mmap protection */
        int flags;              /* mmap flags */
 
@@ -75,6 +80,7 @@ struct ctf_stream_pos {
        struct mmap_align *base_mma;/* mmap base address */
        int64_t offset;         /* offset from base, in bits. EOF for end of file. */
        int64_t last_offset;    /* offset before the last read_event */
+       int64_t data_offset;    /* offset of data in current packet */
        uint64_t cur_index;     /* current index in packet index */
        uint64_t last_events_discarded; /* last known amount of event discarded */
        void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
@@ -82,6 +88,7 @@ struct ctf_stream_pos {
 
        int dummy;              /* dummy position, for length calculation */
        struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
+       void *priv;
 };
 
 static inline
@@ -125,31 +132,62 @@ int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
                int fd, int open_flags);
 int ctf_fini_pos(struct ctf_stream_pos *pos);
 
+static inline
+int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
+{
+       uint64_t max_len;
+
+       if (unlikely(pos->offset == EOF))
+               return 0;
+       if (pos->prot == PROT_READ) {
+               /*
+                * Reads may only reach up to the "content_size",
+                * regardless of the packet_size.
+                */
+               max_len = pos->content_size;
+       } else {
+               /* Writes may take place up to the end of the packet. */
+               max_len = pos->packet_size;
+       }
+       if (unlikely(pos->offset + bit_len > max_len))
+               return 0;
+       return 1;
+}
+
 /*
  * move_pos - move position of a relative bit offset
  *
+ * Return 1 if OK, 0 if out-of-bound.
+ *
  * TODO: allow larger files by updating base too.
  */
 static inline
-void ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
+int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 {
-       printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
-       if (unlikely(pos->offset == EOF))
-               return;
+       int ret = 0;
 
+       printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
+       ret = ctf_pos_access_ok(pos, bit_offset);
+       if (!ret) {
+               goto end;
+       }
        pos->offset += bit_offset;
        printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
+end:
+       return ret;
 }
 
 /*
  * align_pos - align position on a bit offset (> 0)
  *
+ * Return 1 if OK, 0 if out-of-bound.
+ *
  * TODO: allow larger files by updating base too.
  */
 static inline
-void ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
+int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 {
-       ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
+       return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
 }
 
 static inline
@@ -187,18 +225,8 @@ void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
        ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
 }
 
-static inline
-int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
-{
-       if (unlikely(pos->offset == EOF))
-               return 0;
-       if (unlikely(pos->offset + bit_len > pos->packet_size))
-               return 0;
-       return 1;
-}
-
 /*
- * Update the stream position for to the current event. This moves to
+ * Update the stream position to the current event. This moves to
  * the next packet if we are located at the end of the current packet.
  */
 static inline
@@ -216,5 +244,7 @@ void ctf_pos_get_event(struct ctf_stream_pos *pos)
 
 void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
                        uint64_t timestamp);
+int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
+                       FILE *metadata_fp);
 
 #endif /* _BABELTRACE_CTF_TYPES_H */