writecache

Documentation

Index

• Variables
• func Get(db *bbolt.DB, key []byte) ([]byte, error)
• func IterateDB(db *bbolt.DB, f func(oid.Address) error) error
• func OpenDB(p string, ro bool, openFile func(string, int, fs.FileMode) (*os.File, error)) (*bbolt.DB, error)
• type Cache
  • func New(opts ...Option) Cache
• type Info
• type MainStorage
• type Metabase
• type Metrics
  • func DefaultMetrics() Metrics
• type Option
  • func WithBlobstor(bs MainStorage) Option
  • func WithDisableBackgroundFlush() Option
  • func WithFlushWorkersCount(c int) Option
  • func WithLogger(log *logger.Logger) Option
  • func WithMaxBatchDelay(d time.Duration) Option
  • func WithMaxBatchSize(sz int) Option
  • func WithMaxCacheSize(sz uint64) Option
  • func WithMaxObjectSize(sz uint64) Option
  • func WithMetabase(db Metabase) Option
  • func WithMetrics(metrics Metrics) Option
  • func WithNoSync(noSync bool) Option
  • func WithOpenFile(f func(string, int, fs.FileMode) (*os.File, error)) Option
  • func WithPath(path string) Option
  • func WithReportErrorFunc(f func(string, error)) Option
  • func WithSmallObjectSize(sz uint64) Option
• type StorageType
  • func (t StorageType) String() string

Variables

var (
	// ErrReadOnly is returned when Put/Write is performed in a read-only mode.
	ErrReadOnly = logicerr.New("write-cache is in read-only mode")
	// ErrDegraded is returned when writecache is in degraded mode.
	ErrDegraded = logicerr.New("write-cache is in degraded mode")
	// ErrNotInitialized is returned when write-cache is initializing.
	ErrNotInitialized = logicerr.New("write-cache is not initialized yet")
	// ErrBigObject is returned when object is too big to be placed in cache.
	ErrBigObject = errors.New("too big object")
	// ErrOutOfSpace is returned when there is no space left to put a new object.
	ErrOutOfSpace = errors.New("no space left in the write cache")
)

var ErrNoDefaultBucket = errors.New("no default bucket")

ErrNoDefaultBucket is returned by IterateDB when default bucket for objects is missing.

Functions

func Get

func Get(db *bbolt.DB, key []byte) ([]byte, error)

Get fetches object from the underlying database. Key should be a stringified address.

Returns an error of type apistatus.ObjectNotFound if the requested object is missing in db.

func IterateDB

func IterateDB(db *bbolt.DB, f func(oid.Address) error) error

IterateDB iterates over all objects stored in bbolt.DB instance and passes them to f until error return. It is assumed that db is an underlying database of some WriteCache instance.

Returns ErrNoDefaultBucket if there is no default bucket in db.

DB must not be nil and should be opened.

func OpenDB

func OpenDB(p string, ro bool, openFile func(string, int, fs.FileMode) (*os.File, error)) (*bbolt.DB, error)

OpenDB opens BoltDB instance for write-cache. Opens in read-only mode if ro is true.

Types

type Cache

type Cache interface {
	Get(ctx context.Context, address oid.Address) (*objectSDK.Object, error)
	Head(context.Context, oid.Address) (*objectSDK.Object, error)
	// Delete removes object referenced by the given oid.Address from the
	// Cache. Returns any error encountered that prevented the object to be
	// removed.
	//
	// Returns apistatus.ObjectNotFound if object is missing in the Cache.
	// Returns ErrReadOnly if the Cache is currently in the read-only mode.
	Delete(context.Context, oid.Address) error
	Put(context.Context, common.PutPrm) (common.PutRes, error)
	SetMode(mode.Mode) error
	SetLogger(*logger.Logger)
	DumpInfo() Info
	Flush(context.Context, bool, bool) error
	Seal(context.Context, bool) error

	Init() error
	Open(ctx context.Context, mode mode.Mode) error
	Close() error
	GetMetrics() Metrics
}

