2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "STREAM"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/trace-ir/stream-const.h>
30 #include <babeltrace/trace-ir/stream.h>
31 #include <babeltrace/trace-ir/stream-internal.h>
32 #include <babeltrace/trace-ir/stream-class.h>
33 #include <babeltrace/trace-ir/stream-class-internal.h>
34 #include <babeltrace/trace-ir/trace.h>
35 #include <babeltrace/trace-ir/trace-internal.h>
36 #include <babeltrace/trace-ir/packet-internal.h>
37 #include <babeltrace/object.h>
38 #include <babeltrace/compiler-internal.h>
39 #include <babeltrace/align-internal.h>
40 #include <babeltrace/assert-internal.h>
41 #include <babeltrace/property-internal.h>
45 #define BT_ASSERT_PRE_STREAM_HOT(_stream) \
46 BT_ASSERT_PRE_HOT((_stream), "Stream", ": %!+s", (_stream))
49 void destroy_stream(struct bt_object
*obj
)
51 struct bt_stream
*stream
= (void *) obj
;
53 BT_LIB_LOGD("Destroying stream object: %!+s", stream
);
55 if (stream
->name
.str
) {
56 g_string_free(stream
->name
.str
, TRUE
);
57 stream
->name
.str
= NULL
;
58 stream
->name
.value
= NULL
;
61 bt_object_pool_finalize(&stream
->packet_pool
);
66 void bt_stream_free_packet(struct bt_packet
*packet
, struct bt_stream
*stream
)
68 bt_packet_destroy(packet
);
73 bool stream_id_is_unique(struct bt_trace
*trace
,
74 struct bt_stream_class
*stream_class
, uint64_t id
)
77 bool is_unique
= true;
79 for (i
= 0; i
< trace
->streams
->len
; i
++) {
80 struct bt_stream
*stream
= trace
->streams
->pdata
[i
];
82 if (stream
->class != stream_class
) {
86 if (stream
->id
== id
) {
97 struct bt_stream
*create_stream_with_id(struct bt_stream_class
*stream_class
,
101 struct bt_stream
*stream
;
102 struct bt_trace
*trace
;
104 BT_ASSERT(stream_class
);
105 trace
= bt_stream_class_borrow_trace_inline(stream_class
);
106 BT_ASSERT_PRE(stream_id_is_unique(trace
, stream_class
, id
),
107 "Duplicate stream ID: %![trace-]+t, id=%" PRIu64
, trace
, id
);
108 BT_ASSERT_PRE(!trace
->is_static
,
109 "Trace is static: %![trace-]+t", trace
);
110 BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64
,
112 stream
= g_new0(struct bt_stream
, 1);
114 BT_LOGE_STR("Failed to allocate one stream.");
118 bt_object_init_shared_with_parent(&stream
->base
, destroy_stream
);
119 stream
->name
.str
= g_string_new(NULL
);
120 if (!stream
->name
.str
) {
121 BT_LOGE_STR("Failed to allocate a GString.");
126 ret
= bt_object_pool_initialize(&stream
->packet_pool
,
127 (bt_object_pool_new_object_func
) bt_packet_new
,
128 (bt_object_pool_destroy_object_func
) bt_stream_free_packet
,
131 BT_LOGE("Failed to initialize packet pool: ret=%d", ret
);
135 stream
->class = stream_class
;
136 bt_trace_add_stream(trace
, stream
);
137 bt_stream_class_freeze(stream_class
);
138 BT_LIB_LOGD("Created stream object: %!+s", stream
);
142 BT_OBJECT_PUT_REF_AND_RESET(stream
);
148 struct bt_stream
*bt_stream_create(struct bt_stream_class
*stream_class
)
152 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
153 BT_ASSERT_PRE(stream_class
->assigns_automatic_stream_id
,
154 "Stream class does not automatically assigns stream IDs: "
155 "%![sc-]+S", stream_class
);
156 id
= bt_trace_get_automatic_stream_id(
157 bt_stream_class_borrow_trace_inline(stream_class
),
159 return create_stream_with_id(stream_class
, id
);
162 struct bt_stream
*bt_stream_create_with_id(struct bt_stream_class
*stream_class
,
165 BT_ASSERT_PRE(!stream_class
->assigns_automatic_stream_id
,
166 "Stream class automatically assigns stream IDs: "
167 "%![sc-]+S", stream_class
);
168 return create_stream_with_id(stream_class
, id
);
171 struct bt_stream_class
*bt_stream_borrow_class(struct bt_stream
*stream
)
173 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
174 return stream
->class;
177 const struct bt_stream_class
*bt_stream_borrow_class_const(
178 const struct bt_stream
*stream
)
180 return bt_stream_borrow_class((void *) stream
);
183 const char *bt_stream_get_name(const struct bt_stream
*stream
)
185 BT_ASSERT_PRE_NON_NULL(stream
, "Stream class");
186 return stream
->name
.value
;
189 int bt_stream_set_name(struct bt_stream
*stream
, const char *name
)
191 BT_ASSERT_PRE_NON_NULL(stream
, "Clock class");
192 BT_ASSERT_PRE_NON_NULL(name
, "Name");
193 BT_ASSERT_PRE_STREAM_HOT(stream
);
194 g_string_assign(stream
->name
.str
, name
);
195 stream
->name
.value
= stream
->name
.str
->str
;
196 BT_LIB_LOGV("Set stream class's name: %!+s", stream
);
200 uint64_t bt_stream_get_id(const struct bt_stream
*stream
)
202 BT_ASSERT_PRE_NON_NULL(stream
, "Stream class");
207 void _bt_stream_freeze(const struct bt_stream
*stream
)
209 /* The field classes and default clock class are already frozen */
211 BT_LIB_LOGD("Freezing stream: %!+s", stream
);
212 ((struct bt_stream
*) stream
)->frozen
= true;