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
|
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
module Network.HTTP2.H2.Context where
import Control.Concurrent.STM
import Control.Exception
import qualified Control.Exception as E
import Data.IORef
import Network.Control
import Network.Socket (SockAddr)
import qualified System.ThreadManager as T
import Imports hiding (insert)
import Network.HPACK
import Network.HTTP2.Frame
import Network.HTTP2.H2.Settings
import Network.HTTP2.H2.Stream
import Network.HTTP2.H2.StreamTable
import Network.HTTP2.H2.Types
data Role = Client | Server deriving (Eq, Show)
----------------------------------------------------------------
data RoleInfo = RIS ServerInfo | RIC ClientInfo
type Launch = Context -> Stream -> InpObj -> IO ()
newtype ServerInfo = ServerInfo
{ launch :: Launch
}
data ClientInfo = ClientInfo
{ scheme :: ByteString
, authority :: Authority
}
toServerInfo :: RoleInfo -> ServerInfo
toServerInfo (RIS x) = x
toServerInfo _ = error "toServerInfo"
toClientInfo :: RoleInfo -> ClientInfo
toClientInfo (RIC x) = x
toClientInfo _ = error "toClientInfo"
newServerInfo :: Launch -> RoleInfo
newServerInfo = RIS . ServerInfo
newClientInfo :: ByteString -> Authority -> RoleInfo
newClientInfo scm auth = RIC $ ClientInfo scm auth
----------------------------------------------------------------
{- FOURMOLU_DISABLE -}
-- | The context for HTTP/2 connection.
data Context = Context
{ role :: Role
, roleInfo :: RoleInfo
, -- Settings
mySettings :: Settings
, myFirstSettings :: IORef Bool
, peerSettings :: IORef Settings
, oddStreamTable :: TVar OddStreamTable
, evenStreamTable :: TVar EvenStreamTable
, continued :: IORef (Maybe StreamId)
-- ^ RFC 9113 says "Other frames (from any stream) MUST NOT
-- occur between the HEADERS frame and any CONTINUATION
-- frames that might follow". This field is used to implement
-- this requirement.
, myStreamId :: TVar StreamId
, peerStreamId :: IORef StreamId
, outputBufferLimit :: IORef Int
, outputQ :: TQueue Output
-- ^ Invariant: Each stream will only ever have at most one 'Output'
-- object in this queue at any moment.
, outputQStreamID :: TVar StreamId
, controlQ :: TQueue Control
, encodeDynamicTable :: DynamicTable
, decodeDynamicTable :: DynamicTable
, -- the connection window for sending data
txFlow :: TVar TxFlow
, rxFlow :: IORef RxFlow
, pingRate :: Rate
, settingsRate :: Rate
, emptyFrameRate :: Rate
, rstRate :: Rate
, mySockAddr :: SockAddr
, peerSockAddr :: SockAddr
, threadManager :: T.ThreadManager
}
{- FOURMOLU_ENABLE -}
----------------------------------------------------------------
{- FOURMOLU_DISABLE -}
newContext
:: RoleInfo
-> Config
-> Int
-> Int
-> Settings
-> T.Manager
-> IO Context
newContext roleInfo Config{..} cacheSiz connRxWS mySettings timmgr = do
-- My: Use this even if ack has not been received yet.
myFirstSettings <- newIORef False
-- Peer: The spec defines max concurrency is infinite unless
-- SETTINGS_MAX_CONCURRENT_STREAMS is exchanged.
-- But it is vulnerable, so we set the limitations.
peerSettings <-
newIORef baseSettings{maxConcurrentStreams = Just defaultMaxStreams}
oddStreamTable <- newTVarIO emptyOddStreamTable
evenStreamTable <- newTVarIO (emptyEvenStreamTable cacheSiz)
continued <- newIORef Nothing
myStreamId <- newTVarIO sid0
peerStreamId <- newIORef 0
outputBufferLimit <- newIORef buflim
outputQ <- newTQueueIO
outputQStreamID <- newTVarIO sid0
controlQ <- newTQueueIO
-- My SETTINGS_HEADER_TABLE_SIZE
encodeDynamicTable <- newDynamicTableForEncoding defaultDynamicTableSize
decodeDynamicTable <-
newDynamicTableForDecoding (headerTableSize mySettings) 4096
txFlow <- newTVarIO (newTxFlow defaultWindowSize) -- 64K
rxFlow <- newIORef (newRxFlow connRxWS)
pingRate <- newRate
settingsRate <- newRate
emptyFrameRate <- newRate
rstRate <- newRate
let mySockAddr = confMySockAddr
let peerSockAddr = confPeerSockAddr
threadManager <- T.newThreadManager timmgr
return Context{..}
where
role = case roleInfo of
RIC{} -> Client
_ -> Server
sid0
| role == Client = 1
| otherwise = 2
dlim = defaultPayloadLength + frameHeaderLength
buflim
| confBufferSize >= dlim = dlim
| otherwise = confBufferSize
{- FOURMOLU_ENABLE -}
----------------------------------------------------------------
isClient :: Context -> Bool
isClient ctx = role ctx == Client
isServer :: Context -> Bool
isServer ctx = role ctx == Server
----------------------------------------------------------------
getMyNewStreamId :: Context -> STM StreamId
getMyNewStreamId Context{..} = do
n <- readTVar myStreamId
let n' = n + 2
writeTVar myStreamId n'
return n
getPeerStreamID :: Context -> IO StreamId
getPeerStreamID ctx = readIORef $ peerStreamId ctx
setPeerStreamID :: Context -> StreamId -> IO ()
setPeerStreamID ctx sid = writeIORef (peerStreamId ctx) sid
----------------------------------------------------------------
{-# INLINE setStreamState #-}
setStreamState :: Context -> Stream -> StreamState -> IO ()
setStreamState _ Stream{streamState} newState = do
oldState <- readIORef streamState
case (oldState, newState) of
(Open _ (Body q _ _ _), Open _ (Body q' _ _ _))
| q == q' ->
-- The stream stays open with the same body; nothing to do
return ()
(Open _ (Body q _ _ _), _) ->
-- The stream is either closed, or is open with a /new/ body
-- We need to close the old queue so that any reads from it won't block
atomically $ writeTQueue q $ Left $ toException ConnectionIsClosed
_otherwise ->
-- The stream wasn't open to start with; nothing to do
return ()
writeIORef streamState newState
opened :: Context -> Stream -> IO ()
opened ctx strm = setStreamState ctx strm (Open Nothing JustOpened)
halfClosedRemote :: Context -> Stream -> IO ()
halfClosedRemote ctx stream@Stream{streamState} = do
closingCode <- atomicModifyIORef streamState closeHalf
traverse_ (closed ctx stream) closingCode
where
closeHalf :: StreamState -> (StreamState, Maybe ClosedCode)
closeHalf x@(Closed _) = (x, Nothing)
closeHalf (Open (Just cc) _) = (Closed cc, Just cc)
closeHalf _ = (HalfClosedRemote, Nothing)
halfClosedLocal :: Context -> Stream -> ClosedCode -> IO ()
halfClosedLocal ctx stream@Stream{streamState} cc = do
shouldFinalize <- atomicModifyIORef streamState closeHalf
when shouldFinalize $
closed ctx stream cc
where
closeHalf :: StreamState -> (StreamState, Bool)
closeHalf x@(Closed _) = (x, False)
closeHalf HalfClosedRemote = (Closed cc, True)
closeHalf (Open Nothing o) = (Open (Just cc) o, False)
closeHalf _ = (Open (Just cc) JustOpened, False)
closed :: Context -> Stream -> ClosedCode -> IO ()
closed ctx@Context{oddStreamTable, evenStreamTable} strm@Stream{streamNumber} cc = do
if isServerInitiated streamNumber
then deleteEven evenStreamTable streamNumber err
else deleteOdd oddStreamTable streamNumber err
setStreamState ctx strm (Closed cc) -- anyway
where
err :: SomeException
err = toException (closedCodeToError streamNumber cc)
----------------------------------------------------------------
-- From peer
-- Server
openOddStreamCheck :: Context -> StreamId -> FrameType -> IO Stream
openOddStreamCheck ctx@Context{oddStreamTable, peerSettings, mySettings} sid ftyp = do
-- My SETTINGS_MAX_CONCURRENT_STREAMS
when (ftyp == FrameHeaders) $ do
conc <- getOddConcurrency oddStreamTable
checkMyConcurrency sid mySettings (conc + 1)
txws <- initialWindowSize <$> readIORef peerSettings
let rxws = initialWindowSize mySettings
newstrm <- newOddStream sid txws rxws
when (ftyp == FrameHeaders || ftyp == FramePushPromise) $ opened ctx newstrm
insertOdd oddStreamTable sid newstrm
return newstrm
-- Client
openEvenStreamCacheCheck :: Context -> StreamId -> Method -> ByteString -> IO ()
openEvenStreamCacheCheck Context{evenStreamTable, peerSettings, mySettings} sid method path = do
-- My SETTINGS_MAX_CONCURRENT_STREAMS
conc <- getEvenConcurrency evenStreamTable
checkMyConcurrency sid mySettings (conc + 1)
txws <- initialWindowSize <$> readIORef peerSettings
let rxws = initialWindowSize mySettings
newstrm <- newEvenStream sid txws rxws
insertEvenCache evenStreamTable method path newstrm
checkMyConcurrency
:: StreamId -> Settings -> Int -> IO ()
checkMyConcurrency sid settings conc = do
let mMaxConc = maxConcurrentStreams settings
case mMaxConc of
Nothing -> return ()
Just maxConc ->
when (conc > maxConc) $
E.throwIO $
StreamErrorIsSent RefusedStream sid "exceeds max concurrent"
----------------------------------------------------------------
-- From me
-- Clinet
openOddStreamWait :: Context -> IO (StreamId, Stream)
openOddStreamWait ctx@Context{oddStreamTable, mySettings, peerSettings} = do
-- Peer SETTINGS_MAX_CONCURRENT_STREAMS
mMaxConc <- maxConcurrentStreams <$> readIORef peerSettings
let rxws = initialWindowSize mySettings
case mMaxConc of
Nothing -> do
sid <- atomically $ getMyNewStreamId ctx
txws <- initialWindowSize <$> readIORef peerSettings
newstrm <- newOddStream sid txws rxws
insertOdd oddStreamTable sid newstrm
return (sid, newstrm)
Just maxConc -> do
sid <- atomically $ do
waitIncOdd oddStreamTable maxConc
getMyNewStreamId ctx
txws <- initialWindowSize <$> readIORef peerSettings
newstrm <- newOddStream sid txws rxws
insertOdd' oddStreamTable sid newstrm
return (sid, newstrm)
-- Server
openEvenStreamWait :: Context -> IO (StreamId, Stream)
openEvenStreamWait ctx@Context{..} = do
-- Peer SETTINGS_MAX_CONCURRENT_STREAMS
mMaxConc <- maxConcurrentStreams <$> readIORef peerSettings
let rxws = initialWindowSize mySettings
case mMaxConc of
Nothing -> do
sid <- atomically $ getMyNewStreamId ctx
txws <- initialWindowSize <$> readIORef peerSettings
newstrm <- newEvenStream sid txws rxws
insertEven evenStreamTable sid newstrm
return (sid, newstrm)
Just maxConc -> do
sid <- atomically $ do
waitIncEven evenStreamTable maxConc
getMyNewStreamId ctx
txws <- initialWindowSize <$> readIORef peerSettings
newstrm <- newEvenStream sid txws rxws
insertEven' evenStreamTable sid newstrm
return (sid, newstrm)
|