Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Storage.ChainDB.Impl

Contents

Initialization
Trace types
Re-exported for convenience
Internals for testing purposes

Synopsis

data ChainDbArgs f m blk = ChainDbArgs {
- cdbImmDbArgs ∷ ImmutableDbArgs f m blk
- cdbVolDbArgs ∷ VolatileDbArgs f m blk
- cdbLgrDbArgs ∷ LgrDbArgs f m blk
- cdbsArgs ∷ ChainDbSpecificArgs f m blk
}
class (ImmutableDbSerialiseConstraints blk, LgrDbSerialiseConstraints blk, VolatileDbSerialiseConstraints blk, EncodeDiskDep (NestedCtxt Header) blk) ⇒ SerialiseDiskConstraints blk
defaultArgs ∷ ∀ m blk. Monad m ⇒ Incomplete ChainDbArgs m blk
openDB ∷ ∀ m blk. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk) ⇒ ChainDbArgs Identity m blk → m (ChainDB m blk)
withDB ∷ ∀ m blk a. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk) ⇒ ChainDbArgs Identity m blk → (ChainDB m blk → m a) → m a
data TraceReplayEvent blk
data SelectionChangedInfo blk = SelectionChangedInfo {
- newTipPoint ∷ RealPoint blk
- newTipEpoch ∷ EpochNo
- newTipSlotInEpoch ∷ Word64
- newTipTrigger ∷ RealPoint blk
- newTipSelectView ∷ SelectView (BlockProtocol blk)
- oldTipSelectView ∷ Maybe (SelectView (BlockProtocol blk))
}
data TraceAddBlockEvent blk
- = IgnoreBlockOlderThanK (RealPoint blk)
- | IgnoreBlockAlreadyInVolatileDB (RealPoint blk)
- | IgnoreInvalidBlock (RealPoint blk) (InvalidBlockReason blk)
- | AddedBlockToQueue (RealPoint blk) (Enclosing' Word)
- | PoppedBlockFromQueue (Enclosing' (RealPoint blk))
- | AddedReprocessLoEBlocksToQueue
- | PoppedReprocessLoEBlocksFromQueue
- | BlockInTheFuture (RealPoint blk) SlotNo
- | AddedBlockToVolatileDB (RealPoint blk) BlockNo IsEBB Enclosing
- | TryAddToCurrentChain (RealPoint blk)
- | TrySwitchToAFork (RealPoint blk) (ChainDiff (HeaderFields blk))
- | StoreButDontChange (RealPoint blk)
- | ChainSelectionLoEDebug (AnchoredFragment (Header blk)) (LoE (AnchoredFragment (Header blk)))
- | AddedToCurrentChain [LedgerEvent blk] (SelectionChangedInfo blk) (AnchoredFragment (Header blk)) (AnchoredFragment (Header blk))
- | SwitchedToAFork [LedgerEvent blk] (SelectionChangedInfo blk) (AnchoredFragment (Header blk)) (AnchoredFragment (Header blk))
- | AddBlockValidation (TraceValidationEvent blk)
- | ChainSelectionForFutureBlock (RealPoint blk)
- | PipeliningEvent (TracePipeliningEvent blk)
- | ChangingSelection (Point blk)
data TraceCopyToImmutableDBEvent blk
- = CopiedBlockToImmutableDB (Point blk)
- | NoBlocksToCopyToImmutableDB
data TraceEvent blk
- = TraceAddBlockEvent (TraceAddBlockEvent blk)
- | TraceFollowerEvent (TraceFollowerEvent blk)
- | TraceCopyToImmutableDBEvent (TraceCopyToImmutableDBEvent blk)
- | TraceGCEvent (TraceGCEvent blk)
- | TraceInitChainSelEvent (TraceInitChainSelEvent blk)
- | TraceOpenEvent (TraceOpenEvent blk)
- | TraceIteratorEvent (TraceIteratorEvent blk)
- | TraceSnapshotEvent (TraceSnapshotEvent blk)
- | TraceLedgerReplayEvent (TraceReplayEvent blk)
- | TraceImmutableDBEvent (TraceEvent blk)
- | TraceVolatileDBEvent (TraceEvent blk)
data TraceFollowerEvent blk
- = NewFollower
- | FollowerNoLongerInMem (FollowerRollState blk)
- | FollowerSwitchToMem (Point blk) (WithOrigin SlotNo)
- | FollowerNewImmIterator (Point blk) (WithOrigin SlotNo)
data TraceGCEvent blk
- = ScheduledGC SlotNo Time
- | PerformedGC SlotNo
data TraceInitChainSelEvent blk
- = StartedInitChainSelection
- | InitialChainSelected
- | InitChainSelValidation (TraceValidationEvent blk)
data TraceIteratorEvent blk
- = UnknownRangeRequested (UnknownRange blk)
- | StreamFromVolatileDB (StreamFrom blk) (StreamTo blk) [RealPoint blk]
- | StreamFromImmutableDB (StreamFrom blk) (StreamTo blk)
- | StreamFromBoth (StreamFrom blk) (StreamTo blk) [RealPoint blk]
- | BlockMissingFromVolatileDB (RealPoint blk)
- | BlockWasCopiedToImmutableDB (RealPoint blk)
- | BlockGCedFromVolatileDB (RealPoint blk)
- | SwitchBackToVolatileDB
data TraceOpenEvent blk
- = StartedOpeningDB
- | OpenedDB (Point blk) (Point blk)
- | ClosedDB (Point blk) (Point blk)
- | StartedOpeningImmutableDB
- | OpenedImmutableDB (Point blk) ChunkNo
- | StartedOpeningVolatileDB
- | OpenedVolatileDB MaxSlotNo
- | StartedOpeningLgrDB
- | OpenedLgrDB
data TracePipeliningEvent blk
- = SetTentativeHeader (Header blk) Enclosing
- | TrapTentativeHeader (Header blk)
- | OutdatedTentativeHeader (Header blk)
data TraceValidationEvent blk
- = InvalidBlock (ExtValidationError blk) (RealPoint blk)
- | ValidCandidate (AnchoredFragment (Header blk))
- | CandidateContainsFutureBlocks (AnchoredFragment (Header blk)) [Header blk]
- | CandidateContainsFutureBlocksExceedingClockSkew (AnchoredFragment (Header blk)) [Header blk]
- | UpdateLedgerDbTraceEvent (UpdateLedgerDbTraceEvent blk)
newtype RelativeMountPoint = RelativeMountPoint FilePath
type ImmutableDbSerialiseConstraints blk = (EncodeDisk blk blk, DecodeDisk blk (ByteString → blk), DecodeDiskDep (NestedCtxt Header) blk, ReconstructNestedCtxt Header blk, HasBinaryBlockInfo blk)
type LgrDbSerialiseConstraints blk = (Serialise (HeaderHash blk), EncodeDisk blk (LedgerState blk), DecodeDisk blk (LedgerState blk), EncodeDisk blk (AnnTip blk), DecodeDisk blk (AnnTip blk), EncodeDisk blk (ChainDepState (BlockProtocol blk)), DecodeDisk blk (ChainDepState (BlockProtocol blk)))
type VolatileDbSerialiseConstraints blk = (EncodeDisk blk blk, DecodeDisk blk (ByteString → blk), DecodeDiskDep (NestedCtxt Header) blk, HasNestedContent Header blk, HasBinaryBlockInfo blk)
data Internal m blk = Internal {
- intCopyToImmutableDB ∷ m (WithOrigin SlotNo)
- intGarbageCollect ∷ SlotNo → m ()
- intUpdateLedgerSnapshots ∷ m ()
- intAddBlockRunner ∷ m Void
- intKillBgThreads ∷ StrictTVar m (m ())
}
openDBInternal ∷ ∀ m blk. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk) ⇒ ChainDbArgs Identity m blk → Bool → m (ChainDB m blk, Internal m blk)

Initialization

data ChainDbArgs f m blk Source #

Constructors

ChainDbArgs
Fields cdbImmDbArgs ∷ ImmutableDbArgs f m blk cdbVolDbArgs ∷ VolatileDbArgs f m blk cdbLgrDbArgs ∷ LgrDbArgs f m blk cdbsArgs ∷ ChainDbSpecificArgs f m blk

class (ImmutableDbSerialiseConstraints blk, LgrDbSerialiseConstraints blk, VolatileDbSerialiseConstraints blk, EncodeDiskDep (NestedCtxt Header) blk) ⇒ SerialiseDiskConstraints blk Source #

All the serialisation related constraints needed by the ChainDB.

Instances

Instances details

SerialiseHFC xs ⇒ SerialiseDiskConstraints (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

defaultArgs ∷ ∀ m blk. Monad m ⇒ Incomplete ChainDbArgs m blk Source #

Default arguments

See defaultArgs, defaultArgs, defaultArgs, and defaultSpecificArgs for a list of which fields are not given a default and must therefore be set explicitly.

openDB ∷ ∀ m blk. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk) ⇒ ChainDbArgs Identity m blk → m (ChainDB m blk) Source #

withDB ∷ ∀ m blk a. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk) ⇒ ChainDbArgs Identity m blk → (ChainDB m blk → m a) → m a Source #

