Coverage Report

Created: 2026-08-14 20:23

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/streams.cpp
Line
Count
Source
1
// Copyright (c) 2009-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or https://opensource.org/license/mit/.
4
5
#include <memusage.h>
6
#include <span.h>
7
#include <streams.h>
8
#include <util/fs_helpers.h>
9
#include <util/obfuscation.h>
10
11
#include <array>
12
13
442k
AutoFile::AutoFile(std::FILE* file, const Obfuscation& obfuscation) : m_file{file}, m_obfuscation{obfuscation}
14
442k
{
15
442k
    if (!IsNull()) {
16
440k
        auto pos{std::ftell(m_file)};
17
440k
        if (pos >= 0) m_position = pos;
18
440k
    }
19
442k
}
20
21
std::size_t AutoFile::detail_fread(std::span<std::byte> dst)
22
23.6M
{
23
23.6M
    if (!m_file) throw std::ios_base::failure("AutoFile::read: file handle is nullptr");
24
23.6M
    const size_t ret = std::fread(dst.data(), 1, dst.size(), m_file);
25
23.6M
    if (m_obfuscation) {
26
587k
        if (!m_position) throw std::ios_base::failure("AutoFile::read: position unknown");
27
587k
        m_obfuscation(dst.subspan(0, ret), *m_position);
28
587k
    }
29
23.6M
    if (m_position) *m_position += ret;
30
23.6M
    return ret;
31
23.6M
}
32
33
void AutoFile::seek(int64_t offset, int origin)
34
5.22k
{
35
5.22k
    if (IsNull()) {
36
0
        throw std::ios_base::failure("AutoFile::seek: file handle is nullptr");
37
0
    }
38
5.22k
    if (std::fseek(m_file, offset, origin) != 0) {
39
0
        throw std::ios_base::failure(feof() ? "AutoFile::seek: end of file" : "AutoFile::seek: fseek failed");
40
0
    }
41
5.22k
    if (origin == SEEK_SET) {
42
715
        m_position = offset;
43
4.50k
    } else if (origin == SEEK_CUR && m_position.has_value()) {
44
4.43k
        *m_position += offset;
45
4.43k
    } else {
46
78
        int64_t r{std::ftell(m_file)};
47
78
        if (r < 0) {
48
0
            throw std::ios_base::failure("AutoFile::seek: ftell failed");
49
0
        }
50
78
        m_position = r;
51
78
    }
52
5.22k
}
53
54
int64_t AutoFile::tell()
55
154
{
56
154
    if (!m_position.has_value()) throw std::ios_base::failure("AutoFile::tell: position unknown");
57
154
    return *m_position;
58
154
}
59
60
int64_t AutoFile::size()
61
66
{
62
66
    if (IsNull()) {
63
1
        throw std::ios_base::failure("AutoFile::size: file handle is nullptr");
64
1
    }
65
    // Temporarily save the current position
66
65
    int64_t current_pos = tell();
67
65
    seek(0, SEEK_END);
68
65
    int64_t file_size = tell();
69
    // Restore the original position
70
65
    seek(current_pos, SEEK_SET);
71
65
    return file_size;
72
66
}
73
74
void AutoFile::read(std::span<std::byte> dst)
75
23.5M
{
76
23.5M
    if (detail_fread(dst) != dst.size()) {
77
39
        throw std::ios_base::failure(feof() ? "AutoFile::read: end of file" : "AutoFile::read: fread failed");
78
39
    }
79
23.5M
}
80
81
void AutoFile::ignore(size_t nSize)
82
4.25k
{
83
4.25k
    if (!m_file) throw std::ios_base::failure("AutoFile::ignore: file handle is nullptr");
84
4.25k
    unsigned char data[4096];
85
8.50k
    while (nSize > 0) {
86
4.25k
        size_t nNow = std::min<size_t>(nSize, sizeof(data));
87
4.25k
        if (std::fread(data, 1, nNow, m_file) != nNow) {
88
2
            throw std::ios_base::failure(feof() ? "AutoFile::ignore: end of file" : "AutoFile::ignore: fread failed");
89
2
        }
90
4.25k
        nSize -= nNow;
91
4.25k
        if (m_position.has_value()) *m_position += nNow;
92
4.25k
    }
93
4.25k
}
94
95
void AutoFile::write(std::span<const std::byte> src)
96
44.4M
{
97
44.4M
    if (!m_file) throw std::ios_base::failure("AutoFile::write: file handle is nullptr");
98
44.4M
    if (!m_obfuscation) {
99
44.3M
        if (std::fwrite(src.data(), 1, src.size(), m_file) != src.size()) {
100
1
            throw std::ios_base::failure("AutoFile::write: write failed");
101
1
        }
102
44.3M
        m_was_written = true;
103
44.3M
        if (m_position.has_value()) *m_position += src.size();
104
44.3M
    } else {
105
42.5k
        std::array<std::byte, 4096> buf;
106
92.6k
        while (src.size()) {
107
50.1k
            auto buf_now{std::span{buf}.first(std::min<size_t>(src.size(), buf.size()))};
108
50.1k
            std::copy_n(src.begin(), buf_now.size(), buf_now.begin());
109
50.1k
            write_buffer(buf_now);
110
50.1k
            src = src.subspan(buf_now.size());
111
50.1k
        }
112
42.5k
    }
113
44.4M
}
114
115
void AutoFile::write_buffer(std::span<std::byte> src)
116
286k
{
117
286k
    if (!m_file) throw std::ios_base::failure("AutoFile::write_buffer: file handle is nullptr");
118
286k
    if (m_obfuscation) {
119
286k
        if (!m_position) throw std::ios_base::failure("AutoFile::write_buffer: obfuscation position unknown");
120
286k
        m_obfuscation(src, *m_position); // obfuscate in-place
121
286k
    }
122
286k
    if (std::fwrite(src.data(), 1, src.size(), m_file) != src.size()) {
123
0
        throw std::ios_base::failure("AutoFile::write_buffer: write failed");
124
0
    }
125
286k
    m_was_written = true;
126
286k
    if (m_position) *m_position += src.size();
127
286k
}
128
129
bool AutoFile::Commit()
130
2.59k
{
131
2.59k
    return ::FileCommit(m_file);
132
2.59k
}
133
134
bool AutoFile::Truncate(unsigned size)
135
0
{
136
0
    m_was_written = true;
137
0
    return ::TruncateFile(m_file, size);
138
0
}
139
140
size_t DataStream::GetMemoryUsage() const noexcept
141
327k
{
142
327k
    return sizeof(*this) + memusage::DynamicUsage(vch);
143
327k
}