update subtask.cancel implementation to match latest spec tweak - #14382
Merged
Merged
Conversation
WebAssembly/component-model#726 refined the behavior of `subtask.cancel` to more closely match how async-lowered calls behave, meaning the runtime must resume the cancelling thread specifically as soon as the cancellee suspends or exits. This required some refactoring, and I believe it's a net simplification of how the runtime decides which thread to switch to and when. - Both guest->guest calls and `subtask.cancel` use a new `SuspendReason::YieldingToSubtask` variant which replaces `WaitingForGuestSubtask` and means "I'm yielding specifically to the specified (via `ConcurrentState::switch_item`) subtask and expect to be resumed when that subtask suspends or exits." - I've removed `GuestTask::switch_item` in favor of a new `ConcurrentState::next_switch_item` field. This addresses a case exercised by the new `cancel-resumed-callback-switch.wast` test where a subtask, while being cancelled, explicitly resumes a thread belonging to a different task, which then suspends, in which case we need to resume the cancelling thread. This new `next_switch_item` field is saved and restored as needed so that a stack of cancels and guest->guest calls can each yield to their respective subtasks and return to their respective callers/cancellers without clobbering each other. - The new `cancel-targeted-resume.wast` test revealed that Wasmtime was out of compliance regarding `CALLBACK_CODE_YIELD`; when a task is cancelled while it is stacklessly yielding, we must promote it so the `cancel` event can be delivered deterministically. I've addressed this by defining a new `WakeOnCancel` enum type which can represent a thread which is waiting cancellably, yielding cancellably, or neither. Since the aforementioned spec PR has not yet been merged as of this writing, I haven't updated the `tests/component-model` submodule yet, but I've verified locally that the new tests pass.
alexcrichton
approved these changes
Sep 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WebAssembly/component-model#726 refined the behavior of
subtask.cancelto more closely match how async-lowered calls behave, meaning the runtime must resume the cancelling thread specifically as soon as the cancellee suspends or exits.This required some refactoring, and I believe it's a net simplification of how the runtime decides which thread to switch to and when.
Both guest->guest calls and
subtask.canceluse a newSuspendReason::YieldingToSubtaskvariant which replacesWaitingForGuestSubtaskand means "I'm yielding specifically to the specified (viaConcurrentState::switch_item) subtask and expect to be resumed when that subtask suspends or exits."I've removed
GuestTask::switch_itemin favor of a newConcurrentState::next_switch_itemfield. This addresses a case exercised by the newcancel-resumed-callback-switch.wasttest where a subtask, while being cancelled, explicitly resumes a thread belonging to a different task, which then suspends, in which case we need to resume the cancelling thread. This newnext_switch_itemfield is saved and restored as needed so that a stack of cancels and guest->guest calls can each yield to their respective subtasks and return to their respective callers/cancellers without clobbering each other.The new
cancel-targeted-resume.wasttest revealed that Wasmtime was out of compliance regardingCALLBACK_CODE_YIELD; when a task is cancelled while it is stacklessly yielding, we must promote it so thecancelevent can be delivered deterministically. I've addressed this by defining a newWakeOnCancelenum type which can represent a thread which is waiting cancellably, yielding cancellably, or neither.Since the aforementioned spec PR has not yet been merged as of this writing, I haven't updated the
tests/component-modelsubmodule yet, but I've verified locally that the new tests pass.