lib: update copyrights
[babeltrace.git] / lib / graph / notification / event.c
index 486a8b1018eb248780b3de2979ba75cc76f05ea2..038da740f46a3cc8a1ceaa6764e3123907ec3600 100644 (file)
@@ -1,10 +1,7 @@
 /*
- * Babeltrace Plug-in Event Notification
- *
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
 #include <babeltrace/lib-logging-internal.h>
 
 #include <babeltrace/compiler-internal.h>
-#include <babeltrace/ctf-ir/event.h>
-#include <babeltrace/ctf-ir/event-internal.h>
-#include <babeltrace/ctf-ir/event-class-internal.h>
-#include <babeltrace/ctf-ir/stream-class-internal.h>
-#include <babeltrace/ctf-ir/trace.h>
-#include <babeltrace/graph/clock-class-priority-map.h>
-#include <babeltrace/graph/clock-class-priority-map-internal.h>
+#include <babeltrace/object-internal.h>
+#include <babeltrace/trace-ir/event.h>
+#include <babeltrace/trace-ir/event-internal.h>
+#include <babeltrace/trace-ir/event-class-internal.h>
+#include <babeltrace/trace-ir/stream-class-internal.h>
+#include <babeltrace/trace-ir/trace.h>
+#include <babeltrace/graph/graph-internal.h>
+#include <babeltrace/graph/notification-event-const.h>
+#include <babeltrace/graph/notification-event.h>
 #include <babeltrace/graph/notification-event-internal.h>
 #include <babeltrace/types.h>
 #include <babeltrace/assert-internal.h>
 #include <babeltrace/assert-pre-internal.h>
+#include <babeltrace/object.h>
 #include <stdbool.h>
 #include <inttypes.h>
 
-static
-void bt_notification_event_destroy(struct bt_object *obj)
-{
-       struct bt_notification_event *notification =
-                       (struct bt_notification_event *) obj;
-
-       BT_LOGD("Destroying event notification: addr=%p", notification);
-       BT_LOGD_STR("Recycling event.");
-       bt_event_recycle(notification->event);
-       notification->event = NULL;
-       BT_LOGD_STR("Putting clock class priority map.");
-       BT_PUT(notification->cc_prio_map);
-       g_free(notification);
-}
-
 BT_ASSERT_PRE_FUNC
 static inline bool event_class_has_trace(struct bt_event_class *event_class)
 {
@@ -64,79 +49,136 @@ static inline bool event_class_has_trace(struct bt_event_class *event_class)
 
        stream_class = bt_event_class_borrow_stream_class(event_class);
        BT_ASSERT(stream_class);
-       return bt_stream_class_borrow_trace(stream_class) != NULL;
+       return bt_stream_class_borrow_trace_class(stream_class) != NULL;
+}
+
+BT_HIDDEN
+struct bt_notification *bt_notification_event_new(
+               struct bt_graph *graph)
+{
+       struct bt_notification_event *notification = NULL;
+
+       notification = g_new0(struct bt_notification_event, 1);
+       if (!notification) {
+               BT_LOGE_STR("Failed to allocate one event notification.");
+               goto error;
+       }
+
+       bt_notification_init(&notification->parent, BT_NOTIFICATION_TYPE_EVENT,
+               (bt_object_release_func) bt_notification_event_recycle, graph);
+       goto end;
+
+error:
+       BT_OBJECT_PUT_REF_AND_RESET(notification);
+
+end:
+       return (void *) notification;
 }
 
 struct bt_notification *bt_notification_event_create(
+               struct bt_self_notification_iterator *self_notif_iter,
                struct bt_event_class *event_class,
-               struct bt_packet *packet,
-               struct bt_clock_class_priority_map *cc_prio_map)
+               struct bt_packet *packet)
 {
+       struct bt_self_component_port_input_notification_iterator *notif_iter =
+               (void *) self_notif_iter;
        struct bt_notification_event *notification = NULL;
+       struct bt_event *event;
 
+       BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
        BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
-
-       if (cc_prio_map) {
-               /* Function's reference, released at the end */
-               bt_get(cc_prio_map);
-       } else {
-               cc_prio_map = bt_clock_class_priority_map_create();
-               if (!cc_prio_map) {
-                       BT_LOGE_STR("Cannot create empty clock class priority map.");
-                       goto error;
-               }
-       }
-
-       BT_ASSERT(cc_prio_map);
-       BT_LOGD("Creating event notification object: "
-               "event-class-addr=%p, "
-               "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
-               "cc-prio-map-addr=%p",
-               event_class,
-               bt_event_class_get_name(event_class),
-               bt_event_class_get_id(event_class), cc_prio_map);
-
        BT_ASSERT_PRE(event_class_has_trace(event_class),
                "Event class is not part of a trace: %!+E", event_class);
