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 | ||
24 | #define BT_LOG_TAG "MSG-PACKET" | |
25 | #include <babeltrace/lib-logging-internal.h> | |
26 | ||
27 | #include <babeltrace/compiler-internal.h> | |
28 | #include <babeltrace/trace-ir/packet.h> | |
29 | #include <babeltrace/trace-ir/packet-internal.h> | |
30 | #include <babeltrace/trace-ir/stream-class.h> | |
31 | #include <babeltrace/trace-ir/stream.h> | |
32 | #include <babeltrace/trace-ir/stream-internal.h> | |
a6d85d2f | 33 | #include <babeltrace/trace-ir/stream-class-internal.h> |
d6e69534 | 34 | #include <babeltrace/graph/graph-internal.h> |
5df26c89 PP |
35 | #include <babeltrace/graph/message-packet-beginning-const.h> |
36 | #include <babeltrace/graph/message-packet-end-const.h> | |
37 | #include <babeltrace/graph/message-packet-beginning.h> | |
38 | #include <babeltrace/graph/message-packet-end.h> | |
d6e69534 PP |
39 | #include <babeltrace/graph/message-packet-internal.h> |
40 | #include <babeltrace/assert-internal.h> | |
41 | #include <babeltrace/assert-pre-internal.h> | |
42 | #include <babeltrace/object-internal.h> | |
43 | #include <inttypes.h> | |
44 | ||
5df26c89 PP |
45 | static inline |
46 | struct bt_message *new_packet_message(struct bt_graph *graph, | |
47 | enum bt_message_type type, bt_object_release_func recycle_func) | |
d6e69534 | 48 | { |
5df26c89 | 49 | struct bt_message_packet *message; |
d6e69534 | 50 | |
5df26c89 | 51 | message = g_new0(struct bt_message_packet, 1); |
d6e69534 | 52 | if (!message) { |
5df26c89 | 53 | BT_LOGE_STR("Failed to allocate one packet message."); |
d6e69534 PP |
54 | goto error; |
55 | } | |
56 | ||
5df26c89 | 57 | bt_message_init(&message->parent, type, recycle_func, graph); |
d6e69534 PP |
58 | goto end; |
59 | ||
60 | error: | |
61 | BT_OBJECT_PUT_REF_AND_RESET(message); | |
62 | ||
63 | end: | |
64 | return (void *) message; | |
65 | } | |
66 | ||
5df26c89 PP |
67 | BT_HIDDEN |
68 | struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph) | |
d6e69534 | 69 | { |
5df26c89 PP |
70 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING, |
71 | (bt_object_release_func) bt_message_packet_beginning_recycle); | |
72 | } | |
73 | ||
74 | BT_HIDDEN | |
75 | struct bt_message *bt_message_packet_end_new(struct bt_graph *graph) | |
76 | { | |
77 | return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END, | |
78 | (bt_object_release_func) bt_message_packet_end_recycle); | |
79 | } | |
80 | ||
81 | static inline | |
a6d85d2f | 82 | struct bt_message *create_packet_message( |
5df26c89 | 83 | struct bt_self_component_port_input_message_iterator *msg_iter, |
a6d85d2f | 84 | struct bt_packet *packet, struct bt_object_pool *pool, |
83a5656a | 85 | bool with_cs, uint64_t raw_value) |
5df26c89 PP |
86 | { |
87 | struct bt_message_packet *message = NULL; | |
d6e69534 PP |
88 | struct bt_stream *stream; |
89 | struct bt_stream_class *stream_class; | |
649934d2 | 90 | bool packet_has_default_clock_snapshot; |
d6e69534 | 91 | |
5df26c89 | 92 | BT_ASSERT(msg_iter); |
d6e69534 PP |
93 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
94 | stream = bt_packet_borrow_stream(packet); | |
95 | BT_ASSERT(stream); | |
96 | stream_class = bt_stream_borrow_class(stream); | |
97 | BT_ASSERT(stream_class); | |
649934d2 | 98 | |
83a5656a | 99 | if (pool == &msg_iter->graph->packet_begin_msg_pool) { |
649934d2 PP |
100 | packet_has_default_clock_snapshot = |
101 | stream_class->packets_have_default_beginning_clock_snapshot; | |
102 | } else { | |
103 | packet_has_default_clock_snapshot = | |
104 | stream_class->packets_have_default_end_clock_snapshot; | |
105 | } | |
106 | ||
107 | /* | |
108 | * `packet_has_default_clock_snapshot` implies that the stream | |
109 | * class has a default clock class (precondition). | |
110 | */ | |
111 | BT_ASSERT_PRE((with_cs && packet_has_default_clock_snapshot) || | |
112 | (!with_cs && !packet_has_default_clock_snapshot), | |
a6d85d2f PP |
113 | "Creating a packet message with a default clock snapshot, but without " |
114 | "a default clock class, or without a default clock snapshot, " | |
115 | "but with a default clock class: ", | |
116 | "%![stream-]+s, %![sc-]+S, with-cs=%d, " | |
117 | "cs-val=%" PRIu64, | |
118 | stream, stream_class, with_cs, raw_value); | |
5df26c89 | 119 | BT_LIB_LOGD("Creating packet message object: " |
d6e69534 PP |
120 | "%![packet-]+a, %![stream-]+s, %![sc-]+S", |
121 | packet, stream, stream_class); | |
5df26c89 | 122 | message = (void *) bt_message_create_from_pool(pool, msg_iter->graph); |
d6e69534 PP |
123 | if (!message) { |
124 | /* bt_message_create_from_pool() logs errors */ | |
125 | goto end; | |
126 | } | |
127 | ||
a6d85d2f PP |
128 | if (with_cs) { |
129 | BT_ASSERT(stream_class->default_clock_class); | |
130 | message->default_cs = bt_clock_snapshot_create( | |
131 | stream_class->default_clock_class); | |
132 | if (!message->default_cs) { | |
133 | bt_object_put_no_null_check(message); | |
134 | message = NULL; | |
135 | goto end; | |
136 | } | |
137 | ||
138 | bt_clock_snapshot_set_raw_value(message->default_cs, raw_value); | |
139 | } | |
140 | ||
d6e69534 PP |
141 | BT_ASSERT(!message->packet); |
142 | message->packet = packet; | |
143 | bt_object_get_no_null_check_no_parent_check( | |
144 | &message->packet->base); | |
145 | bt_packet_set_is_frozen(packet, true); | |
5df26c89 | 146 | BT_LIB_LOGD("Created packet message object: " |
d6e69534 PP |
147 | "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S", |
148 | message, packet, stream, stream_class); | |
149 | goto end; | |
150 | ||
151 | end: | |
152 | return (void *) message; | |
153 | } | |
154 | ||
5df26c89 PP |
155 | struct bt_message *bt_message_packet_beginning_create( |
156 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 157 | const struct bt_packet *packet) |
d6e69534 | 158 | { |
5df26c89 PP |
159 | struct bt_self_component_port_input_message_iterator *msg_iter = |
160 | (void *) self_msg_iter; | |
d6e69534 | 161 | |
5df26c89 | 162 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); |
a6d85d2f | 163 | return create_packet_message(msg_iter, (void *) packet, |
83a5656a | 164 | &msg_iter->graph->packet_begin_msg_pool, false, 0); |
a6d85d2f PP |
165 | } |
166 | ||
167 | struct bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot( | |
168 | struct bt_self_message_iterator *self_msg_iter, | |
169 | const struct bt_packet *packet, uint64_t raw_value) | |
170 | { | |
171 | struct bt_self_component_port_input_message_iterator *msg_iter = | |
172 | (void *) self_msg_iter; | |
173 | ||
174 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); | |
175 | return create_packet_message(msg_iter, (void *) packet, | |
83a5656a | 176 | &msg_iter->graph->packet_begin_msg_pool, true, raw_value); |
d6e69534 PP |
177 | } |
178 | ||
5df26c89 PP |
179 | struct bt_message *bt_message_packet_end_create( |
180 | struct bt_self_message_iterator *self_msg_iter, | |
58085ca4 | 181 | const struct bt_packet *packet) |
d6e69534 | 182 | { |
5df26c89 PP |
183 | struct bt_self_component_port_input_message_iterator *msg_iter = |
184 | (void *) self_msg_iter; | |
d6e69534 | 185 | |
5df26c89 | 186 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); |
a6d85d2f | 187 | return create_packet_message(msg_iter, (void *) packet, |
83a5656a | 188 | &msg_iter->graph->packet_end_msg_pool, false, 0); |
a6d85d2f PP |
189 | } |
190 | ||
191 | struct bt_message *bt_message_packet_end_create_with_default_clock_snapshot( | |
192 | struct bt_self_message_iterator *self_msg_iter, | |
193 | const struct bt_packet *packet, uint64_t raw_value) | |
194 | { | |
195 | struct bt_self_component_port_input_message_iterator *msg_iter = | |
196 | (void *) self_msg_iter; | |
197 | ||
198 | BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator"); | |
199 | return create_packet_message(msg_iter, (void *) packet, | |
83a5656a | 200 | &msg_iter->graph->packet_end_msg_pool, true, raw_value); |
d6e69534 PP |
201 | } |
202 | ||
5df26c89 PP |
203 | BT_HIDDEN |
204 | void bt_message_packet_destroy(struct bt_message *msg) | |
d6e69534 | 205 | { |
5df26c89 | 206 | struct bt_message_packet *packet_msg = (void *) msg; |
d6e69534 | 207 | |
5df26c89 PP |
208 | BT_LIB_LOGD("Destroying packet message: %!+n", msg); |
209 | BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet); | |
210 | BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet); | |
a6d85d2f PP |
211 | |
212 | if (packet_msg->default_cs) { | |
213 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
214 | packet_msg->default_cs = NULL; | |
215 | } | |
216 | ||
5df26c89 | 217 | g_free(msg); |
d6e69534 PP |
218 | } |
219 | ||
5df26c89 PP |
220 | static inline |
221 | void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool) | |
d6e69534 | 222 | { |
5df26c89 PP |
223 | struct bt_message_packet *packet_msg = (void *) msg; |
224 | ||
225 | BT_LIB_LOGD("Recycling packet message: %!+n", msg); | |
226 | bt_message_reset(msg); | |
227 | bt_object_put_no_null_check(&packet_msg->packet->base); | |
a6d85d2f PP |
228 | |
229 | if (packet_msg->default_cs) { | |
230 | bt_clock_snapshot_recycle(packet_msg->default_cs); | |
231 | packet_msg->default_cs = NULL; | |
232 | } | |
233 | ||
5df26c89 PP |
234 | packet_msg->packet = NULL; |
235 | msg->graph = NULL; | |
236 | bt_object_pool_recycle_object(pool, msg); | |
d6e69534 PP |
237 | } |
238 | ||
239 | BT_HIDDEN | |
5df26c89 | 240 | void bt_message_packet_beginning_recycle(struct bt_message *msg) |
d6e69534 | 241 | { |
5df26c89 | 242 | BT_ASSERT(msg); |
d6e69534 | 243 | |
5df26c89 PP |
244 | if (unlikely(!msg->graph)) { |
245 | bt_message_packet_destroy(msg); | |
246 | return; | |
d6e69534 PP |
247 | } |
248 | ||
5df26c89 | 249 | recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool); |
d6e69534 PP |
250 | } |
251 | ||
5df26c89 PP |
252 | BT_HIDDEN |
253 | void bt_message_packet_end_recycle(struct bt_message *msg) | |
d6e69534 | 254 | { |
5df26c89 | 255 | BT_ASSERT(msg); |
d6e69534 | 256 | |
5df26c89 PP |
257 | if (unlikely(!msg->graph)) { |
258 | bt_message_packet_destroy(msg); | |
259 | return; | |
d6e69534 PP |
260 | } |
261 | ||
5df26c89 | 262 | recycle_packet_message(msg, &msg->graph->packet_end_msg_pool); |
d6e69534 PP |
263 | } |
264 | ||
5df26c89 PP |
265 | struct bt_packet *bt_message_packet_beginning_borrow_packet( |
266 | struct bt_message *message) | |
d6e69534 | 267 | { |
5df26c89 | 268 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 | 269 | |
5df26c89 PP |
270 | BT_ASSERT_PRE_NON_NULL(message, "Message"); |
271 | BT_ASSERT_PRE_MSG_IS_TYPE(message, | |
272 | BT_MESSAGE_TYPE_PACKET_BEGINNING); | |
273 | return packet_msg->packet; | |
d6e69534 PP |
274 | } |
275 | ||
5df26c89 PP |
276 | const struct bt_packet *bt_message_packet_beginning_borrow_packet_const( |
277 | const struct bt_message *message) | |
d6e69534 | 278 | { |
5df26c89 PP |
279 | return bt_message_packet_beginning_borrow_packet( |
280 | (void *) message); | |
d6e69534 PP |
281 | } |
282 | ||
283 | struct bt_packet *bt_message_packet_end_borrow_packet( | |
284 | struct bt_message *message) | |
285 | { | |
5df26c89 | 286 | struct bt_message_packet *packet_msg = (void *) message; |
d6e69534 PP |
287 | |
288 | BT_ASSERT_PRE_NON_NULL(message, "Message"); | |
289 | BT_ASSERT_PRE_MSG_IS_TYPE(message, | |
290 | BT_MESSAGE_TYPE_PACKET_END); | |
5df26c89 | 291 | return packet_msg->packet; |
d6e69534 PP |
292 | } |
293 | ||
294 | const struct bt_packet *bt_message_packet_end_borrow_packet_const( | |
295 | const struct bt_message *message) | |
296 | { | |
297 | return bt_message_packet_end_borrow_packet( | |
298 | (void *) message); | |
299 | } | |
a6d85d2f PP |
300 | |
301 | static inline | |
0cbc2c33 | 302 | const struct bt_clock_snapshot * |
a6d85d2f | 303 | borrow_packet_message_default_clock_snapshot_const( |
0cbc2c33 | 304 | const struct bt_message *message) |
a6d85d2f PP |
305 | { |
306 | struct bt_message_packet *packet_msg = (void *) message; | |
307 | ||
308 | BT_ASSERT(message); | |
309 | BT_ASSERT_PRE(packet_msg->packet->stream->class->default_clock_class, | |
310 | "Message's stream's class has no default clock class: " | |
311 | "%![msg-]+n, %![sc-]+S", | |
312 | message, packet_msg->packet->stream->class); | |
0cbc2c33 | 313 | return packet_msg->default_cs; |
a6d85d2f PP |
314 | } |
315 | ||
0cbc2c33 | 316 | const struct bt_clock_snapshot * |
a6d85d2f | 317 | bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
0cbc2c33 | 318 | const struct bt_message *msg) |
a6d85d2f PP |
319 | { |
320 | BT_ASSERT_PRE_NON_NULL(msg, "Message"); | |
321 | BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING); | |
0cbc2c33 | 322 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f PP |
323 | } |
324 | ||
0cbc2c33 | 325 | const struct bt_clock_snapshot * |
a6d85d2f | 326 | bt_message_packet_end_borrow_default_clock_snapshot_const( |
0cbc2c33 | 327 | const struct bt_message *msg) |
a6d85d2f PP |
328 | { |
329 | BT_ASSERT_PRE_NON_NULL(msg, "Message"); | |
330 | BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END); | |
0cbc2c33 | 331 | return borrow_packet_message_default_clock_snapshot_const(msg); |
a6d85d2f | 332 | } |
33931ab8 PP |
333 | |
334 | static inline | |
335 | const struct bt_clock_class * | |
336 | borrow_packet_message_stream_class_default_clock_class( | |
337 | const struct bt_message *msg) | |
338 | { | |
339 | struct bt_message_packet *packet_msg = (void *) msg; | |
340 | ||
341 | BT_ASSERT(msg); | |
342 | return packet_msg->packet->stream->class->default_clock_class; | |
343 | } | |
344 | ||
345 | const struct bt_clock_class * | |
346 | bt_message_packet_beginning_borrow_stream_class_default_clock_class_const( | |
347 | const struct bt_message *msg) | |
348 | { | |
349 | BT_ASSERT_PRE_NON_NULL(msg, "Message"); | |
350 | BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING); | |
351 | return borrow_packet_message_stream_class_default_clock_class(msg); | |
352 | } | |
353 | ||
354 | const struct bt_clock_class * | |
355 | bt_message_packet_end_borrow_stream_class_default_clock_class_const( | |
356 | const struct bt_message *msg) | |
357 | { | |
358 | BT_ASSERT_PRE_NON_NULL(msg, "Message"); | |
359 | BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END); | |
360 | return borrow_packet_message_stream_class_default_clock_class(msg); | |
361 | } |