Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index

Contents

Index
File-backed index
Cached index

Synopsis

data Index m blk h = Index {
- readOffsets :: forall t. ( HasCallStack , Traversable t) => ChunkNo -> t RelativeSlot -> m (t ( Maybe SecondaryOffset ))
- readFirstFilledSlot :: HasCallStack => ChunkNo -> m ( Maybe RelativeSlot )
- openPrimaryIndex :: HasCallStack => ChunkNo -> AllowExisting -> m ( Handle h)
- appendOffsets :: forall f. ( HasCallStack , Foldable f) => Handle h -> f SecondaryOffset -> m ()
- readEntries :: forall t. ( HasCallStack , Traversable t) => ChunkNo -> t ( IsEBB , SecondaryOffset ) -> m (t ( Entry blk, BlockSize ))
- readAllEntries :: HasCallStack => SecondaryOffset -> ChunkNo -> ( Entry blk -> Bool ) -> Word64 -> IsEBB -> m [ WithBlockSize ( Entry blk)]
- appendEntry :: HasCallStack => ChunkNo -> Handle h -> WithBlockSize ( Entry blk) -> m Word64
- close :: HasCallStack => m ()
- restart :: HasCallStack => ChunkNo -> m ()
}
readEntry :: Functor m => Index m blk h -> ChunkNo -> IsEBB -> SecondaryOffset -> m ( Entry blk, BlockSize )
readOffset :: Functor m => Index m blk h -> ChunkNo -> RelativeSlot -> m ( Maybe SecondaryOffset )
fileBackedIndex :: forall m blk h. ( ConvertRawHash blk, MonadCatch m, StandardHash blk, Typeable blk) => HasFS m h -> ChunkInfo -> Index m blk h
data CacheConfig = CacheConfig {
- pastChunksToCache :: Word32
- expireUnusedAfter :: DiffTime
}
cachedIndex :: forall m blk h. ( IOLike m, ConvertRawHash blk, StandardHash blk, Typeable blk) => HasFS m h -> ResourceRegistry m -> Tracer m TraceCacheEvent -> CacheConfig -> ChunkInfo -> ChunkNo -> m ( Index m blk h)

Index

data Index m blk h Source #

Bundle the operations on the primary and secondary index that touch the files. This allows us to easily introduce an intermediary caching layer.

Constructors

Index

Fields

readOffsets :: forall t. ( HasCallStack , Traversable t) => ChunkNo -> t RelativeSlot -> m (t ( Maybe SecondaryOffset ))

See readOffsets
readFirstFilledSlot :: HasCallStack => ChunkNo -> m ( Maybe RelativeSlot )

See readFirstFilledSlot
openPrimaryIndex :: HasCallStack => ChunkNo -> AllowExisting -> m ( Handle h)

See open
appendOffsets :: forall f. ( HasCallStack , Foldable f) => Handle h -> f SecondaryOffset -> m ()

See appendOffsets
readEntries :: forall t. ( HasCallStack , Traversable t) => ChunkNo -> t ( IsEBB , SecondaryOffset ) -> m (t ( Entry blk, BlockSize ))

See readEntries
readAllEntries :: HasCallStack => SecondaryOffset -> ChunkNo -> ( Entry blk -> Bool ) -> Word64 -> IsEBB -> m [ WithBlockSize ( Entry blk)]

See readAllEntries
appendEntry :: HasCallStack => ChunkNo -> Handle h -> WithBlockSize ( Entry blk) -> m Word64

See appendEntry
close :: HasCallStack => m ()

Close the index and stop any background threads.

Should be called when the ImmutableDB is closed.
restart :: HasCallStack => ChunkNo -> m ()

Restart a closed index using the given chunk as the current chunk, drop all previously cached information.

NOTE: this will only used in the testsuite, when we need to truncate.

Instances

Instances details

NoThunks ( Index m blk h) Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index Methods noThunks :: Context -> Index m blk h -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Index m blk h -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( Index m blk h) -> String Source #

readEntry :: Functor m => Index m blk h -> ChunkNo -> IsEBB -> SecondaryOffset -> m ( Entry blk, BlockSize ) Source #

See readEntry .

readOffset :: Functor m => Index m blk h -> ChunkNo -> RelativeSlot -> m ( Maybe SecondaryOffset ) Source #

See readOffset .

File-backed index

fileBackedIndex :: forall m blk h. ( ConvertRawHash blk, MonadCatch m, StandardHash blk, Typeable blk) => HasFS m h -> ChunkInfo -> Index m blk h Source #

Cached index

data CacheConfig Source #

Constructors

CacheConfig
Fields pastChunksToCache :: Word32 Maximum number of past chunks to cache, excluding the current chunk. NOTE: must be > 0 expireUnusedAfter :: DiffTime Expire past chunks that haven't been used for `$sel:expireUnusedAfter:CacheConfig` from the cache, regardless the number of past chunks in the cache.

Instances

Instances details

Eq CacheConfig Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index.Cache Methods (==) :: CacheConfig -> CacheConfig -> Bool Source # (/=) :: CacheConfig -> CacheConfig -> Bool Source #
Show CacheConfig Source #
Instance details Defined in Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index.Cache Methods showsPrec :: Int -> CacheConfig -> ShowS Source # show :: CacheConfig -> String Source # showList :: [ CacheConfig ] -> ShowS Source #

cachedIndex Source #

Arguments

:: forall m blk h. ( IOLike m, ConvertRawHash blk, StandardHash blk, Typeable blk)
=> HasFS m h
-> ResourceRegistry m
-> Tracer m TraceCacheEvent
-> CacheConfig
-> ChunkInfo
-> ChunkNo	Current chunk
-> m ( Index m blk h)

Caches the current chunk's indices as well as a number of past chunk's indices.

Spawns a background thread to expire past chunks from the cache that haven't been used for a while.