blockchain_cache.go

// Copyright 2021 The Alaya Network Authors
// This file is part of the Alaya-Go library.
//
// The Alaya-Go 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 Alaya-Go 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 Alaya-Go library. If not, see <http://www.gnu.org/licenses/>.

package core

import (
	"errors"
	"fmt"
	"sort"
	"sync"
	"time"

	"github.com/AlayaNetwork/Alaya-Go/metrics"

	"github.com/AlayaNetwork/Alaya-Go/common"
	"github.com/AlayaNetwork/Alaya-Go/consensus"
	"github.com/AlayaNetwork/Alaya-Go/core/state"
	"github.com/AlayaNetwork/Alaya-Go/core/types"
	"github.com/AlayaNetwork/Alaya-Go/log"
)

var (
	errMakeStateDB = errors.New("make StateDB error")

	blockExecutedGauage = metrics.NewRegisteredGauge("cbft/gauage/block/executed", nil)
)

type BlockChainCache struct {
	*BlockChain
	stateDBCache  map[common.Hash]*stateDBCache  // key is header SealHash
	receiptsCache map[common.Hash]*receiptsCache // key is header SealHash
	stateDBMu     sync.RWMutex
	receiptsMu    sync.RWMutex

	executing sync.Mutex
	executed  sync.Map
}

type stateDBCache struct {
	stateDB  *state.StateDB
	blockNum uint64
}

type receiptsCache struct {
	receipts []*types.Receipt
	blockNum uint64
}

func (pbc *BlockChainCache) CurrentBlock() *types.Block {
	block := pbc.Engine().CurrentBlock()
	if block != nil {
		return block
	}
	return pbc.currentBlock.Load().(*types.Block)
}

func (pbc *BlockChainCache) GetBlock(hash common.Hash, number uint64) *types.Block {
	var block *types.Block
	if cbft, ok := pbc.Engine().(consensus.Bft); ok {
		log.Trace("Find block in cbft", "hash", hash, "number", number)
		block = cbft.GetBlock(hash, number)
	}
	if block == nil {
		log.Trace("Cannot find block in cbft, try to find it in chain", "hash", hash, "number", number)
		block = pbc.getBlock(hash, number)
		if block == nil {
			log.Trace("Cannot find block in chain", "hash", hash, "number", number)
		}
	}
	return block
}

func (pbc *BlockChainCache) GetBlockInMemory(hash common.Hash, number uint64) *types.Block {
	var block *types.Block
	if cbft, ok := pbc.Engine().(consensus.Bft); ok {
		log.Trace("find block in cbft", "hash", hash, "number", number)
		block = cbft.GetBlockWithoutLock(hash, number)
	}
	if block == nil {
		log.Trace("cannot find block in cbft, try to find it in chain", "hash", hash, "number", number)
		block = pbc.getBlock(hash, number)
		if block == nil {
			log.Trace("cannot find block in chain", "hash", hash, "number", number)
		}
	}
	return block
}

func NewBlockChainCache(blockChain *BlockChain) *BlockChainCache {
	pbc := &BlockChainCache{}
	pbc.BlockChain = blockChain
	pbc.stateDBCache = make(map[common.Hash]*stateDBCache)
	pbc.receiptsCache = make(map[common.Hash]*receiptsCache)

	return pbc
}

// Read the Receipt collection from the cache map.
func (bcc *BlockChainCache) ReadReceipts(sealHash common.Hash) []*types.Receipt {
	bcc.receiptsMu.RLock()
	defer bcc.receiptsMu.RUnlock()
	if obj, exist := bcc.receiptsCache[sealHash]; exist {
		return obj.receipts
	}
	return nil
}

// GetState returns a new mutable state based on a particular point in time.
func (bcc *BlockChainCache) GetState(header *types.Header) (*state.StateDB, error) {
	state, err := bcc.MakeStateDBByHeader(header)
	if err == nil {
		return state, nil
	} else {
		return bcc.StateAt(header.Root)
	}
}

// Read the StateDB instance from the cache map
func (pbc *BlockChainCache) ReadStateDB(sealHash common.Hash) *state.StateDB {
	pbc.stateDBMu.RLock()
	defer pbc.stateDBMu.RUnlock()
	if obj, exist := pbc.stateDBCache[sealHash]; exist {
		log.Debug("Read the StateDB instance from the cache map", "sealHash", sealHash)
		return obj.stateDB.Copy()
	}
	return nil
}

