network-mux: removed MuxCleanShutdown

It is not a clean shutdown if mux stops while any mini-protocol is still runing.
IntersectMBO · May 8, 2021 · a1fb2ad · a1fb2ad
1 parent a6463e3
commit a1fb2ad
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/network-mux/src/Network/Mux.hs b/network-mux/src/Network/Mux.hs
@@ -696,9 +696,9 @@ runMiniProtocol Mux { muxMiniProtocols, muxControlCmdQueue , muxStatus}
       case st of
            MuxReady    -> readTMVar completionVar
            MuxStopping -> readTMVar completionVar
-                      <|> return (Left $ toException (MuxError MuxCleanShutdown "Mux stopped"))
+                      <|> return (Left $ toException (MuxError (MuxShutdown Nothing) "Mux stoping"))
            MuxStopped  -> readTMVar completionVar
-                      <|> return (Left $ toException (MuxError MuxCleanShutdown "Mux stopped"))
+                      <|> return (Left $ toException (MuxError (MuxShutdown Nothing) "Mux stopped"))
            MuxFailed e -> readTMVar completionVar
                       <|> return (Left $ toException $
                             case fromException e of

diff --git a/network-mux/src/Network/Mux/Trace.hs b/network-mux/src/Network/Mux/Trace.hs
@@ -64,9 +64,9 @@ data MuxErrorType = MuxUnknownMiniProtocol
                   | MuxSDUWriteTimeout
                   -- ^ thrown when writing a single SDU takes too long
                   | MuxShutdown !(Maybe MuxErrorType)
-                  -- ^ Result of runMiniProtocol's completionAction in case of an error.
-                  | MuxCleanShutdown
-                  -- ^ Mux stopped by 'stopMux'
+                  -- ^ Result of runMiniProtocol's completionAction in case of
+                  -- an error or mux being closed while a mini-protocol was
+                  -- still running, this is not a clean exit.
                   | MuxBlockedOnCompletionVar !MiniProtocolNum
                   -- ^  Mux blocked on @completionVar@.
                   deriving (Show, Eq)

diff --git a/ouroboros-network/src/Ouroboros/Network/NodeToClient.hs b/ouroboros-network/src/Ouroboros/Network/NodeToClient.hs
@@ -364,7 +364,6 @@ networkErrorPolicies = ErrorPolicies
                       MuxIngressQueueOverRun       -> Just ourBug
                       MuxInitiatorOnly             -> Just ourBug
                       MuxShutdown {}               -> Just ourBug
-                      MuxCleanShutdown             -> Just ourBug
                       MuxBlockedOnCompletionVar {} -> Just ourBug
 
                       -- in case of bearer closed / or IOException we suspend

diff --git a/ouroboros-network/src/Ouroboros/Network/NodeToNode.hs b/ouroboros-network/src/Ouroboros/Network/NodeToNode.hs
@@ -579,7 +579,6 @@ remoteNetworkErrorPolicy = ErrorPolicies {
                         MuxSDUReadTimeout            -> Just (SuspendPeer shortDelay shortDelay)
                         MuxSDUWriteTimeout           -> Just (SuspendPeer shortDelay shortDelay)
                         MuxShutdown {}               -> Just (SuspendPeer shortDelay shortDelay)
-                        MuxCleanShutdown             -> Just (SuspendPeer shortDelay shortDelay)
                         MuxBlockedOnCompletionVar {} -> Just (SuspendPeer shortDelay shortDelay)
 
           -- Error policy for TxSubmission protocol: outbound side (client role)