Skip to content

Commit 4485629

Browse files
chore: rename revoke_buffer to reclaim_buffer
This commit renames `revoke_buffer` which is used during stream copying to `reclaim_buffer` which hopefully better conveys (if only slightly) the handoff/change in ownership of the buffer in use. Signed-off-by: Victor Adossi <vadossi@cosmonic.com>
1 parent e362068 commit 4485629

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

design/mvp/CanonicalABI.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3880,7 +3880,7 @@ Next, the `copy` method of `{Readable,Writable}{Stream,Future}End` is called to
38803880
perform the actual read/write. The `on_copy*` callbacks passed to `copy` bind
38813881
and store a `stream_event` closure on the readable/writable end (via the
38823882
inherited `Waitable.set_event`) which will be called right before the event is
3883-
delivered to core wasm. `stream_event` first calls `revoke_buffer` to regain
3883+
delivered to core wasm. `stream_event` first calls `reclaim_buffer` to regain
38843884
ownership of `buffer` and prevent any further partial reads/writes. Thus, up
38853885
until event delivery, the other end of the stream is free to repeatedly
38863886
read/write from/to `buffer`, ideally filling it up and minimizing context
@@ -3890,8 +3890,8 @@ all future use of this stream end. Lastly, `stream_event` packs the
38903890
`CopyResult` and number of elements copied up until this point into a single
38913891
`i32` payload for core wasm.
38923892
```python
3893-
def stream_event(result, revoke_buffer):
3894-
revoke_buffer()
3893+
def stream_event(result, reclaim_buffer):
3894+
reclaim_buffer()
38953895
assert(e.copying)
38963896
e.copying = False
38973897
if result == CopyResult.DROPPED:
@@ -3902,11 +3902,11 @@ all future use of this stream end. Lastly, `stream_event` packs the
39023902
return (event_code, i, packed_result)
39033903
return (event_code, i, pack_stream_result(result, buffer))
39043904

3905-
def on_copy(revoke_buffer):
3906-
e.set_event(partial(stream_event, CopyResult.COMPLETED, revoke_buffer))
3905+
def on_copy(reclaim_buffer):
3906+
e.set_event(partial(stream_event, CopyResult.COMPLETED, reclaim_buffer))
39073907

39083908
def on_copy_done(result):
3909-
e.set_event(partial(stream_event, result, revoke_buffer = lambda:()))
3909+
e.set_event(partial(stream_event, result, reclaim_buffer = lambda:()))
39103910

39113911
e.copying = True
39123912
e.copy(task.inst, buffer, on_copy, on_copy_done)

design/mvp/canonical-abi/definitions.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2259,8 +2259,8 @@ async def stream_copy(EndT, BufferT, event_code, stream_t, opts, task, i, ptr, n
22592259
cx = LiftLowerContext(opts, task.inst, borrow_scope = None)
22602260
buffer = BufferT(stream_t.t, cx, ptr, n)
22612261

2262-
def stream_event(result, revoke_buffer):
2263-
revoke_buffer()
2262+
def stream_event(result, reclaim_buffer):
2263+
reclaim_buffer()
22642264
assert(e.copying)
22652265
e.copying = False
22662266
if result == CopyResult.DROPPED:
@@ -2271,11 +2271,11 @@ def stream_event(result, revoke_buffer):
22712271
return (event_code, i, packed_result)
22722272
return (event_code, i, pack_stream_result(result, buffer))
22732273

2274-
def on_copy(revoke_buffer):
2275-
e.set_event(partial(stream_event, CopyResult.COMPLETED, revoke_buffer))
2274+
def on_copy(reclaim_buffer):
2275+
e.set_event(partial(stream_event, CopyResult.COMPLETED, reclaim_buffer))
22762276

22772277
def on_copy_done(result):
2278-
e.set_event(partial(stream_event, result, revoke_buffer = lambda:()))
2278+
e.set_event(partial(stream_event, result, reclaim_buffer = lambda:()))
22792279

22802280
e.copying = True
22812281
e.copy(task.inst, buffer, on_copy, on_copy_done)

design/mvp/canonical-abi/run_tests.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,8 +1088,8 @@ def __init__(self, shared, chunk, remain = 2**64):
10881088
async def read_all():
10891089
while True:
10901090
await self.write_event.wait()
1091-
def on_copy(revoke_buffer):
1092-
revoke_buffer()
1091+
def on_copy(reclaim_buffer):
1092+
reclaim_buffer()
10931093
if not f.done():
10941094
f.set_result(None)
10951095
def on_copy_done(result):

0 commit comments

Comments
 (0)