A RED packet queue disc. More...

#include "red-queue-disc.h"

Inheritance diagram for ns3::RedQueueDisc:

Collaboration diagram for ns3::RedQueueDisc:

Public Types
enum	{ DTYPE_NONE , DTYPE_FORCED , DTYPE_UNFORCED }
	Drop types. More...

enum	FengStatus { Above , Between , Below }
	Used in Feng's Adaptive RED. More...

Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItem >	InternalQueue
	Internal queues store QueueDiscItem objects. More...

typedef std::function< void(Ptr< QueueDiscItem >)>	SendCallback
	Callback invoked to send a packet to the receiving object when Run is called. More...

enum	WakeMode { WAKE_ROOT = 0x00 , WAKE_CHILD = 0x01 }
	Used to determine whether the queue disc itself or its children must be activated when a netdevice wakes a transmission queue. More...

Public Member Functions
	RedQueueDisc ()
	RedQueueDisc Constructor. More...

	~RedQueueDisc () override
	Destructor. More...

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

double	GetAredAlpha ()
	Get the alpha value to adapt m_curMaxP. More...

double	GetAredBeta ()
	Get the beta value to adapt m_curMaxP. More...

double	GetFengAdaptiveA ()
	Get the alpha value to adapt m_curMaxP in Feng's Adaptive RED. More...

double	GetFengAdaptiveB ()
	Get the beta value to adapt m_curMaxP in Feng's Adaptive RED. More...

void	SetAredAlpha (double alpha)
	Set the alpha value to adapt m_curMaxP. More...

void	SetAredBeta (double beta)
	Set the beta value to adapt m_curMaxP. More...

void	SetFengAdaptiveA (double a)
	Set the alpha value to adapt m_curMaxP in Feng's Adaptive RED. More...

void	SetFengAdaptiveB (double b)
	Set the beta value to adapt m_curMaxP in Feng's Adaptive RED. More...

void	SetTh (double minTh, double maxTh)
	Set the thresh limits of RED. More...

Public Member Functions inherited from ns3::QueueDisc
	QueueDisc (const QueueDisc &)=delete

	QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit)
	Constructor. More...

	QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE)
	Constructor. More...

	~QueueDisc () override

void	AddInternalQueue (Ptr< InternalQueue > queue)
	Add an internal queue to the tail of the list of queues. More...

void	AddPacketFilter (Ptr< PacketFilter > filter)
	Add a packet filter to the tail of the list of filters used to classify packets. More...

void	AddQueueDiscClass (Ptr< QueueDiscClass > qdClass)
	Add a queue disc class to the tail of the list of classes. More...

int32_t	Classify (Ptr< QueueDiscItem > item)
	Classify a packet by calling the packet filters, one at a time, until either a filter able to classify the packet is found or all the filters have been processed. More...

Ptr< QueueDiscItem >	Dequeue ()
	Extract from the queue disc the packet that has been dequeued by calling Peek, if any, or call the private DoDequeue method (which must be implemented by derived classes) to dequeue a packet, otherwise. More...

bool	Enqueue (Ptr< QueueDiscItem > item)
	Pass a packet to store to the queue discipline. More...

QueueSize	GetCurrentSize () const
	Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise. More...

Ptr< InternalQueue >	GetInternalQueue (std::size_t i) const
	Get the i-th internal queue. More...

QueueSize	GetMaxSize () const
	Get the maximum size of the queue disc. More...

uint32_t	GetNBytes () const
	Get the amount of bytes stored by the queue disc. More...

Ptr< NetDeviceQueueInterface >	GetNetDeviceQueueInterface () const

std::size_t	GetNInternalQueues () const
	Get the number of internal queues. More...

std::size_t	GetNPacketFilters () const
	Get the number of packet filters. More...

uint32_t	GetNPackets () const
	Get the number of packets stored by the queue disc. More...

std::size_t	GetNQueueDiscClasses () const
	Get the number of queue disc classes. More...

Ptr< PacketFilter >	GetPacketFilter (std::size_t i) const
	Get the i-th packet filter. More...

Ptr< QueueDiscClass >	GetQueueDiscClass (std::size_t i) const
	Get the i-th queue disc class. More...

virtual uint32_t	GetQuota () const
	Get the maximum number of dequeue operations following a packet enqueue. More...

SendCallback	GetSendCallback () const

const Stats &	GetStats ()
	Retrieve all the collected statistics. More...

virtual WakeMode	GetWakeMode () const
	When setting up the wake callbacks on the netdevice queues, it is necessary to determine which queue disc (the root queue disc or one of its children) should be activated when the netdevice wakes one of its transmission queues. More...

QueueDisc &	operator= (const QueueDisc &)=delete

