github-actions[bot] commented on code in PR #30145: URL: https://github.com/apache/doris/pull/30145#discussion_r1524999881
########## be/src/olap/rowset/segment_v2/inverted_index_file_writer.cpp: ########## @@ -0,0 +1,414 @@ +// 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 "olap/rowset/segment_v2/inverted_index_file_writer.h" + +#include "common/status.h" +#include "io/fs/file_writer.h" +#include "io/fs/local_file_system.h" +#include "olap/rowset/segment_v2/inverted_index_desc.h" +#include "olap/rowset/segment_v2/inverted_index_fs_directory.h" +#include "olap/tablet_schema.h" +#include "runtime/exec_env.h" + +namespace doris::segment_v2 { + +std::string InvertedIndexFileWriter::get_index_file_path(const TabletIndex* index_meta) const { + return InvertedIndexDescriptor::get_index_file_name(_index_file_dir / _segment_file_name, + index_meta->index_id(), + index_meta->get_index_suffix()); +} + +Status InvertedIndexFileWriter::initialize(InvertedIndexDirectoryMap& indices_dirs) { + _indices_dirs = std::move(indices_dirs); + return Status::OK(); +} + +Result<DorisFSDirectory*> InvertedIndexFileWriter::open(const TabletIndex* index_meta) { + auto index_id = index_meta->index_id(); + auto index_suffix = index_meta->get_index_suffix(); + auto tmp_file_dir = ExecEnv::GetInstance()->get_tmp_file_dirs()->get_tmp_file_dir(); + _lfs = io::global_local_filesystem(); + auto lfs_index_path = InvertedIndexDescriptor::get_temporary_index_path( + tmp_file_dir / _segment_file_name, index_meta->index_id(), + index_meta->get_index_suffix()); + auto index_path = InvertedIndexDescriptor::get_temporary_index_path( + (_index_file_dir / _segment_file_name).native(), index_id, index_suffix); + + bool exists = false; + auto st = _fs->exists(lfs_index_path.c_str(), &exists); + if (!st.ok()) { + LOG(ERROR) << "index_path:" << lfs_index_path << " exists error:" << st; + return ResultError(st); + } + if (exists) { + LOG(ERROR) << "try to init a directory:" << lfs_index_path << " already exists"; + return ResultError(Status::InternalError("init_fulltext_index directory already exists")); + } + + bool can_use_ram_dir = true; + bool use_compound_file_writer = false; + auto* dir = DorisFSDirectoryFactory::getDirectory(_lfs, lfs_index_path.c_str(), + use_compound_file_writer, can_use_ram_dir, + nullptr, _fs, index_path.c_str()); + _indices_dirs.emplace(std::make_pair(index_id, index_suffix), + std::unique_ptr<DorisFSDirectory>(dir)); + return dir; +} + +Status InvertedIndexFileWriter::delete_index(const TabletIndex* index_meta) { Review Comment: warning: method 'delete_index' can be made static [readability-convert-member-functions-to-static] ```suggestion static Status delete_index(const TabletIndex* index_meta); ``` ########## be/src/olap/rowset/segment_v2/inverted_index_writer.cpp: ########## @@ -546,72 +511,85 @@ class InvertedIndexColumnWriterImpl : public InvertedIndexColumnWriter { faststring buf; buf.resize(size); _null_bitmap.write(reinterpret_cast<char*>(buf.data()), false); - null_bitmap_out->writeBytes(reinterpret_cast<uint8_t*>(buf.data()), size); + null_bitmap_out->writeBytes(buf.data(), size); null_bitmap_out->close(); } } Status finish() override { Review Comment: warning: function 'finish' has cognitive complexity of 52 (threshold 50) [readability-function-cognitive-complexity] ```cpp Status finish() override { ^ ``` <details> <summary>Additional context</summary> **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:519:** +1, including nesting penalty of 0, nesting level increased to 1 ```cpp if (_dir != nullptr) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:526:** +2, including nesting penalty of 1, nesting level increased to 2 ```cpp if constexpr (field_is_numeric_type(field_type)) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:543:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp DBUG_EXECUTE_IF("InvertedIndexWriter._set_bkd_data_out_nullptr", ^ ``` **be/src/util/debug_points.h:34:** expanded from macro 'DBUG_EXECUTE_IF' ```cpp if (UNLIKELY(config::enable_debug_points)) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:543:** +4, including nesting penalty of 3, nesting level increased to 4 ```cpp DBUG_EXECUTE_IF("InvertedIndexWriter._set_bkd_data_out_nullptr", ^ ``` **be/src/util/debug_points.h:36:** expanded from macro 'DBUG_EXECUTE_IF' ```cpp if (dp) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:545:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp if (data_out != nullptr && meta_out != nullptr && index_out != nullptr) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:550:** +1, nesting level increased to 3 ```cpp } else { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:559:** +1, nesting level increased to 2 ```cpp } else if constexpr (field_is_slice_type(field_type)) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:566:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp DBUG_EXECUTE_IF( ^ ``` **be/src/util/debug_points.h:34:** expanded from macro 'DBUG_EXECUTE_IF' ```cpp if (UNLIKELY(config::enable_debug_points)) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:566:** +4, including nesting penalty of 3, nesting level increased to 4 ```cpp DBUG_EXECUTE_IF( ^ ``` **be/src/util/debug_points.h:36:** expanded from macro 'DBUG_EXECUTE_IF' ```cpp if (dp) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:572:** +2, including nesting penalty of 1, nesting level increased to 2 ```cpp } catch (CLuceneError& e) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:573:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp FINALLY_CLOSE_OUTPUT(null_bitmap_out) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:574:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp FINALLY_CLOSE_OUTPUT(meta_out) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:575:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp FINALLY_CLOSE_OUTPUT(data_out) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:576:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp FINALLY_CLOSE_OUTPUT(index_out) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:577:** +3, including nesting penalty of 2, nesting level increased to 3 ```cpp if constexpr (field_is_numeric_type(field_type)) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:578:** +4, including nesting penalty of 3, nesting level increased to 4 ```cpp FINALLY_CLOSE_OUTPUT(_dir) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:65:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp if (x != nullptr) x->close(); \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:578:** +4, including nesting penalty of 3, nesting level increased to 4 ```cpp FINALLY_CLOSE_OUTPUT(_dir) ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:579:** +1, nesting level increased to 3 ```cpp } else if constexpr (field_is_slice_type(field_type)) { ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:580:** +4, including nesting penalty of 3, nesting level increased to 4 ```cpp FINALLY_CLOSE_OUTPUT(_index_writer); ^ ``` **be/src/olap/rowset/segment_v2/inverted_index_writer.cpp:66:** expanded from macro 'FINALLY_CLOSE_OUTPUT' ```cpp } catch (...) { \ ^ ``` </details> ########## be/src/olap/rowset/segment_v2/inverted_index_file_writer.cpp: ########## @@ -0,0 +1,414 @@ +// 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 "olap/rowset/segment_v2/inverted_index_file_writer.h" + +#include "common/status.h" +#include "io/fs/file_writer.h" +#include "io/fs/local_file_system.h" +#include "olap/rowset/segment_v2/inverted_index_desc.h" +#include "olap/rowset/segment_v2/inverted_index_fs_directory.h" +#include "olap/tablet_schema.h" +#include "runtime/exec_env.h" + +namespace doris::segment_v2 { + +std::string InvertedIndexFileWriter::get_index_file_path(const TabletIndex* index_meta) const { + return InvertedIndexDescriptor::get_index_file_name(_index_file_dir / _segment_file_name, + index_meta->index_id(), + index_meta->get_index_suffix()); +} + +Status InvertedIndexFileWriter::initialize(InvertedIndexDirectoryMap& indices_dirs) { + _indices_dirs = std::move(indices_dirs); + return Status::OK(); +} + +Result<DorisFSDirectory*> InvertedIndexFileWriter::open(const TabletIndex* index_meta) { + auto index_id = index_meta->index_id(); + auto index_suffix = index_meta->get_index_suffix(); + auto tmp_file_dir = ExecEnv::GetInstance()->get_tmp_file_dirs()->get_tmp_file_dir(); + _lfs = io::global_local_filesystem(); + auto lfs_index_path = InvertedIndexDescriptor::get_temporary_index_path( + tmp_file_dir / _segment_file_name, index_meta->index_id(), + index_meta->get_index_suffix()); + auto index_path = InvertedIndexDescriptor::get_temporary_index_path( + (_index_file_dir / _segment_file_name).native(), index_id, index_suffix); + + bool exists = false; + auto st = _fs->exists(lfs_index_path.c_str(), &exists); + if (!st.ok()) { + LOG(ERROR) << "index_path:" << lfs_index_path << " exists error:" << st; + return ResultError(st); + } + if (exists) { + LOG(ERROR) << "try to init a directory:" << lfs_index_path << " already exists"; + return ResultError(Status::InternalError("init_fulltext_index directory already exists")); + } + + bool can_use_ram_dir = true; + bool use_compound_file_writer = false; + auto* dir = DorisFSDirectoryFactory::getDirectory(_lfs, lfs_index_path.c_str(), + use_compound_file_writer, can_use_ram_dir, + nullptr, _fs, index_path.c_str()); + _indices_dirs.emplace(std::make_pair(index_id, index_suffix), + std::unique_ptr<DorisFSDirectory>(dir)); + return dir; +} + +Status InvertedIndexFileWriter::delete_index(const TabletIndex* index_meta) { + if (!index_meta) { + return Status::Error<ErrorCode::INVALID_ARGUMENT>("Index metadata is null."); + } + + auto index_id = index_meta->index_id(); + auto index_suffix = index_meta->get_index_suffix(); + + // Check if the specified index exists + auto index_it = _indices_dirs.find(std::make_pair(index_id, index_suffix)); + if (index_it == _indices_dirs.end()) { + std::ostringstream errMsg; + errMsg << "No inverted index with id " << index_id << " and suffix " << index_suffix + << " found."; + LOG(WARNING) << errMsg.str(); + return Status::OK(); + } + + _indices_dirs.erase(index_it); + return Status::OK(); +} + +size_t InvertedIndexFileWriter::headerLength() { Review Comment: warning: method 'headerLength' can be made static [readability-convert-member-functions-to-static] be/src/olap/rowset/segment_v2/inverted_index_file_writer.h:77: ```diff - size_t headerLength(); + static size_t headerLength(); ``` ########## be/src/olap/rowset/segment_v2/inverted_index_file_writer.cpp: ########## @@ -0,0 +1,414 @@ +// 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 "olap/rowset/segment_v2/inverted_index_file_writer.h" + +#include "common/status.h" +#include "io/fs/file_writer.h" +#include "io/fs/local_file_system.h" +#include "olap/rowset/segment_v2/inverted_index_desc.h" +#include "olap/rowset/segment_v2/inverted_index_fs_directory.h" +#include "olap/tablet_schema.h" +#include "runtime/exec_env.h" + +namespace doris::segment_v2 { + +std::string InvertedIndexFileWriter::get_index_file_path(const TabletIndex* index_meta) const { + return InvertedIndexDescriptor::get_index_file_name(_index_file_dir / _segment_file_name, + index_meta->index_id(), + index_meta->get_index_suffix()); +} + +Status InvertedIndexFileWriter::initialize(InvertedIndexDirectoryMap& indices_dirs) { + _indices_dirs = std::move(indices_dirs); + return Status::OK(); +} + +Result<DorisFSDirectory*> InvertedIndexFileWriter::open(const TabletIndex* index_meta) { + auto index_id = index_meta->index_id(); + auto index_suffix = index_meta->get_index_suffix(); + auto tmp_file_dir = ExecEnv::GetInstance()->get_tmp_file_dirs()->get_tmp_file_dir(); + _lfs = io::global_local_filesystem(); + auto lfs_index_path = InvertedIndexDescriptor::get_temporary_index_path( + tmp_file_dir / _segment_file_name, index_meta->index_id(), + index_meta->get_index_suffix()); + auto index_path = InvertedIndexDescriptor::get_temporary_index_path( + (_index_file_dir / _segment_file_name).native(), index_id, index_suffix); + + bool exists = false; + auto st = _fs->exists(lfs_index_path.c_str(), &exists); + if (!st.ok()) { + LOG(ERROR) << "index_path:" << lfs_index_path << " exists error:" << st; + return ResultError(st); + } + if (exists) { + LOG(ERROR) << "try to init a directory:" << lfs_index_path << " already exists"; + return ResultError(Status::InternalError("init_fulltext_index directory already exists")); + } + + bool can_use_ram_dir = true; + bool use_compound_file_writer = false; + auto* dir = DorisFSDirectoryFactory::getDirectory(_lfs, lfs_index_path.c_str(), + use_compound_file_writer, can_use_ram_dir, + nullptr, _fs, index_path.c_str()); + _indices_dirs.emplace(std::make_pair(index_id, index_suffix), + std::unique_ptr<DorisFSDirectory>(dir)); + return dir; +} + +Status InvertedIndexFileWriter::delete_index(const TabletIndex* index_meta) { + if (!index_meta) { + return Status::Error<ErrorCode::INVALID_ARGUMENT>("Index metadata is null."); + } + + auto index_id = index_meta->index_id(); + auto index_suffix = index_meta->get_index_suffix(); + + // Check if the specified index exists + auto index_it = _indices_dirs.find(std::make_pair(index_id, index_suffix)); + if (index_it == _indices_dirs.end()) { + std::ostringstream errMsg; + errMsg << "No inverted index with id " << index_id << " and suffix " << index_suffix + << " found."; + LOG(WARNING) << errMsg.str(); + return Status::OK(); + } + + _indices_dirs.erase(index_it); + return Status::OK(); +} + +size_t InvertedIndexFileWriter::headerLength() { + size_t header_size = 0; + header_size += + sizeof(int) * 2; // Account for the size of the version number and number of indices + for (const auto& entry : _indices_dirs) { + auto suffix = entry.first.second; + header_size += sizeof(int); // index id + header_size += 4; // index suffix name size + header_size += suffix.length(); // index suffix name + header_size += sizeof(int); // index file count + const auto& dir = entry.second; + std::vector<std::string> files; + dir->list(&files); + + for (auto file : files) { + header_size += 4; // file name size + header_size += file.length(); // file name + header_size += 8; // file offset + header_size += 8; // file size + } + } + return header_size; +} + +Status InvertedIndexFileWriter::close() { + if (_indices_dirs.empty()) { + return Status::OK(); + } + try { + if (_storage_format == InvertedIndexStorageFormatPB::V1) { + for (const auto& entry : _indices_dirs) { + const auto& dir = entry.second; + auto* cfsWriter = _CLNEW DorisCompoundFileWriter(dir.get()); + // write compound file + _file_size += cfsWriter->writeCompoundFile(); + // delete index path, which contains separated inverted index files + if (std::strcmp(dir->getObjectName(), "DorisFSDirectory") == 0) { + auto* compound_dir = static_cast<DorisFSDirectory*>(dir.get()); + compound_dir->deleteDirectory(); + } + _CLDELETE(cfsWriter) + } + } else { + _file_size = write(); + for (const auto& entry : _indices_dirs) { + const auto& dir = entry.second; + // delete index path, which contains separated inverted index files + if (std::strcmp(dir->getObjectName(), "DorisFSDirectory") == 0) { + auto* compound_dir = static_cast<DorisFSDirectory*>(dir.get()); + compound_dir->deleteDirectory(); + } + } + } + } catch (CLuceneError& err) { + return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>( + "CLuceneError occur when close idx file {}, error msg: {}", + InvertedIndexDescriptor::get_index_file_name(_index_file_dir / _segment_file_name), + err.what()); + } + return Status::OK(); +} +size_t InvertedIndexFileWriter::write() { Review Comment: warning: function 'write' exceeds recommended size/complexity thresholds [readability-function-size] ```cpp size_t InvertedIndexFileWriter::write() { ^ ``` <details> <summary>Additional context</summary> **be/src/olap/rowset/segment_v2/inverted_index_file_writer.cpp:155:** 84 lines including whitespace and comments (threshold 80) ```cpp size_t InvertedIndexFileWriter::write() { ^ ``` </details> -- 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]
