2 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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
23 #define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS"
24 #include "lib/logging.h"
28 #include "lib/assert-pre.h"
29 #include "lib/object.h"
30 #include "compat/compiler.h"
31 #include <babeltrace2/trace-ir/clock-class.h>
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"
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>
42 #include "discarded-items.h"
45 void destroy_discarded_items_message(struct bt_object
*obj
)
47 struct bt_message_discarded_items
*message
= (void *) obj
;
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
);
53 if (message
->default_begin_cs
) {
54 bt_clock_snapshot_recycle(message
->default_begin_cs
);
55 message
->default_begin_cs
= NULL
;
58 if (message
->default_end_cs
) {
59 bt_clock_snapshot_recycle(message
->default_end_cs
);
60 message
->default_end_cs
= NULL
;
67 struct 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
,
71 uint64_t beginning_raw_value
, uint64_t end_raw_value
)
73 struct bt_message_discarded_items
*message
;
74 struct bt_stream_class
*stream_class
;
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
);
83 if (type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
84 has_support
= stream_class
->supports_discarded_events
;
85 need_cs
= stream_class
->discarded_events_have_default_clock_snapshots
;
87 has_support
= stream_class
->supports_discarded_packets
;
88 need_cs
= stream_class
->discarded_packets_have_default_clock_snapshots
;
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
);
95 BT_ASSERT_PRE(need_cs
? with_cs
: true,
96 "Unexpected stream class configuration when creating "
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: "
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
);
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);
118 BT_LIB_LOGE_APPEND_CAUSE(
119 "Failed to allocate one discarded items message.");
123 bt_message_init(&message
->parent
, type
,
124 destroy_discarded_items_message
, NULL
);
125 message
->stream
= stream
;
126 bt_object_get_ref_no_null_check(message
->stream
);
129 BT_ASSERT(stream_class
->default_clock_class
);
130 message
->default_begin_cs
= bt_clock_snapshot_create(
131 stream_class
->default_clock_class
);
132 if (!message
->default_begin_cs
) {
136 bt_clock_snapshot_set_raw_value(message
->default_begin_cs
,
137 beginning_raw_value
);
139 message
->default_end_cs
= bt_clock_snapshot_create(
140 stream_class
->default_clock_class
);
141 if (!message
->default_end_cs
) {
145 bt_clock_snapshot_set_raw_value(message
->default_end_cs
,
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
);
155 return (void *) &message
->parent
;
162 struct bt_stream
*borrow_discarded_items_message_stream(
163 struct bt_message
*message
)
165 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
167 BT_ASSERT_DBG(message
);
168 return disc_items_msg
->stream
;
172 void set_discarded_items_message_count(struct bt_message
*message
,
175 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
178 BT_ASSERT_PRE_DEV_HOT(message
, "Message", ": %!+n", message
);
179 bt_property_uint_set(&disc_items_msg
->count
, count
);
183 enum bt_property_availability
get_discarded_items_message_count(
184 const struct bt_message
*message
, uint64_t *count
)
186 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
188 BT_ASSERT_PRE_DEV_NON_NULL(count
, "Count (output)");
189 BT_ASSERT_DBG(message
);
190 *count
= disc_items_msg
->count
.value
;
191 return disc_items_msg
->count
.base
.avail
;
195 const struct bt_clock_snapshot
*
196 borrow_discarded_items_message_beginning_default_clock_snapshot_const(
197 const struct bt_message
*message
)
199 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
201 BT_ASSERT_DBG(message
);
202 BT_ASSERT_PRE_DEV(disc_items_msg
->stream
->class->default_clock_class
,
203 "Message's stream's class has no default clock class: "
204 "%![msg-]+n, %![sc-]+S",
205 message
, disc_items_msg
->stream
->class);
206 return disc_items_msg
->default_begin_cs
;
210 const struct bt_clock_snapshot
*
211 borrow_discarded_items_message_end_default_clock_snapshot_const(
212 const struct bt_message
*message
)
214 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
216 BT_ASSERT_DBG(message
);
217 BT_ASSERT_PRE_DEV(disc_items_msg
->stream
->class->default_clock_class
,
218 "Message's stream's class has no default clock class: "
219 "%![msg-]+n, %![sc-]+S",
220 message
, disc_items_msg
->stream
->class);
221 return disc_items_msg
->default_end_cs
;
224 struct bt_message
*bt_message_discarded_events_create(
225 struct bt_self_message_iterator
*message_iterator
,
226 const struct bt_stream
*stream
)
228 BT_ASSERT_PRE_DEV_NO_ERROR();
230 return create_discarded_items_message(message_iterator
,
231 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
235 struct bt_message
*bt_message_discarded_events_create_with_default_clock_snapshots(
236 struct bt_self_message_iterator
*message_iterator
,
237 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
238 uint64_t end_raw_value
)
240 BT_ASSERT_PRE_DEV_NO_ERROR();
242 return create_discarded_items_message(message_iterator
,
243 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
244 true, beginning_raw_value
, end_raw_value
);
247 struct bt_stream
*bt_message_discarded_events_borrow_stream(
248 struct bt_message
*message
)
250 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
251 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
252 return borrow_discarded_items_message_stream(message
);
255 void bt_message_discarded_events_set_count(struct bt_message
*message
,
258 BT_ASSERT_PRE_NON_NULL(message
, "Message");
259 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
260 set_discarded_items_message_count(message
, count
);
263 const struct bt_clock_snapshot
*
264 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
265 const struct bt_message
*msg
)
267 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
268 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
269 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
273 const struct bt_clock_snapshot
*
274 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
275 const struct bt_message
*msg
)
277 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
278 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
279 return borrow_discarded_items_message_end_default_clock_snapshot_const(
283 const struct bt_stream
*
284 bt_message_discarded_events_borrow_stream_const(const struct bt_message
*message
)
286 return (void *) bt_message_discarded_events_borrow_stream(
290 enum bt_property_availability
bt_message_discarded_events_get_count(
291 const struct bt_message
*message
, uint64_t *count
)
293 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
294 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
295 BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
296 return get_discarded_items_message_count(message
, count
);
299 struct bt_message
*bt_message_discarded_packets_create(
300 struct bt_self_message_iterator
*message_iterator
,
301 const struct bt_stream
*stream
)
303 BT_ASSERT_PRE_DEV_NO_ERROR();
305 return create_discarded_items_message(message_iterator
,
306 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
310 struct bt_message
*bt_message_discarded_packets_create_with_default_clock_snapshots(
311 struct bt_self_message_iterator
*message_iterator
,
312 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
313 uint64_t end_raw_value
)
315 BT_ASSERT_PRE_DEV_NO_ERROR();
317 return create_discarded_items_message(message_iterator
,
318 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
319 true, beginning_raw_value
, end_raw_value
);
322 struct bt_stream
*bt_message_discarded_packets_borrow_stream(
323 struct bt_message
*message
)
325 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
326 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
327 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
328 return borrow_discarded_items_message_stream(message
);
331 void bt_message_discarded_packets_set_count(struct bt_message
*message
,
334 BT_ASSERT_PRE_NON_NULL(message
, "Message");
335 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
336 set_discarded_items_message_count(message
, count
);
339 const struct bt_clock_snapshot
*
340 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
341 const struct bt_message
*msg
)
343 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
344 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
345 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
349 const struct bt_clock_snapshot
*
350 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
351 const struct bt_message
*msg
)
353 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
354 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
355 return borrow_discarded_items_message_end_default_clock_snapshot_const(
359 const struct bt_stream
*
360 bt_message_discarded_packets_borrow_stream_const(const struct bt_message
*message
)
362 return (void *) bt_message_discarded_packets_borrow_stream(
366 enum bt_property_availability
bt_message_discarded_packets_get_count(
367 const struct bt_message
*message
, uint64_t *count
)
369 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
370 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
371 BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
372 return get_discarded_items_message_count(message
, count
);
376 const struct bt_clock_class
*
377 borrow_discarded_items_message_stream_class_default_clock_class(
378 const struct bt_message
*msg
)
380 struct bt_message_discarded_items
*disc_items_msg
= (void *) msg
;
383 return disc_items_msg
->stream
->class->default_clock_class
;
386 const struct bt_clock_class
*
387 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
388 const struct bt_message
*msg
)
390 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
391 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
392 return borrow_discarded_items_message_stream_class_default_clock_class(
396 const struct bt_clock_class
*
397 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
398 const struct bt_message
*msg
)
400 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
401 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
402 return borrow_discarded_items_message_stream_class_default_clock_class(