swift-mirror/include/swift/ABI/TaskGroup.h

//===--- Task.h - ABI structures for asynchronous tasks ---------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// Swift ABI describing task groups.
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_ABI_TASK_GROUP_H
#define SWIFT_ABI_TASK_GROUP_H

#include "swift/Basic/RelativePointer.h"
#include "swift/ABI/Executor.h"
#include "swift/ABI/HeapObject.h"
#include "swift/ABI/Metadata.h"
#include "swift/ABI/MetadataValues.h"
#include "swift/Runtime/Config.h"
#include "swift/Basic/STLExtras.h"
#include "Task.h"
#include "bitset"
#include "string"
#include "queue"

namespace swift {

  // ==== TaskGroup ------------------------------------------------------------

  class TaskGroup {
  public:
    /// Describes the status of the channel.
    enum class ReadyStatus : uintptr_t {
        /// The channel is empty, no tasks are pending.
        /// Return immediately, there is no point in suspending.
        ///
        /// The storage is not accessible.
        Empty = 0b00,

        /// The future has completed with result (of type \c resultType).
        Success = 0b10,

        /// The future has completed by throwing an error (an \c Error
        /// existential).
        Error = 0b11,
    };

    /// Describes the status of the waiting task that is suspended on `next()`.
    enum class WaitStatus : uintptr_t {
        Waiting = 0,
    };

    enum class GroupPollStatus : uintptr_t {
        /// The channel is known to be empty and we can immediately return nil.
        Empty = 0,

        /// The task has been enqueued to the channels wait queue.
        Waiting = 1,

        /// The task has completed with result (of type \c resultType).
        Success = 2,

        /// The task has completed by throwing an error (an \c Error
        /// existential).
        Error = 3,
    };

    /// The result of waiting on a Channel (TaskGroup).
    struct GroupPollResult {
        GroupPollStatus status; // TODO: pack it into storage pointer or not worth it?

        /// Storage for the result of the future.
        ///
        /// When the future completed normally, this is a pointer to the storage
        /// of the result value, which lives inside the future task itself.
        ///
        /// When the future completed by throwing an error, this is the error
        /// object itself.
        OpaqueValue *storage;

        /// Optional, the completed task that was polled out of the ready queue.
        ///
        /// # Important: swift_release
        /// If if a task is returned here, the task MUST be swift_release'd
        /// once we are done with it, to balance out the retain made before
        /// when the task was enqueued into the ready queue to keep it alive
        /// until a next() call eventually picks it up.
        AsyncTask *retainedTask;

        bool isStorageAccessible() {
          return status == GroupPollStatus::Success ||
              status == GroupPollStatus::Error ||
              status == GroupPollStatus::Empty;
        }

        static GroupPollResult get(AsyncTask *asyncTask, bool hadErrorResult,
                                   bool needsSwiftRelease) {
          auto fragment = asyncTask->futureFragment();
          return GroupPollResult{
              /*status*/ hadErrorResult ?
                  TaskGroup::GroupPollStatus::Error :
                  TaskGroup::GroupPollStatus::Success,
              /*storage*/ hadErrorResult ?
                  reinterpret_cast<OpaqueValue *>(fragment->getError()) :
                  fragment->getStoragePtr(),
              /*task*/ needsSwiftRelease ?
                  asyncTask :
                  nullptr
          };
        }
    };

    /// An item within the message queue of a channel.
    struct ReadyQueueItem {
        /// Mask used for the low status bits in a message queue item.
        static const uintptr_t statusMask = 0x03;

        uintptr_t storage;

        ReadyStatus getStatus() const {
          return static_cast<ReadyStatus>(storage & statusMask);
        }

        AsyncTask *getTask() const {
          return reinterpret_cast<AsyncTask *>(storage & ~statusMask);
        }

        static ReadyQueueItem get(ReadyStatus status, AsyncTask *task) {
          assert(task == nullptr || task->isFuture());
          return ReadyQueueItem{
              reinterpret_cast<uintptr_t>(task) | static_cast<uintptr_t>(status)};
        }
    };

    /// An item within the pending queue.
    struct PendingQueueItem {
        uintptr_t storage;

        AsyncTask *getTask() const {
          return reinterpret_cast<AsyncTask *>(storage);
        }

        static ReadyQueueItem get(AsyncTask *task) {
          assert(task == nullptr || task->isFuture());
          return ReadyQueueItem{ reinterpret_cast<uintptr_t>(task) };
        }
    };

