DynamicQueueLimits would be used in conjunction with a producer/consumer type queue (possibly a netdevice queue). More...

#include "dynamic-queue-limits.h"

Inheritance diagram for ns3::DynamicQueueLimits:

Collaboration diagram for ns3::DynamicQueueLimits:

Public Member Functions
	DynamicQueueLimits ()

	~DynamicQueueLimits () override

int32_t	Available () const override
	Available is called from NotifyTransmittedBytes to calculate the number of bytes that can be passed again to the NetDevice.

void	Completed (uint32_t count) override
	Record number of completed bytes and recalculate the limit.

void	Queued (uint32_t count) override
	Record the number of bytes queued.

void	Reset () override
	Reset queue limits state.

Public Member Functions inherited from ns3::QueueLimits
	~QueueLimits () override

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::QueueLimits
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.

Private Member Functions
int32_t	Posdiff (int32_t a, int32_t b)
	Calculates the difference between the two operators and returns the number if positive, zero otherwise.

Private Attributes
uint32_t	m_adjLimit {0}
	limit + num_completed

uint32_t	m_lastObjCnt {0}
	Count at last queuing.

TracedValue< uint32_t >	m_limit
	Current limit.

uint32_t	m_lowestSlack {std::numeric_limits<uint32_t>::max()}
	Lowest slack found.

uint32_t	m_maxLimit
	Max limit.

uint32_t	m_minLimit
	Minimum limit.

uint32_t	m_numCompleted {0}
	Total ever completed.

uint32_t	m_numQueued {0}
	Total ever queued.

uint32_t	m_prevLastObjCnt {0}
	Previous queuing cnt.

uint32_t	m_prevNumQueued {0}
	Previous queue total.

uint32_t	m_prevOvlimit {0}
	Previous over limit.

Time	m_slackHoldTime
	Time to measure slack.

Time	m_slackStartTime {Seconds(0)}
	Time slacks seen.

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

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

DynamicQueueLimits would be used in conjunction with a producer/consumer type queue (possibly a netdevice queue).

Such a queue would have these general properties:

1) Objects are queued up to some limit specified as number of objects. 2) Periodically a completion process executes which retires consumed objects. 3) Starvation occurs when limit has been reached, all queued data has actually been consumed, but completion processing has not yet run so queuing new data is blocked. 4) Minimizing the amount of queued data is desirable.

The goal of DynamicQueueLimits is to calculate the limit as the minimum number of objects needed to prevent starvation.

The primary functions of DynamicQueueLimits are: Completed - called at completion time to indicate how many objects were retired from the queue Available - returns how many objects are available to be queued based on the object limit and how many objects are already enqueued Queued - called when objects are enqueued to record number of objects

Definition at line 54 of file dynamic-queue-limits.h.

Constructor & Destructor Documentation

◆ DynamicQueueLimits()

ns3::DynamicQueueLimits::DynamicQueueLimits ( )

Definition at line 63 of file dynamic-queue-limits.cc.

References NS_LOG_FUNCTION, and Reset().

Here is the call graph for this function:

◆ ~DynamicQueueLimits()

ns3::DynamicQueueLimits::~DynamicQueueLimits ( )

override

Definition at line 69 of file dynamic-queue-limits.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Available()

int32_t ns3::DynamicQueueLimits::Available ( ) const

overridevirtual

Available is called from NotifyTransmittedBytes to calculate the number of bytes that can be passed again to the NetDevice.

A negative value means that no packets can be passed to the NetDevice. In this case, NotifyTransmittedBytes stops the transmission queue.

Returns how many bytes can be queued

Returns: the number of bytes that can be queued

Implements ns3::QueueLimits.

Definition at line 200 of file dynamic-queue-limits.cc.

References m_adjLimit, m_numQueued, and NS_LOG_FUNCTION.

◆ Completed()

void ns3::DynamicQueueLimits::Completed ( uint32_t count )

overridevirtual

Record number of completed bytes and recalculate the limit.

Parameters

count the number of completed bytes

Implements ns3::QueueLimits.

Definition at line 91 of file dynamic-queue-limits.cc.

References m_adjLimit, m_lastObjCnt, m_limit, m_lowestSlack, m_maxLimit, m_minLimit, m_numCompleted, m_numQueued, m_prevLastObjCnt, m_prevNumQueued, m_prevOvlimit, m_slackHoldTime, m_slackStartTime, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, Posdiff(), and UINTMAX.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::DynamicQueueLimits::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 34 of file dynamic-queue-limits.cc.

References DQL_MAX_LIMIT, m_limit, m_maxLimit, m_minLimit, m_slackHoldTime, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Posdiff()

int32_t ns3::DynamicQueueLimits::Posdiff	(	int32_t	a,
		int32_t	b )

private

