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