2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
7 #define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS"
8 #include "lib/logging.h"
12 #include "lib/assert-pre.h"
13 #include "lib/object.h"
14 #include "compat/compiler.h"
15 #include <babeltrace2/trace-ir/clock-class.h>
16 #include "lib/trace-ir/clock-snapshot.h"
17 #include "lib/trace-ir/stream-class.h"
18 #include "lib/trace-ir/stream.h"
19 #include "lib/property.h"
20 #include "lib/graph/message/message.h"
22 #include "discarded-items.h"
25 void destroy_discarded_items_message(struct bt_object
*obj
)
27 struct bt_message_discarded_items
*message
= (void *) obj
;
29 BT_LIB_LOGD("Destroying discarded items message: %!+n", message
);
30 BT_LIB_LOGD("Putting stream: %!+s", message
->stream
);
31 BT_OBJECT_PUT_REF_AND_RESET(message
->stream
);
33 if (message
->default_begin_cs
) {
34 bt_clock_snapshot_recycle(message
->default_begin_cs
);
35 message
->default_begin_cs
= NULL
;
38 if (message
->default_end_cs
) {
39 bt_clock_snapshot_recycle(message
->default_end_cs
);
40 message
->default_end_cs
= NULL
;
47 struct bt_message
*create_discarded_items_message(
48 struct bt_self_message_iterator
*self_msg_iter
,
49 enum bt_message_type type
, struct bt_stream
*stream
,
51 uint64_t beginning_raw_value
, uint64_t end_raw_value
)
53 struct bt_message_discarded_items
*message
;
54 struct bt_stream_class
*stream_class
;
58 BT_ASSERT_PRE_NON_NULL(self_msg_iter
, "Message iterator");
59 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
60 stream_class
= bt_stream_borrow_class(stream
);
61 BT_ASSERT(stream_class
);
63 if (type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
64 has_support
= stream_class
->supports_discarded_events
;
65 need_cs
= stream_class
->discarded_events_have_default_clock_snapshots
;
67 has_support
= stream_class
->supports_discarded_packets
;
68 need_cs
= stream_class
->discarded_packets_have_default_clock_snapshots
;
71 BT_ASSERT_PRE(has_support
,
72 "Stream class does not support discarded events or packets: "
73 "type=%s, %![stream-]+s, %![sc-]+S",
74 bt_message_type_string(type
), stream
, stream_class
);
75 BT_ASSERT_PRE(need_cs
? with_cs
: true,
76 "Unexpected stream class configuration when creating "
77 "a discarded events or discarded packets message: "
78 "default clock snapshots are needed, but none was provided: "
79 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
80 "cs-begin-val=%" PRIu64
", cs-end-val=%" PRIu64
,
81 bt_message_type_string(type
), stream
, stream_class
,
82 with_cs
, beginning_raw_value
, end_raw_value
);
83 BT_ASSERT_PRE(!need_cs
? !with_cs
: true,
84 "Unexpected stream class configuration when creating "
85 "a discarded events or discarded packets message: "
86 "no default clock snapshots are needed, but two were provided: "
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 BT_LIB_LOGD("Creating discarded items message object: "
92 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
93 "cs-begin-val=%" PRIu64
", cs-end-val=%" PRIu64
,
94 bt_message_type_string(type
), stream
, stream_class
,
95 with_cs
, beginning_raw_value
, end_raw_value
);
96 message
= g_new0(struct bt_message_discarded_items
, 1);
98 BT_LIB_LOGE_APPEND_CAUSE(
99 "Failed to allocate one discarded items message.");
103 bt_message_init(&message
->parent
, type
,
104 destroy_discarded_items_message
, NULL
);
105 message
->stream
= stream
;
106 bt_object_get_ref_no_null_check(message
->stream
);
109 BT_ASSERT(stream_class
->default_clock_class
);
110 message
->default_begin_cs
= bt_clock_snapshot_create(
111 stream_class
->default_clock_class
);
112 if (!message
->default_begin_cs
) {
116 bt_clock_snapshot_set_raw_value(message
->default_begin_cs
,
117 beginning_raw_value
);
119 message
->default_end_cs
= bt_clock_snapshot_create(
120 stream_class
->default_clock_class
);
121 if (!message
->default_end_cs
) {
125 bt_clock_snapshot_set_raw_value(message
->default_end_cs
,
129 bt_property_uint_init(&message
->count
,
130 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
131 BT_LIB_LOGD("Created discarded items message object: "
132 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message
,
133 stream
, stream_class
);
135 return (void *) &message
->parent
;
142 struct bt_stream
*borrow_discarded_items_message_stream(
143 struct bt_message
*message
)
145 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
147 BT_ASSERT_DBG(message
);
148 return disc_items_msg
->stream
;
152 void set_discarded_items_message_count(struct bt_message
*message
,
155 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
158 BT_ASSERT_PRE_DEV_HOT(message
, "Message", ": %!+n", message
);
159 bt_property_uint_set(&disc_items_msg
->count
, count
);
163 enum bt_property_availability
get_discarded_items_message_count(
164 const struct bt_message
*message
, uint64_t *count
)
166 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
168 BT_ASSERT_PRE_DEV_NON_NULL(count
, "Count (output)");
169 BT_ASSERT_DBG(message
);
170 *count
= disc_items_msg
->count
.value
;
171 return disc_items_msg
->count
.base
.avail
;
175 const struct bt_clock_snapshot
*
176 borrow_discarded_items_message_beginning_default_clock_snapshot_const(
177 const struct bt_message
*message
)
179 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
181 BT_ASSERT_DBG(message
);
182 BT_ASSERT_PRE_DEV(disc_items_msg
->stream
->class->default_clock_class
,
183 "Message's stream's class has no default clock class: "
184 "%![msg-]+n, %![sc-]+S",
185 message
, disc_items_msg
->stream
->class);
186 return disc_items_msg
->default_begin_cs
;
190 const struct bt_clock_snapshot
*
191 borrow_discarded_items_message_end_default_clock_snapshot_const(
192 const struct bt_message
*message
)
194 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
196 BT_ASSERT_DBG(message
);
197 BT_ASSERT_PRE_DEV(disc_items_msg
->stream
->class->default_clock_class
,
198 "Message's stream's class has no default clock class: "
199 "%![msg-]+n, %![sc-]+S",
200 message
, disc_items_msg
->stream
->class);
201 return disc_items_msg
->default_end_cs
;
204 struct bt_message
*bt_message_discarded_events_create(
205 struct bt_self_message_iterator
*message_iterator
,
206 const struct bt_stream
*stream
)
208 BT_ASSERT_PRE_DEV_NO_ERROR();
210 return create_discarded_items_message(message_iterator
,
211 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
215 struct bt_message
*bt_message_discarded_events_create_with_default_clock_snapshots(
216 struct bt_self_message_iterator
*message_iterator
,
217 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
218 uint64_t end_raw_value
)
220 BT_ASSERT_PRE_DEV_NO_ERROR();
222 return create_discarded_items_message(message_iterator
,
223 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
224 true, beginning_raw_value
, end_raw_value
);
227 struct bt_stream
*bt_message_discarded_events_borrow_stream(
228 struct bt_message
*message
)
230 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
231 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
232 return borrow_discarded_items_message_stream(message
);
235 void bt_message_discarded_events_set_count(struct bt_message
*message
,
238 BT_ASSERT_PRE_NON_NULL(message
, "Message");
239 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
240 set_discarded_items_message_count(message
, count
);
243 const struct bt_clock_snapshot
*
244 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
245 const struct bt_message
*msg
)
247 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
248 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
249 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
253 const struct bt_clock_snapshot
*
254 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
255 const struct bt_message
*msg
)
257 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
258 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
259 return borrow_discarded_items_message_end_default_clock_snapshot_const(
263 const struct bt_stream
*
264 bt_message_discarded_events_borrow_stream_const(const struct bt_message
*message
)
266 return (void *) bt_message_discarded_events_borrow_stream(
270 enum bt_property_availability
bt_message_discarded_events_get_count(
271 const struct bt_message
*message
, uint64_t *count
)
273 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
274 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
275 BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
276 return get_discarded_items_message_count(message
, count
);
279 struct bt_message
*bt_message_discarded_packets_create(
280 struct bt_self_message_iterator
*message_iterator
,
281 const struct bt_stream
*stream
)
283 BT_ASSERT_PRE_DEV_NO_ERROR();
285 return create_discarded_items_message(message_iterator
,
286 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
290 struct bt_message
*bt_message_discarded_packets_create_with_default_clock_snapshots(
291 struct bt_self_message_iterator
*message_iterator
,
292 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
293 uint64_t end_raw_value
)
295 BT_ASSERT_PRE_DEV_NO_ERROR();
297 return create_discarded_items_message(message_iterator
,
298 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
299 true, beginning_raw_value
, end_raw_value
);
302 struct bt_stream
*bt_message_discarded_packets_borrow_stream(
303 struct bt_message
*message
)
305 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
306 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
307 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
308 return borrow_discarded_items_message_stream(message
);
311 void bt_message_discarded_packets_set_count(struct bt_message
*message
,
314 BT_ASSERT_PRE_NON_NULL(message
, "Message");
315 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
316 set_discarded_items_message_count(message
, count
);
319 const struct bt_clock_snapshot
*
320 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
321 const struct bt_message
*msg
)
323 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
324 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
325 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
329 const struct bt_clock_snapshot
*
330 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
331 const struct bt_message
*msg
)
333 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
334 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
335 return borrow_discarded_items_message_end_default_clock_snapshot_const(
339 const struct bt_stream
*
340 bt_message_discarded_packets_borrow_stream_const(const struct bt_message
*message
)
342 return (void *) bt_message_discarded_packets_borrow_stream(
346 enum bt_property_availability
bt_message_discarded_packets_get_count(
347 const struct bt_message
*message
, uint64_t *count
)
349 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
350 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
351 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
352 return get_discarded_items_message_count(message
, count
);
356 const struct bt_clock_class
*
357 borrow_discarded_items_message_stream_class_default_clock_class(
358 const struct bt_message
*msg
)
360 struct bt_message_discarded_items
*disc_items_msg
= (void *) msg
;
363 return disc_items_msg
->stream
->class->default_clock_class
;
366 const struct bt_clock_class
*
367 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
368 const struct bt_message
*msg
)
370 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
371 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
372 return borrow_discarded_items_message_stream_class_default_clock_class(
376 const struct bt_clock_class
*
377 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
378 const struct bt_message
*msg
)
380 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
381 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
382 return borrow_discarded_items_message_stream_class_default_clock_class(