Cache represents write-cache for objects.

func New

func New(opts ...Option) Cache

New creates new writecache instance.

type Info

type Info struct {
	// Full path to the write-cache.
	Path string
}

Info groups the information about write-cache.

type MainStorage

type MainStorage interface {
	Compressor() *compression.Config
	Exists(context.Context, common.ExistsPrm) (common.ExistsRes, error)
	Put(context.Context, common.PutPrm) (common.PutRes, error)
}

MainStorage is the interface of the underlying storage of Cache implementations.

type Metabase

type Metabase interface {
	UpdateStorageID(context.Context, meta.UpdateStorageIDPrm) (meta.UpdateStorageIDRes, error)
}

Metabase is the interface of the metabase used by Cache implementations.

type Metrics

type Metrics interface {
	SetShardID(string)
	Get(d time.Duration, success bool, st StorageType)
	Delete(d time.Duration, success bool, st StorageType)
	Put(d time.Duration, success bool, st StorageType)
	Flush(success bool, st StorageType)
	Evict(st StorageType)

	SetEstimateSize(db, fstree uint64)
	SetMode(m mode.ComponentMode)
	SetActualCounters(db, fstree uint64)
	SetPath(path string)
	Close()
}

func DefaultMetrics

func DefaultMetrics() Metrics

type Option

type Option func(*options)

Option represents write-cache configuration option.

func WithBlobstor

func WithBlobstor(bs MainStorage) Option

WithBlobstor sets main object storage.

func WithDisableBackgroundFlush

func WithDisableBackgroundFlush() Option

WithDisableBackgroundFlush disables background flush, for testing purposes only.

func WithFlushWorkersCount

func WithFlushWorkersCount(c int) Option

func WithLogger

func WithLogger(log *logger.Logger) Option

WithLogger sets logger.

func WithMaxBatchDelay

func WithMaxBatchDelay(d time.Duration) Option

WithMaxBatchDelay sets max batch delay for the small object database.

func WithMaxBatchSize

func WithMaxBatchSize(sz int) Option

WithMaxBatchSize sets max batch size for the small object database.

func WithMaxCacheSize

func WithMaxCacheSize(sz uint64) Option

WithMaxCacheSize sets maximum write-cache size in bytes.

func WithMaxObjectSize

func WithMaxObjectSize(sz uint64) Option

WithMaxObjectSize sets maximum object size to be stored in write-cache.

func WithMetabase

func WithMetabase(db Metabase) Option

WithMetabase sets metabase.

func WithMetrics

func WithMetrics(metrics Metrics) Option

WithMetrics sets metrics implementation.

func WithNoSync

func WithNoSync(noSync bool) Option

WithNoSync sets an option to allow returning to caller on PUT before write is persisted. Note, that we use this flag for FSTree only and DO NOT use it for a bolt DB because we cannot yet properly handle the corrupted database during the startup. This SHOULD NOT be relied upon and may be changed in future.

func WithOpenFile

func WithOpenFile(f func(string, int, fs.FileMode) (*os.File, error)) Option

WithOpenFile sets the OpenFile function to use internally by bolt. Useful for hermetic testing.

func WithPath

func WithPath(path string) Option

WithPath sets path to writecache db.

func WithReportErrorFunc

func WithReportErrorFunc(f func(string, error)) Option

WithReportErrorFunc sets error reporting function.

func WithSmallObjectSize

func WithSmallObjectSize(sz uint64) Option

WithSmallObjectSize sets maximum object size to be stored in write-cache.

type StorageType

type StorageType string

const (
	StorageTypeUndefined StorageType = "null"
	StorageTypeDB        StorageType = "db"
	StorageTypeFSTree    StorageType = "fstree"
)

func (StorageType) String

func (t StorageType) String() string