snapshot

Documentation

Overview

Package snapshot implements a journalled, dynamic state dump.

Index

• Variables
• func FullAccountRLP(data []byte) ([]byte, error)
• func GenerateAccountTrieRoot(it AccountIterator) (common.Hash, error)
• func GenerateStorageTrieRoot(account common.Hash, it StorageIterator) (common.Hash, error)
• func GenerateTrie(snaptree *Tree, root common.Hash, src ethdb.Database, dst ethdb.KeyValueWriter) error
• func ResetSnapshotGeneration(db ethdb.KeyValueWriter)
• func SlimAccountRLP(nonce uint64, balance *big.Int, root common.Hash, codehash []byte, ...) []byte
• func WipeSnapshot(db ethdb.KeyValueStore, full bool) chan struct{}
• type Account
  • func FullAccount(data []byte) (Account, error)
  • func SlimAccount(nonce uint64, balance *big.Int, root common.Hash, codehash []byte, ...) Account
• type AccountIterator
• type Iterator
• type Snapshot
• type StorageIterator
• type Tree
  • func New(diskdb ethdb.KeyValueStore, triedb *trie.Database, cache int, ...) (*Tree, error)
  • func NewTestTree(diskdb ethdb.KeyValueStore, blockHash, root common.Hash) *Tree
  • func (t *Tree) AbortGeneration()
  • func (t *Tree) AccountIterator(root common.Hash, seek common.Hash, force bool) (AccountIterator, error)
  • func (t *Tree) Discard(blockHash common.Hash) error
  • func (t *Tree) DiskAccountIterator(seek common.Hash) AccountIterator
  • func (t *Tree) DiskRoot() common.Hash
  • func (t *Tree) DiskStorageIterator(account common.Hash, seek common.Hash) StorageIterator
  • func (t *Tree) Flatten(blockHash common.Hash) error
  • func (t *Tree) NumBlockLayers() int
  • func (t *Tree) NumStateLayers() int
  • func (t *Tree) Rebuild(blockHash, root common.Hash)
  • func (t *Tree) Snapshot(stateRoot common.Hash) Snapshot
  • func (t *Tree) Snapshots(blockHash common.Hash, limits int, nodisk bool) []Snapshot
  • func (t *Tree) StorageIterator(root common.Hash, account common.Hash, seek common.Hash, force bool) (StorageIterator, error)
  • func (t *Tree) Update(blockHash, blockRoot, parentBlockHash common.Hash, ...) error
  • func (t *Tree) Verify(root common.Hash) error

Variables

var (

	// ErrSnapshotStale is returned from data accessors if the underlying snapshot
	// layer had been invalidated due to the chain progressing forward far enough
	// to not maintain the layer's original state.
	ErrSnapshotStale = errors.New("snapshot stale")

	// ErrStaleParentLayer is returned when Flatten attempts to flatten a diff layer into
	// a stale parent.
	ErrStaleParentLayer = errors.New("parent disk layer is stale")

	// ErrNotCoveredYet is returned from data accessors if the underlying snapshot
	// is being generated currently and the requested data item is not yet in the
	// range of accounts covered.
	ErrNotCoveredYet = errors.New("not covered yet")

	// ErrNotConstructed is returned if the callers want to iterate the snapshot
	// while the generation is not finished yet.
	ErrNotConstructed = errors.New("snapshot is not constructed")
)

Functions

func FullAccountRLP

func FullAccountRLP(data []byte) ([]byte, error)

FullAccountRLP converts data on the 'slim RLP' format into the full RLP-format.

func GenerateAccountTrieRoot

func GenerateAccountTrieRoot(it AccountIterator) (common.Hash, error)

GenerateAccountTrieRoot takes an account iterator and reproduces the root hash.

func GenerateStorageTrieRoot

func GenerateStorageTrieRoot(account common.Hash, it StorageIterator) (common.Hash, error)

GenerateStorageTrieRoot takes a storage iterator and reproduces the root hash.

func GenerateTrie

func GenerateTrie(snaptree *Tree, root common.Hash, src ethdb.Database, dst ethdb.KeyValueWriter) error

GenerateTrie takes the whole snapshot tree as the input, traverses all the accounts as well as the corresponding storages and regenerate the whole state (account trie + all storage tries).

