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_time {
  48         uint64_t timestamp_begin;
  49         uint64_t timestamp_end;
  50 };
  51
  52 struct packet_index {
  53         off_t offset;           /* offset of the packet in the file, in bytes */
  54         int64_t data_offset;    /* offset of data within the packet, in bits */
  55         uint64_t packet_size;   /* packet size, in bits */
  56         uint64_t content_size;  /* content size, in bits */
  57         uint64_t events_discarded;
  58         uint64_t events_discarded_len;  /* length of the field, in bits */
  59         struct packet_index_time ts_cycles;     /* timestamp in cycles */
  60         struct packet_index_time ts_real;       /* realtime timestamp */
  61         /* CTF_INDEX 1.0 limit */
  62         uint64_t stream_instance_id;    /* ID of the channel instance */
  63         uint64_t packet_seq_num;        /* packet sequence number */
  64 };
  65
  66 /*
  67  * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
  68  */
  69 struct ctf_stream_pos {
  70         struct bt_stream_pos parent;
  71         int fd;                 /* backing file fd. -1 if unset. */
  72         FILE *index_fp;         /* backing index file fp. NULL if unset. */
  73         GArray *packet_index;   /* contains struct packet_index */
  74         int prot;               /* mmap protection */
  75         int flags;              /* mmap flags */
  76
  77         /* Current position */
  78         off_t mmap_offset;      /* mmap offset in the file, in bytes */
  79         off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
  80         uint64_t packet_size;   /* current packet size, in bits */
  81         uint64_t content_size;  /* current content size, in bits */
  82         uint64_t *content_size_loc; /* pointer to current content size */
  83         struct mmap_align *base_mma;/* mmap base address */
  84         int64_t offset;         /* offset from base, in bits. EOF for end of file. */
  85         int64_t last_offset;    /* offset before the last read_event */
  86         int64_t data_offset;    /* offset of data in current packet */
  87         uint64_t cur_index;     /* current index in packet index */
  88         uint64_t last_events_discarded; /* last known amount of event discarded */
  89         void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
  90                         int whence); /* function called to switch packet */
  91
  92         int dummy;              /* dummy position, for length calculation */
  93         struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
  94         void *priv;
  95 };
  96
  97 static inline
  98 struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
  99 {
 100         return container_of(pos, struct ctf_stream_pos, parent);
 101 }
 102
 103 BT_HIDDEN
 104 int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 105 BT_HIDDEN
 106 int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 107 BT_HIDDEN
 108 int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 109 BT_HIDDEN
 110 int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 111 BT_HIDDEN
 112 int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 113 BT_HIDDEN
 114 int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 115 BT_HIDDEN
 116 int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 117 BT_HIDDEN
 118 int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 119 BT_HIDDEN
 120 int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
 121 BT_HIDDEN
 122 int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
 123 BT_HIDDEN
 124 int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 125 BT_HIDDEN
 126 int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 127 BT_HIDDEN
 128 int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
 129 BT_HIDDEN
 130 int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);
 131
 132 void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
 133
 134 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
 135                 int fd, int open_flags);
 136 int ctf_fini_pos(struct ctf_stream_pos *pos);
 137
 138 static inline
 139 int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
 140 {
 141         uint64_t max_len;
 142
 143         if (unlikely(pos->offset == EOF))
 144                 return 0;
 145         if (pos->prot == PROT_READ) {
 146                 /*
 147                  * Reads may only reach up to the "content_size",
 148                  * regardless of the packet_size.
 149                  */
 150                 max_len = pos->content_size;
 151         } else {
 152                 /* Writes may take place up to the end of the packet. */
 153                 max_len = pos->packet_size;
 154         }
 155         if (unlikely(pos->offset + bit_len > max_len))
 156                 return 0;
 157         return 1;
 158 }
 159
 160 /*
 161  * move_pos - move position of a relative bit offset
 162  *
 163  * Return 1 if OK, 0 if out-of-bound.
 164  *
 165  * TODO: allow larger files by updating base too.
 166  */
 167 static inline
 168 int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 169 {
 170         int ret = 0;
 171
 172         printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
 173         ret = ctf_pos_access_ok(pos, bit_offset);
 174         if (!ret) {
 175                 goto end;
 176         }
 177         pos->offset += bit_offset;
 178         printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
 179 end:
 180         return ret;
 181 }
 182
 183 /*
 184  * align_pos - align position on a bit offset (> 0)
 185  *
 186  * Return 1 if OK, 0 if out-of-bound.
 187  *
 188  * TODO: allow larger files by updating base too.
 189  */
 190 static inline
 191 int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
 192 {
 193         return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
 194 }
 195
 196 static inline
 197 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
 198 {
 199         /* Only makes sense to get the address after aligning on CHAR_BIT */
 200         assert(!(pos->offset % CHAR_BIT));
 201         return mmap_align_addr(pos->base_mma) +
 202                 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
 203 }
 204
 205 static inline
 206 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
 207 {
 208         memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
 209         dummy->dummy = 1;
 210         dummy->fd = -1;
 211 }
 212
 213 /*
 214  * Check if current packet can hold data.
 215  * Returns 0 for success, negative error otherwise.
 216  */
 217 static inline
 218 int ctf_pos_packet(struct ctf_stream_pos *dummy)
 219 {
 220         if (unlikely(dummy->offset > dummy->packet_size))
 221                 return -ENOSPC;
 222         return 0;
 223 }
 224
 225 static inline
 226 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
 227 {
 228         ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
 229 }
 230
 231 /*
 232  * Update the stream position to the current event. This moves to
 233  * the next packet if we are located at the end of the current packet.
 234  */
 235 static inline
 236 void ctf_pos_get_event(struct ctf_stream_pos *pos)
 237 {
 238         assert(pos->offset <= pos->content_size);
 239         if (pos->offset == pos->content_size) {
 240                 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
 241                              pos->offset);
 242                 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
 243                 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
 244                              pos->offset);
 245         }
 246 }
 247
 248 void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
 249                         uint64_t timestamp);
 250 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
 251                         FILE *metadata_fp);
 252 void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream);
 253
 254 #endif /* _BABELTRACE_CTF_TYPES_H */