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 22:47:08 +00:00
|
|
|
// Copyright (c) 2019-present, Facebook, Inc. All rights reserved.
|
|
|
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
|
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
|
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
|
|
|
//
|
|
|
|
|
#include "rocksdb/file_system.h"
|
2021-06-15 10:42:52 +00:00
|
|
|
|
|
|
|
|
#include "env/composite_env_wrapper.h"
|
2021-11-02 16:06:02 +00:00
|
|
|
#include "env/env_chroot.h"
|
|
|
|
|
#include "env/env_encryption_ctr.h"
|
|
|
|
|
#include "env/fs_readonly.h"
|
|
|
|
|
#include "env/mock_env.h"
|
2022-08-01 21:37:18 +00:00
|
|
|
#include "logging/env_logger.h"
|
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 22:47:08 +00:00
|
|
|
#include "options/db_options.h"
|
2021-06-15 10:42:52 +00:00
|
|
|
#include "rocksdb/convenience.h"
|
2021-11-02 16:06:02 +00:00
|
|
|
#include "rocksdb/utilities/customizable_util.h"
|
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 22:47:08 +00:00
|
|
|
#include "rocksdb/utilities/object_registry.h"
|
2021-11-02 16:06:02 +00:00
|
|
|
#include "rocksdb/utilities/options_type.h"
|
|
|
|
|
#include "util/string_util.h"
|
2022-02-03 23:00:03 +00:00
|
|
|
#include "utilities/counted_fs.h"
|
2021-11-02 16:06:02 +00:00
|
|
|
#include "utilities/env_timed.h"
|
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 22:47:08 +00:00
|
|
|
|
2020-02-20 20:07:53 +00:00
|
|
|
namespace ROCKSDB_NAMESPACE {
|
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 22:47:08 +00:00
|
|
|
|
2023-12-04 19:17:32 +00:00
|
|
|
FileSystem::FileSystem() = default;
|
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 22:47:08 +00:00
|
|
|
|
2023-12-04 19:17:32 +00:00
|
|
|
FileSystem::~FileSystem() = default;
|
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 22:47:08 +00:00
|
|
|
|
2021-11-02 16:06:02 +00:00
|
|
|
static int RegisterBuiltinFileSystems(ObjectLibrary& library,
|
|
|
|
|
const std::string& /*arg*/) {
|
2022-01-11 14:32:42 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
2021-11-02 16:06:02 +00:00
|
|
|
TimedFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* /* errmsg */) {
|
|
|
|
|
guard->reset(new TimedFileSystem(nullptr));
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
2022-01-11 14:32:42 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
2021-11-02 16:06:02 +00:00
|
|
|
ReadOnlyFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* /* errmsg */) {
|
|
|
|
|
guard->reset(new ReadOnlyFileSystem(nullptr));
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
2022-01-11 14:32:42 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
2021-11-02 16:06:02 +00:00
|
|
|
EncryptedFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* errmsg) {
|
|
|
|
|
Status s = NewEncryptedFileSystemImpl(nullptr, nullptr, guard);
|
|
|
|
|
if (!s.ok()) {
|
|
|
|
|
*errmsg = s.ToString();
|
|
|
|
|
}
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
2022-02-03 23:00:03 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
|
|
|
|
CountedFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* /*errmsg*/) {
|
|
|
|
|
guard->reset(new CountedFileSystem(FileSystem::Default()));
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
2022-01-11 14:32:42 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
2022-01-05 00:44:54 +00:00
|
|
|
MockFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* /*errmsg*/) {
|
|
|
|
|
guard->reset(new MockFileSystem(SystemClock::Default()));
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
2021-11-02 16:06:02 +00:00
|
|
|
#ifndef OS_WIN
|
2022-01-11 14:32:42 +00:00
|
|
|
library.AddFactory<FileSystem>(
|
2021-11-02 16:06:02 +00:00
|
|
|
ChrootFileSystem::kClassName(),
|
|
|
|
|
[](const std::string& /*uri*/, std::unique_ptr<FileSystem>* guard,
|
|
|
|
|
std::string* /* errmsg */) {
|
|
|
|
|
guard->reset(new ChrootFileSystem(nullptr, ""));
|
|
|
|
|
return guard->get();
|
|
|
|
|
});
|
|
|
|
|
#endif // OS_WIN
|
|
|
|
|
size_t num_types;
|
|
|
|
|
return static_cast<int>(library.GetFactoryCount(&num_types));
|
|
|
|
|
}
|
|
|
|
|
|
2021-06-15 10:42:52 +00:00
|
|
|
Status FileSystem::CreateFromString(const ConfigOptions& config_options,
|
|
|
|
|
const std::string& value,
|
|
|
|
|
std::shared_ptr<FileSystem>* result) {
|
2021-11-02 16:06:02 +00:00
|
|
|
auto default_fs = FileSystem::Default();
|
|
|
|
|
if (default_fs->IsInstanceOf(value)) {
|
|
|
|
|
*result = default_fs;
|
|
|
|
|
return Status::OK();
|
|
|
|
|
} else {
|
|
|
|
|
static std::once_flag once;
|
|
|
|
|
std::call_once(once, [&]() {
|
|
|
|
|
RegisterBuiltinFileSystems(*(ObjectLibrary::Default().get()), "");
|
|
|
|
|
});
|
2023-02-17 20:54:07 +00:00
|
|
|
return LoadSharedObject<FileSystem>(config_options, value, result);
|
2021-11-02 16:06:02 +00:00
|
|
|
}
|
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 22:47:08 +00:00
|
|
|
}
|
|
|
|
|
|
2020-03-24 04:50:42 +00:00
|
|
|
IOStatus FileSystem::ReuseWritableFile(const std::string& fname,
|
|
|
|
|
const std::string& old_fname,
|
|
|
|
|
const FileOptions& opts,
|
|
|
|
|
std::unique_ptr<FSWritableFile>* result,
|
|
|
|
|
IODebugContext* dbg) {
|
|
|
|
|
IOStatus s = RenameFile(old_fname, fname, opts.io_options, dbg);
|
|
|
|
|
if (!s.ok()) {
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
return NewWritableFile(fname, opts, result, dbg);
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-01 21:37:18 +00:00
|
|
|
IOStatus FileSystem::NewLogger(const std::string& fname,
|
|
|
|
|
const IOOptions& io_opts,
|
|
|
|
|
std::shared_ptr<Logger>* result,
|
|
|
|
|
IODebugContext* dbg) {
|
|
|
|
|
FileOptions options;
|
|
|
|
|
options.io_options = io_opts;
|
|
|
|
|
// TODO: Tune the buffer size.
|
|
|
|
|
options.writable_file_max_buffer_size = 1024 * 1024;
|
|
|
|
|
std::unique_ptr<FSWritableFile> writable_file;
|
|
|
|
|
const IOStatus status = NewWritableFile(fname, options, &writable_file, dbg);
|
|
|
|
|
if (!status.ok()) {
|
|
|
|
|
return status;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
*result = std::make_shared<EnvLogger>(std::move(writable_file), fname,
|
|
|
|
|
options, Env::Default());
|
|
|
|
|
return IOStatus::OK();
|
|
|
|
|
}
|
|
|
|
|
|
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 22:47:08 +00:00
|
|
|
FileOptions FileSystem::OptimizeForLogRead(
|
2022-10-25 00:54:14 +00:00
|
|
|
const FileOptions& file_options) const {
|
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 22:47:08 +00:00
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.use_direct_reads = false;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOptions FileSystem::OptimizeForManifestRead(
|
|
|
|
|
const FileOptions& file_options) const {
|
|
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.use_direct_reads = false;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOptions FileSystem::OptimizeForLogWrite(const FileOptions& file_options,
|
2022-10-25 00:54:14 +00:00
|
|
|
const DBOptions& db_options) const {
|
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 22:47:08 +00:00
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.bytes_per_sync = db_options.wal_bytes_per_sync;
|
|
|
|
|
optimized_file_options.writable_file_max_buffer_size =
|
|
|
|
|
db_options.writable_file_max_buffer_size;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOptions FileSystem::OptimizeForManifestWrite(
|
|
|
|
|
const FileOptions& file_options) const {
|
|
|
|
|
return file_options;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOptions FileSystem::OptimizeForCompactionTableWrite(
|
|
|
|
|
const FileOptions& file_options,
|
|
|
|
|
const ImmutableDBOptions& db_options) const {
|
|
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.use_direct_writes =
|
|
|
|
|
db_options.use_direct_io_for_flush_and_compaction;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOptions FileSystem::OptimizeForCompactionTableRead(
|
|
|
|
|
const FileOptions& file_options,
|
|
|
|
|
const ImmutableDBOptions& db_options) const {
|
|
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.use_direct_reads = db_options.use_direct_reads;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
2021-04-07 20:37:36 +00:00
|
|
|
FileOptions FileSystem::OptimizeForBlobFileRead(
|
|
|
|
|
const FileOptions& file_options,
|
|
|
|
|
const ImmutableDBOptions& db_options) const {
|
|
|
|
|
FileOptions optimized_file_options(file_options);
|
|
|
|
|
optimized_file_options.use_direct_reads = db_options.use_direct_reads;
|
|
|
|
|
return optimized_file_options;
|
|
|
|
|
}
|
|
|
|
|
|
Pass IOStatus to write path and set retryable IO Error as hard error in BG jobs (#6487)
Summary:
In the current code base, we use Status to get and store the returned status from the call. Specifically, for IO related functions, the current Status cannot reflect the IO Error details such as error scope, error retryable attribute, and others. With the implementation of https://github.com/facebook/rocksdb/issues/5761, we have the new Wrapper for IO, which returns IOStatus instead of Status. However, the IOStatus is purged at the lower level of write path and transferred to Status.
The first job of this PR is to pass the IOStatus to the write path (flush, WAL write, and Compaction). The second job is to identify the Retryable IO Error as HardError, and set the bg_error_ as HardError. In this case, the DB Instance becomes read only. User is informed of the Status and need to take actions to deal with it (e.g., call db->Resume()).
Pull Request resolved: https://github.com/facebook/rocksdb/pull/6487
Test Plan: Added the testing case to error_handler_fs_test. Pass make asan_check
Reviewed By: anand1976
Differential Revision: D20685017
Pulled By: zhichao-cao
fbshipit-source-id: ff85f042896243abcd6ef37877834e26f36b6eb0
2020-03-27 23:03:05 +00:00
|
|
|
IOStatus WriteStringToFile(FileSystem* fs, const Slice& data,
|
|
|
|
|
const std::string& fname, bool should_sync) {
|
|
|
|
|
std::unique_ptr<FSWritableFile> file;
|
|
|
|
|
EnvOptions soptions;
|
|
|
|
|
IOStatus s = fs->NewWritableFile(fname, soptions, &file, nullptr);
|
|
|
|
|
if (!s.ok()) {
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
s = file->Append(data, IOOptions(), nullptr);
|
|
|
|
|
if (s.ok() && should_sync) {
|
|
|
|
|
s = file->Sync(IOOptions(), nullptr);
|
|
|
|
|
}
|
|
|
|
|
if (!s.ok()) {
|
|
|
|
|
fs->DeleteFile(fname, IOOptions(), nullptr);
|
|
|
|
|
}
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
IOStatus ReadFileToString(FileSystem* fs, const std::string& fname,
|
|
|
|
|
std::string* data) {
|
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 22:47:08 +00:00
|
|
|
FileOptions soptions;
|
|
|
|
|
data->clear();
|
|
|
|
|
std::unique_ptr<FSSequentialFile> file;
|
Pass IOStatus to write path and set retryable IO Error as hard error in BG jobs (#6487)
Summary:
In the current code base, we use Status to get and store the returned status from the call. Specifically, for IO related functions, the current Status cannot reflect the IO Error details such as error scope, error retryable attribute, and others. With the implementation of https://github.com/facebook/rocksdb/issues/5761, we have the new Wrapper for IO, which returns IOStatus instead of Status. However, the IOStatus is purged at the lower level of write path and transferred to Status.
The first job of this PR is to pass the IOStatus to the write path (flush, WAL write, and Compaction). The second job is to identify the Retryable IO Error as HardError, and set the bg_error_ as HardError. In this case, the DB Instance becomes read only. User is informed of the Status and need to take actions to deal with it (e.g., call db->Resume()).
Pull Request resolved: https://github.com/facebook/rocksdb/pull/6487
Test Plan: Added the testing case to error_handler_fs_test. Pass make asan_check
Reviewed By: anand1976
Differential Revision: D20685017
Pulled By: zhichao-cao
fbshipit-source-id: ff85f042896243abcd6ef37877834e26f36b6eb0
2020-03-27 23:03:05 +00:00
|
|
|
IOStatus s = status_to_io_status(
|
|
|
|
|
fs->NewSequentialFile(fname, soptions, &file, nullptr));
|
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 22:47:08 +00:00
|
|
|
if (!s.ok()) {
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
static const int kBufferSize = 8192;
|
|
|
|
|
char* space = new char[kBufferSize];
|
|
|
|
|
while (true) {
|
|
|
|
|
Slice fragment;
|
2022-10-25 00:54:14 +00:00
|
|
|
s = file->Read(kBufferSize, IOOptions(), &fragment, space, nullptr);
|
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 22:47:08 +00:00
|
|
|
if (!s.ok()) {
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
data->append(fragment.data(), fragment.size());
|
|
|
|
|
if (fragment.empty()) {
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
delete[] space;
|
|
|
|
|
return s;
|
|
|
|
|
}
|
|
|
|
|
|
2021-11-02 16:06:02 +00:00
|
|
|
namespace {
|
|
|
|
|
static std::unordered_map<std::string, OptionTypeInfo> fs_wrapper_type_info = {
|
|
|
|
|
{"target",
|
|
|
|
|
OptionTypeInfo::AsCustomSharedPtr<FileSystem>(
|
|
|
|
|
0, OptionVerificationType::kByName, OptionTypeFlags::kDontSerialize)},
|
|
|
|
|
};
|
|
|
|
|
} // namespace
|
|
|
|
|
FileSystemWrapper::FileSystemWrapper(const std::shared_ptr<FileSystem>& t)
|
|
|
|
|
: target_(t) {
|
|
|
|
|
RegisterOptions("", &target_, &fs_wrapper_type_info);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Status FileSystemWrapper::PrepareOptions(const ConfigOptions& options) {
|
|
|
|
|
if (target_ == nullptr) {
|
|
|
|
|
target_ = FileSystem::Default();
|
|
|
|
|
}
|
|
|
|
|
return FileSystem::PrepareOptions(options);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
std::string FileSystemWrapper::SerializeOptions(
|
|
|
|
|
const ConfigOptions& config_options, const std::string& header) const {
|
|
|
|
|
auto parent = FileSystem::SerializeOptions(config_options, "");
|
|
|
|
|
if (config_options.IsShallow() || target_ == nullptr ||
|
|
|
|
|
target_->IsInstanceOf(FileSystem::kDefaultName())) {
|
|
|
|
|
return parent;
|
|
|
|
|
} else {
|
|
|
|
|
std::string result = header;
|
|
|
|
|
if (!StartsWith(parent, OptionTypeInfo::kIdPropName())) {
|
|
|
|
|
result.append(OptionTypeInfo::kIdPropName()).append("=");
|
|
|
|
|
}
|
|
|
|
|
result.append(parent);
|
|
|
|
|
if (!EndsWith(result, config_options.delimiter)) {
|
|
|
|
|
result.append(config_options.delimiter);
|
|
|
|
|
}
|
|
|
|
|
result.append("target=").append(target_->ToString(config_options));
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
}
|
2021-11-03 19:20:19 +00:00
|
|
|
|
|
|
|
|
DirFsyncOptions::DirFsyncOptions() { reason = kDefault; }
|
|
|
|
|
|
|
|
|
|
DirFsyncOptions::DirFsyncOptions(std::string file_renamed_new_name) {
|
|
|
|
|
reason = kFileRenamed;
|
|
|
|
|
renamed_new_name = file_renamed_new_name;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
DirFsyncOptions::DirFsyncOptions(FsyncReason fsync_reason) {
|
|
|
|
|
assert(fsync_reason != kFileRenamed);
|
|
|
|
|
reason = fsync_reason;
|
|
|
|
|
}
|
2020-02-20 20:07:53 +00:00
|
|
|
} // namespace ROCKSDB_NAMESPACE
|