forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-08-10 14:03:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Change OnGasConsumed(gas, cost uint64, reason) to OnGasChange(old, new uint64, reason)

Browse source 
This way, we avoid having a `cost` that is negative which does not make sense for a `uint64`. Having the `old, new` also yields correct value and the delta can then be negative and be holded in a `int64`.
This commit is contained in:
Matthieu Vachon 2023-08-28 15:29:22 -04:00
parent e0af166ffa
commit 01ccd7126e
12 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
core/state_transition.go
View file

@ -265,7 +265,7 @@ func (st *StateTransition) buyGas() error {
} }
if st.evm.Config.Tracer != nil { if st.evm.Config.Tracer != nil {
st.evm.Config.Tracer.OnGasConsumed(0, -st.msg.GasLimit, vm.GasInitialBalance) st.evm.Config.Tracer.OnGasChange(0, st.msg.GasLimit, vm.GasInitialBalance)
} }
st.gasRemaining += st.msg.GasLimit st.gasRemaining += st.msg.GasLimit
@ -391,7 +391,7 @@ func (st *StateTransition) TransitionDb() (*ExecutionResult, error) {
return nil, fmt.Errorf("%w: have %d, want %d", ErrIntrinsicGas, st.gasRemaining, gas) return nil, fmt.Errorf("%w: have %d, want %d", ErrIntrinsicGas, st.gasRemaining, gas)
} }
if t := st.evm.Config.Tracer; t != nil { if t := st.evm.Config.Tracer; t != nil {
t.OnGasConsumed(st.gasRemaining, gas, vm.GasChangeIntrinsicGas) t.OnGasChange(st.gasRemaining, st.gasRemaining-gas, vm.GasChangeIntrinsicGas)
} }
st.gasRemaining -= gas st.gasRemaining -= gas
@ -459,7 +459,7 @@ func (st *StateTransition) refundGas(refundQuotient uint64) {
} }
if st.evm.Config.Tracer != nil { if st.evm.Config.Tracer != nil {
st.evm.Config.Tracer.OnGasConsumed(st.gasRemaining, -refund, vm.GasRefunded) st.evm.Config.Tracer.OnGasChange(st.gasRemaining, st.gasRemaining+refund, vm.GasRefunded)
} }
st.gasRemaining += refund st.gasRemaining += refund
@ -469,7 +469,7 @@ func (st *StateTransition) refundGas(refundQuotient uint64) {
st.state.AddBalance(st.msg.From, remaining, state.BalanceChangeGasRefund) st.state.AddBalance(st.msg.From, remaining, state.BalanceChangeGasRefund)
if st.evm.Config.Tracer != nil { if st.evm.Config.Tracer != nil {
st.evm.Config.Tracer.OnGasConsumed(st.gasRemaining, st.gasRemaining, vm.GasBuyBack) st.evm.Config.Tracer.OnGasChange(st.gasRemaining, 0, vm.GasBuyBack)
} }
// Also return remaining gas to the block gas counter so it is // Also return remaining gas to the block gas counter so it is

2
core/vm/contract.go
View file

@ -164,7 +164,7 @@ func (c *Contract) UseGas(gas uint64, logger EVMLogger, reason GasChangeReason)
return false return false
} }
if logger != nil { if logger != nil {
logger.OnGasConsumed(c.Gas, gas, reason) logger.OnGasChange(c.Gas, c.Gas-gas, reason)
} }
c.Gas -= gas c.Gas -= gas
return true return true

2
core/vm/contracts.go
View file

@ -174,7 +174,7 @@ func RunPrecompiledContract(p PrecompiledContract, input []byte, suppliedGas uin
return nil, 0, ErrOutOfGas return nil, 0, ErrOutOfGas
} }
if logger != nil { if logger != nil {
logger.OnGasConsumed(suppliedGas, gasCost, GasChangePrecompiledContract) logger.OnGasChange(suppliedGas, suppliedGas-gasCost, GasChangePrecompiledContract)
} }
suppliedGas -= gasCost suppliedGas -= gasCost
output, err := p.Run(input) output, err := p.Run(input)

