mirror of https://github.com/ethereum/go-ethereum
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
288 lines
8.1 KiB
288 lines
8.1 KiB
// Copyright 2021 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 native
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"math/big"
|
|
"sync/atomic"
|
|
|
|
"github.com/ethereum/go-ethereum/accounts/abi"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/tracing"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
"github.com/ethereum/go-ethereum/eth/tracers"
|
|
)
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type callFrame -field-override callFrameMarshaling -out gen_callframe_json.go
|
|
|
|
func init() {
|
|
tracers.DefaultDirectory.Register("callTracer", newCallTracer, false)
|
|
}
|
|
|
|
type callLog struct {
|
|
Address common.Address `json:"address"`
|
|
Topics []common.Hash `json:"topics"`
|
|
Data hexutil.Bytes `json:"data"`
|
|
// Position of the log relative to subcalls within the same trace
|
|
// See https://github.com/ethereum/go-ethereum/pull/28389 for details
|
|
Position hexutil.Uint `json:"position"`
|
|
}
|
|
|
|
type callFrame struct {
|
|
Type vm.OpCode `json:"-"`
|
|
From common.Address `json:"from"`
|
|
Gas uint64 `json:"gas"`
|
|
GasUsed uint64 `json:"gasUsed"`
|
|
To *common.Address `json:"to,omitempty" rlp:"optional"`
|
|
Input []byte `json:"input" rlp:"optional"`
|
|
Output []byte `json:"output,omitempty" rlp:"optional"`
|
|
Error string `json:"error,omitempty" rlp:"optional"`
|
|
RevertReason string `json:"revertReason,omitempty"`
|
|
Calls []callFrame `json:"calls,omitempty" rlp:"optional"`
|
|
Logs []callLog `json:"logs,omitempty" rlp:"optional"`
|
|
// Placed at end on purpose. The RLP will be decoded to 0 instead of
|
|
// nil if there are non-empty elements after in the struct.
|
|
Value *big.Int `json:"value,omitempty" rlp:"optional"`
|
|
revertedSnapshot bool
|
|
}
|
|
|
|
func (f callFrame) TypeString() string {
|
|
return f.Type.String()
|
|
}
|
|
|
|
func (f callFrame) failed() bool {
|
|
return len(f.Error) > 0 && f.revertedSnapshot
|
|
}
|
|
|
|
func (f *callFrame) processOutput(output []byte, err error, reverted bool) {
|
|
output = common.CopyBytes(output)
|
|
// Clear error if tx wasn't reverted. This happened
|
|
// for pre-homestead contract storage OOG.
|
|
if err != nil && !reverted {
|
|
err = nil
|
|
}
|
|
if err == nil {
|
|
f.Output = output
|
|
return
|
|
}
|
|
f.Error = err.Error()
|
|
f.revertedSnapshot = reverted
|
|
if f.Type == vm.CREATE || f.Type == vm.CREATE2 {
|
|
f.To = nil
|
|
}
|
|
if !errors.Is(err, vm.ErrExecutionReverted) || len(output) == 0 {
|
|
return
|
|
}
|
|
f.Output = output
|
|
if len(output) < 4 {
|
|
return
|
|
}
|
|
if unpacked, err := abi.UnpackRevert(output); err == nil {
|
|
f.RevertReason = unpacked
|
|
}
|
|
}
|
|
|
|
type callFrameMarshaling struct {
|
|
TypeString string `json:"type"`
|
|
Gas hexutil.Uint64
|
|
GasUsed hexutil.Uint64
|
|
Value *hexutil.Big
|
|
Input hexutil.Bytes
|
|
Output hexutil.Bytes
|
|
}
|
|
|
|
type callTracer struct {
|
|
callstack []callFrame
|
|
config callTracerConfig
|
|
gasLimit uint64
|
|
depth int
|
|
interrupt atomic.Bool // Atomic flag to signal execution interruption
|
|
reason error // Textual reason for the interruption
|
|
}
|
|
|
|
type callTracerConfig struct {
|
|
OnlyTopCall bool `json:"onlyTopCall"` // If true, call tracer won't collect any subcalls
|
|
WithLog bool `json:"withLog"` // If true, call tracer will collect event logs
|
|
}
|
|
|
|
// newCallTracer returns a native go tracer which tracks
|
|
// call frames of a tx, and implements vm.EVMLogger.
|
|
func newCallTracer(ctx *tracers.Context, cfg json.RawMessage) (*tracers.Tracer, error) {
|
|
t, err := newCallTracerObject(ctx, cfg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &tracers.Tracer{
|
|
Hooks: &tracing.Hooks{
|
|
OnTxStart: t.OnTxStart,
|
|
OnTxEnd: t.OnTxEnd,
|
|
OnEnter: t.OnEnter,
|
|
OnExit: t.OnExit,
|
|
OnLog: t.OnLog,
|
|
},
|
|
GetResult: t.GetResult,
|
|
Stop: t.Stop,
|
|
}, nil
|
|
}
|
|
|
|
func newCallTracerObject(ctx *tracers.Context, cfg json.RawMessage) (*callTracer, error) {
|
|
var config callTracerConfig
|
|
if cfg != nil {
|
|
if err := json.Unmarshal(cfg, &config); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
// First callframe contains tx context info
|
|
// and is populated on start and end.
|
|
return &callTracer{callstack: make([]callFrame, 0, 1), config: config}, nil
|
|
}
|
|
|
|
// OnEnter is called when EVM enters a new scope (via call, create or selfdestruct).
|
|
func (t *callTracer) OnEnter(depth int, typ byte, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) {
|
|
t.depth = depth
|
|
if t.config.OnlyTopCall && depth > 0 {
|
|
return
|
|
}
|
|
// Skip if tracing was interrupted
|
|
if t.interrupt.Load() {
|
|
return
|
|
}
|
|
|
|
toCopy := to
|
|
call := callFrame{
|
|
Type: vm.OpCode(typ),
|
|
From: from,
|
|
To: &toCopy,
|
|
Input: common.CopyBytes(input),
|
|
Gas: gas,
|
|
Value: value,
|
|
}
|
|
if depth == 0 {
|
|
call.Gas = t.gasLimit
|
|
}
|
|
t.callstack = append(t.callstack, call)
|
|
}
|
|
|
|
// OnExit is called when EVM exits a scope, even if the scope didn't
|
|
// execute any code.
|
|
func (t *callTracer) OnExit(depth int, output []byte, gasUsed uint64, err error, reverted bool) {
|
|
if depth == 0 {
|
|
t.captureEnd(output, gasUsed, err, reverted)
|
|
return
|
|
}
|
|
|
|
t.depth = depth - 1
|
|
if t.config.OnlyTopCall {
|
|
return
|
|
}
|
|
|
|
size := len(t.callstack)
|
|
if size <= 1 {
|
|
return
|
|
}
|
|
// Pop call.
|
|
call := t.callstack[size-1]
|
|
t.callstack = t.callstack[:size-1]
|
|
size -= 1
|
|
|
|
call.GasUsed = gasUsed
|
|
call.processOutput(output, err, reverted)
|
|
// Nest call into parent.
|
|
t.callstack[size-1].Calls = append(t.callstack[size-1].Calls, call)
|
|
}
|
|
|
|
func (t *callTracer) captureEnd(output []byte, gasUsed uint64, err error, reverted bool) {
|
|
if len(t.callstack) != 1 {
|
|
return
|
|
}
|
|
t.callstack[0].processOutput(output, err, reverted)
|
|
}
|
|
|
|
func (t *callTracer) OnTxStart(env *tracing.VMContext, tx *types.Transaction, from common.Address) {
|
|
t.gasLimit = tx.Gas()
|
|
}
|
|
|
|
func (t *callTracer) OnTxEnd(receipt *types.Receipt, err error) {
|
|
// Error happened during tx validation.
|
|
if err != nil {
|
|
return
|
|
}
|
|
t.callstack[0].GasUsed = receipt.GasUsed
|
|
if t.config.WithLog {
|
|
// Logs are not emitted when the call fails
|
|
clearFailedLogs(&t.callstack[0], false)
|
|
}
|
|
}
|
|
|
|
func (t *callTracer) OnLog(log *types.Log) {
|
|
// Only logs need to be captured via opcode processing
|
|
if !t.config.WithLog {
|
|
return
|
|
}
|
|
// Avoid processing nested calls when only caring about top call
|
|
if t.config.OnlyTopCall && t.depth > 0 {
|
|
return
|
|
}
|
|
// Skip if tracing was interrupted
|
|
if t.interrupt.Load() {
|
|
return
|
|
}
|
|
l := callLog{
|
|
Address: log.Address,
|
|
Topics: log.Topics,
|
|
Data: log.Data,
|
|
Position: hexutil.Uint(len(t.callstack[len(t.callstack)-1].Calls)),
|
|
}
|
|
t.callstack[len(t.callstack)-1].Logs = append(t.callstack[len(t.callstack)-1].Logs, l)
|
|
}
|
|
|
|
// GetResult returns the json-encoded nested list of call traces, and any
|
|
// error arising from the encoding or forceful termination (via `Stop`).
|
|
func (t *callTracer) GetResult() (json.RawMessage, error) {
|
|
if len(t.callstack) != 1 {
|
|
return nil, errors.New("incorrect number of top-level calls")
|
|
}
|
|
|
|
res, err := json.Marshal(t.callstack[0])
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return res, t.reason
|
|
}
|
|
|
|
// Stop terminates execution of the tracer at the first opportune moment.
|
|
func (t *callTracer) Stop(err error) {
|
|
t.reason = err
|
|
t.interrupt.Store(true)
|
|
}
|
|
|
|
// clearFailedLogs clears the logs of a callframe and all its children
|
|
// in case of execution failure.
|
|
func clearFailedLogs(cf *callFrame, parentFailed bool) {
|
|
failed := cf.failed() || parentFailed
|
|
// Clear own logs
|
|
if failed {
|
|
cf.Logs = nil
|
|
}
|
|
for i := range cf.Calls {
|
|
clearFailedLogs(&cf.Calls[i], failed)
|
|
}
|
|
}
|
|
|