-
Notifications
You must be signed in to change notification settings - Fork 86
/
MiniProtocols.hs
609 lines (565 loc) · 23.4 KB
/
MiniProtocols.hs
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
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE TypeOperators #-}
-- orphaned 'ShowProxy PingPong' instance.
{-# OPTIONS_GHC -Wno-orphans #-}
module Test.Ouroboros.Network.Diffusion.Node.MiniProtocols
( Codecs
, cborCodecs
, LimitsAndTimeouts (..)
, AppArgs (..)
, applications
) where
import Control.Applicative (Alternative)
import Control.Concurrent.Class.MonadMVar (MonadMVar)
import Control.Concurrent.Class.MonadSTM qualified as LazySTM
import Control.Concurrent.Class.MonadSTM.Strict
import Control.Monad.Class.MonadAsync
import Control.Monad.Class.MonadFork
import Control.Monad.Class.MonadSay
import Control.Monad.Class.MonadST
import Control.Monad.Class.MonadThrow
import Control.Monad.Class.MonadTime.SI
import Control.Monad.Class.MonadTimer.SI
import Control.Tracer (Tracer (..), contramap, nullTracer)
import Data.ByteString.Lazy (ByteString)
import Data.Functor (($>))
import Data.Maybe (fromMaybe)
import Data.Void (Void)
import System.Random (RandomGen, StdGen)
import Codec.CBOR.Read qualified as CBOR
import Codec.Serialise qualified as Serialise
import Network.TypedProtocol.Codec
import Network.TypedProtocol.PingPong.Client as PingPong
import Network.TypedProtocol.PingPong.Codec.CBOR
import Network.TypedProtocol.PingPong.Examples
import Network.TypedProtocol.PingPong.Server
import Network.TypedProtocol.PingPong.Type
import Ouroboros.Network.BlockFetch
import Ouroboros.Network.BlockFetch.Client
import Ouroboros.Network.Protocol.BlockFetch.Codec
import Ouroboros.Network.Protocol.BlockFetch.Examples
import Ouroboros.Network.Protocol.BlockFetch.Server
import Ouroboros.Network.Protocol.BlockFetch.Type
import Ouroboros.Network.Protocol.ChainSync.Client
import Ouroboros.Network.Protocol.ChainSync.Codec
import Ouroboros.Network.Protocol.ChainSync.Examples
import Ouroboros.Network.Protocol.ChainSync.Server
import Ouroboros.Network.Protocol.ChainSync.Type
import Ouroboros.Network.Protocol.Handshake.Type
import Ouroboros.Network.Protocol.Handshake.Unversioned
import Ouroboros.Network.Protocol.Handshake.Version (simpleSingletonVersions)
import Ouroboros.Network.Protocol.KeepAlive.Client
import Ouroboros.Network.Protocol.KeepAlive.Codec
import Ouroboros.Network.Protocol.KeepAlive.Server
import Ouroboros.Network.Protocol.KeepAlive.Type
import Data.Monoid.Synchronisation
import Ouroboros.Network.Block (HasHeader, HeaderHash, Point)
import Ouroboros.Network.Block qualified as Block
import Ouroboros.Network.Context
import Ouroboros.Network.ControlMessage (ControlMessage (..))
import Ouroboros.Network.Diffusion qualified as Diff (Applications (..))
import Ouroboros.Network.Driver.Limits
import Ouroboros.Network.KeepAlive
import Ouroboros.Network.Mock.Chain qualified as Chain
import Ouroboros.Network.Mock.ProducerState
import Ouroboros.Network.Mux
import Ouroboros.Network.NodeToNode.Version (DiffusionMode (..))
import Ouroboros.Network.Util.ShowProxy
import Ouroboros.Network.Mock.ConcreteBlock
import Network.TypedProtocol
import Pipes qualified
import Ouroboros.Network.NodeToNode (blockFetchMiniProtocolNum,
chainSyncMiniProtocolNum, keepAliveMiniProtocolNum,
peerSharingMiniProtocolNum)
import Ouroboros.Network.PeerSelection.LedgerPeers
import Ouroboros.Network.PeerSelection.LocalRootPeers (OutboundConnectionsState)
import Ouroboros.Network.PeerSelection.PeerSharing qualified as PSTypes
import Ouroboros.Network.PeerSharing (PeerSharingAPI, bracketPeerSharingClient,
peerSharingClient, peerSharingServer)
import Ouroboros.Network.Protocol.PeerSharing.Client (peerSharingClientPeer)
import Ouroboros.Network.Protocol.PeerSharing.Codec (codecPeerSharing)
import Ouroboros.Network.Protocol.PeerSharing.Server (peerSharingServerPeer)
import Ouroboros.Network.Protocol.PeerSharing.Type (PeerSharing)
import Test.Ouroboros.Network.Diffusion.Node.NodeKernel
-- | Protocol codecs.
--
data Codecs addr header block m = Codecs
{ chainSyncCodec :: Codec (ChainSync header (Point block) (Tip block))
CBOR.DeserialiseFailure m ByteString
, blockFetchCodec :: Codec (BlockFetch block (Point block))
CBOR.DeserialiseFailure m ByteString
, keepAliveCodec :: Codec KeepAlive
CBOR.DeserialiseFailure m ByteString
, pingPongCodec :: Codec PingPong
CBOR.DeserialiseFailure m ByteString
, peerSharingCodec :: Codec (PeerSharing addr)
CBOR.DeserialiseFailure m ByteString
}
cborCodecs :: MonadST m => Codecs NtNAddr BlockHeader Block m
cborCodecs = Codecs
{ chainSyncCodec = codecChainSync Serialise.encode Serialise.decode
Serialise.encode Serialise.decode
(Block.encodeTip Serialise.encode)
(Block.decodeTip Serialise.decode)
, blockFetchCodec = codecBlockFetch Serialise.encode Serialise.decode
Serialise.encode Serialise.decode
, keepAliveCodec = codecKeepAlive_v2
, pingPongCodec = codecPingPong
, peerSharingCodec = codecPeerSharing encodeNtNAddr decodeNtNAddr
}
-- | Limits and protocol timeouts
data LimitsAndTimeouts header block = LimitsAndTimeouts
{ -- chain-sync
chainSyncLimits
:: MiniProtocolLimits
, chainSyncSizeLimits
:: ProtocolSizeLimits (ChainSync header (Point block) (Tip block))
ByteString
, chainSyncTimeLimits
:: ProtocolTimeLimits (ChainSync header (Point block) (Tip block))
-- block-fetch
, blockFetchLimits
:: MiniProtocolLimits
, blockFetchSizeLimits
:: ProtocolSizeLimits (BlockFetch block (Point block)) ByteString
, blockFetchTimeLimits
:: ProtocolTimeLimits (BlockFetch block (Point block))
-- keep-alive
, keepAliveLimits
:: MiniProtocolLimits
, keepAliveSizeLimits
:: ProtocolSizeLimits KeepAlive ByteString
, keepAliveTimeLimits
:: ProtocolTimeLimits KeepAlive
-- ping-pong
, pingPongLimits
:: MiniProtocolLimits
, pingPongSizeLimits
:: ProtocolSizeLimits PingPong ByteString
, pingPongTimeLimits
:: ProtocolTimeLimits PingPong
-- handshake
, handshakeLimits
:: MiniProtocolLimits
, handshakeTimeLimits
:: ProtocolTimeLimits (Handshake NtNVersion NtNVersionData)
, handhsakeSizeLimits
:: ProtocolSizeLimits (Handshake NtNVersion NtNVersionData) ByteString
-- peer sharing
, peerSharingLimits
:: MiniProtocolLimits
, peerSharingTimeLimits
:: ProtocolTimeLimits (PeerSharing NtNAddr)
, peerSharingSizeLimits
:: ProtocolSizeLimits (PeerSharing NtNAddr) ByteString
}
-- | Arguments for protocol handlers required by 'nodeApplications'.
--
data AppArgs header block m = AppArgs
{ aaLedgerPeersConsensusInterface
:: LedgerPeersConsensusInterface m
, aaKeepAliveStdGen
:: StdGen
, aaDiffusionMode
:: DiffusionMode
, aaKeepAliveInterval
:: DiffTime
, aaPingPongInterval
:: DiffTime
-- | if returns true, `chain-sync` client will exit as soon as it will see
-- that block.
--
, aaShouldChainSyncExit :: header -> m Bool
-- | if true, `chain-sync` will never go pass the query tip phase. This
-- simulates too far behind the chain in a crude way.
--
, aaChainSyncEarlyExit :: Bool
, aaOwnPeerSharing
:: PSTypes.PeerSharing
, aaUpdateOutboundConnectionsState
:: OutboundConnectionsState -> STM m ()
}
-- | Protocol handlers.
--
applications :: forall block header s m.
( Alternative (STM m)
, MonadAsync m
, MonadFork m
, MonadMask m
, MonadMVar m
, MonadSay m
, MonadThrow m
, MonadTime m
, MonadTimer m
, MonadThrow (STM m)
, HasHeader header
, HasHeader block
, HeaderHash header ~ HeaderHash block
, Show block
, ShowProxy block
, ShowProxy header
, RandomGen s
)
=> Tracer m String
-> NodeKernel header block s m
-> Codecs NtNAddr header block m
-> LimitsAndTimeouts header block
-> AppArgs header block m
-> (block -> header)
-> Diff.Applications NtNAddr NtNVersion NtNVersionData
NtCAddr NtCVersion NtCVersionData
m ()
applications debugTracer nodeKernel
Codecs { chainSyncCodec, blockFetchCodec
, keepAliveCodec, pingPongCodec
, peerSharingCodec
}
limits
AppArgs
{ aaLedgerPeersConsensusInterface
, aaDiffusionMode
, aaKeepAliveStdGen
, aaKeepAliveInterval
, aaPingPongInterval
, aaShouldChainSyncExit
, aaChainSyncEarlyExit
, aaOwnPeerSharing
, aaUpdateOutboundConnectionsState
}
toHeader =
Diff.Applications
{ Diff.daApplicationInitiatorMode =
simpleSingletonVersions UnversionedProtocol
(NtNVersionData InitiatorOnlyDiffusionMode aaOwnPeerSharing)
initiatorApp
, Diff.daApplicationInitiatorResponderMode =
simpleSingletonVersions UnversionedProtocol
(NtNVersionData aaDiffusionMode aaOwnPeerSharing)
initiatorAndResponderApp
, Diff.daLocalResponderApplication =
simpleSingletonVersions UnversionedProtocol
UnversionedProtocolData
localResponderApp
, Diff.daLedgerPeersCtx =
aaLedgerPeersConsensusInterface
, Diff.daUpdateOutboundConnectionsState =
aaUpdateOutboundConnectionsState
}
where
initiatorApp
:: OuroborosBundleWithExpandedCtx InitiatorMode NtNAddr ByteString m () Void
-- initiator mode will never run a peer sharing responder side
initiatorApp = fmap f <$> initiatorAndResponderApp
where
f :: MiniProtocolWithExpandedCtx InitiatorResponderMode NtNAddr ByteString m () ()
-> MiniProtocolWithExpandedCtx InitiatorMode NtNAddr ByteString m () Void
f MiniProtocol { miniProtocolNum
, miniProtocolLimits
, miniProtocolRun } =
MiniProtocol { miniProtocolNum
, miniProtocolLimits
, miniProtocolRun =
case miniProtocolRun of
InitiatorAndResponderProtocol initiator _respnder ->
InitiatorProtocolOnly initiator
}
initiatorAndResponderApp
:: OuroborosBundleWithExpandedCtx InitiatorResponderMode NtNAddr ByteString m () ()
initiatorAndResponderApp = TemperatureBundle
{ withHot = WithHot
[ MiniProtocol
{ miniProtocolNum = chainSyncMiniProtocolNum
, miniProtocolLimits = chainSyncLimits limits
, miniProtocolRun =
InitiatorAndResponderProtocol
chainSyncInitiator
chainSyncResponder
}
, MiniProtocol
{ miniProtocolNum = blockFetchMiniProtocolNum
, miniProtocolLimits = blockFetchLimits limits
, miniProtocolRun =
InitiatorAndResponderProtocol
blockFetchInitiator
blockFetchResponder
}
]
, withWarm = WithWarm
[ MiniProtocol
{ miniProtocolNum = MiniProtocolNum 9
, miniProtocolLimits = pingPongLimits limits
, miniProtocolRun =
InitiatorAndResponderProtocol
pingPongInitiator
pingPongResponder
}
]
, withEstablished = WithEstablished $
[ MiniProtocol
{ miniProtocolNum = keepAliveMiniProtocolNum
, miniProtocolLimits = keepAliveLimits limits
, miniProtocolRun =
InitiatorAndResponderProtocol
keepAliveInitiator
keepAliveResponder
}
] ++ if aaOwnPeerSharing /= PSTypes.PeerSharingDisabled
then [ MiniProtocol
{ miniProtocolNum = peerSharingMiniProtocolNum
, miniProtocolLimits = peerSharingLimits limits
, miniProtocolRun =
InitiatorAndResponderProtocol
peerSharingInitiator
(peerSharingResponder (nkPeerSharingAPI nodeKernel))
}
]
else []
}
localResponderApp
:: OuroborosApplicationWithMinimalCtx
ResponderMode NtCAddr ByteString m Void ()
localResponderApp = OuroborosApplication []
chainSyncInitiator
:: MiniProtocolCb (ExpandedInitiatorContext NtNAddr m) ByteString m ()
chainSyncInitiator =
MiniProtocolCb $
\ ExpandedInitiatorContext {
eicConnectionId = connId,
eicControlMessage = controlMessageSTM
}
channel
->
let client :: Client header point tip m ()
client = go
where
go = Client
{ rollbackward = \_ _ -> do
ctrl <- atomically controlMessageSTM
case ctrl of
Continue -> pure (Right go)
Quiesce -> error "Ouroboros.Network.Protocol.ChainSync.Examples.controlledClient: unexpected Quiesce"
Terminate -> pure (Left ())
, rollforward = \header -> do
exit <- aaShouldChainSyncExit header
if exit
then pure (Left ())
else do ctrl <- atomically controlMessageSTM
case ctrl of
Continue -> pure (Right go)
Quiesce -> error "Ouroboros.Network.Protocol.ChainSync.Examples.controlledClient: unexpected Quiesce"
Terminate -> pure (Left ())
, points = \_ -> pure $
if aaChainSyncEarlyExit
then Left ()
else Right go
}
in do labelThisThread "ChainSyncClient"
bracketSyncWithFetchClient (nkFetchClientRegistry nodeKernel)
(remoteAddress connId) $
bracket (registerClientChains nodeKernel (remoteAddress connId))
(\_ -> unregisterClientChains nodeKernel (remoteAddress connId))
(\chainVar ->
runPeerWithLimits
nullTracer
chainSyncCodec
(chainSyncSizeLimits limits)
(chainSyncTimeLimits limits)
channel
(chainSyncClientPeer $
chainSyncClientExample
chainVar
client)
)
chainSyncResponder
:: MiniProtocolCb (ResponderContext NtNAddr) ByteString m ()
chainSyncResponder = MiniProtocolCb $ \_ctx channel -> do
labelThisThread "ChainSyncServer"
runPeerWithLimits
nullTracer
chainSyncCodec
(chainSyncSizeLimits limits)
(chainSyncTimeLimits limits)
channel
(chainSyncServerPeer
(chainSyncServerExample
() (nkChainProducerState nodeKernel) toHeader))
blockFetchInitiator
:: MiniProtocolCb (ExpandedInitiatorContext NtNAddr m) ByteString m ()
blockFetchInitiator =
MiniProtocolCb $
\ ExpandedInitiatorContext {
eicConnectionId = ConnectionId { remoteAddress },
eicControlMessage = controlMessageSTM
}
channel
-> do labelThisThread "BlockFetchClient"
bracketFetchClient (nkFetchClientRegistry nodeKernel)
UnversionedProtocol
(const NotReceivingTentativeBlocks)
remoteAddress
$ \clientCtx ->
runPeerWithLimits
nullTracer
blockFetchCodec
(blockFetchSizeLimits limits)
(blockFetchTimeLimits limits)
channel
(forgetPipelined
$ blockFetchClient UnversionedProtocol controlMessageSTM
nullTracer clientCtx)
blockFetchResponder
:: MiniProtocolCb (ResponderContext NtNAddr) ByteString m ()
blockFetchResponder =
MiniProtocolCb $ \_ctx channel -> do
labelThisThread "BlockFetchServer"
runPeerWithLimits
nullTracer
blockFetchCodec
(blockFetchSizeLimits limits)
(blockFetchTimeLimits limits)
channel
(blockFetchServerPeer $
blockFetchServer
(constantRangeRequests $ \(ChainRange from to) -> do
nkChainProducer <- Pipes.lift
$ readTVarIO (nkChainProducerState nodeKernel)
Pipes.each $ fromMaybe []
$ Chain.selectBlockRange (chainState nkChainProducer)
from
to
)
)
keepAliveInitiator
:: MiniProtocolCb (ExpandedInitiatorContext NtNAddr m) ByteString m ()
keepAliveInitiator =
MiniProtocolCb $
\ ExpandedInitiatorContext {
eicConnectionId = connId@ConnectionId { remoteAddress },
eicControlMessage = controlMessageSTM
}
channel
-> do labelThisThread "KeepAliveClient"
let kacApp =
\ctxVar -> runPeerWithLimits
((show . (connId,)) `contramap` debugTracer)
keepAliveCodec
(keepAliveSizeLimits limits)
(keepAliveTimeLimits limits)
channel
(keepAliveClientPeer $
keepAliveClient
nullTracer
aaKeepAliveStdGen
controlMessageSTM
remoteAddress
ctxVar
(KeepAliveInterval aaKeepAliveInterval))
bracketKeepAliveClient (nkFetchClientRegistry nodeKernel)
remoteAddress
kacApp
keepAliveResponder
:: MiniProtocolCb (ResponderContext NtNAddr) ByteString m ()
keepAliveResponder = MiniProtocolCb $ \_ctx channel -> do
labelThisThread "KeepAliveServer"
runPeerWithLimits
nullTracer
keepAliveCodec
(keepAliveSizeLimits limits)
(keepAliveTimeLimits limits)
channel
(keepAliveServerPeer keepAliveServer)
pingPongInitiator
:: MiniProtocolCb (ExpandedInitiatorContext NtNAddr m) ByteString m ()
pingPongInitiator =
MiniProtocolCb $
\ ExpandedInitiatorContext {
eicConnectionId = connId,
eicControlMessage = controlMessageSTM
}
channel
-> let continueSTM :: STM m Bool
continueSTM = do
ctrl <- controlMessageSTM
case ctrl of
Continue -> return True
Quiesce -> retry
Terminate -> return False
pingPongClient :: PingPongClient m ()
pingPongClient = SendMsgPing $ do
v <- registerDelay aaPingPongInterval
-- block on the timer, but terminate as soon
-- as 'ctroContinue' returns 'False'.
--
-- Note that if both branches of '<>' return they will return the same
-- value (which must be 'False') so it does not matter which branch is
-- picked.
continue <- atomically $ runFirstToFinish $
( FirstToFinish $ do
LazySTM.readTVar v >>= check
continueSTM )
<> ( FirstToFinish $ do
continueSTM >>= \b -> check (not b) $> b )
if continue
then return pingPongClient
else return $ PingPong.SendMsgDone ()
in runPeerWithLimits
((show . (connId,)) `contramap` debugTracer)
pingPongCodec
(pingPongSizeLimits limits)
(pingPongTimeLimits limits)
channel
(pingPongClientPeer pingPongClient)
pingPongResponder
:: MiniProtocolCb (ResponderContext NtNAddr) ByteString m ()
pingPongResponder = MiniProtocolCb $
\ResponderContext { rcConnectionId = connId } channel ->
runPeerWithLimits
((show . (connId,)) `contramap` debugTracer)
pingPongCodec
(pingPongSizeLimits limits)
(pingPongTimeLimits limits)
channel
(pingPongServerPeer pingPongServerStandard)
peerSharingInitiator
:: MiniProtocolCb (ExpandedInitiatorContext NtNAddr m) ByteString m ()
peerSharingInitiator =
MiniProtocolCb $
\ ExpandedInitiatorContext {
eicConnectionId = connId@ConnectionId { remoteAddress = them },
eicControlMessage = controlMessageSTM
}
channel
-> do labelThisThread "PeerSharingClient"
bracketPeerSharingClient (nkPeerSharingRegistry nodeKernel) them
$ \controller -> do
psClient <- peerSharingClient controlMessageSTM controller
runPeerWithLimits
((show . (connId,)) `contramap` debugTracer)
peerSharingCodec
(peerSharingSizeLimits limits)
(peerSharingTimeLimits limits)
channel
(peerSharingClientPeer psClient)
peerSharingResponder
:: PeerSharingAPI NtNAddr s m
-> MiniProtocolCb (ResponderContext NtNAddr) ByteString m ()
peerSharingResponder psAPI = MiniProtocolCb $ \ResponderContext { rcConnectionId = connId } channel -> do
labelThisThread "PeerSharingServer"
runPeerWithLimits
((show . (connId,)) `contramap` debugTracer)
peerSharingCodec
(peerSharingSizeLimits limits)
(peerSharingTimeLimits limits)
channel
$ peerSharingServerPeer
$ peerSharingServer psAPI
--
-- Orphaned Instances
--
instance ShowProxy PingPong where
showProxy Proxy = "PingPong"