ZeroTierOne/node/Path.hpp

/*
 * Copyright (c)2013-2020 ZeroTier, Inc.
 *
 * Use of this software is governed by the Business Source License included
 * in the LICENSE.TXT file in the project's root directory.
 *
 * Change Date: 2026-01-01
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by version 2.0 of the Apache License.
 */
/****/

#ifndef ZT_PATH_HPP
#define ZT_PATH_HPP

#include "AtomicCounter.hpp"
#include "Constants.hpp"
#include "InetAddress.hpp"
#include "Packet.hpp"
#include "RingBuffer.hpp"
#include "SharedPtr.hpp"
#include "Utils.hpp"

#include <algorithm>
#include <stdexcept>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>

/**
 * Maximum return value of preferenceRank()
 */
#define ZT_PATH_MAX_PREFERENCE_RANK ((ZT_INETADDRESS_MAX_SCOPE << 1) | 1)

namespace ZeroTier {

class RuntimeEnvironment;

/**
 * A path across the physical network
 */
class Path {
	friend class SharedPtr<Path>;
	friend class Bond;

  public:
	/**
	 * Efficient unique key for paths in a Hashtable
	 */
	class HashKey {
	  public:
		HashKey()
		{
		}

		HashKey(const int64_t l, const InetAddress& r)
		{
			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;
				_k[2] = (uint64_t)l;
			}
			else if (r.ss_family == AF_INET6) {
				memcpy(_k, reinterpret_cast<const struct sockaddr_in6*>(&r)->sin6_addr.s6_addr, 16);
				_k[2] = ((uint64_t)reinterpret_cast<const struct sockaddr_in6*>(&r)->sin6_port << 32) ^ (uint64_t)l;
			}
			else {
				memcpy(_k, &r, std::min(sizeof(_k), sizeof(InetAddress)));
				_k[2] += (uint64_t)l;
			}
		}

		inline unsigned long hashCode() const
		{
			return (unsigned long)(_k[0] + _k[1] + _k[2]);
		}

		inline bool operator==(const HashKey& k) const
		{
			return ((_k[0] == k._k[0]) && (_k[1] == k._k[1]) && (_k[2] == k._k[2]));
		}
		inline bool operator!=(const HashKey& k) const
		{
			return (! (*this == k));
		}

	  private:
		uint64_t _k[3];
	};

	Path()
		: _lastOut(0)
		, _lastIn(0)
		, _lastTrustEstablishedPacketReceived(0)
		, _lastEchoRequestReceived(0)
		, _localPort(0)
		, _localSocket(-1)
		, _latencyMean(0.0)
		, _latencyVariance(0.0)
		, _packetLossRatio(0.0)
		, _packetErrorRatio(0.0)
		, _assignedFlowCount(0)
		, _valid(true)
		, _eligible(false)
		, _bonded(false)
		, _mtu(0)
		, _givenLinkSpeed(0)
		, _relativeQuality(0)
		, _latency(0xffff)
		, _addr()
		, _ipScope(InetAddress::IP_SCOPE_NONE)
	{
	}

	Path(const int64_t localSocket, const InetAddress& addr)
		: _lastOut(0)
		, _lastIn(0)
		, _lastTrustEstablishedPacketReceived(0)
		, _lastEchoRequestReceived(0)
		, _localPort(0)
		, _localSocket(localSocket)
		, _latencyMean(0.0)
		, _latencyVariance(0.0)
		, _packetLossRatio(0.0)
		, _packetErrorRatio(0.0)
		, _assignedFlowCount(0)
		, _valid(true)
		, _eligible(false)
		, _bonded(false)
		, _mtu(0)
		, _givenLinkSpeed(0)
		, _relativeQuality(0)
		, _latency(0xffff)
		, _addr(addr)
		, _ipScope(addr.ipScope())
	{
	}

	/**
	 * Called when a packet is received from this remote path, regardless of content
	 *
	 * @param t Time of receive
	 */
	inline void received(const uint64_t t)
	{
		_lastIn = t;
	}

	/**
	 * Set time last trusted packet was received (done in Peer::received())
	 */
	inline void trustedPacketReceived(const uint64_t t)
	{
		_lastTrustEstablishedPacketReceived = t;
	}

