Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

recursive EVM call trigger unrecoverable stack overflow #256

Closed
jangko opened this issue Feb 28, 2019 · 7 comments · Fixed by #586, #588 or #598
Closed

recursive EVM call trigger unrecoverable stack overflow #256

jangko opened this issue Feb 28, 2019 · 7 comments · Fixed by #586, #588 or #598

Comments

@jangko
Copy link
Contributor

jangko commented Feb 28, 2019

some GST test such as CallRecursiveBomb0.json will crash the test program without any stack trace, no output at all.

without any additional compiler switch, it will crash at EVM depth around 370. if I increase the stack size with --passL:"-Wl,--stack,<size>" and set the size to 5MB,10MB,20MB --> it will produce stack trace and print stack overflow error. But it will always fail around EVM depth 394 no matter how big the stack is.

EVM stack depth limit is 1024, and we are not even reach half of it.

Are we using too much stack object? Any idea?

@stefantalpalaru
Copy link
Contributor

Last time we discussed this, the consensus was that it's too complicated to reduce stack usage enough to make a difference, so we should avoid recursion in the VM instead.

Some of the ideas thrown around: tail-call optimisation, segmented stacks, trampolines, an explicit loop up to the supported call depth instead of recursion.

@jangko
Copy link
Contributor Author

jangko commented Feb 28, 2019

I hope they are not too complicated, some refactoring to cleanup existing code would help when experimenting with those ideas.

this issue can wait until we have a more stable EVM.

@jangko
Copy link
Contributor Author

jangko commented Mar 21, 2019

after some refactoring, the EVM could reach 658 recursion depth.
the --passL:"-Wl,--stack,<size>" with 4MB stack also can work in release mode.
25 out of 27 'recursive' GST will pass if compiled with 4MB stack.

we can try to keep refactoring to reduce stack usage and at the same time it will simplify transformation process into non-recursive EVM.

I have experimented with state machine iterative EVM, it's ugly, complex, hard to understand, but it works.
need to find more elegant design that does not sacrifice simplicity and performance.

@jangko
Copy link
Contributor Author

jangko commented Apr 4, 2019

finally, we have some progress in this area.
turn out {.computedGoto.} pragma consumes a lot of stack space, I assume the compiler build jump table at the stack. we could build our own manual jump table with macro assistance. and we can continue using recursive EVM until we really, really need to switch into hard-to-do non-recursive EVM.

@mratsim
Copy link
Contributor

mratsim commented Apr 12, 2019

Is the Stack Overflow from Nim 2000 function calls limit in debug or is it from a lower level?

The computed goto table should be inlined with no actual table in assembly just jmp position and no central redispatching.

Edit: probably worth it to check the assembly generated for this implementation. https://github.com/status-im/nimbus/wiki/Interpreter-optimization-resources#nim-implementation-benchmark. There shouldn't be a table only code position to jump to for each opcode.

However the recursive CALL instructions might need a trampoline of some sort.

@jangko
Copy link
Contributor Author

jangko commented Apr 12, 2019

after some refactoring, the EVM could reach 658 recursion depth.

Simply removing computed goto pragma allow the EVM to reach 1400+ recursion depth. there must be something on the stack. But I will take a closer look.

@jlokier
Copy link
Contributor

jlokier commented Apr 26, 2021

Last time we discussed this, the consensus was that it's too complicated to reduce stack usage enough to make a difference, so we should avoid recursion in the VM instead.

Some of the ideas thrown around: tail-call optimisation, segmented stacks, trampolines, an explicit loop up to the supported call depth instead of recursion.

This makes me smile. You might enjoy the linked PR #586, which reduces worst-case EVM stack usage from 13 MB to 48 kB in a small and easy to understand patch.

#588 takes it further by eliminating recursion, and then #598 solves the problem in EVMC mode (EVMC API is intrinsically recursive, but we can still make it use less stack).

There is no realistic performance impact because it doesn't touch the interpreter loop or most ops. It uses a trampoline of sorts, i.e. a Nim closure, just for the call/create ops. The trick is that only a few opcodes trigger EVM recursion, and they are already moderately heavy, so a little transformation of those leaving everything else the same is enough. Kudos to whoever designed the EVM in the first place, for providing the Computation state that was easy to build upon.

