Introduce a CountedFileSystem for counting file operations (#9283)
Summary: Added a CountedFileSystem that tracks a number of file operations (opens, closes, deletes, renames, flushes, syncs, fsyncs, reads, writes). This class was based on the ReportFileOpEnv from db_bench. This is a stepping stone PR to be able to change the SpecialEnv into a SpecialFileSystem, where several of the file varieties wish to do operation counting. Pull Request resolved: https://github.com/facebook/rocksdb/pull/9283 Reviewed By: pdillinger Differential Revision: D33062004 Pulled By: mrambacher fbshipit-source-id: d0d297a7fb9c48c06cbf685e5fa755c27193b6f5main
parent
5104c10ffb
commit
aae3093719
@ -0,0 +1,355 @@ |
||||
// 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).
|
||||
|
||||
#include "utilities/counted_fs.h" |
||||
|
||||
#include <sstream> |
||||
|
||||
#include "rocksdb/file_system.h" |
||||
#include "rocksdb/utilities/options_type.h" |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
namespace { |
||||
class CountedSequentialFile : public FSSequentialFileOwnerWrapper { |
||||
private: |
||||
CountedFileSystem* fs_; |
||||
|
||||
public: |
||||
CountedSequentialFile(std::unique_ptr<FSSequentialFile>&& f, |
||||
CountedFileSystem* fs) |
||||
: FSSequentialFileOwnerWrapper(std::move(f)), fs_(fs) {} |
||||
|
||||
~CountedSequentialFile() override { fs_->counters()->closes++; } |
||||
|
||||
IOStatus Read(size_t n, const IOOptions& options, Slice* result, |
||||
char* scratch, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Read(n, options, result, scratch, dbg); |
||||
fs_->counters()->reads.RecordOp(rv, result->size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus PositionedRead(uint64_t offset, size_t n, const IOOptions& options, |
||||
Slice* result, char* scratch, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = |
||||
target()->PositionedRead(offset, n, options, result, scratch, dbg); |
||||
fs_->counters()->reads.RecordOp(rv, result->size()); |
||||
return rv; |
||||
} |
||||
}; |
||||
|
||||
class CountedRandomAccessFile : public FSRandomAccessFileOwnerWrapper { |
||||
private: |
||||
CountedFileSystem* fs_; |
||||
|
||||
public: |
||||
CountedRandomAccessFile(std::unique_ptr<FSRandomAccessFile>&& f, |
||||
CountedFileSystem* fs) |
||||
: FSRandomAccessFileOwnerWrapper(std::move(f)), fs_(fs) {} |
||||
|
||||
~CountedRandomAccessFile() override { fs_->counters()->closes++; } |
||||
|
||||
IOStatus Read(uint64_t offset, size_t n, const IOOptions& options, |
||||
Slice* result, char* scratch, |
||||
IODebugContext* dbg) const override { |
||||
IOStatus rv = target()->Read(offset, n, options, result, scratch, dbg); |
||||
fs_->counters()->reads.RecordOp(rv, result->size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus MultiRead(FSReadRequest* reqs, size_t num_reqs, |
||||
const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->MultiRead(reqs, num_reqs, options, dbg); |
||||
for (size_t r = 0; r < num_reqs; r++) { |
||||
fs_->counters()->reads.RecordOp(reqs[r].status, reqs[r].result.size()); |
||||
} |
||||
return rv; |
||||
} |
||||
}; |
||||
|
||||
class CountedWritableFile : public FSWritableFileOwnerWrapper { |
||||
private: |
||||
CountedFileSystem* fs_; |
||||
|
||||
public: |
||||
CountedWritableFile(std::unique_ptr<FSWritableFile>&& f, |
||||
CountedFileSystem* fs) |
||||
: FSWritableFileOwnerWrapper(std::move(f)), fs_(fs) {} |
||||
|
||||
IOStatus Append(const Slice& data, const IOOptions& options, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Append(data, options, dbg); |
||||
fs_->counters()->writes.RecordOp(rv, data.size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Append(const Slice& data, const IOOptions& options, |
||||
const DataVerificationInfo& info, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Append(data, options, info, dbg); |
||||
fs_->counters()->writes.RecordOp(rv, data.size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus PositionedAppend(const Slice& data, uint64_t offset, |
||||
const IOOptions& options, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->PositionedAppend(data, offset, options, dbg); |
||||
fs_->counters()->writes.RecordOp(rv, data.size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus PositionedAppend(const Slice& data, uint64_t offset, |
||||
const IOOptions& options, |
||||
const DataVerificationInfo& info, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->PositionedAppend(data, offset, options, info, dbg); |
||||
fs_->counters()->writes.RecordOp(rv, data.size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Close(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Close(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->closes++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Flush(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Flush(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->flushes++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Sync(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Sync(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->syncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Fsync(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Fsync(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->fsyncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus RangeSync(uint64_t offset, uint64_t nbytes, const IOOptions& options, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->RangeSync(offset, nbytes, options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->syncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
}; |
||||
|
||||
class CountedRandomRWFile : public FSRandomRWFileOwnerWrapper { |
||||
private: |
||||
mutable CountedFileSystem* fs_; |
||||
|
||||
public: |
||||
CountedRandomRWFile(std::unique_ptr<FSRandomRWFile>&& f, |
||||
CountedFileSystem* fs) |
||||
: FSRandomRWFileOwnerWrapper(std::move(f)), fs_(fs) {} |
||||
IOStatus Write(uint64_t offset, const Slice& data, const IOOptions& options, |
||||
IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Write(offset, data, options, dbg); |
||||
fs_->counters()->writes.RecordOp(rv, data.size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Read(uint64_t offset, size_t n, const IOOptions& options, |
||||
Slice* result, char* scratch, |
||||
IODebugContext* dbg) const override { |
||||
IOStatus rv = target()->Read(offset, n, options, result, scratch, dbg); |
||||
fs_->counters()->reads.RecordOp(rv, result->size()); |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Flush(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Flush(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->flushes++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Sync(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Sync(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->syncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Fsync(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Fsync(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->fsyncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus Close(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = target()->Close(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->closes++; |
||||
} |
||||
return rv; |
||||
} |
||||
}; |
||||
|
||||
class CountedDirectory : public FSDirectoryWrapper { |
||||
private: |
||||
mutable CountedFileSystem* fs_; |
||||
|
||||
public: |
||||
CountedDirectory(std::unique_ptr<FSDirectory>&& f, CountedFileSystem* fs) |
||||
: FSDirectoryWrapper(std::move(f)), fs_(fs) {} |
||||
|
||||
IOStatus Fsync(const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus rv = FSDirectoryWrapper::Fsync(options, dbg); |
||||
if (rv.ok()) { |
||||
fs_->counters()->dsyncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
|
||||
IOStatus FsyncWithDirOptions(const IOOptions& options, IODebugContext* dbg, |
||||
const DirFsyncOptions& dir_options) override { |
||||
IOStatus rv = |
||||
FSDirectoryWrapper::FsyncWithDirOptions(options, dbg, dir_options); |
||||
if (rv.ok()) { |
||||
fs_->counters()->dsyncs++; |
||||
} |
||||
return rv; |
||||
} |
||||
}; |
||||
} // anonymous namespace
|
||||
|
||||
std::string FileOpCounters::PrintCounters() const { |
||||
std::stringstream ss; |
||||
ss << "Num files opened: " << opens.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num files deleted: " << deletes.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num files renamed: " << renames.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num Flush(): " << flushes.load(std::memory_order_relaxed) << std::endl; |
||||
ss << "Num Sync(): " << syncs.load(std::memory_order_relaxed) << std::endl; |
||||
ss << "Num Fsync(): " << fsyncs.load(std::memory_order_relaxed) << std::endl; |
||||
ss << "Num Dir Fsync(): " << dsyncs.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num Close(): " << closes.load(std::memory_order_relaxed) << std::endl; |
||||
ss << "Num Read(): " << reads.ops.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num Append(): " << writes.ops.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num bytes read: " << reads.bytes.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
ss << "Num bytes written: " << writes.bytes.load(std::memory_order_relaxed) |
||||
<< std::endl; |
||||
return ss.str(); |
||||
} |
||||
|
||||
CountedFileSystem::CountedFileSystem(const std::shared_ptr<FileSystem>& base) |
||||
: FileSystemWrapper(base) {} |
||||
|
||||
IOStatus CountedFileSystem::NewSequentialFile( |
||||
const std::string& f, const FileOptions& options, |
||||
std::unique_ptr<FSSequentialFile>* r, IODebugContext* dbg) { |
||||
std::unique_ptr<FSSequentialFile> base; |
||||
IOStatus s = target()->NewSequentialFile(f, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
r->reset(new CountedSequentialFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::NewRandomAccessFile( |
||||
const std::string& f, const FileOptions& options, |
||||
std::unique_ptr<FSRandomAccessFile>* r, IODebugContext* dbg) { |
||||
std::unique_ptr<FSRandomAccessFile> base; |
||||
IOStatus s = target()->NewRandomAccessFile(f, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
r->reset(new CountedRandomAccessFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::NewWritableFile(const std::string& f, |
||||
const FileOptions& options, |
||||
std::unique_ptr<FSWritableFile>* r, |
||||
IODebugContext* dbg) { |
||||
std::unique_ptr<FSWritableFile> base; |
||||
IOStatus s = target()->NewWritableFile(f, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
r->reset(new CountedWritableFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::ReopenWritableFile( |
||||
const std::string& fname, const FileOptions& options, |
||||
std::unique_ptr<FSWritableFile>* result, IODebugContext* dbg) { |
||||
std::unique_ptr<FSWritableFile> base; |
||||
IOStatus s = target()->ReopenWritableFile(fname, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
result->reset(new CountedWritableFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::ReuseWritableFile( |
||||
const std::string& fname, const std::string& old_fname, |
||||
const FileOptions& options, std::unique_ptr<FSWritableFile>* result, |
||||
IODebugContext* dbg) { |
||||
std::unique_ptr<FSWritableFile> base; |
||||
IOStatus s = |
||||
target()->ReuseWritableFile(fname, old_fname, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
result->reset(new CountedWritableFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::NewRandomRWFile( |
||||
const std::string& name, const FileOptions& options, |
||||
std::unique_ptr<FSRandomRWFile>* result, IODebugContext* dbg) { |
||||
std::unique_ptr<FSRandomRWFile> base; |
||||
IOStatus s = target()->NewRandomRWFile(name, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
result->reset(new CountedRandomRWFile(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus CountedFileSystem::NewDirectory(const std::string& name, |
||||
const IOOptions& options, |
||||
std::unique_ptr<FSDirectory>* result, |
||||
IODebugContext* dbg) { |
||||
std::unique_ptr<FSDirectory> base; |
||||
IOStatus s = target()->NewDirectory(name, options, &base, dbg); |
||||
if (s.ok()) { |
||||
counters_.opens++; |
||||
result->reset(new CountedDirectory(std::move(base), this)); |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
} // namespace ROCKSDB_NAMESPACE
|
@ -0,0 +1,152 @@ |
||||
// Copyright (c) 2016-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 <atomic> |
||||
#include <memory> |
||||
|
||||
#include "rocksdb/file_system.h" |
||||
#include "rocksdb/io_status.h" |
||||
#include "rocksdb/rocksdb_namespace.h" |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
class Logger; |
||||
|
||||
struct OpCounter { |
||||
std::atomic<int> ops; |
||||
std::atomic<uint64_t> bytes; |
||||
|
||||
OpCounter() : ops(0), bytes(0) {} |
||||
|
||||
void Reset() { |
||||
ops = 0; |
||||
bytes = 0; |
||||
} |
||||
void RecordOp(const IOStatus& io_s, size_t added_bytes) { |
||||
if (!io_s.IsNotSupported()) { |
||||
ops.fetch_add(1, std::memory_order_relaxed); |
||||
} |
||||
if (io_s.ok()) { |
||||
bytes.fetch_add(added_bytes, std::memory_order_relaxed); |
||||
} |
||||
} |
||||
}; |
||||
|
||||
struct FileOpCounters { |
||||
static const char* kName() { return "FileOpCounters"; } |
||||
|
||||
std::atomic<int> opens; |
||||
std::atomic<int> closes; |
||||
std::atomic<int> deletes; |
||||
std::atomic<int> renames; |
||||
std::atomic<int> flushes; |
||||
std::atomic<int> syncs; |
||||
std::atomic<int> dsyncs; |
||||
std::atomic<int> fsyncs; |
||||
OpCounter reads; |
||||
OpCounter writes; |
||||
|
||||
FileOpCounters() |
||||
: opens(0), |
||||
closes(0), |
||||
deletes(0), |
||||
renames(0), |
||||
flushes(0), |
||||
syncs(0), |
||||
dsyncs(0), |
||||
fsyncs(0) {} |
||||
|
||||
void Reset() { |
||||
opens = 0; |
||||
closes = 0; |
||||
deletes = 0; |
||||
renames = 0; |
||||
flushes = 0; |
||||
syncs = 0; |
||||
dsyncs = 0; |
||||
fsyncs = 0; |
||||
reads.Reset(); |
||||
writes.Reset(); |
||||
} |
||||
std::string PrintCounters() const; |
||||
}; |
||||
|
||||
// A FileSystem class that counts operations (reads, writes, opens, closes, etc)
|
||||
class CountedFileSystem : public FileSystemWrapper { |
||||
public: |
||||
private: |
||||
FileOpCounters counters_; |
||||
|
||||
public: |
||||
explicit CountedFileSystem(const std::shared_ptr<FileSystem>& base); |
||||
static const char* kClassName() { return "CountedFileSystem"; } |
||||
const char* Name() const override { return kClassName(); } |
||||
|
||||
IOStatus NewSequentialFile(const std::string& f, const FileOptions& options, |
||||
std::unique_ptr<FSSequentialFile>* r, |
||||
IODebugContext* dbg) override; |
||||
|
||||
IOStatus NewRandomAccessFile(const std::string& f, |
||||
const FileOptions& file_opts, |
||||
std::unique_ptr<FSRandomAccessFile>* r, |
||||
IODebugContext* dbg) override; |
||||
|
||||
IOStatus NewWritableFile(const std::string& f, const FileOptions& options, |
||||
std::unique_ptr<FSWritableFile>* r, |
||||
IODebugContext* dbg) override; |
||||
IOStatus ReopenWritableFile(const std::string& fname, |
||||
const FileOptions& options, |
||||
std::unique_ptr<FSWritableFile>* result, |
||||
IODebugContext* dbg) override; |
||||
|
||||
IOStatus ReuseWritableFile(const std::string& fname, |
||||
const std::string& old_fname, |
||||
const FileOptions& file_opts, |
||||
std::unique_ptr<FSWritableFile>* result, |
||||
IODebugContext* dbg) override; |
||||
IOStatus NewRandomRWFile(const std::string& name, const FileOptions& options, |
||||
std::unique_ptr<FSRandomRWFile>* result, |
||||
IODebugContext* dbg) override; |
||||
|
||||
IOStatus NewDirectory(const std::string& name, const IOOptions& io_opts, |
||||
std::unique_ptr<FSDirectory>* result, |
||||
IODebugContext* dbg) override; |
||||
|
||||
IOStatus DeleteFile(const std::string& fname, const IOOptions& options, |
||||
IODebugContext* dbg) override { |
||||
IOStatus s = target()->DeleteFile(fname, options, dbg); |
||||
if (s.ok()) { |
||||
counters_.deletes++; |
||||
} |
||||
return s; |
||||
} |
||||
|
||||
IOStatus RenameFile(const std::string& s, const std::string& t, |
||||
const IOOptions& options, IODebugContext* dbg) override { |
||||
IOStatus st = target()->RenameFile(s, t, options, dbg); |
||||
if (st.ok()) { |
||||
counters_.renames++; |
||||
} |
||||
return st; |
||||
} |
||||
|
||||
const FileOpCounters* counters() const { return &counters_; } |
||||
|
||||
FileOpCounters* counters() { return &counters_; } |
||||
|
||||
const void* GetOptionsPtr(const std::string& name) const override { |
||||
if (name == FileOpCounters::kName()) { |
||||
return counters(); |
||||
} else { |
||||
return FileSystemWrapper::GetOptionsPtr(name); |
||||
} |
||||
} |
||||
|
||||
// Prints the counters to a string
|
||||
std::string PrintCounters() const { return counters_.PrintCounters(); } |
||||
void ResetCounters() { counters_.Reset(); } |
||||
}; |
||||
} // namespace ROCKSDB_NAMESPACE
|
Loading…
Reference in new issue