func (pbc *BlockChainCache) ReadOnlyStateDB(sealHash common.Hash) *state.StateDB {
	pbc.stateDBMu.RLock()
	defer pbc.stateDBMu.RUnlock()
	if obj, exist := pbc.stateDBCache[sealHash]; exist {
		log.Debug("Read the StateDB instance from the cache map", "sealHash", sealHash)
		return obj.stateDB
	}
	return nil
}

// Write Receipt to the cache
func (pbc *BlockChainCache) WriteReceipts(sealHash common.Hash, receipts []*types.Receipt, blockNum uint64) {
	pbc.receiptsMu.Lock()
	defer pbc.receiptsMu.Unlock()
	_, exist := pbc.receiptsCache[sealHash]
	if !exist {
		pbc.receiptsCache[sealHash] = &receiptsCache{receipts: receipts, blockNum: blockNum}
	}
}

// Write a StateDB instance to the cache
func (bcc *BlockChainCache) WriteStateDB(sealHash common.Hash, stateDB *state.StateDB, blockNum uint64) {
	bcc.stateDBMu.Lock()
	defer bcc.stateDBMu.Unlock()
	log.Info("Write a StateDB instance to the cache", "sealHash", sealHash, "blockNum", blockNum)
	if _, exist := bcc.stateDBCache[sealHash]; !exist {
		bcc.stateDBCache[sealHash] = &stateDBCache{stateDB: stateDB, blockNum: blockNum}
	}
}

// Read the Receipt collection from the cache map
func (bcc *BlockChainCache) clearReceipts(sealHash common.Hash) {
	bcc.receiptsMu.Lock()
	defer bcc.receiptsMu.Unlock()

	//var blockNum uint64
	if obj, exist := bcc.receiptsCache[sealHash]; exist {
		//blockNum = obj.blockNum
		log.Debug("Clear Receipts", "sealHash", sealHash, "number", obj.blockNum)
		delete(bcc.receiptsCache, sealHash)
	}
	//for hash, obj := range bcc.receiptsCache {
	//	if obj.blockNum < blockNum {
	//		delete(bcc.receiptsCache, hash)
	//	}
	//}
}

// Read the StateDB instance from the cache map
func (bcc *BlockChainCache) clearStateDB(sealHash common.Hash) {
	bcc.stateDBMu.Lock()
	defer bcc.stateDBMu.Unlock()

	if obj, exist := bcc.stateDBCache[sealHash]; exist {
		obj.stateDB.ClearReference()
		log.Debug("Clear StateDB", "sealHash", sealHash, "number", obj.blockNum)
		delete(bcc.stateDBCache, sealHash)
		//delete(pbc.stateDBCache, sealHash)
	}
	//for hash, obj := range bcc.stateDBCache {
	//	if obj.blockNum < blockNum {
	//		obj.stateDB.ClearReference()
	//		log.Debug("Clear StateDB", "sealHash", hash, "number", obj.blockNum)
	//		delete(bcc.stateDBCache, hash)
	//	}
	//}
}

// Get the StateDB instance of the corresponding block
func (bcc *BlockChainCache) MakeStateDB(block *types.Block) (*state.StateDB, error) {
	log.Info("Make stateDB", "hash", block.Hash(), "number", block.NumberU64(), "root", block.Root())
	return bcc.MakeStateDBByHeader(block.Header())
}

func (bcc *BlockChainCache) MakeStateDBByHeader(header *types.Header) (*state.StateDB, error) {
	// Read and copy the stateDB instance in the cache
	sealHash, number, root := header.SealHash(), header.Number.Uint64(), header.Root
	if state := bcc.ReadOnlyStateDB(sealHash); state != nil {
		statedb := state.NewStateDB()
		if number > 1 && !statedb.HadParent() {
			panic(fmt.Sprintf("parent is nil:%d", number))
		}

		return statedb, nil
	} else if state, err := bcc.StateAt(root); err == nil && state != nil {
		// Create a StateDB instance from the blockchain based on stateRoot
		return state, nil
	}
	return nil, errMakeStateDB
}

// Get the StateDB instance of the corresponding block
func (bcc *BlockChainCache) ClearCache(block *types.Block) {
	baseNumber := block.NumberU64()
	if baseNumber < 1 {
		return
	}
	log.Debug("Clear cache", "baseBlockHash", block.Hash(), "baseBlockNumber", baseNumber)

	var sh sealHashSort
	bcc.executed.Range(func(key, value interface{}) bool {
		number := value.(uint64)
		if number < baseNumber-1 {
			sealHash := key.(common.Hash)
			sh = append(sh, &sealHashNumber{number: number, hash: sealHash})

		}
		return true
	})
	sort.Sort(sh)
	for _, s := range sh {
		log.Debug("Clear Cache block", "sealHash", s.hash, "number", s.number)
		bcc.clearReceipts(s.hash)
		bcc.clearStateDB(s.hash)
		bcc.executed.Delete(s.hash)
	}
}

