Make API CTF-agnostic
[babeltrace.git] / plugins / utils / muxer / muxer.c
index 1f87b2162b3b73b6a9e43b515df094a4bea2504c..c75b5d9bbfd801b47dfea8366d923913a92f56f2 100644 (file)
@@ -52,7 +52,6 @@ struct muxer_comp {
        struct bt_private_component *priv_comp;
        unsigned int next_port_num;
        size_t available_input_ports;
-       bool error;
        bool initializing_muxer_notif_iter;
        bool assume_absolute_clock_classes;
 };
@@ -61,18 +60,8 @@ struct muxer_upstream_notif_iter {
        /* Owned by this, NULL if ended */
        struct bt_notification_iterator *notif_iter;
 
-       /*
-        * This flag is true if the upstream notification iterator's
-        * current notification must be considered for the multiplexing
-        * operations. If the upstream iterator returns
-        * BT_NOTIFICATION_ITERATOR_STATUS_AGAIN, then this object
-        * is considered invalid, because its current notification is
-        * still the previous one, but we already took it into account.
-        *
-        * The value of this flag is not important if notif_iter above
-        * is NULL (which means the upstream iterator is finished).
-        */
-       bool is_valid;
+       /* Contains `struct bt_notification *`, owned by this */
+       GQueue *notifs;
 };
 
 enum muxer_notif_iter_clock_class_expectation {
@@ -104,9 +93,6 @@ struct muxer_notif_iter {
         */
        GList *newly_connected_priv_ports;
 
-       /* Next thing to return by the "next" method */
-       struct bt_notification_iterator_next_method_return next_next_return;
-
        /* Last time returned in a notification */
        int64_t last_returned_ts_ns;
 
@@ -130,11 +116,23 @@ void destroy_muxer_upstream_notif_iter(
        }
 
        BT_LOGD("Destroying muxer's upstream notification iterator wrapper: "
-               "addr=%p, notif-iter-addr=%p, is-valid=%d",
+               "addr=%p, notif-iter-addr=%p, queue-len=%u",
                muxer_upstream_notif_iter,
                muxer_upstream_notif_iter->notif_iter,
-               muxer_upstream_notif_iter->is_valid);
+               muxer_upstream_notif_iter->notifs->length);
        bt_put(muxer_upstream_notif_iter->notif_iter);
+
+       if (muxer_upstream_notif_iter->notifs) {
+               struct bt_notification *notif;
+
+               while ((notif = g_queue_pop_head(
+                               muxer_upstream_notif_iter->notifs))) {
+                       bt_put(notif);
+               }
+
+               g_queue_free(muxer_upstream_notif_iter->notifs);
+       }
+
        g_free(muxer_upstream_notif_iter);
 }
 
@@ -153,7 +151,13 @@ struct muxer_upstream_notif_iter *muxer_notif_iter_add_upstream_notif_iter(
        }
 
        muxer_upstream_notif_iter->notif_iter = bt_get(notif_iter);
