* SOFTWARE.
*/
-#include <babeltrace/ctf-writer/event-types.h>
-#include <babeltrace/ctf-writer/event-fields.h>
+/* Protection: this file uses BT_LIB_LOG*() macros directly */
+#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
+# error Please define include <babeltrace/lib-logging-internal.h> before including this file.
+#endif
+
+#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/values.h>
-#include <babeltrace/ctf/types.h>
+#include <babeltrace/ctf-ir/clock-value-internal.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/field-wrapper-internal.h>
#include <babeltrace/object-internal.h>
+#include <babeltrace/assert-internal.h>
#include <glib.h>
-struct bt_ctf_event {
+#define BT_ASSERT_PRE_EVENT_HOT(_event) \
+ BT_ASSERT_PRE_HOT((_event), "Event", ": %!+e", (_event))
+
+struct bt_event {
struct bt_object base;
- struct bt_ctf_event_class *event_class;
- struct bt_ctf_field *event_header;
- struct bt_ctf_field *stream_event_context;
- struct bt_ctf_field *context_payload;
- struct bt_ctf_field *fields_payload;
+ struct bt_event_class *class;
+ struct bt_packet *packet;
+ struct bt_field_wrapper *header_field;
+ struct bt_field *common_context_field;
+ struct bt_field *specific_context_field;
+ struct bt_field *payload_field;
+ struct bt_clock_value *default_cv;
+ bool frozen;
};
BT_HIDDEN
-int bt_ctf_event_validate(struct bt_ctf_event *event);
+void bt_event_destroy(struct bt_event *event);
BT_HIDDEN
-int bt_ctf_event_serialize(struct bt_ctf_event *event,
- struct ctf_stream_pos *pos);
+struct bt_event *bt_event_new(struct bt_event_class *event_class);
-/*
- * Attempt to populate the "id" and "timestamp" fields of the event header if
- * they are present, unset and their types are integers.
- *
- * Not finding these fields or encountering unexpected types is not an error
- * since the user may have defined a different event header layout. In this
- * case, it is expected that the fields be manually populated before appending
- * an event to a stream.
- */
BT_HIDDEN
-int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
+void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen);
+
+#ifdef BT_DEV_MODE
+# define bt_event_set_is_frozen _bt_event_set_is_frozen
+#else
+# define bt_event_set_is_frozen(_event, _is_frozen)
+#endif
+
+BT_UNUSED
+static inline
+void _bt_event_reset_dev_mode(struct bt_event *event)
+{
+ BT_ASSERT(event);
+
+ if (event->header_field) {
+ bt_field_set_is_frozen(
+ event->header_field->field, false);
+ bt_field_reset(
+ event->header_field->field);
+ }
+
+ if (event->common_context_field) {
+ bt_field_set_is_frozen(
+ event->common_context_field, false);
+ bt_field_reset(
+ event->common_context_field);
+ }
+
+ if (event->specific_context_field) {
+ bt_field_set_is_frozen(
+ event->specific_context_field, false);
+ bt_field_reset(event->specific_context_field);
+ }
+
+ if (event->payload_field) {
+ bt_field_set_is_frozen(
+ event->payload_field, false);
+ bt_field_reset(event->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
+
+static inline
+void bt_event_reset(struct bt_event *event)
+{
+ BT_ASSERT(event);
+ BT_LIB_LOGD("Resetting event: %!+e", event);
+ bt_event_set_is_frozen(event, false);
+
+ if (event->default_cv) {
+ bt_clock_value_reset(event->default_cv);
+ }
+
+ 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 = event->class;
+ BT_ASSERT(event_class);
+ event->class = NULL;
+ bt_object_pool_recycle_object(&event_class->event_pool, event);
+ bt_object_put_no_null_check(&event_class->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_HOT(event);
+ BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
+ event->class) == packet->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_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a",
+ event, 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: "
+ "%![ec-]+E", event_class);
+ goto end;
+ }
+
+ if (likely(!event->class)) {
+ event->class = event_class;
+ bt_object_get_no_null_check(&event_class->base);
+ }
+
+ BT_ASSERT(packet);
+ bt_event_set_packet(event, packet);
+ goto end;
+
+end:
+ return event;
+}
#endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */
projects / babeltrace.git / blobdiff