Go to file
Maysam Yabandeh 638d239507 Charge block cache for cache internal usage (#5797)
Summary:
For our default block cache, each additional entry has extra memory overhead. It include LRUHandle (72 bytes currently) and the cache key (two varint64, file id and offset). The usage is not negligible. For example for block_size=4k, the overhead accounts for an extra 2% memory usage for the cache. The patch charging the cache for the extra usage, reducing untracked memory usage outside block cache. The feature is enabled by default and can be disabled by passing kDontChargeCacheMetadata to the cache constructor.
This PR builds up on https://github.com/facebook/rocksdb/issues/4258
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5797

Test Plan:
- Existing tests are updated to either disable the feature when the test has too much dependency on the old way of accounting the usage or increasing the cache capacity to account for the additional charge of metadata.
- The Usage tests in cache_test.cc are augmented to test the cache usage under kFullChargeCacheMetadata.

Differential Revision: D17396833

Pulled By: maysamyabandeh

fbshipit-source-id: 7684ccb9f8a40ca595e4f5efcdb03623afea0c6f
2019-09-16 15:26:21 -07:00
buckifier Change buckifier to support parameterized dependencies (#5648) 2019-08-02 10:55:17 -07:00
build_tools Clean up + fix build scripts re: USE_SSE= and PORTABLE= (#5800) 2019-09-13 11:07:13 -07:00
cache Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
cmake cmake: s/SNAPPY_LIBRARIES/snappy_LIBRARIES/ (#5687) 2019-08-16 15:49:23 -07:00
coverage Fix interpreter lines for files with python2-only syntax. 2019-07-09 10:51:37 -07:00
db Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
docs Blog post for write_unprepared (#5711) 2019-08-15 14:41:13 -07:00
env Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
examples Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
file Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
hdfs Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
include/rocksdb Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
java test size was wrong in 'fillbatch' benchmark (#5198) 2019-09-11 12:04:44 -07:00
logging Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
memory Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
memtable Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
monitoring Use delete to disable automatic generated methods. (#5009) 2019-09-11 18:09:00 -07:00
options Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
port Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
table Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
test_util Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
third-party Revert changes from PR#5784 accidentally in PR#5780 (#5810) 2019-09-16 11:38:53 -07:00
tools Temporarily disable partitioned index/filter in stress test (#5811) 2019-09-16 11:41:35 -07:00
trace_replay Block cache analyzer: Support reading from human readable trace file. (#5679) 2019-08-09 13:13:54 -07:00
util Revert changes from PR#5784 accidentally in PR#5780 (#5810) 2019-09-16 11:38:53 -07:00
utilities Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.gitignore Block cache simulator: Add pysim to simulate caches using reinforcement learning. (#5610) 2019-07-26 14:41:13 -07:00
.lgtm.yml Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -07:00
.travis.yml Switch Travis to Xenial build (#4789) 2019-06-17 10:20:02 -07:00
.watchmanconfig Added .watchmanconfig file to rocksdb repo (#5593) 2019-07-19 15:00:33 -07:00
AUTHORS Update RocksDB Authors File 2017-10-18 14:42:10 -07:00
CMakeLists.txt Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:21:01 -07:00
CONTRIBUTING.md Add Code of Conduct 2017-12-05 18:42:35 -08:00
COPYING Add GPLv2 as an alternative license. 2017-04-27 18:06:12 -07:00
DEFAULT_OPTIONS_HISTORY.md options.delayed_write_rate use the rate of rate_limiter by default. 2017-05-24 09:58:24 -07:00
DUMP_FORMAT.md First version of rocksdb_dump and rocksdb_undump. 2015-06-19 16:24:36 -07:00
HISTORY.md Charge block cache for cache internal usage (#5797) 2019-09-16 15:26:21 -07:00
INSTALL.md Update the version of the dependencies used by the RocksJava static build (#4761) 2018-12-18 20:25:43 -08:00
LANGUAGE-BINDINGS.md LANGUAGE-BINDINGS.md: mention python-rocksdb 2019-03-20 11:10:48 -07:00
LICENSE.Apache Change RocksDB License 2017-07-15 16:11:23 -07:00
LICENSE.leveldb Add back the LevelDB license file 2017-07-16 18:42:18 -07:00
Makefile Revert changes from PR#5784 accidentally in PR#5780 (#5810) 2019-09-16 11:38:53 -07:00
README.md Add LevelDB repository link in the Readme 2019-04-01 18:19:09 -07:00
ROCKSDB_LITE.md Fix some typos in comments and docs. 2018-03-08 10:27:25 -08:00
TARGETS Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
USERS.md Add avrio to USERS.md (#5748) 2019-09-15 21:29:09 -07:00
Vagrantfile Adding CentOS 7 Vagrantfile & build script 2018-02-26 15:27:17 -08:00
WINDOWS_PORT.md #5145 , rename port/dirent.h to port/port_dirent.h to avoid compile err when use port dir as header dir output (#5152) 2019-04-04 11:38:19 -07:00
appveyor.yml New API to get all merge operands for a Key (#5604) 2019-08-06 14:26:44 -07:00
defs.bzl Change buckifier to support parameterized dependencies (#5648) 2019-08-02 10:55:17 -07:00
issue_template.md Add a template for issues 2017-09-29 11:41:28 -07:00
src.mk Divide file_reader_writer.h and .cc (#5803) 2019-09-16 10:33:51 -07:00
thirdparty.inc Fix build jemalloc api (#5470) 2019-06-24 17:40:32 -07:00

README.md

RocksDB: A Persistent Key-Value Store for Flash and RAM Storage

Linux/Mac Build Status Windows Build status PPC64le Build Status

RocksDB is developed and maintained by Facebook Database Engineering Team. It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)

This code is a library that forms the core building block for a fast key value server, especially suited for storing data on flash drives. It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF) and Space-Amplification-Factor (SAF). It has multi-threaded compactions, making it specially suitable for storing multiple terabytes of data in a single database.

Start with example usage here: https://github.com/facebook/rocksdb/tree/master/examples

See the github wiki for more explanation.

The public interface is in include/. Callers should not include or rely on the details of any other header files in this package. Those internal APIs may be changed without warning.

Design discussions are conducted in https://www.facebook.com/groups/rocksdb.dev/

License

RocksDB is dual-licensed under both the GPLv2 (found in the COPYING file in the root directory) and Apache 2.0 License (found in the LICENSE.Apache file in the root directory). You may select, at your option, one of the above-listed licenses.