QueueDisc is an abstract base class providing the interface and implementing the operations common to all the queueing disciplines. More...

#include "queue-disc.h"

Inheritance diagram for ns3::QueueDisc:

Collaboration diagram for ns3::QueueDisc:

Public Types
typedef Callback< void, Ptr< QueueItem > >	ParentDropCallback
	Callback invoked by a child queue disc to notify the parent of a packet drop. 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
	QueueDisc ()

void	AddInternalQueue (Ptr< Queue > 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< Queue >	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...

uint32_t	GetTotalDroppedBytes (void) const
	Get the total amount of dropped bytes. More...

uint32_t	GetTotalDroppedPackets (void) const
	Get the total number of dropped packets. More...

uint32_t	GetTotalReceivedBytes (void) const
	Get the total amount of received bytes. More...

uint32_t	GetTotalReceivedPackets (void) const
	Get the total number of received packets. More...

uint32_t	GetTotalRequeuedBytes (void) const
	Get the total amount of requeued bytes. More...

uint32_t	GetTotalRequeuedPackets (void) const
	Get the total number of requeued packets. More...

WakeMode	GetWakeMode (void)
	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	SetParentDropCallback (ParentDropCallback cb)
	Set the parent drop callback. 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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
	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. More...

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

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

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

virtual void	DoInitialize (void)
	Check whether the configuration is correct and initialize parameters. More...

void	Drop (Ptr< QueueItem > item)
	Drop a packet. 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...

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

Ptr< QueueDiscItem >	DequeuePacket (void)
	Modelled after the Linux function dequeue_skb (net/sched/sch_generic.c) More...

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

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

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

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

void	NotifyParentDrop (Ptr< QueueItem > item)
	Notify the parent queue disc of a packet drop. More...

void	Requeue (Ptr< QueueDiscItem > item)
	Modelled after the Linux function dev_requeue_skb (net/sched/sch_generic.c) Requeues a packet whose transmission failed. More...

bool	Restart (void)
	Modelled after the Linux function qdisc_restart (net/sched/sch_generic.c) Dequeue a packet (by calling DequeuePacket) and send it to the device (by calling Transmit). More...

bool	RunBegin (void)
	Modelled after the Linux function qdisc_run_begin (include/net/sch_generic.h). More...

void	RunEnd (void)
	Modelled after the Linux function qdisc_run_end (include/net/sch_generic.h). More...

bool	Transmit (Ptr< QueueDiscItem > item)
	Modelled after the Linux function sch_direct_xmit (net/sched/sch_generic.c) Sends a packet to the device if the device queue is not stopped, and requeues it otherwise. More...

Private Attributes
std::vector< Ptr< QueueDiscClass > >	m_classes
	Classes. More...

Ptr< NetDevice >	m_device
	The NetDevice on which this queue discipline is installed. More...

Ptr< NetDeviceQueueInterface >	m_devQueueIface
	NetDevice queue interface. More...

std::vector< Ptr< PacketFilter > >	m_filters
	Packet filters. More...

TracedValue< uint32_t >	m_nBytes
	Number of bytes in the queue. More...

TracedValue< uint32_t >	m_nPackets
	Number of packets in the queue. More...

uint32_t	m_nTotalDroppedBytes
	Total dropped bytes. More...

uint32_t	m_nTotalDroppedPackets
	Total dropped packets. More...

uint32_t	m_nTotalReceivedBytes
	Total received bytes. More...

uint32_t	m_nTotalReceivedPackets
	Total received packets. More...

uint32_t	m_nTotalRequeuedBytes
	Total requeued bytes. More...

uint32_t	m_nTotalRequeuedPackets
	Total requeued packets. More...

ParentDropCallback	m_parentDropCallback
	Parent drop callback. More...

std::vector< Ptr< Queue > >	m_queues
	Internal queues. More...

uint32_t	m_quota
	Maximum number of packets dequeued in a qdisc run. More...

Ptr< QueueDiscItem >	m_requeued
	The last packet that failed to be transmitted. More...

bool	m_running
	The queue disc is performing multiple dequeue operations. More...

TracedCallback< Ptr< const QueueItem > >	m_traceDequeue
	Traced callback: fired when a packet is dequeued. More...

TracedCallback< Ptr< const QueueItem > >	m_traceDrop
	Traced callback: fired when a packet is dropped. More...

TracedCallback< Ptr< const QueueItem > >	m_traceEnqueue
	Traced callback: fired when a packet is enqueued. More...

TracedCallback< Ptr< const QueueItem > >	m_traceRequeue
	Traced callback: fired when a packet is requeued. More...

Static Private Attributes
static const uint32_t	DEFAULT_QUOTA = 64
	Default quota (as in /proc/sys/net/core/dev_weight) More...

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

QueueDisc is an abstract base class providing the interface and implementing the operations common to all the queueing disciplines.

Introspection did not find any typical Config paths.

Child classes need to implement the methods used to enqueue a packet (DoEnqueue), dequeue a single packet (DoDequeue), get a copy of the next packet to extract (DoPeek), check whether the current configuration is correct (CheckConfig).

As in Linux, a queue disc may contain distinct elements:

queues, which actually store the packets waiting for transmission
classes, which allow to reserve a different treatment to different packets
filters, which determine the queue or class which a packet is destined to

Notice that a child queue disc must be attached to every class and a packet filter is only able to classify packets of a single protocol. Also, while in Linux some queue discs (e.g., fq-codel) use an internal classifier and do not make use of packet filters, in ns-3 every queue disc including multiple queues or multiple classes needs an external filter to classify packets (this is to avoid having the traffic-control module depend on other modules such as internet).

Queue disc configuration vary from queue disc to queue disc. A typical taxonomy divides queue discs in classful (i.e., support classes) and classless (i.e., do not support classes). More recently, after the appearance of multi-queue devices (such as Wifi), some multi-queue aware queue discs have been introduced. Multi-queue aware queue discs handle as many queues (or queue discs – without using classes) as the number of transmission queues used by the device on which the queue disc is installed. An attempt is made, also, to enqueue each packet in the "same" queue both within the queue disc and within the device.

The traffic control layer interacts with a queue disc in a simple manner: after requesting to enqueue a packet, the traffic control layer requests the qdisc to "run", i.e., to dequeue a set of packets, until a predefined number ("quota") of packets is dequeued or the netdevice stops the queue disc. A netdevice may stop the queue disc when its transmission queue(s) is/are (almost) full. Also, a netdevice may wake the queue disc when its transmission queue(s) is/are (almost) empty. Waking a queue disc is equivalent to make it run.

The design and implementation of this class is heavily inspired by Linux. For more details, see the traffic-control model page.

Attributes

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

TraceSources

Enqueue: Enqueue a packet in the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Dequeue: Dequeue a packet from the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Requeue: Requeue a packet in the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Drop: Drop a packet stored in the queue disc
Callback signature: ns3::QueueItem::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

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

Definition at line 205 of file queue-disc.h.

Member Typedef Documentation

typedef Callback<void, Ptr<QueueItem> > ns3::QueueDisc::ParentDropCallback

Callback invoked by a child queue disc to notify the parent of a packet drop.

Definition at line 425 of file queue-disc.h.

Constructor & Destructor Documentation

ns3::QueueDisc::QueueDisc ( )

Definition at line 175 of file queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::QueueDisc::AddInternalQueue ( Ptr< Queue > queue )

Add an internal queue to the tail of the list of queues.

Parameters

queue the queue to be added

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

References Drop(), m_queues, ns3::MakeCallback(), and NS_LOG_FUNCTION.

Referenced by ns3::PfifoFastQueueDisc::CheckConfig(), ns3::PieQueueDisc::CheckConfig(), ns3::CoDelQueueDisc::CheckConfig(), ns3::RedQueueDisc::CheckConfig(), ns3::QueueDiscFactory::CreateQueueDisc(), PfifoFastQueueDiscTosPrioritization::DoRun(), PfifoFastQueueDiscDscpPrioritization::DoRun(), PfifoFastQueueDiscOverflow::DoRun(), and PfifoFastQueueDiscNoPriority::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::QueueDisc::AddPacketFilter ( Ptr< PacketFilter > filter )

Add a packet filter to the tail of the list of filters used to classify packets.

Parameters

filter the packet filter to be added

Definition at line 337 of file queue-disc.cc.

References m_filters, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

void ns3::QueueDisc::AddQueueDiscClass ( Ptr< QueueDiscClass > qdClass )

Add a queue disc class to the tail of the list of classes.

Parameters

qdClass the queue disc class to be added

Definition at line 357 of file queue-disc.cc.

References Drop(), m_classes, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and WAKE_CHILD.

Referenced by ns3::QueueDiscFactory::CreateQueueDisc(), and ns3::FqCoDelQueueDisc::DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool ns3::QueueDisc::CheckConfig ( void )

privatepure virtual

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

Implemented in ns3::RedQueueDisc, ns3::CoDelQueueDisc, ns3::PieQueueDisc, ns3::FqCoDelQueueDisc, and ns3::PfifoFastQueueDisc.

Referenced by DoInitialize().

Here is the caller graph for this function:

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

Parameters

item	item to classify

Returns: -1 if no filter able to classify the packet has been found, the value returned by first filter found to be able to classify the packet otherwise.

Definition at line 385 of file queue-disc.cc.

References f(), m_filters, NS_LOG_FUNCTION, and ns3::PacketFilter::PF_NO_MATCH.

Referenced by ns3::FqCoDelQueueDisc::DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< QueueDiscItem > ns3::QueueDisc::Dequeue ( void )

Request the queue discipline to extract a packet.

This function only updates the statistics and calls the (private) DoDequeue function, which must be implemented by derived classes.

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

Definition at line 467 of file queue-disc.cc.

References DoDequeue(), m_nBytes, m_nPackets, m_traceDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by CoDelQueueDiscBasicDrop::Dequeue(), DequeuePacket(), ns3::PfifoFastQueueDisc::DoDequeue(), CoDelQueueDiscBasicEnqueueDequeue::DoRun(), FqCoDelQueueDiscDeficit::DoRun(), PieQueueDiscTestCase::RunPieTest(), RedQueueDiscTestCase::RunRedTest(), PfifoFastQueueDiscDscpPrioritization::TestDscpValue(), and PfifoFastQueueDiscTosPrioritization::TestTosValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< QueueDiscItem > ns3::QueueDisc::DequeuePacket ( void )

private

Modelled after the Linux function dequeue_skb (net/sched/sch_generic.c)

Returns: the requeued packet, if any, or the packet dequeued by the queue disc, otherwise.

Definition at line 549 of file queue-disc.cc.

References Dequeue(), m_devQueueIface, m_nBytes, m_nPackets, m_requeued, m_traceDequeue, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Restart().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Ptr<QueueDiscItem> ns3::QueueDisc::DoDequeue ( void )

privatepure virtual

This function actually extracts a packet from the queue disc.

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

Implemented in ns3::RedQueueDisc, ns3::CoDelQueueDisc, ns3::PieQueueDisc, ns3::FqCoDelQueueDisc, and ns3::PfifoFastQueueDisc.

Referenced by Dequeue().

Here is the caller graph for this function:

void ns3::QueueDisc::DoDispose ( void )

protectedvirtual

Dispose of the object.

Reimplemented from ns3::Object.

Reimplemented in ns3::RedQueueDisc, and ns3::PieQueueDisc.

Definition at line 190 of file queue-disc.cc.

References ns3::Object::DoDispose(), m_classes, m_device, m_devQueueIface, m_filters, m_queues, m_requeued, and NS_LOG_FUNCTION.

Referenced by ns3::PieQueueDisc::DoDispose(), and ns3::RedQueueDisc::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool ns3::QueueDisc::DoEnqueue ( Ptr< QueueDiscItem > item )

privatepure virtual

This function actually enqueues a packet into the queue disc.

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Implemented in ns3::RedQueueDisc, ns3::PieQueueDisc, ns3::CoDelQueueDisc, ns3::FqCoDelQueueDisc, and ns3::PfifoFastQueueDisc.

Referenced by Enqueue().

Here is the caller graph for this function:

void ns3::QueueDisc::DoInitialize ( void )

protectedvirtual

Check whether the configuration is correct and initialize parameters.

Reimplemented from ns3::Object.

Definition at line 203 of file queue-disc.cc.

References CheckConfig(), ns3::Object::DoInitialize(), InitializeParams(), m_classes, m_device, m_devQueueIface, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_UNUSED.

Here is the call graph for this function:

virtual Ptr<const QueueDiscItem> ns3::QueueDisc::DoPeek ( void ) const

privatepure virtual

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.

Implemented in ns3::RedQueueDisc, ns3::CoDelQueueDisc, ns3::PieQueueDisc, ns3::FqCoDelQueueDisc, and ns3::PfifoFastQueueDisc.

Referenced by Peek().

Here is the caller graph for this function:

void ns3::QueueDisc::Drop ( Ptr< QueueItem > item )

protected

Drop a packet.

Parameters

item	item that was dropped This method is called by subclasses to notify parent (this class) of packet drops.

Definition at line 411 of file queue-disc.cc.

References GetWakeMode(), m_nBytes, m_nPackets, m_nTotalDroppedBytes, m_nTotalDroppedPackets, m_traceDrop, NotifyParentDrop(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and WAKE_CHILD.

Referenced by AddInternalQueue(), AddQueueDiscClass(), ns3::CoDelQueueDisc::DoDequeue(), ns3::PfifoFastQueueDisc::DoEnqueue(), ns3::FqCoDelQueueDisc::DoEnqueue(), ns3::CoDelQueueDisc::DoEnqueue(), ns3::PieQueueDisc::DoEnqueue(), and ns3::RedQueueDisc::DoEnqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::QueueDisc::Enqueue ( Ptr< QueueDiscItem > item )

Pass a packet to store to the queue discipline.

This function only updates the statistics and calls the (private) DoEnqueue function, which must be implemented by derived classes.

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Definition at line 451 of file queue-disc.cc.

References DoEnqueue(), m_nBytes, m_nPackets, m_nTotalReceivedBytes, m_nTotalReceivedPackets, m_traceEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by FqCoDelQueueDiscIPFlowsSeparationAndPacketLimit::AddPacket(), FqCoDelQueueDiscDeficit::AddPacket(), PfifoFastQueueDiscOverflow::AddPacket(), FqCoDelQueueDiscTCPFlowsSeparation::AddPacket(), FqCoDelQueueDiscUDPFlowsSeparation::AddPacket(), FqCoDelQueueDiscNoSuitableFilter::DoRun(), CoDelQueueDiscBasicEnqueueDequeue::DoRun(), CoDelQueueDiscBasicOverflow::DoRun(), PfifoFastQueueDiscNoPriority::DoRun(), AutoRedQueueDiscTestCase::Enqueue(), RedQueueDiscTestCase::Enqueue(), CoDelQueueDiscBasicOverflow::Enqueue(), CoDelQueueDiscBasicDrop::Enqueue(), PieQueueDiscTestCase::RunPieTest(), RedQueueDiscTestCase::RunRedTest(), ns3::TrafficControlLayer::Send(), PfifoFastQueueDiscDscpPrioritization::TestDscpValue(), and PfifoFastQueueDiscTosPrioritization::TestTosValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< Queue > ns3::QueueDisc::GetInternalQueue ( uint32_t i ) const

Get the i-th internal queue.

Parameters

i	the index of the queue

Returns: the i-th internal queue.

Definition at line 324 of file queue-disc.cc.

References m_queues, and NS_ASSERT.

Referenced by ns3::PieQueueDisc::CalculateP(), ns3::PfifoFastQueueDisc::CheckConfig(), ns3::PieQueueDisc::CheckConfig(), ns3::CoDelQueueDisc::CheckConfig(), ns3::RedQueueDisc::CheckConfig(), ns3::PfifoFastQueueDisc::DoDequeue(), ns3::PieQueueDisc::DoDequeue(), ns3::CoDelQueueDisc::DoDequeue(), ns3::RedQueueDisc::DoDequeue(), ns3::PfifoFastQueueDisc::DoEnqueue(), ns3::CoDelQueueDisc::DoEnqueue(), ns3::PieQueueDisc::DoEnqueue(), ns3::RedQueueDisc::DoEnqueue(), ns3::PfifoFastQueueDisc::DoPeek(), ns3::PieQueueDisc::DoPeek(), ns3::CoDelQueueDisc::DoPeek(), ns3::RedQueueDisc::DoPeek(), PfifoFastQueueDiscTosPrioritization::DoRun(), PfifoFastQueueDiscDscpPrioritization::DoRun(), PfifoFastQueueDiscOverflow::DoRun(), PfifoFastQueueDiscNoPriority::DoRun(), ns3::FqCoDelQueueDisc::FqCoDelDrop(), ns3::CoDelQueueDisc::GetQueueSize(), ns3::PieQueueDisc::GetQueueSize(), ns3::RedQueueDisc::GetQueueSize(), ns3::CoDelQueueDisc::OkToDrop(), PfifoFastQueueDiscDscpPrioritization::TestDscpValue(), and PfifoFastQueueDiscTosPrioritization::TestTosValue().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetNBytes ( void ) const

Get the amount of bytes stored by the queue disc.

Returns: the amount of bytes stored by the queue disc.

Note that the amount of bytes stored by the queue disc is updated as soon as a packet is received by the queue disc and before actually enqueuing the packet (i.e., before calling DoEnqueue). Thus, while implementing the DoEnqueue method of a subclass, keep in mind that GetNBytes returns the amount of bytes stored in the queue disc, including the size of the packet that we are trying to enqueue.

Definition at line 237 of file queue-disc.cc.

References m_nBytes, and NS_LOG_FUNCTION.

Referenced by ns3::PieQueueDisc::CalculateP(), ns3::PieQueueDisc::DoDequeue(), ns3::CoDelQueueDisc::DoDequeue(), ns3::RedQueueDisc::DoDequeue(), ns3::CoDelQueueDisc::DoEnqueue(), ns3::PieQueueDisc::DoEnqueue(), ns3::RedQueueDisc::DoEnqueue(), ns3::PieQueueDisc::DoPeek(), ns3::CoDelQueueDisc::DoPeek(), ns3::RedQueueDisc::DoPeek(), ns3::FqCoDelQueueDisc::FqCoDelDrop(), ns3::CoDelQueueDisc::OkToDrop(), CoDelQueueDiscBasicEnqueueDequeue::QueueTestSize(), CoDelQueueDiscBasicOverflow::QueueTestSize(), and CoDelQueueDiscBasicDrop::QueueTestSize().

Here is the caller graph for this function:

Ptr< NetDevice > ns3::QueueDisc::GetNetDevice ( void ) const

Get the NetDevice on which this queue discipline is installed.

Returns: the NetDevice on which this queue discipline is installed.

Definition at line 293 of file queue-disc.cc.

References m_device, and NS_LOG_FUNCTION.

Referenced by ns3::FqCoDelQueueDisc::InitializeParams().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetNInternalQueues ( void ) const

Get the number of internal queues.

Returns: the number of internal queues.

Definition at line 331 of file queue-disc.cc.

References m_queues.

Referenced by ns3::PfifoFastQueueDisc::CheckConfig(), ns3::FqCoDelQueueDisc::CheckConfig(), ns3::PieQueueDisc::CheckConfig(), ns3::CoDelQueueDisc::CheckConfig(), ns3::RedQueueDisc::CheckConfig(), ns3::PfifoFastQueueDisc::DoDequeue(), and ns3::PfifoFastQueueDisc::DoPeek().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetNPacketFilters ( void ) const

Get the number of packet filters.

Returns: the number of packet filters.

Definition at line 351 of file queue-disc.cc.

References m_filters.

Referenced by ns3::PfifoFastQueueDisc::CheckConfig(), ns3::FqCoDelQueueDisc::CheckConfig(), ns3::PieQueueDisc::CheckConfig(), ns3::CoDelQueueDisc::CheckConfig(), and ns3::RedQueueDisc::CheckConfig().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetNPackets ( void ) const

Get the number of packets stored by the queue disc.

Returns: the number of packets stored by the queue disc.

Note that the number of packets stored by the queue disc is updated as soon as a packet is received by the queue disc and before actually enqueuing the packet (i.e., before calling DoEnqueue). Thus, while implementing the DoEnqueue method of a subclass, keep in mind that GetNPackets returns the number of packets stored in the queue disc, including the packet that we are trying to enqueue.

Definition at line 230 of file queue-disc.cc.

References m_nPackets, and NS_LOG_FUNCTION.

Referenced by ns3::PfifoFastQueueDisc::DoDequeue(), ns3::CoDelQueueDisc::DoDequeue(), ns3::RedQueueDisc::DoDequeue(), ns3::PfifoFastQueueDisc::DoEnqueue(), ns3::FqCoDelQueueDisc::DoEnqueue(), ns3::CoDelQueueDisc::DoEnqueue(), ns3::PieQueueDisc::DoEnqueue(), ns3::RedQueueDisc::DoEnqueue(), ns3::PfifoFastQueueDisc::DoPeek(), ns3::PieQueueDisc::DoPeek(), ns3::CoDelQueueDisc::DoPeek(), ns3::RedQueueDisc::DoPeek(), CoDelQueueDiscBasicEnqueueDequeue::QueueTestSize(), CoDelQueueDiscBasicOverflow::QueueTestSize(), CoDelQueueDiscBasicDrop::QueueTestSize(), and Transmit().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetNQueueDiscClasses ( void ) const

Get the number of queue disc classes.

Returns: the number of queue disc classes.

Definition at line 379 of file queue-disc.cc.

References m_classes.

Referenced by ns3::PfifoFastQueueDisc::CheckConfig(), ns3::FqCoDelQueueDisc::CheckConfig(), ns3::PieQueueDisc::CheckConfig(), ns3::CoDelQueueDisc::CheckConfig(), ns3::RedQueueDisc::CheckConfig(), ns3::FqCoDelQueueDisc::DoEnqueue(), FqCoDelQueueDiscNoSuitableFilter::DoRun(), and ns3::FqCoDelQueueDisc::FqCoDelDrop().

Here is the caller graph for this function:

Ptr< PacketFilter > ns3::QueueDisc::GetPacketFilter ( uint32_t i ) const

Get the i-th packet filter.

Parameters

i	the index of the packet filter

Returns: the i-th packet filter.

Definition at line 344 of file queue-disc.cc.

References m_filters, and NS_ASSERT.

Ptr< QueueDiscClass > ns3::QueueDisc::GetQueueDiscClass ( uint32_t i ) const

Get the i-th queue disc class.

Parameters

i	the index of the queue disc class

Returns: the i-th queue disc class.

Definition at line 372 of file queue-disc.cc.

References m_classes, and NS_ASSERT.

Referenced by ns3::FqCoDelQueueDisc::DoEnqueue(), FqCoDelQueueDiscIPFlowsSeparationAndPacketLimit::DoRun(), FqCoDelQueueDiscDeficit::DoRun(), FqCoDelQueueDiscTCPFlowsSeparation::DoRun(), FqCoDelQueueDiscUDPFlowsSeparation::DoRun(), and ns3::FqCoDelQueueDisc::FqCoDelDrop().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetQuota ( void ) const

virtual

Get the maximum number of dequeue operations following a packet enqueue.

Returns: the maximum number of dequeue operations following a packet enqueue.

Definition at line 307 of file queue-disc.cc.

References m_quota, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint32_t ns3::QueueDisc::GetTotalDroppedBytes ( void ) const

Get the total amount of dropped bytes.

Returns: the total amount of dropped bytes.

Definition at line 265 of file queue-disc.cc.

References m_nTotalDroppedBytes, and NS_LOG_FUNCTION.

uint32_t ns3::QueueDisc::GetTotalDroppedPackets ( void ) const

Get the total number of dropped packets.

Returns: the total number of dropped packets.

Definition at line 258 of file queue-disc.cc.

References m_nTotalDroppedPackets, and NS_LOG_FUNCTION.

uint32_t ns3::QueueDisc::GetTotalReceivedBytes ( void ) const

Get the total amount of received bytes.

Returns: the total amount of received bytes.

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

References m_nTotalReceivedBytes, and NS_LOG_FUNCTION.

uint32_t ns3::QueueDisc::GetTotalReceivedPackets ( void ) const

Get the total number of received packets.

Returns: the total number of received packets.

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

References m_nTotalReceivedPackets, and NS_LOG_FUNCTION.

uint32_t ns3::QueueDisc::GetTotalRequeuedBytes ( void ) const

Get the total amount of requeued bytes.

Returns: the total amount of requeued bytes.

Definition at line 279 of file queue-disc.cc.

References m_nTotalRequeuedBytes, and NS_LOG_FUNCTION.

uint32_t ns3::QueueDisc::GetTotalRequeuedPackets ( void ) const

Get the total number of requeued packets.

Returns: the total number of requeued packets.

Definition at line 272 of file queue-disc.cc.

References m_nTotalRequeuedPackets, and NS_LOG_FUNCTION.

TypeId ns3::QueueDisc::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 129 of file queue-disc.cc.

References DEFAULT_QUOTA, GetQuota(), m_classes, m_filters, m_nBytes, m_nPackets, m_queues, m_traceDequeue, m_traceDrop, m_traceEnqueue, m_traceRequeue, ns3::MakeObjectVectorAccessor(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::TypeId::SetParent(), and SetQuota().

Here is the call graph for this function:

QueueDisc::WakeMode ns3::QueueDisc::GetWakeMode ( void )

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.

The implementation of this method for the base class returns WAKE_ROOT, i.e., the root queue disc is activated. Subclasses implementing queue discs adopting a different strategy (e.g., multi-queue aware queue discs such as mq) have to redefine this method.

Returns: the wake mode adopted by this queue disc.

Definition at line 399 of file queue-disc.cc.

References WAKE_ROOT.

Referenced by Drop().

Here is the caller graph for this function:

virtual void ns3::QueueDisc::InitializeParams ( void )

privatepure virtual

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

Implemented in ns3::CoDelQueueDisc, ns3::RedQueueDisc, ns3::PieQueueDisc, ns3::FqCoDelQueueDisc, and ns3::PfifoFastQueueDisc.

Referenced by DoInitialize().

Here is the caller graph for this function:

void ns3::QueueDisc::NotifyParentDrop ( Ptr< QueueItem > item )

private

Notify the parent queue disc of a packet drop.

Parameters

item	item that was dropped

Definition at line 440 of file queue-disc.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_parentDropCallback, and NS_LOG_FUNCTION.

Referenced by Drop().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< const QueueDiscItem > ns3::QueueDisc::Peek ( void ) const

Get a copy of the next packet the queue discipline will extract, without actually extracting the packet.

This function only calls the (private) DoPeek function, which must be implemented by derived classes.

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

Definition at line 487 of file queue-disc.cc.

References DoPeek(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::QueueDisc::Requeue ( Ptr< QueueDiscItem > item )

private

Modelled after the Linux function dev_requeue_skb (net/sched/sch_generic.c) Requeues a packet whose transmission failed.

Parameters

item	the packet to requeue

Todo:: netif_schedule (q);

Definition at line 595 of file queue-disc.cc.

References m_nBytes, m_nPackets, m_nTotalRequeuedBytes, m_nTotalRequeuedPackets, m_requeued, m_traceRequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Transmit().

Here is the caller graph for this function:

bool ns3::QueueDisc::Restart ( void )

private

Modelled after the Linux function qdisc_restart (net/sched/sch_generic.c) Dequeue a packet (by calling DequeuePacket) and send it to the device (by calling Transmit).

Returns: true if a packet is successfully sent to the device.

Definition at line 535 of file queue-disc.cc.

References DequeuePacket(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and Transmit().

Referenced by Run().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Todo:: netif_schedule (q);

Definition at line 494 of file queue-disc.cc.

References m_quota, NS_LOG_FUNCTION, Restart(), RunBegin(), and RunEnd().

Referenced by ns3::TrafficControlLayer::DoInitialize(), and ns3::TrafficControlLayer::Send().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::QueueDisc::RunBegin ( void )

private

Modelled after the Linux function qdisc_run_begin (include/net/sch_generic.h).

Returns: false if the qdisc is already running; otherwise, set the qdisc as running and return true.

Definition at line 515 of file queue-disc.cc.

References m_running, and NS_LOG_FUNCTION.

Referenced by Run().

Here is the caller graph for this function:

void ns3::QueueDisc::RunEnd ( void )

private

Modelled after the Linux function qdisc_run_end (include/net/sch_generic.h).

Set the qdisc as not running.

Definition at line 528 of file queue-disc.cc.

References m_running, and NS_LOG_FUNCTION.

Referenced by Run().

Here is the caller graph for this function:

void ns3::QueueDisc::SetNetDevice ( Ptr< NetDevice > device )

Set the NetDevice on which this queue discipline is installed.

Parameters

device the NetDevice on which this queue discipline is installed.

Definition at line 286 of file queue-disc.cc.

References m_device, and NS_LOG_FUNCTION.

Referenced by ns3::TrafficControlHelper::Install().

Here is the caller graph for this function:

void ns3::QueueDisc::SetParentDropCallback ( ParentDropCallback cb )

virtual

Set the parent drop callback.

Parameters

cb	the callback to set

Called when a queue disc class is added to a queue disc in order to set a callback to the Drop method of the parent queue disc.

Definition at line 405 of file queue-disc.cc.

References m_parentDropCallback.

void ns3::QueueDisc::SetQuota ( const uint32_t quota )

virtual

Set the maximum number of dequeue operations following a packet enqueue.

Parameters

quota the maximum number of dequeue operations following a packet enqueue.

Definition at line 300 of file queue-disc.cc.

References m_quota, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

bool ns3::QueueDisc::Transmit ( Ptr< QueueDiscItem > item )

private

Modelled after the Linux function sch_direct_xmit (net/sched/sch_generic.c) Sends a packet to the device if the device queue is not stopped, and requeues it otherwise.

Parameters

item	the packet to transmit

Returns: true if the device queue is not stopped and the queue disc is not empty

Definition at line 611 of file queue-disc.cc.

References GetNPackets(), m_device, m_devQueueIface, NS_ASSERT, NS_LOG_FUNCTION, and Requeue().

Referenced by Restart().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const uint32_t ns3::QueueDisc::DEFAULT_QUOTA = 64

staticprivate

Default quota (as in /proc/sys/net/core/dev_weight)

Definition at line 534 of file queue-disc.h.

Referenced by GetTypeId().

std::vector<Ptr<QueueDiscClass> > ns3::QueueDisc::m_classes

private

Classes.

Definition at line 538 of file queue-disc.h.

Referenced by AddQueueDiscClass(), DoDispose(), DoInitialize(), GetNQueueDiscClasses(), GetQueueDiscClass(), and GetTypeId().

Ptr<NetDevice> ns3::QueueDisc::m_device

private

The NetDevice on which this queue discipline is installed.

Definition at line 550 of file queue-disc.h.

Referenced by DoDispose(), DoInitialize(), GetNetDevice(), SetNetDevice(), and Transmit().

Ptr<NetDeviceQueueInterface> ns3::QueueDisc::m_devQueueIface

private

NetDevice queue interface.

Definition at line 551 of file queue-disc.h.

Referenced by DequeuePacket(), DoDispose(), DoInitialize(), and Transmit().

std::vector<Ptr<PacketFilter> > ns3::QueueDisc::m_filters

private

Packet filters.

Definition at line 537 of file queue-disc.h.

Referenced by AddPacketFilter(), Classify(), DoDispose(), GetNPacketFilters(), GetPacketFilter(), and GetTypeId().

TracedValue<uint32_t> ns3::QueueDisc::m_nBytes

private

Number of bytes in the queue.

Definition at line 541 of file queue-disc.h.

Referenced by Dequeue(), DequeuePacket(), Drop(), Enqueue(), GetNBytes(), GetTypeId(), and Requeue().

TracedValue<uint32_t> ns3::QueueDisc::m_nPackets

private

Number of packets in the queue.

Definition at line 540 of file queue-disc.h.

Referenced by Dequeue(), DequeuePacket(), Drop(), Enqueue(), GetNPackets(), GetTypeId(), and Requeue().

uint32_t ns3::QueueDisc::m_nTotalDroppedBytes

private

Total dropped bytes.

Definition at line 546 of file queue-disc.h.

Referenced by Drop(), and GetTotalDroppedBytes().

uint32_t ns3::QueueDisc::m_nTotalDroppedPackets

private

Total dropped packets.

Definition at line 545 of file queue-disc.h.

Referenced by Drop(), and GetTotalDroppedPackets().

uint32_t ns3::QueueDisc::m_nTotalReceivedBytes

private

Total received bytes.

Definition at line 544 of file queue-disc.h.

Referenced by Enqueue(), and GetTotalReceivedBytes().

uint32_t ns3::QueueDisc::m_nTotalReceivedPackets

private

Total received packets.

Definition at line 543 of file queue-disc.h.

Referenced by Enqueue(), and GetTotalReceivedPackets().

uint32_t ns3::QueueDisc::m_nTotalRequeuedBytes

private

Total requeued bytes.

Definition at line 548 of file queue-disc.h.

Referenced by GetTotalRequeuedBytes(), and Requeue().

uint32_t ns3::QueueDisc::m_nTotalRequeuedPackets

private

Total requeued packets.

Definition at line 547 of file queue-disc.h.

Referenced by GetTotalRequeuedPackets(), and Requeue().

ParentDropCallback ns3::QueueDisc::m_parentDropCallback

private

Parent drop callback.

Definition at line 554 of file queue-disc.h.

Referenced by NotifyParentDrop(), and SetParentDropCallback().

std::vector<Ptr<Queue> > ns3::QueueDisc::m_queues

private

Internal queues.

Definition at line 536 of file queue-disc.h.

Referenced by AddInternalQueue(), DoDispose(), GetInternalQueue(), GetNInternalQueues(), and GetTypeId().

uint32_t ns3::QueueDisc::m_quota

private

Maximum number of packets dequeued in a qdisc run.

Definition at line 549 of file queue-disc.h.

Referenced by GetQuota(), Run(), and SetQuota().

Ptr<QueueDiscItem> ns3::QueueDisc::m_requeued

private

The last packet that failed to be transmitted.

Definition at line 553 of file queue-disc.h.

Referenced by DequeuePacket(), DoDispose(), and Requeue().

bool ns3::QueueDisc::m_running

private

The queue disc is performing multiple dequeue operations.

Definition at line 552 of file queue-disc.h.

Referenced by RunBegin(), and RunEnd().

TracedCallback<Ptr<const QueueItem> > ns3::QueueDisc::m_traceDequeue

private

Traced callback: fired when a packet is dequeued.

Definition at line 559 of file queue-disc.h.

Referenced by Dequeue(), DequeuePacket(), and GetTypeId().

TracedCallback<Ptr<const QueueItem> > ns3::QueueDisc::m_traceDrop

private

Traced callback: fired when a packet is dropped.

Definition at line 563 of file queue-disc.h.

Referenced by Drop(), and GetTypeId().

TracedCallback<Ptr<const QueueItem> > ns3::QueueDisc::m_traceEnqueue

private

Traced callback: fired when a packet is enqueued.

Definition at line 557 of file queue-disc.h.

Referenced by Enqueue(), and GetTypeId().

TracedCallback<Ptr<const QueueItem> > ns3::QueueDisc::m_traceRequeue

private

Traced callback: fired when a packet is requeued.

Definition at line 561 of file queue-disc.h.

Referenced by GetTypeId(), and Requeue().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Attributes

TraceSources

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation