-
Notifications
You must be signed in to change notification settings - Fork 175
/
engine.go
401 lines (351 loc) · 12.1 KB
/
engine.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package compliance
import (
"context"
"errors"
"fmt"
"time"
"github.com/rs/zerolog"
"github.com/onflow/flow-go/engine"
"github.com/onflow/flow-go/engine/common/fifoqueue"
"github.com/onflow/flow-go/model/events"
"github.com/onflow/flow-go/model/flow"
"github.com/onflow/flow-go/model/flow/filter"
"github.com/onflow/flow-go/model/messages"
"github.com/onflow/flow-go/module"
"github.com/onflow/flow-go/module/irrecoverable"
"github.com/onflow/flow-go/module/lifecycle"
"github.com/onflow/flow-go/module/metrics"
"github.com/onflow/flow-go/network"
"github.com/onflow/flow-go/state/protocol"
"github.com/onflow/flow-go/storage"
"github.com/onflow/flow-go/utils/logging"
)
// defaultBlockQueueCapacity maximum capacity of block proposals queue
const defaultBlockQueueCapacity = 10000
// defaultVoteQueueCapacity maximum capacity of block votes queue
const defaultVoteQueueCapacity = 1000
// Engine is a wrapper struct for `Core` which implements consensus algorithm.
// Engine is responsible for handling incoming messages, queueing for processing, broadcasting proposals.
type Engine struct {
unit *engine.Unit
lm *lifecycle.LifecycleManager
log zerolog.Logger
mempool module.MempoolMetrics
metrics module.EngineMetrics
me module.Local
headers storage.Headers
payloads storage.Payloads
tracer module.Tracer
state protocol.State
prov network.Engine
core *Core
pendingBlocks engine.MessageStore
pendingVotes engine.MessageStore
messageHandler *engine.MessageHandler
con network.Conduit
stopHotstuff context.CancelFunc
}
func NewEngine(
log zerolog.Logger,
net network.Network,
me module.Local,
prov network.Engine,
core *Core) (*Engine, error) {
// FIFO queue for block proposals
blocksQueue, err := fifoqueue.NewFifoQueue(
fifoqueue.WithCapacity(defaultBlockQueueCapacity),
fifoqueue.WithLengthObserver(func(len int) { core.mempool.MempoolEntries(metrics.ResourceBlockProposalQueue, uint(len)) }),
)
if err != nil {
return nil, fmt.Errorf("failed to create queue for inbound receipts: %w", err)
}
pendingBlocks := &engine.FifoMessageStore{
FifoQueue: blocksQueue,
}
// FIFO queue for block votes
votesQueue, err := fifoqueue.NewFifoQueue(
fifoqueue.WithCapacity(defaultVoteQueueCapacity),
fifoqueue.WithLengthObserver(func(len int) { core.mempool.MempoolEntries(metrics.ResourceBlockVoteQueue, uint(len)) }),
)
if err != nil {
return nil, fmt.Errorf("failed to create queue for inbound approvals: %w", err)
}
pendingVotes := &engine.FifoMessageStore{FifoQueue: votesQueue}
// define message queueing behaviour
handler := engine.NewMessageHandler(
log.With().Str("compliance", "engine").Logger(),
engine.NewNotifier(),
engine.Pattern{
Match: func(msg *engine.Message) bool {
_, ok := msg.Payload.(*messages.BlockProposal)
if ok {
core.metrics.MessageReceived(metrics.EngineCompliance, metrics.MessageBlockProposal)
}
return ok
},
Store: pendingBlocks,
},
engine.Pattern{
Match: func(msg *engine.Message) bool {
_, ok := msg.Payload.(*events.SyncedBlock)
if ok {
core.metrics.MessageReceived(metrics.EngineCompliance, metrics.MessageSyncedBlock)
}
return ok
},
Map: func(msg *engine.Message) (*engine.Message, bool) {
syncedBlock := msg.Payload.(*events.SyncedBlock)
msg = &engine.Message{
OriginID: msg.OriginID,
Payload: &messages.BlockProposal{
Payload: syncedBlock.Block.Payload,
Header: syncedBlock.Block.Header,
},
}
return msg, true
},
Store: pendingBlocks,
},
engine.Pattern{
Match: func(msg *engine.Message) bool {
_, ok := msg.Payload.(*messages.BlockVote)
if ok {
core.metrics.MessageReceived(metrics.EngineCompliance, metrics.MessageBlockVote)
}
return ok
},
Store: pendingVotes,
},
)
eng := &Engine{
unit: engine.NewUnit(),
lm: lifecycle.NewLifecycleManager(),
log: log.With().Str("compliance", "engine").Logger(),
me: me,
mempool: core.mempool,
metrics: core.metrics,
headers: core.headers,
payloads: core.payloads,
pendingBlocks: pendingBlocks,
pendingVotes: pendingVotes,
state: core.state,
tracer: core.tracer,
prov: prov,
core: core,
messageHandler: handler,
}
// register the core with the network layer and store the conduit
eng.con, err = net.Register(engine.ConsensusCommittee, eng)
if err != nil {
return nil, fmt.Errorf("could not register core: %w", err)
}
return eng, nil
}
// WithConsensus adds the consensus algorithm to the engine. This must be
// called before the engine can start.
func (e *Engine) WithConsensus(hot module.HotStuff) *Engine {
e.core.hotstuff = hot
return e
}
// Ready returns a ready channel that is closed once the engine has fully
// started. For consensus engine, this is true once the underlying consensus
// algorithm has started.
func (e *Engine) Ready() <-chan struct{} {
if e.core.hotstuff == nil {
panic("must initialize compliance engine with hotstuff engine")
}
e.lm.OnStart(func() {
e.unit.Launch(e.loop)
ctx, cancel := context.WithCancel(context.Background())
signalerCtx, _ := irrecoverable.WithSignaler(ctx)
e.stopHotstuff = cancel
e.core.hotstuff.Start(signalerCtx)
// wait for request handler to startup
<-e.core.hotstuff.Ready()
})
return e.lm.Started()
}
// Done returns a done channel that is closed once the engine has fully stopped.
// For the consensus engine, we wait for hotstuff to finish.
func (e *Engine) Done() <-chan struct{} {
e.lm.OnStop(func() {
e.log.Info().Msg("shutting down hotstuff eventloop")
e.stopHotstuff()
<-e.core.hotstuff.Done()
e.log.Info().Msg("all components have been shut down")
<-e.unit.Done()
})
return e.lm.Stopped()
}
// SubmitLocal submits an event originating on the local node.
func (e *Engine) SubmitLocal(event interface{}) {
err := e.ProcessLocal(event)
if err != nil {
e.log.Fatal().Err(err).Msg("internal error processing event")
}
}
// Submit submits the given event from the node with the given origin ID
// for processing in a non-blocking manner. It returns instantly and logs
// a potential processing error internally when done.
func (e *Engine) Submit(channel network.Channel, originID flow.Identifier, event interface{}) {
err := e.Process(channel, originID, event)
if err != nil {
e.log.Fatal().Err(err).Msg("internal error processing event")
}
}
// ProcessLocal processes an event originating on the local node.
func (e *Engine) ProcessLocal(event interface{}) error {
return e.messageHandler.Process(e.me.NodeID(), event)
}
// Process processes the given event from the node with the given origin ID in
// a blocking manner. It returns the potential processing error when done.
func (e *Engine) Process(channel network.Channel, originID flow.Identifier, event interface{}) error {
err := e.messageHandler.Process(originID, event)
if err != nil {
if engine.IsIncompatibleInputTypeError(err) {
e.log.Warn().Msgf("%v delivered unsupported message %T through %v", originID, event, channel)
return nil
}
return fmt.Errorf("unexpected error while processing engine message: %w", err)
}
return nil
}
func (e *Engine) loop() {
for {
select {
case <-e.unit.Quit():
return
case <-e.messageHandler.GetNotifier():
err := e.processAvailableMessages()
if err != nil {
e.log.Fatal().Err(err).Msg("internal error processing queued message")
}
}
}
}
func (e *Engine) processAvailableMessages() error {
for {
// TODO prioritization
// eg: msg := engine.SelectNextMessage()
msg, ok := e.pendingBlocks.Get()
if ok {
err := e.core.OnBlockProposal(msg.OriginID, msg.Payload.(*messages.BlockProposal))
if err != nil {
return fmt.Errorf("could not handle block proposal: %w", err)
}
continue
}
msg, ok = e.pendingVotes.Get()
if ok {
err := e.core.OnBlockVote(msg.OriginID, msg.Payload.(*messages.BlockVote))
if err != nil {
return fmt.Errorf("could not handle block vote: %w", err)
}
continue
}
// when there is no more messages in the queue, back to the loop to wait
// for the next incoming message to arrive.
return nil
}
}
// SendVote will send a vote to the desired node.
func (e *Engine) SendVote(blockID flow.Identifier, view uint64, sigData []byte, recipientID flow.Identifier) error {
log := e.log.With().
Hex("block_id", blockID[:]).
Uint64("block_view", view).
Hex("recipient_id", recipientID[:]).
Logger()
log.Info().Msg("processing vote transmission request from hotstuff")
// build the vote message
vote := &messages.BlockVote{
BlockID: blockID,
View: view,
SigData: sigData,
}
// TODO: this is a hot-fix to mitigate the effects of the following Unicast call blocking occasionally
e.unit.Launch(func() {
// send the vote the desired recipient
err := e.con.Unicast(vote, recipientID)
if err != nil {
log.Warn().Err(err).Msg("could not send vote")
return
}
e.metrics.MessageSent(metrics.EngineCompliance, metrics.MessageBlockVote)
log.Info().Msg("block vote transmitted")
})
return nil
}
// BroadcastProposalWithDelay will propagate a block proposal to all non-local consensus nodes.
// Note the header has incomplete fields, because it was converted from a hotstuff.
func (e *Engine) BroadcastProposalWithDelay(header *flow.Header, delay time.Duration) error {
// first, check that we are the proposer of the block
if header.ProposerID != e.me.NodeID() {
return fmt.Errorf("cannot broadcast proposal with non-local proposer (%x)", header.ProposerID)
}
// get the parent of the block
parent, err := e.headers.ByBlockID(header.ParentID)
if err != nil {
return fmt.Errorf("could not retrieve proposal parent: %w", err)
}
// fill in the fields that can't be populated by HotStuff
header.ChainID = parent.ChainID
header.Height = parent.Height + 1
// retrieve the payload for the block
payload, err := e.payloads.ByBlockID(header.ID())
if err != nil {
return fmt.Errorf("could not retrieve payload for proposal: %w", err)
}
log := e.log.With().
Str("chain_id", header.ChainID.String()).
Uint64("block_height", header.Height).
Uint64("block_view", header.View).
Hex("block_id", logging.Entity(header)).
Hex("parent_id", header.ParentID[:]).
Hex("payload_hash", header.PayloadHash[:]).
Int("gaurantees_count", len(payload.Guarantees)).
Int("seals_count", len(payload.Seals)).
Int("receipts_count", len(payload.Receipts)).
Time("timestamp", header.Timestamp).
Hex("proposer", header.ProposerID[:]).
Int("num_signers", len(header.ParentVoterIDs)).
Dur("delay", delay).
Logger()
log.Debug().Msg("processing proposal broadcast request from hotstuff")
// retrieve all consensus nodes without our ID
recipients, err := e.state.AtBlockID(header.ParentID).Identities(filter.And(
filter.HasRole(flow.RoleConsensus),
filter.Not(filter.HasNodeID(e.me.NodeID())),
))
if err != nil {
return fmt.Errorf("could not get consensus recipients: %w", err)
}
e.unit.LaunchAfter(delay, func() {
go e.core.hotstuff.SubmitProposal(header, parent.View)
// NOTE: some fields are not needed for the message
// - proposer ID is conveyed over the network message
// - the payload hash is deduced from the payload
proposal := &messages.BlockProposal{
Header: header,
Payload: payload,
}
// broadcast the proposal to consensus nodes
err = e.con.Publish(proposal, recipients.NodeIDs()...)
if errors.Is(err, network.EmptyTargetList) {
return
}
if err != nil {
log.Error().Err(err).Msg("could not send proposal message")
}
e.metrics.MessageSent(metrics.EngineCompliance, metrics.MessageBlockProposal)
log.Info().Msg("block proposal broadcasted")
// submit the proposal to the provider engine to forward it to other
// node roles
e.prov.SubmitLocal(proposal)
})
return nil
}
// BroadcastProposal will propagate a block proposal to all non-local consensus nodes.
// Note the header has incomplete fields, because it was converted from a hotstuff.
func (e *Engine) BroadcastProposal(header *flow.Header) error {
return e.BroadcastProposalWithDelay(header, 0)
}