2016-09-24 01:34:04 +02:00
|
|
|
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
2017-07-16 01:03:42 +02: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).
|
2016-09-24 01:34:04 +02:00
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
#include <string>
|
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
|
|
#include "rocksdb/options.h"
|
|
|
|
|
|
2020-02-20 21:07:53 +01:00
|
|
|
namespace ROCKSDB_NAMESPACE {
|
2016-09-24 01:34:04 +02:00
|
|
|
|
|
|
|
|
struct ImmutableDBOptions {
|
|
|
|
|
ImmutableDBOptions();
|
|
|
|
|
explicit ImmutableDBOptions(const DBOptions& options);
|
|
|
|
|
|
|
|
|
|
void Dump(Logger* log) const;
|
|
|
|
|
|
|
|
|
|
bool create_if_missing;
|
|
|
|
|
bool create_missing_column_families;
|
|
|
|
|
bool error_if_exists;
|
|
|
|
|
bool paranoid_checks;
|
|
|
|
|
Env* env;
|
Introduce a new storage specific Env API (#5761)
Summary:
The current Env API encompasses both storage/file operations, as well as OS related operations. Most of the APIs return a Status, which does not have enough metadata about an error, such as whether its retry-able or not, scope (i.e fault domain) of the error etc., that may be required in order to properly handle a storage error. The file APIs also do not provide enough control over the IO SLA, such as timeout, prioritization, hinting about placement and redundancy etc.
This PR separates out the file/storage APIs from Env into a new FileSystem class. The APIs are updated to return an IOStatus with metadata about the error, as well as to take an IOOptions structure as input in order to allow more control over the IO.
The user can set both ```options.env``` and ```options.file_system``` to specify that RocksDB should use the former for OS related operations and the latter for storage operations. Internally, a ```CompositeEnvWrapper``` has been introduced that inherits from ```Env``` and redirects individual methods to either an ```Env``` implementation or the ```FileSystem``` as appropriate. When options are sanitized during ```DB::Open```, ```options.env``` is replaced with a newly allocated ```CompositeEnvWrapper``` instance if both env and file_system have been specified. This way, the rest of the RocksDB code can continue to function as before.
This PR also ports PosixEnv to the new API by splitting it into two - PosixEnv and PosixFileSystem. PosixEnv is defined as a sub-class of CompositeEnvWrapper, and threading/time functions are overridden with Posix specific implementations in order to avoid an extra level of indirection.
The ```CompositeEnvWrapper``` translates ```IOStatus``` return code to ```Status```, and sets the severity to ```kSoftError``` if the io_status is retryable. The error handling code in RocksDB can then recover the DB automatically.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5761
Differential Revision: D18868376
Pulled By: anand1976
fbshipit-source-id: 39efe18a162ea746fabac6360ff529baba48486f
2019-12-13 23:47:08 +01:00
|
|
|
std::shared_ptr<FileSystem> fs;
|
2016-09-24 01:34:04 +02:00
|
|
|
std::shared_ptr<RateLimiter> rate_limiter;
|
|
|
|
|
std::shared_ptr<SstFileManager> sst_file_manager;
|
|
|
|
|
std::shared_ptr<Logger> info_log;
|
|
|
|
|
InfoLogLevel info_log_level;
|
|
|
|
|
int max_file_opening_threads;
|
|
|
|
|
std::shared_ptr<Statistics> statistics;
|
|
|
|
|
bool use_fsync;
|
|
|
|
|
std::vector<DbPath> db_paths;
|
|
|
|
|
std::string db_log_dir;
|
|
|
|
|
std::string wal_dir;
|
|
|
|
|
uint32_t max_subcompactions;
|
|
|
|
|
int max_background_flushes;
|
|
|
|
|
size_t max_log_file_size;
|
|
|
|
|
size_t log_file_time_to_roll;
|
|
|
|
|
size_t keep_log_file_num;
|
|
|
|
|
size_t recycle_log_file_num;
|
|
|
|
|
uint64_t max_manifest_file_size;
|
|
|
|
|
int table_cache_numshardbits;
|
|
|
|
|
uint64_t wal_ttl_seconds;
|
|
|
|
|
uint64_t wal_size_limit_mb;
|
2019-09-12 03:26:22 +02:00
|
|
|
uint64_t max_write_batch_group_size_bytes;
|
2016-09-24 01:34:04 +02:00
|
|
|
size_t manifest_preallocation_size;
|
|
|
|
|
bool allow_mmap_reads;
|
|
|
|
|
bool allow_mmap_writes;
|
2016-10-28 19:36:05 +02:00
|
|
|
bool use_direct_reads;
|
2017-04-13 22:07:33 +02:00
|
|
|
bool use_direct_io_for_flush_and_compaction;
|
2016-09-24 01:34:04 +02:00
|
|
|
bool allow_fallocate;
|
|
|
|
|
bool is_fd_close_on_exec;
|
|
|
|
|
bool advise_random_on_open;
|
|
|
|
|
size_t db_write_buffer_size;
|
|
|
|
|
std::shared_ptr<WriteBufferManager> write_buffer_manager;
|
|
|
|
|
DBOptions::AccessHint access_hint_on_compaction_start;
|
|
|
|
|
bool new_table_reader_for_compaction_inputs;
|
|
|
|
|
size_t random_access_max_buffer_size;
|
|
|
|
|
bool use_adaptive_mutex;
|
|
|
|
|
std::vector<std::shared_ptr<EventListener>> listeners;
|
|
|
|
|
bool enable_thread_tracking;
|
2017-05-19 23:24:23 +02:00
|
|
|
bool enable_pipelined_write;
|
2019-05-14 02:43:47 +02:00
|
|
|
bool unordered_write;
|
2016-09-24 01:34:04 +02:00
|
|
|
bool allow_concurrent_memtable_write;
|
|
|
|
|
bool enable_write_thread_adaptive_yield;
|
|
|
|
|
uint64_t write_thread_max_yield_usec;
|
|
|
|
|
uint64_t write_thread_slow_yield_usec;
|
|
|
|
|
bool skip_stats_update_on_db_open;
|
Add an option to prevent DB::Open() from querying sizes of all sst files (#6353)
Summary:
When paranoid_checks is on, DBImpl::CheckConsistency() iterates over all sst files and calls Env::GetFileSize() for each of them. As far as I could understand, this is pretty arbitrary and doesn't affect correctness - if filesystem doesn't corrupt fsynced files, the file sizes will always match; if it does, it may as well corrupt contents as well as sizes, and rocksdb doesn't check contents on open.
If there are thousands of sst files, getting all their sizes takes a while. If, on top of that, Env is overridden to use some remote storage instead of local filesystem, it can be *really* slow and overload the remote storage service. This PR adds an option to not do GetFileSize(); instead it does GetChildren() for parent directory to check that all the expected sst files are at least present, but doesn't check their sizes.
We can't just disable paranoid_checks instead because paranoid_checks do a few other important things: make the DB read-only on write errors, print error messages on read errors, etc.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/6353
Test Plan: ran the added sanity check unit test. Will try it out in a LogDevice test cluster where the GetFileSize() calls are causing a lot of trouble.
Differential Revision: D19656425
Pulled By: al13n321
fbshipit-source-id: c2c421b367633033760d1f56747bad206d1fbf82
2020-02-04 10:24:29 +01:00
|
|
|
bool skip_checking_sst_file_sizes_on_db_open;
|
2016-09-24 01:34:04 +02:00
|
|
|
WALRecoveryMode wal_recovery_mode;
|
|
|
|
|
bool allow_2pc;
|
|
|
|
|
std::shared_ptr<Cache> row_cache;
|
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
|
WalFilter* wal_filter;
|
|
|
|
|
#endif // ROCKSDB_LITE
|
|
|
|
|
bool fail_if_options_file_error;
|
|
|
|
|
bool dump_malloc_stats;
|
|
|
|
|
bool avoid_flush_during_recovery;
|
2017-05-17 20:32:26 +02:00
|
|
|
bool allow_ingest_behind;
|
Added support for differential snapshots
Summary:
The motivation for this PR is to add to RocksDB support for differential (incremental) snapshots, as snapshot of the DB changes between two points in time (one can think of it as diff between to sequence numbers, or the diff D which can be thought of as an SST file or just set of KVs that can be applied to sequence number S1 to get the database to the state at sequence number S2).
This feature would be useful for various distributed storages layers built on top of RocksDB, as it should help reduce resources (time and network bandwidth) needed to recover and rebuilt DB instances as replicas in the context of distributed storages.
From the API standpoint that would like client app requesting iterator between (start seqnum) and current DB state, and reading the "diff".
This is a very draft PR for initial review in the discussion on the approach, i'm going to rework some parts and keep updating the PR.
For now, what's done here according to initial discussions:
Preserving deletes:
- We want to be able to optionally preserve recent deletes for some defined period of time, so that if a delete came in recently and might need to be included in the next incremental snapshot it would't get dropped by a compaction. This is done by adding new param to Options (preserve deletes flag) and new variable to DB Impl where we keep track of the sequence number after which we don't want to drop tombstones, even if they are otherwise eligible for deletion.
- I also added a new API call for clients to be able to advance this cutoff seqnum after which we drop deletes; i assume it's more flexible to let clients control this, since otherwise we'd need to keep some kind of timestamp < -- > seqnum mapping inside the DB, which sounds messy and painful to support. Clients could make use of it by periodically calling GetLatestSequenceNumber(), noting the timestamp, doing some calculation and figuring out by how much we need to advance the cutoff seqnum.
- Compaction codepath in compaction_iterator.cc has been modified to avoid dropping tombstones with seqnum > cutoff seqnum.
Iterator changes:
- couple params added to ReadOptions, to optionally allow client to request internal keys instead of user keys (so that client can get the latest value of a key, be it delete marker or a put), as well as min timestamp and min seqnum.
TableCache changes:
- I modified table_cache code to be able to quickly exclude SST files from iterators heep if creation_time on the file is less then iter_start_ts as passed in ReadOptions. That would help a lot in some DB settings (like reading very recent data only or using FIFO compactions), but not so much for universal compaction with more or less long iterator time span.
What's left:
- Still looking at how to best plug that inside DBIter codepath. So far it seems that FindNextUserKeyInternal only parses values as UserKeys, and iter->key() call generally returns user key. Can we add new API to DBIter as internal_key(), and modify this internal method to optionally set saved_key_ to point to the full internal key? I don't need to store actual seqnum there, but I do need to store type.
Closes https://github.com/facebook/rocksdb/pull/2999
Differential Revision: D6175602
Pulled By: mikhail-antonov
fbshipit-source-id: c779a6696ee2d574d86c69cec866a3ae095aa900
2017-11-02 02:43:29 +01:00
|
|
|
bool preserve_deletes;
|
2017-11-11 02:18:01 +01:00
|
|
|
bool two_write_queues;
|
2017-06-24 23:06:43 +02:00
|
|
|
bool manual_wal_flush;
|
2018-10-27 00:06:44 +02:00
|
|
|
bool atomic_flush;
|
2019-04-02 02:07:38 +02:00
|
|
|
bool avoid_unnecessary_blocking_io;
|
2019-06-18 00:17:43 +02:00
|
|
|
bool persist_stats_to_disk;
|
2019-09-03 17:50:47 +02:00
|
|
|
bool write_dbid_to_manifest;
|
2019-07-19 20:54:38 +02:00
|
|
|
size_t log_readahead_size;
|
2020-03-30 00:57:02 +02:00
|
|
|
std::shared_ptr<FileChecksumGenFactory> file_checksum_gen_factory;
|
2020-03-21 03:17:54 +01:00
|
|
|
bool best_efforts_recovery;
|
2016-09-24 01:34:04 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct MutableDBOptions {
|
2016-10-14 21:25:39 +02:00
|
|
|
MutableDBOptions();
|
2016-09-24 01:34:04 +02:00
|
|
|
explicit MutableDBOptions(const MutableDBOptions& options) = default;
|
|
|
|
|
explicit MutableDBOptions(const DBOptions& options);
|
|
|
|
|
|
|
|
|
|
void Dump(Logger* log) const;
|
2016-10-14 21:25:39 +02:00
|
|
|
|
2017-05-24 20:25:38 +02:00
|
|
|
int max_background_jobs;
|
2016-10-14 21:25:39 +02:00
|
|
|
int base_background_compactions;
|
|
|
|
|
int max_background_compactions;
|
2016-11-02 23:22:13 +01:00
|
|
|
bool avoid_flush_during_shutdown;
|
2017-10-31 21:49:25 +01:00
|
|
|
size_t writable_file_max_buffer_size;
|
2016-11-13 00:43:33 +01:00
|
|
|
uint64_t delayed_write_rate;
|
2016-11-15 07:45:16 +01:00
|
|
|
uint64_t max_total_wal_size;
|
2016-12-05 23:09:35 +01:00
|
|
|
uint64_t delete_obsolete_files_period_micros;
|
2017-03-21 06:50:56 +01:00
|
|
|
unsigned int stats_dump_period_sec;
|
2019-02-21 00:46:59 +01:00
|
|
|
unsigned int stats_persist_period_sec;
|
|
|
|
|
size_t stats_history_buffer_size;
|
2017-05-04 05:46:17 +02:00
|
|
|
int max_open_files;
|
2017-09-28 02:37:08 +02:00
|
|
|
uint64_t bytes_per_sync;
|
|
|
|
|
uint64_t wal_bytes_per_sync;
|
Optionally wait on bytes_per_sync to smooth I/O (#5183)
Summary:
The existing implementation does not guarantee bytes reach disk every `bytes_per_sync` when writing SST files, or every `wal_bytes_per_sync` when writing WALs. This can cause confusing behavior for users who enable this feature to avoid large syncs during flush and compaction, but then end up hitting them anyways.
My understanding of the existing behavior is we used `sync_file_range` with `SYNC_FILE_RANGE_WRITE` to submit ranges for async writeback, such that we could continue processing the next range of bytes while that I/O is happening. I believe we can preserve that benefit while also limiting how far the processing can get ahead of the I/O, which prevents huge syncs from happening when the file finishes.
Consider this `sync_file_range` usage: `sync_file_range(fd_, 0, static_cast<off_t>(offset + nbytes), SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE)`. Expanding the range to start at 0 and adding the `SYNC_FILE_RANGE_WAIT_BEFORE` flag causes any pending writeback (like from a previous call to `sync_file_range`) to finish before it proceeds to submit the latest `nbytes` for writeback. The latest `nbytes` are still written back asynchronously, unless processing exceeds I/O speed, in which case the following `sync_file_range` will need to wait on it.
There is a second change in this PR to use `fdatasync` when `sync_file_range` is unavailable (determined statically) or has some known problem with the underlying filesystem (determined dynamically).
The above two changes only apply when the user enables a new option, `strict_bytes_per_sync`.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5183
Differential Revision: D14953553
Pulled By: siying
fbshipit-source-id: 445c3862e019fb7b470f9c7f314fc231b62706e9
2019-04-22 20:48:45 +02:00
|
|
|
bool strict_bytes_per_sync;
|
2017-11-17 02:46:43 +01:00
|
|
|
size_t compaction_readahead_size;
|
2016-09-24 01:34:04 +02:00
|
|
|
};
|
|
|
|
|
|
2020-02-20 21:07:53 +01:00
|
|
|
} // namespace ROCKSDB_NAMESPACE
|
