-
Notifications
You must be signed in to change notification settings - Fork 199
/
chronology.go
246 lines (190 loc) · 6.21 KB
/
chronology.go
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
package chronology
import (
"context"
"fmt"
"sync"
"time"
"github.com/ElrondNetwork/elrond-go-logger"
"github.com/ElrondNetwork/elrond-go/consensus"
"github.com/ElrondNetwork/elrond-go/core"
"github.com/ElrondNetwork/elrond-go/core/check"
"github.com/ElrondNetwork/elrond-go/core/closing"
"github.com/ElrondNetwork/elrond-go/display"
"github.com/ElrondNetwork/elrond-go/ntp"
"github.com/ElrondNetwork/elrond-go/statusHandler"
)
var _ consensus.ChronologyHandler = (*chronology)(nil)
var _ closing.Closer = (*chronology)(nil)
var log = logger.GetOrCreate("consensus/chronology")
// srBeforeStartRound defines the state which exist before the start of the round
const srBeforeStartRound = -1
const numRoundsToWaitBeforeSignalingChronologyStuck = 10
const chronologyAlarmID = "chronology"
// chronology defines the data needed by the chronology
type chronology struct {
genesisTime time.Time
rounder consensus.Rounder
syncTimer ntp.SyncTimer
subroundId int
subrounds map[int]int
subroundHandlers []consensus.SubroundHandler
mutSubrounds sync.RWMutex
appStatusHandler core.AppStatusHandler
cancelFunc func()
watchdog core.WatchdogTimer
}
// NewChronology creates a new chronology object
func NewChronology(
genesisTime time.Time,
rounder consensus.Rounder,
syncTimer ntp.SyncTimer,
watchdog core.WatchdogTimer,
) (*chronology, error) {
err := checkNewChronologyParams(
rounder,
syncTimer,
watchdog,
)
if err != nil {
return nil, err
}
chr := chronology{
genesisTime: genesisTime,
rounder: rounder,
syncTimer: syncTimer,
appStatusHandler: statusHandler.NewNilStatusHandler(),
watchdog: watchdog,
}
chr.subroundId = srBeforeStartRound
chr.subrounds = make(map[int]int)
chr.subroundHandlers = make([]consensus.SubroundHandler, 0)
return &chr, nil
}
func checkNewChronologyParams(
rounder consensus.Rounder,
syncTimer ntp.SyncTimer,
watchdog core.WatchdogTimer,
) error {
if check.IfNil(rounder) {
return ErrNilRounder
}
if check.IfNil(syncTimer) {
return ErrNilSyncTimer
}
if check.IfNil(watchdog) {
return ErrNilWatchdog
}
return nil
}
// SetAppStatusHandler will set the AppStatusHandler which will be used for monitoring
func (chr *chronology) SetAppStatusHandler(ash core.AppStatusHandler) error {
if ash == nil || ash.IsInterfaceNil() {
return ErrNilAppStatusHandler
}
chr.appStatusHandler = ash
return nil
}
// AddSubround adds new SubroundHandler implementation to the chronology
func (chr *chronology) AddSubround(subroundHandler consensus.SubroundHandler) {
chr.mutSubrounds.Lock()
chr.subrounds[subroundHandler.Current()] = len(chr.subroundHandlers)
chr.subroundHandlers = append(chr.subroundHandlers, subroundHandler)
chr.mutSubrounds.Unlock()
}
// RemoveAllSubrounds removes all the SubroundHandler implementations added to the chronology
func (chr *chronology) RemoveAllSubrounds() {
chr.mutSubrounds.Lock()
chr.subrounds = make(map[int]int)
chr.subroundHandlers = make([]consensus.SubroundHandler, 0)
chr.mutSubrounds.Unlock()
}
// StartRounds actually starts the chronology and calls the DoWork() method of the subroundHandlers loaded
func (chr *chronology) StartRounds() {
watchdogAlarmDuration := chr.rounder.TimeDuration() * numRoundsToWaitBeforeSignalingChronologyStuck
chr.watchdog.SetDefault(watchdogAlarmDuration, chronologyAlarmID)
var ctx context.Context
ctx, chr.cancelFunc = context.WithCancel(context.Background())
go chr.startRounds(ctx)
}
func (chr *chronology) startRounds(ctx context.Context) {
for {
select {
case <-ctx.Done():
log.Debug("chronology's go routine is stopping...")
return
case <-time.After(time.Millisecond):
}
chr.startRound()
}
}
// startRound calls the current subround, given by the finished tasks in this round
func (chr *chronology) startRound() {
if chr.subroundId == srBeforeStartRound {
chr.updateRound()
}
if chr.rounder.BeforeGenesis() {
return
}
sr := chr.loadSubroundHandler(chr.subroundId)
if sr == nil {
return
}
msg := fmt.Sprintf("SUBROUND %s BEGINS", sr.Name())
log.Debug(display.Headline(msg, chr.syncTimer.FormattedCurrentTime(), "."))
logger.SetCorrelationSubround(sr.Name())
if !sr.DoWork(chr.rounder) {
chr.subroundId = srBeforeStartRound
return
}
chr.subroundId = sr.Next()
}
// updateRound updates rounds and subrounds depending of the current time and the finished tasks
func (chr *chronology) updateRound() {
oldRoundIndex := chr.rounder.Index()
chr.rounder.UpdateRound(chr.genesisTime, chr.syncTimer.CurrentTime())
if oldRoundIndex != chr.rounder.Index() {
chr.watchdog.Reset(chronologyAlarmID)
msg := fmt.Sprintf("ROUND %d BEGINS (%d)", chr.rounder.Index(), chr.rounder.TimeStamp().Unix())
log.Debug(display.Headline(msg, chr.syncTimer.FormattedCurrentTime(), "#"))
logger.SetCorrelationRound(chr.rounder.Index())
chr.initRound()
}
}
// initRound is called when a new round begins and it does the necessary initialization
func (chr *chronology) initRound() {
chr.subroundId = srBeforeStartRound
chr.mutSubrounds.RLock()
hasSubroundsAndGenesisTimePassed := !chr.rounder.BeforeGenesis() && len(chr.subroundHandlers) > 0
if hasSubroundsAndGenesisTimePassed {
chr.subroundId = chr.subroundHandlers[0].Current()
chr.appStatusHandler.SetUInt64Value(core.MetricCurrentRound, uint64(chr.rounder.Index()))
chr.appStatusHandler.SetUInt64Value(core.MetricCurrentRoundTimestamp, uint64(chr.rounder.TimeStamp().Unix()))
}
chr.mutSubrounds.RUnlock()
}
// loadSubroundHandler returns the implementation of SubroundHandler given by the subroundId
func (chr *chronology) loadSubroundHandler(subroundId int) consensus.SubroundHandler {
chr.mutSubrounds.RLock()
defer chr.mutSubrounds.RUnlock()
index, exist := chr.subrounds[subroundId]
if !exist {
return nil
}
indexIsOutOfBounds := index < 0 || index >= len(chr.subroundHandlers)
if indexIsOutOfBounds {
return nil
}
return chr.subroundHandlers[index]
}
// Close will close the endless running go routine
func (chr *chronology) Close() error {
if chr.cancelFunc != nil {
chr.cancelFunc()
}
chr.watchdog.Stop(chronologyAlarmID)
return nil
}
// IsInterfaceNil returns true if there is no value under the interface
func (chr *chronology) IsInterfaceNil() bool {
return chr == nil
}