Trace types

data TraceReplayEvent blk Source #

Events traced while replaying blocks against the ledger to bring it up to date w.r.t. the tip of the ImmutableDB during initialisation. As this process takes a while, we trace events to inform higher layers of our progress.

Instances

Instances details

Generic (TraceReplayEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.Init Associated Types type Rep (TraceReplayEvent blk) ∷ Type → Type # Methods from ∷ TraceReplayEvent blk → Rep (TraceReplayEvent blk) x # to ∷ Rep (TraceReplayEvent blk) x → TraceReplayEvent blk #
(StandardHash blk, InspectLedger blk) ⇒ Show (TraceReplayEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.Init Methods showsPrec ∷ Int → TraceReplayEvent blk → ShowS # show ∷ TraceReplayEvent blk → String # showList ∷ [TraceReplayEvent blk] → ShowS #
(StandardHash blk, InspectLedger blk) ⇒ Eq (TraceReplayEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.Init Methods (==) ∷ TraceReplayEvent blk → TraceReplayEvent blk → Bool # (/=) ∷ TraceReplayEvent blk → TraceReplayEvent blk → Bool #
type Rep (TraceReplayEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.Init type Rep (TraceReplayEvent blk) = D1 ('MetaData "TraceReplayEvent" "Ouroboros.Consensus.Storage.LedgerDB.Init" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "ReplayFromGenesis" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayGoal blk))) :+: (C1 ('MetaCons "ReplayFromSnapshot" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayStart blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayGoal blk)))) :+: C1 ('MetaCons "ReplayedBlock" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LedgerEvent blk])) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayStart blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayGoal blk))))))

data SelectionChangedInfo blk Source #

Information on having changed our selection to a chain with a (necessarily) new tip.

NOTE: the fields of this record are intentionally lazy to prevent the forcing of this information in case it doesn't have to be traced. However, this means that the tracer processing this message must not hold on to it, otherwise it leaks memory.

Constructors

SelectionChangedInfo

Fields

newTipPoint ∷ RealPoint blk
The new tip of the current chain.
newTipEpoch ∷ EpochNo
The epoch of the new tip.
newTipSlotInEpoch ∷ Word64
The slot in the epoch, i.e., the relative slot number, of the new tip.
newTipTrigger ∷ RealPoint blk
The new tip of the current chain (newTipPoint) is the result of performing chain selection for a trigger block (newTipTrigger). In most cases, we add a new block to the tip of the current chain, in which case the new tip is the trigger block.
However, this is not always the case. For example, with our current chain being A and having a disconnected C lying around, adding B will result in A -> B -> C as the new chain. The trigger B /= the new tip C.
newTipSelectView ∷ SelectView (BlockProtocol blk)
The SelectView of the new tip. It is guaranteed that
```
Just newTipSelectView > oldTipSelectView
```
True
oldTipSelectView ∷ Maybe (SelectView (BlockProtocol blk))
The SelectView of the old, previous tip. This can be Nothing when the previous chain/tip was Genesis.

Instances

Instances details

Generic (SelectionChangedInfo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (SelectionChangedInfo blk) ∷ Type → Type # Methods from ∷ SelectionChangedInfo blk → Rep (SelectionChangedInfo blk) x # to ∷ Rep (SelectionChangedInfo blk) x → SelectionChangedInfo blk #
(Show (SelectView (BlockProtocol blk)), StandardHash blk) ⇒ Show (SelectionChangedInfo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → SelectionChangedInfo blk → ShowS # show ∷ SelectionChangedInfo blk → String # showList ∷ [SelectionChangedInfo blk] → ShowS #
(Eq (SelectView (BlockProtocol blk)), StandardHash blk) ⇒ Eq (SelectionChangedInfo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ SelectionChangedInfo blk → SelectionChangedInfo blk → Bool # (/=) ∷ SelectionChangedInfo blk → SelectionChangedInfo blk → Bool #
type Rep (SelectionChangedInfo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (SelectionChangedInfo blk) = D1 ('MetaData "SelectionChangedInfo" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "SelectionChangedInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "newTipPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: (S1 ('MetaSel ('Just "newTipEpoch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EpochNo) :: S1 ('MetaSel ('Just "newTipSlotInEpoch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))) :: (S1 ('MetaSel ('Just "newTipTrigger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: (S1 ('MetaSel ('Just "newTipSelectView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SelectView (BlockProtocol blk))) :*: S1 ('MetaSel ('Just "oldTipSelectView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (SelectView (BlockProtocol blk))))))))

data TraceAddBlockEvent blk Source #

Trace type for the various events that occur when adding a block.

Constructors

IgnoreBlockOlderThanK (RealPoint blk)	A block with a `BlockNo` more than `k` back than the current tip was ignored.
IgnoreBlockAlreadyInVolatileDB (RealPoint blk)	A block that is already in the Volatile DB was ignored.
IgnoreInvalidBlock (RealPoint blk) (InvalidBlockReason blk)	A block that is know to be invalid was ignored.
AddedBlockToQueue (RealPoint blk) (Enclosing' Word)	The block was added to the queue and will be added to the ChainDB by the background thread. The size of the queue is included.
PoppedBlockFromQueue (Enclosing' (RealPoint blk))	The block popped from the queue and will imminently be added to the ChainDB.
AddedReprocessLoEBlocksToQueue	A message was added to the queue that requests that ChainSel reprocess blocks that were postponed by the LoE.
PoppedReprocessLoEBlocksFromQueue	ChainSel will reprocess blocks that were postponed by the LoE.
BlockInTheFuture (RealPoint blk) SlotNo	The block is from the future, i.e., its slot number is greater than the current slot (the second argument).
AddedBlockToVolatileDB (RealPoint blk) BlockNo IsEBB Enclosing	A block was added to the Volatile DB
TryAddToCurrentChain (RealPoint blk)	The block fits onto the current chain, we'll try to use it to extend our chain.
TrySwitchToAFork (RealPoint blk) (ChainDiff (HeaderFields blk))	The block fits onto some fork, we'll try to switch to that fork (if it is preferable to our chain).
StoreButDontChange (RealPoint blk)	The block doesn't fit onto any other block, so we store it and ignore it.
ChainSelectionLoEDebug (AnchoredFragment (Header blk)) (LoE (AnchoredFragment (Header blk)))	Debugging information about chain selection and LoE
AddedToCurrentChain [LedgerEvent blk] (SelectionChangedInfo blk) (AnchoredFragment (Header blk)) (AnchoredFragment (Header blk))	The new block fits onto the current chain (first fragment) and we have successfully used it to extend our (new) current chain (second fragment).
SwitchedToAFork [LedgerEvent blk] (SelectionChangedInfo blk) (AnchoredFragment (Header blk)) (AnchoredFragment (Header blk))	The new block fits onto some fork and we have switched to that fork (second fragment), as it is preferable to our (previous) current chain (first fragment).
AddBlockValidation (TraceValidationEvent blk)	An event traced during validating performed while adding a block.
ChainSelectionForFutureBlock (RealPoint blk)	Run chain selection for a block that was previously from the future. This is done for all blocks from the future each time a new block is added.
PipeliningEvent (TracePipeliningEvent blk)	The tentative header (in the context of diffusion pipelining) has been updated.
ChangingSelection (Point blk)	Herald of `AddedToCurrentChain` or `SwitchedToAFork`. Lists the tip of the new chain.

Instances

Instances details

Generic (TraceAddBlockEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceAddBlockEvent blk) ∷ Type → Type # Methods from ∷ TraceAddBlockEvent blk → Rep (TraceAddBlockEvent blk) x # to ∷ Rep (TraceAddBlockEvent blk) x → TraceAddBlockEvent blk #
(Show (Header blk), LedgerSupportsProtocol blk, InspectLedger blk) ⇒ Show (TraceAddBlockEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceAddBlockEvent blk → ShowS # show ∷ TraceAddBlockEvent blk → String # showList ∷ [TraceAddBlockEvent blk] → ShowS #
(Eq (Header blk), LedgerSupportsProtocol blk, InspectLedger blk) ⇒ Eq (TraceAddBlockEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceAddBlockEvent blk → TraceAddBlockEvent blk → Bool # (/=) ∷ TraceAddBlockEvent blk → TraceAddBlockEvent blk → Bool #
type Rep (TraceAddBlockEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceAddBlockEvent blk) = D1 ('MetaData "TraceAddBlockEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) ((((C1 ('MetaCons "IgnoreBlockOlderThanK" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "IgnoreBlockAlreadyInVolatileDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)))) :+: (C1 ('MetaCons "IgnoreInvalidBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InvalidBlockReason blk))) :+: C1 ('MetaCons "AddedBlockToQueue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Enclosing' Word))))) :+: ((C1 ('MetaCons "PoppedBlockFromQueue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Enclosing' (RealPoint blk)))) :+: C1 ('MetaCons "AddedReprocessLoEBlocksToQueue" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "PoppedReprocessLoEBlocksFromQueue" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "BlockInTheFuture" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)) :+: C1 ('MetaCons "AddedBlockToVolatileDB" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockNo)) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IsEBB) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Enclosing))))))) :+: (((C1 ('MetaCons "TryAddToCurrentChain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "TrySwitchToAFork" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ChainDiff (HeaderFields blk))))) :+: (C1 ('MetaCons "StoreButDontChange" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: (C1 ('MetaCons "ChainSelectionLoEDebug" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LoE (AnchoredFragment (Header blk))))) :+: C1 ('MetaCons "AddedToCurrentChain" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LedgerEvent blk]) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SelectionChangedInfo blk))) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk)))))))) :+: ((C1 ('MetaCons "SwitchedToAFork" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LedgerEvent blk]) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SelectionChangedInfo blk))) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))))) :+: C1 ('MetaCons "AddBlockValidation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceValidationEvent blk)))) :+: (C1 ('MetaCons "ChainSelectionForFutureBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: (C1 ('MetaCons "PipeliningEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TracePipeliningEvent blk))) :+: C1 ('MetaCons "ChangingSelection" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))))))))

