|
| 1 | +{-# LANGUAGE BlockArguments #-} |
| 2 | +{-# LANGUAGE BangPatterns #-} |
| 3 | +{-# LANGUAGE LambdaCase #-} |
| 4 | +{-# LANGUAGE NamedFieldPuns #-} |
| 5 | +{-# LANGUAGE ScopedTypeVariables #-} |
| 6 | + |
| 7 | +module Ouroboros.Network.TxSubmission.Inbound.Registry |
| 8 | + ( SharedTxStateVar |
| 9 | + , newSharedTxStateVar |
| 10 | + , decisionLogicThread |
| 11 | + , withPeer |
| 12 | + ) where |
| 13 | + |
| 14 | +import Control.Concurrent.Class.MonadMVar.Strict |
| 15 | +import Control.Concurrent.Class.MonadSTM.Strict |
| 16 | +import Control.Monad.Class.MonadThrow |
| 17 | +import Control.Monad.Class.MonadTimer.SI |
| 18 | + |
| 19 | +import Data.Foldable (foldl', traverse_) |
| 20 | +import Data.Map.Strict (Map) |
| 21 | +import Data.Map.Strict qualified as Map |
| 22 | +import Data.Maybe (fromMaybe) |
| 23 | +import Data.Set qualified as Set |
| 24 | +import Data.Sequence.Strict qualified as StrictSeq |
| 25 | +import Data.Void (Void) |
| 26 | + |
| 27 | +import Ouroboros.Network.DeltaQ (PeerGSV (..)) |
| 28 | +import Ouroboros.Network.TxSubmission.Inbound.Decision |
| 29 | +import Ouroboros.Network.TxSubmission.Inbound.Policy |
| 30 | +import Ouroboros.Network.TxSubmission.Inbound.State |
| 31 | + |
| 32 | +-- | Communication channels between `TxSubmission` client mini-protocol and |
| 33 | +-- decision logic. |
| 34 | +-- |
| 35 | +newtype TxChannels m peeraddr txid = TxChannels { |
| 36 | + txChannelMap :: Map peeraddr (StrictMVar m (TxDecision txid)) |
| 37 | + } |
| 38 | + |
| 39 | +type TxChannelsVar m peeraddr txid = StrictMVar m (TxChannels m peeraddr txid) |
| 40 | + |
| 41 | +-- | API to access `PeerTxState` inside `PeerTxStateVar`. |
| 42 | +-- |
| 43 | +newtype PeerTxAPI m txid = PeerTxAPI { |
| 44 | + -- A blocking action |
| 45 | + readTxDecision :: m (TxDecision txid) |
| 46 | + } |
| 47 | + |
| 48 | + |
| 49 | +-- | A bracket function which registers / de-registers a new peer in |
| 50 | +-- `SharedTxStateVar` and `PeerTxStateVar`s, which exposes `PeerTxStateAPI`. |
| 51 | +-- `PeerTxStateAPI` is only safe inside the `withPeer` scope. |
| 52 | +-- |
| 53 | +withPeer |
| 54 | + :: forall peeraddr txid tx m a. |
| 55 | + ( MonadMask m |
| 56 | + , MonadMVar m |
| 57 | + , MonadSTM m |
| 58 | + , Ord txid |
| 59 | + , Ord peeraddr |
| 60 | + , Show peeraddr |
| 61 | + ) |
| 62 | + => TxChannelsVar m peeraddr txid |
| 63 | + -> SharedTxStateVar m peeraddr txid tx |
| 64 | + -> peeraddr |
| 65 | + -- ^ new peer |
| 66 | + -> (PeerTxAPI m txid -> m a) |
| 67 | + -- ^ callback which gives access to `PeerTxStateAPI` |
| 68 | + -> m a |
| 69 | +withPeer channelsVar sharedStateVar peeraddr io = |
| 70 | + bracket |
| 71 | + (do -- create a communication channel |
| 72 | + !peerTxAPI <- |
| 73 | + modifyMVar channelsVar |
| 74 | + \ TxChannels { txChannelMap } -> do |
| 75 | + chann <- newEmptyMVar |
| 76 | + let (chann', txChannelMap') = |
| 77 | + Map.alterF (\mbChann -> |
| 78 | + let !chann'' = fromMaybe chann mbChann |
| 79 | + in (chann'', Just chann'')) |
| 80 | + peeraddr |
| 81 | + txChannelMap |
| 82 | + return |
| 83 | + ( TxChannels { txChannelMap = txChannelMap' } |
| 84 | + , PeerTxAPI { readTxDecision = takeMVar chann' } |
| 85 | + ) |
| 86 | + |
| 87 | + atomically $ modifyTVar sharedStateVar registerPeer |
| 88 | + return peerTxAPI |
| 89 | + ) |
| 90 | + -- the handler is a short blocking operation, thus we need to use |
| 91 | + -- `uninterruptibleMask_` |
| 92 | + (\_ -> uninterruptibleMask_ do |
| 93 | + atomically $ modifyTVar sharedStateVar unregisterPeer |
| 94 | + modifyMVar_ channelsVar |
| 95 | + \ TxChannels { txChannelMap } -> |
| 96 | + return TxChannels { txChannelMap = Map.delete peeraddr txChannelMap } |
| 97 | + ) |
| 98 | + io |
| 99 | + where |
| 100 | + registerPeer :: SharedTxState peeraddr txid tx |
| 101 | + -> SharedTxState peeraddr txid tx |
| 102 | + registerPeer st@SharedTxState { peerTxStates } = |
| 103 | + st { peerTxStates = |
| 104 | + Map.insert |
| 105 | + peeraddr |
| 106 | + PeerTxState { |
| 107 | + availableTxIds = Map.empty, |
| 108 | + requestedTxIdsInflight = 0, |
| 109 | + requestedTxsInflightSize = 0, |
| 110 | + requestedTxsInflight = Set.empty, |
| 111 | + unacknowledgedTxIds = StrictSeq.empty, |
| 112 | + unknownTxs = Set.empty } |
| 113 | + peerTxStates |
| 114 | + } |
| 115 | + |
| 116 | + -- TODO: this function needs to be tested! |
| 117 | + unregisterPeer :: SharedTxState peeraddr txid tx |
| 118 | + -> SharedTxState peeraddr txid tx |
| 119 | + unregisterPeer st@SharedTxState { peerTxStates, |
| 120 | + bufferedTxs, |
| 121 | + referenceCounts } = |
| 122 | + st { peerTxStates = peerTxStates', |
| 123 | + bufferedTxs = bufferedTxs', |
| 124 | + referenceCounts = referenceCounts' } |
| 125 | + where |
| 126 | + (PeerTxState { unacknowledgedTxIds }, peerTxStates') = |
| 127 | + Map.alterF |
| 128 | + (\case |
| 129 | + Nothing -> error ("TxSubmission.withPeer: invariant violation for peer " ++ show peeraddr) |
| 130 | + Just a -> (a, Nothing)) |
| 131 | + peeraddr |
| 132 | + peerTxStates |
| 133 | + |
| 134 | + referenceCounts' = |
| 135 | + foldl' (flip $ Map.update |
| 136 | + \cnt -> if cnt > 1 |
| 137 | + then Just $! pred cnt |
| 138 | + else Nothing) |
| 139 | + referenceCounts |
| 140 | + unacknowledgedTxIds |
| 141 | + |
| 142 | + liveSet = Map.keysSet referenceCounts' |
| 143 | + |
| 144 | + bufferedTxs' = bufferedTxs |
| 145 | + `Map.restrictKeys` |
| 146 | + liveSet |
| 147 | + |
| 148 | + |
| 149 | +decisionLogicThread |
| 150 | + :: forall m peeraddr txid tx. |
| 151 | + ( MonadDelay m |
| 152 | + , MonadMVar m |
| 153 | + , MonadSTM m |
| 154 | + , Ord peeraddr |
| 155 | + , Ord txid |
| 156 | + ) |
| 157 | + => TxDecisionPolicy |
| 158 | + -> StrictTVar m (Map peeraddr PeerGSV) |
| 159 | + -> TxChannelsVar m peeraddr txid |
| 160 | + -> SharedTxStateVar m peeraddr txid tx |
| 161 | + -> m Void |
| 162 | +decisionLogicThread policy gsvVar txChannelsVar sharedStateVar = go |
| 163 | + where |
| 164 | + go :: m Void |
| 165 | + go = do |
| 166 | + -- We rate limit the decision making process, it could overwhelm the CPU |
| 167 | + -- if there are too many inbound connections. |
| 168 | + threadDelay 0.005 -- 5ms |
| 169 | + |
| 170 | + decisions <- atomically do |
| 171 | + sharedCtx <- |
| 172 | + SharedDecisionContext |
| 173 | + <$> readTVar gsvVar |
| 174 | + <*> readTVar sharedStateVar |
| 175 | + let activePeers = filterActivePeers policy (sdcSharedTxState sharedCtx) |
| 176 | + |
| 177 | + -- block until at least one peer is active |
| 178 | + check (not (Map.null activePeers)) |
| 179 | + |
| 180 | + let (sharedState, decisions) = makeDecisions policy sharedCtx activePeers |
| 181 | + writeTVar sharedStateVar sharedState |
| 182 | + return decisions |
| 183 | + TxChannels { txChannelMap } <- readMVar txChannelsVar |
| 184 | + traverse_ |
| 185 | + (\(mvar, d) -> modifyMVar_ mvar (\d' -> return (d' <> d))) |
| 186 | + (Map.intersectionWith (,) |
| 187 | + txChannelMap |
| 188 | + decisions) |
| 189 | + go |
0 commit comments