lib: create_packet_message(): make assertion message less convoluted
[babeltrace.git] / lib / graph / message / discarded-items.c
CommitLineData
4c833281
PP
1/*
2 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23#define BT_LOG_TAG "MSG-DISCARDED-ITEMS"
24#include <babeltrace/lib-logging-internal.h>
25
26#include <babeltrace/assert-pre-internal.h>
27#include <babeltrace/object-internal.h>
28#include <babeltrace/compiler-internal.h>
29#include <babeltrace/trace-ir/clock-class.h>
30#include <babeltrace/trace-ir/clock-snapshot-internal.h>
31#include <babeltrace/trace-ir/stream-class-internal.h>
32#include <babeltrace/trace-ir/stream-internal.h>
33#include <babeltrace/property-internal.h>
34#include <babeltrace/graph/message-internal.h>
35#include <babeltrace/graph/message-discarded-items-internal.h>
36#include <babeltrace/graph/message-discarded-events.h>
37#include <babeltrace/graph/message-discarded-events-const.h>
4237f1f2
PP
38#include <babeltrace/graph/message-discarded-packets.h>
39#include <babeltrace/graph/message-discarded-packets-const.h>
4c833281
PP
40
41static
42void destroy_discarded_items_message(struct bt_object *obj)
43{
44 struct bt_message_discarded_items *message = (void *) obj;
45
46 BT_LIB_LOGD("Destroying discarded items message: %!+n", message);
47 BT_LIB_LOGD("Putting stream: %!+s", message->stream);
48 BT_OBJECT_PUT_REF_AND_RESET(message->stream);
49
50 if (message->default_begin_cs) {
51 bt_clock_snapshot_recycle(message->default_begin_cs);
52 message->default_begin_cs = NULL;
53 }
54
55 if (message->default_end_cs) {
56 bt_clock_snapshot_recycle(message->default_end_cs);
57 message->default_end_cs = NULL;
58 }
59
60 g_free(message);
61}
62
63static inline
64struct bt_message *create_discarded_items_message(
65 struct bt_self_message_iterator *self_msg_iter,
66 enum bt_message_type type, struct bt_stream *stream,
67 bool with_cs,
68 uint64_t beginning_raw_value, uint64_t end_raw_value)
69{
70 struct bt_message_discarded_items *message;
71 struct bt_stream_class *stream_class;
72
73 BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
74 BT_ASSERT_PRE_NON_NULL(stream, "Stream");
75 stream_class = bt_stream_borrow_class(stream);
76 BT_ASSERT(stream_class);
aa12059b
PP
77 BT_ASSERT_PRE((with_cs && stream_class->default_clock_class) ||
78 (!with_cs && !stream_class->default_clock_class),
79 "Creating a message with a default clock snapshot, but without "
80 "a default clock class, or without a default clock snapshot, "
81 "but with a default clock class: ",
82 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
83 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
84 bt_message_type_string(type), stream, stream_class,
85 with_cs, beginning_raw_value, end_raw_value);
4c833281
PP
86 BT_LIB_LOGD("Creating discarded items message object: "
87 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
88 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
89 bt_message_type_string(type), stream, stream_class,
90 with_cs, beginning_raw_value, end_raw_value);
91 message = g_new0(struct bt_message_discarded_items, 1);
92 if (!message) {
93 BT_LOGE_STR("Failed to allocate one discarded items message.");
94 goto error;
95 }
96
97 bt_message_init(&message->parent, type,
98 destroy_discarded_items_message, NULL);
99 message->stream = stream;
100 bt_object_get_no_null_check(message->stream);
101
102 if (with_cs) {
aa12059b 103 BT_ASSERT(stream_class->default_clock_class);
4c833281
PP
104 message->default_begin_cs = bt_clock_snapshot_create(
105 stream_class->default_clock_class);
106 if (!message->default_begin_cs) {
107 goto error;
108 }
109
110 bt_clock_snapshot_set_raw_value(message->default_begin_cs,
111 beginning_raw_value);
112
113 message->default_end_cs = bt_clock_snapshot_create(
114 stream_class->default_clock_class);
115 if (!message->default_end_cs) {
116 goto error;
117 }
118
119 bt_clock_snapshot_set_raw_value(message->default_end_cs,
120 end_raw_value);
121 }
122
123 bt_property_uint_init(&message->count,
124 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
125 BT_LIB_LOGD("Created discarded items message object: "
126 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
127 stream, stream_class);
128
129 return (void *) &message->parent;
130
131error:
132 return NULL;
133}
134
135static inline
136struct bt_stream *borrow_discarded_items_message_stream(
137 struct bt_message *message)
138{
139 struct bt_message_discarded_items *disc_items_msg = (void *) message;
140
141 BT_ASSERT(message);
142 return disc_items_msg->stream;
143}
144
145static inline
146void set_discarded_items_message_count(struct bt_message *message,
147 uint64_t count)
148{
149 struct bt_message_discarded_items *disc_items_msg = (void *) message;
150
151 BT_ASSERT(message);
152 BT_ASSERT_PRE_HOT(message, "Message", ": %!+n", message);
153 bt_property_uint_set(&disc_items_msg->count, count);
154}
155
156static inline
157enum bt_property_availability get_discarded_items_message_count(
158 const struct bt_message *message, uint64_t *count)
159{
160 struct bt_message_discarded_items *disc_items_msg = (void *) message;
161
162 BT_ASSERT_PRE_NON_NULL(count, "Count (output)");
163 BT_ASSERT(message);
164 *count = disc_items_msg->count.value;
165 return disc_items_msg->count.base.avail;
166}
167
168static inline
0cbc2c33 169const struct bt_clock_snapshot *
4c833281 170borrow_discarded_items_message_default_beginning_clock_snapshot_const(
0cbc2c33 171 const struct bt_message *message)
4c833281
PP
172{
173 struct bt_message_discarded_items *disc_items_msg = (void *) message;
174
175 BT_ASSERT(message);
176 BT_ASSERT_PRE(disc_items_msg->stream->class->default_clock_class,
177 "Message's stream's class has no default clock class: "
178 "%![msg-]+n, %![sc-]+S",
179 message, disc_items_msg->stream->class);
0cbc2c33 180 return disc_items_msg->default_begin_cs;
4c833281
PP
181}
182
183static inline
0cbc2c33 184const struct bt_clock_snapshot *
4c833281 185borrow_discarded_items_message_default_end_clock_snapshot_const(
0cbc2c33 186 const struct bt_message *message)
4c833281
PP
187{
188 struct bt_message_discarded_items *disc_items_msg = (void *) message;
189
190 BT_ASSERT(message);
191 BT_ASSERT_PRE(disc_items_msg->stream->class->default_clock_class,
192 "Message's stream's class has no default clock class: "
193 "%![msg-]+n, %![sc-]+S",
194 message, disc_items_msg->stream->class);
0cbc2c33 195 return disc_items_msg->default_end_cs;
4c833281
PP
196}
197
198struct bt_message *bt_message_discarded_events_create(
199 struct bt_self_message_iterator *message_iterator,
58085ca4 200 const struct bt_stream *stream)
4c833281
PP
201{
202 return create_discarded_items_message(message_iterator,
58085ca4 203 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
4c833281
PP
204 false, 0, 0);
205}
206
207struct bt_message *bt_message_discarded_events_create_with_default_clock_snapshots(
208 struct bt_self_message_iterator *message_iterator,
58085ca4 209 const struct bt_stream *stream, uint64_t beginning_raw_value,
4c833281
PP
210 uint64_t end_raw_value)
211{
212 return create_discarded_items_message(message_iterator,
58085ca4 213 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
4c833281
PP
214 true, beginning_raw_value, end_raw_value);
215}
216
217struct bt_stream *bt_message_discarded_events_borrow_stream(
218 struct bt_message *message)
219{
220 BT_ASSERT_PRE_NON_NULL(message, "Message");
221 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
222 return borrow_discarded_items_message_stream(message);
223}
224
225void bt_message_discarded_events_set_count(struct bt_message *message,
226 uint64_t count)
227{
228 BT_ASSERT_PRE_NON_NULL(message, "Message");
229 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
230 set_discarded_items_message_count(message, count);
231}
232
0cbc2c33 233const struct bt_clock_snapshot *
4c833281 234bt_message_discarded_events_borrow_default_beginning_clock_snapshot_const(
0cbc2c33 235 const struct bt_message *msg)
4c833281
PP
236{
237 BT_ASSERT_PRE_NON_NULL(msg, "Message");
238 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
239 return borrow_discarded_items_message_default_beginning_clock_snapshot_const(
0cbc2c33 240 msg);
4c833281
PP
241}
242
0cbc2c33 243const struct bt_clock_snapshot *
4c833281 244bt_message_discarded_events_borrow_default_end_clock_snapshot_const(
0cbc2c33 245 const struct bt_message *msg)
4c833281
PP
246{
247 BT_ASSERT_PRE_NON_NULL(msg, "Message");
248 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
249 return borrow_discarded_items_message_default_end_clock_snapshot_const(
0cbc2c33 250 msg);
4c833281
PP
251}
252
253const struct bt_stream *
254bt_message_discarded_events_borrow_stream_const(const struct bt_message *message)
255{
256 return (void *) bt_message_discarded_events_borrow_stream(
257 (void *) message);
258}
259
260enum bt_property_availability bt_message_discarded_events_get_count(
261 const struct bt_message *message, uint64_t *count)
262{
263 BT_ASSERT_PRE_NON_NULL(message, "Message");
264 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
265 return get_discarded_items_message_count(message, count);
266}
4237f1f2
PP
267
268struct bt_message *bt_message_discarded_packets_create(
269 struct bt_self_message_iterator *message_iterator,
58085ca4 270 const struct bt_stream *stream)
4237f1f2
PP
271{
272 return create_discarded_items_message(message_iterator,
58085ca4 273 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
4237f1f2
PP
274 false, 0, 0);
275}
276
277struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
278 struct bt_self_message_iterator *message_iterator,
58085ca4 279 const struct bt_stream *stream, uint64_t beginning_raw_value,
4237f1f2
PP
280 uint64_t end_raw_value)
281{
282 return create_discarded_items_message(message_iterator,
58085ca4 283 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
4237f1f2
PP
284 true, beginning_raw_value, end_raw_value);
285}
286
287struct bt_stream *bt_message_discarded_packets_borrow_stream(
288 struct bt_message *message)
289{
290 BT_ASSERT_PRE_NON_NULL(message, "Message");
291 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
292 return borrow_discarded_items_message_stream(message);
293}
294
295void bt_message_discarded_packets_set_count(struct bt_message *message,
296 uint64_t count)
297{
298 BT_ASSERT_PRE_NON_NULL(message, "Message");
299 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
300 set_discarded_items_message_count(message, count);
301}
302
0cbc2c33 303const struct bt_clock_snapshot *
4237f1f2 304bt_message_discarded_packets_borrow_default_beginning_clock_snapshot_const(
0cbc2c33 305 const struct bt_message *msg)
4237f1f2
PP
306{
307 BT_ASSERT_PRE_NON_NULL(msg, "Message");
308 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
309 return borrow_discarded_items_message_default_beginning_clock_snapshot_const(
0cbc2c33 310 msg);
4237f1f2
PP
311}
312
0cbc2c33 313const struct bt_clock_snapshot *
4237f1f2 314bt_message_discarded_packets_borrow_default_end_clock_snapshot_const(
0cbc2c33 315 const struct bt_message *msg)
4237f1f2
PP
316{
317 BT_ASSERT_PRE_NON_NULL(msg, "Message");
318 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
319 return borrow_discarded_items_message_default_end_clock_snapshot_const(
0cbc2c33 320 msg);
4237f1f2
PP
321}
322
323const struct bt_stream *
324bt_message_discarded_packets_borrow_stream_const(const struct bt_message *message)
325{
326 return (void *) bt_message_discarded_packets_borrow_stream(
327 (void *) message);
328}
329
330enum bt_property_availability bt_message_discarded_packets_get_count(
331 const struct bt_message *message, uint64_t *count)
332{
333 BT_ASSERT_PRE_NON_NULL(message, "Message");
334 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
335 return get_discarded_items_message_count(message, count);
336}
33931ab8
PP
337
338static inline
339const struct bt_clock_class *
340borrow_discarded_items_message_stream_class_default_clock_class(
341 const struct bt_message *msg)
342{
343 struct bt_message_discarded_items *disc_items_msg = (void *) msg;
344
345 BT_ASSERT(msg);
346 return disc_items_msg->stream->class->default_clock_class;
347}
348
349const struct bt_clock_class *
350bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
351 const struct bt_message *msg)
352{
353 BT_ASSERT_PRE_NON_NULL(msg, "Message");
354 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
355 return borrow_discarded_items_message_stream_class_default_clock_class(
356 msg);
357}
358
359const struct bt_clock_class *
360bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
361 const struct bt_message *msg)
362{
363 BT_ASSERT_PRE_NON_NULL(msg, "Message");
364 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
365 return borrow_discarded_items_message_stream_class_default_clock_class(
366 msg);
367}
This page took 0.040154 seconds and 4 git commands to generate.