func (bcc *BlockChainCache) StateDBString() string {
	status := fmt.Sprintf("[")
	for hash, obj := range bcc.stateDBCache {
		status += fmt.Sprintf("[%s, %d]", hash, obj.blockNum)
	}
	status += fmt.Sprintf("]")
	return status
}

func (bcc *BlockChainCache) Execute(block *types.Block, parent *types.Block) error {
	executed := func() bool {
		if number, ok := bcc.executed.Load(block.Header().SealHash()); ok && number.(uint64) == block.Number().Uint64() {
			log.Debug("Block has executed", "number", block.Number(), "hash", block.Hash(), "parentNumber", parent.Number(), "parentHash", parent.Hash())
			return true
		}
		return false
	}

	if executed() {
		return nil
	}

	bcc.executing.Lock()
	defer bcc.executing.Unlock()
	if executed() {
		return nil
	}
	SenderCacher.RecoverFromBlock(types.NewEIP155Signer(bcc.chainConfig.ChainID), block)

	log.Debug("Start execute block", "hash", block.Hash(), "number", block.Number(), "sealHash", block.Header().SealHash())
	start := time.Now()
	state, err := bcc.MakeStateDB(parent)
	elapse := time.Since(start)
	if err != nil {
		return errors.New("execute block error")
	}

	t := time.Now()
	//to execute
	receipts, err := bcc.ProcessDirectly(block, state, parent)
	log.Debug("Execute block", "number", block.Number(), "hash", block.Hash(),
		"parentNumber", parent.Number(), "parentHash", parent.Hash(), "duration", time.Since(t), "makeState", elapse, "err", err)
	if err == nil {
		//save the receipts and state to consensusCache
		sealHash := block.Header().SealHash()
		bcc.WriteReceipts(sealHash, receipts, block.NumberU64())
		bcc.WriteStateDB(sealHash, state, block.NumberU64())
		bcc.executed.Store(block.Header().SealHash(), block.Number().Uint64())
	} else {
		return fmt.Errorf("execute block error, err:%s", err.Error())
	}
	blockExecutedGauage.Update(common.Millis(time.Now()) - common.Millis(start))
	return nil
}

func (bcc *BlockChainCache) AddSealBlock(hash common.Hash, number uint64) {
	bcc.executed.Store(hash, number)
}

func (bcc *BlockChainCache) WriteBlock(block *types.Block) error {
	sealHash := block.Header().SealHash()
	state := bcc.ReadStateDB(sealHash)
	receipts := bcc.ReadReceipts(sealHash)

	if state == nil {
		log.Error("Write Block error, state is nil", "number", block.NumberU64(), "hash", block.Hash())
		return fmt.Errorf("write Block error, state is nil, number:%d, hash:%s", block.NumberU64(), block.Hash().String())
	} else if len(block.Transactions()) > 0 && len(receipts) == 0 {
		log.Error("Write Block error, block has transactions but receipts is nil", "number", block.NumberU64(), "hash", block.Hash())
		return fmt.Errorf("write Block error, block has transactions but receipts is nil, number:%d, hash:%s", block.NumberU64(), block.Hash().String())
	}

	// Different block could share same sealhash, deep copy here to prevent write-write conflict.
	var _receipts = make([]*types.Receipt, len(receipts))
	for i, receipt := range receipts {
		_receipts[i] = new(types.Receipt)
		*_receipts[i] = *receipt
	}
	// Commit block and state to database.
	//block.SetExtraData(extraData)
	log.Debug("Write extra data", "txs", len(block.Transactions()), "extra", len(block.ExtraData()))
	_, err := bcc.WriteBlockWithState(block, _receipts, state)
	if err != nil {
		log.Error("Failed writing block to chain", "hash", block.Hash(), "number", block.NumberU64(), "err", err)
		return fmt.Errorf("failed writing block to chain, number:%d, hash:%s, err:%s", block.NumberU64(), block.Hash().String(), err.Error())
	}

	log.Info("Successfully write new block", "hash", block.Hash(), "number", block.NumberU64())
	return nil
}

type sealHashNumber struct {
	number uint64
	hash   common.Hash
}

type sealHashSort []*sealHashNumber

func (self sealHashSort) Len() int { return len(self) }
func (self sealHashSort) Swap(i, j int) {
	self[i], self[j] = self[j], self[i]
}
func (self sealHashSort) Less(i, j int) bool { return self[i].number < self[j].number }