X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=60bd4fdb583f43c1ee613efd7d05e92bd1684055;hp=845a8ae91500a4744e82c520cd2cfc8c9cd8320d;hb=ebae302b9108c5747e8af8b3d54740f48479b245;hpb=9e88d150c4119a0c6d6288cad6d6db87df7bac4b diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index 845a8ae9..60bd4fdb 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -19,6 +19,14 @@ * * 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 @@ -297,10 +305,10 @@ struct definition_sequence { GString *string; /* String for encoded integer children */ }; -int register_declaration(GQuark declaration_name, +int bt_register_declaration(GQuark declaration_name, struct declaration *declaration, struct declaration_scope *scope); -struct declaration *lookup_declaration(GQuark declaration_name, +struct declaration *bt_lookup_declaration(GQuark declaration_name, struct declaration_scope *scope); /* @@ -309,27 +317,27 @@ 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, +int bt_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_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 @@ -356,28 +364,29 @@ 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 bt_declaration_ref(struct declaration *declaration); +void bt_declaration_unref(struct declaration *declaration); -void definition_ref(struct definition *definition); -void definition_unref(struct definition *definition); +void bt_definition_ref(struct definition *definition); +void bt_definition_unref(struct definition *definition); -struct declaration_integer *integer_declaration_new(size_t len, int byte_order, +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 get_unsigned_int(const struct definition *field); -int64_t get_signed_int(const struct definition *field); -int get_int_signedness(const struct definition *field); -int get_int_byte_order(const struct definition *field); -int get_int_base(const struct definition *field); -enum ctf_string_encoding get_int_encoding(const struct definition *field); +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); /* * 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, +struct declaration_float *bt_float_declaration_new(size_t mantissa_len, size_t exp_len, int byte_order, size_t alignment); @@ -390,14 +399,14 @@ struct declaration_float *float_declaration_new(size_t mantissa_len, * 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, +GArray *bt_enum_int_to_quark_set(const struct declaration_enum *enum_declaration, int64_t v); /* @@ -405,60 +414,60 @@ GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration, * 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(struct declaration_integer *integer_declaration); + bt_enum_declaration_new(struct declaration_integer *integer_declaration); struct declaration_string * - string_declaration_new(enum ctf_string_encoding encoding); -char *get_string(const struct definition *field); -enum ctf_string_encoding get_string_encoding(const struct definition *field); + 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); struct declaration_struct * - struct_declaration_new(struct declaration_scope *parent_scope, + bt_struct_declaration_new(struct declaration_scope *parent_scope, uint64_t min_align); -void struct_declaration_add_field(struct declaration_struct *struct_declaration, +void bt_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. */ -int 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, +bt_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, +bt_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); +int bt_struct_rw(struct stream_pos *pos, struct 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( +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 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. @@ -470,8 +479,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 definition *variant_get_current_field(struct definition_variant *variant); -int variant_rw(struct stream_pos *pos, struct definition *definition); +struct definition *bt_variant_get_current_field(struct definition_variant *variant); +int bt_variant_rw(struct stream_pos *pos, struct definition *definition); /* * elem_declaration passed as parameter now belongs to the array. No @@ -479,30 +488,30 @@ int variant_rw(struct stream_pos *pos, struct definition *definition); * array. */ struct declaration_array * - array_declaration_new(size_t len, struct declaration *elem_declaration, + bt_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(const struct definition *field); -int get_array_len(const struct definition *field); +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 stream_pos *pos, struct definition *definition); +GString *bt_get_char_array(const struct definition *field); +int bt_get_array_len(const 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, + bt_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); +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 stream_pos *pos, struct 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. @@ -512,10 +521,10 @@ struct definition *lookup_definition(const struct definition *definition, struct definition_integer *lookup_integer(const struct definition *definition, const char *field_name, int signedness); -struct definition_enum *lookup_enum(const struct definition *definition, +struct definition_enum *bt_lookup_enum(const struct definition *definition, const char *field_name, int signedness); -struct definition *lookup_variant(const struct definition *definition, +struct definition *bt_lookup_variant(const struct definition *definition, const char *field_name); static inline