API cleanups, offset by bit.
[babeltrace.git] / include / babeltrace / types.h
index ed3e7aca60fa8caba4085a12336f378d4e4afc76..862624084371ecfcf1d1692f7fe10762136ed5b5 100644 (file)
  */
 
 #include <babeltrace/format.h>
+#include <babeltrace/align.h>
+#include <string.h>
+
+/*
+ * Always update stream_pos with move_pos and init_pos.
+ */
+struct stream_pos {
+       unsigned char *base;    /* Base address */
+       size_t offset;          /* Offset from base, in bits */
+       int dummy;              /* Dummy position, for length calculation */
+};
+
+static inline
+void init_pos(struct stream_pos *pos, unsigned char *base)
+{
+       pos->base = base;       /* initial base, page-aligned */
+       pos->offset = 0;
+       pos->dummy = false;
+}
+
+/*
+ * move_pos - move position of a relative bit offset
+ *
+ * TODO: allow larger files by updating base too.
+ */
+static inline
+void move_pos(struct stream_pos *pos, size_t offset)
+{
+       pos->offset = pos->offset + offset;
+}
+
+/*
+ * align_pos - align position on a bit offset (> 0)
+ *
+ * TODO: allow larger files by updating base too.
+ */
+static inline
+void align_pos(struct stream_pos *pos, size_t offset)
+{
+       pos->offset += offset_align(pos->offset, offset);
+}
+
+static inline
+void copy_pos(struct stream_pos *dest, struct stream_pos *src)
+{
+       memcpy(dest, src, sizeof(struct stream_pos));
+}
+
+static inline
+unsigned char *get_pos_addr(struct stream_pos *pos)
+{
+       /* Only makes sense to get the address after aligning on CHAR_BIT */
+       assert(!(pos->alignment % CHAR_BIT));
+       return pos->base + (pos->offset / CHAR_BIT);
+}
 
 struct type_class {
        GQuark name;            /* type name */
@@ -32,9 +87,10 @@ struct type_class {
         * Type copy function. Knows how to find the child type_class from the
         * parent type_class.
         */
-       size_t (*copy)(unsigned char *dest, const struct format *fdest, 
-                      const unsigned char *src, const struct format *fsrc,
+       size_t (*copy)(struct stream_pos *dest, const struct format *fdest, 
+                      struct stream_pos *src, const struct format *fsrc,
                       const struct type_class *type_class);
+       void (*free)(struct type_class *type_class);
 };
 
 struct type_class_integer {
@@ -44,27 +100,35 @@ struct type_class_integer {
        int signedness;
 };
 
-int integer_type_new(const char *name, size_t len, int byte_order,
-                    int signedness);
-
+/*
+ * Because we address in bits, bitfields end up being exactly the same as
+ * integers, except that their read/write functions must be able to deal with
+ * read/write non aligned on CHAR_BIT.
+ */
 struct type_class_bitfield {
        struct type_class_integer p;
-       size_t start_offset;    /* offset from base address, in bits */
 };
 
-int bitfield_type_new(const char *name, size_t start_offset,
-                     size_t len, int byte_order, int signedness);
-
 struct type_class_float {
        struct type_class p;
-       size_t mantissa_len;
-       size_t exp_len;
+       struct bitfield_class *mantissa;
+       struct bitfield_class *exp;
        int byte_order;
+       /* TODO: we might want to express more info about NaN, +inf and -inf */
+};
+
+struct enum_table {
+       GHashTable *value_to_quark;     /* Tuples (value, GQuark) */
+       GHashTable *quark_to_value;     /* Tuples (GQuark, value) */
 };
 
 struct type_class_enum {
-       struct type_class_bitfield;     /* inherit from bitfield */
-       struct enum_table *table;
+       struct type_class_bitfield p;   /* inherit from bitfield */
+       struct enum_table table;
+};
+
+struct type_class_string {
+       struct type_class p;
 };
 
 struct type_class_struct {
@@ -75,4 +139,46 @@ struct type_class_struct {
 struct type_class *ctf_lookup_type(GQuark qname);
 int ctf_register_type(struct type_class *type_class);
 
+/* Nameless types can be created by passing a NULL name */
+
+struct type_class_integer *integer_type_new(const char *name,
+                                           size_t start_offset,
+                                           size_t len, int byte_order,
+                                           int signedness);
+void integer_type_free(struct type_class_integer *int_class);
+
+struct type_class_bitfield *bitfield_type_new(const char *name,
+                                             size_t start_offset,
+                                             size_t len, int byte_order,
+                                             int signedness);
+void bitfield_type_free(struct type_class_bitfield *bitfield_class);
+
+struct type_class_float *float_type_new(const char *name,
+                                       size_t mantissa_len,
+                                       size_t exp_len, int byte_order,
+                                       size_t alignment);
+void float_type_free(struct type_class_float *float_class);
+
+/*
+ * A GQuark can be translated to/from strings with g_quark_from_string() and
+ * g_quark_to_string().
+ */
+GQuark enum_uint_to_quark(const struct type_class_enum *enum_class, uint64_t v);
+GQuark enum_int_to_quark(const struct type_class_enum *enum_class, uint64_t v);
+uint64_t enum_quark_to_uint(const struct type_class_enum *enum_class,
+                           size_t len, int byte_order, GQuark q);
+int64_t enum_quark_to_int(const struct type_class_enum *enum_class,
+                         size_t len, int byte_order, GQuark q);
+void enum_signed_insert(struct type_class_enum *enum_class,
+                       int64_t v, GQuark q);
+void enum_unsigned_insert(struct type_class_enum *enum_class,
+                         uint64_t v, GQuark q);
+
+struct type_class_enum *enum_type_new(const char *name,
+                                     size_t start_offset,
+                                     size_t len, int byte_order,
+                                     int signedness,
+                                     size_t alignment);
+void enum_type_free(struct type_class_enum *enum_class);
+
 #endif /* _BABELTRACE_TYPES_H */
This page took 0.025968 seconds and 4 git commands to generate.