Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.VolatileDB.Impl.State

Contents

Tracing
State types
State helpers

Synopsis

data TraceEvent blk
- = DBAlreadyClosed
- | BlockAlreadyHere ( HeaderHash blk)
- | Truncate ( ParseError blk) FsPath BlockOffset
- | InvalidFileNames [ FsPath ]
newtype BlockOffset = BlockOffset {
- unBlockOffset :: Word64
}
newtype BlockSize = BlockSize {
- unBlockSize :: Word32
}
type FileId = Int
data InternalState blk h
- = DbClosed
- | DbOpen !( OpenState blk h)
data OpenState blk h = OpenState {
- currentWriteHandle :: !( Handle h)
- currentWritePath :: ! FsPath
- currentWriteId :: ! FileId
- currentWriteOffset :: ! Word64
- currentMap :: !( Index blk)
- currentRevMap :: !( ReverseIndex blk)
- currentSuccMap :: !( SuccessorsIndex blk)
- currentMaxSlotNo :: ! MaxSlotNo
}
type ReverseIndex blk = Map ( HeaderHash blk) ( InternalBlockInfo blk)
type SuccessorsIndex blk = Map ( ChainHash blk) ( Set ( HeaderHash blk))
data VolatileDBEnv m blk = forall h. Eq h => VolatileDBEnv {
- hasFS :: !( HasFS m h)
- varInternalState :: !( RAWLock m ( InternalState blk h))
- maxBlocksPerFile :: ! BlocksPerFile
- checkIntegrity :: !(blk -> Bool )
- codecConfig :: !( CodecConfig blk)
- tracer :: !( Tracer m ( TraceEvent blk))
}
dbIsOpen :: InternalState blk h -> Bool
type ModifyOpenState m blk h = StateT ( OpenState blk h) ( WithTempRegistry ( OpenState blk h) m)
appendOpenState :: forall blk m a. ( IOLike m, Typeable blk, StandardHash blk) => VolatileDBEnv m blk -> ( forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a) -> m a
closeOpenHandles :: HasFS m h -> OpenState blk h -> m ()
mkOpenState :: forall m blk h. ( HasCallStack , IOLike m, GetPrevHash blk, HasBinaryBlockInfo blk, HasNestedContent Header blk, DecodeDisk blk ( ByteString -> blk), Eq h) => CodecConfig blk -> HasFS m h -> (blk -> Bool ) -> BlockValidationPolicy -> Tracer m ( TraceEvent blk) -> BlocksPerFile -> WithTempRegistry ( OpenState blk h) m ( OpenState blk h)
withOpenState :: forall blk m r. ( IOLike m, StandardHash blk, Typeable blk) => VolatileDBEnv m blk -> ( forall h. HasFS m h -> OpenState blk h -> m r) -> m r
writeOpenState :: forall blk m a. ( IOLike m, Typeable blk, StandardHash blk) => VolatileDBEnv m blk -> ( forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a) -> m a

Tracing

data TraceEvent blk Source #

Constructors

DBAlreadyClosed
BlockAlreadyHere ( HeaderHash blk)
Truncate ( ParseError blk) FsPath BlockOffset
InvalidFileNames [ FsPath ]

Instances

Instances details

StandardHash blk => Eq ( TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods (==) :: TraceEvent blk -> TraceEvent blk -> Bool Source # (/=) :: TraceEvent blk -> TraceEvent blk -> Bool Source #
StandardHash blk => Show ( TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods showsPrec :: Int -> TraceEvent blk -> ShowS Source # show :: TraceEvent blk -> String Source # showList :: [ TraceEvent blk] -> ShowS Source #
Generic ( TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Associated Types type Rep ( TraceEvent blk) :: Type -> Type Source # Methods from :: TraceEvent blk -> Rep ( TraceEvent blk) x Source # to :: Rep ( TraceEvent blk) x -> TraceEvent blk Source #
type Rep ( TraceEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types type Rep ( TraceEvent blk) = D1 (' MetaData "TraceEvent" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) (( C1 (' MetaCons "DBAlreadyClosed" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "BlockAlreadyHere" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( HeaderHash blk)))) :+: ( C1 (' MetaCons "Truncate" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ParseError blk)) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FsPath ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockOffset ))) :+: C1 (' MetaCons "InvalidFileNames" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ FsPath ]))))