    /// An item within the wait queue, which includes the status and the
    /// head of the list of tasks.
    struct WaitQueueItem { // TODO: reuse the future's wait queue instead?
        /// Mask used for the low status bits in a wait queue item.
        static const uintptr_t statusMask = 0x03;

        uintptr_t storage;

        WaitStatus getStatus() const {
          return static_cast<WaitStatus>(storage & statusMask);
        }

        AsyncTask *getTask() const {
          return reinterpret_cast<AsyncTask *>(storage & ~statusMask);
        }

        static WaitQueueItem get(WaitStatus status, AsyncTask *task) {
          return WaitQueueItem{
              reinterpret_cast<uintptr_t>(task) | static_cast<uintptr_t>(status)};
        }
    };

    struct GroupStatus {
        static const uint64_t cancelled      = 0x01000000000000000ll;

        static const uint64_t maskReady      = 0x00FFFFF0000000000ll;
        static const uint64_t oneReadyTask   = 0x00000010000000000ll;

        static const uint64_t maskPending    = 0x0000000FFFFF00000ll;
        static const uint64_t onePendingTask = 0x00000000000100000ll;

        static const uint64_t maskWaiting    = 0x000000000000FFFFFll;
        static const uint64_t oneWaitingTask = 0x00000000000000001ll;

        uint64_t status;

        bool isCancelled() {
          return (status & cancelled) > 0;
        }

        unsigned int readyTasks() {
          return (status & maskReady) >> 40;
        }

        unsigned int pendingTasks() {
          return (status & maskPending) >> 20;
        }

        unsigned int waitingTasks() {
          return status & maskWaiting;
        }

        bool isEmpty() {
          return pendingTasks() == 0;
        }

        /// Status value decrementing the Ready, Pending and Waiting counters by one.
        GroupStatus completingReadyPendingWaitingTask() {
          assert(pendingTasks() > 0 && "can only complete waiting tasks when pending tasks available");
          assert(readyTasks() > 0 && "can only complete waiting tasks when ready tasks available");
          assert(waitingTasks() > 0 && "can only complete waiting tasks when waiting tasks available");
          // FIXME take into account cancelled !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
          return GroupStatus { status - oneReadyTask - oneWaitingTask - onePendingTask };
        }

        /// Pretty prints the status, as follows:
        /// GroupStatus{ P:{pending tasks} W:{waiting tasks} {binary repr} }
        std::string to_string() {
          std::string str;
          str.append("GroupStatus{ ");
          str.append("C:"); // cancelled
          str.append(isCancelled() ? "y" : "n");
          str.append("R:");
          str.append(std::to_string(readyTasks()));
          str.append(" P:");
          str.append(std::to_string(pendingTasks()));
          str.append(" W:");
          str.append(std::to_string(waitingTasks()));
          str.append(" " + std::bitset<64>(status).to_string());
          str.append(" }");
          return str;
        }

        /// Initially there are no waiting and no pending tasks.
        static const GroupStatus initial() {
          return GroupStatus { 0 };
        };
    };

    template<typename T>
    class NaiveQueue {
        std::queue<T> queue;

    public:
        NaiveQueue() = default;
        NaiveQueue(const NaiveQueue<T> &) = delete ;
        NaiveQueue& operator=(const NaiveQueue<T> &) = delete ;

        NaiveQueue(NaiveQueue<T>&& other) {
          queue = std::move(other.queue);
        }

        virtual ~NaiveQueue() { }

        bool dequeue(T &output) {
          if (queue.empty()) {
            return false;
          }
          output = queue.front();
          queue.pop();
          return true;
        }

        void enqueue(const T item) {
          queue.push(item);
        }

    };

  private:

//    // TODO: move to lockless via the status atomic
    mutable std::mutex mutex;

    /// Used for queue management, counting number of waiting and ready tasks
    std::atomic<uint64_t> status;

    /// Queue containing completed tasks offered into this channel.
    ///
    /// The low bits contain the status, the rest of the pointer is the
    /// AsyncTask.
    NaiveQueue<ReadyQueueItem> readyQueue;
//     mpsc_queue_t<ReadyQueueItem> readyQueue; // TODO: can we get away with an MPSC queue here once actor executors land?

//    /// Queue containing all pending tasks.
//    NaiveQueue<PendingQueueItem> pendingQueue;

