github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/block/options.go

// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package block

import (
	"github.com/m3db/m3/src/dbnode/encoding"
	"github.com/m3db/m3/src/dbnode/encoding/m3tsz"
	"github.com/m3db/m3/src/dbnode/namespace"
	"github.com/m3db/m3/src/dbnode/ts"
	"github.com/m3db/m3/src/dbnode/x/xio"
	"github.com/m3db/m3/src/x/clock"
	"github.com/m3db/m3/src/x/context"
	"github.com/m3db/m3/src/x/instrument"
	"github.com/m3db/m3/src/x/pool"
	xsync "github.com/m3db/m3/src/x/sync"
)

const (
	// defaultDatabaseBlockAllocSize is the size to allocate for values for each
	// database block, this should match the size of expected encoded values per
	// block size.
	defaultDatabaseBlockAllocSize = 1024

	// defaultCloseContextConcurrency is the default concurrency for closing
	// the context the block depends on
	defaultCloseContextConcurrency = 4096
)

type options struct {
	clockOpts               clock.Options
	databaseBlockAllocSize  int
	closeContextWorkers     xsync.WorkerPool
	databaseBlockPool       DatabaseBlockPool
	contextPool             context.Pool
	encoderPool             encoding.EncoderPool
	segmentReaderPool       xio.SegmentReaderPool
	bytesPool               pool.CheckedBytesPool
	readerIteratorPool      encoding.ReaderIteratorPool
	multiReaderIteratorPool encoding.MultiReaderIteratorPool
	wiredList               *WiredList
}

// NewOptions creates new database block options
func NewOptions() Options {
	iOpts := instrument.NewOptions()
	bytesPool := pool.NewCheckedBytesPool(nil, nil, func(s []pool.Bucket) pool.BytesPool {
		return pool.NewBytesPool(s, nil)
	})
	encoderPool := encoding.NewEncoderPool(nil)
	readerIteratorPool := encoding.NewReaderIteratorPool(nil)
	segmentReaderPool := xio.NewSegmentReaderPool(nil)
	o := &options{
		clockOpts:               clock.NewOptions(),
		databaseBlockAllocSize:  defaultDatabaseBlockAllocSize,
		closeContextWorkers:     xsync.NewWorkerPool(defaultCloseContextConcurrency),
		databaseBlockPool:       NewDatabaseBlockPool(nil),
		contextPool:             context.NewPool(context.NewOptions()),
		encoderPool:             encoderPool,
		readerIteratorPool:      readerIteratorPool,
		multiReaderIteratorPool: encoding.NewMultiReaderIteratorPool(nil),
		segmentReaderPool:       segmentReaderPool,
		bytesPool:               bytesPool,
	}
	o.closeContextWorkers.Init()
	o.databaseBlockPool.Init(func() DatabaseBlock {
		return NewDatabaseBlock(timeZero, 0, ts.Segment{}, o, namespace.Context{})
	})

	encodingOpts := encoding.NewOptions().
		SetBytesPool(bytesPool).
		SetEncoderPool(encoderPool).
		SetReaderIteratorPool(readerIteratorPool).
		SetSegmentReaderPool(segmentReaderPool).
		SetMetrics(encoding.NewMetrics(iOpts.MetricsScope()))

	o.encoderPool.Init(func() encoding.Encoder {
		return m3tsz.NewEncoder(timeZero, nil, m3tsz.DefaultIntOptimizationEnabled, encodingOpts)
	})
	o.readerIteratorPool.Init(m3tsz.DefaultReaderIteratorAllocFn(encodingOpts))
	o.multiReaderIteratorPool.Init(
		func(r xio.Reader64, descr namespace.SchemaDescr) encoding.ReaderIterator {
			it := o.readerIteratorPool.Get()
			it.Reset(r, descr)
			return it
		})
	o.segmentReaderPool.Init()
	o.bytesPool.Init()
	return o
}

func (o *options) SetClockOptions(value clock.Options) Options {
	opts := *o
	opts.clockOpts = value
	return &opts
}

func (o *options) ClockOptions() clock.Options {
	return o.clockOpts
}

func (o *options) SetDatabaseBlockAllocSize(value int) Options {
	opts := *o
	opts.databaseBlockAllocSize = value
	return &opts
}

func (o *options) DatabaseBlockAllocSize() int {
	return o.databaseBlockAllocSize
}

func (o *options) SetCloseContextWorkers(value xsync.WorkerPool) Options {
	opts := *o
	opts.closeContextWorkers = value
	return &opts
}

func (o *options) CloseContextWorkers() xsync.WorkerPool {
	return o.closeContextWorkers
}

func (o *options) SetDatabaseBlockPool(value DatabaseBlockPool) Options {
	opts := *o
	opts.databaseBlockPool = value
	return &opts
}

func (o *options) DatabaseBlockPool() DatabaseBlockPool {
	return o.databaseBlockPool
}

func (o *options) SetContextPool(value context.Pool) Options {
	opts := *o
	opts.contextPool = value
	return &opts
}

func (o *options) ContextPool() context.Pool {
	return o.contextPool
}

func (o *options) SetEncoderPool(value encoding.EncoderPool) Options {
	opts := *o
	opts.encoderPool = value
	return &opts
}

func (o *options) EncoderPool() encoding.EncoderPool {
	return o.encoderPool
}

func (o *options) SetReaderIteratorPool(value encoding.ReaderIteratorPool) Options {
	opts := *o
	opts.readerIteratorPool = value
	return &opts
}

func (o *options) ReaderIteratorPool() encoding.ReaderIteratorPool {
	return o.readerIteratorPool
}

func (o *options) SetMultiReaderIteratorPool(value encoding.MultiReaderIteratorPool) Options {
	opts := *o
	opts.multiReaderIteratorPool = value
	return &opts
}

func (o *options) MultiReaderIteratorPool() encoding.MultiReaderIteratorPool {
	return o.multiReaderIteratorPool
}

func (o *options) SetSegmentReaderPool(value xio.SegmentReaderPool) Options {
	opts := *o
	opts.segmentReaderPool = value
	return &opts
}

func (o *options) SegmentReaderPool() xio.SegmentReaderPool {
	return o.segmentReaderPool
}

func (o *options) SetBytesPool(value pool.CheckedBytesPool) Options {
	opts := *o
	opts.bytesPool = value
	return &opts
}

func (o *options) BytesPool() pool.CheckedBytesPool {
	return o.bytesPool
}

func (o *options) SetWiredList(value *WiredList) Options {
	opts := *o
	opts.wiredList = value
	return &opts
}

func (o *options) WiredList() *WiredList {
	return o.wiredList
}