simulation: added OldestFirst, and {eb,vote}-diffusion-strategy to config

Author: Saizan

data/simulation/config.d.ts

@@ -40,6 +40,7 @@ export interface Config {
   "eb-validation-cpu-time-ms": number;
   "eb-size-bytes-constant": bigint;
   "eb-size-bytes-per-ib": bigint;
+  "eb-diffusion-strategy": DiffusionStrategy;
 
   // Vote Configuration
   "vote-generation-probability": number;
@@ -49,6 +50,7 @@ export interface Config {
   "vote-threshold": bigint;
   "vote-bundle-size-bytes-constant": bigint;
   "vote-bundle-size-bytes-per-eb": bigint;
+  "vote-diffusion-strategy": DiffusionStrategy;
 
   // deprecated:
   // "vote-one-eb-per-vrf-win": boolean;
@@ -94,5 +96,6 @@ export interface ConstantDistribution {
 export enum DiffusionStrategy {
   PeerOrder = "peer-order",
   FreshestFirst = "freshest-first",
+  OldestFirst = "oldest-first",
 }
 

data/simulation/config.default.yaml

@@ -72,6 +72,7 @@ eb-generation-cpu-time-ms: 300.0
 eb-validation-cpu-time-ms: 1.0
 eb-size-bytes-constant: 32
 eb-size-bytes-per-ib: 32
+eb-diffusion-strategy: "peer-order"
 
 ################################################################################
 # Vote Configuration
@@ -84,6 +85,7 @@ vote-validation-cpu-time-ms: 3.0
 vote-threshold: 150
 vote-bundle-size-bytes-constant: 32
 vote-bundle-size-bytes-per-eb: 32
+vote-diffusion-strategy: "peer-order"
 
 ################################################################################
 # Certificate Configuration

data/simulation/config.schema.json

@@ -14,7 +14,7 @@
       "type": "object"
     },
     "DiffusionStrategy": {
-      "enum": ["peer-order", "freshest-first"],
+      "enum": ["peer-order", "freshest-first", "oldest-first"],
       "type": "string"
     },
     "Distribution": {
@@ -103,6 +103,9 @@
     "cert-validation-cpu-time-ms-per-node": {
       "type": "number"
     },
+    "eb-diffusion-strategy": {
+      "$ref": "#/definitions/DiffusionStrategy"
+    },
     "eb-generation-cpu-time-ms": {
       "type": "number"
     },
@@ -222,6 +225,9 @@
       "properties": {},
       "type": "number"
     },
+    "vote-diffusion-strategy": {
+      "$ref": "#/definitions/DiffusionStrategy"
+    },
     "vote-generation-cpu-time-ms-constant": {
       "type": "number"
     },

simulation/src/LeiosProtocol/Config.hs

@@ -47,6 +47,8 @@ data DiffusionStrategy
     PeerOrder
   | -- | request message with highest slot
     FreshestFirst
+  | -- | request message with lowest slot
+    OldestFirst
   deriving (Show, Eq, Generic)
 
 data Config = Config
@@ -79,17 +81,17 @@ data Config = Config
   , ebValidationCpuTimeMs :: DurationMs
   , ebSizeBytesConstant :: SizeBytes
   , ebSizeBytesPerIb :: SizeBytes
-  , --  , ebDiffusionStrategy :: DiffusionStrategy -- TBD?
-    voteGenerationProbability :: Double
+  , ebDiffusionStrategy :: DiffusionStrategy
+  , voteGenerationProbability :: Double
   , voteGenerationCpuTimeMsConstant :: DurationMs
   , voteGenerationCpuTimeMsPerIb :: DurationMs
   , voteValidationCpuTimeMs :: DurationMs
   , voteThreshold :: Word
   , voteOneEbPerVrfWin :: Bool
   , voteBundleSizeBytesConstant :: SizeBytes
   , voteBundleSizeBytesPerEb :: SizeBytes
-  , --  , voteDiffusionStrategy :: DiffusionStrategy -- TBS?
-    certGenerationCpuTimeMsConstant :: DurationMs
+  , voteDiffusionStrategy :: DiffusionStrategy
+  , certGenerationCpuTimeMsConstant :: DurationMs
   , certGenerationCpuTimeMsPerNode :: DurationMs
   , certValidationCpuTimeMsConstant :: DurationMs
   , certValidationCpuTimeMsPerNode :: DurationMs
@@ -131,6 +133,7 @@ instance Default Config where
       , ebValidationCpuTimeMs = 1.0
       , ebSizeBytesConstant = 32
       , ebSizeBytesPerIb = 32
+      , ebDiffusionStrategy = PeerOrder
       , voteGenerationProbability = 500.0
       , voteGenerationCpuTimeMsConstant = 1.0
       , voteGenerationCpuTimeMsPerIb = 1.0
@@ -139,6 +142,7 @@ instance Default Config where
       , voteOneEbPerVrfWin = False
       , voteBundleSizeBytesConstant = 32
       , voteBundleSizeBytesPerEb = 32
+      , voteDiffusionStrategy = PeerOrder
       , certGenerationCpuTimeMsConstant = 50.0
       , certGenerationCpuTimeMsPerNode = 1.0
       , certValidationCpuTimeMsConstant = 50.0
@@ -247,6 +251,7 @@ instance FromJSON Config where
     ebValidationCpuTimeMs <- parseFieldOrDefault @Config @"ebValidationCpuTimeMs" obj
     ebSizeBytesConstant <- parseFieldOrDefault @Config @"ebSizeBytesConstant" obj
     ebSizeBytesPerIb <- parseFieldOrDefault @Config @"ebSizeBytesPerIb" obj
+    ebDiffusionStrategy <- parseFieldOrDefault @Config @"ebDiffusionStrategy" obj
     voteGenerationProbability <- parseFieldOrDefault @Config @"voteGenerationProbability" obj
     voteGenerationCpuTimeMsConstant <- parseFieldOrDefault @Config @"voteGenerationCpuTimeMsConstant" obj
     voteGenerationCpuTimeMsPerIb <- parseFieldOrDefault @Config @"voteGenerationCpuTimeMsPerIb" obj
@@ -255,6 +260,7 @@ instance FromJSON Config where
     voteOneEbPerVrfWin <- parseFieldOrDefault @Config @"voteOneEbPerVrfWin" obj
     voteBundleSizeBytesConstant <- parseFieldOrDefault @Config @"voteBundleSizeBytesConstant" obj
     voteBundleSizeBytesPerEb <- parseFieldOrDefault @Config @"voteBundleSizeBytesPerEb" obj
+    voteDiffusionStrategy <- parseFieldOrDefault @Config @"voteDiffusionStrategy" obj
     certGenerationCpuTimeMsConstant <- parseFieldOrDefault @Config @"certGenerationCpuTimeMsConstant" obj
     certGenerationCpuTimeMsPerNode <- parseFieldOrDefault @Config @"certGenerationCpuTimeMsPerNode" obj
     certValidationCpuTimeMsConstant <- parseFieldOrDefault @Config @"certValidationCpuTimeMsConstant" obj

simulation/src/LeiosProtocol/Short.hs

@@ -73,6 +73,7 @@ prioritize ::
   [header]
 prioritize PeerOrder _ = \_ hs -> hs
 prioritize FreshestFirst sl = \m _ -> sortOn (Down . sl) . Map.elems $ m
+prioritize OldestFirst sl = \m _ -> sortOn sl . Map.elems $ m
 
 data SingPipeline (p :: Pipeline) where
   SingSingleVote :: SingPipeline SingleVote
@@ -116,8 +117,8 @@ convertConfig disk =
     , sizes
     , delays
     , ibDiffusionStrategy = disk.ibDiffusionStrategy
-    , ebDiffusionStrategy = PeerOrder
-    , voteDiffusionStrategy = PeerOrder
+    , ebDiffusionStrategy = disk.ebDiffusionStrategy
+    , voteDiffusionStrategy = disk.voteDiffusionStrategy
     }
  where
   forEach n xs = n * fromIntegral (length xs)

simulation/src/LeiosProtocol/Short/Node.hs

@@ -9,6 +9,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE ViewPatterns #-}
+{-# LANGUAGE NoFieldSelectors #-}
 
 module LeiosProtocol.Short.Node where
 
@@ -22,6 +23,7 @@ import Control.Monad.Class.MonadAsync
 import Control.Monad.Class.MonadFork
 import Control.Monad.Class.MonadThrow
 import Control.Tracer
+import Data.Bifunctor
 import Data.Coerce (coerce)
 import Data.Foldable (forM_)
 import Data.Ix (Ix)
@@ -121,8 +123,8 @@ data LeiosNodeTask
   deriving (Eq, Ord, Ix, Bounded, Show)
 
 type RelayIBState = RelayConsumerSharedState InputBlockId InputBlockHeader InputBlockBody
-type RelayEBState = RelayConsumerSharedState EndorseBlockId EndorseBlockId EndorseBlock
-type RelayVoteState = RelayConsumerSharedState VoteId VoteId VoteMsg
+type RelayEBState = RelayConsumerSharedState EndorseBlockId (RelayHeader EndorseBlockId) EndorseBlock
+type RelayVoteState = RelayConsumerSharedState VoteId (RelayHeader VoteId) VoteMsg
 
 data LedgerState = LedgerState
 
@@ -136,9 +138,15 @@ data ValidationRequest m
 --- Messages
 --------------------------------------------------------------
 
+data RelayHeader id = RelayHeader {id :: !id, slot :: !SlotNo}
+  deriving (Show)
+
+instance MessageSize id => MessageSize (RelayHeader id) where
+  messageSizeBytes (RelayHeader x y) = messageSizeBytes x + messageSizeBytes y
+
 type RelayIBMessage = RelayMessage InputBlockId InputBlockHeader InputBlockBody
-type RelayEBMessage = RelayMessage EndorseBlockId EndorseBlockId EndorseBlock
-type RelayVoteMessage = RelayMessage VoteId VoteId VoteMsg
+type RelayEBMessage = RelayMessage EndorseBlockId (RelayHeader EndorseBlockId) EndorseBlock
+type RelayVoteMessage = RelayMessage VoteId (RelayHeader VoteId) VoteMsg
 type PraosMessage = PraosNode.PraosMessage RankingBlockBody
 
 data LeiosMessage
@@ -166,14 +174,14 @@ instance MuxBundle Leios where
   type MuxMsg Leios = LeiosMessage
   toFromMuxMsgBundle =
     Leios
-      { protocolIB = ToFromMuxMsg RelayIB fromRelayIB
-      , protocolEB = ToFromMuxMsg RelayEB fromRelayEB
-      , protocolVote = ToFromMuxMsg RelayVote fromRelayVote
+      { protocolIB = ToFromMuxMsg RelayIB (.fromRelayIB)
+      , protocolEB = ToFromMuxMsg RelayEB (.fromRelayEB)
+      , protocolVote = ToFromMuxMsg RelayVote (.fromRelayVote)
       , protocolPraos = case toFromMuxMsgBundle @(PraosNode.Praos RankingBlockBody) of
           PraosNode.Praos a b -> PraosNode.Praos (p >>> a) (p >>> b)
       }
    where
-    p = ToFromMuxMsg PraosMsg fromPraosMsg
+    p = ToFromMuxMsg PraosMsg (.fromPraosMsg)
 
   traverseMuxBundle f (Leios a b c d) = Leios <$> f a <*> f b <*> f c <*> traverseMuxBundle f d
 
@@ -230,35 +238,37 @@ relayEBConfig ::
   Tracer m LeiosNodeEvent ->
   LeiosNodeConfig ->
   SubmitBlocks m EndorseBlockId EndorseBlock ->
-  RelayConsumerConfig EndorseBlockId EndorseBlockId EndorseBlock m
+  RelayConsumerConfig EndorseBlockId (RelayHeader EndorseBlockId) EndorseBlock m
 relayEBConfig _tracer cfg submitBlocks =
   RelayConsumerConfig
     { relay = RelayConfig{maxWindowSize = 100}
-    , headerId = id
+    , headerId = (.id)
     , validateHeaders = const $ return ()
-    , prioritize = prioritize cfg.leios.ebDiffusionStrategy $ error "FFD not supported for endorse blocks."
+    , prioritize = prioritize cfg.leios.ebDiffusionStrategy (.slot)
     , submitPolicy = SubmitAll
     , maxHeadersToRequest = 100
     , maxBodiesToRequest = 1 -- should we chunk bodies here?
-    , submitBlocks
+    , submitBlocks = \hbs t k ->
+        submitBlocks (map (first (.id)) hbs) t (k . map (\(i, b) -> (RelayHeader i b.slot, b)))
     }
 
 relayVoteConfig ::
   MonadDelay m =>
   Tracer m LeiosNodeEvent ->
   LeiosNodeConfig ->
   SubmitBlocks m VoteId VoteMsg ->
-  RelayConsumerConfig VoteId VoteId VoteMsg m
+  RelayConsumerConfig VoteId (RelayHeader VoteId) VoteMsg m
 relayVoteConfig _tracer cfg submitBlocks =
   RelayConsumerConfig
     { relay = RelayConfig{maxWindowSize = 100}
-    , headerId = id
+    , headerId = (.id)
     , validateHeaders = const $ return ()
-    , prioritize = prioritize cfg.leios.voteDiffusionStrategy $ error "FFD not supported for vote bundles."
+    , prioritize = prioritize cfg.leios.voteDiffusionStrategy (.slot)
     , submitPolicy = SubmitAll
     , maxHeadersToRequest = 100
     , maxBodiesToRequest = 1 -- should we chunk bodies here?
-    , submitBlocks
+    , submitBlocks = \hbs t k ->
+        submitBlocks (map (first (.id)) hbs) t (k . map (\(i, b) -> (RelayHeader i b.slot, b)))
     }
 
 queueAndWait :: (MonadSTM m, MonadDelay m) => LeiosNodeState m -> LeiosNodeTask -> [CPUTask] -> m ()
@@ -337,29 +347,29 @@ leiosNode tracer cfg followers peers = do
       valHeaderRB
       submitRB
       praosState
-      (map protocolPraos followers)
-      (map protocolPraos peers)
+      (map (.protocolPraos) followers)
+      (map (.protocolPraos) peers)
 
   ibThreads <-
     setupRelay
       (relayIBConfig tracer cfg valHeaderIB submitIB)
       relayIBState
-      (map protocolIB followers)
-      (map protocolIB peers)
+      (map (.protocolIB) followers)
+      (map (.protocolIB) peers)
 
   ebThreads <-
     setupRelay
       (relayEBConfig tracer cfg submitEB)
       relayEBState
-      (map protocolEB followers)
-      (map protocolEB peers)
+      (map (.protocolEB) followers)
+      (map (.protocolEB) peers)
 
   voteThreads <-
     setupRelay
       (relayVoteConfig tracer cfg submitVote)
       relayVoteState
-      (map protocolVote followers)
-      (map protocolVote peers)
+      (map (.protocolVote) followers)
+      (map (.protocolVote) peers)
 
   let processWaitingForRB =
         processWaiting'
@@ -554,10 +564,10 @@ generator tracer cfg st = do
           atomically $ modifyTVar' st.relayIBState.relayBufferVar (RB.snoc ib.header.id (ib.header, ib.body))
           traceWith tracer (LeiosNodeEvent Generate (EventIB ib))
         SomeAction Generate.Endorse eb -> (GenEB,) $ do
-          atomically $ modifyTVar' st.relayEBState.relayBufferVar (RB.snoc eb.id (eb.id, eb))
+          atomically $ modifyTVar' st.relayEBState.relayBufferVar (RB.snoc eb.id (RelayHeader eb.id eb.slot, eb))
           traceWith tracer (LeiosNodeEvent Generate (EventEB eb))
         SomeAction Generate.Vote v -> (GenVote,) $ do
-          atomically $ modifyTVar' st.relayVoteState.relayBufferVar (RB.snoc v.id (v.id, v))
+          atomically $ modifyTVar' st.relayVoteState.relayBufferVar (RB.snoc v.id (RelayHeader v.id v.slot, v))
           traceWith tracer (LeiosNodeEvent Generate (EventVote v))
   let LeiosNodeConfig{..} = cfg
   leiosBlockGenerator $ LeiosGeneratorConfig{submit = mapM_ submitOne, ..}
@@ -620,6 +630,9 @@ mkBuffersView cfg st = BuffersView{..}
 
 mkSchedule :: MonadSTM m => LeiosNodeConfig -> m (SlotNo -> m [(SomeRole, Word64)])
 mkSchedule cfg = do
+  -- For each pipeline, we want to deploy all our votes in a single
+  -- message to cut down on traffic, so we pick one slot out of each
+  -- active voting range (they are assumed not to overlap).
   votingSlots <- newTVarIO $ pickFromRanges rng1 $ votingRanges cfg.leios
   mkScheduler rng2 (rates votingSlots)
  where