include/babeltrace/ctf/types.h

   1 #ifndef _BABELTRACE_CTF_TYPES_H
   2 #define _BABELTRACE_CTF_TYPES_H
   3
   4 /*
   5  * Common Trace Format
   6  *
   7  * Type header
   8  *
   9  * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/types.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #include <fcntl.h>
  35 #include <errno.h>
  36 #include <stdint.h>
  37 #include <unistd.h>
  38 #include <glib.h>
  39 #include <stdio.h>
  40 #include <inttypes.h>
  41 #include <babeltrace/mmap-align.h>
  42
  43 #define LAST_OFFSET_POISON      ((int64_t) ~0ULL)
  44
  45 struct bt_stream_callbacks;
  46
  47 struct packet_index {
  48         off_t offset;           /* offset of the packet in the file, in bytes */
  49         int64_t data_offset;    /* offset of data within the packet, in bits */
  50         uint64_t packet_size;   /* packet size, in bits */
  51         uint64_t content_size;  /* content size, in bits */
  52         uint64_t timestamp_begin;
  53         uint64_t timestamp_end;
  54         uint64_t events_discarded;
  55         uint64_t events_discarded_len;  /* length of the field, in bits */
  56 };
  57
  58 /*
  59  * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
  60  */
  61 struct ctf_stream_pos {
  62         struct bt_stream_pos parent;
  63         int fd;                 /* backing file fd. -1 if unset. */
  64         FILE *index_fp;         /* backing index file fp. NULL if unset. */
  65         GArray *packet_cycles_index;    /* contains struct packet_index in cycles */
  66         GArray *packet_real_index;      /* contains struct packet_index in ns */
  67         int prot;               /* mmap protection */
  68         int flags;              /* mmap flags */
  69
  70         /* Current position */
  71         off_t mmap_offset;      /* mmap offset in the file, in bytes */
  72         off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
  73         uint64_t packet_size;   /* current packet size, in bits */
  74         uint64_t content_size;  /* current content size, in bits */
  75         uint64_t *content_size_loc; /* pointer to current content size */
  76         struct mmap_align *base_mma;/* mmap base address */
  77         int64_t offset;         /* offset from base, in bits. EOF for end of file. */
  78         int64_t last_offset;    /* offset before the last read_event */
  79         uint64_t cur_index;     /* current index in packet index */
  80         uint64_t last_events_discarded; /* last known amount of event discarded */
  81         void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
  82                         int whence); /* function called to switch packet */
  83
  84         int dummy;              /* dummy position, for length calculation */
  85         struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
  86         void *priv;
  87 };
  88
  89 static inline
  90 struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
  91 {
  92         return container_of(pos, struct ctf_stream_pos, parent);
  93 }
  94
  95 BT_HIDDEN
  96 int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
  97 BT_HIDDEN
  98 int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
  99 BT_HIDDEN
 100 int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 101 BT_HIDDEN
 102 int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 103 BT_HIDDEN
 104 int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 105 BT_HIDDEN
 106 int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 107 BT_HIDDEN
 108 int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 109 BT_HIDDEN
 110 int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 111 BT_HIDDEN
 112 int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
 113 BT_HIDDEN
 114 int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
 115 BT_HIDDEN
 116 int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 117 BT_HIDDEN
 118 int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 119 BT_HIDDEN
 120 int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 121 BT_HIDDEN
 122 int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 123
 124 void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
 125
 126 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
 127                 int fd, int open_flags);
 128 int ctf_fini_pos(struct ctf_stream_pos *pos);
 129
 130 /*
 131  * move_pos - move position of a relative bit offset
 132  *
 133  * Return 1 if OK, 0 if out-of-bound.
 134  *
 135  * TODO: allow larger files by updating base too.
 136  */
 137 static inline
 138 int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 139 {
 140         uint64_t max_len;
 141
 142         printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
 143         if (unlikely(pos->offset == EOF))
 144                 return 0;
 145         if (pos->prot == PROT_READ)
 146                 max_len = pos->content_size;
 147         else
 148                 max_len = pos->packet_size;
 149         if (unlikely(pos->offset + bit_offset > max_len))
 150                 return 0;
 151
 152         pos->offset += bit_offset;
 153         printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
 154         return 1;
 155 }
 156
 157 /*
 158  * align_pos - align position on a bit offset (> 0)
 159  *
 160  * Return 1 if OK, 0 if out-of-bound.
 161  *
 162  * TODO: allow larger files by updating base too.
 163  */
 164 static inline
 165 int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 166 {
 167         return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
 168 }
 169
 170 static inline
 171 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
 172 {
 173         /* Only makes sense to get the address after aligning on CHAR_BIT */
 174         assert(!(pos->offset % CHAR_BIT));
 175         return mmap_align_addr(pos->base_mma) +
 176                 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
 177 }
 178
 179 static inline
 180 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
 181 {
 182         memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
 183         dummy->dummy = 1;
 184         dummy->fd = -1;
 185 }
 186
 187 /*
 188  * Check if current packet can hold data.
 189  * Returns 0 for success, negative error otherwise.
 190  */
 191 static inline
 192 int ctf_pos_packet(struct ctf_stream_pos *dummy)
 193 {
 194         if (unlikely(dummy->offset > dummy->packet_size))
 195                 return -ENOSPC;
 196         return 0;
 197 }
 198
 199 static inline
 200 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
 201 {
 202         ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
 203 }
 204
 205 static inline
 206 int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
 207 {
 208         uint64_t max_len;
 209
 210         if (unlikely(pos->offset == EOF))
 211                 return 0;
 212         if (pos->prot == PROT_READ)
 213                 max_len = pos->content_size;
 214         else
 215                 max_len = pos->packet_size;
 216         if (unlikely(pos->offset + bit_len > max_len))
 217                 return 0;
 218         return 1;
 219 }
 220
 221 /*
 222  * Update the stream position to the current event. This moves to
 223  * the next packet if we are located at the end of the current packet.
 224  */
 225 static inline
 226 void ctf_pos_get_event(struct ctf_stream_pos *pos)
 227 {
 228         assert(pos->offset <= pos->content_size);
 229         if (pos->offset == pos->content_size) {
 230                 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
 231                              pos->offset);
 232                 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
 233                 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
 234                              pos->offset);
 235         }
 236 }
 237
 238 void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
 239                         uint64_t timestamp);
 240
 241 #endif /* _BABELTRACE_CTF_TYPES_H */