lib: remove "unknown clock snapshot" concept
[babeltrace.git] / lib / graph / message / packet.c
CommitLineData
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
45static inline
46struct 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
60error:
61 BT_OBJECT_PUT_REF_AND_RESET(message);
62
63end:
64 return (void *) message;
65}
66
5df26c89
PP
67BT_HIDDEN
68struct 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
74BT_HIDDEN
75struct 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
81static inline
a6d85d2f 82struct bt_message *create_packet_message(
5df26c89 83 struct bt_self_component_port_input_message_iterator *msg_iter,
a6d85d2f
PP
84 struct bt_packet *packet, struct bt_object_pool *pool,
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;
90
5df26c89 91 BT_ASSERT(msg_iter);
d6e69534
PP
92 BT_ASSERT_PRE_NON_NULL(packet, "Packet");
93 stream = bt_packet_borrow_stream(packet);
94 BT_ASSERT(stream);
95 stream_class = bt_stream_borrow_class(stream);
96 BT_ASSERT(stream_class);
a6d85d2f
PP
97 BT_ASSERT_PRE((with_cs && stream_class->default_clock_class) ||
98 (!with_cs && !stream_class->default_clock_class),
99 "Creating a packet message with a default clock snapshot, but without "
100 "a default clock class, or without a default clock snapshot, "
101 "but with a default clock class: ",
102 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
103 "cs-val=%" PRIu64,
104 stream, stream_class, with_cs, raw_value);
5df26c89 105 BT_LIB_LOGD("Creating packet message object: "
d6e69534
PP
106 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
107 packet, stream, stream_class);
5df26c89 108 message = (void *) bt_message_create_from_pool(pool, msg_iter->graph);
d6e69534
PP
109 if (!message) {
110 /* bt_message_create_from_pool() logs errors */
111 goto end;
112 }
113
a6d85d2f
PP
114 if (with_cs) {
115 BT_ASSERT(stream_class->default_clock_class);
116 message->default_cs = bt_clock_snapshot_create(
117 stream_class->default_clock_class);
118 if (!message->default_cs) {
119 bt_object_put_no_null_check(message);
120 message = NULL;
121 goto end;
122 }
123
124 bt_clock_snapshot_set_raw_value(message->default_cs, raw_value);
125 }
126
d6e69534
PP
127 BT_ASSERT(!message->packet);
128 message->packet = packet;
129 bt_object_get_no_null_check_no_parent_check(
130 &message->packet->base);
131 bt_packet_set_is_frozen(packet, true);
5df26c89 132 BT_LIB_LOGD("Created packet message object: "
d6e69534
PP
133 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
134 message, packet, stream, stream_class);
135 goto end;
136
137end:
138 return (void *) message;
139}
140
5df26c89
PP
141struct bt_message *bt_message_packet_beginning_create(
142 struct bt_self_message_iterator *self_msg_iter,
58085ca4 143 const struct bt_packet *packet)
d6e69534 144{
5df26c89
PP
145 struct bt_self_component_port_input_message_iterator *msg_iter =
146 (void *) self_msg_iter;
d6e69534 147
5df26c89 148 BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
a6d85d2f
PP
149 return create_packet_message(msg_iter, (void *) packet,
150 &msg_iter->graph->packet_begin_msg_pool, false, 0);
151}
152
153struct bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot(
154 struct bt_self_message_iterator *self_msg_iter,
155 const struct bt_packet *packet, uint64_t raw_value)
156{
157 struct bt_self_component_port_input_message_iterator *msg_iter =
158 (void *) self_msg_iter;
159
160 BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
161 return create_packet_message(msg_iter, (void *) packet,
162 &msg_iter->graph->packet_begin_msg_pool, true, raw_value);
d6e69534
PP
163}
164
5df26c89
PP
165struct bt_message *bt_message_packet_end_create(
166 struct bt_self_message_iterator *self_msg_iter,
58085ca4 167 const struct bt_packet *packet)
d6e69534 168{
5df26c89
PP
169 struct bt_self_component_port_input_message_iterator *msg_iter =
170 (void *) self_msg_iter;
d6e69534 171
5df26c89 172 BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
a6d85d2f
PP
173 return create_packet_message(msg_iter, (void *) packet,
174 &msg_iter->graph->packet_end_msg_pool, false, 0);
175}
176
177struct bt_message *bt_message_packet_end_create_with_default_clock_snapshot(
178 struct bt_self_message_iterator *self_msg_iter,
179 const struct bt_packet *packet, uint64_t raw_value)
180{
181 struct bt_self_component_port_input_message_iterator *msg_iter =
182 (void *) self_msg_iter;
183
184 BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
185 return create_packet_message(msg_iter, (void *) packet,
186 &msg_iter->graph->packet_end_msg_pool, true, raw_value);
d6e69534
PP
187}
188
5df26c89
PP
189BT_HIDDEN
190void bt_message_packet_destroy(struct bt_message *msg)
d6e69534 191{
5df26c89 192 struct bt_message_packet *packet_msg = (void *) msg;
d6e69534 193
5df26c89
PP
194 BT_LIB_LOGD("Destroying packet message: %!+n", msg);
195 BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet);
196 BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet);
a6d85d2f
PP
197
198 if (packet_msg->default_cs) {
199 bt_clock_snapshot_recycle(packet_msg->default_cs);
200 packet_msg->default_cs = NULL;
201 }
202
5df26c89 203 g_free(msg);
d6e69534
PP
204}
205
5df26c89
PP
206static inline
207void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool)
d6e69534 208{
5df26c89
PP
209 struct bt_message_packet *packet_msg = (void *) msg;
210
211 BT_LIB_LOGD("Recycling packet message: %!+n", msg);
212 bt_message_reset(msg);
213 bt_object_put_no_null_check(&packet_msg->packet->base);
a6d85d2f
PP
214
215 if (packet_msg->default_cs) {
216 bt_clock_snapshot_recycle(packet_msg->default_cs);
217 packet_msg->default_cs = NULL;
218 }
219
5df26c89
PP
220 packet_msg->packet = NULL;
221 msg->graph = NULL;
222 bt_object_pool_recycle_object(pool, msg);
d6e69534
PP
223}
224
225BT_HIDDEN
5df26c89 226void bt_message_packet_beginning_recycle(struct bt_message *msg)
d6e69534 227{
5df26c89 228 BT_ASSERT(msg);
d6e69534 229
5df26c89
PP
230 if (unlikely(!msg->graph)) {
231 bt_message_packet_destroy(msg);
232 return;
d6e69534
PP
233 }
234
5df26c89 235 recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool);
d6e69534
PP
236}
237
5df26c89
PP
238BT_HIDDEN
239void bt_message_packet_end_recycle(struct bt_message *msg)
d6e69534 240{
5df26c89 241 BT_ASSERT(msg);
d6e69534 242
5df26c89
PP
243 if (unlikely(!msg->graph)) {
244 bt_message_packet_destroy(msg);
245 return;
d6e69534
PP
246 }
247
5df26c89 248 recycle_packet_message(msg, &msg->graph->packet_end_msg_pool);
d6e69534
PP
249}
250
5df26c89
PP
251struct bt_packet *bt_message_packet_beginning_borrow_packet(
252 struct bt_message *message)
d6e69534 253{
5df26c89 254 struct bt_message_packet *packet_msg = (void *) message;
d6e69534 255
5df26c89
PP
256 BT_ASSERT_PRE_NON_NULL(message, "Message");
257 BT_ASSERT_PRE_MSG_IS_TYPE(message,
258 BT_MESSAGE_TYPE_PACKET_BEGINNING);
259 return packet_msg->packet;
d6e69534
PP
260}
261
5df26c89
PP
262const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
263 const struct bt_message *message)
d6e69534 264{
5df26c89
PP
265 return bt_message_packet_beginning_borrow_packet(
266 (void *) message);
d6e69534
PP
267}
268
269struct bt_packet *bt_message_packet_end_borrow_packet(
270 struct bt_message *message)
271{
5df26c89 272 struct bt_message_packet *packet_msg = (void *) message;
d6e69534
PP
273
274 BT_ASSERT_PRE_NON_NULL(message, "Message");
275 BT_ASSERT_PRE_MSG_IS_TYPE(message,
276 BT_MESSAGE_TYPE_PACKET_END);
5df26c89 277 return packet_msg->packet;
d6e69534
PP
278}
279
280const struct bt_packet *bt_message_packet_end_borrow_packet_const(
281 const struct bt_message *message)
282{
283 return bt_message_packet_end_borrow_packet(
284 (void *) message);
285}
a6d85d2f
PP
286
287static inline
0cbc2c33 288const struct bt_clock_snapshot *
a6d85d2f 289borrow_packet_message_default_clock_snapshot_const(
0cbc2c33 290 const struct bt_message *message)
a6d85d2f
PP
291{
292 struct bt_message_packet *packet_msg = (void *) message;
293
294 BT_ASSERT(message);
295 BT_ASSERT_PRE(packet_msg->packet->stream->class->default_clock_class,
296 "Message's stream's class has no default clock class: "
297 "%![msg-]+n, %![sc-]+S",
298 message, packet_msg->packet->stream->class);
0cbc2c33 299 return packet_msg->default_cs;
a6d85d2f
PP
300}
301
0cbc2c33 302const struct bt_clock_snapshot *
a6d85d2f 303bt_message_packet_beginning_borrow_default_clock_snapshot_const(
0cbc2c33 304 const struct bt_message *msg)
a6d85d2f
PP
305{
306 BT_ASSERT_PRE_NON_NULL(msg, "Message");
307 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING);
0cbc2c33 308 return borrow_packet_message_default_clock_snapshot_const(msg);
a6d85d2f
PP
309}
310
0cbc2c33 311const struct bt_clock_snapshot *
a6d85d2f 312bt_message_packet_end_borrow_default_clock_snapshot_const(
0cbc2c33 313 const struct bt_message *msg)
a6d85d2f
PP
314{
315 BT_ASSERT_PRE_NON_NULL(msg, "Message");
316 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END);
0cbc2c33 317 return borrow_packet_message_default_clock_snapshot_const(msg);
a6d85d2f 318}
33931ab8
PP
319
320static inline
321const struct bt_clock_class *
322borrow_packet_message_stream_class_default_clock_class(
323 const struct bt_message *msg)
324{
325 struct bt_message_packet *packet_msg = (void *) msg;
326
327 BT_ASSERT(msg);
328 return packet_msg->packet->stream->class->default_clock_class;
329}
330
331const struct bt_clock_class *
332bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
333 const struct bt_message *msg)
334{
335 BT_ASSERT_PRE_NON_NULL(msg, "Message");
336 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_BEGINNING);
337 return borrow_packet_message_stream_class_default_clock_class(msg);
338}
339
340const struct bt_clock_class *
341bt_message_packet_end_borrow_stream_class_default_clock_class_const(
342 const struct bt_message *msg)
343{
344 BT_ASSERT_PRE_NON_NULL(msg, "Message");
345 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_PACKET_END);
346 return borrow_packet_message_stream_class_default_clock_class(msg);
347}
This page took 0.041186 seconds and 4 git commands to generate.