lib: rename `bt_*_labels_by_value` -> `bt_*_labels_for_value`
[babeltrace.git] / src / lib / graph / message / discarded-items.c
CommitLineData
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
42static
43void 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
64static inline
65struct 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;
124 bt_object_get_no_null_check(message->stream);
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
155error:
156 return NULL;
157}
158
159static inline
160struct 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
165 BT_ASSERT(message);
166 return disc_items_msg->stream;
167}
168
169static inline
170void 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);
176 BT_ASSERT_PRE_HOT(message, "Message", ": %!+n", message);
177 bt_property_uint_set(&disc_items_msg->count, count);
178}
179
180static inline
181enum 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
186 BT_ASSERT_PRE_NON_NULL(count, "Count (output)");
187 BT_ASSERT(message);
188 *count = disc_items_msg->count.value;
189 return disc_items_msg->count.base.avail;
190}
191
192static inline
0cbc2c33 193const struct bt_clock_snapshot *
9b24b6aa 194borrow_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
199 BT_ASSERT(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);
0cbc2c33 204 return disc_items_msg->default_begin_cs;
4c833281
PP
205}
206
207static inline
0cbc2c33 208const struct bt_clock_snapshot *
9b24b6aa 209borrow_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
214 BT_ASSERT(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);
0cbc2c33 219 return disc_items_msg->default_end_cs;
4c833281
PP
220}
221
222struct 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
231struct 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
241struct bt_stream *bt_message_discarded_events_borrow_stream(
242 struct bt_message *message)
243{
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);
247}
248
249void 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 257const struct bt_clock_snapshot *
9b24b6aa 258bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
0cbc2c33 259 const struct bt_message *msg)
4c833281
PP
260{
261 BT_ASSERT_PRE_NON_NULL(msg, "Message");
262 BT_ASSERT_PRE_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 267const struct bt_clock_snapshot *
9b24b6aa 268bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
0cbc2c33 269 const struct bt_message *msg)
4c833281
PP
270{
271 BT_ASSERT_PRE_NON_NULL(msg, "Message");
272 BT_ASSERT_PRE_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
277const struct bt_stream *
278bt_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
284enum bt_property_availability bt_message_discarded_events_get_count(
285 const struct bt_message *message, uint64_t *count)
286{
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);
290}
4237f1f2
PP
291
292struct bt_message *bt_message_discarded_packets_create(
293 struct bt_self_message_iterator *message_iterator,
58085ca4 294 const struct bt_stream *stream)
4237f1f2
PP
295{
296 return create_discarded_items_message(message_iterator,
58085ca4 297 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
4237f1f2
PP
298 false, 0, 0);
299}
300
301struct bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
302 struct bt_self_message_iterator *message_iterator,
58085ca4 303 const struct bt_stream *stream, uint64_t beginning_raw_value,
4237f1f2
PP
304 uint64_t end_raw_value)
305{
306 return create_discarded_items_message(message_iterator,
58085ca4 307 BT_MESSAGE_TYPE_DISCARDED_PACKETS, (void *) stream,
4237f1f2
PP
308 true, beginning_raw_value, end_raw_value);
309}
310
311struct bt_stream *bt_message_discarded_packets_borrow_stream(
312 struct bt_message *message)
313{
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);
317}
318
319void bt_message_discarded_packets_set_count(struct bt_message *message,
320 uint64_t count)
321{
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);
325}
326
0cbc2c33 327const struct bt_clock_snapshot *
9b24b6aa 328bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
0cbc2c33 329 const struct bt_message *msg)
4237f1f2
PP
330{
331 BT_ASSERT_PRE_NON_NULL(msg, "Message");
332 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
9b24b6aa 333 return borrow_discarded_items_message_beginning_default_clock_snapshot_const(
0cbc2c33 334 msg);
4237f1f2
PP
335}
336
0cbc2c33 337const struct bt_clock_snapshot *
9b24b6aa 338bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
0cbc2c33 339 const struct bt_message *msg)
4237f1f2
PP
340{
341 BT_ASSERT_PRE_NON_NULL(msg, "Message");
342 BT_ASSERT_PRE_MSG_IS_TYPE(msg, BT_MESSAGE_TYPE_DISCARDED_PACKETS);
9b24b6aa 343 return borrow_discarded_items_message_end_default_clock_snapshot_const(
0cbc2c33 344 msg);
4237f1f2
PP
345}
346
347const struct bt_stream *
348bt_message_discarded_packets_borrow_stream_const(const struct bt_message *message)
349{
350 return (void *) bt_message_discarded_packets_borrow_stream(
351 (void *) message);
352}
353
354enum bt_property_availability bt_message_discarded_packets_get_count(
355 const struct bt_message *message, uint64_t *count)
356{
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);
360}
33931ab8
PP
361
362static inline
363const struct bt_clock_class *
364borrow_discarded_items_message_stream_class_default_clock_class(
365 const struct bt_message *msg)
366{
367 struct bt_message_discarded_items *disc_items_msg = (void *) msg;
368
369 BT_ASSERT(msg);
370 return disc_items_msg->stream->class->default_clock_class;
371}
372
373const struct bt_clock_class *
374bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
375 const struct bt_message *msg)
376{
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(
380 msg);
381}
382
383const struct bt_clock_class *
384bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
385 const struct bt_message *msg)
386{
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(
390 msg);
391}
This page took 0.046015 seconds and 4 git commands to generate.