/
evm.go
476 lines (425 loc) · 16.5 KB
/
evm.go
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
//此源码被清华学神尹成大魔王专业翻译分析并修改
//尹成QQ77025077
//尹成微信18510341407
//尹成所在QQ群721929980
//尹成邮箱 yinc13@mails.tsinghua.edu.cn
//尹成毕业于清华大学,微软区块链领域全球最有价值专家
//https://mvp.microsoft.com/zh-cn/PublicProfile/4033620
//版权所有2014 Go Ethereum作者
//此文件是Go以太坊库的一部分。
//
//Go-Ethereum库是免费软件:您可以重新分发它和/或修改
//根据GNU发布的较低通用公共许可证的条款
//自由软件基金会,或者许可证的第3版,或者
//(由您选择)任何更高版本。
//
//Go以太坊图书馆的发行目的是希望它会有用,
//但没有任何保证;甚至没有
//适销性或特定用途的适用性。见
//GNU较低的通用公共许可证,了解更多详细信息。
//
//你应该收到一份GNU较低级别的公共许可证副本
//以及Go以太坊图书馆。如果没有,请参见<http://www.gnu.org/licenses/>。
package vm
import (
"math/big"
"sync/atomic"
"time"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/params"
)
//create使用EmptyCodeHash来确保已不允许部署
//已部署的合同地址(在帐户提取之后相关)。
var emptyCodeHash = crypto.Keccak256Hash(nil)
type (
//cantransferfunc是传递保护函数的签名
CanTransferFunc func(StateDB, common.Address, *big.Int) bool
//transferFunc是传递函数的签名
TransferFunc func(StateDB, common.Address, common.Address, *big.Int)
//gethashfunc返回区块链中的第n个区块哈希
//并由blockhash evm op代码使用。
GetHashFunc func(uint64) common.Hash
)
//Run运行给定的合同,并负责运行回退到字节码解释器的预编译。
func run(evm *EVM, contract *Contract, input []byte, readOnly bool) ([]byte, error) {
if contract.CodeAddr != nil {
precompiles := PrecompiledContractsHomestead
if evm.ChainConfig().IsByzantium(evm.BlockNumber) {
precompiles = PrecompiledContractsByzantium
}
if p := precompiles[*contract.CodeAddr]; p != nil {
return RunPrecompiledContract(p, input, contract)
}
}
for _, interpreter := range evm.interpreters {
if interpreter.CanRun(contract.Code) {
if evm.interpreter != interpreter {
//确保解释器指针设置回原处
//返回到当前值。
defer func(i Interpreter) {
evm.interpreter = i
}(evm.interpreter)
evm.interpreter = interpreter
}
return interpreter.Run(contract, input, readOnly)
}
}
return nil, ErrNoCompatibleInterpreter
}
//上下文为EVM提供辅助信息。一旦提供
//它不应该被修改。
type Context struct {
//CanTransfer返回帐户是否包含
//足够的乙醚转移价值
CanTransfer CanTransferFunc
//将乙醚从一个帐户转移到另一个帐户
Transfer TransferFunc
//GetHash返回与n对应的哈希
GetHash GetHashFunc
//消息信息
Origin common.Address //提供源站信息
GasPrice *big.Int //为Gasprice提供信息
//阻止信息
Coinbase common.Address //为CoinBase提供信息
GasLimit uint64 //Provides information for GASLIMIT
BlockNumber *big.Int //提供数字信息
Time *big.Int //提供时间信息
Difficulty *big.Int //为困难提供信息
}
//EVM是以太坊虚拟机基础对象,它提供
//在给定状态下运行合同所需的工具
//提供的上下文。应该注意的是,任何错误
//通过任何调用生成的应被视为
//恢复状态并消耗所有气体操作,不检查
//应执行特定错误。翻译使
//确保生成的任何错误都被视为错误代码。
//
//EVM不应该被重用,也不是线程安全的。
type EVM struct {
//上下文提供辅助区块链相关信息
Context
//statedb提供对底层状态的访问
StateDB StateDB
//深度是当前调用堆栈
depth int
//chainconfig包含有关当前链的信息
chainConfig *params.ChainConfig
//链规则包含当前纪元的链规则
chainRules params.Rules
//用于初始化的虚拟机配置选项
//EVM。
vmConfig Config
//全局(到此上下文)以太坊虚拟机
//在整个Tx执行过程中使用。
interpreters []Interpreter
interpreter Interpreter
//abort用于中止EVM调用操作
//注:必须按原子顺序设置
abort int32
//callgastemp保留当前呼叫可用的气体。这是需要的,因为
//根据63/64规则和更高版本,可用气体在GasCall*中计算。
//在opcall*中应用。
callGasTemp uint64
}
//new evm返回新的evm。返回的EVM不是线程安全的,应该
//只能使用一次。
func NewEVM(ctx Context, statedb StateDB, chainConfig *params.ChainConfig, vmConfig Config) *EVM {
evm := &EVM{
Context: ctx,
StateDB: statedb,
vmConfig: vmConfig,
chainConfig: chainConfig,
chainRules: chainConfig.Rules(ctx.BlockNumber),
interpreters: make([]Interpreter, 0, 1),
}
if chainConfig.IsEWASM(ctx.BlockNumber) {
//由EVM-C和货车PRS实施。
//如果vmconfig.ewasminterper!=“{”
//extIntopts:=strings.split(vmconfig.ewasInterpreter,“:”)
//路径:=extintopts[0]
//选项:=[]字符串
//如果len(extintopts)>1
//选项=extintopts[1..]
//}
//evm.interpreters=append(evm.interpreters,newevmvcinterpreter(evm,vmconfig,options))。
//}否则{
//evm.interpreters=append(evm.interpreters,newewasInterpreter(evm,vmconfig))。
//}
panic("No supported ewasm interpreter yet.")
}
//vmconfig.evminterpreter将由evm-c使用,此处不检查
//因为我们总是希望将内置的EVM作为故障转移选项。
evm.interpreters = append(evm.interpreters, NewEVMInterpreter(evm, vmConfig))
evm.interpreter = evm.interpreters[0]
return evm
}
//取消取消任何正在运行的EVM操作。这可以同时调用,并且
//多次打电话是安全的。
func (evm *EVM) Cancel() {
atomic.StoreInt32(&evm.abort, 1)
}
//解释器返回当前解释器
func (evm *EVM) Interpreter() Interpreter {
return evm.interpreter
}
//调用执行与给定输入为的addr关联的协定
//参数。它还处理任何必要的价值转移,并采取
//创建帐户和在
//执行错误或值传输失败。
func (evm *EVM) Call(caller ContractRef, addr common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, leftOverGas uint64, err error) {
if evm.vmConfig.NoRecursion && evm.depth > 0 {
return nil, gas, nil
}
//如果我们试图执行超过调用深度限制,则失败
if evm.depth > int(params.CallCreateDepth) {
return nil, gas, ErrDepth
}
//如果我们试图转移的余额超过可用余额,则失败
if !evm.Context.CanTransfer(evm.StateDB, caller.Address(), value) {
return nil, gas, ErrInsufficientBalance
}
var (
to = AccountRef(addr)
snapshot = evm.StateDB.Snapshot()
)
if !evm.StateDB.Exist(addr) {
precompiles := PrecompiledContractsHomestead
if evm.ChainConfig().IsByzantium(evm.BlockNumber) {
precompiles = PrecompiledContractsByzantium
}
if precompiles[addr] == nil && evm.ChainConfig().IsEIP158(evm.BlockNumber) && value.Sign() == 0 {
//调用一个不存在的帐户,不要做任何事情,只需ping跟踪程序
if evm.vmConfig.Debug && evm.depth == 0 {
evm.vmConfig.Tracer.CaptureStart(caller.Address(), addr, false, input, gas, value)
evm.vmConfig.Tracer.CaptureEnd(ret, 0, 0, nil)
}
return nil, gas, nil
}
evm.StateDB.CreateAccount(addr)
}
evm.Transfer(evm.StateDB, caller.Address(), to.Address(), value)
//初始化新合同并设置EVM要使用的代码。
//契约只是这个执行上下文的作用域环境。
contract := NewContract(caller, to, value, gas)
contract.SetCallCode(&addr, evm.StateDB.GetCodeHash(addr), evm.StateDB.GetCode(addr))
//即使帐户没有代码,我们也需要继续,因为它可能是预编译的
start := time.Now()
//在调试模式下捕获跟踪程序开始/结束事件
if evm.vmConfig.Debug && evm.depth == 0 {
evm.vmConfig.Tracer.CaptureStart(caller.Address(), addr, false, input, gas, value)
defer func() { //参数的延迟评估
evm.vmConfig.Tracer.CaptureEnd(ret, gas-contract.Gas, time.Since(start), err)
}()
}
ret, err = run(evm, contract, input, false)
//当EVM返回错误或设置创建代码时
//在上面,我们返回快照并消耗所有剩余的气体。另外
//当我们在宅基地时,这也算是代码存储气体错误。
if err != nil {
evm.StateDB.RevertToSnapshot(snapshot)
if err != errExecutionReverted {
contract.UseGas(contract.Gas)
}
}
return ret, contract.Gas, err
}
//callcode使用给定的输入执行与addr关联的协定
//作为参数。它还处理任何必要的价值转移,并采取
//创建帐户和在
//执行错误或值传输失败。
//
//callcode与call的区别在于它执行给定的地址'
//以调用方为上下文的代码。
func (evm *EVM) CallCode(caller ContractRef, addr common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, leftOverGas uint64, err error) {
if evm.vmConfig.NoRecursion && evm.depth > 0 {
return nil, gas, nil
}
//如果我们试图执行超过调用深度限制,则失败
if evm.depth > int(params.CallCreateDepth) {
return nil, gas, ErrDepth
}
//如果我们试图转移的余额超过可用余额,则失败
if !evm.CanTransfer(evm.StateDB, caller.Address(), value) {
return nil, gas, ErrInsufficientBalance
}
var (
snapshot = evm.StateDB.Snapshot()
to = AccountRef(caller.Address())
)
//初始化新合同并设置
//EVM。合同是此执行上下文的作用域环境
//只有。
contract := NewContract(caller, to, value, gas)
contract.SetCallCode(&addr, evm.StateDB.GetCodeHash(addr), evm.StateDB.GetCode(addr))
ret, err = run(evm, contract, input, false)
if err != nil {
evm.StateDB.RevertToSnapshot(snapshot)
if err != errExecutionReverted {
contract.UseGas(contract.Gas)
}
}
return ret, contract.Gas, err
}
//DelegateCall执行与给定输入的addr关联的协定
//作为参数。如果发生执行错误,它将反转状态。
//
//delegateCall与callcode的区别在于它执行给定的地址'
//以调用者为上下文的代码,调用者被设置为调用者的调用者。
func (evm *EVM) DelegateCall(caller ContractRef, addr common.Address, input []byte, gas uint64) (ret []byte, leftOverGas uint64, err error) {
if evm.vmConfig.NoRecursion && evm.depth > 0 {
return nil, gas, nil
}
//如果我们试图执行超过调用深度限制,则失败
if evm.depth > int(params.CallCreateDepth) {
return nil, gas, ErrDepth
}
var (
snapshot = evm.StateDB.Snapshot()
to = AccountRef(caller.Address())
)
//初始化新合同并使委托值初始化
contract := NewContract(caller, to, nil, gas).AsDelegate()
contract.SetCallCode(&addr, evm.StateDB.GetCodeHash(addr), evm.StateDB.GetCode(addr))
ret, err = run(evm, contract, input, false)
if err != nil {
evm.StateDB.RevertToSnapshot(snapshot)
if err != errExecutionReverted {
contract.UseGas(contract.Gas)
}
}
return ret, contract.Gas, err
}
//staticCall使用给定的输入执行与addr关联的协定
//作为参数,同时不允许在调用期间对状态进行任何修改。
//试图执行此类修改的操作码将导致异常
//而不是执行修改。
func (evm *EVM) StaticCall(caller ContractRef, addr common.Address, input []byte, gas uint64) (ret []byte, leftOverGas uint64, err error) {
if evm.vmConfig.NoRecursion && evm.depth > 0 {
return nil, gas, nil
}
//如果我们试图执行超过调用深度限制,则失败
if evm.depth > int(params.CallCreateDepth) {
return nil, gas, ErrDepth
}
var (
to = AccountRef(addr)
snapshot = evm.StateDB.Snapshot()
)
//初始化新合同并设置
//EVM。合同是此执行上下文的作用域环境
//只有。
contract := NewContract(caller, to, new(big.Int), gas)
contract.SetCallCode(&addr, evm.StateDB.GetCodeHash(addr), evm.StateDB.GetCode(addr))
//我们在这里做一个零的加法平衡,只是为了触发一个触摸。
//在拜占庭时代,所有空的东西都不见了。
//但是,在其他网络、测试和潜力方面是否正确以及重要?
//未来情景
evm.StateDB.AddBalance(addr, bigZero)
//当EVM返回错误或设置创建代码时
//在上面,我们返回快照并消耗所有剩余的气体。另外
//当我们在宅基地时,这也算是代码存储气体错误。
ret, err = run(evm, contract, input, true)
if err != nil {
evm.StateDB.RevertToSnapshot(snapshot)
if err != errExecutionReverted {
contract.UseGas(contract.Gas)
}
}
return ret, contract.Gas, err
}
type codeAndHash struct {
code []byte
hash common.Hash
}
func (c *codeAndHash) Hash() common.Hash {
if c.hash == (common.Hash{}) {
c.hash = crypto.Keccak256Hash(c.code)
}
return c.hash
}
//创建使用代码作为部署代码创建新合同。
func (evm *EVM) create(caller ContractRef, codeAndHash *codeAndHash, gas uint64, value *big.Int, address common.Address) ([]byte, common.Address, uint64, error) {
//深度检查执行。如果我们试图执行上面的
//极限。
if evm.depth > int(params.CallCreateDepth) {
return nil, common.Address{}, gas, ErrDepth
}
if !evm.CanTransfer(evm.StateDB, caller.Address(), value) {
return nil, common.Address{}, gas, ErrInsufficientBalance
}
nonce := evm.StateDB.GetNonce(caller.Address())
evm.StateDB.SetNonce(caller.Address(), nonce+1)
//确保指定地址没有现有合同
contractHash := evm.StateDB.GetCodeHash(address)
if evm.StateDB.GetNonce(address) != 0 || (contractHash != (common.Hash{}) && contractHash != emptyCodeHash) {
return nil, common.Address{}, 0, ErrContractAddressCollision
}
//在该州创建新帐户
snapshot := evm.StateDB.Snapshot()
evm.StateDB.CreateAccount(address)
if evm.ChainConfig().IsEIP158(evm.BlockNumber) {
evm.StateDB.SetNonce(address, 1)
}
evm.Transfer(evm.StateDB, caller.Address(), address, value)
//初始化新合同并设置
//EVM。合同是此执行上下文的作用域环境
//只有。
contract := NewContract(caller, AccountRef(address), value, gas)
contract.SetCodeOptionalHash(&address, codeAndHash)
if evm.vmConfig.NoRecursion && evm.depth > 0 {
return nil, address, gas, nil
}
if evm.vmConfig.Debug && evm.depth == 0 {
evm.vmConfig.Tracer.CaptureStart(caller.Address(), address, true, codeAndHash.code, gas, value)
}
start := time.Now()
ret, err := run(evm, contract, nil, false)
//检查是否超过了最大代码大小
maxCodeSizeExceeded := evm.ChainConfig().IsEIP158(evm.BlockNumber) && len(ret) > params.MaxCodeSize
//如果合同创建成功运行且未返回错误
//计算存储代码所需的气体。如果代码不能
//因气量不足而储存,设置错误并处理
//通过下面的错误检查条件。
if err == nil && !maxCodeSizeExceeded {
createDataGas := uint64(len(ret)) * params.CreateDataGas
if contract.UseGas(createDataGas) {
evm.StateDB.SetCode(address, ret)
} else {
err = ErrCodeStoreOutOfGas
}
}
//当EVM返回错误或设置创建代码时
//在上面,我们返回快照并消耗所有剩余的气体。另外
//当我们在宅基地时,这也算是代码存储气体错误。
if maxCodeSizeExceeded || (err != nil && (evm.ChainConfig().IsHomestead(evm.BlockNumber) || err != ErrCodeStoreOutOfGas)) {
evm.StateDB.RevertToSnapshot(snapshot)
if err != errExecutionReverted {
contract.UseGas(contract.Gas)
}
}
//如果合同代码大小超过最大值而错误仍然为空,则分配错误。
if maxCodeSizeExceeded && err == nil {
err = errMaxCodeSizeExceeded
}
if evm.vmConfig.Debug && evm.depth == 0 {
evm.vmConfig.Tracer.CaptureEnd(ret, gas-contract.Gas, time.Since(start), err)
}
return ret, address, contract.Gas, err
}
//创建使用代码作为部署代码创建新合同。
func (evm *EVM) Create(caller ContractRef, code []byte, gas uint64, value *big.Int) (ret []byte, contractAddr common.Address, leftOverGas uint64, err error) {
contractAddr = crypto.CreateAddress(caller.Address(), evm.StateDB.GetNonce(caller.Address()))
return evm.create(caller, &codeAndHash{code: code}, gas, value, contractAddr)
}
//Create2使用代码作为部署代码创建新合同。
//
//create2与create的区别是create2使用sha3(0xff++msg.sender++salt++sha3(init_code))[12:]
//而不是通常的发送者和nonce散列作为合同初始化的地址。
func (evm *EVM) Create2(caller ContractRef, code []byte, gas uint64, endowment *big.Int, salt *big.Int) (ret []byte, contractAddr common.Address, leftOverGas uint64, err error) {
codeAndHash := &codeAndHash{code: code}
contractAddr = crypto.CreateAddress2(caller.Address(), common.BigToHash(salt), codeAndHash.Hash().Bytes())
return evm.create(caller, codeAndHash, gas, endowment, contractAddr)
}
//chainconfig返回环境的链配置
func (evm *EVM) ChainConfig() *params.ChainConfig { return evm.chainConfig }