forked from ava-labs/avalanchego
-
Notifications
You must be signed in to change notification settings - Fork 0
/
topological.go
699 lines (590 loc) · 20.2 KB
/
topological.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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
// Copyright (C) 2019-2022, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package avalanche
import (
"errors"
"fmt"
"strings"
"go.uber.org/zap"
"github.com/dim4egster/qmallgo/ids"
"github.com/dim4egster/qmallgo/snow"
"github.com/dim4egster/qmallgo/snow/choices"
"github.com/dim4egster/qmallgo/snow/consensus/metrics"
"github.com/dim4egster/qmallgo/snow/consensus/snowstorm"
)
const minMapSize = 16
var (
errNoLeaves = errors.New("couldn't pop a leaf from leaf set")
_ Factory = &TopologicalFactory{}
_ Consensus = &Topological{}
)
// TopologicalFactory implements Factory by returning a topological struct
type TopologicalFactory struct{}
func (TopologicalFactory) New() Consensus { return &Topological{} }
// TODO: Implement pruning of decisions.
// To perfectly preserve the protocol, this implementation will need to store
// the hashes of all accepted decisions. It is possible to add a heuristic that
// removes sufficiently old decisions. However, that will need to be analyzed to
// ensure safety. It is doable when adding in a weak synchrony assumption.
// Topological performs the avalanche algorithm by utilizing a topological sort
// of the voting results. Assumes that vertices are inserted in topological
// order.
type Topological struct {
metrics.Latency
// pollNumber is the number of times RecordPolls has been called
pollNumber uint64
// Context used for logging
ctx *snow.ConsensusContext
// Threshold for confidence increases
params Parameters
// Maps vtxID -> transactionVertex wrapping the provided vertex as a
// transaction
nodes map[ids.ID]*transactionVertex
// Tracks the conflict relations
cg snowstorm.Consensus
// preferred is the frontier of vtxIDs that are strongly preferred
preferred ids.Set
// virtuous is the frontier of vtxIDs that are strongly virtuous
virtuous ids.Set
// orphans are the txIDs that are virtuous, but not preferred
orphans ids.Set
// virtuousVoting are the txIDs that are virtuous and still awaiting
// additional votes before acceptance. transactionVertices whose vertices
// are not considered virtuous are removed from this set.
virtuousVoting ids.Set
// frontier is the set of vts that have no descendents
frontier map[ids.ID]Vertex
// preferenceCache is the cache for strongly preferred checks
// virtuousCache is the cache for strongly virtuous checks
preferenceCache, virtuousCache map[ids.ID]bool
// Used in [calculateInDegree] and [markAncestorInDegrees].
// Should only be accessed in those methods.
// We use this one instance of ids.Set instead of creating a
// new ids.Set during each call to [calculateInDegree].
leaves ids.Set
// Kahn nodes used in [calculateInDegree] and [markAncestorInDegrees].
// Should only be accessed in those methods.
// We use this one map instead of creating a new map
// during each call to [calculateInDegree].
kahnNodes map[ids.ID]kahnNode
// Used in [pushVotes]. Should only be accessed in that method.
// We use this one instance instead of creating a new ids.UniqueBag
// during each call to [pushVotes].
votes ids.UniqueBag
}
type kahnNode struct {
inDegree int
votes ids.BitSet64
}
func (ta *Topological) Initialize(
ctx *snow.ConsensusContext,
params Parameters,
frontier []Vertex,
) error {
if err := params.Valid(); err != nil {
return err
}
ta.ctx = ctx
ta.params = params
ta.leaves = ids.Set{}
ta.votes = ids.UniqueBag{}
ta.kahnNodes = make(map[ids.ID]kahnNode)
latencyMetrics, err := metrics.NewLatency("vtx", "vertex/vertices", ctx.Log, "", ctx.Registerer)
if err != nil {
return err
}
ta.Latency = latencyMetrics
ta.nodes = make(map[ids.ID]*transactionVertex, minMapSize)
ta.cg = &snowstorm.Directed{}
if err := ta.cg.Initialize(ctx, params.Parameters); err != nil {
return err
}
ta.frontier = make(map[ids.ID]Vertex, minMapSize)
for _, vtx := range frontier {
ta.frontier[vtx.ID()] = vtx
}
return ta.updateFrontiers()
}
func (ta *Topological) NumProcessing() int { return len(ta.nodes) }
func (ta *Topological) Parameters() Parameters { return ta.params }
func (ta *Topological) IsVirtuous(tx snowstorm.Tx) bool { return ta.cg.IsVirtuous(tx) }
func (ta *Topological) Add(vtx Vertex) error {
ta.ctx.Log.AssertTrue(vtx != nil, "Attempting to insert nil vertex")
if vtx.Status().Decided() {
return nil // Already decided this vertex
}
vtxID := vtx.ID()
if _, exists := ta.nodes[vtxID]; exists {
return nil // Already inserted this vertex
}
txs, err := vtx.Txs()
if err != nil {
return err
}
for _, tx := range txs {
if !tx.Status().Decided() {
// Add the consumers to the conflict graph.
if err := ta.cg.Add(tx); err != nil {
return err
}
// If the added transaction is virtuous, add it to the set of
// virtuous transactions that are still being voted on.
if vs := ta.cg.VirtuousVoting(); vs.Contains(tx.ID()) {
ta.virtuousVoting.Add(tx.ID())
}
}
}
txv := newTransactionVertex(vtx, ta.nodes)
// Add the transaction vertex to the set of processing nodes.
ta.nodes[vtxID] = txv
// Also add the transaction vertex to the conflict graph to track conflicts.
if err := ta.cg.Add(txv); err != nil {
return err
}
// If the added transaction vertex is virtuous, add it to the set of
// virtuous transactions that are still being voted on. If the vertex isn't
// virtuous, then the ID will be removed on the subsequent call to update.
if vs := ta.cg.VirtuousVoting(); vs.Contains(vtxID) {
ta.virtuousVoting.Add(vtxID)
}
ta.Latency.Issued(vtxID, ta.pollNumber)
// Because we don't call [updateFrontiers], previous vertices that were
// marked as virtuous will not be updated to no longer being virtuous. Even
// if this newly added vertex conflicts with them. This is an optimization
// to avoid a retraversal of the DAG in the issuance path. Their virtuous
// status will be updated during a future poll. This is safe because the
// virtuous frontier is only used optimistically to control when it is valid
// to quiesce.
return ta.update(vtx) // Update the vertices preference and virtuous status
}
func (ta *Topological) VertexIssued(vtx Vertex) bool {
if vtx.Status().Decided() {
return true
}
_, ok := ta.nodes[vtx.ID()]
return ok
}
func (ta *Topological) TxIssued(tx snowstorm.Tx) bool { return ta.cg.Issued(tx) }
func (ta *Topological) Orphans() ids.Set { return ta.orphans }
func (ta *Topological) Virtuous() ids.Set { return ta.virtuous }
func (ta *Topological) Preferences() ids.Set { return ta.preferred }
func (ta *Topological) RecordPoll(responses ids.UniqueBag) error {
// Register a new poll call
ta.pollNumber++
// If it isn't possible to have alpha votes for any transaction, then we can
// just reset the confidence values in the conflict graph and not perform
// any traversals.
partialVotes := ids.BitSet64(0)
for vote := range responses {
votes := responses.GetSet(vote)
partialVotes.Union(votes)
if partialVotes.Len() >= ta.params.Alpha {
break
}
}
if partialVotes.Len() < ta.params.Alpha {
// Because there were less than alpha total returned votes, we can skip
// the traversals and fail the poll.
_, err := ta.cg.RecordPoll(ids.Bag{})
return err
}
// Set up the topological sort: O(|Live Set|)
if err := ta.calculateInDegree(responses); err != nil {
return err
}
// Collect the votes for each transaction: O(|Live Set|)
votes, err := ta.pushVotes()
if err != nil {
return err
}
// Update the conflict graph: O(|Transactions|)
if updated, err := ta.cg.RecordPoll(votes); !updated || err != nil {
// If the transaction statuses weren't changed, there is no need to
// perform a traversal.
return err
}
// Update the dag: O(|Live Set|)
return ta.updateFrontiers()
}
func (ta *Topological) Quiesce() bool { return ta.virtuousVoting.Len() == 0 }
func (ta *Topological) Finalized() bool { return ta.cg.Finalized() }
// HealthCheck returns information about the consensus health.
func (ta *Topological) HealthCheck() (interface{}, error) {
numOutstandingVtx := ta.Latency.NumProcessing()
isOutstandingVtx := numOutstandingVtx <= ta.params.MaxOutstandingItems
healthy := isOutstandingVtx
details := map[string]interface{}{
"outstandingVertices": numOutstandingVtx,
}
snowstormReport, err := ta.cg.HealthCheck()
healthy = healthy && err == nil
details["snowstorm"] = snowstormReport
if !healthy {
var errorReasons []string
if isOutstandingVtx {
errorReasons = append(errorReasons, fmt.Sprintf("number outstanding vertexes %d > %d", numOutstandingVtx, ta.params.MaxOutstandingItems))
}
if err != nil {
errorReasons = append(errorReasons, err.Error())
}
return details, fmt.Errorf("avalanche consensus is not healthy reason: %s", strings.Join(errorReasons, ", "))
}
return details, nil
}
// Takes in a list of votes and sets up the topological ordering. Returns the
// reachable section of the graph annotated with the number of inbound edges and
// the non-transitively applied votes. Also returns the list of leaf nodes.
func (ta *Topological) calculateInDegree(responses ids.UniqueBag) error {
// Clear the kahn node set
for k := range ta.kahnNodes {
delete(ta.kahnNodes, k)
}
// Clear the leaf set
ta.leaves.Clear()
for vote := range responses {
// If it is not found, then the vote is either for something decided,
// or something we haven't heard of yet.
if tv := ta.nodes[vote]; tv != nil {
vtx := tv.vtx
kahn, previouslySeen := ta.kahnNodes[vote]
// Add this new vote to the current bag of votes
kahn.votes.Union(responses.GetSet(vote))
ta.kahnNodes[vote] = kahn
if !previouslySeen {
// If I've never seen this node before, it is currently a leaf.
ta.leaves.Add(vote)
parents, err := vtx.Parents()
if err != nil {
return err
}
ta.kahnNodes, err = ta.markAncestorInDegrees(ta.kahnNodes, parents)
if err != nil {
return err
}
}
}
}
return nil
}
// adds a new in-degree reference for all nodes.
// should only be called from [calculateInDegree]
func (ta *Topological) markAncestorInDegrees(
kahns map[ids.ID]kahnNode,
deps []Vertex,
) (map[ids.ID]kahnNode, error) {
frontier := make([]Vertex, 0, len(deps))
for _, vtx := range deps {
// The vertex may have been decided, no need to vote in that case
if !vtx.Status().Decided() {
frontier = append(frontier, vtx)
}
}
for len(frontier) > 0 {
newLen := len(frontier) - 1
current := frontier[newLen]
frontier = frontier[:newLen]
currentID := current.ID()
kahn, alreadySeen := kahns[currentID]
// I got here through a transitive edge, so increase the in-degree
kahn.inDegree++
kahns[currentID] = kahn
if kahn.inDegree == 1 {
// If I am transitively seeing this node for the first
// time, it is no longer a leaf.
ta.leaves.Remove(currentID)
}
if !alreadySeen {
// If I am seeing this node for the first time, I need to check its
// parents
parents, err := current.Parents()
if err != nil {
return nil, err
}
for _, depVtx := range parents {
// No need to traverse to a decided vertex
if !depVtx.Status().Decided() {
frontier = append(frontier, depVtx)
}
}
}
}
return kahns, nil
}
// Count the number of votes for each operation by pushing votes upwards through
// vertex ancestors.
func (ta *Topological) pushVotes() (ids.Bag, error) {
ta.votes.Clear()
txConflicts := make(map[ids.ID]ids.Set, minMapSize)
// A leaf is a node with no inbound edges. This removes each leaf and pushes
// the votes upwards, potentially creating new leaves, until there are no
// more leaves.
for ta.leaves.Len() > 0 {
// Pop one node from [leaves]
leaf, ok := ta.leaves.Pop()
if !ok {
// Should never happen because we just checked that [ta.leaves] is
// not empty.
return ids.Bag{}, errNoLeaves
}
kahn := ta.kahnNodes[leaf]
if tv := ta.nodes[leaf]; tv != nil {
vtx := tv.vtx
txs, err := vtx.Txs()
if err != nil {
return ids.Bag{}, err
}
for _, tx := range txs {
// Give the votes to the consumer
txID := tx.ID()
ta.votes.UnionSet(txID, kahn.votes)
// Map txID to set of Conflicts
if _, exists := txConflicts[txID]; !exists {
txConflicts[txID] = ta.cg.Conflicts(tx)
}
}
// The leaf is the ID of the transaction vertex that was issued to
// the conflict graph for this vertex. Adding this vote is required
// to make progress toward accepting this transaction.
ta.votes.UnionSet(leaf, kahn.votes)
// Map the vertexID to the set of conflicts from the transaction
// vertex.
if _, exists := txConflicts[leaf]; !exists {
txConflicts[leaf] = ta.cg.Conflicts(tv)
}
parents, err := vtx.Parents()
if err != nil {
return ids.Bag{}, err
}
for _, dep := range parents {
depID := dep.ID()
if depNode, notPruned := ta.kahnNodes[depID]; notPruned {
depNode.inDegree--
// Give the votes to my parents
depNode.votes.Union(kahn.votes)
ta.kahnNodes[depID] = depNode
if depNode.inDegree == 0 {
// Only traverse into the leaves
ta.leaves.Add(depID)
}
}
}
}
}
// Create bag of votes for conflicting transactions
conflictingVotes := make(ids.UniqueBag)
for txID, conflicts := range txConflicts {
for conflictTxID := range conflicts {
conflictingVotes.UnionSet(txID, ta.votes.GetSet(conflictTxID))
}
}
ta.votes.Difference(&conflictingVotes)
return ta.votes.Bag(ta.params.Alpha), nil
}
// If I've already checked, do nothing
// If I'm decided, cache the preference and return
// At this point, I must be live
// I now try to accept all my consumers
// I now update all my ancestors
// If any of my parents are rejected, reject myself
// If I'm preferred, remove all my ancestors from the preferred frontier, add
// myself to the preferred frontier
// If all my parents are accepted and I'm acceptable, accept myself
func (ta *Topological) update(vtx Vertex) error {
vtxID := vtx.ID()
if _, cached := ta.preferenceCache[vtxID]; cached {
return nil // This vertex has already been updated
}
// Drop all transaction vertices from the orphan set, as they can never be
// reissued.
ta.orphans.Remove(vtxID)
switch vtx.Status() {
case choices.Accepted:
ta.preferred.Add(vtxID) // I'm preferred
ta.virtuous.Add(vtxID) // Accepted is defined as virtuous
ta.frontier[vtxID] = vtx // I have no descendents yet
ta.preferenceCache[vtxID] = true
ta.virtuousCache[vtxID] = true
return nil
case choices.Rejected:
// I'm rejected
ta.preferenceCache[vtxID] = false
ta.virtuousCache[vtxID] = false
return nil
}
txs, err := vtx.Txs()
if err != nil {
return err
}
preferences := ta.cg.Preferences()
virtuousTxs := ta.cg.Virtuous()
txv, ok := ta.nodes[vtxID]
if !ok {
return fmt.Errorf("transaction vertex %s not found in processing nodes set", vtxID)
}
initialTxVStatus := txv.Status()
// acceptable tracks if all transactions included in the vertex have been
// accepted and if all the parent vertices have been accepted. The
// transactions include the transaction vertex.
acceptable := initialTxVStatus == choices.Accepted
// rejectable tracks if any of the transactions included in the vertex have
// been rejected or if any of the parent vertices have been rejected. The
// transactions include the transaction vertex.
rejectable := initialTxVStatus == choices.Rejected
preferred := acceptable || preferences.Contains(vtxID)
virtuous := acceptable || virtuousTxs.Contains(vtxID)
for _, tx := range txs {
txID := tx.ID()
s := tx.Status()
if s == choices.Rejected {
// If I contain a rejected consumer, I am rejectable
rejectable = true
preferred = false
virtuous = false
}
if s != choices.Accepted {
// If I contain a non-accepted consumer, I am not acceptable
acceptable = false
preferred = preferred && preferences.Contains(txID)
virtuous = virtuous && virtuousTxs.Contains(txID)
}
}
deps, err := vtx.Parents()
if err != nil {
return err
}
// Update all of my dependencies
for _, dep := range deps {
if err := ta.update(dep); err != nil {
return err
}
depID := dep.ID()
preferred = preferred && ta.preferenceCache[depID]
virtuous = virtuous && ta.virtuousCache[depID]
}
// Check my parent statuses
for _, dep := range deps {
switch status := dep.Status(); status {
case choices.Rejected:
// My parent is rejected, so I should be rejected
ta.ctx.Log.Trace("rejecting vertex",
zap.String("reason", "rejected parent"),
zap.Stringer("vtxID", vtxID),
zap.Stringer("parentID", dep.ID()),
)
if !txv.Status().Decided() {
if err := ta.cg.Remove(vtxID); err != nil {
return fmt.Errorf("failed to remove transaction vertex %s from snowstorm before rejecting vertex itself", vtxID)
}
ta.virtuousVoting.Remove(vtxID)
}
if err := vtx.Reject(); err != nil {
return err
}
delete(ta.nodes, vtxID)
ta.Latency.Rejected(vtxID, ta.pollNumber)
ta.preferenceCache[vtxID] = false
ta.virtuousCache[vtxID] = false
return nil
case choices.Accepted:
// If the dependency is accepted, then the vertex's acceptability
// doesn't change.
default:
acceptable = false // A parent isn't accepted, so I can't be
}
}
// Technically, we could also check to see if there are direct conflicts
// between this vertex and a vertex in it's ancestry. If there does exist
// such a conflict, this vertex could also be rejected. However, this would
// require a traversal. Therefore, this memory optimization is ignored.
// Also, this will only happen from a byzantine node issuing the vertex.
// Therefore, this is very unlikely to actually be triggered in practice.
// Remove all my parents from the frontier
for _, dep := range deps {
delete(ta.frontier, dep.ID())
}
ta.frontier[vtxID] = vtx // I have no descendents yet
ta.preferenceCache[vtxID] = preferred
ta.virtuousCache[vtxID] = virtuous
if preferred {
ta.preferred.Add(vtxID) // I'm preferred
for _, dep := range deps {
ta.preferred.Remove(dep.ID()) // My parents aren't part of the frontier
}
// Transactions are marked as orphans if they are virtuous, but not
// contained in a preferred vertex. Since this vertex is preferred,
// remove all the internal transactions from the orphan set.
//
// As an optimization, we only iterate over the transactions if the set
// of orphans isn't empty. As if the set is empty, nothing will be able
// to be removed anyway.
if ta.orphans.Len() > 0 {
for _, tx := range txs {
if tx.Status() != choices.Accepted {
ta.orphans.Remove(tx.ID())
}
}
}
}
if virtuous {
ta.virtuous.Add(vtxID) // I'm virtuous
for _, dep := range deps {
ta.virtuous.Remove(dep.ID()) // My parents aren't part of the frontier
}
} else {
// If the vertex isn't virtuous, then we can remove the transaction
// vertex from the voting set to pessemistically quiesce early.
ta.virtuousVoting.Remove(vtxID)
}
switch {
case acceptable:
// I'm acceptable, why not accept?
// Note that ConsensusAcceptor.Accept must be called before vtx.Accept
// to honor Acceptor.Accept's invariant.
if err := ta.ctx.ConsensusAcceptor.Accept(ta.ctx, vtxID, vtx.Bytes()); err != nil {
return err
}
if err := vtx.Accept(); err != nil {
return err
}
delete(ta.nodes, vtxID)
ta.Latency.Accepted(vtxID, ta.pollNumber)
case rejectable:
// I'm rejectable, why not reject?
ta.ctx.Log.Trace("rejecting vertex",
zap.String("reason", "conflicting acceptance"),
zap.Stringer("vtxID", vtxID),
)
if !txv.Status().Decided() {
if err := ta.cg.Remove(vtxID); err != nil {
return fmt.Errorf("failed to remove transaction vertex %s from snowstorm before rejecting vertex itself", vtxID)
}
ta.virtuousVoting.Remove(vtxID)
}
if err := vtx.Reject(); err != nil {
return err
}
delete(ta.nodes, vtxID)
ta.Latency.Rejected(vtxID, ta.pollNumber)
}
return nil
}
// Update the frontier sets
func (ta *Topological) updateFrontiers() error {
vts := ta.frontier
ta.preferred.Clear()
ta.virtuous.Clear()
ta.virtuousVoting.Clear()
ta.orphans.Clear()
ta.frontier = make(map[ids.ID]Vertex, minMapSize)
ta.preferenceCache = make(map[ids.ID]bool, minMapSize)
ta.virtuousCache = make(map[ids.ID]bool, minMapSize)
ta.virtuousVoting.Union(ta.cg.VirtuousVoting())
ta.orphans.Union(ta.cg.Virtuous()) // Initially, nothing is preferred
for _, vtx := range vts {
// Update all the vertices that were in my previous frontier
if err := ta.update(vtx); err != nil {
return err
}
}
return nil
}