Commit | Line | Data |
---|---|---|
d51202da JG |
1 | /* |
2 | * Babeltrace Plug-in Event Notification | |
3 | * | |
4 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
5 | * | |
6 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
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: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
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 | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
546a0c4a PP |
27 | #define BT_LOG_TAG "NOTIF-EVENT" |
28 | #include <babeltrace/lib-logging-internal.h> | |
29 | ||
3d9990ac | 30 | #include <babeltrace/compiler-internal.h> |
c5a24b0a | 31 | #include <babeltrace/object-internal.h> |
599faa1c | 32 | #include <babeltrace/ctf-ir/event.h> |
80f00602 | 33 | #include <babeltrace/ctf-ir/event-internal.h> |
d8a36e14 PP |
34 | #include <babeltrace/ctf-ir/event-class-internal.h> |
35 | #include <babeltrace/ctf-ir/stream-class-internal.h> | |
599faa1c | 36 | #include <babeltrace/ctf-ir/trace.h> |
f7c3ac09 | 37 | #include <babeltrace/graph/graph-internal.h> |
b2e0c907 | 38 | #include <babeltrace/graph/notification-event-internal.h> |
03e18d5d | 39 | #include <babeltrace/graph/private-connection-private-notification-iterator.h> |
c55a9f58 | 40 | #include <babeltrace/types.h> |
8b45963b PP |
41 | #include <babeltrace/assert-internal.h> |
42 | #include <babeltrace/assert-pre-internal.h> | |
a68c0f97 | 43 | #include <stdbool.h> |
546a0c4a | 44 | #include <inttypes.h> |
d51202da | 45 | |
8b45963b | 46 | BT_ASSERT_PRE_FUNC |
a6918753 | 47 | static inline bool event_class_has_trace(struct bt_event_class *event_class) |
a68c0f97 | 48 | { |
839d52a5 | 49 | struct bt_stream_class *stream_class; |
a68c0f97 | 50 | |
839d52a5 | 51 | stream_class = bt_event_class_borrow_stream_class(event_class); |
8b45963b | 52 | BT_ASSERT(stream_class); |
839d52a5 | 53 | return bt_stream_class_borrow_trace(stream_class) != NULL; |
a68c0f97 PP |
54 | } |
55 | ||
f7c3ac09 | 56 | BT_HIDDEN |
03e18d5d PP |
57 | struct bt_notification *bt_notification_event_new( |
58 | struct bt_graph *graph) | |
f7c3ac09 PP |
59 | { |
60 | struct bt_notification_event *notification = NULL; | |
61 | ||
62 | notification = g_new0(struct bt_notification_event, 1); | |
63 | if (!notification) { | |
64 | BT_LOGE_STR("Failed to allocate one event notification."); | |
65 | goto error; | |
66 | } | |
67 | ||
68 | bt_notification_init(¬ification->parent, BT_NOTIFICATION_TYPE_EVENT, | |
69 | (bt_object_release_func) bt_notification_event_recycle, graph); | |
70 | goto end; | |
71 | ||
72 | error: | |
73 | BT_PUT(notification); | |
74 | ||
75 | end: | |
76 | return (void *) notification; | |
77 | } | |
78 | ||
a6918753 | 79 | struct bt_notification *bt_notification_event_create( |
03e18d5d | 80 | struct bt_private_connection_private_notification_iterator *notif_iter, |
a6918753 | 81 | struct bt_event_class *event_class, |
8fc063a2 | 82 | struct bt_packet *packet) |
d51202da | 83 | { |
80f00602 | 84 | struct bt_notification_event *notification = NULL; |
c5a24b0a | 85 | struct bt_event *event; |
03e18d5d | 86 | struct bt_graph *graph; |
546a0c4a | 87 | |
03e18d5d | 88 | BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator"); |
a6918753 PP |
89 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
90 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); | |
546a0c4a | 91 | BT_LOGD("Creating event notification object: " |
a6918753 | 92 | "event-class-addr=%p, " |
8fc063a2 | 93 | "event-class-name=\"%s\", event-class-id=%" PRId64, |
a6918753 | 94 | event_class, |
839d52a5 | 95 | bt_event_class_get_name(event_class), |
8fc063a2 | 96 | bt_event_class_get_id(event_class)); |
a6918753 PP |
97 | BT_ASSERT_PRE(event_class_has_trace(event_class), |
98 | "Event class is not part of a trace: %!+E", event_class); | |
c5a24b0a PP |
99 | event = bt_event_create(event_class, packet); |
100 | if (unlikely(!event)) { | |
101 | BT_LIB_LOGE("Cannot create event from event class: " | |
102 | "%![event-class-]+E", event_class); | |
24626e8b JG |
103 | goto error; |
104 | } | |
546a0c4a | 105 | |
c5a24b0a PP |
106 | /* |
107 | * Create notification from pool _after_ we have everything | |
108 | * (in this case, a valid event object) so that we never have an | |
109 | * error condition with a non-NULL notification object. | |
110 | * Otherwise: | |
111 | * | |
112 | * * We cannot recycle the notification on error because | |
113 | * bt_notification_event_recycle() expects a complete | |
114 | * notification (and the event or clock class priority map | |
115 | * object could be unset). | |
116 | * | |
117 | * * We cannot destroy the notification because we would need | |
118 | * to notify the graph (pool owner) so that it removes the | |
119 | * notification from its notification array. | |
120 | */ | |
03e18d5d PP |
121 | graph = bt_private_connection_private_notification_iterator_borrow_graph( |
122 | notif_iter); | |
c5a24b0a PP |
123 | notification = (void *) bt_notification_create_from_pool( |
124 | &graph->event_notif_pool, graph); | |
125 | if (unlikely(!notification)) { | |
126 | /* bt_notification_create_from_pool() logs errors */ | |
a6918753 PP |
127 | goto error; |
128 | } | |
129 | ||
c5a24b0a PP |
130 | BT_ASSERT(!notification->event); |
131 | notification->event = event; | |
546a0c4a PP |
132 | BT_LOGD("Created event notification object: " |
133 | "event-addr=%p, event-class-addr=%p, " | |
134 | "event-class-name=\"%s\", event-class-id=%" PRId64 ", " | |
8fc063a2 | 135 | "notif-addr=%p", |
a6918753 | 136 | notification->event, event_class, |
839d52a5 | 137 | bt_event_class_get_name(event_class), |
8fc063a2 | 138 | bt_event_class_get_id(event_class), |
546a0c4a | 139 | notification); |
3fd45dc7 | 140 | goto end; |
546a0c4a | 141 | |
d51202da | 142 | error: |
c5a24b0a PP |
143 | BT_ASSERT(!notification); |
144 | bt_event_destroy(event); | |
3fd45dc7 PP |
145 | |
146 | end: | |
f7c3ac09 PP |
147 | return (void *) notification; |
148 | } | |
149 | ||
150 | BT_HIDDEN | |
151 | void bt_notification_event_destroy(struct bt_notification *notif) | |
152 | { | |
153 | struct bt_notification_event *event_notif = (void *) notif; | |
154 | ||
155 | BT_LOGD("Destroying event notification: addr=%p", notif); | |
156 | ||
157 | if (event_notif->event) { | |
158 | BT_LOGD_STR("Recycling event."); | |
159 | bt_event_recycle(event_notif->event); | |
160 | } | |
161 | ||
f7c3ac09 PP |
162 | g_free(notif); |
163 | } | |
164 | ||
165 | BT_HIDDEN | |
166 | void bt_notification_event_recycle(struct bt_notification *notif) | |
167 | { | |
168 | struct bt_notification_event *event_notif = (void *) notif; | |
169 | struct bt_graph *graph; | |
170 | ||
171 | BT_ASSERT(event_notif); | |
172 | ||
c5a24b0a | 173 | if (unlikely(!notif->graph)) { |
f7c3ac09 PP |
174 | bt_notification_event_destroy(notif); |
175 | return; | |
176 | } | |
177 | ||
178 | BT_LOGD("Recycling event notification: addr=%p", notif); | |
179 | bt_notification_reset(notif); | |
c5a24b0a PP |
180 | BT_ASSERT(event_notif->event); |
181 | BT_LOGD_STR("Recycling event."); | |
182 | bt_event_recycle(event_notif->event); | |
183 | event_notif->event = NULL; | |
f7c3ac09 PP |
184 | graph = notif->graph; |
185 | notif->graph = NULL; | |
186 | bt_object_pool_recycle_object(&graph->event_notif_pool, notif); | |
d51202da JG |
187 | } |
188 | ||
5fe68922 | 189 | struct bt_event *bt_notification_event_borrow_event( |
d51202da JG |
190 | struct bt_notification *notification) |
191 | { | |
192 | struct bt_notification_event *event_notification; | |
193 | ||
8b45963b PP |
194 | BT_ASSERT_PRE_NON_NULL(notification, "Notification"); |
195 | BT_ASSERT_PRE_NOTIF_IS_TYPE(notification, BT_NOTIFICATION_TYPE_EVENT); | |
d51202da JG |
196 | event_notification = container_of(notification, |
197 | struct bt_notification_event, parent); | |
5fe68922 | 198 | return event_notification->event; |
d51202da | 199 | } |