Ptr< const QueueDiscItem >	Peek ()
	Get a copy of the next packet the queue discipline will extract. More...

void	Run ()
	Modelled after the Linux function __qdisc_run (net/sched/sch_generic.c) Dequeues multiple packets, until a quota is exceeded or sending a packet to the device failed. More...

bool	SetMaxSize (QueueSize size)
	Set the maximum size of the queue disc. More...

void	SetNetDeviceQueueInterface (Ptr< NetDeviceQueueInterface > ndqi)

virtual void	SetQuota (const uint32_t quota)
	Set the maximum number of dequeue operations following a packet enqueue. More...

void	SetSendCallback (SendCallback func)

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

	~Object () override
	Destructor. More...

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

void	Dispose ()
	Dispose of this Object. More...

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

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

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated 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...

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

bool	IsInitialized () 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 () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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 errors. 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 ()
	Get the type ID. More...

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

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

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

Static Public Attributes
static constexpr const char *	FORCED_DROP = "Forced drop"
	Forced drops, m_qAvg > m_maxTh. More...

static constexpr const char *	FORCED_MARK = "Forced mark"
	Forced marks, m_qAvg > m_maxTh. More...

static constexpr const char *	UNFORCED_DROP = "Unforced drop"
	Early probability drops. More...

static constexpr const char *	UNFORCED_MARK = "Unforced mark"
	Early probability marks. More...

Static Public Attributes inherited from ns3::QueueDisc
static constexpr const char *	CHILD_QUEUE_DISC_DROP
	Packet dropped by a child queue disc. More...

static constexpr const char *	CHILD_QUEUE_DISC_MARK
	Packet marked by a child queue disc. More...

static constexpr const char *	INTERNAL_QUEUE_DROP
	Packet dropped by an internal queue. More...

Protected Member Functions
void	DoDispose () override
	Dispose of the object. More...

Protected Member Functions inherited from ns3::QueueDisc
void	DoInitialize () override
	Check whether the configuration is correct and initialize parameters. More...

void	DropAfterDequeue (Ptr< const QueueDiscItem > item, const char *reason)
	Perform the actions required when the queue disc is notified of a packet dropped after dequeue. More...

void	DropBeforeEnqueue (Ptr< const QueueDiscItem > item, const char *reason)
	Perform the actions required when the queue disc is notified of a packet dropped before enqueue. More...

bool	Mark (Ptr< QueueDiscItem > item, const char *reason)
	Marks the given packet and, if successful, updates the counters associated with the given reason. More...

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

virtual void	NotifyNewAggregate ()
	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 ()
	Notifier called once the ObjectBase is fully constructed. More...

Private Member Functions
double	CalculatePNew ()
	Returns a probability using these function parameters for the DropEarly function. More...

bool	CheckConfig () override
	Check whether the current configuration is correct. More...

Ptr< QueueDiscItem >	DoDequeue () override
	This function actually extracts a packet from the queue disc. More...

bool	DoEnqueue (Ptr< QueueDiscItem > item) override
	This function actually enqueues a packet into the queue disc. More...

Ptr< const QueueDiscItem >	DoPeek () override
	Return a copy of the next packet the queue disc will extract. More...

bool	DropEarly (Ptr< QueueDiscItem > item, uint32_t qSize)
	Check if a packet needs to be dropped due to probability mark. More...

double	Estimator (uint32_t nQueued, uint32_t m, double qAvg, double qW)
	Compute the average queue size. More...

void	InitializeParams () override
	Initialize the queue parameters. More...

double	ModifyP (double p, uint32_t size)
	Returns a probability using these function parameters for the DropEarly function. More...

void	UpdateMaxP (double newAve)
	Update m_curMaxP. More...

void	UpdateMaxPFeng (double newAve)
	Update m_curMaxP based on Feng's Adaptive RED. More...

Private Attributes
double	m_a
	Decrement parameter for m_curMaxP in Feng's Adaptive RED. More...

double	m_alpha
	Increment parameter for m_curMaxP in ARED. More...

double	m_b
	Increment parameter for m_curMaxP in Feng's Adaptive RED. More...

double	m_beta
	Decrement parameter for m_curMaxP in ARED. More...

double	m_bottom
	Lower bound for m_curMaxP in ARED. More...

uint32_t	m_cautious
	0 for default RED 1 experimental (see red-queue-disc.cc) 2 experimental (see red-queue-disc.cc) 3 use Idle packet size in the ptc More...

uint32_t	m_count
	Number of packets since last random number generation. More...

uint32_t	m_countBytes
	Number of bytes since last drop. More...

double	m_curMaxP
	Current max_p. More...

