lib: remove clock class priority map, use default clock value
[babeltrace.git] / include / babeltrace / ctf-ir / event-internal.h
index 43a77a23069ef92a115e2f954303cb33b3de2911..f1d09205feee70669b9a2c9caab3a0c6bedf7511 100644 (file)
 #include <babeltrace/values.h>
 #include <babeltrace/ctf-ir/stream-class.h>
 #include <babeltrace/ctf-ir/stream.h>
+#include <babeltrace/ctf-ir/stream-internal.h>
 #include <babeltrace/ctf-ir/packet.h>
+#include <babeltrace/ctf-ir/packet-internal.h>
 #include <babeltrace/ctf-ir/fields.h>
 #include <babeltrace/ctf-ir/fields-internal.h>
 #include <babeltrace/ctf-ir/event-class-internal.h>
+#include <babeltrace/ctf-ir/clock-value-set-internal.h>
 #include <babeltrace/ctf-ir/field-wrapper-internal.h>
 #include <babeltrace/ctf-ir/validation-internal.h>
 #include <babeltrace/object-internal.h>
@@ -56,9 +59,7 @@ struct bt_event_common {
 
 struct bt_event {
        struct bt_event_common common;
-
-       /* Maps clock classes to bt_clock_value. */
-       GHashTable *clock_values;
+       struct bt_clock_value_set cv_set;
        struct bt_packet *packet;
 };
 
@@ -66,23 +67,24 @@ BT_HIDDEN
 int _bt_event_common_validate(struct bt_event_common *event);
 
 BT_HIDDEN
-void _bt_event_common_freeze(struct bt_event_common *event);
+void _bt_event_common_set_is_frozen(struct bt_event_common *event,
+               bool is_frozen);
 
 BT_HIDDEN
-void _bt_event_freeze(struct bt_event *event);
+void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen);
 
 #ifdef BT_DEV_MODE
-# define bt_event_common_validate              _bt_event_common_validate
-# define bt_event_common_freeze                        _bt_event_common_freeze
-# define bt_event_freeze                       _bt_event_freeze
+# define bt_event_common_validate      _bt_event_common_validate
+# define bt_event_common_set_is_frozen _bt_event_common_set_is_frozen
+# define bt_event_set_is_frozen                _bt_event_set_is_frozen
 #else
-# define bt_event_common_validate(_event)      0
-# define bt_event_common_freeze(_event)
-# define bt_event_freeze(_event)
+# define bt_event_common_validate(_event)                      0
+# define bt_event_common_set_is_frozen(_event, _is_frozen)
+# define bt_event_set_is_frozen(_event, _is_frozen)
 #endif
 
 #define BT_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name)                  \
