448bdff263
f9ee0f37c2Add comments to CustomUintFormatter (Pieter Wuille)4eb5643e35Convert everything except wallet/qt to new serialization (Pieter Wuille)2b1f85e8c5Convert blockencodings_tests to new serialization (Pieter Wuille)73747afbbeConvert merkleblock to new serialization (Pieter Wuille)d06fedd1bcAdd SER_READ and SER_WRITE for read/write-dependent statements (Russell Yanofsky)6f9a1e5ad0Extend CustomUintFormatter to support enums (Russell Yanofsky)769ee5fa00Merge BigEndian functionality into CustomUintFormatter (Pieter Wuille) Pull request description: The next step of changes from #10785. This: * Adds support for enum serialization to `CustomUintFormatter`, used in `CAddress` for service flags. * Merges `BigEndian` into `CustomUintFormatter`, used in `CNetAddr` for port numbers. * Converts everything (except wallet and gui) to use the new serialization framework. ACKs for top commit: MarcoFalke: re-ACKf9ee0f37c2, only change is new documentation commit for CustomUintFormatter 📂 ryanofsky: Code review ACKf9ee0f37c2. Just new commit adding comment since last review jonatack: Code review re-ACKf9ee0f37c2only change since last review is an additional commit adding Doxygen documentation for `CustomUintFormatter`. Tree-SHA512: e7a0a36afae592d5a4ff8c81ae04d858ac409388e361f2bc197d9a78abca45134218497ab2dfd6d031e0cce0ca586cf857077b7c6ce17fccf67e2d367c1b6cd4
90 lines
2.9 KiB
C++
90 lines
2.9 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2020 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_FLATFILE_H
|
|
#define BITCOIN_FLATFILE_H
|
|
|
|
#include <string>
|
|
|
|
#include <fs.h>
|
|
#include <serialize.h>
|
|
|
|
struct FlatFilePos
|
|
{
|
|
int nFile;
|
|
unsigned int nPos;
|
|
|
|
SERIALIZE_METHODS(FlatFilePos, obj) { READWRITE(VARINT_MODE(obj.nFile, VarIntMode::NONNEGATIVE_SIGNED), VARINT(obj.nPos)); }
|
|
|
|
FlatFilePos() : nFile(-1), nPos(0) {}
|
|
|
|
FlatFilePos(int nFileIn, unsigned int nPosIn) :
|
|
nFile(nFileIn),
|
|
nPos(nPosIn)
|
|
{}
|
|
|
|
friend bool operator==(const FlatFilePos &a, const FlatFilePos &b) {
|
|
return (a.nFile == b.nFile && a.nPos == b.nPos);
|
|
}
|
|
|
|
friend bool operator!=(const FlatFilePos &a, const FlatFilePos &b) {
|
|
return !(a == b);
|
|
}
|
|
|
|
void SetNull() { nFile = -1; nPos = 0; }
|
|
bool IsNull() const { return (nFile == -1); }
|
|
|
|
std::string ToString() const;
|
|
};
|
|
|
|
/**
|
|
* FlatFileSeq represents a sequence of numbered files storing raw data. This class facilitates
|
|
* access to and efficient management of these files.
|
|
*/
|
|
class FlatFileSeq
|
|
{
|
|
private:
|
|
const fs::path m_dir;
|
|
const char* const m_prefix;
|
|
const size_t m_chunk_size;
|
|
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param dir The base directory that all files live in.
|
|
* @param prefix A short prefix given to all file names.
|
|
* @param chunk_size Disk space is pre-allocated in multiples of this amount.
|
|
*/
|
|
FlatFileSeq(fs::path dir, const char* prefix, size_t chunk_size);
|
|
|
|
/** Get the name of the file at the given position. */
|
|
fs::path FileName(const FlatFilePos& pos) const;
|
|
|
|
/** Open a handle to the file at the given position. */
|
|
FILE* Open(const FlatFilePos& pos, bool read_only = false);
|
|
|
|
/**
|
|
* Allocate additional space in a file after the given starting position. The amount allocated
|
|
* will be the minimum multiple of the sequence chunk size greater than add_size.
|
|
*
|
|
* @param[in] pos The starting position that bytes will be allocated after.
|
|
* @param[in] add_size The minimum number of bytes to be allocated.
|
|
* @param[out] out_of_space Whether the allocation failed due to insufficient disk space.
|
|
* @return The number of bytes successfully allocated.
|
|
*/
|
|
size_t Allocate(const FlatFilePos& pos, size_t add_size, bool& out_of_space);
|
|
|
|
/**
|
|
* Commit a file to disk, and optionally truncate off extra pre-allocated bytes if final.
|
|
*
|
|
* @param[in] pos The first unwritten position in the file to be flushed.
|
|
* @param[in] finalize True if no more data will be written to this file.
|
|
* @return true on success, false on failure.
|
|
*/
|
|
bool Flush(const FlatFilePos& pos, bool finalize = false);
|
|
};
|
|
|
|
#endif // BITCOIN_FLATFILE_H
|