-       muxer_upstream_notif_iter->is_valid = false;
+       muxer_upstream_notif_iter->notifs = g_queue_new();
+       if (!muxer_upstream_notif_iter->notifs) {
+               BT_LOGE_STR("Failed to allocate a GQueue.");
+
+               goto end;
+       }
+
        g_ptr_array_add(muxer_notif_iter->muxer_upstream_notif_iters,
                muxer_upstream_notif_iter);
        BT_LOGD("Added muxer's upstream notification iterator wrapper: "
@@ -448,34 +452,45 @@ enum bt_notification_iterator_status muxer_upstream_notif_iter_next(
                struct muxer_upstream_notif_iter *muxer_upstream_notif_iter)
 {
        enum bt_notification_iterator_status status;
+       bt_notification_array notifs;
+       uint64_t i;
+       uint64_t count;
 
        BT_LOGV("Calling upstream notification iterator's \"next\" method: "
                "muxer-upstream-notif-iter-wrap-addr=%p, notif-iter-addr=%p",
                muxer_upstream_notif_iter,
                muxer_upstream_notif_iter->notif_iter);
-       status = bt_notification_iterator_next(
-               muxer_upstream_notif_iter->notif_iter);
+       status = bt_private_connection_notification_iterator_next(
+               muxer_upstream_notif_iter->notif_iter, &notifs, &count);
        BT_LOGV("Upstream notification iterator's \"next\" method returned: "
                "status=%s", bt_notification_iterator_status_string(status));
 
        switch (status) {
        case BT_NOTIFICATION_ITERATOR_STATUS_OK:
                /*
-                * Notification iterator's current notification is valid:
-                * it must be considered for muxing operations.
+                * Notification iterator's current notification is
+                * valid: it must be considered for muxing operations.
                 */
                BT_LOGV_STR("Validated upstream notification iterator wrapper.");
-               muxer_upstream_notif_iter->is_valid = true;
+               BT_ASSERT(count > 0);
+
+               /* Move notifications to our queue */
+               for (i = 0; i < count; i++) {
+                       /*
+                        * Push to tail in order; other side
+                        * (muxer_notif_iter_do_next_one()) consumes
+                        * from the head first.
+                        */
+                       g_queue_push_tail(muxer_upstream_notif_iter->notifs,
+                               notifs[i]);
+               }
                break;
        case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
                /*
                 * Notification iterator's current notification is not
                 * valid anymore. Return
-                * BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
-                * immediately.
+                * BT_NOTIFICATION_ITERATOR_STATUS_AGAIN immediately.
                 */
-               BT_LOGV_STR("Invalidated upstream notification iterator wrapper because of BT_NOTIFICATION_ITERATOR_STATUS_AGAIN.");
-               muxer_upstream_notif_iter->is_valid = false;
                break;
        case BT_NOTIFICATION_ITERATOR_STATUS_END:       /* Fall-through. */
        case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
@@ -484,9 +499,7 @@ enum bt_notification_iterator_status muxer_upstream_notif_iter_next(
                 * won't be considered again to find the youngest
                 * notification.
                 */
-               BT_LOGV_STR("Invalidated upstream notification iterator wrapper because of BT_NOTIFICATION_ITERATOR_STATUS_END or BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.");
                BT_PUT(muxer_upstream_notif_iter->notif_iter);
-               muxer_upstream_notif_iter->is_valid = false;
                status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
                break;
        default:
@@ -511,7 +524,7 @@ int muxer_notif_iter_handle_newly_connected_ports(
 
        /*
         * Here we create one upstream notification iterator for each
-        * newly connected port. We do not perform an initial "next" on
+        * newly connected port. We do NOT perform an initial "next" on
         * those new upstream notification iterators: they are
         * invalidated, to be validated later. The list of newly
         * connected ports to handle here is updated by
@@ -588,13 +601,13 @@ int get_notif_ts_ns(struct muxer_comp *muxer_comp,
                struct bt_notification *notif, int64_t last_returned_ts_ns,
                int64_t *ts_ns)
 {
-       struct bt_clock_class_priority_map *cc_prio_map = NULL;
        struct bt_clock_class *clock_class = NULL;
        struct bt_clock_value *clock_value = NULL;
        struct bt_event *event = NULL;
        int ret = 0;
        const unsigned char *cc_uuid;
        const char *cc_name;
+       enum bt_clock_value_status cv_status = BT_CLOCK_VALUE_STATUS_KNOWN;
 
        BT_ASSERT(notif);
        BT_ASSERT(ts_ns);
@@ -606,14 +619,15 @@ int get_notif_ts_ns(struct muxer_comp *muxer_comp,
 
        switch (bt_notification_get_type(notif)) {
        case BT_NOTIFICATION_TYPE_EVENT:
-               cc_prio_map =
-                       bt_notification_event_borrow_clock_class_priority_map(
-                               notif);
+               event = bt_notification_event_borrow_event(notif);
+               BT_ASSERT(event);
+               cv_status = bt_event_borrow_default_clock_value(event,
+                       &clock_value);
                break;
 
        case BT_NOTIFICATION_TYPE_INACTIVITY:
-               cc_prio_map =
-                       bt_notification_inactivity_borrow_clock_class_priority_map(
+               clock_value =
+                       bt_notification_inactivity_borrow_default_clock_value(
                                notif);
                break;
        default:
@@ -623,33 +637,26 @@ int get_notif_ts_ns(struct muxer_comp *muxer_comp,
                goto end;
        }
 
-       if (!cc_prio_map) {
-               BT_LOGE("Cannot get notification's clock class priority map: "
-                       "notif-addr=%p", notif);
-               goto error;
+       if (cv_status != BT_CLOCK_VALUE_STATUS_KNOWN) {
+               BT_LOGE_STR("Unsupported unknown clock value.");
+               ret = -1;
+               goto end;
        }
 
        /*
-        * If the clock class priority map is empty, then we consider
-        * that this notification has no time. In this case it's always
-        * the youngest.
+        * If the clock value is missing, then we consider that this
+        * notification has no time. In this case it's always the
+        * youngest.
         */
-       if (bt_clock_class_priority_map_get_clock_class_count(cc_prio_map) == 0) {
-               BT_LOGV_STR("Notification's clock class priority map contains 0 clock classes: "
+       if (!clock_value) {
+               BT_LOGV_STR("Notification's default clock value is missing: "
                        "using the last returned timestamp.");
                *ts_ns = last_returned_ts_ns;
                goto end;
        }
 
-       clock_class =
-               bt_clock_class_priority_map_borrow_highest_priority_clock_class(
-                       cc_prio_map);
-       if (!clock_class) {
-               BT_LOGE("Cannot get the clock class with the highest priority from clock class priority map: "
-                       "cc-prio-map-addr=%p", cc_prio_map);
-               goto error;
-       }
-
+       clock_class = bt_clock_value_borrow_clock_class(clock_value);
+       BT_ASSERT(clock_class);
        cc_uuid = bt_clock_class_get_uuid(clock_class);
        cc_name = bt_clock_class_get_name(clock_class);
 
@@ -801,31 +808,7 @@ int get_notif_ts_ns(struct muxer_comp *muxer_comp,
                }
        }
 
-       switch (bt_notification_get_type(notif)) {
-       case BT_NOTIFICATION_TYPE_EVENT:
-               event = bt_notification_event_borrow_event(notif);
-               BT_ASSERT(event);
-               clock_value = bt_event_borrow_clock_value(event,
-                       clock_class);
-               break;
-       case BT_NOTIFICATION_TYPE_INACTIVITY:
-               clock_value = bt_notification_inactivity_borrow_clock_value(
-                       notif, clock_class);
-               break;
-       default:
-               BT_LOGF("Unexpected notification type at this point: "
-                       "type=%d", bt_notification_get_type(notif));
-               abort();
-       }
-
-       if (!clock_value) {
-               BT_LOGE("Cannot get notification's clock value for clock class: "
-                       "clock-class-addr=%p, clock-class-name=\"%s\"",
-                       clock_class, cc_name);
-               goto error;
-       }
-
-       ret = bt_clock_value_get_value_ns_from_epoch(clock_value, ts_ns);
+       ret = bt_clock_value_get_ns_from_origin(clock_value, ts_ns);
        if (ret) {
                BT_LOGE("Cannot get nanoseconds from Epoch of clock value: "
                        "clock-value-addr=%p", clock_value);
@@ -899,9 +882,8 @@ muxer_notif_iter_youngest_upstream_notif_iter(
                        continue;
                }
 
-               BT_ASSERT(cur_muxer_upstream_notif_iter->is_valid);
-               notif = bt_notification_iterator_borrow_notification(
-                       cur_muxer_upstream_notif_iter->notif_iter);
+               BT_ASSERT(cur_muxer_upstream_notif_iter->notifs->length > 0);
+               notif = g_queue_peek_head(cur_muxer_upstream_notif_iter->notifs);
                BT_ASSERT(notif);
                ret = get_notif_ts_ns(muxer_comp, muxer_notif_iter, notif,
                        muxer_notif_iter->last_returned_ts_ns, &notif_ts_ns);
@@ -940,8 +922,12 @@ enum bt_notification_iterator_status validate_muxer_upstream_notif_iter(
                "muxer-upstream-notif-iter-wrap-addr=%p",
                muxer_upstream_notif_iter);
 
-       if (muxer_upstream_notif_iter->is_valid ||
+       if (muxer_upstream_notif_iter->notifs->length > 0 ||
                        !muxer_upstream_notif_iter->notif_iter) {
+               BT_LOGV("Already valid or not considered: "
+                       "queue-len=%u, upstream-notif-iter-addr=%p",
+                       muxer_upstream_notif_iter->notifs->length,
+                       muxer_upstream_notif_iter->notif_iter);
                goto end;
        }
 
@@ -954,7 +940,7 @@ end:
 
 static
 enum bt_notification_iterator_status validate_muxer_upstream_notif_iters(
-       struct muxer_notif_iter *muxer_notif_iter)
+               struct muxer_notif_iter *muxer_notif_iter)
 {
        enum bt_notification_iterator_status status =
                BT_NOTIFICATION_ITERATOR_STATUS_OK;
@@ -1013,16 +999,15 @@ end:
        return status;
 }
 
-static
-struct bt_notification_iterator_next_method_return muxer_notif_iter_do_next(
+static inline
+enum bt_notification_iterator_status muxer_notif_iter_do_next_one(
                struct muxer_comp *muxer_comp,
-               struct muxer_notif_iter *muxer_notif_iter)
+               struct muxer_notif_iter *muxer_notif_iter,
+               struct bt_notification **notif)
 {
+       enum bt_notification_iterator_status status =
+               BT_NOTIFICATION_ITERATOR_STATUS_OK;
        struct muxer_upstream_notif_iter *muxer_upstream_notif_iter = NULL;
-       struct bt_notification_iterator_next_method_return next_return = {
-               .notification = NULL,
-               .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
-       };
        int64_t next_return_ts;
 
        while (true) {
@@ -1034,14 +1019,12 @@ struct bt_notification_iterator_next_method_return muxer_notif_iter_do_next(
                                "muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
                                "ret=%d",
                                muxer_comp, muxer_notif_iter, ret);
-                       next_return.status =
-                               BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
+                       status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
                        goto end;
                }
 
-               next_return.status =
-                       validate_muxer_upstream_notif_iters(muxer_notif_iter);
-               if (next_return.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
+               status = validate_muxer_upstream_notif_iters(muxer_notif_iter);
+               if (status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
                        /* validate_muxer_upstream_notif_iters() logs details */
                        goto end;
                }
@@ -1069,21 +1052,19 @@ struct bt_notification_iterator_next_method_return muxer_notif_iter_do_next(
         * amongst those, of which the current notification is the
         * youngest.
         */
-       next_return.status =
-               muxer_notif_iter_youngest_upstream_notif_iter(muxer_comp,
+       status = muxer_notif_iter_youngest_upstream_notif_iter(muxer_comp,
                        muxer_notif_iter, &muxer_upstream_notif_iter,
                        &next_return_ts);
-       if (next_return.status < 0 ||
-                       next_return.status == BT_NOTIFICATION_ITERATOR_STATUS_END ||
-                       next_return.status == BT_NOTIFICATION_ITERATOR_STATUS_CANCELED) {
-               if (next_return.status < 0) {
+       if (status < 0 || status == BT_NOTIFICATION_ITERATOR_STATUS_END ||
+                       status == BT_NOTIFICATION_ITERATOR_STATUS_CANCELED) {
+               if (status < 0) {
                        BT_LOGE("Cannot find the youngest upstream notification iterator wrapper: "
                                "status=%s",
-                               bt_notification_iterator_status_string(next_return.status));
+                               bt_notification_iterator_status_string(status));
                } else {
                        BT_LOGV("Cannot find the youngest upstream notification iterator wrapper: "
                                "status=%s",
-                               bt_notification_iterator_status_string(next_return.status));
+                               bt_notification_iterator_status_string(status));
                }
 
                goto end;
@@ -1095,7 +1076,7 @@ struct bt_notification_iterator_next_method_return muxer_notif_iter_do_next(
                        "last-returned-ts=%" PRId64,
                        muxer_notif_iter, next_return_ts,
                        muxer_notif_iter->last_returned_ts_ns);
-               next_return.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
+               status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
                goto end;
        }
 
@@ -1104,22 +1085,58 @@ struct bt_notification_iterator_next_method_return muxer_notif_iter_do_next(
                "muxer-upstream-notif-iter-wrap-addr=%p, "
                "ts=%" PRId64,
                muxer_notif_iter, muxer_upstream_notif_iter, next_return_ts);
-       BT_ASSERT(next_return.status == BT_NOTIFICATION_ITERATOR_STATUS_OK);
+       BT_ASSERT(status == BT_NOTIFICATION_ITERATOR_STATUS_OK);
        BT_ASSERT(muxer_upstream_notif_iter);
-       next_return.notification = bt_notification_iterator_get_notification(
-               muxer_upstream_notif_iter->notif_iter);
-       BT_ASSERT(next_return.notification);
 
        /*
-        * We invalidate the upstream notification iterator so that, the
-        * next time this function is called,
-        * validate_muxer_upstream_notif_iters() will make it valid.
+        * Consume from the queue's head: other side
+        * (muxer_upstream_notif_iter_next()) writes to the tail.
         */
-       muxer_upstream_notif_iter->is_valid = false;
+       *notif = g_queue_pop_head(muxer_upstream_notif_iter->notifs);
+       BT_ASSERT(*notif);
        muxer_notif_iter->last_returned_ts_ns = next_return_ts;
 
 end:
-       return next_return;
+       return status;
+}
+
+static
+enum bt_notification_iterator_status muxer_notif_iter_do_next(
+               struct muxer_comp *muxer_comp,
+               struct muxer_notif_iter *muxer_notif_iter,
+               bt_notification_array notifs, uint64_t capacity,
+               uint64_t *count)
+{
+       enum bt_notification_iterator_status status =
+               BT_NOTIFICATION_ITERATOR_STATUS_OK;
+       uint64_t i = 0;
+
+       while (i < capacity && status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
+               status = muxer_notif_iter_do_next_one(muxer_comp,
+                       muxer_notif_iter, &notifs[i]);
+               if (status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
+                       i++;
+               }
+       }
+
+       if (i > 0) {
+               /*
+                * Even if muxer_notif_iter_do_next_one() returned
+                * something else than
+                * BT_NOTIFICATION_ITERATOR_STATUS_OK, we accumulated
+                * notification objects in the output notification
+                * array, so we need to return
+                * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
+                * transfered to downstream. This other status occurs
+                * again the next time muxer_notif_iter_do_next() is
+                * called, possibly without any accumulated
+                * notification, in which case we'll return it.
+                */
+               *count = i;
+               status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
+       }
+
+       return status;
 }
 
 static
@@ -1333,10 +1350,12 @@ void muxer_notif_iter_finalize(
 }
 
 BT_HIDDEN
-struct bt_notification_iterator_next_method_return muxer_notif_iter_next(
-               struct bt_private_connection_private_notification_iterator *priv_notif_iter)
+enum bt_notification_iterator_status muxer_notif_iter_next(
+               struct bt_private_connection_private_notification_iterator *priv_notif_iter,
+               bt_notification_array notifs, uint64_t capacity,
+               uint64_t *count)
 {
-       struct bt_notification_iterator_next_method_return next_ret;
+       enum bt_notification_iterator_status status;
        struct muxer_notif_iter *muxer_notif_iter =
                bt_private_connection_private_notification_iterator_get_user_data(priv_notif_iter);
        struct bt_private_component *priv_comp = NULL;
@@ -1348,48 +1367,36 @@ struct bt_notification_iterator_next_method_return muxer_notif_iter_next(
        BT_ASSERT(priv_comp);
        muxer_comp = bt_private_component_get_user_data(priv_comp);
        BT_ASSERT(muxer_comp);
-
        BT_LOGV("Muxer component's notification iterator's \"next\" method called: "
                "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
                "notif-iter-addr=%p",
                priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter);
 
-       /* Are we in an error state set elsewhere? */
-       if (unlikely(muxer_comp->error)) {
-               BT_LOGE("Muxer component is already in an error state: returning BT_NOTIFICATION_ITERATOR_STATUS_ERROR: "
-                       "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
-                       "notif-iter-addr=%p",
-                       priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter);
-               next_ret.notification = NULL;
-               next_ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
-               goto end;
-       }
-
-       next_ret = muxer_notif_iter_do_next(muxer_comp, muxer_notif_iter);
-       if (next_ret.status < 0) {
+       status = muxer_notif_iter_do_next(muxer_comp, muxer_notif_iter,
+               notifs, capacity, count);
+       if (status < 0) {
                BT_LOGE("Cannot get next notification: "
                        "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
                        "notif-iter-addr=%p, status=%s",
                        priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter,
-                       bt_notification_iterator_status_string(next_ret.status));
+                       bt_notification_iterator_status_string(status));
        } else {
                BT_LOGV("Returning from muxer component's notification iterator's \"next\" method: "
-                       "status=%s, notif-addr=%p",
-                       bt_notification_iterator_status_string(next_ret.status),
-                       next_ret.notification);
+                       "status=%s",
+                       bt_notification_iterator_status_string(status));
        }
 
-end:
        bt_put(priv_comp);
-       return next_ret;
+       return status;
 }
 
 BT_HIDDEN
-void muxer_port_connected(
+enum bt_component_status muxer_port_connected(
                struct bt_private_component *priv_comp,
                struct bt_private_port *self_private_port,
                struct bt_port *other_port)
 {
+       enum bt_component_status status = BT_COMPONENT_STATUS_OK;
        struct bt_port *self_port =
                bt_port_borrow_from_private(self_private_port);
        struct muxer_comp *muxer_comp =
@@ -1430,7 +1437,7 @@ void muxer_port_connected(
                                "port-addr=%p, port-name=\"%s\", "
                                "muxer-notif-iter-addr=%p", self_port,
                                bt_port_get_name(self_port), muxer_notif_iter);
-                       muxer_comp->error = true;
+                       status = BT_COMPONENT_STATUS_ERROR;
                        goto end;
                }
 
@@ -1451,12 +1458,12 @@ void muxer_port_connected(
                BT_LOGE("Cannot ensure that at least one muxer component's input port is available: "
                        "muxer-comp-addr=%p, status=%s",
                        muxer_comp, bt_component_status_string(ret));
-               muxer_comp->error = true;
+               status = BT_COMPONENT_STATUS_ERROR;
                goto end;
        }
 
 end:
-       return;
+       return status;
 }
 
 BT_HIDDEN
This page took 0.032567 seconds and 4 git commands to generate.