	/**
	 * Send a packet via this path (last out time is also updated)
	 *
	 * @param RR Runtime environment
	 * @param tPtr Thread pointer to be handed through to any callbacks called as a result of this call
	 * @param data Packet data
	 * @param len Packet length
	 * @param now Current time
	 * @return True if transport reported success
	 */
	bool send(const RuntimeEnvironment* RR, void* tPtr, const void* data, unsigned int len, int64_t now);

	/**
	 * Manually update last sent time
	 *
	 * @param t Time of send
	 */
	inline void sent(const int64_t t)
	{
		_lastOut = t;
	}

	/**
	 * Update path latency with a new measurement
	 *
	 * @param l Measured latency
	 */
	inline void updateLatency(const unsigned int l, int64_t now)
	{
		unsigned int pl = _latency;
		if (pl < 0xffff) {
			_latency = (pl + l) / 2;
		}
		else {
			_latency = l;
		}
	}

	/**
	 * @return Local socket as specified by external code
	 */
	inline int64_t localSocket() const
	{
		return _localSocket;
	}

	/**
	 * @return Local port corresponding to the localSocket
	 */
	inline int64_t localPort() const
	{
		return _localPort;
	}

	/**
	 * @return Physical address
	 */
	inline const InetAddress& address() const
	{
		return _addr;
	}

	/**
	 * @return IP scope -- faster shortcut for address().ipScope()
	 */
	inline InetAddress::IpScope ipScope() const
	{
		return _ipScope;
	}

	/**
	 * @return True if path has received a trust established packet (e.g. common network membership) in the past ZT_TRUST_EXPIRATION ms
	 */
	inline bool trustEstablished(const int64_t now) const
	{
		return ((now - _lastTrustEstablishedPacketReceived) < ZT_TRUST_EXPIRATION);
	}

	/**
	 * @return Preference rank, higher == better
	 */
	inline unsigned int preferenceRank() const
	{
		// This causes us to rank paths in order of IP scope rank (see InetAddress.hpp) but
		// within each IP scope class to prefer IPv6 over IPv4.
		return (((unsigned int)_ipScope << 1) | (unsigned int)(_addr.ss_family == AF_INET6));
	}

	/**
	 * Check whether this address is valid for a ZeroTier path
	 *
	 * This checks the address type and scope against address types and scopes
	 * that we currently support for ZeroTier communication.
	 *
	 * @param a Address to check
	 * @return True if address is good for ZeroTier path use
	 */
	static inline bool isAddressValidForPath(const InetAddress& a)
	{
		if ((a.ss_family == AF_INET) || (a.ss_family == AF_INET6)) {
			switch (a.ipScope()) {
				/* Note: we don't do link-local at the moment. Unfortunately these
				 * cause several issues. The first is that they usually require a
				 * device qualifier, which we don't handle yet and can't portably
				 * push in PUSH_DIRECT_PATHS. The second is that some OSes assign
				 * these very ephemerally or otherwise strangely. So we'll use
				 * private, pseudo-private, shared (e.g. carrier grade NAT), or
				 * global IP addresses. */
				case InetAddress::IP_SCOPE_PRIVATE:
				case InetAddress::IP_SCOPE_PSEUDOPRIVATE:
				case InetAddress::IP_SCOPE_SHARED:
				case InetAddress::IP_SCOPE_GLOBAL:
					if (a.ss_family == AF_INET6) {
						// TEMPORARY HACK: for now, we are going to blacklist he.net IPv6
						// tunnels due to very spotty performance and low MTU issues over
						// these IPv6 tunnel links.
						const uint8_t* ipd = reinterpret_cast<const uint8_t*>(reinterpret_cast<const struct sockaddr_in6*>(&a)->sin6_addr.s6_addr);
						if ((ipd[0] == 0x20) && (ipd[1] == 0x01) && (ipd[2] == 0x04) && (ipd[3] == 0x70)) {
							return false;
						}
					}
					return true;
				default:
					return false;
			}
		}
		return false;
	}

	/**
	 * @return Latency or 0xffff if unknown
	 */
	inline unsigned int latency() const
	{
		return _latency;
	}

	/**
	 * @return Path quality -- lower is better
	 */
	inline long quality(const int64_t now) const
	{
		const int l = (long)_latency;
		const int age = (long)std::min((now - _lastIn), (int64_t)(ZT_PATH_HEARTBEAT_PERIOD * 10));	 // set an upper sanity limit to avoid overflow
		return (((age < (ZT_PATH_HEARTBEAT_PERIOD + 5000)) ? l : (l + 0xffff + age)) * (long)((ZT_INETADDRESS_MAX_SCOPE - _ipScope) + 1));
	}

