2016-02-09 23:12:00 +00:00
|
|
|
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
2017-07-15 23:03:42 +00:00
|
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
|
|
// (found in the LICENSE.Apache file in the root directory).
|
2013-10-29 00:54:09 +00:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
|
|
|
#include "table/block_based_table_factory.h"
|
|
|
|
|
2017-10-13 21:41:07 +00:00
|
|
|
#ifndef __STDC_FORMAT_MACROS
|
|
|
|
#define __STDC_FORMAT_MACROS
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include <inttypes.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
|
2013-10-29 00:54:09 +00:00
|
|
|
#include <memory>
|
2014-03-01 02:19:07 +00:00
|
|
|
#include <string>
|
|
|
|
|
2017-07-28 23:23:50 +00:00
|
|
|
#include "options/options_helper.h"
|
2015-01-15 00:24:24 +00:00
|
|
|
#include "port/port.h"
|
2014-08-25 21:22:05 +00:00
|
|
|
#include "rocksdb/cache.h"
|
2017-07-28 23:23:50 +00:00
|
|
|
#include "rocksdb/convenience.h"
|
|
|
|
#include "rocksdb/flush_block_policy.h"
|
2013-10-29 00:54:09 +00:00
|
|
|
#include "table/block_based_table_builder.h"
|
2013-10-30 17:52:33 +00:00
|
|
|
#include "table/block_based_table_reader.h"
|
2015-01-15 00:24:24 +00:00
|
|
|
#include "table/format.h"
|
2018-07-20 21:31:27 +00:00
|
|
|
#include "util/mutexlock.h"
|
2017-07-28 23:23:50 +00:00
|
|
|
#include "util/string_util.h"
|
2013-10-29 00:54:09 +00:00
|
|
|
|
|
|
|
namespace rocksdb {
|
|
|
|
|
2018-07-20 21:31:27 +00:00
|
|
|
void TailPrefetchStats::RecordEffectiveSize(size_t len) {
|
|
|
|
MutexLock l(&mutex_);
|
|
|
|
if (num_records_ < kNumTracked) {
|
|
|
|
num_records_++;
|
|
|
|
}
|
|
|
|
records_[next_++] = len;
|
|
|
|
if (next_ == kNumTracked) {
|
|
|
|
next_ = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t TailPrefetchStats::GetSuggestedPrefetchSize() {
|
|
|
|
std::vector<size_t> sorted;
|
|
|
|
{
|
|
|
|
MutexLock l(&mutex_);
|
|
|
|
|
|
|
|
if (num_records_ == 0) {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
sorted.assign(records_, records_ + num_records_);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Of the historic size, we find the maximum one that satisifis the condtiion
|
|
|
|
// that if prefetching all, less than 1/8 will be wasted.
|
|
|
|
std::sort(sorted.begin(), sorted.end());
|
|
|
|
|
|
|
|
// Assuming we have 5 data points, and after sorting it looks like this:
|
|
|
|
//
|
|
|
|
// +---+
|
|
|
|
// +---+ | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// +---+ | | | |
|
|
|
|
// | | | | | |
|
|
|
|
// +---+ | | | | | |
|
|
|
|
// | | | | | | | |
|
|
|
|
// +---+ | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// +---+ +---+ +---+ +---+ +---+
|
|
|
|
//
|
|
|
|
// and we use every of the value as a candidate, and estimate how much we
|
|
|
|
// wasted, compared to read. For example, when we use the 3rd record
|
|
|
|
// as candiate. This area is what we read:
|
|
|
|
// +---+
|
|
|
|
// +---+ | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// *** *** *** ***+ *** *** *** *** **
|
|
|
|
// * | | | | | |
|
|
|
|
// +---+ | | | | | *
|
|
|
|
// * | | | | | | | |
|
|
|
|
// +---+ | | | | | | | *
|
|
|
|
// * | | | | X | | | | |
|
|
|
|
// | | | | | | | | | *
|
|
|
|
// * | | | | | | | | |
|
|
|
|
// | | | | | | | | | *
|
|
|
|
// * | | | | | | | | |
|
|
|
|
// *** *** ***-*** ***--*** ***--*** +****
|
|
|
|
// which is (size of the record) X (number of records).
|
|
|
|
//
|
|
|
|
// While wasted is this area:
|
|
|
|
// +---+
|
|
|
|
// +---+ | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// | | | |
|
|
|
|
// *** *** *** ****---+ | | | |
|
|
|
|
// * * | | | | |
|
|
|
|
// * *-*** *** | | | | |
|
|
|
|
// * * | | | | | | |
|
|
|
|
// *--** *** | | | | | | |
|
|
|
|
// | | | | | X | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// +---+ +---+ +---+ +---+ +---+
|
|
|
|
//
|
|
|
|
// Which can be calculated iteratively.
|
|
|
|
// The difference between wasted using 4st and 3rd record, will
|
|
|
|
// be following area:
|
|
|
|
// +---+
|
|
|
|
// +--+ +-+ ++ +-+ +-+ +---+ | |
|
|
|
|
// + xxxxxxxxxxxxxxxxxxxxxxxx | | | |
|
|
|
|
// xxxxxxxxxxxxxxxxxxxxxxxx | | | |
|
|
|
|
// + xxxxxxxxxxxxxxxxxxxxxxxx | | | |
|
|
|
|
// | xxxxxxxxxxxxxxxxxxxxxxxx | | | |
|
|
|
|
// +-+ +-+ +-+ ++ +---+ +--+ | | |
|
|
|
|
// | | | | | | |
|
|
|
|
// +---+ ++ | | | | | |
|
|
|
|
// | | | | | | X | | |
|
|
|
|
// +---+ ++ | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// | | | | | | | | | |
|
|
|
|
// +---+ +---+ +---+ +---+ +---+
|
|
|
|
//
|
|
|
|
// which will be the size difference between 4st and 3rd record,
|
|
|
|
// times 3, which is number of records before the 4st.
|
|
|
|
// Here we assume that all data within the prefetch range will be useful. In
|
|
|
|
// reality, it may not be the case when a partial block is inside the range,
|
|
|
|
// or there are data in the middle that is not read. We ignore those cases
|
|
|
|
// for simplicity.
|
|
|
|
assert(!sorted.empty());
|
|
|
|
size_t prev_size = sorted[0];
|
|
|
|
size_t max_qualified_size = sorted[0];
|
|
|
|
size_t wasted = 0;
|
|
|
|
for (size_t i = 1; i < sorted.size(); i++) {
|
|
|
|
size_t read = sorted[i] * sorted.size();
|
|
|
|
wasted += (sorted[i] - prev_size) * i;
|
|
|
|
if (wasted <= read / 8) {
|
|
|
|
max_qualified_size = sorted[i];
|
|
|
|
}
|
|
|
|
prev_size = sorted[i];
|
|
|
|
}
|
|
|
|
const size_t kMaxPrefetchSize = 512 * 1024; // Never exceed 512KB
|
|
|
|
return std::min(kMaxPrefetchSize, max_qualified_size);
|
|
|
|
}
|
|
|
|
|
2014-03-01 00:39:27 +00:00
|
|
|
BlockBasedTableFactory::BlockBasedTableFactory(
|
2015-11-18 00:41:54 +00:00
|
|
|
const BlockBasedTableOptions& _table_options)
|
|
|
|
: table_options_(_table_options) {
|
2014-03-01 00:39:27 +00:00
|
|
|
if (table_options_.flush_block_policy_factory == nullptr) {
|
|
|
|
table_options_.flush_block_policy_factory.reset(
|
|
|
|
new FlushBlockBySizePolicyFactory());
|
|
|
|
}
|
2014-08-25 21:22:05 +00:00
|
|
|
if (table_options_.no_block_cache) {
|
|
|
|
table_options_.block_cache.reset();
|
|
|
|
} else if (table_options_.block_cache == nullptr) {
|
|
|
|
table_options_.block_cache = NewLRUCache(8 << 20);
|
|
|
|
}
|
|
|
|
if (table_options_.block_size_deviation < 0 ||
|
|
|
|
table_options_.block_size_deviation > 100) {
|
|
|
|
table_options_.block_size_deviation = 0;
|
|
|
|
}
|
2016-01-04 18:51:00 +00:00
|
|
|
if (table_options_.block_restart_interval < 1) {
|
|
|
|
table_options_.block_restart_interval = 1;
|
|
|
|
}
|
2016-02-05 18:22:37 +00:00
|
|
|
if (table_options_.index_block_restart_interval < 1) {
|
|
|
|
table_options_.index_block_restart_interval = 1;
|
|
|
|
}
|
2017-06-24 01:18:21 +00:00
|
|
|
if (table_options_.partition_filters &&
|
|
|
|
table_options_.index_type !=
|
|
|
|
BlockBasedTableOptions::kTwoLevelIndexSearch) {
|
|
|
|
// We do not support partitioned filters without partitioning indexes
|
|
|
|
table_options_.partition_filters = false;
|
|
|
|
}
|
2014-03-01 00:39:27 +00:00
|
|
|
}
|
|
|
|
|
2014-01-28 05:58:46 +00:00
|
|
|
Status BlockBasedTableFactory::NewTableReader(
|
2015-09-11 18:36:33 +00:00
|
|
|
const TableReaderOptions& table_reader_options,
|
2018-11-09 19:17:34 +00:00
|
|
|
std::unique_ptr<RandomAccessFileReader>&& file, uint64_t file_size,
|
|
|
|
std::unique_ptr<TableReader>* table_reader,
|
2016-07-20 18:23:31 +00:00
|
|
|
bool prefetch_index_and_filter_in_cache) const {
|
2015-09-11 18:36:33 +00:00
|
|
|
return BlockBasedTable::Open(
|
|
|
|
table_reader_options.ioptions, table_reader_options.env_options,
|
|
|
|
table_options_, table_reader_options.internal_comparator, std::move(file),
|
2018-05-21 21:33:55 +00:00
|
|
|
file_size, table_reader, table_reader_options.prefix_extractor,
|
|
|
|
prefetch_index_and_filter_in_cache, table_reader_options.skip_filters,
|
2018-07-20 21:31:27 +00:00
|
|
|
table_reader_options.level, table_reader_options.immortal,
|
2018-07-27 23:00:26 +00:00
|
|
|
table_reader_options.largest_seqno, &tail_prefetch_stats_);
|
2013-10-29 00:54:09 +00:00
|
|
|
}
|
|
|
|
|
2014-01-28 05:58:46 +00:00
|
|
|
TableBuilder* BlockBasedTableFactory::NewTableBuilder(
|
2015-10-08 23:57:35 +00:00
|
|
|
const TableBuilderOptions& table_builder_options, uint32_t column_family_id,
|
Move rate_limiter, write buffering, most perf context instrumentation and most random kill out of Env
Summary: We want to keep Env a think layer for better portability. Less platform dependent codes should be moved out of Env. In this patch, I create a wrapper of file readers and writers, and put rate limiting, write buffering, as well as most perf context instrumentation and random kill out of Env. It will make it easier to maintain multiple Env in the future.
Test Plan: Run all existing unit tests.
Reviewers: anthony, kradhakrishnan, IslamAbdelRahman, yhchiang, igor
Reviewed By: igor
Subscribers: leveldb, dhruba
Differential Revision: https://reviews.facebook.net/D42321
2015-07-17 23:16:11 +00:00
|
|
|
WritableFileWriter* file) const {
|
2014-03-01 02:19:07 +00:00
|
|
|
auto table_builder = new BlockBasedTableBuilder(
|
2018-05-21 21:33:55 +00:00
|
|
|
table_builder_options.ioptions, table_builder_options.moptions,
|
|
|
|
table_options_, table_builder_options.internal_comparator,
|
2015-10-08 23:57:35 +00:00
|
|
|
table_builder_options.int_tbl_prop_collector_factories, column_family_id,
|
|
|
|
file, table_builder_options.compression_type,
|
A new call back to TablePropertiesCollector to allow users know the entry is add, delete or merge
Summary:
Currently users have no idea a key is add, delete or merge from TablePropertiesCollector call back. Add a new function to add it.
Also refactor the codes so that
(1) make table property collector and internal table property collector two separate data structures with the later one now exposed
(2) table builders only receive internal table properties
Test Plan: Add cases in table_properties_collector_test to cover both of old and new ways of using TablePropertiesCollector.
Reviewers: yhchiang, igor.sugak, rven, igor
Reviewed By: rven, igor
Subscribers: meyering, yoshinorim, maykov, leveldb, dhruba
Differential Revision: https://reviews.facebook.net/D35373
2015-04-06 17:04:30 +00:00
|
|
|
table_builder_options.compression_opts,
|
2016-04-07 06:10:32 +00:00
|
|
|
table_builder_options.skip_filters,
|
2017-06-28 00:02:20 +00:00
|
|
|
table_builder_options.column_family_name,
|
2017-10-23 22:22:05 +00:00
|
|
|
table_builder_options.creation_time,
|
Reduce scope of compression dictionary to single SST (#4952)
Summary:
Our previous approach was to train one compression dictionary per compaction, using the first output SST to train a dictionary, and then applying it on subsequent SSTs in the same compaction. While this was great for minimizing CPU/memory/I/O overhead, it did not achieve good compression ratios in practice. In our most promising potential use case, moderate reductions in a dictionary's scope make a major difference on compression ratio.
So, this PR changes compression dictionary to be scoped per-SST. It accepts the tradeoff during table building to use more memory and CPU. Important changes include:
- The `BlockBasedTableBuilder` has a new state when dictionary compression is in-use: `kBuffered`. In that state it accumulates uncompressed data in-memory whenever `Add` is called.
- After accumulating target file size bytes or calling `BlockBasedTableBuilder::Finish`, a `BlockBasedTableBuilder` moves to the `kUnbuffered` state. The transition (`EnterUnbuffered()`) involves sampling the buffered data, training a dictionary, and compressing/writing out all buffered data. In the `kUnbuffered` state, a `BlockBasedTableBuilder` behaves the same as before -- blocks are compressed/written out as soon as they fill up.
- Samples are now whole uncompressed data blocks, except the final sample may be a partial data block so we don't breach the user's configured `max_dict_bytes` or `zstd_max_train_bytes`. The dictionary trainer is supposed to work better when we pass it real units of compression. Previously we were passing 64-byte KV samples which was not realistic.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/4952
Differential Revision: D13967980
Pulled By: ajkr
fbshipit-source-id: 82bea6f7537e1529c7a1a4cdee84585f5949300f
2019-02-12 03:42:25 +00:00
|
|
|
table_builder_options.oldest_key_time,
|
|
|
|
table_builder_options.target_file_size);
|
2013-11-20 06:00:48 +00:00
|
|
|
|
|
|
|
return table_builder;
|
2013-10-29 00:54:09 +00:00
|
|
|
}
|
2013-11-20 06:00:48 +00:00
|
|
|
|
2014-10-18 04:18:36 +00:00
|
|
|
Status BlockBasedTableFactory::SanitizeOptions(
|
2018-03-05 21:08:17 +00:00
|
|
|
const DBOptions& /*db_opts*/, const ColumnFamilyOptions& cf_opts) const {
|
2014-10-18 04:18:36 +00:00
|
|
|
if (table_options_.index_type == BlockBasedTableOptions::kHashSearch &&
|
|
|
|
cf_opts.prefix_extractor == nullptr) {
|
2018-04-13 00:55:14 +00:00
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Hash index is specified for block-based "
|
2014-10-18 04:18:36 +00:00
|
|
|
"table, but prefix_extractor is not given");
|
|
|
|
}
|
2014-10-22 18:52:35 +00:00
|
|
|
if (table_options_.cache_index_and_filter_blocks &&
|
|
|
|
table_options_.no_block_cache) {
|
2018-04-13 00:55:14 +00:00
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Enable cache_index_and_filter_blocks, "
|
2014-10-22 18:52:35 +00:00
|
|
|
", but block cache is disabled");
|
|
|
|
}
|
Adding pin_l0_filter_and_index_blocks_in_cache feature and related fixes.
Summary:
When a block based table file is opened, if prefetch_index_and_filter is true, it will prefetch the index and filter blocks, putting them into the block cache.
What this feature adds: when a L0 block based table file is opened, if pin_l0_filter_and_index_blocks_in_cache is true in the options (and prefetch_index_and_filter is true), then the filter and index blocks aren't released back to the block cache at the end of BlockBasedTableReader::Open(). Instead the table reader takes ownership of them, hence pinning them, ie. the LRU cache will never push them out. Meanwhile in the table reader, further accesses will not hit the block cache, thus avoiding lock contention.
Test Plan:
'export TEST_TMPDIR=/dev/shm/ && DISABLE_JEMALLOC=1 OPT=-g make all valgrind_check -j32' is OK.
I didn't run the Java tests, I don't have Java set up on my devserver.
Reviewers: sdong
Reviewed By: sdong
Subscribers: andrewkr, dhruba
Differential Revision: https://reviews.facebook.net/D56133
2016-04-01 17:42:39 +00:00
|
|
|
if (table_options_.pin_l0_filter_and_index_blocks_in_cache &&
|
|
|
|
table_options_.no_block_cache) {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Enable pin_l0_filter_and_index_blocks_in_cache, "
|
|
|
|
", but block cache is disabled");
|
|
|
|
}
|
2015-01-15 00:24:24 +00:00
|
|
|
if (!BlockBasedTableSupportedVersion(table_options_.format_version)) {
|
2015-01-13 22:33:04 +00:00
|
|
|
return Status::InvalidArgument(
|
2015-01-15 00:24:24 +00:00
|
|
|
"Unsupported BlockBasedTable format_version. Please check "
|
|
|
|
"include/rocksdb/table.h for more info");
|
2015-01-13 22:33:04 +00:00
|
|
|
}
|
2018-03-27 03:14:24 +00:00
|
|
|
if (table_options_.block_align && (cf_opts.compression != kNoCompression)) {
|
2018-04-13 00:55:14 +00:00
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Enable block_align, but compression "
|
2018-03-27 03:14:24 +00:00
|
|
|
"enabled");
|
|
|
|
}
|
|
|
|
if (table_options_.block_align &&
|
|
|
|
(table_options_.block_size & (table_options_.block_size - 1))) {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"Block alignment requested but block size is not a power of 2");
|
|
|
|
}
|
2018-08-15 21:27:47 +00:00
|
|
|
if (table_options_.data_block_index_type ==
|
2018-08-17 01:29:13 +00:00
|
|
|
BlockBasedTableOptions::kDataBlockBinaryAndHash &&
|
2018-08-15 21:27:47 +00:00
|
|
|
table_options_.data_block_hash_table_util_ratio <= 0) {
|
|
|
|
return Status::InvalidArgument(
|
|
|
|
"data_block_hash_table_util_ratio should be greater than 0 when "
|
|
|
|
"data_block_index_type is set to kDataBlockBinaryAndHash");
|
|
|
|
}
|
2014-10-18 04:18:36 +00:00
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
2014-08-25 21:24:09 +00:00
|
|
|
std::string BlockBasedTableFactory::GetPrintableTableOptions() const {
|
|
|
|
std::string ret;
|
|
|
|
ret.reserve(20000);
|
|
|
|
const int kBufferSize = 200;
|
|
|
|
char buffer[kBufferSize];
|
|
|
|
|
|
|
|
snprintf(buffer, kBufferSize, " flush_block_policy_factory: %s (%p)\n",
|
|
|
|
table_options_.flush_block_policy_factory->Name(),
|
2016-03-16 21:57:57 +00:00
|
|
|
static_cast<void*>(table_options_.flush_block_policy_factory.get()));
|
2014-08-25 21:24:09 +00:00
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " cache_index_and_filter_blocks: %d\n",
|
|
|
|
table_options_.cache_index_and_filter_blocks);
|
|
|
|
ret.append(buffer);
|
2016-12-22 22:44:01 +00:00
|
|
|
snprintf(buffer, kBufferSize,
|
|
|
|
" cache_index_and_filter_blocks_with_high_priority: %d\n",
|
|
|
|
table_options_.cache_index_and_filter_blocks_with_high_priority);
|
|
|
|
ret.append(buffer);
|
Adding pin_l0_filter_and_index_blocks_in_cache feature and related fixes.
Summary:
When a block based table file is opened, if prefetch_index_and_filter is true, it will prefetch the index and filter blocks, putting them into the block cache.
What this feature adds: when a L0 block based table file is opened, if pin_l0_filter_and_index_blocks_in_cache is true in the options (and prefetch_index_and_filter is true), then the filter and index blocks aren't released back to the block cache at the end of BlockBasedTableReader::Open(). Instead the table reader takes ownership of them, hence pinning them, ie. the LRU cache will never push them out. Meanwhile in the table reader, further accesses will not hit the block cache, thus avoiding lock contention.
Test Plan:
'export TEST_TMPDIR=/dev/shm/ && DISABLE_JEMALLOC=1 OPT=-g make all valgrind_check -j32' is OK.
I didn't run the Java tests, I don't have Java set up on my devserver.
Reviewers: sdong
Reviewed By: sdong
Subscribers: andrewkr, dhruba
Differential Revision: https://reviews.facebook.net/D56133
2016-04-01 17:42:39 +00:00
|
|
|
snprintf(buffer, kBufferSize,
|
|
|
|
" pin_l0_filter_and_index_blocks_in_cache: %d\n",
|
|
|
|
table_options_.pin_l0_filter_and_index_blocks_in_cache);
|
|
|
|
ret.append(buffer);
|
2018-06-22 22:14:05 +00:00
|
|
|
snprintf(buffer, kBufferSize, " pin_top_level_index_and_filter: %d\n",
|
|
|
|
table_options_.pin_top_level_index_and_filter);
|
|
|
|
ret.append(buffer);
|
2014-08-25 21:24:09 +00:00
|
|
|
snprintf(buffer, kBufferSize, " index_type: %d\n",
|
|
|
|
table_options_.index_type);
|
|
|
|
ret.append(buffer);
|
2019-03-08 19:15:51 +00:00
|
|
|
snprintf(buffer, kBufferSize, " data_block_index_type: %d\n",
|
|
|
|
table_options_.data_block_index_type);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " data_block_hash_table_util_ratio: %lf\n",
|
|
|
|
table_options_.data_block_hash_table_util_ratio);
|
|
|
|
ret.append(buffer);
|
2014-08-25 21:24:09 +00:00
|
|
|
snprintf(buffer, kBufferSize, " hash_index_allow_collision: %d\n",
|
|
|
|
table_options_.hash_index_allow_collision);
|
|
|
|
ret.append(buffer);
|
2018-04-13 00:55:14 +00:00
|
|
|
snprintf(buffer, kBufferSize, " checksum: %d\n", table_options_.checksum);
|
2014-08-25 21:24:09 +00:00
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " no_block_cache: %d\n",
|
|
|
|
table_options_.no_block_cache);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " block_cache: %p\n",
|
2016-03-16 21:57:57 +00:00
|
|
|
static_cast<void*>(table_options_.block_cache.get()));
|
2014-08-25 21:24:09 +00:00
|
|
|
ret.append(buffer);
|
|
|
|
if (table_options_.block_cache) {
|
2016-12-22 22:44:01 +00:00
|
|
|
const char* block_cache_name = table_options_.block_cache->Name();
|
|
|
|
if (block_cache_name != nullptr) {
|
|
|
|
snprintf(buffer, kBufferSize, " block_cache_name: %s\n",
|
|
|
|
block_cache_name);
|
|
|
|
ret.append(buffer);
|
|
|
|
}
|
|
|
|
ret.append(" block_cache_options:\n");
|
|
|
|
ret.append(table_options_.block_cache->GetPrintableOptions());
|
|
|
|
}
|
|
|
|
snprintf(buffer, kBufferSize, " block_cache_compressed: %p\n",
|
|
|
|
static_cast<void*>(table_options_.block_cache_compressed.get()));
|
|
|
|
ret.append(buffer);
|
|
|
|
if (table_options_.block_cache_compressed) {
|
|
|
|
const char* block_cache_compressed_name =
|
|
|
|
table_options_.block_cache_compressed->Name();
|
|
|
|
if (block_cache_compressed_name != nullptr) {
|
|
|
|
snprintf(buffer, kBufferSize, " block_cache_name: %s\n",
|
|
|
|
block_cache_compressed_name);
|
|
|
|
ret.append(buffer);
|
|
|
|
}
|
|
|
|
ret.append(" block_cache_compressed_options:\n");
|
|
|
|
ret.append(table_options_.block_cache_compressed->GetPrintableOptions());
|
2014-08-25 21:24:09 +00:00
|
|
|
}
|
2016-12-19 22:00:04 +00:00
|
|
|
snprintf(buffer, kBufferSize, " persistent_cache: %p\n",
|
|
|
|
static_cast<void*>(table_options_.persistent_cache.get()));
|
|
|
|
ret.append(buffer);
|
|
|
|
if (table_options_.persistent_cache) {
|
|
|
|
snprintf(buffer, kBufferSize, " persistent_cache_options:\n");
|
|
|
|
ret.append(buffer);
|
|
|
|
ret.append(table_options_.persistent_cache->GetPrintableOptions());
|
|
|
|
}
|
2015-07-01 23:13:49 +00:00
|
|
|
snprintf(buffer, kBufferSize, " block_size: %" ROCKSDB_PRIszt "\n",
|
2014-08-25 21:24:09 +00:00
|
|
|
table_options_.block_size);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " block_size_deviation: %d\n",
|
|
|
|
table_options_.block_size_deviation);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " block_restart_interval: %d\n",
|
|
|
|
table_options_.block_restart_interval);
|
|
|
|
ret.append(buffer);
|
2016-02-05 18:22:37 +00:00
|
|
|
snprintf(buffer, kBufferSize, " index_block_restart_interval: %d\n",
|
|
|
|
table_options_.index_block_restart_interval);
|
|
|
|
ret.append(buffer);
|
2017-10-13 21:41:07 +00:00
|
|
|
snprintf(buffer, kBufferSize, " metadata_block_size: %" PRIu64 "\n",
|
|
|
|
table_options_.metadata_block_size);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " partition_filters: %d\n",
|
|
|
|
table_options_.partition_filters);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " use_delta_encoding: %d\n",
|
|
|
|
table_options_.use_delta_encoding);
|
|
|
|
ret.append(buffer);
|
2014-08-25 21:24:09 +00:00
|
|
|
snprintf(buffer, kBufferSize, " filter_policy: %s\n",
|
2018-04-13 00:55:14 +00:00
|
|
|
table_options_.filter_policy == nullptr
|
|
|
|
? "nullptr"
|
|
|
|
: table_options_.filter_policy->Name());
|
2014-08-25 21:24:09 +00:00
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " whole_key_filtering: %d\n",
|
|
|
|
table_options_.whole_key_filtering);
|
2015-10-31 01:33:01 +00:00
|
|
|
ret.append(buffer);
|
2017-10-13 21:41:07 +00:00
|
|
|
snprintf(buffer, kBufferSize, " verify_compression: %d\n",
|
|
|
|
table_options_.verify_compression);
|
|
|
|
ret.append(buffer);
|
|
|
|
snprintf(buffer, kBufferSize, " read_amp_bytes_per_bit: %d\n",
|
|
|
|
table_options_.read_amp_bytes_per_bit);
|
|
|
|
ret.append(buffer);
|
2015-01-13 22:33:04 +00:00
|
|
|
snprintf(buffer, kBufferSize, " format_version: %d\n",
|
|
|
|
table_options_.format_version);
|
2014-08-25 21:24:09 +00:00
|
|
|
ret.append(buffer);
|
2018-01-10 23:06:29 +00:00
|
|
|
snprintf(buffer, kBufferSize, " enable_index_compression: %d\n",
|
|
|
|
table_options_.enable_index_compression);
|
|
|
|
ret.append(buffer);
|
2018-03-27 03:14:24 +00:00
|
|
|
snprintf(buffer, kBufferSize, " block_align: %d\n",
|
|
|
|
table_options_.block_align);
|
|
|
|
ret.append(buffer);
|
2014-08-25 21:24:09 +00:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2017-07-28 23:23:50 +00:00
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
namespace {
|
|
|
|
bool SerializeSingleBlockBasedTableOption(
|
|
|
|
std::string* opt_string, const BlockBasedTableOptions& bbt_options,
|
|
|
|
const std::string& name, const std::string& delimiter) {
|
|
|
|
auto iter = block_based_table_type_info.find(name);
|
|
|
|
if (iter == block_based_table_type_info.end()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
auto& opt_info = iter->second;
|
|
|
|
const char* opt_address =
|
|
|
|
reinterpret_cast<const char*>(&bbt_options) + opt_info.offset;
|
|
|
|
std::string value;
|
|
|
|
bool result = SerializeSingleOptionHelper(opt_address, opt_info.type, &value);
|
|
|
|
if (result) {
|
|
|
|
*opt_string = name + "=" + value + delimiter;
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
Status BlockBasedTableFactory::GetOptionString(
|
|
|
|
std::string* opt_string, const std::string& delimiter) const {
|
|
|
|
assert(opt_string);
|
|
|
|
opt_string->clear();
|
|
|
|
for (auto iter = block_based_table_type_info.begin();
|
|
|
|
iter != block_based_table_type_info.end(); ++iter) {
|
|
|
|
if (iter->second.verification == OptionVerificationType::kDeprecated) {
|
|
|
|
// If the option is no longer used in rocksdb and marked as deprecated,
|
|
|
|
// we skip it in the serialization.
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
std::string single_output;
|
|
|
|
bool result = SerializeSingleBlockBasedTableOption(
|
|
|
|
&single_output, table_options_, iter->first, delimiter);
|
|
|
|
assert(result);
|
|
|
|
if (result) {
|
|
|
|
opt_string->append(single_output);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
Status BlockBasedTableFactory::GetOptionString(
|
2018-04-13 00:55:14 +00:00
|
|
|
std::string* /*opt_string*/, const std::string& /*delimiter*/) const {
|
2017-07-28 23:23:50 +00:00
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
2015-10-30 22:58:46 +00:00
|
|
|
const BlockBasedTableOptions& BlockBasedTableFactory::table_options() const {
|
2014-11-21 03:24:39 +00:00
|
|
|
return table_options_;
|
|
|
|
}
|
|
|
|
|
2017-07-28 23:23:50 +00:00
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
namespace {
|
|
|
|
std::string ParseBlockBasedTableOption(const std::string& name,
|
|
|
|
const std::string& org_value,
|
|
|
|
BlockBasedTableOptions* new_options,
|
|
|
|
bool input_strings_escaped = false,
|
|
|
|
bool ignore_unknown_options = false) {
|
|
|
|
const std::string& value =
|
|
|
|
input_strings_escaped ? UnescapeOptionString(org_value) : org_value;
|
|
|
|
if (!input_strings_escaped) {
|
|
|
|
// if the input string is not escaped, it means this function is
|
|
|
|
// invoked from SetOptions, which takes the old format.
|
2017-11-28 18:35:17 +00:00
|
|
|
if (name == "block_cache" || name == "block_cache_compressed") {
|
|
|
|
// cache options can be specified in the following format
|
|
|
|
// "block_cache={capacity=1M;num_shard_bits=4;
|
|
|
|
// strict_capacity_limit=true;high_pri_pool_ratio=0.5;}"
|
|
|
|
// To support backward compatibility, the following format
|
|
|
|
// is also supported.
|
|
|
|
// "block_cache=1M"
|
|
|
|
std::shared_ptr<Cache> cache;
|
|
|
|
// block_cache is specified in format block_cache=<cache_size>.
|
|
|
|
if (value.find('=') == std::string::npos) {
|
|
|
|
cache = NewLRUCache(ParseSizeT(value));
|
|
|
|
} else {
|
|
|
|
LRUCacheOptions cache_opts;
|
2018-04-13 00:55:14 +00:00
|
|
|
if (!ParseOptionHelper(reinterpret_cast<char*>(&cache_opts),
|
|
|
|
OptionType::kLRUCacheOptions, value)) {
|
2017-11-28 18:35:17 +00:00
|
|
|
return "Invalid cache options";
|
|
|
|
}
|
|
|
|
cache = NewLRUCache(cache_opts);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (name == "block_cache") {
|
|
|
|
new_options->block_cache = cache;
|
|
|
|
} else {
|
|
|
|
new_options->block_cache_compressed = cache;
|
|
|
|
}
|
2017-07-28 23:23:50 +00:00
|
|
|
return "";
|
|
|
|
} else if (name == "filter_policy") {
|
|
|
|
// Expect the following format
|
|
|
|
// bloomfilter:int:bool
|
|
|
|
const std::string kName = "bloomfilter:";
|
|
|
|
if (value.compare(0, kName.size(), kName) != 0) {
|
|
|
|
return "Invalid filter policy name";
|
|
|
|
}
|
|
|
|
size_t pos = value.find(':', kName.size());
|
|
|
|
if (pos == std::string::npos) {
|
|
|
|
return "Invalid filter policy config, missing bits_per_key";
|
|
|
|
}
|
|
|
|
int bits_per_key =
|
|
|
|
ParseInt(trim(value.substr(kName.size(), pos - kName.size())));
|
|
|
|
bool use_block_based_builder =
|
|
|
|
ParseBoolean("use_block_based_builder", trim(value.substr(pos + 1)));
|
|
|
|
new_options->filter_policy.reset(
|
|
|
|
NewBloomFilterPolicy(bits_per_key, use_block_based_builder));
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
const auto iter = block_based_table_type_info.find(name);
|
|
|
|
if (iter == block_based_table_type_info.end()) {
|
|
|
|
if (ignore_unknown_options) {
|
|
|
|
return "";
|
|
|
|
} else {
|
|
|
|
return "Unrecognized option";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
const auto& opt_info = iter->second;
|
|
|
|
if (opt_info.verification != OptionVerificationType::kDeprecated &&
|
|
|
|
!ParseOptionHelper(reinterpret_cast<char*>(new_options) + opt_info.offset,
|
|
|
|
opt_info.type, value)) {
|
|
|
|
return "Invalid value";
|
|
|
|
}
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
Status GetBlockBasedTableOptionsFromString(
|
|
|
|
const BlockBasedTableOptions& table_options, const std::string& opts_str,
|
|
|
|
BlockBasedTableOptions* new_table_options) {
|
|
|
|
std::unordered_map<std::string, std::string> opts_map;
|
|
|
|
Status s = StringToMap(opts_str, &opts_map);
|
|
|
|
if (!s.ok()) {
|
|
|
|
return s;
|
|
|
|
}
|
|
|
|
|
|
|
|
return GetBlockBasedTableOptionsFromMap(table_options, opts_map,
|
|
|
|
new_table_options);
|
|
|
|
}
|
|
|
|
|
|
|
|
Status GetBlockBasedTableOptionsFromMap(
|
|
|
|
const BlockBasedTableOptions& table_options,
|
|
|
|
const std::unordered_map<std::string, std::string>& opts_map,
|
|
|
|
BlockBasedTableOptions* new_table_options, bool input_strings_escaped,
|
|
|
|
bool ignore_unknown_options) {
|
|
|
|
assert(new_table_options);
|
|
|
|
*new_table_options = table_options;
|
|
|
|
for (const auto& o : opts_map) {
|
|
|
|
auto error_message = ParseBlockBasedTableOption(
|
|
|
|
o.first, o.second, new_table_options, input_strings_escaped,
|
|
|
|
ignore_unknown_options);
|
|
|
|
if (error_message != "") {
|
|
|
|
const auto iter = block_based_table_type_info.find(o.first);
|
|
|
|
if (iter == block_based_table_type_info.end() ||
|
|
|
|
!input_strings_escaped || // !input_strings_escaped indicates
|
|
|
|
// the old API, where everything is
|
|
|
|
// parsable.
|
|
|
|
(iter->second.verification != OptionVerificationType::kByName &&
|
|
|
|
iter->second.verification !=
|
|
|
|
OptionVerificationType::kByNameAllowNull &&
|
2017-10-04 16:44:18 +00:00
|
|
|
iter->second.verification !=
|
|
|
|
OptionVerificationType::kByNameAllowFromNull &&
|
2017-07-28 23:23:50 +00:00
|
|
|
iter->second.verification != OptionVerificationType::kDeprecated)) {
|
|
|
|
// Restore "new_options" to the default "base_options".
|
|
|
|
*new_table_options = table_options;
|
|
|
|
return Status::InvalidArgument("Can't parse BlockBasedTableOptions:",
|
|
|
|
o.first + " " + error_message);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
|
|
|
|
Status VerifyBlockBasedTableFactory(
|
|
|
|
const BlockBasedTableFactory* base_tf,
|
|
|
|
const BlockBasedTableFactory* file_tf,
|
|
|
|
OptionsSanityCheckLevel sanity_check_level) {
|
|
|
|
if ((base_tf != nullptr) != (file_tf != nullptr) &&
|
|
|
|
sanity_check_level > kSanityLevelNone) {
|
|
|
|
return Status::Corruption(
|
|
|
|
"[RocksDBOptionsParser]: Inconsistent TableFactory class type");
|
|
|
|
}
|
|
|
|
if (base_tf == nullptr) {
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
assert(file_tf != nullptr);
|
|
|
|
|
|
|
|
const auto& base_opt = base_tf->table_options();
|
|
|
|
const auto& file_opt = file_tf->table_options();
|
|
|
|
|
|
|
|
for (auto& pair : block_based_table_type_info) {
|
|
|
|
if (pair.second.verification == OptionVerificationType::kDeprecated) {
|
|
|
|
// We skip checking deprecated variables as they might
|
|
|
|
// contain random values since they might not be initialized
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
if (BBTOptionSanityCheckLevel(pair.first) <= sanity_check_level) {
|
|
|
|
if (!AreEqualOptions(reinterpret_cast<const char*>(&base_opt),
|
|
|
|
reinterpret_cast<const char*>(&file_opt),
|
|
|
|
pair.second, pair.first, nullptr)) {
|
|
|
|
return Status::Corruption(
|
|
|
|
"[RocksDBOptionsParser]: "
|
|
|
|
"failed the verification on BlockBasedTableOptions::",
|
|
|
|
pair.first);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Status::OK();
|
|
|
|
}
|
|
|
|
#endif // !ROCKSDB_LITE
|
|
|
|
|
2014-01-28 05:58:46 +00:00
|
|
|
TableFactory* NewBlockBasedTableFactory(
|
2015-11-18 00:41:54 +00:00
|
|
|
const BlockBasedTableOptions& _table_options) {
|
|
|
|
return new BlockBasedTableFactory(_table_options);
|
2014-01-28 05:58:46 +00:00
|
|
|
}
|
|
|
|
|
2017-07-28 23:23:50 +00:00
|
|
|
const std::string BlockBasedTableFactory::kName = "BlockBasedTable";
|
2014-03-01 02:19:07 +00:00
|
|
|
const std::string BlockBasedTablePropertyNames::kIndexType =
|
|
|
|
"rocksdb.block.based.table.index.type";
|
2015-02-05 01:03:57 +00:00
|
|
|
const std::string BlockBasedTablePropertyNames::kWholeKeyFiltering =
|
|
|
|
"rocksdb.block.based.table.whole.key.filtering";
|
|
|
|
const std::string BlockBasedTablePropertyNames::kPrefixFiltering =
|
|
|
|
"rocksdb.block.based.table.prefix.filtering";
|
2014-05-15 21:09:03 +00:00
|
|
|
const std::string kHashIndexPrefixesBlock = "rocksdb.hashindex.prefixes";
|
|
|
|
const std::string kHashIndexPrefixesMetadataBlock =
|
|
|
|
"rocksdb.hashindex.metadata";
|
2015-02-05 01:03:57 +00:00
|
|
|
const std::string kPropTrue = "1";
|
|
|
|
const std::string kPropFalse = "0";
|
2014-03-01 02:19:07 +00:00
|
|
|
|
2013-10-29 00:54:09 +00:00
|
|
|
} // namespace rocksdb
|