github.com/codysnider/go-ethereum@v1.10.18-0.20220420071915-14f4ae99222a/core/vm/instructions.go (about)

     1  // Copyright 2015 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  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     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  // GNU Lesser General Public License for more details.
    13  //
    14  // 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  
    17  package vm
    18  
    19  import (
    20  	"sync/atomic"
    21  
    22  	"github.com/ethereum/go-ethereum/common"
    23  	"github.com/ethereum/go-ethereum/core/types"
    24  	"github.com/ethereum/go-ethereum/params"
    25  	"github.com/holiman/uint256"
    26  	"golang.org/x/crypto/sha3"
    27  )
    28  
    29  func opAdd(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    30  	x, y := scope.Stack.pop(), scope.Stack.peek()
    31  	y.Add(&x, y)
    32  	return nil, nil
    33  }
    34  
    35  func opSub(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    36  	x, y := scope.Stack.pop(), scope.Stack.peek()
    37  	y.Sub(&x, y)
    38  	return nil, nil
    39  }
    40  
    41  func opMul(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    42  	x, y := scope.Stack.pop(), scope.Stack.peek()
    43  	y.Mul(&x, y)
    44  	return nil, nil
    45  }
    46  
    47  func opDiv(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    48  	x, y := scope.Stack.pop(), scope.Stack.peek()
    49  	y.Div(&x, y)
    50  	return nil, nil
    51  }
    52  
    53  func opSdiv(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    54  	x, y := scope.Stack.pop(), scope.Stack.peek()
    55  	y.SDiv(&x, y)
    56  	return nil, nil
    57  }
    58  
    59  func opMod(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    60  	x, y := scope.Stack.pop(), scope.Stack.peek()
    61  	y.Mod(&x, y)
    62  	return nil, nil
    63  }
    64  
    65  func opSmod(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    66  	x, y := scope.Stack.pop(), scope.Stack.peek()
    67  	y.SMod(&x, y)
    68  	return nil, nil
    69  }
    70  
    71  func opExp(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    72  	base, exponent := scope.Stack.pop(), scope.Stack.peek()
    73  	exponent.Exp(&base, exponent)
    74  	return nil, nil
    75  }
    76  
    77  func opSignExtend(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    78  	back, num := scope.Stack.pop(), scope.Stack.peek()
    79  	num.ExtendSign(num, &back)
    80  	return nil, nil
    81  }
    82  
    83  func opNot(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    84  	x := scope.Stack.peek()
    85  	x.Not(x)
    86  	return nil, nil
    87  }
    88  
    89  func opLt(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
    90  	x, y := scope.Stack.pop(), scope.Stack.peek()
    91  	if x.Lt(y) {
    92  		y.SetOne()
    93  	} else {
    94  		y.Clear()
    95  	}
    96  	return nil, nil
    97  }
    98  
    99  func opGt(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   100  	x, y := scope.Stack.pop(), scope.Stack.peek()
   101  	if x.Gt(y) {
   102  		y.SetOne()
   103  	} else {
   104  		y.Clear()
   105  	}
   106  	return nil, nil
   107  }
   108  
   109  func opSlt(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   110  	x, y := scope.Stack.pop(), scope.Stack.peek()
   111  	if x.Slt(y) {
   112  		y.SetOne()
   113  	} else {
   114  		y.Clear()
   115  	}
   116  	return nil, nil
   117  }
   118  
   119  func opSgt(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   120  	x, y := scope.Stack.pop(), scope.Stack.peek()
   121  	if x.Sgt(y) {
   122  		y.SetOne()
   123  	} else {
   124  		y.Clear()
   125  	}
   126  	return nil, nil
   127  }
   128  
   129  func opEq(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   130  	x, y := scope.Stack.pop(), scope.Stack.peek()
   131  	if x.Eq(y) {
   132  		y.SetOne()
   133  	} else {
   134  		y.Clear()
   135  	}
   136  	return nil, nil
   137  }
   138  
   139  func opIszero(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   140  	x := scope.Stack.peek()
   141  	if x.IsZero() {
   142  		x.SetOne()
   143  	} else {
   144  		x.Clear()
   145  	}
   146  	return nil, nil
   147  }
   148  
   149  func opAnd(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   150  	x, y := scope.Stack.pop(), scope.Stack.peek()
   151  	y.And(&x, y)
   152  	return nil, nil
   153  }
   154  
   155  func opOr(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   156  	x, y := scope.Stack.pop(), scope.Stack.peek()
   157  	y.Or(&x, y)
   158  	return nil, nil
   159  }
   160  
   161  func opXor(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   162  	x, y := scope.Stack.pop(), scope.Stack.peek()
   163  	y.Xor(&x, y)
   164  	return nil, nil
   165  }
   166  
   167  func opByte(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   168  	th, val := scope.Stack.pop(), scope.Stack.peek()
   169  	val.Byte(&th)
   170  	return nil, nil
   171  }
   172  
   173  func opAddmod(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   174  	x, y, z := scope.Stack.pop(), scope.Stack.pop(), scope.Stack.peek()
   175  	if z.IsZero() {
   176  		z.Clear()
   177  	} else {
   178  		z.AddMod(&x, &y, z)
   179  	}
   180  	return nil, nil
   181  }
   182  
   183  func opMulmod(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   184  	x, y, z := scope.Stack.pop(), scope.Stack.pop(), scope.Stack.peek()
   185  	z.MulMod(&x, &y, z)
   186  	return nil, nil
   187  }
   188  
   189  // opSHL implements Shift Left
   190  // The SHL instruction (shift left) pops 2 values from the stack, first arg1 and then arg2,
   191  // and pushes on the stack arg2 shifted to the left by arg1 number of bits.
   192  func opSHL(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   193  	// Note, second operand is left in the stack; accumulate result into it, and no need to push it afterwards
   194  	shift, value := scope.Stack.pop(), scope.Stack.peek()
   195  	if shift.LtUint64(256) {
   196  		value.Lsh(value, uint(shift.Uint64()))
   197  	} else {
   198  		value.Clear()
   199  	}
   200  	return nil, nil
   201  }
   202  
   203  // opSHR implements Logical Shift Right
   204  // The SHR instruction (logical shift right) pops 2 values from the stack, first arg1 and then arg2,
   205  // and pushes on the stack arg2 shifted to the right by arg1 number of bits with zero fill.
   206  func opSHR(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   207  	// Note, second operand is left in the stack; accumulate result into it, and no need to push it afterwards
   208  	shift, value := scope.Stack.pop(), scope.Stack.peek()
   209  	if shift.LtUint64(256) {
   210  		value.Rsh(value, uint(shift.Uint64()))
   211  	} else {
   212  		value.Clear()
   213  	}
   214  	return nil, nil
   215  }
   216  
   217  // opSAR implements Arithmetic Shift Right
   218  // The SAR instruction (arithmetic shift right) pops 2 values from the stack, first arg1 and then arg2,
   219  // and pushes on the stack arg2 shifted to the right by arg1 number of bits with sign extension.
   220  func opSAR(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   221  	shift, value := scope.Stack.pop(), scope.Stack.peek()
   222  	if shift.GtUint64(256) {
   223  		if value.Sign() >= 0 {
   224  			value.Clear()
   225  		} else {
   226  			// Max negative shift: all bits set
   227  			value.SetAllOne()
   228  		}
   229  		return nil, nil
   230  	}
   231  	n := uint(shift.Uint64())
   232  	value.SRsh(value, n)
   233  	return nil, nil
   234  }
   235  
   236  func opKeccak256(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   237  	offset, size := scope.Stack.pop(), scope.Stack.peek()
   238  	data := scope.Memory.GetPtr(int64(offset.Uint64()), int64(size.Uint64()))
   239  
   240  	if interpreter.hasher == nil {
   241  		interpreter.hasher = sha3.NewLegacyKeccak256().(keccakState)
   242  	} else {
   243  		interpreter.hasher.Reset()
   244  	}
   245  	interpreter.hasher.Write(data)
   246  	interpreter.hasher.Read(interpreter.hasherBuf[:])
   247  
   248  	evm := interpreter.evm
   249  	if evm.Config.EnablePreimageRecording {
   250  		evm.StateDB.AddPreimage(interpreter.hasherBuf, data)
   251  	}
   252  
   253  	size.SetBytes(interpreter.hasherBuf[:])
   254  	return nil, nil
   255  }
   256  func opAddress(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   257  	scope.Stack.push(new(uint256.Int).SetBytes(scope.Contract.Address().Bytes()))
   258  	return nil, nil
   259  }
   260  
   261  func opBalance(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   262  	slot := scope.Stack.peek()
   263  	address := common.Address(slot.Bytes20())
   264  	slot.SetFromBig(interpreter.evm.StateDB.GetBalance(address))
   265  	return nil, nil
   266  }
   267  
   268  func opOrigin(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   269  	scope.Stack.push(new(uint256.Int).SetBytes(interpreter.evm.Origin.Bytes()))
   270  	return nil, nil
   271  }
   272  func opCaller(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   273  	scope.Stack.push(new(uint256.Int).SetBytes(scope.Contract.Caller().Bytes()))
   274  	return nil, nil
   275  }
   276  
   277  func opCallValue(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   278  	v, _ := uint256.FromBig(scope.Contract.value)
   279  	scope.Stack.push(v)
   280  	return nil, nil
   281  }
   282  
   283  func opCallDataLoad(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   284  	x := scope.Stack.peek()
   285  	if offset, overflow := x.Uint64WithOverflow(); !overflow {
   286  		data := getData(scope.Contract.Input, offset, 32)
   287  		x.SetBytes(data)
   288  	} else {
   289  		x.Clear()
   290  	}
   291  	return nil, nil
   292  }
   293  
   294  func opCallDataSize(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   295  	scope.Stack.push(new(uint256.Int).SetUint64(uint64(len(scope.Contract.Input))))
   296  	return nil, nil
   297  }
   298  
   299  func opCallDataCopy(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   300  	var (
   301  		memOffset  = scope.Stack.pop()
   302  		dataOffset = scope.Stack.pop()
   303  		length     = scope.Stack.pop()
   304  	)
   305  	dataOffset64, overflow := dataOffset.Uint64WithOverflow()
   306  	if overflow {
   307  		dataOffset64 = 0xffffffffffffffff
   308  	}
   309  	// These values are checked for overflow during gas cost calculation
   310  	memOffset64 := memOffset.Uint64()
   311  	length64 := length.Uint64()
   312  	scope.Memory.Set(memOffset64, length64, getData(scope.Contract.Input, dataOffset64, length64))
   313  
   314  	return nil, nil
   315  }
   316  
   317  func opReturnDataSize(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   318  	scope.Stack.push(new(uint256.Int).SetUint64(uint64(len(interpreter.returnData))))
   319  	return nil, nil
   320  }
   321  
   322  func opReturnDataCopy(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   323  	var (
   324  		memOffset  = scope.Stack.pop()
   325  		dataOffset = scope.Stack.pop()
   326  		length     = scope.Stack.pop()
   327  	)
   328  
   329  	offset64, overflow := dataOffset.Uint64WithOverflow()
   330  	if overflow {
   331  		return nil, ErrReturnDataOutOfBounds
   332  	}
   333  	// we can reuse dataOffset now (aliasing it for clarity)
   334  	var end = dataOffset
   335  	end.Add(&dataOffset, &length)
   336  	end64, overflow := end.Uint64WithOverflow()
   337  	if overflow || uint64(len(interpreter.returnData)) < end64 {
   338  		return nil, ErrReturnDataOutOfBounds
   339  	}
   340  	scope.Memory.Set(memOffset.Uint64(), length.Uint64(), interpreter.returnData[offset64:end64])
   341  	return nil, nil
   342  }
   343  
   344  func opExtCodeSize(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   345  	slot := scope.Stack.peek()
   346  	slot.SetUint64(uint64(interpreter.evm.StateDB.GetCodeSize(slot.Bytes20())))
   347  	return nil, nil
   348  }
   349  
   350  func opCodeSize(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   351  	l := new(uint256.Int)
   352  	l.SetUint64(uint64(len(scope.Contract.Code)))
   353  	scope.Stack.push(l)
   354  	return nil, nil
   355  }
   356  
   357  func opCodeCopy(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   358  	var (
   359  		memOffset  = scope.Stack.pop()
   360  		codeOffset = scope.Stack.pop()
   361  		length     = scope.Stack.pop()
   362  	)
   363  	uint64CodeOffset, overflow := codeOffset.Uint64WithOverflow()
   364  	if overflow {
   365  		uint64CodeOffset = 0xffffffffffffffff
   366  	}
   367  	codeCopy := getData(scope.Contract.Code, uint64CodeOffset, length.Uint64())
   368  	scope.Memory.Set(memOffset.Uint64(), length.Uint64(), codeCopy)
   369  
   370  	return nil, nil
   371  }
   372  
   373  func opExtCodeCopy(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   374  	var (
   375  		stack      = scope.Stack
   376  		a          = stack.pop()
   377  		memOffset  = stack.pop()
   378  		codeOffset = stack.pop()
   379  		length     = stack.pop()
   380  	)
   381  	uint64CodeOffset, overflow := codeOffset.Uint64WithOverflow()
   382  	if overflow {
   383  		uint64CodeOffset = 0xffffffffffffffff
   384  	}
   385  	addr := common.Address(a.Bytes20())
   386  	codeCopy := getData(interpreter.evm.StateDB.GetCode(addr), uint64CodeOffset, length.Uint64())
   387  	scope.Memory.Set(memOffset.Uint64(), length.Uint64(), codeCopy)
   388  
   389  	return nil, nil
   390  }
   391  
   392  // opExtCodeHash returns the code hash of a specified account.
   393  // There are several cases when the function is called, while we can relay everything
   394  // to `state.GetCodeHash` function to ensure the correctness.
   395  //   (1) Caller tries to get the code hash of a normal contract account, state
   396  // should return the relative code hash and set it as the result.
   397  //
   398  //   (2) Caller tries to get the code hash of a non-existent account, state should
   399  // return common.Hash{} and zero will be set as the result.
   400  //
   401  //   (3) Caller tries to get the code hash for an account without contract code,
   402  // state should return emptyCodeHash(0xc5d246...) as the result.
   403  //
   404  //   (4) Caller tries to get the code hash of a precompiled account, the result
   405  // should be zero or emptyCodeHash.
   406  //
   407  // It is worth noting that in order to avoid unnecessary create and clean,
   408  // all precompile accounts on mainnet have been transferred 1 wei, so the return
   409  // here should be emptyCodeHash.
   410  // If the precompile account is not transferred any amount on a private or
   411  // customized chain, the return value will be zero.
   412  //
   413  //   (5) Caller tries to get the code hash for an account which is marked as suicided
   414  // in the current transaction, the code hash of this account should be returned.
   415  //
   416  //   (6) Caller tries to get the code hash for an account which is marked as deleted,
   417  // this account should be regarded as a non-existent account and zero should be returned.
   418  func opExtCodeHash(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   419  	slot := scope.Stack.peek()
   420  	address := common.Address(slot.Bytes20())
   421  	if interpreter.evm.StateDB.Empty(address) {
   422  		slot.Clear()
   423  	} else {
   424  		slot.SetBytes(interpreter.evm.StateDB.GetCodeHash(address).Bytes())
   425  	}
   426  	return nil, nil
   427  }
   428  
   429  func opGasprice(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   430  	v, _ := uint256.FromBig(interpreter.evm.GasPrice)
   431  	scope.Stack.push(v)
   432  	return nil, nil
   433  }
   434  
   435  func opBlockhash(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   436  	num := scope.Stack.peek()
   437  	num64, overflow := num.Uint64WithOverflow()
   438  	if overflow {
   439  		num.Clear()
   440  		return nil, nil
   441  	}
   442  	var upper, lower uint64
   443  	upper = interpreter.evm.Context.BlockNumber.Uint64()
   444  	if upper < 257 {
   445  		lower = 0
   446  	} else {
   447  		lower = upper - 256
   448  	}
   449  	if num64 >= lower && num64 < upper {
   450  		num.SetBytes(interpreter.evm.Context.GetHash(num64).Bytes())
   451  	} else {
   452  		num.Clear()
   453  	}
   454  	return nil, nil
   455  }
   456  
   457  func opCoinbase(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   458  	scope.Stack.push(new(uint256.Int).SetBytes(interpreter.evm.Context.Coinbase.Bytes()))
   459  	return nil, nil
   460  }
   461  
   462  func opTimestamp(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   463  	v, _ := uint256.FromBig(interpreter.evm.Context.Time)
   464  	scope.Stack.push(v)
   465  	return nil, nil
   466  }
   467  
   468  func opNumber(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   469  	v, _ := uint256.FromBig(interpreter.evm.Context.BlockNumber)
   470  	scope.Stack.push(v)
   471  	return nil, nil
   472  }
   473  
   474  func opDifficulty(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   475  	v, _ := uint256.FromBig(interpreter.evm.Context.Difficulty)
   476  	scope.Stack.push(v)
   477  	return nil, nil
   478  }
   479  
   480  func opRandom(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   481  	v := new(uint256.Int).SetBytes((interpreter.evm.Context.Random.Bytes()))
   482  	scope.Stack.push(v)
   483  	return nil, nil
   484  }
   485  
   486  func opGasLimit(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   487  	scope.Stack.push(new(uint256.Int).SetUint64(interpreter.evm.Context.GasLimit))
   488  	return nil, nil
   489  }
   490  
   491  func opPop(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   492  	scope.Stack.pop()
   493  	return nil, nil
   494  }
   495  
   496  func opMload(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   497  	v := scope.Stack.peek()
   498  	offset := int64(v.Uint64())
   499  	v.SetBytes(scope.Memory.GetPtr(offset, 32))
   500  	return nil, nil
   501  }
   502  
   503  func opMstore(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   504  	// pop value of the stack
   505  	mStart, val := scope.Stack.pop(), scope.Stack.pop()
   506  	scope.Memory.Set32(mStart.Uint64(), &val)
   507  	return nil, nil
   508  }
   509  
   510  func opMstore8(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   511  	off, val := scope.Stack.pop(), scope.Stack.pop()
   512  	scope.Memory.store[off.Uint64()] = byte(val.Uint64())
   513  	return nil, nil
   514  }
   515  
   516  func opSload(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   517  	loc := scope.Stack.peek()
   518  	hash := common.Hash(loc.Bytes32())
   519  	val := interpreter.evm.StateDB.GetState(scope.Contract.Address(), hash)
   520  	loc.SetBytes(val.Bytes())
   521  	return nil, nil
   522  }
   523  
   524  func opSstore(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   525  	if interpreter.readOnly {
   526  		return nil, ErrWriteProtection
   527  	}
   528  	loc := scope.Stack.pop()
   529  	val := scope.Stack.pop()
   530  	interpreter.evm.StateDB.SetState(scope.Contract.Address(),
   531  		loc.Bytes32(), val.Bytes32())
   532  	return nil, nil
   533  }
   534  
   535  func opJump(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   536  	if atomic.LoadInt32(&interpreter.evm.abort) != 0 {
   537  		return nil, errStopToken
   538  	}
   539  	pos := scope.Stack.pop()
   540  	if !scope.Contract.validJumpdest(&pos) {
   541  		return nil, ErrInvalidJump
   542  	}
   543  	*pc = pos.Uint64() - 1 // pc will be increased by the interpreter loop
   544  	return nil, nil
   545  }
   546  
   547  func opJumpi(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   548  	if atomic.LoadInt32(&interpreter.evm.abort) != 0 {
   549  		return nil, errStopToken
   550  	}
   551  	pos, cond := scope.Stack.pop(), scope.Stack.pop()
   552  	if !cond.IsZero() {
   553  		if !scope.Contract.validJumpdest(&pos) {
   554  			return nil, ErrInvalidJump
   555  		}
   556  		*pc = pos.Uint64() - 1 // pc will be increased by the interpreter loop
   557  	}
   558  	return nil, nil
   559  }
   560  
   561  func opJumpdest(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   562  	return nil, nil
   563  }
   564  
   565  func opPc(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   566  	scope.Stack.push(new(uint256.Int).SetUint64(*pc))
   567  	return nil, nil
   568  }
   569  
   570  func opMsize(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   571  	scope.Stack.push(new(uint256.Int).SetUint64(uint64(scope.Memory.Len())))
   572  	return nil, nil
   573  }
   574  
   575  func opGas(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   576  	scope.Stack.push(new(uint256.Int).SetUint64(scope.Contract.Gas))
   577  	return nil, nil
   578  }
   579  
   580  func opCreate(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   581  	if interpreter.readOnly {
   582  		return nil, ErrWriteProtection
   583  	}
   584  	var (
   585  		value        = scope.Stack.pop()
   586  		offset, size = scope.Stack.pop(), scope.Stack.pop()
   587  		input        = scope.Memory.GetCopy(int64(offset.Uint64()), int64(size.Uint64()))
   588  		gas          = scope.Contract.Gas
   589  	)
   590  	if interpreter.evm.chainRules.IsEIP150 {
   591  		gas -= gas / 64
   592  	}
   593  	// reuse size int for stackvalue
   594  	stackvalue := size
   595  
   596  	scope.Contract.UseGas(gas)
   597  	//TODO: use uint256.Int instead of converting with toBig()
   598  	var bigVal = big0
   599  	if !value.IsZero() {
   600  		bigVal = value.ToBig()
   601  	}
   602  
   603  	res, addr, returnGas, suberr := interpreter.evm.Create(scope.Contract, input, gas, bigVal)
   604  	// Push item on the stack based on the returned error. If the ruleset is
   605  	// homestead we must check for CodeStoreOutOfGasError (homestead only
   606  	// rule) and treat as an error, if the ruleset is frontier we must
   607  	// ignore this error and pretend the operation was successful.
   608  	if interpreter.evm.chainRules.IsHomestead && suberr == ErrCodeStoreOutOfGas {
   609  		stackvalue.Clear()
   610  	} else if suberr != nil && suberr != ErrCodeStoreOutOfGas {
   611  		stackvalue.Clear()
   612  	} else {
   613  		stackvalue.SetBytes(addr.Bytes())
   614  	}
   615  	scope.Stack.push(&stackvalue)
   616  	scope.Contract.Gas += returnGas
   617  
   618  	if suberr == ErrExecutionReverted {
   619  		interpreter.returnData = res // set REVERT data to return data buffer
   620  		return res, nil
   621  	}
   622  	interpreter.returnData = nil // clear dirty return data buffer
   623  	return nil, nil
   624  }
   625  
   626  func opCreate2(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   627  	if interpreter.readOnly {
   628  		return nil, ErrWriteProtection
   629  	}
   630  	var (
   631  		endowment    = scope.Stack.pop()
   632  		offset, size = scope.Stack.pop(), scope.Stack.pop()
   633  		salt         = scope.Stack.pop()
   634  		input        = scope.Memory.GetCopy(int64(offset.Uint64()), int64(size.Uint64()))
   635  		gas          = scope.Contract.Gas
   636  	)
   637  
   638  	// Apply EIP150
   639  	gas -= gas / 64
   640  	scope.Contract.UseGas(gas)
   641  	// reuse size int for stackvalue
   642  	stackvalue := size
   643  	//TODO: use uint256.Int instead of converting with toBig()
   644  	bigEndowment := big0
   645  	if !endowment.IsZero() {
   646  		bigEndowment = endowment.ToBig()
   647  	}
   648  	res, addr, returnGas, suberr := interpreter.evm.Create2(scope.Contract, input, gas,
   649  		bigEndowment, &salt)
   650  	// Push item on the stack based on the returned error.
   651  	if suberr != nil {
   652  		stackvalue.Clear()
   653  	} else {
   654  		stackvalue.SetBytes(addr.Bytes())
   655  	}
   656  	scope.Stack.push(&stackvalue)
   657  	scope.Contract.Gas += returnGas
   658  
   659  	if suberr == ErrExecutionReverted {
   660  		interpreter.returnData = res // set REVERT data to return data buffer
   661  		return res, nil
   662  	}
   663  	interpreter.returnData = nil // clear dirty return data buffer
   664  	return nil, nil
   665  }
   666  
   667  func opCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   668  	stack := scope.Stack
   669  	// Pop gas. The actual gas in interpreter.evm.callGasTemp.
   670  	// We can use this as a temporary value
   671  	temp := stack.pop()
   672  	gas := interpreter.evm.callGasTemp
   673  	// Pop other call parameters.
   674  	addr, value, inOffset, inSize, retOffset, retSize := stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop()
   675  	toAddr := common.Address(addr.Bytes20())
   676  	// Get the arguments from the memory.
   677  	args := scope.Memory.GetPtr(int64(inOffset.Uint64()), int64(inSize.Uint64()))
   678  
   679  	if interpreter.readOnly && !value.IsZero() {
   680  		return nil, ErrWriteProtection
   681  	}
   682  	var bigVal = big0
   683  	//TODO: use uint256.Int instead of converting with toBig()
   684  	// By using big0 here, we save an alloc for the most common case (non-ether-transferring contract calls),
   685  	// but it would make more sense to extend the usage of uint256.Int
   686  	if !value.IsZero() {
   687  		gas += params.CallStipend
   688  		bigVal = value.ToBig()
   689  	}
   690  
   691  	ret, returnGas, err := interpreter.evm.Call(scope.Contract, toAddr, args, gas, bigVal)
   692  
   693  	if err != nil {
   694  		temp.Clear()
   695  	} else {
   696  		temp.SetOne()
   697  	}
   698  	stack.push(&temp)
   699  	if err == nil || err == ErrExecutionReverted {
   700  		ret = common.CopyBytes(ret)
   701  		scope.Memory.Set(retOffset.Uint64(), retSize.Uint64(), ret)
   702  	}
   703  	scope.Contract.Gas += returnGas
   704  
   705  	interpreter.returnData = ret
   706  	return ret, nil
   707  }
   708  
   709  func opCallCode(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   710  	// Pop gas. The actual gas is in interpreter.evm.callGasTemp.
   711  	stack := scope.Stack
   712  	// We use it as a temporary value
   713  	temp := stack.pop()
   714  	gas := interpreter.evm.callGasTemp
   715  	// Pop other call parameters.
   716  	addr, value, inOffset, inSize, retOffset, retSize := stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop()
   717  	toAddr := common.Address(addr.Bytes20())
   718  	// Get arguments from the memory.
   719  	args := scope.Memory.GetPtr(int64(inOffset.Uint64()), int64(inSize.Uint64()))
   720  
   721  	//TODO: use uint256.Int instead of converting with toBig()
   722  	var bigVal = big0
   723  	if !value.IsZero() {
   724  		gas += params.CallStipend
   725  		bigVal = value.ToBig()
   726  	}
   727  
   728  	ret, returnGas, err := interpreter.evm.CallCode(scope.Contract, toAddr, args, gas, bigVal)
   729  	if err != nil {
   730  		temp.Clear()
   731  	} else {
   732  		temp.SetOne()
   733  	}
   734  	stack.push(&temp)
   735  	if err == nil || err == ErrExecutionReverted {
   736  		ret = common.CopyBytes(ret)
   737  		scope.Memory.Set(retOffset.Uint64(), retSize.Uint64(), ret)
   738  	}
   739  	scope.Contract.Gas += returnGas
   740  
   741  	interpreter.returnData = ret
   742  	return ret, nil
   743  }
   744  
   745  func opDelegateCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   746  	stack := scope.Stack
   747  	// Pop gas. The actual gas is in interpreter.evm.callGasTemp.
   748  	// We use it as a temporary value
   749  	temp := stack.pop()
   750  	gas := interpreter.evm.callGasTemp
   751  	// Pop other call parameters.
   752  	addr, inOffset, inSize, retOffset, retSize := stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop()
   753  	toAddr := common.Address(addr.Bytes20())
   754  	// Get arguments from the memory.
   755  	args := scope.Memory.GetPtr(int64(inOffset.Uint64()), int64(inSize.Uint64()))
   756  
   757  	ret, returnGas, err := interpreter.evm.DelegateCall(scope.Contract, toAddr, args, gas)
   758  	if err != nil {
   759  		temp.Clear()
   760  	} else {
   761  		temp.SetOne()
   762  	}
   763  	stack.push(&temp)
   764  	if err == nil || err == ErrExecutionReverted {
   765  		ret = common.CopyBytes(ret)
   766  		scope.Memory.Set(retOffset.Uint64(), retSize.Uint64(), ret)
   767  	}
   768  	scope.Contract.Gas += returnGas
   769  
   770  	interpreter.returnData = ret
   771  	return ret, nil
   772  }
   773  
   774  func opStaticCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   775  	// Pop gas. The actual gas is in interpreter.evm.callGasTemp.
   776  	stack := scope.Stack
   777  	// We use it as a temporary value
   778  	temp := stack.pop()
   779  	gas := interpreter.evm.callGasTemp
   780  	// Pop other call parameters.
   781  	addr, inOffset, inSize, retOffset, retSize := stack.pop(), stack.pop(), stack.pop(), stack.pop(), stack.pop()
   782  	toAddr := common.Address(addr.Bytes20())
   783  	// Get arguments from the memory.
   784  	args := scope.Memory.GetPtr(int64(inOffset.Uint64()), int64(inSize.Uint64()))
   785  
   786  	ret, returnGas, err := interpreter.evm.StaticCall(scope.Contract, toAddr, args, gas)
   787  	if err != nil {
   788  		temp.Clear()
   789  	} else {
   790  		temp.SetOne()
   791  	}
   792  	stack.push(&temp)
   793  	if err == nil || err == ErrExecutionReverted {
   794  		ret = common.CopyBytes(ret)
   795  		scope.Memory.Set(retOffset.Uint64(), retSize.Uint64(), ret)
   796  	}
   797  	scope.Contract.Gas += returnGas
   798  
   799  	interpreter.returnData = ret
   800  	return ret, nil
   801  }
   802  
   803  func opReturn(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   804  	offset, size := scope.Stack.pop(), scope.Stack.pop()
   805  	ret := scope.Memory.GetPtr(int64(offset.Uint64()), int64(size.Uint64()))
   806  
   807  	return ret, errStopToken
   808  }
   809  
   810  func opRevert(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   811  	offset, size := scope.Stack.pop(), scope.Stack.pop()
   812  	ret := scope.Memory.GetPtr(int64(offset.Uint64()), int64(size.Uint64()))
   813  
   814  	interpreter.returnData = ret
   815  	return ret, ErrExecutionReverted
   816  }
   817  
   818  func opUndefined(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   819  	return nil, &ErrInvalidOpCode{opcode: OpCode(scope.Contract.Code[*pc])}
   820  }
   821  
   822  func opStop(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   823  	return nil, errStopToken
   824  }
   825  
   826  func opSelfdestruct(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   827  	if interpreter.readOnly {
   828  		return nil, ErrWriteProtection
   829  	}
   830  	beneficiary := scope.Stack.pop()
   831  	balance := interpreter.evm.StateDB.GetBalance(scope.Contract.Address())
   832  	interpreter.evm.StateDB.AddBalance(beneficiary.Bytes20(), balance)
   833  	interpreter.evm.StateDB.Suicide(scope.Contract.Address())
   834  	if interpreter.cfg.Debug {
   835  		interpreter.cfg.Tracer.CaptureEnter(SELFDESTRUCT, scope.Contract.Address(), beneficiary.Bytes20(), []byte{}, 0, balance)
   836  		interpreter.cfg.Tracer.CaptureExit([]byte{}, 0, nil)
   837  	}
   838  	return nil, errStopToken
   839  }
   840  
   841  // following functions are used by the instruction jump  table
   842  
   843  // make log instruction function
   844  func makeLog(size int) executionFunc {
   845  	return func(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   846  		if interpreter.readOnly {
   847  			return nil, ErrWriteProtection
   848  		}
   849  		topics := make([]common.Hash, size)
   850  		stack := scope.Stack
   851  		mStart, mSize := stack.pop(), stack.pop()
   852  		for i := 0; i < size; i++ {
   853  			addr := stack.pop()
   854  			topics[i] = addr.Bytes32()
   855  		}
   856  
   857  		d := scope.Memory.GetCopy(int64(mStart.Uint64()), int64(mSize.Uint64()))
   858  		interpreter.evm.StateDB.AddLog(&types.Log{
   859  			Address: scope.Contract.Address(),
   860  			Topics:  topics,
   861  			Data:    d,
   862  			// This is a non-consensus field, but assigned here because
   863  			// core/state doesn't know the current block number.
   864  			BlockNumber: interpreter.evm.Context.BlockNumber.Uint64(),
   865  		})
   866  
   867  		return nil, nil
   868  	}
   869  }
   870  
   871  // opPush1 is a specialized version of pushN
   872  func opPush1(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   873  	var (
   874  		codeLen = uint64(len(scope.Contract.Code))
   875  		integer = new(uint256.Int)
   876  	)
   877  	*pc += 1
   878  	if *pc < codeLen {
   879  		scope.Stack.push(integer.SetUint64(uint64(scope.Contract.Code[*pc])))
   880  	} else {
   881  		scope.Stack.push(integer.Clear())
   882  	}
   883  	return nil, nil
   884  }
   885  
   886  // make push instruction function
   887  func makePush(size uint64, pushByteSize int) executionFunc {
   888  	return func(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   889  		codeLen := len(scope.Contract.Code)
   890  
   891  		startMin := codeLen
   892  		if int(*pc+1) < startMin {
   893  			startMin = int(*pc + 1)
   894  		}
   895  
   896  		endMin := codeLen
   897  		if startMin+pushByteSize < endMin {
   898  			endMin = startMin + pushByteSize
   899  		}
   900  
   901  		integer := new(uint256.Int)
   902  		scope.Stack.push(integer.SetBytes(common.RightPadBytes(
   903  			scope.Contract.Code[startMin:endMin], pushByteSize)))
   904  
   905  		*pc += size
   906  		return nil, nil
   907  	}
   908  }
   909  
   910  // make dup instruction function
   911  func makeDup(size int64) executionFunc {
   912  	return func(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   913  		scope.Stack.dup(int(size))
   914  		return nil, nil
   915  	}
   916  }
   917  
   918  // make swap instruction function
   919  func makeSwap(size int64) executionFunc {
   920  	// switch n + 1 otherwise n would be swapped with n
   921  	size++
   922  	return func(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
   923  		scope.Stack.swap(int(size))
   924  		return nil, nil
   925  	}
   926  }