Bitcoin Core  21.99.0
P2P Digital Currency
flatfile.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_FLATFILE_H
7 #define BITCOIN_FLATFILE_H
8 
9 #include <string>
10 
11 #include <fs.h>
12 #include <serialize.h>
13 
15 {
16  int nFile;
17  unsigned int nPos;
18 
20 
21  FlatFilePos() : nFile(-1), nPos(0) {}
22 
23  FlatFilePos(int nFileIn, unsigned int nPosIn) :
24  nFile(nFileIn),
25  nPos(nPosIn)
26  {}
27 
28  friend bool operator==(const FlatFilePos &a, const FlatFilePos &b) {
29  return (a.nFile == b.nFile && a.nPos == b.nPos);
30  }
31 
32  friend bool operator!=(const FlatFilePos &a, const FlatFilePos &b) {
33  return !(a == b);
34  }
35 
36  void SetNull() { nFile = -1; nPos = 0; }
37  bool IsNull() const { return (nFile == -1); }
38 
39  std::string ToString() const;
40 };
41 
47 {
48 private:
49  const fs::path m_dir;
50  const char* const m_prefix;
51  const size_t m_chunk_size;
52 
53 public:
61  FlatFileSeq(fs::path dir, const char* prefix, size_t chunk_size);
62 
64  fs::path FileName(const FlatFilePos& pos) const;
65 
67  FILE* Open(const FlatFilePos& pos, bool read_only = false);
68 
78  size_t Allocate(const FlatFilePos& pos, size_t add_size, bool& out_of_space);
79 
87  bool Flush(const FlatFilePos& pos, bool finalize = false);
88 };
89 
90 #endif // BITCOIN_FLATFILE_H
FlatFilePos::nFile
int nFile
Definition: flatfile.h:16
FlatFilePos::operator==
friend bool operator==(const FlatFilePos &a, const FlatFilePos &b)
Definition: flatfile.h:28
FlatFilePos::SetNull
void SetNull()
Definition: flatfile.h:36
fs.h
FlatFilePos::ToString
std::string ToString() const
Definition: flatfile.cpp:23
VARINT_MODE
#define VARINT_MODE(obj, mode)
Definition: serialize.h:442
FlatFileSeq::m_chunk_size
const size_t m_chunk_size
Definition: flatfile.h:51
FlatFileSeq::Allocate
size_t Allocate(const FlatFilePos &pos, size_t add_size, bool &out_of_space)
Allocate additional space in a file after the given starting position.
Definition: flatfile.cpp:55
FlatFilePos::IsNull
bool IsNull() const
Definition: flatfile.h:37
VarIntMode::NONNEGATIVE_SIGNED
@ NONNEGATIVE_SIGNED
FlatFilePos::SERIALIZE_METHODS
SERIALIZE_METHODS(FlatFilePos, obj)
Definition: flatfile.h:19
FlatFileSeq::m_dir
const fs::path m_dir
Definition: flatfile.h:49
FlatFilePos::FlatFilePos
FlatFilePos(int nFileIn, unsigned int nPosIn)
Definition: flatfile.h:23
prefix
const char * prefix
Definition: rest.cpp:711
FlatFileSeq
FlatFileSeq represents a sequence of numbered files storing raw data.
Definition: flatfile.h:46
FlatFileSeq::FlatFileSeq
FlatFileSeq(fs::path dir, const char *prefix, size_t chunk_size)
Constructor.
Definition: flatfile.cpp:13
FlatFileSeq::Open
FILE * Open(const FlatFilePos &pos, bool read_only=false)
Open a handle to the file at the given position.
Definition: flatfile.cpp:33
FlatFilePos
Definition: flatfile.h:14
VARINT
#define VARINT(obj)
Definition: serialize.h:443
FlatFilePos::operator!=
friend bool operator!=(const FlatFilePos &a, const FlatFilePos &b)
Definition: flatfile.h:32
READWRITE
#define READWRITE(...)
Definition: serialize.h:147
FlatFileSeq::FileName
fs::path FileName(const FlatFilePos &pos) const
Get the name of the file at the given position.
Definition: flatfile.cpp:28
FlatFilePos::FlatFilePos
FlatFilePos()
Definition: flatfile.h:21
FlatFileSeq::m_prefix
const char *const m_prefix
Definition: flatfile.h:50
serialize.h
FlatFilePos::nPos
unsigned int nPos
Definition: flatfile.h:17
FlatFileSeq::Flush
bool Flush(const FlatFilePos &pos, bool finalize=false)
Commit a file to disk, and optionally truncate off extra pre-allocated bytes if final.
Definition: flatfile.cpp:81