aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/opcodes.go
blob: 00593ae95decefd45e8f327f01254a321063bd8b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
// 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 <http://www.gnu.org/licenses/>.

package vm

import (
    "fmt"
)

// OpCode is an EVM opcode
type OpCode byte

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
}

func (op OpCode) IsStaticJump() bool {
    return op == JUMP
}

const (
    // 0x0 range - arithmetic ops
    STOP OpCode = iota
    ADD
    MUL
    SUB
    DIV
    SDIV
    MOD
    SMOD
    ADDMOD
    MULMOD
    EXP
    SIGNEXTEND
)

const (
    LT OpCode = iota + 0x10
    GT
    SLT
    SGT
    EQ
    ISZERO
    AND
    OR
    XOR
    NOT
    BYTE

    SHA3 = 0x20
)

const (
    // 0x30 range - closure state
    ADDRESS OpCode = 0x30 + iota
    BALANCE
    ORIGIN
    CALLER
    CALLVALUE
    CALLDATALOAD
    CALLDATASIZE
    CALLDATACOPY
    CODESIZE
    CODECOPY
    GASPRICE
    EXTCODESIZE
    EXTCODECOPY
)

const (

    // 0x40 range - block operations
    BLOCKHASH OpCode = 0x40 + iota
    COINBASE
    TIMESTAMP
    NUMBER
    DIFFICULTY
    GASLIMIT
)

const (
    // 0x50 range - 'storage' and execution
    POP OpCode = 0x50 + iota
    MLOAD
    MSTORE
    MSTORE8
    SLOAD
    SSTORE
    JUMP
    JUMPI
    PC
    MSIZE
    GAS
    JUMPDEST
)

const (
    // 0x60 range
    PUSH1 OpCode = 0x60 + iota
    PUSH2
    PUSH3
    PUSH4
    PUSH5
    PUSH6
    PUSH7
    PUSH8
    PUSH9
    PUSH10
    PUSH11
    PUSH12
    PUSH13
    PUSH14
    PUSH15
    PUSH16
    PUSH17
    PUSH18
    PUSH19
    PUSH20
    PUSH21
    PUSH22
    PUSH23
    PUSH24
    PUSH25
    PUSH26
    PUSH27
    PUSH28
    PUSH29
    PUSH30
    PUSH31
    PUSH32
    DUP1
    DUP2
    DUP3
    DUP4
    DUP5
    DUP6
    DUP7
    DUP8
    DUP9
    DUP10
    DUP11
    DUP12
    DUP13
    DUP14
    DUP15
    DUP16
    SWAP1
    SWAP2
    SWAP3
    SWAP4
    SWAP5
    SWAP6
    SWAP7
    SWAP8
    SWAP9
    SWAP10
    SWAP11
    SWAP12
    SWAP13
    SWAP14
    SWAP15
    SWAP16
)

const (
    LOG0 OpCode = 0xa0 + iota
    LOG1
    LOG2
    LOG3
    LOG4
)

// unofficial opcodes used for parsing
const (
    PUSH OpCode = 0xb0 + iota
    DUP
    SWAP
)

const (
    // 0xf0 range - closures
    CREATE OpCode = 0xf0 + iota
    CALL
    CALLCODE
    RETURN
    DELEGATECALL

    SUICIDE = 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",
    ADDMOD: "ADDMOD",
    MULMOD: "MULMOD",

    // 0x20 range - crypto
    SHA3: "SHA3",

    // 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:     "TXGASPRICE",

    // 0x40 range - block operations
    BLOCKHASH:   "BLOCKHASH",
    COINBASE:    "COINBASE",
    TIMESTAMP:   "TIMESTAMP",
    NUMBER:      "NUMBER",
    DIFFICULTY:  "DIFFICULTY",
    GASLIMIT:    "GASLIMIT",
    EXTCODESIZE: "EXTCODESIZE",
    EXTCODECOPY: "EXTCODECOPY",

    // 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",

    // 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",
    SUICIDE:      "SUICIDE",

    PUSH: "PUSH",
    DUP:  "DUP",
    SWAP: "SWAP",
}

func (o OpCode) String() string {
    str := opCodeToString[o]
    if len(str) == 0 {
        return fmt.Sprintf("Missing opcode 0x%x", int(o))
    }

    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,
    "ADDMOD":       ADDMOD,
    "MULMOD":       MULMOD,
    "SHA3":         SHA3,
    "ADDRESS":      ADDRESS,
    "BALANCE":      BALANCE,
    "ORIGIN":       ORIGIN,
    "CALLER":       CALLER,
    "CALLVALUE":    CALLVALUE,
    "CALLDATALOAD": CALLDATALOAD,
    "CALLDATASIZE": CALLDATASIZE,
    "CALLDATACOPY": CALLDATACOPY,
    "CODESIZE":     CODESIZE,
    "CODECOPY":     CODECOPY,
    "GASPRICE":     GASPRICE,
    "BLOCKHASH":    BLOCKHASH,
    "COINBASE":     COINBASE,
    "TIMESTAMP":    TIMESTAMP,
    "NUMBER":       NUMBER,
    "DIFFICULTY":   DIFFICULTY,
    "GASLIMIT":     GASLIMIT,
    "EXTCODESIZE":  EXTCODESIZE,
    "EXTCODECOPY":  EXTCODECOPY,
    "POP":          POP,
    "MLOAD":        MLOAD,
    "MSTORE":       MSTORE,
    "MSTORE8":      MSTORE8,
    "SLOAD":        SLOAD,
    "SSTORE":       SSTORE,
    "JUMP":         JUMP,
    "JUMPI":        JUMPI,
    "PC":           PC,
    "MSIZE":        MSIZE,
    "GAS":          GAS,
    "JUMPDEST":     JUMPDEST,
    "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,
    "CALL":         CALL,
    "RETURN":       RETURN,
    "CALLCODE":     CALLCODE,
    "SUICIDE":      SUICIDE,
}

func StringToOp(str string) OpCode {
    return stringToOp[str]
}