diff --git a/CMakeLists.txt b/CMakeLists.txt index 4b8b3542e..676192913 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -575,7 +575,7 @@ set(SOURCES db/blob/blob_file_meta.cc db/blob/blob_file_reader.cc db/blob/blob_log_format.cc - db/blob/blob_log_reader.cc + db/blob/blob_log_sequential_reader.cc db/blob/blob_log_writer.cc db/builder.cc db/c.cc diff --git a/TARGETS b/TARGETS index 28c570757..ee6d99032 100644 --- a/TARGETS +++ b/TARGETS @@ -139,7 +139,7 @@ cpp_library( "db/blob/blob_file_meta.cc", "db/blob/blob_file_reader.cc", "db/blob/blob_log_format.cc", - "db/blob/blob_log_reader.cc", + "db/blob/blob_log_sequential_reader.cc", "db/blob/blob_log_writer.cc", "db/builder.cc", "db/c.cc", @@ -427,7 +427,7 @@ cpp_library( "db/blob/blob_file_meta.cc", "db/blob/blob_file_reader.cc", "db/blob/blob_log_format.cc", - "db/blob/blob_log_reader.cc", + "db/blob/blob_log_sequential_reader.cc", "db/blob/blob_log_writer.cc", "db/builder.cc", "db/c.cc", diff --git a/db/blob/blob_file_builder_test.cc b/db/blob/blob_file_builder_test.cc index dbcdcb9b0..72e9ac47b 100644 --- a/db/blob/blob_file_builder_test.cc +++ b/db/blob/blob_file_builder_test.cc @@ -14,7 +14,7 @@ #include "db/blob/blob_file_addition.h" #include "db/blob/blob_index.h" #include "db/blob/blob_log_format.h" -#include "db/blob/blob_log_reader.h" +#include "db/blob/blob_log_sequential_reader.h" #include "env/composite_env_wrapper.h" #include "env/mock_env.h" #include "file/filename.h" @@ -61,8 +61,8 @@ class BlobFileBuilderTest : public testing::Test { &mock_env_)); constexpr Statistics* statistics = nullptr; - BlobLogReader blob_log_reader(std::move(file_reader), &mock_env_, - statistics); + BlobLogSequentialReader blob_log_reader(std::move(file_reader), &mock_env_, + statistics); BlobLogHeader header; ASSERT_OK(blob_log_reader.ReadHeader(&header)); @@ -77,7 +77,7 @@ class BlobFileBuilderTest : public testing::Test { uint64_t blob_offset = 0; ASSERT_OK(blob_log_reader.ReadRecord( - &record, BlobLogReader::kReadHeaderKeyBlob, &blob_offset)); + &record, BlobLogSequentialReader::kReadHeaderKeyBlob, &blob_offset)); // Check the contents of the blob file const auto& expected_key_value = expected_key_value_pairs[i]; diff --git a/db/blob/blob_log_reader.cc b/db/blob/blob_log_sequential_reader.cc similarity index 82% rename from db/blob/blob_log_reader.cc rename to db/blob/blob_log_sequential_reader.cc index 991616e1b..58afd27a9 100644 --- a/db/blob/blob_log_reader.cc +++ b/db/blob/blob_log_sequential_reader.cc @@ -4,7 +4,7 @@ // (found in the LICENSE.Apache file in the root directory). // -#include "db/blob/blob_log_reader.h" +#include "db/blob/blob_log_sequential_reader.h" #include @@ -14,16 +14,19 @@ namespace ROCKSDB_NAMESPACE { -BlobLogReader::BlobLogReader( +BlobLogSequentialReader::BlobLogSequentialReader( std::unique_ptr&& file_reader, Env* env, Statistics* statistics) : file_(std::move(file_reader)), env_(env), statistics_(statistics), - buffer_(), next_byte_(0) {} -Status BlobLogReader::ReadSlice(uint64_t size, Slice* slice, char* buf) { +BlobLogSequentialReader::~BlobLogSequentialReader() = default; + +Status BlobLogSequentialReader::ReadSlice(uint64_t size, Slice* slice, + char* buf) { + assert(slice); assert(file_); StopWatch read_sw(env_, statistics_, BLOB_DB_BLOB_FILE_READ_MICROS); @@ -40,7 +43,8 @@ Status BlobLogReader::ReadSlice(uint64_t size, Slice* slice, char* buf) { return s; } -Status BlobLogReader::ReadHeader(BlobLogHeader* header) { +Status BlobLogSequentialReader::ReadHeader(BlobLogHeader* header) { + assert(header); assert(next_byte_ == 0); static_assert(BlobLogHeader::kSize <= sizeof(header_buf_), @@ -58,8 +62,10 @@ Status BlobLogReader::ReadHeader(BlobLogHeader* header) { return header->DecodeFrom(buffer_); } -Status BlobLogReader::ReadRecord(BlobLogRecord* record, ReadLevel level, - uint64_t* blob_offset) { +Status BlobLogSequentialReader::ReadRecord(BlobLogRecord* record, + ReadLevel level, + uint64_t* blob_offset) { + assert(record); static_assert(BlobLogRecord::kHeaderSize <= sizeof(header_buf_), "Buffer is smaller than BlobLogRecord::kHeaderSize"); @@ -108,7 +114,8 @@ Status BlobLogReader::ReadRecord(BlobLogRecord* record, ReadLevel level, return s; } -Status BlobLogReader::ReadFooter(BlobLogFooter* footer) { +Status BlobLogSequentialReader::ReadFooter(BlobLogFooter* footer) { + assert(footer); static_assert(BlobLogFooter::kSize <= sizeof(header_buf_), "Buffer is smaller than BlobLogFooter::kSize"); diff --git a/db/blob/blob_log_reader.h b/db/blob/blob_log_sequential_reader.h similarity index 52% rename from db/blob/blob_log_reader.h rename to db/blob/blob_log_sequential_reader.h index 9ce0e64c0..62c707b4d 100644 --- a/db/blob/blob_log_reader.h +++ b/db/blob/blob_log_sequential_reader.h @@ -6,28 +6,26 @@ #pragma once #include -#include #include "db/blob/blob_log_format.h" -#include "file/random_access_file_reader.h" -#include "rocksdb/env.h" #include "rocksdb/slice.h" -#include "rocksdb/statistics.h" -#include "rocksdb/status.h" namespace ROCKSDB_NAMESPACE { -class SequentialFileReader; -class Logger; +class RandomAccessFileReader; +class Env; +class Statistics; +class Status; /** - * BlobLogReader is a general purpose log stream reader implementation. The - * actual job of reading from the device is implemented by the SequentialFile - * interface. + * 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 Writer for details on the file and record layout. + * Please see BlobLogWriter for details on the file and record layout. */ -class BlobLogReader { + +class BlobLogSequentialReader { public: enum ReadLevel { kReadHeader, @@ -35,23 +33,22 @@ class BlobLogReader { kReadHeaderKeyBlob, }; - // Create a reader that will return log records from "*file". - // "*file" must remain live while this BlobLogReader is in use. - BlobLogReader(std::unique_ptr&& file_reader, Env* env, - Statistics* statistics); + // Create a reader that will return log records from "*file_reader". + BlobLogSequentialReader(std::unique_ptr&& file_reader, + Env* env, Statistics* statistics); + // No copying allowed - BlobLogReader(const BlobLogReader&) = delete; - BlobLogReader& operator=(const BlobLogReader&) = delete; + BlobLogSequentialReader(const BlobLogSequentialReader&) = delete; + BlobLogSequentialReader& operator=(const BlobLogSequentialReader&) = delete; - ~BlobLogReader() = default; + ~BlobLogSequentialReader(); Status ReadHeader(BlobLogHeader* header); // Read the next record into *record. Returns true if read - // successfully, false if we hit end of the input. May use - // "*scratch" as temporary storage. The contents filled in *record - // will only be valid until the next mutating operation on this - // reader or the next mutation to *scratch. + // 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); @@ -72,7 +69,7 @@ class BlobLogReader { Slice buffer_; char header_buf_[BlobLogRecord::kHeaderSize]; - // which byte to read next. For asserting proper usage + // which byte to read next uint64_t next_byte_; }; diff --git a/src.mk b/src.mk index aedc75ceb..8342f2a3b 100644 --- a/src.mk +++ b/src.mk @@ -11,7 +11,7 @@ LIB_SOURCES = \ db/blob/blob_file_meta.cc \ db/blob/blob_file_reader.cc \ db/blob/blob_log_format.cc \ - db/blob/blob_log_reader.cc \ + db/blob/blob_log_sequential_reader.cc \ db/blob/blob_log_writer.cc \ db/builder.cc \ db/c.cc \ diff --git a/utilities/blob_db/blob_db_impl.h b/utilities/blob_db/blob_db_impl.h index bad2fd00d..e400fae18 100644 --- a/utilities/blob_db/blob_db_impl.h +++ b/utilities/blob_db/blob_db_impl.h @@ -20,7 +20,6 @@ #include #include "db/blob/blob_log_format.h" -#include "db/blob/blob_log_reader.h" #include "db/blob/blob_log_writer.h" #include "db/db_iter.h" #include "rocksdb/compaction_filter.h" diff --git a/utilities/blob_db/blob_file.cc b/utilities/blob_db/blob_file.cc index 1d94f3b71..a3d208c3b 100644 --- a/utilities/blob_db/blob_file.cc +++ b/utilities/blob_db/blob_file.cc @@ -61,29 +61,6 @@ std::string BlobFile::PathName() const { return BlobFileName(path_to_dir_, file_number_); } -std::shared_ptr BlobFile::OpenRandomAccessReader( - Env* env, const DBOptions& db_options, - const EnvOptions& env_options) const { - constexpr size_t kReadaheadSize = 2 * 1024 * 1024; - std::unique_ptr sfile; - std::string path_name(PathName()); - Status s = env->NewRandomAccessFile(path_name, &sfile, env_options); - if (!s.ok()) { - // report something here. - return nullptr; - } - sfile = NewReadaheadRandomAccessFile(std::move(sfile), kReadaheadSize); - - std::unique_ptr sfile_reader; - sfile_reader.reset(new RandomAccessFileReader( - NewLegacyRandomAccessFileWrapper(sfile), path_name)); - - std::shared_ptr log_reader = std::make_shared( - std::move(sfile_reader), db_options.env, db_options.statistics.get()); - - return log_reader; -} - std::string BlobFile::DumpState() const { char str[1000]; snprintf( diff --git a/utilities/blob_db/blob_file.h b/utilities/blob_db/blob_file.h index fb990dafd..9de9a3e91 100644 --- a/utilities/blob_db/blob_file.h +++ b/utilities/blob_db/blob_file.h @@ -11,7 +11,6 @@ #include #include "db/blob/blob_log_format.h" -#include "db/blob/blob_log_reader.h" #include "db/blob/blob_log_writer.h" #include "file/random_access_file_reader.h" #include "port/port.h" @@ -216,10 +215,6 @@ class BlobFile { bool* fresh_open); private: - std::shared_ptr OpenRandomAccessReader( - Env* env, const DBOptions& db_options, - const EnvOptions& env_options) const; - Status ReadFooter(BlobLogFooter* footer); Status WriteFooterAndCloseLocked(SequenceNumber sequence);