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"
27 #include "lib/assert-pre.h"
28 #include "lib/assert-post.h"
29 #include "compat/compiler.h"
30 #include <babeltrace2/trace-ir/packet.h>
31 #include "lib/trace-ir/packet.h"
32 #include <babeltrace2/trace-ir/stream-class.h>
33 #include <babeltrace2/trace-ir/stream.h>
34 #include "lib/trace-ir/stream.h"
35 #include "lib/trace-ir/stream-class.h"
36 #include "lib/graph/graph.h"
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>
41 #include "common/assert.h"
42 #include "lib/object.h"
48 struct bt_message
*new_packet_message(struct bt_graph
*graph
,
49 enum bt_message_type type
, bt_object_release_func recycle_func
)
51 struct bt_message_packet
*message
;
53 message
= g_new0(struct bt_message_packet
, 1);
55 BT_LOGE_STR("Failed to allocate one packet message.");
59 bt_message_init(&message
->parent
, type
, recycle_func
, graph
);
63 BT_OBJECT_PUT_REF_AND_RESET(message
);
66 return (void *) message
;
70 struct bt_message
*bt_message_packet_beginning_new(struct bt_graph
*graph
)
72 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_BEGINNING
,
73 (bt_object_release_func
) bt_message_packet_beginning_recycle
);
77 struct bt_message
*bt_message_packet_end_new(struct bt_graph
*graph
)
79 return new_packet_message(graph
, BT_MESSAGE_TYPE_PACKET_END
,
80 (bt_object_release_func
) bt_message_packet_end_recycle
);
84 struct bt_message
*create_packet_message(
85 struct bt_self_component_port_input_message_iterator
*msg_iter
,
86 struct bt_packet
*packet
, struct bt_object_pool
*pool
,
87 bool with_cs
, uint64_t raw_value
)
89 struct bt_message_packet
*message
= NULL
;
90 struct bt_stream
*stream
;
91 struct bt_stream_class
*stream_class
;
95 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
96 stream
= bt_packet_borrow_stream(packet
);
98 stream_class
= bt_stream_borrow_class(stream
);
99 BT_ASSERT(stream_class
);
101 if (pool
== &msg_iter
->graph
->packet_begin_msg_pool
) {
102 need_cs
= stream_class
->packets_have_beginning_default_clock_snapshot
;
104 need_cs
= stream_class
->packets_have_end_default_clock_snapshot
;
108 * `packet_has_default_clock_snapshot` implies that the stream
109 * class has a default clock class (precondition).
111 BT_ASSERT_PRE(need_cs
? with_cs
: true,
112 "Unexpected stream class configuration when creating "
113 "a packet beginning or end message: "
114 "a default clock snapshot is needed, but none was provided: "
115 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
117 stream
, stream_class
, with_cs
, raw_value
);
118 BT_ASSERT_PRE(!need_cs
? !with_cs
: true,
119 "Unexpected stream class configuration when creating "
120 "a packet beginning or end message: "
121 "no default clock snapshot is needed, but one was provided: "
122 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
124 stream
, stream_class
, with_cs
, raw_value
);
125 BT_LIB_LOGD("Creating packet message object: "
126 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
127 packet
, stream
, stream_class
);
128 message
= (void *) bt_message_create_from_pool(pool
, msg_iter
->graph
);
130 /* bt_message_create_from_pool() logs errors */
135 BT_ASSERT(stream_class
->default_clock_class
);
136 message
->default_cs
= bt_clock_snapshot_create(
137 stream_class
->default_clock_class
);
138 if (!message
->default_cs
) {
139 bt_object_put_no_null_check(message
);
144 bt_clock_snapshot_set_raw_value(message
->default_cs
, raw_value
);
147 BT_ASSERT(!message
->packet
);
148 message
->packet
= packet
;
149 bt_object_get_no_null_check_no_parent_check(
150 &message
->packet
->base
);
151 bt_packet_set_is_frozen(packet
, true);
152 BT_LIB_LOGD("Created packet message object: "
153 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
154 message
, packet
, stream
, stream_class
);
158 return (void *) message
;
161 struct bt_message
*bt_message_packet_beginning_create(
162 struct bt_self_message_iterator
*self_msg_iter
,
163 const struct bt_packet
*packet
)
165 struct bt_self_component_port_input_message_iterator
*msg_iter
=
166 (void *) self_msg_iter
;
168 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
169 return create_packet_message(msg_iter
, (void *) packet
,
170 &msg_iter
->graph
->packet_begin_msg_pool
, false, 0);
173 struct bt_message
*bt_message_packet_beginning_create_with_default_clock_snapshot(
174 struct bt_self_message_iterator
*self_msg_iter
,
175 const struct bt_packet
*packet
, uint64_t raw_value
)
177 struct bt_self_component_port_input_message_iterator
*msg_iter
=
178 (void *) self_msg_iter
;
180 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
181 return create_packet_message(msg_iter
, (void *) packet
,
182 &msg_iter
->graph
->packet_begin_msg_pool
, true, raw_value
);
185 struct bt_message
*bt_message_packet_end_create(
186 struct bt_self_message_iterator
*self_msg_iter
,
187 const struct bt_packet
*packet
)
189 struct bt_self_component_port_input_message_iterator
*msg_iter
=
190 (void *) self_msg_iter
;
192 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
193 return create_packet_message(msg_iter
, (void *) packet
,
194 &msg_iter
->graph
->packet_end_msg_pool
, false, 0);
197 struct bt_message
*bt_message_packet_end_create_with_default_clock_snapshot(
198 struct bt_self_message_iterator
*self_msg_iter
,
199 const struct bt_packet
*packet
, uint64_t raw_value
)
201 struct bt_self_component_port_input_message_iterator
*msg_iter
=
202 (void *) self_msg_iter
;
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
, true, raw_value
);
210 void bt_message_packet_destroy(struct bt_message
*msg
)
212 struct bt_message_packet
*packet_msg
= (void *) msg
;
214 BT_LIB_LOGD("Destroying packet message: %!+n", msg
);
215 BT_LIB_LOGD("Putting packet: %!+a", packet_msg
->packet
);
216 BT_OBJECT_PUT_REF_AND_RESET(packet_msg
->packet
);
218 if (packet_msg
->default_cs
) {
219 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
220 packet_msg
->default_cs
= NULL
;
227 void recycle_packet_message(struct bt_message
*msg
, struct bt_object_pool
*pool
)
229 struct bt_message_packet
*packet_msg
= (void *) msg
;
231 BT_LIB_LOGD("Recycling packet message: %!+n", msg
);
232 bt_message_reset(msg
);
233 bt_object_put_no_null_check(&packet_msg
->packet
->base
);
235 if (packet_msg
->default_cs
) {
236 bt_clock_snapshot_recycle(packet_msg
->default_cs
);
237 packet_msg
->default_cs
= NULL
;
240 packet_msg
->packet
= NULL
;
242 bt_object_pool_recycle_object(pool
, msg
);
246 void bt_message_packet_beginning_recycle(struct bt_message
*msg
)
250 if (G_UNLIKELY(!msg
->graph
)) {
251 bt_message_packet_destroy(msg
);
255 recycle_packet_message(msg
, &msg
->graph
->packet_begin_msg_pool
);
259 void bt_message_packet_end_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_end_msg_pool
);
271 struct bt_packet
*bt_message_packet_beginning_borrow_packet(
272 struct bt_message
*message
)
274 struct bt_message_packet
*packet_msg
= (void *) message
;
276 BT_ASSERT_PRE_NON_NULL(message
, "Message");
277 BT_ASSERT_PRE_MSG_IS_TYPE(message
,
278 BT_MESSAGE_TYPE_PACKET_BEGINNING
);
279 return packet_msg
->packet
;
282 const struct bt_packet
*bt_message_packet_beginning_borrow_packet_const(
283 const struct bt_message
*message
)
285 return bt_message_packet_beginning_borrow_packet(
289 struct bt_packet
*bt_message_packet_end_borrow_packet(
290 struct bt_message
*message
)
292 struct bt_message_packet
*packet_msg
= (void *) message
;
294 BT_ASSERT_PRE_NON_NULL(message
, "Message");
295 BT_ASSERT_PRE_MSG_IS_TYPE(message
,
296 BT_MESSAGE_TYPE_PACKET_END
);
297 return packet_msg
->packet
;
300 const struct bt_packet
*bt_message_packet_end_borrow_packet_const(
301 const struct bt_message
*message
)
303 return bt_message_packet_end_borrow_packet(
308 const struct bt_clock_snapshot
*
309 borrow_packet_message_default_clock_snapshot_const(
310 const struct bt_message
*message
)
312 struct bt_message_packet
*packet_msg
= (void *) message
;
315 BT_ASSERT_PRE(packet_msg
->packet
->stream
->class->default_clock_class
,
316 "Message's stream's class has no default clock class: "
317 "%![msg-]+n, %![sc-]+S",
318 message
, packet_msg
->packet
->stream
->class);
319 return packet_msg
->default_cs
;
322 const struct bt_clock_snapshot
*
323 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
324 const struct bt_message
*msg
)
326 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
327 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_BEGINNING
);
328 return borrow_packet_message_default_clock_snapshot_const(msg
);
331 const struct bt_clock_snapshot
*
332 bt_message_packet_end_borrow_default_clock_snapshot_const(
333 const struct bt_message
*msg
)
335 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
336 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_END
);
337 return borrow_packet_message_default_clock_snapshot_const(msg
);
341 const struct bt_clock_class
*
342 borrow_packet_message_stream_class_default_clock_class(
343 const struct bt_message
*msg
)
345 struct bt_message_packet
*packet_msg
= (void *) msg
;
348 return packet_msg
->packet
->stream
->class->default_clock_class
;
351 const struct bt_clock_class
*
352 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
353 const struct bt_message
*msg
)
355 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
356 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_BEGINNING
);
357 return borrow_packet_message_stream_class_default_clock_class(msg
);
360 const struct bt_clock_class
*
361 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
362 const struct bt_message
*msg
)
364 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
365 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_PACKET_END
);
366 return borrow_packet_message_stream_class_default_clock_class(msg
);