forked from TrueCloudLab/frostfs-node
176 lines
4.9 KiB
Go
176 lines
4.9 KiB
Go
package writecache
|
|
|
|
import (
|
|
"context"
|
|
"io/fs"
|
|
"os"
|
|
"time"
|
|
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/local_object_storage/blobstor"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/local_object_storage/blobstor/common"
|
|
meta "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/local_object_storage/metabase"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/util/logger"
|
|
objectSDK "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object"
|
|
"go.uber.org/zap"
|
|
)
|
|
|
|
// Option represents write-cache configuration option.
|
|
type Option func(*options)
|
|
|
|
// meta is an interface for a metabase.
|
|
type metabase interface {
|
|
Exists(context.Context, meta.ExistsPrm) (meta.ExistsRes, error)
|
|
StorageID(context.Context, meta.StorageIDPrm) (meta.StorageIDRes, error)
|
|
UpdateStorageID(meta.UpdateStorageIDPrm) (meta.UpdateStorageIDRes, error)
|
|
}
|
|
|
|
// blob is an interface for the blobstor.
|
|
type blob interface {
|
|
Put(context.Context, common.PutPrm) (common.PutRes, error)
|
|
NeedsCompression(obj *objectSDK.Object) bool
|
|
Exists(ctx context.Context, res common.ExistsPrm) (common.ExistsRes, error)
|
|
}
|
|
|
|
type options struct {
|
|
log *logger.Logger
|
|
// path is a path to a directory for write-cache.
|
|
path string
|
|
// blobstor is the main persistent storage.
|
|
blobstor blob
|
|
// metabase is the metabase instance.
|
|
metabase metabase
|
|
// maxObjectSize is the maximum size of the object stored in the write-cache.
|
|
maxObjectSize uint64
|
|
// smallObjectSize is the maximum size of the object stored in the database.
|
|
smallObjectSize uint64
|
|
// workersCount is the number of workers flushing objects in parallel.
|
|
workersCount int
|
|
// maxCacheSize is the maximum total size of all objects saved in cache (DB + FS).
|
|
// 1 GiB by default.
|
|
maxCacheSize uint64
|
|
// objCounters contains atomic counters for the number of objects stored in cache.
|
|
objCounters counters
|
|
// maxBatchSize is the maximum batch size for the small object database.
|
|
maxBatchSize int
|
|
// maxBatchDelay is the maximum batch wait time for the small object database.
|
|
maxBatchDelay time.Duration
|
|
// noSync is true iff FSTree allows unsynchronized writes.
|
|
noSync bool
|
|
// reportError is the function called when encountering disk errors in background workers.
|
|
reportError func(string, error)
|
|
// openFile is the function called internally by bbolt to open database files. Useful for hermetic testing.
|
|
openFile func(string, int, fs.FileMode) (*os.File, error)
|
|
// metrics is metrics implementation
|
|
metrics Metrics
|
|
}
|
|
|
|
// WithLogger sets logger.
|
|
func WithLogger(log *logger.Logger) Option {
|
|
return func(o *options) {
|
|
o.log = &logger.Logger{Logger: log.With(zap.String("component", "WriteCache"))}
|
|
}
|
|
}
|
|
|
|
// WithPath sets path to writecache db.
|
|
func WithPath(path string) Option {
|
|
return func(o *options) {
|
|
o.path = path
|
|
}
|
|
}
|
|
|
|
// WithBlobstor sets main object storage.
|
|
func WithBlobstor(bs *blobstor.BlobStor) Option {
|
|
return func(o *options) {
|
|
o.blobstor = bs
|
|
}
|
|
}
|
|
|
|
// WithMetabase sets metabase.
|
|
func WithMetabase(db *meta.DB) Option {
|
|
return func(o *options) {
|
|
o.metabase = db
|
|
}
|
|
}
|
|
|
|
// WithMaxObjectSize sets maximum object size to be stored in write-cache.
|
|
func WithMaxObjectSize(sz uint64) Option {
|
|
return func(o *options) {
|
|
if sz > 0 {
|
|
o.maxObjectSize = sz
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithSmallObjectSize sets maximum object size to be stored in write-cache.
|
|
func WithSmallObjectSize(sz uint64) Option {
|
|
return func(o *options) {
|
|
if sz > 0 {
|
|
o.smallObjectSize = sz
|
|
}
|
|
}
|
|
}
|
|
|
|
func WithFlushWorkersCount(c int) Option {
|
|
return func(o *options) {
|
|
if c > 0 {
|
|
o.workersCount = c
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithMaxCacheSize sets maximum write-cache size in bytes.
|
|
func WithMaxCacheSize(sz uint64) Option {
|
|
return func(o *options) {
|
|
o.maxCacheSize = sz
|
|
}
|
|
}
|
|
|
|
// WithMaxBatchSize sets max batch size for the small object database.
|
|
func WithMaxBatchSize(sz int) Option {
|
|
return func(o *options) {
|
|
if sz > 0 {
|
|
o.maxBatchSize = sz
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithMaxBatchDelay sets max batch delay for the small object database.
|
|
func WithMaxBatchDelay(d time.Duration) Option {
|
|
return func(o *options) {
|
|
if d > 0 {
|
|
o.maxBatchDelay = d
|
|
}
|
|
}
|
|
}
|
|
|
|
// 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 WithNoSync(noSync bool) Option {
|
|
return func(o *options) {
|
|
o.noSync = noSync
|
|
}
|
|
}
|
|
|
|
// WithReportErrorFunc sets error reporting function.
|
|
func WithReportErrorFunc(f func(string, error)) Option {
|
|
return func(o *options) {
|
|
o.reportError = f
|
|
}
|
|
}
|
|
|
|
// WithOpenFile sets the OpenFile function to use internally by bolt. Useful for hermetic testing.
|
|
func WithOpenFile(f func(string, int, fs.FileMode) (*os.File, error)) Option {
|
|
return func(o *options) {
|
|
o.openFile = f
|
|
}
|
|
}
|
|
|
|
// WithMetrics sets metrics implementation.
|
|
func WithMetrics(metrics Metrics) Option {
|
|
return func(o *options) {
|
|
o.metrics = metrics
|
|
}
|
|
}
|