Commit | Line | Data |
---|---|---|
4c833281 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 | ||
350ad6c1 | 23 | #define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS" |
c2d9d9cf | 24 | #include "lib/logging.h" |
4c833281 | 25 | |
578e048b MJ |
26 | #include "lib/assert-pre.h" |
27 | #include "lib/object.h" | |
28 | #include "compat/compiler.h" | |
3fadfbc0 | 29 | #include <babeltrace2/trace-ir/clock-class.h> |
578e048b MJ |
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" | |
3fadfbc0 MJ |
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> | |
4c833281 | 39 | |
578e048b MJ |
40 | #include "discarded-items.h" |
41 | ||
4c833281 PP |
42 | static |
43 | void destroy_discarded_items_message(struct bt_object *obj) | |
44 | { | |
45 | struct bt_message_discarded_items *message = (void *) obj; | |
46 | ||
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); | |
50 | ||
51 | if (message->default_begin_cs) { | |
52 | bt_clock_snapshot_recycle(message->default_begin_cs); | |
53 | message->default_begin_cs = NULL; | |
54 | } | |
55 | ||
56 | if (message->default_end_cs) { | |
57 | bt_clock_snapshot_recycle(message->default_end_cs); | |
58 | message->default_end_cs = NULL; | |
59 | } | |
60 | ||
61 | g_free(message); | |
62 | } | |
63 | ||
64 | static inline | |
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, | |
68 | bool with_cs, | |
69 | uint64_t beginning_raw_value, uint64_t end_raw_value) | |
70 | { | |
71 | struct bt_message_discarded_items *message; | |
72 | struct bt_stream_class *stream_class; | |
2e90378a | 73 | bool has_support; |
8cc5f12b | 74 | bool need_cs; |
4c833281 PP |
75 | |
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); | |
2e90378a PP |
80 | |
81 | if (type == BT_MESSAGE_TYPE_DISCARDED_EVENTS) { | |
82 | has_support = stream_class->supports_discarded_events; | |
8cc5f12b | 83 | need_cs = stream_class->discarded_events_have_default_clock_snapshots; |
2e90378a PP |
84 | } else { |
85 | has_support = stream_class->supports_discarded_packets; | |
8cc5f12b | 86 | need_cs = stream_class->discarded_packets_have_default_clock_snapshots; |
2e90378a PP |
87 | } |
88 | ||
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); | |
8cc5f12b | 93 | BT_ASSERT_PRE(need_cs ? with_cs : true, |
2e90378a | 94 | "Unexpected stream class configuration when creating " |
8cc5f12b PP |
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: " | |
aa12059b PP |
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); | |
4c833281 PP |
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); | |
115 | if (!message) { | |
870631a2 PP |
116 | BT_LIB_LOGE_APPEND_CAUSE( |
117 | "Failed to allocate one discarded items message."); | |
4c833281 PP |
118 | goto error; |
119 | } | |
120 | ||
121 | bt_message_init(&message->parent, type, | |
122 | destroy_discarded_items_message, NULL); | |
123 | message->stream = stream; | |
6871026b | 124 | bt_object_get_ref_no_null_check(message->stream); |
4c833281 PP |
125 | |
126 | if (with_cs) { | |
aa12059b | 127 | BT_ASSERT(stream_class->default_clock_class); |
4c833281 PP |
128 | message->default_begin_cs = bt_clock_snapshot_create( |
129 | stream_class->default_clock_class); | |
130 | if (!message->default_begin_cs) { | |
131 | goto error; | |
132 | } | |
133 | ||
134 | bt_clock_snapshot_set_raw_value(message->default_begin_cs, | |
135 | beginning_raw_value); | |
136 | ||
137 | message->default_end_cs = bt_clock_snapshot_create( | |
138 | stream_class->default_clock_class); | |
139 | if (!message->default_end_cs) { | |
140 | goto error; | |
141 | } | |
142 | ||
143 | bt_clock_snapshot_set_raw_value(message->default_end_cs, | |
144 | end_raw_value); | |
145 | } | |
146 | ||
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); | |
152 | ||
153 | return (void *) &message->parent; | |
154 | ||
155 | error: | |
156 | return NULL; | |
157 | } | |
158 | ||
159 | static inline | |
160 | struct bt_stream *borrow_discarded_items_message_stream( | |
161 | struct bt_message *message) | |
162 | { | |
163 | struct bt_message_discarded_items *disc_items_msg = (void *) message; | |
164 | ||
98b15851 | 165 | BT_ASSERT_DBG(message); |
4c833281 PP |
166 | return disc_items_msg->stream; |
167 | } | |
168 | ||
169 | static inline | |
170 | void set_discarded_items_message_count(struct bt_message *message, | |
171 | uint64_t count) | |
172 | { | |
173 | struct bt_message_discarded_items *disc_items_msg = (void *) message; | |
174 | ||
175 | BT_ASSERT(message); | |
bdb288b3 | 176 | BT_ASSERT_PRE_DEV_HOT(message, "Message", ": %!+n", message); |
4c833281 PP |
177 | bt_property_uint_set(&disc_items_msg->count, count); |
178 | } | |
179 | ||
180 | static inline | |
181 | enum bt_property_availability get_discarded_items_message_count( | |
182 | const struct bt_message *message, uint64_t *count) | |
183 | { | |
184 | struct bt_message_discarded_items *disc_items_msg = (void *) message; | |
185 | ||
bdb288b3 | 186 | BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)"); |
98b15851 | 187 | BT_ASSERT_DBG(message); |
4c833281 PP |
188 | *count = disc_items_msg->count.value; |
189 | return disc_items_msg->count.base.avail; | |
190 | } | |
191 | ||
192 | static inline | |
0cbc2c33 | 193 | const struct bt_clock_snapshot * |
9b24b6aa | 194 | borrow_discarded_items_message_beginning_default_clock_snapshot_const( |
0cbc2c33 | 195 | const struct bt_message *message) |
4c833281 PP |
196 | { |
197 | struct bt_message_discarded_items *disc_items_msg = (void *) message; | |
198 | ||
98b15851 | 199 | BT_ASSERT_DBG(message); |
bdb288b3 | 200 | BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class, |
4c833281 PP |
201 | "Message's stream's class has no default clock class: " |
202 | "%![msg-]+n, %![sc-]+S", | |
203 | message, disc_items_msg->stream->class); | |
0cbc2c33 | 204 | return disc_items_msg->default_begin_cs; |
4c833281 PP |
205 | } |
206 | ||
207 | static inline | |
0cbc2c33 | 208 | const struct bt_clock_snapshot * |
9b24b6aa | 209 | borrow_discarded_items_message_end_default_clock_snapshot_const( |
0cbc2c33 | 210 | const struct bt_message *message) |
4c833281 PP |
211 | { |
212 | struct bt_message_discarded_items *disc_items_msg = (void *) message; | |
213 | ||
98b15851 | 214 | BT_ASSERT_DBG(message); |
bdb288b3 | 215 | BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class, |
4c833281 PP |
216 | "Message's stream's class has no default clock class: " |
217 | "%![msg-]+n, %![sc-]+S", | |
218 | message, disc_items_msg->stream->class); | |
0cbc2c33 | 219 | return disc_items_msg->default_end_cs; |
4c833281 PP |
220 | } |
221 | ||
222 | struct bt_message *bt_message_discarded_events_create( | |
223 | struct bt_self_message_iterator *message_iterator, | |
58085ca4 | 224 | const struct bt_stream *stream) |
4c833281 PP |
225 | { |
226 | return create_discarded_items_message(message_iterator, | |
58085ca4 | 227 | BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream, |
4c833281 PP |
228 | false, 0, 0); |
229 | } | |
230 | ||
231 | struct bt_message *bt_message_discarded_events_create_with_default_clock_snapshots( | |
232 | struct bt_self_message_iterator *message_iterator, | |
58085ca4 | 233 | const struct bt_stream *stream, uint64_t beginning_raw_value, |
4c833281 PP |
234 | uint64_t end_raw_value) |
235 | { | |
236 | return create_discarded_items_message(message_iterator, | |
58085ca4 | 237 | BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream, |
4c833281 PP |
238 | true, beginning_raw_value, end_raw_value); |
239 | } | |
240 | ||
241 | struct bt_stream *bt_message_discarded_events_borrow_stream( | |
242 | struct bt_message *message) | |
243 | { | |
bdb288b3 PP |
244 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
245 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS); | |
4c833281 PP |
246 | return borrow_discarded_items_message_stream(message); |
247 | } | |
248 | ||
249 | void bt_message_discarded_events_set_count(struct bt_message *message, | |
250 | uint64_t count) | |
251 | { | |
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); | |
255 | } | |
256 | ||
0cbc2c33 | 257 | const struct bt_clock_snapshot * |
9b24b6aa | 258 | bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 259 | const struct bt_message *msg) |
4c833281 | 260 | { |
bdb288b3 PP |
261 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
262 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS); | |
9b24b6aa | 263 | return borrow_discarded_items_message_beginning_default_clock_snapshot_const( |
0cbc2c33 | 264 | msg); |
4c833281 PP |
265 | } |
266 | ||
0cbc2c33 | 267 | const struct bt_clock_snapshot * |
9b24b6aa | 268 | bt_message_discarded_events_borrow_end_default_clock_snapshot_const( |
0cbc2c33 | 269 | const struct bt_message *msg) |
4c833281 | 270 | { |
bdb288b3 PP |
271 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
272 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS); | |
9b24b6aa | 273 | return borrow_discarded_items_message_end_default_clock_snapshot_const( |
0cbc2c33 | 274 | msg); |
4c833281 PP |
275 | } |
276 | ||
277 | const struct bt_stream * | |
278 | bt_message_discarded_events_borrow_stream_const(const struct bt_message *message) | |
279 | { | |
280 | return (void *) bt_message_discarded_events_borrow_stream( | |
281 | (void *) message); | |
282 | } | |
283 | ||
284 | enum bt_property_availability bt_message_discarded_events_get_count( | |
285 | const struct bt_message *message, uint64_t *count) | |
286 | { | |
bdb288b3 PP |
287 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
288 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, | |
289 | BT_MESSAGE_TYPE_DISCARDED_EVENTS); | |
4c833281 PP |
290 | return get_discarded_items_message_count(message, count); |
291 | } | |
4237f1f2 PP |
292 | |
293 | struct bt_message *bt_message_discarded_packets_create( | |
294 | struct bt_self_message_iterator *message_iterator, | |
58085ca4 | 295 | const struct bt_stream *stream) |
4237f1f2 PP |
296 | { |
297 | return create_discarded_items_message(message_iterator, | |
58085ca4 | 298 | BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream, |
4237f1f2 PP |
299 | false, 0, 0); |
300 | } | |
301 | ||
302 | struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots( | |
303 | struct bt_self_message_iterator *message_iterator, | |
58085ca4 | 304 | const struct bt_stream *stream, uint64_t beginning_raw_value, |
4237f1f2 PP |
305 | uint64_t end_raw_value) |
306 | { | |
307 | return create_discarded_items_message(message_iterator, | |
58085ca4 | 308 | BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream, |
4237f1f2 PP |
309 | true, beginning_raw_value, end_raw_value); |
310 | } | |
311 | ||
312 | struct bt_stream *bt_message_discarded_packets_borrow_stream( | |
313 | struct bt_message *message) | |
314 | { | |
bdb288b3 PP |
315 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
316 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, | |
317 | BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
4237f1f2 PP |
318 | return borrow_discarded_items_message_stream(message); |
319 | } | |
320 | ||
321 | void bt_message_discarded_packets_set_count(struct bt_message *message, | |
322 | uint64_t count) | |
323 | { | |
324 | BT_ASSERT_PRE_NON_NULL(message, "Message"); | |
325 | BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
326 | set_discarded_items_message_count(message, count); | |
327 | } | |
328 | ||
0cbc2c33 | 329 | const struct bt_clock_snapshot * |
9b24b6aa | 330 | bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 331 | const struct bt_message *msg) |
4237f1f2 | 332 | { |
bdb288b3 PP |
333 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
334 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
9b24b6aa | 335 | return borrow_discarded_items_message_beginning_default_clock_snapshot_const( |
0cbc2c33 | 336 | msg); |
4237f1f2 PP |
337 | } |
338 | ||
0cbc2c33 | 339 | const struct bt_clock_snapshot * |
9b24b6aa | 340 | bt_message_discarded_packets_borrow_end_default_clock_snapshot_const( |
0cbc2c33 | 341 | const struct bt_message *msg) |
4237f1f2 | 342 | { |
bdb288b3 PP |
343 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
344 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
9b24b6aa | 345 | return borrow_discarded_items_message_end_default_clock_snapshot_const( |
0cbc2c33 | 346 | msg); |
4237f1f2 PP |
347 | } |
348 | ||
349 | const struct bt_stream * | |
350 | bt_message_discarded_packets_borrow_stream_const(const struct bt_message *message) | |
351 | { | |
352 | return (void *) bt_message_discarded_packets_borrow_stream( | |
353 | (void *) message); | |
354 | } | |
355 | ||
356 | enum bt_property_availability bt_message_discarded_packets_get_count( | |
357 | const struct bt_message *message, uint64_t *count) | |
358 | { | |
bdb288b3 PP |
359 | BT_ASSERT_PRE_DEV_NON_NULL(message, "Message"); |
360 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, | |
361 | BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
4237f1f2 PP |
362 | return get_discarded_items_message_count(message, count); |
363 | } | |
33931ab8 PP |
364 | |
365 | static inline | |
366 | const struct bt_clock_class * | |
367 | borrow_discarded_items_message_stream_class_default_clock_class( | |
368 | const struct bt_message *msg) | |
369 | { | |
370 | struct bt_message_discarded_items *disc_items_msg = (void *) msg; | |
371 | ||
98b15851 | 372 | BT_ASSERT_DBG(msg); |
33931ab8 PP |
373 | return disc_items_msg->stream->class->default_clock_class; |
374 | } | |
375 | ||
376 | const struct bt_clock_class * | |
377 | bt_message_discarded_events_borrow_stream_class_default_clock_class_const( | |
378 | const struct bt_message *msg) | |
379 | { | |
bdb288b3 PP |
380 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
381 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS); | |
33931ab8 PP |
382 | return borrow_discarded_items_message_stream_class_default_clock_class( |
383 | msg); | |
384 | } | |
385 | ||
386 | const struct bt_clock_class * | |
387 | bt_message_discarded_packets_borrow_stream_class_default_clock_class_const( | |
388 | const struct bt_message *msg) | |
389 | { | |
bdb288b3 PP |
390 | BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message"); |
391 | BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS); | |
33931ab8 PP |
392 | return borrow_discarded_items_message_stream_class_default_clock_class( |
393 | msg); | |
394 | } |