	/**
	 * @return True if this path is alive (receiving heartbeats)
	 */
	inline bool alive(const int64_t now) const
	{
		return (now - _lastIn) < (ZT_PATH_HEARTBEAT_PERIOD + 5000);
	}

	/**
	 * @return True if this path needs a heartbeat
	 */
	inline bool needsHeartbeat(const int64_t now) const
	{
		return ((now - _lastOut) >= ZT_PATH_HEARTBEAT_PERIOD);
	}

	/**
	 * @return Last time we sent something
	 */
	inline int64_t lastOut() const
	{
		return _lastOut;
	}

	/**
	 * @return Last time we received anything
	 */
	inline int64_t lastIn() const
	{
		return _lastIn;
	}

	/**
	 * @return the age of the path in terms of receiving packets
	 */
	inline int64_t age(int64_t now)
	{
		return (now - _lastIn);
	}

	/**
	 * @return Time last trust-established packet was received
	 */
	inline int64_t lastTrustEstablishedPacketReceived() const
	{
		return _lastTrustEstablishedPacketReceived;
	}

	/**
	 * Rate limit gate for inbound ECHO requests
	 */
	inline bool rateGateEchoRequest(const int64_t now)
	{
		if ((now - _lastEchoRequestReceived) >= (ZT_PEER_GENERAL_RATE_LIMIT / 6)) {
			_lastEchoRequestReceived = now;
			return true;
		}
		return false;
	}

	/**
	 * @return Mean latency as reported by the bonding layer
	 */
	inline float latencyMean() const
	{
		return _latencyMean;
	}

	/**
	 * @return Latency variance as reported by the bonding layer
	 */
	inline float latencyVariance() const
	{
		return _latencyVariance;
	}

	/**
	 * @return Packet Loss Ratio as reported by the bonding layer
	 */
	inline float packetLossRatio() const
	{
		return _packetLossRatio;
	}

	/**
	 * @return Packet Error Ratio as reported by the bonding layer
	 */
	inline float packetErrorRatio() const
	{
		return _packetErrorRatio;
	}

	/**
	 * @return Number of flows assigned to this path
	 */
	inline unsigned int assignedFlowCount() const
	{
		return _assignedFlowCount;
	}

	/**
	 * @return Whether this path is valid as reported by the bonding layer. The bonding layer
	 * actually checks with Phy to see if the interface is still up
	 */
	inline bool valid() const
	{
		return _valid;
	}

	/**
	 * @return Whether this path is eligible for use in a bond as reported by the bonding layer
	 */
	inline bool eligible() const
	{
		return _eligible;
	}

	/**
	 * @return Whether this path is bonded as reported by the bonding layer
	 */
	inline bool bonded() const
	{
		return _bonded;
	}

	/**
	 * @return Whether the user-specified MTU for this path (determined by MTU for parent link)
	 */
	inline uint16_t mtu() const
	{
		return _mtu;
	}

	/**
	 * @return Given link capacity as reported by the bonding layer
	 */
	inline uint32_t givenLinkSpeed() const
	{
		return _givenLinkSpeed;
	}

	/**
	 * @return Path's quality as reported by the bonding layer
	 */
	inline float relativeQuality() const
	{
		return _relativeQuality;
	}

	/**
	 * @return Physical interface name that this path lives on
	 */
	char* ifname()
	{
		return _ifname;
	}

  private:
	char _ifname[ZT_MAX_PHYSIFNAME] = {};

	volatile int64_t _lastOut;
	volatile int64_t _lastIn;
	volatile int64_t _lastTrustEstablishedPacketReceived;

	int64_t _lastEchoRequestReceived;

	uint16_t _localPort;
	int64_t _localSocket;

	volatile float _latencyMean;
	volatile float _latencyVariance;
	volatile float _packetLossRatio;
	volatile float _packetErrorRatio;
	volatile uint16_t _assignedFlowCount;
	volatile bool _valid;
	volatile bool _eligible;
	volatile bool _bonded;
	volatile uint16_t _mtu;
	volatile uint32_t _givenLinkSpeed;
	volatile float _relativeQuality;

	volatile unsigned int _latency;
	InetAddress _addr;
	InetAddress::IpScope _ipScope;	 // memoize this since it's a computed value checked often
	AtomicCounter __refCount;
};

}	// namespace ZeroTier

#endif