    /// Queue containing all of the tasks that are waiting in `get()`.
    ///
    /// A task group is also a future, and awaits on the group's result *itself*
    /// are enqueued on its future fragment.
    ///
    /// The low bits contain the status, the rest of the pointer is the
    /// AsyncTask.
    std::atomic<WaitQueueItem> waitQueue;

    friend class AsyncTask;

  public:
    explicit TaskGroup()
        : status(GroupStatus::initial().status),
          readyQueue(),
//          readyQueue(ReadyQueueItem::get(ReadyStatus::Empty, nullptr)),
          waitQueue(WaitQueueItem::get(WaitStatus::Waiting, nullptr)) {}

    /// Destroy the storage associated with the channel.
    void destroy(AsyncTask *task);

    bool isEmpty() {
      auto oldStatus = GroupStatus { status.load(std::memory_order_relaxed) };
      return oldStatus.pendingTasks() == 0;
    }

    bool isCancelled() {
      auto oldStatus = GroupStatus { status.load(std::memory_order_relaxed) };
      return oldStatus.isCancelled();
    }

    /// Cancel the task group and all tasks within it.
    ///
    /// Returns `true` if this is the first time cancelling the group, false otherwise.
    bool cancelAll(AsyncTask *task);

    /// Returns *assumed* new status, including the just performed +1.
    GroupStatus statusAddReadyTaskAcquire() {
      auto old = status.fetch_add(GroupStatus::oneReadyTask, std::memory_order_acquire);
      auto s = GroupStatus {old + GroupStatus::oneReadyTask };
      assert(s.readyTasks() <= s.pendingTasks());
      return s;
    }

    /// Returns *assumed* new status, including the just performed +1.
    GroupStatus statusAddPendingTaskRelaxed(AsyncTask* pendingTask) {
      assert(pendingTask->isFuture());
      auto old = status.fetch_add(GroupStatus::onePendingTask, std::memory_order_relaxed);

//      // FIXME: we won't need the +1 in the status, just the queue?
//      pendingQueue.enqueue(PendingQueueItem::get(pendingTask))

      return GroupStatus {old + GroupStatus::onePendingTask };
    }

    /// Returns *assumed* new status, including the just performed +1.
    GroupStatus statusAddWaitingTaskAcquire() {
      auto old = status.fetch_add(GroupStatus::oneWaitingTask, std::memory_order_acquire);
      return GroupStatus { old + GroupStatus::oneWaitingTask };
    }

    /// Remove waiting task, without taking any pending task.
    GroupStatus statusRemoveWaitingTask() {
      return GroupStatus {
          status.fetch_sub(GroupStatus::oneWaitingTask, std::memory_order_relaxed)
      };
    }

    /// Compare-and-set old status to a status derived from the old one,
    /// by simultaneously decrementing one Pending and one Waiting tasks.
    ///
    /// This is used to atomically perform a waiting task completion.
    bool statusCompleteReadyPendingWaitingTasks(GroupStatus& old) {
      return status.compare_exchange_weak(
          old.status, old.completingReadyPendingWaitingTask().status,
          /*success*/ std::memory_order_relaxed,
          /*failure*/ std::memory_order_relaxed);
    }


    /// Offer result of a task into this channel.
    /// The value is enqueued at the end of the channel.
    void offer(AsyncTask *completed, AsyncContext *context, ExecutorRef executor);

    /// Attempt to dequeue ready tasks and complete the waitingTask.
    ///
    /// If unable to complete the waiting task immediately (with an readily
    /// available completed task), either returns an `GroupPollStatus::Empty`
    /// result if it is known that no pending tasks in the group,
    /// or a `GroupPollStatus::Waiting` result if there are tasks in flight
    /// and the waitingTask eventually be woken up by a completion.
    TaskGroup::GroupPollResult poll(AsyncTask *waitingTask);

  };

//  /// Offer result of a task into this channel.
//  /// The value is enqueued at the end of the channel.
//  void groupOffer(AsyncTask *completed, AsyncContext *context, ExecutorRef executor);
//
//  /// Attempt to dequeue ready tasks and complete the waitingTask.
//  ///
//  /// If unable to complete the waiting task immediately (with an readily
//  /// available completed task), either returns an `GroupPollStatus::Empty`
//  /// result if it is known that no pending tasks in the group,
//  /// or a `GroupPollStatus::Waiting` result if there are tasks in flight
//  /// and the waitingTask eventually be woken up by a completion.
//  TaskGroup::GroupPollResult groupPoll(AsyncTask *waitingTask);

} // end namespace swift

#endif