|
|
|
|
// Copyright (c) 2013, Facebook, Inc. All rights reserved.
|
|
|
|
|
// This source code is licensed under the BSD-style license found in the
|
|
|
|
|
// LICENSE file in the root directory of this source tree. An additional grant
|
|
|
|
|
// of patent rights can be found in the PATENTS file in the same 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.
|
|
|
|
|
|
|
|
|
|
#ifndef __STDC_FORMAT_MACROS
|
|
|
|
|
#define __STDC_FORMAT_MACROS
|
|
|
|
|
#endif
|
|
|
|
|
|
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 <inttypes.h>
|
|
|
|
|
|
|
|
|
|
#include "rocksdb/cache.h"
|
|
|
|
|
#include "rocksdb/convenience.h"
|
|
|
|
|
#include "rocksdb/memtablerep.h"
|
|
|
|
|
#include "rocksdb/utilities/leveldb_options.h"
|
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 "util/options_helper.h"
|
|
|
|
|
#include "util/options_parser.h"
|
|
|
|
|
#include "util/options_sanity_check.h"
|
|
|
|
|
#include "util/random.h"
|
|
|
|
|
#include "util/testharness.h"
|
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 "util/testutil.h"
|
|
|
|
|
|
|
|
|
|
#ifndef GFLAGS
|
|
|
|
|
bool FLAGS_enable_print = false;
|
|
|
|
|
#else
|
|
|
|
|
#include <gflags/gflags.h>
|
|
|
|
|
using GFLAGS::ParseCommandLineFlags;
|
|
|
|
|
DEFINE_bool(enable_print, false, "Print options generated to console.");
|
|
|
|
|
#endif // GFLAGS
|
|
|
|
|
|
|
|
|
|
namespace rocksdb {
|
|
|
|
|
|
|
|
|
|
class StderrLogger : public Logger {
|
|
|
|
|
public:
|
|
|
|
|
using Logger::Logv;
|
|
|
|
|
virtual void Logv(const char* format, va_list ap) override {
|
|
|
|
|
vprintf(format, ap);
|
|
|
|
|
printf("\n");
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Options PrintAndGetOptions(size_t total_write_buffer_limit,
|
|
|
|
|
int read_amplification_threshold,
|
|
|
|
|
int write_amplification_threshold,
|
|
|
|
|
uint64_t target_db_size = 68719476736) {
|
|
|
|
|
StderrLogger logger;
|
|
|
|
|
|
|
|
|
|
if (FLAGS_enable_print) {
|
|
|
|
|
printf("---- total_write_buffer_limit: %" ROCKSDB_PRIszt
|
|
|
|
|
" "
|
|
|
|
|
"read_amplification_threshold: %d write_amplification_threshold: %d "
|
|
|
|
|
"target_db_size %" PRIu64 " ----\n",
|
|
|
|
|
total_write_buffer_limit, read_amplification_threshold,
|
|
|
|
|
write_amplification_threshold, target_db_size);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Options options =
|
|
|
|
|
GetOptions(total_write_buffer_limit, read_amplification_threshold,
|
|
|
|
|
write_amplification_threshold, target_db_size);
|
|
|
|
|
if (FLAGS_enable_print) {
|
|
|
|
|
options.Dump(&logger);
|
|
|
|
|
printf("-------------------------------------\n\n\n");
|
|
|
|
|
}
|
|
|
|
|
return 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
|
|
|
class OptionsTest : public testing::Test {};
|
|
|
|
|
|
|
|
|
|
TEST_F(OptionsTest, LooseCondition) {
|
|
|
|
|
Options options;
|
|
|
|
|
PrintAndGetOptions(static_cast<size_t>(10) * 1024 * 1024 * 1024, 100, 100);
|
|
|
|
|
|
|
|
|
|
// Less mem table memory budget
|
|
|
|
|
PrintAndGetOptions(32 * 1024 * 1024, 100, 100);
|
|
|
|
|
|
|
|
|
|
// Tight read amplification
|
|
|
|
|
options = PrintAndGetOptions(128 * 1024 * 1024, 8, 100);
|
|
|
|
|
ASSERT_EQ(options.compaction_style, kCompactionStyleLevel);
|
|
|
|
|
|
|
|
|
|
#ifndef ROCKSDB_LITE // Universal compaction is not supported in ROCKSDB_LITE
|
|
|
|
|
// Tight write amplification
|
|
|
|
|
options = PrintAndGetOptions(128 * 1024 * 1024, 64, 10);
|
|
|
|
|
ASSERT_EQ(options.compaction_style, kCompactionStyleUniversal);
|
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
|
|
|
|
|
// Both tight amplifications
|
|
|
|
|
PrintAndGetOptions(128 * 1024 * 1024, 4, 8);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#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"},
|
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:"
|
|
|
|
|
"kZSTDNotFinalCompression"},
|
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_opts", "4:5:6"},
|
|
|
|
|
{"num_levels", "7"},
|
|
|
|
|
{"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"},
|
|
|
|
|
{"level_compaction_dynamic_level_bytes", "true"},
|
|
|
|
|
{"max_bytes_for_level_multiplier", "15"},
|
|
|
|
|
{"max_bytes_for_level_multiplier_additional", "16:17:18"},
|
|
|
|
|
{"expanded_compaction_factor", "19"},
|
|
|
|
|
{"source_compaction_factor", "20"},
|
|
|
|
|
{"max_grandparent_overlap_factor", "21"},
|
|
|
|
|
{"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"},
|
|
|
|
|
{"verify_checksums_in_compaction", "false"},
|
|
|
|
|
{"compaction_options_fifo", "23"},
|
|
|
|
|
{"filter_deletes", "0"},
|
|
|
|
|
{"max_sequential_skip_in_iterations", "24"},
|
|
|
|
|
{"inplace_update_support", "true"},
|
Add options.compaction_measure_io_stats to print write I/O stats in compactions
Summary:
Add options.compaction_measure_io_stats to print out / pass to listener accumulated time spent on write calls. Example outputs in info logs:
2015/08/12-16:27:59.463944 7fd428bff700 (Original Log Time 2015/08/12-16:27:59.463922) EVENT_LOG_v1 {"time_micros": 1439422079463897, "job": 6, "event": "compaction_finished", "output_level": 1, "num_output_files": 4, "total_output_size": 6900525, "num_input_records": 111483, "num_output_records": 106877, "file_write_nanos": 15663206, "file_range_sync_nanos": 649588, "file_fsync_nanos": 349614797, "file_prepare_write_nanos": 1505812, "lsm_state": [2, 4, 0, 0, 0, 0, 0]}
Add two more counters in iostats_context.
Also add a parameter of db_bench.
Test Plan: Add a unit test. Also manually verify LOG outputs in db_bench
Subscribers: leveldb, dhruba
Differential Revision: https://reviews.facebook.net/D44115
10 years ago
|
|
|
{"compaction_measure_io_stats", "true"},
|
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_bits", "26"},
|
|
|
|
|
{"memtable_prefix_bloom_probes", "27"},
|
|
|
|
|
{"memtable_prefix_bloom_huge_page_tlb_size", "28"},
|
|
|
|
|
{"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"},
|
|
|
|
|
{"disable_data_sync", "false"},
|
|
|
|
|
{"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_os_buffer", "false"},
|
|
|
|
|
{"allow_mmap_reads", "true"},
|
|
|
|
|
{"allow_mmap_writes", "false"},
|
|
|
|
|
{"is_fd_close_on_exec", "true"},
|
|
|
|
|
{"skip_log_error_on_recovery", "false"},
|
|
|
|
|
{"stats_dump_period_sec", "46"},
|
|
|
|
|
{"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"},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
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);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression, kSnappyCompression);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compression_per_level.size(), 7U);
|
|
|
|
|
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], 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);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.num_levels, 7);
|
|
|
|
|
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);
|
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);
|
|
|
|
|
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.expanded_compaction_factor, 19);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.source_compaction_factor, 20);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_grandparent_overlap_factor, 21);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.soft_rate_limit, 1.1);
|
|
|
|
|
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.verify_checksums_in_compaction, false);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.compaction_options_fifo.max_table_files_size,
|
|
|
|
|
static_cast<uint64_t>(23));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.filter_deletes, false);
|
|
|
|
|
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_bits, 26U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_prefix_bloom_probes, 27U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_prefix_bloom_huge_page_tlb_size, 28U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.bloom_locality, 29U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.max_successive_merges, 30U);
|
|
|
|
|
ASSERT_EQ(new_cf_opt.min_partial_merge_operands, 31U);
|
|
|
|
|
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));
|
|
|
|
|
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));
|
|
|
|
|
|
|
|
|
|
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.disableDataSync, false);
|
|
|
|
|
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_os_buffer, false);
|
|
|
|
|
ASSERT_EQ(new_db_opt.allow_mmap_reads, true);
|
|
|
|
|
ASSERT_EQ(new_db_opt.allow_mmap_writes, 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.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));
|
|
|
|
|
}
|
|
|
|
|
#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));
|
|
|
|
|
// Wrong key/value pair
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13;max_write_buffer_number;", &new_cf_opt));
|
|
|
|
|
// Error Paring value
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13;max_write_buffer_number=;", &new_cf_opt));
|
|
|
|
|
// Missing option name
|
|
|
|
|
ASSERT_NOK(GetColumnFamilyOptionsFromString(base_cf_opt,
|
|
|
|
|
"write_buffer_size=13; =100;", &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,
|
|
|
|
|
"memtable_prefix_bloom_bits=14k;max_write_buffer_number=-15K",
|
|
|
|
|
&new_cf_opt));
|
|
|
|
|
ASSERT_EQ(new_cf_opt.memtable_prefix_bloom_bits, 14UL * kilo);
|
|
|
|
|
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
|
|
|
|
|
// Emtpy
|
|
|
|
|
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));
|
|
|
|
|
// 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_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_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));
|
|
|
|
|
// 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(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));
|
|
|
|
|
|
|
|
|
|
// Nested plain table options
|
|
|
|
|
// Emtpy
|
|
|
|
|
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;"
|
|
|
|
|
"skip_table_builder_flush=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);
|
|
|
|
|
ASSERT_TRUE(new_opt.skip_table_builder_flush);
|
|
|
|
|
|
|
|
|
|
// unknown option
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;index_type=kBinarySearch;"
|
|
|
|
|
"bad_option=1",
|
|
|
|
|
&new_opt));
|
|
|
|
|
|
|
|
|
|
// unrecognized index type
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;index_type=kBinarySearchXX",
|
|
|
|
|
&new_opt));
|
|
|
|
|
|
|
|
|
|
// unrecognized checksum type
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;checksum=kxxHashXX",
|
|
|
|
|
&new_opt));
|
|
|
|
|
|
|
|
|
|
// unrecognized filter policy name
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;"
|
|
|
|
|
"filter_policy=bloomfilterxx:4:true",
|
|
|
|
|
&new_opt));
|
|
|
|
|
// unrecognized filter policy config
|
|
|
|
|
ASSERT_NOK(GetBlockBasedTableOptionsFromString(table_opt,
|
|
|
|
|
"cache_index_and_filter_blocks=1;"
|
|
|
|
|
"filter_policy=bloomfilter:4",
|
|
|
|
|
&new_opt));
|
|
|
|
|
}
|
|
|
|
|
#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));
|
|
|
|
|
ASSERT_OK(GetMemTableRepFactoryFromString("cuckoo:1024", &new_mem_factory));
|
|
|
|
|
ASSERT_EQ(std::string(new_mem_factory->Name()), "HashCuckooRepFactory");
|
|
|
|
|
|
|
|
|
|
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));
|
|
|
|
|
ASSERT_OK(GetOptionsFromString(
|
|
|
|
|
base_options,
|
|
|
|
|
"write_buffer_size=10;max_write_buffer_number=16;"
|
|
|
|
|
"block_based_table_factory={block_cache=1M;block_size=4;};"
|
|
|
|
|
"create_if_missing=true;max_open_files=1;rate_limiter_bytes_per_sec=1024",
|
|
|
|
|
&new_options));
|
|
|
|
|
|
|
|
|
|
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);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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, ColumnFamilyOptionsSerialization) {
|
|
|
|
|
ColumnFamilyOptions base_opt, new_opt;
|
|
|
|
|
Random rnd(302);
|
|
|
|
|
// Phase 1: randomly assign base_opt
|
|
|
|
|
// custom type 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::RandomInitCFOptions(&base_opt, &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();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
#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<BlockBasedTableFactory> table_factory =
|
|
|
|
|
std::dynamic_pointer_cast<BlockBasedTableFactory>(
|
|
|
|
|
converted_opt.table_factory);
|
|
|
|
|
|
|
|
|
|
ASSERT_TRUE(table_factory.get() != 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, 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";
|
|
|
|
|
for (int c = 0; c < num_cf; ++c) {
|
|
|
|
|
ColumnFamilyOptions cf_opt;
|
|
|
|
|
Random cf_rnd(0xFB + c);
|
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::RandomInitCFOptions(&cf_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));
|
|
|
|
|
}
|
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()));
|
|
|
|
|
|
|
|
|
|
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;
|
|
|
|
|
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()));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
{
|
|
|
|
|
// change the prefix extractor and expect only pass when
|
|
|
|
|
// sanity-level == kSanityLevelNone
|
|
|
|
|
opts.prefix_extractor.reset(NewCappedPrefixTransform(10));
|
|
|
|
|
ASSERT_NOK(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 kSanityLevelNone
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
|
|
|
|
|
// repeat the test with FixedPrefixTransform
|
|
|
|
|
opts.prefix_extractor.reset(NewFixedPrefixTransform(10));
|
|
|
|
|
ASSERT_NOK(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 kSanityLevelNone
|
|
|
|
|
ASSERT_NOK(SanityCheckCFOptions(opts, kSanityLevelLooselyCompatible));
|
|
|
|
|
ASSERT_OK(SanityCheckCFOptions(opts, kSanityLevelNone));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// table_factory
|
|
|
|
|
{
|
|
|
|
|
for (int tb = 2; tb >= 0; --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
|
|
|
|
|
{
|
|
|
|
|
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));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 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, 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");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Only run the tests to verify new fields in options are settable through
|
|
|
|
|
// string on limited platforms as it depends on behavior of compilers.
|
|
|
|
|
#ifdef OS_LINUX
|
|
|
|
|
#ifndef __clang__
|
|
|
|
|
const char kSpecialChar = 'R';
|
|
|
|
|
typedef std::vector<std::pair<int, size_t>> OffsetGap;
|
|
|
|
|
|
|
|
|
|
void FillWithSpecialChar(char* start_ptr, size_t total_size,
|
|
|
|
|
const OffsetGap& blacklist) {
|
|
|
|
|
size_t offset = 0;
|
|
|
|
|
for (auto& pair : blacklist) {
|
|
|
|
|
std::memset(start_ptr + offset, kSpecialChar, pair.first - offset);
|
|
|
|
|
offset = pair.first + pair.second;
|
|
|
|
|
}
|
|
|
|
|
std::memset(start_ptr + offset, kSpecialChar, total_size - offset);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int NumUnsetBytes(char* start_ptr, size_t total_size,
|
|
|
|
|
const OffsetGap& blacklist) {
|
|
|
|
|
int total_unset_bytes_base = 0;
|
|
|
|
|
size_t offset = 0;
|
|
|
|
|
for (auto& pair : blacklist) {
|
|
|
|
|
for (char* ptr = start_ptr + offset; ptr < start_ptr + pair.first; ptr++) {
|
|
|
|
|
if (*ptr == kSpecialChar) {
|
|
|
|
|
total_unset_bytes_base++;
|
|
|
|
|
}
|
|
|
|
|
offset = pair.first + pair.second;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
for (char* ptr = start_ptr + offset; ptr < start_ptr + total_size; ptr++) {
|
|
|
|
|
if (*ptr == kSpecialChar) {
|
|
|
|
|
total_unset_bytes_base++;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return total_unset_bytes_base;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If the test fails, likely a new option is added to BlockBasedTableOptions
|
|
|
|
|
// but it cannot be set through GetBlockBasedTableOptionsFromString(), or the
|
|
|
|
|
// test is not updated accordingly.
|
|
|
|
|
// After adding an option, we need to make sure it is settable by
|
|
|
|
|
// GetBlockBasedTableOptionsFromString() and add the option to the input string
|
|
|
|
|
// passed to the GetBlockBasedTableOptionsFromString() in this test.
|
|
|
|
|
// If it is a complicated type, you also need to add the field to
|
|
|
|
|
// kBbtoBlacklist, and maybe add customized verification for it.
|
|
|
|
|
TEST_F(OptionsParserTest, BlockBasedTableOptionsAllFieldsSettable) {
|
|
|
|
|
// Items in the form of <offset, size>. Need to be in ascending order
|
|
|
|
|
// and not overlapping. Need to updated if new pointer-option is added.
|
|
|
|
|
const OffsetGap kBbtoBlacklist = {
|
|
|
|
|
{offsetof(struct BlockBasedTableOptions, flush_block_policy_factory),
|
|
|
|
|
sizeof(std::shared_ptr<FlushBlockPolicyFactory>)},
|
|
|
|
|
{offsetof(struct BlockBasedTableOptions, block_cache),
|
|
|
|
|
sizeof(std::shared_ptr<Cache>)},
|
|
|
|
|
{offsetof(struct BlockBasedTableOptions, block_cache_compressed),
|
|
|
|
|
sizeof(std::shared_ptr<Cache>)},
|
|
|
|
|
{offsetof(struct BlockBasedTableOptions, filter_policy),
|
|
|
|
|
sizeof(std::shared_ptr<const FilterPolicy>)},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// In this test, we catch a new option of BlockBasedTableOptions that is not
|
|
|
|
|
// settable through GetBlockBasedTableOptionsFromString().
|
|
|
|
|
// We count padding bytes of the option struct, and assert it to be the same
|
|
|
|
|
// as unset bytes of an option struct initialized by
|
|
|
|
|
// GetBlockBasedTableOptionsFromString().
|
|
|
|
|
|
|
|
|
|
char* bbto_ptr = new char[sizeof(BlockBasedTableOptions)];
|
|
|
|
|
|
|
|
|
|
// Count padding bytes by setting all bytes in the memory to a special char,
|
|
|
|
|
// copy a well constructed struct to this memory and see how many special
|
|
|
|
|
// bytes left.
|
|
|
|
|
BlockBasedTableOptions* bbto = new (bbto_ptr) BlockBasedTableOptions();
|
|
|
|
|
FillWithSpecialChar(bbto_ptr, sizeof(BlockBasedTableOptions), kBbtoBlacklist);
|
|
|
|
|
// It based on the behavior of compiler that padding bytes are not changed
|
|
|
|
|
// when copying the struct. It's prone to failure when compiler behavior
|
|
|
|
|
// changes. We verify there is unset bytes to detect the case.
|
|
|
|
|
*bbto = BlockBasedTableOptions();
|
|
|
|
|
int unset_bytes_base =
|
|
|
|
|
NumUnsetBytes(bbto_ptr, sizeof(BlockBasedTableOptions), kBbtoBlacklist);
|
|
|
|
|
ASSERT_GT(unset_bytes_base, 0);
|
|
|
|
|
bbto->~BlockBasedTableOptions();
|
|
|
|
|
|
|
|
|
|
// Construct the base option passed into
|
|
|
|
|
// GetBlockBasedTableOptionsFromString().
|
|
|
|
|
bbto = new (bbto_ptr) BlockBasedTableOptions();
|
|
|
|
|
FillWithSpecialChar(bbto_ptr, sizeof(BlockBasedTableOptions), kBbtoBlacklist);
|
|
|
|
|
// This option is not setable:
|
|
|
|
|
bbto->use_delta_encoding = true;
|
|
|
|
|
|
|
|
|
|
char* new_bbto_ptr = new char[sizeof(BlockBasedTableOptions)];
|
|
|
|
|
BlockBasedTableOptions* new_bbto =
|
|
|
|
|
new (new_bbto_ptr) BlockBasedTableOptions();
|
|
|
|
|
FillWithSpecialChar(new_bbto_ptr, sizeof(BlockBasedTableOptions),
|
|
|
|
|
kBbtoBlacklist);
|
|
|
|
|
|
|
|
|
|
// Need to update the option string if a new option is added.
|
|
|
|
|
ASSERT_OK(GetBlockBasedTableOptionsFromString(
|
|
|
|
|
*bbto,
|
|
|
|
|
"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;"
|
|
|
|
|
"skip_table_builder_flush=1;format_version=1;"
|
|
|
|
|
"hash_index_allow_collision=false;",
|
|
|
|
|
new_bbto));
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(unset_bytes_base,
|
|
|
|
|
NumUnsetBytes(new_bbto_ptr, sizeof(BlockBasedTableOptions),
|
|
|
|
|
kBbtoBlacklist));
|
|
|
|
|
|
|
|
|
|
ASSERT_TRUE(new_bbto->block_cache.get() != nullptr);
|
|
|
|
|
ASSERT_TRUE(new_bbto->block_cache_compressed.get() != nullptr);
|
|
|
|
|
ASSERT_TRUE(new_bbto->filter_policy.get() != nullptr);
|
|
|
|
|
|
|
|
|
|
bbto->~BlockBasedTableOptions();
|
|
|
|
|
new_bbto->~BlockBasedTableOptions();
|
|
|
|
|
|
|
|
|
|
delete[] bbto_ptr;
|
|
|
|
|
delete[] new_bbto_ptr;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If the test fails, likely a new option is added to DBOptions
|
|
|
|
|
// but it cannot be set through GetDBOptionsFromString(), or the test is not
|
|
|
|
|
// updated accordingly.
|
|
|
|
|
// After adding an option, we need to make sure it is settable by
|
|
|
|
|
// GetDBOptionsFromString() and add the option to the input string passed to
|
|
|
|
|
// DBOptionsFromString()in this test.
|
|
|
|
|
// If it is a complicated type, you also need to add the field to
|
|
|
|
|
// kDBOptionsBlacklist, and maybe add customized verification for it.
|
|
|
|
|
TEST_F(OptionsParserTest, DBOptionsAllFieldsSettable) {
|
|
|
|
|
const OffsetGap kDBOptionsBlacklist = {
|
|
|
|
|
{offsetof(struct DBOptions, env), sizeof(Env*)},
|
|
|
|
|
{offsetof(struct DBOptions, rate_limiter),
|
|
|
|
|
sizeof(std::shared_ptr<RateLimiter>)},
|
|
|
|
|
{offsetof(struct DBOptions, delete_scheduler),
|
|
|
|
|
sizeof(std::shared_ptr<DeleteScheduler>)},
|
|
|
|
|
{offsetof(struct DBOptions, info_log), sizeof(std::shared_ptr<Logger>)},
|
|
|
|
|
{offsetof(struct DBOptions, statistics),
|
|
|
|
|
sizeof(std::shared_ptr<Statistics>)},
|
|
|
|
|
{offsetof(struct DBOptions, db_paths), sizeof(std::vector<DbPath>)},
|
|
|
|
|
{offsetof(struct DBOptions, db_log_dir), sizeof(std::string)},
|
|
|
|
|
{offsetof(struct DBOptions, wal_dir), sizeof(std::string)},
|
|
|
|
|
{offsetof(struct DBOptions, listeners),
|
|
|
|
|
sizeof(std::vector<std::shared_ptr<EventListener>>)},
|
|
|
|
|
{offsetof(struct DBOptions, row_cache), sizeof(std::shared_ptr<Cache>)},
|
|
|
|
|
{offsetof(struct DBOptions, wal_filter), sizeof(const WalFilter*)},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
char* options_ptr = new char[sizeof(DBOptions)];
|
|
|
|
|
|
|
|
|
|
// Count padding bytes by setting all bytes in the memory to a special char,
|
|
|
|
|
// copy a well constructed struct to this memory and see how many special
|
|
|
|
|
// bytes left.
|
|
|
|
|
DBOptions* options = new (options_ptr) DBOptions();
|
|
|
|
|
FillWithSpecialChar(options_ptr, sizeof(DBOptions), kDBOptionsBlacklist);
|
|
|
|
|
// It based on the behavior of compiler that padding bytes are not changed
|
|
|
|
|
// when copying the struct. It's prone to failure when compiler behavior
|
|
|
|
|
// changes. We verify there is unset bytes to detect the case.
|
|
|
|
|
*options = DBOptions();
|
|
|
|
|
int unset_bytes_base =
|
|
|
|
|
NumUnsetBytes(options_ptr, sizeof(DBOptions), kDBOptionsBlacklist);
|
|
|
|
|
ASSERT_GT(unset_bytes_base, 0);
|
|
|
|
|
options->~DBOptions();
|
|
|
|
|
|
|
|
|
|
options = new (options_ptr) DBOptions();
|
|
|
|
|
FillWithSpecialChar(options_ptr, sizeof(DBOptions), kDBOptionsBlacklist);
|
|
|
|
|
|
|
|
|
|
// Following options are not settable through GetDBOptionsFromString():
|
|
|
|
|
options->fail_if_options_file_error = false;
|
|
|
|
|
options->allow_concurrent_memtable_write = false;
|
|
|
|
|
options->wal_recovery_mode = WALRecoveryMode::kPointInTimeRecovery;
|
|
|
|
|
options->enable_write_thread_adaptive_yield = true;
|
|
|
|
|
options->write_thread_slow_yield_usec = true;
|
|
|
|
|
options->write_thread_max_yield_usec = 1000u;
|
|
|
|
|
options->access_hint_on_compaction_start = DBOptions::AccessHint::NONE;
|
|
|
|
|
options->info_log_level = InfoLogLevel::DEBUG_LEVEL;
|
|
|
|
|
|
|
|
|
|
char* new_options_ptr = new char[sizeof(DBOptions)];
|
|
|
|
|
DBOptions* new_options = new (new_options_ptr) DBOptions();
|
|
|
|
|
FillWithSpecialChar(new_options_ptr, sizeof(DBOptions), kDBOptionsBlacklist);
|
|
|
|
|
|
|
|
|
|
// Need to update the option string if a new option is added.
|
|
|
|
|
ASSERT_OK(
|
|
|
|
|
GetDBOptionsFromString(*options,
|
|
|
|
|
"wal_bytes_per_sync=4295048118;"
|
|
|
|
|
"delete_obsolete_files_period_micros=4294967758;"
|
|
|
|
|
"WAL_ttl_seconds=4295008036;"
|
|
|
|
|
"WAL_size_limit_MB=4295036161;"
|
|
|
|
|
"wal_dir=path/to/wal_dir;"
|
|
|
|
|
"db_write_buffer_size=2587;"
|
|
|
|
|
"max_subcompactions=64330;"
|
|
|
|
|
"table_cache_numshardbits=28;"
|
|
|
|
|
"max_open_files=72;"
|
|
|
|
|
"max_file_opening_threads=35;"
|
|
|
|
|
"max_background_compactions=33;"
|
|
|
|
|
"use_fsync=true;"
|
|
|
|
|
"use_adaptive_mutex=false;"
|
|
|
|
|
"max_total_wal_size=4295005604;"
|
|
|
|
|
"compaction_readahead_size=0;"
|
|
|
|
|
"new_table_reader_for_compaction_inputs=false;"
|
|
|
|
|
"keep_log_file_num=4890;"
|
|
|
|
|
"skip_stats_update_on_db_open=false;"
|
|
|
|
|
"max_manifest_file_size=4295009941;"
|
|
|
|
|
"db_log_dir=path/to/db_log_dir;"
|
|
|
|
|
"skip_log_error_on_recovery=true;"
|
|
|
|
|
"writable_file_max_buffer_size=1048576;"
|
|
|
|
|
"paranoid_checks=true;"
|
|
|
|
|
"is_fd_close_on_exec=false;"
|
|
|
|
|
"bytes_per_sync=4295013613;"
|
|
|
|
|
"enable_thread_tracking=false;"
|
|
|
|
|
"disable_data_sync=false;"
|
|
|
|
|
"recycle_log_file_num=0;"
|
|
|
|
|
"disableDataSync=false;"
|
|
|
|
|
"create_missing_column_families=true;"
|
|
|
|
|
"log_file_time_to_roll=3097;"
|
|
|
|
|
"max_background_flushes=35;"
|
|
|
|
|
"create_if_missing=false;"
|
|
|
|
|
"error_if_exists=true;"
|
|
|
|
|
"allow_os_buffer=false;"
|
|
|
|
|
"delayed_write_rate=4294976214;"
|
|
|
|
|
"manifest_preallocation_size=1222;"
|
|
|
|
|
"allow_mmap_writes=false;"
|
|
|
|
|
"stats_dump_period_sec=70127;"
|
|
|
|
|
"allow_fallocate=true;"
|
|
|
|
|
"allow_mmap_reads=false;"
|
|
|
|
|
"max_log_file_size=4607;"
|
|
|
|
|
"random_access_max_buffer_size=1048576;"
|
|
|
|
|
"advise_random_on_open=true;"
|
|
|
|
|
"wal_bytes_per_sync=4295048118;"
|
|
|
|
|
"delete_obsolete_files_period_micros=4294967758;"
|
|
|
|
|
"WAL_ttl_seconds=4295008036;"
|
|
|
|
|
"WAL_size_limit_MB=4295036161;"
|
|
|
|
|
"wal_dir=path/to/wal_dir;"
|
|
|
|
|
"db_write_buffer_size=2587;"
|
|
|
|
|
"max_subcompactions=64330;"
|
|
|
|
|
"table_cache_numshardbits=28;"
|
|
|
|
|
"max_open_files=72;"
|
|
|
|
|
"max_file_opening_threads=35;"
|
|
|
|
|
"max_background_compactions=33;"
|
|
|
|
|
"use_fsync=true;"
|
|
|
|
|
"use_adaptive_mutex=false;"
|
|
|
|
|
"max_total_wal_size=4295005604;"
|
|
|
|
|
"compaction_readahead_size=0;"
|
|
|
|
|
"new_table_reader_for_compaction_inputs=false;"
|
|
|
|
|
"keep_log_file_num=4890;"
|
|
|
|
|
"skip_stats_update_on_db_open=false;"
|
|
|
|
|
"max_manifest_file_size=4295009941;"
|
|
|
|
|
"db_log_dir=path/to/db_log_dir;"
|
|
|
|
|
"skip_log_error_on_recovery=true;"
|
|
|
|
|
"writable_file_max_buffer_size=1048576;"
|
|
|
|
|
"paranoid_checks=true;"
|
|
|
|
|
"is_fd_close_on_exec=false;"
|
|
|
|
|
"bytes_per_sync=4295013613;"
|
|
|
|
|
"enable_thread_tracking=false;"
|
|
|
|
|
"disable_data_sync=false;"
|
|
|
|
|
"recycle_log_file_num=0;"
|
|
|
|
|
"disableDataSync=false;"
|
|
|
|
|
"create_missing_column_families=true;"
|
|
|
|
|
"log_file_time_to_roll=3097;"
|
|
|
|
|
"max_background_flushes=35;"
|
|
|
|
|
"create_if_missing=false;"
|
|
|
|
|
"error_if_exists=true;"
|
|
|
|
|
"allow_os_buffer=false;"
|
|
|
|
|
"delayed_write_rate=4294976214;"
|
|
|
|
|
"manifest_preallocation_size=1222;"
|
|
|
|
|
"allow_mmap_writes=false;"
|
|
|
|
|
"stats_dump_period_sec=70127;"
|
|
|
|
|
"allow_fallocate=true;"
|
|
|
|
|
"allow_mmap_reads=false;"
|
|
|
|
|
"max_log_file_size=4607;"
|
|
|
|
|
"random_access_max_buffer_size=1048576;"
|
|
|
|
|
"advise_random_on_open=true;",
|
|
|
|
|
new_options));
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(unset_bytes_base, NumUnsetBytes(new_options_ptr, sizeof(DBOptions),
|
|
|
|
|
kDBOptionsBlacklist));
|
|
|
|
|
|
|
|
|
|
options->~DBOptions();
|
|
|
|
|
new_options->~DBOptions();
|
|
|
|
|
|
|
|
|
|
delete[] options_ptr;
|
|
|
|
|
delete[] new_options_ptr;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If the test fails, likely a new option is added to ColumnFamilyOptions
|
|
|
|
|
// but it cannot be set through GetColumnFamilyOptionsFromString(), or the
|
|
|
|
|
// test is not updated accordingly.
|
|
|
|
|
// After adding an option, we need to make sure it is settable by
|
|
|
|
|
// GetColumnFamilyOptionsFromString() and add the option to the input
|
|
|
|
|
// string passed to GetColumnFamilyOptionsFromString()in this test.
|
|
|
|
|
// If it is a complicated type, you also need to add the field to
|
|
|
|
|
// kColumnFamilyOptionsBlacklist, and maybe add customized verification
|
|
|
|
|
// for it.
|
|
|
|
|
TEST_F(OptionsParserTest, ColumnFamilyOptionsAllFieldsSettable) {
|
|
|
|
|
const OffsetGap kColumnFamilyOptionsBlacklist = {
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, comparator), sizeof(Comparator*)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, merge_operator),
|
|
|
|
|
sizeof(std::shared_ptr<MergeOperator>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, compaction_filter),
|
|
|
|
|
sizeof(const CompactionFilter*)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, compaction_filter_factory),
|
|
|
|
|
sizeof(std::shared_ptr<CompactionFilterFactory>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, compression_per_level),
|
|
|
|
|
sizeof(std::vector<CompressionType>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, prefix_extractor),
|
|
|
|
|
sizeof(std::shared_ptr<const SliceTransform>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions,
|
|
|
|
|
max_bytes_for_level_multiplier_additional),
|
|
|
|
|
sizeof(std::vector<int>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, memtable_factory),
|
|
|
|
|
sizeof(std::shared_ptr<MemTableRepFactory>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, table_factory),
|
|
|
|
|
sizeof(std::shared_ptr<TableFactory>)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions,
|
|
|
|
|
table_properties_collector_factories),
|
|
|
|
|
sizeof(ColumnFamilyOptions::TablePropertiesCollectorFactories)},
|
|
|
|
|
{offsetof(struct ColumnFamilyOptions, inplace_callback),
|
|
|
|
|
sizeof(UpdateStatus (*)(char*, uint32_t*, Slice, std::string*))},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
char* options_ptr = new char[sizeof(ColumnFamilyOptions)];
|
|
|
|
|
|
|
|
|
|
// Count padding bytes by setting all bytes in the memory to a special char,
|
|
|
|
|
// copy a well constructed struct to this memory and see how many special
|
|
|
|
|
// bytes left.
|
|
|
|
|
ColumnFamilyOptions* options = new (options_ptr) ColumnFamilyOptions();
|
|
|
|
|
FillWithSpecialChar(options_ptr, sizeof(ColumnFamilyOptions),
|
|
|
|
|
kColumnFamilyOptionsBlacklist);
|
|
|
|
|
// It based on the behavior of compiler that padding bytes are not changed
|
|
|
|
|
// when copying the struct. It's prone to failure when compiler behavior
|
|
|
|
|
// changes. We verify there is unset bytes to detect the case.
|
|
|
|
|
*options = ColumnFamilyOptions();
|
|
|
|
|
|
|
|
|
|
// Deprecatd option which is not initialized. Need to set it to avoid
|
|
|
|
|
// Valgrind error
|
|
|
|
|
options->max_mem_compaction_level = 0;
|
|
|
|
|
|
|
|
|
|
int unset_bytes_base = NumUnsetBytes(options_ptr, sizeof(ColumnFamilyOptions),
|
|
|
|
|
kColumnFamilyOptionsBlacklist);
|
|
|
|
|
ASSERT_GT(unset_bytes_base, 0);
|
|
|
|
|
options->~ColumnFamilyOptions();
|
|
|
|
|
|
|
|
|
|
options = new (options_ptr) ColumnFamilyOptions();
|
|
|
|
|
FillWithSpecialChar(options_ptr, sizeof(ColumnFamilyOptions),
|
|
|
|
|
kColumnFamilyOptionsBlacklist);
|
|
|
|
|
|
|
|
|
|
// Following options are not settable through
|
|
|
|
|
// GetColumnFamilyOptionsFromString():
|
|
|
|
|
options->rate_limit_delay_max_milliseconds = 33;
|
|
|
|
|
options->compaction_pri = CompactionPri::kOldestSmallestSeqFirst;
|
|
|
|
|
options->compaction_options_universal = CompactionOptionsUniversal();
|
|
|
|
|
options->compression_opts = CompressionOptions();
|
|
|
|
|
options->hard_rate_limit = 0;
|
|
|
|
|
options->soft_rate_limit = 0;
|
|
|
|
|
options->compaction_options_fifo = CompactionOptionsFIFO();
|
|
|
|
|
options->max_mem_compaction_level = 0;
|
|
|
|
|
|
|
|
|
|
char* new_options_ptr = new char[sizeof(ColumnFamilyOptions)];
|
|
|
|
|
ColumnFamilyOptions* new_options =
|
|
|
|
|
new (new_options_ptr) ColumnFamilyOptions();
|
|
|
|
|
FillWithSpecialChar(new_options_ptr, sizeof(ColumnFamilyOptions),
|
|
|
|
|
kColumnFamilyOptionsBlacklist);
|
|
|
|
|
|
|
|
|
|
// Need to update the option string if a new option is added.
|
|
|
|
|
ASSERT_OK(GetColumnFamilyOptionsFromString(
|
|
|
|
|
*options,
|
|
|
|
|
"compaction_filter_factory=mpudlojcujCompactionFilterFactory;"
|
|
|
|
|
"table_factory=PlainTable;"
|
|
|
|
|
"prefix_extractor=rocksdb.CappedPrefix.13;"
|
|
|
|
|
"comparator=leveldb.BytewiseComparator;"
|
|
|
|
|
"compression_per_level=kBZip2Compression:kBZip2Compression:"
|
|
|
|
|
"kBZip2Compression:kNoCompression:kZlibCompression:kBZip2Compression:"
|
|
|
|
|
"kSnappyCompression;"
|
|
|
|
|
"max_bytes_for_level_base=986;"
|
|
|
|
|
"bloom_locality=8016;"
|
|
|
|
|
"target_file_size_base=4294976376;"
|
|
|
|
|
"memtable_prefix_bloom_huge_page_tlb_size=2557;"
|
|
|
|
|
"max_successive_merges=5497;"
|
|
|
|
|
"max_sequential_skip_in_iterations=4294971408;"
|
|
|
|
|
"arena_block_size=1893;"
|
|
|
|
|
"target_file_size_multiplier=35;"
|
|
|
|
|
"source_compaction_factor=54;"
|
|
|
|
|
"min_write_buffer_number_to_merge=9;"
|
|
|
|
|
"max_write_buffer_number=84;"
|
|
|
|
|
"write_buffer_size=1653;"
|
|
|
|
|
"max_grandparent_overlap_factor=64;"
|
|
|
|
|
"max_bytes_for_level_multiplier=60;"
|
|
|
|
|
"memtable_factory=SkipListFactory;"
|
|
|
|
|
"compression=kNoCompression;"
|
|
|
|
|
"min_partial_merge_operands=7576;"
|
|
|
|
|
"level0_stop_writes_trigger=33;"
|
|
|
|
|
"num_levels=99;"
|
|
|
|
|
"level0_slowdown_writes_trigger=22;"
|
|
|
|
|
"level0_file_num_compaction_trigger=14;"
|
|
|
|
|
"expanded_compaction_factor=34;"
|
|
|
|
|
"compaction_filter=urxcqstuwnCompactionFilter;"
|
|
|
|
|
"soft_rate_limit=530.615385;"
|
|
|
|
|
"soft_pending_compaction_bytes_limit=0;"
|
|
|
|
|
"max_write_buffer_number_to_maintain=84;"
|
|
|
|
|
"verify_checksums_in_compaction=false;"
|
|
|
|
|
"merge_operator=aabcxehazrMergeOperator;"
|
|
|
|
|
"memtable_prefix_bloom_bits=4642;"
|
|
|
|
|
"paranoid_file_checks=true;"
|
|
|
|
|
"inplace_update_num_locks=7429;"
|
|
|
|
|
"optimize_filters_for_hits=false;"
|
|
|
|
|
"level_compaction_dynamic_level_bytes=false;"
|
|
|
|
|
"inplace_update_support=false;"
|
|
|
|
|
"compaction_style=kCompactionStyleFIFO;"
|
|
|
|
|
"memtable_prefix_bloom_probes=2511;"
|
|
|
|
|
"purge_redundant_kvs_while_flush=true;"
|
|
|
|
|
"filter_deletes=false;"
|
|
|
|
|
"hard_pending_compaction_bytes_limit=0;"
|
|
|
|
|
"disable_auto_compactions=false;"
|
|
|
|
|
"compaction_measure_io_stats=true;",
|
|
|
|
|
new_options));
|
|
|
|
|
|
|
|
|
|
ASSERT_EQ(unset_bytes_base,
|
|
|
|
|
NumUnsetBytes(new_options_ptr, sizeof(ColumnFamilyOptions),
|
|
|
|
|
kColumnFamilyOptionsBlacklist));
|
|
|
|
|
|
|
|
|
|
options->~ColumnFamilyOptions();
|
|
|
|
|
new_options->~ColumnFamilyOptions();
|
|
|
|
|
|
|
|
|
|
delete[] options_ptr;
|
|
|
|
|
delete[] new_options_ptr;
|
|
|
|
|
}
|
|
|
|
|
#endif // !__clang__
|
|
|
|
|
#endif // OS_LINUX
|
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
|
|
|
#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();
|
|
|
|
|
}
|