This method is flexible enough that it can also be used to asyncify the EVM (await on SLOAD etc) without penalty to other ops or changing much code.

jlokier added a commit that referenced this issue Apr 27, 2021
This patch reduces stack space used with EVM in ENABLE_EVMC=1 mode, from 13 MB
worst case to 550 kB, a 24x reduction, and fixes stack overflows.

This finishes the "stack problem" and closes #575 (EVM: Different segmentation
faults when running the test suite with EVMC).

It also closes #256 (recursive EVM call trigger unrecoverable stack overflow).

After this patch, it is possible to re-enable the CI targets which had to be
disabled due to #575.

This change is a required precursor for switching over to "nearly EVMC" as the
clean and focused Nimbus-internal API between EVM and sync/database processes,
and is also key to the use of Chronos `async` in those processes when calling
the EVM.

(The motivation is the internal interface has to be substantially changed
_anyway_ for the parallel sync and database processes, and EVMC turns out to be
well-designed and well-suited for this.  It provides good separation between
modules, and suits our needs better than our other current interface.  Might as
well use a good one designed by someone else.  EVMC is 98% done in Nimbus
thanks to great work done before by @jangko, and we can use Nimbus-specific
extensions where we need flexibility, including for performance.  Being aligned
with the ecosystem is a useful bonus feature.)

All tests below were run on Ubuntu 20.04 LTS server, x86-64.  This matches one
of the targets that has been disabled for a while in CI in EVMC mode due to
stack overflow crashing the tests, so it's a good choice.

Measurements before
===================

Testing commit `e76e0144 2021-04-22 11:29:42 +0700 add submodules: graphql and
toml-serialization`.

    $ rm -f build/all_tests && make ENABLE_EVMC=1 test
    $ ulimit -S -s 16384 # Requires larger stack than default to avoid crash.
    $ ./build/all_tests 9 | tee tlog
    [Suite] persist block json tests
    ...
    Stack range 38416 depthHigh 3
    ...
    Stack range 13074720 depthHigh 1024
    [OK] tests/fixtures/PersistBlockTests/block1431916.json

These tests use 13.07 MB of stack to run, and so crash with the default stack
limit on Ubuntu Server 20.04 (8MB).  Exactly 12768 bytes per EVM call stack
frame.

    $ rm -f build/all_tests && make ENABLE_EVMC=1 test
    $ ulimit -S -s 16384 # Requires larger stack than default.
    $ ./build/all_tests 7 | tee tlog
    [Suite] new generalstate json tests
        ...
    Stack range 14384 depthHigh 2
        ...
    Stack range 3495456 depthHigh 457
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stRandom2/randomStatetest639.json
    ...
    Stack range 3709600 depthHigh 485
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stRandom2/randomStatetest458.json
        ...
    Stack range 7831600 depthHigh 1024
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stCreate2/Create2OnDepth1024.json

These tests use 7.83MB of stack to run.  About 7648 bytes per EVM call stack
frame.  It _only just_ avoids crashing with the default Ubuntu Server stack
limit of 8 MB.  However, it still crashes on Windows x86-64, which is why the
Windows CI EVMC target is currently disabled.

On Linux where this passes, this is so borderline that it affects work and
testing of the complex storage code, because that's called from the EVM.

Also, this greatly exceeds the default thread stack size.

