2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "LIB/MSG-STREAM"
25 #include "lib/logging.h"
27 #include "lib/assert-pre.h"
28 #include "compat/compiler.h"
29 #include <babeltrace2/trace-ir/clock-snapshot-const.h>
30 #include "lib/trace-ir/stream.h"
31 #include <babeltrace2/trace-ir/stream-class.h>
32 #include "lib/trace-ir/stream-class.h"
33 #include <babeltrace2/graph/message-stream-beginning.h>
34 #include <babeltrace2/graph/message-stream-end.h>
35 #include <babeltrace2/graph/message-stream-beginning-const.h>
36 #include <babeltrace2/graph/message-stream-end-const.h>
37 #include "common/assert.h"
43 void destroy_stream_message(struct bt_object
*obj
)
45 struct bt_message_stream
*message
= (void *) obj
;
47 BT_LIB_LOGD("Destroying stream message: %!+n", message
);
49 if (message
->default_cs
) {
50 BT_LIB_LOGD("Putting default clock snapshot: %!+k",
52 bt_clock_snapshot_destroy(message
->default_cs
);
53 message
->default_cs
= NULL
;
56 BT_LIB_LOGD("Putting stream: %!+s", message
->stream
);
57 BT_OBJECT_PUT_REF_AND_RESET(message
->stream
);
62 struct bt_message
*create_stream_message(
63 struct bt_self_message_iterator
*self_msg_iter
,
64 struct bt_stream
*stream
, enum bt_message_type type
)
66 struct bt_message_stream
*message
;
67 struct bt_stream_class
*stream_class
;
69 BT_ASSERT_PRE_NON_NULL(self_msg_iter
, "Message iterator");
70 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
71 stream_class
= bt_stream_borrow_class(stream
);
72 BT_ASSERT(stream_class
);
73 BT_LIB_LOGD("Creating stream message object: "
74 "type=%s, %![stream-]+s, %![sc-]+S",
75 bt_message_type_string(type
), stream
, stream_class
);
76 message
= g_new0(struct bt_message_stream
, 1);
78 BT_LIB_LOGE_APPEND_CAUSE(
79 "Failed to allocate one stream message.");
83 bt_message_init(&message
->parent
, type
,
84 destroy_stream_message
, NULL
);
85 message
->stream
= stream
;
86 bt_object_get_ref_no_null_check(message
->stream
);
88 if (stream_class
->default_clock_class
) {
89 message
->default_cs
= bt_clock_snapshot_create(
90 stream_class
->default_clock_class
);
91 if (!message
->default_cs
) {
96 BT_LIB_LOGD("Created stream message object: "
97 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message
,
98 stream
, stream_class
);
109 return &message
->parent
;
112 struct bt_message
*bt_message_stream_beginning_create(
113 struct bt_self_message_iterator
*self_msg_iter
,
114 const struct bt_stream
*stream
)
116 BT_ASSERT_PRE_DEV_NO_ERROR();
118 return create_stream_message(self_msg_iter
, (void *) stream
,
119 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
122 struct bt_message
*bt_message_stream_end_create(
123 struct bt_self_message_iterator
*self_msg_iter
,
124 const struct bt_stream
*stream
)
126 BT_ASSERT_PRE_DEV_NO_ERROR();
128 return create_stream_message(self_msg_iter
, (void *) stream
,
129 BT_MESSAGE_TYPE_STREAM_END
);
133 struct bt_stream
*borrow_stream_message_stream(struct bt_message
*message
)
135 struct bt_message_stream
*stream_msg
;
137 BT_ASSERT_DBG(message
);
138 stream_msg
= (void *) message
;
139 return stream_msg
->stream
;
142 struct bt_stream
*bt_message_stream_beginning_borrow_stream(
143 struct bt_message
*message
)
145 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
146 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
147 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
148 return borrow_stream_message_stream(message
);
151 struct bt_stream
*bt_message_stream_end_borrow_stream(
152 struct bt_message
*message
)
154 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
155 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
156 BT_MESSAGE_TYPE_STREAM_END
);
157 return borrow_stream_message_stream(message
);
160 const struct bt_stream
*bt_message_stream_beginning_borrow_stream_const(
161 const struct bt_message
*message
)
163 return bt_message_stream_beginning_borrow_stream(
167 const struct bt_stream
*bt_message_stream_end_borrow_stream_const(
168 const struct bt_message
*message
)
170 return bt_message_stream_end_borrow_stream(
175 void bt_message_stream_set_default_clock_snapshot(
176 struct bt_message
*msg
, uint64_t raw_value
)
178 struct bt_message_stream
*stream_msg
= (void *) msg
;
179 struct bt_stream_class
*sc
;
182 BT_ASSERT_PRE_DEV_HOT(msg
, "Message", ": %!+n", msg
);
183 sc
= stream_msg
->stream
->class;
185 BT_ASSERT_PRE(sc
->default_clock_class
,
186 "Message's stream's class has no default clock class: "
187 "%![msg-]+n, %![sc-]+S", msg
, sc
);
188 BT_ASSERT(stream_msg
->default_cs
);
189 bt_clock_snapshot_set_raw_value(stream_msg
->default_cs
, raw_value
);
190 stream_msg
->default_cs_state
= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
;
191 BT_LIB_LOGD("Set stream message's default clock snapshot: "
192 "%![msg-]+n, value=%" PRIu64
, msg
, raw_value
);
195 void bt_message_stream_beginning_set_default_clock_snapshot(
196 struct bt_message
*message
, uint64_t raw_value
)
198 BT_ASSERT_PRE_NON_NULL(message
, "Message");
199 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_BEGINNING
);
201 bt_message_stream_set_default_clock_snapshot(message
, raw_value
);
204 void bt_message_stream_end_set_default_clock_snapshot(
205 struct bt_message
*message
, uint64_t raw_value
)
207 BT_ASSERT_PRE_NON_NULL(message
, "Message");
208 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_END
);
210 return bt_message_stream_set_default_clock_snapshot(message
, raw_value
);
213 static enum bt_message_stream_clock_snapshot_state
214 bt_message_stream_borrow_default_clock_snapshot_const(
215 const bt_message
*msg
, const bt_clock_snapshot
**snapshot
)
217 struct bt_message_stream
*stream_msg
= (void *) msg
;
218 struct bt_stream_class
*sc
;
221 sc
= stream_msg
->stream
->class;
223 BT_ASSERT_PRE_DEV(sc
->default_clock_class
,
224 "Message's stream's class has no default clock class: "
225 "%![msg-]+n, %![sc-]+S", msg
, sc
);
226 BT_ASSERT_DBG(stream_msg
->default_cs
);
228 *snapshot
= stream_msg
->default_cs
;
230 return stream_msg
->default_cs_state
;
233 enum bt_message_stream_clock_snapshot_state
234 bt_message_stream_beginning_borrow_default_clock_snapshot_const(
235 const bt_message
*message
, const bt_clock_snapshot
**snapshot
)
237 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
238 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
,
239 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
240 return bt_message_stream_borrow_default_clock_snapshot_const(
244 enum bt_message_stream_clock_snapshot_state
245 bt_message_stream_end_borrow_default_clock_snapshot_const(
246 const bt_message
*message
, const bt_clock_snapshot
**snapshot
)
248 BT_ASSERT_PRE_DEV_NON_NULL(message
, "Message");
249 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_END
);
250 return bt_message_stream_borrow_default_clock_snapshot_const(
255 const struct bt_clock_class
*
256 borrow_stream_message_stream_class_default_clock_class(
257 const struct bt_message
*msg
)
259 struct bt_message_stream
*stream_msg
= (void *) msg
;
262 return stream_msg
->stream
->class->default_clock_class
;
265 const struct bt_clock_class
*
266 bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
267 const struct bt_message
*msg
)
269 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
270 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
,
271 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
272 return borrow_stream_message_stream_class_default_clock_class(msg
);
275 const struct bt_clock_class
*
276 bt_message_stream_end_borrow_stream_class_default_clock_class_const(
277 const struct bt_message
*msg
)
279 BT_ASSERT_PRE_DEV_NON_NULL(msg
, "Message");
280 BT_ASSERT_PRE_DEV_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_STREAM_END
);
281 return borrow_stream_message_stream_class_default_clock_class(msg
);