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 "NOTIF-STREAM"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/compiler-internal.h>
29 #include <babeltrace/trace-ir/stream-internal.h>
30 #include <babeltrace/trace-ir/stream-class.h>
31 #include <babeltrace/trace-ir/stream-class-internal.h>
32 #include <babeltrace/graph/notification-stream.h>
33 #include <babeltrace/graph/notification-stream-const.h>
34 #include <babeltrace/graph/notification-stream-internal.h>
35 #include <babeltrace/assert-internal.h>
39 void bt_notification_stream_end_destroy(struct bt_object
*obj
)
41 struct bt_notification_stream_end
*notification
=
42 (struct bt_notification_stream_end
*) obj
;
44 BT_LIB_LOGD("Destroying stream end notification: %!+n",
46 BT_LIB_LOGD("Putting stream: %!+s", notification
->stream
);
47 BT_OBJECT_PUT_REF_AND_RESET(notification
->stream
);
49 if (notification
->default_cv
) {
50 bt_clock_value_recycle(notification
->default_cv
);
51 notification
->default_cv
= NULL
;
57 struct bt_notification
*bt_notification_stream_end_create(
58 struct bt_self_notification_iterator
*self_notif_iter
,
59 struct bt_stream
*stream
)
61 struct bt_notification_stream_end
*notification
;
62 struct bt_stream_class
*stream_class
;
64 BT_ASSERT_PRE_NON_NULL(self_notif_iter
, "Notification iterator");
65 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
66 stream_class
= bt_stream_borrow_class(stream
);
67 BT_ASSERT(stream_class
);
68 BT_LIB_LOGD("Creating stream end notification object: "
69 "%![stream-]+s, %![sc-]+S", stream
, stream_class
);
70 notification
= g_new0(struct bt_notification_stream_end
, 1);
72 BT_LOGE_STR("Failed to allocate one stream end notification.");
76 bt_notification_init(¬ification
->parent
,
77 BT_NOTIFICATION_TYPE_STREAM_END
,
78 bt_notification_stream_end_destroy
, NULL
);
79 notification
->stream
= stream
;
80 bt_object_get_no_null_check(notification
->stream
);
81 BT_LIB_LOGD("Created stream end notification object: "
82 "%![notif-]+n, %![stream-]+s, %![sc-]+S", notification
,
83 stream
, stream_class
);
85 return (void *) ¬ification
->parent
;
90 struct bt_stream
*bt_notification_stream_end_borrow_stream(
91 struct bt_notification
*notification
)
93 struct bt_notification_stream_end
*stream_end
;
95 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
96 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
,
97 BT_NOTIFICATION_TYPE_STREAM_END
);
98 stream_end
= (void *) notification
;
99 return stream_end
->stream
;
102 const struct bt_stream
*bt_notification_stream_end_borrow_stream_const(
103 const struct bt_notification
*notification
)
105 return bt_notification_stream_end_borrow_stream(
106 (void *) notification
);
109 void bt_notification_stream_end_set_default_clock_value(
110 struct bt_notification
*notif
, uint64_t value_cycles
)
112 struct bt_notification_stream_end
*se_notif
= (void *) notif
;
114 BT_ASSERT_PRE_NON_NULL(notif
, "Notification");
115 BT_ASSERT_PRE_HOT(notif
, "Notification", ": %!+n", notif
);
116 BT_ASSERT_PRE_NOTIF_IS_TYPE(notif
, BT_NOTIFICATION_TYPE_STREAM_END
);
117 BT_ASSERT_PRE(se_notif
->stream
->class->default_clock_class
,
118 "Notification's stream class has no default clock class: "
119 "%![notif-]+n, %![sc-]+S", notif
, se_notif
->stream
->class);
121 /* TODO: have the object already created */
122 se_notif
->default_cv
= bt_clock_value_create(
123 se_notif
->stream
->class->default_clock_class
);
124 BT_ASSERT(se_notif
->default_cv
);
125 bt_clock_value_set_value_inline(se_notif
->default_cv
, value_cycles
);
126 BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
127 "value=%" PRIu64
, value_cycles
);
130 struct bt_clock_value
*bt_notification_stream_end_borrow_default_clock_value(
131 struct bt_notification
*notif
)
133 struct bt_notification_stream_end
*stream_end
= (void *) notif
;
135 BT_ASSERT_PRE_NON_NULL(notif
, "Notification");
136 BT_ASSERT_PRE_NOTIF_IS_TYPE(notif
, BT_NOTIFICATION_TYPE_STREAM_END
);
137 return stream_end
->default_cv
;
141 void bt_notification_stream_beginning_destroy(struct bt_object
*obj
)
143 struct bt_notification_stream_beginning
*notification
=
144 (struct bt_notification_stream_beginning
*) obj
;
146 BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
148 BT_LIB_LOGD("Putting stream: %!+s", notification
->stream
);
149 BT_OBJECT_PUT_REF_AND_RESET(notification
->stream
);
151 if (notification
->default_cv
) {
152 bt_clock_value_recycle(notification
->default_cv
);
153 notification
->default_cv
= NULL
;
156 g_free(notification
);
159 struct bt_notification
*bt_notification_stream_beginning_create(
160 struct bt_self_notification_iterator
*self_notif_iter
,
161 struct bt_stream
*stream
)
163 struct bt_notification_stream_beginning
*notification
;
164 struct bt_stream_class
*stream_class
;
166 BT_ASSERT_PRE_NON_NULL(self_notif_iter
, "Notification iterator");
167 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
168 stream_class
= bt_stream_borrow_class(stream
);
169 BT_ASSERT(stream_class
);
170 BT_LIB_LOGD("Creating stream beginning notification object: "
171 "%![stream-]+s, %![sc-]+S", stream
, stream_class
);
172 notification
= g_new0(struct bt_notification_stream_beginning
, 1);
174 BT_LOGE_STR("Failed to allocate one stream beginning notification.");
178 bt_notification_init(¬ification
->parent
,
179 BT_NOTIFICATION_TYPE_STREAM_BEGINNING
,
180 bt_notification_stream_beginning_destroy
, NULL
);
181 notification
->stream
= stream
;
182 bt_object_get_no_null_check(notification
->stream
);
183 BT_LIB_LOGD("Created stream beginning notification object: "
184 "%![notif-]+n, %![stream-]+s, %![sc-]+S", notification
,
185 stream
, stream_class
);
186 return (void *) ¬ification
->parent
;
191 struct bt_stream
*bt_notification_stream_beginning_borrow_stream(
192 struct bt_notification
*notification
)
194 struct bt_notification_stream_beginning
*stream_begin
;
196 BT_ASSERT_PRE_NON_NULL(notification
, "Notification");
197 BT_ASSERT_PRE_NOTIF_IS_TYPE(notification
,
198 BT_NOTIFICATION_TYPE_STREAM_BEGINNING
);
199 stream_begin
= (void *) notification
;
200 return stream_begin
->stream
;
203 const struct bt_stream
*bt_notification_stream_beginning_borrow_stream_const(
204 const struct bt_notification
*notification
)
206 return bt_notification_stream_beginning_borrow_stream(
207 (void *) notification
);
210 void bt_notification_stream_beginning_set_default_clock_value(
211 struct bt_notification
*notif
,
212 uint64_t value_cycles
)
214 struct bt_notification_stream_beginning
*sb_notif
= (void *) notif
;
216 BT_ASSERT_PRE_NON_NULL(notif
, "Notification");
217 BT_ASSERT_PRE_HOT(notif
, "Notification", ": %!+n", notif
);
218 BT_ASSERT_PRE_NOTIF_IS_TYPE(notif
, BT_NOTIFICATION_TYPE_STREAM_BEGINNING
);
219 BT_ASSERT_PRE(sb_notif
->stream
->class->default_clock_class
,
220 "Notification's stream class has no default clock class: "
221 "%![notif-]+n, %![sc-]+S", notif
, sb_notif
->stream
->class);
223 /* TODO: have the object already created */
224 sb_notif
->default_cv
= bt_clock_value_create(
225 sb_notif
->stream
->class->default_clock_class
);
226 BT_ASSERT(sb_notif
->default_cv
);
227 bt_clock_value_set_value_inline(sb_notif
->default_cv
, value_cycles
);
228 BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
229 "value=%" PRIu64
, value_cycles
);
232 struct bt_clock_value
*bt_notification_stream_beginning_borrow_default_clock_value(
233 struct bt_notification
*notif
)
235 struct bt_notification_stream_beginning
*stream_begin
= (void *) notif
;
237 BT_ASSERT_PRE_NON_NULL(notif
, "Notification");
238 BT_ASSERT_PRE_NOTIF_IS_TYPE(notif
, BT_NOTIFICATION_TYPE_STREAM_BEGINNING
);
239 return stream_begin
->default_cv
;