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"
26 #include "lib/assert-pre.h"
27 #include "lib/object.h"
28 #include "compat/compiler.h"
29 #include <babeltrace2/trace-ir/clock-class.h>
30 #include "lib/trace-ir/clock-snapshot.h"
31 #include "lib/trace-ir/stream-class.h"
32 #include "lib/trace-ir/stream.h"
33 #include "lib/property.h"
34 #include "lib/graph/message/message.h"
35 #include <babeltrace2/graph/message-discarded-events.h>
36 #include <babeltrace2/graph/message-discarded-events-const.h>
37 #include <babeltrace2/graph/message-discarded-packets.h>
38 #include <babeltrace2/graph/message-discarded-packets-const.h>
40 #include "discarded-items.h"
43 void destroy_discarded_items_message(struct bt_object
*obj
)
45 struct bt_message_discarded_items
*message
= (void *) obj
;
47 BT_LIB_LOGD("Destroying discarded items message: %!+n", message
);
48 BT_LIB_LOGD("Putting stream: %!+s", message
->stream
);
49 BT_OBJECT_PUT_REF_AND_RESET(message
->stream
);
51 if (message
->default_begin_cs
) {
52 bt_clock_snapshot_recycle(message
->default_begin_cs
);
53 message
->default_begin_cs
= NULL
;
56 if (message
->default_end_cs
) {
57 bt_clock_snapshot_recycle(message
->default_end_cs
);
58 message
->default_end_cs
= NULL
;
65 struct bt_message
*create_discarded_items_message(
66 struct bt_self_message_iterator
*self_msg_iter
,
67 enum bt_message_type type
, struct bt_stream
*stream
,
69 uint64_t beginning_raw_value
, uint64_t end_raw_value
)
71 struct bt_message_discarded_items
*message
;
72 struct bt_stream_class
*stream_class
;
76 BT_ASSERT_PRE_NON_NULL(self_msg_iter
, "Message iterator");
77 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
78 stream_class
= bt_stream_borrow_class(stream
);
79 BT_ASSERT(stream_class
);
81 if (type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
82 has_support
= stream_class
->supports_discarded_events
;
83 need_cs
= stream_class
->discarded_events_have_default_clock_snapshots
;
85 has_support
= stream_class
->supports_discarded_packets
;
86 need_cs
= stream_class
->discarded_packets_have_default_clock_snapshots
;
89 BT_ASSERT_PRE(has_support
,
90 "Stream class does not support discarded events or packets: "
91 "type=%s, %![stream-]+s, %![sc-]+S",
92 bt_message_type_string(type
), stream
, stream_class
);
93 BT_ASSERT_PRE(need_cs
? with_cs
: true,
94 "Unexpected stream class configuration when creating "
95 "a discarded events or discarded packets message: "
96 "default clock snapshots are needed, but none was provided: "
97 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
98 "cs-begin-val=%" PRIu64
", cs-end-val=%" PRIu64
,
99 bt_message_type_string(type
), stream
, stream_class
,
100 with_cs
, beginning_raw_value
, end_raw_value
);
101 BT_ASSERT_PRE(!need_cs
? !with_cs
: true,
102 "Unexpected stream class configuration when creating "
103 "a discarded events or discarded packets message: "
104 "no default clock snapshots are needed, but two were provided: "
105 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
106 "cs-begin-val=%" PRIu64
", cs-end-val=%" PRIu64
,
107 bt_message_type_string(type
), stream
, stream_class
,
108 with_cs
, beginning_raw_value
, end_raw_value
);
109 BT_LIB_LOGD("Creating discarded items message object: "
110 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
111 "cs-begin-val=%" PRIu64
", cs-end-val=%" PRIu64
,
112 bt_message_type_string(type
), stream
, stream_class
,
113 with_cs
, beginning_raw_value
, end_raw_value
);
114 message
= g_new0(struct bt_message_discarded_items
, 1);
116 BT_LIB_LOGE_APPEND_CAUSE(
117 "Failed to allocate one discarded items message.");
121 bt_message_init(&message
->parent
, type
,
122 destroy_discarded_items_message
, NULL
);
123 message
->stream
= stream
;
124 bt_object_get_no_null_check(message
->stream
);
127 BT_ASSERT(stream_class
->default_clock_class
);
128 message
->default_begin_cs
= bt_clock_snapshot_create(
129 stream_class
->default_clock_class
);
130 if (!message
->default_begin_cs
) {
134 bt_clock_snapshot_set_raw_value(message
->default_begin_cs
,
135 beginning_raw_value
);
137 message
->default_end_cs
= bt_clock_snapshot_create(
138 stream_class
->default_clock_class
);
139 if (!message
->default_end_cs
) {
143 bt_clock_snapshot_set_raw_value(message
->default_end_cs
,
147 bt_property_uint_init(&message
->count
,
148 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
149 BT_LIB_LOGD("Created discarded items message object: "
150 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message
,
151 stream
, stream_class
);
153 return (void *) &message
->parent
;
160 struct bt_stream
*borrow_discarded_items_message_stream(
161 struct bt_message
*message
)
163 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
166 return disc_items_msg
->stream
;
170 void set_discarded_items_message_count(struct bt_message
*message
,
173 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
176 BT_ASSERT_PRE_HOT(message
, "Message", ": %!+n", message
);
177 bt_property_uint_set(&disc_items_msg
->count
, count
);
181 enum bt_property_availability
get_discarded_items_message_count(
182 const struct bt_message
*message
, uint64_t *count
)
184 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
186 BT_ASSERT_PRE_NON_NULL(count
, "Count (output)");
188 *count
= disc_items_msg
->count
.value
;
189 return disc_items_msg
->count
.base
.avail
;
193 const struct bt_clock_snapshot
*
194 borrow_discarded_items_message_beginning_default_clock_snapshot_const(
195 const struct bt_message
*message
)
197 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
200 BT_ASSERT_PRE(disc_items_msg
->stream
->class->default_clock_class
,
201 "Message's stream's class has no default clock class: "
202 "%![msg-]+n, %![sc-]+S",
203 message
, disc_items_msg
->stream
->class);
204 return disc_items_msg
->default_begin_cs
;
208 const struct bt_clock_snapshot
*
209 borrow_discarded_items_message_end_default_clock_snapshot_const(
210 const struct bt_message
*message
)
212 struct bt_message_discarded_items
*disc_items_msg
= (void *) message
;
215 BT_ASSERT_PRE(disc_items_msg
->stream
->class->default_clock_class
,
216 "Message's stream's class has no default clock class: "
217 "%![msg-]+n, %![sc-]+S",
218 message
, disc_items_msg
->stream
->class);
219 return disc_items_msg
->default_end_cs
;
222 struct bt_message
*bt_message_discarded_events_create(
223 struct bt_self_message_iterator
*message_iterator
,
224 const struct bt_stream
*stream
)
226 return create_discarded_items_message(message_iterator
,
227 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
231 struct bt_message
*bt_message_discarded_events_create_with_default_clock_snapshots(
232 struct bt_self_message_iterator
*message_iterator
,
233 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
234 uint64_t end_raw_value
)
236 return create_discarded_items_message(message_iterator
,
237 BT_MESSAGE_TYPE_DISCARDED_EVENTS
, (void *) stream
,
238 true, beginning_raw_value
, end_raw_value
);
241 struct bt_stream
*bt_message_discarded_events_borrow_stream(
242 struct bt_message
*message
)
244 BT_ASSERT_PRE_NON_NULL(message
, "Message");
245 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
246 return borrow_discarded_items_message_stream(message
);
249 void bt_message_discarded_events_set_count(struct bt_message
*message
,
252 BT_ASSERT_PRE_NON_NULL(message
, "Message");
253 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
254 set_discarded_items_message_count(message
, count
);
257 const struct bt_clock_snapshot
*
258 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
259 const struct bt_message
*msg
)
261 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
262 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
263 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
267 const struct bt_clock_snapshot
*
268 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
269 const struct bt_message
*msg
)
271 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
272 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
273 return borrow_discarded_items_message_end_default_clock_snapshot_const(
277 const struct bt_stream
*
278 bt_message_discarded_events_borrow_stream_const(const struct bt_message
*message
)
280 return (void *) bt_message_discarded_events_borrow_stream(
284 enum bt_property_availability
bt_message_discarded_events_get_count(
285 const struct bt_message
*message
, uint64_t *count
)
287 BT_ASSERT_PRE_NON_NULL(message
, "Message");
288 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
289 return get_discarded_items_message_count(message
, count
);
292 struct bt_message
*bt_message_discarded_packets_create(
293 struct bt_self_message_iterator
*message_iterator
,
294 const struct bt_stream
*stream
)
296 return create_discarded_items_message(message_iterator
,
297 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
301 struct bt_message
*bt_message_discarded_packets_create_with_default_clock_snapshots(
302 struct bt_self_message_iterator
*message_iterator
,
303 const struct bt_stream
*stream
, uint64_t beginning_raw_value
,
304 uint64_t end_raw_value
)
306 return create_discarded_items_message(message_iterator
,
307 BT_MESSAGE_TYPE_DISCARDED_PACKETS
, (void *) stream
,
308 true, beginning_raw_value
, end_raw_value
);
311 struct bt_stream
*bt_message_discarded_packets_borrow_stream(
312 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 return borrow_discarded_items_message_stream(message
);
319 void bt_message_discarded_packets_set_count(struct bt_message
*message
,
322 BT_ASSERT_PRE_NON_NULL(message
, "Message");
323 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
324 set_discarded_items_message_count(message
, count
);
327 const struct bt_clock_snapshot
*
328 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
329 const struct bt_message
*msg
)
331 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
332 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
333 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
337 const struct bt_clock_snapshot
*
338 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
339 const struct bt_message
*msg
)
341 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
342 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
343 return borrow_discarded_items_message_end_default_clock_snapshot_const(
347 const struct bt_stream
*
348 bt_message_discarded_packets_borrow_stream_const(const struct bt_message
*message
)
350 return (void *) bt_message_discarded_packets_borrow_stream(
354 enum bt_property_availability
bt_message_discarded_packets_get_count(
355 const struct bt_message
*message
, uint64_t *count
)
357 BT_ASSERT_PRE_NON_NULL(message
, "Message");
358 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
359 return get_discarded_items_message_count(message
, count
);
363 const struct bt_clock_class
*
364 borrow_discarded_items_message_stream_class_default_clock_class(
365 const struct bt_message
*msg
)
367 struct bt_message_discarded_items
*disc_items_msg
= (void *) msg
;
370 return disc_items_msg
->stream
->class->default_clock_class
;
373 const struct bt_clock_class
*
374 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
375 const struct bt_message
*msg
)
377 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
378 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_EVENTS
);
379 return borrow_discarded_items_message_stream_class_default_clock_class(
383 const struct bt_clock_class
*
384 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
385 const struct bt_message
*msg
)
387 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
388 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_DISCARDED_PACKETS
);
389 return borrow_discarded_items_message_stream_class_default_clock_class(