Commit | Line | Data |
---|---|---|
d6e69534 | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
d6e69534 PP |
4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
d6e69534 PP |
6 | */ |
7 | ||
350ad6c1 | 8 | #define BT_LOG_TAG "LIB/MSG-PACKET" |
c2d9d9cf | 9 | #include "lib/logging.h" |
d6e69534 | 10 | |
c4f23e30 FD |
11 | #include <stdbool.h> |
12 | ||
d98421f2 | 13 | #include "lib/assert-cond.h" |
578e048b | 14 | #include "compat/compiler.h" |
3fadfbc0 | 15 | #include <babeltrace2/trace-ir/packet.h> |
578e048b | 16 | #include "lib/trace-ir/packet.h" |
3fadfbc0 MJ |
17 | #include <babeltrace2/trace-ir/stream-class.h> |
18 | #include <babeltrace2/trace-ir/stream.h> | |
578e048b MJ |
19 | #include "lib/trace-ir/stream.h" |
20 | #include "lib/trace-ir/stream-class.h" | |
21 | #include "lib/graph/graph.h" | |
43c59509 | 22 | #include <babeltrace2/graph/message.h> |
578e048b | 23 | #include "common/assert.h" |
578e048b | 24 | #include "lib/object.h" |
d6e69534 PP |
25 | #include <inttypes.h> |
26 | ||
578e048b MJ |
27 | #include "packet.h" |
28 | ||
1778c2a4 PP |
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) | |
32 | ||
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) | |
36 | ||
d4f19030 SM |
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.") | |
44 | ||
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.") | |
52 | ||
5df26c89 PP |
53 | static inline |
54 | struct bt_message *new_packet_message(struct bt_graph *graph, | |
55 | enum bt_message_type type, bt_object_release_func recycle_func) | |
d6e69534 | 56 | { |
5df26c89 | 57 | struct bt_message_packet *message; |
d6e69534 | 58 | |
5df26c89 | 59 | message = g_new0(struct bt_message_packet, 1); |
d6e69534 | 60 | if (!message) { |
870631a2 PP |
61 | BT_LIB_LOGE_APPEND_CAUSE( |
62 | "Failed to allocate one packet message."); | |
d6e69534 PP |
63 | goto error; |
64 | } | |
65 | ||
5df26c89 | 66 | bt_message_init(&message->parent, type, recycle_func, graph); |
d6e69534 PP |
67 | goto end; |
68 | ||
69 | error: | |
70 | BT_OBJECT_PUT_REF_AND_RESET(message); | |
71 | ||
72 | end: | |
73 | return (void *) message; | |
74 | } | |
75 | ||
5df26c89 | 76 | struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph) |
d6e69534 | 77 | { |
5df26c89 PP |
78 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING, |
79 | (bt_object_release_func) bt_message_packet_beginning_recycle); | |
80 | } | |
81 | ||
5df26c89 PP |
82 | struct bt_message *bt_message_packet_end_new(struct bt_graph *graph) |
83 | { | |
84 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END, | |
85 | (bt_object_release_func) bt_message_packet_end_recycle); | |
86 | } | |
87 | ||
88 | static inline | |
a6d85d2f | 89 | struct bt_message *create_packet_message( |
9a2c8b8e | 90 | struct bt_message_iterator *msg_iter, |
a6d85d2f | 91 | struct bt_packet *packet, struct bt_object_pool *pool, |
1778c2a4 | 92 | bool with_cs, uint64_t raw_value, const char *api_func) |
5df26c89 PP |
93 | { |
94 | struct bt_message_packet *message = NULL; | |
d6e69534 PP |
95 | struct bt_stream *stream; |
96 | struct bt_stream_class *stream_class; | |
8cc5f12b | 97 | bool need_cs; |
d6e69534 | 98 | |
5df26c89 | 99 | BT_ASSERT(msg_iter); |
1778c2a4 | 100 | BT_ASSERT_PRE_PACKET_NON_NULL_FROM_FUNC(api_func, packet); |
d6e69534 PP |
101 | stream = bt_packet_borrow_stream(packet); |
102 | BT_ASSERT(stream); | |
103 | stream_class = bt_stream_borrow_class(stream); | |
104 | BT_ASSERT(stream_class); | |
649934d2 | 105 | |
26fc5aed PP |
106 | /* |
107 | * It's not possible to create a packet from a stream of which | |
108 | * the class indicates that packets are not supported. | |
109 | */ | |
110 | BT_ASSERT(stream_class->supports_packets); | |
111 | ||
83a5656a | 112 | if (pool == &msg_iter->graph->packet_begin_msg_pool) { |
8cc5f12b | 113 | need_cs = stream_class->packets_have_beginning_default_clock_snapshot; |
649934d2 | 114 | } else { |
8cc5f12b | 115 | need_cs = stream_class->packets_have_end_default_clock_snapshot; |
649934d2 PP |
116 | } |
117 | ||
118 | /* | |
119 | * `packet_has_default_clock_snapshot` implies that the stream | |
120 | * class has a default clock class (precondition). | |
121 | */ | |
1778c2a4 PP |
122 | BT_ASSERT_PRE_FROM_FUNC(api_func, "with-default-clock-snapshot", |
123 | need_cs ? with_cs : true, | |
7fe92073 | 124 | "Unexpected stream class configuration when creating " |
8cc5f12b PP |
125 | "a packet beginning or end message: " |
126 | "a default clock snapshot is needed, but none was provided: " | |
127 | "%![stream-]+s, %![sc-]+S, with-cs=%d, " | |
128 | "cs-val=%" PRIu64, | |
129 | stream, stream_class, with_cs, raw_value); | |
1778c2a4 PP |
130 | BT_ASSERT_PRE_FROM_FUNC(api_func, "without-default-clock-snapshot", |
131 | !need_cs ? !with_cs : true, | |
8cc5f12b PP |
132 | "Unexpected stream class configuration when creating " |
133 | "a packet beginning or end message: " | |
134 | "no default clock snapshot is needed, but one was provided: " | |
a6d85d2f PP |
135 | "%![stream-]+s, %![sc-]+S, with-cs=%d, " |
136 | "cs-val=%" PRIu64, | |
137 | stream, stream_class, with_cs, raw_value); | |
5df26c89 | 138 | BT_LIB_LOGD("Creating packet message object: " |
d6e69534 PP |
139 | "%![packet-]+a, %![stream-]+s, %![sc-]+S", |
140 | packet, stream, stream_class); | |
5df26c89 | 141 | message = (void *) bt_message_create_from_pool(pool, msg_iter->graph); |
d6e69534 PP |
142 | if (!message) { |
143 | /* bt_message_create_from_pool() logs errors */ | |
144 | goto end; | |
145 | } | |
146 | ||
a6d85d2f PP |
147 | if (with_cs) { |
148 | BT_ASSERT(stream_class->default_clock_class); | |
149 | message->default_cs = bt_clock_snapshot_create( | |
150 | stream_class->default_clock_class); | |
151 | if (!message->default_cs) { | |
6871026b | 152 | bt_object_put_ref_no_null_check(message); |
a6d85d2f PP |
153 | message = NULL; |
154 | goto end; | |
155 | } | |
156 | ||
157 | bt_clock_snapshot_set_raw_value(message->default_cs, raw_value); | |
158 | } | |
159 | ||
d6e69534 PP |
160 | BT_ASSERT(!message->packet); |
161 | message->packet = packet; | |
6871026b | 162 | bt_object_get_ref_no_null_check_no_parent_check( |
d6e69534 PP |
163 | &message->packet->base); |
164 | bt_packet_set_is_frozen(packet, true); | |
5df26c89 | 165 | BT_LIB_LOGD("Created packet message object: " |
d6e69534 PP |
166 | "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S", |
167 | message, packet, stream, stream_class); | |
168 | goto end; | |
169 | ||
170 | end: | |
171 | return (void *) message; | |
172 | } | |
173 | ||
1353b066 | 174 | BT_EXPORT |
5df26c89 PP |
175 | struct bt_message *bt_message_packet_beginning_create( |
176 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 177 | const struct bt_packet *packet) |
d6e69534 | 178 | { |
9a2c8b8e | 179 | struct bt_message_iterator *msg_iter = |
5df26c89 | 180 | (void *) self_msg_iter; |
d6e69534 | 181 | |
17f3083a | 182 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
d5b13b9b | 183 | BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter); |
a6d85d2f | 184 | return create_packet_message(msg_iter, (void *) packet, |
1778c2a4 | 185 | &msg_iter->graph->packet_begin_msg_pool, false, 0, __func__); |
a6d85d2f PP |
186 | } |
187 | ||
1353b066 | 188 | BT_EXPORT |
a6d85d2f PP |
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) | |
192 | { | |
9a2c8b8e | 193 | struct bt_message_iterator *msg_iter = |
a6d85d2f PP |
194 | (void *) self_msg_iter; |
195 | ||
17f3083a | 196 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
d5b13b9b | 197 | BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter); |
a6d85d2f | 198 | return create_packet_message(msg_iter, (void *) packet, |
1778c2a4 PP |
199 | &msg_iter->graph->packet_begin_msg_pool, true, raw_value, |
200 | __func__); | |
d6e69534 PP |
201 | } |
202 | ||
1353b066 | 203 | BT_EXPORT |
5df26c89 PP |
204 | struct bt_message *bt_message_packet_end_create( |
205 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 206 | const struct bt_packet *packet) |
d6e69534 | 207 | { |
9a2c8b8e | 208 | struct bt_message_iterator *msg_iter = |
5df26c89 | 209 | (void *) self_msg_iter; |
d6e69534 | 210 | |
17f3083a | 211 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
d5b13b9b | 212 | BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter); |
a6d85d2f | 213 | return create_packet_message(msg_iter, (void *) packet, |
1778c2a4 | 214 | &msg_iter->graph->packet_end_msg_pool, false, 0, __func__); |
a6d85d2f PP |
215 | } |
216 | ||
1353b066 | 217 | BT_EXPORT |
a6d85d2f PP |
218 | struct bt_message *bt_message_packet_end_create_with_default_clock_snapshot( |
219 | struct bt_self_message_iterator *self_msg_iter, | |
220 | const struct bt_packet *packet, uint64_t raw_value) | |
221 | { | |
9a2c8b8e | 222 | struct bt_message_iterator *msg_iter = |
a6d85d2f PP |
223 | (void *) self_msg_iter; |
224 | ||
17f3083a | 225 | BT_ASSERT_PRE_DEV_NO_ERROR(); |
d5b13b9b | 226 | BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter); |
a6d85d2f | 227 | return create_packet_message(msg_iter, (void *) packet, |
1778c2a4 PP |
228 | &msg_iter->graph->packet_end_msg_pool, true, raw_value, |
229 | __func__); | |
d6e69534 PP |
230 | } |
231 | ||
5df26c89 | 232 | void bt_message_packet_destroy(struct bt_message *msg) |
d6e69534 | 233 | { |
5df26c89 | 234 | struct bt_message_packet *packet_msg = (void *) msg; |
d6e69534 | 235 | |
5df26c89 PP |
236 | BT_LIB_LOGD("Destroying packet message: %!+n", msg); |
237 | BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet); | |
238 | BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet); | |
a6d85d2f PP |
239 | |
240 | if (packet_msg->default_cs) { | |
241 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
242 | packet_msg->default_cs = NULL; | |
243 | } | |
244 | ||
5df26c89 | 245 | g_free(msg); |
d6e69534 PP |
246 | } |
247 | ||
5df26c89 PP |
248 | static inline |
249 | void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool) | |
d6e69534 | 250 | { |
5df26c89 PP |
251 | struct bt_message_packet *packet_msg = (void *) msg; |
252 | ||
253 | BT_LIB_LOGD("Recycling packet message: %!+n", msg); | |
254 | bt_message_reset(msg); | |
6871026b | 255 | bt_object_put_ref_no_null_check(&packet_msg->packet->base); |
a6d85d2f PP |
256 | |
257 | if (packet_msg->default_cs) { | |
258 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
259 | packet_msg->default_cs = NULL; | |
260 | } | |
261 | ||
5df26c89 PP |
262 | packet_msg->packet = NULL; |
263 | msg->graph = NULL; | |
264 | bt_object_pool_recycle_object(pool, msg); | |
d6e69534 PP |
265 | } |
266 | ||
5df26c89 | 267 | void bt_message_packet_beginning_recycle(struct bt_message *msg) |
d6e69534 | 268 | { |
5df26c89 | 269 | BT_ASSERT(msg); |
d6e69534 | 270 | |
91d81473 | 271 | if (G_UNLIKELY(!msg->graph)) { |
5df26c89 PP |
272 | bt_message_packet_destroy(msg); |
273 | return; | |
d6e69534 PP |
274 | } |
275 | ||
5df26c89 | 276 | recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool); |
d6e69534 PP |
277 | } |
278 | ||
5df26c89 | 279 | void bt_message_packet_end_recycle(struct bt_message *msg) |
d6e69534 | 280 | { |
5df26c89 | 281 | BT_ASSERT(msg); |
d6e69534 | 282 | |
91d81473 | 283 | if (G_UNLIKELY(!msg->graph)) { |
5df26c89 PP |
284 | bt_message_packet_destroy(msg); |
285 | return; | |
d6e69534 PP |
286 | } |
287 | ||
5df26c89 | 288 | recycle_packet_message(msg, &msg->graph->packet_end_msg_pool); |
d6e69534 PP |
289 | } |
290 | ||
1353b066 | 291 | BT_EXPORT |
5df26c89 PP |
292 | struct bt_packet *bt_message_packet_beginning_borrow_packet( |
293 | struct bt_message *message) | |
d6e69534 | 294 | { |
5df26c89 | 295 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 | 296 | |
d5b13b9b | 297 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(message); |
1778c2a4 | 298 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(message); |
5df26c89 | 299 | return packet_msg->packet; |
d6e69534 PP |
300 | } |
301 | ||
1353b066 | 302 | BT_EXPORT |
5df26c89 PP |
303 | const struct bt_packet *bt_message_packet_beginning_borrow_packet_const( |
304 | const struct bt_message *message) | |
d6e69534 | 305 | { |
5df26c89 PP |
306 | return bt_message_packet_beginning_borrow_packet( |
307 | (void *) message); | |
d6e69534 PP |
308 | } |
309 | ||
1353b066 | 310 | BT_EXPORT |
d6e69534 PP |
311 | struct bt_packet *bt_message_packet_end_borrow_packet( |
312 | struct bt_message *message) | |
313 | { | |
5df26c89 | 314 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 | 315 | |
d5b13b9b | 316 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(message); |
1778c2a4 | 317 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(message); |
5df26c89 | 318 | return packet_msg->packet; |
d6e69534 PP |
319 | } |
320 | ||
1353b066 | 321 | BT_EXPORT |
d6e69534 PP |
322 | const struct bt_packet *bt_message_packet_end_borrow_packet_const( |
323 | const struct bt_message *message) | |
324 | { | |
325 | return bt_message_packet_end_borrow_packet( | |
326 | (void *) message); | |
327 | } | |
a6d85d2f | 328 | |
1778c2a4 PP |
329 | #define BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(_msg) \ |
330 | BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS((_msg), \ | |
331 | ((struct bt_message_packet *) _msg)->packet->stream->class) | |
332 | ||
a6d85d2f | 333 | static inline |
0cbc2c33 | 334 | const struct bt_clock_snapshot * |
a6d85d2f | 335 | borrow_packet_message_default_clock_snapshot_const( |
0cbc2c33 | 336 | const struct bt_message *message) |
a6d85d2f PP |
337 | { |
338 | struct bt_message_packet *packet_msg = (void *) message; | |
339 | ||
98b15851 | 340 | BT_ASSERT_DBG(message); |
0cbc2c33 | 341 | return packet_msg->default_cs; |
a6d85d2f PP |
342 | } |
343 | ||
1353b066 | 344 | BT_EXPORT |
0cbc2c33 | 345 | const struct bt_clock_snapshot * |
a6d85d2f | 346 | bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
0cbc2c33 | 347 | const struct bt_message *msg) |
a6d85d2f | 348 | { |
d5b13b9b | 349 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg); |
1778c2a4 PP |
350 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg); |
351 | BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg); | |
d4f19030 | 352 | BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_BEGINNING_DEF_CS(msg); |
0cbc2c33 | 353 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f PP |
354 | } |
355 | ||
1353b066 | 356 | BT_EXPORT |
0cbc2c33 | 357 | const struct bt_clock_snapshot * |
a6d85d2f | 358 | bt_message_packet_end_borrow_default_clock_snapshot_const( |
0cbc2c33 | 359 | const struct bt_message *msg) |
a6d85d2f | 360 | { |
d5b13b9b | 361 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg); |
1778c2a4 PP |
362 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg); |
363 | BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg); | |
d4f19030 | 364 | BT_ASSERT_PRE_DEV_MSG_STREAM_CLASS_PACKETS_HAVE_END_DEF_CS(msg); |
0cbc2c33 | 365 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f | 366 | } |
33931ab8 PP |
367 | |
368 | static inline | |
369 | const struct bt_clock_class * | |
370 | borrow_packet_message_stream_class_default_clock_class( | |
371 | const struct bt_message *msg) | |
372 | { | |
373 | struct bt_message_packet *packet_msg = (void *) msg; | |
374 | ||
98b15851 | 375 | BT_ASSERT_DBG(msg); |
33931ab8 PP |
376 | return packet_msg->packet->stream->class->default_clock_class; |
377 | } | |
378 | ||
1353b066 | 379 | BT_EXPORT |
33931ab8 PP |
380 | const struct bt_clock_class * |
381 | bt_message_packet_beginning_borrow_stream_class_default_clock_class_const( | |
382 | const struct bt_message *msg) | |
383 | { | |
d5b13b9b | 384 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg); |
1778c2a4 | 385 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg); |
33931ab8 PP |
386 | return borrow_packet_message_stream_class_default_clock_class(msg); |
387 | } | |
388 | ||
1353b066 | 389 | BT_EXPORT |
33931ab8 PP |
390 | const struct bt_clock_class * |
391 | bt_message_packet_end_borrow_stream_class_default_clock_class_const( | |
392 | const struct bt_message *msg) | |
393 | { | |
d5b13b9b | 394 | BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg); |
1778c2a4 | 395 | BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg); |
33931ab8 PP |
396 | return borrow_packet_message_stream_class_default_clock_class(msg); |
397 | } |