2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "LIB/MSG-PACKET"
25 #include "lib/logging.h"
29 #include "lib/assert-pre.h"
30 #include "lib/assert-post.h"
31 #include "compat/compiler.h"
32 #include <babeltrace2/trace-ir/packet.h>
33 #include "lib/trace-ir/packet.h"
34 #include <babeltrace2/trace-ir/stream-class.h>
35 #include <babeltrace2/trace-ir/stream.h>
36 #include "lib/trace-ir/stream.h"
37 #include "lib/trace-ir/stream-class.h"
38 #include "lib/graph/graph.h"
39 #include <babeltrace2/graph/message-packet-beginning-const.h>
40 #include <babeltrace2/graph/message-packet-end-const.h>
41 #include <babeltrace2/graph/message-packet-beginning.h>
42 #include <babeltrace2/graph/message-packet-end.h>
43 #include "common/assert.h"
44 #include "lib/object.h"
50 struct bt_message
*new_packet_message(struct bt_graph
*graph
,
51 enum bt_message_type type
, bt_object_release_func recycle_func
)
53 struct bt_message_packet
*message
;
55 message
= g_new0(struct bt_message_packet
, 1);
57 BT_LIB_LOGE_APPEND_CAUSE(
58 "Failed to allocate one packet message.");
62 bt_message_init(&message
->parent
, type
, recycle_func
, graph
);
66 BT_OBJECT_PUT_REF_AND_RESET(message
);
69 return (void *) message
;
73 struct bt_message
*bt_message_packet_beginning_new(struct bt_graph
*graph
)
75 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_BEGINNING
,
76 (bt_object_release_func
) bt_message_packet_beginning_recycle
);
80 struct bt_message
*bt_message_packet_end_new(struct bt_graph
*graph
)
82 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_END
,
83 (bt_object_release_func
) bt_message_packet_end_recycle
);
87 struct bt_message
*create_packet_message(
88 struct bt_self_component_port_input_message_iterator
*msg_iter
,
89 struct bt_packet
*packet
, struct bt_object_pool
*pool
,
90 bool with_cs
, uint64_t raw_value
)
92 struct bt_message_packet
*message
= NULL
;
93 struct bt_stream
*stream
;
94 struct bt_stream_class
*stream_class
;
98 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
99 stream
= bt_packet_borrow_stream(packet
);
101 stream_class
= bt_stream_borrow_class(stream
);
102 BT_ASSERT(stream_class
);
105 * It's not possible to create a packet from a stream of which
106 * the class indicates that packets are not supported.
108 BT_ASSERT(stream_class
->supports_packets
);
110 if (pool
== &msg_iter
->graph
->packet_begin_msg_pool
) {
111 need_cs
= stream_class
->packets_have_beginning_default_clock_snapshot
;
113 need_cs
= stream_class
->packets_have_end_default_clock_snapshot
;
117 * `packet_has_default_clock_snapshot` implies that the stream
118 * class has a default clock class (precondition).
120 BT_ASSERT_PRE(need_cs
? with_cs
: true,
121 "Unexpected stream class configuration when creating "
122 "a packet beginning or end message: "
123 "a default clock snapshot is needed, but none was provided: "
124 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
126 stream
, stream_class
, with_cs
, raw_value
);
127 BT_ASSERT_PRE(!need_cs
? !with_cs
: true,
128 "Unexpected stream class configuration when creating "
129 "a packet beginning or end message: "
130 "no default clock snapshot is needed, but one was provided: "
131 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
133 stream
, stream_class
, with_cs
, raw_value
);
134 BT_LIB_LOGD("Creating packet message object: "
135 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
136 packet
, stream
, stream_class
);
137 message
= (void *) bt_message_create_from_pool(pool
, msg_iter
->graph
);
139 /* bt_message_create_from_pool() logs errors */
144 BT_ASSERT(stream_class
->default_clock_class
);
145 message
->default_cs
= bt_clock_snapshot_create(
146 stream_class
->default_clock_class
);
147 if (!message
->default_cs
) {
148 bt_object_put_ref_no_null_check(message
);
153 bt_clock_snapshot_set_raw_value(message
->default_cs
, raw_value
);
156 BT_ASSERT(!message
->packet
);
157 message
->packet
= packet
;
158 bt_object_get_ref_no_null_check_no_parent_check(
159 &message
->packet
->base
);
160 bt_packet_set_is_frozen(packet
, true);
161 BT_LIB_LOGD("Created packet message object: "
162 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
163 message
, packet
, stream
, stream_class
);
167 return (void *) message
;
170 struct bt_message
*bt_message_packet_beginning_create(
171 struct bt_self_message_iterator
*self_msg_iter
,
172 const struct bt_packet
*packet
)
174 struct bt_self_component_port_input_message_iterator
*msg_iter
=
175 (void *) self_msg_iter
;
177 BT_ASSERT_PRE_DEV_NO_ERROR();
178 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
179 return create_packet_message(msg_iter
, (void *) packet
,
180 &msg_iter
->graph
->packet_begin_msg_pool
, false, 0);
183 struct bt_message
*bt_message_packet_beginning_create_with_default_clock_snapshot(
184 struct bt_self_message_iterator
*self_msg_iter
,
185 const struct bt_packet
*packet
, uint64_t raw_value
)
187 struct bt_self_component_port_input_message_iterator
*msg_iter
=
188 (void *) self_msg_iter
;
190 BT_ASSERT_PRE_DEV_NO_ERROR();
191 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
192 return create_packet_message(msg_iter
, (void *) packet
,
193 &msg_iter
->graph
->packet_begin_msg_pool
, true, raw_value
);
196 struct bt_message
*bt_message_packet_end_create(
197 struct bt_self_message_iterator
*self_msg_iter
,
198 const struct bt_packet
*packet
)
200 struct bt_self_component_port_input_message_iterator
*msg_iter
=
201 (void *) self_msg_iter
;
203 BT_ASSERT_PRE_DEV_NO_ERROR();
204 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
205 return create_packet_message(msg_iter
, (void *) packet
,
206 &msg_iter
->graph
->packet_end_msg_pool
, false, 0);
209 struct bt_message
*bt_message_packet_end_create_with_default_clock_snapshot(
210 struct bt_self_message_iterator
*self_msg_iter
,
211 const struct bt_packet
*packet
, uint64_t raw_value
)
213 struct bt_self_component_port_input_message_iterator
*msg_iter
=
214 (void *) self_msg_iter
;
216 BT_ASSERT_PRE_DEV_NO_ERROR();
217 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
218 return create_packet_message(msg_iter
, (void *) packet
,
219 &msg_iter
->graph
->packet_end_msg_pool
, true, raw_value
);
223 void bt_message_packet_destroy(struct bt_message
*msg
)
225 struct bt_message_packet
*packet_msg
= (void *) msg
;
227 BT_LIB_LOGD("Destroying packet message: %!+n", msg
);
228 BT_LIB_LOGD("Putting packet: %!+a", packet_msg
->packet
);
229 BT_OBJECT_PUT_REF_AND_RESET(packet_msg
->packet
);
231 if (packet_msg
->default_cs
) {
232 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
233 packet_msg
->default_cs
= NULL
;
240 void recycle_packet_message(struct bt_message
*msg
, struct bt_object_pool
*pool
)
242 struct bt_message_packet
*packet_msg
= (void *) msg
;
244 BT_LIB_LOGD("Recycling packet message: %!+n", msg
);
245 bt_message_reset(msg
);
246 bt_object_put_ref_no_null_check(&packet_msg
->packet
->base
);
248 if (packet_msg
->default_cs
) {
249 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
250 packet_msg
->default_cs
= NULL
;
253 packet_msg
->packet
= NULL
;
255 bt_object_pool_recycle_object(pool
, msg
);
259 void bt_message_packet_beginning_recycle(struct bt_message
*msg
)
263 if (G_UNLIKELY(!msg
->graph
)) {
264 bt_message_packet_destroy(msg
);
268 recycle_packet_message(msg
, &msg
->graph
->packet_begin_msg_pool
);
272 void bt_message_packet_end_recycle(struct bt_message
*msg
)
276 if (G_UNLIKELY(!msg
->graph
)) {
277 bt_message_packet_destroy(msg
);
281 recycle_packet_message(msg
, &msg
->graph
->packet_end_msg_pool
);
284 struct bt_packet
*bt_message_packet_beginning_borrow_packet(
285 struct bt_message
*message
)
287 struct bt_message_packet
*packet_msg
= (void *) message
;
289 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
290 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
291 BT_MESSAGE_TYPE_PACKET_BEGINNING
);
292 return packet_msg
->packet
;
295 const struct bt_packet
*bt_message_packet_beginning_borrow_packet_const(
296 const struct bt_message
*message
)
298 return bt_message_packet_beginning_borrow_packet(
302 struct bt_packet
*bt_message_packet_end_borrow_packet(
303 struct bt_message
*message
)
305 struct bt_message_packet
*packet_msg
= (void *) message
;
307 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
308 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
309 BT_MESSAGE_TYPE_PACKET_END
);
310 return packet_msg
->packet
;
313 const struct bt_packet
*bt_message_packet_end_borrow_packet_const(
314 const struct bt_message
*message
)
316 return bt_message_packet_end_borrow_packet(
321 const struct bt_clock_snapshot
*
322 borrow_packet_message_default_clock_snapshot_const(
323 const struct bt_message
*message
)
325 struct bt_message_packet
*packet_msg
= (void *) message
;
327 BT_ASSERT_DBG(message
);
329 packet_msg
->packet
->stream
->class->default_clock_class
,
330 "Message's stream's class has no default clock class: "
331 "%![msg-]+n, %![sc-]+S",
332 message
, packet_msg
->packet
->stream
->class);
333 return packet_msg
->default_cs
;
336 const struct bt_clock_snapshot
*
337 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
338 const struct bt_message
*msg
)
340 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
341 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_BEGINNING
);
342 return borrow_packet_message_default_clock_snapshot_const(msg
);
345 const struct bt_clock_snapshot
*
346 bt_message_packet_end_borrow_default_clock_snapshot_const(
347 const struct bt_message
*msg
)
349 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
350 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_END
);
351 return borrow_packet_message_default_clock_snapshot_const(msg
);
355 const struct bt_clock_class
*
356 borrow_packet_message_stream_class_default_clock_class(
357 const struct bt_message
*msg
)
359 struct bt_message_packet
*packet_msg
= (void *) msg
;
362 return packet_msg
->packet
->stream
->class->default_clock_class
;
365 const struct bt_clock_class
*
366 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
367 const struct bt_message
*msg
)
369 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
370 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_BEGINNING
);
371 return borrow_packet_message_stream_class_default_clock_class(msg
);
374 const struct bt_clock_class
*
375 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
376 const struct bt_message
*msg
)
378 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
379 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_END
);
380 return borrow_packet_message_stream_class_default_clock_class(msg
);