interpreter.go 7.53 KB
Newer Older
1
// Copyright 2014 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
5 6 7 8
// 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.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
15
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16

obscuren's avatar
obscuren committed
17
package vm
18

obscuren's avatar
obscuren committed
19 20
import (
	"fmt"
21
	"sync/atomic"
22

23
	"github.com/ethereum/go-ethereum/common/math"
24
	"github.com/ethereum/go-ethereum/params"
obscuren's avatar
obscuren committed
25
)
obscuren's avatar
obscuren committed
26

27
// Config are the configuration options for the Interpreter
28
type Config struct {
29
	// Debug enabled debugging Interpreter options
30 31 32
	Debug bool
	// Tracer is the op code logger
	Tracer Tracer
33
	// NoRecursion disabled Interpreter call, callcode,
34 35
	// delegate call and create.
	NoRecursion bool
36 37
	// Enable recording of SHA3/keccak preimages
	EnablePreimageRecording bool
38
	// JumpTable contains the EVM instruction table. This
39
	// may be left uninitialised and will be set to the default
40 41
	// table.
	JumpTable [256]operation
42 43
}

44
// Interpreter is used to run Ethereum based contracts and will utilise the
45
// passed environment to query external sources for state information.
46
// The Interpreter will run the byte code VM based on the passed
47
// configuration.
48
type Interpreter struct {
49
	evm      *EVM
50 51
	cfg      Config
	gasTable params.GasTable
52
	intPool  *intPool
53

54 55
	readOnly   bool   // Whether to throw on stateful modifications
	returnData []byte // Last CALL's return data for subsequent reuse
obscuren's avatar
obscuren committed
56 57
}

58
// NewInterpreter returns a new instance of the Interpreter.
59
func NewInterpreter(evm *EVM, cfg Config) *Interpreter {
60 61 62 63
	// We use the STOP instruction whether to see
	// the jump table was initialised. If it was not
	// we'll set the default jump table.
	if !cfg.JumpTable[STOP].valid {
64
		switch {
65 66
		case evm.ChainConfig().IsConstantinople(evm.BlockNumber):
			cfg.JumpTable = constantinopleInstructionSet
67 68
		case evm.ChainConfig().IsByzantium(evm.BlockNumber):
			cfg.JumpTable = byzantiumInstructionSet
69 70 71
		case evm.ChainConfig().IsHomestead(evm.BlockNumber):
			cfg.JumpTable = homesteadInstructionSet
		default:
72
			cfg.JumpTable = frontierInstructionSet
73
		}
74 75 76
	}

	return &Interpreter{
77
		evm:      evm,
78
		cfg:      cfg,
79
		gasTable: evm.ChainConfig().GasTable(evm.BlockNumber),
80
		intPool:  newIntPool(),
81
	}
obscuren's avatar
obscuren committed
82 83
}

84
func (in *Interpreter) enforceRestrictions(op OpCode, operation operation, stack *Stack) error {
85
	if in.evm.chainRules.IsByzantium {
86
		if in.readOnly {
87 88
			// If the interpreter is operating in readonly mode, make sure no
			// state-modifying operation is performed. The 3rd stack item
89
			// for a call operation is the value. Transferring value from one
90 91
			// account to the others means the state is modified and should also
			// return with an error.
92
			if operation.writes || (op == CALL && stack.Back(2).BitLen() > 0) {
93 94 95 96
				return errWriteProtection
			}
		}
	}
97 98
	return nil
}
obscuren's avatar
obscuren committed
99

