mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-05 22:48:36 +00:00
bc1967f088
## Overview
This PR fixes a race condition during blockchain shutdown where snapshot
generation could continue accessing the trie database after it has been
closed, leading to iterator errors. We noticed this in one of our nodes
on https://github.com/ava-labs/avalanchego, which relies on an older
version of geth with the same issue (so this behavior does happen!).
During node shutdown, the following sequence occurs:
1. `BlockChain.Stop()` calls `snaps.Release()` to clean up snapshot
resources
2. `Release()` only resets the cache but doesn't stop the generator
goroutine
3. The trie database is then closed via `triedb.Close()`
4. The still-running generator attempts to iterate storage tries
5. Iterator fails because the database is closed (`"Generator failed to
iterate storage trie"`)
## Problem
There are three related bugs:
1. `Release()` doesn't stop generation: The `diskLayer.Release()` method
only resets the cache without stopping ongoing snapshot generation,
leaving the generator goroutine running after database closure.
2. `stopGeneration()` has an incorrect completion check: The
`stopGeneration()` method checks `genMarker != nil` to determine if
generation is running. However, `genMarker` is set to nil when
generation completes successfully, even though the generator goroutine
is still waiting for the abort signal at the end of `generate()`. See
line 705 in `generate.go`:
eaaa5b716d/core/state/snapshot/generate.go (L699-L707)
This means `stopGeneration()` returns early without sending the abort
signal.
3. Node shutdown doesn't stop generation: During shutdown, no code path
calls `stopGeneration()` or sends the abort signal to the generator,
causing the generator to access a closed database and error.
## Fix
- Modified `diskLayer.Release()` to call `stopGeneration()` before
releasing resources
- Added cancelation architecture, removing reliance on someone having to
wait
- Fixed `stopGeneration()` to properly and safely stop snapshot
generation
- Added `TestGenerateGoroutineLeak` to verify the fix and prevent
regression. The test fails without the fix and passes with it.
- The test creates a snapshot with active generation, waits for
completion, then calls `Release()`, and uses `go.uber.org/goleak` to
assert no generator goroutine survives.
- Without the fix, the test fails: `Release()` returns without stopping
the generator, which stays parked at `generate.go:705` waiting for an
abort signal that never comes:
```
--- FAIL: TestGenerateGoroutineLeak (0.88s)
generate_test.go: found unexpected goroutines:
[Goroutine 6 in state chan receive, with
core/state/snapshot.(*diskLayer).generate on top of the stack:
core/state/snapshot.(*diskLayer).generate(...)
core/state/snapshot/generate.go:705
created by core/state/snapshot.generateSnapshot
core/state/snapshot/generate.go:79 ]
```
- With the fix, the test passes: `Release()` -> `stopGeneration()`
blocks until the generator goroutine has fully exited, so nothing leaks
Note that this fix follows the same pattern used in `Tree.Disable()` in
https://github.com/ethereum/go-ethereum/pull/30040, which introduced
`stopGeneration()` for use in `Disable()` and `Rebuild()` but didn't
address the shutdown path.
The test follows the same pattern used in
`TestCheckSimBackendGoroutineLeak`
1025 lines
44 KiB
Go
1025 lines
44 KiB
Go
// Copyright 2019 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 snapshot
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/core/rawdb"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/rlp"
|
|
"github.com/ethereum/go-ethereum/trie"
|
|
"github.com/ethereum/go-ethereum/trie/trienode"
|
|
"github.com/ethereum/go-ethereum/triedb"
|
|
"github.com/ethereum/go-ethereum/triedb/hashdb"
|
|
"github.com/ethereum/go-ethereum/triedb/pathdb"
|
|
"github.com/holiman/uint256"
|
|
"go.uber.org/goleak"
|
|
)
|
|
|
|
func hashData(input []byte) common.Hash {
|
|
return crypto.Keccak256Hash(input)
|
|
}
|
|
|
|
// Tests that snapshot generation from an empty database.
|
|
func TestGeneration(t *testing.T) {
|
|
testGeneration(t, rawdb.HashScheme)
|
|
testGeneration(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGeneration(t *testing.T, scheme string) {
|
|
// We can't use statedb to make a test trie (circular dependency), so make
|
|
// a fake one manually. We're going with a small account trie of 3 accounts,
|
|
// two of which also has the same 3-slot storage trie attached.
|
|
var helper = newHelper(scheme)
|
|
stRoot := helper.makeStorageTrie("", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, false)
|
|
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
if have, want := root, common.HexToHash("0xe3712f1a226f3782caca78ca770ccc19ee000552813a9f59d479f8611db9b1fd"); have != want {
|
|
t.Fatalf("have %#x want %#x", have, want)
|
|
}
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation with existent flat state.
|
|
func TestGenerateExistentState(t *testing.T) {
|
|
testGenerateExistentState(t, rawdb.HashScheme)
|
|
testGenerateExistentState(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateExistentState(t *testing.T, scheme string) {
|
|
// We can't use statedb to make a test trie (circular dependency), so make
|
|
// a fake one manually. We're going with a small account trie of 3 accounts,
|
|
// two of which also has the same 3-slot storage trie attached.
|
|
var helper = newHelper(scheme)
|
|
|
|
stRoot := helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
stRoot = helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func checkSnapRoot(t *testing.T, snap *diskLayer, trieRoot common.Hash) {
|
|
t.Helper()
|
|
|
|
accIt := snap.AccountIterator(common.Hash{})
|
|
defer accIt.Release()
|
|
|
|
snapRoot, err := generateTrieRoot(nil, "", accIt, common.Hash{}, stackTrieGenerate,
|
|
func(db ethdb.KeyValueWriter, accountHash, codeHash common.Hash, stat *generateStats) (common.Hash, error) {
|
|
storageIt := snap.StorageIterator(accountHash, common.Hash{})
|
|
defer storageIt.Release()
|
|
|
|
hash, err := generateTrieRoot(nil, "", storageIt, accountHash, stackTrieGenerate, nil, stat, false)
|
|
if err != nil {
|
|
return common.Hash{}, err
|
|
}
|
|
return hash, nil
|
|
}, newGenerateStats(), true)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if snapRoot != trieRoot {
|
|
t.Fatalf("snaproot: %#x != trieroot #%x", snapRoot, trieRoot)
|
|
}
|
|
if err := CheckDanglingStorage(snap.diskdb); err != nil {
|
|
t.Fatalf("Detected dangling storages: %v", err)
|
|
}
|
|
}
|
|
|
|
type testHelper struct {
|
|
diskdb ethdb.Database
|
|
triedb *triedb.Database
|
|
accTrie *trie.StateTrie
|
|
nodes *trienode.MergedNodeSet
|
|
states *triedb.StateSet
|
|
}
|
|
|
|
func newHelper(scheme string) *testHelper {
|
|
diskdb := rawdb.NewMemoryDatabase()
|
|
config := &triedb.Config{}
|
|
if scheme == rawdb.PathScheme {
|
|
config.PathDB = &pathdb.Config{
|
|
SnapshotNoBuild: true,
|
|
NoAsyncFlush: true,
|
|
} // disable caching
|
|
} else {
|
|
config.HashDB = &hashdb.Config{} // disable caching
|
|
}
|
|
db := triedb.NewDatabase(diskdb, config)
|
|
accTrie, _ := trie.NewStateTrie(trie.StateTrieID(types.EmptyRootHash), db)
|
|
return &testHelper{
|
|
diskdb: diskdb,
|
|
triedb: db,
|
|
accTrie: accTrie,
|
|
nodes: trienode.NewMergedNodeSet(),
|
|
states: triedb.NewStateSet(),
|
|
}
|
|
}
|
|
|
|
func (t *testHelper) addTrieAccount(acckey string, acc *types.StateAccount) {
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
t.accTrie.MustUpdate([]byte(acckey), val)
|
|
|
|
accHash := hashData([]byte(acckey))
|
|
t.states.Accounts[accHash] = val
|
|
t.states.AccountsOrigin[common.BytesToAddress([]byte(acckey))] = nil
|
|
}
|
|
|
|
func (t *testHelper) addSnapAccount(acckey string, acc *types.StateAccount) {
|
|
key := hashData([]byte(acckey))
|
|
rawdb.WriteAccountSnapshot(t.diskdb, key, types.SlimAccountRLP(*acc))
|
|
}
|
|
|
|
func (t *testHelper) addAccount(acckey string, acc *types.StateAccount) {
|
|
t.addTrieAccount(acckey, acc)
|
|
t.addSnapAccount(acckey, acc)
|
|
}
|
|
|
|
func (t *testHelper) addSnapStorage(accKey string, keys []string, vals []string) {
|
|
accHash := hashData([]byte(accKey))
|
|
for i, key := range keys {
|
|
rawdb.WriteStorageSnapshot(t.diskdb, accHash, hashData([]byte(key)), []byte(vals[i]))
|
|
}
|
|
}
|
|
|
|
func (t *testHelper) makeStorageTrie(accKey string, keys []string, vals []string, commit bool) common.Hash {
|
|
owner := hashData([]byte(accKey))
|
|
addr := common.BytesToAddress([]byte(accKey))
|
|
id := trie.StorageTrieID(types.EmptyRootHash, owner, types.EmptyRootHash)
|
|
stTrie, _ := trie.NewStateTrie(id, t.triedb)
|
|
for i, k := range keys {
|
|
stTrie.MustUpdate([]byte(k), []byte(vals[i]))
|
|
if t.states.Storages[owner] == nil {
|
|
t.states.Storages[owner] = make(map[common.Hash][]byte)
|
|
}
|
|
if t.states.StoragesOrigin[addr] == nil {
|
|
t.states.StoragesOrigin[addr] = make(map[common.Hash][]byte)
|
|
}
|
|
t.states.Storages[owner][hashData([]byte(k))] = []byte(vals[i])
|
|
t.states.StoragesOrigin[addr][hashData([]byte(k))] = nil
|
|
}
|
|
if !commit {
|
|
return stTrie.Hash()
|
|
}
|
|
root, nodes := stTrie.Commit(false)
|
|
if nodes != nil {
|
|
t.nodes.Merge(nodes)
|
|
}
|
|
return root
|
|
}
|
|
|
|
func (t *testHelper) Commit() common.Hash {
|
|
root, nodes := t.accTrie.Commit(true)
|
|
if nodes != nil {
|
|
t.nodes.Merge(nodes)
|
|
}
|
|
t.triedb.Update(root, types.EmptyRootHash, 0, t.nodes, t.states)
|
|
t.triedb.Commit(root, false)
|
|
return root
|
|
}
|
|
|
|
func (t *testHelper) CommitAndGenerate() (common.Hash, *diskLayer) {
|
|
root := t.Commit()
|
|
snap := generateSnapshot(t.diskdb, t.triedb, 16, root)
|
|
return root, snap
|
|
}
|
|
|
|
// Tests that snapshot generation with existent flat state, where the flat state
|
|
// contains some errors:
|
|
// - the contract with empty storage root but has storage entries in the disk
|
|
// - the contract with non empty storage root but empty storage slots
|
|
// - the contract(non-empty storage) misses some storage slots
|
|
// - miss in the beginning
|
|
// - miss in the middle
|
|
// - miss in the end
|
|
//
|
|
// - the contract(non-empty storage) has wrong storage slots
|
|
// - wrong slots in the beginning
|
|
// - wrong slots in the middle
|
|
// - wrong slots in the end
|
|
//
|
|
// - the contract(non-empty storage) has extra storage slots
|
|
// - extra slots in the beginning
|
|
// - extra slots in the middle
|
|
// - extra slots in the end
|
|
func TestGenerateExistentStateWithWrongStorage(t *testing.T) {
|
|
testGenerateExistentStateWithWrongStorage(t, rawdb.HashScheme)
|
|
testGenerateExistentStateWithWrongStorage(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateExistentStateWithWrongStorage(t *testing.T, scheme string) {
|
|
helper := newHelper(scheme)
|
|
|
|
// Account one, empty root but non-empty database
|
|
helper.addAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Account two, non empty root but empty database
|
|
stRoot := helper.makeStorageTrie("acc-2", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
// Miss slots
|
|
{
|
|
// Account three, non empty root but misses slots in the beginning
|
|
helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-3", []string{"key-2", "key-3"}, []string{"val-2", "val-3"})
|
|
|
|
// Account four, non empty root but misses slots in the middle
|
|
helper.makeStorageTrie("acc-4", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-4", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-4", []string{"key-1", "key-3"}, []string{"val-1", "val-3"})
|
|
|
|
// Account five, non empty root but misses slots in the end
|
|
helper.makeStorageTrie("acc-5", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-5", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-5", []string{"key-1", "key-2"}, []string{"val-1", "val-2"})
|
|
}
|
|
|
|
// Wrong storage slots
|
|
{
|
|
// Account six, non empty root but wrong slots in the beginning
|
|
helper.makeStorageTrie("acc-6", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-6", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-6", []string{"key-1", "key-2", "key-3"}, []string{"badval-1", "val-2", "val-3"})
|
|
|
|
// Account seven, non empty root but wrong slots in the middle
|
|
helper.makeStorageTrie("acc-7", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-7", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-7", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "badval-2", "val-3"})
|
|
|
|
// Account eight, non empty root but wrong slots in the end
|
|
helper.makeStorageTrie("acc-8", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-8", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-8", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "badval-3"})
|
|
|
|
// Account 9, non empty root but rotated slots
|
|
helper.makeStorageTrie("acc-9", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-9", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-9", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-3", "val-2"})
|
|
}
|
|
|
|
// Extra storage slots
|
|
{
|
|
// Account 10, non empty root but extra slots in the beginning
|
|
helper.makeStorageTrie("acc-10", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-10", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-10", []string{"key-0", "key-1", "key-2", "key-3"}, []string{"val-0", "val-1", "val-2", "val-3"})
|
|
|
|
// Account 11, non empty root but extra slots in the middle
|
|
helper.makeStorageTrie("acc-11", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-11", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-11", []string{"key-1", "key-2", "key-2-1", "key-3"}, []string{"val-1", "val-2", "val-2-1", "val-3"})
|
|
|
|
// Account 12, non empty root but extra slots in the end
|
|
helper.makeStorageTrie("acc-12", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-12", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapStorage("acc-12", []string{"key-1", "key-2", "key-3", "key-4"}, []string{"val-1", "val-2", "val-3", "val-4"})
|
|
}
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
t.Logf("Root: %#x\n", root) // Root = 0x8746cce9fd9c658b2cfd639878ed6584b7a2b3e73bb40f607fcfa156002429a0
|
|
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation with existent flat state, where the flat state
|
|
// contains some errors:
|
|
// - miss accounts
|
|
// - wrong accounts
|
|
// - extra accounts
|
|
func TestGenerateExistentStateWithWrongAccounts(t *testing.T) {
|
|
testGenerateExistentStateWithWrongAccounts(t, rawdb.HashScheme)
|
|
testGenerateExistentStateWithWrongAccounts(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateExistentStateWithWrongAccounts(t *testing.T, scheme string) {
|
|
helper := newHelper(scheme)
|
|
|
|
helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.makeStorageTrie("acc-2", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.makeStorageTrie("acc-4", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
stRoot := helper.makeStorageTrie("acc-6", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
|
|
// Trie accounts [acc-1, acc-2, acc-3, acc-4, acc-6]
|
|
// Extra accounts [acc-0, acc-5, acc-7]
|
|
|
|
// Missing accounts, only in the trie
|
|
{
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // Beginning
|
|
helper.addTrieAccount("acc-4", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // Middle
|
|
helper.addTrieAccount("acc-6", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // End
|
|
}
|
|
|
|
// Wrong accounts
|
|
{
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: common.Hex2Bytes("0x1234")})
|
|
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addSnapAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
}
|
|
|
|
// Extra accounts, only in the snap
|
|
{
|
|
helper.addSnapAccount("acc-0", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // before the beginning
|
|
helper.addSnapAccount("acc-5", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: common.Hex2Bytes("0x1234")}) // Middle
|
|
helper.addSnapAccount("acc-7", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // after the end
|
|
}
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
t.Logf("Root: %#x\n", root) // Root = 0x825891472281463511e7ebcc7f109e4f9200c20fa384754e11fd605cd98464e8
|
|
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation errors out correctly in case of a missing trie
|
|
// node in the account trie.
|
|
func TestGenerateCorruptAccountTrie(t *testing.T) {
|
|
testGenerateCorruptAccountTrie(t, rawdb.HashScheme)
|
|
testGenerateCorruptAccountTrie(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateCorruptAccountTrie(t *testing.T, scheme string) {
|
|
// We can't use statedb to make a test trie (circular dependency), so make
|
|
// a fake one manually. We're going with a small account trie of 3 accounts,
|
|
// without any storage slots to keep the test smaller.
|
|
helper := newHelper(scheme)
|
|
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // 0xc7a30f39aff471c95d8a837497ad0e49b65be475cc0953540f80cfcdbdcd9074
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x65145f923027566669a1ae5ccac66f945b55ff6eaeb17d2ea8e048b7d381f2d7
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x19ead688e907b0fab07176120dceec244a72aff2f0aa51e8b827584e378772f4
|
|
|
|
root := helper.Commit() // Root: 0xa04693ea110a31037fb5ee814308a6f1d76bdab0b11676bdf4541d2de55ba978
|
|
|
|
// Delete an account trie node and ensure the generator chokes
|
|
targetPath := []byte{0xc}
|
|
targetHash := common.HexToHash("0x65145f923027566669a1ae5ccac66f945b55ff6eaeb17d2ea8e048b7d381f2d7")
|
|
|
|
rawdb.DeleteTrieNode(helper.diskdb, common.Hash{}, targetPath, targetHash, scheme)
|
|
|
|
snap := generateSnapshot(helper.diskdb, helper.triedb, 16, root)
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
t.Errorf("Snapshot generated against corrupt account trie")
|
|
|
|
case <-time.After(time.Second):
|
|
// Not generated fast enough, hopefully blocked inside on missing trie node fail
|
|
}
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation errors out correctly in case of a missing root
|
|
// trie node for a storage trie. It's similar to internal corruption but it is
|
|
// handled differently inside the generator.
|
|
func TestGenerateMissingStorageTrie(t *testing.T) {
|
|
testGenerateMissingStorageTrie(t, rawdb.HashScheme)
|
|
testGenerateMissingStorageTrie(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateMissingStorageTrie(t *testing.T, scheme string) {
|
|
// We can't use statedb to make a test trie (circular dependency), so make
|
|
// a fake one manually. We're going with a small account trie of 3 accounts,
|
|
// two of which also has the same 3-slot storage trie attached.
|
|
var (
|
|
acc1 = hashData([]byte("acc-1"))
|
|
acc3 = hashData([]byte("acc-3"))
|
|
helper = newHelper(scheme)
|
|
)
|
|
stRoot := helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true) // 0xddefcd9376dd029653ef384bd2f0a126bb755fe84fdcc9e7cf421ba454f2bc67
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x9250573b9c18c664139f3b6a7a8081b7d8f8916a8fcc5d94feec6c29f5fd4e9e
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x65145f923027566669a1ae5ccac66f945b55ff6eaeb17d2ea8e048b7d381f2d7
|
|
stRoot = helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x50815097425d000edfc8b3a4a13e175fc2bdcfee8bdfbf2d1ff61041d3c235b2
|
|
|
|
root := helper.Commit()
|
|
|
|
// Delete storage trie root of account one and three.
|
|
rawdb.DeleteTrieNode(helper.diskdb, acc1, nil, stRoot, scheme)
|
|
rawdb.DeleteTrieNode(helper.diskdb, acc3, nil, stRoot, scheme)
|
|
|
|
snap := generateSnapshot(helper.diskdb, helper.triedb, 16, root)
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
t.Errorf("Snapshot generated against corrupt storage trie")
|
|
|
|
case <-time.After(time.Second):
|
|
// Not generated fast enough, hopefully blocked inside on missing trie node fail
|
|
}
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation errors out correctly in case of a missing trie
|
|
// node in a storage trie.
|
|
func TestGenerateCorruptStorageTrie(t *testing.T) {
|
|
testGenerateCorruptStorageTrie(t, rawdb.HashScheme)
|
|
testGenerateCorruptStorageTrie(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateCorruptStorageTrie(t *testing.T, scheme string) {
|
|
// We can't use statedb to make a test trie (circular dependency), so make
|
|
// a fake one manually. We're going with a small account trie of 3 accounts,
|
|
// two of which also has the same 3-slot storage trie attached.
|
|
helper := newHelper(scheme)
|
|
|
|
stRoot := helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true) // 0xddefcd9376dd029653ef384bd2f0a126bb755fe84fdcc9e7cf421ba454f2bc67
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x9250573b9c18c664139f3b6a7a8081b7d8f8916a8fcc5d94feec6c29f5fd4e9e
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x65145f923027566669a1ae5ccac66f945b55ff6eaeb17d2ea8e048b7d381f2d7
|
|
stRoot = helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}) // 0x50815097425d000edfc8b3a4a13e175fc2bdcfee8bdfbf2d1ff61041d3c235b2
|
|
|
|
root := helper.Commit()
|
|
|
|
// Delete a node in the storage trie.
|
|
targetPath := []byte{0x4}
|
|
targetHash := common.HexToHash("0x18a0f4d79cff4459642dd7604f303886ad9d77c30cf3d7d7cedb3a693ab6d371")
|
|
rawdb.DeleteTrieNode(helper.diskdb, hashData([]byte("acc-1")), targetPath, targetHash, scheme)
|
|
rawdb.DeleteTrieNode(helper.diskdb, hashData([]byte("acc-3")), targetPath, targetHash, scheme)
|
|
|
|
snap := generateSnapshot(helper.diskdb, helper.triedb, 16, root)
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
t.Errorf("Snapshot generated against corrupt storage trie")
|
|
|
|
case <-time.After(time.Second):
|
|
// Not generated fast enough, hopefully blocked inside on missing trie node fail
|
|
}
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation when an extra account with storage exists in the snap state.
|
|
func TestGenerateWithExtraAccounts(t *testing.T) {
|
|
testGenerateWithExtraAccounts(t, rawdb.HashScheme)
|
|
testGenerateWithExtraAccounts(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateWithExtraAccounts(t *testing.T, scheme string) {
|
|
helper := newHelper(scheme)
|
|
{
|
|
// Account one in the trie
|
|
stRoot := helper.makeStorageTrie("acc-1",
|
|
[]string{"key-1", "key-2", "key-3", "key-4", "key-5"},
|
|
[]string{"val-1", "val-2", "val-3", "val-4", "val-5"},
|
|
true,
|
|
)
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
helper.accTrie.MustUpdate([]byte("acc-1"), val) // 0x9250573b9c18c664139f3b6a7a8081b7d8f8916a8fcc5d94feec6c29f5fd4e9e
|
|
|
|
// Identical in the snap
|
|
key := hashData([]byte("acc-1"))
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, key, val)
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-1")), []byte("val-1"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-2")), []byte("val-2"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-3")), []byte("val-3"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-4")), []byte("val-4"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-5")), []byte("val-5"))
|
|
}
|
|
{
|
|
// Account two exists only in the snapshot
|
|
stRoot := helper.makeStorageTrie("acc-2",
|
|
[]string{"key-1", "key-2", "key-3", "key-4", "key-5"},
|
|
[]string{"val-1", "val-2", "val-3", "val-4", "val-5"},
|
|
true,
|
|
)
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
key := hashData([]byte("acc-2"))
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, key, val)
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("b-key-1")), []byte("b-val-1"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("b-key-2")), []byte("b-val-2"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("b-key-3")), []byte("b-val-3"))
|
|
}
|
|
root := helper.Commit()
|
|
|
|
// To verify the test: If we now inspect the snap db, there should exist extraneous storage items
|
|
if data := rawdb.ReadStorageSnapshot(helper.diskdb, hashData([]byte("acc-2")), hashData([]byte("b-key-1"))); data == nil {
|
|
t.Fatalf("expected snap storage to exist")
|
|
}
|
|
snap := generateSnapshot(helper.diskdb, helper.triedb, 16, root)
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// If we now inspect the snap db, there should exist no extraneous storage items
|
|
if data := rawdb.ReadStorageSnapshot(helper.diskdb, hashData([]byte("acc-2")), hashData([]byte("b-key-1"))); data != nil {
|
|
t.Fatalf("expected slot to be removed, got %v", string(data))
|
|
}
|
|
}
|
|
|
|
func enableLogging() {
|
|
log.SetDefault(log.NewLogger(log.NewTerminalHandlerWithLevel(os.Stderr, log.LevelTrace, true)))
|
|
}
|
|
|
|
// Tests that snapshot generation when an extra account with storage exists in the snap state.
|
|
func TestGenerateWithManyExtraAccounts(t *testing.T) {
|
|
testGenerateWithManyExtraAccounts(t, rawdb.HashScheme)
|
|
testGenerateWithManyExtraAccounts(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateWithManyExtraAccounts(t *testing.T, scheme string) {
|
|
if false {
|
|
enableLogging()
|
|
}
|
|
helper := newHelper(scheme)
|
|
{
|
|
// Account one in the trie
|
|
stRoot := helper.makeStorageTrie("acc-1",
|
|
[]string{"key-1", "key-2", "key-3"},
|
|
[]string{"val-1", "val-2", "val-3"},
|
|
true,
|
|
)
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
helper.accTrie.MustUpdate([]byte("acc-1"), val) // 0x9250573b9c18c664139f3b6a7a8081b7d8f8916a8fcc5d94feec6c29f5fd4e9e
|
|
|
|
// Identical in the snap
|
|
key := hashData([]byte("acc-1"))
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, key, val)
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-1")), []byte("val-1"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-2")), []byte("val-2"))
|
|
rawdb.WriteStorageSnapshot(helper.diskdb, key, hashData([]byte("key-3")), []byte("val-3"))
|
|
}
|
|
{
|
|
// 100 accounts exist only in snapshot
|
|
for i := 0; i < 1000; i++ {
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(uint64(i)), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
key := hashData(fmt.Appendf(nil, "acc-%d", i))
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, key, val)
|
|
}
|
|
}
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests this case
|
|
// maxAccountRange 3
|
|
// snapshot-accounts: 01, 02, 03, 04, 05, 06, 07
|
|
// trie-accounts: 03, 07
|
|
//
|
|
// We iterate three snapshot storage slots (max = 3) from the database. They are 0x01, 0x02, 0x03.
|
|
// The trie has a lot of deletions.
|
|
// So in trie, we iterate 2 entries 0x03, 0x07. We create the 0x07 in the database and abort the procedure, because the trie is exhausted.
|
|
// But in the database, we still have the stale storage slots 0x04, 0x05. They are not iterated yet, but the procedure is finished.
|
|
func TestGenerateWithExtraBeforeAndAfter(t *testing.T) {
|
|
testGenerateWithExtraBeforeAndAfter(t, rawdb.HashScheme)
|
|
testGenerateWithExtraBeforeAndAfter(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateWithExtraBeforeAndAfter(t *testing.T, scheme string) {
|
|
accountCheckRange = 3
|
|
if false {
|
|
enableLogging()
|
|
}
|
|
helper := newHelper(scheme)
|
|
{
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
helper.accTrie.MustUpdate(common.HexToHash("0x03").Bytes(), val)
|
|
helper.accTrie.MustUpdate(common.HexToHash("0x07").Bytes(), val)
|
|
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x01"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x02"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x03"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x04"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x05"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x06"), val)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x07"), val)
|
|
}
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// TestGenerateWithMalformedSnapdata tests what happes if we have some junk
|
|
// in the snapshot database, which cannot be parsed back to an account
|
|
func TestGenerateWithMalformedSnapdata(t *testing.T) {
|
|
testGenerateWithMalformedSnapdata(t, rawdb.HashScheme)
|
|
testGenerateWithMalformedSnapdata(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateWithMalformedSnapdata(t *testing.T, scheme string) {
|
|
accountCheckRange = 3
|
|
if false {
|
|
enableLogging()
|
|
}
|
|
helper := newHelper(scheme)
|
|
{
|
|
acc := &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()}
|
|
val, _ := rlp.EncodeToBytes(acc)
|
|
helper.accTrie.MustUpdate(common.HexToHash("0x03").Bytes(), val)
|
|
|
|
junk := make([]byte, 100)
|
|
copy(junk, []byte{0xde, 0xad})
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x02"), junk)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x03"), junk)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x04"), junk)
|
|
rawdb.WriteAccountSnapshot(helper.diskdb, common.HexToHash("0x05"), junk)
|
|
}
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// If we now inspect the snap db, there should exist no extraneous storage items
|
|
if data := rawdb.ReadStorageSnapshot(helper.diskdb, hashData([]byte("acc-2")), hashData([]byte("b-key-1"))); data != nil {
|
|
t.Fatalf("expected slot to be removed, got %v", string(data))
|
|
}
|
|
}
|
|
|
|
func TestGenerateFromEmptySnap(t *testing.T) {
|
|
testGenerateFromEmptySnap(t, rawdb.HashScheme)
|
|
testGenerateFromEmptySnap(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateFromEmptySnap(t *testing.T, scheme string) {
|
|
//enableLogging()
|
|
accountCheckRange = 10
|
|
storageCheckRange = 20
|
|
helper := newHelper(scheme)
|
|
// Add 1K accounts to the trie
|
|
for i := 0; i < 400; i++ {
|
|
stRoot := helper.makeStorageTrie(fmt.Sprintf("acc-%d", i), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount(fmt.Sprintf("acc-%d", i),
|
|
&types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
}
|
|
root, snap := helper.CommitAndGenerate()
|
|
t.Logf("Root: %#x\n", root) // Root: 0x6f7af6d2e1a1bf2b84a3beb3f8b64388465fbc1e274ca5d5d3fc787ca78f59e4
|
|
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation with existent flat state, where the flat state
|
|
// storage is correct, but incomplete.
|
|
// The incomplete part is on the second range
|
|
// snap: [ 0x01, 0x02, 0x03, 0x04] , [ 0x05, 0x06, 0x07, {missing}] (with storageCheck = 4)
|
|
// trie: 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
|
|
// This hits a case where the snap verification passes, but there are more elements in the trie
|
|
// which we must also add.
|
|
func TestGenerateWithIncompleteStorage(t *testing.T) {
|
|
testGenerateWithIncompleteStorage(t, rawdb.HashScheme)
|
|
testGenerateWithIncompleteStorage(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateWithIncompleteStorage(t *testing.T, scheme string) {
|
|
storageCheckRange = 4
|
|
helper := newHelper(scheme)
|
|
stKeys := []string{"1", "2", "3", "4", "5", "6", "7", "8"}
|
|
stVals := []string{"v1", "v2", "v3", "v4", "v5", "v6", "v7", "v8"}
|
|
// We add 8 accounts, each one is missing exactly one of the storage slots. This means
|
|
// we don't have to order the keys and figure out exactly which hash-key winds up
|
|
// on the sensitive spots at the boundaries
|
|
for i := 0; i < 8; i++ {
|
|
accKey := fmt.Sprintf("acc-%d", i)
|
|
stRoot := helper.makeStorageTrie(accKey, stKeys, stVals, true)
|
|
helper.addAccount(accKey, &types.StateAccount{Balance: uint256.NewInt(uint64(i)), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
var moddedKeys []string
|
|
var moddedVals []string
|
|
for ii := 0; ii < 8; ii++ {
|
|
if ii != i {
|
|
moddedKeys = append(moddedKeys, stKeys[ii])
|
|
moddedVals = append(moddedVals, stVals[ii])
|
|
}
|
|
}
|
|
helper.addSnapStorage(accKey, moddedKeys, moddedVals)
|
|
}
|
|
root, snap := helper.CommitAndGenerate()
|
|
t.Logf("Root: %#x\n", root) // Root: 0xca73f6f05ba4ca3024ef340ef3dfca8fdabc1b677ff13f5a9571fd49c16e67ff
|
|
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func incKey(key []byte) []byte {
|
|
for i := len(key) - 1; i >= 0; i-- {
|
|
key[i]++
|
|
if key[i] != 0x0 {
|
|
break
|
|
}
|
|
}
|
|
return key
|
|
}
|
|
|
|
func decKey(key []byte) []byte {
|
|
for i := len(key) - 1; i >= 0; i-- {
|
|
key[i]--
|
|
if key[i] != 0xff {
|
|
break
|
|
}
|
|
}
|
|
return key
|
|
}
|
|
|
|
func populateDangling(disk ethdb.KeyValueStore) {
|
|
populate := func(accountHash common.Hash, keys []string, vals []string) {
|
|
for i, key := range keys {
|
|
rawdb.WriteStorageSnapshot(disk, accountHash, hashData([]byte(key)), []byte(vals[i]))
|
|
}
|
|
}
|
|
// Dangling storages of the "first" account
|
|
populate(common.Hash{}, []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Dangling storages of the "last" account
|
|
populate(common.HexToHash("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Dangling storages around the account 1
|
|
hash := decKey(hashData([]byte("acc-1")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
hash = incKey(hashData([]byte("acc-1")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Dangling storages around the account 2
|
|
hash = decKey(hashData([]byte("acc-2")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
hash = incKey(hashData([]byte("acc-2")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Dangling storages around the account 3
|
|
hash = decKey(hashData([]byte("acc-3")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
hash = incKey(hashData([]byte("acc-3")).Bytes())
|
|
populate(common.BytesToHash(hash), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
// Dangling storages of the random account
|
|
populate(randomHash(), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
populate(randomHash(), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
populate(randomHash(), []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
}
|
|
|
|
// Tests that snapshot generation with dangling storages. Dangling storage means
|
|
// the storage data is existent while the corresponding account data is missing.
|
|
//
|
|
// This test will populate some dangling storages to see if they can be cleaned up.
|
|
func TestGenerateCompleteSnapshotWithDanglingStorage(t *testing.T) {
|
|
testGenerateCompleteSnapshotWithDanglingStorage(t, rawdb.HashScheme)
|
|
testGenerateCompleteSnapshotWithDanglingStorage(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateCompleteSnapshotWithDanglingStorage(t *testing.T, scheme string) {
|
|
var helper = newHelper(scheme)
|
|
|
|
stRoot := helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
helper.addSnapStorage("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
helper.addSnapStorage("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"})
|
|
|
|
populateDangling(helper.diskdb)
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Tests that snapshot generation with dangling storages. Dangling storage means
|
|
// the storage data is existent while the corresponding account data is missing.
|
|
//
|
|
// This test will populate some dangling storages to see if they can be cleaned up.
|
|
func TestGenerateBrokenSnapshotWithDanglingStorage(t *testing.T) {
|
|
testGenerateBrokenSnapshotWithDanglingStorage(t, rawdb.HashScheme)
|
|
testGenerateBrokenSnapshotWithDanglingStorage(t, rawdb.PathScheme)
|
|
}
|
|
|
|
func testGenerateBrokenSnapshotWithDanglingStorage(t *testing.T, scheme string) {
|
|
var helper = newHelper(scheme)
|
|
|
|
stRoot := helper.makeStorageTrie("acc-1", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
helper.addTrieAccount("acc-2", &types.StateAccount{Balance: uint256.NewInt(2), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
helper.makeStorageTrie("acc-3", []string{"key-1", "key-2", "key-3"}, []string{"val-1", "val-2", "val-3"}, true)
|
|
helper.addTrieAccount("acc-3", &types.StateAccount{Balance: uint256.NewInt(3), Root: stRoot, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
populateDangling(helper.diskdb)
|
|
|
|
root, snap := helper.CommitAndGenerate()
|
|
select {
|
|
case <-snap.genPending:
|
|
// Snapshot generation succeeded
|
|
|
|
case <-time.After(3 * time.Second):
|
|
t.Errorf("Snapshot generation failed")
|
|
}
|
|
checkSnapRoot(t, snap, root)
|
|
|
|
// Stop the generator (if still running) and wait for it to exit.
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// TestGenerateGoroutineLeak verifies that Release() tears down the generator
|
|
// goroutine. Even after generation completes, the goroutine parks waiting for
|
|
// an abort signal. If Release() does not stop it, it lingers and can touch the
|
|
// database after it has been closed during shutdown.
|
|
func TestGenerateGoroutineLeak(t *testing.T) {
|
|
testGenerateGoroutineLeak(t, rawdb.HashScheme)
|
|
testGenerateGoroutineLeak(t, rawdb.PathScheme)
|
|
}
|
|
|
|
// generateAndRelease builds a minimal state, runs snapshot generation to
|
|
// completion, and releases the resulting disk layer.
|
|
func generateAndRelease(t *testing.T, scheme string) {
|
|
t.Helper()
|
|
|
|
helper := newHelper(scheme)
|
|
helper.addTrieAccount("acc-1", &types.StateAccount{Balance: uint256.NewInt(1), Root: types.EmptyRootHash, CodeHash: types.EmptyCodeHash.Bytes()})
|
|
|
|
_, snap := helper.CommitAndGenerate()
|
|
|
|
// Wait for generation to run to completion.
|
|
select {
|
|
case <-snap.genPending:
|
|
case <-time.After(3 * time.Second):
|
|
t.Fatal("snapshot generation did not complete in time")
|
|
}
|
|
|
|
if err := snap.Release(); err != nil {
|
|
t.Fatalf("Release returned error: %v", err)
|
|
}
|
|
}
|
|
|
|
func testGenerateGoroutineLeak(t *testing.T, scheme string) {
|
|
generateAndRelease(t, scheme)
|
|
|
|
// Snapshot the current goroutines now berfore verifying the run
|
|
// below leaks none of its own.
|
|
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
|
|
|
generateAndRelease(t, scheme)
|
|
}
|