feat(executor): implement stack overflow protection #4559
+203
−8
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR introduces a configurable max call stack depth in the runtime, wires it through the C API, and adds executor and test changes so recursive Wasm programs trap with a defined CallStackExhausted error instead of hanging or crashing (addressing #2079 and #4410).
Changes:
- Add a new
CallStackExhaustedWASM error (0x041A) and aMaxCallDepthfield toRuntimeConfigurewith a default of 10000, plus C API getters/setters and VM behavior that checks depth inenterFunctionfor host, compiled, and native functions. - Implement
assert_exhaustionhandling in the spec tests to assert execution-phaseCallStackExhaustederrors, and add a dedicated stack overflow test module (stack_overflow.wat) plus GTest coverage for various depth limits and recursion patterns. - Extend the public C API (
wasmedge_configure.h/wasmedge.cpp) and existing configuration tests to cover the new call depth limit behavior, including null-config safety.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
lib/executor/helper.cpp |
Adds pre-frame checks against RuntimeConfigure::getMaxCallDepth() in all enterFunction paths (host, compiled, native) and returns the new CallStackExhausted error on overflow to prevent unbounded recursion and stack faults. |
include/runtime/stackmgr.h |
Introduces getFrameDepth() to expose the current number of frames so executor can enforce the configured max depth. |
include/common/configure.h |
Extends RuntimeConfigure with an atomic MaxCallDepth (default 10000), copy-ctor initialization, and setMaxCallDepth/getMaxCallDepth accessors. |
include/common/enum.inc |
Defines the new CallStackExhausted error code (0x041A, message "call stack exhausted") in the WASM execution error space. |
include/api/wasmedge/wasmedge_configure.h |
Exposes WasmEdge_ConfigureSetMaxCallDepth / WasmEdge_ConfigureGetMaxCallDepth in the public C API with documentation describing the new depth limit. |
lib/api/wasmedge.cpp |
Implements the new configure C API functions by forwarding to RuntimeConfigure::setMaxCallDepth / getMaxCallDepth, mirroring the existing max-memory-page pattern. |
test/spec/spectest.cpp |
Implements CommandID::AssertExhaustion by invoking the action and asserting that failures are execution-phase CallStackExhausted errors; introduces one new failure-path assertion to force a test failure on unexpected success. |
test/api/apiTestData/stack_overflow.wat |
Adds a small Wasm module with an infinite recursion export and a parameterized deep-recursion export used by the new API stack overflow tests. |
test/api/APIUnitTest.cpp |
Extends APICoreTest.Configure to validate the new call depth configure APIs (including null-context behavior) and adds APICoreTest.StackOverflow to exercise default, low, and high call depth limits with the new Wasm test module and verify the 0x041A WASM error. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
Hi @criticic, |
cc4837e to
2b0f292
Compare
Collaborator
|
In my opinion, I believe this implementation surely can prevent from the runtime overflow becuase it strickly limited the calling frame size. |
Add configurable call stack depth limit to prevent infinite recursion and stack overflow issues. Fixes WasmEdge#2079 and WasmEdge#4410. Changes: - Add CallStackExhausted error code (0x041A) in execution phase - Add MaxCallDepth configuration option (default: 10000) to RuntimeConfigure - Add stack depth checks before pushing frames in enterFunction() - Checks added for host functions, compiled functions, and native functions - Implement assert_exhaustion handler in spec tests - Add C API functions: WasmEdge_ConfigureSetMaxCallDepth() and WasmEdge_ConfigureGetMaxCallDepth() - Add comprehensive unit tests for stack overflow scenarios Signed-off-by: Sagnik Mandal <acriticalcynic@outlook.com>
2b0f292 to
b441bfc
Compare
Author
I could not find anything in the spec about what the default call stack size should be. I'll also look at other implementations and see what they have done regarding this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add configurable call stack depth limit to prevent infinite recursion and stack overflow issues. Fixes #2079 and #4410.
Changes: