X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=9704efed5e08229bc82243b30e715b1e2316e86e;hp=23fec0fcfcba89c48fd2715b30b55e0daa389b7a;hb=78af2bcd1a8236a26371d7638ab7acb2d41b6807;hpb=d79865b92da224131f58ab311e75e49043b62c7a diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index 23fec0fc..9704efed 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -4,23 +4,524 @@ /* * BabelTrace * - * Type header + * Type Header * - * Copyright (c) 2010 Mathieu Desnoyers + * Copyright 2010, 2011 - Mathieu Desnoyers * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +/* 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) * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * 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 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; +}; + +/* 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 */ +}; + +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, +}; + +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); + /* + * 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 */ + int ref; /* number of references to the 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 + * read/write non aligned on CHAR_BIT. + */ +struct declaration_integer { + struct declaration p; + size_t len; /* length, in bits. */ + int byte_order; /* byte order */ + int signedness; +}; + +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; + /* Last values read */ + long 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_set; /* (value, GQuark GArray) */ + struct cds_list_head range_to_quark; /* (range, GQuark) */ + GHashTable *quark_to_range_set; /* (GQuark, range GArray) */ +}; + +struct declaration_enum { + struct declaration p; + struct declaration_integer *integer_declaration; + struct enum_table table; +}; + +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; +}; + +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 */ +}; + +struct declaration_field { + GQuark name; + 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) */ + struct declaration_scope *scope; + GArray *fields; /* Array of declaration_field */ +}; + +struct definition_struct { + struct definition p; + struct declaration_struct *declaration; + struct definition_scope *scope; + GArray *fields; /* Array of struct field */ +}; + +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_scope *scope; + struct definition *enum_tag; + GArray *fields; /* Array of struct field */ + struct field *current_field; /* Last field read */ +}; + +struct declaration_array { + struct declaration p; + size_t len; + struct declaration *elem; + struct declaration_scope *scope; +}; + +struct definition_array { + struct definition p; + struct declaration_array *declaration; + struct definition_scope *scope; + struct field current_element; /* struct field */ +}; + +struct declaration_sequence { + struct declaration p; + struct declaration_integer *len_declaration; + struct declaration *elem; + struct declaration_scope *scope; +}; + +struct definition_sequence { + struct definition p; + struct declaration_sequence *declaration; + struct definition_scope *scope; + struct definition_integer *len; + struct field current_element; /* struct field */ +}; + +int register_declaration(GQuark declaration_name, + struct declaration *declaration, + struct declaration_scope *scope); +struct declaration *lookup_declaration(GQuark declaration_name, + struct declaration_scope *scope); + +/* + * 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_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); +void set_dynamic_definition_scope(struct definition *definition, + struct definition_scope *scope, + const char *root_name); +void free_definition_scope(struct definition_scope *scope); + +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); + +/* + * 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(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(). + */ + +/* + * 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, + uint64_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); + +struct declaration_struct * + 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, + 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); + +/* + * 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 field *variant_get_current_field(struct definition_variant *variant); + +/* + * 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); + +/* + * 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(struct declaration_integer *len_declaration, + struct declaration *elem_declaration, + struct declaration_scope *parent_scope); + +/* + * in: path (dot separated), out: q (GArray of GQuark) */ +void append_scope_path(const char *path, GArray *q); -#endif /* _BABELTRACE_TYPES_H */ +#endif /* _BABELTRACE_declarationS_H */