mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-20 21:54:30 +00:00
1bccf4f2dd
## Why this should be merged The `temporary.WithTempRegisteredExtras()` global lock introduced in #234 wasn't fit for purpose when used in `coreth` as it required central coordination of registration, types, and usage of the payload accessor. ## How this works Instead of a central registration point, the new `libevm.WithTemporaryExtrasLock()` function takes out a global lock and provides the caller with a handle that proves the lock is held. All of the override functions, e.g. `params.WithTempRegisteredExtras()` now require a current lock, which will be propagated by the respective `coreth` functions. See https://github.com/ava-labs/coreth/pull/1328 for intended usage in `coreth` and `subnet-evm`. A consumer of both of these can then safely do the following: ```go import ( "github.com/ava-labs/libevm/libevm" coreth "github.com/ava-labs/coreth/plugin/evm" subnet "github.com/ava-labs/subnet-evm/plugin/evm" ) // asCChain calls `fn` while emulating `coreth`. It is safe for concurrent usage with [asSubnetEVM]. func asCChain(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return coreth.WithTempRegisteredLibEVMExtras(l, fn) }) } // asSubnetEVM calls `fn` while emulating `subnet-evm`. It is safe for concurrent usage with [asCChain]. func asSubnetEVM(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return subnet.WithTempRegisteredLibEVMExtras(l, fn) }) } ``` ## How this was tested Unit test of the new function plus existing integration tests of all modified code.
99 lines
3.5 KiB
Go
99 lines
3.5 KiB
Go
// Copyright 2024-2025 the libevm authors.
|
|
//
|
|
// The libevm additions to go-ethereum are free software: you can redistribute
|
|
// them and/or modify them under the terms of the GNU Lesser General Public License
|
|
// as published by the Free Software Foundation, either version 3 of the License,
|
|
// or (at your option) any later version.
|
|
//
|
|
// The libevm additions are distributed in the hope that they will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
|
|
// General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see
|
|
// <http://www.gnu.org/licenses/>.
|
|
|
|
package vm
|
|
|
|
import (
|
|
"github.com/ava-labs/libevm/libevm"
|
|
"github.com/ava-labs/libevm/libevm/register"
|
|
"github.com/ava-labs/libevm/params"
|
|
)
|
|
|
|
// RegisterHooks registers the Hooks. It is expected to be called in an `init()`
|
|
// function and MUST NOT be called more than once.
|
|
func RegisterHooks(h Hooks) {
|
|
libevmHooks.MustRegister(h)
|
|
}
|
|
|
|
// WithTempRegisteredHooks temporarily registers `h` as if calling
|
|
// [RegisterHooks] the same type parameter. After `fn` returns, the registration
|
|
// is returned to its former state, be that none or the types originally passed
|
|
// to [RegisterHooks].
|
|
//
|
|
// This MUST NOT be used on a live chain. It is solely intended for off-chain
|
|
// consumers that require access to extras. Said consumers SHOULD NOT, however
|
|
// call this function directly. Use the libevm/temporary.WithRegisteredExtras()
|
|
// function instead as it atomically overrides all possible packages.
|
|
func WithTempRegisteredHooks(lock libevm.ExtrasLock, h Hooks, fn func() error) error {
|
|
if err := lock.Verify(); err != nil {
|
|
return err
|
|
}
|
|
return libevmHooks.TempOverride(h, fn)
|
|
}
|
|
|
|
// TestOnlyClearRegisteredHooks clears the [Hooks] previously passed to
|
|
// [RegisterHooks]. It panics if called from a non-testing call stack.
|
|
func TestOnlyClearRegisteredHooks() {
|
|
libevmHooks.TestOnlyClear()
|
|
}
|
|
|
|
var libevmHooks register.AtMostOnce[Hooks]
|
|
|
|
// Hooks are arbitrary configuration functions to modify default VM behaviour.
|
|
// See [RegisterHooks].
|
|
type Hooks interface {
|
|
OverrideNewEVMArgs(*NewEVMArgs) *NewEVMArgs
|
|
OverrideEVMResetArgs(params.Rules, *EVMResetArgs) *EVMResetArgs
|
|
}
|
|
|
|
// NewEVMArgs are the arguments received by [NewEVM], available for override
|
|
// via [Hooks].
|
|
type NewEVMArgs struct {
|
|
BlockContext BlockContext
|
|
TxContext TxContext
|
|
StateDB StateDB
|
|
ChainConfig *params.ChainConfig
|
|
Config Config
|
|
}
|
|
|
|
// EVMResetArgs are the arguments received by [EVM.Reset], available for
|
|
// override via [Hooks].
|
|
type EVMResetArgs struct {
|
|
TxContext TxContext
|
|
StateDB StateDB
|
|
}
|
|
|
|
func overrideNewEVMArgs(
|
|
blockCtx BlockContext,
|
|
txCtx TxContext,
|
|
statedb StateDB,
|
|
chainConfig *params.ChainConfig,
|
|
config Config,
|
|
) (BlockContext, TxContext, StateDB, *params.ChainConfig, Config) {
|
|
if !libevmHooks.Registered() {
|
|
return blockCtx, txCtx, statedb, chainConfig, config
|
|
}
|
|
args := libevmHooks.Get().OverrideNewEVMArgs(&NewEVMArgs{blockCtx, txCtx, statedb, chainConfig, config})
|
|
return args.BlockContext, args.TxContext, args.StateDB, args.ChainConfig, args.Config
|
|
}
|
|
|
|
func (evm *EVM) overrideEVMResetArgs(txCtx TxContext, statedb StateDB) (TxContext, StateDB) {
|
|
if !libevmHooks.Registered() {
|
|
return txCtx, statedb
|
|
}
|
|
args := libevmHooks.Get().OverrideEVMResetArgs(evm.chainRules, &EVMResetArgs{txCtx, statedb})
|
|
return args.TxContext, args.StateDB
|
|
}
|