Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Layout

Contents

Relative slots
- Opaque
Chunks
Slots within a chunk

Description

Layout of individual chunks on disk

This module is not re-exported from the public Chunks API, since it's only relevant internally in the immutable DB. This module makes the layout decisions.

Synopsis

data NextRelativeSlot
- = NextRelativeSlot RelativeSlot
- | NoMoreRelativeSlots
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
data RelativeSlot
chunkIndexOfSlot ∷ ChunkInfo → SlotNo → ChunkNo
data ChunkSlot = UnsafeChunkSlot {
- chunkIndex ∷ !ChunkNo
- chunkRelative ∷ !RelativeSlot
}
pattern ChunkSlot ∷ ChunkNo → RelativeSlot → ChunkSlot
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

Relative slots

data NextRelativeSlot Source #

Result of nextRelativeSlot

Constructors

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

firstBlockOrEBB ∷ ChunkInfo → ChunkNo → RelativeSlot Source #

The first relative slot

NOTE: This refers to an EBB only if the ChunkSize supports it.

maxRelativeSlot ∷ ChunkInfo → ChunkNo → RelativeSlot Source #

The last relative slot within a chunk of the given size

nextRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → NextRelativeSlot Source #

Next relative slot

nthBlockOrEBB ∷ (HasCallStack, Integral a) ⇒ ChunkInfo → ChunkNo → a → RelativeSlot Source #

The n'th relative slot for an arbitrary block

NOTE: Offset 0 refers to an EBB only if the ChunkSize supports it.

relativeSlotIsEBB ∷ RelativeSlot → IsEBB Source #

Is this relative slot reserved for an EBB?

unsafeNextRelativeSlot ∷ HasCallStack ⇒ RelativeSlot → RelativeSlot Source #

Variation on nextRelativeSlot where the caller knows that there must be a next slot

Throws an assertion failure (if assertions are enabled) if there is no next slot.

Opaque

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))))

Chunks

chunkIndexOfSlot ∷ ChunkInfo → SlotNo → ChunkNo Source #

Slots within a 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 #

Translation to `ChunkSlot`

chunkSlotForBlockOrEBB ∷ ChunkInfo → BlockOrEBB → ChunkSlot Source #

Chunk slot for BlockOrEBB

chunkSlotForBoundaryBlock ∷ HasCallStack ⇒ ChunkInfo → EpochNo → ChunkSlot Source #

Chunk slot for EBB

chunkSlotForRegularBlock ∷ ChunkInfo → SlotNo → ChunkSlot Source #

Chunk slot for a regular block (i.e., not an EBB)

chunkSlotForRelativeSlot ∷ ChunkNo → RelativeSlot → ChunkSlot Source #

chunkSlotForTip ∷ ChunkInfo → Tip blk → ChunkSlot Source #

Chunk slot for Tip

chunkSlotForUnknownBlock ∷ HasCallStack ⇒ ChunkInfo → SlotNo → (ChunkNo, Maybe ChunkSlot, ChunkSlot) Source #

Chunk slot for an unknown block

This returns two ChunkSlots: one in case the block could be an EBB, and one in case the block is a regular block. In addition, it also returns the ChunkNo that both of these ChunkSlots must necessarily share.