mirror of https://github.com/ethereum/go-ethereum
trie, les, tests, core: implement trie tracer (#24403)
Trie tracer is an auxiliary tool to capture all deleted nodes which can't be captured by trie.Committer. The deleted nodes can be removed from the disk later.pull/24648/head
rjl493456442
3 years ago
committed by
GitHub
parent
127dc5982e
commit
da16d089c0
@ -0,0 +1,122 @@ |
||||
// 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 ( |
||||
"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, _ := New(common.Hash{}, 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
|
||||
trie.Commit(nil) |
||||
|
||||
// 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) { |
||||
db := NewDatabase(rawdb.NewMemoryDatabase()) |
||||
trie, _ := New(common.Hash{}, 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)) |
||||
} |
||||
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())) |
||||
} |
||||
} |
||||
@ -0,0 +1,133 @@ |
||||
// 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.
|
||||
//
|
||||
// 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{} |
||||
} |
||||
|
||||
// newTracer initializes trie node diff tracer.
|
||||
func newTracer() *tracer { |
||||
return &tracer{ |
||||
insert: make(map[string]struct{}), |
||||
delete: make(map[string]struct{}), |
||||
} |
||||
} |
||||
|
||||
// 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 it's untouched.
|
||||
func (t *tracer) onInsert(key []byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
if _, present := t.delete[string(key)]; present { |
||||
delete(t.delete, string(key)) |
||||
return |
||||
} |
||||
t.insert[string(key)] = 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(key []byte) { |
||||
// Tracer isn't used right now, remove this check later.
|
||||
if t == nil { |
||||
return |
||||
} |
||||
if _, present := t.insert[string(key)]; present { |
||||
delete(t.insert, string(key)) |
||||
return |
||||
} |
||||
t.delete[string(key)] = 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 key := range t.insert { |
||||
ret = append(ret, []byte(key)) |
||||
} |
||||
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 key := range t.delete { |
||||
ret = append(ret, []byte(key)) |
||||
} |
||||
return ret |
||||
} |
||||
|
||||
// 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{}) |
||||
} |
||||
|
||||
// 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{}) |
||||
) |
||||
for key := range t.insert { |
||||
insert[key] = struct{}{} |
||||
} |
||||
for key := range t.delete { |
||||
delete[key] = struct{}{} |
||||
} |
||||
return &tracer{ |
||||
insert: insert, |
||||
delete: delete, |
||||
} |
||||
} |
||||
Loading…
Reference in new issue