5043960623
Summary: The patch adds a class called `BlobFileBuilder` that can be used to build and cut blob files in background jobs (flushes/compactions). The class enforces a value size threshold (`min_blob_size`; smaller blobs will be inlined in the LSM tree itself), and supports specifying a blob file size limit (`blob_file_size`), as well as compression (`blob_compression_type`) and checksums for blob files. It also keeps track of the generated blob files and their associated `BlobFileAddition` metadata, which can be applied as part of the background job's `VersionEdit`. Pull Request resolved: https://github.com/facebook/rocksdb/pull/7306 Test Plan: `make check` Reviewed By: riversand963 Differential Revision: D23298817 Pulled By: ltamasi fbshipit-source-id: 38f35d81dab1ba81f15236240612ec173d7f21b5
84 lines
2.5 KiB
C++
84 lines
2.5 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 <cstdint>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "db/blob/blob_log_format.h"
|
|
#include "rocksdb/env.h"
|
|
#include "rocksdb/slice.h"
|
|
#include "rocksdb/statistics.h"
|
|
#include "rocksdb/status.h"
|
|
#include "rocksdb/types.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
class WritableFileWriter;
|
|
|
|
/**
|
|
* BlobLogWriter is the blob log stream writer. It provides an append-only
|
|
* abstraction for writing blob data.
|
|
*
|
|
*
|
|
* Look at blob_db_format.h to see the details of the record formats.
|
|
*/
|
|
|
|
class BlobLogWriter {
|
|
public:
|
|
// Create a writer that will append data to "*dest".
|
|
// "*dest" must be initially empty.
|
|
// "*dest" must remain live while this BlobLogWriter is in use.
|
|
BlobLogWriter(std::unique_ptr<WritableFileWriter>&& dest, Env* env,
|
|
Statistics* statistics, uint64_t log_number, bool use_fsync,
|
|
uint64_t boffset = 0);
|
|
// No copying allowed
|
|
BlobLogWriter(const BlobLogWriter&) = delete;
|
|
BlobLogWriter& operator=(const BlobLogWriter&) = delete;
|
|
|
|
~BlobLogWriter();
|
|
|
|
static void ConstructBlobHeader(std::string* buf, const Slice& key,
|
|
const Slice& val, uint64_t expiration);
|
|
|
|
Status AddRecord(const Slice& key, const Slice& val, uint64_t* key_offset,
|
|
uint64_t* blob_offset);
|
|
|
|
Status AddRecord(const Slice& key, const Slice& val, uint64_t expiration,
|
|
uint64_t* key_offset, uint64_t* blob_offset);
|
|
|
|
Status EmitPhysicalRecord(const std::string& headerbuf, const Slice& key,
|
|
const Slice& val, uint64_t* key_offset,
|
|
uint64_t* blob_offset);
|
|
|
|
Status AppendFooter(BlobLogFooter& footer, std::string* checksum_method,
|
|
std::string* checksum_value);
|
|
|
|
Status WriteHeader(BlobLogHeader& header);
|
|
|
|
WritableFileWriter* file() { return dest_.get(); }
|
|
|
|
const WritableFileWriter* file() const { return dest_.get(); }
|
|
|
|
uint64_t get_log_number() const { return log_number_; }
|
|
|
|
Status Sync();
|
|
|
|
private:
|
|
std::unique_ptr<WritableFileWriter> dest_;
|
|
Env* env_;
|
|
Statistics* statistics_;
|
|
uint64_t log_number_;
|
|
uint64_t block_offset_; // Current offset in block
|
|
bool use_fsync_;
|
|
|
|
public:
|
|
enum ElemType { kEtNone, kEtFileHdr, kEtRecord, kEtFileFooter };
|
|
ElemType last_elem_type_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|