Calculates the difference between the two operators and returns the number if positive, zero otherwise.

Parameters

a	First operator.
b	Second operator.

Returns: the difference between a and b if positive, zero otherwise.

Definition at line 217 of file dynamic-queue-limits.cc.

References NS_LOG_FUNCTION.

Referenced by Completed().

Here is the caller graph for this function:

◆ Queued()

void ns3::DynamicQueueLimits::Queued ( uint32_t count )

overridevirtual

Record the number of bytes queued.

Parameters

count the number of bytes queued

Implements ns3::QueueLimits.

Definition at line 207 of file dynamic-queue-limits.cc.

References DQL_MAX_OBJECT, m_lastObjCnt, m_numQueued, NS_ASSERT, and NS_LOG_FUNCTION.

◆ Reset()

void ns3::DynamicQueueLimits::Reset ( )

overridevirtual

Reset queue limits state.

Implements ns3::QueueLimits.

Definition at line 75 of file dynamic-queue-limits.cc.

References m_lastObjCnt, m_limit, m_lowestSlack, m_numCompleted, m_numQueued, m_prevLastObjCnt, m_prevNumQueued, m_prevOvlimit, m_slackStartTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, and UINTMAX.

Referenced by DynamicQueueLimits().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_adjLimit

uint32_t ns3::DynamicQueueLimits::m_adjLimit {0}

private

limit + num_completed

Definition at line 83 of file dynamic-queue-limits.h.

Referenced by Available(), and Completed().

◆ m_lastObjCnt

uint32_t ns3::DynamicQueueLimits::m_lastObjCnt {0}

private

Count at last queuing.

Definition at line 84 of file dynamic-queue-limits.h.

Referenced by Completed(), Queued(), and Reset().

◆ m_limit

TracedValue<uint32_t> ns3::DynamicQueueLimits::m_limit

private

Current limit.

Definition at line 87 of file dynamic-queue-limits.h.

Referenced by Completed(), GetTypeId(), and Reset().

◆ m_lowestSlack

uint32_t ns3::DynamicQueueLimits::m_lowestSlack {std::numeric_limits<uint32_t>::max()}

private

Lowest slack found.

Definition at line 94 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

◆ m_maxLimit

uint32_t ns3::DynamicQueueLimits::m_maxLimit

private

Max limit.

Definition at line 98 of file dynamic-queue-limits.h.

Referenced by Completed(), and GetTypeId().

◆ m_minLimit

uint32_t ns3::DynamicQueueLimits::m_minLimit

private

Minimum limit.

Definition at line 99 of file dynamic-queue-limits.h.

Referenced by Completed(), and GetTypeId().

◆ m_numCompleted

uint32_t ns3::DynamicQueueLimits::m_numCompleted {0}

private

Total ever completed.

Definition at line 88 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

◆ m_numQueued

uint32_t ns3::DynamicQueueLimits::m_numQueued {0}

private

Total ever queued.

Definition at line 82 of file dynamic-queue-limits.h.

Referenced by Available(), Completed(), Queued(), and Reset().

◆ m_prevLastObjCnt

uint32_t ns3::DynamicQueueLimits::m_prevLastObjCnt {0}

private

Previous queuing cnt.

Definition at line 92 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

◆ m_prevNumQueued

uint32_t ns3::DynamicQueueLimits::m_prevNumQueued {0}

private

Previous queue total.

Definition at line 91 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

◆ m_prevOvlimit

uint32_t ns3::DynamicQueueLimits::m_prevOvlimit {0}

private

Previous over limit.

Definition at line 90 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

◆ m_slackHoldTime

Time ns3::DynamicQueueLimits::m_slackHoldTime

private

Time to measure slack.

Definition at line 100 of file dynamic-queue-limits.h.

Referenced by Completed(), and GetTypeId().

◆ m_slackStartTime

Time ns3::DynamicQueueLimits::m_slackStartTime {Seconds(0)}

private

Time slacks seen.

Definition at line 95 of file dynamic-queue-limits.h.

Referenced by Completed(), and Reset().

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

src/network/utils/dynamic-queue-limits.h
src/network/utils/dynamic-queue-limits.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DynamicQueueLimits()

◆ ~DynamicQueueLimits()

Member Function Documentation

◆ Available()

◆ Completed()

◆ GetTypeId()

◆ Posdiff()

◆ Queued()

◆ Reset()

Member Data Documentation

◆ m_adjLimit

◆ m_lastObjCnt

◆ m_limit

◆ m_lowestSlack

◆ m_maxLimit

◆ m_minLimit

◆ m_numCompleted

◆ m_numQueued

◆ m_prevLastObjCnt

◆ m_prevNumQueued

◆ m_prevOvlimit

◆ m_slackHoldTime

◆ m_slackStartTime