Support leios-late-ib-inclusion

Author: nfrisby

data/simulation/config.d.ts

@@ -39,10 +39,10 @@ export interface Config {
    * Only supported by Haskell simulation. */
   "leios-vote-send-recv-stages": boolean;
   /**
-   * Extends Leios so that EB producers include IBs directly from previous pipelines
-   * where no certified EB was observed.
-   * 
-   * Only supported by Rust simulation. */
+   * Extends Leios so that EB producers include IBs directly from previous pipelines.
+   * Due to casuality, the EB must always include them, even if those IBs end up being
+   * certified in their own pipeline.
+   */
   "leios-late-ib-inclusion": boolean;
   /**
    * The expected time it takes a header to fully diffuse across the network.

data/simulation/variants/config.full.yaml

@@ -4,7 +4,7 @@ leios-variant: full
 # "Random" is meant to ensure that different producers include different TXs.
 leios-mempool-sampling-strategy: random
 
-# Allow EBs to include IBs from previous slots
+# Allow EBs to include IBs from previous pipelines
 leios-late-ib-inclusion: true
 
 # Chain quality controls how far back EB recursion can reach.

leios-trace-hs/src/LeiosConfig.hs

@@ -99,6 +99,7 @@ data Config = Config
   , leiosStageActiveVotingSlots :: Word
   , leiosVoteSendRecvStages :: Bool
   , leiosVariant :: LeiosVariant
+  , leiosLateIbInclusion :: Bool
   , leiosHeaderDiffusionTimeMs :: DurationMs
   , praosChainQuality :: Double
   , txGenerationDistribution :: Distribution
@@ -171,6 +172,7 @@ instance Default Config where
       , leiosStageActiveVotingSlots = 1
       , leiosVoteSendRecvStages = False
       , leiosVariant = Short
+      , leiosLateIbInclusion = True
       , leiosHeaderDiffusionTimeMs = 1000
       , praosChainQuality = 40
       , txGenerationDistribution = Exp{lambda = 0.85, scale = Just 1000}
@@ -243,6 +245,7 @@ configToKVsWith getter cfg =
     , get @"treatBlocksAsFull" getter cfg
     , get @"cleanupPolicies" getter cfg
     , get @"leiosVariant" getter cfg
+    , get @"leiosLateIbInclusion" getter cfg
     , get @"leiosHeaderDiffusionTimeMs" getter cfg
     , get @"praosChainQuality" getter cfg
     , get @"simulateTransactions" getter cfg
@@ -329,6 +332,7 @@ instance FromJSON Config where
     treatBlocksAsFull <- parseFieldOrDefault @Config @"treatBlocksAsFull" obj
     cleanupPolicies <- parseFieldOrDefault @Config @"cleanupPolicies" obj
     leiosVariant <- parseFieldOrDefault @Config @"leiosVariant" obj
+    leiosLateIbInclusion <- parseFieldOrDefault @Config @"leiosLateIbInclusion" obj
     leiosHeaderDiffusionTimeMs <- parseFieldOrDefault @Config @"leiosHeaderDiffusionTimeMs" obj
     praosChainQuality <- parseFieldOrDefault @Config @"praosChainQuality" obj
     simulateTransactions <- parseFieldOrDefault @Config @"simulateTransactions" obj

leios-trace-verifier/hs-src/test/Spec/Scenario.hs

@@ -19,7 +19,7 @@ import qualified Data.Map.Strict as M
 import qualified Data.Set as S
 
 config :: Config
-config = Config{relayStrategy = RequestFromFirst, tcpCongestionControl = True, multiplexMiniProtocols = True, treatBlocksAsFull = False, cleanupPolicies = CleanupPolicies (S.fromList [CleanupExpiredVote]), simulateTransactions = True, leiosStageLengthSlots = 2, leiosStageActiveVotingSlots = 1, leiosVoteSendRecvStages = False, leiosVariant = Short, leiosHeaderDiffusionTimeMs = 1000.0, praosChainQuality = 20.0, txGenerationDistribution = Exp{lambda = 0.85, scale = pure 1000.0}, txSizeBytesDistribution = LogNormal{mu = 6.833, sigma = 1.127}, txValidationCpuTimeMs = 1.5, txMaxSizeBytes = 16384, rbGenerationProbability = 5.0e-2, rbGenerationCpuTimeMs = 1.0, rbHeadValidationCpuTimeMs = 1.0, rbHeadSizeBytes = 1024, rbBodyMaxSizeBytes = 90112, rbBodyLegacyPraosPayloadValidationCpuTimeMsConstant = 50.0, rbBodyLegacyPraosPayloadValidationCpuTimeMsPerByte = 5.0e-4, rbBodyLegacyPraosPayloadAvgSizeBytes = 0, ibGenerationProbability = 5.0, ibGenerationCpuTimeMs = 130.0, ibHeadSizeBytes = 304, ibHeadValidationCpuTimeMs = 1.0, ibBodyValidationCpuTimeMsConstant = 50.0, ibBodyValidationCpuTimeMsPerByte = 5.0e-4, ibBodyMaxSizeBytes = 327680, ibBodyAvgSizeBytes = 98304, ibDiffusionStrategy = FreshestFirst, ibDiffusionMaxWindowSize = 100, ibDiffusionMaxHeadersToRequest = 100, ibDiffusionMaxBodiesToRequest = 1, ibShards = 50, ebGenerationProbability = 1.5, ebGenerationCpuTimeMs = 75.0, ebValidationCpuTimeMs = 1.0, ebSizeBytesConstant = 240, ebSizeBytesPerIb = 32, ebDiffusionStrategy = PeerOrder, ebDiffusionMaxWindowSize = 100, ebDiffusionMaxHeadersToRequest = 100, ebDiffusionMaxBodiesToRequest = 1, ebMaxAgeSlots = 100, ebMaxAgeForRelaySlots = 40, voteGenerationProbability = 500.0, voteGenerationCpuTimeMsConstant = 0.164, voteGenerationCpuTimeMsPerIb = 0.0, voteValidationCpuTimeMs = 0.816, voteThreshold = 300, voteBundleSizeBytesConstant = 0, voteBundleSizeBytesPerEb = 105, voteDiffusionStrategy = PeerOrder, voteDiffusionMaxWindowSize = 100, voteDiffusionMaxHeadersToRequest = 100, voteDiffusionMaxBodiesToRequest = 1, certGenerationCpuTimeMsConstant = 90.0, certGenerationCpuTimeMsPerNode = 0.0, certValidationCpuTimeMsConstant = 130.0, certValidationCpuTimeMsPerNode = 0.0, certSizeBytesConstant = 7168, certSizeBytesPerNode = 0}
+config = Config{relayStrategy = RequestFromFirst, tcpCongestionControl = True, multiplexMiniProtocols = True, treatBlocksAsFull = False, cleanupPolicies = CleanupPolicies (S.fromList [CleanupExpiredVote]), simulateTransactions = True, leiosStageLengthSlots = 2, leiosStageActiveVotingSlots = 1, leiosVoteSendRecvStages = False, leiosVariant = Short, leiosLateIbInclusion = False, leiosHeaderDiffusionTimeMs = 1000.0, praosChainQuality = 20.0, txGenerationDistribution = Exp{lambda = 0.85, scale = pure 1000.0}, txSizeBytesDistribution = LogNormal{mu = 6.833, sigma = 1.127}, txValidationCpuTimeMs = 1.5, txMaxSizeBytes = 16384, rbGenerationProbability = 5.0e-2, rbGenerationCpuTimeMs = 1.0, rbHeadValidationCpuTimeMs = 1.0, rbHeadSizeBytes = 1024, rbBodyMaxSizeBytes = 90112, rbBodyLegacyPraosPayloadValidationCpuTimeMsConstant = 50.0, rbBodyLegacyPraosPayloadValidationCpuTimeMsPerByte = 5.0e-4, rbBodyLegacyPraosPayloadAvgSizeBytes = 0, ibGenerationProbability = 5.0, ibGenerationCpuTimeMs = 130.0, ibHeadSizeBytes = 304, ibHeadValidationCpuTimeMs = 1.0, ibBodyValidationCpuTimeMsConstant = 50.0, ibBodyValidationCpuTimeMsPerByte = 5.0e-4, ibBodyMaxSizeBytes = 327680, ibBodyAvgSizeBytes = 98304, ibDiffusionStrategy = FreshestFirst, ibDiffusionMaxWindowSize = 100, ibDiffusionMaxHeadersToRequest = 100, ibDiffusionMaxBodiesToRequest = 1, ibShards = 50, ebGenerationProbability = 1.5, ebGenerationCpuTimeMs = 75.0, ebValidationCpuTimeMs = 1.0, ebSizeBytesConstant = 240, ebSizeBytesPerIb = 32, ebDiffusionStrategy = PeerOrder, ebDiffusionMaxWindowSize = 100, ebDiffusionMaxHeadersToRequest = 100, ebDiffusionMaxBodiesToRequest = 1, ebMaxAgeSlots = 100, ebMaxAgeForRelaySlots = 40, voteGenerationProbability = 500.0, voteGenerationCpuTimeMsConstant = 0.164, voteGenerationCpuTimeMsPerIb = 0.0, voteValidationCpuTimeMs = 0.816, voteThreshold = 300, voteBundleSizeBytesConstant = 0, voteBundleSizeBytesPerEb = 105, voteDiffusionStrategy = PeerOrder, voteDiffusionMaxWindowSize = 100, voteDiffusionMaxHeadersToRequest = 100, voteDiffusionMaxBodiesToRequest = 1, certGenerationCpuTimeMsConstant = 90.0, certGenerationCpuTimeMsPerNode = 0.0, certValidationCpuTimeMsConstant = 130.0, certValidationCpuTimeMsPerNode = 0.0, certSizeBytesConstant = 7168, certSizeBytesPerNode = 0}
 
 topology :: Topology 'COORD2D
 topology = Topology{nodes = M.fromList [(NodeName "node-0", Node{nodeInfo = NodeInfo{stake = 500, cpuCoreCount = CpuCoreCount mzero, location = LocCoord2D{coord2D = Point{_1 = 0.12000040231003672, _2 = 0.1631004621065356}}, adversarial = mzero}, producers = M.fromList [(NodeName "node-1", LinkInfo{latencyMs = 141.01364015418432, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000}), (NodeName "node-2", LinkInfo{latencyMs = 254.6249782835189, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000})]}), (NodeName "node-1", Node{nodeInfo = NodeInfo{stake = 200, cpuCoreCount = CpuCoreCount mzero, location = LocCoord2D{coord2D = Point{_1 = 0.34276660615051174, _2 = 0.2636899791034371}}, adversarial = mzero}, producers = M.fromList [(NodeName "node-2", LinkInfo{latencyMs = 175.32530255486685, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000}), (NodeName "node-3", LinkInfo{latencyMs = 379.1167948193313, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000})]}), (NodeName "node-2", Node{nodeInfo = NodeInfo{stake = 100, cpuCoreCount = CpuCoreCount mzero, location = LocCoord2D{coord2D = Point{_1 = 0.5150493264153491, _2 = 0.27873594531347595}}, adversarial = mzero}, producers = M.fromList [(NodeName "node-3", LinkInfo{latencyMs = 248.31457793649423, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000})]}), (NodeName "node-3", Node{nodeInfo = NodeInfo{stake = 0, cpuCoreCount = CpuCoreCount mzero, location = LocCoord2D{coord2D = Point{_1 = 0.3503537969220088, _2 = 0.13879558055660354}}, adversarial = mzero}, producers = M.fromList [(NodeName "node-0", LinkInfo{latencyMs = 140.19739576271448, bandwidthBytesPerSecond = BandwidthBps $ pure 1024000})]})]}

simulation/ouroboros-leios-sim.cabal

@@ -218,6 +218,7 @@ test-suite ols-test
     , bytestring
   other-modules:
     Paths_ouroboros_leios_sim
-    Test.Topology
     Test.Config
+    Test.ShortToFull
+    Test.Topology
   default-language: Haskell2010

simulation/src/LeiosProtocol/Relay.hs

@@ -498,7 +498,7 @@ data SubmitPolicy = SubmitInOrder | SubmitAll
 
 data RelayConsumerConfig id header body m = RelayConsumerConfig
   { relay :: !RelayConfig
-  , shouldIgnore :: m (header -> Bool)
+  , shouldNotRequest :: m (header -> Bool)
   -- ^ headers to ignore, e.g. already received or coming too late.
   , validateHeaders :: [header] -> m ()
   , headerId :: !(header -> id)
@@ -761,7 +761,7 @@ relayConsumerPipelined config sst =
     if (min (Map.size lst0.available) (fromIntegral config.maxBodiesToRequest)) == 0
       then return (Left lst0)
       else return . Right . TS.Effect $ do
-        isIgnored <- config.shouldIgnore
+        isIgnored <- config.shouldNotRequest
         atomically $ do
           -- New headers are filtered before becoming available, but we have
           -- to filter `lst.available` again in the same STM tx that sets them as
@@ -987,7 +987,7 @@ relayConsumerPipelined config sst =
     m (RelayConsumerLocalState id header body n)
   acknowledgeIds lst idsSeq _ | Seq.null idsSeq = pure lst
   acknowledgeIds lst idsSeq idsMap = do
-    isIgnored <- config.shouldIgnore
+    isIgnored <- config.shouldNotRequest
     inFlight <- readTVarIO sst.inFlightVar
 
     let lst1 =

simulation/src/LeiosProtocol/Short.hs

@@ -111,6 +111,10 @@ data LeiosConfig = forall p. IsPipeline p => LeiosConfig
   , variant :: LeiosVariant
   , headerDiffusionTime :: NominalDiffTime
   -- ^ Δ_{hdr}.
+  , lateIbInclusion :: Bool
+  -- ^ Whether an EB also includes IBs from the two previous iterations.
+  --
+  -- TODO Merely one previous iteration if 'pipeline' is 'SingleVote'?
   , pipelinesToReferenceFromEB :: Int
   -- ^ how many older pipelines to reference from an EB when `variant = Full`.
   , votingFrequencyPerStage :: Double
@@ -147,6 +151,7 @@ convertConfig disk =
           , cleanupPolicies = disk.cleanupPolicies
           , variant = disk.leiosVariant
           , headerDiffusionTime = realToFrac $ durationMsToDiffTime disk.leiosHeaderDiffusionTimeMs
+          , lateIbInclusion = disk.leiosLateIbInclusion
           , pipelinesToReferenceFromEB =
               if disk.leiosVariant == Full
                 then
@@ -285,6 +290,7 @@ delaysAndSizesAsFull cfg@LeiosConfig{pipeline, voteSendStage} =
     , cleanupPolicies = cfg.cleanupPolicies
     , variant = cfg.variant
     , headerDiffusionTime = cfg.headerDiffusionTime
+    , lateIbInclusion = cfg.lateIbInclusion
     , pipelinesToReferenceFromEB = cfg.pipelinesToReferenceFromEB
     , activeVotingStageLength = cfg.activeVotingStageLength
     , votingFrequencyPerStage = cfg.votingFrequencyPerStage
@@ -461,21 +467,38 @@ isStage cfg stage slot = fromEnum slot >= cfg.sliceLength * fromEnum stage
 newtype PipelineNo = PipelineNo Word64
   deriving (Bounded, Enum, Show, Eq, Ord)
 
+pipelineMonus :: PipelineNo -> Word64 -> PipelineNo
+pipelineMonus (PipelineNo w) i = PipelineNo $ w - min w i
+
 stageRangeOf :: forall p. IsPipeline p => LeiosConfig -> PipelineNo -> Stage p -> (SlotNo, SlotNo)
 stageRangeOf cfg pl stage =
   fromMaybe
     undefined
     (stageRange cfg minBound (toEnum (fromEnum pl * cfg.sliceLength)) stage)
 
+-- | WARNING This fails if the slot is earlier than the beginning of the stage
+-- in the first iteration (ie @'PipelineNo' 0@)
 pipelineOf :: forall p. IsPipeline p => LeiosConfig -> Stage p -> SlotNo -> PipelineNo
 pipelineOf cfg stage sl =
-  toEnum $
-    fromMaybe undefined (fromEnum <$> stageStart cfg stage sl minBound)
-      `div` cfg.sliceLength
+  maybe err cnv $ stageStart cfg stage sl minBound
+ where
+  cnv = toEnum . (`div` cfg.sliceLength) . fromEnum
+
+  err = error $ show (cfg.sliceLength, x, stage, sl)
+
+  x :: String
+  x = case cfg of
+    LeiosConfig{pipeline} -> case pipeline of
+      SingSingleVote -> "SingleVote"
+      SingSplitVote -> "SplitVote"
 
 forEachPipeline :: (forall p. Stage p) -> (forall p. IsPipeline p => Stage p -> a) -> [a]
 forEachPipeline s k = [k @SingleVote s, k @SplitVote s]
 
+lastEndorse :: LeiosConfig -> PipelineNo -> SlotNo
+lastEndorse leios@LeiosConfig{pipeline = _ :: SingPipeline p} pipelineNo =
+  snd $ stageRangeOf @p leios pipelineNo Endorse
+
 lastVoteSend :: LeiosConfig -> PipelineNo -> SlotNo
 lastVoteSend leios@LeiosConfig{pipeline} pipelineNo = case pipeline of
   SingSingleVote -> snd (stageRangeOf leios pipelineNo Vote)
@@ -657,28 +680,76 @@ data EndorseBlocksSnapshot = EndorseBlocksSnapshot
   , certifiedEndorseBlocks :: (PipelineNo, PipelineNo) -> [(PipelineNo, [(EndorseBlock, Certificate, UTCTime)])]
   }
 
+-- | In which contemporary stage was an IB delivered
+--
+-- IBs cannot be deliver earlier than any of these options, due to the
+-- 'LeiosProtocol.Relay.shouldNotRequest' logic of the
+-- 'LeiosProtocol.Short.Node.relayIBState'.
+--
+-- IBs that are delivered later than any of these options are discarded,
+-- ignored.
+data IbDeliveryStage
+  = -- | The node will not vote for an EB that excludes IBs that arrived during
+    -- Propose or Deliver1.
+    --
+    -- The node will include IBs that arrived during Propose or Deliver1 in an
+    -- EB it makes.
+    IbDuringProposeOrDeliver1
+  | -- | The node will include IBs that arrived during Deliver2 in an EB it makes.
+    IbDuringDeliver2
+  | -- | The node will not vote for an EB that includes IBs that arrived later
+    -- than Endorse.
+    IbDuringEndorse
+  deriving (Bounded, Enum, Eq, Ord, Show)
+
 -- | Both constraints are inclusive.
 data InputBlocksQuery = InputBlocksQuery
-  { generatedBetween :: (SlotNo, SlotNo)
-  , receivedBy :: SlotNo
+  { generatedBetween :: (PipelineNo, PipelineNo)
+  , receivedBy :: IbDeliveryStage
   -- ^ This is checked against time the body is downloaded, before validation.
   }
 
+ibWasDeliveredLate :: LeiosConfig -> SlotConfig -> SlotNo -> UTCTime -> Bool
+ibWasDeliveredLate cfg slotCfg sl deliveryTime =
+  case ibDeliveryStage cfg slotCfg sl deliveryTime of
+    Nothing -> True
+    Just{} -> False
+
+ibDeliveryStage :: LeiosConfig -> SlotConfig -> SlotNo -> UTCTime -> Maybe IbDeliveryStage
+ibDeliveryStage
+  cfg@LeiosConfig{pipeline = _ :: SingPipeline p}
+  slotCfg
+  ibSlot
+  deliveryTime
+    | before loPropose = Nothing -- TODO future blocks?
+    | before loDeliver2 = Just IbDuringProposeOrDeliver1
+    | before loEndorse = Just IbDuringDeliver2
+    | before (succ hiEndorse) = Just IbDuringEndorse
+    | otherwise = Nothing -- TODO late blocks?
+   where
+    p = pipelineOf @p cfg Propose ibSlot
+
+    before sl = deliveryTime < slotTime slotCfg sl
+
+    (loPropose, _) = stageRangeOf @p cfg p Propose
+    (loDeliver2, _) = stageRangeOf @p cfg p Deliver2
+    (loEndorse, hiEndorse) = stageRangeOf @p cfg p Endorse
+
 inputBlocksToEndorse ::
   LeiosConfig ->
   -- | current slot
   SlotNo ->
   InputBlocksSnapshot ->
   [InputBlockId]
-inputBlocksToEndorse cfg@LeiosConfig{pipeline = _ :: SingPipeline p} current buffer = fromMaybe [] $ do
-  generatedBetween <- stageRange @p cfg Endorse current Propose
-  receivedBy <- stageEnd @p cfg Endorse current Deliver2
-  pure $
-    buffer.validInputBlocks
-      InputBlocksQuery
-        { generatedBetween
-        , receivedBy
-        }
+inputBlocksToEndorse cfg@LeiosConfig{pipeline = _ :: SingPipeline p} current buffer =
+  buffer.validInputBlocks
+    InputBlocksQuery
+      { generatedBetween = (lo, hi)
+      , receivedBy = IbDuringDeliver2
+      }
+ where
+  hi = pipelineOf @p cfg Endorse current
+  lo = if cfg.lateIbInclusion then pipelineMonus hi 2 else hi
 
 -- | Returns possible EBs to reference from current pipeline EB.
 endorseBlocksToReference ::
@@ -734,21 +805,24 @@ shouldVoteOnEB ::
 shouldVoteOnEB cfg@LeiosConfig{voteSendStage} _ slot _buffers _
   -- checks whether a pipeline has been started before.
   | Nothing <- stageRange cfg voteSendStage slot Propose = const False
-shouldVoteOnEB cfg@LeiosConfig{voteSendStage} slotConfig slot buffers ebuffers = cond
+shouldVoteOnEB cfg@LeiosConfig{voteSendStage = voteSendStage :: Stage p} slotConfig slot buffers ebuffers = cond
  where
-  generatedBetween = fromMaybe (error "impossible") $ stageRange cfg voteSendStage slot Propose
+  generatedBetween = (lo, hi)
+   where
+    hi = pipelineOf @p cfg voteSendStage slot
+    lo = if cfg.lateIbInclusion then pipelineMonus hi 2 else hi
   receivedByEndorse =
     buffers.validInputBlocks
       InputBlocksQuery
         { generatedBetween
-        , receivedBy = fromMaybe (error "impossible") $ stageEnd cfg voteSendStage slot Endorse
+        , receivedBy = IbDuringEndorse
         }
   receivedByDeliver1 = buffers.validInputBlocks q
    where
     q =
       InputBlocksQuery
         { generatedBetween
-        , receivedBy = fromMaybe (error "impossible") $ stageEnd cfg voteSendStage slot Deliver1
+        , receivedBy = IbDuringProposeOrDeliver1
         }
   -- Order of references in EndorseBlock matters for ledger state, so we stick to lists.
   -- Note: maybe order on (slot, subSlot, vrf proof) should be used instead?