Merge pull request #459 from OffchainLabs/gas-dimension-tracing

feat: Add Gas dimension tracers

Author: eljobe

core/blockchain.go

@@ -2125,7 +2125,11 @@ func (bc *BlockChain) processBlock(block *types.Block, statedb *state.StateDB, s
 	triedbCommitTimer.Update(statedb.TrieDBCommits)     // Trie database commits are complete, we can mark them
 
 	blockWriteTimer.Update(time.Since(wstart) - max(statedb.AccountCommits, statedb.StorageCommits) /* concurrent */ - statedb.SnapshotCommits - statedb.TrieDBCommits)
-	blockInsertTimer.UpdateSince(start)
+	insertDuration := time.Since(start)
+	blockInsertTimer.Update(insertDuration)
+	if bc.logger != nil && bc.logger.OnBlockEndMetrics != nil {
+		bc.logger.OnBlockEndMetrics(block.NumberU64(), insertDuration)
+	}
 
 	return &blockProcessingResult{usedGas: res.GasUsed, procTime: proctime, status: status}, nil
 }

core/state/statedb.go

@@ -1555,6 +1555,15 @@ func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addre
 	return s.accessList.Contains(addr, slot)
 }
 
+// GetAccessList returns the data of the access list directly for tracers to consume
+// this is necessary because the accessList is not exported from the state package
+func (s *StateDB) GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{}) {
+	accessListCopy := s.accessList.Copy()
+	addresses = accessListCopy.addresses
+	slots = accessListCopy.slots
+	return
+}
+
 // markDelete is invoked when an account is deleted but the deletion is
 // not yet committed. The pending mutation is cached and will be applied
 // all together

core/state/statedb_hooked.go

@@ -373,3 +373,7 @@ func (s *hookedStateDB) GetSelfDestructs() []common.Address {
 func (s *hookedStateDB) GetCurrentTxLogs() []*types.Log {
 	return s.inner.GetCurrentTxLogs()
 }
+
+func (s *hookedStateDB) GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{}) {
+	return s.inner.GetAccessList()
+}

core/tracing/hooks.go

@@ -26,6 +26,7 @@ package tracing
 
 import (
 	"math/big"
+	"time"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -55,6 +56,7 @@ type StateDB interface {
 	GetTransientState(common.Address, common.Hash) common.Hash
 	Exist(common.Address) bool
 	GetRefund() uint64
+	GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{})
 }
 
 // VMContext provides the context for the EVM execution.
@@ -136,6 +138,9 @@ type (
 	// BlockEndHook is called after executing a block.
 	BlockEndHook = func(err error)
 
+	// BlockEndMetricsHook is called after executing a block and calculating the metrics timers
+	BlockEndMetricsHook = func(blockNumber uint64, blockInsertDuration time.Duration)
+
 	// SkippedBlockHook indicates a block was skipped during processing
 	// due to it being known previously. This can happen e.g. when recovering
 	// from a crash.
@@ -210,6 +215,7 @@ type Hooks struct {
 	OnClose             CloseHook
 	OnBlockStart        BlockStartHook
 	OnBlockEnd          BlockEndHook
+	OnBlockEndMetrics   BlockEndMetricsHook
 	OnSkippedBlock      SkippedBlockHook
 	OnGenesisBlock      GenesisBlockHook
 	OnSystemCallStart   OnSystemCallStartHook

core/vm/interface.go

@@ -116,6 +116,8 @@ type StateDB interface {
 	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
 	// even if the feature/fork is not active yet
 	AddSlotToAccessList(addr common.Address, slot common.Hash)
+	// GetAccessList returns the access list
+	GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{})
 
 	// PointCache returns the point cache used in computations
 	PointCache() *utils.PointCache

eth/tracers/live/block_insert_times.go

@@ -0,0 +1,63 @@
+package live
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+	"time"
+
+	"github.com/ethereum/go-ethereum/core/tracing"
+	"github.com/ethereum/go-ethereum/eth/tracers"
+)
+
+type blockInsertTimes struct {
+	Path string `json:"path"`
+}
+
+func init() {
+	tracers.LiveDirectory.Register("blockInsertTimes", newBlockInsertTimes)
+}
+
+type blockInsertTimesConfig struct {
+	Path string `json:"path"` // Path to directory for output
+}
+
+func newBlockInsertTimes(cfg json.RawMessage) (*tracing.Hooks, error) {
+	var config blockInsertTimesConfig
+	if err := json.Unmarshal(cfg, &config); err != nil {
+		return nil, err
+	}
+
+	if config.Path == "" {
+		return nil, fmt.Errorf("gas dimension live tracer path for output is required: %v", config)
+	}
+
+	t := &blockInsertTimes{
+		Path: config.Path,
+	}
+
+	return &tracing.Hooks{
+		OnBlockEndMetrics: t.OnBlockEndMetrics,
+	}, nil
+}
+
+func (t *blockInsertTimes) OnBlockEndMetrics(blockNumber uint64, blockInsertDuration time.Duration) {
+	filename := fmt.Sprintf("%d.json", blockNumber)
+	filepath := filepath.Join(t.Path, filename)
+
+	// Ensure the directory exists
+	if err := os.MkdirAll(t.Path, 0755); err != nil {
+		fmt.Printf("Failed to create directory %s: %v\n", t.Path, err)
+		return
+	}
+
+	// the output is the duration in nanoseconds
+	var outData int64 = blockInsertDuration.Nanoseconds()
+
+	// Write the file
+	if err := os.WriteFile(filepath, []byte(fmt.Sprintf("%d", outData)), 0644); err != nil {
+		fmt.Printf("Failed to write file %s: %v\n", filepath, err)
+		return
+	}
+}