-       BT_ASSERT_PRE_HOT((_event), (_name), ": +%!+_e", (_event))
+       BT_ASSERT_PRE_HOT((_event), (_name), ": %!+_e", (_event))
 
 static inline
 struct bt_event_class_common *bt_event_common_borrow_class(
@@ -101,7 +103,7 @@ BT_HIDDEN
 int bt_event_common_initialize(struct bt_event_common *event,
                struct bt_event_class_common *event_class,
                struct bt_clock_class *init_expected_clock_class,
-               bt_object_release_func release_func,
+               bool is_shared_with_parent, bt_object_release_func release_func,
                bt_validation_flag_copy_field_type_func field_type_copy_func,
                bool must_be_in_trace,
                int (*map_clock_classes_func)(struct bt_stream_class_common *stream_class,
@@ -248,20 +250,147 @@ void bt_event_common_finalize(struct bt_object *obj,
        }
 }
 
-BT_HIDDEN
-struct bt_event *bt_event_new(struct bt_event_class *event_class);
+BT_UNUSED
+static inline
+void _bt_event_reset_dev_mode(struct bt_event *event)
+{
+       BT_ASSERT(event);
 
-BT_HIDDEN
-struct bt_event *bt_event_create(struct bt_event_class *event_class,
-               struct bt_packet *packet);
+       if (event->common.header_field) {
+               bt_field_common_set_is_frozen_recursive(
+                       event->common.header_field->field, false);
+               bt_field_common_reset_recursive(
+                       event->common.header_field->field);
+       }
 
-BT_HIDDEN
-void bt_event_recycle(struct bt_event *event);
+       if (event->common.stream_event_context_field) {
+               bt_field_common_set_is_frozen_recursive(
+                       event->common.stream_event_context_field, false);
+               bt_field_common_reset_recursive(
+                       event->common.stream_event_context_field);
+       }
+
+       if (event->common.context_field) {
+               bt_field_common_set_is_frozen_recursive(
+                       event->common.context_field, false);
+               bt_field_common_reset_recursive(event->common.context_field);
+       }
+
+       if (event->common.payload_field) {
+               bt_field_common_set_is_frozen_recursive(
+                       event->common.payload_field, false);
+               bt_field_common_reset_recursive(event->common.payload_field);
+       }
+}
+
+#ifdef BT_DEV_MODE
+# define bt_event_reset_dev_mode       _bt_event_reset_dev_mode
+#else
+# define bt_event_reset_dev_mode(_x)
+#endif
 
 BT_HIDDEN
 void bt_event_destroy(struct bt_event *event);
 
+static inline
+void bt_event_reset(struct bt_event *event)
+{
+       BT_ASSERT(event);
+       bt_event_set_is_frozen(event, false);
+       bt_clock_value_set_reset(&event->cv_set);
+       bt_object_put_no_null_check(&event->packet->base);
+       event->packet = NULL;
+}
+
+static inline
+void bt_event_recycle(struct bt_event *event)
+{
+       struct bt_event_class *event_class;
+
+       BT_ASSERT(event);
+       BT_LIB_LOGD("Recycling event: %!+e", event);
+
+       /*
+        * Those are the important ordered steps:
+        *
+        * 1. Reset the event object (put any permanent reference it
+        *    has, unfreeze it and its fields in developer mode, etc.),
+        *    but do NOT put its class's reference. This event class
+        *    contains the pool to which we're about to recycle this
+        *    event object, so we must guarantee its existence thanks
+        *    to this existing reference.
+        *
+        * 2. Move the event class reference to our `event_class`
+        *    variable so that we can set the event's class member
+        *    to NULL before recycling it. We CANNOT do this after
+        *    we put the event class reference because this bt_put()
+        *    could destroy the event class, also destroying its
+        *    event pool, thus also destroying our event object (this
+        *    would result in an invalid write access).
+        *
+        * 3. Recycle the event object.
+        *
+        * 4. Put our event class reference.
+        */
+       bt_event_reset(event);
+       event_class = BT_FROM_COMMON(event->common.class);
+       BT_ASSERT(event_class);
+       event->common.class = NULL;
+       bt_object_pool_recycle_object(&event_class->event_pool, event);
+       bt_object_put_no_null_check(&event_class->common.base);
+}
+
+static inline
+void bt_event_set_packet(struct bt_event *event, struct bt_packet *packet)
+{
+       BT_ASSERT_PRE_NON_NULL(event, "Event");
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_EVENT_COMMON_HOT(BT_TO_COMMON(event), "Event");
+       BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
+               BT_FROM_COMMON(event->common.class)) ==
+               BT_FROM_COMMON(packet->stream->common.stream_class),
+               "Packet's stream class and event's stream class differ: "
+               "%![event-]+e, %![packet-]+a",
+               event, packet);
+
+       BT_ASSERT(!event->packet);
+       event->packet = packet;
+       bt_object_get_no_null_check_no_parent_check(&event->packet->base);
+       BT_LOGV("Set event's packet: event-addr=%p, "
+               "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
+               "packet-addr=%p",
+               event, bt_event_class_common_get_name(event->common.class),
+               bt_event_class_common_get_id(event->common.class), packet);
+}
+
+static inline
+struct bt_event *bt_event_create(struct bt_event_class *event_class,
+               struct bt_packet *packet)
+{
+       struct bt_event *event = NULL;
+
+       BT_ASSERT(event_class);
+       event = bt_object_pool_create_object(&event_class->event_pool);
+       if (unlikely(!event)) {
+               BT_LIB_LOGE("Cannot allocate one event from event class's event pool: "
+                       "%![event-class-]+E", event_class);
+               goto end;
+       }
+
+       if (unlikely(!event->common.class)) {
+               event->common.class = BT_TO_COMMON(event_class);
+               bt_object_get_no_null_check(&event_class->common.base);
+       }
+
+       BT_ASSERT(packet);
+       bt_event_set_packet(event, packet);
+       goto end;
+
+end:
+       return event;
+}
+
 BT_HIDDEN
-int bt_event_set_packet(struct bt_event *event, struct bt_packet *packet);
+struct bt_event *bt_event_new(struct bt_event_class *event_class);
 
 #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */
This page took 0.028042 seconds and 4 git commands to generate.