123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439 |
- // Copyright 2020 The go-ethereum Authors
- // This file is part of go-ethereum.
- //
- // go-ethereum is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // go-ethereum 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 General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
- package main
- import (
- "bytes"
- "errors"
- "time"
- "github.com/ethereum/go-ethereum/cmd/utils"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/core/rawdb"
- "github.com/ethereum/go-ethereum/core/state"
- "github.com/ethereum/go-ethereum/core/state/pruner"
- "github.com/ethereum/go-ethereum/core/state/snapshot"
- "github.com/ethereum/go-ethereum/crypto"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/rlp"
- "github.com/ethereum/go-ethereum/trie"
- cli "gopkg.in/urfave/cli.v1"
- )
- var (
- // emptyRoot is the known root hash of an empty trie.
- emptyRoot = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
- // emptyCode is the known hash of the empty EVM bytecode.
- emptyCode = crypto.Keccak256(nil)
- )
- var (
- snapshotCommand = cli.Command{
- Name: "snapshot",
- Usage: "A set of commands based on the snapshot",
- Category: "MISCELLANEOUS COMMANDS",
- Description: "",
- Subcommands: []cli.Command{
- {
- Name: "prune-state",
- Usage: "Prune stale ethereum state data based on the snapshot",
- ArgsUsage: "<root>",
- Action: utils.MigrateFlags(pruneState),
- Category: "MISCELLANEOUS COMMANDS",
- Flags: []cli.Flag{
- utils.DataDirFlag,
- utils.AncientFlag,
- utils.RopstenFlag,
- utils.RinkebyFlag,
- utils.GoerliFlag,
- utils.CacheTrieJournalFlag,
- utils.BloomFilterSizeFlag,
- },
- Description: `
- geth snapshot prune-state <state-root>
- will prune historical state data with the help of the state snapshot.
- All trie nodes and contract codes that do not belong to the specified
- version state will be deleted from the database. After pruning, only
- two version states are available: genesis and the specific one.
- The default pruning target is the HEAD-127 state.
- WARNING: It's necessary to delete the trie clean cache after the pruning.
- If you specify another directory for the trie clean cache via "--cache.trie.journal"
- during the use of Geth, please also specify it here for correct deletion. Otherwise
- the trie clean cache with default directory will be deleted.
- `,
- },
- {
- Name: "verify-state",
- Usage: "Recalculate state hash based on the snapshot for verification",
- ArgsUsage: "<root>",
- Action: utils.MigrateFlags(verifyState),
- Category: "MISCELLANEOUS COMMANDS",
- Flags: []cli.Flag{
- utils.DataDirFlag,
- utils.AncientFlag,
- utils.RopstenFlag,
- utils.RinkebyFlag,
- utils.GoerliFlag,
- },
- Description: `
- geth snapshot verify-state <state-root>
- will traverse the whole accounts and storages set based on the specified
- snapshot and recalculate the root hash of state for verification.
- In other words, this command does the snapshot to trie conversion.
- `,
- },
- {
- Name: "traverse-state",
- Usage: "Traverse the state with given root hash for verification",
- ArgsUsage: "<root>",
- Action: utils.MigrateFlags(traverseState),
- Category: "MISCELLANEOUS COMMANDS",
- Flags: []cli.Flag{
- utils.DataDirFlag,
- utils.AncientFlag,
- utils.RopstenFlag,
- utils.RinkebyFlag,
- utils.GoerliFlag,
- },
- Description: `
- geth snapshot traverse-state <state-root>
- will traverse the whole state from the given state root and will abort if any
- referenced trie node or contract code is missing. This command can be used for
- state integrity verification. The default checking target is the HEAD state.
- It's also usable without snapshot enabled.
- `,
- },
- {
- Name: "traverse-rawstate",
- Usage: "Traverse the state with given root hash for verification",
- ArgsUsage: "<root>",
- Action: utils.MigrateFlags(traverseRawState),
- Category: "MISCELLANEOUS COMMANDS",
- Flags: []cli.Flag{
- utils.DataDirFlag,
- utils.AncientFlag,
- utils.RopstenFlag,
- utils.RinkebyFlag,
- utils.GoerliFlag,
- },
- Description: `
- geth snapshot traverse-rawstate <state-root>
- will traverse the whole state from the given root and will abort if any referenced
- trie node or contract code is missing. This command can be used for state integrity
- verification. The default checking target is the HEAD state. It's basically identical
- to traverse-state, but the check granularity is smaller.
- It's also usable without snapshot enabled.
- `,
- },
- },
- }
- )
- func pruneState(ctx *cli.Context) error {
- stack, config := makeConfigNode(ctx)
- defer stack.Close()
- chaindb := utils.MakeChainDatabase(ctx, stack, false)
- // Quorum
- if config.Eth.Genesis.Config.IsQuorum {
- log.Error("Can not prune state when using GoQuorum as this has an impact on private state")
- return errors.New("prune-state is not available when IsQuorum is enabled")
- }
- pruner, err := pruner.NewPruner(chaindb, stack.ResolvePath(""), stack.ResolvePath(config.Eth.TrieCleanCacheJournal), ctx.GlobalUint64(utils.BloomFilterSizeFlag.Name))
- if err != nil {
- log.Error("Failed to open snapshot tree", "err", err)
- return err
- }
- if ctx.NArg() > 1 {
- log.Error("Too many arguments given")
- return errors.New("too many arguments")
- }
- var targetRoot common.Hash
- if ctx.NArg() == 1 {
- targetRoot, err = parseRoot(ctx.Args()[0])
- if err != nil {
- log.Error("Failed to resolve state root", "err", err)
- return err
- }
- }
- if err = pruner.Prune(targetRoot); err != nil {
- log.Error("Failed to prune state", "err", err)
- return err
- }
- return nil
- }
- func verifyState(ctx *cli.Context) error {
- stack, _ := makeConfigNode(ctx)
- defer stack.Close()
- chaindb := utils.MakeChainDatabase(ctx, stack, true)
- headBlock := rawdb.ReadHeadBlock(chaindb)
- if headBlock == nil {
- log.Error("Failed to load head block")
- return errors.New("no head block")
- }
- snaptree, err := snapshot.New(chaindb, trie.NewDatabase(chaindb), 256, headBlock.Root(), false, false, false)
- if err != nil {
- log.Error("Failed to open snapshot tree", "err", err)
- return err
- }
- if ctx.NArg() > 1 {
- log.Error("Too many arguments given")
- return errors.New("too many arguments")
- }
- var root = headBlock.Root()
- if ctx.NArg() == 1 {
- root, err = parseRoot(ctx.Args()[0])
- if err != nil {
- log.Error("Failed to resolve state root", "err", err)
- return err
- }
- }
- if err := snaptree.Verify(root); err != nil {
- log.Error("Failed to verify state", "root", root, "err", err)
- return err
- }
- log.Info("Verified the state", "root", root)
- return nil
- }
- // traverseState is a helper function used for pruning verification.
- // Basically it just iterates the trie, ensure all nodes and associated
- // contract codes are present.
- func traverseState(ctx *cli.Context) error {
- stack, _ := makeConfigNode(ctx)
- defer stack.Close()
- chaindb := utils.MakeChainDatabase(ctx, stack, true)
- headBlock := rawdb.ReadHeadBlock(chaindb)
- if headBlock == nil {
- log.Error("Failed to load head block")
- return errors.New("no head block")
- }
- if ctx.NArg() > 1 {
- log.Error("Too many arguments given")
- return errors.New("too many arguments")
- }
- var (
- root common.Hash
- err error
- )
- if ctx.NArg() == 1 {
- root, err = parseRoot(ctx.Args()[0])
- if err != nil {
- log.Error("Failed to resolve state root", "err", err)
- return err
- }
- log.Info("Start traversing the state", "root", root)
- } else {
- root = headBlock.Root()
- log.Info("Start traversing the state", "root", root, "number", headBlock.NumberU64())
- }
- triedb := trie.NewDatabase(chaindb)
- t, err := trie.NewSecure(root, triedb)
- if err != nil {
- log.Error("Failed to open trie", "root", root, "err", err)
- return err
- }
- var (
- accounts int
- slots int
- codes int
- lastReport time.Time
- start = time.Now()
- )
- accIter := trie.NewIterator(t.NodeIterator(nil))
- for accIter.Next() {
- accounts += 1
- var acc state.Account
- if err := rlp.DecodeBytes(accIter.Value, &acc); err != nil {
- log.Error("Invalid account encountered during traversal", "err", err)
- return err
- }
- if acc.Root != emptyRoot {
- storageTrie, err := trie.NewSecure(acc.Root, triedb)
- if err != nil {
- log.Error("Failed to open storage trie", "root", acc.Root, "err", err)
- return err
- }
- storageIter := trie.NewIterator(storageTrie.NodeIterator(nil))
- for storageIter.Next() {
- slots += 1
- }
- if storageIter.Err != nil {
- log.Error("Failed to traverse storage trie", "root", acc.Root, "err", storageIter.Err)
- return storageIter.Err
- }
- }
- if !bytes.Equal(acc.CodeHash, emptyCode) {
- code := rawdb.ReadCode(chaindb, common.BytesToHash(acc.CodeHash))
- if len(code) == 0 {
- log.Error("Code is missing", "hash", common.BytesToHash(acc.CodeHash))
- return errors.New("missing code")
- }
- codes += 1
- }
- if time.Since(lastReport) > time.Second*8 {
- log.Info("Traversing state", "accounts", accounts, "slots", slots, "codes", codes, "elapsed", common.PrettyDuration(time.Since(start)))
- lastReport = time.Now()
- }
- }
- if accIter.Err != nil {
- log.Error("Failed to traverse state trie", "root", root, "err", accIter.Err)
- return accIter.Err
- }
- log.Info("State is complete", "accounts", accounts, "slots", slots, "codes", codes, "elapsed", common.PrettyDuration(time.Since(start)))
- return nil
- }
- // traverseRawState is a helper function used for pruning verification.
- // Basically it just iterates the trie, ensure all nodes and associated
- // contract codes are present. It's basically identical to traverseState
- // but it will check each trie node.
- func traverseRawState(ctx *cli.Context) error {
- stack, _ := makeConfigNode(ctx)
- defer stack.Close()
- chaindb := utils.MakeChainDatabase(ctx, stack, true)
- headBlock := rawdb.ReadHeadBlock(chaindb)
- if headBlock == nil {
- log.Error("Failed to load head block")
- return errors.New("no head block")
- }
- if ctx.NArg() > 1 {
- log.Error("Too many arguments given")
- return errors.New("too many arguments")
- }
- var (
- root common.Hash
- err error
- )
- if ctx.NArg() == 1 {
- root, err = parseRoot(ctx.Args()[0])
- if err != nil {
- log.Error("Failed to resolve state root", "err", err)
- return err
- }
- log.Info("Start traversing the state", "root", root)
- } else {
- root = headBlock.Root()
- log.Info("Start traversing the state", "root", root, "number", headBlock.NumberU64())
- }
- triedb := trie.NewDatabase(chaindb)
- t, err := trie.NewSecure(root, triedb)
- if err != nil {
- log.Error("Failed to open trie", "root", root, "err", err)
- return err
- }
- var (
- nodes int
- accounts int
- slots int
- codes int
- lastReport time.Time
- start = time.Now()
- )
- accIter := t.NodeIterator(nil)
- for accIter.Next(true) {
- nodes += 1
- node := accIter.Hash()
- if node != (common.Hash{}) {
- // Check the present for non-empty hash node(embedded node doesn't
- // have their own hash).
- blob := rawdb.ReadTrieNode(chaindb, node)
- if len(blob) == 0 {
- log.Error("Missing trie node(account)", "hash", node)
- return errors.New("missing account")
- }
- }
- // If it's a leaf node, yes we are touching an account,
- // dig into the storage trie further.
- if accIter.Leaf() {
- accounts += 1
- var acc state.Account
- if err := rlp.DecodeBytes(accIter.LeafBlob(), &acc); err != nil {
- log.Error("Invalid account encountered during traversal", "err", err)
- return errors.New("invalid account")
- }
- if acc.Root != emptyRoot {
- storageTrie, err := trie.NewSecure(acc.Root, triedb)
- if err != nil {
- log.Error("Failed to open storage trie", "root", acc.Root, "err", err)
- return errors.New("missing storage trie")
- }
- storageIter := storageTrie.NodeIterator(nil)
- for storageIter.Next(true) {
- nodes += 1
- node := storageIter.Hash()
- // Check the present for non-empty hash node(embedded node doesn't
- // have their own hash).
- if node != (common.Hash{}) {
- blob := rawdb.ReadTrieNode(chaindb, node)
- if len(blob) == 0 {
- log.Error("Missing trie node(storage)", "hash", node)
- return errors.New("missing storage")
- }
- }
- // Bump the counter if it's leaf node.
- if storageIter.Leaf() {
- slots += 1
- }
- }
- if storageIter.Error() != nil {
- log.Error("Failed to traverse storage trie", "root", acc.Root, "err", storageIter.Error())
- return storageIter.Error()
- }
- }
- if !bytes.Equal(acc.CodeHash, emptyCode) {
- code := rawdb.ReadCode(chaindb, common.BytesToHash(acc.CodeHash))
- if len(code) == 0 {
- log.Error("Code is missing", "account", common.BytesToHash(accIter.LeafKey()))
- return errors.New("missing code")
- }
- codes += 1
- }
- if time.Since(lastReport) > time.Second*8 {
- log.Info("Traversing state", "nodes", nodes, "accounts", accounts, "slots", slots, "codes", codes, "elapsed", common.PrettyDuration(time.Since(start)))
- lastReport = time.Now()
- }
- }
- }
- if accIter.Error() != nil {
- log.Error("Failed to traverse state trie", "root", root, "err", accIter.Error())
- return accIter.Error()
- }
- log.Info("State is complete", "nodes", nodes, "accounts", accounts, "slots", slots, "codes", codes, "elapsed", common.PrettyDuration(time.Since(start)))
- return nil
- }
- func parseRoot(input string) (common.Hash, error) {
- var h common.Hash
- if err := h.UnmarshalText([]byte(input)); err != nil {
- return h, err
- }
- return h, nil
- }
|