30
core/vm/evm.go
View file

@ -184,9 +184,9 @@ func (evm *EVM) Call(caller ContractRef, addr common.Address, input []byte, gas
} else { } else {
// Handle tracer events for entering and exiting a call frame // Handle tracer events for entering and exiting a call frame
evm.Config.Tracer.CaptureEnter(CALL, caller.Address(), addr, input, gas, value) evm.Config.Tracer.CaptureEnter(CALL, caller.Address(), addr, input, gas, value)
evm.Config.Tracer.OnGasConsumed(0, -gas, GasInitialBalance) evm.Config.Tracer.OnGasChange(0, gas, GasInitialBalance)
defer func(startGas uint64) { defer func(startGas uint64) {
evm.Config.Tracer.OnGasConsumed(leftOverGas, leftOverGas, GasBuyBack) evm.Config.Tracer.OnGasChange(leftOverGas, 0, GasBuyBack)
evm.Config.Tracer.CaptureExit(ret, startGas-gas, err) evm.Config.Tracer.CaptureExit(ret, startGas-gas, err)
}(gas) }(gas)
} }
@ -236,7 +236,7 @@ func (evm *EVM) Call(caller ContractRef, addr common.Address, input []byte, gas
evm.StateDB.RevertToSnapshot(snapshot) evm.StateDB.RevertToSnapshot(snapshot)
if err != ErrExecutionReverted { if err != ErrExecutionReverted {
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.OnGasConsumed(gas, gas, GasChangeFailedExecution) evm.Config.Tracer.OnGasChange(gas, 0, GasChangeFailedExecution)
} }
gas = 0 gas = 0
@ -259,9 +259,9 @@ func (evm *EVM) CallCode(caller ContractRef, addr common.Address, input []byte,
// Invoke tracer hooks that signal entering/exiting a call frame // Invoke tracer hooks that signal entering/exiting a call frame
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.CaptureEnter(CALLCODE, caller.Address(), addr, input, gas, value) evm.Config.Tracer.CaptureEnter(CALLCODE, caller.Address(), addr, input, gas, value)
evm.Config.Tracer.OnGasConsumed(0, -gas, GasInitialBalance) evm.Config.Tracer.OnGasChange(0, gas, GasInitialBalance)
defer func(startGas uint64) { defer func(startGas uint64) {
evm.Config.Tracer.OnGasConsumed(leftOverGas, leftOverGas, GasBuyBack) evm.Config.Tracer.OnGasChange(leftOverGas, 0, GasBuyBack)
evm.Config.Tracer.CaptureExit(ret, startGas-gas, err) evm.Config.Tracer.CaptureExit(ret, startGas-gas, err)
}(gas) }(gas)
} }
@ -294,7 +294,7 @@ func (evm *EVM) CallCode(caller ContractRef, addr common.Address, input []byte,
evm.StateDB.RevertToSnapshot(snapshot) evm.StateDB.RevertToSnapshot(snapshot)
if err != ErrExecutionReverted { if err != ErrExecutionReverted {
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.OnGasConsumed(gas, gas, GasChangeFailedExecution) evm.Config.Tracer.OnGasChange(gas, 0, GasChangeFailedExecution)
} }
gas = 0 gas = 0
@ -316,9 +316,9 @@ func (evm *EVM) DelegateCall(caller ContractRef, addr common.Address, input []by
parent := caller.(*Contract) parent := caller.(*Contract)
// DELEGATECALL inherits value from parent call // DELEGATECALL inherits value from parent call
evm.Config.Tracer.CaptureEnter(DELEGATECALL, caller.Address(), addr, input, gas, parent.value) evm.Config.Tracer.CaptureEnter(DELEGATECALL, caller.Address(), addr, input, gas, parent.value)
evm.Config.Tracer.OnGasConsumed(0, -gas, GasInitialBalance) evm.Config.Tracer.OnGasChange(0, gas, GasInitialBalance)
defer func(startGas uint64) { defer func(startGas uint64) {
evm.Config.Tracer.OnGasConsumed(leftOverGas, leftOverGas, GasBuyBack) evm.Config.Tracer.OnGasChange(leftOverGas, 0, GasBuyBack)
evm.Config.Tracer.CaptureExit(ret, startGas-gas, err) evm.Config.Tracer.CaptureExit(ret, startGas-gas, err)
}(gas) }(gas)
} }
@ -343,7 +343,7 @@ func (evm *EVM) DelegateCall(caller ContractRef, addr common.Address, input []by
evm.StateDB.RevertToSnapshot(snapshot) evm.StateDB.RevertToSnapshot(snapshot)
if err != ErrExecutionReverted { if err != ErrExecutionReverted {
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.OnGasConsumed(gas, gas, GasChangeFailedExecution) evm.Config.Tracer.OnGasChange(gas, 0, GasChangeFailedExecution)
} }
gas = 0 gas = 0
@ -360,9 +360,9 @@ func (evm *EVM) StaticCall(caller ContractRef, addr common.Address, input []byte
// Invoke tracer hooks that signal entering/exiting a call frame // Invoke tracer hooks that signal entering/exiting a call frame
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.CaptureEnter(STATICCALL, caller.Address(), addr, input, gas, nil) evm.Config.Tracer.CaptureEnter(STATICCALL, caller.Address(), addr, input, gas, nil)
evm.Config.Tracer.OnGasConsumed(0, -gas, GasInitialBalance) evm.Config.Tracer.OnGasChange(0, gas, GasInitialBalance)
defer func(startGas uint64) { defer func(startGas uint64) {
evm.Config.Tracer.OnGasConsumed(leftOverGas, leftOverGas, GasBuyBack) evm.Config.Tracer.OnGasChange(leftOverGas, 0, GasBuyBack)
evm.Config.Tracer.CaptureExit(ret, startGas-gas, err) evm.Config.Tracer.CaptureExit(ret, startGas-gas, err)
}(gas) }(gas)
} }
@ -404,7 +404,7 @@ func (evm *EVM) StaticCall(caller ContractRef, addr common.Address, input []byte
evm.StateDB.RevertToSnapshot(snapshot) evm.StateDB.RevertToSnapshot(snapshot)
if err != ErrExecutionReverted { if err != ErrExecutionReverted {
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.OnGasConsumed(gas, gas, GasChangeFailedExecution) evm.Config.Tracer.OnGasChange(gas, 0, GasChangeFailedExecution)
} }
gas = 0 gas = 0
@ -435,9 +435,9 @@ func (evm *EVM) create(caller ContractRef, codeAndHash *codeAndHash, gas uint64,
}() }()
} else { } else {
evm.Config.Tracer.CaptureEnter(typ, caller.Address(), address, codeAndHash.code, gas, value) evm.Config.Tracer.CaptureEnter(typ, caller.Address(), address, codeAndHash.code, gas, value)
evm.Config.Tracer.OnGasConsumed(0, -gas, GasInitialBalance) evm.Config.Tracer.OnGasChange(0, gas, GasInitialBalance)
defer func() { defer func() {
evm.Config.Tracer.OnGasConsumed(leftoverGas, leftoverGas, GasBuyBack) evm.Config.Tracer.OnGasChange(leftoverGas, 0, GasBuyBack)
evm.Config.Tracer.CaptureExit(ret, gas-leftoverGas, err) evm.Config.Tracer.CaptureExit(ret, gas-leftoverGas, err)
}() }()
} }
@ -464,7 +464,7 @@ func (evm *EVM) create(caller ContractRef, codeAndHash *codeAndHash, gas uint64,
contractHash := evm.StateDB.GetCodeHash(address) contractHash := evm.StateDB.GetCodeHash(address)
if evm.StateDB.GetNonce(address) != 0 || (contractHash != (common.Hash{}) && contractHash != types.EmptyCodeHash) { if evm.StateDB.GetNonce(address) != 0 || (contractHash != (common.Hash{}) && contractHash != types.EmptyCodeHash) {
if evm.Config.Tracer != nil { if evm.Config.Tracer != nil {
evm.Config.Tracer.OnGasConsumed(gas, gas, GasChangeFailedExecution) evm.Config.Tracer.OnGasChange(gas, 0, GasChangeFailedExecution)
} }
return nil, common.Address{}, 0, ErrContractAddressCollision return nil, common.Address{}, 0, ErrContractAddressCollision

12
core/vm/instructions.go
View file

@ -614,7 +614,7 @@ func opCreate(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]b
scope.Stack.push(&stackvalue) scope.Stack.push(&stackvalue)
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas
@ -659,7 +659,7 @@ func opCreate2(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]
scope.Stack.push(&stackvalue) scope.Stack.push(&stackvalue)
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas
@ -709,7 +709,7 @@ func opCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byt
} }
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas
@ -749,7 +749,7 @@ func opCallCode(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([
} }
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas
@ -782,7 +782,7 @@ func opDelegateCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext
} }
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas
@ -815,7 +815,7 @@ func opStaticCall(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext)
} }
if interpreter.evm.Config.Tracer != nil { if interpreter.evm.Config.Tracer != nil {
interpreter.evm.Config.Tracer.OnGasConsumed(scope.Contract.Gas, -returnGas, GasChangeCallLeftOverRefunded) interpreter.evm.Config.Tracer.OnGasChange(scope.Contract.Gas, scope.Contract.Gas+returnGas, GasChangeCallLeftOverRefunded)
} }
scope.Contract.Gas += returnGas scope.Contract.Gas += returnGas

