Add cooperative threads

Author: lukewagner

design/mvp/canonical-abi/definitions.py

@@ -215,21 +215,28 @@ def tick(self):
 
 class Thread:
   task: Task
+  index: int
   future: Optional[asyncio.Future]
   on_resume: Optional[asyncio.Future]
   on_suspend_or_exit: Optional[asyncio.Future]
+  context: list[int]
+
+  CONTEXT_LENGTH = 1
 
   def __init__(self, task, thread_func):
     self.task = task
+    self.index = task.inst.table.add(self)
     self.future = None
     self.on_resume = asyncio.Future()
     self.on_suspend_or_exit = None
+    self.context = [0] * Thread.CONTEXT_LENGTH
     async def thread_start():
       await self.on_resume
       self.on_resume = None
       await thread_func(task, self)
       self.on_suspend_or_exit.set_result(None)
       self.task.thread = None
+      self.task.inst.table.remove(self.index)
     asyncio.create_task(thread_start())
 
   async def resume(self):
@@ -254,6 +261,30 @@ async def suspend(self, future):
     await self.on_resume
     self.on_resume = None
 
+  async def switch(self, other: Thread) -> Cancelled:
+    assert(not self.future and not other.future)
+    assert(self.on_suspend_or_exit and not other.on_suspend_or_exit)
+    other.on_suspend_or_exit = self.on_suspend_or_exit
+    self.on_suspend_or_exit = None
+    other.on_resume.set_result(Cancelled.FALSE)
+    assert(not self.on_resume)
+    self.on_resume = asyncio.Future()
+    cancelled = await self.on_resume
+    self.on_resume = None
+    return cancelled
+
+  def yield_to(self, other: Thread) -> Cancelled:
+    # deterministically switch to other, but leave this thread unblocked
+    TODO
+
+  def block(self) -> Cancelled:
+    # perform just the first half of switch
+    TODO
+
+  def unblock(self, other: Thread):
+    # unblock other, but deterministically keep running here
+    TODO
+
 
 ### Lifting and Lowering Context
 
@@ -431,22 +462,6 @@ def write(self, vs):
       assert(all(v == () for v in vs))
     self.progress += len(vs)
 
-#### Context-Local Storage
-
-class ContextLocalStorage:
-  LENGTH = 1
-  array: list[int]
-
-  def __init__(self):
-    self.array = [0] * ContextLocalStorage.LENGTH
-
-  def set(self, i, v):
-    assert(types_match_values(['i32'], [v]))
-    self.array[i] = v
-
-  def get(self, i):
-    return self.array[i]
-
 #### Waitable State
 
 class EventCode(IntEnum):
@@ -457,6 +472,7 @@ class EventCode(IntEnum):
   FUTURE_READ = 4
   FUTURE_WRITE = 5
   TASK_CANCELLED = 6
+  THREAD_RESUMED = 7
 
 EventTuple = tuple[EventCode, int, int]
 
@@ -546,7 +562,6 @@ class State(Enum):
   thread: Thread
   cancellable: bool
   num_borrows: int
-  context: ContextLocalStorage
 
   def __init__(self, opts, inst, ft, supertask, on_resolve, thread_func):
     self.state = Task.State.INITIAL
@@ -558,7 +573,6 @@ def __init__(self, opts, inst, ft, supertask, on_resolve, thread_func):
     self.thread = Thread(self, thread_func)
     self.cancellable = False
     self.num_borrows = 0
-    self.context = ContextLocalStorage()
 
   def trap_if_on_the_stack(self, inst):
     c = self.supertask
@@ -638,6 +652,7 @@ async def wait_for_event(self, thread, waitable_set, cancellable, unlock) -> Eve
     waitable_set.num_waiting += 1
     e = None
     while not e:
+      # TODO: somehow get a THREAD_RESUME event...
       maybe_event = waitable_set.maybe_has_pending_event.wait()
       await self.block_on(thread, maybe_event, cancellable, unlock)
       if self.deliver_cancel():
