cff0d1e8e6
Summary: The primary goal of this change is to add support for backing up and restoring (applying on restore) file temperature metadata, without committing to either the DB manifest or the FS reported "current" temperatures being exclusive "source of truth". To achieve this goal, we need to add temperature information to backup metadata, which requires updated backup meta schema. Fortunately I prepared for this in https://github.com/facebook/rocksdb/issues/8069, which began forward compatibility in version 6.19.0 for this kind of schema update. (Previously, backup meta schema was not extensible! Making this schema update public will allow some other "nice to have" features like taking backups with hard links, and avoiding crc32c checksum computation when another checksum is already available.) While schema version 2 is newly public, the default schema version is still 1. Until we change the default, users will need to set to 2 to enable features like temperature data backup+restore. New metadata like temperature information will be ignored with a warning in versions before this change and since 6.19.0. The metadata is considered ignorable because a functioning DB can be restored without it. Some detail: * Some renaming because "future schema" is now just public schema 2. * Initialize some atomics in TestFs (linter reported) * Add temperature hint support to SstFileDumper (used by BackupEngine) Pull Request resolved: https://github.com/facebook/rocksdb/pull/9660 Test Plan: related unit test majorly updated for the new functionality, including some shared testing support for tracking temperatures in a FS. Some other tests and testing hooks into production code also updated for making the backup meta schema change public. Reviewed By: ajkr Differential Revision: D34686968 Pulled By: pdillinger fbshipit-source-id: 3ac1fa3e67ee97ca8a5103d79cc87d872c1d862a
102 lines
3.7 KiB
C++
102 lines
3.7 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
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "db/dbformat.h"
|
|
#include "file/writable_file_writer.h"
|
|
#include "options/cf_options.h"
|
|
#include "rocksdb/advanced_options.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
class SstFileDumper {
|
|
public:
|
|
explicit SstFileDumper(const Options& options, const std::string& file_name,
|
|
Temperature file_temp, size_t readahead_size,
|
|
bool verify_checksum, bool output_hex,
|
|
bool decode_blob_index,
|
|
const EnvOptions& soptions = EnvOptions(),
|
|
bool silent = false);
|
|
|
|
Status ReadSequential(bool print_kv, uint64_t read_num, bool has_from,
|
|
const std::string& from_key, bool has_to,
|
|
const std::string& to_key,
|
|
bool use_from_as_prefix = false);
|
|
|
|
Status ReadTableProperties(
|
|
std::shared_ptr<const TableProperties>* table_properties);
|
|
uint64_t GetReadNumber() { return read_num_; }
|
|
TableProperties* GetInitTableProperties() { return table_properties_.get(); }
|
|
|
|
Status VerifyChecksum();
|
|
Status DumpTable(const std::string& out_filename);
|
|
Status getStatus() { return init_result_; }
|
|
|
|
Status ShowAllCompressionSizes(
|
|
size_t block_size,
|
|
const std::vector<std::pair<CompressionType, const char*>>&
|
|
compression_types,
|
|
int32_t compress_level_from, int32_t compress_level_to,
|
|
uint32_t max_dict_bytes, uint32_t zstd_max_train_bytes,
|
|
uint64_t max_dict_buffer_bytes);
|
|
|
|
Status ShowCompressionSize(size_t block_size, CompressionType compress_type,
|
|
const CompressionOptions& compress_opt);
|
|
|
|
private:
|
|
// Get the TableReader implementation for the sst file
|
|
Status GetTableReader(const std::string& file_path);
|
|
Status ReadTableProperties(uint64_t table_magic_number,
|
|
RandomAccessFileReader* file, uint64_t file_size,
|
|
FilePrefetchBuffer* prefetch_buffer);
|
|
|
|
Status CalculateCompressedTableSize(const TableBuilderOptions& tb_options,
|
|
size_t block_size,
|
|
uint64_t* num_data_blocks,
|
|
uint64_t* compressed_table_size);
|
|
|
|
Status SetTableOptionsByMagicNumber(uint64_t table_magic_number);
|
|
Status SetOldTableOptions();
|
|
|
|
// Helper function to call the factory with settings specific to the
|
|
// factory implementation
|
|
Status NewTableReader(const ImmutableOptions& ioptions,
|
|
const EnvOptions& soptions,
|
|
const InternalKeyComparator& internal_comparator,
|
|
uint64_t file_size,
|
|
std::unique_ptr<TableReader>* table_reader);
|
|
|
|
std::string file_name_;
|
|
uint64_t read_num_;
|
|
Temperature file_temp_;
|
|
bool output_hex_;
|
|
bool decode_blob_index_;
|
|
EnvOptions soptions_;
|
|
// less verbose in stdout/stderr
|
|
bool silent_;
|
|
|
|
// options_ and internal_comparator_ will also be used in
|
|
// ReadSequential internally (specifically, seek-related operations)
|
|
Options options_;
|
|
|
|
Status init_result_;
|
|
std::unique_ptr<TableReader> table_reader_;
|
|
std::unique_ptr<RandomAccessFileReader> file_;
|
|
|
|
const ImmutableOptions ioptions_;
|
|
const MutableCFOptions moptions_;
|
|
ReadOptions read_options_;
|
|
InternalKeyComparator internal_comparator_;
|
|
std::unique_ptr<TableProperties> table_properties_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|
|
|
|
#endif // ROCKSDB_LITE
|