mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-25 22:44:05 +00:00
74544d582f
Summary: Note: This PR is the 4th part of a bigger PR stack (https://github.com/facebook/rocksdb/pull/9073) and will rebase/merge only after the first three PRs (https://github.com/facebook/rocksdb/pull/9070, https://github.com/facebook/rocksdb/pull/9071, https://github.com/facebook/rocksdb/pull/9130) merge. **Context:** Similar to https://github.com/facebook/rocksdb/pull/8428, this PR is to track memory usage during (new) Bloom Filter (i.e,FastLocalBloom) and Ribbon Filter (i.e, Ribbon128) construction, moving toward the goal of [single global memory limit using block cache capacity](https://github.com/facebook/rocksdb/wiki/Projects-Being-Developed#improving-memory-efficiency). It also constrains the size of the banding portion of Ribbon Filter during construction by falling back to Bloom Filter if that banding is, at some point, larger than the available space in the cache under `LRUCacheOptions::strict_capacity_limit=true`. The option to turn on this feature is `BlockBasedTableOptions::reserve_table_builder_memory = true` which by default is set to `false`. We [decided](https://github.com/facebook/rocksdb/pull/9073#discussion_r741548409) not to have separate option for separate memory user in table building therefore their memory accounting are all bundled under one general option. **Summary:** - Reserved/released cache for creation/destruction of three main memory users with the passed-in `FilterBuildingContext::cache_res_mgr` during filter construction: - hash entries (i.e`hash_entries`.size(), we bucket-charge hash entries during insertion for performance), - banding (Ribbon Filter only, `bytes_coeff_rows` +`bytes_result_rows` + `bytes_backtrack`), - final filter (i.e, `mutable_buf`'s size). - Implementation details: in order to use `CacheReservationManager::CacheReservationHandle` to account final filter's memory, we have to store the `CacheReservationManager` object and `CacheReservationHandle` for final filter in `XXPH3BitsFilterBuilder` as well as explicitly delete the filter bits builder when done with the final filter in block based table. - Added option fo run `filter_bench` with this memory reservation feature Pull Request resolved: https://github.com/facebook/rocksdb/pull/9073 Test Plan: - Added new tests in `db_bloom_filter_test` to verify filter construction peak cache reservation under combination of `BlockBasedTable::Rep::FilterType` (e.g, `kFullFilter`, `kPartitionedFilter`), `BloomFilterPolicy::Mode`(e.g, `kFastLocalBloom`, `kStandard128Ribbon`, `kDeprecatedBlock`) and `BlockBasedTableOptions::reserve_table_builder_memory` - To address the concern for slow test: tests with memory reservation under `kFullFilter` + `kStandard128Ribbon` and `kPartitionedFilter` take around **3000 - 6000 ms** and others take around **1500 - 2000 ms**, in total adding **20000 - 25000 ms** to the test suit running locally - Added new test in `bloom_test` to verify Ribbon Filter fallback on large banding in FullFilter - Added test in `filter_bench` to verify that this feature does not significantly slow down Bloom/Ribbon Filter construction speed. Local result averaged over **20** run as below: - FastLocalBloom - baseline `./filter_bench -impl=2 -quick -runs 20 | grep 'Build avg'`: - **Build avg ns/key: 29.56295** (DEBUG_LEVEL=1), **29.98153** (DEBUG_LEVEL=0) - new feature (expected to be similar as above)`./filter_bench -impl=2 -quick -runs 20 -reserve_table_builder_memory=true | grep 'Build avg'`: - **Build avg ns/key: 30.99046** (DEBUG_LEVEL=1), **30.48867** (DEBUG_LEVEL=0) - new feature of RibbonFilter with fallback (expected to be similar as above) `./filter_bench -impl=2 -quick -runs 20 -reserve_table_builder_memory=true -strict_capacity_limit=true | grep 'Build avg'` : - **Build avg ns/key: 31.146975** (DEBUG_LEVEL=1), **30.08165** (DEBUG_LEVEL=0) - Ribbon128 - baseline `./filter_bench -impl=3 -quick -runs 20 | grep 'Build avg'`: - **Build avg ns/key: 129.17585** (DEBUG_LEVEL=1), **130.5225** (DEBUG_LEVEL=0) - new feature (expected to be similar as above) `./filter_bench -impl=3 -quick -runs 20 -reserve_table_builder_memory=true | grep 'Build avg' `: - **Build avg ns/key: 131.61645** (DEBUG_LEVEL=1), **132.98075** (DEBUG_LEVEL=0) - new feature of RibbonFilter with fallback (expected to be a lot faster than above due to fallback) `./filter_bench -impl=3 -quick -runs 20 -reserve_table_builder_memory=true -strict_capacity_limit=true | grep 'Build avg'` : - **Build avg ns/key: 52.032965** (DEBUG_LEVEL=1), **52.597825** (DEBUG_LEVEL=0) - And the warning message of `"Cache reservation for Ribbon filter banding failed due to cache full"` is indeed logged to console. Reviewed By: pdillinger Differential Revision: D31991348 Pulled By: hx235 fbshipit-source-id: 9336b2c60f44d530063da518ceaf56dac5f9df8e |
||
|---|---|---|
| .. | ||
| aligned_buffer.h | ||
| autovector.h | ||
| autovector_test.cc | ||
| bloom_impl.h | ||
| bloom_test.cc | ||
| build_version.cc.in | ||
| cast_util.h | ||
| channel.h | ||
| coding.cc | ||
| coding.h | ||
| coding_lean.h | ||
| coding_test.cc | ||
| compaction_job_stats_impl.cc | ||
| comparator.cc | ||
| compression.h | ||
| compression_context_cache.cc | ||
| compression_context_cache.h | ||
| concurrent_task_limiter_impl.cc | ||
| concurrent_task_limiter_impl.h | ||
| core_local.h | ||
| crc32c.cc | ||
| crc32c.h | ||
| crc32c_arm64.cc | ||
| crc32c_arm64.h | ||
| crc32c_ppc.c | ||
| crc32c_ppc.h | ||
| crc32c_ppc_asm.S | ||
| crc32c_ppc_constants.h | ||
| crc32c_test.cc | ||
| defer.h | ||
| defer_test.cc | ||
| duplicate_detector.h | ||
| dynamic_bloom.cc | ||
| dynamic_bloom.h | ||
| dynamic_bloom_test.cc | ||
| fastrange.h | ||
| file_checksum_helper.cc | ||
| file_checksum_helper.h | ||
| file_reader_writer_test.cc | ||
| filelock_test.cc | ||
| filter_bench.cc | ||
| gflags_compat.h | ||
| hash.cc | ||
| hash.h | ||
| hash128.h | ||
| hash_map.h | ||
| hash_test.cc | ||
| heap.h | ||
| heap_test.cc | ||
| kv_map.h | ||
| log_write_bench.cc | ||
| math.h | ||
| math128.h | ||
| murmurhash.cc | ||
| murmurhash.h | ||
| mutexlock.h | ||
| ppc-opcode.h | ||
| random.cc | ||
| random.h | ||
| random_test.cc | ||
| rate_limiter.cc | ||
| rate_limiter.h | ||
| rate_limiter_test.cc | ||
| regex.cc | ||
| repeatable_thread.h | ||
| repeatable_thread_test.cc | ||
| ribbon_alg.h | ||
| ribbon_config.cc | ||
| ribbon_config.h | ||
| ribbon_impl.h | ||
| ribbon_test.cc | ||
| set_comparator.h | ||
| slice.cc | ||
| slice_test.cc | ||
| slice_transform_test.cc | ||
| status.cc | ||
| stderr_logger.h | ||
| stop_watch.h | ||
| string_util.cc | ||
| string_util.h | ||
| thread_guard.h | ||
| thread_list_test.cc | ||
| thread_local.cc | ||
| thread_local.h | ||
| thread_local_test.cc | ||
| thread_operation.h | ||
| threadpool_imp.cc | ||
| threadpool_imp.h | ||
| timer.h | ||
| timer_queue.h | ||
| timer_queue_test.cc | ||
| timer_test.cc | ||
| user_comparator_wrapper.h | ||
| vector_iterator.h | ||
| work_queue.h | ||
| work_queue_test.cc | ||
| xxhash.cc | ||
| xxhash.h | ||
| xxph3.h | ||