HappenLee commented on code in PR #54276: URL: https://github.com/apache/doris/pull/54276#discussion_r2286933343
########## be/src/olap/rowset/segment_v2/ann_index/ann_index_reader.cpp: ########## @@ -0,0 +1,220 @@ +// Licensed to the Apache Software Foundation (ASF) 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. + +#include "ann_index_reader.h" + +#include <cstddef> +#include <memory> + +#include "ann_index_iterator.h" +#include "common/config.h" +#include "io/io_common.h" +#include "olap/rowset/segment_v2/ann_index/ann_index.h" +#include "olap/rowset/segment_v2/ann_index/ann_search_params.h" +#include "olap/rowset/segment_v2/ann_index/faiss_ann_index.h" +#include "olap/rowset/segment_v2/index_file_reader.h" +#include "olap/rowset/segment_v2/inverted_index_compound_reader.h" +#include "runtime/runtime_state.h" +#include "util/doris_metrics.h" +#include "util/once.h" +#include "util/runtime_profile.h" + +namespace doris::segment_v2 { +#include "common/compile_check_begin.h" +void AnnIndexReader::update_result(const IndexSearchResult& search_result, + std::vector<float>& distance, roaring::Roaring& roaring) { + DCHECK(search_result.distances != nullptr); + DCHECK(search_result.roaring != nullptr); + size_t limit = search_result.roaring->cardinality(); + // Use search result to update distance and row_id + distance.resize(limit); + for (size_t i = 0; i < limit; ++i) { + distance[i] = search_result.distances[i]; + } + roaring = *search_result.roaring; +} + +AnnIndexReader::AnnIndexReader(const TabletIndex* index_meta, + std::shared_ptr<IndexFileReader> index_file_reader) + : _index_meta(*index_meta), _index_file_reader(index_file_reader) { + const auto index_properties = _index_meta.properties(); + auto it = index_properties.find("index_type"); + DCHECK(it != index_properties.end()); + _index_type = it->second; + it = index_properties.find("metric_type"); + DCHECK(it != index_properties.end()); + _metric_type = string_to_metric(it->second); +} + +Status AnnIndexReader::new_iterator(std::unique_ptr<IndexIterator>* iterator) { + *iterator = AnnIndexIterator::create_unique(shared_from_this()); + return Status::OK(); +} + +Status AnnIndexReader::load_index(io::IOContext* io_ctx) { + return _load_index_once.call([&]() { + DorisMetrics::instance()->ann_index_load_cnt->increment(1); + + try { + RETURN_IF_ERROR( + _index_file_reader->init(config::inverted_index_read_buffer_size, io_ctx)); + Result<std::unique_ptr<DorisCompoundReader, DirectoryDeleter>> compound_dir; + compound_dir = _index_file_reader->open(&_index_meta, io_ctx); + if (!compound_dir.has_value()) { + return Status::IOError("Failed to open index file: {}", + compound_dir.error().to_string()); + } + _vector_index = std::make_unique<FaissVectorIndex>(); + _vector_index->set_metric(_metric_type); + RETURN_IF_ERROR(_vector_index->load(compound_dir->get())); + } catch (CLuceneError& err) { + return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>( + "CLuceneError occur when open ann idx file, error msg: {}", err.what()); + } + return Status::OK(); + }); +} + +Status AnnIndexReader::query(io::IOContext* io_ctx, AnnTopNParam* param, AnnIndexStats* stats) { +#ifndef BE_TEST + { + SCOPED_TIMER(&(stats->load_index_costs_ns)); + RETURN_IF_ERROR(load_index(io_ctx)); + double load_costs_ms = static_cast<double>(stats->load_index_costs_ns.value()) / 1000.0; + DorisMetrics::instance()->ann_index_load_costs_ms->increment( + static_cast<int64_t>(load_costs_ms)); + } +#endif + { + DorisMetrics::instance()->ann_index_search_cnt->increment(1); + SCOPED_TIMER(&(stats->search_costs_ns)); + DCHECK(_vector_index != nullptr); + const float* query_vec = param->query_value; + const int limit = static_cast<int>(param->limit); + IndexSearchResult index_search_result; + if (string_to_ann_index_type(_index_type) == AnnIndexType::HNSW) { + HNSWSearchParameters hnsw_search_params; + hnsw_search_params.roaring = param->roaring; + hnsw_search_params.rows_of_segment = param->rows_of_segment; + hnsw_search_params.ef_search = param->_user_params.hnsw_ef_search; + hnsw_search_params.check_relative_distance = + param->_user_params.hnsw_check_relative_distance; + hnsw_search_params.bounded_queue = param->_user_params.hnsw_bounded_queue; + RETURN_IF_ERROR(_vector_index->ann_topn_search(query_vec, limit, hnsw_search_params, + index_search_result)); + // Accumulate detailed engine timings + stats->engine_search_ns.update(index_search_result.engine_search_ns); + stats->engine_convert_ns.update(index_search_result.engine_convert_ns); + stats->engine_prepare_ns.update(index_search_result.engine_prepare_ns); + } else { + throw Status::NotSupported("Unsupported index type: {}", _index_type); + } + + DCHECK(index_search_result.roaring != nullptr); + DCHECK(index_search_result.distances != nullptr); + DCHECK(index_search_result.row_ids != nullptr); + param->distance = std::make_unique<std::vector<float>>(); + { + SCOPED_TIMER(&(stats->result_process_costs_ns)); + update_result(index_search_result, *param->distance, *param->roaring); + } + param->row_ids = std::move(index_search_result.row_ids); + } + + double search_costs_ms = static_cast<double>(stats->search_costs_ns.value()) / 1000.0; + DorisMetrics::instance()->ann_index_search_costs_ms->increment( + static_cast<int64_t>(search_costs_ms)); + return Status::OK(); +} + +Status AnnIndexReader::range_search(const AnnRangeSearchParams& params, + const VectorSearchUserParams& custom_params, + segment_v2::AnnRangeSearchResult* result, + segment_v2::AnnIndexStats* stats, io::IOContext* io_ctx) { + DCHECK(stats != nullptr); +#ifndef BE_TEST + { + SCOPED_TIMER(&(stats->load_index_costs_ns)); + RETURN_IF_ERROR(load_index(io_ctx)); + double load_costs_ms = static_cast<double>(stats->load_index_costs_ns.value()) / 1000.0; + DorisMetrics::instance()->ann_index_load_costs_ms->increment( + static_cast<int64_t>(load_costs_ms)); + } +#endif + { + DorisMetrics::instance()->ann_index_search_cnt->increment(1); + SCOPED_TIMER(&(stats->search_costs_ns)); + DCHECK(_vector_index != nullptr); + segment_v2::IndexSearchResult search_result; + std::unique_ptr<segment_v2::IndexSearchParameters> search_param = nullptr; + + if (string_to_ann_index_type(_index_type) == AnnIndexType::HNSW) { Review Comment: `string_to_ann_index_type(_index_type)` should be call in construct, no need each function call the func -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
