1 #ifndef _BABELTRACE_CTF_EVENTS_H
2 #define _BABELTRACE_CTF_EVENTS_H
9 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
14 * Permission is hereby granted, free of charge, to any person obtaining
15 * a copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sublicense, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be
23 * included in all copies or substantial portions of the Software.
27 #include <babeltrace/context.h>
31 struct bt_ctf_event_decl
;
32 struct bt_ctf_field_decl
;
35 * the top-level scopes in CTF
38 BT_TRACE_PACKET_HEADER
= 0,
39 BT_STREAM_PACKET_CONTEXT
= 1,
40 BT_STREAM_EVENT_HEADER
= 2,
41 BT_STREAM_EVENT_CONTEXT
= 3,
47 * the supported CTF types
56 CTF_TYPE_UNTAGGED_VARIANT
,
64 * the supported CTF string encodings
66 enum ctf_string_encoding
{
74 * bt_ctf_get_top_level_scope: return a definition of the top-level scope
76 * Top-level scopes are defined in the bt_ctf_scope enum.
77 * In order to get a field or a field list, the user needs to pass a
78 * scope as argument, this scope can be a top-level scope or a scope
79 * relative to an arbitrary field. This function provides the mapping
80 * between the enum and the actual definition of top-level scopes.
81 * On error return NULL.
83 const struct definition
*bt_ctf_get_top_level_scope(const struct bt_ctf_event
*event
,
84 enum bt_ctf_scope scope
);
87 * bt_ctf_event_get_name: returns the name of the event or NULL on error
89 const char *bt_ctf_event_name(const struct bt_ctf_event
*event
);
92 * bt_ctf_get_timestamp_raw: returns the timestamp of the event as written in
93 * the packet or -1ULL on error
95 uint64_t bt_ctf_get_timestamp_raw(const struct bt_ctf_event
*event
);
98 * bt_ctf_get_timestamp: returns the timestamp of the event offsetted with the
99 * system clock source or -1ULL on error
101 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event
*event
);
104 * bt_ctf_get_field_list: set list pointer to an array of definition
105 * pointers and set count to the number of elements in the array.
106 * Return 0 on success and a negative value on error.
108 int bt_ctf_get_field_list(const struct bt_ctf_event
*event
,
109 const struct definition
*scope
,
110 struct definition
const * const **list
,
111 unsigned int *count
);
114 * bt_ctf_get_field: returns the definition of a specific field
116 const struct definition
*bt_ctf_get_field(const struct bt_ctf_event
*event
,
117 const struct definition
*scope
,
121 * bt_ctf_get_index: if the field is an array or a sequence, return the element
122 * at position index, otherwise return NULL;
124 const struct definition
*bt_ctf_get_index(const struct bt_ctf_event
*event
,
125 const struct definition
*field
,
129 * bt_ctf_field_name: returns the name of a field or NULL on error
131 const char *bt_ctf_field_name(const struct definition
*def
);
134 * bt_ctf_field_type: returns the type of a field or -1 if unknown
136 enum ctf_type_id
bt_ctf_field_type(const struct definition
*def
);
139 * bt_ctf_get_int_signedness: return the signedness of an integer
141 * return 0 if unsigned
145 int bt_ctf_get_int_signedness(const struct definition
*field
);
148 * bt_ctf_get_int_base: return the base of an int or a negative value on error
150 int bt_ctf_get_int_base(const struct definition
*field
);
153 * bt_ctf_get_int_byte_order: return the byte order of an int or a negative
156 int bt_ctf_get_int_byte_order(const struct definition
*field
);
159 * bt_ctf_get_int_len: return the size, in bits, of an int or a negative
162 ssize_t
bt_ctf_get_int_len(const struct definition
*field
);
165 * bt_ctf_get_encoding: return the encoding of an int or a string.
166 * return a negative value on error
168 enum ctf_string_encoding
bt_ctf_get_encoding(const struct definition
*field
);
171 * bt_ctf_get_array_len: return the len of an array or a negative
174 int bt_ctf_get_array_len(const struct definition
*field
);
177 * Field access functions
179 * These functions return the value associated with the field passed in
182 * If the field does not exist or is not of the type requested, the value
183 * returned is undefined. To check if an error occured, use the
184 * bt_ctf_field_error() function after accessing a field.
186 uint64_t bt_ctf_get_uint64(const struct definition
*field
);
187 int64_t bt_ctf_get_int64(const struct definition
*field
);
188 char *bt_ctf_get_char_array(const struct definition
*field
);
189 char *bt_ctf_get_string(const struct definition
*field
);
192 * bt_ctf_field_error: returns the last error code encountered while
193 * accessing a field and reset the error flag.
194 * Return 0 if no error, a negative value otherwise.
196 int bt_ctf_field_get_error(void);
199 * bt_ctf_get_event_decl_list: set list pointer to an array of bt_ctf_event_decl
200 * pointers and set count to the number of elements in the array.
202 * Return 0 on success and a negative value on error.
204 int bt_ctf_get_event_decl_list(int handle_id
, struct bt_context
*ctx
,
205 struct bt_ctf_event_decl
* const **list
,
206 unsigned int *count
);
209 * bt_ctf_get_decl_event_name: return the name of the event or NULL on error
211 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl
*event
);
214 * bt_ctf_get_decl_fields: set list pointer to an array of bt_ctf_field_decl
215 * pointers and set count to the number of elements in the array.
217 * Returns 0 on success and a negative value on error
219 int bt_ctf_get_decl_fields(struct bt_ctf_event_decl
*event_decl
,
220 enum bt_ctf_scope scope
,
221 struct bt_ctf_field_decl
const * const **list
,
222 unsigned int *count
);
225 * bt_ctf_get_decl_field_name: return the name of a field decl or NULL on error
227 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl
*field
);
229 #endif /* _BABELTRACE_CTF_EVENTS_H */