rocksdb/java/rocksjni
Adam Retter 7242dae7fe Improve RocksJava Comparator (#6252)
Summary:
This is a redesign of the API for RocksJava comparators with the aim of improving performance. It also simplifies the class hierarchy.

**NOTE**: This breaks backwards compatibility for existing 3rd party Comparators implemented in Java... so we need to consider carefully which release branches this goes into.

Previously when implementing a comparator in Java the developer had a choice of subclassing either `DirectComparator` or `Comparator` which would use direct and non-direct byte-buffers resepectively (via `DirectSlice` and `Slice`).

In this redesign there we have eliminated the overhead of using the Java Slice classes, and just use `ByteBuffer`s. The `ComparatorOptions` supplied when constructing a Comparator allow you to choose between direct and non-direct byte buffers by setting `useDirect`.

In addition, the `ComparatorOptions` now allow you to choose whether a ByteBuffer is reused over multiple comparator calls, by setting `maxReusedBufferSize > 0`. When buffers are reused, ComparatorOptions provides a choice of mutex type by setting `useAdaptiveMutex`.

 ---
[JMH benchmarks previously indicated](https://github.com/facebook/rocksdb/pull/6241#issue-356398306) that the difference between C++ and Java for implementing a comparator was ~7x slowdown in Java.

With these changes, when reusing buffers and guarding access to them via mutexes the slowdown is approximately the same. However, these changes offer a new facility to not reuse mutextes, which reduces the slowdown to ~5.5x in Java. We also offer a `thread_local` mechanism for reusing buffers, which reduces slowdown to ~5.2x in Java (closes https://github.com/facebook/rocksdb/pull/4425).

These changes also form a good base for further optimisation work such as further JNI lookup caching, and JNI critical.

 ---
These numbers were captured without jemalloc. With jemalloc, the performance improves for all tests, and the Java slowdown reduces to between 4.8x and 5.x.

```
ComparatorBenchmarks.put                                                native_bytewise  thrpt   25  124483.795 ± 2032.443  ops/s
ComparatorBenchmarks.put                                        native_reverse_bytewise  thrpt   25  114414.536 ± 3486.156  ops/s
ComparatorBenchmarks.put              java_bytewise_non-direct_reused-64_adaptive-mutex  thrpt   25   17228.250 ± 1288.546  ops/s
ComparatorBenchmarks.put          java_bytewise_non-direct_reused-64_non-adaptive-mutex  thrpt   25   16035.865 ± 1248.099  ops/s
ComparatorBenchmarks.put                java_bytewise_non-direct_reused-64_thread-local  thrpt   25   21571.500 ±  871.521  ops/s
ComparatorBenchmarks.put                  java_bytewise_direct_reused-64_adaptive-mutex  thrpt   25   23613.773 ± 8465.660  ops/s
ComparatorBenchmarks.put              java_bytewise_direct_reused-64_non-adaptive-mutex  thrpt   25   16768.172 ± 5618.489  ops/s
ComparatorBenchmarks.put                    java_bytewise_direct_reused-64_thread-local  thrpt   25   23921.164 ± 8734.742  ops/s
ComparatorBenchmarks.put                              java_bytewise_non-direct_no-reuse  thrpt   25   17899.684 ±  839.679  ops/s
ComparatorBenchmarks.put                                  java_bytewise_direct_no-reuse  thrpt   25   22148.316 ± 1215.527  ops/s
ComparatorBenchmarks.put      java_reverse_bytewise_non-direct_reused-64_adaptive-mutex  thrpt   25   11311.126 ±  820.602  ops/s
ComparatorBenchmarks.put  java_reverse_bytewise_non-direct_reused-64_non-adaptive-mutex  thrpt   25   11421.311 ±  807.210  ops/s
ComparatorBenchmarks.put        java_reverse_bytewise_non-direct_reused-64_thread-local  thrpt   25   11554.005 ±  960.556  ops/s
ComparatorBenchmarks.put          java_reverse_bytewise_direct_reused-64_adaptive-mutex  thrpt   25   22960.523 ± 1673.421  ops/s
ComparatorBenchmarks.put      java_reverse_bytewise_direct_reused-64_non-adaptive-mutex  thrpt   25   18293.317 ± 1434.601  ops/s
ComparatorBenchmarks.put            java_reverse_bytewise_direct_reused-64_thread-local  thrpt   25   24479.361 ± 2157.306  ops/s
ComparatorBenchmarks.put                      java_reverse_bytewise_non-direct_no-reuse  thrpt   25    7942.286 ±  626.170  ops/s
ComparatorBenchmarks.put                          java_reverse_bytewise_direct_no-reuse  thrpt   25   11781.955 ± 1019.843  ops/s
```
Pull Request resolved: https://github.com/facebook/rocksdb/pull/6252

Differential Revision: D19331064

Pulled By: pdillinger

fbshipit-source-id: 1f3b794e6a14162b2c3ffb943e8c0e64a0c03738
2020-02-03 12:30:13 -08:00
..
backupablejni.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
backupenginejni.cc Support range deletion tombstones in IngestExternalFile SSTs (#3778) 2018-07-13 22:43:09 -07:00
cassandra_compactionfilterjni.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
cassandra_value_operator.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
checkpoint.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
clock_cache.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
columnfamilyhandle.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
compact_range_options.cc Add CompactRangeOptions for Java (#4220) 2018-08-17 10:57:25 -07:00
compaction_filter_factory_jnicallback.cc Added CompactionFilterFactory support to RocksJava 2017-10-12 11:12:16 -07:00
compaction_filter_factory_jnicallback.h Added CompactionFilterFactory support to RocksJava 2017-10-12 11:12:16 -07:00
compaction_filter_factory.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
compaction_filter.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
compaction_job_info.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
compaction_job_stats.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
compaction_options_fifo.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
compaction_options_universal.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
compaction_options.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
comparator.cc Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
comparatorjnicallback.cc Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
comparatorjnicallback.h Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
compression_options.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
env_options.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
env.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
filter.cc Allow fractional bits/key in BloomFilterPolicy (#6092) 2019-11-26 15:59:34 -08:00
ingest_external_file_options.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
iterator.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
jnicallback.cc Suppress lint in old files 2018-01-29 12:56:42 -08:00
jnicallback.h Suppress lint in old files 2018-01-29 12:56:42 -08:00
loggerjnicallback.cc Remove invalid comparison of va_list and nullptr (#5836) 2019-09-23 12:15:01 -07:00
loggerjnicallback.h Added CompactionFilterFactory support to RocksJava 2017-10-12 11:12:16 -07:00
lru_cache.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
memory_util.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
memtablejni.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
merge_operator.cc Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
native_comparator_wrapper_test.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
optimistic_transaction_db.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
optimistic_transaction_options.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
options_util.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
options.cc Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
persistent_cache.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
portal.h Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
ratelimiterjni.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
remove_emptyvalue_compactionfilterjni.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
restorejni.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
rocks_callback_object.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
rocksdb_exception_test.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
rocksjni.cc RocksDB#keyMayExist should not assume database values are unicode strings (#6186) 2019-12-20 14:27:58 -08:00
slice.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
snapshot.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
sst_file_manager.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
sst_file_reader_iterator.cc Apply formatter on recent 45 commits. (#5827) 2019-09-19 12:34:17 -07:00
sst_file_readerjni.cc Apply formatter on recent 45 commits. (#5827) 2019-09-19 12:34:17 -07:00
sst_file_writerjni.cc Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
statistics.cc Make statistics's stats_level change thread-safe (#5030) 2019-03-01 10:42:09 -08:00
statisticsjni.cc Get CompactionJobInfo from CompactFiles 2018-12-13 14:21:24 -08:00
statisticsjni.h Suppress lint in old files 2018-01-29 12:56:42 -08:00
table_filter_jnicallback.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
table_filter_jnicallback.h Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
table_filter.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
table.cc JNI: Do not create 8M block cache for negative blockCacheSize values (#5465) 2019-06-24 11:37:04 -07:00
thread_status.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
trace_writer_jnicallback.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
trace_writer_jnicallback.h Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
trace_writer.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
transaction_db_options.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
transaction_db.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
transaction_log.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
transaction_notifier_jnicallback.cc Add TransactionDB and OptimisticTransactionDB to the Java API 2018-03-02 10:34:13 -08:00
transaction_notifier_jnicallback.h Add TransactionDB and OptimisticTransactionDB to the Java API 2018-03-02 10:34:13 -08:00
transaction_notifier.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
transaction_options.cc comment unused parameters to turn on -Wunused-parameter flag 2018-04-12 17:59:16 -07:00
transaction.cc Extend Transaction::GetForUpdate with do_validate (#4680) 2018-12-06 17:49:00 -08:00
ttl.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
wal_filter_jnicallback.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
wal_filter_jnicallback.h Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
wal_filter.cc Add missing functionality to RocksJava (#4833) 2019-02-22 14:46:46 -08:00
write_batch_test.cc upgrade gtest 1.7.0 => 1.8.1 for json result writing 2019-09-09 11:24:11 -07:00
write_batch_with_index.cc Improve RocksJava Comparator (#6252) 2020-02-03 12:30:13 -08:00
write_batch.cc Move some logging related files to logging/ (#5387) 2019-05-31 17:23:59 -07:00
write_buffer_manager.cc Plumb WriteBufferManager through JNI (#4492) 2018-10-17 11:49:57 -07:00
writebatchhandlerjnicallback.cc Remove warnings caused by unused variables in jni (#4345) 2018-09-05 13:42:34 -07:00
writebatchhandlerjnicallback.h WriteUnPrepared: Add support for recovering WriteUnprepared transactions (#4078) 2018-07-06 17:59:13 -07:00