Bitcoin Core  25.99.0
P2P Digital Currency
addrman_tests.cpp
Go to the documentation of this file.
1 // Copyright (c) 2012-2022 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #include <addrdb.h>
6 #include <addrman.h>
7 #include <addrman_impl.h>
8 #include <chainparams.h>
9 #include <clientversion.h>
10 #include <hash.h>
11 #include <netbase.h>
12 #include <random.h>
13 #include <test/data/asmap.raw.h>
14 #include <test/util/setup_common.h>
15 #include <util/asmap.h>
16 #include <util/string.h>
17 
18 #include <boost/test/unit_test.hpp>
19 
20 #include <optional>
21 #include <string>
22 
23 using namespace std::literals;
24 using node::NodeContext;
25 
26 static NetGroupManager EMPTY_NETGROUPMAN{std::vector<bool>()};
27 static const bool DETERMINISTIC{true};
28 
29 static int32_t GetCheckRatio(const NodeContext& node_ctx)
30 {
31  return std::clamp<int32_t>(node_ctx.args->GetIntArg("-checkaddrman", 100), 0, 1000000);
32 }
33 
34 static CNetAddr ResolveIP(const std::string& ip)
35 {
36  const std::optional<CNetAddr> addr{LookupHost(ip, false)};
37  BOOST_CHECK_MESSAGE(addr.has_value(), strprintf("failed to resolve: %s", ip));
38  return addr.value_or(CNetAddr{});
39 }
40 
41 static CService ResolveService(const std::string& ip, uint16_t port = 0)
42 {
43  const std::optional<CService> serv{Lookup(ip, port, false)};
44  BOOST_CHECK_MESSAGE(serv.has_value(), strprintf("failed to resolve: %s:%i", ip, port));
45  return serv.value_or(CService{});
46 }
47 
48 
49 static std::vector<bool> FromBytes(const unsigned char* source, int vector_size)
50 {
51  std::vector<bool> result(vector_size);
52  for (int byte_i = 0; byte_i < vector_size / 8; ++byte_i) {
53  unsigned char cur_byte = source[byte_i];
54  for (int bit_i = 0; bit_i < 8; ++bit_i) {
55  result[byte_i * 8 + bit_i] = (cur_byte >> bit_i) & 1;
56  }
57  }
58  return result;
59 }
60 
61 BOOST_FIXTURE_TEST_SUITE(addrman_tests, BasicTestingSetup)
62 
63 BOOST_AUTO_TEST_CASE(addrman_simple)
64 {
65  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
66 
67  CNetAddr source = ResolveIP("252.2.2.2");
68 
69  // Test: Does Addrman respond correctly when empty.
70  BOOST_CHECK_EQUAL(addrman->Size(), 0U);
71  auto addr_null = addrman->Select().first;
72  BOOST_CHECK_EQUAL(addr_null.ToStringAddrPort(), "[::]:0");
73 
74  // Test: Does Addrman::Add work as expected.
75  CService addr1 = ResolveService("250.1.1.1", 8333);
76  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
77  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
78  auto addr_ret1 = addrman->Select().first;
79  BOOST_CHECK_EQUAL(addr_ret1.ToStringAddrPort(), "250.1.1.1:8333");
80 
81  // Test: Does IP address deduplication work correctly.
82  // Expected dup IP should not be added.
83  CService addr1_dup = ResolveService("250.1.1.1", 8333);
84  BOOST_CHECK(!addrman->Add({CAddress(addr1_dup, NODE_NONE)}, source));
85  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
86 
87 
88  // Test: New table has one addr and we add a diff addr we should
89  // have at least one addr.
90  // Note that addrman's size cannot be tested reliably after insertion, as
91  // hash collisions may occur. But we can always be sure of at least one
92  // success.
93 
94  CService addr2 = ResolveService("250.1.1.2", 8333);
95  BOOST_CHECK(addrman->Add({CAddress(addr2, NODE_NONE)}, source));
96  BOOST_CHECK(addrman->Size() >= 1);
97 
98  // Test: reset addrman and test AddrMan::Add multiple addresses works as expected
99  addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
100  std::vector<CAddress> vAddr;
101  vAddr.push_back(CAddress(ResolveService("250.1.1.3", 8333), NODE_NONE));
102  vAddr.push_back(CAddress(ResolveService("250.1.1.4", 8333), NODE_NONE));
103  BOOST_CHECK(addrman->Add(vAddr, source));
104  BOOST_CHECK(addrman->Size() >= 1);
105 }
106 
107 BOOST_AUTO_TEST_CASE(addrman_ports)
108 {
109  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
110 
111  CNetAddr source = ResolveIP("252.2.2.2");
112 
113  BOOST_CHECK_EQUAL(addrman->Size(), 0U);
114 
115  // Test 7; Addr with same IP but diff port does not replace existing addr.
116  CService addr1 = ResolveService("250.1.1.1", 8333);
117  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
118  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
119 
120  CService addr1_port = ResolveService("250.1.1.1", 8334);
121  BOOST_CHECK(addrman->Add({CAddress(addr1_port, NODE_NONE)}, source));
122  BOOST_CHECK_EQUAL(addrman->Size(), 2U);
123  auto addr_ret2 = addrman->Select().first;
124  BOOST_CHECK(addr_ret2.ToStringAddrPort() == "250.1.1.1:8333" || addr_ret2.ToStringAddrPort() == "250.1.1.1:8334");
125 
126  // Test: Add same IP but diff port to tried table; this converts the entry with
127  // the specified port to tried, but not the other.
128  addrman->Good(CAddress(addr1_port, NODE_NONE));
129  BOOST_CHECK_EQUAL(addrman->Size(), 2U);
130  bool new_only = true;
131  auto addr_ret3 = addrman->Select(new_only).first;
132  BOOST_CHECK_EQUAL(addr_ret3.ToStringAddrPort(), "250.1.1.1:8333");
133 }
134 
135 BOOST_AUTO_TEST_CASE(addrman_select)
136 {
137  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
138  BOOST_CHECK(!addrman->Select(false).first.IsValid());
139  BOOST_CHECK(!addrman->Select(true).first.IsValid());
140 
141  CNetAddr source = ResolveIP("252.2.2.2");
142 
143  // Add 1 address to the new table
144  CService addr1 = ResolveService("250.1.1.1", 8333);
145  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
146  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
147 
148  BOOST_CHECK(addrman->Select(/*new_only=*/true).first == addr1);
149  BOOST_CHECK(addrman->Select(/*new_only=*/false).first == addr1);
150 
151  // Move address to the tried table
152  BOOST_CHECK(addrman->Good(CAddress(addr1, NODE_NONE)));
153 
154  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
155  BOOST_CHECK(!addrman->Select(/*new_only=*/true).first.IsValid());
156  BOOST_CHECK(addrman->Select().first == addr1);
157  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
158 
159  // Add one address to the new table
160  CService addr2 = ResolveService("250.3.1.1", 8333);
161  BOOST_CHECK(addrman->Add({CAddress(addr2, NODE_NONE)}, addr2));
162  BOOST_CHECK(addrman->Select(/*new_only=*/true).first == addr2);
163 
164  // Add two more addresses to the new table
165  CService addr3 = ResolveService("250.3.2.2", 9999);
166  CService addr4 = ResolveService("250.3.3.3", 9999);
167 
168  BOOST_CHECK(addrman->Add({CAddress(addr3, NODE_NONE)}, addr2));
169  BOOST_CHECK(addrman->Add({CAddress(addr4, NODE_NONE)}, ResolveService("250.4.1.1", 8333)));
170 
171  // Add three addresses to tried table.
172  CService addr5 = ResolveService("250.4.4.4", 8333);
173  CService addr6 = ResolveService("250.4.5.5", 7777);
174  CService addr7 = ResolveService("250.4.6.6", 8333);
175 
176  BOOST_CHECK(addrman->Add({CAddress(addr5, NODE_NONE)}, addr3));
177  BOOST_CHECK(addrman->Good(CAddress(addr5, NODE_NONE)));
178  BOOST_CHECK(addrman->Add({CAddress(addr6, NODE_NONE)}, addr3));
179  BOOST_CHECK(addrman->Good(CAddress(addr6, NODE_NONE)));
180  BOOST_CHECK(addrman->Add({CAddress(addr7, NODE_NONE)}, ResolveService("250.1.1.3", 8333)));
181  BOOST_CHECK(addrman->Good(CAddress(addr7, NODE_NONE)));
182 
183  // 6 addrs + 1 addr from last test = 7.
184  BOOST_CHECK_EQUAL(addrman->Size(), 7U);
185 
186  // Select pulls from new and tried regardless of port number.
187  std::set<uint16_t> ports;
188  for (int i = 0; i < 20; ++i) {
189  ports.insert(addrman->Select().first.GetPort());
190  }
191  BOOST_CHECK_EQUAL(ports.size(), 3U);
192 }
193 
194 BOOST_AUTO_TEST_CASE(addrman_select_by_network)
195 {
196  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
197  BOOST_CHECK(!addrman->Select(/*new_only=*/true, NET_IPV4).first.IsValid());
198  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_IPV4).first.IsValid());
199 
200  // add ipv4 address to the new table
201  CNetAddr source = ResolveIP("252.2.2.2");
202  CService addr1 = ResolveService("250.1.1.1", 8333);
203  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
204 
205  BOOST_CHECK(addrman->Select(/*new_only=*/true, NET_IPV4).first == addr1);
206  BOOST_CHECK(addrman->Select(/*new_only=*/false, NET_IPV4).first == addr1);
207  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_IPV6).first.IsValid());
208  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_ONION).first.IsValid());
209  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_I2P).first.IsValid());
210  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_CJDNS).first.IsValid());
211  BOOST_CHECK(!addrman->Select(/*new_only=*/true, NET_CJDNS).first.IsValid());
212  BOOST_CHECK(addrman->Select(/*new_only=*/false).first == addr1);
213 
214  // add I2P address to the new table
215  CAddress i2p_addr;
216  i2p_addr.SetSpecial("udhdrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jna.b32.i2p");
217  BOOST_CHECK(addrman->Add({i2p_addr}, source));
218 
219  BOOST_CHECK(addrman->Select(/*new_only=*/true, NET_I2P).first == i2p_addr);
220  BOOST_CHECK(addrman->Select(/*new_only=*/false, NET_I2P).first == i2p_addr);
221  BOOST_CHECK(addrman->Select(/*new_only=*/false, NET_IPV4).first == addr1);
222  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_IPV6).first.IsValid());
223  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_ONION).first.IsValid());
224  BOOST_CHECK(!addrman->Select(/*new_only=*/false, NET_CJDNS).first.IsValid());
225 
226  // bump I2P address to tried table
227  BOOST_CHECK(addrman->Good(i2p_addr));
228 
229  BOOST_CHECK(!addrman->Select(/*new_only=*/true, NET_I2P).first.IsValid());
230  BOOST_CHECK(addrman->Select(/*new_only=*/false, NET_I2P).first == i2p_addr);
231 
232  // add another I2P address to the new table
233  CAddress i2p_addr2;
234  i2p_addr2.SetSpecial("c4gfnttsuwqomiygupdqqqyy5y5emnk5c73hrfvatri67prd7vyq.b32.i2p");
235  BOOST_CHECK(addrman->Add({i2p_addr2}, source));
236 
237  BOOST_CHECK(addrman->Select(/*new_only=*/true, NET_I2P).first == i2p_addr2);
238 
239  // ensure that both new and tried table are selected from
240  bool new_selected{false};
241  bool tried_selected{false};
242 
243  while (!new_selected || !tried_selected) {
244  const CAddress selected{addrman->Select(/*new_only=*/false, NET_I2P).first};
245  BOOST_REQUIRE(selected == i2p_addr || selected == i2p_addr2);
246  if (selected == i2p_addr) {
247  tried_selected = true;
248  } else {
249  new_selected = true;
250  }
251  }
252 }
253 
254 BOOST_AUTO_TEST_CASE(addrman_select_special)
255 {
256  // use a non-deterministic addrman to ensure a passing test isn't due to setup
257  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, /*deterministic=*/false, GetCheckRatio(m_node));
258 
259  CNetAddr source = ResolveIP("252.2.2.2");
260 
261  // add I2P address to the tried table
262  CAddress i2p_addr;
263  i2p_addr.SetSpecial("udhdrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jna.b32.i2p");
264  BOOST_CHECK(addrman->Add({i2p_addr}, source));
265  BOOST_CHECK(addrman->Good(i2p_addr));
266 
267  // add ipv4 address to the new table
268  CService addr1 = ResolveService("250.1.1.3", 8333);
269  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
270 
271  // since the only ipv4 address is on the new table, ensure that the new
272  // table gets selected even if new_only is false. if the table was being
273  // selected at random, this test will sporadically fail
274  BOOST_CHECK(addrman->Select(/*new_only=*/false, NET_IPV4).first == addr1);
275 }
276 
277 BOOST_AUTO_TEST_CASE(addrman_new_collisions)
278 {
279  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
280 
281  CNetAddr source = ResolveIP("252.2.2.2");
282 
283  uint32_t num_addrs{0};
284 
285  BOOST_CHECK_EQUAL(addrman->Size(), num_addrs);
286 
287  while (num_addrs < 22) { // Magic number! 250.1.1.1 - 250.1.1.22 do not collide with deterministic key = 1
288  CService addr = ResolveService("250.1.1." + ToString(++num_addrs));
289  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
290 
291  // Test: No collision in new table yet.
292  BOOST_CHECK_EQUAL(addrman->Size(), num_addrs);
293  }
294 
295  // Test: new table collision!
296  CService addr1 = ResolveService("250.1.1." + ToString(++num_addrs));
297  uint32_t collisions{1};
298  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
299  BOOST_CHECK_EQUAL(addrman->Size(), num_addrs - collisions);
300 
301  CService addr2 = ResolveService("250.1.1." + ToString(++num_addrs));
302  BOOST_CHECK(addrman->Add({CAddress(addr2, NODE_NONE)}, source));
303  BOOST_CHECK_EQUAL(addrman->Size(), num_addrs - collisions);
304 }
305 
306 BOOST_AUTO_TEST_CASE(addrman_new_multiplicity)
307 {
308  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
309  CAddress addr{CAddress(ResolveService("253.3.3.3", 8333), NODE_NONE)};
310  const auto start_time{Now<NodeSeconds>()};
311  addr.nTime = start_time;
312 
313  // test that multiplicity stays at 1 if nTime doesn't increase
314  for (unsigned int i = 1; i < 20; ++i) {
315  std::string addr_ip{ToString(i % 256) + "." + ToString(i >> 8 % 256) + ".1.1"};
316  CNetAddr source{ResolveIP(addr_ip)};
317  addrman->Add({addr}, source);
318  }
319  AddressPosition addr_pos = addrman->FindAddressEntry(addr).value();
320  BOOST_CHECK_EQUAL(addr_pos.multiplicity, 1U);
321  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
322 
323  // if nTime increases, an addr can occur in up to 8 buckets
324  // The acceptance probability decreases exponentially with existing multiplicity -
325  // choose number of iterations such that it gets to 8 with deterministic addrman.
326  for (unsigned int i = 1; i < 400; ++i) {
327  std::string addr_ip{ToString(i % 256) + "." + ToString(i >> 8 % 256) + ".1.1"};
328  CNetAddr source{ResolveIP(addr_ip)};
329  addr.nTime = start_time + std::chrono::seconds{i};
330  addrman->Add({addr}, source);
331  }
332  AddressPosition addr_pos_multi = addrman->FindAddressEntry(addr).value();
333  BOOST_CHECK_EQUAL(addr_pos_multi.multiplicity, 8U);
334  // multiplicity doesn't affect size
335  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
336 }
337 
338 BOOST_AUTO_TEST_CASE(addrman_tried_collisions)
339 {
340  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
341 
342  CNetAddr source = ResolveIP("252.2.2.2");
343 
344  uint32_t num_addrs{0};
345 
346  BOOST_CHECK_EQUAL(addrman->Size(), num_addrs);
347 
348  while (num_addrs < 35) { // Magic number! 250.1.1.1 - 250.1.1.35 do not collide in tried with deterministic key = 1
349  CService addr = ResolveService("250.1.1." + ToString(++num_addrs));
350  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
351 
352  // Test: Add to tried without collision
353  BOOST_CHECK(addrman->Good(CAddress(addr, NODE_NONE)));
354 
355  }
356 
357  // Test: Unable to add to tried table due to collision!
358  CService addr1 = ResolveService("250.1.1." + ToString(++num_addrs));
359  BOOST_CHECK(addrman->Add({CAddress(addr1, NODE_NONE)}, source));
360  BOOST_CHECK(!addrman->Good(CAddress(addr1, NODE_NONE)));
361 
362  // Test: Add the next address to tried without collision
363  CService addr2 = ResolveService("250.1.1." + ToString(++num_addrs));
364  BOOST_CHECK(addrman->Add({CAddress(addr2, NODE_NONE)}, source));
365  BOOST_CHECK(addrman->Good(CAddress(addr2, NODE_NONE)));
366 }
367 
368 
369 BOOST_AUTO_TEST_CASE(addrman_getaddr)
370 {
371  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
372 
373  // Test: Sanity check, GetAddr should never return anything if addrman
374  // is empty.
375  BOOST_CHECK_EQUAL(addrman->Size(), 0U);
376  std::vector<CAddress> vAddr1 = addrman->GetAddr(/*max_addresses=*/0, /*max_pct=*/0, /*network=*/std::nullopt);
377  BOOST_CHECK_EQUAL(vAddr1.size(), 0U);
378 
379  CAddress addr1 = CAddress(ResolveService("250.250.2.1", 8333), NODE_NONE);
380  addr1.nTime = Now<NodeSeconds>(); // Set time so isTerrible = false
381  CAddress addr2 = CAddress(ResolveService("250.251.2.2", 9999), NODE_NONE);
382  addr2.nTime = Now<NodeSeconds>();
383  CAddress addr3 = CAddress(ResolveService("251.252.2.3", 8333), NODE_NONE);
384  addr3.nTime = Now<NodeSeconds>();
385  CAddress addr4 = CAddress(ResolveService("252.253.3.4", 8333), NODE_NONE);
386  addr4.nTime = Now<NodeSeconds>();
387  CAddress addr5 = CAddress(ResolveService("252.254.4.5", 8333), NODE_NONE);
388  addr5.nTime = Now<NodeSeconds>();
389  CNetAddr source1 = ResolveIP("250.1.2.1");
390  CNetAddr source2 = ResolveIP("250.2.3.3");
391 
392  // Test: Ensure GetAddr works with new addresses.
393  BOOST_CHECK(addrman->Add({addr1, addr3, addr5}, source1));
394  BOOST_CHECK(addrman->Add({addr2, addr4}, source2));
395 
396  BOOST_CHECK_EQUAL(addrman->GetAddr(/*max_addresses=*/0, /*max_pct=*/0, /*network=*/std::nullopt).size(), 5U);
397  // Net processing asks for 23% of addresses. 23% of 5 is 1 rounded down.
398  BOOST_CHECK_EQUAL(addrman->GetAddr(/*max_addresses=*/2500, /*max_pct=*/23, /*network=*/std::nullopt).size(), 1U);
399 
400  // Test: Ensure GetAddr works with new and tried addresses.
401  BOOST_CHECK(addrman->Good(CAddress(addr1, NODE_NONE)));
402  BOOST_CHECK(addrman->Good(CAddress(addr2, NODE_NONE)));
403  BOOST_CHECK_EQUAL(addrman->GetAddr(/*max_addresses=*/0, /*max_pct=*/0, /*network=*/std::nullopt).size(), 5U);
404  BOOST_CHECK_EQUAL(addrman->GetAddr(/*max_addresses=*/2500, /*max_pct=*/23, /*network=*/std::nullopt).size(), 1U);
405 
406  // Test: Ensure GetAddr still returns 23% when addrman has many addrs.
407  for (unsigned int i = 1; i < (8 * 256); i++) {
408  int octet1 = i % 256;
409  int octet2 = i >> 8 % 256;
410  std::string strAddr = ToString(octet1) + "." + ToString(octet2) + ".1.23";
411  CAddress addr = CAddress(ResolveService(strAddr), NODE_NONE);
412 
413  // Ensure that for all addrs in addrman, isTerrible == false.
414  addr.nTime = Now<NodeSeconds>();
415  addrman->Add({addr}, ResolveIP(strAddr));
416  if (i % 8 == 0)
417  addrman->Good(addr);
418  }
419  std::vector<CAddress> vAddr = addrman->GetAddr(/*max_addresses=*/2500, /*max_pct=*/23, /*network=*/std::nullopt);
420 
421  size_t percent23 = (addrman->Size() * 23) / 100;
422  BOOST_CHECK_EQUAL(vAddr.size(), percent23);
423  BOOST_CHECK_EQUAL(vAddr.size(), 461U);
424  // (addrman.Size() < number of addresses added) due to address collisions.
425  BOOST_CHECK_EQUAL(addrman->Size(), 2006U);
426 }
427 
428 
429 BOOST_AUTO_TEST_CASE(caddrinfo_get_tried_bucket_legacy)
430 {
431  CAddress addr1 = CAddress(ResolveService("250.1.1.1", 8333), NODE_NONE);
432  CAddress addr2 = CAddress(ResolveService("250.1.1.1", 9999), NODE_NONE);
433 
434  CNetAddr source1 = ResolveIP("250.1.1.1");
435 
436 
437  AddrInfo info1 = AddrInfo(addr1, source1);
438 
439  uint256 nKey1 = (uint256)(CHashWriter(SER_GETHASH, 0) << 1).GetHash();
440  uint256 nKey2 = (uint256)(CHashWriter(SER_GETHASH, 0) << 2).GetHash();
441 
443 
444  // Test: Make sure key actually randomizes bucket placement. A fail on
445  // this test could be a security issue.
447 
448  // Test: Two addresses with same IP but different ports can map to
449  // different buckets because they have different keys.
450  AddrInfo info2 = AddrInfo(addr2, source1);
451 
452  BOOST_CHECK(info1.GetKey() != info2.GetKey());
454 
455  std::set<int> buckets;
456  for (int i = 0; i < 255; i++) {
457  AddrInfo infoi = AddrInfo(
458  CAddress(ResolveService("250.1.1." + ToString(i)), NODE_NONE),
459  ResolveIP("250.1.1." + ToString(i)));
460  int bucket = infoi.GetTriedBucket(nKey1, EMPTY_NETGROUPMAN);
461  buckets.insert(bucket);
462  }
463  // Test: IP addresses in the same /16 prefix should
464  // never get more than 8 buckets with legacy grouping
465  BOOST_CHECK_EQUAL(buckets.size(), 8U);
466 
467  buckets.clear();
468  for (int j = 0; j < 255; j++) {
469  AddrInfo infoj = AddrInfo(
470  CAddress(ResolveService("250." + ToString(j) + ".1.1"), NODE_NONE),
471  ResolveIP("250." + ToString(j) + ".1.1"));
472  int bucket = infoj.GetTriedBucket(nKey1, EMPTY_NETGROUPMAN);
473  buckets.insert(bucket);
474  }
475  // Test: IP addresses in the different /16 prefix should map to more than
476  // 8 buckets with legacy grouping
477  BOOST_CHECK_EQUAL(buckets.size(), 160U);
478 }
479 
480 BOOST_AUTO_TEST_CASE(caddrinfo_get_new_bucket_legacy)
481 {
482  CAddress addr1 = CAddress(ResolveService("250.1.2.1", 8333), NODE_NONE);
483  CAddress addr2 = CAddress(ResolveService("250.1.2.1", 9999), NODE_NONE);
484 
485  CNetAddr source1 = ResolveIP("250.1.2.1");
486 
487  AddrInfo info1 = AddrInfo(addr1, source1);
488 
489  uint256 nKey1 = (uint256)(CHashWriter(SER_GETHASH, 0) << 1).GetHash();
490  uint256 nKey2 = (uint256)(CHashWriter(SER_GETHASH, 0) << 2).GetHash();
491 
492  // Test: Make sure the buckets are what we expect
494  BOOST_CHECK_EQUAL(info1.GetNewBucket(nKey1, source1, EMPTY_NETGROUPMAN), 786);
495 
496  // Test: Make sure key actually randomizes bucket placement. A fail on
497  // this test could be a security issue.
499 
500  // Test: Ports should not affect bucket placement in the addr
501  AddrInfo info2 = AddrInfo(addr2, source1);
502  BOOST_CHECK(info1.GetKey() != info2.GetKey());
504 
505  std::set<int> buckets;
506  for (int i = 0; i < 255; i++) {
507  AddrInfo infoi = AddrInfo(
508  CAddress(ResolveService("250.1.1." + ToString(i)), NODE_NONE),
509  ResolveIP("250.1.1." + ToString(i)));
510  int bucket = infoi.GetNewBucket(nKey1, EMPTY_NETGROUPMAN);
511  buckets.insert(bucket);
512  }
513  // Test: IP addresses in the same group (\16 prefix for IPv4) should
514  // always map to the same bucket.
515  BOOST_CHECK_EQUAL(buckets.size(), 1U);
516 
517  buckets.clear();
518  for (int j = 0; j < 4 * 255; j++) {
519  AddrInfo infoj = AddrInfo(CAddress(
521  ToString(250 + (j / 255)) + "." + ToString(j % 256) + ".1.1"), NODE_NONE),
522  ResolveIP("251.4.1.1"));
523  int bucket = infoj.GetNewBucket(nKey1, EMPTY_NETGROUPMAN);
524  buckets.insert(bucket);
525  }
526  // Test: IP addresses in the same source groups should map to NO MORE
527  // than 64 buckets.
528  BOOST_CHECK(buckets.size() <= 64);
529 
530  buckets.clear();
531  for (int p = 0; p < 255; p++) {
532  AddrInfo infoj = AddrInfo(
533  CAddress(ResolveService("250.1.1.1"), NODE_NONE),
534  ResolveIP("250." + ToString(p) + ".1.1"));
535  int bucket = infoj.GetNewBucket(nKey1, EMPTY_NETGROUPMAN);
536  buckets.insert(bucket);
537  }
538  // Test: IP addresses in the different source groups should map to MORE
539  // than 64 buckets.
540  BOOST_CHECK(buckets.size() > 64);
541 }
542 
543 // The following three test cases use asmap.raw
544 // We use an artificial minimal mock mapping
545 // 250.0.0.0/8 AS1000
546 // 101.1.0.0/16 AS1
547 // 101.2.0.0/16 AS2
548 // 101.3.0.0/16 AS3
549 // 101.4.0.0/16 AS4
550 // 101.5.0.0/16 AS5
551 // 101.6.0.0/16 AS6
552 // 101.7.0.0/16 AS7
553 // 101.8.0.0/16 AS8
554 BOOST_AUTO_TEST_CASE(caddrinfo_get_tried_bucket)
555 {
556  std::vector<bool> asmap = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
557  NetGroupManager ngm_asmap{asmap};
558 
559  CAddress addr1 = CAddress(ResolveService("250.1.1.1", 8333), NODE_NONE);
560  CAddress addr2 = CAddress(ResolveService("250.1.1.1", 9999), NODE_NONE);
561 
562  CNetAddr source1 = ResolveIP("250.1.1.1");
563 
564 
565  AddrInfo info1 = AddrInfo(addr1, source1);
566 
567  uint256 nKey1 = (uint256)(CHashWriter(SER_GETHASH, 0) << 1).GetHash();
568  uint256 nKey2 = (uint256)(CHashWriter(SER_GETHASH, 0) << 2).GetHash();
569 
570  BOOST_CHECK_EQUAL(info1.GetTriedBucket(nKey1, ngm_asmap), 236);
571 
572  // Test: Make sure key actually randomizes bucket placement. A fail on
573  // this test could be a security issue.
574  BOOST_CHECK(info1.GetTriedBucket(nKey1, ngm_asmap) != info1.GetTriedBucket(nKey2, ngm_asmap));
575 
576  // Test: Two addresses with same IP but different ports can map to
577  // different buckets because they have different keys.
578  AddrInfo info2 = AddrInfo(addr2, source1);
579 
580  BOOST_CHECK(info1.GetKey() != info2.GetKey());
581  BOOST_CHECK(info1.GetTriedBucket(nKey1, ngm_asmap) != info2.GetTriedBucket(nKey1, ngm_asmap));
582 
583  std::set<int> buckets;
584  for (int j = 0; j < 255; j++) {
585  AddrInfo infoj = AddrInfo(
586  CAddress(ResolveService("101." + ToString(j) + ".1.1"), NODE_NONE),
587  ResolveIP("101." + ToString(j) + ".1.1"));
588  int bucket = infoj.GetTriedBucket(nKey1, ngm_asmap);
589  buckets.insert(bucket);
590  }
591  // Test: IP addresses in the different /16 prefix MAY map to more than
592  // 8 buckets.
593  BOOST_CHECK(buckets.size() > 8);
594 
595  buckets.clear();
596  for (int j = 0; j < 255; j++) {
597  AddrInfo infoj = AddrInfo(
598  CAddress(ResolveService("250." + ToString(j) + ".1.1"), NODE_NONE),
599  ResolveIP("250." + ToString(j) + ".1.1"));
600  int bucket = infoj.GetTriedBucket(nKey1, ngm_asmap);
601  buckets.insert(bucket);
602  }
603  // Test: IP addresses in the different /16 prefix MAY NOT map to more than
604  // 8 buckets.
605  BOOST_CHECK(buckets.size() == 8);
606 }
607 
608 BOOST_AUTO_TEST_CASE(caddrinfo_get_new_bucket)
609 {
610  std::vector<bool> asmap = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
611  NetGroupManager ngm_asmap{asmap};
612 
613  CAddress addr1 = CAddress(ResolveService("250.1.2.1", 8333), NODE_NONE);
614  CAddress addr2 = CAddress(ResolveService("250.1.2.1", 9999), NODE_NONE);
615 
616  CNetAddr source1 = ResolveIP("250.1.2.1");
617 
618  AddrInfo info1 = AddrInfo(addr1, source1);
619 
620  uint256 nKey1 = (uint256)(CHashWriter(SER_GETHASH, 0) << 1).GetHash();
621  uint256 nKey2 = (uint256)(CHashWriter(SER_GETHASH, 0) << 2).GetHash();
622 
623  // Test: Make sure the buckets are what we expect
624  BOOST_CHECK_EQUAL(info1.GetNewBucket(nKey1, ngm_asmap), 795);
625  BOOST_CHECK_EQUAL(info1.GetNewBucket(nKey1, source1, ngm_asmap), 795);
626 
627  // Test: Make sure key actually randomizes bucket placement. A fail on
628  // this test could be a security issue.
629  BOOST_CHECK(info1.GetNewBucket(nKey1, ngm_asmap) != info1.GetNewBucket(nKey2, ngm_asmap));
630 
631  // Test: Ports should not affect bucket placement in the addr
632  AddrInfo info2 = AddrInfo(addr2, source1);
633  BOOST_CHECK(info1.GetKey() != info2.GetKey());
634  BOOST_CHECK_EQUAL(info1.GetNewBucket(nKey1, ngm_asmap), info2.GetNewBucket(nKey1, ngm_asmap));
635 
636  std::set<int> buckets;
637  for (int i = 0; i < 255; i++) {
638  AddrInfo infoi = AddrInfo(
639  CAddress(ResolveService("250.1.1." + ToString(i)), NODE_NONE),
640  ResolveIP("250.1.1." + ToString(i)));
641  int bucket = infoi.GetNewBucket(nKey1, ngm_asmap);
642  buckets.insert(bucket);
643  }
644  // Test: IP addresses in the same /16 prefix
645  // usually map to the same bucket.
646  BOOST_CHECK_EQUAL(buckets.size(), 1U);
647 
648  buckets.clear();
649  for (int j = 0; j < 4 * 255; j++) {
650  AddrInfo infoj = AddrInfo(CAddress(
652  ToString(250 + (j / 255)) + "." + ToString(j % 256) + ".1.1"), NODE_NONE),
653  ResolveIP("251.4.1.1"));
654  int bucket = infoj.GetNewBucket(nKey1, ngm_asmap);
655  buckets.insert(bucket);
656  }
657  // Test: IP addresses in the same source /16 prefix should not map to more
658  // than 64 buckets.
659  BOOST_CHECK(buckets.size() <= 64);
660 
661  buckets.clear();
662  for (int p = 0; p < 255; p++) {
663  AddrInfo infoj = AddrInfo(
664  CAddress(ResolveService("250.1.1.1"), NODE_NONE),
665  ResolveIP("101." + ToString(p) + ".1.1"));
666  int bucket = infoj.GetNewBucket(nKey1, ngm_asmap);
667  buckets.insert(bucket);
668  }
669  // Test: IP addresses in the different source /16 prefixes usually map to MORE
670  // than 1 bucket.
671  BOOST_CHECK(buckets.size() > 1);
672 
673  buckets.clear();
674  for (int p = 0; p < 255; p++) {
675  AddrInfo infoj = AddrInfo(
676  CAddress(ResolveService("250.1.1.1"), NODE_NONE),
677  ResolveIP("250." + ToString(p) + ".1.1"));
678  int bucket = infoj.GetNewBucket(nKey1, ngm_asmap);
679  buckets.insert(bucket);
680  }
681  // Test: IP addresses in the different source /16 prefixes sometimes map to NO MORE
682  // than 1 bucket.
683  BOOST_CHECK(buckets.size() == 1);
684 }
685 
686 BOOST_AUTO_TEST_CASE(addrman_serialization)
687 {
688  std::vector<bool> asmap1 = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
689  NetGroupManager netgroupman{asmap1};
690 
691  const auto ratio = GetCheckRatio(m_node);
692  auto addrman_asmap1 = std::make_unique<AddrMan>(netgroupman, DETERMINISTIC, ratio);
693  auto addrman_asmap1_dup = std::make_unique<AddrMan>(netgroupman, DETERMINISTIC, ratio);
694  auto addrman_noasmap = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, ratio);
695 
697 
698  CAddress addr = CAddress(ResolveService("250.1.1.1"), NODE_NONE);
699  CNetAddr default_source;
700 
701  addrman_asmap1->Add({addr}, default_source);
702 
703  stream << *addrman_asmap1;
704  // serizalizing/deserializing addrman with the same asmap
705  stream >> *addrman_asmap1_dup;
706 
707  AddressPosition addr_pos1 = addrman_asmap1->FindAddressEntry(addr).value();
708  AddressPosition addr_pos2 = addrman_asmap1_dup->FindAddressEntry(addr).value();
709  BOOST_CHECK(addr_pos1.multiplicity != 0);
710  BOOST_CHECK(addr_pos2.multiplicity != 0);
711 
712  BOOST_CHECK(addr_pos1 == addr_pos2);
713 
714  // deserializing asmaped peers.dat to non-asmaped addrman
715  stream << *addrman_asmap1;
716  stream >> *addrman_noasmap;
717  AddressPosition addr_pos3 = addrman_noasmap->FindAddressEntry(addr).value();
718  BOOST_CHECK(addr_pos3.multiplicity != 0);
719  BOOST_CHECK(addr_pos1.bucket != addr_pos3.bucket);
720  BOOST_CHECK(addr_pos1.position != addr_pos3.position);
721 
722  // deserializing non-asmaped peers.dat to asmaped addrman
723  addrman_asmap1 = std::make_unique<AddrMan>(netgroupman, DETERMINISTIC, ratio);
724  addrman_noasmap = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, ratio);
725  addrman_noasmap->Add({addr}, default_source);
726  stream << *addrman_noasmap;
727  stream >> *addrman_asmap1;
728 
729  AddressPosition addr_pos4 = addrman_asmap1->FindAddressEntry(addr).value();
730  BOOST_CHECK(addr_pos4.multiplicity != 0);
731  BOOST_CHECK(addr_pos4.bucket != addr_pos3.bucket);
732  BOOST_CHECK(addr_pos4 == addr_pos2);
733 
734  // used to map to different buckets, now maps to the same bucket.
735  addrman_asmap1 = std::make_unique<AddrMan>(netgroupman, DETERMINISTIC, ratio);
736  addrman_noasmap = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, ratio);
739  addrman_noasmap->Add({addr, addr2}, default_source);
740  AddressPosition addr_pos5 = addrman_noasmap->FindAddressEntry(addr1).value();
741  AddressPosition addr_pos6 = addrman_noasmap->FindAddressEntry(addr2).value();
742  BOOST_CHECK(addr_pos5.bucket != addr_pos6.bucket);
743  stream << *addrman_noasmap;
744  stream >> *addrman_asmap1;
745  AddressPosition addr_pos7 = addrman_asmap1->FindAddressEntry(addr1).value();
746  AddressPosition addr_pos8 = addrman_asmap1->FindAddressEntry(addr2).value();
747  BOOST_CHECK(addr_pos7.bucket == addr_pos8.bucket);
748  BOOST_CHECK(addr_pos7.position != addr_pos8.position);
749 }
750 
751 BOOST_AUTO_TEST_CASE(remove_invalid)
752 {
753  // Confirm that invalid addresses are ignored in unserialization.
754 
755  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
757 
758  const CAddress new1{ResolveService("5.5.5.5"), NODE_NONE};
759  const CAddress new2{ResolveService("6.6.6.6"), NODE_NONE};
760  const CAddress tried1{ResolveService("7.7.7.7"), NODE_NONE};
761  const CAddress tried2{ResolveService("8.8.8.8"), NODE_NONE};
762 
763  addrman->Add({new1, tried1, new2, tried2}, CNetAddr{});
764  addrman->Good(tried1);
765  addrman->Good(tried2);
766  BOOST_REQUIRE_EQUAL(addrman->Size(), 4);
767 
768  stream << *addrman;
769 
770  const std::string str{stream.str()};
771  size_t pos;
772 
773  const char new2_raw[]{6, 6, 6, 6};
774  const uint8_t new2_raw_replacement[]{0, 0, 0, 0}; // 0.0.0.0 is !IsValid()
775  pos = str.find(new2_raw, 0, sizeof(new2_raw));
776  BOOST_REQUIRE(pos != std::string::npos);
777  BOOST_REQUIRE(pos + sizeof(new2_raw_replacement) <= stream.size());
778  memcpy(stream.data() + pos, new2_raw_replacement, sizeof(new2_raw_replacement));
779 
780  const char tried2_raw[]{8, 8, 8, 8};
781  const uint8_t tried2_raw_replacement[]{255, 255, 255, 255}; // 255.255.255.255 is !IsValid()
782  pos = str.find(tried2_raw, 0, sizeof(tried2_raw));
783  BOOST_REQUIRE(pos != std::string::npos);
784  BOOST_REQUIRE(pos + sizeof(tried2_raw_replacement) <= stream.size());
785  memcpy(stream.data() + pos, tried2_raw_replacement, sizeof(tried2_raw_replacement));
786 
787  addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
788  stream >> *addrman;
789  BOOST_CHECK_EQUAL(addrman->Size(), 2);
790 }
791 
792 BOOST_AUTO_TEST_CASE(addrman_selecttriedcollision)
793 {
794  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
795 
796  BOOST_CHECK(addrman->Size() == 0);
797 
798  // Empty addrman should return blank addrman info.
799  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
800 
801  // Add twenty two addresses.
802  CNetAddr source = ResolveIP("252.2.2.2");
803  for (unsigned int i = 1; i < 23; i++) {
804  CService addr = ResolveService("250.1.1." + ToString(i));
805  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
806 
807  // No collisions in tried.
808  BOOST_CHECK(addrman->Good(addr));
809  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
810  }
811 
812  // Ensure Good handles duplicates well.
813  // If an address is a duplicate, Good will return false but will not count it as a collision.
814  for (unsigned int i = 1; i < 23; i++) {
815  CService addr = ResolveService("250.1.1." + ToString(i));
816 
817  // Unable to add duplicate address to tried table.
818  BOOST_CHECK(!addrman->Good(addr));
819 
820  // Verify duplicate address not marked as a collision.
821  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
822  }
823 }
824 
825 BOOST_AUTO_TEST_CASE(addrman_noevict)
826 {
827  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
828 
829  // Add 35 addresses.
830  CNetAddr source = ResolveIP("252.2.2.2");
831  for (unsigned int i = 1; i < 36; i++) {
832  CService addr = ResolveService("250.1.1." + ToString(i));
833  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
834 
835  // No collision yet.
836  BOOST_CHECK(addrman->Good(addr));
837  }
838 
839  // Collision in tried table between 36 and 19.
840  CService addr36 = ResolveService("250.1.1.36");
841  BOOST_CHECK(addrman->Add({CAddress(addr36, NODE_NONE)}, source));
842  BOOST_CHECK(!addrman->Good(addr36));
843  BOOST_CHECK_EQUAL(addrman->SelectTriedCollision().first.ToStringAddrPort(), "250.1.1.19:0");
844 
845  // 36 should be discarded and 19 not evicted.
846  // This means we keep 19 in the tried table and
847  // 36 stays in the new table.
848  addrman->ResolveCollisions();
849  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
850 
851  // Lets create two collisions.
852  for (unsigned int i = 37; i < 59; i++) {
853  CService addr = ResolveService("250.1.1." + ToString(i));
854  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
855  BOOST_CHECK(addrman->Good(addr));
856  }
857 
858  // Cause a collision in the tried table.
859  CService addr59 = ResolveService("250.1.1.59");
860  BOOST_CHECK(addrman->Add({CAddress(addr59, NODE_NONE)}, source));
861  BOOST_CHECK(!addrman->Good(addr59));
862 
863  BOOST_CHECK_EQUAL(addrman->SelectTriedCollision().first.ToStringAddrPort(), "250.1.1.10:0");
864 
865  // Cause a second collision in the new table.
866  BOOST_CHECK(!addrman->Add({CAddress(addr36, NODE_NONE)}, source));
867 
868  // 36 still cannot be moved from new to tried due to colliding with 19
869  BOOST_CHECK(!addrman->Good(addr36));
870  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() != "[::]:0");
871 
872  // Resolve all collisions.
873  addrman->ResolveCollisions();
874  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
875 }
876 
877 BOOST_AUTO_TEST_CASE(addrman_evictionworks)
878 {
879  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
880 
881  BOOST_CHECK(addrman->Size() == 0);
882 
883  // Empty addrman should return blank addrman info.
884  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
885 
886  // Add 35 addresses
887  CNetAddr source = ResolveIP("252.2.2.2");
888  for (unsigned int i = 1; i < 36; i++) {
889  CService addr = ResolveService("250.1.1." + ToString(i));
890  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
891 
892  // No collision yet.
893  BOOST_CHECK(addrman->Good(addr));
894  }
895 
896  // Collision between 36 and 19.
897  CService addr = ResolveService("250.1.1.36");
898  BOOST_CHECK(addrman->Add({CAddress(addr, NODE_NONE)}, source));
899  BOOST_CHECK(!addrman->Good(addr));
900 
901  auto info = addrman->SelectTriedCollision().first;
902  BOOST_CHECK_EQUAL(info.ToStringAddrPort(), "250.1.1.19:0");
903 
904  // Ensure test of address fails, so that it is evicted.
905  // Update entry in tried by setting last good connection in the deep past.
906  BOOST_CHECK(!addrman->Good(info, NodeSeconds{1s}));
907  addrman->Attempt(info, /*fCountFailure=*/false, Now<NodeSeconds>() - 61s);
908 
909  // Should swap 36 for 19.
910  addrman->ResolveCollisions();
911  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
912  AddressPosition addr_pos{addrman->FindAddressEntry(CAddress(addr, NODE_NONE)).value()};
913  BOOST_CHECK(addr_pos.tried);
914 
915  // If 36 was swapped for 19, then adding 36 to tried should fail because we
916  // are attempting to add a duplicate.
917  // We check this by verifying Good() returns false and also verifying that
918  // we have no collisions.
919  BOOST_CHECK(!addrman->Good(addr));
920  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
921 
922  // 19 should fail as a collision (not a duplicate) if we now attempt to move
923  // it to the tried table.
924  CService addr19 = ResolveService("250.1.1.19");
925  BOOST_CHECK(!addrman->Good(addr19));
926  BOOST_CHECK_EQUAL(addrman->SelectTriedCollision().first.ToStringAddrPort(), "250.1.1.36:0");
927 
928  // Eviction is also successful if too much time has passed since last try
929  SetMockTime(GetTime() + 4 * 60 *60);
930  addrman->ResolveCollisions();
931  BOOST_CHECK(addrman->SelectTriedCollision().first.ToStringAddrPort() == "[::]:0");
932  //Now 19 is in tried again, and 36 back to new
933  AddressPosition addr_pos19{addrman->FindAddressEntry(CAddress(addr19, NODE_NONE)).value()};
934  BOOST_CHECK(addr_pos19.tried);
935  AddressPosition addr_pos36{addrman->FindAddressEntry(CAddress(addr, NODE_NONE)).value()};
936  BOOST_CHECK(!addr_pos36.tried);
937 }
938 
939 static CDataStream AddrmanToStream(const AddrMan& addrman)
940 {
941  CDataStream ssPeersIn(SER_DISK, CLIENT_VERSION);
942  ssPeersIn << Params().MessageStart();
943  ssPeersIn << addrman;
944  return ssPeersIn;
945 }
946 
947 BOOST_AUTO_TEST_CASE(load_addrman)
948 {
950 
951  std::optional<CService> addr1, addr2, addr3, addr4;
952  addr1 = Lookup("250.7.1.1", 8333, false);
953  BOOST_CHECK(addr1.has_value());
954  addr2 = Lookup("250.7.2.2", 9999, false);
955  BOOST_CHECK(addr2.has_value());
956  addr3 = Lookup("250.7.3.3", 9999, false);
957  BOOST_CHECK(addr3.has_value());
958  addr3 = Lookup("250.7.3.3"s, 9999, false);
959  BOOST_CHECK(addr3.has_value());
960  addr4 = Lookup("250.7.3.3\0example.com"s, 9999, false);
961  BOOST_CHECK(!addr4.has_value());
962 
963  // Add three addresses to new table.
964  const std::optional<CService> source{Lookup("252.5.1.1", 8333, false)};
965  BOOST_CHECK(source.has_value());
966  std::vector<CAddress> addresses{CAddress(addr1.value(), NODE_NONE), CAddress(addr2.value(), NODE_NONE), CAddress(addr3.value(), NODE_NONE)};
967  BOOST_CHECK(addrman.Add(addresses, source.value()));
968  BOOST_CHECK(addrman.Size() == 3);
969 
970  // Test that the de-serialization does not throw an exception.
971  CDataStream ssPeers1 = AddrmanToStream(addrman);
972  bool exceptionThrown = false;
974 
975  BOOST_CHECK(addrman1.Size() == 0);
976  try {
977  unsigned char pchMsgTmp[4];
978  ssPeers1 >> pchMsgTmp;
979  ssPeers1 >> addrman1;
980  } catch (const std::exception&) {
981  exceptionThrown = true;
982  }
983 
984  BOOST_CHECK(addrman1.Size() == 3);
985  BOOST_CHECK(exceptionThrown == false);
986 
987  // Test that ReadFromStream creates an addrman with the correct number of addrs.
988  CDataStream ssPeers2 = AddrmanToStream(addrman);
989 
991  BOOST_CHECK(addrman2.Size() == 0);
992  ReadFromStream(addrman2, ssPeers2);
993  BOOST_CHECK(addrman2.Size() == 3);
994 }
995 
996 // Produce a corrupt peers.dat that claims 20 addrs when it only has one addr.
998 {
1000  s << ::Params().MessageStart();
1001 
1002  unsigned char nVersion = 1;
1003  s << nVersion;
1004  s << ((unsigned char)32);
1005  s << uint256::ONE;
1006  s << 10; // nNew
1007  s << 10; // nTried
1008 
1009  int nUBuckets = ADDRMAN_NEW_BUCKET_COUNT ^ (1 << 30);
1010  s << nUBuckets;
1011 
1012  const std::optional<CService> serv{Lookup("252.1.1.1", 7777, false)};
1013  BOOST_REQUIRE(serv.has_value());
1014  CAddress addr = CAddress(serv.value(), NODE_NONE);
1015  std::optional<CNetAddr> resolved{LookupHost("252.2.2.2", false)};
1016  BOOST_REQUIRE(resolved.has_value());
1017  AddrInfo info = AddrInfo(addr, resolved.value());
1018  s << info;
1019 
1020  return s;
1021 }
1022 
1023 BOOST_AUTO_TEST_CASE(load_addrman_corrupted)
1024 {
1025  // Test that the de-serialization of corrupted peers.dat throws an exception.
1026  CDataStream ssPeers1 = MakeCorruptPeersDat();
1027  bool exceptionThrown = false;
1029  BOOST_CHECK(addrman1.Size() == 0);
1030  try {
1031  unsigned char pchMsgTmp[4];
1032  ssPeers1 >> pchMsgTmp;
1033  ssPeers1 >> addrman1;
1034  } catch (const std::exception&) {
1035  exceptionThrown = true;
1036  }
1037  BOOST_CHECK(exceptionThrown);
1038 
1039  // Test that ReadFromStream fails if peers.dat is corrupt
1040  CDataStream ssPeers2 = MakeCorruptPeersDat();
1041 
1043  BOOST_CHECK(addrman2.Size() == 0);
1044  BOOST_CHECK_THROW(ReadFromStream(addrman2, ssPeers2), std::ios_base::failure);
1045 }
1046 
1047 BOOST_AUTO_TEST_CASE(addrman_update_address)
1048 {
1049  // Tests updating nTime via Connected() and nServices via SetServices()
1050  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
1051  CNetAddr source{ResolveIP("252.2.2.2")};
1052  CAddress addr{CAddress(ResolveService("250.1.1.1", 8333), NODE_NONE)};
1053 
1054  const auto start_time{Now<NodeSeconds>() - 10000s};
1055  addr.nTime = start_time;
1056  BOOST_CHECK(addrman->Add({addr}, source));
1057  BOOST_CHECK_EQUAL(addrman->Size(), 1U);
1058 
1059  // Updating an addrman entry with a different port doesn't change it
1060  CAddress addr_diff_port{CAddress(ResolveService("250.1.1.1", 8334), NODE_NONE)};
1061  addr_diff_port.nTime = start_time;
1062  addrman->Connected(addr_diff_port);
1063  addrman->SetServices(addr_diff_port, NODE_NETWORK_LIMITED);
1064  std::vector<CAddress> vAddr1{addrman->GetAddr(/*max_addresses=*/0, /*max_pct=*/0, /*network=*/std::nullopt)};
1065  BOOST_CHECK_EQUAL(vAddr1.size(), 1U);
1066  BOOST_CHECK(vAddr1.at(0).nTime == start_time);
1067  BOOST_CHECK_EQUAL(vAddr1.at(0).nServices, NODE_NONE);
1068 
1069  // Updating an addrman entry with the correct port is successful
1070  addrman->Connected(addr);
1071  addrman->SetServices(addr, NODE_NETWORK_LIMITED);
1072  std::vector<CAddress> vAddr2 = addrman->GetAddr(/*max_addresses=*/0, /*max_pct=*/0, /*network=*/std::nullopt);
1073  BOOST_CHECK_EQUAL(vAddr2.size(), 1U);
1074  BOOST_CHECK(vAddr2.at(0).nTime >= start_time + 10000s);
1075  BOOST_CHECK_EQUAL(vAddr2.at(0).nServices, NODE_NETWORK_LIMITED);
1076 }
1077 
1079 {
1080  auto addrman = std::make_unique<AddrMan>(EMPTY_NETGROUPMAN, DETERMINISTIC, GetCheckRatio(m_node));
1081  const CNetAddr source = ResolveIP("252.2.2.2");
1082 
1083  // empty addrman
1084  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/std::nullopt), 0U);
1085  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/std::nullopt), 0U);
1086  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/true), 0U);
1087  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/false), 0U);
1088 
1089  // add two ipv4 addresses, one to tried and new
1090  const CAddress addr1{ResolveService("250.1.1.1", 8333), NODE_NONE};
1091  BOOST_CHECK(addrman->Add({addr1}, source));
1092  BOOST_CHECK(addrman->Good(addr1));
1093  const CAddress addr2{ResolveService("250.1.1.2", 8333), NODE_NONE};
1094  BOOST_CHECK(addrman->Add({addr2}, source));
1095 
1096  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/std::nullopt), 2U);
1097  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/std::nullopt), 2U);
1098  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/true), 1U);
1099  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/false), 1U);
1100  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/true), 1U);
1101  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/false), 1U);
1102 
1103  // add one i2p address to new
1104  CService i2p_addr;
1105  i2p_addr.SetSpecial("UDHDrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jna.b32.I2P");
1106  const CAddress addr3{i2p_addr, NODE_NONE};
1107  BOOST_CHECK(addrman->Add({addr3}, source));
1108  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/std::nullopt), 3U);
1109  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_IPV4, /*in_new=*/std::nullopt), 2U);
1110  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_I2P, /*in_new=*/std::nullopt), 1U);
1111  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/NET_I2P, /*in_new=*/true), 1U);
1112  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/true), 2U);
1113  BOOST_CHECK_EQUAL(addrman->Size(/*net=*/std::nullopt, /*in_new=*/false), 1U);
1114 }
1115 
void ReadFromStream(AddrMan &addr, CDataStream &ssPeers)
Only used by tests.
Definition: addrdb.cpp:181
static constexpr int ADDRMAN_NEW_BUCKET_COUNT
Definition: addrman_impl.h:31
static NetGroupManager EMPTY_NETGROUPMAN
static CService ResolveService(const std::string &ip, uint16_t port=0)
static int32_t GetCheckRatio(const NodeContext &node_ctx)
static CDataStream AddrmanToStream(const AddrMan &addrman)
static const bool DETERMINISTIC
BOOST_AUTO_TEST_CASE(addrman_simple)
static std::vector< bool > FromBytes(const unsigned char *source, int vector_size)
static CDataStream MakeCorruptPeersDat()
static CNetAddr ResolveIP(const std::string &ip)
node::NodeContext m_node
Definition: bitcoin-gui.cpp:37
const CChainParams & Params()
Return the currently selected parameters.
Extended statistics about a CAddress.
Definition: addrman_impl.h:40
int GetNewBucket(const uint256 &nKey, const CNetAddr &src, const NetGroupManager &netgroupman) const
Calculate in which "new" bucket this entry belongs, given a certain source.
Definition: addrman.cpp:53
int GetTriedBucket(const uint256 &nKey, const NetGroupManager &netgroupman) const
Calculate in which "tried" bucket this entry belongs.
Definition: addrman.cpp:46
Stochastic address manager.
Definition: addrman.h:87
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:481
A CService with information about it as peer.
Definition: protocol.h:360
NodeSeconds nTime
Always included in serialization. The behavior is unspecified if the value is not representable as ui...
Definition: protocol.h:440
const CMessageHeader::MessageStartChars & MessageStart() const
Definition: chainparams.h:90
Network address.
Definition: netaddress.h:120
bool SetSpecial(const std::string &addr)
Parse a Tor or I2P address and set this object to it.
Definition: netaddress.cpp:208
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:520
std::vector< unsigned char > GetKey() const
Definition: netaddress.cpp:906
size_type size() const
Definition: streams.h:220
value_type * data()
Definition: streams.h:227
std::string str() const
Definition: streams.h:207
Netgroup manager.
Definition: netgroup.h:16
256-bit opaque blob.
Definition: uint256.h:105
static const uint256 ONE
Definition: uint256.h:111
static const int CLIENT_VERSION
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
Definition: clientversion.h:33
BOOST_AUTO_TEST_SUITE_END()
static CService ip(uint32_t i)
static const std::string addr1
Definition: key_tests.cpp:25
static const std::string addr2
Definition: key_tests.cpp:26
@ NET_I2P
I2P.
Definition: netaddress.h:58
@ NET_CJDNS
CJDNS.
Definition: netaddress.h:61
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:55
@ NET_IPV6
IPv6.
Definition: netaddress.h:52
@ NET_IPV4
IPv4.
Definition: netaddress.h:49
std::vector< CService > Lookup(const std::string &name, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:182
std::vector< CNetAddr > LookupHost(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
Definition: netbase.cpp:164
#define BOOST_CHECK_THROW(stmt, excMatch)
Definition: object.cpp:19
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18
#define BOOST_CHECK(expr)
Definition: object.cpp:17
@ NODE_NONE
Definition: protocol.h:277
@ NODE_NETWORK_LIMITED
Definition: protocol.h:292
const char * source
Definition: rpcconsole.cpp:58
@ SER_DISK
Definition: serialize.h:132
@ SER_NETWORK
Definition: serialize.h:131
@ SER_GETHASH
Definition: serialize.h:133
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:109
Test-only struct, capturing info about an address in AddrMan.
Definition: addrman.h:33
const int bucket
Definition: addrman.h:46
const int position
Definition: addrman.h:47
const int multiplicity
Definition: addrman.h:40
Basic testing setup.
Definition: setup_common.h:80
NodeContext struct containing references to chain state and connection state.
Definition: context.h:45
ArgsManager * args
Definition: context.h:58
int64_t GetTime()
Definition: time.cpp:97
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:81
std::chrono::time_point< NodeClock, std::chrono::seconds > NodeSeconds
Definition: time.h:25
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1162
static const int PROTOCOL_VERSION
network protocol versioning
Definition: version.h:12