An implementation of TCP YeAH. More...
#include "tcp-yeah.h"
Public Member Functions | |
TcpYeah (const TcpYeah &sock) | |
Copy constructor. More... | |
TcpYeah (void) | |
Create an unbound tcp socket. More... | |
virtual | ~TcpYeah (void) |
virtual void | CongestionStateSet (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState) |
Enable/disable YeAH algorithm depending on the congestion state. More... | |
virtual Ptr< TcpCongestionOps > | Fork () |
Copy the congestion control algorithm across sockets. More... | |
virtual std::string | GetName () const |
Get the name of the congestion control algorithm. More... | |
virtual uint32_t | GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight) |
Get slow start threshold upon the receipt of 3 dupACKs. More... | |
virtual void | IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) |
Adjust cwnd following YeAH dual-mode algorithm. More... | |
virtual void | PktsAcked (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt) |
Compute RTTs needed to execute YeAH algorithm. More... | |
Public Member Functions inherited from ns3::TcpNewReno | |
TcpNewReno () | |
TcpNewReno (const TcpNewReno &sock) | |
Copy constructor. More... | |
~TcpNewReno () | |
Public Member Functions inherited from ns3::TcpCongestionOps | |
TcpCongestionOps () | |
TcpCongestionOps (const TcpCongestionOps &other) | |
Copy constructor. More... | |
virtual | ~TcpCongestionOps () |
virtual void | CongControl (Ptr< TcpSocketState > tcb, const TcpRateOps::TcpRateConnection &rc, const TcpRateOps::TcpRateSample &rs) |
Called when packets are delivered to update cwnd and pacing rate. More... | |
virtual void | CwndEvent (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event) |
Trigger events/calculations on occurrence of congestion window event. More... | |
virtual bool | HasCongControl () const |
Returns true when Congestion Control Algorithm implements CongControl. More... | |
virtual void | Init ([[maybe_unused]] Ptr< TcpSocketState > tcb) |
Set configuration required by congestion control algorithm. More... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized (void) const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= ([[maybe_unused]] const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::TcpNewReno | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::TcpCongestionOps | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
void | DisableYeah () |
Stop taking YeAH samples. More... | |
void | EnableYeah (const SequenceNumber32 &nextTxSequence) |
Enable YeAH algorithm to start taking YeAH samples. More... | |
Private Attributes | |
uint32_t | m_alpha |
Maximum backlog allowed at the bottleneck queue; Q_max in the paper. More... | |
Time | m_baseRtt |
Minimum of all YeAH RTT measurements seen during connection. More... | |
SequenceNumber32 | m_begSndNxt |
Right edge during last RTT. More... | |
uint32_t | m_cntRtt |
Number of RTT measurements during last RTT. More... | |
uint32_t | m_delta |
Log minimum fraction of cwnd to be removed on loss. More... | |
uint32_t | m_doingRenoNow |
Number of RTTs in "Slow" mode. More... | |
bool | m_doingYeahNow |
If true, do YeAH for this RTT. More... | |
uint32_t | m_epsilon |
Log maximum fraction to be removed on early decongestion. More... | |
uint32_t | m_fastCount |
Number of RTTs in "Fast" mode. More... | |
uint32_t | m_gamma |
Fraction of queue to be removed per RTT when precautionary decongestion executed. More... | |
uint32_t | m_lastQ |
Last number of packets in the bottleneck queue. More... | |
Time | m_minRtt |
Minimum of all RTTs measured within last RTT. More... | |
uint32_t | m_phy |
Maximum delta from base. More... | |
uint32_t | m_renoCount |
Estimated cwnd of competing Reno flow. More... | |
uint32_t | m_rho |
Minimum number of consecutive RTT to consider competition with Reno flows on loss. More... | |
Ptr< TcpScalable > | m_stcp |
TcpScalable object. More... | |
uint32_t | m_stcpAiFactor |
STCP additive increase parameter. More... | |
uint32_t | m_zeta |
Minimum number of state switches to reset m_renoCount. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::TcpNewReno | |
virtual void | CongestionAvoidance (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) |
NewReno congestion avoidance. More... | |
virtual uint32_t | SlowStart (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) |
Tcp NewReno slow start algorithm. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
An implementation of TCP YeAH.
YeAH-TCP (Yet Another HighSpeed TCP) is a heuristic designed to balance various requirements of a state-of-the-art congestion control algorithm: 1) fully exploit the link capacity of high BDP networks while inducing a small number of congestion events 2) compete friendly with Reno flows 3) achieve intra and RTT fairness 4) robust to random losses 5) achieve high performance regardless of buffer size
YeAH operates between 2 modes: Fast and Slow mode. In the Fast mode when the queue occupancy is small and the network congestion level is low, YeAH increments its congestion window according to the aggressive STCP rule. When the number of packets in the queue grows beyond a threshold and the network congestion level is high, YeAH enters its Slow mode, acting as Reno with a decongestion algorithm. YeAH employs Vegas' mechanism for calculating the backlog as in Equation (1). The estimation of the network congestion level is shown in Equation (2).
Q = (RTT - BaseRTT) (cwnd / RTT) (1) L = (RTT - BaseRTT) / BaseRTT (2)
To ensure TCP friendliness, YeAH also implements an algorithm to detect the presence of legacy Reno flows. Upon the receipt of 3 duplicate ACKs, YeAH decreases its slow start threshold according to Equation (3) if it's not competing with Reno flows. Otherwise, the ssthresh is halved as in Reno.
ssthresh = min{max{cwnd/8, Q}, cwnd/2}
More information: http://www.csc.lsu.edu/~sjpark/cs7601/4-YeAH_TCP.pdf
ns3::TcpYeah is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).
Definition at line 72 of file tcp-yeah.h.
ns3::TcpYeah::TcpYeah | ( | void | ) |
Create an unbound tcp socket.
Definition at line 79 of file tcp-yeah.cc.
References m_stcp, m_stcpAiFactor, and NS_LOG_FUNCTION.
ns3::TcpYeah::TcpYeah | ( | const TcpYeah & | sock | ) |
Copy constructor.
sock | the object to copy |
Definition at line 105 of file tcp-yeah.cc.
References ns3::Object::CopyObject, m_stcp, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 129 of file tcp-yeah.cc.
References NS_LOG_FUNCTION.
|
virtual |
Enable/disable YeAH algorithm depending on the congestion state.
We only start a YeAH cycle when we are in normal congestion state (CA_OPEN state).
tcb | internal congestion state |
newState | new congestion state to which the TCP is going to switch |
Reimplemented from ns3::TcpCongestionOps.
Definition at line 182 of file tcp-yeah.cc.
References ns3::TcpSocketState::CA_OPEN, DisableYeah(), EnableYeah(), ns3::TcpSocketState::m_nextTxSequence, and NS_LOG_FUNCTION.
|
private |
Stop taking YeAH samples.
Definition at line 174 of file tcp-yeah.cc.
References m_doingYeahNow, and NS_LOG_FUNCTION.
Referenced by CongestionStateSet().
|
private |
Enable YeAH algorithm to start taking YeAH samples.
YeAH algorithm is enabled in the following situations:
nextTxSequence | Sequence to transmit next |
Definition at line 163 of file tcp-yeah.cc.
References m_begSndNxt, m_cntRtt, m_doingYeahNow, m_minRtt, ns3::Time::Max(), and NS_LOG_FUNCTION.
Referenced by CongestionStateSet().
|
virtual |
Copy the congestion control algorithm across sockets.
Reimplemented from ns3::TcpNewReno.
Definition at line 135 of file tcp-yeah.cc.
|
virtual |
Get the name of the congestion control algorithm.
Reimplemented from ns3::TcpNewReno.
Definition at line 310 of file tcp-yeah.cc.
|
virtual |
Get slow start threshold upon the receipt of 3 dupACKs.
tcb | internal congestion state |
bytesInFlight | number of outstanding bytes |
Reimplemented from ns3::TcpNewReno.
Definition at line 316 of file tcp-yeah.cc.
References m_delta, m_doingRenoNow, m_fastCount, m_lastQ, m_renoCount, m_rho, max, min, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_LOGIC.
|
static |
Get the type ID.
Definition at line 37 of file tcp-yeah.cc.
References m_alpha, m_delta, m_epsilon, m_gamma, m_phy, m_rho, m_stcpAiFactor, m_zeta, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().
|
virtual |
Adjust cwnd following YeAH dual-mode algorithm.
tcb | internal congestion state |
segmentsAcked | count of segments ACKed |
Reimplemented from ns3::TcpNewReno.
Definition at line 198 of file tcp-yeah.cc.
References ns3::TcpNewReno::CongestionAvoidance(), ns3::TcpSocketState::GetCwndInSegments(), ns3::Time::GetMilliSeconds(), ns3::Time::GetSeconds(), m_alpha, m_baseRtt, m_begSndNxt, m_cntRtt, ns3::TcpSocketState::m_cWnd, m_doingRenoNow, m_epsilon, m_fastCount, m_gamma, ns3::TcpSocketState::m_lastAckedSeq, m_lastQ, m_minRtt, ns3::TcpSocketState::m_nextTxSequence, m_phy, m_renoCount, ns3::TcpSocketState::m_segmentSize, ns3::TcpSocketState::m_ssThresh, m_stcp, m_zeta, ns3::Time::Max(), max, min, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and ns3::TcpNewReno::SlowStart().
|
virtual |
Compute RTTs needed to execute YeAH algorithm.
The function filters RTT samples from the last RTT to find the current smallest propagation delay + queueing delay (minRtt). We take the minimum to avoid the effects of delayed ACKs.
The function also min-filters all RTT measurements seen to find the propagation delay (baseRtt).
tcb | internal congestion state |
segmentsAcked | count of segments ACKed |
rtt | last RTT |
Reimplemented from ns3::TcpCongestionOps.
Definition at line 141 of file tcp-yeah.cc.
References ns3::Time::GetMilliSeconds(), ns3::Time::IsZero(), m_baseRtt, m_cntRtt, m_minRtt, min, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
private |
Maximum backlog allowed at the bottleneck queue; Q_max in the paper.
Definition at line 166 of file tcp-yeah.h.
Referenced by GetTypeId(), and IncreaseWindow().
|
private |
Minimum of all YeAH RTT measurements seen during connection.
Definition at line 176 of file tcp-yeah.h.
Referenced by IncreaseWindow(), and PktsAcked().
|
private |
Right edge during last RTT.
Definition at line 180 of file tcp-yeah.h.
Referenced by EnableYeah(), and IncreaseWindow().
|
private |
Number of RTT measurements during last RTT.
Definition at line 178 of file tcp-yeah.h.
Referenced by EnableYeah(), IncreaseWindow(), and PktsAcked().
|
private |
Log minimum fraction of cwnd to be removed on loss.
Definition at line 168 of file tcp-yeah.h.
Referenced by GetSsThresh(), and GetTypeId().
|
private |
Number of RTTs in "Slow" mode.
Definition at line 182 of file tcp-yeah.h.
Referenced by GetSsThresh(), and IncreaseWindow().
|
private |
If true, do YeAH for this RTT.
Definition at line 179 of file tcp-yeah.h.
Referenced by DisableYeah(), and EnableYeah().
|
private |
Log maximum fraction to be removed on early decongestion.
Definition at line 169 of file tcp-yeah.h.
Referenced by GetTypeId(), and IncreaseWindow().
|
private |
Number of RTTs in "Fast" mode.
Definition at line 184 of file tcp-yeah.h.
Referenced by GetSsThresh(), and IncreaseWindow().
|
private |
Fraction of queue to be removed per RTT when precautionary decongestion executed.
Definition at line 167 of file tcp-yeah.h.
Referenced by GetTypeId(), and IncreaseWindow().
|
private |
Last number of packets in the bottleneck queue.
Definition at line 181 of file tcp-yeah.h.
Referenced by GetSsThresh(), and IncreaseWindow().
|
private |
Minimum of all RTTs measured within last RTT.
Definition at line 177 of file tcp-yeah.h.
Referenced by EnableYeah(), IncreaseWindow(), and PktsAcked().
|
private |
Maximum delta from base.
Definition at line 170 of file tcp-yeah.h.
Referenced by GetTypeId(), and IncreaseWindow().
|
private |
Estimated cwnd of competing Reno flow.
Definition at line 183 of file tcp-yeah.h.
Referenced by GetSsThresh(), and IncreaseWindow().
|
private |
Minimum number of consecutive RTT to consider competition with Reno flows on loss.
Definition at line 171 of file tcp-yeah.h.
Referenced by GetSsThresh(), and GetTypeId().
|
private |
TcpScalable object.
Definition at line 175 of file tcp-yeah.h.
Referenced by TcpYeah(), and IncreaseWindow().
|
private |
STCP additive increase parameter.
Definition at line 174 of file tcp-yeah.h.
Referenced by TcpYeah(), and GetTypeId().
|
private |
Minimum number of state switches to reset m_renoCount.
Definition at line 172 of file tcp-yeah.h.
Referenced by GetTypeId(), and IncreaseWindow().