Reno congestion control algorithm. More...

#include "tcp-linux-reno.h"

Inheritance diagram for ns3::TcpLinuxReno:

Collaboration diagram for ns3::TcpLinuxReno:

Public Member Functions
	TcpLinuxReno ()

	TcpLinuxReno (const TcpLinuxReno &sock)
	Copy constructor.

	~TcpLinuxReno () override

Ptr< TcpCongestionOps >	Fork () override
	Copy the congestion control algorithm across sockets.

std::string	GetName () const override
	Get the name of the congestion control algorithm.

uint32_t	GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight) override
	Get the slow start threshold after a loss event.

void	IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) override
	Congestion avoidance algorithm implementation.

Public Member Functions inherited from ns3::TcpCongestionOps
	TcpCongestionOps ()

	TcpCongestionOps (const TcpCongestionOps &other)
	Copy constructor.

	~TcpCongestionOps () override

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.

virtual void	CongestionStateSet (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState)
	Trigger events/calculations specific to a congestion state.

virtual void	CwndEvent (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event)
	Trigger events/calculations on occurrence of congestion window event.

virtual bool	HasCongControl () const
	Returns true when Congestion Control Algorithm implements CongControl.

virtual void	Init (Ptr< TcpSocketState > tcb)
	Set configuration required by congestion control algorithm.

