Document libbabeltrace2's C API
[babeltrace.git] / src / lib / graph / message / discarded-items.c
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
23 #define BT_LOG_TAG "LIB/MSG-DISCARDED-ITEMS"
24 #include "lib/logging.h"
25
26 #include <stdbool.h>
27
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
38 #include "discarded-items.h"
39
40 static
41 void destroy_discarded_items_message(struct bt_object *obj)
42 {
43 struct bt_message_discarded_items *message = (void *) obj;
44
45 BT_LIB_LOGD("Destroying discarded items message: %!+n", message);
46 BT_LIB_LOGD("Putting stream: %!+s", message->stream);
47 BT_OBJECT_PUT_REF_AND_RESET(message->stream);
48
49 if (message->default_begin_cs) {
50 bt_clock_snapshot_recycle(message->default_begin_cs);
51 message->default_begin_cs = NULL;
52 }
53
54 if (message->default_end_cs) {
55 bt_clock_snapshot_recycle(message->default_end_cs);
56 message->default_end_cs = NULL;
57 }
58
59 g_free(message);
60 }
61
62 static inline
63 struct bt_message *create_discarded_items_message(
64 struct bt_self_message_iterator *self_msg_iter,
65 enum bt_message_type type, struct bt_stream *stream,
66 bool with_cs,
67 uint64_t beginning_raw_value, uint64_t end_raw_value)
68 {
69 struct bt_message_discarded_items *message;
70 struct bt_stream_class *stream_class;
71 bool has_support;
72 bool need_cs;
73
74 BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
75 BT_ASSERT_PRE_NON_NULL(stream, "Stream");
76 stream_class = bt_stream_borrow_class(stream);
77 BT_ASSERT(stream_class);
78
79 if (type == BT_MESSAGE_TYPE_DISCARDED_EVENTS) {
80 has_support = stream_class->supports_discarded_events;
81 need_cs = stream_class->discarded_events_have_default_clock_snapshots;
82 } else {
83 has_support = stream_class->supports_discarded_packets;
84 need_cs = stream_class->discarded_packets_have_default_clock_snapshots;
85 }
86
87 BT_ASSERT_PRE(has_support,
88 "Stream class does not support discarded events or packets: "
89 "type=%s, %![stream-]+s, %![sc-]+S",
90 bt_message_type_string(type), stream, stream_class);
91 BT_ASSERT_PRE(need_cs ? with_cs : true,
92 "Unexpected stream class configuration when creating "
93 "a discarded events or discarded packets message: "
94 "default clock snapshots are needed, but none was provided: "
95 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
96 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
97 bt_message_type_string(type), stream, stream_class,
98 with_cs, beginning_raw_value, end_raw_value);
99 BT_ASSERT_PRE(!need_cs ? !with_cs : true,
100 "Unexpected stream class configuration when creating "
101 "a discarded events or discarded packets message: "
102 "no default clock snapshots are needed, but two were provided: "
103 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
104 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
105 bt_message_type_string(type), stream, stream_class,
106 with_cs, beginning_raw_value, end_raw_value);
107 BT_LIB_LOGD("Creating discarded items message object: "
108 "type=%s, %![stream-]+s, %![sc-]+S, with-cs=%d, "
109 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64,
110 bt_message_type_string(type), stream, stream_class,
111 with_cs, beginning_raw_value, end_raw_value);
112 message = g_new0(struct bt_message_discarded_items, 1);
113 if (!message) {
114 BT_LIB_LOGE_APPEND_CAUSE(
115 "Failed to allocate one discarded items message.");
116 goto error;
117 }
118
119 bt_message_init(&message->parent, type,
120 destroy_discarded_items_message, NULL);
121 message->stream = stream;
122 bt_object_get_ref_no_null_check(message->stream);
123
124 if (with_cs) {
125 BT_ASSERT(stream_class->default_clock_class);
126 message->default_begin_cs = bt_clock_snapshot_create(
127 stream_class->default_clock_class);
128 if (!message->default_begin_cs) {
129 goto error;
130 }
131
132 bt_clock_snapshot_set_raw_value(message->default_begin_cs,
133 beginning_raw_value);
134
135 message->default_end_cs = bt_clock_snapshot_create(
136 stream_class->default_clock_class);
137 if (!message->default_end_cs) {
138 goto error;
139 }
140
141 bt_clock_snapshot_set_raw_value(message->default_end_cs,
142 end_raw_value);
143 }
144
145 bt_property_uint_init(&message->count,
146 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
147 BT_LIB_LOGD("Created discarded items message object: "
148 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
149 stream, stream_class);
150
151 return (void *) &message->parent;
152
153 error:
154 return NULL;
155 }
156
157 static inline
158 struct bt_stream *borrow_discarded_items_message_stream(
159 struct bt_message *message)
160 {
161 struct bt_message_discarded_items *disc_items_msg = (void *) message;
162
163 BT_ASSERT_DBG(message);
164 return disc_items_msg->stream;
165 }
166
167 static inline
168 void set_discarded_items_message_count(struct bt_message *message,
169 uint64_t count)
170 {
171 struct bt_message_discarded_items *disc_items_msg = (void *) message;
172
173 BT_ASSERT(message);
174 BT_ASSERT_PRE_DEV_HOT(message, "Message", ": %!+n", message);
175 bt_property_uint_set(&disc_items_msg->count, count);
176 }
177
178 static inline
179 enum bt_property_availability get_discarded_items_message_count(
180 const struct bt_message *message, uint64_t *count)
181 {
182 struct bt_message_discarded_items *disc_items_msg = (void *) message;
183
184 BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
185 BT_ASSERT_DBG(message);
186 *count = disc_items_msg->count.value;
187 return disc_items_msg->count.base.avail;
188 }
189
190 static inline
191 const struct bt_clock_snapshot *
192 borrow_discarded_items_message_beginning_default_clock_snapshot_const(
193 const struct bt_message *message)
194 {
195 struct bt_message_discarded_items *disc_items_msg = (void *) message;
196
197 BT_ASSERT_DBG(message);
198 BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
199 "Message's stream's class has no default clock class: "
200 "%![msg-]+n, %![sc-]+S",
201 message, disc_items_msg->stream->class);
202 return disc_items_msg->default_begin_cs;
203 }
204
205 static inline
206 const struct bt_clock_snapshot *
207 borrow_discarded_items_message_end_default_clock_snapshot_const(
208 const struct bt_message *message)
209 {
210 struct bt_message_discarded_items *disc_items_msg = (void *) message;
211
212 BT_ASSERT_DBG(message);
213 BT_ASSERT_PRE_DEV(disc_items_msg->stream->class->default_clock_class,
214 "Message's stream's class has no default clock class: "
215 "%![msg-]+n, %![sc-]+S",
216 message, disc_items_msg->stream->class);
217 return disc_items_msg->default_end_cs;
218 }
219
220 struct bt_message *bt_message_discarded_events_create(
221 struct bt_self_message_iterator *message_iterator,
222 const struct bt_stream *stream)
223 {
224 BT_ASSERT_PRE_DEV_NO_ERROR();
225
226 return create_discarded_items_message(message_iterator,
227 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
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,
233 const struct bt_stream *stream, uint64_t beginning_raw_value,
234 uint64_t end_raw_value)
235 {
236 BT_ASSERT_PRE_DEV_NO_ERROR();
237
238 return create_discarded_items_message(message_iterator,
239 BT_MESSAGE_TYPE_DISCARDED_EVENTS, (void *) stream,
240 true, beginning_raw_value, end_raw_value);
241 }
242
243 struct bt_stream *bt_message_discarded_events_borrow_stream(
244 struct bt_message *message)
245 {
246 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
247 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
248 return borrow_discarded_items_message_stream(message);
249 }
250
251 void bt_message_discarded_events_set_count(struct bt_message *message,
252 uint64_t count)
253 {
254 BT_ASSERT_PRE_NON_NULL(message, "Message");
255 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
256 set_discarded_items_message_count(message, count);
257 }
258
259 const struct bt_clock_snapshot *
260 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
261 const struct bt_message *msg)
262 {
263 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
264 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
265 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
266 msg);
267 }
268
269 const struct bt_clock_snapshot *
270 bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
271 const struct bt_message *msg)
272 {
273 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
274 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
275 return borrow_discarded_items_message_end_default_clock_snapshot_const(
276 msg);
277 }
278
279 const struct bt_stream *
280 bt_message_discarded_events_borrow_stream_const(const struct bt_message *message)
281 {
282 return (void *) bt_message_discarded_events_borrow_stream(
283 (void *) message);
284 }
285
286 enum bt_property_availability bt_message_discarded_events_get_count(
287 const struct bt_message *message, uint64_t *count)
288 {
289 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
290 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
291 BT_MESSAGE_TYPE_DISCARDED_EVENTS);
292 return get_discarded_items_message_count(message, count);
293 }
294
295 struct bt_message *bt_message_discarded_packets_create(
296 struct bt_self_message_iterator *message_iterator,
297 const struct bt_stream *stream)
298 {
299 BT_ASSERT_PRE_DEV_NO_ERROR();
300
301 return create_discarded_items_message(message_iterator,
302 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
303 false, 0, 0);
304 }
305
306 struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
307 struct bt_self_message_iterator *message_iterator,
308 const struct bt_stream *stream, uint64_t beginning_raw_value,
309 uint64_t end_raw_value)
310 {
311 BT_ASSERT_PRE_DEV_NO_ERROR();
312
313 return create_discarded_items_message(message_iterator,
314 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
315 true, beginning_raw_value, end_raw_value);
316 }
317
318 struct bt_stream *bt_message_discarded_packets_borrow_stream(
319 struct bt_message *message)
320 {
321 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
322 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
323 BT_MESSAGE_TYPE_DISCARDED_PACKETS);
324 return borrow_discarded_items_message_stream(message);
325 }
326
327 void bt_message_discarded_packets_set_count(struct bt_message *message,
328 uint64_t count)
329 {
330 BT_ASSERT_PRE_NON_NULL(message, "Message");
331 BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
332 set_discarded_items_message_count(message, count);
333 }
334
335 const struct bt_clock_snapshot *
336 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
337 const struct bt_message *msg)
338 {
339 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
340 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
341 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
342 msg);
343 }
344
345 const struct bt_clock_snapshot *
346 bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
347 const struct bt_message *msg)
348 {
349 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
350 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
351 return borrow_discarded_items_message_end_default_clock_snapshot_const(
352 msg);
353 }
354
355 const struct bt_stream *
356 bt_message_discarded_packets_borrow_stream_const(const struct bt_message *message)
357 {
358 return (void *) bt_message_discarded_packets_borrow_stream(
359 (void *) message);
360 }
361
362 enum bt_property_availability bt_message_discarded_packets_get_count(
363 const struct bt_message *message, uint64_t *count)
364 {
365 BT_ASSERT_PRE_DEV_NON_NULL(message, "Message");
366 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message,
367 BT_MESSAGE_TYPE_DISCARDED_PACKETS);
368 return get_discarded_items_message_count(message, count);
369 }
370
371 static inline
372 const struct bt_clock_class *
373 borrow_discarded_items_message_stream_class_default_clock_class(
374 const struct bt_message *msg)
375 {
376 struct bt_message_discarded_items *disc_items_msg = (void *) msg;
377
378 BT_ASSERT_DBG(msg);
379 return disc_items_msg->stream->class->default_clock_class;
380 }
381
382 const struct bt_clock_class *
383 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
384 const struct bt_message *msg)
385 {
386 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
387 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_EVENTS);
388 return borrow_discarded_items_message_stream_class_default_clock_class(
389 msg);
390 }
391
392 const struct bt_clock_class *
393 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
394 const struct bt_message *msg)
395 {
396 BT_ASSERT_PRE_DEV_NON_NULL(msg, "Message");
397 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
398 return borrow_discarded_items_message_stream_class_default_clock_class(
399 msg);
400 }
This page took 0.039687 seconds and 4 git commands to generate.