-       notification = g_new0(struct bt_notification_event, 1);
-       if (!notification) {
-               BT_LOGE_STR("Failed to allocate one event notification.");
+       BT_LIB_LOGD("Creating event notification object: %![ec-]+E",
+               event_class);
+       event = bt_event_create(event_class, packet);
+       if (unlikely(!event)) {
+               BT_LIB_LOGE("Cannot create event from event class: "
+                       "%![ec-]+E", event_class);
                goto error;
        }
 
-       bt_notification_init(&notification->parent, BT_NOTIFICATION_TYPE_EVENT,
-               bt_notification_event_destroy);
-       notification->event = bt_event_create(event_class, packet);
-       if (!notification->event) {
-               BT_LIB_LOGE("Cannot create event from event class: "
-                       "%![event-class-]+E", event_class);
+       /*
+        * Create notification from pool _after_ we have everything
+        * (in this case, a valid event object) so that we never have an
+        * error condition with a non-NULL notification object.
+        * Otherwise:
+        *
+        * * We cannot recycle the notification on error because
+        *   bt_notification_event_recycle() expects a complete
+        *   notification (and the event or clock class priority map
+        *   object could be unset).
+        *
+        * * We cannot destroy the notification because we would need
+        *   to notify the graph (pool owner) so that it removes the
+        *   notification from its notification array.
+        */
+       notification = (void *) bt_notification_create_from_pool(
+               &notif_iter->graph->event_notif_pool, notif_iter->graph);
+       if (unlikely(!notification)) {
+               /* bt_notification_create_from_pool() logs errors */
                goto error;
        }
 
-       notification->cc_prio_map = bt_get(cc_prio_map);
-       BT_LOGD_STR("Freezing event notification's clock class priority map.");
-       bt_clock_class_priority_map_freeze(notification->cc_prio_map);
-       BT_LOGD("Created event notification object: "
-               "event-addr=%p, event-class-addr=%p, "
-               "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
-               "cc-prio-map-addr=%p, notif-addr=%p",
-               notification->event, event_class,
-               bt_event_class_get_name(event_class),
-               bt_event_class_get_id(event_class), cc_prio_map,
-               notification);
+       BT_ASSERT(!notification->event);
+       notification->event = event;
+       bt_packet_set_is_frozen(packet, true);
+       bt_event_class_freeze(event_class);
+       BT_LIB_LOGD("Created event notification object: "
+               "%![notif-]+n, %![event-]+e", notification, event);
        goto end;
 
 error:
-       BT_PUT(notification);
+       BT_ASSERT(!notification);
+       bt_event_destroy(event);
 
 end:
-       bt_put(cc_prio_map);
-       return &notification->parent;
+       return (void *) notification;
 }
 
-struct bt_event *bt_notification_event_borrow_event(
-               struct bt_notification *notification)
+BT_HIDDEN
+void bt_notification_event_destroy(struct bt_notification *notif)
+{
+       struct bt_notification_event *event_notif = (void *) notif;
+
+       BT_LIB_LOGD("Destroying event notification: %!+n", notif);
+
+       if (event_notif->event) {
+               BT_LIB_LOGD("Recycling event: %!+e", event_notif->event);
+               bt_event_recycle(event_notif->event);
+               event_notif->event = NULL;
+       }
+
+       g_free(notif);
+}
+
+BT_HIDDEN
+void bt_notification_event_recycle(struct bt_notification *notif)
+{
+       struct bt_notification_event *event_notif = (void *) notif;
+       struct bt_graph *graph;
+
+       BT_ASSERT(event_notif);
+
+       if (unlikely(!notif->graph)) {
+               bt_notification_event_destroy(notif);
+               return;
+       }
+
+       BT_LIB_LOGD("Recycling event notification: %![notif-]+n, %![event-]+e",
+               notif, event_notif->event);
+       bt_notification_reset(notif);
+       BT_ASSERT(event_notif->event);
+       bt_event_recycle(event_notif->event);
+       event_notif->event = NULL;
+       graph = notif->graph;
+       notif->graph = NULL;
+       bt_object_pool_recycle_object(&graph->event_notif_pool, notif);
+}
+
+static inline
+struct bt_event *borrow_event(struct bt_notification *notification)
 {
        struct bt_notification_event *event_notification;
 
@@ -147,15 +189,14 @@ struct bt_event *bt_notification_event_borrow_event(
        return event_notification->event;
 }
 
-extern struct bt_clock_class_priority_map *
-bt_notification_event_borrow_clock_class_priority_map(
+struct bt_event *bt_notification_event_borrow_event(
                struct bt_notification *notification)
 {
-       struct bt_notification_event *event_notification;
+       return borrow_event(notification);
+}
 
-       BT_ASSERT_PRE_NON_NULL(notification, "Notification");
-       BT_ASSERT_PRE_NOTIF_IS_TYPE(notification, BT_NOTIFICATION_TYPE_EVENT);
-       event_notification = container_of(notification,
-                       struct bt_notification_event, parent);
-       return event_notification->cc_prio_map;
+const struct bt_event *bt_notification_event_borrow_event_const(
+               const struct bt_notification *notification)
+{
+       return borrow_event((void *) notification);
 }
This page took 0.025388 seconds and 4 git commands to generate.