X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=f3a0e831b15fcdfb9a85f76dc79a0c569222ca8a;hp=ad28ac0912c85e98e8bc2c27acd0474e446e1d47;hb=98b6832656447ab0f8024f9086aa67625e391ac7;hpb=1ee8e81dbe8f14831974e32cef7d5f116d17a73d diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index ad28ac09..f3a0e831 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 @@ -31,59 +33,8 @@ /* 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; +struct stream_pos; struct format; struct definition; @@ -133,7 +84,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,24 +93,50 @@ struct declaration { struct definition * (*definition_new)(struct 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); }; 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 +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); +} + +enum ctf_string_encoding { + CTF_STRING_NONE = 0, + CTF_STRING_UTF8, + CTF_STRING_ASCII, + CTF_STRING_UNKNOWN, }; /* @@ -173,6 +149,8 @@ struct declaration_integer { 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 definition_integer { @@ -197,8 +175,11 @@ 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; + double value; }; /* @@ -255,12 +236,14 @@ struct definition_enum { 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 { @@ -268,11 +251,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) */ @@ -283,8 +261,7 @@ struct declaration_struct { 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_untagged_variant { @@ -304,10 +281,9 @@ struct declaration_variant { 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 { @@ -320,13 +296,13 @@ struct declaration_array { 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 */ + GString *string; /* String for encoded integer children */ }; struct declaration_sequence { struct declaration p; - struct declaration_integer *len_declaration; + GArray *length_name; /* Array of GQuark */ struct declaration *elem; struct declaration_scope *scope; }; @@ -334,16 +310,16 @@ struct declaration_sequence { struct definition_sequence { struct 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 definition */ + GString *string; /* String for encoded integer children */ }; 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 @@ -358,9 +334,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, @@ -378,38 +354,43 @@ void free_declaration_scope(struct declaration_scope *scope); * definition scopes. */ struct definition * - lookup_definition(GArray *cur_path, /* array of GQuark */ - GArray *lookup_path, /* array of GQuark */ - struct definition_scope *scope); + 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); -void set_dynamic_definition_scope(struct definition *definition, - struct definition_scope *scope, - const char *root_name); + 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); -/* 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, - int signedness, size_t alignment); +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 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); @@ -430,7 +411,7 @@ GArray *enum_uint_to_quark_set(const struct declaration_enum *enum_declaration, * Caller must release the GArray with g_array_unref(). */ GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration, - uint64_t v); + int64_t v); /* * Returns a GArray of struct enum_range or NULL. @@ -446,36 +427,41 @@ 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); +char *get_string(struct definition *field); struct declaration_struct * - struct_declaration_new(const char *name, - struct declaration_scope *parent_scope); + 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_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); +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(const char *name, +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); @@ -496,7 +482,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 @@ -504,23 +491,42 @@ 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); +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 *name, - struct declaration_integer *len_declaration, + 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); /* * in: path (dot separated), out: q (GArray of GQuark) */ void append_scope_path(const char *path, GArray *q); -#endif /* _BABELTRACE_declarationS_H */ +/* + * Lookup helpers. + */ +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 */