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 d0ec3e10615b3beefcee75bff226cc58431eacc0..419c4c8df0f050635b4cd49d863c69266bbbd58a 100644 (file)
--- a/include/babeltrace/ctf/events.h
+++ b/include/babeltrace/ctf/events.h
@@ -24,10 +24,13 @@
  */
 
 #include <stdint.h>
+#include <babeltrace/context.h>
+#include <babeltrace/clock-types.h>
 
-struct ctf_stream;
-struct ctf_stream_event;
 struct definition;
+struct bt_ctf_event;
+struct bt_ctf_event_decl;
+struct bt_ctf_field_decl;
 
 /*
  * the top-level scopes in CTF
@@ -68,14 +71,6 @@ enum ctf_string_encoding {
        CTF_STRING_UNKNOWN,
 };
 
-/*
- * the structure to manipulate events
- */
-struct bt_ctf_event {
-       struct ctf_stream *stream;
-       struct ctf_stream_event *event;
-};
-
 /*
  * bt_ctf_get_top_level_scope: return a definition of the top-level scope
  *
@@ -86,49 +81,49 @@ struct bt_ctf_event {
  * 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
+ * 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(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(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
  * 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);
 
 /*
@@ -161,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,4 +196,35 @@ char *bt_ctf_get_string(const struct definition *field);
  */
 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 */