src/addrman.h

   1 // Copyright (c) 2012 Pieter Wuille
   2 // Distributed under the MIT/X11 software license, see the accompanying
   3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4 #ifndef _BITCOIN_ADDRMAN
   5 #define _BITCOIN_ADDRMAN 1
   6
   7 #include "netbase.h"
   8 #include "protocol.h"
   9 #include "util.h"
  10 #include "sync.h"
  11
  12
  13 #include <map>
  14 #include <vector>
  15
  16 #include <openssl/rand.h>
  17
  18
  19 /** Extended statistics about a CAddress */
  20 class CAddrInfo : public CAddress
  21 {
  22 private:
  23     // where knowledge about this address first came from
  24     CNetAddr source;
  25
  26     // last successful connection by us
  27     int64_t nLastSuccess;
  28
  29     // last try whatsoever by us:
  30     // int64_t CAddress::nLastTry
  31
  32     // connection attempts since last successful attempt
  33     int nAttempts;
  34
  35     // reference count in new sets (memory only)
  36     int nRefCount;
  37
  38     // in tried set? (memory only)
  39     bool fInTried;
  40
  41     // position in vRandom
  42     int nRandomPos;
  43
  44     friend class CAddrMan;
  45
  46 public:
  47
  48     IMPLEMENT_SERIALIZE(
  49         CAddress* pthis = (CAddress*)(this);
  50         READWRITE(*pthis);
  51         READWRITE(source);
  52         READWRITE(nLastSuccess);
  53         READWRITE(nAttempts);
  54     )
  55
  56     void Init()
  57     {
  58         nLastSuccess = 0;
  59         nLastTry = 0;
  60         nAttempts = 0;
  61         nRefCount = 0;
  62         fInTried = false;
  63         nRandomPos = -1;
  64     }
  65
  66     CAddrInfo(const CAddress &addrIn, const CNetAddr &addrSource) : CAddress(addrIn), source(addrSource)
  67     {
  68         Init();
  69     }
  70
  71     CAddrInfo() : CAddress(), source()
  72     {
  73         Init();
  74     }
  75
  76     // Calculate in which "tried" bucket this entry belongs
  77     int GetTriedBucket(const std::vector<unsigned char> &nKey) const;
  78
  79     // Calculate in which "new" bucket this entry belongs, given a certain source
  80     int GetNewBucket(const std::vector<unsigned char> &nKey, const CNetAddr& src) const;
  81
  82     // Calculate in which "new" bucket this entry belongs, using its default source
  83     int GetNewBucket(const std::vector<unsigned char> &nKey) const
  84     {
  85         return GetNewBucket(nKey, source);
  86     }
  87
  88     // Determine whether the statistics about this entry are bad enough so that it can just be deleted
  89     bool IsTerrible(int64_t nNow = GetAdjustedTime()) const;
  90
  91     // Calculate the relative chance this entry should be given when selecting nodes to connect to
  92     double GetChance(int64_t nNow = GetAdjustedTime()) const;
  93
  94 };
  95
  96 // Stochastic address manager
  97 //
  98 // Design goals:
  99 //  * Only keep a limited number of addresses around, so that addr.dat and memory requirements do not grow without bound.
 100 //  * Keep the address tables in-memory, and asynchronously dump the entire to able in addr.dat.
 101 //  * Make sure no (localized) attacker can fill the entire table with his nodes/addresses.
 102 //
 103 // To that end:
 104 //  * Addresses are organized into buckets.
 105 //    * Address that have not yet been tried go into 256 "new" buckets.
 106 //      * Based on the address range (/16 for IPv4) of source of the information, 32 buckets are selected at random
 107 //      * The actual bucket is chosen from one of these, based on the range the address itself is located.
 108 //      * One single address can occur in up to 4 different buckets, to increase selection chances for addresses that
 109 //        are seen frequently. The chance for increasing this multiplicity decreases exponentially.
 110 //      * When adding a new address to a full bucket, a randomly chosen entry (with a bias favoring less recently seen
 111 //        ones) is removed from it first.
 112 //    * Addresses of nodes that are known to be accessible go into 64 "tried" buckets.
 113 //      * Each address range selects at random 4 of these buckets.
 114 //      * The actual bucket is chosen from one of these, based on the full address.
 115 //      * When adding a new good address to a full bucket, a randomly chosen entry (with a bias favoring less recently
 116 //        tried ones) is evicted from it, back to the "new" buckets.
 117 //    * Bucket selection is based on cryptographic hashing, using a randomly-generated 256-bit key, which should not
 118 //      be observable by adversaries.
 119 //    * Several indexes are kept for high performance. Defining DEBUG_ADDRMAN will introduce frequent (and expensive)
 120 //      consistency checks for the entire data structure.
 121
 122 // total number of buckets for tried addresses
 123 #define ADDRMAN_TRIED_BUCKET_COUNT 64
 124
 125 // maximum allowed number of entries in buckets for tried addresses
 126 #define ADDRMAN_TRIED_BUCKET_SIZE 64
 127
 128 // total number of buckets for new addresses
 129 #define ADDRMAN_NEW_BUCKET_COUNT 256
 130
 131 // maximum allowed number of entries in buckets for new addresses
 132 #define ADDRMAN_NEW_BUCKET_SIZE 64
 133
 134 // over how many buckets entries with tried addresses from a single group (/16 for IPv4) are spread
 135 #define ADDRMAN_TRIED_BUCKETS_PER_GROUP 4
 136
 137 // over how many buckets entries with new addresses originating from a single group are spread
 138 #define ADDRMAN_NEW_BUCKETS_PER_SOURCE_GROUP 32
 139
 140 // in how many buckets for entries with new addresses a single address may occur
 141 #define ADDRMAN_NEW_BUCKETS_PER_ADDRESS 4
 142
 143 // how many entries in a bucket with tried addresses are inspected, when selecting one to replace
 144 #define ADDRMAN_TRIED_ENTRIES_INSPECT_ON_EVICT 4
 145
 146 // how old addresses can maximally be
 147 #define ADDRMAN_HORIZON_DAYS 30
 148
 149 // after how many failed attempts we give up on a new node
 150 #define ADDRMAN_RETRIES 3
 151
 152 // how many successive failures are allowed ...
 153 #define ADDRMAN_MAX_FAILURES 10
 154
 155 // ... in at least this many days
 156 #define ADDRMAN_MIN_FAIL_DAYS 7
 157
 158 // the maximum percentage of nodes to return in a getaddr call
 159 #define ADDRMAN_GETADDR_MAX_PCT 23
 160
 161 // the maximum number of nodes to return in a getaddr call
 162 #define ADDRMAN_GETADDR_MAX 2500
 163
 164 /** Stochastical (IP) address manager */
 165 class CAddrMan
 166 {
 167 private:
 168     // critical section to protect the inner data structures
 169     mutable CCriticalSection cs;
 170
 171     // secret key to randomize bucket select with
 172     std::vector<unsigned char> nKey;
 173
 174     // last used nId
 175     int nIdCount;
 176
 177     // table with information about all nIds
 178     std::map<int, CAddrInfo> mapInfo;
 179
 180     // find an nId based on its network address
 181     std::map<CNetAddr, int> mapAddr;
 182
 183     // randomly-ordered vector of all nIds
 184     std::vector<int> vRandom;
 185
 186     // number of "tried" entries
 187     int nTried;
 188
 189     // list of "tried" buckets
 190     std::vector<std::vector<int> > vvTried;
 191
 192     // number of (unique) "new" entries
 193     int nNew;
 194
 195     // list of "new" buckets
 196     std::vector<std::set<int> > vvNew;
 197
 198 protected:
 199
 200     // Find an entry.
 201     CAddrInfo* Find(const CNetAddr& addr, int *pnId = NULL);
 202
 203     // find an entry, creating it if necessary.
 204     // nTime and nServices of found node is updated, if necessary.
 205     CAddrInfo* Create(const CAddress &addr, const CNetAddr &addrSource, int *pnId = NULL);
 206
 207     // Swap two elements in vRandom.
 208     void SwapRandom(unsigned int nRandomPos1, unsigned int nRandomPos2);
 209
 210     // Return position in given bucket to replace.
 211     int SelectTried(int nKBucket);
 212
 213     // Remove an element from a "new" bucket.
 214     // This is the only place where actual deletes occur.
 215     // They are never deleted while in the "tried" table, only possibly evicted back to the "new" table.
 216     int ShrinkNew(int nUBucket);
 217
 218     // Move an entry from the "new" table(s) to the "tried" table
 219     // @pre vvUnkown[nOrigin].count(nId) != 0
 220     void MakeTried(CAddrInfo& info, int nId, int nOrigin);
 221
 222     // Mark an entry "good", possibly moving it from "new" to "tried".
 223     void Good_(const CService &addr, int64_t nTime);
 224
 225     // Add an entry to the "new" table.
 226     bool Add_(const CAddress &addr, const CNetAddr& source, int64_t nTimePenalty);
 227
 228     // Mark an entry as attempted to connect.
 229     void Attempt_(const CService &addr, int64_t nTime);
 230
 231     // Select an address to connect to.
 232     // nUnkBias determines how much to favor new addresses over tried ones (min=0, max=100)
 233     CAddress Select_(int nUnkBias);
 234
 235 #ifdef DEBUG_ADDRMAN
 236     // Perform consistency check. Returns an error code or zero.
 237     int Check_();
 238 #endif
 239
 240     // Select several addresses at once.
 241     void GetAddr_(std::vector<CAddress> &vAddr);
 242     void GetOnlineAddr_(std::vector<CAddrInfo> &vAddr);
 243
 244     // Mark an entry as currently-connected-to.
 245     void Connected_(const CService &addr, int64_t nTime);
 246
 247 public:
 248
 249     typedef std::map<int, int> MapUnkIds; // For MSVC macro
 250     IMPLEMENT_SERIALIZE
 251             (
 252             LOCK(cs);
 253                 unsigned char
 254                     nVersion = 0;
 255
 256                 READWRITE(nVersion);
 257                 READWRITE(nKey);
 258                 READWRITE(nNew);
 259                 READWRITE(nTried);
 260
 261                 CAddrMan
 262                     *am = const_cast<CAddrMan*>(this);
 263
 264                 if (fWrite)
 265                 {
 266                     int
 267                         nUBuckets = ADDRMAN_NEW_BUCKET_COUNT;
 268
 269                     READWRITE(nUBuckets);
 270                     MapUnkIds mapUnkIds;
 271                     int
 272                         nIds = 0;
 273                     for (std::map<int, CAddrInfo>::iterator it = am->mapInfo.begin(); it != am->mapInfo.end(); it++)
 274                     {
 275                         if (nIds == nNew)
 276                             break; // this means nNew was wrong, oh ow
 277                         mapUnkIds[(*it).first] = nIds;
 278
 279                         CAddrInfo
 280                             &info = (*it).second;
 281
 282                         if (info.nRefCount)
 283                         {
 284                             READWRITE(info);
 285                             nIds++;
 286                         }
 287                     }
 288                     nIds = 0;
 289                     for (std::map<int, CAddrInfo>::iterator it = am->mapInfo.begin(); it != am->mapInfo.end(); it++)
 290                     {
 291                         if (nIds == nTried)
 292                             break; /* this means nTried was wrong, oh ow */
 293
 294                         CAddrInfo
 295                             &info = (*it).second;
 296
 297                         if (info.fInTried)
 298                         {
 299                             READWRITE(info);
 300                             nIds++;
 301                         }
 302                     }
 303                     for (
 304                          std::vector<std::set<int> >::iterator it = am->vvNew.begin();
 305                          it != am->vvNew.end();
 306                          it++
 307                         )
 308                     {
 309                         std::set<int>
 310                             &vNew = (*it);
 311
 312                         int
 313                             nSize = int( vNew.size() );
 314
 315                         READWRITE(nSize);
 316                         for (std::set<int>::iterator it2 = vNew.begin(); it2 != vNew.end(); it2++)
 317                         {
 318                         int
 319                             nIndex = mapUnkIds[*it2];
 320                         READWRITE(nIndex);
 321                         }
 322                     }
 323                 }
 324                 else
 325                 {
 326                     int
 327                         nUBuckets = 0;
 328
 329                     READWRITE(nUBuckets);
 330                     am->nIdCount = 0;
 331                     am->mapInfo.clear();
 332                     am->mapAddr.clear();
 333                     am->vRandom.clear();
 334                     am->vvTried =
 335                         std::vector<std::vector<int> >(
 336                                                         ADDRMAN_TRIED_BUCKET_COUNT,
 337                                                         std::vector<int>(0)
 338                                                       );
 339                     am->vvNew =
 340                         std::vector<std::set<int> >(
 341                                                     ADDRMAN_NEW_BUCKET_COUNT,
 342                                                     std::set<int>()
 343                                                    );
 344                     for (int n = 0; n < am->nNew; n++)
 345                     {
 346                         CAddrInfo
 347                             &info = am->mapInfo[n];
 348
 349                         READWRITE(info);
 350                         am->mapAddr[info] = n;
 351                         info.nRandomPos = int( vRandom.size() );
 352                         am->vRandom.push_back(n);
 353                         if (nUBuckets != ADDRMAN_NEW_BUCKET_COUNT)
 354                         {
 355                             am->vvNew[info.GetNewBucket(am->nKey)].insert(n);
 356                             info.nRefCount++;
 357                         }
 358                     }
 359                     am->nIdCount = am->nNew;
 360
 361                     int
 362                         nLost = 0;
 363
 364                     for (int n = 0; n < am->nTried; n++)
 365                     {
 366                         CAddrInfo
 367                             info;
 368
 369                         READWRITE(info);
 370
 371                         std::vector<int>
 372                             &vTried = am->vvTried[info.GetTriedBucket(am->nKey)];
 373
 374                         if (vTried.size() < ADDRMAN_TRIED_BUCKET_SIZE)
 375                         {
 376                             info.nRandomPos = int( vRandom.size() );
 377                             info.fInTried = true;
 378                             am->vRandom.push_back(am->nIdCount);
 379                             am->mapInfo[am->nIdCount] = info;
 380                             am->mapAddr[info] = am->nIdCount;
 381                             vTried.push_back(am->nIdCount);
 382                             am->nIdCount++;
 383                         }
 384                         else
 385                         {
 386                             nLost++;
 387                         }
 388                     }
 389                     am->nTried -= nLost;
 390                     for (int b = 0; b < nUBuckets; b++)
 391                     {
 392                         std::set<int>
 393                             &vNew = am->vvNew[b];
 394
 395                         int
 396                             nSize = 0;
 397
 398                         READWRITE(nSize);
 399                         for (int n = 0; n < nSize; n++)
 400                         {
 401                             int
 402                                 nIndex = 0;
 403
 404                             READWRITE(nIndex);
 405
 406                             CAddrInfo
 407                                 &info = am->mapInfo[nIndex];
 408
 409                             if (
 410                                 (nUBuckets == ADDRMAN_NEW_BUCKET_COUNT) &&
 411                                 (info.nRefCount < ADDRMAN_NEW_BUCKETS_PER_ADDRESS)
 412                                )
 413                             {
 414                                 info.nRefCount++;
 415                                 vNew.insert(nIndex);
 416                             }
 417                         }
 418                     }
 419                 }
 420             )
 421
 422
 423     CAddrMan() : vRandom(0), vvTried(ADDRMAN_TRIED_BUCKET_COUNT, std::vector<int>(0)), vvNew(ADDRMAN_NEW_BUCKET_COUNT, std::set<int>())
 424     {
 425          nKey.resize(32);
 426          RAND_bytes(&nKey[0], 32);
 427
 428          nIdCount = 0;
 429          nTried = 0;
 430          nNew = 0;
 431     }
 432
 433     // Return the number of (unique) addresses in all tables.
 434     int size()
 435     {
 436         return (int) vRandom.size();
 437     }
 438
 439     // Consistency check
 440     void Check()
 441     {
 442 #ifdef DEBUG_ADDRMAN
 443         {
 444             LOCK(cs);
 445             int err;
 446             if ((err=Check_()))
 447                 printf("ADDRMAN CONSISTENCY CHECK FAILED!!! err=%i\n", err);
 448         }
 449 #endif
 450     }
 451
 452     // Add a single address.
 453     bool Add(const CAddress &addr, const CNetAddr& source, int64_t nTimePenalty = 0)
 454     {
 455         bool fRet = false;
 456         {
 457             LOCK(cs);
 458             Check();
 459             fRet |= Add_(addr, source, nTimePenalty);
 460             Check();
 461         }
 462         if (fRet)
 463             printf("Added %s from %s: %i tried, %i new\n", addr.ToStringIPPort().c_str(), source.ToString().c_str(), nTried, nNew);
 464         return fRet;
 465     }
 466
 467     // Add multiple addresses.
 468     bool Add(const std::vector<CAddress> &vAddr, const CNetAddr& source, int64_t nTimePenalty = 0)
 469     {
 470         int nAdd = 0;
 471         {
 472             LOCK(cs);
 473             Check();
 474             for (std::vector<CAddress>::const_iterator it = vAddr.begin(); it != vAddr.end(); it++)
 475                 nAdd += Add_(*it, source, nTimePenalty) ? 1 : 0;
 476             Check();
 477         }
 478         if (nAdd)
 479             printf("Added %i addresses from %s: %i tried, %i new\n", nAdd, source.ToString().c_str(), nTried, nNew);
 480         return nAdd > 0;
 481     }
 482
 483     // Mark an entry as accessible.
 484     void Good(const CService &addr, int64_t nTime = GetAdjustedTime())
 485     {
 486         {
 487             LOCK(cs);
 488             Check();
 489             Good_(addr, nTime);
 490             Check();
 491         }
 492     }
 493
 494     // Mark an entry as connection attempted to.
 495     void Attempt(const CService &addr, int64_t nTime = GetAdjustedTime())
 496     {
 497         {
 498             LOCK(cs);
 499             Check();
 500             Attempt_(addr, nTime);
 501             Check();
 502         }
 503     }
 504
 505     // Choose an address to connect to.
 506     // nUnkBias determines how much "new" entries are favored over "tried" ones (0-100).
 507     CAddress Select(int nUnkBias = 50)
 508     {
 509         CAddress addrRet;
 510         {
 511             LOCK(cs);
 512             Check();
 513             addrRet = Select_(nUnkBias);
 514             Check();
 515         }
 516         return addrRet;
 517     }
 518
 519     // Return a bunch of addresses, selected at random.
 520     std::vector<CAddress> GetAddr()
 521     {
 522         Check();
 523         std::vector<CAddress> vAddr;
 524         {
 525             LOCK(cs);
 526             GetAddr_(vAddr);
 527         }
 528         Check();
 529         return vAddr;
 530     }
 531
 532     std::vector<CAddrInfo> GetOnlineAddr()
 533     {
 534         Check();
 535         std::vector<CAddrInfo> vAddr;
 536         {
 537             LOCK(cs);
 538             GetOnlineAddr_(vAddr);
 539         }
 540         Check();
 541         return vAddr;
 542     }
 543
 544     // Mark an entry as currently-connected-to.
 545     void Connected(const CService &addr, int64_t nTime = GetAdjustedTime())
 546     {
 547         {
 548             LOCK(cs);
 549             Check();
 550             Connected_(addr, nTime);
 551             Check();
 552         }
 553     }
 554 };
 555
 556 #endif