da16d089c0
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.
134 lines
3.9 KiB
Go
134 lines
3.9 KiB
Go
// 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,
|
|
}
|
|
}
|