Fix API : functions to access fields properties

[babeltrace.git] / include / babeltrace / ctf / events.h

diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h
index eb644125c69a9875b0875c9f60aa7fecd5ad5824..a08518b8a0e0aad7cc29485a283508816d4626e4 100644 (file)
--- a/include/babeltrace/ctf/events.h
+++ b/include/babeltrace/ctf/events.h
@@ -24,10 +24,12 @@
  */
 
 #include <stdint.h>
+#include <babeltrace/iterator.h>
 
 struct ctf_stream;
 struct ctf_stream_event;
 struct definition;
+struct bt_ctf_iter;
 
 /*
  * the top-level scopes in CTF
@@ -58,6 +60,16 @@ enum ctf_type_id {
        NR_CTF_TYPES,
 };
 
+/*
+ * the supported CTF string encodings
+ */
+enum ctf_string_encoding {
+       CTF_STRING_NONE = 0,
+       CTF_STRING_UTF8,
+       CTF_STRING_ASCII,
+       CTF_STRING_UNKNOWN,
+};
+
 /*
  * the structure to manipulate events
  */
@@ -66,6 +78,42 @@ struct bt_ctf_event {
        struct ctf_stream_event *event;
 };
 
+/*
+ * 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
  *
@@ -85,14 +133,21 @@ struct definition *bt_ctf_get_top_level_scope(struct bt_ctf_event *event,
 const char *bt_ctf_event_name(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_raw(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);
 
 /*
- * 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_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,
@@ -122,7 +177,39 @@ const char *bt_ctf_field_name(const struct definition *def);
 /*
  * 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
@@ -134,10 +221,10 @@ enum ctf_type_id bt_ctf_field_type(struct definition *def);
  * 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