github.com/benz9527/xboot@v0.0.0-20240504061247-c23f15593274/timer/options.go

package timer

import (
	"fmt"
	"log/slog"
	"math"
	"os"
	"runtime"
	"strings"
	"sync/atomic"
	"time"

	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
	"go.opentelemetry.io/otel/sdk/metric"

	"github.com/benz9527/xboot/lib/hrtime"
	"github.com/benz9527/xboot/lib/id"
)

const (
	defaultMinEventBufferSize          = 1024
	defaultMinWorkerPoolSize           = 128
	defaultMinSlotIncrementSize        = 10
	defaultMinIntervalMilliseconds     = 20 // lt 20ms will overflow
	defaultMinTickAccuracyMilliseconds = 1
)

type xTimingWheelsOption struct {
	name           string
	basicTickMs    int64
	slotIncrSize   int64
	idGenerator    id.Gen
	stats          *xTimingWheelsStats
	clock          hrtime.Clock
	bufferSize     int
	workPoolSize   int
	isValueChecked *atomic.Bool
	enableStats    bool
}

func (opt *xTimingWheelsOption) getBasicTickMilliseconds() int64 {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.basicTickMs < defaultMinTickAccuracyMilliseconds {
		return defaultMinTickAccuracyMilliseconds
	}
	return opt.basicTickMs
}

func (opt *xTimingWheelsOption) getEventBufferSize() int {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.bufferSize < defaultMinEventBufferSize {
		return defaultMinEventBufferSize
	}
	return opt.bufferSize
}

func (opt *xTimingWheelsOption) getSlotIncrementSize() int64 {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.slotIncrSize < defaultMinSlotIncrementSize {
		return defaultMinSlotIncrementSize
	}
	return opt.slotIncrSize
}

func (opt *xTimingWheelsOption) getWorkerPoolSize() int {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.workPoolSize < defaultMinWorkerPoolSize {
		return defaultMinWorkerPoolSize
	}
	return opt.workPoolSize
}

func (opt *xTimingWheelsOption) getExpiredSlotBufferSize() int {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	return int(opt.getSlotIncrementSize() + 8)
}

func (opt *xTimingWheelsOption) getClock() hrtime.Clock {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.clock == nil {
		return hrtime.SdkClock
	}
	return opt.clock
}

func (opt *xTimingWheelsOption) getIDGenerator() id.Gen {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.idGenerator == nil {
		gen, err := id.MonotonicNonZeroID()
		if err != nil {
			panic(err)
		}
		opt.idGenerator = gen.Number
	}
	return opt.idGenerator
}

func (opt *xTimingWheelsOption) getStats() *xTimingWheelsStats {
	return opt.stats
}

func (opt *xTimingWheelsOption) defaultDelayQueueCapacity() int {
	return 128
}

func (opt *xTimingWheelsOption) getName() string {
	if opt.isValueChecked == nil || !opt.isValueChecked.Load() {
		panic("value unchecked")
	}
	if opt.name == "" {
		return fmt.Sprintf("xtw-%s-%d", runtime.GOOS, opt.getIDGenerator()())
	}
	return opt.name
}

func (opt *xTimingWheelsOption) Validate() {
	opt.isValueChecked = &atomic.Bool{}
	if opt.basicTickMs < 1 {
		opt.basicTickMs = defaultMinTickAccuracyMilliseconds
		slog.Warn("[x-timing-wheels options] adjust the tick accuracy milliseconds", "from", 0, "to", opt.basicTickMs)
	}
	if opt.basicTickMs > 0 && opt.slotIncrSize > 0 &&
		opt.basicTickMs*opt.slotIncrSize < defaultMinIntervalMilliseconds {
		from := opt.slotIncrSize
		opt.slotIncrSize = int64(math.Ceil(float64(defaultMinIntervalMilliseconds) / float64(opt.basicTickMs)))
		slog.Warn("[x-timing-wheels options] adjust the slot increment size", "from", from, "to", opt.slotIncrSize)
	}
	if opt.basicTickMs >= 1 && opt.slotIncrSize < 1 {
		opt.slotIncrSize = int64(math.Ceil(float64(defaultMinIntervalMilliseconds) / float64(opt.basicTickMs)))
		slog.Warn("[x-timing-wheels options] adjust the slot increment size", "from", 0, "to", opt.slotIncrSize)
	}
	opt.isValueChecked.Store(true)
	if opt.enableStats {
		opt.stats = newTimingWheelStats(opt)
	}
}

type TimingWheelsOption func(option *xTimingWheelsOption)

func WithTimingWheelsTickMs(basicTickMs time.Duration) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		if basicTickMs.Milliseconds() < defaultMinTickAccuracyMilliseconds {
			panic(fmt.Sprintf("timing-wheels' tick accuracy must be greater than or equals to %dms", defaultMinTickAccuracyMilliseconds))
		}
		opt.basicTickMs = basicTickMs.Milliseconds()
	}
}

func WithTimingWheelsSlotSize(slotSize int64) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		if slotSize < 1 {
			panic("empty slot increment size")
		}
		opt.slotIncrSize = slotSize
	}
}

func WithTimingWheelsName(name string) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		if len(strings.TrimSpace(name)) <= 0 {
			panic("timing-wheels' name must not be empty or blank")
		}
		opt.name = name
	}
}

func WithTimingWheelsIDGen(gen id.Gen) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		opt.idGenerator = gen
	}
}

func WithTimingWheelsStats() TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		opt.enableStats = true
	}
}

func WithTimingWheelsWorkerPoolSize(poolSize int) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		if poolSize < defaultMinWorkerPoolSize {
			panic(fmt.Sprintf("timing-wheels' work pool size must be greater than or equals to %d", defaultMinWorkerPoolSize))
		}
		opt.workPoolSize = poolSize
	}
}

func WithTimingWheelsEventBufferSize(size int) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		if size < defaultMinEventBufferSize {
			panic(fmt.Sprintf("timing-wheels' event buffer size must be greater than or equals to %d", defaultMinEventBufferSize))
		}
		opt.bufferSize = size
	}
}

func withTimingWheelsDebugStatsInit(interval int64) TimingWheelsOption {
	return func(opt *xTimingWheelsOption) {
		_, debugLogDisabled := os.LookupEnv("DISABLE_TEST_DEBUG_LOG")
		if debugLogDisabled {
			return
		}

		exp, err := stdoutmetric.New(
			stdoutmetric.WithWriter(os.Stdout),
		)
		if err != nil {
			panic(err)
		}
		mp := metric.NewMeterProvider(metric.WithReader(metric.NewPeriodicReader(exp, metric.WithInterval(time.Duration(interval)*time.Second))))
		otel.SetMeterProvider(mp)
	}
}