// Copyright (C) 2019-2020 Zilliz. All rights reserved. // // Licensed 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 indexservice import ( "context" "errors" "math/rand" "sync" "time" "go.uber.org/zap" "github.com/zilliztech/milvus-distributed/internal/allocator" "github.com/zilliztech/milvus-distributed/internal/kv" etcdkv "github.com/zilliztech/milvus-distributed/internal/kv/etcd" miniokv "github.com/zilliztech/milvus-distributed/internal/kv/minio" "github.com/zilliztech/milvus-distributed/internal/log" "github.com/zilliztech/milvus-distributed/internal/proto/commonpb" "github.com/zilliztech/milvus-distributed/internal/proto/indexpb" "github.com/zilliztech/milvus-distributed/internal/proto/internalpb" "github.com/zilliztech/milvus-distributed/internal/proto/milvuspb" "github.com/zilliztech/milvus-distributed/internal/tso" "github.com/zilliztech/milvus-distributed/internal/util/retry" "github.com/zilliztech/milvus-distributed/internal/util/tsoutil" "github.com/zilliztech/milvus-distributed/internal/util/typeutil" "go.etcd.io/etcd/clientv3" ) const ( reqTimeoutInterval = time.Second * 10 durationInterval = time.Second * 10 dropIndexLimit = 20 ) type IndexService struct { nodeClients *PriorityQueue nodeStates map[UniqueID]*internalpb.ComponentStates stateCode internalpb.StateCode ID UniqueID loopCtx context.Context loopCancel func() loopWg sync.WaitGroup sched *TaskScheduler idAllocator *allocator.GlobalIDAllocator kv kv.BaseKV metaTable *metaTable nodeLock sync.RWMutex // Add callback functions at different stages startCallbacks []func() closeCallbacks []func() } type UniqueID = typeutil.UniqueID type Timestamp = typeutil.Timestamp func NewIndexService(ctx context.Context) (*IndexService, error) { rand.Seed(time.Now().UnixNano()) ctx1, cancel := context.WithCancel(ctx) i := &IndexService{ loopCtx: ctx1, loopCancel: cancel, nodeClients: &PriorityQueue{}, } return i, nil } func (i *IndexService) Init() error { etcdAddress := Params.EtcdAddress log.Debug("indexservice", zap.String("etcd address", etcdAddress)) connectEtcdFn := func() error { etcdClient, err := clientv3.New(clientv3.Config{Endpoints: []string{etcdAddress}}) if err != nil { return err } etcdKV := etcdkv.NewEtcdKV(etcdClient, Params.MetaRootPath) metakv, err := NewMetaTable(etcdKV) if err != nil { return err } i.metaTable = metakv return nil } err := retry.Retry(100000, time.Millisecond*200, connectEtcdFn) if err != nil { return err } //init idAllocator kvRootPath := Params.KvRootPath i.idAllocator = allocator.NewGlobalIDAllocator("idTimestamp", tsoutil.NewTSOKVBase([]string{etcdAddress}, kvRootPath, "index_gid")) if err := i.idAllocator.Initialize(); err != nil { return err } i.ID, err = i.idAllocator.AllocOne() if err != nil { return err } option := &miniokv.Option{ Address: Params.MinIOAddress, AccessKeyID: Params.MinIOAccessKeyID, SecretAccessKeyID: Params.MinIOSecretAccessKey, UseSSL: Params.MinIOUseSSL, BucketName: Params.MinioBucketName, CreateBucket: true, } i.kv, err = miniokv.NewMinIOKV(i.loopCtx, option) if err != nil { return err } i.sched, err = NewTaskScheduler(i.loopCtx, i.idAllocator, i.kv, i.metaTable) if err != nil { return err } i.UpdateStateCode(internalpb.StateCode_Healthy) return nil } func (i *IndexService) Start() error { i.loopWg.Add(1) go i.tsLoop() i.loopWg.Add(1) go i.dropIndexLoop() i.sched.Start() // Start callbacks for _, cb := range i.startCallbacks { cb() } log.Debug("IndexService start") return nil } func (i *IndexService) Stop() error { i.loopCancel() i.sched.Close() for _, cb := range i.closeCallbacks { cb() } return nil } func (i *IndexService) UpdateStateCode(code internalpb.StateCode) { i.stateCode = code } func (i *IndexService) GetComponentStates(ctx context.Context) (*internalpb.ComponentStates, error) { log.Debug("get indexservice component states ...") stateInfo := &internalpb.ComponentInfo{ NodeID: i.ID, Role: "IndexService", StateCode: i.stateCode, } ret := &internalpb.ComponentStates{ State: stateInfo, SubcomponentStates: nil, // todo add subcomponents states Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, }, } return ret, nil } func (i *IndexService) GetTimeTickChannel(ctx context.Context) (*milvuspb.StringResponse, error) { log.Debug("get indexservice time tick channel ...") return &milvuspb.StringResponse{ Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, Reason: "", }, Value: "", }, nil } func (i *IndexService) GetStatisticsChannel(ctx context.Context) (*milvuspb.StringResponse, error) { log.Debug("get indexservice statistics channel ...") return &milvuspb.StringResponse{ Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, Reason: "", }, Value: "", }, nil } func (i *IndexService) BuildIndex(ctx context.Context, req *indexpb.BuildIndexRequest) (*indexpb.BuildIndexResponse, error) { log.Debug("indexservice building index ...", zap.Int64("IndexBuildID", req.IndexBuildID), zap.String("IndexName = ", req.IndexName), zap.Int64("IndexID = ", req.IndexID), zap.Strings("DataPath = ", req.DataPaths), zap.Any("TypeParams", req.TypeParams), zap.Any("IndexParams", req.IndexParams)) ret := &indexpb.BuildIndexResponse{ Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_UnexpectedError, }, } t := &IndexAddTask{ BaseTask: BaseTask{ ctx: ctx, done: make(chan error), table: i.metaTable, }, req: req, idAllocator: i.idAllocator, kv: i.kv, } if i.nodeClients == nil || i.nodeClients.Len() <= 0 { ret.Status.Reason = "IndexBuilding Service not available" return ret, nil } t.nodeClients = i.nodeClients var cancel func() t.ctx, cancel = context.WithTimeout(ctx, reqTimeoutInterval) defer cancel() fn := func() error { select { case <-ctx.Done(): return errors.New("IndexAddQueue enqueue timeout") default: return i.sched.IndexAddQueue.Enqueue(t) } } err := fn() if err != nil { ret.Status.ErrorCode = commonpb.ErrorCode_UnexpectedError ret.Status.Reason = err.Error() return ret, nil } err = t.WaitToFinish() if err != nil { ret.Status.ErrorCode = commonpb.ErrorCode_UnexpectedError ret.Status.Reason = err.Error() return ret, nil } ret.Status.ErrorCode = commonpb.ErrorCode_Success ret.IndexBuildID = t.indexBuildID return ret, nil } func (i *IndexService) GetIndexStates(ctx context.Context, req *indexpb.GetIndexStatesRequest) (*indexpb.GetIndexStatesResponse, error) { log.Debug("get index states ...", zap.Int64s("IndexBuildIDs", req.IndexBuildIDs)) var indexStates []*indexpb.IndexInfo for _, indexID := range req.IndexBuildIDs { indexState, err := i.metaTable.GetIndexState(indexID) if err != nil { indexState.Reason = err.Error() } indexStates = append(indexStates, indexState) } ret := &indexpb.GetIndexStatesResponse{ Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, }, States: indexStates, } log.Debug("get index states success") log.Debug("get index states", zap.Any("index status", ret.Status), zap.Any("index states", ret.States)) return ret, nil } func (i *IndexService) DropIndex(ctx context.Context, req *indexpb.DropIndexRequest) (*commonpb.Status, error) { log.Debug("IndexService", zap.Int64("Drop Index ID", req.IndexID)) ret := &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, } err := i.metaTable.MarkIndexAsDeleted(req.IndexID) if err != nil { ret.ErrorCode = commonpb.ErrorCode_UnexpectedError ret.Reason = err.Error() return ret, nil } defer func() { go func() { unissuedIndexBuildIDs := i.sched.IndexAddQueue.tryToRemoveUselessIndexAddTask(req.IndexID) for _, indexBuildID := range unissuedIndexBuildIDs { i.metaTable.DeleteIndex(indexBuildID) } }() go func() { allNodeClients := i.nodeClients.PeekAllClients() for _, client := range allNodeClients { client.DropIndex(ctx, req) } }() }() log.Debug("IndexService", zap.Int64("DropIndex success by ID", req.IndexID)) return ret, nil } func (i *IndexService) GetIndexFilePaths(ctx context.Context, req *indexpb.GetIndexFilePathsRequest) (*indexpb.GetIndexFilePathsResponse, error) { log.Debug("indexservice", zap.Int64s("get index file paths", req.IndexBuildIDs)) var indexPaths []*indexpb.IndexFilePathInfo = nil for _, indexID := range req.IndexBuildIDs { indexPathInfo, err := i.metaTable.GetIndexFilePathInfo(indexID) if err != nil { return nil, err } indexPaths = append(indexPaths, indexPathInfo) } log.Debug("indexservice, get index file paths success") ret := &indexpb.GetIndexFilePathsResponse{ Status: &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, }, FilePaths: indexPaths, } log.Debug("indexservice", zap.Any("index file paths", ret.FilePaths)) return ret, nil } func (i *IndexService) NotifyBuildIndex(ctx context.Context, nty *indexpb.NotifyBuildIndexRequest) (*commonpb.Status, error) { log.Debug("IndexService", zap.Int64("notify build index", nty.IndexBuildID), zap.Strings("index file paths", nty.IndexFilePaths), zap.Int64("node ID", nty.NodeID)) ret := &commonpb.Status{ ErrorCode: commonpb.ErrorCode_Success, } log.Debug("IndexService", zap.String("[IndexService][NotifyBuildIndex]", nty.String())) if err := i.metaTable.NotifyBuildIndex(nty); err != nil { ret.ErrorCode = commonpb.ErrorCode_BuildIndexError ret.Reason = err.Error() log.Debug("IndexService", zap.String("[IndexService][NotifyBuildIndex][metaTable][NotifyBuildIndex]", err.Error())) } log.Debug("IndexService", zap.Any("Index build completed with ID", nty.IndexBuildID)) i.nodeClients.IncPriority(nty.NodeID, -1) return ret, nil } func (i *IndexService) tsLoop() { tsoTicker := time.NewTicker(tso.UpdateTimestampStep) defer tsoTicker.Stop() ctx, cancel := context.WithCancel(i.loopCtx) defer cancel() defer i.loopWg.Done() for { select { case <-tsoTicker.C: if err := i.idAllocator.UpdateID(); err != nil { log.Debug("indexservice", zap.String("failed to update id", err.Error())) return } case <-ctx.Done(): // Server is closed and it should return nil. log.Debug("tsLoop is closed") return } } } func (i *IndexService) dropIndexLoop() { ctx, cancel := context.WithCancel(i.loopCtx) defer cancel() defer i.loopWg.Done() timeTicker := time.NewTicker(durationInterval) log.Debug("IndexService start drop index loop") for { select { case <-ctx.Done(): return case <-timeTicker.C: indexMetas := i.metaTable.getMarkDeleted(dropIndexLimit) for j := 0; j < len(indexMetas); j++ { if err := i.kv.MultiRemove(indexMetas[j].IndexFilePaths); err != nil { log.Debug("IndexService", zap.String("Remove index files error", err.Error())) } i.metaTable.DeleteIndex(indexMetas[j].IndexBuildID) } } } }