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 "MSG-PACKET"
25 #include <babeltrace/lib-logging-internal.h>
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>
33 #include <babeltrace/graph/graph-internal.h>
34 #include <babeltrace/graph/message-packet-const.h>
35 #include <babeltrace/graph/message-packet.h>
36 #include <babeltrace/graph/message-packet-internal.h>
37 #include <babeltrace/assert-internal.h>
38 #include <babeltrace/assert-pre-internal.h>
39 #include <babeltrace/object-internal.h>
43 struct bt_message
*bt_message_packet_beginning_new(struct bt_graph
*graph
)
45 struct bt_message_packet_beginning
*message
;
47 message
= g_new0(struct bt_message_packet_beginning
, 1);
49 BT_LOGE_STR("Failed to allocate one packet beginning message.");
53 bt_message_init(&message
->parent
,
54 BT_MESSAGE_TYPE_PACKET_BEGINNING
,
55 (bt_object_release_func
) bt_message_packet_beginning_recycle
,
60 BT_OBJECT_PUT_REF_AND_RESET(message
);
63 return (void *) message
;
66 struct bt_message
*bt_message_packet_beginning_create(
67 struct bt_self_message_iterator
*self_msg_iter
,
68 struct bt_packet
*packet
)
70 struct bt_self_component_port_input_message_iterator
*msg_iter
=
71 (void *) self_msg_iter
;
72 struct bt_message_packet_beginning
*message
= NULL
;
73 struct bt_stream
*stream
;
74 struct bt_stream_class
*stream_class
;
76 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
77 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
78 stream
= bt_packet_borrow_stream(packet
);
80 stream_class
= bt_stream_borrow_class(stream
);
81 BT_ASSERT(stream_class
);
82 BT_LIB_LOGD("Creating packet beginning message object: "
83 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
84 packet
, stream
, stream_class
);
85 message
= (void *) bt_message_create_from_pool(
86 &msg_iter
->graph
->packet_begin_msg_pool
, msg_iter
->graph
);
88 /* bt_message_create_from_pool() logs errors */
92 BT_ASSERT(!message
->packet
);
93 message
->packet
= packet
;
94 bt_object_get_no_null_check_no_parent_check(
95 &message
->packet
->base
);
96 bt_packet_set_is_frozen(packet
, true);
97 BT_LIB_LOGD("Created packet beginning message object: "
98 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
99 message
, packet
, stream
, stream_class
);
103 return (void *) message
;
107 void bt_message_packet_beginning_destroy(struct bt_message
*msg
)
109 struct bt_message_packet_beginning
*packet_begin_msg
= (void *) msg
;
111 BT_LIB_LOGD("Destroying packet beginning message: %!+n", msg
);
112 BT_LIB_LOGD("Putting packet: %!+a", packet_begin_msg
->packet
);
113 BT_OBJECT_PUT_REF_AND_RESET(packet_begin_msg
->packet
);
118 void bt_message_packet_beginning_recycle(struct bt_message
*msg
)
120 struct bt_message_packet_beginning
*packet_begin_msg
= (void *) msg
;
121 struct bt_graph
*graph
;
123 BT_ASSERT(packet_begin_msg
);
125 if (unlikely(!msg
->graph
)) {
126 bt_message_packet_beginning_destroy(msg
);
130 BT_LIB_LOGD("Recycling packet beginning message: %!+n", msg
);
131 bt_message_reset(msg
);
132 bt_object_put_no_null_check(&packet_begin_msg
->packet
->base
);
133 packet_begin_msg
->packet
= NULL
;
136 bt_object_pool_recycle_object(&graph
->packet_begin_msg_pool
, msg
);
139 struct bt_packet
*bt_message_packet_beginning_borrow_packet(
140 struct bt_message
*message
)
142 struct bt_message_packet_beginning
*packet_begin
;
144 BT_ASSERT_PRE_NON_NULL(message
, "Message");
145 BT_ASSERT_PRE_MSG_IS_TYPE(message
,
146 BT_MESSAGE_TYPE_PACKET_BEGINNING
);
147 packet_begin
= (void *) message
;
148 return packet_begin
->packet
;
151 const struct bt_packet
*bt_message_packet_beginning_borrow_packet_const(
152 const struct bt_message
*message
)
154 return bt_message_packet_beginning_borrow_packet(
159 struct bt_message
*bt_message_packet_end_new(struct bt_graph
*graph
)
161 struct bt_message_packet_end
*message
;
163 message
= g_new0(struct bt_message_packet_end
, 1);
165 BT_LOGE_STR("Failed to allocate one packet end message.");
169 bt_message_init(&message
->parent
,
170 BT_MESSAGE_TYPE_PACKET_END
,
171 (bt_object_release_func
) bt_message_packet_end_recycle
,
176 BT_OBJECT_PUT_REF_AND_RESET(message
);
179 return (void *) message
;
182 struct bt_message
*bt_message_packet_end_create(
183 struct bt_self_message_iterator
*self_msg_iter
,
184 struct bt_packet
*packet
)
186 struct bt_self_component_port_input_message_iterator
*msg_iter
=
187 (void *) self_msg_iter
;
188 struct bt_message_packet_end
*message
= NULL
;
189 struct bt_stream
*stream
;
190 struct bt_stream_class
*stream_class
;
192 BT_ASSERT_PRE_NON_NULL(msg_iter
, "Message iterator");
193 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
194 stream
= bt_packet_borrow_stream(packet
);
196 stream_class
= bt_stream_borrow_class(stream
);
197 BT_ASSERT(stream_class
);
198 BT_LIB_LOGD("Creating packet end message object: "
199 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
200 packet
, stream
, stream_class
);
201 message
= (void *) bt_message_create_from_pool(
202 &msg_iter
->graph
->packet_end_msg_pool
, msg_iter
->graph
);
204 /* bt_message_create_from_pool() logs errors */
208 BT_ASSERT(!message
->packet
);
209 message
->packet
= packet
;
210 bt_object_get_no_null_check_no_parent_check(
211 &message
->packet
->base
);
212 bt_packet_set_is_frozen(packet
, true);
213 BT_LIB_LOGD("Created packet end message object: "
214 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
215 message
, packet
, stream
, stream_class
);
219 return (void *) message
;
223 void bt_message_packet_end_destroy(struct bt_message
*msg
)
225 struct bt_message_packet_end
*packet_end_msg
= (void *) msg
;
227 BT_LIB_LOGD("Destroying packet end message: %!+n", msg
);
228 BT_LIB_LOGD("Putting packet: %!+a", packet_end_msg
->packet
);
229 BT_OBJECT_PUT_REF_AND_RESET(packet_end_msg
->packet
);
234 void bt_message_packet_end_recycle(struct bt_message
*msg
)
236 struct bt_message_packet_end
*packet_end_msg
= (void *) msg
;
237 struct bt_graph
*graph
;
239 BT_ASSERT(packet_end_msg
);
242 bt_message_packet_end_destroy(msg
);
246 BT_LIB_LOGD("Recycling packet end message: %!+n", msg
);
247 bt_message_reset(msg
);
248 BT_OBJECT_PUT_REF_AND_RESET(packet_end_msg
->packet
);
251 bt_object_pool_recycle_object(&graph
->packet_end_msg_pool
, msg
);
254 struct bt_packet
*bt_message_packet_end_borrow_packet(
255 struct bt_message
*message
)
257 struct bt_message_packet_end
*packet_end
;
259 BT_ASSERT_PRE_NON_NULL(message
, "Message");
260 BT_ASSERT_PRE_MSG_IS_TYPE(message
,
261 BT_MESSAGE_TYPE_PACKET_END
);
262 packet_end
= (void *) message
;
263 return packet_end
->packet
;
266 const struct bt_packet
*bt_message_packet_end_borrow_packet_const(
267 const struct bt_message
*message
)
269 return bt_message_packet_end_borrow_packet(