Commit | Line | Data |
---|---|---|
d6e69534 PP |
1 | /* |
2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> | |
3 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
4 | * | |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
350ad6c1 | 24 | #define BT_LOG_TAG "LIB/MSG-PACKET" |
c2d9d9cf | 25 | #include "lib/logging.h" |
d6e69534 | 26 | |
51375aa9 PP |
27 | #include "lib/assert-pre.h" |
28 | #include "lib/assert-post.h" | |
578e048b | 29 | #include "compat/compiler.h" |
3fadfbc0 | 30 | #include <babeltrace2/trace-ir/packet.h> |
578e048b | 31 | #include "lib/trace-ir/packet.h" |
3fadfbc0 MJ |
32 | #include <babeltrace2/trace-ir/stream-class.h> |
33 | #include <babeltrace2/trace-ir/stream.h> | |
578e048b MJ |
34 | #include "lib/trace-ir/stream.h" |
35 | #include "lib/trace-ir/stream-class.h" | |
36 | #include "lib/graph/graph.h" | |
3fadfbc0 MJ |
37 | #include <babeltrace2/graph/message-packet-beginning-const.h> |
38 | #include <babeltrace2/graph/message-packet-end-const.h> | |
39 | #include <babeltrace2/graph/message-packet-beginning.h> | |
40 | #include <babeltrace2/graph/message-packet-end.h> | |
578e048b | 41 | #include "common/assert.h" |
578e048b | 42 | #include "lib/object.h" |
d6e69534 PP |
43 | #include <inttypes.h> |
44 | ||
578e048b MJ |
45 | #include "packet.h" |
46 | ||
5df26c89 PP |
47 | static inline |
48 | struct bt_message *new_packet_message(struct bt_graph *graph, | |
49 | enum bt_message_type type, bt_object_release_func recycle_func) | |
d6e69534 | 50 | { |
5df26c89 | 51 | struct bt_message_packet *message; |
d6e69534 | 52 | |
5df26c89 | 53 | message = g_new0(struct bt_message_packet, 1); |
d6e69534 | 54 | if (!message) { |
870631a2 PP |
55 | BT_LIB_LOGE_APPEND_CAUSE( |
56 | "Failed to allocate one packet message."); | |
d6e69534 PP |
57 | goto error; |
58 | } | |
59 | ||
5df26c89 | 60 | bt_message_init(&message->parent, type, recycle_func, graph); |
d6e69534 PP |
61 | goto end; |
62 | ||
63 | error: | |
64 | BT_OBJECT_PUT_REF_AND_RESET(message); | |
65 | ||
66 | end: | |
67 | return (void *) message; | |
68 | } | |
69 | ||
5df26c89 PP |
70 | BT_HIDDEN |
71 | struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph) | |
d6e69534 | 72 | { |
5df26c89 PP |
73 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING, |
74 | (bt_object_release_func) bt_message_packet_beginning_recycle); | |
75 | } | |
76 | ||
77 | BT_HIDDEN | |
78 | struct bt_message *bt_message_packet_end_new(struct bt_graph *graph) | |
79 | { | |
80 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END, | |
81 | (bt_object_release_func) bt_message_packet_end_recycle); | |
82 | } | |
83 | ||
84 | static inline | |
a6d85d2f | 85 | struct bt_message *create_packet_message( |
5df26c89 | 86 | struct bt_self_component_port_input_message_iterator *msg_iter, |
a6d85d2f | 87 | struct bt_packet *packet, struct bt_object_pool *pool, |
83a5656a | 88 | bool with_cs, uint64_t raw_value) |
5df26c89 PP |
89 | { |
90 | struct bt_message_packet *message = NULL; | |
d6e69534 PP |
91 | struct bt_stream *stream; |
92 | struct bt_stream_class *stream_class; | |
8cc5f12b | 93 | bool need_cs; |
d6e69534 | 94 | |
5df26c89 | 95 | BT_ASSERT(msg_iter); |
d6e69534 PP |
96 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
97 | stream = bt_packet_borrow_stream(packet); | |
98 | BT_ASSERT(stream); | |
99 | stream_class = bt_stream_borrow_class(stream); | |
100 | BT_ASSERT(stream_class); | |
649934d2 | 101 | |
26fc5aed PP |
102 | /* |
103 | * It's not possible to create a packet from a stream of which | |
104 | * the class indicates that packets are not supported. | |
105 | */ | |
106 | BT_ASSERT(stream_class->supports_packets); | |
107 | ||
83a5656a | 108 | if (pool == &msg_iter->graph->packet_begin_msg_pool) { |
8cc5f12b | 109 | need_cs = stream_class->packets_have_beginning_default_clock_snapshot; |
649934d2 | 110 | } else { |
8cc5f12b | 111 | need_cs = stream_class->packets_have_end_default_clock_snapshot; |
649934d2 PP |
112 | } |
113 | ||
114 | /* | |
115 | * `packet_has_default_clock_snapshot` implies that the stream | |
116 | * class has a default clock class (precondition). | |
117 | */ | |
8cc5f12b | 118 | BT_ASSERT_PRE(need_cs ? with_cs : true, |
7fe92073 | 119 | "Unexpected stream class configuration when creating " |
8cc5f12b PP |
120 | "a packet beginning or end message: " |
121 | "a default clock snapshot is needed, but none was provided: " | |
122 | "%![stream-]+s, %![sc-]+S, with-cs=%d, " | |
123 | "cs-val=%" PRIu64, | |
124 | stream, stream_class, with_cs, raw_value); | |
125 | BT_ASSERT_PRE(!need_cs ? !with_cs : true, | |
126 | "Unexpected stream class configuration when creating " | |
127 | "a packet beginning or end message: " | |
128 | "no default clock snapshot is needed, but one was provided: " | |
a6d85d2f PP |
129 | "%![stream-]+s, %![sc-]+S, with-cs=%d, " |
130 | "cs-val=%" PRIu64, | |
131 | stream, stream_class, with_cs, raw_value); | |
5df26c89 | 132 | BT_LIB_LOGD("Creating packet message object: " |
d6e69534 PP |
133 | "%![packet-]+a, %![stream-]+s, %![sc-]+S", |
134 | packet, stream, stream_class); | |
5df26c89 | 135 | message = (void *) bt_message_create_from_pool(pool, msg_iter->graph); |
d6e69534 PP |
136 | if (!message) { |
137 | /* bt_message_create_from_pool() logs errors */ | |
138 | goto end; | |
139 | } | |
140 | ||
a6d85d2f PP |
141 | if (with_cs) { |
142 | BT_ASSERT(stream_class->default_clock_class); | |
143 | message->default_cs = bt_clock_snapshot_create( | |
144 | stream_class->default_clock_class); | |
145 | if (!message->default_cs) { | |
6871026b | 146 | bt_object_put_ref_no_null_check(message); |
a6d85d2f PP |
147 | message = NULL; |
148 | goto end; | |
149 | } | |
150 | ||
151 | bt_clock_snapshot_set_raw_value(message->default_cs, raw_value); | |
152 | } | |
153 | ||
d6e69534 PP |
154 | BT_ASSERT(!message->packet); |
155 | message->packet = packet; | |
6871026b | 156 | bt_object_get_ref_no_null_check_no_parent_check( |
d6e69534 PP |
157 | &message->packet->base); |
158 | bt_packet_set_is_frozen(packet, true); | |
5df26c89 | 159 | BT_LIB_LOGD("Created packet message object: " |
d6e69534 PP |
160 | "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S", |
161 | message, packet, stream, stream_class); | |
162 | goto end; | |
163 | ||
164 | end: | |
165 | return (void *) message; | |
166 | } | |
167 | ||
5df26c89 PP |
168 | struct bt_message *bt_message_packet_beginning_create( |
169 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 170 | const struct bt_packet *packet) |
d6e69534 | 171 | { |
5df26c89 PP |
172 | struct bt_self_component_port_input_message_iterator *msg_iter = |
173 | (void *) self_msg_iter; | |
d6e69534 | 174 | |
5df26c89 | 175 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); |
a6d85d2f | 176 | return create_packet_message(msg_iter, (void *) packet, |
83a5656a | 177 | &msg_iter->graph->packet_begin_msg_pool, false, 0); |
a6d85d2f PP |
178 | } |
179 | ||
180 | struct bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot( | |
181 | struct bt_self_message_iterator *self_msg_iter, | |
182 | const struct bt_packet *packet, uint64_t raw_value) | |
183 | { | |
184 | struct bt_self_component_port_input_message_iterator *msg_iter = | |
185 | (void *) self_msg_iter; | |
186 | ||
187 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); | |
188 | return create_packet_message(msg_iter, (void *) packet, | |
83a5656a | 189 | &msg_iter->graph->packet_begin_msg_pool, true, raw_value); |
d6e69534 PP |
190 | } |
191 | ||
5df26c89 PP |
192 | struct bt_message *bt_message_packet_end_create( |
193 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 194 | const struct bt_packet *packet) |
d6e69534 | 195 | { |
5df26c89 PP |
196 | struct bt_self_component_port_input_message_iterator *msg_iter = |
197 | (void *) self_msg_iter; | |
d6e69534 | 198 | |
5df26c89 | 199 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); |
a6d85d2f | 200 | return create_packet_message(msg_iter, (void *) packet, |
83a5656a | 201 | &msg_iter->graph->packet_end_msg_pool, false, 0); |
a6d85d2f PP |
202 | } |
203 | ||
204 | struct bt_message *bt_message_packet_end_create_with_default_clock_snapshot( | |
205 | struct bt_self_message_iterator *self_msg_iter, | |
206 | const struct bt_packet *packet, uint64_t raw_value) | |
207 | { | |
208 | struct bt_self_component_port_input_message_iterator *msg_iter = | |
209 | (void *) self_msg_iter; | |
210 | ||
211 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); | |
212 | return create_packet_message(msg_iter, (void *) packet, | |
83a5656a | 213 | &msg_iter->graph->packet_end_msg_pool, true, raw_value); |
d6e69534 PP |
214 | } |
215 | ||
5df26c89 PP |
216 | BT_HIDDEN |
217 | void bt_message_packet_destroy(struct bt_message *msg) | |
d6e69534 | 218 | { |
5df26c89 | 219 | struct bt_message_packet *packet_msg = (void *) msg; |
d6e69534 | 220 | |
5df26c89 PP |
221 | BT_LIB_LOGD("Destroying packet message: %!+n", msg); |
222 | BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet); | |
223 | BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet); | |
a6d85d2f PP |
224 | |
225 | if (packet_msg->default_cs) { | |
226 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
227 | packet_msg->default_cs = NULL; | |
228 | } | |
229 | ||
5df26c89 | 230 | g_free(msg); |
d6e69534 PP |
231 | } |
232 | ||
5df26c89 PP |
233 | static inline |
234 | void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool) | |
d6e69534 | 235 | { |
5df26c89 PP |
236 | struct bt_message_packet *packet_msg = (void *) msg; |
237 | ||
238 | BT_LIB_LOGD("Recycling packet message: %!+n", msg); | |
239 | bt_message_reset(msg); | |
6871026b | 240 | bt_object_put_ref_no_null_check(&packet_msg->packet->base); |
a6d85d2f PP |
241 | |
242 | if (packet_msg->default_cs) { | |
243 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
244 | packet_msg->default_cs = NULL; | |
245 | } | |
246 | ||
5df26c89 PP |
247 | packet_msg->packet = NULL; |
248 | msg->graph = NULL; | |
249 | bt_object_pool_recycle_object(pool, msg); | |
d6e69534 PP |
250 | } |
251 | ||
252 | BT_HIDDEN | |
5df26c89 | 253 | void bt_message_packet_beginning_recycle(struct bt_message *msg) |
d6e69534 | 254 | { |
5df26c89 | 255 | BT_ASSERT(msg); |
d6e69534 | 256 | |
91d81473 | 257 | if (G_UNLIKELY(!msg->graph)) { |
5df26c89 PP |
258 | bt_message_packet_destroy(msg); |
259 | return; | |
d6e69534 PP |
260 | } |
261 | ||
5df26c89 | 262 | recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool); |
d6e69534 PP |
263 | } |
264 | ||
5df26c89 PP |
265 | BT_HIDDEN |
266 | void bt_message_packet_end_recycle(struct bt_message *msg) | |
d6e69534 | 267 | { |
5df26c89 | 268 | BT_ASSERT(msg); |
d6e69534 | 269 | |
91d81473 | 270 | if (G_UNLIKELY(!msg->graph)) { |
5df26c89 PP |
271 | bt_message_packet_destroy(msg); |
272 | return; | |
d6e69534 PP |
273 | } |
274 | ||
5df26c89 | 275 | recycle_packet_message(msg, &msg->graph->packet_end_msg_pool); |
d6e69534 PP |
276 | } |
277 | ||
5df26c89 PP |
278 | struct bt_packet *bt_message_packet_beginning_borrow_packet( |
279 | struct bt_message *message) | |
d6e69534 | 280 | { |
5df26c89 | 281 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 | 282 | |
bdb288b3 PP |
283 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
284 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, | |
5df26c89 PP |
285 | BT_MESSAGE_TYPE_PACKET_BEGINNING); |
286 | return packet_msg->packet; | |
d6e69534 PP |
287 | } |
288 | ||
5df26c89 PP |
289 | const struct bt_packet *bt_message_packet_beginning_borrow_packet_const( |
290 | const struct bt_message *message) | |
d6e69534 | 291 | { |
5df26c89 PP |
292 | return bt_message_packet_beginning_borrow_packet( |
293 | (void *) message); | |
d6e69534 PP |
294 | } |
295 | ||
296 | struct bt_packet *bt_message_packet_end_borrow_packet( | |
297 | struct bt_message *message) | |
298 | { | |
5df26c89 | 299 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 | 300 | |
bdb288b3 PP |
301 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
302 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, | |
d6e69534 | 303 | BT_MESSAGE_TYPE_PACKET_END); |
5df26c89 | 304 | return packet_msg->packet; |
d6e69534 PP |
305 | } |
306 | ||
307 | const struct bt_packet *bt_message_packet_end_borrow_packet_const( | |
308 | const struct bt_message *message) | |
309 | { | |
310 | return bt_message_packet_end_borrow_packet( | |
311 | (void *) message); | |
312 | } | |
a6d85d2f PP |
313 | |
314 | static inline | |
0cbc2c33 | 315 | const struct bt_clock_snapshot * |
a6d85d2f | 316 | borrow_packet_message_default_clock_snapshot_const( |
0cbc2c33 | 317 | const struct bt_message *message) |
a6d85d2f PP |
318 | { |
319 | struct bt_message_packet *packet_msg = (void *) message; | |
320 | ||
321 | BT_ASSERT(message); | |
bdb288b3 PP |
322 | BT_ASSERT_PRE_DEV( |
323 | packet_msg->packet->stream->class->default_clock_class, | |
a6d85d2f PP |
324 | "Message's stream's class has no default clock class: " |
325 | "%![msg-]+n, %![sc-]+S", | |
326 | message, packet_msg->packet->stream->class); | |
0cbc2c33 | 327 | return packet_msg->default_cs; |
a6d85d2f PP |
328 | } |
329 | ||
0cbc2c33 | 330 | const struct bt_clock_snapshot * |
a6d85d2f | 331 | bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
0cbc2c33 | 332 | const struct bt_message *msg) |
a6d85d2f | 333 | { |
bdb288b3 PP |
334 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
335 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING); | |
0cbc2c33 | 336 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f PP |
337 | } |
338 | ||
0cbc2c33 | 339 | const struct bt_clock_snapshot * |
a6d85d2f | 340 | bt_message_packet_end_borrow_default_clock_snapshot_const( |
0cbc2c33 | 341 | const struct bt_message *msg) |
a6d85d2f | 342 | { |
bdb288b3 PP |
343 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
344 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END); | |
0cbc2c33 | 345 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f | 346 | } |
33931ab8 PP |
347 | |
348 | static inline | |
349 | const struct bt_clock_class * | |
350 | borrow_packet_message_stream_class_default_clock_class( | |
351 | const struct bt_message *msg) | |
352 | { | |
353 | struct bt_message_packet *packet_msg = (void *) msg; | |
354 | ||
355 | BT_ASSERT(msg); | |
356 | return packet_msg->packet->stream->class->default_clock_class; | |
357 | } | |
358 | ||
359 | const struct bt_clock_class * | |
360 | bt_message_packet_beginning_borrow_stream_class_default_clock_class_const( | |
361 | const struct bt_message *msg) | |
362 | { | |
bdb288b3 PP |
363 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
364 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING); | |
33931ab8 PP |
365 | return borrow_packet_message_stream_class_default_clock_class(msg); |
366 | } | |
367 | ||
368 | const struct bt_clock_class * | |
369 | bt_message_packet_end_borrow_stream_class_default_clock_class_const( | |
370 | const struct bt_message *msg) | |
371 | { | |
bdb288b3 PP |
372 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
373 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END); | |
33931ab8 PP |
374 | return borrow_packet_message_stream_class_default_clock_class(msg); |
375 | } |