-
Notifications
You must be signed in to change notification settings - Fork 175
/
message_hub.go
482 lines (435 loc) · 18 KB
/
message_hub.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
package message_hub
import (
"context"
"errors"
"fmt"
"time"
"github.com/rs/zerolog"
"github.com/onflow/flow-go/consensus/hotstuff"
"github.com/onflow/flow-go/consensus/hotstuff/model"
"github.com/onflow/flow-go/consensus/hotstuff/notifications"
"github.com/onflow/flow-go/engine"
"github.com/onflow/flow-go/engine/collection"
"github.com/onflow/flow-go/engine/common/fifoqueue"
"github.com/onflow/flow-go/model/cluster"
"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/component"
"github.com/onflow/flow-go/module/irrecoverable"
"github.com/onflow/flow-go/module/metrics"
"github.com/onflow/flow-go/network"
"github.com/onflow/flow-go/network/channels"
clusterkv "github.com/onflow/flow-go/state/cluster"
"github.com/onflow/flow-go/state/protocol"
"github.com/onflow/flow-go/storage"
"github.com/onflow/flow-go/utils/logging"
)
// defaultMessageHubRequestsWorkers number of workers to dispatch events for requests
const defaultMessageHubRequestsWorkers = 5
// defaultProposalQueueCapacity number of pending outgoing proposals stored in queue
const defaultProposalQueueCapacity = 3
// defaultVoteQueueCapacity number of pending outgoing votes stored in queue
const defaultVoteQueueCapacity = 20
// defaultTimeoutQueueCapacity number of pending outgoing timeouts stored in queue
const defaultTimeoutQueueCapacity = 3
// packedVote is a helper structure to pack recipientID and vote into one structure to pass through fifoqueue.FifoQueue
type packedVote struct {
recipientID flow.Identifier
vote *messages.ClusterBlockVote
}
// MessageHub is a central module for handling incoming and outgoing messages via cluster consensus channel.
// It performs message routing for incoming messages by matching them by type and sending to respective engine.
// For incoming messages handling processing looks like this:
//
// +-------------------+ +------------+
// -->| Cluster-Channel |----->| MessageHub |
// +-------------------+ +------+-----+
// ------------|------------
// +------+---------+ | +------+-----+ | +------+------------+
// | VoteAggregator |----+ | Compliance | +----| TimeoutAggregator |
// +----------------+ +------------+ +------+------------+
// vote block timeout object
//
// MessageHub acts as communicator and handles hotstuff.Consumer communication events to send votes, broadcast timeouts
// and proposals. It is responsible for communication between cluster consensus participants.
// It implements hotstuff.Consumer interface and needs to be subscribed for notifications via pub/sub.
// All communicator events are handled on worker thread to prevent sender from blocking.
// For outgoing messages processing logic looks like this:
//
// +-------------------+ +------------+ +----------+ +------------------------+
// | Cluster-Channel |<-----| MessageHub |<-----| Consumer |<-----| Hotstuff |
// +-------------------+ +------+-----+ +----------+ +------------------------+
// pub/sub vote, timeout, proposal
//
// MessageHub is safe to use in concurrent environment.
type MessageHub struct {
*component.ComponentManager
notifications.NoopConsumer
log zerolog.Logger
me module.Local
engineMetrics module.EngineMetrics
state protocol.State
payloads storage.ClusterPayloads
con network.Conduit
ownOutboundMessageNotifier engine.Notifier
ownOutboundVotes *fifoqueue.FifoQueue // queue for handling outgoing vote transmissions
ownOutboundProposals *fifoqueue.FifoQueue // queue for handling outgoing proposal transmissions
ownOutboundTimeouts *fifoqueue.FifoQueue // queue for handling outgoing timeout transmissions
clusterIdentityFilter flow.IdentityFilter
// injected dependencies
compliance collection.Compliance // handler of incoming block proposals
hotstuff module.HotStuff // used to submit proposals that were previously broadcast
voteAggregator hotstuff.VoteAggregator // handler of incoming votes
timeoutAggregator hotstuff.TimeoutAggregator // handler of incoming timeouts
}
var _ network.MessageProcessor = (*MessageHub)(nil)
var _ hotstuff.CommunicatorConsumer = (*MessageHub)(nil)
// NewMessageHub constructs new instance of message hub
// No errors are expected during normal operations.
func NewMessageHub(log zerolog.Logger,
engineMetrics module.EngineMetrics,
net network.EngineRegistry,
me module.Local,
compliance collection.Compliance,
hotstuff module.HotStuff,
voteAggregator hotstuff.VoteAggregator,
timeoutAggregator hotstuff.TimeoutAggregator,
state protocol.State,
clusterState clusterkv.State,
payloads storage.ClusterPayloads,
) (*MessageHub, error) {
// find my cluster for the current epoch
// TODO this should flow from cluster state as source of truth
clusters, err := state.Final().Epochs().Current().Clustering()
if err != nil {
return nil, fmt.Errorf("could not get clusters: %w", err)
}
currentCluster, _, found := clusters.ByNodeID(me.NodeID())
if !found {
return nil, fmt.Errorf("could not find cluster for self")
}
ownOutboundVotes, err := fifoqueue.NewFifoQueue(defaultVoteQueueCapacity)
if err != nil {
return nil, fmt.Errorf("could not initialize votes queue")
}
ownOutboundProposals, err := fifoqueue.NewFifoQueue(defaultProposalQueueCapacity)
if err != nil {
return nil, fmt.Errorf("could not initialize blocks queue")
}
ownOutboundTimeouts, err := fifoqueue.NewFifoQueue(defaultTimeoutQueueCapacity)
if err != nil {
return nil, fmt.Errorf("could not initialize timeouts queue")
}
hub := &MessageHub{
log: log.With().Str("engine", "cluster_message_hub").Logger(),
me: me,
engineMetrics: engineMetrics,
state: state,
payloads: payloads,
compliance: compliance,
hotstuff: hotstuff,
voteAggregator: voteAggregator,
timeoutAggregator: timeoutAggregator,
ownOutboundMessageNotifier: engine.NewNotifier(),
ownOutboundVotes: ownOutboundVotes,
ownOutboundProposals: ownOutboundProposals,
ownOutboundTimeouts: ownOutboundTimeouts,
clusterIdentityFilter: filter.And(
filter.In(currentCluster),
filter.Not(filter.HasNodeID(me.NodeID())),
),
}
// register network conduit
chainID, err := clusterState.Params().ChainID()
if err != nil {
return nil, fmt.Errorf("could not get chain ID: %w", err)
}
conduit, err := net.Register(channels.ConsensusCluster(chainID), hub)
if err != nil {
return nil, fmt.Errorf("could not register engine: %w", err)
}
hub.con = conduit
componentBuilder := component.NewComponentManagerBuilder()
// This implementation tolerates if the networking layer sometimes blocks on send requests.
// We use by default 5 go-routines here. This is fine, because outbound messages are temporally sparse
// under normal operations. Hence, the go-routines should mostly be asleep waiting for work.
for i := 0; i < defaultMessageHubRequestsWorkers; i++ {
componentBuilder.AddWorker(func(ctx irrecoverable.SignalerContext, ready component.ReadyFunc) {
ready()
hub.queuedMessagesProcessingLoop(ctx)
})
}
hub.ComponentManager = componentBuilder.Build()
return hub, nil
}
// queuedMessagesProcessingLoop orchestrates dispatching of previously queued messages
func (h *MessageHub) queuedMessagesProcessingLoop(ctx irrecoverable.SignalerContext) {
notifier := h.ownOutboundMessageNotifier.Channel()
for {
select {
case <-ctx.Done():
return
case <-notifier:
err := h.sendOwnMessages(ctx)
if err != nil {
ctx.Throw(fmt.Errorf("internal error processing queued messages: %w", err))
return
}
}
}
}
// sendOwnMessages is a function which dispatches previously queued messages on worker thread
// This function is called whenever we have queued messages ready to be dispatched.
// No errors are expected during normal operations.
func (h *MessageHub) sendOwnMessages(ctx context.Context) error {
for {
select {
case <-ctx.Done():
return nil
default:
}
msg, ok := h.ownOutboundProposals.Pop()
if ok {
block := msg.(*flow.Header)
err := h.sendOwnProposal(block)
if err != nil {
return fmt.Errorf("could not process queued block %v: %w", block.ID(), err)
}
continue
}
msg, ok = h.ownOutboundVotes.Pop()
if ok {
packed := msg.(*packedVote)
err := h.sendOwnVote(packed)
if err != nil {
return fmt.Errorf("could not process queued vote: %w", err)
}
continue
}
msg, ok = h.ownOutboundTimeouts.Pop()
if ok {
err := h.sendOwnTimeout(msg.(*model.TimeoutObject))
if err != nil {
return fmt.Errorf("coult not process queued timeout: %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
}
}
// sendOwnTimeout propagates the timeout to the consensus committee (excluding myself)
// No errors are expected during normal operations.
func (h *MessageHub) sendOwnTimeout(timeout *model.TimeoutObject) error {
log := timeout.LogContext(h.log).Logger()
log.Info().Msg("processing timeout broadcast request from hotstuff")
// Retrieve all collection nodes in our cluster (excluding myself).
recipients, err := h.state.Final().Identities(h.clusterIdentityFilter)
if err != nil {
return fmt.Errorf("could not get cluster members for broadcasting timeout: %w", err)
}
// create the timeout message
msg := &messages.ClusterTimeoutObject{
View: timeout.View,
NewestQC: timeout.NewestQC,
LastViewTC: timeout.LastViewTC,
SigData: timeout.SigData,
TimeoutTick: timeout.TimeoutTick,
}
err = h.con.Publish(msg, recipients.NodeIDs()...)
if err != nil {
if !errors.Is(err, network.EmptyTargetList) {
log.Err(err).Msg("could not broadcast timeout")
}
return nil
}
log.Info().Msg("cluster timeout was broadcast")
h.engineMetrics.MessageSent(metrics.EngineCollectionMessageHub, metrics.MessageTimeoutObject)
return nil
}
// sendOwnVote propagates the vote via unicast to another node that is the next leader
// No errors are expected during normal operations.
func (h *MessageHub) sendOwnVote(packed *packedVote) error {
log := h.log.With().
Hex("collection_id", packed.vote.BlockID[:]).
Uint64("collection_view", packed.vote.View).
Hex("recipient_id", packed.recipientID[:]).
Logger()
log.Info().Msg("processing vote transmission request from hotstuff")
// send the vote the desired recipient
err := h.con.Unicast(packed.vote, packed.recipientID)
if err != nil {
log.Err(err).Msg("could not send vote")
return nil
}
log.Info().Msg("collection vote transmitted")
h.engineMetrics.MessageSent(metrics.EngineCollectionMessageHub, metrics.MessageBlockVote)
return nil
}
// sendOwnProposal propagates the block proposal to the consensus committee by broadcasting to all other cluster participants (excluding myself)
// No errors are expected during normal operations.
func (h *MessageHub) sendOwnProposal(header *flow.Header) error {
// first, check that we are the proposer of the block
if header.ProposerID != h.me.NodeID() {
return fmt.Errorf("cannot broadcast proposal with non-local proposer (%x)", header.ProposerID)
}
// retrieve the payload for the block
payload, err := h.payloads.ByBlockID(header.ID())
if err != nil {
return fmt.Errorf("could not retrieve payload for proposal: %w", err)
}
log := h.log.With().
Str("chain_id", header.ChainID.String()).
Uint64("block_height", header.Height).
Uint64("block_view", header.View).
Hex("block_id", logging.ID(header.ID())).
Hex("parent_id", header.ParentID[:]).
Hex("ref_block", payload.ReferenceBlockID[:]).
Int("transaction_count", payload.Collection.Len()).
Hex("parent_signer_indices", header.ParentVoterIndices).
Logger()
log.Debug().Msg("processing cluster broadcast request from hotstuff")
// retrieve all collection nodes in our cluster
recipients, err := h.state.Final().Identities(h.clusterIdentityFilter)
if err != nil {
return fmt.Errorf("could not get cluster members for broadcasting collection proposal")
}
// create the proposal message for the collection
proposal := messages.NewClusterBlockProposal(&cluster.Block{
Header: header,
Payload: payload,
})
// broadcast the proposal to consensus nodes
err = h.con.Publish(proposal, recipients.NodeIDs()...)
if err != nil {
if !errors.Is(err, network.EmptyTargetList) {
log.Err(err).Msg("could not send proposal message")
}
return nil
}
log.Info().Msg("cluster proposal was broadcast")
h.engineMetrics.MessageSent(metrics.EngineCollectionMessageHub, metrics.MessageBlockProposal)
return nil
}
// OnOwnVote propagates the vote to relevant recipient(s):
// - [common case] vote is queued and is sent via unicast to another node that is the next leader by worker
// - [special case] this node is the next leader: vote is directly forwarded to the node's internal `VoteAggregator`
func (h *MessageHub) OnOwnVote(blockID flow.Identifier, view uint64, sigData []byte, recipientID flow.Identifier) {
vote := &messages.ClusterBlockVote{
BlockID: blockID,
View: view,
SigData: sigData,
}
// special case: I am the next leader
if recipientID == h.me.NodeID() {
h.forwardToOwnVoteAggregator(vote, h.me.NodeID()) // forward vote to my own `voteAggregator`
return
}
// common case: someone else is leader
packed := &packedVote{
recipientID: recipientID,
vote: vote,
}
if ok := h.ownOutboundVotes.Push(packed); ok {
h.ownOutboundMessageNotifier.Notify()
} else {
h.engineMetrics.OutboundMessageDropped(metrics.EngineCollectionMessageHub, metrics.MessageBlockVote)
}
}
// OnOwnTimeout forwards timeout to node's internal `timeoutAggregator` and queues timeout for
// subsequent propagation to all consensus participants (excluding this node)
func (h *MessageHub) OnOwnTimeout(timeout *model.TimeoutObject) {
h.forwardToOwnTimeoutAggregator(timeout) // forward timeout to my own `timeoutAggregator`
if ok := h.ownOutboundTimeouts.Push(timeout); ok {
h.ownOutboundMessageNotifier.Notify()
} else {
h.engineMetrics.OutboundMessageDropped(metrics.EngineCollectionMessageHub, metrics.MessageTimeoutObject)
}
}
// OnOwnProposal directly forwards proposal to HotStuff core logic(skipping compliance engine as we assume our
// own proposals to be correct) and queues proposal for subsequent propagation to all consensus participants (including this node).
// The proposal will only be placed in the queue, after the specified delay (or dropped on shutdown signal).
func (h *MessageHub) OnOwnProposal(proposal *flow.Header, targetPublicationTime time.Time) {
go func() {
select {
case <-time.After(time.Until(targetPublicationTime)):
case <-h.ShutdownSignal():
return
}
hotstuffProposal := model.ProposalFromFlow(proposal)
// notify vote aggregator that new block proposal is available, in case we are next leader
h.voteAggregator.AddBlock(hotstuffProposal) // non-blocking
// TODO(active-pacemaker): replace with pub/sub?
// submit proposal to our own processing pipeline
h.hotstuff.SubmitProposal(hotstuffProposal) // non-blocking
if ok := h.ownOutboundProposals.Push(proposal); ok {
h.ownOutboundMessageNotifier.Notify()
} else {
h.engineMetrics.OutboundMessageDropped(metrics.EngineCollectionMessageHub, metrics.MessageBlockProposal)
}
}()
}
// Process handles incoming messages from consensus channel. After matching message by type, sends it to the correct
// component for handling.
// No errors are expected during normal operations.
func (h *MessageHub) Process(channel channels.Channel, originID flow.Identifier, message interface{}) error {
switch msg := message.(type) {
case *messages.ClusterBlockProposal:
h.compliance.OnClusterBlockProposal(flow.Slashable[*messages.ClusterBlockProposal]{
OriginID: originID,
Message: msg,
})
case *messages.ClusterBlockVote:
h.forwardToOwnVoteAggregator(msg, originID)
case *messages.ClusterTimeoutObject:
t := &model.TimeoutObject{
View: msg.View,
NewestQC: msg.NewestQC,
LastViewTC: msg.LastViewTC,
SignerID: originID,
SigData: msg.SigData,
TimeoutTick: msg.TimeoutTick,
}
h.forwardToOwnTimeoutAggregator(t)
default:
h.log.Warn().
Bool(logging.KeySuspicious, true).
Hex("origin_id", logging.ID(originID)).
Str("message_type", fmt.Sprintf("%T", message)).
Str("channel", channel.String()).
Msgf("delivered unsupported message type")
}
return nil
}
// forwardToOwnVoteAggregator converts vote to generic `model.Vote`, logs vote and forwards it to own `voteAggregator`.
// Per API convention, timeoutAggregator` is non-blocking, hence, this call returns quickly.
func (h *MessageHub) forwardToOwnVoteAggregator(vote *messages.ClusterBlockVote, originID flow.Identifier) {
h.engineMetrics.MessageReceived(metrics.EngineCollectionMessageHub, metrics.MessageBlockVote)
v := &model.Vote{
View: vote.View,
BlockID: vote.BlockID,
SignerID: originID,
SigData: vote.SigData,
}
h.log.Info().
Uint64("block_view", v.View).
Hex("block_id", v.BlockID[:]).
Hex("voter", v.SignerID[:]).
Str("vote_id", v.ID().String()).
Msg("block vote received, forwarding block vote to hotstuff vote aggregator")
h.voteAggregator.AddVote(v)
}
// forwardToOwnTimeoutAggregator logs timeout and forwards it to own `timeoutAggregator`.
// Per API convention, timeoutAggregator` is non-blocking, hence, this call returns quickly.
func (h *MessageHub) forwardToOwnTimeoutAggregator(t *model.TimeoutObject) {
h.engineMetrics.MessageReceived(metrics.EngineCollectionMessageHub, metrics.MessageTimeoutObject)
h.log.Info().
Hex("origin_id", t.SignerID[:]).
Uint64("view", t.View).
Str("timeout_id", t.ID().String()).
Msg("timeout received, forwarding timeout to hotstuff timeout aggregator")
h.timeoutAggregator.AddTimeout(t)
}