virtual void	PktsAcked (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt)
	Timing information on received ACK.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::TcpCongestionOps
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
virtual void	CongestionAvoidance (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
	Congestion avoidance phase handler.

void	SetSuppressIncreaseIfCwndLimited (bool value)
	TcpSocketBase follows the Linux way of setting a flag 'isCwndLimited' when BytesInFlight() >= cwnd.

virtual uint32_t	SlowStart (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
	Slow start phase handler.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Attributes
uint32_t	m_cWndCnt {0}
	Linear increase counter.

bool	m_suppressIncreaseIfCwndLimited
	Suppress window increase if TCP is not cwnd limited.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Reno congestion control algorithm.

This class implement the Reno congestion control type and it mimics the one implemented in the Linux kernel.

Definition at line 28 of file tcp-linux-reno.h.

Constructor & Destructor Documentation

◆ TcpLinuxReno() [1/2]

ns3::TcpLinuxReno::TcpLinuxReno ( )

Definition at line 32 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ TcpLinuxReno() [2/2]

ns3::TcpLinuxReno::TcpLinuxReno ( const TcpLinuxReno & sock )

Copy constructor.

Parameters

sock	object to copy.

Definition at line 38 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ ~TcpLinuxReno()

ns3::TcpLinuxReno::~TcpLinuxReno ( )

override

Definition at line 44 of file tcp-linux-reno.cc.

Member Function Documentation

◆ CongestionAvoidance()

void ns3::TcpLinuxReno::CongestionAvoidance	(	Ptr< TcpSocketState >	tcb,
		uint32_t	segmentsAcked )

protectedvirtual

Congestion avoidance phase handler.

Parameters

tcb	Transmission Control Block of the connection
segmentsAcked	count of segments acked

Definition at line 67 of file tcp-linux-reno.cc.

References m_cWndCnt, m_suppressIncreaseIfCwndLimited, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by IncreaseWindow().

Here is the caller graph for this function:

◆ Fork()

Ptr< TcpCongestionOps > ns3::TcpLinuxReno::Fork ( )

overridevirtual

Copy the congestion control algorithm across sockets.

Returns: a pointer of the copied object

Implements ns3::TcpCongestionOps.

Definition at line 144 of file tcp-linux-reno.cc.

References ns3::Object::CopyObject.

◆ GetName()

std::string ns3::TcpLinuxReno::GetName ( ) const

overridevirtual

Get the name of the congestion control algorithm.

Returns: A string identifying the name

Implements ns3::TcpCongestionOps.

Definition at line 129 of file tcp-linux-reno.cc.

◆ GetSsThresh()

uint32_t ns3::TcpLinuxReno::GetSsThresh	(	Ptr< const TcpSocketState >	tcb,
		uint32_t	bytesInFlight )

overridevirtual

Get the slow start threshold after a loss event.

Is guaranteed that the congestion control state (TcpAckState_t) is changed BEFORE the invocation of this method. The implementer should return the slow start threshold (and not change it directly) because, in the future, the TCP implementation may require to instantly recover from a loss event (e.g. when there is a network with an high reordering factor).

Parameters

tcb	internal congestion state
bytesInFlight	total bytes in flight

Returns: Slow start threshold

Implements ns3::TcpCongestionOps.

Definition at line 135 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::TcpLinuxReno::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 23 of file tcp-linux-reno.cc.

References ns3::TypeId::SetParent().

Referenced by TcpLinuxRenoTestSuite::TcpLinuxRenoTestSuite().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IncreaseWindow()

void ns3::TcpLinuxReno::IncreaseWindow	(	Ptr< TcpSocketState >	tcb,
		uint32_t	segmentsAcked )

overridevirtual

Congestion avoidance algorithm implementation.

Mimic the function cong_avoid in Linux. New segments have been ACKed, and the congestion control duty is to update the window.

The function is allowed to change directly cWnd and/or ssThresh.

Parameters

tcb	internal congestion state
segmentsAcked	count of segments acked

Reimplemented from ns3::TcpCongestionOps.

Definition at line 110 of file tcp-linux-reno.cc.

References CongestionAvoidance(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and SlowStart().

Here is the call graph for this function:

◆ SetSuppressIncreaseIfCwndLimited()

void ns3::TcpLinuxReno::SetSuppressIncreaseIfCwndLimited ( bool value )

protected

TcpSocketBase follows the Linux way of setting a flag 'isCwndLimited' when BytesInFlight() >= cwnd.

This flag, if true, will suppress additive increase window updates for this class. However, some derived classes using the IncreaseWindow() method may not want this behavior, so this method exists to allow subclasses to set it to false.

Parameters

value Value to set whether the isCwndLimited condition suppresses window updates

Definition at line 150 of file tcp-linux-reno.cc.

References m_suppressIncreaseIfCwndLimited, and NS_LOG_FUNCTION.

Referenced by ns3::TcpDctcp::Init().

Here is the caller graph for this function:

◆ SlowStart()

uint32_t ns3::TcpLinuxReno::SlowStart	(	Ptr< TcpSocketState >	tcb,
		uint32_t	segmentsAcked )

protectedvirtual

Slow start phase handler.

Parameters

tcb	Transmission Control Block of the connection
segmentsAcked	count of segments acked

Returns: Number of segments acked minus the difference between the receiver and sender Cwnd

Definition at line 49 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by IncreaseWindow().

Here is the caller graph for this function:

Member Data Documentation

◆ m_cWndCnt

uint32_t ns3::TcpLinuxReno::m_cWndCnt {0}

private

Linear increase counter.

Definition at line 81 of file tcp-linux-reno.h.

Referenced by CongestionAvoidance().

◆ m_suppressIncreaseIfCwndLimited

bool ns3::TcpLinuxReno::m_suppressIncreaseIfCwndLimited

private

Initial value:

{

true}

Suppress window increase if TCP is not cwnd limited.

Definition at line 85 of file tcp-linux-reno.h.

Referenced by CongestionAvoidance(), and SetSuppressIncreaseIfCwndLimited().

The documentation for this class was generated from the following files:

src/internet/model/tcp-linux-reno.h
src/internet/model/tcp-linux-reno.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpLinuxReno() [1/2]

◆ TcpLinuxReno() [2/2]

◆ ~TcpLinuxReno()

Member Function Documentation

◆ CongestionAvoidance()

◆ Fork()

◆ GetName()

◆ GetSsThresh()

◆ GetTypeId()

◆ IncreaseWindow()

◆ SetSuppressIncreaseIfCwndLimited()

◆ SlowStart()

Member Data Documentation

◆ m_cWndCnt

◆ m_suppressIncreaseIfCwndLimited