A FqPie packet queue disc. More...

#include "fq-pie-queue-disc.h"

Inheritance diagram for ns3::FqPieQueueDisc:

Collaboration diagram for ns3::FqPieQueueDisc:

Public Member Functions
	FqPieQueueDisc ()
	FqPieQueueDisc constructor. More...

virtual	~FqPieQueueDisc ()

uint32_t	GetQuantum (void) const
	Get the quantum value. More...

void	SetQuantum (uint32_t quantum)
	Set the quantum value. 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...

virtual	~QueueDisc ()

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 (void)
	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 (void)
	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 (void) const
	Get the maximum size of the queue disc. More...

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

Ptr< NetDeviceQueueInterface >	GetNetDeviceQueueInterface (void) const

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

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

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

std::size_t	GetNQueueDiscClasses (void) 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 (void) const
	Get the maximum number of dequeue operations following a packet enqueue. More...

SendCallback	GetSendCallback (void) const

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

virtual WakeMode	GetWakeMode (void) 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 (void)
	Get a copy of the next packet the queue discipline will extract. More...

void	Run (void)
	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...

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

Static Public Attributes
static constexpr const char *	OVERLIMIT_DROP = "Overlimit drop"
	Overlimit dropped packets. More...

static constexpr const char *	UNCLASSIFIED_DROP = "Unclassified drop"
	No packet filter able to classify packet. More...

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

static constexpr const char *	CHILD_QUEUE_DISC_MARK = "(Marked by child queue disc) "
	Packet marked by a child queue disc. More...

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

Private Member Functions
virtual bool	CheckConfig (void)
	Check whether the current configuration is correct. More...

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

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

uint32_t	FqPieDrop (void)
	Drop a packet from the head of the queue with the largest current byte count. More...

virtual void	InitializeParams (void)
	Initialize parameters (if any) before the first packet is enqueued. More...

uint32_t	SetAssociativeHash (uint32_t flowHash)
	Compute the index of the queue for the flow having the given flowHash, according to the set associative hash approach. More...

Private Attributes
double	m_a
	Parameter to pie controller. More...

double	m_b
	Parameter to pie controller. More...

Time	m_ceThreshold
	Threshold above which to CE mark. More...

uint32_t	m_dqThreshold
	Minimum queue size in bytes before dequeue rate is measured. More...

uint32_t	m_dropBatchSize
	Max number of packets dropped from the fat flow. More...

bool	m_enableSetAssociativeHash
	whether to enable set associative hash More...

ObjectFactory	m_flowFactory
	Factory to create a new flow. More...

uint32_t	m_flows
	Number of flow queues. More...

std::map< uint32_t, uint32_t >	m_flowsIndices
	Map with the index of class for each flow. More...

bool	m_isCapDropAdjustment
	Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033. More...

double	m_markEcnTh
	ECN marking threshold (default 10% as suggested in RFC 8033) More...

Time	m_maxBurst
	Maximum burst allowed before random early dropping kicks in. More...

uint32_t	m_meanPktSize
	Average packet size in bytes. More...

std::list< Ptr< FqPieFlow > >	m_newFlows
	The list of new flows. More...

std::list< Ptr< FqPieFlow > >	m_oldFlows
	The list of old flows. More...

uint32_t	m_perturbation
	hash perturbation value More...

Time	m_qDelayRef
	Desired queue delay. More...

uint32_t	m_quantum
	Deficit assigned to flows at each round. More...

ObjectFactory	m_queueDiscFactory
	Factory to create a new queue. More...

uint32_t	m_setWays
	size of a set of queues (used by set associative hash) More...

Time	m_sUpdate
	Start time of the update timer. More...

std::map< uint32_t, uint32_t >	m_tags
	Tags used by set associative hash. More...

Time	m_tUpdate
	Time period after which CalculateP () is called. More...

bool	m_useDerandomization
	Enable Derandomization feature mentioned in RFC 8033. More...

bool	m_useDqRateEstimator
	Enable/Disable usage of dequeue rate estimator for queue delay calculation. More...

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

bool	m_useL4s
	True if L4S is used (ECT1 packets are marked at CE threshold) More...

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

