block_store

type AccessBlockStoreFunc ¶

type AccessBlockStoreFunc = func(ctx context.Context, released func()) (Store, func(), error)

AccessBlockStoreFunc is a function to access a BlockStoreHandle. Optionally pass a released function that may be called when the handle was released. Returns a release function.

func NewAccessBlockStoreViaBusFunc(b bus.Bus, blockStoreID string, returnIfIdle bool) AccessBlockStoreFunc

type Constructor ¶

type Constructor func(
	ctx context.Context,
	le *logrus.Entry,
) (Store, error)

Constructor constructs a block store with common parameters.

type LookupBlockStore ¶

type LookupBlockStore interface {
	// Directive indicates LookupBlockStore is a directive.
	directive.Directive

	// LookupBlockStoreId is the block store id to lookup.
	// If empty, returns all block stores on the bus.
	LookupBlockStoreId() string
}

LookupBlockStore is a directive to lookup a block store.

func NewLookupBlockStore(blockStoreId string) LookupBlockStore

type LookupBlockStoreValue ¶

type LookupBlockStoreValue = Store

LookupBlockStoreValue is the result type for LookupBlockStore. Multiple results may be pushed to the directive.

func ExLookupBlockStores(
	ctx context.Context,
	b bus.Bus,
	blockStoreId string,
	waitOne bool,
) ([]LookupBlockStoreValue, directive.Instance, directive.Reference, error)

func ExLookupFirstBlockStore(
	ctx context.Context,
	b bus.Bus,
	blockStoreId string,
	returnIfIdle bool,
	valDisposeCb func(),
) (LookupBlockStoreValue, directive.Instance, directive.Reference, error)

type Store ¶

type Store interface {
	// GetID returns the ID of the block store.
	GetID() string

	// StoreOps are the block store operations.
	block.StoreOps
}

Store is a block store with an ID and read/write functions.

func NewStore(id string, ops block.StoreOps) Store

type StoreReadThrough ¶ added in v0.57.0

type StoreReadThrough struct {
	// contains filtered or unexported fields
}

StoreReadThrough reads from a primary source, then an optional lower source. When writeback is enabled, lower hits are synchronously written to primary.

StoreReadThrough is separate from block.StoreOverlay because StoreOverlay readback is asynchronous.

func NewStoreReadThrough(primary, lower StoreSource, writeback bool) *StoreReadThrough

func (s *StoreReadThrough) BeginReadOperation(ctx context.Context) (block.StoreOps, func(), error)

func (s *StoreReadThrough) GetBlock(ctx context.Context, ref *block.BlockRef) ([]byte, bool, error)

func (s *StoreReadThrough) GetBlockExists(ctx context.Context, ref *block.BlockRef) (bool, error)

func (s *StoreReadThrough) GetBlockExistsBatch(ctx context.Context, refs []*block.BlockRef) ([]bool, error)

func (s *StoreReadThrough) GetHashType() hash.HashType

func (s *StoreReadThrough) GetSupportedFeatures() block.StoreFeature

func (*StoreReadThrough) PutBlock(context.Context, []byte, *block.PutOpts) (*block.BlockRef, bool, error)

func (*StoreReadThrough) PutBlockBatch(context.Context, []*block.PutBatchEntry) error

func (*StoreReadThrough) RmBlock(context.Context, *block.BlockRef) error

func (s *StoreReadThrough) StatBlock(ctx context.Context, ref *block.BlockRef) (*block.BlockStat, error)

func (*StoreReadThrough) Sync(context.Context) (bool, error)

type StoreSource ¶ added in v0.57.0

type StoreSource func() block.StoreOps

StoreSource resolves the current store for a read pipeline.

A nil result means that the source is unavailable and the pipeline moves to its next source.