1f84611e5d
Summary: The patch does some cleanup in and around the legacy `BlobLogReader` class: * It renames the class to `BlobLogSequentialReader` to emphasize that it is for sequentially iterating through blobs in a blob file, as opposed to doing random point reads using `BlobIndex`es (which is `BlobFileReader`'s jurisdiction). * It removes some dead code from the old BlobDB implementation that references `BlobLogReader` (namely the method `BlobFile::OpenRandomAccessReader`). * It cleans up some `#include`s and forward declarations. * It fixes some incorrect/outdated comments related to the reader class. * It adds a few assertions to the `Read` methods of the class. Pull Request resolved: https://github.com/facebook/rocksdb/pull/7517 Test Plan: `make check` Reviewed By: riversand963 Differential Revision: D24172611 Pulled By: ltamasi fbshipit-source-id: 43e2ae1eba5c3dd30c1070cb00f217edc45bd64f
77 lines
2.2 KiB
C++
77 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 "db/blob/blob_log_format.h"
|
|
#include "rocksdb/slice.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
class RandomAccessFileReader;
|
|
class Env;
|
|
class Statistics;
|
|
class Status;
|
|
|
|
/**
|
|
* BlobLogSequentialReader is a general purpose log stream reader
|
|
* implementation. The actual job of reading from the device is implemented by
|
|
* the RandomAccessFileReader interface.
|
|
*
|
|
* Please see BlobLogWriter for details on the file and record layout.
|
|
*/
|
|
|
|
class BlobLogSequentialReader {
|
|
public:
|
|
enum ReadLevel {
|
|
kReadHeader,
|
|
kReadHeaderKey,
|
|
kReadHeaderKeyBlob,
|
|
};
|
|
|
|
// Create a reader that will return log records from "*file_reader".
|
|
BlobLogSequentialReader(std::unique_ptr<RandomAccessFileReader>&& file_reader,
|
|
Env* env, Statistics* statistics);
|
|
|
|
// No copying allowed
|
|
BlobLogSequentialReader(const BlobLogSequentialReader&) = delete;
|
|
BlobLogSequentialReader& operator=(const BlobLogSequentialReader&) = delete;
|
|
|
|
~BlobLogSequentialReader();
|
|
|
|
Status ReadHeader(BlobLogHeader* header);
|
|
|
|
// Read the next record into *record. Returns true if read
|
|
// successfully, false if we hit end of the input. The contents filled in
|
|
// *record will only be valid until the next mutating operation on this
|
|
// reader.
|
|
// If blob_offset is non-null, return offset of the blob through it.
|
|
Status ReadRecord(BlobLogRecord* record, ReadLevel level = kReadHeader,
|
|
uint64_t* blob_offset = nullptr);
|
|
|
|
Status ReadFooter(BlobLogFooter* footer);
|
|
|
|
void ResetNextByte() { next_byte_ = 0; }
|
|
|
|
uint64_t GetNextByte() const { return next_byte_; }
|
|
|
|
private:
|
|
Status ReadSlice(uint64_t size, Slice* slice, char* buf);
|
|
|
|
const std::unique_ptr<RandomAccessFileReader> file_;
|
|
Env* env_;
|
|
Statistics* statistics_;
|
|
|
|
Slice buffer_;
|
|
char header_buf_[BlobLogRecord::kHeaderSize];
|
|
|
|
// which byte to read next
|
|
uint64_t next_byte_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|