Skip to content

Commit c18c5c3

Browse files
jsvisajsvisa
authored
cmd/evm: t8n support custom tracers (#28557)
This change implements ability for the `evm t8n` tool to use custom tracers; either 'native' golang tracers or javascript tracers.
1 parent 553bafc commit c18c5c3

File tree

5 files changed

+119
-51
lines changed

5 files changed

+119
-51
lines changed

‎cmd/evm/internal/t8ntool/execution.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ type rejectedTx struct {
117117
// Apply applies a set of transactions to a pre-state
118118
func (pre *Prestate) Apply(vmConfig vm.Config, chainConfig *params.ChainConfig,
119119
txIt txIterator, miningReward int64,
120-
getTracerFn func(txIndex int, txHash common.Hash) (tracer vm.EVMLogger, err error)) (*state.StateDB, *ExecutionResult, []byte, error) {
120+
getTracerFn func(txIndex int, txHash common.Hash) (vm.EVMLogger, error)) (*state.StateDB, *ExecutionResult, []byte, error) {
121121
// Capture errors for BLOCKHASH operation, if we haven't been supplied the
122122
// required blockhashes
123123
var hashError error

‎cmd/evm/internal/t8ntool/flags.go

+8-10
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@ import (
2828
var (
2929
TraceFlag = &cli.BoolFlag{
3030
Name: "trace",
31-
Usage: "Output full trace logs to files <txhash>.jsonl",
31+
Usage: "Configures the use of the JSON opcode tracer. This tracer emits traces to files as trace-<txIndex>-<txHash>.jsonl",
3232
}
33-
TraceDisableMemoryFlag = &cli.BoolFlag{
34-
Name: "trace.nomemory",
35-
Value: true,
36-
Usage: "Disable full memory dump in traces (deprecated)",
33+
TraceTracerFlag = &cli.StringFlag{
34+
Name: "trace.tracer",
35+
Usage: "Configures the use of a custom tracer, e.g native or js tracers. Examples are callTracer and 4byteTracer. These tracers emit results into files as trace-<txIndex>-<txHash>.json",
36+
}
37+
TraceTracerConfigFlag = &cli.StringFlag{
38+
Name: "trace.jsonconfig",
39+
Usage: "The configurations for the custom tracer specified by --trace.tracer. If provided, must be in JSON format",
3740
}
3841
TraceEnableMemoryFlag = &cli.BoolFlag{
3942
Name: "trace.memory",
@@ -43,11 +46,6 @@ var (
4346
Name: "trace.nostack",
4447
Usage: "Disable stack output in traces",
4548
}
46-
TraceDisableReturnDataFlag = &cli.BoolFlag{
47-
Name: "trace.noreturndata",
48-
Value: true,
49-
Usage: "Disable return data output in traces (deprecated)",
50-
}
5149
TraceEnableReturnDataFlag = &cli.BoolFlag{
5250
Name: "trace.returndata",
5351
Usage: "Enable return data output in traces",

‎cmd/evm/internal/t8ntool/tracewriter.go

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
// Copyright 2020 The go-ethereum Authors
2+
// This file is part of go-ethereum.
3+
//
4+
// go-ethereum is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// go-ethereum is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU General Public License
15+
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
16+
17+
package t8ntool
18+
19+
import (
20+
"encoding/json"
21+
"io"
22+
"math/big"
23+
24+
"github.com/ethereum/go-ethereum/common"
25+
"github.com/ethereum/go-ethereum/core/vm"
26+
"github.com/ethereum/go-ethereum/eth/tracers"
27+
"github.com/ethereum/go-ethereum/log"
28+
)
29+
30+
// traceWriter is an vm.EVMLogger which also holds an inner logger/tracer.
31+
// When the TxEnd event happens, the inner tracer result is written to the file, and
32+
// the file is closed.
33+
type traceWriter struct {
34+
inner vm.EVMLogger
35+
f io.WriteCloser
36+
}
37+
38+
// Compile-time interface check
39+
var _ = vm.EVMLogger((*traceWriter)(nil))
40+
41+
func (t *traceWriter) CaptureTxEnd(restGas uint64) {
42+
t.inner.CaptureTxEnd(restGas)
43+
defer t.f.Close()
44+
45+
if tracer, ok := t.inner.(tracers.Tracer); ok {
46+
result, err := tracer.GetResult()
47+
if err != nil {
48+
log.Warn("Error in tracer", "err", err)
49+
return
50+
}
51+
err = json.NewEncoder(t.f).Encode(result)
52+
if err != nil {
53+
log.Warn("Error writing tracer output", "err", err)
54+
return
55+
}
56+
}
57+
}
58+
59+
func (t *traceWriter) CaptureTxStart(gasLimit uint64) { t.inner.CaptureTxStart(gasLimit) }
60+
func (t *traceWriter) CaptureStart(env *vm.EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int) {
61+
t.inner.CaptureStart(env, from, to, create, input, gas, value)
62+
}
63+
64+
func (t *traceWriter) CaptureEnd(output []byte, gasUsed uint64, err error) {
65+
t.inner.CaptureEnd(output, gasUsed, err)
66+
}
67+
68+
func (t *traceWriter) CaptureEnter(typ vm.OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) {
69+
t.inner.CaptureEnter(typ, from, to, input, gas, value)
70+
}
71+
72+
func (t *traceWriter) CaptureExit(output []byte, gasUsed uint64, err error) {
73+
t.inner.CaptureExit(output, gasUsed, err)
74+
}
75+
76+
func (t *traceWriter) CaptureState(pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, rData []byte, depth int, err error) {
77+
t.inner.CaptureState(pc, op, gas, cost, scope, rData, depth, err)
78+
}
79+
func (t *traceWriter) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, depth int, err error) {
80+
t.inner.CaptureFault(pc, op, gas, cost, scope, depth, err)
81+
}

‎cmd/evm/internal/t8ntool/transition.go

+23-38
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import (
3131
"github.com/ethereum/go-ethereum/core/state"
3232
"github.com/ethereum/go-ethereum/core/types"
3333
"github.com/ethereum/go-ethereum/core/vm"
34+
"github.com/ethereum/go-ethereum/eth/tracers"
3435
"github.com/ethereum/go-ethereum/eth/tracers/logger"
3536
"github.com/ethereum/go-ethereum/log"
3637
"github.com/ethereum/go-ethereum/params"
@@ -80,57 +81,43 @@ type input struct {
8081
}
8182

8283
func Transition(ctx *cli.Context) error {
83-
var (
84-
err error
85-
tracer vm.EVMLogger
86-
)
87-
var getTracer func(txIndex int, txHash common.Hash) (vm.EVMLogger, error)
84+
var getTracer = func(txIndex int, txHash common.Hash) (vm.EVMLogger, error) { return nil, nil }
8885

8986
baseDir, err := createBasedir(ctx)
9087
if err != nil {
9188
return NewError(ErrorIO, fmt.Errorf("failed creating output basedir: %v", err))
9289
}
93-
if ctx.Bool(TraceFlag.Name) {
94-
if ctx.IsSet(TraceDisableMemoryFlag.Name) && ctx.IsSet(TraceEnableMemoryFlag.Name) {
95-
return NewError(ErrorConfig, fmt.Errorf("can't use both flags --%s and --%s", TraceDisableMemoryFlag.Name, TraceEnableMemoryFlag.Name))
96-
}
97-
if ctx.IsSet(TraceDisableReturnDataFlag.Name) && ctx.IsSet(TraceEnableReturnDataFlag.Name) {
98-
return NewError(ErrorConfig, fmt.Errorf("can't use both flags --%s and --%s", TraceDisableReturnDataFlag.Name, TraceEnableReturnDataFlag.Name))
99-
}
100-
if ctx.IsSet(TraceDisableMemoryFlag.Name) {
101-
log.Warn(fmt.Sprintf("--%s has been deprecated in favour of --%s", TraceDisableMemoryFlag.Name, TraceEnableMemoryFlag.Name))
102-
}
103-
if ctx.IsSet(TraceDisableReturnDataFlag.Name) {
104-
log.Warn(fmt.Sprintf("--%s has been deprecated in favour of --%s", TraceDisableReturnDataFlag.Name, TraceEnableReturnDataFlag.Name))
105-
}
90+
91+
if ctx.Bool(TraceFlag.Name) { // JSON opcode tracing
10692
// Configure the EVM logger
10793
logConfig := &logger.Config{
10894
DisableStack: ctx.Bool(TraceDisableStackFlag.Name),
109-
EnableMemory: !ctx.Bool(TraceDisableMemoryFlag.Name) || ctx.Bool(TraceEnableMemoryFlag.Name),
110-
EnableReturnData: !ctx.Bool(TraceDisableReturnDataFlag.Name) || ctx.Bool(TraceEnableReturnDataFlag.Name),
95+
EnableMemory: ctx.Bool(TraceEnableMemoryFlag.Name),
96+
EnableReturnData: ctx.Bool(TraceEnableReturnDataFlag.Name),
11197
Debug: true,
11298
}
113-
var prevFile *os.File
114-
// This one closes the last file
115-
defer func() {
116-
if prevFile != nil {
117-
prevFile.Close()
118-
}
119-
}()
12099
getTracer = func(txIndex int, txHash common.Hash) (vm.EVMLogger, error) {
121-
if prevFile != nil {
122-
prevFile.Close()
123-
}
124100
traceFile, err := os.Create(path.Join(baseDir, fmt.Sprintf("trace-%d-%v.jsonl", txIndex, txHash.String())))
125101
if err != nil {
126102
return nil, NewError(ErrorIO, fmt.Errorf("failed creating trace-file: %v", err))
127103
}
128-
prevFile = traceFile
129-
return logger.NewJSONLogger(logConfig, traceFile), nil
104+
return &traceWriter{logger.NewJSONLogger(logConfig, traceFile), traceFile}, nil
130105
}
131-
} else {
132-
getTracer = func(txIndex int, txHash common.Hash) (tracer vm.EVMLogger, err error) {
133-
return nil, nil
106+
} else if ctx.IsSet(TraceTracerFlag.Name) {
107+
var config json.RawMessage
108+
if ctx.IsSet(TraceTracerConfigFlag.Name) {
109+
config = []byte(ctx.String(TraceTracerConfigFlag.Name))
110+
}
111+
getTracer = func(txIndex int, txHash common.Hash) (vm.EVMLogger, error) {
112+
traceFile, err := os.Create(path.Join(baseDir, fmt.Sprintf("trace-%d-%v.json", txIndex, txHash.String())))
113+
if err != nil {
114+
return nil, NewError(ErrorIO, fmt.Errorf("failed creating trace-file: %v", err))
115+
}
116+
tracer, err := tracers.DefaultDirectory.New(ctx.String(TraceTracerFlag.Name), nil, config)
117+
if err != nil {
118+
return nil, NewError(ErrorConfig, fmt.Errorf("failed instantiating tracer: %w", err))
119+
}
120+
return &traceWriter{tracer, traceFile}, nil
134121
}
135122
}
136123
// We need to load three things: alloc, env and transactions. May be either in
@@ -169,9 +156,7 @@ func Transition(ctx *cli.Context) error {
169156
}
170157
prestate.Env = *inputData.Env
171158

172-
vmConfig := vm.Config{
173-
Tracer: tracer,
174-
}
159+
vmConfig := vm.Config{}
175160
// Construct the chainconfig
176161
var chainConfig *params.ChainConfig
177162
if cConf, extraEips, err := tests.GetChainConfig(ctx.String(ForknameFlag.Name)); err != nil {

‎cmd/evm/main.go

+6-2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ import (
2626
"github.com/ethereum/go-ethereum/internal/debug"
2727
"github.com/ethereum/go-ethereum/internal/flags"
2828
"github.com/urfave/cli/v2"
29+
30+
// Force-load the tracer engines to trigger registration
31+
_ "github.com/ethereum/go-ethereum/eth/tracers/js"
32+
_ "github.com/ethereum/go-ethereum/eth/tracers/native"
2933
)
3034

3135
var (
@@ -143,10 +147,10 @@ var stateTransitionCommand = &cli.Command{
143147
Action: t8ntool.Transition,
144148
Flags: []cli.Flag{
145149
t8ntool.TraceFlag,
146-
t8ntool.TraceDisableMemoryFlag,
150+
t8ntool.TraceTracerFlag,
151+
t8ntool.TraceTracerConfigFlag,
147152
t8ntool.TraceEnableMemoryFlag,
148153
t8ntool.TraceDisableStackFlag,
149-
t8ntool.TraceDisableReturnDataFlag,
150154
t8ntool.TraceEnableReturnDataFlag,
151155
t8ntool.OutputBasedir,
152156
t8ntool.OutputAllocFlag,

0 commit comments

Comments
 (0)