milvus/internal/querynodev2/pkoracle/pk_oracle.go

// 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.

// pkoracle package contains pk - segment mapping logic.
package pkoracle

import (
	"fmt"
	"sync"

	"github.com/milvus-io/milvus/internal/storage"
	"github.com/milvus-io/milvus/pkg/log"
	"github.com/milvus-io/milvus/pkg/util/typeutil"
)

// PkOracle interface for pk oracle.
type PkOracle interface {
	// GetCandidates returns segment candidates of which pk might belongs to.
	Get(pk storage.PrimaryKey, filters ...CandidateFilter) ([]int64, error)
	// RegisterCandidate adds candidate into pkOracle.
	Register(candidate Candidate, workerID int64) error
	// RemoveCandidate removes candidate
	Remove(filters ...CandidateFilter) error
	// CheckCandidate checks whether candidate with provided key exists.
	Exists(candidate Candidate, workerID int64) bool
}

var _ PkOracle = (*pkOracle)(nil)

// pkOracle implementation.
type pkOracle struct {
	candidates *typeutil.ConcurrentMap[string, candidateWithWorker]

	hashFuncNumMutex sync.RWMutex
	maxHashFuncNum   uint
}

func (pko *pkOracle) GetMaxHashFuncNum() uint {
	pko.hashFuncNumMutex.RLock()
	defer pko.hashFuncNumMutex.RUnlock()
	return pko.maxHashFuncNum
}

func (pko *pkOracle) TryUpdateHashFuncNum(newValue uint) {
	pko.hashFuncNumMutex.Lock()
	defer pko.hashFuncNumMutex.Unlock()
	if newValue > pko.maxHashFuncNum {
		pko.maxHashFuncNum = newValue
	}
}

// Get implements PkOracle.
func (pko *pkOracle) Get(pk storage.PrimaryKey, filters ...CandidateFilter) ([]int64, error) {
	var result []int64
	var locations []uint64

	pko.candidates.Range(func(key string, candidate candidateWithWorker) bool {
		for _, filter := range filters {
			if !filter(candidate) {
				return true
			}
		}

		if locations == nil {
			locations = storage.Locations(pk, pko.GetMaxHashFuncNum())
			if len(locations) == 0 {
				log.Warn("pkOracle: no location found for pk")
				return true
			}
		}

		if candidate.TestLocations(pk, locations) {
			result = append(result, candidate.ID())
		}
		return true
	})

	return result, nil
}

func (pko *pkOracle) candidateKey(candidate Candidate, workerID int64) string {
	return fmt.Sprintf("%s-%d-%d", candidate.Type().String(), workerID, candidate.ID())
}

// Register register candidate
func (pko *pkOracle) Register(candidate Candidate, workerID int64) error {
	pko.TryUpdateHashFuncNum(candidate.GetHashFuncNum())
	pko.candidates.Insert(pko.candidateKey(candidate, workerID), candidateWithWorker{
		Candidate: candidate,
		workerID:  workerID,
	})

	return nil
}

// Remove removes candidate from pko.
func (pko *pkOracle) Remove(filters ...CandidateFilter) error {
	max := uint(0)
	pko.candidates.Range(func(key string, candidate candidateWithWorker) bool {
		for _, filter := range filters {
			if !filter(candidate) {
				return true
			}
		}
		pko.candidates.GetAndRemove(pko.candidateKey(candidate, candidate.workerID))
		if candidate.GetHashFuncNum() > max {
			max = candidate.GetHashFuncNum()
		}

		return true
	})

	pko.TryUpdateHashFuncNum(max)
	return nil
}

func (pko *pkOracle) Exists(candidate Candidate, workerID int64) bool {
	_, ok := pko.candidates.Get(pko.candidateKey(candidate, workerID))
	return ok
}

// NewPkOracle returns pkOracle as PkOracle interface.
func NewPkOracle() PkOracle {
	return &pkOracle{
		candidates: typeutil.NewConcurrentMap[string, candidateWithWorker](),
	}
}