mirror of https://github.com/ethereum/go-ethereum
core/trie: remove trie tracer (#26665)
This PR contains a small portion of the full pbss PR, namely
Remove the tracer from trie (and comitter), and instead using an accessList.
Related changes to the Nodeset.
---------
Co-authored-by: Gary Rong <garyrong0905@gmail.com>
pull/26658/head
Martin Holst Swende
2 years ago
committed by
GitHub
parent
15e5e6176b
commit
7c749c947a
@ -1,304 +0,0 @@ |
||||
// 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 ( |
||||
"bytes" |
||||
"testing" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/core/rawdb" |
||||
) |
||||
|
||||
// Tests if the trie diffs are tracked correctly.
|
||||
func TestTrieTracer(t *testing.T) { |
||||
db := NewDatabase(rawdb.NewMemoryDatabase()) |
||||
trie := NewEmpty(db) |
||||
trie.tracer = newTracer() |
||||
|
||||
// Insert a batch of entries, all the nodes should be marked as inserted
|
||||
vals := []struct{ k, v string }{ |
||||
{"do", "verb"}, |
||||
{"ether", "wookiedoo"}, |
||||
{"horse", "stallion"}, |
||||
{"shaman", "horse"}, |
||||
{"doge", "coin"}, |
||||
{"dog", "puppy"}, |
||||
{"somethingveryoddindeedthis is", "myothernodedata"}, |
||||
} |
||||
for _, val := range vals { |
||||
trie.Update([]byte(val.k), []byte(val.v)) |
||||
} |
||||
trie.Hash() |
||||
|
||||
seen := make(map[string]struct{}) |
||||
it := trie.NodeIterator(nil) |
||||
for it.Next(true) { |
||||
if it.Leaf() { |
||||
continue |
||||
} |
||||
seen[string(it.Path())] = struct{}{} |
||||
} |
||||
inserted := trie.tracer.insertList() |
||||
if len(inserted) != len(seen) { |
||||
t.Fatalf("Unexpected inserted node tracked want %d got %d", len(seen), len(inserted)) |
||||
} |
||||
for _, k := range inserted { |
||||
_, ok := seen[string(k)] |
||||
if !ok { |
||||
t.Fatalf("Unexpected inserted node") |
||||
} |
||||
} |
||||
deleted := trie.tracer.deleteList() |
||||
if len(deleted) != 0 { |
||||
t.Fatalf("Unexpected deleted node tracked %d", len(deleted)) |
||||
} |
||||
|
||||
// Commit the changes and re-create with new root
|
||||
root, nodes := trie.Commit(false) |
||||
if err := db.Update(NewWithNodeSet(nodes)); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
|
||||
// Delete all the elements, check deletion set
|
||||
for _, val := range vals { |
||||
trie.Delete([]byte(val.k)) |
||||
} |
||||
trie.Hash() |
||||
|
||||
inserted = trie.tracer.insertList() |
||||
if len(inserted) != 0 { |
||||
t.Fatalf("Unexpected inserted node tracked %d", len(inserted)) |
||||
} |
||||
deleted = trie.tracer.deleteList() |
||||
if len(deleted) != len(seen) { |
||||
t.Fatalf("Unexpected deleted node tracked want %d got %d", len(seen), len(deleted)) |
||||
} |
||||
for _, k := range deleted { |
||||
_, ok := seen[string(k)] |
||||
if !ok { |
||||
t.Fatalf("Unexpected inserted node") |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestTrieTracerNoop(t *testing.T) { |
||||
trie := NewEmpty(NewDatabase(rawdb.NewMemoryDatabase())) |
||||
trie.tracer = newTracer() |
||||
|
||||
// Insert a batch of entries, all the nodes should be marked as inserted
|
||||
vals := []struct{ k, v string }{ |
||||
{"do", "verb"}, |
||||
{"ether", "wookiedoo"}, |
||||
{"horse", "stallion"}, |
||||
{"shaman", "horse"}, |
||||
{"doge", "coin"}, |
||||
{"dog", "puppy"}, |
||||
{"somethingveryoddindeedthis is", "myothernodedata"}, |
||||
} |
||||
for _, val := range vals { |
||||
trie.Update([]byte(val.k), []byte(val.v)) |
||||
} |
||||
for _, val := range vals { |
||||
trie.Delete([]byte(val.k)) |
||||
} |
||||
if len(trie.tracer.insertList()) != 0 { |
||||
t.Fatalf("Unexpected inserted node tracked %d", len(trie.tracer.insertList())) |
||||
} |
||||
if len(trie.tracer.deleteList()) != 0 { |
||||
t.Fatalf("Unexpected deleted node tracked %d", len(trie.tracer.deleteList())) |
||||
} |
||||
} |
||||
|
||||
func TestTrieTracePrevValue(t *testing.T) { |
||||
db := NewDatabase(rawdb.NewMemoryDatabase()) |
||||
trie := NewEmpty(db) |
||||
trie.tracer = newTracer() |
||||
|
||||
paths, blobs := trie.tracer.prevList() |
||||
if len(paths) != 0 || len(blobs) != 0 { |
||||
t.Fatalf("Nothing should be tracked") |
||||
} |
||||
// Insert a batch of entries, all the nodes should be marked as inserted
|
||||
vals := []struct{ k, v string }{ |
||||
{"do", "verb"}, |
||||
{"ether", "wookiedoo"}, |
||||
{"horse", "stallion"}, |
||||
{"shaman", "horse"}, |
||||
{"doge", "coin"}, |
||||
{"dog", "puppy"}, |
||||
{"somethingveryoddindeedthis is", "myothernodedata"}, |
||||
} |
||||
for _, val := range vals { |
||||
trie.Update([]byte(val.k), []byte(val.v)) |
||||
} |
||||
paths, blobs = trie.tracer.prevList() |
||||
if len(paths) != 0 || len(blobs) != 0 { |
||||
t.Fatalf("Nothing should be tracked") |
||||
} |
||||
|
||||
// Commit the changes and re-create with new root
|
||||
root, nodes := trie.Commit(false) |
||||
if err := db.Update(NewWithNodeSet(nodes)); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
trie.resolveAndTrack(root.Bytes(), nil) |
||||
|
||||
// Load all nodes in trie
|
||||
for _, val := range vals { |
||||
trie.TryGet([]byte(val.k)) |
||||
} |
||||
|
||||
// Ensure all nodes are tracked by tracer with correct prev-values
|
||||
iter := trie.NodeIterator(nil) |
||||
seen := make(map[string][]byte) |
||||
for iter.Next(true) { |
||||
// Embedded nodes are ignored since they are not present in
|
||||
// database.
|
||||
if iter.Hash() == (common.Hash{}) { |
||||
continue |
||||
} |
||||
seen[string(iter.Path())] = common.CopyBytes(iter.NodeBlob()) |
||||
} |
||||
|
||||
paths, blobs = trie.tracer.prevList() |
||||
if len(paths) != len(seen) || len(blobs) != len(seen) { |
||||
t.Fatalf("Unexpected tracked values") |
||||
} |
||||
for i, path := range paths { |
||||
blob := blobs[i] |
||||
prev, ok := seen[string(path)] |
||||
if !ok { |
||||
t.Fatalf("Missing node %v", path) |
||||
} |
||||
if !bytes.Equal(blob, prev) { |
||||
t.Fatalf("Unexpected value path: %v, want: %v, got: %v", path, prev, blob) |
||||
} |
||||
} |
||||
|
||||
// Re-open the trie and iterate the trie, ensure nothing will be tracked.
|
||||
// Iterator will not link any loaded nodes to trie.
|
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
|
||||
iter = trie.NodeIterator(nil) |
||||
for iter.Next(true) { |
||||
} |
||||
paths, blobs = trie.tracer.prevList() |
||||
if len(paths) != 0 || len(blobs) != 0 { |
||||
t.Fatalf("Nothing should be tracked") |
||||
} |
||||
|
||||
// Re-open the trie and generate proof for entries, ensure nothing will
|
||||
// be tracked. Prover will not link any loaded nodes to trie.
|
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
for _, val := range vals { |
||||
trie.Prove([]byte(val.k), 0, rawdb.NewMemoryDatabase()) |
||||
} |
||||
paths, blobs = trie.tracer.prevList() |
||||
if len(paths) != 0 || len(blobs) != 0 { |
||||
t.Fatalf("Nothing should be tracked") |
||||
} |
||||
|
||||
// Delete entries from trie, ensure all previous values are correct.
|
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
trie.resolveAndTrack(root.Bytes(), nil) |
||||
|
||||
for _, val := range vals { |
||||
trie.TryDelete([]byte(val.k)) |
||||
} |
||||
paths, blobs = trie.tracer.prevList() |
||||
if len(paths) != len(seen) || len(blobs) != len(seen) { |
||||
t.Fatalf("Unexpected tracked values") |
||||
} |
||||
for i, path := range paths { |
||||
blob := blobs[i] |
||||
prev, ok := seen[string(path)] |
||||
if !ok { |
||||
t.Fatalf("Missing node %v", path) |
||||
} |
||||
if !bytes.Equal(blob, prev) { |
||||
t.Fatalf("Unexpected value path: %v, want: %v, got: %v", path, prev, blob) |
||||
} |
||||
} |
||||
} |
||||
|
||||
func TestDeleteAll(t *testing.T) { |
||||
db := NewDatabase(rawdb.NewMemoryDatabase()) |
||||
trie := NewEmpty(db) |
||||
trie.tracer = newTracer() |
||||
|
||||
// Insert a batch of entries, all the nodes should be marked as inserted
|
||||
vals := []struct{ k, v string }{ |
||||
{"do", "verb"}, |
||||
{"ether", "wookiedoo"}, |
||||
{"horse", "stallion"}, |
||||
{"shaman", "horse"}, |
||||
{"doge", "coin"}, |
||||
{"dog", "puppy"}, |
||||
{"somethingveryoddindeedthis is", "myothernodedata"}, |
||||
} |
||||
for _, val := range vals { |
||||
trie.Update([]byte(val.k), []byte(val.v)) |
||||
} |
||||
root, set := trie.Commit(false) |
||||
if err := db.Update(NewWithNodeSet(set)); err != nil { |
||||
t.Fatal(err) |
||||
} |
||||
// Delete entries from trie, ensure all values are detected
|
||||
trie, _ = New(TrieID(root), db) |
||||
trie.tracer = newTracer() |
||||
trie.resolveAndTrack(root.Bytes(), nil) |
||||
|
||||
// Iterate all existent nodes
|
||||
var ( |
||||
it = trie.NodeIterator(nil) |
||||
nodes = make(map[string][]byte) |
||||
) |
||||
for it.Next(true) { |
||||
if it.Hash() != (common.Hash{}) { |
||||
nodes[string(it.Path())] = common.CopyBytes(it.NodeBlob()) |
||||
} |
||||
} |
||||
|
||||
// Perform deletion to purge the entire trie
|
||||
for _, val := range vals { |
||||
trie.Delete([]byte(val.k)) |
||||
} |
||||
root, set = trie.Commit(false) |
||||
if root != emptyRoot { |
||||
t.Fatalf("Invalid trie root %v", root) |
||||
} |
||||
for path, blob := range set.deletes { |
||||
prev, ok := nodes[path] |
||||
if !ok { |
||||
t.Fatalf("Extra node deleted %v", []byte(path)) |
||||
} |
||||
if !bytes.Equal(prev, blob) { |
||||
t.Fatalf("Unexpected previous value %v", []byte(path)) |
||||
} |
||||
} |
||||
if len(set.deletes) != len(nodes) { |
||||
t.Fatalf("Unexpected deletion set") |
||||
} |
||||
} |
||||
@ -1,199 +0,0 @@ |
||||
// 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 |
||||
|
||||
// tracer tracks the changes of trie nodes. During the trie operations,
|
||||
// some nodes can be deleted from the trie, while these deleted nodes
|
||||
// won't be captured by trie.Hasher or trie.Committer. Thus, these deleted
|
||||
// nodes won't be removed from the disk at all. Tracer is an auxiliary tool
|
||||
// used to track all insert and delete operations of trie and capture all
|
||||
// deleted nodes eventually.
|
||||
//
|
||||
// The changed nodes can be mainly divided into two categories: the leaf
|
||||
// node and intermediate node. The former is inserted/deleted by callers
|
||||
// while the latter is inserted/deleted in order to follow the rule of trie.
|
||||
// This tool can track all of them no matter the node is embedded in its
|
||||
// parent or not, but valueNode is never tracked.
|
||||
//
|
||||
// Besides, it's also used for recording the original value of the nodes
|
||||
// when they are resolved from the disk. The pre-value of the nodes will
|
||||
// be used to construct reverse-diffs in the future.
|
||||
//
|
||||
// Note tracer is not thread-safe, callers should be responsible for handling
|
||||
// the concurrency issues by themselves.
|
||||
type tracer struct { |
||||
insert map[string]struct{} |
||||
delete map[string]struct{} |
||||
origin map[string][]byte |
||||
} |
||||
|
||||
// newTracer initializes the tracer for capturing trie changes.
|
||||
func newTracer() *tracer { |
||||
return &tracer{ |
||||
insert: make(map[string]struct{}), |
||||
delete: make(map[string]struct{}), |
||||
origin: make(map[string][]byte), |
||||
} |
||||
} |
||||
|
||||
// onRead tracks the newly loaded trie node and caches the rlp-encoded blob internally.
|
||||
// Don't change the value outside of function since it's not deep-copied.
|
||||
func (t *tracer) onRead(path []byte, val []byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
t.origin[string(path)] = val |
||||
} |
||||
|
||||
// onInsert tracks the newly inserted trie node. If it's already in the deletion set
|
||||
// (resurrected node), then just wipe it from the deletion set as the "untouched".
|
||||
func (t *tracer) onInsert(path []byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
if _, present := t.delete[string(path)]; present { |
||||
delete(t.delete, string(path)) |
||||
return |
||||
} |
||||
t.insert[string(path)] = struct{}{} |
||||
} |
||||
|
||||
// onDelete tracks the newly deleted trie node. If it's already
|
||||
// in the addition set, then just wipe it from the addition set
|
||||
// as it's untouched.
|
||||
func (t *tracer) onDelete(path []byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
if _, present := t.insert[string(path)]; present { |
||||
delete(t.insert, string(path)) |
||||
return |
||||
} |
||||
t.delete[string(path)] = struct{}{} |
||||
} |
||||
|
||||
// insertList returns the tracked inserted trie nodes in list format.
|
||||
func (t *tracer) insertList() [][]byte { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return nil |
||||
} |
||||
var ret [][]byte |
||||
for path := range t.insert { |
||||
ret = append(ret, []byte(path)) |
||||
} |
||||
return ret |
||||
} |
||||
|
||||
// deleteList returns the tracked deleted trie nodes in list format.
|
||||
func (t *tracer) deleteList() [][]byte { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return nil |
||||
} |
||||
var ret [][]byte |
||||
for path := range t.delete { |
||||
ret = append(ret, []byte(path)) |
||||
} |
||||
return ret |
||||
} |
||||
|
||||
// prevList returns the tracked node blobs in list format.
|
||||
func (t *tracer) prevList() ([][]byte, [][]byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return nil, nil |
||||
} |
||||
var ( |
||||
paths [][]byte |
||||
blobs [][]byte |
||||
) |
||||
for path, blob := range t.origin { |
||||
paths = append(paths, []byte(path)) |
||||
blobs = append(blobs, blob) |
||||
} |
||||
return paths, blobs |
||||
} |
||||
|
||||
// getPrev returns the cached original value of the specified node.
|
||||
func (t *tracer) getPrev(path []byte) []byte { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return nil |
||||
} |
||||
return t.origin[string(path)] |
||||
} |
||||
|
||||
// reset clears the content tracked by tracer.
|
||||
func (t *tracer) reset() { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
t.insert = make(map[string]struct{}) |
||||
t.delete = make(map[string]struct{}) |
||||
t.origin = make(map[string][]byte) |
||||
} |
||||
|
||||
// copy returns a deep copied tracer instance.
|
||||
func (t *tracer) copy() *tracer { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return nil |
||||
} |
||||
var ( |
||||
insert = make(map[string]struct{}) |
||||
delete = make(map[string]struct{}) |
||||
origin = make(map[string][]byte) |
||||
) |
||||
for key := range t.insert { |
||||
insert[key] = struct{}{} |
||||
} |
||||
for key := range t.delete { |
||||
delete[key] = struct{}{} |
||||
} |
||||
for key, val := range t.origin { |
||||
origin[key] = val |
||||
} |
||||
return &tracer{ |
||||
insert: insert, |
||||
delete: delete, |
||||
origin: origin, |
||||
} |
||||
} |
||||
|
||||
// markDeletions puts all tracked deletions into the provided nodeset.
|
||||
func (t *tracer) markDeletions(set *NodeSet) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
for _, path := range t.deleteList() { |
||||
// There are a few possibilities for this scenario(the node is deleted
|
||||
// but not present in database previously), for example the node was
|
||||
// embedded in the parent and now deleted from the trie. In this case
|
||||
// it's noop from database's perspective.
|
||||
val := t.getPrev(path) |
||||
if len(val) == 0 { |
||||
continue |
||||
} |
||||
set.markDeleted(path, val) |
||||
} |
||||
} |
||||
Loading…
Reference in new issue