mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-27 20:43:57 +00:00
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
49 lines
1.3 KiB
C++
49 lines
1.3 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 "rocksdb/trace_reader_writer.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
class RandomAccessFileReader;
|
|
class WritableFileWriter;
|
|
|
|
// FileTraceReader allows reading RocksDB traces from a file.
|
|
class FileTraceReader : public TraceReader {
|
|
public:
|
|
explicit FileTraceReader(std::unique_ptr<RandomAccessFileReader>&& reader);
|
|
~FileTraceReader();
|
|
|
|
virtual Status Read(std::string* data) override;
|
|
virtual Status Close() override;
|
|
virtual Status Reset() override;
|
|
|
|
private:
|
|
std::unique_ptr<RandomAccessFileReader> file_reader_;
|
|
Slice result_;
|
|
size_t offset_;
|
|
char* const buffer_;
|
|
|
|
static const unsigned int kBufferSize;
|
|
};
|
|
|
|
// FileTraceWriter allows writing RocksDB traces to a file.
|
|
class FileTraceWriter : public TraceWriter {
|
|
public:
|
|
explicit FileTraceWriter(std::unique_ptr<WritableFileWriter>&& file_writer);
|
|
~FileTraceWriter();
|
|
|
|
virtual Status Write(const Slice& data) override;
|
|
virtual Status Close() override;
|
|
virtual uint64_t GetFileSize() override;
|
|
|
|
private:
|
|
std::unique_ptr<WritableFileWriter> file_writer_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|