// Licensed to the LF AI & Data foundation under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package segments /* #cgo pkg-config: milvus_core #include #include #include "common/init_c.h" #include "segcore/segcore_init_c.h" */ import "C" import ( "context" "math" "runtime" "sync" "go.uber.org/atomic" "github.com/milvus-io/milvus/pkg/v3/config" "github.com/milvus-io/milvus/pkg/v3/metrics" "github.com/milvus-io/milvus/pkg/v3/mlog" "github.com/milvus-io/milvus/pkg/v3/util/conc" "github.com/milvus-io/milvus/pkg/v3/util/hardware" "github.com/milvus-io/milvus/pkg/v3/util/paramtable" ) var ( // Use separate pool for search/query // and other operations (insert/delete/statistics/etc.) // since in concurrent situation, there operation may block each other in high payload sqp atomic.Pointer[conc.Pool[any]] sqOnce sync.Once dp atomic.Pointer[conc.Pool[any]] dynOnce sync.Once loadPool atomic.Pointer[conc.Pool[any]] loadOnce sync.Once // mutatePool serves the online write CGO path (segment Insert/Delete). // It is isolated from the load/management work on DynamicPool so that a // burst of segment loading (e.g. delta-log replay after compaction) cannot // starve online insert/delete, which would otherwise stall tSafe advancement. mutatePool atomic.Pointer[conc.Pool[any]] mutatePoolOnce sync.Once // deletePool is the outer dispatch pool for DeleteBatch fan-out across // segments. It MUST stay separate from mutatePool: each dispatched task // calls segment.Delete which submits the CGO onto mutatePool and waits, so // sharing one pool would risk a nested-submit deadlock. deletePool atomic.Pointer[conc.Pool[struct{}]] deletePoolOnce sync.Once bfPool atomic.Pointer[conc.Pool[any]] bfApplyOnce sync.Once // intentionally leaked CGO tag names cgoTagSQ = C.CString("CGO_SQ") cgoTagLoad = C.CString("CGO_LOAD") cgoTagDynamic = C.CString("CGO_DYN") cgoTagMutate = C.CString("CGO_MUTATE") ) // initSQPool initialize func initSQPool() { sqOnce.Do(func() { pt := paramtable.Get() initPoolSize := int(math.Ceil(pt.QueryNodeCfg.MaxReadConcurrency.GetAsFloat() * pt.QueryNodeCfg.CGOPoolSizeRatio.GetAsFloat())) pool := conc.NewPool[any]( initPoolSize, conc.WithPreAlloc(false), // pre alloc must be false to resize pool dynamically, use warmup to alloc worker here conc.WithDisablePurge(true), ) conc.WarmupPool(pool, func() { runtime.LockOSThread() C.SetThreadName(cgoTagSQ) }) sqp.Store(pool) pt.Watch(pt.QueryNodeCfg.MaxReadConcurrency.Key, config.NewHandler("qn.sqpool.maxconc", ResizeSQPool)) pt.Watch(pt.QueryNodeCfg.CGOPoolSizeRatio.Key, config.NewHandler("qn.sqpool.cgopoolratio", ResizeSQPool)) mlog.Info(context.TODO(), "init SQPool done", mlog.Int("size", initPoolSize)) }) } func dynamicPoolSize() int { size := hardware.GetCPUNum() * paramtable.Get().QueryNodeCfg.DynamicPoolSizeFactor.GetAsInt() if size < 1 { size = hardware.GetCPUNum() } return size } func initDynamicPool() { dynOnce.Do(func() { pt := paramtable.Get() size := dynamicPoolSize() pool := conc.NewPool[any]( size, conc.WithPreAlloc(false), conc.WithDisablePurge(false), conc.WithPreHandler(func() { runtime.LockOSThread() C.SetThreadName(cgoTagDynamic) }), // lock os thread for cgo thread disposal ) dp.Store(pool) pt.Watch(pt.QueryNodeCfg.DynamicPoolSizeFactor.Key, config.NewHandler("qn.dynamicpool.sizefactor", ResizeDynamicPool)) mlog.Info(context.TODO(), "init dynamicPool done", mlog.Int("size", size)) }) } func initLoadPool() { loadOnce.Do(func() { pt := paramtable.Get() poolSize := hardware.GetCPUNum() * pt.CommonCfg.MiddlePriorityThreadCoreCoefficient.GetAsInt() pool := conc.NewPool[any]( poolSize, conc.WithPreAlloc(false), conc.WithDisablePurge(false), conc.WithPreHandler(func() { runtime.LockOSThread() C.SetThreadName(cgoTagLoad) }), // lock os thread for cgo thread disposal ) loadPool.Store(pool) pt.Watch(pt.CommonCfg.MiddlePriorityThreadCoreCoefficient.Key, config.NewHandler("qn.loadpool.middlepriority", ResizeLoadPool)) mlog.Info(context.TODO(), "init loadPool done", mlog.Int("size", poolSize)) }) } func mutatePoolSize() int { size := hardware.GetCPUNum() * paramtable.Get().QueryNodeCfg.MutatePoolSizeFactor.GetAsInt() if size < 1 { size = hardware.GetCPUNum() } return size } func initMutatePool() { mutatePoolOnce.Do(func() { pt := paramtable.Get() size := mutatePoolSize() pool := conc.NewPool[any]( size, conc.WithPreAlloc(false), conc.WithDisablePurge(false), conc.WithPreHandler(func() { runtime.LockOSThread() C.SetThreadName(cgoTagMutate) }), // lock os thread for cgo thread disposal ) mutatePool.Store(pool) pt.Watch(pt.QueryNodeCfg.MutatePoolSizeFactor.Key, config.NewHandler("qn.mutatepool.sizefactor", ResizeMutatePool)) mlog.Info(context.TODO(), "init mutatePool done", mlog.Int("size", size)) }) } func initBFApplyPool() { bfApplyOnce.Do(func() { pt := paramtable.Get() poolSize := hardware.GetCPUNum() * pt.QueryNodeCfg.BloomFilterApplyParallelFactor.GetAsInt() pool := conc.NewPool[any]( poolSize, ) bfPool.Store(pool) pt.Watch(pt.QueryNodeCfg.BloomFilterApplyParallelFactor.Key, config.NewHandler("qn.bfapply.parallel", ResizeBFApplyPool)) }) } func deletePoolSize() int { size := hardware.GetCPUNum() * paramtable.Get().QueryNodeCfg.DeletePoolSizeFactor.GetAsInt() if size < 1 { size = hardware.GetCPUNum() } return size } func initDeletePool() { deletePoolOnce.Do(func() { pt := paramtable.Get() size := deletePoolSize() pool := conc.NewPool[struct{}](size) deletePool.Store(pool) pt.Watch(pt.QueryNodeCfg.DeletePoolSizeFactor.Key, config.NewHandler("qn.deletepool.sizefactor", ResizeDeletePool)) mlog.Info(context.TODO(), "init deletePool done", mlog.Int("size", size)) }) } // GetSQPool returns the singleton pool instance for search/query operations. func GetSQPool() *conc.Pool[any] { initSQPool() return sqp.Load() } // GetDynamicPool returns the singleton pool for dynamic cgo operations. func GetDynamicPool() *conc.Pool[any] { initDynamicPool() return dp.Load() } func GetLoadPool() *conc.Pool[any] { initLoadPool() return loadPool.Load() } func GetBFApplyPool() *conc.Pool[any] { initBFApplyPool() return bfPool.Load() } func GetDeletePool() *conc.Pool[struct{}] { initDeletePool() return deletePool.Load() } // GetMutatePool returns the singleton pool for online write cgo operations // (segment Insert/Delete). func GetMutatePool() *conc.Pool[any] { initMutatePool() return mutatePool.Load() } func ResizeSQPool(evt *config.Event) { if evt.HasUpdated { pt := paramtable.Get() newSize := int(math.Ceil(pt.QueryNodeCfg.MaxReadConcurrency.GetAsFloat() * pt.QueryNodeCfg.CGOPoolSizeRatio.GetAsFloat())) pool := GetSQPool() resizePool(pool, newSize, "SQPool") conc.WarmupPool(pool, runtime.LockOSThread) } } func ResizeLoadPool(evt *config.Event) { if evt.HasUpdated { pt := paramtable.Get() newSize := hardware.GetCPUNum() * pt.CommonCfg.MiddlePriorityThreadCoreCoefficient.GetAsInt() resizePool(GetLoadPool(), newSize, "LoadPool") } } func ResizeBFApplyPool(evt *config.Event) { if evt.HasUpdated { pt := paramtable.Get() newSize := hardware.GetCPUNum() * pt.QueryNodeCfg.BloomFilterApplyParallelFactor.GetAsInt() resizePool(GetBFApplyPool(), newSize, "BFApplyPool") } } func ResizeMutatePool(evt *config.Event) { if evt.HasUpdated { resizePool(GetMutatePool(), mutatePoolSize(), "MutatePool") } } func ResizeDynamicPool(evt *config.Event) { if evt.HasUpdated { resizePool(GetDynamicPool(), dynamicPoolSize(), "DynamicPool") } } func ResizeDeletePool(evt *config.Event) { if evt.HasUpdated { resizePool(GetDeletePool(), deletePoolSize(), "DeletePool") } } // CollectPoolStats returns current stats for all goroutine pools. // Called by PoolMetricsCollector at Prometheus scrape time (pull model). func CollectPoolStats() []metrics.PoolStats { type poolRef struct { name string pool interface { Cap() int Running() int Waiting() int } } refs := []poolRef{ {"SQPool", GetSQPool()}, {"DynamicPool", GetDynamicPool()}, {"LoadPool", GetLoadPool()}, {"MutatePool", GetMutatePool()}, {"BFApplyPool", GetBFApplyPool()}, {"DeletePool", GetDeletePool()}, } stats := make([]metrics.PoolStats, 0, len(refs)) for _, r := range refs { stats = append(stats, metrics.PoolStats{ Name: r.name, Cap: r.pool.Cap(), Running: r.pool.Running(), Waiting: r.pool.Waiting(), }) } return stats } func resizePool[T any](pool *conc.Pool[T], newSize int, tag string) { log := mlog.With( mlog.String("poolTag", tag), mlog.Int("newSize", newSize), ) if newSize <= 0 { log.Warn(context.TODO(), "cannot set pool size to non-positive value") return } err := pool.Resize(newSize) if err != nil { log.Warn(context.TODO(), "failed to resize pool", mlog.Err(err)) return } log.Info(context.TODO(), "pool resize successfully") }