lib: assign a unique ID to each pre/postcond. and report it on failure
[babeltrace.git] / src / lib / graph / message / stream.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-STREAM"
c2d9d9cf 9#include "lib/logging.h"
d6e69534 10
d98421f2 11#include "lib/assert-cond.h"
578e048b 12#include "compat/compiler.h"
43c59509 13#include <babeltrace2/trace-ir/clock-snapshot.h>
578e048b 14#include "lib/trace-ir/stream.h"
3fadfbc0 15#include <babeltrace2/trace-ir/stream-class.h>
578e048b 16#include "lib/trace-ir/stream-class.h"
43c59509 17#include <babeltrace2/graph/message.h>
578e048b 18#include "common/assert.h"
d6e69534
PP
19#include <inttypes.h>
20
578e048b
MJ
21#include "stream.h"
22
1778c2a4
PP
23#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(_msg) \
24 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
25 "stream-beginning", BT_MESSAGE_TYPE_STREAM_BEGINNING)
26
27#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(_msg) \
28 BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
29 "stream-end", BT_MESSAGE_TYPE_STREAM_END)
30
d6e69534 31static
5df26c89 32void destroy_stream_message(struct bt_object *obj)
d6e69534 33{
5df26c89 34 struct bt_message_stream *message = (void *) obj;
d6e69534 35
5df26c89 36 BT_LIB_LOGD("Destroying stream message: %!+n", message);
82cacf47
PP
37
38 if (message->default_cs) {
39 BT_LIB_LOGD("Putting default clock snapshot: %!+k",
40 message->default_cs);
41 bt_clock_snapshot_destroy(message->default_cs);
42 message->default_cs = NULL;
43 }
44
d6e69534
PP
45 BT_LIB_LOGD("Putting stream: %!+s", message->stream);
46 BT_OBJECT_PUT_REF_AND_RESET(message->stream);
d6e69534
PP
47 g_free(message);
48}
49
5df26c89
PP
50static inline
51struct bt_message *create_stream_message(
d6e69534 52 struct bt_self_message_iterator *self_msg_iter,
1778c2a4
PP
53 struct bt_stream *stream, enum bt_message_type type,
54 const char *api_func)
d6e69534 55{
5df26c89 56 struct bt_message_stream *message;
d6e69534
PP
57 struct bt_stream_class *stream_class;
58
1778c2a4
PP
59 BT_ASSERT_PRE_MSG_ITER_NON_NULL_FROM_FUNC(api_func, self_msg_iter);
60 BT_ASSERT_PRE_STREAM_NON_NULL_FROM_FUNC(api_func, stream);
d6e69534
PP
61 stream_class = bt_stream_borrow_class(stream);
62 BT_ASSERT(stream_class);
5df26c89
PP
63 BT_LIB_LOGD("Creating stream message object: "
64 "type=%s, %![stream-]+s, %![sc-]+S",
65 bt_message_type_string(type), stream, stream_class);
66 message = g_new0(struct bt_message_stream, 1);
d6e69534 67 if (!message) {
870631a2
PP
68 BT_LIB_LOGE_APPEND_CAUSE(
69 "Failed to allocate one stream message.");
d6e69534
PP
70 goto error;
71 }
72
5df26c89
PP
73 bt_message_init(&message->parent, type,
74 destroy_stream_message, NULL);
d6e69534 75 message->stream = stream;
6871026b 76 bt_object_get_ref_no_null_check(message->stream);
188edac1
SM
77
78 if (stream_class->default_clock_class) {
79 message->default_cs = bt_clock_snapshot_create(
80 stream_class->default_clock_class);
81 if (!message->default_cs) {
82 goto error;
83 }
84 }
85
5df26c89 86 BT_LIB_LOGD("Created stream message object: "
d6e69534
PP
87 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
88 stream, stream_class);
89
188edac1 90 goto end;
5df26c89 91
d6e69534 92error:
188edac1
SM
93 if (message) {
94 g_free(message);
95 message = NULL;
96 }
97
98end:
99 return &message->parent;
d6e69534
PP
100}
101
5df26c89
PP
102struct bt_message *bt_message_stream_beginning_create(
103 struct bt_self_message_iterator *self_msg_iter,
58085ca4 104 const struct bt_stream *stream)
d6e69534 105{
17f3083a
SM
106 BT_ASSERT_PRE_DEV_NO_ERROR();
107
58085ca4 108 return create_stream_message(self_msg_iter, (void *) stream,
1778c2a4 109 BT_MESSAGE_TYPE_STREAM_BEGINNING, __func__);
d6e69534
PP
110}
111
5df26c89
PP
112struct bt_message *bt_message_stream_end_create(
113 struct bt_self_message_iterator *self_msg_iter,
58085ca4 114 const struct bt_stream *stream)
d6e69534 115{
17f3083a
SM
116 BT_ASSERT_PRE_DEV_NO_ERROR();
117
58085ca4 118 return create_stream_message(self_msg_iter, (void *) stream,
1778c2a4 119 BT_MESSAGE_TYPE_STREAM_END, __func__);
d6e69534
PP
120}
121
5df26c89
PP
122static inline
123struct bt_stream *borrow_stream_message_stream(struct bt_message *message)
d6e69534 124{
5df26c89 125 struct bt_message_stream *stream_msg;
d6e69534 126
98b15851 127 BT_ASSERT_DBG(message);
5df26c89
PP
128 stream_msg = (void *) message;
129 return stream_msg->stream;
d6e69534
PP
130}
131
5df26c89
PP
132struct bt_stream *bt_message_stream_beginning_borrow_stream(
133 struct bt_message *message)
d6e69534 134{
d5b13b9b 135 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
1778c2a4 136 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
5df26c89 137 return borrow_stream_message_stream(message);
d6e69534
PP
138}
139
5df26c89 140struct bt_stream *bt_message_stream_end_borrow_stream(
d6e69534
PP
141 struct bt_message *message)
142{
d5b13b9b 143 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
1778c2a4 144 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
5df26c89 145 return borrow_stream_message_stream(message);
d6e69534
PP
146}
147
148const struct bt_stream *bt_message_stream_beginning_borrow_stream_const(
149 const struct bt_message *message)
150{
151 return bt_message_stream_beginning_borrow_stream(
152 (void *) message);
153}
5df26c89
PP
154
155const struct bt_stream *bt_message_stream_end_borrow_stream_const(
156 const struct bt_message *message)
157{
158 return bt_message_stream_end_borrow_stream(
159 (void *) message);
160}
188edac1
SM
161
162static
1778c2a4
PP
163void set_stream_default_clock_snapshot(
164 struct bt_message *msg, uint64_t raw_value,
165 const char *api_func)
188edac1
SM
166{
167 struct bt_message_stream *stream_msg = (void *) msg;
168 struct bt_stream_class *sc;
169
170 BT_ASSERT(msg);
1778c2a4
PP
171 BT_ASSERT_PRE_DEV_HOT_FROM_FUNC(api_func, "message", msg,
172 "Message", ": %!+n", msg);
188edac1
SM
173 sc = stream_msg->stream->class;
174 BT_ASSERT(sc);
1778c2a4 175 BT_ASSERT_PRE_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
188edac1
SM
176 BT_ASSERT(stream_msg->default_cs);
177 bt_clock_snapshot_set_raw_value(stream_msg->default_cs, raw_value);
178 stream_msg->default_cs_state = BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN;
179 BT_LIB_LOGD("Set stream message's default clock snapshot: "
180 "%![msg-]+n, value=%" PRIu64, msg, raw_value);
181}
182
183void bt_message_stream_beginning_set_default_clock_snapshot(
184 struct bt_message *message, uint64_t raw_value)
185{
d5b13b9b 186 BT_ASSERT_PRE_MSG_NON_NULL(message);
1778c2a4
PP
187 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
188 set_stream_default_clock_snapshot(message, raw_value, __func__);
188edac1
SM
189}
190
191void bt_message_stream_end_set_default_clock_snapshot(
192 struct bt_message *message, uint64_t raw_value)
193{
d5b13b9b 194 BT_ASSERT_PRE_MSG_NON_NULL(message);
1778c2a4
PP
195 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
196 return set_stream_default_clock_snapshot(message, raw_value, __func__);
188edac1
SM
197}
198
199static enum bt_message_stream_clock_snapshot_state
1778c2a4
PP
200borrow_stream_message_default_clock_snapshot_const(
201 const bt_message *msg, const bt_clock_snapshot **snapshot,
202 const char *api_func)
188edac1
SM
203{
204 struct bt_message_stream *stream_msg = (void *) msg;
205 struct bt_stream_class *sc;
206
98b15851 207 BT_ASSERT_DBG(msg);
188edac1 208 sc = stream_msg->stream->class;
98b15851 209 BT_ASSERT_DBG(sc);
1778c2a4 210 BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
98b15851 211 BT_ASSERT_DBG(stream_msg->default_cs);
188edac1
SM
212
213 *snapshot = stream_msg->default_cs;
214
215 return stream_msg->default_cs_state;
216}
217
218enum bt_message_stream_clock_snapshot_state
219bt_message_stream_beginning_borrow_default_clock_snapshot_const(
220 const bt_message *message, const bt_clock_snapshot **snapshot)
221{
d5b13b9b 222 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
1778c2a4
PP
223 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
224 return borrow_stream_message_default_clock_snapshot_const(
225 message, snapshot, __func__);
188edac1
SM
226}
227
228enum bt_message_stream_clock_snapshot_state
229bt_message_stream_end_borrow_default_clock_snapshot_const(
230 const bt_message *message, const bt_clock_snapshot **snapshot)
231{
d5b13b9b 232 BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
1778c2a4
PP
233 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
234 return borrow_stream_message_default_clock_snapshot_const(
235 message, snapshot, __func__);
188edac1
SM
236}
237
238static inline
239const struct bt_clock_class *
240borrow_stream_message_stream_class_default_clock_class(
241 const struct bt_message *msg)
242{
243 struct bt_message_stream *stream_msg = (void *) msg;
244
98b15851 245 BT_ASSERT_DBG(msg);
188edac1
SM
246 return stream_msg->stream->class->default_clock_class;
247}
248
249const struct bt_clock_class *
250bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
251 const struct bt_message *msg)
252{
d5b13b9b 253 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
1778c2a4 254 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(msg);
188edac1
SM
255 return borrow_stream_message_stream_class_default_clock_class(msg);
256}
257
258const struct bt_clock_class *
259bt_message_stream_end_borrow_stream_class_default_clock_class_const(
260 const struct bt_message *msg)
261{
d5b13b9b 262 BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
1778c2a4 263 BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(msg);
188edac1
SM
264 return borrow_stream_message_stream_class_default_clock_class(msg);
265}
This page took 0.078538 seconds and 4 git commands to generate.