/*
- * Babeltrace Plug-in Event Notification
- *
* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
#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("Putting event.");
- BT_PUT(notification->event);
- BT_LOGD_STR("Putting clock class priority map.");
- BT_PUT(notification->cc_prio_map);
- g_free(notification);
-}
-
-BT_ASSERT_PRE_FUNC static inline
-bt_bool validate_clock_classes(struct bt_notification_event *notif)
+BT_ASSERT_PRE_FUNC
+static inline bool event_class_has_trace(struct bt_event_class *event_class)
{
- /*
- * For each clock class found in the notification's clock class
- * priority map, make sure the event has a clock value set for
- * this clock class. Also make sure that those clock classes
- * are part of the trace to which the event belongs.
- */
- bt_bool is_valid = BT_TRUE;
-
- int trace_cc_count;
- int cc_prio_map_cc_count;
- size_t cc_prio_map_cc_i, trace_cc_i;
- struct bt_clock_value *clock_value = NULL;
- struct bt_clock_class *clock_class = NULL;
- struct bt_event_class *event_class = NULL;
- struct bt_stream_class *stream_class = NULL;
- struct bt_trace *trace = NULL;
+ struct bt_stream_class *stream_class;
- event_class = bt_event_borrow_event_class(notif->event);
- BT_ASSERT(event_class);
stream_class = bt_event_class_borrow_stream_class(event_class);
BT_ASSERT(stream_class);
- trace = bt_stream_class_borrow_trace(stream_class);
- BT_ASSERT(trace);
- trace_cc_count = bt_trace_get_clock_class_count(trace);
- BT_ASSERT(trace_cc_count >= 0);
- cc_prio_map_cc_count =
- bt_clock_class_priority_map_get_clock_class_count(
- notif->cc_prio_map);
- BT_ASSERT(cc_prio_map_cc_count >= 0);
+ return bt_stream_class_borrow_trace_class(stream_class) != NULL;
+}
- for (cc_prio_map_cc_i = 0; cc_prio_map_cc_i < cc_prio_map_cc_count;
- cc_prio_map_cc_i++) {
- bt_bool found_in_trace = BT_FALSE;
+BT_HIDDEN
+struct bt_notification *bt_notification_event_new(
+ struct bt_graph *graph)
+{
+ struct bt_notification_event *notification = NULL;
- clock_class =
- bt_clock_class_priority_map_get_clock_class_by_index(
- notif->cc_prio_map, cc_prio_map_cc_i);
- BT_ASSERT(clock_class);
- clock_value = bt_event_get_clock_value(notif->event,
- clock_class);
- if (!clock_value) {
- BT_ASSERT_PRE_MSG("Event has no clock value for a clock class which exists in the notification's clock class priority map: "
- "notif-addr=%p, event-addr=%p, "
- "event-class-addr=%p, event-class-name=\"%s\", "
- "event-class-id=%" PRId64 ", "
- "cc-prio-map-addr=%p, "
- "clock-class-addr=%p, clock-class-name=\"%s\"",
- notif, notif->event, event_class,
- bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class),
- notif->cc_prio_map, clock_class,
- bt_clock_class_get_name(clock_class));
- is_valid = BT_FALSE;
- goto end;
- }
+ notification = g_new0(struct bt_notification_event, 1);
+ if (!notification) {
+ BT_LOGE_STR("Failed to allocate one event notification.");
+ goto error;
+ }
- for (trace_cc_i = 0; trace_cc_i < trace_cc_count;
- trace_cc_i++) {
- struct bt_clock_class *trace_clock_class =
- bt_trace_get_clock_class_by_index(trace,
- trace_cc_i);
+ bt_notification_init(¬ification->parent, BT_NOTIFICATION_TYPE_EVENT,
+ (bt_object_release_func) bt_notification_event_recycle, graph);
+ goto end;
- BT_ASSERT(trace_clock_class);
- bt_put(trace_clock_class);
+error:
+ BT_OBJECT_PUT_REF_AND_RESET(notification);
- if (trace_clock_class == clock_class) {
- found_in_trace = BT_TRUE;
- break;
- }
- }
+end:
+ return (void *) notification;
+}
- if (!found_in_trace) {
- BT_ASSERT_PRE_MSG("A clock class found in the event notification's clock class priority map does not exist in the notification's event's trace: "
- "notif-addr=%p, trace-addr=%p, "
- "trace-name=\"%s\", cc-prio-map-addr=%p, "
- "clock-class-addr=%p, clock-class-name=\"%s\"",
- notif, trace, bt_trace_get_name(trace),
- notif->cc_prio_map, clock_class,
- bt_clock_class_get_name(clock_class));
- is_valid = BT_FALSE;
- goto end;
- }
+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_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");
+ BT_ASSERT_PRE(event_class_has_trace(event_class),
+ "Event class is not part of a trace: %!+E", event_class);
+ 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_PUT(clock_value);
- BT_PUT(clock_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(
+ ¬if_iter->graph->event_notif_pool, notif_iter->graph);
+ if (unlikely(!notification)) {
+ /* bt_notification_create_from_pool() logs errors */
+ goto error;
}
-end:
- bt_put(clock_value);
- bt_put(clock_class);
- return is_valid;
-}
+ 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;
-BT_ASSERT_PRE_FUNC
-static inline bool event_has_trace(struct bt_event *event)
-{
- struct bt_event_class *event_class;
- struct bt_stream_class *stream_class;
+error:
+ BT_ASSERT(!notification);
+ bt_event_destroy(event);
- event_class = bt_event_borrow_event_class(event);
- BT_ASSERT(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;
+end:
+ return (void *) notification;
}
-struct bt_notification *bt_notification_event_create(struct bt_event *event,
- struct bt_clock_class_priority_map *cc_prio_map)
+BT_HIDDEN
+void bt_notification_event_destroy(struct bt_notification *notif)
{
- struct bt_notification_event *notification = NULL;
- struct bt_event_class *event_class;
+ struct bt_notification_event *event_notif = (void *) notif;
- BT_ASSERT_PRE_NON_NULL(event, "Event");
+ BT_LIB_LOGD("Destroying event notification: %!+n", notif);
- 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;
- }
+ if (event_notif->event) {
+ BT_LIB_LOGD("Recycling event: %!+e", event_notif->event);
+ bt_event_recycle(event_notif->event);
+ event_notif->event = NULL;
}
- BT_ASSERT(cc_prio_map);
- event_class = bt_event_borrow_event_class(event);
- BT_ASSERT(event_class);
- BT_LOGD("Creating event notification object: "
- "event-addr=%p, event-class-addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
- "cc-prio-map-addr=%p",
- event, event_class,
- bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), cc_prio_map);
+ g_free(notif);
+}
- BT_ASSERT_PRE(bt_event_borrow_packet(event),
- "Event has no packet: %!+e", event);
- BT_ASSERT_PRE(event_has_trace(event),
- "Event has no trace: %!+e", event);
- notification = g_new0(struct bt_notification_event, 1);
- if (!notification) {
- BT_LOGE_STR("Failed to allocate one event notification.");
- goto error;
- }
+BT_HIDDEN
+void bt_notification_event_recycle(struct bt_notification *notif)
+{
+ struct bt_notification_event *event_notif = (void *) notif;
+ struct bt_graph *graph;
- bt_notification_init(¬ification->parent, BT_NOTIFICATION_TYPE_EVENT,
- bt_notification_event_destroy);
- notification->event = bt_get(event);
- notification->cc_prio_map = bt_get(cc_prio_map);
- BT_ASSERT_PRE(validate_clock_classes(notification),
- "Invalid clock classes: %![event-]+e", event);
- BT_LOGD_STR("Freezing event notification's event.");
- bt_event_freeze(notification->event);
- 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",
- event, event_class,
- bt_event_class_get_name(event_class),
- bt_event_class_get_id(event_class), cc_prio_map,
- notification);
- goto end;
+ BT_ASSERT(event_notif);
-error:
- BT_PUT(notification);
+ if (unlikely(!notif->graph)) {
+ bt_notification_event_destroy(notif);
+ return;
+ }
-end:
- bt_put(cc_prio_map);
- return ¬ification->parent;
+ 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);
}
-struct bt_event *bt_notification_event_get_event(
- struct bt_notification *notification)
+static inline
+struct bt_event *borrow_event(struct bt_notification *notification)
{
struct bt_notification_event *event_notification;
BT_ASSERT_PRE_NOTIF_IS_TYPE(notification, BT_NOTIFICATION_TYPE_EVENT);
event_notification = container_of(notification,
struct bt_notification_event, parent);
- return bt_get(event_notification->event);
+ return event_notification->event;
}
-extern struct bt_clock_class_priority_map *
-bt_notification_event_get_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 bt_get(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);
}