State types

newtype BlockOffset Source #

The offset at which a block is stored in a file.

Constructors

BlockOffset
Fields unBlockOffset :: Word64

Instances

Instances details

Eq BlockOffset Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods (==) :: BlockOffset -> BlockOffset -> Bool Source # (/=) :: BlockOffset -> BlockOffset -> Bool Source #
Show BlockOffset Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods showsPrec :: Int -> BlockOffset -> ShowS Source # show :: BlockOffset -> String Source # showList :: [ BlockOffset ] -> ShowS Source #
Generic BlockOffset Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Associated Types type Rep BlockOffset :: Type -> Type Source # Methods from :: BlockOffset -> Rep BlockOffset x Source # to :: Rep BlockOffset x -> BlockOffset Source #
NoThunks BlockOffset Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods noThunks :: Context -> BlockOffset -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> BlockOffset -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy BlockOffset -> String Source #
type Rep BlockOffset Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types type Rep BlockOffset = D1 (' MetaData "BlockOffset" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' True ) ( C1 (' MetaCons "BlockOffset" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unBlockOffset") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word64 )))

newtype BlockSize Source #

Constructors

BlockSize
Fields unBlockSize :: Word32

Instances

Instances details

Eq BlockSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods (==) :: BlockSize -> BlockSize -> Bool Source # (/=) :: BlockSize -> BlockSize -> Bool Source #
Show BlockSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods showsPrec :: Int -> BlockSize -> ShowS Source # show :: BlockSize -> String Source # showList :: [ BlockSize ] -> ShowS Source #
Generic BlockSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Associated Types type Rep BlockSize :: Type -> Type Source # Methods from :: BlockSize -> Rep BlockSize x Source # to :: Rep BlockSize x -> BlockSize Source #
NoThunks BlockSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types Methods noThunks :: Context -> BlockSize -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> BlockSize -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy BlockSize -> String Source #
type Rep BlockSize Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.Types type Rep BlockSize = D1 (' MetaData "BlockSize" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' True ) ( C1 (' MetaCons "BlockSize" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unBlockSize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word32 )))

type FileId = Int Source #

The FileId is the unique identifier of each file found in the db. For example, the file blocks-42.dat has FileId 42 .

data InternalState blk h Source #

Constructors

DbClosed
DbOpen !( OpenState blk h)

Instances

Instances details

Generic ( InternalState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State Associated Types type Rep ( InternalState blk h) :: Type -> Type Source # Methods from :: InternalState blk h -> Rep ( InternalState blk h) x Source # to :: Rep ( InternalState blk h) x -> InternalState blk h Source #
( StandardHash blk, Typeable blk) => NoThunks ( InternalState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State Methods noThunks :: Context -> InternalState blk h -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> InternalState blk h -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( InternalState blk h) -> String Source #
type Rep ( InternalState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State type Rep ( InternalState blk h) = D1 (' MetaData "InternalState" "Ouroboros.Consensus.Storage.VolatileDB.Impl.State" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) ( C1 (' MetaCons "DbClosed" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "DbOpen" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( OpenState blk h))))

data OpenState blk h Source #

Internal state when the database is open.

Constructors

OpenState

Fields

currentWriteHandle :: !( Handle h)

The only open file we append blocks to.
currentWritePath :: ! FsPath

The path of the file above.
currentWriteId :: ! FileId

The FileId of the same file.
currentWriteOffset :: ! Word64

The offset of the same file.
currentMap :: !( Index blk)

The contents of each file.
currentRevMap :: !( ReverseIndex blk)

Where to find each block based on its slot number.
currentSuccMap :: !( SuccessorsIndex blk)

The successors for each block.
currentMaxSlotNo :: ! MaxSlotNo

Highest stored SlotNo.

INVARIANT: this is the cached value of: > FileInfo.maxSlotNoInFiles (Index.elems (currentMap st))

Instances

Instances details

Generic ( OpenState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State Associated Types type Rep ( OpenState blk h) :: Type -> Type Source # Methods from :: OpenState blk h -> Rep ( OpenState blk h) x Source # to :: Rep ( OpenState blk h) x -> OpenState blk h Source #
( StandardHash blk, Typeable blk) => NoThunks ( OpenState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State Methods noThunks :: Context -> OpenState blk h -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> OpenState blk h -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( OpenState blk h) -> String Source #
type Rep ( OpenState blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.State type Rep ( OpenState blk h) = D1 (' MetaData "OpenState" "Ouroboros.Consensus.Storage.VolatileDB.Impl.State" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) ( C1 (' MetaCons "OpenState" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "currentWriteHandle") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Handle h)) :: S1 (' MetaSel (' Just "currentWritePath") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 FsPath )) :: ( S1 (' MetaSel (' Just "currentWriteId") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 FileId ) :: S1 (' MetaSel (' Just "currentWriteOffset") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 ))) :: (( S1 (' MetaSel (' Just "currentMap") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Index blk)) :: S1 (' MetaSel (' Just "currentRevMap") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ReverseIndex blk))) :: ( S1 (' MetaSel (' Just "currentSuccMap") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( SuccessorsIndex blk)) :*: S1 (' MetaSel (' Just "currentMaxSlotNo") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 MaxSlotNo )))))