100
// Run loops and evaluates the contract's code with the given input data and returns
101
// the return byte-slice and an error if one occurred.
102 103
//
// It's important to note that any errors returned by the interpreter should be
104 105 106
// considered a revert-and-consume-all-gas operation except for
// errExecutionReverted which means revert-and-keep-gas-left.
func (in *Interpreter) Run(contract *Contract, input []byte) (ret []byte, err error) {
107
	// Increment the call depth which is restricted to 1024
108 109
	in.evm.depth++
	defer func() { in.evm.depth-- }()
110

111 112 113 114
	// Reset the previous call's return data. It's unimportant to preserve the old buffer
	// as every returning call will return new data anyway.
	in.returnData = nil

115 116
	// Don't bother with the execution if there's no code.
	if len(contract.Code) == 0 {
117
		return nil, nil
118 119
	}

120
	var (
121 122 123
		op    OpCode        // current opcode
		mem   = NewMemory() // bound memory
		stack = newstack()  // local stack
124
		// For optimisation reason we're using uint64 as the program counter.
125 126
		// It's theoretically possible to go above 2^64. The YP defines the PC
		// to be uint256. Practically much less so feasible.
127
		pc   = uint64(0) // program counter
128
		cost uint64
129
		// copies used by tracer
130 131 132
		pcCopy  uint64 // needed for the deferred Tracer
		gasCopy uint64 // for Tracer to log gas remaining before execution
		logged  bool   // deferred Tracer should ignore already logged steps
133
	)
134
	contract.Input = input
obscuren's avatar
obscuren committed
135

136 137 138 139 140 141 142 143 144 145 146
	if in.cfg.Debug {
		defer func() {
			if err != nil {
				if !logged {
					in.cfg.Tracer.CaptureState(in.evm, pcCopy, op, gasCopy, cost, mem, stack, contract, in.evm.depth, err)
				} else {
					in.cfg.Tracer.CaptureFault(in.evm, pcCopy, op, gasCopy, cost, mem, stack, contract, in.evm.depth, err)
				}
			}
		}()
	}
147
	// The Interpreter main run loop (contextual). This loop runs until either an
148
	// explicit STOP, RETURN or SELFDESTRUCT is executed, an error occurred during
149 150
	// the execution of one of the operations or until the done flag is set by the
	// parent context.
151
	for atomic.LoadInt32(&in.evm.abort) == 0 {
152
		if in.cfg.Debug {
153 154
			// Capture pre-execution values for tracing.
			logged, pcCopy, gasCopy = false, pc, contract.Gas
155 156
		}

157 158 159
		// Get the operation from the jump table and validate the stack to ensure there are
		// enough stack items available to perform the operation.
		op = contract.GetOp(pc)
160
		operation := in.cfg.JumpTable[op]
161
		if !operation.valid {
162
			return nil, fmt.Errorf("invalid opcode 0x%x", int(op))
163
		}
164 165
		if err := operation.validateStack(stack); err != nil {
			return nil, err
obscuren's avatar
obscuren committed
166
		}
167 168 169 170
		// If the operation is valid, enforce and write restrictions
		if err := in.enforceRestrictions(op, operation, stack); err != nil {
			return nil, err
		}
obscuren's avatar
obscuren committed
171

172
		var memorySize uint64
173 174 175
		// calculate the new memory size and expand the memory to fit
		// the operation
		if operation.memorySize != nil {
176 177 178 179
			memSize, overflow := bigUint64(operation.memorySize(stack))
			if overflow {
				return nil, errGasUintOverflow
			}
180 181
			// memory is expanded in words of 32 bytes. Gas
			// is also calculated in words.
182 183 184
			if memorySize, overflow = math.SafeMul(toWordSize(memSize), 32); overflow {
				return nil, errGasUintOverflow
			}
185
		}
186
		// consume the gas and return an error if not enough gas is available.
187
		// cost is explicitly set so that the capture state defer method can get the proper cost
188 189 190
		cost, err = operation.gasCost(in.gasTable, in.evm, contract, stack, mem, memorySize)
		if err != nil || !contract.UseGas(cost) {
			return nil, ErrOutOfGas
obscuren's avatar
obscuren committed
191
		}
192 193
		if memorySize > 0 {
			mem.Resize(memorySize)
obscuren's avatar
obscuren committed
194
		}
obscuren's avatar
obscuren committed
195

196
		if in.cfg.Debug {
197
			in.cfg.Tracer.CaptureState(in.evm, pc, op, gasCopy, cost, mem, stack, contract, in.evm.depth, err)
198
			logged = true
obscuren's avatar
obscuren committed
199
		}
200

201
		// execute the operation
202
		res, err := operation.execute(&pc, in.evm, contract, mem, stack)
203 204 205
		// verifyPool is a build flag. Pool verification makes sure the integrity
		// of the integer pool by comparing values to a default value.
		if verifyPool {
206
			verifyIntegerPool(in.intPool)
207
		}
208 209 210 211
		// if the operation clears the return data (e.g. it has returning data)
		// set the last return to the result of the operation.
		if operation.returns {
			in.returnData = res
212
		}
213

214 215 216
		switch {
		case err != nil:
			return nil, err
217 218
		case operation.reverts:
			return res, errExecutionReverted
219 220 221 222
		case operation.halts:
			return res, nil
		case !operation.jumps:
			pc++
obscuren's avatar
obscuren committed
223
		}
obscuren's avatar
obscuren committed
224
	}
225
	return nil, nil
226
}