2020-05-12 08:35:48 +00:00
/*
2021-09-02 04:37:49 +00:00
* Copyright ( c ) 2013 - 2021 ZeroTier , Inc .
2020-05-12 08:35:48 +00:00
*
* Use of this software is governed by the Business Source License included
* in the LICENSE . TXT file in the project ' s root directory .
*
2021-09-02 04:37:49 +00:00
* Change Date : 2026 - 01 - 01
2020-05-12 08:35:48 +00:00
*
* 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 .
*/
/****/
2021-05-04 00:59:31 +00:00
# include "Bond.hpp"
2020-05-12 08:35:48 +00:00
# include "Switch.hpp"
2021-05-04 00:59:31 +00:00
# include <cmath>
2021-09-02 04:37:49 +00:00
# include <string>
2021-12-15 05:13:19 +00:00
# include <cstdio>
2020-05-12 08:35:48 +00:00
namespace ZeroTier {
2021-09-02 04:37:49 +00:00
static unsigned char s_freeRandomByteCounter = 0 ;
int Bond : : _minReqMonitorInterval = ZT_BOND_FAILOVER_DEFAULT_INTERVAL ;
uint8_t Bond : : _defaultPolicy = ZT_BOND_POLICY_NONE ;
Phy < Bond * > * Bond : : _phy ;
Mutex Bond : : _bonds_m ;
Mutex Bond : : _links_m ;
std : : string Bond : : _defaultPolicyStr ;
std : : map < int64_t , SharedPtr < Bond > > Bond : : _bonds ;
std : : map < int64_t , std : : string > Bond : : _policyTemplateAssignments ;
std : : map < std : : string , SharedPtr < Bond > > Bond : : _bondPolicyTemplates ;
std : : map < std : : string , std : : vector < SharedPtr < Link > > > Bond : : _linkDefinitions ;
std : : map < std : : string , std : : map < std : : string , SharedPtr < Link > > > Bond : : _interfaceToLinkMap ;
bool Bond : : linkAllowed ( std : : string & policyAlias , SharedPtr < Link > link )
{
bool foundInDefinitions = false ;
if ( _linkDefinitions . count ( policyAlias ) ) {
auto it = _linkDefinitions [ policyAlias ] . begin ( ) ;
while ( it ! = _linkDefinitions [ policyAlias ] . end ( ) ) {
if ( link - > ifname ( ) = = ( * it ) - > ifname ( ) ) {
foundInDefinitions = true ;
break ;
}
+ + it ;
}
}
return _linkDefinitions [ policyAlias ] . empty ( ) | | foundInDefinitions ;
}
void Bond : : addCustomLink ( std : : string & policyAlias , SharedPtr < Link > link )
{
Mutex : : Lock _l ( _links_m ) ;
_linkDefinitions [ policyAlias ] . push_back ( link ) ;
auto search = _interfaceToLinkMap [ policyAlias ] . find ( link - > ifname ( ) ) ;
if ( search = = _interfaceToLinkMap [ policyAlias ] . end ( ) ) {
link - > setAsUserSpecified ( true ) ;
_interfaceToLinkMap [ policyAlias ] . insert ( std : : pair < std : : string , SharedPtr < Link > > ( link - > ifname ( ) , link ) ) ;
}
}
bool Bond : : addCustomPolicy ( const SharedPtr < Bond > & newBond )
{
Mutex : : Lock _l ( _bonds_m ) ;
if ( ! _bondPolicyTemplates . count ( newBond - > policyAlias ( ) ) ) {
_bondPolicyTemplates [ newBond - > policyAlias ( ) ] = newBond ;
return true ;
}
return false ;
}
bool Bond : : assignBondingPolicyToPeer ( int64_t identity , const std : : string & policyAlias )
{
Mutex : : Lock _l ( _bonds_m ) ;
if ( ! _policyTemplateAssignments . count ( identity ) ) {
_policyTemplateAssignments [ identity ] = policyAlias ;
return true ;
}
return false ;
}
SharedPtr < Bond > Bond : : getBondByPeerId ( int64_t identity )
{
Mutex : : Lock _l ( _bonds_m ) ;
return _bonds . count ( identity ) ? _bonds [ identity ] : SharedPtr < Bond > ( ) ;
}
SharedPtr < Bond > Bond : : createTransportTriggeredBond ( const RuntimeEnvironment * renv , const SharedPtr < Peer > & peer )
{
Mutex : : Lock _l ( _bonds_m ) ;
int64_t identity = peer - > identity ( ) . address ( ) . toInt ( ) ;
Bond * bond = nullptr ;
if ( ! _bonds . count ( identity ) ) {
if ( ! _policyTemplateAssignments . count ( identity ) ) {
if ( _defaultPolicy ) {
bond = new Bond ( renv , _defaultPolicy , peer ) ;
bond - > log ( " new default bond " ) ;
}
if ( ! _defaultPolicy & & _defaultPolicyStr . length ( ) ) {
bond = new Bond ( renv , _bondPolicyTemplates [ _defaultPolicyStr ] . ptr ( ) , peer ) ;
2021-12-15 05:13:19 +00:00
bond - > log ( " new default custom bond (based on %s) " , bond - > getPolicyStrByCode ( bond - > policy ( ) ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
}
}
else {
if ( ! _bondPolicyTemplates [ _policyTemplateAssignments [ identity ] ] ) {
bond = new Bond ( renv , _defaultPolicy , peer ) ;
bond - > log ( " peer-specific bond, was specified as %s but the bond definition was not found, using default %s " , _policyTemplateAssignments [ identity ] . c_str ( ) , getPolicyStrByCode ( _defaultPolicy ) . c_str ( ) ) ;
}
else {
bond = new Bond ( renv , _bondPolicyTemplates [ _policyTemplateAssignments [ identity ] ] . ptr ( ) , peer ) ;
bond - > log ( " new default bond " ) ;
}
}
}
if ( bond ) {
_bonds [ identity ] = bond ;
/**
* Determine if user has specified anything that could affect the bonding policy ' s decisions
*/
if ( _interfaceToLinkMap . count ( bond - > policyAlias ( ) ) ) {
std : : map < std : : string , SharedPtr < Link > > : : iterator it = _interfaceToLinkMap [ bond - > policyAlias ( ) ] . begin ( ) ;
while ( it ! = _interfaceToLinkMap [ bond - > policyAlias ( ) ] . end ( ) ) {
if ( it - > second - > isUserSpecified ( ) ) {
bond - > _userHasSpecifiedLinks = true ;
}
if ( it - > second - > isUserSpecified ( ) & & it - > second - > primary ( ) ) {
bond - > _userHasSpecifiedPrimaryLink = true ;
}
if ( it - > second - > isUserSpecified ( ) & & it - > second - > userHasSpecifiedFailoverInstructions ( ) ) {
bond - > _userHasSpecifiedFailoverInstructions = true ;
}
if ( it - > second - > isUserSpecified ( ) & & ( it - > second - > speed ( ) > 0 ) ) {
bond - > _userHasSpecifiedLinkSpeeds = true ;
}
+ + it ;
}
}
return bond ;
}
return SharedPtr < Bond > ( ) ;
}
SharedPtr < Link > Bond : : getLinkBySocket ( const std : : string & policyAlias , uint64_t localSocket )
{
Mutex : : Lock _l ( _links_m ) ;
2021-12-15 05:13:19 +00:00
char ifname [ 64 ] = { 0 } ;
2021-09-02 04:37:49 +00:00
_phy - > getIfName ( ( PhySocket * ) ( ( uintptr_t ) localSocket ) , ifname , sizeof ( ifname ) - 1 ) ;
std : : string ifnameStr ( ifname ) ;
auto search = _interfaceToLinkMap [ policyAlias ] . find ( ifnameStr ) ;
if ( search = = _interfaceToLinkMap [ policyAlias ] . end ( ) ) {
// If the link wasn't already known, add a new entry
SharedPtr < Link > s = new Link ( ifnameStr , 0 , 0 , true , ZT_BOND_SLAVE_MODE_SPARE , " " , 0.0 ) ;
_interfaceToLinkMap [ policyAlias ] . insert ( std : : pair < std : : string , SharedPtr < Link > > ( ifnameStr , s ) ) ;
return s ;
}
else {
return search - > second ;
}
}
SharedPtr < Link > Bond : : getLinkByName ( const std : : string & policyAlias , const std : : string & ifname )
{
Mutex : : Lock _l ( _links_m ) ;
auto search = _interfaceToLinkMap [ policyAlias ] . find ( ifname ) ;
if ( search ! = _interfaceToLinkMap [ policyAlias ] . end ( ) ) {
return search - > second ;
}
return SharedPtr < Link > ( ) ;
}
void Bond : : processBackgroundTasks ( void * tPtr , const int64_t now )
{
unsigned long _currMinReqMonitorInterval = ZT_BOND_FAILOVER_DEFAULT_INTERVAL ;
Mutex : : Lock _l ( _bonds_m ) ;
std : : map < int64_t , SharedPtr < Bond > > : : iterator bondItr = _bonds . begin ( ) ;
while ( bondItr ! = _bonds . end ( ) ) {
// Update Bond Controller's background processing timer
_currMinReqMonitorInterval = std : : min ( _currMinReqMonitorInterval , ( unsigned long ) ( bondItr - > second - > monitorInterval ( ) ) ) ;
bondItr - > second - > processBackgroundBondTasks ( tPtr , now ) ;
+ + bondItr ;
}
_minReqMonitorInterval = std : : min ( _currMinReqMonitorInterval , ( unsigned long ) ZT_BOND_FAILOVER_DEFAULT_INTERVAL ) ;
}
Bond : : Bond ( const RuntimeEnvironment * renv ) : RR ( renv )
{
}
Bond : : Bond ( const RuntimeEnvironment * renv , int policy , const SharedPtr < Peer > & peer ) : RR ( renv ) , _freeRandomByte ( ( unsigned char ) ( ( uintptr_t ) this > > 4 ) ^ + + s_freeRandomByteCounter ) , _peer ( peer ) , _peerId ( _peer - > _id . address ( ) . toInt ( ) )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
setBondParameters ( policy , SharedPtr < Bond > ( ) , false ) ;
_policyAlias = getPolicyStrByCode ( policy ) ;
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
Bond : : Bond ( const RuntimeEnvironment * renv , std : : string & basePolicy , std : : string & policyAlias , const SharedPtr < Peer > & peer ) : RR ( renv ) , _policyAlias ( policyAlias ) , _peer ( peer )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
setBondParameters ( getPolicyCodeByStr ( basePolicy ) , SharedPtr < Bond > ( ) , false ) ;
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
Bond : : Bond ( const RuntimeEnvironment * renv , SharedPtr < Bond > originalBond , const SharedPtr < Peer > & peer )
: RR ( renv )
2021-09-02 04:37:49 +00:00
, _freeRandomByte ( ( unsigned char ) ( ( uintptr_t ) this > > 4 ) ^ + + s_freeRandomByteCounter )
2021-05-04 00:59:31 +00:00
, _peer ( peer )
2021-09-02 04:37:49 +00:00
, _peerId ( _peer - > _id . address ( ) . toInt ( ) )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
setBondParameters ( originalBond - > _policy , originalBond , true ) ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
void Bond : : nominatePathToBond ( const SharedPtr < Path > & path , int64_t now )
2020-05-12 08:35:48 +00:00
{
Mutex : : Lock _l ( _paths_m ) ;
2021-09-02 04:37:49 +00:00
/**
* Ensure the link is allowed and the path is not already present
*/
2021-05-04 00:59:31 +00:00
if ( ! RR - > bc - > linkAllowed ( _policyAlias , getLink ( path ) ) ) {
2020-05-12 08:35:48 +00:00
return ;
}
bool alreadyPresent = false ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
// Sanity check
if ( path . ptr ( ) = = _paths [ i ] . p . ptr ( ) ) {
2020-05-12 08:35:48 +00:00
alreadyPresent = true ;
break ;
}
}
2021-05-04 00:59:31 +00:00
if ( ! alreadyPresent ) {
2021-09-02 04:37:49 +00:00
/**
* Find somewhere to stick it
*/
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
_paths [ i ] . set ( now , path ) ;
/**
* Set user preferences and update state variables of other paths on the same link
*/
SharedPtr < Link > sl = getLink ( _paths [ i ] . p ) ;
if ( sl ) {
// Determine if there are any other paths on this link
bool bFoundCommonLink = false ;
SharedPtr < Link > commonLink = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
for ( unsigned int j = 0 ; j < ZT_MAX_PEER_NETWORK_PATHS ; + + j ) {
if ( _paths [ j ] . p & & _paths [ j ] . p . ptr ( ) ! = _paths [ i ] . p . ptr ( ) ) {
if ( RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ j ] . p - > localSocket ( ) ) = = commonLink ) {
bFoundCommonLink = true ;
_paths [ j ] . onlyPathOnLink = false ;
}
}
}
_paths [ i ] . ipvPref = sl - > ipvPref ( ) ;
_paths [ i ] . mode = sl - > mode ( ) ;
_paths [ i ] . enabled = sl - > enabled ( ) ;
_paths [ i ] . onlyPathOnLink = ! bFoundCommonLink ;
}
2021-12-15 05:13:19 +00:00
log ( " nominate link %s " , pathToStr ( path ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
break ;
}
}
}
curateBond ( now , true ) ;
estimatePathQuality ( now ) ;
}
2021-09-02 04:37:49 +00:00
void Bond : : addPathToBond ( int nominatedIdx , int bondedIdx )
{
// Map bonded set to nominated set
_bondIdxMap [ bondedIdx ] = nominatedIdx ;
// Tell the bonding layer that we can now use this bond for traffic
_paths [ nominatedIdx ] . bonded = true ;
}
2020-05-12 08:35:48 +00:00
SharedPtr < Path > Bond : : getAppropriatePath ( int64_t now , int32_t flowId )
{
Mutex : : Lock _l ( _paths_m ) ;
/**
* active - backup
*/
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_ACTIVE_BACKUP ) {
if ( _abPathIdx ! = ZT_MAX_PEER_NETWORK_PATHS & & _paths [ _abPathIdx ] . p ) {
return _paths [ _abPathIdx ] . p ;
2020-05-12 08:35:48 +00:00
}
}
/**
* broadcast
*/
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BROADCAST ) {
2021-05-04 00:59:31 +00:00
return SharedPtr < Path > ( ) ; // Handled in Switch::_trySend()
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
if ( ! _numBondedPaths ) {
return SharedPtr < Path > ( ) ; // No paths assigned to bond yet, cannot balance traffic
2020-05-12 08:35:48 +00:00
}
/**
* balance - rr
*/
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_RR ) {
2021-05-04 00:59:31 +00:00
if ( ! _allowFlowHashing ) {
2020-06-17 21:54:13 +00:00
if ( _packetsPerLink = = 0 ) {
2020-05-12 08:35:48 +00:00
// Randomly select a path
2021-09-02 04:37:49 +00:00
return _paths [ _bondIdxMap [ _freeRandomByte % _numBondedPaths ] ] . p ;
2020-05-12 08:35:48 +00:00
}
2020-06-17 21:54:13 +00:00
if ( _rrPacketsSentOnCurrLink < _packetsPerLink ) {
// Continue to use this link
+ + _rrPacketsSentOnCurrLink ;
2021-09-02 04:37:49 +00:00
return _paths [ _bondIdxMap [ _rrIdx ] ] . p ;
2020-05-12 08:35:48 +00:00
}
// Reset striping counter
2020-06-17 21:54:13 +00:00
_rrPacketsSentOnCurrLink = 0 ;
2021-09-08 04:41:54 +00:00
if ( _numBondedPaths = = 1 | | _rrIdx > = ( ZT_MAX_PEER_NETWORK_PATHS - 1 ) ) {
2020-05-12 08:35:48 +00:00
_rrIdx = 0 ;
}
else {
int _tempIdx = _rrIdx ;
2021-05-04 00:59:31 +00:00
for ( int searchCount = 0 ; searchCount < ( _numBondedPaths - 1 ) ; searchCount + + ) {
_tempIdx = ( _tempIdx = = ( _numBondedPaths - 1 ) ) ? 0 : _tempIdx + 1 ;
2021-09-02 04:37:49 +00:00
if ( _bondIdxMap [ _tempIdx ] ! = ZT_MAX_PEER_NETWORK_PATHS ) {
if ( _paths [ _bondIdxMap [ _tempIdx ] ] . p & & _paths [ _bondIdxMap [ _tempIdx ] ] . eligible ) {
2020-05-31 04:21:22 +00:00
_rrIdx = _tempIdx ;
break ;
}
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
if ( _paths [ _bondIdxMap [ _rrIdx ] ] . p ) {
return _paths [ _bondIdxMap [ _rrIdx ] ] . p ;
2020-05-12 08:35:48 +00:00
}
}
}
/**
* balance - xor
*/
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_XOR | | _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) {
2021-05-04 00:59:31 +00:00
if ( ! _allowFlowHashing | | flowId = = - 1 ) {
2020-05-12 08:35:48 +00:00
// No specific path required for unclassified traffic, send on anything
2021-09-02 04:37:49 +00:00
int m_idx = _bondIdxMap [ _freeRandomByte % _numBondedPaths ] ;
return _paths [ m_idx ] . p ;
2020-05-12 08:35:48 +00:00
}
else if ( _allowFlowHashing ) {
Mutex : : Lock _l ( _flows_m ) ;
SharedPtr < Flow > flow ;
if ( _flows . count ( flowId ) ) {
flow = _flows [ flowId ] ;
2021-09-02 04:37:49 +00:00
flow - > lastActivity = now ;
2020-05-12 08:35:48 +00:00
}
else {
unsigned char entropy ;
Utils : : getSecureRandom ( & entropy , 1 ) ;
2021-09-02 04:37:49 +00:00
flow = createFlow ( ZT_MAX_PEER_NETWORK_PATHS , flowId , entropy , now ) ;
2020-05-12 08:35:48 +00:00
}
if ( flow ) {
2021-09-02 04:37:49 +00:00
return _paths [ flow - > assignedPath ] . p ;
2020-05-12 08:35:48 +00:00
}
}
}
return SharedPtr < Path > ( ) ;
}
void Bond : : recordIncomingInvalidPacket ( const SharedPtr < Path > & path )
{
Mutex : : Lock _l ( _paths_m ) ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p = = path ) {
_paths [ i ] . packetValiditySamples . push ( false ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : recordOutgoingPacket ( const SharedPtr < Path > & path , uint64_t packetId , uint16_t payloadLength , const Packet : : Verb verb , const int32_t flowId , int64_t now )
2020-05-12 08:35:48 +00:00
{
2021-05-04 00:59:31 +00:00
_freeRandomByte + = ( unsigned char ) ( packetId > > 8 ) ; // Grab entropy to use in path selection logic
2021-09-02 04:37:49 +00:00
bool isFrame = ( verb = = Packet : : Packet : : VERB_ECHO | | verb = = Packet : : VERB_FRAME | | verb = = Packet : : VERB_EXT_FRAME ) ;
2021-05-04 00:59:31 +00:00
bool shouldRecord = ( packetId & ( ZT_QOS_ACK_DIVISOR - 1 ) & & ( verb ! = Packet : : VERB_ACK ) & & ( verb ! = Packet : : VERB_QOS_MEASUREMENT ) ) ;
2020-05-12 08:35:48 +00:00
if ( isFrame | | shouldRecord ) {
Mutex : : Lock _l ( _paths_m ) ;
2021-09-02 04:37:49 +00:00
int pathIdx = getNominatedPathIdx ( path ) ;
if ( pathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
return ;
}
2020-05-12 08:35:48 +00:00
if ( isFrame ) {
2021-09-02 04:37:49 +00:00
+ + ( _paths [ pathIdx ] . packetsOut ) ;
2021-05-04 00:59:31 +00:00
_lastFrame = now ;
2020-05-12 08:35:48 +00:00
}
if ( shouldRecord ) {
2021-09-02 04:37:49 +00:00
//_paths[pathIdx].unackedBytes += payloadLength;
2020-05-12 08:35:48 +00:00
// Take note that we're expecting a VERB_ACK on this path as of a specific time
2021-09-02 04:37:49 +00:00
if ( _paths [ pathIdx ] . qosStatsOut . size ( ) < ZT_QOS_MAX_OUTSTANDING_RECORDS ) {
_paths [ pathIdx ] . qosStatsOut [ packetId ] = now ;
2020-05-12 08:35:48 +00:00
}
}
}
2020-10-15 01:40:20 +00:00
if ( _allowFlowHashing & & ( flowId ! = ZT_QOS_NO_FLOW ) ) {
Mutex : : Lock _l ( _flows_m ) ;
if ( _flows . count ( flowId ) ) {
2021-09-02 04:37:49 +00:00
_flows [ flowId ] - > bytesOut + = payloadLength ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-05-04 00:59:31 +00:00
void Bond : : recordIncomingPacket ( const SharedPtr < Path > & path , uint64_t packetId , uint16_t payloadLength , Packet : : Verb verb , int32_t flowId , int64_t now )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
bool isFrame = ( verb = = Packet : : Packet : : VERB_ECHO | | verb = = Packet : : VERB_FRAME | | verb = = Packet : : VERB_EXT_FRAME ) ;
2021-05-04 00:59:31 +00:00
bool shouldRecord = ( packetId & ( ZT_QOS_ACK_DIVISOR - 1 ) & & ( verb ! = Packet : : VERB_ACK ) & & ( verb ! = Packet : : VERB_QOS_MEASUREMENT ) ) ;
2021-09-02 04:37:49 +00:00
Mutex : : Lock _l ( _paths_m ) ;
int pathIdx = getNominatedPathIdx ( path ) ;
if ( pathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
return ;
}
// Take note of the time that this previously-dead path received a packet
if ( ! _paths [ pathIdx ] . alive ) {
_paths [ pathIdx ] . lastAliveToggle = now ;
}
2020-05-12 08:35:48 +00:00
if ( isFrame | | shouldRecord ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ pathIdx ] . allowed ( ) ) {
if ( isFrame ) {
+ + ( _paths [ pathIdx ] . packetsIn ) ;
_lastFrame = now ;
}
if ( shouldRecord ) {
_paths [ pathIdx ] . qosStatsIn [ packetId ] = now ;
+ + ( _paths [ pathIdx ] . packetsReceivedSinceLastQoS ) ;
_paths [ pathIdx ] . packetValiditySamples . push ( true ) ;
}
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
2020-05-12 08:35:48 +00:00
/**
* Learn new flows and pro - actively create entries for them in the bond so
2020-05-15 03:09:25 +00:00
* that the next time we send a packet out that is part of a flow we know
2020-05-12 08:35:48 +00:00
* which path to use .
*/
2021-09-02 04:37:49 +00:00
if ( ( flowId ! = ZT_QOS_NO_FLOW ) & & ( _policy = = ZT_BOND_POLICY_BALANCE_RR | | _policy = = ZT_BOND_POLICY_BALANCE_XOR | | _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) ) {
2020-05-12 08:35:48 +00:00
Mutex : : Lock _l ( _flows_m ) ;
SharedPtr < Flow > flow ;
2021-05-04 00:59:31 +00:00
if ( ! _flows . count ( flowId ) ) {
2021-09-02 04:37:49 +00:00
flow = createFlow ( pathIdx , flowId , 0 , now ) ;
2021-05-04 00:59:31 +00:00
}
else {
2020-05-12 08:35:48 +00:00
flow = _flows [ flowId ] ;
}
if ( flow ) {
2021-09-02 04:37:49 +00:00
flow - > bytesIn + = payloadLength ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-05-04 00:59:31 +00:00
void Bond : : receivedQoS ( const SharedPtr < Path > & path , int64_t now , int count , uint64_t * rx_id , uint16_t * rx_ts )
2020-05-12 08:35:48 +00:00
{
Mutex : : Lock _l ( _paths_m ) ;
2021-09-02 04:37:49 +00:00
int pathIdx = getNominatedPathIdx ( path ) ;
if ( pathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
return ;
}
2021-12-15 05:13:19 +00:00
// log("received QoS packet (sampling %d frames) via %s", count, pathToStr(path).c_str());
2020-05-12 08:35:48 +00:00
// Look up egress times and compute latency values for each record
2021-05-04 00:59:31 +00:00
std : : map < uint64_t , uint64_t > : : iterator it ;
for ( int j = 0 ; j < count ; j + + ) {
2021-09-02 04:37:49 +00:00
it = _paths [ pathIdx ] . qosStatsOut . find ( rx_id [ j ] ) ;
if ( it ! = _paths [ pathIdx ] . qosStatsOut . end ( ) ) {
_paths [ pathIdx ] . latencySamples . push ( ( ( uint16_t ) ( now - it - > second ) - rx_ts [ j ] ) / 2 ) ;
_paths [ pathIdx ] . qosStatsOut . erase ( it ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
_paths [ pathIdx ] . qosRecordSize . push ( count ) ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
int32_t Bond : : generateQoSPacket ( int pathIdx , int64_t now , char * qosBuffer )
2020-05-12 08:35:48 +00:00
{
int32_t len = 0 ;
2021-09-02 04:37:49 +00:00
std : : map < uint64_t , uint64_t > : : iterator it = _paths [ pathIdx ] . qosStatsIn . begin ( ) ;
2021-05-04 00:59:31 +00:00
int i = 0 ;
2021-09-02 04:37:49 +00:00
int numRecords = std : : min ( _paths [ pathIdx ] . packetsReceivedSinceLastQoS , ZT_QOS_TABLE_SIZE ) ;
while ( i < numRecords & & it ! = _paths [ pathIdx ] . qosStatsIn . end ( ) ) {
2020-05-12 08:35:48 +00:00
uint64_t id = it - > first ;
memcpy ( qosBuffer , & id , sizeof ( uint64_t ) ) ;
2021-05-04 00:59:31 +00:00
qosBuffer + = sizeof ( uint64_t ) ;
2020-05-12 08:35:48 +00:00
uint16_t holdingTime = ( uint16_t ) ( now - it - > second ) ;
memcpy ( qosBuffer , & holdingTime , sizeof ( uint16_t ) ) ;
2021-05-04 00:59:31 +00:00
qosBuffer + = sizeof ( uint16_t ) ;
len + = sizeof ( uint64_t ) + sizeof ( uint16_t ) ;
2021-09-02 04:37:49 +00:00
_paths [ pathIdx ] . qosStatsIn . erase ( it + + ) ;
2020-05-12 08:35:48 +00:00
+ + i ;
}
return len ;
}
2021-05-04 00:59:31 +00:00
bool Bond : : assignFlowToBondedPath ( SharedPtr < Flow > & flow , int64_t now )
2020-05-12 08:35:48 +00:00
{
unsigned int idx = ZT_MAX_PEER_NETWORK_PATHS ;
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_XOR ) {
idx = abs ( ( int ) ( flow - > id % ( _numBondedPaths ) ) ) ;
flow - > assignPath ( _bondIdxMap [ idx ] , now ) ;
+ + ( _paths [ _bondIdxMap [ idx ] ] . assignedFlowCount ) ;
}
if ( _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) {
2020-05-12 08:35:48 +00:00
unsigned char entropy ;
Utils : : getSecureRandom ( & entropy , 1 ) ;
if ( _totalBondUnderload ) {
entropy % = _totalBondUnderload ;
}
2021-05-04 00:59:31 +00:00
if ( ! _numBondedPaths ) {
2021-09-02 04:37:49 +00:00
log ( " unable to assign flow %x (bond has no links) \n " , flow - > id ) ;
2020-05-12 08:35:48 +00:00
return false ;
}
2020-06-02 05:58:58 +00:00
/* Since there may be scenarios where a path is removed before we can re-estimate
relative qualities ( and thus allocations ) we need to down - modulate the entropy
value that we use to randomly assign among the surviving paths , otherwise we risk
not being able to find a path to assign this flow to . */
int totalIncompleteAllocation = 0 ;
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . bonded ) {
totalIncompleteAllocation + = _paths [ i ] . allocation ;
2020-06-02 05:58:58 +00:00
}
}
entropy % = totalIncompleteAllocation ;
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . bonded ) {
uint8_t probabilitySegment = ( _totalBondUnderload > 0 ) ? _paths [ i ] . affinity : _paths [ i ] . allocation ;
2020-05-12 08:35:48 +00:00
if ( entropy < = probabilitySegment ) {
idx = i ;
break ;
}
entropy - = probabilitySegment ;
}
}
if ( idx < ZT_MAX_PEER_NETWORK_PATHS ) {
2021-09-02 04:37:49 +00:00
flow - > assignPath ( idx , now ) ;
+ + ( _paths [ idx ] . assignedFlowCount ) ;
2020-05-12 08:35:48 +00:00
}
else {
2021-09-02 04:37:49 +00:00
log ( " unable to assign out-flow %x (unknown reason) " , flow - > id ) ;
2020-05-12 08:35:48 +00:00
return false ;
}
}
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_ACTIVE_BACKUP ) {
if ( _abPathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
log ( " unable to assign out-flow %x (no active backup link) " , flow - > id ) ;
2020-11-23 17:59:28 +00:00
}
2021-09-02 04:37:49 +00:00
flow - > assignPath ( _abPathIdx , now ) ;
2020-11-23 17:59:28 +00:00
}
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ flow - > assignedPath ] . p - > localSocket ( ) ) ;
2021-12-15 05:13:19 +00:00
log ( " assign out-flow %04x to link %s (%lu / %lu flows) " , flow - > id , pathToStr ( _paths [ flow - > assignedPath ] . p ) . c_str ( ) , _paths [ flow - > assignedPath ] . assignedFlowCount , ( unsigned long ) _flows . size ( ) ) ;
2020-05-12 08:35:48 +00:00
return true ;
}
2021-09-02 04:37:49 +00:00
SharedPtr < Bond : : Flow > Bond : : createFlow ( int pathIdx , int32_t flowId , unsigned char entropy , int64_t now )
2020-05-12 08:35:48 +00:00
{
2021-05-04 00:59:31 +00:00
if ( ! _numBondedPaths ) {
2021-09-02 04:37:49 +00:00
log ( " unable to assign flow %x (bond has no links) \n " , flowId ) ;
2020-05-12 08:35:48 +00:00
return SharedPtr < Flow > ( ) ;
}
if ( _flows . size ( ) > = ZT_FLOW_MAX_COUNT ) {
2021-09-02 04:37:49 +00:00
log ( " forget oldest flow (max flows reached: %d) \n " , ZT_FLOW_MAX_COUNT ) ;
2020-08-07 01:10:40 +00:00
forgetFlowsWhenNecessary ( 0 , true , now ) ;
2020-05-12 08:35:48 +00:00
}
SharedPtr < Flow > flow = new Flow ( flowId , now ) ;
_flows [ flowId ] = flow ;
/**
* Add a flow with a given Path already provided . This is the case when a packet
* is received on a path but no flow exists , in this case we simply assign the path
* that the remote peer chose for us .
*/
2021-09-02 04:37:49 +00:00
if ( pathIdx ! = ZT_MAX_PEER_NETWORK_PATHS ) {
flow - > assignPath ( pathIdx , now ) ;
_paths [ pathIdx ] . assignedFlowCount + + ;
2021-12-15 05:13:19 +00:00
log ( " assign in-flow %x to link %s (%lu / %lu) " , flow - > id , pathToStr ( _paths [ pathIdx ] . p ) . c_str ( ) , _paths [ pathIdx ] . assignedFlowCount , ( unsigned long ) _flows . size ( ) ) ;
2020-05-12 08:35:48 +00:00
}
/**
* Add a flow when no path was provided . This means that it is an outgoing packet
* and that it is up to the local peer to decide how to load - balance its transmission .
*/
2021-09-02 04:37:49 +00:00
else {
2020-05-12 08:35:48 +00:00
assignFlowToBondedPath ( flow , now ) ;
}
return flow ;
}
void Bond : : forgetFlowsWhenNecessary ( uint64_t age , bool oldest , int64_t now )
{
2021-05-04 00:59:31 +00:00
std : : map < int32_t , SharedPtr < Flow > > : : iterator it = _flows . begin ( ) ;
std : : map < int32_t , SharedPtr < Flow > > : : iterator oldestFlow = _flows . end ( ) ;
2020-05-12 08:35:48 +00:00
SharedPtr < Flow > expiredFlow ;
2021-05-04 00:59:31 +00:00
if ( age ) { // Remove by specific age
2020-05-12 08:35:48 +00:00
while ( it ! = _flows . end ( ) ) {
if ( it - > second - > age ( now ) > age ) {
2021-09-02 04:37:49 +00:00
log ( " forget flow %x (age %llu) (%lu / %lu) " , it - > first , ( unsigned long long ) it - > second - > age ( now ) , _paths [ it - > second - > assignedPath ] . assignedFlowCount , ( unsigned long ) ( _flows . size ( ) - 1 ) ) ;
_paths [ it - > second - > assignedPath ] . assignedFlowCount - - ;
2020-05-12 08:35:48 +00:00
it = _flows . erase ( it ) ;
2021-05-04 00:59:31 +00:00
}
else {
2020-05-12 08:35:48 +00:00
+ + it ;
}
}
}
2021-05-04 00:59:31 +00:00
else if ( oldest ) { // Remove single oldest by natural expiration
2020-05-12 08:35:48 +00:00
uint64_t maxAge = 0 ;
while ( it ! = _flows . end ( ) ) {
if ( it - > second - > age ( now ) > maxAge ) {
maxAge = ( now - it - > second - > age ( now ) ) ;
oldestFlow = it ;
}
+ + it ;
}
if ( oldestFlow ! = _flows . end ( ) ) {
2021-09-02 04:37:49 +00:00
log ( " forget oldest flow %x (age %llu) (total flows: %lu) " , oldestFlow - > first , ( unsigned long long ) oldestFlow - > second - > age ( now ) , ( unsigned long ) ( _flows . size ( ) - 1 ) ) ;
_paths [ oldestFlow - > second - > assignedPath ] . assignedFlowCount - - ;
2020-05-12 08:35:48 +00:00
_flows . erase ( oldestFlow ) ;
}
}
}
2021-05-04 00:59:31 +00:00
void Bond : : processIncomingPathNegotiationRequest ( uint64_t now , SharedPtr < Path > & path , int16_t remoteUtility )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
char pathStr [ 64 ] = { 0 } ;
if ( _abLinkSelectMethod ! = ZT_BOND_RESELECTION_POLICY_OPTIMIZE ) {
2020-05-12 08:35:48 +00:00
return ;
}
Mutex : : Lock _l ( _paths_m ) ;
2021-09-02 04:37:49 +00:00
int pathIdx = getNominatedPathIdx ( path ) ;
if ( pathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
return ;
}
_paths [ pathIdx ] . p - > address ( ) . toString ( pathStr ) ;
2021-05-04 00:59:31 +00:00
if ( ! _lastPathNegotiationCheck ) {
2020-05-12 08:35:48 +00:00
return ;
}
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ pathIdx ] . p - > localSocket ( ) ) ;
2020-05-12 08:35:48 +00:00
if ( remoteUtility > _localUtility ) {
2021-09-02 04:37:49 +00:00
_paths [ pathIdx ] . p - > address ( ) . toString ( pathStr ) ;
log ( " peer suggests alternate link %s/%s, remote utility (%d) greater than local utility (%d), switching to suggested link \n " , link - > ifname ( ) . c_str ( ) , pathStr , remoteUtility , _localUtility ) ;
2021-12-09 21:43:52 +00:00
_negotiatedPathIdx = pathIdx ;
2020-05-12 08:35:48 +00:00
}
if ( remoteUtility < _localUtility ) {
2021-09-02 04:37:49 +00:00
log ( " peer suggests alternate link %s/%s, remote utility (%d) less than local utility (%d), not switching \n " , link - > ifname ( ) . c_str ( ) , pathStr , remoteUtility , _localUtility ) ;
2020-05-12 08:35:48 +00:00
}
if ( remoteUtility = = _localUtility ) {
2021-09-02 04:37:49 +00:00
log ( " peer suggests alternate link %s/%s, remote utility (%d) equal to local utility (%d) \n " , link - > ifname ( ) . c_str ( ) , pathStr , remoteUtility , _localUtility ) ;
2020-05-12 08:35:48 +00:00
if ( _peer - > _id . address ( ) . toInt ( ) > RR - > node - > identity ( ) . address ( ) . toInt ( ) ) {
2021-09-02 04:37:49 +00:00
log ( " agree with peer to use alternate link %s/%s \n " , link - > ifname ( ) . c_str ( ) , pathStr ) ;
2021-12-09 21:43:52 +00:00
_negotiatedPathIdx = pathIdx ;
2021-05-04 00:59:31 +00:00
}
else {
2021-09-02 04:37:49 +00:00
log ( " ignore petition from peer to use alternate link %s/%s \n " , link - > ifname ( ) . c_str ( ) , pathStr ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : pathNegotiationCheck ( void * tPtr , int64_t now )
2020-05-12 08:35:48 +00:00
{
int maxInPathIdx = ZT_MAX_PEER_NETWORK_PATHS ;
int maxOutPathIdx = ZT_MAX_PEER_NETWORK_PATHS ;
uint64_t maxInCount = 0 ;
uint64_t maxOutCount = 0 ;
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
2020-05-12 08:35:48 +00:00
continue ;
}
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . packetsIn > maxInCount ) {
maxInCount = _paths [ i ] . packetsIn ;
2020-05-12 08:35:48 +00:00
maxInPathIdx = i ;
}
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . packetsOut > maxOutCount ) {
maxOutCount = _paths [ i ] . packetsOut ;
2020-05-12 08:35:48 +00:00
maxOutPathIdx = i ;
}
2021-09-02 04:37:49 +00:00
_paths [ i ] . resetPacketCounts ( ) ;
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
bool _peerLinksSynchronized = ( ( maxInPathIdx ! = ZT_MAX_PEER_NETWORK_PATHS ) & & ( maxOutPathIdx ! = ZT_MAX_PEER_NETWORK_PATHS ) & & ( maxInPathIdx ! = maxOutPathIdx ) ) ? false : true ;
2020-05-12 08:35:48 +00:00
/**
* Determine utility and attempt to petition remote peer to switch to our chosen path
*/
2021-05-04 00:59:31 +00:00
if ( ! _peerLinksSynchronized ) {
2021-09-02 04:37:49 +00:00
_localUtility = _paths [ maxOutPathIdx ] . failoverScore - _paths [ maxInPathIdx ] . failoverScore ;
if ( _paths [ maxOutPathIdx ] . negotiated ) {
_localUtility - = ZT_BOND_FAILOVER_HANDICAP_NEGOTIATED ;
2020-05-12 08:35:48 +00:00
}
if ( ( now - _lastSentPathNegotiationRequest ) > ZT_PATH_NEGOTIATION_CUTOFF_TIME ) {
2021-05-04 00:59:31 +00:00
// fprintf(stderr, "BT: (sync) it's been long enough, sending more requests.\n");
2020-05-12 08:35:48 +00:00
_numSentPathNegotiationRequests = 0 ;
}
if ( _numSentPathNegotiationRequests < ZT_PATH_NEGOTIATION_TRY_COUNT ) {
if ( _localUtility > = 0 ) {
2021-05-04 00:59:31 +00:00
// fprintf(stderr, "BT: (sync) paths appear to be out of sync (utility=%d)\n", _localUtility);
2021-09-02 04:37:49 +00:00
sendPATH_NEGOTIATION_REQUEST ( tPtr , _paths [ maxOutPathIdx ] . p ) ;
2020-05-12 08:35:48 +00:00
+ + _numSentPathNegotiationRequests ;
_lastSentPathNegotiationRequest = now ;
2021-09-02 04:37:49 +00:00
// fprintf(stderr, "sending request to use %s on %s, ls=%llx, utility=%d\n", pathStr, link->ifname().c_str(), _paths[maxOutPathIdx].p->localSocket(), _localUtility);
2020-05-12 08:35:48 +00:00
}
}
/**
* Give up negotiating and consider switching
*/
2021-09-02 04:37:49 +00:00
else if ( ( now - _lastSentPathNegotiationRequest ) > ( 2 * ZT_BOND_OPTIMIZE_INTERVAL ) ) {
2020-05-12 08:35:48 +00:00
if ( _localUtility = = 0 ) {
// There's no loss to us, just switch without sending a another request
2021-05-04 00:59:31 +00:00
// fprintf(stderr, "BT: (sync) giving up, switching to remote peer's path.\n");
2021-12-09 21:43:52 +00:00
_negotiatedPathIdx = maxInPathIdx ;
2020-05-12 08:35:48 +00:00
}
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : sendPATH_NEGOTIATION_REQUEST ( void * tPtr , int pathIdx )
2020-05-12 08:35:48 +00:00
{
2021-12-15 05:13:19 +00:00
log ( " send link negotiation request to peer via link %s, local utility is %d " , pathToStr ( _paths [ pathIdx ] . p ) . c_str ( ) , _localUtility ) ;
2021-09-02 04:37:49 +00:00
if ( _abLinkSelectMethod ! = ZT_BOND_RESELECTION_POLICY_OPTIMIZE ) {
2020-05-12 08:35:48 +00:00
return ;
}
2021-05-04 00:59:31 +00:00
Packet outp ( _peer - > _id . address ( ) , RR - > identity . address ( ) , Packet : : VERB_PATH_NEGOTIATION_REQUEST ) ;
2020-05-12 08:35:48 +00:00
outp . append < int16_t > ( _localUtility ) ;
2021-09-02 04:37:49 +00:00
if ( _paths [ pathIdx ] . p - > address ( ) ) {
2021-05-04 00:59:31 +00:00
outp . armor ( _peer - > key ( ) , false , _peer - > aesKeysIfSupported ( ) ) ;
2021-09-02 04:37:49 +00:00
RR - > node - > putPacket ( tPtr , _paths [ pathIdx ] . p - > localSocket ( ) , _paths [ pathIdx ] . p - > address ( ) , outp . data ( ) , outp . size ( ) ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
void Bond : : sendQOS_MEASUREMENT ( void * tPtr , int pathIdx , int64_t localSocket , const InetAddress & atAddress , int64_t now )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
int64_t _now = RR - > node - > now ( ) ;
2021-05-04 00:59:31 +00:00
Packet outp ( _peer - > _id . address ( ) , RR - > identity . address ( ) , Packet : : VERB_QOS_MEASUREMENT ) ;
2020-05-12 08:35:48 +00:00
char qosData [ ZT_QOS_MAX_PACKET_SIZE ] ;
2021-09-02 04:37:49 +00:00
int16_t len = generateQoSPacket ( pathIdx , _now , qosData ) ;
_overheadBytes + = len ;
if ( len ) {
outp . append ( qosData , len ) ;
if ( atAddress ) {
outp . armor ( _peer - > key ( ) , false , _peer - > aesKeysIfSupported ( ) ) ;
RR - > node - > putPacket ( tPtr , localSocket , atAddress , outp . data ( ) , outp . size ( ) ) ;
}
else {
RR - > sw - > send ( tPtr , outp , false ) ;
}
_paths [ pathIdx ] . packetsReceivedSinceLastQoS = 0 ;
_paths [ pathIdx ] . lastQoSMeasurement = now ;
2020-05-12 08:35:48 +00:00
}
2021-12-15 05:13:19 +00:00
// log("send QOS via link %s (len=%d)", pathToStr(_paths[pathIdx].p).c_str(), len);
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
void Bond : : processBackgroundBondTasks ( void * tPtr , int64_t now )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
if ( ! _peer - > _localMultipathSupported | | ( now - _lastBackgroundTaskCheck ) < ZT_BOND_BACKGROUND_TASK_MIN_INTERVAL ) {
2020-05-12 08:35:48 +00:00
return ;
}
_lastBackgroundTaskCheck = now ;
2021-09-02 04:37:49 +00:00
Mutex : : Lock _l ( _paths_m ) ;
2020-05-12 08:35:48 +00:00
2021-05-04 00:59:31 +00:00
curateBond ( now , false ) ;
2020-05-12 08:35:48 +00:00
if ( ( now - _lastQualityEstimation ) > _qualityEstimationInterval ) {
_lastQualityEstimation = now ;
estimatePathQuality ( now ) ;
}
2021-09-02 04:37:49 +00:00
dumpInfo ( now , false ) ;
2020-05-12 08:35:48 +00:00
2021-09-02 04:37:49 +00:00
// Send ambient monitoring traffic
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( _paths [ i ] . p & & _paths [ i ] . allowed ( ) ) {
if ( ( _monitorInterval > 0 ) & & ( ( now - _paths [ i ] . p - > _lastOut ) > = _monitorInterval ) ) {
if ( ( _peer - > remoteVersionProtocol ( ) > = 5 ) & & ( ! ( ( _peer - > remoteVersionMajor ( ) = = 1 ) & & ( _peer - > remoteVersionMinor ( ) = = 1 ) & & ( _peer - > remoteVersionRevision ( ) = = 0 ) ) ) ) {
2021-12-15 05:13:19 +00:00
Packet outp ( _peer - > address ( ) , RR - > identity . address ( ) , Packet : : VERB_ECHO ) ; // ECHO (this is our bond's heartbeat)
2021-09-02 04:37:49 +00:00
outp . armor ( _peer - > key ( ) , true , _peer - > aesKeysIfSupported ( ) ) ;
RR - > node - > expectReplyTo ( outp . packetId ( ) ) ;
RR - > node - > putPacket ( tPtr , _paths [ i ] . p - > localSocket ( ) , _paths [ i ] . p - > address ( ) , outp . data ( ) , outp . size ( ) ) ;
_overheadBytes + = outp . size ( ) ;
2021-12-15 05:13:19 +00:00
log ( " sent ECHO via link %s " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
// QOS
if ( _paths [ i ] . needsToSendQoS ( now , _qosSendInterval ) ) {
sendQOS_MEASUREMENT ( tPtr , i , _paths [ i ] . p - > localSocket ( ) , _paths [ i ] . p - > address ( ) , now ) ;
}
2020-05-12 08:35:48 +00:00
}
}
// Perform periodic background tasks unique to each bonding policy
2021-09-02 04:37:49 +00:00
switch ( _policy ) {
case ZT_BOND_POLICY_ACTIVE_BACKUP :
2020-08-07 01:10:40 +00:00
processActiveBackupTasks ( tPtr , now ) ;
2020-05-12 08:35:48 +00:00
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BROADCAST :
2020-05-12 08:35:48 +00:00
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BALANCE_RR :
case ZT_BOND_POLICY_BALANCE_XOR :
case ZT_BOND_POLICY_BALANCE_AWARE :
2020-05-12 08:35:48 +00:00
processBalanceTasks ( now ) ;
break ;
default :
break ;
}
// Check whether or not a path negotiation needs to be performed
2021-09-02 04:37:49 +00:00
if ( ( ( now - _lastPathNegotiationCheck ) > ZT_BOND_OPTIMIZE_INTERVAL ) & & _allowPathNegotiation ) {
2020-05-12 08:35:48 +00:00
_lastPathNegotiationCheck = now ;
pathNegotiationCheck ( tPtr , now ) ;
2020-05-15 03:09:25 +00:00
}
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
void Bond : : curateBond ( int64_t now , bool rebuildBond )
2020-05-12 08:35:48 +00:00
{
2020-07-28 06:01:12 +00:00
uint8_t tmpNumAliveLinks = 0 ;
uint8_t tmpNumTotalLinks = 0 ;
2020-05-12 08:35:48 +00:00
/**
2021-09-02 04:37:49 +00:00
* Update path state variables . State variables are used so that critical
* blocks that perform fast packet processing won ' t need to make as many
* function calls or computations .
2020-05-12 08:35:48 +00:00
*/
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
2020-05-12 08:35:48 +00:00
continue ;
}
2020-07-28 06:01:12 +00:00
tmpNumTotalLinks + + ;
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . eligible ) {
2020-07-28 06:01:12 +00:00
tmpNumAliveLinks + + ;
}
2021-09-02 04:37:49 +00:00
/**
2021-12-15 05:13:19 +00:00
* Determine aliveness
2021-09-02 04:37:49 +00:00
*/
_paths [ i ] . alive = ( now - _paths [ i ] . p - > _lastIn ) < _failoverInterval ;
/**
* Determine current eligibility
*/
bool currEligibility = false ;
// Simple RX age (driven by packets of any type and gratuitous VERB_HELLOs)
bool acceptableAge = _paths [ i ] . p - > age ( now ) < ( _failoverInterval + _downDelay ) ;
// Whether we've waited long enough since the link last came online
bool satisfiedUpDelay = ( now - _paths [ i ] . lastAliveToggle ) > = _upDelay ;
// Whether this path is still in its trial period
bool inTrial = ( now - _paths [ i ] . whenNominated ) < ZT_BOND_OPTIMIZE_INTERVAL ;
// if (includeRefractoryPeriod && _paths[i].refractoryPeriod) {
// As long as the refractory period value has not fully drained this path is not eligible
// currEligibility = false;
//}
currEligibility = _paths [ i ] . allowed ( ) & & ( ( acceptableAge & & satisfiedUpDelay ) | | inTrial ) ;
// log("[%d] allowed=%d, acceptableAge=%d, satisfiedUpDelay=%d, inTrial=%d ==== %d", i, _paths[i].allowed(), acceptableAge, satisfiedUpDelay, inTrial, currEligibility);
/**
* Note eligibility state change ( if any ) and take appropriate action
*/
if ( currEligibility ! = _paths [ i ] . eligible ) {
if ( currEligibility = = 0 ) {
2021-12-15 05:13:19 +00:00
log ( " link %s is no longer eligible " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
}
if ( currEligibility = = 1 ) {
2021-12-15 05:13:19 +00:00
log ( " link %s is eligible " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
}
dumpPathStatus ( now , i ) ;
2020-05-12 08:35:48 +00:00
if ( currEligibility ) {
rebuildBond = true ;
}
2021-05-04 00:59:31 +00:00
if ( ! currEligibility ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . adjustRefractoryPeriod ( now , _defaultPathRefractoryPeriod , ! currEligibility ) ;
if ( _paths [ i ] . bonded ) {
if ( _allowFlowHashing ) {
2021-12-15 05:13:19 +00:00
log ( " link %s was bonded, flow reallocation will occur soon " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
rebuildBond = true ;
_paths [ i ] . shouldReallocateFlows = _paths [ i ] . bonded ;
}
2021-12-08 22:32:58 +00:00
_paths [ i ] . bonded = false ;
2020-05-12 08:35:48 +00:00
}
}
}
if ( currEligibility ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . adjustRefractoryPeriod ( now , _defaultPathRefractoryPeriod , false ) ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
_paths [ i ] . eligible = currEligibility ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
/**
* Determine health status to report to user
*/
2020-07-28 06:01:12 +00:00
_numAliveLinks = tmpNumAliveLinks ;
_numTotalLinks = tmpNumTotalLinks ;
bool tmpHealthStatus = true ;
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BROADCAST ) {
2020-07-28 06:01:12 +00:00
if ( _numAliveLinks < 1 ) {
2021-05-04 00:59:31 +00:00
// Considered healthy if we're able to send frames at all
2020-07-28 06:01:12 +00:00
tmpHealthStatus = false ;
}
}
2021-12-15 05:13:19 +00:00
if ( ( _policy = = ZT_BOND_POLICY_BALANCE_RR ) | | ( _policy = = ZT_BOND_POLICY_BALANCE_XOR ) | | ( _policy = = ZT_BOND_POLICY_BALANCE_AWARE | | ( _policy = = ZT_BOND_POLICY_ACTIVE_BACKUP ) ) ) {
2020-07-28 06:01:12 +00:00
if ( _numAliveLinks < _numTotalLinks ) {
tmpHealthStatus = false ;
}
}
2020-08-07 01:10:40 +00:00
if ( tmpHealthStatus ! = _isHealthy ) {
std : : string healthStatusStr ;
if ( tmpHealthStatus = = true ) {
healthStatusStr = " HEALTHY " ;
2021-05-04 00:59:31 +00:00
}
else {
2020-08-07 01:10:40 +00:00
healthStatusStr = " DEGRADED " ;
}
2021-12-15 05:13:19 +00:00
log ( " bond is %s (%d/%d links) " , healthStatusStr . c_str ( ) , _numAliveLinks , _numTotalLinks ) ;
2021-09-02 04:37:49 +00:00
dumpInfo ( now , true ) ;
2020-08-07 01:10:40 +00:00
}
2020-07-28 06:01:12 +00:00
_isHealthy = tmpHealthStatus ;
2020-05-12 08:35:48 +00:00
/**
2021-09-02 04:37:49 +00:00
* Curate the set of paths that are part of the bond proper . Select a set of paths
2020-06-17 21:54:13 +00:00
* per logical link according to eligibility and user - specified constraints .
2020-05-12 08:35:48 +00:00
*/
2021-09-02 04:37:49 +00:00
if ( ( _policy = = ZT_BOND_POLICY_BALANCE_RR ) | | ( _policy = = ZT_BOND_POLICY_BALANCE_XOR ) | | ( _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) ) {
2021-05-04 00:59:31 +00:00
if ( ! _numBondedPaths ) {
2020-05-12 08:35:48 +00:00
rebuildBond = true ;
}
if ( rebuildBond ) {
2021-09-02 04:37:49 +00:00
log ( " rebuilding bond " ) ;
2020-05-12 08:35:48 +00:00
int updatedBondedPathCount = 0 ;
2021-09-02 04:37:49 +00:00
// Build map associating paths with local physical links. Will be selected from in next step
std : : map < SharedPtr < Link > , std : : vector < int > > linkMap ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p ) {
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
linkMap [ link ] . push_back ( i ) ;
}
}
// Re-form bond from link<->path map
std : : map < SharedPtr < Link > , std : : vector < int > > : : iterator it = linkMap . begin ( ) ;
while ( it ! = linkMap . end ( ) ) {
SharedPtr < Link > link = it - > first ;
int ipvPref = link - > ipvPref ( ) ;
// If user has no address type preference, then use every path we find on a link
if ( ipvPref = = 0 ) {
for ( int j = 0 ; j < it - > second . size ( ) ; j + + ) {
int idx = it - > second . at ( j ) ;
2021-12-08 22:32:58 +00:00
if ( ! _paths [ idx ] . p | | ! _paths [ idx ] . eligible | | ! _paths [ idx ] . allowed ( ) ) {
2021-09-02 04:37:49 +00:00
continue ;
}
addPathToBond ( idx , updatedBondedPathCount ) ;
+ + updatedBondedPathCount ;
2021-12-15 05:13:19 +00:00
log ( " add %s (no user addr preference) " , pathToStr ( _paths [ idx ] . p ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
}
// If the user prefers to only use one address type (IPv4 or IPv6)
if ( ipvPref = = 4 | | ipvPref = = 6 ) {
for ( int j = 0 ; j < it - > second . size ( ) ; j + + ) {
int idx = it - > second . at ( j ) ;
2021-12-08 22:32:58 +00:00
if ( ! _paths [ idx ] . p | | ! _paths [ idx ] . eligible ) {
2021-09-02 04:37:49 +00:00
continue ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
if ( ! _paths [ idx ] . allowed ( ) ) {
2021-12-15 05:13:19 +00:00
log ( " did not add %s (user addr preference %d) " , pathToStr ( _paths [ idx ] . p ) . c_str ( ) , ipvPref ) ;
2021-09-02 04:37:49 +00:00
continue ;
}
addPathToBond ( idx , updatedBondedPathCount ) ;
+ + updatedBondedPathCount ;
2021-12-15 05:13:19 +00:00
log ( " add path %s (user addr preference %d) " , pathToStr ( _paths [ idx ] . p ) . c_str ( ) , ipvPref ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
// If the users prefers one address type to another, try to find at least
// one path of that type before considering others.
if ( ipvPref = = 46 | | ipvPref = = 64 ) {
bool foundPreferredPath = false ;
// Search for preferred paths
for ( int j = 0 ; j < it - > second . size ( ) ; j + + ) {
int idx = it - > second . at ( j ) ;
2021-12-08 22:32:58 +00:00
if ( ! _paths [ idx ] . p | | ! _paths [ idx ] . eligible | | ! _paths [ idx ] . allowed ( ) ) {
2021-09-02 04:37:49 +00:00
continue ;
}
2021-12-08 22:32:58 +00:00
if ( _paths [ idx ] . preferred ( ) ) {
2021-09-02 04:37:49 +00:00
addPathToBond ( idx , updatedBondedPathCount ) ;
+ + updatedBondedPathCount ;
2021-12-15 05:13:19 +00:00
log ( " add %s (user addr preference %d) " , pathToStr ( _paths [ idx ] . p ) . c_str ( ) , ipvPref ) ;
2021-09-02 04:37:49 +00:00
foundPreferredPath = true ;
}
}
// Unable to find a path that matches user preference, settle for another address type
if ( ! foundPreferredPath ) {
log ( " did not find first-choice path type on link %s (user preference %d) " , link - > ifname ( ) . c_str ( ) , ipvPref ) ;
for ( int j = 0 ; j < it - > second . size ( ) ; j + + ) {
int idx = it - > second . at ( j ) ;
if ( ! _paths [ idx ] . p | | ! _paths [ idx ] . eligible ) {
continue ;
}
addPathToBond ( idx , updatedBondedPathCount ) ;
+ + updatedBondedPathCount ;
2021-12-15 05:13:19 +00:00
log ( " add %s (user addr preference %d) " , pathToStr ( _paths [ idx ] . p ) . c_str ( ) , ipvPref ) ;
2021-09-02 04:37:49 +00:00
foundPreferredPath = true ;
}
}
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
+ + it ; // Next link
2020-05-12 08:35:48 +00:00
}
_numBondedPaths = updatedBondedPathCount ;
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_RR ) {
// Cause a RR reset since the current index might no longer be valid
2020-06-17 21:54:13 +00:00
_rrPacketsSentOnCurrLink = _packetsPerLink ;
2020-05-12 08:35:48 +00:00
}
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : estimatePathQuality ( int64_t now )
2020-05-12 08:35:48 +00:00
{
2020-06-17 21:54:13 +00:00
uint32_t totUserSpecifiedLinkSpeed = 0 ;
2021-05-04 00:59:31 +00:00
if ( _numBondedPaths ) { // Compute relative user-specified speeds of links
for ( unsigned int i = 0 ; i < _numBondedPaths ; + + i ) {
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
if ( _paths [ i ] . p & & _paths [ i ] . allowed ( ) ) {
2020-06-17 21:54:13 +00:00
totUserSpecifiedLinkSpeed + = link - > speed ( ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < _numBondedPaths ; + + i ) {
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
if ( _paths [ i ] . p & & _paths [ i ] . allowed ( ) ) {
2021-05-04 04:12:45 +00:00
link - > setRelativeSpeed ( ( uint8_t ) round ( ( ( float ) link - > speed ( ) / ( float ) totUserSpecifiedLinkSpeed ) * 255 ) ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
float lat [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
float pdv [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
float plr [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
float per [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
2020-05-12 08:35:48 +00:00
float maxLAT = 0 ;
float maxPDV = 0 ;
float maxPLR = 0 ;
float maxPER = 0 ;
2021-09-02 04:37:49 +00:00
float quality [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
uint8_t alloc [ ZT_MAX_PEER_NETWORK_PATHS ] = { 0 } ;
2020-05-15 03:09:25 +00:00
2020-05-12 08:35:48 +00:00
float totQuality = 0.0f ;
// Compute initial summary statistics
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p | | ! _paths [ i ] . allowed ( ) ) {
2020-05-12 08:35:48 +00:00
continue ;
}
// Compute/Smooth average of real-world observations
2021-09-02 04:37:49 +00:00
_paths [ i ] . latencyMean = _paths [ i ] . latencySamples . mean ( ) ;
_paths [ i ] . latencyVariance = _paths [ i ] . latencySamples . stddev ( ) ;
_paths [ i ] . packetErrorRatio = 1.0 - ( _paths [ i ] . packetValiditySamples . count ( ) ? _paths [ i ] . packetValiditySamples . mean ( ) : 1.0 ) ;
2020-05-12 08:35:48 +00:00
2020-06-17 21:54:13 +00:00
if ( userHasSpecifiedLinkSpeeds ( ) ) {
2020-05-12 08:35:48 +00:00
// Use user-reported metrics
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
2020-06-17 21:54:13 +00:00
if ( link ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . throughputMean = link - > speed ( ) ;
_paths [ i ] . throughputVariance = 0 ;
2020-05-12 08:35:48 +00:00
}
}
// Drain unacknowledged QoS records
2021-09-02 04:37:49 +00:00
std : : map < uint64_t , uint64_t > : : iterator it = _paths [ i ] . qosStatsOut . begin ( ) ;
2020-05-12 08:35:48 +00:00
uint64_t currentLostRecords = 0 ;
2021-09-02 04:37:49 +00:00
while ( it ! = _paths [ i ] . qosStatsOut . end ( ) ) {
int qosRecordTimeout = 5000 ; //_paths[i].p->monitorInterval() * ZT_BOND_QOS_ACK_INTERVAL_MULTIPLIER * 8;
2020-05-12 08:35:48 +00:00
if ( ( now - it - > second ) > = qosRecordTimeout ) {
2020-08-07 01:10:40 +00:00
// Packet was lost
2021-09-02 04:37:49 +00:00
it = _paths [ i ] . qosStatsOut . erase ( it ) ;
2020-05-12 08:35:48 +00:00
+ + currentLostRecords ;
2021-05-04 00:59:31 +00:00
}
else {
+ + it ;
}
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
quality [ i ] = 0 ;
totQuality = 0 ;
2020-05-12 08:35:48 +00:00
// Normalize raw observations according to sane limits and/or user specified values
2021-09-02 04:37:49 +00:00
lat [ i ] = 1.0 / expf ( 4 * Utils : : normalize ( _paths [ i ] . latencyMean , 0 , _maxAcceptableLatency , 0 , 1 ) ) ;
pdv [ i ] = 1.0 / expf ( 4 * Utils : : normalize ( _paths [ i ] . latencyVariance , 0 , _maxAcceptablePacketDelayVariance , 0 , 1 ) ) ;
plr [ i ] = 1.0 / expf ( 4 * Utils : : normalize ( _paths [ i ] . packetLossRatio , 0 , _maxAcceptablePacketLossRatio , 0 , 1 ) ) ;
per [ i ] = 1.0 / expf ( 4 * Utils : : normalize ( _paths [ i ] . packetErrorRatio , 0 , _maxAcceptablePacketErrorRatio , 0 , 1 ) ) ;
2020-05-12 08:35:48 +00:00
// Record bond-wide maximums to determine relative values
maxLAT = lat [ i ] > maxLAT ? lat [ i ] : maxLAT ;
maxPDV = pdv [ i ] > maxPDV ? pdv [ i ] : maxPDV ;
maxPLR = plr [ i ] > maxPLR ? plr [ i ] : maxPLR ;
maxPER = per [ i ] > maxPER ? per [ i ] : maxPER ;
}
// Convert metrics to relative quantities and apply contribution weights
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . bonded ) {
quality [ i ] + = ( ( maxLAT > 0.0f ? lat [ i ] / maxLAT : 0.0f ) * _qw [ ZT_QOS_LAT_IDX ] ) ;
quality [ i ] + = ( ( maxPDV > 0.0f ? pdv [ i ] / maxPDV : 0.0f ) * _qw [ ZT_QOS_PDV_IDX ] ) ;
quality [ i ] + = ( ( maxPLR > 0.0f ? plr [ i ] / maxPLR : 0.0f ) * _qw [ ZT_QOS_PLR_IDX ] ) ;
quality [ i ] + = ( ( maxPER > 0.0f ? per [ i ] / maxPER : 0.0f ) * _qw [ ZT_QOS_PER_IDX ] ) ;
2020-05-12 08:35:48 +00:00
totQuality + = quality [ i ] ;
}
}
2020-08-07 01:10:40 +00:00
// Normalize to 8-bit allocation values
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . bonded ) {
2021-05-04 04:12:45 +00:00
alloc [ i ] = ( uint8_t ) ( std : : ceil ( ( quality [ i ] / totQuality ) * ( float ) 255 ) ) ;
2021-09-02 04:37:49 +00:00
_paths [ i ] . allocation = alloc [ i ] ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : processBalanceTasks ( int64_t now )
2020-05-12 08:35:48 +00:00
{
2020-05-15 03:09:25 +00:00
if ( _allowFlowHashing ) {
/**
* Clean up and reset flows if necessary
*/
2021-09-02 04:37:49 +00:00
if ( ( now - _lastFlowExpirationCheck ) > ZT_PEER_PATH_EXPIRATION ) {
2020-05-15 03:09:25 +00:00
Mutex : : Lock _l ( _flows_m ) ;
2021-09-02 04:37:49 +00:00
forgetFlowsWhenNecessary ( ZT_PEER_PATH_EXPIRATION , false , now ) ;
2021-05-04 00:59:31 +00:00
std : : map < int32_t , SharedPtr < Flow > > : : iterator it = _flows . begin ( ) ;
2020-05-15 03:09:25 +00:00
while ( it ! = _flows . end ( ) ) {
it - > second - > resetByteCounts ( ) ;
+ + it ;
}
2021-09-02 04:37:49 +00:00
_lastFlowExpirationCheck = now ;
2020-05-15 03:09:25 +00:00
}
/**
* Re - allocate flows from dead paths
*/
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_XOR | | _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) {
2020-05-15 03:09:25 +00:00
Mutex : : Lock _l ( _flows_m ) ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
2020-05-15 03:09:25 +00:00
continue ;
}
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . eligible & & _paths [ i ] . shouldReallocateFlows ) {
2021-12-15 05:13:19 +00:00
log ( " reallocate flows from dead link %s " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-05-04 00:59:31 +00:00
std : : map < int32_t , SharedPtr < Flow > > : : iterator flow_it = _flows . begin ( ) ;
2020-05-15 03:09:25 +00:00
while ( flow_it ! = _flows . end ( ) ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ flow_it - > second - > assignedPath ] . p = = _paths [ i ] . p ) {
2021-05-04 00:59:31 +00:00
if ( assignFlowToBondedPath ( flow_it - > second , now ) ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . assignedFlowCount - - ;
2020-05-15 03:09:25 +00:00
}
}
+ + flow_it ;
}
2021-09-02 04:37:49 +00:00
_paths [ i ] . shouldReallocateFlows = false ;
2020-05-15 03:09:25 +00:00
}
}
}
2020-06-16 19:30:21 +00:00
/**
* Re - allocate flows from under - performing
* NOTE : This could be part of the above block but was kept separate for clarity .
*/
2021-10-20 17:48:07 +00:00
if ( _policy = = ZT_BOND_POLICY_BALANCE_AWARE ) {
int totalAllocation = 0 ;
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( ! _paths [ i ] . p ) {
continue ;
}
if ( _paths [ i ] . p & & _paths [ i ] . bonded & & _paths [ i ] . eligible ) {
totalAllocation + = _paths [ i ] . allocation ;
}
}
unsigned char minimumAllocationValue = ( uint8_t ) ( 0.33 * ( ( float ) totalAllocation / ( float ) _numBondedPaths ) ) ;
2020-06-16 19:30:21 +00:00
Mutex : : Lock _l ( _flows_m ) ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
2020-06-16 19:30:21 +00:00
continue ;
}
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . bonded & & _paths [ i ] . eligible & & ( _paths [ i ] . allocation < minimumAllocationValue ) & & _paths [ i ] . assignedFlowCount ) {
2021-12-15 05:13:19 +00:00
log ( " reallocate flows from under-performing link %s \n " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-05-04 00:59:31 +00:00
std : : map < int32_t , SharedPtr < Flow > > : : iterator flow_it = _flows . begin ( ) ;
2020-06-16 19:30:21 +00:00
while ( flow_it ! = _flows . end ( ) ) {
2021-09-02 04:37:49 +00:00
if ( flow_it - > second - > assignedPath = = _paths [ i ] . p ) {
2021-05-04 00:59:31 +00:00
if ( assignFlowToBondedPath ( flow_it - > second , now ) ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . assignedFlowCount - - ;
2020-06-16 19:30:21 +00:00
}
}
+ + flow_it ;
}
2021-09-02 04:37:49 +00:00
_paths [ i ] . shouldReallocateFlows = false ;
2020-06-16 19:30:21 +00:00
}
}
}
2020-05-15 03:09:25 +00:00
}
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
void Bond : : dequeueNextActiveBackupPath ( uint64_t now )
2020-05-12 08:35:48 +00:00
{
if ( _abFailoverQueue . empty ( ) ) {
return ;
}
2021-09-02 04:37:49 +00:00
_abPathIdx = _abFailoverQueue . front ( ) ;
2020-05-12 08:35:48 +00:00
_abFailoverQueue . pop_front ( ) ;
_lastActiveBackupPathChange = now ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p ) {
_paths [ i ] . resetPacketCounts ( ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2020-11-23 17:59:28 +00:00
bool Bond : : abForciblyRotateLink ( )
{
2021-09-02 04:37:49 +00:00
if ( _policy = = ZT_BOND_POLICY_ACTIVE_BACKUP ) {
int prevPathIdx = _abPathIdx ;
2020-11-23 17:59:28 +00:00
dequeueNextActiveBackupPath ( RR - > node - > now ( ) ) ;
2021-12-15 05:13:19 +00:00
log ( " active link rotated from %s to %s " , pathToStr ( _paths [ prevPathIdx ] . p ) . c_str ( ) , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2020-11-23 17:59:28 +00:00
return true ;
}
return false ;
}
2021-09-02 04:37:49 +00:00
void Bond : : processActiveBackupTasks ( void * tPtr , int64_t now )
2020-05-15 03:09:25 +00:00
{
2021-09-02 04:37:49 +00:00
int prevActiveBackupPathIdx = _abPathIdx ;
int nonPreferredPathIdx ;
2020-06-17 21:54:13 +00:00
bool bFoundPrimaryLink = false ;
2020-05-12 08:35:48 +00:00
2020-08-07 01:10:40 +00:00
/**
2021-05-04 00:59:31 +00:00
* Generate periodic status report
2020-08-07 01:10:40 +00:00
*/
2021-09-02 04:37:49 +00:00
if ( ( now - _lastBondStatusLog ) > ZT_BOND_STATUS_INTERVAL ) {
2020-08-07 01:10:40 +00:00
_lastBondStatusLog = now ;
2021-09-02 04:37:49 +00:00
if ( _abPathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
log ( " no active link " ) ;
2021-05-04 00:59:31 +00:00
}
2021-09-02 04:37:49 +00:00
else if ( _paths [ _abPathIdx ] . p ) {
2021-12-15 05:13:19 +00:00
log ( " active link is %s, failover queue size is %zu " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) , _abFailoverQueue . size ( ) ) ;
2020-08-07 01:10:40 +00:00
}
if ( _abFailoverQueue . empty ( ) ) {
2021-12-15 05:13:19 +00:00
log ( " failover queue is empty, bond is no longer fault-tolerant " ) ;
2020-08-07 01:10:40 +00:00
}
}
2021-09-02 04:37:49 +00:00
2020-05-12 08:35:48 +00:00
/**
2020-06-17 21:54:13 +00:00
* Select initial " active " active - backup link
2020-05-12 08:35:48 +00:00
*/
2021-09-02 04:37:49 +00:00
if ( _abPathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
2020-05-12 08:35:48 +00:00
/**
* [ Automatic mode ]
2020-06-17 21:54:13 +00:00
* The user has not explicitly specified links or their failover schedule ,
2020-05-15 03:09:25 +00:00
* the bonding policy will now select the first eligible path and set it as
2020-05-12 08:35:48 +00:00
* its active backup path , if a substantially better path is detected the bonding
* policy will assign it as the new active backup path . If the path fails it will
* simply find the next eligible path .
*/
2021-05-04 00:59:31 +00:00
if ( ! userHasSpecifiedLinks ( ) ) {
2021-09-02 04:37:49 +00:00
log ( " no user-specified links " ) ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . eligible ) {
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
2020-06-17 21:54:13 +00:00
if ( link ) {
2021-12-15 05:13:19 +00:00
log ( " found eligible link %s " , pathToStr ( _paths [ i ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
_abPathIdx = i ;
break ;
2020-05-12 08:35:48 +00:00
}
}
}
}
/**
2020-11-23 17:59:28 +00:00
* [ Manual mode ]
* The user has specified links or failover rules that the bonding policy should adhere to .
*/
2020-06-17 21:54:13 +00:00
else if ( userHasSpecifiedLinks ( ) ) {
if ( userHasSpecifiedPrimaryLink ( ) ) {
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( ! _paths [ i ] . p ) {
2020-05-12 08:35:48 +00:00
continue ;
}
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
if ( _paths [ i ] . eligible & & link - > primary ( ) ) {
if ( ! _paths [ i ] . preferred ( ) ) {
2020-08-07 01:10:40 +00:00
// Found path on primary link, take note in case we don't find a preferred path
2021-09-02 04:37:49 +00:00
nonPreferredPathIdx = i ;
2020-06-17 21:54:13 +00:00
bFoundPrimaryLink = true ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . preferred ( ) ) {
_abPathIdx = i ;
2020-06-17 21:54:13 +00:00
bFoundPrimaryLink = true ;
2021-09-02 04:37:49 +00:00
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ _abPathIdx ] . p - > localSocket ( ) ) ;
if ( link ) {
2021-12-15 05:13:19 +00:00
log ( " found preferred primary link %s " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
}
break ; // Found preferred path on primary link
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
if ( bFoundPrimaryLink & & nonPreferredPathIdx ) {
log ( " found non-preferred primary link " ) ;
_abPathIdx = nonPreferredPathIdx ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
if ( _abPathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
log ( " user-designated primary link is not yet ready " ) ;
2021-05-04 00:59:31 +00:00
// TODO: Should wait for some time (failover interval?) and then switch to spare link
2020-05-12 08:35:48 +00:00
}
}
2021-05-04 00:59:31 +00:00
else if ( ! userHasSpecifiedPrimaryLink ( ) ) {
2021-09-02 04:37:49 +00:00
log ( " user did not specify a primary link, select first available link " ) ;
2021-05-04 00:59:31 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
2021-09-02 04:37:49 +00:00
if ( _paths [ i ] . p & & _paths [ i ] . eligible ) {
_abPathIdx = i ;
2020-05-12 08:35:48 +00:00
break ;
}
}
2021-09-02 04:37:49 +00:00
if ( _abPathIdx ! = ZT_MAX_PEER_NETWORK_PATHS ) {
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ _abPathIdx ] . p - > localSocket ( ) ) ;
2020-06-17 21:54:13 +00:00
if ( link ) {
2021-12-15 05:13:19 +00:00
log ( " select non-primary link %s " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
}
}
}
}
}
2021-09-02 04:37:49 +00:00
// Short-circuit if we don't have an active link yet
if ( _abPathIdx = = ZT_MAX_PEER_NETWORK_PATHS ) {
return ;
}
// Remove ineligible paths from the failover link queue
for ( std : : deque < int > : : iterator it ( _abFailoverQueue . begin ( ) ) ; it ! = _abFailoverQueue . end ( ) ; ) {
if ( _paths [ ( * it ) ] . p & & ! _paths [ ( * it ) ] . eligible ) {
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ ( * it ) ] . p - > localSocket ( ) ) ;
it = _abFailoverQueue . erase ( it ) ;
if ( link ) {
2021-12-15 05:13:19 +00:00
log ( " link %s is ineligible, removing from failover queue (%zu links in queue) " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) , _abFailoverQueue . size ( ) ) ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
else {
+ + it ;
}
}
/**
* Failover instructions were provided by user , build queue according those as well as IPv
* preference , disregarding performance .
*/
if ( userHasSpecifiedFailoverInstructions ( ) ) {
2020-05-12 08:35:48 +00:00
/**
2021-09-02 04:37:49 +00:00
* Clear failover scores
2020-05-12 08:35:48 +00:00
*/
2021-09-02 04:37:49 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( _paths [ i ] . p ) {
_paths [ i ] . failoverScore = 0 ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
}
// Follow user-specified failover instructions
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( ! _paths [ i ] . p | | ! _paths [ i ] . allowed ( ) | | ! _paths [ i ] . eligible ) {
continue ;
}
SharedPtr < Link > link = RR - > bc - > getLinkBySocket ( _policyAlias , _paths [ i ] . p - > localSocket ( ) ) ;
2020-05-15 03:09:25 +00:00
2021-09-02 04:37:49 +00:00
int failoverScoreHandicap = _paths [ i ] . failoverScore ;
if ( _paths [ i ] . preferred ( ) ) {
failoverScoreHandicap + = ZT_BOND_FAILOVER_HANDICAP_PREFERRED ;
}
if ( link - > primary ( ) ) {
// If using "optimize" primary re-select mode, ignore user link designations
failoverScoreHandicap + = ZT_BOND_FAILOVER_HANDICAP_PRIMARY ;
}
if ( ! _paths [ i ] . failoverScore ) {
// If we didn't inherit a failover score from a "parent" that wants to use this path as a failover
int newHandicap = failoverScoreHandicap ? failoverScoreHandicap : _paths [ i ] . allocation ;
_paths [ i ] . failoverScore = newHandicap ;
}
SharedPtr < Link > failoverLink ;
if ( link - > failoverToLink ( ) . length ( ) ) {
failoverLink = RR - > bc - > getLinkByName ( _policyAlias , link - > failoverToLink ( ) ) ;
}
if ( failoverLink ) {
for ( int j = 0 ; j < ZT_MAX_PEER_NETWORK_PATHS ; j + + ) {
if ( _paths [ j ] . p & & getLink ( _paths [ j ] . p ) = = failoverLink . ptr ( ) ) {
int inheritedHandicap = failoverScoreHandicap - 10 ;
int newHandicap = _paths [ j ] . failoverScore > inheritedHandicap ? _paths [ j ] . failoverScore : inheritedHandicap ;
if ( ! _paths [ j ] . preferred ( ) ) {
newHandicap - - ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
_paths [ j ] . failoverScore = newHandicap ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
}
if ( _paths [ i ] . p . ptr ( ) ! = _paths [ _abPathIdx ] . p . ptr ( ) ) {
bool bFoundPathInQueue = false ;
for ( std : : deque < int > : : iterator it ( _abFailoverQueue . begin ( ) ) ; it ! = _abFailoverQueue . end ( ) ; + + it ) {
if ( _paths [ i ] . p . ptr ( ) = = _paths [ ( * it ) ] . p . ptr ( ) ) {
bFoundPathInQueue = true ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
if ( ! bFoundPathInQueue ) {
_abFailoverQueue . push_front ( i ) ;
2021-12-15 05:13:19 +00:00
log ( " add link %s to failover queue (%zu links in queue) " , pathToStr ( _paths [ i ] . p ) . c_str ( ) , _abFailoverQueue . size ( ) ) ;
2021-09-02 04:37:49 +00:00
addPathToBond ( 0 , i ) ;
}
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
}
/**
* No failover instructions provided by user , build queue according to performance
* and IPv preference .
*/
else if ( ! userHasSpecifiedFailoverInstructions ( ) ) {
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( ! _paths [ i ] . p | | ! _paths [ i ] . allowed ( ) | | ! _paths [ i ] . eligible ) {
continue ;
}
int failoverScoreHandicap = 0 ;
if ( _paths [ i ] . preferred ( ) ) {
failoverScoreHandicap = ZT_BOND_FAILOVER_HANDICAP_PREFERRED ;
}
if ( ! _paths [ i ] . eligible ) {
failoverScoreHandicap = - 10000 ;
}
if ( getLink ( _paths [ i ] . p ) - > primary ( ) & & _abLinkSelectMethod ! = ZT_BOND_RESELECTION_POLICY_OPTIMIZE ) {
// If using "optimize" primary re-select mode, ignore user link designations
failoverScoreHandicap = ZT_BOND_FAILOVER_HANDICAP_PRIMARY ;
}
2021-12-09 21:43:52 +00:00
/*
if ( _paths [ i ] . p . ptr ( ) = = _paths [ _negotiatedPathIdx ] . p . ptr ( ) ) {
2021-09-02 04:37:49 +00:00
_paths [ i ] . negotiated = true ;
failoverScoreHandicap = ZT_BOND_FAILOVER_HANDICAP_NEGOTIATED ;
}
else {
_paths [ i ] . negotiated = false ;
}
2021-12-09 21:43:52 +00:00
*/
2021-09-02 04:37:49 +00:00
_paths [ i ] . failoverScore = _paths [ i ] . allocation + failoverScoreHandicap ;
if ( _paths [ i ] . p . ptr ( ) ! = _paths [ _abPathIdx ] . p . ptr ( ) ) {
bool bFoundPathInQueue = false ;
for ( std : : deque < int > : : iterator it ( _abFailoverQueue . begin ( ) ) ; it ! = _abFailoverQueue . end ( ) ; + + it ) {
if ( _paths [ i ] . p . ptr ( ) = = _paths [ ( * it ) ] . p . ptr ( ) ) {
bFoundPathInQueue = true ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
if ( ! bFoundPathInQueue ) {
_abFailoverQueue . push_front ( i ) ;
2021-12-15 05:13:19 +00:00
log ( " add link %s to failover queue (%zu links in queue) " , pathToStr ( _paths [ i ] . p ) . c_str ( ) , _abFailoverQueue . size ( ) ) ;
2021-09-02 04:37:49 +00:00
addPathToBond ( 0 , i ) ;
}
}
}
}
// Sort queue based on performance
if ( ! _abFailoverQueue . empty ( ) ) {
for ( int i = 0 ; i < _abFailoverQueue . size ( ) ; i + + ) {
int value_to_insert = _abFailoverQueue [ i ] ;
int hole_position = i ;
while ( hole_position > 0 & & ( _abFailoverQueue [ hole_position - 1 ] > value_to_insert ) ) {
_abFailoverQueue [ hole_position ] = _abFailoverQueue [ hole_position - 1 ] ;
hole_position = hole_position - 1 ;
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
_abFailoverQueue [ hole_position ] = value_to_insert ;
2020-05-12 08:35:48 +00:00
}
}
2021-09-02 04:37:49 +00:00
2020-05-12 08:35:48 +00:00
/**
* Short - circuit if we have no queued paths
*/
if ( _abFailoverQueue . empty ( ) ) {
return ;
}
2021-09-02 04:37:49 +00:00
2020-05-12 08:35:48 +00:00
/**
2021-09-02 04:37:49 +00:00
* Fulfill primary re - select obligations
2020-05-12 08:35:48 +00:00
*/
2021-09-02 04:37:49 +00:00
if ( _paths [ _abPathIdx ] . p & & ! _paths [ _abPathIdx ] . eligible ) { // Implicit ZT_BOND_RESELECTION_POLICY_FAILURE
2021-12-15 05:13:19 +00:00
log ( " link %s has failed, select link from failover queue (%zu links in queue) " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) , _abFailoverQueue . size ( ) ) ;
2021-05-04 00:59:31 +00:00
if ( ! _abFailoverQueue . empty ( ) ) {
2020-05-12 08:35:48 +00:00
dequeueNextActiveBackupPath ( now ) ;
2021-12-15 05:13:19 +00:00
log ( " active link switched to %s " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2021-05-04 00:59:31 +00:00
}
else {
2021-09-02 04:37:49 +00:00
log ( " failover queue is empty, no links to choose from " ) ;
2020-05-12 08:35:48 +00:00
}
}
/**
* Detect change to prevent flopping during later optimization step .
*/
2021-09-02 04:37:49 +00:00
if ( prevActiveBackupPathIdx ! = _abPathIdx ) {
2020-05-12 08:35:48 +00:00
_lastActiveBackupPathChange = now ;
}
2021-09-02 04:37:49 +00:00
if ( _abLinkSelectMethod = = ZT_BOND_RESELECTION_POLICY_ALWAYS ) {
if ( _paths [ _abPathIdx ] . p & & ! getLink ( _paths [ _abPathIdx ] . p ) - > primary ( ) & & getLink ( _paths [ _abFailoverQueue . front ( ) ] . p ) - > primary ( ) ) {
2020-05-12 08:35:48 +00:00
dequeueNextActiveBackupPath ( now ) ;
2021-12-15 05:13:19 +00:00
log ( " switch back to available primary link %s (select mode: always) " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2021-09-02 04:37:49 +00:00
}
}
if ( _abLinkSelectMethod = = ZT_BOND_RESELECTION_POLICY_BETTER ) {
if ( _paths [ _abPathIdx ] . p & & ! getLink ( _paths [ _abPathIdx ] . p ) - > primary ( ) ) {
2020-08-07 01:10:40 +00:00
// Active backup has switched to "better" primary link according to re-select policy.
2021-09-02 04:37:49 +00:00
if ( getLink ( _paths [ _abFailoverQueue . front ( ) ] . p ) - > primary ( ) & & ( _paths [ _abFailoverQueue . front ( ) ] . failoverScore > _paths [ _abPathIdx ] . failoverScore ) ) {
2020-05-12 08:35:48 +00:00
dequeueNextActiveBackupPath ( now ) ;
2021-12-15 05:13:19 +00:00
log ( " switch back to user-defined primary link %s (select mode: better) " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
if ( _abLinkSelectMethod = = ZT_BOND_RESELECTION_POLICY_OPTIMIZE & & ! _abFailoverQueue . empty ( ) ) {
2020-05-12 08:35:48 +00:00
/**
* Implement link negotiation that was previously - decided
*/
2021-09-02 04:37:49 +00:00
if ( _paths [ _abFailoverQueue . front ( ) ] . negotiated ) {
2020-05-12 08:35:48 +00:00
dequeueNextActiveBackupPath ( now ) ;
_lastPathNegotiationCheck = now ;
2021-12-15 05:13:19 +00:00
log ( " switch negotiated link %s (select mode: optimize) " , pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ) ;
2020-05-12 08:35:48 +00:00
}
else {
// Try to find a better path and automatically switch to it -- not too often, though.
2021-09-02 04:37:49 +00:00
if ( ( now - _lastActiveBackupPathChange ) > ZT_BOND_OPTIMIZE_INTERVAL ) {
2021-05-04 00:59:31 +00:00
if ( ! _abFailoverQueue . empty ( ) ) {
2021-09-02 04:37:49 +00:00
int newFScore = _paths [ _abFailoverQueue . front ( ) ] . failoverScore ;
int prevFScore = _paths [ _abPathIdx ] . failoverScore ;
2020-05-12 08:35:48 +00:00
// Establish a minimum switch threshold to prevent flapping
2021-09-02 04:37:49 +00:00
int failoverScoreDifference = _paths [ _abFailoverQueue . front ( ) ] . failoverScore - _paths [ _abPathIdx ] . failoverScore ;
int thresholdQuantity = ( int ) ( ZT_BOND_ACTIVE_BACKUP_OPTIMIZE_MIN_THRESHOLD * ( float ) _paths [ _abPathIdx ] . allocation ) ;
2020-05-12 08:35:48 +00:00
if ( ( failoverScoreDifference > 0 ) & & ( failoverScoreDifference > thresholdQuantity ) ) {
2021-09-02 04:37:49 +00:00
SharedPtr < Path > oldPath = _paths [ _abPathIdx ] . p ;
2020-05-12 08:35:48 +00:00
dequeueNextActiveBackupPath ( now ) ;
2021-12-15 05:13:19 +00:00
log ( " switch from %s (score: %d) to better link %s (score: %d) (select mode: optimize) " ,
pathToStr ( oldPath ) . c_str ( ) ,
2021-05-04 00:59:31 +00:00
prevFScore ,
2021-12-15 05:13:19 +00:00
pathToStr ( _paths [ _abPathIdx ] . p ) . c_str ( ) ,
newFScore ) ;
2020-05-12 08:35:48 +00:00
}
}
}
}
}
}
2021-09-02 04:37:49 +00:00
void Bond : : setBondParameters ( int policy , SharedPtr < Bond > templateBond , bool useTemplate )
2020-05-12 08:35:48 +00:00
{
2021-09-02 04:37:49 +00:00
// Sanity check for policy
2020-08-07 01:10:40 +00:00
2021-09-02 04:37:49 +00:00
_defaultPolicy = ( _defaultPolicy < = ZT_BOND_POLICY_NONE | | _defaultPolicy > ZT_BOND_POLICY_BALANCE_AWARE ) ? ZT_BOND_POLICY_NONE : _defaultPolicy ;
_policy = ( policy < = ZT_BOND_POLICY_NONE | | policy > ZT_BOND_POLICY_BALANCE_AWARE ) ? ZT_BOND_POLICY_NONE : _defaultPolicy ;
2020-06-16 19:30:21 +00:00
2021-09-02 04:37:49 +00:00
// Flows
2020-07-28 06:01:12 +00:00
2021-09-02 04:37:49 +00:00
_lastFlowExpirationCheck = 0 ;
_lastFlowRebalance = 0 ;
2021-05-04 00:59:31 +00:00
_allowFlowHashing = false ;
2020-06-16 19:30:21 +00:00
2020-05-27 00:57:37 +00:00
// Path negotiation
2021-09-02 04:37:49 +00:00
_lastSentPathNegotiationRequest = 0 ;
_lastPathNegotiationCheck = 0 ;
2021-05-04 00:59:31 +00:00
_allowPathNegotiation = false ;
_pathNegotiationCutoffCount = 0 ;
2021-09-02 04:37:49 +00:00
_lastPathNegotiationReceived = 0 ;
2021-05-04 00:59:31 +00:00
_localUtility = 0 ;
2021-12-09 21:43:52 +00:00
_negotiatedPathIdx = 0 ;
2020-05-15 03:09:25 +00:00
2021-09-02 04:37:49 +00:00
// QOS Verb (and related checks)
_qosCutoffCount = 0 ;
_lastQoSRateCheck = 0 ;
_lastQualityEstimation = 0 ;
// User preferences which may override the default bonding algorithm's behavior
_userHasSpecifiedPrimaryLink = false ;
_userHasSpecifiedFailoverInstructions = false ;
_userHasSpecifiedLinkSpeeds = 0 ;
// Bond status
_lastBondStatusLog = 0 ;
_lastSummaryDump = 0 ;
_isHealthy = false ;
_numAliveLinks = 0 ;
_numTotalLinks = 0 ;
2021-05-04 00:59:31 +00:00
_numBondedPaths = 0 ;
2021-09-02 04:37:49 +00:00
// active-backup
_lastActiveBackupPathChange = 0 ;
_abPathIdx = ZT_MAX_PEER_NETWORK_PATHS ;
// rr
2021-05-04 00:59:31 +00:00
_rrPacketsSentOnCurrLink = 0 ;
2021-09-08 04:41:54 +00:00
_rrIdx = 0 ;
2020-05-27 00:57:37 +00:00
2021-09-02 04:37:49 +00:00
// General parameters
_downDelay = 0 ;
_upDelay = 0 ;
_monitorInterval = 0 ;
// (Sane?) limits
2020-05-15 03:09:25 +00:00
2020-06-16 19:30:21 +00:00
_maxAcceptableLatency = 100 ;
2020-05-12 08:35:48 +00:00
_maxAcceptablePacketDelayVariance = 50 ;
2021-05-04 04:12:45 +00:00
_maxAcceptablePacketLossRatio = 0.10f ;
_maxAcceptablePacketErrorRatio = 0.10f ;
2020-05-12 08:35:48 +00:00
2021-09-02 04:37:49 +00:00
// General timers
_lastFrame = 0 ;
_lastBackgroundTaskCheck = 0 ;
// balance-aware
_totalBondUnderload = 0 ;
_overheadBytes = 0 ;
2020-05-12 08:35:48 +00:00
/**
2021-09-02 04:37:49 +00:00
* Policy - specific defaults
2020-05-12 08:35:48 +00:00
*/
2021-09-02 04:37:49 +00:00
switch ( _policy ) {
case ZT_BOND_POLICY_ACTIVE_BACKUP :
_abLinkSelectMethod = ZT_BOND_RESELECTION_POLICY_OPTIMIZE ;
2020-05-12 08:35:48 +00:00
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BROADCAST :
2020-05-12 08:35:48 +00:00
_downDelay = 30000 ;
_upDelay = 0 ;
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BALANCE_RR :
_packetsPerLink = 64 ;
2020-05-12 08:35:48 +00:00
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BALANCE_XOR :
2020-05-12 08:35:48 +00:00
_allowFlowHashing = true ;
break ;
2021-09-02 04:37:49 +00:00
case ZT_BOND_POLICY_BALANCE_AWARE :
2020-05-12 08:35:48 +00:00
_allowFlowHashing = true ;
break ;
default :
break ;
}
2021-09-02 04:37:49 +00:00
_qw [ ZT_QOS_LAT_IDX ] = 0.3f ;
_qw [ ZT_QOS_LTM_IDX ] = 0.1f ;
_qw [ ZT_QOS_PDV_IDX ] = 0.3f ;
_qw [ ZT_QOS_PLR_IDX ] = 0.1f ;
_qw [ ZT_QOS_PER_IDX ] = 0.1f ;
_qw [ ZT_QOS_SCP_IDX ] = 0.1f ;
_failoverInterval = ZT_BOND_FAILOVER_DEFAULT_INTERVAL ;
/* If a user has specified custom parameters for this bonding policy, overlay them onto the defaults */
2020-06-02 05:58:58 +00:00
if ( useTemplate ) {
_policyAlias = templateBond - > _policyAlias ;
2021-12-14 19:49:43 +00:00
_policy = templateBond - > policy ( ) ;
2021-09-02 04:37:49 +00:00
_failoverInterval = templateBond - > _failoverInterval > = ZT_BOND_FAILOVER_MIN_INTERVAL ? templateBond - > _failoverInterval : ZT_BOND_FAILOVER_MIN_INTERVAL ;
2020-06-02 05:58:58 +00:00
_downDelay = templateBond - > _downDelay ;
_upDelay = templateBond - > _upDelay ;
2020-06-17 21:54:13 +00:00
_abLinkSelectMethod = templateBond - > _abLinkSelectMethod ;
2021-09-02 04:37:49 +00:00
memcpy ( _qw , templateBond - > _qw , ZT_QOS_WEIGHT_SIZE * sizeof ( float ) ) ;
2020-06-02 05:58:58 +00:00
}
2021-09-02 04:37:49 +00:00
// Timer geometry
_monitorInterval = _failoverInterval / ZT_BOND_ECHOS_PER_FAILOVER_INTERVAL ;
2020-05-12 08:35:48 +00:00
_qualityEstimationInterval = _failoverInterval * 2 ;
2021-09-02 04:37:49 +00:00
_qosSendInterval = _failoverInterval * 2 ;
2020-05-12 08:35:48 +00:00
_qosCutoffCount = 0 ;
_defaultPathRefractoryPeriod = 8000 ;
}
void Bond : : setUserQualityWeights ( float weights [ ] , int len )
{
if ( len = = ZT_QOS_WEIGHT_SIZE ) {
float weightTotal = 0.0 ;
2021-05-04 00:59:31 +00:00
for ( unsigned int i = 0 ; i < ZT_QOS_WEIGHT_SIZE ; + + i ) {
2020-05-12 08:35:48 +00:00
weightTotal + = weights [ i ] ;
}
if ( weightTotal > 0.99 & & weightTotal < 1.01 ) {
2021-09-02 04:37:49 +00:00
memcpy ( _qw , weights , len * sizeof ( float ) ) ;
2020-05-12 08:35:48 +00:00
}
}
}
2021-09-02 04:37:49 +00:00
SharedPtr < Link > Bond : : getLink ( const SharedPtr < Path > & path )
2021-05-04 00:59:31 +00:00
{
2021-09-02 04:37:49 +00:00
return RR - > bc - > getLinkBySocket ( _policyAlias , path - > localSocket ( ) ) ;
2020-05-12 08:35:48 +00:00
}
2021-12-15 05:13:19 +00:00
std : : string Bond : : pathToStr ( const SharedPtr < Path > & path )
2020-05-12 08:35:48 +00:00
{
2021-12-15 05:13:19 +00:00
# ifdef ZT_TRACE
2021-09-02 04:37:49 +00:00
char pathStr [ 64 ] = { 0 } ;
2021-12-15 05:13:19 +00:00
char fullPathStr [ 256 ] = { 0 } ;
path - > address ( ) . toString ( pathStr ) ;
snprintf ( fullPathStr , 256 , " %.16llx-%s/%s " , ( unsigned long long ) ( path - > localSocket ( ) ) , getLink ( path ) - > ifname ( ) . c_str ( ) , pathStr ) ;
return std : : string ( fullPathStr ) ;
# else
return " " ;
# endif
}
void Bond : : dumpPathStatus ( int64_t now , int pathIdx )
{
# ifdef ZT_TRACE
std : : string aliveOrDead = _paths [ pathIdx ] . alive ? std : : string ( " alive " ) : std : : string ( " dead " ) ;
std : : string eligibleOrNot = _paths [ pathIdx ] . eligible ? std : : string ( " eligible " ) : std : : string ( " ineligible " ) ;
std : : string bondedOrNot = _paths [ pathIdx ] . bonded ? std : : string ( " bonded " ) : std : : string ( " unbonded " ) ;
log ( " path[%2d] --- %5s (%7d), %10s, %8s, flows=%-6d lat=%-8.3f pdv=%-7.3f err=%-6.4f loss=%-6.4f alloc=%-3d --- (%s) " ,
2021-09-02 04:37:49 +00:00
pathIdx ,
2021-12-15 05:13:19 +00:00
aliveOrDead . c_str ( ) ,
_paths [ pathIdx ] . p - > age ( now ) ,
eligibleOrNot . c_str ( ) ,
bondedOrNot . c_str ( ) ,
2021-09-02 04:37:49 +00:00
_paths [ pathIdx ] . assignedFlowCount ,
_paths [ pathIdx ] . latencyMean ,
_paths [ pathIdx ] . latencyVariance ,
_paths [ pathIdx ] . packetErrorRatio ,
_paths [ pathIdx ] . packetLossRatio ,
2021-10-20 17:48:07 +00:00
_paths [ pathIdx ] . allocation ,
2021-12-15 05:13:19 +00:00
pathToStr ( _paths [ pathIdx ] . p ) . c_str ( ) ) ;
# endif
2020-05-12 08:35:48 +00:00
}
2021-09-02 04:37:49 +00:00
void Bond : : dumpInfo ( int64_t now , bool force )
2020-05-12 08:35:48 +00:00
{
2021-12-15 05:13:19 +00:00
# ifdef ZT_TRACE
2021-09-02 04:37:49 +00:00
uint64_t timeSinceLastDump = now - _lastSummaryDump ;
if ( ! force & & timeSinceLastDump < ZT_BOND_STATUS_INTERVAL ) {
return ;
}
_lastSummaryDump = now ;
float overhead = ( _overheadBytes / ( timeSinceLastDump / 1000.0f ) / 1000.0f ) ;
_overheadBytes = 0 ;
2021-12-15 05:13:19 +00:00
log ( " bond: bp=%d, fi=%d, mi=%d, ud=%d, dd=%d, flows=%lu, overhead=%f KB/s " , _policy , _failoverInterval , _monitorInterval , _upDelay , _downDelay , ( unsigned long ) _flows . size ( ) , overhead ) ;
2021-09-02 04:37:49 +00:00
for ( int i = 0 ; i < ZT_MAX_PEER_NETWORK_PATHS ; + + i ) {
if ( _paths [ i ] . p ) {
dumpPathStatus ( now , i ) ;
}
}
2021-12-15 05:13:19 +00:00
log ( " " ) ;
# endif
2020-05-12 08:35:48 +00:00
}
2021-05-04 00:59:31 +00:00
} // namespace ZeroTier