2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #define BT_LOG_TAG "LIB/MSG-EVENT"
9 #include "lib/logging.h"
11 #include "common/assert.h"
12 #include "lib/assert-cond.h"
13 #include "compat/compiler.h"
14 #include "lib/object.h"
15 #include <babeltrace2/trace-ir/event.h>
16 #include "lib/trace-ir/event.h"
17 #include "lib/trace-ir/event-class.h"
18 #include "lib/trace-ir/stream-class.h"
19 #include <babeltrace2/trace-ir/trace.h>
20 #include "lib/trace-ir/clock-snapshot.h"
21 #include "lib/graph/graph.h"
22 #include <babeltrace2/graph/message.h>
23 #include <babeltrace2/types.h>
29 #define BT_ASSERT_PRE_DEV_MSG_IS_EVENT(_msg) \
30 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), "event", \
31 BT_MESSAGE_TYPE_EVENT)
33 struct bt_message
*bt_message_event_new(
34 struct bt_graph
*graph
)
36 struct bt_message_event
*message
= NULL
;
38 message
= g_new0(struct bt_message_event
, 1);
40 BT_LIB_LOGE_APPEND_CAUSE(
41 "Failed to allocate one event message.");
45 bt_message_init(&message
->parent
, BT_MESSAGE_TYPE_EVENT
,
46 (bt_object_release_func
) bt_message_event_recycle
, graph
);
50 BT_OBJECT_PUT_REF_AND_RESET(message
);
53 return (void *) message
;
57 struct bt_event
*create_event(struct bt_event_class
*event_class
,
58 struct bt_packet
*packet
, struct bt_stream
*stream
,
61 struct bt_event
*event
= NULL
;
63 BT_ASSERT_DBG(event_class
);
64 BT_ASSERT_DBG(stream
);
65 event
= bt_object_pool_create_object(&event_class
->event_pool
);
66 if (G_UNLIKELY(!event
)) {
67 BT_LIB_LOGE_APPEND_CAUSE(
68 "Cannot allocate one event from event class's event pool: "
69 "%![ec-]+E", event_class
);
73 if (G_LIKELY(!event
->class)) {
74 event
->class = event_class
;
75 bt_object_get_ref_no_null_check(&event_class
->base
);
78 BT_ASSERT_DBG(!event
->stream
);
79 event
->stream
= stream
;
80 bt_object_get_ref_no_null_check_no_parent_check(&event
->stream
->base
);
81 BT_LIB_LOGD("Set event's stream: %![event-]+e, %![stream-]+s",
85 BT_ASSERT_PRE_DEV_FROM_FUNC(api_func
,
86 "packet-stream-class-is-event-class-stream-class",
87 bt_event_class_borrow_stream_class(
88 event_class
) == packet
->stream
->class,
89 "Packet's stream class and event class's stream class differ: "
90 "%![ec-]+E, %![packet-]+a", event
, packet
);
91 BT_ASSERT_DBG(event
->stream
->class->supports_packets
);
92 BT_ASSERT_DBG(!event
->packet
);
93 event
->packet
= packet
;
94 bt_object_get_ref_no_null_check_no_parent_check(&event
->packet
->base
);
95 BT_LIB_LOGD("Set event's packet: %![event-]+e, %![packet-]+a",
104 struct bt_message
*create_event_message(
105 struct bt_self_message_iterator
*self_msg_iter
,
106 const struct bt_event_class
*c_event_class
,
107 const struct bt_packet
*c_packet
,
108 const struct bt_stream
*c_stream
, bool with_cs
,
109 uint64_t raw_value
, const char *api_func
)
111 struct bt_message_iterator
*msg_iter
=
112 (void *) self_msg_iter
;
113 struct bt_message_event
*message
= NULL
;
114 struct bt_event_class
*event_class
= (void *) c_event_class
;
115 struct bt_stream_class
*stream_class
;
116 struct bt_packet
*packet
= (void *) c_packet
;
117 struct bt_stream
*stream
= (void *) c_stream
;
118 struct bt_event
*event
;
120 BT_ASSERT_DBG(stream
);
121 BT_ASSERT_PRE_MSG_ITER_NON_NULL_FROM_FUNC(api_func
, msg_iter
);
122 BT_ASSERT_PRE_EC_NON_NULL_FROM_FUNC(api_func
, event_class
);
123 stream_class
= bt_event_class_borrow_stream_class_inline(event_class
);
124 BT_ASSERT_PRE_FROM_FUNC(api_func
,
125 "stream-class-is-event-class-stream-class",
126 bt_event_class_borrow_stream_class(event_class
) ==
128 "Stream's class and event's stream class differ: "
129 "%![ec-]+E, %![stream-]+s", event_class
, stream
);
130 BT_ASSERT_DBG(stream_class
);
131 BT_ASSERT_PRE_FROM_FUNC(api_func
,
132 "with-default-clock-snapshot-if-stream-class-has-default-clock-class",
133 (with_cs
&& stream_class
->default_clock_class
) ||
134 (!with_cs
&& !stream_class
->default_clock_class
),
135 "Creating an event message with a default clock snapshot, but without "
136 "a default clock class, or without a default clock snapshot, "
137 "but with a default clock class: ",
138 "%![ec-]+E, %![sc-]+S, with-cs=%d, "
140 event_class
, stream_class
, with_cs
, raw_value
);
141 BT_LIB_LOGD("Creating event message object: %![ec-]+E", event_class
);
142 event
= create_event(event_class
, packet
, stream
, api_func
);
143 if (G_UNLIKELY(!event
)) {
144 BT_LIB_LOGE_APPEND_CAUSE(
145 "Cannot create event from event class: "
146 "%![ec-]+E", event_class
);
151 * Create message from pool _after_ we have everything
152 * (in this case, a valid event object) so that we never have an
153 * error condition with a non-NULL message object.
156 * * We cannot recycle the message on error because
157 * bt_message_event_recycle() expects a complete
158 * message (and the event or clock class priority map
159 * object could be unset).
161 * * We cannot destroy the message because we would need
162 * to notify the graph (pool owner) so that it removes the
163 * message from its message array.
165 message
= (void *) bt_message_create_from_pool(
166 &msg_iter
->graph
->event_msg_pool
, msg_iter
->graph
);
167 if (G_UNLIKELY(!message
)) {
168 /* bt_message_create_from_pool() logs errors */
173 BT_ASSERT_DBG(stream_class
->default_clock_class
);
174 message
->default_cs
= bt_clock_snapshot_create(
175 stream_class
->default_clock_class
);
176 if (!message
->default_cs
) {
180 bt_clock_snapshot_set_raw_value(message
->default_cs
, raw_value
);
183 BT_ASSERT_DBG(!message
->event
);
184 message
->event
= event
;
187 bt_packet_set_is_frozen(packet
, true);
190 bt_stream_freeze(stream
);
191 bt_event_class_freeze(event_class
);
192 BT_LIB_LOGD("Created event message object: "
193 "%![msg-]+n, %![event-]+e", message
, event
);
198 bt_event_destroy(event
);
201 return (void *) message
;
205 struct bt_message
*bt_message_event_create(
206 struct bt_self_message_iterator
*msg_iter
,
207 const struct bt_event_class
*event_class
,
208 const struct bt_stream
*stream
)
210 BT_ASSERT_PRE_DEV_NO_ERROR();
211 BT_ASSERT_PRE_STREAM_NON_NULL(stream
);
212 return create_event_message(msg_iter
, event_class
, NULL
, stream
,
217 struct bt_message
*bt_message_event_create_with_packet(
218 struct bt_self_message_iterator
*msg_iter
,
219 const struct bt_event_class
*event_class
,
220 const struct bt_packet
*packet
)
222 BT_ASSERT_PRE_DEV_NO_ERROR();
223 BT_ASSERT_PRE_PACKET_NON_NULL(packet
);
224 return create_event_message(msg_iter
, event_class
, packet
,
225 packet
->stream
, false, 0, __func__
);
229 struct bt_message
*bt_message_event_create_with_default_clock_snapshot(
230 struct bt_self_message_iterator
*msg_iter
,
231 const struct bt_event_class
*event_class
,
232 const struct bt_stream
*stream
,
235 BT_ASSERT_PRE_DEV_NO_ERROR();
236 BT_ASSERT_PRE_STREAM_NON_NULL(stream
);
237 return create_event_message(msg_iter
, event_class
, NULL
, stream
,
238 true, raw_value
, __func__
);
243 bt_message_event_create_with_packet_and_default_clock_snapshot(
244 struct bt_self_message_iterator
*msg_iter
,
245 const struct bt_event_class
*event_class
,
246 const struct bt_packet
*packet
,
249 BT_ASSERT_PRE_DEV_NO_ERROR();
250 BT_ASSERT_PRE_PACKET_NON_NULL(packet
);
251 return create_event_message(msg_iter
, event_class
, packet
,
252 packet
->stream
, true, raw_value
, __func__
);
255 void bt_message_event_destroy(struct bt_message
*msg
)
257 struct bt_message_event
*event_msg
= (void *) msg
;
259 BT_LIB_LOGD("Destroying event message: %!+n", msg
);
261 if (event_msg
->event
) {
262 BT_LIB_LOGD("Recycling event: %!+e", event_msg
->event
);
263 bt_event_recycle(event_msg
->event
);
264 event_msg
->event
= NULL
;
267 if (event_msg
->default_cs
) {
268 bt_clock_snapshot_recycle(event_msg
->default_cs
);
269 event_msg
->default_cs
= NULL
;
275 void bt_message_event_recycle(struct bt_message
*msg
)
277 struct bt_message_event
*event_msg
= (void *) msg
;
278 struct bt_graph
*graph
;
280 BT_ASSERT_DBG(event_msg
);
282 if (G_UNLIKELY(!msg
->graph
)) {
283 bt_message_event_destroy(msg
);
287 BT_LIB_LOGD("Recycling event message: %![msg-]+n, %![event-]+e",
288 msg
, event_msg
->event
);
289 bt_message_reset(msg
);
290 BT_ASSERT_DBG(event_msg
->event
);
291 bt_event_recycle(event_msg
->event
);
292 event_msg
->event
= NULL
;
294 if (event_msg
->default_cs
) {
295 bt_clock_snapshot_recycle(event_msg
->default_cs
);
296 event_msg
->default_cs
= NULL
;
301 bt_object_pool_recycle_object(&graph
->event_msg_pool
, msg
);
304 #define BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(_msg) \
306 BT_ASSERT_PRE_DEV_MSG_NON_NULL(_msg); \
307 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(_msg); \
311 struct bt_event
*borrow_event(struct bt_message
*message
)
313 struct bt_message_event
*event_message
;
315 event_message
= container_of(message
,
316 struct bt_message_event
, parent
);
317 return event_message
->event
;
321 struct bt_event
*bt_message_event_borrow_event(
322 struct bt_message
*message
)
324 BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(message
);
325 return borrow_event(message
);
329 const struct bt_event
*bt_message_event_borrow_event_const(
330 const struct bt_message
*message
)
332 BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(message
);
333 return borrow_event((void *) message
);
337 const struct bt_clock_snapshot
*
338 bt_message_event_borrow_default_clock_snapshot_const(
339 const struct bt_message
*msg
)
341 struct bt_message_event
*event_msg
= (void *) msg
;
342 struct bt_stream_class
*stream_class
;
344 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
345 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(msg
);
346 stream_class
= bt_event_class_borrow_stream_class_inline(
347 event_msg
->event
->class);
348 BT_ASSERT_DBG(stream_class
);
349 BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS(msg
, stream_class
);
350 return event_msg
->default_cs
;
354 const bt_clock_class
*
355 bt_message_event_borrow_stream_class_default_clock_class_const(
356 const bt_message
*msg
)
358 struct bt_message_event
*event_msg
= (void *) msg
;
359 struct bt_stream_class
*stream_class
;
361 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
362 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(msg
);
363 stream_class
= bt_event_class_borrow_stream_class_inline(
364 event_msg
->event
->class);
365 BT_ASSERT_DBG(stream_class
);
366 return stream_class
->default_clock_class
;
This page took 0.038512 seconds and 4 git commands to generate.