Peer.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908
  1. /*
  2. * ZeroTier One - Network Virtualization Everywhere
  3. * Copyright (C) 2011-2019 ZeroTier, Inc. https://www.zerotier.com/
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation, either version 3 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. *
  18. * --
  19. *
  20. * You can be released from the requirements of the license by purchasing
  21. * a commercial license. Buying such a license is mandatory as soon as you
  22. * develop commercial closed-source software that incorporates or links
  23. * directly against ZeroTier software without disclosing the source code
  24. * of your own application.
  25. */
  26. #include "../version.h"
  27. #include "Constants.hpp"
  28. #include "Peer.hpp"
  29. #include "Node.hpp"
  30. #include "Switch.hpp"
  31. #include "Network.hpp"
  32. #include "SelfAwareness.hpp"
  33. #include "Packet.hpp"
  34. #include "Trace.hpp"
  35. #include "InetAddress.hpp"
  36. #include "RingBuffer.hpp"
  37. #include "Utils.hpp"
  38. namespace ZeroTier {
  39. Peer::Peer(const RuntimeEnvironment *renv,const Identity &myIdentity,const Identity &peerIdentity) :
  40. RR(renv),
  41. _lastReceive(0),
  42. _lastNontrivialReceive(0),
  43. _lastTriedMemorizedPath(0),
  44. _lastDirectPathPushSent(0),
  45. _lastDirectPathPushReceive(0),
  46. _lastCredentialRequestSent(0),
  47. _lastWhoisRequestReceived(0),
  48. _lastEchoRequestReceived(0),
  49. _lastCredentialsReceived(0),
  50. _lastTrustEstablishedPacketReceived(0),
  51. _lastSentFullHello(0),
  52. _lastACKWindowReset(0),
  53. _lastQoSWindowReset(0),
  54. _lastMultipathCompatibilityCheck(0),
  55. _freeRandomByte(0),
  56. _uniqueAlivePathCount(0),
  57. _localMultipathSupported(false),
  58. _remoteMultipathSupported(false),
  59. _canUseMultipath(false),
  60. _vProto(0),
  61. _vMajor(0),
  62. _vMinor(0),
  63. _vRevision(0),
  64. _id(peerIdentity),
  65. _directPathPushCutoffCount(0),
  66. _credentialsCutoffCount(0),
  67. _linkIsBalanced(false),
  68. _linkIsRedundant(false),
  69. _remotePeerMultipathEnabled(false),
  70. _lastAggregateStatsReport(0),
  71. _lastAggregateAllocation(0)
  72. {
  73. Utils::getSecureRandom(&_freeRandomByte, 1);
  74. if (!myIdentity.agree(peerIdentity,_key,ZT_PEER_SECRET_KEY_LENGTH))
  75. throw ZT_EXCEPTION_INVALID_ARGUMENT;
  76. }
  77. void Peer::received(
  78. void *tPtr,
  79. const SharedPtr<Path> &path,
  80. const unsigned int hops,
  81. const uint64_t packetId,
  82. const unsigned int payloadLength,
  83. const Packet::Verb verb,
  84. const uint64_t inRePacketId,
  85. const Packet::Verb inReVerb,
  86. const bool trustEstablished,
  87. const uint64_t networkId)
  88. {
  89. const int64_t now = RR->node->now();
  90. _lastReceive = now;
  91. switch (verb) {
  92. case Packet::VERB_FRAME:
  93. case Packet::VERB_EXT_FRAME:
  94. case Packet::VERB_NETWORK_CONFIG_REQUEST:
  95. case Packet::VERB_NETWORK_CONFIG:
  96. case Packet::VERB_MULTICAST_FRAME:
  97. _lastNontrivialReceive = now;
  98. break;
  99. default: break;
  100. }
  101. if (trustEstablished) {
  102. _lastTrustEstablishedPacketReceived = now;
  103. path->trustedPacketReceived(now);
  104. }
  105. {
  106. Mutex::Lock _l(_paths_m);
  107. recordIncomingPacket(tPtr, path, packetId, payloadLength, verb, now);
  108. if (_canUseMultipath) {
  109. if (path->needsToSendQoS(now)) {
  110. sendQOS_MEASUREMENT(tPtr, path, path->localSocket(), path->address(), now);
  111. }
  112. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  113. if (_paths[i].p) {
  114. _paths[i].p->processBackgroundPathMeasurements(now);
  115. }
  116. }
  117. }
  118. }
  119. if (hops == 0) {
  120. // If this is a direct packet (no hops), update existing paths or learn new ones
  121. bool havePath = false;
  122. {
  123. Mutex::Lock _l(_paths_m);
  124. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  125. if (_paths[i].p) {
  126. if (_paths[i].p == path) {
  127. _paths[i].lr = now;
  128. havePath = true;
  129. break;
  130. }
  131. } else break;
  132. }
  133. }
  134. bool attemptToContact = false;
  135. if ((!havePath)&&(RR->node->shouldUsePathForZeroTierTraffic(tPtr,_id.address(),path->localSocket(),path->address()))) {
  136. Mutex::Lock _l(_paths_m);
  137. // Paths are redundant if they duplicate an alive path to the same IP or
  138. // with the same local socket and address family.
  139. bool redundant = false;
  140. unsigned int replacePath = ZT_MAX_PEER_NETWORK_PATHS;
  141. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  142. if (_paths[i].p) {
  143. if ( (_paths[i].p->alive(now)) && ( ((_paths[i].p->localSocket() == path->localSocket())&&(_paths[i].p->address().ss_family == path->address().ss_family)) || (_paths[i].p->address().ipsEqual2(path->address())) ) ) {
  144. redundant = true;
  145. break;
  146. }
  147. // If the path is the same address and port, simply assume this is a replacement
  148. if ( (_paths[i].p->address().ipsEqual2(path->address()) && (_paths[i].p->address().port() == path->address().port()))) {
  149. replacePath = i;
  150. break;
  151. }
  152. } else break;
  153. }
  154. // If the path isn't a duplicate of the same localSocket AND we haven't already determined a replacePath,
  155. // then find the worst path and replace it.
  156. if (!redundant && replacePath == ZT_MAX_PEER_NETWORK_PATHS) {
  157. int replacePathQuality = 0;
  158. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  159. if (_paths[i].p) {
  160. const int q = _paths[i].p->quality(now);
  161. if (q > replacePathQuality) {
  162. replacePathQuality = q;
  163. replacePath = i;
  164. }
  165. } else {
  166. replacePath = i;
  167. break;
  168. }
  169. }
  170. }
  171. if (replacePath != ZT_MAX_PEER_NETWORK_PATHS) {
  172. if (verb == Packet::VERB_OK) {
  173. RR->t->peerLearnedNewPath(tPtr,networkId,*this,path,packetId);
  174. _paths[replacePath].lr = now;
  175. _paths[replacePath].p = path;
  176. _paths[replacePath].priority = 1;
  177. } else {
  178. attemptToContact = true;
  179. }
  180. }
  181. }
  182. if (attemptToContact) {
  183. attemptToContactAt(tPtr,path->localSocket(),path->address(),now,true);
  184. path->sent(now);
  185. RR->t->peerConfirmingUnknownPath(tPtr,networkId,*this,path,packetId,verb);
  186. }
  187. }
  188. // If we have a trust relationship periodically push a message enumerating
  189. // all known external addresses for ourselves. We now do this even if we
  190. // have a current path since we'll want to use new ones too.
  191. if (this->trustEstablished(now)) {
  192. if ((now - _lastDirectPathPushSent) >= ZT_DIRECT_PATH_PUSH_INTERVAL) {
  193. _lastDirectPathPushSent = now;
  194. std::vector<InetAddress> pathsToPush;
  195. std::vector<InetAddress> dps(RR->node->directPaths());
  196. for(std::vector<InetAddress>::const_iterator i(dps.begin());i!=dps.end();++i)
  197. pathsToPush.push_back(*i);
  198. // Do symmetric NAT prediction if we are communicating indirectly.
  199. if (hops > 0) {
  200. std::vector<InetAddress> sym(RR->sa->getSymmetricNatPredictions());
  201. for(unsigned long i=0,added=0;i<sym.size();++i) {
  202. InetAddress tmp(sym[(unsigned long)RR->node->prng() % sym.size()]);
  203. if (std::find(pathsToPush.begin(),pathsToPush.end(),tmp) == pathsToPush.end()) {
  204. pathsToPush.push_back(tmp);
  205. if (++added >= ZT_PUSH_DIRECT_PATHS_MAX_PER_SCOPE_AND_FAMILY)
  206. break;
  207. }
  208. }
  209. }
  210. if (pathsToPush.size() > 0) {
  211. std::vector<InetAddress>::const_iterator p(pathsToPush.begin());
  212. while (p != pathsToPush.end()) {
  213. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_PUSH_DIRECT_PATHS);
  214. outp.addSize(2); // leave room for count
  215. unsigned int count = 0;
  216. while ((p != pathsToPush.end())&&((outp.size() + 24) < 1200)) {
  217. uint8_t addressType = 4;
  218. switch(p->ss_family) {
  219. case AF_INET:
  220. break;
  221. case AF_INET6:
  222. addressType = 6;
  223. break;
  224. default: // we currently only push IP addresses
  225. ++p;
  226. continue;
  227. }
  228. outp.append((uint8_t)0); // no flags
  229. outp.append((uint16_t)0); // no extensions
  230. outp.append(addressType);
  231. outp.append((uint8_t)((addressType == 4) ? 6 : 18));
  232. outp.append(p->rawIpData(),((addressType == 4) ? 4 : 16));
  233. outp.append((uint16_t)p->port());
  234. ++count;
  235. ++p;
  236. }
  237. if (count) {
  238. outp.setAt(ZT_PACKET_IDX_PAYLOAD,(uint16_t)count);
  239. outp.armor(_key,true);
  240. path->send(RR,tPtr,outp.data(),outp.size(),now);
  241. }
  242. }
  243. }
  244. }
  245. }
  246. }
  247. void Peer::recordOutgoingPacket(const SharedPtr<Path> &path, const uint64_t packetId,
  248. uint16_t payloadLength, const Packet::Verb verb, int64_t now)
  249. {
  250. // Grab second byte from packetId to use as a source of entropy in the next path selection
  251. _freeRandomByte = (packetId & 0xFF00) >> 8;
  252. if (_canUseMultipath) {
  253. path->recordOutgoingPacket(now, packetId, payloadLength, verb);
  254. }
  255. }
  256. void Peer::recordIncomingPacket(void *tPtr, const SharedPtr<Path> &path, const uint64_t packetId,
  257. uint16_t payloadLength, const Packet::Verb verb, int64_t now)
  258. {
  259. if (_canUseMultipath) {
  260. if (path->needsToSendAck(now)) {
  261. sendACK(tPtr, path, path->localSocket(), path->address(), now);
  262. }
  263. path->recordIncomingPacket(now, packetId, payloadLength, verb);
  264. }
  265. }
  266. void Peer::computeAggregateProportionalAllocation(int64_t now)
  267. {
  268. float maxStability = 0;
  269. float totalRelativeQuality = 0;
  270. float maxThroughput = 1;
  271. float maxScope = 0;
  272. float relStability[ZT_MAX_PEER_NETWORK_PATHS];
  273. float relThroughput[ZT_MAX_PEER_NETWORK_PATHS];
  274. memset(&relStability, 0, sizeof(relStability));
  275. memset(&relThroughput, 0, sizeof(relThroughput));
  276. // Survey all paths
  277. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  278. if (_paths[i].p) {
  279. relStability[i] = _paths[i].p->lastComputedStability();
  280. relThroughput[i] = _paths[i].p->maxLifetimeThroughput();
  281. maxStability = relStability[i] > maxStability ? relStability[i] : maxStability;
  282. maxThroughput = relThroughput[i] > maxThroughput ? relThroughput[i] : maxThroughput;
  283. maxScope = _paths[i].p->ipScope() > maxScope ? _paths[i].p->ipScope() : maxScope;
  284. }
  285. }
  286. // Convert to relative values
  287. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  288. if (_paths[i].p) {
  289. relStability[i] /= maxStability ? maxStability : 1;
  290. relThroughput[i] /= maxThroughput ? maxThroughput : 1;
  291. float normalized_ma = Utils::normalize(_paths[i].p->ackAge(now), 0, ZT_PATH_MAX_AGE, 0, 10);
  292. float age_contrib = exp((-1)*normalized_ma);
  293. float relScope = ((float)(_paths[i].p->ipScope()+1) / (maxScope + 1));
  294. float relQuality =
  295. (relStability[i] * ZT_PATH_CONTRIB_STABILITY)
  296. + (fmax(1, relThroughput[i]) * ZT_PATH_CONTRIB_THROUGHPUT)
  297. + relScope * ZT_PATH_CONTRIB_SCOPE;
  298. relQuality *= age_contrib;
  299. // Arbitrary cutoffs
  300. relQuality = relQuality > (1.00 / 100.0) ? relQuality : 0.0;
  301. relQuality = relQuality < (99.0 / 100.0) ? relQuality : 1.0;
  302. totalRelativeQuality += relQuality;
  303. _paths[i].p->updateRelativeQuality(relQuality);
  304. }
  305. }
  306. // Convert set of relative performances into an allocation set
  307. for(uint16_t i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  308. if (_paths[i].p) {
  309. _paths[i].p->updateComponentAllocationOfAggregateLink((_paths[i].p->relativeQuality() / totalRelativeQuality) * 255);
  310. }
  311. }
  312. }
  313. int Peer::computeAggregateLinkPacketDelayVariance()
  314. {
  315. float pdv = 0.0;
  316. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  317. if (_paths[i].p) {
  318. pdv += _paths[i].p->relativeQuality() * _paths[i].p->packetDelayVariance();
  319. }
  320. }
  321. return pdv;
  322. }
  323. int Peer::computeAggregateLinkMeanLatency()
  324. {
  325. int ml = 0;
  326. int pathCount = 0;
  327. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  328. if (_paths[i].p) {
  329. pathCount++;
  330. ml += _paths[i].p->relativeQuality() * _paths[i].p->meanLatency();
  331. }
  332. }
  333. return ml / pathCount;
  334. }
  335. int Peer::aggregateLinkPhysicalPathCount()
  336. {
  337. std::map<std::string, bool> ifnamemap;
  338. int pathCount = 0;
  339. int64_t now = RR->node->now();
  340. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  341. if (_paths[i].p && _paths[i].p->alive(now)) {
  342. if (!ifnamemap[_paths[i].p->getName()]) {
  343. ifnamemap[_paths[i].p->getName()] = true;
  344. pathCount++;
  345. }
  346. }
  347. }
  348. return pathCount;
  349. }
  350. int Peer::aggregateLinkLogicalPathCount()
  351. {
  352. int pathCount = 0;
  353. int64_t now = RR->node->now();
  354. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  355. if (_paths[i].p && _paths[i].p->alive(now)) {
  356. pathCount++;
  357. }
  358. }
  359. return pathCount;
  360. }
  361. SharedPtr<Path> Peer::getAppropriatePath(int64_t now, bool includeExpired)
  362. {
  363. Mutex::Lock _l(_paths_m);
  364. unsigned int bestPath = ZT_MAX_PEER_NETWORK_PATHS;
  365. /**
  366. * Send traffic across the highest quality path only. This algorithm will still
  367. * use the old path quality metric from protocol version 9.
  368. */
  369. if (!_canUseMultipath) {
  370. long bestPathQuality = 2147483647;
  371. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  372. if (_paths[i].p) {
  373. if ((includeExpired)||((now - _paths[i].lr) < ZT_PEER_PATH_EXPIRATION)) {
  374. const long q = _paths[i].p->quality(now) / _paths[i].priority;
  375. if (q <= bestPathQuality) {
  376. bestPathQuality = q;
  377. bestPath = i;
  378. }
  379. }
  380. } else break;
  381. }
  382. if (bestPath != ZT_MAX_PEER_NETWORK_PATHS) {
  383. return _paths[bestPath].p;
  384. }
  385. return SharedPtr<Path>();
  386. }
  387. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  388. if (_paths[i].p) {
  389. _paths[i].p->processBackgroundPathMeasurements(now);
  390. }
  391. }
  392. /**
  393. * Randomly distribute traffic across all paths
  394. */
  395. int numAlivePaths = 0;
  396. int numStalePaths = 0;
  397. if (RR->node->getMultipathMode() == ZT_MULTIPATH_RANDOM) {
  398. int alivePaths[ZT_MAX_PEER_NETWORK_PATHS];
  399. int stalePaths[ZT_MAX_PEER_NETWORK_PATHS];
  400. memset(&alivePaths, -1, sizeof(alivePaths));
  401. memset(&stalePaths, -1, sizeof(stalePaths));
  402. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  403. if (_paths[i].p) {
  404. if (_paths[i].p->alive(now)) {
  405. alivePaths[numAlivePaths] = i;
  406. numAlivePaths++;
  407. }
  408. else {
  409. stalePaths[numStalePaths] = i;
  410. numStalePaths++;
  411. }
  412. }
  413. }
  414. unsigned int r = _freeRandomByte;
  415. if (numAlivePaths > 0) {
  416. int rf = r % numAlivePaths;
  417. return _paths[alivePaths[rf]].p;
  418. }
  419. else if(numStalePaths > 0) {
  420. // Resort to trying any non-expired path
  421. int rf = r % numStalePaths;
  422. return _paths[stalePaths[rf]].p;
  423. }
  424. }
  425. /**
  426. * Proportionally allocate traffic according to dynamic path quality measurements
  427. */
  428. if (RR->node->getMultipathMode() == ZT_MULTIPATH_PROPORTIONALLY_BALANCED) {
  429. if ((now - _lastAggregateAllocation) >= ZT_PATH_QUALITY_COMPUTE_INTERVAL) {
  430. _lastAggregateAllocation = now;
  431. computeAggregateProportionalAllocation(now);
  432. }
  433. // Randomly choose path according to their allocations
  434. float rf = _freeRandomByte;
  435. for(int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  436. if (_paths[i].p) {
  437. if (rf < _paths[i].p->allocation()) {
  438. bestPath = i;
  439. _pathChoiceHist.push(bestPath); // Record which path we chose
  440. break;
  441. }
  442. rf -= _paths[i].p->allocation();
  443. }
  444. }
  445. if (bestPath < ZT_MAX_PEER_NETWORK_PATHS) {
  446. return _paths[bestPath].p;
  447. }
  448. }
  449. return SharedPtr<Path>();
  450. }
  451. char *Peer::interfaceListStr()
  452. {
  453. std::map<std::string, int> ifnamemap;
  454. char tmp[32];
  455. const int64_t now = RR->node->now();
  456. char *ptr = _interfaceListStr;
  457. bool imbalanced = false;
  458. memset(_interfaceListStr, 0, sizeof(_interfaceListStr));
  459. int alivePathCount = aggregateLinkLogicalPathCount();
  460. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  461. if (_paths[i].p && _paths[i].p->alive(now)) {
  462. int ipv = _paths[i].p->address().isV4();
  463. // If this is acting as an aggregate link, check allocations
  464. float targetAllocation = 1.0 / alivePathCount;
  465. float currentAllocation = 1.0;
  466. if (alivePathCount > 1) {
  467. currentAllocation = (float)_pathChoiceHist.countValue(i) / (float)_pathChoiceHist.count();
  468. if (fabs(targetAllocation - currentAllocation) > ZT_PATH_IMBALANCE_THRESHOLD) {
  469. imbalanced = true;
  470. }
  471. }
  472. char *ipvStr = ipv ? (char*)"ipv4" : (char*)"ipv6";
  473. sprintf(tmp, "(%s, %s, %.3f)", _paths[i].p->getName(), ipvStr, currentAllocation);
  474. // Prevent duplicates
  475. if(ifnamemap[_paths[i].p->getName()] != ipv) {
  476. memcpy(ptr, tmp, strlen(tmp));
  477. ptr += strlen(tmp);
  478. *ptr = ' ';
  479. ptr++;
  480. ifnamemap[_paths[i].p->getName()] = ipv;
  481. }
  482. }
  483. }
  484. ptr--; // Overwrite trailing space
  485. if (imbalanced) {
  486. sprintf(tmp, ", is asymmetrical");
  487. memcpy(ptr, tmp, sizeof(tmp));
  488. } else {
  489. *ptr = '\0';
  490. }
  491. return _interfaceListStr;
  492. }
  493. void Peer::introduce(void *const tPtr,const int64_t now,const SharedPtr<Peer> &other) const
  494. {
  495. unsigned int myBestV4ByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  496. unsigned int myBestV6ByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  497. long myBestV4QualityByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  498. long myBestV6QualityByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  499. unsigned int theirBestV4ByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  500. unsigned int theirBestV6ByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  501. long theirBestV4QualityByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  502. long theirBestV6QualityByScope[ZT_INETADDRESS_MAX_SCOPE+1];
  503. for(int i=0;i<=ZT_INETADDRESS_MAX_SCOPE;++i) {
  504. myBestV4ByScope[i] = ZT_MAX_PEER_NETWORK_PATHS;
  505. myBestV6ByScope[i] = ZT_MAX_PEER_NETWORK_PATHS;
  506. myBestV4QualityByScope[i] = 2147483647;
  507. myBestV6QualityByScope[i] = 2147483647;
  508. theirBestV4ByScope[i] = ZT_MAX_PEER_NETWORK_PATHS;
  509. theirBestV6ByScope[i] = ZT_MAX_PEER_NETWORK_PATHS;
  510. theirBestV4QualityByScope[i] = 2147483647;
  511. theirBestV6QualityByScope[i] = 2147483647;
  512. }
  513. Mutex::Lock _l1(_paths_m);
  514. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  515. if (_paths[i].p) {
  516. const long q = _paths[i].p->quality(now) / _paths[i].priority;
  517. const unsigned int s = (unsigned int)_paths[i].p->ipScope();
  518. switch(_paths[i].p->address().ss_family) {
  519. case AF_INET:
  520. if (q <= myBestV4QualityByScope[s]) {
  521. myBestV4QualityByScope[s] = q;
  522. myBestV4ByScope[s] = i;
  523. }
  524. break;
  525. case AF_INET6:
  526. if (q <= myBestV6QualityByScope[s]) {
  527. myBestV6QualityByScope[s] = q;
  528. myBestV6ByScope[s] = i;
  529. }
  530. break;
  531. }
  532. } else break;
  533. }
  534. Mutex::Lock _l2(other->_paths_m);
  535. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  536. if (other->_paths[i].p) {
  537. const long q = other->_paths[i].p->quality(now) / other->_paths[i].priority;
  538. const unsigned int s = (unsigned int)other->_paths[i].p->ipScope();
  539. switch(other->_paths[i].p->address().ss_family) {
  540. case AF_INET:
  541. if (q <= theirBestV4QualityByScope[s]) {
  542. theirBestV4QualityByScope[s] = q;
  543. theirBestV4ByScope[s] = i;
  544. }
  545. break;
  546. case AF_INET6:
  547. if (q <= theirBestV6QualityByScope[s]) {
  548. theirBestV6QualityByScope[s] = q;
  549. theirBestV6ByScope[s] = i;
  550. }
  551. break;
  552. }
  553. } else break;
  554. }
  555. unsigned int mine = ZT_MAX_PEER_NETWORK_PATHS;
  556. unsigned int theirs = ZT_MAX_PEER_NETWORK_PATHS;
  557. for(int s=ZT_INETADDRESS_MAX_SCOPE;s>=0;--s) {
  558. if ((myBestV6ByScope[s] != ZT_MAX_PEER_NETWORK_PATHS)&&(theirBestV6ByScope[s] != ZT_MAX_PEER_NETWORK_PATHS)) {
  559. mine = myBestV6ByScope[s];
  560. theirs = theirBestV6ByScope[s];
  561. break;
  562. }
  563. if ((myBestV4ByScope[s] != ZT_MAX_PEER_NETWORK_PATHS)&&(theirBestV4ByScope[s] != ZT_MAX_PEER_NETWORK_PATHS)) {
  564. mine = myBestV4ByScope[s];
  565. theirs = theirBestV4ByScope[s];
  566. break;
  567. }
  568. }
  569. if (mine != ZT_MAX_PEER_NETWORK_PATHS) {
  570. unsigned int alt = (unsigned int)RR->node->prng() & 1; // randomize which hint we send first for black magickal NAT-t reasons
  571. const unsigned int completed = alt + 2;
  572. while (alt != completed) {
  573. if ((alt & 1) == 0) {
  574. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_RENDEZVOUS);
  575. outp.append((uint8_t)0);
  576. other->_id.address().appendTo(outp);
  577. outp.append((uint16_t)other->_paths[theirs].p->address().port());
  578. if (other->_paths[theirs].p->address().ss_family == AF_INET6) {
  579. outp.append((uint8_t)16);
  580. outp.append(other->_paths[theirs].p->address().rawIpData(),16);
  581. } else {
  582. outp.append((uint8_t)4);
  583. outp.append(other->_paths[theirs].p->address().rawIpData(),4);
  584. }
  585. outp.armor(_key,true);
  586. _paths[mine].p->send(RR,tPtr,outp.data(),outp.size(),now);
  587. } else {
  588. Packet outp(other->_id.address(),RR->identity.address(),Packet::VERB_RENDEZVOUS);
  589. outp.append((uint8_t)0);
  590. _id.address().appendTo(outp);
  591. outp.append((uint16_t)_paths[mine].p->address().port());
  592. if (_paths[mine].p->address().ss_family == AF_INET6) {
  593. outp.append((uint8_t)16);
  594. outp.append(_paths[mine].p->address().rawIpData(),16);
  595. } else {
  596. outp.append((uint8_t)4);
  597. outp.append(_paths[mine].p->address().rawIpData(),4);
  598. }
  599. outp.armor(other->_key,true);
  600. other->_paths[theirs].p->send(RR,tPtr,outp.data(),outp.size(),now);
  601. }
  602. ++alt;
  603. }
  604. }
  605. }
  606. inline void Peer::processBackgroundPeerTasks(int64_t now)
  607. {
  608. // Determine current multipath compatibility with other peer
  609. if ((now - _lastMultipathCompatibilityCheck) >= ZT_PATH_QUALITY_COMPUTE_INTERVAL) {
  610. // Cache number of available paths so that we can short-circuit multipath logic elsewhere
  611. //
  612. // We also take notice of duplicate paths (same IP only) because we may have
  613. // recently received a direct path push from a peer and our list might contain
  614. // a dead path which hasn't been fully recognized as such. In this case we
  615. // don't want the duplicate to trigger execution of multipath code prematurely.
  616. //
  617. // This is done to support the behavior of auto multipath enable/disable
  618. // without user intervention.
  619. int currAlivePathCount = 0;
  620. int duplicatePathsFound = 0;
  621. for (unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  622. if (_paths[i].p) {
  623. currAlivePathCount++;
  624. for (unsigned int j=0;j<ZT_MAX_PEER_NETWORK_PATHS;++j) {
  625. if (_paths[i].p && _paths[j].p && _paths[i].p->address().ipsEqual2(_paths[j].p->address()) && i != j) {
  626. duplicatePathsFound+=1;
  627. break;
  628. }
  629. }
  630. }
  631. }
  632. _uniqueAlivePathCount = (currAlivePathCount - (duplicatePathsFound / 2));
  633. _lastMultipathCompatibilityCheck = now;
  634. _localMultipathSupported = ((RR->node->getMultipathMode() != ZT_MULTIPATH_NONE) && (ZT_PROTO_VERSION > 9));
  635. _remoteMultipathSupported = _vProto > 9;
  636. // If both peers support multipath and more than one path exist, we can use multipath logic
  637. _canUseMultipath = _localMultipathSupported && _remoteMultipathSupported && (_uniqueAlivePathCount > 1);
  638. }
  639. }
  640. void Peer::sendACK(void *tPtr,const SharedPtr<Path> &path,const int64_t localSocket,const InetAddress &atAddress,int64_t now)
  641. {
  642. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_ACK);
  643. uint32_t bytesToAck = path->bytesToAck();
  644. outp.append<uint32_t>(bytesToAck);
  645. if (atAddress) {
  646. outp.armor(_key,false);
  647. RR->node->putPacket(tPtr,localSocket,atAddress,outp.data(),outp.size());
  648. } else {
  649. RR->sw->send(tPtr,outp,false);
  650. }
  651. path->sentAck(now);
  652. }
  653. void Peer::sendQOS_MEASUREMENT(void *tPtr,const SharedPtr<Path> &path,const int64_t localSocket,const InetAddress &atAddress,int64_t now)
  654. {
  655. const int64_t _now = RR->node->now();
  656. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_QOS_MEASUREMENT);
  657. char qosData[ZT_PATH_MAX_QOS_PACKET_SZ];
  658. int16_t len = path->generateQoSPacket(_now,qosData);
  659. outp.append(qosData,len);
  660. if (atAddress) {
  661. outp.armor(_key,false);
  662. RR->node->putPacket(tPtr,localSocket,atAddress,outp.data(),outp.size());
  663. } else {
  664. RR->sw->send(tPtr,outp,false);
  665. }
  666. path->sentQoS(now);
  667. }
  668. void Peer::sendHELLO(void *tPtr,const int64_t localSocket,const InetAddress &atAddress,int64_t now)
  669. {
  670. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_HELLO);
  671. outp.append((unsigned char)ZT_PROTO_VERSION);
  672. outp.append((unsigned char)ZEROTIER_ONE_VERSION_MAJOR);
  673. outp.append((unsigned char)ZEROTIER_ONE_VERSION_MINOR);
  674. outp.append((uint16_t)ZEROTIER_ONE_VERSION_REVISION);
  675. outp.append(now);
  676. RR->identity.serialize(outp,false);
  677. atAddress.serialize(outp);
  678. outp.append((uint64_t)RR->topology->planetWorldId());
  679. outp.append((uint64_t)RR->topology->planetWorldTimestamp());
  680. const unsigned int startCryptedPortionAt = outp.size();
  681. std::vector<World> moons(RR->topology->moons());
  682. std::vector<uint64_t> moonsWanted(RR->topology->moonsWanted());
  683. outp.append((uint16_t)(moons.size() + moonsWanted.size()));
  684. for(std::vector<World>::const_iterator m(moons.begin());m!=moons.end();++m) {
  685. outp.append((uint8_t)m->type());
  686. outp.append((uint64_t)m->id());
  687. outp.append((uint64_t)m->timestamp());
  688. }
  689. for(std::vector<uint64_t>::const_iterator m(moonsWanted.begin());m!=moonsWanted.end();++m) {
  690. outp.append((uint8_t)World::TYPE_MOON);
  691. outp.append(*m);
  692. outp.append((uint64_t)0);
  693. }
  694. outp.cryptField(_key,startCryptedPortionAt,outp.size() - startCryptedPortionAt);
  695. RR->node->expectReplyTo(outp.packetId());
  696. if (atAddress) {
  697. outp.armor(_key,false); // false == don't encrypt full payload, but add MAC
  698. RR->node->putPacket(tPtr,localSocket,atAddress,outp.data(),outp.size());
  699. } else {
  700. RR->sw->send(tPtr,outp,false); // false == don't encrypt full payload, but add MAC
  701. }
  702. }
  703. void Peer::attemptToContactAt(void *tPtr,const int64_t localSocket,const InetAddress &atAddress,int64_t now,bool sendFullHello)
  704. {
  705. if ( (!sendFullHello) && (_vProto >= 5) && (!((_vMajor == 1)&&(_vMinor == 1)&&(_vRevision == 0))) ) {
  706. Packet outp(_id.address(),RR->identity.address(),Packet::VERB_ECHO);
  707. RR->node->expectReplyTo(outp.packetId());
  708. outp.armor(_key,true);
  709. RR->node->putPacket(tPtr,localSocket,atAddress,outp.data(),outp.size());
  710. } else {
  711. sendHELLO(tPtr,localSocket,atAddress,now);
  712. }
  713. }
  714. void Peer::tryMemorizedPath(void *tPtr,int64_t now)
  715. {
  716. if ((now - _lastTriedMemorizedPath) >= ZT_TRY_MEMORIZED_PATH_INTERVAL) {
  717. _lastTriedMemorizedPath = now;
  718. InetAddress mp;
  719. if (RR->node->externalPathLookup(tPtr,_id.address(),-1,mp))
  720. attemptToContactAt(tPtr,-1,mp,now,true);
  721. }
  722. }
  723. unsigned int Peer::doPingAndKeepalive(void *tPtr,int64_t now)
  724. {
  725. unsigned int sent = 0;
  726. Mutex::Lock _l(_paths_m);
  727. const bool sendFullHello = ((now - _lastSentFullHello) >= ZT_PEER_PING_PERIOD);
  728. _lastSentFullHello = now;
  729. processBackgroundPeerTasks(now);
  730. // Emit traces regarding aggregate link status
  731. if (_canUseMultipath) {
  732. int alivePathCount = aggregateLinkPhysicalPathCount();
  733. if ((now - _lastAggregateStatsReport) > ZT_PATH_AGGREGATE_STATS_REPORT_INTERVAL) {
  734. _lastAggregateStatsReport = now;
  735. if (alivePathCount) {
  736. RR->t->peerLinkAggregateStatistics(NULL,*this);
  737. }
  738. } if (alivePathCount < 2 && _linkIsRedundant) {
  739. _linkIsRedundant = !_linkIsRedundant;
  740. RR->t->peerLinkNoLongerRedundant(NULL,*this);
  741. } if (alivePathCount > 1 && !_linkIsRedundant) {
  742. _linkIsRedundant = !_linkIsRedundant;
  743. RR->t->peerLinkNowRedundant(NULL,*this);
  744. }
  745. }
  746. // Right now we only keep pinging links that have the maximum priority. The
  747. // priority is used to track cluster redirections, meaning that when a cluster
  748. // redirects us its redirect target links override all other links and we
  749. // let those old links expire.
  750. long maxPriority = 0;
  751. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  752. if (_paths[i].p)
  753. maxPriority = std::max(_paths[i].priority,maxPriority);
  754. else break;
  755. }
  756. unsigned int j = 0;
  757. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  758. if (_paths[i].p) {
  759. // Clean expired and reduced priority paths
  760. if ( ((now - _paths[i].lr) < ZT_PEER_PATH_EXPIRATION) && (_paths[i].priority == maxPriority) ) {
  761. if ((sendFullHello)||(_paths[i].p->needsHeartbeat(now))) {
  762. attemptToContactAt(tPtr,_paths[i].p->localSocket(),_paths[i].p->address(),now,sendFullHello);
  763. _paths[i].p->sent(now);
  764. sent |= (_paths[i].p->address().ss_family == AF_INET) ? 0x1 : 0x2;
  765. }
  766. if (i != j)
  767. _paths[j] = _paths[i];
  768. ++j;
  769. }
  770. } else break;
  771. }
  772. if (canUseMultipath()) {
  773. while(j < ZT_MAX_PEER_NETWORK_PATHS) {
  774. _paths[j].lr = 0;
  775. _paths[j].p.zero();
  776. _paths[j].priority = 1;
  777. ++j;
  778. }
  779. }
  780. return sent;
  781. }
  782. void Peer::clusterRedirect(void *tPtr,const SharedPtr<Path> &originatingPath,const InetAddress &remoteAddress,const int64_t now)
  783. {
  784. SharedPtr<Path> np(RR->topology->getPath(originatingPath->localSocket(),remoteAddress));
  785. RR->t->peerRedirected(tPtr,0,*this,np);
  786. attemptToContactAt(tPtr,originatingPath->localSocket(),remoteAddress,now,true);
  787. {
  788. Mutex::Lock _l(_paths_m);
  789. // New priority is higher than the priority of the originating path (if known)
  790. long newPriority = 1;
  791. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  792. if (_paths[i].p) {
  793. if (_paths[i].p == originatingPath) {
  794. newPriority = _paths[i].priority;
  795. break;
  796. }
  797. } else break;
  798. }
  799. newPriority += 2;
  800. // Erase any paths with lower priority than this one or that are duplicate
  801. // IPs and add this path.
  802. unsigned int j = 0;
  803. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  804. if (_paths[i].p) {
  805. if ((_paths[i].priority >= newPriority)&&(!_paths[i].p->address().ipsEqual2(remoteAddress))) {
  806. if (i != j)
  807. _paths[j] = _paths[i];
  808. ++j;
  809. }
  810. }
  811. }
  812. if (j < ZT_MAX_PEER_NETWORK_PATHS) {
  813. _paths[j].lr = now;
  814. _paths[j].p = np;
  815. _paths[j].priority = newPriority;
  816. ++j;
  817. while (j < ZT_MAX_PEER_NETWORK_PATHS) {
  818. _paths[j].lr = 0;
  819. _paths[j].p.zero();
  820. _paths[j].priority = 1;
  821. ++j;
  822. }
  823. }
  824. }
  825. }
  826. void Peer::resetWithinScope(void *tPtr,InetAddress::IpScope scope,int inetAddressFamily,int64_t now)
  827. {
  828. Mutex::Lock _l(_paths_m);
  829. for(unsigned int i=0;i<ZT_MAX_PEER_NETWORK_PATHS;++i) {
  830. if (_paths[i].p) {
  831. if ((_paths[i].p->address().ss_family == inetAddressFamily)&&(_paths[i].p->ipScope() == scope)) {
  832. attemptToContactAt(tPtr,_paths[i].p->localSocket(),_paths[i].p->address(),now,false);
  833. _paths[i].p->sent(now);
  834. _paths[i].lr = 0; // path will not be used unless it speaks again
  835. }
  836. } else break;
  837. }
  838. }
  839. } // namespace ZeroTier