*/
#include <stdint.h>
-#include <babeltrace/iterator.h>
+#include <babeltrace/context.h>
-struct ctf_stream;
-struct ctf_stream_event;
struct definition;
-struct bt_ctf_iter;
+struct bt_ctf_event;
+struct bt_ctf_event_decl;
+struct bt_ctf_field_decl;
/*
* the top-level scopes in CTF
};
/*
- * the structure to manipulate events
+ * the supported CTF string encodings
*/
-struct bt_ctf_event {
- struct ctf_stream *stream;
- struct ctf_stream_event *event;
+enum ctf_string_encoding {
+ CTF_STRING_NONE = 0,
+ CTF_STRING_UTF8,
+ CTF_STRING_ASCII,
+ CTF_STRING_UNKNOWN,
};
-/*
- * bt_ctf_iter_read_event: Read the iterator's current event data.
- *
- * @iter: trace collection iterator (input)
- * @stream: stream containing event at current position (output)
- * @event: current event (output)
- * Return 0 on success, negative error value on error.
- */
-struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
-
-/*
- * bt_ctf_iter_create - Allocate a CTF trace collection iterator.
- *
- * begin_pos and end_pos are optional parameters to specify the position
- * at which the trace collection should be seeked upon iterator
- * creation, and the position at which iteration will start returning
- * "EOF".
- *
- * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
- * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
- * trace) is the EOF criterion.
- */
-struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
- struct bt_iter_pos *begin_pos,
- struct bt_iter_pos *end_pos);
-
-/*
- * bt_ctf_get_iter - get iterator from ctf iterator.
- */
-struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter);
-
-/*
- * bt_ctf_iter_destroy - Free a CTF trace collection iterator.
- */
-void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
-
/*
* bt_ctf_get_top_level_scope: return a definition of the top-level scope
*
* between the enum and the actual definition of top-level scopes.
* On error return NULL.
*/
-struct definition *bt_ctf_get_top_level_scope(struct bt_ctf_event *event,
+const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event,
enum bt_ctf_scope scope);
/*
* bt_ctf_event_get_name: returns the name of the event or NULL on error
*/
-const char *bt_ctf_event_name(struct bt_ctf_event *event);
+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
*/
-uint64_t bt_ctf_get_timestamp_raw(struct bt_ctf_event *event);
+uint64_t bt_ctf_get_timestamp_raw(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
*/
-uint64_t bt_ctf_get_timestamp(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
* pointers and set count to the number of elements in the array.
* Return 0 on success and a negative value on error.
*/
-int bt_ctf_get_field_list(struct bt_ctf_event *event,
- struct definition *scope,
+int bt_ctf_get_field_list(const struct bt_ctf_event *event,
+ const struct definition *scope,
struct definition const * const **list,
unsigned int *count);
/*
* bt_ctf_get_field: returns the definition of a specific field
*/
-struct definition *bt_ctf_get_field(struct bt_ctf_event *event,
- struct definition *scope,
+const struct definition *bt_ctf_get_field(const struct bt_ctf_event *event,
+ const struct 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;
*/
-struct definition *bt_ctf_get_index(struct bt_ctf_event *event,
- struct definition *field,
+const struct definition *bt_ctf_get_index(const struct bt_ctf_event *event,
+ const struct definition *field,
unsigned int index);
/*
*/
enum ctf_type_id bt_ctf_field_type(const struct definition *def);
+/*
+ * bt_ctf_get_int_signedness: return the signedness of an integer
+ *
+ * return 0 if unsigned
+ * return 1 if signed
+ * return -1 on error
+ */
+int bt_ctf_get_int_signedness(const struct definition *field);
+
+/*
+ * 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);
+
+/*
+ * 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);
+
+/*
+ * bt_ctf_get_encoding: return the encoding of an int or a string.
+ * return a negative value on error
+ */
+enum ctf_string_encoding bt_ctf_get_encoding(const struct definition *field);
+
+/*
+ * 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);
+
/*
* Field access functions
*
*/
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.
+ *
+ * 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 **list,
+ unsigned int *count);
+
+/*
+ * bt_ctf_get_decl_event_name: return the name of the event or NULL on error
+ */
+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);
+
#endif /* _BABELTRACE_CTF_EVENTS_H */
projects / babeltrace.git / blobdiff