[Draft] feat: support fixed length range bitmap file index read and write #147
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,281 @@ | ||
| /* | ||
| * Copyright 2026-present Alibaba Inc. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #include "paimon/common/file_index/rangebitmap/bit_slice_index_bitmap.h" | ||
|
|
||
| #include <fmt/format.h> | ||
|
|
||
| #include <algorithm> | ||
| #include <cmath> | ||
| #include <string> | ||
|
|
||
| #include "paimon/common/io/memory_segment_output_stream.h" | ||
| #include "paimon/common/memory/memory_segment_utils.h" | ||
| #include "paimon/io/data_input_stream.h" | ||
| #include "paimon/result.h" | ||
| #include "paimon/status.h" | ||
|
|
||
| namespace paimon { | ||
|
|
||
| Result<std::unique_ptr<BitSliceIndexBitmap>> BitSliceIndexBitmap::Create( | ||
| const std::shared_ptr<MemoryPool>& pool, const std::shared_ptr<InputStream>& input_stream, | ||
| const int32_t offset) { | ||
| auto data_in = std::make_unique<DataInputStream>(input_stream); | ||
| PAIMON_RETURN_NOT_OK(data_in->Seek(offset)); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t header_length, data_in->ReadValue<int32_t>()); | ||
| PAIMON_ASSIGN_OR_RAISE(int8_t version, data_in->ReadValue<int8_t>()); | ||
| if (version != CURRENT_VERSION) { | ||
| return Status::Invalid(fmt::format("Unknown BitSliceBitmap version: {}, Expected: {}", | ||
| version, CURRENT_VERSION)); | ||
| } | ||
| PAIMON_ASSIGN_OR_RAISE(int8_t slices_size, data_in->ReadValue<int8_t>()); | ||
| auto slices = std::vector<std::unique_ptr<RoaringBitmap32>>(); | ||
| slices.resize(slices_size); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t ebm_size, data_in->ReadValue<int32_t>()); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t indexes_length, data_in->ReadValue<int32_t>()); | ||
| auto indexes = Bytes::AllocateBytes(indexes_length, pool.get()); | ||
| PAIMON_RETURN_NOT_OK(data_in->Read(indexes->data(), indexes_length)); | ||
| auto body_offset = offset + sizeof(int32_t) + header_length; | ||
| return std::make_unique<BitSliceIndexBitmap>(pool, indexes_length, std::move(indexes), ebm_size, | ||
| slices_size, input_stream, body_offset); | ||
| } | ||
|
|
||
| static int32_t NumberOfLeadingZeros(const int64_t value) { | ||
| if (value == 0) { | ||
| return 64; | ||
| } | ||
| return __builtin_clzll(static_cast<uint64_t>(value)); | ||
| } | ||
|
|
||
| static int32_t NumberOfTrailingZeros(const int64_t value) { | ||
| if (value == 0) { | ||
| return 64; | ||
| } | ||
| return __builtin_ctzll(static_cast<uint64_t>(value)); | ||
| } | ||
|
|
||
| BitSliceIndexBitmap::BitSliceIndexBitmap(const std::shared_ptr<MemoryPool>& pool, | ||
| const int32_t indexes_length, | ||
| PAIMON_UNIQUE_PTR<Bytes> indexes, const int32_t ebm_length, | ||
| const int32_t slices_size, | ||
| const std::shared_ptr<InputStream>& input_stream, | ||
| const int32_t body_offset) | ||
| : pool_(pool), | ||
| initialized_(false), | ||
| bit_slices_(std::vector<std::optional<RoaringBitmap32>>(slices_size, std::nullopt)), | ||
| ebm(std::nullopt), | ||
| input_stream_(input_stream), | ||
| body_offset_(body_offset), | ||
| indexes_(std::move(indexes)), | ||
| ebm_length_(ebm_length), | ||
| indexes_length_(indexes_length) {} | ||
|
|
||
| Result<const RoaringBitmap32*> BitSliceIndexBitmap::GetEmptyBitmap() { | ||
| if (!ebm.has_value()) { | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Seek(body_offset_, FS_SEEK_SET)); | ||
| const auto bytes = Bytes::AllocateBytes(ebm_length_, pool_.get()); | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Read(bytes->data(), ebm_length_)); | ||
| RoaringBitmap32 bitmap; | ||
| PAIMON_RETURN_NOT_OK(bitmap.Deserialize(bytes->data(), ebm_length_)); | ||
| ebm = bitmap; | ||
| } | ||
| return &ebm.value(); | ||
| } | ||
|
|
||
| Result<const RoaringBitmap32*> BitSliceIndexBitmap::GetSliceBitmap(const int32_t idx) { | ||
| if (!bit_slices_[idx].has_value()) { | ||
| auto data_in = std::make_unique<DataInputStream>( | ||
| std::make_shared<ByteArrayInputStream>(indexes_->data(), indexes_length_)); | ||
| const int position = static_cast<int32_t>(2 * sizeof(int32_t) * idx); | ||
| PAIMON_RETURN_NOT_OK(data_in->Seek(position)); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t offset, data_in->ReadValue<int32_t>()); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t length, data_in->ReadValue<int32_t>()); | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Seek(body_offset_ + ebm_length_ + offset, FS_SEEK_SET)); | ||
| RoaringBitmap32 bitmap; | ||
| const auto bytes = Bytes::AllocateBytes(length, pool_.get()); | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Read(bytes->data(), length)); | ||
| PAIMON_RETURN_NOT_OK(bitmap.Deserialize(bytes->data(), length)); | ||
| bit_slices_[idx] = bitmap; | ||
| } | ||
| return &bit_slices_[idx].value(); | ||
| } | ||
|
|
||
| /// Batch load slices from start to end to avoid unnecessary IO | ||
| Status BitSliceIndexBitmap::LoadSlices(const int32_t start, const int32_t end) { | ||
| if (initialized_) { | ||
|
Collaborator
There was a problem hiding this comment. It looks like |
||
| return Status::OK(); | ||
| } | ||
| auto indexes_stream = std::make_shared<ByteArrayInputStream>(indexes_->data(), indexes_length_); | ||
| auto data_in = std::make_unique<DataInputStream>(indexes_stream); | ||
| auto position = static_cast<int32_t>(2 * sizeof(int32_t) * start); | ||
| PAIMON_RETURN_NOT_OK(data_in->Seek(position)); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t offset, data_in->ReadValue<int32_t>()); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t length, data_in->ReadValue<int32_t>()); | ||
| std::vector<int32_t> lengths(end); | ||
| lengths[start] = length; | ||
|
|
||
| for (int32_t i = start + 1; i < end; ++i) { | ||
| PAIMON_RETURN_NOT_OK(data_in->ReadValue<int32_t>()); | ||
| PAIMON_ASSIGN_OR_RAISE(int32_t slice_length, data_in->ReadValue<int32_t>()); | ||
| lengths[i] = slice_length; | ||
| length += slice_length; | ||
| } | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Seek(body_offset_ + ebm_length_ + offset, FS_SEEK_SET)); | ||
| const auto bytes = Bytes::AllocateBytes(length, pool_.get()); | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Read(bytes->data(), length)); | ||
| int32_t byte_position = 0; | ||
| for (int32_t i = start; i < end; ++i) { | ||
| const int32_t slice_length = lengths[i]; | ||
| RoaringBitmap32 bitmap; | ||
| PAIMON_RETURN_NOT_OK(bitmap.Deserialize(bytes->data() + byte_position, slice_length)); | ||
| bit_slices_[i] = std::move(bitmap); | ||
| byte_position += slice_length; | ||
| } | ||
| initialized_ = true; | ||
| return Status::OK(); | ||
| } | ||
|
|
||
| Result<RoaringBitmap32> BitSliceIndexBitmap::Eq(const int32_t code) { | ||
| PAIMON_ASSIGN_OR_RAISE(const RoaringBitmap32* empty_bitmap, GetEmptyBitmap()); | ||
| auto state = RoaringBitmap32(*empty_bitmap); | ||
|
Collaborator
There was a problem hiding this comment.
|
||
| if (state.IsEmpty()) { | ||
| return RoaringBitmap32(); | ||
| } | ||
| PAIMON_RETURN_NOT_OK(LoadSlices(0, static_cast<int32_t>(bit_slices_.size()))); | ||
| for (int32_t i = 0; i < static_cast<int32_t>(bit_slices_.size()); i++) { | ||
| PAIMON_ASSIGN_OR_RAISE(const RoaringBitmap32* slice_bitmap, GetSliceBitmap(i)); | ||
| if ((code >> i & 1) == 1) { | ||
| state &= *slice_bitmap; | ||
| } else { | ||
| state -= *slice_bitmap; | ||
| } | ||
| } | ||
| return state; | ||
| } | ||
|
|
||
| Result<RoaringBitmap32> BitSliceIndexBitmap::Gt(const int32_t code) { | ||
| if (code < 0) { | ||
| return IsNotNull({}); | ||
| } | ||
| PAIMON_ASSIGN_OR_RAISE(RoaringBitmap32 found_set, IsNotNull({})); | ||
| if (found_set.IsEmpty()) { | ||
| return RoaringBitmap32(); | ||
| } | ||
| auto state = RoaringBitmap32{}; | ||
| auto state_inited = false; | ||
| const auto start = NumberOfTrailingZeros(~code); | ||
| PAIMON_RETURN_NOT_OK(LoadSlices(start, static_cast<int32_t>(bit_slices_.size()))); | ||
| for (int i = start; i < static_cast<int32_t>(bit_slices_.size()); ++i) { | ||
| if (!state_inited) { | ||
| PAIMON_ASSIGN_OR_RAISE(const RoaringBitmap32* slice_ptr, GetSliceBitmap(i)); | ||
| state = *slice_ptr; | ||
| state_inited = true; | ||
| continue; | ||
| } | ||
| const auto bit = code >> i & 1; | ||
| PAIMON_ASSIGN_OR_RAISE(const RoaringBitmap32* slice_ptr, GetSliceBitmap(i)); | ||
| if (bit == 1) { | ||
| state &= *slice_ptr; | ||
| } else { | ||
| state |= *slice_ptr; | ||
| } | ||
| } | ||
| if (!state_inited) { | ||
| return RoaringBitmap32(); | ||
| } | ||
| return state &= found_set; | ||
| } | ||
|
|
||
| Result<RoaringBitmap32> BitSliceIndexBitmap::Gte(const int32_t code) { | ||
| return Gt(code - 1); | ||
| } | ||
|
|
||
| Result<RoaringBitmap32> BitSliceIndexBitmap::IsNotNull(const RoaringBitmap32& found_set) { | ||
| if (!ebm.has_value()) { | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Seek(body_offset_, FS_SEEK_SET)); | ||
| const auto bytes = Bytes::AllocateBytes(ebm_length_, pool_.get()); | ||
| PAIMON_RETURN_NOT_OK(input_stream_->Read(bytes->data(), ebm_length_)); | ||
| RoaringBitmap32 bitmap; | ||
| PAIMON_RETURN_NOT_OK(bitmap.Deserialize(bytes->data(), ebm_length_)); | ||
| ebm = bitmap; | ||
| } | ||
|
Collaborator
There was a problem hiding this comment. It looks like |
||
| return found_set.IsEmpty() ? *ebm : *ebm &= found_set; | ||
| } | ||
|
|
||
| BitSliceIndexBitmap::Appender::Appender(const std::shared_ptr<MemoryPool>& pool, const int32_t min, | ||
| const int32_t max) | ||
| : pool_(pool), min_(min), max_(max) { | ||
|
Collaborator
There was a problem hiding this comment. Is |
||
| ebm_ = RoaringBitmap32{}; | ||
|
Collaborator
There was a problem hiding this comment. Generally, we place memory pool parameters at the end of function parameter lists, and memory pool member variables at the beginning of class member declarations (which helps ensure safe destruction order). |
||
| int32_t slices_size = std::max(64 - NumberOfLeadingZeros(max), 1); | ||
| slices_.resize(slices_size); | ||
| } | ||
|
|
||
| Status BitSliceIndexBitmap::Appender::Append(const int32_t key, const int32_t value) { | ||
| if (key < 0) { | ||
| return Status::Invalid(fmt::format("Invalid key: {}", key)); | ||
| } | ||
| if (value < min_ || value > max_) { | ||
| return Status::Invalid(fmt::format("value not in range [{}, {}]", min_, max_)); | ||
| } | ||
| int bits = value; | ||
| while (bits != 0) { | ||
| slices_[NumberOfTrailingZeros(bits)].Add(key); | ||
| bits &= (bits - 1); | ||
| } | ||
| ebm_.Add(key); | ||
| return Status::OK(); | ||
| } | ||
|
|
||
| Result<PAIMON_UNIQUE_PTR<Bytes>> BitSliceIndexBitmap::Appender::Serialize() const { | ||
| auto indexes_length = static_cast<int32_t>(2 * sizeof(int32_t) * slices_.size()); | ||
| PAIMON_UNIQUE_PTR<Bytes> ebm_bytes = ebm_.Serialize(pool_.get()); | ||
| auto ebm_length = static_cast<int32_t>(ebm_bytes->size()); | ||
| int32_t header_size = 0; | ||
| header_size += sizeof(int8_t); // version | ||
| header_size += sizeof(int8_t); // slices size | ||
| header_size += sizeof(int32_t); // ebm length | ||
| header_size += sizeof(int32_t); // indexes length | ||
| header_size += indexes_length; | ||
| int32_t offset = 0; | ||
| auto data_output_stream = std::make_unique<MemorySegmentOutputStream>( | ||
| MemorySegmentOutputStream::DEFAULT_SEGMENT_SIZE, pool_); | ||
| std::vector<PAIMON_UNIQUE_PTR<Bytes>> slices_bytes_vector{}; | ||
| std::vector<std::pair<int32_t, int32_t>> indexes_vector{}; | ||
| for (const auto& slice : slices_) { | ||
| auto slice_bytes = slice.Serialize(pool_.get()); | ||
| auto length = static_cast<int32_t>(slice_bytes->size()); | ||
| indexes_vector.emplace_back(offset, length); | ||
| offset += length; | ||
| slices_bytes_vector.emplace_back(std::move(slice_bytes)); | ||
| } | ||
| data_output_stream->WriteValue<int32_t>(header_size); | ||
| data_output_stream->WriteValue<int8_t>(CURRENT_VERSION); | ||
| data_output_stream->WriteValue<int8_t>(static_cast<int8_t>(slices_.size())); | ||
| data_output_stream->WriteValue<int32_t>(ebm_length); | ||
| data_output_stream->WriteValue<int32_t>(indexes_length); | ||
| for (const auto& [slice_offset, length] : indexes_vector) { | ||
| data_output_stream->WriteValue<int32_t>(slice_offset); | ||
| data_output_stream->WriteValue<int32_t>(length); | ||
| } | ||
| data_output_stream->Write(ebm_bytes->data(), ebm_length); | ||
| for (const auto& slice_bytes : slices_bytes_vector) { | ||
| data_output_stream->Write(slice_bytes->data(), slice_bytes->size()); | ||
| } | ||
| return MemorySegmentUtils::CopyToBytes(data_output_stream->Segments(), 0, | ||
| static_cast<int32_t>(data_output_stream->CurrentSize()), | ||
| pool_.get()); | ||
| } | ||
| } // namespace paimon | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ebm = std::move(bitmap);
bit_slices_[idx] = std::move(bitmap);