2 * Babeltrace Plug-in Event Notification
4 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #define BT_LOG_TAG "NOTIF-EVENT"
28 #include <babeltrace/lib-logging-internal.h>
30 #include <babeltrace/compiler-internal.h>
31 #include <babeltrace/ctf-ir/event.h>
32 #include <babeltrace/ctf-ir/event-internal.h>
33 #include <babeltrace/ctf-ir/event-class-internal.h>
34 #include <babeltrace/ctf-ir/stream-class-internal.h>
35 #include <babeltrace/ctf-ir/trace.h>
36 #include <babeltrace/graph/clock-class-priority-map.h>
37 #include <babeltrace/graph/clock-class-priority-map-internal.h>
38 #include <babeltrace/graph/notification-event-internal.h>
39 #include <babeltrace/types.h>
40 #include <babeltrace/assert-internal.h>
41 #include <babeltrace/assert-pre-internal.h>
46 void bt_notification_event_destroy(struct bt_object
*obj
)
48 struct bt_notification_event
*notification
=
49 (struct bt_notification_event
*) obj
;
51 BT_LOGD("Destroying event notification: addr=%p", notification
);
52 BT_LOGD_STR("Recycling event.");
53 bt_event_recycle(notification
->event
);
54 notification
->event
= NULL
;
55 BT_LOGD_STR("Putting clock class priority map.");
56 BT_PUT(notification
->cc_prio_map
);
61 static inline bool event_class_has_trace(struct bt_event_class
*event_class
)
63 struct bt_stream_class
*stream_class
;
65 stream_class
= bt_event_class_borrow_stream_class(event_class
);
66 BT_ASSERT(stream_class
);
67 return bt_stream_class_borrow_trace(stream_class
) != NULL
;
70 struct bt_notification
*bt_notification_event_create(
71 struct bt_event_class
*event_class
,
72 struct bt_packet
*packet
,
73 struct bt_clock_class_priority_map
*cc_prio_map
)
75 struct bt_notification_event
*notification
= NULL
;
77 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
78 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
81 /* Function's reference, released at the end */
84 cc_prio_map
= bt_clock_class_priority_map_create();
86 BT_LOGE_STR("Cannot create empty clock class priority map.");
91 BT_ASSERT(cc_prio_map
);
92 BT_LOGD("Creating event notification object: "
93 "event-class-addr=%p, "
94 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
95 "cc-prio-map-addr=%p",
97 bt_event_class_get_name(event_class
),
98 bt_event_class_get_id(event_class
), cc_prio_map
);
100 BT_ASSERT_PRE(event_class_has_trace(event_class
),
101 "Event class is not part of a trace: %!+E", event_class
);
102 notification
= g_new0(struct bt_notification_event
, 1);
104 BT_LOGE_STR("Failed to allocate one event notification.");
108 bt_notification_init(¬ification
->parent
, BT_NOTIFICATION_TYPE_EVENT
,
109 bt_notification_event_destroy
);
110 notification
->event
= bt_event_create(event_class
, packet
);
111 if (!notification
->event
) {
112 BT_LIB_LOGE("Cannot create event from event class: "
113 "%![event-class-]+E", event_class
);
117 notification
->cc_prio_map
= bt_get(cc_prio_map
);
118 BT_LOGD_STR("Freezing event notification's clock class priority map.");
119 bt_clock_class_priority_map_freeze(notification
->cc_prio_map
);
120 BT_LOGD("Created event notification object: "
121 "event-addr=%p, event-class-addr=%p, "
122 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
123 "cc-prio-map-addr=%p, notif-addr=%p",
124 notification
->event
, event_class
,
125 bt_event_class_get_name(event_class
),
126 bt_event_class_get_id(event_class
), cc_prio_map
,
131 BT_PUT(notification
);
135 return ¬ification
->parent
;
138 struct bt_event
*bt_notification_event_borrow_event(
139 struct bt_notification
*notification
)
141 struct bt_notification_event
*event_notification
;
143 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
144 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
, BT_NOTIFICATION_TYPE_EVENT
);
145 event_notification
= container_of(notification
,
146 struct bt_notification_event
, parent
);
147 return event_notification
->event
;
150 extern struct bt_clock_class_priority_map
*
151 bt_notification_event_borrow_clock_class_priority_map(
152 struct bt_notification
*notification
)
154 struct bt_notification_event
*event_notification
;
156 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
157 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
, BT_NOTIFICATION_TYPE_EVENT
);
158 event_notification
= container_of(notification
,
159 struct bt_notification_event
, parent
);
160 return event_notification
->cc_prio_map
;