data TraceCopyToImmutableDBEvent blk Source #

Constructors

CopiedBlockToImmutableDB (Point blk)	A block was successfully copied to the ImmutableDB.
NoBlocksToCopyToImmutableDB	There are no block to copy to the ImmutableDB.

Instances

Instances details

Generic (TraceCopyToImmutableDBEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceCopyToImmutableDBEvent blk) ∷ Type → Type # Methods from ∷ TraceCopyToImmutableDBEvent blk → Rep (TraceCopyToImmutableDBEvent blk) x # to ∷ Rep (TraceCopyToImmutableDBEvent blk) x → TraceCopyToImmutableDBEvent blk #
StandardHash blk ⇒ Show (TraceCopyToImmutableDBEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceCopyToImmutableDBEvent blk → ShowS # show ∷ TraceCopyToImmutableDBEvent blk → String # showList ∷ [TraceCopyToImmutableDBEvent blk] → ShowS #
StandardHash blk ⇒ Eq (TraceCopyToImmutableDBEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceCopyToImmutableDBEvent blk → TraceCopyToImmutableDBEvent blk → Bool # (/=) ∷ TraceCopyToImmutableDBEvent blk → TraceCopyToImmutableDBEvent blk → Bool #
type Rep (TraceCopyToImmutableDBEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceCopyToImmutableDBEvent blk) = D1 ('MetaData "TraceCopyToImmutableDBEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "CopiedBlockToImmutableDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))) :+: C1 ('MetaCons "NoBlocksToCopyToImmutableDB" 'PrefixI 'False) (U1 ∷ Type → Type))

data TraceEvent blk Source #

Trace type for the various events of the ChainDB.

Constructors

TraceAddBlockEvent (TraceAddBlockEvent blk)
TraceFollowerEvent (TraceFollowerEvent blk)
TraceCopyToImmutableDBEvent (TraceCopyToImmutableDBEvent blk)
TraceGCEvent (TraceGCEvent blk)
TraceInitChainSelEvent (TraceInitChainSelEvent blk)
TraceOpenEvent (TraceOpenEvent blk)
TraceIteratorEvent (TraceIteratorEvent blk)
TraceSnapshotEvent (TraceSnapshotEvent blk)
TraceLedgerReplayEvent (TraceReplayEvent blk)
TraceImmutableDBEvent (TraceEvent blk)
TraceVolatileDBEvent (TraceEvent blk)

Instances

Instances details

Generic (TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceEvent blk) ∷ Type → Type # Methods from ∷ TraceEvent blk → Rep (TraceEvent blk) x # to ∷ Rep (TraceEvent blk) x → TraceEvent blk #
(Show (Header blk), LedgerSupportsProtocol blk, InspectLedger blk) ⇒ Show (TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceEvent blk → ShowS # show ∷ TraceEvent blk → String # showList ∷ [TraceEvent blk] → ShowS #
(Eq (Header blk), LedgerSupportsProtocol blk, InspectLedger blk) ⇒ Eq (TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceEvent blk → TraceEvent blk → Bool # (/=) ∷ TraceEvent blk → TraceEvent blk → Bool #
type Rep (TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceEvent blk) = D1 ('MetaData "TraceEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (((C1 ('MetaCons "TraceAddBlockEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceAddBlockEvent blk))) :+: C1 ('MetaCons "TraceFollowerEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceFollowerEvent blk)))) :+: (C1 ('MetaCons "TraceCopyToImmutableDBEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceCopyToImmutableDBEvent blk))) :+: (C1 ('MetaCons "TraceGCEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceGCEvent blk))) :+: C1 ('MetaCons "TraceInitChainSelEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceInitChainSelEvent blk)))))) :+: ((C1 ('MetaCons "TraceOpenEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceOpenEvent blk))) :+: (C1 ('MetaCons "TraceIteratorEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceIteratorEvent blk))) :+: C1 ('MetaCons "TraceSnapshotEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceSnapshotEvent blk))))) :+: (C1 ('MetaCons "TraceLedgerReplayEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceReplayEvent blk))) :+: (C1 ('MetaCons "TraceImmutableDBEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceEvent blk))) :+: C1 ('MetaCons "TraceVolatileDBEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceEvent blk)))))))

