cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
// Copyright 2022 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 trie
|
|
|
|
|
|
|
|
import (
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
cmd, core/state, eth, tests, trie: improve state reader (#27428)
The state availability is checked during the creation of a state reader.
- In hash-based database, if the specified root node does not exist on disk disk, then
the state reader won't be created and an error will be returned.
- In path-based database, if the specified state layer is not available, then the
state reader won't be created and an error will be returned.
This change also contains a stricter semantics regarding the `Commit` operation: once it has been performed, the trie is no longer usable, and certain operations will return an error.
2023-06-20 22:31:45 +03:00
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
|
|
"github.com/ethereum/go-ethereum/log"
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
)
|
|
|
|
|
2023-04-24 10:38:52 +03:00
|
|
|
// Reader wraps the Node method of a backing trie store.
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
type Reader interface {
|
2023-04-24 10:38:52 +03:00
|
|
|
// Node retrieves the RLP-encoded trie node blob with the provided trie
|
|
|
|
// identifier, node path and the corresponding node hash. No error will
|
|
|
|
// be returned if the node is not found.
|
|
|
|
Node(owner common.Hash, path []byte, hash common.Hash) ([]byte, error)
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
// trieReader is a wrapper of the underlying node reader. It's not safe
|
|
|
|
// for concurrent usage.
|
|
|
|
type trieReader struct {
|
|
|
|
owner common.Hash
|
|
|
|
reader Reader
|
|
|
|
banned map[string]struct{} // Marker to prevent node from being accessed, for tests
|
|
|
|
}
|
|
|
|
|
|
|
|
// newTrieReader initializes the trie reader with the given node reader.
|
cmd, core/state, eth, tests, trie: improve state reader (#27428)
The state availability is checked during the creation of a state reader.
- In hash-based database, if the specified root node does not exist on disk disk, then
the state reader won't be created and an error will be returned.
- In path-based database, if the specified state layer is not available, then the
state reader won't be created and an error will be returned.
This change also contains a stricter semantics regarding the `Commit` operation: once it has been performed, the trie is no longer usable, and certain operations will return an error.
2023-06-20 22:31:45 +03:00
|
|
|
func newTrieReader(stateRoot, owner common.Hash, db *Database) (*trieReader, error) {
|
|
|
|
if stateRoot == (common.Hash{}) || stateRoot == types.EmptyRootHash {
|
|
|
|
if stateRoot == (common.Hash{}) {
|
|
|
|
log.Error("Zero state root hash!")
|
|
|
|
}
|
|
|
|
return &trieReader{owner: owner}, nil
|
|
|
|
}
|
|
|
|
reader, err := db.Reader(stateRoot)
|
|
|
|
if err != nil {
|
|
|
|
return nil, &MissingNodeError{Owner: owner, NodeHash: stateRoot, err: err}
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
}
|
|
|
|
return &trieReader{owner: owner, reader: reader}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// newEmptyReader initializes the pure in-memory reader. All read operations
|
|
|
|
// should be forbidden and returns the MissingNodeError.
|
|
|
|
func newEmptyReader() *trieReader {
|
|
|
|
return &trieReader{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// node retrieves the rlp-encoded trie node with the provided trie node
|
|
|
|
// information. An MissingNodeError will be returned in case the node is
|
|
|
|
// not found or any error is encountered.
|
2023-04-24 10:38:52 +03:00
|
|
|
func (r *trieReader) node(path []byte, hash common.Hash) ([]byte, error) {
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
// Perform the logics in tests for preventing trie node access.
|
|
|
|
if r.banned != nil {
|
|
|
|
if _, ok := r.banned[string(path)]; ok {
|
|
|
|
return nil, &MissingNodeError{Owner: r.owner, NodeHash: hash, Path: path}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if r.reader == nil {
|
|
|
|
return nil, &MissingNodeError{Owner: r.owner, NodeHash: hash, Path: path}
|
|
|
|
}
|
2023-04-24 10:38:52 +03:00
|
|
|
blob, err := r.reader.Node(r.owner, path, hash)
|
cmd, core, eth, les, light: track deleted nodes (#25757)
* cmd, core, eth, les, light: track deleted nodes
* trie: add docs
* trie: address comments
* cmd, core, eth, les, light, trie: trie id
* trie: add tests
* trie, core: updates
* trie: fix imports
* trie: add utility print-method for nodeset
* trie: import err
* trie: fix go vet warnings
Co-authored-by: Martin Holst Swende <martin@swende.se>
2022-09-27 11:01:02 +03:00
|
|
|
if err != nil || len(blob) == 0 {
|
|
|
|
return nil, &MissingNodeError{Owner: r.owner, NodeHash: hash, Path: path, err: err}
|
|
|
|
}
|
|
|
|
return blob, nil
|
|
|
|
}
|