feat: add async runtime

GordonSmith · GordonSmith · commit af57bb641da5 · 2025-09-28T07:27:27.000+01:00
helpers fixes #4 Signed-off-by: Gordon Smith <GordonJSmith@gmail.com>
diff --git a/README.md b/README.md
@@ -59,6 +59,8 @@ This repository contains a C++ ABI implementation of the WebAssembly Component M
 - [x] Wamr
 - [ ] WasmEdge
 
+When expanding the canonical ABI surface, cross-check the Python reference tests in `ref/component-model/design/mvp/canonical-abi/run_tests.py`; new host features should mirror the behaviors exercised there.
+
 ## Build Instructions
 
 ### Prerequisites
@@ -171,6 +173,46 @@ This library is a header only library. To use it in your project, you can:
 - [x] Copy the contents of the `include` directory to your project.
 - [ ] Use `vcpkg` to install the library and its dependencies.
 
+### Async runtime helpers
+
+The canonical Component Model runtime is cooperative: hosts must drive pending work by scheduling tasks explicitly. `cmcpp` now provides a minimal async harness in `cmcpp/runtime.hpp`:
+
+- `Store` owns the pending task queue and exposes `invoke` plus `tick()`.
+- `FuncInst` is the callable signature hosts use to wrap guest functions.
+- `Thread::create` builds a pending task with user-supplied readiness/resume callbacks.
+- `Call::from_thread` returns a cancellation-capable handle to the caller.
+
+Typical usage:
+
+```cpp
+cmcpp::Store store;
+cmcpp::FuncInst func = [](cmcpp::Store &store,
+              cmcpp::SupertaskPtr,
+              cmcpp::OnStart on_start,
+              cmcpp::OnResolve on_resolve) {
+  auto args = std::make_shared<std::vector<std::any>>(on_start());
+  auto gate = std::make_shared<std::atomic<bool>>(false);
+
+  auto thread = cmcpp::Thread::create(
+    store,
+    [gate]() { return gate->load(); },
+    [args, on_resolve](bool cancelled) {
+      on_resolve(cancelled ? std::nullopt : std::optional{*args});
+      return false; // finished
+    },
+    true,
+    [gate]() { gate->store(true); });
+
+  return cmcpp::Call::from_thread(thread);
+};
+
+auto call = store.invoke(func, nullptr, [] { return std::vector<std::any>{}; }, [](auto) {});
+// Drive progress
+store.tick();
+```
+
+Call `tick()` in your host loop until all pending work completes. Cancellation is cooperative: calling `Call::request_cancellation()` marks the associated thread as cancelled before the next `tick()`.
+
  
 ## Related projects
 
diff --git a/include/cmcpp.hpp b/include/cmcpp.hpp
@@ -11,5 +11,6 @@
 #include <cmcpp/func.hpp>
 #include <cmcpp/lower.hpp>
 #include <cmcpp/lift.hpp>
+#include <cmcpp/runtime.hpp>
 
 #endif // CMCPP_HPP
