Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Storage.ImmutableDB.Chunks

Synopsis

data ChunkInfo = UniformChunkSize !ChunkSize
data ChunkNo
data ChunkSize = ChunkSize {
- chunkCanContainEBB ∷ !Bool
- numRegularBlocks ∷ !Word64
}
data RelativeSlot
data NextRelativeSlot
- = NextRelativeSlot RelativeSlot
- | NoMoreRelativeSlots
data ChunkSlot = UnsafeChunkSlot {
- chunkIndex ∷ !ChunkNo
- chunkRelative ∷ !RelativeSlot
}
pattern ChunkSlot ∷ ChunkNo → RelativeSlot → ChunkSlot
chunkInfoSupportsEBBs ∷ ChunkInfo → Bool
chunksBetween ∷ ChunkNo → ChunkNo → [ChunkNo]
compareRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → RelativeSlot → Ordering
countChunks ∷ ChunkNo → ChunkNo → Word64
firstChunkNo ∷ ChunkNo
getChunkSize ∷ ChunkInfo → ChunkNo → ChunkSize
mkRelativeSlot ∷ HasCallStack ⇒ ChunkInfo → ChunkNo → Word64 → RelativeSlot
nextChunkNo ∷ ChunkNo → ChunkNo
prevChunkNo ∷ ChunkNo → Maybe ChunkNo
simpleChunkInfo ∷ EpochSize → ChunkInfo
singleChunkInfo ∷ ChunkSize → ChunkInfo
firstBlockOrEBB ∷ ChunkInfo → ChunkNo → RelativeSlot
maxRelativeSlot ∷ ChunkInfo → ChunkNo → RelativeSlot
nextRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → NextRelativeSlot
nthBlockOrEBB ∷ (HasCallStack, Integral a) ⇒ ChunkInfo → ChunkNo → a → RelativeSlot
relativeSlotIsEBB ∷ RelativeSlot → IsEBB
unsafeNextRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → RelativeSlot
chunkIndexOfSlot ∷ ChunkInfo → SlotNo → ChunkNo
chunkSlotForBlockOrEBB ∷ ChunkInfo → BlockOrEBB → ChunkSlot
chunkSlotForBoundaryBlock ∷ HasCallStack ⇒ ChunkInfo → EpochNo → ChunkSlot
chunkSlotForRegularBlock ∷ ChunkInfo → SlotNo → ChunkSlot
chunkSlotForRelativeSlot ∷ ChunkNo → RelativeSlot → ChunkSlot
chunkSlotForTip ∷ ChunkInfo → Tip blk → ChunkSlot
chunkSlotForUnknownBlock ∷ HasCallStack ⇒ ChunkInfo → SlotNo → (ChunkNo, Maybe ChunkSlot, ChunkSlot)
chunkSlotToBlockOrEBB ∷ ChunkInfo → ChunkSlot → BlockOrEBB
chunkSlotToSlot ∷ ChunkInfo → ChunkSlot → SlotNo
slotMightBeEBB ∷ ChunkInfo → SlotNo → Maybe EpochNo
slotNoOfBlockOrEBB ∷ ChunkInfo → BlockOrEBB → SlotNo
slotNoOfEBB ∷ HasCallStack ⇒ ChunkInfo → EpochNo → SlotNo

Documentation

data ChunkInfo Source #

Size of the chunks of the immutable DB

This is the key data structure that drives all layout functions.

TODO: Add support for non-uniform ChunkInfo https://github.com/IntersectMBO/ouroboros-network/issues/1754

Constructors

UniformChunkSize !ChunkSize

A single, uniform, chunk size

If EBBs are present, the chunk size must line up precisely with the epoch size (that is, the number of regular blocks in the chunk must equal the number of regular blocks in an epoch).

Instances

Instances details

