trie: add inspector

Co-authored-by: Fynn <zcheng1004@gmail.com>
Co-authored-by: lightclient <lightclient@protonmail.com>
Co-authored-by: MariusVanDerWijden <m.vanderwijden@live.de>

Author: 3 people

cmd/geth/dbcmd.go

@@ -19,9 +19,11 @@ package main
 import (
 	"bytes"
 	"fmt"
+	"math"
 	"os"
 	"os/signal"
 	"path/filepath"
+	"runtime"
 	"slices"
 	"strconv"
 	"strings"
@@ -75,6 +77,7 @@ Remove blockchain and state databases`,
 			dbCompactCmd,
 			dbGetCmd,
 			dbDeleteCmd,
+			dbInspectTrieCmd,
 			dbPutCmd,
 			dbGetSlotsCmd,
 			dbDumpFreezerIndex,
@@ -93,6 +96,18 @@ Remove blockchain and state databases`,
 		Usage:       "Inspect the storage size for each type of data in the database",
 		Description: `This commands iterates the entire database. If the optional 'prefix' and 'start' arguments are provided, then the iteration is limited to the given subset of data.`,
 	}
+	dbInspectTrieCmd = &cli.Command{
+		Action:    inspectTrie,
+		Name:      "inspect-trie",
+		ArgsUsage: "<blocknum> <jobnum>",
+		Flags: []cli.Flag{
+			utils.DataDirFlag,
+		},
+		Usage: "Print detailed trie information about the structure of account trie and storage tries.",
+		Description: `This commands iterates the entrie trie-backed state. If the 'blocknum' is not specified, 
+the latest block number will be used by default. 'jobnum' indicates the number of coroutines concurrently traversing
+the account and storage trie.`,
+	}
 	dbCheckStateContentCmd = &cli.Command{
 		Action:    checkStateContent,
 		Name:      "check-state-content",
@@ -386,6 +401,87 @@ func checkStateContent(ctx *cli.Context) error {
 	return nil
 }
 
+func inspectTrie(ctx *cli.Context) error {
+	if ctx.NArg() > 2 {
+		return fmt.Errorf("excessive number of arguments: %v", ctx.Command.ArgsUsage)
+	}
+
+	var (
+		blockNumber  uint64
+		trieRootHash common.Hash
+		jobnum       uint64
+	)
+
+	stack, _ := makeConfigNode(ctx)
+	defer stack.Close()
+
+	db := utils.MakeChainDatabase(ctx, stack, false)
+	defer db.Close()
+
+	var headerBlockHash common.Hash
+	switch {
+	case ctx.NArg() == 0 || ctx.Args().Get(0) == "latest":
+		headerHash := rawdb.ReadHeadHeaderHash(db)
+		n, ok := rawdb.ReadHeaderNumber(db, headerHash)
+		if !ok {
+			return fmt.Errorf("could not load head block hash")
+		}
+		blockNumber = n
+	case ctx.Args().Get(0) == "snapshot":
+		trieRootHash = rawdb.ReadSnapshotRoot(db)
+		blockNumber = math.MaxUint64
+	default:
+		var err error
+		blockNumber, err = strconv.ParseUint(ctx.Args().Get(0), 10, 64)
+		if err != nil {
+			return fmt.Errorf("failed to parse blocknum, Args[0]: %v, err: %v", ctx.Args().Get(0), err)
+		}
+	}
+
+	// Configure number of threads.
+	if ctx.NArg() <= 1 {
+		jobnum = uint64(runtime.NumCPU())
+	} else {
+		var err error
+		jobnum, err = strconv.ParseUint(ctx.Args().Get(1), 10, 64)
+		if err != nil {
+			return fmt.Errorf("failed to parse jobnum, Args[1]: %v, err: %v", ctx.Args().Get(1), err)
+		}
+	}
+
+	// Load head block number based on canonical hash, if applicable.
+	if blockNumber != math.MaxUint64 {
+		headerBlockHash = rawdb.ReadCanonicalHash(db, blockNumber)
+		if headerBlockHash == (common.Hash{}) {
+			return fmt.Errorf("canonical hash for block %d not found", blockNumber)
+		}
+		blockHeader := rawdb.ReadHeader(db, headerBlockHash, blockNumber)
+		trieRootHash = blockHeader.Root
+	}
+
+	if (trieRootHash == common.Hash{}) {
+		log.Error("Empty root hash")
+	}
+
+	log.Debug("Inspecting trie", "root", trieRootHash, "block", blockNumber)
+
+	triedb := utils.MakeTrieDatabase(ctx, stack, db, false, true, false)
+	defer triedb.Close()
+
+	theTrie, err := trie.New(trie.TrieID(trieRootHash), triedb)
+	if err != nil {
+		fmt.Printf("fail to new trie tree, err: %v, rootHash: %v\n", err, trieRootHash.String())
+		return err
+	}
+	inspector, err := trie.NewInspector(theTrie, triedb, trieRootHash, blockNumber, jobnum)
+	if err != nil {
+		return err
+	}
+	inspector.Run()
+	inspector.DisplayResult()
+	return nil
+}
+
 func showDBStats(db ethdb.KeyValueStater) {
 	stats, err := db.Stat()
 	if err != nil {