mirror of https://github.com/facebook/rocksdb.git
60af964372
Summary:
Added experimental public API for Ribbon filter:
NewExperimentalRibbonFilterPolicy(). This experimental API will
take a "Bloom equivalent" bits per key, and configure the Ribbon
filter for the same FP rate as Bloom would have but ~30% space
savings. (Note: optimize_filters_for_memory is not yet implemented
for Ribbon filter. That can be added with no effect on schema.)
Internally, the Ribbon filter is configured using a "one_in_fp_rate"
value, which is 1 over desired FP rate. For example, use 100 for 1%
FP rate. I'm expecting this will be used in the future for configuring
Bloom-like filters, as I expect people to more commonly hold constant
the filter accuracy and change the space vs. time trade-off, rather than
hold constant the space (per key) and change the accuracy vs. time
trade-off, though we might make that available.
### Benchmarking
```
$ ./filter_bench -impl=2 -quick -m_keys_total_max=200 -average_keys_per_filter=100000 -net_includes_hashing
Building...
Build avg ns/key: 34.1341
Number of filters: 1993
Total size (MB): 238.488
Reported total allocated memory (MB): 262.875
Reported internal fragmentation: 10.2255%
Bits/key stored: 10.0029
----------------------------
Mixed inside/outside queries...
Single filter net ns/op: 18.7508
Random filter net ns/op: 258.246
Average FP rate %: 0.968672
----------------------------
Done. (For more info, run with -legend or -help.)
$ ./filter_bench -impl=3 -quick -m_keys_total_max=200 -average_keys_per_filter=100000 -net_includes_hashing
Building...
Build avg ns/key: 130.851
Number of filters: 1993
Total size (MB): 168.166
Reported total allocated memory (MB): 183.211
Reported internal fragmentation: 8.94626%
Bits/key stored: 7.05341
----------------------------
Mixed inside/outside queries...
Single filter net ns/op: 58.4523
Random filter net ns/op: 363.717
Average FP rate %: 0.952978
----------------------------
Done. (For more info, run with -legend or -help.)
```
168.166 / 238.488 = 0.705 -> 29.5% space reduction
130.851 / 34.1341 = 3.83x construction time for this Ribbon filter vs. lastest Bloom filter (could make that as little as about 2.5x for less space reduction)
### Working around a hashing "flaw"
bloom_test discovered a flaw in the simple hashing applied in
StandardHasher when num_starts == 1 (num_slots == 128), showing an
excessively high FP rate. The problem is that when many entries, on the
order of number of hash bits or kCoeffBits, are associated with the same
start location, the correlation between the CoeffRow and ResultRow (for
efficiency) can lead to a solution that is "universal," or nearly so, for
entries mapping to that start location. (Normally, variance in start
location breaks the effective association between CoeffRow and
ResultRow; the same value for CoeffRow is effectively different if start
locations are different.) Without kUseSmash and with num_starts > 1 (thus
num_starts ~= num_slots), this flaw should be completely irrelevant. Even
with 10M slots, the chances of a single slot having just 16 (or more)
entries map to it--not enough to cause an FP problem, which would be local
to that slot if it happened--is 1 in millions. This spreadsheet formula
shows that: =1/(10000000*(1 - POISSON(15, 1, TRUE)))
As kUseSmash==false (the setting for Standard128RibbonBitsBuilder) is
intended for CPU efficiency of filters with many more entries/slots than
kCoeffBits, a very reasonable work-around is to disallow num_starts==1
when !kUseSmash, by making the minimum non-zero number of slots
2*kCoeffBits. This is the work-around I've applied. This also means that
the new Ribbon filter schema (Standard128RibbonBitsBuilder) is not
space-efficient for less than a few hundred entries. Because of this, I
have made it fall back on constructing a Bloom filter, under existing
schema, when that is more space efficient for small filters. (We can
change this in the future if we want.)
TODO: better unit tests for this case in ribbon_test, and probably
update StandardHasher for kUseSmash case so that it can scale nicely to
small filters.
### Other related changes
* Add Ribbon filter to stress/crash test
* Add Ribbon filter to filter_bench as -impl=3
* Add option string support, as in "filter_policy=experimental_ribbon:5.678;"
where 5.678 is the Bloom equivalent bits per key.
* Rename internal mode BloomFilterPolicy::kAuto to kAutoBloom
* Add a general BuiltinFilterBitsBuilder::CalculateNumEntry based on
binary searching CalculateSpace (inefficient), so that subclasses
(especially experimental ones) don't have to provide an efficient
implementation inverting CalculateSpace.
* Minor refactor FastLocalBloomBitsBuilder for new base class
XXH3pFilterBitsBuilder shared with new Standard128RibbonBitsBuilder,
which allows the latter to fall back on Bloom construction in some
extreme cases.
* Mostly updated bloom_test for Ribbon filter, though a test like
FullBloomTest::Schema is a next TODO to ensure schema stability
(in case this becomes production-ready schema as it is).
* Add some APIs to ribbon_impl.h for configuring Ribbon filters.
Although these are reasonably covered by bloom_test, TODO more unit
tests in ribbon_test
* Added a "tool" FindOccupancyForSuccessRate to ribbon_test to get data
for constructing the linear approximations in GetNumSlotsFor95PctSuccess.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/7658
Test Plan:
Some unit tests updated but other testing is left TODO. This
is considered experimental but laying down schema compatibility as early
as possible in case it proves production-quality. Also tested in
stress/crash test.
Reviewed By: jay-zhuang
Differential Revision: D24899349
Pulled By: pdillinger
fbshipit-source-id: 9715f3e6371c959d923aea8077c9423c7a9f82b8
|
||
|---|---|---|
| .. | ||
| aligned_buffer.h | ||
| autovector.h | ||
| autovector_test.cc | ||
| bloom_impl.h | ||
| bloom_test.cc | ||
| build_version.cc.in | ||
| build_version.h | ||
| 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 | ||
| 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 | ||
| repeatable_thread.h | ||
| repeatable_thread_test.cc | ||
| ribbon_alg.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_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 | ||
| xxh3p.h | ||
| xxhash.cc | ||
| xxhash.h | ||