Generic ChunkInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Associated Types type Rep ChunkInfo ∷ Type → Type # Methods from ∷ ChunkInfo → Rep ChunkInfo x # to ∷ Rep ChunkInfo x → ChunkInfo #
Show ChunkInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods showsPrec ∷ Int → ChunkInfo → ShowS # show ∷ ChunkInfo → String # showList ∷ [ChunkInfo] → ShowS #
NoThunks ChunkInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods noThunks ∷ Context → ChunkInfo → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChunkInfo → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ChunkInfo → String Source #
type Rep ChunkInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep ChunkInfo = D1 ('MetaData "ChunkInfo" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.21.0.0-inplace" 'False) (C1 ('MetaCons "UniformChunkSize" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkSize)))

data ChunkNo Source #

Chunk number

Instances

Instances details

Generic ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Associated Types type Rep ChunkNo ∷ Type → Type # Methods from ∷ ChunkNo → Rep ChunkNo x # to ∷ Rep ChunkNo x → ChunkNo #
Show ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods showsPrec ∷ Int → ChunkNo → ShowS # show ∷ ChunkNo → String # showList ∷ [ChunkNo] → ShowS #
Eq ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods (==) ∷ ChunkNo → ChunkNo → Bool # (/=) ∷ ChunkNo → ChunkNo → Bool #
Ord ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods compare ∷ ChunkNo → ChunkNo → Ordering # (<) ∷ ChunkNo → ChunkNo → Bool # (<=) ∷ ChunkNo → ChunkNo → Bool # (>) ∷ ChunkNo → ChunkNo → Bool # (>=) ∷ ChunkNo → ChunkNo → Bool # max ∷ ChunkNo → ChunkNo → ChunkNo # min ∷ ChunkNo → ChunkNo → ChunkNo #
NoThunks ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods noThunks ∷ Context → ChunkNo → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChunkNo → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ChunkNo → String Source #
type Rep ChunkNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep ChunkNo = D1 ('MetaData "ChunkNo" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.21.0.0-inplace" 'True) (C1 ('MetaCons "ChunkNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unChunkNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

data ChunkSize Source #

Size of a chunk

The total number of slots available in a chunk is equal to numRegularBlocks if not chunkCanContainEBB, and numRegularBlocks + 1 otherwise.

Constructors

ChunkSize
Fields chunkCanContainEBB ∷ !Bool Does this chunk also accomodate an EBB? numRegularBlocks ∷ !Word64 The number of regular blocks in this chunk

Instances

Instances details

Generic ChunkSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Associated Types type Rep ChunkSize ∷ Type → Type # Methods from ∷ ChunkSize → Rep ChunkSize x # to ∷ Rep ChunkSize x → ChunkSize #
Show ChunkSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods showsPrec ∷ Int → ChunkSize → ShowS # show ∷ ChunkSize → String # showList ∷ [ChunkSize] → ShowS #
NoThunks ChunkSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods noThunks ∷ Context → ChunkSize → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChunkSize → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ChunkSize → String Source #
type Rep ChunkSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep ChunkSize = D1 ('MetaData "ChunkSize" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.21.0.0-inplace" 'False) (C1 ('MetaCons "ChunkSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "chunkCanContainEBB") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "numRegularBlocks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))

data RelativeSlot Source #

A relative slot within a chunk

Instances

Instances details

Generic RelativeSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Associated Types type Rep RelativeSlot ∷ Type → Type # Methods from ∷ RelativeSlot → Rep RelativeSlot x # to ∷ Rep RelativeSlot x → RelativeSlot #
Show RelativeSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods showsPrec ∷ Int → RelativeSlot → ShowS # show ∷ RelativeSlot → String # showList ∷ [RelativeSlot] → ShowS #
Eq RelativeSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods (==) ∷ RelativeSlot → RelativeSlot → Bool # (/=) ∷ RelativeSlot → RelativeSlot → Bool #
NoThunks RelativeSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal Methods noThunks ∷ Context → RelativeSlot → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RelativeSlot → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RelativeSlot → String Source #
type Rep RelativeSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep RelativeSlot = D1 ('MetaData "RelativeSlot" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.21.0.0-inplace" 'False) (C1 ('MetaCons "RelativeSlot" 'PrefixI 'True) (S1 ('MetaSel ('Just "relativeSlotChunkNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkNo) :: (S1 ('MetaSel ('Just "relativeSlotChunkSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkSize) :: S1 ('MetaSel ('Just "relativeSlotIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))))

data NextRelativeSlot Source #

Result of nextRelativeSlot

Constructors

NextRelativeSlot RelativeSlot	There is a next negative slot
NoMoreRelativeSlots	We reached the end of the chunk

data ChunkSlot Source #

Uniquely identify a block within the immutable DB

Constructor marked as Unsafe; construction should normally happen inside this module only (though see the ChunkSlot pattern synonym).

Constructors

UnsafeChunkSlot
Fields chunkIndex ∷ !ChunkNo chunkRelative ∷ !RelativeSlot

Instances

Instances details

Generic ChunkSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout Associated Types type Rep ChunkSlot ∷ Type → Type # Methods from ∷ ChunkSlot → Rep ChunkSlot x # to ∷ Rep ChunkSlot x → ChunkSlot #
Show ChunkSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout Methods showsPrec ∷ Int → ChunkSlot → ShowS # show ∷ ChunkSlot → String # showList ∷ [ChunkSlot] → ShowS #
Eq ChunkSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout Methods (==) ∷ ChunkSlot → ChunkSlot → Bool # (/=) ∷ ChunkSlot → ChunkSlot → Bool #
Ord ChunkSlot Source #	We provide a manual `Ord` instance because `RelativeSlot` does not (and cannot) define one. By comparing the `chunkIndex` before the index here, we establish the precondition to `compareRelativeSlot`.
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout Methods compare ∷ ChunkSlot → ChunkSlot → Ordering # (<) ∷ ChunkSlot → ChunkSlot → Bool # (<=) ∷ ChunkSlot → ChunkSlot → Bool # (>) ∷ ChunkSlot → ChunkSlot → Bool # (>=) ∷ ChunkSlot → ChunkSlot → Bool # max ∷ ChunkSlot → ChunkSlot → ChunkSlot # min ∷ ChunkSlot → ChunkSlot → ChunkSlot #
NoThunks ChunkSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout Methods noThunks ∷ Context → ChunkSlot → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChunkSlot → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ChunkSlot → String Source #
type Rep ChunkSlot Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout type Rep ChunkSlot = D1 ('MetaData "ChunkSlot" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout" "ouroboros-consensus-0.21.0.0-inplace" 'False) (C1 ('MetaCons "UnsafeChunkSlot" 'PrefixI 'True) (S1 ('MetaSel ('Just "chunkIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkNo) :*: S1 ('MetaSel ('Just "chunkRelative") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RelativeSlot)))

pattern ChunkSlot ∷ ChunkNo → RelativeSlot → ChunkSlot Source #

chunkInfoSupportsEBBs ∷ ChunkInfo → Bool Source #

Can we store EBBs in the chunks described by this ChunkInfo?

This is only used for tests. This API will need to change (and the tests will become more complicated) once we support non-uniform ChunkInfo.

chunksBetween ∷ ChunkNo → ChunkNo → [ChunkNo] Source #

Enumerate all chunks

chunksBetween x              x  == [x]
chunksBetween x (nextChunkNo x) == [x, nextChunkNo x]

compareRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → RelativeSlot → Ordering Source #

RelativeSlot is partially ordered, not totally ordered

It makes no sense to compare RelativeSlots from different chunks. Doing so will result in an assertion failure.

countChunks ∷ ChunkNo → ChunkNo → Word64 Source #

Count number of chunks between two indices

countChunks x              x  == 0
countChunks x (nextChunkNo x) == 1

firstChunkNo ∷ ChunkNo Source #

First chunk

getChunkSize ∷ ChunkInfo → ChunkNo → ChunkSize Source #

mkRelativeSlot ∷ HasCallStack ⇒ ChunkInfo → ChunkNo → Word64 → RelativeSlot Source #

Smart constructor for RelativeSlot

nextChunkNo ∷ ChunkNo → ChunkNo Source #

prevChunkNo ∷ ChunkNo → Maybe ChunkNo Source #

simpleChunkInfo ∷ EpochSize → ChunkInfo Source #

Simple chunk config with a single chunk size

This intentionally takes EpochSize (number of slots) rather than ChunkSize: the translation from EpochSize to ChunkSize (number of available entries in a chunk) should not be done by client code.

singleChunkInfo ∷ ChunkSize → ChunkInfo Source #

ChunkInfo for a single ChunkSize