/root/bitcoin/src/addrdb.cpp

Source
// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <bitcoin-build-config.h> // IWYU pragma: keep

#include <addrdb.h>

#include <addrman.h>
#include <chainparams.h>
#include <clientversion.h>
#include <common/args.h>
#include <common/settings.h>
#include <cstdint>
#include <hash.h>
#include <logging.h>
#include <logging/timer.h>
#include <netbase.h>
#include <netgroup.h>
#include <random.h>
#include <streams.h>
#include <tinyformat.h>
#include <univalue.h>
#include <util/fs.h>
#include <util/fs_helpers.h>
#include <util/syserror.h>
#include <util/translation.h>

namespace {

class DbNotFoundError : public std::exception
{
    using std::exception::exception;
};

template <typename Stream, typename Data>
bool SerializeDB(Stream& stream, const Data& data)
{
    // Write and commit header, data
    try {
        HashedSourceWriter hashwriter{stream};
        hashwriter << Params().MessageStart() << data;
        stream << hashwriter.GetHash();
    } catch (const std::exception& e) {
        LogError("%s: Serialize or I/O error - %s\n", __func__, e.what());
        return false;
    }

    return true;
}

template <typename Data>
bool SerializeFileDB(const std::string& prefix, const fs::path& path, const Data& data)
{
    // Generate random temporary filename
    const uint16_t randv{FastRandomContext().rand<uint16_t>()};
    std::string tmpfn = strprintf("%s.%04x", prefix, randv);

    // open temp output file
    fs::path pathTmp = gArgs.GetDataDirNet() / fs::u8path(tmpfn);
    FILE *file = fsbridge::fopen(pathTmp, "wb");
    AutoFile fileout{file};
    if (fileout.IsNull()) {
        remove(pathTmp);
        LogError("%s: Failed to open file %s\n", __func__, fs::PathToString(pathTmp));
        return false;
    }

    // Serialize
    if (!SerializeDB(fileout, data)) {
        (void)fileout.fclose();
        remove(pathTmp);
        return false;
    }
    if (!fileout.Commit()) {
        (void)fileout.fclose();
        remove(pathTmp);
        LogError("%s: Failed to flush file %s\n", __func__, fs::PathToString(pathTmp));
        return false;
    }
    if (fileout.fclose() != 0) {
        const int errno_save{errno};
        remove(pathTmp);
        LogError("Failed to close file %s after commit: %s", fs::PathToString(pathTmp), SysErrorString(errno_save));
        return false;
    }

    // replace existing file, if any, with new file
    if (!RenameOver(pathTmp, path)) {
        remove(pathTmp);
        LogError("%s: Rename-into-place failed\n", __func__);
        return false;
    }

    return true;
}

template <typename Stream, typename Data>
void DeserializeDB(Stream& stream, Data&& data, bool fCheckSum = true)
{
    HashVerifier verifier{stream};
    // de-serialize file header (network specific magic number) and ..
    MessageStartChars pchMsgTmp;
    verifier >> pchMsgTmp;
    // ... verify the network matches ours
    if (pchMsgTmp != Params().MessageStart()) {
        throw std::runtime_error{"Invalid network magic number"};
    }

    // de-serialize data
    verifier >> data;

    // verify checksum
    if (fCheckSum) {
        uint256 hashTmp;
        stream >> hashTmp;
        if (hashTmp != verifier.GetHash()) {
            throw std::runtime_error{"Checksum mismatch, data corrupted"};
        }
    }
}

template <typename Data>
void DeserializeFileDB(const fs::path& path, Data&& data)
{
    FILE* file = fsbridge::fopen(path, "rb");
    AutoFile filein{file};
    if (filein.IsNull()) {
        throw DbNotFoundError{};
    }
    DeserializeDB(filein, data);
}
} // namespace

CBanDB::CBanDB(fs::path ban_list_path)
    : m_banlist_dat(ban_list_path + ".dat"),
      m_banlist_json(ban_list_path + ".json")
{
}

