lib: assign a unique ID to each pre/postcond. and report it on failure
[babeltrace.git] / src / lib / graph / message / event.c
CommitLineData
d6e69534 1/*
0235b0db
MJ
2 * SPDX-License-Identifier: MIT
3 *
d6e69534
PP
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
d6e69534
PP
6 */
7
350ad6c1 8#define BT_LOG_TAG "LIB/MSG-EVENT"
c2d9d9cf 9#include "lib/logging.h"
d6e69534 10
578e048b 11#include "common/assert.h"
d98421f2 12#include "lib/assert-cond.h"
578e048b
MJ
13#include "compat/compiler.h"
14#include "lib/object.h"
3fadfbc0 15#include <babeltrace2/trace-ir/event.h>
578e048b
MJ
16#include "lib/trace-ir/event.h"
17#include "lib/trace-ir/event-class.h"
18#include "lib/trace-ir/stream-class.h"
3fadfbc0 19#include <babeltrace2/trace-ir/trace.h>
578e048b
MJ
20#include "lib/trace-ir/clock-snapshot.h"
21#include "lib/graph/graph.h"
43c59509 22#include <babeltrace2/graph/message.h>
3fadfbc0 23#include <babeltrace2/types.h>
d6e69534
PP
24#include <stdbool.h>
25#include <inttypes.h>
26
578e048b
MJ
27#include "event.h"
28
1778c2a4
PP
29#define BT_ASSERT_PRE_DEV_MSG_IS_EVENT(_msg) \
30 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), "event", \
31 BT_MESSAGE_TYPE_EVENT)
d6e69534
PP
32
33BT_HIDDEN
34struct bt_message *bt_message_event_new(
35 struct bt_graph *graph)
36{
37 struct bt_message_event *message = NULL;
38
39 message = g_new0(struct bt_message_event, 1);
40 if (!message) {
870631a2
PP
41 BT_LIB_LOGE_APPEND_CAUSE(
42 "Failed to allocate one event message.");
d6e69534
PP
43 goto error;
44 }
45
46 bt_message_init(&message->parent, BT_MESSAGE_TYPE_EVENT,
47 (bt_object_release_func) bt_message_event_recycle, graph);
48 goto end;
49
50error:
51 BT_OBJECT_PUT_REF_AND_RESET(message);
52
53end:
54 return (void *) message;
55}
56
cbb76258
PP
57static
58struct bt_event *create_event(struct bt_event_class *event_class,
1778c2a4
PP
59 struct bt_packet *packet, struct bt_stream *stream,
60 const char *api_func)
cbb76258
PP
61{
62 struct bt_event *event = NULL;
63
64 BT_ASSERT_DBG(event_class);
65 BT_ASSERT_DBG(stream);
66 event = bt_object_pool_create_object(&event_class->event_pool);
67 if (G_UNLIKELY(!event)) {
68 BT_LIB_LOGE_APPEND_CAUSE(
69 "Cannot allocate one event from event class's event pool: "
70 "%![ec-]+E", event_class);
71 goto end;
72 }
73
74 if (G_LIKELY(!event->class)) {
75 event->class = event_class;
76 bt_object_get_ref_no_null_check(&event_class->base);
77 }
78
79 BT_ASSERT_DBG(!event->stream);
80 event->stream = stream;
81 bt_object_get_ref_no_null_check_no_parent_check(&event->stream->base);
82 BT_LIB_LOGD("Set event's stream: %![event-]+e, %![stream-]+s",
83 event, stream);
84
85 if (packet) {
1778c2a4
PP
86 BT_ASSERT_PRE_DEV_FROM_FUNC(api_func,
87 "packet-stream-class-is-event-class-stream-class",
88 bt_event_class_borrow_stream_class(
89 event_class) == packet->stream->class,
cbb76258
PP
90 "Packet's stream class and event class's stream class differ: "
91 "%![ec-]+E, %![packet-]+a", event, packet);
92 BT_ASSERT_DBG(event->stream->class->supports_packets);
93 BT_ASSERT_DBG(!event->packet);
94 event->packet = packet;
95 bt_object_get_ref_no_null_check_no_parent_check(&event->packet->base);
96 BT_LIB_LOGD("Set event's packet: %![event-]+e, %![packet-]+a",
97 event, packet);
98 }
99
100end:
101 return event;
102}
103
2c091c04
PP
104static inline
105struct bt_message *create_event_message(
d6e69534 106 struct bt_self_message_iterator *self_msg_iter,
58085ca4 107 const struct bt_event_class *c_event_class,
26fc5aed
PP
108 const struct bt_packet *c_packet,
109 const struct bt_stream *c_stream, bool with_cs,
1778c2a4 110 uint64_t raw_value, const char *api_func)
d6e69534 111{
9a2c8b8e 112 struct bt_message_iterator *msg_iter =
d6e69534
PP
113 (void *) self_msg_iter;
114 struct bt_message_event *message = NULL;
58085ca4 115 struct bt_event_class *event_class = (void *) c_event_class;
2c091c04 116 struct bt_stream_class *stream_class;
58085ca4 117 struct bt_packet *packet = (void *) c_packet;
26fc5aed 118 struct bt_stream *stream = (void *) c_stream;
d6e69534
PP
119 struct bt_event *event;
120
98b15851 121 BT_ASSERT_DBG(stream);
1778c2a4
PP
122 BT_ASSERT_PRE_MSG_ITER_NON_NULL_FROM_FUNC(api_func, msg_iter);
123 BT_ASSERT_PRE_EC_NON_NULL_FROM_FUNC(api_func, event_class);
124 stream_class = bt_event_class_borrow_stream_class_inline(event_class);
125 BT_ASSERT_PRE_FROM_FUNC(api_func,
126 "stream-class-is-event-class-stream-class",
127 bt_event_class_borrow_stream_class(event_class) ==
128 stream->class,
cbb76258
PP
129 "Stream's class and event's stream class differ: "
130 "%![ec-]+E, %![stream-]+s", event_class, stream);
98b15851 131 BT_ASSERT_DBG(stream_class);
1778c2a4
PP
132 BT_ASSERT_PRE_FROM_FUNC(api_func,
133 "with-default-clock-snapshot-if-stream-class-has-default-clock-class",
134 (with_cs && stream_class->default_clock_class) ||
2c091c04
PP
135 (!with_cs && !stream_class->default_clock_class),
136 "Creating an event message with a default clock snapshot, but without "
137 "a default clock class, or without a default clock snapshot, "
138 "but with a default clock class: ",
139 "%![ec-]+E, %![sc-]+S, with-cs=%d, "
140 "cs-val=%" PRIu64,
141 event_class, stream_class, with_cs, raw_value);
142 BT_LIB_LOGD("Creating event message object: %![ec-]+E", event_class);
1778c2a4 143 event = create_event(event_class, packet, stream, api_func);
91d81473 144 if (G_UNLIKELY(!event)) {
870631a2
PP
145 BT_LIB_LOGE_APPEND_CAUSE(
146 "Cannot create event from event class: "
d6e69534
PP
147 "%![ec-]+E", event_class);
148 goto error;
149 }
150
151 /*
152 * Create message from pool _after_ we have everything
153 * (in this case, a valid event object) so that we never have an
154 * error condition with a non-NULL message object.
155 * Otherwise:
156 *
157 * * We cannot recycle the message on error because
158 * bt_message_event_recycle() expects a complete
159 * message (and the event or clock class priority map
160 * object could be unset).
161 *
162 * * We cannot destroy the message because we would need
163 * to notify the graph (pool owner) so that it removes the
164 * message from its message array.
165 */
166 message = (void *) bt_message_create_from_pool(
167 &msg_iter->graph->event_msg_pool, msg_iter->graph);
91d81473 168 if (G_UNLIKELY(!message)) {
d6e69534
PP
169 /* bt_message_create_from_pool() logs errors */
170 goto error;
171 }
172
2c091c04 173 if (with_cs) {
98b15851 174 BT_ASSERT_DBG(stream_class->default_clock_class);
2c091c04
PP
175 message->default_cs = bt_clock_snapshot_create(
176 stream_class->default_clock_class);
177 if (!message->default_cs) {
178 goto error;
179 }
180
181 bt_clock_snapshot_set_raw_value(message->default_cs, raw_value);
182 }
183
98b15851 184 BT_ASSERT_DBG(!message->event);
d6e69534 185 message->event = event;
26fc5aed
PP
186
187 if (packet) {
188 bt_packet_set_is_frozen(packet, true);
189 }
190
191 bt_stream_freeze(stream);
d6e69534
PP
192 bt_event_class_freeze(event_class);
193 BT_LIB_LOGD("Created event message object: "
194 "%![msg-]+n, %![event-]+e", message, event);
195 goto end;
196
197error:
198 BT_ASSERT(!message);
199 bt_event_destroy(event);
200
201end:
202 return (void *) message;
203}
204
2c091c04 205struct bt_message *bt_message_event_create(
26fc5aed
PP
206 struct bt_self_message_iterator *msg_iter,
207 const struct bt_event_class *event_class,
208 const struct bt_stream *stream)
209{
17f3083a 210 BT_ASSERT_PRE_DEV_NO_ERROR();
d5b13b9b 211 BT_ASSERT_PRE_STREAM_NON_NULL(stream);
1778c2a4
PP
212 return create_event_message(msg_iter, event_class, NULL, stream,
213 false, 0, __func__);
26fc5aed
PP
214}
215
216struct bt_message *bt_message_event_create_with_packet(
2c091c04
PP
217 struct bt_self_message_iterator *msg_iter,
218 const struct bt_event_class *event_class,
219 const struct bt_packet *packet)
220{
17f3083a 221 BT_ASSERT_PRE_DEV_NO_ERROR();
d5b13b9b 222 BT_ASSERT_PRE_PACKET_NON_NULL(packet);
26fc5aed 223 return create_event_message(msg_iter, event_class, packet,
1778c2a4 224 packet->stream, false, 0, __func__);
2c091c04
PP
225}
226
227struct bt_message *bt_message_event_create_with_default_clock_snapshot(
26fc5aed
PP
228 struct bt_self_message_iterator *msg_iter,
229 const struct bt_event_class *event_class,
230 const struct bt_stream *stream,
231 uint64_t raw_value)
232{
17f3083a 233 BT_ASSERT_PRE_DEV_NO_ERROR();
d5b13b9b 234 BT_ASSERT_PRE_STREAM_NON_NULL(stream);
26fc5aed 235 return create_event_message(msg_iter, event_class, NULL, stream,
1778c2a4 236 true, raw_value, __func__);
26fc5aed
PP
237}
238
239struct bt_message *
240bt_message_event_create_with_packet_and_default_clock_snapshot(
2c091c04
PP
241 struct bt_self_message_iterator *msg_iter,
242 const struct bt_event_class *event_class,
243 const struct bt_packet *packet,
244 uint64_t raw_value)
245{
17f3083a 246 BT_ASSERT_PRE_DEV_NO_ERROR();
d5b13b9b 247 BT_ASSERT_PRE_PACKET_NON_NULL(packet);
2c091c04 248 return create_event_message(msg_iter, event_class, packet,
1778c2a4 249 packet->stream, true, raw_value, __func__);
2c091c04
PP
250}
251
d6e69534
PP
252BT_HIDDEN
253void bt_message_event_destroy(struct bt_message *msg)
254{
255 struct bt_message_event *event_msg = (void *) msg;
256
257 BT_LIB_LOGD("Destroying event message: %!+n", msg);
258
259 if (event_msg->event) {
260 BT_LIB_LOGD("Recycling event: %!+e", event_msg->event);
261 bt_event_recycle(event_msg->event);
262 event_msg->event = NULL;
263 }
264
2c091c04
PP
265 if (event_msg->default_cs) {
266 bt_clock_snapshot_recycle(event_msg->default_cs);
267 event_msg->default_cs = NULL;
268 }
269
d6e69534
PP
270 g_free(msg);
271}
272
273BT_HIDDEN
274void bt_message_event_recycle(struct bt_message *msg)
275{
276 struct bt_message_event *event_msg = (void *) msg;
277 struct bt_graph *graph;
278
98b15851 279 BT_ASSERT_DBG(event_msg);
d6e69534 280
91d81473 281 if (G_UNLIKELY(!msg->graph)) {
d6e69534
PP
282 bt_message_event_destroy(msg);
283 return;
284 }
285
286 BT_LIB_LOGD("Recycling event message: %![msg-]+n, %![event-]+e",
287 msg, event_msg->event);
288 bt_message_reset(msg);
98b15851 289 BT_ASSERT_DBG(event_msg->event);
d6e69534
PP
290 bt_event_recycle(event_msg->event);
291 event_msg->event = NULL;
2c091c04
PP
292
293 if (event_msg->default_cs) {
294 bt_clock_snapshot_recycle(event_msg->default_cs);
295 event_msg->default_cs = NULL;
296 }
297
d6e69534
PP
298 graph = msg->graph;
299 msg->graph = NULL;
300 bt_object_pool_recycle_object(&graph->event_msg_pool, msg);
301}
302
1778c2a4
PP
303#define BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(_msg) \
304 do { \
305 BT_ASSERT_PRE_DEV_MSG_NON_NULL(_msg); \
306 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(_msg); \
307 } while (0)
308
d6e69534
PP
309static inline
310struct bt_event *borrow_event(struct bt_message *message)
311{
312 struct bt_message_event *event_message;
313
d6e69534
PP
314 event_message = container_of(message,
315 struct bt_message_event, parent);
316 return event_message->event;
317}
318
319struct bt_event *bt_message_event_borrow_event(
320 struct bt_message *message)
321{
1778c2a4 322 BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(message);
d6e69534
PP
323 return borrow_event(message);
324}
325
326const struct bt_event *bt_message_event_borrow_event_const(
327 const struct bt_message *message)
328{
1778c2a4 329 BT_ASSERT_PRE_DEV_FOR_BORROW_EVENTS(message);
d6e69534
PP
330 return borrow_event((void *) message);
331}
2c091c04 332
0cbc2c33 333const struct bt_clock_snapshot *
2c091c04 334bt_message_event_borrow_default_clock_snapshot_const(
0cbc2c33 335 const struct bt_message *msg)
2c091c04
PP
336{
337 struct bt_message_event *event_msg = (void *) msg;
338 struct bt_stream_class *stream_class;
339
d5b13b9b 340 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
1778c2a4 341 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(msg);
33931ab8 342 stream_class = bt_event_class_borrow_stream_class_inline(
2c091c04 343 event_msg->event->class);
98b15851 344 BT_ASSERT_DBG(stream_class);
d5b13b9b 345 BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS(msg, stream_class);
0cbc2c33 346 return event_msg->default_cs;
2c091c04 347}
33931ab8
PP
348
349const bt_clock_class *
350bt_message_event_borrow_stream_class_default_clock_class_const(
351 const bt_message *msg)
352{
353 struct bt_message_event *event_msg = (void *) msg;
354 struct bt_stream_class *stream_class;
355
d5b13b9b 356 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
1778c2a4 357 BT_ASSERT_PRE_DEV_MSG_IS_EVENT(msg);
33931ab8
PP
358 stream_class = bt_event_class_borrow_stream_class_inline(
359 event_msg->event->class);
98b15851 360 BT_ASSERT_DBG(stream_class);
33931ab8
PP
361 return stream_class->default_clock_class;
362}
This page took 0.081993 seconds and 4 git commands to generate.