func ResetSnapshotGeneration

func ResetSnapshotGeneration(db ethdb.KeyValueWriter)

ResetSnapshotGeneration writes a clean snapshot generator marker to [db] so no re-generation is performed after.

func SlimAccountRLP

func SlimAccountRLP(nonce uint64, balance *big.Int, root common.Hash, codehash []byte, isMultiCoin bool) []byte

SlimAccountRLP converts a state.Account content into a slim snapshot version RLP encoded.

func WipeSnapshot

func WipeSnapshot(db ethdb.KeyValueStore, full bool) chan struct{}

WipeSnapshot starts a goroutine to iterate over the entire key-value database and delete all the data associated with the snapshot (accounts, storage, metadata). After all is done, the snapshot range of the database is compacted to free up unused data blocks.

Types

type Account

type Account struct {
	Nonce       uint64
	Balance     *big.Int
	Root        []byte
	CodeHash    []byte
	IsMultiCoin bool
}

Account is a modified version of a state.Account, where the root is replaced with a byte slice. This format can be used to represent full-consensus format or slim-snapshot format which replaces the empty root and code hash as nil byte slice.

func FullAccount

func FullAccount(data []byte) (Account, error)

FullAccount decodes the data on the 'slim RLP' format and return the consensus format account.

func SlimAccount

func SlimAccount(nonce uint64, balance *big.Int, root common.Hash, codehash []byte, isMultiCoin bool) Account

SlimAccount converts a state.Account content into a slim snapshot account

type AccountIterator

type AccountIterator interface {
	Iterator

	// Account returns the RLP encoded slim account the iterator is currently at.
	// An error will be returned if the iterator becomes invalid
	Account() []byte
}

AccountIterator is an iterator to step over all the accounts in a snapshot, which may or may not be composed of multiple layers.

type Iterator

type Iterator interface {
	// Next steps the iterator forward one element, returning false if exhausted,
	// or an error if iteration failed for some reason (e.g. root being iterated
	// becomes stale and garbage collected).
	Next() bool

	// Error returns any failure that occurred during iteration, which might have
	// caused a premature iteration exit (e.g. snapshot stack becoming stale).
	Error() error

	// Hash returns the hash of the account or storage slot the iterator is
	// currently at.
	Hash() common.Hash

	// Release releases associated resources. Release should always succeed and
	// can be called multiple times without causing error.
	Release()
}

Iterator is an iterator to step over all the accounts or the specific storage in a snapshot which may or may not be composed of multiple layers.

type Snapshot

type Snapshot interface {
	// Root returns the root hash for which this snapshot was made.
	Root() common.Hash

	// Account directly retrieves the account associated with a particular hash in
	// the snapshot slim data format.
	Account(hash common.Hash) (*Account, error)

	// AccountRLP directly retrieves the account RLP associated with a particular
	// hash in the snapshot slim data format.
	AccountRLP(hash common.Hash) ([]byte, error)

	// Storage directly retrieves the storage data associated with a particular hash,
	// within a particular account.
	Storage(accountHash, storageHash common.Hash) ([]byte, error)
}

Snapshot represents the functionality supported by a snapshot storage layer.

type StorageIterator

type StorageIterator interface {
	Iterator

	// Slot returns the storage slot the iterator is currently at. An error will
	// be returned if the iterator becomes invalid
	Slot() []byte
}

StorageIterator is an iterator to step over the specific storage in a snapshot, which may or may not be composed of multiple layers.

type Tree

type Tree struct {
	// contains filtered or unexported fields
}

Tree is an Ethereum state snapshot tree. It consists of one persistent base layer backed by a key-value store, on top of which arbitrarily many in-memory diff layers are topped. The memory diffs can form a tree with branching, but the disk layer is singleton and common to all. If a reorg goes deeper than the disk layer, everything needs to be deleted.

The goal of a state snapshot is twofold: to allow direct access to account and storage data to avoid expensive multi-level trie lookups; and to allow sorted, cheap iteration of the account/storage tries for sync aid.

func New

func New(diskdb ethdb.KeyValueStore, triedb *trie.Database, cache int, blockHash, root common.Hash, async bool, rebuild bool, verify bool) (*Tree, error)

