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("Putting event.");
53 BT_PUT(notification
->event
);
54 BT_LOGD_STR("Putting clock class priority map.");
55 BT_PUT(notification
->cc_prio_map
);
59 BT_ASSERT_PRE_FUNC
static inline
60 bt_bool
validate_clock_classes(struct bt_notification_event
*notif
)
63 * For each clock class found in the notification's clock class
64 * priority map, make sure the event has a clock value set for
65 * this clock class. Also make sure that those clock classes
66 * are part of the trace to which the event belongs.
68 bt_bool is_valid
= BT_TRUE
;
71 int cc_prio_map_cc_count
;
72 size_t cc_prio_map_cc_i
, trace_cc_i
;
73 struct bt_clock_value
*clock_value
= NULL
;
74 struct bt_clock_class
*clock_class
= NULL
;
75 struct bt_event_class
*event_class
= NULL
;
76 struct bt_stream_class
*stream_class
= NULL
;
77 struct bt_trace
*trace
= NULL
;
79 event_class
= bt_event_borrow_class(notif
->event
);
80 BT_ASSERT(event_class
);
81 stream_class
= bt_event_class_borrow_stream_class(event_class
);
82 BT_ASSERT(stream_class
);
83 trace
= bt_stream_class_borrow_trace(stream_class
);
85 trace_cc_count
= bt_trace_get_clock_class_count(trace
);
86 BT_ASSERT(trace_cc_count
>= 0);
87 cc_prio_map_cc_count
=
88 bt_clock_class_priority_map_get_clock_class_count(
90 BT_ASSERT(cc_prio_map_cc_count
>= 0);
92 for (cc_prio_map_cc_i
= 0; cc_prio_map_cc_i
< cc_prio_map_cc_count
;
94 bt_bool found_in_trace
= BT_FALSE
;
97 bt_clock_class_priority_map_get_clock_class_by_index(
98 notif
->cc_prio_map
, cc_prio_map_cc_i
);
99 BT_ASSERT(clock_class
);
100 clock_value
= bt_event_get_clock_value(notif
->event
,
103 BT_ASSERT_PRE_MSG("Event has no clock value for a clock class which exists in the notification's clock class priority map: "
104 "notif-addr=%p, event-addr=%p, "
105 "event-class-addr=%p, event-class-name=\"%s\", "
106 "event-class-id=%" PRId64
", "
107 "cc-prio-map-addr=%p, "
108 "clock-class-addr=%p, clock-class-name=\"%s\"",
109 notif
, notif
->event
, event_class
,
110 bt_event_class_get_name(event_class
),
111 bt_event_class_get_id(event_class
),
112 notif
->cc_prio_map
, clock_class
,
113 bt_clock_class_get_name(clock_class
));
118 for (trace_cc_i
= 0; trace_cc_i
< trace_cc_count
;
120 struct bt_clock_class
*trace_clock_class
=
121 bt_trace_get_clock_class_by_index(trace
,
124 BT_ASSERT(trace_clock_class
);
125 bt_put(trace_clock_class
);
127 if (trace_clock_class
== clock_class
) {
128 found_in_trace
= BT_TRUE
;
133 if (!found_in_trace
) {
134 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: "
135 "notif-addr=%p, trace-addr=%p, "
136 "trace-name=\"%s\", cc-prio-map-addr=%p, "
137 "clock-class-addr=%p, clock-class-name=\"%s\"",
138 notif
, trace
, bt_trace_get_name(trace
),
139 notif
->cc_prio_map
, clock_class
,
140 bt_clock_class_get_name(clock_class
));
156 static inline bool event_has_trace(struct bt_event
*event
)
158 struct bt_event_class
*event_class
;
159 struct bt_stream_class
*stream_class
;
161 event_class
= bt_event_borrow_class(event
);
162 BT_ASSERT(event_class
);
163 stream_class
= bt_event_class_borrow_stream_class(event_class
);
164 BT_ASSERT(stream_class
);
165 return bt_stream_class_borrow_trace(stream_class
) != NULL
;
168 struct bt_notification
*bt_notification_event_create(struct bt_event
*event
,
169 struct bt_clock_class_priority_map
*cc_prio_map
)
171 struct bt_notification_event
*notification
= NULL
;
172 struct bt_event_class
*event_class
;
174 BT_ASSERT_PRE_NON_NULL(event
, "Event");
177 /* Function's reference, released at the end */
180 cc_prio_map
= bt_clock_class_priority_map_create();
182 BT_LOGE_STR("Cannot create empty clock class priority map.");
187 BT_ASSERT(cc_prio_map
);
188 event_class
= bt_event_borrow_class(event
);
189 BT_ASSERT(event_class
);
190 BT_LOGD("Creating event notification object: "
191 "event-addr=%p, event-class-addr=%p, "
192 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
193 "cc-prio-map-addr=%p",
195 bt_event_class_get_name(event_class
),
196 bt_event_class_get_id(event_class
), cc_prio_map
);
198 BT_ASSERT_PRE(bt_event_borrow_packet(event
),
199 "Event has no packet: %!+e", event
);
200 BT_ASSERT_PRE(event_has_trace(event
),
201 "Event has no trace: %!+e", event
);
202 notification
= g_new0(struct bt_notification_event
, 1);
204 BT_LOGE_STR("Failed to allocate one event notification.");
208 bt_notification_init(¬ification
->parent
, BT_NOTIFICATION_TYPE_EVENT
,
209 bt_notification_event_destroy
);
210 notification
->event
= bt_get(event
);
211 notification
->cc_prio_map
= bt_get(cc_prio_map
);
212 BT_ASSERT_PRE(validate_clock_classes(notification
),
213 "Invalid clock classes: %![event-]+e", event
);
214 BT_LOGD_STR("Freezing event notification's event.");
215 bt_event_freeze(notification
->event
);
216 BT_LOGD_STR("Freezing event notification's clock class priority map.");
217 bt_clock_class_priority_map_freeze(notification
->cc_prio_map
);
218 BT_LOGD("Created event notification object: "
219 "event-addr=%p, event-class-addr=%p, "
220 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
221 "cc-prio-map-addr=%p, notif-addr=%p",
223 bt_event_class_get_name(event_class
),
224 bt_event_class_get_id(event_class
), cc_prio_map
,
229 BT_PUT(notification
);
233 return ¬ification
->parent
;
236 struct bt_event
*bt_notification_event_borrow_event(
237 struct bt_notification
*notification
)
239 struct bt_notification_event
*event_notification
;
241 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
242 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
, BT_NOTIFICATION_TYPE_EVENT
);
243 event_notification
= container_of(notification
,
244 struct bt_notification_event
, parent
);
245 return event_notification
->event
;
248 extern struct bt_clock_class_priority_map
*
249 bt_notification_event_borrow_clock_class_priority_map(
250 struct bt_notification
*notification
)
252 struct bt_notification_event
*event_notification
;
254 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
255 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
, BT_NOTIFICATION_TYPE_EVENT
);
256 event_notification
= container_of(notification
,
257 struct bt_notification_event
, parent
);
258 return event_notification
->cc_prio_map
;