bool CBanDB::Write(const banmap_t& banSet)
{
    std::vector<std::string> errors;
    if (common::WriteSettings(m_banlist_json, {{JSON_KEY, BanMapToJson(banSet)}}, errors)) {
        return true;
    }

    for (const auto& err : errors) {
        LogError("%s\n", err);
    }
    return false;
}

bool CBanDB::Read(banmap_t& banSet)
{
    if (fs::exists(m_banlist_dat)) {
        LogWarning("banlist.dat ignored because it can only be read by " CLIENT_NAME " version 22.x. Remove %s to silence this warning.", fs::quoted(fs::PathToString(m_banlist_dat)));
    }
    // If the JSON banlist does not exist, then recreate it
    if (!fs::exists(m_banlist_json)) {
        return false;
    }

    std::map<std::string, common::SettingsValue> settings;
    std::vector<std::string> errors;

    if (!common::ReadSettings(m_banlist_json, settings, errors)) {
        for (const auto& err : errors) {
            LogWarning("Cannot load banlist %s: %s", fs::PathToString(m_banlist_json), err);
        }
        return false;
    }

    try {
        BanMapFromJson(settings[JSON_KEY], banSet);
    } catch (const std::runtime_error& e) {
        LogWarning("Cannot parse banlist %s: %s", fs::PathToString(m_banlist_json), e.what());
        return false;
    }

    return true;
}

bool DumpPeerAddresses(const ArgsManager& args, const AddrMan& addr)
{
    const auto pathAddr = args.GetDataDirNet() / "peers.dat";
    return SerializeFileDB("peers", pathAddr, addr);
}

void ReadFromStream(AddrMan& addr, DataStream& ssPeers)
{
    DeserializeDB(ssPeers, addr, false);
}