FengStatus	m_fengStatus
	For use in Feng's Adaptive RED. More...

uint32_t	m_idle
	0/1 idle status More...

uint32_t	m_idlePktSize
	Avg pkt size used during idle times. More...

Time	m_idleTime
	Start of current idle period. More...

Time	m_interval
	Time interval to update m_curMaxP. More...

bool	m_isAdaptMaxP
	True to adapt m_curMaxP. More...

bool	m_isARED
	True to enable Adaptive RED. More...

bool	m_isFengAdaptive
	True to enable Feng's Adaptive RED. More...

bool	m_isGentle
	True to increase dropping prob. More...

bool	m_isNonlinear
	True to enable Nonlinear RED. More...

bool	m_isNs1Compat
	Ns-1 compatibility. More...

bool	m_isWait
	True for waiting between dropped packets. More...

Time	m_lastSet
	Last time m_curMaxP was updated. More...

DataRate	m_linkBandwidth
	Link bandwidth. More...

Time	m_linkDelay
	Link delay. More...

double	m_lInterm
	The max probability of dropping a packet. More...

double	m_maxTh
	Maximum threshold for m_qAvg (bytes or packets), should be >= 2 * m_minTh. More...

uint32_t	m_meanPktSize
	Avg pkt size. More...

double	m_minTh
	Minimum threshold for m_qAvg (bytes or packets) More...

uint32_t	m_old
	0 when average queue first exceeds threshold More...

double	m_ptc
	packet time constant in packets/second More...

double	m_qAvg
	Average queue length. More...

double	m_qW
	Queue weight given to cur queue size sample. More...

Time	m_rtt
	Rtt to be considered while automatically setting m_bottom in ARED. More...

Time	m_targetDelay
	Target average queuing delay in ARED. More...

double	m_top
	Upper bound for m_curMaxP in ARED. More...

bool	m_useEcn
	True if ECN is used (packets are marked instead of being dropped) More...

bool	m_useHardDrop
	True if packets are always dropped above max threshold. More...

Ptr< UniformRandomVariable >	m_uv
	rng stream More...

double	m_vA
	1.0 / (m_maxTh - m_minTh) More...

double	m_vB
	-m_minTh / (m_maxTh - m_minTh) More...