data TraceFollowerEvent blk Source #

Constructors

NewFollower	A new follower was created.
FollowerNoLongerInMem (FollowerRollState blk)	The follower was in the `FollowerInMem` state but its point is no longer on the in-memory chain fragment, so it has to switch to the `FollowerInImmutableDB` state.
FollowerSwitchToMem	The follower was in the `FollowerInImmutableDB` state and is switched to the `FollowerInMem` state.
Fields (Point blk) Point at which the follower is (WithOrigin SlotNo) Slot number at the tip of the ImmutableDB
FollowerNewImmIterator	The follower is in the `FollowerInImmutableDB` state but the iterator is exhausted while the ImmutableDB has grown, so we open a new iterator to stream these blocks too.
Fields (Point blk) Point at which the follower is (WithOrigin SlotNo) Slot number at the tip of the ImmutableDB

Instances

Instances details

Generic (TraceFollowerEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceFollowerEvent blk) ∷ Type → Type # Methods from ∷ TraceFollowerEvent blk → Rep (TraceFollowerEvent blk) x # to ∷ Rep (TraceFollowerEvent blk) x → TraceFollowerEvent blk #
StandardHash blk ⇒ Show (TraceFollowerEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceFollowerEvent blk → ShowS # show ∷ TraceFollowerEvent blk → String # showList ∷ [TraceFollowerEvent blk] → ShowS #
StandardHash blk ⇒ Eq (TraceFollowerEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceFollowerEvent blk → TraceFollowerEvent blk → Bool # (/=) ∷ TraceFollowerEvent blk → TraceFollowerEvent blk → Bool #
type Rep (TraceFollowerEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceFollowerEvent blk) = D1 ('MetaData "TraceFollowerEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) ((C1 ('MetaCons "NewFollower" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "FollowerNoLongerInMem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (FollowerRollState blk)))) :+: (C1 ('MetaCons "FollowerSwitchToMem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WithOrigin SlotNo))) :+: C1 ('MetaCons "FollowerNewImmIterator" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WithOrigin SlotNo)))))

data TraceGCEvent blk Source #

Constructors

ScheduledGC SlotNo Time	A garbage collection for the given `SlotNo` was scheduled to happen at the given time.
PerformedGC SlotNo	A garbage collection for the given `SlotNo` was performed.

Instances

Instances details

Generic (TraceGCEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceGCEvent blk) ∷ Type → Type # Methods from ∷ TraceGCEvent blk → Rep (TraceGCEvent blk) x # to ∷ Rep (TraceGCEvent blk) x → TraceGCEvent blk #
Show (TraceGCEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceGCEvent blk → ShowS # show ∷ TraceGCEvent blk → String # showList ∷ [TraceGCEvent blk] → ShowS #
Eq (TraceGCEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceGCEvent blk → TraceGCEvent blk → Bool # (/=) ∷ TraceGCEvent blk → TraceGCEvent blk → Bool #
type Rep (TraceGCEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceGCEvent blk) = D1 ('MetaData "TraceGCEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "ScheduledGC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Time)) :+: C1 ('MetaCons "PerformedGC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)))

data TraceInitChainSelEvent blk Source #

Constructors

StartedInitChainSelection	An event traced when inital chain selection has started during the initialization of ChainDB
InitialChainSelected	An event traced when inital chain has been selected
InitChainSelValidation (TraceValidationEvent blk)	An event traced during validation performed while performing initial chain selection.

Instances

Instances details

Generic (TraceInitChainSelEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceInitChainSelEvent blk) ∷ Type → Type # Methods from ∷ TraceInitChainSelEvent blk → Rep (TraceInitChainSelEvent blk) x # to ∷ Rep (TraceInitChainSelEvent blk) x → TraceInitChainSelEvent blk #
(Show (Header blk), LedgerSupportsProtocol blk) ⇒ Show (TraceInitChainSelEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceInitChainSelEvent blk → ShowS # show ∷ TraceInitChainSelEvent blk → String # showList ∷ [TraceInitChainSelEvent blk] → ShowS #
(Eq (Header blk), LedgerSupportsProtocol blk) ⇒ Eq (TraceInitChainSelEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceInitChainSelEvent blk → TraceInitChainSelEvent blk → Bool # (/=) ∷ TraceInitChainSelEvent blk → TraceInitChainSelEvent blk → Bool #
type Rep (TraceInitChainSelEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceInitChainSelEvent blk) = D1 ('MetaData "TraceInitChainSelEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "StartedInitChainSelection" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "InitialChainSelected" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "InitChainSelValidation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceValidationEvent blk)))))

data TraceIteratorEvent blk Source #

Constructors

UnknownRangeRequested (UnknownRange blk)	An unknown range was requested, see `UnknownRange`.
StreamFromVolatileDB (StreamFrom blk) (StreamTo blk) [RealPoint blk]	Stream only from the VolatileDB.
StreamFromImmutableDB (StreamFrom blk) (StreamTo blk)	Stream only from the ImmutableDB.
StreamFromBoth (StreamFrom blk) (StreamTo blk) [RealPoint blk]	Stream from both the VolatileDB and the ImmutableDB.
BlockMissingFromVolatileDB (RealPoint blk)	A block is no longer in the VolatileDB because it has been garbage collected. It might now be in the ImmutableDB if it was part of the current chain.
BlockWasCopiedToImmutableDB (RealPoint blk)	A block that has been garbage collected from the VolatileDB is now found and streamed from the ImmutableDB.
BlockGCedFromVolatileDB (RealPoint blk)	A block is no longer in the VolatileDB and isn't in the ImmutableDB either; it wasn't part of the current chain.
SwitchBackToVolatileDB	We have streamed one or more blocks from the ImmutableDB that were part of the VolatileDB when initialising the iterator. Now, we have to look back in the VolatileDB again because the ImmutableDB doesn't have the next block we're looking for.

Instances

Instances details

Generic (TraceIteratorEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceIteratorEvent blk) ∷ Type → Type # Methods from ∷ TraceIteratorEvent blk → Rep (TraceIteratorEvent blk) x # to ∷ Rep (TraceIteratorEvent blk) x → TraceIteratorEvent blk #
StandardHash blk ⇒ Show (TraceIteratorEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceIteratorEvent blk → ShowS # show ∷ TraceIteratorEvent blk → String # showList ∷ [TraceIteratorEvent blk] → ShowS #
StandardHash blk ⇒ Eq (TraceIteratorEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceIteratorEvent blk → TraceIteratorEvent blk → Bool # (/=) ∷ TraceIteratorEvent blk → TraceIteratorEvent blk → Bool #
type Rep (TraceIteratorEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceIteratorEvent blk) = D1 ('MetaData "TraceIteratorEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (((C1 ('MetaCons "UnknownRangeRequested" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UnknownRange blk))) :+: C1 ('MetaCons "StreamFromVolatileDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamFrom blk)) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamTo blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RealPoint blk])))) :+: (C1 ('MetaCons "StreamFromImmutableDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamFrom blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamTo blk))) :+: C1 ('MetaCons "StreamFromBoth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamFrom blk)) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamTo blk)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RealPoint blk]))))) :+: ((C1 ('MetaCons "BlockMissingFromVolatileDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "BlockWasCopiedToImmutableDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)))) :+: (C1 ('MetaCons "BlockGCedFromVolatileDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "SwitchBackToVolatileDB" 'PrefixI 'False) (U1 ∷ Type → Type))))

data TraceOpenEvent blk Source #

Constructors

StartedOpeningDB	The ChainDB started the process of opening.
OpenedDB	The ChainDB was opened.
Fields (Point blk) Immutable tip (Point blk) Tip of the current chain
ClosedDB	The ChainDB was closed.
Fields (Point blk) Immutable tip (Point blk) Tip of the current chain
StartedOpeningImmutableDB	The ImmutableDB started the process of opening.
OpenedImmutableDB	The ImmutableDB was opened.
Fields (Point blk) Immutable tip ChunkNo Chunk number of the immutable tip
StartedOpeningVolatileDB	The VolatileDB started opening.
OpenedVolatileDB MaxSlotNo	The VolatileDB was opened, with the highest seen slot number for any block currently in the DB.
StartedOpeningLgrDB	The LedgerDB started opening.
OpenedLgrDB	The LedgerDB was opened.

Instances

Instances details

Generic (TraceOpenEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceOpenEvent blk) ∷ Type → Type # Methods from ∷ TraceOpenEvent blk → Rep (TraceOpenEvent blk) x # to ∷ Rep (TraceOpenEvent blk) x → TraceOpenEvent blk #
StandardHash blk ⇒ Show (TraceOpenEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceOpenEvent blk → ShowS # show ∷ TraceOpenEvent blk → String # showList ∷ [TraceOpenEvent blk] → ShowS #
StandardHash blk ⇒ Eq (TraceOpenEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceOpenEvent blk → TraceOpenEvent blk → Bool # (/=) ∷ TraceOpenEvent blk → TraceOpenEvent blk → Bool #
type Rep (TraceOpenEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceOpenEvent blk) = D1 ('MetaData "TraceOpenEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) (((C1 ('MetaCons "StartedOpeningDB" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "OpenedDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)))) :+: (C1 ('MetaCons "ClosedDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))) :+: C1 ('MetaCons "StartedOpeningImmutableDB" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "OpenedImmutableDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :+: C1 ('MetaCons "StartedOpeningVolatileDB" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "OpenedVolatileDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MaxSlotNo)) :+: (C1 ('MetaCons "StartedOpeningLgrDB" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "OpenedLgrDB" 'PrefixI 'False) (U1 ∷ Type → Type)))))

data TracePipeliningEvent blk Source #

Constructors

SetTentativeHeader (Header blk) Enclosing	A new tentative header got set.
TrapTentativeHeader (Header blk)	The body of tentative block turned out to be invalid.
OutdatedTentativeHeader (Header blk)	We selected a new (better) chain, which cleared the previous tentative header.

Instances

Instances details

Show (Header blk) ⇒ Show (TracePipeliningEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TracePipeliningEvent blk → ShowS # show ∷ TracePipeliningEvent blk → String # showList ∷ [TracePipeliningEvent blk] → ShowS #
Eq (Header blk) ⇒ Eq (TracePipeliningEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TracePipeliningEvent blk → TracePipeliningEvent blk → Bool # (/=) ∷ TracePipeliningEvent blk → TracePipeliningEvent blk → Bool #

data TraceValidationEvent blk Source #

Constructors

InvalidBlock (ExtValidationError blk) (RealPoint blk)	A point was found to be invalid.
ValidCandidate (AnchoredFragment (Header blk))	A candidate chain was valid.
CandidateContainsFutureBlocks	Candidate contains headers from the future which do no exceed the clock skew.
Fields (AnchoredFragment (Header blk)) Candidate chain containing headers from the future [Header blk] Headers from the future, not exceeding clock skew
CandidateContainsFutureBlocksExceedingClockSkew	Candidate contains headers from the future which exceed the clock skew, making them invalid.
Fields (AnchoredFragment (Header blk)) Candidate chain containing headers from the future [Header blk] Headers from the future, exceeding clock skew
UpdateLedgerDbTraceEvent (UpdateLedgerDbTraceEvent blk)

Instances

Instances details

Generic (TraceValidationEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Associated Types type Rep (TraceValidationEvent blk) ∷ Type → Type # Methods from ∷ TraceValidationEvent blk → Rep (TraceValidationEvent blk) x # to ∷ Rep (TraceValidationEvent blk) x → TraceValidationEvent blk #
(Show (Header blk), LedgerSupportsProtocol blk) ⇒ Show (TraceValidationEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods showsPrec ∷ Int → TraceValidationEvent blk → ShowS # show ∷ TraceValidationEvent blk → String # showList ∷ [TraceValidationEvent blk] → ShowS #
(Eq (Header blk), LedgerSupportsProtocol blk) ⇒ Eq (TraceValidationEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types Methods (==) ∷ TraceValidationEvent blk → TraceValidationEvent blk → Bool # (/=) ∷ TraceValidationEvent blk → TraceValidationEvent blk → Bool #
type Rep (TraceValidationEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ChainDB.Impl.Types type Rep (TraceValidationEvent blk) = D1 ('MetaData "TraceValidationEvent" "Ouroboros.Consensus.Storage.ChainDB.Impl.Types" "ouroboros-consensus-0.18.0.0-inplace" 'False) ((C1 ('MetaCons "InvalidBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ExtValidationError blk)) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "ValidCandidate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))))) :+: (C1 ('MetaCons "CandidateContainsFutureBlocks" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Header blk])) :+: (C1 ('MetaCons "CandidateContainsFutureBlocksExceedingClockSkew" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AnchoredFragment (Header blk))) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Header blk])) :+: C1 ('MetaCons "UpdateLedgerDbTraceEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UpdateLedgerDbTraceEvent blk))))))

Re-exported for convenience

newtype RelativeMountPoint Source #

A relative path for a MountPoint

The root is determined by context.

Constructors

RelativeMountPoint FilePath

type ImmutableDbSerialiseConstraints blk = (EncodeDisk blk blk, DecodeDisk blk (ByteString → blk), DecodeDiskDep (NestedCtxt Header) blk, ReconstructNestedCtxt Header blk, HasBinaryBlockInfo blk) Source #

EncodeDisk and DecodeDisk constraints needed for the ImmutableDB.

type LgrDbSerialiseConstraints blk = (Serialise (HeaderHash blk), EncodeDisk blk (LedgerState blk), DecodeDisk blk (LedgerState blk), EncodeDisk blk (AnnTip blk), DecodeDisk blk (AnnTip blk), EncodeDisk blk (ChainDepState (BlockProtocol blk)), DecodeDisk blk (ChainDepState (BlockProtocol blk))) Source #

EncodeDisk and DecodeDisk constraints needed for the LgrDB.

type VolatileDbSerialiseConstraints blk = (EncodeDisk blk blk, DecodeDisk blk (ByteString → blk), DecodeDiskDep (NestedCtxt Header) blk, HasNestedContent Header blk, HasBinaryBlockInfo blk) Source #

EncodeDisk and DecodeDisk constraints needed for the VolatileDB.

Internals for testing purposes

data Internal m blk Source #

Constructors

Internal

Fields

intCopyToImmutableDB ∷ m (WithOrigin SlotNo)
Copy the blocks older than k from to the VolatileDB to the ImmutableDB and update the in-memory chain fragment correspondingly.
The SlotNo of the tip of the ImmutableDB after copying the blocks is returned. This can be used for a garbage collection on the VolatileDB.
intGarbageCollect ∷ SlotNo → m ()
Perform garbage collection for blocks <= the given SlotNo.
intUpdateLedgerSnapshots ∷ m ()
Write a new LedgerDB snapshot to disk and remove the oldest one(s).
intAddBlockRunner ∷ m Void
Start the loop that adds blocks to the ChainDB retrieved from the queue populated by addBlock. Execute this loop in a separate thread.
intKillBgThreads ∷ StrictTVar m (m ())
A handle to kill the background threads.

openDBInternal Source #

Arguments

∷ ∀ m blk. (IOLike m, LedgerSupportsProtocol blk, BlockSupportsDiffusionPipelining blk, InspectLedger blk, HasHardForkHistory blk, ConvertRawHash blk, SerialiseDiskConstraints blk)
⇒ ChainDbArgs Identity m blk
→ Bool	`True` = Launch background tasks
→ m (ChainDB m blk, Internal m blk)