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-cond.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_MSG_ITER_NON_NULL(self_msg_iter
);
59 BT_ASSERT_PRE_STREAM_NON_NULL(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_MSG_HOT(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_MSG_SC_DEF_CLK_CLS(message
,
183 disc_items_msg
->stream
->class);
184 return disc_items_msg
->default_begin_cs
;
188 const struct bt_clock_snapshot
*
189 borrow_discarded_items_message_end_default_clock_snapshot_const(
190 const struct bt_message
*message
)
192 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
194 BT_ASSERT_DBG(message
);
195 BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS(message
,
196 disc_items_msg
->stream
->class);
197 return disc_items_msg
->default_end_cs
;
200 struct bt_message
*bt_message_discarded_events_create(
201 struct bt_self_message_iterator
*message_iterator
,
202 const struct bt_stream
*stream
)
204 BT_ASSERT_PRE_DEV_NO_ERROR();
206 return create_discarded_items_message(message_iterator
,
207 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
211 struct bt_message
*bt_message_discarded_events_create_with_default_clock_snapshots(
212 struct bt_self_message_iterator
*message_iterator
,
213 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
214 uint64_t end_raw_value
)
216 BT_ASSERT_PRE_DEV_NO_ERROR();
217 BT_ASSERT_PRE_MSG_CS_BEGIN_LE_END(message_iterator
,
218 beginning_raw_value
, end_raw_value
);
220 return create_discarded_items_message(message_iterator
,
221 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
222 true, beginning_raw_value
, end_raw_value
);
225 struct bt_stream
*bt_message_discarded_events_borrow_stream(
226 struct bt_message
*message
)
228 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message
);
229 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(message
,
230 BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
231 return borrow_discarded_items_message_stream(message
);
234 void bt_message_discarded_events_set_count(struct bt_message
*message
,
237 BT_ASSERT_PRE_MSG_NON_NULL(message
);
238 BT_ASSERT_PRE_MSG_HAS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
239 BT_ASSERT_PRE(count
> 0, "Discarded event count is 0.");
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_MSG_NON_NULL(msg
);
248 BT_ASSERT_PRE_DEV_MSG_HAS_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_MSG_NON_NULL(msg
);
258 BT_ASSERT_PRE_DEV_MSG_HAS_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_MSG_NON_NULL(message
);
274 BT_ASSERT_PRE_DEV_MSG_HAS_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();
296 BT_ASSERT_PRE_MSG_CS_BEGIN_LE_END(message_iterator
,
297 beginning_raw_value
, end_raw_value
);
299 return create_discarded_items_message(message_iterator
,
300 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
301 true, beginning_raw_value
, end_raw_value
);
304 struct bt_stream
*bt_message_discarded_packets_borrow_stream(
305 struct bt_message
*message
)
307 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message
);
308 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(message
,
309 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
310 return borrow_discarded_items_message_stream(message
);
313 void bt_message_discarded_packets_set_count(struct bt_message
*message
,
316 BT_ASSERT_PRE_MSG_NON_NULL(message
);
317 BT_ASSERT_PRE_MSG_HAS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
318 BT_ASSERT_PRE(count
> 0, "Discarded packet count is 0.");
319 set_discarded_items_message_count(message
, count
);
322 const struct bt_clock_snapshot
*
323 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
324 const struct bt_message
*msg
)
326 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
327 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
328 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
332 const struct bt_clock_snapshot
*
333 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
334 const struct bt_message
*msg
)
336 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
337 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
338 return borrow_discarded_items_message_end_default_clock_snapshot_const(
342 const struct bt_stream
*
343 bt_message_discarded_packets_borrow_stream_const(const struct bt_message
*message
)
345 return (void *) bt_message_discarded_packets_borrow_stream(
349 enum bt_property_availability
bt_message_discarded_packets_get_count(
350 const struct bt_message
*message
, uint64_t *count
)
352 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message
);
353 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(message
,
354 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
355 return get_discarded_items_message_count(message
, count
);
359 const struct bt_clock_class
*
360 borrow_discarded_items_message_stream_class_default_clock_class(
361 const struct bt_message
*msg
)
363 struct bt_message_discarded_items
*disc_items_msg
= (void *) msg
;
366 return disc_items_msg
->stream
->class->default_clock_class
;
369 const struct bt_clock_class
*
370 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
371 const struct bt_message
*msg
)
373 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
374 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
375 return borrow_discarded_items_message_stream_class_default_clock_class(
379 const struct bt_clock_class
*
380 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
381 const struct bt_message
*msg
)
383 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg
);
384 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
385 return borrow_discarded_items_message_stream_class_default_clock_class(