Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merkle db cleanup view creation #1934

Merged
merged 6 commits into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 18 additions & 38 deletions x/merkledb/db.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ func (db *merkleDB) rebuild(ctx context.Context) error {

for it.Next() {
if len(currentOps) >= viewSizeLimit {
view, err := db.newUntrackedView(currentOps, true)
view, err := newTrieView(db, db, ViewChanges{BatchOps: currentOps, ConsumeBytes: true})
if err != nil {
return err
}
Expand All @@ -304,7 +304,7 @@ func (db *merkleDB) rebuild(ctx context.Context) error {
if err := it.Error(); err != nil {
return err
}
view, err := db.newUntrackedView(currentOps, true)
view, err := newTrieView(db, db, ViewChanges{BatchOps: currentOps, ConsumeBytes: true})
if err != nil {
return err
}
Expand All @@ -330,7 +330,7 @@ func (db *merkleDB) CommitChangeProof(ctx context.Context, proof *ChangeProof) e
}
}

view, err := db.newUntrackedView(ops, false)
view, err := newTrieView(db, db, ViewChanges{BatchOps: ops})
if err != nil {
return err
}
Expand Down Expand Up @@ -371,7 +371,7 @@ func (db *merkleDB) CommitRangeProof(ctx context.Context, start maybe.Maybe[[]by
}

// Don't need to lock [view] because nobody else has a reference to it.
view, err := db.newUntrackedView(ops, false)
view, err := newTrieView(db, db, ViewChanges{BatchOps: ops})
if err != nil {
return err
}
Expand Down Expand Up @@ -526,7 +526,7 @@ func (db *merkleDB) getProof(ctx context.Context, key []byte) (*Proof, error) {
return nil, database.ErrClosed
}

view, err := db.newUntrackedView(nil, true)
view, err := newTrieView(db, db, ViewChanges{})
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -696,7 +696,7 @@ func (db *merkleDB) NewView(
return nil, database.ErrClosed
}

newView, err := newTrieView(db, db, db.root.clone(), changes)
newView, err := newTrieView(db, db, changes)
if err != nil {
return nil, err
}
Expand All @@ -709,21 +709,6 @@ func (db *merkleDB) NewView(
return newView, nil
}

// Returns a new view that isn't tracked in [db.childViews].
// For internal use only, namely in methods that create short-lived views.
// Assumes [db.lock] isn't held and [db.commitLock] is read locked.
func (db *merkleDB) newUntrackedView(batchOps []database.BatchOp, consumeBytes bool) (*trieView, error) {
return newTrieView(
db,
db,
db.root.clone(),
ViewChanges{
BatchOps: batchOps,
ConsumeBytes: consumeBytes,
},
)
}

func (db *merkleDB) Has(k []byte) (bool, error) {
db.lock.RLock()
defer db.lock.RUnlock()
Expand Down Expand Up @@ -853,13 +838,7 @@ func (db *merkleDB) PutContext(ctx context.Context, k, v []byte) error {
return database.ErrClosed
}

view, err := db.newUntrackedView(
[]database.BatchOp{{
Key: k,
Value: v,
}},
false,
)
view, err := newTrieView(db, db, ViewChanges{BatchOps: []database.BatchOp{{Key: k, Value: v}}})
if err != nil {
return err
}
Expand All @@ -878,13 +857,14 @@ func (db *merkleDB) DeleteContext(ctx context.Context, key []byte) error {
return database.ErrClosed
}

view, err := db.newUntrackedView(
[]database.BatchOp{{
Key: key,
Delete: true,
}},
true,
)
view, err := newTrieView(db, db,
ViewChanges{
BatchOps: []database.BatchOp{{
Key: key,
Delete: true,
}},
ConsumeBytes: true,
})
if err != nil {
return err
}
Expand All @@ -901,7 +881,7 @@ func (db *merkleDB) commitBatch(ops []database.BatchOp) error {
return database.ErrClosed
}

view, err := db.newUntrackedView(ops, true)
view, err := newTrieView(db, db, ViewChanges{BatchOps: ops, ConsumeBytes: true})
if err != nil {
return err
}
Expand Down Expand Up @@ -1116,7 +1096,7 @@ func (db *merkleDB) VerifyChangeProof(
}

// Don't need to lock [view] because nobody else has a reference to it.
view, err := db.newUntrackedView(ops, true)
view, err := newTrieView(db, db, ViewChanges{BatchOps: ops, ConsumeBytes: true})
if err != nil {
return err
}
Expand Down Expand Up @@ -1226,7 +1206,7 @@ func (db *merkleDB) getHistoricalViewForRange(
// looking for the trie's current root id, so return the trie unmodified
if currentRootID == rootID {
// create an empty trie
return newTrieView(db, db, db.root.clone(), ViewChanges{})
return newTrieView(db, db, ViewChanges{})
}

changeHistory, err := db.history.getChangesToGetToRoot(rootID, start, end)
Expand Down
11 changes: 7 additions & 4 deletions x/merkledb/db_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -458,11 +458,14 @@ func TestDatabaseNewUntrackedView(t *testing.T) {
require.NoError(err)

// Create a new untracked view.
view, err := db.newUntrackedView(
[]database.BatchOp{
{Key: []byte{1}, Value: []byte{1}},
view, err := newTrieView(
db,
db,
ViewChanges{
BatchOps: []database.BatchOp{
{Key: []byte{1}, Value: []byte{1}},
},
},
false,
)
require.NoError(err)
require.Empty(db.childViews)
Expand Down
2 changes: 1 addition & 1 deletion x/merkledb/proof.go
Original file line number Diff line number Diff line change
Expand Up @@ -878,5 +878,5 @@ func getStandaloneTrieView(ctx context.Context, ops []database.BatchOp) (*trieVi
return nil, err
}

return db.newUntrackedView(ops, true)
return newTrieView(db, db, ViewChanges{BatchOps: ops, ConsumeBytes: true})
}
30 changes: 17 additions & 13 deletions x/merkledb/trie_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import (
"sync"
"testing"

"github.com/ava-labs/avalanchego/utils/maybe"

"github.com/stretchr/testify/require"

"github.com/ava-labs/avalanchego/database"
Expand Down Expand Up @@ -565,19 +563,28 @@ func Test_Trie_HashCountOnBranch(t *testing.T) {
dbTrie, err := getBasicDB()
require.NoError(err)
require.NotNil(dbTrie)
trieIntf, err := dbTrie.NewView(context.Background(), ViewChanges{})
trieIntf, err := dbTrie.NewView(
context.Background(),
ViewChanges{
BatchOps: []database.BatchOp{
{Key: []byte("key12"), Value: []byte("value12")},
},
})
require.NoError(err)
trie := trieIntf.(*trieView)

// force a new node to generate with common prefix "key1" and have these two nodes as children
_, err = trie.insert(newPath([]byte("key12")), maybe.Some([]byte("value12")))
require.NoError(err)
_, err = trie.insert(newPath([]byte("key134")), maybe.Some([]byte("value134")))
// force a new branch node to generate with common prefix "key1" and have this node and the "key12" node as children
trieIntf, err = trie.NewView(context.Background(), ViewChanges{BatchOps: []database.BatchOp{
{Key: []byte("key134"), Value: []byte("value134")},
}})
require.NoError(err)
trie = trieIntf.(*trieView)
dbTrie.metrics.(*mockMetrics).hashCount = 0
require.NoError(trie.calculateNodeIDs(context.Background()))

// only hashes the new branch node, the new child node, and root
// shouldn't hash the existing node
require.NoError(trie.calculateNodeIDs(context.Background()))
require.Equal(int64(5), dbTrie.metrics.(*mockMetrics).hashCount)
require.Equal(int64(3), dbTrie.metrics.(*mockMetrics).hashCount)
}

func Test_Trie_HashCountOnDelete(t *testing.T) {
Expand Down Expand Up @@ -945,7 +952,7 @@ func TestNewViewOnCommittedView(t *testing.T) {
require.NoError(err)

// Create a view
view1Intf, err := db.NewView(context.Background(), ViewChanges{})
view1Intf, err := db.NewView(context.Background(), ViewChanges{BatchOps: []database.BatchOp{{Key: []byte{1}, Value: []byte{1}}}})
require.NoError(err)
require.IsType(&trieView{}, view1Intf)
view1 := view1Intf.(*trieView)
Expand All @@ -958,9 +965,6 @@ func TestNewViewOnCommittedView(t *testing.T) {
require.Contains(db.childViews, view1)
require.Equal(db, view1.parentTrie)

_, err = view1.insert(newPath([]byte{1}), maybe.Some([]byte{1}))
require.NoError(err)

// Commit the view
require.NoError(view1.CommitToDB(context.Background()))

Expand Down
11 changes: 7 additions & 4 deletions x/merkledb/trieview.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ func (t *trieView) NewView(
return nil, err
}

newView, err := newTrieView(t.db, t, t.root.clone(), changes)
newView, err := newTrieView(t.db, t, changes)
if err != nil {
return nil, err
}
Expand All @@ -145,11 +145,14 @@ func (t *trieView) NewView(
func newTrieView(
db *merkleDB,
parentTrie TrieView,
root *node,
changes ViewChanges,
) (*trieView, error) {
if root == nil {
return nil, ErrNoValidRoot
root, err := parentTrie.getEditableNode(RootPath)
if err != nil {
if err == database.ErrNotFound {
return nil, ErrNoValidRoot
}
return nil, err
}

newView := &trieView{
Expand Down