diff --git a/include/cmcpp/runtime.hpp b/include/cmcpp/runtime.hpp
@@ -0,0 +1,261 @@
+#ifndef CMCPP_RUNTIME_HPP
+#define CMCPP_RUNTIME_HPP
+
+#include <algorithm>
+#include <any>
+#include <functional>
+#include <memory>
+#include <mutex>
+#include <optional>
+#include <utility>
+#include <vector>
+
+namespace cmcpp
+{
+    class Store;
+
+    struct Supertask;
+    using SupertaskPtr = std::shared_ptr<Supertask>;
+
+    using OnStart = std::function<std::vector<std::any>()>;
+    using OnResolve = std::function<void(std::optional<std::vector<std::any>>)>;
+
+    class Thread : public std::enable_shared_from_this<Thread>
+    {
+    public:
+        using ReadyFn = std::function<bool()>;
+        using ResumeFn = std::function<bool(bool)>;
+        using CancelFn = std::function<void()>;
+
+        static std::shared_ptr<Thread> create(Store &store, ReadyFn ready, ResumeFn resume, bool cancellable = false, CancelFn on_cancel = {});
+
+        Thread(Store &store, ReadyFn ready, ResumeFn resume, bool cancellable, CancelFn on_cancel);
+        bool ready() const;
+        void resume();
+        void request_cancellation();
+        bool cancellable() const;
+        bool cancelled() const;
+        bool completed() const;
+
+    private:
+        enum class State
+        {
+            Pending,
+            Running,
+            Completed
+        };
+
+        void set_pending(bool pending_again, const std::shared_ptr<Thread> &self);
+
+        Store *store_;
+        ReadyFn ready_;
+        ResumeFn resume_;
+        CancelFn on_cancel_;
+        bool cancellable_;
+        bool cancelled_;
+        mutable std::mutex mutex_;
+        State state_;
+    };
+
+    class Call
+    {
+    public:
+        using CancelRequest = std::function<void()>;
+
+        Call() = default;
+        explicit Call(CancelRequest cancel) : request_cancellation_(std::move(cancel)) {}
+
+        void request_cancellation() const
+        {
+            if (request_cancellation_)
+            {
+                request_cancellation_();
+            }
+        }
+
+        static Call from_thread(const std::shared_ptr<Thread> &thread)
+        {
+            if (!thread)
+            {
+                return Call();
+            }
+            std::weak_ptr<Thread> weak = thread;
+            return Call([weak]()
+                        {
+                if (auto locked = weak.lock())
+                {
+                    locked->request_cancellation();
+                } });
+        }
+
+    private:
+        CancelRequest request_cancellation_;
+    };
+
+    struct Supertask
+    {
+        SupertaskPtr parent;
+    };
+
+    using FuncInst = std::function<Call(Store &, SupertaskPtr, OnStart, OnResolve)>;
+
+    class Store
+    {
+    public:
+        Call invoke(const FuncInst &func, SupertaskPtr caller, OnStart on_start, OnResolve on_resolve);
+        void tick();
+        void schedule(const std::shared_ptr<Thread> &thread);
+        std::size_t pending_size() const;
+
+    private:
+        friend class Thread;
+        mutable std::mutex mutex_;
+        std::vector<std::shared_ptr<Thread>> pending_;
+    };
+
+    inline std::shared_ptr<Thread> Thread::create(Store &store, ReadyFn ready, ResumeFn resume, bool cancellable, CancelFn on_cancel)
+    {
+        auto thread = std::shared_ptr<Thread>(new Thread(store, std::move(ready), std::move(resume), cancellable, std::move(on_cancel)));
+        store.schedule(thread);
+        return thread;
+    }
+
+    inline Thread::Thread(Store &store, ReadyFn ready, ResumeFn resume, bool cancellable, CancelFn on_cancel)
+        : store_(&store), ready_(std::move(ready)), resume_(std::move(resume)), on_cancel_(std::move(on_cancel)), cancellable_(cancellable), cancelled_(false), state_(State::Pending)
+    {
+    }
+
+    inline bool Thread::ready() const
+    {
+        std::lock_guard lock(mutex_);
+        if (state_ != State::Pending)
+        {
+            return false;
+        }
+        if (!ready_)
+        {
+            return true;
+        }
+        return ready_();
+    }
+
+    inline void Thread::resume()
+    {
+        auto self = shared_from_this();
+        ResumeFn resume;
+        bool was_cancelled = false;
+        {
+            std::lock_guard lock(mutex_);
+            if (state_ != State::Pending)
+            {
+                return;
+            }
+            state_ = State::Running;
+            resume = resume_;
+            was_cancelled = cancelled_;
+        }
+
+        bool keep_pending = false;
+        if (resume)
+        {
+            keep_pending = resume(was_cancelled);
+        }
+
+        set_pending(keep_pending, self);
+    }
+
+    inline void Thread::request_cancellation()
+    {
+        CancelFn cancel;
+        {
+            std::lock_guard lock(mutex_);
+            if (cancelled_ || !cancellable_)
+            {
+                return;
+            }
+            cancelled_ = true;
+            cancel = on_cancel_;
+        }
+        if (cancel)
+        {
+            cancel();
+        }
+    }
+
+    inline bool Thread::cancellable() const
+    {
+        std::lock_guard lock(mutex_);
+        return cancellable_;
+    }
+
+    inline bool Thread::cancelled() const
+    {
+        std::lock_guard lock(mutex_);
+        return cancelled_;
+    }
+
+    inline bool Thread::completed() const
+    {
+        std::lock_guard lock(mutex_);
+        return state_ == State::Completed;
+    }
+
+    inline void Thread::set_pending(bool pending_again, const std::shared_ptr<Thread> &self)
+    {
+        {
+            std::lock_guard lock(mutex_);
+            state_ = pending_again ? State::Pending : State::Completed;
+        }
+        if (pending_again)
+        {
+            store_->schedule(self);
+        }
+    }
+
+    inline Call Store::invoke(const FuncInst &func, SupertaskPtr caller, OnStart on_start, OnResolve on_resolve)
+    {
+        if (!func)
+        {
+            return Call();
+        }
+        return func(*this, std::move(caller), std::move(on_start), std::move(on_resolve));
+    }
+
+    inline void Store::tick()
+    {
+        std::shared_ptr<Thread> selected;
+        {
+            std::lock_guard lock(mutex_);
+            auto it = std::find_if(pending_.begin(), pending_.end(), [](const std::shared_ptr<Thread> &thread)
+                                   { return thread && thread->ready(); });
+            if (it == pending_.end())
+            {
+                return;
+            }
+            selected = *it;
+            pending_.erase(it);
+        }
+        if (selected)
+        {
+            selected->resume();
+        }
+    }
+
+    inline void Store::schedule(const std::shared_ptr<Thread> &thread)
+    {
+        if (!thread)
+        {
+            return;
+        }
+        std::lock_guard lock(mutex_);
+        pending_.push_back(thread);
+    }
+
+    inline std::size_t Store::pending_size() const
+    {
+        std::lock_guard lock(mutex_);
+        return pending_.size();
+    }
+}
+
+#endif
diff --git a/test/main.cpp b/test/main.cpp
