X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=22c6876d5e34195ae14c67f167975637381d6d19;hp=310a269fdb35dea1b09a4895ea5c097cc23804fe;hb=ecc54f11c258cad6b54d35da83e525d32c032397;hpb=1cf393f63db4dce618515749d5549564d1313ee4 diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index 310a269f..22c6876d 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -44,8 +44,8 @@ struct ctf_stream_definition; struct bt_stream_pos; -struct format; -struct definition; +struct bt_format; +struct bt_definition; struct ctf_clock; /* type scope */ @@ -78,27 +78,27 @@ struct definition_scope { GArray *scope_path; /* array of GQuark */ }; -struct declaration { +struct bt_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, + 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, const char *root_name); /* * definition_free called with definition ref is decremented to 0. */ - void (*definition_free)(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 */ @@ -107,7 +107,7 @@ struct definition { }; typedef int (*rw_dispatch)(struct bt_stream_pos *pos, - struct definition *definition); + struct bt_definition *definition); /* Parent of per-plugin positions */ struct bt_stream_pos { @@ -118,7 +118,7 @@ struct bt_stream_pos { }; static inline -int generic_rw(struct bt_stream_pos *pos, struct definition *definition) +int generic_rw(struct bt_stream_pos *pos, struct bt_definition *definition) { enum ctf_type_id dispatch_id = definition->declaration->id; rw_dispatch call; @@ -134,7 +134,7 @@ int generic_rw(struct bt_stream_pos *pos, struct definition *definition) * 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; @@ -144,7 +144,7 @@ struct declaration_integer { }; struct definition_integer { - struct definition p; + struct bt_definition p; struct declaration_integer *declaration; /* Last values read */ union { @@ -154,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; @@ -163,7 +163,7 @@ 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; @@ -211,13 +211,13 @@ struct enum_table { }; 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. */ @@ -225,12 +225,12 @@ 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; @@ -238,77 +238,77 @@ struct definition_string { struct declaration_field { GQuark name; - struct declaration *declaration; + 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; - GPtrArray *fields; /* Array of pointers to struct definition */ + 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 *enum_tag; - GPtrArray *fields; /* Array of pointers to struct definition */ - struct definition *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; - GPtrArray *elems; /* Array of pointers to struct definition */ + GPtrArray *elems; /* Array of pointers to struct bt_definition */ GString *string; /* String for encoded integer children */ }; struct declaration_sequence { - struct declaration p; + struct bt_declaration p; GArray *length_name; /* Array of GQuark */ - struct declaration *elem; + struct bt_declaration *elem; struct declaration_scope *scope; }; struct definition_sequence { - struct definition p; + struct bt_definition p; struct declaration_sequence *declaration; struct definition_integer *length; - GPtrArray *elems; /* Array of pointers to struct definition */ + GPtrArray *elems; /* Array of pointers to struct bt_definition */ GString *string; /* String for encoded integer children */ }; int bt_register_declaration(GQuark declaration_name, - struct declaration *declaration, + struct bt_declaration *declaration, struct declaration_scope *scope); -struct declaration *bt_lookup_declaration(GQuark declaration_name, +struct bt_declaration *bt_lookup_declaration(GQuark declaration_name, struct declaration_scope *scope); /* @@ -343,12 +343,12 @@ void bt_free_declaration_scope(struct declaration_scope *scope); * field_definition is for field definitions. They are registered into * definition scopes. */ -struct 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 definition *definition, + struct bt_definition *definition, struct definition_scope *scope); struct definition_scope * bt_new_definition_scope(struct definition_scope *parent_scope, @@ -359,28 +359,28 @@ GQuark bt_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) +int compare_definition_path(struct bt_definition *definition, GQuark path) { return definition->path == path; } -void bt_declaration_ref(struct declaration *declaration); -void bt_declaration_unref(struct declaration *declaration); +void bt_declaration_ref(struct bt_declaration *declaration); +void bt_declaration_unref(struct bt_declaration *declaration); -void bt_definition_ref(struct definition *definition); -void bt_definition_unref(struct definition *definition); +void bt_definition_ref(struct bt_definition *definition); +void bt_definition_unref(struct bt_definition *definition); 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 definition *field); -int64_t bt_get_signed_int(const struct definition *field); -int bt_get_int_signedness(const struct definition *field); -int bt_get_int_byte_order(const struct definition *field); -int bt_get_int_base(const struct definition *field); -size_t bt_get_int_len(const struct definition *field); /* in bits */ -enum ctf_string_encoding bt_get_int_encoding(const struct definition *field); +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 @@ -427,15 +427,15 @@ struct declaration_enum * struct declaration_string * bt_string_declaration_new(enum ctf_string_encoding encoding); -char *bt_get_string(const struct definition *field); -enum ctf_string_encoding bt_get_string_encoding(const struct definition *field); +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 * 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. */ @@ -447,10 +447,10 @@ int bt_struct_declaration_lookup_field_index(struct declaration_struct *struct_d struct declaration_field * bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration, int index); -struct definition * +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 definition *definition); +int bt_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); uint64_t bt_struct_declaration_len(struct declaration_struct *struct_declaration); /* @@ -465,7 +465,7 @@ struct declaration_variant *bt_variant_declaration_new(struct declaration_untagg 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 * bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag); @@ -473,14 +473,14 @@ struct declaration_field * * 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 definition *bt_variant_get_current_field(struct definition_variant *variant); -int bt_variant_rw(struct bt_stream_pos *pos, struct definition *definition); +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 @@ -488,13 +488,13 @@ int bt_variant_rw(struct bt_stream_pos *pos, struct definition *definition); * array. */ struct declaration_array * - bt_array_declaration_new(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 definition *bt_array_index(struct definition_array *array, uint64_t i); -int bt_array_rw(struct bt_stream_pos *pos, struct definition *definition); -GString *bt_get_char_array(const struct definition *field); -int bt_get_array_len(const struct definition *field); +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 @@ -502,11 +502,11 @@ int bt_get_array_len(const struct definition *field); */ struct declaration_sequence * bt_sequence_declaration_new(const char *length_name, - struct declaration *elem_declaration, + struct bt_declaration *elem_declaration, struct declaration_scope *parent_scope); uint64_t bt_sequence_len(struct definition_sequence *sequence); -struct definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); -int bt_sequence_rw(struct bt_stream_pos *pos, struct definition *definition); +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) @@ -516,15 +516,15 @@ void bt_append_scope_path(const char *path, GArray *q); /* * Lookup helpers. */ -struct definition *bt_lookup_definition(const struct definition *definition, +struct bt_definition *bt_lookup_definition(const struct bt_definition *definition, const char *field_name); -struct definition_integer *bt_lookup_integer(const struct definition *definition, +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 definition *definition, +struct definition_enum *bt_lookup_enum(const struct bt_definition *definition, const char *field_name, int signedness); -struct definition *bt_lookup_variant(const struct definition *definition, +struct bt_definition *bt_lookup_variant(const struct bt_definition *definition, const char *field_name); static inline