You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
267 lines
7.1 KiB
267 lines
7.1 KiB
package state
|
|
|
|
import (
|
|
"bytes"
|
|
"io/ioutil"
|
|
"sync"
|
|
"time"
|
|
|
|
abci "github.com/tendermint/abci/types"
|
|
cmn "github.com/tendermint/tmlibs/common"
|
|
dbm "github.com/tendermint/tmlibs/db"
|
|
|
|
"github.com/tendermint/go-wire"
|
|
"github.com/tendermint/tendermint/state/txindex"
|
|
"github.com/tendermint/tendermint/state/txindex/null"
|
|
"github.com/tendermint/tendermint/types"
|
|
)
|
|
|
|
var (
|
|
stateKey = []byte("stateKey")
|
|
abciResponsesKey = []byte("abciResponsesKey")
|
|
)
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// NOTE: not goroutine-safe.
|
|
type State struct {
|
|
// mtx for writing to db
|
|
mtx sync.Mutex
|
|
db dbm.DB
|
|
|
|
// should not change
|
|
GenesisDoc *types.GenesisDoc
|
|
ChainID string
|
|
|
|
// updated at end of SetBlockAndValidators
|
|
LastBlockHeight int // Genesis state has this set to 0. So, Block(H=0) does not exist.
|
|
LastBlockID types.BlockID
|
|
LastBlockTime time.Time
|
|
Validators *types.ValidatorSet
|
|
LastValidators *types.ValidatorSet // block.LastCommit validated against this
|
|
|
|
// AppHash is updated after Commit
|
|
AppHash []byte
|
|
|
|
TxIndexer txindex.TxIndexer `json:"-"` // Transaction indexer.
|
|
|
|
// Intermediate results from processing
|
|
// Persisted separately from the state
|
|
abciResponses *ABCIResponses
|
|
}
|
|
|
|
func LoadState(db dbm.DB) *State {
|
|
return loadState(db, stateKey)
|
|
}
|
|
|
|
func loadState(db dbm.DB, key []byte) *State {
|
|
s := &State{db: db, TxIndexer: &null.TxIndex{}}
|
|
buf := db.Get(key)
|
|
if len(buf) == 0 {
|
|
return nil
|
|
} else {
|
|
r, n, err := bytes.NewReader(buf), new(int), new(error)
|
|
wire.ReadBinaryPtr(&s, r, 0, n, err)
|
|
if *err != nil {
|
|
// DATA HAS BEEN CORRUPTED OR THE SPEC HAS CHANGED
|
|
cmn.Exit(cmn.Fmt("LoadState: Data has been corrupted or its spec has changed: %v\n", *err))
|
|
}
|
|
// TODO: ensure that buf is completely read.
|
|
}
|
|
return s
|
|
}
|
|
|
|
func (s *State) Copy() *State {
|
|
return &State{
|
|
db: s.db,
|
|
GenesisDoc: s.GenesisDoc,
|
|
ChainID: s.ChainID,
|
|
LastBlockHeight: s.LastBlockHeight,
|
|
LastBlockID: s.LastBlockID,
|
|
LastBlockTime: s.LastBlockTime,
|
|
Validators: s.Validators.Copy(),
|
|
LastValidators: s.LastValidators.Copy(),
|
|
AppHash: s.AppHash,
|
|
TxIndexer: s.TxIndexer, // pointer here, not value
|
|
}
|
|
}
|
|
|
|
func (s *State) Save() {
|
|
s.mtx.Lock()
|
|
defer s.mtx.Unlock()
|
|
s.db.SetSync(stateKey, s.Bytes())
|
|
}
|
|
|
|
// Sets the ABCIResponses in the state and writes them to disk
|
|
// in case we crash after app.Commit and before s.Save()
|
|
func (s *State) SaveABCIResponses(abciResponses *ABCIResponses) {
|
|
// save the validators to the db
|
|
s.db.SetSync(abciResponsesKey, abciResponses.Bytes())
|
|
}
|
|
|
|
func (s *State) LoadABCIResponses() *ABCIResponses {
|
|
abciResponses := new(ABCIResponses)
|
|
|
|
buf := s.db.Get(abciResponsesKey)
|
|
if len(buf) != 0 {
|
|
r, n, err := bytes.NewReader(buf), new(int), new(error)
|
|
wire.ReadBinaryPtr(abciResponses, r, 0, n, err)
|
|
if *err != nil {
|
|
// DATA HAS BEEN CORRUPTED OR THE SPEC HAS CHANGED
|
|
cmn.Exit(cmn.Fmt("LoadABCIResponses: Data has been corrupted or its spec has changed: %v\n", *err))
|
|
}
|
|
// TODO: ensure that buf is completely read.
|
|
}
|
|
return abciResponses
|
|
}
|
|
|
|
func (s *State) Equals(s2 *State) bool {
|
|
return bytes.Equal(s.Bytes(), s2.Bytes())
|
|
}
|
|
|
|
func (s *State) Bytes() []byte {
|
|
buf, n, err := new(bytes.Buffer), new(int), new(error)
|
|
wire.WriteBinary(s, buf, n, err)
|
|
if *err != nil {
|
|
cmn.PanicCrisis(*err)
|
|
}
|
|
return buf.Bytes()
|
|
}
|
|
|
|
// Mutate state variables to match block and validators
|
|
// after running EndBlock
|
|
func (s *State) SetBlockAndValidators(header *types.Header, blockPartsHeader types.PartSetHeader, abciResponses *ABCIResponses) {
|
|
|
|
// copy the valset so we can apply changes from EndBlock
|
|
// and update s.LastValidators and s.Validators
|
|
prevValSet := s.Validators.Copy()
|
|
nextValSet := prevValSet.Copy()
|
|
|
|
// update the validator set with the latest abciResponses
|
|
err := updateValidators(nextValSet, abciResponses.EndBlock.Diffs)
|
|
if err != nil {
|
|
log.Warn("Error changing validator set", "error", err)
|
|
// TODO: err or carry on?
|
|
}
|
|
// Update validator accums and set state variables
|
|
nextValSet.IncrementAccum(1)
|
|
|
|
s.setBlockAndValidators(header.Height,
|
|
types.BlockID{header.Hash(), blockPartsHeader}, header.Time,
|
|
prevValSet, nextValSet)
|
|
}
|
|
|
|
func (s *State) setBlockAndValidators(
|
|
height int, blockID types.BlockID, blockTime time.Time,
|
|
prevValSet, nextValSet *types.ValidatorSet) {
|
|
|
|
s.LastBlockHeight = height
|
|
s.LastBlockID = blockID
|
|
s.LastBlockTime = blockTime
|
|
s.Validators = nextValSet
|
|
s.LastValidators = prevValSet
|
|
}
|
|
|
|
func (s *State) GetValidators() (*types.ValidatorSet, *types.ValidatorSet) {
|
|
return s.LastValidators, s.Validators
|
|
}
|
|
|
|
// Load the most recent state from "state" db,
|
|
// or create a new one (and save) from genesis.
|
|
func GetState(stateDB dbm.DB, genesisFile string) *State {
|
|
state := LoadState(stateDB)
|
|
if state == nil {
|
|
state = MakeGenesisStateFromFile(stateDB, genesisFile)
|
|
state.Save()
|
|
}
|
|
|
|
return state
|
|
}
|
|
|
|
//--------------------------------------------------
|
|
// ABCIResponses holds intermediate state during block processing
|
|
|
|
type ABCIResponses struct {
|
|
Height int
|
|
|
|
DeliverTx []*abci.ResponseDeliverTx
|
|
EndBlock abci.ResponseEndBlock
|
|
|
|
txs types.Txs // reference for indexing results by hash
|
|
}
|
|
|
|
func NewABCIResponses(block *types.Block) *ABCIResponses {
|
|
return &ABCIResponses{
|
|
Height: block.Height,
|
|
DeliverTx: make([]*abci.ResponseDeliverTx, block.NumTxs),
|
|
txs: block.Data.Txs,
|
|
}
|
|
}
|
|
|
|
// Serialize the ABCIResponse
|
|
func (a *ABCIResponses) Bytes() []byte {
|
|
buf, n, err := new(bytes.Buffer), new(int), new(error)
|
|
wire.WriteBinary(*a, buf, n, err)
|
|
if *err != nil {
|
|
cmn.PanicCrisis(*err)
|
|
}
|
|
return buf.Bytes()
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Genesis
|
|
|
|
// MakeGenesisStateFromFile reads and unmarshals state from the given file.
|
|
//
|
|
// Used during replay and in tests.
|
|
func MakeGenesisStateFromFile(db dbm.DB, genDocFile string) *State {
|
|
genDocJSON, err := ioutil.ReadFile(genDocFile)
|
|
if err != nil {
|
|
cmn.Exit(cmn.Fmt("Couldn't read GenesisDoc file: %v", err))
|
|
}
|
|
genDoc, err := types.GenesisDocFromJSON(genDocJSON)
|
|
if err != nil {
|
|
cmn.Exit(cmn.Fmt("Error reading GenesisDoc: %v", err))
|
|
}
|
|
return MakeGenesisState(db, genDoc)
|
|
}
|
|
|
|
// MakeGenesisState creates state from types.GenesisDoc.
|
|
//
|
|
// Used in tests.
|
|
func MakeGenesisState(db dbm.DB, genDoc *types.GenesisDoc) *State {
|
|
if len(genDoc.Validators) == 0 {
|
|
cmn.Exit(cmn.Fmt("The genesis file has no validators"))
|
|
}
|
|
|
|
if genDoc.GenesisTime.IsZero() {
|
|
genDoc.GenesisTime = time.Now()
|
|
}
|
|
|
|
// Make validators slice
|
|
validators := make([]*types.Validator, len(genDoc.Validators))
|
|
for i, val := range genDoc.Validators {
|
|
pubKey := val.PubKey
|
|
address := pubKey.Address()
|
|
|
|
// Make validator
|
|
validators[i] = &types.Validator{
|
|
Address: address,
|
|
PubKey: pubKey,
|
|
VotingPower: val.Amount,
|
|
}
|
|
}
|
|
|
|
return &State{
|
|
db: db,
|
|
GenesisDoc: genDoc,
|
|
ChainID: genDoc.ChainID,
|
|
LastBlockHeight: 0,
|
|
LastBlockID: types.BlockID{},
|
|
LastBlockTime: genDoc.GenesisTime,
|
|
Validators: types.NewValidatorSet(validators),
|
|
LastValidators: types.NewValidatorSet(nil),
|
|
AppHash: genDoc.AppHash,
|
|
TxIndexer: &null.TxIndex{}, // we do not need indexer during replay and in tests
|
|
}
|
|
}
|