Protected Member Functions inherited from ns3::QueueDisc
virtual void	DoDispose (void)
	Dispose of the object. More...

void	DoInitialize (void)
	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 (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

A FqPie packet queue disc.

Introspection did not find any typical Config paths.

Attributes

UseEcn: True to use ECN (packets are marked instead of being dropped)
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
MarkEcnThreshold: ECN marking threshold (RFC 8033 suggests 0.1 (i.e., 10%) default)
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1
- Initial value: 0.1
- Flags: construct write read
CeThreshold: The FqPie CE threshold for marking packets
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +9.22337e+18ns
- Flags: construct write read
UseL4s: True to use L4S (only ECT1 packets are marked at CE threshold)
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
MeanPktSize: Average of packet size
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1000
- Flags: construct write read
A: Value of alpha
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.125
- Flags: construct write read
B: Value of beta
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1.25
- Flags: construct write read
Tupdate: Time period to calculate drop probability
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1.5e+07ns
- Flags: construct write read
Supdate: Start time of the update timer
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read
MaxSize: The maximum number of packets accepted by this queue disc
- Set with class: QueueSizeValue
- Underlying type: QueueSize
- Initial value: 10240p
- Flags: construct write read
DequeueThreshold: Minimum queue size in bytes before dequeue rate is measured
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 16384
- Flags: construct write read
QueueDelayReference: Desired queue delay
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1.5e+07ns
- Flags: construct write read
MaxBurstAllowance: Current max burst allowance before random drop
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1.5e+08ns
- Flags: construct write read
UseDequeueRateEstimator: Enable/Disable usage of Dequeue Rate Estimator
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
UseCapDropAdjustment: Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
UseDerandomization: Enable/Disable Derandomization feature mentioned in RFC 8033
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
Flows: The number of queues into which the incoming packets are classified
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1024
- Flags: construct write read
DropBatchSize: The maximum number of packets dropped from the fat flow
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
Perturbation: The salt used as an additional input to the hash function used to classify packets
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write read
EnableSetAssociativeHash: Enable/Disable Set Associative Hash
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
SetWays: The size of a set of queues (used by set associative hash)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 8
- Flags: construct write read

Attributes defined in parent class ns3::QueueDisc

Quota: The maximum number of packets dequeued in a qdisc run
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
InternalQueueList: The list of internal queues.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Queue<QueueDiscItem>>
- Flags: read
PacketFilterList: The list of packet filters.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::PacketFilter>
- Flags: read
QueueDiscClassList: The list of queue disc classes.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::QueueDiscClass>
- Flags: read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::QueueDisc

Enqueue: Enqueue a packet in the queue disc
Callback signature: ns3::QueueDiscItem::TracedCallback
Dequeue: Dequeue a packet from the queue disc
Callback signature: ns3::QueueDiscItem::TracedCallback
Requeue: Requeue a packet in the queue disc
Callback signature: ns3::QueueDiscItem::TracedCallback
Drop: Drop a packet stored in the queue disc
Callback signature: ns3::QueueDiscItem::TracedCallback
DropBeforeEnqueue: Drop a packet before enqueue
Callback signature: ns3::QueueDiscItem::TracedCallback
DropAfterDequeue: Drop a packet after dequeue
Callback signature: ns3::QueueDiscItem::TracedCallback
Mark: Mark a packet stored in the queue disc
Callback signature: ns3::QueueDiscItem::TracedCallback
PacketsInQueue: Number of packets currently stored in the queue disc
Callback signature: ns3::TracedValueCallback::Uint32
BytesInQueue: Number of bytes currently stored in the queue disc
Callback signature: ns3::TracedValueCallback::Uint32
SojournTime: Sojourn time of the last packet dequeued from the queue disc
Callback signature: ns3::Time::TracedCallback

Size of this type is 1424 bytes (on a 64-bit architecture).

Definition at line 118 of file fq-pie-queue-disc.h.

Constructor & Destructor Documentation

◆ FqPieQueueDisc()

ns3::FqPieQueueDisc::FqPieQueueDisc ( )

FqPieQueueDisc constructor.

Definition at line 231 of file fq-pie-queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~FqPieQueueDisc()

ns3::FqPieQueueDisc::~FqPieQueueDisc ( )

virtual

Definition at line 238 of file fq-pie-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckConfig()

bool ns3::FqPieQueueDisc::CheckConfig ( void )

privatevirtual

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 452 of file fq-pie-queue-disc.cc.

References ns3::NetDevice::GetMtu(), ns3::QueueDisc::GetNetDeviceQueueInterface(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNQueueDiscClasses(), m_ceThreshold, m_enableSetAssociativeHash, m_flows, m_quantum, m_setWays, m_useEcn, m_useL4s, ns3::Time::Max(), NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::FqPieQueueDisc::DoDequeue ( void )

privatevirtual

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 368 of file fq-pie-queue-disc.cc.

References ns3::FqPieFlow::INACTIVE, m_newFlows, m_oldFlows, m_quantum, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::FqPieFlow::OLD_FLOW.

◆ DoEnqueue()

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

privatevirtual

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 286 of file fq-pie-queue-disc.cc.

References ns3::QueueDisc::AddQueueDiscClass(), ns3::QueueDisc::Classify(), ns3::ObjectFactory::Create(), ns3::QueueDisc::DropBeforeEnqueue(), FqPieDrop(), ns3::QueueDisc::GetCurrentSize(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), ns3::FqPieFlow::INACTIVE, m_ceThreshold, m_enableSetAssociativeHash, m_flowFactory, m_flows, m_flowsIndices, m_newFlows, m_perturbation, m_quantum, m_queueDiscFactory, m_useEcn, m_useL4s, ns3::FqPieFlow::NEW_FLOW, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::PacketFilter::PF_NO_MATCH, SetAssociativeHash(), ns3::ObjectBase::SetAttribute(), and UNCLASSIFIED_DROP.

Here is the call graph for this function:

◆ FqPieDrop()

uint32_t ns3::FqPieQueueDisc::FqPieDrop ( void )

private

Drop a packet from the head of the queue with the largest current byte count.

Returns: the index of the queue with the largest current byte count

Definition at line 529 of file fq-pie-queue-disc.cc.

References ns3::QueueDisc::DropAfterDequeue(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), m_dropBatchSize, NS_LOG_DEBUG, NS_LOG_FUNCTION, and OVERLIMIT_DROP.

Referenced by DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetQuantum()

uint32_t ns3::FqPieQueueDisc::GetQuantum ( void ) const

Get the quantum value.

Returns: The number of bytes each queue gets to dequeue on each round of the scheduling algorithm

Definition at line 251 of file fq-pie-queue-disc.cc.

References m_quantum.

◆ GetTypeId()

TypeId ns3::FqPieQueueDisc::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 115 of file fq-pie-queue-disc.cc.

References ns3::QueueDisc::GetMaxSize(), m_a, m_b, m_ceThreshold, m_dqThreshold, m_dropBatchSize, m_enableSetAssociativeHash, m_flows, m_isCapDropAdjustment, m_markEcnTh, m_maxBurst, m_meanPktSize, m_perturbation, m_qDelayRef, m_setWays, m_sUpdate, m_tUpdate, m_useDerandomization, m_useDqRateEstimator, m_useEcn, m_useL4s, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::Time::Max(), ns3::Seconds(), ns3::QueueDisc::SetMaxSize(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InitializeParams()

void ns3::FqPieQueueDisc::InitializeParams ( void )

privatevirtual

Initialize parameters (if any) before the first packet is enqueued.

This method is automatically called at simulation initialization time, after the CheckConfig() method has been called.

See also: QueueDisc::CheckConfig

Implements ns3::QueueDisc.

Definition at line 507 of file fq-pie-queue-disc.cc.

References ns3::QueueDisc::GetMaxSize(), m_a, m_b, m_dqThreshold, m_flowFactory, m_isCapDropAdjustment, m_maxBurst, m_meanPktSize, m_qDelayRef, m_queueDiscFactory, m_sUpdate, m_tUpdate, m_useDerandomization, m_useDqRateEstimator, NS_LOG_FUNCTION, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

◆ SetAssociativeHash()

uint32_t ns3::FqPieQueueDisc::SetAssociativeHash ( uint32_t flowHash )

private

Compute the index of the queue for the flow having the given flowHash, according to the set associative hash approach.

Parameters

flowHash the hash of the flow 5-tuple

Returns: the index of the queue for the given flow

Definition at line 257 of file fq-pie-queue-disc.cc.

References ns3::QueueDisc::GetQueueDiscClass(), ns3::FqPieFlow::INACTIVE, m_flows, m_flowsIndices, m_setWays, m_tags, and NS_LOG_FUNCTION.

Referenced by DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetQuantum()

void ns3::FqPieQueueDisc::SetQuantum ( uint32_t quantum )

Set the quantum value.

Parameters

quantum The number of bytes each queue gets to dequeue on each round of the scheduling algorithm

Definition at line 244 of file fq-pie-queue-disc.cc.

References m_quantum, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_a

double ns3::FqPieQueueDisc::m_a

private

Parameter to pie controller.

Definition at line 182 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_b

double ns3::FqPieQueueDisc::m_b

private

Parameter to pie controller.

Definition at line 183 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_ceThreshold

Time ns3::FqPieQueueDisc::m_ceThreshold

private

Threshold above which to CE mark.

Definition at line 175 of file fq-pie-queue-disc.h.

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

◆ m_dqThreshold

uint32_t ns3::FqPieQueueDisc::m_dqThreshold

private

Minimum queue size in bytes before dequeue rate is measured.

Definition at line 184 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_dropBatchSize

uint32_t ns3::FqPieQueueDisc::m_dropBatchSize

private

Max number of packets dropped from the fat flow.

Definition at line 193 of file fq-pie-queue-disc.h.

Referenced by FqPieDrop(), and GetTypeId().

◆ m_enableSetAssociativeHash

bool ns3::FqPieQueueDisc::m_enableSetAssociativeHash

private

whether to enable set associative hash

Definition at line 195 of file fq-pie-queue-disc.h.

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

◆ m_flowFactory

ObjectFactory ns3::FqPieQueueDisc::m_flowFactory

private

Factory to create a new flow.

Definition at line 203 of file fq-pie-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

◆ m_flows

uint32_t ns3::FqPieQueueDisc::m_flows

private

Number of flow queues.

Definition at line 191 of file fq-pie-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), GetTypeId(), and SetAssociativeHash().

◆ m_flowsIndices

std::map<uint32_t, uint32_t> ns3::FqPieQueueDisc::m_flowsIndices

private

Map with the index of class for each flow.

Definition at line 200 of file fq-pie-queue-disc.h.

Referenced by DoEnqueue(), and SetAssociativeHash().

◆ m_isCapDropAdjustment

bool ns3::FqPieQueueDisc::m_isCapDropAdjustment

private

Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033.

Definition at line 186 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_markEcnTh

double ns3::FqPieQueueDisc::m_markEcnTh

private

ECN marking threshold (default 10% as suggested in RFC 8033)

Definition at line 174 of file fq-pie-queue-disc.h.

Referenced by GetTypeId().

◆ m_maxBurst

Time ns3::FqPieQueueDisc::m_maxBurst

private

Maximum burst allowed before random early dropping kicks in.

Definition at line 181 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_meanPktSize

uint32_t ns3::FqPieQueueDisc::m_meanPktSize

private

Average packet size in bytes.

Definition at line 180 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_newFlows

std::list<Ptr<FqPieFlow> > ns3::FqPieQueueDisc::m_newFlows

private

The list of new flows.

Definition at line 197 of file fq-pie-queue-disc.h.

Referenced by DoDequeue(), and DoEnqueue().

◆ m_oldFlows

std::list<Ptr<FqPieFlow> > ns3::FqPieQueueDisc::m_oldFlows

private

The list of old flows.

Definition at line 198 of file fq-pie-queue-disc.h.

Referenced by DoDequeue().

◆ m_perturbation

uint32_t ns3::FqPieQueueDisc::m_perturbation

private

hash perturbation value

Definition at line 194 of file fq-pie-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_qDelayRef

Time ns3::FqPieQueueDisc::m_qDelayRef

private

Desired queue delay.

Definition at line 179 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_quantum

uint32_t ns3::FqPieQueueDisc::m_quantum

private

Deficit assigned to flows at each round.

Definition at line 190 of file fq-pie-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), DoEnqueue(), GetQuantum(), and SetQuantum().

◆ m_queueDiscFactory

ObjectFactory ns3::FqPieQueueDisc::m_queueDiscFactory

private

Factory to create a new queue.

Definition at line 204 of file fq-pie-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

◆ m_setWays

uint32_t ns3::FqPieQueueDisc::m_setWays

private

size of a set of queues (used by set associative hash)

Definition at line 192 of file fq-pie-queue-disc.h.

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

◆ m_sUpdate

Time ns3::FqPieQueueDisc::m_sUpdate

private

Start time of the update timer.

Definition at line 177 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_tags

std::map<uint32_t, uint32_t> ns3::FqPieQueueDisc::m_tags

private

Tags used by set associative hash.

Definition at line 201 of file fq-pie-queue-disc.h.

Referenced by SetAssociativeHash().

◆ m_tUpdate

Time ns3::FqPieQueueDisc::m_tUpdate

private

Time period after which CalculateP () is called.

Definition at line 178 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_useDerandomization

bool ns3::FqPieQueueDisc::m_useDerandomization

private

Enable Derandomization feature mentioned in RFC 8033.

Definition at line 187 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_useDqRateEstimator

bool ns3::FqPieQueueDisc::m_useDqRateEstimator

private

Enable/Disable usage of dequeue rate estimator for queue delay calculation.

Definition at line 185 of file fq-pie-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_useEcn

bool ns3::FqPieQueueDisc::m_useEcn

private

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

Definition at line 173 of file fq-pie-queue-disc.h.

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

◆ m_useL4s

bool ns3::FqPieQueueDisc::m_useL4s

private

True if L4S is used (ECT1 packets are marked at CE threshold)

Definition at line 176 of file fq-pie-queue-disc.h.

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

◆ OVERLIMIT_DROP

constexpr const char* ns3::FqPieQueueDisc::OVERLIMIT_DROP = "Overlimit drop"

staticconstexpr

Overlimit dropped packets.

Definition at line 149 of file fq-pie-queue-disc.h.

Referenced by FqPieDrop().

◆ UNCLASSIFIED_DROP

constexpr const char* ns3::FqPieQueueDisc::UNCLASSIFIED_DROP = "Unclassified drop"

staticconstexpr

No packet filter able to classify packet.

Definition at line 148 of file fq-pie-queue-disc.h.

Referenced by DoEnqueue().

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

src/traffic-control/model/fq-pie-queue-disc.h
src/traffic-control/model/fq-pie-queue-disc.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Attributes defined in parent class ns3::QueueDisc

TraceSources defined in parent class ns3::QueueDisc

Constructor & Destructor Documentation

◆ FqPieQueueDisc()

◆ ~FqPieQueueDisc()

Member Function Documentation

◆ CheckConfig()

◆ DoDequeue()

◆ DoEnqueue()

◆ FqPieDrop()

◆ GetQuantum()

◆ GetTypeId()

◆ InitializeParams()

◆ SetAssociativeHash()

◆ SetQuantum()

Member Data Documentation

◆ m_a

◆ m_b

◆ m_ceThreshold

◆ m_dqThreshold

◆ m_dropBatchSize

◆ m_enableSetAssociativeHash

◆ m_flowFactory

◆ m_flows

◆ m_flowsIndices

◆ m_isCapDropAdjustment

◆ m_markEcnTh

◆ m_maxBurst

◆ m_meanPktSize

◆ m_newFlows

◆ m_oldFlows

◆ m_perturbation

◆ m_qDelayRef

◆ m_quantum

◆ m_queueDiscFactory

◆ m_setWays

◆ m_sUpdate

◆ m_tags

◆ m_tUpdate

◆ m_useDerandomization

◆ m_useDqRateEstimator

◆ m_useEcn

◆ m_useL4s

◆ OVERLIMIT_DROP

◆ UNCLASSIFIED_DROP