util::Result<std::unique_ptr<AddrMan>> LoadAddrman(const NetGroupManager& netgroupman, const ArgsManager& args)
{
    auto check_addrman = std::clamp<int32_t>(args.GetIntArg("-checkaddrman", DEFAULT_ADDRMAN_CONSISTENCY_CHECKS), 0, 1000000);
    bool deterministic = HasTestOption(args, "addrman"); // use a deterministic addrman only for tests

    auto addrman{std::make_unique<AddrMan>(netgroupman, deterministic, /*consistency_check_ratio=*/check_addrman)};

    const auto start{SteadyClock::now()};
    const auto path_addr{args.GetDataDirNet() / "peers.dat"};
    try {
        DeserializeFileDB(path_addr, *addrman);
        LogInfo("Loaded %i addresses from peers.dat  %dms", addrman->Size(), Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
    } catch (const DbNotFoundError&) {
        // Addrman can be in an inconsistent state after failure, reset it
        addrman = std::make_unique<AddrMan>(netgroupman, deterministic, /*consistency_check_ratio=*/check_addrman);
        LogInfo("Creating peers.dat because the file was not found (%s)", fs::quoted(fs::PathToString(path_addr)));
        DumpPeerAddresses(args, *addrman);
    } catch (const InvalidAddrManVersionError&) {
        if (!RenameOver(path_addr, (fs::path)path_addr + ".bak")) {
            return util::Error{strprintf(_("Failed to rename invalid peers.dat file. Please move or delete it and try again."))};
        }
        // Addrman can be in an inconsistent state after failure, reset it
        addrman = std::make_unique<AddrMan>(netgroupman, deterministic, /*consistency_check_ratio=*/check_addrman);
        LogWarning("Creating new peers.dat because the file version was not compatible (%s). Original backed up to peers.dat.bak", fs::quoted(fs::PathToString(path_addr)));
        DumpPeerAddresses(args, *addrman);
    } catch (const std::exception& e) {
        return util::Error{strprintf(_("Invalid or corrupt peers.dat (%s). If you believe this is a bug, please report it to %s. As a workaround, you can move the file (%s) out of the way (rename, move, or delete) to have a new one created on the next start."),
                                     e.what(), CLIENT_BUGREPORT, fs::quoted(fs::PathToString(path_addr)))};
    }
    return addrman;
}

void DumpAnchors(const fs::path& anchors_db_path, const std::vector<CAddress>& anchors)
{
    LOG_TIME_SECONDS(strprintf("Flush %d outbound block-relay-only peer addresses to anchors.dat", anchors.size()));
    SerializeFileDB("anchors", anchors_db_path, CAddress::V2_DISK(anchors));
}

std::vector<CAddress> ReadAnchors(const fs::path& anchors_db_path)
{
    std::vector<CAddress> anchors;
    try {
        DeserializeFileDB(anchors_db_path, CAddress::V2_DISK(anchors));
        LogInfo("Loaded %i addresses from %s", anchors.size(), fs::quoted(fs::PathToString(anchors_db_path.filename())));
    } catch (const std::exception&) {
        anchors.clear();
    }

    fs::remove(anchors_db_path);
    return anchors;
}

Coverage Report

Created: 2025-09-19 18:21

Line	Count	Source
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		#include <bitcoin-build-config.h> // IWYU pragma: keep
7
8		#include <addrdb.h>
9
10		#include <addrman.h>
11		#include <chainparams.h>
12		#include <clientversion.h>
13		#include <common/args.h>
14		#include <common/settings.h>
15		#include <cstdint>
16		#include <hash.h>
17		#include <logging.h>
18		#include <logging/timer.h>
19		#include <netbase.h>
20		#include <netgroup.h>
21		#include <random.h>
22		#include <streams.h>
23		#include <tinyformat.h>
24		#include <univalue.h>
25		#include <util/fs.h>
26		#include <util/fs_helpers.h>
27		#include <util/syserror.h>
28		#include <util/translation.h>
29
30		namespace {
31
32		class DbNotFoundError : public std::exception
33		{
34		using std::exception::exception;
35		};
36
37		template <typename Stream, typename Data>
38		bool SerializeDB(Stream& stream, const Data& data)
39	0	{
40		// Write and commit header, data
41	0	try {
42	0	HashedSourceWriter hashwriter{stream};
43	0	hashwriter << Params().MessageStart() << data;
44	0	stream << hashwriter.GetHash();
45	0	} catch (const std::exception& e) {
46	0	LogError("%s: Serialize or I/O error - %s\n", __func__, e.what());
47	0	return false;
48	0	}
49
50	0	return true;
51	0	} Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_111SerializeDBI8AutoFile7AddrManEEbRT_RKT0_ Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_111SerializeDBI8AutoFile13ParamsWrapperIN8CAddress9SerParamsEKSt6vectorIS3_SaIS3_EEEEEbRT_RKT0_
52
53		template <typename Data>
54		bool SerializeFileDB(const std::string& prefix, const fs::path& path, const Data& data)
55	0	{
56		// Generate random temporary filename
57	0	const uint16_t randv{FastRandomContext().rand<uint16_t>()};
58	0	std::string tmpfn = strprintf("%s.%04x", prefix, randv);
59
60		// open temp output file
61	0	fs::path pathTmp = gArgs.GetDataDirNet() / fs::u8path(tmpfn);
62	0	FILE *file = fsbridge::fopen(pathTmp, "wb");
63	0	AutoFile fileout{file};
64	0	if (fileout.IsNull()) {
65	0	remove(pathTmp);
66	0	LogError("%s: Failed to open file %s\n", __func__, fs::PathToString(pathTmp));
67	0	return false;
68	0	}
69
70		// Serialize
71	0	if (!SerializeDB(fileout, data)) {
72	0	(void)fileout.fclose();
73	0	remove(pathTmp);
74	0	return false;
75	0	}
76	0	if (!fileout.Commit()) {
77	0	(void)fileout.fclose();
78	0	remove(pathTmp);
79	0	LogError("%s: Failed to flush file %s\n", __func__, fs::PathToString(pathTmp));
80	0	return false;
81	0	}
82	0	if (fileout.fclose() != 0) {
83	0	const int errno_save{errno};
84	0	remove(pathTmp);
85	0	LogError("Failed to close file %s after commit: %s", fs::PathToString(pathTmp), SysErrorString(errno_save));
86	0	return false;
87	0	}
88
89		// replace existing file, if any, with new file
90	0	if (!RenameOver(pathTmp, path)) {
91	0	remove(pathTmp);
92	0	LogError("%s: Rename-into-place failed\n", __func__);
93	0	return false;
94	0	}
95
96	0	return true;
97	0	} Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_115SerializeFileDBI7AddrManEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERKN2fs4pathERKT_ Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_115SerializeFileDBI13ParamsWrapperIN8CAddress9SerParamsEKSt6vectorIS2_SaIS2_EEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERKN2fs4pathERKT_
98
99		template <typename Stream, typename Data>
100		void DeserializeDB(Stream& stream, Data&& data, bool fCheckSum = true)
101	0	{
102	0	HashVerifier verifier{stream};
103		// de-serialize file header (network specific magic number) and ..
104	0	MessageStartChars pchMsgTmp;
105	0	verifier >> pchMsgTmp;
106		// ... verify the network matches ours
107	0	if (pchMsgTmp != Params().MessageStart()) {
108	0	throw std::runtime_error{"Invalid network magic number"};
109	0	}
110
111		// de-serialize data
112	0	verifier >> data;
113
114		// verify checksum
115	0	if (fCheckSum) {
116	0	uint256 hashTmp;
117	0	stream >> hashTmp;
118	0	if (hashTmp != verifier.GetHash()) {
119	0	throw std::runtime_error{"Checksum mismatch, data corrupted"};
120	0	}
121	0	}
122	0	} Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_113DeserializeDBI10DataStreamR7AddrManEEvRT_OT0_b Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_113DeserializeDBI8AutoFileR7AddrManEEvRT_OT0_b Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_113DeserializeDBI8AutoFileR13ParamsWrapperIN8CAddress9SerParamsESt6vectorIS3_SaIS3_EEEEEvRT_OT0_b
123
124		template <typename Data>
125		void DeserializeFileDB(const fs::path& path, Data&& data)
126	0	{
127	0	FILE* file = fsbridge::fopen(path, "rb");
128	0	AutoFile filein{file};
129	0	if (filein.IsNull()) {
130	0	throw DbNotFoundError{};
131	0	}
132	0	DeserializeDB(filein, data);
133	0	} Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_117DeserializeFileDBIR7AddrManEEvRKN2fs4pathEOT_ Unexecuted instantiation: addrdb.cpp:_ZN12_GLOBAL__N_117DeserializeFileDBI13ParamsWrapperIN8CAddress9SerParamsESt6vectorIS2_SaIS2_EEEEEvRKN2fs4pathEOT_
134		} // namespace
135
136		CBanDB::CBanDB(fs::path ban_list_path)
137	0	: m_banlist_dat(ban_list_path + ".dat"),
138	0	m_banlist_json(ban_list_path + ".json")
139	0	{
140	0	}
141
142		bool CBanDB::Write(const banmap_t& banSet)
143	0	{
144	0	std::vector<std::string> errors;
145	0	if (common::WriteSettings(m_banlist_json, {{JSON_KEY, BanMapToJson(banSet)}}, errors)) {
146	0	return true;
147	0	}
148
149	0	for (const auto& err : errors) {
150	0	LogError("%s\n", err);
151	0	}
152	0	return false;
153	0	}
154
155		bool CBanDB::Read(banmap_t& banSet)
156	0	{
157	0	if (fs::exists(m_banlist_dat)) {
158	0	LogWarning("banlist.dat ignored because it can only be read by " CLIENT_NAME " version 22.x. Remove %s to silence this warning.", fs::quoted(fs::PathToString(m_banlist_dat)));
159	0	}
160		// If the JSON banlist does not exist, then recreate it
161	0	if (!fs::exists(m_banlist_json)) {
162	0	return false;
163	0	}
164
165	0	std::map<std::string, common::SettingsValue> settings;
166	0	std::vector<std::string> errors;
167
168	0	if (!common::ReadSettings(m_banlist_json, settings, errors)) {
169	0	for (const auto& err : errors) {
170	0	LogWarning("Cannot load banlist %s: %s", fs::PathToString(m_banlist_json), err);
171	0	}
172	0	return false;
173	0	}
174
175	0	try {
176	0	BanMapFromJson(settings[JSON_KEY], banSet);
177	0	} catch (const std::runtime_error& e) {
178	0	LogWarning("Cannot parse banlist %s: %s", fs::PathToString(m_banlist_json), e.what());
179	0	return false;
180	0	}
181
182	0	return true;
183	0	}
184
185		bool DumpPeerAddresses(const ArgsManager& args, const AddrMan& addr)
186	0	{
187	0	const auto pathAddr = args.GetDataDirNet() / "peers.dat";
188	0	return SerializeFileDB("peers", pathAddr, addr);
189	0	}
190
191		void ReadFromStream(AddrMan& addr, DataStream& ssPeers)
192	0	{
193	0	DeserializeDB(ssPeers, addr, false);
194	0	}
195
196		util::Result<std::unique_ptr<AddrMan>> LoadAddrman(const NetGroupManager& netgroupman, const ArgsManager& args)
197	0	{
198	0	auto check_addrman = std::clamp<int32_t>(args.GetIntArg("-checkaddrman", DEFAULT_ADDRMAN_CONSISTENCY_CHECKS), 0, 1000000);
199	0	bool deterministic = HasTestOption(args, "addrman"); // use a deterministic addrman only for tests
200
201	0	auto addrman{std::make_unique<AddrMan>(netgroupman, deterministic, /consistency_check_ratio=/check_addrman)};
202
203	0	const auto start{SteadyClock::now()};
204	0	const auto path_addr{args.GetDataDirNet() / "peers.dat"};
205	0	try {
206	0	DeserializeFileDB(path_addr, *addrman);
207	0	LogInfo("Loaded %i addresses from peers.dat %dms", addrman->Size(), Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
208	0	} catch (const DbNotFoundError&) {
209		// Addrman can be in an inconsistent state after failure, reset it
210	0	addrman = std::make_unique<AddrMan>(netgroupman, deterministic, /consistency_check_ratio=/check_addrman);
211	0	LogInfo("Creating peers.dat because the file was not found (%s)", fs::quoted(fs::PathToString(path_addr)));
212	0	DumpPeerAddresses(args, *addrman);
213	0	} catch (const InvalidAddrManVersionError&) {
214	0	if (!RenameOver(path_addr, (fs::path)path_addr + ".bak")) {
215	0	return util::Error{strprintf(_("Failed to rename invalid peers.dat file. Please move or delete it and try again."))};
216	0	}
217		// Addrman can be in an inconsistent state after failure, reset it
218	0	addrman = std::make_unique<AddrMan>(netgroupman, deterministic, /consistency_check_ratio=/check_addrman);
219	0	LogWarning("Creating new peers.dat because the file version was not compatible (%s). Original backed up to peers.dat.bak", fs::quoted(fs::PathToString(path_addr)));
220	0	DumpPeerAddresses(args, *addrman);
221	0	} catch (const std::exception& e) {
222	0	return util::Error{strprintf(_("Invalid or corrupt peers.dat (%s). If you believe this is a bug, please report it to %s. As a workaround, you can move the file (%s) out of the way (rename, move, or delete) to have a new one created on the next start."),
223	0	e.what(), CLIENT_BUGREPORT, fs::quoted(fs::PathToString(path_addr)))};
224	0	}
225	0	return addrman;
226	0	}
227
228		void DumpAnchors(const fs::path& anchors_db_path, const std::vector<CAddress>& anchors)
229	0	{
230	0	LOG_TIME_SECONDS(strprintf("Flush %d outbound block-relay-only peer addresses to anchors.dat", anchors.size()));
231	0	SerializeFileDB("anchors", anchors_db_path, CAddress::V2_DISK(anchors));
232	0	}
233
234		std::vector<CAddress> ReadAnchors(const fs::path& anchors_db_path)
235	0	{
236	0	std::vector<CAddress> anchors;
237	0	try {
238	0	DeserializeFileDB(anchors_db_path, CAddress::V2_DISK(anchors));
239	0	LogInfo("Loaded %i addresses from %s", anchors.size(), fs::quoted(fs::PathToString(anchors_db_path.filename())));
240	0	} catch (const std::exception&) {
241	0	anchors.clear();
242	0	}
243
244	0	fs::remove(anchors_db_path);
245	0	return anchors;
246	0	}