-
Notifications
You must be signed in to change notification settings - Fork 339
/
puller.go
460 lines (373 loc) · 11.3 KB
/
puller.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
// Copyright 2020 The Swarm Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package puller provides protocol-orchestrating functionality
// over the pullsync protocol. It pulls chunks from other nodes
// and reacts to changes in network configuration.
package puller
import (
"context"
"errors"
"fmt"
"math"
"sync"
"time"
"github.com/ethersphere/bee/pkg/intervalstore"
"github.com/ethersphere/bee/pkg/log"
"github.com/ethersphere/bee/pkg/postage"
"github.com/ethersphere/bee/pkg/pullsync"
"github.com/ethersphere/bee/pkg/storage"
"github.com/ethersphere/bee/pkg/swarm"
"github.com/ethersphere/bee/pkg/topology"
)
// loggerName is the tree path name of the logger for this package.
const loggerName = "puller"
var errCursorsLength = errors.New("cursors length mismatch")
const syncSleepDur = time.Minute * 5
type Options struct {
Bins uint8
}
type Puller struct {
topology topology.Driver
reserveState postage.ReserveStateGetter
statestore storage.StateStorer
syncer pullsync.Interface
metrics metrics
logger log.Logger
syncPeers []map[string]*syncPeer // index is bin, map key is peer address
syncPeersMtx sync.Mutex
quit chan struct{}
wg sync.WaitGroup
bins uint8 // how many bins do we support
}
func New(stateStore storage.StateStorer, topology topology.Driver, reserveState postage.ReserveStateGetter, pullSync pullsync.Interface, logger log.Logger, o Options, warmupTime time.Duration) *Puller {
var (
bins uint8 = swarm.MaxBins
)
if o.Bins != 0 {
bins = o.Bins
}
p := &Puller{
statestore: stateStore,
topology: topology,
reserveState: reserveState,
syncer: pullSync,
metrics: newMetrics(),
logger: logger.WithName(loggerName).Register(),
syncPeers: make([]map[string]*syncPeer, bins),
quit: make(chan struct{}),
bins: bins,
}
for i := uint8(0); i < bins; i++ {
p.syncPeers[i] = make(map[string]*syncPeer)
}
p.wg.Add(1)
go p.manage(warmupTime)
return p
}
func (p *Puller) manage(warmupTime time.Duration) {
defer p.wg.Done()
select {
case <-time.After(warmupTime):
case <-p.quit:
return
}
c, unsubscribe := p.topology.SubscribeTopologyChange()
defer unsubscribe()
ctx, cancel := context.WithCancel(context.Background())
go func() {
<-p.quit
cancel()
}()
p.logger.Info("puller: warmup period complete, worker starting.")
for {
select {
case <-p.quit:
return
case <-c:
p.syncPeersMtx.Lock()
// peersDisconnected is used to mark and prune peers that are no longer connected.
peersDisconnected := make(map[string]*syncPeer)
for _, bin := range p.syncPeers {
for addr, peer := range bin {
peersDisconnected[addr] = peer
}
}
neighborhoodDepth := p.topology.NeighborhoodDepth()
syncRadius := p.reserveState.GetReserveState().StorageRadius
_ = p.topology.EachPeerRev(func(addr swarm.Address, po uint8) (stop, jumpToNext bool, err error) {
if po >= neighborhoodDepth {
// add peer to sync
if _, ok := p.syncPeers[po][addr.ByteString()]; !ok {
p.syncPeers[po][addr.ByteString()] = newSyncPeer(addr, po, p.bins)
}
// remove from disconnected list as the peer is still connected
delete(peersDisconnected, addr.ByteString())
} else {
// outside of neighborhood, prune peer
p.disconnectPeer(addr, po)
}
return false, false, nil
}, topology.Filter{Reachable: true})
for _, peer := range peersDisconnected {
p.disconnectPeer(peer.address, peer.po)
}
p.recalcPeers(ctx, syncRadius)
p.syncPeersMtx.Unlock()
}
}
}
// disconnectPeer cancels all existing syncing and removes the peer entry from the syncing map.
// Must be called under lock.
func (p *Puller) disconnectPeer(addr swarm.Address, po uint8) {
loggerV2 := p.logger
loggerV2.Debug("puller disconnect cleanup peer", "peer_address", addr, "proximity_order", po)
if peer, ok := p.syncPeers[po][addr.ByteString()]; ok {
peer.gone()
}
delete(p.syncPeers[po], addr.ByteString())
}
// recalcPeers starts or stops syncing process for peers per bin depending on the current sync radius.
// Must be called under lock.
func (p *Puller) recalcPeers(ctx context.Context, syncRadius uint8) (dontSync bool) {
loggerV2 := p.logger
for bin, peers := range p.syncPeers {
for _, peer := range peers {
if bin < int(syncRadius) {
peer.cancelBins(uint8(bin))
continue
}
err := p.syncPeer(ctx, peer, syncRadius)
if err != nil {
loggerV2.Error(err, "recalc peers sync failed", "bin", bin, "peer", peer.address)
}
}
}
return false
}
func (p *Puller) syncPeer(ctx context.Context, peer *syncPeer, syncRadius uint8) error {
peer.Lock()
defer peer.Unlock()
if peer.cursors == nil {
cursors, err := p.syncer.GetCursors(ctx, peer.address)
if err != nil {
return fmt.Errorf("could not get cursors from peer %s: %w", peer.address, err)
}
peer.cursors = cursors
}
if len(peer.cursors) != int(p.bins) {
return errCursorsLength
}
for bin, cur := range peer.cursors {
if bin >= int(syncRadius) && !peer.isBinSyncing(uint8(bin)) {
p.syncPeerBin(ctx, peer, uint8(bin), cur)
}
}
return nil
}
// syncPeerBin will start historical and live syncing for the peer for a particular bin.
// Must be called under syncPeer lock.
func (p *Puller) syncPeerBin(ctx context.Context, peer *syncPeer, bin uint8, cur uint64) {
binCtx, cancel := context.WithCancel(ctx)
peer.setBinCancel(cancel, bin)
if cur > 0 {
p.wg.Add(1)
go p.histSyncWorker(binCtx, peer.address, bin, cur)
}
// start live
p.wg.Add(1)
go p.liveSyncWorker(binCtx, peer.address, bin, cur)
}
func (p *Puller) histSyncWorker(ctx context.Context, peer swarm.Address, bin uint8, cur uint64) {
loggerV2 := p.logger
defer p.wg.Done()
defer p.metrics.HistWorkerDoneCounter.Inc()
sleep := false
p.logger.Debug("histSyncWorker starting", "peer_address", peer, "bin", bin, "cursor", cur)
for {
p.metrics.HistWorkerIterCounter.Inc()
if sleep {
select {
case <-ctx.Done():
loggerV2.Debug("histSyncWorker context cancelled", "peer_address", peer, "bin", bin, "cursor", cur)
return
case <-time.After(syncSleepDur):
}
sleep = false
}
select {
case <-ctx.Done():
loggerV2.Debug("histSyncWorker context cancelled", "peer_address", peer, "bin", bin, "cursor", cur)
return
default:
}
s, _, _, err := p.nextPeerInterval(peer, bin)
if err != nil {
p.metrics.HistWorkerErrCounter.Inc()
p.logger.Error(err, "histSyncWorker nextPeerInterval failed")
return
}
if s > cur {
p.logger.Debug("histSyncWorker syncing finished", "bin", bin, "cursor", cur)
return
}
top, _, syncErr := p.syncer.SyncInterval(ctx, peer, bin, s, cur)
err = p.addPeerInterval(peer, bin, s, top)
if err != nil {
p.metrics.HistWorkerErrCounter.Inc()
p.logger.Error(err, "histSyncWorker could not persist interval for peer, quitting...", "peer_address", peer)
return
}
if syncErr != nil {
p.metrics.HistWorkerErrCounter.Inc()
p.logger.Error(syncErr, "histSyncWorker syncing interval failed", "peer_address", peer, "bin", bin, "cursor", cur, "start", s, "topmost", top)
}
loggerV2.Debug("histSyncWorker pulled", "bin", bin, "start", s, "topmost", top, "peer_address", peer)
}
}
func (p *Puller) liveSyncWorker(ctx context.Context, peer swarm.Address, bin uint8, cur uint64) {
loggerV2 := p.logger
defer p.wg.Done()
p.logger.Debug("liveSyncWorker starting", "peer_address", peer, "bin", bin, "cursor", cur)
from := cur + 1
sleep := false
for {
p.metrics.LiveWorkerIterCounter.Inc()
if sleep {
select {
case <-ctx.Done():
loggerV2.Debug("liveSyncWorker context cancelled", "peer_address", peer, "bin", bin, "cursor", cur)
return
case <-time.After(syncSleepDur):
}
sleep = false
}
select {
case <-ctx.Done():
loggerV2.Debug("liveSyncWorker context cancelled", "peer_address", peer, "bin", bin, "cursor", cur)
return
default:
}
top, _, syncErr := p.syncer.SyncInterval(ctx, peer, bin, from, pullsync.MaxCursor)
if top == math.MaxUint64 {
p.metrics.MaxUintErrCounter.Inc()
return
}
err := p.addPeerInterval(peer, bin, from, top)
if err != nil {
p.metrics.LiveWorkerErrCounter.Inc()
p.logger.Error(err, "liveSyncWorker exit on add peer interval", "peer_address", peer, "bin", bin, "from", from, "error", err)
return
}
if syncErr != nil {
p.metrics.LiveWorkerErrCounter.Inc()
p.logger.Error(syncErr, "liveSyncWorker sync error", "peer_address", peer, "bin", bin, "from", from, "topmost", top)
sleep = true
}
loggerV2.Debug("liveSyncWorker pulled bin", "bin", bin, "from", from, "topmost", top, "peer_address", peer)
from = top + 1
}
}
func (p *Puller) Close() error {
p.logger.Info("puller shutting down")
close(p.quit)
cc := make(chan struct{})
go func() {
defer close(cc)
p.wg.Wait()
}()
select {
case <-cc:
case <-time.After(10 * time.Second):
p.logger.Warning("puller shutting down with running goroutines")
}
return nil
}
func (p *Puller) addPeerInterval(peer swarm.Address, bin uint8, start, end uint64) (err error) {
peerStreamKey := peerIntervalKey(peer, bin)
i, err := p.getOrCreateInterval(peer, bin)
if err != nil {
return err
}
i.Add(start, end)
return p.statestore.Put(peerStreamKey, i)
}
func (p *Puller) nextPeerInterval(peer swarm.Address, bin uint8) (start, end uint64, empty bool, err error) {
i, err := p.getOrCreateInterval(peer, bin)
if err != nil {
return 0, 0, false, err
}
start, end, empty = i.Next(0)
return start, end, empty, nil
}
func (p *Puller) getOrCreateInterval(peer swarm.Address, bin uint8) (*intervalstore.Intervals, error) {
// check that an interval entry exists
key := peerIntervalKey(peer, bin)
i := &intervalstore.Intervals{}
err := p.statestore.Get(key, i)
if err != nil {
if errors.Is(err, storage.ErrNotFound) {
// key interval values are ALWAYS > 0
i = intervalstore.NewIntervals(1)
if err := p.statestore.Put(key, i); err != nil {
return nil, err
}
} else {
return nil, fmt.Errorf("get peer interval: %w", err)
}
}
return i, nil
}
func peerIntervalKey(peer swarm.Address, bin uint8) string {
k := fmt.Sprintf("%s|%d", peer.String(), bin)
return k
}
type syncPeer struct {
address swarm.Address
binCancelFuncs map[uint8]func() // slice of context cancel funcs for historical sync. index is bin
po uint8
cursors []uint64
sync.Mutex
}
func newSyncPeer(addr swarm.Address, po, bins uint8) *syncPeer {
return &syncPeer{
address: addr,
binCancelFuncs: make(map[uint8]func(), bins),
}
}
// called when peer disconnects or on shutdown, cleans up ongoing sync operations
func (p *syncPeer) gone() {
p.Lock()
defer p.Unlock()
for _, f := range p.binCancelFuncs {
f()
}
}
func (p *syncPeer) setBinCancel(cf func(), bin uint8) {
p.binCancelFuncs[bin] = cf
}
func (p *syncPeer) cancelBins(bin uint8) {
if c, ok := p.binCancelFuncs[bin]; ok {
c()
delete(p.binCancelFuncs, bin)
}
}
func (p *syncPeer) isBinSyncing(bin uint8) bool {
_, ok := p.binCancelFuncs[bin]
return ok
}
func isSyncing(p *Puller, addr swarm.Address) bool {
// this is needed for testing purposes in order
// to verify that a peer is no longer syncing on
// disconnect
p.syncPeersMtx.Lock()
defer p.syncPeersMtx.Unlock()
for _, bin := range p.syncPeers {
for peer := range bin {
if addr.ByteString() == peer {
return true
}
}
}
return false
}