Path.hpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  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. #ifndef ZT_PATH_HPP
  27. #define ZT_PATH_HPP
  28. #include <stdint.h>
  29. #include <string.h>
  30. #include <stdlib.h>
  31. #include <stdexcept>
  32. #include <algorithm>
  33. #include "Constants.hpp"
  34. #include "InetAddress.hpp"
  35. #include "SharedPtr.hpp"
  36. #include "AtomicCounter.hpp"
  37. #include "Utils.hpp"
  38. #include "RingBuffer.hpp"
  39. #include "Packet.hpp"
  40. #include "../osdep/Phy.hpp"
  41. /**
  42. * Maximum return value of preferenceRank()
  43. */
  44. #define ZT_PATH_MAX_PREFERENCE_RANK ((ZT_INETADDRESS_MAX_SCOPE << 1) | 1)
  45. namespace ZeroTier {
  46. class RuntimeEnvironment;
  47. /**
  48. * A path across the physical network
  49. */
  50. class Path
  51. {
  52. friend class SharedPtr<Path>;
  53. Phy<Path *> *_phy;
  54. public:
  55. /**
  56. * Efficient unique key for paths in a Hashtable
  57. */
  58. class HashKey
  59. {
  60. public:
  61. inline HashKey() {}
  62. inline HashKey(const int64_t l,const InetAddress &r)
  63. {
  64. if (r.ss_family == AF_INET) {
  65. _k[0] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&r)->sin_addr.s_addr;
  66. _k[1] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&r)->sin_port;
  67. _k[2] = (uint64_t)l;
  68. } else if (r.ss_family == AF_INET6) {
  69. memcpy(_k,reinterpret_cast<const struct sockaddr_in6 *>(&r)->sin6_addr.s6_addr,16);
  70. _k[2] = ((uint64_t)reinterpret_cast<const struct sockaddr_in6 *>(&r)->sin6_port << 32) ^ (uint64_t)l;
  71. } else {
  72. memcpy(_k,&r,std::min(sizeof(_k),sizeof(InetAddress)));
  73. _k[2] += (uint64_t)l;
  74. }
  75. }
  76. inline unsigned long hashCode() const { return (unsigned long)(_k[0] + _k[1] + _k[2]); }
  77. inline bool operator==(const HashKey &k) const { return ( (_k[0] == k._k[0]) && (_k[1] == k._k[1]) && (_k[2] == k._k[2]) ); }
  78. inline bool operator!=(const HashKey &k) const { return (!(*this == k)); }
  79. private:
  80. uint64_t _k[3];
  81. };
  82. inline Path() :
  83. _lastOut(0),
  84. _lastIn(0),
  85. _lastPathQualityComputeTime(0),
  86. _localSocket(-1),
  87. _latency(0xffff),
  88. _addr(),
  89. _ipScope(InetAddress::IP_SCOPE_NONE),
  90. _lastAck(0),
  91. _lastThroughputEstimation(0),
  92. _lastQoSMeasurement(0),
  93. _lastQoSRecordPurge(0),
  94. _unackedBytes(0),
  95. _expectingAckAsOf(0),
  96. _packetsReceivedSinceLastAck(0),
  97. _packetsReceivedSinceLastQoS(0),
  98. _maxLifetimeThroughput(0),
  99. _lastComputedMeanThroughput(0),
  100. _bytesAckedSinceLastThroughputEstimation(0),
  101. _lastComputedMeanLatency(0.0),
  102. _lastComputedPacketDelayVariance(0.0),
  103. _lastComputedPacketErrorRatio(0.0),
  104. _lastComputedPacketLossRatio(0),
  105. _lastComputedStability(0.0),
  106. _lastComputedRelativeQuality(0),
  107. _lastComputedThroughputDistCoeff(0.0),
  108. _lastAllocation(0)
  109. {
  110. memset(_ifname, 0, 16);
  111. memset(_addrString, 0, sizeof(_addrString));
  112. }
  113. inline Path(const int64_t localSocket,const InetAddress &addr) :
  114. _lastOut(0),
  115. _lastIn(0),
  116. _lastPathQualityComputeTime(0),
  117. _localSocket(localSocket),
  118. _latency(0xffff),
  119. _addr(addr),
  120. _ipScope(addr.ipScope()),
  121. _lastAck(0),
  122. _lastThroughputEstimation(0),
  123. _lastQoSMeasurement(0),
  124. _lastQoSRecordPurge(0),
  125. _unackedBytes(0),
  126. _expectingAckAsOf(0),
  127. _packetsReceivedSinceLastAck(0),
  128. _packetsReceivedSinceLastQoS(0),
  129. _maxLifetimeThroughput(0),
  130. _lastComputedMeanThroughput(0),
  131. _bytesAckedSinceLastThroughputEstimation(0),
  132. _lastComputedMeanLatency(0.0),
  133. _lastComputedPacketDelayVariance(0.0),
  134. _lastComputedPacketErrorRatio(0.0),
  135. _lastComputedPacketLossRatio(0),
  136. _lastComputedStability(0.0),
  137. _lastComputedRelativeQuality(0),
  138. _lastComputedThroughputDistCoeff(0.0),
  139. _lastAllocation(0)
  140. {
  141. memset(_ifname, 0, 16);
  142. memset(_addrString, 0, sizeof(_addrString));
  143. if (_localSocket != -1) {
  144. _phy->getIfName((PhySocket *) ((uintptr_t) _localSocket), _ifname, 16);
  145. }
  146. }
  147. /**
  148. * Called when a packet is received from this remote path, regardless of content
  149. *
  150. * @param t Time of receive
  151. */
  152. inline void received(const uint64_t t) { _lastIn = t; }
  153. /**
  154. * Send a packet via this path (last out time is also updated)
  155. *
  156. * @param RR Runtime environment
  157. * @param tPtr Thread pointer to be handed through to any callbacks called as a result of this call
  158. * @param data Packet data
  159. * @param len Packet length
  160. * @param now Current time
  161. * @return True if transport reported success
  162. */
  163. bool send(const RuntimeEnvironment *RR,void *tPtr,const void *data,unsigned int len,int64_t now);
  164. /**
  165. * Manually update last sent time
  166. *
  167. * @param t Time of send
  168. */
  169. inline void sent(const int64_t t) { _lastOut = t; }
  170. /**
  171. * Update path latency with a new measurement
  172. *
  173. * @param l Measured latency
  174. */
  175. inline void updateLatency(const unsigned int l, int64_t now)
  176. {
  177. unsigned int pl = _latency;
  178. if (pl < 0xffff) {
  179. _latency = (pl + l) / 2;
  180. }
  181. else {
  182. _latency = l;
  183. }
  184. _latencySamples.push(l);
  185. }
  186. /**
  187. * @return Local socket as specified by external code
  188. */
  189. inline int64_t localSocket() const { return _localSocket; }
  190. /**
  191. * @return Physical address
  192. */
  193. inline const InetAddress &address() const { return _addr; }
  194. /**
  195. * @return IP scope -- faster shortcut for address().ipScope()
  196. */
  197. inline InetAddress::IpScope ipScope() const { return _ipScope; }
  198. /**
  199. * @return Preference rank, higher == better
  200. */
  201. inline unsigned int preferenceRank() const
  202. {
  203. // This causes us to rank paths in order of IP scope rank (see InetAdddress.hpp) but
  204. // within each IP scope class to prefer IPv6 over IPv4.
  205. return ( ((unsigned int)_ipScope << 1) | (unsigned int)(_addr.ss_family == AF_INET6) );
  206. }
  207. /**
  208. * Check whether this address is valid for a ZeroTier path
  209. *
  210. * This checks the address type and scope against address types and scopes
  211. * that we currently support for ZeroTier communication.
  212. *
  213. * @param a Address to check
  214. * @return True if address is good for ZeroTier path use
  215. */
  216. static inline bool isAddressValidForPath(const InetAddress &a)
  217. {
  218. if ((a.ss_family == AF_INET)||(a.ss_family == AF_INET6)) {
  219. switch(a.ipScope()) {
  220. /* Note: we don't do link-local at the moment. Unfortunately these
  221. * cause several issues. The first is that they usually require a
  222. * device qualifier, which we don't handle yet and can't portably
  223. * push in PUSH_DIRECT_PATHS. The second is that some OSes assign
  224. * these very ephemerally or otherwise strangely. So we'll use
  225. * private, pseudo-private, shared (e.g. carrier grade NAT), or
  226. * global IP addresses. */
  227. case InetAddress::IP_SCOPE_PRIVATE:
  228. case InetAddress::IP_SCOPE_PSEUDOPRIVATE:
  229. case InetAddress::IP_SCOPE_SHARED:
  230. case InetAddress::IP_SCOPE_GLOBAL:
  231. if (a.ss_family == AF_INET6) {
  232. // TEMPORARY HACK: for now, we are going to blacklist he.net IPv6
  233. // tunnels due to very spotty performance and low MTU issues over
  234. // these IPv6 tunnel links.
  235. const uint8_t *ipd = reinterpret_cast<const uint8_t *>(reinterpret_cast<const struct sockaddr_in6 *>(&a)->sin6_addr.s6_addr);
  236. if ((ipd[0] == 0x20)&&(ipd[1] == 0x01)&&(ipd[2] == 0x04)&&(ipd[3] == 0x70))
  237. return false;
  238. }
  239. return true;
  240. default:
  241. return false;
  242. }
  243. }
  244. return false;
  245. }
  246. /**
  247. * @return Latency or 0xffff if unknown
  248. */
  249. inline unsigned int latency() const { return _latency; }
  250. /**
  251. * @return Path quality -- lower is better
  252. */
  253. inline long quality(const int64_t now) const
  254. {
  255. const long l = (long)_latency;
  256. const long age = (long)std::min((long)(now - _lastIn),(long)(ZT_PEER_PING_PERIOD * 10)); // set an upper sanity limit to avoid overflow
  257. return ( ( (age < (ZT_PEER_PING_PERIOD + 5000)) ? l : (l + 65535 + age) ) * (long)((ZT_INETADDRESS_MAX_SCOPE - _ipScope) + 1));
  258. }
  259. /**
  260. * Record statistics on outgoing packets. Used later to estimate QoS metrics.
  261. *
  262. * @param now Current time
  263. * @param packetId ID of packet
  264. * @param payloadLength Length of payload
  265. * @param verb Packet verb
  266. */
  267. inline void recordOutgoingPacket(int64_t now, int64_t packetId, uint16_t payloadLength, Packet::Verb verb)
  268. {
  269. Mutex::Lock _l(_statistics_m);
  270. if (verb != Packet::VERB_ACK && verb != Packet::VERB_QOS_MEASUREMENT) {
  271. if ((packetId & (ZT_PATH_QOS_ACK_PROTOCOL_DIVISOR - 1)) == 0) {
  272. _unackedBytes += payloadLength;
  273. // Take note that we're expecting a VERB_ACK on this path as of a specific time
  274. _expectingAckAsOf = ackAge(now) > ZT_PATH_ACK_INTERVAL ? _expectingAckAsOf : now;
  275. if (_outQoSRecords.size() < ZT_PATH_MAX_OUTSTANDING_QOS_RECORDS) {
  276. _outQoSRecords[packetId] = now;
  277. }
  278. }
  279. }
  280. }
  281. /**
  282. * Record statistics on incoming packets. Used later to estimate QoS metrics.
  283. *
  284. * @param now Current time
  285. * @param packetId ID of packet
  286. * @param payloadLength Length of payload
  287. * @param verb Packet verb
  288. */
  289. inline void recordIncomingPacket(int64_t now, int64_t packetId, uint16_t payloadLength, Packet::Verb verb)
  290. {
  291. Mutex::Lock _l(_statistics_m);
  292. if (verb != Packet::VERB_ACK && verb != Packet::VERB_QOS_MEASUREMENT) {
  293. if ((packetId & (ZT_PATH_QOS_ACK_PROTOCOL_DIVISOR - 1)) == 0) {
  294. _inACKRecords[packetId] = payloadLength;
  295. _packetsReceivedSinceLastAck++;
  296. _inQoSRecords[packetId] = now;
  297. _packetsReceivedSinceLastQoS++;
  298. }
  299. _packetValiditySamples.push(true);
  300. }
  301. }
  302. /**
  303. * Record that we've received a VERB_ACK on this path, also compute throughput if required.
  304. *
  305. * @param now Current time
  306. * @param ackedBytes Number of bytes acknowledged by other peer
  307. */
  308. inline void receivedAck(int64_t now, int32_t ackedBytes)
  309. {
  310. _expectingAckAsOf = 0;
  311. _unackedBytes = (ackedBytes > _unackedBytes) ? 0 : _unackedBytes - ackedBytes;
  312. int64_t timeSinceThroughputEstimate = (now - _lastThroughputEstimation);
  313. if (timeSinceThroughputEstimate >= ZT_PATH_THROUGHPUT_MEASUREMENT_INTERVAL) {
  314. uint64_t throughput = (uint64_t)((float)(_bytesAckedSinceLastThroughputEstimation * 8) / ((float)timeSinceThroughputEstimate / (float)1000));
  315. _throughputSamples.push(throughput);
  316. _maxLifetimeThroughput = throughput > _maxLifetimeThroughput ? throughput : _maxLifetimeThroughput;
  317. _lastThroughputEstimation = now;
  318. _bytesAckedSinceLastThroughputEstimation = 0;
  319. } else {
  320. _bytesAckedSinceLastThroughputEstimation += ackedBytes;
  321. }
  322. }
  323. /**
  324. * @return Number of bytes this peer is responsible for ACKing since last ACK
  325. */
  326. inline int32_t bytesToAck()
  327. {
  328. Mutex::Lock _l(_statistics_m);
  329. int32_t bytesToAck = 0;
  330. std::map<uint64_t,uint16_t>::iterator it = _inACKRecords.begin();
  331. while (it != _inACKRecords.end()) {
  332. bytesToAck += it->second;
  333. it++;
  334. }
  335. return bytesToAck;
  336. }
  337. /**
  338. * @return Number of bytes thus far sent that have not been acknowledged by the remote peer
  339. */
  340. inline int64_t unackedSentBytes()
  341. {
  342. return _unackedBytes;
  343. }
  344. /**
  345. * Account for the fact that an ACK was just sent. Reset counters, timers, and clear statistics buffers
  346. *
  347. * @param Current time
  348. */
  349. inline void sentAck(int64_t now)
  350. {
  351. Mutex::Lock _l(_statistics_m);
  352. _inACKRecords.clear();
  353. _packetsReceivedSinceLastAck = 0;
  354. _lastAck = now;
  355. }
  356. /**
  357. * Receive QoS data, match with recorded egress times from this peer, compute latency
  358. * estimates.
  359. *
  360. * @param now Current time
  361. * @param count Number of records
  362. * @param rx_id table of packet IDs
  363. * @param rx_ts table of holding times
  364. */
  365. inline void receivedQoS(int64_t now, int count, uint64_t *rx_id, uint16_t *rx_ts)
  366. {
  367. Mutex::Lock _l(_statistics_m);
  368. // Look up egress times and compute latency values for each record
  369. std::map<uint64_t,uint64_t>::iterator it;
  370. for (int j=0; j<count; j++) {
  371. it = _outQoSRecords.find(rx_id[j]);
  372. if (it != _outQoSRecords.end()) {
  373. uint16_t rtt = (uint16_t)(now - it->second);
  374. uint16_t rtt_compensated = rtt - rx_ts[j];
  375. uint16_t latency = rtt_compensated / 2;
  376. updateLatency(latency, now);
  377. _outQoSRecords.erase(it);
  378. }
  379. }
  380. }
  381. /**
  382. * Generate the contents of a VERB_QOS_MEASUREMENT packet.
  383. *
  384. * @param now Current time
  385. * @param qosBuffer destination buffer
  386. * @return Size of payload
  387. */
  388. inline int32_t generateQoSPacket(int64_t now, char *qosBuffer)
  389. {
  390. Mutex::Lock _l(_statistics_m);
  391. int32_t len = 0;
  392. std::map<uint64_t,uint64_t>::iterator it = _inQoSRecords.begin();
  393. int i=0;
  394. while (i<_packetsReceivedSinceLastQoS && it != _inQoSRecords.end()) {
  395. uint64_t id = it->first;
  396. memcpy(qosBuffer, &id, sizeof(uint64_t));
  397. qosBuffer+=sizeof(uint64_t);
  398. uint16_t holdingTime = (uint16_t)(now - it->second);
  399. memcpy(qosBuffer, &holdingTime, sizeof(uint16_t));
  400. qosBuffer+=sizeof(uint16_t);
  401. len+=sizeof(uint64_t)+sizeof(uint16_t);
  402. _inQoSRecords.erase(it++);
  403. i++;
  404. }
  405. return len;
  406. }
  407. /**
  408. * Account for the fact that a VERB_QOS_MEASUREMENT was just sent. Reset timers.
  409. *
  410. * @param Current time
  411. */
  412. inline void sentQoS(int64_t now) {
  413. _packetsReceivedSinceLastQoS = 0;
  414. _lastQoSMeasurement = now;
  415. }
  416. /**
  417. * @param now Current time
  418. * @return Whether an ACK (VERB_ACK) packet needs to be emitted at this time
  419. */
  420. inline bool needsToSendAck(int64_t now) {
  421. return ((now - _lastAck) >= ZT_PATH_ACK_INTERVAL ||
  422. (_packetsReceivedSinceLastAck == ZT_PATH_QOS_TABLE_SIZE)) && _packetsReceivedSinceLastAck;
  423. }
  424. /**
  425. * @param now Current time
  426. * @return Whether a QoS (VERB_QOS_MEASUREMENT) packet needs to be emitted at this time
  427. */
  428. inline bool needsToSendQoS(int64_t now) {
  429. return ((_packetsReceivedSinceLastQoS >= ZT_PATH_QOS_TABLE_SIZE) ||
  430. ((now - _lastQoSMeasurement) > ZT_PATH_QOS_INTERVAL)) && _packetsReceivedSinceLastQoS;
  431. }
  432. /**
  433. * How much time has elapsed since we've been expecting a VERB_ACK on this path. This value
  434. * is used to determine a more relevant path "age". This lets us penalize paths which are no
  435. * longer ACKing, but not those that simple aren't being used to carry traffic at the
  436. * current time.
  437. */
  438. inline int64_t ackAge(int64_t now) { return _expectingAckAsOf ? now - _expectingAckAsOf : 0; }
  439. /**
  440. * The maximum observed throughput (in bits/s) for this path
  441. */
  442. inline uint64_t maxLifetimeThroughput() { return _maxLifetimeThroughput; }
  443. /**
  444. * @return The mean throughput (in bits/s) of this link
  445. */
  446. inline uint64_t meanThroughput() { return _lastComputedMeanThroughput; }
  447. /**
  448. * Assign a new relative quality value for this path in the aggregate link
  449. *
  450. * @param rq Quality of this path in comparison to other paths available to this peer
  451. */
  452. inline void updateRelativeQuality(float rq) { _lastComputedRelativeQuality = rq; }
  453. /**
  454. * @return Quality of this path compared to others in the aggregate link
  455. */
  456. inline float relativeQuality() { return _lastComputedRelativeQuality; }
  457. /**
  458. * Assign a new allocation value for this path in the aggregate link
  459. *
  460. * @param allocation Percentage of traffic to be sent over this path to a peer
  461. */
  462. inline void updateComponentAllocationOfAggregateLink(unsigned char allocation) { _lastAllocation = allocation; }
  463. /**
  464. * @return Percentage of traffic allocated to this path in the aggregate link
  465. */
  466. inline unsigned char allocation() { return _lastAllocation; }
  467. /**
  468. * @return Stability estimates can become expensive to compute, we cache the most recent result.
  469. */
  470. inline float lastComputedStability() { return _lastComputedStability; }
  471. /**
  472. * @return A pointer to a cached copy of the human-readable name of the interface this Path's localSocket is bound to
  473. */
  474. inline char *getName() { return _ifname; }
  475. /**
  476. * @return Packet delay variance
  477. */
  478. inline float packetDelayVariance() { return _lastComputedPacketDelayVariance; }
  479. /**
  480. * @return Previously-computed mean latency
  481. */
  482. inline float meanLatency() { return _lastComputedMeanLatency; }
  483. /**
  484. * @return Packet loss rate (PLR)
  485. */
  486. inline float packetLossRatio() { return _lastComputedPacketLossRatio; }
  487. /**
  488. * @return Packet error ratio (PER)
  489. */
  490. inline float packetErrorRatio() { return _lastComputedPacketErrorRatio; }
  491. /**
  492. * Record an invalid incoming packet. This packet failed MAC/compression/cipher checks and will now
  493. * contribute to a Packet Error Ratio (PER).
  494. */
  495. inline void recordInvalidPacket() { _packetValiditySamples.push(false); }
  496. /**
  497. * @return A pointer to a cached copy of the address string for this Path (For debugging only)
  498. */
  499. inline char *getAddressString() { return _addrString; }
  500. /**
  501. * @return The current throughput disturbance coefficient
  502. */
  503. inline float throughputDisturbanceCoefficient() { return _lastComputedThroughputDistCoeff; }
  504. /**
  505. * Compute and cache stability and performance metrics. The resultant stability coefficient is a measure of how "well behaved"
  506. * this path is. This figure is substantially different from (but required for the estimation of the path's overall "quality".
  507. *
  508. * @param now Current time
  509. */
  510. inline void processBackgroundPathMeasurements(const int64_t now)
  511. {
  512. if (now - _lastPathQualityComputeTime > ZT_PATH_QUALITY_COMPUTE_INTERVAL) {
  513. Mutex::Lock _l(_statistics_m);
  514. _lastPathQualityComputeTime = now;
  515. address().toString(_addrString);
  516. _lastComputedMeanLatency = _latencySamples.mean();
  517. _lastComputedPacketDelayVariance = _latencySamples.stddev(); // Similar to "jitter" (SEE: RFC 3393, RFC 4689)
  518. _lastComputedMeanThroughput = (uint64_t)_throughputSamples.mean();
  519. // If no packet validity samples, assume PER==0
  520. _lastComputedPacketErrorRatio = 1 - (_packetValiditySamples.count() ? _packetValiditySamples.mean() : 1);
  521. // Compute path stability
  522. // Normalize measurements with wildly different ranges into a reasonable range
  523. float normalized_pdv = Utils::normalize(_lastComputedPacketDelayVariance, 0, ZT_PATH_MAX_PDV, 0, 10);
  524. float normalized_la = Utils::normalize(_lastComputedMeanLatency, 0, ZT_PATH_MAX_MEAN_LATENCY, 0, 10);
  525. float throughput_cv = _throughputSamples.mean() > 0 ? _throughputSamples.stddev() / _throughputSamples.mean() : 1;
  526. // Form an exponential cutoff and apply contribution weights
  527. float pdv_contrib = expf((-1.0f)*normalized_pdv) * (float)ZT_PATH_CONTRIB_PDV;
  528. float latency_contrib = expf((-1.0f)*normalized_la) * (float)ZT_PATH_CONTRIB_LATENCY;
  529. // Throughput Disturbance Coefficient
  530. float throughput_disturbance_contrib = expf((-1.0f)*throughput_cv) * (float)ZT_PATH_CONTRIB_THROUGHPUT_DISTURBANCE;
  531. _throughputDisturbanceSamples.push(throughput_cv);
  532. _lastComputedThroughputDistCoeff = _throughputDisturbanceSamples.mean();
  533. // Obey user-defined ignored contributions
  534. pdv_contrib = ZT_PATH_CONTRIB_PDV > 0.0 ? pdv_contrib : 1;
  535. latency_contrib = ZT_PATH_CONTRIB_LATENCY > 0.0 ? latency_contrib : 1;
  536. throughput_disturbance_contrib = ZT_PATH_CONTRIB_THROUGHPUT_DISTURBANCE > 0.0 ? throughput_disturbance_contrib : 1;
  537. // Stability
  538. _lastComputedStability = pdv_contrib + latency_contrib + throughput_disturbance_contrib;
  539. _lastComputedStability *= 1 - _lastComputedPacketErrorRatio;
  540. // Prevent QoS records from sticking around for too long
  541. std::map<uint64_t,uint64_t>::iterator it = _outQoSRecords.begin();
  542. while (it != _outQoSRecords.end()) {
  543. // Time since egress of tracked packet
  544. if ((now - it->second) >= ZT_PATH_QOS_TIMEOUT) {
  545. _outQoSRecords.erase(it++);
  546. } else { it++; }
  547. }
  548. }
  549. }
  550. /**
  551. * @return True if this path is alive (receiving data)
  552. */
  553. inline bool alive(const int64_t now) const { return ((now - _lastIn) < ((ZT_PEER_PING_PERIOD * 2) + 5000)); }
  554. /**
  555. * @return Last time we sent something
  556. */
  557. inline int64_t lastOut() const { return _lastOut; }
  558. /**
  559. * @return Last time we received anything
  560. */
  561. inline int64_t lastIn() const { return _lastIn; }
  562. private:
  563. Mutex _statistics_m;
  564. volatile int64_t _lastOut;
  565. volatile int64_t _lastIn;
  566. volatile int64_t _lastPathQualityComputeTime;
  567. int64_t _localSocket;
  568. volatile unsigned int _latency;
  569. InetAddress _addr;
  570. InetAddress::IpScope _ipScope; // memoize this since it's a computed value checked often
  571. AtomicCounter __refCount;
  572. std::map<uint64_t,uint64_t> _outQoSRecords; // id:egress_time
  573. std::map<uint64_t,uint64_t> _inQoSRecords; // id:now
  574. std::map<uint64_t,uint16_t> _inACKRecords; // id:len
  575. int64_t _lastAck;
  576. int64_t _lastThroughputEstimation;
  577. int64_t _lastQoSMeasurement;
  578. int64_t _lastQoSRecordPurge;
  579. int64_t _unackedBytes;
  580. int64_t _expectingAckAsOf;
  581. int16_t _packetsReceivedSinceLastAck;
  582. int16_t _packetsReceivedSinceLastQoS;
  583. uint64_t _maxLifetimeThroughput;
  584. uint64_t _lastComputedMeanThroughput;
  585. uint64_t _bytesAckedSinceLastThroughputEstimation;
  586. float _lastComputedMeanLatency;
  587. float _lastComputedPacketDelayVariance;
  588. float _lastComputedPacketErrorRatio;
  589. float _lastComputedPacketLossRatio;
  590. // cached estimates
  591. float _lastComputedStability;
  592. float _lastComputedRelativeQuality;
  593. float _lastComputedThroughputDistCoeff;
  594. unsigned char _lastAllocation;
  595. // cached human-readable strings for tracing purposes
  596. char _ifname[16];
  597. char _addrString[256];
  598. RingBuffer<uint64_t,ZT_PATH_QUALITY_METRIC_WIN_SZ> _throughputSamples;
  599. RingBuffer<uint32_t,ZT_PATH_QUALITY_METRIC_WIN_SZ> _latencySamples;
  600. RingBuffer<bool,ZT_PATH_QUALITY_METRIC_WIN_SZ> _packetValiditySamples;
  601. RingBuffer<float,ZT_PATH_QUALITY_METRIC_WIN_SZ> _throughputDisturbanceSamples;
  602. };
  603. } // namespace ZeroTier
  604. #endif