@@ -650,6 +665,7 @@ async def yield_(self, thread, cancellable, unlock) -> EventTuple:
     assert(self.thread is thread and self is thread.task)
     if cancellable and self.deliver_cancel():
       return (EventCode.TASK_CANCELLED, 0, 0)
+    # TODO: somehow get a THREAD_RESUME event...
     await self.block_on(thread, asyncio.sleep(0), cancellable, unlock)
     if cancellable and self.deliver_cancel():
       return (EventCode.TASK_CANCELLED, 0, 0)
@@ -681,7 +697,7 @@ def cancel(self):
     self.state = Task.State.RESOLVED
 
   def exit(self):
-    trap_if(self.state != Task.State.RESOLVED)
+    trap_if(self.state != Task.State.RESOLVED) # TODO: move this to empty-threads case
     assert(self.num_borrows == 0)
     if self.needs_lock():
       self.inst.lock.release()
@@ -2102,25 +2118,76 @@ async def canon_resource_rep(rt, thread, i):
   trap_if(h.rt is not rt)
   return [h.rep]
 
+### 🧵 `canon thread.index`
+
+async def canon_thread_index(shared, thread):
+  assert(not shared)
+  return [thread.index]
+
+### 🧵 `canon thread.new_indirect`
+
+async def canon_thread_new_indirect(ft, ftbl, thread, i, c):
+  trap_if(not thread.task.inst.may_leave)
+  f = thread.task.inst.ftbl.get(i)
+  trap_if(f.type != ft)
+  thread = Thread(thread.task, f(c))
+  return [thread.index]
+
+### 🧵 `canon thread.switch`
+
+async def canon_thread_switch(thread, i):
+  trap_if(not thread.task.inst.may_leave)
+  other = thread.task.inst.table.get(i)
+  trap_if(not isinstance(other, Thread))
+  cancelled = await thread.switch(other)
+  return [ 1 if cancelled else 0 ]
+
+### 🧵 `canon thread.yield-to`
+
+async def canon_thread_yield_to(thread, i):
+  trap_if(not thread.task.inst.may_leave)
+  other = thread.task.inst.table.get(i)
+  trap_if(not isinstance(other, Thread))
+  other.yield_to(other)
+  return []
+
+### 🧵 `canon thread.block`
+
+async def canon_thread_block(thread, i):
+  trap_if(not thread.task.inst.may_leave)
+  other = thread.task.inst.table.get(i)
+  trap_if(not isinstance(other, Thread))
+  cancelled = await thread.block()
+  return [ 1 if cancelled else 0 ]
+
+### 🧵 `canon thread.unblock`
+
+async def canon_thread_unblock(thread, i):
+  trap_if(not thread.task.inst.may_leave)
+  other = thread.task.inst.table.get(i)
+  trap_if(not isinstance(other, Thread))
+  thread.unblock()
+  return []
+
 ### 🔀 `canon context.get`
 
 async def canon_context_get(t, i, thread):
   assert(t == 'i32')
-  assert(i < ContextLocalStorage.LENGTH)
-  return [thread.task.context.get(i)]
+  assert(i < Thread.CONTEXT_LENGTH)
+  return [thread.context[i]]
 
 ### 🔀 `canon context.set`
 
 async def canon_context_set(t, i, thread, v):
   assert(t == 'i32')
-  assert(i < ContextLocalStorage.LENGTH)
-  thread.task.context.set(i, v)
+  assert(i < Thread.CONTEXT_LENGTH)
+  thread.context[i] = v
   return []
 
 ### 🔀 `canon backpressure.set`
 
 async def canon_backpressure_set(thread, flat_args):
-  trap_if(thread.task.opts.sync)
+  # TODO: remove trap_if(thread.task.opts.sync)
   assert(len(flat_args) == 1)
   if flat_args[0] == 0:
     thread.task.inst.no_backpressure.set()