-
Notifications
You must be signed in to change notification settings - Fork 210
/
ninja_tortoise.go
625 lines (537 loc) · 18.5 KB
/
ninja_tortoise.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
package tortoise
import (
"fmt"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/events"
"github.com/spacemeshos/go-spacemesh/log"
"github.com/spacemeshos/go-spacemesh/mesh"
"hash/fnv"
"math"
"sync"
"time"
)
type vec [2]int
type PatternId uint32 //this hash dose not include the layer id
const ( //Threshold
Window = 10
LocalThreshold = 0.8 //ThetaL
GlobalThreshold = 0.6 //ThetaG
Genesis = 0
)
var ( //correction vectors type
//Opinion
Support = vec{1, 0}
Against = vec{0, 1}
Abstain = vec{0, 0}
ZeroPattern = votingPattern{}
)
func Max(i types.LayerID, j types.LayerID) types.LayerID {
if i > j {
return i
}
return j
}
func (a vec) Add(v vec) vec {
return vec{a[0] + v[0], a[1] + v[1]}
}
func (a vec) Negate() vec {
a[0] = a[0] * -1
a[1] = a[1] * -1
return a
}
func (a vec) Multiply(x int) vec {
a[0] = a[0] * x
a[1] = a[1] * x
return a
}
type BlockIDLayerTuple struct {
types.BlockID
types.LayerID
}
func (blt BlockIDLayerTuple) Layer() types.LayerID {
return blt.LayerID
}
func (blt BlockIDLayerTuple) Id() types.BlockID {
return blt.BlockID
}
type votingPattern struct {
id PatternId //cant put a slice here wont work well with maps, we need to hash the blockids
types.LayerID
}
func (vp votingPattern) Layer() types.LayerID {
return vp.LayerID
}
type Mesh interface {
GetBlock(id types.BlockID) (*types.Block, error)
LayerBlockIds(id types.LayerID) ([]types.BlockID, error)
ForBlockInView(view map[types.BlockID]struct{}, layer types.LayerID, foo func(block *types.Block) (bool, error)) error
SaveContextualValidity(id types.BlockID, valid bool) error
Persist(key []byte, v interface{}) error
Retrieve(key []byte, v interface{}) (interface{}, error)
}
//todo memory optimizations
type NinjaTortoise struct {
log.Log
Mesh //block cache
*ninjaTortoise //contains all fields needed for serialization
}
type ninjaTortoise struct {
Last types.LayerID
Hdist types.LayerID
Evict types.LayerID
AvgLayerSize int
PBase votingPattern
Patterns map[types.LayerID]map[votingPattern]struct{} //map Patterns by layer for eviction purposes
TEffective map[types.BlockID]votingPattern //Explicit voting pattern of latest layer for a block
TCorrect map[types.BlockID]map[types.BlockID]vec //correction vectors
TExplicit map[types.BlockID]map[types.LayerID]votingPattern //explict votes from block to layer pattern
TSupport map[votingPattern]int //for pattern p the number of blocks that support p
TComplete map[votingPattern]struct{} //complete voting Patterns
TEffectiveToBlocks map[votingPattern][]BlockIDLayerTuple //inverse blocks effective pattern
TTally map[votingPattern]map[BlockIDLayerTuple]vec //for pattern p and block b count votes for b according to p
TPattern map[votingPattern]map[types.BlockID]struct{} //set of blocks that comprise pattern p
TPatSupport map[votingPattern]map[types.LayerID]votingPattern //pattern support count
TGood map[types.LayerID]votingPattern //good pattern for layer i
TVote map[votingPattern]map[BlockIDLayerTuple]vec //global opinion
}
func NewNinjaTortoise(layerSize int, blocks Mesh, hdist int, log log.Log) *NinjaTortoise {
trtl := &NinjaTortoise{Log: log, Mesh: blocks}
trtl.ninjaTortoise = &ninjaTortoise{
Hdist: types.LayerID(hdist),
AvgLayerSize: layerSize,
PBase: ZeroPattern,
Patterns: map[types.LayerID]map[votingPattern]struct{}{},
TGood: map[types.LayerID]votingPattern{},
TEffective: map[types.BlockID]votingPattern{},
TCorrect: map[types.BlockID]map[types.BlockID]vec{},
TExplicit: map[types.BlockID]map[types.LayerID]votingPattern{},
TSupport: map[votingPattern]int{},
TPattern: map[votingPattern]map[types.BlockID]struct{}{},
TVote: map[votingPattern]map[BlockIDLayerTuple]vec{},
TTally: map[votingPattern]map[BlockIDLayerTuple]vec{},
TComplete: map[votingPattern]struct{}{},
TEffectiveToBlocks: map[votingPattern][]BlockIDLayerTuple{},
TPatSupport: map[votingPattern]map[types.LayerID]votingPattern{},
}
return trtl
}
func (ni *NinjaTortoise) saveOpinion() error {
for b, vec := range ni.TVote[ni.PBase] {
valid := vec == Support
if err := ni.SaveContextualValidity(b.Id(), valid); err != nil {
return err
}
if !valid {
ni.With().Warning("block is contextually invalid", log.BlockId(b.Id().String()))
}
events.Publish(events.ValidBlock{Id: b.Id().String(), Valid: valid})
}
return nil
}
func (ni *NinjaTortoise) PersistTortoise() error {
if err := ni.saveOpinion(); err != nil {
return err
}
return ni.Persist(mesh.TORTOISE, ni.ninjaTortoise)
}
func (ni *NinjaTortoise) RecoverTortoise() (interface{}, error) {
return ni.Retrieve(mesh.TORTOISE, &ninjaTortoise{})
}
func (ni *NinjaTortoise) evictOutOfPbase() {
wg := sync.WaitGroup{}
if ni.PBase == ZeroPattern || ni.PBase.Layer() <= ni.Hdist {
return
}
window := ni.PBase.Layer() - ni.Hdist
for lyr := ni.Evict; lyr < window; lyr++ {
wg.Add(1)
go func() {
defer wg.Done()
for p, _ := range ni.Patterns[lyr] {
delete(ni.TSupport, p)
delete(ni.TComplete, p)
delete(ni.TEffectiveToBlocks, p)
delete(ni.TVote, p)
delete(ni.TTally, p)
delete(ni.TPattern, p)
delete(ni.TPatSupport, p)
ni.Debug("evict pattern %v from maps ", p)
}
delete(ni.TGood, lyr)
delete(ni.Patterns, lyr)
}()
wg.Add(1)
go func() {
defer wg.Done()
ids, err := ni.LayerBlockIds(lyr)
if err != nil {
ni.Error("could not get layer ids for layer %v %v", lyr, err)
}
for _, id := range ids {
delete(ni.TEffective, id)
delete(ni.TCorrect, id)
delete(ni.TExplicit, id)
ni.Debug("evict block %v from maps ", id)
}
}()
wg.Wait()
}
ni.Evict = window
}
func (ni *NinjaTortoise) processBlock(b *types.Block) {
ni.Debug("process block: %s layer: %s ", b.Id(), b.Layer())
if b.Layer() == Genesis {
return
}
patternMap := make(map[types.LayerID]map[types.BlockID]struct{})
for _, bid := range b.BlockVotes {
ni.Debug("block votes %s", bid)
bl, err := ni.GetBlock(bid)
if err != nil || bl == nil {
ni.Panic(fmt.Sprintf("error block not found ID %s , %v!!!!!", bid, err))
}
if _, found := patternMap[bl.Layer()]; !found {
patternMap[bl.Layer()] = map[types.BlockID]struct{}{}
}
patternMap[bl.Layer()][bl.Id()] = struct{}{}
}
var effective votingPattern
ni.TExplicit[b.Id()] = make(map[types.LayerID]votingPattern, ni.Hdist)
var layerId types.LayerID
if ni.Hdist > b.Layer() {
layerId = 0
} else {
layerId = b.Layer() - ni.Hdist
}
for ; layerId < b.Layer(); layerId++ {
v, found := patternMap[layerId]
if !found {
ni.TExplicit[b.Id()][layerId] = ZeroPattern
continue
}
vp := votingPattern{id: getIdsFromSet(v), LayerID: layerId}
ni.TPattern[vp] = v
if _, ok := ni.Patterns[vp.Layer()]; !ok {
ni.Patterns[vp.Layer()] = map[votingPattern]struct{}{}
}
ni.Patterns[vp.Layer()][vp] = struct{}{}
ni.TExplicit[b.Id()][layerId] = vp
if layerId >= effective.Layer() {
effective = vp
}
}
ni.TEffective[b.Id()] = effective
v, found := ni.TEffectiveToBlocks[effective]
if !found {
v = make([]BlockIDLayerTuple, 0, ni.AvgLayerSize)
}
var pattern []BlockIDLayerTuple = nil
pattern = append(v, BlockIDLayerTuple{b.Id(), b.Layer()})
ni.TEffectiveToBlocks[effective] = pattern
ni.Debug("effective pattern to blocks %s %s", effective, pattern)
return
}
func getId(bids []types.BlockID) PatternId {
bids = types.SortBlockIds(bids)
// calc
h := fnv.New32()
for i := 0; i < len(bids); i++ {
h.Write(bids[i].ToBytes())
}
// update
sum := h.Sum32()
return PatternId(sum)
}
func getIdsFromSet(bids map[types.BlockID]struct{}) PatternId {
keys := make([]types.BlockID, 0, len(bids))
for k := range bids {
keys = append(keys, k)
}
return getId(keys)
}
func globalOpinion(v vec, layerSize int, delta float64) vec {
threshold := float64(GlobalThreshold*delta) * float64(layerSize)
if float64(v[0]) > threshold {
return Support
} else if float64(v[1]) > threshold {
return Against
} else {
return Abstain
}
}
func (ni *NinjaTortoise) updateCorrectionVectors(p votingPattern, bottomOfWindow types.LayerID) {
foo := func(x *types.Block) (bool, error) {
for _, b := range ni.TEffectiveToBlocks[p] { //for all b whose effective vote is p
if _, found := ni.TExplicit[b.Id()][x.Layer()]; found { //if Texplicit[b][x.layer]!=0 check correctness of x.layer and found
ni.Debug(" blocks pattern %s block %s layer %s", p, b.Id(), b.Layer())
if _, found := ni.TCorrect[b.Id()]; !found {
ni.TCorrect[b.Id()] = make(map[types.BlockID]vec)
}
vo := ni.TVote[p][BlockIDLayerTuple{BlockID: x.Id(), LayerID: x.Layer()}]
ni.Debug("vote from pattern %s to block %s layer %s vote %s ", p, x.Id(), x.Layer(), vo)
ni.TCorrect[b.Id()][x.Id()] = vo.Negate() //Tcorrect[b][x] = -Tvote[p][x]
ni.Debug("update correction vector for block %s layer %s , pattern %s vote %s for block %s ", b.Id(), b.Layer(), p, ni.TCorrect[b.Id()][x.Id()], x.Id())
} else {
ni.Debug("block %s from layer %s dose'nt explicitly vote for layer %s", b.Id(), b.Layer(), x.Layer())
}
}
return false, nil
}
tp := ni.TPattern[p]
ni.ForBlockInView(tp, bottomOfWindow, foo)
}
func (ni *NinjaTortoise) updatePatternTally(newMinGood votingPattern, correctionMap map[types.BlockID]vec, effCountMap map[types.LayerID]int) {
ni.Debug("update tally pbase id:%s layer:%s p id:%s layer:%s", ni.PBase.id, ni.PBase.Layer(), newMinGood.id, newMinGood.Layer())
for idx, effc := range effCountMap {
g := ni.TGood[idx]
for b, v := range ni.TVote[g] {
tally := ni.TTally[newMinGood][b]
tally = tally.Add(v.Multiply(effc))
ni.TTally[newMinGood][b] = tally //in g's view -> in p's view
}
}
for b, tally := range ni.TTally[newMinGood] {
if count, found := correctionMap[b.Id()]; found {
ni.TTally[newMinGood][b] = tally.Add(count)
}
}
}
func (ni *ninjaTortoise) getCorrEffCounter() (map[types.BlockID]vec, map[types.LayerID]int, func(b *types.Block)) {
correctionMap := make(map[types.BlockID]vec)
effCountMap := make(map[types.LayerID]int)
foo := func(b *types.Block) {
if b.Layer() > ni.PBase.Layer() {
if eff, found := ni.TEffective[b.Id()]; found {
p, found := ni.TGood[eff.Layer()]
if found && eff == p {
effCountMap[eff.Layer()] = effCountMap[eff.Layer()] + 1
for k, v := range ni.TCorrect[b.Id()] {
correctionMap[k] = correctionMap[k].Add(v)
}
}
}
}
}
return correctionMap, effCountMap, foo
}
//for all layers from pBase to i add b's votes, mark good layers
// return new minimal good layer
func (ni *NinjaTortoise) findMinimalNewlyGoodLayer(lyr *types.Layer) types.LayerID {
minGood := types.LayerID(math.MaxUint64)
var j types.LayerID
if Window > lyr.Index() {
j = ni.PBase.Layer() + 1
} else {
j = Max(ni.PBase.Layer()+1, lyr.Index()-Window+1)
}
for ; j < lyr.Index(); j++ {
// update block votes on all Patterns in blocks view
sUpdated := ni.updateBlocksSupport(lyr.Blocks(), j)
//todo do this as part of previous for if possible
//for each p that was updated and not the good layer of j check if it is the good layer
for p := range sUpdated {
//if a majority supports p (p is good)
//according to tal we dont have to know the exact amount, we can multiply layer size by number of layers
jGood, found := ni.TGood[j]
threshold := 0.5 * float64(types.LayerID(ni.AvgLayerSize)*(ni.Last-p.Layer()))
if (jGood != p || !found) && float64(ni.TSupport[p]) > threshold {
ni.TGood[p.Layer()] = p
//if p is the new minimal good layer
if p.Layer() < minGood {
minGood = p.Layer()
}
}
}
}
ni.Info("found minimal good layer %d, %d", minGood, ni.TGood[minGood].id)
return minGood
}
//update block support for pattern in layer j
func (ni *NinjaTortoise) updateBlocksSupport(b []*types.Block, j types.LayerID) map[votingPattern]struct{} {
sUpdated := map[votingPattern]struct{}{}
for _, block := range b {
//check if block votes for layer j explicitly or implicitly
p, found := ni.TExplicit[block.Id()][j]
if found {
//explicit
ni.TSupport[p]++ //add to supporting Patterns
sUpdated[p] = struct{}{} //add to updated Patterns
//implicit
} else if eff, effFound := ni.TEffective[block.Id()]; effFound {
p, found = ni.TPatSupport[eff][j]
if found {
ni.TSupport[p]++ //add to supporting Patterns
sUpdated[p] = struct{}{} //add to updated Patterns
}
}
}
return sUpdated
}
func (ni *NinjaTortoise) addPatternVote(p votingPattern, view map[types.BlockID]struct{}) func(b types.BlockID) {
addPatternVote := func(b types.BlockID) {
var vp map[types.LayerID]votingPattern
var found bool
blk, err := ni.GetBlock(b)
if err != nil {
ni.Panic(fmt.Sprintf("error block not found ID %s %v", b, err))
}
if ni.PBase != ZeroPattern && blk.Layer() <= ni.PBase.Layer() { //ignore under pbase
return
}
if vp, found = ni.TExplicit[b]; !found {
ni.Panic(fmt.Sprintf("block %s from layer %v has no explicit voting, something went wrong ", b, blk.Layer()))
}
for _, ex := range vp {
blocks, err := ni.LayerBlockIds(ex.Layer())
if err != nil {
ni.Panic("could not retrieve layer block ids")
}
//explicitly abstain
if ex == ZeroPattern {
continue
}
for _, bl := range blocks {
_, found := ni.TPattern[ex][bl]
blt := BlockIDLayerTuple{bl, ex.Layer()}
if found {
ni.TTally[p][blt] = ni.TTally[p][blt].Add(Support)
} else if _, inSet := view[bl]; inSet { //in view but not in pattern
ni.TTally[p][blt] = ni.TTally[p][blt].Add(Against)
}
}
}
}
return addPatternVote
}
func sumNodesInView(layerBlockCounter map[types.LayerID]int, layer types.LayerID, pLayer types.LayerID) vec {
var sum int
for sum = 0; layer <= pLayer; layer++ {
sum = sum + layerBlockCounter[layer]
}
return Against.Multiply(sum)
}
func (ni *NinjaTortoise) processBlocks(layer *types.Layer) {
for _, block := range layer.Blocks() {
ni.processBlock(block)
}
}
func (ni *NinjaTortoise) handleGenesis(genesis *types.Layer) {
for _, blk := range genesis.Blocks() {
ni.TExplicit[blk.Id()] = make(map[types.LayerID]votingPattern, int(ni.Hdist)*ni.AvgLayerSize)
}
}
//todo send map instead of ni
func (ni *NinjaTortoise) updatePatSupport(p votingPattern, bids []types.BlockID, idx types.LayerID) {
if val, found := ni.TPatSupport[p]; !found || val == nil {
ni.TPatSupport[p] = make(map[types.LayerID]votingPattern)
}
pid := getId(bids)
ni.Debug("update support for %s layer %s supported pattern %s", p, idx, pid)
ni.TPatSupport[p][idx] = votingPattern{id: pid, LayerID: idx}
}
//todo not sure initTallyToBase is even needed
//todo due to the fact that we treat layers under pbase as irreversible
func (ni *NinjaTortoise) initTallyToBase(base votingPattern, p votingPattern, windowStart types.LayerID) {
mp := make(map[BlockIDLayerTuple]vec, len(ni.TTally[base]))
for b, v := range ni.TTally[base] {
if b.Layer() < windowStart {
continue //dont copy votes for block outside window
}
mp[b] = v
}
ni.TTally[p] = mp
}
func (ni *NinjaTortoise) LatestComplete() types.LayerID {
return ni.PBase.Layer()
}
func (ni *NinjaTortoise) handleIncomingLayer(newlyr *types.Layer) {
ni.With().Info("Tortoise update tables", log.LayerId(uint64(newlyr.Index())), log.Int("n_blocks", len(newlyr.Blocks())))
start := time.Now()
if newlyr.Index() > ni.Last {
ni.Last = newlyr.Index()
}
defer ni.evictOutOfPbase()
ni.processBlocks(newlyr)
if newlyr.Index() == Genesis {
ni.handleGenesis(newlyr)
return
}
l := ni.findMinimalNewlyGoodLayer(newlyr)
//from minimal newly good pattern to current layer
//update pattern tally for all good layers
for j := l; j > 0 && j < newlyr.Index(); j++ {
p, gfound := ni.TGood[j]
if gfound {
//find bottom of window
windowStart := getBottomOfWindow(newlyr.Index(), ni.PBase.Layer(), ni.Hdist)
//init p's tally to pBase tally
ni.initTallyToBase(ni.PBase, p, windowStart)
view := make(map[types.BlockID]struct{})
lCntr := make(map[types.LayerID]int)
correctionMap, effCountMap, getCrrEffCnt := ni.getCorrEffCounter()
foo := func(block *types.Block) (bool, error) {
view[block.Id()] = struct{}{} //all blocks in view
lCntr[block.Layer()]++ //amount of blocks for each layer in view
getCrrEffCnt(block) //calc correction and eff count
return false, nil
}
tp := ni.TPattern[p]
ni.ForBlockInView(tp, windowStart, foo)
//add corrected implicit votes
ni.updatePatternTally(p, correctionMap, effCountMap)
//add explicit votes
addPtrnVt := ni.addPatternVote(p, view)
for bl := range view {
addPtrnVt(bl)
}
complete := true
for idx := ni.PBase.Layer(); idx < j; idx++ {
layer, _ := ni.LayerBlockIds(idx) //todo handle error
bids := make([]types.BlockID, 0, ni.AvgLayerSize)
for _, bid := range layer {
blt := BlockIDLayerTuple{BlockID: bid, LayerID: idx}
//if bid is not in p's view.
//add negative vote multiplied by the amount of blocks in the view
//explicit votes against (not in view )
if _, found := view[bid]; idx >= ni.PBase.Layer() && !found {
ni.TTally[p][blt] = sumNodesInView(lCntr, idx+1, p.Layer())
}
if val, found := ni.TVote[p]; !found || val == nil {
ni.TVote[p] = make(map[BlockIDLayerTuple]vec)
}
if vote := globalOpinion(ni.TTally[p][blt], ni.AvgLayerSize, float64(p.LayerID-idx)); vote != Abstain {
ni.TVote[p][blt] = vote
if vote == Support {
bids = append(bids, bid)
}
} else {
ni.TVote[p][blt] = vote
ni.Debug(" %s no opinion on %s %s %s", p, bid, idx, vote, ni.TTally[p][blt])
complete = false //not complete
}
}
if idx > ni.PBase.Layer() {
ni.updatePatSupport(p, bids, idx)
}
}
//update correction vectors after vote count
ni.updateCorrectionVectors(p, windowStart)
// update completeness of p
if _, found := ni.TComplete[p]; complete && !found {
ni.TComplete[p] = struct{}{}
ni.PBase = p
ni.Info("found new complete and good pattern for layer %d pattern %d with %d support ", p.Layer().Uint64(), p.id, ni.TSupport[p])
}
}
}
ni.With().Info(fmt.Sprintf("Tortoise finished layer in %v", time.Since(start)), log.LayerId(uint64(newlyr.Index())), log.Uint64("pbase", uint64(ni.PBase.Layer())))
return
}
func getBottomOfWindow(newlyr types.LayerID, pbase types.LayerID, hdist types.LayerID) types.LayerID {
if Window > newlyr {
return 0
} else if pbase < hdist {
return newlyr - Window + 1
}
return Max(pbase-hdist, newlyr-Window+1)
}