Cleanup: add `#include <stdbool.h>` whenever `bool` type is used
[babeltrace.git] / src / lib / graph / message / discarded-items.c
CommitLineData
8f1a1bbb
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
b03487ab 23#define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS"
1633ef46 24#include "lib/logging.h"
8f1a1bbb 25
969c1d8a
FD
26#include <stdbool.h>
27
57952005
MJ
28#include "lib/assert-pre.h"
29#include "lib/object.h"
30#include "compat/compiler.h"
71c5da58 31#include <babeltrace2/trace-ir/clock-class.h>
57952005
MJ
32#include "lib/trace-ir/clock-snapshot.h"
33#include "lib/trace-ir/stream-class.h"
34#include "lib/trace-ir/stream.h"
35#include "lib/property.h"
36#include "lib/graph/message/message.h"
71c5da58
MJ
37#include <babeltrace2/graph/message-discarded-events.h>
38#include <babeltrace2/graph/message-discarded-events-const.h>
39#include <babeltrace2/graph/message-discarded-packets.h>
40#include <babeltrace2/graph/message-discarded-packets-const.h>
8f1a1bbb 41
57952005
MJ
42#include "discarded-items.h"
43
8f1a1bbb
PP
44static
45void destroy_discarded_items_message(struct bt_object *obj)
46{
47 struct bt_message_discarded_items *message = (void *) obj;
48
49 BT_LIB_LOGD("Destroying discarded items message: %!+n", message);
50 BT_LIB_LOGD("Putting stream: %!+s", message->stream);
51 BT_OBJECT_PUT_REF_AND_RESET(message->stream);
52
53 if (message->default_begin_cs) {
54 bt_clock_snapshot_recycle(message->default_begin_cs);
55 message->default_begin_cs = NULL;
56 }
57
58 if (message->default_end_cs) {
59 bt_clock_snapshot_recycle(message->default_end_cs);
60 message->default_end_cs = NULL;
61 }
62
63 g_free(message);
64}
65
66static inline
67struct bt_message *create_discarded_items_message(
68 struct bt_self_message_iterator *self_msg_iter,
69 enum bt_message_type type, struct bt_stream *stream,
70 bool with_cs,
71 uint64_t beginning_raw_value, uint64_t end_raw_value)
72{
73 struct bt_message_discarded_items *message;
74 struct bt_stream_class *stream_class;
77037b2b 75 bool has_support;
e934e1b6 76 bool need_cs;
8f1a1bbb
PP
77
78 BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
79 BT_ASSERT_PRE_NON_NULL(stream, "Stream");
80 stream_class = bt_stream_borrow_class(stream);
81 BT_ASSERT(stream_class);
77037b2b
PP
82
83 if (type == BT_MESSAGE_TYPE_DISCARDED_EVENTS) {
84 has_support = stream_class->supports_discarded_events;
e934e1b6 85 need_cs = stream_class->discarded_events_have_default_clock_snapshots;
77037b2b
PP
86 } else {
87 has_support = stream_class->supports_discarded_packets;
e934e1b6 88 need_cs = stream_class->discarded_packets_have_default_clock_snapshots;
77037b2b
PP
89 }
90
91 BT_ASSERT_PRE(has_support,
92 "Stream class does not support discarded events or packets: "
93 "type=%s, %![stream-]+s, %![sc-]+S",
94 bt_message_type_string(type), stream, stream_class);
e934e1b6 95 BT_ASSERT_PRE(need_cs ? with_cs : true,
77037b2b 96 "Unexpected stream class configuration when creating "
e934e1b6
PP
97 "a discarded events or discarded packets message: "
98 "default clock snapshots are needed, but none was provided: "
99 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
100 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
101 bt_message_type_string(type), stream, stream_class,
102 with_cs, beginning_raw_value, end_raw_value);
103 BT_ASSERT_PRE(!need_cs ? !with_cs : true,
104 "Unexpected stream class configuration when creating "
105 "a discarded events or discarded packets message: "
106 "no default clock snapshots are needed, but two were provided: "
0bed0a49
PP
107 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
108 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
109 bt_message_type_string(type), stream, stream_class,
110 with_cs, beginning_raw_value, end_raw_value);
8f1a1bbb
PP
111 BT_LIB_LOGD("Creating discarded items message object: "
112 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
113 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
114 bt_message_type_string(type), stream, stream_class,
115 with_cs, beginning_raw_value, end_raw_value);
116 message = g_new0(struct bt_message_discarded_items, 1);
117 if (!message) {
a8f90e5d
PP
118 BT_LIB_LOGE_APPEND_CAUSE(
119 "Failed to allocate one discarded items message.");
8f1a1bbb
PP
120 goto error;
121 }
122
123 bt_message_init(&message->parent, type,
124 destroy_discarded_items_message, NULL);
125 message->stream = stream;
864aa43f 126 bt_object_get_ref_no_null_check(message->stream);
8f1a1bbb
PP
127
128 if (with_cs) {
0bed0a49 129 BT_ASSERT(stream_class->default_clock_class);
8f1a1bbb
PP
130 message->default_begin_cs = bt_clock_snapshot_create(
131 stream_class->default_clock_class);
132 if (!message->default_begin_cs) {
133 goto error;
134 }
135
136 bt_clock_snapshot_set_raw_value(message->default_begin_cs,
137 beginning_raw_value);
138
139 message->default_end_cs = bt_clock_snapshot_create(
140 stream_class->default_clock_class);
141 if (!message->default_end_cs) {
142 goto error;
143 }
144
145 bt_clock_snapshot_set_raw_value(message->default_end_cs,
146 end_raw_value);
147 }
148
149 bt_property_uint_init(&message->count,
150 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
151 BT_LIB_LOGD("Created discarded items message object: "
152 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
153 stream, stream_class);
154
155 return (void *) &message->parent;
156
157error:
158 return NULL;
159}
160
161static inline
162struct bt_stream *borrow_discarded_items_message_stream(
163 struct bt_message *message)
164{
165 struct bt_message_discarded_items *disc_items_msg = (void *) message;
166
ec4a3354 167 BT_ASSERT_DBG(message);
8f1a1bbb
PP
168 return disc_items_msg->stream;
169}
170
171static inline
172void set_discarded_items_message_count(struct bt_message *message,
173 uint64_t count)
174{
175 struct bt_message_discarded_items *disc_items_msg = (void *) message;
176
177 BT_ASSERT(message);
fa6cfec3 178 BT_ASSERT_PRE_DEV_HOT(message, "Message", ": %!+n", message);
8f1a1bbb
PP
179 bt_property_uint_set(&disc_items_msg->count, count);
180}
181
182static inline
183enum bt_property_availability get_discarded_items_message_count(
184 const struct bt_message *message, uint64_t *count)
185{
186 struct bt_message_discarded_items *disc_items_msg = (void *) message;
187
fa6cfec3 188 BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
ec4a3354 189 BT_ASSERT_DBG(message);
8f1a1bbb
PP
190 *count = disc_items_msg->count.value;
191 return disc_items_msg->count.base.avail;
192}
193
194static inline
11ddb3ef 195const struct bt_clock_snapshot *
5ef34326 196borrow_discarded_items_message_beginning_default_clock_snapshot_const(
11ddb3ef 197 const struct bt_message *message)
8f1a1bbb
PP
198{
199 struct bt_message_discarded_items *disc_items_msg = (void *) message;
200
ec4a3354 201 BT_ASSERT_DBG(message);
fa6cfec3 202 BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
8f1a1bbb
PP
203 "Message's stream's class has no default clock class: "
204 "%![msg-]+n, %![sc-]+S",
205 message, disc_items_msg->stream->class);
11ddb3ef 206 return disc_items_msg->default_begin_cs;
8f1a1bbb
PP
207}
208
209static inline
11ddb3ef 210const struct bt_clock_snapshot *
5ef34326 211borrow_discarded_items_message_end_default_clock_snapshot_const(
11ddb3ef 212 const struct bt_message *message)
8f1a1bbb
PP
213{
214 struct bt_message_discarded_items *disc_items_msg = (void *) message;
215
ec4a3354 216 BT_ASSERT_DBG(message);
fa6cfec3 217 BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
8f1a1bbb
PP
218 "Message's stream's class has no default clock class: "
219 "%![msg-]+n, %![sc-]+S",
220 message, disc_items_msg->stream->class);
11ddb3ef 221 return disc_items_msg->default_end_cs;
8f1a1bbb
PP
222}
223
224struct bt_message *bt_message_discarded_events_create(
225 struct bt_self_message_iterator *message_iterator,
6a6975d2 226 const struct bt_stream *stream)
8f1a1bbb
PP
227{
228 return create_discarded_items_message(message_iterator,
6a6975d2 229 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
8f1a1bbb
PP
230 false, 0, 0);
231}
232
233struct bt_message *bt_message_discarded_events_create_with_default_clock_snapshots(
234 struct bt_self_message_iterator *message_iterator,
6a6975d2 235 const struct bt_stream *stream, uint64_t beginning_raw_value,
8f1a1bbb
PP
236 uint64_t end_raw_value)
237{
238 return create_discarded_items_message(message_iterator,
6a6975d2 239 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
8f1a1bbb
PP
240 true, beginning_raw_value, end_raw_value);
241}
242
243struct bt_stream *bt_message_discarded_events_borrow_stream(
244 struct bt_message *message)
245{
fa6cfec3
PP
246 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
247 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
8f1a1bbb
PP
248 return borrow_discarded_items_message_stream(message);
249}
250
251void bt_message_discarded_events_set_count(struct bt_message *message,
252 uint64_t count)
253{
254 BT_ASSERT_PRE_NON_NULL(message, "Message");
255 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
256 set_discarded_items_message_count(message, count);
257}
258
11ddb3ef 259const struct bt_clock_snapshot *
5ef34326 260bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
11ddb3ef 261 const struct bt_message *msg)
8f1a1bbb 262{
fa6cfec3
PP
263 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
264 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
5ef34326 265 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
11ddb3ef 266 msg);
8f1a1bbb
PP
267}
268
11ddb3ef 269const struct bt_clock_snapshot *
5ef34326 270bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
11ddb3ef 271 const struct bt_message *msg)
8f1a1bbb 272{
fa6cfec3
PP
273 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
274 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
5ef34326 275 return borrow_discarded_items_message_end_default_clock_snapshot_const(
11ddb3ef 276 msg);
8f1a1bbb
PP
277}
278
279const struct bt_stream *
280bt_message_discarded_events_borrow_stream_const(const struct bt_message *message)
281{
282 return (void *) bt_message_discarded_events_borrow_stream(
283 (void *) message);
284}
285
286enum bt_property_availability bt_message_discarded_events_get_count(
287 const struct bt_message *message, uint64_t *count)
288{
fa6cfec3
PP
289 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
290 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
291 BT_MESSAGE_TYPE_DISCARDED_EVENTS);
8f1a1bbb
PP
292 return get_discarded_items_message_count(message, count);
293}
2df5d26f
PP
294
295struct bt_message *bt_message_discarded_packets_create(
296 struct bt_self_message_iterator *message_iterator,
6a6975d2 297 const struct bt_stream *stream)
2df5d26f
PP
298{
299 return create_discarded_items_message(message_iterator,
6a6975d2 300 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
2df5d26f
PP
301 false, 0, 0);
302}
303
304struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
305 struct bt_self_message_iterator *message_iterator,
6a6975d2 306 const struct bt_stream *stream, uint64_t beginning_raw_value,
2df5d26f
PP
307 uint64_t end_raw_value)
308{
309 return create_discarded_items_message(message_iterator,
6a6975d2 310 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
2df5d26f
PP
311 true, beginning_raw_value, end_raw_value);
312}
313
314struct bt_stream *bt_message_discarded_packets_borrow_stream(
315 struct bt_message *message)
316{
fa6cfec3
PP
317 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
318 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
319 BT_MESSAGE_TYPE_DISCARDED_PACKETS);
2df5d26f
PP
320 return borrow_discarded_items_message_stream(message);
321}
322
323void bt_message_discarded_packets_set_count(struct bt_message *message,
324 uint64_t count)
325{
326 BT_ASSERT_PRE_NON_NULL(message, "Message");
327 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
328 set_discarded_items_message_count(message, count);
329}
330
11ddb3ef 331const struct bt_clock_snapshot *
5ef34326 332bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
11ddb3ef 333 const struct bt_message *msg)
2df5d26f 334{
fa6cfec3
PP
335 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
336 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
5ef34326 337 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
11ddb3ef 338 msg);
2df5d26f
PP
339}
340
11ddb3ef 341const struct bt_clock_snapshot *
5ef34326 342bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
11ddb3ef 343 const struct bt_message *msg)
2df5d26f 344{
fa6cfec3
PP
345 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
346 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
5ef34326 347 return borrow_discarded_items_message_end_default_clock_snapshot_const(
11ddb3ef 348 msg);
2df5d26f
PP
349}
350
351const struct bt_stream *
352bt_message_discarded_packets_borrow_stream_const(const struct bt_message *message)
353{
354 return (void *) bt_message_discarded_packets_borrow_stream(
355 (void *) message);
356}
357
358enum bt_property_availability bt_message_discarded_packets_get_count(
359 const struct bt_message *message, uint64_t *count)
360{
fa6cfec3
PP
361 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
362 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
363 BT_MESSAGE_TYPE_DISCARDED_PACKETS);
2df5d26f
PP
364 return get_discarded_items_message_count(message, count);
365}
2d2affbb
PP
366
367static inline
368const struct bt_clock_class *
369borrow_discarded_items_message_stream_class_default_clock_class(
370 const struct bt_message *msg)
371{
372 struct bt_message_discarded_items *disc_items_msg = (void *) msg;
373
ec4a3354 374 BT_ASSERT_DBG(msg);
2d2affbb
PP
375 return disc_items_msg->stream->class->default_clock_class;
376}
377
378const struct bt_clock_class *
379bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
380 const struct bt_message *msg)
381{
fa6cfec3
PP
382 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
383 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
2d2affbb
PP
384 return borrow_discarded_items_message_stream_class_default_clock_class(
385 msg);
386}
387
388const struct bt_clock_class *
389bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
390 const struct bt_message *msg)
391{
fa6cfec3
PP
392 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
393 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
2d2affbb
PP
394 return borrow_discarded_items_message_stream_class_default_clock_class(
395 msg);
396}
This page took 0.0586449999999999 seconds and 4 git commands to generate.