123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- // Copyright 2017 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Lesser General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // The go-ethereum library is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- package core
- import (
- "math"
- "math/big"
- "sync"
- "time"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/consensus/istanbul"
- qbfttypes "github.com/ethereum/go-ethereum/consensus/istanbul/qbft/types"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/event"
- "github.com/ethereum/go-ethereum/log"
- metrics "github.com/ethereum/go-ethereum/metrics"
- "gopkg.in/karalabe/cookiejar.v2/collections/prque"
- )
- var (
- roundMeter = metrics.NewRegisteredMeter("consensus/istanbul/qbft/core/round", nil)
- sequenceMeter = metrics.NewRegisteredMeter("consensus/istanbul/qbft/core/sequence", nil)
- consensusTimer = metrics.NewRegisteredTimer("consensus/istanbul/qbft/core/consensus", nil)
- )
- // New creates an Istanbul consensus core
- func New(backend istanbul.Backend, config *istanbul.Config) istanbul.Core {
- c := &core{
- config: config,
- address: backend.Address(),
- state: StateAcceptRequest,
- handlerWg: new(sync.WaitGroup),
- logger: log.New("address", backend.Address()),
- backend: backend,
- backlogs: make(map[common.Address]*prque.Prque),
- backlogsMu: new(sync.Mutex),
- pendingRequests: prque.New(),
- pendingRequestsMu: new(sync.Mutex),
- consensusTimestamp: time.Time{},
- }
- c.validateFn = c.checkValidatorSignature
- return c
- }
- // ----------------------------------------------------------------------------
- type core struct {
- config *istanbul.Config
- address common.Address
- state State
- logger log.Logger
- backend istanbul.Backend
- events *event.TypeMuxSubscription
- finalCommittedSub *event.TypeMuxSubscription
- timeoutSub *event.TypeMuxSubscription
- futurePreprepareTimer *time.Timer
- valSet istanbul.ValidatorSet
- validateFn func([]byte, []byte) (common.Address, error)
- backlogs map[common.Address]*prque.Prque
- backlogsMu *sync.Mutex
- current *roundState
- handlerWg *sync.WaitGroup
- roundChangeSet *roundChangeSet
- roundChangeTimer *time.Timer
- QBFTPreparedPrepares []*qbfttypes.Prepare
- pendingRequests *prque.Prque
- pendingRequestsMu *sync.Mutex
- consensusTimestamp time.Time
- newRoundMutex sync.Mutex
- newRoundTimer *time.Timer
- }
- func (c *core) currentView() *istanbul.View {
- return &istanbul.View{
- Sequence: new(big.Int).Set(c.current.Sequence()),
- Round: new(big.Int).Set(c.current.Round()),
- }
- }
- func (c *core) IsProposer() bool {
- v := c.valSet
- if v == nil {
- return false
- }
- return v.IsProposer(c.backend.Address())
- }
- func (c *core) IsCurrentProposal(blockHash common.Hash) bool {
- return c.current != nil && c.current.pendingRequest != nil && c.current.pendingRequest.Proposal.Hash() == blockHash
- }
- // startNewRound starts a new round. if round equals to 0, it means to starts a new sequence
- func (c *core) startNewRound(round *big.Int) {
- var logger log.Logger
- if c.current == nil {
- logger = c.logger.New("old.round", -1, "old.seq", 0)
- } else {
- logger = c.currentLogger(false, nil)
- }
- logger = logger.New("target.round", round)
- roundChange := false
- // Try to get last proposal
- lastProposal, lastProposer := c.backend.LastProposal()
- if lastProposal != nil {
- logger = logger.New("lastProposal.number", lastProposal.Number().Uint64(), "lastProposal.hash", lastProposal.Hash())
- }
- logger.Info("QBFT: initialize new round")
- if c.current == nil {
- logger.Debug("QBFT: start at the initial round")
- } else if lastProposal.Number().Cmp(c.current.Sequence()) >= 0 {
- diff := new(big.Int).Sub(lastProposal.Number(), c.current.Sequence())
- sequenceMeter.Mark(new(big.Int).Add(diff, common.Big1).Int64())
- if !c.consensusTimestamp.IsZero() {
- consensusTimer.UpdateSince(c.consensusTimestamp)
- c.consensusTimestamp = time.Time{}
- }
- logger.Debug("QBFT: catch up last block proposal")
- } else if lastProposal.Number().Cmp(big.NewInt(c.current.Sequence().Int64()-1)) == 0 {
- if round.Cmp(common.Big0) == 0 {
- // same seq and round, don't need to start new round
- logger.Debug("QBFT: same round, no need to start new round")
- return
- } else if round.Cmp(c.current.Round()) < 0 {
- logger.Warn("QBFT: next round is inferior to current round")
- return
- }
- roundChange = true
- } else {
- logger.Warn("QBFT: next sequence is before last block proposal")
- return
- }
- var oldLogger log.Logger
- if c.current == nil {
- oldLogger = c.logger.New("old.round", -1, "old.seq", 0)
- } else {
- oldLogger = c.logger.New("old.round", c.current.Round().Uint64(), "old.sequence", c.current.Sequence().Uint64(), "old.state", c.state.String(), "old.proposer", c.valSet.GetProposer())
- }
- // Create next view
- var newView *istanbul.View
- if roundChange {
- newView = &istanbul.View{
- Sequence: new(big.Int).Set(c.current.Sequence()),
- Round: new(big.Int).Set(round),
- }
- } else {
- newView = &istanbul.View{
- Sequence: new(big.Int).Add(lastProposal.Number(), common.Big1),
- Round: new(big.Int),
- }
- c.valSet = c.backend.Validators(lastProposal)
- }
- // New snapshot for new round
- c.updateRoundState(newView, c.valSet, roundChange)
- // Calculate new proposer
- c.valSet.CalcProposer(lastProposer, newView.Round.Uint64())
- c.setState(StateAcceptRequest)
- if c.current != nil && round.Cmp(c.current.Round()) > 0 {
- roundMeter.Mark(new(big.Int).Sub(round, c.current.Round()).Int64())
- }
- // Update RoundChangeSet by deleting older round messages
- if round.Uint64() == 0 {
- c.QBFTPreparedPrepares = nil
- c.roundChangeSet = newRoundChangeSet(c.valSet)
- } else {
- // Clear earlier round messages
- c.roundChangeSet.ClearLowerThan(round)
- }
- c.roundChangeSet.NewRound(round)
- if round.Uint64() > 0 {
- c.newRoundChangeTimer()
- }
- oldLogger.Info("QBFT: start new round", "next.round", newView.Round, "next.seq", newView.Sequence, "next.proposer", c.valSet.GetProposer(), "next.valSet", c.valSet.List(), "next.size", c.valSet.Size(), "next.IsProposer", c.IsProposer())
- }
- // updateRoundState updates round state by checking if locking block is necessary
- func (c *core) updateRoundState(view *istanbul.View, validatorSet istanbul.ValidatorSet, roundChange bool) {
- if roundChange && c.current != nil {
- c.current = newRoundState(view, validatorSet, c.current.Preprepare, c.current.preparedRound, c.current.preparedBlock, c.current.pendingRequest, c.backend.HasBadProposal)
- } else {
- c.current = newRoundState(view, validatorSet, nil, nil, nil, nil, c.backend.HasBadProposal)
- }
- }
- func (c *core) setState(state State) {
- if c.state != state {
- oldState := c.state
- c.state = state
- c.currentLogger(false, nil).Info("QBFT: changed state", "old.state", oldState.String(), "new.state", state.String())
- }
- if state == StateAcceptRequest {
- c.processPendingRequests()
- }
- // each time we change state, we process backlog for possible message that are
- // now ready
- c.processBacklog()
- }
- func (c *core) Address() common.Address {
- return c.address
- }
- func (c *core) stopFuturePreprepareTimer() {
- if c.futurePreprepareTimer != nil {
- c.futurePreprepareTimer.Stop()
- }
- }
- func (c *core) stopTimer() {
- c.stopFuturePreprepareTimer()
- if c.roundChangeTimer != nil {
- c.roundChangeTimer.Stop()
- }
- }
- func (c *core) newRoundChangeTimer() {
- c.stopTimer()
- for c.current == nil { // wait because it is asynchronous in handleRequest
- time.Sleep(10 * time.Millisecond)
- }
- // set timeout based on the round number
- baseTimeout := time.Duration(c.config.GetConfig(c.current.Sequence()).RequestTimeout) * time.Millisecond
- round := c.current.Round().Uint64()
- timeout := baseTimeout * time.Duration(math.Pow(2, float64(round)))
- c.currentLogger(true, nil).Trace("QBFT: start new ROUND-CHANGE timer", "timeout", timeout.Seconds())
- c.roundChangeTimer = time.AfterFunc(timeout, func() {
- c.sendEvent(timeoutEvent{})
- })
- }
- func (c *core) checkValidatorSignature(data []byte, sig []byte) (common.Address, error) {
- return istanbul.CheckValidatorSignature(c.valSet, data, sig)
- }
- func (c *core) QuorumSize() int {
- if c.config.Get2FPlus1Enabled(c.current.sequence) || c.config.Ceil2Nby3Block == nil || (c.current != nil && c.current.sequence.Cmp(c.config.Ceil2Nby3Block) < 0) {
- c.currentLogger(true, nil).Trace("QBFT: confirmation Formula used 2F+ 1")
- return (2 * c.valSet.F()) + 1
- }
- c.currentLogger(true, nil).Trace("QBFT: confirmation Formula used ceil(2N/3)")
- return int(math.Ceil(float64(2*c.valSet.Size()) / 3))
- }
- // PrepareCommittedSeal returns a committed seal for the given header and takes current round under consideration
- func PrepareCommittedSeal(header *types.Header, round uint32) []byte {
- h := types.CopyHeader(header)
- return h.QBFTHashWithRoundNumber(round).Bytes()
- }
|