/
virtual.go
400 lines (341 loc) · 9.71 KB
/
virtual.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
package bitswap
import (
"context"
"errors"
"sort"
"sync"
"sync/atomic"
"time"
bsmsg "github.com/Genon2/ipfs-thesis-bitswap/message"
bsnet "github.com/Genon2/ipfs-thesis-bitswap/network"
cid "github.com/ipfs/go-cid"
delay "github.com/ipfs/go-ipfs-delay"
mockrouting "github.com/ipfs/go-ipfs-routing/mock"
"github.com/libp2p/go-libp2p-core/connmgr"
"github.com/libp2p/go-libp2p-core/peer"
protocol "github.com/libp2p/go-libp2p-core/protocol"
"github.com/libp2p/go-libp2p-core/routing"
tnet "github.com/libp2p/go-libp2p-testing/net"
mocknet "github.com/libp2p/go-libp2p/p2p/net/mock"
"github.com/libp2p/go-libp2p/p2p/protocol/ping"
)
// VirtualNetwork generates a new testnet instance - a fake network that
// is used to simulate sending messages.
func VirtualNetwork(rs mockrouting.Server, d delay.D) Network {
return &network{
latencies: make(map[peer.ID]map[peer.ID]time.Duration),
clients: make(map[peer.ID]*receiverQueue),
delay: d,
routingserver: rs,
isRateLimited: false,
rateLimitGenerator: nil,
conns: make(map[string]struct{}),
}
}
// RateLimitGenerator is an interface for generating rate limits across peers
type RateLimitGenerator interface {
NextRateLimit() float64
}
// RateLimitedVirtualNetwork generates a testnet instance where nodes are rate
// limited in the upload/download speed.
func RateLimitedVirtualNetwork(rs mockrouting.Server, d delay.D, rateLimitGenerator RateLimitGenerator) Network {
return &network{
latencies: make(map[peer.ID]map[peer.ID]time.Duration),
rateLimiters: make(map[peer.ID]map[peer.ID]*mocknet.RateLimiter),
clients: make(map[peer.ID]*receiverQueue),
delay: d,
routingserver: rs,
isRateLimited: true,
rateLimitGenerator: rateLimitGenerator,
conns: make(map[string]struct{}),
}
}
type network struct {
mu sync.Mutex
latencies map[peer.ID]map[peer.ID]time.Duration
rateLimiters map[peer.ID]map[peer.ID]*mocknet.RateLimiter
clients map[peer.ID]*receiverQueue
routingserver mockrouting.Server
delay delay.D
isRateLimited bool
rateLimitGenerator RateLimitGenerator
conns map[string]struct{}
}
type message struct {
from peer.ID
msg bsmsg.BitSwapMessage
shouldSend time.Time
}
// receiverQueue queues up a set of messages to be sent, and sends them *in
// order* with their delays respected as much as sending them in order allows
// for
type receiverQueue struct {
receiver *networkClient
queue []*message
active bool
lk sync.Mutex
}
func (n *network) Adapter(p tnet.Identity, opts ...bsnet.NetOpt) bsnet.BitSwapNetwork {
n.mu.Lock()
defer n.mu.Unlock()
s := bsnet.Settings{
SupportedProtocols: []protocol.ID{
bsnet.ProtocolBitswap,
bsnet.ProtocolBitswapOneOne,
bsnet.ProtocolBitswapOneZero,
bsnet.ProtocolBitswapNoVers,
},
}
for _, opt := range opts {
opt(&s)
}
client := &networkClient{
local: p.ID(),
network: n,
routing: n.routingserver.Client(p),
supportedProtocols: s.SupportedProtocols,
}
n.clients[p.ID()] = &receiverQueue{receiver: client}
return client
}
func (n *network) HasPeer(p peer.ID) bool {
n.mu.Lock()
defer n.mu.Unlock()
_, found := n.clients[p]
return found
}
// TODO should this be completely asynchronous?
// TODO what does the network layer do with errors received from services?
func (n *network) SendMessage(
ctx context.Context,
from peer.ID,
to peer.ID,
mes bsmsg.BitSwapMessage) error {
mes = mes.Clone()
n.mu.Lock()
defer n.mu.Unlock()
latencies, ok := n.latencies[from]
if !ok {
latencies = make(map[peer.ID]time.Duration)
n.latencies[from] = latencies
}
latency, ok := latencies[to]
if !ok {
latency = n.delay.NextWaitTime()
latencies[to] = latency
}
var bandwidthDelay time.Duration
if n.isRateLimited {
rateLimiters, ok := n.rateLimiters[from]
if !ok {
rateLimiters = make(map[peer.ID]*mocknet.RateLimiter)
n.rateLimiters[from] = rateLimiters
}
rateLimiter, ok := rateLimiters[to]
if !ok {
rateLimiter = mocknet.NewRateLimiter(n.rateLimitGenerator.NextRateLimit())
rateLimiters[to] = rateLimiter
}
size := mes.ToProtoV1().Size()
bandwidthDelay = rateLimiter.Limit(size)
} else {
bandwidthDelay = 0
}
receiver, ok := n.clients[to]
if !ok {
return errors.New("cannot locate peer on network")
}
// nb: terminate the context since the context wouldn't actually be passed
// over the network in a real scenario
msg := &message{
from: from,
msg: mes,
shouldSend: time.Now().Add(latency).Add(bandwidthDelay),
}
receiver.enqueue(msg)
return nil
}
type networkClient struct {
// These need to be at the top of the struct (allocated on the heap) for alignment on 32bit platforms.
stats bsnet.Stats
local peer.ID
bsnet.Receiver
network *network
routing routing.Routing
supportedProtocols []protocol.ID
}
func (nc *networkClient) Self() peer.ID {
return nc.local
}
func (nc *networkClient) Ping(ctx context.Context, p peer.ID) ping.Result {
return ping.Result{RTT: nc.Latency(p)}
}
func (nc *networkClient) Latency(p peer.ID) time.Duration {
nc.network.mu.Lock()
defer nc.network.mu.Unlock()
return nc.network.latencies[nc.local][p]
}
func (nc *networkClient) SendMessage(
ctx context.Context,
to peer.ID,
message bsmsg.BitSwapMessage) error {
if err := nc.network.SendMessage(ctx, nc.local, to, message); err != nil {
return err
}
atomic.AddUint64(&nc.stats.MessagesSent, 1)
return nil
}
func (nc *networkClient) Stats() bsnet.Stats {
return bsnet.Stats{
MessagesRecvd: atomic.LoadUint64(&nc.stats.MessagesRecvd),
MessagesSent: atomic.LoadUint64(&nc.stats.MessagesSent),
}
}
// FindProvidersAsync returns a channel of providers for the given key.
func (nc *networkClient) FindProvidersAsync(ctx context.Context, k cid.Cid, max int) <-chan peer.ID {
// NB: this function duplicates the AddrInfo -> ID transformation in the
// bitswap network adapter. Not to worry. This network client will be
// deprecated once the ipfsnet.Mock is added. The code below is only
// temporary.
out := make(chan peer.ID)
go func() {
defer close(out)
providers := nc.routing.FindProvidersAsync(ctx, k, max)
for info := range providers {
select {
case <-ctx.Done():
case out <- info.ID:
}
}
}()
return out
}
func (nc *networkClient) ConnectionManager() connmgr.ConnManager {
return &connmgr.NullConnMgr{}
}
type messagePasser struct {
net *networkClient
target peer.ID
local peer.ID
ctx context.Context
}
func (mp *messagePasser) SendMsg(ctx context.Context, m bsmsg.BitSwapMessage) error {
return mp.net.SendMessage(ctx, mp.target, m)
}
func (mp *messagePasser) Close() error {
return nil
}
func (mp *messagePasser) Reset() error {
return nil
}
var oldProtos = map[protocol.ID]struct{}{
bsnet.ProtocolBitswapNoVers: {},
bsnet.ProtocolBitswapOneZero: {},
bsnet.ProtocolBitswapOneOne: {},
}
func (mp *messagePasser) SupportsHave() bool {
protos := mp.net.network.clients[mp.target].receiver.supportedProtocols
for _, proto := range protos {
if _, ok := oldProtos[proto]; !ok {
return true
}
}
return false
}
func (nc *networkClient) NewMessageSender(ctx context.Context, p peer.ID, opts *bsnet.MessageSenderOpts) (bsnet.MessageSender, error) {
return &messagePasser{
net: nc,
target: p,
local: nc.local,
ctx: ctx,
}, nil
}
// Provide provides the key to the network.
func (nc *networkClient) Provide(ctx context.Context, k cid.Cid) error {
return nc.routing.Provide(ctx, k, true)
}
func (nc *networkClient) SetDelegate(r bsnet.Receiver) {
nc.Receiver = r
}
func (nc *networkClient) ConnectTo(_ context.Context, p peer.ID) error {
nc.network.mu.Lock()
otherClient, ok := nc.network.clients[p]
if !ok {
nc.network.mu.Unlock()
return errors.New("no such peer in network")
}
tag := tagForPeers(nc.local, p)
if _, ok := nc.network.conns[tag]; ok {
nc.network.mu.Unlock()
// log.Warning("ALREADY CONNECTED TO PEER (is this a reconnect? test lib needs fixing)")
return nil
}
nc.network.conns[tag] = struct{}{}
nc.network.mu.Unlock()
otherClient.receiver.PeerConnected(nc.local)
nc.Receiver.PeerConnected(p)
return nil
}
func (nc *networkClient) DisconnectFrom(_ context.Context, p peer.ID) error {
nc.network.mu.Lock()
defer nc.network.mu.Unlock()
otherClient, ok := nc.network.clients[p]
if !ok {
return errors.New("no such peer in network")
}
tag := tagForPeers(nc.local, p)
if _, ok := nc.network.conns[tag]; !ok {
// Already disconnected
return nil
}
delete(nc.network.conns, tag)
otherClient.receiver.PeerDisconnected(nc.local)
nc.Receiver.PeerDisconnected(p)
return nil
}
func (rq *receiverQueue) enqueue(m *message) {
rq.lk.Lock()
defer rq.lk.Unlock()
rq.queue = append(rq.queue, m)
if !rq.active {
rq.active = true
go rq.process()
}
}
func (rq *receiverQueue) Swap(i, j int) {
rq.queue[i], rq.queue[j] = rq.queue[j], rq.queue[i]
}
func (rq *receiverQueue) Len() int {
return len(rq.queue)
}
func (rq *receiverQueue) Less(i, j int) bool {
return rq.queue[i].shouldSend.UnixNano() < rq.queue[j].shouldSend.UnixNano()
}
func (rq *receiverQueue) process() {
for {
rq.lk.Lock()
sort.Sort(rq)
if len(rq.queue) == 0 {
rq.active = false
rq.lk.Unlock()
return
}
m := rq.queue[0]
if time.Until(m.shouldSend).Seconds() < 0.1 {
rq.queue = rq.queue[1:]
rq.lk.Unlock()
time.Sleep(time.Until(m.shouldSend))
atomic.AddUint64(&rq.receiver.stats.MessagesRecvd, 1)
rq.receiver.ReceiveMessage(context.TODO(), m.from, m.msg)
} else {
rq.lk.Unlock()
time.Sleep(100 * time.Millisecond)
}
}
}
func tagForPeers(a, b peer.ID) string {
if a < b {
return string(a + b)
}
return string(b + a)
}