// 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 #pragma once #include "common/Types.h" #include "common/Schema.h" #include "query/Plan.h" #include "common/Span.h" #include "FieldIndexing.h" #include #include "common/SystemProperty.h" #include "query/PlanNode.h" namespace milvus::segcore { // common interface of SegmentSealed and SegmentGrowing // used by C API class SegmentInterface { public: // fill results according to target_entries in plan virtual void FillTargetEntry(const query::Plan* plan, QueryResult& results) const = 0; virtual QueryResult Search(const query::Plan* Plan, const query::PlaceholderGroup* placeholder_groups[], const Timestamp timestamps[], int64_t num_groups) const = 0; virtual int64_t GetMemoryUsageInBytes() const = 0; virtual int64_t get_row_count() const = 0; virtual const Schema& get_schema() const = 0; virtual ~SegmentInterface() = default; protected: }; // internal API for DSL calculation // only for implementation class SegmentInternalInterface : public SegmentInterface { public: template Span chunk_data(FieldOffset field_offset, int64_t chunk_id) const { return static_cast>(chunk_data_impl(field_offset, chunk_id)); } template const knowhere::scalar::StructuredIndex& chunk_scalar_index(FieldOffset field_offset, int64_t chunk_id) const { static_assert(IsScalar); using IndexType = knowhere::scalar::StructuredIndex; auto base_ptr = chunk_index_impl(field_offset, chunk_id); auto ptr = dynamic_cast(base_ptr); AssertInfo(ptr, "entry mismatch"); return *ptr; } QueryResult Search(const query::Plan* Plan, const query::PlaceholderGroup* placeholder_groups[], const Timestamp timestamps[], int64_t num_groups) const override; void FillTargetEntry(const query::Plan* plan, QueryResult& results) const override; public: virtual void vector_search(int64_t vec_count, query::QueryInfo query_info, const void* query_data, int64_t query_count, const BitsetView& bitset, QueryResult& output) const = 0; // count of chunk that has index available virtual int64_t num_chunk_index(FieldOffset field_offset) const = 0; // count of chunks virtual int64_t num_chunk() const = 0; // element size in each chunk virtual int64_t size_per_chunk() const = 0; protected: // internal API: return chunk_data in span virtual SpanBase chunk_data_impl(FieldOffset field_offset, int64_t chunk_id) const = 0; // internal API: return chunk_index in span, support scalar index only virtual const knowhere::Index* chunk_index_impl(FieldOffset field_offset, int64_t chunk_id) const = 0; // calculate output[i] = Vec[seg_offsets[i]}, where Vec binds to system_type virtual void bulk_subscript(SystemFieldType system_type, const int64_t* seg_offsets, int64_t count, void* output) const = 0; // calculate output[i] = Vec[seg_offsets[i]}, where Vec binds to field_offset virtual void bulk_subscript(FieldOffset field_offset, const int64_t* seg_offsets, int64_t count, void* output) const = 0; virtual void check_search(const query::Plan* plan) const = 0; protected: mutable std::shared_mutex mutex_; }; } // namespace milvus::segcore