X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fevents.h;h=c81d8852f83207881524129b1186d7a946c7f225;hp=4232feb3cd202c7ea118cf45333aad1b71d3faea;hb=3a068915df64d2480d176ae58913f9d04d72f87c;hpb=d40ee8ec4ac9998f69383218762662ba01e89513 diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index 4232feb3..c81d8852 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -21,13 +21,26 @@ * * 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 #include #include -struct definition; +#ifdef __cplusplus +extern "C" { +#endif + +struct bt_definition; +struct bt_declaration; struct bt_ctf_event; struct bt_ctf_event_decl; struct bt_ctf_field_decl; @@ -81,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); /* @@ -102,39 +115,62 @@ uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *event); 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 top-level scope of an event or 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, - 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 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 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 definition *def); +enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *decl); /* * bt_ctf_get_int_signedness: return the signedness of an integer @@ -143,36 +179,43 @@ 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 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 definition *field); +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 definition *field); +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 definition *field); +ssize_t bt_ctf_get_int_len(const struct bt_declaration *decl); /* - * bt_ctf_get_encoding: return the encoding of an int or a string. + * 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 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 definition *field); +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 @@ -182,25 +225,41 @@ 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); -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_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. */ int bt_ctf_field_get_error(void); /* - * bt_ctf_get_event_decl_list: set list pointer to an array of bt_ctf_event_decl - * pointers and set count to the number of elements in the array. + * bt_ctf_get_event_decl_list: get a list of all the event declarations in + * a trace. + * + * The list array is pointed to the array of event declarations. + * The number of events in the array is written in count. * * 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 trace is opened. */ int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx, struct bt_ctf_event_decl * const **list, @@ -212,10 +271,15 @@ 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. + * bt_ctf_get_decl_fields: get all field declarations in a scope of an event + * + * The list array is pointed to the array of field declaration. + * The number of field declaration in the array is written in count. * * Returns 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 trace is opened. */ int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl, enum bt_ctf_scope scope, @@ -227,4 +291,8 @@ int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl, */ const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); +#ifdef __cplusplus +} +#endif + #endif /* _BABELTRACE_CTF_EVENTS_H */