1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2014 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
12 #include "limitedmap.h"
25 #include <arpa/inet.h>
28 #include <boost/foreach.hpp>
29 #include <boost/signals2/signal.hpp>
39 /** Time between pings automatically sent out for latency probing and keepalive (in seconds). */
40 static const int PING_INTERVAL = 2 * 60;
41 /** Time after which to disconnect, after waiting for a ping response (or inactivity). */
42 static const int TIMEOUT_INTERVAL = 20 * 60;
43 /** The maximum number of entries in an 'inv' protocol message */
44 static const unsigned int MAX_INV_SZ = 50000;
45 /** -listen default */
46 static const bool DEFAULT_LISTEN = true;
49 static const bool DEFAULT_UPNP = USE_UPNP;
51 static const bool DEFAULT_UPNP = false;
54 inline unsigned int ReceiveFloodSize() { return 1000*GetArg("-maxreceivebuffer", 5*1000); }
55 inline unsigned int SendBufferSize() { return 1000*GetArg("-maxsendbuffer", 1*1000); }
57 void AddOneShot(std::string strDest);
58 bool RecvLine(SOCKET hSocket, std::string& strLine);
59 bool GetMyExternalIP(CNetAddr& ipRet);
60 void AddressCurrentlyConnected(const CService& addr);
61 CNode* FindNode(const CNetAddr& ip);
62 CNode* FindNode(const CService& ip);
63 CNode* ConnectNode(CAddress addrConnect, const char *pszDest = NULL);
64 bool OpenNetworkConnection(const CAddress& addrConnect, CSemaphoreGrant *grantOutbound = NULL, const char *strDest = NULL, bool fOneShot = false);
65 void MapPort(bool fUseUPnP);
66 unsigned short GetListenPort();
67 bool BindListenPort(const CService &bindAddr, std::string& strError, bool fWhitelisted = false);
68 void StartNode(boost::thread_group& threadGroup);
70 void SocketSendData(CNode *pnode);
74 // Signals for message handling
77 boost::signals2::signal<int ()> GetHeight;
78 boost::signals2::signal<bool (CNode*)> ProcessMessages;
79 boost::signals2::signal<bool (CNode*, bool)> SendMessages;
80 boost::signals2::signal<void (NodeId, const CNode*)> InitializeNode;
81 boost::signals2::signal<void (NodeId)> FinalizeNode;
85 CNodeSignals& GetNodeSignals();
90 LOCAL_NONE, // unknown
91 LOCAL_IF, // address a local interface listens on
92 LOCAL_BIND, // address explicit bound to
93 LOCAL_UPNP, // address reported by UPnP
94 LOCAL_HTTP, // address reported by whatismyip.com and similar
95 LOCAL_MANUAL, // address explicitly specified (-externalip=)
100 void SetLimited(enum Network net, bool fLimited = true);
101 bool IsLimited(enum Network net);
102 bool IsLimited(const CNetAddr& addr);
103 bool AddLocal(const CService& addr, int nScore = LOCAL_NONE);
104 bool AddLocal(const CNetAddr& addr, int nScore = LOCAL_NONE);
105 bool SeenLocal(const CService& addr);
106 bool IsLocal(const CService& addr);
107 bool GetLocal(CService &addr, const CNetAddr *paddrPeer = NULL);
108 bool IsReachable(const CNetAddr &addr);
109 void SetReachable(enum Network net, bool fFlag = true);
110 CAddress GetLocalAddress(const CNetAddr *paddrPeer = NULL);
113 extern bool fDiscover;
115 extern uint64_t nLocalServices;
116 extern uint64_t nLocalHostNonce;
117 extern CAddrMan addrman;
118 extern int nMaxConnections;
120 extern std::vector<CNode*> vNodes;
121 extern CCriticalSection cs_vNodes;
122 extern std::map<CInv, CDataStream> mapRelay;
123 extern std::deque<std::pair<int64_t, CInv> > vRelayExpiration;
124 extern CCriticalSection cs_mapRelay;
125 extern limitedmap<CInv, int64_t> mapAlreadyAskedFor;
127 extern std::vector<std::string> vAddedNodes;
128 extern CCriticalSection cs_vAddedNodes;
130 extern NodeId nLastNodeId;
131 extern CCriticalSection cs_nLastNodeId;
133 struct LocalServiceInfo {
138 extern CCriticalSection cs_mapLocalHost;
139 extern std::map<CNetAddr, LocalServiceInfo> mapLocalHost;
148 int64_t nTimeConnected;
149 std::string addrName;
151 std::string cleanSubVer;
160 std::string addrLocal;
168 bool in_data; // parsing header (false) or data (true)
170 CDataStream hdrbuf; // partially received header
171 CMessageHeader hdr; // complete header
172 unsigned int nHdrPos;
174 CDataStream vRecv; // received message data
175 unsigned int nDataPos;
177 int64_t nTime; // time (in microseconds) of message receipt.
179 CNetMessage(int nTypeIn, int nVersionIn) : hdrbuf(nTypeIn, nVersionIn), vRecv(nTypeIn, nVersionIn) {
187 bool complete() const
191 return (hdr.nMessageSize == nDataPos);
194 void SetVersion(int nVersionIn)
196 hdrbuf.SetVersion(nVersionIn);
197 vRecv.SetVersion(nVersionIn);
200 int readHeader(const char *pch, unsigned int nBytes);
201 int readData(const char *pch, unsigned int nBytes);
208 /** Information about a peer */
216 size_t nSendSize; // total size of all vSendMsg entries
217 size_t nSendOffset; // offset inside the first vSendMsg already sent
219 std::deque<CSerializeData> vSendMsg;
220 CCriticalSection cs_vSend;
222 std::deque<CInv> vRecvGetData;
223 std::deque<CNetMessage> vRecvMsg;
224 CCriticalSection cs_vRecvMsg;
230 int64_t nTimeConnected;
232 std::string addrName;
235 // strSubVer is whatever byte array we read from the wire. However, this field is intended
236 // to be printed out, displayed to humans in various forms and so on. So we sanitize it and
237 // store the sanitized version in cleanSubVer. The original should be used when dealing with
238 // the network or wire types and the cleaned string used when displayed or logged.
239 std::string strSubVer, cleanSubVer;
240 bool fWhitelisted; // This peer can bypass DoS banning.
245 bool fSuccessfullyConnected;
247 // We use fRelayTxes for two purposes -
248 // a) it allows us to not relay tx invs before receiving the peer's version message
249 // b) the peer may tell us in their version message that we should not relay tx invs
250 // until they have initialized their bloom filter.
252 CSemaphoreGrant grantOutbound;
253 CCriticalSection cs_filter;
254 CBloomFilter* pfilter;
259 // Denial-of-service detection/prevention
260 // Key is IP address, value is banned-until-time
261 static std::map<CNetAddr, int64_t> setBanned;
262 static CCriticalSection cs_setBanned;
264 // Whitelisted ranges. Any node connecting from these is automatically
265 // whitelisted (as well as those connecting to whitelisted binds).
266 static std::vector<CSubNet> vWhitelistedRange;
267 static CCriticalSection cs_vWhitelistedRange;
269 // Basic fuzz-testing
270 void Fuzz(int nChance); // modifies ssSend
273 uint256 hashContinue;
274 CBlockIndex* pindexLastGetBlocksBegin;
275 uint256 hashLastGetBlocksEnd;
280 std::vector<CAddress> vAddrToSend;
281 mruset<CAddress> setAddrKnown;
283 std::set<uint256> setKnown;
285 // inventory based relay
286 mruset<CInv> setInventoryKnown;
287 std::vector<CInv> vInventoryToSend;
288 CCriticalSection cs_inventory;
289 std::multimap<int64_t, CInv> mapAskFor;
291 // Ping time measurement:
292 // The pong reply we're expecting, or 0 if no pong expected.
293 uint64_t nPingNonceSent;
294 // Time (in usec) the last ping was sent, or 0 if no ping was ever sent.
295 int64_t nPingUsecStart;
296 // Last measured round-trip time.
297 int64_t nPingUsecTime;
298 // Whether a ping is requested.
301 CNode(SOCKET hSocketIn, CAddress addrIn, std::string addrNameIn = "", bool fInboundIn=false) : ssSend(SER_NETWORK, INIT_PROTO_VERSION), setAddrKnown(5000)
305 nRecvVersion = INIT_PROTO_VERSION;
310 nTimeConnected = GetTime();
312 addrName = addrNameIn == "" ? addr.ToStringIPPort() : addrNameIn;
315 fWhitelisted = false;
317 fClient = false; // set by version message
318 fInbound = fInboundIn;
319 fNetworkNode = false;
320 fSuccessfullyConnected = false;
326 pindexLastGetBlocksBegin = 0;
327 hashLastGetBlocksEnd = 0;
328 nStartingHeight = -1;
332 setInventoryKnown.max_size(SendBufferSize() / 1000);
333 pfilter = new CBloomFilter();
340 LOCK(cs_nLastNodeId);
345 LogPrint("net", "Added connection to %s peer=%d\n", addrName, id);
347 LogPrint("net", "Added connection peer=%d\n", id);
349 // Be shy and don't send version until we hear
350 if (hSocket != INVALID_SOCKET && !fInbound)
353 GetNodeSignals().InitializeNode(GetId(), this);
358 if (hSocket != INVALID_SOCKET)
360 CloseSocket(hSocket);
364 GetNodeSignals().FinalizeNode(GetId());
368 // Network usage totals
369 static CCriticalSection cs_totalBytesRecv;
370 static CCriticalSection cs_totalBytesSent;
371 static uint64_t nTotalBytesRecv;
372 static uint64_t nTotalBytesSent;
375 void operator=(const CNode&);
379 NodeId GetId() const {
385 assert(nRefCount >= 0);
389 // requires LOCK(cs_vRecvMsg)
390 unsigned int GetTotalRecvSize()
392 unsigned int total = 0;
393 BOOST_FOREACH(const CNetMessage &msg, vRecvMsg)
394 total += msg.vRecv.size() + 24;
398 // requires LOCK(cs_vRecvMsg)
399 bool ReceiveMsgBytes(const char *pch, unsigned int nBytes);
401 // requires LOCK(cs_vRecvMsg)
402 void SetRecvVersion(int nVersionIn)
404 nRecvVersion = nVersionIn;
405 BOOST_FOREACH(CNetMessage &msg, vRecvMsg)
406 msg.SetVersion(nVersionIn);
422 void AddAddressKnown(const CAddress& addr)
424 setAddrKnown.insert(addr);
427 void PushAddress(const CAddress& addr)
429 // Known checking here is only to save space from duplicates.
430 // SendMessages will filter it again for knowns that were added
431 // after addresses were pushed.
432 if (addr.IsValid() && !setAddrKnown.count(addr))
433 vAddrToSend.push_back(addr);
437 void AddInventoryKnown(const CInv& inv)
441 setInventoryKnown.insert(inv);
445 void PushInventory(const CInv& inv)
449 if (!setInventoryKnown.count(inv))
450 vInventoryToSend.push_back(inv);
454 void AskFor(const CInv& inv)
456 // We're using mapAskFor as a priority queue,
457 // the key is the earliest time the request can be sent
458 int64_t nRequestTime;
459 limitedmap<CInv, int64_t>::const_iterator it = mapAlreadyAskedFor.find(inv);
460 if (it != mapAlreadyAskedFor.end())
461 nRequestTime = it->second;
464 LogPrint("net", "askfor %s %d (%s) peer=%d\n", inv.ToString(), nRequestTime, DateTimeStrFormat("%H:%M:%S", nRequestTime/1000000).c_str(), id);
466 // Make sure not to reuse time indexes to keep things in the same order
467 int64_t nNow = GetTimeMicros() - 1000000;
468 static int64_t nLastTime;
470 nNow = std::max(nNow, nLastTime);
473 // Each retry is 2 minutes after the last
474 nRequestTime = std::max(nRequestTime + 2 * 60 * 1000000, nNow);
475 if (it != mapAlreadyAskedFor.end())
476 mapAlreadyAskedFor.update(it, nRequestTime);
478 mapAlreadyAskedFor.insert(std::make_pair(inv, nRequestTime));
479 mapAskFor.insert(std::make_pair(nRequestTime, inv));
484 // TODO: Document the postcondition of this function. Is cs_vSend locked?
485 void BeginMessage(const char* pszCommand) EXCLUSIVE_LOCK_FUNCTION(cs_vSend)
487 ENTER_CRITICAL_SECTION(cs_vSend);
488 assert(ssSend.size() == 0);
489 ssSend << CMessageHeader(pszCommand, 0);
490 LogPrint("net", "sending: %s ", pszCommand);
493 // TODO: Document the precondition of this function. Is cs_vSend locked?
494 void AbortMessage() UNLOCK_FUNCTION(cs_vSend)
498 LEAVE_CRITICAL_SECTION(cs_vSend);
500 LogPrint("net", "(aborted)\n");
503 // TODO: Document the precondition of this function. Is cs_vSend locked?
504 void EndMessage() UNLOCK_FUNCTION(cs_vSend)
506 // The -*messagestest options are intentionally not documented in the help message,
507 // since they are only used during development to debug the networking code and are
508 // not intended for end-users.
509 if (mapArgs.count("-dropmessagestest") && GetRand(GetArg("-dropmessagestest", 2)) == 0)
511 LogPrint("net", "dropmessages DROPPING SEND MESSAGE\n");
515 if (mapArgs.count("-fuzzmessagestest"))
516 Fuzz(GetArg("-fuzzmessagestest", 10));
518 if (ssSend.size() == 0)
522 unsigned int nSize = ssSend.size() - CMessageHeader::HEADER_SIZE;
523 memcpy((char*)&ssSend[CMessageHeader::MESSAGE_SIZE_OFFSET], &nSize, sizeof(nSize));
526 uint256 hash = Hash(ssSend.begin() + CMessageHeader::HEADER_SIZE, ssSend.end());
527 unsigned int nChecksum = 0;
528 memcpy(&nChecksum, &hash, sizeof(nChecksum));
529 assert(ssSend.size () >= CMessageHeader::CHECKSUM_OFFSET + sizeof(nChecksum));
530 memcpy((char*)&ssSend[CMessageHeader::CHECKSUM_OFFSET], &nChecksum, sizeof(nChecksum));
532 LogPrint("net", "(%d bytes) peer=%d\n", nSize, id);
534 std::deque<CSerializeData>::iterator it = vSendMsg.insert(vSendMsg.end(), CSerializeData());
535 ssSend.GetAndClear(*it);
536 nSendSize += (*it).size();
538 // If write queue empty, attempt "optimistic write"
539 if (it == vSendMsg.begin())
540 SocketSendData(this);
542 LEAVE_CRITICAL_SECTION(cs_vSend);
548 void PushMessage(const char* pszCommand)
552 BeginMessage(pszCommand);
562 template<typename T1>
563 void PushMessage(const char* pszCommand, const T1& a1)
567 BeginMessage(pszCommand);
578 template<typename T1, typename T2>
579 void PushMessage(const char* pszCommand, const T1& a1, const T2& a2)
583 BeginMessage(pszCommand);
594 template<typename T1, typename T2, typename T3>
595 void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3)
599 BeginMessage(pszCommand);
600 ssSend << a1 << a2 << a3;
610 template<typename T1, typename T2, typename T3, typename T4>
611 void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4)
615 BeginMessage(pszCommand);
616 ssSend << a1 << a2 << a3 << a4;
626 template<typename T1, typename T2, typename T3, typename T4, typename T5>
627 void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5)
631 BeginMessage(pszCommand);
632 ssSend << a1 << a2 << a3 << a4 << a5;
642 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
643 void PushMessage(const char* pszCommand, const T1& a1, const T2& a2, const T3& a3, const T4& a4, const T5& a5, const T6& a6)
647 BeginMessage(pszCommand);
648 ssSend << a1 << a2 << a3 << a4 << a5 << a6;
658 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7>
659 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)
663 BeginMessage(pszCommand);
664 ssSend << a1 << a2 << a3 << a4 << a5 << a6 << a7;
674 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8>
675 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)
679 BeginMessage(pszCommand);
680 ssSend << a1 << a2 << a3 << a4 << a5 << a6 << a7 << a8;
690 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8, typename T9>
691 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)
695 BeginMessage(pszCommand);
696 ssSend << a1 << a2 << a3 << a4 << a5 << a6 << a7 << a8 << a9;
706 bool IsSubscribed(unsigned int nChannel);
707 void Subscribe(unsigned int nChannel, unsigned int nHops=0);
708 void CancelSubscribe(unsigned int nChannel);
709 void CloseSocketDisconnect();
711 // Denial-of-service detection/prevention
712 // The idea is to detect peers that are behaving
713 // badly and disconnect/ban them, but do it in a
714 // one-coding-mistake-won't-shatter-the-entire-network
716 // IMPORTANT: There should be nothing I can give a
717 // node that it will forward on that will make that
718 // node's peers drop it. If there is, an attacker
719 // can isolate a node and/or try to split the network.
720 // Dropping a node for sending stuff that is invalid
721 // now but might be valid in a later version is also
722 // dangerous, because it can cause a network split
723 // between nodes running old code and nodes running
725 static void ClearBanned(); // needed for unit testing
726 static bool IsBanned(CNetAddr ip);
727 static bool Ban(const CNetAddr &ip);
728 void copyStats(CNodeStats &stats);
730 static bool IsWhitelistedRange(const CNetAddr &ip);
731 static void AddWhitelistedRange(const CSubNet &subnet);
734 static void RecordBytesRecv(uint64_t bytes);
735 static void RecordBytesSent(uint64_t bytes);
737 static uint64_t GetTotalBytesRecv();
738 static uint64_t GetTotalBytesSent();
744 void RelayTransaction(const CTransaction& tx);
745 void RelayTransaction(const CTransaction& tx, const CDataStream& ss);
747 /** Access to the (IP) address database (peers.dat) */
751 boost::filesystem::path pathAddr;
754 bool Write(const CAddrMan& addr);
755 bool Read(CAddrMan& addr);