Commit | Line | Data |
---|---|---|
273b65be JG |
1 | /* |
2 | * stream.c | |
3 | * | |
d2dc44b6 | 4 | * Babeltrace CTF IR - Stream |
273b65be | 5 | * |
de9dd397 | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
7 | * |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
19abc2c6 PP |
29 | #define BT_LOG_TAG "STREAM" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
ac0c6bdd PP |
32 | #include <babeltrace/ctf-ir/clock-class.h> |
33 | #include <babeltrace/ctf-writer/clock.h> | |
34 | #include <babeltrace/ctf-writer/clock-internal.h> | |
273b65be | 35 | #include <babeltrace/ctf-writer/event.h> |
adc315b8 | 36 | #include <babeltrace/ctf-ir/event-internal.h> |
2e33ac5a PP |
37 | #include <babeltrace/ctf-ir/field-types-internal.h> |
38 | #include <babeltrace/ctf-ir/fields-internal.h> | |
3f043b05 JG |
39 | #include <babeltrace/ctf-ir/stream.h> |
40 | #include <babeltrace/ctf-ir/stream-internal.h> | |
adc315b8 | 41 | #include <babeltrace/ctf-ir/stream-class-internal.h> |
5acf2ae6 | 42 | #include <babeltrace/ctf-ir/trace.h> |
319fd969 PP |
43 | #include <babeltrace/ctf-ir/trace-internal.h> |
44 | #include <babeltrace/ctf-writer/writer-internal.h> | |
3230ee6b | 45 | #include <babeltrace/graph/component-internal.h> |
83509119 | 46 | #include <babeltrace/ref.h> |
273b65be | 47 | #include <babeltrace/ctf-writer/functor-internal.h> |
3d9990ac PP |
48 | #include <babeltrace/compiler-internal.h> |
49 | #include <babeltrace/align-internal.h> | |
dc3fffef | 50 | #include <inttypes.h> |
95076212 | 51 | #include <unistd.h> |
273b65be JG |
52 | |
53 | static | |
50842bdc | 54 | void bt_stream_destroy(struct bt_object *obj); |
273b65be | 55 | static |
50842bdc | 56 | int try_set_structure_field_integer(struct bt_field *, char *, uint64_t); |
273b65be | 57 | |
ac0c6bdd | 58 | static |
50842bdc | 59 | int set_integer_field_value(struct bt_field* field, uint64_t value) |
ac0c6bdd PP |
60 | { |
61 | int ret = 0; | |
50842bdc | 62 | struct bt_field_type *field_type = NULL; |
ac0c6bdd PP |
63 | |
64 | if (!field) { | |
19abc2c6 | 65 | BT_LOGW_STR("Invalid parameter: field is NULL."); |
ac0c6bdd PP |
66 | ret = -1; |
67 | goto end; | |
68 | } | |
69 | ||
50842bdc | 70 | field_type = bt_field_get_type(field); |
ac0c6bdd PP |
71 | assert(field_type); |
72 | ||
50842bdc PP |
73 | if (bt_field_type_get_type_id(field_type) != |
74 | BT_FIELD_TYPE_ID_INTEGER) { | |
ac0c6bdd | 75 | /* Not an integer and the value is unset, error. */ |
19abc2c6 PP |
76 | BT_LOGW("Invalid parameter: field's type is not an integer field type: " |
77 | "field-addr=%p, ft-addr=%p, ft-id=%s", | |
78 | field, field_type, | |
50842bdc | 79 | bt_field_type_id_string(field_type->id)); |
ac0c6bdd PP |
80 | ret = -1; |
81 | goto end; | |
82 | } | |
83 | ||
50842bdc PP |
84 | if (bt_field_type_integer_is_signed(field_type)) { |
85 | ret = bt_field_signed_integer_set_value(field, (int64_t) value); | |
ac0c6bdd PP |
86 | if (ret) { |
87 | /* Value is out of range, error. */ | |
19abc2c6 PP |
88 | BT_LOGW("Cannot set signed integer field's value: " |
89 | "addr=%p, value=%" PRId64, | |
90 | field, (int64_t) value); | |
ac0c6bdd PP |
91 | goto end; |
92 | } | |
93 | } else { | |
50842bdc | 94 | ret = bt_field_unsigned_integer_set_value(field, value); |
ac0c6bdd PP |
95 | if (ret) { |
96 | /* Value is out of range, error. */ | |
19abc2c6 PP |
97 | BT_LOGW("Cannot set unsigned integer field's value: " |
98 | "addr=%p, value=%" PRIu64, | |
99 | field, value); | |
ac0c6bdd PP |
100 | goto end; |
101 | } | |
102 | } | |
103 | end: | |
104 | bt_put(field_type); | |
105 | return ret; | |
106 | } | |
107 | ||
d246b111 | 108 | static |
50842bdc | 109 | int set_packet_header_magic(struct bt_stream *stream) |
d246b111 JG |
110 | { |
111 | int ret = 0; | |
50842bdc | 112 | struct bt_field *magic_field = bt_field_structure_get_field_by_name( |
d246b111 | 113 | stream->packet_header, "magic"); |
19abc2c6 PP |
114 | const uint32_t magic_value = 0xc1fc1fc1; |
115 | ||
116 | assert(stream); | |
d246b111 JG |
117 | |
118 | if (!magic_field) { | |
119 | /* No magic field found. Not an error, skip. */ | |
19abc2c6 PP |
120 | BT_LOGV("No field named `magic` in packet header: skipping: " |
121 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 122 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
123 | goto end; |
124 | } | |
125 | ||
50842bdc | 126 | ret = bt_field_unsigned_integer_set_value(magic_field, |
b3376dd9 | 127 | (uint64_t) magic_value); |
d246b111 | 128 | |
d246b111 | 129 | if (ret) { |
b3376dd9 PP |
130 | BT_LOGW("Cannot set packet header field's `magic` integer field's value: " |
131 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 132 | stream, bt_stream_get_name(stream), |
19abc2c6 PP |
133 | magic_field, (uint64_t) magic_value); |
134 | } else { | |
135 | BT_LOGV("Set packet header field's `magic` field's value: " | |
b3376dd9 | 136 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
50842bdc | 137 | stream, bt_stream_get_name(stream), |
19abc2c6 | 138 | magic_field, (uint64_t) magic_value); |
d246b111 JG |
139 | } |
140 | end: | |
83509119 | 141 | bt_put(magic_field); |
d246b111 JG |
142 | return ret; |
143 | } | |
144 | ||
145 | static | |
50842bdc | 146 | int set_packet_header_uuid(struct bt_stream *stream) |
d246b111 | 147 | { |
19abc2c6 PP |
148 | int ret = 0; |
149 | int64_t i; | |
50842bdc PP |
150 | struct bt_trace *trace = NULL; |
151 | struct bt_field *uuid_field = bt_field_structure_get_field_by_name( | |
d246b111 JG |
152 | stream->packet_header, "uuid"); |
153 | ||
19abc2c6 PP |
154 | assert(stream); |
155 | ||
d246b111 JG |
156 | if (!uuid_field) { |
157 | /* No uuid field found. Not an error, skip. */ | |
19abc2c6 PP |
158 | BT_LOGV("No field named `uuid` in packet header: skipping: " |
159 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 160 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
161 | goto end; |
162 | } | |
163 | ||
50842bdc | 164 | trace = (struct bt_trace *) bt_object_get_parent(stream); |
d246b111 | 165 | for (i = 0; i < 16; i++) { |
50842bdc PP |
166 | struct bt_field *uuid_element = |
167 | bt_field_array_get_field(uuid_field, i); | |
d246b111 | 168 | |
50842bdc | 169 | ret = bt_field_unsigned_integer_set_value( |
b3376dd9 | 170 | uuid_element, (uint64_t) trace->uuid[i]); |
83509119 | 171 | bt_put(uuid_element); |
d246b111 | 172 | if (ret) { |
19abc2c6 PP |
173 | BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): " |
174 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " | |
b3376dd9 | 175 | "value=%" PRIu64 ", index=%" PRId64, |
50842bdc | 176 | stream, bt_stream_get_name(stream), |
19abc2c6 | 177 | uuid_element, (uint64_t) trace->uuid[i], i); |
d246b111 JG |
178 | goto end; |
179 | } | |
180 | } | |
181 | ||
19abc2c6 PP |
182 | BT_LOGV("Set packet header field's `uuid` field's value: " |
183 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p", | |
50842bdc | 184 | stream, bt_stream_get_name(stream), uuid_field); |
19abc2c6 | 185 | |
d246b111 | 186 | end: |
83509119 | 187 | bt_put(uuid_field); |
e6a8e8e4 | 188 | BT_PUT(trace); |
d246b111 JG |
189 | return ret; |
190 | } | |
191 | static | |
50842bdc | 192 | int set_packet_header_stream_id(struct bt_stream *stream) |
d246b111 JG |
193 | { |
194 | int ret = 0; | |
195 | uint32_t stream_id; | |
50842bdc | 196 | struct bt_field *stream_id_field = bt_field_structure_get_field_by_name( |
d246b111 JG |
197 | stream->packet_header, "stream_id"); |
198 | ||
199 | if (!stream_id_field) { | |
200 | /* No stream_id field found. Not an error, skip. */ | |
19abc2c6 PP |
201 | BT_LOGV("No field named `stream_id` in packet header: skipping: " |
202 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 203 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
204 | goto end; |
205 | } | |
206 | ||
b3376dd9 | 207 | stream_id = stream->stream_class->id; |
50842bdc | 208 | ret = bt_field_unsigned_integer_set_value(stream_id_field, |
b3376dd9 PP |
209 | (uint64_t) stream_id); |
210 | if (ret) { | |
211 | BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: " | |
212 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 213 | stream, bt_stream_get_name(stream), |
b3376dd9 PP |
214 | stream_id_field, (uint64_t) stream_id); |
215 | } else { | |
216 | BT_LOGV("Set packet header field's `stream_id` field's value: " | |
217 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 218 | stream, bt_stream_get_name(stream), |
b3376dd9 PP |
219 | stream_id_field, (uint64_t) stream_id); |
220 | } | |
221 | ||
222 | end: | |
223 | bt_put(stream_id_field); | |
224 | return ret; | |
225 | } | |
226 | ||
227 | static | |
50842bdc | 228 | int auto_populate_packet_header(struct bt_stream *stream) |
b3376dd9 PP |
229 | { |
230 | int ret = 0; | |
231 | ||
232 | if (!stream->packet_header) { | |
233 | goto end; | |
234 | } | |
235 | ||
236 | ret = set_packet_header_magic(stream); | |
237 | if (ret) { | |
238 | BT_LOGW("Cannot set packet header's magic number field: " | |
239 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 240 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
241 | goto end; |
242 | } | |
243 | ||
244 | ret = set_packet_header_uuid(stream); | |
245 | if (ret) { | |
246 | BT_LOGW("Cannot set packet header's UUID field: " | |
19abc2c6 | 247 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 248 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
249 | goto end; |
250 | } | |
251 | ||
b3376dd9 PP |
252 | ret = set_packet_header_stream_id(stream); |
253 | if (ret) { | |
254 | BT_LOGW("Cannot set packet header's stream class ID field: " | |
255 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 256 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
257 | goto end; |
258 | } | |
259 | ||
b3376dd9 PP |
260 | BT_LOGV("Automatically populated stream's packet header's known fields: " |
261 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 262 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
263 | |
264 | end: | |
265 | return ret; | |
266 | } | |
267 | ||
268 | static | |
50842bdc | 269 | int set_packet_context_packet_size(struct bt_stream *stream) |
b3376dd9 PP |
270 | { |
271 | int ret = 0; | |
50842bdc | 272 | struct bt_field *field = bt_field_structure_get_field_by_name( |
b3376dd9 PP |
273 | stream->packet_context, "packet_size"); |
274 | ||
275 | assert(stream); | |
276 | ||
277 | if (!field) { | |
278 | /* No packet size field found. Not an error, skip. */ | |
279 | BT_LOGV("No field named `packet_size` in packet context: skipping: " | |
280 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 281 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
282 | goto end; |
283 | } | |
284 | ||
50842bdc | 285 | ret = bt_field_unsigned_integer_set_value(field, |
b3376dd9 | 286 | stream->pos.packet_size); |
d246b111 | 287 | if (ret) { |
b3376dd9 PP |
288 | BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: " |
289 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 290 | stream, bt_stream_get_name(stream), |
b3376dd9 | 291 | field, stream->pos.packet_size); |
d246b111 | 292 | } else { |
b3376dd9 PP |
293 | BT_LOGV("Set packet context field's `packet_size` field's value: " |
294 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 295 | stream, bt_stream_get_name(stream), |
b3376dd9 | 296 | field, stream->pos.packet_size); |
d246b111 | 297 | } |
19abc2c6 | 298 | |
b3376dd9 PP |
299 | end: |
300 | bt_put(field); | |
301 | return ret; | |
302 | } | |
303 | ||
304 | static | |
50842bdc | 305 | int set_packet_context_content_size(struct bt_stream *stream) |
b3376dd9 PP |
306 | { |
307 | int ret = 0; | |
50842bdc | 308 | struct bt_field *field = bt_field_structure_get_field_by_name( |
b3376dd9 PP |
309 | stream->packet_context, "content_size"); |
310 | ||
311 | assert(stream); | |
312 | ||
313 | if (!field) { | |
314 | /* No content size field found. Not an error, skip. */ | |
315 | BT_LOGV("No field named `content_size` in packet context: skipping: " | |
316 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 317 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
318 | goto end; |
319 | } | |
320 | ||
50842bdc | 321 | ret = bt_field_unsigned_integer_set_value(field, |
b3376dd9 | 322 | stream->pos.offset); |
19abc2c6 | 323 | if (ret) { |
b3376dd9 PP |
324 | BT_LOGW("Cannot set packet context field's `content_size` integer field's value: " |
325 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64, | |
50842bdc | 326 | stream, bt_stream_get_name(stream), |
b3376dd9 | 327 | field, stream->pos.offset); |
19abc2c6 | 328 | } else { |
b3376dd9 PP |
329 | BT_LOGV("Set packet context field's `content_size` field's value: " |
330 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64, | |
50842bdc | 331 | stream, bt_stream_get_name(stream), |
b3376dd9 | 332 | field, stream->pos.offset); |
19abc2c6 PP |
333 | } |
334 | ||
d246b111 | 335 | end: |
b3376dd9 | 336 | bt_put(field); |
d246b111 JG |
337 | return ret; |
338 | } | |
339 | ||
340 | static | |
50842bdc | 341 | int set_packet_context_events_discarded(struct bt_stream *stream) |
d246b111 | 342 | { |
b3376dd9 | 343 | int ret = 0; |
50842bdc | 344 | struct bt_field *field = bt_field_structure_get_field_by_name( |
b3376dd9 | 345 | stream->packet_context, "events_discarded"); |
d246b111 | 346 | |
b3376dd9 PP |
347 | assert(stream); |
348 | ||
349 | if (!field) { | |
350 | /* No discarded events count field found. Not an error, skip. */ | |
351 | BT_LOGV("No field named `events_discarded` in packet context: skipping: " | |
352 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 353 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
354 | goto end; |
355 | } | |
356 | ||
59a09b0e PP |
357 | /* |
358 | * If the field is set by the user, make sure that the value is | |
359 | * greater than or equal to the stream's current count of | |
360 | * discarded events. We do not allow wrapping here. If it's | |
361 | * valid, update the stream's current count. | |
362 | */ | |
50842bdc | 363 | if (bt_field_is_set(field)) { |
59a09b0e PP |
364 | uint64_t user_val; |
365 | ||
50842bdc | 366 | ret = bt_field_unsigned_integer_get_value(field, |
59a09b0e PP |
367 | &user_val); |
368 | if (ret) { | |
369 | BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: " | |
370 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p", | |
50842bdc | 371 | stream, bt_stream_get_name(stream), field); |
59a09b0e PP |
372 | goto end; |
373 | } | |
374 | ||
375 | if (user_val < stream->discarded_events) { | |
376 | BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: " | |
377 | "value is lesser than the stream's current discarded events count: " | |
378 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " | |
379 | "value=%" PRIu64 ", " | |
380 | "stream-discarded-events-count=%" PRIu64, | |
50842bdc | 381 | stream, bt_stream_get_name(stream), field, |
59a09b0e PP |
382 | user_val, stream->discarded_events); |
383 | goto end; | |
384 | } | |
385 | ||
386 | stream->discarded_events = user_val; | |
b3376dd9 | 387 | } else { |
50842bdc | 388 | ret = bt_field_unsigned_integer_set_value(field, |
59a09b0e PP |
389 | stream->discarded_events); |
390 | if (ret) { | |
391 | BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: " | |
392 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 393 | stream, bt_stream_get_name(stream), |
59a09b0e PP |
394 | field, stream->discarded_events); |
395 | } else { | |
396 | BT_LOGV("Set packet context field's `events_discarded` field's value: " | |
397 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 398 | stream, bt_stream_get_name(stream), |
59a09b0e PP |
399 | field, stream->discarded_events); |
400 | } | |
b3376dd9 PP |
401 | } |
402 | ||
403 | end: | |
404 | bt_put(field); | |
405 | return ret; | |
406 | } | |
407 | ||
408 | static | |
50842bdc PP |
409 | int get_event_header_timestamp(struct bt_stream *stream, |
410 | struct bt_field *event_header, uint64_t *timestamp) | |
b3376dd9 PP |
411 | { |
412 | int ret = 0; | |
50842bdc PP |
413 | struct bt_field *timestamp_field = NULL; |
414 | struct bt_clock_class *ts_field_mapped_clock_class = NULL; | |
b3376dd9 PP |
415 | |
416 | *timestamp = 0; | |
417 | ||
418 | if (!event_header) { | |
419 | BT_LOGV_STR("Event header does not exist."); | |
420 | goto end; | |
421 | } | |
422 | ||
50842bdc | 423 | timestamp_field = bt_field_structure_get_field_by_name(event_header, |
b3376dd9 PP |
424 | "timestamp"); |
425 | if (!timestamp_field) { | |
426 | BT_LOGV("Cannot get event header's `timestamp` field: " | |
427 | "event-header-field-addr=%p", event_header); | |
428 | goto end; | |
429 | } | |
430 | ||
50842bdc | 431 | if (!bt_field_type_is_integer(timestamp_field->type)) { |
b3376dd9 PP |
432 | BT_LOGV("Event header's `timestamp` field's type is not an integer field type: " |
433 | "event-header-field-addr=%p", event_header); | |
434 | goto end; | |
435 | } | |
436 | ||
437 | ts_field_mapped_clock_class = | |
50842bdc | 438 | bt_field_type_integer_get_mapped_clock_class( |
b3376dd9 PP |
439 | timestamp_field->type); |
440 | if (!ts_field_mapped_clock_class) { | |
441 | BT_LOGV("Event header's `timestamp` field's type is not mapped to a clock class: " | |
442 | "event-header-field-addr=%p", event_header); | |
443 | goto end; | |
444 | } | |
445 | ||
446 | if (ts_field_mapped_clock_class != | |
447 | stream->stream_class->clock->clock_class) { | |
448 | BT_LOGV("Event header's `timestamp` field's type is not mapped to the stream's clock's class: " | |
449 | "event-header-field-addr=%p", event_header); | |
450 | goto end; | |
451 | } | |
452 | ||
50842bdc | 453 | ret = bt_field_unsigned_integer_get_value(timestamp_field, |
b3376dd9 PP |
454 | timestamp); |
455 | if (ret) { | |
456 | BT_LOGW("Cannot get unsigned integer field's value: " | |
457 | "event-header-field-addr=%p, " | |
458 | "timestamp-field-addr=%p", | |
459 | event_header, timestamp_field); | |
460 | goto end; | |
461 | } | |
462 | ||
463 | end: | |
464 | bt_put(timestamp_field); | |
465 | bt_put(ts_field_mapped_clock_class); | |
466 | return ret; | |
467 | } | |
468 | ||
469 | static | |
50842bdc PP |
470 | int set_packet_context_timestamp_field(struct bt_stream *stream, |
471 | const char *field_name, struct bt_event *event) | |
b3376dd9 PP |
472 | { |
473 | int ret = 0; | |
50842bdc | 474 | struct bt_field *field = bt_field_structure_get_field_by_name( |
b3376dd9 | 475 | stream->packet_context, field_name); |
50842bdc | 476 | struct bt_clock_class *field_mapped_clock_class = NULL; |
b3376dd9 PP |
477 | uint64_t ts; |
478 | ||
479 | assert(stream); | |
480 | ||
481 | if (!field) { | |
482 | /* No beginning timestamp field found. Not an error, skip. */ | |
483 | BT_LOGV("No field named `%s` in packet context: skipping: " | |
484 | "stream-addr=%p, stream-name=\"%s\"", field_name, | |
50842bdc | 485 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
486 | goto end; |
487 | } | |
488 | ||
489 | if (!stream->stream_class->clock) { | |
490 | BT_LOGV("Stream has no clock: skipping: " | |
19abc2c6 | 491 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 492 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
493 | goto end; |
494 | } | |
495 | ||
b3376dd9 | 496 | field_mapped_clock_class = |
50842bdc | 497 | bt_field_type_integer_get_mapped_clock_class(field->type); |
9f1bc157 | 498 | if (field_mapped_clock_class && field_mapped_clock_class != |
b3376dd9 PP |
499 | stream->stream_class->clock->clock_class) { |
500 | BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: " | |
501 | "stream-addr=%p, stream-name=\"%s\", " | |
502 | "field-addr=%p, ft-addr=%p, " | |
503 | "ft-mapped-clock-class-addr=%p, " | |
504 | "ft-mapped-clock-class-name=\"%s\", " | |
505 | "stream-clock-class-addr=%p, " | |
506 | "stream-clock-class-name=\"%s\"", | |
507 | field_name, | |
50842bdc | 508 | stream, bt_stream_get_name(stream), |
b3376dd9 PP |
509 | field, field->type, |
510 | field_mapped_clock_class, | |
50842bdc | 511 | bt_clock_class_get_name(field_mapped_clock_class), |
b3376dd9 | 512 | stream->stream_class->clock->clock_class, |
50842bdc | 513 | bt_clock_class_get_name( |
b3376dd9 PP |
514 | stream->stream_class->clock->clock_class)); |
515 | goto end; | |
516 | } | |
517 | ||
518 | if (get_event_header_timestamp(stream, event->event_header, &ts)) { | |
519 | BT_LOGW("Cannot get event's timestamp: " | |
520 | "event-header-field-addr=%p", | |
521 | event->event_header); | |
522 | ret = -1; | |
523 | goto end; | |
524 | } | |
525 | ||
50842bdc | 526 | ret = bt_field_unsigned_integer_set_value(field, ts); |
d246b111 | 527 | if (ret) { |
b3376dd9 PP |
528 | BT_LOGW("Cannot set packet context field's `%s` integer field's value: " |
529 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 530 | field_name, stream, bt_stream_get_name(stream), |
b3376dd9 PP |
531 | field, stream->discarded_events); |
532 | } else { | |
533 | BT_LOGV("Set packet context field's `%s` field's value: " | |
534 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
50842bdc | 535 | field_name, stream, bt_stream_get_name(stream), |
b3376dd9 PP |
536 | field, stream->discarded_events); |
537 | } | |
538 | ||
539 | end: | |
540 | bt_put(field); | |
541 | bt_put(field_mapped_clock_class); | |
542 | return ret; | |
543 | } | |
544 | ||
545 | static | |
50842bdc | 546 | int set_packet_context_timestamp_begin(struct bt_stream *stream) |
b3376dd9 PP |
547 | { |
548 | int ret = 0; | |
549 | ||
550 | if (stream->events->len == 0) { | |
551 | BT_LOGV("Current packet contains no events: skipping: " | |
19abc2c6 | 552 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 553 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
554 | goto end; |
555 | } | |
556 | ||
b3376dd9 PP |
557 | ret = set_packet_context_timestamp_field(stream, "timestamp_begin", |
558 | g_ptr_array_index(stream->events, 0)); | |
559 | ||
560 | end: | |
561 | return ret; | |
562 | } | |
563 | ||
564 | static | |
50842bdc | 565 | int set_packet_context_timestamp_end(struct bt_stream *stream) |
b3376dd9 PP |
566 | { |
567 | int ret = 0; | |
568 | ||
569 | if (stream->events->len == 0) { | |
570 | BT_LOGV("Current packet contains no events: skipping: " | |
571 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 572 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
573 | goto end; |
574 | } | |
575 | ||
576 | ret = set_packet_context_timestamp_field(stream, "timestamp_end", | |
577 | g_ptr_array_index(stream->events, stream->events->len - 1)); | |
578 | ||
579 | end: | |
580 | return ret; | |
581 | } | |
582 | ||
583 | static | |
50842bdc | 584 | int auto_populate_packet_context(struct bt_stream *stream) |
b3376dd9 PP |
585 | { |
586 | int ret = 0; | |
587 | ||
588 | if (!stream->packet_context) { | |
589 | goto end; | |
590 | } | |
591 | ||
592 | ret = set_packet_context_packet_size(stream); | |
d246b111 | 593 | if (ret) { |
b3376dd9 PP |
594 | BT_LOGW("Cannot set packet context's packet size field: " |
595 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 596 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
597 | goto end; |
598 | } | |
599 | ||
600 | ret = set_packet_context_content_size(stream); | |
601 | if (ret) { | |
602 | BT_LOGW("Cannot set packet context's content size field: " | |
19abc2c6 | 603 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 604 | stream, bt_stream_get_name(stream)); |
d246b111 JG |
605 | goto end; |
606 | } | |
19abc2c6 | 607 | |
b3376dd9 PP |
608 | ret = set_packet_context_timestamp_begin(stream); |
609 | if (ret) { | |
610 | BT_LOGW("Cannot set packet context's beginning timestamp field: " | |
611 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 612 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
613 | goto end; |
614 | } | |
615 | ||
616 | ret = set_packet_context_timestamp_end(stream); | |
617 | if (ret) { | |
618 | BT_LOGW("Cannot set packet context's end timestamp field: " | |
619 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 620 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
621 | goto end; |
622 | } | |
623 | ||
624 | ret = set_packet_context_events_discarded(stream); | |
625 | if (ret) { | |
626 | BT_LOGW("Cannot set packet context's discarded events count field: " | |
627 | "stream-addr=%p, stream-name=\"%s\"", | |
50842bdc | 628 | stream, bt_stream_get_name(stream)); |
b3376dd9 PP |
629 | goto end; |
630 | } | |
631 | ||
632 | BT_LOGV("Automatically populated stream's packet context's known fields: " | |
19abc2c6 | 633 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 634 | stream, bt_stream_get_name(stream)); |
19abc2c6 | 635 | |
d246b111 JG |
636 | end: |
637 | return ret; | |
638 | } | |
639 | ||
123fbdec | 640 | static |
50842bdc | 641 | void release_event(struct bt_event *event) |
123fbdec | 642 | { |
e6a8e8e4 JG |
643 | if (bt_object_get_ref_count(event)) { |
644 | /* | |
645 | * The event is being orphaned, but it must guarantee the | |
646 | * existence of its event class for the duration of its | |
647 | * lifetime. | |
648 | */ | |
649 | bt_get(event->event_class); | |
650 | BT_PUT(event->base.parent); | |
651 | } else { | |
652 | bt_object_release(event); | |
653 | } | |
123fbdec JG |
654 | } |
655 | ||
319fd969 PP |
656 | static |
657 | int create_stream_file(struct bt_ctf_writer *writer, | |
50842bdc | 658 | struct bt_stream *stream) |
319fd969 PP |
659 | { |
660 | int fd; | |
ab22d18f PP |
661 | GString *filename = g_string_new(NULL); |
662 | int64_t stream_class_id; | |
663 | char *file_path = NULL; | |
319fd969 | 664 | |
19abc2c6 PP |
665 | BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, " |
666 | "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"", | |
50842bdc | 667 | writer, stream, bt_stream_get_name(stream), |
19abc2c6 PP |
668 | stream->stream_class, stream->stream_class->name->str); |
669 | ||
ab22d18f PP |
670 | if (stream->name && stream->name->len > 0) { |
671 | /* Use stream name's base name as prefix */ | |
672 | gchar *basename = g_path_get_basename(stream->name->str); | |
673 | ||
674 | assert(basename); | |
675 | ||
676 | if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { | |
677 | g_string_assign(filename, "stream"); | |
678 | } else { | |
679 | g_string_assign(filename, basename); | |
680 | } | |
681 | ||
682 | g_free(basename); | |
683 | goto append_ids; | |
684 | } | |
685 | ||
686 | if (stream->stream_class->name && | |
687 | stream->stream_class->name->len > 0) { | |
688 | /* Use stream class name's base name as prefix */ | |
689 | gchar *basename = | |
690 | g_path_get_basename(stream->stream_class->name->str); | |
691 | ||
692 | assert(basename); | |
693 | ||
694 | if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { | |
695 | g_string_assign(filename, "stream"); | |
696 | } else { | |
697 | g_string_assign(filename, basename); | |
319fd969 PP |
698 | } |
699 | ||
ab22d18f PP |
700 | g_free(basename); |
701 | goto append_ids; | |
319fd969 PP |
702 | } |
703 | ||
ab22d18f PP |
704 | /* Default to using `stream-` as prefix */ |
705 | g_string_assign(filename, "stream"); | |
706 | ||
707 | append_ids: | |
50842bdc | 708 | stream_class_id = bt_stream_class_get_id(stream->stream_class); |
ab22d18f PP |
709 | assert(stream_class_id >= 0); |
710 | assert(stream->id >= 0); | |
711 | g_string_append_printf(filename, "-%" PRId64 "-%" PRId64, | |
712 | stream_class_id, stream->id); | |
713 | ||
ebd04048 MJ |
714 | file_path = g_build_filename(writer->path->str, filename->str, NULL); |
715 | if (file_path == NULL) { | |
716 | fd = -1; | |
717 | goto end; | |
718 | } | |
ab22d18f | 719 | |
ebd04048 | 720 | fd = open(file_path, |
319fd969 PP |
721 | O_RDWR | O_CREAT | O_TRUNC, |
722 | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP); | |
ebd04048 | 723 | g_free(file_path); |
19abc2c6 | 724 | if (fd < 0) { |
c606e638 PP |
725 | BT_LOGW_ERRNO("Failed to open stream file for writing", |
726 | ": file_path=\"%s\", filename=\"%s\", ret=%d", | |
727 | file_path, filename->str, fd); | |
19abc2c6 PP |
728 | goto end; |
729 | } | |
730 | ||
731 | BT_LOGD("Created stream file for writing: " | |
ebd04048 | 732 | "stream-addr=%p, stream-name=\"%s\", " |
50842bdc | 733 | "filename=\"%s\", fd=%d", stream, bt_stream_get_name(stream), |
ebd04048 | 734 | filename->str, fd); |
19abc2c6 PP |
735 | |
736 | end: | |
319fd969 PP |
737 | g_string_free(filename, TRUE); |
738 | return fd; | |
739 | } | |
740 | ||
741 | static | |
50842bdc | 742 | void set_stream_fd(struct bt_stream *stream, int fd) |
319fd969 | 743 | { |
50842bdc | 744 | (void) bt_stream_pos_init(&stream->pos, fd, O_RDWR); |
319fd969 | 745 | stream->pos.fd = fd; |
319fd969 PP |
746 | } |
747 | ||
3230ee6b PP |
748 | static |
749 | void component_destroy_listener(struct bt_component *component, void *data) | |
750 | { | |
50842bdc | 751 | struct bt_stream *stream = data; |
3230ee6b | 752 | |
19abc2c6 PP |
753 | BT_LOGD("Component is being destroyed, stream is notified: " |
754 | "comp-addr=%p, stream-addr=%p", component, stream); | |
3230ee6b PP |
755 | g_hash_table_remove(stream->comp_cur_port, component); |
756 | } | |
757 | ||
cfe11c58 | 758 | static |
50842bdc PP |
759 | struct bt_stream *bt_stream_create_with_id_no_check( |
760 | struct bt_stream_class *stream_class, | |
cfe11c58 | 761 | const char *name, uint64_t id) |
273b65be | 762 | { |
12c8a1a3 | 763 | int ret; |
50842bdc PP |
764 | struct bt_stream *stream = NULL; |
765 | struct bt_trace *trace = NULL; | |
319fd969 | 766 | struct bt_ctf_writer *writer = NULL; |
273b65be | 767 | |
319fd969 | 768 | if (!stream_class) { |
19abc2c6 | 769 | BT_LOGW_STR("Invalid parameter: stream class is NULL."); |
b71d7298 | 770 | goto error; |
319fd969 PP |
771 | } |
772 | ||
19abc2c6 | 773 | BT_LOGD("Creating stream object: stream-class-addr=%p, " |
cfe11c58 PP |
774 | "stream-class-name=\"%s\", stream-name=\"%s\", " |
775 | "stream-id=%" PRIu64, | |
50842bdc | 776 | stream_class, bt_stream_class_get_name(stream_class), |
cfe11c58 | 777 | name, id); |
50842bdc | 778 | trace = bt_stream_class_borrow_trace(stream_class); |
319fd969 | 779 | if (!trace) { |
19abc2c6 | 780 | BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " |
b3376dd9 PP |
781 | "stream-class-addr=%p, stream-class-name=\"%s\", " |
782 | "stream-name=\"%s\"", | |
50842bdc | 783 | stream_class, bt_stream_class_get_name(stream_class), |
19abc2c6 | 784 | name); |
b71d7298 | 785 | goto error; |
273b65be JG |
786 | } |
787 | ||
50842bdc | 788 | if (bt_trace_is_static(trace)) { |
5acf2ae6 PP |
789 | /* |
790 | * A static trace has the property that all its stream | |
791 | * classes, clock classes, and streams are definitive: | |
792 | * no more can be added, and each object is also frozen. | |
793 | */ | |
19abc2c6 | 794 | BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: " |
b3376dd9 PP |
795 | "stream-class-addr=%p, stream-class-name=\"%s\", " |
796 | "stream-name=\"%s\", trace-addr=%p", | |
50842bdc | 797 | stream_class, bt_stream_class_get_name(stream_class), |
b3376dd9 | 798 | name, trace); |
5acf2ae6 PP |
799 | goto error; |
800 | } | |
801 | ||
cfe11c58 PP |
802 | if (id != -1ULL) { |
803 | /* | |
804 | * Validate that the given ID is unique amongst all the | |
805 | * existing trace's streams created from the same stream | |
806 | * class. | |
807 | */ | |
808 | size_t i; | |
809 | ||
810 | for (i = 0; i < trace->streams->len; i++) { | |
50842bdc | 811 | struct bt_stream *trace_stream = |
cfe11c58 PP |
812 | g_ptr_array_index(trace->streams, i); |
813 | ||
814 | if (trace_stream->stream_class != stream_class) { | |
815 | continue; | |
816 | } | |
817 | ||
818 | if (trace_stream->id == id) { | |
819 | BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID."); | |
820 | goto error; | |
821 | } | |
822 | } | |
823 | } | |
824 | ||
50842bdc | 825 | stream = g_new0(struct bt_stream, 1); |
273b65be | 826 | if (!stream) { |
19abc2c6 | 827 | BT_LOGE_STR("Failed to allocate one stream."); |
b71d7298 | 828 | goto error; |
273b65be JG |
829 | } |
830 | ||
50842bdc | 831 | bt_object_init(stream, bt_stream_destroy); |
e6a8e8e4 JG |
832 | /* |
833 | * Acquire reference to parent since stream will become publicly | |
834 | * reachable; it needs its parent to remain valid. | |
835 | */ | |
836 | bt_object_set_parent(stream, trace); | |
273b65be | 837 | stream->stream_class = stream_class; |
319fd969 | 838 | stream->pos.fd = -1; |
cfe11c58 | 839 | stream->id = (int64_t) id; |
d246b111 | 840 | |
3230ee6b | 841 | stream->destroy_listeners = g_array_new(FALSE, TRUE, |
50842bdc | 842 | sizeof(struct bt_stream_destroy_listener)); |
3230ee6b | 843 | if (!stream->destroy_listeners) { |
19abc2c6 | 844 | BT_LOGE_STR("Failed to allocate a GArray."); |
3230ee6b PP |
845 | goto error; |
846 | } | |
847 | ||
b71d7298 PP |
848 | if (name) { |
849 | stream->name = g_string_new(name); | |
850 | if (!stream->name) { | |
19abc2c6 | 851 | BT_LOGE_STR("Failed to allocate a GString."); |
b71d7298 PP |
852 | goto error; |
853 | } | |
854 | } | |
855 | ||
19abc2c6 PP |
856 | BT_LOGD("Set stream's trace parent: trace-addr=%p", trace); |
857 | ||
319fd969 PP |
858 | if (trace->is_created_by_writer) { |
859 | int fd; | |
cfe11c58 PP |
860 | writer = (struct bt_ctf_writer *) bt_object_get_parent(trace); |
861 | stream->id = (int64_t) stream_class->next_stream_id++; | |
319fd969 | 862 | |
19abc2c6 PP |
863 | BT_LOGD("Stream object belongs to a writer's trace: " |
864 | "writer-addr=%p", writer); | |
319fd969 | 865 | assert(writer); |
b3376dd9 | 866 | |
98edd02c | 867 | if (stream_class->packet_context_type) { |
19abc2c6 PP |
868 | BT_LOGD("Creating stream's packet context field: " |
869 | "ft-addr=%p", stream_class->packet_context_type); | |
50842bdc | 870 | stream->packet_context = bt_field_create( |
98edd02c JG |
871 | stream_class->packet_context_type); |
872 | if (!stream->packet_context) { | |
19abc2c6 | 873 | BT_LOGW_STR("Cannot create stream's packet context field."); |
98edd02c JG |
874 | goto error; |
875 | } | |
319fd969 | 876 | |
98edd02c | 877 | /* Initialize events_discarded */ |
af9296f3 | 878 | ret = try_set_structure_field_integer( |
19abc2c6 | 879 | stream->packet_context, "events_discarded", 0); |
7ee636df | 880 | if (ret < 0) { |
19abc2c6 PP |
881 | BT_LOGW("Cannot set `events_discarded` field in packet context: " |
882 | "ret=%d, packet-context-field-addr=%p", | |
883 | ret, stream->packet_context); | |
98edd02c JG |
884 | goto error; |
885 | } | |
319fd969 PP |
886 | } |
887 | ||
888 | stream->events = g_ptr_array_new_with_free_func( | |
889 | (GDestroyNotify) release_event); | |
890 | if (!stream->events) { | |
19abc2c6 | 891 | BT_LOGE_STR("Failed to allocate a GPtrArray."); |
319fd969 PP |
892 | goto error; |
893 | } | |
894 | ||
b3376dd9 PP |
895 | if (trace->packet_header_type) { |
896 | BT_LOGD("Creating stream's packet header field: " | |
897 | "ft-addr=%p", trace->packet_header_type); | |
898 | stream->packet_header = | |
50842bdc | 899 | bt_field_create(trace->packet_header_type); |
b3376dd9 PP |
900 | if (!stream->packet_header) { |
901 | BT_LOGW_STR("Cannot create stream's packet header field."); | |
902 | goto error; | |
903 | } | |
319fd969 PP |
904 | } |
905 | ||
906 | /* | |
907 | * Attempt to populate the default trace packet header fields | |
908 | * (magic, uuid and stream_id). This will _not_ fail shall the | |
909 | * fields not be found or be of an incompatible type; they will | |
910 | * simply not be populated automatically. The user will have to | |
911 | * make sure to set the trace packet header fields himself | |
912 | * before flushing. | |
913 | */ | |
b3376dd9 | 914 | ret = auto_populate_packet_header(stream); |
319fd969 | 915 | if (ret) { |
b3376dd9 | 916 | BT_LOGW_STR("Cannot automatically populate the stream's packet header."); |
319fd969 PP |
917 | goto error; |
918 | } | |
919 | ||
920 | /* Create file associated with this stream */ | |
921 | fd = create_stream_file(writer, stream); | |
922 | if (fd < 0) { | |
19abc2c6 | 923 | BT_LOGW_STR("Cannot create stream file."); |
319fd969 PP |
924 | goto error; |
925 | } | |
926 | ||
19abc2c6 | 927 | set_stream_fd(stream, fd); |
319fd969 PP |
928 | |
929 | /* Freeze the writer */ | |
19abc2c6 | 930 | BT_LOGD_STR("Freezing stream's CTF writer."); |
319fd969 PP |
931 | bt_ctf_writer_freeze(writer); |
932 | } else { | |
933 | /* Non-writer stream indicated by a negative FD */ | |
19abc2c6 | 934 | set_stream_fd(stream, -1); |
3230ee6b PP |
935 | stream->comp_cur_port = g_hash_table_new(g_direct_hash, |
936 | g_direct_equal); | |
937 | if (!stream->comp_cur_port) { | |
19abc2c6 | 938 | BT_LOGE_STR("Failed to allocate a GHashTable."); |
3230ee6b PP |
939 | goto error; |
940 | } | |
d246b111 | 941 | } |
319fd969 PP |
942 | |
943 | /* Add this stream to the trace's streams */ | |
944 | g_ptr_array_add(trace->streams, stream); | |
19abc2c6 | 945 | BT_LOGD("Created stream object: addr=%p", stream); |
cfe11c58 PP |
946 | goto end; |
947 | ||
83509119 JG |
948 | error: |
949 | BT_PUT(stream); | |
cfe11c58 PP |
950 | |
951 | end: | |
952 | bt_put(writer); | |
953 | return stream; | |
954 | } | |
955 | ||
50842bdc PP |
956 | struct bt_stream *bt_stream_create_with_id( |
957 | struct bt_stream_class *stream_class, | |
cfe11c58 PP |
958 | const char *name, uint64_t id_param) |
959 | { | |
50842bdc PP |
960 | struct bt_trace *trace; |
961 | struct bt_stream *stream = NULL; | |
cfe11c58 PP |
962 | int64_t id = (int64_t) id_param; |
963 | ||
964 | if (!stream_class) { | |
965 | BT_LOGW_STR("Invalid parameter: stream class is NULL."); | |
966 | goto end; | |
967 | } | |
968 | ||
969 | if (id < 0) { | |
970 | BT_LOGW("Invalid parameter: invalid stream's ID: " | |
971 | "name=\"%s\", id=%" PRIu64, | |
972 | name, id_param); | |
973 | goto end; | |
974 | } | |
975 | ||
50842bdc | 976 | trace = bt_stream_class_borrow_trace(stream_class); |
cfe11c58 PP |
977 | if (!trace) { |
978 | BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " | |
979 | "stream-class-addr=%p, stream-class-name=\"%s\", " | |
980 | "stream-name=\"%s\", stream-id=%" PRIu64, | |
50842bdc | 981 | stream_class, bt_stream_class_get_name(stream_class), |
cfe11c58 PP |
982 | name, id_param); |
983 | goto end; | |
984 | } | |
985 | ||
986 | if (trace->is_created_by_writer) { | |
50842bdc | 987 | BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_stream_create(): " |
cfe11c58 PP |
988 | "stream-class-addr=%p, stream-class-name=\"%s\", " |
989 | "stream-name=\"%s\", stream-id=%" PRIu64, | |
50842bdc | 990 | stream_class, bt_stream_class_get_name(stream_class), |
cfe11c58 PP |
991 | name, id_param); |
992 | goto end; | |
993 | } | |
994 | ||
50842bdc | 995 | stream = bt_stream_create_with_id_no_check(stream_class, |
cfe11c58 PP |
996 | name, id_param); |
997 | ||
998 | end: | |
83509119 | 999 | return stream; |
273b65be JG |
1000 | } |
1001 | ||
50842bdc PP |
1002 | struct bt_stream *bt_stream_create( |
1003 | struct bt_stream_class *stream_class, | |
cfe11c58 PP |
1004 | const char *name) |
1005 | { | |
50842bdc | 1006 | return bt_stream_create_with_id_no_check(stream_class, |
cfe11c58 PP |
1007 | name, -1ULL); |
1008 | } | |
1009 | ||
50842bdc PP |
1010 | struct bt_stream_class *bt_stream_get_class( |
1011 | struct bt_stream *stream) | |
3baf0856 | 1012 | { |
50842bdc | 1013 | struct bt_stream_class *stream_class = NULL; |
3baf0856 JG |
1014 | |
1015 | if (!stream) { | |
19abc2c6 | 1016 | BT_LOGW_STR("Invalid parameter: stream is NULL."); |
3baf0856 JG |
1017 | goto end; |
1018 | } | |
1019 | ||
1020 | stream_class = stream->stream_class; | |
83509119 | 1021 | bt_get(stream_class); |
3baf0856 JG |
1022 | end: |
1023 | return stream_class; | |
1024 | } | |
1025 | ||
50842bdc PP |
1026 | int bt_stream_get_discarded_events_count( |
1027 | struct bt_stream *stream, uint64_t *count) | |
a78a2e25 | 1028 | { |
37949e9e | 1029 | int ret = 0; |
a78a2e25 | 1030 | |
19abc2c6 PP |
1031 | if (!stream) { |
1032 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
37949e9e | 1033 | ret = -1; |
19abc2c6 PP |
1034 | goto end; |
1035 | } | |
1036 | ||
1037 | if (!count) { | |
1038 | BT_LOGW_STR("Invalid parameter: count is NULL."); | |
37949e9e | 1039 | ret = -1; |
19abc2c6 PP |
1040 | goto end; |
1041 | } | |
1042 | ||
b3376dd9 PP |
1043 | if (stream->pos.fd < 0) { |
1044 | BT_LOGW("Invalid parameter: stream is not a CTF writer stream: " | |
19abc2c6 | 1045 | "stream-addr=%p, stream-name=\"%s\"", |
50842bdc | 1046 | stream, bt_stream_get_name(stream)); |
37949e9e | 1047 | ret = -1; |
19abc2c6 PP |
1048 | goto end; |
1049 | } | |
1050 | ||
b3376dd9 PP |
1051 | *count = (uint64_t) stream->discarded_events; |
1052 | ||
1053 | end: | |
1054 | return ret; | |
1055 | } | |
1056 | ||
1057 | static | |
50842bdc | 1058 | int set_packet_context_events_discarded_field(struct bt_stream *stream, |
b3376dd9 PP |
1059 | uint64_t count) |
1060 | { | |
1061 | int ret = 0; | |
50842bdc | 1062 | struct bt_field *events_discarded_field = NULL; |
b3376dd9 PP |
1063 | |
1064 | if (!stream->packet_context) { | |
a78a2e25 JG |
1065 | goto end; |
1066 | } | |
1067 | ||
50842bdc | 1068 | events_discarded_field = bt_field_structure_get_field_by_name( |
12c8a1a3 JG |
1069 | stream->packet_context, "events_discarded"); |
1070 | if (!events_discarded_field) { | |
12c8a1a3 JG |
1071 | goto end; |
1072 | } | |
1073 | ||
50842bdc | 1074 | ret = bt_field_unsigned_integer_set_value( |
b3376dd9 PP |
1075 | events_discarded_field, count); |
1076 | if (ret) { | |
1077 | BT_LOGW("Cannot set packet context's `events_discarded` field: " | |
1078 | "field-addr=%p, value=%" PRIu64, | |
12c8a1a3 | 1079 | events_discarded_field, count); |
b3376dd9 | 1080 | goto end; |
12c8a1a3 | 1081 | } |
b3376dd9 | 1082 | |
a78a2e25 | 1083 | end: |
83509119 | 1084 | bt_put(events_discarded_field); |
a78a2e25 JG |
1085 | return ret; |
1086 | } | |
1087 | ||
50842bdc | 1088 | void bt_stream_append_discarded_events(struct bt_stream *stream, |
273b65be JG |
1089 | uint64_t event_count) |
1090 | { | |
12c8a1a3 | 1091 | int ret; |
12c8a1a3 | 1092 | uint64_t new_count; |
50842bdc | 1093 | struct bt_field *events_discarded_field = NULL; |
12c8a1a3 | 1094 | |
19abc2c6 PP |
1095 | if (!stream) { |
1096 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1097 | goto end; | |
1098 | } | |
1099 | ||
1100 | BT_LOGV("Appending discarded events to stream: " | |
1101 | "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, | |
50842bdc | 1102 | stream, bt_stream_get_name(stream), event_count); |
19abc2c6 PP |
1103 | |
1104 | if (!stream->packet_context) { | |
1105 | BT_LOGW_STR("Invalid parameter: stream has no packet context field."); | |
1106 | goto end; | |
1107 | } | |
1108 | ||
1109 | if (stream->pos.fd < 0) { | |
1110 | BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); | |
12c8a1a3 JG |
1111 | goto end; |
1112 | } | |
1113 | ||
50842bdc | 1114 | events_discarded_field = bt_field_structure_get_field_by_name( |
12c8a1a3 JG |
1115 | stream->packet_context, "events_discarded"); |
1116 | if (!events_discarded_field) { | |
b3376dd9 | 1117 | BT_LOGW_STR("No field named `events_discarded` in stream's packet context."); |
12c8a1a3 JG |
1118 | goto end; |
1119 | } | |
1120 | ||
b3376dd9 PP |
1121 | new_count = stream->discarded_events + event_count; |
1122 | if (new_count < stream->discarded_events) { | |
1123 | BT_LOGW("New discarded events count is less than the stream's current discarded events count: " | |
1124 | "cur-count=%" PRIu64 ", new-count=%" PRIu64, | |
1125 | stream->discarded_events, new_count); | |
1126 | goto end; | |
1127 | } | |
1128 | ||
1129 | ret = set_packet_context_events_discarded_field(stream, new_count); | |
1130 | if (ret) { | |
1131 | /* set_packet_context_events_discarded_field() logs errors */ | |
1132 | goto end; | |
12c8a1a3 JG |
1133 | } |
1134 | ||
b3376dd9 | 1135 | stream->discarded_events = new_count; |
19abc2c6 PP |
1136 | BT_LOGV("Appended discarded events to stream: " |
1137 | "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, | |
50842bdc | 1138 | stream, bt_stream_get_name(stream), event_count); |
19abc2c6 | 1139 | |
12c8a1a3 | 1140 | end: |
83509119 | 1141 | bt_put(events_discarded_field); |
273b65be JG |
1142 | } |
1143 | ||
50842bdc PP |
1144 | static int auto_populate_event_header(struct bt_stream *stream, |
1145 | struct bt_event *event) | |
ac0c6bdd PP |
1146 | { |
1147 | int ret = 0; | |
50842bdc PP |
1148 | struct bt_field *id_field = NULL, *timestamp_field = NULL; |
1149 | struct bt_clock_class *mapped_clock_class = NULL; | |
fa2061de | 1150 | int64_t event_class_id; |
ac0c6bdd | 1151 | |
19abc2c6 PP |
1152 | assert(event); |
1153 | ||
06b019a7 JD |
1154 | if (!event->event_header) { |
1155 | goto end; | |
1156 | } | |
1157 | ||
19abc2c6 PP |
1158 | if (event->frozen) { |
1159 | BT_LOGW_STR("Cannot populate event header field: event is frozen."); | |
ac0c6bdd PP |
1160 | ret = -1; |
1161 | goto end; | |
1162 | } | |
1163 | ||
b3376dd9 | 1164 | BT_LOGV("Automatically populating event's header field: " |
19abc2c6 | 1165 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p", |
50842bdc | 1166 | stream, bt_stream_get_name(stream), event); |
19abc2c6 | 1167 | |
50842bdc PP |
1168 | id_field = bt_field_structure_get_field_by_name(event->event_header, "id"); |
1169 | event_class_id = bt_event_class_get_id(event->event_class); | |
fa2061de MD |
1170 | if (event_class_id < 0) { |
1171 | BT_LOGE("Event class ID cannot be found"); | |
1172 | ret = -1; | |
1173 | goto end; | |
1174 | } | |
50842bdc | 1175 | if (id_field && bt_field_type_is_integer(id_field->type)) { |
19abc2c6 | 1176 | ret = set_integer_field_value(id_field, event_class_id); |
ac0c6bdd | 1177 | if (ret) { |
19abc2c6 PP |
1178 | BT_LOGW("Cannot set event header's `id` field's value: " |
1179 | "addr=%p, value=%" PRIu64, id_field, | |
1180 | event_class_id); | |
ac0c6bdd PP |
1181 | goto end; |
1182 | } | |
1183 | } | |
1184 | ||
1185 | /* | |
1186 | * The conditions to automatically set the timestamp are: | |
1187 | * | |
1188 | * 1. The event header field "timestamp" exists and is an | |
1189 | * integer field. | |
1190 | * 2. This stream's class has a registered clock (set with | |
50842bdc | 1191 | * bt_stream_class_set_clock()). |
ac0c6bdd PP |
1192 | * 3. The event header field "timestamp" has its type mapped to |
1193 | * a clock class which is also the clock class of this | |
1194 | * stream's class's registered clock. | |
ac0c6bdd | 1195 | */ |
50842bdc | 1196 | timestamp_field = bt_field_structure_get_field_by_name(event->event_header, |
ac0c6bdd | 1197 | "timestamp"); |
b3376dd9 | 1198 | if (timestamp_field && stream->stream_class->clock && |
50842bdc PP |
1199 | bt_field_type_is_integer(timestamp_field->type)) { |
1200 | struct bt_clock_class *stream_class_clock_class = | |
ac0c6bdd | 1201 | stream->stream_class->clock->clock_class; |
ac0c6bdd | 1202 | |
ac0c6bdd | 1203 | mapped_clock_class = |
50842bdc | 1204 | bt_field_type_integer_get_mapped_clock_class( |
b3376dd9 | 1205 | timestamp_field->type); |
9f1bc157 PP |
1206 | if (!mapped_clock_class || |
1207 | mapped_clock_class == stream_class_clock_class) { | |
ac0c6bdd PP |
1208 | uint64_t timestamp; |
1209 | ||
1210 | ret = bt_ctf_clock_get_value( | |
1211 | stream->stream_class->clock, | |
1212 | ×tamp); | |
19abc2c6 | 1213 | assert(ret == 0); |
ac0c6bdd PP |
1214 | ret = set_integer_field_value(timestamp_field, |
1215 | timestamp); | |
1216 | if (ret) { | |
19abc2c6 PP |
1217 | BT_LOGW("Cannot set event header's `timestamp` field's value: " |
1218 | "addr=%p, value=%" PRIu64, | |
1219 | timestamp_field, timestamp); | |
ac0c6bdd PP |
1220 | goto end; |
1221 | } | |
1222 | } | |
1223 | } | |
1224 | ||
b3376dd9 | 1225 | BT_LOGV("Automatically populated event's header field: " |
19abc2c6 | 1226 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p", |
50842bdc | 1227 | stream, bt_stream_get_name(stream), event); |
19abc2c6 | 1228 | |
ac0c6bdd PP |
1229 | end: |
1230 | bt_put(id_field); | |
1231 | bt_put(timestamp_field); | |
1232 | bt_put(mapped_clock_class); | |
1233 | return ret; | |
1234 | } | |
1235 | ||
50842bdc PP |
1236 | int bt_stream_append_event(struct bt_stream *stream, |
1237 | struct bt_event *event) | |
273b65be JG |
1238 | { |
1239 | int ret = 0; | |
273b65be | 1240 | |
19abc2c6 PP |
1241 | if (!stream) { |
1242 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1243 | ret = -1; | |
1244 | goto end; | |
1245 | } | |
1246 | ||
1247 | if (!event) { | |
1248 | BT_LOGW_STR("Invalid parameter: event is NULL."); | |
1249 | ret = -1; | |
1250 | goto end; | |
1251 | } | |
1252 | ||
1253 | if (stream->pos.fd < 0) { | |
1254 | BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); | |
273b65be JG |
1255 | ret = -1; |
1256 | goto end; | |
1257 | } | |
1258 | ||
19abc2c6 PP |
1259 | BT_LOGV("Appending event to stream: " |
1260 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " | |
1261 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
50842bdc PP |
1262 | stream, bt_stream_get_name(stream), event, |
1263 | bt_event_class_get_name(bt_event_borrow_event_class(event)), | |
1264 | bt_event_class_get_id(bt_event_borrow_event_class(event))); | |
19abc2c6 | 1265 | |
fa29ba83 PP |
1266 | /* |
1267 | * The event is not supposed to have a parent stream at this | |
1268 | * point. The only other way an event can have a parent stream | |
1269 | * is if it was assigned when setting a packet to the event, | |
1270 | * in which case the packet's stream is not a writer stream, | |
1271 | * and thus the user is trying to append an event which belongs | |
1272 | * to another stream. | |
1273 | */ | |
1274 | if (event->base.parent) { | |
1275 | ret = -1; | |
1276 | goto end; | |
1277 | } | |
1278 | ||
e6a8e8e4 | 1279 | bt_object_set_parent(event, stream); |
19abc2c6 | 1280 | BT_LOGV_STR("Automatically populating the header of the event to append."); |
ac0c6bdd | 1281 | ret = auto_populate_event_header(stream, event); |
662e778c | 1282 | if (ret) { |
19abc2c6 | 1283 | /* auto_populate_event_header() reports errors */ |
37f30168 | 1284 | goto error; |
662e778c JG |
1285 | } |
1286 | ||
5fd2e9fd | 1287 | /* Make sure the various scopes of the event are set */ |
19abc2c6 | 1288 | BT_LOGV_STR("Validating event to append."); |
50842bdc | 1289 | ret = bt_event_validate(event); |
273b65be | 1290 | if (ret) { |
37f30168 | 1291 | goto error; |
273b65be JG |
1292 | } |
1293 | ||
0d688c15 | 1294 | /* Save the new event and freeze it */ |
19abc2c6 | 1295 | BT_LOGV_STR("Freezing the event to append."); |
50842bdc | 1296 | bt_event_freeze(event); |
273b65be | 1297 | g_ptr_array_add(stream->events, event); |
5fd2e9fd | 1298 | |
e6a8e8e4 JG |
1299 | /* |
1300 | * Event had to hold a reference to its event class as long as it wasn't | |
1301 | * part of the same trace hierarchy. From now on, the event and its | |
1302 | * class share the same lifetime guarantees and the reference is no | |
1303 | * longer needed. | |
1304 | */ | |
19abc2c6 | 1305 | BT_LOGV_STR("Putting the event's class."); |
e6a8e8e4 | 1306 | bt_put(event->event_class); |
19abc2c6 PP |
1307 | BT_LOGV("Appended event to stream: " |
1308 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " | |
1309 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
50842bdc PP |
1310 | stream, bt_stream_get_name(stream), event, |
1311 | bt_event_class_get_name(bt_event_borrow_event_class(event)), | |
1312 | bt_event_class_get_id(bt_event_borrow_event_class(event))); | |
37f30168 | 1313 | |
273b65be | 1314 | end: |
37f30168 PP |
1315 | return ret; |
1316 | ||
1317 | error: | |
1318 | /* | |
1319 | * Orphan the event; we were not successful in associating it to | |
1320 | * a stream. | |
1321 | */ | |
1322 | bt_object_set_parent(event, NULL); | |
1323 | ||
273b65be JG |
1324 | return ret; |
1325 | } | |
1326 | ||
50842bdc | 1327 | struct bt_field *bt_stream_get_packet_context(struct bt_stream *stream) |
12c8a1a3 | 1328 | { |
50842bdc | 1329 | struct bt_field *packet_context = NULL; |
12c8a1a3 | 1330 | |
19abc2c6 PP |
1331 | if (!stream) { |
1332 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1333 | goto end; | |
1334 | } | |
1335 | ||
1336 | if (stream->pos.fd < 0) { | |
1337 | BT_LOGW("Invalid parameter: stream is not a CTF writer stream: " | |
1338 | "stream-addr=%p, stream-name=\"%s\"", stream, | |
50842bdc | 1339 | bt_stream_get_name(stream)); |
12c8a1a3 JG |
1340 | goto end; |
1341 | } | |
1342 | ||
1343 | packet_context = stream->packet_context; | |
12c8a1a3 | 1344 | if (packet_context) { |
83509119 | 1345 | bt_get(packet_context); |
12c8a1a3 | 1346 | } |
34629a55 | 1347 | end: |
12c8a1a3 JG |
1348 | return packet_context; |
1349 | } | |
1350 | ||
50842bdc PP |
1351 | int bt_stream_set_packet_context(struct bt_stream *stream, |
1352 | struct bt_field *field) | |
12c8a1a3 JG |
1353 | { |
1354 | int ret = 0; | |
50842bdc | 1355 | struct bt_field_type *field_type; |
12c8a1a3 | 1356 | |
19abc2c6 PP |
1357 | if (!stream) { |
1358 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1359 | ret = -1; | |
1360 | goto end; | |
1361 | } | |
1362 | ||
1363 | if (stream->pos.fd < 0) { | |
1364 | BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); | |
12c8a1a3 JG |
1365 | ret = -1; |
1366 | goto end; | |
1367 | } | |
1368 | ||
50842bdc PP |
1369 | field_type = bt_field_get_type(field); |
1370 | if (bt_field_type_compare(field_type, | |
09840de5 | 1371 | stream->stream_class->packet_context_type)) { |
19abc2c6 PP |
1372 | BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: " |
1373 | "stream-addr=%p, stream-name=\"%s\", " | |
1374 | "packet-context-field-addr=%p, " | |
1375 | "packet-context-ft-addr=%p", | |
50842bdc | 1376 | stream, bt_stream_get_name(stream), |
19abc2c6 | 1377 | field, field_type); |
12c8a1a3 JG |
1378 | ret = -1; |
1379 | goto end; | |
1380 | } | |
1381 | ||
83509119 | 1382 | bt_put(field_type); |
83509119 | 1383 | bt_put(stream->packet_context); |
835b2d10 | 1384 | stream->packet_context = bt_get(field); |
19abc2c6 PP |
1385 | BT_LOGV("Set stream's packet context field: " |
1386 | "stream-addr=%p, stream-name=\"%s\", " | |
1387 | "packet-context-field-addr=%p", | |
50842bdc | 1388 | stream, bt_stream_get_name(stream), field); |
12c8a1a3 JG |
1389 | end: |
1390 | return ret; | |
1391 | } | |
1392 | ||
50842bdc | 1393 | struct bt_field *bt_stream_get_packet_header(struct bt_stream *stream) |
263a7df5 | 1394 | { |
50842bdc | 1395 | struct bt_field *packet_header = NULL; |
263a7df5 | 1396 | |
19abc2c6 PP |
1397 | if (!stream) { |
1398 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1399 | goto end; | |
1400 | } | |
1401 | ||
1402 | if (stream->pos.fd < 0) { | |
1403 | BT_LOGW("Invalid parameter: stream is not a CTF writer stream: " | |
1404 | "stream-addr=%p, stream-name=\"%s\"", stream, | |
50842bdc | 1405 | bt_stream_get_name(stream)); |
263a7df5 JG |
1406 | goto end; |
1407 | } | |
1408 | ||
1409 | packet_header = stream->packet_header; | |
1410 | if (packet_header) { | |
83509119 | 1411 | bt_get(packet_header); |
263a7df5 JG |
1412 | } |
1413 | end: | |
1414 | return packet_header; | |
1415 | } | |
1416 | ||
50842bdc PP |
1417 | int bt_stream_set_packet_header(struct bt_stream *stream, |
1418 | struct bt_field *field) | |
263a7df5 JG |
1419 | { |
1420 | int ret = 0; | |
50842bdc PP |
1421 | struct bt_trace *trace = NULL; |
1422 | struct bt_field_type *field_type = NULL; | |
263a7df5 | 1423 | |
19abc2c6 PP |
1424 | if (!stream) { |
1425 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1426 | ret = -1; | |
1427 | goto end; | |
1428 | } | |
1429 | ||
1430 | if (stream->pos.fd < 0) { | |
1431 | BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); | |
263a7df5 JG |
1432 | ret = -1; |
1433 | goto end; | |
1434 | } | |
1435 | ||
50842bdc | 1436 | trace = (struct bt_trace *) bt_object_get_parent(stream); |
b3376dd9 PP |
1437 | |
1438 | if (!field) { | |
1439 | if (trace->packet_header_type) { | |
1440 | BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: " | |
1441 | "stream-addr=%p, stream-name=\"%s\", " | |
1442 | "packet-header-field-addr=%p, " | |
1443 | "expected-ft-addr=%p", | |
50842bdc | 1444 | stream, bt_stream_get_name(stream), |
b3376dd9 PP |
1445 | field, trace->packet_header_type); |
1446 | ret = -1; | |
1447 | goto end; | |
1448 | } | |
1449 | ||
1450 | goto skip_validation; | |
1451 | } | |
1452 | ||
50842bdc | 1453 | field_type = bt_field_get_type(field); |
b3376dd9 PP |
1454 | assert(field_type); |
1455 | ||
50842bdc | 1456 | if (bt_field_type_compare(field_type, trace->packet_header_type)) { |
19abc2c6 PP |
1457 | BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: " |
1458 | "stream-addr=%p, stream-name=\"%s\", " | |
1459 | "packet-header-field-addr=%p, " | |
1460 | "packet-header-ft-addr=%p", | |
50842bdc | 1461 | stream, bt_stream_get_name(stream), |
19abc2c6 | 1462 | field, field_type); |
263a7df5 JG |
1463 | ret = -1; |
1464 | goto end; | |
1465 | } | |
1466 | ||
b3376dd9 | 1467 | skip_validation: |
83509119 | 1468 | bt_put(stream->packet_header); |
835b2d10 | 1469 | stream->packet_header = bt_get(field); |
19abc2c6 PP |
1470 | BT_LOGV("Set stream's packet header field: " |
1471 | "stream-addr=%p, stream-name=\"%s\", " | |
1472 | "packet-header-field-addr=%p", | |
50842bdc | 1473 | stream, bt_stream_get_name(stream), field); |
263a7df5 | 1474 | end: |
e6a8e8e4 | 1475 | BT_PUT(trace); |
83509119 | 1476 | bt_put(field_type); |
263a7df5 JG |
1477 | return ret; |
1478 | } | |
1479 | ||
c9af50d1 | 1480 | static |
50842bdc | 1481 | void reset_structure_field(struct bt_field *structure, const char *name) |
c9af50d1 | 1482 | { |
50842bdc | 1483 | struct bt_field *member; |
c9af50d1 | 1484 | |
50842bdc | 1485 | member = bt_field_structure_get_field_by_name(structure, name); |
db1af8cc | 1486 | if (member) { |
50842bdc | 1487 | (void) bt_field_reset(member); |
db1af8cc JD |
1488 | bt_put(member); |
1489 | } | |
c9af50d1 JG |
1490 | } |
1491 | ||
50842bdc | 1492 | int bt_stream_flush(struct bt_stream *stream) |
273b65be JG |
1493 | { |
1494 | int ret = 0; | |
1495 | size_t i; | |
50842bdc PP |
1496 | struct bt_stream_pos packet_context_pos; |
1497 | struct bt_trace *trace; | |
1498 | enum bt_byte_order native_byte_order; | |
1c1d572f | 1499 | bool has_packet_size = false; |
273b65be | 1500 | |
19abc2c6 PP |
1501 | if (!stream) { |
1502 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1503 | ret = -1; | |
f0ea9318 | 1504 | goto end_no_stream; |
19abc2c6 PP |
1505 | } |
1506 | ||
1507 | if (stream->pos.fd < 0) { | |
1508 | BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream."); | |
273b65be JG |
1509 | ret = -1; |
1510 | goto end; | |
1511 | } | |
1512 | ||
1c1d572f | 1513 | if (stream->packet_context) { |
50842bdc | 1514 | struct bt_field *packet_size_field; |
b3376dd9 | 1515 | |
50842bdc | 1516 | packet_size_field = bt_field_structure_get_field_by_name( |
1c1d572f JD |
1517 | stream->packet_context, "packet_size"); |
1518 | has_packet_size = (packet_size_field != NULL); | |
1519 | bt_put(packet_size_field); | |
1520 | } | |
1521 | ||
1522 | if (stream->flushed_packet_count == 1) { | |
b3376dd9 PP |
1523 | if (!stream->packet_context) { |
1524 | BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once."); | |
1525 | ret = -1; | |
1526 | goto end; | |
1527 | } | |
1528 | ||
1c1d572f | 1529 | if (!has_packet_size) { |
b3376dd9 PP |
1530 | BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once."); |
1531 | ret = -1; | |
1532 | goto end; | |
1533 | } | |
664f50c8 JG |
1534 | } |
1535 | ||
19abc2c6 PP |
1536 | BT_LOGV("Flushing stream's current packet: stream-addr=%p, " |
1537 | "stream-name=\"%s\", packet-index=%u", stream, | |
50842bdc PP |
1538 | bt_stream_get_name(stream), stream->flushed_packet_count); |
1539 | trace = bt_stream_class_borrow_trace(stream->stream_class); | |
dc3fffef | 1540 | assert(trace); |
50842bdc | 1541 | native_byte_order = bt_trace_get_native_byte_order(trace); |
d246b111 | 1542 | |
b3376dd9 | 1543 | ret = auto_populate_packet_header(stream); |
d246b111 | 1544 | if (ret) { |
b3376dd9 PP |
1545 | BT_LOGW_STR("Cannot automatically populate the stream's packet header field."); |
1546 | ret = -1; | |
d246b111 | 1547 | goto end; |
273b65be JG |
1548 | } |
1549 | ||
b3376dd9 PP |
1550 | ret = auto_populate_packet_context(stream); |
1551 | if (ret) { | |
1552 | BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); | |
1553 | ret = -1; | |
1554 | goto end; | |
1555 | } | |
98edd02c | 1556 | |
b3376dd9 PP |
1557 | /* mmap the next packet */ |
1558 | BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64, | |
1559 | stream->pos.offset); | |
50842bdc | 1560 | bt_stream_pos_packet_seek(&stream->pos, 0, SEEK_CUR); |
b3376dd9 | 1561 | assert(stream->pos.packet_size % 8 == 0); |
273b65be | 1562 | |
b3376dd9 PP |
1563 | if (stream->packet_header) { |
1564 | BT_LOGV_STR("Serializing packet header field."); | |
50842bdc | 1565 | ret = bt_field_serialize(stream->packet_header, &stream->pos, |
b3376dd9 PP |
1566 | native_byte_order); |
1567 | if (ret) { | |
1568 | BT_LOGW("Cannot serialize stream's packet header field: " | |
1569 | "field-addr=%p", stream->packet_header); | |
98edd02c JG |
1570 | goto end; |
1571 | } | |
b3376dd9 | 1572 | } |
12c8a1a3 | 1573 | |
b3376dd9 | 1574 | if (stream->packet_context) { |
10cb7b41 JG |
1575 | /* Write packet context */ |
1576 | memcpy(&packet_context_pos, &stream->pos, | |
dc3fffef | 1577 | sizeof(packet_context_pos)); |
19abc2c6 | 1578 | BT_LOGV_STR("Serializing packet context field."); |
50842bdc | 1579 | ret = bt_field_serialize(stream->packet_context, |
dc3fffef | 1580 | &stream->pos, native_byte_order); |
98edd02c | 1581 | if (ret) { |
b3376dd9 | 1582 | BT_LOGW("Cannot serialize stream's packet context field: " |
19abc2c6 | 1583 | "field-addr=%p", stream->packet_context); |
98edd02c JG |
1584 | goto end; |
1585 | } | |
12c8a1a3 JG |
1586 | } |
1587 | ||
19abc2c6 PP |
1588 | BT_LOGV("Serializing events: count=%u", stream->events->len); |
1589 | ||
273b65be | 1590 | for (i = 0; i < stream->events->len; i++) { |
50842bdc | 1591 | struct bt_event *event = g_ptr_array_index( |
273b65be | 1592 | stream->events, i); |
50842bdc PP |
1593 | struct bt_event_class *event_class = |
1594 | bt_event_borrow_event_class(event); | |
19abc2c6 | 1595 | |
b3376dd9 | 1596 | BT_LOGV("Serializing event: index=%zu, event-addr=%p, " |
19abc2c6 PP |
1597 | "event-class-name=\"%s\", event-class-id=%" PRId64 ", " |
1598 | "pos-offset=%" PRId64 ", packet-size=%" PRIu64, | |
50842bdc PP |
1599 | i, event, bt_event_class_get_name(event_class), |
1600 | bt_event_class_get_id(event_class), | |
19abc2c6 | 1601 | stream->pos.offset, stream->pos.packet_size); |
273b65be | 1602 | |
273b65be | 1603 | /* Write event header */ |
06b019a7 JD |
1604 | if (event->event_header) { |
1605 | BT_LOGV_STR("Serializing event's header field."); | |
50842bdc | 1606 | ret = bt_field_serialize(event->event_header, |
06b019a7 JD |
1607 | &stream->pos, native_byte_order); |
1608 | if (ret) { | |
1609 | BT_LOGW("Cannot serialize event's header field: " | |
1610 | "field-addr=%p", event->event_header); | |
1611 | goto end; | |
1612 | } | |
273b65be JG |
1613 | } |
1614 | ||
8bfa3f9c | 1615 | /* Write stream event context */ |
5fd2e9fd | 1616 | if (event->stream_event_context) { |
19abc2c6 | 1617 | BT_LOGV_STR("Serializing event's stream event context field."); |
50842bdc | 1618 | ret = bt_field_serialize( |
dc3fffef PP |
1619 | event->stream_event_context, &stream->pos, |
1620 | native_byte_order); | |
8bfa3f9c | 1621 | if (ret) { |
b3376dd9 | 1622 | BT_LOGW("Cannot serialize event's stream event context field: " |
19abc2c6 | 1623 | "field-addr=%p", event->stream_event_context); |
8bfa3f9c JG |
1624 | goto end; |
1625 | } | |
1626 | } | |
1627 | ||
273b65be | 1628 | /* Write event content */ |
50842bdc | 1629 | ret = bt_event_serialize(event, &stream->pos, |
dc3fffef | 1630 | native_byte_order); |
273b65be | 1631 | if (ret) { |
50842bdc | 1632 | /* bt_event_serialize() logs errors */ |
273b65be JG |
1633 | goto end; |
1634 | } | |
1635 | } | |
1636 | ||
1c1d572f JD |
1637 | if (!has_packet_size && stream->pos.offset % 8 != 0) { |
1638 | BT_LOGW("Stream's packet context field type has no `packet_size` field, " | |
1639 | "but current content size is not a multiple of 8 bits: " | |
1640 | "content-size=%" PRId64 ", " | |
1641 | "packet-size=%" PRIu64, | |
1642 | stream->pos.offset, | |
1643 | stream->pos.packet_size); | |
1644 | ret = -1; | |
1645 | goto end; | |
1646 | } | |
1647 | ||
b3376dd9 | 1648 | assert(stream->pos.packet_size % 8 == 0); |
0686ef94 | 1649 | |
1c1d572f JD |
1650 | /* |
1651 | * Remove extra padding bytes. | |
1652 | */ | |
1653 | stream->pos.packet_size = (stream->pos.offset + 7) & ~7; | |
1654 | ||
98edd02c JG |
1655 | if (stream->packet_context) { |
1656 | /* | |
b3376dd9 PP |
1657 | * The whole packet is serialized at this point. Make sure that, |
1658 | * if `packet_size` is missing, the current content size is | |
1659 | * equal to the current packet size. | |
98edd02c | 1660 | */ |
50842bdc | 1661 | struct bt_field *field = bt_field_structure_get_field_by_name( |
b3376dd9 PP |
1662 | stream->packet_context, "content_size"); |
1663 | ||
1664 | bt_put(field); | |
1665 | if (!field) { | |
1666 | if (stream->pos.offset != stream->pos.packet_size) { | |
1667 | BT_LOGW("Stream's packet context's `content_size` field is missing, " | |
1668 | "but current packet's content size is not equal to its packet size: " | |
1669 | "content-size=%" PRId64 ", " | |
1670 | "packet-size=%" PRIu64, | |
1671 | stream->pos.offset, | |
1672 | stream->pos.packet_size); | |
1673 | ret = -1; | |
c9af50d1 JG |
1674 | goto end; |
1675 | } | |
98edd02c | 1676 | } |
273b65be | 1677 | |
b3376dd9 PP |
1678 | /* |
1679 | * Overwrite the packet context now that the stream | |
1680 | * position's packet and content sizes have the correct | |
1681 | * values. | |
1682 | * | |
1683 | * Copy base_mma as the packet may have been remapped | |
1684 | * (e.g. when a packet is resized). | |
1685 | */ | |
1686 | packet_context_pos.base_mma = stream->pos.base_mma; | |
1687 | ret = auto_populate_packet_context(stream); | |
1688 | if (ret) { | |
1689 | BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); | |
1690 | ret = -1; | |
1691 | goto end; | |
98edd02c | 1692 | } |
273b65be | 1693 | |
19abc2c6 | 1694 | BT_LOGV("Rewriting (serializing) packet context field."); |
50842bdc | 1695 | ret = bt_field_serialize(stream->packet_context, |
dc3fffef | 1696 | &packet_context_pos, native_byte_order); |
98edd02c | 1697 | if (ret) { |
b3376dd9 | 1698 | BT_LOGW("Cannot serialize stream's packet context field: " |
19abc2c6 | 1699 | "field-addr=%p", stream->packet_context); |
98edd02c JG |
1700 | goto end; |
1701 | } | |
273b65be JG |
1702 | } |
1703 | ||
1704 | g_ptr_array_set_size(stream->events, 0); | |
1705 | stream->flushed_packet_count++; | |
b3376dd9 | 1706 | stream->size += stream->pos.packet_size / CHAR_BIT; |
1c1d572f | 1707 | |
273b65be | 1708 | end: |
c9af50d1 | 1709 | /* Reset automatically-set fields. */ |
1c1d572f JD |
1710 | if (stream->packet_context) { |
1711 | reset_structure_field(stream->packet_context, "timestamp_begin"); | |
1712 | reset_structure_field(stream->packet_context, "timestamp_end"); | |
1713 | reset_structure_field(stream->packet_context, "packet_size"); | |
1714 | reset_structure_field(stream->packet_context, "content_size"); | |
1715 | reset_structure_field(stream->packet_context, "events_discarded"); | |
1716 | } | |
cd7d8fb7 JG |
1717 | |
1718 | if (ret < 0) { | |
1719 | /* | |
1720 | * We failed to write the packet. Its size is therefore set to 0 | |
1721 | * to ensure the next mapping is done in the same place rather | |
1722 | * than advancing by "stream->pos.packet_size", which would | |
1723 | * leave a corrupted packet in the trace. | |
1724 | */ | |
1725 | stream->pos.packet_size = 0; | |
19abc2c6 | 1726 | } else { |
b3376dd9 PP |
1727 | BT_LOGV("Flushed stream's current packet: content-size=%" PRId64 ", " |
1728 | "packet-size=%" PRIu64, | |
1729 | stream->pos.offset, stream->pos.packet_size); | |
cd7d8fb7 | 1730 | } |
f0ea9318 MD |
1731 | |
1732 | end_no_stream: | |
273b65be JG |
1733 | return ret; |
1734 | } | |
1735 | ||
19abc2c6 | 1736 | /* Pre-2.0 CTF writer backward compatibility */ |
50842bdc | 1737 | void bt_ctf_stream_get(struct bt_stream *stream) |
273b65be | 1738 | { |
83509119 | 1739 | bt_get(stream); |
273b65be JG |
1740 | } |
1741 | ||
19abc2c6 | 1742 | /* Pre-2.0 CTF writer backward compatibility */ |
50842bdc | 1743 | void bt_ctf_stream_put(struct bt_stream *stream) |
273b65be | 1744 | { |
83509119 | 1745 | bt_put(stream); |
273b65be JG |
1746 | } |
1747 | ||
1748 | static | |
50842bdc | 1749 | void bt_stream_destroy(struct bt_object *obj) |
273b65be | 1750 | { |
50842bdc | 1751 | struct bt_stream *stream; |
3230ee6b | 1752 | int i; |
273b65be | 1753 | |
50842bdc | 1754 | stream = container_of(obj, struct bt_stream, base); |
19abc2c6 | 1755 | BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"", |
50842bdc | 1756 | stream, bt_stream_get_name(stream)); |
3230ee6b PP |
1757 | |
1758 | /* Call destroy listeners in reverse registration order */ | |
1759 | for (i = stream->destroy_listeners->len - 1; i >= 0; i--) { | |
50842bdc | 1760 | struct bt_stream_destroy_listener *listener = |
3230ee6b | 1761 | &g_array_index(stream->destroy_listeners, |
50842bdc | 1762 | struct bt_stream_destroy_listener, i); |
3230ee6b | 1763 | |
19abc2c6 PP |
1764 | BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d", |
1765 | listener->func, listener->data, i); | |
3230ee6b PP |
1766 | listener->func(stream, listener->data); |
1767 | } | |
1768 | ||
50842bdc | 1769 | (void) bt_stream_pos_fini(&stream->pos); |
0686ef94 JG |
1770 | if (stream->pos.fd >= 0) { |
1771 | int ret; | |
1772 | ||
1773 | /* | |
1774 | * Truncate the file's size to the minimum required to fit the | |
1775 | * last packet as we might have grown it too much on the last | |
1776 | * mmap. | |
1777 | */ | |
1778 | do { | |
1779 | ret = ftruncate(stream->pos.fd, stream->size); | |
1780 | } while (ret == -1 && errno == EINTR); | |
1781 | if (ret) { | |
c606e638 PP |
1782 | BT_LOGE_ERRNO("Failed to truncate stream file", |
1783 | ": ret=%d, size=%" PRIu64, | |
1784 | ret, (uint64_t) stream->size); | |
0686ef94 JG |
1785 | } |
1786 | ||
1787 | if (close(stream->pos.fd)) { | |
c606e638 PP |
1788 | BT_LOGE_ERRNO("Failed to close stream file", |
1789 | ": ret=%d", ret); | |
0686ef94 | 1790 | } |
9f56e450 | 1791 | } |
12c8a1a3 | 1792 | |
12c8a1a3 | 1793 | if (stream->events) { |
19abc2c6 | 1794 | BT_LOGD_STR("Putting events."); |
12c8a1a3 JG |
1795 | g_ptr_array_free(stream->events, TRUE); |
1796 | } | |
b71d7298 PP |
1797 | |
1798 | if (stream->name) { | |
1799 | g_string_free(stream->name, TRUE); | |
1800 | } | |
41ac640a | 1801 | |
3230ee6b PP |
1802 | if (stream->comp_cur_port) { |
1803 | GHashTableIter ht_iter; | |
1804 | gpointer comp_gptr, port_gptr; | |
1805 | ||
1806 | /* | |
1807 | * Since we're destroying the stream, remove the destroy | |
1808 | * listeners that it registered for each component in | |
1809 | * its component-port mapping hash table. Otherwise they | |
1810 | * would be called and the stream would be accessed once | |
1811 | * it's freed or another stream would be accessed. | |
1812 | */ | |
1813 | g_hash_table_iter_init(&ht_iter, stream->comp_cur_port); | |
1814 | ||
1815 | while (g_hash_table_iter_next(&ht_iter, &comp_gptr, &port_gptr)) { | |
1816 | assert(comp_gptr); | |
1817 | bt_component_remove_destroy_listener((void *) comp_gptr, | |
1818 | component_destroy_listener, stream); | |
1819 | } | |
1820 | ||
1821 | g_hash_table_destroy(stream->comp_cur_port); | |
1822 | } | |
1823 | ||
1824 | if (stream->destroy_listeners) { | |
1825 | g_array_free(stream->destroy_listeners, TRUE); | |
1826 | } | |
1827 | ||
19abc2c6 | 1828 | BT_LOGD_STR("Putting packet header field."); |
83509119 | 1829 | bt_put(stream->packet_header); |
19abc2c6 | 1830 | BT_LOGD_STR("Putting packet context field."); |
83509119 | 1831 | bt_put(stream->packet_context); |
273b65be JG |
1832 | g_free(stream); |
1833 | } | |
1834 | ||
273b65be | 1835 | static |
50842bdc | 1836 | int _set_structure_field_integer(struct bt_field *structure, char *name, |
c55a9f58 | 1837 | uint64_t value, bt_bool force) |
273b65be JG |
1838 | { |
1839 | int ret = 0; | |
50842bdc PP |
1840 | struct bt_field_type *field_type = NULL; |
1841 | struct bt_field *integer; | |
12c8a1a3 | 1842 | |
19abc2c6 PP |
1843 | assert(structure); |
1844 | assert(name); | |
273b65be | 1845 | |
50842bdc | 1846 | integer = bt_field_structure_get_field_by_name(structure, name); |
12c8a1a3 JG |
1847 | if (!integer) { |
1848 | /* Field not found, not an error. */ | |
19abc2c6 PP |
1849 | BT_LOGV("Field not found: struct-field-addr=%p, " |
1850 | "name=\"%s\", force=%d", structure, name, force); | |
12c8a1a3 JG |
1851 | goto end; |
1852 | } | |
1853 | ||
1854 | /* Make sure the payload has not already been set. */ | |
50842bdc | 1855 | if (!force && bt_field_is_set(integer)) { |
12c8a1a3 | 1856 | /* Payload already set, not an error */ |
19abc2c6 PP |
1857 | BT_LOGV("Field's payload is already set: struct-field-addr=%p, " |
1858 | "name=\"%s\", force=%d", structure, name, force); | |
12c8a1a3 JG |
1859 | goto end; |
1860 | } | |
1861 | ||
50842bdc | 1862 | field_type = bt_field_get_type(integer); |
d7b1ea66 | 1863 | assert(field_type); |
50842bdc | 1864 | if (bt_field_type_get_type_id(field_type) != BT_FIELD_TYPE_ID_INTEGER) { |
d7b1ea66 JG |
1865 | /* |
1866 | * The user most likely meant for us to populate this field | |
1867 | * automatically. However, we can only do this if the field | |
1868 | * is an integer. Return an error. | |
1869 | */ | |
19abc2c6 PP |
1870 | BT_LOGW("Invalid parameter: field's type is not an integer field type: " |
1871 | "field-addr=%p, ft-addr=%p, ft-id=%s", | |
1872 | integer, field_type, | |
50842bdc | 1873 | bt_field_type_id_string(field_type->id)); |
d7b1ea66 JG |
1874 | ret = -1; |
1875 | goto end; | |
1876 | } | |
1877 | ||
50842bdc PP |
1878 | if (bt_field_type_integer_is_signed(field_type)) { |
1879 | ret = bt_field_signed_integer_set_value(integer, | |
d7b1ea66 JG |
1880 | (int64_t) value); |
1881 | } else { | |
50842bdc | 1882 | ret = bt_field_unsigned_integer_set_value(integer, value); |
d7b1ea66 | 1883 | } |
af9296f3 | 1884 | ret = !ret ? 1 : ret; |
273b65be | 1885 | end: |
83509119 JG |
1886 | bt_put(integer); |
1887 | bt_put(field_type); | |
273b65be JG |
1888 | return ret; |
1889 | } | |
b71d7298 | 1890 | |
af9296f3 JG |
1891 | /* |
1892 | * Returns the following codes: | |
1893 | * 1 if the field was found and set, | |
1894 | * 0 if nothing was done (field not found, or was already set), | |
1895 | * <0 if an error was encoutered | |
1896 | */ | |
1897 | static | |
50842bdc | 1898 | int try_set_structure_field_integer(struct bt_field *structure, char *name, |
af9296f3 JG |
1899 | uint64_t value) |
1900 | { | |
c55a9f58 | 1901 | return _set_structure_field_integer(structure, name, value, BT_FALSE); |
af9296f3 JG |
1902 | } |
1903 | ||
50842bdc | 1904 | const char *bt_stream_get_name(struct bt_stream *stream) |
b71d7298 PP |
1905 | { |
1906 | const char *name = NULL; | |
1907 | ||
1908 | if (!stream) { | |
19abc2c6 | 1909 | BT_LOGW_STR("Invalid parameter: stream is NULL."); |
b71d7298 PP |
1910 | goto end; |
1911 | } | |
1912 | ||
1913 | name = stream->name ? stream->name->str : NULL; | |
1914 | ||
1915 | end: | |
1916 | return name; | |
1917 | } | |
98a4cbef | 1918 | |
50842bdc | 1919 | int bt_stream_is_writer(struct bt_stream *stream) |
98a4cbef PP |
1920 | { |
1921 | int ret = -1; | |
1922 | ||
1923 | if (!stream) { | |
19abc2c6 | 1924 | BT_LOGW_STR("Invalid parameter: stream is NULL."); |
98a4cbef PP |
1925 | goto end; |
1926 | } | |
1927 | ||
1928 | ret = (stream->pos.fd >= 0); | |
1929 | ||
1930 | end: | |
1931 | return ret; | |
1932 | } | |
3230ee6b PP |
1933 | |
1934 | BT_HIDDEN | |
50842bdc | 1935 | void bt_stream_map_component_to_port(struct bt_stream *stream, |
3230ee6b PP |
1936 | struct bt_component *comp, |
1937 | struct bt_port *port) | |
1938 | { | |
1939 | assert(stream); | |
1940 | assert(comp); | |
1941 | assert(port); | |
1942 | assert(stream->comp_cur_port); | |
1943 | ||
1944 | /* | |
1945 | * Do not take a reference to the component here because we | |
1946 | * don't want the component to exist as long as this stream | |
1947 | * exists. Instead, keep a weak reference, but add a destroy | |
1948 | * listener so that we remove this hash table entry when we know | |
1949 | * the component is destroyed. | |
1950 | */ | |
a2136eca PP |
1951 | BT_LOGV("Adding component's destroy listener for stream: " |
1952 | "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, " | |
1953 | "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"", | |
50842bdc | 1954 | stream, bt_stream_get_name(stream), |
19abc2c6 PP |
1955 | comp, bt_component_get_name(comp), port, |
1956 | bt_port_get_name(port)); | |
a2136eca PP |
1957 | bt_component_add_destroy_listener(comp, component_destroy_listener, |
1958 | stream); | |
1959 | g_hash_table_insert(stream->comp_cur_port, comp, port); | |
1960 | BT_LOGV_STR("Mapped component to port for stream."); | |
3230ee6b PP |
1961 | } |
1962 | ||
1963 | BT_HIDDEN | |
50842bdc | 1964 | struct bt_port *bt_stream_port_for_component(struct bt_stream *stream, |
3230ee6b PP |
1965 | struct bt_component *comp) |
1966 | { | |
1967 | assert(stream); | |
1968 | assert(comp); | |
1969 | assert(stream->comp_cur_port); | |
1970 | return g_hash_table_lookup(stream->comp_cur_port, comp); | |
1971 | } | |
1972 | ||
1973 | BT_HIDDEN | |
50842bdc PP |
1974 | void bt_stream_add_destroy_listener(struct bt_stream *stream, |
1975 | bt_stream_destroy_listener_func func, void *data) | |
3230ee6b | 1976 | { |
50842bdc | 1977 | struct bt_stream_destroy_listener listener; |
3230ee6b PP |
1978 | |
1979 | assert(stream); | |
1980 | assert(func); | |
1981 | listener.func = func; | |
1982 | listener.data = data; | |
1983 | g_array_append_val(stream->destroy_listeners, listener); | |
19abc2c6 PP |
1984 | BT_LOGV("Added stream destroy listener: stream-addr=%p, " |
1985 | "stream-name=\"%s\", func=%p, data=%p", | |
50842bdc | 1986 | stream, bt_stream_get_name(stream), func, data); |
3230ee6b PP |
1987 | } |
1988 | ||
1989 | BT_HIDDEN | |
50842bdc PP |
1990 | void bt_stream_remove_destroy_listener(struct bt_stream *stream, |
1991 | bt_stream_destroy_listener_func func, void *data) | |
3230ee6b PP |
1992 | { |
1993 | size_t i; | |
1994 | ||
1995 | assert(stream); | |
1996 | assert(func); | |
1997 | ||
1998 | for (i = 0; i < stream->destroy_listeners->len; i++) { | |
50842bdc | 1999 | struct bt_stream_destroy_listener *listener = |
3230ee6b | 2000 | &g_array_index(stream->destroy_listeners, |
50842bdc | 2001 | struct bt_stream_destroy_listener, i); |
3230ee6b PP |
2002 | |
2003 | if (listener->func == func && listener->data == data) { | |
2004 | g_array_remove_index(stream->destroy_listeners, i); | |
2005 | i--; | |
19abc2c6 PP |
2006 | BT_LOGV("Removed stream destroy listener: stream-addr=%p, " |
2007 | "stream-name=\"%s\", func=%p, data=%p", | |
50842bdc | 2008 | stream, bt_stream_get_name(stream), |
19abc2c6 | 2009 | func, data); |
3230ee6b PP |
2010 | } |
2011 | } | |
2012 | } | |
cfe11c58 | 2013 | |
50842bdc | 2014 | int64_t bt_stream_get_id(struct bt_stream *stream) |
cfe11c58 PP |
2015 | { |
2016 | int64_t ret; | |
2017 | ||
2018 | if (!stream) { | |
2019 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
2020 | ret = (int64_t) -1; | |
2021 | goto end; | |
2022 | } | |
2023 | ||
2024 | ret = stream->id; | |
2025 | if (ret < 0) { | |
2026 | BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"", | |
50842bdc | 2027 | stream, bt_stream_get_name(stream)); |
cfe11c58 PP |
2028 | } |
2029 | ||
2030 | end: | |
2031 | return ret; | |
2032 | } |