lib: merge common CTF IR part with the remaining implementation

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

diff --git a/include/babeltrace/ctf-ir/stream-class-internal.h b/include/babeltrace/ctf-ir/stream-class-internal.h
index 0a1420d5dee824117427aa7c9a087e471a31aa3e..6a167c9371267cf2302844cf46ca6de1f5b7ad3a 100644 (file)
--- a/include/babeltrace/ctf-ir/stream-class-internal.h
+++ b/include/babeltrace/ctf-ir/stream-class-internal.h
@@ -4,7 +4,7 @@
 /*
  * BabelTrace - CTF IR: Stream class internal
  *
- * Copyright 2013 EfficiOS Inc.
+ * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,45 +27,102 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/ctf-writer/ref-internal.h>
-#include <babeltrace/ctf-writer/clock.h>
-#include <babeltrace/ctf-writer/event-fields.h>
-#include <babeltrace/ctf-writer/event-types.h>
+#include <babeltrace/assert-internal.h>
+#include <babeltrace/common-internal.h>
+#include <babeltrace/ctf-ir/validation-internal.h>
+#include <babeltrace/ctf-ir/field-types-internal.h>
+#include <babeltrace/ctf-ir/utils-internal.h>
+#include <babeltrace/ctf-ir/visitor.h>
+#include <babeltrace/ctf-ir/stream-class.h>
+#include <babeltrace/object-internal.h>
+#include <babeltrace/object-pool-internal.h>
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ctf/types.h>
 #include <glib.h>
+#include <inttypes.h>
 
-struct bt_ctf_stream_class {
-       struct bt_ctf_ref ref_count;
+struct bt_stream_class {
+       struct bt_object base;
        GString *name;
-       struct bt_ctf_clock *clock;
-       GPtrArray *event_classes; /* Array of pointers to bt_ctf_event_class */
+
+       /* Array of pointers to event class addresses */
+       GPtrArray *event_classes;
+
+       /* event class id (int64_t) to event class address */
+       GHashTable *event_classes_ht;
        int id_set;
-       uint32_t id;
-       uint32_t next_event_id;
-       uint32_t next_stream_id;
-       struct bt_ctf_field_type *event_header_type;
-       struct bt_ctf_field *event_header;
-       struct bt_ctf_field_type *packet_context_type;
-       struct bt_ctf_field *packet_context;
-       struct bt_ctf_field_type *event_context_type;
-       struct bt_ctf_field *event_context;
+       int64_t id;
+       int64_t next_event_id;
+       struct bt_field_type *packet_context_field_type;
+       struct bt_field_type *event_header_field_type;
+       struct bt_field_type *event_context_field_type;
        int frozen;
+       int byte_order;
+
+       /*
+        * This flag indicates if the stream class is valid. A valid
+        * stream class is _always_ frozen.
+        */
+       int valid;
+
+       /*
+        * Unique clock class mapped to any field type within this
+        * stream class, including all the stream class's event class
+        * field types. This is only set if the stream class is frozen.
+        *
+        * If the stream class is frozen and this is still NULL, it is
+        * still possible that it becomes non-NULL because
+        * bt_stream_class_add_event_class() can add an event class
+        * containing a field type mapped to some clock class. In this
+        * case, this is the mapped clock class, and at this point, both
+        * the new event class and the stream class are frozen, so the
+        * next added event classes are expected to contain field types
+        * which only map to this specific clock class.
+        *
+        * If this is a CTF writer stream class, then this is the
+        * backing clock class of the `clock` member above.
+        */
+       struct bt_clock_class *clock_class;
+
+       /* Pool of `struct bt_field_wrapper *` */
+       struct bt_object_pool event_header_field_pool;
+
+       /* Pool of `struct bt_field_wrapper *` */
+       struct bt_object_pool packet_context_field_pool;
 };
 
-BT_HIDDEN
-void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class *stream_class);
+struct bt_event_class;
 
 BT_HIDDEN
-int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
-               uint32_t id);
+void bt_stream_class_freeze(struct bt_stream_class *stream_class);
 
 BT_HIDDEN
-int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
-               struct metadata_context *context);
+int bt_stream_class_validate_single_clock_class(
+               struct bt_stream_class *stream_class,
+               struct bt_clock_class **expected_clock_class);
 
 BT_HIDDEN
-int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class *stream_class,
-               enum bt_ctf_byte_order byte_order);
+int bt_stream_class_visit(struct bt_stream_class *stream_class,
+               bt_visitor visitor, void *data);
+
+static inline
+void _bt_stream_class_set_id(
+               struct bt_stream_class *stream_class, int64_t id)
+{
+       BT_ASSERT(stream_class);
+       stream_class->id = id;
+       stream_class->id_set = 1;
+       BT_LOGV("Set stream class's ID (internal): "
+               "addr=%p, name=\"%s\", id=%" PRId64,
+               stream_class, bt_stream_class_get_name(stream_class),
+               bt_stream_class_get_id(stream_class));
+}
+
+static inline
+int bt_stream_class_set_id_no_check(
+               struct bt_stream_class *stream_class, int64_t id)
+{
+       _bt_stream_class_set_id(stream_class, id);
+       return 0;
+}
 
 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */