X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=22c6876d5e34195ae14c67f167975637381d6d19;hp=ad28ac0912c85e98e8bc2c27acd0474e446e1d47;hb=ecc54f11c258cad6b54d35da83e525d32c032397;hpb=1ee8e81dbe8f14831974e32cef7d5f116d17a73d diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index ad28ac09..22c6876d 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -6,7 +6,9 @@ * * Type Header * - * Copyright 2010, 2011 - Mathieu Desnoyers + * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation + * + * Author: Mathieu Desnoyers * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -17,10 +19,19 @@ * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ #include #include +#include #include #include #include @@ -31,61 +42,11 @@ /* 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 format; -struct definition; +struct ctf_stream_definition; +struct bt_stream_pos; +struct bt_format; +struct bt_definition; +struct ctf_clock; /* type scope */ struct declaration_scope { @@ -117,66 +78,73 @@ struct definition_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 { +struct bt_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 */ /* * declaration_free called with declaration ref is decremented to 0. */ - void (*declaration_free)(struct declaration *declaration); - struct definition * - (*definition_new)(struct declaration *declaration, + void (*declaration_free)(struct bt_declaration *declaration); + struct bt_definition * + (*definition_new)(struct bt_declaration *declaration, struct definition_scope *parent_scope, - GQuark field_name, int index); + 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); - /* - * 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); + void (*definition_free)(struct bt_definition *definition); }; -struct definition { - struct declaration *declaration; +struct bt_definition { + struct bt_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 bt_stream_pos *pos, + struct bt_definition *definition); + +/* Parent of per-plugin positions */ +struct bt_stream_pos { + /* read/write dispatch table. Specific to plugin used for stream. */ + rw_dispatch *rw_table; /* rw dispatch table */ + int (*event_cb)(struct bt_stream_pos *pos, + struct ctf_stream_definition *stream); +}; + +static inline +int generic_rw(struct bt_stream_pos *pos, struct bt_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 * read/write non aligned on CHAR_BIT. */ struct declaration_integer { - struct declaration p; + struct bt_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 ctf_clock *clock; }; struct definition_integer { - struct definition p; + struct bt_definition p; struct declaration_integer *declaration; /* Last values read */ union { @@ -186,7 +154,7 @@ struct definition_integer { }; struct declaration_float { - struct declaration p; + struct bt_declaration p; struct declaration_integer *sign; struct declaration_integer *mantissa; struct declaration_integer *exp; @@ -195,10 +163,13 @@ struct declaration_float { }; struct definition_float { - struct definition p; + struct bt_definition p; struct declaration_float *declaration; + struct definition_integer *sign; + struct definition_integer *mantissa; + struct definition_integer *exp; /* Last values read */ - long double value; + double value; }; /* @@ -216,7 +187,7 @@ struct enum_range { }; struct enum_range_to_quark { - struct cds_list_head node; + struct bt_list_head node; struct enum_range range; GQuark quark; }; @@ -235,18 +206,18 @@ struct enum_range_to_quark { */ struct enum_table { GHashTable *value_to_quark_set; /* (value, GQuark GArray) */ - struct cds_list_head range_to_quark; /* (range, GQuark) */ + struct bt_list_head range_to_quark; /* (range, GQuark) */ GHashTable *quark_to_range_set; /* (GQuark, range GArray) */ }; struct declaration_enum { - struct declaration p; + struct bt_declaration p; struct declaration_integer *integer_declaration; struct enum_table table; }; struct definition_enum { - struct definition p; + struct bt_definition p; struct definition_integer *integer; struct declaration_enum *declaration; /* Last GQuark values read. Keeping a reference on the GQuark array. */ @@ -254,96 +225,91 @@ struct definition_enum { }; struct declaration_string { - struct declaration p; + struct bt_declaration p; + enum ctf_string_encoding encoding; }; struct definition_string { - struct definition p; + struct bt_definition p; struct declaration_string *declaration; char *value; /* freed at definition_string teardown */ + size_t len, alloc_len; }; struct declaration_field { GQuark name; - struct declaration *declaration; -}; - -struct field { - GQuark name; - struct definition *definition; + struct bt_declaration *declaration; }; struct declaration_struct { - struct declaration p; + struct bt_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 bt_definition p; struct declaration_struct *declaration; - struct definition_scope *scope; - GArray *fields; /* Array of struct field */ + GPtrArray *fields; /* Array of pointers to struct bt_definition */ }; struct declaration_untagged_variant { - struct declaration p; + struct bt_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 bt_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 bt_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 bt_definition *enum_tag; + GPtrArray *fields; /* Array of pointers to struct bt_definition */ + struct bt_definition *current_field; /* Last field read */ }; struct declaration_array { - struct declaration p; + struct bt_declaration p; size_t len; - struct declaration *elem; + struct bt_declaration *elem; struct declaration_scope *scope; }; struct definition_array { - struct definition p; + struct bt_definition p; struct declaration_array *declaration; - struct definition_scope *scope; - struct field current_element; /* struct field */ + GPtrArray *elems; /* Array of pointers to struct bt_definition */ + GString *string; /* String for encoded integer children */ }; struct declaration_sequence { - struct declaration p; - struct declaration_integer *len_declaration; - struct declaration *elem; + struct bt_declaration p; + GArray *length_name; /* Array of GQuark */ + struct bt_declaration *elem; struct declaration_scope *scope; }; struct definition_sequence { - struct definition p; + struct bt_definition p; struct declaration_sequence *declaration; - struct definition_scope *scope; - struct definition_integer *len; - struct field current_element; /* struct field */ + struct definition_integer *length; + GPtrArray *elems; /* Array of pointers to struct bt_definition */ + GString *string; /* String for encoded integer children */ }; -int register_declaration(GQuark declaration_name, - struct declaration *declaration, +int bt_register_declaration(GQuark declaration_name, + struct bt_declaration *declaration, struct declaration_scope *scope); -struct declaration *lookup_declaration(GQuark declaration_name, - struct declaration_scope *scope); +struct bt_declaration *bt_lookup_declaration(GQuark declaration_name, + struct declaration_scope *scope); /* * Type scopes also contain a separate registry for struct, variant and @@ -351,65 +317,76 @@ struct declaration *lookup_declaration(GQuark declaration_name, * that a named variant can be declared without specifying its target * "choice" tag field immediately. */ -int register_struct_declaration(GQuark struct_name, +int bt_register_struct_declaration(GQuark struct_name, struct declaration_struct *struct_declaration, struct declaration_scope *scope); struct declaration_struct * - lookup_struct_declaration(GQuark struct_name, + bt_lookup_struct_declaration(GQuark struct_name, struct declaration_scope *scope); -int register_variant_declaration(GQuark variant_name, - struct declaration_variant *variant_declaration, +int bt_register_variant_declaration(GQuark variant_name, + struct declaration_untagged_variant *untagged_variant_declaration, struct declaration_scope *scope); -struct declaration_variant *lookup_variant_declaration(GQuark variant_name, +struct declaration_untagged_variant *bt_lookup_variant_declaration(GQuark variant_name, struct declaration_scope *scope); -int register_enum_declaration(GQuark enum_name, +int bt_register_enum_declaration(GQuark enum_name, struct declaration_enum *enum_declaration, struct declaration_scope *scope); struct declaration_enum * - lookup_enum_declaration(GQuark enum_name, + bt_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); + bt_new_declaration_scope(struct declaration_scope *parent_scope); +void bt_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 bt_definition * + bt_lookup_path_definition(GArray *cur_path, /* array of GQuark */ + GArray *lookup_path, /* array of GQuark */ + struct definition_scope *scope); +int bt_register_field_definition(GQuark field_name, + struct bt_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); + bt_new_definition_scope(struct definition_scope *parent_scope, + GQuark field_name, const char *root_name); +void bt_free_definition_scope(struct definition_scope *scope); -void declaration_ref(struct declaration *declaration); -void declaration_unref(struct declaration *declaration); +GQuark bt_new_definition_path(struct definition_scope *parent_scope, + GQuark field_name, const char *root_name); + +static inline +int compare_definition_path(struct bt_definition *definition, GQuark path) +{ + return definition->path == path; +} -void definition_ref(struct definition *definition); -void definition_unref(struct definition *definition); +void bt_declaration_ref(struct bt_declaration *declaration); +void bt_declaration_unref(struct bt_declaration *declaration); -/* Nameless declarations can be created by passing a NULL name */ +void bt_definition_ref(struct bt_definition *definition); +void bt_definition_unref(struct bt_definition *definition); -struct declaration_integer *integer_declaration_new(const char *name, - size_t len, int byte_order, - int signedness, size_t alignment); +struct declaration_integer *bt_integer_declaration_new(size_t len, int byte_order, + int signedness, size_t alignment, + int base, enum ctf_string_encoding encoding, + struct ctf_clock *clock); +uint64_t bt_get_unsigned_int(const struct bt_definition *field); +int64_t bt_get_signed_int(const struct bt_definition *field); +int bt_get_int_signedness(const struct bt_definition *field); +int bt_get_int_byte_order(const struct bt_definition *field); +int bt_get_int_base(const struct bt_definition *field); +size_t bt_get_int_len(const struct bt_definition *field); /* in bits */ +enum ctf_string_encoding bt_get_int_encoding(const struct bt_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 declaration_float *float_declaration_new(const char *name, - size_t mantissa_len, +struct declaration_float *bt_float_declaration_new(size_t mantissa_len, size_t exp_len, int byte_order, size_t alignment); @@ -422,81 +399,88 @@ struct declaration_float *float_declaration_new(const char *name, * 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, +GArray *bt_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); +GArray *bt_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, +GArray *bt_enum_quark_to_range_set(const struct declaration_enum *enum_declaration, GQuark q); -void enum_signed_insert(struct declaration_enum *enum_declaration, +void bt_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, +void bt_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); +size_t bt_enum_get_nr_enumerators(struct declaration_enum *enum_declaration); struct declaration_enum * - enum_declaration_new(const char *name, - struct declaration_integer *integer_declaration); + bt_enum_declaration_new(struct declaration_integer *integer_declaration); + +struct declaration_string * + bt_string_declaration_new(enum ctf_string_encoding encoding); +char *bt_get_string(const struct bt_definition *field); +enum ctf_string_encoding bt_get_string_encoding(const struct bt_definition *field); struct declaration_struct * - struct_declaration_new(const char *name, - struct declaration_scope *parent_scope); -void struct_declaration_add_field(struct declaration_struct *struct_declaration, + bt_struct_declaration_new(struct declaration_scope *parent_scope, + uint64_t min_align); +void bt_struct_declaration_add_field(struct declaration_struct *struct_declaration, const char *field_name, - struct declaration *field_declaration); + struct bt_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 bt_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); +bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration, + int index); +struct bt_definition * +bt_struct_definition_get_field_from_index(struct definition_struct *struct_definition, + int index); +int bt_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); +uint64_t bt_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(const char *name, +struct declaration_untagged_variant *bt_untagged_bt_variant_declaration_new( struct declaration_scope *parent_scope); -struct declaration_variant *variant_declaration_new(struct declaration_untagged_variant *untagged_variant, +struct declaration_variant *bt_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, +void bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration, const char *field_name, - struct declaration *field_declaration); + struct bt_declaration *field_declaration); struct declaration_field * - untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, + bt_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); + struct bt_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); +struct bt_definition *bt_variant_get_current_field(struct definition_variant *variant); +int bt_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); /* * elem_declaration passed as parameter now belongs to the array. No @@ -504,23 +488,52 @@ 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, + bt_array_declaration_new(size_t len, struct bt_declaration *elem_declaration, struct declaration_scope *parent_scope); +uint64_t bt_array_len(struct definition_array *array); +struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i); +int bt_array_rw(struct bt_stream_pos *pos, struct bt_definition *definition); +GString *bt_get_char_array(const struct bt_definition *field); +int bt_get_array_len(const struct bt_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 *name, - struct declaration_integer *len_declaration, - struct declaration *elem_declaration, + bt_sequence_declaration_new(const char *length_name, + struct bt_declaration *elem_declaration, struct declaration_scope *parent_scope); +uint64_t bt_sequence_len(struct definition_sequence *sequence); +struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); +int bt_sequence_rw(struct bt_stream_pos *pos, struct bt_definition *definition); /* * in: path (dot separated), out: q (GArray of GQuark) */ -void append_scope_path(const char *path, GArray *q); +void bt_append_scope_path(const char *path, GArray *q); + +/* + * Lookup helpers. + */ +struct bt_definition *bt_lookup_definition(const struct bt_definition *definition, + const char *field_name); +struct definition_integer *bt_lookup_integer(const struct bt_definition *definition, + const char *field_name, + int signedness); +struct definition_enum *bt_lookup_enum(const struct bt_definition *definition, + const char *field_name, + int signedness); +struct bt_definition *bt_lookup_variant(const struct bt_definition *definition, + const char *field_name); + +static inline +const char *rem_(const char *str) +{ + if (str[0] == '_') + return &str[1]; + else + return str; +} -#endif /* _BABELTRACE_declarationS_H */ +#endif /* _BABELTRACE_TYPES_H */