move struct ctf_stream -> struct ctf_stream_class
[babeltrace.git] / include / babeltrace / types.h
index 885a6a1b85c07ff1195e85b051606b8d6e5fb87f..fa543bf2ddaed57323aea6d4331ce2ce7586e477 100644 (file)
 /* Preallocate this many fields for structures */
 #define DEFAULT_NR_STRUCT_FIELDS 8
 
-/*
- * Always update stream_pos with move_pos and init_pos.
- */
-struct stream_pos {
-       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, 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
-char *get_pos_addr(struct stream_pos *pos)
-{
-       /* Only makes sense to get the address after aligning on CHAR_BIT */
-       assert(!(pos->offset % CHAR_BIT));
-       return pos->base + (pos->offset / CHAR_BIT);
-}
-
+struct ctf_stream_class;
+struct stream_pos;
 struct format;
 struct definition;
 
 /* type scope */
 struct declaration_scope {
        /* Hash table mapping type name GQuark to "struct declaration" */
+       /* Used for both typedef and typealias. */
        GHashTable *typedef_declarations;
        /* Hash table mapping struct name GQuark to "struct declaration_struct" */
        GHashTable *struct_declarations;
@@ -107,8 +57,11 @@ struct definition_scope {
        struct definition_scope *parent_scope;
        /*
         * Complete "path" leading to this definition scope.
-        * Includes trace/stream/event '.' field name '.' field name '.' ....
+        * Includes dynamic scope name '.' field name '.' field name '.' ....
         * Array of GQuark elements (which are each separated by dots).
+        * The dynamic scope name can contain dots, and is encoded into
+        * a single GQuark. Thus, scope_path[0] returns the GQuark
+        * identifying the dynamic scope.
         */
        GArray *scope_path;     /* array of GQuark */
 };
@@ -120,6 +73,7 @@ enum ctf_type_id {
        CTF_TYPE_ENUM,
        CTF_TYPE_STRING,
        CTF_TYPE_STRUCT,
+       CTF_TYPE_UNTAGGED_VARIANT,
        CTF_TYPE_VARIANT,
        CTF_TYPE_ARRAY,
        CTF_TYPE_SEQUENCE,
@@ -128,7 +82,6 @@ enum ctf_type_id {
 
 struct declaration {
        enum ctf_type_id id;
-       GQuark name;            /* type name */
        size_t alignment;       /* type alignment, in bits */
        int ref;                /* number of references to the type */
        /*
@@ -143,21 +96,38 @@ struct declaration {
         * definition_free called with definition ref is decremented to 0.
         */
        void (*definition_free)(struct definition *definition);
-       /*
-        * Definition copy function. Knows how to find the child
-        * definition from the parent definition.
-        */
-       void (*copy)(struct stream_pos *dest, const struct format *fdest, 
-                    struct stream_pos *src, const struct format *fsrc,
-                    struct definition *definition);
 };
 
 struct definition {
        struct declaration *declaration;
        int index;              /* Position of the definition in its container */
+       GQuark name;            /* Field name in its container (or 0 if unset) */
        int ref;                /* number of references to the definition */
+       GQuark path;
 };
 
+typedef int (*rw_dispatch)(struct stream_pos *pos,
+                          struct definition *definition);
+
+/* Parent of per-plugin positions */
+struct stream_pos {
+       /* read/write dispatch table. Specific to plugin used for stream. */
+       rw_dispatch *rw_table;  /* rw dispatch table */
+       int (*event_cb)(struct stream_pos *pos,
+                       struct ctf_stream_class *stream_class);
+};
+
+static inline
+int generic_rw(struct stream_pos *pos, struct definition *definition)
+{
+       enum ctf_type_id dispatch_id = definition->declaration->id;
+       rw_dispatch call;
+
+       assert(pos->rw_table[dispatch_id] != NULL);
+       call = pos->rw_table[dispatch_id];
+       return call(pos, definition);
+}
+
 /*
  * 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
@@ -192,6 +162,9 @@ struct declaration_float {
 struct definition_float {
        struct definition p;
        struct declaration_float *declaration;
+       struct definition_integer *sign;
+       struct definition_integer *mantissa;
+       struct definition_integer *exp;
        /* Last values read */
        long double value;
 };
@@ -248,14 +221,22 @@ struct definition_enum {
        GArray *value;
 };
 
+enum ctf_string_encoding {
+       CTF_STRING_UTF8 = 0,
+       CTF_STRING_ASCII,
+       CTF_STRING_UNKNOWN,
+};
+
 struct declaration_string {
        struct declaration p;
+       enum ctf_string_encoding encoding;
 };
 
 struct definition_string {
        struct definition p;
        struct declaration_string *declaration;
        char *value;    /* freed at definition_string teardown */
+       size_t len, alloc_len;
 };
 
 struct declaration_field {
@@ -263,11 +244,6 @@ struct declaration_field {
        struct declaration *declaration;
 };
 
-struct field {
-       GQuark name;
-       struct definition *definition;
-};
-
 struct declaration_struct {
        struct declaration p;
        GHashTable *fields_by_name;     /* Tuples (field name, field index) */
@@ -279,25 +255,30 @@ struct definition_struct {
        struct definition p;
        struct declaration_struct *declaration;
        struct definition_scope *scope;
-       GArray *fields;                 /* Array of struct field */
+       GPtrArray *fields;              /* Array of pointers to struct definition */
 };
 
-struct declaration_variant {
+struct declaration_untagged_variant {
        struct declaration p;
        GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
        struct declaration_scope *scope;
        GArray *fields;                 /* Array of declaration_field */
-       GQuark tag_name;                /* TODO */
-       /* Tag name must be nonzero and must exist when defining the variant */
 };
 
+struct declaration_variant {
+       struct declaration p;
+       struct declaration_untagged_variant *untagged_variant;
+       GArray *tag_name;               /* Array of GQuark */
+};
+
+/* A variant needs to be tagged to be defined. */
 struct definition_variant {
        struct definition p;
        struct declaration_variant *declaration;
        struct definition_scope *scope;
        struct definition *enum_tag;
-       GArray *fields;                 /* Array of struct field */
-       struct field *current_field;    /* Last field read */
+       GPtrArray *fields;              /* Array of pointers to struct definition */
+       struct definition *current_field;       /* Last field read */
 };
 
 struct declaration_array {
@@ -311,7 +292,7 @@ struct definition_array {
        struct definition p;
        struct declaration_array *declaration;
        struct definition_scope *scope;
-       struct field current_element;           /* struct field */
+       GPtrArray *elems;               /* Array of pointers to struct definition */
 };
 
 struct declaration_sequence {
@@ -326,14 +307,14 @@ struct definition_sequence {
        struct declaration_sequence *declaration;
        struct definition_scope *scope;
        struct definition_integer *len;
-       struct field current_element;           /* struct field */
+       GPtrArray *elems;               /* Array of pointers to struct definition */
 };
 
 int register_declaration(GQuark declaration_name,
                         struct declaration *declaration,
                         struct declaration_scope *scope);
 struct declaration *lookup_declaration(GQuark declaration_name,
-                                      struct declaration_scope *scope);
+                               struct declaration_scope *scope);
 
 /*
  * Type scopes also contain a separate registry for struct, variant and
@@ -348,9 +329,9 @@ struct declaration_struct *
        lookup_struct_declaration(GQuark struct_name,
                                  struct declaration_scope *scope);
 int register_variant_declaration(GQuark variant_name,
-                         struct declaration_variant *variant_declaration,
+                         struct declaration_untagged_variant *untagged_variant_declaration,
                          struct declaration_scope *scope);
-struct declaration_variant *lookup_variant_declaration(GQuark variant_name,
+struct declaration_untagged_variant *lookup_variant_declaration(GQuark variant_name,
                                         struct declaration_scope *scope);
 int register_enum_declaration(GQuark enum_name,
                              struct declaration_enum *enum_declaration,
@@ -377,26 +358,33 @@ int register_field_definition(GQuark field_name,
 struct definition_scope *
        new_definition_scope(struct definition_scope *parent_scope,
                             GQuark field_name);
+void set_dynamic_definition_scope(struct definition *definition,
+                                 struct definition_scope *scope,
+                                 const char *root_name);
 void free_definition_scope(struct definition_scope *scope);
 
+GQuark new_definition_path(struct definition_scope *parent_scope, GQuark field_name);
+
+static inline
+int compare_definition_path(struct definition *definition, GQuark path)
+{
+       return definition->path == path;
+}
+
 void declaration_ref(struct declaration *declaration);
 void declaration_unref(struct declaration *declaration);
 
 void definition_ref(struct definition *definition);
 void definition_unref(struct definition *definition);
 
-/* Nameless declarations can be created by passing a NULL name */
-
-struct declaration_integer *integer_declaration_new(const char *name,
-                                     size_t len, int byte_order,
+struct declaration_integer *integer_declaration_new(size_t len, int byte_order,
                                      int signedness, size_t alignment);
 
 /*
  * mantissa_len is the length of the number of bytes represented by the mantissa
  * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
  */
-struct declaration_float *float_declaration_new(const char *name,
-                                 size_t mantissa_len,
+struct declaration_float *float_declaration_new(size_t mantissa_len,
                                  size_t exp_len, int byte_order,
                                  size_t alignment);
 
@@ -433,42 +421,47 @@ void enum_unsigned_insert(struct declaration_enum *enum_declaration,
 size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
 
 struct declaration_enum *
-       enum_declaration_new(const char *name,
-                            struct declaration_integer *integer_declaration);
+       enum_declaration_new(struct declaration_integer *integer_declaration);
+
+struct declaration_string *
+       string_declaration_new(enum ctf_string_encoding encoding);
 
 struct declaration_struct *
-       struct_declaration_new(const char *name,
-                              struct declaration_scope *parent_scope);
+       struct_declaration_new(struct declaration_scope *parent_scope);
 void struct_declaration_add_field(struct declaration_struct *struct_declaration,
                                  const char *field_name,
                                  struct declaration *field_declaration);
 /*
  * Returns the index of a field within a structure.
  */
-unsigned long struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
+int struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
                                                    GQuark field_name);
 /*
  * field returned only valid as long as the field structure is not appended to.
  */
 struct declaration_field *
 struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
-                                       unsigned long index);
-struct field *
-struct_get_field_from_index(struct definition_struct *struct_definition,
-                           unsigned long index);
+                                       int index);
+struct definition *
+struct_definition_get_field_from_index(struct definition_struct *struct_definition,
+                                      int index);
+int struct_rw(struct stream_pos *pos, struct definition *definition);
 
 /*
  * The tag enumeration is validated to ensure that it contains only mappings
  * from numeric values to a single tag. Overlapping tag value ranges are
  * therefore forbidden.
  */
-struct declaration_variant *variant_declaration_new(const char *name,
+struct declaration_untagged_variant *untagged_variant_declaration_new(
                struct declaration_scope *parent_scope);
-void variant_declaration_add_field(struct declaration_variant *variant_declaration,
-               const char *tag_name,
-               struct declaration *tag_declaration);
+struct declaration_variant *variant_declaration_new(struct declaration_untagged_variant *untagged_variant,
+               const char *tag);
+
+void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+               const char *field_name,
+               struct declaration *field_declaration);
 struct declaration_field *
-       variant_declaration_get_field_from_tag(struct declaration_variant *variant_declaration,
+       untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration,
                GQuark tag);
 /*
  * Returns 0 on success, -EPERM on error.
@@ -480,7 +473,8 @@ int variant_definition_set_tag(struct definition_variant *variant,
  * field returned only valid as long as the variant structure is not appended
  * to.
  */
-struct field *variant_get_current_field(struct definition_variant *variant);
+struct definition *variant_get_current_field(struct definition_variant *variant);
+int variant_rw(struct stream_pos *pos, struct definition *definition);
 
 /*
  * elem_declaration passed as parameter now belongs to the array. No
@@ -488,18 +482,27 @@ struct field *variant_get_current_field(struct definition_variant *variant);
  * array.
  */
 struct declaration_array *
-       array_declaration_new(const char *name,
-               size_t len, struct declaration *elem_declaration,
+       array_declaration_new(size_t len, struct declaration *elem_declaration,
                struct declaration_scope *parent_scope);
+uint64_t array_len(struct definition_array *array);
+struct definition *array_index(struct definition_array *array, uint64_t i);
+int array_rw(struct stream_pos *pos, struct definition *definition);
 
 /*
  * int_declaration and elem_declaration passed as parameter now belong
  * to the sequence. No need to free them explicitly.
  */
 struct declaration_sequence *
-       sequence_declaration_new(const char *name,
-               struct declaration_integer *len_declaration, 
+       sequence_declaration_new(struct declaration_integer *len_declaration, 
                struct declaration *elem_declaration,
                struct declaration_scope *parent_scope);
+uint64_t sequence_len(struct definition_sequence *sequence);
+struct definition *sequence_index(struct definition_sequence *sequence, uint64_t i);
+int sequence_rw(struct stream_pos *pos, struct definition *definition);
+
+/*
+ * in: path (dot separated), out: q (GArray of GQuark)
+ */
+void append_scope_path(const char *path, GArray *q);
 
-#endif /* _BABELTRACE_declarationS_H */
+#endif /* _BABELTRACE_TYPES_H */
This page took 0.027003 seconds and 4 git commands to generate.