Documentation
¶
Overview ¶
Package vm implements the Ethereum Virtual Machine.
The vm package implements two EVMs, a byte code VM and a JIT VM. The BC (Byte Code) VM loops over a set of bytes and executes them according to the set of rules defined in the Ethereum yellow paper. When the BC VM is invoked it invokes the JIT VM in a separate goroutine and compiles the byte code in JIT instructions.
The JIT VM, when invoked, loops around a set of pre-defined instructions until it either runs of gas, causes an internal error, returns or stops.
The JIT optimiser attempts to pre-compile instructions in to chunks or segments such as multiple PUSH operations and static JUMPs. It does this by analysing the opcodes and attempts to match certain regions to known sets. Whenever the optimiser finds said segments it creates a new instruction and replaces the first occurrence in the sequence.
Index ¶
- Variables
- func CompileProgram(program *Program) (err error)
- func Disasm(code []byte) []string
- func Disassemble(script []byte) (asm []string)
- func GetProgramStatus(id common.Hash) progStatus
- func MatchFn(input, match []OpCode, matcherFn func(int) bool)
- func PrecompiledContracts() map[string]*PrecompiledAccount
- func RunProgram(program *Program, env Environment, contract *Contract, input []byte) ([]byte, error)
- func SetJITCacheSize(size int)
- func StdErrFormat(logs []StructLog)
- type Account
- type Config
- type Contract
- func (c *Contract) Address() common.Address
- func (c *Contract) AsDelegate() *Contract
- func (c *Contract) Caller() common.Address
- func (c *Contract) Finalise()
- func (self *Contract) ForEachStorage(cb func(key, value common.Hash) bool)
- func (c *Contract) GetByte(n uint64) byte
- func (c *Contract) GetOp(n uint64) OpCode
- func (c *Contract) ReturnGas(gas, price *big.Int)
- func (self *Contract) SetCallCode(addr *common.Address, hash common.Hash, code []byte)
- func (self *Contract) SetCode(hash common.Hash, code []byte)
- func (c *Contract) UseGas(gas *big.Int) (ok bool)
- func (c *Contract) Value() *big.Int
- type ContractRef
- type Database
- type EVM
- type Environment
- type Log
- type LogConfig
- type LogForStorage
- type Logger
- type Logs
- type Memory
- type OpCode
- type PrecompiledAccount
- type Program
- type RuleSet
- type Storage
- type StructLog
- type StructLogCollector
- type Type
- type VirtualMachine
- type Vm
Constants ¶
This section is empty.
Variables ¶
var ( Pow256 = common.BigPow(2, 256) // Pow256 is 2**256 U256 = common.U256 // Shortcut to common.U256 S256 = common.S256 // Shortcut to common.S256 Zero = common.Big0 // Shortcut to common.Big0 One = common.Big1 // Shortcut to common.Big1 )
var ( GasQuickStep = big.NewInt(2) GasFastestStep = big.NewInt(3) GasFastStep = big.NewInt(5) GasMidStep = big.NewInt(8) GasSlowStep = big.NewInt(10) GasExtStep = big.NewInt(20) GasReturn = big.NewInt(0) GasStop = big.NewInt(0) GasContractByte = big.NewInt(200) )
var CodeStoreOutOfGasError = errors.New("Contract creation code storage out of gas")
var DepthError = fmt.Errorf("Max call depth exceeded (%d)", params.CallCreateDepth)
var MaxProgSize int // Max cache size for JIT programs
var OutOfGasError = errors.New("Out of gas")
var Precompiled = PrecompiledContracts()
Precompiled contains the default set of ethereum contracts
Functions ¶
func CompileProgram ¶ added in v1.1.0
CompileProgram compiles the given program and return an error when it fails
func Disassemble ¶ added in v0.9.39
Disassemble disassembles the byte code and returns the string representation (human readable opcodes).
func GetProgramStatus ¶ added in v1.1.0
GenProgramStatus returns the status of the given program id
func MatchFn ¶ added in v1.3.1
MatchFn searcher for match in the given input and calls matcheFn if it finds an appropriate match. matcherFn yields the starting position in the input. MatchFn will continue to search for a match until it reaches the end of the buffer or if matcherFn return false.
func PrecompiledContracts ¶ added in v0.9.39
func PrecompiledContracts() map[string]*PrecompiledAccount
PrecompiledContracts returns the default set of precompiled ethereum contracts defined by the ethereum yellow paper.
func RunProgram ¶ added in v1.1.0
func RunProgram(program *Program, env Environment, contract *Contract, input []byte) ([]byte, error)
RunProgram runs the program given the environment and contract and returns an error if the execution failed (non-consensus)
func SetJITCacheSize ¶ added in v1.1.0
func SetJITCacheSize(size int)
SetJITCacheSize recreates the program cache with the max given size. Setting a new cache is **not** thread safe. Use with caution.
func StdErrFormat ¶ added in v0.9.39
func StdErrFormat(logs []StructLog)
StdErrFormat formats a slice of StructLogs to human readable format
Types ¶
type Account ¶ added in v0.9.39
type Account interface { SubBalance(amount *big.Int) AddBalance(amount *big.Int) SetBalance(*big.Int) SetNonce(uint64) Balance() *big.Int Address() common.Address ReturnGas(*big.Int, *big.Int) SetCode(common.Hash, []byte) ForEachStorage(cb func(key, value common.Hash) bool) Value() *big.Int }
Account represents a contract or basic ethereum account.
type Contract ¶
type Contract struct { // CallerAddress is the result of the caller which initialised this // contract. However when the "call method" is delegated this value // needs to be initialised to that of the caller's caller. CallerAddress common.Address Code []byte CodeHash common.Hash CodeAddr *common.Address Input []byte Gas, UsedGas, Price *big.Int Args []byte DelegateCall bool // contains filtered or unexported fields }
Contract represents an ethereum contract in the state database. It contains the the contract code, calling arguments. Contract implements ContractRef
func NewContract ¶
func NewContract(caller ContractRef, object ContractRef, value, gas, price *big.Int) *Contract
NewContract returns a new contract environment for the execution of EVM.
func (*Contract) AsDelegate ¶
AsDelegate sets the contract to be a delegate call and returns the current contract (for chaining calls)
func (*Contract) Caller ¶
Caller returns the caller of the contract.
Caller will recursively call caller when the contract is a delegate call, including that of caller's caller.
func (*Contract) Finalise ¶ added in v1.3.4
func (c *Contract) Finalise()
Finalise finalises the contract and returning any remaining gas to the original caller.
func (*Contract) ForEachStorage ¶ added in v1.4.0
EachStorage iterates the contract's storage and calls a method for every key value pair.
func (*Contract) SetCallCode ¶
SetCallCode sets the code of the contract and address of the backing data object
type ContractRef ¶
type ContractRef interface { ReturnGas(*big.Int, *big.Int) Address() common.Address Value() *big.Int SetCode(common.Hash, []byte) ForEachStorage(callback func(key, value common.Hash) bool) }
ContractRef is a reference to the contract's backing object
type Database ¶ added in v1.3.1
type Database interface { GetAccount(common.Address) Account CreateAccount(common.Address) Account AddBalance(common.Address, *big.Int) GetBalance(common.Address) *big.Int GetNonce(common.Address) uint64 SetNonce(common.Address, uint64) GetCodeHash(common.Address) common.Hash GetCodeSize(common.Address) int GetCode(common.Address) []byte SetCode(common.Address, []byte) AddRefund(*big.Int) GetRefund() *big.Int GetState(common.Address, common.Hash) common.Hash SetState(common.Address, common.Hash, common.Hash) Suicide(common.Address) bool HasSuicided(common.Address) bool // Exist reports whether the given account exists in state. // Notably this should also return true for suicided accounts. Exist(common.Address) bool }
Database is a EVM database for full state querying.
type EVM ¶
type EVM struct {
// contains filtered or unexported fields
}
EVM is used to run Ethereum based contracts and will utilise the passed environment to query external sources for state information. The EVM will run the byte code VM or JIT VM based on the passed configuration.
func New ¶ added in v0.9.39
func New(env Environment, cfg Config) *EVM
New returns a new instance of the EVM.
func (*EVM) Run ¶ added in v1.4.0
Run loops and evaluates the contract's code with the given input data
func (*EVM) RunPrecompiled ¶ added in v1.4.0
func (evm *EVM) RunPrecompiled(p *PrecompiledAccount, input []byte, contract *Contract) (ret []byte, err error)
RunPrecompile runs and evaluate the output of a precompiled contract defined in contracts.go
type Environment ¶ added in v0.9.39
type Environment interface { // The current ruleset RuleSet() RuleSet // The state database Db() Database // Creates a restorable snapshot SnapshotDatabase() int // Set database to previous snapshot RevertToSnapshot(int) // Address of the original invoker (first occurrence of the VM invoker) Origin() common.Address // The block number this VM is invoked on BlockNumber() *big.Int // The n'th hash ago from this block number GetHash(uint64) common.Hash // The handler's address Coinbase() common.Address // The current time (block time) Time() *big.Int // Difficulty set on the current block Difficulty() *big.Int // The gas limit of the block GasLimit() *big.Int // Determines whether it's possible to transact CanTransfer(from common.Address, balance *big.Int) bool // Transfers amount from one account to the other Transfer(from, to Account, amount *big.Int) // Adds a LOG to the state AddLog(*Log) // Type of the VM Vm() Vm // Get the curret calling depth Depth() int // Set the current calling depth SetDepth(i int) // Call another contract Call(me ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error) // Take another's contract code and execute within our own context CallCode(me ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error) // Same as CallCode except sender and value is propagated from parent to child scope DelegateCall(me ContractRef, addr common.Address, data []byte, gas, price *big.Int) ([]byte, error) // Create a new contract Create(me ContractRef, data []byte, gas, price, value *big.Int) ([]byte, common.Address, error) }
Environment is an EVM requirement and helper which allows access to outside information such as states.
type Log ¶ added in v1.3.1
type Log struct { // Consensus fields Address common.Address Topics []common.Hash Data []byte // Derived fields (don't reorder!) BlockNumber uint64 TxHash common.Hash TxIndex uint BlockHash common.Hash Index uint }
func (*Log) MarshalJSON ¶ added in v1.4.0
type LogConfig ¶
type LogConfig struct { DisableMemory bool // disable memory capture DisableStack bool // disable stack capture DisableStorage bool // disable storage capture FullStorage bool // show full storage (slow) Collector StructLogCollector // the log collector }
LogConfig are the configuration options for structured logger the EVM
type LogForStorage ¶ added in v1.3.1
type LogForStorage Log
LogForStorage is a wrapper around a Log that flattens and parses the entire content of a log, as opposed to only the consensus fields originally (by hiding the rlp interface methods).
type Logger ¶ added in v1.4.0
type Logger struct {
// contains filtered or unexported fields
}
Logger is an EVM state logger and implements VmLogger.
Logger can capture state based on the given Log configuration and also keeps a track record of modified storage which is used in reporting snapshots of the contract their storage.
type Memory ¶
type Memory struct {
// contains filtered or unexported fields
}
Memory implements a simple memory model for the ethereum virtual machine.
type OpCode ¶
type OpCode byte
OpCode is an EVM opcode
const ( // 0x60 range PUSH1 OpCode = 0x60 + iota PUSH2 PUSH3 PUSH4 PUSH5 PUSH6 PUSH7 PUSH8 PUSH9 PUSH10 PUSH11 PUSH12 PUSH13 PUSH14 PUSH15 PUSH16 PUSH17 PUSH18 PUSH19 PUSH20 PUSH21 PUSH22 PUSH23 PUSH24 PUSH25 PUSH26 PUSH27 PUSH28 PUSH29 PUSH30 PUSH31 PUSH32 DUP1 DUP2 DUP3 DUP4 DUP5 DUP6 DUP7 DUP8 DUP9 DUP10 DUP11 DUP12 DUP13 DUP14 DUP15 DUP16 SWAP1 SWAP2 SWAP3 SWAP4 SWAP5 SWAP6 SWAP7 SWAP8 SWAP9 SWAP10 SWAP11 SWAP12 SWAP13 SWAP14 SWAP15 SWAP16 )
func Parse ¶ added in v1.3.1
Parse parses all opcodes from the given code byte slice. This function performs no error checking and may return non-existing opcodes.
func StringToOp ¶
func (OpCode) IsStaticJump ¶
type PrecompiledAccount ¶ added in v0.9.39
type PrecompiledAccount struct { Gas func(l int) *big.Int // contains filtered or unexported fields }
PrecompiledAccount represents a native ethereum contract
func (PrecompiledAccount) Call ¶ added in v0.9.39
func (self PrecompiledAccount) Call(in []byte) []byte
Call calls the native function
type Program ¶ added in v1.1.0
type Program struct { Id common.Hash // Id of the program // contains filtered or unexported fields }
Program is a compiled program for the JIT VM and holds all required for running a compiled JIT program.
func GetProgram ¶ added in v1.1.0
GetProgram returns the program by id or nil when non-existent
func NewProgram ¶ added in v1.1.0
NewProgram returns a new JIT program
type RuleSet ¶ added in v1.4.0
RuleSet is an interface that defines the current rule set during the execution of the EVM instructions (e.g. whether it's homestead)
type StructLog ¶
type StructLog struct { Pc uint64 Op OpCode Gas *big.Int GasCost *big.Int Memory []byte Stack []*big.Int Storage map[common.Hash]common.Hash Depth int Err error }
StructLog is emitted to the Environment each cycle and lists information about the current internal state prior to the execution of the statement.
type StructLogCollector ¶ added in v1.4.0
type StructLogCollector interface { // Adds the structured log to the collector. AddStructLog(StructLog) }
StructLogCollector is the basic interface to capture emited logs by the EVM logger.
type VirtualMachine ¶ added in v0.9.39
VirtualMachine is an EVM interface
func NewJitVm ¶ added in v0.9.39
func NewJitVm(env Environment) VirtualMachine