aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/gas_table.go
blob: f9eea319e1213cf4029d868af38605da0dc4accd (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
// Copyright 2017 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 (
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/math"
    "github.com/ethereum/go-ethereum/params"
)

// memoryGasCosts calculates the quadratic gas for memory expansion. It does so
// only for the memory region that is expanded, not the total memory.
func memoryGasCost(mem *Memory, newMemSize uint64) (uint64, error) {

    if newMemSize == 0 {
        return 0, nil
    }
    // The maximum that will fit in a uint64 is max_word_count - 1
    // anything above that will result in an overflow.
    // Additionally, a newMemSize which results in a
    // newMemSizeWords larger than 0x7ffffffff will cause the square operation
    // to overflow.
    // The constant 0xffffffffe0 is the highest number that can be used without
    // overflowing the gas calculation
    if newMemSize > 0xffffffffe0 {
        return 0, errGasUintOverflow
    }

    newMemSizeWords := toWordSize(newMemSize)
    newMemSize = newMemSizeWords * 32

    if newMemSize > uint64(mem.Len()) {
        square := newMemSizeWords * newMemSizeWords
        linCoef := newMemSizeWords * params.MemoryGas
        quadCoef := square / params.QuadCoeffDiv
        newTotalFee := linCoef + quadCoef

        fee := newTotalFee - mem.lastGasCost
        mem.lastGasCost = newTotalFee

        return fee, nil
    }
    return 0, nil
}

func constGasFunc(gas uint64) gasFunc {
    return func(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
        return gas, nil
    }
}

func gasCallDataCopy(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }

    var overflow bool
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }

    words, overflow := bigUint64(stack.Back(2))
    if overflow {
        return 0, errGasUintOverflow
    }

    if words, overflow = math.SafeMul(toWordSize(words), params.CopyGas); overflow {
        return 0, errGasUintOverflow
    }

    if gas, overflow = math.SafeAdd(gas, words); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasReturnDataCopy(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }

    var overflow bool
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }

    words, overflow := bigUint64(stack.Back(2))
    if overflow {
        return 0, errGasUintOverflow
    }

    if words, overflow = math.SafeMul(toWordSize(words), params.CopyGas); overflow {
        return 0, errGasUintOverflow
    }

    if gas, overflow = math.SafeAdd(gas, words); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasSStore(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var (
        y, x = stack.Back(1), stack.Back(0)
        val  = evm.StateDB.GetState(contract.Address(), common.BigToHash(x))
    )
    // This checks for 3 scenario's and calculates gas accordingly
    // 1. From a zero-value address to a non-zero value         (NEW VALUE)
    // 2. From a non-zero value address to a zero-value address (DELETE)
    // 3. From a non-zero to a non-zero                         (CHANGE)
    if val == (common.Hash{}) && y.Sign() != 0 {
        // 0 => non 0
        return params.SstoreSetGas, nil
    } else if val != (common.Hash{}) && y.Sign() == 0 {
        // non 0 => 0
        evm.StateDB.AddRefund(params.SstoreRefundGas)
        return params.SstoreClearGas, nil
    } else {
        // non 0 => non 0 (or 0 => 0)
        return params.SstoreResetGas, nil
    }
}

func makeGasLog(n uint64) gasFunc {
    return func(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
        requestedSize, overflow := bigUint64(stack.Back(1))
        if overflow {
            return 0, errGasUintOverflow
        }

        gas, err := memoryGasCost(mem, memorySize)
        if err != nil {
            return 0, err
        }

        if gas, overflow = math.SafeAdd(gas, params.LogGas); overflow {
            return 0, errGasUintOverflow
        }
        if gas, overflow = math.SafeAdd(gas, n*params.LogTopicGas); overflow {
            return 0, errGasUintOverflow
        }

        var memorySizeGas uint64
        if memorySizeGas, overflow = math.SafeMul(requestedSize, params.LogDataGas); overflow {
            return 0, errGasUintOverflow
        }
        if gas, overflow = math.SafeAdd(gas, memorySizeGas); overflow {
            return 0, errGasUintOverflow
        }
        return gas, nil
    }
}

func gasSha3(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }

    if gas, overflow = math.SafeAdd(gas, params.Sha3Gas); overflow {
        return 0, errGasUintOverflow
    }

    wordGas, overflow := bigUint64(stack.Back(1))
    if overflow {
        return 0, errGasUintOverflow
    }
    if wordGas, overflow = math.SafeMul(toWordSize(wordGas), params.Sha3WordGas); overflow {
        return 0, errGasUintOverflow
    }
    if gas, overflow = math.SafeAdd(gas, wordGas); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasCodeCopy(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }

    var overflow bool
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }

    wordGas, overflow := bigUint64(stack.Back(2))
    if overflow {
        return 0, errGasUintOverflow
    }
    if wordGas, overflow = math.SafeMul(toWordSize(wordGas), params.CopyGas); overflow {
        return 0, errGasUintOverflow
    }
    if gas, overflow = math.SafeAdd(gas, wordGas); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasExtCodeCopy(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }

    var overflow bool
    if gas, overflow = math.SafeAdd(gas, gt.ExtcodeCopy); overflow {
        return 0, errGasUintOverflow
    }

    wordGas, overflow := bigUint64(stack.Back(3))
    if overflow {
        return 0, errGasUintOverflow
    }

    if wordGas, overflow = math.SafeMul(toWordSize(wordGas), params.CopyGas); overflow {
        return 0, errGasUintOverflow
    }

    if gas, overflow = math.SafeAdd(gas, wordGas); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasExtCodeHash(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return gt.ExtcodeHash, nil
}

