src/net.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2012 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
   5 #ifndef BITCOIN_NET_H
   6 #define BITCOIN_NET_H
   7
   8 #include <deque>
   9 #include <boost/array.hpp>
  10 #include <boost/foreach.hpp>
  11 #include <openssl/rand.h>
  12
  13 #ifndef WIN32
  14 #include <arpa/inet.h>
  15 #endif
  16
  17 #include "protocol.h"
  18
  19 class CAddrDB;
  20 class CRequestTracker;
  21 class CNode;
  22 class CBlockIndex;
  23 extern int nBestHeight;
  24 extern int nConnectTimeout;
  25
  26
  27
  28 inline unsigned int ReceiveBufferSize() { return 1000*GetArg("-maxreceivebuffer", 10*1000); }
  29 inline unsigned int SendBufferSize() { return 1000*GetArg("-maxsendbuffer", 10*1000); }
  30 static const unsigned int PUBLISH_HOPS = 5;
  31
  32 bool ConnectSocket(const CAddress& addrConnect, SOCKET& hSocketRet, int nTimeout=nConnectTimeout);
  33 bool Lookup(const char *pszName, std::vector<CAddress>& vaddr, int nServices, int nMaxSolutions, bool fAllowLookup = false, int portDefault = 0, bool fAllowPort = false);
  34 bool Lookup(const char *pszName, CAddress& addr, int nServices, bool fAllowLookup = false, int portDefault = 0, bool fAllowPort = false);
  35 bool GetMyExternalIP(unsigned int& ipRet);
  36 bool AddAddress(CAddress addr, int64 nTimePenalty=0, CAddrDB *pAddrDB=NULL);
  37 void AddressCurrentlyConnected(const CAddress& addr);
  38 CNode* FindNode(unsigned int ip);
  39 CNode* ConnectNode(CAddress addrConnect, int64 nTimeout=0);
  40 void AbandonRequests(void (*fn)(void*, CDataStream&), void* param1);
  41 bool AnySubscribed(unsigned int nChannel);
  42 void MapPort(bool fMapPort);
  43 bool BindListenPort(std::string& strError=REF(std::string()));
  44 void StartNode(void* parg);
  45 bool StopNode();
  46
  47 enum
  48 {
  49     MSG_TX = 1,
  50     MSG_BLOCK,
  51 };
  52
  53 class CRequestTracker
  54 {
  55 public:
  56     void (*fn)(void*, CDataStream&);
  57     void* param1;
  58
  59     explicit CRequestTracker(void (*fnIn)(void*, CDataStream&)=NULL, void* param1In=NULL)
  60     {
  61         fn = fnIn;
  62         param1 = param1In;
  63     }
  64
  65     bool IsNull()
  66     {
  67         return fn == NULL;
  68     }
  69 };
  70
  71
  72
  73
  74
  75 extern bool fClient;
  76 extern bool fAllowDNS;
  77 extern uint64 nLocalServices;
  78 extern CAddress addrLocalHost;
  79 extern uint64 nLocalHostNonce;
  80 extern boost::array<int, 10> vnThreadsRunning;
  81
  82 extern std::vector<CNode*> vNodes;
  83 extern CCriticalSection cs_vNodes;
  84 extern std::map<std::vector<unsigned char>, CAddress> mapAddresses;
  85 extern CCriticalSection cs_mapAddresses;
  86 extern std::map<CInv, CDataStream> mapRelay;
  87 extern std::deque<std::pair<int64, CInv> > vRelayExpiration;
  88 extern CCriticalSection cs_mapRelay;
  89 extern std::map<CInv, int64> mapAlreadyAskedFor;
  90
  91 // Settings
  92 extern int fUseProxy;
  93 extern CAddress addrProxy;
  94
  95
  96
  97
  98
  99
 100 class CNode
 101 {
 102 public:
 103     // socket
 104     uint64 nServices;
 105     SOCKET hSocket;
 106     CDataStream vSend;
 107     CDataStream vRecv;
 108     CCriticalSection cs_vSend;
 109     CCriticalSection cs_vRecv;
 110     int64 nLastSend;
 111     int64 nLastRecv;
 112     int64 nLastSendEmpty;
 113     int64 nTimeConnected;
 114     unsigned int nHeaderStart;
 115     unsigned int nMessageStart;
 116     CAddress addr;
 117     int nVersion;
 118     std::string strSubVer;
 119     bool fClient;
 120     bool fInbound;
 121     bool fNetworkNode;
 122     bool fSuccessfullyConnected;
 123     bool fDisconnect;
 124 protected:
 125     int nRefCount;
 126
 127     // Denial-of-service detection/prevention
 128     // Key is ip address, value is banned-until-time
 129     static std::map<unsigned int, int64> setBanned;
 130     static CCriticalSection cs_setBanned;
 131     int nMisbehavior;
 132
 133 public:
 134     int64 nReleaseTime;
 135     std::map<uint256, CRequestTracker> mapRequests;
 136     CCriticalSection cs_mapRequests;
 137     uint256 hashContinue;
 138     CBlockIndex* pindexLastGetBlocksBegin;
 139     uint256 hashLastGetBlocksEnd;
 140     int nStartingHeight;
 141
 142     // flood relay
 143     std::vector<CAddress> vAddrToSend;
 144     std::set<CAddress> setAddrKnown;
 145     bool fGetAddr;
 146     std::set<uint256> setKnown;
 147
 148     // inventory based relay
 149     std::set<CInv> setInventoryKnown;
 150     std::vector<CInv> vInventoryToSend;
 151     CCriticalSection cs_inventory;
 152     std::multimap<int64, CInv> mapAskFor;
 153
 154     // publish and subscription
 155     std::vector<char> vfSubscribe;
 156
 157     CNode(SOCKET hSocketIn, CAddress addrIn, bool fInboundIn=false)
 158     {
 159         nServices = 0;
 160         hSocket = hSocketIn;
 161         vSend.SetType(SER_NETWORK);
 162         vSend.SetVersion(0);
 163         vRecv.SetType(SER_NETWORK);
 164         vRecv.SetVersion(0);
 165         // Version 0.2 obsoletes 20 Feb 2012
 166         if (GetTime() > 1329696000)
 167         {
 168             vSend.SetVersion(209);
 169             vRecv.SetVersion(209);
 170         }
 171         nLastSend = 0;
 172         nLastRecv = 0;
 173         nLastSendEmpty = GetTime();
 174         nTimeConnected = GetTime();
 175         nHeaderStart = -1;
 176         nMessageStart = -1;
 177         addr = addrIn;
 178         nVersion = 0;
 179         strSubVer = "";
 180         fClient = false; // set by version message
 181         fInbound = fInboundIn;
 182         fNetworkNode = false;
 183         fSuccessfullyConnected = false;
 184         fDisconnect = false;
 185         nRefCount = 0;
 186         nReleaseTime = 0;
 187         hashContinue = 0;
 188         pindexLastGetBlocksBegin = 0;
 189         hashLastGetBlocksEnd = 0;
 190         nStartingHeight = -1;
 191         fGetAddr = false;
 192         vfSubscribe.assign(256, false);
 193         nMisbehavior = 0;
 194
 195         // Be shy and don't send version until we hear
 196         if (!fInbound)
 197             PushVersion();
 198     }
 199
 200     ~CNode()
 201     {
 202         if (hSocket != INVALID_SOCKET)
 203         {
 204             closesocket(hSocket);
 205             hSocket = INVALID_SOCKET;
 206         }
 207     }
 208
 209 private:
 210     CNode(const CNode&);
 211     void operator=(const CNode&);
 212 public:
 213
 214
 215     int GetRefCount()
 216     {
 217         return std::max(nRefCount, 0) + (GetTime() < nReleaseTime ? 1 : 0);
 218     }
 219
 220     CNode* AddRef(int64 nTimeout=0)
 221     {
 222         if (nTimeout != 0)
 223             nReleaseTime = std::max(nReleaseTime, GetTime() + nTimeout);
 224         else
 225             nRefCount++;
 226         return this;
 227     }
 228
 229     void Release()
 230     {
 231         nRefCount--;
 232     }
 233
 234
 235
 236     void AddAddressKnown(const CAddress& addr)
 237     {
 238         setAddrKnown.insert(addr);
 239     }
 240
 241     void PushAddress(const CAddress& addr)
 242     {
 243         // Known checking here is only to save space from duplicates.
 244         // SendMessages will filter it again for knowns that were added
 245         // after addresses were pushed.
 246         if (addr.IsValid() && !setAddrKnown.count(addr))
 247             vAddrToSend.push_back(addr);
 248     }
 249
 250
 251     void AddInventoryKnown(const CInv& inv)
 252     {
 253         CRITICAL_BLOCK(cs_inventory)
 254             setInventoryKnown.insert(inv);
 255     }
 256
 257     void PushInventory(const CInv& inv)
 258     {
 259         CRITICAL_BLOCK(cs_inventory)
 260             if (!setInventoryKnown.count(inv))
 261                 vInventoryToSend.push_back(inv);
 262     }
 263
 264     void AskFor(const CInv& inv)
 265     {
 266         // We're using mapAskFor as a priority queue,
 267         // the key is the earliest time the request can be sent
 268         int64& nRequestTime = mapAlreadyAskedFor[inv];
 269         printf("askfor %s   %"PRI64d"\n", inv.ToString().c_str(), nRequestTime);
 270
 271         // Make sure not to reuse time indexes to keep things in the same order
 272         int64 nNow = (GetTime() - 1) * 1000000;
 273         static int64 nLastTime;
 274         ++nLastTime;
 275         nNow = std::max(nNow, nLastTime);
 276         nLastTime = nNow;
 277
 278         // Each retry is 2 minutes after the last
 279         nRequestTime = std::max(nRequestTime + 2 * 60 * 1000000, nNow);
 280         mapAskFor.insert(std::make_pair(nRequestTime, inv));
 281     }
 282
 283
 284
 285     void BeginMessage(const char* pszCommand)
 286     {
 287         ENTER_CRITICAL_SECTION(cs_vSend);
 288         if (nHeaderStart != -1)
 289             AbortMessage();
 290         nHeaderStart = vSend.size();
 291         vSend << CMessageHeader(pszCommand, 0);
 292         nMessageStart = vSend.size();
 293         if (fDebug) {
 294             printf("%s ", DateTimeStrFormat("%x %H:%M:%S", GetTime()).c_str());
 295             printf("sending: %s ", pszCommand);
 296         }
 297     }
 298
 299     void AbortMessage()
 300     {
 301         if (nHeaderStart == -1)
 302             return;
 303         vSend.resize(nHeaderStart);
 304         nHeaderStart = -1;
 305         nMessageStart = -1;
 306         LEAVE_CRITICAL_SECTION(cs_vSend);
 307
 308         if (fDebug)
 309             printf("(aborted)\n");
 310     }
 311
 312     void EndMessage()
 313     {
 314         if (mapArgs.count("-dropmessagestest") && GetRand(atoi(mapArgs["-dropmessagestest"])) == 0)
 315         {
 316             printf("dropmessages DROPPING SEND MESSAGE\n");
 317             AbortMessage();
 318             return;
 319         }
 320
 321         if (nHeaderStart == -1)
 322             return;
 323
 324         // Set the size
 325         unsigned int nSize = vSend.size() - nMessageStart;
 326         memcpy((char*)&vSend[nHeaderStart] + offsetof(CMessageHeader, nMessageSize), &nSize, sizeof(nSize));
 327
 328         // Set the checksum
 329         if (vSend.GetVersion() >= 209)
 330         {
 331             uint256 hash = Hash(vSend.begin() + nMessageStart, vSend.end());
 332             unsigned int nChecksum = 0;
 333             memcpy(&nChecksum, &hash, sizeof(nChecksum));
 334             assert(nMessageStart - nHeaderStart >= offsetof(CMessageHeader, nChecksum) + sizeof(nChecksum));
 335             memcpy((char*)&vSend[nHeaderStart] + offsetof(CMessageHeader, nChecksum), &nChecksum, sizeof(nChecksum));
 336         }
 337
 338         if (fDebug) {
 339             printf("(%d bytes)\n", nSize);
 340         }
 341
 342         nHeaderStart = -1;
 343         nMessageStart = -1;
 344         LEAVE_CRITICAL_SECTION(cs_vSend);
 345     }
 346
 347     void EndMessageAbortIfEmpty()
 348     {
 349         if (nHeaderStart == -1)
 350             return;
 351         int nSize = vSend.size() - nMessageStart;
 352         if (nSize > 0)
 353             EndMessage();
 354         else
 355             AbortMessage();
 356     }
 357
 358
 359
 360     void PushVersion()
 361     {
 362         /// when NTP implemented, change to just nTime = GetAdjustedTime()
 363         int64 nTime = (fInbound ? GetAdjustedTime() : GetTime());
 364         CAddress addrYou = (fUseProxy ? CAddress("0.0.0.0") : addr);
 365         CAddress addrMe = (fUseProxy || !addrLocalHost.IsRoutable() ? CAddress("0.0.0.0") : addrLocalHost);
 366         RAND_bytes((unsigned char*)&nLocalHostNonce, sizeof(nLocalHostNonce));
 367         PushMessage("version", VERSION, nLocalServices, nTime, addrYou, addrMe,
 368                     nLocalHostNonce, std::string(pszSubVer), nBestHeight);
 369     }
 370
 371
 372
 373
 374     void PushMessage(const char* pszCommand)
 375     {
 376         try
 377         {
 378             BeginMessage(pszCommand);
 379             EndMessage();
 380         }
 381         catch (...)
 382         {
 383             AbortMessage();
 384             throw;
 385         }
 386     }
 387
 388     template<typename T1>
 389     void PushMessage(const char* pszCommand, const T1& a1)
 390     {
 391         try
 392         {
 393             BeginMessage(pszCommand);
 394             vSend << a1;
 395             EndMessage();
 396         }
 397         catch (...)
 398         {
 399             AbortMessage();
 400             throw;
 401         }
 402     }
 403
 404     template<typename T1, typename T2>
 405     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2)
 406     {
 407         try
 408         {
 409             BeginMessage(pszCommand);
 410             vSend << a1 << a2;
 411             EndMessage();
 412         }
 413         catch (...)
 414         {
 415             AbortMessage();
 416             throw;
 417         }
 418     }
 419
 420     template<typename T1, typename T2, typename T3>
 421     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3)
 422     {
 423         try
 424         {
 425             BeginMessage(pszCommand);
 426             vSend << a1 << a2 << a3;
 427             EndMessage();
 428         }
 429         catch (...)
 430         {
 431             AbortMessage();
 432             throw;
 433         }
 434     }
 435
 436     template<typename T1, typename T2, typename T3, typename T4>
 437     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4)
 438     {
 439         try
 440         {
 441             BeginMessage(pszCommand);
 442             vSend << a1 << a2 << a3 << a4;
 443             EndMessage();
 444         }
 445         catch (...)
 446         {
 447             AbortMessage();
 448             throw;
 449         }
 450     }
 451
 452     template<typename T1, typename T2, typename T3, typename T4, typename T5>
 453     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5)
 454     {
 455         try
 456         {
 457             BeginMessage(pszCommand);
 458             vSend << a1 << a2 << a3 << a4 << a5;
 459             EndMessage();
 460         }
 461         catch (...)
 462         {
 463             AbortMessage();
 464             throw;
 465         }
 466     }
 467
 468     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
 469     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5, const T6& a6)
 470     {
 471         try
 472         {
 473             BeginMessage(pszCommand);
 474             vSend << a1 << a2 << a3 << a4 << a5 << a6;
 475             EndMessage();
 476         }
 477         catch (...)
 478         {
 479             AbortMessage();
 480             throw;
 481         }
 482     }
 483
 484     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7>
 485     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5, const T6& a6, const T7& a7)
 486     {
 487         try
 488         {
 489             BeginMessage(pszCommand);
 490             vSend << a1 << a2 << a3 << a4 << a5 << a6 << a7;
 491             EndMessage();
 492         }
 493         catch (...)
 494         {
 495             AbortMessage();
 496             throw;
 497         }
 498     }
 499
 500     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8>
 501     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5, const T6& a6, const T7& a7, const T8& a8)
 502     {
 503         try
 504         {
 505             BeginMessage(pszCommand);
 506             vSend << a1 << a2 << a3 << a4 << a5 << a6 << a7 << a8;
 507             EndMessage();
 508         }
 509         catch (...)
 510         {
 511             AbortMessage();
 512             throw;
 513         }
 514     }
 515
 516     template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8, typename T9>
 517     void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5, const T6& a6, const T7& a7, const T8& a8, const T9& a9)
 518     {
 519         try
 520         {
 521             BeginMessage(pszCommand);
 522             vSend << a1 << a2 << a3 << a4 << a5 << a6 << a7 << a8 << a9;
 523             EndMessage();
 524         }
 525         catch (...)
 526         {
 527             AbortMessage();
 528             throw;
 529         }
 530     }
 531
 532
 533     void PushRequest(const char* pszCommand,
 534                      void (*fn)(void*, CDataStream&), void* param1)
 535     {
 536         uint256 hashReply;
 537         RAND_bytes((unsigned char*)&hashReply, sizeof(hashReply));
 538
 539         CRITICAL_BLOCK(cs_mapRequests)
 540             mapRequests[hashReply] = CRequestTracker(fn, param1);
 541
 542         PushMessage(pszCommand, hashReply);
 543     }
 544
 545     template<typename T1>
 546     void PushRequest(const char* pszCommand, const T1& a1,
 547                      void (*fn)(void*, CDataStream&), void* param1)
 548     {
 549         uint256 hashReply;
 550         RAND_bytes((unsigned char*)&hashReply, sizeof(hashReply));
 551
 552         CRITICAL_BLOCK(cs_mapRequests)
 553             mapRequests[hashReply] = CRequestTracker(fn, param1);
 554
 555         PushMessage(pszCommand, hashReply, a1);
 556     }
 557
 558     template<typename T1, typename T2>
 559     void PushRequest(const char* pszCommand, const T1& a1, const T2& a2,
 560                      void (*fn)(void*, CDataStream&), void* param1)
 561     {
 562         uint256 hashReply;
 563         RAND_bytes((unsigned char*)&hashReply, sizeof(hashReply));
 564
 565         CRITICAL_BLOCK(cs_mapRequests)
 566             mapRequests[hashReply] = CRequestTracker(fn, param1);
 567
 568         PushMessage(pszCommand, hashReply, a1, a2);
 569     }
 570
 571
 572
 573     void PushGetBlocks(CBlockIndex* pindexBegin, uint256 hashEnd);
 574     bool IsSubscribed(unsigned int nChannel);
 575     void Subscribe(unsigned int nChannel, unsigned int nHops=0);
 576     void CancelSubscribe(unsigned int nChannel);
 577     void CloseSocketDisconnect();
 578     void Cleanup();
 579
 580
 581     // Denial-of-service detection/prevention
 582     // The idea is to detect peers that are behaving
 583     // badly and disconnect/ban them, but do it in a
 584     // one-coding-mistake-won't-shatter-the-entire-network
 585     // way.
 586     // IMPORTANT:  There should be nothing I can give a
 587     // node that it will forward on that will make that
 588     // node's peers drop it. If there is, an attacker
 589     // can isolate a node and/or try to split the network.
 590     // Dropping a node for sending stuff that is invalid
 591     // now but might be valid in a later version is also
 592     // dangerous, because it can cause a network split
 593     // between nodes running old code and nodes running
 594     // new code.
 595     static void ClearBanned(); // needed for unit testing
 596     static bool IsBanned(unsigned int ip);
 597     bool Misbehaving(int howmuch); // 1 == a little, 100 == a lot
 598 };
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609 inline void RelayInventory(const CInv& inv)
 610 {
 611     // Put on lists to offer to the other nodes
 612     CRITICAL_BLOCK(cs_vNodes)
 613         BOOST_FOREACH(CNode* pnode, vNodes)
 614             pnode->PushInventory(inv);
 615 }
 616
 617 template<typename T>
 618 void RelayMessage(const CInv& inv, const T& a)
 619 {
 620     CDataStream ss(SER_NETWORK);
 621     ss.reserve(10000);
 622     ss << a;
 623     RelayMessage(inv, ss);
 624 }
 625
 626 template<>
 627 inline void RelayMessage<>(const CInv& inv, const CDataStream& ss)
 628 {
 629     CRITICAL_BLOCK(cs_mapRelay)
 630     {
 631         // Expire old relay messages
 632         while (!vRelayExpiration.empty() && vRelayExpiration.front().first < GetTime())
 633         {
 634             mapRelay.erase(vRelayExpiration.front().second);
 635             vRelayExpiration.pop_front();
 636         }
 637
 638         // Save original serialized message so newer versions are preserved
 639         mapRelay[inv] = ss;
 640         vRelayExpiration.push_back(std::make_pair(GetTime() + 15 * 60, inv));
 641     }
 642
 643     RelayInventory(inv);
 644 }
 645
 646
 647
 648
 649
 650
 651
 652
 653 //
 654 // Templates for the publish and subscription system.
 655 // The object being published as T& obj needs to have:
 656 //   a set<unsigned int> setSources member
 657 //   specializations of AdvertInsert and AdvertErase
 658 // Currently implemented for CTable and CProduct.
 659 //
 660
 661 template<typename T>
 662 void AdvertStartPublish(CNode* pfrom, unsigned int nChannel, unsigned int nHops, T& obj)
 663 {
 664     // Add to sources
 665     obj.setSources.insert(pfrom->addr.ip);
 666
 667     if (!AdvertInsert(obj))
 668         return;
 669
 670     // Relay
 671     CRITICAL_BLOCK(cs_vNodes)
 672         BOOST_FOREACH(CNode* pnode, vNodes)
 673             if (pnode != pfrom && (nHops < PUBLISH_HOPS || pnode->IsSubscribed(nChannel)))
 674                 pnode->PushMessage("publish", nChannel, nHops, obj);
 675 }
 676
 677 template<typename T>
 678 void AdvertStopPublish(CNode* pfrom, unsigned int nChannel, unsigned int nHops, T& obj)
 679 {
 680     uint256 hash = obj.GetHash();
 681
 682     CRITICAL_BLOCK(cs_vNodes)
 683         BOOST_FOREACH(CNode* pnode, vNodes)
 684             if (pnode != pfrom && (nHops < PUBLISH_HOPS || pnode->IsSubscribed(nChannel)))
 685                 pnode->PushMessage("pub-cancel", nChannel, nHops, hash);
 686
 687     AdvertErase(obj);
 688 }
 689
 690 template<typename T>
 691 void AdvertRemoveSource(CNode* pfrom, unsigned int nChannel, unsigned int nHops, T& obj)
 692 {
 693     // Remove a source
 694     obj.setSources.erase(pfrom->addr.ip);
 695
 696     // If no longer supported by any sources, cancel it
 697     if (obj.setSources.empty())
 698         AdvertStopPublish(pfrom, nChannel, nHops, obj);
 699 }
 700
 701 #endif