Interface for all operations that involve a Rate monitoring for TCP. More...

#include "tcp-rate-ops.h"

Inheritance diagram for ns3::TcpRateOps:

Collaboration diagram for ns3::TcpRateOps:

Classes
struct	TcpRateConnection
	Information about the connection rate. More...

struct	TcpRateSample
	Rate Sample structure. More...

Public Member Functions
virtual void	CalculateAppLimited (uint32_t cWnd, uint32_t in_flight, uint32_t segmentSize, const SequenceNumber32 &tailSeq, const SequenceNumber32 &nextTx, const uint32_t lostOut, const uint32_t retransOut)=0
	If a gap is detected between sends, it means we are app-limited. More...

virtual const TcpRateSample &	GenerateSample (uint32_t delivered, uint32_t lost, bool is_sack_reneg, uint32_t priorInFlight, const Time &minRtt)=0
	Generate a TcpRateSample to feed a congestion avoidance algorithm. More...

virtual const TcpRateConnection &	GetConnectionRate ()=0

virtual void	SkbDelivered (TcpTxItem *skb)=0
	Update the Rate information after an item is received. More...

virtual void	SkbSent (TcpTxItem *skb, bool isStartOfTransmission)=0
	Put the rate information inside the sent skb. 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::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...

Additional Inherited Members
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...

Detailed Description

Interface for all operations that involve a Rate monitoring for TCP.

Introspection did not find any typical Config paths.

The interface is meant to take information to generate rate information valid for congestion avoidance algorithm such as BBR.

Please take a look to the TcpRateLinux class for an example.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

Definition at line 38 of file tcp-rate-ops.h.

Member Function Documentation

◆ CalculateAppLimited()

virtual void ns3::TcpRateOps::CalculateAppLimited	(	uint32_t	cWnd,
		uint32_t	in_flight,
		uint32_t	segmentSize,
		const SequenceNumber32 &	tailSeq,
		const SequenceNumber32 &	nextTx,
		const uint32_t	lostOut,
		const uint32_t	retransOut
	)

pure virtual

If a gap is detected between sends, it means we are app-limited.

TODO What the Linux kernel is setting in tp->app_limited? https://elixir.bootlin.com/linux/latest/source/net/ipv4/tcp_rate.c#L177

Parameters

cWnd	Congestion Window
in_flight	In Flight size (in bytes)
segmentSize	Segment size
tailSeq	Tail Sequence
nextTx	NextTx
lostOut	Number of lost bytes
retransOut	Number of retransmitted bytes

Implemented in ns3::TcpRateLinux.

Referenced by ns3::TcpSocketBase::Send().

Here is the caller graph for this function:

◆ GenerateSample()

virtual const TcpRateSample& ns3::TcpRateOps::GenerateSample	(	uint32_t	delivered,
		uint32_t	lost,
		bool	is_sack_reneg,
		uint32_t	priorInFlight,
		const Time &	minRtt
	)

pure virtual

Generate a TcpRateSample to feed a congestion avoidance algorithm.

This function will be called after an ACK (or a SACK) is received. The (S)ACK carries some implicit information, such as how many segments have been lost or delivered. These values will be this function input.

Parameters

delivered	number of delivered segments (e.g., receiving a cumulative ACK means having more than 1 segment delivered) relative to the most recent (S)ACK received
lost	number of segments that we detected as lost after the reception of the most recent (S)ACK
priorInFlight	number of segments previously considered in flight
is_sack_reneg	Is SACK reneged?
minRtt	Minimum RTT so far

Returns: The TcpRateSample that will be used for CA

Implemented in ns3::TcpRateLinux.

Referenced by ns3::TcpSocketBase::ReceivedAck(), and TcpRateLinuxWithBufferTest::TestWithSackBlocks().

Here is the caller graph for this function:

◆ GetConnectionRate()

virtual const TcpRateConnection& ns3::TcpRateOps::GetConnectionRate ( )

pure virtual

Returns: The information about the rate connection

Implemented in ns3::TcpRateLinux.

Referenced by ns3::TcpSocketBase::ReceivedAck().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::TcpRateOps::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 29 of file tcp-rate-ops.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SkbDelivered()

virtual void ns3::TcpRateOps::SkbDelivered ( TcpTxItem * skb )

pure virtual

Update the Rate information after an item is received.

When an skb is sacked or acked, we fill in the rate sample with the (prior) delivery information when the skb was last transmitted.

If an ACK (s)acks multiple skbs (e.g., stretched-acks), this function is called multiple times. We favor the information from the most recently sent skb, i.e., the skb with the highest prior_delivered count.

Parameters