Measurements after
==================

    $ rm -f build/all_tests && make ENABLE_EVMC=1 test
    $ ulimit -S -s 600 # Because we can!  600k stack.
    $ ./build/all_tests 9 | tee tlog
    [Suite] persist block json tests
    ...
    Stack range 1936 depthHigh 3
    ...
        Stack range 556272 depthHigh 1022
        Stack range 556512 depthHigh 1023
        Stack range 556816 depthHigh 1023
        Stack range 557056 depthHigh 1024
        Stack range 557360 depthHigh 1024
        [OK] tests/fixtures/PersistBlockTests/block1431916.json

    $ rm -f build/all_tests && make ENABLE_EVMC=1 test
    $ ulimit -S -s 600 # Because we can!  600k stack.
    $ ./build/all_tests 7 | tee tlog
    [Suite] new generalstate json tests
        ...
    Stack range 1392 depthHigh 2
        ...
    Stack range 248912 depthHigh 457
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stRandom2/randomStatetest639.json
    ...
    Stack range 264144 depthHigh 485
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stRandom2/randomStatetest458.json
        ...
        Stack range 557360 depthHigh 1024
    [OK] tests/fixtures/eth_tests/GeneralStateTests/stStaticCall/static_CallRecursiveBombPreCall.json

For both tests, a satisfying *544 bytes* per EVM call stack frame, and EVM
takes less than 600 kB total.  With other overheads, both tests run in 600 kB
stack total at maximum EVM depth.

We must add some headroom on this for database activity called from the EVM,
and different compile targets.  But it means the EVM itself is no longer a
stack burden.

This is much smaller than the default thread stack size on Linux (2MB), with
plenty of margin.  (Just fyi, it isn't smaller than a _small_ thread stack on
Linux from a long time ago (128kB), and some small embedded C targets.)

This size is well suited to running EVMs in threads.

Further reduction
=================

This patch solves the stack problem.  Windows and Linux 64-bit EVMC CI targets
can be re-enabled, and there is no longer a problem with stack usage.

We can reduce further to ~340 bytes per frame and 350 kB total, while still
complying with EVMC.  But as this involves changing how errors are handled to
comply fully with EVMC, and removing `dispose` calls, it's not worth doing now
while there are other EVMC changes in progress that will have the same effect.

A Nimbus-specific extension will allow us to avoid recursion with EVMC anyway,
bringing bytes per frame to zero.  We need the extension anyway, to support
Chronos `async` which parallel transaction processing is built around.

Interop with non-Nimbus over EVMC won't let us avoid recursion, but then we
can't control the stack frame size either.  To prevent stack overflow in
interop I anticipate using (this method in Aleth)
[https://github.com/ethereum/aleth/blob/6e96ce34e3f131e2d42f3cb00741b54e05ab029d/libethereum/ExtVM.cpp#L61].

Smoke test other versions of GCC and Clang/LLVM
===============================================

As all builds including Windows use GCC or Apple's Clang/LLVM, this is just to
verify we're in the right ballpark on all targets.  I've only checked `x86_64`
though, not 32-bit, and not ARM.

It's interesting to see GCC 10 uses less stack.  This is because it optimises
`struct` returns better, sometimes skipping an intermediate copy.  Here it
benefits the EVMC API, but I found GCC 10 also improves the larger stack usage
of the rest of `nimbus-eth1` as well.

Apple clang 12.0.0 (clang-1200.0.26.2) on MacOS 10.15:

- 544 bytes per EVM call stack frame

GCC 10.3.0 (Ubuntu 10.3.0-1ubuntu1) on Ubuntu 21.04:

- 464 bytes per EVM call stack frame

GCC 10.2.0 (Ubuntu 10.2.0-5ubuntu1~20.04) on Ubuntu 20.04 LTS:

- 464 bytes per EVM call stack frame

GCC 11.0.1 20210417 (experimental; Ubuntu 11-20210417-1ubuntu1) on Ubuntu 21.04:

- 8 bytes per EVM call stack frame

GCC 9.3.0 (Ubuntu 9.3.0-17ubuntu1~20.04) on Ubuntu 20.04 LTS:

- 544 bytes per EVM call stack frame

GCC 8.4.0 (Ubuntu 8.4.0-3ubuntu2) on Ubuntu 20.04 LTS:

- 544 bytes per EVM call stack frame

GCC 7.5.0 (Ubuntu 7.5.0-6ubuntu2) on Ubuntu 20.04 LTS:

- 544 bytes per EVM call stack frame

GCC 9.2.1 20191008 (Ubuntu 9.2.1-9ubuntu2) on Ubuntu 19.10:

- 528 bytes per EVM call stack frame

Signed-off-by: Jamie Lokier <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants