#include <stdint.h>
-struct ctf_stream;
-struct ctf_stream_event;
struct definition;
+struct bt_ctf_event;
/*
* 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,
};
/*
* 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: returns the timestamp of the event or -1ULL on error
+ * 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(struct bt_ctf_event *event);
+uint64_t bt_ctf_get_timestamp_raw(const struct bt_ctf_event *event);
/*
- * bt_ctf_get_field_list: returns an array of *def pointing to each field of
- * the event. The array is NULL terminated.
- * On error : return NULL.
+ * bt_ctf_get_timestamp: returns the timestamp of the event offsetted with the
+ * system clock source or -1ULL on error
*/
-int bt_ctf_get_field_list(struct bt_ctf_event *event,
- struct definition *scope,
+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(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);
/*
/*
* bt_ctf_field_type: returns the type of a field or -1 if unknown
*/
-enum ctf_type_id bt_ctf_field_type(struct definition *def);
+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
* returned is undefined. To check if an error occured, use the
* bt_ctf_field_error() function after accessing a field.
*/
-uint64_t bt_ctf_get_uint64(struct definition *field);
-int64_t bt_ctf_get_int64(struct definition *field);
-char *bt_ctf_get_char_array(struct definition *field);
-char *bt_ctf_get_string(struct definition *field);
+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);
/*
* bt_ctf_field_error: returns the last error code encountered while