mirror of https://github.com/facebook/rocksdb.git
920386f2b7
Summary: Note: rebase on and merge after https://github.com/facebook/rocksdb/pull/9349, https://github.com/facebook/rocksdb/pull/9345, (optional) https://github.com/facebook/rocksdb/pull/9393 **Context:** (Quoted from pdillinger) Layers of information during new Bloom/Ribbon Filter construction in building block-based tables includes the following: a) set of keys to add to filter b) set of hashes to add to filter (64-bit hash applied to each key) c) set of Bloom indices to set in filter, with duplicates d) set of Bloom indices to set in filter, deduplicated e) final filter and its checksum This PR aims to detect corruption (e.g, unexpected hardware/software corruption on data structures residing in the memory for a long time) from b) to e) and leave a) as future works for application level. - b)'s corruption is detected by verifying the xor checksum of the hash entries calculated as the entries accumulate before being added to the filter. (i.e, `XXPH3FilterBitsBuilder::MaybeVerifyHashEntriesChecksum()`) - c) - e)'s corruption is detected by verifying the hash entries indeed exists in the constructed filter by re-querying these hash entries in the filter (i.e, `FilterBitsBuilder::MaybePostVerify()`) after computing the block checksum (except for PartitionFilter, which is done right after each `FilterBitsBuilder::Finish` for impl simplicity - see code comment for more). For this stage of detection, we assume hash entries are not corrupted after checking on b) since the time interval from b) to c) is relatively short IMO. Option to enable this feature of detection is `BlockBasedTableOptions::detect_filter_construct_corruption` which is false by default. **Summary:** - Implemented new functions `XXPH3FilterBitsBuilder::MaybeVerifyHashEntriesChecksum()` and `FilterBitsBuilder::MaybePostVerify()` - Ensured hash entries, final filter and banding and their [cache reservation ](https://github.com/facebook/rocksdb/issues/9073) are released properly despite corruption - See [Filter.construction.artifacts.release.point.pdf ](https://github.com/facebook/rocksdb/files/7923487/Design.Filter.construction.artifacts.release.point.pdf) for high-level design - Bundled and refactored hash entries's related artifact in XXPH3FilterBitsBuilder into `HashEntriesInfo` for better control on lifetime of these artifact during `SwapEntires`, `ResetEntries` - Ensured RocksDB block-based table builder calls `FilterBitsBuilder::MaybePostVerify()` after constructing the filter by `FilterBitsBuilder::Finish()` - When encountering such filter construction corruption, stop writing the filter content to files and mark such a block-based table building non-ok by storing the corruption status in the builder. Pull Request resolved: https://github.com/facebook/rocksdb/pull/9342 Test Plan: - Added new unit test `DBFilterConstructionCorruptionTestWithParam.DetectCorruption` - Included this new feature in `DBFilterConstructionReserveMemoryTestWithParam.ReserveMemory` as this feature heavily touch ReserveMemory's impl - For fallback case, I run `./filter_bench -impl=3 -detect_filter_construct_corruption=true -reserve_table_builder_memory=true -strict_capacity_limit=true -quick -runs 10 | grep 'Build avg'` to make sure nothing break. - Added to `filter_bench`: increased filter construction time by **30%**, mostly by `MaybePostVerify()` - FastLocalBloom - Before change: `./filter_bench -impl=2 -quick -runs 10 | grep 'Build avg'`: **28.86643s** - After change: - `./filter_bench -impl=2 -detect_filter_construct_corruption=false -quick -runs 10 | grep 'Build avg'` (expect a tiny increase due to MaybePostVerify is always called regardless): **27.6644s (-4% perf improvement might be due to now we don't drop bloom hash entry in `AddAllEntries` along iteration but in bulk later, same with the bypassing-MaybePostVerify case below)** - `./filter_bench -impl=2 -detect_filter_construct_corruption=true -quick -runs 10 | grep 'Build avg'` (expect acceptable increase): **34.41159s (+20%)** - `./filter_bench -impl=2 -detect_filter_construct_corruption=true -quick -runs 10 | grep 'Build avg'` (by-passing MaybePostVerify, expect minor increase): **27.13431s (-6%)** - Standard128Ribbon - Before change: `./filter_bench -impl=3 -quick -runs 10 | grep 'Build avg'`: **122.5384s** - After change: - `./filter_bench -impl=3 -detect_filter_construct_corruption=false -quick -runs 10 | grep 'Build avg'` (expect a tiny increase due to MaybePostVerify is always called regardless - verified by removing MaybePostVerify under this case and found only +-1ns difference): **124.3588s (+2%)** - `./filter_bench -impl=3 -detect_filter_construct_corruption=true -quick -runs 10 | grep 'Build avg'`(expect acceptable increase): **159.4946s (+30%)** - `./filter_bench -impl=3 -detect_filter_construct_corruption=true -quick -runs 10 | grep 'Build avg'`(by-passing MaybePostVerify, expect minor increase) : **125.258s (+2%)** - Added to `db_stress`: `make crash_test`, `./db_stress --detect_filter_construct_corruption=true` - Manually smoke-tested: manually corrupted the filter construction in some db level tests with basic PUT and background flush. As expected, the error did get returned to users in subsequent PUT and Flush status. Reviewed By: pdillinger Differential Revision: D33746928 Pulled By: hx235 fbshipit-source-id: cb056426be5a7debc1cd16f23bc250f36a08ca57 |
||
|---|---|---|
| .. | ||
| binary_search_index_reader.cc | ||
| binary_search_index_reader.h | ||
| block.cc | ||
| block.h | ||
| block_based_filter_block.cc | ||
| block_based_filter_block.h | ||
| block_based_filter_block_test.cc | ||
| block_based_table_builder.cc | ||
| block_based_table_builder.h | ||
| block_based_table_factory.cc | ||
| block_based_table_factory.h | ||
| block_based_table_iterator.cc | ||
| block_based_table_iterator.h | ||
| block_based_table_reader.cc | ||
| block_based_table_reader.h | ||
| block_based_table_reader_impl.h | ||
| block_based_table_reader_test.cc | ||
| block_builder.cc | ||
| block_builder.h | ||
| block_like_traits.h | ||
| block_prefetcher.cc | ||
| block_prefetcher.h | ||
| block_prefix_index.cc | ||
| block_prefix_index.h | ||
| block_test.cc | ||
| block_type.h | ||
| cachable_entry.h | ||
| data_block_footer.cc | ||
| data_block_footer.h | ||
| data_block_hash_index.cc | ||
| data_block_hash_index.h | ||
| data_block_hash_index_test.cc | ||
| filter_block.h | ||
| filter_block_reader_common.cc | ||
| filter_block_reader_common.h | ||
| filter_policy.cc | ||
| filter_policy_internal.h | ||
| flush_block_policy.cc | ||
| flush_block_policy.h | ||
| full_filter_block.cc | ||
| full_filter_block.h | ||
| full_filter_block_test.cc | ||
| hash_index_reader.cc | ||
| hash_index_reader.h | ||
| index_builder.cc | ||
| index_builder.h | ||
| index_reader_common.cc | ||
| index_reader_common.h | ||
| mock_block_based_table.h | ||
| parsed_full_filter_block.cc | ||
| parsed_full_filter_block.h | ||
| partitioned_filter_block.cc | ||
| partitioned_filter_block.h | ||
| partitioned_filter_block_test.cc | ||
| partitioned_index_iterator.cc | ||
| partitioned_index_iterator.h | ||
| partitioned_index_reader.cc | ||
| partitioned_index_reader.h | ||
| reader_common.cc | ||
| reader_common.h | ||
| uncompression_dict_reader.cc | ||
| uncompression_dict_reader.h | ||