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.
2127 lines
67 KiB
2127 lines
67 KiB
package consensus
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"reflect"
|
|
"runtime/debug"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/gogo/protobuf/proto"
|
|
|
|
cfg "github.com/tendermint/tendermint/config"
|
|
cstypes "github.com/tendermint/tendermint/consensus/types"
|
|
tmevents "github.com/tendermint/tendermint/libs/events"
|
|
"github.com/tendermint/tendermint/libs/fail"
|
|
tmjson "github.com/tendermint/tendermint/libs/json"
|
|
"github.com/tendermint/tendermint/libs/log"
|
|
tmmath "github.com/tendermint/tendermint/libs/math"
|
|
tmos "github.com/tendermint/tendermint/libs/os"
|
|
"github.com/tendermint/tendermint/libs/service"
|
|
"github.com/tendermint/tendermint/p2p"
|
|
tmproto "github.com/tendermint/tendermint/proto/types"
|
|
sm "github.com/tendermint/tendermint/state"
|
|
"github.com/tendermint/tendermint/types"
|
|
tmtime "github.com/tendermint/tendermint/types/time"
|
|
)
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Errors
|
|
|
|
var (
|
|
ErrInvalidProposalSignature = errors.New("error invalid proposal signature")
|
|
ErrInvalidProposalPOLRound = errors.New("error invalid proposal POL round")
|
|
ErrAddingVote = errors.New("error adding vote")
|
|
)
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
var (
|
|
msgQueueSize = 1000
|
|
)
|
|
|
|
// msgs from the reactor which may update the state
|
|
type msgInfo struct {
|
|
Msg Message `json:"msg"`
|
|
PeerID p2p.ID `json:"peer_key"`
|
|
}
|
|
|
|
// internally generated messages which may update the state
|
|
type timeoutInfo struct {
|
|
Duration time.Duration `json:"duration"`
|
|
Height int64 `json:"height"`
|
|
Round int32 `json:"round"`
|
|
Step cstypes.RoundStepType `json:"step"`
|
|
}
|
|
|
|
func (ti *timeoutInfo) String() string {
|
|
return fmt.Sprintf("%v ; %d/%d %v", ti.Duration, ti.Height, ti.Round, ti.Step)
|
|
}
|
|
|
|
// interface to the mempool
|
|
type txNotifier interface {
|
|
TxsAvailable() <-chan struct{}
|
|
}
|
|
|
|
// interface to the evidence pool
|
|
type evidencePool interface {
|
|
AddEvidence(types.Evidence) error
|
|
AddPOLC(types.ProofOfLockChange) error
|
|
}
|
|
|
|
// State handles execution of the consensus algorithm.
|
|
// It processes votes and proposals, and upon reaching agreement,
|
|
// commits blocks to the chain and executes them against the application.
|
|
// The internal state machine receives input from peers, the internal validator, and from a timer.
|
|
type State struct {
|
|
service.BaseService
|
|
|
|
// config details
|
|
config *cfg.ConsensusConfig
|
|
privValidator types.PrivValidator // for signing votes
|
|
|
|
// store blocks and commits
|
|
blockStore sm.BlockStore
|
|
|
|
// create and execute blocks
|
|
blockExec *sm.BlockExecutor
|
|
|
|
// notify us if txs are available
|
|
txNotifier txNotifier
|
|
|
|
// add evidence to the pool
|
|
// when it's detected
|
|
evpool evidencePool
|
|
|
|
// internal state
|
|
mtx sync.RWMutex
|
|
cstypes.RoundState
|
|
state sm.State // State until height-1.
|
|
|
|
// state changes may be triggered by: msgs from peers,
|
|
// msgs from ourself, or by timeouts
|
|
peerMsgQueue chan msgInfo
|
|
internalMsgQueue chan msgInfo
|
|
timeoutTicker TimeoutTicker
|
|
|
|
// information about about added votes and block parts are written on this channel
|
|
// so statistics can be computed by reactor
|
|
statsMsgQueue chan msgInfo
|
|
|
|
// we use eventBus to trigger msg broadcasts in the reactor,
|
|
// and to notify external subscribers, eg. through a websocket
|
|
eventBus *types.EventBus
|
|
|
|
// a Write-Ahead Log ensures we can recover from any kind of crash
|
|
// and helps us avoid signing conflicting votes
|
|
wal WAL
|
|
replayMode bool // so we don't log signing errors during replay
|
|
doWALCatchup bool // determines if we even try to do the catchup
|
|
|
|
// for tests where we want to limit the number of transitions the state makes
|
|
nSteps int
|
|
|
|
// some functions can be overwritten for testing
|
|
decideProposal func(height int64, round int32)
|
|
doPrevote func(height int64, round int32)
|
|
setProposal func(proposal *types.Proposal) error
|
|
|
|
// closed when we finish shutting down
|
|
done chan struct{}
|
|
|
|
// synchronous pubsub between consensus state and reactor.
|
|
// state only emits EventNewRoundStep and EventVote
|
|
evsw tmevents.EventSwitch
|
|
|
|
// for reporting metrics
|
|
metrics *Metrics
|
|
}
|
|
|
|
// StateOption sets an optional parameter on the State.
|
|
type StateOption func(*State)
|
|
|
|
// NewState returns a new State.
|
|
func NewState(
|
|
config *cfg.ConsensusConfig,
|
|
state sm.State,
|
|
blockExec *sm.BlockExecutor,
|
|
blockStore sm.BlockStore,
|
|
txNotifier txNotifier,
|
|
evpool evidencePool,
|
|
options ...StateOption,
|
|
) *State {
|
|
cs := &State{
|
|
config: config,
|
|
blockExec: blockExec,
|
|
blockStore: blockStore,
|
|
txNotifier: txNotifier,
|
|
peerMsgQueue: make(chan msgInfo, msgQueueSize),
|
|
internalMsgQueue: make(chan msgInfo, msgQueueSize),
|
|
timeoutTicker: NewTimeoutTicker(),
|
|
statsMsgQueue: make(chan msgInfo, msgQueueSize),
|
|
done: make(chan struct{}),
|
|
doWALCatchup: true,
|
|
wal: nilWAL{},
|
|
evpool: evpool,
|
|
evsw: tmevents.NewEventSwitch(),
|
|
metrics: NopMetrics(),
|
|
}
|
|
// set function defaults (may be overwritten before calling Start)
|
|
cs.decideProposal = cs.defaultDecideProposal
|
|
cs.doPrevote = cs.defaultDoPrevote
|
|
cs.setProposal = cs.defaultSetProposal
|
|
|
|
// We have no votes, so reconstruct LastCommit from SeenCommit.
|
|
if state.LastBlockHeight > 0 {
|
|
cs.reconstructLastCommit(state)
|
|
}
|
|
|
|
cs.updateToState(state)
|
|
|
|
// Don't call scheduleRound0 yet.
|
|
// We do that upon Start().
|
|
|
|
cs.BaseService = *service.NewBaseService(nil, "State", cs)
|
|
for _, option := range options {
|
|
option(cs)
|
|
}
|
|
return cs
|
|
}
|
|
|
|
//----------------------------------------
|
|
// Public interface
|
|
|
|
// SetLogger implements Service.
|
|
func (cs *State) SetLogger(l log.Logger) {
|
|
cs.BaseService.Logger = l
|
|
cs.timeoutTicker.SetLogger(l)
|
|
}
|
|
|
|
// SetEventBus sets event bus.
|
|
func (cs *State) SetEventBus(b *types.EventBus) {
|
|
cs.eventBus = b
|
|
cs.blockExec.SetEventBus(b)
|
|
}
|
|
|
|
// StateMetrics sets the metrics.
|
|
func StateMetrics(metrics *Metrics) StateOption {
|
|
return func(cs *State) { cs.metrics = metrics }
|
|
}
|
|
|
|
// String returns a string.
|
|
func (cs *State) String() string {
|
|
// better not to access shared variables
|
|
return "ConsensusState"
|
|
}
|
|
|
|
// GetState returns a copy of the chain state.
|
|
func (cs *State) GetState() sm.State {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
return cs.state.Copy()
|
|
}
|
|
|
|
// GetLastHeight returns the last height committed.
|
|
// If there were no blocks, returns 0.
|
|
func (cs *State) GetLastHeight() int64 {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
return cs.RoundState.Height - 1
|
|
}
|
|
|
|
// GetRoundState returns a shallow copy of the internal consensus state.
|
|
func (cs *State) GetRoundState() *cstypes.RoundState {
|
|
cs.mtx.RLock()
|
|
rs := cs.RoundState // copy
|
|
cs.mtx.RUnlock()
|
|
return &rs
|
|
}
|
|
|
|
// GetRoundStateJSON returns a json of RoundState.
|
|
func (cs *State) GetRoundStateJSON() ([]byte, error) {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
return tmjson.Marshal(cs.RoundState)
|
|
}
|
|
|
|
// GetRoundStateSimpleJSON returns a json of RoundStateSimple
|
|
func (cs *State) GetRoundStateSimpleJSON() ([]byte, error) {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
return tmjson.Marshal(cs.RoundState.RoundStateSimple())
|
|
}
|
|
|
|
// GetValidators returns a copy of the current validators.
|
|
func (cs *State) GetValidators() (int64, []*types.Validator) {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
return cs.state.LastBlockHeight, cs.state.Validators.Copy().Validators
|
|
}
|
|
|
|
// SetPrivValidator sets the private validator account for signing votes.
|
|
func (cs *State) SetPrivValidator(priv types.PrivValidator) {
|
|
cs.mtx.Lock()
|
|
cs.privValidator = priv
|
|
cs.mtx.Unlock()
|
|
}
|
|
|
|
// SetTimeoutTicker sets the local timer. It may be useful to overwrite for testing.
|
|
func (cs *State) SetTimeoutTicker(timeoutTicker TimeoutTicker) {
|
|
cs.mtx.Lock()
|
|
cs.timeoutTicker = timeoutTicker
|
|
cs.mtx.Unlock()
|
|
}
|
|
|
|
// LoadCommit loads the commit for a given height.
|
|
func (cs *State) LoadCommit(height int64) *types.Commit {
|
|
cs.mtx.RLock()
|
|
defer cs.mtx.RUnlock()
|
|
if height == cs.blockStore.Height() {
|
|
return cs.blockStore.LoadSeenCommit(height)
|
|
}
|
|
return cs.blockStore.LoadBlockCommit(height)
|
|
}
|
|
|
|
// OnStart loads the latest state via the WAL, and starts the timeout and
|
|
// receive routines.
|
|
func (cs *State) OnStart() error {
|
|
// We may set the WAL in testing before calling Start, so only OpenWAL if its
|
|
// still the nilWAL.
|
|
if _, ok := cs.wal.(nilWAL); ok {
|
|
if err := cs.loadWalFile(); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// We may have lost some votes if the process crashed reload from consensus
|
|
// log to catchup.
|
|
if cs.doWALCatchup {
|
|
repairAttempted := false
|
|
LOOP:
|
|
for {
|
|
err := cs.catchupReplay(cs.Height)
|
|
switch {
|
|
case err == nil:
|
|
break LOOP
|
|
case !IsDataCorruptionError(err):
|
|
cs.Logger.Error("Error on catchup replay. Proceeding to start State anyway", "err", err)
|
|
break LOOP
|
|
case repairAttempted:
|
|
return err
|
|
}
|
|
|
|
cs.Logger.Info("WAL file is corrupted. Attempting repair", "err", err)
|
|
|
|
// 1) prep work
|
|
cs.wal.Stop()
|
|
repairAttempted = true
|
|
|
|
// 2) backup original WAL file
|
|
corruptedFile := fmt.Sprintf("%s.CORRUPTED", cs.config.WalFile())
|
|
if err := tmos.CopyFile(cs.config.WalFile(), corruptedFile); err != nil {
|
|
return err
|
|
}
|
|
cs.Logger.Info("Backed up WAL file", "src", cs.config.WalFile(), "dst", corruptedFile)
|
|
|
|
// 3) try to repair (WAL file will be overwritten!)
|
|
if err := repairWalFile(corruptedFile, cs.config.WalFile()); err != nil {
|
|
cs.Logger.Error("Repair failed", "err", err)
|
|
return err
|
|
}
|
|
cs.Logger.Info("Successful repair")
|
|
|
|
// reload WAL file
|
|
if err := cs.loadWalFile(); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
|
|
if err := cs.evsw.Start(); err != nil {
|
|
return err
|
|
}
|
|
|
|
// we need the timeoutRoutine for replay so
|
|
// we don't block on the tick chan.
|
|
// NOTE: we will get a build up of garbage go routines
|
|
// firing on the tockChan until the receiveRoutine is started
|
|
// to deal with them (by that point, at most one will be valid)
|
|
if err := cs.timeoutTicker.Start(); err != nil {
|
|
return err
|
|
}
|
|
|
|
// now start the receiveRoutine
|
|
go cs.receiveRoutine(0)
|
|
|
|
// schedule the first round!
|
|
// use GetRoundState so we don't race the receiveRoutine for access
|
|
cs.scheduleRound0(cs.GetRoundState())
|
|
|
|
return nil
|
|
}
|
|
|
|
// timeoutRoutine: receive requests for timeouts on tickChan and fire timeouts on tockChan
|
|
// receiveRoutine: serializes processing of proposoals, block parts, votes; coordinates state transitions
|
|
func (cs *State) startRoutines(maxSteps int) {
|
|
err := cs.timeoutTicker.Start()
|
|
if err != nil {
|
|
cs.Logger.Error("Error starting timeout ticker", "err", err)
|
|
return
|
|
}
|
|
go cs.receiveRoutine(maxSteps)
|
|
}
|
|
|
|
// loadWalFile loads WAL data from file. It overwrites cs.wal.
|
|
func (cs *State) loadWalFile() error {
|
|
wal, err := cs.OpenWAL(cs.config.WalFile())
|
|
if err != nil {
|
|
cs.Logger.Error("Error loading State wal", "err", err)
|
|
return err
|
|
}
|
|
cs.wal = wal
|
|
return nil
|
|
}
|
|
|
|
// OnStop implements service.Service.
|
|
func (cs *State) OnStop() {
|
|
cs.evsw.Stop()
|
|
cs.timeoutTicker.Stop()
|
|
// WAL is stopped in receiveRoutine.
|
|
}
|
|
|
|
// Wait waits for the the main routine to return.
|
|
// NOTE: be sure to Stop() the event switch and drain
|
|
// any event channels or this may deadlock
|
|
func (cs *State) Wait() {
|
|
<-cs.done
|
|
}
|
|
|
|
// OpenWAL opens a file to log all consensus messages and timeouts for
|
|
// deterministic accountability.
|
|
func (cs *State) OpenWAL(walFile string) (WAL, error) {
|
|
wal, err := NewWAL(walFile)
|
|
if err != nil {
|
|
cs.Logger.Error("Failed to open WAL", "file", walFile, "err", err)
|
|
return nil, err
|
|
}
|
|
wal.SetLogger(cs.Logger.With("wal", walFile))
|
|
if err := wal.Start(); err != nil {
|
|
cs.Logger.Error("Failed to start WAL", "err", err)
|
|
return nil, err
|
|
}
|
|
return wal, nil
|
|
}
|
|
|
|
//------------------------------------------------------------
|
|
// Public interface for passing messages into the consensus state, possibly causing a state transition.
|
|
// If peerID == "", the msg is considered internal.
|
|
// Messages are added to the appropriate queue (peer or internal).
|
|
// If the queue is full, the function may block.
|
|
// TODO: should these return anything or let callers just use events?
|
|
|
|
// AddVote inputs a vote.
|
|
func (cs *State) AddVote(vote *types.Vote, peerID p2p.ID) (added bool, err error) {
|
|
if peerID == "" {
|
|
cs.internalMsgQueue <- msgInfo{&VoteMessage{vote}, ""}
|
|
} else {
|
|
cs.peerMsgQueue <- msgInfo{&VoteMessage{vote}, peerID}
|
|
}
|
|
|
|
// TODO: wait for event?!
|
|
return false, nil
|
|
}
|
|
|
|
// SetProposal inputs a proposal.
|
|
func (cs *State) SetProposal(proposal *types.Proposal, peerID p2p.ID) error {
|
|
|
|
if peerID == "" {
|
|
cs.internalMsgQueue <- msgInfo{&ProposalMessage{proposal}, ""}
|
|
} else {
|
|
cs.peerMsgQueue <- msgInfo{&ProposalMessage{proposal}, peerID}
|
|
}
|
|
|
|
// TODO: wait for event?!
|
|
return nil
|
|
}
|
|
|
|
// AddProposalBlockPart inputs a part of the proposal block.
|
|
func (cs *State) AddProposalBlockPart(height int64, round int32, part *types.Part, peerID p2p.ID) error {
|
|
|
|
if peerID == "" {
|
|
cs.internalMsgQueue <- msgInfo{&BlockPartMessage{height, round, part}, ""}
|
|
} else {
|
|
cs.peerMsgQueue <- msgInfo{&BlockPartMessage{height, round, part}, peerID}
|
|
}
|
|
|
|
// TODO: wait for event?!
|
|
return nil
|
|
}
|
|
|
|
// SetProposalAndBlock inputs the proposal and all block parts.
|
|
func (cs *State) SetProposalAndBlock(
|
|
proposal *types.Proposal,
|
|
block *types.Block,
|
|
parts *types.PartSet,
|
|
peerID p2p.ID,
|
|
) error {
|
|
if err := cs.SetProposal(proposal, peerID); err != nil {
|
|
return err
|
|
}
|
|
for i := 0; i < int(parts.Total()); i++ {
|
|
part := parts.GetPart(i)
|
|
if err := cs.AddProposalBlockPart(proposal.Height, proposal.Round, part, peerID); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
//------------------------------------------------------------
|
|
// internal functions for managing the state
|
|
|
|
func (cs *State) updateHeight(height int64) {
|
|
cs.metrics.Height.Set(float64(height))
|
|
cs.Height = height
|
|
}
|
|
|
|
func (cs *State) updateRoundStep(round int32, step cstypes.RoundStepType) {
|
|
cs.Round = round
|
|
cs.Step = step
|
|
}
|
|
|
|
// enterNewRound(height, 0) at cs.StartTime.
|
|
func (cs *State) scheduleRound0(rs *cstypes.RoundState) {
|
|
//cs.Logger.Info("scheduleRound0", "now", tmtime.Now(), "startTime", cs.StartTime)
|
|
sleepDuration := rs.StartTime.Sub(tmtime.Now())
|
|
cs.scheduleTimeout(sleepDuration, rs.Height, 0, cstypes.RoundStepNewHeight)
|
|
}
|
|
|
|
// Attempt to schedule a timeout (by sending timeoutInfo on the tickChan)
|
|
func (cs *State) scheduleTimeout(duration time.Duration, height int64, round int32, step cstypes.RoundStepType) {
|
|
cs.timeoutTicker.ScheduleTimeout(timeoutInfo{duration, height, round, step})
|
|
}
|
|
|
|
// send a msg into the receiveRoutine regarding our own proposal, block part, or vote
|
|
func (cs *State) sendInternalMessage(mi msgInfo) {
|
|
select {
|
|
case cs.internalMsgQueue <- mi:
|
|
default:
|
|
// NOTE: using the go-routine means our votes can
|
|
// be processed out of order.
|
|
// TODO: use CList here for strict determinism and
|
|
// attempt push to internalMsgQueue in receiveRoutine
|
|
cs.Logger.Info("Internal msg queue is full. Using a go-routine")
|
|
go func() { cs.internalMsgQueue <- mi }()
|
|
}
|
|
}
|
|
|
|
// Reconstruct LastCommit from SeenCommit, which we saved along with the block,
|
|
// (which happens even before saving the state)
|
|
func (cs *State) reconstructLastCommit(state sm.State) {
|
|
seenCommit := cs.blockStore.LoadSeenCommit(state.LastBlockHeight)
|
|
if seenCommit == nil {
|
|
panic(fmt.Sprintf("Failed to reconstruct LastCommit: seen commit for height %v not found",
|
|
state.LastBlockHeight))
|
|
}
|
|
|
|
lastPrecommits := types.CommitToVoteSet(state.ChainID, seenCommit, state.LastValidators)
|
|
if !lastPrecommits.HasTwoThirdsMajority() {
|
|
panic("Failed to reconstruct LastCommit: Does not have +2/3 maj")
|
|
}
|
|
|
|
cs.LastCommit = lastPrecommits
|
|
}
|
|
|
|
// Updates State and increments height to match that of state.
|
|
// The round becomes 0 and cs.Step becomes cstypes.RoundStepNewHeight.
|
|
func (cs *State) updateToState(state sm.State) {
|
|
if cs.CommitRound > -1 && 0 < cs.Height && cs.Height != state.LastBlockHeight {
|
|
panic(fmt.Sprintf("updateToState() expected state height of %v but found %v",
|
|
cs.Height, state.LastBlockHeight))
|
|
}
|
|
if !cs.state.IsEmpty() && cs.state.LastBlockHeight+1 != cs.Height {
|
|
// This might happen when someone else is mutating cs.state.
|
|
// Someone forgot to pass in state.Copy() somewhere?!
|
|
panic(fmt.Sprintf("Inconsistent cs.state.LastBlockHeight+1 %v vs cs.Height %v",
|
|
cs.state.LastBlockHeight+1, cs.Height))
|
|
}
|
|
|
|
// If state isn't further out than cs.state, just ignore.
|
|
// This happens when SwitchToConsensus() is called in the reactor.
|
|
// We don't want to reset e.g. the Votes, but we still want to
|
|
// signal the new round step, because other services (eg. txNotifier)
|
|
// depend on having an up-to-date peer state!
|
|
if !cs.state.IsEmpty() && (state.LastBlockHeight <= cs.state.LastBlockHeight) {
|
|
cs.Logger.Info(
|
|
"Ignoring updateToState()",
|
|
"newHeight",
|
|
state.LastBlockHeight+1,
|
|
"oldHeight",
|
|
cs.state.LastBlockHeight+1)
|
|
cs.newStep()
|
|
return
|
|
}
|
|
|
|
// Reset fields based on state.
|
|
validators := state.Validators
|
|
|
|
switch {
|
|
case state.LastBlockHeight == 0: // Very first commit should be empty.
|
|
cs.LastCommit = (*types.VoteSet)(nil)
|
|
case cs.CommitRound > -1 && cs.Votes != nil: // Otherwise, use cs.Votes
|
|
if !cs.Votes.Precommits(cs.CommitRound).HasTwoThirdsMajority() {
|
|
panic(fmt.Sprintf("Wanted to form a Commit, but Precommits (H/R: %d/%d) didn't have 2/3+: %v",
|
|
state.LastBlockHeight,
|
|
cs.CommitRound,
|
|
cs.Votes.Precommits(cs.CommitRound)))
|
|
}
|
|
cs.LastCommit = cs.Votes.Precommits(cs.CommitRound)
|
|
case cs.LastCommit == nil:
|
|
// NOTE: when Tendermint starts, it has no votes. reconstructLastCommit
|
|
// must be called to reconstruct LastCommit from SeenCommit.
|
|
panic(fmt.Sprintf("LastCommit cannot be empty in heights > 1 (H:%d)",
|
|
state.LastBlockHeight+1,
|
|
))
|
|
}
|
|
|
|
// Next desired block height
|
|
height := state.LastBlockHeight + 1
|
|
|
|
// RoundState fields
|
|
cs.updateHeight(height)
|
|
cs.updateRoundStep(0, cstypes.RoundStepNewHeight)
|
|
if cs.CommitTime.IsZero() {
|
|
// "Now" makes it easier to sync up dev nodes.
|
|
// We add timeoutCommit to allow transactions
|
|
// to be gathered for the first block.
|
|
// And alternative solution that relies on clocks:
|
|
// cs.StartTime = state.LastBlockTime.Add(timeoutCommit)
|
|
cs.StartTime = cs.config.Commit(tmtime.Now())
|
|
} else {
|
|
cs.StartTime = cs.config.Commit(cs.CommitTime)
|
|
}
|
|
|
|
cs.Validators = validators
|
|
cs.Proposal = nil
|
|
cs.ProposalBlock = nil
|
|
cs.ProposalBlockParts = nil
|
|
cs.LockedRound = -1
|
|
cs.LockedBlock = nil
|
|
cs.LockedBlockParts = nil
|
|
cs.ValidRound = -1
|
|
cs.ValidBlock = nil
|
|
cs.ValidBlockParts = nil
|
|
cs.Votes = cstypes.NewHeightVoteSet(state.ChainID, height, validators)
|
|
cs.CommitRound = -1
|
|
cs.LastValidators = state.LastValidators
|
|
cs.TriggeredTimeoutPrecommit = false
|
|
|
|
cs.state = state
|
|
|
|
// Finally, broadcast RoundState
|
|
cs.newStep()
|
|
}
|
|
|
|
func (cs *State) newStep() {
|
|
rs := cs.RoundStateEvent()
|
|
cs.wal.Write(rs)
|
|
cs.nSteps++
|
|
// newStep is called by updateToState in NewState before the eventBus is set!
|
|
if cs.eventBus != nil {
|
|
cs.eventBus.PublishEventNewRoundStep(rs)
|
|
cs.evsw.FireEvent(types.EventNewRoundStep, &cs.RoundState)
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------
|
|
// the main go routines
|
|
|
|
// receiveRoutine handles messages which may cause state transitions.
|
|
// it's argument (n) is the number of messages to process before exiting - use 0 to run forever
|
|
// It keeps the RoundState and is the only thing that updates it.
|
|
// Updates (state transitions) happen on timeouts, complete proposals, and 2/3 majorities.
|
|
// State must be locked before any internal state is updated.
|
|
func (cs *State) receiveRoutine(maxSteps int) {
|
|
onExit := func(cs *State) {
|
|
// NOTE: the internalMsgQueue may have signed messages from our
|
|
// priv_val that haven't hit the WAL, but its ok because
|
|
// priv_val tracks LastSig
|
|
|
|
// close wal now that we're done writing to it
|
|
cs.wal.Stop()
|
|
cs.wal.Wait()
|
|
|
|
close(cs.done)
|
|
}
|
|
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
cs.Logger.Error("CONSENSUS FAILURE!!!", "err", r, "stack", string(debug.Stack()))
|
|
// stop gracefully
|
|
//
|
|
// NOTE: We most probably shouldn't be running any further when there is
|
|
// some unexpected panic. Some unknown error happened, and so we don't
|
|
// know if that will result in the validator signing an invalid thing. It
|
|
// might be worthwhile to explore a mechanism for manual resuming via
|
|
// some console or secure RPC system, but for now, halting the chain upon
|
|
// unexpected consensus bugs sounds like the better option.
|
|
onExit(cs)
|
|
}
|
|
}()
|
|
|
|
for {
|
|
if maxSteps > 0 {
|
|
if cs.nSteps >= maxSteps {
|
|
cs.Logger.Info("reached max steps. exiting receive routine")
|
|
cs.nSteps = 0
|
|
return
|
|
}
|
|
}
|
|
rs := cs.RoundState
|
|
var mi msgInfo
|
|
|
|
select {
|
|
case <-cs.txNotifier.TxsAvailable():
|
|
cs.handleTxsAvailable()
|
|
case mi = <-cs.peerMsgQueue:
|
|
cs.wal.Write(mi)
|
|
// handles proposals, block parts, votes
|
|
// may generate internal events (votes, complete proposals, 2/3 majorities)
|
|
cs.handleMsg(mi)
|
|
case mi = <-cs.internalMsgQueue:
|
|
err := cs.wal.WriteSync(mi) // NOTE: fsync
|
|
if err != nil {
|
|
panic(fmt.Sprintf("Failed to write %v msg to consensus wal due to %v. Check your FS and restart the node", mi, err))
|
|
}
|
|
|
|
if _, ok := mi.Msg.(*VoteMessage); ok {
|
|
// we actually want to simulate failing during
|
|
// the previous WriteSync, but this isn't easy to do.
|
|
// Equivalent would be to fail here and manually remove
|
|
// some bytes from the end of the wal.
|
|
fail.Fail() // XXX
|
|
}
|
|
|
|
// handles proposals, block parts, votes
|
|
cs.handleMsg(mi)
|
|
case ti := <-cs.timeoutTicker.Chan(): // tockChan:
|
|
cs.wal.Write(ti)
|
|
// if the timeout is relevant to the rs
|
|
// go to the next step
|
|
cs.handleTimeout(ti, rs)
|
|
case <-cs.Quit():
|
|
onExit(cs)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
// state transitions on complete-proposal, 2/3-any, 2/3-one
|
|
func (cs *State) handleMsg(mi msgInfo) {
|
|
cs.mtx.Lock()
|
|
defer cs.mtx.Unlock()
|
|
|
|
var (
|
|
added bool
|
|
err error
|
|
)
|
|
msg, peerID := mi.Msg, mi.PeerID
|
|
switch msg := msg.(type) {
|
|
case *ProposalMessage:
|
|
// will not cause transition.
|
|
// once proposal is set, we can receive block parts
|
|
err = cs.setProposal(msg.Proposal)
|
|
case *BlockPartMessage:
|
|
// if the proposal is complete, we'll enterPrevote or tryFinalizeCommit
|
|
added, err = cs.addProposalBlockPart(msg, peerID)
|
|
if added {
|
|
cs.statsMsgQueue <- mi
|
|
}
|
|
|
|
if err != nil && msg.Round != cs.Round {
|
|
cs.Logger.Debug(
|
|
"Received block part from wrong round",
|
|
"height",
|
|
cs.Height,
|
|
"csRound",
|
|
cs.Round,
|
|
"blockRound",
|
|
msg.Round)
|
|
err = nil
|
|
}
|
|
case *VoteMessage:
|
|
// attempt to add the vote and dupeout the validator if its a duplicate signature
|
|
// if the vote gives us a 2/3-any or 2/3-one, we transition
|
|
added, err = cs.tryAddVote(msg.Vote, peerID)
|
|
if added {
|
|
cs.statsMsgQueue <- mi
|
|
}
|
|
|
|
// if err == ErrAddingVote {
|
|
// TODO: punish peer
|
|
// We probably don't want to stop the peer here. The vote does not
|
|
// necessarily comes from a malicious peer but can be just broadcasted by
|
|
// a typical peer.
|
|
// https://github.com/tendermint/tendermint/issues/1281
|
|
// }
|
|
|
|
// NOTE: the vote is broadcast to peers by the reactor listening
|
|
// for vote events
|
|
|
|
// TODO: If rs.Height == vote.Height && rs.Round < vote.Round,
|
|
// the peer is sending us CatchupCommit precommits.
|
|
// We could make note of this and help filter in broadcastHasVoteMessage().
|
|
default:
|
|
cs.Logger.Error("Unknown msg type", "type", reflect.TypeOf(msg))
|
|
return
|
|
}
|
|
|
|
if err != nil {
|
|
cs.Logger.Error("Error with msg", "height", cs.Height, "round", cs.Round,
|
|
"peer", peerID, "err", err, "msg", msg)
|
|
}
|
|
}
|
|
|
|
func (cs *State) handleTimeout(ti timeoutInfo, rs cstypes.RoundState) {
|
|
cs.Logger.Debug("Received tock", "timeout", ti.Duration, "height", ti.Height, "round", ti.Round, "step", ti.Step)
|
|
|
|
// timeouts must be for current height, round, step
|
|
if ti.Height != rs.Height || ti.Round < rs.Round || (ti.Round == rs.Round && ti.Step < rs.Step) {
|
|
cs.Logger.Debug("Ignoring tock because we're ahead", "height", rs.Height, "round", rs.Round, "step", rs.Step)
|
|
return
|
|
}
|
|
|
|
// the timeout will now cause a state transition
|
|
cs.mtx.Lock()
|
|
defer cs.mtx.Unlock()
|
|
|
|
switch ti.Step {
|
|
case cstypes.RoundStepNewHeight:
|
|
// NewRound event fired from enterNewRound.
|
|
// XXX: should we fire timeout here (for timeout commit)?
|
|
cs.enterNewRound(ti.Height, 0)
|
|
case cstypes.RoundStepNewRound:
|
|
cs.enterPropose(ti.Height, 0)
|
|
case cstypes.RoundStepPropose:
|
|
cs.eventBus.PublishEventTimeoutPropose(cs.RoundStateEvent())
|
|
cs.enterPrevote(ti.Height, ti.Round)
|
|
case cstypes.RoundStepPrevoteWait:
|
|
cs.eventBus.PublishEventTimeoutWait(cs.RoundStateEvent())
|
|
cs.enterPrecommit(ti.Height, ti.Round)
|
|
case cstypes.RoundStepPrecommitWait:
|
|
cs.eventBus.PublishEventTimeoutWait(cs.RoundStateEvent())
|
|
cs.enterPrecommit(ti.Height, ti.Round)
|
|
cs.enterNewRound(ti.Height, ti.Round+1)
|
|
default:
|
|
panic(fmt.Sprintf("Invalid timeout step: %v", ti.Step))
|
|
}
|
|
|
|
}
|
|
|
|
func (cs *State) handleTxsAvailable() {
|
|
cs.mtx.Lock()
|
|
defer cs.mtx.Unlock()
|
|
|
|
// We only need to do this for round 0.
|
|
if cs.Round != 0 {
|
|
return
|
|
}
|
|
|
|
switch cs.Step {
|
|
case cstypes.RoundStepNewHeight: // timeoutCommit phase
|
|
if cs.needProofBlock(cs.Height) {
|
|
// enterPropose will be called by enterNewRound
|
|
return
|
|
}
|
|
|
|
// +1ms to ensure RoundStepNewRound timeout always happens after RoundStepNewHeight
|
|
timeoutCommit := cs.StartTime.Sub(tmtime.Now()) + 1*time.Millisecond
|
|
cs.scheduleTimeout(timeoutCommit, cs.Height, 0, cstypes.RoundStepNewRound)
|
|
case cstypes.RoundStepNewRound: // after timeoutCommit
|
|
cs.enterPropose(cs.Height, 0)
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// State functions
|
|
// Used internally by handleTimeout and handleMsg to make state transitions
|
|
|
|
// Enter: `timeoutNewHeight` by startTime (commitTime+timeoutCommit),
|
|
// or, if SkipTimeoutCommit==true, after receiving all precommits from (height,round-1)
|
|
// Enter: `timeoutPrecommits` after any +2/3 precommits from (height,round-1)
|
|
// Enter: +2/3 precommits for nil at (height,round-1)
|
|
// Enter: +2/3 prevotes any or +2/3 precommits for block or any from (height, round)
|
|
// NOTE: cs.StartTime was already set for height.
|
|
func (cs *State) enterNewRound(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cs.Step != cstypes.RoundStepNewHeight) {
|
|
logger.Debug(fmt.Sprintf(
|
|
"enterNewRound(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
round,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
|
|
if now := tmtime.Now(); cs.StartTime.After(now) {
|
|
logger.Info("Need to set a buffer and log message here for sanity.", "startTime", cs.StartTime, "now", now)
|
|
}
|
|
|
|
logger.Info(fmt.Sprintf("enterNewRound(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
// Increment validators if necessary
|
|
validators := cs.Validators
|
|
if cs.Round < round {
|
|
validators = validators.Copy()
|
|
validators.IncrementProposerPriority(tmmath.SafeSubInt32(round, cs.Round))
|
|
}
|
|
|
|
// Setup new round
|
|
// we don't fire newStep for this step,
|
|
// but we fire an event, so update the round step first
|
|
cs.updateRoundStep(round, cstypes.RoundStepNewRound)
|
|
cs.Validators = validators
|
|
if round == 0 {
|
|
// We've already reset these upon new height,
|
|
// and meanwhile we might have received a proposal
|
|
// for round 0.
|
|
} else {
|
|
logger.Info("Resetting Proposal info")
|
|
cs.Proposal = nil
|
|
cs.ProposalBlock = nil
|
|
cs.ProposalBlockParts = nil
|
|
}
|
|
cs.Votes.SetRound(tmmath.SafeAddInt32(round, 1)) // also track next round (round+1) to allow round-skipping
|
|
cs.TriggeredTimeoutPrecommit = false
|
|
|
|
cs.eventBus.PublishEventNewRound(cs.NewRoundEvent())
|
|
cs.metrics.Rounds.Set(float64(round))
|
|
|
|
// Wait for txs to be available in the mempool
|
|
// before we enterPropose in round 0. If the last block changed the app hash,
|
|
// we may need an empty "proof" block, and enterPropose immediately.
|
|
waitForTxs := cs.config.WaitForTxs() && round == 0 && !cs.needProofBlock(height)
|
|
if waitForTxs {
|
|
if cs.config.CreateEmptyBlocksInterval > 0 {
|
|
cs.scheduleTimeout(cs.config.CreateEmptyBlocksInterval, height, round,
|
|
cstypes.RoundStepNewRound)
|
|
}
|
|
} else {
|
|
cs.enterPropose(height, round)
|
|
}
|
|
}
|
|
|
|
// needProofBlock returns true on the first height (so the genesis app hash is signed right away)
|
|
// and where the last block (height-1) caused the app hash to change
|
|
func (cs *State) needProofBlock(height int64) bool {
|
|
if height == 1 {
|
|
return true
|
|
}
|
|
|
|
lastBlockMeta := cs.blockStore.LoadBlockMeta(height - 1)
|
|
if lastBlockMeta == nil {
|
|
panic(fmt.Sprintf("needProofBlock: last block meta for height %d not found", height-1))
|
|
}
|
|
return !bytes.Equal(cs.state.AppHash, lastBlockMeta.Header.AppHash)
|
|
}
|
|
|
|
// Enter (CreateEmptyBlocks): from enterNewRound(height,round)
|
|
// Enter (CreateEmptyBlocks, CreateEmptyBlocksInterval > 0 ):
|
|
// after enterNewRound(height,round), after timeout of CreateEmptyBlocksInterval
|
|
// Enter (!CreateEmptyBlocks) : after enterNewRound(height,round), once txs are in the mempool
|
|
func (cs *State) enterPropose(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cstypes.RoundStepPropose <= cs.Step) {
|
|
logger.Debug(fmt.Sprintf(
|
|
"enterPropose(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
round,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
logger.Info(fmt.Sprintf("enterPropose(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
defer func() {
|
|
// Done enterPropose:
|
|
cs.updateRoundStep(round, cstypes.RoundStepPropose)
|
|
cs.newStep()
|
|
|
|
// If we have the whole proposal + POL, then goto Prevote now.
|
|
// else, we'll enterPrevote when the rest of the proposal is received (in AddProposalBlockPart),
|
|
// or else after timeoutPropose
|
|
if cs.isProposalComplete() {
|
|
cs.enterPrevote(height, cs.Round)
|
|
}
|
|
}()
|
|
|
|
// If we don't get the proposal and all block parts quick enough, enterPrevote
|
|
cs.scheduleTimeout(cs.config.Propose(round), height, round, cstypes.RoundStepPropose)
|
|
|
|
// Nothing more to do if we're not a validator
|
|
if cs.privValidator == nil {
|
|
logger.Debug("This node is not a validator")
|
|
return
|
|
}
|
|
logger.Debug("This node is a validator")
|
|
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
// If this node is a validator & proposer in the current round, it will
|
|
// miss the opportunity to create a block.
|
|
logger.Error("Error on retrival of pubkey", "err", err)
|
|
return
|
|
}
|
|
address := pubKey.Address()
|
|
|
|
// if not a validator, we're done
|
|
if !cs.Validators.HasAddress(address) {
|
|
logger.Debug("This node is not a validator", "addr", address, "vals", cs.Validators)
|
|
return
|
|
}
|
|
|
|
if cs.isProposer(address) {
|
|
logger.Info("enterPropose: Our turn to propose",
|
|
"proposer",
|
|
address,
|
|
"privValidator",
|
|
cs.privValidator)
|
|
cs.decideProposal(height, round)
|
|
} else {
|
|
logger.Info("enterPropose: Not our turn to propose",
|
|
"proposer",
|
|
cs.Validators.GetProposer().Address,
|
|
"privValidator",
|
|
cs.privValidator)
|
|
}
|
|
}
|
|
|
|
func (cs *State) isProposer(address []byte) bool {
|
|
return bytes.Equal(cs.Validators.GetProposer().Address, address)
|
|
}
|
|
|
|
func (cs *State) defaultDecideProposal(height int64, round int32) {
|
|
var block *types.Block
|
|
var blockParts *types.PartSet
|
|
|
|
// Decide on block
|
|
if cs.ValidBlock != nil {
|
|
// If there is valid block, choose that.
|
|
block, blockParts = cs.ValidBlock, cs.ValidBlockParts
|
|
} else {
|
|
// Create a new proposal block from state/txs from the mempool.
|
|
block, blockParts = cs.createProposalBlock()
|
|
if block == nil {
|
|
return
|
|
}
|
|
}
|
|
|
|
// Flush the WAL. Otherwise, we may not recompute the same proposal to sign,
|
|
// and the privValidator will refuse to sign anything.
|
|
cs.wal.FlushAndSync()
|
|
|
|
// Make proposal
|
|
propBlockID := types.BlockID{Hash: block.Hash(), PartsHeader: blockParts.Header()}
|
|
proposal := types.NewProposal(height, round, cs.ValidRound, propBlockID)
|
|
p := proposal.ToProto()
|
|
if err := cs.privValidator.SignProposal(cs.state.ChainID, p); err == nil {
|
|
proposal.Signature = p.Signature
|
|
|
|
// send proposal and block parts on internal msg queue
|
|
cs.sendInternalMessage(msgInfo{&ProposalMessage{proposal}, ""})
|
|
for i := 0; i < int(blockParts.Total()); i++ {
|
|
part := blockParts.GetPart(i)
|
|
cs.sendInternalMessage(msgInfo{&BlockPartMessage{cs.Height, cs.Round, part}, ""})
|
|
}
|
|
cs.Logger.Info("Signed proposal", "height", height, "round", round, "proposal", proposal)
|
|
cs.Logger.Debug(fmt.Sprintf("Signed proposal block: %v", block))
|
|
} else if !cs.replayMode {
|
|
cs.Logger.Error("enterPropose: Error signing proposal", "height", height, "round", round, "err", err)
|
|
}
|
|
}
|
|
|
|
// Returns true if the proposal block is complete &&
|
|
// (if POLRound was proposed, we have +2/3 prevotes from there).
|
|
func (cs *State) isProposalComplete() bool {
|
|
if cs.Proposal == nil || cs.ProposalBlock == nil {
|
|
return false
|
|
}
|
|
// we have the proposal. if there's a POLRound,
|
|
// make sure we have the prevotes from it too
|
|
if cs.Proposal.POLRound < 0 {
|
|
return true
|
|
}
|
|
// if this is false the proposer is lying or we haven't received the POL yet
|
|
return cs.Votes.Prevotes(cs.Proposal.POLRound).HasTwoThirdsMajority()
|
|
|
|
}
|
|
|
|
// Create the next block to propose and return it. Returns nil block upon error.
|
|
//
|
|
// We really only need to return the parts, but the block is returned for
|
|
// convenience so we can log the proposal block.
|
|
//
|
|
// NOTE: keep it side-effect free for clarity.
|
|
// CONTRACT: cs.privValidator is not nil.
|
|
func (cs *State) createProposalBlock() (block *types.Block, blockParts *types.PartSet) {
|
|
var commit *types.Commit
|
|
switch {
|
|
case cs.Height == 1:
|
|
// We're creating a proposal for the first block.
|
|
// The commit is empty, but not nil.
|
|
commit = types.NewCommit(0, 0, types.BlockID{}, nil)
|
|
case cs.LastCommit.HasTwoThirdsMajority():
|
|
// Make the commit from LastCommit
|
|
commit = cs.LastCommit.MakeCommit()
|
|
default: // This shouldn't happen.
|
|
cs.Logger.Error("enterPropose: Cannot propose anything: No commit for the previous block")
|
|
return
|
|
}
|
|
|
|
if cs.privValidator == nil {
|
|
panic("entered createProposalBlock with privValidator being nil")
|
|
}
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
// If this node is a validator & proposer in the current round, it will
|
|
// miss the opportunity to create a block.
|
|
cs.Logger.Error("Error on retrival of pubkey", "err", err)
|
|
return
|
|
}
|
|
proposerAddr := pubKey.Address()
|
|
|
|
return cs.blockExec.CreateProposalBlock(cs.Height, cs.state, commit, proposerAddr)
|
|
}
|
|
|
|
// Enter: `timeoutPropose` after entering Propose.
|
|
// Enter: proposal block and POL is ready.
|
|
// Prevote for LockedBlock if we're locked, or ProposalBlock if valid.
|
|
// Otherwise vote nil.
|
|
func (cs *State) enterPrevote(height int64, round int32) {
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cstypes.RoundStepPrevote <= cs.Step) {
|
|
cs.Logger.Debug(fmt.Sprintf(
|
|
"enterPrevote(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
round,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
|
|
defer func() {
|
|
// Done enterPrevote:
|
|
cs.updateRoundStep(round, cstypes.RoundStepPrevote)
|
|
cs.newStep()
|
|
}()
|
|
|
|
cs.Logger.Info(fmt.Sprintf("enterPrevote(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
// Sign and broadcast vote as necessary
|
|
cs.doPrevote(height, round)
|
|
|
|
// Once `addVote` hits any +2/3 prevotes, we will go to PrevoteWait
|
|
// (so we have more time to try and collect +2/3 prevotes for a single block)
|
|
}
|
|
|
|
func (cs *State) defaultDoPrevote(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
// If a block is locked, prevote that.
|
|
if cs.LockedBlock != nil {
|
|
logger.Info("enterPrevote: Already locked on a block, prevoting locked block")
|
|
cs.signAddVote(tmproto.PrevoteType, cs.LockedBlock.Hash(), cs.LockedBlockParts.Header())
|
|
return
|
|
}
|
|
|
|
// If ProposalBlock is nil, prevote nil.
|
|
if cs.ProposalBlock == nil {
|
|
logger.Info("enterPrevote: ProposalBlock is nil")
|
|
cs.signAddVote(tmproto.PrevoteType, nil, types.PartSetHeader{})
|
|
return
|
|
}
|
|
|
|
// Validate proposal block
|
|
err := cs.blockExec.ValidateBlock(cs.state, cs.ProposalBlock)
|
|
if err != nil {
|
|
// ProposalBlock is invalid, prevote nil.
|
|
logger.Error("enterPrevote: ProposalBlock is invalid", "err", err)
|
|
cs.signAddVote(tmproto.PrevoteType, nil, types.PartSetHeader{})
|
|
return
|
|
}
|
|
|
|
// Prevote cs.ProposalBlock
|
|
// NOTE: the proposal signature is validated when it is received,
|
|
// and the proposal block parts are validated as they are received (against the merkle hash in the proposal)
|
|
logger.Info("enterPrevote: ProposalBlock is valid")
|
|
cs.signAddVote(tmproto.PrevoteType, cs.ProposalBlock.Hash(), cs.ProposalBlockParts.Header())
|
|
}
|
|
|
|
// Enter: any +2/3 prevotes at next round.
|
|
func (cs *State) enterPrevoteWait(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cstypes.RoundStepPrevoteWait <= cs.Step) {
|
|
logger.Debug(fmt.Sprintf(
|
|
"enterPrevoteWait(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
round,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
if !cs.Votes.Prevotes(round).HasTwoThirdsAny() {
|
|
panic(fmt.Sprintf("enterPrevoteWait(%v/%v), but Prevotes does not have any +2/3 votes", height, round))
|
|
}
|
|
logger.Info(fmt.Sprintf("enterPrevoteWait(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
defer func() {
|
|
// Done enterPrevoteWait:
|
|
cs.updateRoundStep(round, cstypes.RoundStepPrevoteWait)
|
|
cs.newStep()
|
|
}()
|
|
|
|
// Wait for some more prevotes; enterPrecommit
|
|
cs.scheduleTimeout(cs.config.Prevote(round), height, round, cstypes.RoundStepPrevoteWait)
|
|
}
|
|
|
|
// Enter: `timeoutPrevote` after any +2/3 prevotes.
|
|
// Enter: `timeoutPrecommit` after any +2/3 precommits.
|
|
// Enter: +2/3 precomits for block or nil.
|
|
// Lock & precommit the ProposalBlock if we have enough prevotes for it (a POL in this round)
|
|
// else, unlock an existing lock and precommit nil if +2/3 of prevotes were nil,
|
|
// else, precommit nil otherwise.
|
|
func (cs *State) enterPrecommit(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cstypes.RoundStepPrecommit <= cs.Step) {
|
|
logger.Debug(fmt.Sprintf(
|
|
"enterPrecommit(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
round,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
|
|
logger.Info(fmt.Sprintf("enterPrecommit(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
defer func() {
|
|
// Done enterPrecommit:
|
|
cs.updateRoundStep(round, cstypes.RoundStepPrecommit)
|
|
cs.newStep()
|
|
}()
|
|
|
|
// check for a polka
|
|
blockID, ok := cs.Votes.Prevotes(round).TwoThirdsMajority()
|
|
|
|
// If we don't have a polka, we must precommit nil.
|
|
if !ok {
|
|
if cs.LockedBlock != nil {
|
|
logger.Info("enterPrecommit: No +2/3 prevotes during enterPrecommit while we're locked. Precommitting nil")
|
|
} else {
|
|
logger.Info("enterPrecommit: No +2/3 prevotes during enterPrecommit. Precommitting nil.")
|
|
}
|
|
cs.signAddVote(tmproto.PrecommitType, nil, types.PartSetHeader{})
|
|
return
|
|
}
|
|
|
|
// At this point +2/3 prevoted for a particular block or nil.
|
|
cs.eventBus.PublishEventPolka(cs.RoundStateEvent())
|
|
|
|
// the latest POLRound should be this round.
|
|
polRound, _ := cs.Votes.POLInfo()
|
|
if polRound < round {
|
|
panic(fmt.Sprintf("This POLRound should be %v but got %v", round, polRound))
|
|
}
|
|
|
|
// +2/3 prevoted nil. Unlock and precommit nil.
|
|
if len(blockID.Hash) == 0 {
|
|
if cs.LockedBlock == nil {
|
|
logger.Info("enterPrecommit: +2/3 prevoted for nil.")
|
|
} else {
|
|
logger.Info("enterPrecommit: +2/3 prevoted for nil. Unlocking")
|
|
cs.LockedRound = -1
|
|
cs.LockedBlock = nil
|
|
cs.LockedBlockParts = nil
|
|
cs.eventBus.PublishEventUnlock(cs.RoundStateEvent())
|
|
}
|
|
cs.signAddVote(tmproto.PrecommitType, nil, types.PartSetHeader{})
|
|
return
|
|
}
|
|
|
|
// At this point, +2/3 prevoted for a particular block.
|
|
|
|
// If we're already locked on that block, precommit it, and update the LockedRound
|
|
if cs.LockedBlock.HashesTo(blockID.Hash) {
|
|
logger.Info("enterPrecommit: +2/3 prevoted locked block. Relocking")
|
|
cs.LockedRound = round
|
|
cs.eventBus.PublishEventRelock(cs.RoundStateEvent())
|
|
cs.signAddVote(tmproto.PrecommitType, blockID.Hash, blockID.PartsHeader)
|
|
return
|
|
}
|
|
|
|
// If +2/3 prevoted for proposal block, stage and precommit it
|
|
if cs.ProposalBlock.HashesTo(blockID.Hash) {
|
|
logger.Info("enterPrecommit: +2/3 prevoted proposal block. Locking", "hash", blockID.Hash)
|
|
// Validate the block.
|
|
if err := cs.blockExec.ValidateBlock(cs.state, cs.ProposalBlock); err != nil {
|
|
panic(fmt.Sprintf("enterPrecommit: +2/3 prevoted for an invalid block: %v", err))
|
|
}
|
|
cs.LockedRound = round
|
|
cs.LockedBlock = cs.ProposalBlock
|
|
cs.LockedBlockParts = cs.ProposalBlockParts
|
|
cs.eventBus.PublishEventLock(cs.RoundStateEvent())
|
|
cs.signAddVote(tmproto.PrecommitType, blockID.Hash, blockID.PartsHeader)
|
|
return
|
|
}
|
|
|
|
// There was a polka in this round for a block we don't have.
|
|
// Fetch that block, unlock, and precommit nil.
|
|
// The +2/3 prevotes for this round is the POL for our unlock.
|
|
logger.Info("enterPrecommit: +2/3 prevotes for a block we don't have. Voting nil", "blockID", blockID)
|
|
cs.LockedRound = -1
|
|
cs.LockedBlock = nil
|
|
cs.LockedBlockParts = nil
|
|
if !cs.ProposalBlockParts.HasHeader(blockID.PartsHeader) {
|
|
cs.ProposalBlock = nil
|
|
cs.ProposalBlockParts = types.NewPartSetFromHeader(blockID.PartsHeader)
|
|
}
|
|
cs.eventBus.PublishEventUnlock(cs.RoundStateEvent())
|
|
cs.signAddVote(tmproto.PrecommitType, nil, types.PartSetHeader{})
|
|
}
|
|
|
|
func (cs *State) savePOLC(round int32, blockID types.BlockID) {
|
|
// polc must be for rounds greater than 0
|
|
if round == 0 {
|
|
return
|
|
}
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
cs.Logger.Error("Error on retrieval of pubkey", "err", err)
|
|
return
|
|
}
|
|
polc, err := types.MakePOLCFromVoteSet(cs.Votes.Prevotes(round), pubKey, blockID)
|
|
if err != nil {
|
|
cs.Logger.Error("Error on forming POLC", "err", err)
|
|
return
|
|
}
|
|
err = cs.evpool.AddPOLC(polc)
|
|
if err != nil {
|
|
cs.Logger.Error("Error on saving POLC", "err", err)
|
|
return
|
|
}
|
|
cs.Logger.Info("Saved POLC to evidence pool", "round", round, "height", polc.Height())
|
|
}
|
|
|
|
// Enter: any +2/3 precommits for next round.
|
|
func (cs *State) enterPrecommitWait(height int64, round int32) {
|
|
logger := cs.Logger.With("height", height, "round", round)
|
|
|
|
if cs.Height != height || round < cs.Round || (cs.Round == round && cs.TriggeredTimeoutPrecommit) {
|
|
logger.Debug(
|
|
fmt.Sprintf(
|
|
"enterPrecommitWait(%v/%v): Invalid args. "+
|
|
"Current state is Height/Round: %v/%v/, TriggeredTimeoutPrecommit:%v",
|
|
height, round, cs.Height, cs.Round, cs.TriggeredTimeoutPrecommit))
|
|
return
|
|
}
|
|
if !cs.Votes.Precommits(round).HasTwoThirdsAny() {
|
|
panic(fmt.Sprintf("enterPrecommitWait(%v/%v), but Precommits does not have any +2/3 votes", height, round))
|
|
}
|
|
logger.Info(fmt.Sprintf("enterPrecommitWait(%v/%v). Current: %v/%v/%v", height, round, cs.Height, cs.Round, cs.Step))
|
|
|
|
defer func() {
|
|
// Done enterPrecommitWait:
|
|
cs.TriggeredTimeoutPrecommit = true
|
|
cs.newStep()
|
|
}()
|
|
|
|
// Wait for some more precommits; enterNewRound
|
|
cs.scheduleTimeout(cs.config.Precommit(round), height, round, cstypes.RoundStepPrecommitWait)
|
|
}
|
|
|
|
// Enter: +2/3 precommits for block
|
|
func (cs *State) enterCommit(height int64, commitRound int32) {
|
|
logger := cs.Logger.With("height", height, "commitRound", commitRound)
|
|
|
|
if cs.Height != height || cstypes.RoundStepCommit <= cs.Step {
|
|
logger.Debug(fmt.Sprintf(
|
|
"enterCommit(%v/%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
commitRound,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
logger.Info(fmt.Sprintf("enterCommit(%v/%v). Current: %v/%v/%v", height, commitRound, cs.Height, cs.Round, cs.Step))
|
|
|
|
defer func() {
|
|
// Done enterCommit:
|
|
// keep cs.Round the same, commitRound points to the right Precommits set.
|
|
cs.updateRoundStep(cs.Round, cstypes.RoundStepCommit)
|
|
cs.CommitRound = commitRound
|
|
cs.CommitTime = tmtime.Now()
|
|
cs.newStep()
|
|
|
|
// Maybe finalize immediately.
|
|
cs.tryFinalizeCommit(height)
|
|
}()
|
|
|
|
blockID, ok := cs.Votes.Precommits(commitRound).TwoThirdsMajority()
|
|
if !ok {
|
|
panic("RunActionCommit() expects +2/3 precommits")
|
|
}
|
|
|
|
// The Locked* fields no longer matter.
|
|
// Move them over to ProposalBlock if they match the commit hash,
|
|
// otherwise they'll be cleared in updateToState.
|
|
if cs.LockedBlock.HashesTo(blockID.Hash) {
|
|
logger.Info("Commit is for locked block. Set ProposalBlock=LockedBlock", "blockHash", blockID.Hash)
|
|
cs.ProposalBlock = cs.LockedBlock
|
|
cs.ProposalBlockParts = cs.LockedBlockParts
|
|
}
|
|
|
|
// If we don't have the block being committed, set up to get it.
|
|
if !cs.ProposalBlock.HashesTo(blockID.Hash) {
|
|
if !cs.ProposalBlockParts.HasHeader(blockID.PartsHeader) {
|
|
logger.Info(
|
|
"Commit is for a block we don't know about. Set ProposalBlock=nil",
|
|
"proposal",
|
|
cs.ProposalBlock.Hash(),
|
|
"commit",
|
|
blockID.Hash)
|
|
// We're getting the wrong block.
|
|
// Set up ProposalBlockParts and keep waiting.
|
|
cs.ProposalBlock = nil
|
|
cs.ProposalBlockParts = types.NewPartSetFromHeader(blockID.PartsHeader)
|
|
cs.eventBus.PublishEventValidBlock(cs.RoundStateEvent())
|
|
cs.evsw.FireEvent(types.EventValidBlock, &cs.RoundState)
|
|
}
|
|
// else {
|
|
// We just need to keep waiting.
|
|
// }
|
|
}
|
|
}
|
|
|
|
// If we have the block AND +2/3 commits for it, finalize.
|
|
func (cs *State) tryFinalizeCommit(height int64) {
|
|
logger := cs.Logger.With("height", height)
|
|
|
|
if cs.Height != height {
|
|
panic(fmt.Sprintf("tryFinalizeCommit() cs.Height: %v vs height: %v", cs.Height, height))
|
|
}
|
|
|
|
blockID, ok := cs.Votes.Precommits(cs.CommitRound).TwoThirdsMajority()
|
|
if !ok || len(blockID.Hash) == 0 {
|
|
logger.Error("Attempt to finalize failed. There was no +2/3 majority, or +2/3 was for <nil>.")
|
|
return
|
|
}
|
|
if !cs.ProposalBlock.HashesTo(blockID.Hash) {
|
|
// TODO: this happens every time if we're not a validator (ugly logs)
|
|
// TODO: ^^ wait, why does it matter that we're a validator?
|
|
logger.Info(
|
|
"Attempt to finalize failed. We don't have the commit block.",
|
|
"proposal-block",
|
|
cs.ProposalBlock.Hash(),
|
|
"commit-block",
|
|
blockID.Hash)
|
|
return
|
|
}
|
|
|
|
// go
|
|
cs.finalizeCommit(height)
|
|
}
|
|
|
|
// Increment height and goto cstypes.RoundStepNewHeight
|
|
func (cs *State) finalizeCommit(height int64) {
|
|
if cs.Height != height || cs.Step != cstypes.RoundStepCommit {
|
|
cs.Logger.Debug(fmt.Sprintf(
|
|
"finalizeCommit(%v): Invalid args. Current step: %v/%v/%v",
|
|
height,
|
|
cs.Height,
|
|
cs.Round,
|
|
cs.Step))
|
|
return
|
|
}
|
|
|
|
blockID, ok := cs.Votes.Precommits(cs.CommitRound).TwoThirdsMajority()
|
|
block, blockParts := cs.ProposalBlock, cs.ProposalBlockParts
|
|
|
|
if !ok {
|
|
panic("Cannot finalizeCommit, commit does not have two thirds majority")
|
|
}
|
|
if !blockParts.HasHeader(blockID.PartsHeader) {
|
|
panic("Expected ProposalBlockParts header to be commit header")
|
|
}
|
|
if !block.HashesTo(blockID.Hash) {
|
|
panic("Cannot finalizeCommit, ProposalBlock does not hash to commit hash")
|
|
}
|
|
if err := cs.blockExec.ValidateBlock(cs.state, block); err != nil {
|
|
panic(fmt.Errorf("+2/3 committed an invalid block: %w", err))
|
|
}
|
|
|
|
cs.Logger.Info("Finalizing commit of block with N txs",
|
|
"height", block.Height,
|
|
"hash", block.Hash(),
|
|
"root", block.AppHash,
|
|
"N", len(block.Txs))
|
|
cs.Logger.Info(fmt.Sprintf("%v", block))
|
|
|
|
fail.Fail() // XXX
|
|
|
|
// Save to blockStore.
|
|
if cs.blockStore.Height() < block.Height {
|
|
// NOTE: the seenCommit is local justification to commit this block,
|
|
// but may differ from the LastCommit included in the next block
|
|
precommits := cs.Votes.Precommits(cs.CommitRound)
|
|
seenCommit := precommits.MakeCommit()
|
|
cs.blockStore.SaveBlock(block, blockParts, seenCommit)
|
|
} else {
|
|
// Happens during replay if we already saved the block but didn't commit
|
|
cs.Logger.Info("Calling finalizeCommit on already stored block", "height", block.Height)
|
|
}
|
|
|
|
fail.Fail() // XXX
|
|
|
|
// Write EndHeightMessage{} for this height, implying that the blockstore
|
|
// has saved the block.
|
|
//
|
|
// If we crash before writing this EndHeightMessage{}, we will recover by
|
|
// running ApplyBlock during the ABCI handshake when we restart. If we
|
|
// didn't save the block to the blockstore before writing
|
|
// EndHeightMessage{}, we'd have to change WAL replay -- currently it
|
|
// complains about replaying for heights where an #ENDHEIGHT entry already
|
|
// exists.
|
|
//
|
|
// Either way, the State should not be resumed until we
|
|
// successfully call ApplyBlock (ie. later here, or in Handshake after
|
|
// restart).
|
|
endMsg := EndHeightMessage{height}
|
|
if err := cs.wal.WriteSync(endMsg); err != nil { // NOTE: fsync
|
|
panic(fmt.Sprintf("Failed to write %v msg to consensus wal due to %v. Check your FS and restart the node",
|
|
endMsg, err))
|
|
}
|
|
|
|
fail.Fail() // XXX
|
|
|
|
// Create a copy of the state for staging and an event cache for txs.
|
|
stateCopy := cs.state.Copy()
|
|
|
|
// Execute and commit the block, update and save the state, and update the mempool.
|
|
// NOTE The block.AppHash wont reflect these txs until the next block.
|
|
var err error
|
|
var retainHeight int64
|
|
stateCopy, retainHeight, err = cs.blockExec.ApplyBlock(
|
|
stateCopy,
|
|
types.BlockID{Hash: block.Hash(), PartsHeader: blockParts.Header()},
|
|
block)
|
|
if err != nil {
|
|
cs.Logger.Error("Error on ApplyBlock. Did the application crash? Please restart tendermint", "err", err)
|
|
err := tmos.Kill()
|
|
if err != nil {
|
|
cs.Logger.Error("Failed to kill this process - please do so manually", "err", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
fail.Fail() // XXX
|
|
|
|
// Prune old heights, if requested by ABCI app.
|
|
if retainHeight > 0 {
|
|
pruned, err := cs.pruneBlocks(retainHeight)
|
|
if err != nil {
|
|
cs.Logger.Error("Failed to prune blocks", "retainHeight", retainHeight, "err", err)
|
|
} else {
|
|
cs.Logger.Info("Pruned blocks", "pruned", pruned, "retainHeight", retainHeight)
|
|
}
|
|
}
|
|
|
|
// must be called before we update state
|
|
cs.recordMetrics(height, block)
|
|
|
|
// NewHeightStep!
|
|
cs.updateToState(stateCopy)
|
|
|
|
fail.Fail() // XXX
|
|
|
|
// cs.StartTime is already set.
|
|
// Schedule Round0 to start soon.
|
|
cs.scheduleRound0(&cs.RoundState)
|
|
|
|
// By here,
|
|
// * cs.Height has been increment to height+1
|
|
// * cs.Step is now cstypes.RoundStepNewHeight
|
|
// * cs.StartTime is set to when we will start round0.
|
|
}
|
|
|
|
func (cs *State) pruneBlocks(retainHeight int64) (uint64, error) {
|
|
base := cs.blockStore.Base()
|
|
if retainHeight <= base {
|
|
return 0, nil
|
|
}
|
|
pruned, err := cs.blockStore.PruneBlocks(retainHeight)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("failed to prune block store: %w", err)
|
|
}
|
|
err = sm.PruneStates(cs.blockExec.DB(), base, retainHeight)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("failed to prune state database: %w", err)
|
|
}
|
|
return pruned, nil
|
|
}
|
|
|
|
func (cs *State) recordMetrics(height int64, block *types.Block) {
|
|
cs.metrics.Validators.Set(float64(cs.Validators.Size()))
|
|
cs.metrics.ValidatorsPower.Set(float64(cs.Validators.TotalVotingPower()))
|
|
|
|
var (
|
|
missingValidators int
|
|
missingValidatorsPower int64
|
|
)
|
|
// height=0 -> MissingValidators and MissingValidatorsPower are both 0.
|
|
// Remember that the first LastCommit is intentionally empty, so it's not
|
|
// fair to increment missing validators number.
|
|
if height > 1 {
|
|
// Sanity check that commit size matches validator set size - only applies
|
|
// after first block.
|
|
var (
|
|
commitSize = block.LastCommit.Size()
|
|
valSetLen = len(cs.LastValidators.Validators)
|
|
address types.Address
|
|
)
|
|
if commitSize != valSetLen {
|
|
panic(fmt.Sprintf("commit size (%d) doesn't match valset length (%d) at height %d\n\n%v\n\n%v",
|
|
commitSize, valSetLen, block.Height, block.LastCommit.Signatures, cs.LastValidators.Validators))
|
|
}
|
|
|
|
if cs.privValidator != nil {
|
|
pubkey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
// Metrics won't be updated, but it's not critical.
|
|
cs.Logger.Error("Error on retrieval of pubkey", "err", err)
|
|
} else {
|
|
address = pubkey.Address()
|
|
}
|
|
}
|
|
|
|
for i, val := range cs.LastValidators.Validators {
|
|
commitSig := block.LastCommit.Signatures[i]
|
|
if commitSig.Absent() {
|
|
missingValidators++
|
|
missingValidatorsPower += val.VotingPower
|
|
}
|
|
|
|
if bytes.Equal(val.Address, address) {
|
|
label := []string{
|
|
"validator_address", val.Address.String(),
|
|
}
|
|
cs.metrics.ValidatorPower.With(label...).Set(float64(val.VotingPower))
|
|
if commitSig.ForBlock() {
|
|
cs.metrics.ValidatorLastSignedHeight.With(label...).Set(float64(height))
|
|
} else {
|
|
cs.metrics.ValidatorMissedBlocks.With(label...).Add(float64(1))
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
cs.metrics.MissingValidators.Set(float64(missingValidators))
|
|
cs.metrics.MissingValidatorsPower.Set(float64(missingValidatorsPower))
|
|
|
|
cs.metrics.ByzantineValidators.Set(float64(len(block.Evidence.Evidence)))
|
|
byzantineValidatorsPower := int64(0)
|
|
for _, ev := range block.Evidence.Evidence {
|
|
if _, val := cs.Validators.GetByAddress(ev.Address()); val != nil {
|
|
byzantineValidatorsPower += val.VotingPower
|
|
}
|
|
}
|
|
cs.metrics.ByzantineValidatorsPower.Set(float64(byzantineValidatorsPower))
|
|
|
|
if height > 1 {
|
|
lastBlockMeta := cs.blockStore.LoadBlockMeta(height - 1)
|
|
if lastBlockMeta != nil {
|
|
cs.metrics.BlockIntervalSeconds.Set(
|
|
block.Time.Sub(lastBlockMeta.Header.Time).Seconds(),
|
|
)
|
|
}
|
|
}
|
|
|
|
cs.metrics.NumTxs.Set(float64(len(block.Data.Txs)))
|
|
cs.metrics.TotalTxs.Add(float64(len(block.Data.Txs)))
|
|
cs.metrics.BlockSizeBytes.Set(float64(block.Size()))
|
|
cs.metrics.CommittedHeight.Set(float64(block.Height))
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
func (cs *State) defaultSetProposal(proposal *types.Proposal) error {
|
|
// Already have one
|
|
// TODO: possibly catch double proposals
|
|
if cs.Proposal != nil {
|
|
return nil
|
|
}
|
|
|
|
// Does not apply
|
|
if proposal.Height != cs.Height || proposal.Round != cs.Round {
|
|
return nil
|
|
}
|
|
|
|
// Verify POLRound, which must be -1 or in range [0, proposal.Round).
|
|
if proposal.POLRound < -1 ||
|
|
(proposal.POLRound >= 0 && proposal.POLRound >= proposal.Round) {
|
|
return ErrInvalidProposalPOLRound
|
|
}
|
|
|
|
p := proposal.ToProto()
|
|
// Verify signature
|
|
if !cs.Validators.GetProposer().PubKey.VerifyBytes(types.ProposalSignBytes(cs.state.ChainID, p), proposal.Signature) {
|
|
return ErrInvalidProposalSignature
|
|
}
|
|
|
|
proposal.Signature = p.Signature
|
|
cs.Proposal = proposal
|
|
// We don't update cs.ProposalBlockParts if it is already set.
|
|
// This happens if we're already in cstypes.RoundStepCommit or if there is a valid block in the current round.
|
|
// TODO: We can check if Proposal is for a different block as this is a sign of misbehavior!
|
|
if cs.ProposalBlockParts == nil {
|
|
cs.ProposalBlockParts = types.NewPartSetFromHeader(proposal.BlockID.PartsHeader)
|
|
}
|
|
cs.Logger.Info("Received proposal", "proposal", proposal)
|
|
return nil
|
|
}
|
|
|
|
// NOTE: block is not necessarily valid.
|
|
// Asynchronously triggers either enterPrevote (before we timeout of propose) or tryFinalizeCommit,
|
|
// once we have the full block.
|
|
func (cs *State) addProposalBlockPart(msg *BlockPartMessage, peerID p2p.ID) (added bool, err error) {
|
|
height, round, part := msg.Height, msg.Round, msg.Part
|
|
|
|
// Blocks might be reused, so round mismatch is OK
|
|
if cs.Height != height {
|
|
cs.Logger.Debug("Received block part from wrong height", "height", height, "round", round)
|
|
return false, nil
|
|
}
|
|
|
|
// We're not expecting a block part.
|
|
if cs.ProposalBlockParts == nil {
|
|
// NOTE: this can happen when we've gone to a higher round and
|
|
// then receive parts from the previous round - not necessarily a bad peer.
|
|
cs.Logger.Info("Received a block part when we're not expecting any",
|
|
"height", height, "round", round, "index", part.Index, "peer", peerID)
|
|
return false, nil
|
|
}
|
|
|
|
added, err = cs.ProposalBlockParts.AddPart(part)
|
|
if err != nil {
|
|
return added, err
|
|
}
|
|
if added && cs.ProposalBlockParts.IsComplete() {
|
|
bz, err := ioutil.ReadAll(cs.ProposalBlockParts.GetReader())
|
|
if err != nil {
|
|
return added, err
|
|
}
|
|
var pbb = new(tmproto.Block)
|
|
err = proto.Unmarshal(bz, pbb)
|
|
if err != nil {
|
|
return added, err
|
|
}
|
|
block, err := types.BlockFromProto(pbb)
|
|
if err != nil {
|
|
return added, err
|
|
}
|
|
|
|
cs.ProposalBlock = block
|
|
// NOTE: it's possible to receive complete proposal blocks for future rounds without having the proposal
|
|
cs.Logger.Info("Received complete proposal block", "height", cs.ProposalBlock.Height, "hash", cs.ProposalBlock.Hash())
|
|
cs.eventBus.PublishEventCompleteProposal(cs.CompleteProposalEvent())
|
|
|
|
// Update Valid* if we can.
|
|
prevotes := cs.Votes.Prevotes(cs.Round)
|
|
blockID, hasTwoThirds := prevotes.TwoThirdsMajority()
|
|
if hasTwoThirds && !blockID.IsZero() && (cs.ValidRound < cs.Round) {
|
|
if cs.ProposalBlock.HashesTo(blockID.Hash) {
|
|
cs.Logger.Info("Updating valid block to new proposal block",
|
|
"valid-round", cs.Round, "valid-block-hash", cs.ProposalBlock.Hash())
|
|
cs.ValidRound = cs.Round
|
|
cs.ValidBlock = cs.ProposalBlock
|
|
cs.ValidBlockParts = cs.ProposalBlockParts
|
|
}
|
|
// TODO: In case there is +2/3 majority in Prevotes set for some
|
|
// block and cs.ProposalBlock contains different block, either
|
|
// proposer is faulty or voting power of faulty processes is more
|
|
// than 1/3. We should trigger in the future accountability
|
|
// procedure at this point.
|
|
}
|
|
|
|
if cs.Step <= cstypes.RoundStepPropose && cs.isProposalComplete() {
|
|
// Move onto the next step
|
|
cs.enterPrevote(height, cs.Round)
|
|
if hasTwoThirds { // this is optimisation as this will be triggered when prevote is added
|
|
cs.enterPrecommit(height, cs.Round)
|
|
}
|
|
} else if cs.Step == cstypes.RoundStepCommit {
|
|
// If we're waiting on the proposal block...
|
|
cs.tryFinalizeCommit(height)
|
|
}
|
|
return added, nil
|
|
}
|
|
return added, nil
|
|
}
|
|
|
|
// Attempt to add the vote. if its a duplicate signature, dupeout the validator
|
|
func (cs *State) tryAddVote(vote *types.Vote, peerID p2p.ID) (bool, error) {
|
|
added, err := cs.addVote(vote, peerID)
|
|
if err != nil {
|
|
// If the vote height is off, we'll just ignore it,
|
|
// But if it's a conflicting sig, add it to the cs.evpool.
|
|
// If it's otherwise invalid, punish peer.
|
|
// nolint: gocritic
|
|
if voteErr, ok := err.(*types.ErrVoteConflictingVotes); ok {
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
return false, fmt.Errorf("can't get pubkey: %w", err)
|
|
}
|
|
|
|
if bytes.Equal(vote.ValidatorAddress, pubKey.Address()) {
|
|
cs.Logger.Error(
|
|
"Found conflicting vote from ourselves. Did you unsafe_reset a validator?",
|
|
"height",
|
|
vote.Height,
|
|
"round",
|
|
vote.Round,
|
|
"type",
|
|
vote.Type)
|
|
return added, err
|
|
}
|
|
cs.evpool.AddEvidence(voteErr.DuplicateVoteEvidence)
|
|
return added, err
|
|
} else if err == types.ErrVoteNonDeterministicSignature {
|
|
cs.Logger.Debug("Vote has non-deterministic signature", "err", err)
|
|
} else {
|
|
// Either
|
|
// 1) bad peer OR
|
|
// 2) not a bad peer? this can also err sometimes with "Unexpected step" OR
|
|
// 3) tmkms use with multiple validators connecting to a single tmkms instance
|
|
// (https://github.com/tendermint/tendermint/issues/3839).
|
|
cs.Logger.Info("Error attempting to add vote", "err", err)
|
|
return added, ErrAddingVote
|
|
}
|
|
}
|
|
return added, nil
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
func (cs *State) addVote(
|
|
vote *types.Vote,
|
|
peerID p2p.ID) (added bool, err error) {
|
|
cs.Logger.Debug(
|
|
"addVote",
|
|
"voteHeight",
|
|
vote.Height,
|
|
"voteType",
|
|
vote.Type,
|
|
"valIndex",
|
|
vote.ValidatorIndex,
|
|
"csHeight",
|
|
cs.Height,
|
|
)
|
|
|
|
// A precommit for the previous height?
|
|
// These come in while we wait timeoutCommit
|
|
if vote.Height+1 == cs.Height && vote.Type == tmproto.PrecommitType {
|
|
if cs.Step != cstypes.RoundStepNewHeight {
|
|
// Late precommit at prior height is ignored
|
|
cs.Logger.Debug("Precommit vote came in after commit timeout and has been ignored", "vote", vote)
|
|
return
|
|
}
|
|
added, err = cs.LastCommit.AddVote(vote)
|
|
if !added {
|
|
return
|
|
}
|
|
|
|
cs.Logger.Info(fmt.Sprintf("Added to lastPrecommits: %v", cs.LastCommit.StringShort()))
|
|
cs.eventBus.PublishEventVote(types.EventDataVote{Vote: vote})
|
|
cs.evsw.FireEvent(types.EventVote, vote)
|
|
|
|
// if we can skip timeoutCommit and have all the votes now,
|
|
if cs.config.SkipTimeoutCommit && cs.LastCommit.HasAll() {
|
|
// go straight to new round (skip timeout commit)
|
|
// cs.scheduleTimeout(time.Duration(0), cs.Height, 0, cstypes.RoundStepNewHeight)
|
|
cs.enterNewRound(cs.Height, 0)
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
// Height mismatch is ignored.
|
|
// Not necessarily a bad peer, but not favourable behaviour.
|
|
if vote.Height != cs.Height {
|
|
cs.Logger.Info("Vote ignored and not added", "voteHeight", vote.Height, "csHeight", cs.Height, "peerID", peerID)
|
|
return
|
|
}
|
|
|
|
height := cs.Height
|
|
added, err = cs.Votes.AddVote(vote, peerID)
|
|
if !added {
|
|
// Either duplicate, or error upon cs.Votes.AddByIndex()
|
|
return
|
|
}
|
|
|
|
cs.eventBus.PublishEventVote(types.EventDataVote{Vote: vote})
|
|
cs.evsw.FireEvent(types.EventVote, vote)
|
|
|
|
switch vote.Type {
|
|
case tmproto.PrevoteType:
|
|
prevotes := cs.Votes.Prevotes(vote.Round)
|
|
cs.Logger.Info("Added to prevote", "vote", vote, "prevotes", prevotes.StringShort())
|
|
|
|
// If +2/3 prevotes for a block or nil for *any* round:
|
|
if blockID, ok := prevotes.TwoThirdsMajority(); ok {
|
|
|
|
// There was a polka!
|
|
// If we're locked but this is a recent polka, unlock.
|
|
// If it matches our ProposalBlock, update the ValidBlock
|
|
|
|
// Unlock if `cs.LockedRound < vote.Round <= cs.Round`
|
|
// NOTE: If vote.Round > cs.Round, we'll deal with it when we get to vote.Round
|
|
if (cs.LockedBlock != nil) &&
|
|
(cs.LockedRound < vote.Round) &&
|
|
(vote.Round <= cs.Round) &&
|
|
!cs.LockedBlock.HashesTo(blockID.Hash) {
|
|
|
|
cs.Logger.Info("Unlocking because of POL.", "lockedRound", cs.LockedRound, "POLRound", vote.Round)
|
|
cs.LockedRound = -1
|
|
cs.LockedBlock = nil
|
|
cs.LockedBlockParts = nil
|
|
// If this is not the first round and we have already locked onto something then we are
|
|
// changing the locked block so save POLC prevotes in evidence db in case of future justification
|
|
cs.savePOLC(vote.Round, blockID)
|
|
cs.eventBus.PublishEventUnlock(cs.RoundStateEvent())
|
|
}
|
|
|
|
// Update Valid* if we can.
|
|
// NOTE: our proposal block may be nil or not what received a polka..
|
|
if len(blockID.Hash) != 0 && (cs.ValidRound < vote.Round) && (vote.Round == cs.Round) {
|
|
|
|
if cs.ProposalBlock.HashesTo(blockID.Hash) {
|
|
cs.Logger.Info(
|
|
"Updating ValidBlock because of POL.", "validRound", cs.ValidRound, "POLRound", vote.Round)
|
|
cs.ValidRound = vote.Round
|
|
cs.ValidBlock = cs.ProposalBlock
|
|
cs.ValidBlockParts = cs.ProposalBlockParts
|
|
} else {
|
|
cs.Logger.Info(
|
|
"Valid block we don't know about. Set ProposalBlock=nil",
|
|
"proposal", cs.ProposalBlock.Hash(), "blockID", blockID.Hash)
|
|
// We're getting the wrong block.
|
|
cs.ProposalBlock = nil
|
|
}
|
|
if !cs.ProposalBlockParts.HasHeader(blockID.PartsHeader) {
|
|
cs.ProposalBlockParts = types.NewPartSetFromHeader(blockID.PartsHeader)
|
|
}
|
|
cs.evsw.FireEvent(types.EventValidBlock, &cs.RoundState)
|
|
cs.eventBus.PublishEventValidBlock(cs.RoundStateEvent())
|
|
}
|
|
}
|
|
|
|
// If +2/3 prevotes for *anything* for future round:
|
|
switch {
|
|
case cs.Round < vote.Round && prevotes.HasTwoThirdsAny():
|
|
// Round-skip if there is any 2/3+ of votes ahead of us
|
|
cs.enterNewRound(height, vote.Round)
|
|
case cs.Round == vote.Round && cstypes.RoundStepPrevote <= cs.Step: // current round
|
|
blockID, ok := prevotes.TwoThirdsMajority()
|
|
if ok && (cs.isProposalComplete() || len(blockID.Hash) == 0) {
|
|
cs.enterPrecommit(height, vote.Round)
|
|
} else if prevotes.HasTwoThirdsAny() {
|
|
cs.enterPrevoteWait(height, vote.Round)
|
|
}
|
|
case cs.Proposal != nil && 0 <= cs.Proposal.POLRound && cs.Proposal.POLRound == vote.Round:
|
|
// If the proposal is now complete, enter prevote of cs.Round.
|
|
if cs.isProposalComplete() {
|
|
cs.enterPrevote(height, cs.Round)
|
|
}
|
|
}
|
|
|
|
case tmproto.PrecommitType:
|
|
precommits := cs.Votes.Precommits(vote.Round)
|
|
cs.Logger.Info("Added to precommit", "vote", vote, "precommits", precommits.StringShort())
|
|
|
|
blockID, ok := precommits.TwoThirdsMajority()
|
|
if ok {
|
|
// Executed as TwoThirdsMajority could be from a higher round
|
|
cs.enterNewRound(height, vote.Round)
|
|
cs.enterPrecommit(height, vote.Round)
|
|
if len(blockID.Hash) != 0 {
|
|
cs.enterCommit(height, vote.Round)
|
|
if cs.config.SkipTimeoutCommit && precommits.HasAll() {
|
|
cs.enterNewRound(cs.Height, 0)
|
|
}
|
|
} else {
|
|
cs.enterPrecommitWait(height, vote.Round)
|
|
}
|
|
} else if cs.Round <= vote.Round && precommits.HasTwoThirdsAny() {
|
|
cs.enterNewRound(height, vote.Round)
|
|
cs.enterPrecommitWait(height, vote.Round)
|
|
}
|
|
|
|
default:
|
|
panic(fmt.Sprintf("Unexpected vote type %v", vote.Type))
|
|
}
|
|
|
|
return added, err
|
|
}
|
|
|
|
// CONTRACT: cs.privValidator is not nil.
|
|
func (cs *State) signVote(
|
|
msgType tmproto.SignedMsgType,
|
|
hash []byte,
|
|
header types.PartSetHeader,
|
|
) (*types.Vote, error) {
|
|
// Flush the WAL. Otherwise, we may not recompute the same vote to sign,
|
|
// and the privValidator will refuse to sign anything.
|
|
cs.wal.FlushAndSync()
|
|
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("can't get pubkey: %w", err)
|
|
}
|
|
addr := pubKey.Address()
|
|
valIdx, _ := cs.Validators.GetByAddress(addr)
|
|
|
|
vote := &types.Vote{
|
|
ValidatorAddress: addr,
|
|
ValidatorIndex: valIdx,
|
|
Height: cs.Height,
|
|
Round: cs.Round,
|
|
Timestamp: cs.voteTime(),
|
|
Type: msgType,
|
|
BlockID: types.BlockID{Hash: hash, PartsHeader: header},
|
|
}
|
|
v := vote.ToProto()
|
|
err = cs.privValidator.SignVote(cs.state.ChainID, v)
|
|
vote.Signature = v.Signature
|
|
|
|
return vote, err
|
|
}
|
|
|
|
func (cs *State) voteTime() time.Time {
|
|
now := tmtime.Now()
|
|
minVoteTime := now
|
|
// TODO: We should remove next line in case we don't vote for v in case cs.ProposalBlock == nil,
|
|
// even if cs.LockedBlock != nil. See https://docs.tendermint.com/master/spec/.
|
|
timeIota := time.Duration(cs.state.ConsensusParams.Block.TimeIotaMs) * time.Millisecond
|
|
if cs.LockedBlock != nil {
|
|
// See the BFT time spec https://docs.tendermint.com/master/spec/consensus/bft-time.html
|
|
minVoteTime = cs.LockedBlock.Time.Add(timeIota)
|
|
} else if cs.ProposalBlock != nil {
|
|
minVoteTime = cs.ProposalBlock.Time.Add(timeIota)
|
|
}
|
|
|
|
if now.After(minVoteTime) {
|
|
return now
|
|
}
|
|
return minVoteTime
|
|
}
|
|
|
|
// sign the vote and publish on internalMsgQueue
|
|
func (cs *State) signAddVote(msgType tmproto.SignedMsgType, hash []byte, header types.PartSetHeader) *types.Vote {
|
|
if cs.privValidator == nil { // the node does not have a key
|
|
return nil
|
|
}
|
|
|
|
pubKey, err := cs.privValidator.GetPubKey()
|
|
if err != nil {
|
|
// Vote won't be signed, but it's not critical.
|
|
cs.Logger.Error("Error on retrival of pubkey", "err", err)
|
|
return nil
|
|
}
|
|
|
|
// If the node not in the validator set, do nothing.
|
|
if !cs.Validators.HasAddress(pubKey.Address()) {
|
|
return nil
|
|
}
|
|
|
|
// TODO: pass pubKey to signVote
|
|
vote, err := cs.signVote(msgType, hash, header)
|
|
if err == nil {
|
|
cs.sendInternalMessage(msgInfo{&VoteMessage{vote}, ""})
|
|
cs.Logger.Info("Signed and pushed vote", "height", cs.Height, "round", cs.Round, "vote", vote, "err", err)
|
|
return vote
|
|
}
|
|
//if !cs.replayMode {
|
|
cs.Logger.Error("Error signing vote", "height", cs.Height, "round", cs.Round, "vote", vote, "err", err)
|
|
//}
|
|
return nil
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
|
|
func CompareHRS(h1 int64, r1 int32, s1 cstypes.RoundStepType, h2 int64, r2 int32, s2 cstypes.RoundStepType) int {
|
|
if h1 < h2 {
|
|
return -1
|
|
} else if h1 > h2 {
|
|
return 1
|
|
}
|
|
if r1 < r2 {
|
|
return -1
|
|
} else if r1 > r2 {
|
|
return 1
|
|
}
|
|
if s1 < s2 {
|
|
return -1
|
|
} else if s1 > s2 {
|
|
return 1
|
|
}
|
|
return 0
|
|
}
|
|
|
|
// repairWalFile decodes messages from src (until the decoder errors) and
|
|
// writes them to dst.
|
|
func repairWalFile(src, dst string) error {
|
|
in, err := os.Open(src)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer in.Close()
|
|
|
|
out, err := os.Open(dst)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer out.Close()
|
|
|
|
var (
|
|
dec = NewWALDecoder(in)
|
|
enc = NewWALEncoder(out)
|
|
)
|
|
|
|
// best-case repair (until first error is encountered)
|
|
for {
|
|
msg, err := dec.Decode()
|
|
if err != nil {
|
|
break
|
|
}
|
|
|
|
err = enc.Encode(msg)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to encode msg: %w", err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|