// Copyright 2014 The go-ethereum Authors // This file is part of the go-ethereum library. // // The go-ethereum library is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // The go-ethereum library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with the go-ethereum library. If not, see . package vm import ( "fmt" ) // OpCode is an EVM opcode type OpCode byte // IsPush specifies if an opcode is a PUSH opcode. func (op OpCode) IsPush() bool { switch op { case PUSH1, 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: return true } return false } // 0x0 range - arithmetic ops. const ( STOP OpCode = 0x0 ADD OpCode = 0x1 MUL OpCode = 0x2 SUB OpCode = 0x3 DIV OpCode = 0x4 SDIV OpCode = 0x5 MOD OpCode = 0x6 SMOD OpCode = 0x7 ADDMOD OpCode = 0x8 MULMOD OpCode = 0x9 EXP OpCode = 0xa SIGNEXTEND OpCode = 0xb ) // 0x10 range - comparison ops. const ( LT OpCode = 0x10 GT OpCode = 0x11 SLT OpCode = 0x12 SGT OpCode = 0x13 EQ OpCode = 0x14 ISZERO OpCode = 0x15 AND OpCode = 0x16 OR OpCode = 0x17 XOR OpCode = 0x18 NOT OpCode = 0x19 BYTE OpCode = 0x1a SHL OpCode = 0x1b SHR OpCode = 0x1c SAR OpCode = 0x1d ) // 0x20 range - crypto. const ( KECCAK256 OpCode = 0x20 ) // 0x30 range - closure state. const ( ADDRESS OpCode = 0x30 BALANCE OpCode = 0x31 ORIGIN OpCode = 0x32 CALLER OpCode = 0x33 CALLVALUE OpCode = 0x34 CALLDATALOAD OpCode = 0x35 CALLDATASIZE OpCode = 0x36 CALLDATACOPY OpCode = 0x37 CODESIZE OpCode = 0x38 CODECOPY OpCode = 0x39 GASPRICE OpCode = 0x3a EXTCODESIZE OpCode = 0x3b EXTCODECOPY OpCode = 0x3c RETURNDATASIZE OpCode = 0x3d RETURNDATACOPY OpCode = 0x3e EXTCODEHASH OpCode = 0x3f ) // 0x40 range - block operations. const ( BLOCKHASH OpCode = 0x40 COINBASE OpCode = 0x41 TIMESTAMP OpCode = 0x42 NUMBER OpCode = 0x43 DIFFICULTY OpCode = 0x44 RANDOM OpCode = 0x44 // Same as DIFFICULTY GASLIMIT OpCode = 0x45 CHAINID OpCode = 0x46 SELFBALANCE OpCode = 0x47 BASEFEE OpCode = 0x48 ) // 0x50 range - 'storage' and execution. const ( POP OpCode = 0x50 MLOAD OpCode = 0x51 MSTORE OpCode = 0x52 MSTORE8 OpCode = 0x53 SLOAD OpCode = 0x54 SSTORE OpCode = 0x55 JUMP OpCode = 0x56 JUMPI OpCode = 0x57 PC OpCode = 0x58 MSIZE OpCode = 0x59 GAS OpCode = 0x5a JUMPDEST OpCode = 0x5b PUSH0 OpCode = 0x5f ) // 0x60 range - pushes. const ( 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 ) // 0x80 range - dups. const ( DUP1 = 0x80 + iota DUP2 DUP3 DUP4 DUP5 DUP6 DUP7 DUP8 DUP9 DUP10 DUP11 DUP12 DUP13 DUP14 DUP15 DUP16 ) // 0x90 range - swaps. const ( SWAP1 = 0x90 + iota SWAP2 SWAP3 SWAP4 SWAP5 SWAP6 SWAP7 SWAP8 SWAP9 SWAP10 SWAP11 SWAP12 SWAP13 SWAP14 SWAP15 SWAP16 ) // 0xa0 range - logging ops. const ( LOG0 OpCode = 0xa0 + iota LOG1 LOG2 LOG3 LOG4 ) // 0xf0 range - closures. const ( CREATE OpCode = 0xf0 CALL OpCode = 0xf1 CALLCODE OpCode = 0xf2 RETURN OpCode = 0xf3 DELEGATECALL OpCode = 0xf4 CREATE2 OpCode = 0xf5 STATICCALL OpCode = 0xfa REVERT OpCode = 0xfd INVALID OpCode = 0xfe SELFDESTRUCT OpCode = 0xff ) // Since the opcodes aren't all in order we can't use a regular slice. var opCodeToString = map[OpCode]string{ // 0x0 range - arithmetic ops. STOP: "STOP", ADD: "ADD", MUL: "MUL", SUB: "SUB", DIV: "DIV", SDIV: "SDIV", MOD: "MOD", SMOD: "SMOD", EXP: "EXP", NOT: "NOT", LT: "LT", GT: "GT", SLT: "SLT", SGT: "SGT", EQ: "EQ", ISZERO: "ISZERO", SIGNEXTEND: "SIGNEXTEND", // 0x10 range - bit ops. AND: "AND", OR: "OR", XOR: "XOR", BYTE: "BYTE", SHL: "SHL", SHR: "SHR", SAR: "SAR", ADDMOD: "ADDMOD", MULMOD: "MULMOD", // 0x20 range - crypto. KECCAK256: "KECCAK256", // 0x30 range - closure state. ADDRESS: "ADDRESS", BALANCE: "BALANCE", ORIGIN: "ORIGIN", CALLER: "CALLER", CALLVALUE: "CALLVALUE", CALLDATALOAD: "CALLDATALOAD", CALLDATASIZE: "CALLDATASIZE", CALLDATACOPY: "CALLDATACOPY", CODESIZE: "CODESIZE", CODECOPY: "CODECOPY", GASPRICE: "GASPRICE", EXTCODESIZE: "EXTCODESIZE", EXTCODECOPY: "EXTCODECOPY", RETURNDATASIZE: "RETURNDATASIZE", RETURNDATACOPY: "RETURNDATACOPY", EXTCODEHASH: "EXTCODEHASH", // 0x40 range - block operations. BLOCKHASH: "BLOCKHASH", COINBASE: "COINBASE", TIMESTAMP: "TIMESTAMP", NUMBER: "NUMBER", DIFFICULTY: "DIFFICULTY", // TODO (MariusVanDerWijden) rename to RANDOM post merge GASLIMIT: "GASLIMIT", CHAINID: "CHAINID", SELFBALANCE: "SELFBALANCE", BASEFEE: "BASEFEE", // 0x50 range - 'storage' and execution. POP: "POP", //DUP: "DUP", //SWAP: "SWAP", MLOAD: "MLOAD", MSTORE: "MSTORE", MSTORE8: "MSTORE8", SLOAD: "SLOAD", SSTORE: "SSTORE", JUMP: "JUMP", JUMPI: "JUMPI", PC: "PC", MSIZE: "MSIZE", GAS: "GAS", JUMPDEST: "JUMPDEST", PUSH0: "PUSH0", // 0x60 range - push. PUSH1: "PUSH1", PUSH2: "PUSH2", PUSH3: "PUSH3", PUSH4: "PUSH4", PUSH5: "PUSH5", PUSH6: "PUSH6", PUSH7: "PUSH7", PUSH8: "PUSH8", PUSH9: "PUSH9", PUSH10: "PUSH10", PUSH11: "PUSH11", PUSH12: "PUSH12", PUSH13: "PUSH13", PUSH14: "PUSH14", PUSH15: "PUSH15", PUSH16: "PUSH16", PUSH17: "PUSH17", PUSH18: "PUSH18", PUSH19: "PUSH19", PUSH20: "PUSH20", PUSH21: "PUSH21", PUSH22: "PUSH22", PUSH23: "PUSH23", PUSH24: "PUSH24", PUSH25: "PUSH25", PUSH26: "PUSH26", PUSH27: "PUSH27", PUSH28: "PUSH28", PUSH29: "PUSH29", PUSH30: "PUSH30", PUSH31: "PUSH31", PUSH32: "PUSH32", DUP1: "DUP1", DUP2: "DUP2", DUP3: "DUP3", DUP4: "DUP4", DUP5: "DUP5", DUP6: "DUP6", DUP7: "DUP7", DUP8: "DUP8", DUP9: "DUP9", DUP10: "DUP10", DUP11: "DUP11", DUP12: "DUP12", DUP13: "DUP13", DUP14: "DUP14", DUP15: "DUP15", DUP16: "DUP16", SWAP1: "SWAP1", SWAP2: "SWAP2", SWAP3: "SWAP3", SWAP4: "SWAP4", SWAP5: "SWAP5", SWAP6: "SWAP6", SWAP7: "SWAP7", SWAP8: "SWAP8", SWAP9: "SWAP9", SWAP10: "SWAP10", SWAP11: "SWAP11", SWAP12: "SWAP12", SWAP13: "SWAP13", SWAP14: "SWAP14", SWAP15: "SWAP15", SWAP16: "SWAP16", LOG0: "LOG0", LOG1: "LOG1", LOG2: "LOG2", LOG3: "LOG3", LOG4: "LOG4", // 0xf0 range. CREATE: "CREATE", CALL: "CALL", RETURN: "RETURN", CALLCODE: "CALLCODE", DELEGATECALL: "DELEGATECALL", CREATE2: "CREATE2", STATICCALL: "STATICCALL", REVERT: "REVERT", INVALID: "INVALID", SELFDESTRUCT: "SELFDESTRUCT", } func (op OpCode) String() string { str := opCodeToString[op] if len(str) == 0 { return fmt.Sprintf("opcode 0x%x not defined", int(op)) } return str } var stringToOp = map[string]OpCode{ "STOP": STOP, "ADD": ADD, "MUL": MUL, "SUB": SUB, "DIV": DIV, "SDIV": SDIV, "MOD": MOD, "SMOD": SMOD, "EXP": EXP, "NOT": NOT, "LT": LT, "GT": GT, "SLT": SLT, "SGT": SGT, "EQ": EQ, "ISZERO": ISZERO, "SIGNEXTEND": SIGNEXTEND, "AND": AND, "OR": OR, "XOR": XOR, "BYTE": BYTE, "SHL": SHL, "SHR": SHR, "SAR": SAR, "ADDMOD": ADDMOD, "MULMOD": MULMOD, "KECCAK256": KECCAK256, "ADDRESS": ADDRESS, "BALANCE": BALANCE, "ORIGIN": ORIGIN, "CALLER": CALLER, "CALLVALUE": CALLVALUE, "CALLDATALOAD": CALLDATALOAD, "CALLDATASIZE": CALLDATASIZE, "CALLDATACOPY": CALLDATACOPY, "CHAINID": CHAINID, "BASEFEE": BASEFEE, "DELEGATECALL": DELEGATECALL, "STATICCALL": STATICCALL, "CODESIZE": CODESIZE, "CODECOPY": CODECOPY, "GASPRICE": GASPRICE, "EXTCODESIZE": EXTCODESIZE, "EXTCODECOPY": EXTCODECOPY, "RETURNDATASIZE": RETURNDATASIZE, "RETURNDATACOPY": RETURNDATACOPY, "EXTCODEHASH": EXTCODEHASH, "BLOCKHASH": BLOCKHASH, "COINBASE": COINBASE, "TIMESTAMP": TIMESTAMP, "NUMBER": NUMBER, "DIFFICULTY": DIFFICULTY, "GASLIMIT": GASLIMIT, "SELFBALANCE": SELFBALANCE, "POP": POP, "MLOAD": MLOAD, "MSTORE": MSTORE, "MSTORE8": MSTORE8, "SLOAD": SLOAD, "SSTORE": SSTORE, "JUMP": JUMP, "JUMPI": JUMPI, "PC": PC, "MSIZE": MSIZE, "GAS": GAS, "JUMPDEST": JUMPDEST, "PUSH0": PUSH0, "PUSH1": PUSH1, "PUSH2": PUSH2, "PUSH3": PUSH3, "PUSH4": PUSH4, "PUSH5": PUSH5, "PUSH6": PUSH6, "PUSH7": PUSH7, "PUSH8": PUSH8, "PUSH9": PUSH9, "PUSH10": PUSH10, "PUSH11": PUSH11, "PUSH12": PUSH12, "PUSH13": PUSH13, "PUSH14": PUSH14, "PUSH15": PUSH15, "PUSH16": PUSH16, "PUSH17": PUSH17, "PUSH18": PUSH18, "PUSH19": PUSH19, "PUSH20": PUSH20, "PUSH21": PUSH21, "PUSH22": PUSH22, "PUSH23": PUSH23, "PUSH24": PUSH24, "PUSH25": PUSH25, "PUSH26": PUSH26, "PUSH27": PUSH27, "PUSH28": PUSH28, "PUSH29": PUSH29, "PUSH30": PUSH30, "PUSH31": PUSH31, "PUSH32": PUSH32, "DUP1": DUP1, "DUP2": DUP2, "DUP3": DUP3, "DUP4": DUP4, "DUP5": DUP5, "DUP6": DUP6, "DUP7": DUP7, "DUP8": DUP8, "DUP9": DUP9, "DUP10": DUP10, "DUP11": DUP11, "DUP12": DUP12, "DUP13": DUP13, "DUP14": DUP14, "DUP15": DUP15, "DUP16": DUP16, "SWAP1": SWAP1, "SWAP2": SWAP2, "SWAP3": SWAP3, "SWAP4": SWAP4, "SWAP5": SWAP5, "SWAP6": SWAP6, "SWAP7": SWAP7, "SWAP8": SWAP8, "SWAP9": SWAP9, "SWAP10": SWAP10, "SWAP11": SWAP11, "SWAP12": SWAP12, "SWAP13": SWAP13, "SWAP14": SWAP14, "SWAP15": SWAP15, "SWAP16": SWAP16, "LOG0": LOG0, "LOG1": LOG1, "LOG2": LOG2, "LOG3": LOG3, "LOG4": LOG4, "CREATE": CREATE, "CREATE2": CREATE2, "CALL": CALL, "RETURN": RETURN, "CALLCODE": CALLCODE, "REVERT": REVERT, "INVALID": INVALID, "SELFDESTRUCT": SELFDESTRUCT, } // StringToOp finds the opcode whose name is stored in `str`. func StringToOp(str string) OpCode { return stringToOp[str] }