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-PACKET"
9 #include "lib/logging.h"
13 #include "lib/assert-cond.h"
14 #include "compat/compiler.h"
15 #include <babeltrace2/trace-ir/packet.h>
16 #include "lib/trace-ir/packet.h"
17 #include <babeltrace2/trace-ir/stream-class.h>
18 #include <babeltrace2/trace-ir/stream.h>
19 #include "lib/trace-ir/stream.h"
20 #include "lib/trace-ir/stream-class.h"
21 #include "lib/graph/graph.h"
22 #include <babeltrace2/graph/message.h>
23 #include "common/assert.h"
24 #include "lib/object.h"
29 #define BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(_msg) \
30 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
31 "packet-beginning", BT_MESSAGE_TYPE_PACKET_BEGINNING)
33 #define BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(_msg) \
34 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
35 "packet-end", BT_MESSAGE_TYPE_PACKET_END)
37 #define BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_BEGINNING_DEF_CS(_msg) \
38 BT_ASSERT_PRE_DEV("msg-stream-class-packets-have-beginning-default-clock-snapshot", ({ \
39 const struct bt_packet *_packet = bt_message_packet_beginning_borrow_packet_const(_msg); \
40 const struct bt_stream *_stream = bt_packet_borrow_stream_const(_packet); \
41 const struct bt_stream_class *_stream_class = bt_stream_borrow_class_const(_stream); \
42 bt_stream_class_packets_have_beginning_default_clock_snapshot(_stream_class); \
43 }), "Packets of the message's stream don't have a beginning default clock snapshot.")
45 #define BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_END_DEF_CS(_msg) \
46 BT_ASSERT_PRE_DEV("msg-stream-class-packets-have-end-default-clock-snapshot", ({ \
47 const struct bt_packet *_packet = bt_message_packet_end_borrow_packet_const(_msg); \
48 const struct bt_stream *_stream = bt_packet_borrow_stream_const(_packet); \
49 const struct bt_stream_class *_stream_class = bt_stream_borrow_class_const(_stream); \
50 bt_stream_class_packets_have_end_default_clock_snapshot(_stream_class); \
51 }), "Packets of the message's stream don't have an end default clock snapshot.")
54 struct bt_message
*new_packet_message(struct bt_graph
*graph
,
55 enum bt_message_type type
, bt_object_release_func recycle_func
)
57 struct bt_message_packet
*message
;
59 message
= g_new0(struct bt_message_packet
, 1);
61 BT_LIB_LOGE_APPEND_CAUSE(
62 "Failed to allocate one packet message.");
66 bt_message_init(&message
->parent
, type
, recycle_func
, graph
);
70 BT_OBJECT_PUT_REF_AND_RESET(message
);
73 return (void *) message
;
77 struct bt_message
*bt_message_packet_beginning_new(struct bt_graph
*graph
)
79 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_BEGINNING
,
80 (bt_object_release_func
) bt_message_packet_beginning_recycle
);
84 struct bt_message
*bt_message_packet_end_new(struct bt_graph
*graph
)
86 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_END
,
87 (bt_object_release_func
) bt_message_packet_end_recycle
);
91 struct bt_message
*create_packet_message(
92 struct bt_message_iterator
*msg_iter
,
93 struct bt_packet
*packet
, struct bt_object_pool
*pool
,
94 bool with_cs
, uint64_t raw_value
, const char *api_func
)
96 struct bt_message_packet
*message
= NULL
;
97 struct bt_stream
*stream
;
98 struct bt_stream_class
*stream_class
;
102 BT_ASSERT_PRE_PACKET_NON_NULL_FROM_FUNC(api_func
, packet
);
103 stream
= bt_packet_borrow_stream(packet
);
105 stream_class
= bt_stream_borrow_class(stream
);
106 BT_ASSERT(stream_class
);
109 * It's not possible to create a packet from a stream of which
110 * the class indicates that packets are not supported.
112 BT_ASSERT(stream_class
->supports_packets
);
114 if (pool
== &msg_iter
->graph
->packet_begin_msg_pool
) {
115 need_cs
= stream_class
->packets_have_beginning_default_clock_snapshot
;
117 need_cs
= stream_class
->packets_have_end_default_clock_snapshot
;
121 * `packet_has_default_clock_snapshot` implies that the stream
122 * class has a default clock class (precondition).
124 BT_ASSERT_PRE_FROM_FUNC(api_func
, "with-default-clock-snapshot",
125 need_cs
? with_cs
: true,
126 "Unexpected stream class configuration when creating "
127 "a packet beginning or end message: "
128 "a default clock snapshot is needed, but none was provided: "
129 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
131 stream
, stream_class
, with_cs
, raw_value
);
132 BT_ASSERT_PRE_FROM_FUNC(api_func
, "without-default-clock-snapshot",
133 !need_cs
? !with_cs
: true,
134 "Unexpected stream class configuration when creating "
135 "a packet beginning or end message: "
136 "no default clock snapshot is needed, but one was provided: "
137 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
139 stream
, stream_class
, with_cs
, raw_value
);
140 BT_LIB_LOGD("Creating packet message object: "
141 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
142 packet
, stream
, stream_class
);
143 message
= (void *) bt_message_create_from_pool(pool
, msg_iter
->graph
);
145 /* bt_message_create_from_pool() logs errors */
150 BT_ASSERT(stream_class
->default_clock_class
);
151 message
->default_cs
= bt_clock_snapshot_create(
152 stream_class
->default_clock_class
);
153 if (!message
->default_cs
) {
154 bt_object_put_ref_no_null_check(message
);
159 bt_clock_snapshot_set_raw_value(message
->default_cs
, raw_value
);
162 BT_ASSERT(!message
->packet
);
163 message
->packet
= packet
;
164 bt_object_get_ref_no_null_check_no_parent_check(
165 &message
->packet
->base
);
166 bt_packet_set_is_frozen(packet
, true);
167 BT_LIB_LOGD("Created packet message object: "
168 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
169 message
, packet
, stream
, stream_class
);
173 return (void *) message
;
176 struct bt_message
*bt_message_packet_beginning_create(
177 struct bt_self_message_iterator
*self_msg_iter
,
178 const struct bt_packet
*packet
)
180 struct bt_message_iterator
*msg_iter
=
181 (void *) self_msg_iter
;
183 BT_ASSERT_PRE_DEV_NO_ERROR();
184 BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter
);
185 return create_packet_message(msg_iter
, (void *) packet
,
186 &msg_iter
->graph
->packet_begin_msg_pool
, false, 0, __func__
);
189 struct bt_message
*bt_message_packet_beginning_create_with_default_clock_snapshot(
190 struct bt_self_message_iterator
*self_msg_iter
,
191 const struct bt_packet
*packet
, uint64_t raw_value
)
193 struct bt_message_iterator
*msg_iter
=
194 (void *) self_msg_iter
;
196 BT_ASSERT_PRE_DEV_NO_ERROR();
197 BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter
);
198 return create_packet_message(msg_iter
, (void *) packet
,
199 &msg_iter
->graph
->packet_begin_msg_pool
, true, raw_value
,
203 struct bt_message
*bt_message_packet_end_create(
204 struct bt_self_message_iterator
*self_msg_iter
,
205 const struct bt_packet
*packet
)
207 struct bt_message_iterator
*msg_iter
=
208 (void *) self_msg_iter
;
210 BT_ASSERT_PRE_DEV_NO_ERROR();
211 BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter
);
212 return create_packet_message(msg_iter
, (void *) packet
,
213 &msg_iter
->graph
->packet_end_msg_pool
, false, 0, __func__
);
216 struct bt_message
*bt_message_packet_end_create_with_default_clock_snapshot(
217 struct bt_self_message_iterator
*self_msg_iter
,
218 const struct bt_packet
*packet
, uint64_t raw_value
)
220 struct bt_message_iterator
*msg_iter
=
221 (void *) self_msg_iter
;
223 BT_ASSERT_PRE_DEV_NO_ERROR();
224 BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter
);
225 return create_packet_message(msg_iter
, (void *) packet
,
226 &msg_iter
->graph
->packet_end_msg_pool
, true, raw_value
,
231 void bt_message_packet_destroy(struct bt_message
*msg
)
233 struct bt_message_packet
*packet_msg
= (void *) msg
;
235 BT_LIB_LOGD("Destroying packet message: %!+n", msg
);
236 BT_LIB_LOGD("Putting packet: %!+a", packet_msg
->packet
);
237 BT_OBJECT_PUT_REF_AND_RESET(packet_msg
->packet
);
239 if (packet_msg
->default_cs
) {
240 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
241 packet_msg
->default_cs
= NULL
;
248 void recycle_packet_message(struct bt_message
*msg
, struct bt_object_pool
*pool
)
250 struct bt_message_packet
*packet_msg
= (void *) msg
;
252 BT_LIB_LOGD("Recycling packet message: %!+n", msg
);
253 bt_message_reset(msg
);
254 bt_object_put_ref_no_null_check(&packet_msg
->packet
->base
);
256 if (packet_msg
->default_cs
) {
257 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
258 packet_msg
->default_cs
= NULL
;
261 packet_msg
->packet
= NULL
;
263 bt_object_pool_recycle_object(pool
, msg
);
267 void bt_message_packet_beginning_recycle(struct bt_message
*msg
)
271 if (G_UNLIKELY(!msg
->graph
)) {
272 bt_message_packet_destroy(msg
);
276 recycle_packet_message(msg
, &msg
->graph
->packet_begin_msg_pool
);
280 void bt_message_packet_end_recycle(struct bt_message
*msg
)
284 if (G_UNLIKELY(!msg
->graph
)) {
285 bt_message_packet_destroy(msg
);
289 recycle_packet_message(msg
, &msg
->graph
->packet_end_msg_pool
);
292 struct bt_packet
*bt_message_packet_beginning_borrow_packet(
293 struct bt_message
*message
)
295 struct bt_message_packet
*packet_msg
= (void *) message
;
297 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message
);
298 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(message
);
299 return packet_msg
->packet
;
302 const struct bt_packet
*bt_message_packet_beginning_borrow_packet_const(
303 const struct bt_message
*message
)
305 return bt_message_packet_beginning_borrow_packet(
309 struct bt_packet
*bt_message_packet_end_borrow_packet(
310 struct bt_message
*message
)
312 struct bt_message_packet
*packet_msg
= (void *) message
;
314 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message
);
315 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(message
);
316 return packet_msg
->packet
;
319 const struct bt_packet
*bt_message_packet_end_borrow_packet_const(
320 const struct bt_message
*message
)
322 return bt_message_packet_end_borrow_packet(
326 #define BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(_msg) \
327 BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS((_msg), \
328 ((struct bt_message_packet *) _msg)->packet->stream->class)
331 const struct bt_clock_snapshot
*
332 borrow_packet_message_default_clock_snapshot_const(
333 const struct bt_message
*message
)
335 struct bt_message_packet
*packet_msg
= (void *) message
;
337 BT_ASSERT_DBG(message
);
338 return packet_msg
->default_cs
;
341 const struct bt_clock_snapshot
*
342 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
343 const struct bt_message
*msg
)
345 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
346 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg
);
347 BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg
);
348 BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_BEGINNING_DEF_CS(msg
);
349 return borrow_packet_message_default_clock_snapshot_const(msg
);
352 const struct bt_clock_snapshot
*
353 bt_message_packet_end_borrow_default_clock_snapshot_const(
354 const struct bt_message
*msg
)
356 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
357 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg
);
358 BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg
);
359 BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_END_DEF_CS(msg
);
360 return borrow_packet_message_default_clock_snapshot_const(msg
);
364 const struct bt_clock_class
*
365 borrow_packet_message_stream_class_default_clock_class(
366 const struct bt_message
*msg
)
368 struct bt_message_packet
*packet_msg
= (void *) msg
;
371 return packet_msg
->packet
->stream
->class->default_clock_class
;
374 const struct bt_clock_class
*
375 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
376 const struct bt_message
*msg
)
378 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
379 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg
);
380 return borrow_packet_message_stream_class_default_clock_class(msg
);
383 const struct bt_clock_class
*
384 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
385 const struct bt_message
*msg
)
387 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
388 BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg
);
389 return borrow_packet_message_stream_class_default_clock_class(msg
);