double	m_vC
	(1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode More...

double	m_vD
	2.0 * m_curMaxP - 1.0 - used in "gentle" mode More...

double	m_vProb
	Prob. More...

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

Detailed Description

A RED packet queue disc.

Definition at line 80 of file red-queue-disc.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Drop types.

Enumerator
DTYPE_NONE	Ok, no drop.
DTYPE_FORCED	A "forced" drop.
DTYPE_UNFORCED	An "unforced" (random) drop.

Definition at line 115 of file red-queue-disc.h.

◆ FengStatus

enum ns3::RedQueueDisc::FengStatus

Used in Feng's Adaptive RED.

Enumerator
Above	When m_qAvg > m_maxTh.
Between	When m_maxTh < m_qAvg < m_minTh.
Below	When m_qAvg < m_minTh.

Definition at line 105 of file red-queue-disc.h.

Constructor & Destructor Documentation

◆ RedQueueDisc()

ns3::RedQueueDisc::RedQueueDisc ( )

RedQueueDisc Constructor.

Create a RED queue disc

Definition at line 228 of file red-queue-disc.cc.

References m_uv, and NS_LOG_FUNCTION.

◆ ~RedQueueDisc()

ns3::RedQueueDisc::~RedQueueDisc ( )

override

Destructor.

Destructor

Definition at line 235 of file red-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::RedQueueDisc::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 334 of file red-queue-disc.cc.

References m_uv, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ CalculatePNew()

double ns3::RedQueueDisc::CalculatePNew ( )

private

Returns a probability using these function parameters for the DropEarly function.

Returns: Prob. of packet drop before "count"

Definition at line 717 of file red-queue-disc.cc.

References m_curMaxP, m_isGentle, m_isNonlinear, m_maxTh, m_qAvg, m_vA, m_vB, m_vC, m_vD, and NS_LOG_FUNCTION.

Referenced by DropEarly().

Here is the caller graph for this function:

◆ CheckConfig()

bool ns3::RedQueueDisc::CheckConfig ( )

overrideprivatevirtual

Check whether the current configuration is correct.

Default objects (such as internal queues) might be created by this method to ensure the configuration is correct. This method is automatically called at simulation initialization time, and it is called before the InitializeParams () method. It is appropriate to promote parameter initialization to this method if it aids in checking for correct configuration.

See also: QueueDisc::InitializeParams

Returns: true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 859 of file red-queue-disc.cc.

References ns3::QueueDisc::AddInternalQueue(), ns3::CreateObjectWithAttributes(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_isAdaptMaxP, m_isARED, m_isFengAdaptive, NS_LOG_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::RedQueueDisc::DoDequeue ( )

overrideprivatevirtual

This function actually extracts a packet from the queue disc.

Returns: 0 if the operation was not successful; the item otherwise.

Implements ns3::QueueDisc.

Definition at line 814 of file red-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), m_idle, m_idleTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ DoDispose()

void ns3::RedQueueDisc::DoDispose ( void )

overrideprotectedvirtual

Dispose of the object.

Reimplemented from ns3::QueueDisc.

Definition at line 241 of file red-queue-disc.cc.

References ns3::QueueDisc::DoDispose(), m_uv, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoEnqueue()

bool ns3::RedQueueDisc::DoEnqueue ( Ptr< QueueDiscItem > item )

overrideprivatevirtual

This function actually enqueues a packet into the queue disc.

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Implements ns3::QueueDisc.

Definition at line 342 of file red-queue-disc.cc.

References ns3::QueueDisc::DropBeforeEnqueue(), DropEarly(), DTYPE_FORCED, DTYPE_NONE, DTYPE_UNFORCED, Estimator(), FORCED_DROP, FORCED_MARK, ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), two-ray-to-three-gpp-ch-calibration::m, m_cautious, m_count, m_countBytes, m_idle, m_idlePktSize, m_idleTime, m_isGentle, m_isNs1Compat, m_maxTh, m_meanPktSize, m_minTh, m_old, m_ptc, m_qAvg, m_qW, m_useEcn, m_useHardDrop, m_vProb, ns3::QueueDisc::Mark(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, UNFORCED_DROP, and UNFORCED_MARK.

Here is the call graph for this function:

◆ DoPeek()

Ptr< const QueueDiscItem > ns3::RedQueueDisc::DoPeek ( )

overrideprivatevirtual

Return a copy of the next packet the queue disc will extract.

The implementation of this method is based on the qdisc_peek_dequeued function of the Linux kernel, which dequeues a packet and retains it in the queue disc as a requeued packet. The packet is not traced as requeued, nor is the total count of requeued packets increased. The packet is still considered to be part of the queue disc and the dequeue trace is fired when Dequeue is called and the packet is actually extracted from the queue disc.

This approach is especially recommended for queue discs for which it is not obvious what is the next packet that will be dequeued (e.g., queue discs having multiple internal queues or child queue discs or queue discs that drop packets after dequeue). Subclasses can however provide their own implementation of this method that overrides the default one.

Returns: 0 if the operation was not successful; the packet otherwise.

Reimplemented from ns3::QueueDisc.

Definition at line 841 of file red-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ DropEarly()

bool ns3::RedQueueDisc::DropEarly	(	Ptr< QueueDiscItem >	item,
		uint32_t	qSize
	)

private

Check if a packet needs to be dropped due to probability mark.

Parameters

item	queue item
qSize	queue size

Returns: false for no drop/mark, true for drop

Todo:: Implement set bit to mark

Definition at line 655 of file red-queue-disc.cc.

References CalculatePNew(), ns3::UniformRandomVariable::GetValue(), m_cautious, m_count, m_countBytes, m_ptc, m_qAvg, m_qW, m_uv, m_vProb, ModifyP(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Estimator()

double ns3::RedQueueDisc::Estimator	(	uint32_t	nQueued,
		uint32_t	m,
		double	qAvg,
		double	qW
	)

private

Compute the average queue size.

Parameters

nQueued	number of queued packets
m	simulated number of packets arrival during idle period
qAvg	average queue size
qW	queue weight given to cur q size sample

Returns: new average queue size

Definition at line 633 of file red-queue-disc.cc.

References two-ray-to-three-gpp-ch-calibration::m, m_interval, m_isAdaptMaxP, m_isFengAdaptive, m_lastSet, ns3::Simulator::Now(), NS_LOG_FUNCTION, UpdateMaxP(), and UpdateMaxPFeng().

Referenced by DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAredAlpha()

double ns3::RedQueueDisc::GetAredAlpha ( )

Get the alpha value to adapt m_curMaxP.

Returns: The alpha value to adapt m_curMaxP.

Definition at line 261 of file red-queue-disc.cc.

References m_alpha, and NS_LOG_FUNCTION.

◆ GetAredBeta()

double ns3::RedQueueDisc::GetAredBeta ( )

Get the beta value to adapt m_curMaxP.

Returns: The beta value to adapt m_curMaxP.

Definition at line 280 of file red-queue-disc.cc.

References m_beta, and NS_LOG_FUNCTION.

◆ GetFengAdaptiveA()

double ns3::RedQueueDisc::GetFengAdaptiveA ( )

Get the alpha value to adapt m_curMaxP in Feng's Adaptive RED.

Returns: The alpha value to adapt m_curMaxP in Feng's Adaptive RED.

Definition at line 299 of file red-queue-disc.cc.

References m_a, and NS_LOG_FUNCTION.

◆ GetFengAdaptiveB()

double ns3::RedQueueDisc::GetFengAdaptiveB ( )

Get the beta value to adapt m_curMaxP in Feng's Adaptive RED.

Returns: The beta value to adapt m_curMaxP in Feng's Adaptive RED.

Definition at line 318 of file red-queue-disc.cc.

References m_b, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::RedQueueDisc::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 76 of file red-queue-disc.cc.

References ns3::QueueDisc::GetMaxSize(), m_bottom, m_idlePktSize, m_interval, m_isAdaptMaxP, m_isARED, m_isFengAdaptive, m_isGentle, m_isNonlinear, m_isNs1Compat, m_isWait, m_lastSet, m_linkBandwidth, m_linkDelay, m_lInterm, m_maxTh, m_meanPktSize, m_minTh, m_qW, m_rtt, m_targetDelay, m_top, m_useEcn, m_useHardDrop, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MilliSeconds(), ns3::Seconds(), SetAredAlpha(), SetAredBeta(), SetFengAdaptiveA(), SetFengAdaptiveB(), ns3::QueueDisc::SetMaxSize(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InitializeParams()

void ns3::RedQueueDisc::InitializeParams ( )

overrideprivatevirtual

Initialize the queue parameters.

Note: if the link bandwidth changes in the course of the simulation, the bandwidth-dependent RED parameters do not change. This should be fixed, but it would require some extra parameters, and didn't seem worth the trouble...

Implements ns3::QueueDisc.

Definition at line 455 of file red-queue-disc.cc.

References Above, ns3::BYTES, ns3::DataRate::GetBitRate(), ns3::QueueDisc::GetMaxSize(), ns3::Time::GetSeconds(), ns3::QueueSize::GetUnit(), m_bottom, m_cautious, m_count, m_countBytes, m_curMaxP, m_fengStatus, m_idle, m_idleTime, m_isAdaptMaxP, m_isARED, m_isFengAdaptive, m_isGentle, m_isWait, m_linkBandwidth, m_linkDelay, m_lInterm, m_maxTh, m_meanPktSize, m_minTh, m_old, m_ptc, m_qAvg, m_qW, m_rtt, m_targetDelay, m_vA, m_vB, m_vC, m_vD, ns3::NanoSeconds(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_INFO.

Here is the call graph for this function:

◆ ModifyP()

double ns3::RedQueueDisc::ModifyP	(	double	p,
		uint32_t	size
	)

private

Returns a probability using these function parameters for the DropEarly function.

Parameters

p	Prob. of packet drop before "count"
size	packet size

Returns: Prob. of packet drop

Definition at line 763 of file red-queue-disc.cc.

References ns3::BYTES, ns3::QueueDisc::GetMaxSize(), ns3::QueueSize::GetUnit(), m_count, m_countBytes, m_isWait, m_meanPktSize, and NS_LOG_FUNCTION.

Referenced by DropEarly().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAredAlpha()

void ns3::RedQueueDisc::SetAredAlpha ( double alpha )

Set the alpha value to adapt m_curMaxP.

Parameters

alpha The value of alpha to adapt m_curMaxP.

Definition at line 249 of file red-queue-disc.cc.

References m_alpha, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetAredBeta()

void ns3::RedQueueDisc::SetAredBeta ( double beta )

Set the beta value to adapt m_curMaxP.

Parameters

beta	The value of beta to adapt m_curMaxP.

Definition at line 268 of file red-queue-disc.cc.

References m_beta, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetFengAdaptiveA()

void ns3::RedQueueDisc::SetFengAdaptiveA ( double a )

Set the alpha value to adapt m_curMaxP in Feng's Adaptive RED.

Parameters

a	The value of alpha to adapt m_curMaxP in Feng's Adaptive RED.

Definition at line 287 of file red-queue-disc.cc.

References m_a, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetFengAdaptiveB()

void ns3::RedQueueDisc::SetFengAdaptiveB ( double b )

Set the beta value to adapt m_curMaxP in Feng's Adaptive RED.

Parameters

b	The value of beta to adapt m_curMaxP in Feng's Adaptive RED.

Definition at line 306 of file red-queue-disc.cc.

References m_b, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetTh()

void ns3::RedQueueDisc::SetTh	(	double	minTh,
		double	maxTh
	)

Set the thresh limits of RED.

Parameters

minTh	Minimum thresh in bytes or packets.
maxTh	Maximum thresh in bytes or packets.

Definition at line 325 of file red-queue-disc.cc.

References m_maxTh, m_minTh, NS_ASSERT, and NS_LOG_FUNCTION.

◆ UpdateMaxP()

void ns3::RedQueueDisc::UpdateMaxP ( double newAve )

private

Update m_curMaxP.

Parameters

newAve new average queue length

Definition at line 605 of file red-queue-disc.cc.

References m_alpha, m_beta, m_bottom, m_curMaxP, m_lastSet, m_maxTh, m_minTh, m_top, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by Estimator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateMaxPFeng()

void ns3::RedQueueDisc::UpdateMaxPFeng ( double newAve )

private

Update m_curMaxP based on Feng's Adaptive RED.

Parameters

newAve new average queue length

Definition at line 583 of file red-queue-disc.cc.

References Above, Below, Between, m_a, m_b, m_curMaxP, m_fengStatus, m_maxTh, m_minTh, and NS_LOG_FUNCTION.

Referenced by Estimator().

Here is the caller graph for this function:

Member Data Documentation

◆ FORCED_DROP

constexpr const char* ns3::RedQueueDisc::FORCED_DROP = "Forced drop"

staticconstexpr

Forced drops, m_qAvg > m_maxTh.

Definition at line 198 of file red-queue-disc.h.

Referenced by DoEnqueue().

◆ FORCED_MARK

constexpr const char* ns3::RedQueueDisc::FORCED_MARK = "Forced mark"

staticconstexpr

Forced marks, m_qAvg > m_maxTh.

Definition at line 201 of file red-queue-disc.h.

Referenced by DoEnqueue().

◆ m_a

double ns3::RedQueueDisc::m_a

private

Decrement parameter for m_curMaxP in Feng's Adaptive RED.

Definition at line 284 of file red-queue-disc.h.

Referenced by GetFengAdaptiveA(), SetFengAdaptiveA(), and UpdateMaxPFeng().

◆ m_alpha

double ns3::RedQueueDisc::m_alpha

private

Increment parameter for m_curMaxP in ARED.

Definition at line 278 of file red-queue-disc.h.

Referenced by GetAredAlpha(), SetAredAlpha(), and UpdateMaxP().

◆ m_b

double ns3::RedQueueDisc::m_b

private

Increment parameter for m_curMaxP in Feng's Adaptive RED.

Definition at line 283 of file red-queue-disc.h.

Referenced by GetFengAdaptiveB(), SetFengAdaptiveB(), and UpdateMaxPFeng().

◆ m_beta

double ns3::RedQueueDisc::m_beta

private

Decrement parameter for m_curMaxP in ARED.

Definition at line 279 of file red-queue-disc.h.

Referenced by GetAredBeta(), SetAredBeta(), and UpdateMaxP().

◆ m_bottom

double ns3::RedQueueDisc::m_bottom

private

Lower bound for m_curMaxP in ARED.

Definition at line 277 of file red-queue-disc.h.

Referenced by GetTypeId(), InitializeParams(), and UpdateMaxP().

◆ m_cautious

uint32_t ns3::RedQueueDisc::m_cautious

private

0 for default RED 1 experimental (see red-queue-disc.cc) 2 experimental (see red-queue-disc.cc) 3 use Idle packet size in the ptc

Definition at line 312 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

◆ m_count

uint32_t ns3::RedQueueDisc::m_count

private

Number of packets since last random number generation.

Definition at line 304 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), InitializeParams(), and ModifyP().

◆ m_countBytes

uint32_t ns3::RedQueueDisc::m_countBytes

private

Number of bytes since last drop.

Definition at line 299 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), InitializeParams(), and ModifyP().

◆ m_curMaxP

double ns3::RedQueueDisc::m_curMaxP

private

Current max_p.

Definition at line 296 of file red-queue-disc.h.

Referenced by CalculatePNew(), InitializeParams(), UpdateMaxP(), and UpdateMaxPFeng().

◆ m_fengStatus

FengStatus ns3::RedQueueDisc::m_fengStatus

private

For use in Feng's Adaptive RED.

Definition at line 305 of file red-queue-disc.h.

Referenced by InitializeParams(), and UpdateMaxPFeng().

◆ m_idle

uint32_t ns3::RedQueueDisc::m_idle

private

0/1 idle status

Definition at line 301 of file red-queue-disc.h.

Referenced by DoDequeue(), DoEnqueue(), and InitializeParams().

◆ m_idlePktSize

uint32_t ns3::RedQueueDisc::m_idlePktSize

private

Avg pkt size used during idle times.

Definition at line 265 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_idleTime

Time ns3::RedQueueDisc::m_idleTime

private

Start of current idle period.

Definition at line 313 of file red-queue-disc.h.

Referenced by DoDequeue(), DoEnqueue(), and InitializeParams().

◆ m_interval

Time ns3::RedQueueDisc::m_interval

private

Time interval to update m_curMaxP.

Definition at line 275 of file red-queue-disc.h.

Referenced by Estimator(), and GetTypeId().

◆ m_isAdaptMaxP

bool ns3::RedQueueDisc::m_isAdaptMaxP

private

True to adapt m_curMaxP.

Definition at line 269 of file red-queue-disc.h.

Referenced by CheckConfig(), Estimator(), GetTypeId(), and InitializeParams().

◆ m_isARED

bool ns3::RedQueueDisc::m_isARED

private

True to enable Adaptive RED.

Definition at line 268 of file red-queue-disc.h.

Referenced by CheckConfig(), GetTypeId(), and InitializeParams().

◆ m_isFengAdaptive

bool ns3::RedQueueDisc::m_isFengAdaptive

private

True to enable Feng's Adaptive RED.

Definition at line 281 of file red-queue-disc.h.

Referenced by CheckConfig(), Estimator(), GetTypeId(), and InitializeParams().

◆ m_isGentle

bool ns3::RedQueueDisc::m_isGentle

private

True to increase dropping prob.

slowly when m_qAvg exceeds m_maxTh

Definition at line 267 of file red-queue-disc.h.

Referenced by CalculatePNew(), DoEnqueue(), GetTypeId(), and InitializeParams().

◆ m_isNonlinear

bool ns3::RedQueueDisc::m_isNonlinear

private

True to enable Nonlinear RED.

Definition at line 282 of file red-queue-disc.h.

Referenced by CalculatePNew(), and GetTypeId().

◆ m_isNs1Compat

bool ns3::RedQueueDisc::m_isNs1Compat

private

Ns-1 compatibility.

Definition at line 285 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_isWait

bool ns3::RedQueueDisc::m_isWait

private

True for waiting between dropped packets.

Definition at line 266 of file red-queue-disc.h.

Referenced by GetTypeId(), InitializeParams(), and ModifyP().

◆ m_lastSet

Time ns3::RedQueueDisc::m_lastSet

private

Last time m_curMaxP was updated.

Definition at line 297 of file red-queue-disc.h.

Referenced by Estimator(), GetTypeId(), and UpdateMaxP().

◆ m_linkBandwidth

DataRate ns3::RedQueueDisc::m_linkBandwidth

private

Link bandwidth.

Definition at line 286 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_linkDelay

Time ns3::RedQueueDisc::m_linkDelay

private

Link delay.

Definition at line 287 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_lInterm

double ns3::RedQueueDisc::m_lInterm

private

The max probability of dropping a packet.

Definition at line 273 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_maxTh

double ns3::RedQueueDisc::m_maxTh

private

Maximum threshold for m_qAvg (bytes or packets), should be >= 2 * m_minTh.

Definition at line 271 of file red-queue-disc.h.

Referenced by CalculatePNew(), DoEnqueue(), GetTypeId(), InitializeParams(), SetTh(), UpdateMaxP(), and UpdateMaxPFeng().

◆ m_meanPktSize

uint32_t ns3::RedQueueDisc::m_meanPktSize

private

Avg pkt size.

Definition at line 264 of file red-queue-disc.h.

Referenced by DoEnqueue(), GetTypeId(), InitializeParams(), and ModifyP().

◆ m_minTh

double ns3::RedQueueDisc::m_minTh

private

Minimum threshold for m_qAvg (bytes or packets)

Definition at line 270 of file red-queue-disc.h.

Referenced by DoEnqueue(), GetTypeId(), InitializeParams(), SetTh(), UpdateMaxP(), and UpdateMaxPFeng().

◆ m_old

uint32_t ns3::RedQueueDisc::m_old

private

0 when average queue first exceeds threshold

Definition at line 300 of file red-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

◆ m_ptc

double ns3::RedQueueDisc::m_ptc

private

packet time constant in packets/second

Definition at line 302 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

◆ m_qAvg

double ns3::RedQueueDisc::m_qAvg

private

Average queue length.

Definition at line 303 of file red-queue-disc.h.

Referenced by CalculatePNew(), DoEnqueue(), DropEarly(), and InitializeParams().

◆ m_qW

double ns3::RedQueueDisc::m_qW

private

Queue weight given to cur queue size sample.

Definition at line 272 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), GetTypeId(), and InitializeParams().

◆ m_rtt

Time ns3::RedQueueDisc::m_rtt

private

Rtt to be considered while automatically setting m_bottom in ARED.

Definition at line 280 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_targetDelay

Time ns3::RedQueueDisc::m_targetDelay

private

Target average queuing delay in ARED.

Definition at line 274 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_top

double ns3::RedQueueDisc::m_top

private

Upper bound for m_curMaxP in ARED.

Definition at line 276 of file red-queue-disc.h.

Referenced by GetTypeId(), and UpdateMaxP().

◆ m_useEcn

bool ns3::RedQueueDisc::m_useEcn

private

True if ECN is used (packets are marked instead of being dropped)

Definition at line 288 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_useHardDrop

bool ns3::RedQueueDisc::m_useHardDrop

private

True if packets are always dropped above max threshold.

Definition at line 289 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_uv

Ptr<UniformRandomVariable> ns3::RedQueueDisc::m_uv

private

rng stream

Definition at line 315 of file red-queue-disc.h.

Referenced by RedQueueDisc(), AssignStreams(), DoDispose(), and DropEarly().

◆ m_vA

double ns3::RedQueueDisc::m_vA

private

1.0 / (m_maxTh - m_minTh)

Definition at line 292 of file red-queue-disc.h.

Referenced by CalculatePNew(), and InitializeParams().

◆ m_vB

double ns3::RedQueueDisc::m_vB

private

-m_minTh / (m_maxTh - m_minTh)

Definition at line 293 of file red-queue-disc.h.

Referenced by CalculatePNew(), and InitializeParams().

◆ m_vC

double ns3::RedQueueDisc::m_vC

private

(1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode

Definition at line 294 of file red-queue-disc.h.

Referenced by CalculatePNew(), and InitializeParams().

◆ m_vD

double ns3::RedQueueDisc::m_vD

private

2.0 * m_curMaxP - 1.0 - used in "gentle" mode

Definition at line 295 of file red-queue-disc.h.

Referenced by CalculatePNew(), and InitializeParams().

◆ m_vProb

double ns3::RedQueueDisc::m_vProb

private

Prob.

of packet drop

Definition at line 298 of file red-queue-disc.h.

Referenced by DoEnqueue(), and DropEarly().

◆ UNFORCED_DROP

constexpr const char* ns3::RedQueueDisc::UNFORCED_DROP = "Unforced drop"

staticconstexpr

Early probability drops.

Definition at line 197 of file red-queue-disc.h.

Referenced by DoEnqueue().

◆ UNFORCED_MARK

constexpr const char* ns3::RedQueueDisc::UNFORCED_MARK = "Unforced mark"

staticconstexpr

Early probability marks.

Definition at line 200 of file red-queue-disc.h.

Referenced by DoEnqueue().

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

src/traffic-control/model/red-queue-disc.h
src/traffic-control/model/red-queue-disc.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ FengStatus

Constructor & Destructor Documentation

◆ RedQueueDisc()

◆ ~RedQueueDisc()

Member Function Documentation

◆ AssignStreams()

◆ CalculatePNew()

◆ CheckConfig()

◆ DoDequeue()

◆ DoDispose()

◆ DoEnqueue()

◆ DoPeek()

◆ DropEarly()

◆ Estimator()

◆ GetAredAlpha()

◆ GetAredBeta()

◆ GetFengAdaptiveA()

◆ GetFengAdaptiveB()

◆ GetTypeId()

◆ InitializeParams()

◆ ModifyP()

◆ SetAredAlpha()

◆ SetAredBeta()

◆ SetFengAdaptiveA()

◆ SetFengAdaptiveB()

◆ SetTh()

◆ UpdateMaxP()

◆ UpdateMaxPFeng()

Member Data Documentation

◆ FORCED_DROP

◆ FORCED_MARK

◆ m_a

◆ m_alpha

◆ m_b

◆ m_beta

◆ m_bottom

◆ m_cautious

◆ m_count

◆ m_countBytes

◆ m_curMaxP

◆ m_fengStatus

◆ m_idle

◆ m_idlePktSize

◆ m_idleTime

◆ m_interval

◆ m_isAdaptMaxP

◆ m_isARED

◆ m_isFengAdaptive

◆ m_isGentle

◆ m_isNonlinear

◆ m_isNs1Compat

◆ m_isWait

◆ m_lastSet

◆ m_linkBandwidth

◆ m_linkDelay

◆ m_lInterm

◆ m_maxTh

◆ m_meanPktSize

◆ m_minTh

◆ m_old

◆ m_ptc

◆ m_qAvg

◆ m_qW

◆ m_rtt

◆ m_targetDelay

◆ m_top

◆ m_useEcn

◆ m_useHardDrop

◆ m_uv