Add the concept of a static trace

[babeltrace.git] / include / babeltrace / ctf-ir / trace-internal.h

diff --git a/include/babeltrace/ctf-ir/trace-internal.h b/include/babeltrace/ctf-ir/trace-internal.h
index 227120dc86817097b8a84ecba2e507d34ca2ec8f..8b6c1f5a45ec6e99850b3c0de3a9478bb91a56e5 100644 (file)
--- a/include/babeltrace/ctf-ir/trace-internal.h
+++ b/include/babeltrace/ctf-ir/trace-internal.h
@@ -28,8 +28,8 @@
  */
 
 #include <babeltrace/ctf-ir/trace.h>
-#include <babeltrace/ctf-ir/event-types.h>
-#include <babeltrace/ctf-ir/event-fields.h>
+#include <babeltrace/ctf-ir/field-types.h>
+#include <babeltrace/ctf-ir/fields.h>
 #include <babeltrace/object-internal.h>
 #include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/values.h>
@@ -49,15 +49,25 @@ enum field_type_alias {
 
 struct bt_ctf_trace {
        struct bt_object base;
+       GString *name;
        int frozen;
        uuid_t uuid;
-       int byte_order; /* A value defined in Babeltrace's "endian.h" */
+       enum bt_ctf_byte_order native_byte_order;
        struct bt_value *environment;
-       GPtrArray *clocks; /* Array of pointers to bt_ctf_clock */
+       GPtrArray *clocks; /* Array of pointers to bt_ctf_clock_class */
        GPtrArray *stream_classes; /* Array of ptrs to bt_ctf_stream_class */
        GPtrArray *streams; /* Array of ptrs to bt_ctf_stream */
        struct bt_ctf_field_type *packet_header_type;
        uint64_t next_stream_id;
+       int is_created_by_writer;
+
+       /*
+        * This flag indicates if the trace is valid. A valid
+        * trace is _always_ frozen.
+        */
+       int valid;
+       GPtrArray *listeners; /* Array of struct listener_wrapper */
+       bool is_static;
 };
 
 struct metadata_context {
@@ -72,4 +82,43 @@ const char *get_byte_order_string(int byte_order);
 BT_HIDDEN
 struct bt_ctf_field_type *get_field_type(enum field_type_alias alias);
 
+BT_HIDDEN
+int bt_ctf_trace_object_modification(struct bt_ctf_object *object,
+               void *trace_ptr);
+
+BT_HIDDEN
+bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace *trace,
+               struct bt_ctf_clock_class *clock_class);
+
+/**
+@brief User function type to use with bt_ctf_trace_add_listener().
+
+@param[in] obj New CTF IR object which is part of the trace
+               class hierarchy.
+@param[in] data        User data.
+
+@prenotnull{obj}
+*/
+typedef void (*bt_ctf_listener_cb)(struct bt_ctf_object *obj, void *data);
+
+/**
+@brief Adds the trace class modification listener \p listener to
+       the CTF IR trace class \p trace_class.
+
+Once you add \p listener to \p trace_class, whenever \p trace_class
+is modified, \p listener is called with the new element and with
+\p data (user data).
+
+@param[in] trace_class Trace class to which to add \p listener.
+@param[in] listener    Modification listener function.
+@param[in] data                User data.
+@returns               0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{listener}
+@postrefcountsame{trace_class}
+*/
+extern int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace_class,
+               bt_ctf_listener_cb listener, void *data);
+
 #endif /* BABELTRACE_CTF_IR_TRACE_INTERNAL_H */