New attempts to load an already existing snapshot from a persistent key-value store (with a number of memory layers from a journal), ensuring that the head of the snapshot matches the expected one.

If the snapshot is missing or the disk layer is broken, the snapshot will be reconstructed using both the existing data and the state trie. The repair happens on a background thread.

func NewTestTree

func NewTestTree(diskdb ethdb.KeyValueStore, blockHash, root common.Hash) *Tree

NewTestTree creates a *Tree with a pre-populated diskLayer

func (*Tree) AbortGeneration

func (t *Tree) AbortGeneration()

AbortGeneration aborts an ongoing snapshot generation process (if it hasn't stopped already).

It is not required to manually abort snapshot generation. If generation has not been manually aborted prior to invoking [diffToDisk], it will be aborted anyways.

It is safe to call this method multiple times and when there is no snapshot generation currently underway.

func (*Tree) AccountIterator

func (t *Tree) AccountIterator(root common.Hash, seek common.Hash, force bool) (AccountIterator, error)

AccountIterator creates a new account iterator for the specified root hash and seeks to a starting account hash. When [force] is true, a new account iterator is created without acquiring the [snapTree] lock and without confirming that the snapshot on the disk layer is fully generated.

func (*Tree) Discard

func (t *Tree) Discard(blockHash common.Hash) error

Discard removes layers that we no longer need

func (*Tree) DiskAccountIterator

func (t *Tree) DiskAccountIterator(seek common.Hash) AccountIterator

func (*Tree) DiskRoot

func (t *Tree) DiskRoot() common.Hash

diskRoot is a external helper function to return the disk layer root.

func (*Tree) DiskStorageIterator

func (t *Tree) DiskStorageIterator(account common.Hash, seek common.Hash) StorageIterator

func (*Tree) Flatten

func (t *Tree) Flatten(blockHash common.Hash) error

Flatten flattens the snapshot for [blockHash] into its parent. if its parent is not a disk layer, Flatten will return an error. Note: a blockHash is used instead of a state root so that the exact state transition between the two states is well defined. This is intended to prevent the following edge case

  A
 /  \
B    C
     |
     D

In this scenario, it's possible For (A, B) and (A, C, D) to be two different paths to the resulting state. We use block hashes and parent block hashes to ensure that the exact path through which we flatten diffLayers is well defined.

func (*Tree) NumBlockLayers

func (t *Tree) NumBlockLayers() int

func (*Tree) NumStateLayers

func (t *Tree) NumStateLayers() int

Length returns the number of snapshot layers that is currently being maintained.

func (*Tree) Rebuild

func (t *Tree) Rebuild(blockHash, root common.Hash)

Rebuild wipes all available snapshot data from the persistent database and discard all caches and diff layers. Afterwards, it starts a new snapshot generator with the given root hash.

func (*Tree) Snapshot

func (t *Tree) Snapshot(stateRoot common.Hash) Snapshot

Snapshot retrieves a snapshot belonging to the given state root, or nil if no snapshot is maintained for that state root.

func (*Tree) Snapshots

func (t *Tree) Snapshots(blockHash common.Hash, limits int, nodisk bool) []Snapshot

Snapshots returns all visited layers from the topmost layer with specific root and traverses downward. The layer amount is limited by the given number. If nodisk is set, then disk layer is excluded.

func (*Tree) StorageIterator

func (t *Tree) StorageIterator(root common.Hash, account common.Hash, seek common.Hash, force bool) (StorageIterator, error)

StorageIterator creates a new storage iterator for the specified root hash and account. The iterator will be move to the specific start position. When [force] is true, a new account iterator is created without acquiring the [snapTree] lock and without confirming that the snapshot on the disk layer is fully generated.

func (*Tree) Update

func (t *Tree) Update(blockHash, blockRoot, parentBlockHash common.Hash, destructs map[common.Hash]struct{}, accounts map[common.Hash][]byte, storage map[common.Hash]map[common.Hash][]byte) error

Update adds a new snapshot into the tree, if that can be linked to an existing old parent. It is disallowed to insert a disk layer (the origin of all).

func (*Tree) Verify

func (t *Tree) Verify(root common.Hash) error

Verify iterates the whole state(all the accounts as well as the corresponding storages) with the specific root and compares the re-computed hash with the original one.