2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 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 "STREAM"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/trace-ir/stream-const.h>
29 #include <babeltrace/trace-ir/stream.h>
30 #include <babeltrace/trace-ir/stream-internal.h>
31 #include <babeltrace/trace-ir/stream-class.h>
32 #include <babeltrace/trace-ir/stream-class-internal.h>
33 #include <babeltrace/trace-ir/trace.h>
34 #include <babeltrace/trace-ir/trace-internal.h>
35 #include <babeltrace/trace-ir/packet-internal.h>
36 #include <babeltrace/object.h>
37 #include <babeltrace/compiler-internal.h>
38 #include <babeltrace/align-internal.h>
39 #include <babeltrace/assert-internal.h>
40 #include <babeltrace/property-internal.h>
44 #define BT_ASSERT_PRE_STREAM_HOT(_stream) \
45 BT_ASSERT_PRE_HOT((_stream), "Stream", ": %!+s", (_stream))
48 void destroy_stream(struct bt_object
*obj
)
50 struct bt_stream
*stream
= (void *) obj
;
52 BT_LIB_LOGD("Destroying stream object: %!+s", stream
);
54 if (stream
->name
.str
) {
55 g_string_free(stream
->name
.str
, TRUE
);
56 stream
->name
.str
= NULL
;
57 stream
->name
.value
= NULL
;
60 BT_LOGD_STR("Putting stream's class.");
61 bt_object_put_ref(stream
->class);
62 bt_object_pool_finalize(&stream
->packet_pool
);
67 void bt_stream_free_packet(struct bt_packet
*packet
, struct bt_stream
*stream
)
69 bt_packet_destroy(packet
);
74 bool stream_id_is_unique(struct bt_trace
*trace
,
75 struct bt_stream_class
*stream_class
, uint64_t id
)
78 bool is_unique
= true;
80 for (i
= 0; i
< trace
->streams
->len
; i
++) {
81 struct bt_stream
*stream
= trace
->streams
->pdata
[i
];
83 if (stream
->class != stream_class
) {
87 if (stream
->id
== id
) {
98 struct bt_stream
*create_stream_with_id(struct bt_stream_class
*stream_class
,
99 struct bt_trace
*trace
, uint64_t id
)
102 struct bt_stream
*stream
;
104 BT_ASSERT(stream_class
);
106 BT_ASSERT_PRE(trace
->class ==
107 bt_stream_class_borrow_trace_class_inline(stream_class
),
108 "Trace's class is different from stream class's parent trace class: "
109 "%![sc-]+S, %![trace-]+t", stream_class
, trace
);
110 BT_ASSERT_PRE(stream_id_is_unique(trace
, stream_class
, id
),
111 "Duplicate stream ID: %![trace-]+t, id=%" PRIu64
, trace
, id
);
112 BT_ASSERT_PRE(!trace
->is_static
,
113 "Trace is static: %![trace-]+t", trace
);
114 BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64
,
116 stream
= g_new0(struct bt_stream
, 1);
118 BT_LOGE_STR("Failed to allocate one stream.");
122 bt_object_init_shared_with_parent(&stream
->base
, destroy_stream
);
123 stream
->name
.str
= g_string_new(NULL
);
124 if (!stream
->name
.str
) {
125 BT_LOGE_STR("Failed to allocate a GString.");
130 ret
= bt_object_pool_initialize(&stream
->packet_pool
,
131 (bt_object_pool_new_object_func
) bt_packet_new
,
132 (bt_object_pool_destroy_object_func
) bt_stream_free_packet
,
135 BT_LOGE("Failed to initialize packet pool: ret=%d", ret
);
139 stream
->class = stream_class
;
140 bt_object_get_no_null_check(stream_class
);
142 /* bt_trace_add_stream() sets the parent trace, and freezes the trace */
143 bt_trace_add_stream(trace
, stream
);
145 bt_stream_class_freeze(stream_class
);
146 BT_LIB_LOGD("Created stream object: %!+s", stream
);
150 BT_OBJECT_PUT_REF_AND_RESET(stream
);
156 struct bt_stream
*bt_stream_create(struct bt_stream_class
*stream_class
,
157 struct bt_trace
*trace
)
161 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
162 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
163 BT_ASSERT_PRE(stream_class
->assigns_automatic_stream_id
,
164 "Stream class does not automatically assigns stream IDs: "
165 "%![sc-]+S", stream_class
);
166 id
= bt_trace_get_automatic_stream_id(trace
, stream_class
);
167 return create_stream_with_id(stream_class
, trace
, id
);
170 struct bt_stream
*bt_stream_create_with_id(struct bt_stream_class
*stream_class
,
171 struct bt_trace
*trace
, uint64_t id
)
173 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
174 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
175 BT_ASSERT_PRE(!stream_class
->assigns_automatic_stream_id
,
176 "Stream class automatically assigns stream IDs: "
177 "%![sc-]+S", stream_class
);
178 return create_stream_with_id(stream_class
, trace
, id
);
181 struct bt_stream_class
*bt_stream_borrow_class(struct bt_stream
*stream
)
183 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
184 return stream
->class;
187 const struct bt_stream_class
*bt_stream_borrow_class_const(
188 const struct bt_stream
*stream
)
190 return bt_stream_borrow_class((void *) stream
);
193 struct bt_trace
*bt_stream_borrow_trace(struct bt_stream
*stream
)
195 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
196 return bt_stream_borrow_trace_inline(stream
);
199 const struct bt_trace
*bt_stream_borrow_trace_const(
200 const struct bt_stream
*stream
)
202 return bt_stream_borrow_trace((void *) stream
);
205 const char *bt_stream_get_name(const struct bt_stream
*stream
)
207 BT_ASSERT_PRE_NON_NULL(stream
, "Stream class");
208 return stream
->name
.value
;
211 int bt_stream_set_name(struct bt_stream
*stream
, const char *name
)
213 BT_ASSERT_PRE_NON_NULL(stream
, "Clock class");
214 BT_ASSERT_PRE_NON_NULL(name
, "Name");
215 BT_ASSERT_PRE_STREAM_HOT(stream
);
216 g_string_assign(stream
->name
.str
, name
);
217 stream
->name
.value
= stream
->name
.str
->str
;
218 BT_LIB_LOGV("Set stream class's name: %!+s", stream
);
222 uint64_t bt_stream_get_id(const struct bt_stream
*stream
)
224 BT_ASSERT_PRE_NON_NULL(stream
, "Stream class");
229 void _bt_stream_freeze(const struct bt_stream
*stream
)
231 /* The field classes and default clock class are already frozen */
233 BT_LIB_LOGD("Freezing stream: %!+s", stream
);
234 ((struct bt_stream
*) stream
)->frozen
= true;