// Copyright 2019 The go-ethereum Authors // This file is part of the go-ethereum library. // // The go-ethereum library is free software: you can redistribute it and/or modify // it 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 go-ethereum library is distributed in the hope that it 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 . // Implements interaction with EVMC-based VMs. // https://github.com/ethereum/evmc package vm import ( "bytes" "fmt" "math/big" "strings" "sync" "github.com/ethereum/evmc/v7/bindings/go/evmc" "github.com/holiman/uint256" "github.com/ledgerwatch/turbo-geth/common" "github.com/ledgerwatch/turbo-geth/core/types" "github.com/ledgerwatch/turbo-geth/log" "github.com/ledgerwatch/turbo-geth/params" ) // EVMC represents the reference to a common EVMC-based VM instance and // the current execution context as required by go-ethereum design. type EVMC struct { instance *evmc.VM // The reference to the EVMC VM instance. env *EVM // The execution context. cap evmc.Capability // The supported EVMC capability (EVM or Ewasm) readOnly bool // The readOnly flag (TODO: Try to get rid of it). } var ( evmModule *evmc.VM ewasmModule *evmc.VM evmcMux sync.Mutex ) func InitEVMCEVM(config string) { evmcMux.Lock() defer evmcMux.Unlock() if evmModule != nil { return } evmModule = initEVMC(evmc.CapabilityEVM1, config) log.Info("initialized EVMC interpreter", "path", config) } func InitEVMCEwasm(config string) { evmcMux.Lock() defer evmcMux.Unlock() if ewasmModule != nil { return } ewasmModule = initEVMC(evmc.CapabilityEWASM, config) } func initEVMC(cap evmc.Capability, config string) *evmc.VM { options := strings.Split(config, ",") path := options[0] if path == "" { panic("EVMC VM path not provided, set --vm.(evm|ewasm)=/path/to/vm") } instance, err := evmc.Load(path) if err != nil { panic(err.Error()) } log.Info("EVMC VM loaded", "name", instance.Name(), "version", instance.Version(), "path", path) // Set options before checking capabilities. for _, option := range options[1:] { if idx := strings.Index(option, "="); idx >= 0 { name := option[:idx] value := option[idx+1:] err := instance.SetOption(name, value) if err == nil { log.Info("EVMC VM option set", "name", name, "value", value) } else { log.Warn("EVMC VM option setting failed", "name", name, "error", err) } } } if !instance.HasCapability(cap) { panic(fmt.Errorf("the EVMC module %s does not have requested capability %d", path, cap)) } return instance } // hostContext implements evmc.HostContext interface. type hostContext struct { env *EVM // The reference to the EVM execution context. contract *Contract // The reference to the current contract, needed by Call-like methods. } func (host *hostContext) AccountExists(evmcAddr evmc.Address) bool { addr := common.Address(evmcAddr) if host.env.ChainConfig().IsEIP158(host.env.BlockNumber) { if !host.env.IntraBlockState.Empty(addr) { return true } } else if host.env.IntraBlockState.Exist(addr) { return true } return false } func (host *hostContext) GetStorage(addr evmc.Address, evmcKey evmc.Hash) evmc.Hash { var value uint256.Int key := common.Hash(evmcKey) host.env.IntraBlockState.GetState(common.Address(addr), &key, &value) return evmc.Hash(value.Bytes32()) } func (host *hostContext) SetStorage(evmcAddr evmc.Address, evmcKey evmc.Hash, evmcValue evmc.Hash) (status evmc.StorageStatus) { addr := common.Address(evmcAddr) key := common.Hash(evmcKey) value := uint256.NewInt().SetBytes(evmcValue[:]) var oldValue uint256.Int host.env.IntraBlockState.GetState(addr, &key, &oldValue) if oldValue.Eq(value) { return evmc.StorageUnchanged } var current, original uint256.Int host.env.IntraBlockState.GetState(addr, &key, ¤t) host.env.IntraBlockState.GetCommittedState(addr, &key, &original) host.env.IntraBlockState.SetState(addr, &key, *value) hasNetStorageCostEIP := host.env.ChainConfig().IsConstantinople(host.env.BlockNumber) && !host.env.ChainConfig().IsPetersburg(host.env.BlockNumber) if !hasNetStorageCostEIP { status = evmc.StorageModified if oldValue.IsZero() { return evmc.StorageAdded } else if value.IsZero() { host.env.IntraBlockState.AddRefund(params.SstoreRefundGas) return evmc.StorageDeleted } return evmc.StorageModified } if original == current { if original.IsZero() { // create slot (2.1.1) return evmc.StorageAdded } if value.IsZero() { // delete slot (2.1.2b) host.env.IntraBlockState.AddRefund(params.NetSstoreClearRefund) return evmc.StorageDeleted } return evmc.StorageModified } if !original.IsZero() { if current.IsZero() { // recreate slot (2.2.1.1) host.env.IntraBlockState.SubRefund(params.NetSstoreClearRefund) } else if value.IsZero() { // delete slot (2.2.1.2) host.env.IntraBlockState.AddRefund(params.NetSstoreClearRefund) } } if original.Eq(value) { if original.IsZero() { // reset to original inexistent slot (2.2.2.1) host.env.IntraBlockState.AddRefund(params.NetSstoreResetClearRefund) } else { // reset to original existing slot (2.2.2.2) host.env.IntraBlockState.AddRefund(params.NetSstoreResetRefund) } } return evmc.StorageModifiedAgain } func (host *hostContext) GetBalance(addr evmc.Address) evmc.Hash { return evmc.Hash(common.Hash(host.env.IntraBlockState.GetBalance(common.Address(addr)).Bytes32())) } func (host *hostContext) GetCodeSize(addr evmc.Address) int { return host.env.IntraBlockState.GetCodeSize(common.Address(addr)) } func (host *hostContext) GetCodeHash(evmcAddr evmc.Address) evmc.Hash { addr := common.Address(evmcAddr) if host.env.IntraBlockState.Empty(addr) { return evmc.Hash{} } return evmc.Hash(host.env.IntraBlockState.GetCodeHash(addr)) } func (host *hostContext) GetCode(addr evmc.Address) []byte { return host.env.IntraBlockState.GetCode(common.Address(addr)) } func (host *hostContext) Selfdestruct(evmcAddr evmc.Address, evmcBeneficiary evmc.Address) { addr := common.Address(evmcAddr) beneficiary := common.Address(evmcBeneficiary) db := host.env.IntraBlockState if !db.HasSuicided(addr) { db.AddRefund(params.SelfdestructRefundGas) } db.AddBalance(beneficiary, db.GetBalance(addr)) db.Suicide(addr) } func (host *hostContext) GetTxContext() evmc.TxContext { return evmc.TxContext{ GasPrice: evmc.Hash(common.BigToHash(host.env.GasPrice)), Origin: evmc.Address(host.env.Origin), Coinbase: evmc.Address(host.env.Coinbase), Number: host.env.BlockNumber.Int64(), Timestamp: host.env.Time.Int64(), GasLimit: int64(host.env.GasLimit), Difficulty: evmc.Hash(common.BigToHash(host.env.Difficulty)), } } func (host *hostContext) GetBlockHash(number int64) evmc.Hash { b := host.env.BlockNumber.Int64() if number >= (b-256) && number < b { return evmc.Hash(host.env.GetHash(uint64(number))) } return evmc.Hash{} } func (host *hostContext) EmitLog(addr evmc.Address, evmcTopics []evmc.Hash, data []byte) { topics := make([]common.Hash, len(evmcTopics)) for i, t := range evmcTopics { topics[i] = common.Hash(t) } host.env.IntraBlockState.AddLog(&types.Log{ Address: common.Address(addr), Topics: topics, Data: data, BlockNumber: host.env.BlockNumber.Uint64(), }) } func (host *hostContext) Call(kind evmc.CallKind, evmcDestination evmc.Address, evmcSender evmc.Address, valueBytes evmc.Hash, input []byte, gas int64, depth int, static bool, saltBytes evmc.Hash) (output []byte, gasLeft int64, createAddrEvmc evmc.Address, err error) { destination := common.Address(evmcDestination) var createAddr common.Address gasU := uint64(gas) var gasLeftU uint64 value := uint256.NewInt() value.SetBytes(valueBytes[:]) salt := big.NewInt(0) salt.SetBytes(saltBytes[:]) switch kind { case evmc.Call: if static { output, gasLeftU, err = host.env.StaticCall(host.contract, destination, input, gasU) } else { output, gasLeftU, err = host.env.Call(host.contract, destination, input, gasU, value) } case evmc.DelegateCall: output, gasLeftU, err = host.env.DelegateCall(host.contract, destination, input, gasU) case evmc.CallCode: output, gasLeftU, err = host.env.CallCode(host.contract, destination, input, gasU, value) case evmc.Create: var createOutput []byte createOutput, createAddr, gasLeftU, err = host.env.Create(host.contract, input, gasU, value) createAddrEvmc = evmc.Address(createAddr) isHomestead := host.env.ChainConfig().IsHomestead(host.env.BlockNumber) if !isHomestead && err == ErrCodeStoreOutOfGas { err = nil } if err == ErrExecutionReverted { // Assign return buffer from REVERT. // TODO: Bad API design: return data buffer and the code is returned in the same place. In worst case // the code is returned also when there is not enough funds to deploy the code. output = createOutput } case evmc.Create2: var createOutput []byte createOutput, createAddr, gasLeftU, err = host.env.Create2(host.contract, input, gasU, value, salt) createAddrEvmc = evmc.Address(createAddr) if err == ErrExecutionReverted { // Assign return buffer from REVERT. // TODO: Bad API design: return data buffer and the code is returned in the same place. In worst case // the code is returned also when there is not enough funds to deploy the code. output = createOutput } default: panic(fmt.Errorf("EVMC: Unknown call kind %d", kind)) } // Map errors. if err == ErrExecutionReverted { err = evmc.Revert } else if err != nil { err = evmc.Failure } gasLeft = int64(gasLeftU) return output, gasLeft, createAddrEvmc, err } // getRevision translates ChainConfig's HF block information into EVMC revision. func getRevision(env *EVM) evmc.Revision { n := env.BlockNumber conf := env.ChainConfig() switch { case conf.IsPetersburg(n): return evmc.Petersburg case conf.IsConstantinople(n): return evmc.Constantinople case conf.IsByzantium(n): return evmc.Byzantium case conf.IsEIP158(n): return evmc.SpuriousDragon case conf.IsEIP150(n): return evmc.TangerineWhistle case conf.IsHomestead(n): return evmc.Homestead default: return evmc.Frontier } } // Run implements Interpreter.Run(). func (evm *EVMC) Run(contract *Contract, input []byte, readOnly bool) (ret []byte, err error) { evm.env.depth++ defer func() { evm.env.depth-- }() // Don't bother with the execution if there's no code. if len(contract.Code) == 0 { return nil, nil } kind := evmc.Call if evm.env.IntraBlockState.GetCodeSize(contract.Address()) == 0 { // Guess if this is a CREATE. kind = evmc.Create } // Make sure the readOnly is only set if we aren't in readOnly yet. // This makes also sure that the readOnly flag isn't removed for child calls. if readOnly && !evm.readOnly { evm.readOnly = true defer func() { evm.readOnly = false }() } output, gasLeft, err := evm.instance.Execute( &hostContext{evm.env, contract}, getRevision(evm.env), kind, evm.readOnly, evm.env.depth-1, int64(contract.Gas), evmc.Address(contract.Address()), evmc.Address(contract.Caller()), input, evmc.Hash(contract.value.Bytes32()), contract.Code, evmc.Hash{}) contract.Gas = uint64(gasLeft) if err == evmc.Revert { err = ErrExecutionReverted } else if evmcError, ok := err.(evmc.Error); ok && evmcError.IsInternalError() { panic(fmt.Sprintf("EVMC VM internal error: %s", evmcError.Error())) } return output, err } // CanRun implements Interpreter.CanRun(). func (evm *EVMC) CanRun(code []byte) bool { required := evmc.CapabilityEVM1 wasmPreamble := []byte("\x00asm") if bytes.HasPrefix(code, wasmPreamble) { required = evmc.CapabilityEWASM } return evm.cap == required }