bda8d93ba9
Summary: It's always annoying to find a header does not include its own dependencies and only works when included after other includes. This change adds `make check-headers` which validates that each header can be included at the top of a file. Some headers are excluded e.g. because of platform or external dependencies. rocksdb_namespace.h had to be re-worked slightly to enable checking for failure to include it. (ROCKSDB_NAMESPACE is a valid namespace name.) Fixes mostly involve adding and cleaning up #includes, but for FileTraceWriter, a constructor was out-of-lined to make a forward declaration sufficient. This check is not currently run with `make check` but is added to CircleCI build-linux-unity since that one is already relatively fast. Pull Request resolved: https://github.com/facebook/rocksdb/pull/8893 Test Plan: existing tests and resolving issues detected by new check Reviewed By: mrambacher Differential Revision: D30823300 Pulled By: pdillinger fbshipit-source-id: 9fff223944994c83c105e2e6496d24845dc8e572
133 lines
4.0 KiB
C++
133 lines
4.0 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).
|
|
|
|
#include "utilities/trace/file_trace_reader_writer.h"
|
|
|
|
#include "env/composite_env_wrapper.h"
|
|
#include "file/random_access_file_reader.h"
|
|
#include "file/writable_file_writer.h"
|
|
#include "trace_replay/trace_replay.h"
|
|
#include "util/coding.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
const unsigned int FileTraceReader::kBufferSize = 1024; // 1KB
|
|
|
|
FileTraceReader::FileTraceReader(
|
|
std::unique_ptr<RandomAccessFileReader>&& reader)
|
|
: file_reader_(std::move(reader)),
|
|
offset_(0),
|
|
buffer_(new char[kBufferSize]) {}
|
|
|
|
FileTraceReader::~FileTraceReader() {
|
|
Close().PermitUncheckedError();
|
|
delete[] buffer_;
|
|
}
|
|
|
|
Status FileTraceReader::Close() {
|
|
file_reader_.reset();
|
|
return Status::OK();
|
|
}
|
|
|
|
Status FileTraceReader::Reset() {
|
|
if (file_reader_ == nullptr) {
|
|
return Status::IOError("TraceReader is closed.");
|
|
}
|
|
offset_ = 0;
|
|
return Status::OK();
|
|
}
|
|
|
|
Status FileTraceReader::Read(std::string* data) {
|
|
assert(file_reader_ != nullptr);
|
|
Status s = file_reader_->Read(IOOptions(), offset_, kTraceMetadataSize,
|
|
&result_, buffer_, nullptr);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
if (result_.size() == 0) {
|
|
// No more data to read
|
|
// Todo: Come up with a better way to indicate end of data. May be this
|
|
// could be avoided once footer is introduced.
|
|
return Status::Incomplete();
|
|
}
|
|
if (result_.size() < kTraceMetadataSize) {
|
|
return Status::Corruption("Corrupted trace file.");
|
|
}
|
|
*data = result_.ToString();
|
|
offset_ += kTraceMetadataSize;
|
|
|
|
uint32_t payload_len =
|
|
DecodeFixed32(&buffer_[kTraceTimestampSize + kTraceTypeSize]);
|
|
|
|
// Read Payload
|
|
unsigned int bytes_to_read = payload_len;
|
|
unsigned int to_read =
|
|
bytes_to_read > kBufferSize ? kBufferSize : bytes_to_read;
|
|
while (to_read > 0) {
|
|
s = file_reader_->Read(IOOptions(), offset_, to_read, &result_, buffer_,
|
|
nullptr);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
if (result_.size() < to_read) {
|
|
return Status::Corruption("Corrupted trace file.");
|
|
}
|
|
data->append(result_.data(), result_.size());
|
|
|
|
offset_ += to_read;
|
|
bytes_to_read -= to_read;
|
|
to_read = bytes_to_read > kBufferSize ? kBufferSize : bytes_to_read;
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
FileTraceWriter::FileTraceWriter(
|
|
std::unique_ptr<WritableFileWriter>&& file_writer)
|
|
: file_writer_(std::move(file_writer)) {}
|
|
|
|
FileTraceWriter::~FileTraceWriter() { Close().PermitUncheckedError(); }
|
|
|
|
Status FileTraceWriter::Close() {
|
|
file_writer_.reset();
|
|
return Status::OK();
|
|
}
|
|
|
|
Status FileTraceWriter::Write(const Slice& data) {
|
|
return file_writer_->Append(data);
|
|
}
|
|
|
|
uint64_t FileTraceWriter::GetFileSize() { return file_writer_->GetFileSize(); }
|
|
|
|
Status NewFileTraceReader(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceReader>* trace_reader) {
|
|
std::unique_ptr<RandomAccessFileReader> file_reader;
|
|
Status s = RandomAccessFileReader::Create(
|
|
env->GetFileSystem(), trace_filename, FileOptions(env_options),
|
|
&file_reader, nullptr);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
trace_reader->reset(new FileTraceReader(std::move(file_reader)));
|
|
return s;
|
|
}
|
|
|
|
Status NewFileTraceWriter(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceWriter>* trace_writer) {
|
|
std::unique_ptr<WritableFileWriter> file_writer;
|
|
Status s = WritableFileWriter::Create(env->GetFileSystem(), trace_filename,
|
|
FileOptions(env_options), &file_writer,
|
|
nullptr);
|
|
if (!s.ok()) {
|
|
return s;
|
|
}
|
|
trace_writer->reset(new FileTraceWriter(std::move(file_writer)));
|
|
return s;
|
|
}
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|