renamed ForkPolicy configuration option as ResponderCoreAffinityPolicy

Author: coot

cardano-node/src/Cardano/Node/Configuration/POM.hs

@@ -12,7 +12,7 @@
 
 module Cardano.Node.Configuration.POM
   ( NodeConfiguration (..)
-  , NCForkPolicy (..)
+  , ResponderCoreAffinityPolicy (..)
   , NetworkP2PMode (..)
   , SomeNetworkP2PMode (..)
   , PartialNodeConfiguration(..)
@@ -46,7 +46,7 @@ import qualified Ouroboros.Consensus.Node as Consensus (NetworkP2PMode (..))
 import           Ouroboros.Consensus.Node.Genesis (GenesisConfig, GenesisConfigFlags,
                    defaultGenesisConfigFlags, mkGenesisConfig)
 import qualified Ouroboros.Network.Diffusion.Configuration as Ouroboros
-import           Ouroboros.Network.Mux (ForkPolicy, noBindForkPolicy, responderForkPolicy)
+import qualified Ouroboros.Network.Mux as Mux
 import qualified Ouroboros.Network.PeerSelection.Governor as PeerSelection
 import           Ouroboros.Consensus.Storage.LedgerDB.Args (QueryBatchSize (..))
 import           Ouroboros.Consensus.Storage.LedgerDB.Snapshots (NumOfDiskSnapshots (..),
@@ -197,20 +197,22 @@ data NodeConfiguration
          -- Ouroboros Genesis
        , ncGenesisConfig :: GenesisConfig
 
-       , ncForkPolicy :: NCForkPolicy
+       , ncResponderCoreAffinityPolicy :: ResponderCoreAffinityPolicy
        } deriving (Eq, Show)
 
 -- | We expose the `Ouroboros.Network.Mux.ForkPolicy` as a `NodeConfiguration` field.
--- * `NoBindForkPolicy` corresponds to `Ouroboros.Network.Mux.noBindForkPolicy`
--- * `ResponderForkPolicy` corresponds to `Ouroboros.Network.Mux.responderForkPolicy`
---   with a `randomIO` generated salt and `getNumCapabilities`
-data NCForkPolicy = NoBindForkPolicy | ResponderForkPolicy deriving (Eq, Show, Generic, FromJSON)
+--
+-- * `NoResponderCoreAffinity` corresponds to `Ouroboros.Network.Mux.noBindForkPolicy`
+-- * `ResponderCoreAffinity` corresponds to `Ouroboros.Network.Mux.responderForkPolicy`
+--   with a `randomIO` generated salt and `getNumCapabilities`.
+--
+data ResponderCoreAffinityPolicy = NoResponderCoreAffinity | ResponderCoreAffinity deriving (Eq, Show, Generic, FromJSON)
 
 -- | Convert `NCForkPolicy` to a `Ouroboros.Network.Mux.ForkPolicy`
-getForkPolicy :: Hashable peerAddr => NCForkPolicy -> IO (ForkPolicy peerAddr)
+getForkPolicy :: Hashable peerAddr => ResponderCoreAffinityPolicy -> IO (Mux.ForkPolicy peerAddr)
 getForkPolicy = \case
-  NoBindForkPolicy -> pure noBindForkPolicy
-  ResponderForkPolicy -> responderForkPolicy <$> randomIO <*> getNumCapabilities
+  NoResponderCoreAffinity -> pure Mux.noBindForkPolicy
+  ResponderCoreAffinity -> Mux.responderForkPolicy <$> randomIO <*> getNumCapabilities
 
 data PartialNodeConfiguration
   = PartialNodeConfiguration
@@ -288,7 +290,7 @@ data PartialNodeConfiguration
          -- Ouroboros Genesis
        , pncGenesisConfigFlags :: !(Last GenesisConfigFlags)
 
-       , pncForkPolicy :: !(Last NCForkPolicy)
+       , pncResponderCoreAffinityPolicy :: !(Last ResponderCoreAffinityPolicy)
        } deriving (Eq, Generic, Show)
 
 instance AdjustFilePaths PartialNodeConfiguration where
@@ -398,7 +400,10 @@ instance FromJSON PartialNodeConfiguration where
       -- pncConsensusMode determines whether Genesis is enabled in the first place.
       pncGenesisConfigFlags <- Last <$> v .:? "LowLevelGenesisOptions"
 
