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 <stdint.h>
  24 #include <glib.h>
  25
  26 /*
  27  * Always update stream_pos with move_pos and init_pos.
  28  */
  29 struct stream_pos {
  30         char *base;             /* Base address */
  31         size_t offset;          /* Offset from base, in bits */
  32         int dummy;              /* Dummy position, for length calculation */
  33 };
  34
  35 static inline
  36 void init_pos(struct stream_pos *pos, char *base)
  37 {
  38         pos->base = base;       /* initial base, page-aligned */
  39         pos->offset = 0;
  40         pos->dummy = false;
  41 }
  42
  43 /*
  44  * move_pos - move position of a relative bit offset
  45  *
  46  * TODO: allow larger files by updating base too.
  47  */
  48 static inline
  49 void move_pos(struct stream_pos *pos, size_t offset)
  50 {
  51         pos->offset = pos->offset + offset;
  52 }
  53
  54 /*
  55  * align_pos - align position on a bit offset (> 0)
  56  *
  57  * TODO: allow larger files by updating base too.
  58  */
  59 static inline
  60 void align_pos(struct stream_pos *pos, size_t offset)
  61 {
  62         pos->offset += offset_align(pos->offset, offset);
  63 }
  64
  65 static inline
  66 void copy_pos(struct stream_pos *dest, struct stream_pos *src)
  67 {
  68         memcpy(dest, src, sizeof(struct stream_pos));
  69 }
  70
  71 static inline
  72 char *get_pos_addr(struct stream_pos *pos)
  73 {
  74         /* Only makes sense to get the address after aligning on CHAR_BIT */
  75         assert(!(pos->offset % CHAR_BIT));
  76         return pos->base + (pos->offset / CHAR_BIT);
  77 }
  78
  79 /*
  80  * IMPORTANT: All lengths (len) and offsets (start, end) are expressed in bits,
  81  *            *not* in bytes.
  82  *
  83  * All write primitives, as well as read for dynamically sized entities, can
  84  * receive a NULL ptr/dest parameter. In this case, no write is performed, but
  85  * the size is returned.
  86  */
  87
  88 uint64_t ctf_uint_read(struct stream_pos *pos,
  89                 const struct declaration_integer *integer_declaration);
  90 int64_t ctf_int_read(struct stream_pos *pos,
  91                 const struct declaration_integer *integer_declaration);
  92 void ctf_uint_write(struct stream_pos *pos,
  93                 const struct declaration_integer *integer_declaration,
  94                 uint64_t v);
  95 void ctf_int_write(struct stream_pos *pos,
  96                 const struct declaration_integer *integer_declaration,
  97                 int64_t v);
  98
  99 double ctf_double_read(struct stream_pos *pos,
 100                         const struct declaration_float *src);
 101 void ctf_double_write(struct stream_pos *pos,
 102                 const struct declaration_float *dest,
 103                 double v);
 104 long double ctf_ldouble_read(struct stream_pos *pos,
 105                              const struct declaration_float *src);
 106 void ctf_ldouble_write(struct stream_pos *pos,
 107                 const struct declaration_float *dest,
 108                 long double v);
 109 void ctf_float_copy(struct stream_pos *destp,
 110                 struct stream_pos *srcp,
 111                 const struct declaration_float *float_declaration);
 112
 113 void ctf_string_copy(struct stream_pos *dest, struct stream_pos *src,
 114                 const struct declaration_string *string_declaration);
 115 void ctf_string_read(char **dest, struct stream_pos *src,
 116                 const struct declaration_string *string_declaration);
 117 void ctf_string_write(struct stream_pos *dest, const char *src,
 118                 const struct declaration_string *string_declaration);
 119 void ctf_string_free_temp(char *string);
 120
 121 GArray *ctf_enum_read(struct stream_pos *pos,
 122                 const struct declaration_enum *src);
 123 void ctf_enum_write(struct stream_pos *pos,
 124                 const struct declaration_enum *dest,
 125                 GQuark q);
 126 void ctf_struct_begin(struct stream_pos *pos,
 127                 const struct declaration_struct *struct_declaration);
 128 void ctf_struct_end(struct stream_pos *pos,
 129                 const struct declaration_struct *struct_declaration);
 130 void ctf_variant_begin(struct stream_pos *pos,
 131                 const struct declaration_variant *variant_declaration);
 132 void ctf_variant_end(struct stream_pos *pos,
 133                 const struct declaration_variant *variant_declaration);
 134 void ctf_array_begin(struct stream_pos *pos,
 135                 const struct declaration_array *array_declaration);
 136 void ctf_array_end(struct stream_pos *pos,
 137                 const struct declaration_array *array_declaration);
 138 void ctf_sequence_begin(struct stream_pos *pos,
 139                 const struct declaration_sequence *sequence_declaration);
 140 void ctf_sequence_end(struct stream_pos *pos,
 141                 const struct declaration_sequence *sequence_declaration);
 142
 143 #endif /* _BABELTRACE_CTF_TYPES_H */