347 lines
10 KiB
Go
347 lines
10 KiB
Go
// Copyright 2017 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 state
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"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/ethdb"
|
|
"github.com/ethereum/go-ethereum/trie"
|
|
lru "github.com/hashicorp/golang-lru"
|
|
)
|
|
|
|
const (
|
|
// Number of codehash->size associations to keep.
|
|
codeSizeCacheSize = 100000
|
|
|
|
// Number of state trie in cache
|
|
accountTrieCacheSize = 32
|
|
|
|
// Number of storage Trie in cache
|
|
storageTrieCacheSize = 2000
|
|
|
|
// Cache size granted for caching clean code.
|
|
codeCacheSize = 64 * 1024 * 1024
|
|
|
|
purgeInterval = 600
|
|
|
|
maxAccountTrieSize = 1024 * 1024
|
|
)
|
|
|
|
// Database wraps access to tries and contract code.
|
|
type Database interface {
|
|
// OpenTrie opens the main account trie.
|
|
OpenTrie(root common.Hash) (Trie, error)
|
|
|
|
// OpenStorageTrie opens the storage trie of an account.
|
|
OpenStorageTrie(addrHash, root common.Hash) (Trie, error)
|
|
|
|
// CopyTrie returns an independent copy of the given trie.
|
|
CopyTrie(Trie) Trie
|
|
|
|
// ContractCode retrieves a particular contract's code.
|
|
ContractCode(addrHash, codeHash common.Hash) ([]byte, error)
|
|
|
|
// ContractCodeSize retrieves a particular contracts code's size.
|
|
ContractCodeSize(addrHash, codeHash common.Hash) (int, error)
|
|
|
|
// TrieDB retrieves the low level trie database used for data storage.
|
|
TrieDB() *trie.Database
|
|
|
|
// Cache the account trie tree
|
|
CacheAccount(root common.Hash, t Trie)
|
|
|
|
// Cache the storage trie tree
|
|
CacheStorage(addrHash common.Hash, root common.Hash, t Trie)
|
|
|
|
// Purge cache
|
|
Purge()
|
|
|
|
// NoTries returns whether the database has tries storage.
|
|
NoTries() bool
|
|
}
|
|
|
|
// Trie is a Ethereum Merkle Patricia trie.
|
|
type Trie interface {
|
|
// GetKey returns the sha3 preimage of a hashed key that was previously used
|
|
// to store a value.
|
|
//
|
|
// TODO(fjl): remove this when SecureTrie is removed
|
|
GetKey([]byte) []byte
|
|
|
|
// TryGet returns the value for key stored in the trie. The value bytes must
|
|
// not be modified by the caller. If a node was not found in the database, a
|
|
// trie.MissingNodeError is returned.
|
|
TryGet(key []byte) ([]byte, error)
|
|
|
|
// TryUpdateAccount abstract an account write in the trie.
|
|
TryUpdateAccount(key []byte, account *types.StateAccount) error
|
|
|
|
// TryUpdate associates key with value in the trie. If value has length zero, any
|
|
// existing value is deleted from the trie. The value bytes must not be modified
|
|
// by the caller while they are stored in the trie. If a node was not found in the
|
|
// database, a trie.MissingNodeError is returned.
|
|
TryUpdate(key, value []byte) error
|
|
|
|
// TryDelete removes any existing value for key from the trie. If a node was not
|
|
// found in the database, a trie.MissingNodeError is returned.
|
|
TryDelete(key []byte) error
|
|
|
|
// Hash returns the root hash of the trie. It does not write to the database and
|
|
// can be used even if the trie doesn't have one.
|
|
Hash() common.Hash
|
|
|
|
// Commit writes all nodes to the trie's memory database, tracking the internal
|
|
// and external (for account tries) references.
|
|
Commit(onleaf trie.LeafCallback) (common.Hash, int, error)
|
|
|
|
// NodeIterator returns an iterator that returns nodes of the trie. Iteration
|
|
// starts at the key after the given start key.
|
|
NodeIterator(startKey []byte) trie.NodeIterator
|
|
|
|
// Prove constructs a Merkle proof for key. The result contains all encoded nodes
|
|
// on the path to the value at key. The value itself is also included in the last
|
|
// node and can be retrieved by verifying the proof.
|
|
//
|
|
// If the trie does not contain a value for key, the returned proof contains all
|
|
// nodes of the longest existing prefix of the key (at least the root), ending
|
|
// with the node that proves the absence of the key.
|
|
Prove(key []byte, fromLevel uint, proofDb ethdb.KeyValueWriter) error
|
|
}
|
|
|
|
// NewDatabase creates a backing store for state. The returned database is safe for
|
|
// concurrent use, but does not retain any recent trie nodes in memory. To keep some
|
|
// historical state in memory, use the NewDatabaseWithConfig constructor.
|
|
func NewDatabase(db ethdb.Database) Database {
|
|
return NewDatabaseWithConfig(db, nil)
|
|
}
|
|
|
|
// NewDatabaseWithConfig creates a backing store for state. The returned database
|
|
// is safe for concurrent use and retains a lot of collapsed RLP trie nodes in a
|
|
// large memory cache.
|
|
func NewDatabaseWithConfig(db ethdb.Database, config *trie.Config) Database {
|
|
csc, _ := lru.New(codeSizeCacheSize)
|
|
cc, _ := lru.New(codeCacheSize)
|
|
noTries := config != nil && config.NoTries
|
|
return &cachingDB{
|
|
db: trie.NewDatabaseWithConfig(db, config),
|
|
codeSizeCache: csc,
|
|
codeCache: cc,
|
|
noTries: noTries,
|
|
}
|
|
}
|
|
|
|
func NewDatabaseWithConfigAndCache(db ethdb.Database, config *trie.Config) Database {
|
|
csc, _ := lru.New(codeSizeCacheSize)
|
|
cc, _ := lru.New(codeCacheSize)
|
|
atc, _ := lru.New(accountTrieCacheSize)
|
|
stc, _ := lru.New(storageTrieCacheSize)
|
|
noTries := config != nil && config.NoTries
|
|
|
|
database := &cachingDB{
|
|
db: trie.NewDatabaseWithConfig(db, config),
|
|
codeSizeCache: csc,
|
|
codeCache: cc,
|
|
accountTrieCache: atc,
|
|
storageTrieCache: stc,
|
|
noTries: noTries,
|
|
}
|
|
if !noTries {
|
|
go database.purgeLoop()
|
|
}
|
|
return database
|
|
}
|
|
|
|
type cachingDB struct {
|
|
db *trie.Database
|
|
codeSizeCache *lru.Cache
|
|
codeCache *lru.Cache
|
|
accountTrieCache *lru.Cache
|
|
storageTrieCache *lru.Cache
|
|
noTries bool
|
|
}
|
|
|
|
type triePair struct {
|
|
root common.Hash
|
|
trie Trie
|
|
}
|
|
|
|
func (db *cachingDB) purgeLoop() {
|
|
for {
|
|
time.Sleep(purgeInterval * time.Second)
|
|
_, accounts, ok := db.accountTrieCache.GetOldest()
|
|
if !ok {
|
|
continue
|
|
}
|
|
tr := accounts.(*trie.SecureTrie).GetRawTrie()
|
|
if tr.Size() > maxAccountTrieSize {
|
|
db.Purge()
|
|
}
|
|
}
|
|
}
|
|
|
|
// OpenTrie opens the main account trie at a specific root hash.
|
|
func (db *cachingDB) OpenTrie(root common.Hash) (Trie, error) {
|
|
if db.noTries {
|
|
return trie.NewEmptyTrie(), nil
|
|
}
|
|
if db.accountTrieCache != nil {
|
|
if tr, exist := db.accountTrieCache.Get(root); exist {
|
|
return tr.(Trie).(*trie.SecureTrie).Copy(), nil
|
|
}
|
|
}
|
|
tr, err := trie.NewSecure(root, db.db)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return tr, nil
|
|
}
|
|
|
|
// OpenStorageTrie opens the storage trie of an account.
|
|
func (db *cachingDB) OpenStorageTrie(addrHash, root common.Hash) (Trie, error) {
|
|
if db.noTries {
|
|
return trie.NewEmptyTrie(), nil
|
|
}
|
|
if db.storageTrieCache != nil {
|
|
if tries, exist := db.storageTrieCache.Get(addrHash); exist {
|
|
triesPairs := tries.([3]*triePair)
|
|
for _, triePair := range triesPairs {
|
|
if triePair != nil && triePair.root == root {
|
|
return triePair.trie.(*trie.SecureTrie).Copy(), nil
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
tr, err := trie.NewSecure(root, db.db)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return tr, nil
|
|
}
|
|
|
|
func (db *cachingDB) CacheAccount(root common.Hash, t Trie) {
|
|
if db.accountTrieCache == nil {
|
|
return
|
|
}
|
|
tr := t.(*trie.SecureTrie)
|
|
db.accountTrieCache.Add(root, tr.ResetCopy())
|
|
}
|
|
|
|
func (db *cachingDB) CacheStorage(addrHash common.Hash, root common.Hash, t Trie) {
|
|
if db.storageTrieCache == nil {
|
|
return
|
|
}
|
|
tr := t.(*trie.SecureTrie)
|
|
if tries, exist := db.storageTrieCache.Get(addrHash); exist {
|
|
triesArray := tries.([3]*triePair)
|
|
newTriesArray := [3]*triePair{
|
|
{root: root, trie: tr.ResetCopy()},
|
|
triesArray[0],
|
|
triesArray[1],
|
|
}
|
|
db.storageTrieCache.Add(addrHash, newTriesArray)
|
|
} else {
|
|
triesArray := [3]*triePair{{root: root, trie: tr.ResetCopy()}, nil, nil}
|
|
db.storageTrieCache.Add(addrHash, triesArray)
|
|
}
|
|
}
|
|
|
|
func (db *cachingDB) NoTries() bool {
|
|
return db.noTries
|
|
}
|
|
|
|
func (db *cachingDB) Purge() {
|
|
if db.storageTrieCache != nil {
|
|
db.storageTrieCache.Purge()
|
|
}
|
|
if db.accountTrieCache != nil {
|
|
db.accountTrieCache.Purge()
|
|
}
|
|
}
|
|
|
|
// CopyTrie returns an independent copy of the given trie.
|
|
func (db *cachingDB) CopyTrie(t Trie) Trie {
|
|
if t == nil {
|
|
return nil
|
|
}
|
|
switch t := t.(type) {
|
|
case *trie.SecureTrie:
|
|
return t.Copy()
|
|
case *trie.EmptyTrie:
|
|
return t.Copy()
|
|
default:
|
|
panic(fmt.Errorf("unknown trie type %T", t))
|
|
}
|
|
}
|
|
|
|
// ContractCode retrieves a particular contract's code.
|
|
func (db *cachingDB) ContractCode(addrHash, codeHash common.Hash) ([]byte, error) {
|
|
if cached, ok := db.codeCache.Get(codeHash); ok {
|
|
code := cached.([]byte)
|
|
if len(code) > 0 {
|
|
return code, nil
|
|
}
|
|
}
|
|
code := rawdb.ReadCode(db.db.DiskDB(), codeHash)
|
|
if len(code) > 0 {
|
|
|
|
db.codeCache.Add(codeHash, code)
|
|
db.codeSizeCache.Add(codeHash, len(code))
|
|
return code, nil
|
|
}
|
|
return nil, errors.New("not found")
|
|
}
|
|
|
|
// ContractCodeWithPrefix retrieves a particular contract's code. If the
|
|
// code can't be found in the cache, then check the existence with **new**
|
|
// db scheme.
|
|
func (db *cachingDB) ContractCodeWithPrefix(addrHash, codeHash common.Hash) ([]byte, error) {
|
|
if cached, ok := db.codeCache.Get(codeHash); ok {
|
|
code := cached.([]byte)
|
|
if len(code) > 0 {
|
|
return code, nil
|
|
}
|
|
}
|
|
code := rawdb.ReadCodeWithPrefix(db.db.DiskDB(), codeHash)
|
|
if len(code) > 0 {
|
|
db.codeCache.Add(codeHash, code)
|
|
db.codeSizeCache.Add(codeHash, len(code))
|
|
return code, nil
|
|
}
|
|
return nil, errors.New("not found")
|
|
}
|
|
|
|
// ContractCodeSize retrieves a particular contracts code's size.
|
|
func (db *cachingDB) ContractCodeSize(addrHash, codeHash common.Hash) (int, error) {
|
|
if cached, ok := db.codeSizeCache.Get(codeHash); ok {
|
|
return cached.(int), nil
|
|
}
|
|
code, err := db.ContractCode(addrHash, codeHash)
|
|
return len(code), err
|
|
}
|
|
|
|
// TrieDB retrieves any intermediate trie-node caching layer.
|
|
func (db *cachingDB) TrieDB() *trie.Database {
|
|
return db.db
|
|
}
|