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
  22 #include <babeltrace/types.h>
  23 #include <babeltrace/babeltrace.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <sys/mman.h>
  28 #include <errno.h>
  29 #include <stdint.h>
  30 #include <unistd.h>
  31 #include <glib.h>
  32 #include <stdio.h>
  33
  34 struct packet_index {
  35         off_t offset;           /* offset of the packet in the file, in bytes */
  36         off_t data_offset;      /* offset of data within the packet, in bits */
  37         size_t packet_size;     /* packet size, in bits */
  38         size_t content_size;    /* content size, in bits */
  39         uint64_t timestamp_begin;
  40         uint64_t timestamp_end;
  41 };
  42
  43 /*
  44  * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
  45  */
  46 struct ctf_stream_pos {
  47         struct stream_pos parent;
  48         int fd;                 /* backing file fd. -1 if unset. */
  49         GArray *packet_index;   /* contains struct packet_index */
  50         int prot;               /* mmap protection */
  51         int flags;              /* mmap flags */
  52
  53         /* Current position */
  54         off_t mmap_offset;      /* mmap offset in the file, in bytes */
  55         size_t packet_size;     /* current packet size, in bits */
  56         size_t content_size;    /* current content size, in bits */
  57         uint32_t *content_size_loc; /* pointer to current content size */
  58         char *base;             /* mmap base address */
  59         ssize_t offset;         /* offset from base, in bits. EOF for end of file. */
  60         size_t cur_index;       /* current index in packet index */
  61
  62         int dummy;              /* dummy position, for length calculation */
  63 };
  64
  65 static inline
  66 struct ctf_stream_pos *ctf_pos(struct stream_pos *pos)
  67 {
  68         return container_of(pos, struct ctf_stream_pos, parent);
  69 }
  70
  71 int ctf_integer_read(struct stream_pos *pos, struct definition *definition);
  72 int ctf_integer_write(struct stream_pos *pos, struct definition *definition);
  73 int ctf_float_read(struct stream_pos *pos, struct definition *definition);
  74 int ctf_float_write(struct stream_pos *pos, struct definition *definition);
  75 int ctf_string_read(struct stream_pos *pos, struct definition *definition);
  76 int ctf_string_write(struct stream_pos *pos, struct definition *definition);
  77 int ctf_enum_read(struct stream_pos *pos, struct definition *definition);
  78 int ctf_enum_write(struct stream_pos *pos, struct definition *definition);
  79 int ctf_struct_rw(struct stream_pos *pos, struct definition *definition);
  80 int ctf_variant_rw(struct stream_pos *pos, struct definition *definition);
  81 int ctf_array_read(struct stream_pos *pos, struct definition *definition);
  82 int ctf_array_write(struct stream_pos *pos, struct definition *definition);
  83 int ctf_sequence_read(struct stream_pos *pos, struct definition *definition);
  84 int ctf_sequence_write(struct stream_pos *pos, struct definition *definition);
  85
  86 void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence);
  87
  88 void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags);
  89 void ctf_fini_pos(struct ctf_stream_pos *pos);
  90
  91 /*
  92  * move_pos - move position of a relative bit offset
  93  *
  94  * TODO: allow larger files by updating base too.
  95  */
  96 static inline
  97 void ctf_move_pos(struct ctf_stream_pos *pos, size_t bit_offset)
  98 {
  99         printf_debug("ctf_move_pos test EOF: %zd\n", pos->offset);
 100         if (pos->offset == EOF)
 101                 return;
 102
 103         if (pos->fd >= 0) {
 104                 if (((pos->prot == PROT_READ)
 105                       && (pos->offset + bit_offset >= pos->content_size))
 106                     || ((pos->prot == PROT_WRITE)
 107                       && (pos->offset + bit_offset >= pos->packet_size))) {
 108                         printf_debug("ctf_move_pos_slow (before call): %zd\n",
 109                                      pos->offset);
 110                         ctf_move_pos_slow(pos, bit_offset, SEEK_CUR);
 111                         printf_debug("ctf_move_pos_slow (after call): %zd\n",
 112                                      pos->offset);
 113                         return;
 114                 }
 115         }
 116         pos->offset += bit_offset;
 117         printf_debug("ctf_move_pos after increment: %zd\n", pos->offset);
 118 }
 119
 120 /*
 121  * align_pos - align position on a bit offset (> 0)
 122  *
 123  * TODO: allow larger files by updating base too.
 124  */
 125 static inline
 126 void ctf_align_pos(struct ctf_stream_pos *pos, size_t bit_offset)
 127 {
 128         ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
 129 }
 130
 131 static inline
 132 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
 133 {
 134         /* Only makes sense to get the address after aligning on CHAR_BIT */
 135         assert(!(pos->offset % CHAR_BIT));
 136         return pos->base + (pos->offset / CHAR_BIT);
 137 }
 138
 139 static inline
 140 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
 141 {
 142         memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
 143         dummy->dummy = 1;
 144         dummy->fd = -1;
 145 }
 146
 147 /*
 148  * Check if current packet can hold data.
 149  * Returns 0 for success, negative error otherwise.
 150  */
 151 static inline
 152 int ctf_pos_packet(struct ctf_stream_pos *dummy)
 153 {
 154         if (dummy->offset > dummy->packet_size)
 155                 return -ENOSPC;
 156         return 0;
 157 }
 158
 159 static inline
 160 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
 161 {
 162         ctf_move_pos(pos, pos->packet_size - pos->offset);
 163 }
 164
 165 static inline
 166 int ctf_pos_access_ok(struct ctf_stream_pos *pos, size_t bit_len)
 167 {
 168         if (pos->offset == EOF)
 169                 return 0;
 170         if (pos->offset + bit_len > pos->packet_size)
 171                 return 0;
 172         return 1;
 173 }
 174
 175 #endif /* _BABELTRACE_CTF_TYPES_H */