fix(EVM): Implement resetEVMFrame function (#1051)

matter-labs · Oct 30, 2024 · cf476b1 · cf476b1
1 parent df1c554
commit cf476b1
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 0 deletions.
diff --git a/system-contracts/contracts/EvmEmulator.yul b/system-contracts/contracts/EvmEmulator.yul
@@ -619,6 +619,14 @@ object "EvmEmulator" {
             }
         }
 
+        function resetEvmFrame() {
+            // function resetEvmFrame()
+            // non-standard selector 0x05
+            mstore(0, 0x0500000000000000000000000000000000000000000000000000000000000000)
+
+            performSystemCall(EVM_GAS_MANAGER_CONTRACT(), 1)
+        }
+
         ////////////////////////////////////////////////////////////////
         //               CALLS FUNCTIONALITY
         ////////////////////////////////////////////////////////////////
@@ -772,6 +780,9 @@ object "EvmEmulator" {
             )
 
             let frameGasLeft := _saveReturndataAfterEVMCall(add(MEM_OFFSET(), retOffset), retSize)
+            if iszero(success) {
+                resetEvmFrame()
+            }
 
             newGasLeft := add(evmGasLeft, frameGasLeft)
             stackHead := success
@@ -802,6 +813,9 @@ object "EvmEmulator" {
                 }
                 success := call(ergsToPass, addr, value, argsOffset, argsSize, 0, 0)
                 frameGasLeft := _saveReturndataAfterEVMCall(retOffset, retSize)
+                if iszero(success) {
+                    resetEvmFrame()
+                }
             }
         }
 
@@ -1103,6 +1117,7 @@ object "EvmEmulator" {
                     case 0 {
                         addr := 0
                         gasLeft := _saveReturndataAfterEVMCall(0, 0)
+                        resetEvmFrame()
                     }
                     default {
                         gasLeft, addr := _saveConstructorReturnGas()
@@ -3616,6 +3631,14 @@ object "EvmEmulator" {
                 }
             }
 
+            function resetEvmFrame() {
+                // function resetEvmFrame()
+                // non-standard selector 0x05
+                mstore(0, 0x0500000000000000000000000000000000000000000000000000000000000000)
+
+                performSystemCall(EVM_GAS_MANAGER_CONTRACT(), 1)
+            }
+
             ////////////////////////////////////////////////////////////////
             //               CALLS FUNCTIONALITY
             ////////////////////////////////////////////////////////////////
@@ -3769,6 +3792,9 @@ object "EvmEmulator" {
                 )
 
                 let frameGasLeft := _saveReturndataAfterEVMCall(add(MEM_OFFSET(), retOffset), retSize)
+                if iszero(success) {
+                    resetEvmFrame()
+                }
 
                 newGasLeft := add(evmGasLeft, frameGasLeft)
                 stackHead := success
@@ -3799,6 +3825,9 @@ object "EvmEmulator" {
                     }
                     success := call(ergsToPass, addr, value, argsOffset, argsSize, 0, 0)
                     frameGasLeft := _saveReturndataAfterEVMCall(retOffset, retSize)
+                    if iszero(success) {
+                        resetEvmFrame()
+                    }
                 }
             }
 
@@ -4100,6 +4129,7 @@ object "EvmEmulator" {
                         case 0 {
                             addr := 0
                             gasLeft := _saveReturndataAfterEVMCall(0, 0)
+                            resetEvmFrame()
                         }
                         default {
                             gasLeft, addr := _saveConstructorReturnGas()

diff --git a/system-contracts/contracts/EvmGasManager.yul b/system-contracts/contracts/EvmGasManager.yul
@@ -231,6 +231,13 @@ object "EvmGasManager" {
                 warmAccount(coinbase()) // and the coinbase too
                 return(0x0, 0x0)
             }
+            case 5 { // function resetEVMFrame()
+                // Reset EVM frame context data
+                // This method is used by EvmEmulator to clean frame data after failed EVM call.
+                $llvm_AlwaysInline_llvm$_onlyEvmSystemCall()
+
+                tstore(EVM_AUX_DATA_SLOT(), 0) // mark as consumed (clean it)
+            }
             default {
                 revert(0, 0)
             }

diff --git a/system-contracts/evm-emulator/EvmEmulatorFunctions.template.yul b/system-contracts/evm-emulator/EvmEmulatorFunctions.template.yul
@@ -557,6 +557,14 @@ function consumeEvmFrame() -> passGas, isStatic, callerEVM {
     }
 }
 
+function resetEvmFrame() {
+    // function resetEvmFrame()
+    // non-standard selector 0x05
+    mstore(0, 0x0500000000000000000000000000000000000000000000000000000000000000)
+
+    performSystemCall(EVM_GAS_MANAGER_CONTRACT(), 1)
+}
+
 ////////////////////////////////////////////////////////////////
 //               CALLS FUNCTIONALITY
 ////////////////////////////////////////////////////////////////
@@ -710,6 +718,9 @@ function performDelegateCall(oldSp, evmGasLeft, isStatic, oldStackHead) -> newGa
     )
 
     let frameGasLeft := _saveReturndataAfterEVMCall(add(MEM_OFFSET(), retOffset), retSize)
+    if iszero(success) {
+        resetEvmFrame()
+    }
 
     newGasLeft := add(evmGasLeft, frameGasLeft)
     stackHead := success
@@ -740,6 +751,9 @@ function _genericCall(addr, gasToPass, value, argsOffset, argsSize, retOffset, r
         }
         success := call(ergsToPass, addr, value, argsOffset, argsSize, 0, 0)
         frameGasLeft := _saveReturndataAfterEVMCall(retOffset, retSize)
+        if iszero(success) {
+            resetEvmFrame()
+        }
     }
 }
 
@@ -1041,6 +1055,7 @@ function _executeCreate(offset, size, value, evmGasLeftOld, isCreate2, salt) ->
             case 0 {
                 addr := 0
                 gasLeft := _saveReturndataAfterEVMCall(0, 0)
+                resetEvmFrame()
             }
             default {
                 gasLeft, addr := _saveConstructorReturnGas()