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         GArray *packet_cycles_index;    /* contains struct packet_index in cycles */
  65         GArray *packet_real_index;      /* contains struct packet_index in ns */
  66         int prot;               /* mmap protection */
  67         int flags;              /* mmap flags */
  68
  69         /* Current position */
  70         off_t mmap_offset;      /* mmap offset in the file, in bytes */
  71         off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
  72         uint64_t packet_size;   /* current packet size, in bits */
  73         uint64_t content_size;  /* current content size, in bits */
  74         uint64_t *content_size_loc; /* pointer to current content size */
  75         struct mmap_align *base_mma;/* mmap base address */
  76         int64_t offset;         /* offset from base, in bits. EOF for end of file. */
  77         int64_t last_offset;    /* offset before the last read_event */
  78         uint64_t cur_index;     /* current index in packet index */
  79         uint64_t last_events_discarded; /* last known amount of event discarded */
  80         void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
  81                         int whence); /* function called to switch packet */
  82
  83         int dummy;              /* dummy position, for length calculation */
  84         struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
  85 };
  86
  87 static inline
  88 struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
  89 {
  90         return container_of(pos, struct ctf_stream_pos, parent);
  91 }
  92
  93 BT_HIDDEN
  94 int ctf_integer_read(struct bt_stream_pos *pos, struct definition *definition);
  95 BT_HIDDEN
  96 int ctf_integer_write(struct bt_stream_pos *pos, struct definition *definition);
  97 BT_HIDDEN
  98 int ctf_float_read(struct bt_stream_pos *pos, struct definition *definition);
  99 BT_HIDDEN
 100 int ctf_float_write(struct bt_stream_pos *pos, struct definition *definition);
 101 BT_HIDDEN
 102 int ctf_string_read(struct bt_stream_pos *pos, struct definition *definition);
 103 BT_HIDDEN
 104 int ctf_string_write(struct bt_stream_pos *pos, struct definition *definition);
 105 BT_HIDDEN
 106 int ctf_enum_read(struct bt_stream_pos *pos, struct definition *definition);
 107 BT_HIDDEN
 108 int ctf_enum_write(struct bt_stream_pos *pos, struct definition *definition);
 109 BT_HIDDEN
 110 int ctf_struct_rw(struct bt_stream_pos *pos, struct definition *definition);
 111 BT_HIDDEN
 112 int ctf_variant_rw(struct bt_stream_pos *pos, struct definition *definition);
 113 BT_HIDDEN
 114 int ctf_array_read(struct bt_stream_pos *pos, struct definition *definition);
 115 BT_HIDDEN
 116 int ctf_array_write(struct bt_stream_pos *pos, struct definition *definition);
 117 BT_HIDDEN
 118 int ctf_sequence_read(struct bt_stream_pos *pos, struct definition *definition);
 119 BT_HIDDEN
 120 int ctf_sequence_write(struct bt_stream_pos *pos, struct definition *definition);
 121
 122 void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
 123
 124 int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags);
 125 int ctf_fini_pos(struct ctf_stream_pos *pos);
 126
 127 /*
 128  * move_pos - move position of a relative bit offset
 129  *
 130  * TODO: allow larger files by updating base too.
 131  */
 132 static inline
 133 void ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 134 {
 135         printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
 136         if (unlikely(pos->offset == EOF))
 137                 return;
 138
 139         if (pos->fd >= 0) {
 140                 /*
 141                  * PROT_READ ctf_packet_seek is called from within
 142                  * ctf_pos_get_event so end of packet does not change
 143                  * the packet context on for the last event of the
 144                  * packet.
 145                  */
 146                 if ((pos->prot == PROT_WRITE)
 147                         && (unlikely(pos->offset + bit_offset >= pos->packet_size))) {
 148                         printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
 149                                      pos->offset);
 150                         ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
 151                         printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
 152                                      pos->offset);
 153                         return;
 154                 }
 155         }
 156         pos->offset += bit_offset;
 157         printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
 158 }
 159
 160 /*
 161  * align_pos - align position on a bit offset (> 0)
 162  *
 163  * TODO: allow larger files by updating base too.
 164  */
 165 static inline
 166 void ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 167 {
 168         ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
 169 }
 170
 171 static inline
 172 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
 173 {
 174         /* Only makes sense to get the address after aligning on CHAR_BIT */
 175         assert(!(pos->offset % CHAR_BIT));
 176         return mmap_align_addr(pos->base_mma) +
 177                 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
 178 }
 179
 180 static inline
 181 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
 182 {
 183         memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
 184         dummy->dummy = 1;
 185         dummy->fd = -1;
 186 }
 187
 188 /*
 189  * Check if current packet can hold data.
 190  * Returns 0 for success, negative error otherwise.
 191  */
 192 static inline
 193 int ctf_pos_packet(struct ctf_stream_pos *dummy)
 194 {
 195         if (unlikely(dummy->offset > dummy->packet_size))
 196                 return -ENOSPC;
 197         return 0;
 198 }
 199
 200 static inline
 201 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
 202 {
 203         ctf_move_pos(pos, pos->packet_size - pos->offset);
 204 }
 205
 206 static inline
 207 int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
 208 {
 209         if (unlikely(pos->offset == EOF))
 210                 return 0;
 211         if (unlikely(pos->offset + bit_len > pos->packet_size))
 212                 return 0;
 213         return 1;
 214 }
 215
 216 /*
 217  * Update the stream position for to the current event. This moves to
 218  * the next packet if we are located at the end of the current packet.
 219  */
 220 static inline
 221 void ctf_pos_get_event(struct ctf_stream_pos *pos)
 222 {
 223         assert(pos->offset <= pos->content_size);
 224         if (pos->offset == pos->content_size) {
 225                 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
 226                              pos->offset);
 227                 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
 228                 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
 229                              pos->offset);
 230         }
 231 }
 232
 233 void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
 234                         uint64_t timestamp);
 235
 236 #endif /* _BABELTRACE_CTF_TYPES_H */