Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
e2f7325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 3 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be | 4 | * |
273b65be JG |
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: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
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 | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
350ad6c1 | 24 | #define BT_LOG_TAG "LIB/STREAM" |
c2d9d9cf | 25 | #include "lib/logging.h" |
19abc2c6 | 26 | |
578e048b | 27 | #include "lib/assert-pre.h" |
3fadfbc0 MJ |
28 | #include <babeltrace2/trace-ir/stream-const.h> |
29 | #include <babeltrace2/trace-ir/stream.h> | |
3fadfbc0 | 30 | #include <babeltrace2/trace-ir/stream-class.h> |
3fadfbc0 | 31 | #include <babeltrace2/trace-ir/trace.h> |
578e048b MJ |
32 | #include "compat/compiler.h" |
33 | #include "common/align.h" | |
34 | #include "common/assert.h" | |
35 | #include "lib/property.h" | |
3dca2276 PP |
36 | #include <inttypes.h> |
37 | #include <unistd.h> | |
12c8a1a3 | 38 | |
578e048b MJ |
39 | #include "packet.h" |
40 | #include "stream-class.h" | |
41 | #include "stream.h" | |
42 | #include "trace.h" | |
43 | ||
44c440bc PP |
44 | #define BT_ASSERT_PRE_STREAM_HOT(_stream) \ |
45 | BT_ASSERT_PRE_HOT((_stream), "Stream", ": %!+s", (_stream)) | |
263a7df5 | 46 | |
c9af50d1 | 47 | static |
44c440bc | 48 | void destroy_stream(struct bt_object *obj) |
c9af50d1 | 49 | { |
3dca2276 | 50 | struct bt_stream *stream = (void *) obj; |
c9af50d1 | 51 | |
44c440bc PP |
52 | BT_LIB_LOGD("Destroying stream object: %!+s", stream); |
53 | ||
54 | if (stream->name.str) { | |
55 | g_string_free(stream->name.str, TRUE); | |
238b7404 PP |
56 | stream->name.str = NULL; |
57 | stream->name.value = NULL; | |
44c440bc PP |
58 | } |
59 | ||
862ca4ed PP |
60 | BT_LOGD_STR("Putting stream's class."); |
61 | bt_object_put_ref(stream->class); | |
312c056a | 62 | bt_object_pool_finalize(&stream->packet_pool); |
3dca2276 | 63 | g_free(stream); |
c9af50d1 JG |
64 | } |
65 | ||
44c440bc PP |
66 | static |
67 | void bt_stream_free_packet(struct bt_packet *packet, struct bt_stream *stream) | |
273b65be | 68 | { |
44c440bc PP |
69 | bt_packet_destroy(packet); |
70 | } | |
19abc2c6 | 71 | |
44c440bc PP |
72 | BT_ASSERT_PRE_FUNC |
73 | static inline | |
74 | bool stream_id_is_unique(struct bt_trace *trace, | |
75 | struct bt_stream_class *stream_class, uint64_t id) | |
76 | { | |
77 | uint64_t i; | |
78 | bool is_unique = true; | |
273b65be | 79 | |
44c440bc PP |
80 | for (i = 0; i < trace->streams->len; i++) { |
81 | struct bt_stream *stream = trace->streams->pdata[i]; | |
273b65be | 82 | |
44c440bc PP |
83 | if (stream->class != stream_class) { |
84 | continue; | |
8bfa3f9c | 85 | } |
1c1d572f | 86 | |
44c440bc PP |
87 | if (stream->id == id) { |
88 | is_unique = false; | |
89 | goto end; | |
98edd02c | 90 | } |
273b65be JG |
91 | } |
92 | ||
3dca2276 | 93 | end: |
44c440bc | 94 | return is_unique; |
312c056a PP |
95 | } |
96 | ||
273b65be | 97 | static |
44c440bc | 98 | struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class, |
862ca4ed | 99 | struct bt_trace *trace, uint64_t id) |
273b65be | 100 | { |
3dca2276 | 101 | int ret; |
44c440bc | 102 | struct bt_stream *stream; |
44c440bc PP |
103 | |
104 | BT_ASSERT(stream_class); | |
862ca4ed PP |
105 | BT_ASSERT(trace); |
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); | |
44c440bc PP |
110 | BT_ASSERT_PRE(stream_id_is_unique(trace, stream_class, id), |
111 | "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id); | |
44c440bc PP |
112 | BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64, |
113 | trace, id); | |
3dca2276 PP |
114 | stream = g_new0(struct bt_stream, 1); |
115 | if (!stream) { | |
116 | BT_LOGE_STR("Failed to allocate one stream."); | |
117 | goto error; | |
12c8a1a3 | 118 | } |
b71d7298 | 119 | |
44c440bc PP |
120 | bt_object_init_shared_with_parent(&stream->base, destroy_stream); |
121 | stream->name.str = g_string_new(NULL); | |
122 | if (!stream->name.str) { | |
123 | BT_LOGE_STR("Failed to allocate a GString."); | |
3dca2276 | 124 | goto error; |
b71d7298 | 125 | } |
41ac640a | 126 | |
44c440bc | 127 | stream->id = id; |
312c056a PP |
128 | ret = bt_object_pool_initialize(&stream->packet_pool, |
129 | (bt_object_pool_new_object_func) bt_packet_new, | |
130 | (bt_object_pool_destroy_object_func) bt_stream_free_packet, | |
131 | stream); | |
132 | if (ret) { | |
133 | BT_LOGE("Failed to initialize packet pool: ret=%d", ret); | |
134 | goto error; | |
135 | } | |
136 | ||
44c440bc | 137 | stream->class = stream_class; |
862ca4ed PP |
138 | bt_object_get_no_null_check(stream_class); |
139 | ||
140 | /* bt_trace_add_stream() sets the parent trace, and freezes the trace */ | |
44c440bc | 141 | bt_trace_add_stream(trace, stream); |
862ca4ed | 142 | |
44c440bc PP |
143 | bt_stream_class_freeze(stream_class); |
144 | BT_LIB_LOGD("Created stream object: %!+s", stream); | |
3dca2276 | 145 | goto end; |
3230ee6b | 146 | |
3dca2276 | 147 | error: |
65300d60 | 148 | BT_OBJECT_PUT_REF_AND_RESET(stream); |
3dca2276 PP |
149 | |
150 | end: | |
151 | return stream; | |
273b65be JG |
152 | } |
153 | ||
862ca4ed PP |
154 | struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class, |
155 | struct bt_trace *trace) | |
273b65be | 156 | { |
44c440bc PP |
157 | uint64_t id; |
158 | ||
159 | BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class"); | |
862ca4ed | 160 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
44c440bc PP |
161 | BT_ASSERT_PRE(stream_class->assigns_automatic_stream_id, |
162 | "Stream class does not automatically assigns stream IDs: " | |
163 | "%![sc-]+S", stream_class); | |
862ca4ed PP |
164 | id = bt_trace_get_automatic_stream_id(trace, stream_class); |
165 | return create_stream_with_id(stream_class, trace, id); | |
44c440bc | 166 | } |
d7b1ea66 | 167 | |
40f4ba76 | 168 | struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class, |
862ca4ed | 169 | struct bt_trace *trace, uint64_t id) |
44c440bc | 170 | { |
862ca4ed PP |
171 | BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class"); |
172 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); | |
44c440bc PP |
173 | BT_ASSERT_PRE(!stream_class->assigns_automatic_stream_id, |
174 | "Stream class automatically assigns stream IDs: " | |
175 | "%![sc-]+S", stream_class); | |
862ca4ed | 176 | return create_stream_with_id(stream_class, trace, id); |
273b65be | 177 | } |
b71d7298 | 178 | |
094ff7c0 | 179 | struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream) |
af9296f3 | 180 | { |
44c440bc PP |
181 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); |
182 | return stream->class; | |
af9296f3 JG |
183 | } |
184 | ||
40f4ba76 PP |
185 | const struct bt_stream_class *bt_stream_borrow_class_const( |
186 | const struct bt_stream *stream) | |
e5be10ef | 187 | { |
40f4ba76 | 188 | return bt_stream_borrow_class((void *) stream); |
e5be10ef PP |
189 | } |
190 | ||
862ca4ed PP |
191 | struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream) |
192 | { | |
193 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); | |
194 | return bt_stream_borrow_trace_inline(stream); | |
195 | } | |
196 | ||
197 | const struct bt_trace *bt_stream_borrow_trace_const( | |
198 | const struct bt_stream *stream) | |
199 | { | |
200 | return bt_stream_borrow_trace((void *) stream); | |
201 | } | |
202 | ||
40f4ba76 | 203 | const char *bt_stream_get_name(const struct bt_stream *stream) |
b71d7298 | 204 | { |
28ee7eed | 205 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); |
44c440bc | 206 | return stream->name.value; |
b71d7298 | 207 | } |
98a4cbef | 208 | |
3dcff82b PP |
209 | enum bt_stream_status bt_stream_set_name(struct bt_stream *stream, |
210 | const char *name) | |
98a4cbef | 211 | { |
28ee7eed | 212 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); |
44c440bc PP |
213 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
214 | BT_ASSERT_PRE_STREAM_HOT(stream); | |
215 | g_string_assign(stream->name.str, name); | |
216 | stream->name.value = stream->name.str->str; | |
3f7d4d90 | 217 | BT_LIB_LOGD("Set stream's name: %!+s", stream); |
3dcff82b | 218 | return BT_STREAM_STATUS_OK; |
44c440bc | 219 | } |
cb6f1f7d | 220 | |
40f4ba76 | 221 | uint64_t bt_stream_get_id(const struct bt_stream *stream) |
44c440bc PP |
222 | { |
223 | BT_ASSERT_PRE_NON_NULL(stream, "Stream class"); | |
224 | return stream->id; | |
225 | } | |
cb6f1f7d | 226 | |
44c440bc | 227 | BT_HIDDEN |
40f4ba76 | 228 | void _bt_stream_freeze(const struct bt_stream *stream) |
44c440bc | 229 | { |
44c440bc PP |
230 | BT_ASSERT(stream); |
231 | BT_LIB_LOGD("Freezing stream: %!+s", stream); | |
40f4ba76 | 232 | ((struct bt_stream *) stream)->frozen = true; |
98a4cbef | 233 | } |
c5b9b441 PP |
234 | |
235 | void bt_stream_get_ref(const struct bt_stream *stream) | |
236 | { | |
237 | bt_object_get_ref(stream); | |
238 | } | |
239 | ||
240 | void bt_stream_put_ref(const struct bt_stream *stream) | |
241 | { | |
242 | bt_object_put_ref(stream); | |
243 | } |