func gasMLoad(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, errGasUintOverflow
    }
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasMStore8(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, errGasUintOverflow
    }
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasMStore(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, errGasUintOverflow
    }
    if gas, overflow = math.SafeAdd(gas, GasFastestStep); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasCreate(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, params.CreateGas); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasCreate2(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var overflow bool
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, params.Create2Gas); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasBalance(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return gt.Balance, nil
}

func gasExtCodeSize(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return gt.ExtcodeSize, nil
}

func gasSLoad(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return gt.SLoad, nil
}

func gasExp(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    expByteLen := uint64((stack.data[stack.len()-2].BitLen() + 7) / 8)

    var (
        gas      = expByteLen * gt.ExpByte // no overflow check required. Max is 256 * ExpByte gas
        overflow bool
    )
    if gas, overflow = math.SafeAdd(gas, GasSlowStep); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasCall(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var (
        gas            = gt.Calls
        transfersValue = stack.Back(2).Sign() != 0
        address        = common.BigToAddress(stack.Back(1))
        eip158         = evm.ChainConfig().IsEIP158(evm.BlockNumber)
    )
    if eip158 {
        if transfersValue && evm.StateDB.Empty(address) {
            gas += params.CallNewAccountGas
        }
    } else if !evm.StateDB.Exist(address) {
        gas += params.CallNewAccountGas
    }
    if transfersValue {
        gas += params.CallValueTransferGas
    }
    memoryGas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    var overflow bool
    if gas, overflow = math.SafeAdd(gas, memoryGas); overflow {
        return 0, errGasUintOverflow
    }

    evm.callGasTemp, err = callGas(gt, contract.Gas, gas, stack.Back(0))
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, evm.callGasTemp); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasCallCode(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas := gt.Calls
    if stack.Back(2).Sign() != 0 {
        gas += params.CallValueTransferGas
    }
    memoryGas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    var overflow bool
    if gas, overflow = math.SafeAdd(gas, memoryGas); overflow {
        return 0, errGasUintOverflow
    }

    evm.callGasTemp, err = callGas(gt, contract.Gas, gas, stack.Back(0))
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, evm.callGasTemp); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasReturn(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return memoryGasCost(mem, memorySize)
}

func gasRevert(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return memoryGasCost(mem, memorySize)
}

func gasSuicide(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    var gas uint64
    // EIP150 homestead gas reprice fork:
    if evm.ChainConfig().IsEIP150(evm.BlockNumber) {
        gas = gt.Suicide
        var (
            address = common.BigToAddress(stack.Back(0))
            eip158  = evm.ChainConfig().IsEIP158(evm.BlockNumber)
        )

        if eip158 {
            // if empty and transfers value
            if evm.StateDB.Empty(address) && evm.StateDB.GetBalance(contract.Address()).Sign() != 0 {
                gas += gt.CreateBySuicide
            }
        } else if !evm.StateDB.Exist(address) {
            gas += gt.CreateBySuicide
        }
    }

    if !evm.StateDB.HasSuicided(contract.Address()) {
        evm.StateDB.AddRefund(params.SuicideRefundGas)
    }
    return gas, nil
}

func gasDelegateCall(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    var overflow bool
    if gas, overflow = math.SafeAdd(gas, gt.Calls); overflow {
        return 0, errGasUintOverflow
    }

    evm.callGasTemp, err = callGas(gt, contract.Gas, gas, stack.Back(0))
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, evm.callGasTemp); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasStaticCall(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    gas, err := memoryGasCost(mem, memorySize)
    if err != nil {
        return 0, err
    }
    var overflow bool
    if gas, overflow = math.SafeAdd(gas, gt.Calls); overflow {
        return 0, errGasUintOverflow
    }

    evm.callGasTemp, err = callGas(gt, contract.Gas, gas, stack.Back(0))
    if err != nil {
        return 0, err
    }
    if gas, overflow = math.SafeAdd(gas, evm.callGasTemp); overflow {
        return 0, errGasUintOverflow
    }
    return gas, nil
}

func gasPush(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return GasFastestStep, nil
}

func gasSwap(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return GasFastestStep, nil
}

func gasDup(gt params.GasTable, evm *EVM, contract *Contract, stack *Stack, mem *Memory, memorySize uint64) (uint64, error) {
    return GasFastestStep, nil
}