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