CABI: change result of async lower on eager return to be more consistent (#516)

Author: lukewagner

design/mvp/Async.md

@@ -645,7 +645,7 @@ the same as in the synchronous case. What's different, however, is *when* `$in`
 and `$out` are read or written. In a synchronous call, they are always read or
 written before the call returns. In an asynchronous call, there is a set of
 possibilities indicated by the `(result i32)` value:
-* If the returned `i32` is `0`, then the call completed synchronously without
+* If the returned `i32` is `2`, then the call returned eagerly without
   blocking and so `$in` has been read and `$out` has been written.
 * Otherwise, the high 28 bits of the `i32` are the index of a new `Subtask`
   in the current component instance's table. The low 4 bits indicate how far

design/mvp/CanonicalABI.md

@@ -3143,7 +3143,7 @@ always returns control flow back to the caller without blocking:
   await subtask.call_async(callee, on_start, on_resolve)
   if subtask.resolved():
     subtask.deliver_resolve()
-    return [0]
+    return [int(Subtask.State.RETURNED)]
 
   subtaski = task.inst.table.add(subtask)
   assert(0 < subtaski <= Table.MAX_LENGTH < 2**28)

design/mvp/canonical-abi/definitions.py

@@ -1951,7 +1951,7 @@ def subtask_event():
   await subtask.call_async(callee, on_start, on_resolve)
   if subtask.resolved():
     subtask.deliver_resolve()
-    return [0]
+    return [int(Subtask.State.RETURNED)]
 
   subtaski = task.inst.table.add(subtask)
   assert(0 < subtaski <= Table.MAX_LENGTH < 2**28)

design/mvp/canonical-abi/run_tests.py

@@ -574,7 +574,7 @@ async def consumer(task, args):
     [seti] = await canon_waitable_set_new(task)
     ptr = consumer_heap.realloc(0, 0, 1, 1)
     [ret] = await canon_lower(consumer_opts, eager_ft, eager_callee, task, [ptr])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     u8 = consumer_heap.memory[ptr]
     assert(u8 == 43)
     [ret] = await canon_lower(consumer_opts, toggle_ft, toggle_callee, task, [])
@@ -1171,7 +1171,7 @@ async def core_func(task, args):
     retp = 12
     await asyncio.sleep(0)
     [ret] = await canon_lower(opts, ft, host_import, task, [rsi3, retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi4 = mem[retp]
     [ret] = await canon_stream_write(StreamType(U8Type()), opts, task, wsi3, 0, 4)
     result,n = unpack_result(ret)
@@ -1267,7 +1267,7 @@ async def core_func(task, args):
     [packed] = await canon_stream_new(StreamType(U8Type()), task)
     rsi3,wsi3 = unpack_new_ends(packed)
     [ret] = await canon_lower(opts, ft, host_import, task, [rsi3, retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi4 = mem[16]
     assert(rsi4 == 4)
     [ret] = await canon_stream_write(StreamType(U8Type()), opts, task, wsi3, 0, 4)
@@ -1370,7 +1370,7 @@ async def core_func(task, args):
     assert(ret == definitions.BLOCKED)
     retp = 8
     [ret] = await canon_lower(opts, host_ft, host_import, task, [rsi, retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi2 = int.from_bytes(mem[retp : retp+4], 'little', signed=False)
     assert(rsi2 == 1)
     try:
@@ -1408,7 +1408,7 @@ async def core_func(task, args):
     assert(len(args) == 0)
     retp = 4
     [ret] = await canon_lower(opts, source_ft, host_source, task, [retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi = mem[retp]
     assert(rsi == 1)
     [ret] = await canon_stream_read(StreamType(U8Type()), opts, task, rsi, 0, 4)
@@ -1437,7 +1437,7 @@ async def core_func(task, args):
     assert(rsi == 1)
     assert(wsi == 3)
     [ret] = await canon_lower(opts, sink_ft, host_sink, task, [rsi])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     mem[0:6] = b'\x01\x02\x03\x04\x05\x06'
     [ret] = await canon_stream_write(StreamType(U8Type()), opts, task, wsi, 0, 6)
     result,n = unpack_result(ret)
@@ -1538,7 +1538,7 @@ async def core_func2(task, args):
 
     retp = 16
     [ret] = await canon_lower(opts2, ft1, func1, task, [retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi = mem2[retp]
     assert(rsi == 1)
 
@@ -1649,7 +1649,7 @@ async def core_func2(task, args):
 
     retp = 0
     [ret] = await canon_lower(opts2, ft1, func1, task, [retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi = mem2[0]
     assert(rsi == 1)
 
@@ -1715,7 +1715,7 @@ async def core_func(task, args):
     [packed] = await canon_stream_new(StreamType(U8Type()), task)
     rsi,wsi = unpack_new_ends(packed)
     [ret] = await canon_lower(lower_opts, host_ft1, host_func1, task, [rsi])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     mem[0:4] = b'\x0a\x0b\x0c\x0d'
     [ret] = await canon_stream_write(StreamType(U8Type()), lower_opts, task, wsi, 0, 4)
     assert(ret == definitions.BLOCKED)
@@ -1732,7 +1732,7 @@ async def core_func(task, args):
     [packed] = await canon_stream_new(StreamType(U8Type()), task)
     rsi,wsi = unpack_new_ends(packed)
     [ret] = await canon_lower(lower_opts, host_ft1, host_func1, task, [rsi])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     mem[0:4] = b'\x01\x02\x03\x04'
     [ret] = await canon_stream_write(StreamType(U8Type()), lower_opts, task, wsi, 0, 4)
     assert(ret == definitions.BLOCKED)
@@ -1748,7 +1748,7 @@ async def core_func(task, args):
 
     retp = 16
     [ret] = await canon_lower(lower_opts, host_ft2, host_func2, task, [retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi = mem[retp]
     [ret] = await canon_stream_read(StreamType(U8Type()), lower_opts, task, rsi, 0, 4)
     assert(ret == definitions.BLOCKED)
@@ -1758,7 +1758,7 @@ async def core_func(task, args):
     [] = await canon_stream_close_readable(StreamType(U8Type()), task, rsi)
 
     [ret] = await canon_lower(lower_opts, host_ft2, host_func2, task, [retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rsi = mem[retp]
     [ret] = await canon_stream_read(StreamType(U8Type()), lower_opts, task, rsi, 0, 4)
     assert(ret == definitions.BLOCKED)
@@ -1868,7 +1868,7 @@ async def core_func(task, args):
     rfi,wfi = unpack_new_ends(packed)
     retp = 16
     [ret] = await canon_lower(lower_opts, host_ft1, host_func, task, [rfi, retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rfi = mem[retp]
 
     readp = 0
@@ -1897,7 +1897,7 @@ async def core_func(task, args):
     [packed] = await canon_future_new(FutureType(U8Type()), task)
     rfi,wfi = unpack_new_ends(packed)
     [ret] = await canon_lower(lower_opts, host_ft1, host_func, task, [rfi, retp])
-    assert(ret == 0)
+    assert(ret == Subtask.State.RETURNED)
     rfi = mem[retp]
 
     readp = 0