summaryrefslogtreecommitdiff
path: root/node/Path.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'node/Path.hpp')
-rw-r--r--node/Path.hpp214
1 files changed, 82 insertions, 132 deletions
diff --git a/node/Path.hpp b/node/Path.hpp
index ca5dd98f..f8d84d4b 100644
--- a/node/Path.hpp
+++ b/node/Path.hpp
@@ -27,27 +27,8 @@
#include "Constants.hpp"
#include "InetAddress.hpp"
-
-// Note: if you change these flags check the logic below. Some of it depends
-// on these bits being what they are.
-
-/**
- * Flag indicating that this path is suboptimal
- *
- * Clusters set this flag on remote paths if GeoIP or other routing decisions
- * indicate that a peer should be handed off to another cluster member.
- */
-#define ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL 0x0001
-
-/**
- * Flag indicating that this path is optimal
- *
- * Peers set this flag on paths that are pushed by a cluster and indicated as
- * optimal. A second flag is needed since we want to prioritize cluster optimal
- * paths and de-prioritize sub-optimal paths and for new paths we don't know
- * which one they are. So we want a trinary state: optimal, suboptimal, unknown.
- */
-#define ZT_PATH_FLAG_CLUSTER_OPTIMAL 0x0002
+#include "SharedPtr.hpp"
+#include "AtomicCounter.hpp"
/**
* Maximum return value of preferenceRank()
@@ -59,34 +40,83 @@ namespace ZeroTier {
class RuntimeEnvironment;
/**
- * Base class for paths
- *
- * The base Path class is an immutable value.
+ * A path across the physical network
*/
class Path
{
+ friend class SharedPtr<Path>;
+
public:
+ /**
+ * Efficient unique key for paths in a Hashtable
+ */
+ class HashKey
+ {
+ public:
+ HashKey() {}
+
+ HashKey(const InetAddress &l,const InetAddress &r)
+ {
+ // This is an ad-hoc bit packing algorithm to yield unique keys for
+ // remote addresses and their local-side counterparts if defined.
+ // Portability across runtimes is not needed.
+ if (r.ss_family == AF_INET) {
+ _k[0] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&r)->sin_addr.s_addr;
+ _k[1] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&r)->sin_port;
+ if (l.ss_family == AF_INET) {
+ _k[2] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&l)->sin_addr.s_addr;
+ _k[3] = (uint64_t)reinterpret_cast<const struct sockaddr_in *>(&r)->sin_port;
+ } else {
+ _k[2] = 0;
+ _k[3] = 0;
+ }
+ } else if (r.ss_family == AF_INET6) {
+ const uint8_t *a = reinterpret_cast<const uint8_t *>(reinterpret_cast<const struct sockaddr_in6 *>(&r)->sin6_addr.s6_addr);
+ uint8_t *b = reinterpret_cast<uint8_t *>(_k);
+ for(unsigned int i=0;i<16;++i) b[i] = a[i];
+ _k[2] = ~((uint64_t)reinterpret_cast<const struct sockaddr_in6 *>(&r)->sin6_port);
+ if (l.ss_family == AF_INET6) {
+ _k[2] ^= ((uint64_t)reinterpret_cast<const struct sockaddr_in6 *>(&r)->sin6_port) << 32;
+ a = reinterpret_cast<const uint8_t *>(reinterpret_cast<const struct sockaddr_in6 *>(&l)->sin6_addr.s6_addr);
+ b += 24;
+ for(unsigned int i=0;i<8;++i) b[i] = a[i];
+ a += 8;
+ for(unsigned int i=0;i<8;++i) b[i] ^= a[i];
+ }
+ } else {
+ _k[0] = 0;
+ _k[1] = 0;
+ _k[2] = 0;
+ _k[3] = 0;
+ }
+ }
+
+ inline unsigned long hashCode() const { return (unsigned long)(_k[0] + _k[1] + _k[2] + _k[3]); }
+
+ inline bool operator==(const HashKey &k) const { return ( (_k[0] == k._k[0]) && (_k[1] == k._k[1]) && (_k[2] == k._k[2]) && (_k[3] == k._k[3]) ); }
+ inline bool operator!=(const HashKey &k) const { return (!(*this == k)); }
+
+ private:
+ uint64_t _k[4];
+ };
+
Path() :
- _lastSend(0),
- _lastPing(0),
- _lastKeepalive(0),
- _lastReceived(0),
+ _lastOut(0),
+ _lastIn(0),
_addr(),
_localAddress(),
- _flags(0),
- _ipScope(InetAddress::IP_SCOPE_NONE)
+ _ipScope(InetAddress::IP_SCOPE_NONE),
+ _clusterSuboptimal(false)
{
}
Path(const InetAddress &localAddress,const InetAddress &addr) :
- _lastSend(0),
- _lastPing(0),
- _lastKeepalive(0),
- _lastReceived(0),
+ _lastOut(0),
+ _lastIn(0),
_addr(addr),
_localAddress(localAddress),
- _flags(0),
- _ipScope(addr.ipScope())
+ _ipScope(addr.ipScope()),
+ _clusterSuboptimal(false)
{
}
@@ -104,44 +134,17 @@ public:
*
* @param t Time of send
*/
- inline void sent(uint64_t t) { _lastSend = t; }
-
- /**
- * Called when we've sent a ping or echo
- *
- * @param t Time of send
- */
- inline void pinged(uint64_t t) { _lastPing = t; }
+ inline void sent(const uint64_t t) { _lastOut = t; }
/**
- * Called when we send a NAT keepalive
- *
- * @param t Time of send
- */
- inline void sentKeepalive(uint64_t t) { _lastKeepalive = t; }
-
- /**
- * Called when a packet is received from this remote path
+ * Called when a packet is received from this remote path, regardless of content
*
* @param t Time of receive
*/
- inline void received(uint64_t t)
- {
- _lastReceived = t;
- _probation = 0;
- }
+ inline void received(const uint64_t t) { _lastIn = t; }
/**
- * @param now Current time
- * @return True if this path appears active
- */
- inline bool active(uint64_t now) const
- {
- return ( ((now - _lastReceived) < ZT_PATH_ACTIVITY_TIMEOUT) && (_probation < ZT_PEER_DEAD_PATH_DETECTION_MAX_PROBATION) );
- }
-
- /**
- * Send a packet via this path
+ * Send a packet via this path (last out time is also updated)
*
* @param RR Runtime environment
* @param data Packet data
@@ -157,26 +160,6 @@ public:
inline const InetAddress &localAddress() const throw() { return _localAddress; }
/**
- * @return Time of last send to this path
- */
- inline uint64_t lastSend() const throw() { return _lastSend; }
-
- /**
- * @return Time we last pinged or dead path checked this link
- */
- inline uint64_t lastPing() const throw() { return _lastPing; }
-
- /**
- * @return Time of last keepalive
- */
- inline uint64_t lastKeepalive() const throw() { return _lastKeepalive; }
-
- /**
- * @return Time of last receive from this path
- */
- inline uint64_t lastReceived() const throw() { return _lastReceived; }
-
- /**
* @return Physical address
*/
inline const InetAddress &address() const throw() { return _addr; }
@@ -187,26 +170,19 @@ public:
inline InetAddress::IpScope ipScope() const throw() { return _ipScope; }
/**
- * @param f Valuve of ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL and inverse of ZT_PATH_FLAG_CLUSTER_OPTIMAL (both are changed)
+ * @param f Is this path cluster-suboptimal?
*/
- inline void setClusterSuboptimal(bool f)
- {
- if (f) {
- _flags = (_flags | ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL) & ~ZT_PATH_FLAG_CLUSTER_OPTIMAL;
- } else {
- _flags = (_flags | ZT_PATH_FLAG_CLUSTER_OPTIMAL) & ~ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL;
- }
- }
+ inline void setClusterSuboptimal(const bool f) { _clusterSuboptimal = f; }
/**
- * @return True if ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL is set
+ * @return True if cluster-suboptimal (for someone)
*/
- inline bool isClusterSuboptimal() const { return ((_flags & ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL) != 0); }
+ inline bool isClusterSuboptimal() const { return _clusterSuboptimal; }
/**
- * @return True if ZT_PATH_FLAG_CLUSTER_OPTIMAL is set
+ * @return True if cluster-optimal (for someone) (the default)
*/
- inline bool isClusterOptimal() const { return ((_flags & ZT_PATH_FLAG_CLUSTER_OPTIMAL) != 0); }
+ inline bool isClusterOptimal() const { return (!(_clusterSuboptimal)); }
/**
* @return Preference rank, higher == better (will be less than 255)
@@ -230,29 +206,18 @@ public:
// This is a little bit convoluted because we try to be branch-free, using multiplication instead of branches for boolean flags
// Start with the last time this path was active, and add a fudge factor to prevent integer underflow if _lastReceived is 0
- uint64_t score = _lastReceived + (ZT_PEER_DIRECT_PING_DELAY * (ZT_PEER_DEAD_PATH_DETECTION_MAX_PROBATION + 1));
+ uint64_t score = _lastIn + (ZT_PEER_DIRECT_PING_DELAY * (ZT_PEER_DEAD_PATH_DETECTION_MAX_PROBATION + 1));
// Increase score based on path preference rank, which is based on IP scope and address family
score += preferenceRank() * (ZT_PEER_DIRECT_PING_DELAY / ZT_PATH_MAX_PREFERENCE_RANK);
- // Increase score if this is known to be an optimal path to a cluster
- score += (uint64_t)(_flags & ZT_PATH_FLAG_CLUSTER_OPTIMAL) * (ZT_PEER_DIRECT_PING_DELAY / 2); // /2 because CLUSTER_OPTIMAL is flag 0x0002
-
// Decrease score if this is known to be a sub-optimal path to a cluster
- score -= (uint64_t)(_flags & ZT_PATH_FLAG_CLUSTER_SUBOPTIMAL) * ZT_PEER_DIRECT_PING_DELAY;
-
- // Penalize for missed ECHO tests in dead path detection
- score -= (uint64_t)((ZT_PEER_DIRECT_PING_DELAY / 2) * _probation);
+ score -= ((uint64_t)_clusterSuboptimal) * ZT_PEER_DIRECT_PING_DELAY;
return score;
}
/**
- * @return True if address is non-NULL
- */
- inline operator bool() const throw() { return (_addr); }
-
- /**
* Check whether this address is valid for a ZeroTier path
*
* This checks the address type and scope against address types and scopes
@@ -293,29 +258,14 @@ public:
return false;
}
- /**
- * @return Current path probation count (for dead path detect)
- */
- inline unsigned int probation() const { return _probation; }
-
- /**
- * Increase this path's probation violation count (for dead path detect)
- */
- inline void increaseProbation() { ++_probation; }
-
- inline bool operator==(const Path &p) const { return ((p._addr == _addr)&&(p._localAddress == _localAddress)); }
- inline bool operator!=(const Path &p) const { return ((p._addr != _addr)||(p._localAddress != _localAddress)); }
-
private:
- uint64_t _lastSend;
- uint64_t _lastPing;
- uint64_t _lastKeepalive;
- uint64_t _lastReceived;
+ uint64_t _lastOut;
+ uint64_t _lastIn;
InetAddress _addr;
InetAddress _localAddress;
- unsigned int _flags;
- unsigned int _probation;
InetAddress::IpScope _ipScope; // memoize this since it's a computed value checked often
+ AtomicCounter __refCount;
+ bool _clusterSuboptimal;
};
} // namespace ZeroTier