2
core/vm/logger.go
View file

@ -43,7 +43,7 @@ type EVMLogger interface {
CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error) CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)
CaptureKeccakPreimage(hash common.Hash, data []byte) CaptureKeccakPreimage(hash common.Hash, data []byte)
// Misc // Misc
OnGasConsumed(gas, amount uint64, reason GasChangeReason) OnGasChange(old, new uint64, reason GasChangeReason)
} }
// GasChangeReason is used to indicate the reason for a gas change, useful // GasChangeReason is used to indicate the reason for a gas change, useful

2
eth/tracers/logger/access_list_tracer.go
View file

@ -163,7 +163,7 @@ func (*AccessListTracer) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64,
func (*AccessListTracer) CaptureKeccakPreimage(hash common.Hash, data []byte) {} func (*AccessListTracer) CaptureKeccakPreimage(hash common.Hash, data []byte) {}
func (*AccessListTracer) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) {} func (*AccessListTracer) OnGasChange(old, new uint64, reason vm.GasChangeReason) {}
func (*AccessListTracer) CaptureEnd(output []byte, gasUsed uint64, err error) {} func (*AccessListTracer) CaptureEnd(output []byte, gasUsed uint64, err error) {}

4
eth/tracers/logger/logger.go
View file

@ -219,7 +219,7 @@ func (l *StructLogger) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64, s
// CaptureKeccakPreimage is called during the KECCAK256 opcode. // CaptureKeccakPreimage is called during the KECCAK256 opcode.
func (l *StructLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {} func (l *StructLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {}
func (l *StructLogger) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) {} func (l *StructLogger) OnGasChange(old, new uint64, reason vm.GasChangeReason) {}
// CaptureEnd is called after the call finishes to finalize the tracing. // CaptureEnd is called after the call finishes to finalize the tracing.
func (l *StructLogger) CaptureEnd(output []byte, gasUsed uint64, err error) { func (l *StructLogger) CaptureEnd(output []byte, gasUsed uint64, err error) {
@ -410,7 +410,7 @@ func (t *mdLogger) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64, scope
func (t *mdLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {} func (t *mdLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {}
func (t *mdLogger) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) {} func (t *mdLogger) OnGasChange(old, new uint64, reason vm.GasChangeReason) {}
func (t *mdLogger) CaptureEnd(output []byte, gasUsed uint64, err error) { func (t *mdLogger) CaptureEnd(output []byte, gasUsed uint64, err error) {
fmt.Fprintf(t.out, "\nOutput: `%#x`\nConsumed gas: `%d`\nError: `%v`\n", fmt.Fprintf(t.out, "\nOutput: `%#x`\nConsumed gas: `%d`\nError: `%v`\n",

2
eth/tracers/logger/logger_json.go
View file

@ -81,7 +81,7 @@ func (l *JSONLogger) CaptureState(pc uint64, op vm.OpCode, gas, cost uint64, sco
// CaptureKeccakPreimage is called during the KECCAK256 opcode. // CaptureKeccakPreimage is called during the KECCAK256 opcode.
func (l *JSONLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {} func (l *JSONLogger) CaptureKeccakPreimage(hash common.Hash, data []byte) {}
func (l *JSONLogger) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) {} func (l *JSONLogger) OnGasChange(old, new uint64, reason vm.GasChangeReason) {}
// CaptureEnd is triggered at end of execution. // CaptureEnd is triggered at end of execution.
func (l *JSONLogger) CaptureEnd(output []byte, gasUsed uint64, err error) { func (l *JSONLogger) CaptureEnd(output []byte, gasUsed uint64, err error) {

4
eth/tracers/native/mux.go
View file

@ -96,9 +96,9 @@ func (t *muxTracer) CaptureKeccakPreimage(hash common.Hash, data []byte) {
} }
// CaptureGasConsumed is called when gas is consumed. // CaptureGasConsumed is called when gas is consumed.
func (t *muxTracer) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) { func (t *muxTracer) OnGasChange(old, new uint64, reason vm.GasChangeReason) {
for _, t := range t.tracers { for _, t := range t.tracers {
t.OnGasConsumed(gas, amount, reason) t.OnGasChange(old, new, reason)
} }
} }

4
eth/tracers/noop.go
View file

@ -58,8 +58,8 @@ func (t *NoopTracer) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64, _ *
// CaptureKeccakPreimage is called during the KECCAK256 opcode. // CaptureKeccakPreimage is called during the KECCAK256 opcode.
func (t *NoopTracer) CaptureKeccakPreimage(hash common.Hash, data []byte) {} func (t *NoopTracer) CaptureKeccakPreimage(hash common.Hash, data []byte) {}
// OnGasConsumed is called when gas is consumed. // OnGasChange is called when gas is either consumed or refunded.
func (t *NoopTracer) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) {} func (t *NoopTracer) OnGasChange(old, new uint64, reason vm.GasChangeReason) {}
// CaptureEnter is called when EVM enters a new scope (via call, create or selfdestruct). // CaptureEnter is called when EVM enters a new scope (via call, create or selfdestruct).
func (t *NoopTracer) CaptureEnter(typ vm.OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) { func (t *NoopTracer) CaptureEnter(typ vm.OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) {

4
eth/tracers/printer.go
View file

@ -120,6 +120,6 @@ func (p *Printer) OnNewAccount(a common.Address) {
fmt.Printf("OnNewAccount: a=%v\n", a) fmt.Printf("OnNewAccount: a=%v\n", a)
} }
func (p *Printer) OnGasConsumed(gas, amount uint64, reason vm.GasChangeReason) { func (p *Printer) OnGasChange(old, new uint64, reason vm.GasChangeReason) {
fmt.Printf("OnGasConsumed: gas=%v, amount=%v\n", gas, amount) fmt.Printf("OnGasChange: old=%v, new=%v, diff=%v\n", old, new, new-old)
} }