aboutsummaryrefslogtreecommitdiffstats
path: root/core/test/stopper.go
blob: abc93c372109401c01dfdae0cb24f23a92729edb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 dexon-consensus 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 dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package test

import (
    "sync"

    "github.com/dexon-foundation/dexon-consensus/core/blockdb"
    "github.com/dexon-foundation/dexon-consensus/core/types"
)

// StopByConfirmedBlocks would make sure each nodes confirms
// at least X blocks proposed by itself.
type StopByConfirmedBlocks struct {
    apps               map[types.NodeID]*App
    dbs                map[types.NodeID]blockdb.BlockDatabase
    lastCheckDelivered map[types.NodeID]int
    confirmedBlocks    map[types.NodeID]int
    blockCount         int
    lock               sync.Mutex
}

// NewStopByConfirmedBlocks construct an StopByConfirmedBlocks instance.
func NewStopByConfirmedBlocks(
    blockCount int,
    apps map[types.NodeID]*App,
    dbs map[types.NodeID]blockdb.BlockDatabase) *StopByConfirmedBlocks {
    confirmedBlocks := make(map[types.NodeID]int)
    for nID := range apps {
        confirmedBlocks[nID] = 0
    }
    return &StopByConfirmedBlocks{
        apps:               apps,
        dbs:                dbs,
        lastCheckDelivered: make(map[types.NodeID]int),
        confirmedBlocks:    confirmedBlocks,
        blockCount:         blockCount,
    }
}

// ShouldStop implements Stopper interface.
func (s *StopByConfirmedBlocks) ShouldStop(nID types.NodeID) bool {
    s.lock.Lock()
    defer s.lock.Unlock()
    // Accumulate confirmed blocks proposed by this node in this round.
    lastChecked := s.lastCheckDelivered[nID]
    currentConfirmedBlocks := s.confirmedBlocks[nID]
    db := s.dbs[nID]
    s.apps[nID].Check(func(app *App) {
        for _, h := range app.DeliverSequence[lastChecked:] {
            b, err := db.Get(h)
            if err != nil {
                panic(err)
            }
            if b.ProposerID == nID {
                currentConfirmedBlocks++
            }
        }
        s.lastCheckDelivered[nID] = len(app.DeliverSequence)
    })
    s.confirmedBlocks[nID] = currentConfirmedBlocks
    // Check if all nodes confirmed at least 'blockCount' blocks.
    for _, v := range s.confirmedBlocks {
        if v < s.blockCount {
            return false
        }
    }
    return true
}

// StopByRound would make sure at least one block at round R is delivered
// at each node.
type StopByRound struct {
    untilRound         uint64
    currentRounds      map[types.NodeID]uint64
    lastCheckDelivered map[types.NodeID]int
    apps               map[types.NodeID]*App
    dbs                map[types.NodeID]blockdb.BlockDatabase
    lock               sync.Mutex
}

// NewStopByRound constructs an StopByRound instance.
func NewStopByRound(
    round uint64,
    apps map[types.NodeID]*App,
    dbs map[types.NodeID]blockdb.BlockDatabase) *StopByRound {
    return &StopByRound{
        untilRound:         round,
        currentRounds:      make(map[types.NodeID]uint64),
        lastCheckDelivered: make(map[types.NodeID]int),
        apps:               apps,
        dbs:                dbs,
    }
}

// ShouldStop implements Stopper interface.
func (s *StopByRound) ShouldStop(nID types.NodeID) bool {
    s.lock.Lock()
    defer s.lock.Unlock()
    // Cache latest round of this node.
    if curRound := s.currentRounds[nID]; curRound < s.untilRound {
        lastChecked := s.lastCheckDelivered[nID]
        db := s.dbs[nID]
        s.apps[nID].Check(func(app *App) {
            for _, h := range app.DeliverSequence[lastChecked:] {
                b, err := db.Get(h)
                if err != nil {
                    panic(err)
                }
                if b.Position.Round > curRound {
                    curRound = b.Position.Round
                }
            }
            s.lastCheckDelivered[nID] = len(app.DeliverSequence)
            s.currentRounds[nID] = curRound
        })
    }
    // Check if latest round on each node is later than untilRound.
    for _, round := range s.currentRounds {
        if round < s.untilRound {
            return false
        }
    }
    return true
}