GitHub/GameNetworkingSockets
1
0
Fork 0
mirror of https://github.com/ValveSoftware/GameNetworkingSockets.git synced 2026-05-29 16:20:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

ICE client refactor: local candidates remember the interface

Browse Source 
This removes several places where we need to lookup the interface.
But since we are storing a pointer, it means now we need to make sure
and carefully cleanup if an interface drops out of the interface list.

(cherry picked from commit 3d29fc0a08)
This commit is contained in:
Fletcher Dunn
2026-05-25 17:42:02 -07:00
parent d0ed9d1c35
commit 675ea5580d
2 changed files with 86 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/steamnetworkingsockets/clientlib/steamnetworkingsockets_ice_client.cpp
+74 -72
View File
@@ -1091,19 +1091,20 @@ CSteamNetworkingICESession::~CSteamNetworkingICESession()
{
SteamNetworkingGlobalLock::AssertHeldByCurrentThread();
// Make sure we don't fire any more callbacks while doing any of this processing
m_pCallbacks = nullptr;
for ( const auto &pIntf : m_vecInterfaces )
{
if ( pIntf->m_pPendingSTUNRequest )
pIntf->m_pPendingSTUNRequest->Cancel();
}
for ( int i = len( m_vecPendingPeerRequests ) - 1; i >= 0; --i )
{
m_vecPendingPeerRequests[i]->Cancel();
{
delete pIntf->m_pPendingSTUNRequest;
pIntf->m_pPendingSTUNRequest = nullptr;
}
}
for ( ICECandidatePair *pPair: m_vecCandidatePairs )
delete pPair;
InternalDeleteCandidatePair( pPair );
m_vecCandidatePairs.clear();
m_vecInterfaces.clear();
@@ -1189,18 +1190,32 @@ void CSteamNetworkingICESession::InvalidateInterfaceList()
void CSteamNetworkingICESession::SetSelectedCandidatePair( ICECandidatePair *pPair )
{
SpewMsg( "\n\nSelected candidate %s -> %s.\n\n", SteamNetworkingIPAddrRender( pPair->m_localCandidate.m_base ).c_str(), SteamNetworkingIPAddrRender( pPair->m_remoteCandidate.m_addr ).c_str() );
ICESessionInterface *pIntf = FindInterfaceForCandidate( pPair->m_localCandidate.m_base );
if ( !pIntf )
{
AssertMsg( false, "Tried to select a candidate pair but cannot find the local interface?" );
return;
}
m_pSelectedCandidatePair = pPair;
m_pSelectedSocket = pIntf->m_pSocket;
m_pSelectedSocket = pPair->m_localCandidate.m_pInterface->m_pSocket;
if ( m_pCallbacks )
m_pCallbacks->OnConnectionSelected( pPair->m_localCandidate, pPair->m_remoteCandidate );
}
void CSteamNetworkingICESession::InternalDeleteCandidatePair( ICECandidatePair *pPair )
{
if ( pPair == m_pSelectedCandidatePair )
{
m_pSelectedCandidatePair = nullptr;
m_pSelectedSocket = nullptr;
}
if ( pPair->m_pPeerRequest != nullptr )
{
find_and_remove_element( m_vecPendingPeerRequests, pPair->m_pPeerRequest );
delete pPair->m_pPeerRequest;
pPair->m_pPeerRequest = nullptr;
}
find_and_remove_element( m_vecTriggeredCheckQueue, pPair );
delete pPair;
}
int CSteamNetworkingICESession::GetPing() const
{
if ( m_pSelectedCandidatePair == nullptr )
@@ -1235,14 +1250,14 @@ void CSteamNetworkingICESession::GatherInterfaces()
uint32 uNextPriority = 65535;
for ( int i = len( m_vecInterfaces ) - 1; i >= 0; --i )
{
ICESessionInterface &intf = *m_vecInterfaces[i];
ICESessionInterface *intf = m_vecInterfaces[i].get();
bool bFound = false;
for ( int j = 0; j < vecAddrs.Count(); ++j )
{
if ( IPAddrEqualIgnoringPort( vecAddrs[j].m_addr, intf.m_pSocket->m_boundAddr ) )
if ( IPAddrEqualIgnoringPort( vecAddrs[j].m_addr, intf->m_pSocket->m_boundAddr ) )
{
vecAddrs.FastRemove( j );
vecAddrs.Remove( j );
bFound = true;
break;
}
@@ -1250,16 +1265,37 @@ void CSteamNetworkingICESession::GatherInterfaces()
if ( !bFound )
{
// ICESessionInterface disappeared — cancel its pending STUN request if any.
// The socket is closed by the ICESessionInterface destructor when we erase below.
if ( intf.m_pPendingSTUNRequest )
intf.m_pPendingSTUNRequest->Cancel();
// ICESessionInterface disappeared! Delete the socket and all candidates
// and pairs that use it
SpewMsg( "Local interface %s removed\n", SteamNetworkingIPAddrRender( intf->m_pSocket->m_boundAddr ).c_str() );
for ( int j = len( m_vecCandidatePairs ) - 1; j >= 0; --j )
{
ICECandidatePair *pPair = m_vecCandidatePairs[j];
if ( pPair->m_localCandidate.m_pInterface == intf )
{
InternalDeleteCandidatePair( pPair );
erase_at( m_vecCandidatePairs, j );
}
}
for ( int j = len( m_vecCandidates ) - 1; j >= 0; --j )
{
if ( m_vecCandidates[j].m_pInterface == intf )
erase_at( m_vecCandidates, j );
}
if ( intf->m_pPendingSTUNRequest )
{
delete intf->m_pPendingSTUNRequest;
intf->m_pPendingSTUNRequest = nullptr;
}
erase_at( m_vecInterfaces, i );
continue;
}
if ( intf.m_nPriority <= uNextPriority )
uNextPriority = intf.m_nPriority-1;
if ( intf->m_nPriority <= uNextPriority )
uNextPriority = intf->m_nPriority-1;
}
// Second pass: add genuinely new interfaces. Assign priorities counting
@@ -1282,26 +1318,6 @@ void CSteamNetworkingICESession::GatherInterfaces()
}
}
int CSteamNetworkingICESession::GetLocalCandidatePrefixLen( const SteamNetworkingIPAddr &addr ) const
{
for ( const auto &pIntf : m_vecInterfaces )
{
if ( IPAddrEqualIgnoringPort( pIntf->m_pSocket->m_boundAddr, addr ) )
return pIntf->m_nPrefixLen;
}
return 0;
}
ICESessionInterface *CSteamNetworkingICESession::FindInterfaceForCandidate( const SteamNetworkingIPAddr& addr )
{
for ( const auto &pIntf : m_vecInterfaces )
{
if ( addr == pIntf->m_pSocket->m_boundAddr )
return pIntf.get();
}
return nullptr;
}
CSteamNetworkingSocketsSTUNRequest *CSteamNetworkingICESession::FindPendingRequestByTransactionID( const uint32 nTransactionID[3] ) const
{
auto fnMatches = [nTransactionID]( const CSteamNetworkingSocketsSTUNRequest *pRequest )
@@ -1549,6 +1565,8 @@ void CSteamNetworkingICESession::Think_DiscoverServerReflexiveCandidates()
{
if ( c.m_type != ICECandidateKind::Host )
continue;
ICESessionInterface *pIntf = c.m_pInterface;
// Do we have a server-reflexive candidate for this host already?
bool bFound = false;
if ( !bFound )
@@ -1563,8 +1581,8 @@ void CSteamNetworkingICESession::Think_DiscoverServerReflexiveCandidates()
}
}
if ( !bFound )
{ // Is there a STUN request pending for this interface?
ICESessionInterface *pIntf = FindInterfaceForCandidate( c.m_base );
{
// Is there a STUN request pending for this interface?
if ( pIntf != nullptr && pIntf->m_pPendingSTUNRequest != nullptr )
bFound = true;
}
@@ -1584,10 +1602,6 @@ void CSteamNetworkingICESession::Think_DiscoverServerReflexiveCandidates()
if ( !pSTUNServer )
continue;
ICESessionInterface *pIntf = FindInterfaceForCandidate( c.m_base );
if ( pIntf == nullptr )
continue;
CSteamNetworkingSocketsSTUNRequest *pNewRequest = CSteamNetworkingSocketsSTUNRequest::SendBindRequest( pIntf, *pSTUNServer, CRecvSTUNPktCallback( StaticSTUNRequestCallback_ServerReflexiveCandidate, this ), m_nEncoding | kSTUNPacketEncodingFlags_MappedAddress );
if ( pNewRequest != nullptr )
return;
@@ -1618,7 +1632,7 @@ void CSteamNetworkingICESession::UpdateHostCandidates()
}
if ( pHostCandidate == nullptr )
pHostCandidate = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::Host, hostCandidateAddr, hostCandidateAddr ) );
pHostCandidate = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::Host, hostCandidateAddr, pIntf.get() ) );
pHostCandidate->m_nPriority = pHostCandidate->CalcPriority( pIntf->m_nPriority );
if ( m_pCallbacks != nullptr )
m_pCallbacks->OnLocalCandidateDiscovered( *pHostCandidate );
@@ -1663,8 +1677,9 @@ void CSteamNetworkingICESession::STUNRequestCallback_ServerReflexiveCandidate( c
{ // Got a response... is it redundant (this happens when we get a STUN response but we're not behind a NAT)
if ( bindResult == localAddr )
bindResult.Clear();
ICELocalCandidate *pCand = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::ServerReflexive, bindResult, localAddr, info.m_pRequest->m_remoteAddr ) );
ICELocalCandidate *pCand = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::ServerReflexive, bindResult, pIntf ) );
pCand->m_nPriority = pCand->CalcPriority( pIntf->m_nPriority );
pCand->m_stunServer = info.m_pRequest->m_remoteAddr;
if ( m_pCallbacks != nullptr && !bindResult.IsIPv6AllZeros() )
m_pCallbacks->OnLocalCandidateDiscovered( *pCand );
return;
@@ -1682,8 +1697,9 @@ void CSteamNetworkingICESession::STUNRequestCallback_ServerReflexiveCandidate( c
// candidate" or "pending request". Without this marker, a total STUN failure would
// be retried forever every think tick, creating unbounded churn.
bindResult.Clear();
ICELocalCandidate *pCand = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::ServerReflexive, bindResult, localAddr, info.m_pRequest->m_remoteAddr ) );
ICELocalCandidate *pCand = push_back_get_ptr( m_vecCandidates, ICELocalCandidate( ICECandidateKind::ServerReflexive, bindResult, pIntf ) );
pCand->m_nPriority = 0;
pCand->m_stunServer = info.m_pRequest->m_remoteAddr;
return;
}
@@ -1750,9 +1766,7 @@ void CSteamNetworkingICESession::UpdateKeepalive( const ICELocalCandidate& c )
if ( c.m_addr.IsIPv6AllZeros() )
return;
ICESessionInterface * const pIntf = FindInterfaceForCandidate( c.m_base );
if ( pIntf == nullptr )
return;
ICESessionInterface * const pIntf = c.m_pInterface;
if ( pIntf->m_pPendingSTUNRequest != nullptr )
return;
@@ -1877,14 +1891,8 @@ void CSteamNetworkingICESession::Think_TestPeerConnectivity()
if ( pPairToCheck != nullptr )
{
// Trigger the connectivity check here...
ICESessionInterface * const pIntf = pPairToCheck->m_localCandidate.m_pInterface;
pPairToCheck->m_nState = kICECandidatePairState_InProgress;
ICESessionInterface * const pIntf = FindInterfaceForCandidate( pPairToCheck->m_localCandidate.m_base );
if ( pIntf == nullptr )
{
pPairToCheck->m_nState = kICECandidatePairState_Failed;
return;
}
pPairToCheck->m_pPeerRequest = CSteamNetworkingSocketsSTUNRequest::CreatePeerConnectivityCheckRequest( pIntf, pPairToCheck->m_remoteCandidate.m_addr, CRecvSTUNPktCallback( StaticSTUNRequestCallback_PeerConnectivityCheck, this ), m_nEncoding );
if ( pPairToCheck->m_pPeerRequest == nullptr )
{
@@ -2039,20 +2047,14 @@ CSteamNetworkingICESession::ICECandidateBase::ICECandidateBase( ICECandidateKind
m_nPriority = 0;
}
CSteamNetworkingICESession::ICELocalCandidate::ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, const SteamNetworkingIPAddr& base )
CSteamNetworkingICESession::ICELocalCandidate::ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, ICESessionInterface *pInterface )
: ICECandidateBase( t, addr )
, m_base( base )
, m_pInterface( pInterface )
, m_base( pInterface->m_pSocket->m_boundAddr )
{
m_stunServer.Clear();
}
CSteamNetworkingICESession::ICELocalCandidate::ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, const SteamNetworkingIPAddr& base, const SteamNetworkingIPAddr& stunServer )
: ICECandidateBase( t, addr )
, m_base( base )
{
m_stunServer = stunServer;
}
uint32 CSteamNetworkingICESession::ICECandidateBase::CalcPriority( uint32 nLocalPreference )
{
/*priority = (2^24)*(type preference) +
@@ -2291,7 +2293,7 @@ void CConnectionTransportP2PICE_Valve::OnConnectionSelected( const CSteamNetwork
if ( localCandidate.m_type == ICECandidateKind::Host
&& remoteCandidate.m_type == ICECandidateKind::Host )
{
int nPrefixLen = m_pICESession->GetLocalCandidatePrefixLen( localCandidate.m_base );
int nPrefixLen = localCandidate.m_pInterface->m_nPrefixLen;
if ( IsRemoteAddressOnLocalSubnet( localCandidate.m_base, nPrefixLen, remoteCandidate.m_addr ) )
m_eCurrentRouteKind = k_ESteamNetTransport_UDPProbablyLocal;
}
src/steamnetworkingsockets/clientlib/steamnetworkingsockets_ice_client.h
+12 -9
View File
@@ -178,13 +178,14 @@ namespace SteamNetworkingSocketsLib {
constexpr static bool kPacketProcessed = true;
bool OnPacketReceived( const RecvPktInfo_t &info );
~CSteamNetworkingSocketsSTUNRequest();
protected:
void Think( SteamNetworkingMicroseconds usecNow ) override;
friend class CSteamNetworkingSocketsSTUN;
private:
explicit CSteamNetworkingSocketsSTUNRequest( ICESessionInterface *pInterface );
~CSteamNetworkingSocketsSTUNRequest();
static void StaticPacketReceived( const RecvPktInfo_t &info, CSteamNetworkingSocketsSTUNRequest *pContext );
@@ -219,10 +220,10 @@ namespace SteamNetworkingSocketsLib {
};
struct ICELocalCandidate : public ICECandidateBase
{
ICESessionInterface *m_pInterface;
SteamNetworkingIPAddr m_stunServer;
SteamNetworkingIPAddr m_base; // FIXME Each local candidate should remember what interface it came from, and the interface's bound address is the base
ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, const SteamNetworkingIPAddr& base );
ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, const SteamNetworkingIPAddr& base, const SteamNetworkingIPAddr& stunServer );
SteamNetworkingIPAddr m_base; // FIXME Remove this, fetch it from the interface
ICELocalCandidate( ICECandidateKind t, const SteamNetworkingIPAddr& addr, ICESessionInterface *pInterface );
void CalcCandidateAttribute( char *pszBuffer, size_t nBufferSize ) const;
};
EICERole GetRole() { return m_role; }
@@ -235,10 +236,6 @@ namespace SteamNetworkingSocketsLib {
SteamNetworkingIPAddr GetSelectedDestination();
int GetPing() const;
// Returns the subnet prefix length for the local interface matching addr,
// or 0 if the interface was not found or has no valid prefix data.
int GetLocalCandidatePrefixLen( const SteamNetworkingIPAddr &addr ) const;
protected:
void Think( SteamNetworkingMicroseconds usecNow ) override;
@@ -376,7 +373,6 @@ namespace SteamNetworkingSocketsLib {
// each Think() pass before the regular check list.
std_vector< ICECandidatePair* > m_vecTriggeredCheckQueue;
ICESessionInterface *FindInterfaceForCandidate( const SteamNetworkingIPAddr& addr );
CSteamNetworkingSocketsSTUNRequest *FindPendingRequestByTransactionID( const uint32 nTransactionID[3] ) const;
void GatherInterfaces();
void UpdateHostCandidates();
@@ -390,6 +386,13 @@ namespace SteamNetworkingSocketsLib {
void SetSelectedCandidatePair( ICECandidatePair *pPair );
// Delete a candidate pair and perform all associated cleanup:
// clears the selected-pair state if this was the active path, cancels
// any in-flight peer connectivity check, and removes the pair from the
// triggered-check queue. Does NOT remove it from m_vecCandidatePairs —
// that is the caller's responsibility.
void InternalDeleteCandidatePair( ICECandidatePair *pPair );
void STUNRequestCallback_ServerReflexiveCandidate( const RecvSTUNPktInfo_t &info );
static void StaticSTUNRequestCallback_ServerReflexiveCandidate( const RecvSTUNPktInfo_t &info, CSteamNetworkingICESession* pContext );
void STUNRequestCallback_ServerReflexiveKeepAlive( const RecvSTUNPktInfo_t &info );