Linux pfifo_fast is the default priority queue enabled on Linux systems. More...

#include "pfifo-fast-queue-disc.h"

Inheritance diagram for ns3::PfifoFastQueueDisc:

Collaboration diagram for ns3::PfifoFastQueueDisc:

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

virtual	~PfifoFastQueueDisc ()

Public Member Functions inherited from ns3::QueueDisc
	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	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...

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

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

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

Private Attributes
uint32_t	m_limit
	Maximum number of packets that can be stored. More...

Additional Inherited Members
Public Types inherited from ns3::QueueDisc
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...

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

void	Drop (Ptr< QueueDiscItem > 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...

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

Linux pfifo_fast is the default priority queue enabled on Linux systems.

Introspection did not find any typical Config paths.

Packets are enqueued in three FIFO droptail queues according to three priority bands based on the classification returned by the configured packet filters.

The system behaves similar to three ns3::DropTail queues operating together, in which packets from higher priority bands are always dequeued before a packet from a lower priority band is dequeued.

The queue disc capacity, i.e., the maximum number of packets that can be enqueued in the queue disc, is set through the limit attribute, which plays the same role as txqueuelen in Linux. If no internal queue is provided, three DropTail queues having each a capacity equal to limit are created by default. User is allowed to provide queues, but they must be three, operate in packet mode and each have a capacity not less than limit.

It is necessary to provide at least one packet filter. To simulate the Linux behavior, the PfifoFastIpv4PacketFilter and/or the PfifoFastIpv6PacketFilter shall be provided. These filters classify packets based on their Type of Service bits or DSCP bits. If the filters are unable to classify a packet, i.e., they return -1 (PF_NO_MATCH), that packet is enqueued into band 1 (normal service).

Attributes

Limit: The maximum number of packets accepted by this queue disc.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1000
- 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>
- 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::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