Skip to content

Commit f124267

Browse files
MercybuddaholimanJohn.H
authored
eth/tracers: improve tracing performance (#23016) (bnb-chain#326)
* eth/tracers: improve tracing performance (#23016) Improves the performance of debug.traceTransaction * Update the import order Co-authored-by: Martin Holst Swende <martin@swende.se> Co-authored-by: John.H <john.h@binance.com>
1 parent 7822e9e commit f124267

File tree

5 files changed

+107
-34
lines changed

5 files changed

+107
-34
lines changed

‎core/vm/gen_structlog.go‎

Lines changed: 6 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎core/vm/logger.go‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import (
2424
"strings"
2525
"time"
2626

27+
"github.com/holiman/uint256"
28+
2729
"github.com/ethereum/go-ethereum/common"
2830
"github.com/ethereum/go-ethereum/common/hexutil"
2931
"github.com/ethereum/go-ethereum/common/math"
@@ -66,7 +68,7 @@ type StructLog struct {
6668
GasCost uint64 `json:"gasCost"`
6769
Memory []byte `json:"memory"`
6870
MemorySize int `json:"memSize"`
69-
Stack []*big.Int `json:"stack"`
71+
Stack []uint256.Int `json:"stack"`
7072
ReturnData []byte `json:"returnData"`
7173
Storage map[common.Hash]common.Hash `json:"-"`
7274
Depth int `json:"depth"`
@@ -76,7 +78,6 @@ type StructLog struct {
7678

7779
// overrides for gencodec
7880
type structLogMarshaling struct {
79-
Stack []*math.HexOrDecimal256
8081
Gas math.HexOrDecimal64
8182
GasCost math.HexOrDecimal64
8283
Memory hexutil.Bytes
@@ -135,6 +136,14 @@ func NewStructLogger(cfg *LogConfig) *StructLogger {
135136
return logger
136137
}
137138

139+
// Reset clears the data held by the logger.
140+
func (l *StructLogger) Reset() {
141+
l.storage = make(map[common.Address]Storage)
142+
l.output = make([]byte, 0)
143+
l.logs = l.logs[:0]
144+
l.err = nil
145+
}
146+
138147
// CaptureStart implements the Tracer interface to initialize the tracing operation.
139148
func (l *StructLogger) CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int) {
140149
}
@@ -157,16 +166,16 @@ func (l *StructLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost ui
157166
copy(mem, memory.Data())
158167
}
159168
// Copy a snapshot of the current stack state to a new buffer
160-
var stck []*big.Int
169+
var stck []uint256.Int
161170
if !l.cfg.DisableStack {
162-
stck = make([]*big.Int, len(stack.Data()))
171+
stck = make([]uint256.Int, len(stack.Data()))
163172
for i, item := range stack.Data() {
164-
stck[i] = new(big.Int).Set(item.ToBig())
173+
stck[i] = item
165174
}
166175
}
167176
// Copy a snapshot of the current storage to a new container
168177
var storage Storage
169-
if !l.cfg.DisableStorage {
178+
if !l.cfg.DisableStorage && (op == SLOAD || op == SSTORE) {
170179
// initialise new changed values storage container for this contract
171180
// if not present.
172181
if l.storage[contract.Address()] == nil {
@@ -179,16 +188,16 @@ func (l *StructLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost ui
179188
value = env.StateDB.GetState(contract.Address(), address)
180189
)
181190
l.storage[contract.Address()][address] = value
182-
}
183-
// capture SSTORE opcodes and record the written entry in the local storage.
184-
if op == SSTORE && stack.len() >= 2 {
191+
storage = l.storage[contract.Address()].Copy()
192+
} else if op == SSTORE && stack.len() >= 2 {
193+
// capture SSTORE opcodes and record the written entry in the local storage.
185194
var (
186195
value = common.Hash(stack.data[stack.len()-2].Bytes32())
187196
address = common.Hash(stack.data[stack.len()-1].Bytes32())
188197
)
189198
l.storage[contract.Address()][address] = value
199+
storage = l.storage[contract.Address()].Copy()
190200
}
191-
storage = l.storage[contract.Address()].Copy()
192201
}
193202
var rdata []byte
194203
if !l.cfg.DisableReturnData {
@@ -238,7 +247,7 @@ func WriteTrace(writer io.Writer, logs []StructLog) {
238247
if len(log.Stack) > 0 {
239248
fmt.Fprintln(writer, "Stack:")
240249
for i := len(log.Stack) - 1; i >= 0; i-- {
241-
fmt.Fprintf(writer, "%08d %x\n", len(log.Stack)-i-1, math.PaddedBigBytes(log.Stack[i], 32))
250+
fmt.Fprintf(writer, "%08d %s\n", len(log.Stack)-i-1, log.Stack[i].Hex())
242251
}
243252
}
244253
if len(log.Memory) > 0 {
@@ -314,7 +323,7 @@ func (t *mdLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost uint64
314323
// format stack
315324
var a []string
316325
for _, elem := range stack.data {
317-
a = append(a, fmt.Sprintf("%v", elem.String()))
326+
a = append(a, elem.Hex())
318327
}
319328
b := fmt.Sprintf("[%v]", strings.Join(a, ","))
320329
fmt.Fprintf(t.out, "%10v |", b)

‎core/vm/logger_json.go‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ func (l *JSONLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost uint
5757
Gas: gas,
5858
GasCost: cost,
5959
MemorySize: memory.Len(),
60-
Storage: nil,
6160
Depth: depth,
6261
RefundCounter: env.StateDB.GetRefund(),
6362
Err: err,
@@ -66,12 +65,7 @@ func (l *JSONLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost uint
6665
log.Memory = memory.Data()
6766
}
6867
if !l.cfg.DisableStack {
69-
//TODO(@holiman) improve this
70-
logstack := make([]*big.Int, len(stack.Data()))
71-
for i, item := range stack.Data() {
72-
logstack[i] = item.ToBig()
73-
}
74-
log.Stack = logstack
68+
log.Stack = stack.data
7569
}
7670
if !l.cfg.DisableReturnData {
7771
log.ReturnData = rData

‎eth/tracers/tracers_test.go‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,3 +300,81 @@ func jsonEqual(x, y interface{}) bool {
300300
}
301301
return reflect.DeepEqual(xTrace, yTrace)
302302
}
303+
304+
func BenchmarkTransactionTrace(b *testing.B) {
305+
key, _ := crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
306+
from := crypto.PubkeyToAddress(key.PublicKey)
307+
gas := uint64(1000000) // 1M gas
308+
to := common.HexToAddress("0x00000000000000000000000000000000deadbeef")
309+
signer := types.LatestSignerForChainID(big.NewInt(1337))
310+
tx, err := types.SignNewTx(key, signer,
311+
&types.LegacyTx{
312+
Nonce: 1,
313+
GasPrice: big.NewInt(500),
314+
Gas: gas,
315+
To: &to,
316+
})
317+
if err != nil {
318+
b.Fatal(err)
319+
}
320+
txContext := vm.TxContext{
321+
Origin: from,
322+
GasPrice: tx.GasPrice(),
323+
}
324+
context := vm.BlockContext{
325+
CanTransfer: core.CanTransfer,
326+
Transfer: core.Transfer,
327+
Coinbase: common.Address{},
328+
BlockNumber: new(big.Int).SetUint64(uint64(5)),
329+
Time: new(big.Int).SetUint64(uint64(5)),
330+
Difficulty: big.NewInt(0xffffffff),
331+
GasLimit: gas,
332+
}
333+
alloc := core.GenesisAlloc{}
334+
// The code pushes 'deadbeef' into memory, then the other params, and calls CREATE2, then returns
335+
// the address
336+
loop := []byte{
337+
byte(vm.JUMPDEST), // [ count ]
338+
byte(vm.PUSH1), 0, // jumpdestination
339+
byte(vm.JUMP),
340+
}
341+
alloc[common.HexToAddress("0x00000000000000000000000000000000deadbeef")] = core.GenesisAccount{
342+
Nonce: 1,
343+
Code: loop,
344+
Balance: big.NewInt(1),
345+
}
346+
alloc[from] = core.GenesisAccount{
347+
Nonce: 1,
348+
Code: []byte{},
349+
Balance: big.NewInt(500000000000000),
350+
}
351+
_, statedb := tests.MakePreState(rawdb.NewMemoryDatabase(), alloc, false)
352+
// Create the tracer, the EVM environment and run it
353+
tracer := vm.NewStructLogger(&vm.LogConfig{
354+
Debug: false,
355+
//DisableStorage: true,
356+
//DisableMemory: true,
357+
//DisableReturnData: true,
358+
})
359+
evm := vm.NewEVM(context, txContext, statedb, params.AllEthashProtocolChanges, vm.Config{Debug: true, Tracer: tracer})
360+
msg, err := tx.AsMessage(signer, nil)
361+
if err != nil {
362+
b.Fatalf("failed to prepare transaction for tracing: %v", err)
363+
}
364+
b.ResetTimer()
365+
b.ReportAllocs()
366+
367+
for i := 0; i < b.N; i++ {
368+
snap := statedb.Snapshot()
369+
st := core.NewStateTransition(evm, msg, new(core.GasPool).AddGas(tx.Gas()))
370+
_, err = st.TransitionDb()
371+
if err != nil {
372+
b.Fatal(err)
373+
}
374+
statedb.RevertToSnapshot(snap)
375+
if have, want := len(tracer.StructLogs()), 244752; have != want {
376+
b.Fatalf("trace wrong, want %d steps, have %d", want, have)
377+
}
378+
tracer.Reset()
379+
}
380+
}

‎internal/ethapi/api.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1124,7 +1124,7 @@ func FormatLogs(logs []vm.StructLog) []StructLogRes {
11241124
if trace.Stack != nil {
11251125
stack := make([]string, len(trace.Stack))
11261126
for i, stackValue := range trace.Stack {
1127-
stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
1127+
stack[i] = stackValue.Hex()
11281128
}
11291129
formatted[index].Stack = &stack
11301130
}

0 commit comments

Comments
 (0)