projects / babeltrace.git / blob
? search:


638bc0c947c5fbdf9a6e4ffa48e3f8ae5693ea3d
[babeltrace.git] / src / plugins / utils / muxer / muxer.c
1 /*
2 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 #define BT_COMP_LOG_SELF_COMP (muxer_comp->self_comp)
24 #define BT_LOG_OUTPUT_LEVEL (muxer_comp->log_level)
25 #define BT_LOG_TAG "PLUGIN/FLT.UTILS.MUXER"
26 #include "logging/comp-logging.h"
27
28 #include "common/macros.h"
29 #include "common/uuid.h"
30 #include <babeltrace2/babeltrace.h>
31 #include <glib.h>
32 #include <stdbool.h>
33 #include <inttypes.h>
34 #include "common/assert.h"
35 #include "common/common.h"
36 #include <stdlib.h>
37 #include <string.h>
38
39 #include "plugins/common/muxing/muxing.h"
40 #include "plugins/common/param-validation/param-validation.h"
41
42 #include "muxer.h"
43
44 struct muxer_comp {
45 /* Weak refs */
46 bt_self_component_filter *self_comp_flt;
47 bt_self_component *self_comp;
48
49 unsigned int next_port_num;
50 size_t available_input_ports;
51 bool initializing_muxer_msg_iter;
52 bt_logging_level log_level;
53 };
54
55 struct muxer_upstream_msg_iter {
56 struct muxer_comp *muxer_comp;
57
58 /* Owned by this, NULL if ended */
59 bt_self_component_port_input_message_iterator *msg_iter;
60
61 /* Contains `const bt_message *`, owned by this */
62 GQueue *msgs;
63 };
64
65 enum muxer_msg_iter_clock_class_expectation {
66 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY = 0,
67 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE,
68 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE,
69 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID,
70 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID,
71 };
72
73 struct muxer_msg_iter {
74 struct muxer_comp *muxer_comp;
75
76 /* Weak */
77 bt_self_message_iterator *self_msg_iter;
78
79 /*
80 * Array of struct muxer_upstream_msg_iter * (owned by this).
81 *
82 * NOTE: This array is searched in linearly to find the youngest
83 * current message. Keep this until benchmarks confirm that
84 * another data structure is faster than this for our typical
85 * use cases.
86 */
87 GPtrArray *active_muxer_upstream_msg_iters;
88
89 /*
90 * Array of struct muxer_upstream_msg_iter * (owned by this).
91 *
92 * We move ended message iterators from
93 * `active_muxer_upstream_msg_iters` to this array so as to be
94 * able to restore them when seeking.
95 */
96 GPtrArray *ended_muxer_upstream_msg_iters;
97
98 /* Last time returned in a message */
99 int64_t last_returned_ts_ns;
100
101 /* Clock class expectation state */
102 enum muxer_msg_iter_clock_class_expectation clock_class_expectation;
103
104 /*
105 * Expected clock class UUID, only valid when
106 * clock_class_expectation is
107 * MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID.
108 */
109 bt_uuid_t expected_clock_class_uuid;
110
111 /*
112 * Saved error. If we hit an error in the _next method, but have some
113 * messages ready to return, we save the error here and return it on
114 * the next _next call.
115 */
116 bt_component_class_message_iterator_next_method_status next_saved_status;
117 const struct bt_error *next_saved_error;
118 };
119
120 static
121 void empty_message_queue(struct muxer_upstream_msg_iter *upstream_msg_iter)
122 {
123 const bt_message *msg;
124
125 while ((msg = g_queue_pop_head(upstream_msg_iter->msgs))) {
126 bt_message_put_ref(msg);
127 }
128 }
129
130 static
131 void destroy_muxer_upstream_msg_iter(
132 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter)
133 {
134 struct muxer_comp *muxer_comp;
135
136 if (!muxer_upstream_msg_iter) {
137 return;
138 }
139
140 muxer_comp = muxer_upstream_msg_iter->muxer_comp;
141 BT_COMP_LOGD("Destroying muxer's upstream message iterator wrapper: "
142 "addr=%p, msg-iter-addr=%p, queue-len=%u",
143 muxer_upstream_msg_iter,
144 muxer_upstream_msg_iter->msg_iter,
145 muxer_upstream_msg_iter->msgs->length);
146 bt_self_component_port_input_message_iterator_put_ref(
147 muxer_upstream_msg_iter->msg_iter);
148
149 if (muxer_upstream_msg_iter->msgs) {
150 empty_message_queue(muxer_upstream_msg_iter);
151 g_queue_free(muxer_upstream_msg_iter->msgs);
152 }
153
154 g_free(muxer_upstream_msg_iter);
155 }
156
157 static
158 int muxer_msg_iter_add_upstream_msg_iter(struct muxer_msg_iter *muxer_msg_iter,
159 bt_self_component_port_input_message_iterator *self_msg_iter)
160 {
161 int ret = 0;
162 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter =
163 g_new0(struct muxer_upstream_msg_iter, 1);
164 struct muxer_comp *muxer_comp = muxer_msg_iter->muxer_comp;
165
166 if (!muxer_upstream_msg_iter) {
167 BT_COMP_LOGE_STR("Failed to allocate one muxer's upstream message iterator wrapper.");
168 goto error;
169 }
170
171 muxer_upstream_msg_iter->muxer_comp = muxer_comp;
172 muxer_upstream_msg_iter->msg_iter = self_msg_iter;
173 bt_self_component_port_input_message_iterator_get_ref(muxer_upstream_msg_iter->msg_iter);
174 muxer_upstream_msg_iter->msgs = g_queue_new();
175 if (!muxer_upstream_msg_iter->msgs) {
176 BT_COMP_LOGE_STR("Failed to allocate a GQueue.");
177 goto error;
178 }
179
180 g_ptr_array_add(muxer_msg_iter->active_muxer_upstream_msg_iters,
181 muxer_upstream_msg_iter);
182 BT_COMP_LOGD("Added muxer's upstream message iterator wrapper: "
183 "addr=%p, muxer-msg-iter-addr=%p, msg-iter-addr=%p",
184 muxer_upstream_msg_iter, muxer_msg_iter,
185 self_msg_iter);
186
187 goto end;
188
189 error:
190 g_free(muxer_upstream_msg_iter);
191 ret = -1;
192
193 end:
194 return ret;
195 }
196
197 static
198 bt_self_component_add_port_status add_available_input_port(
199 bt_self_component_filter *self_comp)
200 {
201 struct muxer_comp *muxer_comp = bt_self_component_get_data(
202 bt_self_component_filter_as_self_component(self_comp));
203 bt_self_component_add_port_status status =
204 BT_SELF_COMPONENT_ADD_PORT_STATUS_OK;
205 GString *port_name = NULL;
206
207 BT_ASSERT(muxer_comp);
208 port_name = g_string_new("in");
209 if (!port_name) {
210 BT_COMP_LOGE_STR("Failed to allocate a GString.");
211 status = BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR;
212 goto end;
213 }
214
215 g_string_append_printf(port_name, "%u", muxer_comp->next_port_num);
216 status = bt_self_component_filter_add_input_port(
217 self_comp, port_name->str, NULL, NULL);
218 if (status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
219 BT_COMP_LOGE("Cannot add input port to muxer component: "
220 "port-name=\"%s\", comp-addr=%p, status=%s",
221 port_name->str, self_comp,
222 bt_common_func_status_string(status));
223 goto end;
224 }
225
226 muxer_comp->available_input_ports++;
227 muxer_comp->next_port_num++;
228 BT_COMP_LOGI("Added one input port to muxer component: "
229 "port-name=\"%s\", comp-addr=%p",
230 port_name->str, self_comp);
231
232 end:
233 if (port_name) {
234 g_string_free(port_name, TRUE);
235 }
236
237 return status;
238 }
239
240 static
241 bt_self_component_add_port_status create_output_port(
242 bt_self_component_filter *self_comp)
243 {
244 return bt_self_component_filter_add_output_port(
245 self_comp, "out", NULL, NULL);
246 }
247
248 static
249 void destroy_muxer_comp(struct muxer_comp *muxer_comp)
250 {
251 if (!muxer_comp) {
252 return;
253 }
254
255 g_free(muxer_comp);
256 }
257
258 struct bt_param_validation_map_value_entry_descr muxer_params[] = {
259 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
260 };
261
262 BT_HIDDEN
263 bt_component_class_initialize_method_status muxer_init(
264 bt_self_component_filter *self_comp_flt,
265 bt_self_component_filter_configuration *config,
266 const bt_value *params, void *init_data)
267 {
268 bt_component_class_initialize_method_status status;
269 bt_self_component_add_port_status add_port_status;
270 bt_self_component *self_comp =
271 bt_self_component_filter_as_self_component(self_comp_flt);
272 struct muxer_comp *muxer_comp = g_new0(struct muxer_comp, 1);
273 bt_logging_level log_level = bt_component_get_logging_level(
274 bt_self_component_as_component(self_comp));
275 enum bt_param_validation_status validation_status;
276 gchar *validate_error = NULL;
277
278 BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
279 "Initializing muxer component: "
280 "comp-addr=%p, params-addr=%p", self_comp, params);
281
282 if (!muxer_comp) {
283 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
284 "Failed to allocate one muxer component.");
285 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
286 goto error;
287 }
288
289 muxer_comp->log_level = log_level;
290 muxer_comp->self_comp = self_comp;
291 muxer_comp->self_comp_flt = self_comp_flt;
292
293 validation_status = bt_param_validation_validate(params,
294 muxer_params, &validate_error);
295 if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
296 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
297 goto error;
298 } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
299 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
300 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validate_error);
301 goto error;
302 }
303
304 bt_self_component_set_data(self_comp, muxer_comp);
305 add_port_status = add_available_input_port(self_comp_flt);
306 if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
307 BT_COMP_LOGE("Cannot ensure that at least one muxer component's input port is available: "
308 "muxer-comp-addr=%p, status=%s",
309 muxer_comp,
310 bt_common_func_status_string(add_port_status));
311 status = (int) add_port_status;
312 goto error;
313 }
314
315 add_port_status = create_output_port(self_comp_flt);
316 if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
317 BT_COMP_LOGE("Cannot create muxer component's output port: "
318 "muxer-comp-addr=%p, status=%s",
319 muxer_comp,
320 bt_common_func_status_string(add_port_status));
321 status = (int) add_port_status;
322 goto error;
323 }
324
325 BT_COMP_LOGI("Initialized muxer component: "
326 "comp-addr=%p, params-addr=%p, muxer-comp-addr=%p",
327 self_comp, params, muxer_comp);
328
329 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
330 goto end;
331
332 error:
333 destroy_muxer_comp(muxer_comp);
334 bt_self_component_set_data(self_comp, NULL);
335
336 end:
337 g_free(validate_error);
338 return status;
339 }
340
341 BT_HIDDEN
342 void muxer_finalize(bt_self_component_filter *self_comp)
343 {
344 struct muxer_comp *muxer_comp = bt_self_component_get_data(
345 bt_self_component_filter_as_self_component(self_comp));
346
347 BT_COMP_LOGI("Finalizing muxer component: comp-addr=%p",
348 self_comp);
349 destroy_muxer_comp(muxer_comp);
350 }
351
352 static
353 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
354 create_msg_iter_on_input_port(struct muxer_comp *muxer_comp,
355 struct muxer_msg_iter *muxer_msg_iter,
356 bt_self_component_port_input *self_port,
357 bt_self_component_port_input_message_iterator **msg_iter)
358 {
359 const bt_port *port = bt_self_component_port_as_port(
360 bt_self_component_port_input_as_self_component_port(
361 self_port));
362 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
363 status;
364
365 BT_ASSERT(port);
366 BT_ASSERT(bt_port_is_connected(port));
367
368 // TODO: Advance the iterator to >= the time of the latest
369 // returned message by the muxer message
370 // iterator which creates it.
371 status = bt_self_component_port_input_message_iterator_create_from_message_iterator(
372 muxer_msg_iter->self_msg_iter, self_port, msg_iter);
373 if (status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK) {
374 BT_COMP_LOGE("Cannot create upstream message iterator on input port: "
375 "port-addr=%p, port-name=\"%s\"",
376 port, bt_port_get_name(port));
377 goto end;
378 }
379
380 BT_COMP_LOGI("Created upstream message iterator on input port: "
381 "port-addr=%p, port-name=\"%s\", msg-iter-addr=%p",
382 port, bt_port_get_name(port), msg_iter);
383
384 end:
385 return status;
386 }
387
388 static
389 bt_component_class_message_iterator_next_method_status muxer_upstream_msg_iter_next(
390 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
391 bool *is_ended)
392 {
393 struct muxer_comp *muxer_comp = muxer_upstream_msg_iter->muxer_comp;
394 bt_component_class_message_iterator_next_method_status status;
395 bt_message_iterator_next_status input_port_iter_status;
396 bt_message_array_const msgs;
397 uint64_t i;
398 uint64_t count;
399
400 BT_COMP_LOGD("Calling upstream message iterator's \"next\" method: "
401 "muxer-upstream-msg-iter-wrap-addr=%p, msg-iter-addr=%p",
402 muxer_upstream_msg_iter,
403 muxer_upstream_msg_iter->msg_iter);
404 input_port_iter_status = bt_self_component_port_input_message_iterator_next(
405 muxer_upstream_msg_iter->msg_iter, &msgs, &count);
406 BT_COMP_LOGD("Upstream message iterator's \"next\" method returned: "
407 "status=%s",
408 bt_common_func_status_string(input_port_iter_status));
409
410 switch (input_port_iter_status) {
411 case BT_MESSAGE_ITERATOR_NEXT_STATUS_OK:
412 /*
413 * Message iterator's current message is
414 * valid: it must be considered for muxing operations.
415 */
416 BT_COMP_LOGD_STR("Validated upstream message iterator wrapper.");
417 BT_ASSERT_DBG(count > 0);
418
419 /* Move messages to our queue */
420 for (i = 0; i < count; i++) {
421 /*
422 * Push to tail in order; other side
423 * (muxer_msg_iter_do_next_one()) consumes
424 * from the head first.
425 */
426 g_queue_push_tail(muxer_upstream_msg_iter->msgs,
427 (void *) msgs[i]);
428 }
429 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
430 break;
431 case BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN:
432 /*
433 * Message iterator's current message is not
434 * valid anymore. Return
435 * BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN immediately.
436 */
437 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN;
438 break;
439 case BT_MESSAGE_ITERATOR_NEXT_STATUS_END: /* Fall-through. */
440 /*
441 * Message iterator reached the end: release it. It
442 * won't be considered again to find the youngest
443 * message.
444 */
445 *is_ended = true;
446 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
447 break;
448 case BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR:
449 case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
450 /* Error status code */
451 BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
452 "Upstream iterator's next method returned an error: status=%s",
453 bt_common_func_status_string(input_port_iter_status));
454 status = (int) input_port_iter_status;
455 break;
456 default:
457 /* Unsupported status code */
458 BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
459 "Unsupported status code: status=%s",
460 bt_common_func_status_string(input_port_iter_status));
461 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
462 break;
463 }
464
465 return status;
466 }
467
468 static
469 int get_msg_ts_ns(struct muxer_comp *muxer_comp,
470 struct muxer_msg_iter *muxer_msg_iter,
471 const bt_message *msg, int64_t last_returned_ts_ns,
472 int64_t *ts_ns)
473 {
474 const bt_clock_snapshot *clock_snapshot = NULL;
475 int ret = 0;
476 const bt_stream_class *stream_class = NULL;
477 bt_message_type msg_type;
478
479 BT_ASSERT_DBG(msg);
480 BT_ASSERT_DBG(ts_ns);
481 BT_COMP_LOGD("Getting message's timestamp: "
482 "muxer-msg-iter-addr=%p, msg-addr=%p, "
483 "last-returned-ts=%" PRId64,
484 muxer_msg_iter, msg, last_returned_ts_ns);
485
486 if (G_UNLIKELY(muxer_msg_iter->clock_class_expectation ==
487 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE)) {
488 *ts_ns = last_returned_ts_ns;
489 goto end;
490 }
491
492 msg_type = bt_message_get_type(msg);
493
494 if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_PACKET_BEGINNING)) {
495 stream_class = bt_stream_borrow_class_const(
496 bt_packet_borrow_stream_const(
497 bt_message_packet_beginning_borrow_packet_const(
498 msg)));
499 } else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_PACKET_END)) {
500 stream_class = bt_stream_borrow_class_const(
501 bt_packet_borrow_stream_const(
502 bt_message_packet_end_borrow_packet_const(
503 msg)));
504 } else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_DISCARDED_EVENTS)) {
505 stream_class = bt_stream_borrow_class_const(
506 bt_message_discarded_events_borrow_stream_const(msg));
507 } else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_DISCARDED_PACKETS)) {
508 stream_class = bt_stream_borrow_class_const(
509 bt_message_discarded_packets_borrow_stream_const(msg));
510 }
511
512 switch (msg_type) {
513 case BT_MESSAGE_TYPE_EVENT:
514 BT_ASSERT_DBG(bt_message_event_borrow_stream_class_default_clock_class_const(
515 msg));
516 clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const(
517 msg);
518 break;
519 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
520 if (bt_stream_class_packets_have_beginning_default_clock_snapshot(
521 stream_class)) {
522 clock_snapshot = bt_message_packet_beginning_borrow_default_clock_snapshot_const(
523 msg);
524 } else {
525 goto no_clock_snapshot;
526 }
527
528 break;
529 case BT_MESSAGE_TYPE_PACKET_END:
530 if (bt_stream_class_packets_have_end_default_clock_snapshot(
531 stream_class)) {
532 clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const(
533 msg);
534 } else {
535 goto no_clock_snapshot;
536 }
537
538 break;
539 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
540 {
541 enum bt_message_stream_clock_snapshot_state snapshot_state =
542 bt_message_stream_beginning_borrow_default_clock_snapshot_const(
543 msg, &clock_snapshot);
544 if (snapshot_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_UNKNOWN) {
545 goto no_clock_snapshot;
546 }
547
548 break;
549 }
550 case BT_MESSAGE_TYPE_STREAM_END:
551 {
552 enum bt_message_stream_clock_snapshot_state snapshot_state =
553 bt_message_stream_end_borrow_default_clock_snapshot_const(
554 msg, &clock_snapshot);
555 if (snapshot_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_UNKNOWN) {
556 goto no_clock_snapshot;
557 }
558
559 break;
560 }
561 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
562 if (bt_stream_class_discarded_events_have_default_clock_snapshots(
563 stream_class)) {
564 clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
565 msg);
566 } else {
567 goto no_clock_snapshot;
568 }
569
570 break;
571 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
572 if (bt_stream_class_discarded_packets_have_default_clock_snapshots(
573 stream_class)) {
574 clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
575 msg);
576 } else {
577 goto no_clock_snapshot;
578 }
579
580 break;
581 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
582 clock_snapshot = bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
583 msg);
584 break;
585 default:
586 /* All the other messages have a higher priority */
587 BT_COMP_LOGD_STR("Message has no timestamp: using the last returned timestamp.");
588 *ts_ns = last_returned_ts_ns;
589 goto end;
590 }
591
592 ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, ts_ns);
593 if (ret) {
594 BT_COMP_LOGE("Cannot get nanoseconds from Epoch of clock snapshot: "
595 "clock-snapshot-addr=%p", clock_snapshot);
596 goto error;
597 }
598
599 goto end;
600
601 no_clock_snapshot:
602 BT_COMP_LOGD_STR("Message's default clock snapshot is missing: "
603 "using the last returned timestamp.");
604 *ts_ns = last_returned_ts_ns;
605 goto end;
606
607 error:
608 ret = -1;
609
610 end:
611 if (ret == 0) {
612 BT_COMP_LOGD("Found message's timestamp: "
613 "muxer-msg-iter-addr=%p, msg-addr=%p, "
614 "last-returned-ts=%" PRId64 ", ts=%" PRId64,
615 muxer_msg_iter, msg, last_returned_ts_ns,
616 *ts_ns);
617 }
618
619 return ret;
620 }
621
622 static inline
623 int validate_clock_class(struct muxer_msg_iter *muxer_msg_iter,
624 struct muxer_comp *muxer_comp,
625 const bt_clock_class *clock_class)
626 {
627 int ret = 0;
628 const uint8_t *cc_uuid;
629 const char *cc_name;
630
631 BT_ASSERT_DBG(clock_class);
632 cc_uuid = bt_clock_class_get_uuid(clock_class);
633 cc_name = bt_clock_class_get_name(clock_class);
634
635 if (muxer_msg_iter->clock_class_expectation ==
636 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY) {
637 /*
638 * This is the first clock class that this muxer message
639 * iterator encounters. Its properties determine what to expect
640 * for the whole lifetime of the iterator.
641 */
642 if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
643 /* Expect absolute clock classes */
644 muxer_msg_iter->clock_class_expectation =
645 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE;
646 } else {
647 if (cc_uuid) {
648 /*
649 * Expect non-absolute clock classes
650 * with a specific UUID.
651 */
652 muxer_msg_iter->clock_class_expectation =
653 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID;
654 bt_uuid_copy(muxer_msg_iter->expected_clock_class_uuid, cc_uuid);
655 } else {
656 /*
657 * Expect non-absolute clock classes
658 * with no UUID.
659 */
660 muxer_msg_iter->clock_class_expectation =
661 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID;
662 }
663 }
664 }
665
666 switch (muxer_msg_iter->clock_class_expectation) {
667 case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE:
668 if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
669 BT_COMP_LOGE("Expecting an absolute clock class, "
670 "but got a non-absolute one: "
671 "clock-class-addr=%p, clock-class-name=\"%s\"",
672 clock_class, cc_name);
673 goto error;
674 }
675 break;
676 case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID:
677 if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
678 BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
679 "but got an absolute one: "
680 "clock-class-addr=%p, clock-class-name=\"%s\"",
681 clock_class, cc_name);
682 goto error;
683 }
684
685 if (cc_uuid) {
686 BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
687 "but got one with a UUID: "
688 "clock-class-addr=%p, clock-class-name=\"%s\", "
689 "uuid=\"" BT_UUID_FMT "\"",
690 clock_class, cc_name, BT_UUID_FMT_VALUES(cc_uuid));
691 goto error;
692 }
693 break;
694 case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID:
695 if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
696 BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
697 "but got an absolute one: "
698 "clock-class-addr=%p, clock-class-name=\"%s\"",
699 clock_class, cc_name);
700 goto error;
701 }
702
703 if (!cc_uuid) {
704 BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
705 "but got one with no UUID: "
706 "clock-class-addr=%p, clock-class-name=\"%s\"",
707 clock_class, cc_name);
708 goto error;
709 }
710
711 if (bt_uuid_compare(muxer_msg_iter->expected_clock_class_uuid, cc_uuid) != 0) {
712 BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
713 "but got one with different UUID: "
714 "clock-class-addr=%p, clock-class-name=\"%s\", "
715 "expected-uuid=\"" BT_UUID_FMT "\", "
716 "uuid=\"" BT_UUID_FMT "\"",
717 clock_class, cc_name,
718 BT_UUID_FMT_VALUES(muxer_msg_iter->expected_clock_class_uuid),
719 BT_UUID_FMT_VALUES(cc_uuid));
720 goto error;
721 }
722 break;
723 case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE:
724 BT_COMP_LOGE("Expecting no clock class, but got one: "
725 "clock-class-addr=%p, clock-class-name=\"%s\"",
726 clock_class, cc_name);
727 goto error;
728 default:
729 /* Unexpected */
730 BT_COMP_LOGF("Unexpected clock class expectation: "
731 "expectation-code=%d",
732 muxer_msg_iter->clock_class_expectation);
733 bt_common_abort();
734 }
735
736 goto end;
737
738 error:
739 ret = -1;
740
741 end:
742 return ret;
743 }
744
745 static inline
746 int validate_new_stream_clock_class(struct muxer_msg_iter *muxer_msg_iter,
747 struct muxer_comp *muxer_comp, const bt_stream *stream)
748 {
749 int ret = 0;
750 const bt_stream_class *stream_class =
751 bt_stream_borrow_class_const(stream);
752 const bt_clock_class *clock_class =
753 bt_stream_class_borrow_default_clock_class_const(stream_class);
754
755 if (!clock_class) {
756 if (muxer_msg_iter->clock_class_expectation ==
757 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY) {
758 /* Expect no clock class */
759 muxer_msg_iter->clock_class_expectation =
760 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE;
761 } else if (muxer_msg_iter->clock_class_expectation !=
762 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE) {
763 BT_COMP_LOGE("Expecting stream class without a default clock class: "
764 "stream-class-addr=%p, stream-class-name=\"%s\", "
765 "stream-class-id=%" PRIu64,
766 stream_class, bt_stream_class_get_name(stream_class),
767 bt_stream_class_get_id(stream_class));
768 ret = -1;
769 }
770
771 goto end;
772 }
773
774 ret = validate_clock_class(muxer_msg_iter, muxer_comp, clock_class);
775
776 end:
777 return ret;
778 }
779
780 /*
781 * This function finds the youngest available message amongst the
782 * non-ended upstream message iterators and returns the upstream
783 * message iterator which has it, or
784 * BT_MESSAGE_ITERATOR_STATUS_END if there's no available
785 * message.
786 *
787 * This function does NOT:
788 *
789 * * Update any upstream message iterator.
790 * * Check the upstream message iterators to retry.
791 *
792 * On sucess, this function sets *muxer_upstream_msg_iter to the
793 * upstream message iterator of which the current message is
794 * the youngest, and sets *ts_ns to its time.
795 */
796 static
797 bt_component_class_message_iterator_next_method_status
798 muxer_msg_iter_youngest_upstream_msg_iter(
799 struct muxer_comp *muxer_comp,
800 struct muxer_msg_iter *muxer_msg_iter,
801 struct muxer_upstream_msg_iter **muxer_upstream_msg_iter,
802 int64_t *ts_ns)
803 {
804 size_t i;
805 int ret;
806 int64_t youngest_ts_ns = INT64_MAX;
807 bt_component_class_message_iterator_next_method_status status =
808 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
809
810 BT_ASSERT_DBG(muxer_comp);
811 BT_ASSERT_DBG(muxer_msg_iter);
812 BT_ASSERT_DBG(muxer_upstream_msg_iter);
813 *muxer_upstream_msg_iter = NULL;
814
815 for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
816 i++) {
817 const bt_message *msg;
818 struct muxer_upstream_msg_iter *cur_muxer_upstream_msg_iter =
819 g_ptr_array_index(
820 muxer_msg_iter->active_muxer_upstream_msg_iters,
821 i);
822 int64_t msg_ts_ns;
823
824 if (!cur_muxer_upstream_msg_iter->msg_iter) {
825 /* This upstream message iterator is ended */
826 BT_COMP_LOGT("Skipping ended upstream message iterator: "
827 "muxer-upstream-msg-iter-wrap-addr=%p",
828 cur_muxer_upstream_msg_iter);
829 continue;
830 }
831
832 BT_ASSERT_DBG(cur_muxer_upstream_msg_iter->msgs->length > 0);
833 msg = g_queue_peek_head(cur_muxer_upstream_msg_iter->msgs);
834 BT_ASSERT_DBG(msg);
835
836 if (G_UNLIKELY(bt_message_get_type(msg) ==
837 BT_MESSAGE_TYPE_STREAM_BEGINNING)) {
838 ret = validate_new_stream_clock_class(
839 muxer_msg_iter, muxer_comp,
840 bt_message_stream_beginning_borrow_stream_const(
841 msg));
842 if (ret) {
843 /*
844 * validate_new_stream_clock_class() logs
845 * errors.
846 */
847 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
848 goto end;
849 }
850 } else if (G_UNLIKELY(bt_message_get_type(msg) ==
851 BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY)) {
852 const bt_clock_snapshot *cs;
853
854 cs = bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
855 msg);
856 ret = validate_clock_class(muxer_msg_iter, muxer_comp,
857 bt_clock_snapshot_borrow_clock_class_const(cs));
858 if (ret) {
859 /* validate_clock_class() logs errors */
860 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
861 goto end;
862 }
863 }
864
865 ret = get_msg_ts_ns(muxer_comp, muxer_msg_iter, msg,
866 muxer_msg_iter->last_returned_ts_ns, &msg_ts_ns);
867 if (ret) {
868 /* get_msg_ts_ns() logs errors */
869 *muxer_upstream_msg_iter = NULL;
870 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
871 goto end;
872 }
873
874 /*
875 * Update the current message iterator if it has not been set
876 * yet, or if its current message has a timestamp smaller than
877 * the previously selected youngest message.
878 */
879 if (G_UNLIKELY(*muxer_upstream_msg_iter == NULL) ||
880 msg_ts_ns < youngest_ts_ns) {
881 *muxer_upstream_msg_iter =
882 cur_muxer_upstream_msg_iter;
883 youngest_ts_ns = msg_ts_ns;
884 *ts_ns = youngest_ts_ns;
885 } else if (msg_ts_ns == youngest_ts_ns) {
886 /*
887 * The currently selected message to be sent downstream
888 * next has the exact same timestamp that of the
889 * current candidate message. We must break the tie
890 * in a predictable manner.
891 */
892 const bt_message *selected_msg = g_queue_peek_head(
893 (*muxer_upstream_msg_iter)->msgs);
894 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
895
896 /*
897 * Order the messages in an arbitrary but determinitic
898 * way.
899 */
900 ret = common_muxing_compare_messages(msg, selected_msg);
901 if (ret < 0) {
902 /*
903 * The `msg` should go first. Update the next
904 * iterator and the current timestamp.
905 */
906 *muxer_upstream_msg_iter =
907 cur_muxer_upstream_msg_iter;
908 youngest_ts_ns = msg_ts_ns;
909 *ts_ns = youngest_ts_ns;
910 } else if (ret == 0) {
911 /* Unable to pick which one should go first. */
912 BT_COMP_LOGW("Cannot deterministically pick next upstream message iterator because they have identical next messages: "
913 "muxer-upstream-msg-iter-wrap-addr=%p"
914 "cur-muxer-upstream-msg-iter-wrap-addr=%p",
915 *muxer_upstream_msg_iter,
916 cur_muxer_upstream_msg_iter);
917 }
918 }
919 }
920
921 if (!*muxer_upstream_msg_iter) {
922 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END;
923 *ts_ns = INT64_MIN;
924 }
925
926 end:
927 return status;
928 }
929
930 static
931 bt_component_class_message_iterator_next_method_status
932 validate_muxer_upstream_msg_iter(
933 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
934 bool *is_ended)
935 {
936 struct muxer_comp *muxer_comp = muxer_upstream_msg_iter->muxer_comp;
937 bt_component_class_message_iterator_next_method_status status;
938
939 BT_COMP_LOGD("Validating muxer's upstream message iterator wrapper: "
940 "muxer-upstream-msg-iter-wrap-addr=%p",
941 muxer_upstream_msg_iter);
942
943 if (muxer_upstream_msg_iter->msgs->length > 0 ||
944 !muxer_upstream_msg_iter->msg_iter) {
945 BT_COMP_LOGD("Already valid or not considered: "
946 "queue-len=%u, upstream-msg-iter-addr=%p",
947 muxer_upstream_msg_iter->msgs->length,
948 muxer_upstream_msg_iter->msg_iter);
949 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
950 goto end;
951 }
952
953 /* muxer_upstream_msg_iter_next() logs details/errors */
954 status = muxer_upstream_msg_iter_next(muxer_upstream_msg_iter,
955 is_ended);
956
957 end:
958 return status;
959 }
960
961 static
962 bt_component_class_message_iterator_next_method_status
963 validate_muxer_upstream_msg_iters(
964 struct muxer_msg_iter *muxer_msg_iter)
965 {
966 struct muxer_comp *muxer_comp = muxer_msg_iter->muxer_comp;
967 bt_component_class_message_iterator_next_method_status status;
968 size_t i;
969
970 BT_COMP_LOGD("Validating muxer's upstream message iterator wrappers: "
971 "muxer-msg-iter-addr=%p", muxer_msg_iter);
972
973 for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
974 i++) {
975 bool is_ended = false;
976 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter =
977 g_ptr_array_index(
978 muxer_msg_iter->active_muxer_upstream_msg_iters,
979 i);
980
981 status = validate_muxer_upstream_msg_iter(
982 muxer_upstream_msg_iter, &is_ended);
983 if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
984 if (status < 0) {
985 BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
986 "Cannot validate muxer's upstream message iterator wrapper: "
987 "muxer-msg-iter-addr=%p, "
988 "muxer-upstream-msg-iter-wrap-addr=%p",
989 muxer_msg_iter,
990 muxer_upstream_msg_iter);
991 } else {
992 BT_COMP_LOGD("Cannot validate muxer's upstream message iterator wrapper: "
993 "muxer-msg-iter-addr=%p, "
994 "muxer-upstream-msg-iter-wrap-addr=%p",
995 muxer_msg_iter,
996 muxer_upstream_msg_iter);
997 }
998
999 goto end;
1000 }
1001
1002 /*
1003 * Move this muxer upstream message iterator to the
1004 * array of ended iterators if it's ended.
1005 */
1006 if (G_UNLIKELY(is_ended)) {
1007 BT_COMP_LOGD("Muxer's upstream message iterator wrapper: ended or canceled: "
1008 "muxer-msg-iter-addr=%p, "
1009 "muxer-upstream-msg-iter-wrap-addr=%p",
1010 muxer_msg_iter, muxer_upstream_msg_iter);
1011 g_ptr_array_add(
1012 muxer_msg_iter->ended_muxer_upstream_msg_iters,
1013 muxer_upstream_msg_iter);
1014 muxer_msg_iter->active_muxer_upstream_msg_iters->pdata[i] = NULL;
1015
1016 /*
1017 * Use g_ptr_array_remove_fast() because the
1018 * order of those elements is not important.
1019 */
1020 g_ptr_array_remove_index_fast(
1021 muxer_msg_iter->active_muxer_upstream_msg_iters,
1022 i);
1023 i--;
1024 }
1025 }
1026
1027 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
1028
1029 end:
1030 return status;
1031 }
1032
1033 static inline
1034 bt_component_class_message_iterator_next_method_status muxer_msg_iter_do_next_one(
1035 struct muxer_comp *muxer_comp,
1036 struct muxer_msg_iter *muxer_msg_iter,
1037 const bt_message **msg)
1038 {
1039 bt_component_class_message_iterator_next_method_status status;
1040 struct muxer_upstream_msg_iter *muxer_upstream_msg_iter = NULL;
1041 int64_t next_return_ts;
1042
1043 status = validate_muxer_upstream_msg_iters(muxer_msg_iter);
1044 if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
1045 /* validate_muxer_upstream_msg_iters() logs details */
1046 goto end;
1047 }
1048
1049 /*
1050 * At this point we know that all the existing upstream
1051 * message iterators are valid. We can find the one,
1052 * amongst those, of which the current message is the
1053 * youngest.
1054 */
1055 status = muxer_msg_iter_youngest_upstream_msg_iter(muxer_comp,
1056 muxer_msg_iter, &muxer_upstream_msg_iter,
1057 &next_return_ts);
1058 if (status < 0 || status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END) {
1059 if (status < 0) {
1060 BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
1061 "Cannot find the youngest upstream message iterator wrapper: "
1062 "status=%s",
1063 bt_common_func_status_string(status));
1064 } else {
1065 BT_COMP_LOGD("Cannot find the youngest upstream message iterator wrapper: "
1066 "status=%s",
1067 bt_common_func_status_string(status));
1068 }
1069
1070 goto end;
1071 }
1072
1073 if (next_return_ts < muxer_msg_iter->last_returned_ts_ns) {
1074 BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
1075 "Youngest upstream message iterator wrapper's timestamp is less than muxer's message iterator's last returned timestamp: "
1076 "muxer-msg-iter-addr=%p, ts=%" PRId64 ", "
1077 "last-returned-ts=%" PRId64,
1078 muxer_msg_iter, next_return_ts,
1079 muxer_msg_iter->last_returned_ts_ns);
1080 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
1081 goto end;
1082 }
1083
1084 BT_COMP_LOGD("Found youngest upstream message iterator wrapper: "
1085 "muxer-msg-iter-addr=%p, "
1086 "muxer-upstream-msg-iter-wrap-addr=%p, "
1087 "ts=%" PRId64,
1088 muxer_msg_iter, muxer_upstream_msg_iter, next_return_ts);
1089 BT_ASSERT_DBG(status ==
1090 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK);
1091 BT_ASSERT_DBG(muxer_upstream_msg_iter);
1092
1093 /*
1094 * Consume from the queue's head: other side
1095 * (muxer_upstream_msg_iter_next()) writes to the tail.
1096 */
1097 *msg = g_queue_pop_head(muxer_upstream_msg_iter->msgs);
1098 BT_ASSERT_DBG(*msg);
1099 muxer_msg_iter->last_returned_ts_ns = next_return_ts;
1100
1101 end:
1102 return status;
1103 }
1104
1105 static
1106 bt_component_class_message_iterator_next_method_status muxer_msg_iter_do_next(
1107 struct muxer_comp *muxer_comp,
1108 struct muxer_msg_iter *muxer_msg_iter,
1109 bt_message_array_const msgs, uint64_t capacity,
1110 uint64_t *count)
1111 {
1112 bt_component_class_message_iterator_next_method_status status;
1113 uint64_t i = 0;
1114
1115 if (G_UNLIKELY(muxer_msg_iter->next_saved_error)) {
1116 /*
1117 * Last time we were called, we hit an error but had some
1118 * messages to deliver, so we stashed the error here. Return
1119 * it now.
1120 */
1121 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(muxer_msg_iter->next_saved_error);
1122 status = muxer_msg_iter->next_saved_status;
1123 goto end;
1124 }
1125
1126 do {
1127 status = muxer_msg_iter_do_next_one(muxer_comp,
1128 muxer_msg_iter, &msgs[i]);
1129 if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
1130 i++;
1131 }
1132 } while (i < capacity && status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK);
1133
1134 if (i > 0) {
1135 /*
1136 * Even if muxer_msg_iter_do_next_one() returned
1137 * something else than
1138 * BT_MESSAGE_ITERATOR_STATUS_OK, we accumulated
1139 * message objects in the output message
1140 * array, so we need to return
1141 * BT_MESSAGE_ITERATOR_STATUS_OK so that they are
1142 * transfered to downstream. This other status occurs
1143 * again the next time muxer_msg_iter_do_next() is
1144 * called, possibly without any accumulated
1145 * message, in which case we'll return it.
1146 */
1147 if (status < 0) {
1148 /*
1149 * Save this error for the next _next call. Assume that
1150 * this component always appends error causes when
1151 * returning an error status code, which will cause the
1152 * current thread error to be non-NULL.
1153 */
1154 muxer_msg_iter->next_saved_error = bt_current_thread_take_error();
1155 BT_ASSERT(muxer_msg_iter->next_saved_error);
1156 muxer_msg_iter->next_saved_status = status;
1157 }
1158
1159 *count = i;
1160 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
1161 }
1162
1163 end:
1164 return status;
1165 }
1166
1167 static
1168 void destroy_muxer_msg_iter(struct muxer_msg_iter *muxer_msg_iter)
1169 {
1170 struct muxer_comp *muxer_comp;
1171
1172 if (!muxer_msg_iter) {
1173 return;
1174 }
1175
1176 muxer_comp = muxer_msg_iter->muxer_comp;
1177 BT_COMP_LOGD("Destroying muxer component's message iterator: "
1178 "muxer-msg-iter-addr=%p", muxer_msg_iter);
1179
1180 if (muxer_msg_iter->active_muxer_upstream_msg_iters) {
1181 BT_COMP_LOGD_STR("Destroying muxer's active upstream message iterator wrappers.");
1182 g_ptr_array_free(
1183 muxer_msg_iter->active_muxer_upstream_msg_iters, TRUE);
1184 }
1185
1186 if (muxer_msg_iter->ended_muxer_upstream_msg_iters) {
1187 BT_COMP_LOGD_STR("Destroying muxer's ended upstream message iterator wrappers.");
1188 g_ptr_array_free(
1189 muxer_msg_iter->ended_muxer_upstream_msg_iters, TRUE);
1190 }
1191
1192 g_free(muxer_msg_iter);
1193 }
1194
1195 static
1196 bt_component_class_message_iterator_initialize_method_status
1197 muxer_msg_iter_init_upstream_iterators(struct muxer_comp *muxer_comp,
1198 struct muxer_msg_iter *muxer_msg_iter,
1199 struct bt_self_message_iterator_configuration *config)
1200 {
1201 int64_t count;
1202 int64_t i;
1203 bt_component_class_message_iterator_initialize_method_status status;
1204 bool can_seek_forward = true;
1205
1206 count = bt_component_filter_get_input_port_count(
1207 bt_self_component_filter_as_component_filter(
1208 muxer_comp->self_comp_flt));
1209 if (count < 0) {
1210 BT_COMP_LOGD("No input port to initialize for muxer component's message iterator: "
1211 "muxer-comp-addr=%p, muxer-msg-iter-addr=%p",
1212 muxer_comp, muxer_msg_iter);
1213 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK;
1214 goto end;
1215 }
1216
1217 for (i = 0; i < count; i++) {
1218 bt_self_component_port_input_message_iterator *upstream_msg_iter;
1219 bt_self_component_port_input *self_port =
1220 bt_self_component_filter_borrow_input_port_by_index(
1221 muxer_comp->self_comp_flt, i);
1222 const bt_port *port;
1223 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
1224 msg_iter_status;
1225 int int_status;
1226
1227 BT_ASSERT(self_port);
1228 port = bt_self_component_port_as_port(
1229 bt_self_component_port_input_as_self_component_port(
1230 self_port));
1231 BT_ASSERT(port);
1232
1233 if (!bt_port_is_connected(port)) {
1234 /* Skip non-connected port */
1235 continue;
1236 }
1237
1238 msg_iter_status = create_msg_iter_on_input_port(muxer_comp,
1239 muxer_msg_iter, self_port, &upstream_msg_iter);
1240 if (msg_iter_status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK) {
1241 /* create_msg_iter_on_input_port() logs errors */
1242 status = (int) msg_iter_status;
1243 goto end;
1244 }
1245
1246 int_status = muxer_msg_iter_add_upstream_msg_iter(muxer_msg_iter,
1247 upstream_msg_iter);
1248 bt_self_component_port_input_message_iterator_put_ref(
1249 upstream_msg_iter);
1250 if (int_status) {
1251 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
1252 /* muxer_msg_iter_add_upstream_msg_iter() logs errors */
1253 goto end;
1254 }
1255
1256 can_seek_forward = can_seek_forward &&
1257 bt_self_component_port_input_message_iterator_can_seek_forward(
1258 upstream_msg_iter);
1259 }
1260
1261 /*
1262 * This iterator can seek forward if all of its iterators can seek
1263 * forward.
1264 */
1265 bt_self_message_iterator_configuration_set_can_seek_forward(
1266 config, can_seek_forward);
1267
1268 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK;
1269
1270 end:
1271 return status;
1272 }
1273
1274 BT_HIDDEN
1275 bt_component_class_message_iterator_initialize_method_status muxer_msg_iter_init(
1276 bt_self_message_iterator *self_msg_iter,
1277 bt_self_message_iterator_configuration *config,
1278 bt_self_component_filter *self_comp,
1279 bt_self_component_port_output *port)
1280 {
1281 struct muxer_comp *muxer_comp = NULL;
1282 struct muxer_msg_iter *muxer_msg_iter = NULL;
1283 bt_component_class_message_iterator_initialize_method_status status;
1284
1285 muxer_comp = bt_self_component_get_data(
1286 bt_self_component_filter_as_self_component(self_comp));
1287 BT_ASSERT(muxer_comp);
1288 BT_COMP_LOGD("Initializing muxer component's message iterator: "
1289 "comp-addr=%p, muxer-comp-addr=%p, msg-iter-addr=%p",
1290 self_comp, muxer_comp, self_msg_iter);
1291
1292 if (muxer_comp->initializing_muxer_msg_iter) {
1293 /*
1294 * Weird, unhandled situation detected: downstream
1295 * creates a muxer message iterator while creating
1296 * another muxer message iterator (same component).
1297 */
1298 BT_COMP_LOGE("Recursive initialization of muxer component's message iterator: "
1299 "comp-addr=%p, muxer-comp-addr=%p, msg-iter-addr=%p",
1300 self_comp, muxer_comp, self_msg_iter);
1301 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
1302 goto error;
1303 }
1304
1305 muxer_comp->initializing_muxer_msg_iter = true;
1306 muxer_msg_iter = g_new0(struct muxer_msg_iter, 1);
1307 if (!muxer_msg_iter) {
1308 BT_COMP_LOGE_STR("Failed to allocate one muxer component's message iterator.");
1309 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1310 goto error;
1311 }
1312
1313 muxer_msg_iter->muxer_comp = muxer_comp;
1314 muxer_msg_iter->self_msg_iter = self_msg_iter;
1315 muxer_msg_iter->last_returned_ts_ns = INT64_MIN;
1316 muxer_msg_iter->active_muxer_upstream_msg_iters =
1317 g_ptr_array_new_with_free_func(
1318 (GDestroyNotify) destroy_muxer_upstream_msg_iter);
1319 if (!muxer_msg_iter->active_muxer_upstream_msg_iters) {
1320 BT_COMP_LOGE_STR("Failed to allocate a GPtrArray.");
1321 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1322 goto error;
1323 }
1324
1325 muxer_msg_iter->ended_muxer_upstream_msg_iters =
1326 g_ptr_array_new_with_free_func(
1327 (GDestroyNotify) destroy_muxer_upstream_msg_iter);
1328 if (!muxer_msg_iter->ended_muxer_upstream_msg_iters) {
1329 BT_COMP_LOGE_STR("Failed to allocate a GPtrArray.");
1330 status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1331 goto error;
1332 }
1333
1334 status = muxer_msg_iter_init_upstream_iterators(muxer_comp,
1335 muxer_msg_iter, config);
1336 if (status) {
1337 BT_COMP_LOGE("Cannot initialize connected input ports for muxer component's message iterator: "
1338 "comp-addr=%p, muxer-comp-addr=%p, "
1339 "muxer-msg-iter-addr=%p, msg-iter-addr=%p, ret=%d",
1340 self_comp, muxer_comp, muxer_msg_iter,
1341 self_msg_iter, status);
1342 goto error;
1343 }
1344
1345 bt_self_message_iterator_set_data(self_msg_iter, muxer_msg_iter);
1346 BT_COMP_LOGD("Initialized muxer component's message iterator: "
1347 "comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
1348 "msg-iter-addr=%p",
1349 self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);
1350 goto end;
1351
1352 error:
1353 destroy_muxer_msg_iter(muxer_msg_iter);
1354 bt_self_message_iterator_set_data(self_msg_iter, NULL);
1355
1356 end:
1357 muxer_comp->initializing_muxer_msg_iter = false;
1358 return status;
1359 }
1360
1361 BT_HIDDEN
1362 void muxer_msg_iter_finalize(bt_self_message_iterator *self_msg_iter)
1363 {
1364 struct muxer_msg_iter *muxer_msg_iter =
1365 bt_self_message_iterator_get_data(self_msg_iter);
1366 bt_self_component *self_comp = NULL;
1367 struct muxer_comp *muxer_comp = NULL;
1368
1369 self_comp = bt_self_message_iterator_borrow_component(
1370 self_msg_iter);
1371 BT_ASSERT(self_comp);
1372 muxer_comp = bt_self_component_get_data(self_comp);
1373 BT_COMP_LOGD("Finalizing muxer component's message iterator: "
1374 "comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
1375 "msg-iter-addr=%p",
1376 self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);
1377
1378 if (muxer_msg_iter) {
1379 destroy_muxer_msg_iter(muxer_msg_iter);
1380 }
1381 }
1382
1383 BT_HIDDEN
1384 bt_component_class_message_iterator_next_method_status muxer_msg_iter_next(
1385 bt_self_message_iterator *self_msg_iter,
1386 bt_message_array_const msgs, uint64_t capacity,
1387 uint64_t *count)
1388 {
1389 bt_component_class_message_iterator_next_method_status status;
1390 struct muxer_msg_iter *muxer_msg_iter =
1391 bt_self_message_iterator_get_data(self_msg_iter);
1392 bt_self_component *self_comp = NULL;
1393 struct muxer_comp *muxer_comp = NULL;
1394
1395 BT_ASSERT_DBG(muxer_msg_iter);
1396 self_comp = bt_self_message_iterator_borrow_component(
1397 self_msg_iter);
1398 BT_ASSERT_DBG(self_comp);
1399 muxer_comp = bt_self_component_get_data(self_comp);
1400 BT_ASSERT_DBG(muxer_comp);
1401 BT_COMP_LOGT("Muxer component's message iterator's \"next\" method called: "
1402 "comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
1403 "msg-iter-addr=%p",
1404 self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);
1405
1406 status = muxer_msg_iter_do_next(muxer_comp, muxer_msg_iter,
1407 msgs, capacity, count);
1408 if (status < 0) {
1409 BT_COMP_LOGE("Cannot get next message: "
1410 "comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
1411 "msg-iter-addr=%p, status=%s",
1412 self_comp, muxer_comp, muxer_msg_iter, self_msg_iter,
1413 bt_common_func_status_string(status));
1414 } else {
1415 BT_COMP_LOGT("Returning from muxer component's message iterator's \"next\" method: "
1416 "status=%s",
1417 bt_common_func_status_string(status));
1418 }
1419
1420 return status;
1421 }
1422
1423 BT_HIDDEN
1424 bt_component_class_port_connected_method_status muxer_input_port_connected(
1425 bt_self_component_filter *self_comp,
1426 bt_self_component_port_input *self_port,
1427 const bt_port_output *other_port)
1428 {
1429 bt_component_class_port_connected_method_status status =
1430 BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK;
1431 bt_self_component_add_port_status add_port_status;
1432 struct muxer_comp *muxer_comp = bt_self_component_get_data(
1433 bt_self_component_filter_as_self_component(self_comp));
1434
1435 add_port_status = add_available_input_port(self_comp);
1436 if (add_port_status) {
1437 BT_COMP_LOGE("Cannot add one muxer component's input port: "
1438 "status=%s",
1439 bt_common_func_status_string(status));
1440
1441 if (add_port_status ==
1442 BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR) {
1443 status = BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR;
1444 } else {
1445 status = BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR;
1446 }
1447
1448 goto end;
1449 }
1450
1451 end:
1452 return status;
1453 }
1454
1455 static inline
1456 bt_component_class_message_iterator_can_seek_beginning_method_status
1457 muxer_upstream_msg_iters_can_all_seek_beginning(
1458 GPtrArray *muxer_upstream_msg_iters, bt_bool *can_seek)
1459 {
1460 bt_component_class_message_iterator_can_seek_beginning_method_status status =
1461 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK;
1462 uint64_t i;
1463
1464 for (i = 0; i < muxer_upstream_msg_iters->len; i++) {
1465 struct muxer_upstream_msg_iter *upstream_msg_iter =
1466 muxer_upstream_msg_iters->pdata[i];
1467 status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
1468 upstream_msg_iter->msg_iter, can_seek);
1469 if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK) {
1470 goto end;
1471 }
1472
1473 if (!*can_seek) {
1474 goto end;
1475 }
1476 }
1477
1478 *can_seek = BT_TRUE;
1479
1480 end:
1481 return status;
1482 }
1483
1484 BT_HIDDEN
1485 bt_component_class_message_iterator_can_seek_beginning_method_status
1486 muxer_msg_iter_can_seek_beginning(
1487 bt_self_message_iterator *self_msg_iter, bt_bool *can_seek)
1488 {
1489 struct muxer_msg_iter *muxer_msg_iter =
1490 bt_self_message_iterator_get_data(self_msg_iter);
1491 bt_component_class_message_iterator_can_seek_beginning_method_status status;
1492
1493 status = muxer_upstream_msg_iters_can_all_seek_beginning(
1494 muxer_msg_iter->active_muxer_upstream_msg_iters, can_seek);
1495 if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK) {
1496 goto end;
1497 }
1498
1499 if (!*can_seek) {
1500 goto end;
1501 }
1502
1503 status = muxer_upstream_msg_iters_can_all_seek_beginning(
1504 muxer_msg_iter->ended_muxer_upstream_msg_iters, can_seek);
1505
1506 end:
1507 return status;
1508 }
1509
1510 BT_HIDDEN
1511 bt_component_class_message_iterator_seek_beginning_method_status muxer_msg_iter_seek_beginning(
1512 bt_self_message_iterator *self_msg_iter)
1513 {
1514 struct muxer_msg_iter *muxer_msg_iter =
1515 bt_self_message_iterator_get_data(self_msg_iter);
1516 bt_component_class_message_iterator_seek_beginning_method_status status =
1517 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK;
1518 bt_message_iterator_seek_beginning_status seek_beg_status;
1519 uint64_t i;
1520
1521 /* Seek all ended upstream iterators first */
1522 for (i = 0; i < muxer_msg_iter->ended_muxer_upstream_msg_iters->len;
1523 i++) {
1524 struct muxer_upstream_msg_iter *upstream_msg_iter =
1525 muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i];
1526
1527 seek_beg_status = bt_self_component_port_input_message_iterator_seek_beginning(
1528 upstream_msg_iter->msg_iter);
1529 if (seek_beg_status != BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK) {
1530 status = (int) seek_beg_status;
1531 goto end;
1532 }
1533
1534 empty_message_queue(upstream_msg_iter);
1535 }
1536
1537 /* Seek all previously active upstream iterators */
1538 for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
1539 i++) {
1540 struct muxer_upstream_msg_iter *upstream_msg_iter =
1541 muxer_msg_iter->active_muxer_upstream_msg_iters->pdata[i];
1542
1543 seek_beg_status = bt_self_component_port_input_message_iterator_seek_beginning(
1544 upstream_msg_iter->msg_iter);
1545 if (seek_beg_status != BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK) {
1546 status = (int) seek_beg_status;
1547 goto end;
1548 }
1549
1550 empty_message_queue(upstream_msg_iter);
1551 }
1552
1553 /* Make them all active */
1554 for (i = 0; i < muxer_msg_iter->ended_muxer_upstream_msg_iters->len;
1555 i++) {
1556 struct muxer_upstream_msg_iter *upstream_msg_iter =
1557 muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i];
1558
1559 g_ptr_array_add(muxer_msg_iter->active_muxer_upstream_msg_iters,
1560 upstream_msg_iter);
1561 muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i] = NULL;
1562 }
1563
1564 /*
1565 * GLib < 2.48.0 asserts when g_ptr_array_remove_range() is
1566 * called on an empty array.
1567 */
1568 if (muxer_msg_iter->ended_muxer_upstream_msg_iters->len > 0) {
1569 g_ptr_array_remove_range(muxer_msg_iter->ended_muxer_upstream_msg_iters,
1570 0, muxer_msg_iter->ended_muxer_upstream_msg_iters->len);
1571 }
1572 muxer_msg_iter->last_returned_ts_ns = INT64_MIN;
1573 muxer_msg_iter->clock_class_expectation =
1574 MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY;
1575
1576 end:
1577 return status;
1578 }
BabelTrace - Trace Format Babel Tower
This page took 0.061922 seconds and 3 git commands to generate.