mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-27 02:44:18 +00:00
d85ff4953c
Summary: The final pull request for Blob Storage. Closes https://github.com/facebook/rocksdb/pull/2269 Differential Revision: D5033189 Pulled By: yiwu-arbug fbshipit-source-id: 6356b683ccd58cbf38a1dc55e2ea400feecd5d06
99 lines
2.9 KiB
C++
99 lines
2.9 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under the BSD-style license found in the
|
|
// LICENSE file in the root directory of this source tree. An additional grant
|
|
// of patent rights can be found in the PATENTS file in the same directory.
|
|
//
|
|
#pragma once
|
|
|
|
#ifndef ROCKSDB_LITE
|
|
|
|
#include <cstdint>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "rocksdb/slice.h"
|
|
#include "rocksdb/status.h"
|
|
#include "rocksdb/types.h"
|
|
#include "utilities/blob_db/blob_log_format.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
class WritableFileWriter;
|
|
|
|
namespace blob_db {
|
|
|
|
/**
|
|
* Writer 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 Writer {
|
|
public:
|
|
// Create a writer that will append data to "*dest".
|
|
// "*dest" must be initially empty.
|
|
// "*dest" must remain live while this Writer is in use.
|
|
explicit Writer(std::unique_ptr<WritableFileWriter>&& dest,
|
|
uint64_t log_number, uint64_t bpsync, bool use_fsync,
|
|
uint64_t boffset = 0);
|
|
~Writer();
|
|
|
|
static void ConstructBlobHeader(std::string* headerbuf, const Slice& key,
|
|
const Slice& val, int32_t ttl, int64_t ts);
|
|
|
|
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* key_offset,
|
|
uint64_t* blob_offset, uint32_t ttl);
|
|
|
|
Status EmitPhysicalRecord(const std::string& headerbuf, const Slice& key,
|
|
const Slice& val, uint64_t* key_offset,
|
|
uint64_t* blob_offset);
|
|
|
|
Status AddRecordFooter(const SequenceNumber& sn);
|
|
|
|
Status AppendFooter(const BlobLogFooter& footer);
|
|
|
|
Status WriteHeader(const BlobLogHeader& header);
|
|
|
|
WritableFileWriter* file() { return dest_.get(); }
|
|
|
|
const WritableFileWriter* file() const { return dest_.get(); }
|
|
|
|
uint64_t get_log_number() const { return log_number_; }
|
|
|
|
bool ShouldSync() const { return block_offset_ > next_sync_offset_; }
|
|
|
|
void Sync();
|
|
|
|
void ResetSyncPointer() { next_sync_offset_ += bytes_per_sync_; }
|
|
|
|
private:
|
|
std::unique_ptr<WritableFileWriter> dest_;
|
|
uint64_t log_number_;
|
|
uint64_t block_offset_; // Current offset in block
|
|
uint64_t bytes_per_sync_;
|
|
uint64_t next_sync_offset_;
|
|
bool use_fsync_;
|
|
|
|
// crc32c values for all supported record types. These are
|
|
// pre-computed to reduce the overhead of computing the crc of the
|
|
// record type stored in the header.
|
|
uint32_t type_crc_[kMaxRecordType + 1];
|
|
|
|
// No copying allowed
|
|
Writer(const Writer&) = delete;
|
|
Writer& operator=(const Writer&) = delete;
|
|
|
|
public:
|
|
enum ElemType { kEtNone, kEtFileHdr, kEtRecord, kEtFooter, kEtFileFooter };
|
|
ElemType last_elem_type_;
|
|
};
|
|
|
|
} // namespace blob_db
|
|
} // namespace rocksdb
|
|
#endif // ROCKSDB_LITE
|