Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present 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_STREAMS_H
7 : : #define BITCOIN_STREAMS_H
8 : :
9 : : #include <serialize.h>
10 : : #include <span.h>
11 : : #include <support/allocators/zeroafterfree.h>
12 : : #include <util/check.h>
13 : : #include <util/log.h>
14 : : #include <util/obfuscation.h>
15 : : #include <util/overflow.h>
16 : : #include <util/syserror.h>
17 : :
18 : : #include <algorithm>
19 : : #include <cassert>
20 : : #include <cstddef>
21 : : #include <cstdint>
22 : : #include <cstdio>
23 : : #include <cstring>
24 : : #include <ios>
25 : : #include <limits>
26 : : #include <optional>
27 : : #include <string>
28 : : #include <vector>
29 : :
30 : : /* Minimal stream for overwriting and/or appending to an existing byte vector
31 : : *
32 : : * The referenced vector will grow as necessary
33 : : */
34 : : class VectorWriter
35 : : {
36 : : public:
37 : : /*
38 : : * @param[in] vchDataIn Referenced byte vector to overwrite/append
39 : : * @param[in] nPosIn Starting position. Vector index where writes should start. The vector will initially
40 : : * grow as necessary to max(nPosIn, vec.size()). So to append, use vec.size().
41 : : */
42 : 640107 : VectorWriter(std::vector<unsigned char>& vchDataIn, size_t nPosIn) : vchData{vchDataIn}, nPos{nPosIn}
43 : : {
44 [ - + - + ]: 640107 : if(nPos > vchData.size())
45 : 0 : vchData.resize(nPos);
46 : 640107 : }
47 : : /*
48 : : * (other params same as above)
49 : : * @param[in] args A list of items to serialize starting at nPosIn.
50 : : */
51 : : template <typename... Args>
52 [ + - + - : 550282 : VectorWriter(std::vector<unsigned char>& vchDataIn, size_t nPosIn, Args&&... args) : VectorWriter{vchDataIn, nPosIn}
+ - - - -
- - - + -
+ - - - -
- - - - -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - ][ + - ]
[ + - + -
# # ][ + -
+ - + - ]
53 : : {
54 [ + - + - : 550282 : ::SerializeMany(*this, std::forward<Args>(args)...);
+ - - - -
- - - + -
+ - - - -
- - - - -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - ][ + - ]
[ + - + -
# # ][ + -
+ - + - ]
55 : 205932 : }
56 : 6817696 : void write(std::span<const std::byte> src)
57 : : {
58 [ - + - + ]: 6817696 : assert(nPos <= vchData.size());
59 [ + + ]: 6817696 : size_t nOverwrite = std::min(src.size(), vchData.size() - nPos);
60 [ - + ]: 6817696 : if (nOverwrite) {
61 : 0 : memcpy(vchData.data() + nPos, src.data(), nOverwrite);
62 : : }
63 [ + + ]: 6817696 : if (nOverwrite < src.size()) {
64 : 6759677 : vchData.insert(vchData.end(), UCharCast(src.data()) + nOverwrite, UCharCast(src.data() + src.size()));
65 : : }
66 : 6817696 : nPos += src.size();
67 : 6817696 : }
68 : : template <typename T>
69 : 1873855 : VectorWriter& operator<<(const T& obj)
70 : : {
71 [ + - + - : 1761611 : ::Serialize(*this, obj);
+ - + - +
- + - +
- ][ + - +
- + - + -
# # # # #
# ][ + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - ]
72 : 164469 : return (*this);
73 : : }
74 : :
75 : : private:
76 : : std::vector<unsigned char>& vchData;
77 : : size_t nPos;
78 : : };
79 : :
80 : : /** Minimal stream for reading from an existing byte array by std::span.
81 : : */
82 : : class SpanReader
83 : : {
84 : : private:
85 : : std::span<const std::byte> m_data;
86 : :
87 : : public:
88 : : /**
89 : : * @param[in] data Referenced byte vector to overwrite/append
90 : : */
91 : 2324078 : explicit SpanReader(std::span<const unsigned char> data) : m_data{std::as_bytes(data)} {}
92 [ + + + - ]: 4451506 : explicit SpanReader(std::span<const std::byte> data) : m_data{data} {}
[ + + # # ]
93 : :
94 : : template<typename T>
95 : 34476910 : SpanReader& operator>>(T&& obj)
96 : : {
97 [ + + + - : 34461482 : ::Unserialize(*this, obj);
+ - + - +
- ][ + + #
# # # # #
# # ][ + +
+ + + + +
+ ][ + + +
+ # # #
# ][ - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - +
+ ][ + + +
+ + + ][ +
+ + + + +
+ + + + +
+ + - + -
+ - + + +
- + + + -
+ - + + +
- + + + +
+ + + + +
- + + + -
+ - + - +
- + - + +
+ + + - +
+ + + # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ - - + +
+ - + + +
+ + + + +
+ + + + +
- + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + -
+ - + + +
+ + - + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
- - - - -
- + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + ][ -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- + + - -
- - - - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
98 : 20980642 : return (*this);
99 : : }
100 : :
101 [ + + + + : 248314 : size_t size() const { return m_data.size(); }
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + ]
102 [ + + ]: 2295462 : bool empty() const { return m_data.empty(); }
[ + + + + ]
[ - - - -
- - - - -
- - - - -
- - - - +
+ ][ + + +
+ + + + +
+ + + + +
+ + + +
+ ]
103 : :
104 : 300701488 : void read(std::span<std::byte> dst)
105 : : {
106 [ + + ]: 300701488 : if (dst.size() == 0) {
107 : : return;
108 : : }
109 : :
110 : : // Read from the beginning of the buffer
111 [ + + ]: 296512876 : if (dst.size() > m_data.size()) {
112 [ + - ]: 742172 : throw std::ios_base::failure("SpanReader::read(): end of data");
113 : : }
114 : 296141790 : memcpy(dst.data(), m_data.data(), dst.size());
115 : 296141790 : m_data = m_data.subspan(dst.size());
116 : : }
117 : :
118 : 2921 : void ignore(size_t n)
119 : : {
120 [ + + ]: 2921 : if (n > m_data.size()) {
121 [ + - ]: 1778 : throw std::ios_base::failure("SpanReader::ignore(): end of data");
122 : : }
123 : 2032 : m_data = m_data.subspan(n);
124 : 2032 : }
125 : : };
126 : :
127 : : /** Minimal stream for writing to an existing span of bytes.
128 : : */
129 : : class SpanWriter
130 : : {
131 : : private:
132 : : std::span<std::byte> m_dest;
133 : :
134 : : public:
135 : : explicit SpanWriter(std::span<std::byte> dest) : m_dest{dest} {}
136 : : template <typename... Args>
137 : : SpanWriter(std::span<std::byte> dest, Args&&... args) : SpanWriter{dest}
138 : : {
139 : : ::SerializeMany(*this, std::forward<Args>(args)...);
140 : : }
141 : :
142 : : void write(std::span<const std::byte> src)
143 : : {
144 : : if (src.size() > m_dest.size()) {
145 : : throw std::ios_base::failure("SpanWriter::write(): exceeded buffer size");
146 : : }
147 : : memcpy(m_dest.data(), src.data(), src.size());
148 : : m_dest = m_dest.subspan(src.size());
149 : : }
150 : :
151 : : template<typename T>
152 : : SpanWriter& operator<<(const T& obj)
153 : : {
154 : : ::Serialize(*this, obj);
155 : : return *this;
156 : : }
157 : : };
158 : :
159 : : /** Double ended buffer combining vector and stream-like interfaces.
160 : : *
161 : : * >> and << read and write unformatted data using the above serialization templates.
162 : : * Fills with data in linear time; some stringstream implementations take N^2 time.
163 : : */
164 [ + + + - ]: 29847568 : class DataStream
[ + - ][ - -
- - - - ]
165 : : {
166 : : protected:
167 : : using vector_type = SerializeData;
168 : : vector_type vch;
169 : : vector_type::size_type m_read_pos{0};
170 : :
171 : : public:
172 : : typedef vector_type::allocator_type allocator_type;
173 : : typedef vector_type::size_type size_type;
174 : : typedef vector_type::difference_type difference_type;
175 : : typedef vector_type::reference reference;
176 : : typedef vector_type::const_reference const_reference;
177 : : typedef vector_type::value_type value_type;
178 : : typedef vector_type::iterator iterator;
179 : : typedef vector_type::const_iterator const_iterator;
180 : : typedef vector_type::reverse_iterator reverse_iterator;
181 : :
182 : : explicit DataStream() = default;
183 : 9550 : explicit DataStream(std::span<const uint8_t> sp) : DataStream{std::as_bytes(sp)} {}
184 : 4414016 : explicit DataStream(std::span<const value_type> sp) : vch(sp.data(), sp.data() + sp.size()) {}
185 : :
186 : 357 : std::string str() const
187 : : {
188 : 1071 : return std::string{UCharCast(data()), UCharCast(data() + size())};
189 : : }
190 : :
191 : : //
192 : : // Vector subset
193 : : //
194 : : const_iterator begin() const { return vch.begin() + m_read_pos; }
195 : 93737 : iterator begin() { return vch.begin() + m_read_pos; }
196 : : const_iterator end() const { return vch.end(); }
197 [ + - ]: 84091 : iterator end() { return vch.end(); }
[ # # # # ]
198 [ - + + + : 40695854 : size_type size() const { return vch.size() - m_read_pos; }
- + + + -
+ + - - +
+ - - + +
+ - + + +
+ + + + +
+ + + +
- ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ - + + +
- + + + #
# # # # #
# # ][ - +
+ - - + -
+ - + +
- ][ - + +
- - + + -
- + + - -
+ + - ][ -
- - - - -
- + + - -
+ + - - -
- - # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# ][ - + -
+ + - - +
- + + - -
+ - + - +
- + - - -
+ + - - +
+ - - + +
- - + + -
- - - - ]
[ - + + +
# # # # #
# ][ - - -
- - + # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ][ #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # # # #
# ][ - + #
# # # # #
# # # # #
# ][ - + -
+ + + - +
- + ]
199 [ - + + + : 56732 : bool empty() const { return vch.size() == m_read_pos; }
- + + + -
+ + + - +
+ + ][ - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ ][ - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + -
+ ][ - + -
+ - + -
+ ]
200 : 601512 : void resize(size_type n, value_type c = value_type{}) { vch.resize(n + m_read_pos, c); }
201 [ + - + - : 24089046 : void reserve(size_type n) { vch.reserve(n + m_read_pos); }
+ - + - +
- ][ + - +
- + - + -
+ - + - +
- - - ][ +
- # # # #
# # # # #
# # # #
# ][ # # #
# # # # #
# # # # ]
[ # # # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ + -
+ - - - -
- - - - -
- - - - +
- + - + -
+ - + - +
- - - - -
- - + - +
- - - + -
+ - - - -
- + - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - + -
+ - - - -
- - - - -
- - - - ]
202 : : const_reference operator[](size_type pos) const { return vch[pos + m_read_pos]; }
203 [ + + ]: 3425276 : reference operator[](size_type pos) { return vch[pos + m_read_pos]; }
204 [ + - + - : 59287243 : void clear() { vch.clear(); m_read_pos = 0; }
+ - + - +
- + - + -
+ - + - +
- + - ][ +
- + - + -
+ - + - +
- + - - -
# # # # #
# ][ + + +
+ # # # #
# # # # #
# # # ][ #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # ][ # #
# # # # ]
205 [ - + - + : 45934915 : value_type* data() { return vch.data() + m_read_pos; }
- + - + -
+ - + - +
- + - + -
+ - + - +
# # ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ - + - +
- + - + ]
[ - + - +
- + - + -
+ - + - +
- + - - -
+ - + - +
- + - - ]
[ - + - +
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # # # #
# # # # #
# # ][ - -
- - - + -
+ - - ][ -
+ # # # #
# # # # ]
[ - + - +
- + - + -
+ - + - +
- + ][ - +
- + - + #
# # # # #
# # # # ]
206 [ - + ]: 64501 : const value_type* data() const { return vch.data() + m_read_pos; }
207 : :
208 : : //
209 : : // Stream subset
210 : : //
211 : 158087391 : void read(std::span<value_type> dst)
212 : : {
213 [ + + ]: 158087391 : if (dst.size() == 0) return;
214 : :
215 : : // Read from the beginning of the buffer
216 [ + - ]: 158073408 : auto next_read_pos{CheckedAdd(m_read_pos, dst.size())};
217 [ + - - + : 158073408 : if (!next_read_pos.has_value() || next_read_pos.value() > vch.size()) {
+ + ]
218 [ + - ]: 19572 : throw std::ios_base::failure("DataStream::read(): end of data");
219 : : }
220 [ - + ]: 158063622 : memcpy(dst.data(), &vch[m_read_pos], dst.size());
221 [ - + + + ]: 158063622 : if (next_read_pos.value() == vch.size()) {
222 : : // If fully consumed, reset to empty state.
223 [ + - ]: 17422752 : clear();
224 : 17422752 : return;
225 : : }
226 : 140640870 : m_read_pos = next_read_pos.value();
227 : : }
228 : :
229 : 603669 : void ignore(size_t num_ignore)
230 : : {
231 : : // Ignore from the beginning of the buffer
232 : 603669 : auto next_read_pos{CheckedAdd(m_read_pos, num_ignore)};
233 [ + - - + : 603669 : if (!next_read_pos.has_value() || next_read_pos.value() > vch.size()) {
+ + ]
234 [ + - ]: 4140 : throw std::ios_base::failure("DataStream::ignore(): end of data");
235 : : }
236 [ + + ]: 601599 : if (next_read_pos.value() == vch.size()) {
237 : : // If all bytes are ignored, reset to empty state.
238 [ + + ]: 379 : clear();
239 : 379 : return;
240 : : }
241 : 601220 : m_read_pos = next_read_pos.value();
242 : : }
243 : :
244 : 256355213 : void write(std::span<const value_type> src)
245 : : {
246 : : // Write to the end of the buffer
247 : 256355213 : vch.insert(vch.end(), src.begin(), src.end());
248 : 256355213 : }
249 : :
250 : : template<typename T>
251 : 89468488 : DataStream& operator<<(const T& obj)
252 : : {
253 [ + - + - : 80591716 : ::Serialize(*this, obj);
+ - + - +
- # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ - - -
- - - - -
- - - - -
- - - - -
- - - - +
- + - - -
- - - - -
- - - - -
+ - + - +
- + - + -
+ - - - -
- - - + -
+ - - - +
- + - - -
- - + - +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - +
- + - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ + - + -
+ - + - +
- + - + -
+ - + - +
- + - ][ +
- + - # #
# # # # #
# # # # #
# # # # #
# ][ + - #
# # # # #
# # # # ]
[ # # # #
# # # # #
# # # ][ -
- - - - -
- - - - -
- - - - -
+ - + - +
- + - + -
+ - + - +
- + - ][ #
# # # # #
# # # # #
# # # # #
# # ][ + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - +
- ][ - - -
- - - - -
- - - - -
- - - + -
+ - + - +
- ]
254 : 15244808 : return (*this);
255 : : }
256 : :
257 : : template <typename T>
258 : 31045362 : DataStream& operator>>(T&& obj)
259 : : {
260 [ + + ]: 31010546 : ::Unserialize(*this, obj);
[ + + + + ]
[ + - + +
+ + + + +
+ + + + +
+ + + - +
+ + + + +
+ + + + +
+ + + + +
- - + + +
+ + + + +
+ + + + +
+ ][ + - +
- + - + -
+ - ][ + -
+ - + - +
- + - + -
+ - + - +
- + - +
- ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
261 : 9549486 : return (*this);
262 : : }
263 : :
264 : : /** Compute total memory usage of this object (own memory + any dynamic memory). */
265 : : size_t GetMemoryUsage() const noexcept;
266 : : };
267 : :
268 : : template <typename IStream>
269 : : class BitStreamReader
270 : : {
271 : : private:
272 : : IStream& m_istream;
273 : :
274 : : /// Buffered byte read in from the input stream. A new byte is read into the
275 : : /// buffer when m_offset reaches 8.
276 : : uint8_t m_buffer{0};
277 : :
278 : : /// Number of high order bits in m_buffer already returned by previous
279 : : /// Read() calls. The next bit to be returned is at this offset from the
280 : : /// most significant bit position.
281 : : int m_offset{8};
282 : :
283 : : public:
284 [ + - ]: 1735 : explicit BitStreamReader(IStream& istream) : m_istream(istream) {}
285 : :
286 : : /** Read the specified number of bits from the stream. The data is returned
287 : : * in the nbits least significant bits of a 64-bit uint.
288 : : */
289 : 2141226 : uint64_t Read(int nbits) {
290 [ + - ]: 2141226 : if (nbits < 0 || nbits > 64) {
291 [ # # ]: 0 : throw std::out_of_range("nbits must be between 0 and 64");
292 : : }
293 : :
294 : : uint64_t data = 0;
295 [ + + ]: 6286730 : while (nbits > 0) {
296 [ + + ]: 4158232 : if (m_offset == 8) {
297 : 2421408 : m_istream >> m_buffer;
298 : 2408680 : m_offset = 0;
299 : : }
300 : :
301 [ + + ]: 4145504 : int bits = std::min(8 - m_offset, nbits);
302 : 4145504 : data <<= bits;
303 : 4145504 : data |= static_cast<uint8_t>(m_buffer << m_offset) >> (8 - bits);
304 : 4145504 : m_offset += bits;
305 : 4145504 : nbits -= bits;
306 : : }
307 : 2128498 : return data;
308 : : }
309 : : };
310 : :
311 : : template <typename OStream>
312 : : class BitStreamWriter
313 : : {
314 : : private:
315 : : OStream& m_ostream;
316 : :
317 : : /// Buffered byte waiting to be written to the output stream. The byte is
318 : : /// written buffer when m_offset reaches 8 or Flush() is called.
319 : : uint8_t m_buffer{0};
320 : :
321 : : /// Number of high order bits in m_buffer already written by previous
322 : : /// Write() calls and not yet flushed to the stream. The next bit to be
323 : : /// written to is at this offset from the most significant bit position.
324 : : int m_offset{0};
325 : :
326 : : public:
327 [ + + ]: 263 : explicit BitStreamWriter(OStream& ostream) : m_ostream(ostream) {}
328 : :
329 : 263 : ~BitStreamWriter()
330 : : {
331 : 263 : Flush();
332 : 263 : }
333 : :
334 : : /** Write the nbits least significant bits of a 64-bit int to the output
335 : : * stream. Data is buffered until it completes an octet.
336 : : */
337 : 93811 : void Write(uint64_t data, int nbits) {
338 [ + - ]: 93811 : if (nbits < 0 || nbits > 64) {
339 [ # # ]: 0 : throw std::out_of_range("nbits must be between 0 and 64");
340 : : }
341 : :
342 [ + + ]: 274228 : while (nbits > 0) {
343 [ + + ]: 180417 : int bits = std::min(8 - m_offset, nbits);
344 : 180417 : m_buffer |= (data << (64 - nbits)) >> (64 - 8 + m_offset);
345 : 180417 : m_offset += bits;
346 : 180417 : nbits -= bits;
347 : :
348 [ + + ]: 180417 : if (m_offset == 8) {
349 : 98235 : Flush();
350 : : }
351 : : }
352 : 93811 : }
353 : :
354 : : /** Flush any unwritten bits to the output stream, padding with 0's to the
355 : : * next byte boundary.
356 : : */
357 : 98761 : void Flush() {
358 [ + + ]: 98761 : if (m_offset == 0) {
359 : : return;
360 : : }
361 : :
362 : 98435 : m_ostream << m_buffer;
363 : 98435 : m_buffer = 0;
364 : 98435 : m_offset = 0;
365 : : }
366 : : };
367 : :
368 : : /** Non-refcounted RAII wrapper for FILE*
369 : : *
370 : : * Will automatically close the file when it goes out of scope if not null.
371 : : * If you're returning the file pointer, return file.release().
372 : : * If you need to close the file early, use autofile.fclose() instead of fclose(underlying_FILE).
373 : : *
374 : : * @note If the file has been written to, then the caller must close it
375 : : * explicitly with the `fclose()` method, check if it returns an error and treat
376 : : * such an error as if the `write()` method failed. The OS's `fclose(3)` may
377 : : * fail to flush to disk data that has been previously written, rendering the
378 : : * file corrupt.
379 : : */
380 : : class AutoFile
381 : : {
382 : : protected:
383 : : std::FILE* m_file;
384 : : Obfuscation m_obfuscation;
385 : : std::optional<int64_t> m_position;
386 : : bool m_was_written{false};
387 : :
388 : : public:
389 : : explicit AutoFile(std::FILE* file, const Obfuscation& obfuscation = {});
390 : :
391 : 392826 : ~AutoFile()
392 : : {
393 [ + + ]: 392826 : if (m_was_written) {
394 : : // Callers that wrote to the file must have closed it explicitly
395 : : // with the fclose() method and checked that the close succeeded.
396 : : // This is because here in the destructor we have no way to signal
397 : : // errors from fclose() which, after write, could mean the file is
398 : : // corrupted and must be handled properly at the call site.
399 : : // Destructors in C++ cannot signal an error to the callers because
400 : : // they do not return a value and are not allowed to throw exceptions.
401 : 750104 : Assume(IsNull());
402 : : }
403 : :
404 [ + + ]: 14529 : if (fclose() != 0) {
405 : 2174 : LogError("Failed to close file: %s", SysErrorString(errno));
406 : : }
407 : 392826 : }
408 : :
409 : : // Disallow copies
410 : : AutoFile(const AutoFile&) = delete;
411 : : AutoFile& operator=(const AutoFile&) = delete;
412 : :
413 : 10788 : bool feof() const { return std::feof(m_file); }
414 : :
415 : 752723 : [[nodiscard]] int fclose()
416 : : {
417 [ + - ][ + - : 373959 : if (auto rel{release()}) return std::fclose(rel);
+ - + - ]
[ + - + - ]
418 : : return 0;
419 : : }
420 : :
421 : : /** Get wrapped FILE* with transfer of ownership.
422 : : * @note This will invalidate the AutoFile object, and makes it the responsibility of the caller
423 : : * of this function to clean up the returned FILE*.
424 : : */
425 : 752747 : std::FILE* release()
426 : : {
427 : 752747 : std::FILE* ret{m_file};
428 : 752747 : m_file = nullptr;
429 [ # # ][ + + : 752747 : return ret;
+ + + + ]
[ + - - -
# # ][ + -
+ - + - -
- ][ # # #
# # # # #
# # ]
430 : : }
431 : :
432 : : /** Return true if the wrapped FILE* is nullptr, false otherwise.
433 : : */
434 [ + + + + : 1135475 : bool IsNull() const { return m_file == nullptr; }
+ + ]
[ + + - - ]
[ - - - -
- + + + -
+ - - -
- ][ # # #
# # # # #
# # # # #
# ][ - + #
# # # # #
# # ]
435 : :
436 : : /** Continue with a different XOR key */
437 : 1506 : void SetObfuscation(const Obfuscation& obfuscation) { m_obfuscation = obfuscation; }
438 : :
439 : : /** Implementation detail, only used internally. */
440 : : std::size_t detail_fread(std::span<std::byte> dst);
441 : :
442 : : /** Wrapper around fseek(). Will throw if seeking is not possible. */
443 : : void seek(int64_t offset, int origin);
444 : :
445 : : /** Find position within the file. Will throw if unknown. */
446 : : int64_t tell();
447 : :
448 : : /** Return the size of the file. Will throw if unknown. */
449 : : int64_t size();
450 : :
451 : : /** Wrapper around FileCommit(). */
452 : : bool Commit();
453 : :
454 : : /** Wrapper around TruncateFile(). */
455 : : bool Truncate(unsigned size);
456 : :
457 : : //! Write a mutable buffer more efficiently than write(), obfuscating the buffer in-place.
458 : : void write_buffer(std::span<std::byte> src);
459 : :
460 : : //
461 : : // Stream subset
462 : : //
463 : : void read(std::span<std::byte> dst);
464 : : void ignore(size_t nSize);
465 : : void write(std::span<const std::byte> src);
466 : :
467 : : template <typename T>
468 : 1381882 : AutoFile& operator<<(const T& obj)
469 : : {
470 [ + - + + : 1376115 : ::Serialize(*this, obj);
+ - + + -
- - - - -
+ + + - ]
[ + - # #
# # # # #
# # # # #
# # # # ]
[ + + + + ]
[ # # # #
# # ][ + +
+ - + - +
- + - + -
+ - ][ # #
# # # # #
# ][ - - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - ]
471 : 316549 : return *this;
472 : : }
473 : :
474 : : template <typename T>
475 : 5267484 : AutoFile& operator>>(T&& obj)
476 : : {
477 [ + + + + : 5253725 : ::Unserialize(*this, obj);
+ + + + ]
[ # # # #
# # # # #
# # # # #
# # # # ]
[ + + + +
+ + + + +
+ + + + +
+ + + + ]
[ + - + -
+ - ][ + +
+ + + + +
+ + + ]
[ + + + + ]
[ - - + +
+ + + + +
- + + + +
+ - + - -
- + - - -
- - ]
478 : 2954310 : return *this;
479 : : }
480 : : };
481 : :
482 : : using DataBuffer = std::vector<std::byte>;
483 : :
484 : : /** Wrapper around an AutoFile& that implements a ring buffer to
485 : : * deserialize from. It guarantees the ability to rewind a given number of bytes.
486 : : *
487 : : * Will automatically close the file when it goes out of scope if not null.
488 : : * If you need to close the file early, use file.fclose() instead of fclose(file).
489 : : */
490 : 830 : class BufferedFile
491 : : {
492 : : private:
493 : : AutoFile& m_src;
494 : : uint64_t nSrcPos{0}; //!< how many bytes have been read from source
495 : : uint64_t m_read_pos{0}; //!< how many bytes have been read from this
496 : : uint64_t nReadLimit; //!< up to which position we're allowed to read
497 : : uint64_t nRewind; //!< how many bytes we guarantee to rewind
498 : : DataBuffer vchBuf;
499 : :
500 : : //! read data from the source to fill the buffer
501 : 282291 : bool Fill() {
502 [ - + ]: 282291 : unsigned int pos = nSrcPos % vchBuf.size();
503 : 282291 : unsigned int readNow = vchBuf.size() - pos;
504 : 282291 : unsigned int nAvail = vchBuf.size() - (nSrcPos - m_read_pos) - nRewind;
505 [ + + ]: 282291 : if (nAvail < readNow)
506 : 262956 : readNow = nAvail;
507 [ + - ]: 282291 : if (readNow == 0)
508 : : return false;
509 : 282291 : size_t nBytes{m_src.detail_fread(std::span{vchBuf}.subspan(pos, readNow))};
510 [ + + ]: 282058 : if (nBytes == 0) {
511 [ + + + - ]: 6740 : throw std::ios_base::failure{m_src.feof() ? "BufferedFile::Fill: end of file" : "BufferedFile::Fill: fread failed"};
512 : : }
513 : 278688 : nSrcPos += nBytes;
514 : 278688 : return true;
515 : : }
516 : :
517 : : //! Advance the stream's read pointer (m_read_pos) by up to 'length' bytes,
518 : : //! filling the buffer from the file so that at least one byte is available.
519 : : //! Return a pointer to the available buffer data and the number of bytes
520 : : //! (which may be less than the requested length) that may be accessed
521 : : //! beginning at that pointer.
522 : 5990407 : std::pair<std::byte*, size_t> AdvanceStream(size_t length)
523 : : {
524 [ - + ]: 5990407 : assert(m_read_pos <= nSrcPos);
525 [ + + ]: 5990407 : if (m_read_pos + length > nReadLimit) {
526 [ + - ]: 37442 : throw std::ios_base::failure("Attempt to position past buffer limit");
527 : : }
528 : : // If there are no bytes available, read from the file.
529 [ + + + - ]: 5971686 : if (m_read_pos == nSrcPos && length > 0) Fill();
530 : :
531 [ - + ]: 5968691 : size_t buffer_offset{static_cast<size_t>(m_read_pos % vchBuf.size())};
532 : 5968691 : size_t buffer_available{static_cast<size_t>(vchBuf.size() - buffer_offset)};
533 : 5968691 : size_t bytes_until_source_pos{static_cast<size_t>(nSrcPos - m_read_pos)};
534 : 5968691 : size_t advance{std::min({length, buffer_available, bytes_until_source_pos})};
535 : 5968691 : m_read_pos += advance;
536 : 5968691 : return std::make_pair(&vchBuf[buffer_offset], advance);
537 : : }
538 : :
539 : : public:
540 : 843 : BufferedFile(AutoFile& file LIFETIMEBOUND, uint64_t nBufSize, uint64_t nRewindIn)
541 : 843 : : m_src{file}, nReadLimit{std::numeric_limits<uint64_t>::max()}, nRewind{nRewindIn}, vchBuf(nBufSize, std::byte{0})
542 : : {
543 [ + + ]: 843 : if (nRewindIn >= nBufSize)
544 [ + - ]: 26 : throw std::ios_base::failure("Rewind limit must be less than buffer size");
545 : 843 : }
546 : :
547 : : //! check whether we're at the end of the source file
548 : 1958505 : bool eof() const {
549 [ + + + + ]: 1958505 : return m_read_pos == nSrcPos && m_src.feof();
550 : : }
551 : :
552 : : //! read a number of bytes
553 : 5501708 : void read(std::span<std::byte> dst)
554 : : {
555 [ + + ]: 11209325 : while (dst.size() > 0) {
556 : 5728277 : auto [buffer_pointer, length]{AdvanceStream(dst.size())};
557 : 5707617 : memcpy(dst.data(), buffer_pointer, length);
558 : 5707617 : dst = dst.subspan(length);
559 : : }
560 : 5481048 : }
561 : :
562 : : //! Move the read position ahead in the stream to the given position.
563 : : //! Use SetPos() to back up in the stream, not SkipTo().
564 : 264482 : void SkipTo(const uint64_t file_pos)
565 : : {
566 [ + - ]: 264482 : assert(file_pos >= m_read_pos);
567 [ + + ]: 525556 : while (m_read_pos < file_pos) AdvanceStream(file_pos - m_read_pos);
568 : 263426 : }
569 : :
570 : : //! return the current reading position
571 : 2286076 : uint64_t GetPos() const {
572 [ + + + + : 2286076 : return m_read_pos;
+ - ]
573 : : }
574 : :
575 : : //! rewind to a given reading position
576 : 2048680 : bool SetPos(uint64_t nPos) {
577 [ - + ]: 2048680 : size_t bufsize = vchBuf.size();
578 [ + + ]: 2048680 : if (nPos + bufsize < nSrcPos) {
579 : : // rewinding too far, rewind as far as possible
580 : 386 : m_read_pos = nSrcPos - bufsize;
581 : 386 : return false;
582 : : }
583 [ + + ]: 2048294 : if (nPos > nSrcPos) {
584 : : // can't go this far forward, go as far as possible
585 : 1122 : m_read_pos = nSrcPos;
586 : 1122 : return false;
587 : : }
588 : 2047172 : m_read_pos = nPos;
589 : 2047172 : return true;
590 : : }
591 : :
592 : : //! prevent reading beyond a certain position
593 : : //! no argument removes the limit
594 : 2224081 : bool SetLimit(uint64_t nPos = std::numeric_limits<uint64_t>::max()) {
595 [ + + ]: 265804 : if (nPos < m_read_pos)
596 : : return false;
597 : 2223873 : nReadLimit = nPos;
598 [ + + ]: 2223873 : return true;
599 : : }
600 : :
601 : : template<typename T>
602 : 2643474 : BufferedFile& operator>>(T&& obj) {
603 [ + + + + : 2643474 : ::Unserialize(*this, obj);
+ + + + ]
[ + + + + ]
604 : 2603270 : return (*this);
605 : : }
606 : :
607 : : //! search for a given byte in the stream, and remain positioned on it
608 : 1959444 : void FindByte(std::byte byte)
609 : : {
610 : : // For best performance, avoid mod operation within the loop.
611 [ - + ]: 1959444 : size_t buf_offset{size_t(m_read_pos % uint64_t(vchBuf.size()))};
612 : 2003669 : while (true) {
613 [ + + ]: 2003669 : if (m_read_pos == nSrcPos) {
614 : : // No more bytes available; read from the file into the buffer,
615 : : // setting nSrcPos to one beyond the end of the new data.
616 : : // Throws exception if end-of-file reached.
617 : 46006 : Fill();
618 : : }
619 [ - + + + ]: 2003061 : const size_t len{std::min<size_t>(vchBuf.size() - buf_offset, nSrcPos - m_read_pos)};
620 [ + + ]: 2003061 : const auto it_start{vchBuf.begin() + buf_offset};
621 : 2003061 : const auto it_find{std::find(it_start, it_start + len, byte)};
622 [ + + ]: 2003061 : const size_t inc{size_t(std::distance(it_start, it_find))};
623 : 2003061 : m_read_pos += inc;
624 [ + + ]: 2003061 : if (inc < len) break;
625 : 44225 : buf_offset += inc;
626 [ + + ]: 44225 : if (buf_offset >= vchBuf.size()) buf_offset = 0;
627 : : }
628 : 1958836 : }
629 : : };
630 : :
631 : : /**
632 : : * Wrapper that buffers reads from an underlying stream.
633 : : * Requires underlying stream to support read() and detail_fread() calls
634 : : * to support fixed-size and variable-sized reads, respectively.
635 : : */
636 : : template <typename S>
637 : 0 : class BufferedReader
638 : : {
639 : : S& m_src;
640 : : DataBuffer m_buf;
641 : : size_t m_buf_pos;
642 : :
643 : : public:
644 : : //! Requires stream ownership to prevent leaving the stream at an unexpected position after buffered reads.
645 : 0 : explicit BufferedReader(S&& stream LIFETIMEBOUND, size_t size = 1 << 16)
646 : : requires std::is_rvalue_reference_v<S&&>
647 [ # # # # ]: 0 : : m_src{stream}, m_buf(size), m_buf_pos{size} {}
648 : :
649 : 0 : void read(std::span<std::byte> dst)
650 : : {
651 [ # # # # : 0 : if (const auto available{std::min(dst.size(), m_buf.size() - m_buf_pos)}) {
# # ]
652 : 0 : std::copy_n(m_buf.begin() + m_buf_pos, available, dst.begin());
653 : 0 : m_buf_pos += available;
654 : 0 : dst = dst.subspan(available);
655 : : }
656 [ # # ]: 0 : if (dst.size()) {
657 [ # # # # ]: 0 : assert(m_buf_pos == m_buf.size());
658 : 0 : m_src.read(dst);
659 : :
660 : 0 : m_buf_pos = 0;
661 [ # # ]: 0 : m_buf.resize(m_src.detail_fread(m_buf));
662 : : }
663 : 0 : }
664 : :
665 : : template <typename T>
666 : 0 : BufferedReader& operator>>(T&& obj)
667 : : {
668 [ # # ]: 0 : Unserialize(*this, obj);
669 : 0 : return *this;
670 : : }
671 : : };
672 : :
673 : : /**
674 : : * Wrapper that buffers writes to an underlying stream.
675 : : * Requires underlying stream to support write_buffer() method
676 : : * for efficient buffer flushing and obfuscation.
677 : : */
678 : : template <typename S>
679 : : class BufferedWriter
680 : : {
681 : : S& m_dst;
682 : : DataBuffer m_buf;
683 : : size_t m_buf_pos{0};
684 : :
685 : : public:
686 [ + - + - : 354183 : explicit BufferedWriter(S& stream LIFETIMEBOUND, size_t size = 1 << 16) : m_dst{stream}, m_buf(size) {}
+ - + - ]
687 : :
688 [ + - + - ]: 354183 : ~BufferedWriter() { flush(); }
689 : :
690 : 354183 : void flush()
691 : : {
692 [ + - - + ]: 354183 : if (m_buf_pos) m_dst.write_buffer(std::span{m_buf}.first(m_buf_pos));
693 : 354183 : m_buf_pos = 0;
694 : 354183 : }
695 : :
696 : 6081451 : void write(std::span<const std::byte> src)
697 : : {
698 [ - + + - : 24325804 : while (const auto available{std::min(src.size(), m_buf.size() - m_buf_pos)}) {
+ + ]
699 : 6081451 : std::copy_n(src.begin(), available, m_buf.begin() + m_buf_pos);
700 : 6081451 : m_buf_pos += available;
701 [ - + - + ]: 6081451 : if (m_buf_pos == m_buf.size()) flush();
702 : 6081451 : src = src.subspan(available);
703 : : }
704 : 6081451 : }
705 : :
706 : : template <typename T>
707 : 1408415 : BufferedWriter& operator<<(const T& obj)
708 : : {
709 [ - - + - : 1054232 : Serialize(*this, obj);
+ - + - +
- + - + -
+ - + - +
- ]
710 : 709142 : return *this;
711 : : }
712 : : };
713 : :
714 : : #endif // BITCOIN_STREAMS_H
|
