milvus/internal/datacoord/compaction_util.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.

package datacoord

import (
	"google.golang.org/protobuf/proto"

	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
	"github.com/milvus-io/milvus/internal/datacoord/allocator"
	"github.com/milvus-io/milvus/internal/util/hookutil"
	"github.com/milvus-io/milvus/internal/util/importutilv2"
	"github.com/milvus-io/milvus/pkg/v2/proto/datapb"
	"github.com/milvus-io/milvus/pkg/v2/proto/workerpb"
	"github.com/milvus-io/milvus/pkg/v2/util/paramtable"
)

// PreAllocateBinlogIDs pre-allocates binlog IDs based on the total number of binlogs from
// the segments for compaction, multiplied by an expansion factor.
func PreAllocateBinlogIDs(allocator allocator.Allocator, segmentInfos []*SegmentInfo) (*datapb.IDRange, error) {
	binlogNum := 0
	for _, s := range segmentInfos {
		for _, l := range s.GetBinlogs() {
			binlogNum += len(l.GetBinlogs())
		}
		for _, l := range s.GetDeltalogs() {
			binlogNum += len(l.GetBinlogs())
		}
		for _, l := range s.GetStatslogs() {
			binlogNum += len(l.GetBinlogs())
		}
		for _, l := range s.GetBm25Statslogs() {
			binlogNum += len(l.GetBinlogs())
		}
	}
	n := binlogNum * paramtable.Get().DataCoordCfg.CompactionPreAllocateIDExpansionFactor.GetAsInt()
	begin, end, err := allocator.AllocN(int64(n))
	return &datapb.IDRange{Begin: begin, End: end}, err
}

func WrapPluginContextWithImport(collectionID int64, dbProperties []*commonpb.KeyValuePair, options importutilv2.Options, msg proto.Message) {
	pluginContext := make([]*commonpb.KeyValuePair, 0)

	importEzk, _ := importutilv2.GetEZK(options)
	readPluginContext := hookutil.GetReadStoragePluginContext(importEzk)
	if readPluginContext != nil {
		pluginContext = append(pluginContext, readPluginContext...)
	}

	writePluginContext := hookutil.GetStoragePluginContext(dbProperties, collectionID)
	if writePluginContext != nil {
		pluginContext = append(pluginContext, writePluginContext...)
	}

	if len(pluginContext) == 0 {
		return
	}

	switch msg.(type) {
	case *datapb.ImportRequest:
		job := msg.(*datapb.ImportRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	case *datapb.PreImportRequest:
		job := msg.(*datapb.PreImportRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	default:
		return
	}
}

func WrapPluginContext(collectionID int64, properties []*commonpb.KeyValuePair, msg proto.Message) {
	pluginContext := hookutil.GetStoragePluginContext(properties, collectionID)
	if pluginContext == nil {
		return
	}

	switch msg.(type) {
	case *datapb.CompactionPlan:
		plan := msg.(*datapb.CompactionPlan)
		plan.PluginContext = append(plan.PluginContext, pluginContext...)
	case *workerpb.CreateJobRequest:
		job := msg.(*workerpb.CreateJobRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	case *workerpb.AnalyzeRequest:
		job := msg.(*workerpb.AnalyzeRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	case *workerpb.CreateStatsRequest:
		job := msg.(*workerpb.CreateStatsRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	case *datapb.ImportRequest:
		job := msg.(*datapb.ImportRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	case *datapb.PreImportRequest:
		job := msg.(*datapb.PreImportRequest)
		job.PluginContext = append(job.PluginContext, pluginContext...)
	default:
		return
	}
}

// isCompactionTaskFinished returns true if the task has reached a terminal state
// (timeout, completed, cleaned, or unknown) and requires no further processing.
func isCompactionTaskFinished(t *datapb.CompactionTask) bool {
	switch t.GetState() {
	case datapb.CompactionTaskState_timeout,
		datapb.CompactionTaskState_completed,
		datapb.CompactionTaskState_cleaned,
		datapb.CompactionTaskState_unknown:
		return true
	default:
		return false
	}
}

// isCompactionTaskCleaned returns true if the task has been cleaned
// (cleaned, or unknown) and requires no further processing.
func isCompactionTaskCleaned(t *datapb.CompactionTask) bool {
	switch t.GetState() {
	case datapb.CompactionTaskState_cleaned,
		datapb.CompactionTaskState_unknown:
		return true
	default:
		return false
	}
}