package state import ( "bytes" "fmt" "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/tmlibs/log" wire "github.com/tendermint/go-wire" "github.com/tendermint/tendermint/types" ) var ( stateKey = []byte("stateKey") abciResponsesKey = []byte("abciResponsesKey") ) func calcValidatorsKey(height int64) []byte { return []byte(cmn.Fmt("validatorsKey:%v", height)) } //----------------------------------------------------------------------------- // State represents the latest committed state of the Tendermint consensus, // including the last committed block and validator set. // Newly committed blocks are validated and executed against the State. // NOTE: not goroutine-safe. type State struct { // mtx for writing to db mtx sync.Mutex db dbm.DB ChainID string // Consensus parameters used for validating blocks Params types.ConsensusParams // These fields are updated by SetBlockAndValidators. // LastBlockHeight=0 at genesis (ie. block(H=0) does not exist) // LastValidators is used to validate block.LastCommit. LastBlockHeight int64 LastBlockTotalTx int64 LastBlockID types.BlockID LastBlockTime time.Time Validators *types.ValidatorSet LastValidators *types.ValidatorSet // When a block returns a validator set change via EndBlock, // the change only applies to the next block. // So, if s.LastBlockHeight causes a valset change, // we set s.LastHeightValidatorsChanged = s.LastBlockHeight + 1 LastHeightValidatorsChanged int64 // AppHash is updated after Commit AppHash []byte // LastConsensusHash is updated after Commit LastConsensusHash []byte logger log.Logger } // GetState loads the most recent state from the database, // or creates a new one from the given genesisFile and persists the result // to the database. func GetState(stateDB dbm.DB, genesisFile string) (*State, error) { state := LoadState(stateDB) if state == nil { var err error state, err = MakeGenesisStateFromFile(stateDB, genesisFile) if err != nil { return nil, err } state.Save() } return state, nil } // LoadState loads the State from the database. func LoadState(db dbm.DB) *State { return loadState(db, stateKey) } func loadState(db dbm.DB, key []byte) *State { buf := db.Get(key) if len(buf) == 0 { return nil } s := &State{db: db} 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 } // SetLogger sets the logger on the State. func (s *State) SetLogger(l log.Logger) { s.logger = l } // Copy makes a copy of the State for mutating. func (s *State) Copy() *State { return &State{ db: s.db, LastBlockHeight: s.LastBlockHeight, LastBlockTotalTx: s.LastBlockTotalTx, LastBlockID: s.LastBlockID, LastBlockTime: s.LastBlockTime, Validators: s.Validators.Copy(), LastValidators: s.LastValidators.Copy(), AppHash: s.AppHash, LastConsensusHash: s.LastConsensusHash, LastHeightValidatorsChanged: s.LastHeightValidatorsChanged, logger: s.logger, ChainID: s.ChainID, Params: s.Params, } } // Save persists the State to the database. func (s *State) Save() { s.mtx.Lock() defer s.mtx.Unlock() s.saveValidatorsInfo() s.db.SetSync(stateKey, s.Bytes()) } // SaveABCIResponses persists the ABCIResponses to the database. // This is useful in case we crash after app.Commit and before s.Save(). func (s *State) SaveABCIResponses(abciResponses *ABCIResponses) { s.db.SetSync(abciResponsesKey, abciResponses.Bytes()) } // LoadABCIResponses loads the ABCIResponses from the database. // This is useful for recovering from crashes where we called app.Commit and before we called // s.Save() func (s *State) LoadABCIResponses() *ABCIResponses { buf := s.db.Get(abciResponsesKey) if len(buf) == 0 { return nil } abciResponses := new(ABCIResponses) 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 } // LoadValidators loads the ValidatorSet for a given height. func (s *State) LoadValidators(height int64) (*types.ValidatorSet, error) { valInfo := s.loadValidators(height) if valInfo == nil { return nil, ErrNoValSetForHeight{height} } if valInfo.ValidatorSet == nil { valInfo = s.loadValidators(valInfo.LastHeightChanged) if valInfo == nil { cmn.PanicSanity(fmt.Sprintf(`Couldn't find validators at height %d as last changed from height %d`, valInfo.LastHeightChanged, height)) } } return valInfo.ValidatorSet, nil } func (s *State) loadValidators(height int64) *ValidatorsInfo { buf := s.db.Get(calcValidatorsKey(height)) if len(buf) == 0 { return nil } v := new(ValidatorsInfo) r, n, err := bytes.NewReader(buf), new(int), new(error) wire.ReadBinaryPtr(v, r, 0, n, err) if *err != nil { // DATA HAS BEEN CORRUPTED OR THE SPEC HAS CHANGED cmn.Exit(cmn.Fmt(`LoadValidators: Data has been corrupted or its spec has changed: %v\n`, *err)) } // TODO: ensure that buf is completely read. return v } // saveValidatorsInfo persists the validator set for the next block to disk. // It should be called from s.Save(), right before the state itself is persisted. // If the validator set did not change after processing the latest block, // only the last height for which the validators changed is persisted. func (s *State) saveValidatorsInfo() { changeHeight := s.LastHeightValidatorsChanged nextHeight := s.LastBlockHeight + 1 valInfo := &ValidatorsInfo{ LastHeightChanged: changeHeight, } if changeHeight == nextHeight { valInfo.ValidatorSet = s.Validators } s.db.SetSync(calcValidatorsKey(nextHeight), valInfo.Bytes()) } // Equals returns true if the States are identical. func (s *State) Equals(s2 *State) bool { return bytes.Equal(s.Bytes(), s2.Bytes()) } // Bytes serializes the State using go-wire. func (s *State) Bytes() []byte { return wire.BinaryBytes(s) } // SetBlockAndValidators mutates State variables // to update 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 if len(abciResponses.EndBlock.ValidatorUpdates) > 0 { err := updateValidators(nextValSet, abciResponses.EndBlock.ValidatorUpdates) if err != nil { s.logger.Error("Error changing validator set", "err", err) // TODO: err or carry on? } // change results from this height but only applies to the next height s.LastHeightValidatorsChanged = header.Height + 1 } // Update validator accums and set state variables nextValSet.IncrementAccum(1) nextParams := applyUpdates(s.Params, abciResponses.EndBlock.ConsensusParamUpdates) err := nextParams.Validate() if err != nil { s.logger.Error("Error updating consensus params", "err", err) // TODO: err or carry on? nextParams = s.Params } s.setBlockAndValidators(header.Height, header.NumTxs, types.BlockID{header.Hash(), blockPartsHeader}, header.Time, prevValSet, nextValSet, nextParams) } // applyUpdates returns new ConsensusParams // whose fields are set to any non-zero fields of c. // If c is nil, it returns p unmodified, as it was passed in. func applyUpdates(p types.ConsensusParams, c *abci.ConsensusParams) types.ConsensusParams { if c == nil { return p } res := p // we must defensively consider any structs may be nil if c.BlockSize != nil { if c.BlockSize.MaxBytes != 0 { res.BlockSize.MaxBytes = int(c.BlockSize.MaxBytes) } if c.BlockSize.MaxTxs != 0 { res.BlockSize.MaxTxs = int(c.BlockSize.MaxTxs) } if c.BlockSize.MaxGas != 0 { res.BlockSize.MaxGas = int(c.BlockSize.MaxGas) } } if c.TxSize != nil { if c.TxSize.MaxBytes != 0 { res.TxSize.MaxBytes = int(c.TxSize.MaxBytes) } if c.TxSize.MaxGas != 0 { res.TxSize.MaxGas = int(c.TxSize.MaxGas) } } if c.BlockGossip != nil { if c.BlockGossip.BlockPartSizeBytes != 0 { res.BlockGossip.BlockPartSizeBytes = int(c.BlockGossip.BlockPartSizeBytes) } } return res } func (s *State) setBlockAndValidators(height int64, newTxs int64, blockID types.BlockID, blockTime time.Time, prevValSet, nextValSet *types.ValidatorSet, nextParams types.ConsensusParams) { s.LastBlockHeight = height s.LastBlockTotalTx += newTxs s.LastBlockID = blockID s.LastBlockTime = blockTime s.Validators = nextValSet s.LastValidators = prevValSet s.LastConsensusHash = s.Params.Hash() s.Params = nextParams } // GetValidators returns the last and current validator sets. func (s *State) GetValidators() (last *types.ValidatorSet, current *types.ValidatorSet) { return s.LastValidators, s.Validators } //------------------------------------------------------------------------ // ABCIResponses retains the responses of the various ABCI calls during block processing. // It is persisted to disk before calling Commit. type ABCIResponses struct { Height int64 DeliverTx []*abci.ResponseDeliverTx EndBlock *abci.ResponseEndBlock txs types.Txs // reference for indexing results by hash } // NewABCIResponses returns a new ABCIResponses func NewABCIResponses(block *types.Block) *ABCIResponses { return &ABCIResponses{ Height: block.Height, DeliverTx: make([]*abci.ResponseDeliverTx, block.NumTxs), txs: block.Data.Txs, } } // Bytes serializes the ABCIResponse using go-wire func (a *ABCIResponses) Bytes() []byte { return wire.BinaryBytes(*a) } //----------------------------------------------------------------------------- // ValidatorsInfo represents the latest validator set, or the last height it changed type ValidatorsInfo struct { ValidatorSet *types.ValidatorSet LastHeightChanged int64 } // Bytes serializes the ValidatorsInfo using go-wire func (valInfo *ValidatorsInfo) Bytes() []byte { return wire.BinaryBytes(*valInfo) } //------------------------------------------------------------------------ // Genesis // MakeGenesisStateFromFile reads and unmarshals state from the given // file. // // Used during replay and in tests. func MakeGenesisStateFromFile(db dbm.DB, genDocFile string) (*State, error) { genDoc, err := MakeGenesisDocFromFile(genDocFile) if err != nil { return nil, err } return MakeGenesisState(db, genDoc) } // MakeGenesisDocFromFile reads and unmarshals genesis doc from the given file. func MakeGenesisDocFromFile(genDocFile string) (*types.GenesisDoc, error) { genDocJSON, err := ioutil.ReadFile(genDocFile) if err != nil { return nil, fmt.Errorf("Couldn't read GenesisDoc file: %v", err) } genDoc, err := types.GenesisDocFromJSON(genDocJSON) if err != nil { return nil, fmt.Errorf("Error reading GenesisDoc: %v", err) } return genDoc, nil } // MakeGenesisState creates state from types.GenesisDoc. func MakeGenesisState(db dbm.DB, genDoc *types.GenesisDoc) (*State, error) { err := genDoc.ValidateAndComplete() if err != nil { return nil, fmt.Errorf("Error in genesis file: %v", err) } // 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.Power, } } return &State{ db: db, ChainID: genDoc.ChainID, Params: *genDoc.ConsensusParams, LastBlockHeight: 0, LastBlockID: types.BlockID{}, LastBlockTime: genDoc.GenesisTime, Validators: types.NewValidatorSet(validators), LastValidators: types.NewValidatorSet(nil), AppHash: genDoc.AppHash, LastConsensusHash: genDoc.ConsensusParams.Hash(), LastHeightValidatorsChanged: 1, }, nil }