-      pncForkPolicy <- Last <$> v .:? "ForkPolicy"
+      pncResponderCoreAffinityPolicy <-
+            (\a b -> Last a <> Last b)
+        <$> v .:? "ResponderCoreAffinityPolicy"
+        <*> v .:? "ForkPolicy" -- deprecated
 
       pure PartialNodeConfiguration {
              pncProtocolConfig
@@ -440,7 +445,7 @@ instance FromJSON PartialNodeConfiguration where
            , pncEnableP2P
            , pncPeerSharing
            , pncGenesisConfigFlags
-           , pncForkPolicy
+           , pncResponderCoreAffinityPolicy
            }
     where
       parseMempoolCapacityBytesOverride v = parseNoOverride <|> parseOverride
@@ -676,7 +681,7 @@ defaultPartialNodeConfiguration =
     , pncEnableP2P     = Last (Just EnabledP2PMode)
     , pncPeerSharing   = Last (Just Ouroboros.defaultPeerSharing)
     , pncGenesisConfigFlags = Last (Just defaultGenesisConfigFlags)
-    , pncForkPolicy = Last $ Just NoBindForkPolicy
+    , pncResponderCoreAffinityPolicy = Last $ Just NoResponderCoreAffinity
     }
   where
     PeerSelectionTargets {
@@ -783,7 +788,7 @@ makeNodeConfiguration pnc = do
       $ pncGenesisConfigFlags pnc
   let ncGenesisConfig = mkGenesisConfig mGenesisConfigFlags
 
-  ncForkPolicy <- lastToEither "Missing ForkPolicy" $ pncForkPolicy pnc
+  ncResponderCoreAffinityPolicy <- lastToEither "Missing ResponderCoreAffinityPolicy" $ pncResponderCoreAffinityPolicy pnc
 
   let deadlineTargets =
         PeerSelectionTargets {
@@ -864,7 +869,7 @@ makeNodeConfiguration pnc = do
              , ncPeerSharing
              , ncConsensusMode
              , ncGenesisConfig
-             , ncForkPolicy
+             , ncResponderCoreAffinityPolicy
              }
 
 ncProtocol :: NodeConfiguration -> Protocol

cardano-node/src/Cardano/Node/Parsers.hs

@@ -127,7 +127,7 @@ nodeRunParser = do
            , pncEnableP2P = mempty
            , pncPeerSharing = mempty
            , pncGenesisConfigFlags = mempty
-           , pncForkPolicy = mempty
+           , pncResponderCoreAffinityPolicy = mempty
            }
 
 parseSocketPath :: Text -> Parser SocketPath

cardano-node/src/Cardano/Node/Run.hs

@@ -547,8 +547,8 @@ handleSimpleNode blockType runP p2pMode tracers nc onKernel = do
               )
               Nothing
 #endif
-        nForkPolicy <- getForkPolicy $ ncForkPolicy nc
-        cForkPolicy <- getForkPolicy $ ncForkPolicy nc
+        nForkPolicy <- getForkPolicy $ ncResponderCoreAffinityPolicy nc
+        cForkPolicy <- getForkPolicy $ ncResponderCoreAffinityPolicy nc
         void $
           let diffusionArgumentsExtra =
                 mkP2PArguments nForkPolicy cForkPolicy nc

cardano-node/test/Test/Cardano/Node/POM.hs

@@ -164,7 +164,7 @@ testPartialYamlConfig =
     , pncPeerSharing = Last (Just PeerSharingDisabled)
     , pncConsensusMode = mempty
     , pncGenesisConfigFlags = mempty
-    , pncForkPolicy = mempty
+    , pncResponderCoreAffinityPolicy = mempty
     , pncLedgerDbConfig = mempty
     }
 
@@ -211,7 +211,7 @@ testPartialCliConfig =
     , pncPeerSharing = Last (Just PeerSharingDisabled)
     , pncConsensusMode = Last (Just PraosMode)
     , pncGenesisConfigFlags = mempty
-    , pncForkPolicy = mempty
+    , pncResponderCoreAffinityPolicy = mempty
     , pncLedgerDbConfig = mempty
     }