*
* Type Header
*
- * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
*/
#include <babeltrace/align.h>
+#include <babeltrace/list.h>
#include <stdbool.h>
#include <stdint.h>
#include <limits.h>
#include <string.h>
#include <glib.h>
+#include <assert.h>
/* 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 {
- unsigned char *base; /* Base address */
- size_t offset; /* Offset from base, in bits */
- int dummy; /* Dummy position, for length calculation */
+struct ctf_stream;
+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;
+ /* Hash table mapping variant name GQuark to "struct declaration_variant" */
+ GHashTable *variant_declarations;
+ /* Hash table mapping enum name GQuark to "struct type_enum" */
+ GHashTable *enum_declarations;
+ struct declaration_scope *parent_scope;
};
-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;
-}
+/* definition scope */
+struct definition_scope {
+ /* Hash table mapping field name GQuark to "struct definition" */
+ GHashTable *definitions;
+ struct definition_scope *parent_scope;
+ /*
+ * Complete "path" leading to this definition scope.
+ * 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 */
+};
-/*
- * 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;
-}
+enum ctf_type_id {
+ CTF_TYPE_UNKNOWN = 0,
+ CTF_TYPE_INTEGER,
+ CTF_TYPE_FLOAT,
+ CTF_TYPE_ENUM,
+ CTF_TYPE_STRING,
+ CTF_TYPE_STRUCT,
+ CTF_TYPE_UNTAGGED_VARIANT,
+ CTF_TYPE_VARIANT,
+ CTF_TYPE_ARRAY,
+ CTF_TYPE_SEQUENCE,
+ NR_CTF_TYPES,
+};
-/*
- * 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);
-}
+struct declaration {
+ enum ctf_type_id id;
+ size_t alignment; /* type alignment, in bits */
+ int ref; /* number of references to the type */
+ /*
+ * declaration_free called with declaration ref is decremented to 0.
+ */
+ void (*declaration_free)(struct declaration *declaration);
+ struct definition *
+ (*definition_new)(struct declaration *declaration,
+ struct definition_scope *parent_scope,
+ GQuark field_name, int index,
+ const char *root_name);
+ /*
+ * definition_free called with definition ref is decremented to 0.
+ */
+ void (*definition_free)(struct definition *definition);
+};
-static inline
-void copy_pos(struct stream_pos *dest, struct stream_pos *src)
-{
- memcpy(dest, src, sizeof(struct stream_pos));
-}
+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;
+ struct definition_scope *scope;
+};
+
+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 *stream);
+};
static inline
-unsigned char *get_pos_addr(struct stream_pos *pos)
+int generic_rw(struct stream_pos *pos, struct definition *definition)
{
- /* Only makes sense to get the address after aligning on CHAR_BIT */
- assert(!(pos->offset % CHAR_BIT));
- return pos->base + (pos->offset / CHAR_BIT);
-}
+ enum ctf_type_id dispatch_id = definition->declaration->id;
+ rw_dispatch call;
-struct format;
+ assert(pos->rw_table[dispatch_id] != NULL);
+ call = pos->rw_table[dispatch_id];
+ return call(pos, definition);
+}
-struct type_class {
- GQuark name; /* type name */
- size_t alignment; /* type alignment, in bits */
- int ref; /* number of references to the type */
- /*
- * Type copy function. Knows how to find the child type_class from the
- * parent type_class.
- */
- void (*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);
+enum ctf_string_encoding {
+ CTF_STRING_NONE = 0,
+ CTF_STRING_UTF8,
+ CTF_STRING_ASCII,
+ CTF_STRING_UNKNOWN,
};
/*
* integers, except that their read/write functions must be able to deal with
* read/write non aligned on CHAR_BIT.
*/
-struct type_class_integer {
- struct type_class p;
+struct declaration_integer {
+ struct declaration p;
size_t len; /* length, in bits. */
int byte_order; /* byte order */
int signedness;
+ int base; /* Base for pretty-printing: 2, 8, 10, 16 */
+ enum ctf_string_encoding encoding;
};
-struct type_class_float {
- struct type_class p;
- struct type_class_integer *sign;
- struct type_class_integer *mantissa;
- struct type_class_integer *exp;
+struct definition_integer {
+ struct definition p;
+ struct declaration_integer *declaration;
+ /* Last values read */
+ union {
+ uint64_t _unsigned;
+ int64_t _signed;
+ } value;
+};
+
+struct declaration_float {
+ struct declaration p;
+ struct declaration_integer *sign;
+ struct declaration_integer *mantissa;
+ struct declaration_integer *exp;
int byte_order;
/* TODO: we might want to express more info about NaN, +inf and -inf */
};
+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 */
+ double value;
+};
+
+/*
+ * enum_val_equal assumes that signed and unsigned memory layout overlap.
+ */
+struct enum_range {
+ union {
+ int64_t _signed;
+ uint64_t _unsigned;
+ } start; /* lowest range value */
+ union {
+ int64_t _signed;
+ uint64_t _unsigned;
+ } end; /* highest range value */
+};
+
+struct enum_range_to_quark {
+ struct cds_list_head node;
+ struct enum_range range;
+ GQuark quark;
+};
+
+/*
+ * We optimize the common case (range of size 1: single value) by creating a
+ * hash table mapping values to quark sets. We then lookup the ranges to
+ * complete the quark set.
+ *
+ * TODO: The proper structure to hold the range to quark set mapping would be an
+ * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
+ * time. Using a simple O(n) list search for now for implementation speed and
+ * given that we can expect to have a _relatively_ small number of enumeration
+ * ranges. This might become untrue if we are fed with symbol tables often
+ * required to lookup function names from instruction pointer value.
+ */
struct enum_table {
- GHashTable *value_to_quark; /* Tuples (value, GQuark) */
- GHashTable *quark_to_value; /* Tuples (GQuark, value) */
+ GHashTable *value_to_quark_set; /* (value, GQuark GArray) */
+ struct cds_list_head range_to_quark; /* (range, GQuark) */
+ GHashTable *quark_to_range_set; /* (GQuark, range GArray) */
};
-struct type_class_enum {
- struct type_class_integer p; /* inherit from integer */
+struct declaration_enum {
+ struct declaration p;
+ struct declaration_integer *integer_declaration;
struct enum_table table;
};
-struct type_class_string {
- struct type_class p;
+struct definition_enum {
+ struct definition p;
+ struct definition_integer *integer;
+ struct declaration_enum *declaration;
+ /* Last GQuark values read. Keeping a reference on the GQuark array. */
+ GArray *value;
+};
+
+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 field {
+struct declaration_field {
GQuark name;
- struct type_class *type_class;
+ struct declaration *declaration;
};
-struct type_class_struct {
- struct type_class p;
+struct declaration_struct {
+ struct declaration p;
GHashTable *fields_by_name; /* Tuples (field name, field index) */
- GArray *fields; /* Array of fields */
+ struct declaration_scope *scope;
+ GArray *fields; /* Array of declaration_field */
+};
+
+struct definition_struct {
+ struct definition p;
+ struct declaration_struct *declaration;
+ GPtrArray *fields; /* Array of pointers to struct definition */
+};
+
+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 */
+};
+
+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 *enum_tag;
+ GPtrArray *fields; /* Array of pointers to struct definition */
+ struct definition *current_field; /* Last field read */
};
-struct type_class_array {
- struct type_class p;
+struct declaration_array {
+ struct declaration p;
size_t len;
- struct type_class *elem;
+ struct declaration *elem;
+ struct declaration_scope *scope;
};
-struct type_class_sequence {
- struct type_class p;
- struct type_class_integer *len_class;
- struct type_class *elem;
+struct definition_array {
+ struct definition p;
+ struct declaration_array *declaration;
+ GPtrArray *elems; /* Array of pointers to struct definition */
+ GString *string; /* String for encoded integer children */
};
-struct type_class *lookup_type(GQuark qname);
-int register_type(struct type_class *type_class);
+struct declaration_sequence {
+ struct declaration p;
+ GArray *length_name; /* Array of GQuark */
+ struct declaration *elem;
+ struct declaration_scope *scope;
+};
-void type_ref(struct type_class *type_class);
-void type_unref(struct type_class *type_class);
+struct definition_sequence {
+ struct definition p;
+ struct declaration_sequence *declaration;
+ struct definition_integer *length;
+ GPtrArray *elems; /* Array of pointers to struct definition */
+ GString *string; /* String for encoded integer children */
+};
-/* Nameless types can be created by passing a NULL name */
+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 type_class_integer *integer_type_new(const char *name,
- size_t len, int byte_order,
- int signedness,
- size_t alignment);
-void integer_type_free(struct type_class_integer *int_class);
+/*
+ * Type scopes also contain a separate registry for struct, variant and
+ * enum types. Those register types rather than type definitions, so
+ * that a named variant can be declared without specifying its target
+ * "choice" tag field immediately.
+ */
+int register_struct_declaration(GQuark struct_name,
+ struct declaration_struct *struct_declaration,
+ struct declaration_scope *scope);
+struct declaration_struct *
+ lookup_struct_declaration(GQuark struct_name,
+ struct declaration_scope *scope);
+int register_variant_declaration(GQuark variant_name,
+ struct declaration_untagged_variant *untagged_variant_declaration,
+ struct declaration_scope *scope);
+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,
+ struct declaration_scope *scope);
+struct declaration_enum *
+ lookup_enum_declaration(GQuark enum_name,
+ struct declaration_scope *scope);
+
+struct declaration_scope *
+ new_declaration_scope(struct declaration_scope *parent_scope);
+void free_declaration_scope(struct declaration_scope *scope);
+
+/*
+ * field_definition is for field definitions. They are registered into
+ * definition scopes.
+ */
+struct definition *
+ lookup_path_definition(GArray *cur_path, /* array of GQuark */
+ GArray *lookup_path, /* array of GQuark */
+ struct definition_scope *scope);
+int register_field_definition(GQuark field_name,
+ struct definition *definition,
+ struct definition_scope *scope);
+struct definition_scope *
+ new_definition_scope(struct definition_scope *parent_scope,
+ GQuark field_name, const char *root_name);
+void free_definition_scope(struct definition_scope *scope);
+
+GQuark new_definition_path(struct definition_scope *parent_scope,
+ GQuark field_name, const char *root_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);
+
+struct declaration_integer *integer_declaration_new(size_t len, int byte_order,
+ int signedness, size_t alignment,
+ int base, enum ctf_string_encoding encoding);
+uint64_t get_unsigned_int(struct definition *field);
+int64_t get_signed_int(struct definition *field);
/*
* 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 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);
+struct declaration_float *float_declaration_new(size_t mantissa_len,
+ size_t exp_len, int byte_order,
+ size_t alignment);
/*
* 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,
- GQuark q);
-int64_t enum_quark_to_int(const struct type_class_enum *enum_class,
- 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 len, int byte_order,
- int signedness,
- size_t alignment);
-void enum_type_free(struct type_class_enum *enum_class);
-
-struct type_class_struct *struct_type_new(const char *name);
-void struct_type_free(struct type_class_struct *struct_class);
-void struct_type_add_field(struct type_class_struct *struct_class,
- const char *field_name,
- struct type_class *type_class);
+
+/*
+ * Returns a GArray of GQuark or NULL.
+ * Caller must release the GArray with g_array_unref().
+ */
+GArray *enum_uint_to_quark_set(const struct declaration_enum *enum_declaration,
+ uint64_t v);
+
+/*
+ * Returns a GArray of GQuark or NULL.
+ * Caller must release the GArray with g_array_unref().
+ */
+GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
+ int64_t v);
+
+/*
+ * Returns a GArray of struct enum_range or NULL.
+ * Callers do _not_ own the returned GArray (and therefore _don't_ need to
+ * release it).
+ */
+GArray *enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
+ GQuark q);
+void enum_signed_insert(struct declaration_enum *enum_declaration,
+ int64_t start, int64_t end, GQuark q);
+void enum_unsigned_insert(struct declaration_enum *enum_declaration,
+ uint64_t start, uint64_t end, GQuark q);
+size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
+
+struct declaration_enum *
+ enum_declaration_new(struct declaration_integer *integer_declaration);
+
+struct declaration_string *
+ string_declaration_new(enum ctf_string_encoding encoding);
+char *get_string(struct definition *field);
+
+struct declaration_struct *
+ struct_declaration_new(struct declaration_scope *parent_scope,
+ uint64_t min_align);
+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_type_lookup_field_index(struct type_class_struct *struct_class,
- GQuark field_name);
+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 field *
-struct_type_get_field_from_index(struct type_class_struct *struct_class,
- unsigned long index);
+struct declaration_field *
+struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
+ 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);
+uint64_t struct_declaration_len(struct declaration_struct *struct_declaration);
+
+/*
+ * 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_untagged_variant *untagged_variant_declaration_new(
+ struct declaration_scope *parent_scope);
+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 *
+ untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration,
+ GQuark tag);
+/*
+ * Returns 0 on success, -EPERM on error.
+ */
+int variant_definition_set_tag(struct definition_variant *variant,
+ struct definition *enum_tag);
+/*
+ * Returns the field selected by the current tag value.
+ * field returned only valid as long as the variant structure is not appended
+ * to.
+ */
+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
+ * need to free it explicitly. "len" is the number of elements in the
+ * array.
+ */
+struct declaration_array *
+ 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);
+GString *get_char_array(struct definition *field);
+
+/*
+ * 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 *length_name,
+ 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);
/*
- * elem_class passed as parameter now belongs to the array. No need to free it
- * explicitely.
+ * in: path (dot separated), out: q (GArray of GQuark)
*/
-struct type_class_array *array_type_new(const char *name,
- size_t len,
- struct type_class *elem_class);
-void array_type_free(struct type_class_array *array_class);
+void append_scope_path(const char *path, GArray *q);
/*
- * int_class and elem_class passed as parameter now belongs to the sequence. No
- * need to free them explicitely.
+ * Lookup helpers.
*/
-struct type_class_sequence *sequence_type_new(const char *name,
- struct type_class_integer *len_class,
- struct type_class *elem_class);
-void sequence_type_free(struct type_class_sequence *sequence_class);
+struct definition *lookup_definition(struct definition *definition,
+ const char *field_name);
+struct definition_integer *lookup_integer(struct definition *definition,
+ const char *field_name,
+ int signedness);
+struct definition_enum *lookup_enum(struct definition *definition,
+ const char *field_name,
+ int signedness);
+struct definition *lookup_variant(struct definition *definition,
+ const char *field_name);
#endif /* _BABELTRACE_TYPES_H */
projects / babeltrace.git / blobdiff