X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fevents.h;h=a8764707a7f188061f579588d072ccb431452761;hb=61cf588beae752e5ddfc60b6b5310f769ac9e852;hp=19d73612b45d78695d5508e5fc6788a855cea3f3;hpb=c462e188f3e7819c7bc74f671038cdbf36e8c3c0;p=babeltrace.git diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index 19d73612..a8764707 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -39,8 +39,8 @@ extern "C" { #endif -struct definition; -struct declaration; +struct bt_definition; +struct bt_declaration; struct bt_ctf_event; struct bt_ctf_event_decl; struct bt_ctf_field_decl; @@ -94,7 +94,7 @@ enum ctf_string_encoding { * between the enum and the actual definition of top-level scopes. * On error return NULL. */ -const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event, +const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event, enum bt_ctf_scope scope); /* @@ -109,10 +109,12 @@ const char *bt_ctf_event_name(const struct bt_ctf_event *event); uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *event); /* - * bt_ctf_get_timestamp: returns the timestamp of the event offsetted - * with the system clock source (in ns) or -1ULL on error + * bt_ctf_get_timestamp: get the timestamp of the event offsetted + * with the system clock source (in ns) in *timestamp. + * + * Return 0 on success, or -1ULL on error. */ -uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event); +int bt_ctf_get_timestamp(const struct bt_ctf_event *event, int64_t *timestamp); /* * bt_ctf_get_field_list: obtain the list of fields for compound type @@ -130,47 +132,47 @@ uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event); * from which the event is extracted is unchanged). */ int bt_ctf_get_field_list(const struct bt_ctf_event *event, - const struct definition *scope, - struct definition const * const **list, + const struct bt_definition *scope, + struct bt_definition const * const **list, unsigned int *count); /* * bt_ctf_get_field: returns the definition of a specific field */ -const struct definition *bt_ctf_get_field(const struct bt_ctf_event *event, - const struct definition *scope, +const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *event, + const struct bt_definition *scope, const char *field); /* * bt_ctf_get_index: if the field is an array or a sequence, return the element * at position index, otherwise return NULL; */ -const struct definition *bt_ctf_get_index(const struct bt_ctf_event *event, - const struct definition *field, +const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *event, + const struct bt_definition *field, unsigned int index); /* * bt_ctf_field_name: returns the name of a field or NULL on error */ -const char *bt_ctf_field_name(const struct definition *def); +const char *bt_ctf_field_name(const struct bt_definition *def); /* * bt_ctf_get_decl_from_def: return the declaration of a field from * its definition or NULL on error */ -const struct declaration *bt_ctf_get_decl_from_def(const struct definition *def); +const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *def); /* * bt_ctf_get_decl_from_field_decl: return the declaration of a field from * a field_decl or NULL on error */ -const struct declaration *bt_ctf_get_decl_from_field_decl( +const struct bt_declaration *bt_ctf_get_decl_from_field_decl( const struct bt_ctf_field_decl *field); /* * bt_ctf_field_type: returns the type of a field or -1 if unknown */ -enum ctf_type_id bt_ctf_field_type(const struct declaration *decl); +enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *decl); /* * bt_ctf_get_int_signedness: return the signedness of an integer @@ -179,37 +181,43 @@ enum ctf_type_id bt_ctf_field_type(const struct declaration *decl); * return 1 if signed * return -1 on error */ -int bt_ctf_get_int_signedness(const struct declaration *decl); +int bt_ctf_get_int_signedness(const struct bt_declaration *decl); /* * bt_ctf_get_int_base: return the base of an int or a negative value on error */ -int bt_ctf_get_int_base(const struct declaration *decl); +int bt_ctf_get_int_base(const struct bt_declaration *decl); /* * bt_ctf_get_int_byte_order: return the byte order of an int or a negative * value on error */ -int bt_ctf_get_int_byte_order(const struct declaration *decl); +int bt_ctf_get_int_byte_order(const struct bt_declaration *decl); /* * bt_ctf_get_int_len: return the size, in bits, of an int or a negative * value on error */ -ssize_t bt_ctf_get_int_len(const struct declaration *decl); +ssize_t bt_ctf_get_int_len(const struct bt_declaration *decl); /* * bt_ctf_get_encoding: return the encoding of an int, a string, or of * the integer contained in a char array or a sequence. * return a negative value on error */ -enum ctf_string_encoding bt_ctf_get_encoding(const struct declaration *decl); +enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *decl); /* * bt_ctf_get_array_len: return the len of an array or a negative * value on error */ -int bt_ctf_get_array_len(const struct declaration *decl); +int bt_ctf_get_array_len(const struct bt_declaration *decl); + +/* + * bt_ctf_get_struct_field_count: return the number of fields in a structure. + * Returns a negative value on error. + */ +uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *field); /* * Field access functions @@ -225,12 +233,16 @@ int bt_ctf_get_array_len(const struct declaration *decl); * bt_ctf_get_enum_str gets the string matching the current enumeration * value, or NULL if the current value does not match any string. */ -uint64_t bt_ctf_get_uint64(const struct definition *field); -int64_t bt_ctf_get_int64(const struct definition *field); -const struct definition *bt_ctf_get_enum_int(const struct definition *field); -const char *bt_ctf_get_enum_str(const struct definition *field); -char *bt_ctf_get_char_array(const struct definition *field); -char *bt_ctf_get_string(const struct definition *field); +uint64_t bt_ctf_get_uint64(const struct bt_definition *field); +int64_t bt_ctf_get_int64(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field); +const char *bt_ctf_get_enum_str(const struct bt_definition *field); +char *bt_ctf_get_char_array(const struct bt_definition *field); +char *bt_ctf_get_string(const struct bt_definition *field); +double bt_ctf_get_float(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_struct_field_index( + const struct bt_definition *field, uint64_t i); /* * bt_ctf_field_get_error: returns the last error code encountered while @@ -260,6 +272,11 @@ int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx, */ const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event); +/* + * bt_ctf_get_decl_event_id: return the event-ID of the event or -1ULL on error + */ +uint64_t bt_ctf_get_decl_event_id(const struct bt_ctf_event_decl *event); + /* * bt_ctf_get_decl_fields: get all field declarations in a scope of an event *