a27fce408e
Summary: This commit implements automatic recovery from a Status::NoSpace() error during background operations such as write callback, flush and compaction. The broad design is as follows - 1. Compaction errors are treated as soft errors and don't put the database in read-only mode. A compaction is delayed until enough free disk space is available to accomodate the compaction outputs, which is estimated based on the input size. This means that users can continue to write, and we rely on the WriteController to delay or stop writes if the compaction debt becomes too high due to persistent low disk space condition 2. Errors during write callback and flush are treated as hard errors, i.e the database is put in read-only mode and goes back to read-write only fater certain recovery actions are taken. 3. Both types of recovery rely on the SstFileManagerImpl to poll for sufficient disk space. We assume that there is a 1-1 mapping between an SFM and the underlying OS storage container. For cases where multiple DBs are hosted on a single storage container, the user is expected to allocate a single SFM instance and use the same one for all the DBs. If no SFM is specified by the user, DBImpl::Open() will allocate one, but this will be one per DB and each DB will recover independently. The recovery implemented by SFM is as follows - a) On the first occurance of an out of space error during compaction, subsequent compactions will be delayed until the disk free space check indicates enough available space. The required space is computed as the sum of input sizes. b) The free space check requirement will be removed once the amount of free space is greater than the size reserved by in progress compactions when the first error occured c) If the out of space error is a hard error, a background thread in SFM will poll for sufficient headroom before triggering the recovery of the database and putting it in write-only mode. The headroom is calculated as the sum of the write_buffer_size of all the DB instances associated with the SFM 4. EventListener callbacks will be called at the start and completion of automatic recovery. Users can disable the auto recov ery in the start callback, and later initiate it manually by calling DB::Resume() Todo: 1. More extensive testing 2. Add disk full condition to db_stress (follow-on PR) Pull Request resolved: https://github.com/facebook/rocksdb/pull/4164 Differential Revision: D9846378 Pulled By: anand1976 fbshipit-source-id: 80ea875dbd7f00205e19c82215ff6e37da10da4a
56 lines
2.2 KiB
C++
56 lines
2.2 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "db/column_family.h"
|
|
#include "db/version_edit.h"
|
|
#include "rocksdb/listener.h"
|
|
#include "rocksdb/table_properties.h"
|
|
#include "util/event_logger.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
class EventHelpers {
|
|
public:
|
|
static void AppendCurrentTime(JSONWriter* json_writer);
|
|
#ifndef ROCKSDB_LITE
|
|
static void NotifyTableFileCreationStarted(
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners,
|
|
const std::string& db_name, const std::string& cf_name,
|
|
const std::string& file_path, int job_id, TableFileCreationReason reason);
|
|
#endif // !ROCKSDB_LITE
|
|
static void NotifyOnBackgroundError(
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners,
|
|
BackgroundErrorReason reason, Status* bg_error,
|
|
InstrumentedMutex* db_mutex, bool* auto_recovery);
|
|
static void LogAndNotifyTableFileCreationFinished(
|
|
EventLogger* event_logger,
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners,
|
|
const std::string& db_name, const std::string& cf_name,
|
|
const std::string& file_path, int job_id, const FileDescriptor& fd,
|
|
const TableProperties& table_properties, TableFileCreationReason reason,
|
|
const Status& s);
|
|
static void LogAndNotifyTableFileDeletion(
|
|
EventLogger* event_logger, int job_id,
|
|
uint64_t file_number, const std::string& file_path,
|
|
const Status& status, const std::string& db_name,
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners);
|
|
static void NotifyOnErrorRecoveryCompleted(
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners,
|
|
Status bg_error, InstrumentedMutex* db_mutex);
|
|
|
|
private:
|
|
static void LogAndNotifyTableFileCreation(
|
|
EventLogger* event_logger,
|
|
const std::vector<std::shared_ptr<EventListener>>& listeners,
|
|
const FileDescriptor& fd, const TableFileCreationInfo& info);
|
|
};
|
|
|
|
} // namespace rocksdb
|