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