|
|
|
|
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
|
|
|
// This source code is 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).
|
|
|
|
|
//
|
|
|
|
|
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
|
|
|
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
|
|
|
// found in the LICENSE file. See the AUTHORS file for names of contributors.
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
#include <cctype>
|
|
|
|
|
#include <cstring>
|
|
|
|
|
#include <unordered_map>
|
|
|
|
|
#include <cinttypes>
|
|
|
|
|
|
|
|
|
|
#include "cache/lru_cache.h"
|
|
|
|
|
#include "cache/sharded_cache.h"
|
|
|
|
|
#include "options/options_helper.h"
|
|
|
|
|
#include "options/options_parser.h"
|
|
|
|
|
#include "options/options_sanity_check.h"
|
|
|
|
|
#include "port/port.h"
|
|
|
|
|
#include "rocksdb/cache.h"
|
|
|
|
|
#include "rocksdb/convenience.h"
|
|
|
|
|
#include "rocksdb/memtablerep.h"
|
|
|
|
|
#include "rocksdb/utilities/leveldb_options.h"
|
|
|
|
|
#include "rocksdb/utilities/object_registry.h"
|
|
|
|
|
#include "test_util/testharness.h"
|
|
|
|
|
#include "test_util/testutil.h"
|
|
|
|
|
#include "util/random.h"
|
|
|
|
|
#include "util/stderr_logger.h"
|
|
|
|
|
#include "util/string_util.h"
|
|
|
|
|
#include "utilities/merge_operators/bytesxor.h"
|
|
|
|
|
|
|
|
|
|
#ifndef GFLAGS
|
|
|
|
|
bool FLAGS_enable_print = false;
|
|
|
|
|
#else
|
|
|
|
|
#include "util/gflags_compat.h"
|
|
|
|
|
using GFLAGS_NAMESPACE::ParseCommandLineFlags;
|
|
|
|
|
DEFINE_bool(enable_print, false, "Print options generated to console.");
|
|
|
|
|
#endif // GFLAGS
|
|
|
|
|
|
|
|
|
|
namespace rocksdb {
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
class OptionsTest : public testing::Test {};
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetOptionsFromMap is not supported in ROCKSDB_LITE
|
|
|
|
|
TEST_F(OptionsTest, GetOptionsFromMapTest) {
|
|
|
|
|
std::unordered_map<std::string, std::string> cf_options_map = {
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"write_buffer_size", "1"},
|
|
|
|
|
{"max_write_buffer_number", "2"},
|
|
|
|
|
{"min_write_buffer_number_to_merge", "3"},
|
|
|
|
|
{"max_write_buffer_number_to_maintain", "99"},
|
Refactor trimming logic for immutable memtables (#5022)
Summary:
MyRocks currently sets `max_write_buffer_number_to_maintain` in order to maintain enough history for transaction conflict checking. The effectiveness of this approach depends on the size of memtables. When memtables are small, it may not keep enough history; when memtables are large, this may consume too much memory.
We are proposing a new way to configure memtable list history: by limiting the memory usage of immutable memtables. The new option is `max_write_buffer_size_to_maintain` and it will take precedence over the old `max_write_buffer_number_to_maintain` if they are both set to non-zero values. The new option accounts for the total memory usage of flushed immutable memtables and mutable memtable. When the total usage exceeds the limit, RocksDB may start dropping immutable memtables (which is also called trimming history), starting from the oldest one.
The semantics of the old option actually works both as an upper bound and lower bound. History trimming will start if number of immutable memtables exceeds the limit, but it will never go below (limit-1) due to history trimming.
In order the mimic the behavior with the new option, history trimming will stop if dropping the next immutable memtable causes the total memory usage go below the size limit. For example, assuming the size limit is set to 64MB, and there are 3 immutable memtables with sizes of 20, 30, 30. Although the total memory usage is 80MB > 64MB, dropping the oldest memtable will reduce the memory usage to 60MB < 64MB, so in this case no memtable will be dropped.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5022
Differential Revision: D14394062
Pulled By: miasantreble
fbshipit-source-id: 60457a509c6af89d0993f988c9b5c2aa9e45f5c5
5 years ago
|
|
|
{"max_write_buffer_size_to_maintain", "-99999"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"compression", "kSnappyCompression"},
|
|
|
|
|
{"compression_per_level",
|
|
|
|
|
"kNoCompression:"
|
|
|
|
|
"kSnappyCompression:"
|
|
|
|
|
"kZlibCompression:"
|
|
|
|
|
"kBZip2Compression:"
|
|
|
|
|
"kLZ4Compression:"
|
|
|
|
|
"kLZ4HCCompression:"
|
|
|
|
|
"kXpressCompression:"
|
|
|
|
|
"kZSTD:"
|
|
|
|
|
"kZSTDNotFinalCompression"},
|
|
|
|
|
{"bottommost_compression", "kLZ4Compression"},
|
|
|
|
|
{"bottommost_compression_opts", "5:6:7:8:9:true"},
|
|
|
|
|
{"compression_opts", "4:5:6:7:8:true"},
|
|
|
|
|
{"num_levels", "8"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"level0_file_num_compaction_trigger", "8"},
|
|
|
|
|
{"level0_slowdown_writes_trigger", "9"},
|
|
|
|
|
{"level0_stop_writes_trigger", "10"},
|
|
|
|
|
{"target_file_size_base", "12"},
|
|
|
|
|
{"target_file_size_multiplier", "13"},
|
|
|
|
|
{"max_bytes_for_level_base", "14"},
|
|
|
|
|
{"snap_refresh_nanos", "1000000000"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"level_compaction_dynamic_level_bytes", "true"},
|
|
|
|
|
{"max_bytes_for_level_multiplier", "15.0"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"max_bytes_for_level_multiplier_additional", "16:17:18"},
|
|
|
|
|
{"max_compaction_bytes", "21"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"soft_rate_limit", "1.1"},
|
|
|
|
|
{"hard_rate_limit", "2.1"},
|
|
|
|
|
{"hard_pending_compaction_bytes_limit", "211"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"arena_block_size", "22"},
|
|
|
|
|
{"disable_auto_compactions", "true"},
|
|
|
|
|
{"compaction_style", "kCompactionStyleLevel"},
|
|
|
|
|
{"compaction_pri", "kOldestSmallestSeqFirst"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"verify_checksums_in_compaction", "false"},
|
|
|
|
|
{"compaction_options_fifo", "23"},
|
|
|
|
|
{"max_sequential_skip_in_iterations", "24"},
|
|
|
|
|
{"inplace_update_support", "true"},
|
|
|
|
|
{"report_bg_io_stats", "true"},
|
|
|
|
|
{"compaction_measure_io_stats", "false"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"inplace_update_num_locks", "25"},
|
|
|
|
|
{"memtable_prefix_bloom_size_ratio", "0.26"},
|
|
|
|
|
{"memtable_whole_key_filtering", "true"},
|
|
|
|
|
{"memtable_huge_page_size", "28"},
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
{"bloom_locality", "29"},
|
|
|
|
|
{"max_successive_merges", "30"},
|
|
|
|
|
{"min_partial_merge_operands", "31"},
|
|
|
|
|
{"prefix_extractor", "fixed:31"},
|
|
|
|
|
{"optimize_filters_for_hits", "true"},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
std::unordered_map<std::string, std::string> db_options_map = {
|
|
|
|
|
{"create_if_missing", "false"},
|
|
|
|
|
{"create_missing_column_families", "true"},
|
|
|
|
|
{"error_if_exists", "false"},
|
|
|
|
|
{"paranoid_checks", "true"},
|
|
|
|
|
{"max_open_files", "32"},
|
|
|
|
|
{"max_total_wal_size", "33"},
|
|
|
|
|
{"use_fsync", "true"},
|
|
|
|
|
{"db_log_dir", "/db_log_dir"},
|
|
|
|
|
{"wal_dir", "/wal_dir"},
|
|
|
|
|
{"delete_obsolete_files_period_micros", "34"},
|
|
|
|
|
{"max_background_compactions", "35"},
|
|
|
|
|
{"max_background_flushes", "36"},
|
|
|
|
|
{"max_log_file_size", "37"},
|
|
|
|
|
{"log_file_time_to_roll", "38"},
|
|
|
|
|
{"keep_log_file_num", "39"},
|
|
|
|
|
{"recycle_log_file_num", "5"},
|
|
|
|
|
{"max_manifest_file_size", "40"},
|
|
|
|
|
{"table_cache_numshardbits", "41"},
|
|
|
|
|
{"WAL_ttl_seconds", "43"},
|
|
|
|
|
{"WAL_size_limit_MB", "44"},
|
|
|
|
|
{"manifest_preallocation_size", "45"},
|
|
|
|
|
{"allow_mmap_reads", "true"},
|
|
|
|
|
{"allow_mmap_writes", "false"},
|
|
|
|
|
{"use_direct_reads", "false"},
|
|
|
|
|
{"use_direct_io_for_flush_and_compaction", "false"},
|
|
|
|
|
{"is_fd_close_on_exec", "true"},
|
|
|
|
|
{"skip_log_error_on_recovery", "false"},
|
|
|
|
|
{"stats_dump_period_sec", "46"},
|
|
|
|
|
{"stats_persist_period_sec", "57"},
|
|
|
|
|
{"persist_stats_to_disk", "false"},
|
|
|
|
|
{"stats_history_buffer_size", "69"},
|
|
|
|
|
{"advise_random_on_open", "true"},
|
|
|
|
|
{"use_adaptive_mutex", "false"},
|
|
|
|
|
{"new_table_reader_for_compaction_inputs", "true"},
|
|
|
|
|
{"compaction_readahead_size", "100"},
|
|
|
|
|
{"random_access_max_buffer_size", "3145728"},
|
|
|
|
|
{"writable_file_max_buffer_size", "314159"},
|
|
|
|
|
{"bytes_per_sync", "47"},
|
|
|
|
|
{"wal_bytes_per_sync", "48"},
|
Optionally wait on bytes_per_sync to smooth I/O (#5183)
Summary:
The existing implementation does not guarantee bytes reach disk every `bytes_per_sync` when writing SST files, or every `wal_bytes_per_sync` when writing WALs. This can cause confusing behavior for users who enable this feature to avoid large syncs during flush and compaction, but then end up hitting them anyways.
My understanding of the existing behavior is we used `sync_file_range` with `SYNC_FILE_RANGE_WRITE` to submit ranges for async writeback, such that we could continue processing the next range of bytes while that I/O is happening. I believe we can preserve that benefit while also limiting how far the processing can get ahead of the I/O, which prevents huge syncs from happening when the file finishes.
Consider this `sync_file_range` usage: `sync_file_range(fd_, 0, static_cast<off_t>(offset + nbytes), SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE)`. Expanding the range to start at 0 and adding the `SYNC_FILE_RANGE_WAIT_BEFORE` flag causes any pending writeback (like from a previous call to `sync_file_range`) to finish before it proceeds to submit the latest `nbytes` for writeback. The latest `nbytes` are still written back asynchronously, unless processing exceeds I/O speed, in which case the following `sync_file_range` will need to wait on it.
There is a second change in this PR to use `fdatasync` when `sync_file_range` is unavailable (determined statically) or has some known problem with the underlying filesystem (determined dynamically).
The above two changes only apply when the user enables a new option, `strict_bytes_per_sync`.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5183
Differential Revision: D14953553
Pulled By: siying
fbshipit-source-id: 445c3862e019fb7b470f9c7f314fc231b62706e9
6 years ago
|
|
|
{"strict_bytes_per_sync", "true"},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
ColumnFamilyOptions base_cf_opt;
|
|
|
|
|
ColumnFamilyOptions new_cf_opt;
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromMap(
|
|
|
|
|
base_cf_opt, cf_options_map, &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 1U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number, 2);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.min_write_buffer_number_to_merge, 3);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number_to_maintain, 99);
|
Refactor trimming logic for immutable memtables (#5022)
Summary:
MyRocks currently sets `max_write_buffer_number_to_maintain` in order to maintain enough history for transaction conflict checking. The effectiveness of this approach depends on the size of memtables. When memtables are small, it may not keep enough history; when memtables are large, this may consume too much memory.
We are proposing a new way to configure memtable list history: by limiting the memory usage of immutable memtables. The new option is `max_write_buffer_size_to_maintain` and it will take precedence over the old `max_write_buffer_number_to_maintain` if they are both set to non-zero values. The new option accounts for the total memory usage of flushed immutable memtables and mutable memtable. When the total usage exceeds the limit, RocksDB may start dropping immutable memtables (which is also called trimming history), starting from the oldest one.
The semantics of the old option actually works both as an upper bound and lower bound. History trimming will start if number of immutable memtables exceeds the limit, but it will never go below (limit-1) due to history trimming.
In order the mimic the behavior with the new option, history trimming will stop if dropping the next immutable memtable causes the total memory usage go below the size limit. For example, assuming the size limit is set to 64MB, and there are 3 immutable memtables with sizes of 20, 30, 30. Although the total memory usage is 80MB > 64MB, dropping the oldest memtable will reduce the memory usage to 60MB < 64MB, so in this case no memtable will be dropped.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5022
Differential Revision: D14394062
Pulled By: miasantreble
fbshipit-source-id: 60457a509c6af89d0993f988c9b5c2aa9e45f5c5
5 years ago
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_size_to_maintain, -99999);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression, kSnappyCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level.size(), 9U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[0], kNoCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[1], kSnappyCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[2], kZlibCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[3], kBZip2Compression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[4], kLZ4Compression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[5], kLZ4HCCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[6], kXpressCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[7], kZSTD);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level[8], kZSTDNotFinalCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.window_bits, 4);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.level, 5);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.strategy, 6);
|
Shared dictionary compression using reference block
Summary:
This adds a new metablock containing a shared dictionary that is used
to compress all data blocks in the SST file. The size of the shared dictionary
is configurable in CompressionOptions and defaults to 0. It's currently only
used for zlib/lz4/lz4hc, but the block will be stored in the SST regardless of
the compression type if the user chooses a nonzero dictionary size.
During compaction, computes the dictionary by randomly sampling the first
output file in each subcompaction. It pre-computes the intervals to sample
by assuming the output file will have the maximum allowable length. In case
the file is smaller, some of the pre-computed sampling intervals can be beyond
end-of-file, in which case we skip over those samples and the dictionary will
be a bit smaller. After the dictionary is generated using the first file in a
subcompaction, it is loaded into the compression library before writing each
block in each subsequent file of that subcompaction.
On the read path, gets the dictionary from the metablock, if it exists. Then,
loads that dictionary into the compression library before reading each block.
Test Plan: new unit test
Reviewers: yhchiang, IslamAbdelRahman, cyan, sdong
Reviewed By: sdong
Subscribers: andrewkr, yoshinorim, kradhakrishnan, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D52287
9 years ago
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.max_dict_bytes, 7);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.zstd_max_train_bytes, 8);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_opts.enabled, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression, kLZ4Compression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.window_bits, 5);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.level, 6);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.strategy, 7);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.max_dict_bytes, 8);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.zstd_max_train_bytes, 9);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bottommost_compression_opts.enabled, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.num_levels, 8);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.level0_file_num_compaction_trigger, 8);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.level0_slowdown_writes_trigger, 9);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.level0_stop_writes_trigger, 10);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.target_file_size_base, static_cast<uint64_t>(12));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.target_file_size_multiplier, 13);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_base, 14U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.snap_refresh_nanos, 1000000000U);
|
options.level_compaction_dynamic_level_bytes to allow RocksDB to pick size bases of levels dynamically.
Summary:
When having fixed max_bytes_for_level_base, the ratio of size of largest level and the second one can range from 0 to the multiplier. This makes LSM tree frequently irregular and unpredictable. It can also cause poor space amplification in some cases.
In this improvement (proposed by Igor Kabiljo), we introduce a parameter option.level_compaction_use_dynamic_max_bytes. When turning it on, RocksDB is free to pick a level base in the range of (options.max_bytes_for_level_base/options.max_bytes_for_level_multiplier, options.max_bytes_for_level_base] so that real level ratios are close to options.max_bytes_for_level_multiplier.
Test Plan: New unit tests and pass tests suites including valgrind.
Reviewers: MarkCallaghan, rven, yhchiang, igor, ikabiljo
Reviewed By: ikabiljo
Subscribers: yoshinorim, ikabiljo, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D31437
10 years ago
|
|
|
ASSERT_EQ(new_cf_opt.level_compaction_dynamic_level_bytes, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_multiplier, 15.0);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_multiplier_additional.size(), 3U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_multiplier_additional[0], 16);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_multiplier_additional[1], 17);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_bytes_for_level_multiplier_additional[2], 18);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_compaction_bytes, 21);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.hard_pending_compaction_bytes_limit, 211);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.arena_block_size, 22U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.disable_auto_compactions, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compaction_style, kCompactionStyleLevel);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compaction_pri, kOldestSmallestSeqFirst);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compaction_options_fifo.max_table_files_size,
|
|
|
|
|
static_cast<uint64_t>(23));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_sequential_skip_in_iterations,
|
|
|
|
|
static_cast<uint64_t>(24));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.inplace_update_support, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.inplace_update_num_locks, 25U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_prefix_bloom_size_ratio, 0.26);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_whole_key_filtering, true);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_huge_page_size, 28U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bloom_locality, 29U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_successive_merges, 30U);
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.prefix_extractor != nullptr);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.optimize_filters_for_hits, true);
|
|
|
|
|
ASSERT_EQ(std::string(new_cf_opt.prefix_extractor->Name()),
|
|
|
|
|
"rocksdb.FixedPrefix.31");
|
|
|
|
|
|
|
|
|
|
cf_options_map["write_buffer_size"] = "hello";
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromMap(
|
|
|
|
|
base_cf_opt, cf_options_map, &new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
cf_options_map["write_buffer_size"] = "1";
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromMap(
|
|
|
|
|
base_cf_opt, cf_options_map, &new_cf_opt));
|
|
|
|
|
|
|
|
|
|
cf_options_map["unknown_option"] = "1";
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromMap(
|
|
|
|
|
base_cf_opt, cf_options_map, &new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromMap(base_cf_opt, cf_options_map,
|
|
|
|
|
&new_cf_opt,
|
|
|
|
|
false, /* input_strings_escaped */
|
|
|
|
|
true /* ignore_unknown_options */));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
base_cf_opt, new_cf_opt, nullptr, /* new_opt_map */
|
|
|
|
|
kSanityLevelLooselyCompatible /* from CheckOptionsCompatibility*/));
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
base_cf_opt, new_cf_opt, nullptr, /* new_opt_map */
|
|
|
|
|
kSanityLevelExactMatch /* default for VerifyCFOptions */));
|
|
|
|
|
|
|
|
|
|
DBOptions base_db_opt;
|
|
|
|
|
DBOptions new_db_opt;
|
|
|
|
|
ASSERT_OK(GetDBOptionsFromMap(base_db_opt, db_options_map, &new_db_opt));
|
|
|
|
|
ASSERT_EQ(new_db_opt.create_if_missing, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.create_missing_column_families, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.error_if_exists, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.paranoid_checks, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_open_files, 32);
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_total_wal_size, static_cast<uint64_t>(33));
|
|
|
|
|
ASSERT_EQ(new_db_opt.use_fsync, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.db_log_dir, "/db_log_dir");
|
|
|
|
|
ASSERT_EQ(new_db_opt.wal_dir, "/wal_dir");
|
|
|
|
|
ASSERT_EQ(new_db_opt.delete_obsolete_files_period_micros,
|
|
|
|
|
static_cast<uint64_t>(34));
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_background_compactions, 35);
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_background_flushes, 36);
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_log_file_size, 37U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.log_file_time_to_roll, 38U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.keep_log_file_num, 39U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.recycle_log_file_num, 5U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.max_manifest_file_size, static_cast<uint64_t>(40));
|
|
|
|
|
ASSERT_EQ(new_db_opt.table_cache_numshardbits, 41);
|
|
|
|
|
ASSERT_EQ(new_db_opt.WAL_ttl_seconds, static_cast<uint64_t>(43));
|
|
|
|
|
ASSERT_EQ(new_db_opt.WAL_size_limit_MB, static_cast<uint64_t>(44));
|
|
|
|
|
ASSERT_EQ(new_db_opt.manifest_preallocation_size, 45U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.allow_mmap_reads, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.allow_mmap_writes, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.use_direct_reads, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.use_direct_io_for_flush_and_compaction, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.is_fd_close_on_exec, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.skip_log_error_on_recovery, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.stats_dump_period_sec, 46U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.stats_persist_period_sec, 57U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.persist_stats_to_disk, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.stats_history_buffer_size, 69U);
|
|
|
|
|
ASSERT_EQ(new_db_opt.advise_random_on_open, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.use_adaptive_mutex, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.new_table_reader_for_compaction_inputs, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.compaction_readahead_size, 100);
|
|
|
|
|
ASSERT_EQ(new_db_opt.random_access_max_buffer_size, 3145728);
|
|
|
|
|
ASSERT_EQ(new_db_opt.writable_file_max_buffer_size, 314159);
|
|
|
|
|
ASSERT_EQ(new_db_opt.bytes_per_sync, static_cast<uint64_t>(47));
|
|
|
|
|
ASSERT_EQ(new_db_opt.wal_bytes_per_sync, static_cast<uint64_t>(48));
|
Optionally wait on bytes_per_sync to smooth I/O (#5183)
Summary:
The existing implementation does not guarantee bytes reach disk every `bytes_per_sync` when writing SST files, or every `wal_bytes_per_sync` when writing WALs. This can cause confusing behavior for users who enable this feature to avoid large syncs during flush and compaction, but then end up hitting them anyways.
My understanding of the existing behavior is we used `sync_file_range` with `SYNC_FILE_RANGE_WRITE` to submit ranges for async writeback, such that we could continue processing the next range of bytes while that I/O is happening. I believe we can preserve that benefit while also limiting how far the processing can get ahead of the I/O, which prevents huge syncs from happening when the file finishes.
Consider this `sync_file_range` usage: `sync_file_range(fd_, 0, static_cast<off_t>(offset + nbytes), SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE)`. Expanding the range to start at 0 and adding the `SYNC_FILE_RANGE_WAIT_BEFORE` flag causes any pending writeback (like from a previous call to `sync_file_range`) to finish before it proceeds to submit the latest `nbytes` for writeback. The latest `nbytes` are still written back asynchronously, unless processing exceeds I/O speed, in which case the following `sync_file_range` will need to wait on it.
There is a second change in this PR to use `fdatasync` when `sync_file_range` is unavailable (determined statically) or has some known problem with the underlying filesystem (determined dynamically).
The above two changes only apply when the user enables a new option, `strict_bytes_per_sync`.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5183
Differential Revision: D14953553
Pulled By: siying
fbshipit-source-id: 445c3862e019fb7b470f9c7f314fc231b62706e9
6 years ago
|
|
|
ASSERT_EQ(new_db_opt.strict_bytes_per_sync, true);
|
|
|
|
|
|
|
|
|
|
db_options_map["max_open_files"] = "hello";
|
|
|
|
|
ASSERT_NOK(GetDBOptionsFromMap(base_db_opt, db_options_map, &new_db_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(base_db_opt, new_db_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(
|
|
|
|
|
base_db_opt, new_db_opt, nullptr, /* new_opt_map */
|
|
|
|
|
kSanityLevelLooselyCompatible /* from CheckOptionsCompatibility */));
|
|
|
|
|
|
|
|
|
|
// unknow options should fail parsing without ignore_unknown_options = true
|
|
|
|
|
db_options_map["unknown_db_option"] = "1";
|
|
|
|
|
ASSERT_NOK(GetDBOptionsFromMap(base_db_opt, db_options_map, &new_db_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(base_db_opt, new_db_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetDBOptionsFromMap(base_db_opt, db_options_map, &new_db_opt,
|
|
|
|
|
false, /* input_strings_escaped */
|
|
|
|
|
true /* ignore_unknown_options */));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(
|
|
|
|
|
base_db_opt, new_db_opt, nullptr, /* new_opt_map */
|
|
|
|
|
kSanityLevelLooselyCompatible /* from CheckOptionsCompatibility */));
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyDBOptions(
|
|
|
|
|
base_db_opt, new_db_opt, nullptr, /* new_opt_mat */
|
|
|
|
|
kSanityLevelExactMatch /* default for VerifyDBOptions */));
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetColumnFamilyOptionsFromString is not supported in
|
|
|
|
|
// ROCKSDB_LITE
|
|
|
|
|
TEST_F(OptionsTest, GetColumnFamilyOptionsFromStringTest) {
|
|
|
|
|
ColumnFamilyOptions base_cf_opt;
|
|
|
|
|
ColumnFamilyOptions new_cf_opt;
|
|
|
|
|
base_cf_opt.table_factory.reset();
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt, "", &new_cf_opt));
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=5", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 5U);
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory == nullptr);
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=6;", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 6U);
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
" write_buffer_size = 7 ", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 7U);
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
" write_buffer_size = 8 ; ", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 8U);
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=9;max_write_buffer_number=10", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 9U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number, 10);
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=11; max_write_buffer_number = 12 ;",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 11U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number, 12);
|
|
|
|
|
// Wrong name "max_write_buffer_number_"
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13;max_write_buffer_number_=14;",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Comparator from object registry
|
|
|
|
|
std::string kCompName = "reverse_comp";
|
|
|
|
|
ObjectLibrary::Default()->Register<const Comparator>(
|
|
|
|
|
kCompName,
|
|
|
|
|
[](const std::string& /*name*/,
|
|
|
|
|
std::unique_ptr<const Comparator>* /*guard*/,
|
|
|
|
|
std::string* /* errmsg */) { return ReverseBytewiseComparator(); });
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
base_cf_opt, "comparator=" + kCompName + ";", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.comparator, ReverseBytewiseComparator());
|
|
|
|
|
|
|
|
|
|
// MergeOperator from object registry
|
|
|
|
|
std::unique_ptr<BytesXOROperator> bxo(new BytesXOROperator());
|
|
|
|
|
std::string kMoName = bxo->Name();
|
|
|
|
|
ObjectLibrary::Default()->Register<MergeOperator>(
|
|
|
|
|
kMoName,
|
|
|
|
|
[](const std::string& /*name*/, std::unique_ptr<MergeOperator>* guard,
|
|
|
|
|
std::string* /* errmsg */) {
|
|
|
|
|
guard->reset(new BytesXOROperator());
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
base_cf_opt, "merge_operator=" + kMoName + ";", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(kMoName, std::string(new_cf_opt.merge_operator->Name()));
|
|
|
|
|
|
|
|
|
|
// Wrong key/value pair
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13;max_write_buffer_number;", &new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Error Paring value
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13;max_write_buffer_number=;", &new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Missing option name
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13; =100;", &new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
const int64_t kilo = 1024UL;
|
|
|
|
|
const int64_t mega = 1024 * kilo;
|
|
|
|
|
const int64_t giga = 1024 * mega;
|
|
|
|
|
const int64_t tera = 1024 * giga;
|
|
|
|
|
|
|
|
|
|
// Units (k)
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
base_cf_opt, "max_write_buffer_number=15K", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number, 15 * kilo);
|
|
|
|
|
// Units (m)
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"max_write_buffer_number=16m;inplace_update_num_locks=17M",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_write_buffer_number, 16 * mega);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.inplace_update_num_locks, 17 * mega);
|
|
|
|
|
// Units (g)
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
base_cf_opt,
|
|
|
|
|
"write_buffer_size=18g;prefix_extractor=capped:8;"
|
|
|
|
|
"arena_block_size=19G",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 18 * giga);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.arena_block_size, 19 * giga);
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.prefix_extractor.get() != nullptr);
|
|
|
|
|
std::string prefix_name(new_cf_opt.prefix_extractor->Name());
|
|
|
|
|
ASSERT_EQ(prefix_name, "rocksdb.CappedPrefix.8");
|
|
|
|
|
|
|
|
|
|
// Units (t)
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=20t;arena_block_size=21T", &new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.write_buffer_size, 20 * tera);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.arena_block_size, 21 * tera);
|
|
|
|
|
|
|
|
|
|
// Nested block based table options
|
|
|
|
|
// Empty
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={};arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory != nullptr);
|
|
|
|
|
// Non-empty
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_cache=1M;block_size=4;};"
|
|
|
|
|
"arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory != nullptr);
|
|
|
|
|
// Last one
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_cache=1M;block_size=4;}",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory != nullptr);
|
|
|
|
|
// Mismatch curly braces
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={{{block_size=4;};"
|
|
|
|
|
"arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Unexpected chars after closing curly brace
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_size=4;}};"
|
|
|
|
|
"arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_size=4;}xdfa;"
|
|
|
|
|
"arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_size=4;}xdfa",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Invalid block based table option
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={xx_block_size=4;}",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"optimize_filters_for_hits=true",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"optimize_filters_for_hits=false",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"optimize_filters_for_hits=junk",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opt, new_cf_opt));
|
|
|
|
|
|
|
|
|
|
// Nested plain table options
|
|
|
|
|
// Empty
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"plain_table_factory={};arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory != nullptr);
|
|
|
|
|
ASSERT_EQ(std::string(new_cf_opt.table_factory->Name()), "PlainTable");
|
|
|
|
|
// Non-empty
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"plain_table_factory={user_key_len=66;bloom_bits_per_key=20;};"
|
|
|
|
|
"arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.table_factory != nullptr);
|
|
|
|
|
ASSERT_EQ(std::string(new_cf_opt.table_factory->Name()), "PlainTable");
|
|
|
|
|
|
|
|
|
|
// memtable factory
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"memtable=skip_list:10;arena_block_size=1024",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_TRUE(new_cf_opt.memtable_factory != nullptr);
|
|
|
|
|
ASSERT_EQ(std::string(new_cf_opt.memtable_factory->Name()), "SkipListFactory");
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetBlockBasedTableOptionsFromString is not supported
|
|
|
|
|
TEST_F(OptionsTest, GetBlockBasedTableOptionsFromString) {
|
|
|
|
|
BlockBasedTableOptions table_opt;
|
|
|
|
|
BlockBasedTableOptions new_opt;
|
|
|
|
|
// make sure default values are overwritten by something else
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;index_type=kHashSearch;"
|
|
|
|
|
"checksum=kxxHash;hash_index_allow_collision=1;no_block_cache=1;"
|
|
|
|
|
"block_cache=1M;block_cache_compressed=1k;block_size=1024;"
|
|
|
|
|
"block_size_deviation=8;block_restart_interval=4;"
|
|
|
|
|
"filter_policy=bloomfilter:4:true;whole_key_filtering=1;",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_TRUE(new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(new_opt.index_type, BlockBasedTableOptions::kHashSearch);
|
|
|
|
|
ASSERT_EQ(new_opt.checksum, ChecksumType::kxxHash);
|
|
|
|
|
ASSERT_TRUE(new_opt.hash_index_allow_collision);
|
|
|
|
|
ASSERT_TRUE(new_opt.no_block_cache);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->GetCapacity(), 1024UL*1024UL);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache_compressed != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->GetCapacity(), 1024UL);
|
|
|
|
|
ASSERT_EQ(new_opt.block_size, 1024UL);
|
|
|
|
|
ASSERT_EQ(new_opt.block_size_deviation, 8);
|
|
|
|
|
ASSERT_EQ(new_opt.block_restart_interval, 4);
|
|
|
|
|
ASSERT_TRUE(new_opt.filter_policy != nullptr);
|
|
|
|
|
|
|
|
|
|
// unknown option
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;index_type=kBinarySearch;"
|
|
|
|
|
"bad_option=1",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(table_opt.cache_index_and_filter_blocks,
|
|
|
|
|
new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(table_opt.index_type, new_opt.index_type);
|
|
|
|
|
|
|
|
|
|
// unrecognized index type
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;index_type=kBinarySearchXX",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(table_opt.cache_index_and_filter_blocks,
|
|
|
|
|
new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(table_opt.index_type, new_opt.index_type);
|
|
|
|
|
|
|
|
|
|
// unrecognized checksum type
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;checksum=kxxHashXX",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(table_opt.cache_index_and_filter_blocks,
|
|
|
|
|
new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(table_opt.index_type, new_opt.index_type);
|
|
|
|
|
|
|
|
|
|
// unrecognized filter policy name
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;"
|
|
|
|
|
"filter_policy=bloomfilterxx:4:true",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(table_opt.cache_index_and_filter_blocks,
|
|
|
|
|
new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(table_opt.filter_policy, new_opt.filter_policy);
|
|
|
|
|
|
|
|
|
|
// unrecognized filter policy config
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;"
|
|
|
|
|
"filter_policy=bloomfilter:4",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(table_opt.cache_index_and_filter_blocks,
|
|
|
|
|
new_opt.cache_index_and_filter_blocks);
|
|
|
|
|
ASSERT_EQ(table_opt.filter_policy, new_opt.filter_policy);
|
|
|
|
|
|
|
|
|
|
// Check block cache options are overwritten when specified
|
|
|
|
|
// in new format as a struct.
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"block_cache={capacity=1M;num_shard_bits=4;"
|
|
|
|
|
"strict_capacity_limit=true;high_pri_pool_ratio=0.5;};"
|
|
|
|
|
"block_cache_compressed={capacity=1M;num_shard_bits=4;"
|
|
|
|
|
"strict_capacity_limit=true;high_pri_pool_ratio=0.5;}",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->GetCapacity(), 1024UL*1024UL);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache)->GetNumShardBits(), 4);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->HasStrictCapacityLimit(), true);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(
|
|
|
|
|
new_opt.block_cache)->GetHighPriPoolRatio(), 0.5);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache_compressed != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->GetCapacity(), 1024UL*1024UL);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache_compressed)->GetNumShardBits(), 4);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->HasStrictCapacityLimit(), true);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(
|
|
|
|
|
new_opt.block_cache_compressed)->GetHighPriPoolRatio(),
|
|
|
|
|
0.5);
|
|
|
|
|
|
|
|
|
|
// Set only block cache capacity. Check other values are
|
|
|
|
|
// reset to default values.
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"block_cache={capacity=2M};"
|
|
|
|
|
"block_cache_compressed={capacity=2M}",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->GetCapacity(), 2*1024UL*1024UL);
|
|
|
|
|
// Default values
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache)->GetNumShardBits(),
|
|
|
|
|
GetDefaultCacheShardBits(new_opt.block_cache->GetCapacity()));
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->HasStrictCapacityLimit(), false);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(new_opt.block_cache)
|
|
|
|
|
->GetHighPriPoolRatio(),
|
|
|
|
|
0.5);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache_compressed != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->GetCapacity(), 2*1024UL*1024UL);
|
|
|
|
|
// Default values
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache_compressed)->GetNumShardBits(),
|
|
|
|
|
GetDefaultCacheShardBits(
|
|
|
|
|
new_opt.block_cache_compressed->GetCapacity()));
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->HasStrictCapacityLimit(), false);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(new_opt.block_cache_compressed)
|
|
|
|
|
->GetHighPriPoolRatio(),
|
|
|
|
|
0.5);
|
|
|
|
|
|
|
|
|
|
// Set couple of block cache options.
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(
|
|
|
|
|
table_opt,
|
|
|
|
|
"block_cache={num_shard_bits=5;high_pri_pool_ratio=0.5;};"
|
|
|
|
|
"block_cache_compressed={num_shard_bits=5;"
|
|
|
|
|
"high_pri_pool_ratio=0.0;}",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->GetCapacity(), 0);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache)->GetNumShardBits(), 5);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->HasStrictCapacityLimit(), false);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(
|
|
|
|
|
new_opt.block_cache)->GetHighPriPoolRatio(), 0.5);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache_compressed != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->GetCapacity(), 0);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache_compressed)->GetNumShardBits(), 5);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->HasStrictCapacityLimit(), false);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(new_opt.block_cache_compressed)
|
|
|
|
|
->GetHighPriPoolRatio(),
|
|
|
|
|
0.0);
|
|
|
|
|
|
|
|
|
|
// Set couple of block cache options.
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"block_cache={capacity=1M;num_shard_bits=4;"
|
|
|
|
|
"strict_capacity_limit=true;};"
|
|
|
|
|
"block_cache_compressed={capacity=1M;num_shard_bits=4;"
|
|
|
|
|
"strict_capacity_limit=true;}",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->GetCapacity(), 1024UL*1024UL);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache)->GetNumShardBits(), 4);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache->HasStrictCapacityLimit(), true);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(new_opt.block_cache)
|
|
|
|
|
->GetHighPriPoolRatio(),
|
|
|
|
|
0.5);
|
|
|
|
|
ASSERT_TRUE(new_opt.block_cache_compressed != nullptr);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->GetCapacity(), 1024UL*1024UL);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<ShardedCache>(
|
|
|
|
|
new_opt.block_cache_compressed)->GetNumShardBits(), 4);
|
|
|
|
|
ASSERT_EQ(new_opt.block_cache_compressed->HasStrictCapacityLimit(), true);
|
|
|
|
|
ASSERT_EQ(std::dynamic_pointer_cast<LRUCache>(new_opt.block_cache_compressed)
|
|
|
|
|
->GetHighPriPoolRatio(),
|
|
|
|
|
0.5);
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetPlainTableOptionsFromString is not supported
|
|
|
|
|
TEST_F(OptionsTest, GetPlainTableOptionsFromString) {
|
|
|
|
|
PlainTableOptions table_opt;
|
|
|
|
|
PlainTableOptions new_opt;
|
|
|
|
|
// make sure default values are overwritten by something else
|
|
|
|
|
ASSERT_OK(GetPlainTableOptionsFromString(table_opt,
|
|
|
|
|
"user_key_len=66;bloom_bits_per_key=20;hash_table_ratio=0.5;"
|
|
|
|
|
"index_sparseness=8;huge_page_tlb_size=4;encoding_type=kPrefix;"
|
|
|
|
|
"full_scan_mode=true;store_index_in_file=true",
|
|
|
|
|
&new_opt));
|
|
|
|
|
ASSERT_EQ(new_opt.user_key_len, 66);
|
|
|
|
|
ASSERT_EQ(new_opt.bloom_bits_per_key, 20);
|
|
|
|
|
ASSERT_EQ(new_opt.hash_table_ratio, 0.5);
|
|
|
|
|
ASSERT_EQ(new_opt.index_sparseness, 8);
|
|
|
|
|
ASSERT_EQ(new_opt.huge_page_tlb_size, 4);
|
|
|
|
|
ASSERT_EQ(new_opt.encoding_type, EncodingType::kPrefix);
|
|
|
|
|
ASSERT_TRUE(new_opt.full_scan_mode);
|
|
|
|
|
ASSERT_TRUE(new_opt.store_index_in_file);
|
|
|
|
|
|
|
|
|
|
// unknown option
|
|
|
|
|
ASSERT_NOK(GetPlainTableOptionsFromString(table_opt,
|
|
|
|
|
"user_key_len=66;bloom_bits_per_key=20;hash_table_ratio=0.5;"
|
|
|
|
|
"bad_option=1",
|
|
|
|
|
&new_opt));
|
|
|
|
|
|
|
|
|
|
// unrecognized EncodingType
|
|
|
|
|
ASSERT_NOK(GetPlainTableOptionsFromString(table_opt,
|
|
|
|
|
"user_key_len=66;bloom_bits_per_key=20;hash_table_ratio=0.5;"
|
|
|
|
|
"encoding_type=kPrefixXX",
|
|
|
|
|
&new_opt));
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetMemTableRepFactoryFromString is not supported
|
|
|
|
|
TEST_F(OptionsTest, GetMemTableRepFactoryFromString) {
|
|
|
|
|
std::unique_ptr<MemTableRepFactory> new_mem_factory = nullptr;
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("skip_list", &new_mem_factory));
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("skip_list:16", &new_mem_factory));
|
|
|
|
|
ASSERT_EQ(std::string(new_mem_factory->Name()), "SkipListFactory");
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("skip_list:16:invalid_opt",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("prefix_hash", &new_mem_factory));
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("prefix_hash:1000",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
ASSERT_EQ(std::string(new_mem_factory->Name()), "HashSkipListRepFactory");
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("prefix_hash:1000:invalid_opt",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("hash_linkedlist",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("hash_linkedlist:1000",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
ASSERT_EQ(std::string(new_mem_factory->Name()), "HashLinkListRepFactory");
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("hash_linkedlist:1000:invalid_opt",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("vector", &new_mem_factory));
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("vector:1024", &new_mem_factory));
|
|
|
|
|
ASSERT_EQ(std::string(new_mem_factory->Name()), "VectorRepFactory");
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("vector:1024:invalid_opt",
|
|
|
|
|
&new_mem_factory));
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("cuckoo", &new_mem_factory));
|
|
|
|
|
// CuckooHash memtable is already removed.
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("cuckoo:1024", &new_mem_factory));
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(GetMemTableRepFactoryFromString("bad_factory", &new_mem_factory));
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // GetOptionsFromString is not supported in RocksDB Lite
|
|
|
|
|
TEST_F(OptionsTest, GetOptionsFromStringTest) {
|
|
|
|
|
Options base_options, new_options;
|
|
|
|
|
base_options.write_buffer_size = 20;
|
|
|
|
|
base_options.min_write_buffer_number_to_merge = 15;
|
|
|
|
|
BlockBasedTableOptions block_based_table_options;
|
|
|
|
|
block_based_table_options.cache_index_and_filter_blocks = true;
|
|
|
|
|
base_options.table_factory.reset(
|
|
|
|
|
NewBlockBasedTableFactory(block_based_table_options));
|
|
|
|
|
|
|
|
|
|
// Register an Env with object registry.
|
|
|
|
|
const static char* kCustomEnvName = "CustomEnv";
|
|
|
|
|
class CustomEnv : public EnvWrapper {
|
|
|
|
|
public:
|
|
|
|
|
explicit CustomEnv(Env* _target) : EnvWrapper(_target) {}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
ObjectLibrary::Default()->Register<Env>(
|
|
|
|
|
kCustomEnvName,
|
|
|
|
|
[](const std::string& /*name*/, std::unique_ptr<Env>* /*env_guard*/,
|
|
|
|
|
std::string* /* errmsg */) {
|
|
|
|
|
static CustomEnv env(Env::Default());
|
|
|
|
|
return &env;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetOptionsFromString(
|
|
|
|
|
base_options,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_cache=1M;block_size=4;};"
|
|
|
|
|
"compression_opts=4:5:6;create_if_missing=true;max_open_files=1;"
|
|
|
|
|
"bottommost_compression_opts=5:6:7;create_if_missing=true;max_open_files="
|
|
|
|
|
"1;"
|
|
|
|
|
"rate_limiter_bytes_per_sec=1024;env=CustomEnv",
|
|
|
|
|
&new_options));
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.window_bits, 4);
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.level, 5);
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.strategy, 6);
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.max_dict_bytes, 0);
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.zstd_max_train_bytes, 0);
|
|
|
|
|
ASSERT_EQ(new_options.compression_opts.enabled, false);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression, kDisableCompressionOption);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.window_bits, 5);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.level, 6);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.strategy, 7);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.max_dict_bytes, 0);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.zstd_max_train_bytes, 0);
|
|
|
|
|
ASSERT_EQ(new_options.bottommost_compression_opts.enabled, false);
|
|
|
|
|
ASSERT_EQ(new_options.write_buffer_size, 10U);
|
|
|
|
|
ASSERT_EQ(new_options.max_write_buffer_number, 16);
|
|
|
|
|
BlockBasedTableOptions new_block_based_table_options =
|
|
|
|
|
dynamic_cast<BlockBasedTableFactory*>(new_options.table_factory.get())
|
|
|
|
|
->table_options();
|
|
|
|
|
ASSERT_EQ(new_block_based_table_options.block_cache->GetCapacity(), 1U << 20);
|
|
|
|
|
ASSERT_EQ(new_block_based_table_options.block_size, 4U);
|
|
|
|
|
// don't overwrite block based table options
|
|
|
|
|
ASSERT_TRUE(new_block_based_table_options.cache_index_and_filter_blocks);
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(new_options.create_if_missing, true);
|
|
|
|
|
ASSERT_EQ(new_options.max_open_files, 1);
|
|
|
|
|
ASSERT_TRUE(new_options.rate_limiter.get() != nullptr);
|
|
|
|
|
Env* newEnv = new_options.env;
|
|
|
|
|
ASSERT_OK(Env::LoadEnv(kCustomEnvName, &newEnv));
|
|
|
|
|
ASSERT_EQ(newEnv, new_options.env);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, DBOptionsSerialization) {
|
|
|
|
|
Options base_options, new_options;
|
|
|
|
|
Random rnd(301);
|
|
|
|
|
|
|
|
|
|
// Phase 1: Make big change in base_options
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
test::RandomInitDBOptions(&base_options, &rnd);
|
|
|
|
|
|
|
|
|
|
// Phase 2: obtain a string from base_option
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
std::string base_options_file_content;
|
|
|
|
|
ASSERT_OK(GetStringFromDBOptions(&base_options_file_content, base_options));
|
|
|
|
|
|
|
|
|
|
// Phase 3: Set new_options from the derived string and expect
|
|
|
|
|
// new_options == base_options
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
ASSERT_OK(GetDBOptionsFromString(DBOptions(), base_options_file_content,
|
|
|
|
|
&new_options));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(base_options, new_options));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, OptionsComposeDecompose) {
|
|
|
|
|
// build an Options from DBOptions + CFOptions, then decompose it to verify
|
|
|
|
|
// we get same constituent options.
|
|
|
|
|
DBOptions base_db_opts;
|
|
|
|
|
ColumnFamilyOptions base_cf_opts;
|
|
|
|
|
|
|
|
|
|
Random rnd(301);
|
|
|
|
|
test::RandomInitDBOptions(&base_db_opts, &rnd);
|
|
|
|
|
test::RandomInitCFOptions(&base_cf_opts, base_db_opts, &rnd);
|
|
|
|
|
|
|
|
|
|
Options base_opts(base_db_opts, base_cf_opts);
|
|
|
|
|
DBOptions new_db_opts(base_opts);
|
|
|
|
|
ColumnFamilyOptions new_cf_opts(base_opts);
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(base_db_opts, new_db_opts));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_cf_opts, new_cf_opts));
|
|
|
|
|
delete new_cf_opts.compaction_filter;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, ColumnFamilyOptionsSerialization) {
|
|
|
|
|
Options options;
|
|
|
|
|
ColumnFamilyOptions base_opt, new_opt;
|
|
|
|
|
Random rnd(302);
|
|
|
|
|
// Phase 1: randomly assign base_opt
|
|
|
|
|
// custom type options
|
|
|
|
|
test::RandomInitCFOptions(&base_opt, options, &rnd);
|
|
|
|
|
|
|
|
|
|
// Phase 2: obtain a string from base_opt
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
std::string base_options_file_content;
|
|
|
|
|
ASSERT_OK(
|
|
|
|
|
GetStringFromColumnFamilyOptions(&base_options_file_content, base_opt));
|
|
|
|
|
|
|
|
|
|
// Phase 3: Set new_opt from the derived string and expect
|
|
|
|
|
// new_opt == base_opt
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
ColumnFamilyOptions(), base_options_file_content, &new_opt));
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(base_opt, new_opt));
|
|
|
|
|
if (base_opt.compaction_filter) {
|
|
|
|
|
delete base_opt.compaction_filter;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
Status StringToMap(
|
|
|
|
|
const std::string& opts_str,
|
|
|
|
|
std::unordered_map<std::string, std::string>* opts_map);
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // StringToMap is not supported in ROCKSDB_LITE
|
|
|
|
|
TEST_F(OptionsTest, StringToMapTest) {
|
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
|
// Regular options
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=v2;k3=v3", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "v2");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
// Value with '='
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1==v1;k2=v2=;", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "=v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "v2=");
|
|
|
|
|
// Overwrriten option
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k1=v2;k3=v3", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v2");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
// Empty value
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=;k3=v3;k4=", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k2") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k4") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k4"], "");
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=;k3=v3;k4= ", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k2") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k4") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k4"], "");
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=;k3=", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k2") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k3") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "");
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=;k3=;", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k2") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "");
|
|
|
|
|
ASSERT_TRUE(opts_map.find("k3") != opts_map.end());
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "");
|
|
|
|
|
// Regular nested options
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2={nk1=nv1;nk2=nv2};k3=v3", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "nk1=nv1;nk2=nv2");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
// Multi-level nested options
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2={nk1=nv1;nk2={nnk1=nnk2}};"
|
|
|
|
|
"k3={nk1={nnk1={nnnk1=nnnv1;nnnk2;nnnv2}}};k4=v4",
|
|
|
|
|
&opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "nk1=nv1;nk2={nnk1=nnk2}");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "nk1={nnk1={nnnk1=nnnv1;nnnk2;nnnv2}}");
|
|
|
|
|
ASSERT_EQ(opts_map["k4"], "v4");
|
|
|
|
|
// Garbage inside curly braces
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2={dfad=};k3={=};k4=v4",
|
|
|
|
|
&opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "dfad=");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "=");
|
|
|
|
|
ASSERT_EQ(opts_map["k4"], "v4");
|
|
|
|
|
// Empty nested options
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2={};", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "");
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2={{{{}}}{}{}};", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "{{{}}}{}{}");
|
|
|
|
|
// With random spaces
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap(" k1 = v1 ; k2= {nk1=nv1; nk2={nnk1=nnk2}} ; "
|
|
|
|
|
"k3={ { } }; k4= v4 ",
|
|
|
|
|
&opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "nk1=nv1; nk2={nnk1=nnk2}");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "{ }");
|
|
|
|
|
ASSERT_EQ(opts_map["k4"], "v4");
|
|
|
|
|
|
|
|
|
|
// Empty key
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2=v2;=", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("=v1;k2=v2", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2v2;", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2=v2;fadfa", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2=v2;;", &opts_map));
|
|
|
|
|
// Mismatch curly braces
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={;k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{};k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={}};k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}{}}};k3=v3", &opts_map));
|
|
|
|
|
// However this is valid!
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
ASSERT_OK(StringToMap("k1=v1;k2=};k3=v3", &opts_map));
|
|
|
|
|
ASSERT_EQ(opts_map["k1"], "v1");
|
|
|
|
|
ASSERT_EQ(opts_map["k2"], "}");
|
|
|
|
|
ASSERT_EQ(opts_map["k3"], "v3");
|
|
|
|
|
|
|
|
|
|
// Invalid chars after closing curly brace
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}}{};k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}}cfda;k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}} cfda;k3=v3", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}} cfda", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{}}{}", &opts_map));
|
|
|
|
|
ASSERT_NOK(StringToMap("k1=v1;k2={{dfdl}adfa}{}", &opts_map));
|
|
|
|
|
}
|
|
|
|
|
#endif // ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // StringToMap is not supported in ROCKSDB_LITE
|
|
|
|
|
TEST_F(OptionsTest, StringToMapRandomTest) {
|
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
|
// Make sure segfault is not hit by semi-random strings
|
|
|
|
|
|
|
|
|
|
std::vector<std::string> bases = {
|
|
|
|
|
"a={aa={};tt={xxx={}}};c=defff",
|
|
|
|
|
"a={aa={};tt={xxx={}}};c=defff;d={{}yxx{}3{xx}}",
|
|
|
|
|
"abc={{}{}{}{{{}}}{{}{}{}{}{}{}{}"};
|
|
|
|
|
|
|
|
|
|
for (std::string base : bases) {
|
|
|
|
|
for (int rand_seed = 301; rand_seed < 401; rand_seed++) {
|
|
|
|
|
Random rnd(rand_seed);
|
|
|
|
|
for (int attempt = 0; attempt < 10; attempt++) {
|
|
|
|
|
std::string str = base;
|
|
|
|
|
// Replace random position to space
|
|
|
|
|
size_t pos = static_cast<size_t>(
|
|
|
|
|
rnd.Uniform(static_cast<int>(base.size())));
|
|
|
|
|
str[pos] = ' ';
|
|
|
|
|
Status s = StringToMap(str, &opts_map);
|
|
|
|
|
ASSERT_TRUE(s.ok() || s.IsInvalidArgument());
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Random Construct a string
|
|
|
|
|
std::vector<char> chars = {'{', '}', ' ', '=', ';', 'c'};
|
|
|
|
|
for (int rand_seed = 301; rand_seed < 1301; rand_seed++) {
|
|
|
|
|
Random rnd(rand_seed);
|
|
|
|
|
int len = rnd.Uniform(30);
|
|
|
|
|
std::string str = "";
|
|
|
|
|
for (int attempt = 0; attempt < len; attempt++) {
|
|
|
|
|
// Add a random character
|
|
|
|
|
size_t pos = static_cast<size_t>(
|
|
|
|
|
rnd.Uniform(static_cast<int>(chars.size())));
|
|
|
|
|
str.append(1, chars[pos]);
|
|
|
|
|
}
|
|
|
|
|
Status s = StringToMap(str, &opts_map);
|
|
|
|
|
ASSERT_TRUE(s.ok() || s.IsInvalidArgument());
|
|
|
|
|
s = StringToMap("name=" + str, &opts_map);
|
|
|
|
|
ASSERT_TRUE(s.ok() || s.IsInvalidArgument());
|
|
|
|
|
opts_map.clear();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, GetStringFromCompressionType) {
|
|
|
|
|
std::string res;
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetStringFromCompressionType(&res, kNoCompression));
|
|
|
|
|
ASSERT_EQ(res, "kNoCompression");
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetStringFromCompressionType(&res, kSnappyCompression));
|
|
|
|
|
ASSERT_EQ(res, "kSnappyCompression");
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetStringFromCompressionType(&res, kDisableCompressionOption));
|
|
|
|
|
ASSERT_EQ(res, "kDisableCompressionOption");
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetStringFromCompressionType(&res, kLZ4Compression));
|
|
|
|
|
ASSERT_EQ(res, "kLZ4Compression");
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(GetStringFromCompressionType(&res, kZlibCompression));
|
|
|
|
|
ASSERT_EQ(res, "kZlibCompression");
|
|
|
|
|
|
|
|
|
|
ASSERT_NOK(
|
|
|
|
|
GetStringFromCompressionType(&res, static_cast<CompressionType>(-10)));
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, ConvertOptionsTest) {
|
|
|
|
|
LevelDBOptions leveldb_opt;
|
|
|
|
|
Options converted_opt = ConvertOptions(leveldb_opt);
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(converted_opt.create_if_missing, leveldb_opt.create_if_missing);
|
|
|
|
|
ASSERT_EQ(converted_opt.error_if_exists, leveldb_opt.error_if_exists);
|
|
|
|
|
ASSERT_EQ(converted_opt.paranoid_checks, leveldb_opt.paranoid_checks);
|
|
|
|
|
ASSERT_EQ(converted_opt.env, leveldb_opt.env);
|
|
|
|
|
ASSERT_EQ(converted_opt.info_log.get(), leveldb_opt.info_log);
|
|
|
|
|
ASSERT_EQ(converted_opt.write_buffer_size, leveldb_opt.write_buffer_size);
|
|
|
|
|
ASSERT_EQ(converted_opt.max_open_files, leveldb_opt.max_open_files);
|
|
|
|
|
ASSERT_EQ(converted_opt.compression, leveldb_opt.compression);
|
|
|
|
|
|
|
|
|
|
std::shared_ptr<TableFactory> tb_guard = converted_opt.table_factory;
|
|
|
|
|
BlockBasedTableFactory* table_factory =
|
|
|
|
|
dynamic_cast<BlockBasedTableFactory*>(converted_opt.table_factory.get());
|
|
|
|
|
|
|
|
|
|
ASSERT_TRUE(table_factory != nullptr);
|
|
|
|
|
|
|
|
|
|
const BlockBasedTableOptions table_opt = table_factory->table_options();
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(table_opt.block_cache->GetCapacity(), 8UL << 20);
|
|
|
|
|
ASSERT_EQ(table_opt.block_size, leveldb_opt.block_size);
|
|
|
|
|
ASSERT_EQ(table_opt.block_restart_interval,
|
|
|
|
|
leveldb_opt.block_restart_interval);
|
|
|
|
|
ASSERT_EQ(table_opt.filter_policy.get(), leveldb_opt.filter_policy);
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
|
class OptionsParserTest : public testing::Test {
|
|
|
|
|
public:
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
OptionsParserTest() { env_.reset(new test::StringEnv(Env::Default())); }
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
|
|
|
|
|
protected:
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
std::unique_ptr<test::StringEnv> env_;
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
};
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, Comment) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[ DBOptions ]\n"
|
|
|
|
|
" # note that we don't support space around \"=\"\n"
|
|
|
|
|
" max_open_files=12345;\n"
|
|
|
|
|
" max_background_flushes=301 # comment after a statement is fine\n"
|
|
|
|
|
" # max_background_flushes=1000 # this line would be ignored\n"
|
|
|
|
|
" # max_background_compactions=2000 # so does this one\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
"[CFOptions \"default\"] # column family must be specified\n"
|
|
|
|
|
" # in the correct order\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_OK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyDBOptions(*parser.db_opt(), db_opt));
|
|
|
|
|
ASSERT_EQ(parser.NumColumnFamilies(), 1U);
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*parser.GetCFOptions("default"), cf_opt));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, ExtraSpace) {
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[ Version ]\n"
|
|
|
|
|
" rocksdb_version = 3.14.0 \n"
|
|
|
|
|
" options_file_version=1 # some comment\n"
|
|
|
|
|
"[DBOptions ] # some comment\n"
|
|
|
|
|
"max_open_files=12345 \n"
|
|
|
|
|
" max_background_flushes = 301 \n"
|
|
|
|
|
" max_total_wal_size = 1024 # keep_log_file_num=1000\n"
|
|
|
|
|
" [CFOptions \"default\" ]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_OK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, MissingDBOptions) {
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[CFOptions \"default\"]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, DoubleDBOptions) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
" max_open_files=12345\n"
|
|
|
|
|
" max_background_flushes=301\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
"[CFOptions \"default\"]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, NoDefaultCFOptions) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
" max_open_files=12345\n"
|
|
|
|
|
" max_background_flushes=301\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
"[CFOptions \"something_else\"]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, DefaultCFOptionsMustBeTheFirst) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
" max_open_files=12345\n"
|
|
|
|
|
" max_background_flushes=301\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
"[CFOptions \"something_else\"]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n"
|
|
|
|
|
"[CFOptions \"default\"]\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, DuplicateCFOptions) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.14.0\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
" max_open_files=12345\n"
|
|
|
|
|
" max_background_flushes=301\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
"[CFOptions \"default\"]\n"
|
|
|
|
|
"[CFOptions \"something_else\"]\n"
|
|
|
|
|
"[CFOptions \"something_else\"]\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, IgnoreUnknownOptions) {
|
|
|
|
|
for (int case_id = 0; case_id < 5; case_id++) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string version_string;
|
|
|
|
|
bool should_ignore = true;
|
|
|
|
|
if (case_id == 0) {
|
|
|
|
|
// same version
|
|
|
|
|
should_ignore = false;
|
|
|
|
|
version_string =
|
|
|
|
|
ToString(ROCKSDB_MAJOR) + "." + ToString(ROCKSDB_MINOR) + ".0";
|
|
|
|
|
} else if (case_id == 1) {
|
|
|
|
|
// higher minor version
|
|
|
|
|
should_ignore = true;
|
|
|
|
|
version_string =
|
|
|
|
|
ToString(ROCKSDB_MAJOR) + "." + ToString(ROCKSDB_MINOR + 1) + ".0";
|
|
|
|
|
} else if (case_id == 2) {
|
|
|
|
|
// higher major version.
|
|
|
|
|
should_ignore = true;
|
|
|
|
|
version_string = ToString(ROCKSDB_MAJOR + 1) + ".0.0";
|
|
|
|
|
} else if (case_id == 3) {
|
|
|
|
|
// lower minor version
|
|
|
|
|
#if ROCKSDB_MINOR == 0
|
|
|
|
|
continue;
|
|
|
|
|
#else
|
|
|
|
|
version_string =
|
|
|
|
|
ToString(ROCKSDB_MAJOR) + "." + ToString(ROCKSDB_MINOR - 1) + ".0";
|
|
|
|
|
should_ignore = false;
|
|
|
|
|
#endif
|
|
|
|
|
} else {
|
|
|
|
|
// lower major version
|
|
|
|
|
should_ignore = false;
|
|
|
|
|
version_string =
|
|
|
|
|
ToString(ROCKSDB_MAJOR - 1) + "." + ToString(ROCKSDB_MINOR) + ".0";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
std::string options_file_content =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=" +
|
|
|
|
|
version_string +
|
|
|
|
|
"\n"
|
|
|
|
|
" options_file_version=1\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
" max_open_files=12345\n"
|
|
|
|
|
" max_background_flushes=301\n"
|
|
|
|
|
" max_total_wal_size=1024 # keep_log_file_num=1000\n"
|
|
|
|
|
" unknown_db_option1=321\n"
|
|
|
|
|
" unknown_db_option2=false\n"
|
|
|
|
|
"[CFOptions \"default\"]\n"
|
|
|
|
|
" unknown_cf_option1=hello\n"
|
|
|
|
|
"[CFOptions \"something_else\"]\n"
|
|
|
|
|
" unknown_cf_option2=world\n"
|
|
|
|
|
" # if a section is blank, we will use the default\n";
|
|
|
|
|
|
|
|
|
|
const std::string kTestFileName = "test-rocksdb-options.ini";
|
|
|
|
|
env_->DeleteFile(kTestFileName);
|
|
|
|
|
env_->WriteToNewFile(kTestFileName, options_file_content);
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get()));
|
|
|
|
|
if (should_ignore) {
|
|
|
|
|
ASSERT_OK(parser.Parse(kTestFileName, env_.get(),
|
|
|
|
|
true /* ignore_unknown_options */));
|
|
|
|
|
} else {
|
|
|
|
|
ASSERT_NOK(parser.Parse(kTestFileName, env_.get(),
|
|
|
|
|
true /* ignore_unknown_options */));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
TEST_F(OptionsParserTest, ParseVersion) {
|
|
|
|
|
DBOptions db_opt;
|
|
|
|
|
db_opt.max_open_files = 12345;
|
|
|
|
|
db_opt.max_background_flushes = 301;
|
|
|
|
|
db_opt.max_total_wal_size = 1024;
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
|
|
|
|
|
std::string file_template =
|
|
|
|
|
"# This is a testing option string.\n"
|
|
|
|
|
"# Currently we only support \"#\" styled comment.\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"[Version]\n"
|
|
|
|
|
" rocksdb_version=3.13.1\n"
|
|
|
|
|
" options_file_version=%s\n"
|
|
|
|
|
"[DBOptions]\n"
|
|
|
|
|
"[CFOptions \"default\"]\n";
|
|
|
|
|
const int kLength = 1000;
|
|
|
|
|
char buffer[kLength];
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
|
|
|
|
|
const std::vector<std::string> invalid_versions = {
|
|
|
|
|
"a.b.c", "3.2.2b", "3.-12", "3. 1", // only digits and dots are allowed
|
|
|
|
|
"1.2.3.4",
|
|
|
|
|
"1.2.3" // can only contains at most one dot.
|
|
|
|
|
"0", // options_file_version must be at least one
|
|
|
|
|
"3..2",
|
|
|
|
|
".", ".1.2", // must have at least one digit before each dot
|
|
|
|
|
"1.2.", "1.", "2.34."}; // must have at least one digit after each dot
|
|
|
|
|
for (auto iv : invalid_versions) {
|
|
|
|
|
snprintf(buffer, kLength - 1, file_template.c_str(), iv.c_str());
|
|
|
|
|
|
|
|
|
|
parser.Reset();
|
|
|
|
|
env_->WriteToNewFile(iv, buffer);
|
|
|
|
|
ASSERT_NOK(parser.Parse(iv, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const std::vector<std::string> valid_versions = {
|
|
|
|
|
"1.232", "100", "3.12", "1", "12.3 ", " 1.25 "};
|
|
|
|
|
for (auto vv : valid_versions) {
|
|
|
|
|
snprintf(buffer, kLength - 1, file_template.c_str(), vv.c_str());
|
|
|
|
|
parser.Reset();
|
|
|
|
|
env_->WriteToNewFile(vv, buffer);
|
|
|
|
|
ASSERT_OK(parser.Parse(vv, env_.get()));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void VerifyCFPointerTypedOptions(
|
|
|
|
|
ColumnFamilyOptions* base_cf_opt, const ColumnFamilyOptions* new_cf_opt,
|
|
|
|
|
const std::unordered_map<std::string, std::string>* new_cf_opt_map) {
|
|
|
|
|
std::string name_buffer;
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
|
|
|
|
|
// change the name of merge operator back-and-forth
|
|
|
|
|
{
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
auto* merge_operator = dynamic_cast<test::ChanglingMergeOperator*>(
|
|
|
|
|
base_cf_opt->merge_operator.get());
|
|
|
|
|
if (merge_operator != nullptr) {
|
|
|
|
|
name_buffer = merge_operator->Name();
|
|
|
|
|
// change the name and expect non-ok status
|
|
|
|
|
merge_operator->SetName("some-other-name");
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*base_cf_opt, *new_cf_opt, new_cf_opt_map));
|
|
|
|
|
// change the name back and expect ok status
|
|
|
|
|
merge_operator->SetName(name_buffer);
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// change the name of the compaction filter factory back-and-forth
|
|
|
|
|
{
|
|
|
|
|
auto* compaction_filter_factory =
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
dynamic_cast<test::ChanglingCompactionFilterFactory*>(
|
|
|
|
|
base_cf_opt->compaction_filter_factory.get());
|
|
|
|
|
if (compaction_filter_factory != nullptr) {
|
|
|
|
|
name_buffer = compaction_filter_factory->Name();
|
|
|
|
|
// change the name and expect non-ok status
|
|
|
|
|
compaction_filter_factory->SetName("some-other-name");
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*base_cf_opt, *new_cf_opt, new_cf_opt_map));
|
|
|
|
|
// change the name back and expect ok status
|
|
|
|
|
compaction_filter_factory->SetName(name_buffer);
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// test by setting compaction_filter to nullptr
|
|
|
|
|
{
|
|
|
|
|
auto* tmp_compaction_filter = base_cf_opt->compaction_filter;
|
|
|
|
|
if (tmp_compaction_filter != nullptr) {
|
|
|
|
|
base_cf_opt->compaction_filter = nullptr;
|
|
|
|
|
// set compaction_filter to nullptr and expect non-ok status
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*base_cf_opt, *new_cf_opt, new_cf_opt_map));
|
|
|
|
|
// set the value back and expect ok status
|
|
|
|
|
base_cf_opt->compaction_filter = tmp_compaction_filter;
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// test by setting table_factory to nullptr
|
|
|
|
|
{
|
|
|
|
|
auto tmp_table_factory = base_cf_opt->table_factory;
|
|
|
|
|
if (tmp_table_factory != nullptr) {
|
|
|
|
|
base_cf_opt->table_factory.reset();
|
|
|
|
|
// set table_factory to nullptr and expect non-ok status
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*base_cf_opt, *new_cf_opt, new_cf_opt_map));
|
|
|
|
|
// set the value back and expect ok status
|
|
|
|
|
base_cf_opt->table_factory = tmp_table_factory;
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// test by setting memtable_factory to nullptr
|
|
|
|
|
{
|
|
|
|
|
auto tmp_memtable_factory = base_cf_opt->memtable_factory;
|
|
|
|
|
if (tmp_memtable_factory != nullptr) {
|
|
|
|
|
base_cf_opt->memtable_factory.reset();
|
|
|
|
|
// set memtable_factory to nullptr and expect non-ok status
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
*base_cf_opt, *new_cf_opt, new_cf_opt_map));
|
|
|
|
|
// set the value back and expect ok status
|
|
|
|
|
base_cf_opt->memtable_factory = tmp_memtable_factory;
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(*base_cf_opt, *new_cf_opt,
|
|
|
|
|
new_cf_opt_map));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
TEST_F(OptionsParserTest, DumpAndParse) {
|
|
|
|
|
DBOptions base_db_opt;
|
|
|
|
|
std::vector<ColumnFamilyOptions> base_cf_opts;
|
|
|
|
|
std::vector<std::string> cf_names = {"default", "cf1", "cf2", "cf3",
|
|
|
|
|
"c:f:4:4:4"
|
|
|
|
|
"p\\i\\k\\a\\chu\\\\\\",
|
|
|
|
|
"###rocksdb#1-testcf#2###"};
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
const int num_cf = static_cast<int>(cf_names.size());
|
|
|
|
|
Random rnd(302);
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
test::RandomInitDBOptions(&base_db_opt, &rnd);
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
base_db_opt.db_log_dir += "/#odd #but #could #happen #path #/\\\\#OMG";
|
|
|
|
|
|
|
|
|
|
BlockBasedTableOptions special_bbto;
|
|
|
|
|
special_bbto.cache_index_and_filter_blocks = true;
|
|
|
|
|
special_bbto.block_size = 999999;
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
for (int c = 0; c < num_cf; ++c) {
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
Random cf_rnd(0xFB + c);
|
|
|
|
|
test::RandomInitCFOptions(&cf_opt, base_db_opt, &cf_rnd);
|
|
|
|
|
if (c < 4) {
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
cf_opt.prefix_extractor.reset(test::RandomSliceTransform(&rnd, c));
|
|
|
|
|
}
|
|
|
|
|
if (c < 3) {
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
cf_opt.table_factory.reset(test::RandomTableFactory(&rnd, c));
|
|
|
|
|
} else if (c == 4) {
|
|
|
|
|
cf_opt.table_factory.reset(NewBlockBasedTableFactory(special_bbto));
|
|
|
|
|
}
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
base_cf_opts.emplace_back(cf_opt);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const std::string kOptionsFileName = "test-persisted-options.ini";
|
|
|
|
|
ASSERT_OK(PersistRocksDBOptions(base_db_opt, cf_names, base_cf_opts,
|
|
|
|
|
kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_OK(parser.Parse(kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
// Make sure block-based table factory options was deserialized correctly
|
|
|
|
|
std::shared_ptr<TableFactory> ttf = (*parser.cf_opts())[4].table_factory;
|
|
|
|
|
ASSERT_EQ(BlockBasedTableFactory::kName, std::string(ttf->Name()));
|
|
|
|
|
const BlockBasedTableOptions& parsed_bbto =
|
|
|
|
|
static_cast<BlockBasedTableFactory*>(ttf.get())->table_options();
|
|
|
|
|
ASSERT_EQ(special_bbto.block_size, parsed_bbto.block_size);
|
|
|
|
|
ASSERT_EQ(special_bbto.cache_index_and_filter_blocks,
|
|
|
|
|
parsed_bbto.cache_index_and_filter_blocks);
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyRocksDBOptionsFromFile(
|
|
|
|
|
base_db_opt, cf_names, base_cf_opts, kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(
|
|
|
|
|
RocksDBOptionsParser::VerifyDBOptions(*parser.db_opt(), base_db_opt));
|
|
|
|
|
for (int c = 0; c < num_cf; ++c) {
|
|
|
|
|
const auto* cf_opt = parser.GetCFOptions(cf_names[c]);
|
|
|
|
|
ASSERT_NE(cf_opt, nullptr);
|
|
|
|
|
ASSERT_OK(RocksDBOptionsParser::VerifyCFOptions(
|
|
|
|
|
base_cf_opts[c], *cf_opt, &(parser.cf_opt_maps()->at(c))));
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Further verify pointer-typed options
|
|
|
|
|
for (int c = 0; c < num_cf; ++c) {
|
|
|
|
|
const auto* cf_opt = parser.GetCFOptions(cf_names[c]);
|
|
|
|
|
ASSERT_NE(cf_opt, nullptr);
|
|
|
|
|
VerifyCFPointerTypedOptions(&base_cf_opts[c], cf_opt,
|
|
|
|
|
&(parser.cf_opt_maps()->at(c)));
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
ASSERT_EQ(parser.GetCFOptions("does not exist"), nullptr);
|
|
|
|
|
|
|
|
|
|
base_db_opt.max_open_files++;
|
|
|
|
|
ASSERT_NOK(RocksDBOptionsParser::VerifyRocksDBOptionsFromFile(
|
|
|
|
|
base_db_opt, cf_names, base_cf_opts, kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
for (int c = 0; c < num_cf; ++c) {
|
|
|
|
|
if (base_cf_opts[c].compaction_filter) {
|
|
|
|
|
delete base_cf_opts[c].compaction_filter;
|
|
|
|
|
}
|
|
|
|
|
}
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, DifferentDefault) {
|
|
|
|
|
const std::string kOptionsFileName = "test-persisted-options.ini";
|
|
|
|
|
|
|
|
|
|
ColumnFamilyOptions cf_level_opts;
|
|
|
|
|
ASSERT_EQ(CompactionPri::kMinOverlappingRatio, cf_level_opts.compaction_pri);
|
|
|
|
|
cf_level_opts.OptimizeLevelStyleCompaction();
|
|
|
|
|
|
|
|
|
|
ColumnFamilyOptions cf_univ_opts;
|
|
|
|
|
cf_univ_opts.OptimizeUniversalStyleCompaction();
|
|
|
|
|
|
|
|
|
|
ASSERT_OK(PersistRocksDBOptions(DBOptions(), {"default", "universal"},
|
|
|
|
|
{cf_level_opts, cf_univ_opts},
|
|
|
|
|
kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
RocksDBOptionsParser parser;
|
|
|
|
|
ASSERT_OK(parser.Parse(kOptionsFileName, env_.get()));
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults();
|
|
|
|
|
ASSERT_EQ(10 * 1048576, old_default_opts.max_bytes_for_level_base);
|
|
|
|
|
ASSERT_EQ(5000, old_default_opts.max_open_files);
|
|
|
|
|
ASSERT_EQ(2 * 1024U * 1024U, old_default_opts.delayed_write_rate);
|
|
|
|
|
ASSERT_EQ(WALRecoveryMode::kTolerateCorruptedTailRecords,
|
|
|
|
|
old_default_opts.wal_recovery_mode);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults(4, 6);
|
|
|
|
|
ASSERT_EQ(10 * 1048576, old_default_opts.max_bytes_for_level_base);
|
|
|
|
|
ASSERT_EQ(5000, old_default_opts.max_open_files);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults(4, 7);
|
|
|
|
|
ASSERT_NE(10 * 1048576, old_default_opts.max_bytes_for_level_base);
|
|
|
|
|
ASSERT_NE(4, old_default_opts.table_cache_numshardbits);
|
|
|
|
|
ASSERT_EQ(5000, old_default_opts.max_open_files);
|
|
|
|
|
ASSERT_EQ(2 * 1024U * 1024U, old_default_opts.delayed_write_rate);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
ColumnFamilyOptions old_default_cf_opts;
|
|
|
|
|
old_default_cf_opts.OldDefaults();
|
|
|
|
|
ASSERT_EQ(2 * 1048576, old_default_cf_opts.target_file_size_base);
|
|
|
|
|
ASSERT_EQ(4 << 20, old_default_cf_opts.write_buffer_size);
|
|
|
|
|
ASSERT_EQ(2 * 1048576, old_default_cf_opts.target_file_size_base);
|
|
|
|
|
ASSERT_EQ(0, old_default_cf_opts.soft_pending_compaction_bytes_limit);
|
|
|
|
|
ASSERT_EQ(0, old_default_cf_opts.hard_pending_compaction_bytes_limit);
|
|
|
|
|
ASSERT_EQ(CompactionPri::kByCompensatedSize,
|
|
|
|
|
old_default_cf_opts.compaction_pri);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
ColumnFamilyOptions old_default_cf_opts;
|
|
|
|
|
old_default_cf_opts.OldDefaults(4, 6);
|
|
|
|
|
ASSERT_EQ(2 * 1048576, old_default_cf_opts.target_file_size_base);
|
|
|
|
|
ASSERT_EQ(CompactionPri::kByCompensatedSize,
|
|
|
|
|
old_default_cf_opts.compaction_pri);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
ColumnFamilyOptions old_default_cf_opts;
|
|
|
|
|
old_default_cf_opts.OldDefaults(4, 7);
|
|
|
|
|
ASSERT_NE(2 * 1048576, old_default_cf_opts.target_file_size_base);
|
|
|
|
|
ASSERT_EQ(CompactionPri::kByCompensatedSize,
|
|
|
|
|
old_default_cf_opts.compaction_pri);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults(5, 1);
|
|
|
|
|
ASSERT_EQ(2 * 1024U * 1024U, old_default_opts.delayed_write_rate);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults(5, 2);
|
|
|
|
|
ASSERT_EQ(16 * 1024U * 1024U, old_default_opts.delayed_write_rate);
|
|
|
|
|
ASSERT_TRUE(old_default_opts.compaction_pri ==
|
|
|
|
|
CompactionPri::kByCompensatedSize);
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
Options old_default_opts;
|
|
|
|
|
old_default_opts.OldDefaults(5, 18);
|
|
|
|
|
ASSERT_TRUE(old_default_opts.compaction_pri ==
|
|
|
|
|
CompactionPri::kByCompensatedSize);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Options small_opts;
|
|
|
|
|
small_opts.OptimizeForSmallDb();
|
|
|
|
|
ASSERT_EQ(2 << 20, small_opts.write_buffer_size);
|
|
|
|
|
ASSERT_EQ(5000, small_opts.max_open_files);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
class OptionsSanityCheckTest : public OptionsParserTest {
|
|
|
|
|
public:
|
|
|
|
|
OptionsSanityCheckTest() {}
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
Status SanityCheckCFOptions(const ColumnFamilyOptions& cf_opts,
|
|
|
|
|
OptionsSanityCheckLevel level) {
|
|
|
|
|
return RocksDBOptionsParser::VerifyRocksDBOptionsFromFile(
|
|
|
|
|
DBOptions(), {"default"}, {cf_opts}, kOptionsFileName, env_.get(),
|
|
|
|
|
level);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Status PersistCFOptions(const ColumnFamilyOptions& cf_opts) {
|
|
|
|
|
Status s = env_->DeleteFile(kOptionsFileName);
|
|
|
|
|
if (!s.ok()) {
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
return PersistRocksDBOptions(DBOptions(), {"default"}, {cf_opts},
|
|
|
|
|
kOptionsFileName, env_.get());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const std::string kOptionsFileName = "OPTIONS";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsSanityCheckTest, SanityCheck) {
|
|
|
|
|
ColumnFamilyOptions opts;
|
|
|
|
|
Random rnd(301);
|
|
|
|
|
|
|
|
|
|
// default ColumnFamilyOptions
|
|
|
|
|
{
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// prefix_extractor
|
|
|
|
|
{
|
|
|
|
|
// Okay to change prefix_extractor form nullptr to non-nullptr
|
|
|
|
|
ASSERT_EQ(opts.prefix_extractor.get(), nullptr);
|
|
|
|
|
opts.prefix_extractor.reset(NewCappedPrefixTransform(10));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
|
|
|
|
|
// use same prefix extractor but with different parameter
|
|
|
|
|
opts.prefix_extractor.reset(NewCappedPrefixTransform(15));
|
|
|
|
|
// expect pass only in kSanityLevelLooselyCompatible
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// repeat the test with FixedPrefixTransform
|
|
|
|
|
opts.prefix_extractor.reset(NewFixedPrefixTransform(10));
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change of prefix_extractor
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
|
|
|
|
|
// use same prefix extractor but with different parameter
|
|
|
|
|
opts.prefix_extractor.reset(NewFixedPrefixTransform(15));
|
|
|
|
|
// expect pass only in kSanityLevelLooselyCompatible
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// Change prefix extractor from non-nullptr to nullptr
|
|
|
|
|
opts.prefix_extractor.reset();
|
|
|
|
|
// expect pass as it's safe to change prefix_extractor
|
|
|
|
|
// from non-null to null
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
}
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
|
|
|
|
|
// table_factory
|
|
|
|
|
{
|
|
|
|
|
for (int tb = 0; tb <= 2; ++tb) {
|
|
|
|
|
// change the table factory
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
opts.table_factory.reset(test::RandomTableFactory(&rnd, tb));
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// merge_operator
|
|
|
|
|
{
|
|
|
|
|
// Test when going from nullptr -> merge operator
|
|
|
|
|
opts.merge_operator.reset(test::RandomMergeOperator(&rnd));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
|
|
|
|
|
for (int test = 0; test < 5; ++test) {
|
|
|
|
|
// change the merge operator
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
opts.merge_operator.reset(test::RandomMergeOperator(&rnd));
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Test when going from merge operator -> nullptr
|
|
|
|
|
opts.merge_operator = nullptr;
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// compaction_filter
|
|
|
|
|
{
|
|
|
|
|
for (int test = 0; test < 5; ++test) {
|
|
|
|
|
// change the compaction filter
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
opts.compaction_filter = test::RandomCompactionFilter(&rnd);
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
delete opts.compaction_filter;
|
|
|
|
|
opts.compaction_filter = nullptr;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// compaction_filter_factory
|
|
|
|
|
{
|
|
|
|
|
for (int test = 0; test < 5; ++test) {
|
|
|
|
|
// change the compaction filter factory
|
Add OptionsUtil::LoadOptionsFromFile() API
Summary:
This patch adds OptionsUtil::LoadOptionsFromFile() and
OptionsUtil::LoadLatestOptionsFromDB(), which allow developers
to construct DBOptions and ColumnFamilyOptions from a RocksDB
options file. Note that most pointer-typed options such as
merge_operator will not be constructed.
With this API, developers no longer need to remember all the
options in order to reopen an existing rocksdb instance like
the following:
DBOptions db_options;
std::vector<std::string> cf_names;
std::vector<ColumnFamilyOptions> cf_opts;
// Load primitive-typed options from an existing DB
OptionsUtil::LoadLatestOptionsFromDB(
dbname, &db_options, &cf_names, &cf_opts);
// Initialize necessary pointer-typed options
cf_opts[0].merge_operator.reset(new MyMergeOperator());
...
// Construct the vector of ColumnFamilyDescriptor
std::vector<ColumnFamilyDescriptor> cf_descs;
for (size_t i = 0; i < cf_opts.size(); ++i) {
cf_descs.emplace_back(cf_names[i], cf_opts[i]);
}
// Open the DB
DB* db = nullptr;
std::vector<ColumnFamilyHandle*> cf_handles;
auto s = DB::Open(db_options, dbname, cf_descs,
&handles, &db);
Test Plan:
Augment existing tests in column_family_test
options_test
db_test
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D49095
9 years ago
|
|
|
opts.compaction_filter_factory.reset(
|
|
|
|
|
test::RandomCompactionFilterFactory(&rnd));
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
|
|
|
|
|
// persist the change
|
|
|
|
|
ASSERT_OK(PersistCFOptions(opts));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelExactMatch));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
namespace {
|
|
|
|
|
bool IsEscapedString(const std::string& str) {
|
|
|
|
|
for (size_t i = 0; i < str.size(); ++i) {
|
|
|
|
|
if (str[i] == '\\') {
|
|
|
|
|
// since we already handle those two consecutive '\'s in
|
|
|
|
|
// the next if-then branch, any '\' appear at the end
|
|
|
|
|
// of an escaped string in such case is not valid.
|
|
|
|
|
if (i == str.size() - 1) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
if (str[i + 1] == '\\') {
|
|
|
|
|
// if there're two consecutive '\'s, skip the second one.
|
|
|
|
|
i++;
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
switch (str[i + 1]) {
|
|
|
|
|
case ':':
|
|
|
|
|
case '\\':
|
|
|
|
|
case '#':
|
|
|
|
|
continue;
|
|
|
|
|
default:
|
|
|
|
|
// if true, '\' together with str[i + 1] is not a valid escape.
|
|
|
|
|
if (UnescapeChar(str[i + 1]) == str[i + 1]) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
} else if (isSpecialChar(str[i]) && (i == 0 || str[i - 1] != '\\')) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsParserTest, IntegerParsing) {
|
|
|
|
|
ASSERT_EQ(ParseUint64("18446744073709551615"), 18446744073709551615U);
|
|
|
|
|
ASSERT_EQ(ParseUint32("4294967295"), 4294967295U);
|
|
|
|
|
ASSERT_EQ(ParseSizeT("18446744073709551615"), 18446744073709551615U);
|
|
|
|
|
ASSERT_EQ(ParseInt64("9223372036854775807"), 9223372036854775807U);
|
|
|
|
|
ASSERT_EQ(ParseInt64("-9223372036854775808"), port::kMinInt64);
|
|
|
|
|
ASSERT_EQ(ParseInt32("2147483647"), 2147483647U);
|
|
|
|
|
ASSERT_EQ(ParseInt32("-2147483648"), port::kMinInt32);
|
|
|
|
|
ASSERT_EQ(ParseInt("-32767"), -32767);
|
|
|
|
|
ASSERT_EQ(ParseDouble("-1.234567"), -1.234567);
|
|
|
|
|
}
|
|
|
|
|
|
RocksDB Options file format and its serialization / deserialization.
Summary:
This patch defines the format of RocksDB options file, which
follows the INI file format, and implements functions for its
serialization and deserialization. An example RocksDB options
file can be found in examples/rocksdb_option_file_example.ini.
A typical RocksDB options file has three sections, which are
Version, DBOptions, and more than one CFOptions. The RocksDB
options file in general follows the basic INI file format
with the following extensions / modifications:
* Escaped characters
We escaped the following characters:
- \n -- line feed - new line
- \r -- carriage return
- \\ -- backslash \
- \: -- colon symbol :
- \# -- hash tag #
* Comments
We support # style comments. Comments can appear at the ending
part of a line.
* Statements
A statement is of the form option_name = value.
Each statement contains a '=', where extra white-spaces
are supported. However, we don't support multi-lined statement.
Furthermore, each line can only contain at most one statement.
* Section
Sections are of the form [SecitonTitle "SectionArgument"],
where section argument is optional.
* List
We use colon-separated string to represent a list.
For instance, n1:n2:n3:n4 is a list containing four values.
Below is an example of a RocksDB options file:
[Version]
rocksdb_version=4.0.0
options_file_version=1.0
[DBOptions]
max_open_files=12345
max_background_flushes=301
[CFOptions "default"]
[CFOptions "the second column family"]
[CFOptions "the third column family"]
Test Plan: Added many tests in options_test.cc
Reviewers: igor, IslamAbdelRahman, sdong, anthony
Reviewed By: anthony
Subscribers: maykov, dhruba, leveldb
Differential Revision: https://reviews.facebook.net/D46059
9 years ago
|
|
|
TEST_F(OptionsParserTest, EscapeOptionString) {
|
|
|
|
|
ASSERT_EQ(UnescapeOptionString(
|
|
|
|
|
"This is a test string with \\# \\: and \\\\ escape chars."),
|
|
|
|
|
"This is a test string with # : and \\ escape chars.");
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(
|
|
|
|
|
EscapeOptionString("This is a test string with # : and \\ escape chars."),
|
|
|
|
|
"This is a test string with \\# \\: and \\\\ escape chars.");
|
|
|
|
|
|
|
|
|
|
std::string readible_chars =
|
|
|
|
|
"A String like this \"1234567890-=_)(*&^%$#@!ertyuiop[]{POIU"
|
|
|
|
|
"YTREWQasdfghjkl;':LKJHGFDSAzxcvbnm,.?>"
|
|
|
|
|
"<MNBVCXZ\\\" should be okay to \\#\\\\\\:\\#\\#\\#\\ "
|
|
|
|
|
"be serialized and deserialized";
|
|
|
|
|
|
|
|
|
|
std::string escaped_string = EscapeOptionString(readible_chars);
|
|
|
|
|
ASSERT_TRUE(IsEscapedString(escaped_string));
|
|
|
|
|
// This two transformations should be canceled and should output
|
|
|
|
|
// the original input.
|
|
|
|
|
ASSERT_EQ(UnescapeOptionString(escaped_string), readible_chars);
|
|
|
|
|
|
|
|
|
|
std::string all_chars;
|
|
|
|
|
for (unsigned char c = 0;; ++c) {
|
|
|
|
|
all_chars += c;
|
|
|
|
|
if (c == 255) {
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
escaped_string = EscapeOptionString(all_chars);
|
|
|
|
|
ASSERT_TRUE(IsEscapedString(escaped_string));
|
|
|
|
|
ASSERT_EQ(UnescapeOptionString(escaped_string), all_chars);
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(RocksDBOptionsParser::TrimAndRemoveComment(
|
|
|
|
|
" A simple statement with a comment. # like this :)"),
|
|
|
|
|
"A simple statement with a comment.");
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(RocksDBOptionsParser::TrimAndRemoveComment(
|
|
|
|
|
"Escape \\# and # comment together ."),
|
|
|
|
|
"Escape \\# and");
|
|
|
|
|
}
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
} // namespace rocksdb
|
|
|
|
|
|
|
|
|
|
int main(int argc, char** argv) {
|
|
|
|
|
::testing::InitGoogleTest(&argc, argv);
|
|
|
|
|
#ifdef GFLAGS
|
|
|
|
|
ParseCommandLineFlags(&argc, &argv, true);
|
|
|
|
|
#endif // GFLAGS
|
|
|
|
|
return RUN_ALL_TESTS();
|
|
|
|
|
}
|
