X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fevents.h;h=461cf06ccdd9c63040e45719f1a48b88154e6f29;hp=73e6bc1aa9dc35cb23a14286f04d8e80773413c3;hb=c22b9327cbc4e6d9053f998952ea71c3227b8e36;hpb=e003ab503def7b0db6c130cccbc03685adb32bbb diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index 73e6bc1a..461cf06c 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -25,10 +25,17 @@ #include #include +#include + +#ifdef __cplusplus +extern "C" { +#endif struct definition; +struct declaration; struct bt_ctf_event; struct bt_ctf_event_decl; +struct bt_ctf_field_decl; /* * the top-level scopes in CTF @@ -88,21 +95,31 @@ const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *e const char *bt_ctf_event_name(const struct bt_ctf_event *event); /* - * bt_ctf_get_timestamp_raw: returns the timestamp of the event as written in - * the packet or -1ULL on error + * bt_ctf_get_cycles: returns the timestamp of the event as written + * in the packet (in cycles) or -1ULL on error. */ -uint64_t bt_ctf_get_timestamp_raw(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 or -1ULL on error + * bt_ctf_get_timestamp: returns the timestamp of the event offsetted + * with the system clock source (in ns) or -1ULL on error */ uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event); /* - * bt_ctf_get_field_list: set list pointer to an array of definition + * bt_ctf_get_field_list: obtain the list of fields for compound type + * + * This function can be used to obtain the list of fields + * contained within a compound type: array, sequence, + * structure, or variant. + + * This function sets the "list" pointer to an array of definition * pointers and set count to the number of elements in the array. * Return 0 on success and a negative value on error. + * + * The content pointed to by "list" should *not* be freed. It stays + * valid as long as the event is unchanged (as long as the iterator + * from which the event is extracted is unchanged). */ int bt_ctf_get_field_list(const struct bt_ctf_event *event, const struct definition *scope, @@ -129,10 +146,23 @@ const struct definition *bt_ctf_get_index(const struct bt_ctf_event *event, */ const char *bt_ctf_field_name(const struct 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); + +/* + * 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_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 definition *def); +enum ctf_type_id bt_ctf_field_type(const struct declaration *decl); /* * bt_ctf_get_int_signedness: return the signedness of an integer @@ -141,30 +171,37 @@ enum ctf_type_id bt_ctf_field_type(const struct definition *def); * return 1 if signed * return -1 on error */ -int bt_ctf_get_int_signedness(const struct definition *field); +int bt_ctf_get_int_signedness(const struct 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 definition *field); +int bt_ctf_get_int_base(const struct 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 definition *field); +int bt_ctf_get_int_byte_order(const struct declaration *decl); /* - * bt_ctf_get_encoding: return the encoding of an int or a string. + * 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); + +/* + * 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 definition *field); +enum ctf_string_encoding bt_ctf_get_encoding(const struct 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 definition *field); +int bt_ctf_get_array_len(const struct declaration *decl); /* * Field access functions @@ -174,15 +211,21 @@ int bt_ctf_get_array_len(const struct definition *field); * * If the field does not exist or is not of the type requested, the value * returned is undefined. To check if an error occured, use the - * bt_ctf_field_error() function after accessing a field. + * bt_ctf_field_get_error() function after accessing a field. + * + * bt_ctf_get_enum_int gets the integer field of an enumeration. + * 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); /* - * bt_ctf_field_error: returns the last error code encountered while + * bt_ctf_field_get_error: returns the last error code encountered while * accessing a field and reset the error flag. * Return 0 if no error, a negative value otherwise. */ @@ -195,7 +238,7 @@ int bt_ctf_field_get_error(void); * Return 0 on success and a negative value on error. */ int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx, - struct bt_ctf_event_decl const * const **list, + struct bt_ctf_event_decl * const **list, unsigned int *count); /* @@ -203,4 +246,24 @@ 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_fields: set list pointer to an array of bt_ctf_field_decl + * pointers and set count to the number of elements in the array. + * + * Returns 0 on success and a negative value on error + */ +int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl, + enum bt_ctf_scope scope, + struct bt_ctf_field_decl const * const **list, + unsigned int *count); + +/* + * bt_ctf_get_decl_field_name: return the name of a field decl or NULL on error + */ +const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); + +#ifdef __cplusplus +} +#endif + #endif /* _BABELTRACE_CTF_EVENTS_H */