rocksdb

fork of https://github.com/oxigraph/rocksdb and https://github.com/facebook/rocksdb for nextgraph and oxigraph

Luca Giacchino 66a95f0fac Provide an allocator for new memory type to be used with RocksDB block cache (#6214 ) Summary: New memory technologies are being developed by various hardware vendors (Intel DCPMM is one such technology currently available). These new memory types require different libraries for allocation and management (such as PMDK and memkind). The high capacities available make it possible to provision large caches (up to several TBs in size), beyond what is achievable with DRAM. The new allocator provided in this PR uses the memkind library to allocate memory on different media. Performance We tested the new allocator using db_bench. - For each test, we vary the size of the block cache (relative to the size of the uncompressed data in the database). - The database is filled sequentially. Throughput is then measured with a readrandom benchmark. - We use a uniform distribution as a worst-case scenario. The plot shows throughput (ops/s) relative to a configuration with no block cache and default allocator. For all tests, p99 latency is below 500 us. ![image](https://user-images.githubusercontent.com/26400080/71108594-42479100-2178-11ea-8231-8a775bbc92db.png) Changes - Add MemkindKmemAllocator - Add --use_cache_memkind_kmem_allocator db_bench option (to create an LRU block cache with the new allocator) - Add detection of memkind library with KMEM DAX support - Add test for MemkindKmemAllocator Minimum Requirements - kernel 5.3.12 - ndctl v67 - https://github.com/pmem/ndctl - memkind v1.10.0 - https://github.com/memkind/memkind Memory Configuration The allocator uses the MEMKIND_DAX_KMEM memory kind. Follow the instructions on[ memkind’s GitHub page](https://github.com/memkind/memkind) to set up NVDIMM memory accordingly. Note on memory allocation with NVDIMM memory exposed as system memory. - The MemkindKmemAllocator will only allocate from NVDIMM memory (using memkind_malloc with MEMKIND_DAX_KMEM kind). - The default allocator is not restricted to RAM by default. Based on NUMA node latency, the kernel should allocate from local RAM preferentially, but it’s a kernel decision. numactl --preferred/--membind can be used to allocate preferentially/exclusively from the local RAM node. Usage When creating an LRU cache, pass a MemkindKmemAllocator object as argument. For example (replace capacity with the desired value in bytes): ``` #include "rocksdb/cache.h" #include "memory/memkind_kmem_allocator.h" NewLRUCache( capacity /size_t/, 6 /cache_numshardbits/, false /strict_capacity_limit/, false /cache_high_pri_pool_ratio/, std::make_shared<MemkindKmemAllocator>()); ``` Refer to [RocksDB’s block cache documentation](https://github.com/facebook/rocksdb/wiki/Block-Cache) to assign the LRU cache as block cache for a database. Pull Request resolved: https://github.com/facebook/rocksdb/pull/6214 Reviewed By: cheng-chang Differential Revision: D19292435 fbshipit-source-id: 7202f47b769e7722b539c86c2ffd669f64d7b4e1		4 years ago
.circleci	Migrate AppVeyor to CircleCI (#6518 )	4 years ago
buckifier	Buck config: Re-enable liburing under Linux (#6451 )	4 years ago
build_tools	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
cache	Revamp cache_bench to resemble a real workload (#6629 )	4 years ago
cmake	cmake: do not build tests for Release build and cleanups (#5916 )	5 years ago
coverage	Update a few scripts to be python3 compatible (#6525 )	4 years ago
db	Fix wrong key being read on ingested file with global seqno and delta encoding (#6669 )	4 years ago
db_stress_tool	Remove GetSortedWalFiles/GetCurrentWalFile from the crash test (#6491 )	4 years ago
docs	Log warning for high bits/key in legacy Bloom filter (#6312 )	5 years ago
env	Add counter in perf_context to time cipher time (#6596 )	4 years ago
examples	Use DestroyColumnFamilyHandle instead of directly deleting column family handle (#6505 )	4 years ago
file	Fix result slice's address for direct io read (#6672 )	4 years ago
hdfs	Replace namespace name "rocksdb" with ROCKSDB_NAMESPACE (#6433 )	4 years ago
include/rocksdb	added new functions to c-api (#5630 )	4 years ago
java	Fix crash in JNI getApproximateSizes (#6652 )	4 years ago
logging	Fix info log source file display length (#5824 )	4 years ago
memory	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
memtable	Fix a bug that crashes the service when write buffer manager fails to insert to block cache (#6619 )	4 years ago
monitoring	fix compiler errors with -DNPERF_CONTEXT (#6642 )	4 years ago
options	Fix memory corruption caused by new test in options_settable_test (#6676 )	4 years ago
port	Fix jemalloc forward declarations (#6613 )	4 years ago
table	Fix wrong key being read on ingested file with global seqno and delta encoding (#6669 )	4 years ago
test_util	Simplify migration to FileSystem API (#6552 )	4 years ago
third-party	Add dependency of gtest on pthread (#6572 )	4 years ago
tools	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
trace_replay	Replace namespace name "rocksdb" with ROCKSDB_NAMESPACE (#6433 )	4 years ago
util	Add a simple timer support to schedule work at fixed times/intervals (#6543 )	4 years ago
utilities	Add unit test for TransactionLockMgr (#6599 )	4 years ago
.clang-format	A script that automatically reformat affected lines	11 years ago
.gitignore	Separate timestamp related test from db_basic_test (#6516 )	4 years ago
.lgtm.yml	Create lgtm.yml for LGTM.com C/C++ analysis (#4058 )	6 years ago
.travis.yml	Temporarily disable ppc64le unit tests in PRs (#6682 )	4 years ago
.watchmanconfig	Added .watchmanconfig file to rocksdb repo (#5593 )	5 years ago
AUTHORS	Update RocksDB Authors File	7 years ago
CMakeLists.txt	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
CODE_OF_CONDUCT.md	Adopt Contributor Covenant	5 years ago
CONTRIBUTING.md	Add Code of Conduct	7 years ago
COPYING	Add GPLv2 as an alternative license.	7 years ago
DEFAULT_OPTIONS_HISTORY.md	options.delayed_write_rate use the rate of rate_limiter by default.	7 years ago
DUMP_FORMAT.md	First version of rocksdb_dump and rocksdb_undump.	9 years ago
HISTORY.md	Add two more optimization improvements to HISTORY (#6679 )	4 years ago
INSTALL.md	Update the version of the dependencies used by the RocksJava static build (#4761 )	6 years ago
LANGUAGE-BINDINGS.md	LANGUAGE-BINDINGS.md: mention python-rocksdb	5 years ago
LICENSE.Apache	Change RocksDB License	7 years ago
LICENSE.leveldb	Add back the LevelDB license file	7 years ago
Makefile	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
README.md	Replaced some words (#5877 )	5 years ago
ROCKSDB_LITE.md	Fix some typos in comments and docs.	6 years ago
TARGETS	Add unit test for TransactionLockMgr (#6599 )	4 years ago
USERS.md	add user nebula (#6271 )	5 years ago
Vagrantfile	Adding CentOS 7 Vagrantfile & build script	6 years ago
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 )	5 years ago
appveyor.yml	Separate timestamp related test from db_basic_test (#6516 )	4 years ago
defs.bzl	Make testpilot recognize that these tests have coverage instrumentation	4 years ago
issue_template.md	Add Google Group to Issue Template	4 years ago
src.mk	Provide an allocator for new memory type to be used with RocksDB block cache (#6214 )	4 years ago
thirdparty.inc	Fix build jemalloc api (#5470 )	5 years ago

README.md

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

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 especially 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.