github.com/linapex/ethereum-dpos-chinese@v0.0.0-20190316121959-b78b3a4a1ece/core/state/database.go

//<developer>
//    <name>linapex 曹一峰</name>
//    <email>linapex@163.com</email>
//    <wx>superexc</wx>
//    <qqgroup>128148617</qqgroup>
//    <url>https://jsq.ink</url>
//    <role>pku engineer</role>
//    <date>2019-03-16 12:09:34</date>
//</624342617307484160>


package state

import (
	"fmt"
	"sync"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/ethereum/go-ethereum/trie"
	lru "github.com/hashicorp/golang-lru"
)

//trie缓存生成限制，在此之后将trie节点从内存中逐出。
var MaxTrieCacheGen = uint16(120)

const (
//要保留的过去尝试次数。此值的选择方式如下：
//合理的链条重铺深度将达到现有的三重。
	maxPastTries = 12

//要保留的codehash->大小关联数。
	codeSizeCacheSize = 100000
)

//数据库将访问权限包装为“尝试”和“合同代码”。
type Database interface {
//opentrie打开主帐户trie。
	OpenTrie(root common.Hash) (Trie, error)

//openstoragetrie打开帐户的存储trie。
	OpenStorageTrie(addrHash, root common.Hash) (Trie, error)

//copy trie返回给定trie的独立副本。
	CopyTrie(Trie) Trie

//ContractCode检索特定合同的代码。
	ContractCode(addrHash, codeHash common.Hash) ([]byte, error)

//ContractCodeSize检索特定合同代码的大小。
	ContractCodeSize(addrHash, codeHash common.Hash) (int, error)

//triedb检索用于数据存储的低级trie数据库。
	TrieDB() *trie.Database
}

//特里亚是以太梅克尔特里亚。
type Trie interface {
	TryGet(key []byte) ([]byte, error)
	TryUpdate(key, value []byte) error
	TryDelete(key []byte) error
	Commit(onleaf trie.LeafCallback) (common.Hash, error)
	Hash() common.Hash
	NodeIterator(startKey []byte) trie.NodeIterator
GetKey([]byte) []byte //TODO（FJL）：移除SecureTrie时移除此项
	Prove(key []byte, fromLevel uint, proofDb ethdb.Putter) error
}

//NeXDATA为状态创建后备存储。返回的数据库是安全的
//同时使用并将缓存的trie节点保留在内存中。游泳池是可选的
//在低级存储层和
//高级Trie抽象。
func NewDatabase(db ethdb.Database) Database {
	csc, _ := lru.New(codeSizeCacheSize)
	return &cachingDB{
		db:            trie.NewDatabase(db),
		codeSizeCache: csc,
	}
}

type cachingDB struct {
	db            *trie.Database
	mu            sync.Mutex
	pastTries     []*trie.SecureTrie
	codeSizeCache *lru.Cache
}

//opentrie打开主帐户trie。
func (db *cachingDB) OpenTrie(root common.Hash) (Trie, error) {
	db.mu.Lock()
	defer db.mu.Unlock()

	for i := len(db.pastTries) - 1; i >= 0; i-- {
		if db.pastTries[i].Hash() == root {
			return cachedTrie{db.pastTries[i].Copy(), db}, nil
		}
	}
	tr, err := trie.NewSecure(root, db.db, MaxTrieCacheGen)
	if err != nil {
		return nil, err
	}
	return cachedTrie{tr, db}, nil
}

func (db *cachingDB) pushTrie(t *trie.SecureTrie) {
	db.mu.Lock()
	defer db.mu.Unlock()

	if len(db.pastTries) >= maxPastTries {
		copy(db.pastTries, db.pastTries[1:])
		db.pastTries[len(db.pastTries)-1] = t
	} else {
		db.pastTries = append(db.pastTries, t)
	}
}

//openstoragetrie打开帐户的存储trie。
func (db *cachingDB) OpenStorageTrie(addrHash, root common.Hash) (Trie, error) {
	return trie.NewSecure(root, db.db, 0)
}

//copy trie返回给定trie的独立副本。
func (db *cachingDB) CopyTrie(t Trie) Trie {
	switch t := t.(type) {
	case cachedTrie:
		return cachedTrie{t.SecureTrie.Copy(), db}
	case *trie.SecureTrie:
		return t.Copy()
	default:
		panic(fmt.Errorf("unknown trie type %T", t))
	}
}

//ContractCode检索特定合同的代码。
func (db *cachingDB) ContractCode(addrHash, codeHash common.Hash) ([]byte, error) {
	code, err := db.db.Node(codeHash)
	if err == nil {
		db.codeSizeCache.Add(codeHash, len(code))
	}
	return code, err
}

//ContractCodeSize检索特定合同代码的大小。
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检索任何中间trie节点缓存层。
func (db *cachingDB) TrieDB() *trie.Database {
	return db.db
}

//cachedtrie在提交时将其trie插入cachingdb。
type cachedTrie struct {
	*trie.SecureTrie
	db *cachingDB
}

func (m cachedTrie) Commit(onleaf trie.LeafCallback) (common.Hash, error) {
	root, err := m.SecureTrie.Commit(onleaf)
	if err == nil {
		m.db.pushTrie(m.SecureTrie)
	}
	return root, err
}

func (m cachedTrie) Prove(key []byte, fromLevel uint, proofDb ethdb.Putter) error {
	return m.SecureTrie.Prove(key, fromLevel, proofDb)
}