// SPDX-FileCopyrightText: 2023 The Pion community // SPDX-License-Identifier: MIT package ice import ( "fmt" "sync/atomic" "time" "github.com/pion/stun/v3" ) func newCandidatePair(local, remote Candidate, controlling bool) *CandidatePair { return &CandidatePair{ iceRoleControlling: controlling, Remote: remote, Local: local, state: CandidatePairStateWaiting, } } // CandidatePair is a combination of a local and remote candidate. type CandidatePair struct { iceRoleControlling bool Remote Candidate Local Candidate bindingRequestCount uint16 state CandidatePairState nominated bool nominateOnBindingSuccess bool // stats currentRoundTripTime int64 // in ns totalRoundTripTime int64 // in ns packetsSent uint32 packetsReceived uint32 bytesSent uint64 bytesReceived uint64 lastPacketSentAt atomic.Value // time.Time lastPacketReceivedAt atomic.Value // time.Time requestsReceived uint64 requestsSent uint64 responsesReceived uint64 responsesSent uint64 firstRequestSentAt atomic.Value // time.Time lastRequestSentAt atomic.Value // time.Time firstResponseReceivedAt atomic.Value // time.Time lastResponseReceivedAt atomic.Value // time.Time firstRequestReceivedAt atomic.Value // time.Time lastRequestReceivedAt atomic.Value // time.Time } func (p *CandidatePair) String() string { if p == nil { return "" } return fmt.Sprintf( "prio %d (local, prio %d) %s <-> %s (remote, prio %d), state: %s, nominated: %v, nominateOnBindingSuccess: %v", p.priority(), p.Local.Priority(), p.Local, p.Remote, p.Remote.Priority(), p.state, p.nominated, p.nominateOnBindingSuccess, ) } func (p *CandidatePair) equal(other *CandidatePair) bool { if p == nil && other == nil { return true } if p == nil || other == nil { return false } return p.Local.Equal(other.Local) && p.Remote.Equal(other.Remote) } // RFC 5245 - 5.7.2. Computing Pair Priority and Ordering Pairs // Let G be the priority for the candidate provided by the controlling // agent. Let D be the priority for the candidate provided by the // controlled agent. // pair priority = 2^32*MIN(G,D) + 2*MAX(G,D) + (G>D?1:0). func (p *CandidatePair) priority() uint64 { var g, d uint32 //nolint:varnamelen // clearer to use g and d here if p.iceRoleControlling { g = p.Local.Priority() d = p.Remote.Priority() } else { g = p.Remote.Priority() d = p.Local.Priority() } // Just implement these here rather // than fooling around with the math package localMin := func(x, y uint32) uint64 { if x < y { return uint64(x) } return uint64(y) } localMax := func(x, y uint32) uint64 { if x > y { return uint64(x) } return uint64(y) } cmp := func(x, y uint32) uint64 { if x > y { return uint64(1) } return uint64(0) } // 1<<32 overflows uint32; and if both g && d are // maxUint32, this result would overflow uint64 return (1<<32-1)*localMin(g, d) + 2*localMax(g, d) + cmp(g, d) } func (p *CandidatePair) Write(b []byte) (int, error) { return p.Local.writeTo(b, p.Remote) } func (a *Agent) sendSTUN(msg *stun.Message, local, remote Candidate) { _, err := local.writeTo(msg.Raw, remote) if err != nil { a.log.Tracef("Failed to send STUN message: %s", err) } } // UpdateRoundTripTime sets the current round time of this pair and // accumulates total round trip time and responses received. func (p *CandidatePair) UpdateRoundTripTime(rtt time.Duration) { rttNs := rtt.Nanoseconds() atomic.StoreInt64(&p.currentRoundTripTime, rttNs) atomic.AddInt64(&p.totalRoundTripTime, rttNs) atomic.AddUint64(&p.responsesReceived, 1) now := time.Now() p.firstResponseReceivedAt.CompareAndSwap(nil, now) p.lastResponseReceivedAt.Store(now) } // CurrentRoundTripTime returns the current round trip time in seconds // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-currentroundtriptime func (p *CandidatePair) CurrentRoundTripTime() float64 { return time.Duration(atomic.LoadInt64(&p.currentRoundTripTime)).Seconds() } // TotalRoundTripTime returns the current round trip time in seconds // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-totalroundtriptime func (p *CandidatePair) TotalRoundTripTime() float64 { return time.Duration(atomic.LoadInt64(&p.totalRoundTripTime)).Seconds() } // RequestsReceived returns the total number of connectivity checks received // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-requestsreceived func (p *CandidatePair) RequestsReceived() uint64 { return atomic.LoadUint64(&p.requestsReceived) } // RequestsSent returns the total number of connectivity checks sent // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-requestssent func (p *CandidatePair) RequestsSent() uint64 { return atomic.LoadUint64(&p.requestsSent) } // ResponsesReceived returns the total number of connectivity responses received // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-responsesreceived func (p *CandidatePair) ResponsesReceived() uint64 { return atomic.LoadUint64(&p.responsesReceived) } // ResponsesSent returns the total number of connectivity responses sent // https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-responsessent func (p *CandidatePair) ResponsesSent() uint64 { return atomic.LoadUint64(&p.responsesSent) } // PacketsSent returns total application (non-STUN) packets sent on this pair. func (p *CandidatePair) PacketsSent() uint32 { return atomic.LoadUint32(&p.packetsSent) } // PacketsReceived returns total application (non-STUN) packets received on this pair. func (p *CandidatePair) PacketsReceived() uint32 { return atomic.LoadUint32(&p.packetsReceived) } // BytesSent returns total application bytes sent on this pair. func (p *CandidatePair) BytesSent() uint64 { return atomic.LoadUint64(&p.bytesSent) } // BytesReceived returns total application bytes received on this pair. func (p *CandidatePair) BytesReceived() uint64 { return atomic.LoadUint64(&p.bytesReceived) } // LastPacketSentAt returns the timestamp of the last application packet sent. func (p *CandidatePair) LastPacketSentAt() time.Time { if v, ok := p.lastPacketSentAt.Load().(time.Time); ok { return v } return time.Time{} } // LastPacketReceivedAt returns the timestamp of the last application packet received. func (p *CandidatePair) LastPacketReceivedAt() time.Time { if v, ok := p.lastPacketReceivedAt.Load().(time.Time); ok { return v } return time.Time{} } // UpdatePacketSent increments packet/byte counters and updates timestamp for a sent application packet. func (p *CandidatePair) UpdatePacketSent(n int) { if n <= 0 { return } atomic.AddUint32(&p.packetsSent, 1) atomic.AddUint64(&p.bytesSent, uint64(n)) // #nosec G115 -- n > 0 validated above p.lastPacketSentAt.Store(time.Now()) } // UpdatePacketReceived increments packet/byte counters and updates timestamp for a received application packet. func (p *CandidatePair) UpdatePacketReceived(n int) { if n <= 0 { return } atomic.AddUint32(&p.packetsReceived, 1) atomic.AddUint64(&p.bytesReceived, uint64(n)) // #nosec G115 -- n > 0 validated above p.lastPacketReceivedAt.Store(time.Now()) } // FirstRequestSentAt returns the timestamp of the first connectivity check sent. func (p *CandidatePair) FirstRequestSentAt() time.Time { if v, ok := p.firstRequestSentAt.Load().(time.Time); ok { return v } return time.Time{} } // LastRequestSentAt returns the timestamp of the last connectivity check sent. func (p *CandidatePair) LastRequestSentAt() time.Time { if v, ok := p.lastRequestSentAt.Load().(time.Time); ok { return v } return time.Time{} } // Deprecated: use FirstResponseReceivedAt // FirstReponseReceivedAt returns the timestamp of the first connectivity response received. func (p *CandidatePair) FirstReponseReceivedAt() time.Time { return p.FirstResponseReceivedAt() } // FirstResponseReceivedAt returns the timestamp of the first connectivity response received. func (p *CandidatePair) FirstResponseReceivedAt() time.Time { if v, ok := p.firstResponseReceivedAt.Load().(time.Time); ok { return v } return time.Time{} } // LastResponseReceivedAt returns the timestamp of the last connectivity response received. func (p *CandidatePair) LastResponseReceivedAt() time.Time { if v, ok := p.lastResponseReceivedAt.Load().(time.Time); ok { return v } return time.Time{} } // FirstRequestReceivedAt returns the timestamp of the first connectivity check received. func (p *CandidatePair) FirstRequestReceivedAt() time.Time { if v, ok := p.firstRequestReceivedAt.Load().(time.Time); ok { return v } return time.Time{} } // LastRequestReceivedAt returns the timestamp of the last connectivity check received. func (p *CandidatePair) LastRequestReceivedAt() time.Time { if v, ok := p.lastRequestReceivedAt.Load().(time.Time); ok { return v } return time.Time{} } // UpdateRequestSent increments the number of requests sent and updates the timestamp. func (p *CandidatePair) UpdateRequestSent() { atomic.AddUint64(&p.requestsSent, 1) now := time.Now() p.firstRequestSentAt.CompareAndSwap(nil, now) p.lastRequestSentAt.Store(now) } // UpdateResponseSent increments the number of responses sent. func (p *CandidatePair) UpdateResponseSent() { atomic.AddUint64(&p.responsesSent, 1) } // UpdateRequestReceived increments the number of requests received and updates the timestamp. func (p *CandidatePair) UpdateRequestReceived() { atomic.AddUint64(&p.requestsReceived, 1) now := time.Now() p.firstRequestReceivedAt.CompareAndSwap(nil, now) p.lastRequestReceivedAt.Store(now) }