type ReverseIndex blk = Map ( HeaderHash blk) ( InternalBlockInfo blk) Source #

We map the header hash of each block to the InternalBlockInfo .

type SuccessorsIndex blk = Map ( ChainHash blk) ( Set ( HeaderHash blk)) Source #

For each block, we store the set of all blocks which have this block as a predecessor (set of successors).

data VolatileDBEnv m blk Source #

Constructors

forall h. Eq h => VolatileDBEnv
Fields hasFS :: !( HasFS m h) varInternalState :: !( RAWLock m ( InternalState blk h)) maxBlocksPerFile :: ! BlocksPerFile checkIntegrity :: !(blk -> Bool ) codecConfig :: !( CodecConfig blk) tracer :: !( Tracer m ( TraceEvent blk))

dbIsOpen :: InternalState blk h -> Bool Source #

State helpers

type ModifyOpenState m blk h = StateT ( OpenState blk h) ( WithTempRegistry ( OpenState blk h) m) Source #

Shorthand

appendOpenState :: forall blk m a. ( IOLike m, Typeable blk, StandardHash blk) => VolatileDBEnv m blk -> ( forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a) -> m a Source #

Append to the open state. Reads can happen concurrently with this operation.

NOTE: This is safe in terms of throwing FsErrors.

closeOpenHandles :: HasFS m h -> OpenState blk h -> m () Source #

Close the handles in the OpenState .

Idempotent, as closing a handle is idempotent.

NOTE: does not wrap FsError s and must be called within wrapFsError or tryVolatileDB .

mkOpenState :: forall m blk h. ( HasCallStack , IOLike m, GetPrevHash blk, HasBinaryBlockInfo blk, HasNestedContent Header blk, DecodeDisk blk ( ByteString -> blk), Eq h) => CodecConfig blk -> HasFS m h -> (blk -> Bool ) -> BlockValidationPolicy -> Tracer m ( TraceEvent blk) -> BlocksPerFile -> WithTempRegistry ( OpenState blk h) m ( OpenState blk h) Source #

withOpenState :: forall blk m r. ( IOLike m, StandardHash blk, Typeable blk) => VolatileDBEnv m blk -> ( forall h. HasFS m h -> OpenState blk h -> m r) -> m r Source #

Perform an action that accesses the internal state of an open database.

In case the database is closed, a ClosedDBError is thrown.

In case an UnexpectedFailure is thrown while the action is being run, the database is closed to prevent further appending to a database in a potentially inconsistent state. All other exceptions will leave the database open.

writeOpenState :: forall blk m a. ( IOLike m, Typeable blk, StandardHash blk) => VolatileDBEnv m blk -> ( forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a) -> m a Source #

Write to the open state. No reads or appends can concurrently with this operation.

NOTE: This is safe in terms of throwing FsErrors.