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
);
48 BT_LIB_LOGD("Putting stream: %!+s", message
->stream
);
49 BT_OBJECT_PUT_REF_AND_RESET(message
->stream
);
54 struct bt_message
*create_stream_message(
55 struct bt_self_message_iterator
*self_msg_iter
,
56 struct bt_stream
*stream
, enum bt_message_type type
)
58 struct bt_message_stream
*message
;
59 struct bt_stream_class
*stream_class
;
61 BT_ASSERT_PRE_NON_NULL(self_msg_iter
, "Message iterator");
62 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
63 stream_class
= bt_stream_borrow_class(stream
);
64 BT_ASSERT(stream_class
);
65 BT_LIB_LOGD("Creating stream message object: "
66 "type=%s, %![stream-]+s, %![sc-]+S",
67 bt_message_type_string(type
), stream
, stream_class
);
68 message
= g_new0(struct bt_message_stream
, 1);
70 BT_LIB_LOGE_APPEND_CAUSE(
71 "Failed to allocate one stream message.");
75 bt_message_init(&message
->parent
, type
,
76 destroy_stream_message
, NULL
);
77 message
->stream
= stream
;
78 bt_object_get_no_null_check(message
->stream
);
80 if (stream_class
->default_clock_class
) {
81 message
->default_cs
= bt_clock_snapshot_create(
82 stream_class
->default_clock_class
);
83 if (!message
->default_cs
) {
88 BT_LIB_LOGD("Created stream message object: "
89 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message
,
90 stream
, stream_class
);
101 return &message
->parent
;
104 struct bt_message
*bt_message_stream_beginning_create(
105 struct bt_self_message_iterator
*self_msg_iter
,
106 const struct bt_stream
*stream
)
108 return create_stream_message(self_msg_iter
, (void *) stream
,
109 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
112 struct bt_message
*bt_message_stream_end_create(
113 struct bt_self_message_iterator
*self_msg_iter
,
114 const struct bt_stream
*stream
)
116 return create_stream_message(self_msg_iter
, (void *) stream
,
117 BT_MESSAGE_TYPE_STREAM_END
);
121 struct bt_stream
*borrow_stream_message_stream(struct bt_message
*message
)
123 struct bt_message_stream
*stream_msg
;
126 stream_msg
= (void *) message
;
127 return stream_msg
->stream
;
130 struct bt_stream
*bt_message_stream_beginning_borrow_stream(
131 struct bt_message
*message
)
133 BT_ASSERT_PRE_NON_NULL(message
, "Message");
134 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_BEGINNING
);
135 return borrow_stream_message_stream(message
);
138 struct bt_stream
*bt_message_stream_end_borrow_stream(
139 struct bt_message
*message
)
141 BT_ASSERT_PRE_NON_NULL(message
, "Message");
142 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_END
);
143 return borrow_stream_message_stream(message
);
146 const struct bt_stream
*bt_message_stream_beginning_borrow_stream_const(
147 const struct bt_message
*message
)
149 return bt_message_stream_beginning_borrow_stream(
153 const struct bt_stream
*bt_message_stream_end_borrow_stream_const(
154 const struct bt_message
*message
)
156 return bt_message_stream_end_borrow_stream(
161 void bt_message_stream_set_default_clock_snapshot(
162 struct bt_message
*msg
, uint64_t raw_value
)
164 struct bt_message_stream
*stream_msg
= (void *) msg
;
165 struct bt_stream_class
*sc
;
168 BT_ASSERT_PRE_HOT(msg
, "Message", ": %!+n", msg
);
169 sc
= stream_msg
->stream
->class;
171 BT_ASSERT_PRE(sc
->default_clock_class
,
172 "Message's stream's class has no default clock class: "
173 "%![msg-]+n, %![sc-]+S", msg
, sc
);
174 BT_ASSERT(stream_msg
->default_cs
);
175 bt_clock_snapshot_set_raw_value(stream_msg
->default_cs
, raw_value
);
176 stream_msg
->default_cs_state
= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
;
177 BT_LIB_LOGD("Set stream message's default clock snapshot: "
178 "%![msg-]+n, value=%" PRIu64
, msg
, raw_value
);
181 void bt_message_stream_beginning_set_default_clock_snapshot(
182 struct bt_message
*message
, uint64_t raw_value
)
184 BT_ASSERT_PRE_NON_NULL(message
, "Message");
185 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_BEGINNING
);
187 bt_message_stream_set_default_clock_snapshot(message
, raw_value
);
190 void bt_message_stream_end_set_default_clock_snapshot(
191 struct bt_message
*message
, uint64_t raw_value
)
193 BT_ASSERT_PRE_NON_NULL(message
, "Message");
194 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_END
);
196 return bt_message_stream_set_default_clock_snapshot(message
, raw_value
);
199 static enum bt_message_stream_clock_snapshot_state
200 bt_message_stream_borrow_default_clock_snapshot_const(
201 const bt_message
*msg
, const bt_clock_snapshot
**snapshot
)
203 struct bt_message_stream
*stream_msg
= (void *) msg
;
204 struct bt_stream_class
*sc
;
207 sc
= stream_msg
->stream
->class;
209 BT_ASSERT_PRE(sc
->default_clock_class
,
210 "Message's stream's class has no default clock class: "
211 "%![msg-]+n, %![sc-]+S", msg
, sc
);
212 BT_ASSERT(stream_msg
->default_cs
);
214 *snapshot
= stream_msg
->default_cs
;
216 return stream_msg
->default_cs_state
;
219 enum bt_message_stream_clock_snapshot_state
220 bt_message_stream_beginning_borrow_default_clock_snapshot_const(
221 const bt_message
*message
, const bt_clock_snapshot
**snapshot
)
223 BT_ASSERT_PRE_NON_NULL(message
, "Message");
224 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_BEGINNING
);
226 return bt_message_stream_borrow_default_clock_snapshot_const(
230 enum bt_message_stream_clock_snapshot_state
231 bt_message_stream_end_borrow_default_clock_snapshot_const(
232 const bt_message
*message
, const bt_clock_snapshot
**snapshot
)
234 BT_ASSERT_PRE_NON_NULL(message
, "Message");
235 BT_ASSERT_PRE_MSG_IS_TYPE(message
, BT_MESSAGE_TYPE_STREAM_END
);
237 return bt_message_stream_borrow_default_clock_snapshot_const(
242 const struct bt_clock_class
*
243 borrow_stream_message_stream_class_default_clock_class(
244 const struct bt_message
*msg
)
246 struct bt_message_stream
*stream_msg
= (void *) msg
;
249 return stream_msg
->stream
->class->default_clock_class
;
252 const struct bt_clock_class
*
253 bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
254 const struct bt_message
*msg
)
256 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
257 BT_ASSERT_PRE_MSG_IS_TYPE(msg
,
258 BT_MESSAGE_TYPE_STREAM_BEGINNING
);
259 return borrow_stream_message_stream_class_default_clock_class(msg
);
262 const struct bt_clock_class
*
263 bt_message_stream_end_borrow_stream_class_default_clock_class_const(
264 const struct bt_message
*msg
)
266 BT_ASSERT_PRE_NON_NULL(msg
, "Message");
267 BT_ASSERT_PRE_MSG_IS_TYPE(msg
, BT_MESSAGE_TYPE_STREAM_END
);
268 return borrow_stream_message_stream_class_default_clock_class(msg
);