Get rid of clock-raw and use real clock

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

diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h
index 73e6bc1aa9dc35cb23a14286f04d8e80773413c3..419c4c8df0f050635b4cd49d863c69266bbbd58a 100644 (file)
--- a/include/babeltrace/ctf/events.h
+++ b/include/babeltrace/ctf/events.h
@@ -25,10 +25,12 @@
 
 #include <stdint.h>
 #include <babeltrace/context.h>
+#include <babeltrace/clock-types.h>
 
 struct definition;
 struct bt_ctf_event;
 struct bt_ctf_event_decl;
+struct bt_ctf_field_decl;
 
 /*
  * the top-level scopes in CTF
@@ -88,16 +90,16 @@ const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *e
 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
+ * bt_ctf_get_cycles_timestamp: returns the timestamp of the event as written
+ * in the packet (in cycles) or -1ULL on error.
  */
-uint64_t bt_ctf_get_timestamp_raw(const struct bt_ctf_event *event);
+uint64_t bt_ctf_get_cycles_timestamp(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
+ * bt_ctf_get_real_timestamp: returns the timestamp of the event offsetted
+ * with the system clock source (in ns) or -1ULL on error
  */
-uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event);
+uint64_t bt_ctf_get_real_timestamp(const struct bt_ctf_event *event);
 
 /*
  * bt_ctf_get_field_list: set list pointer to an array of definition
@@ -154,6 +156,12 @@ int bt_ctf_get_int_base(const struct definition *field);
  */
 int bt_ctf_get_int_byte_order(const struct definition *field);
 
+/*
+ * 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);
+
 /*
  * bt_ctf_get_encoding: return the encoding of an int or a string.
  * return a negative value on error
@@ -195,7 +203,7 @@ int bt_ctf_field_get_error(void);
  * 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 * const **list,
+               struct bt_ctf_event_decl * const **list,
                unsigned int *count);
 
 /*
@@ -203,4 +211,20 @@ 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.
+ *
+ * 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 */