A FqCoDel packet queue disc. More...

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

Inheritance diagram for ns3::FqCoDelQueueDisc:

Collaboration diagram for ns3::FqCoDelQueueDisc:

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

virtual	~FqCoDelQueueDisc ()

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

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)
	Request the queue discipline to extract a packet. More...

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

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

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

Ptr< NetDevice >	GetNetDevice (void) const
	Get the NetDevice on which this queue discipline is installed. More...

uint32_t	GetNInternalQueues (void) const
	Get the number of internal queues. More...

uint32_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...

uint32_t	GetNQueueDiscClasses (void) const
	Get the number of queue disc classes. More...

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

Ptr< QueueDiscClass >	GetQueueDiscClass (uint32_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...

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

Ptr< const QueueDiscItem >	Peek (void) const
	Get a copy of the next packet the queue discipline will extract, without actually extracting the packet. 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...

void	SetNetDevice (Ptr< NetDevice > device)
	Set the NetDevice on which this queue discipline is installed. More...

virtual void	SetQuota (const uint32_t quota)
	Set the maximum number of dequeue operations following a packet enqueue. 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<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. 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)
	Copy constructor. More...

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

SimpleRefCount &	operator= (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 *	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...

virtual Ptr< const QueueDiscItem >	DoPeek (void) const
	This function returns a copy of the next packet the queue disc will extract. More...

uint32_t	FqCoDelDrop (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...

Private Attributes
uint32_t	m_dropBatchSize
	Max number of packets dropped from the fat flow. 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...

std::string	m_interval
	CoDel interval attribute. More...

uint32_t	m_limit
	Maximum number of packets in the queue disc. More...

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

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

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

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

std::string	m_target
	CoDel target attribute. More...

Additional Inherited Members
Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItem >	InternalQueue
	Internal queues store QueueDiscItem objects. 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 FqCoDel packet queue disc.

Introspection did not find any typical Config paths.

Attributes

Interval: The CoDel algorithm interval for each FQCoDel queue
- Set with class: StringValue
- Underlying type:
- Initial value: 100ms
- Flags: construct write read
Target: The CoDel algorithm target queue delay for each FQCoDel queue
- Set with class: StringValue
- Underlying type:
- Initial value: 5ms
- Flags: construct write read
PacketLimit: The hard limit on the real queue size, measured in packets
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10240
- 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

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::TracedValueCallback

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

Definition at line 101 of file fq-codel-queue-disc.h.

Constructor & Destructor Documentation

ns3::FqCoDelQueueDisc::FqCoDelQueueDisc ( )

FqCoDelQueueDisc constructor.

Definition at line 130 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

ns3::FqCoDelQueueDisc::~FqCoDelQueueDisc ( )

virtual

Definition at line 136 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

bool ns3::FqCoDelQueueDisc::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.

Returns: true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 314 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), NS_LOG_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Ptr< QueueDiscItem > ns3::FqCoDelQueueDisc::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 207 of file fq-codel-queue-disc.cc.

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

bool ns3::FqCoDelQueueDisc::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 155 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::AddQueueDiscClass(), ns3::QueueDisc::Classify(), ns3::ObjectFactory::Create(), ns3::QueueDisc::DropBeforeEnqueue(), FqCoDelDrop(), ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), ns3::FqCoDelFlow::INACTIVE, ns3::Object::Initialize(), m_flowFactory, m_flows, m_flowsIndices, m_limit, m_newFlows, m_quantum, m_queueDiscFactory, ns3::FqCoDelFlow::NEW_FLOW, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::PacketFilter::PF_NO_MATCH, and UNCLASSIFIED_DROP.

Here is the call graph for this function:

Ptr< const QueueDiscItem > ns3::FqCoDelQueueDisc::DoPeek ( void ) const

privatevirtual

This function returns a copy of the next packet the queue disc will extract.

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

Implements ns3::QueueDisc.

Definition at line 288 of file fq-codel-queue-disc.cc.

References m_newFlows, m_oldFlows, and NS_LOG_FUNCTION.

uint32_t ns3::FqCoDelQueueDisc::FqCoDelDrop ( 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 363 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::DropAfterDequeue(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), m_dropBatchSize, 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:

uint32_t ns3::FqCoDelQueueDisc::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 149 of file fq-codel-queue-disc.cc.

References m_quantum.

Referenced by FqCoDelQueueDiscDeficit::DoRun().

Here is the caller graph for this function:

TypeId ns3::FqCoDelQueueDisc::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 95 of file fq-codel-queue-disc.cc.

References m_dropBatchSize, m_flows, m_interval, m_limit, m_target, ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::FqCoDelQueueDisc::InitializeParams ( void )

privatevirtual

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

Implements ns3::QueueDisc.

Definition at line 339 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::GetNetDevice(), m_flowFactory, m_interval, m_limit, m_quantum, m_queueDiscFactory, m_target, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::CoDelQueueDisc::QUEUE_DISC_MODE_PACKETS, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

void ns3::FqCoDelQueueDisc::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 142 of file fq-codel-queue-disc.cc.

References m_quantum, and NS_LOG_FUNCTION.

Referenced by FqCoDelQueueDiscNoSuitableFilter::DoRun(), FqCoDelQueueDiscIPFlowsSeparationAndPacketLimit::DoRun(), FqCoDelQueueDiscDeficit::DoRun(), FqCoDelQueueDiscTCPFlowsSeparation::DoRun(), and FqCoDelQueueDiscUDPFlowsSeparation::DoRun().

Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::FqCoDelQueueDisc::m_dropBatchSize

private

Max number of packets dropped from the fat flow.

Definition at line 151 of file fq-codel-queue-disc.h.

Referenced by FqCoDelDrop(), and GetTypeId().

ObjectFactory ns3::FqCoDelQueueDisc::m_flowFactory

private

Factory to create a new flow.

Definition at line 158 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

uint32_t ns3::FqCoDelQueueDisc::m_flows

private

Number of flow queues.

Definition at line 150 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

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

private

Map with the index of class for each flow.

Definition at line 156 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue().

std::string ns3::FqCoDelQueueDisc::m_interval

private

CoDel interval attribute.

Definition at line 146 of file fq-codel-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

uint32_t ns3::FqCoDelQueueDisc::m_limit

private

Maximum number of packets in the queue disc.

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

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

std::list<Ptr<FqCoDelFlow> > ns3::FqCoDelQueueDisc::m_newFlows

private

The list of new flows.

Definition at line 153 of file fq-codel-queue-disc.h.

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

std::list<Ptr<FqCoDelFlow> > ns3::FqCoDelQueueDisc::m_oldFlows

private

The list of old flows.

Definition at line 154 of file fq-codel-queue-disc.h.

Referenced by DoDequeue(), and DoPeek().

uint32_t ns3::FqCoDelQueueDisc::m_quantum

private

Deficit assigned to flows at each round.

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

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

ObjectFactory ns3::FqCoDelQueueDisc::m_queueDiscFactory

private

Factory to create a new queue.

Definition at line 159 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

std::string ns3::FqCoDelQueueDisc::m_target

private

CoDel target attribute.

Definition at line 147 of file fq-codel-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

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

static

Overlimit dropped packets.

Definition at line 131 of file fq-codel-queue-disc.h.

Referenced by FqCoDelDrop().

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

static

No packet filter able to classify packet.

Definition at line 130 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue().

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

src/traffic-control/model/fq-codel-queue-disc.h
src/traffic-control/model/fq-codel-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

Member Function Documentation

Member Data Documentation